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__
  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.Action
  37 import SCons.Builder
  38 import SCons.Defaults
  39 import SCons.Node.FS
  40 import SCons.Util
  41
  42 tars = ['tar', 'gtar']
  43
  44 TarAction = SCons.Action.Action('$TARCOM', '$TARCOMSTR')
  45
  46 TarBuilder = SCons.Builder.Builder(action = TarAction,
  47                                    source_factory = SCons.Node.FS.Entry,
  48                                    source_scanner = SCons.Defaults.DirScanner,
  49                                    suffix = '$TARSUFFIX',
  50                                    multi = 1)
  51
  52
  53 def generate(env) -> None:
  54     """Add Builders and construction variables for tar to an Environment."""
  55     try:
  56         bld = env['BUILDERS']['Tar']
  57     except KeyError:
  58         bld = TarBuilder
  59         env['BUILDERS']['Tar'] = bld
  60
  61     env['TAR']        = env.Detect(tars) or 'gtar'
  62     env['TARFLAGS']   = SCons.Util.CLVar('-c')
  63     env['TARCOM']     = '$TAR $TARFLAGS -f $TARGET $SOURCES'
  64     env['TARSUFFIX']  = '.tar'
  65
  66 def exists(env):
  67     return env.Detect(tars)
  68
  69 # Local Variables:
  70 # tab-width:4
  71 # indent-tabs-mode:nil
  72 # End:
  73 # vim: set expandtab tabstop=4 shiftwidth=4: