src/engine/SCons/Tool/midl.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="midl">
   8 <summary>
   9 Sets construction variables for the Microsoft IDL compiler.
  10 </summary>
  11 <sets>
  12 MIDL
  13 MIDLFLAGS
  14 MIDLCOM
  15 </sets>
  16 <uses>
  17 MIDLCOMSTR
  18 </uses>
  19 </tool>
  20
  21 <builder name="TypeLibrary">
  22 <summary>
  23 Builds a Windows type library (<filename>.tlb</filename>)
  24 file from an input IDL file (<filename>.idl</filename>).
  25 In addition, it will build the associated inteface stub and
  26 proxy source files,
  27 naming them according to the base name of the <filename>.idl</filename> file.
  28 For example,
  29
  30 <example>
  31 env.TypeLibrary(source="foo.idl")
  32 </example>
  33
  34 Will create <filename>foo.tlb</filename>,
  35 <filename>foo.h</filename>,
  36 <filename>foo_i.c</filename>,
  37 <filename>foo_p.c</filename>
  38 and
  39 <filename>foo_data.c</filename>
  40 files.
  41 </summary>
  42 </builder>
  43
  44 <cvar name="MIDL">
  45 <summary>
  46 The Microsoft IDL compiler.
  47 </summary>
  48 </cvar>
  49
  50 <cvar name="MIDLCOM">
  51 <summary>
  52 The command line used to pass files to the Microsoft IDL compiler.
  53 </summary>
  54 </cvar>
  55
  56 <cvar name="MIDLCOMSTR">
  57 <summary>
  58 The string displayed when
  59 the Microsoft IDL copmiler is called.
  60 If this is not set, then &cv-link-MIDLCOM; (the command line) is displayed.
  61 </summary>
  62 </cvar>
  63
  64 <cvar name="MIDLFLAGS">
  65 <summary>
  66 General options passed to the Microsoft IDL compiler.
  67 </summary>
  68 </cvar>