blob: bd8c0623412339f2afb320729df2c4b68bdd9dd1 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template pattern_replacer</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
<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;">
<link rel="prev" href="char_decorator_terminal.html" title="Class template char_decorator_terminal">
<link rel="next" href="pattern_replacer/string_lengths.html" title="Struct string_lengths">
</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></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="char_decorator_terminal.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>
</div>
<div class="refentry">
<a name="boost.log.expressions.pattern_replacer"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template pattern_replacer</span></h2>
<p>boost::log::expressions::pattern_replacer</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: &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;
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
<span class="keyword">class</span> <a class="link" href="pattern_replacer.html" title="Class template pattern_replacer">pattern_replacer</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<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>
<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>
<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>
<span class="comment">// member classes/structs/unions</span>
<span class="comment">// Lengths of source pattern and replacement.</span>
<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>
<span class="comment">// public data members</span>
<span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">from_len</span><span class="special">;</span>
<span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">to_len</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span>
<span class="comment">// <a class="link" href="pattern_replacer.html#boost.log.expressions.pattern_replacerconstruct-copy-destruct">construct/copy/destruct</a></span>
<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#idp42703536-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>
<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>
<a class="link" href="pattern_replacer.html#idp42707152-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>
<a class="link" href="pattern_replacer.html#idp42712096-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>
<span class="comment">// <a class="link" href="pattern_replacer.html#idp42699680-bb">public member functions</a></span>
<span class="identifier">result_type</span> <a class="link" href="pattern_replacer.html#idp42700240-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>
<span class="comment">// <a class="link" href="pattern_replacer.html#idp42713648-bb">private static functions</a></span>
<span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a class="link" href="pattern_replacer.html#idp42714224-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>
<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#idp42716032-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>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
<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#idp42717840-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>
<span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a class="link" href="pattern_replacer.html#idp42720512-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>
<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#idp42722320-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>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RangeT<span class="special">&gt;</span>
<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#idp42724128-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>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp112302016"></a><h2>Description</h2>
<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>
<div class="refsect2">
<a name="idp112302928"></a><h3>
<a name="boost.log.expressions.pattern_replacerconstruct-copy-destruct"></a><code class="computeroutput">pattern_replacer</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<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>
<span class="keyword">explicit</span> <a name="idp42703536-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>
<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>
</li>
<li class="listitem">
<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>
<a name="idp42707152-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>
<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>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp42712096-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>
</ol></div>
</div>
<div class="refsect2">
<a name="idp112336928"></a><h3>
<a name="idp42699680-bb"></a><code class="computeroutput">pattern_replacer</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp42700240-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>
<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>
</div>
<div class="refsect2">
<a name="idp112351040"></a><h3>
<a name="idp42713648-bb"></a><code class="computeroutput">pattern_replacer</code> private static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a name="idp42714224-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>
<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="idp42716032-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>
<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>
<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="idp42717840-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>
<li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">char_type</span> <span class="special">*</span> <a name="idp42720512-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>
<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="idp42722320-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>
<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>
<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="idp42724128-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>
</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 &#169; 2007-2015 Andrey
Semashev<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="char_decorator_terminal.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>
</div>
</body>
</html>