SCons/Tool/m4.py

   1 """SCons.Tool.m4
   2
   3 Tool-specific initialization for m4.
   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.Util
  39
  40 def generate(env) -> None:
  41     """Add Builders and construction variables for m4 to an Environment."""
  42     M4Action = SCons.Action.Action('$M4COM', '$M4COMSTR')
  43     bld = SCons.Builder.Builder(action = M4Action, src_suffix = '.m4')
  44
  45     env['BUILDERS']['M4'] = bld
  46
  47     # .m4 files might include other files, and it would be pretty hard
  48     # to write a scanner for it, so let's just cd to the dir of the m4
  49     # file and run from there.
  50     # The src_suffix setup is like so: file.c.m4 -> file.c,
  51     # file.cpp.m4 -> file.cpp etc.
  52     env['M4']      = 'm4'
  53     env['M4FLAGS'] = SCons.Util.CLVar('-E')
  54     env['M4COM']   = 'cd ${SOURCE.rsrcdir} && $M4 $M4FLAGS < ${SOURCE.file} > ${TARGET.abspath}'
  55
  56 def exists(env):
  57     return env.Detect('m4')
  58
  59 # Local Variables:
  60 # tab-width:4
  61 # indent-tabs-mode:nil
  62 # End:
  63 # vim: set expandtab tabstop=4 shiftwidth=4: