9
3

karma_confix_generator.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Karma Confix Generator</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 Repository 0.2">
  8. <link rel="up" href="../directives.html" title="Karma Generator Directives">
  9. <link rel="prev" href="../directives.html" title="Karma Generator Directives">
  10. <link rel="next" href="../nonterminal.html" title="Karma Generator Non-terminals">
  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="../directives.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directives.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="../nonterminal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h4 class="title">
  27. <a name="spirit_repository.karma_components.directives.karma_confix_generator"></a><a class="link" href="karma_confix_generator.html" title="Karma Confix Generator">Karma
  28. Confix Generator</a>
  29. </h4></div></div></div>
  30. <h6>
  31. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h0"></a>
  32. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.description"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.description">Description</a>
  33. </h6>
  34. <p>
  35. The <span class="emphasis"><em>Spirit.Karma</em></span> <code class="computeroutput"><span class="identifier">confix</span></code>
  36. generator is a generator directive component allowing to embed any generated
  37. ouput inside an opening (a prefix) and a closing (a suffix). A simple example
  38. is a C comment: <code class="computeroutput"><span class="comment">/* This is a C comment */</span></code>
  39. which can be generated using the <code class="computeroutput"><span class="identifier">confix</span></code>
  40. generator as: <code class="computeroutput"><span class="identifier">confix</span><span class="special">(</span><span class="string">"/*"</span><span class="special">,</span>
  41. <span class="string">"*/"</span><span class="special">)[</span><span class="string">"This is a C comment"</span><span class="special">]</span></code>.
  42. The general syntax for using the <code class="computeroutput"><span class="identifier">confix</span></code>
  43. is:
  44. </p>
  45. <pre class="programlisting"><span class="identifier">confix</span><span class="special">(</span><span class="identifier">prefix</span><span class="special">,</span> <span class="identifier">suffix</span><span class="special">)[</span><span class="identifier">subject</span><span class="special">]</span>
  46. </pre>
  47. <p>
  48. which results in generating a sequence equivalent to
  49. </p>
  50. <pre class="programlisting"><span class="identifier">prefix</span> <span class="special">&lt;&lt;</span> <span class="identifier">subject</span> <span class="special">&lt;&lt;</span> <span class="identifier">suffix</span>
  51. </pre>
  52. <p>
  53. Using the <code class="computeroutput"><span class="identifier">confix</span></code> component
  54. instead of the explicit sequence has the advantage of being able to encapsulate
  55. the prefix and the suffix into a separate generator construct. The following
  56. code snippet illustrates the idea:
  57. </p>
  58. <pre class="programlisting"><span class="comment">// Define a metafunction allowing to compute the type of the confix()</span>
  59. <span class="comment">// construct</span>
  60. <span class="keyword">namespace</span> <span class="identifier">traits</span>
  61. <span class="special">{</span>
  62. <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">;</span>
  63. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Prefix</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Suffix</span> <span class="special">=</span> <span class="identifier">Prefix</span><span class="special">&gt;</span>
  64. <span class="keyword">struct</span> <span class="identifier">confix_spec</span>
  65. <span class="special">:</span> <span class="identifier">spirit</span><span class="special">::</span><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">terminal</span><span class="special">&lt;</span><span class="identifier">repository</span><span class="special">::</span><span class="identifier">tag</span><span class="special">::</span><span class="identifier">confix</span><span class="special">(</span><span class="identifier">Prefix</span><span class="special">,</span> <span class="identifier">Suffix</span><span class="special">)&gt;</span>
  66. <span class="special">{};</span>
  67. <span class="special">};</span>
  68. <span class="comment">// Define a helper function allowing to create a confix() construct from </span>
  69. <span class="comment">// arbitrary prefix and suffix generators</span>
  70. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Prefix</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Suffix</span><span class="special">&gt;</span>
  71. <span class="keyword">typename</span> <span class="identifier">traits</span><span class="special">::</span><span class="identifier">confix_spec</span><span class="special">&lt;</span><span class="identifier">Prefix</span><span class="special">,</span> <span class="identifier">Suffix</span><span class="special">&gt;::</span><span class="identifier">type</span>
  72. <span class="identifier">confix_spec</span><span class="special">(</span><span class="identifier">Prefix</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">prefix</span><span class="special">,</span> <span class="identifier">Suffix</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">suffix</span><span class="special">)</span>
  73. <span class="special">{</span>
  74. <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">;</span>
  75. <span class="keyword">return</span> <span class="identifier">repository</span><span class="special">::</span><span class="identifier">confix</span><span class="special">(</span><span class="identifier">prefix</span><span class="special">,</span> <span class="identifier">suffix</span><span class="special">);</span>
  76. <span class="special">}</span>
  77. <span class="comment">// Define a helper function to construct a HTML tag from the tag name</span>
  78. <span class="keyword">inline</span> <span class="keyword">typename</span> <span class="identifier">traits</span><span class="special">::</span><span class="identifier">confix_spec</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;::</span><span class="identifier">type</span>
  79. <span class="identifier">tag</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">tagname</span><span class="special">)</span>
  80. <span class="special">{</span>
  81. <span class="keyword">return</span> <span class="identifier">confix_spec</span><span class="special">(</span><span class="string">"&lt;"</span> <span class="special">+</span> <span class="identifier">tagname</span> <span class="special">+</span> <span class="string">"&gt;"</span><span class="special">,</span> <span class="string">"&lt;/"</span> <span class="special">+</span> <span class="identifier">tagname</span> <span class="special">+</span> <span class="string">"&gt;"</span><span class="special">);</span>
  82. <span class="special">}</span>
  83. <span class="comment">// Define generators for different HTML tags the HTML tag</span>
  84. <span class="keyword">typedef</span> <span class="identifier">traits</span><span class="special">::</span><span class="identifier">confix_spec</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">ol</span> <span class="special">=</span> <span class="identifier">tag</span><span class="special">(</span><span class="string">"ol"</span><span class="special">);</span> <span class="comment">// &lt;ol&gt;...&lt;/ol&gt; </span>
  85. <span class="keyword">typedef</span> <span class="identifier">traits</span><span class="special">::</span><span class="identifier">confix_spec</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">li</span> <span class="special">=</span> <span class="identifier">tag</span><span class="special">(</span><span class="string">"li"</span><span class="special">);</span> <span class="comment">// &lt;li&gt;...&lt;/li&gt; </span>
  86. </pre>
  87. <p>
  88. Now, for instance, the above definitions allow to generate the HTML 'ol'
  89. tag using a simple: <code class="computeroutput"><span class="identifier">ol</span><span class="special">[</span><span class="string">"Some text"</span><span class="special">]</span></code> (which results in <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">ol</span><span class="special">&gt;</span><span class="identifier">Some</span> <span class="identifier">text</span><span class="special">&lt;/</span><span class="identifier">ol</span><span class="special">&gt;</span></code>).
  90. </p>
  91. <h6>
  92. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h1"></a>
  93. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.header"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.header">Header</a>
  94. </h6>
  95. <pre class="programlisting"><span class="comment">// forwards to &lt;boost/spirit/repository/home/karma/directive/confix.hpp&gt;</span>
  96. <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">repository</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">karma_confix</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  97. </pre>
  98. <h6>
  99. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h2"></a>
  100. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.synopsis"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.synopsis">Synopsis</a>
  101. </h6>
  102. <pre class="programlisting"><span class="identifier">confix</span><span class="special">(</span><span class="identifier">prefix</span><span class="special">,</span> <span class="identifier">suffix</span><span class="special">)[</span><span class="identifier">subject</span><span class="special">]</span>
  103. </pre>
  104. <h6>
  105. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h3"></a>
  106. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.parameters"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.parameters">Parameters</a>
  107. </h6>
  108. <div class="informaltable"><table class="table">
  109. <colgroup>
  110. <col>
  111. <col>
  112. </colgroup>
  113. <thead><tr>
  114. <th>
  115. <p>
  116. Parameter
  117. </p>
  118. </th>
  119. <th>
  120. <p>
  121. Description
  122. </p>
  123. </th>
  124. </tr></thead>
  125. <tbody>
  126. <tr>
  127. <td>
  128. <p>
  129. <code class="computeroutput"><span class="identifier">prefix</span></code>
  130. </p>
  131. </td>
  132. <td>
  133. <p>
  134. The generator construct to use to format the opening (the prefix).
  135. The prefix is the part generated <span class="emphasis"><em>before</em></span>
  136. any output as generated by the <code class="computeroutput"><span class="identifier">subject</span></code>.
  137. </p>
  138. </td>
  139. </tr>
  140. <tr>
  141. <td>
  142. <p>
  143. <code class="computeroutput"><span class="identifier">suffix</span></code>
  144. </p>
  145. </td>
  146. <td>
  147. <p>
  148. The generator construct to use to format the ending (the suffix).
  149. The suffix is the part generated <span class="emphasis"><em>after</em></span> any
  150. output as generated by the <code class="computeroutput"><span class="identifier">subject</span></code>.
  151. </p>
  152. </td>
  153. </tr>
  154. <tr>
  155. <td>
  156. <p>
  157. <code class="computeroutput"><span class="identifier">subject</span></code>
  158. </p>
  159. </td>
  160. <td>
  161. <p>
  162. The generator construct to use to format the actual output in
  163. between the <code class="computeroutput"><span class="identifier">prefix</span></code>
  164. and <code class="computeroutput"><span class="identifier">suffix</span></code> parts.
  165. </p>
  166. </td>
  167. </tr>
  168. </tbody>
  169. </table></div>
  170. <p>
  171. All three parameters can be arbitrary complex generators themselves.
  172. </p>
  173. <h6>
  174. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h4"></a>
  175. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.attribute"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.attribute">Attribute</a>
  176. </h6>
  177. <p>
  178. The <code class="computeroutput"><span class="identifier">confix</span></code> component exposes
  179. the attribute type of its subject as its own attribute type. If the <code class="computeroutput"><span class="identifier">subject</span></code> does not expose any attribute
  180. (the type is <code class="computeroutput"><span class="identifier">unused_type</span></code>),
  181. then the <code class="computeroutput"><span class="identifier">confix</span></code> does not
  182. expose any attribute either.
  183. </p>
  184. <pre class="programlisting"><span class="identifier">a</span><span class="special">:</span> <span class="identifier">A</span> <span class="special">--&gt;</span> <span class="identifier">confix</span><span class="special">(</span><span class="identifier">p</span><span class="special">,</span> <span class="identifier">s</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]:</span> <span class="identifier">A</span>
  185. </pre>
  186. <div class="note"><table border="0" summary="Note">
  187. <tr>
  188. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
  189. <th align="left">Note</th>
  190. </tr>
  191. <tr><td align="left" valign="top"><p>
  192. This notation is used all over the Spirit documentation and reads as:
  193. Given, <code class="computeroutput"><span class="identifier">a</span></code> is generator,
  194. and <code class="computeroutput"><span class="identifier">A</span></code> is the type of
  195. the attribute of generator <code class="computeroutput"><span class="identifier">a</span></code>,
  196. then the type of the attribute exposed by <code class="computeroutput"><span class="identifier">confix</span><span class="special">(</span><span class="identifier">p</span><span class="special">,</span> <span class="identifier">s</span><span class="special">)[</span><span class="identifier">a</span><span class="special">]</span></code> will be <code class="computeroutput"><span class="identifier">A</span></code>
  197. as well.
  198. </p></td></tr>
  199. </table></div>
  200. <h6>
  201. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h5"></a>
  202. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.example"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.example">Example</a>
  203. </h6>
  204. <p>
  205. The following example shows simple use cases of the <code class="computeroutput"><span class="identifier">confix</span></code>
  206. generator. We will illustrate its usage by generating different comment
  207. styles and a function prototype (for the full example code see here: <a href="../../../../../example/karma/confix.cpp" target="_top">confix.cpp</a>)
  208. </p>
  209. <h6>
  210. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h6"></a>
  211. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.prerequisites"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.prerequisites">Prerequisites</a>
  212. </h6>
  213. <p>
  214. In addition to the main header file needed to include the core components
  215. implemented in <span class="emphasis"><em>Spirit.Karma</em></span> we add the header file
  216. needed for the new <code class="computeroutput"><span class="identifier">confix</span></code>
  217. generator.
  218. </p>
  219. <p>
  220. </p>
  221. <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">include</span><span class="special">/</span><span class="identifier">karma</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  222. <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">repository</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">karma_confix</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  223. </pre>
  224. <p>
  225. </p>
  226. <p>
  227. To make all the code below more readable we introduce the following namespaces.
  228. </p>
  229. <p>
  230. </p>
  231. <pre class="programlisting"><span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">;</span>
  232. <span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">ascii</span><span class="special">;</span>
  233. <span class="keyword">using</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">spirit</span><span class="special">::</span><span class="identifier">repository</span><span class="special">::</span><span class="identifier">confix</span><span class="special">;</span>
  234. </pre>
  235. <p>
  236. </p>
  237. <h6>
  238. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h7"></a>
  239. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.generating_different_comment_styles"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.generating_different_comment_styles">Generating
  240. Different Comment Styles</a>
  241. </h6>
  242. <p>
  243. We will show how to generate different comment styles. First we will generate
  244. a C++ comment:
  245. </p>
  246. <p>
  247. </p>
  248. <pre class="programlisting"><span class="comment">// C++ comment</span>
  249. <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span>
  250. <span class="identifier">karma</span><span class="special">::</span><span class="identifier">format_delimited</span><span class="special">(</span>
  251. <span class="identifier">confix</span><span class="special">(</span><span class="string">"//"</span><span class="special">,</span> <span class="identifier">eol</span><span class="special">)[</span><span class="identifier">string</span><span class="special">],</span> <span class="comment">// format description</span>
  252. <span class="identifier">space</span><span class="special">,</span> <span class="comment">// delimiter</span>
  253. <span class="string">"This is a comment"</span> <span class="comment">// data</span>
  254. <span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
  255. </pre>
  256. <p>
  257. </p>
  258. <p>
  259. This code snippet will obviouly generate <code class="computeroutput"><span class="comment">//
  260. This is a comment \n </span></code>. Similarily generating a 'C'-style
  261. comment proves to be straightforward:
  262. </p>
  263. <p>
  264. </p>
  265. <pre class="programlisting"><span class="comment">// C comment</span>
  266. <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span>
  267. <span class="identifier">karma</span><span class="special">::</span><span class="identifier">format_delimited</span><span class="special">(</span>
  268. <span class="identifier">confix</span><span class="special">(</span><span class="string">"/*"</span><span class="special">,</span> <span class="string">"*/"</span><span class="special">)[</span><span class="identifier">string</span><span class="special">],</span> <span class="comment">// format description</span>
  269. <span class="identifier">space</span><span class="special">,</span> <span class="comment">// delimiter</span>
  270. <span class="string">"This is a comment"</span> <span class="comment">// data</span>
  271. <span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
  272. </pre>
  273. <p>
  274. </p>
  275. <p>
  276. which again will generate <code class="computeroutput"><span class="comment">/* This is a comment
  277. */</span> </code>.
  278. </p>
  279. <h6>
  280. <a name="spirit_repository.karma_components.directives.karma_confix_generator.h8"></a>
  281. <span class="phrase"><a name="spirit_repository.karma_components.directives.karma_confix_generator.generating_a_function_prototype"></a></span><a class="link" href="karma_confix_generator.html#spirit_repository.karma_components.directives.karma_confix_generator.generating_a_function_prototype">Generating
  282. a Function Prototype</a>
  283. </h6>
  284. <p>
  285. Generating a function prototype given a function name a vector or parameter
  286. names is simple as well:
  287. </p>
  288. <p>
  289. </p>
  290. <pre class="programlisting"><span class="comment">// Generate a function call with an arbitrary parameter list</span>
  291. <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;</span> <span class="identifier">parameters</span><span class="special">;</span>
  292. <span class="identifier">parameters</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="string">"par1"</span><span class="special">);</span>
  293. <span class="identifier">parameters</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="string">"par2"</span><span class="special">);</span>
  294. <span class="identifier">parameters</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="string">"par3"</span><span class="special">);</span>
  295. <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span>
  296. <span class="identifier">karma</span><span class="special">::</span><span class="identifier">format</span><span class="special">(</span>
  297. <span class="identifier">string</span> <span class="special">&lt;&lt;</span> <span class="identifier">confix</span><span class="special">(</span><span class="char">'('</span><span class="special">,</span> <span class="char">')'</span><span class="special">)[</span><span class="identifier">string</span> <span class="special">%</span> <span class="char">','</span><span class="special">],</span> <span class="comment">// format description</span>
  298. <span class="string">"func"</span><span class="special">,</span> <span class="comment">// function name</span>
  299. <span class="identifier">parameters</span> <span class="comment">// parameter names</span>
  300. <span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
  301. </pre>
  302. <p>
  303. </p>
  304. <p>
  305. which generates the expected output: <code class="computeroutput"><span class="identifier">func</span><span class="special">(</span><span class="identifier">par1</span><span class="special">,</span><span class="identifier">par2</span><span class="special">,</span><span class="identifier">par3</span><span class="special">)</span></code>.
  306. </p>
  307. </div>
  308. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  309. <td align="left"></td>
  310. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2011 Joel de Guzman, Hartmut Kaiser<p>
  311. Distributed under the Boost Software License, Version 1.0. (See accompanying
  312. 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>)
  313. </p>
  314. </div></td>
  315. </tr></table>
  316. <hr>
  317. <div class="spirit-nav">
  318. <a accesskey="p" href="../directives.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../directives.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="../nonterminal.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  319. </div>
  320. </body>
  321. </html>