# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*- import os import subprocess from waflib import Context, Logs VERSION = '0.5.5' APPNAME = 'ChronoSync' GIT_TAG_PREFIX = '' def options(opt): opt.load(['compiler_cxx', 'gnu_dirs']) opt.load(['default-compiler-flags', 'coverage', 'sanitizers', 'boost', 'doxygen', 'sphinx_build'], tooldir=['.waf-tools']) optgrp = opt.add_option_group('ChronoSync Options') optgrp.add_option('--with-tests', action='store_true', default=False, help='Build unit tests') def configure(conf): conf.load(['compiler_cxx', 'gnu_dirs', 'default-compiler-flags', 'boost', 'doxygen', 'sphinx_build']) conf.env.WITH_TESTS = conf.options.with_tests conf.find_program('dot', mandatory=False) # Prefer pkgconf if it's installed, because it gives more correct results # on Fedora/CentOS/RHEL/etc. See https://bugzilla.redhat.com/show_bug.cgi?id=1953348 # Store the result in env.PKGCONFIG, which is the variable used inside check_cfg() conf.find_program(['pkgconf', 'pkg-config'], var='PKGCONFIG') pkg_config_path = os.environ.get('PKG_CONFIG_PATH', f'{conf.env.LIBDIR}/pkgconfig') conf.check_cfg(package='libndn-cxx', args=['libndn-cxx >= 0.8.1', '--cflags', '--libs'], uselib_store='NDN_CXX', pkg_config_path=pkg_config_path) conf.check_boost(lib='iostreams', mt=True) if conf.env.BOOST_VERSION_NUMBER < 107100: conf.fatal('The minimum supported version of Boost is 1.71.0.\n' 'Please upgrade your distribution or manually install a newer version of Boost.\n' 'For more information, see https://redmine.named-data.net/projects/nfd/wiki/Boost') if conf.env.WITH_TESTS: conf.check_boost(lib='filesystem unit_test_framework', mt=True, uselib_store='BOOST_TESTS') conf.check_compiler_flags() # Loading "late" to prevent tests from being compiled with profiling flags conf.load('coverage') conf.load('sanitizers') # If there happens to be a static library, waf will put the corresponding -L flags # before dynamic library flags. This can result in compilation failure when the # system has a different version of the ChronoSync library installed. conf.env.prepend_value('STLIBPATH', ['.']) conf.define_cond('WITH_TESTS', conf.env.WITH_TESTS) # The config header will contain all defines that were added using conf.define() # or conf.define_cond(). Everything that was added directly to conf.env.DEFINES # will not appear in the config header, but will instead be passed directly to the # compiler on the command line. conf.write_config_header('src/detail/config.hpp', define_prefix='CHRONOSYNC_') def build(bld): bld.shlib( target='ChronoSync', vnum=VERSION, cnum=VERSION, source=bld.path.ant_glob('src/**/*.cpp'), use='BOOST NDN_CXX', includes='src/detail', export_includes='src src/detail') if bld.env.WITH_TESTS: bld.recurse('tests') # Install header files srcdir = bld.path.find_dir('src') bld.install_files('${INCLUDEDIR}/ChronoSync', srcdir.ant_glob('**/*.hpp'), cwd=srcdir, relative_trick=True) bld.install_files('${INCLUDEDIR}/ChronoSync/detail', 'src/detail/config.hpp') bld(features='subst', source='ChronoSync.pc.in', target='ChronoSync.pc', install_path='${LIBDIR}/pkgconfig', VERSION=VERSION) def docs(bld): from waflib import Options Options.commands = ['doxygen', 'sphinx'] + Options.commands def doxygen(bld): version(bld) if not bld.env.DOXYGEN: bld.fatal('Cannot build documentation ("doxygen" not found in PATH)') bld(features='subst', name='doxygen.conf', source=['docs/doxygen.conf.in', 'docs/named_data_theme/named_data_footer-with-analytics.html.in'], target=['docs/doxygen.conf', 'docs/named_data_theme/named_data_footer-with-analytics.html'], VERSION=VERSION, HAVE_DOT='YES' if bld.env.DOT else 'NO', HTML_FOOTER='../build/docs/named_data_theme/named_data_footer-with-analytics.html' \ if os.getenv('GOOGLE_ANALYTICS', None) \ else '../docs/named_data_theme/named_data_footer.html', GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', '')) bld(features='doxygen', doxyfile='docs/doxygen.conf', use='doxygen.conf') def sphinx(bld): version(bld) if not bld.env.SPHINX_BUILD: bld.fatal('Cannot build documentation ("sphinx-build" not found in PATH)') bld(features='sphinx', config='docs/conf.py', outdir='docs', source=bld.path.ant_glob('docs/**/*.rst'), version=VERSION_BASE, release=VERSION) def version(ctx): # don't execute more than once if getattr(Context.g_module, 'VERSION_BASE', None): return Context.g_module.VERSION_BASE = Context.g_module.VERSION Context.g_module.VERSION_SPLIT = VERSION_BASE.split('.') # first, try to get a version string from git gotVersionFromGit = False try: cmd = ['git', 'describe', '--always', '--match', f'{GIT_TAG_PREFIX}*'] out = subprocess.run(cmd, capture_output=True, check=True, text=True).stdout.strip() if out: gotVersionFromGit = True if out.startswith(GIT_TAG_PREFIX): Context.g_module.VERSION = out.lstrip(GIT_TAG_PREFIX) else: # no tags matched Context.g_module.VERSION = f'{VERSION_BASE}-commit-{out}' except (OSError, subprocess.SubprocessError): pass versionFile = ctx.path.find_node('VERSION.info') if not gotVersionFromGit and versionFile is not None: try: Context.g_module.VERSION = versionFile.read() return except EnvironmentError: pass # version was obtained from git, update VERSION file if necessary if versionFile is not None: try: if versionFile.read() == Context.g_module.VERSION: # already up-to-date return except EnvironmentError as e: Logs.warn(f'{versionFile} exists but is not readable ({e.strerror})') else: versionFile = ctx.path.make_node('VERSION.info') try: versionFile.write(Context.g_module.VERSION) except EnvironmentError as e: Logs.warn(f'{versionFile} is not writable ({e.strerror})') def dist(ctx): ctx.algo = 'tar.xz' version(ctx) def distcheck(ctx): ctx.algo = 'tar.xz' version(ctx)