source: wscript @ 50d7afe

feature/cnn_orgfeature/crepe_org
Last change on this file since 50d7afe was 9d609355, checked in by Paul Brossier <piem@piem.org>, 6 years ago

[waf] check for errno.h
  • Property mode set to 100644
File size: 26.5 KB
Line 
1#! /usr/bin/python
2#
3# usage:
4#   $ python waf --help
5#
6# example:
7#   $ ./waf distclean configure build
8#
9# Note: aubio uses the waf build system, which relies on Python. Provided you
10# have Python installed, you do *not* need to install anything to build aubio.
11# For more info about waf, see http://code.google.com/p/waf/ .
12
13import sys
14
15APPNAME = 'aubio'
16
17from this_version import *
18
19VERSION = get_aubio_version()
20LIB_VERSION = get_libaubio_version()
21
22top = '.'
23out = 'build'
24
25def add_option_enable_disable(ctx, name, default = None,
26        help_str = None, help_disable_str = None):
27    if help_str == None:
28        help_str = 'enable ' + name + ' support'
29    if help_disable_str == None:
30        help_disable_str = 'do not ' + help_str
31    ctx.add_option('--enable-' + name, action = 'store_true',
32            default = default,
33            dest = 'enable_' + name.replace('-','_'),
34            help = help_str)
35    ctx.add_option('--disable-' + name, action = 'store_false',
36            #default = default,
37            dest = 'enable_' + name.replace('-','_'),
38            help = help_disable_str )
39
40def options(ctx):
41    ctx.add_option('--build-type', action = 'store',
42            default = "release",
43            choices = ('debug', 'release'),
44            dest = 'build_type',
45            help = 'whether to compile with (--build-type=release)' \
46                    ' or without (--build-type=debug)' \
47                    ' compiler opimizations [default: release]')
48    add_option_enable_disable(ctx, 'fftw3f', default = False,
49            help_str = 'compile with fftw3f instead of ooura (recommended)',
50            help_disable_str = 'do not compile with fftw3f')
51    add_option_enable_disable(ctx, 'fftw3', default = False,
52            help_str = 'compile with fftw3 instead of ooura',
53            help_disable_str = 'do not compile with fftw3')
54    add_option_enable_disable(ctx, 'intelipp', default = False,
55            help_str = 'use Intel IPP libraries (auto)',
56            help_disable_str = 'do not use Intel IPP libraries')
57    add_option_enable_disable(ctx, 'complex', default = False,
58            help_str ='compile with C99 complex',
59            help_disable_str = 'do not use C99 complex (default)' )
60    add_option_enable_disable(ctx, 'jack', default = None,
61            help_str = 'compile with jack (auto)',
62            help_disable_str = 'disable jack support')
63    add_option_enable_disable(ctx, 'sndfile', default = None,
64            help_str = 'compile with sndfile (auto)',
65            help_disable_str = 'disable sndfile')
66    add_option_enable_disable(ctx, 'avcodec', default = None,
67            help_str = 'compile with libavcodec (auto)',
68            help_disable_str = 'disable libavcodec')
69    add_option_enable_disable(ctx, 'samplerate', default = None,
70            help_str = 'compile with samplerate (auto)',
71            help_disable_str = 'disable samplerate')
72    add_option_enable_disable(ctx, 'memcpy', default = True,
73            help_str = 'use memcpy hacks (default)',
74            help_disable_str = 'do not use memcpy hacks')
75    add_option_enable_disable(ctx, 'double', default = False,
76            help_str = 'compile in double precision mode',
77            help_disable_str = 'compile in single precision mode (default)')
78    add_option_enable_disable(ctx, 'fat', default = False,
79            help_str = 'build fat binaries (darwin only)',
80            help_disable_str = 'do not build fat binaries (default)')
81    add_option_enable_disable(ctx, 'accelerate', default = None,
82            help_str = 'use Accelerate framework (darwin only) (auto)',
83            help_disable_str = 'do not use Accelerate framework')
84    add_option_enable_disable(ctx, 'apple-audio', default = None,
85            help_str = 'use CoreFoundation (darwin only) (auto)',
86            help_disable_str = 'do not use CoreFoundation framework')
87    add_option_enable_disable(ctx, 'blas', default = False,
88            help_str = 'use BLAS acceleration library (no)',
89            help_disable_str = 'do not use BLAS library')
90    add_option_enable_disable(ctx, 'atlas', default = False,
91            help_str = 'use ATLAS acceleration library (no)',
92            help_disable_str = 'do not use ATLAS library')
93    add_option_enable_disable(ctx, 'wavread', default = True,
94            help_str = 'compile with source_wavread (default)',
95            help_disable_str = 'do not compile source_wavread')
96    add_option_enable_disable(ctx, 'wavwrite', default = True,
97            help_str = 'compile with source_wavwrite (default)',
98            help_disable_str = 'do not compile source_wavwrite')
99
100    add_option_enable_disable(ctx, 'docs', default = None,
101            help_str = 'build documentation (auto)',
102            help_disable_str = 'do not build documentation')
103
104    add_option_enable_disable(ctx, 'tests', default = True,
105            help_str = 'build tests (true)',
106            help_disable_str = 'do not build or run tests')
107
108    add_option_enable_disable(ctx, 'examples', default = True,
109            help_str = 'build examples (true)',
110            help_disable_str = 'do not build examples')
111
112    ctx.add_option('--with-target-platform', type='string',
113            help='set target platform for cross-compilation',
114            dest='target_platform')
115
116    ctx.load('compiler_c')
117    ctx.load('waf_unit_test')
118    ctx.load('gnu_dirs')
119    ctx.load('waf_gensyms', tooldir='.')
120
121def configure(ctx):
122    target_platform = sys.platform
123    if ctx.options.target_platform:
124        target_platform = ctx.options.target_platform
125
126    from waflib import Options
127
128    if target_platform=='emscripten':
129        ctx.load('c_emscripten')
130    else:
131        ctx.load('compiler_c')
132
133    ctx.load('waf_unit_test')
134    ctx.load('gnu_dirs')
135    ctx.load('waf_gensyms', tooldir='.')
136
137    # check for common headers
138    ctx.check(header_name='stdlib.h')
139    ctx.check(header_name='stdio.h')
140    ctx.check(header_name='math.h')
141    ctx.check(header_name='string.h')
142    ctx.check(header_name='errno.h')
143    ctx.check(header_name='limits.h')
144    ctx.check(header_name='stdarg.h')
145    ctx.check(header_name='getopt.h', mandatory = False)
146    ctx.check(header_name='unistd.h', mandatory = False)
147
148    ctx.env['DEST_OS'] = target_platform
149
150    if ctx.options.build_type == "debug":
151        ctx.define('DEBUG', 1)
152    else:
153        ctx.define('NDEBUG', 1)
154
155    if ctx.env.CC_NAME != 'msvc':
156        if ctx.options.build_type == "debug":
157            # no optimization in debug mode
158            ctx.env.prepend_value('CFLAGS', ['-O0'])
159        else:
160            if target_platform == 'emscripten':
161                # -Oz for small js file generation
162                ctx.env.prepend_value('CFLAGS', ['-Oz'])
163            else:
164                # default to -O2 in release mode
165                ctx.env.prepend_value('CFLAGS', ['-O2'])
166        # enable debug symbols and configure warnings
167        ctx.env.prepend_value('CFLAGS', ['-g', '-Wall', '-Wextra'])
168    else:
169        # enable debug symbols
170        ctx.env.CFLAGS += ['/Z7']
171        # /FS flag available in msvc >= 12 (2013)
172        if 'MSVC_VERSION' in ctx.env and ctx.env.MSVC_VERSION >= 12:
173            ctx.env.CFLAGS += ['/FS']
174        ctx.env.LINKFLAGS += ['/DEBUG', '/INCREMENTAL:NO']
175        # configure warnings
176        ctx.env.CFLAGS += ['/W4', '/D_CRT_SECURE_NO_WARNINGS']
177        # ignore "possible loss of data" warnings
178        ctx.env.CFLAGS += ['/wd4305', '/wd4244', '/wd4245', '/wd4267']
179        # ignore "unreferenced formal parameter" warnings
180        ctx.env.CFLAGS += ['/wd4100']
181        # set optimization level and runtime libs
182        if (ctx.options.build_type == "release"):
183            ctx.env.CFLAGS += ['/Ox']
184            ctx.env.CFLAGS += ['/MD']
185        else:
186            assert(ctx.options.build_type == "debug")
187            ctx.env.CFLAGS += ['/MDd']
188
189    ctx.check_cc(lib='m', uselib_store='M', mandatory=False)
190
191    if target_platform not in ['win32', 'win64']:
192        ctx.env.CFLAGS += ['-fPIC']
193    else:
194        ctx.define('HAVE_WIN_HACKS', 1)
195        ctx.env['cshlib_PATTERN'] = 'lib%s.dll'
196
197    if target_platform == 'darwin' and ctx.options.enable_fat:
198        ctx.env.CFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
199        ctx.env.LINKFLAGS += ['-arch', 'i386', '-arch', 'x86_64']
200        MINSDKVER="10.4"
201        ctx.env.CFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
202        ctx.env.LINKFLAGS += [ '-mmacosx-version-min=' + MINSDKVER ]
203
204    if target_platform in [ 'darwin', 'ios', 'iosimulator']:
205        if (ctx.options.enable_apple_audio != False):
206            ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
207            ctx.define('HAVE_SOURCE_APPLE_AUDIO', 1)
208            ctx.define('HAVE_SINK_APPLE_AUDIO', 1)
209            ctx.msg('Checking for AudioToolbox.framework', 'yes')
210        else:
211            ctx.msg('Checking for AudioToolbox.framework', 'no (disabled)',
212                    color = 'YELLOW')
213        if (ctx.options.enable_accelerate != False):
214            ctx.define('HAVE_ACCELERATE', 1)
215            ctx.env.FRAMEWORK += ['Accelerate']
216            ctx.msg('Checking for Accelerate framework', 'yes')
217        else:
218            ctx.msg('Checking for Accelerate framework', 'no (disabled)',
219                    color = 'YELLOW')
220
221    if target_platform in [ 'ios', 'iosimulator' ]:
222        MINSDKVER="6.1"
223        ctx.env.CFLAGS += ['-std=c99']
224        if (ctx.options.enable_apple_audio != False):
225            ctx.define('HAVE_AUDIO_UNIT', 1)
226            #ctx.env.FRAMEWORK += ['CoreFoundation', 'AudioToolbox']
227        if target_platform == 'ios':
228            DEVROOT = "/Applications/Xcode.app/Contents"
229            DEVROOT += "/Developer/Platforms/iPhoneOS.platform/Developer"
230            SDKROOT = "%(DEVROOT)s/SDKs/iPhoneOS.sdk" % locals()
231            ctx.env.CFLAGS += [ '-fembed-bitcode' ]
232            ctx.env.CFLAGS += [ '-arch', 'arm64' ]
233            ctx.env.CFLAGS += [ '-arch', 'armv7' ]
234            ctx.env.CFLAGS += [ '-arch', 'armv7s' ]
235            ctx.env.LINKFLAGS += [ '-arch', 'arm64' ]
236            ctx.env.LINKFLAGS += ['-arch', 'armv7']
237            ctx.env.LINKFLAGS += ['-arch', 'armv7s']
238            ctx.env.CFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
239            ctx.env.LINKFLAGS += [ '-miphoneos-version-min=' + MINSDKVER ]
240        else:
241            DEVROOT = "/Applications/Xcode.app/Contents"
242            DEVROOT += "/Developer/Platforms/iPhoneSimulator.platform/Developer"
243            SDKROOT = "%(DEVROOT)s/SDKs/iPhoneSimulator.sdk" % locals()
244            ctx.env.CFLAGS += [ '-arch', 'i386' ]
245            ctx.env.CFLAGS += [ '-arch', 'x86_64' ]
246            ctx.env.LINKFLAGS += ['-arch', 'i386']
247            ctx.env.LINKFLAGS += ['-arch', 'x86_64']
248            ctx.env.CFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
249            ctx.env.LINKFLAGS += [ '-mios-simulator-version-min=' + MINSDKVER ]
250        ctx.env.CFLAGS += [ '-isysroot' , SDKROOT]
251        ctx.env.LINKFLAGS += [ '-isysroot' , SDKROOT]
252
253    if target_platform == 'emscripten':
254        if ctx.options.build_type == "debug":
255            ctx.env.cshlib_PATTERN = '%s.js'
256            ctx.env.LINKFLAGS += ['-s','ASSERTIONS=2']
257            ctx.env.LINKFLAGS += ['-s','SAFE_HEAP=1']
258            ctx.env.LINKFLAGS += ['-s','ALIASING_FUNCTION_POINTERS=0']
259            ctx.env.LINKFLAGS += ['-O0']
260        else:
261            ctx.env.LINKFLAGS += ['-Oz']
262            ctx.env.cshlib_PATTERN = '%s.min.js'
263
264        # doesnt ship file system support in lib
265        ctx.env.LINKFLAGS_cshlib += ['-s', 'NO_FILESYSTEM=1']
266        # put memory file inside generated js files for easier portability
267        ctx.env.LINKFLAGS += ['--memory-init-file', '0']
268        ctx.env.cprogram_PATTERN = "%s.js"
269        ctx.env.cstlib_PATTERN = '%s.a'
270
271        # tell emscripten functions we want to expose
272        from python.lib.gen_external import get_c_declarations, \
273                get_cpp_objects_from_c_declarations, \
274                get_all_func_names_from_lib, \
275                generate_lib_from_c_declarations
276        # emscripten can't use double
277        c_decls = get_c_declarations(usedouble=False)
278        objects = list(get_cpp_objects_from_c_declarations(c_decls))
279        # ensure that aubio structs are exported
280        objects += ['fvec_t', 'cvec_t', 'fmat_t']
281        lib = generate_lib_from_c_declarations(objects, c_decls)
282        exported_funcnames = get_all_func_names_from_lib(lib)
283        c_mangled_names = ['_' + s for s in exported_funcnames]
284        ctx.env.LINKFLAGS_cshlib += ['-s',
285                'EXPORTED_FUNCTIONS=%s' % c_mangled_names]
286
287    # check support for C99 __VA_ARGS__ macros
288    check_c99_varargs = '''
289#include <stdio.h>
290#define AUBIO_ERR(...) fprintf(stderr, __VA_ARGS__)
291'''
292
293    if ctx.check_cc(fragment = check_c99_varargs,
294            type='cstlib',
295            msg = 'Checking for C99 __VA_ARGS__ macro',
296            mandatory = False):
297        ctx.define('HAVE_C99_VARARGS_MACROS', 1)
298
299    # show a message about enable_double status
300    if (ctx.options.enable_double == True):
301        ctx.msg('Checking for size of smpl_t', 'double')
302        ctx.msg('Checking for size of lsmp_t', 'long double')
303    else:
304        ctx.msg('Checking for size of smpl_t', 'float')
305        ctx.msg('Checking for size of lsmp_t', 'double')
306
307    # optionally use complex.h
308    if (ctx.options.enable_complex == True):
309        ctx.check(header_name='complex.h')
310    else:
311        ctx.msg('Checking if complex.h is enabled', 'no')
312
313    # check for Intel IPP
314    if (ctx.options.enable_intelipp != False):
315        has_ipp_headers = ctx.check(header_name=['ippcore.h', 'ippvm.h',
316            'ipps.h'], mandatory = False)
317        has_ipp_libs = ctx.check(lib=['ippcore', 'ippvm', 'ipps'],
318                uselib_store='INTEL_IPP', mandatory = False)
319        if (has_ipp_headers and has_ipp_libs):
320            ctx.msg('Checking if Intel IPP is available', 'yes')
321            ctx.define('HAVE_INTEL_IPP', 1)
322            if ctx.env.CC_NAME == 'msvc':
323                # force linking multi-threaded static IPP libraries on Windows
324                # with msvc
325                ctx.define('_IPP_SEQUENTIAL_STATIC', 1)
326        else:
327            ctx.msg('Checking if Intel IPP is available', 'no')
328
329    # check for fftw3
330    if (ctx.options.enable_fftw3 != False or ctx.options.enable_fftw3f != False):
331        # one of fftwf or fftw3f
332        if (ctx.options.enable_fftw3f != False):
333            ctx.check_cfg(package = 'fftw3f',
334                    args = '--cflags --libs fftw3f >= 3.0.0',
335                    mandatory = ctx.options.enable_fftw3f)
336            if (ctx.options.enable_double == True):
337                ctx.msg('Warning',
338                        'fftw3f enabled, but compiling in double precision!')
339        else:
340            # fftw3f disabled, take most sensible one according to
341            # enable_double
342            if (ctx.options.enable_double == True):
343                ctx.check_cfg(package = 'fftw3',
344                        args = '--cflags --libs fftw3 >= 3.0.0.',
345                        mandatory = ctx.options.enable_fftw3)
346            else:
347                ctx.check_cfg(package = 'fftw3f',
348                        args = '--cflags --libs fftw3f >= 3.0.0',
349                        mandatory = ctx.options.enable_fftw3)
350        ctx.define('HAVE_FFTW3', 1)
351
352    # fftw not enabled, use vDSP, intelIPP or ooura
353    if 'HAVE_FFTW3F' in ctx.env.define_key:
354        ctx.msg('Checking for FFT implementation', 'fftw3f')
355    elif 'HAVE_FFTW3' in ctx.env.define_key:
356        ctx.msg('Checking for FFT implementation', 'fftw3')
357    elif 'HAVE_ACCELERATE' in ctx.env.define_key:
358        ctx.msg('Checking for FFT implementation', 'vDSP')
359    elif 'HAVE_INTEL_IPP' in ctx.env.define_key:
360        ctx.msg('Checking for FFT implementation', 'Intel IPP')
361    else:
362        ctx.msg('Checking for FFT implementation', 'ooura')
363
364    # check for libsndfile
365    if (ctx.options.enable_sndfile != False):
366        ctx.check_cfg(package = 'sndfile',
367                args = '--cflags --libs sndfile >= 1.0.4',
368                mandatory = ctx.options.enable_sndfile)
369
370    # check for libsamplerate
371    if (ctx.options.enable_double):
372        if (ctx.options.enable_samplerate):
373            ctx.fatal("Could not compile aubio in double precision mode' \
374                    ' with libsamplerate")
375        else:
376            ctx.options.enable_samplerate = False
377            ctx.msg('Checking if using samplerate',
378                    'no (disabled in double precision mode)', color = 'YELLOW')
379    if (ctx.options.enable_samplerate != False):
380        ctx.check_cfg(package = 'samplerate',
381                args = '--cflags --libs samplerate >= 0.0.15',
382                mandatory = ctx.options.enable_samplerate)
383
384    # check for jack
385    if (ctx.options.enable_jack != False):
386        ctx.check_cfg(package = 'jack',
387                args = '--cflags --libs',
388                mandatory = ctx.options.enable_jack)
389
390    # check for libav
391    if (ctx.options.enable_avcodec != False):
392        ctx.check_cfg(package = 'libavcodec',
393                args = '--cflags --libs libavcodec >= 54.35.0',
394                uselib_store = 'AVCODEC',
395                mandatory = ctx.options.enable_avcodec)
396        ctx.check_cfg(package = 'libavformat',
397                args = '--cflags --libs libavformat >= 52.3.0',
398                uselib_store = 'AVFORMAT',
399                mandatory = ctx.options.enable_avcodec)
400        ctx.check_cfg(package = 'libavutil',
401                args = '--cflags --libs libavutil >= 52.3.0',
402                uselib_store = 'AVUTIL',
403                mandatory = ctx.options.enable_avcodec)
404        ctx.check_cfg(package = 'libswresample',
405                args = '--cflags --libs libswresample >= 1.2.0',
406                uselib_store = 'SWRESAMPLE',
407                mandatory = False)
408        if 'HAVE_SWRESAMPLE' not in ctx.env:
409            ctx.check_cfg(package = 'libavresample',
410                    args = '--cflags --libs libavresample >= 1.0.1',
411                    uselib_store = 'AVRESAMPLE',
412                    mandatory = False)
413
414        msg_check = 'Checking for all libav libraries'
415        if 'HAVE_AVCODEC' not in ctx.env:
416            ctx.msg(msg_check, 'not found (missing avcodec)', color = 'YELLOW')
417        elif 'HAVE_AVFORMAT' not in ctx.env:
418            ctx.msg(msg_check, 'not found (missing avformat)', color = 'YELLOW')
419        elif 'HAVE_AVUTIL' not in ctx.env:
420            ctx.msg(msg_check, 'not found (missing avutil)', color = 'YELLOW')
421        elif 'HAVE_SWRESAMPLE' not in ctx.env \
422                and 'HAVE_AVRESAMPLE' not in ctx.env:
423            resample_missing = 'not found (avresample or swresample required)'
424            ctx.msg(msg_check, resample_missing, color = 'YELLOW')
425        else:
426            ctx.msg(msg_check, 'yes')
427            if 'HAVE_SWRESAMPLE' in ctx.env:
428                ctx.define('HAVE_SWRESAMPLE', 1)
429            elif 'HAVE_AVRESAMPLE' in ctx.env:
430                ctx.define('HAVE_AVRESAMPLE', 1)
431            ctx.define('HAVE_LIBAV', 1)
432
433    if (ctx.options.enable_wavread != False):
434        ctx.define('HAVE_WAVREAD', 1)
435    ctx.msg('Checking if using source_wavread',
436            ctx.options.enable_wavread and 'yes' or 'no')
437    if (ctx.options.enable_wavwrite!= False):
438        ctx.define('HAVE_WAVWRITE', 1)
439    ctx.msg('Checking if using sink_wavwrite',
440            ctx.options.enable_wavwrite and 'yes' or 'no')
441
442    # use BLAS/ATLAS
443    if (ctx.options.enable_blas != False):
444        ctx.check_cfg(package = 'blas',
445                args = '--cflags --libs',
446                uselib_store='BLAS', mandatory = ctx.options.enable_blas)
447        if 'LIB_BLAS' in ctx.env:
448            blas_header = None
449            if ctx.env['LIBPATH_BLAS']:
450                if 'atlas' in ctx.env['LIBPATH_BLAS'][0]:
451                    blas_header = 'atlas/cblas.h'
452                elif 'openblas' in ctx.env['LIBPATH_BLAS'][0]:
453                    blas_header = 'openblas/cblas.h'
454            else:
455                blas_header = 'cblas.h'
456            ctx.check(header_name = blas_header, mandatory =
457                    ctx.options.enable_atlas)
458
459    # use memcpy hacks
460    if (ctx.options.enable_memcpy == True):
461        ctx.define('HAVE_MEMCPY_HACKS', 1)
462
463    # write configuration header
464    ctx.write_config_header('src/config.h')
465
466    # the following defines will be passed as arguments to the compiler
467    # instead of being written to src/config.h
468    ctx.define('HAVE_CONFIG_H', 1)
469
470    # add some defines used in examples
471    ctx.define('AUBIO_PREFIX', ctx.env['PREFIX'])
472    ctx.define('PACKAGE', APPNAME)
473
474    # double precision mode
475    if (ctx.options.enable_double == True):
476        ctx.define('HAVE_AUBIO_DOUBLE', 1)
477
478    if (ctx.options.enable_docs != False):
479        # check if txt2man is installed, optional
480        try:
481          ctx.find_program('txt2man', var='TXT2MAN')
482        except ctx.errors.ConfigurationError:
483          ctx.to_log('txt2man was not found (ignoring)')
484
485        # check if doxygen is installed, optional
486        try:
487          ctx.find_program('doxygen', var='DOXYGEN')
488        except ctx.errors.ConfigurationError:
489          ctx.to_log('doxygen was not found (ignoring)')
490
491        # check if sphinx-build is installed, optional
492        try:
493          ctx.find_program('sphinx-build', var='SPHINX')
494        except ctx.errors.ConfigurationError:
495          ctx.to_log('sphinx-build was not found (ignoring)')
496
497def build(bld):
498    bld.env['VERSION'] = VERSION
499    bld.env['LIB_VERSION'] = LIB_VERSION
500
501    # main source
502    bld.recurse('src')
503
504    # add sub directories
505    if bld.env['DEST_OS'] not in ['ios', 'iosimulator', 'android']:
506        if bld.env['DEST_OS']=='emscripten' and not bld.options.testcmd:
507            bld.options.testcmd = 'node %s'
508        if bld.options.enable_examples:
509            bld.recurse('examples')
510        if bld.options.enable_tests:
511            bld.recurse('tests')
512
513    # pkg-config template
514    bld( source = 'aubio.pc.in' )
515
516    # documentation
517    txt2man(bld)
518    doxygen(bld)
519    sphinx(bld)
520
521    from waflib.Tools import waf_unit_test
522    bld.add_post_fun(waf_unit_test.summary)
523    bld.add_post_fun(waf_unit_test.set_exit_code)
524
525def txt2man(bld):
526    # build manpages from txt files using txt2man
527    if bld.env['TXT2MAN']:
528        from waflib import TaskGen
529        if 'MANDIR' not in bld.env:
530            bld.env['MANDIR'] = bld.env['DATAROOTDIR'] + '/man'
531        bld.env.VERSION = VERSION
532        rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`'
533        rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}'
534        rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual'
535        rule_str += ' -s 1 ${SRC} > ${TGT}'
536        TaskGen.declare_chain(
537                name      = 'txt2man',
538                rule      = rule_str,
539                ext_in    = '.txt',
540                ext_out   = '.1',
541                reentrant = False,
542                install_path =  '${MANDIR}/man1',
543                )
544        bld( source = bld.path.ant_glob('doc/*.txt') )
545
546def doxygen(bld):
547    # build documentation from source files using doxygen
548    if bld.env['DOXYGEN']:
549        bld.env.VERSION = VERSION
550        rule = '( cat ${SRC[0]} && echo PROJECT_NUMBER=${VERSION}'
551        rule += ' && echo OUTPUT_DIRECTORY=%s && echo HTML_OUTPUT=%s )'
552        rule += ' | doxygen - > /dev/null'
553        rule %= (os.path.abspath(out), 'api')
554        bld( name = 'doxygen', rule = rule,
555                source = ['doc/web.cfg']
556                    + bld.path.find_dir('src').ant_glob('**/*.h'),
557                target = bld.path.find_or_declare('api/index.html'),
558                cwd = bld.path.find_dir('doc'))
559        # evaluate nodes lazily to prevent build directory traversal warnings
560        bld.install_files('${DATAROOTDIR}/doc/libaubio-doc/api',
561                bld.path.find_or_declare('api').ant_glob('**/*',
562                    generator=True), cwd=bld.path.find_or_declare('api'),
563                relative_trick=True)
564
565def sphinx(bld):
566    # build documentation from source files using sphinx-build
567    try:
568        import aubio
569        has_aubio = True
570    except ImportError:
571        from waflib import Logs
572        Logs.pprint('YELLOW', "Sphinx manual: install aubio first")
573        has_aubio = False
574    if bld.env['SPHINX'] and has_aubio:
575        bld.env.VERSION = VERSION
576        rule = '${SPHINX} -b html -D release=${VERSION}' \
577                ' -D version=${VERSION} -W -a -q' \
578                ' -d %s ' % os.path.join(os.path.abspath(out), 'doctrees')
579        rule += ' . %s' % os.path.join(os.path.abspath(out), 'manual')
580        bld( name = 'sphinx', rule = rule,
581                cwd = bld.path.find_dir('doc'),
582                source = bld.path.find_dir('doc').ant_glob('*.rst'),
583                target = bld.path.find_or_declare('manual/index.html'))
584        # evaluate nodes lazily to prevent build directory traversal warnings
585        bld.install_files('${DATAROOTDIR}/doc/libaubio-doc/manual',
586                bld.path.find_or_declare('manual').ant_glob('**/*',
587                    generator=True), cwd=bld.path.find_or_declare('manual'),
588                relative_trick=True)
589
590# register the previous rules as build rules
591from waflib.Build import BuildContext
592
593class build_txt2man(BuildContext):
594    cmd = 'txt2man'
595    fun = 'txt2man'
596
597class build_manpages(BuildContext):
598    cmd = 'manpages'
599    fun = 'txt2man'
600
601class build_sphinx(BuildContext):
602    cmd = 'sphinx'
603    fun = 'sphinx'
604
605class build_doxygen(BuildContext):
606    cmd = 'doxygen'
607    fun = 'doxygen'
608
609def shutdown(bld):
610    from waflib import Logs
611    if bld.options.target_platform in ['ios', 'iosimulator']:
612        msg ='building for %s, contact the author for a commercial license' \
613                % bld.options.target_platform
614        Logs.pprint('RED', msg)
615        msg ='   Paul Brossier <piem@aubio.org>'
616        Logs.pprint('RED', msg)
617
618def dist(ctx):
619    ctx.excl  = ' **/.waf*'
620    ctx.excl += ' **/.git*'
621    ctx.excl += ' **/*~ **/*.pyc **/*.swp **/*.swo **/*.swn **/.lock-w*'
622    ctx.excl += ' **/build/*'
623    ctx.excl += ' doc/_build'
624    ctx.excl += ' python/demos_*'
625    ctx.excl += ' **/python/gen **/python/build **/python/dist'
626    ctx.excl += ' **/python/ext/config.h'
627    ctx.excl += ' **/python/lib/aubio/_aubio.so'
628    ctx.excl += ' **.egg-info'
629    ctx.excl += ' **/.eggs'
630    ctx.excl += ' **/.pytest_cache'
631    ctx.excl += ' **/.cache'
632    ctx.excl += ' **/**.zip **/**.tar.bz2'
633    ctx.excl += ' **.tar.bz2'
634    ctx.excl += ' **/doc/full/* **/doc/web/*'
635    ctx.excl += ' **/doc/full.cfg'
636    ctx.excl += ' **/python/*.db'
637    ctx.excl += ' **/python.old/*'
638    ctx.excl += ' **/python/*/*.old'
639    ctx.excl += ' **/python/lib/aubio/*.so'
640    ctx.excl += ' **/python/tests/sounds'
641    ctx.excl += ' **/**.asc'
642    ctx.excl += ' **/dist*'
643    ctx.excl += ' **/.DS_Store'
644    ctx.excl += ' **/.travis.yml'
645    ctx.excl += ' **/.landscape.yml'
646    ctx.excl += ' **/.appveyor.yml'
647    ctx.excl += ' **/.circleci/*'
648    ctx.excl += ' **/azure-pipelines.yml'
649    ctx.excl += ' **/.coverage*'
Note: See TracBrowser for help on using the repository browser.