Initial commit of quickbook generated docs.

[SVN r37943]
This commit is contained in:
John Maddock
2007-06-08 09:23:23 +00:00
parent 5f96b68080
commit 7e4d1b570c
82 changed files with 24467 additions and 0 deletions

View File

@ -0,0 +1,398 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost-Extended Format String Syntax</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_2006-12-17_0120">
<link rel="start" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../format.html" title="Search and Replace Format String Syntax">
<link rel="prev" href="perl_format.html" title="Perl Format String Syntax">
<link rel="next" href="../ref.html" title="Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="perl_format.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../format.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../ref.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.format.boost_format_syntax"></a><a href="boost_format_syntax.html" title="Boost-Extended Format String Syntax"> Boost-Extended
Format String Syntax</a></h3></div></div></div>
<p>
Boost-Extended format strings treat all characters as literals except for
'$', '\', '(', ')', '?', and ':'.
</p>
<a name="boost_regex.format.boost_format_syntax.grouping"></a><h5>
<a name="id525164"></a>
<a href="boost_format_syntax.html#boost_regex.format.boost_format_syntax.grouping">Grouping</a>
</h5>
<p>
The characters '(' and ')' perform lexical grouping, so use \( and \) if
you want a to output literal parenthesis.
</p>
<a name="boost_regex.format.boost_format_syntax.conditionals"></a><h5>
<a name="id525196"></a>
<a href="boost_format_syntax.html#boost_regex.format.boost_format_syntax.conditionals">Conditionals</a>
</h5>
<p>
The character '?' begins a conditional expression, the general form is:
</p>
<p>
?Ntrue-expression:false-expression
</p>
<p>
where N is decimal digit.
</p>
<p>
If sub-expression N was matched, then true-expression is evaluated and sent
to output, otherwise false-expression is evaluated and sent to output.
</p>
<p>
You will normally need to surround a conditional-expression with parenthesis
in order to prevent ambiguities.
</p>
<p>
For example, the format string "(?1foo:bar)" will replace each
match found with "foo" if the sub-expression $1 was matched, and
with "bar" otherwise.
</p>
<a name="boost_regex.format.boost_format_syntax.placeholder_sequences"></a><h5>
<a name="id525255"></a>
<a href="boost_format_syntax.html#boost_regex.format.boost_format_syntax.placeholder_sequences">Placeholder
Sequences</a>
</h5>
<p>
Placeholder sequences specify that some part of what matched the regular
expression should be sent to output as follows:
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Placeholder
</p>
</th>
<th>
<p>
Meaning
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
$&amp;
</p>
</td>
<td>
<p>
Outputs what matched the whole expression.
</p>
</td>
</tr>
<tr>
<td>
<p>
$`
</p>
</td>
<td>
<p>
Outputs the text between the end of the last match found (or the
start of the text if no previous match was found), and the start
of the current match.
</p>
</td>
</tr>
<tr>
<td>
<p>
$'
</p>
</td>
<td>
<p>
Outputs all the text following the end of the current match.
</p>
</td>
</tr>
<tr>
<td>
<p>
$$
</p>
</td>
<td>
<p>
Outputs a literal '$'
</p>
</td>
</tr>
<tr>
<td>
<p>
$n
</p>
</td>
<td>
<p>
Outputs what matched the n'th sub-expression.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
Any $-placeholder sequence not listed above, results in '$' being treated
as a literal.
</p>
<a name="boost_regex.format.boost_format_syntax.escape_sequences"></a><h5>
<a name="id525428"></a>
<a href="boost_format_syntax.html#boost_regex.format.boost_format_syntax.escape_sequences">Escape
Sequences</a>
</h5>
<p>
An escape character followed by any character x, outputs that character unless
x is one of the escape sequences shown below.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Escape
</p>
</th>
<th>
<p>
Meaning
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
\a
</p>
</td>
<td>
<p>
Outputs the bell character: '\a'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\e
</p>
</td>
<td>
<p>
Outputs the ANSI escape character (code point 27).
</p>
</td>
</tr>
<tr>
<td>
<p>
\f
</p>
</td>
<td>
<p>
Outputs a form feed character: '\f'
</p>
</td>
</tr>
<tr>
<td>
<p>
\n
</p>
</td>
<td>
<p>
Outputs a newline character: '\n'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\r
</p>
</td>
<td>
<p>
Outputs a carriage return character: '\r'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\t
</p>
</td>
<td>
<p>
Outputs a tab character: '\t'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\v
</p>
</td>
<td>
<p>
Outputs a vertical tab character: '\v'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\xDD
</p>
</td>
<td>
<p>
Outputs the character whose hexadecimal code point is 0xDD
</p>
</td>
</tr>
<tr>
<td>
<p>
\x{DDDD}
</p>
</td>
<td>
<p>
Outputs the character whose hexadecimal code point is 0xDDDDD
</p>
</td>
</tr>
<tr>
<td>
<p>
\cX
</p>
</td>
<td>
<p>
Outputs the ANSI escape sequence "escape-X".
</p>
</td>
</tr>
<tr>
<td>
<p>
\D
</p>
</td>
<td>
<p>
If D is a decimal digit in the range 1-9, then outputs the text that
matched sub-expression D.
</p>
</td>
</tr>
<tr>
<td>
<p>
\l
</p>
</td>
<td>
<p>
Causes the next character to be outputted, to be output in lower
case.
</p>
</td>
</tr>
<tr>
<td>
<p>
\u
</p>
</td>
<td>
<p>
Causes the next character to be outputted, to be output in upper
case.
</p>
</td>
</tr>
<tr>
<td>
<p>
\L
</p>
</td>
<td>
<p>
Causes all subsequent characters to be output in lower case, until
a \E is found.
</p>
</td>
</tr>
<tr>
<td>
<p>
\U
</p>
</td>
<td>
<p>
Causes all subsequent characters to be output in upper case, until
a \E is found.
</p>
</td>
</tr>
<tr>
<td>
<p>
\E
</p>
</td>
<td>
<p>
Terminates a \L or \U sequence.
</p>
</td>
</tr>
</tbody>
</table></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"><small>Copyright <20> 2007 John Maddock</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="perl_format.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../format.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../ref.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@ -0,0 +1,353 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Perl Format String Syntax</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_2006-12-17_0120">
<link rel="start" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../format.html" title="Search and Replace Format String Syntax">
<link rel="prev" href="sed_format.html" title="Sed Format String Syntax">
<link rel="next" href="boost_format_syntax.html" title="Boost-Extended Format String Syntax">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="sed_format.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../format.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="boost_format_syntax.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.format.perl_format"></a><a href="perl_format.html" title="Perl Format String Syntax"> Perl Format String Syntax</a></h3></div></div></div>
<p>
Perl-style format strings treat all characters as literals except '$' and
'\' which start placeholder and escape sequences respectively.
</p>
<p>
Placeholder sequences specify that some part of what matched the regular
expression should be sent to output as follows:
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Placeholder
</p>
</th>
<th>
<p>
Meaning
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
$&amp;
</p>
</td>
<td>
<p>
Outputs what matched the whole expression.
</p>
</td>
</tr>
<tr>
<td>
<p>
$`
</p>
</td>
<td>
<p>
Outputs the text between the end of the last match found (or the
start of the text if no previous match was found), and the start
of the current match.
</p>
</td>
</tr>
<tr>
<td>
<p>
$'
</p>
</td>
<td>
<p>
Outputs all the text following the end of the current match.
</p>
</td>
</tr>
<tr>
<td>
<p>
$$
</p>
</td>
<td>
<p>
Outputs a literal '$'
</p>
</td>
</tr>
<tr>
<td>
<p>
$n
</p>
</td>
<td>
<p>
Outputs what matched the n'th sub-expression.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
Any $-placeholder sequence not listed above, results in '$' being treated
as a literal.
</p>
<p>
An escape character followed by any character x, outputs that character unless
x is one of the escape sequences shown below.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Escape
</p>
</th>
<th>
<p>
Meaning
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
\a
</p>
</td>
<td>
<p>
Outputs the bell character: '\a'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\e
</p>
</td>
<td>
<p>
Outputs the ANSI escape character (code point 27).
</p>
</td>
</tr>
<tr>
<td>
<p>
\f
</p>
</td>
<td>
<p>
Outputs a form feed character: '\f'
</p>
</td>
</tr>
<tr>
<td>
<p>
\n
</p>
</td>
<td>
<p>
Outputs a newline character: '\n'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\r
</p>
</td>
<td>
<p>
Outputs a carriage return character: '\r'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\t
</p>
</td>
<td>
<p>
Outputs a tab character: '\t'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\v
</p>
</td>
<td>
<p>
Outputs a vertical tab character: '\v'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\xDD
</p>
</td>
<td>
<p>
Outputs the character whose hexadecimal code point is 0xDD
</p>
</td>
</tr>
<tr>
<td>
<p>
\x{DDDD}
</p>
</td>
<td>
<p>
Outputs the character whose hexadecimal code point is 0xDDDDD
</p>
</td>
</tr>
<tr>
<td>
<p>
\cX
</p>
</td>
<td>
<p>
Outputs the ANSI escape sequence "escape-X".
</p>
</td>
</tr>
<tr>
<td>
<p>
\D
</p>
</td>
<td>
<p>
If D is a decimal digit in the range 1-9, then outputs the text that
matched sub-expression D.
</p>
</td>
</tr>
<tr>
<td>
<p>
\l
</p>
</td>
<td>
<p>
Causes the next character to be outputted, to be output in lower
case.
</p>
</td>
</tr>
<tr>
<td>
<p>
\u
</p>
</td>
<td>
<p>
Causes the next character to be outputted, to be output in upper
case.
</p>
</td>
</tr>
<tr>
<td>
<p>
\L
</p>
</td>
<td>
<p>
Causes all subsequent characters to be output in lower case, until
a \E is found.
</p>
</td>
</tr>
<tr>
<td>
<p>
\U
</p>
</td>
<td>
<p>
Causes all subsequent characters to be output in upper case, until
a \E is found.
</p>
</td>
</tr>
<tr>
<td>
<p>
\E
</p>
</td>
<td>
<p>
Terminates a \L or \U sequence.
</p>
</td>
</tr>
</tbody>
</table></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"><small>Copyright <20> 2007 John Maddock</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="sed_format.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../format.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="boost_format_syntax.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

View File

@ -0,0 +1,244 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Sed Format String Syntax</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_2006-12-17_0120">
<link rel="start" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../format.html" title="Search and Replace Format String Syntax">
<link rel="prev" href="../format.html" title="Search and Replace Format String Syntax">
<link rel="next" href="perl_format.html" title="Perl Format String Syntax">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../format.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../format.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="perl_format.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.format.sed_format"></a><a href="sed_format.html" title="Sed Format String Syntax"> Sed Format String Syntax</a></h3></div></div></div>
<p>
Sed-style format strings treat all characters as literals except:
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
character
</p>
</th>
<th>
<p>
description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
&amp;
</p>
</td>
<td>
<p>
The ampersand character is replaced in the output stream by the the
whole of what matched the regular expression. Use \&amp; to output
a literal '&amp;' character.
</p>
</td>
</tr>
<tr>
<td>
<p>
\
</p>
</td>
<td>
<p>
Specifies an escape sequence.
</p>
</td>
</tr>
</tbody>
</table></div>
<p>
An escape character followed by any character x, outputs that character unless
x is one of the escape sequences shown below.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Escape
</p>
</th>
<th>
<p>
Meaning
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
\a
</p>
</td>
<td>
<p>
Outputs the bell character: '\a'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\e
</p>
</td>
<td>
<p>
Outputs the ANSI escape character (code point 27).
</p>
</td>
</tr>
<tr>
<td>
<p>
\f
</p>
</td>
<td>
<p>
Outputs a form feed character: '\f'
</p>
</td>
</tr>
<tr>
<td>
<p>
\n
</p>
</td>
<td>
<p>
Outputs a newline character: '\n'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\r
</p>
</td>
<td>
<p>
Outputs a carriage return character: '\r'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\t
</p>
</td>
<td>
<p>
Outputs a tab character: '\t'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\v
</p>
</td>
<td>
<p>
Outputs a vertical tab character: '\v'.
</p>
</td>
</tr>
<tr>
<td>
<p>
\xDD
</p>
</td>
<td>
<p>
Outputs the character whose hexadecimal code point is 0xDD
</p>
</td>
</tr>
<tr>
<td>
<p>
\x{DDDD}
</p>
</td>
<td>
<p>
Outputs the character whose hexadecimal code point is 0xDDDDD
</p>
</td>
</tr>
<tr>
<td>
<p>
\cX
</p>
</td>
<td>
<p>
Outputs the ANSI escape sequence "escape-X".
</p>
</td>
</tr>
<tr>
<td>
<p>
\D
</p>
</td>
<td>
<p>
If D is a decimal digit in the range 1-9, then outputs the text that
matched sub-expression D.
</p>
</td>
</tr>
</tbody>
</table></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"><small>Copyright <20> 2007 John Maddock</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../format.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../format.html"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="perl_format.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>