Move 2.0 changes collected in branches/pending back to trunk for further
[scons.git] / src / engine / SCons / Tool / lex.py
1 """SCons.Tool.lex
2
3 Tool-specific initialization for lex.
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.Action
39 import SCons.Tool
40 import SCons.Util
41
42 LexAction = SCons.Action.Action("$LEXCOM", "$LEXCOMSTR")
43
44 def lexEmitter(target, source, env):
45     sourceBase, sourceExt = os.path.splitext(SCons.Util.to_String(source[0]))
46
47     if sourceExt == ".lm":           # If using Objective-C
48         target = [sourceBase + ".m"] # the extension is ".m".
49
50     # This emitter essentially tries to add to the target all extra
51     # files generated by flex.
52
53     # Different options that are used to trigger the creation of extra files.
54     fileGenOptions = ["--header-file=", "--tables-file="]
55
56     lexflags = env.subst("$LEXFLAGS", target=target, source=source)
57     for option in SCons.Util.CLVar(lexflags):
58         for fileGenOption in fileGenOptions:
59             l = len(fileGenOption)
60             if option[:l] == fileGenOption:
61                 # A file generating option is present, so add the
62                 # file name to the target list.
63                 fileName = option[l:].strip()
64                 target.append(fileName)
65     return (target, source)
66
67 def generate(env):
68     """Add Builders and construction variables for lex to an Environment."""
69     c_file, cxx_file = SCons.Tool.createCFileBuilders(env)
70
71     # C
72     c_file.add_action(".l", LexAction)
73     c_file.add_emitter(".l", lexEmitter)
74
75     c_file.add_action(".lex", LexAction)
76     c_file.add_emitter(".lex", lexEmitter)
77
78     # Objective-C
79     cxx_file.add_action(".lm", LexAction)
80     cxx_file.add_emitter(".lm", lexEmitter)
81
82     # C++
83     cxx_file.add_action(".ll", LexAction)
84     cxx_file.add_emitter(".ll", lexEmitter)
85
86     env["LEX"]      = env.Detect("flex") or "lex"
87     env["LEXFLAGS"] = SCons.Util.CLVar("")
88     env["LEXCOM"] = "$LEX $LEXFLAGS -t $SOURCES > $TARGET"
89
90 def exists(env):
91     return env.Detect(["flex", "lex"])
92
93 # Local Variables:
94 # tab-width:4
95 # indent-tabs-mode:nil
96 # End:
97 # vim: set expandtab tabstop=4 shiftwidth=4: