src/engine/SCons/Tool/yacc.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="yacc">
   8 <summary>
   9 Sets construction variables for the &yacc; parse generator.
  10 </summary>
  11 <sets>
  12 YACC
  13 YACCFLAGS
  14 YACCCOM
  15 YACCHFILESUFFIX
  16 YACCHXXFILESUFFIX
  17 YACCVCGFILESUFFIX
  18 </sets>
  19 <uses>
  20 YACCCOMSTR
  21 </uses>
  22 </tool>
  23
  24 <cvar name="YACC">
  25 <summary>
  26 The parser generator.
  27 </summary>
  28 </cvar>
  29
  30 <cvar name="YACCCOM">
  31 <summary>
  32 The command line used to call the parser generator
  33 to generate a source file.
  34 </summary>
  35 </cvar>
  36
  37 <cvar name="YACCCOMSTR">
  38 <summary>
  39 The string displayed when generating a source file
  40 using the parser generator.
  41 If this is not set, then &cv-link-YACCCOM; (the command line) is displayed.
  42
  43 <example>
  44 env = Environment(YACCCOMSTR = "Yacc'ing $TARGET from $SOURCES")
  45 </example>
  46 </summary>
  47 </cvar>
  48
  49 <cvar name="YACCFLAGS">
  50 <summary>
  51 General options passed to the parser generator.
  52 If &cv-link-YACCFLAGS; contains a <option>-d</option> option,
  53 SCons assumes that the call will also create a .h file
  54 (if the yacc source file ends in a .y suffix)
  55 or a .hpp file
  56 (if the yacc source file ends in a .yy suffix)
  57 </summary>
  58 </cvar>
  59
  60 <cvar name="YACCHFILESUFFIX">
  61 <summary>
  62 The suffix of the C
  63 header file generated by the parser generator
  64 when the
  65 <option>-d</option>
  66 option is used.
  67 Note that setting this variable does not cause
  68 the parser generator to generate a header
  69 file with the specified suffix,
  70 it exists to allow you to specify
  71 what suffix the parser generator will use of its own accord.
  72 The default value is
  73 <filename>.h</filename>.
  74 </summary>
  75 </cvar>
  76
  77 <cvar name="YACCHXXFILESUFFIX">
  78 <summary>
  79 The suffix of the C++
  80 header file generated by the parser generator
  81 when the
  82 <option>-d</option>
  83 option is used.
  84 Note that setting this variable does not cause
  85 the parser generator to generate a header
  86 file with the specified suffix,
  87 it exists to allow you to specify
  88 what suffix the parser generator will use of its own accord.
  89 The default value is
  90 <filename>.hpp</filename>.
  91 </summary>
  92 </cvar>
  93
  94 <cvar name="YACCVCGFILESUFFIX">
  95 <summary>
  96 The suffix of the file
  97 containing the VCG grammar automaton definition
  98 when the
  99 <option>--graph=</option>
 100 option is used.
 101 Note that setting this variable does not cause
 102 the parser generator to generate a VCG
 103 file with the specified suffix,
 104 it exists to allow you to specify
 105 what suffix the parser generator will use of its own accord.
 106 The default value is
 107 <filename>.vcg</filename>.
 108 </summary>
 109 </cvar>