Throw a specific exception when no WEBVTT header is found.
[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 this_version == '':
30     VERSION = '%sdevel' % last_version[1:].strip()
31 else:
32     VERSION = this_version[1:].strip()
33
34 API_VERSION = '-1.0'
35
36 try:
37     from subprocess import STDOUT, check_output, CalledProcessError
38 except ImportError:
39     # python 2.6 (in Centos 6) doesn't include check_output
40     # monkey patch it in!
41     import subprocess
42     STDOUT = subprocess.STDOUT
43
44     def check_output(*popenargs, **kwargs):
45         if 'stdout' in kwargs:  # pragma: no cover
46             raise ValueError('stdout argument not allowed, '
47                              'it will be overridden.')
48         process = subprocess.Popen(stdout=subprocess.PIPE,
49                                    *popenargs, **kwargs)
50         output, _ = process.communicate()
51         retcode = process.poll()
52         if retcode:
53             cmd = kwargs.get("args")
54             if cmd is None:
55                 cmd = popenargs[0]
56             raise subprocess.CalledProcessError(retcode, cmd,
57                                                 output=output)
58         return output
59     subprocess.check_output = check_output
60
61     # overwrite CalledProcessError due to `output`
62     # keyword not being available (in 2.6)
63     class CalledProcessError(Exception):
64
65         def __init__(self, returncode, cmd, output=None):
66             self.returncode = returncode
67             self.cmd = cmd
68             self.output = output
69
70         def __str__(self):
71             return "Command '%s' returned non-zero exit status %d" % (
72                 self.cmd, self.returncode)
73     subprocess.CalledProcessError = CalledProcessError
74
75 def options(opt):
76     opt.load('compiler_cxx')
77     opt.add_option('--enable-debug', action='store_true', default=False, help='build with debugging information and without optimisation')
78     opt.add_option('--static', action='store_true', default=False, help='build libsub statically and link statically to dcp')
79     opt.add_option('--target-windows', action='store_true', default=False, help='set up to do a cross-compile to make a Windows package')
80     opt.add_option('--disable-tests', action='store_true', default=False, help='disable building of tests')
81
82 def configure(conf):
83     conf.load('compiler_cxx')
84     conf.load('clang_compilation_database', tooldir=['waf-tools'])
85     conf.env.append_value('CXXFLAGS', ['-Wall', '-Wextra', '-D_FILE_OFFSET_BITS=64', '-D__STDC_FORMAT_MACROS', '-std=c++11', '-DBOOST_NO_CXX11_SCOPED_ENUMS'])
86     conf.env.append_value('CXXFLAGS', ['-DLIBSUB_VERSION="%s"' % VERSION])
87
88     conf.env.ENABLE_DEBUG = conf.options.enable_debug
89     conf.env.STATIC = conf.options.static
90     conf.env.TARGET_WINDOWS = conf.options.target_windows
91     conf.env.DISABLE_TESTS = conf.options.disable_tests
92     conf.env.API_VERSION = API_VERSION
93
94     if conf.options.target_windows:
95         conf.env.append_value('CXXFLAGS', '-DLIBSUB_WINDOWS')
96     else:
97         conf.env.append_value('CXXFLAGS', '-DLIBSUB_POSIX')
98
99     if conf.options.enable_debug:
100         conf.env.append_value('CXXFLAGS', '-g')
101     else:
102         conf.env.append_value('CXXFLAGS', '-O3')
103
104     if not conf.env.TARGET_WINDOWS:
105         conf.env.append_value('LINKFLAGS', '-pthread')
106
107     # Disable libxml++ deprecation warnings for now
108     conf.env.append_value('CXXFLAGS', ['-Wno-deprecated-declarations'])
109
110     conf.check_cfg(package='openssl', args='--cflags --libs', uselib_store='OPENSSL', mandatory=True)
111
112     if conf.options.static:
113         conf.check_cfg(package='libdcp-1.0', atleast_version='1.6.2', args='--cflags', uselib_store='DCP', mandatory=True)
114         conf.env.HAVE_DCP = 1
115         conf.env.STLIB_DCP = ['dcp-1.0', 'asdcp-carl', 'kumu-carl', 'openjp2', 'cxml']
116         conf.env.LIB_DCP = ['ssl', 'crypto', 'xmlsec1-openssl', 'xmlsec1', 'glibmm-2.4', 'xml++-2.6', 'xml2', 'dl']
117     else:
118         conf.check_cfg(package='libdcp-1.0', atleast_version='1.6.2', args='--cflags --libs', uselib_store='DCP', mandatory=True)
119
120     conf.env.DEFINES_DCP = [f.replace('\\', '') for f in conf.env.DEFINES_DCP]
121
122     boost_lib_suffix = ''
123     if conf.env.TARGET_WINDOWS:
124         boost_lib_suffix = '-mt'
125
126     conf.check_cxx(fragment="""
127                             #include <boost/version.hpp>\n
128                             #if BOOST_VERSION < 104500\n
129                             #error boost too old\n
130                             #endif\n
131                             int main(void) { return 0; }\n
132                             """,
133                    mandatory=True,
134                    msg='Checking for boost library >= 1.45',
135                    okmsg='yes',
136                    errmsg='too old\nPlease install boost version 1.45 or higher.')
137
138     conf.check_cxx(fragment="""
139                             #include <boost/filesystem.hpp>\n
140                             int main() { boost::filesystem::copy_file ("a", "b"); }\n
141                             """,
142                    msg='Checking for boost filesystem library',
143                    libpath='/usr/local/lib',
144                    lib=['boost_filesystem%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
145                    uselib_store='BOOST_FILESYSTEM')
146
147     # Find the icu- libraries on the system as we need to link to them when we look for boost locale.
148     locale_libs = ['boost_locale%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix]
149     for pkg in subprocess.check_output(['pkg-config', '--list-all']).splitlines():
150         pkg = pkg.decode('utf-8')
151         if pkg.startswith("icu"):
152             for lib in subprocess.check_output(['pkg-config', '--libs-only-l', pkg.split()[0]]).split():
153                 name = lib[2:]
154                 if not name in locale_libs:
155                     locale_libs.append(name.decode('utf-8'))
156
157     conf.check_cxx(fragment="""
158                             #include <boost/locale.hpp>\n
159                             int main() { boost::locale::conv::to_utf<char> ("a", "cp850"); }\n
160                             """,
161                    msg='Checking for boost locale library',
162                    libpath='/usr/local/lib',
163                    lib=locale_libs,
164                    uselib_store='BOOST_LOCALE')
165
166     conf.check_cxx(fragment="""
167                             #include <boost/regex.hpp>\n
168                             int main() { boost::regex re ("foo"); }\n
169                             """,
170                    msg='Checking for boost regex library',
171                    libpath='/usr/local/lib',
172                    lib=['boost_regex%s' % boost_lib_suffix, 'boost_system%s' % boost_lib_suffix],
173                    uselib_store='BOOST_REGEX')
174
175     if not conf.env.DISABLE_TESTS:
176         conf.recurse('test')
177
178 def build(bld):
179     create_version_cc(bld, VERSION)
180
181     if bld.env.TARGET_WINDOWS:
182         boost_lib_suffix = '-mt'
183     else:
184         boost_lib_suffix = ''
185
186     bld(source='libsub%s.pc.in' % bld.env.API_VERSION,
187         version=VERSION,
188         includedir='%s/include/libsub%s' % (bld.env.PREFIX, bld.env.API_VERSION),
189         libs="-L${libdir} -lsub%s -lboost_system%s" % (bld.env.API_VERSION, boost_lib_suffix),
190         install_path='${LIBDIR}/pkgconfig')
191
192     bld.recurse('src')
193     if not bld.env.DISABLE_TESTS:
194         bld.recurse('test')
195     bld.recurse('tools')
196
197     bld.add_post_fun(post)
198
199 def dist(ctx):
200     ctx.excl = 'TODO core *~ .git build .waf* .lock* doc/*~ src/*~ test/ref/*~ __pycache__ GPATH GRTAGS GSYMS GTAGS'
201
202 def create_version_cc(bld, version):
203     if os.path.exists('.git'):
204         cmd = "LANG= git log --abbrev HEAD^..HEAD ."
205         output = subprocess.Popen(cmd, shell=True, stderr=subprocess.STDOUT, stdout=subprocess.PIPE).communicate()[0].splitlines()
206         o = output[0].decode('utf-8')
207         commit = o.replace ("commit ", "")[0:10]
208     else:
209         commit = "release"
210
211     try:
212         text =  '#include "version.h"\n'
213         text += 'char const * sub::git_commit = \"%s\";\n' % commit
214         text += 'char const * sub::version = \"%s\";\n' % version
215         if bld.env.ENABLE_DEBUG:
216             debug_string = 'true'
217         else:
218             debug_string = 'false'
219         text += 'bool const built_with_debug = %s;\n' % debug_string
220         print('Writing version information to src/version.cc')
221         o = open('src/version.cc', 'w')
222         o.write(text)
223         o.close()
224     except IOError:
225         print('Could not open src/version.cc for writing\n')
226         sys.exit(-1)
227
228 def post(ctx):
229     if ctx.cmd == 'install':
230         ctx.exec_command('/sbin/ldconfig')
231
232 def tags(bld):
233     os.system('etags src/*.cc src/*.h')