Parameterize the '@' prefix when calling TempFileMunge(). (Bjorn Eriksson)

7 files changed, 149 insertions, 45 deletions

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 8ac5681..e08297a 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -7177,6 +7177,14 @@ that may not be set or used in a construction environment.
 .IP TARSUFFIX 
 The suffix used for tar file names.
 
+.IP TEMPFILEPREFIX
+The prefix for a temporary file used
+to execute lines longer than $MAXLINELENGTH.
+The default is '@'.
+This may be set for toolchains that use other values,
+such as '-@' for the diab compiler
+or '-via' for ARM toolchain.
+
 .IP TEX
 The TeX formatter and typesetter.
 
diff --git a/src/engine/SCons/Platform/__init__.py b/src/engine/SCons/Platform/__init__.py
index 9c15a08..385f0c9 100644
--- a/src/engine/SCons/Platform/__init__.py
+++ b/src/engine/SCons/Platform/__init__.py
@@ -127,6 +127,13 @@ class TempFileMunge:
     Example usage:
     env["TEMPFILE"] = TempFileMunge
     env["LINKCOM"] = "${TEMPFILE('$LINK $TARGET $SOURCES')}"
+
+    By default, the name of the temporary file used begins with a
+    prefix of '@'.  This may be configred for other tool chains by
+    setting '$TEMPFILEPREFIX'.
+
+    env["TEMPFILEPREFIX"] = '-@'        # diab compiler
+    env["TEMPFILEPREFIX"] = '-via'      # arm tool chain
     """
     def __init__(self, cmd):
         self.cmd = cmd
@@ -139,54 +146,59 @@ class TempFileMunge:
             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
+
+        # 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:
-            # 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 ]
+            # 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'
+
+        prefix = env.subst('$TEMPFILEPREFIX')
+        if not prefix:
+            prefix = '@'
+
+        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], prefix + native_tmp + '\n' + rm, native_tmp ]
     
 def Platform(name = platform_default()):
     """Select a canned Platform specification.
diff --git a/src/engine/SCons/Platform/__init__.xml b/src/engine/SCons/Platform/__init__.xml
index 20ec83b..a6cb720 100644
--- a/src/engine/SCons/Platform/__init__.xml
+++ b/src/engine/SCons/Platform/__init__.xml
@@ -116,3 +116,14 @@ The prefix used for shared object file names.
 The suffix used for shared object file names.
 </summary>
 </cvar>
+
+<cvar name="TEMPFILEPREFIX">
+<summary>
+The prefix for a temporary file used
+to execute lines longer than $MAXLINELENGTH.
+The default is '@'.
+This may be set for toolchains that use other values,
+such as '-@' for the diab compiler
+or '-via' for ARM toolchain.
+</summary>
+</cvar>
diff --git a/src/engine/SCons/Platform/cygwin.py b/src/engine/SCons/Platform/cygwin.py
index 728eda3..3022798 100644
--- a/src/engine/SCons/Platform/cygwin.py
+++ b/src/engine/SCons/Platform/cygwin.py
@@ -45,4 +45,5 @@ def generate(env):
     env['LIBPREFIXES'] = [ '$LIBPREFIX', '$SHLIBPREFIX' ]
     env['LIBSUFFIXES'] = [ '$LIBSUFFIX', '$SHLIBSUFFIX' ]
     env['TEMPFILE']    = TempFileMunge
+    env['TEMPFILEPREFIX'] = '@'
     env['MAXLINELENGTH']  = 2048
diff --git a/src/engine/SCons/Platform/posix.py b/src/engine/SCons/Platform/posix.py
index b945d1c..5f1cfa1 100644
--- a/src/engine/SCons/Platform/posix.py
+++ b/src/engine/SCons/Platform/posix.py
@@ -242,6 +242,7 @@ def generate(env):
     env['SHELL']          = 'sh'
     env['ESCAPE']         = escape
     env['TEMPFILE']       = TempFileMunge
+    env['TEMPFILEPREFIX'] = '@'
     #Based on LINUX: ARG_MAX=ARG_MAX=131072 - 3000 for environment expansion
     #Note: specific platforms might rise or lower this value
     env['MAXLINELENGTH']  = 128072
diff --git a/src/engine/SCons/Platform/win32.py b/src/engine/SCons/Platform/win32.py
index 58e06da..6faf606 100644
--- a/src/engine/SCons/Platform/win32.py
+++ b/src/engine/SCons/Platform/win32.py
@@ -257,5 +257,6 @@ def generate(env):
     env['SPAWN']          = spawn
     env['SHELL']          = cmd_interp
     env['TEMPFILE']       = TempFileMunge
+    env['TEMPFILEPREFIX'] = '@'
     env['MAXLINELENGTH']  = 2048
     env['ESCAPE']         = escape
diff --git a/test/TEMPFILEPREFIX.py b/test/TEMPFILEPREFIX.py
new file mode 100644
index 0000000..7fabb7c
--- /dev/null
+++ b/test/TEMPFILEPREFIX.py
@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# 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__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify that setting the $TEMPFILEPREFIX variable will append to the
+beginning of the TEMPFILE invocation of a long command line.
+"""
+
+import os
+import stat
+
+import TestSCons
+
+test = TestSCons.TestSCons(match = TestSCons.match_re)
+
+test.write('echo.py', """\
+#!/usr/bin/env python
+import sys
+print sys.argv
+""")
+
+echo_py = test.workpath('echo.py')
+
+st = os.stat(echo_py)
+os.chmod(echo_py, st[stat.ST_MODE]|0111)
+
+test.write('SConstruct', """
+import os
+env = Environment(
+    BUILDCOM = '${TEMPFILE("xxx.py $TARGET $SOURCES")}',
+    MAXLINELENGTH = 16,
+    TEMPFILEPREFIX = '-via',
+)
+env.AppendENVPath('PATH', os.curdir)
+env.Command('foo.out', 'foo.in', '$BUILDCOM')
+""")
+
+test.write('foo.in', "foo.in\n")
+
+test.run(arguments = '-n -Q .',
+         stdout = """\
+Using tempfile \\S+ for command line:
+xxx.py foo.out foo.in
+xxx.py -via\\S+
+""")
+
+test.pass_test()