blob: 5cff2a6e82340d905fd69e0b9598a81ee3612a14 [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',
71 'pch', 'sanitizers', 'osx-security',
72 'boost', 'cryptopp', 'openssl', 'sqlite3',
73 'doxygen', 'sphinx_build'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080074
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070075 conf.env['WITH_TESTS'] = conf.options.with_tests
76 conf.env['WITH_TOOLS'] = conf.options.with_tools
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -070077 conf.env['WITH_EXAMPLES'] = conf.options.with_examples
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080078
Alexander Afanasyev95de62e2014-04-11 18:26:33 -070079 conf.find_program('sh', var='SH', mandatory=True)
80
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070081 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD',
82 mandatory=False)
83 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Alexander Afanasyev3188c40f2015-01-28 14:49:42 -080084 conf.check_cxx(msg='Checking for function getpass', mandatory=False,
85 define_name='HAVE_GETPASS', fragment='''
86#include <unistd.h>
87int
88main(int, char**)
89{
90 char* pass = getpass("test prompt");
91 (void)(pass);
92 return 0;
93}
94''')
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070095
Alexander Afanasyev7b3080f2015-01-28 21:21:01 -080096 conf.check_cxx(msg='Checking for rtnetlink', mandatory=False,
97 define_name='HAVE_RTNETLINK',
98 header_name=['netinet/in.h', 'linux/netlink.h', 'linux/rtnetlink.h', 'net/if.h'])
99
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700100 conf.check_osx_security(mandatory=False)
Yingdi Yue6bfab22014-02-06 16:01:19 -0800101
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700102 conf.check_sqlite3(mandatory=True)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -0700103 conf.check_cryptopp(mandatory=True, use='PTHREAD')
Yingdi Yub3015bd2015-06-23 23:21:53 -0700104 conf.check_openssl(mandatory=True, atleast_version=0x10001000) # 1.0.1
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800105
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700106 USED_BOOST_LIBS = ['system', 'filesystem', 'date_time', 'iostreams',
Davide Pesavento1cd9f6e2016-10-08 00:26:36 +0200107 'regex', 'program_options', 'chrono', 'thread',
108 'log', 'log_setup']
Junxiao Shi7d054272016-08-04 17:00:41 +0000109
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000110 if conf.env['WITH_TESTS']:
111 USED_BOOST_LIBS += ['unit_test_framework']
Yingdi Yuf56c68f2014-04-24 21:50:13 -0700112 conf.define('HAVE_TESTS', 1)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800113
Junxiao Shi7d054272016-08-04 17:00:41 +0000114 conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True, mt=True)
Davide Pesaventoe6e6fde2016-04-16 14:44:45 +0200115 if conf.env.BOOST_VERSION_NUMBER < 105400:
116 Logs.error("Minimum required boost version is 1.54.0")
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700117 Logs.error("Please upgrade your distribution or install custom boost libraries" +
Alexander Afanasyevdafdc372014-03-03 15:58:44 +0000118 " (http://redmine.named-data.net/projects/nfd/wiki/Boost_FAQ)")
119 return
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800120
Alexander Afanasyev5b60f702014-02-07 12:55:24 -0800121 if not conf.options.with_sqlite_locking:
122 conf.define('DISABLE_SQLITE3_FS_LOCKING', 1)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800123
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700124 if conf.env['HAVE_OSX_SECURITY']:
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -0800125 conf.env['WITH_OSX_KEYCHAIN'] = conf.options.with_osx_keychain
126 if conf.options.with_osx_keychain:
127 conf.define('WITH_OSX_KEYCHAIN', 1)
128 else:
129 conf.env['WITH_OSX_KEYCHAIN'] = False
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800130
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700131 # Loading "late" to prevent tests to be compiled with profiling flags
132 conf.load('coverage')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800133
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 Afanasyev5519cc72015-03-01 14:25:03 -0800164 libndn_cxx = dict(
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700165 target="ndn-cxx",
166 name="ndn-cxx",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700167 source=bld.path.ant_glob('src/**/*.cpp',
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100168 excl=['src/security/**/*-osx.cpp',
169 'src/**/*-sqlite3.cpp']),
Alexander Afanasyev8b1674a2014-05-15 00:58:43 -0700170 headers='src/common-pch.hpp',
Yingdi Yub3015bd2015-06-23 23:21:53 -0700171 use='version BOOST CRYPTOPP OPENSSL SQLITE3 RT PTHREAD',
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700172 includes=". src",
173 export_includes="src",
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200174 install_path='${LIBDIR}')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800175
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700176 if bld.env['HAVE_OSX_SECURITY']:
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100177 libndn_cxx['source'] += bld.path.ant_glob('src/security/**/*-osx.cpp')
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800178 libndn_cxx['mac_app'] = True
179 libndn_cxx['use'] += " OSX_COREFOUNDATION OSX_SECURITY"
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800180
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800181 # In case we want to make it optional later
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800182 libndn_cxx['source'] += bld.path.ant_glob('src/**/*-sqlite3.cpp')
183
184 if bld.env.enable_shared:
185 bld(features=['pch', 'cxx', 'cxxshlib'],
186 vnum=VERSION_BASE,
187 cnum=VERSION_BASE,
188 **libndn_cxx)
189
190 if bld.env.enable_static:
191 bld(features=['pch', 'cxx', 'cxxstlib'],
192 **libndn_cxx)
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800193
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700194 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800195 pkgconfig_libs = []
196 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800197 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800198 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800199 pkgconfig_cxxflags = []
Alexander Afanasyev5519cc72015-03-01 14:25:03 -0800200 for lib in Utils.to_list(libndn_cxx['use']):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800201 if bld.env['LIB_%s' % lib]:
202 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
203 if bld.env['LIBPATH_%s' % lib]:
204 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
205 if bld.env['INCLUDES_%s' % lib]:
206 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800207 if bld.env['LINKFLAGS_%s' % lib]:
208 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
209 if bld.env['CXXFLAGS_%s' % lib]:
210 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800211
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200212 EXTRA_FRAMEWORKS = ""
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700213 if bld.env['HAVE_OSX_SECURITY']:
Alexander Afanasyev84cf4292014-01-29 22:16:27 -0800214 EXTRA_FRAMEWORKS = "-framework CoreFoundation -framework Security"
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800215
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800216 def uniq(alist):
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200217 seen = set()
218 return [x for x in alist if x not in seen and not seen.add(x)]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800219
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700220 pkconfig = bld(features="subst",
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700221 source="libndn-cxx.pc.in",
222 target="libndn-cxx.pc",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700223 install_path="${LIBDIR}/pkgconfig",
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700224 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800225
226 # This probably not the right thing to do, but to simplify life of apps
227 # that use the library
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700228 EXTRA_LIBS=" ".join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
229 EXTRA_LDFLAGS=" ".join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
230 EXTRA_LINKFLAGS=" ".join(uniq(pkgconfig_linkflags)),
231 EXTRA_INCLUDES=" ".join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
232 EXTRA_CXXFLAGS=" ".join(uniq(pkgconfig_cxxflags)),
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200233 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800234
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800235 if bld.env['WITH_TESTS']:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800236 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800237
Yingdi Yue6bfab22014-02-06 16:01:19 -0800238 if bld.env['WITH_TOOLS']:
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700239 bld.recurse("tools")
240
241 if bld.env['WITH_EXAMPLES']:
Yingdi Yue6bfab22014-02-06 16:01:19 -0800242 bld.recurse("examples")
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800243
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100244 headers = bld.path.ant_glob('src/**/*.hpp',
245 excl=['src/security/**/*-osx.hpp',
246 'src/detail/**/*',
247 'src/util/detail/**/*'])
Junxiao Shie30aaea2014-12-03 20:48:34 -0700248 if bld.env['HAVE_OSX_SECURITY']:
Davide Pesavento9a8bae52016-02-24 20:33:08 +0100249 headers += bld.path.ant_glob('src/security/**/*-osx.hpp')
Junxiao Shie30aaea2014-12-03 20:48:34 -0700250
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700251 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'], headers,
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700252 relative_trick=True, cwd=bld.path.find_node('src'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800253
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700254 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
255 bld.path.find_resource('src/ndn-cxx-config.hpp'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800256
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700257 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
258 bld.path.find_resource('src/version.hpp'))
259
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600260 bld.install_files("${SYSCONFDIR}/ndn", "client.conf.sample")
261
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700262 if bld.env['SPHINX_BUILD']:
263 bld(features="sphinx",
264 builder="man",
265 outdir="docs/manpages",
266 config="docs/conf.py",
267 source=bld.path.ant_glob('docs/manpages/**/*.rst'),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700268 install_path="${MANDIR}/",
269 VERSION=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700270
271def docs(bld):
272 from waflib import Options
273 Options.commands = ['doxygen', 'sphinx'] + Options.commands
274
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000275def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700276 version(bld)
277
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800278 if not bld.env.DOXYGEN:
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200279 Logs.error("ERROR: cannot build documentation (`doxygen' not found in $PATH)")
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700280 else:
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700281 bld(features="subst",
282 name="doxygen-conf",
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700283 source=["docs/doxygen.conf.in",
284 "docs/named_data_theme/named_data_footer-with-analytics.html.in"],
285 target=["docs/doxygen.conf",
286 "docs/named_data_theme/named_data_footer-with-analytics.html"],
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700287 VERSION=VERSION,
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700288 HTML_FOOTER="../build/docs/named_data_theme/named_data_footer-with-analytics.html" \
289 if os.getenv('GOOGLE_ANALYTICS', None) \
290 else "../docs/named_data_theme/named_data_footer.html",
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200291 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ""))
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700292
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700293 bld(features="doxygen",
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700294 doxyfile='docs/doxygen.conf',
295 use="doxygen-conf")
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800296
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700297def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700298 version(bld)
299
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700300 if not bld.env.SPHINX_BUILD:
Davide Pesavento1349d2d2016-08-09 06:43:57 +0200301 bld.fatal("ERROR: cannot build documentation (`sphinx-build' not found in $PATH)")
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700302 else:
303 bld(features="sphinx",
304 outdir="docs",
305 source=bld.path.ant_glob("docs/**/*.rst"),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700306 config="docs/conf.py",
307 VERSION=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700308
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700309def version(ctx):
310 if getattr(Context.g_module, 'VERSION_BASE', None):
311 return
312
313 Context.g_module.VERSION_BASE = Context.g_module.VERSION
314 Context.g_module.VERSION_SPLIT = [v for v in VERSION_BASE.split('.')]
315
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700316 didGetVersion = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700317 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700318 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700319 p = Utils.subprocess.Popen(cmd, stdout=Utils.subprocess.PIPE,
320 stderr=None, stdin=None)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700321 out = str(p.communicate()[0].strip())
322 didGetVersion = (p.returncode == 0 and out != "")
323 if didGetVersion:
324 if out.startswith(GIT_TAG_PREFIX):
325 Context.g_module.VERSION = out[len(GIT_TAG_PREFIX):]
326 else:
327 Context.g_module.VERSION = "%s-commit-%s" % (Context.g_module.VERSION_BASE, out)
328 except OSError:
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700329 pass
330
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700331 versionFile = ctx.path.find_node('VERSION')
332
333 if not didGetVersion and versionFile is not None:
334 try:
335 Context.g_module.VERSION = versionFile.read()
336 return
337 except (OSError, IOError):
338 pass
339
340 # version was obtained from git, update VERSION file if necessary
341 if versionFile is not None:
342 try:
343 version = versionFile.read()
344 if version == Context.g_module.VERSION:
345 return # no need to update
346 except (OSError, IOError):
347 Logs.warn("VERSION file exists, but not readable")
348 else:
349 versionFile = ctx.path.make_node('VERSION')
350
351 if versionFile is None:
352 return
353
354 try:
355 versionFile.write(Context.g_module.VERSION)
356 except (OSError, IOError):
357 Logs.warn("VERSION file is not writeable")
358
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700359def dist(ctx):
360 version(ctx)
361
362def distcheck(ctx):
363 version(ctx)