forked from boostorg/regex
added license info in copyright notice at the footer
[SVN r40867]
This commit is contained in:
Joel de Guzman
@ -1,13 +1,15 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>Traits Class Requirements</title>
|
||||
<title> Traits Class
|
||||
Requirements</title>
|
||||
<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_2006-12-17_0120">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
|
||||
<link rel="start" href="../../../index.html" title="Boost.Regex">
|
||||
<link rel="up" href="../concepts.html" title="Concepts">
|
||||
<link rel="prev" href="charT_concept.html" title="charT Requirements">
|
||||
<link rel="next" href="iterator_concepts.html" title="Iterator Rrequirements">
|
||||
<link rel="up" href="../concepts.html" title=" Concepts">
|
||||
<link rel="prev" href="charT_concept.html" title=" charT Requirements">
|
||||
<link rel="next" href="iterator_concepts.html" title=" Iterator
|
||||
Rrequirements">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr>
|
||||
@ -24,37 +26,37 @@
|
||||
</div>
|
||||
<div class="section" lang="en">
|
||||
<div class="titlepage"><div><div><h4 class="title">
|
||||
<a name="boost_regex.ref.concepts.traits_concept"></a><a href="traits_concept.html" title="Traits Class Requirements"> Traits Class
|
||||
Requirements</a>
|
||||
</h4></div></div></div>
|
||||
<a name="boost_regex.ref.concepts.traits_concept"></a><a href="traits_concept.html" title=" Traits Class
|
||||
Requirements"> Traits Class
|
||||
Requirements</a></h4></div></div></div>
|
||||
<p>
|
||||
There are two sets of requirements for the <code class="computeroutput"><span class="identifier">traits</span></code>
|
||||
template argument to <a href="../basic_regex.html" title="basic_regex"><code class="computeroutput"><span class="identifier">basic_regex</span></code></a>: a mininal interface
|
||||
There are two sets of requirements for the <tt class="computeroutput"><span class="identifier">traits</span></tt>
|
||||
template argument to <a href="../basic_regex.html" title=" basic_regex"><tt class="computeroutput"><span class="identifier">basic_regex</span></tt></a>: a mininal interface
|
||||
(which is part of the regex standardization proposal), and an optional
|
||||
Boost-specific enhanced interface.
|
||||
</p>
|
||||
<a name="boost_regex.ref.concepts.traits_concept.minimal_requirements_"></a><h5>
|
||||
<a name="id623213"></a>
|
||||
<a name="boost_regex.ref.concepts.traits_concept.minimal_requirements_"></a><h4>
|
||||
<a name="id589905"></a>
|
||||
<a href="traits_concept.html#boost_regex.ref.concepts.traits_concept.minimal_requirements_">Minimal
|
||||
requirements.</a>
|
||||
</h5>
|
||||
</h4>
|
||||
<p>
|
||||
In the following table <code class="computeroutput"><span class="identifier">X</span></code>
|
||||
In the following table <tt class="computeroutput"><span class="identifier">X</span></tt>
|
||||
denotes a traits class defining types and functions for the character container
|
||||
type <code class="computeroutput"><span class="identifier">charT</span></code>; <span class="emphasis"><em>u</em></span>
|
||||
is an object of type <code class="computeroutput"><span class="identifier">X</span></code>;
|
||||
<span class="emphasis"><em>v</em></span> is an object of type <code class="computeroutput"><span class="keyword">const</span>
|
||||
<span class="identifier">X</span></code>; <span class="emphasis"><em>p</em></span> is
|
||||
a value of type <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">charT</span><span class="special">*</span></code>; <span class="emphasis"><em>I1</em></span> and <span class="emphasis"><em>I2</em></span>
|
||||
are Input Iterators; <span class="emphasis"><em>c</em></span> is a value of type <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">charT</span></code>;
|
||||
<span class="emphasis"><em>s</em></span> is an object of type <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">string_type</span></code>;
|
||||
<span class="emphasis"><em>cs</em></span> is an object of type <code class="computeroutput"><span class="keyword">const</span>
|
||||
<span class="identifier">X</span><span class="special">::</span><span class="identifier">string_type</span></code>; <span class="emphasis"><em>b</em></span> is
|
||||
a value of type <code class="computeroutput"><span class="keyword">bool</span></code>; <span class="emphasis"><em>I</em></span>
|
||||
is a value of type <code class="computeroutput"><span class="keyword">int</span></code>; <span class="emphasis"><em>F1</em></span>
|
||||
and <span class="emphasis"><em>F2</em></span> are values of type <code class="computeroutput"><span class="keyword">const</span>
|
||||
<span class="identifier">charT</span><span class="special">*</span></code>;
|
||||
and <span class="emphasis"><em>loc</em></span> is an object of type <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">locale_type</span></code>.
|
||||
type <tt class="computeroutput"><span class="identifier">charT</span></tt>; <span class="emphasis"><em>u</em></span>
|
||||
is an object of type <tt class="computeroutput"><span class="identifier">X</span></tt>;
|
||||
<span class="emphasis"><em>v</em></span> is an object of type <tt class="computeroutput"><span class="keyword">const</span>
|
||||
<span class="identifier">X</span></tt>; <span class="emphasis"><em>p</em></span> is
|
||||
a value of type <tt class="computeroutput"><span class="keyword">const</span> <span class="identifier">charT</span><span class="special">*</span></tt>; <span class="emphasis"><em>I1</em></span> and <span class="emphasis"><em>I2</em></span>
|
||||
are Input Iterators; <span class="emphasis"><em>c</em></span> is a value of type <tt class="computeroutput"><span class="keyword">const</span> <span class="identifier">charT</span></tt>;
|
||||
<span class="emphasis"><em>s</em></span> is an object of type <tt class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">string_type</span></tt>;
|
||||
<span class="emphasis"><em>cs</em></span> is an object of type <tt class="computeroutput"><span class="keyword">const</span>
|
||||
<span class="identifier">X</span><span class="special">::</span><span class="identifier">string_type</span></tt>; <span class="emphasis"><em>b</em></span> is
|
||||
a value of type <tt class="computeroutput"><span class="keyword">bool</span></tt>; <span class="emphasis"><em>I</em></span>
|
||||
is a value of type <tt class="computeroutput"><span class="keyword">int</span></tt>; <span class="emphasis"><em>F1</em></span>
|
||||
and <span class="emphasis"><em>F2</em></span> are values of type <tt class="computeroutput"><span class="keyword">const</span>
|
||||
<span class="identifier">charT</span><span class="special">*</span></tt>;
|
||||
and <span class="emphasis"><em>loc</em></span> is an object of type <tt class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">locale_type</span></tt>.
|
||||
</p>
|
||||
<div class="informaltable"><table class="table">
|
||||
<colgroup>
|
||||
@ -400,17 +402,17 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<a name="boost_regex.ref.concepts.traits_concept.additional_optional_requirements"></a><h5>
|
||||
<a name="id624046"></a>
|
||||
<a name="boost_regex.ref.concepts.traits_concept.additional_optional_requirements"></a><h4>
|
||||
<a name="id590748"></a>
|
||||
<a href="traits_concept.html#boost_regex.ref.concepts.traits_concept.additional_optional_requirements">Additional
|
||||
Optional Requirements</a>
|
||||
</h5>
|
||||
</h4>
|
||||
<p>
|
||||
The following additional requirements are strictly optional, however in
|
||||
order for <a href="../basic_regex.html" title="basic_regex"><code class="computeroutput"><span class="identifier">basic_regex</span></code></a>
|
||||
order for <a href="../basic_regex.html" title=" basic_regex"><tt class="computeroutput"><span class="identifier">basic_regex</span></tt></a>
|
||||
to take advantage of these additional interfaces, all of the following
|
||||
requirements must be met; <a href="../basic_regex.html" title="basic_regex"><code class="computeroutput"><span class="identifier">basic_regex</span></code></a> will detect the presence
|
||||
or absense of the member <code class="computeroutput"><span class="identifier">boost_extensions_tag</span></code>
|
||||
requirements must be met; <a href="../basic_regex.html" title=" basic_regex"><tt class="computeroutput"><span class="identifier">basic_regex</span></tt></a> will detect the presence
|
||||
or absense of the member <tt class="computeroutput"><span class="identifier">boost_extensions_tag</span></tt>
|
||||
and configure itself appropriately.
|
||||
</p>
|
||||
<div class="informaltable"><table class="table">
|
||||
@ -491,8 +493,8 @@
|
||||
that signifies the meaning of character c within the regular expression
|
||||
grammar, when c has been preceded by an escape character. Precondition:
|
||||
if b is the character preceding c in the expression being parsed
|
||||
then: <code class="computeroutput"><span class="identifier">v</span><span class="special">.</span><span class="identifier">syntax_type</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span>
|
||||
<span class="special">==</span> <span class="identifier">syntax_escape</span></code>
|
||||
then: <tt class="computeroutput"><span class="identifier">v</span><span class="special">.</span><span class="identifier">syntax_type</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span>
|
||||
<span class="special">==</span> <span class="identifier">syntax_escape</span></tt>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -510,9 +512,9 @@
|
||||
<td>
|
||||
<p>
|
||||
Returns a character d such that: for any character d that is to
|
||||
be considered equivalent to c then <code class="computeroutput"><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">c</span><span class="special">,</span><span class="keyword">false</span><span class="special">)==</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">d</span><span class="special">,</span><span class="keyword">false</span><span class="special">)</span></code>. Likewise for all characters C
|
||||
be considered equivalent to c then <tt class="computeroutput"><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">c</span><span class="special">,</span><span class="keyword">false</span><span class="special">)==</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">d</span><span class="special">,</span><span class="keyword">false</span><span class="special">)</span></tt>. Likewise for all characters C
|
||||
that are to be considered equivalent to c when comparisons are
|
||||
to be performed without regard to case, then <code class="computeroutput"><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">c</span><span class="special">,</span><span class="keyword">true</span><span class="special">)==</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">C</span><span class="special">,</span><span class="keyword">true</span><span class="special">)</span></code>.
|
||||
to be performed without regard to case, then <tt class="computeroutput"><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">c</span><span class="special">,</span><span class="keyword">true</span><span class="special">)==</span><span class="identifier">v</span><span class="special">.</span><span class="identifier">translate</span><span class="special">(</span><span class="identifier">C</span><span class="special">,</span><span class="keyword">true</span><span class="special">)</span></tt>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -529,9 +531,9 @@
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Behaves as follows: if <code class="computeroutput"><span class="identifier">p</span>
|
||||
<span class="special">==</span> <span class="identifier">q</span></code>
|
||||
or if <code class="computeroutput"><span class="special">*</span><span class="identifier">p</span></code>
|
||||
Behaves as follows: if <tt class="computeroutput"><span class="identifier">p</span>
|
||||
<span class="special">==</span> <span class="identifier">q</span></tt>
|
||||
or if <tt class="computeroutput"><span class="special">*</span><span class="identifier">p</span></tt>
|
||||
is not a digit character then returns -1. Otherwise performs formatted
|
||||
numeric input on the sequence [p,q) and returns the result as an
|
||||
int. Postcondition: either p == q or *p is a non-digit character.
|
||||
@ -599,7 +601,10 @@
|
||||
</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>
|
||||
<td align="right"><div class="copyright-footer"><small>Copyright <20> 2007 John Maddock<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></small></div></td>
|
||||
</tr></table>
|
||||
<hr>
|
||||
<div class="spirit-nav">
|
||||
|
||||
Reference in New Issue
Block a user