Missing import.
[libsub.git] / wscript
1 #
2 #    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
3 #
4 #    This file is part of libsub.
5 #
6 #    libsub is free software; you can redistribute it and/or modify
7 #    it under the terms of the GNU General Public License as published by
8 #    the Free Software Foundation; either version 2 of the License, or
9 #    (at your option) any later version.
10 #
11 #    libsub is distributed in the hope that it will be useful,
12 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 #    GNU General Public License for more details.
15 #
16 #    You should have received a copy of the GNU General Public License
17 #    along with libsub.  If not, see <http://www.gnu.org/licenses/>.
18
19 import subprocess
20 import os
21 import shlex
22 from waflib import Context
23
24 APPNAME = 'libsub'
25
26 this_version = subprocess.Popen(shlex.split('git tag -l --points-at HEAD'), stdout=subprocess.PIPE).communicate()[0]
27 last_version = subprocess.Popen(shlex.split('git describe --tags --abbrev=0'), stdout=subprocess.PIPE).communicate()[0]
28
29 if isinstance(this_version, bytes):
30     this_version = this_version.decode('UTF-8')
31 if isinstance(last_version, bytes):
32     last_version = last_version.decode('UTF-8')
33
34 if this_version == '':
35     VERSION = '%sdevel' % last_version[1:].strip()
36 else:
37     VERSION = this_version[1:].strip()
38
39 API_VERSION = '-1.0'
40
41 try:
42     from subprocess import STDOUT, check_output, CalledProcessError
43 except ImportError:
44     # python 2.6 (in Centos 6) doesn't include check_output
45     # monkey patch it in!
46     import subprocess
47     STDOUT = subprocess.STDOUT
48
49     def check_output(*popenargs, **kwargs):
50         if 'stdout' in kwargs:  # pragma: no cover
51             raise ValueError('stdout argument not allowed, '
52                              'it will be overridden.')
53         process = subprocess.Popen(stdout=subprocess.PIPE,
54                                    *popenargs, **kwargs)
55         output, _ = process.communicate()
56         retcode = process.poll()
57         if retcode:
58             cmd = kwargs.get("args")
59             if cmd is None:
60                 cmd = popenargs[0]
61             raise subprocess.CalledProcessError(retcode, cmd,
62                                                 output=output)
63         return output
64     subprocess.check_output = check_output
65
66     # overwrite CalledProcessError due to `output`
67     # keyword not being available (in 2.6)
68     class CalledProcessError(Exception):
69
70         def __init__(self, returncode, cmd, output=None):
71             self.returncode = returncode
72             self.cmd = cmd
73             self.output = output
74
75         def __str__(self):
76             return "Command '%s' returned non-zero exit status %d" % (
77                 self.cmd, self.returncode)
78     subprocess.CalledProcessError = CalledProcessError
79
80 def options(opt):
81     opt.load('compiler_cxx')
82     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
83     opt.add_option('--static', action='store_true', default=False, help='build libsub statically and link statically to cxml and dcp')
84     opt.add_option('--target-windows', action='store_true', default=False, help='set up to do a cross-compile to make a Windows package')
85     opt.add_option('--disable-tests', action='store_true', default=False, help='disable building of tests')
86     opt.add_option('--force-cpp11', action='store_true', default=False, help='force use of C++11')
87
88 def configure(conf):
89     conf.load('compiler_cxx')
90     conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS'])
91     if conf.options.force_cpp11:
92         conf.env.append_value('CXXFLAGS', ['-std=c++11', '-DBOOST_NO_CXX11_SCOPED_ENUMS'])
93     conf.env.append_value('CXXFLAGS', ['-DLIBSUB_VERSION="%s"' % VERSION])
94
95     conf.env.ENABLE_DEBUG = conf.options.enable_debug
96     conf.env.STATIC = conf.options.static
97     conf.env.TARGET_WINDOWS = conf.options.target_windows
98     conf.env.DISABLE_TESTS = conf.options.disable_tests
99     conf.env.API_VERSION = API_VERSION
100
101     if conf.options.enable_debug:
102         conf.env.append_value('CXXFLAGS', '-g')
103     else:
104         conf.env.append_value('CXXFLAGS', '-O3')
105
106     # Disable libxml++ deprecation warnings for now
107     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
108
109     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
110
111     if conf.options.static:
112         conf.check_cfg(package='libcxml', atleast_version='0.14.0', args='--cflags', uselib_store='CXML', mandatory=True)
113         conf.env.HAVE_CXML = 1
114         conf.env.LIB_CXML = ['glibmm-2.4', 'glib-2.0', 'pcre', 'sigc-2.0', 'rt', 'xml++-2.6', 'xml2', 'pthread', 'lzma', 'dl', 'z']
115         conf.env.STLIB_CXML = ['cxml']
116         conf.check_cfg(package='libdcp-1.0', atleast_version='1.4.4', args='--cflags', uselib_store='DCP', mandatory=True)
117         conf.env.HAVE_DCP = 1
118         conf.env.STLIB_DCP = ['dcp-1.0', 'asdcp-cth', 'kumu-cth', 'openjp2']
119         conf.env.LIB_DCP = ['ssl', 'crypto', 'xmlsec1-openssl', 'xmlsec1']
120     else:
121         conf.check_cfg(package='libcxml', atleast_version='0.15.2', args='--cflags --libs', uselib_store='CXML', mandatory=True)
122         conf.check_cfg(package='libdcp-1.0', atleast_version='1.4.4', args='--cflags --libs', uselib_store='DCP', mandatory=True)
123
124     conf.env.DEFINES_DCP = [f.replace('\\', '') for f in conf.env.DEFINES_DCP]
125
126     boost_lib_suffix = ''
127     if conf.env.TARGET_WINDOWS:
128         boost_lib_suffix = '-mt'
129
130     conf.check_cxx(fragment="""
131                             #include <boost/version.hpp>\n
132                             #if BOOST_VERSION < 104500\n
133                             #error boost too old\n
134                             #endif\n
135                             int main(void) { return 0; }\n
136                             """,
137                    mandatory=True,
138                    msg='Checking for boost library >= 1.45',
139                    okmsg='yes',
140                    errmsg='too old\nPlease install boost version 1.45 or higher.')
141
142     conf.check_cxx(fragment="""
143                             #include <boost/filesystem.hpp>\n
144                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
145                             """,
146                    msg='Checking for boost filesystem library',
147                    libpath='/usr/local/lib',
148                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
149                    uselib_store='BOOST_FILESYSTEM')
150
151     # Find the icu- libraries on the system as we need to link to them when we look for boost locale.
152     locale_libs = ['boost_locale%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix]
153     for pkg in subprocess.check_output(['pkg-config', '--list-all']).splitlines():
154         pkg = pkg.decode('utf-8')
155         if pkg.startswith("icu"):
156             for lib in subprocess.check_output(['pkg-config', '--libs-only-l', pkg.split()[0]]).split():
157                 name = lib[2:]
158                 if not name in locale_libs:
159                     locale_libs.append(name.decode('utf-8'))
160
161     conf.check_cxx(fragment="""
162                             #include <boost/locale.hpp>\n
163                             int main() { boost::locale::conv::to_utf<char> ("a", "cp850"); }\n
164                             """,
165                    msg='Checking for boost locale library',
166                    libpath='/usr/local/lib',
167                    lib=locale_libs,
168                    uselib_store='BOOST_LOCALE')
169
170     conf.check_cxx(fragment="""
171                             #include <boost/regex.hpp>\n
172                             int main() { boost::regex re ("foo"); }\n
173                             """,
174                    msg='Checking for boost regex library',
175                    libpath='/usr/local/lib',
176                    lib=['boost_regex%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
177                    uselib_store='BOOST_REGEX')
178
179     if not conf.env.DISABLE_TESTS:
180         conf.recurse('test')
181
182 def build(bld):
183     create_version_cc(bld, VERSION)
184
185     if bld.env.TARGET_WINDOWS:
186         boost_lib_suffix = '-mt'
187     else:
188         boost_lib_suffix = ''
189
190     bld(source='libsub%s.pc.in' % bld.env.API_VERSION,
191         version=VERSION,
192         includedir='%s/include/libsub%s' % (bld.env.PREFIX, bld.env.API_VERSION),
193         libs="-L${libdir} -lsub%s -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix),
194         install_path='${LIBDIR}/pkgconfig')
195
196     bld.recurse('src')
197     if not bld.env.DISABLE_TESTS:
198         bld.recurse('test')
199     bld.recurse('tools')
200
201     bld.add_post_fun(post)
202
203 def dist(ctx):
204     ctx.excl = 'TODO core *~ .git build .waf* .lock* doc/*~ src/*~ test/ref/*~ __pycache__ GPATH GRTAGS GSYMS GTAGS'
205
206 def create_version_cc(bld, version):
207     if os.path.exists('.git'):
208         cmd = "LANG= git log --abbrev HEAD^..HEAD ."
209         output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
210         o = output[0].decode('utf-8')
211         commit = o.replace ("commit ", "")[0:10]
212     else:
213         commit = "release"
214
215     try:
216         text =  '#include "version.h"\n'
217         text += 'char const * sub::git_commit = \"%s\";\n' % commit
218         text += 'char const * sub::version = \"%s\";\n' % version
219         if bld.env.ENABLE_DEBUG:
220             debug_string = 'true'
221         else:
222             debug_string = 'false'
223         text += 'bool const built_with_debug = %s;\n' % debug_string
224         print('Writing version information to src/version.cc')
225         o = open('src/version.cc', 'w')
226         o.write(text)
227         o.close()
228     except IOError:
229         print('Could not open src/version.cc for writing\n')
230         sys.exit(-1)
231
232 def post(ctx):
233     if ctx.cmd == 'install':
234         ctx.exec_command('/sbin/ldconfig')
235
236 def tags(bld):
237     os.system('etags src/*.cc src/*.h')