blob: 2c62c5e112760ac2e0b580f67317d9cfb0ea0d1c [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 Afanasyevd36dd552014-06-30 12:42:46 -07006VERSION = "0.2.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'])
14 opt.load(['default-compiler-flags', 'coverage', 'osx-security', 'pch',
15 'boost', 'openssl', 'cryptopp', 'sqlite3',
16 'doxygen', 'sphinx_build'],
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070017 tooldir=['.waf-tools'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080018
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070019 opt = opt.add_option_group('Library Options')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080020
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070021 opt.add_option('--with-tests', action='store_true', default=False, dest='with_tests',
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080022 help='''build unit tests''')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080023
Yingdi Yue6bfab22014-02-06 16:01:19 -080024 opt.add_option('--without-tools', action='store_false', default=True, dest='with_tools',
25 help='''Do not build tools''')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080026
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -070027 opt.add_option('--with-examples', action='store_true', default=False, dest='with_examples',
28 help='''Build examples''')
29
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070030 opt.add_option('--without-sqlite-locking', action='store_false', default=True,
31 dest='with_sqlite_locking',
32 help='''Disable filesystem locking in sqlite3 database '''
33 '''(use unix-dot locking mechanism instead). '''
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -080034 '''This option may be necessary if home directory is hosted on NFS.''')
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070035 opt.add_option('--without-osx-keychain', action='store_false', default=True,
36 dest='with_osx_keychain',
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -080037 help='''On Darwin, do not use OSX keychain as a default TPM''')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080038
39def configure(conf):
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070040 conf.load(['compiler_cxx', 'gnu_dirs', 'c_osx',
41 'default-compiler-flags', 'osx-security', 'pch',
42 'boost', 'openssl', 'cryptopp', 'sqlite3',
43 'doxygen', 'sphinx_build'])
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080044
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070045 conf.env['WITH_TESTS'] = conf.options.with_tests
46 conf.env['WITH_TOOLS'] = conf.options.with_tools
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -070047 conf.env['WITH_EXAMPLES'] = conf.options.with_examples
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080048
Alexander Afanasyev95de62e2014-04-11 18:26:33 -070049 conf.find_program('sh', var='SH', mandatory=True)
50
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070051 conf.check_cxx(lib='pthread', uselib_store='PTHREAD', define_name='HAVE_PTHREAD',
52 mandatory=False)
53 conf.check_cxx(lib='rt', uselib_store='RT', define_name='HAVE_RT', mandatory=False)
Alexander Afanasyev8b1674a2014-05-15 00:58:43 -070054 conf.check_cxx(cxxflags=['-fPIC'], uselib_store='PIC', mandatory=False)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070055
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070056 conf.check_osx_security(mandatory=False)
Yingdi Yue6bfab22014-02-06 16:01:19 -080057
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070058 conf.check_openssl(mandatory=True)
59 conf.check_sqlite3(mandatory=True)
Alexander Afanasyevfff47d62014-05-11 19:24:46 -070060 conf.check_cryptopp(mandatory=True, use='PTHREAD')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080061
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070062 USED_BOOST_LIBS = ['system', 'filesystem', 'date_time', 'iostreams',
Alexander Afanasyev75088672014-07-14 11:58:30 -070063 'regex', 'program_options', 'chrono', 'random']
Alexander Afanasyevdafdc372014-03-03 15:58:44 +000064 if conf.env['WITH_TESTS']:
65 USED_BOOST_LIBS += ['unit_test_framework']
Yingdi Yuf56c68f2014-04-24 21:50:13 -070066 conf.define('HAVE_TESTS', 1)
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080067
Alexander Afanasyevdafdc372014-03-03 15:58:44 +000068 conf.check_boost(lib=USED_BOOST_LIBS, mandatory=True)
69 if conf.env.BOOST_VERSION_NUMBER < 104800:
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070070 Logs.error("Minimum required boost version is 1.48.0")
71 Logs.error("Please upgrade your distribution or install custom boost libraries" +
Alexander Afanasyevdafdc372014-03-03 15:58:44 +000072 " (http://redmine.named-data.net/projects/nfd/wiki/Boost_FAQ)")
73 return
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080074
Alexander Afanasyev5b60f702014-02-07 12:55:24 -080075 if not conf.options.with_sqlite_locking:
76 conf.define('DISABLE_SQLITE3_FS_LOCKING', 1)
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -080077
Alexander Afanasyev59d67a52014-04-03 16:09:31 -070078 if conf.env['HAVE_OSX_SECURITY']:
Alexander Afanasyev3e08d5d2014-02-12 19:24:28 -080079 conf.env['WITH_OSX_KEYCHAIN'] = conf.options.with_osx_keychain
80 if conf.options.with_osx_keychain:
81 conf.define('WITH_OSX_KEYCHAIN', 1)
82 else:
83 conf.env['WITH_OSX_KEYCHAIN'] = False
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -080084
Alexander Afanasyev1160baa2014-04-10 18:50:29 -070085 # Loading "late" to prevent tests to be compiled with profiling flags
86 conf.load('coverage')
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -080087
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -060088 conf.define('SYSCONFDIR', conf.env['SYSCONFDIR'])
89
Alexander Afanasyev766cea72014-04-24 19:16:42 -070090 conf.write_config_header('src/ndn-cxx-config.hpp', define_prefix='NDN_CXX_')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -080091
Junxiao Shif4f541f2014-11-04 20:58:32 -070092 # disable assertions in release builds
93 # This must appear after write_config_header, because otherwise all projects
94 # using a ndn-cxx release build would be compiled without assertions.
95 if not conf.options.debug:
96 conf.define('NDEBUG', 1)
97
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -070098def build(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -070099 version(bld)
100
101 bld(features="subst",
102 name='version',
103 source='src/version.hpp.in',
104 target='src/version.hpp',
105 install_path=None,
106 VERSION_STRING=VERSION_BASE,
107 VERSION_BUILD=VERSION,
108 VERSION=int(VERSION_SPLIT[0]) * 1000000 +
109 int(VERSION_SPLIT[1]) * 1000 +
110 int(VERSION_SPLIT[2]),
111 VERSION_MAJOR=VERSION_SPLIT[0],
112 VERSION_MINOR=VERSION_SPLIT[1],
113 VERSION_PATCH=VERSION_SPLIT[2],
114 )
115
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700116 libndn_cxx = bld(
Alexander Afanasyev8b1674a2014-05-15 00:58:43 -0700117 features=['pch', 'cxx', 'cxxstlib'], # 'cxxshlib',
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700118 # vnum=VERSION,
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700119 target="ndn-cxx",
120 name="ndn-cxx",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700121 source=bld.path.ant_glob('src/**/*.cpp',
122 excl=['src/**/*-osx.cpp', 'src/**/*-sqlite3.cpp']),
Alexander Afanasyev8b1674a2014-05-15 00:58:43 -0700123 headers='src/common-pch.hpp',
Alexander Afanasyevfc7d33a2014-05-12 18:04:51 -0700124 use='version BOOST OPENSSL CRYPTOPP SQLITE3 RT PIC PTHREAD',
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700125 includes=". src",
126 export_includes="src",
127 install_path='${LIBDIR}',
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800128 )
129
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700130 if bld.env['HAVE_OSX_SECURITY']:
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700131 libndn_cxx.source += bld.path.ant_glob('src/**/*-osx.cpp')
132 libndn_cxx.mac_app = True
133 libndn_cxx.use += " OSX_COREFOUNDATION OSX_SECURITY"
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800134
Alexander Afanasyev1e0a0772014-01-28 20:07:07 -0800135 # In case we want to make it optional later
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700136 libndn_cxx.source += bld.path.ant_glob('src/**/*-sqlite3.cpp')
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800137
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700138 # Prepare flags that should go to pkgconfig file
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800139 pkgconfig_libs = []
140 pkgconfig_ldflags = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800141 pkgconfig_linkflags = []
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800142 pkgconfig_includes = []
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800143 pkgconfig_cxxflags = []
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700144 for lib in Utils.to_list(libndn_cxx.use):
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800145 if bld.env['LIB_%s' % lib]:
146 pkgconfig_libs += Utils.to_list(bld.env['LIB_%s' % lib])
147 if bld.env['LIBPATH_%s' % lib]:
148 pkgconfig_ldflags += Utils.to_list(bld.env['LIBPATH_%s' % lib])
149 if bld.env['INCLUDES_%s' % lib]:
150 pkgconfig_includes += Utils.to_list(bld.env['INCLUDES_%s' % lib])
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800151 if bld.env['LINKFLAGS_%s' % lib]:
152 pkgconfig_linkflags += Utils.to_list(bld.env['LINKFLAGS_%s' % lib])
153 if bld.env['CXXFLAGS_%s' % lib]:
154 pkgconfig_cxxflags += Utils.to_list(bld.env['CXXFLAGS_%s' % lib])
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800155
Alexander Afanasyev84cf4292014-01-29 22:16:27 -0800156 EXTRA_FRAMEWORKS = "";
Alexander Afanasyev59d67a52014-04-03 16:09:31 -0700157 if bld.env['HAVE_OSX_SECURITY']:
Alexander Afanasyev84cf4292014-01-29 22:16:27 -0800158 EXTRA_FRAMEWORKS = "-framework CoreFoundation -framework Security"
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800159
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800160 def uniq(alist):
161 set = {}
162 return [set.setdefault(e,e) for e in alist if e not in set]
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800163
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700164 pkconfig = bld(features="subst",
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700165 source="libndn-cxx.pc.in",
166 target="libndn-cxx.pc",
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700167 install_path="${LIBDIR}/pkgconfig",
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700168 VERSION=VERSION_BASE,
Alexander Afanasyev200dd6f2014-01-28 19:04:25 -0800169
170 # This probably not the right thing to do, but to simplify life of apps
171 # that use the library
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700172 EXTRA_LIBS=" ".join([('-l%s' % i) for i in uniq(pkgconfig_libs)]),
173 EXTRA_LDFLAGS=" ".join([('-L%s' % i) for i in uniq(pkgconfig_ldflags)]),
174 EXTRA_LINKFLAGS=" ".join(uniq(pkgconfig_linkflags)),
175 EXTRA_INCLUDES=" ".join([('-I%s' % i) for i in uniq(pkgconfig_includes)]),
176 EXTRA_CXXFLAGS=" ".join(uniq(pkgconfig_cxxflags)),
177 EXTRA_FRAMEWORKS=EXTRA_FRAMEWORKS,
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800178 )
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800179
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800180 # Unit tests
181 if bld.env['WITH_TESTS']:
Alexander Afanasyevd409d592014-01-28 18:36:38 -0800182 bld.recurse('tests')
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800183
Yingdi Yue6bfab22014-02-06 16:01:19 -0800184 if bld.env['WITH_TOOLS']:
Alexander Afanasyevc8bcd452014-05-12 17:58:47 -0700185 bld.recurse("tools")
186
187 if bld.env['WITH_EXAMPLES']:
Yingdi Yue6bfab22014-02-06 16:01:19 -0800188 bld.recurse("examples")
Alexander Afanasyevf5df8e62014-02-16 19:56:21 -0800189
Alexander Afanasyev19508852014-01-29 01:01:51 -0800190 headers = bld.path.ant_glob(['src/**/*.hpp'])
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700191 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'], headers,
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700192 relative_trick=True, cwd=bld.path.find_node('src'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800193
Alexander Afanasyev766cea72014-04-24 19:16:42 -0700194 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
195 bld.path.find_resource('src/ndn-cxx-config.hpp'))
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800196
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700197 bld.install_files("%s/ndn-cxx" % bld.env['INCLUDEDIR'],
198 bld.path.find_resource('src/version.hpp'))
199
Steve DiBenedettoc07b3a22014-03-19 12:32:52 -0600200 bld.install_files("${SYSCONFDIR}/ndn", "client.conf.sample")
201
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700202 if bld.env['SPHINX_BUILD']:
203 bld(features="sphinx",
204 builder="man",
205 outdir="docs/manpages",
206 config="docs/conf.py",
207 source=bld.path.ant_glob('docs/manpages/**/*.rst'),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700208 install_path="${MANDIR}/",
209 VERSION=VERSION)
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700210
211def docs(bld):
212 from waflib import Options
213 Options.commands = ['doxygen', 'sphinx'] + Options.commands
214
Alexander Afanasyev401a2362014-03-02 00:03:11 +0000215def doxygen(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700216 version(bld)
217
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800218 if not bld.env.DOXYGEN:
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700219 Logs.error("ERROR: cannot build documentation (`doxygen' is not found in $PATH)")
220 else:
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700221 bld(features="subst",
222 name="doxygen-conf",
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700223 source=["docs/doxygen.conf.in",
224 "docs/named_data_theme/named_data_footer-with-analytics.html.in"],
225 target=["docs/doxygen.conf",
226 "docs/named_data_theme/named_data_footer-with-analytics.html"],
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700227 VERSION=VERSION,
Alexander Afanasyev9b0e1142014-05-08 00:17:34 -0700228 HTML_FOOTER="../build/docs/named_data_theme/named_data_footer-with-analytics.html" \
229 if os.getenv('GOOGLE_ANALYTICS', None) \
230 else "../docs/named_data_theme/named_data_footer.html",
231 GOOGLE_ANALYTICS=os.getenv('GOOGLE_ANALYTICS', ""),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700232 )
233
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700234 bld(features="doxygen",
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700235 doxyfile='docs/doxygen.conf',
236 use="doxygen-conf")
Alexander Afanasyeva1ae0a12014-01-28 15:21:02 -0800237
Alexander Afanasyev5e1288e2014-03-28 11:11:48 -0700238def sphinx(bld):
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700239 version(bld)
240
Alexander Afanasyev1160baa2014-04-10 18:50:29 -0700241 if not bld.env.SPHINX_BUILD:
242 bld.fatal("ERROR: cannot build documentation (`sphinx-build' is not found in $PATH)")
Alexander Afanasyev7c6aeb02014-04-10 19:59:19 -0700243 else:
244 bld(features="sphinx",
245 outdir="docs",
246 source=bld.path.ant_glob("docs/**/*.rst"),
Alexander Afanasyeva06fdda2014-04-29 19:15:00 -0700247 config="docs/conf.py",
248 VERSION=VERSION)
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700249
250
251def version(ctx):
252 if getattr(Context.g_module, 'VERSION_BASE', None):
253 return
254
255 Context.g_module.VERSION_BASE = Context.g_module.VERSION
256 Context.g_module.VERSION_SPLIT = [v for v in VERSION_BASE.split('.')]
257
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700258 didGetVersion = False
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700259 try:
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700260 cmd = ['git', 'describe', '--always', '--match', '%s*' % GIT_TAG_PREFIX]
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700261 p = Utils.subprocess.Popen(cmd, stdout=Utils.subprocess.PIPE,
262 stderr=None, stdin=None)
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700263 out = str(p.communicate()[0].strip())
264 didGetVersion = (p.returncode == 0 and out != "")
265 if didGetVersion:
266 if out.startswith(GIT_TAG_PREFIX):
267 Context.g_module.VERSION = out[len(GIT_TAG_PREFIX):]
268 else:
269 Context.g_module.VERSION = "%s-commit-%s" % (Context.g_module.VERSION_BASE, out)
270 except OSError:
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700271 pass
272
Alexander Afanasyev6c632302014-10-31 12:34:11 -0700273 versionFile = ctx.path.find_node('VERSION')
274
275 if not didGetVersion and versionFile is not None:
276 try:
277 Context.g_module.VERSION = versionFile.read()
278 return
279 except (OSError, IOError):
280 pass
281
282 # version was obtained from git, update VERSION file if necessary
283 if versionFile is not None:
284 try:
285 version = versionFile.read()
286 if version == Context.g_module.VERSION:
287 return # no need to update
288 except (OSError, IOError):
289 Logs.warn("VERSION file exists, but not readable")
290 else:
291 versionFile = ctx.path.make_node('VERSION')
292
293 if versionFile is None:
294 return
295
296 try:
297 versionFile.write(Context.g_module.VERSION)
298 except (OSError, IOError):
299 Logs.warn("VERSION file is not writeable")
300
Alexander Afanasyevcfe0b062014-05-08 18:26:50 -0700301def dist(ctx):
302 version(ctx)
303
304def distcheck(ctx):
305 version(ctx)