Add a TAR Builder.
[scons.git] / src / engine / SCons / Tool / tar.py
1 """SCons.Tool.tar
2
3 Tool-specific initialization for tar.
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 (c) 2001, 2002 Steven Knight
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 SCons.Builder
37 import SCons.Node.FS
38
39 TarBuilder = SCons.Builder.Builder(action = '$TARCOM',
40                                    source_factory = SCons.Node.FS.default_fs.Entry,
41                                    suffix = '$TARSUFFIX',
42                                    multi = 1)
43
44 def generate(env, platform):
45     """Add Builders and construction variables for tar to an Environment."""
46     try:
47         bld = env['BUILDERS']['Tar']
48     except KeyError:
49         bld = TarBuilder
50         env['BUILDERS']['Tar'] = bld
51
52     env['TAR']        = 'tar'
53     env['TARFLAGS']   = '-c'
54     env['TARCOM']     = '$TAR $TARFLAGS -f $TARGET $SOURCES'
55     env['TARSUFFIX']  = '.tar'