383 lines
15 KiB
Python
383 lines
15 KiB
Python
# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
|
|
|
|
from waflib import Logs, Utils, Context
|
|
import os
|
|
|
|
VERSION = "0.6.0"
|
|
APPNAME = "ndn-cxx"
|
|
PACKAGE_BUGREPORT = "https://redmine.named-data.net/projects/ndn-cxx"
|
|
PACKAGE_URL = "http://named-data.net/doc/ndn-cxx/"
|
|
GIT_TAG_PREFIX = "ndn-cxx-"
|
|
|
|
def options(opt):
|
|
opt.load(['compiler_cxx', 'gnu_dirs', 'c_osx'])
|
|
opt.load(['default-compiler-flags', 'compiler-features', 'type_traits',
|
|
'coverage', 'pch', 'sanitizers', 'osx-frameworks',
|
|
'boost', 'openssl', 'sqlite3',
|
|
'doxygen', 'sphinx_build'],
|
|
tooldir=['.waf-tools'])
|
|
|
|
opt = opt.add_option_group('Library Options')
|
|
|
|
opt.add_option('--with-tests', action='store_true', default=False, dest='with_tests',
|
|
help='''Build unit tests''')
|
|
|
|
opt.add_option('--without-tools', action='store_false', default=True, dest='with_tools',
|
|
help='''Do not build tools''')
|
|
|
|
opt.add_option('--with-examples', action='store_true', default=False, dest='with_examples',
|
|
help='''Build examples''')
|
|
|
|
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 home directory is hosted on NFS.''')
|
|
|
|
opt.add_option('--without-osx-keychain', action='store_false', default=True,
|
|
dest='with_osx_keychain',
|
|
help='''On Darwin, do not use OSX keychain as a default TPM''')
|
|
|
|
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)''')
|
|
|
|
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',
|
|
'default-compiler-flags', 'compiler-features', 'type_traits',
|
|
'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('sh', var='SH', mandatory=True)
|
|
|
|
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(function_name='getpass', header_name='unistd.h', mandatory=False)
|
|
|
|
if conf.check_cxx(msg='Checking for rtnetlink', define_name='HAVE_RTNETLINK', mandatory=False,
|
|
header_name=['linux/if_addr.h', 'linux/if_link.h',
|
|
'linux/netlink.h', 'linux/rtnetlink.h']):
|
|
conf.env['HAVE_RTNETLINK'] = True
|
|
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(mandatory=True)
|
|
conf.check_openssl(mandatory=True, atleast_version=0x10001000) # 1.0.1
|
|
|
|
USED_BOOST_LIBS = ['system', 'filesystem', 'date_time', 'iostreams',
|
|
'regex', 'program_options', 'chrono', 'thread',
|
|
'log', 'log_setup']
|
|
|
|
if conf.env['WITH_TESTS']:
|
|
USED_BOOST_LIBS += ['unit_test_framework']
|
|
conf.define('HAVE_TESTS', 1)
|
|
|
|
conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True, mt=True)
|
|
if conf.env.BOOST_VERSION_NUMBER < 105400:
|
|
Logs.error("Minimum required boost version is 1.54.0")
|
|
Logs.error("Please upgrade your distribution or install custom boost libraries" +
|
|
" (https://redmine.named-data.net/projects/nfd/wiki/Boost_FAQ)")
|
|
return
|
|
|
|
if conf.env['CXX_NAME'] == 'clang' and conf.env.BOOST_VERSION_NUMBER < 105800:
|
|
conf.env.append_value('DEFINES', 'BOOST_ASIO_HAS_STD_ARRAY=1') # Bug #4096
|
|
|
|
if not conf.options.with_sqlite_locking:
|
|
conf.define('DISABLE_SQLITE3_FS_LOCKING', 1)
|
|
|
|
if conf.env['HAVE_OSX_FRAMEWORKS']:
|
|
conf.env['WITH_OSX_KEYCHAIN'] = conf.options.with_osx_keychain
|
|
if conf.options.with_osx_keychain:
|
|
conf.define('WITH_OSX_KEYCHAIN', 1)
|
|
else:
|
|
conf.env['WITH_OSX_KEYCHAIN'] = False
|
|
|
|
conf.check_compiler_flags()
|
|
|
|
# Loading "late" to prevent tests to be compiled with profiling flags
|
|
conf.load('coverage')
|
|
|
|
conf.load('sanitizers')
|
|
|
|
conf.define('SYSCONFDIR', conf.env['SYSCONFDIR'])
|
|
|
|
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['STLIBPATH'] = ['.'] + conf.env['STLIBPATH']
|
|
|
|
# config file will contain all defines that were added using conf.define('xxx'...)
|
|
# Everything that was added directly to conf.env['DEFINES'] will not appear in the
|
|
# config file and will be added using compiler directives in the command line.
|
|
conf.write_config_header('src/ndn-cxx-config.hpp', define_prefix='NDN_CXX_')
|
|
|
|
def build(bld):
|
|
version(bld)
|
|
|
|
bld(features="subst",
|
|
name='version',
|
|
source='src/version.hpp.in',
|
|
target='src/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",
|
|
name="ndn-cxx-mm",
|
|
source=bld.path.ant_glob(['src/**/*-osx.mm']),
|
|
use='version BOOST OPENSSL SQLITE3 RT PTHREAD OSX_COREFOUNDATION OSX_CORESERVICES OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN',
|
|
includes=". src")
|
|
|
|
libndn_cxx = dict(
|
|
target="ndn-cxx",
|
|
name="ndn-cxx",
|
|
source=bld.path.ant_glob('src/**/*.cpp',
|
|
excl=['src/**/*-osx.cpp',
|
|
'src/**/*-rtnl.cpp',
|
|
'src/**/*-sqlite3.cpp']),
|
|
headers='src/common-pch.hpp',
|
|
use='version ndn-cxx-mm BOOST OPENSSL SQLITE3 RT PTHREAD',
|
|
includes=". src",
|
|
export_includes="src",
|
|
install_path='${LIBDIR}')
|
|
|
|
if bld.env['HAVE_OSX_FRAMEWORKS']:
|
|
libndn_cxx['source'] += bld.path.ant_glob('src/**/*-osx.cpp')
|
|
libndn_cxx['use'] += " OSX_COREFOUNDATION OSX_CORESERVICES OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN"
|
|
|
|
if bld.env['HAVE_RTNETLINK']:
|
|
libndn_cxx['source'] += bld.path.ant_glob('src/**/*-rtnl.cpp')
|
|
|
|
# In case we want to make it optional later
|
|
libndn_cxx['source'] += bld.path.ant_glob('src/**/*-sqlite3.cpp')
|
|
|
|
if bld.env.enable_shared:
|
|
bld(features=['pch', 'cxx', 'cxxshlib'],
|
|
vnum=VERSION_BASE,
|
|
cnum=VERSION_BASE,
|
|
**libndn_cxx)
|
|
|
|
if bld.env.enable_static:
|
|
bld(features=['pch', 'cxx', 'cxxstlib'],
|
|
**libndn_cxx)
|
|
|
|
# Prepare flags that should go to pkgconfig file
|
|
pkgconfig_libs = []
|
|
pkgconfig_ldflags = []
|
|
pkgconfig_linkflags = []
|
|
pkgconfig_includes = []
|
|
pkgconfig_cxxflags = []
|
|
for lib in Utils.to_list(libndn_cxx['use']):
|
|
if bld.env['LIB_%s' % lib]:
|
|
pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
|
|
if bld.env['LIBPATH_%s' % lib]:
|
|
pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
|
|
if bld.env['INCLUDES_%s' % lib]:
|
|
pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
|
|
if bld.env['LINKFLAGS_%s' % lib]:
|
|
pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
|
|
if bld.env['CXXFLAGS_%s' % lib]:
|
|
pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
|
|
|
|
EXTRA_FRAMEWORKS = ""
|
|
if bld.env['HAVE_OSX_FRAMEWORKS']:
|
|
EXTRA_FRAMEWORKS = "-framework CoreFoundation -framework CoreServices -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN"
|
|
|
|
def uniq(alist):
|
|
seen = set()
|
|
return [x for x in alist if x not in seen and not seen.add(x)]
|
|
|
|
pkconfig = 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([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
|
|
EXTRA_LDFLAGS=" ".join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
|
|
EXTRA_LINKFLAGS=" ".join(uniq(pkgconfig_linkflags)),
|
|
EXTRA_INCLUDES=" ".join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
|
|
EXTRA_CXXFLAGS=" ".join(uniq(pkgconfig_cxxflags)),
|
|
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('src/**/*.hpp',
|
|
excl=['src/**/*-osx.hpp',
|
|
'src/**/*-rtnl.hpp',
|
|
'src/**/*-sqlite3.hpp',
|
|
'src/**/detail/**/*'])
|
|
if bld.env['HAVE_OSX_FRAMEWORKS']:
|
|
headers += bld.path.ant_glob('src/**/*-osx.hpp', excl='src/**/detail/**/*')
|
|
|
|
if bld.env['HAVE_RTNETLINK']:
|
|
headers += bld.path.ant_glob('src/**/*-rtnl.hpp', excl='src/**/detail/**/*')
|
|
|
|
# In case we want to make it optional later
|
|
headers += bld.path.ant_glob('src/**/*-sqlite3.hpp', excl='src/**/detail/**/*')
|
|
|
|
bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'], headers,
|
|
relative_trick=True, cwd=bld.path.find_node('src'))
|
|
|
|
bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
|
|
bld.path.find_resource('src/ndn-cxx-config.hpp'))
|
|
|
|
bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
|
|
bld.path.find_resource('src/version.hpp'))
|
|
|
|
bld.install_files("${SYSCONFDIR}/ndn", "client.conf.sample")
|
|
|
|
if bld.env['SPHINX_BUILD']:
|
|
bld(features="sphinx",
|
|
builder="man",
|
|
outdir="docs/manpages",
|
|
config="docs/conf.py",
|
|
source=bld.path.ant_glob('docs/manpages/**/*.rst'),
|
|
install_path="${MANDIR}/",
|
|
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:
|
|
Logs.error("ERROR: cannot build documentation (`doxygen' not found in $PATH)")
|
|
else:
|
|
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,
|
|
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("ERROR: cannot build documentation (`sphinx-build' not found in $PATH)")
|
|
else:
|
|
bld(features="sphinx",
|
|
outdir="docs",
|
|
source=bld.path.ant_glob("docs/**/*.rst"),
|
|
config="docs/conf.py",
|
|
VERSION=VERSION)
|
|
|
|
def version(ctx):
|
|
if getattr(Context.g_module, 'VERSION_BASE', None):
|
|
return
|
|
|
|
Context.g_module.VERSION_BASE = Context.g_module.VERSION
|
|
Context.g_module.VERSION_SPLIT = [v for v in VERSION_BASE.split('.')]
|
|
|
|
didGetVersion = False
|
|
try:
|
|
cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
|
|
p = Utils.subprocess.Popen(cmd, stdout=Utils.subprocess.PIPE,
|
|
stderr=None, stdin=None)
|
|
out = str(p.communicate()[0].strip())
|
|
didGetVersion = (p.returncode == 0 and out != "")
|
|
if didGetVersion:
|
|
if out.startswith(GIT_TAG_PREFIX):
|
|
Context.g_module.VERSION = out[len(GIT_TAG_PREFIX):]
|
|
else:
|
|
Context.g_module.VERSION = "%s-commit-%s" % (Context.g_module.VERSION_BASE, out)
|
|
except OSError:
|
|
pass
|
|
|
|
versionFile = ctx.path.find_node('VERSION')
|
|
|
|
if not didGetVersion and versionFile is not None:
|
|
try:
|
|
Context.g_module.VERSION = versionFile.read()
|
|
return
|
|
except (OSError, IOError):
|
|
pass
|
|
|
|
# version was obtained from git, update VERSION file if necessary
|
|
if versionFile is not None:
|
|
try:
|
|
version = versionFile.read()
|
|
if version == Context.g_module.VERSION:
|
|
return # no need to update
|
|
except (OSError, IOError):
|
|
Logs.warn("VERSION file exists, but not readable")
|
|
else:
|
|
versionFile = ctx.path.make_node('VERSION')
|
|
|
|
if versionFile is None:
|
|
return
|
|
|
|
try:
|
|
versionFile.write(Context.g_module.VERSION)
|
|
except (OSError, IOError):
|
|
Logs.warn("VERSION file is not writeable")
|
|
|
|
def dist(ctx):
|
|
version(ctx)
|
|
|
|
def distcheck(ctx):
|
|
version(ctx)
|