src/engine/SCons/Tool/midl.py

   1 """SCons.Tool.midl
   2
   3 Tool-specific initialization for midl (Microsoft IDL compiler).
   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.Defaults
  37 import SCons.Scanner.IDL
  38 import SCons.Util
  39 import SCons.Tool.msvs
  40
  41 def midl_emitter(target, source, env):
  42     """Produces a list of outputs from the MIDL compiler"""
  43     base, ext = SCons.Util.splitext(str(target[0]))
  44     tlb = target[0]
  45     incl = base + '.h'
  46     interface = base + '_i.c'
  47     proxy = base + '_p.c'
  48     dlldata = base + '_data.c'
  49
  50     t = [tlb, incl, interface, proxy, dlldata]
  51
  52     return (t,source)
  53
  54 idl_scanner = SCons.Scanner.IDL.IDLScan()
  55
  56 midl_builder = SCons.Builder.Builder(action='$MIDLCOM',
  57                                      src_suffix = '.idl',
  58                                      suffix='.tlb',
  59                                      emitter = midl_emitter,
  60                                      source_scanner = idl_scanner)
  61
  62 def generate(env):
  63     """Add Builders and construction variables for midl to an Environment."""
  64
  65     env['MIDL']          = 'MIDL.EXE'
  66     env['MIDLFLAGS']     = SCons.Util.CLVar('/nologo')
  67     env['MIDLCOM']       = '$MIDL $MIDLFLAGS /tlb ${TARGETS[0]} /h ${TARGETS[1]} /iid ${TARGETS[2]} /proxy ${TARGETS[3]} /dlldata ${TARGETS[4]} $SOURCE 2> NUL'
  68     env['BUILDERS']['TypeLibrary'] = midl_builder
  69
  70 def exists(env):
  71     if SCons.Tool.msvs.is_msvs_installed():
  72         # there's at least one version of MSVS installed, which comes with midl:
  73         return 1
  74     else:
  75         return env.Detect('midl')
  76
  77