SCons/Tool/lex.xml

   1 <?xml version="1.0"?>
   2 <!--
   3  MIT License
   4
   5  Copyright The SCons Foundation
   6
   7  Permission is hereby granted, free of charge, to any person obtaining
   8  a copy of this software and associated documentation files (the
   9  "Software"), to deal in the Software without restriction, including
  10  without limitation the rights to use, copy, modify, merge, publish,
  11  distribute, sublicense, and/or sell copies of the Software, and to
  12  permit persons to whom the Software is furnished to do so, subject to
  13  the following conditions:
  14
  15  The above copyright notice and this permission notice shall be included
  16  in all copies or substantial portions of the Software.
  17
  18  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  19  KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  20  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  22  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  23  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  24  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25
  26
  27 This file is processed by the bin/SConsDoc.py module.
  28 See its __doc__ string for a discussion of the format.
  29 -->
  30
  31 <!DOCTYPE sconsdoc [
  32 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  33 %scons;
  34 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  35 %builders-mod;
  36 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  37 %functions-mod;
  38 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  39 %tools-mod;
  40 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  41 %variables-mod;
  42 ]>
  43
  44 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  45           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  46           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  47
  48 <tool name="lex">
  49 <summary>
  50 <para>
  51 Sets construction variables for the &lex; lexical analyser.
  52 </para>
  53 </summary>
  54 <sets>
  55 <item>LEX</item>
  56 <item>LEXFLAGS</item>
  57 <item>LEXCOM</item>
  58 <item>LEXUNISTD</item>
  59 </sets>
  60 <uses>
  61 <item>LEXCOMSTR</item>
  62 <item>LEXFLAGS</item>
  63 <item>LEX_HEADER_FILE</item>
  64 <item>LEX_TABLES_FILE</item>
  65 </uses>
  66 </tool>
  67
  68 <cvar name="LEX">
  69 <summary>
  70 <para>
  71 The lexical analyzer generator.
  72 </para>
  73 </summary>
  74 </cvar>
  75
  76 <cvar name="LEXCOM">
  77 <summary>
  78 <para>
  79 The command line used to call the lexical analyzer generator
  80 to generate a source file.
  81 </para>
  82 </summary>
  83 </cvar>
  84
  85 <cvar name="LEXCOMSTR">
  86 <summary>
  87 <para>
  88 The string displayed when generating a source file
  89 using the lexical analyzer generator.
  90 If this is not set, then &cv-link-LEXCOM; (the command line) is displayed.
  91 </para>
  92
  93 <example_commands>
  94 env = Environment(LEXCOMSTR="Lex'ing $TARGET from $SOURCES")
  95 </example_commands>
  96 </summary>
  97 </cvar>
  98
  99 <cvar name="LEXFLAGS">
 100 <summary>
 101 <para>
 102 General options passed to the lexical analyzer generator.
 103 In addition to passing the value on during invocation,
 104 the &t-link-lex; tool also examines this &consvar; for options
 105 which cause additional output files to be generated,
 106 and adds those to the target list.
 107 Recognized for this purpose are GNU &flex; options
 108 <option>--header-file=</option> and
 109 <option>--tables-file=</option>;
 110 the output file is named by the option argument.
 111 </para>
 112 <para>
 113 Note that files specified by <option>--header-file=</option> and
 114 <option>--tables-file=</option> may not be properly handled
 115 by &SCons; in all situations. Consider using
 116 &cv-link-LEX_HEADER_FILE; and &cv-link-LEX_TABLES_FILE; instead.
 117 </para>
 118 </summary>
 119 </cvar>
 120
 121 <cvar name="LEX_HEADER_FILE">
 122 <summary>
 123 <para>
 124 If supplied, generate a C header file with the name taken from this variable.
 125 Will be emitted as a <option>--header-file=</option>
 126 command-line option. Use this in preference to including
 127 <option>--header-file=</option> in &cv-link-LEXFLAGS; directly.
 128 </para>
 129 </summary>
 130 </cvar>
 131
 132 <cvar name="LEX_TABLES_FILE">
 133 <summary>
 134 <para>
 135 If supplied, write the lex tables to a file with the name
 136 taken from this variable.
 137 Will be emitted as a <option>--tables-file=</option>
 138 command-line option. Use this in preference to including
 139 <option>--tables-file=</option> in &cv-link-LEXFLAGS; directly.
 140 </para>
 141 </summary>
 142 </cvar>
 143
 144 <cvar name="LEXUNISTD">
 145 <summary>
 146 <para>
 147 Used only on windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'.
 148 </para>
 149 </summary>
 150 </cvar>
 151
 152 </sconsdoc>