blob: 8a5a252584af98fcec9b9530ee7b6c03618f0e2c [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 Afanasyevb72360f2019-01-28 14:17:11 -05006VERSION = '0.6.5'
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
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070020 opt = opt.add_option_group('Library Options')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080021
Davide Pesavento4b8eab72018-09-01 20:10:36 -040022 opt.add_option('--with-examples', action='store_true', default=False,
23 help='Build examples')
24
25 opt.add_option('--with-tests', action='store_true', default=False,
26 help='Build unit tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080027
Yingdi Yue6bfab22014-02-06 16:01:19 -080028 opt.add_option('--without-tools', action='store_false', default=True, dest='with_tools',
Davide Pesavento4b8eab72018-09-01 20:10:36 -040029 help='Do not build tools')
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -070030
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070031 opt.add_option('--without-sqlite-locking', action='store_false', default=True,
32 dest='with_sqlite_locking',
Davide Pesavento4b8eab72018-09-01 20:10:36 -040033 help='Disable filesystem locking in sqlite3 database '
34 '(use unix-dot locking mechanism instead). '
35 'This option may be necessary if the home directory is hosted on NFS.')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080036
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070037 opt.add_option('--without-osx-keychain', action='store_false', default=True,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040038 dest='with_osx_keychain', help='Do not use macOS Keychain as default TPM (macOS only)')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080039
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070040 opt.add_option('--enable-static', action='store_true', default=False,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040041 dest='enable_static', help='Build static library (disabled by default)')
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070042 opt.add_option('--disable-static', action='store_false', default=False,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040043 dest='enable_static', help='Do not build static library (disabled by default)')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080044
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070045 opt.add_option('--enable-shared', action='store_true', default=True,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040046 dest='enable_shared', help='Build shared library (enabled by default)')
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070047 opt.add_option('--disable-shared', action='store_false', default=True,
Davide Pesavento4b8eab72018-09-01 20:10:36 -040048 dest='enable_shared', help='Do not build shared library (enabled by default)')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080049
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080050def configure(conf):
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080051 conf.start_msg('Building static library')
52 if conf.options.enable_static:
53 conf.end_msg('yes')
54 else:
55 conf.end_msg('no', color='YELLOW')
56 conf.env.enable_static = conf.options.enable_static
57
58 conf.start_msg('Building shared library')
59 if conf.options.enable_shared:
60 conf.end_msg('yes')
61 else:
62 conf.end_msg('no', color='YELLOW')
63 conf.env.enable_shared = conf.options.enable_shared
64
65 if not conf.options.enable_shared and not conf.options.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050066 conf.fatal('Either static library or shared library must be enabled')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080067
Davide Pesavento1349d2d2016-08-09 06:43:57 +020068 conf.load(['compiler_cxx', 'gnu_dirs', 'c_osx',
Davide Pesavento844b0932018-05-07 01:00:16 -040069 'default-compiler-flags', 'compiler-features',
Alexander Afanasyevadc71842017-01-26 22:17:58 -050070 'pch', 'osx-frameworks', 'boost', 'openssl', 'sqlite3',
Davide Pesavento1349d2d2016-08-09 06:43:57 +020071 'doxygen', 'sphinx_build'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080072
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070073 conf.env['WITH_TESTS'] = conf.options.with_tests
74 conf.env['WITH_TOOLS'] = conf.options.with_tools
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -070075 conf.env['WITH_EXAMPLES'] = conf.options.with_examples
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080076
Alexander Afanasyev95de62e2014-04-11 18:26:33 -070077 conf.find_program('sh', var='SH', mandatory=True)
78
Davide Pesavento2bf35a62017-04-02 00:41:06 -040079 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD', mandatory=False)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070080 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Davide Pesavento50b92262018-07-11 12:28:31 -040081 conf.check_cxx(msg='Checking for function getpass', define_name='HAVE_GETPASS', mandatory=False,
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050082 fragment='''#include <unistd.h>
83 int main() { getpass("Enter password"); }''')
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070084
Davide Pesavento474c3b22018-08-25 16:24:43 -040085 if conf.check_cxx(msg='Checking for netlink', define_name='HAVE_NETLINK', mandatory=False,
Davide Pesavento2bf35a62017-04-02 00:41:06 -040086 header_name=['linux/if_addr.h', 'linux/if_link.h',
Davide Pesavento474c3b22018-08-25 16:24:43 -040087 'linux/netlink.h', 'linux/rtnetlink.h', 'linux/genetlink.h']):
88 conf.env['HAVE_NETLINK'] = True
Davide Pesavento50b92262018-07-11 12:28:31 -040089 conf.check_cxx(msg='Checking for NETLINK_EXT_ACK', define_name='HAVE_NETLINK_EXT_ACK', mandatory=False,
90 fragment='''#include <linux/netlink.h>
91 int main() { return NETLINK_EXT_ACK; }''')
Davide Pesavento2bf35a62017-04-02 00:41:06 -040092 conf.check_cxx(msg='Checking for IFA_FLAGS', define_name='HAVE_IFA_FLAGS', mandatory=False,
Davide Pesavento844b0932018-05-07 01:00:16 -040093 fragment='''#include <linux/if_addr.h>
94 int main() { return IFA_FLAGS; }''')
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -080095
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -050096 conf.check_osx_frameworks()
Yingdi Yue6bfab22014-02-06 16:01:19 -080097
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070098 conf.check_sqlite3(mandatory=True)
Davide Pesavento844b0932018-05-07 01:00:16 -040099 conf.check_openssl(mandatory=True, atleast_version=0x1000200f) # 1.0.2
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800100
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700101 USED_BOOST_LIBS = ['system', 'filesystem', 'date_time', 'iostreams',
Davide Pesavento90db7ee2018-06-10 11:33:31 -0400102 'program_options', 'chrono', 'thread', 'log', 'log_setup']
Junxiao Shi7d054272016-08-04 17:00:41 +0000103
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000104 if conf.env['WITH_TESTS']:
105 USED_BOOST_LIBS += ['unit_test_framework']
Yingdi Yuf56c68f2014-04-24 21:50:13 -0700106 conf.define('HAVE_TESTS', 1)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800107
Junxiao Shi7d054272016-08-04 17:00:41 +0000108 conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True, mt=True)
Davide Pesavento844b0932018-05-07 01:00:16 -0400109 if conf.env.BOOST_VERSION_NUMBER < 105800:
110 conf.fatal('Minimum required Boost version is 1.58.0\n'
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500111 'Please upgrade your distribution or manually install a newer version of Boost'
112 ' (https://redmine.named-data.net/projects/nfd/wiki/Boost_FAQ)')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800113
Alexander Afanasyev5b60f702014-02-07 12:55:24 -0800114 if not conf.options.with_sqlite_locking:
115 conf.define('DISABLE_SQLITE3_FS_LOCKING', 1)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800116
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500117 if conf.env['HAVE_OSX_FRAMEWORKS']:
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -0800118 conf.env['WITH_OSX_KEYCHAIN'] = conf.options.with_osx_keychain
119 if conf.options.with_osx_keychain:
120 conf.define('WITH_OSX_KEYCHAIN', 1)
121 else:
122 conf.env['WITH_OSX_KEYCHAIN'] = False
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800123
Alexander Afanasyevb82d8c32017-09-21 11:35:07 -0400124 conf.check_compiler_flags()
125
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500126 # Loading "late" to prevent tests from being compiled with profiling flags
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700127 conf.load('coverage')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800128
Eric Newberrya3973e02016-11-01 17:58:12 -0700129 conf.load('sanitizers')
130
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600131 conf.define('SYSCONFDIR', conf.env['SYSCONFDIR'])
132
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200133 if not conf.env.enable_static:
134 # If there happens to be a static library, waf will put the corresponding -L flags
135 # before dynamic library flags. This can result in compilation failure when the
136 # system has a different version of the ndn-cxx library installed.
137 conf.env['STLIBPATH'] = ['.'] + conf.env['STLIBPATH']
138
Alexander Afanasyev3e7d2ac2015-02-10 19:39:28 -0800139 # config file will contain all defines that were added using conf.define('xxx'...)
140 # Everything that was added directly to conf.env['DEFINES'] will not appear in the
141 # config file and will be added using compiler directives in the command line.
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000142 conf.write_config_header('ndn-cxx/detail/config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800143
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700144def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700145 version(bld)
146
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500147 bld(features='subst',
148 name='version.hpp',
Davide Pesavento19442812018-11-23 14:00:04 -0500149 source='ndn-cxx/version.hpp.in',
150 target='ndn-cxx/version.hpp',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700151 install_path=None,
152 VERSION_STRING=VERSION_BASE,
153 VERSION_BUILD=VERSION,
154 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
155 int(VERSION_SPLIT[1]) * 1000 +
156 int(VERSION_SPLIT[2]),
157 VERSION_MAJOR=VERSION_SPLIT[0],
158 VERSION_MINOR=VERSION_SPLIT[1],
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200159 VERSION_PATCH=VERSION_SPLIT[2])
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700160
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500161 if bld.env['HAVE_OSX_FRAMEWORKS']:
162 # Need to disable precompiled headers for Objective-C++ code
163 bld(features=['cxx'],
Davide Pesavento19442812018-11-23 14:00:04 -0500164 target='ndn-cxx-mm-objects',
165 source=bld.path.ant_glob('ndn-cxx/**/*-osx.mm'),
166 use='BOOST PTHREAD OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN',
Davide Pesavento7e780642018-11-24 15:51:34 -0500167 includes='.')
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500168
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800169 libndn_cxx = dict(
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500170 target='ndn-cxx',
Davide Pesavento19442812018-11-23 14:00:04 -0500171 source=bld.path.ant_glob('ndn-cxx/**/*.cpp',
172 excl=['ndn-cxx/**/*-osx.cpp',
173 'ndn-cxx/**/*netlink*.cpp',
174 'ndn-cxx/**/*-sqlite3.cpp']),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500175 features='pch',
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000176 headers='ndn-cxx/impl/common-pch.hpp',
Davide Pesavento19442812018-11-23 14:00:04 -0500177 use='ndn-cxx-mm-objects version BOOST OPENSSL SQLITE3 RT PTHREAD',
Davide Pesavento7e780642018-11-24 15:51:34 -0500178 includes='.',
179 export_includes='.',
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200180 install_path='${LIBDIR}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800181
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500182 if bld.env['HAVE_OSX_FRAMEWORKS']:
Davide Pesavento19442812018-11-23 14:00:04 -0500183 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-osx.cpp')
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400184 libndn_cxx['use'] += ' OSX_COREFOUNDATION OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN'
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500185
Davide Pesavento474c3b22018-08-25 16:24:43 -0400186 if bld.env['HAVE_NETLINK']:
Davide Pesavento19442812018-11-23 14:00:04 -0500187 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*netlink*.cpp')
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400188
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800189 # In case we want to make it optional later
Davide Pesavento19442812018-11-23 14:00:04 -0500190 libndn_cxx['source'] += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.cpp')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800191
192 if bld.env.enable_shared:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500193 bld.shlib(name='ndn-cxx',
194 vnum=VERSION_BASE,
195 cnum=VERSION_BASE,
196 **libndn_cxx)
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800197
198 if bld.env.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500199 bld.stlib(name='ndn-cxx-static' if bld.env.enable_shared else 'ndn-cxx',
200 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800201
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700202 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800203 pkgconfig_libs = []
204 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800205 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800206 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800207 pkgconfig_cxxflags = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800208 for lib in Utils.to_list(libndn_cxx['use']):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800209 if bld.env['LIB_%s' % lib]:
210 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
211 if bld.env['LIBPATH_%s' % lib]:
212 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
213 if bld.env['INCLUDES_%s' % lib]:
214 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800215 if bld.env['LINKFLAGS_%s' % lib]:
216 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
217 if bld.env['CXXFLAGS_%s' % lib]:
218 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800219
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500220 EXTRA_FRAMEWORKS = ''
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500221 if bld.env['HAVE_OSX_FRAMEWORKS']:
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400222 EXTRA_FRAMEWORKS = '-framework CoreFoundation -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN'
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800223
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800224 def uniq(alist):
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200225 seen = set()
226 return [x for x in alist if x not in seen and not seen.add(x)]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800227
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500228 pkconfig = bld(features='subst',
229 source='libndn-cxx.pc.in',
230 target='libndn-cxx.pc',
231 install_path='${LIBDIR}/pkgconfig',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700232 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800233
234 # This probably not the right thing to do, but to simplify life of apps
235 # that use the library
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500236 EXTRA_LIBS=' '.join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
237 EXTRA_LDFLAGS=' '.join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
238 EXTRA_LINKFLAGS=' '.join(uniq(pkgconfig_linkflags)),
239 EXTRA_INCLUDES=' '.join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
240 EXTRA_CXXFLAGS=' '.join(uniq(pkgconfig_cxxflags)),
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200241 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800242
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800243 if bld.env['WITH_TESTS']:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800244 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800245
Yingdi Yue6bfab22014-02-06 16:01:19 -0800246 if bld.env['WITH_TOOLS']:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500247 bld.recurse('tools')
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700248
249 if bld.env['WITH_EXAMPLES']:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500250 bld.recurse('examples')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800251
Davide Pesavento19442812018-11-23 14:00:04 -0500252 headers = bld.path.ant_glob('ndn-cxx/**/*.hpp',
253 excl=['ndn-cxx/**/*-osx.hpp',
254 'ndn-cxx/**/*netlink*.hpp',
255 'ndn-cxx/**/*-sqlite3.hpp',
Junxiao Shi24c5a002018-12-12 04:47:15 +0000256 'ndn-cxx/**/impl/**/*'])
Davide Pesavento50b92262018-07-11 12:28:31 -0400257
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500258 if bld.env['HAVE_OSX_FRAMEWORKS']:
Junxiao Shi24c5a002018-12-12 04:47:15 +0000259 headers += bld.path.ant_glob('ndn-cxx/**/*-osx.hpp', excl='ndn-cxx/**/impl/**/*')
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500260
Davide Pesavento474c3b22018-08-25 16:24:43 -0400261 if bld.env['HAVE_NETLINK']:
Junxiao Shi24c5a002018-12-12 04:47:15 +0000262 headers += bld.path.ant_glob('ndn-cxx/**/*netlink*.hpp', excl='ndn-cxx/**/impl/**/*')
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500263
264 # In case we want to make it optional later
Junxiao Shi24c5a002018-12-12 04:47:15 +0000265 headers += bld.path.ant_glob('ndn-cxx/**/*-sqlite3.hpp', excl='ndn-cxx/**/impl/**/*')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700266
Davide Pesavento19442812018-11-23 14:00:04 -0500267 bld.install_files(bld.env['INCLUDEDIR'], headers, relative_trick=True)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800268
Junxiao Shid1fc9a72018-12-12 16:35:34 +0000269 # Install generated headers
270 for filename in ['ndn-cxx/detail/config.hpp', 'ndn-cxx/version.hpp']:
271 bld.install_files('%s/%s' % (bld.env['INCLUDEDIR'], os.path.dirname(filename)),
272 bld.path.find_resource(filename))
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700273
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500274 bld.install_files('${SYSCONFDIR}/ndn', 'client.conf.sample')
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600275
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500276 if bld.env.SPHINX_BUILD:
277 bld(features='sphinx',
278 name='manpages',
279 builder='man',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500280 config='docs/conf.py',
Davide Pesavento4b8eab72018-09-01 20:10:36 -0400281 outdir='docs/manpages',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700282 source=bld.path.ant_glob('docs/manpages/**/*.rst'),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500283 install_path='${MANDIR}',
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700284 VERSION=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700285
286def docs(bld):
287 from waflib import Options
288 Options.commands = ['doxygen', 'sphinx'] + Options.commands
289
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000290def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700291 version(bld)
292
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800293 if not bld.env.DOXYGEN:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500294 bld.fatal('Cannot build documentation ("doxygen" not found in PATH)')
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700295
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500296 bld(features='subst',
297 name='doxygen.conf',
298 source=['docs/doxygen.conf.in',
299 'docs/named_data_theme/named_data_footer-with-analytics.html.in'],
300 target=['docs/doxygen.conf',
301 'docs/named_data_theme/named_data_footer-with-analytics.html'],
302 VERSION=VERSION,
303 HTML_FOOTER='../build/docs/named_data_theme/named_data_footer-with-analytics.html' \
304 if os.getenv('GOOGLE_ANALYTICS', None) \
305 else '../docs/named_data_theme/named_data_footer.html',
306 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ''))
307
308 bld(features='doxygen',
309 doxyfile='docs/doxygen.conf',
310 use='doxygen.conf')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800311
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700312def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700313 version(bld)
314
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700315 if not bld.env.SPHINX_BUILD:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500316 bld.fatal('Cannot build documentation ("sphinx-build" not found in PATH)')
317
318 bld(features='sphinx',
319 config='docs/conf.py',
320 outdir='docs',
321 source=bld.path.ant_glob('docs/**/*.rst'),
322 VERSION=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700323
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700324def version(ctx):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500325 # don't execute more than once
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700326 if getattr(Context.g_module, 'VERSION_BASE', None):
327 return
328
329 Context.g_module.VERSION_BASE = Context.g_module.VERSION
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500330 Context.g_module.VERSION_SPLIT = VERSION_BASE.split('.')
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700331
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500332 # first, try to get a version string from git
333 gotVersionFromGit = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700334 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700335 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500336 out = subprocess.check_output(cmd, universal_newlines=True).strip()
337 if out:
338 gotVersionFromGit = True
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700339 if out.startswith(GIT_TAG_PREFIX):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500340 Context.g_module.VERSION = out.lstrip(GIT_TAG_PREFIX)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700341 else:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500342 # no tags matched
343 Context.g_module.VERSION = '%s-commit-%s' % (VERSION_BASE, out)
Davide Pesavento21be8162018-05-10 20:36:37 -0400344 except (OSError, subprocess.CalledProcessError):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700345 pass
346
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700347 versionFile = ctx.path.find_node('VERSION')
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500348 if not gotVersionFromGit and versionFile is not None:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700349 try:
350 Context.g_module.VERSION = versionFile.read()
351 return
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500352 except EnvironmentError:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700353 pass
354
355 # version was obtained from git, update VERSION file if necessary
356 if versionFile is not None:
357 try:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500358 if versionFile.read() == Context.g_module.VERSION:
359 # already up-to-date
360 return
361 except EnvironmentError as e:
362 Logs.warn('%s exists but is not readable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700363 else:
364 versionFile = ctx.path.make_node('VERSION')
365
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700366 try:
367 versionFile.write(Context.g_module.VERSION)
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500368 except EnvironmentError as e:
369 Logs.warn('%s is not writable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700370
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700371def dist(ctx):
372 version(ctx)
373
374def distcheck(ctx):
375 version(ctx)