wscript

   1 #! /usr/bin/python3
   2 # encoding: utf-8
   3 #
   4 # Copyright (C) 2015-2018 Karl Linden <karl.j.linden@gmail.com>
   5 # Copyleft (C) 2008-2022 Nedko Arnaudov
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 2 of the License.
  10 #
  11 # This program 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 this program; if not, write to the Free Software
  18 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 #
  20
  21 from __future__ import print_function
  22
  23 import os
  24 import shutil
  25 import sys
  26
  27 from waflib import Logs, Options, TaskGen
  28 from waflib.Build import BuildContext, CleanContext, InstallContext, UninstallContext
  29
  30 # see also common/JackConstants.h
  31 VERSION = '2.22'
  32 APPNAME = 'jack'
  33 JACK_API_VERSION = '0.1.0'
  34
  35 # these variables are mandatory ('/' are converted automatically)
  36 top = '.'
  37 out = 'build'
  38
  39 def display_feature(conf, msg, build):
  40     if build:
  41         conf.msg(msg, 'yes', color='GREEN')
  42     else:
  43         conf.msg(msg, 'no', color='YELLOW')
  44
  45
  46 def options(opt):
  47     # options provided by the modules
  48     opt.load('compiler_cxx')
  49     opt.load('compiler_c')
  50     opt.load('autooptions')
  51
  52     # install directories
  53     opt.add_option(
  54         '--htmldir',
  55         type='string',
  56         default=None,
  57         help='HTML documentation directory [Default: <prefix>/share/jack-audio-connection-kit/reference/html/',
  58     )
  59     opt.add_option('--libdir', type='string', help='Library directory [Default: <prefix>/lib]')
  60     opt.add_option('--pkgconfigdir', type='string', help='pkg-config file directory [Default: <libdir>/pkgconfig]')
  61     opt.add_option('--mandir', type='string', help='Manpage directory [Default: <prefix>/share/man/man1]')
  62
  63     # options affecting binaries
  64     opt.add_option(
  65         '--platform',
  66         type='string',
  67         default=sys.platform,
  68         help='Target platform for cross-compiling, e.g. cygwin or win32',
  69     )
  70     opt.add_option('--debug', action='store_true', default=False, dest='debug', help='Build debuggable binaries')
  71
  72     #opt.set_auto_options_define('HAVE_%s')
  73     #opt.set_auto_options_style('yesno_and_hack')
  74
  75     # options with third party dependencies
  76     #doxygen = opt.add_auto_option(
  77     #        'doxygen',
  78     #        help='Build doxygen documentation',
  79     #        conf_dest='BUILD_DOXYGEN_DOCS',
  80     #        default=False)
  81     #doxygen.find_program('doxygen')
  82
  83     # dbus options
  84     opt.recurse('dbus')
  85
  86     # this must be called before the configure phase
  87     #opt.apply_auto_options_hack()
  88
  89
  90 def detect_platform(conf):
  91     # GNU/kFreeBSD and GNU/Hurd are treated as Linux
  92     platforms = [
  93         # ('KEY, 'Human readable name', ['strings', 'to', 'check', 'for'])
  94         ('IS_LINUX',   'Linux',   ['gnu0', 'gnukfreebsd', 'linux', 'posix']),
  95         ('IS_FREEBSD', 'FreeBSD', ['freebsd']),
  96         ('IS_MACOSX',  'MacOS X', ['darwin']),
  97         ('IS_SUN',     'SunOS',   ['sunos']),
  98         ('IS_WINDOWS', 'Windows', ['cygwin', 'msys', 'win32'])
  99     ]
 100
 101     for key, name, strings in platforms:
 102         conf.env[key] = False
 103
 104     conf.start_msg('Checking platform')
 105     platform = Options.options.platform
 106     for key, name, strings in platforms:
 107         for s in strings:
 108             if platform.startswith(s):
 109                 conf.env[key] = True
 110                 conf.end_msg(name, color='CYAN')
 111                 break
 112
 113
 114 def configure(conf):
 115     conf.load('compiler_cxx')
 116     conf.load('compiler_c')
 117
 118     detect_platform(conf)
 119
 120     conf.check_cfg(package='jackserver', uselib_store='JACKSERVER', args=["--cflags", "--libs"])
 121
 122     conf.check_cfg(package='expat', args='--cflags --libs')
 123
 124     conf.env.append_unique('CFLAGS', '-Wall')
 125     conf.env.append_unique('CXXFLAGS', ['-Wall', '-Wno-invalid-offsetof'])
 126     conf.env.append_unique('CXXFLAGS', '-std=gnu++11')
 127
 128     if conf.env['IS_FREEBSD']:
 129         conf.check(lib='execinfo', uselib='EXECINFO', define_name='EXECINFO')
 130         conf.check_cfg(package='libsysinfo', args='--cflags --libs')
 131
 132     if not conf.env['IS_MACOSX']:
 133         conf.env.append_unique('LDFLAGS', '-Wl,--no-undefined')
 134     else:
 135         conf.check(lib='aften', uselib='AFTEN', define_name='AFTEN')
 136         conf.check_cxx(
 137             fragment=''
 138             + '#include <aften/aften.h>\n'
 139             + 'int\n'
 140             + 'main(void)\n'
 141             + '{\n'
 142             + 'AftenContext fAftenContext;\n'
 143             + 'aften_set_defaults(&fAftenContext);\n'
 144             + 'unsigned char *fb;\n'
 145             + 'float *buf=new float[10];\n'
 146             + 'int res = aften_encode_frame(&fAftenContext, fb, buf, 1);\n'
 147             + '}\n',
 148             lib='aften',
 149             msg='Checking for aften_encode_frame()',
 150             define_name='HAVE_AFTEN_NEW_API',
 151             mandatory=False)
 152
 153         # TODO
 154         conf.env.append_unique('CXXFLAGS', '-Wno-deprecated-register')
 155
 156     conf.load('autooptions')
 157
 158     conf.recurse('dbus')
 159
 160     conf.env['LIB_PTHREAD'] = ['pthread']
 161     conf.env['LIB_DL'] = ['dl']
 162     conf.env['LIB_RT'] = ['rt']
 163     conf.env['LIB_M'] = ['m']
 164     conf.env['LIB_STDC++'] = ['stdc++']
 165     conf.env['JACK_API_VERSION'] = JACK_API_VERSION
 166     conf.env['JACK_VERSION'] = VERSION
 167
 168     conf.env['BINDIR'] = conf.env['PREFIX'] + '/bin'
 169
 170     if Options.options.htmldir:
 171         conf.env['HTMLDIR'] = Options.options.htmldir
 172     else:
 173         # set to None here so that the doxygen code can find out the highest
 174         # directory to remove upon install
 175         conf.env['HTMLDIR'] = None
 176
 177     if Options.options.libdir:
 178         conf.env['LIBDIR'] = Options.options.libdir
 179     else:
 180         conf.env['LIBDIR'] = conf.env['PREFIX'] + '/lib'
 181
 182     if Options.options.pkgconfigdir:
 183         conf.env['PKGCONFDIR'] = Options.options.pkgconfigdir
 184     else:
 185         conf.env['PKGCONFDIR'] = conf.env['LIBDIR'] + '/pkgconfig'
 186
 187     if Options.options.mandir:
 188         conf.env['MANDIR'] = Options.options.mandir
 189     else:
 190         conf.env['MANDIR'] = conf.env['PREFIX'] + '/share/man/man1'
 191
 192     if conf.env['BUILD_DEBUG']:
 193         conf.env.append_unique('CXXFLAGS', '-g')
 194         conf.env.append_unique('CFLAGS', '-g')
 195         conf.env.append_unique('LINKFLAGS', '-g')
 196
 197     conf.write_config_header('config.h', remove=False)
 198
 199     print()
 200     print('LADI JACK ' + VERSION)
 201
 202     conf.msg('Install prefix', conf.env['PREFIX'], color='CYAN')
 203     conf.msg('Library directory', conf.all_envs['']['LIBDIR'], color='CYAN')
 204     display_feature(conf, 'Build debuggable binaries', conf.env['BUILD_DEBUG'])
 205
 206     tool_flags = [
 207         ('C compiler flags',   ['CFLAGS', 'CPPFLAGS']),
 208         ('C++ compiler flags', ['CXXFLAGS', 'CPPFLAGS']),
 209         ('Linker flags',       ['LINKFLAGS', 'LDFLAGS'])
 210     ]
 211     for name, vars in tool_flags:
 212         flags = []
 213         for var in vars:
 214             flags += conf.all_envs[''][var]
 215         conf.msg(name, repr(flags), color='NORMAL')
 216
 217     #conf.summarize_auto_options()
 218
 219     conf.msg('D-Bus service install directory', conf.env['DBUS_SERVICES_DIR'], color='CYAN')
 220
 221     if conf.env['DBUS_SERVICES_DIR'] != conf.env['DBUS_SERVICES_DIR_REAL']:
 222         print()
 223         print(Logs.colors.RED + 'WARNING: D-Bus session services directory as reported by pkg-config is')
 224         print(Logs.colors.RED + 'WARNING:', end=' ')
 225         print(Logs.colors.CYAN + conf.env['DBUS_SERVICES_DIR_REAL'])
 226         print(Logs.colors.RED + 'WARNING: but service file will be installed in')
 227         print(Logs.colors.RED + 'WARNING:', end=' ')
 228         print(Logs.colors.CYAN + conf.env['DBUS_SERVICES_DIR'])
 229         print(
 230             Logs.colors.RED + 'WARNING: You may need to adjust your D-Bus configuration after installing jackdbus'
 231             )
 232         print('WARNING: You can override dbus service install directory')
 233         print('WARNING: with --enable-pkg-config-dbus-service-dir option to this script')
 234         print(Logs.colors.NORMAL, end=' ')
 235     print()
 236
 237
 238 def build(bld):
 239     # process subfolders from here
 240
 241     if bld.env['IS_LINUX'] or bld.env['IS_FREEBSD']:
 242         bld.recurse('man')
 243     bld.recurse('dbus')
 244
 245     if bld.env['BUILD_DOXYGEN_DOCS']:
 246         html_build_dir = bld.path.find_or_declare('html').abspath()
 247
 248         bld(
 249             features='subst',
 250             source='doxyfile.in',
 251             target='doxyfile',
 252             HTML_BUILD_DIR=html_build_dir,
 253             SRCDIR=bld.srcnode.abspath(),
 254             VERSION=VERSION
 255         )
 256
 257         # There are two reasons for logging to doxygen.log and using it as
 258         # target in the build rule (rather than html_build_dir):
 259         # (1) reduce the noise when running the build
 260         # (2) waf has a regular file to check for a timestamp. If the directory
 261         #     is used instead waf will rebuild the doxygen target (even upon
 262         #     install).
 263         def doxygen(task):
 264             doxyfile = task.inputs[0].abspath()
 265             logfile = task.outputs[0].abspath()
 266             cmd = '%s %s &> %s' % (task.env['DOXYGEN'][0], doxyfile, logfile)
 267             return task.exec_command(cmd)
 268
 269         bld(
 270             rule=doxygen,
 271             source='doxyfile',
 272             target='doxygen.log'
 273         )
 274
 275         # Determine where to install HTML documentation. Since share_dir is the
 276         # highest directory the uninstall routine should remove, there is no
 277         # better candidate for share_dir, but the requested HTML directory if
 278         # --htmldir is given.
 279         if bld.env['HTMLDIR']:
 280             html_install_dir = bld.options.destdir + bld.env['HTMLDIR']
 281             share_dir = html_install_dir
 282         else:
 283             share_dir = bld.options.destdir + bld.env['PREFIX'] + '/share/jack-audio-connection-kit'
 284             html_install_dir = share_dir + '/reference/html/'
 285
 286         if bld.cmd == 'install':
 287             if os.path.isdir(html_install_dir):
 288                 Logs.pprint('CYAN', 'Removing old doxygen documentation installation...')
 289                 shutil.rmtree(html_install_dir)
 290                 Logs.pprint('CYAN', 'Removing old doxygen documentation installation done.')
 291             Logs.pprint('CYAN', 'Installing doxygen documentation...')
 292             shutil.copytree(html_build_dir, html_install_dir)
 293             Logs.pprint('CYAN', 'Installing doxygen documentation done.')
 294         elif bld.cmd == 'uninstall':
 295             Logs.pprint('CYAN', 'Uninstalling doxygen documentation...')
 296             if os.path.isdir(share_dir):
 297                 shutil.rmtree(share_dir)
 298             Logs.pprint('CYAN', 'Uninstalling doxygen documentation done.')
 299         elif bld.cmd == 'clean':
 300             if os.access(html_build_dir, os.R_OK):
 301                 Logs.pprint('CYAN', 'Removing doxygen generated documentation...')
 302                 shutil.rmtree(html_build_dir)
 303                 Logs.pprint('CYAN', 'Removing doxygen generated documentation done.')
 304
 305
 306 @TaskGen.extension('.mm')
 307 def mm_hook(self, node):
 308     """Alias .mm files to be compiled the same as .cpp files, gcc will do the right thing."""
 309     return self.create_compiled_task('cxx', node)