SCons/Tool/cc.py

   1 """SCons.Tool.cc
   2
   3 Tool-specific initialization for generic Posix C compilers.
   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
  10 #
  11 # __COPYRIGHT__
  12 #
  13 # Permission is hereby granted, free of charge, to any person obtaining
  14 # a copy of this software and associated documentation files (the
  15 # "Software"), to deal in the Software without restriction, including
  16 # without limitation the rights to use, copy, modify, merge, publish,
  17 # distribute, sublicense, and/or sell copies of the Software, and to
  18 # permit persons to whom the Software is furnished to do so, subject to
  19 # the following conditions:
  20 #
  21 # The above copyright notice and this permission notice shall be included
  22 # in all copies or substantial portions of the Software.
  23 #
  24 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  25 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  26 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 #
  32
  33 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  34
  35 import SCons.Tool
  36 import SCons.Defaults
  37 import SCons.Util
  38
  39 CSuffixes = ['.c', '.m']
  40 if not SCons.Util.case_sensitive_suffixes('.c', '.C'):
  41     CSuffixes.append('.C')
  42
  43 def add_common_cc_variables(env) -> None:
  44     """
  45     Add underlying common "C compiler" variables that
  46     are used by multiple tools (specifically, c++).
  47     """
  48     if '_CCCOMCOM' not in env:
  49         env['_CCCOMCOM'] = '$CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS'
  50         # It's a hack to test for darwin here, but the alternative
  51         # of creating an applecc.py to contain this seems overkill.
  52         # Maybe someday the Apple platform will require more setup and
  53         # this logic will be moved.
  54         env['FRAMEWORKS'] = SCons.Util.CLVar('')
  55         env['FRAMEWORKPATH'] = SCons.Util.CLVar('')
  56         if env['PLATFORM'] == 'darwin':
  57             env['_CCCOMCOM'] = env['_CCCOMCOM'] + ' $_FRAMEWORKPATH'
  58
  59     if 'CCFLAGS' not in env:
  60         env['CCFLAGS']   = SCons.Util.CLVar('')
  61
  62     if 'SHCCFLAGS' not in env:
  63         env['SHCCFLAGS'] = SCons.Util.CLVar('$CCFLAGS')
  64
  65 compilers = ['cc']
  66
  67 def generate(env) -> None:
  68     """
  69     Add Builders and construction variables for C compilers to an Environment.
  70     """
  71     static_obj, shared_obj = SCons.Tool.createObjBuilders(env)
  72
  73     for suffix in CSuffixes:
  74         static_obj.add_action(suffix, SCons.Defaults.CAction)
  75         shared_obj.add_action(suffix, SCons.Defaults.ShCAction)
  76         static_obj.add_emitter(suffix, SCons.Defaults.StaticObjectEmitter)
  77         shared_obj.add_emitter(suffix, SCons.Defaults.SharedObjectEmitter)
  78
  79     add_common_cc_variables(env)
  80
  81     if 'CC' not in env:
  82         env['CC']    = env.Detect(compilers) or compilers[0]
  83     env['CFLAGS']    = SCons.Util.CLVar('')
  84     env['CCCOM']     = '$CC -o $TARGET -c $CFLAGS $CCFLAGS $_CCCOMCOM $SOURCES'
  85     env['SHCC']      = '$CC'
  86     env['SHCFLAGS'] = SCons.Util.CLVar('$CFLAGS')
  87     env['SHCCCOM']   = '$SHCC -o $TARGET -c $SHCFLAGS $SHCCFLAGS $_CCCOMCOM $SOURCES'
  88
  89     env['CPPDEFPREFIX']  = '-D'
  90     env['CPPDEFSUFFIX']  = ''
  91     env['INCPREFIX']  = '-I'
  92     env['INCSUFFIX']  = ''
  93     env['SHOBJSUFFIX'] = '.os'
  94     env['STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME'] = 0
  95
  96     env['CFILESUFFIX'] = '.c'
  97
  98 def exists(env):
  99     return env.Detect(env.get('CC', compilers))
 100
 101 # Local Variables:
 102 # tab-width:4
 103 # indent-tabs-mode:nil
 104 # End:
 105 # vim: set expandtab tabstop=4 shiftwidth=4: