libs/log/doc/html/boost/log/expressions/pattern_replacer.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template pattern_replacer</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../../expressions.html#header.boost.log.expressions.formatters.char_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/char_decorator.hpp&gt;">
   9 <link rel="prev" href="make_c_ascii_decor.html" title="Function template make_c_ascii_decor">
  10 <link rel="next" href="pattern_replacer/string_lengths.html" title="Struct string_lengths">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="make_c_ascii_decor.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.char_decorator_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="pattern_replacer/string_lengths.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.pattern_replacer"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template pattern_replacer</span></h2>
  22 <p>boost::log::expressions::pattern_replacer</p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../expressions.html#header.boost.log.expressions.formatters.char_decorator_hpp" title="Header &lt;boost/log/expressions/formatters/char_decorator.hpp&gt;">boost/log/expressions/formatters/char_decorator.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="pattern_replacer.html" title="Class template pattern_replacer">pattern_replacer</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// types</span>
  31   <span class="keyword">typedef</span> <span class="keyword">void</span>                           <a name="boost.log.expressions.pattern_replacer.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>  <span class="comment">// Result type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                          <a name="boost.log.expressions.pattern_replacer.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>    <span class="comment">// Character type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.expressions.pattern_replacer.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>  <span class="comment">// String type. </span>
  34
  35   <span class="comment">// member classes/structs/unions</span>
  36
  37   <span class="comment">// Lengths of source pattern and replacement.</span>
  38
  39   <span class="keyword">struct</span> <a class="link" href="pattern_replacer/string_lengths.html" title="Struct string_lengths">string_lengths</a> <span class="special">{</span>
  40
  41     <span class="comment">// public data members</span>
  42     <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">from_len</span><span class="special">;</span>
  43     <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">to_len</span><span class="special">;</span>
  44   <span class="special">}</span><span class="special">;</span>
  45
  46   <span class="comment">// <a class="link" href="pattern_replacer.html#boost.log.expressions.pattern_replacerconstruct-copy-destruct">construct/copy/destruct</a></span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="pattern_replacer.html#idp62750144-bb"><span class="identifier">pattern_replacer</span></a><span class="special">(</span><span class="identifier">RangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  48   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FromRangeT<span class="special">,</span> <span class="keyword">typename</span> ToRangeT<span class="special">&gt;</span>
  49     <a class="link" href="pattern_replacer.html#idp62753760-bb"><span class="identifier">pattern_replacer</span></a><span class="special">(</span><span class="identifier">FromRangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">ToRangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <a class="link" href="pattern_replacer.html#idp62758704-bb"><span class="identifier">pattern_replacer</span></a><span class="special">(</span><a class="link" href="pattern_replacer.html" title="Class template pattern_replacer">pattern_replacer</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  51
  52   <span class="comment">// <a class="link" href="pattern_replacer.html#idp62746288-bb">public member functions</a></span>
  53   <span class="identifier">result_type</span> <a class="link" href="pattern_replacer.html#idp62746848-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">string_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">string_type</span><span class="special">::</span><span class="identifier">size_type</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54
  55   <span class="comment">// <a class="link" href="pattern_replacer.html#idp62760256-bb">private static functions</a></span>
  56   <span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a class="link" href="pattern_replacer.html#idp62760832-bb"><span class="identifier">string_begin</span></a><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> <a class="link" href="pattern_replacer.html#idp62762640-bb"><span class="identifier">string_begin</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
  59     <span class="keyword">static</span> <span class="identifier">range_const_iterator</span><span class="special">&lt;</span> <span class="identifier">RangeT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="pattern_replacer.html#idp62764448-bb"><span class="identifier">string_begin</span></a><span class="special">(</span><span class="identifier">RangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a class="link" href="pattern_replacer.html#idp62767120-bb"><span class="identifier">string_end</span></a><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> <a class="link" href="pattern_replacer.html#idp62768928-bb"><span class="identifier">string_end</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  62   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
  63     <span class="keyword">static</span> <span class="identifier">range_const_iterator</span><span class="special">&lt;</span> <span class="identifier">RangeT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="pattern_replacer.html#idp62770736-bb"><span class="identifier">string_end</span></a><span class="special">(</span><span class="identifier">RangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  64 <span class="special">}</span><span class="special">;</span></pre></div>
  65 <div class="refsect1">
  66 <a name="idp112220288"></a><h2>Description</h2>
  67 <p>A simple character decorator implementation. This implementation replaces string patterns in the source string with the fixed replacements. Source patterns and replacements can be specified at the object construction. </p>
  68 <div class="refsect2">
  69 <a name="idp112221200"></a><h3>
  70 <a name="boost.log.expressions.pattern_replacerconstruct-copy-destruct"></a><code class="computeroutput">pattern_replacer</code>
  71         public
  72        construct/copy/destruct</h3>
  73 <div class="orderedlist"><ol class="orderedlist" type="1">
  74 <li class="listitem">
  75 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
  76   <span class="keyword">explicit</span> <a name="idp62750144-bb"></a><span class="identifier">pattern_replacer</span><span class="special">(</span><span class="identifier">RangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> decorations<span class="special">)</span><span class="special">;</span></pre>
  77 <p>Initializing constructor. Creates a pattern replacer with the specified <span class="emphasis"><em>decorations</em></span>. The provided decorations must be a sequence of <code class="computeroutput">std::pair</code> of strings. The first element of each pair is the source pattern, and the second one is the corresponding replacement. </p>
  78 </li>
  79 <li class="listitem">
  80 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FromRangeT<span class="special">,</span> <span class="keyword">typename</span> ToRangeT<span class="special">&gt;</span>
  81   <a name="idp62753760-bb"></a><span class="identifier">pattern_replacer</span><span class="special">(</span><span class="identifier">FromRangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> from<span class="special">,</span> <span class="identifier">ToRangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> to<span class="special">)</span><span class="special">;</span></pre>
  82 <p>Initializing constructor. Creates a pattern replacer with decorations specified in form of two same-sized string sequences. Each <code class="computeroutput">i</code>'th decoration will be <code class="computeroutput">from[i]</code> -&gt; <code class="computeroutput">to[i]</code>. </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><a name="idp62758704-bb"></a><span class="identifier">pattern_replacer</span><span class="special">(</span><a class="link" href="pattern_replacer.html" title="Class template pattern_replacer">pattern_replacer</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>Copy constructor. </li>
  86 </ol></div>
  87 </div>
  88 <div class="refsect2">
  89 <a name="idp112255152"></a><h3>
  90 <a name="idp62746288-bb"></a><code class="computeroutput">pattern_replacer</code> public member functions</h3>
  91 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  92 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idp62746848-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">string_type</span> <span class="special">&amp;</span> str<span class="special">,</span>
  93                        <span class="keyword">typename</span> <span class="identifier">string_type</span><span class="special">::</span><span class="identifier">size_type</span> start_pos <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Applies string replacements starting from the specified position. </li></ol></div>
  94 </div>
  95 <div class="refsect2">
  96 <a name="idp112269264"></a><h3>
  97 <a name="idp62760256-bb"></a><code class="computeroutput">pattern_replacer</code> private static functions</h3>
  98 <div class="orderedlist"><ol class="orderedlist" type="1">
  99 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a name="idp62760832-bb"></a><span class="identifier">string_begin</span><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre></li>
 100 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> <a name="idp62762640-bb"></a><span class="identifier">string_begin</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre></li>
 101 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
 102   <span class="keyword">static</span> <span class="identifier">range_const_iterator</span><span class="special">&lt;</span> <span class="identifier">RangeT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="idp62764448-bb"></a><span class="identifier">string_begin</span><span class="special">(</span><span class="identifier">RangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> r<span class="special">)</span><span class="special">;</span></pre></li>
 103 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a name="idp62767120-bb"></a><span class="identifier">string_end</span><span class="special">(</span><span class="identifier">char_type</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre></li>
 104 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> <a name="idp62768928-bb"></a><span class="identifier">string_end</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre></li>
 105 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
 106   <span class="keyword">static</span> <span class="identifier">range_const_iterator</span><span class="special">&lt;</span> <span class="identifier">RangeT</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="idp62770736-bb"></a><span class="identifier">string_end</span><span class="special">(</span><span class="identifier">RangeT</span> <span class="keyword">const</span> <span class="special">&amp;</span> r<span class="special">)</span><span class="special">;</span></pre></li>
 107 </ol></div>
 108 </div>
 109 </div>
 110 </div>
 111 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 112 <td align="left"></td>
 113 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 114         Distributed under the Boost Software License, Version 1.0. (See accompanying
 115         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>).
 116       </p>
 117 </div></td>
 118 </tr></table>
 119 <hr>
 120 <div class="spirit-nav">
 121 <a accesskey="p" href="make_c_ascii_decor.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.char_decorator_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="pattern_replacer/string_lengths.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 122 </div>
 123 </body>
 124 </html>