blob: 132bd9d663e9155d4af699d38b9bd6dfd37131d9 [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 Afanasyevcfe0b062014-05-08 18:26:50 -07003from waflib import Logs, Utils, Context
4import os
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -07005
susmitf47cef62018-02-13 12:01:14 -07006VERSION = "0.6.1"
Alexander Afanasyev766cea72014-04-24 19:16:42 -07007APPNAME = "ndn-cxx"
Davide Pesavento0530b5b2016-11-07 03:23:58 +01008PACKAGE_BUGREPORT = "https://redmine.named-data.net/projects/ndn-cxx"
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -07009PACKAGE_URL = "http://named-data.net/doc/ndn-cxx/"
Alexander Afanasyev6c632302014-10-31 12:34:11 -070010GIT_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:
67 conf.fatal("Either static library or shared library must be enabled")
68
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)
Davide Pesavento2bf35a62017-04-02 00:41:06 -040082 conf.check_cxx(function_name='getpass', header_name='unistd.h', mandatory=False)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070083
Davide Pesavento2bf35a62017-04-02 00:41:06 -040084 if conf.check_cxx(msg='Checking for rtnetlink', define_name='HAVE_RTNETLINK', mandatory=False,
85 header_name=['linux/if_addr.h', 'linux/if_link.h',
86 'linux/netlink.h', 'linux/rtnetlink.h']):
87 conf.env['HAVE_RTNETLINK'] = True
88 conf.check_cxx(msg='Checking for IFA_FLAGS', define_name='HAVE_IFA_FLAGS', mandatory=False,
89 fragment='''
90 #include <linux/if_addr.h>
91 int main() { return IFA_FLAGS; }
92 ''')
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -080093
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -050094 conf.check_osx_frameworks()
Yingdi Yue6bfab22014-02-06 16:01:19 -080095
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070096 conf.check_sqlite3(mandatory=True)
Yingdi Yub3015bd2015-06-23 23:21:53 -070097 conf.check_openssl(mandatory=True, atleast_version=0x10001000) # 1.0.1
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080098
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070099 USED_BOOST_LIBS = ['system', 'filesystem', 'date_time', 'iostreams',
Davide Pesavento1cd9f6e2016-10-08 00:26:36 +0200100 'regex', 'program_options', 'chrono', 'thread',
101 'log', 'log_setup']
Junxiao Shi7d054272016-08-04 17:00:41 +0000102
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000103 if conf.env['WITH_TESTS']:
104 USED_BOOST_LIBS += ['unit_test_framework']
Yingdi Yuf56c68f2014-04-24 21:50:13 -0700105 conf.define('HAVE_TESTS', 1)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800106
Junxiao Shi7d054272016-08-04 17:00:41 +0000107 conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True, mt=True)
Davide Pesaventoe6e6fde2016-04-16 14:44:45 +0200108 if conf.env.BOOST_VERSION_NUMBER < 105400:
109 Logs.error("Minimum required boost version is 1.54.0")
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700110 Logs.error("Please upgrade your distribution or install custom boost libraries" +
Davide Pesavento81bf95c2017-05-27 14:23:08 -0400111 " (https://redmine.named-data.net/projects/nfd/wiki/Boost_FAQ)")
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000112 return
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800113
Davide Pesavento81bf95c2017-05-27 14:23:08 -0400114 if conf.env['CXX_NAME'] == 'clang' and conf.env.BOOST_VERSION_NUMBER < 105800:
115 conf.env.append_value('DEFINES', 'BOOST_ASIO_HAS_STD_ARRAY=1') # Bug #4096
116
Alexander Afanasyev5b60f702014-02-07 12:55:24 -0800117 if not conf.options.with_sqlite_locking:
118 conf.define('DISABLE_SQLITE3_FS_LOCKING', 1)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800119
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500120 if conf.env['HAVE_OSX_FRAMEWORKS']:
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -0800121 conf.env['WITH_OSX_KEYCHAIN'] = conf.options.with_osx_keychain
122 if conf.options.with_osx_keychain:
123 conf.define('WITH_OSX_KEYCHAIN', 1)
124 else:
125 conf.env['WITH_OSX_KEYCHAIN'] = False
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800126
Alexander Afanasyevb82d8c32017-09-21 11:35:07 -0400127 conf.check_compiler_flags()
128
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700129 # Loading "late" to prevent tests to be compiled with profiling flags
130 conf.load('coverage')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800131
Eric Newberrya3973e02016-11-01 17:58:12 -0700132 conf.load('sanitizers')
133
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600134 conf.define('SYSCONFDIR', conf.env['SYSCONFDIR'])
135
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200136 if not conf.env.enable_static:
137 # If there happens to be a static library, waf will put the corresponding -L flags
138 # before dynamic library flags. This can result in compilation failure when the
139 # system has a different version of the ndn-cxx library installed.
140 conf.env['STLIBPATH'] = ['.'] + conf.env['STLIBPATH']
141
Alexander Afanasyev3e7d2ac2015-02-10 19:39:28 -0800142 # config file will contain all defines that were added using conf.define('xxx'...)
143 # Everything that was added directly to conf.env['DEFINES'] will not appear in the
144 # config file and will be added using compiler directives in the command line.
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700145 conf.write_config_header('src/ndn-cxx-config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800146
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700147def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700148 version(bld)
149
150 bld(features="subst",
151 name='version',
152 source='src/version.hpp.in',
153 target='src/version.hpp',
154 install_path=None,
155 VERSION_STRING=VERSION_BASE,
156 VERSION_BUILD=VERSION,
157 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
158 int(VERSION_SPLIT[1]) * 1000 +
159 int(VERSION_SPLIT[2]),
160 VERSION_MAJOR=VERSION_SPLIT[0],
161 VERSION_MINOR=VERSION_SPLIT[1],
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200162 VERSION_PATCH=VERSION_SPLIT[2])
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700163
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500164 if bld.env['HAVE_OSX_FRAMEWORKS']:
165 # Need to disable precompiled headers for Objective-C++ code
166 bld(features=['cxx'],
167 target="ndn-cxx-mm",
168 name="ndn-cxx-mm",
169 source=bld.path.ant_glob(['src/**/*-osx.mm']),
Alexander Afanasyevadc71842017-01-26 22:17:58 -0500170 use='version BOOST OPENSSL SQLITE3 RT PTHREAD OSX_COREFOUNDATION OSX_CORESERVICES OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN',
Alexander Afanasyev7cd43ab2017-03-27 21:33:10 -0500171 includes=". src")
172
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800173 libndn_cxx = dict(
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700174 target="ndn-cxx",
175 name="ndn-cxx",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700176 source=bld.path.ant_glob('src/**/*.cpp',
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500177 excl=['src/**/*-osx.cpp',
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400178 'src/**/*-rtnl.cpp',
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100179 'src/**/*-sqlite3.cpp']),
Alexander Afanasyev8b1674a2014-05-15 00:58:43 -0700180 headers='src/common-pch.hpp',
Alexander Afanasyevadc71842017-01-26 22:17:58 -0500181 use='version ndn-cxx-mm BOOST OPENSSL SQLITE3 RT PTHREAD',
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700182 includes=". src",
183 export_includes="src",
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200184 install_path='${LIBDIR}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800185
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500186 if bld.env['HAVE_OSX_FRAMEWORKS']:
187 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-osx.cpp')
Alexander Afanasyev5bcee102017-03-27 22:28:29 -0500188 libndn_cxx['use'] += " OSX_COREFOUNDATION OSX_CORESERVICES OSX_SECURITY OSX_SYSTEMCONFIGURATION OSX_FOUNDATION OSX_COREWLAN"
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500189
Davide Pesavento2bf35a62017-04-02 00:41:06 -0400190 if bld.env['HAVE_RTNETLINK']:
191 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-rtnl.cpp')
192
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800193 # In case we want to make it optional later
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800194 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-sqlite3.cpp')
195
196 if bld.env.enable_shared:
197 bld(features=['pch', 'cxx', 'cxxshlib'],
198 vnum=VERSION_BASE,
199 cnum=VERSION_BASE,
200 **libndn_cxx)
201
202 if bld.env.enable_static:
203 bld(features=['pch', 'cxx', 'cxxstlib'],
204 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800205
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700206 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800207 pkgconfig_libs = []
208 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800209 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800210 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800211 pkgconfig_cxxflags = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800212 for lib in Utils.to_list(libndn_cxx['use']):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800213 if bld.env['LIB_%s' % lib]:
214 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
215 if bld.env['LIBPATH_%s' % lib]:
216 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
217 if bld.env['INCLUDES_%s' % lib]:
218 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800219 if bld.env['LINKFLAGS_%s' % lib]:
220 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
221 if bld.env['CXXFLAGS_%s' % lib]:
222 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800223
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200224 EXTRA_FRAMEWORKS = ""
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500225 if bld.env['HAVE_OSX_FRAMEWORKS']:
Alexander Afanasyev5bcee102017-03-27 22:28:29 -0500226 EXTRA_FRAMEWORKS = "-framework CoreFoundation -framework CoreServices -framework Security -framework SystemConfiguration -framework Foundation -framework CoreWLAN"
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800227
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800228 def uniq(alist):
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200229 seen = set()
230 return [x for x in alist if x not in seen and not seen.add(x)]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800231
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700232 pkconfig = bld(features="subst",
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700233 source="libndn-cxx.pc.in",
234 target="libndn-cxx.pc",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700235 install_path="${LIBDIR}/pkgconfig",
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700236 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800237
238 # This probably not the right thing to do, but to simplify life of apps
239 # that use the library
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700240 EXTRA_LIBS=" ".join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
241 EXTRA_LDFLAGS=" ".join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
242 EXTRA_LINKFLAGS=" ".join(uniq(pkgconfig_linkflags)),
243 EXTRA_INCLUDES=" ".join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
244 EXTRA_CXXFLAGS=" ".join(uniq(pkgconfig_cxxflags)),
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200245 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800246
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800247 if bld.env['WITH_TESTS']:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800248 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800249
Yingdi Yue6bfab22014-02-06 16:01:19 -0800250 if bld.env['WITH_TOOLS']:
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700251 bld.recurse("tools")
252
253 if bld.env['WITH_EXAMPLES']:
Yingdi Yue6bfab22014-02-06 16:01:19 -0800254 bld.recurse("examples")
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800255
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100256 headers = bld.path.ant_glob('src/**/*.hpp',
Alexander Afanasyev0cf887d2017-03-26 16:58:59 -0500257 excl=['src/**/*-osx.hpp',
258 'src/**/*-rtnl.hpp',
259 'src/**/*-sqlite3.hpp',
260 'src/**/detail/**/*'])
261 if bld.env['HAVE_OSX_FRAMEWORKS']:
262 headers += bld.path.ant_glob('src/**/*-osx.hpp', excl='src/**/detail/**/*')
263
264 if bld.env['HAVE_RTNETLINK']:
265 headers += bld.path.ant_glob('src/**/*-rtnl.hpp', excl='src/**/detail/**/*')
266
267 # In case we want to make it optional later
268 headers += bld.path.ant_glob('src/**/*-sqlite3.hpp', excl='src/**/detail/**/*')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700269
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700270 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'], headers,
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700271 relative_trick=True, cwd=bld.path.find_node('src'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800272
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700273 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
274 bld.path.find_resource('src/ndn-cxx-config.hpp'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800275
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700276 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
277 bld.path.find_resource('src/version.hpp'))
278
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600279 bld.install_files("${SYSCONFDIR}/ndn", "client.conf.sample")
280
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700281 if bld.env['SPHINX_BUILD']:
282 bld(features="sphinx",
283 builder="man",
284 outdir="docs/manpages",
285 config="docs/conf.py",
286 source=bld.path.ant_glob('docs/manpages/**/*.rst'),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700287 install_path="${MANDIR}/",
288 VERSION=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700289
290def docs(bld):
291 from waflib import Options
292 Options.commands = ['doxygen', 'sphinx'] + Options.commands
293
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000294def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700295 version(bld)
296
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800297 if not bld.env.DOXYGEN:
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200298 Logs.error("ERROR: cannot build documentation (`doxygen' not found in $PATH)")
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700299 else:
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700300 bld(features="subst",
301 name="doxygen-conf",
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700302 source=["docs/doxygen.conf.in",
303 "docs/named_data_theme/named_data_footer-with-analytics.html.in"],
304 target=["docs/doxygen.conf",
305 "docs/named_data_theme/named_data_footer-with-analytics.html"],
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700306 VERSION=VERSION,
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700307 HTML_FOOTER="../build/docs/named_data_theme/named_data_footer-with-analytics.html" \
308 if os.getenv('GOOGLE_ANALYTICS', None) \
309 else "../docs/named_data_theme/named_data_footer.html",
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200310 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ""))
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700311
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700312 bld(features="doxygen",
Davide Pesaventoba4fbbe2017-07-03 01:06:30 -0400313 doxyfile="docs/doxygen.conf",
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700314 use="doxygen-conf")
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800315
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700316def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700317 version(bld)
318
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700319 if not bld.env.SPHINX_BUILD:
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200320 bld.fatal("ERROR: cannot build documentation (`sphinx-build' not found in $PATH)")
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700321 else:
322 bld(features="sphinx",
323 outdir="docs",
324 source=bld.path.ant_glob("docs/**/*.rst"),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700325 config="docs/conf.py",
326 VERSION=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700327
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700328def version(ctx):
329 if getattr(Context.g_module, 'VERSION_BASE', None):
330 return
331
332 Context.g_module.VERSION_BASE = Context.g_module.VERSION
333 Context.g_module.VERSION_SPLIT = [v for v in VERSION_BASE.split('.')]
334
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700335 didGetVersion = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700336 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700337 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700338 p = Utils.subprocess.Popen(cmd, stdout=Utils.subprocess.PIPE,
339 stderr=None, stdin=None)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700340 out = str(p.communicate()[0].strip())
341 didGetVersion = (p.returncode == 0 and out != "")
342 if didGetVersion:
343 if out.startswith(GIT_TAG_PREFIX):
344 Context.g_module.VERSION = out[len(GIT_TAG_PREFIX):]
345 else:
346 Context.g_module.VERSION = "%s-commit-%s" % (Context.g_module.VERSION_BASE, out)
347 except OSError:
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700348 pass
349
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700350 versionFile = ctx.path.find_node('VERSION')
351
352 if not didGetVersion and versionFile is not None:
353 try:
354 Context.g_module.VERSION = versionFile.read()
355 return
356 except (OSError, IOError):
357 pass
358
359 # version was obtained from git, update VERSION file if necessary
360 if versionFile is not None:
361 try:
362 version = versionFile.read()
363 if version == Context.g_module.VERSION:
364 return # no need to update
365 except (OSError, IOError):
366 Logs.warn("VERSION file exists, but not readable")
367 else:
368 versionFile = ctx.path.make_node('VERSION')
369
370 if versionFile is None:
371 return
372
373 try:
374 versionFile.write(Context.g_module.VERSION)
375 except (OSError, IOError):
376 Logs.warn("VERSION file is not writeable")
377
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700378def dist(ctx):
379 version(ctx)
380
381def distcheck(ctx):
382 version(ctx)