Add some documentation to the SCons-version-switching hack
[senf.git] / scons / scons-1.2.0 / 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 (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
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__ = "src/engine/SCons/Tool/yacc.py 3842 2008/12/20 22:59:52 scons"
35
36 import os.path
37 import string
38
39 import SCons.Defaults
40 import SCons.Tool
41 import SCons.Util
42
43 YaccAction = SCons.Action.Action("$YACCCOM", "$YACCCOMSTR")
44
45 def _yaccEmitter(target, source, env, ysuf, hsuf):
46     yaccflags = env.subst("$YACCFLAGS", target=target, source=source)
47     flags = SCons.Util.CLVar(yaccflags)
48     targetBase, targetExt = os.path.splitext(SCons.Util.to_String(target[0]))
49
50     if '.ym' in ysuf:                # If using Objective-C
51         target = [targetBase + ".m"] # the extension is ".m".
52
53
54     # If -d is specified on the command line, yacc will emit a .h
55     # or .hpp file with the same name as the .c or .cpp output file.
56     if '-d' in flags:
57         target.append(targetBase + env.subst(hsuf, target=target, source=source))
58
59     # If -g is specified on the command line, yacc will emit a .vcg
60     # file with the same base name as the .y, .yacc, .ym or .yy file.
61     if "-g" in flags:
62         base, ext = os.path.splitext(SCons.Util.to_String(source[0]))
63         target.append(base + env.subst("$YACCVCGFILESUFFIX"))
64
65     # With --defines and --graph, the name of the file is totally defined
66     # in the options.
67     fileGenOptions = ["--defines=", "--graph="]
68     for option in flags:
69         for fileGenOption in fileGenOptions:
70             l = len(fileGenOption)
71             if option[:l] == fileGenOption:
72                 # A file generating option is present, so add the file
73                 # name to the list of targets.
74                 fileName = string.strip(option[l:])
75                 target.append(fileName)
76
77     return (target, source)
78
79 def yEmitter(target, source, env):
80     return _yaccEmitter(target, source, env, ['.y', '.yacc'], '$YACCHFILESUFFIX')
81
82 def ymEmitter(target, source, env):
83     return _yaccEmitter(target, source, env, ['.ym'], '$YACCHFILESUFFIX')
84
85 def yyEmitter(target, source, env):
86     return _yaccEmitter(target, source, env, ['.yy'], '$YACCHXXFILESUFFIX')
87
88 def generate(env):
89     """Add Builders and construction variables for yacc to an Environment."""
90     c_file, cxx_file = SCons.Tool.createCFileBuilders(env)
91
92     # C
93     c_file.add_action('.y', YaccAction)
94     c_file.add_emitter('.y', yEmitter)
95
96     c_file.add_action('.yacc', YaccAction)
97     c_file.add_emitter('.yacc', yEmitter)
98
99     # Objective-C
100     c_file.add_action('.ym', YaccAction)
101     c_file.add_emitter('.ym', ymEmitter)
102
103     # C++
104     cxx_file.add_action('.yy', YaccAction)
105     cxx_file.add_emitter('.yy', yyEmitter)
106
107     env['YACC']      = env.Detect('bison') or 'yacc'
108     env['YACCFLAGS'] = SCons.Util.CLVar('')
109     env['YACCCOM']   = '$YACC $YACCFLAGS -o $TARGET $SOURCES'
110     env['YACCHFILESUFFIX'] = '.h'
111
112     # Apparently, OS X now creates file.hpp like everybody else
113     # I have no idea when it changed; it was fixed in 10.4
114     #if env['PLATFORM'] == 'darwin':
115     #    # Bison on Mac OS X just appends ".h" to the generated target .cc
116     #    # or .cpp file name.  Hooray for delayed expansion of variables.
117     #    env['YACCHXXFILESUFFIX'] = '${TARGET.suffix}.h'
118     #else:
119     #    env['YACCHXXFILESUFFIX'] = '.hpp'
120     env['YACCHXXFILESUFFIX'] = '.hpp'
121
122     env['YACCVCGFILESUFFIX'] = '.vcg'
123
124 def exists(env):
125     return env.Detect(['bison', 'yacc'])