Add some documentation to the SCons-version-switching hack
[senf.git] / tools / scons-1.2.0 / engine / SCons / Tool / aixcc.py
1 """SCons.Tool.aixcc
2
3 Tool-specific initialization for IBM xlc / Visual Age C compiler.
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 (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
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__ = "src/engine/SCons/Tool/aixcc.py 3842 2008/12/20 22:59:52 scons"
34
35 import os.path
36
37 import SCons.Platform.aix
38
39 import cc
40
41 packages = ['vac.C', 'ibmcxx.cmp']
42
43 def get_xlc(env):
44     xlc = env.get('CC', 'xlc')
45     xlc_r = env.get('SHCC', 'xlc_r')
46     return SCons.Platform.aix.get_xlc(env, xlc, xlc_r, packages)
47
48 def generate(env):
49     """Add Builders and construction variables for xlc / Visual Age
50     suite to an Environment."""
51     path, _cc, _shcc, version = get_xlc(env)
52     if path:
53         _cc = os.path.join(path, _cc)
54         _shcc = os.path.join(path, _shcc)
55
56     cc.generate(env)
57
58     env['CC'] = _cc
59     env['SHCC'] = _shcc
60     env['CCVERSION'] = version
61
62 def exists(env):
63     path, _cc, _shcc, version = get_xlc(env)
64     if path and _cc:
65         xlc = os.path.join(path, _cc)
66         if os.path.exists(xlc):
67             return xlc
68     return None