autowaf.py

   1 #!/usr/bin/env python
   2 # Waf utilities for easily building standard unixey packages/libraries
   3 # Licensed under the GNU GPL v2 or later, see COPYING file for details.
   4 # Copyright (C) 2008 Dave Robillard
   5 # Copyright (C) 2008 Nedko Arnaudov
   6
   7 import os
   8 import misc
   9 import Configure
  10 import Options
  11 import Utils
  12 import sys
  13 from TaskGen import feature, before, after
  14
  15 global g_is_child
  16 g_is_child = False
  17
  18 # Only run autowaf hooks once (even if sub projects call several times)
  19 global g_step
  20 g_step = 0
  21
  22 # Compute dependencies globally
  23 #import preproc
  24 #preproc.go_absolute = True
  25
  26 @feature('cc', 'cxx')
  27 @after('apply_lib_vars')
  28 @before('apply_obj_vars_cc', 'apply_obj_vars_cxx')
  29 def include_config_h(self):
  30         self.env.append_value('INC_PATHS', self.bld.srcnode)
  31
  32 def set_options(opt):
  33         "Add standard autowaf options if they havn't been added yet"
  34         global g_step
  35         if g_step > 0:
  36                 return
  37         opt.tool_options('compiler_cc')
  38         opt.tool_options('compiler_cxx')
  39         opt.add_option('--debug', action='store_true', default=False, dest='debug',
  40                         help="Build debuggable binaries [Default: False]")
  41         opt.add_option('--strict', action='store_true', default=False, dest='strict',
  42                         help="Use strict compiler flags and show all warnings [Default: False]")
  43         opt.add_option('--build-docs', action='store_true', default=False, dest='build_docs',
  44                         help="Build documentation - requires doxygen [Default: False]")
  45         opt.add_option('--bundle', action='store_true', default=False,
  46                         help="Build a self-contained bundle [Default: False]")
  47         opt.add_option('--bindir', type='string',
  48                         help="Executable programs [Default: PREFIX/bin]")
  49         opt.add_option('--libdir', type='string',
  50                         help="Libraries [Default: PREFIX/lib]")
  51         opt.add_option('--includedir', type='string',
  52                         help="Header files [Default: PREFIX/include]")
  53         opt.add_option('--datadir', type='string',
  54                         help="Shared data [Default: PREFIX/share]")
  55         opt.add_option('--mandir', type='string',
  56                         help="Manual pages [Default: DATADIR/man]")
  57         opt.add_option('--htmldir', type='string',
  58                         help="HTML documentation [Default: DATADIR/doc/PACKAGE]")
  59         opt.add_option('--lv2-user', action='store_true', default=False, dest='lv2_user',
  60                         help="Install LV2 bundles to user-local location [Default: False]")
  61         if sys.platform == "darwin":
  62                 opt.add_option('--lv2dir', type='string',
  63                                 help="LV2 bundles [Default: /Library/Audio/Plug-Ins/LV2]")
  64         else:
  65                 opt.add_option('--lv2dir', type='string',
  66                                 help="LV2 bundles [Default: LIBDIR/lv2]")
  67         g_step = 1
  68
  69 def check_header(conf, name, define='', mandatory=False):
  70         "Check for a header iff it hasn't been checked for yet"
  71         if type(conf.env['AUTOWAF_HEADERS']) != dict:
  72                 conf.env['AUTOWAF_HEADERS'] = {}
  73
  74         checked = conf.env['AUTOWAF_HEADERS']
  75         if not name in checked:
  76                 checked[name] = True
  77                 if define != '':
  78                         conf.check(header_name=name, define_name=define, mandatory=mandatory)
  79                 else:
  80                         conf.check(header_name=name, mandatory=mandatory)
  81
  82 def check_tool(conf, name):
  83         "Check for a tool iff it hasn't been checked for yet"
  84         if type(conf.env['AUTOWAF_TOOLS']) != dict:
  85                 conf.env['AUTOWAF_TOOLS'] = {}
  86
  87         checked = conf.env['AUTOWAF_TOOLS']
  88         if not name in checked:
  89                 conf.check_tool(name)
  90                 checked[name] = True
  91
  92 def nameify(name):
  93         return name.replace('/', '_').replace('++', 'PP').replace('-', '_')
  94
  95 def check_pkg(conf, name, **args):
  96         "Check for a package iff it hasn't been checked for yet"
  97         var_name = 'HAVE_' + nameify(args['uselib_store'])
  98         check = not var_name in conf.env
  99         if not check and 'atleast_version' in args:
 100                 # Re-check if version is newer than previous check
 101                 checked_version = conf.env['VERSION_' + name]
 102                 if checked_version and checked_version < args['atleast_version']:
 103                         check = True;
 104         if check:
 105                 conf.check_cfg(package=name, args="--cflags --libs", **args)
 106                 found = bool(conf.env[var_name])
 107                 if found:
 108                         conf.define(var_name, int(found))
 109                         if 'atleast_version' in args:
 110                                 conf.env['VERSION_' + name] = args['atleast_version']
 111                 else:
 112                         conf.undefine(var_name)
 113                         if args['mandatory'] == True:
 114                                 conf.fatal("Required package " + name + " not found")
 115
 116 def chop_prefix(conf, var):
 117         name = conf.env[var][len(conf.env['PREFIX']):]
 118         if len(name) > 0 and name[0] == '/':
 119                 name = name[1:]
 120         if name == "":
 121                 name = "/"
 122         return name;
 123
 124 def configure(conf):
 125         global g_step
 126         if g_step > 1:
 127                 return
 128         def append_cxx_flags(val):
 129                 conf.env.append_value('CCFLAGS', val)
 130                 conf.env.append_value('CXXFLAGS', val)
 131         conf.line_just = 42
 132         check_tool(conf, 'misc')
 133         check_tool(conf, 'compiler_cc')
 134         check_tool(conf, 'compiler_cxx')
 135         conf.env['BUILD_DOCS'] = Options.options.build_docs
 136         conf.env['DEBUG'] = Options.options.debug
 137         conf.env['PREFIX'] = os.path.abspath(os.path.expanduser(os.path.normpath(conf.env['PREFIX'])))
 138         if Options.options.bundle:
 139                 conf.env['BUNDLE'] = True
 140                 conf.define('BUNDLE', 1)
 141                 conf.env['BINDIR'] = conf.env['PREFIX']
 142                 conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/Headers/'
 143                 conf.env['LIBDIR'] = conf.env['PREFIX'] + '/Libraries/'
 144                 conf.env['DATADIR'] = conf.env['PREFIX'] + '/Resources/'
 145                 conf.env['HTMLDIR'] = conf.env['PREFIX'] + '/Resources/Documentation/'
 146                 conf.env['MANDIR'] = conf.env['PREFIX'] + '/Resources/Man/'
 147                 conf.env['LV2DIR'] = conf.env['PREFIX'] + '/PlugIns/'
 148         else:
 149                 conf.env['BUNDLE'] = False
 150                 if Options.options.bindir:
 151                         conf.env['BINDIR'] = Options.options.bindir
 152                 else:
 153                         conf.env['BINDIR'] = conf.env['PREFIX'] + '/bin/'
 154                 if Options.options.includedir:
 155                         conf.env['INCLUDEDIR'] = Options.options.includedir
 156                 else:
 157                         conf.env['INCLUDEDIR'] = conf.env['PREFIX'] + '/include/'
 158                 if Options.options.libdir:
 159                         conf.env['LIBDIR'] = Options.options.libdir
 160                 else:
 161                         conf.env['LIBDIR'] = conf.env['PREFIX'] + '/lib/'
 162                 if Options.options.datadir:
 163                         conf.env['DATADIR'] = Options.options.datadir
 164                 else:
 165                         conf.env['DATADIR'] = conf.env['PREFIX'] + '/share/'
 166                 if Options.options.htmldir:
 167                         conf.env['HTMLDIR'] = Options.options.htmldir
 168                 else:
 169                         conf.env['HTMLDIR'] = conf.env['DATADIR'] + 'doc/' + Utils.g_module.APPNAME + '/'
 170                 if Options.options.mandir:
 171                         conf.env['MANDIR'] = Options.options.mandir
 172                 else:
 173                         conf.env['MANDIR'] = conf.env['DATADIR'] + 'man/'
 174                 if Options.options.lv2dir:
 175                         conf.env['LV2DIR'] = Options.options.lv2dir
 176                 else:
 177                         if Options.options.lv2_user:
 178                                 if sys.platform == "darwin":
 179                                         conf.env['LV2DIR'] = os.getenv('HOME') + '/Library/Audio/Plug-Ins/LV2'
 180                                 else:
 181                                         conf.env['LV2DIR'] = os.getenv('HOME') + '/.lv2'
 182                         else:
 183                                 if sys.platform == "darwin":
 184                                         conf.env['LV2DIR'] = '/Library/Audio/Plug-Ins/LV2'
 185                                 else:
 186                                         conf.env['LV2DIR'] = conf.env['LIBDIR'] + 'lv2/'
 187
 188         conf.env['BINDIRNAME'] = chop_prefix(conf, 'BINDIR')
 189         conf.env['LIBDIRNAME'] = chop_prefix(conf, 'LIBDIR')
 190         conf.env['DATADIRNAME'] = chop_prefix(conf, 'DATADIR')
 191         conf.env['LV2DIRNAME'] = chop_prefix(conf, 'LV2DIR')
 192
 193         if Options.options.debug:
 194                 conf.env['CCFLAGS'] = '-O0 -g -std=c99'
 195                 conf.env['CXXFLAGS'] = '-O0 -g -ansi'
 196         if Options.options.strict:
 197                 conf.env['CCFLAGS'] = '-O0 -g -std=c99 -pedantic'
 198                 append_cxx_flags('-Wall -Wextra -Wno-unused-parameter')
 199                 conf.env.append_value('CXXFLAGS', '-Woverloaded-virtual')
 200         append_cxx_flags('-fPIC -DPIC')
 201         g_step = 2
 202
 203 def set_local_lib(conf, name, has_objects):
 204         conf.define('HAVE_' + nameify(name.upper()), 1)
 205         if has_objects:
 206                 if type(conf.env['AUTOWAF_LOCAL_LIBS']) != dict:
 207                         conf.env['AUTOWAF_LOCAL_LIBS'] = {}
 208                 conf.env['AUTOWAF_LOCAL_LIBS'][name.lower()] = True
 209         else:
 210                 if type(conf.env['AUTOWAF_LOCAL_HEADERS']) != dict:
 211                         conf.env['AUTOWAF_LOCAL_HEADERS'] = {}
 212                 conf.env['AUTOWAF_LOCAL_HEADERS'][name.lower()] = True
 213
 214 def use_lib(bld, obj, libs):
 215         abssrcdir = os.path.abspath('.')
 216         libs_list = libs.split()
 217         for l in libs_list:
 218                 in_headers = l.lower() in bld.env['AUTOWAF_LOCAL_HEADERS']
 219                 in_libs    = l.lower() in bld.env['AUTOWAF_LOCAL_LIBS']
 220                 if in_libs:
 221                         if hasattr(obj, 'uselib_local'):
 222                                 obj.uselib_local += ' lib' + l.lower() + ' '
 223                         else:
 224                                 obj.uselib_local = 'lib' + l.lower() + ' '
 225
 226                 if in_headers or in_libs:
 227                         inc_flag = '-iquote ' + abssrcdir + '/' + l.lower()
 228                         for f in ['CCFLAGS', 'CXXFLAGS']:
 229                                 if not inc_flag in bld.env[f]:
 230                                         bld.env.prepend_value(f, inc_flag)
 231                 else:
 232                         if hasattr(obj, 'uselib'):
 233                                 obj.uselib += ' ' + l
 234                         else:
 235                                 obj.uselib = l
 236
 237
 238 def display_header(title):
 239         Utils.pprint('BOLD', title)
 240
 241 def display_msg(conf, msg, status = None, color = None):
 242         color = 'CYAN'
 243         if type(status) == bool and status or status == "True":
 244                 color = 'GREEN'
 245         elif type(status) == bool and not status or status == "False":
 246                 color = 'YELLOW'
 247         Utils.pprint('NORMAL', "%s :" % msg.ljust(conf.line_just), sep='')
 248         Utils.pprint(color, status)
 249
 250 def print_summary(conf):
 251         global g_step
 252         if g_step > 2:
 253                 print
 254                 return
 255         e = conf.env
 256         print
 257         display_header('Global configuration')
 258         display_msg(conf, "Install prefix", conf.env['PREFIX'])
 259         display_msg(conf, "Debuggable build", str(conf.env['DEBUG']))
 260         display_msg(conf, "Build documentation", str(conf.env['BUILD_DOCS']))
 261         print
 262         g_step = 3
 263
 264 def link_flags(env, lib):
 265         return ' '.join(map(lambda x: env['LIB_ST'] % x, env['LIB_' + lib]))
 266
 267 def compile_flags(env, lib):
 268         return ' '.join(map(lambda x: env['CPPPATH_ST'] % x, env['CPPPATH_' + lib]))
 269
 270 def set_recursive():
 271         global g_is_child
 272         g_is_child = True
 273
 274 def is_child():
 275         global g_is_child
 276         return g_is_child
 277
 278 # Pkg-config file
 279 def build_pc(bld, name, version, libs):
 280         '''Build a pkg-config file for a library.
 281         name    -- uppercase variable name     (e.g. 'SOMENAME')
 282         version -- version string              (e.g. '1.2.3')
 283         libs    -- string/list of dependencies (e.g. 'LIBFOO GLIB')
 284         '''
 285
 286         obj              = bld.new_task_gen('subst')
 287         obj.source       = name.lower() + '.pc.in'
 288         obj.target       = name.lower() + '.pc'
 289         obj.install_path = '${PREFIX}/${LIBDIRNAME}/pkgconfig'
 290         pkg_prefix       = bld.env['PREFIX']
 291         if pkg_prefix[-1] == '/':
 292                 pkg_prefix = pkg_prefix[:-1]
 293         obj.dict = {
 294                 'prefix'           : pkg_prefix,
 295                 'exec_prefix'      : '${prefix}',
 296                 'libdir'           : '${exec_prefix}/lib',
 297                 'includedir'       : '${prefix}/include',
 298                 name + '_VERSION'  : version,
 299         }
 300         if type(libs) != list:
 301                 libs = libs.split()
 302         for i in libs:
 303                 obj.dict[i + '_LIBS']   = link_flags(bld.env, i)
 304                 obj.dict[i + '_CFLAGS'] = compile_flags(bld.env, i)
 305
 306 # Doxygen API documentation
 307 def build_dox(bld, name, version, srcdir, blddir):
 308         if not bld.env['BUILD_DOCS']:
 309                 return
 310         obj = bld.new_task_gen('subst')
 311         obj.source = 'doc/reference.doxygen.in'
 312         obj.target = 'doc/reference.doxygen'
 313         if is_child():
 314                 src_dir = srcdir + '/' + name.lower()
 315                 doc_dir = blddir + '/default/' + name.lower() + '/doc'
 316         else:
 317                 src_dir = srcdir
 318                 doc_dir = blddir + '/default/doc'
 319         obj.dict = {
 320                 name + '_VERSION' : version,
 321                 name + '_SRCDIR'  : os.path.abspath(src_dir),
 322                 name + '_DOC_DIR' : os.path.abspath(doc_dir)
 323         }
 324         obj.install_path = ''
 325         out1 = bld.new_task_gen('command-output')
 326         out1.stdout = '/doc/doxygen.out'
 327         out1.stdin = '/doc/reference.doxygen' # whatever..
 328         out1.command = 'doxygen'
 329         out1.argv = [os.path.abspath(doc_dir) + '/reference.doxygen']
 330         out1.command_is_external = True
 331
 332 def shutdown():
 333         # This isn't really correct (for packaging), but people asking is annoying
 334         if Options.commands['install']:
 335                 try: os.popen("/sbin/ldconfig")
 336                 except: pass
 337