directive.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Parser Directives</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="binary.html" title="Binary Parsers">
  10. <link rel="next" href="operator.html" title="Parser Operators">
  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="binary.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="operator.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.directive"></a><a class="link" href="directive.html" title="Parser Directives">Parser Directives</a>
  28. </h3></div></div></div>
  29. <div class="informaltable"><table class="table">
  30. <colgroup>
  31. <col>
  32. <col>
  33. <col>
  34. </colgroup>
  35. <thead><tr>
  36. <th>
  37. <p>
  38. Expression
  39. </p>
  40. </th>
  41. <th>
  42. <p>
  43. Attribute
  44. </p>
  45. </th>
  46. <th>
  47. <p>
  48. Description
  49. </p>
  50. </th>
  51. </tr></thead>
  52. <tbody>
  53. <tr>
  54. <td>
  55. <p>
  56. <code class="computeroutput"><span class="identifier">lexeme</span></code><code class="computeroutput"><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  57. </p>
  58. </td>
  59. <td>
  60. <p>
  61. <code class="computeroutput"><span class="identifier">A</span></code>
  62. </p>
  63. </td>
  64. <td>
  65. <p>
  66. Disable skip parsing for <code class="computeroutput"><span class="identifier">a</span></code>,
  67. does pre-skipping
  68. </p>
  69. </td>
  70. </tr>
  71. <tr>
  72. <td>
  73. <p>
  74. <code class="computeroutput"><span class="identifier">no_skip</span><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  75. </p>
  76. </td>
  77. <td>
  78. <p>
  79. <code class="computeroutput"><span class="identifier">A</span></code>
  80. </p>
  81. </td>
  82. <td>
  83. <p>
  84. Disable skip parsing for <code class="computeroutput"><span class="identifier">a</span></code>,
  85. no pre-skipping
  86. </p>
  87. </td>
  88. </tr>
  89. <tr>
  90. <td>
  91. <p>
  92. <code class="computeroutput"><span class="identifier">no_case</span></code><code class="computeroutput"><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  93. </p>
  94. </td>
  95. <td>
  96. <p>
  97. <code class="computeroutput"><span class="identifier">A</span></code>
  98. </p>
  99. </td>
  100. <td>
  101. <p>
  102. Inhibits case-sensitivity for <code class="computeroutput"><span class="identifier">a</span></code>
  103. </p>
  104. </td>
  105. </tr>
  106. <tr>
  107. <td>
  108. <p>
  109. <code class="computeroutput"><span class="identifier">omit</span></code><code class="computeroutput"><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  110. </p>
  111. </td>
  112. <td>
  113. <p>
  114. <code class="computeroutput"><span class="identifier">Unused</span></code>
  115. </p>
  116. </td>
  117. <td>
  118. <p>
  119. Ignores the attribute type of <code class="computeroutput"><span class="identifier">a</span></code>
  120. </p>
  121. </td>
  122. </tr>
  123. <tr>
  124. <td>
  125. <p>
  126. <code class="computeroutput"><span class="identifier">matches</span></code><code class="computeroutput"><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  127. </p>
  128. </td>
  129. <td>
  130. <p>
  131. <code class="computeroutput"><span class="keyword">bool</span></code>
  132. </p>
  133. </td>
  134. <td>
  135. <p>
  136. Return if the embedded parser <code class="computeroutput"><span class="identifier">a</span></code>
  137. matched its input
  138. </p>
  139. </td>
  140. </tr>
  141. <tr>
  142. <td>
  143. <p>
  144. <code class="computeroutput"><span class="identifier">raw</span></code><code class="computeroutput"><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  145. </p>
  146. </td>
  147. <td>
  148. <p>
  149. <a href="../../../../../../../libs/range/doc/html/range/reference/utilities/iterator_range.html" target="_top"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_range</span></code></a><code class="computeroutput"><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;</span></code>
  150. </p>
  151. </td>
  152. <td>
  153. <p>
  154. Presents the transduction of <code class="computeroutput"><span class="identifier">a</span></code>
  155. as an iterator range
  156. </p>
  157. </td>
  158. </tr>
  159. <tr>
  160. <td>
  161. <p>
  162. <code class="computeroutput"><span class="identifier">expect</span></code><code class="computeroutput"><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  163. </p>
  164. </td>
  165. <td>
  166. <p>
  167. <code class="computeroutput"><span class="identifier">A</span></code>
  168. </p>
  169. </td>
  170. <td>
  171. <p>
  172. Throw an exception if parsing <code class="computeroutput"><span class="identifier">a</span></code>
  173. fails
  174. </p>
  175. </td>
  176. </tr>
  177. <tr>
  178. <td>
  179. <p>
  180. <code class="computeroutput"><span class="identifier">repeat</span><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  181. </p>
  182. </td>
  183. <td>
  184. <p>
  185. <code class="computeroutput"><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">A</span><span class="special">&gt;</span></code>
  186. </p>
  187. </td>
  188. <td>
  189. <p>
  190. Repeat <code class="computeroutput"><span class="identifier">a</span></code> zero or
  191. more times
  192. </p>
  193. </td>
  194. </tr>
  195. <tr>
  196. <td>
  197. <p>
  198. <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">N</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
  199. </p>
  200. </td>
  201. <td>
  202. <p>
  203. <code class="computeroutput"><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">A</span><span class="special">&gt;</span></code>
  204. </p>
  205. </td>
  206. <td>
  207. <p>
  208. Repeat <code class="computeroutput"><span class="identifier">a</span></code> <code class="computeroutput"><span class="identifier">N</span></code> times
  209. </p>
  210. </td>
  211. </tr>
  212. <tr>
  213. <td>
  214. <p>
  215. <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">N</span><span class="special">,</span>
  216. <span class="identifier">M</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
  217. </p>
  218. </td>
  219. <td>
  220. <p>
  221. <code class="computeroutput"><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">A</span><span class="special">&gt;</span></code>
  222. </p>
  223. </td>
  224. <td>
  225. <p>
  226. Repeat <code class="computeroutput"><span class="identifier">a</span></code> <code class="computeroutput"><span class="identifier">N</span></code> to <code class="computeroutput"><span class="identifier">M</span></code>
  227. times
  228. </p>
  229. </td>
  230. </tr>
  231. <tr>
  232. <td>
  233. <p>
  234. <code class="computeroutput"><span class="identifier">repeat</span><span class="special">(</span><span class="identifier">N</span><span class="special">,</span>
  235. <span class="identifier">inf</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
  236. </p>
  237. </td>
  238. <td>
  239. <p>
  240. <code class="computeroutput"><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">A</span><span class="special">&gt;</span></code>
  241. </p>
  242. </td>
  243. <td>
  244. <p>
  245. Repeat <code class="computeroutput"><span class="identifier">a</span></code> <code class="computeroutput"><span class="identifier">N</span></code> or more times
  246. </p>
  247. </td>
  248. </tr>
  249. <tr>
  250. <td>
  251. <p>
  252. <code class="computeroutput"><span class="identifier">skip</span></code><code class="computeroutput"><span class="special">[</span><span class="identifier">a</span><span class="special">]</span></code>
  253. </p>
  254. </td>
  255. <td>
  256. <p>
  257. <code class="computeroutput"><span class="identifier">A</span></code>
  258. </p>
  259. </td>
  260. <td>
  261. <p>
  262. Re-establish the skipper that got inhibited by lexeme or no_skip.
  263. </p>
  264. </td>
  265. </tr>
  266. <tr>
  267. <td>
  268. <p>
  269. <code class="computeroutput"><span class="identifier">skip</span></code><code class="computeroutput"><span class="special">(</span><span class="identifier">p</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code>
  270. </p>
  271. </td>
  272. <td>
  273. <p>
  274. <code class="computeroutput"><span class="identifier">A</span></code>
  275. </p>
  276. </td>
  277. <td>
  278. <p>
  279. Use <code class="computeroutput"><span class="identifier">p</span></code> as a skipper
  280. for parsing <code class="computeroutput"><span class="identifier">a</span></code>
  281. </p>
  282. </td>
  283. </tr>
  284. </tbody>
  285. </table></div>
  286. </div>
  287. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  288. <td align="left"></td>
  289. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2018 Joel de Guzman,
  290. Hartmut Kaiser<p>
  291. Distributed under the Boost Software License, Version 1.0. (See accompanying
  292. 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>)
  293. </p>
  294. </div></td>
  295. </tr></table>
  296. <hr>
  297. <div class="spirit-nav">
  298. <a accesskey="p" href="binary.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="operator.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  299. </div>
  300. </body>
  301. </html>