common_notation.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Common Notation</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="../quick_reference.html" title="Quick Reference">
  9. <link rel="prev" href="../quick_reference.html" title="Quick Reference">
  10. <link rel="next" href="char.html" title="Character Parsers">
  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="../quick_reference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.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="char.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h3 class="title">
  27. <a name="spirit_x3.quick_reference.common_notation"></a><a class="link" href="common_notation.html" title="Common Notation">Common Notation</a>
  28. </h3></div></div></div>
  29. <div class="variablelist">
  30. <p class="title"><b>Notation</b></p>
  31. <dl class="variablelist">
  32. <dt><span class="term"><code class="computeroutput"><span class="identifier">P</span></code></span></dt>
  33. <dd><p>
  34. Parser type
  35. </p></dd>
  36. <dt><span class="term"><code class="computeroutput"><span class="identifier">p</span><span class="special">,</span>
  37. <span class="identifier">a</span><span class="special">,</span>
  38. <span class="identifier">b</span><span class="special">,</span>
  39. <span class="identifier">c</span></code></span></dt>
  40. <dd><p>
  41. Parser objects
  42. </p></dd>
  43. <dt><span class="term"><code class="computeroutput"><span class="identifier">A</span><span class="special">,</span>
  44. <span class="identifier">B</span><span class="special">,</span>
  45. <span class="identifier">C</span></code></span></dt>
  46. <dd><p>
  47. Attribute types of parsers <code class="computeroutput"><span class="identifier">a</span></code>,
  48. <code class="computeroutput"><span class="identifier">b</span></code> and <code class="computeroutput"><span class="identifier">c</span></code>
  49. </p></dd>
  50. <dt><span class="term"><code class="computeroutput"><span class="identifier">I</span></code></span></dt>
  51. <dd><p>
  52. The iterator type used for parsing
  53. </p></dd>
  54. <dt><span class="term"><code class="computeroutput"><span class="identifier">Unused</span></code></span></dt>
  55. <dd><p>
  56. An <code class="computeroutput"><span class="identifier">unused_type</span></code>
  57. </p></dd>
  58. <dt><span class="term"><code class="computeroutput"><span class="identifier">Context</span></code></span></dt>
  59. <dd><p>
  60. The enclosing rule's <code class="computeroutput"><span class="identifier">Context</span></code>
  61. type
  62. </p></dd>
  63. <dt><span class="term"><code class="computeroutput"><span class="identifier">attrib</span></code></span></dt>
  64. <dd><p>
  65. An attribute value
  66. </p></dd>
  67. <dt><span class="term"><code class="computeroutput"><span class="identifier">Attrib</span></code></span></dt>
  68. <dd><p>
  69. An attribute type
  70. </p></dd>
  71. <dt><span class="term"><code class="computeroutput"><span class="identifier">b</span></code></span></dt>
  72. <dd><p>
  73. A boolean expression
  74. </p></dd>
  75. <dt><span class="term"><code class="computeroutput"><span class="identifier">fp</span></code></span></dt>
  76. <dd><p>
  77. A (lazy parser) function with signature <code class="computeroutput"><span class="identifier">P</span><span class="special">(</span><span class="identifier">Unused</span><span class="special">,</span> <span class="identifier">Context</span><span class="special">)</span></code>
  78. </p></dd>
  79. <dt><span class="term"><code class="computeroutput"><span class="identifier">fa</span></code></span></dt>
  80. <dd><p>
  81. A (semantic action) function with signature <code class="computeroutput"><span class="keyword">void</span><span class="special">(</span><span class="identifier">Context</span><span class="special">&amp;)</span></code>.
  82. </p></dd>
  83. <dt><span class="term"><code class="computeroutput"><span class="identifier">first</span></code></span></dt>
  84. <dd><p>
  85. An iterator pointing to the start of input
  86. </p></dd>
  87. <dt><span class="term"><code class="computeroutput"><span class="identifier">last</span></code></span></dt>
  88. <dd><p>
  89. An iterator pointing to the end of input
  90. </p></dd>
  91. <dt><span class="term"><code class="computeroutput"><span class="identifier">Ch</span></code></span></dt>
  92. <dd><p>
  93. Character-class specific character type (See Character Class Types)
  94. </p></dd>
  95. <dt><span class="term"><code class="computeroutput"><span class="identifier">ch</span></code></span></dt>
  96. <dd><p>
  97. Character-class specific character (See Character Class Types)
  98. </p></dd>
  99. <dt><span class="term"><code class="computeroutput"><span class="identifier">ch2</span></code></span></dt>
  100. <dd><p>
  101. Character-class specific character (See Character Class Types)
  102. </p></dd>
  103. <dt><span class="term"><code class="computeroutput"><span class="identifier">charset</span></code></span></dt>
  104. <dd><p>
  105. Character-set specifier string (example: "a-z0-9")
  106. </p></dd>
  107. <dt><span class="term"><code class="computeroutput"><span class="identifier">str</span></code></span></dt>
  108. <dd><p>
  109. Character-class specific string (See Character Class Types)
  110. </p></dd>
  111. <dt><span class="term"><code class="computeroutput"><span class="identifier">Str</span></code></span></dt>
  112. <dd><p>
  113. Attribute of <code class="computeroutput"><span class="identifier">str</span></code>:
  114. <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span></code>
  115. where <code class="computeroutput"><span class="identifier">T</span></code> is the underlying
  116. character type of <code class="computeroutput"><span class="identifier">str</span></code>
  117. </p></dd>
  118. <dt><span class="term"><code class="computeroutput"><span class="identifier">tuple</span><span class="special">&lt;&gt;</span></code></span></dt>
  119. <dd><p>
  120. Used as a placeholder for a fusion sequence
  121. </p></dd>
  122. <dt><span class="term"><code class="computeroutput"><span class="identifier">vector</span><span class="special">&lt;&gt;</span></code></span></dt>
  123. <dd><p>
  124. Used as a placeholder for an STL container
  125. </p></dd>
  126. <dt><span class="term"><code class="computeroutput"><span class="identifier">variant</span><span class="special">&lt;&gt;</span></code></span></dt>
  127. <dd><p>
  128. Used as a placeholder for a boost::variant
  129. </p></dd>
  130. <dt><span class="term"><code class="computeroutput"><span class="identifier">optional</span><span class="special">&lt;&gt;</span></code></span></dt>
  131. <dd><p>
  132. Used as a placeholder for a boost::optional
  133. </p></dd>
  134. </dl>
  135. </div>
  136. </div>
  137. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  138. <td align="left"></td>
  139. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2018 Joel de Guzman,
  140. Hartmut Kaiser<p>
  141. Distributed under the Boost Software License, Version 1.0. (See accompanying
  142. 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>)
  143. </p>
  144. </div></td>
  145. </tr></table>
  146. <hr>
  147. <div class="spirit-nav">
  148. <a accesskey="p" href="../quick_reference.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quick_reference.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="char.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  149. </div>
  150. </body>
  151. </html>