/Src/Dependencies/Boost/libs/spirit/doc/html/spirit/structure/include.html

http://hadesmem.googlecode.com/ · HTML · 230 lines · 230 code · 0 blank · 0 comment · 0 complexity · 5b29a9f4a3c570dfe333cc2e648b17e1 MD5 · raw file 

    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Include</title>
    5. 

  5. <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.75.0">
    7. 

  7. <link rel="home" href="../../index.html" title="Spirit 2.5">
    8. 

  8. <link rel="up" href="../structure.html" title="Structure">
    9. 

  9. <link rel="prev" href="../structure.html" title="Structure">
    10. 

  10. <link rel="next" href="../abstracts.html" title="Abstracts">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="../structure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../structure.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../abstracts.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="section">
    26. 

  26. <div class="titlepage"><div><div><h3 class="title">
    27. 

  27. <a name="spirit.structure.include"></a><a class="link" href="include.html" title="Include">Include</a>
    28. 

  28. </h3></div></div></div>
    29. 

  29. <p>
    30. 

  30.         Spirit is a header file only library. There are no libraries to link to.
    31. 

  31.         This section documents the structure of the Spirit headers.
    32. 

  32.       </p>
    33. 

  33. <p>
    34. 

  34.         Spirit contains five sub-libraries plus a 'support' module where common support
    35. 

  35.         classes are placed:
    36. 

  36.       </p>
    37. 

  37. <div class="itemizedlist"><ul class="itemizedlist" type="disc">
    38. 

  38. <li class="listitem">
    39. 

  39.             Classic
    40. 

  40.           </li>
    41. 

  41. <li class="listitem">
    42. 

  42.             Qi
    43. 

  43.           </li>
    44. 

  44. <li class="listitem">
    45. 

  45.             Karma
    46. 

  46.           </li>
    47. 

  47. <li class="listitem">
    48. 

  48.             Lex
    49. 

  49.           </li>
    50. 

  50. <li class="listitem">
    51. 

  51.             Phoenix
    52. 

  52.           </li>
    53. 

  53. <li class="listitem">
    54. 

  54.             Support
    55. 

  55.           </li>
    56. 

  56. </ul></div>
    57. 

  57. <p>
    58. 

  58.         The top Spirit directory is:
    59. 

  59.       </p>
    60. 

  60. <pre class="programlisting"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span>
    61. 

  61. </pre>
    62. 

  62. <p>
    63. 

  63.         Currently, the directory contains:
    64. 

  64.       </p>
    65. 

  65. <pre class="programlisting"><span class="special">[</span><span class="identifier">actor</span><span class="special">]</span>     <span class="special">[</span><span class="identifier">attribute</span><span class="special">]</span>     <span class="special">[</span><span class="identifier">core</span><span class="special">]</span>      <span class="special">[</span><span class="identifier">debug</span><span class="special">]</span>
    66. 

  66. <span class="special">[</span><span class="identifier">dynamic</span><span class="special">]</span>   <span class="special">[</span><span class="identifier">error_handling</span><span class="special">][</span><span class="identifier">home</span><span class="special">]</span>      <span class="special">[</span><span class="identifier">include</span><span class="special">]</span>
    67. 

  67. <span class="special">[</span><span class="identifier">iterator</span><span class="special">]</span>  <span class="special">[</span><span class="identifier">meta</span><span class="special">]</span>          <span class="special">[</span><span class="identifier">phoenix</span><span class="special">]</span>   <span class="special">[</span><span class="identifier">repository</span><span class="special">]</span>
    68. 

  68. <span class="special">[</span><span class="identifier">symbols</span><span class="special">]</span>   <span class="special">[</span><span class="identifier">tree</span><span class="special">]</span>          <span class="special">[</span><span class="identifier">utility</span><span class="special">]</span>
    69. 

  69. </pre>
    70. 

  70. <p>
    71. 

  71.         These include some old v1.8 directories that are now deprecated. These are:
    72. 

  72.         actor, attribute, core, debug, dynamic, error_handling, iterator, meta, phoenix,
    73. 

  73.         symbols, tree and utility. There is no guarantee that these directories will
    74. 

  74.         still be present in future versions of Spirit. We only keep them for backward
    75. 

  75.         compatibility. Please be warned.
    76. 

  76.       </p>
    77. 

  77. <p>
    78. 

  78.         Each directory (except include, home, and repository) has a corresponding
    79. 

  79.         header file that contains forwarding includes of each relevant include file
    80. 

  80.         that the directory contains. For example, there exists a &lt;boost/spirit/actor.hpp&gt;
    81. 

  81.         header file which includes all the relevant files from the boost/spirit/actor
    82. 

  82.         directory.
    83. 

  83.       </p>
    84. 

  84. <p>
    85. 

  85.         To distinguish between Spirit versions, you can inspect the version file:
    86. 

  86.       </p>
    87. 

  87. <pre class="programlisting"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span><span class="special">/</span><span class="identifier">version</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
    88. 

  88. </pre>
    89. 

  89. <p>
    90. 

  90.         using the preprocessor define
    91. 

  91.       </p>
    92. 

  92. <pre class="programlisting"><span class="identifier">SPIRIT_VERSION</span>
    93. 

  93. </pre>
    94. 

  94. <p>
    95. 

  95.         It is a hex number where the first two digits determine the major version
    96. 

  96.         while the last two digits determine the minor version. For example:
    97. 

  97.       </p>
    98. 

  98. <pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">SPIRIT_VERSION</span> <span class="number">0x2010</span> <span class="comment">// version 2.1
    99. 

  99. </span></pre>
    100. 

  100. <p>
    101. 

  101.         The include directory at:
    102. 

  102.       </p>
    103. 

  103. <pre class="programlisting"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span><span class="special">/</span><span class="identifier">include</span>
    104. 

  104. </pre>
    105. 

  105. <p>
    106. 

  106.         is a special flat directory that contains all the Spirit headers. To accommodate
    107. 

  107.         the flat structure, the headers are prefixed with the sub-library name:
    108. 

  108.       </p>
    109. 

  109. <div class="itemizedlist"><ul class="itemizedlist" type="disc">
    110. 

  110. <li class="listitem">
    111. 

  111.             classic_
    112. 

  112.           </li>
    113. 

  113. <li class="listitem">
    114. 

  114.             karma_
    115. 

  115.           </li>
    116. 

  116. <li class="listitem">
    117. 

  117.             lex_
    118. 

  118.           </li>
    119. 

  119. <li class="listitem">
    120. 

  120.             phoenix1_
    121. 

  121.           </li>
    122. 

  122. <li class="listitem">
    123. 

  123.             phoenix_
    124. 

  124.           </li>
    125. 

  125. <li class="listitem">
    126. 

  126.             qi_
    127. 

  127.           </li>
    128. 

  128. <li class="listitem">
    129. 

  129.             support_
    130. 

  130.           </li>
    131. 

  131. </ul></div>
    132. 

  132. <p>
    133. 

  133.         For example, if you used to include &lt;boost/spirit/actor.hpp&gt;, which
    134. 

  134.         is now a deprecated header, you should instead include &lt;boost/spirit/include/classic_actor.hpp&gt;
    135. 

  135.       </p>
    136. 

  136. <p>
    137. 

  137.         If you want to simply include the main sub-library name, then you can include:
    138. 

  138.       </p>
    139. 

  139. <div class="itemizedlist"><ul class="itemizedlist" type="disc">
    140. 

  140. <li class="listitem">
    141. 

  141.             &lt;boost/spirit/include/classic.hpp&gt;
    142. 

  142.           </li>
    143. 

  143. <li class="listitem">
    144. 

  144.             &lt;boost/spirit/include/karma.hpp&gt;
    145. 

  145.           </li>
    146. 

  146. <li class="listitem">
    147. 

  147.             &lt;boost/spirit/include/lex.hpp&gt;
    148. 

  148.           </li>
    149. 

  149. <li class="listitem">
    150. 

  150.             &lt;boost/spirit/include/phoenix1.hpp&gt;
    151. 

  151.           </li>
    152. 

  152. <li class="listitem">
    153. 

  153.             &lt;boost/spirit/include/phoenix.hpp&gt;
    154. 

  154.           </li>
    155. 

  155. <li class="listitem">
    156. 

  156.             &lt;boost/spirit/include/qi.hpp&gt;
    157. 

  157.           </li>
    158. 

  158. <li class="listitem">
    159. 

  159.             &lt;boost/spirit/include/support.hpp&gt;
    160. 

  160.           </li>
    161. 

  161. </ul></div>
    162. 

  162. <p>
    163. 

  163.         The home directory:
    164. 

  164.       </p>
    165. 

  165. <pre class="programlisting"><span class="identifier">BOOST_ROOT</span><span class="special">/</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span><span class="special">/</span><span class="identifier">home</span>
    166. 

  166. </pre>
    167. 

  167. <p>
    168. 

  168.         is the <span class="emphasis"><em>real</em></span> home of Spirit. It is the place where the
    169. 

  169.         various sub-libraries actually exist. The home directory contains:
    170. 

  170.       </p>
    171. 

  171. <pre class="programlisting"><span class="special">[</span><span class="identifier">classic</span><span class="special">]</span>   <span class="special">[</span><span class="identifier">karma</span><span class="special">]</span>     <span class="special">[</span><span class="identifier">lex</span><span class="special">]</span>
    172. 

  172. <span class="special">[</span><span class="identifier">phoenix</span><span class="special">]</span>   <span class="special">[</span><span class="identifier">qi</span><span class="special">]</span>        <span class="special">[</span><span class="identifier">support</span><span class="special">]</span>
    173. 

  173. </pre>
    174. 

  174. <p>
    175. 

  175.         As usual, these directories have their corresponding include files:
    176. 

  176.       </p>
    177. 

  177. <div class="itemizedlist"><ul class="itemizedlist" type="disc">
    178. 

  178. <li class="listitem">
    179. 

  179.             &lt;boost/spirit/home/classic.hpp&gt;
    180. 

  180.           </li>
    181. 

  181. <li class="listitem">
    182. 

  182.             &lt;boost/spirit/home/karma.hpp&gt;
    183. 

  183.           </li>
    184. 

  184. <li class="listitem">
    185. 

  185.             &lt;boost/spirit/home/lex.hpp&gt;
    186. 

  186.           </li>
    187. 

  187. <li class="listitem">
    188. 

  188.             &lt;boost/spirit/home/phoenix.hpp&gt;
    189. 

  189.           </li>
    190. 

  190. <li class="listitem">
    191. 

  191.             &lt;boost/spirit/home/qi.hpp&gt;
    192. 

  192.           </li>
    193. 

  193. <li class="listitem">
    194. 

  194.             &lt;boost/spirit/home/support.hpp&gt;
    195. 

  195.           </li>
    196. 

  196. </ul></div>
    197. 

  197. <p>
    198. 

  198.         The various sub-libraries include files can be found in each sub-directory
    199. 

  199.         containing the particular sub-library. The include structure of a sub-library
    200. 

  200.         is covered in its documentation. For consistency, each library follows the
    201. 

  201.         same scheme as above.
    202. 

  202.       </p>
    203. 

  203. <p>
    204. 

  204.         To keep it simple, you should use the flat include directory at boost/spirit/include.
    205. 

  205.       </p>
    206. 

  206. <p>
    207. 

  207.         For some additional information about the rationale you might want to have
    208. 

  208.         a look at the FAQ entry <a class="link" href="../faq.html#spirit.faq.i_m_very_confused_about_the_header_hell_in_my_boost_spirit_directory__what_s_all_this_about_">Header
    209. 

  209.         Hell</a>.
    210. 

  210.       </p>
    211. 

  211. <p>
    212. 

  212.         The subdirectory <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span><span class="special">/</span><span class="identifier">repository</span></code> does not belong to the main
    213. 

  213.         Spirit distribution. For more information please refer to: <a class="link" href="../repository.html" title="Spirit Repository">Spirit
    214. 

  214.         Repository</a>.
    215. 

  215.       </p>
    216. 

  216. </div>
    217. 

  217. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    218. 

  218. <td align="left"></td>
    219. 

  219. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2011 Joel de Guzman, Hartmut Kaiser<p>
    220. 

  220.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    221. 

  221.         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
    222. 

  222.       </p>
    223. 

  223. </div></td>
    224. 

  224. </tr></table>
    225. 

  225. <hr>
    226. 

  226. <div class="spirit-nav">
    227. 

  227. <a accesskey="p" href="../structure.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../structure.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../abstracts.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
    228. 

  228. </div>
    229. 

  229. </body>
    230. 

  230. </html>
    231.