boost/libs/regex/doc/regex_traits.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3    <head>
   4       <title>Boost.Regex: class regex_traits</title>
   5       <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   6       <link rel="stylesheet" type="text/css" href="../../../boost.css">
   7    </head>
   8    <body>
   9       <P>
  10          <TABLE id="Table1" cellSpacing="1" cellPadding="1" width="100%" border="0">
  11             <TR>
  12                <td valign="top" width="300">
  13                   <h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3>
  14                </td>
  15                <TD width="353">
  16                   <H1 align="center">Boost.Regex</H1>
  17                   <H2 align="center">class regex_traits</H2>
  18                </TD>
  19                <td width="50">
  20                   <h3><a href="index.html"><img height="45" width="43" alt="Boost.Regex Index" src="uarrow.gif" border="0"></a></h3>
  21                </td>
  22             </TR>
  23          </TABLE>
  24       </P>
  25       <HR>
  26       <H3>Contents</H3>
  27       <dl class="index">
  28          <dt><A href="#synopsis">Synopsis</A> <dt><a href="#description">Description</a></dt>
  29       </dl>
  30       <H3><A name="synopsis"></A>Synopsis</H3>
  31       <pre>
  32 namespace boost{
  33
  34 template &lt;class charT, class implementationT = sensible_default_choice&gt;
  35 struct regex_traits : public implementationT
  36 {
  37    regex_traits() : implementationT() {}
  38 };
  39
  40 template &lt;class charT&gt;
  41 struct c_regex_traits;
  42
  43 template &lt;class charT&gt;
  44 struct cpp_regex_traits;
  45
  46 template &lt;class charT&gt;
  47 struct w32_regex_traits;
  48
  49 } // namespace boost
  50 </pre>
  51       <H3><A name="description"></A>Description</H3>
  52       <P>The class regex_traits is just a thin wrapper around an actual implemention
  53          class, which may be one of:</P>
  54       <UL>
  55          <LI>
  56             c_regex_traits: this class is deprecated, it wraps the C locale, and is used as
  57             the default implementation when the platform is not Win32, and the C++ locale
  58             is not available.</LI>
  59          <LI>
  60             cpp_regex_traits: the default traits class for non-Win32 platforms, allows the
  61             regex class to be imbued with a std::locale instance.</LI>
  62          <LI>
  63             w32_regex_traits: the default traits class implementation on Win32 platforms,
  64             allows the regex class to be imbued with an LCID.</LI></UL>
  65       <P>The default behavior can be altered by defining one of the following
  66          configuration macros in <A href="../../../boost/regex/user.hpp">boost/regex/user.hpp</A>:</P>
  67       <UL>
  68          <LI>
  69             BOOST_REGEX_USE_C_LOCALE: makes c_regex_traits the default.</LI>
  70          <LI>
  71             BOOST_REGEX_USE_CPP_LOCALE: makes cpp_regex_traits the default.</LI></UL>
  72       <P>All these traits classes fulfil the <A href="concepts.html#traits">traits class
  73             requirements</A>.</P>
  74       <HR>
  75       <P></P>
  76       <p>Revised
  77          <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
  78          24&nbsp;June 2004&nbsp;
  79          <!--webbot bot="Timestamp" endspan i-checksum="39359" --></p>
  80       <p><i>© Copyright John Maddock&nbsp;1998-
  81             <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%Y" startspan -->
  82             2004</i></p>
  83       <P><I>Use, modification and distribution are subject to the Boost Software License,
  84             Version 1.0. (See accompanying file <A href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A>
  85             or copy at <A href="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</A>)</I></P>
  86    </body>
  87 </html>