blob: d5723822456b57288a457f96fb15cb0905f2f638 [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
Alexander Afanasyev4df22302016-09-28 15:02:06 +09006VERSION = "0.5.0"
Alexander Afanasyev766cea72014-04-24 19:16:42 -07007APPNAME = "ndn-cxx"
8PACKAGE_BUGREPORT = "http://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',
15 'coverage', 'pch', 'sanitizers', 'osx-security',
16 'boost', 'cryptopp', 'openssl', 'sqlite3',
17 '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',
Eric Newberrya3973e02016-11-01 17:58:12 -070071 'pch', 'osx-security', 'boost', 'cryptopp', '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
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070080 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD',
81 mandatory=False)
82 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Alexander Afanasyev3188c40f2015-01-28 14:49:42 -080083 conf.check_cxx(msg='Checking for function getpass', mandatory=False,
84 define_name='HAVE_GETPASS', fragment='''
85#include <unistd.h>
86int
87main(int, char**)
88{
89 char* pass = getpass("test prompt");
90 (void)(pass);
91 return 0;
92}
93''')
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070094
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -080095 conf.check_cxx(msg='Checking for rtnetlink', mandatory=False,
96 define_name='HAVE_RTNETLINK',
97 header_name=['netinet/in.h', 'linux/netlink.h', 'linux/rtnetlink.h', 'net/if.h'])
98
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070099 conf.check_osx_security(mandatory=False)
Yingdi Yue6bfab22014-02-06 16:01:19 -0800100
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700101 conf.check_sqlite3(mandatory=True)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -0700102 conf.check_cryptopp(mandatory=True, use='PTHREAD')
Yingdi Yub3015bd2015-06-23 23:21:53 -0700103 conf.check_openssl(mandatory=True, atleast_version=0x10001000) # 1.0.1
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800104
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700105 USED_BOOST_LIBS = ['system', 'filesystem', 'date_time', 'iostreams',
Davide Pesavento1cd9f6e2016-10-08 00:26:36 +0200106 'regex', 'program_options', 'chrono', 'thread',
107 'log', 'log_setup']
Junxiao Shi7d054272016-08-04 17:00:41 +0000108
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000109 if conf.env['WITH_TESTS']:
110 USED_BOOST_LIBS += ['unit_test_framework']
Yingdi Yuf56c68f2014-04-24 21:50:13 -0700111 conf.define('HAVE_TESTS', 1)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800112
Junxiao Shi7d054272016-08-04 17:00:41 +0000113 conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True, mt=True)
Davide Pesaventoe6e6fde2016-04-16 14:44:45 +0200114 if conf.env.BOOST_VERSION_NUMBER < 105400:
115 Logs.error("Minimum required boost version is 1.54.0")
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700116 Logs.error("Please upgrade your distribution or install custom boost libraries" +
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000117 " (http://redmine.named-data.net/projects/nfd/wiki/Boost_FAQ)")
118 return
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800119
Alexander Afanasyev5b60f702014-02-07 12:55:24 -0800120 if not conf.options.with_sqlite_locking:
121 conf.define('DISABLE_SQLITE3_FS_LOCKING', 1)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800122
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700123 if conf.env['HAVE_OSX_SECURITY']:
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -0800124 conf.env['WITH_OSX_KEYCHAIN'] = conf.options.with_osx_keychain
125 if conf.options.with_osx_keychain:
126 conf.define('WITH_OSX_KEYCHAIN', 1)
127 else:
128 conf.env['WITH_OSX_KEYCHAIN'] = False
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800129
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700130 # Loading "late" to prevent tests to be compiled with profiling flags
131 conf.load('coverage')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800132
Eric Newberrya3973e02016-11-01 17:58:12 -0700133 conf.load('sanitizers')
134
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600135 conf.define('SYSCONFDIR', conf.env['SYSCONFDIR'])
136
Alexander Afanasyev224044f2016-07-18 10:45:08 +0200137 if not conf.env.enable_static:
138 # If there happens to be a static library, waf will put the corresponding -L flags
139 # before dynamic library flags. This can result in compilation failure when the
140 # system has a different version of the ndn-cxx library installed.
141 conf.env['STLIBPATH'] = ['.'] + conf.env['STLIBPATH']
142
Alexander Afanasyev3e7d2ac2015-02-10 19:39:28 -0800143 # config file will contain all defines that were added using conf.define('xxx'...)
144 # Everything that was added directly to conf.env['DEFINES'] will not appear in the
145 # config file and will be added using compiler directives in the command line.
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700146 conf.write_config_header('src/ndn-cxx-config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800147
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700148def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700149 version(bld)
150
151 bld(features="subst",
152 name='version',
153 source='src/version.hpp.in',
154 target='src/version.hpp',
155 install_path=None,
156 VERSION_STRING=VERSION_BASE,
157 VERSION_BUILD=VERSION,
158 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
159 int(VERSION_SPLIT[1]) * 1000 +
160 int(VERSION_SPLIT[2]),
161 VERSION_MAJOR=VERSION_SPLIT[0],
162 VERSION_MINOR=VERSION_SPLIT[1],
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200163 VERSION_PATCH=VERSION_SPLIT[2])
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700164
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800165 libndn_cxx = dict(
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700166 target="ndn-cxx",
167 name="ndn-cxx",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700168 source=bld.path.ant_glob('src/**/*.cpp',
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100169 excl=['src/security/**/*-osx.cpp',
170 'src/**/*-sqlite3.cpp']),
Alexander Afanasyev8b1674a2014-05-15 00:58:43 -0700171 headers='src/common-pch.hpp',
Yingdi Yub3015bd2015-06-23 23:21:53 -0700172 use='version BOOST CRYPTOPP OPENSSL SQLITE3 RT PTHREAD',
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700173 includes=". src",
174 export_includes="src",
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200175 install_path='${LIBDIR}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800176
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700177 if bld.env['HAVE_OSX_SECURITY']:
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100178 libndn_cxx['source'] += bld.path.ant_glob('src/security/**/*-osx.cpp')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800179 libndn_cxx['mac_app'] = True
180 libndn_cxx['use'] += " OSX_COREFOUNDATION OSX_SECURITY"
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800181
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800182 # In case we want to make it optional later
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800183 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-sqlite3.cpp')
184
185 if bld.env.enable_shared:
186 bld(features=['pch', 'cxx', 'cxxshlib'],
187 vnum=VERSION_BASE,
188 cnum=VERSION_BASE,
189 **libndn_cxx)
190
191 if bld.env.enable_static:
192 bld(features=['pch', 'cxx', 'cxxstlib'],
193 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800194
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700195 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800196 pkgconfig_libs = []
197 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800198 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800199 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800200 pkgconfig_cxxflags = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800201 for lib in Utils.to_list(libndn_cxx['use']):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800202 if bld.env['LIB_%s' % lib]:
203 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
204 if bld.env['LIBPATH_%s' % lib]:
205 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
206 if bld.env['INCLUDES_%s' % lib]:
207 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800208 if bld.env['LINKFLAGS_%s' % lib]:
209 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
210 if bld.env['CXXFLAGS_%s' % lib]:
211 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800212
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200213 EXTRA_FRAMEWORKS = ""
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700214 if bld.env['HAVE_OSX_SECURITY']:
Alexander Afanasyev84cf4292014-01-29 22:16:27 -0800215 EXTRA_FRAMEWORKS = "-framework CoreFoundation -framework Security"
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800216
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800217 def uniq(alist):
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200218 seen = set()
219 return [x for x in alist if x not in seen and not seen.add(x)]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800220
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700221 pkconfig = bld(features="subst",
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700222 source="libndn-cxx.pc.in",
223 target="libndn-cxx.pc",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700224 install_path="${LIBDIR}/pkgconfig",
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700225 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800226
227 # This probably not the right thing to do, but to simplify life of apps
228 # that use the library
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700229 EXTRA_LIBS=" ".join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
230 EXTRA_LDFLAGS=" ".join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
231 EXTRA_LINKFLAGS=" ".join(uniq(pkgconfig_linkflags)),
232 EXTRA_INCLUDES=" ".join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
233 EXTRA_CXXFLAGS=" ".join(uniq(pkgconfig_cxxflags)),
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200234 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800235
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800236 if bld.env['WITH_TESTS']:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800237 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800238
Yingdi Yue6bfab22014-02-06 16:01:19 -0800239 if bld.env['WITH_TOOLS']:
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700240 bld.recurse("tools")
241
242 if bld.env['WITH_EXAMPLES']:
Yingdi Yue6bfab22014-02-06 16:01:19 -0800243 bld.recurse("examples")
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800244
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100245 headers = bld.path.ant_glob('src/**/*.hpp',
246 excl=['src/security/**/*-osx.hpp',
247 'src/detail/**/*',
248 'src/util/detail/**/*'])
Junxiao Shie30aaea2014-12-03 20:48:34 -0700249 if bld.env['HAVE_OSX_SECURITY']:
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100250 headers += bld.path.ant_glob('src/security/**/*-osx.hpp')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700251
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700252 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'], headers,
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700253 relative_trick=True, cwd=bld.path.find_node('src'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800254
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700255 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
256 bld.path.find_resource('src/ndn-cxx-config.hpp'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800257
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700258 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
259 bld.path.find_resource('src/version.hpp'))
260
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600261 bld.install_files("${SYSCONFDIR}/ndn", "client.conf.sample")
262
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700263 if bld.env['SPHINX_BUILD']:
264 bld(features="sphinx",
265 builder="man",
266 outdir="docs/manpages",
267 config="docs/conf.py",
268 source=bld.path.ant_glob('docs/manpages/**/*.rst'),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700269 install_path="${MANDIR}/",
270 VERSION=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700271
272def docs(bld):
273 from waflib import Options
274 Options.commands = ['doxygen', 'sphinx'] + Options.commands
275
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000276def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700277 version(bld)
278
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800279 if not bld.env.DOXYGEN:
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200280 Logs.error("ERROR: cannot build documentation (`doxygen' not found in $PATH)")
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700281 else:
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700282 bld(features="subst",
283 name="doxygen-conf",
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700284 source=["docs/doxygen.conf.in",
285 "docs/named_data_theme/named_data_footer-with-analytics.html.in"],
286 target=["docs/doxygen.conf",
287 "docs/named_data_theme/named_data_footer-with-analytics.html"],
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700288 VERSION=VERSION,
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700289 HTML_FOOTER="../build/docs/named_data_theme/named_data_footer-with-analytics.html" \
290 if os.getenv('GOOGLE_ANALYTICS', None) \
291 else "../docs/named_data_theme/named_data_footer.html",
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200292 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ""))
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700293
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700294 bld(features="doxygen",
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700295 doxyfile='docs/doxygen.conf',
296 use="doxygen-conf")
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800297
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700298def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700299 version(bld)
300
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700301 if not bld.env.SPHINX_BUILD:
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200302 bld.fatal("ERROR: cannot build documentation (`sphinx-build' not found in $PATH)")
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700303 else:
304 bld(features="sphinx",
305 outdir="docs",
306 source=bld.path.ant_glob("docs/**/*.rst"),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700307 config="docs/conf.py",
308 VERSION=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700309
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700310def version(ctx):
311 if getattr(Context.g_module, 'VERSION_BASE', None):
312 return
313
314 Context.g_module.VERSION_BASE = Context.g_module.VERSION
315 Context.g_module.VERSION_SPLIT = [v for v in VERSION_BASE.split('.')]
316
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700317 didGetVersion = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700318 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700319 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700320 p = Utils.subprocess.Popen(cmd, stdout=Utils.subprocess.PIPE,
321 stderr=None, stdin=None)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700322 out = str(p.communicate()[0].strip())
323 didGetVersion = (p.returncode == 0 and out != "")
324 if didGetVersion:
325 if out.startswith(GIT_TAG_PREFIX):
326 Context.g_module.VERSION = out[len(GIT_TAG_PREFIX):]
327 else:
328 Context.g_module.VERSION = "%s-commit-%s" % (Context.g_module.VERSION_BASE, out)
329 except OSError:
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700330 pass
331
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700332 versionFile = ctx.path.find_node('VERSION')
333
334 if not didGetVersion and versionFile is not None:
335 try:
336 Context.g_module.VERSION = versionFile.read()
337 return
338 except (OSError, IOError):
339 pass
340
341 # version was obtained from git, update VERSION file if necessary
342 if versionFile is not None:
343 try:
344 version = versionFile.read()
345 if version == Context.g_module.VERSION:
346 return # no need to update
347 except (OSError, IOError):
348 Logs.warn("VERSION file exists, but not readable")
349 else:
350 versionFile = ctx.path.make_node('VERSION')
351
352 if versionFile is None:
353 return
354
355 try:
356 versionFile.write(Context.g_module.VERSION)
357 except (OSError, IOError):
358 Logs.warn("VERSION file is not writeable")
359
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700360def dist(ctx):
361 version(ctx)
362
363def distcheck(ctx):
364 version(ctx)