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 nameify(name):
  85         return name.replace('/', '_').replace('++', 'PP').replace('-', '_').replace('.', '_')
  86
  87 def check_pkg(conf, name, **args):
  88         if not 'mandatory' in args:
  89                 args['mandatory'] = True
  90         "Check for a package iff it hasn't been checked for yet"
  91         var_name = 'HAVE_' + nameify(args['uselib_store'])
  92         check = not var_name in conf.env
  93         if not check and 'atleast_version' in args:
  94                 # Re-check if version is newer than previous check
  95                 checked_version = conf.env['VERSION_' + name]
  96                 if checked_version and checked_version < args['atleast_version']:
  97                         check = True;
  98         if check:
  99                 conf.check_cfg(package=name, args="--cflags --libs", **args)
 100                 found = bool(conf.env[var_name])
 101                 if found:
 102                         conf.define(var_name, int(found))
 103                         if 'atleast_version' in args:
 104                                 conf.env['VERSION_' + name] = args['atleast_version']
 105                 else:
 106                         conf.undefine(var_name)
 107                         if args['mandatory'] == True:
 108                                 conf.fatal("Required package " + name + " not found")
 109
 110 def chop_prefix(conf, var):
 111         name = conf.env[var][len(conf.env['PREFIX']):]
 112         if len(name) > 0 and name[0] == '/':
 113                 name = name[1:]
 114         if name == "":
 115                 name = "/"
 116         return name;
 117
 118 def configure(conf):
 119         global g_step
 120         if g_step > 1:
 121                 return
 122         def append_cxx_flags(vals):
 123                 conf.env.append_value('CCFLAGS', vals.split())
 124                 conf.env.append_value('CXXFLAGS', vals.split())
 125         conf.line_just = 43
 126         conf.check_tool('misc')
 127         conf.check_tool('compiler_cc')
 128         conf.check_tool('compiler_cxx')
 129         conf.env['BUILD_DOCS'] = Options.options.build_docs
 130         conf.env['DEBUG'] = Options.options.debug
 131         conf.env['STRICT'] = Options.options.strict
 132         conf.env['PREFIX'] = os.path.abspath(os.path.expanduser(os.path.normpath(conf.env['PREFIX'])))
 133
 134         if sys.platform == 'darwin':
 135                 #
 136                 #       Define OSX as a uselib to use when compiling
 137                 #       on Darwin to add all applicable flags at once
 138                 #
 139                 conf.env.append_value('CXXFLAGS_OSX', "-mmacosx-version-min=10.4")
 140                 conf.env.append_value('CCFLAGS_OSX', "-mmacosx-version-min=10.4")
 141                 conf.env.append_value('CXXFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
 142                 conf.env.append_value('CCFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
 143                 conf.env.append_value('LINKFLAGS_OSX', "-mmacosx-version-min=10.4")
 144                 conf.env.append_value('LINKFLAGS_OSX', "-isysroot /Developer/SDKs/MacOSX10.4u.sdk")
 145
 146                 conf.env.append_value('LINKFLAGS_OSX', "-sysroot /Developer/SDKs/MacOSX10.4u.sdk")
 147                 conf.env.append_value('LINKFLAGS_OSX', "-F/System/Library/Frameworks")
 148
 149                 conf.env.append_value('CXXFLAGS_OSX', "-msse")
 150                 conf.env.append_value('CCFLAGS_OSX', "-msse")
 151                 conf.env.append_value('CXXFLAGS_OSX', "-msse2")
 152                 conf.env.append_value('CCFLAGS_OSX', "-msse2")
 153                 #
 154                 #       TODO: The previous sse flags NEED to be based
 155                 #       off processor type.  Need to add in a check
 156                 #       for that.
 157                 #
 158
 159                 conf.env.append_value('LINKFLAGS_OSX', ['-undefined', 'suppress'])
 160                 conf.env.append_value('LINKFLAGS_OSX', "-flat_namespace")
 161                 #
 162                 #       The previous 2 flags avoid circular dependencies
 163                 #       between libardour and libardour_cp on OS X.
 164                 #       ld reported -undefined suppress as an unknown option
 165                 #       in one of the tests ran, removing it for the moment
 166                 #
 167                 conf.env.append_value('CXXFLAGS_OSX', "-F/System/Library/Frameworks")
 168                 conf.env.append_value('CCFLAGS_OSX', "-F/System/Library/Frameworks")
 169
 170
 171         if Options.options.gtkosx:
 172                 #
 173                 #       Define Include Paths for GTKOSX
 174                 #
 175                 conf.env.append_value('CPPPATH_GTKOSX', "/usr/include/")
 176                 conf.env.append_value('CPPPATH_GTKOSX', "/usr/include/c++/4.0.0")
 177                 conf.env.append_value('CPPPATH_GTKOSX', "/usr/include/c++/4.0.0/i686-apple-darwin8/")
 178                 #
 179                 #       TODO: Fix the above include path, it needs to be
 180                 #       defined based off what is read in the configuration
 181                 #       stage about the machine(PPC, X86, X86_64, etc.)
 182                 #
 183                 conf.env.append_value('CPPPATH_GTKOSX', "/usr/lib/gcc/i686-apple-darwin9/4.0.1/include/")
 184                 #
 185                 #       TODO: Likewise this needs to be defined not only
 186                 #       based off the machine characteristics, but also
 187                 #       based off the version of GCC being used.
 188                 #
 189                 conf.env.append_value('CPPPATH_GTKOSX', "/System/Library/Frameworks/")
 190                 conf.env.append_value('CXXFLAGS_GTKOSX', '-DTOP_MENUBAR')
 191                 conf.env.append_value('CXXFLAGS_GTKOSX', '-DGTKOSX')
 192                 conf.env.append_value('LINKFLAGS_GTKOSX', "-framework AppKit")
 193                 conf.env.append_value('LINKFLAGS_GTKOSX', "-Xlinker -headerpad")
 194                 conf.env.append_value('LINKFLAGS_GTKOSX', "-Xlinker 2048")
 195                 conf.env.append_value('CPPPATH_GTKOSX', "/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/")
 196                 #
 197                 #       I had a note the previous was for MacTypes.h
 198                 #
 199
 200         if Options.options.coreaudio:
 201            #conf.env.append_value('LINKFLAGS_COREAUDIO', "-framework CoreAudioKit")
 202            #conf.env.append_value('LINKFLAGS_COREAUDIO', "-framework AudioToolbox")
 203            #conf.env.append_value('LINKFLAGS_COREAUDIO', "-framework CoreServices")
 204            conf.check_cc (header_name = '/System/Library/Frameworks/CoreAudio.framework/Headers/CoreAudio.h',
 205                                           define_name = 'HAVE_COREAUDIO', linkflags = ['-framework', 'CoreAudio'])
 206            conf.check_cxx (header_name = '/System/Library/Frameworks/AudioToolbox.framework/Headers/ExtendedAudioFile.h',
 207                                           linkflags = [ '-framework', 'AudioToolbox' ])
 208            conf.check_cc (header_name = '/System/Library/Frameworks/CoreFoundation.framework/Headers/CoreFoundation.h',
 209                                           linkflags = ['-framework', 'CoreFoundation'])
 210            conf.check_cc (header_name = '/System/Library/Frameworks/CoreServices.framework/Headers/CoreServices.h',
 211                                           linkflags = ['-framework', 'CoreServices'])
 212            #
 213            #    TODO: For some reason the above doesn't seem to be correctly adding the
 214            #    the link flags, so we will add them manually.
 215            #
 216            conf.env.append_value('LINKFLAGS_COREAUDIO', ['-framework', 'CoreServices'])
 217            conf.env.append_value('LINKFLAGS_COREAUDIO', ['-framework', 'CoreFoundation'])
 218            conf.env.append_value('LINKFLAGS_COREAUDIO', ['-framework', 'AudioToolbox'])
 219            conf.env.append_value('LINKFLAGS_COREAUDIO', ['-framework', 'CoreAudio'])
 220
 221         if Options.options.audiounits:
 222            #conf.env.append_value('CXXFLAGS_AUDIOUNITS', "-DHAVE_AUDIOUNITS")
 223            conf.env.append_value('LINKFLAGS_AUDIOUNITS', "-framework AudioToolbox")
 224            conf.env.append_value('LINKFLAGS_AUDIOUNITS', "-framework CoreServices")
 225            conf.check_cc (header_name = '/System/Library/Frameworks/AudioUnit.framework/Headers/AudioUnit.h',
 226                                           define_name = 'HAVE_AUDIOUNITS', linkflags = [ '-framework', 'AudioUnit' ])
 227
 228
 229         if Options.options.bundle:
 230                 conf.env['BUNDLE'] = True
 231                 conf.define('BUNDLE', 1)
 232                 conf.env['BINDIR'] = conf.env['PREFIX']
 233                 conf.env['INCLUDEDIR'] = os.path.join(conf.env['PREFIX'], 'Headers')
 234                 conf.env['LIBDIR'] = os.path.join(conf.env['PREFIX'], 'Libraries')
 235                 conf.env['DATADIR'] = os.path.join(conf.env['PREFIX'], 'Resources')
 236                 conf.env['HTMLDIR'] = os.path.join(conf.env['PREFIX'], 'Resources/Documentation')
 237                 conf.env['MANDIR'] = os.path.join(conf.env['PREFIX'], 'Resources/Man')
 238                 conf.env['LV2DIR'] = os.path.join(conf.env['PREFIX'], 'PlugIns')
 239         else:
 240                 conf.env['BUNDLE'] = False
 241                 if Options.options.bindir:
 242                         conf.env['BINDIR'] = Options.options.bindir
 243                 else:
 244                         conf.env['BINDIR'] = os.path.join(conf.env['PREFIX'], 'bin')
 245                 if Options.options.includedir:
 246                         conf.env['INCLUDEDIR'] = Options.options.includedir
 247                 else:
 248                         conf.env['INCLUDEDIR'] = os.path.join(conf.env['PREFIX'], 'include')
 249                 if Options.options.libdir:
 250                         conf.env['LIBDIR'] = Options.options.libdir
 251                 else:
 252                         conf.env['LIBDIR'] = os.path.join(conf.env['PREFIX'], 'lib')
 253                 if Options.options.datadir:
 254                         conf.env['DATADIR'] = Options.options.datadir
 255                 else:
 256                         conf.env['DATADIR'] = os.path.join(conf.env['PREFIX'], 'share')
 257                 if Options.options.configdir:
 258                         conf.env['CONFIGDIR'] = Options.options.configdir
 259                 else:
 260                         conf.env['CONFIGDIR'] = os.path.join(conf.env['PREFIX'], 'etc')
 261                 if Options.options.htmldir:
 262                         conf.env['HTMLDIR'] = Options.options.htmldir
 263                 else:
 264                         conf.env['HTMLDIR'] = os.path.join(conf.env['DATADIR'], 'doc', Utils.g_module.APPNAME)
 265                 if Options.options.mandir:
 266                         conf.env['MANDIR'] = Options.options.mandir
 267                 else:
 268                         conf.env['MANDIR'] = os.path.join(conf.env['DATADIR'], 'man')
 269                 if Options.options.lv2dir:
 270                         conf.env['LV2DIR'] = Options.options.lv2dir
 271                 else:
 272                         if Options.options.lv2_user:
 273                                 if sys.platform == "darwin":
 274                                         conf.env['LV2DIR'] = os.path.join(os.getenv('HOME'), 'Library/Audio/Plug-Ins/LV2')
 275                                 else:
 276                                         conf.env['LV2DIR'] = os.path.join(os.getenv('HOME'), '.lv2')
 277                         else:
 278                                 if sys.platform == "darwin":
 279                                         conf.env['LV2DIR'] = '/Library/Audio/Plug-Ins/LV2'
 280                                 else:
 281                                         conf.env['LV2DIR'] = os.path.join(conf.env['LIBDIR'], 'lv2')
 282
 283         conf.env['BINDIRNAME'] = chop_prefix(conf, 'BINDIR')
 284         conf.env['LIBDIRNAME'] = chop_prefix(conf, 'LIBDIR')
 285         conf.env['DATADIRNAME'] = chop_prefix(conf, 'DATADIR')
 286         conf.env['CONFIGDIRNAME'] = chop_prefix(conf, 'CONFIGDIR')
 287         conf.env['LV2DIRNAME'] = chop_prefix(conf, 'LV2DIR')
 288
 289         if Options.options.debug:
 290                 conf.env['CCFLAGS'] = [ '-O0', '-g' ]
 291                 conf.env['CXXFLAGS'] = [ '-O0',  '-g' ]
 292         else:
 293                 append_cxx_flags('-DNDEBUG')
 294         if Options.options.strict:
 295                 conf.env.append_value('CCFLAGS', [ '-std=c99', '-pedantic' ])
 296                 conf.env.append_value('CXXFLAGS', [ '-ansi', '-Woverloaded-virtual'])
 297                 append_cxx_flags('-Wall -Wextra -Wno-unused-parameter')
 298         append_cxx_flags('-fPIC -DPIC -fshow-column')
 299         g_step = 2
 300
 301 def set_local_lib(conf, name, has_objects):
 302         conf.define('HAVE_' + nameify(name.upper()), 1)
 303         if has_objects:
 304                 if type(conf.env['AUTOWAF_LOCAL_LIBS']) != dict:
 305                         conf.env['AUTOWAF_LOCAL_LIBS'] = {}
 306                 conf.env['AUTOWAF_LOCAL_LIBS'][name.lower()] = True
 307         else:
 308                 if type(conf.env['AUTOWAF_LOCAL_HEADERS']) != dict:
 309                         conf.env['AUTOWAF_LOCAL_HEADERS'] = {}
 310                 conf.env['AUTOWAF_LOCAL_HEADERS'][name.lower()] = True
 311
 312 def use_lib(bld, obj, libs):
 313         abssrcdir = os.path.abspath('.')
 314         libs_list = libs.split()
 315         for l in libs_list:
 316                 in_headers = l.lower() in bld.env['AUTOWAF_LOCAL_HEADERS']
 317                 in_libs    = l.lower() in bld.env['AUTOWAF_LOCAL_LIBS']
 318                 if in_libs:
 319                         if hasattr(obj, 'uselib_local'):
 320                                 obj.uselib_local += ' lib' + l.lower() + ' '
 321                         else:
 322                                 obj.uselib_local = 'lib' + l.lower() + ' '
 323
 324                 if in_headers or in_libs:
 325                         inc_flag = '-iquote ' + os.path.join(abssrcdir, l.lower())
 326                         for f in ['CCFLAGS', 'CXXFLAGS']:
 327                                 if not inc_flag in bld.env[f]:
 328                                         bld.env.append_value(f, inc_flag)
 329                 else:
 330                         if hasattr(obj, 'uselib'):
 331                                 obj.uselib += ' ' + l
 332                         else:
 333                                 obj.uselib = l
 334
 335
 336 def display_header(title):
 337         Utils.pprint('BOLD', title)
 338
 339 def display_msg(conf, msg, status = None, color = None):
 340         color = 'CYAN'
 341         if type(status) == bool and status or status == "True":
 342                 color = 'GREEN'
 343         elif type(status) == bool and not status or status == "False":
 344                 color = 'YELLOW'
 345         Utils.pprint('NORMAL', "%s :" % msg.ljust(conf.line_just), sep='')
 346         Utils.pprint(color, status)
 347
 348 def print_summary(conf):
 349         global g_step
 350         if g_step > 2:
 351                 print
 352                 return
 353         e = conf.env
 354         print
 355         display_header('Global configuration')
 356         display_msg(conf, "Install prefix", conf.env['PREFIX'])
 357         display_msg(conf, "Debuggable build", str(conf.env['DEBUG']))
 358         display_msg(conf, "Strict compiler flags", str(conf.env['STRICT']))
 359         display_msg(conf, "Build documentation", str(conf.env['BUILD_DOCS']))
 360         print
 361         g_step = 3
 362
 363 def link_flags(env, lib):
 364         return ' '.join(map(lambda x: env['LIB_ST'] % x, env['LIB_' + lib]))
 365
 366 def compile_flags(env, lib):
 367         return ' '.join(map(lambda x: env['CPPPATH_ST'] % x, env['CPPPATH_' + lib]))
 368
 369 def set_recursive():
 370         global g_is_child
 371         g_is_child = True
 372
 373 def is_child():
 374         global g_is_child
 375         return g_is_child
 376
 377 # Pkg-config file
 378 def build_pc(bld, name, version, libs):
 379         '''Build a pkg-config file for a library.
 380         name    -- uppercase variable name     (e.g. 'SOMENAME')
 381         version -- version string              (e.g. '1.2.3')
 382         libs    -- string/list of dependencies (e.g. 'LIBFOO GLIB')
 383         '''
 384
 385         obj              = bld.new_task_gen('subst')
 386         obj.source       = name.lower() + '.pc.in'
 387         obj.target       = name.lower() + '.pc'
 388         obj.install_path = '${PREFIX}/${LIBDIRNAME}/pkgconfig'
 389         pkg_prefix       = bld.env['PREFIX']
 390         if pkg_prefix[-1] == '/':
 391                 pkg_prefix = pkg_prefix[:-1]
 392         obj.dict = {
 393                 'prefix'           : pkg_prefix,
 394                 'exec_prefix'      : '${prefix}',
 395                 'libdir'           : '${exec_prefix}/lib',
 396                 'includedir'       : '${prefix}/include',
 397                 name + '_VERSION'  : version,
 398         }
 399         if type(libs) != list:
 400                 libs = libs.split()
 401         for i in libs:
 402                 obj.dict[i + '_LIBS']   = link_flags(bld.env, i)
 403                 obj.dict[i + '_CFLAGS'] = compile_flags(bld.env, i)
 404
 405 # Doxygen API documentation
 406 def build_dox(bld, name, version, srcdir, blddir):
 407         if not bld.env['BUILD_DOCS']:
 408                 return
 409         obj = bld.new_task_gen('subst')
 410         obj.source = 'doc/reference.doxygen.in'
 411         obj.target = 'doc/reference.doxygen'
 412         if is_child():
 413                 src_dir = os.path.join(srcdir, name.lower())
 414                 doc_dir = os.path.join(blddir, 'default', name.lower(), 'doc')
 415         else:
 416                 src_dir = srcdir
 417                 doc_dir = os.path.join(blddir, 'default', 'doc')
 418         obj.dict = {
 419                 name + '_VERSION' : version,
 420                 name + '_SRCDIR'  : os.path.abspath(src_dir),
 421                 name + '_DOC_DIR' : os.path.abspath(doc_dir)
 422         }
 423         obj.install_path = ''
 424         out1 = bld.new_task_gen('command-output')
 425         out1.dependencies = [obj]
 426         out1.stdout = '/doc/doxygen.out'
 427         out1.stdin = '/doc/reference.doxygen' # whatever..
 428         out1.command = 'doxygen'
 429         out1.argv = [os.path.abspath(doc_dir) + '/reference.doxygen']
 430         out1.command_is_external = True
 431
 432 # Version code file generation
 433 def build_version_files(header_path, source_path, domain, major, minor, micro):
 434         header_path = os.path.abspath(header_path)
 435         source_path = os.path.abspath(source_path)
 436         text  = "int " + domain + "_major_version = " + str(major) + ";\n"
 437         text += "int " + domain + "_minor_version = " + str(minor) + ";\n"
 438         text += "int " + domain + "_micro_version = " + str(micro) + ";\n"
 439         try:
 440                 o = file(source_path, 'w')
 441                 o.write(text)
 442                 o.close()
 443         except IOError:
 444                 print "Could not open", source_path, " for writing\n"
 445                 sys.exit(-1)
 446
 447         text  = "#ifndef __" + domain + "_version_h__\n"
 448         text += "#define __" + domain + "_version_h__\n"
 449         text += "extern const char* " + domain + "_revision;\n"
 450         text += "extern int " + domain + "_major_version;\n"
 451         text += "extern int " + domain + "_minor_version;\n"
 452         text += "extern int " + domain + "_micro_version;\n"
 453         text += "#endif /* __" + domain + "_version_h__ */\n"
 454         try:
 455                 o = file(header_path, 'w')
 456                 o.write(text)
 457                 o.close()
 458         except IOError:
 459                 print "Could not open", header_path, " for writing\n"
 460                 sys.exit(-1)
 461
 462         return None
 463
 464 def shutdown():
 465         # This isn't really correct (for packaging), but people asking is annoying
 466         if Options.commands['install']:
 467                 try: os.popen("/sbin/ldconfig")
 468                 except: pass
 469