Add Framework support for Mac OS X. (Greg Noel) Document it. (Gary Oberbrunner)
[scons.git] / src / engine / SCons / Tool / link.py
1 """SCons.Tool.link
2
3 Tool-specific initialization for the generic Posix linker.
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 SCons.Defaults
37 import SCons.Tool
38 import SCons.Util
39
40 cplusplus = __import__('c++', globals(), locals(), [])
41
42 def smart_link(source, target, env, for_signature):
43     if cplusplus.iscplusplus(source):
44         return '$CXX'
45     return '$CC'
46
47 def generate(env):
48     """Add Builders and construction variables for gnulink to an Environment."""
49     SCons.Tool.createSharedLibBuilder(env)
50     SCons.Tool.createProgBuilder(env)
51     
52     env['SHLINK']      = '$LINK'
53     env['SHLINKFLAGS'] = SCons.Util.CLVar('$LINKFLAGS -shared')
54     env['SHLINKCOM']   = '$SHLINK -o $TARGET $SHLINKFLAGS $SOURCES $_LIBDIRFLAGS $_LIBFLAGS'
55     # don't set up the emitter, cause AppendUnique will generate a list
56     # starting with None :-(
57     #env['SHLIBEMITTER']= None
58     env['SMARTLINK']   = smart_link
59     env['LINK']        = "$SMARTLINK"
60     env['LINKFLAGS']   = SCons.Util.CLVar('')
61     env['LINKCOM']     = '$LINK -o $TARGET $LINKFLAGS $SOURCES $_LIBDIRFLAGS $_LIBFLAGS'
62     env['LIBDIRPREFIX']='-L'
63     env['LIBDIRSUFFIX']=''
64     env['_LIBFLAGS']='${_stripixes(LIBLINKPREFIX, LIBS, LIBLINKSUFFIX, LIBPREFIX, LIBSUFFIX, __env__)}'
65     env['LIBLINKPREFIX']='-l'
66     env['LIBLINKSUFFIX']=''
67
68     if env['PLATFORM'] == 'hpux':
69         env['SHLIBSUFFIX'] = '.sl'
70     elif env['PLATFORM'] == 'aix':
71         env['SHLIBSUFFIX'] = '.a'
72
73     # For most platforms, a loadable module is the same as a shared
74     # library.  Platforms which are different can override these, but
75     # setting them the same means that LoadableModule works everywhere.
76     SCons.Tool.createLoadableModuleBuilder(env)
77     env['LDMODULE'] = '$SHLINK'
78     env['LDMODULEPREFIX'] = '$SHLIBPREFIX' 
79     env['LDMODULESUFFIX'] = '$SHLIBSUFFIX' 
80     env['LDMODULEFLAGS'] = '$SHLINKFLAGS'
81     env['LDMODULECOM'] = '$SHLINKCOM'
82
83
84
85 def exists(env):
86     # This module isn't really a Tool on its own, it's common logic for
87     # other linkers.
88     return None