scons/generic.py

   1 """generic
   2
   3 Generic tool that provides a commmon ground for all platforms.
   4
   5 """
   6
   7 #
   8 # Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   9 # All Rights Reserved.
  10 #
  11 # Permission is hereby granted, free of charge, to any person obtaining a
  12 # copy of this software and associated documentation files (the
  13 # "Software"), to deal in the Software without restriction, including
  14 # without limitation the rights to use, copy, modify, merge, publish,
  15 # distribute, sub license, and/or sell copies of the Software, and to
  16 # permit persons to whom the Software is furnished to do so, subject to
  17 # the following conditions:
  18 #
  19 # The above copyright notice and this permission notice (including the
  20 # next paragraph) shall be included in all copies or substantial portions
  21 # of the Software.
  22 #
  23 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  24 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  26 # IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  27 # ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  28 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  29 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 #
  31
  32
  33 import os
  34 import os.path
  35 import re
  36 import platform as _platform
  37 import sys
  38
  39 import SCons.Action
  40 import SCons.Builder
  41 import SCons.Scanner
  42
  43
  44 def quietCommandLines(env):
  45     # Quiet command lines
  46     # See also http://www.scons.org/wiki/HidingCommandLinesInOutput
  47     env['CCCOMSTR'] = "Compiling $SOURCE ..."
  48     env['CXXCOMSTR'] = "Compiling $SOURCE ..."
  49     env['ARCOMSTR'] = "Archiving $TARGET ..."
  50     env['RANLIBCOMSTR'] = ""
  51     env['LINKCOMSTR'] = "Linking $TARGET ..."
  52
  53
  54 def createConvenienceLibBuilder(env):
  55     """This is a utility function that creates the ConvenienceLibrary
  56     Builder in an Environment if it is not there already.
  57
  58     If it is already there, we return the existing one.
  59
  60     Based on the stock StaticLibrary and SharedLibrary builders.
  61     """
  62
  63     try:
  64         convenience_lib = env['BUILDERS']['ConvenienceLibrary']
  65     except KeyError:
  66         action_list = [ SCons.Action.Action("$ARCOM", "$ARCOMSTR") ]
  67         if env.Detect('ranlib'):
  68             ranlib_action = SCons.Action.Action("$RANLIBCOM", "$RANLIBCOMSTR")
  69             action_list.append(ranlib_action)
  70
  71         convenience_lib = SCons.Builder.Builder(action = action_list,
  72                                   emitter = '$LIBEMITTER',
  73                                   prefix = '$LIBPREFIX',
  74                                   suffix = '$LIBSUFFIX',
  75                                   src_suffix = '$SHOBJSUFFIX',
  76                                   src_builder = 'SharedObject')
  77         env['BUILDERS']['ConvenienceLibrary'] = convenience_lib
  78
  79     return convenience_lib
  80
  81
  82 # TODO: handle import statements with multiple modules
  83 # TODO: handle from import statements
  84 import_re = re.compile(r'^import\s+(\S+)$', re.M)
  85
  86 def python_scan(node, env, path):
  87     # http://www.scons.org/doc/0.98.5/HTML/scons-user/c2781.html#AEN2789
  88     contents = node.get_contents()
  89     source_dir = node.get_dir()
  90     imports = import_re.findall(contents)
  91     results = []
  92     for imp in imports:
  93         for dir in path:
  94             file = os.path.join(str(dir), imp.replace('.', os.sep) + '.py')
  95             if os.path.exists(file):
  96                 results.append(env.File(file))
  97                 break
  98             file = os.path.join(str(dir), imp.replace('.', os.sep), '__init__.py')
  99             if os.path.exists(file):
 100                 results.append(env.File(file))
 101                 break
 102     return results
 103
 104 python_scanner = SCons.Scanner.Scanner(function = python_scan, skeys = ['.py'])
 105
 106
 107 def code_generate(env, script, target, source, command):
 108     """Method to simplify code generation via python scripts.
 109
 110     http://www.scons.org/wiki/UsingCodeGenerators
 111     http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
 112     """
 113
 114     # We're generating code using Python scripts, so we have to be
 115     # careful with our scons elements.  This entry represents
 116     # the generator file *in the source directory*.
 117     script_src = env.File(script).srcnode()
 118
 119     # This command creates generated code *in the build directory*.
 120     command = command.replace('$SCRIPT', script_src.path)
 121     code = env.Command(target, source, command)
 122
 123     # Explicitly mark that the generated code depends on the generator,
 124     # and on implicitly imported python modules
 125     path = (script_src.get_dir(),)
 126     deps = [script_src]
 127     deps += script_src.get_implicit_deps(env, python_scanner, path)
 128     env.Depends(code, deps)
 129
 130     # Running the Python script causes .pyc files to be generated in the
 131     # source directory.  When we clean up, they should go too. So add side
 132     # effects for .pyc files
 133     for dep in deps:
 134         pyc = env.File(str(dep) + 'c')
 135         env.SideEffect(pyc, code)
 136
 137     return code
 138
 139
 140 def createCodeGenerateMethod(env):
 141     env.Append(SCANNERS = python_scanner)
 142     env.AddMethod(code_generate, 'CodeGenerate')
 143
 144
 145 def symlink(target, source, env):
 146     target = str(target[0])
 147     source = str(source[0])
 148     if os.path.islink(target) or os.path.exists(target):
 149         os.remove(target)
 150     os.symlink(os.path.basename(source), target)
 151
 152 def install_shared_library(env, source, version = ()):
 153     source = str(source[0])
 154     version = tuple(map(str, version))
 155     target_dir =  os.path.join(env.Dir('#.').srcnode().abspath, env['build'], 'lib')
 156     target_name = '.'.join((str(source),) + version)
 157     last = env.InstallAs(os.path.join(target_dir, target_name), source)
 158     while len(version):
 159         version = version[:-1]
 160         target_name = '.'.join((str(source),) + version)
 161         action = SCons.Action.Action(symlink, "$TARGET -> $SOURCE")
 162         last = env.Command(os.path.join(target_dir, target_name), last, action)
 163
 164 def createInstallMethods(env):
 165     env.AddMethod(install_shared_library, 'InstallSharedLibrary')
 166
 167
 168 _platform_map = {
 169     'linux2': 'linux',
 170     'win32': 'windows',
 171 }
 172
 173
 174 _machine_map = {
 175         'x86': 'x86',
 176         'i386': 'x86',
 177         'i486': 'x86',
 178         'i586': 'x86',
 179         'i686': 'x86',
 180         'ppc': 'ppc',
 181         'x86_64': 'x86_64',
 182 }
 183
 184
 185 _toolchain_map = {
 186     'winddk': 'winddk',
 187     'wince': 'wcesdk',
 188 }
 189
 190
 191 _bool_map = {
 192     'y': 1,
 193     'yes': 1,
 194     't': 1,
 195     'true': 1,
 196     '1': 1,
 197     'on': 1,
 198     'all': 1,
 199     'n': 0,
 200     'no': 0,
 201     'f': 0,
 202     'false': 0,
 203     '0': 0,
 204     'off': 0,
 205     'none': 0,
 206 }
 207
 208
 209 def generate(env):
 210     """Common environment generation code"""
 211
 212     from SCons.Script import ARGUMENTS
 213
 214     # FIXME: this is already too late
 215     #if env.get('quiet', False):
 216     #    quietCommandLines(env)
 217
 218
 219     # Platform
 220     try:
 221         env['platform'] = ARGUMENTS['platform']
 222     except KeyError:
 223         env['platform'] = _platform_map.get(sys.platform, sys.platform)
 224
 225     # Machine
 226     try:
 227         env['machine'] = ARGUMENTS['machine']
 228     except KeyError:
 229         env['machine'] = _machine_map.get(os.environ.get('PROCESSOR_ARCHITECTURE', _platform.machine()), 'generic')
 230
 231     # Toolchain
 232     try:
 233         env['toolchain'] = ARGUMENTS['toolchain']
 234     except KeyError:
 235         if env['platform'] in ('windows', 'winddk', 'wince') and sys.platform != 'win32':
 236             env['toolchain'] = 'crossmingw'
 237         else:
 238             env['toolchain'] = _toolchain_map.get(env['platform'], 'default')
 239     if env['toolchain'] == 'crossmingw' and env['machine'] not in ('generic', 'x86'):
 240             env['machine'] = 'x86'
 241
 242     try:
 243         env['MSVS_VERSION'] = ARGUMENTS['MSVS_VERSION']
 244     except KeyError:
 245         pass
 246
 247     # Build type
 248     env['debug'] = _bool_map[ARGUMENTS.get('debug', 'no')]
 249     env['profile'] = _bool_map[ARGUMENTS.get('profile', 'no')]
 250
 251     # Put build output in a separate dir, which depends on the current
 252     # configuration. See also http://www.scons.org/wiki/AdvancedBuildExample
 253     try:
 254         env['build'] = ARGUMENTS['build']
 255     except KeyError:
 256         build_topdir = 'build'
 257         build_subdir = env['platform']
 258         if env['machine'] != 'generic':
 259             build_subdir += '-' + env['machine']
 260         if env['debug']:
 261             build_subdir += "-debug"
 262         if env['profile']:
 263             build_subdir += "-profile"
 264         env['build'] = os.path.join(build_topdir, build_subdir)
 265     # Place the .sconsign file in the build dir too, to avoid issues with
 266     # different scons versions building the same source file
 267     env.SConsignFile(os.path.join(env['build'], '.sconsign'))
 268
 269     # Summary
 270     print
 271     print '  platform=%s' % env['platform']
 272     print '  machine=%s' % env['machine']
 273     print '  toolchain=%s' % env['toolchain']
 274     print '  debug=%s' % ['no', 'yes'][env['debug']]
 275     print '  profile=%s' % ['no', 'yes'][env['profile']]
 276     print '  build=%s' % env['build']
 277     print
 278
 279     # Load tool chain
 280     env.Tool(env['toolchain'])
 281
 282     # shortcuts
 283     debug = env['debug']
 284     machine = env['machine']
 285     platform = env['platform']
 286     x86 = env['machine'] == 'x86'
 287     ppc = env['machine'] == 'ppc'
 288     gcc = env['platform'] in ('linux', 'freebsd', 'darwin') or env['toolchain'] == 'crossmingw'
 289     msvc = env['platform'] in ('windows', 'winddk', 'wince') and env['toolchain'] != 'crossmingw'
 290
 291     # C preprocessor options
 292     cppdefines = []
 293     if debug:
 294         cppdefines += ['DEBUG']
 295     else:
 296         cppdefines += ['NDEBUG']
 297     if env['profile']:
 298         cppdefines += ['PROFILE']
 299     if platform == 'windows':
 300         cppdefines += [
 301             'WIN32',
 302             '_WINDOWS',
 303             #'_UNICODE',
 304             #'UNICODE',
 305             # http://msdn2.microsoft.com/en-us/library/6dwk3a1z.aspx,
 306             #'WIN32_LEAN_AND_MEAN',
 307             'VC_EXTRALEAN',
 308             '_CRT_SECURE_NO_DEPRECATE',
 309         ]
 310         if debug:
 311             cppdefines += ['_DEBUG']
 312     if platform == 'winddk':
 313         # Mimic WINDDK's builtin flags. See also:
 314         # - WINDDK's bin/makefile.new i386mk.inc for more info.
 315         # - buildchk_wxp_x86.log files, generated by the WINDDK's build
 316         # - http://alter.org.ua/docs/nt_kernel/vc8_proj/
 317         cppdefines += [
 318             ('_X86_', '1'),
 319             ('i386', '1'),
 320             'STD_CALL',
 321             ('CONDITION_HANDLING', '1'),
 322             ('NT_INST', '0'),
 323             ('WIN32', '100'),
 324             ('_NT1X_', '100'),
 325             ('WINNT', '1'),
 326             ('_WIN32_WINNT', '0x0501'), # minimum required OS version
 327             ('WINVER', '0x0501'),
 328             ('_WIN32_IE', '0x0603'),
 329             ('WIN32_LEAN_AND_MEAN', '1'),
 330             ('DEVL', '1'),
 331             ('__BUILDMACHINE__', 'WinDDK'),
 332             ('FPO', '0'),
 333         ]
 334         if debug:
 335             cppdefines += [('DBG', 1)]
 336     if platform == 'wince':
 337         cppdefines += [
 338             '_CRT_SECURE_NO_DEPRECATE',
 339             '_USE_32BIT_TIME_T',
 340             'UNICODE',
 341             '_UNICODE',
 342             ('UNDER_CE', '600'),
 343             ('_WIN32_WCE', '0x600'),
 344             'WINCEOEM',
 345             'WINCEINTERNAL',
 346             'WIN32',
 347             'STRICT',
 348             'x86',
 349             '_X86_',
 350             'INTERNATIONAL',
 351             ('INTLMSG_CODEPAGE', '1252'),
 352         ]
 353     env.Append(CPPDEFINES = cppdefines)
 354
 355     # C preprocessor includes
 356     if platform == 'winddk':
 357         env.Append(CPPPATH = [
 358             env['SDK_INC_PATH'],
 359             env['DDK_INC_PATH'],
 360             env['WDM_INC_PATH'],
 361             env['CRT_INC_PATH'],
 362         ])
 363
 364     # C compiler options
 365     cflags = [] # C
 366     cxxflags = [] # C++
 367     ccflags = [] # C & C++
 368     if gcc:
 369         if debug:
 370             ccflags += ['-O0', '-g3']
 371         else:
 372             ccflags += ['-O3', '-g0']
 373         if env['profile']:
 374             ccflags += ['-pg']
 375         if env['machine'] == 'x86':
 376             ccflags += [
 377                 '-m32',
 378                 #'-march=pentium4',
 379                 '-mmmx', '-msse', '-msse2', # enable SIMD intrinsics
 380                 #'-mfpmath=sse',
 381             ]
 382         if env['machine'] == 'x86_64':
 383             ccflags += ['-m64']
 384         ccflags += [
 385             '-Wall',
 386             '-Wmissing-prototypes',
 387             '-Wno-long-long',
 388             '-ffast-math',
 389             '-pedantic',
 390             '-fmessage-length=0', # be nice to Eclipse
 391         ]
 392         cflags += [
 393             '-Wmissing-prototypes',
 394         ]
 395     if msvc:
 396         # See also:
 397         # - http://msdn.microsoft.com/en-us/library/19z1t1wy.aspx
 398         # - cl /?
 399         if debug:
 400             ccflags += [
 401               '/Od', # disable optimizations
 402               '/Oi', # enable intrinsic functions
 403               '/Oy-', # disable frame pointer omission
 404             ]
 405         else:
 406             ccflags += [
 407               '/Ox', # maximum optimizations
 408               '/Oi', # enable intrinsic functions
 409               '/Ot', # favor code speed
 410               #'/fp:fast', # fast floating point
 411             ]
 412         if env['profile']:
 413             ccflags += [
 414                 '/Gh', # enable _penter hook function
 415                 '/GH', # enable _pexit hook function
 416             ]
 417         ccflags += [
 418             '/W3', # warning level
 419             #'/Wp64', # enable 64 bit porting warnings
 420         ]
 421         if env['machine'] == 'x86':
 422             ccflags += [
 423                 #'/QIfist', # Suppress _ftol
 424                 #'/arch:SSE2', # use the SSE2 instructions
 425             ]
 426         if platform == 'windows':
 427             ccflags += [
 428                 # TODO
 429             ]
 430         if platform == 'winddk':
 431             ccflags += [
 432                 '/Zl', # omit default library name in .OBJ
 433                 '/Zp8', # 8bytes struct member alignment
 434                 '/Gy', # separate functions for linker
 435                 '/Gm-', # disable minimal rebuild
 436                 '/WX', # treat warnings as errors
 437                 '/Gz', # __stdcall Calling convention
 438                 '/GX-', # disable C++ EH
 439                 '/GR-', # disable C++ RTTI
 440                 '/GF', # enable read-only string pooling
 441                 '/G6', # optimize for PPro, P-II, P-III
 442                 '/Ze', # enable extensions
 443                 '/Gi-', # disable incremental compilation
 444                 '/QIfdiv-', # disable Pentium FDIV fix
 445                 '/hotpatch', # prepares an image for hotpatching.
 446                 #'/Z7', #enable old-style debug info
 447             ]
 448         if platform == 'wince':
 449             # See also C:\WINCE600\public\common\oak\misc\makefile.def
 450             ccflags += [
 451                 '/Zl', # omit default library name in .OBJ
 452                 '/GF', # enable read-only string pooling
 453                 '/GR-', # disable C++ RTTI
 454                 '/GS', # enable security checks
 455                 # Allow disabling language conformance to maintain backward compat
 456                 #'/Zc:wchar_t-', # don't force wchar_t as native type, instead of typedef
 457                 #'/Zc:forScope-', # don't enforce Standard C++ for scoping rules
 458                 #'/wd4867',
 459                 #'/wd4430',
 460                 #'/MT',
 461                 #'/U_MT',
 462             ]
 463         # Automatic pdb generation
 464         # See http://scons.tigris.org/issues/show_bug.cgi?id=1656
 465         env.EnsureSConsVersion(0, 98, 0)
 466         env['PDB'] = '${TARGET.base}.pdb'
 467     env.Append(CCFLAGS = ccflags)
 468     env.Append(CFLAGS = cflags)
 469     env.Append(CXXFLAGS = cxxflags)
 470
 471     if env['platform'] == 'windows' and msvc:
 472         # Choose the appropriate MSVC CRT
 473         # http://msdn.microsoft.com/en-us/library/2kzt1wy3.aspx
 474         if env['debug']:
 475             env.Append(CCFLAGS = ['/MTd'])
 476             env.Append(SHCCFLAGS = ['/LDd'])
 477         else:
 478             env.Append(CCFLAGS = ['/MT'])
 479             env.Append(SHCCFLAGS = ['/LD'])
 480
 481     # Assembler options
 482     if gcc:
 483         if env['machine'] == 'x86':
 484             env.Append(ASFLAGS = ['-m32'])
 485         if env['machine'] == 'x86_64':
 486             env.Append(ASFLAGS = ['-m64'])
 487
 488     # Linker options
 489     linkflags = []
 490     if gcc:
 491         if env['machine'] == 'x86':
 492             linkflags += ['-m32']
 493         if env['machine'] == 'x86_64':
 494             linkflags += ['-m64']
 495     if platform == 'winddk':
 496         # See also:
 497         # - http://msdn2.microsoft.com/en-us/library/y0zzbyt4.aspx
 498         linkflags += [
 499             '/merge:_PAGE=PAGE',
 500             '/merge:_TEXT=.text',
 501             '/section:INIT,d',
 502             '/opt:ref',
 503             '/opt:icf',
 504             '/ignore:4198,4010,4037,4039,4065,4070,4078,4087,4089,4221',
 505             '/incremental:no',
 506             '/fullbuild',
 507             '/release',
 508             '/nodefaultlib',
 509             '/wx',
 510             '/debug',
 511             '/debugtype:cv',
 512             '/version:5.1',
 513             '/osversion:5.1',
 514             '/functionpadmin:5',
 515             '/safeseh',
 516             '/pdbcompress',
 517             '/stack:0x40000,0x1000',
 518             '/driver',
 519             '/align:0x80',
 520             '/subsystem:native,5.01',
 521             '/base:0x10000',
 522
 523             '/entry:DrvEnableDriver',
 524         ]
 525         if env['profile']:
 526             linkflags += [
 527                 '/MAP', # http://msdn.microsoft.com/en-us/library/k7xkk3e2.aspx
 528             ]
 529     if platform == 'wince':
 530         linkflags += [
 531             '/nodefaultlib',
 532             #'/incremental:no',
 533             #'/fullbuild',
 534             '/entry:_DllMainCRTStartup',
 535         ]
 536     env.Append(LINKFLAGS = linkflags)
 537
 538     # Default libs
 539     env.Append(LIBS = [])
 540
 541     # Custom builders and methods
 542     createConvenienceLibBuilder(env)
 543     createCodeGenerateMethod(env)
 544     createInstallMethods(env)
 545
 546     # for debugging
 547     #print env.Dump()
 548
 549
 550 def exists(env):
 551     return 1