Add some documentation to the SCons-version-switching hack
[senf.git] / scons / scons-1.2.0 / engine / SCons / Tool / mslib.py
1 """SCons.Tool.mslib
2
3 Tool-specific initialization for lib (MicroSoft library archiver).
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/mslib.py 3842 2008/12/20 22:59:52 scons"
35
36 import SCons.Defaults
37 import SCons.Tool
38 import SCons.Tool.msvs
39 import SCons.Tool.msvc
40 import SCons.Util
41
42 def generate(env):
43     """Add Builders and construction variables for lib to an Environment."""
44     SCons.Tool.createStaticLibBuilder(env)
45
46     try:
47         version = SCons.Tool.msvs.get_default_visualstudio_version(env)
48
49         if env.has_key('MSVS_IGNORE_IDE_PATHS') and env['MSVS_IGNORE_IDE_PATHS']:
50             include_path, lib_path, exe_path = SCons.Tool.msvc.get_msvc_default_paths(env,version)
51         else:
52             include_path, lib_path, exe_path = SCons.Tool.msvc.get_msvc_paths(env,version)
53
54         # since other tools can set this, we just make sure that the
55         # relevant stuff from MSVS is in there somewhere.
56         env.PrependENVPath('PATH', exe_path)
57     except (SCons.Util.RegError, SCons.Errors.InternalError):
58         pass
59
60     env['AR']          = 'lib'
61     env['ARFLAGS']     = SCons.Util.CLVar('/nologo')
62     env['ARCOM']       = "${TEMPFILE('$AR $ARFLAGS /OUT:$TARGET $SOURCES')}"
63     env['LIBPREFIX']   = ''
64     env['LIBSUFFIX']   = '.lib'
65
66 def exists(env):
67     try:
68         v = SCons.Tool.msvs.get_visualstudio_versions()
69     except (SCons.Util.RegError, SCons.Errors.InternalError):
70         pass
71
72     if not v:
73         return env.Detect('lib')
74     else:
75         # there's at least one version of MSVS installed.
76         return 1