blob: c28bed1c86a6ff3e203962027da569395b97d70d [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
Eric Newberrybdfb53a2020-10-01 10:43:46 -07006VERSION = '0.7.1'
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'])
Alexander Afanasyev39535f42019-07-05 22:07:52 -040014 opt.load(['cross', '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
Alexander Afanasyev39535f42019-07-05 22:07:52 -040074 conf.load(['cross', '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')
Davide Pesaventodbe645f2021-04-16 00:42:52 -040084 conf.find_program('dot', var='DOT', mandatory=False)
Alexander Afanasyev95de62e2014-04-11 18:26:33 -070085
Eric Newberry96033252020-04-10 13:08:27 -070086 conf.check_cxx(lib='atomic', uselib_store='ATOMIC', define_name='HAVE_ATOMIC', mandatory=False)
Davide Pesavento2bf35a62017-04-02 00:41:06 -040087 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD', mandatory=False)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070088 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Davide Pesavento78338c52020-04-20 23:00:02 -040089
Davide Pesavento50b92262018-07-11 12:28:31 -040090 conf.check_cxx(msg='Checking for function getpass', define_name='HAVE_GETPASS', mandatory=False,
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050091 fragment='''#include <unistd.h>
92 int main() { getpass("Enter password"); }''')
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070093
Davide Pesavento474c3b22018-08-25 16:24:43 -040094 if conf.check_cxx(msg='Checking for netlink', define_name='HAVE_NETLINK', mandatory=False,
Davide Pesavento2bf35a62017-04-02 00:41:06 -040095 header_name=['linux/if_addr.h', 'linux/if_link.h',
Davide Pesavento474c3b22018-08-25 16:24:43 -040096 'linux/netlink.h', 'linux/rtnetlink.h', 'linux/genetlink.h']):
Davide Pesaventofd674012019-02-06 02:00:12 -050097 conf.env.HAVE_NETLINK = True
Davide Pesavento50b92262018-07-11 12:28:31 -040098 conf.check_cxx(msg='Checking for NETLINK_EXT_ACK', define_name='HAVE_NETLINK_EXT_ACK', mandatory=False,
99 fragment='''#include <linux/netlink.h>
100 int main() { return NETLINK_EXT_ACK; }''')
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400101 conf.check_cxx(msg='Checking for IFA_FLAGS', define_name='HAVE_IFA_FLAGS', mandatory=False,
Davide Pesavento844b0932018-05-07 01:00:16 -0400102 fragment='''#include <linux/if_addr.h>
103 int main() { return IFA_FLAGS; }''')
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -0800104
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500105 conf.check_osx_frameworks()
Davide Pesavento77f1c762019-02-19 03:20:49 -0500106 conf.check_sqlite3()
107 conf.check_openssl(lib='crypto', atleast_version=0x1000200f) # 1.0.2
Yingdi Yue6bfab22014-02-06 16:01:19 -0800108
Davide Pesavento77f1c762019-02-19 03:20:49 -0500109 boost_libs = ['system', 'program_options', 'chrono', 'date_time', 'filesystem', 'thread', 'log']
Junxiao Shi7d054272016-08-04 17:00:41 +0000110
Davide Pesaventofd674012019-02-06 02:00:12 -0500111 stacktrace_backend = conf.options.with_stacktrace
112 if stacktrace_backend is None:
113 # auto-detect
Davide Pesaventof3089c32021-05-25 21:28:21 -0400114 for candidate in ('backtrace', 'basic'):
Davide Pesaventofd674012019-02-06 02:00:12 -0500115 try:
116 conf.check_boost(lib='stacktrace_%s' % candidate, mt=True)
117 except conf.errors.ConfigurationError:
118 continue
119 stacktrace_backend = candidate
120 break
121 if stacktrace_backend:
122 conf.env.HAVE_STACKTRACE = True
123 conf.env.append_unique('DEFINES_BOOST', ['BOOST_STACKTRACE_DYN_LINK'])
124 boost_libs.append('stacktrace_%s' % stacktrace_backend)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800125
Davide Pesaventofd674012019-02-06 02:00:12 -0500126 if conf.env.WITH_TESTS:
127 boost_libs.append('unit_test_framework')
128
129 conf.check_boost(lib=boost_libs, mt=True)
Davide Pesavento844b0932018-05-07 01:00:16 -0400130 if conf.env.BOOST_VERSION_NUMBER < 105800:
Davide Pesavento78338c52020-04-20 23:00:02 -0400131 conf.fatal('The minimum supported version of Boost is 1.65.1.\n'
132 'Please upgrade your distribution or manually install a newer version of Boost.\n'
133 'For more information, see https://redmine.named-data.net/projects/nfd/wiki/Boost')
134 elif conf.env.BOOST_VERSION_NUMBER < 106501:
135 Logs.warn('WARNING: Using a version of Boost older than 1.65.1 is not officially supported and may not work.\n'
136 'If you encounter any problems, please upgrade your distribution or manually install a newer version of Boost.\n'
137 'For more information, see https://redmine.named-data.net/projects/nfd/wiki/Boost')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800138
Davide Pesaventofc27d3b2019-03-02 00:47:35 -0500139 # Workaround for bug 4860
140 if conf.env.BOOST_VERSION_NUMBER < 106900 and conf.env.CXX_NAME == 'clang':
141 conf.env.append_unique('DEFINES_BOOST', ['BOOST_ASIO_DISABLE_STD_EXPERIMENTAL_STRING_VIEW'])
142
Davide Pesaventod8e0cad2021-05-26 21:43:47 -0400143 conf.env.append_unique('DEFINES_BOOST', ['BOOST_FILESYSTEM_NO_DEPRECATED'])
144
Alexander Afanasyevb82d8c32017-09-21 11:35:07 -0400145 conf.check_compiler_flags()
146
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500147 # Loading "late" to prevent tests from being compiled with profiling flags
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700148 conf.load('coverage')
Eric Newberrya3973e02016-11-01 17:58:12 -0700149 conf.load('sanitizers')
150
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200151 if not conf.env.enable_static:
152 # If there happens to be a static library, waf will put the corresponding -L flags
153 # before dynamic library flags. This can result in compilation failure when the
154 # system has a different version of the ndn-cxx library installed.
Davide Pesaventofd674012019-02-06 02:00:12 -0500155 conf.env.prepend_value('STLIBPATH', ['.'])
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200156
Davide Pesaventofd674012019-02-06 02:00:12 -0500157 conf.define_cond('HAVE_STACKTRACE', conf.env.HAVE_STACKTRACE)
158 conf.define_cond('HAVE_TESTS', conf.env.WITH_TESTS)
159 conf.define_cond('WITH_OSX_KEYCHAIN', conf.env.HAVE_OSX_FRAMEWORKS and conf.options.with_osx_keychain)
160 conf.define_cond('DISABLE_SQLITE3_FS_LOCKING', not conf.options.with_sqlite_locking)
161 conf.define('SYSCONFDIR', conf.env.SYSCONFDIR)
162 # The config header will contain all defines that were added using conf.define()
163 # or conf.define_cond(). Everything that was added directly to conf.env.DEFINES
164 # will not appear in the config header, but will instead be passed directly to the
165 # compiler on the command line.
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000166 conf.write_config_header('ndn-cxx/detail/config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800167
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700168def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700169 version(bld)
170
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500171 bld(features='subst',
172 name='version.hpp',
Davide Pesavento19442812018-11-23 14:00:04 -0500173 source='ndn-cxx/version.hpp.in',
174 target='ndn-cxx/version.hpp',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700175 install_path=None,
176 VERSION_STRING=VERSION_BASE,
177 VERSION_BUILD=VERSION,
178 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
179 int(VERSION_SPLIT[1]) * 1000 +
180 int(VERSION_SPLIT[2]),
181 VERSION_MAJOR=VERSION_SPLIT[0],
182 VERSION_MINOR=VERSION_SPLIT[1],
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200183 VERSION_PATCH=VERSION_SPLIT[2])
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700184
Davide Pesaventofd674012019-02-06 02:00:12 -0500185 if bld.env.HAVE_OSX_FRAMEWORKS:
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500186 # Need to disable precompiled headers for Objective-C++ code
Davide Pesavento25d4f1c2020-04-29 23:31:04 -0400187 bld(features='cxx',
Davide Pesavento19442812018-11-23 14:00:04 -0500188 target='ndn-cxx-mm-objects',
189 source=bld.path.ant_glob('ndn-cxx/**/*-osx.mm'),
190 use='BOOST PTHREAD OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN',
Davide Pesavento7e780642018-11-24 15:51:34 -0500191 includes='.')
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500192
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800193 libndn_cxx = dict(
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500194 target='ndn-cxx',
Davide Pesavento19442812018-11-23 14:00:04 -0500195 source=bld.path.ant_glob('ndn-cxx/**/*.cpp',
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400196 excl=['ndn-cxx/**/*-android.cpp',
197 'ndn-cxx/**/*-osx.cpp',
198 'ndn-cxx/**/*-sqlite3.cpp',
199 'ndn-cxx/**/*netlink*.cpp']),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500200 features='pch',
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000201 headers='ndn-cxx/impl/common-pch.hpp',
Eric Newberry96033252020-04-10 13:08:27 -0700202 use='ndn-cxx-mm-objects version BOOST OPENSSL SQLITE3 ATOMIC RT PTHREAD',
Davide Pesavento7e780642018-11-24 15:51:34 -0500203 includes='.',
204 export_includes='.',
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200205 install_path='${LIBDIR}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800206
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400207 if bld.env.HOST == 'android':
208 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-android.cpp')
209
Davide Pesaventofd674012019-02-06 02:00:12 -0500210 if bld.env.HAVE_OSX_FRAMEWORKS:
Davide Pesavento19442812018-11-23 14:00:04 -0500211 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-osx.cpp')
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400212 libndn_cxx['use'] += ' OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN'
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500213
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800214 # In case we want to make it optional later
Davide Pesavento19442812018-11-23 14:00:04 -0500215 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.cpp')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800216
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400217 if bld.env.HAVE_NETLINK:
218 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*netlink*.cpp')
219
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800220 if bld.env.enable_shared:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500221 bld.shlib(name='ndn-cxx',
222 vnum=VERSION_BASE,
223 cnum=VERSION_BASE,
224 **libndn_cxx)
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800225
226 if bld.env.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500227 bld.stlib(name='ndn-cxx-static' if bld.env.enable_shared else 'ndn-cxx',
228 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800229
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700230 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800231 pkgconfig_libs = []
232 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800233 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800234 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800235 pkgconfig_cxxflags = []
Alexander Afanasyev8fdae892019-02-10 16:40:48 -0500236 pkgconfig_defines = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800237 for lib in Utils.to_list(libndn_cxx['use']):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800238 if bld.env['LIB_%s' % lib]:
239 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
240 if bld.env['LIBPATH_%s' % lib]:
241 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
242 if bld.env['INCLUDES_%s' % lib]:
243 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800244 if bld.env['LINKFLAGS_%s' % lib]:
245 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
246 if bld.env['CXXFLAGS_%s' % lib]:
247 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev8fdae892019-02-10 16:40:48 -0500248 if bld.env['DEFINES_%s' % lib]:
249 pkgconfig_defines += Utils.to_list(bld.env['DEFINES_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800250
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500251 EXTRA_FRAMEWORKS = ''
Davide Pesaventofd674012019-02-06 02:00:12 -0500252 if bld.env.HAVE_OSX_FRAMEWORKS:
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400253 EXTRA_FRAMEWORKS = '-framework CoreFoundation -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN'
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800254
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800255 def uniq(alist):
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200256 seen = set()
257 return [x for x in alist if x not in seen and not seen.add(x)]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800258
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500259 pkconfig = bld(features='subst',
260 source='libndn-cxx.pc.in',
261 target='libndn-cxx.pc',
262 install_path='${LIBDIR}/pkgconfig',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700263 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800264
265 # This probably not the right thing to do, but to simplify life of apps
266 # that use the library
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500267 EXTRA_LIBS=' '.join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
268 EXTRA_LDFLAGS=' '.join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
269 EXTRA_LINKFLAGS=' '.join(uniq(pkgconfig_linkflags)),
270 EXTRA_INCLUDES=' '.join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
Davide Pesavento4fb35d82019-10-31 19:33:10 -0400271 EXTRA_CXXFLAGS=' '.join(uniq(pkgconfig_cxxflags) + [('-D%s' % i) for i in uniq(pkgconfig_defines)]),
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200272 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800273
Davide Pesaventofd674012019-02-06 02:00:12 -0500274 if bld.env.WITH_TESTS:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800275 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800276
Davide Pesaventofd674012019-02-06 02:00:12 -0500277 if bld.env.WITH_TOOLS:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500278 bld.recurse('tools')
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700279
Davide Pesaventofd674012019-02-06 02:00:12 -0500280 if bld.env.WITH_EXAMPLES:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500281 bld.recurse('examples')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800282
Davide Pesavento19442812018-11-23 14:00:04 -0500283 headers = bld.path.ant_glob('ndn-cxx/**/*.hpp',
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400284 excl=['ndn-cxx/**/*-android.hpp',
285 'ndn-cxx/**/*-osx.hpp',
Davide Pesavento19442812018-11-23 14:00:04 -0500286 'ndn-cxx/**/*-sqlite3.hpp',
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400287 'ndn-cxx/**/*netlink*.hpp',
Junxiao Shi24c5a002018-12-12 04:47:15 +0000288 'ndn-cxx/**/impl/**/*'])
Davide Pesavento50b92262018-07-11 12:28:31 -0400289
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400290 if bld.env.HOST == 'android':
291 headers += bld.path.ant_glob('ndn-cxx/**/*-android.hpp', excl='ndn-cxx/**/impl/**/*')
292
Davide Pesaventofd674012019-02-06 02:00:12 -0500293 if bld.env.HAVE_OSX_FRAMEWORKS:
Junxiao Shi24c5a002018-12-12 04:47:15 +0000294 headers += bld.path.ant_glob('ndn-cxx/**/*-osx.hpp', excl='ndn-cxx/**/impl/**/*')
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500295
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500296 # In case we want to make it optional later
Junxiao Shi24c5a002018-12-12 04:47:15 +0000297 headers += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.hpp', excl='ndn-cxx/**/impl/**/*')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700298
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400299 if bld.env.HAVE_NETLINK:
300 headers += bld.path.ant_glob('ndn-cxx/**/*netlink*.hpp', excl='ndn-cxx/**/impl/**/*')
301
Davide Pesaventof3089c32021-05-25 21:28:21 -0400302 bld.install_files('${INCLUDEDIR}', headers, relative_trick=True)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800303
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000304 # Install generated headers
Davide Pesaventof3089c32021-05-25 21:28:21 -0400305 for filename in ('ndn-cxx/detail/config.hpp', 'ndn-cxx/version.hpp'):
306 bld.install_files('${INCLUDEDIR}/%s' % os.path.dirname(filename),
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000307 bld.path.find_resource(filename))
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700308
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500309 bld.install_files('${SYSCONFDIR}/ndn', 'client.conf.sample')
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600310
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500311 if bld.env.SPHINX_BUILD:
312 bld(features='sphinx',
313 name='manpages',
314 builder='man',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500315 config='docs/conf.py',
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400316 outdir='docs/manpages',
Davide Pesaventob310efb2019-04-11 22:10:24 -0400317 source=bld.path.ant_glob('docs/manpages/*.rst'),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500318 install_path='${MANDIR}',
Davide Pesaventob310efb2019-04-11 22:10:24 -0400319 version=VERSION_BASE,
320 release=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700321
322def docs(bld):
323 from waflib import Options
324 Options.commands = ['doxygen', 'sphinx'] + Options.commands
325
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000326def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700327 version(bld)
328
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800329 if not bld.env.DOXYGEN:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500330 bld.fatal('Cannot build documentation ("doxygen" not found in PATH)')
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700331
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500332 bld(features='subst',
333 name='doxygen.conf',
334 source=['docs/doxygen.conf.in',
335 'docs/named_data_theme/named_data_footer-with-analytics.html.in'],
336 target=['docs/doxygen.conf',
337 'docs/named_data_theme/named_data_footer-with-analytics.html'],
338 VERSION=VERSION,
Davide Pesaventodbe645f2021-04-16 00:42:52 -0400339 HAVE_DOT='YES' if bld.env.DOT else 'NO',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500340 HTML_FOOTER='../build/docs/named_data_theme/named_data_footer-with-analytics.html' \
341 if os.getenv('GOOGLE_ANALYTICS', None) \
342 else '../docs/named_data_theme/named_data_footer.html',
343 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ''))
344
345 bld(features='doxygen',
346 doxyfile='docs/doxygen.conf',
347 use='doxygen.conf')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800348
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700349def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700350 version(bld)
351
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700352 if not bld.env.SPHINX_BUILD:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500353 bld.fatal('Cannot build documentation ("sphinx-build" not found in PATH)')
354
355 bld(features='sphinx',
356 config='docs/conf.py',
357 outdir='docs',
358 source=bld.path.ant_glob('docs/**/*.rst'),
Davide Pesaventob310efb2019-04-11 22:10:24 -0400359 version=VERSION_BASE,
360 release=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700361
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700362def version(ctx):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500363 # don't execute more than once
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700364 if getattr(Context.g_module, 'VERSION_BASE', None):
365 return
366
367 Context.g_module.VERSION_BASE = Context.g_module.VERSION
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500368 Context.g_module.VERSION_SPLIT = VERSION_BASE.split('.')
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700369
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500370 # first, try to get a version string from git
371 gotVersionFromGit = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700372 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700373 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500374 out = subprocess.check_output(cmd, universal_newlines=True).strip()
375 if out:
376 gotVersionFromGit = True
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700377 if out.startswith(GIT_TAG_PREFIX):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500378 Context.g_module.VERSION = out.lstrip(GIT_TAG_PREFIX)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700379 else:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500380 # no tags matched
381 Context.g_module.VERSION = '%s-commit-%s' % (VERSION_BASE, out)
Davide Pesavento21be8162018-05-10 20:36:37 -0400382 except (OSError, subprocess.CalledProcessError):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700383 pass
384
Alexander Afanasyev3de8aac2020-05-28 20:51:43 -0400385 versionFile = ctx.path.find_node('VERSION.info')
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500386 if not gotVersionFromGit and versionFile is not None:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700387 try:
388 Context.g_module.VERSION = versionFile.read()
389 return
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500390 except EnvironmentError:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700391 pass
392
393 # version was obtained from git, update VERSION file if necessary
394 if versionFile is not None:
395 try:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500396 if versionFile.read() == Context.g_module.VERSION:
397 # already up-to-date
398 return
399 except EnvironmentError as e:
400 Logs.warn('%s exists but is not readable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700401 else:
Alexander Afanasyev3de8aac2020-05-28 20:51:43 -0400402 versionFile = ctx.path.make_node('VERSION.info')
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700403
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700404 try:
405 versionFile.write(Context.g_module.VERSION)
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500406 except EnvironmentError as e:
407 Logs.warn('%s is not writable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700408
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700409def dist(ctx):
410 version(ctx)
411
412def distcheck(ctx):
413 version(ctx)