327 lines
13 KiB
Python
327 lines
13 KiB
Python
"""SCons.Platform.win32
|
|
|
|
Platform-specific initialization for Win32 systems.
|
|
|
|
There normally shouldn't be any need to import this module directly. It
|
|
will usually be imported through the generic SCons.Platform.Platform()
|
|
selection method.
|
|
"""
|
|
|
|
#
|
|
# Copyright (c) 2001, 2002, 2003, 2004 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.
|
|
#
|
|
|
|
__revision__ = "/home/scons/scons/branch.0/baseline/src/engine/SCons/Platform/win32.py 0.96.1.D001 2004/08/23 09:55:29 knight"
|
|
|
|
import os
|
|
import os.path
|
|
import string
|
|
import sys
|
|
import tempfile
|
|
from SCons.Platform.posix import exitvalmap
|
|
|
|
# XXX See note below about why importing SCons.Action should be
|
|
# eventually refactored.
|
|
import SCons.Action
|
|
import SCons.Util
|
|
|
|
class TempFileMunge:
|
|
"""A callable class. You can set an Environment variable to this,
|
|
then call it with a string argument, then it will perform temporary
|
|
file substitution on it. This is used to circumvent the win32 long command
|
|
line limitation.
|
|
|
|
Example usage:
|
|
env["TEMPFILE"] = TempFileMunge
|
|
env["LINKCOM"] = "${TEMPFILE('$LINK $TARGET $SOURCES')}"
|
|
"""
|
|
def __init__(self, cmd):
|
|
self.cmd = cmd
|
|
|
|
def __call__(self, target, source, env, for_signature):
|
|
if for_signature:
|
|
return self.cmd
|
|
cmd = env.subst_list(self.cmd, 0, target, source)[0]
|
|
try:
|
|
maxline = int(env.subst('$MAXLINELENGTH'))
|
|
except ValueError:
|
|
maxline = 2048
|
|
if (reduce(lambda x, y: x + len(y), cmd, 0) + len(cmd)) <= maxline:
|
|
return self.cmd
|
|
else:
|
|
# We do a normpath because mktemp() has what appears to be
|
|
# a bug in Win32 that will use a forward slash as a path
|
|
# delimiter. Win32's link mistakes that for a command line
|
|
# switch and barfs.
|
|
#
|
|
# We use the .lnk suffix for the benefit of the Phar Lap
|
|
# linkloc linker, which likes to append an .lnk suffix if
|
|
# none is given.
|
|
tmp = os.path.normpath(tempfile.mktemp('.lnk'))
|
|
native_tmp = SCons.Util.get_native_path(tmp)
|
|
|
|
if env['SHELL'] and env['SHELL'] == 'sh':
|
|
# The sh shell will try to escape the backslashes in the
|
|
# path, so unescape them.
|
|
native_tmp = string.replace(native_tmp, '\\', r'\\\\')
|
|
# In Cygwin, we want to use rm to delete the temporary
|
|
# file, because del does not exist in the sh shell.
|
|
rm = env.Detect('rm') or 'del'
|
|
else:
|
|
# Don't use 'rm' if the shell is not sh, because rm won't
|
|
# work with the win32 shells (cmd.exe or command.com) or
|
|
# win32 path names.
|
|
rm = 'del'
|
|
|
|
args = map(SCons.Util.quote_spaces, cmd[1:])
|
|
open(tmp, 'w').write(string.join(args, " ") + "\n")
|
|
# XXX Using the SCons.Action.print_actions value directly
|
|
# like this is bogus, but expedient. This class should
|
|
# really be rewritten as an Action that defines the
|
|
# __call__() and strfunction() methods and lets the
|
|
# normal action-execution logic handle whether or not to
|
|
# print/execute the action. The problem, though, is all
|
|
# of that is decided before we execute this method as
|
|
# part of expanding the $TEMPFILE construction variable.
|
|
# Consequently, refactoring this will have to wait until
|
|
# we get more flexible with allowing Actions to exist
|
|
# independently and get strung together arbitrarily like
|
|
# Ant tasks. In the meantime, it's going to be more
|
|
# user-friendly to not let obsession with architectural
|
|
# purity get in the way of just being helpful, so we'll
|
|
# reach into SCons.Action directly.
|
|
if SCons.Action.print_actions:
|
|
print("Using tempfile "+native_tmp+" for command line:\n"+
|
|
str(cmd[0]) + " " + string.join(args," "))
|
|
return [ cmd[0], '@' + native_tmp + '\n' + rm, native_tmp ]
|
|
|
|
# The upshot of all this is that, if you are using Python 1.5.2,
|
|
# you had better have cmd or command.com in your PATH when you run
|
|
# scons.
|
|
|
|
def piped_spawn(sh, escape, cmd, args, env, stdout, stderr):
|
|
# There is no direct way to do that in python. What we do
|
|
# here should work for most cases:
|
|
# In case stdout (stderr) is not redirected to a file,
|
|
# we redirect it into a temporary file tmpFileStdout
|
|
# (tmpFileStderr) and copy the contents of this file
|
|
# to stdout (stderr) given in the argument
|
|
if not sh:
|
|
sys.stderr.write("scons: Could not find command interpreter, is it in your PATH?\n")
|
|
return 127
|
|
else:
|
|
# one temporary file for stdout and stderr
|
|
tmpFileStdout = os.path.normpath(tempfile.mktemp())
|
|
tmpFileStderr = os.path.normpath(tempfile.mktemp())
|
|
|
|
# check if output is redirected
|
|
stdoutRedirected = 0
|
|
stderrRedirected = 0
|
|
for arg in args:
|
|
# are there more possibilities to redirect stdout ?
|
|
if (string.find( arg, ">", 0, 1 ) != -1 or
|
|
string.find( arg, "1>", 0, 2 ) != -1):
|
|
stdoutRedirected = 1
|
|
# are there more possibilities to redirect stderr ?
|
|
if string.find( arg, "2>", 0, 2 ) != -1:
|
|
stderrRedirected = 1
|
|
|
|
# redirect output of non-redirected streams to our tempfiles
|
|
if stdoutRedirected == 0:
|
|
args.append(">" + str(tmpFileStdout))
|
|
if stderrRedirected == 0:
|
|
args.append("2>" + str(tmpFileStderr))
|
|
|
|
# actually do the spawn
|
|
try:
|
|
args = [sh, '/C', escape(string.join(args)) ]
|
|
ret = os.spawnve(os.P_WAIT, sh, args, env)
|
|
except OSError, e:
|
|
# catch any error
|
|
ret = exitvalmap[e[0]]
|
|
if stderr != None:
|
|
stderr.write("scons: %s: %s\n" % (cmd, e[1]))
|
|
# copy child output from tempfiles to our streams
|
|
# and do clean up stuff
|
|
if stdout != None and stdoutRedirected == 0:
|
|
try:
|
|
stdout.write(open( tmpFileStdout, "r" ).read())
|
|
os.remove( tmpFileStdout )
|
|
except (IOError, OSError):
|
|
pass
|
|
|
|
if stderr != None and stderrRedirected == 0:
|
|
try:
|
|
stderr.write(open( tmpFileStderr, "r" ).read())
|
|
os.remove( tmpFileStderr )
|
|
except (IOError, OSError):
|
|
pass
|
|
return ret
|
|
|
|
def spawn(sh, escape, cmd, args, env):
|
|
if not sh:
|
|
sys.stderr.write("scons: Could not find command interpreter, is it in your PATH?\n")
|
|
return 127
|
|
else:
|
|
try:
|
|
args = [sh, '/C', escape(string.join(args)) ]
|
|
ret = os.spawnve(os.P_WAIT, sh, args, env)
|
|
except OSError, e:
|
|
ret = exitvalmap[e[0]]
|
|
sys.stderr.write("scons: %s: %s\n" % (cmd, e[1]))
|
|
return ret
|
|
|
|
# Windows does not allow special characters in file names anyway, so
|
|
# no need for a complex escape function, we will just quote the arg.
|
|
escape = lambda x: '"' + x + '"'
|
|
|
|
# Get the windows system directory name
|
|
def get_system_root():
|
|
# A resonable default if we can't read the registry
|
|
try:
|
|
val = os.environ['SYSTEMROOT']
|
|
except KeyError:
|
|
val = "C:/WINDOWS"
|
|
pass
|
|
|
|
# First see if we can look in the registry...
|
|
if SCons.Util.can_read_reg:
|
|
try:
|
|
# Look for Windows NT system root
|
|
k=SCons.Util.RegOpenKeyEx(SCons.Util.hkey_mod.HKEY_LOCAL_MACHINE,
|
|
'Software\\Microsoft\\Windows NT\\CurrentVersion')
|
|
val, tok = SCons.Util.RegQueryValueEx(k, 'SystemRoot')
|
|
except SCons.Util.RegError:
|
|
try:
|
|
# Okay, try the Windows 9x system root
|
|
k=SCons.Util.RegOpenKeyEx(SCons.Util.hkey_mod.HKEY_LOCAL_MACHINE,
|
|
'Software\\Microsoft\\Windows\\CurrentVersion')
|
|
val, tok = SCons.Util.RegQueryValueEx(k, 'SystemRoot')
|
|
except KeyboardInterrupt:
|
|
raise
|
|
except:
|
|
pass
|
|
return val
|
|
|
|
# Get the location of the program files directory
|
|
def get_program_files_dir():
|
|
# Now see if we can look in the registry...
|
|
val = ''
|
|
if SCons.Util.can_read_reg:
|
|
try:
|
|
# Look for Windows Program Files directory
|
|
k=SCons.Util.RegOpenKeyEx(SCons.Util.hkey_mod.HKEY_LOCAL_MACHINE,
|
|
'Software\\Microsoft\\Windows\\CurrentVersion')
|
|
val, tok = SCons.Util.RegQueryValueEx(k, 'ProgramFilesDir')
|
|
except SCons.Util.RegError:
|
|
val = ''
|
|
pass
|
|
|
|
if val == '':
|
|
# A reasonable default if we can't read the registry
|
|
# (Actually, it's pretty reasonable even if we can :-)
|
|
val = os.path.join(os.path.dirname(get_system_root()),"Program Files")
|
|
|
|
return val
|
|
|
|
def generate(env):
|
|
# Attempt to find cmd.exe (for WinNT/2k/XP) or
|
|
# command.com for Win9x
|
|
cmd_interp = ''
|
|
# First see if we can look in the registry...
|
|
if SCons.Util.can_read_reg:
|
|
try:
|
|
# Look for Windows NT system root
|
|
k=SCons.Util.RegOpenKeyEx(SCons.Util.hkey_mod.HKEY_LOCAL_MACHINE,
|
|
'Software\\Microsoft\\Windows NT\\CurrentVersion')
|
|
val, tok = SCons.Util.RegQueryValueEx(k, 'SystemRoot')
|
|
cmd_interp = os.path.join(val, 'System32\\cmd.exe')
|
|
except SCons.Util.RegError:
|
|
try:
|
|
# Okay, try the Windows 9x system root
|
|
k=SCons.Util.RegOpenKeyEx(SCons.Util.hkey_mod.HKEY_LOCAL_MACHINE,
|
|
'Software\\Microsoft\\Windows\\CurrentVersion')
|
|
val, tok = SCons.Util.RegQueryValueEx(k, 'SystemRoot')
|
|
cmd_interp = os.path.join(val, 'command.com')
|
|
except KeyboardInterrupt:
|
|
raise
|
|
except:
|
|
pass
|
|
|
|
# For the special case of not having access to the registry, we
|
|
# use a temporary path and pathext to attempt to find the command
|
|
# interpreter. If we fail, we try to find the interpreter through
|
|
# the env's PATH. The problem with that is that it might not
|
|
# contain an ENV and a PATH.
|
|
if not cmd_interp:
|
|
systemroot = r'C:\Windows'
|
|
if os.environ.has_key('SYSTEMROOT'):
|
|
systemroot = os.environ['SYSTEMROOT']
|
|
tmp_path = systemroot + os.pathsep + \
|
|
os.path.join(systemroot,'System32')
|
|
tmp_pathext = '.com;.exe;.bat;.cmd'
|
|
if os.environ.has_key('PATHEXT'):
|
|
tmp_pathext = os.environ['PATHEXT']
|
|
cmd_interp = SCons.Util.WhereIs('cmd', tmp_path, tmp_pathext)
|
|
if not cmd_interp:
|
|
cmd_interp = SCons.Util.WhereIs('command', tmp_path, tmp_pathext)
|
|
|
|
if not cmd_interp:
|
|
cmd_interp = env.Detect('cmd')
|
|
if not cmd_interp:
|
|
cmd_interp = env.Detect('command')
|
|
|
|
|
|
if not env.has_key('ENV'):
|
|
env['ENV'] = {}
|
|
|
|
# Import things from the external environment to the construction
|
|
# environment's ENV. This is a potential slippery slope, because we
|
|
# *don't* want to make builds dependent on the user's environment by
|
|
# default. We're doing this for SYSTEMROOT, though, because it's
|
|
# needed for anything that uses sockets, and seldom changes. Weigh
|
|
# the impact carefully before adding other variables to this list.
|
|
import_env = [ 'SYSTEMROOT' ]
|
|
for var in import_env:
|
|
v = os.environ.get(var)
|
|
if v:
|
|
env['ENV'][var] = v
|
|
|
|
env['ENV']['PATHEXT'] = '.COM;.EXE;.BAT;.CMD'
|
|
env['OBJPREFIX'] = ''
|
|
env['OBJSUFFIX'] = '.obj'
|
|
env['SHOBJPREFIX'] = '$OBJPREFIX'
|
|
env['SHOBJSUFFIX'] = '$OBJSUFFIX'
|
|
env['PROGPREFIX'] = ''
|
|
env['PROGSUFFIX'] = '.exe'
|
|
env['LIBPREFIX'] = ''
|
|
env['LIBSUFFIX'] = '.lib'
|
|
env['SHLIBPREFIX'] = ''
|
|
env['SHLIBSUFFIX'] = '.dll'
|
|
env['LIBPREFIXES'] = [ '$LIBPREFIX' ]
|
|
env['LIBSUFFIXES'] = [ '$LIBSUFFIX' ]
|
|
env['PSPAWN'] = piped_spawn
|
|
env['SPAWN'] = spawn
|
|
env['SHELL'] = cmd_interp
|
|
env['TEMPFILE'] = TempFileMunge
|
|
env['MAXLINELENGTH'] = 2048
|
|
env['ESCAPE'] = escape
|