blob: 96740c3cb6ac9f1aa7b8955be08480874bbb4a20 [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 Afanasyevd9b083e2018-05-02 16:06:57 -04006VERSION = '0.6.2'
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 Pesavento1349d2d2016-08-09 06:43:57 +020014 opt.load(['default-compiler-flags', 'compiler-features', 'type_traits',
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
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070022 opt.add_option('--with-tests', action='store_true', default=False, dest='with_tests',
Alexander Afanasyev224044f2016-07-18 10:45:08 +020023 help='''Build unit tests''')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080024
Yingdi Yue6bfab22014-02-06 16:01:19 -080025 opt.add_option('--without-tools', action='store_false', default=True, dest='with_tools',
26 help='''Do not build tools''')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080027
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -070028 opt.add_option('--with-examples', action='store_true', default=False, dest='with_examples',
29 help='''Build examples''')
30
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070031 opt.add_option('--without-sqlite-locking', action='store_false', default=True,
32 dest='with_sqlite_locking',
33 help='''Disable filesystem locking in sqlite3 database '''
34 '''(use unix-dot locking mechanism instead). '''
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -080035 '''This option may be necessary if 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,
38 dest='with_osx_keychain',
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -080039 help='''On Darwin, do not use OSX keychain as a default TPM''')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080040
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070041 opt.add_option('--enable-static', action='store_true', default=False,
42 dest='enable_static', help='''Build static library (disabled by default)''')
43 opt.add_option('--disable-static', action='store_false', default=False,
44 dest='enable_static', help='''Do not build static library (disabled by default)''')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080045
Spyridon Mastorakis5ebfda62015-07-21 20:57:40 -070046 opt.add_option('--enable-shared', action='store_true', default=True,
47 dest='enable_shared', help='''Build shared library (enabled by default)''')
48 opt.add_option('--disable-shared', action='store_false', default=True,
49 dest='enable_shared', help='''Do not build shared library (enabled by default)''')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080050
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080051def configure(conf):
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080052 conf.start_msg('Building static library')
53 if conf.options.enable_static:
54 conf.end_msg('yes')
55 else:
56 conf.end_msg('no', color='YELLOW')
57 conf.env.enable_static = conf.options.enable_static
58
59 conf.start_msg('Building shared library')
60 if conf.options.enable_shared:
61 conf.end_msg('yes')
62 else:
63 conf.end_msg('no', color='YELLOW')
64 conf.env.enable_shared = conf.options.enable_shared
65
66 if not conf.options.enable_shared and not conf.options.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050067 conf.fatal('Either static library or shared library must be enabled')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -080068
Davide Pesavento1349d2d2016-08-09 06:43:57 +020069 conf.load(['compiler_cxx', 'gnu_dirs', 'c_osx',
70 'default-compiler-flags', 'compiler-features', 'type_traits',
Alexander Afanasyevadc71842017-01-26 22:17:58 -050071 'pch', 'osx-frameworks', 'boost', 'openssl', 'sqlite3',
Davide Pesavento1349d2d2016-08-09 06:43:57 +020072 'doxygen', 'sphinx_build'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080073
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070074 conf.env['WITH_TESTS'] = conf.options.with_tests
75 conf.env['WITH_TOOLS'] = conf.options.with_tools
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -070076 conf.env['WITH_EXAMPLES'] = conf.options.with_examples
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080077
Alexander Afanasyev95de62e2014-04-11 18:26:33 -070078 conf.find_program('sh', var='SH', mandatory=True)
79
Davide Pesavento2bf35a62017-04-02 00:41:06 -040080 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD', mandatory=False)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070081 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Alexander Afanasyev5560fd42018-03-07 17:03:03 -050082 conf.check_cxx(msg='Checking for getpass function', mandatory=False,
83 define_name='HAVE_GETPASS',
84 fragment='''#include <unistd.h>
85 int main() { getpass("Enter password"); }''')
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070086
Davide Pesavento2bf35a62017-04-02 00:41:06 -040087 if conf.check_cxx(msg='Checking for rtnetlink', define_name='HAVE_RTNETLINK', mandatory=False,
88 header_name=['linux/if_addr.h', 'linux/if_link.h',
89 'linux/netlink.h', 'linux/rtnetlink.h']):
90 conf.env['HAVE_RTNETLINK'] = True
91 conf.check_cxx(msg='Checking for IFA_FLAGS', define_name='HAVE_IFA_FLAGS', mandatory=False,
92 fragment='''
93 #include <linux/if_addr.h>
94 int main() { return IFA_FLAGS; }
95 ''')
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -080096
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -050097 conf.check_osx_frameworks()
Yingdi Yue6bfab22014-02-06 16:01:19 -080098
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070099 conf.check_sqlite3(mandatory=True)
Yingdi Yub3015bd2015-06-23 23:21:53 -0700100 conf.check_openssl(mandatory=True, atleast_version=0x10001000) # 1.0.1
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800101
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700102 USED_BOOST_LIBS = ['system', 'filesystem', 'date_time', 'iostreams',
Davide Pesavento1cd9f6e2016-10-08 00:26:36 +0200103 'regex', 'program_options', 'chrono', 'thread',
104 'log', 'log_setup']
Junxiao Shi7d054272016-08-04 17:00:41 +0000105
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000106 if conf.env['WITH_TESTS']:
107 USED_BOOST_LIBS += ['unit_test_framework']
Yingdi Yuf56c68f2014-04-24 21:50:13 -0700108 conf.define('HAVE_TESTS', 1)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800109
Junxiao Shi7d054272016-08-04 17:00:41 +0000110 conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True, mt=True)
Davide Pesaventoe6e6fde2016-04-16 14:44:45 +0200111 if conf.env.BOOST_VERSION_NUMBER < 105400:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500112 conf.fatal('Minimum required Boost version is 1.54.0\n'
113 'Please upgrade your distribution or manually install a newer version of Boost'
114 ' (https://redmine.named-data.net/projects/nfd/wiki/Boost_FAQ)')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800115
Davide Pesavento81bf95c2017-05-27 14:23:08 -0400116 if conf.env['CXX_NAME'] == 'clang' and conf.env.BOOST_VERSION_NUMBER < 105800:
117 conf.env.append_value('DEFINES', 'BOOST_ASIO_HAS_STD_ARRAY=1') # Bug #4096
118
Alexander Afanasyev5b60f702014-02-07 12:55:24 -0800119 if not conf.options.with_sqlite_locking:
120 conf.define('DISABLE_SQLITE3_FS_LOCKING', 1)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800121
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500122 if conf.env['HAVE_OSX_FRAMEWORKS']:
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -0800123 conf.env['WITH_OSX_KEYCHAIN'] = conf.options.with_osx_keychain
124 if conf.options.with_osx_keychain:
125 conf.define('WITH_OSX_KEYCHAIN', 1)
126 else:
127 conf.env['WITH_OSX_KEYCHAIN'] = False
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800128
Alexander Afanasyevb82d8c32017-09-21 11:35:07 -0400129 conf.check_compiler_flags()
130
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500131 # Loading "late" to prevent tests from being compiled with profiling flags
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700132 conf.load('coverage')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800133
Eric Newberrya3973e02016-11-01 17:58:12 -0700134 conf.load('sanitizers')
135
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600136 conf.define('SYSCONFDIR', conf.env['SYSCONFDIR'])
137
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200138 if not conf.env.enable_static:
139 # If there happens to be a static library, waf will put the corresponding -L flags
140 # before dynamic library flags. This can result in compilation failure when the
141 # system has a different version of the ndn-cxx library installed.
142 conf.env['STLIBPATH'] = ['.'] + conf.env['STLIBPATH']
143
Alexander Afanasyev3e7d2ac2015-02-10 19:39:28 -0800144 # config file will contain all defines that were added using conf.define('xxx'...)
145 # Everything that was added directly to conf.env['DEFINES'] will not appear in the
146 # config file and will be added using compiler directives in the command line.
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700147 conf.write_config_header('src/ndn-cxx-config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800148
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700149def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700150 version(bld)
151
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500152 bld(features='subst',
153 name='version.hpp',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700154 source='src/version.hpp.in',
155 target='src/version.hpp',
156 install_path=None,
157 VERSION_STRING=VERSION_BASE,
158 VERSION_BUILD=VERSION,
159 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
160 int(VERSION_SPLIT[1]) * 1000 +
161 int(VERSION_SPLIT[2]),
162 VERSION_MAJOR=VERSION_SPLIT[0],
163 VERSION_MINOR=VERSION_SPLIT[1],
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200164 VERSION_PATCH=VERSION_SPLIT[2])
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700165
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500166 if bld.env['HAVE_OSX_FRAMEWORKS']:
167 # Need to disable precompiled headers for Objective-C++ code
168 bld(features=['cxx'],
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500169 target='ndn-cxx-mm',
170 name='ndn-cxx-mm',
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500171 source=bld.path.ant_glob(['src/**/*-osx.mm']),
Alexander Afanasyevadc71842017-01-26 22:17:58 -0500172 use='version BOOST OPENSSL SQLITE3 RT PTHREAD OSX_COREFOUNDATION OSX_CORESERVICES OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500173 includes='src')
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500174
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800175 libndn_cxx = dict(
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500176 target='ndn-cxx',
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700177 source=bld.path.ant_glob('src/**/*.cpp',
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500178 excl=['src/**/*-osx.cpp',
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400179 'src/**/*-rtnl.cpp',
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100180 'src/**/*-sqlite3.cpp']),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500181 features='pch',
Alexander Afanasyev8b1674a2014-05-15 00:58:43 -0700182 headers='src/common-pch.hpp',
Alexander Afanasyevadc71842017-01-26 22:17:58 -0500183 use='version ndn-cxx-mm BOOST OPENSSL SQLITE3 RT PTHREAD',
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500184 includes='. src',
185 export_includes='src',
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200186 install_path='${LIBDIR}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800187
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500188 if bld.env['HAVE_OSX_FRAMEWORKS']:
189 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-osx.cpp')
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500190 libndn_cxx['use'] += ' OSX_COREFOUNDATION OSX_CORESERVICES OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN'
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500191
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400192 if bld.env['HAVE_RTNETLINK']:
193 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-rtnl.cpp')
194
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800195 # In case we want to make it optional later
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800196 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-sqlite3.cpp')
197
198 if bld.env.enable_shared:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500199 bld.shlib(name='ndn-cxx',
200 vnum=VERSION_BASE,
201 cnum=VERSION_BASE,
202 **libndn_cxx)
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800203
204 if bld.env.enable_static:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500205 bld.stlib(name='ndn-cxx-static' if bld.env.enable_shared else 'ndn-cxx',
206 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800207
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700208 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800209 pkgconfig_libs = []
210 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800211 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800212 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800213 pkgconfig_cxxflags = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800214 for lib in Utils.to_list(libndn_cxx['use']):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800215 if bld.env['LIB_%s' % lib]:
216 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
217 if bld.env['LIBPATH_%s' % lib]:
218 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
219 if bld.env['INCLUDES_%s' % lib]:
220 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800221 if bld.env['LINKFLAGS_%s' % lib]:
222 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
223 if bld.env['CXXFLAGS_%s' % lib]:
224 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800225
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500226 EXTRA_FRAMEWORKS = ''
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500227 if bld.env['HAVE_OSX_FRAMEWORKS']:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500228 EXTRA_FRAMEWORKS = '-framework CoreFoundation -framework CoreServices -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN'
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800229
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800230 def uniq(alist):
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200231 seen = set()
232 return [x for x in alist if x not in seen and not seen.add(x)]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800233
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500234 pkconfig = bld(features='subst',
235 source='libndn-cxx.pc.in',
236 target='libndn-cxx.pc',
237 install_path='${LIBDIR}/pkgconfig',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700238 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800239
240 # This probably not the right thing to do, but to simplify life of apps
241 # that use the library
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500242 EXTRA_LIBS=' '.join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
243 EXTRA_LDFLAGS=' '.join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
244 EXTRA_LINKFLAGS=' '.join(uniq(pkgconfig_linkflags)),
245 EXTRA_INCLUDES=' '.join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
246 EXTRA_CXXFLAGS=' '.join(uniq(pkgconfig_cxxflags)),
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200247 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800248
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800249 if bld.env['WITH_TESTS']:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800250 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800251
Yingdi Yue6bfab22014-02-06 16:01:19 -0800252 if bld.env['WITH_TOOLS']:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500253 bld.recurse('tools')
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700254
255 if bld.env['WITH_EXAMPLES']:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500256 bld.recurse('examples')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800257
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100258 headers = bld.path.ant_glob('src/**/*.hpp',
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500259 excl=['src/**/*-osx.hpp',
260 'src/**/*-rtnl.hpp',
261 'src/**/*-sqlite3.hpp',
262 'src/**/detail/**/*'])
263 if bld.env['HAVE_OSX_FRAMEWORKS']:
264 headers += bld.path.ant_glob('src/**/*-osx.hpp', excl='src/**/detail/**/*')
265
266 if bld.env['HAVE_RTNETLINK']:
267 headers += bld.path.ant_glob('src/**/*-rtnl.hpp', excl='src/**/detail/**/*')
268
269 # In case we want to make it optional later
270 headers += bld.path.ant_glob('src/**/*-sqlite3.hpp', excl='src/**/detail/**/*')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700271
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500272 bld.install_files('%s/ndn-cxx' % bld.env['INCLUDEDIR'], headers,
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700273 relative_trick=True, cwd=bld.path.find_node('src'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800274
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500275 bld.install_files('%s/ndn-cxx' % bld.env['INCLUDEDIR'],
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700276 bld.path.find_resource('src/ndn-cxx-config.hpp'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800277
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500278 bld.install_files('%s/ndn-cxx' % bld.env['INCLUDEDIR'],
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700279 bld.path.find_resource('src/version.hpp'))
280
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500281 bld.install_files('${SYSCONFDIR}/ndn', 'client.conf.sample')
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600282
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500283 if bld.env.SPHINX_BUILD:
284 bld(features='sphinx',
285 name='manpages',
286 builder='man',
287 outdir='docs/manpages',
288 config='docs/conf.py',
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700289 source=bld.path.ant_glob('docs/manpages/**/*.rst'),
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500290 install_path='${MANDIR}',
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700291 VERSION=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700292
293def docs(bld):
294 from waflib import Options
295 Options.commands = ['doxygen', 'sphinx'] + Options.commands
296
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000297def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700298 version(bld)
299
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800300 if not bld.env.DOXYGEN:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500301 bld.fatal('Cannot build documentation ("doxygen" not found in PATH)')
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700302
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500303 bld(features='subst',
304 name='doxygen.conf',
305 source=['docs/doxygen.conf.in',
306 'docs/named_data_theme/named_data_footer-with-analytics.html.in'],
307 target=['docs/doxygen.conf',
308 'docs/named_data_theme/named_data_footer-with-analytics.html'],
309 VERSION=VERSION,
310 HTML_FOOTER='../build/docs/named_data_theme/named_data_footer-with-analytics.html' \
311 if os.getenv('GOOGLE_ANALYTICS', None) \
312 else '../docs/named_data_theme/named_data_footer.html',
313 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ''))
314
315 bld(features='doxygen',
316 doxyfile='docs/doxygen.conf',
317 use='doxygen.conf')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800318
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700319def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700320 version(bld)
321
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700322 if not bld.env.SPHINX_BUILD:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500323 bld.fatal('Cannot build documentation ("sphinx-build" not found in PATH)')
324
325 bld(features='sphinx',
326 config='docs/conf.py',
327 outdir='docs',
328 source=bld.path.ant_glob('docs/**/*.rst'),
329 VERSION=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700330
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700331def version(ctx):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500332 # don't execute more than once
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700333 if getattr(Context.g_module, 'VERSION_BASE', None):
334 return
335
336 Context.g_module.VERSION_BASE = Context.g_module.VERSION
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500337 Context.g_module.VERSION_SPLIT = VERSION_BASE.split('.')
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700338
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500339 # first, try to get a version string from git
340 gotVersionFromGit = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700341 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700342 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500343 out = subprocess.check_output(cmd, universal_newlines=True).strip()
344 if out:
345 gotVersionFromGit = True
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700346 if out.startswith(GIT_TAG_PREFIX):
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500347 Context.g_module.VERSION = out.lstrip(GIT_TAG_PREFIX)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700348 else:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500349 # no tags matched
350 Context.g_module.VERSION = '%s-commit-%s' % (VERSION_BASE, out)
351 except subprocess.CalledProcessError:
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700352 pass
353
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700354 versionFile = ctx.path.find_node('VERSION')
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500355 if not gotVersionFromGit and versionFile is not None:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700356 try:
357 Context.g_module.VERSION = versionFile.read()
358 return
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500359 except EnvironmentError:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700360 pass
361
362 # version was obtained from git, update VERSION file if necessary
363 if versionFile is not None:
364 try:
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500365 if versionFile.read() == Context.g_module.VERSION:
366 # already up-to-date
367 return
368 except EnvironmentError as e:
369 Logs.warn('%s exists but is not readable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700370 else:
371 versionFile = ctx.path.make_node('VERSION')
372
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700373 try:
374 versionFile.write(Context.g_module.VERSION)
Alexander Afanasyev5560fd42018-03-07 17:03:03 -0500375 except EnvironmentError as e:
376 Logs.warn('%s is not writable (%s)' % (versionFile, e.strerror))
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700377
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700378def dist(ctx):
379 version(ctx)
380
381def distcheck(ctx):
382 version(ctx)