| # -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*- |
| |
| from waflib import Context, Logs, Utils |
| import os, subprocess |
| |
| VERSION = '0.8.1' |
| APPNAME = 'ndn-cxx' |
| GIT_TAG_PREFIX = 'ndn-cxx-' |
| |
| def options(opt): |
| opt.load(['compiler_cxx', 'gnu_dirs', 'c_osx']) |
| opt.load(['cross', 'default-compiler-flags', 'pch', |
| 'coverage', 'sanitizers', 'osx-frameworks', |
| 'boost', 'openssl', 'sqlite3', |
| 'doxygen', 'sphinx_build'], |
| tooldir=['.waf-tools']) |
| |
| opt = opt.add_option_group('ndn-cxx Options') |
| |
| opt.add_option('--enable-static', action='store_true', default=False, |
| dest='enable_static', help='Build static library (disabled by default)') |
| opt.add_option('--disable-static', action='store_false', default=False, |
| dest='enable_static', help='Do not build static library (disabled by default)') |
| |
| opt.add_option('--enable-shared', action='store_true', default=True, |
| dest='enable_shared', help='Build shared library (enabled by default)') |
| opt.add_option('--disable-shared', action='store_false', default=True, |
| dest='enable_shared', help='Do not build shared library (enabled by default)') |
| |
| opt.add_option('--without-osx-keychain', action='store_false', default=True, |
| dest='with_osx_keychain', help='Do not use macOS Keychain as default TPM (macOS only)') |
| |
| opt.add_option('--without-sqlite-locking', action='store_false', default=True, dest='with_sqlite_locking', |
| help='Disable filesystem locking in sqlite3 database ' |
| '(use unix-dot locking mechanism instead). ' |
| 'This option may be necessary if the home directory is hosted on NFS.') |
| |
| stacktrace_choices = ['backtrace', 'addr2line', 'basic', 'noop'] |
| opt.add_option('--with-stacktrace', action='store', default=None, choices=stacktrace_choices, |
| help='Select the stacktrace backend implementation: ' |
| '%s [default=auto-detect]' % ', '.join(stacktrace_choices)) |
| opt.add_option('--without-stacktrace', action='store_const', const='', dest='with_stacktrace', |
| help='Disable stacktrace support') |
| |
| opt.add_option('--with-examples', action='store_true', default=False, |
| help='Build examples') |
| |
| opt.add_option('--with-tests', action='store_true', default=False, |
| help='Build tests') |
| |
| opt.add_option('--without-tools', action='store_false', default=True, dest='with_tools', |
| help='Do not build tools') |
| |
| def configure(conf): |
| conf.start_msg('Building static library') |
| if conf.options.enable_static: |
| conf.end_msg('yes') |
| else: |
| conf.end_msg('no', color='YELLOW') |
| conf.env.enable_static = conf.options.enable_static |
| |
| conf.start_msg('Building shared library') |
| if conf.options.enable_shared: |
| conf.end_msg('yes') |
| else: |
| conf.end_msg('no', color='YELLOW') |
| conf.env.enable_shared = conf.options.enable_shared |
| |
| if not conf.options.enable_shared and not conf.options.enable_static: |
| conf.fatal('Either static library or shared library must be enabled') |
| |
| conf.load(['compiler_cxx', 'gnu_dirs', 'c_osx', |
| 'cross', 'default-compiler-flags', 'pch', |
| 'osx-frameworks', 'boost', 'openssl', 'sqlite3', |
| 'doxygen', 'sphinx_build']) |
| |
| conf.env.WITH_TESTS = conf.options.with_tests |
| conf.env.WITH_TOOLS = conf.options.with_tools |
| conf.env.WITH_EXAMPLES = conf.options.with_examples |
| |
| conf.find_program('dot', mandatory=False) |
| |
| conf.check_cxx(lib='atomic', uselib_store='ATOMIC', define_name='HAVE_ATOMIC', mandatory=False) |
| conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD', mandatory=False) |
| conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False) |
| |
| conf.check_cxx(msg='Checking for function getpass', define_name='HAVE_GETPASS', mandatory=False, |
| fragment='''#include <unistd.h> |
| int main() { getpass("Enter password"); }''') |
| |
| if conf.check_cxx(msg='Checking for netlink', define_name='HAVE_NETLINK', mandatory=False, |
| header_name=['linux/if_addr.h', 'linux/if_link.h', |
| 'linux/netlink.h', 'linux/rtnetlink.h', 'linux/genetlink.h']): |
| conf.env.HAVE_NETLINK = True |
| conf.check_cxx(msg='Checking for NETLINK_EXT_ACK', define_name='HAVE_NETLINK_EXT_ACK', mandatory=False, |
| fragment='''#include <linux/netlink.h> |
| int main() { return NETLINK_EXT_ACK; }''') |
| conf.check_cxx(msg='Checking for IFA_FLAGS', define_name='HAVE_IFA_FLAGS', mandatory=False, |
| fragment='''#include <linux/if_addr.h> |
| int main() { return IFA_FLAGS; }''') |
| |
| conf.check_osx_frameworks() |
| conf.check_sqlite3() |
| conf.check_openssl(lib='crypto', atleast_version='1.1.1') |
| |
| boost_libs = ['system', 'chrono', 'date_time', 'filesystem', 'thread', 'log'] |
| |
| stacktrace_backend = conf.options.with_stacktrace |
| if stacktrace_backend is None: |
| # auto-detect |
| for candidate in ('backtrace', 'basic'): |
| try: |
| conf.check_boost(lib=f'stacktrace_{candidate}', mt=True) |
| except conf.errors.ConfigurationError: |
| continue |
| stacktrace_backend = candidate |
| break |
| if stacktrace_backend: |
| conf.env.HAVE_STACKTRACE = True |
| conf.env.append_unique('DEFINES_BOOST', ['BOOST_STACKTRACE_DYN_LINK']) |
| boost_libs.append(f'stacktrace_{stacktrace_backend}') |
| |
| conf.check_boost(lib=boost_libs, mt=True) |
| if conf.env.BOOST_VERSION_NUMBER < 106501: |
| conf.fatal('The minimum supported version of Boost is 1.65.1.\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') |
| |
| # Workaround for bug 4860 |
| if conf.env.BOOST_VERSION_NUMBER < 106900 and conf.env.CXX_NAME == 'clang': |
| conf.env.append_unique('DEFINES_BOOST', ['BOOST_ASIO_DISABLE_STD_EXPERIMENTAL_STRING_VIEW']) |
| |
| conf.env.append_unique('DEFINES_BOOST', ['BOOST_FILESYSTEM_NO_DEPRECATED']) |
| |
| if conf.env.WITH_TESTS: |
| conf.check_boost(lib='unit_test_framework', mt=True, uselib_store='BOOST_TESTS') |
| |
| if conf.env.WITH_TOOLS: |
| conf.check_boost(lib='program_options', mt=True, uselib_store='BOOST_TOOLS') |
| |
| conf.check_compiler_flags() |
| |
| # Loading "late" to prevent tests from being compiled with profiling flags |
| conf.load('coverage') |
| conf.load('sanitizers') |
| |
| if not conf.env.enable_static: |
| # 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 ndn-cxx library installed. |
| conf.env.prepend_value('STLIBPATH', ['.']) |
| |
| conf.define_cond('HAVE_STACKTRACE', conf.env.HAVE_STACKTRACE) |
| conf.define_cond('HAVE_TESTS', conf.env.WITH_TESTS) |
| conf.define_cond('WITH_OSX_KEYCHAIN', conf.env.HAVE_OSX_FRAMEWORKS and conf.options.with_osx_keychain) |
| conf.define_cond('DISABLE_SQLITE3_FS_LOCKING', not conf.options.with_sqlite_locking) |
| conf.define('SYSCONFDIR', conf.env.SYSCONFDIR) |
| # 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('ndn-cxx/detail/config.hpp', define_prefix='NDN_CXX_') |
| |
| def build(bld): |
| version(bld) |
| |
| bld(features='subst', |
| name='version.hpp', |
| source='ndn-cxx/version.hpp.in', |
| target='ndn-cxx/version.hpp', |
| install_path=None, |
| VERSION_STRING=VERSION_BASE, |
| VERSION_BUILD=VERSION, |
| VERSION=int(VERSION_SPLIT[0]) * 1000000 + |
| int(VERSION_SPLIT[1]) * 1000 + |
| int(VERSION_SPLIT[2]), |
| VERSION_MAJOR=VERSION_SPLIT[0], |
| VERSION_MINOR=VERSION_SPLIT[1], |
| VERSION_PATCH=VERSION_SPLIT[2]) |
| |
| if bld.env.HAVE_OSX_FRAMEWORKS: |
| # Need to disable precompiled headers for Objective-C++ code |
| bld(features='cxx', |
| target='ndn-cxx-mm-objects', |
| source=bld.path.ant_glob('ndn-cxx/**/*-osx.mm'), |
| use='BOOST PTHREAD OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN', |
| includes='.') |
| |
| libndn_cxx = dict( |
| target='ndn-cxx', |
| source=bld.path.ant_glob('ndn-cxx/**/*.cpp', |
| excl=['ndn-cxx/**/*-android.cpp', |
| 'ndn-cxx/**/*-osx.cpp', |
| 'ndn-cxx/**/*-sqlite3.cpp', |
| 'ndn-cxx/**/*netlink*.cpp']), |
| features='pch', |
| headers='ndn-cxx/impl/common-pch.hpp', |
| use='ndn-cxx-mm-objects version BOOST OPENSSL SQLITE3 ATOMIC RT PTHREAD', |
| includes='.', |
| export_includes='.', |
| install_path='${LIBDIR}') |
| |
| if bld.env.HOST == 'android': |
| libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-android.cpp') |
| |
| if bld.env.HAVE_OSX_FRAMEWORKS: |
| libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-osx.cpp') |
| libndn_cxx['use'] += ' OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN' |
| |
| # In case we want to make it optional later |
| libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.cpp') |
| |
| if bld.env.HAVE_NETLINK: |
| libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*netlink*.cpp') |
| |
| if bld.env.enable_shared: |
| bld.shlib(name='ndn-cxx', |
| vnum=VERSION_BASE, |
| cnum=VERSION_BASE, |
| **libndn_cxx) |
| |
| if bld.env.enable_static: |
| bld.stlib(name='ndn-cxx-static' if bld.env.enable_shared else 'ndn-cxx', |
| **libndn_cxx) |
| |
| # Prepare flags that should go to pkgconfig file |
| pkgconfig_libs = [] |
| pkgconfig_ldflags = [] |
| pkgconfig_linkflags = [] |
| pkgconfig_includes = [] |
| pkgconfig_cxxflags = [] |
| pkgconfig_defines = [] |
| for lib in Utils.to_list(libndn_cxx['use']): |
| if bld.env[f'LIB_{lib}']: |
| pkgconfig_libs += Utils.to_list(bld.env[f'LIB_{lib}']) |
| if bld.env[f'LIBPATH_{lib}']: |
| pkgconfig_ldflags += Utils.to_list(bld.env[f'LIBPATH_{lib}']) |
| if bld.env[f'INCLUDES_{lib}']: |
| pkgconfig_includes += Utils.to_list(bld.env[f'INCLUDES_{lib}']) |
| if bld.env[f'LINKFLAGS_{lib}']: |
| pkgconfig_linkflags += Utils.to_list(bld.env[f'LINKFLAGS_{lib}']) |
| if bld.env[f'CXXFLAGS_{lib}']: |
| pkgconfig_cxxflags += Utils.to_list(bld.env[f'CXXFLAGS_{lib}']) |
| if bld.env[f'DEFINES_{lib}']: |
| pkgconfig_defines += Utils.to_list(bld.env[f'DEFINES_{lib}']) |
| |
| EXTRA_FRAMEWORKS = '' |
| if bld.env.HAVE_OSX_FRAMEWORKS: |
| EXTRA_FRAMEWORKS = '-framework CoreFoundation -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN' |
| |
| def uniq(alist): |
| return list(dict.fromkeys(alist)) |
| |
| bld(features='subst', |
| source='libndn-cxx.pc.in', |
| target='libndn-cxx.pc', |
| install_path='${LIBDIR}/pkgconfig', |
| VERSION=VERSION_BASE, |
| # This probably not the right thing to do, but to simplify life of apps |
| # that use the library |
| EXTRA_LIBS=' '.join([f'-l{i}' for i in uniq(pkgconfig_libs)]), |
| EXTRA_LDFLAGS=' '.join([f'-L{i}' for i in uniq(pkgconfig_ldflags)]), |
| EXTRA_LINKFLAGS=' '.join(uniq(pkgconfig_linkflags)), |
| EXTRA_INCLUDES=' '.join([f'-I{i}' for i in uniq(pkgconfig_includes)]), |
| EXTRA_CXXFLAGS=' '.join(uniq(pkgconfig_cxxflags) + [f'-D{i}' for i in uniq(pkgconfig_defines)]), |
| EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS) |
| |
| if bld.env.WITH_TESTS: |
| bld.recurse('tests') |
| |
| if bld.env.WITH_TOOLS: |
| bld.recurse('tools') |
| |
| if bld.env.WITH_EXAMPLES: |
| bld.recurse('examples') |
| |
| headers = bld.path.ant_glob('ndn-cxx/**/*.hpp', |
| excl=['ndn-cxx/**/*-android.hpp', |
| 'ndn-cxx/**/*-osx.hpp', |
| 'ndn-cxx/**/*-sqlite3.hpp', |
| 'ndn-cxx/**/*netlink*.hpp', |
| 'ndn-cxx/**/impl/**/*']) |
| |
| if bld.env.HOST == 'android': |
| headers += bld.path.ant_glob('ndn-cxx/**/*-android.hpp', excl='ndn-cxx/**/impl/**/*') |
| |
| if bld.env.HAVE_OSX_FRAMEWORKS: |
| headers += bld.path.ant_glob('ndn-cxx/**/*-osx.hpp', excl='ndn-cxx/**/impl/**/*') |
| |
| # In case we want to make it optional later |
| headers += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.hpp', excl='ndn-cxx/**/impl/**/*') |
| |
| if bld.env.HAVE_NETLINK: |
| headers += bld.path.ant_glob('ndn-cxx/**/*netlink*.hpp', excl='ndn-cxx/**/impl/**/*') |
| |
| bld.install_files('${INCLUDEDIR}', headers, relative_trick=True) |
| |
| # Install generated headers |
| for filename in ('ndn-cxx/detail/config.hpp', 'ndn-cxx/version.hpp'): |
| bld.install_files('${INCLUDEDIR}/%s' % os.path.dirname(filename), |
| bld.path.find_resource(filename)) |
| |
| bld.install_files('${SYSCONFDIR}/ndn', 'client.conf.sample') |
| |
| if bld.env.SPHINX_BUILD: |
| bld(features='sphinx', |
| name='manpages', |
| builder='man', |
| config='docs/conf.py', |
| outdir='docs/manpages', |
| source=bld.path.ant_glob('docs/manpages/*.rst'), |
| install_path='${MANDIR}', |
| version=VERSION_BASE, |
| release=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) |