include.html 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Include</title>
  5. <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../index.html" title="Spirit X3 3.0.4">
  8. <link rel="up" href="../index.html" title="Spirit X3 3.0.4">
  9. <link rel="prev" href="introduction.html" title="Introduction">
  10. <link rel="next" href="abstracts.html" title="Abstracts">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="introduction.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27. <a name="spirit_x3.include"></a><a class="link" href="include.html" title="Include">Include</a>
  28. </h2></div></div></div>
  29. <p>
  30. Spirit is a header file only library. There are no libraries to link to. To
  31. use Spirit X3 simply include:
  32. </p>
  33. <pre class="programlisting"><span class="preprocessor">#include</span> <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">home</span><span class="special">/</span><span class="identifier">x3</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  34. </pre>
  35. <p>
  36. To distinguish between Spirit versions, you can inspect the version file:
  37. </p>
  38. <pre class="programlisting"><span class="preprocessor">#include</span> <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">home</span><span class="special">/</span><span class="identifier">x3</span><span class="special">/</span><span class="identifier">version</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  39. </pre>
  40. <p>
  41. using the preprocessor define
  42. </p>
  43. <pre class="programlisting"><span class="identifier">SPIRIT_X3_VERSION</span>
  44. </pre>
  45. <p>
  46. It is a hex number where the first two digits determine the major version while
  47. the last two digits determine the minor version. For example:
  48. </p>
  49. <pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">SPIRIT_X3_VERSION</span> <span class="number">0x3000</span> <span class="comment">// version 3.0</span>
  50. </pre>
  51. </div>
  52. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  53. <td align="left"></td>
  54. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2018 Joel de Guzman,
  55. Hartmut Kaiser<p>
  56. Distributed under the Boost Software License, Version 1.0. (See accompanying
  57. 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>)
  58. </p>
  59. </div></td>
  60. </tr></table>
  61. <hr>
  62. <div class="spirit-nav">
  63. <a accesskey="p" href="introduction.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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>
  64. </div>
  65. </body>
  66. </html>