| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Struct template cpp_regex_traits</title> |
| <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="The Boost C++ Libraries BoostBook Documentation Subset"> |
| <link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.traits.cpp_regex_traits_hpp" title="Header <boost/xpressive/traits/cpp_regex_traits.hpp>"> |
| <link rel="prev" href="has_fold_case_c_regex_t_id1542741.html" title="Struct has_fold_case<c_regex_traits< char >>"> |
| <link rel="next" href="has_fold_case_cpp_regex_id1543521.html" title="Struct has_fold_case<cpp_regex_traits< char >>"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="has_fold_case_c_regex_t_id1542741.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.traits.cpp_regex_traits_hpp"><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="has_fold_case_cpp_regex_id1543521.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="refentry"> |
| <a name="boost.xpressive.cpp_regex_traits"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Struct template cpp_regex_traits</span></h2> |
| <p>boost::xpressive::cpp_regex_traits — Encapsaulates a std::locale for use by the basic_regex<> class template. </p> |
| </div> |
| <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
| <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../xpressive/reference.html#header.boost.xpressive.traits.cpp_regex_traits_hpp" title="Header <boost/xpressive/traits/cpp_regex_traits.hpp>">boost/xpressive/traits/cpp_regex_traits.hpp</a>> |
| |
| </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">></span> |
| <span class="keyword">struct</span> <a class="link" href="cpp_regex_traits.html" title="Struct template cpp_regex_traits">cpp_regex_traits</a> <span class="special">{</span> |
| <span class="comment">// types</span> |
| <span class="keyword">typedef</span> <span class="identifier">Char</span> <a name="boost.xpressive.cpp_regex_traits.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">char_type</span> <span class="special">></span> <a name="boost.xpressive.cpp_regex_traits.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">locale</span> <a name="boost.xpressive.cpp_regex_traits.locale_type"></a><span class="identifier">locale_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.xpressive.cpp_regex_traits.char_class_type"></a><span class="identifier">char_class_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <a class="link" href="regex_traits_version_2_tag.html" title="Struct regex_traits_version_2_tag">regex_traits_version_2_tag</a> <a name="boost.xpressive.cpp_regex_traits.version_tag"></a><span class="identifier">version_tag</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.xpressive.cpp_regex_traits.base_type"></a><span class="identifier">base_type</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="cpp_regex_traits.html#boost.xpressive.cpp_regex_traitsconstruct-copy-destruct">construct/copy/destruct</a></span> |
| <a class="link" href="cpp_regex_traits.html#id1543398-bb"><span class="identifier">cpp_regex_traits</span></a><span class="special">(</span><span class="identifier">locale_type</span> <span class="keyword">const</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">locale_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="cpp_regex_traits.html#id1542817-bb">public member functions</a></span> |
| <span class="keyword">bool</span> <a class="link" href="cpp_regex_traits.html#id1542821-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><a class="link" href="cpp_regex_traits.html" title="Struct template cpp_regex_traits">cpp_regex_traits</a><span class="special"><</span> <span class="identifier">char_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">bool</span> <a class="link" href="cpp_regex_traits.html#id1542848-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><a class="link" href="cpp_regex_traits.html" title="Struct template cpp_regex_traits">cpp_regex_traits</a><span class="special"><</span> <span class="identifier">char_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">char_type</span> <a class="link" href="cpp_regex_traits.html#id1542874-bb"><span class="identifier">widen</span></a><span class="special">(</span><span class="keyword">char</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">char_type</span> <a class="link" href="cpp_regex_traits.html#id1542902-bb"><span class="identifier">translate_nocase</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">char_type</span> <a class="link" href="cpp_regex_traits.html#id1542930-bb"><span class="identifier">tolower</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">char_type</span> <a class="link" href="cpp_regex_traits.html#id1542958-bb"><span class="identifier">toupper</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">string_type</span> <a class="link" href="cpp_regex_traits.html#id1542986-bb"><span class="identifier">fold_case</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">bool</span> <a class="link" href="cpp_regex_traits.html#id1543017-bb"><span class="identifier">in_range_nocase</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FwdIter<span class="special">></span> |
| <span class="identifier">string_type</span> <a class="link" href="cpp_regex_traits.html#id1543072-bb"><span class="identifier">transform_primary</span></a><span class="special">(</span><span class="identifier">FwdIter</span><span class="special">,</span> <span class="identifier">FwdIter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FwdIter<span class="special">></span> |
| <span class="identifier">string_type</span> <a class="link" href="cpp_regex_traits.html#id1543112-bb"><span class="identifier">lookup_collatename</span></a><span class="special">(</span><span class="identifier">FwdIter</span><span class="special">,</span> <span class="identifier">FwdIter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FwdIter<span class="special">></span> |
| <span class="identifier">char_class_type</span> <a class="link" href="cpp_regex_traits.html#id1543151-bb"><span class="identifier">lookup_classname</span></a><span class="special">(</span><span class="identifier">FwdIter</span><span class="special">,</span> <span class="identifier">FwdIter</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">bool</span> <a class="link" href="cpp_regex_traits.html#id1543209-bb"><span class="identifier">isctype</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">char_class_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">int</span> <a class="link" href="cpp_regex_traits.html#id1543252-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="identifier">locale_type</span> <a class="link" href="cpp_regex_traits.html#id1543297-bb"><span class="identifier">imbue</span></a><span class="special">(</span><span class="identifier">locale_type</span><span class="special">)</span><span class="special">;</span> |
| <span class="identifier">locale_type</span> <a class="link" href="cpp_regex_traits.html#id1543324-bb"><span class="identifier">getloc</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a class="link" href="cpp_regex_traits.html#id1543336-bb"><span class="identifier">hash</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a class="link" href="cpp_regex_traits.html#id1543351-bb"><span class="identifier">hash</span></a><span class="special">(</span><span class="keyword">char</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a class="link" href="cpp_regex_traits.html#id1543367-bb"><span class="identifier">hash</span></a><span class="special">(</span><span class="keyword">signed</span> <span class="keyword">char</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a class="link" href="cpp_regex_traits.html#id1543383-bb"><span class="identifier">hash</span></a><span class="special">(</span><span class="keyword">wchar_t</span><span class="special">)</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="cpp_regex_traits.html#id1543413-bb">public static functions</a></span> |
| <span class="keyword">static</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a class="link" href="cpp_regex_traits.html#id1543417-bb"><span class="identifier">hash</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">static</span> <span class="identifier">char_type</span> <a class="link" href="cpp_regex_traits.html#id1543445-bb"><span class="identifier">translate</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="cpp_regex_traits.html#id1543471-bb"><span class="identifier">in_range</span></a><span class="special">(</span><span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">char_type</span><span class="special">)</span><span class="special">;</span> |
| <span class="special">}</span><span class="special">;</span></pre></div> |
| <div class="refsect1"> |
| <a name="id3208289"></a><h2>Description</h2> |
| <div class="refsect2"> |
| <a name="id3208293"></a><h3> |
| <a name="boost.xpressive.cpp_regex_traitsconstruct-copy-destruct"></a><code class="computeroutput">cpp_regex_traits</code> |
| public |
| construct/copy/destruct</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> |
| <pre class="literallayout"><a name="id1543398-bb"></a><span class="identifier">cpp_regex_traits</span><span class="special">(</span><span class="identifier">locale_type</span> <span class="keyword">const</span> <span class="special">&</span> loc <span class="special">=</span> <span class="identifier">locale_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> |
| <p>Initialize a cpp_regex_traits object to use the specified std::locale, or the global std::locale if none is specified. </p> |
| </li></ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="id3208381"></a><h3> |
| <a name="id1542817-bb"></a><code class="computeroutput">cpp_regex_traits</code> public member functions</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">bool</span> <a name="id1542821-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><a class="link" href="cpp_regex_traits.html" title="Struct template cpp_regex_traits">cpp_regex_traits</a><span class="special"><</span> <span class="identifier">char_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Checks two cpp_regex_traits objects for equality</p> |
| <p> |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>this->getloc() == that.getloc(). </p></td> |
| </tr></tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">bool</span> <a name="id1542848-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><a class="link" href="cpp_regex_traits.html" title="Struct template cpp_regex_traits">cpp_regex_traits</a><span class="special"><</span> <span class="identifier">char_type</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> that<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Checks two cpp_regex_traits objects for inequality</p> |
| <p> |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>this->getloc() != that.getloc(). </p></td> |
| </tr></tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">char_type</span> <a name="id1542874-bb"></a><span class="identifier">widen</span><span class="special">(</span><span class="keyword">char</span> ch<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Convert a char to a Char</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>std::use_facet<std::ctype<char_type> >(this->getloc()).widen(ch). </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">char_type</span> <a name="id1542902-bb"></a><span class="identifier">translate_nocase</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Converts a character to lower-case using the internally-stored std::locale.</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>std::tolower(ch, this->getloc()). </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">char_type</span> <a name="id1542930-bb"></a><span class="identifier">tolower</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Converts a character to lower-case using the internally-stored std::locale.</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>std::tolower(ch, this->getloc()). </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">char_type</span> <a name="id1542958-bb"></a><span class="identifier">toupper</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Converts a character to upper-case using the internally-stored std::locale.</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>std::toupper(ch, this->getloc()). </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">string_type</span> <a name="id1542986-bb"></a><span class="identifier">fold_case</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Returns a string_type containing all the characters that compare equal disregrarding case to the one passed in. This function can only be called if has_fold_case<cpp_regex_traits<Char> >value is true.</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>string_type containing all chars which are equal to ch when disregarding case </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">bool</span> <a name="id1543017-bb"></a><span class="identifier">in_range_nocase</span><span class="special">(</span><span class="identifier">char_type</span> first<span class="special">,</span> <span class="identifier">char_type</span> last<span class="special">,</span> <span class="identifier">char_type</span> ch<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Checks to see if a character is within a character range, irregardless of case.</p> |
| <p> |
| |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">first</code></span></p></td> |
| <td><p>The bottom of the range, inclusive. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">last</code></span></p></td> |
| <td><p>The top of the range, inclusive. </p></td> |
| </tr> |
| </tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>in_range(first, last, ch) || in_range(first, last, tolower(ch, this->getloc())) || in_range(first, last, toupper(ch, this->getloc())) </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Notes:</span></p></td> |
| <td><p>The default implementation doesn't do proper Unicode case folding, but this is the best we can do with the standard ctype facet. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FwdIter<span class="special">></span> |
| <span class="identifier">string_type</span> <a name="id1543072-bb"></a><span class="identifier">transform_primary</span><span class="special">(</span><span class="identifier">FwdIter</span> begin<span class="special">,</span> <span class="identifier">FwdIter</span> end<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Returns a sort key for the character sequence designated by the iterator range [F1, F2) such that if the character sequence [G1, G2) sorts before the character sequence [H1, H2) when character case is not considered then v.transform_primary(G1, G2) < v.transform_primary(H1, H2).</p> |
| <p> |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term">Notes:</span></p></td> |
| <td><p>Not currently used </p></td> |
| </tr></tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FwdIter<span class="special">></span> |
| <span class="identifier">string_type</span> <a name="id1543112-bb"></a><span class="identifier">lookup_collatename</span><span class="special">(</span><span class="identifier">FwdIter</span> begin<span class="special">,</span> <span class="identifier">FwdIter</span> end<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Returns a sequence of characters that represents the collating element consisting of the character sequence designated by the iterator range [F1, F2). Returns an empty string if the character sequence is not a valid collating element.</p> |
| <p> |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term">Notes:</span></p></td> |
| <td><p>Not currently used </p></td> |
| </tr></tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> FwdIter<span class="special">></span> |
| <span class="identifier">char_class_type</span> |
| <a name="id1543151-bb"></a><span class="identifier">lookup_classname</span><span class="special">(</span><span class="identifier">FwdIter</span> begin<span class="special">,</span> <span class="identifier">FwdIter</span> end<span class="special">,</span> <span class="keyword">bool</span> icase<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>For the character class name represented by the specified character sequence, return the corresponding bitmask representation.</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">begin</code></span></p></td> |
| <td><p>A forward iterator to the start of the character sequence representing the name of the character class. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">end</code></span></p></td> |
| <td><p>The end of the character sequence. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">icase</code></span></p></td> |
| <td><p>Specifies whether the returned bitmask should represent the case-insensitive version of the character class. </p></td> |
| </tr> |
| </tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>A bitmask representing the character class. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">bool</span> <a name="id1543209-bb"></a><span class="identifier">isctype</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">,</span> <span class="identifier">char_class_type</span> mask<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Tests a character against a character class bitmask.</p> |
| <p> |
| |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The character to test. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">mask</code></span></p></td> |
| <td><p>The character class bitmask against which to test. </p></td> |
| </tr> |
| </tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Requires:</span></p></td> |
| <td><p>mask is a bitmask returned by lookup_classname, or is several such masks bit-or'ed together. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>true if the character is a member of any of the specified character classes, false otherwise. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">int</span> <a name="id1543252-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">,</span> <span class="keyword">int</span> radix<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Convert a digit character into the integer it represents.</p> |
| <p> |
| |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The digit character. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">radix</code></span></p></td> |
| <td><p>The radix to use for the conversion. </p></td> |
| </tr> |
| </tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Requires:</span></p></td> |
| <td><p>radix is one of 8, 10, or 16. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>-1 if ch is not a digit character, the integer value of the character otherwise. The conversion is performed by imbueing a std::stringstream with this->getloc(); setting the radix to one of oct, hex or dec; inserting ch into the stream; and extracting an int. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">locale_type</span> <a name="id1543297-bb"></a><span class="identifier">imbue</span><span class="special">(</span><span class="identifier">locale_type</span> loc<span class="special">)</span><span class="special">;</span></pre> |
| <p>Imbues *this with loc</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">loc</code></span></p></td> |
| <td><p>A std::locale. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>the previous std::locale used by *this. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">locale_type</span> <a name="id1543324-bb"></a><span class="identifier">getloc</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p>Returns the current std::locale used by *this. </p> |
| </li> |
| <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a name="id1543336-bb"></a><span class="identifier">hash</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">char</span> ch<span class="special">)</span><span class="special">;</span></pre></li> |
| <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a name="id1543351-bb"></a><span class="identifier">hash</span><span class="special">(</span><span class="keyword">char</span> ch<span class="special">)</span><span class="special">;</span></pre></li> |
| <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a name="id1543367-bb"></a><span class="identifier">hash</span><span class="special">(</span><span class="keyword">signed</span> <span class="keyword">char</span> ch<span class="special">)</span><span class="special">;</span></pre></li> |
| <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="special">></span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a name="id1543383-bb"></a><span class="identifier">hash</span><span class="special">(</span><span class="keyword">wchar_t</span> ch<span class="special">)</span><span class="special">;</span></pre></li> |
| </ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="id3210108"></a><h3> |
| <a name="id1543413-bb"></a><code class="computeroutput">cpp_regex_traits</code> public static functions</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <a name="id1543417-bb"></a><span class="identifier">hash</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">)</span><span class="special">;</span></pre> |
| <p>Returns a hash value for a Char in the range [0, UCHAR_MAX]</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>a value between 0 and UCHAR_MAX, inclusive. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">char_type</span> <a name="id1543445-bb"></a><span class="identifier">translate</span><span class="special">(</span><span class="identifier">char_type</span> ch<span class="special">)</span><span class="special">;</span></pre> |
| <p>No-op</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody><tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr></tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>ch </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id1543471-bb"></a><span class="identifier">in_range</span><span class="special">(</span><span class="identifier">char_type</span> first<span class="special">,</span> <span class="identifier">char_type</span> last<span class="special">,</span> <span class="identifier">char_type</span> ch<span class="special">)</span><span class="special">;</span></pre> |
| <p>Checks to see if a character is within a character range.</p> |
| <p> |
| |
| </p> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">Parameters:</span></p></td> |
| <td><div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">ch</code></span></p></td> |
| <td><p>The source character. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">first</code></span></p></td> |
| <td><p>The bottom of the range, inclusive. </p></td> |
| </tr> |
| <tr> |
| <td><p><span class="term"><code class="computeroutput">last</code></span></p></td> |
| <td><p>The top of the range, inclusive. </p></td> |
| </tr> |
| </tbody> |
| </table></div></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">Returns:</span></p></td> |
| <td><p>first <= ch && ch <= last. </p></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </li> |
| </ol></div> |
| </div> |
| </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"><div class="copyright-footer">Copyright © 2007 Eric Niebler<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> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="has_fold_case_c_regex_t_id1542741.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.traits.cpp_regex_traits_hpp"><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="has_fold_case_cpp_regex_id1543521.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
