342 lines
14 KiB
Python
342 lines
14 KiB
Python
|
# MIT License
|
||
|
|
#
|
||
|
|
# Copyright The SCons Foundation
|
||
|
|
#
|
||
|
|
# Permission is hereby granted, free of charge, to any person obtaining
|
||
|
|
# a copy of this software and associated documentation files (the
|
||
|
|
# "Software"), to deal in the Software without restriction, including
|
||
|
|
# without limitation the rights to use, copy, modify, merge, publish,
|
||
|
|
# distribute, sublicense, and/or sell copies of the Software, and to
|
||
|
|
# permit persons to whom the Software is furnished to do so, subject to
|
||
|
|
# the following conditions:
|
||
|
|
#
|
||
|
|
# The above copyright notice and this permission notice shall be included
|
||
|
|
# in all copies or substantial portions of the Software.
|
||
|
|
#
|
||
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
|
||
|
|
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
|
||
|
|
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||
|
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||
|
|
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||
|
|
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||
|
|
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||
|
|
|
||
|
|
"""SCons.Tool.mslink
|
||
|
|
|
||
|
|
Tool-specific initialization for the Microsoft linker.
|
||
|
|
|
||
|
|
There normally shouldn't be any need to import this module directly.
|
||
|
|
It will usually be imported through the generic SCons.Tool.Tool()
|
||
|
|
selection method.
|
||
|
|
|
||
|
|
"""
|
||
|
|
|
||
|
|
import os
|
||
|
|
import os.path
|
||
|
|
|
||
|
|
import SCons.Action
|
||
|
|
import SCons.Defaults
|
||
|
|
import SCons.Errors
|
||
|
|
import SCons.Platform.win32
|
||
|
|
import SCons.Tool
|
||
|
|
import SCons.Tool.msvc
|
||
|
|
import SCons.Tool.msvs
|
||
|
|
import SCons.Util
|
||
|
|
|
||
|
|
from .MSCommon import msvc_setup_env_once, msvc_setup_env_tool
|
||
|
|
from .MSCommon.common import get_pch_node
|
||
|
|
|
||
|
|
tool_name = 'mslink'
|
||
|
|
|
||
|
|
def pdbGenerator(env, target, source, for_signature):
|
||
|
|
try:
|
||
|
|
return ['/PDB:%s' % target[0].attributes.pdb, '/DEBUG']
|
||
|
|
except (AttributeError, IndexError):
|
||
|
|
return None
|
||
|
|
|
||
|
|
def _dllTargets(target, source, env, for_signature, paramtp):
|
||
|
|
listCmd = []
|
||
|
|
dll = env.FindIxes(target, '%sPREFIX' % paramtp, '%sSUFFIX' % paramtp)
|
||
|
|
if dll: listCmd.append("/out:%s"%dll.get_string(for_signature))
|
||
|
|
|
||
|
|
implib = env.FindIxes(target, 'LIBPREFIX', 'LIBSUFFIX')
|
||
|
|
if implib: listCmd.append("/implib:%s"%implib.get_string(for_signature))
|
||
|
|
|
||
|
|
return listCmd
|
||
|
|
|
||
|
|
def _dllSources(target, source, env, for_signature, paramtp):
|
||
|
|
listCmd = []
|
||
|
|
|
||
|
|
deffile = env.FindIxes(source, "WINDOWSDEFPREFIX", "WINDOWSDEFSUFFIX")
|
||
|
|
for src in source:
|
||
|
|
# Check explicitly for a non-None deffile so that the __cmp__
|
||
|
|
# method of the base SCons.Util.Proxy class used for some Node
|
||
|
|
# proxies doesn't try to use a non-existent __dict__ attribute.
|
||
|
|
if deffile and src == deffile:
|
||
|
|
# Treat this source as a .def file.
|
||
|
|
listCmd.append("/def:%s" % src.get_string(for_signature))
|
||
|
|
else:
|
||
|
|
# Just treat it as a generic source file.
|
||
|
|
listCmd.append(src)
|
||
|
|
return listCmd
|
||
|
|
|
||
|
|
def windowsShlinkTargets(target, source, env, for_signature):
|
||
|
|
return _dllTargets(target, source, env, for_signature, 'SHLIB')
|
||
|
|
|
||
|
|
def windowsShlinkSources(target, source, env, for_signature):
|
||
|
|
return _dllSources(target, source, env, for_signature, 'SHLIB')
|
||
|
|
|
||
|
|
def _windowsLdmodTargets(target, source, env, for_signature):
|
||
|
|
"""Get targets for loadable modules."""
|
||
|
|
return _dllTargets(target, source, env, for_signature, 'LDMODULE')
|
||
|
|
|
||
|
|
def _windowsLdmodSources(target, source, env, for_signature):
|
||
|
|
"""Get sources for loadable modules."""
|
||
|
|
return _dllSources(target, source, env, for_signature, 'LDMODULE')
|
||
|
|
|
||
|
|
def _dllEmitter(target, source, env, paramtp):
|
||
|
|
"""Common implementation of dll emitter."""
|
||
|
|
SCons.Tool.msvc.validate_vars(env)
|
||
|
|
|
||
|
|
extratargets = []
|
||
|
|
extrasources = []
|
||
|
|
|
||
|
|
dll = env.FindIxes(target, '%sPREFIX' % paramtp, '%sSUFFIX' % paramtp)
|
||
|
|
no_import_lib = env.get('no_import_lib', 0)
|
||
|
|
|
||
|
|
if not dll:
|
||
|
|
raise SCons.Errors.UserError('A shared library should have exactly one target with the suffix: %s' % env.subst('$%sSUFFIX' % paramtp))
|
||
|
|
|
||
|
|
insert_def = env.subst("$WINDOWS_INSERT_DEF")
|
||
|
|
if insert_def not in ['', '0', 0] and \
|
||
|
|
not env.FindIxes(source, "WINDOWSDEFPREFIX", "WINDOWSDEFSUFFIX"):
|
||
|
|
|
||
|
|
# append a def file to the list of sources
|
||
|
|
extrasources.append(
|
||
|
|
env.ReplaceIxes(dll,
|
||
|
|
'%sPREFIX' % paramtp, '%sSUFFIX' % paramtp,
|
||
|
|
"WINDOWSDEFPREFIX", "WINDOWSDEFSUFFIX"))
|
||
|
|
|
||
|
|
version_num, suite = SCons.Tool.msvs.msvs_parse_version(env.get('MSVS_VERSION', '6.0'))
|
||
|
|
if version_num >= 8.0 and \
|
||
|
|
(env.get('WINDOWS_INSERT_MANIFEST', 0) or env.get('WINDOWS_EMBED_MANIFEST', 0)):
|
||
|
|
# MSVC 8 and above automatically generate .manifest files that must be installed
|
||
|
|
extratargets.append(
|
||
|
|
env.ReplaceIxes(dll,
|
||
|
|
'%sPREFIX' % paramtp, '%sSUFFIX' % paramtp,
|
||
|
|
"WINDOWSSHLIBMANIFESTPREFIX", "WINDOWSSHLIBMANIFESTSUFFIX"))
|
||
|
|
|
||
|
|
if 'PDB' in env and env['PDB']:
|
||
|
|
pdb = env.arg2nodes('$PDB', target=target, source=source)[0]
|
||
|
|
extratargets.append(pdb)
|
||
|
|
target[0].attributes.pdb = pdb
|
||
|
|
|
||
|
|
pch_node = get_pch_node(env, target, source)
|
||
|
|
if version_num >= 11.0 and pch_node:
|
||
|
|
# MSVC 11 and above need the PCH object file to be added to the link line,
|
||
|
|
# otherwise you get link error LNK2011.
|
||
|
|
pchobj = SCons.Util.splitext(str(pch_node))[0] + '.obj'
|
||
|
|
# print "prog_emitter, version %s, appending pchobj %s"%(version_num, pchobj)
|
||
|
|
if pchobj not in extrasources:
|
||
|
|
extrasources.append(pchobj)
|
||
|
|
|
||
|
|
if not no_import_lib and \
|
||
|
|
not env.FindIxes(target, "LIBPREFIX", "LIBSUFFIX"):
|
||
|
|
# Append an import library to the list of targets.
|
||
|
|
extratargets.append(
|
||
|
|
env.ReplaceIxes(dll,
|
||
|
|
'%sPREFIX' % paramtp, '%sSUFFIX' % paramtp,
|
||
|
|
"LIBPREFIX", "LIBSUFFIX"))
|
||
|
|
# and .exp file is created if there are exports from a DLL
|
||
|
|
extratargets.append(
|
||
|
|
env.ReplaceIxes(dll,
|
||
|
|
'%sPREFIX' % paramtp, '%sSUFFIX' % paramtp,
|
||
|
|
"WINDOWSEXPPREFIX", "WINDOWSEXPSUFFIX"))
|
||
|
|
|
||
|
|
return (target+extratargets, source+extrasources)
|
||
|
|
|
||
|
|
def windowsLibEmitter(target, source, env):
|
||
|
|
return _dllEmitter(target, source, env, 'SHLIB')
|
||
|
|
|
||
|
|
def ldmodEmitter(target, source, env):
|
||
|
|
"""Emitter for loadable modules.
|
||
|
|
|
||
|
|
Loadable modules are identical to shared libraries on Windows, but building
|
||
|
|
them is subject to different parameters (LDMODULE*).
|
||
|
|
"""
|
||
|
|
return _dllEmitter(target, source, env, 'LDMODULE')
|
||
|
|
|
||
|
|
def prog_emitter(target, source, env):
|
||
|
|
SCons.Tool.msvc.validate_vars(env)
|
||
|
|
|
||
|
|
extratargets = []
|
||
|
|
extrasources = []
|
||
|
|
|
||
|
|
exe = env.FindIxes(target, "PROGPREFIX", "PROGSUFFIX")
|
||
|
|
if not exe:
|
||
|
|
raise SCons.Errors.UserError("An executable should have exactly one target with the suffix: %s" % env.subst("$PROGSUFFIX"))
|
||
|
|
|
||
|
|
version_num, suite = SCons.Tool.msvs.msvs_parse_version(env.get('MSVS_VERSION', '6.0'))
|
||
|
|
if version_num >= 8.0 and \
|
||
|
|
(env.get('WINDOWS_INSERT_MANIFEST', 0) or env.get('WINDOWS_EMBED_MANIFEST', 0)):
|
||
|
|
# MSVC 8 and above automatically generate .manifest files that have to be installed
|
||
|
|
extratargets.append(
|
||
|
|
env.ReplaceIxes(exe,
|
||
|
|
"PROGPREFIX", "PROGSUFFIX",
|
||
|
|
"WINDOWSPROGMANIFESTPREFIX", "WINDOWSPROGMANIFESTSUFFIX"))
|
||
|
|
|
||
|
|
if 'PDB' in env and env['PDB']:
|
||
|
|
pdb = env.arg2nodes('$PDB', target=target, source=source)[0]
|
||
|
|
extratargets.append(pdb)
|
||
|
|
target[0].attributes.pdb = pdb
|
||
|
|
|
||
|
|
pch_node = get_pch_node(env, target, source)
|
||
|
|
if version_num >= 11.0 and pch_node:
|
||
|
|
# MSVC 11 and above need the PCH object file to be added to the link line,
|
||
|
|
# otherwise you get link error LNK2011.
|
||
|
|
pchobj = SCons.Util.splitext(str(pch_node))[0] + '.obj'
|
||
|
|
# print "prog_emitter, version %s, appending pchobj %s"%(version_num, pchobj)
|
||
|
|
if pchobj not in extrasources:
|
||
|
|
extrasources.append(pchobj)
|
||
|
|
|
||
|
|
return (target+extratargets,source+extrasources)
|
||
|
|
|
||
|
|
def RegServerFunc(target, source, env):
|
||
|
|
if 'register' in env and env['register']:
|
||
|
|
ret = regServerAction([target[0]], [source[0]], env)
|
||
|
|
if ret:
|
||
|
|
raise SCons.Errors.UserError("Unable to register %s" % target[0])
|
||
|
|
else:
|
||
|
|
print("Registered %s sucessfully" % target[0])
|
||
|
|
return ret
|
||
|
|
return 0
|
||
|
|
|
||
|
|
# These are the actual actions run to embed the manifest.
|
||
|
|
# They are only called from the Check versions below.
|
||
|
|
embedManifestExeAction = SCons.Action.Action('$MTEXECOM')
|
||
|
|
embedManifestDllAction = SCons.Action.Action('$MTSHLIBCOM')
|
||
|
|
|
||
|
|
def embedManifestDllCheck(target, source, env):
|
||
|
|
"""Function run by embedManifestDllCheckAction to check for existence of manifest
|
||
|
|
and other conditions, and embed the manifest by calling embedManifestDllAction if so."""
|
||
|
|
if env.get('WINDOWS_EMBED_MANIFEST', 0):
|
||
|
|
manifestSrc = target[0].get_abspath() + '.manifest'
|
||
|
|
if os.path.exists(manifestSrc):
|
||
|
|
ret = embedManifestDllAction([target[0]], None, env)
|
||
|
|
if ret:
|
||
|
|
raise SCons.Errors.UserError("Unable to embed manifest into %s" % (target[0]))
|
||
|
|
return ret
|
||
|
|
else:
|
||
|
|
print('(embed: no %s.manifest found; not embedding.)'%str(target[0]))
|
||
|
|
return 0
|
||
|
|
|
||
|
|
def embedManifestExeCheck(target, source, env):
|
||
|
|
"""Function run by embedManifestExeCheckAction to check for existence of manifest
|
||
|
|
and other conditions, and embed the manifest by calling embedManifestExeAction if so."""
|
||
|
|
if env.get('WINDOWS_EMBED_MANIFEST', 0):
|
||
|
|
manifestSrc = target[0].get_abspath() + '.manifest'
|
||
|
|
if os.path.exists(manifestSrc):
|
||
|
|
ret = embedManifestExeAction([target[0]], None, env)
|
||
|
|
if ret:
|
||
|
|
raise SCons.Errors.UserError("Unable to embed manifest into %s" % (target[0]))
|
||
|
|
return ret
|
||
|
|
else:
|
||
|
|
print('(embed: no %s.manifest found; not embedding.)'%str(target[0]))
|
||
|
|
return 0
|
||
|
|
|
||
|
|
embedManifestDllCheckAction = SCons.Action.Action(embedManifestDllCheck, None)
|
||
|
|
embedManifestExeCheckAction = SCons.Action.Action(embedManifestExeCheck, None)
|
||
|
|
|
||
|
|
regServerAction = SCons.Action.Action("$REGSVRCOM", "$REGSVRCOMSTR")
|
||
|
|
regServerCheck = SCons.Action.Action(RegServerFunc, None)
|
||
|
|
shlibLinkAction = SCons.Action.Action('${TEMPFILE("$SHLINK $SHLINKFLAGS $_SHLINK_TARGETS $_LIBDIRFLAGS $_LIBFLAGS $_PDB $_SHLINK_SOURCES", "$SHLINKCOMSTR")}', '$SHLINKCOMSTR')
|
||
|
|
compositeShLinkAction = shlibLinkAction + regServerCheck + embedManifestDllCheckAction
|
||
|
|
ldmodLinkAction = SCons.Action.Action('${TEMPFILE("$LDMODULE $LDMODULEFLAGS $_LDMODULE_TARGETS $_LIBDIRFLAGS $_LIBFLAGS $_PDB $_LDMODULE_SOURCES", "$LDMODULECOMSTR")}', '$LDMODULECOMSTR')
|
||
|
|
compositeLdmodAction = ldmodLinkAction + regServerCheck + embedManifestDllCheckAction
|
||
|
|
exeLinkAction = SCons.Action.Action('${TEMPFILE("$LINK $LINKFLAGS /OUT:$TARGET.windows $_LIBDIRFLAGS $_LIBFLAGS $_PDB $SOURCES.windows", "$LINKCOMSTR")}', '$LINKCOMSTR')
|
||
|
|
compositeLinkAction = exeLinkAction + embedManifestExeCheckAction
|
||
|
|
|
||
|
|
def generate(env):
|
||
|
|
"""Add Builders and construction variables for ar to an Environment."""
|
||
|
|
SCons.Tool.createSharedLibBuilder(env, shlib_suffix='$SHLIBSUFFIX')
|
||
|
|
SCons.Tool.createProgBuilder(env)
|
||
|
|
|
||
|
|
env['SHLINK'] = '$LINK'
|
||
|
|
env['SHLINKFLAGS'] = SCons.Util.CLVar('$LINKFLAGS /dll')
|
||
|
|
env['_SHLINK_TARGETS'] = windowsShlinkTargets
|
||
|
|
env['_SHLINK_SOURCES'] = windowsShlinkSources
|
||
|
|
env['SHLINKCOM'] = compositeShLinkAction
|
||
|
|
env.Append(SHLIBEMITTER=[windowsLibEmitter])
|
||
|
|
env.Append(LDMODULEEMITTER=[windowsLibEmitter])
|
||
|
|
env['LINK'] = 'link'
|
||
|
|
env['LINKFLAGS'] = SCons.Util.CLVar('/nologo')
|
||
|
|
env['_PDB'] = pdbGenerator
|
||
|
|
env['LINKCOM'] = compositeLinkAction
|
||
|
|
env.Append(PROGEMITTER=[prog_emitter])
|
||
|
|
env['LIBDIRPREFIX'] = '/LIBPATH:'
|
||
|
|
env['LIBDIRSUFFIX'] = ''
|
||
|
|
env['LIBLINKPREFIX'] = ''
|
||
|
|
env['LIBLINKSUFFIX'] = '$LIBSUFFIX'
|
||
|
|
|
||
|
|
env['WINDOWSDEFPREFIX'] = ''
|
||
|
|
env['WINDOWSDEFSUFFIX'] = '.def'
|
||
|
|
env['WINDOWSEXPPREFIX'] = ''
|
||
|
|
env['WINDOWSEXPSUFFIX'] = '.exp'
|
||
|
|
env['WINDOWS_INSERT_DEF'] = 0
|
||
|
|
|
||
|
|
env['WINDOWSSHLIBMANIFESTPREFIX'] = ''
|
||
|
|
env['WINDOWSSHLIBMANIFESTSUFFIX'] = '${SHLIBSUFFIX}.manifest'
|
||
|
|
env['WINDOWSPROGMANIFESTPREFIX'] = ''
|
||
|
|
env['WINDOWSPROGMANIFESTSUFFIX'] = '${PROGSUFFIX}.manifest'
|
||
|
|
|
||
|
|
env['REGSVRACTION'] = regServerCheck
|
||
|
|
env['REGSVR'] = os.path.join(
|
||
|
|
SCons.Platform.win32.get_system_root(), 'System32', 'regsvr32'
|
||
|
|
)
|
||
|
|
env['REGSVRFLAGS'] = '/s '
|
||
|
|
env['REGSVRCOM'] = '$REGSVR $REGSVRFLAGS ${TARGET.windows}'
|
||
|
|
|
||
|
|
env['WINDOWS_EMBED_MANIFEST'] = 0
|
||
|
|
env['MT'] = 'mt'
|
||
|
|
# env['MTFLAGS'] = ['-hashupdate']
|
||
|
|
env['MTFLAGS'] = SCons.Util.CLVar('/nologo')
|
||
|
|
# Note: use - here to prevent build failure if no manifest produced.
|
||
|
|
# This seems much simpler than a fancy system using a function action to see
|
||
|
|
# if the manifest actually exists before trying to run mt with it.
|
||
|
|
env['MTEXECOM'] = '-$MT $MTFLAGS -manifest ${TARGET}.manifest $_MANIFEST_SOURCES -outputresource:$TARGET;1'
|
||
|
|
env['MTSHLIBCOM'] = '-$MT $MTFLAGS -manifest ${TARGET}.manifest $_MANIFEST_SOURCES -outputresource:$TARGET;2'
|
||
|
|
# TODO Future work garyo 27-Feb-11
|
||
|
|
env['_MANIFEST_SOURCES'] = None # _windowsManifestSources
|
||
|
|
|
||
|
|
# Set-up ms tools paths
|
||
|
|
msvc_setup_env_once(env, tool=tool_name)
|
||
|
|
|
||
|
|
# Loadable modules are on Windows the same as shared libraries, but they
|
||
|
|
# are subject to different build parameters (LDMODULE* variables).
|
||
|
|
# Therefore LDMODULE* variables correspond as much as possible to
|
||
|
|
# SHLINK*/SHLIB* ones.
|
||
|
|
SCons.Tool.createLoadableModuleBuilder(env, loadable_module_suffix='$LDMODULESUFFIX')
|
||
|
|
env['LDMODULE'] = '$SHLINK'
|
||
|
|
env['LDMODULEPREFIX'] = '$SHLIBPREFIX'
|
||
|
|
env['LDMODULESUFFIX'] = '$SHLIBSUFFIX'
|
||
|
|
env['LDMODULEFLAGS'] = '$SHLINKFLAGS'
|
||
|
|
env['_LDMODULE_TARGETS'] = _windowsLdmodTargets
|
||
|
|
env['_LDMODULE_SOURCES'] = _windowsLdmodSources
|
||
|
|
env['LDMODULEEMITTER'] = [ldmodEmitter]
|
||
|
|
env['LDMODULECOM'] = compositeLdmodAction
|
||
|
|
|
||
|
|
# Issue #3350
|
||
|
|
# Change tempfile argument joining character from a space to a newline
|
||
|
|
# mslink will fail if any single line is too long, but is fine with many lines
|
||
|
|
# in a tempfile
|
||
|
|
env['TEMPFILEARGJOIN'] = os.linesep
|
||
|
|
|
||
|
|
def exists(env):
|
||
|
|
return msvc_setup_env_tool(env, tool=tool_name)
|
||
|
|
|
||
|
|
# Local Variables:
|
||
|
|
# tab-width:4
|
||
|
|
# indent-tabs-mode:nil
|
||
|
|
# End:
|
||
|
|
# vim: set expandtab tabstop=4 shiftwidth=4:
|