SCons/Tool/dvi.py

   1 # MIT License
   2 #
   3 # Copyright The SCons Foundation
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining
   6 # a copy of this software and associated documentation files (the
   7 # "Software"), to deal in the Software without restriction, including
   8 # without limitation the rights to use, copy, modify, merge, publish,
   9 # distribute, sublicense, and/or sell copies of the Software, and to
  10 # permit persons to whom the Software is furnished to do so, subject to
  11 # the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included
  14 # in all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  17 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  18 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23
  24 """
  25 Common DVI Builder definition for various other Tool modules that use it.
  26 """
  27
  28 import SCons.Builder
  29 import SCons.Tool
  30
  31 DVIBuilder = None
  32
  33 def generate(env) -> None:
  34     try:
  35         env['BUILDERS']['DVI']
  36     except KeyError:
  37         global DVIBuilder
  38
  39         if DVIBuilder is None:
  40             # The suffix is hard-coded to '.dvi', not configurable via a
  41             # construction variable like $DVISUFFIX, because the output
  42             # file name is hard-coded within TeX.
  43             DVIBuilder = SCons.Builder.Builder(action = {},
  44                                                source_scanner = SCons.Tool.LaTeXScanner,
  45                                                suffix = '.dvi',
  46                                                emitter = {},
  47                                                source_ext_match = None)
  48
  49         env['BUILDERS']['DVI'] = DVIBuilder
  50
  51 def exists(env) -> bool:
  52     # This only puts a skeleton Builder in place, so if someone
  53     # references this Tool directly, it's always "available."
  54     return True
  55
  56 # Local Variables:
  57 # tab-width:4
  58 # indent-tabs-mode:nil
  59 # End:
  60 # vim: set expandtab tabstop=4 shiftwidth=4: