| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Reference</title> |
| <link rel="stylesheet" href="../boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| <link rel="home" href="../index.html" title="Chapter 1. Phoenix 3.0"> |
| <link rel="up" href="../index.html" title="Chapter 1. Phoenix 3.0"> |
| <link rel="prev" href="actor.html" title="Actor"> |
| <link rel="next" href="reference/core_mechanisms.html" title="Core Mechanisms"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <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> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
| <a name="phoenix.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a> |
| </h2></div></div></div> |
| <div class="toc"><dl> |
| <dt><span class="section"><a href="reference/core_mechanisms.html">Core Mechanisms</a></span></dt> |
| <dd><dl> |
| <dt><span class="section"><a href="reference/core_mechanisms/_actor_.html"><code class="computeroutput"><span class="identifier">actor</span></code></a></span></dt> |
| <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> |
| <dt><span class="section"><a href="reference/core_mechanisms/environment.html"><code class="computeroutput"><span class="identifier">environment</span></code></a></span></dt> |
| <dt><span class="section"><a href="reference/core_mechanisms/evaluator.html"><code class="computeroutput"><span class="identifier">evaluator</span></code></a></span></dt> |
| <dd><dl> |
| <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> |
| <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> |
| <dt><span class="section"><a href="reference/core_mechanisms/evaluator/arity.html"><code class="computeroutput"><span class="identifier">arity</span></code></a></span></dt> |
| </dl></dd> |
| <dt><span class="section"><a href="reference/core_mechanisms/expression.html"><code class="computeroutput"><span class="identifier">expression</span></code></a></span></dt> |
| <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> |
| <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> |
| <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> |
| <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> |
| <dt><span class="section"><a href="reference/core_mechanisms/terminals.html">Terminals</a></span></dt> |
| <dd><dl> |
| <dt><span class="section"><a href="reference/core_mechanisms/terminals/placeholders.html">Placeholders</a></span></dt> |
| <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> |
| <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> |
| </dl></dd> |
| </dl></dd> |
| <dt><span class="section"><a href="reference/the_language.html">The Language</a></span></dt> |
| <dd><dl> |
| <dt><span class="section"><a href="reference/the_language/core.html">Core</a></span></dt> |
| <dd><dl> |
| <dt><span class="section"><a href="reference/the_language/core/value.html">Value</a></span></dt> |
| <dt><span class="section"><a href="reference/the_language/core/reference.html">Reference</a></span></dt> |
| <dt><span class="section"><a href="reference/the_language/core/arguments.html">Arguments</a></span></dt> |
| <dt><span class="section"><a href="reference/the_language/core/nothing.html">Nothing</a></span></dt> |
| </dl></dd> |
| </dl></dd> |
| </dl></div> |
| <p> |
| While the previous section gave a brief overview on how to use the Phoenix |
| library, this section will provide as the reference to the interfaces defined |
| in phoenix. |
| </p> |
| <p> |
| With Phoenix being a domain specific embedded language this reference manual |
| is different than most references to C++ libraries. |
| </p> |
| <p> |
| Phoenix is designed in a way that the language constructs are clearly separated |
| from how they are evaluated. This follows the design principles of the C++ |
| standard library. This design also allows us to see the code (i.e. Phoenix |
| Actors) as data, and the different evaluation schemes, which act as the algorithms. |
| </p> |
| <p> |
| The remainder of this section is structured as following: |
| </p> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl> |
| <dt><span class="term"> The Language </span></dt> |
| <dd> |
| <p> |
| Definition of the Phoenix grammar |
| </p> |
| <p> |
| Reference to the mechanisms used to generate Phoenix actors |
| </p> |
| <p> |
| Extension mechanism of the Phoenix grammar |
| </p> |
| </dd> |
| <dt><span class="term"> Evaluation </span></dt> |
| <dd> |
| <p> |
| How Phoenix actors get evaluated |
| </p> |
| <p> |
| Reference to the predefined evaluators |
| </p> |
| <p> |
| Extension mechanism of the evaluation process |
| </p> |
| </dd> |
| <dt><span class="term"> Advanced Tutorials </span></dt> |
| <dd><p> |
| In depth discussion of the advertised features in the previous sections |
| </p></dd> |
| </dl> |
| </div> |
| <a name="phoenix.reference.concepts"></a><h4> |
| <a name="id3390618"></a> |
| <a class="link" href="reference.html#phoenix.reference.concepts">Concepts</a> |
| </h4> |
| <p> |
| Throughout this reference section various concepts are used. To disambiguate |
| their meanings consider the following definitions. |
| </p> |
| <a name="phoenix.reference.phoenix_actor"></a><h4> |
| <a name="id3390640"></a> |
| <a class="link" href="reference.html#phoenix.reference.phoenix_actor">Phoenix Actor</a> |
| </h4> |
| <p> |
| A Phoenix Actor is the C++ Expression that is generated by the Phoenix Generators. |
| </p> |
| <a name="phoenix.reference.phoenix_generator"></a><h4> |
| <a name="id3390662"></a> |
| <a class="link" href="reference.html#phoenix.reference.phoenix_generator">Phoenix Generator</a> |
| </h4> |
| <p> |
| The Generator is a C++ Expression that results in a Phoenix Actor. |
| </p> |
| <p> |
| This Generator is: |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" type="disc"> |
| <li class="listitem"> |
| A function (can be a free function, operator, or member function) |
| </li> |
| <li class="listitem"> |
| An instance of a Phoenix Actor |
| </li> |
| </ul></div> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2002-2005, 2010 Joel de Guzman, Dan Marsden, Thomas Heller<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <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> |
| </div> |
| </body> |
| </html> |
