boostorg/regex
1
0
Fork 1
mirror of https://github.com/boostorg/regex.git synced 2025-07-02 07:10:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge more rebuilt documentation.

Browse Source 
[SVN r63771]
This commit is contained in:
Daniel James
2010-07-08 23:13:28 +00:00
parent 5fe36e6e56
commit 4741ee7d94
82 changed files with 7675 additions and 7924 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
doc/html/boost_regex/configuration/algorithm.html
View File

@ -2,8 +2,8 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Algorithm Selection</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../configuration.html" title="Configuration">
<link rel="prev" href="linkage.html" title="Linkage Options">
@ -20,9 +20,9 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="linkage.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="tuning.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="linkage.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tuning.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.configuration.algorithm"></a><a class="link" href="algorithm.html" title="Algorithm Selection"> Algorithm Selection</a>
</h3></div></div></div>
@ -33,45 +33,45 @@
</colgroup>
<thead><tr>
<th>
<p>
macro
</p>
<p>
macro
</p>
</th>
<th>
<p>
description
</p>
<p>
description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
BOOST_REGEX_RECURSIVE
</p>
<p>
BOOST_REGEX_RECURSIVE
</p>
</td>
<td>
<p>
Tells Boost.Regex to use a stack-recursive matching algorithm. This
is generally the fastest option (although there is very little in
it), but can cause stack overflow in extreme cases, on Win32 this
can be handled safely, but this is not the case on other platforms.
</p>
<p>
Tells Boost.Regex to use a stack-recursive matching algorithm.
This is generally the fastest option (although there is very little
in it), but can cause stack overflow in extreme cases, on Win32
this can be handled safely, but this is not the case on other platforms.
</p>
</td>
</tr>
<tr>
<td>
<p>
BOOST_REGEX_NON_RECURSIVE
</p>
<p>
BOOST_REGEX_NON_RECURSIVE
</p>
</td>
<td>
<p>
Tells Boost.Regex to use a non-stack recursive matching algorithm,
this can be slightly slower than the alternative, but is always safe
no matter how pathological the regular expression. This is the default
on non-Win32 platforms.
</p>
<p>
Tells Boost.Regex to use a non-stack recursive matching algorithm,
this can be slightly slower than the alternative, but is always
safe no matter how pathological the regular expression. This is
the default on non-Win32 platforms.
</p>
</td>
</tr>
</tbody>
@ -87,7 +87,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="linkage.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="tuning.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="linkage.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tuning.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

10
doc/html/boost_regex/configuration/compiler.html
View File

@ -2,8 +2,8 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Compiler Setup</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../configuration.html" title="Configuration">
<link rel="prev" href="../configuration.html" title="Configuration">
@ -20,9 +20,9 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../configuration.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="locale.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="../configuration.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="locale.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.configuration.compiler"></a><a class="link" href="compiler.html" title="Compiler Setup"> Compiler Setup</a>
</h3></div></div></div>
@ -44,7 +44,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../configuration.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="locale.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="../configuration.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="locale.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

54
doc/html/boost_regex/configuration/linkage.html
View File

@ -2,8 +2,8 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Linkage Options</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../configuration.html" title="Configuration">
<link rel="prev" href="locale.html" title="Locale and traits class selection">
@ -20,9 +20,9 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="locale.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="algorithm.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="locale.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.configuration.linkage"></a><a class="link" href="linkage.html" title="Linkage Options"> Linkage Options</a>
</h3></div></div></div>
@ -33,43 +33,43 @@
</colgroup>
<thead><tr>
<th>
<p>
macro
</p>
<p>
macro
</p>
</th>
<th>
<p>
description
</p>
<p>
description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
BOOST_REGEX_DYN_LINK
</p>
<p>
BOOST_REGEX_DYN_LINK
</p>
</td>
<td>
<p>
For Microsoft and Borland C++ builds, this tells Boost.Regex that
it should link to the dll build of the Boost.Regex. By default boost.regex
will link to its static library build, even if the dynamic C runtime
library is in use.
</p>
<p>
For Microsoft and Borland C++ builds, this tells Boost.Regex that
it should link to the dll build of the Boost.Regex. By default
boost.regex will link to its static library build, even if the
dynamic C runtime library is in use.
</p>
</td>
</tr>
<tr>
<td>
<p>
BOOST_REGEX_NO_LIB
</p>
<p>
BOOST_REGEX_NO_LIB
</p>
</td>
<td>
<p>
For Microsoft and Borland C++ builds, this tells Boost.Regex that
it should not automatically select the library to link to.
</p>
<p>
For Microsoft and Borland C++ builds, this tells Boost.Regex that
it should not automatically select the library to link to.
</p>
</td>
</tr>
</tbody>
@ -85,7 +85,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="locale.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="algorithm.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="locale.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="algorithm.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

68
doc/html/boost_regex/configuration/locale.html
View File

@ -2,8 +2,8 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Locale and traits class selection</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../configuration.html" title="Configuration">
<link rel="prev" href="compiler.html" title="Compiler Setup">
@ -20,9 +20,9 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="compiler.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="linkage.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="compiler.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="linkage.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.configuration.locale"></a><a class="link" href="locale.html" title="Locale and traits class selection"> Locale and traits
class selection</a>
@ -38,56 +38,56 @@
</colgroup>
<thead><tr>
<th>
<p>
macro
</p>
<p>
macro
</p>
</th>
<th>
<p>
description
</p>
<p>
description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
BOOST_REGEX_USE_C_LOCALE
</p>
<p>
BOOST_REGEX_USE_C_LOCALE
</p>
</td>
<td>
<p>
Forces Boost.Regex to use the global C locale in its traits class
support: this is now deprecated in favour of the C++ locale.
</p>
<p>
Forces Boost.Regex to use the global C locale in its traits class
support: this is now deprecated in favour of the C++ locale.
</p>
</td>
</tr>
<tr>
<td>
<p>
BOOST_REGEX_USE_CPP_LOCALE
</p>
<p>
BOOST_REGEX_USE_CPP_LOCALE
</p>
</td>
<td>
<p>
Forces Boost.Regex to use std::locale in it's default traits class,
regular expressions can then be imbued with an instance specific
locale. This is the default behaviour on non-Windows platforms.
</p>
<p>
Forces Boost.Regex to use std::locale in it's default traits class,
regular expressions can then be imbued with an instance specific
locale. This is the default behaviour on non-Windows platforms.
</p>
</td>
</tr>
<tr>
<td>
<p>
BOOST_REGEX_NO_W32
</p>
<p>
BOOST_REGEX_NO_W32
</p>
</td>
<td>
<p>
Tells Boost.Regex not to use any Win32 API's even when available
(implies BOOST_REGEX_USE_CPP_LOCALE unless BOOST_REGEX_USE_C_LOCALE
is set).
</p>
<p>
Tells Boost.Regex not to use any Win32 API's even when available
(implies BOOST_REGEX_USE_CPP_LOCALE unless BOOST_REGEX_USE_C_LOCALE
is set).
</p>
</td>
</tr>
</tbody>
@ -103,7 +103,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="compiler.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="linkage.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="compiler.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="linkage.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>

122
doc/html/boost_regex/configuration/tuning.html
View File

@ -2,8 +2,8 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Algorithm Tuning</title>
<link rel="stylesheet" href="../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Boost.Regex">
<link rel="up" href="../configuration.html" title="Configuration">
<link rel="prev" href="algorithm.html" title="Algorithm Selection">
@ -20,9 +20,9 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="../install.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../install.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_regex.configuration.tuning"></a><a class="link" href="tuning.html" title="Algorithm Tuning"> Algorithm Tuning</a>
</h3></div></div></div>
@ -36,27 +36,27 @@
</colgroup>
<thead><tr>
<th>
<p>
macro
</p>
<p>
macro
</p>
</th>
<th>
<p>
description
</p>
<p>
description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
BOOST_REGEX_HAS_MS_STACK_GUARD
</p>
<p>
BOOST_REGEX_HAS_MS_STACK_GUARD
</p>
</td>
<td>
<p>
Tells Boost.Regex that Microsoft style __try - __except blocks are
supported, and can be used to safely trap stack overflow.
</p>
<p>
Tells Boost.Regex that Microsoft style __try - __except blocks
are supported, and can be used to safely trap stack overflow.
</p>
</td>
</tr></tbody>
</table></div>
@ -70,69 +70,71 @@
</colgroup>
<thead><tr>
<th>
<p>
macro
</p>
<p>
macro
</p>
</th>
<th>
<p>
description
</p>
<p>
description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
BOOST_REGEX_BLOCKSIZE
</p>
<p>
BOOST_REGEX_BLOCKSIZE
</p>
</td>
<td>
<p>
In non-recursive mode, Boost.Regex uses largish blocks of memory
to act as a stack for the state machine, the larger the block size
then the fewer allocations that will take place. This defaults to
4096 bytes, which is large enough to match the vast majority of regular
expressions without further allocations, however, you can choose
smaller or larger values depending upon your platforms characteristics.
</p>
<p>
In non-recursive mode, Boost.Regex uses largish blocks of memory
to act as a stack for the state machine, the larger the block size
then the fewer allocations that will take place. This defaults
to 4096 bytes, which is large enough to match the vast majority
of regular expressions without further allocations, however, you
can choose smaller or larger values depending upon your platforms
characteristics.
</p>
</td>
</tr>
<tr>
<td>
<p>
BOOST_REGEX_MAX_BLOCKS
</p>
<p>
BOOST_REGEX_MAX_BLOCKS
</p>
</td>
<td>
<p>
Tells Boost.Regex how many blocks of size BOOST_REGEX_BLOCKSIZE it
is permitted to use. If this value is exceeded then Boost.Regex will
stop trying to find a match and throw a std::runtime_error. Defaults
to 1024, don't forget to tweek this value if you alter BOOST_REGEX_BLOCKSIZE
by much.
</p>
<p>
Tells Boost.Regex how many blocks of size BOOST_REGEX_BLOCKSIZE
it is permitted to use. If this value is exceeded then Boost.Regex
will stop trying to find a match and throw a std::runtime_error.
Defaults to 1024, don't forget to tweek this value if you alter
BOOST_REGEX_BLOCKSIZE by much.
</p>
</td>
</tr>
<tr>
<td>
<p>
BOOST_REGEX_MAX_CACHE_BLOCKS
</p>
<p>
BOOST_REGEX_MAX_CACHE_BLOCKS
</p>
</td>
<td>
<p>
Tells Boost.Regex how many memory blocks to store in it's internal
cache - memory blocks are taken from this cache rather than by calling
::operator new. Generally speeking this can be an order of magnitude
faster than calling ::opertator new each time a memory block is required,
but has the downside that Boost.Regex can end up caching a large
chunk of memory (by default up to 16 blocks each of BOOST_REGEX_BLOCKSIZE
size). If memory is tight then try defining this to 0 (disables all
caching), or if that is too slow, then a value of 1 or 2, may be
sufficient. On the other hand, on large multi-processor, multi-threaded
systems, you may find that a higher value is in order.
</p>
<p>
Tells Boost.Regex how many memory blocks to store in it's internal
cache - memory blocks are taken from this cache rather than by
calling ::operator new. Generally speeking this can be an order
of magnitude faster than calling ::opertator new each time a memory
block is required, but has the downside that Boost.Regex can end
up caching a large chunk of memory (by default up to 16 blocks
each of BOOST_REGEX_BLOCKSIZE size). If memory is tight then try
defining this to 0 (disables all caching), or if that is too slow,
then a value of 1 or 2, may be sufficient. On the other hand, on
large multi-processor, multi-threaded systems, you may find that
a higher value is in order.
</p>
</td>
</tr>
</tbody>
@ -148,7 +150,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.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="../install.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
<a accesskey="p" href="algorithm.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../configuration.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../install.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>