scons/crossmingw.py

   1 """SCons.Tool.gcc
   2
   3 Tool-specific initialization for MinGW (http://www.mingw.org/)
   4
   5 There normally shouldn't be any need to import this module directly.
   6 It will usually be imported through the generic SCons.Tool.Tool()
   7 selection method.
   8
   9 See also http://www.scons.org/wiki/CrossCompilingMingw
  10 """
  11
  12 #
  13 # Copyright (c) 2001, 2002, 2003, 2004 The SCons Foundation
  14 #
  15 # Permission is hereby granted, free of charge, to any person obtaining
  16 # a copy of this software and associated documentation files (the
  17 # "Software"), to deal in the Software without restriction, including
  18 # without limitation the rights to use, copy, modify, merge, publish,
  19 # distribute, sublicense, and/or sell copies of the Software, and to
  20 # permit persons to whom the Software is furnished to do so, subject to
  21 # the following conditions:
  22 #
  23 # The above copyright notice and this permission notice shall be included
  24 # in all copies or substantial portions of the Software.
  25 #
  26 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  27 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  28 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  30 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  31 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  32 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33 #
  34
  35 import os
  36 import os.path
  37 import string
  38
  39 import SCons.Action
  40 import SCons.Builder
  41 import SCons.Tool
  42 import SCons.Util
  43
  44 # This is what we search for to find mingw:
  45 prefixes32 = SCons.Util.Split("""
  46     mingw32-
  47     mingw32msvc-
  48     i386-mingw32-
  49     i486-mingw32-
  50     i586-mingw32-
  51     i686-mingw32-
  52     i386-mingw32msvc-
  53     i486-mingw32msvc-
  54     i586-mingw32msvc-
  55     i686-mingw32msvc-
  56     i686-pc-mingw32-
  57     i686-w64-mingw32-
  58 """)
  59 prefixes64 = SCons.Util.Split("""
  60     x86_64-w64-mingw32-
  61     amd64-mingw32-
  62     amd64-mingw32msvc-
  63     amd64-pc-mingw32-
  64 """)
  65
  66 def find(env):
  67     if env['machine'] == 'x86_64':
  68         prefixes = prefixes64
  69     else:
  70         prefixes = prefixes32
  71     for prefix in prefixes:
  72         # First search in the SCons path and then the OS path:
  73         if env.WhereIs(prefix + 'gcc') or SCons.Util.WhereIs(prefix + 'gcc'):
  74             return prefix
  75
  76     return ''
  77
  78 def shlib_generator(target, source, env, for_signature):
  79     cmd = SCons.Util.CLVar(['$SHLINK', '$SHLINKFLAGS'])
  80
  81     dll = env.FindIxes(target, 'SHLIBPREFIX', 'SHLIBSUFFIX')
  82     if dll: cmd.extend(['-o', dll])
  83
  84     cmd.extend(['$SOURCES', '$_LIBDIRFLAGS', '$_LIBFLAGS'])
  85
  86     implib = env.FindIxes(target, 'LIBPREFIX', 'LIBSUFFIX')
  87     if implib: cmd.append('-Wl,--out-implib,'+implib.get_string(for_signature))
  88
  89     def_target = env.FindIxes(target, 'WIN32DEFPREFIX', 'WIN32DEFSUFFIX')
  90     if def_target: cmd.append('-Wl,--output-def,'+def_target.get_string(for_signature))
  91
  92     return [cmd]
  93
  94 def shlib_emitter(target, source, env):
  95     dll = env.FindIxes(target, 'SHLIBPREFIX', 'SHLIBSUFFIX')
  96     no_import_lib = env.get('no_import_lib', 0)
  97
  98     if not dll:
  99         raise SCons.Errors.UserError, "A shared library should have exactly one target with the suffix: %s" % env.subst("$SHLIBSUFFIX")
 100
 101     if not no_import_lib and \
 102        not env.FindIxes(target, 'LIBPREFIX', 'LIBSUFFIX'):
 103
 104         # Append an import library to the list of targets.
 105         target.append(env.ReplaceIxes(dll,
 106                                       'SHLIBPREFIX', 'SHLIBSUFFIX',
 107                                       'LIBPREFIX', 'LIBSUFFIX'))
 108
 109     # Append a def file target if there isn't already a def file target
 110     # or a def file source. There is no option to disable def file
 111     # target emitting, because I can't figure out why someone would ever
 112     # want to turn it off.
 113     def_source = env.FindIxes(source, 'WIN32DEFPREFIX', 'WIN32DEFSUFFIX')
 114     def_target = env.FindIxes(target, 'WIN32DEFPREFIX', 'WIN32DEFSUFFIX')
 115     if not def_source and not def_target:
 116         target.append(env.ReplaceIxes(dll,
 117                                       'SHLIBPREFIX', 'SHLIBSUFFIX',
 118                                       'WIN32DEFPREFIX', 'WIN32DEFSUFFIX'))
 119
 120     return (target, source)
 121
 122
 123 shlib_action = SCons.Action.Action(shlib_generator, '$SHLINKCOMSTR', generator=1)
 124
 125 res_action = SCons.Action.Action('$RCCOM', '$RCCOMSTR')
 126
 127 res_builder = SCons.Builder.Builder(action=res_action, suffix='.o',
 128                                     source_scanner=SCons.Tool.SourceFileScanner)
 129 SCons.Tool.SourceFileScanner.add_scanner('.rc', SCons.Defaults.CScan)
 130
 131
 132
 133 def generate(env):
 134     mingw_prefix = find(env)
 135
 136     if mingw_prefix:
 137         dir = os.path.dirname(env.WhereIs(mingw_prefix + 'gcc') or SCons.Util.WhereIs(mingw_prefix + 'gcc'))
 138
 139         # The mingw bin directory must be added to the path:
 140         path = env['ENV'].get('PATH', [])
 141         if not path:
 142             path = []
 143         if SCons.Util.is_String(path):
 144             path = string.split(path, os.pathsep)
 145
 146         env['ENV']['PATH'] = string.join([dir] + path, os.pathsep)
 147
 148     # Most of mingw is the same as gcc and friends...
 149     gnu_tools = ['gcc', 'g++', 'gnulink', 'ar', 'gas']
 150     for tool in gnu_tools:
 151         SCons.Tool.Tool(tool)(env)
 152
 153     #... but a few things differ:
 154     env['CC'] = mingw_prefix + 'gcc'
 155     env['SHCCFLAGS'] = SCons.Util.CLVar('$CCFLAGS')
 156     env['CXX'] = mingw_prefix + 'g++'
 157     env['SHCXXFLAGS'] = SCons.Util.CLVar('$CXXFLAGS')
 158     env['SHLINKFLAGS'] = SCons.Util.CLVar('$LINKFLAGS -shared')
 159     env['SHLINKCOM']   = shlib_action
 160     env.Append(SHLIBEMITTER = [shlib_emitter])
 161     env['LINK'] = mingw_prefix + 'g++'
 162     env['AR'] = mingw_prefix + 'ar'
 163     env['RANLIB'] = mingw_prefix + 'ranlib'
 164     env['LINK'] = mingw_prefix + 'g++'
 165     env['AS'] = mingw_prefix + 'as'
 166     env['WIN32DEFPREFIX']        = ''
 167     env['WIN32DEFSUFFIX']        = '.def'
 168     env['SHOBJSUFFIX'] = '.o'
 169     env['STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME'] = 1
 170
 171     env['RC'] = mingw_prefix + 'windres'
 172     env['RCFLAGS'] = SCons.Util.CLVar('')
 173     env['RCCOM'] = '$RC $_CPPDEFFLAGS $_CPPINCFLAGS ${INCPREFIX}${SOURCE.dir} $RCFLAGS -i $SOURCE -o $TARGET'
 174     env['BUILDERS']['RES'] = res_builder
 175
 176     # Some setting from the platform also have to be overridden:
 177     env['OBJPREFIX']      = ''
 178     env['OBJSUFFIX']      = '.o'
 179     env['SHOBJPREFIX']    = '$OBJPREFIX'
 180     env['SHOBJSUFFIX']    = '$OBJSUFFIX'
 181     env['PROGPREFIX']     = ''
 182     env['PROGSUFFIX']     = '.exe'
 183     env['LIBPREFIX']      = 'lib'
 184     env['LIBSUFFIX']      = '.a'
 185     env['SHLIBPREFIX']    = ''
 186     env['SHLIBSUFFIX']    = '.dll'
 187     env['LIBPREFIXES']    = [ 'lib', '' ]
 188     env['LIBSUFFIXES']    = [ '.a', '.lib' ]
 189
 190 def exists(env):
 191     return find(env)