blob: 03cd636bd87849a7278b054bf4bbfd483ac93db1 [file] [log] [blame]
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -08001# -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -08002
Alexander Afanasyev5560fd42018-03-07 17:03:03 -05003from waflib import Context, Logs, Utils
4import os, subprocess
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -07005
Alexander Afanasyevcf8ffd42019-12-29 17:58:53 -08006VERSION = '0.7.0'
Alexander Afanasyev5560fd42018-03-07 17:03:03 -05007APPNAME = 'ndn-cxx'
8PACKAGE_BUGREPORT = 'https://redmine.named-data.net/projects/ndn-cxx'
9PACKAGE_URL = 'http://named-data.net/doc/ndn-cxx/'
10GIT_TAG_PREFIX = 'ndn-cxx-'
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070011
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080012def options(opt):
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070013 opt.load(['compiler_cxx', 'gnu_dirs', 'c_osx'])
Davide Pesavento844b0932018-05-07 01:00:16 -040014 opt.load(['default-compiler-flags', 'compiler-features',
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -050015 'coverage', 'pch', 'sanitizers', 'osx-frameworks',
Alexander Afanasyevadc71842017-01-26 22:17:58 -050016 'boost', 'openssl', 'sqlite3',
Davide Pesavento1349d2d2016-08-09 06:43:57 +020017 'doxygen', 'sphinx_build'],
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070018 tooldir=['.waf-tools'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080019
Davide Pesavento77f1c762019-02-19 03:20:49 -050020 opt = opt.add_option_group('ndn-cxx Options')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080021
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070022 opt.add_option('--enable-static', action='store_true', default=False,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040023 dest='enable_static', help='Build static library (disabled by default)')
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070024 opt.add_option('--disable-static', action='store_false', default=False,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040025 dest='enable_static', help='Do not build static library (disabled by default)')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080026
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070027 opt.add_option('--enable-shared', action='store_true', default=True,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040028 dest='enable_shared', help='Build shared library (enabled by default)')
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070029 opt.add_option('--disable-shared', action='store_false', default=True,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040030 dest='enable_shared', help='Do not build shared library (enabled by default)')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080031
Davide Pesavento77f1c762019-02-19 03:20:49 -050032 opt.add_option('--without-osx-keychain', action='store_false', default=True,
33 dest='with_osx_keychain', help='Do not use macOS Keychain as default TPM (macOS only)')
34
35 opt.add_option('--without-sqlite-locking', action='store_false', default=True, dest='with_sqlite_locking',
36 help='Disable filesystem locking in sqlite3 database '
37 '(use unix-dot locking mechanism instead). '
38 'This option may be necessary if the home directory is hosted on NFS.')
39
40 stacktrace_choices = ['backtrace', 'addr2line', 'basic', 'noop']
41 opt.add_option('--with-stacktrace', action='store', default=None, choices=stacktrace_choices,
42 help='Select the stacktrace backend implementation: '
43 '%s [default=auto-detect]' % ', '.join(stacktrace_choices))
44 opt.add_option('--without-stacktrace', action='store_const', const='', dest='with_stacktrace',
45 help='Disable stacktrace support')
46
47 opt.add_option('--with-examples', action='store_true', default=False,
48 help='Build examples')
49
50 opt.add_option('--with-tests', action='store_true', default=False,
51 help='Build tests')
52
53 opt.add_option('--without-tools', action='store_false', default=True, dest='with_tools',
54 help='Do not build tools')
55
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080056def configure(conf):
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080057 conf.start_msg('Building static library')
58 if conf.options.enable_static:
59 conf.end_msg('yes')
60 else:
61 conf.end_msg('no', color='YELLOW')
62 conf.env.enable_static = conf.options.enable_static
63
64 conf.start_msg('Building shared library')
65 if conf.options.enable_shared:
66 conf.end_msg('yes')
67 else:
68 conf.end_msg('no', color='YELLOW')
69 conf.env.enable_shared = conf.options.enable_shared
70
71 if not conf.options.enable_shared and not conf.options.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050072 conf.fatal('Either static library or shared library must be enabled')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080073
Davide Pesavento1349d2d2016-08-09 06:43:57 +020074 conf.load(['compiler_cxx', 'gnu_dirs', 'c_osx',
Davide Pesavento844b0932018-05-07 01:00:16 -040075 'default-compiler-flags', 'compiler-features',
Alexander Afanasyevadc71842017-01-26 22:17:58 -050076 'pch', 'osx-frameworks', 'boost', 'openssl', 'sqlite3',
Davide Pesavento1349d2d2016-08-09 06:43:57 +020077 'doxygen', 'sphinx_build'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080078
Davide Pesaventofd674012019-02-06 02:00:12 -050079 conf.env.WITH_TESTS = conf.options.with_tests
80 conf.env.WITH_TOOLS = conf.options.with_tools
81 conf.env.WITH_EXAMPLES = conf.options.with_examples
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080082
Davide Pesavento77f1c762019-02-19 03:20:49 -050083 conf.find_program('sh', var='SH')
Alexander Afanasyev95de62e2014-04-11 18:26:33 -070084
Eric Newberry96033252020-04-10 13:08:27 -070085 conf.check_cxx(lib='atomic', uselib_store='ATOMIC', define_name='HAVE_ATOMIC', mandatory=False)
Davide Pesavento2bf35a62017-04-02 00:41:06 -040086 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD', mandatory=False)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070087 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Davide Pesavento78338c52020-04-20 23:00:02 -040088
Davide Pesavento50b92262018-07-11 12:28:31 -040089 conf.check_cxx(msg='Checking for function getpass', define_name='HAVE_GETPASS', mandatory=False,
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050090 fragment='''#include <unistd.h>
91 int main() { getpass("Enter password"); }''')
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070092
Davide Pesavento474c3b22018-08-25 16:24:43 -040093 if conf.check_cxx(msg='Checking for netlink', define_name='HAVE_NETLINK', mandatory=False,
Davide Pesavento2bf35a62017-04-02 00:41:06 -040094 header_name=['linux/if_addr.h', 'linux/if_link.h',
Davide Pesavento474c3b22018-08-25 16:24:43 -040095 'linux/netlink.h', 'linux/rtnetlink.h', 'linux/genetlink.h']):
Davide Pesaventofd674012019-02-06 02:00:12 -050096 conf.env.HAVE_NETLINK = True
Davide Pesavento50b92262018-07-11 12:28:31 -040097 conf.check_cxx(msg='Checking for NETLINK_EXT_ACK', define_name='HAVE_NETLINK_EXT_ACK', mandatory=False,
98 fragment='''#include <linux/netlink.h>
99 int main() { return NETLINK_EXT_ACK; }''')
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400100 conf.check_cxx(msg='Checking for IFA_FLAGS', define_name='HAVE_IFA_FLAGS', mandatory=False,
Davide Pesavento844b0932018-05-07 01:00:16 -0400101 fragment='''#include <linux/if_addr.h>
102 int main() { return IFA_FLAGS; }''')
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -0800103
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500104 conf.check_osx_frameworks()
Davide Pesavento77f1c762019-02-19 03:20:49 -0500105 conf.check_sqlite3()
106 conf.check_openssl(lib='crypto', atleast_version=0x1000200f) # 1.0.2
Yingdi Yue6bfab22014-02-06 16:01:19 -0800107
Davide Pesavento77f1c762019-02-19 03:20:49 -0500108 boost_libs = ['system', 'program_options', 'chrono', 'date_time', 'filesystem', 'thread', 'log']
Junxiao Shi7d054272016-08-04 17:00:41 +0000109
Davide Pesaventofd674012019-02-06 02:00:12 -0500110 stacktrace_backend = conf.options.with_stacktrace
111 if stacktrace_backend is None:
112 # auto-detect
113 for candidate in ['backtrace', 'basic']:
114 try:
115 conf.check_boost(lib='stacktrace_%s' % candidate, mt=True)
116 except conf.errors.ConfigurationError:
117 continue
118 stacktrace_backend = candidate
119 break
120 if stacktrace_backend:
121 conf.env.HAVE_STACKTRACE = True
122 conf.env.append_unique('DEFINES_BOOST', ['BOOST_STACKTRACE_DYN_LINK'])
123 boost_libs.append('stacktrace_%s' % stacktrace_backend)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800124
Davide Pesaventofd674012019-02-06 02:00:12 -0500125 if conf.env.WITH_TESTS:
126 boost_libs.append('unit_test_framework')
127
128 conf.check_boost(lib=boost_libs, mt=True)
Davide Pesavento844b0932018-05-07 01:00:16 -0400129 if conf.env.BOOST_VERSION_NUMBER < 105800:
Davide Pesavento78338c52020-04-20 23:00:02 -0400130 conf.fatal('The minimum supported version of Boost is 1.65.1.\n'
131 'Please upgrade your distribution or manually install a newer version of Boost.\n'
132 'For more information, see https://redmine.named-data.net/projects/nfd/wiki/Boost')
133 elif conf.env.BOOST_VERSION_NUMBER < 106501:
134 Logs.warn('WARNING: Using a version of Boost older than 1.65.1 is not officially supported and may not work.\n'
135 'If you encounter any problems, please upgrade your distribution or manually install a newer version of Boost.\n'
136 'For more information, see https://redmine.named-data.net/projects/nfd/wiki/Boost')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800137
Davide Pesaventofc27d3b2019-03-02 00:47:35 -0500138 # Workaround for bug 4860
139 if conf.env.BOOST_VERSION_NUMBER < 106900 and conf.env.CXX_NAME == 'clang':
140 conf.env.append_unique('DEFINES_BOOST', ['BOOST_ASIO_DISABLE_STD_EXPERIMENTAL_STRING_VIEW'])
141
Alexander Afanasyevb82d8c32017-09-21 11:35:07 -0400142 conf.check_compiler_flags()
143
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500144 # Loading "late" to prevent tests from being compiled with profiling flags
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700145 conf.load('coverage')
Eric Newberrya3973e02016-11-01 17:58:12 -0700146 conf.load('sanitizers')
147
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200148 if not conf.env.enable_static:
149 # If there happens to be a static library, waf will put the corresponding -L flags
150 # before dynamic library flags. This can result in compilation failure when the
151 # system has a different version of the ndn-cxx library installed.
Davide Pesaventofd674012019-02-06 02:00:12 -0500152 conf.env.prepend_value('STLIBPATH', ['.'])
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200153
Davide Pesaventofd674012019-02-06 02:00:12 -0500154 conf.define_cond('HAVE_STACKTRACE', conf.env.HAVE_STACKTRACE)
155 conf.define_cond('HAVE_TESTS', conf.env.WITH_TESTS)
156 conf.define_cond('WITH_OSX_KEYCHAIN', conf.env.HAVE_OSX_FRAMEWORKS and conf.options.with_osx_keychain)
157 conf.define_cond('DISABLE_SQLITE3_FS_LOCKING', not conf.options.with_sqlite_locking)
158 conf.define('SYSCONFDIR', conf.env.SYSCONFDIR)
159 # The config header will contain all defines that were added using conf.define()
160 # or conf.define_cond(). Everything that was added directly to conf.env.DEFINES
161 # will not appear in the config header, but will instead be passed directly to the
162 # compiler on the command line.
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000163 conf.write_config_header('ndn-cxx/detail/config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800164
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700165def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700166 version(bld)
167
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500168 bld(features='subst',
169 name='version.hpp',
Davide Pesavento19442812018-11-23 14:00:04 -0500170 source='ndn-cxx/version.hpp.in',
171 target='ndn-cxx/version.hpp',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700172 install_path=None,
173 VERSION_STRING=VERSION_BASE,
174 VERSION_BUILD=VERSION,
175 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
176 int(VERSION_SPLIT[1]) * 1000 +
177 int(VERSION_SPLIT[2]),
178 VERSION_MAJOR=VERSION_SPLIT[0],
179 VERSION_MINOR=VERSION_SPLIT[1],
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200180 VERSION_PATCH=VERSION_SPLIT[2])
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700181
Davide Pesaventofd674012019-02-06 02:00:12 -0500182 if bld.env.HAVE_OSX_FRAMEWORKS:
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500183 # Need to disable precompiled headers for Objective-C++ code
Davide Pesavento25d4f1c2020-04-29 23:31:04 -0400184 bld(features='cxx',
Davide Pesavento19442812018-11-23 14:00:04 -0500185 target='ndn-cxx-mm-objects',
186 source=bld.path.ant_glob('ndn-cxx/**/*-osx.mm'),
187 use='BOOST PTHREAD OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN',
Davide Pesavento7e780642018-11-24 15:51:34 -0500188 includes='.')
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500189
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800190 libndn_cxx = dict(
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500191 target='ndn-cxx',
Davide Pesavento19442812018-11-23 14:00:04 -0500192 source=bld.path.ant_glob('ndn-cxx/**/*.cpp',
193 excl=['ndn-cxx/**/*-osx.cpp',
194 'ndn-cxx/**/*netlink*.cpp',
195 'ndn-cxx/**/*-sqlite3.cpp']),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500196 features='pch',
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000197 headers='ndn-cxx/impl/common-pch.hpp',
Eric Newberry96033252020-04-10 13:08:27 -0700198 use='ndn-cxx-mm-objects version BOOST OPENSSL SQLITE3 ATOMIC RT PTHREAD',
Davide Pesavento7e780642018-11-24 15:51:34 -0500199 includes='.',
200 export_includes='.',
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200201 install_path='${LIBDIR}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800202
Davide Pesaventofd674012019-02-06 02:00:12 -0500203 if bld.env.HAVE_OSX_FRAMEWORKS:
Davide Pesavento19442812018-11-23 14:00:04 -0500204 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-osx.cpp')
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400205 libndn_cxx['use'] += ' OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN'
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500206
Davide Pesaventofd674012019-02-06 02:00:12 -0500207 if bld.env.HAVE_NETLINK:
Davide Pesavento19442812018-11-23 14:00:04 -0500208 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*netlink*.cpp')
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400209
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800210 # In case we want to make it optional later
Davide Pesavento19442812018-11-23 14:00:04 -0500211 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.cpp')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800212
213 if bld.env.enable_shared:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500214 bld.shlib(name='ndn-cxx',
215 vnum=VERSION_BASE,
216 cnum=VERSION_BASE,
217 **libndn_cxx)
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800218
219 if bld.env.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500220 bld.stlib(name='ndn-cxx-static' if bld.env.enable_shared else 'ndn-cxx',
221 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800222
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700223 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800224 pkgconfig_libs = []
225 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800226 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800227 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800228 pkgconfig_cxxflags = []
Alexander Afanasyev8fdae892019-02-10 16:40:48 -0500229 pkgconfig_defines = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800230 for lib in Utils.to_list(libndn_cxx['use']):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800231 if bld.env['LIB_%s' % lib]:
232 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
233 if bld.env['LIBPATH_%s' % lib]:
234 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
235 if bld.env['INCLUDES_%s' % lib]:
236 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800237 if bld.env['LINKFLAGS_%s' % lib]:
238 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
239 if bld.env['CXXFLAGS_%s' % lib]:
240 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev8fdae892019-02-10 16:40:48 -0500241 if bld.env['DEFINES_%s' % lib]:
242 pkgconfig_defines += Utils.to_list(bld.env['DEFINES_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800243
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500244 EXTRA_FRAMEWORKS = ''
Davide Pesaventofd674012019-02-06 02:00:12 -0500245 if bld.env.HAVE_OSX_FRAMEWORKS:
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400246 EXTRA_FRAMEWORKS = '-framework CoreFoundation -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN'
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800247
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800248 def uniq(alist):
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200249 seen = set()
250 return [x for x in alist if x not in seen and not seen.add(x)]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800251
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500252 pkconfig = bld(features='subst',
253 source='libndn-cxx.pc.in',
254 target='libndn-cxx.pc',
255 install_path='${LIBDIR}/pkgconfig',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700256 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800257
258 # This probably not the right thing to do, but to simplify life of apps
259 # that use the library
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500260 EXTRA_LIBS=' '.join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
261 EXTRA_LDFLAGS=' '.join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
262 EXTRA_LINKFLAGS=' '.join(uniq(pkgconfig_linkflags)),
263 EXTRA_INCLUDES=' '.join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
Davide Pesavento4fb35d82019-10-31 19:33:10 -0400264 EXTRA_CXXFLAGS=' '.join(uniq(pkgconfig_cxxflags) + [('-D%s' % i) for i in uniq(pkgconfig_defines)]),
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200265 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800266
Davide Pesaventofd674012019-02-06 02:00:12 -0500267 if bld.env.WITH_TESTS:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800268 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800269
Davide Pesaventofd674012019-02-06 02:00:12 -0500270 if bld.env.WITH_TOOLS:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500271 bld.recurse('tools')
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700272
Davide Pesaventofd674012019-02-06 02:00:12 -0500273 if bld.env.WITH_EXAMPLES:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500274 bld.recurse('examples')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800275
Davide Pesavento19442812018-11-23 14:00:04 -0500276 headers = bld.path.ant_glob('ndn-cxx/**/*.hpp',
277 excl=['ndn-cxx/**/*-osx.hpp',
278 'ndn-cxx/**/*netlink*.hpp',
279 'ndn-cxx/**/*-sqlite3.hpp',
Junxiao Shi24c5a002018-12-12 04:47:15 +0000280 'ndn-cxx/**/impl/**/*'])
Davide Pesavento50b92262018-07-11 12:28:31 -0400281
Davide Pesaventofd674012019-02-06 02:00:12 -0500282 if bld.env.HAVE_OSX_FRAMEWORKS:
Junxiao Shi24c5a002018-12-12 04:47:15 +0000283 headers += bld.path.ant_glob('ndn-cxx/**/*-osx.hpp', excl='ndn-cxx/**/impl/**/*')
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500284
Davide Pesaventofd674012019-02-06 02:00:12 -0500285 if bld.env.HAVE_NETLINK:
Junxiao Shi24c5a002018-12-12 04:47:15 +0000286 headers += bld.path.ant_glob('ndn-cxx/**/*netlink*.hpp', excl='ndn-cxx/**/impl/**/*')
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500287
288 # In case we want to make it optional later
Junxiao Shi24c5a002018-12-12 04:47:15 +0000289 headers += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.hpp', excl='ndn-cxx/**/impl/**/*')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700290
Davide Pesaventofd674012019-02-06 02:00:12 -0500291 bld.install_files(bld.env.INCLUDEDIR, headers, relative_trick=True)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800292
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000293 # Install generated headers
294 for filename in ['ndn-cxx/detail/config.hpp', 'ndn-cxx/version.hpp']:
Davide Pesaventofd674012019-02-06 02:00:12 -0500295 bld.install_files('%s/%s' % (bld.env.INCLUDEDIR, os.path.dirname(filename)),
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000296 bld.path.find_resource(filename))
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700297
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500298 bld.install_files('${SYSCONFDIR}/ndn', 'client.conf.sample')
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600299
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500300 if bld.env.SPHINX_BUILD:
301 bld(features='sphinx',
302 name='manpages',
303 builder='man',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500304 config='docs/conf.py',
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400305 outdir='docs/manpages',
Davide Pesaventob310efb2019-04-11 22:10:24 -0400306 source=bld.path.ant_glob('docs/manpages/*.rst'),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500307 install_path='${MANDIR}',
Davide Pesaventob310efb2019-04-11 22:10:24 -0400308 version=VERSION_BASE,
309 release=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700310
311def docs(bld):
312 from waflib import Options
313 Options.commands = ['doxygen', 'sphinx'] + Options.commands
314
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000315def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700316 version(bld)
317
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800318 if not bld.env.DOXYGEN:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500319 bld.fatal('Cannot build documentation ("doxygen" not found in PATH)')
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700320
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500321 bld(features='subst',
322 name='doxygen.conf',
323 source=['docs/doxygen.conf.in',
324 'docs/named_data_theme/named_data_footer-with-analytics.html.in'],
325 target=['docs/doxygen.conf',
326 'docs/named_data_theme/named_data_footer-with-analytics.html'],
327 VERSION=VERSION,
328 HTML_FOOTER='../build/docs/named_data_theme/named_data_footer-with-analytics.html' \
329 if os.getenv('GOOGLE_ANALYTICS', None) \
330 else '../docs/named_data_theme/named_data_footer.html',
331 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ''))
332
333 bld(features='doxygen',
334 doxyfile='docs/doxygen.conf',
335 use='doxygen.conf')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800336
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700337def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700338 version(bld)
339
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700340 if not bld.env.SPHINX_BUILD:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500341 bld.fatal('Cannot build documentation ("sphinx-build" not found in PATH)')
342
343 bld(features='sphinx',
344 config='docs/conf.py',
345 outdir='docs',
346 source=bld.path.ant_glob('docs/**/*.rst'),
Davide Pesaventob310efb2019-04-11 22:10:24 -0400347 version=VERSION_BASE,
348 release=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700349
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700350def version(ctx):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500351 # don't execute more than once
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700352 if getattr(Context.g_module, 'VERSION_BASE', None):
353 return
354
355 Context.g_module.VERSION_BASE = Context.g_module.VERSION
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500356 Context.g_module.VERSION_SPLIT = VERSION_BASE.split('.')
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700357
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500358 # first, try to get a version string from git
359 gotVersionFromGit = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700360 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700361 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500362 out = subprocess.check_output(cmd, universal_newlines=True).strip()
363 if out:
364 gotVersionFromGit = True
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700365 if out.startswith(GIT_TAG_PREFIX):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500366 Context.g_module.VERSION = out.lstrip(GIT_TAG_PREFIX)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700367 else:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500368 # no tags matched
369 Context.g_module.VERSION = '%s-commit-%s' % (VERSION_BASE, out)
Davide Pesavento21be8162018-05-10 20:36:37 -0400370 except (OSError, subprocess.CalledProcessError):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700371 pass
372
Alexander Afanasyev3de8aac2020-05-28 20:51:43 -0400373 versionFile = ctx.path.find_node('VERSION.info')
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500374 if not gotVersionFromGit and versionFile is not None:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700375 try:
376 Context.g_module.VERSION = versionFile.read()
377 return
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500378 except EnvironmentError:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700379 pass
380
381 # version was obtained from git, update VERSION file if necessary
382 if versionFile is not None:
383 try:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500384 if versionFile.read() == Context.g_module.VERSION:
385 # already up-to-date
386 return
387 except EnvironmentError as e:
388 Logs.warn('%s exists but is not readable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700389 else:
Alexander Afanasyev3de8aac2020-05-28 20:51:43 -0400390 versionFile = ctx.path.make_node('VERSION.info')
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700391
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700392 try:
393 versionFile.write(Context.g_module.VERSION)
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500394 except EnvironmentError as e:
395 Logs.warn('%s is not writable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700396
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700397def dist(ctx):
398 version(ctx)
399
400def distcheck(ctx):
401 version(ctx)