blob: 0c185a26a470c018235a0b0ef3c56306acbd0cf5 [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
Davide Pesavento81de5d92022-12-30 01:08:05 -05006VERSION = '0.8.1'
Alexander Afanasyev5560fd42018-03-07 17:03:03 -05007APPNAME = 'ndn-cxx'
Alexander Afanasyev5560fd42018-03-07 17:03:03 -05008GIT_TAG_PREFIX = 'ndn-cxx-'
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -07009
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080010def options(opt):
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070011 opt.load(['compiler_cxx', 'gnu_dirs', 'c_osx'])
Davide Pesavento869d1a32023-03-14 23:55:02 -040012 opt.load(['cross', 'default-compiler-flags', 'pch',
13 'coverage', 'sanitizers', 'osx-frameworks',
Alexander Afanasyevadc71842017-01-26 22:17:58 -050014 'boost', 'openssl', 'sqlite3',
Davide Pesavento1349d2d2016-08-09 06:43:57 +020015 'doxygen', 'sphinx_build'],
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070016 tooldir=['.waf-tools'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080017
Davide Pesavento77f1c762019-02-19 03:20:49 -050018 opt = opt.add_option_group('ndn-cxx Options')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080019
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070020 opt.add_option('--enable-static', action='store_true', default=False,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040021 dest='enable_static', help='Build static library (disabled by default)')
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070022 opt.add_option('--disable-static', action='store_false', default=False,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040023 dest='enable_static', help='Do not build static library (disabled by default)')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080024
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070025 opt.add_option('--enable-shared', action='store_true', default=True,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040026 dest='enable_shared', help='Build shared library (enabled by default)')
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070027 opt.add_option('--disable-shared', action='store_false', default=True,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040028 dest='enable_shared', help='Do not build shared library (enabled by default)')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080029
Davide Pesavento77f1c762019-02-19 03:20:49 -050030 opt.add_option('--without-osx-keychain', action='store_false', default=True,
31 dest='with_osx_keychain', help='Do not use macOS Keychain as default TPM (macOS only)')
32
33 opt.add_option('--without-sqlite-locking', action='store_false', default=True, dest='with_sqlite_locking',
34 help='Disable filesystem locking in sqlite3 database '
35 '(use unix-dot locking mechanism instead). '
36 'This option may be necessary if the home directory is hosted on NFS.')
37
38 stacktrace_choices = ['backtrace', 'addr2line', 'basic', 'noop']
39 opt.add_option('--with-stacktrace', action='store', default=None, choices=stacktrace_choices,
40 help='Select the stacktrace backend implementation: '
41 '%s [default=auto-detect]' % ', '.join(stacktrace_choices))
42 opt.add_option('--without-stacktrace', action='store_const', const='', dest='with_stacktrace',
43 help='Disable stacktrace support')
44
45 opt.add_option('--with-examples', action='store_true', default=False,
46 help='Build examples')
47
48 opt.add_option('--with-tests', action='store_true', default=False,
49 help='Build tests')
50
51 opt.add_option('--without-tools', action='store_false', default=True, dest='with_tools',
52 help='Do not build tools')
53
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080054def configure(conf):
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080055 conf.start_msg('Building static library')
56 if conf.options.enable_static:
57 conf.end_msg('yes')
58 else:
59 conf.end_msg('no', color='YELLOW')
60 conf.env.enable_static = conf.options.enable_static
61
62 conf.start_msg('Building shared library')
63 if conf.options.enable_shared:
64 conf.end_msg('yes')
65 else:
66 conf.end_msg('no', color='YELLOW')
67 conf.env.enable_shared = conf.options.enable_shared
68
69 if not conf.options.enable_shared and not conf.options.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050070 conf.fatal('Either static library or shared library must be enabled')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080071
Davide Pesavento869d1a32023-03-14 23:55:02 -040072 conf.load(['compiler_cxx', 'gnu_dirs', 'c_osx',
73 'cross', 'default-compiler-flags', 'pch',
74 'osx-frameworks', 'boost', 'openssl', 'sqlite3',
Davide Pesavento1349d2d2016-08-09 06:43:57 +020075 'doxygen', 'sphinx_build'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080076
Davide Pesaventofd674012019-02-06 02:00:12 -050077 conf.env.WITH_TESTS = conf.options.with_tests
78 conf.env.WITH_TOOLS = conf.options.with_tools
79 conf.env.WITH_EXAMPLES = conf.options.with_examples
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080080
Davide Pesavento2d7c5852022-07-18 16:02:52 -040081 conf.find_program('dot', mandatory=False)
Alexander Afanasyev95de62e2014-04-11 18:26:33 -070082
Eric Newberry96033252020-04-10 13:08:27 -070083 conf.check_cxx(lib='atomic', uselib_store='ATOMIC', define_name='HAVE_ATOMIC', mandatory=False)
Davide Pesavento2bf35a62017-04-02 00:41:06 -040084 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD', mandatory=False)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070085 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Davide Pesavento78338c52020-04-20 23:00:02 -040086
Davide Pesavento50b92262018-07-11 12:28:31 -040087 conf.check_cxx(msg='Checking for function getpass', define_name='HAVE_GETPASS', mandatory=False,
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050088 fragment='''#include <unistd.h>
89 int main() { getpass("Enter password"); }''')
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070090
Davide Pesavento474c3b22018-08-25 16:24:43 -040091 if conf.check_cxx(msg='Checking for netlink', define_name='HAVE_NETLINK', mandatory=False,
Davide Pesavento2bf35a62017-04-02 00:41:06 -040092 header_name=['linux/if_addr.h', 'linux/if_link.h',
Davide Pesavento474c3b22018-08-25 16:24:43 -040093 'linux/netlink.h', 'linux/rtnetlink.h', 'linux/genetlink.h']):
Davide Pesaventofd674012019-02-06 02:00:12 -050094 conf.env.HAVE_NETLINK = True
Davide Pesavento50b92262018-07-11 12:28:31 -040095 conf.check_cxx(msg='Checking for NETLINK_EXT_ACK', define_name='HAVE_NETLINK_EXT_ACK', mandatory=False,
96 fragment='''#include <linux/netlink.h>
97 int main() { return NETLINK_EXT_ACK; }''')
Davide Pesavento2bf35a62017-04-02 00:41:06 -040098 conf.check_cxx(msg='Checking for IFA_FLAGS', define_name='HAVE_IFA_FLAGS', mandatory=False,
Davide Pesavento844b0932018-05-07 01:00:16 -040099 fragment='''#include <linux/if_addr.h>
100 int main() { return IFA_FLAGS; }''')
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -0800101
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500102 conf.check_osx_frameworks()
Davide Pesavento77f1c762019-02-19 03:20:49 -0500103 conf.check_sqlite3()
Davide Pesavento273ea012022-02-20 17:50:02 -0500104 conf.check_openssl(lib='crypto', atleast_version='1.1.1')
Yingdi Yue6bfab22014-02-06 16:01:19 -0800105
Davide Pesavento5686c512023-09-07 22:08:46 -0400106 boost_libs = ['system', 'chrono', 'date_time', 'filesystem', 'thread', 'log']
Junxiao Shi7d054272016-08-04 17:00:41 +0000107
Davide Pesaventofd674012019-02-06 02:00:12 -0500108 stacktrace_backend = conf.options.with_stacktrace
109 if stacktrace_backend is None:
110 # auto-detect
Davide Pesaventof3089c32021-05-25 21:28:21 -0400111 for candidate in ('backtrace', 'basic'):
Davide Pesaventofd674012019-02-06 02:00:12 -0500112 try:
Davide Pesaventoc9967422023-09-07 22:04:34 -0400113 conf.check_boost(lib=f'stacktrace_{candidate}', mt=True)
Davide Pesaventofd674012019-02-06 02:00:12 -0500114 except conf.errors.ConfigurationError:
115 continue
116 stacktrace_backend = candidate
117 break
118 if stacktrace_backend:
119 conf.env.HAVE_STACKTRACE = True
120 conf.env.append_unique('DEFINES_BOOST', ['BOOST_STACKTRACE_DYN_LINK'])
Davide Pesaventoc9967422023-09-07 22:04:34 -0400121 boost_libs.append(f'stacktrace_{stacktrace_backend}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800122
Davide Pesaventofd674012019-02-06 02:00:12 -0500123 conf.check_boost(lib=boost_libs, mt=True)
Davide Pesavento541a8222022-03-01 15:08:42 -0500124 if conf.env.BOOST_VERSION_NUMBER < 106501:
Davide Pesavento78338c52020-04-20 23:00:02 -0400125 conf.fatal('The minimum supported version of Boost is 1.65.1.\n'
126 'Please upgrade your distribution or manually install a newer version of Boost.\n'
127 'For more information, see https://redmine.named-data.net/projects/nfd/wiki/Boost')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800128
Davide Pesaventofc27d3b2019-03-02 00:47:35 -0500129 # Workaround for bug 4860
130 if conf.env.BOOST_VERSION_NUMBER < 106900 and conf.env.CXX_NAME == 'clang':
131 conf.env.append_unique('DEFINES_BOOST', ['BOOST_ASIO_DISABLE_STD_EXPERIMENTAL_STRING_VIEW'])
132
Davide Pesaventod8e0cad2021-05-26 21:43:47 -0400133 conf.env.append_unique('DEFINES_BOOST', ['BOOST_FILESYSTEM_NO_DEPRECATED'])
134
Davide Pesavento5686c512023-09-07 22:08:46 -0400135 if conf.env.WITH_TESTS:
136 conf.check_boost(lib='unit_test_framework', mt=True, uselib_store='BOOST_TESTS')
137
138 if conf.env.WITH_TOOLS:
139 conf.check_boost(lib='program_options', mt=True, uselib_store='BOOST_TOOLS')
140
Alexander Afanasyevb82d8c32017-09-21 11:35:07 -0400141 conf.check_compiler_flags()
142
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500143 # Loading "late" to prevent tests from being compiled with profiling flags
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700144 conf.load('coverage')
Eric Newberrya3973e02016-11-01 17:58:12 -0700145 conf.load('sanitizers')
146
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200147 if not conf.env.enable_static:
148 # If there happens to be a static library, waf will put the corresponding -L flags
149 # before dynamic library flags. This can result in compilation failure when the
150 # system has a different version of the ndn-cxx library installed.
Davide Pesaventofd674012019-02-06 02:00:12 -0500151 conf.env.prepend_value('STLIBPATH', ['.'])
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200152
Davide Pesaventofd674012019-02-06 02:00:12 -0500153 conf.define_cond('HAVE_STACKTRACE', conf.env.HAVE_STACKTRACE)
154 conf.define_cond('HAVE_TESTS', conf.env.WITH_TESTS)
155 conf.define_cond('WITH_OSX_KEYCHAIN', conf.env.HAVE_OSX_FRAMEWORKS and conf.options.with_osx_keychain)
156 conf.define_cond('DISABLE_SQLITE3_FS_LOCKING', not conf.options.with_sqlite_locking)
157 conf.define('SYSCONFDIR', conf.env.SYSCONFDIR)
158 # The config header will contain all defines that were added using conf.define()
159 # or conf.define_cond(). Everything that was added directly to conf.env.DEFINES
160 # will not appear in the config header, but will instead be passed directly to the
161 # compiler on the command line.
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000162 conf.write_config_header('ndn-cxx/detail/config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800163
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700164def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700165 version(bld)
166
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500167 bld(features='subst',
168 name='version.hpp',
Davide Pesavento19442812018-11-23 14:00:04 -0500169 source='ndn-cxx/version.hpp.in',
170 target='ndn-cxx/version.hpp',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700171 install_path=None,
172 VERSION_STRING=VERSION_BASE,
173 VERSION_BUILD=VERSION,
174 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
175 int(VERSION_SPLIT[1]) * 1000 +
176 int(VERSION_SPLIT[2]),
177 VERSION_MAJOR=VERSION_SPLIT[0],
178 VERSION_MINOR=VERSION_SPLIT[1],
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200179 VERSION_PATCH=VERSION_SPLIT[2])
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700180
Davide Pesaventofd674012019-02-06 02:00:12 -0500181 if bld.env.HAVE_OSX_FRAMEWORKS:
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500182 # Need to disable precompiled headers for Objective-C++ code
Davide Pesavento25d4f1c2020-04-29 23:31:04 -0400183 bld(features='cxx',
Davide Pesavento19442812018-11-23 14:00:04 -0500184 target='ndn-cxx-mm-objects',
185 source=bld.path.ant_glob('ndn-cxx/**/*-osx.mm'),
186 use='BOOST PTHREAD OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN',
Davide Pesavento7e780642018-11-24 15:51:34 -0500187 includes='.')
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500188
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800189 libndn_cxx = dict(
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500190 target='ndn-cxx',
Davide Pesavento19442812018-11-23 14:00:04 -0500191 source=bld.path.ant_glob('ndn-cxx/**/*.cpp',
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400192 excl=['ndn-cxx/**/*-android.cpp',
193 'ndn-cxx/**/*-osx.cpp',
194 'ndn-cxx/**/*-sqlite3.cpp',
195 'ndn-cxx/**/*netlink*.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
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400203 if bld.env.HOST == 'android':
204 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-android.cpp')
205
Davide Pesaventofd674012019-02-06 02:00:12 -0500206 if bld.env.HAVE_OSX_FRAMEWORKS:
Davide Pesavento19442812018-11-23 14:00:04 -0500207 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-osx.cpp')
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400208 libndn_cxx['use'] += ' OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN'
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500209
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
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400213 if bld.env.HAVE_NETLINK:
214 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*netlink*.cpp')
215
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800216 if bld.env.enable_shared:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500217 bld.shlib(name='ndn-cxx',
218 vnum=VERSION_BASE,
219 cnum=VERSION_BASE,
220 **libndn_cxx)
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800221
222 if bld.env.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500223 bld.stlib(name='ndn-cxx-static' if bld.env.enable_shared else 'ndn-cxx',
224 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800225
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700226 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800227 pkgconfig_libs = []
228 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800229 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800230 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800231 pkgconfig_cxxflags = []
Alexander Afanasyev8fdae892019-02-10 16:40:48 -0500232 pkgconfig_defines = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800233 for lib in Utils.to_list(libndn_cxx['use']):
Davide Pesaventoc9967422023-09-07 22:04:34 -0400234 if bld.env[f'LIB_{lib}']:
235 pkgconfig_libs += Utils.to_list(bld.env[f'LIB_{lib}'])
236 if bld.env[f'LIBPATH_{lib}']:
237 pkgconfig_ldflags += Utils.to_list(bld.env[f'LIBPATH_{lib}'])
238 if bld.env[f'INCLUDES_{lib}']:
239 pkgconfig_includes += Utils.to_list(bld.env[f'INCLUDES_{lib}'])
240 if bld.env[f'LINKFLAGS_{lib}']:
241 pkgconfig_linkflags += Utils.to_list(bld.env[f'LINKFLAGS_{lib}'])
242 if bld.env[f'CXXFLAGS_{lib}']:
243 pkgconfig_cxxflags += Utils.to_list(bld.env[f'CXXFLAGS_{lib}'])
244 if bld.env[f'DEFINES_{lib}']:
245 pkgconfig_defines += Utils.to_list(bld.env[f'DEFINES_{lib}'])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800246
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500247 EXTRA_FRAMEWORKS = ''
Davide Pesaventofd674012019-02-06 02:00:12 -0500248 if bld.env.HAVE_OSX_FRAMEWORKS:
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400249 EXTRA_FRAMEWORKS = '-framework CoreFoundation -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN'
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800250
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800251 def uniq(alist):
Davide Pesaventoc9967422023-09-07 22:04:34 -0400252 return list(dict.fromkeys(alist))
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800253
Davide Pesaventoc9967422023-09-07 22:04:34 -0400254 bld(features='subst',
255 source='libndn-cxx.pc.in',
256 target='libndn-cxx.pc',
257 install_path='${LIBDIR}/pkgconfig',
258 VERSION=VERSION_BASE,
259 # This probably not the right thing to do, but to simplify life of apps
260 # that use the library
261 EXTRA_LIBS=' '.join([f'-l{i}' for i in uniq(pkgconfig_libs)]),
262 EXTRA_LDFLAGS=' '.join([f'-L{i}' for i in uniq(pkgconfig_ldflags)]),
263 EXTRA_LINKFLAGS=' '.join(uniq(pkgconfig_linkflags)),
264 EXTRA_INCLUDES=' '.join([f'-I{i}' for i in uniq(pkgconfig_includes)]),
265 EXTRA_CXXFLAGS=' '.join(uniq(pkgconfig_cxxflags) + [f'-D{i}' for i in uniq(pkgconfig_defines)]),
266 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800267
Davide Pesaventofd674012019-02-06 02:00:12 -0500268 if bld.env.WITH_TESTS:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800269 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800270
Davide Pesaventofd674012019-02-06 02:00:12 -0500271 if bld.env.WITH_TOOLS:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500272 bld.recurse('tools')
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700273
Davide Pesaventofd674012019-02-06 02:00:12 -0500274 if bld.env.WITH_EXAMPLES:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500275 bld.recurse('examples')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800276
Davide Pesavento19442812018-11-23 14:00:04 -0500277 headers = bld.path.ant_glob('ndn-cxx/**/*.hpp',
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400278 excl=['ndn-cxx/**/*-android.hpp',
279 'ndn-cxx/**/*-osx.hpp',
Davide Pesavento19442812018-11-23 14:00:04 -0500280 'ndn-cxx/**/*-sqlite3.hpp',
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400281 'ndn-cxx/**/*netlink*.hpp',
Junxiao Shi24c5a002018-12-12 04:47:15 +0000282 'ndn-cxx/**/impl/**/*'])
Davide Pesavento50b92262018-07-11 12:28:31 -0400283
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400284 if bld.env.HOST == 'android':
285 headers += bld.path.ant_glob('ndn-cxx/**/*-android.hpp', excl='ndn-cxx/**/impl/**/*')
286
Davide Pesaventofd674012019-02-06 02:00:12 -0500287 if bld.env.HAVE_OSX_FRAMEWORKS:
Junxiao Shi24c5a002018-12-12 04:47:15 +0000288 headers += bld.path.ant_glob('ndn-cxx/**/*-osx.hpp', excl='ndn-cxx/**/impl/**/*')
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500289
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500290 # In case we want to make it optional later
Junxiao Shi24c5a002018-12-12 04:47:15 +0000291 headers += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.hpp', excl='ndn-cxx/**/impl/**/*')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700292
Alexander Afanasyev39535f42019-07-05 22:07:52 -0400293 if bld.env.HAVE_NETLINK:
294 headers += bld.path.ant_glob('ndn-cxx/**/*netlink*.hpp', excl='ndn-cxx/**/impl/**/*')
295
Davide Pesaventof3089c32021-05-25 21:28:21 -0400296 bld.install_files('${INCLUDEDIR}', headers, relative_trick=True)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800297
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000298 # Install generated headers
Davide Pesaventof3089c32021-05-25 21:28:21 -0400299 for filename in ('ndn-cxx/detail/config.hpp', 'ndn-cxx/version.hpp'):
300 bld.install_files('${INCLUDEDIR}/%s' % os.path.dirname(filename),
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000301 bld.path.find_resource(filename))
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700302
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500303 bld.install_files('${SYSCONFDIR}/ndn', 'client.conf.sample')
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600304
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500305 if bld.env.SPHINX_BUILD:
306 bld(features='sphinx',
307 name='manpages',
308 builder='man',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500309 config='docs/conf.py',
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400310 outdir='docs/manpages',
Davide Pesaventob310efb2019-04-11 22:10:24 -0400311 source=bld.path.ant_glob('docs/manpages/*.rst'),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500312 install_path='${MANDIR}',
Davide Pesaventob310efb2019-04-11 22:10:24 -0400313 version=VERSION_BASE,
314 release=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700315
316def docs(bld):
317 from waflib import Options
318 Options.commands = ['doxygen', 'sphinx'] + Options.commands
319
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000320def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700321 version(bld)
322
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800323 if not bld.env.DOXYGEN:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500324 bld.fatal('Cannot build documentation ("doxygen" not found in PATH)')
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700325
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500326 bld(features='subst',
327 name='doxygen.conf',
328 source=['docs/doxygen.conf.in',
329 'docs/named_data_theme/named_data_footer-with-analytics.html.in'],
330 target=['docs/doxygen.conf',
331 'docs/named_data_theme/named_data_footer-with-analytics.html'],
332 VERSION=VERSION,
Davide Pesaventodbe645f2021-04-16 00:42:52 -0400333 HAVE_DOT='YES' if bld.env.DOT else 'NO',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500334 HTML_FOOTER='../build/docs/named_data_theme/named_data_footer-with-analytics.html' \
335 if os.getenv('GOOGLE_ANALYTICS', None) \
336 else '../docs/named_data_theme/named_data_footer.html',
337 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ''))
338
339 bld(features='doxygen',
340 doxyfile='docs/doxygen.conf',
341 use='doxygen.conf')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800342
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700343def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700344 version(bld)
345
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700346 if not bld.env.SPHINX_BUILD:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500347 bld.fatal('Cannot build documentation ("sphinx-build" not found in PATH)')
348
349 bld(features='sphinx',
350 config='docs/conf.py',
351 outdir='docs',
352 source=bld.path.ant_glob('docs/**/*.rst'),
Davide Pesaventob310efb2019-04-11 22:10:24 -0400353 version=VERSION_BASE,
354 release=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700355
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700356def version(ctx):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500357 # don't execute more than once
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700358 if getattr(Context.g_module, 'VERSION_BASE', None):
359 return
360
361 Context.g_module.VERSION_BASE = Context.g_module.VERSION
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500362 Context.g_module.VERSION_SPLIT = VERSION_BASE.split('.')
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700363
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500364 # first, try to get a version string from git
365 gotVersionFromGit = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700366 try:
Davide Pesaventoc9967422023-09-07 22:04:34 -0400367 cmd = ['git', 'describe', '--always', '--match', f'{GIT_TAG_PREFIX}*']
368 out = subprocess.run(cmd, capture_output=True, check=True, text=True).stdout.strip()
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500369 if out:
370 gotVersionFromGit = True
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700371 if out.startswith(GIT_TAG_PREFIX):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500372 Context.g_module.VERSION = out.lstrip(GIT_TAG_PREFIX)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700373 else:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500374 # no tags matched
Davide Pesaventoc9967422023-09-07 22:04:34 -0400375 Context.g_module.VERSION = f'{VERSION_BASE}-commit-{out}'
376 except (OSError, subprocess.SubprocessError):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700377 pass
378
Alexander Afanasyev3de8aac2020-05-28 20:51:43 -0400379 versionFile = ctx.path.find_node('VERSION.info')
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500380 if not gotVersionFromGit and versionFile is not None:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700381 try:
382 Context.g_module.VERSION = versionFile.read()
383 return
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500384 except EnvironmentError:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700385 pass
386
387 # version was obtained from git, update VERSION file if necessary
388 if versionFile is not None:
389 try:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500390 if versionFile.read() == Context.g_module.VERSION:
391 # already up-to-date
392 return
393 except EnvironmentError as e:
Davide Pesaventoc9967422023-09-07 22:04:34 -0400394 Logs.warn(f'{versionFile} exists but is not readable ({e.strerror})')
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700395 else:
Alexander Afanasyev3de8aac2020-05-28 20:51:43 -0400396 versionFile = ctx.path.make_node('VERSION.info')
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700397
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700398 try:
399 versionFile.write(Context.g_module.VERSION)
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500400 except EnvironmentError as e:
Davide Pesaventoc9967422023-09-07 22:04:34 -0400401 Logs.warn(f'{versionFile} is not writable ({e.strerror})')
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700402
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700403def dist(ctx):
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500404 ctx.algo = 'tar.xz'
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700405 version(ctx)
406
407def distcheck(ctx):
Davide Pesaventoae39daf2023-02-14 23:46:46 -0500408 ctx.algo = 'tar.xz'
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700409 version(ctx)