From a16201c698bb4879ae0f58acf5ec7e06db6e8081 Mon Sep 17 00:00:00 2001 From: stevenknight Date: Wed, 1 Dec 2004 03:27:20 +0000 Subject: [PATCH] More command-line customizability: and . git-svn-id: http://scons.tigris.org/svn/scons/trunk@1176 fdb21ef1-2011-0410-befe-b5e4ea1792b1 --- doc/man/scons.1 | 19 ++++++++++ src/CHANGES.txt | 4 +-- src/engine/SCons/Tool/tar.py | 5 ++- src/engine/SCons/Tool/zip.py | 2 +- test/{ => TAR}/TAR.py | 0 test/TAR/TARCOM.py | 68 ++++++++++++++++++++++++++++++++++++ test/TAR/TARCOMSTR.py | 67 +++++++++++++++++++++++++++++++++++ test/{ => TAR}/TARFLAGS.py | 0 test/{ => ZIP}/ZIP.py | 0 test/ZIP/ZIPCOM.py | 68 ++++++++++++++++++++++++++++++++++++ test/ZIP/ZIPCOMSTR.py | 67 +++++++++++++++++++++++++++++++++++ 11 files changed, 296 insertions(+), 4 deletions(-) rename test/{ => TAR}/TAR.py (100%) create mode 100644 test/TAR/TARCOM.py create mode 100644 test/TAR/TARCOMSTR.py rename test/{ => TAR}/TARFLAGS.py (100%) rename test/{ => ZIP}/ZIP.py (100%) create mode 100644 test/ZIP/ZIPCOM.py create mode 100644 test/ZIP/ZIPCOMSTR.py diff --git a/doc/man/scons.1 b/doc/man/scons.1 index 870377e2..f620a9f6 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -6733,6 +6733,15 @@ The tar archiver. .IP TARCOM The command line used to call the tar archiver. +.IP TARCOMSTR +The string displayed when archiving files +using the tar archiver. +If this is not set, then $TARCOM (the command line) is displayed. + +.ES +env = Environment(TARCOMSTR = "Archiving $TARGET") +.EE + .IP TARFLAGS General options passed to the tar archiver. @@ -6807,6 +6816,16 @@ The command line used to call the zip utility, or the internal Python function used to create a zip archive. +.IP ZIPCOMSTR +The string displayed when archiving files +using the zip utility. +If this is not set, then $ZIPCOM +(the command line or internal Python function) is displayed. + +.ES +env = Environment(ZIPCOMSTR = "Zipping $TARGET") +.EE + .IP ZIPCOMPRESSION The .I compression diff --git a/src/CHANGES.txt b/src/CHANGES.txt index 48483d18..b163ec66 100644 --- a/src/CHANGES.txt +++ b/src/CHANGES.txt @@ -136,8 +136,8 @@ RELEASE 0.97 - XXX $F77COMSTR, $F90COMSTR, $F95COMSTR, $FORTRANCOMSTR, $JARCOMSTR, $JAVACCOMSTR, $JAVAHCOMSTR, $LEXCOMSTR, $LINKCOMSTR, $RCSCOMSTR, $RMICCOMSTR, $SCCSCOMSTR, $SHCCCOMSTR, $SHCXXCOMSTR, $SHF77COMSTR, - $SHF90COMSTR, $SHF95COMSTR, $SHFORTRANCOMSTR, $SHLINKCOMSTR and - $YACCCOMSTR. + $SHF90COMSTR, $SHF95COMSTR, $SHFORTRANCOMSTR, $SHLINKCOMSTR, + $TARCOMSTR, $YACCCOMSTR and $ZIPCOMSTR. - Add an optional "map" keyword argument to ListOption() that takes a dictionary to map user-specified values to legal values from the list diff --git a/src/engine/SCons/Tool/tar.py b/src/engine/SCons/Tool/tar.py index 83fb7d3a..75d20386 100644 --- a/src/engine/SCons/Tool/tar.py +++ b/src/engine/SCons/Tool/tar.py @@ -33,13 +33,16 @@ selection method. __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" +import SCons.Action import SCons.Builder import SCons.Node.FS import SCons.Util tars = ['tar', 'gtar'] -TarBuilder = SCons.Builder.Builder(action = '$TARCOM', +TarAction = SCons.Action.Action('$TARCOM', '$TARCOMSTR') + +TarBuilder = SCons.Builder.Builder(action = TarAction, source_factory = SCons.Node.FS.default_fs.Entry, suffix = '$TARSUFFIX', multi = 1) diff --git a/src/engine/SCons/Tool/zip.py b/src/engine/SCons/Tool/zip.py index c81a4f3e..b32f0245 100644 --- a/src/engine/SCons/Tool/zip.py +++ b/src/engine/SCons/Tool/zip.py @@ -68,7 +68,7 @@ else: zipAction = SCons.Action.Action(zip, varlist=['ZIPCOMPRESSION']) -ZipBuilder = SCons.Builder.Builder(action = '$ZIPCOM', +ZipBuilder = SCons.Builder.Builder(action = SCons.Action.Action('$ZIPCOM', '$ZIPCOMSTR'), source_factory = SCons.Node.FS.default_fs.Entry, suffix = '$ZIPSUFFIX', multi = 1) diff --git a/test/TAR.py b/test/TAR/TAR.py similarity index 100% rename from test/TAR.py rename to test/TAR/TAR.py diff --git a/test/TAR/TARCOM.py b/test/TAR/TARCOM.py new file mode 100644 index 00000000..f6e36e79 --- /dev/null +++ b/test/TAR/TARCOM.py @@ -0,0 +1,68 @@ +#!/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__" + +""" +Test the ability to configure the $TARCOM construction variable. +""" + +import os +import string +import sys +import TestSCons + +python = TestSCons.python + +test = TestSCons.TestSCons() + + + +test.write('mytar.py', r""" +import sys +outfile = open(sys.argv[1], 'wb') +infile = open(sys.argv[2], 'rb') +for l in filter(lambda l: l != '/*tar*/\n', infile.readlines()): + outfile.write(l) +sys.exit(0) +""") + +test.write('SConstruct', """ +env = Environment(TOOLS = ['tar'], + TARCOM = r'%(python)s mytar.py $TARGET $SOURCE') +env.Tar('test1.tar', 'test1.in') +""" % locals()) + +test.write('test1.in', """\ +test1.in +/*tar*/ +""") + +test.run() + +test.must_match('test1.tar', "test1.in\n") + + + +test.pass_test() diff --git a/test/TAR/TARCOMSTR.py b/test/TAR/TARCOMSTR.py new file mode 100644 index 00000000..2bd3813d --- /dev/null +++ b/test/TAR/TARCOMSTR.py @@ -0,0 +1,67 @@ +#!/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__" + +""" +Test that the $TARCOMSTR construction variable allows you to customize +the displayed string when tar is called. +""" + +import TestSCons + +python = TestSCons.python + +test = TestSCons.TestSCons() + + + +test.write('mytar.py', """ +import sys +outfile = open(sys.argv[1], 'wb') +for f in sys.argv[2:]: + infile = open(f, 'rb') + for l in filter(lambda l: l != '/*tar*/\\n', infile.readlines()): + outfile.write(l) +sys.exit(0) +""") + +test.write('SConstruct', """ +env = Environment(tools=['tar'], + TARCOM = r'%s mytar.py $TARGET $SOURCES', + TARCOMSTR = 'Taring $TARGET from $SOURCE') +env.Tar('aaa.tar', 'aaa.in') +""" % python) + +test.write('aaa.in', "aaa.in\n/*tar*/\n") + +test.run(stdout = test.wrap_stdout("""\ +Taring aaa.tar from aaa.in +""")) + +test.must_match('aaa.tar', "aaa.in\n") + + + +test.pass_test() diff --git a/test/TARFLAGS.py b/test/TAR/TARFLAGS.py similarity index 100% rename from test/TARFLAGS.py rename to test/TAR/TARFLAGS.py diff --git a/test/ZIP.py b/test/ZIP/ZIP.py similarity index 100% rename from test/ZIP.py rename to test/ZIP/ZIP.py diff --git a/test/ZIP/ZIPCOM.py b/test/ZIP/ZIPCOM.py new file mode 100644 index 00000000..42b8cff4 --- /dev/null +++ b/test/ZIP/ZIPCOM.py @@ -0,0 +1,68 @@ +#!/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__" + +""" +Test the ability to configure the $ZIPCOM construction variable. +""" + +import os +import string +import sys +import TestSCons + +python = TestSCons.python + +test = TestSCons.TestSCons() + + + +test.write('myzip.py', r""" +import sys +outfile = open(sys.argv[1], 'wb') +infile = open(sys.argv[2], 'rb') +for l in filter(lambda l: l != '/*zip*/\n', infile.readlines()): + outfile.write(l) +sys.exit(0) +""") + +test.write('SConstruct', """ +env = Environment(TOOLS = ['zip'], + ZIPCOM = r'%(python)s myzip.py $TARGET $SOURCE') +env.Zip('test1.zip', 'test1.in') +""" % locals()) + +test.write('test1.in', """\ +test1.in +/*zip*/ +""") + +test.run() + +test.must_match('test1.zip', "test1.in\n") + + + +test.pass_test() diff --git a/test/ZIP/ZIPCOMSTR.py b/test/ZIP/ZIPCOMSTR.py new file mode 100644 index 00000000..0ee90fd8 --- /dev/null +++ b/test/ZIP/ZIPCOMSTR.py @@ -0,0 +1,67 @@ +#!/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__" + +""" +Test that the $ZIPCOMSTR construction variable allows you to customize +the displayed string when zip is called. +""" + +import TestSCons + +python = TestSCons.python + +test = TestSCons.TestSCons() + + + +test.write('myzip.py', """ +import sys +outfile = open(sys.argv[1], 'wb') +for f in sys.argv[2:]: + infile = open(f, 'rb') + for l in filter(lambda l: l != '/*zip*/\\n', infile.readlines()): + outfile.write(l) +sys.exit(0) +""") + +test.write('SConstruct', """ +env = Environment(tools=['zip'], + ZIPCOM = r'%s myzip.py $TARGET $SOURCES', + ZIPCOMSTR = 'Zipping $TARGET from $SOURCE') +env.Zip('aaa.zip', 'aaa.in') +""" % python) + +test.write('aaa.in', "aaa.in\n/*zip*/\n") + +test.run(stdout = test.wrap_stdout("""\ +Zipping aaa.zip from aaa.in +""")) + +test.must_match('aaa.zip', "aaa.in\n") + + + +test.pass_test() -- 2.26.2