src/engine/SCons/Tool/yacc.py

   1 """SCons.Tool.yacc
   2
   3 Tool-specific initialization for yacc.
   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 #
  12 # __COPYRIGHT__
  13 #
  14 # Permission is hereby granted, free of charge, to any person obtaining
  15 # a copy of this software and associated documentation files (the
  16 # "Software"), to deal in the Software without restriction, including
  17 # without limitation the rights to use, copy, modify, merge, publish,
  18 # distribute, sublicense, and/or sell copies of the Software, and to
  19 # permit persons to whom the Software is furnished to do so, subject to
  20 # the following conditions:
  21 #
  22 # The above copyright notice and this permission notice shall be included
  23 # in all copies or substantial portions of the Software.
  24 #
  25 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  26 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  27 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 #
  33
  34 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  35
  36 import os.path
  37
  38 import SCons.Defaults
  39 import SCons.Tool
  40 import SCons.Util
  41
  42 YaccAction = SCons.Action.Action("$YACCCOM", "$YACCCOMSTR")
  43
  44 def _yaccEmitter(target, source, env, ysuf, hsuf):
  45     yaccflags = env.subst("$YACCFLAGS", target=target, source=source)
  46     flags = SCons.Util.CLVar(yaccflags)
  47     targetBase, targetExt = os.path.splitext(SCons.Util.to_String(target[0]))
  48
  49     if '.ym' in ysuf:                # If using Objective-C
  50         target = [targetBase + ".m"] # the extension is ".m".
  51
  52
  53     # If -d is specified on the command line, yacc will emit a .h
  54     # or .hpp file with the same name as the .c or .cpp output file.
  55     if '-d' in flags:
  56         target.append(targetBase + env.subst(hsuf, target=target, source=source))
  57
  58     # If -g is specified on the command line, yacc will emit a .vcg
  59     # file with the same base name as the .y, .yacc, .ym or .yy file.
  60     if "-g" in flags:
  61         base, ext = os.path.splitext(SCons.Util.to_String(source[0]))
  62         target.append(base + env.subst("$YACCVCGFILESUFFIX"))
  63
  64     # With --defines and --graph, the name of the file is totally defined
  65     # in the options.
  66     fileGenOptions = ["--defines=", "--graph="]
  67     for option in flags:
  68         for fileGenOption in fileGenOptions:
  69             l = len(fileGenOption)
  70             if option[:l] == fileGenOption:
  71                 # A file generating option is present, so add the file
  72                 # name to the list of targets.
  73                 fileName = option[l:].strip()
  74                 target.append(fileName)
  75
  76     return (target, source)
  77
  78 def yEmitter(target, source, env):
  79     return _yaccEmitter(target, source, env, ['.y', '.yacc'], '$YACCHFILESUFFIX')
  80
  81 def ymEmitter(target, source, env):
  82     return _yaccEmitter(target, source, env, ['.ym'], '$YACCHFILESUFFIX')
  83
  84 def yyEmitter(target, source, env):
  85     return _yaccEmitter(target, source, env, ['.yy'], '$YACCHXXFILESUFFIX')
  86
  87 def generate(env):
  88     """Add Builders and construction variables for yacc to an Environment."""
  89     c_file, cxx_file = SCons.Tool.createCFileBuilders(env)
  90
  91     # C
  92     c_file.add_action('.y', YaccAction)
  93     c_file.add_emitter('.y', yEmitter)
  94
  95     c_file.add_action('.yacc', YaccAction)
  96     c_file.add_emitter('.yacc', yEmitter)
  97
  98     # Objective-C
  99     c_file.add_action('.ym', YaccAction)
 100     c_file.add_emitter('.ym', ymEmitter)
 101
 102     # C++
 103     cxx_file.add_action('.yy', YaccAction)
 104     cxx_file.add_emitter('.yy', yyEmitter)
 105
 106     env['YACC']      = env.Detect('bison') or 'yacc'
 107     env['YACCFLAGS'] = SCons.Util.CLVar('')
 108     env['YACCCOM']   = '$YACC $YACCFLAGS -o $TARGET $SOURCES'
 109     env['YACCHFILESUFFIX'] = '.h'
 110
 111     # Apparently, OS X now creates file.hpp like everybody else
 112     # I have no idea when it changed; it was fixed in 10.4
 113     #if env['PLATFORM'] == 'darwin':
 114     #    # Bison on Mac OS X just appends ".h" to the generated target .cc
 115     #    # or .cpp file name.  Hooray for delayed expansion of variables.
 116     #    env['YACCHXXFILESUFFIX'] = '${TARGET.suffix}.h'
 117     #else:
 118     #    env['YACCHXXFILESUFFIX'] = '.hpp'
 119     env['YACCHXXFILESUFFIX'] = '.hpp'
 120
 121     env['YACCVCGFILESUFFIX'] = '.vcg'
 122
 123 def exists(env):
 124     return env.Detect(['bison', 'yacc'])
 125
 126 # Local Variables:
 127 # tab-width:4
 128 # indent-tabs-mode:nil
 129 # End:
 130 # vim: set expandtab tabstop=4 shiftwidth=4: