Accumulated documentation changes.
[scons.git] / 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     # If -d is specified on the command line, yacc will emit a .h
46     # or .hpp file as well as a .c or .cpp file, depending on whether
47     # the input file is a .y or .yy, respectively.
48     if len(source) and '-d' in SCons.Util.CLVar(env.subst("$YACCFLAGS")):
49         base, ext = os.path.splitext(SCons.Util.to_String(source[0]))
50         if ext == ysuf:
51             base, ext = os.path.splitext(SCons.Util.to_String(target[0]))
52             target.append(base + hsuf)
53     return (target, source)
54
55 def yEmitter(target, source, env):
56     return _yaccEmitter(target, source, env, '.y', '.h')
57
58 def yyEmitter(target, source, env):
59     return _yaccEmitter(target, source, env, '.yy', '.hpp')
60
61 def generate(env):
62     """Add Builders and construction variables for yacc to an Environment."""
63     c_file, cxx_file = SCons.Tool.createCFileBuilders(env)
64     
65     c_file.add_action('.y', YaccAction)
66     c_file.add_action('.yacc', YaccAction)
67     cxx_file.add_action('.yy', YaccAction)
68     c_file.add_emitter('.y', yEmitter)
69     c_file.add_emitter('.yacc', yEmitter)
70     cxx_file.add_emitter('.yy', yyEmitter)
71
72     env['YACC']      = env.Detect('bison') or 'yacc'
73     env['YACCFLAGS'] = SCons.Util.CLVar('')
74     env['YACCCOM']   = '$YACC $YACCFLAGS -o $TARGET $SOURCES'
75
76 def exists(env):
77     return env.Detect(['bison', 'yacc'])