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__
  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
  37
  38 import SCons.Defaults
  39 import SCons.Tool
  40 import SCons.Tool.msvs
  41 import SCons.Tool.msvc
  42 import SCons.Util
  43
  44 from SCons.Tool.MSCommon import (
  45     msvc_setup_env_tool,
  46     msvc_setup_env_once,
  47 )
  48
  49 tool_name = 'mslib'
  50
  51 def generate(env) -> None:
  52     """Add Builders and construction variables for lib to an Environment."""
  53     SCons.Tool.createStaticLibBuilder(env)
  54
  55     # Set-up ms tools paths
  56     msvc_setup_env_once(env, tool=tool_name)
  57
  58     env['AR']          = 'lib'
  59     env['ARFLAGS']     = SCons.Util.CLVar('/nologo')
  60     env['ARCOM']       = "${TEMPFILE('$AR $ARFLAGS /OUT:$TARGET $SOURCES','$ARCOMSTR')}"
  61     env['LIBPREFIX']   = ''
  62     env['LIBSUFFIX']   = '.lib'
  63
  64     # Issue #3350
  65     # Change tempfile argument joining character from a space to a newline
  66     # mslink will fail if any single line is too long, but is fine with many lines
  67     # in a tempfile
  68     env['TEMPFILEARGJOIN'] = os.linesep
  69
  70
  71 def exists(env):
  72     return msvc_setup_env_tool(env, tool=tool_name)
  73
  74 # Local Variables:
  75 # tab-width:4
  76 # indent-tabs-mode:nil
  77 # End:
  78 # vim: set expandtab tabstop=4 shiftwidth=4: