Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r53423 - trunk/libs/spirit/classic/doc
From: joel_at_[hidden]
Date: 2009-05-29 22:16:54

Next message: joel_at_[hidden]: "[Boost-commit] svn:boost r53424 - trunk/libs/spirit/doc/qi_and_karma"
Previous message: steven_at_[hidden]: "[Boost-commit] svn:boost r53422 - trunk/libs/tokenizer"

Author: djowel
Date: 2009-05-29 22:16:54 EDT (Fri, 29 May 2009)
New Revision: 53423
URL: http://svn.boost.org/trac/boost/changeset/53423

Log:
#3007
Text files modified:
trunk/libs/spirit/classic/doc/primitives.html | 131 +++++++++++++++------------------------
1 files changed, 52 insertions(+), 79 deletions(-)

Modified: trunk/libs/spirit/classic/doc/primitives.html
==============================================================================
--- trunk/libs/spirit/classic/doc/primitives.html (original)
+++ trunk/libs/spirit/classic/doc/primitives.html 2009-05-29 22:16:54 EDT (Fri, 29 May 2009)
@@ -1,30 +1,28 @@
-<html>
-<head>
-<title>Primitives</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<link rel="stylesheet" href="theme/style.css" type="text/css">
-</head>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head>

+<title>Primitives</title><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="stylesheet" href="theme/style.css" type="text/css"></head>
<body>
-<table width="100%" border="0" background="theme/bkd2.gif" cellspacing="2">
- <tr>
+<table background="theme/bkd2.gif" border="0" cellspacing="2" width="100%">
+ <tbody><tr>
 <td width="10">
 </td>
 <td width="85%">
- Primitives
+ Primitives
 </td>
- <td width="112"></td>
+ <td width="112"></td>
 </tr>
-</table>
+</tbody></table>
 
<table border="0">
- <tr>
+ <tbody><tr>
 <td width="10"></td>
 <td width="30"></td>
 <td width="30"></td>
 <td width="30"></td>
 </tr>
-</table>
+</tbody></table>
The framework predefines some parser primitives. These are the most basic building
 blocks that the client uses to build more complex parsers. These primitive parsers
 are template classes, making them very flexible.
@@ -39,17 +37,17 @@
 the type of the character. This type typically corresponds to the input type,
 usually <tt>char</tt> or <tt>wchar_t</tt>. The following expression creates
 a temporary parser object which will recognize the single letter 'X'.
-<pre><code> chlit<char>('X');</code></pre>
+<pre><code> chlit<char>('X');</code></pre>
Using <tt>chlit</tt>'s generator function <tt>ch_p</tt> simplifies the usage
 of the <tt>chlit<></tt> class (this is true of most Spirit parser classes
 since most have corresponding generator functions). It is convenient to call
 the function because the compiler will deduce the template type through argument
 deduction for us. The example above could be expressed less verbosely using
 the <tt>ch_p </tt>helper function. 
-<pre><code> ch_p('X') // equivalent to chlit<char>('X') object</code></pre>
-<table width="80%" border="0" align="center">
- <tr>
- <td class="note_box"><img src="theme/lens.gif" width="15" height="16"> Parser
+<pre><code> ch_p('X') // equivalent to chlit<char>('X') object</code></pre>
+<table align="center" border="0" width="80%">
+ <tbody><tr>
+ <td class="note_box"><img src="theme/lens.gif" height="16" width="15"> Parser
 generators 
 
 Whenever you see an invocation of the parser generator function, it is equivalent
@@ -57,17 +55,9 @@
 parser, even if, technically speaking, it is a function that generates a
 character parser.</td>
 </tr>
-</table>
+</tbody></table>
The following grammar snippet shows these forms in action:
-<pre><code> // a rule can "store" a parser object. They're covered
- // later, but for now just consider a rule as an opaque type
- rule<> r1, r2, r3;
-
- chlit<char> x('X'); // declare a parser named x
-
- r1 = chlit<char>('X'); // explicit declaration
- r2 = x; // using x
- r3 = ch_p('X') // using the generator</code></pre>
+<pre><code> // a rule can "store" a parser object. They're covered // later, but for now just consider a rule as an opaque type rule<> r1, r2, r3; chlit<char> x('X'); // declare a parser named x r1 = chlit<char<spa
n class="special">>('X'); // explicit declaration r2 = x; // using x r3 = ch_p('X') // using the generator</code></pre>
<h2> chlit and ch_p</h2>
Matches a single character literal. <tt>chlit</tt> has a single template type
 parameter which defaults to <tt>char</tt> (i.e. <tt>chlit<></tt> is equivalent
@@ -76,52 +66,41 @@
 the template type parameters from the actual function arguments. The <tt>chlit</tt>
 class constructor accepts a single parameter: the character it will match the
 input against. Examples:
-<pre><code> r1 = chlit<>('X');
- r2 = chlit<wchar_t>(L'X');
- r3 = ch_p('X');</code></pre>
+<pre><code> r1 = chlit<>('X'); r2 = chlit<wchar_t>(L'X'); r3 = ch_p('X');</code></pre>
Going back to our original example:
-<pre><code> group = '(' >> expr >> ')';
- expr1 = integer | group;
- expr2 = expr1 >> *(('*' >> expr1) | ('/' >> expr1));
- expr = expr2 >> *(('+' >> expr2) | ('-' >> expr2));</code></pre>
+<pre><code> group = '(' >> expr >> ')'; expr1 = integer | group; expr2 = expr1 >> *(('*' >> expr1) | ('/' >> expr1
)); expr = expr2 >> *(('+' >> expr2) | ('-' >> expr2));</code></pre>

the character literals <tt class="quotes">'('</tt>, <tt class="quotes">')'</tt>,
 <tt class="quotes">'+'</tt>, <tt class="quotes">'-'</tt>, <tt class="quotes">'*'</tt>
 and <tt class="quotes">'/'</tt> in the grammar declaration are <tt>chlit</tt>
 objects that are implicitly created behind the scenes.
-<table width="80%" border="0" align="center">
- <tr>
- <td class="note_box"><img src="theme/lens.gif" width="15" height="16"> char
+<table align="center" border="0" width="80%">
+ <tbody><tr>
+ <td class="note_box"><img src="theme/lens.gif" height="16" width="15"> char
 operands 
 
 The reason this works is from two special templatized overloads of <tt>operator>></tt>
 that takes a (<tt>char</tt>, <tt> ParserT</tt>), or (<tt>ParserT</tt>, <tt>char</tt>).
 These functions convert the character into a <tt>chlit</tt> object.</td>
 </tr>
-</table>
+</tbody></table>
 One may prefer to declare these explicitly as:
-<pre><code> chlit<> plus('+');
- chlit<> minus('-');
- chlit<> times('*');
- chlit<> divide('/');
- chlit<> oppar('(');
- chlit<> clpar(')');</code></pre>
+<pre><code> chlit<> plus('+'); chlit<> minus('-'); chlit<> times('*'); chlit<> divide('/'); chlit<> oppar('('); chlit<> clpar(')');</code></pre>
<h2>range and range_p</h2>
A <tt>range</tt> of characters is created from a low/high character pair. Such
 a parser matches a single character that is in the <tt>range</tt>, including
 both endpoints. Like <tt>chlit</tt>, <tt>range</tt> has a single template type
 parameter which defaults to <tt>char</tt>. The <tt>range</tt> class constructor
- accepts two parameters: the character range (from and to, inclusive)
+ accepts two parameters: the character range (from and to, inclusive)
 it will match the input against. The function generator version is <tt>range_p</tt>.
 Examples:
-<pre><code> range<>('A','Z') // matches 'A'..'Z'
- range_p('a','z') // matches 'a'..'z'</code></pre>
-Note, the first character must be "before" the second, according
+<pre><code> range<>('A','Z') // matches 'A'..'Z' range_p('a','z') // matches 'a'..'z'</code></pre>
+Note, the first character must be "before" the second, according
 to the underlying character encoding characters. The range, like chlit is a
 single character parser.
-<table border="0" align="center" width="80%">
- <tr>
- <td class="note_box"><img src="theme/alert.gif" width="16" height="16">
+<table align="center" border="0" width="80%">
+ <tbody><tr>
+ <td class="note_box"><img src="theme/alert.gif" height="16" width="16">
 Character mapping 
 
 Character mapping to is inherently platform dependent. It is not guaranteed
@@ -129,7 +108,7 @@
 we are well aware of the character set we are using such as ASCII, ISO-8859-1
 or Unicode. Take care though when porting to another platform.</td>
 </tr>
-</table>
+</tbody></table>
<h2> strlit and str_p</h2>
This parser matches a string literal. <tt>strlit</tt> has a single template
 type parameter: an iterator type. Internally, <tt>strlit</tt> holds a begin/end
@@ -140,14 +119,10 @@
 This constructor may be used to build <tt>strlits</tt> from quoted string literals.
 The second constructor takes in a first/last iterator pair. The function generator
 version is <tt>str_p</tt>. Examples:
-<pre><code> strlit<>("Hello World")
- str_p("Hello World")
-
- std::string msg("Hello World");
- strlit<std::string::const_iterator>(msg.begin(), msg.end());</code></pre>
-<table width="80%" border="0" align="center">
- <tr>
- <td class="note_box"><img src="theme/note.gif" width="16" height="16"> Character
+<pre><code> strlit<>("Hello World") str_p("Hello World") std::string msg("Hello World"); strlit<std::string::const_iterator>(msg.begin(), <s
pan class="identifier">msg.end());</code></pre>
+<table align="center" border="0" width="80%">
+ <tbody><tr>
+ <td class="note_box"><img src="theme/note.gif" height="16" width="16"> Character
 and phrase level parsing 
 
 Typical parsers regard the processing of characters (symbols that form words
@@ -167,26 +142,23 @@
 layers as needed. In theory, one may create a preprocessor, a lexical analyzer
 and a parser proper, all using the same framework.</td>
 </tr>
-</table>
+</tbody></table>
<h2>chseq and chseq_p</h2>
Matches a character sequence. <tt>chseq</tt> has the same template type parameters
 and constructor parameters as strlit. The function generator version is <tt>chseq_p</tt>.
 Examples:
-<pre><code> chseq<>("ABCDEFG")
- chseq_p("ABCDEFG")</code></pre>
+<pre><code> chseq<>("ABCDEFG") chseq_p("ABCDEFG")</code></pre>
<tt>strlit</tt> is an implicit lexeme. That is, it works solely on the character
 level. <tt>chseq</tt>, <tt>strlit</tt>'s twin, on the other hand, can work on
 both the character and phrase levels. What this simply means is that it can
 ignore white spaces in between the string characters. For example:
-<pre><code> chseq<>("ABCDEFG")</code></pre>
+<pre><code> chseq<>("ABCDEFG")</code></pre>
can parse:
-<pre> ABCDEFG
- A B C D E F G
- AB CD EFG</pre>
+<pre> ABCDEFG A B C D E F G AB CD EFG</pre>
<h2>More character parsers</h2>
The framework also predefines the full repertoire of single character parsers:
-<table width="90%" border="0" align="center">
- <tr>
+<table align="center" border="0" width="90%">
+ <tbody><tr>
 <td class="table_title" colspan="2">Single character parsers</td>
 </tr>
 <tr>
@@ -242,11 +214,11 @@
 <td class="table_cells" width="30%">xdigit_p</td>
 <td class="table_cells" width="70%">Matches hexadecimal digits</td>
 </tr>
-</table>
+</tbody></table>
<h2><a name="negation"></a>negation ~</h2>
Single character parsers such as the <tt>chlit</tt>, <tt>range</tt>, <tt>anychar_p</tt>,
 <tt>alnum_p</tt> etc. can be negated. For example:
-<pre><code> ~ch_p('x')</code></pre>
+<pre><code> ~ch_p('x')</code></pre>
matches any character except <tt>'x'</tt>. Double negation of a character parser
 cancels out the negation. <tt>~~alpha_p</tt> is equivalent to <tt>alpha_p</tt>.
<h2>eol_p</h2>
@@ -255,23 +227,24 @@
Never matches anything and always fails.
<h2>end_p</h2>
Matches the end of input (returns a sucessful match with 0 length when the
- input is exhausted)
+ input is exhausted)<h2>eps_p</h2>
+The Epsilon (<tt>epsilon_p</tt> and <tt>eps_p</tt>) is a multi-purpose
+ parser that returns a zero length match. See Epsilon for details.
<table border="0">
- <tr>
+ <tbody><tr>
 <td width="10"></td>
 <td width="30"></td>
 <td width="30"></td>
 <td width="30"></td>
 </tr>
-</table>
+</tbody></table>
 
<hr size="1">
-Copyright © 1998-2003 Joel de Guzman 
- Copyright © 2003 Martin Wille 
+Copyright © 1998-2003 Joel de Guzman 
+ Copyright © 2003 Martin Wille 
 
 Use, modification and distribution is subject to the Boost Software
 License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
 http://www.boost.org/LICENSE_1_0.txt) 
 
-</body>
-</html>
+</body></html>
\ No newline at end of file

Next message: joel_at_[hidden]: "[Boost-commit] svn:boost r53424 - trunk/libs/spirit/doc/qi_and_karma"
Previous message: steven_at_[hidden]: "[Boost-commit] svn:boost r53422 - trunk/libs/tokenizer"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk