PageRenderTime 26ms CodeModel.GetById 14ms app.highlight 8ms RepoModel.GetById 2ms app.codeStats 0ms

/Src/Dependencies/Boost/libs/phoenix/doc/html/phoenix/reference.html

http://hadesmem.googlecode.com/
HTML | 156 lines | 156 code | 0 blank | 0 comment | 0 complexity | 6e87719515933a3a92d48f6012ff4697 MD5 | raw file
  1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2<html>
  3<head>
  4<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  5<title>Reference</title>
  6<link rel="stylesheet" href="../boostbook.css" type="text/css">
  7<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
  8<link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Phoenix 3.0">
  9<link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Phoenix 3.0">
 10<link rel="prev" href="actor.html" title="Actor">
 11<link rel="next" href="reference/core_mechanisms.html" title="Core Mechanisms">
 12</head>
 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 14<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
 15<hr>
 16<div class="spirit-nav">
 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</div>
 19<div class="section">
 20<div class="titlepage"><div><div><h2 class="title" style="clear: both">
 21<a name="phoenix.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
 22</h2></div></div></div>
 23<div class="toc"><dl>
 24<dt><span class="section"><a href="reference/core_mechanisms.html">Core Mechanisms</a></span></dt>
 25<dd><dl>
 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<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<dt><span class="section"><a href="reference/core_mechanisms/environment.html"><code class="computeroutput"><span class="identifier">environment</span></code></a></span></dt>
 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<dd><dl>
 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<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<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</dl></dd>
 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<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<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<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<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<dt><span class="section"><a href="reference/core_mechanisms/terminals.html">Terminals</a></span></dt>
 41<dd><dl>
 42<dt><span class="section"><a href="reference/core_mechanisms/terminals/placeholders.html">Placeholders</a></span></dt>
 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<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</dl></dd>
 46</dl></dd>
 47<dt><span class="section"><a href="reference/the_language.html">The Language</a></span></dt>
 48<dd><dl>
 49<dt><span class="section"><a href="reference/the_language/core.html">Core</a></span></dt>
 50<dd><dl>
 51<dt><span class="section"><a href="reference/the_language/core/value.html">Value</a></span></dt>
 52<dt><span class="section"><a href="reference/the_language/core/reference.html">Reference</a></span></dt>
 53<dt><span class="section"><a href="reference/the_language/core/arguments.html">Arguments</a></span></dt>
 54<dt><span class="section"><a href="reference/the_language/core/nothing.html">Nothing</a></span></dt>
 55</dl></dd>
 56</dl></dd>
 57</dl></div>
 58<p>
 59      While the previous section gave a brief overview on how to use the Phoenix
 60      library, this section will provide as the reference to the interfaces defined
 61      in phoenix.
 62    </p>
 63<p>
 64      With Phoenix being a domain specific embedded language this reference manual
 65      is different than most references to C++ libraries.
 66    </p>
 67<p>
 68      Phoenix is designed in a way that the language constructs are clearly separated
 69      from how they are evaluated. This follows the design principles of the C++
 70      standard library. This design also allows us to see the code (i.e. Phoenix
 71      Actors) as data, and the different evaluation schemes, which act as the algorithms.
 72    </p>
 73<p>
 74      The remainder of this section is structured as following:
 75    </p>
 76<div class="variablelist">
 77<p class="title"><b></b></p>
 78<dl>
 79<dt><span class="term"> The Language </span></dt>
 80<dd>
 81<p>
 82            Definition of the Phoenix grammar
 83          </p>
 84<p>
 85            Reference to the mechanisms used to generate Phoenix actors
 86          </p>
 87<p>
 88            Extension mechanism of the Phoenix grammar
 89          </p>
 90</dd>
 91<dt><span class="term"> Evaluation </span></dt>
 92<dd>
 93<p>
 94            How Phoenix actors get evaluated
 95          </p>
 96<p>
 97            Reference to the predefined evaluators
 98          </p>
 99<p>
100            Extension mechanism of the evaluation process
101          </p>
102</dd>
103<dt><span class="term"> Advanced Tutorials </span></dt>
104<dd><p>
105            In depth discussion of the advertised features in the previous sections
106          </p></dd>
107</dl>
108</div>
109<a name="phoenix.reference.concepts"></a><h4>
110<a name="id3390618"></a>
111      <a class="link" href="reference.html#phoenix.reference.concepts">Concepts</a>
112    </h4>
113<p>
114      Throughout this reference section various concepts are used. To disambiguate
115      their meanings consider the following definitions.
116    </p>
117<a name="phoenix.reference.phoenix_actor"></a><h4>
118<a name="id3390640"></a>
119      <a class="link" href="reference.html#phoenix.reference.phoenix_actor">Phoenix Actor</a>
120    </h4>
121<p>
122      A Phoenix Actor is the C++ Expression that is generated by the Phoenix Generators.
123    </p>
124<a name="phoenix.reference.phoenix_generator"></a><h4>
125<a name="id3390662"></a>
126      <a class="link" href="reference.html#phoenix.reference.phoenix_generator">Phoenix Generator</a>
127    </h4>
128<p>
129      The Generator is a C++ Expression that results in a Phoenix Actor.
130    </p>
131<p>
132      This Generator is:
133    </p>
134<div class="itemizedlist"><ul class="itemizedlist" type="disc">
135<li class="listitem">
136          A function (can be a free function, operator, or member function)
137        </li>
138<li class="listitem">
139          An instance of a Phoenix Actor
140        </li>
141</ul></div>
142</div>
143<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
144<td align="left"></td>
145<td align="right"><div class="copyright-footer">Copyright &#169; 2002-2005, 2010 Joel de Guzman, Dan Marsden, Thomas Heller<p>
146        Distributed under the Boost Software License, Version 1.0. (See accompanying
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      </p>
149</div></td>
150</tr></table>
151<hr>
152<div class="spirit-nav">
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</div>
155</body>
156</html>