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