PageRenderTime 44ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/libs/phoenix/doc/html/phoenix/reference.html

https://bitbucket.org/drainware/boost
HTML | 156 lines | 156 code | 0 blank | 0 comment | 0 complexity | 752b46f896ebe9338f822f2535c536f5 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

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

  5. <title>Reference</title>
    6. 

  6. <link rel="stylesheet" href="../boostbook.css" type="text/css">
    7. 

  7. <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
    8. 

  8. <link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Phoenix 3.0">
    9. 

  9. <link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Phoenix 3.0">
    10. 

  10. <link rel="prev" href="actor.html" title="Actor">
    11. 

  11. <link rel="next" href="reference/core_mechanisms.html" title="Core Mechanisms">
    12. 

  12. </head>
    13. 

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

  14. <table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
    15. 

  15. <hr>
    16. 

  16. <div class="spirit-nav">
    17. 

  17. <a accesskey="p" href="actor.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="reference/core_mechanisms.html"><img src="../images/next.png" alt="Next"></a>
    18. 

  18. </div>
    19. 

  19. <div class="section">
    20. 

  20. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
    21. 

  21. <a name="phoenix.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
    22. 

  22. </h2></div></div></div>
    23. 

  23. <div class="toc"><dl>
    24. 

  24. <dt><span class="section"><a href="reference/core_mechanisms.html">Core Mechanisms</a></span></dt>
    25. 

  25. <dd><dl>
    26. 

  26. <dt><span class="section"><a href="reference/core_mechanisms/_actor_.html"><code class="computeroutput"><span class="identifier">actor</span></code></a></span></dt>
    27. 

  27. <dt><span class="section"><a href="reference/core_mechanisms/_meta_grammar_.html"><code class="computeroutput"><span class="identifier">meta_grammar</span></code></a></span></dt>
    28. 

  28. <dt><span class="section"><a href="reference/core_mechanisms/environment.html"><code class="computeroutput"><span class="identifier">environment</span></code></a></span></dt>
    29. 

  29. <dt><span class="section"><a href="reference/core_mechanisms/evaluator.html"><code class="computeroutput"><span class="identifier">evaluator</span></code></a></span></dt>
    30. 

  30. <dd><dl>
    31. 

  31. <dt><span class="section"><a href="reference/core_mechanisms/evaluator/default_actions.html"><code class="computeroutput"><span class="identifier">default_actions</span></code></a></span></dt>
    32. 

  32. <dt><span class="section"><a href="reference/core_mechanisms/evaluator/is_nullary.html"><code class="computeroutput"><span class="identifier">is_nullary</span></code></a></span></dt>
    33. 

  33. <dt><span class="section"><a href="reference/core_mechanisms/evaluator/arity.html"><code class="computeroutput"><span class="identifier">arity</span></code></a></span></dt>
    34. 

  34. </dl></dd>
    35. 

  35. <dt><span class="section"><a href="reference/core_mechanisms/expression.html"><code class="computeroutput"><span class="identifier">expression</span></code></a></span></dt>
    36. 

  36. <dt><span class="section"><a href="reference/core_mechanisms/phoenix_define_expression.html"><code class="computeroutput"><span class="identifier">PHOENIX_DEFINE_EXPRESSION</span></code></a></span></dt>
    37. 

  37. <dt><span class="section"><a href="reference/core_mechanisms/phoenix_define_expression_vararg.html"><code class="computeroutput"><span class="identifier">PHOENIX_DEFINE_EXPRESSION_VARARG</span></code></a></span></dt>
    38. 

  38. <dt><span class="section"><a href="reference/core_mechanisms/phoenix_define_expression_ext.html"><code class="computeroutput"><span class="identifier">PHOENIX_DEFINE_EXPRESSION_EXT</span></code></a></span></dt>
    39. 

  39. <dt><span class="section"><a href="reference/core_mechanisms/phoenix_define_expression_vararg_ext.html"><code class="computeroutput"><span class="identifier">PHOENIX_DEFINE_EXPRESSION_VARARG_EXT</span></code></a></span></dt>
    40. 

  40. <dt><span class="section"><a href="reference/core_mechanisms/terminals.html">Terminals</a></span></dt>
    41. 

  41. <dd><dl>
    42. 

  42. <dt><span class="section"><a href="reference/core_mechanisms/terminals/placeholders.html">Placeholders</a></span></dt>
    43. 

  43. <dt><span class="section"><a href="reference/core_mechanisms/terminals/_is_custom_terminal_.html"><code class="computeroutput"><span class="identifier">is_custom_terminal</span></code></a></span></dt>
    44. 

  44. <dt><span class="section"><a href="reference/core_mechanisms/terminals/_custom_terminal_.html"><code class="computeroutput"><span class="identifier">custom_terminal</span></code></a></span></dt>
    45. 

  45. </dl></dd>
    46. 

  46. </dl></dd>
    47. 

  47. <dt><span class="section"><a href="reference/the_language.html">The Language</a></span></dt>
    48. 

  48. <dd><dl>
    49. 

  49. <dt><span class="section"><a href="reference/the_language/core.html">Core</a></span></dt>
    50. 

  50. <dd><dl>
    51. 

  51. <dt><span class="section"><a href="reference/the_language/core/value.html">Value</a></span></dt>
    52. 

  52. <dt><span class="section"><a href="reference/the_language/core/reference.html">Reference</a></span></dt>
    53. 

  53. <dt><span class="section"><a href="reference/the_language/core/arguments.html">Arguments</a></span></dt>
    54. 

  54. <dt><span class="section"><a href="reference/the_language/core/nothing.html">Nothing</a></span></dt>
    55. 

  55. </dl></dd>
    56. 

  56. </dl></dd>
    57. 

  57. </dl></div>
    58. 

  58. <p>
    59. 

  59.       While the previous section gave a brief overview on how to use the Phoenix
    60. 

  60.       library, this section will provide as the reference to the interfaces defined
    61. 

  61.       in phoenix.
    62. 

  62.     </p>
    63. 

  63. <p>
    64. 

  64.       With Phoenix being a domain specific embedded language this reference manual
    65. 

  65.       is different than most references to C++ libraries.
    66. 

  66.     </p>
    67. 

  67. <p>
    68. 

  68.       Phoenix is designed in a way that the language constructs are clearly separated
    69. 

  69.       from how they are evaluated. This follows the design principles of the C++
    70. 

  70.       standard library. This design also allows us to see the code (i.e. Phoenix
    71. 

  71.       Actors) as data, and the different evaluation schemes, which act as the algorithms.
    72. 

  72.     </p>
    73. 

  73. <p>
    74. 

  74.       The remainder of this section is structured as following:
    75. 

  75.     </p>
    76. 

  76. <div class="variablelist">
    77. 

  77. <p class="title"><b></b></p>
    78. 

  78. <dl>
    79. 

  79. <dt><span class="term"> The Language </span></dt>
    80. 

  80. <dd>
    81. 

  81. <p>
    82. 

  82.             Definition of the Phoenix grammar
    83. 

  83.           </p>
    84. 

  84. <p>
    85. 

  85.             Reference to the mechanisms used to generate Phoenix actors
    86. 

  86.           </p>
    87. 

  87. <p>
    88. 

  88.             Extension mechanism of the Phoenix grammar
    89. 

  89.           </p>
    90. 

  90. </dd>
    91. 

  91. <dt><span class="term"> Evaluation </span></dt>
    92. 

  92. <dd>
    93. 

  93. <p>
    94. 

  94.             How Phoenix actors get evaluated
    95. 

  95.           </p>
    96. 

  96. <p>
    97. 

  97.             Reference to the predefined evaluators
    98. 

  98.           </p>
    99. 

  99. <p>
    100. 

  100.             Extension mechanism of the evaluation process
    101. 

  101.           </p>
    102. 

  102. </dd>
    103. 

  103. <dt><span class="term"> Advanced Tutorials </span></dt>
    104. 

  104. <dd><p>
    105. 

  105.             In depth discussion of the advertised features in the previous sections
    106. 

  106.           </p></dd>
    107. 

  107. </dl>
    108. 

  108. </div>
    109. 

  109. <a name="phoenix.reference.concepts"></a><h4>
    110. 

  110. <a name="id3390618"></a>
    111. 

  111.       <a class="link" href="reference.html#phoenix.reference.concepts">Concepts</a>
    112. 

  112.     </h4>
    113. 

  113. <p>
    114. 

  114.       Throughout this reference section various concepts are used. To disambiguate
    115. 

  115.       their meanings consider the following definitions.
    116. 

  116.     </p>
    117. 

  117. <a name="phoenix.reference.phoenix_actor"></a><h4>
    118. 

  118. <a name="id3390640"></a>
    119. 

  119.       <a class="link" href="reference.html#phoenix.reference.phoenix_actor">Phoenix Actor</a>
    120. 

  120.     </h4>
    121. 

  121. <p>
    122. 

  122.       A Phoenix Actor is the C++ Expression that is generated by the Phoenix Generators.
    123. 

  123.     </p>
    124. 

  124. <a name="phoenix.reference.phoenix_generator"></a><h4>
    125. 

  125. <a name="id3390662"></a>
    126. 

  126.       <a class="link" href="reference.html#phoenix.reference.phoenix_generator">Phoenix Generator</a>
    127. 

  127.     </h4>
    128. 

  128. <p>
    129. 

  129.       The Generator is a C++ Expression that results in a Phoenix Actor.
    130. 

  130.     </p>
    131. 

  131. <p>
    132. 

  132.       This Generator is:
    133. 

  133.     </p>
    134. 

  134. <div class="itemizedlist"><ul class="itemizedlist" type="disc">
    135. 

  135. <li class="listitem">
    136. 

  136.           A function (can be a free function, operator, or member function)
    137. 

  137.         </li>
    138. 

  138. <li class="listitem">
    139. 

  139.           An instance of a Phoenix Actor
    140. 

  140.         </li>
    141. 

  141. </ul></div>
    142. 

  142. </div>
    143. 

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

  144. <td align="left"></td>
    145. 

  145. <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2005, 2010 Joel de Guzman, Dan Marsden, Thomas Heller<p>
    146. 

  146.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    147. 

  147.         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>)
    148. 

  148.       </p>
    149. 

  149. </div></td>
    150. 

  150. </tr></table>
    151. 

  151. <hr>
    152. 

  152. <div class="spirit-nav">
    153. 

  153. <a accesskey="p" href="actor.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="reference/core_mechanisms.html"><img src="../images/next.png" alt="Next"></a>
    154. 

  154. </div>
    155. 

  155. </body>
    156. 

  156. </html>
    157. 

  157.