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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template char_decorator_terminal</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="char_decorator_actor.html" title="Class template char_decorator_actor">
  10 <link rel="next" href="pattern_replacer.html" title="Class template pattern_replacer">
  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="char_decorator_actor.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.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.char_decorator_terminal"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template char_decorator_terminal</span></h2>
  22 <p>boost::log::expressions::char_decorator_terminal</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> SubactorT<span class="special">,</span> <span class="keyword">typename</span> ImplT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="char_decorator_terminal.html" title="Class template char_decorator_terminal">char_decorator_terminal</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="identifier">ImplT</span>                                 <a name="boost.log.expressions.char_decorator_terminal.impl_type"></a><span class="identifier">impl_type</span><span class="special">;</span>      <span class="comment">// Implementation type. </span>
  32   <span class="keyword">typedef</span> <span class="identifier">impl_type</span><span class="special">::</span><span class="identifier">char_type</span>                  <a name="boost.log.expressions.char_decorator_terminal.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">impl_type</span><span class="special">::</span><span class="identifier">string_type</span>                <a name="boost.log.expressions.char_decorator_terminal.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>    <span class="comment">// String type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">basic_formatting_ostream</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.expressions.char_decorator_terminal.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span>    <span class="comment">// Stream type. </span>
  35   <span class="keyword">typedef</span> <span class="identifier">SubactorT</span>                             <a name="boost.log.expressions.char_decorator_terminal.subactor_type"></a><span class="identifier">subactor_type</span><span class="special">;</span>  <span class="comment">// Adopted actor type. </span>
  36   <span class="keyword">typedef</span> <span class="identifier">string_type</span>                           <a name="boost.log.expressions.char_decorator_terminal.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>    <span class="comment">// Result type definition. </span>
  37
  38   <span class="comment">// <a class="link" href="char_decorator_terminal.html#boost.log.expressions.char_decorator_terminalconstruct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="char_decorator_terminal.html#idm45711348038704-bb"><span class="identifier">char_decorator_terminal</span></a><span class="special">(</span><span class="identifier">subactor_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">impl_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40   <a class="link" href="char_decorator_terminal.html#idm45711348036608-bb"><span class="identifier">char_decorator_terminal</span></a><span class="special">(</span><a class="link" href="char_decorator_terminal.html" title="Class template char_decorator_terminal">char_decorator_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  41   <a class="link" href="char_decorator_terminal.html#idm45711348034928-bb"><span class="identifier">char_decorator_terminal</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="char_decorator_terminal.html#idm45711348049520-bb">public member functions</a></span>
  44   <span class="identifier">subactor_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="char_decorator_terminal.html#idm45711348048960-bb"><span class="identifier">get_subactor</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45   <span class="identifier">impl_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="char_decorator_terminal.html#idm45711348046848-bb"><span class="identifier">get_impl</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="char_decorator_terminal.html#idm45711348044736-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="char_decorator_terminal.html#idm45711348041936-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idm45554746938704"></a><h2>Description</h2>
  51 <p>Character decorator terminal class. This formatter allows to modify strings generated by other formatters on character level. The most obvious application of decorators is replacing a certain set of characters with decorated equivalents to satisfy requirements of text-based sinks.</p>
  52 <p>The <code class="computeroutput"><a class="link" href="char_decorator_terminal.html" title="Class template char_decorator_terminal">char_decorator_terminal</a></code> class aggregates the formatter being decorated, and a set of string pairs that are used as decorations. All decorations are applied sequentially. The <code class="computeroutput"><a class="link" href="char_decorator_terminal.html" title="Class template char_decorator_terminal">char_decorator_terminal</a></code> class is a formatter itself, so it can be used to construct more complex formatters, including nesting decorators. </p>
  53 <div class="refsect2">
  54 <a name="idm45554746934560"></a><h3>
  55 <a name="boost.log.expressions.char_decorator_terminalconstruct-copy-destruct"></a><code class="computeroutput">char_decorator_terminal</code>
  56         public
  57        construct/copy/destruct</h3>
  58 <div class="orderedlist"><ol class="orderedlist" type="1">
  59 <li class="listitem">
  60 <pre class="literallayout"><a name="idm45711348038704-bb"></a><span class="identifier">char_decorator_terminal</span><span class="special">(</span><span class="identifier">subactor_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> sub<span class="special">,</span> <span class="identifier">impl_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> impl<span class="special">)</span><span class="special">;</span></pre>
  61 <p>Initializing constructor. </p>
  62 </li>
  63 <li class="listitem">
  64 <pre class="literallayout"><a name="idm45711348036608-bb"></a><span class="identifier">char_decorator_terminal</span><span class="special">(</span><a class="link" href="char_decorator_terminal.html" title="Class template char_decorator_terminal">char_decorator_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>
  65 <p>Copy constructor </p>
  66 </li>
  67 <li class="listitem"><pre class="literallayout"><a name="idm45711348034928-bb"></a><span class="identifier">char_decorator_terminal</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  68 </ol></div>
  69 </div>
  70 <div class="refsect2">
  71 <a name="idm45554746912336"></a><h3>
  72 <a name="idm45711348049520-bb"></a><code class="computeroutput">char_decorator_terminal</code> public member functions</h3>
  73 <div class="orderedlist"><ol class="orderedlist" type="1">
  74 <li class="listitem">
  75 <pre class="literallayout"><span class="identifier">subactor_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45711348048960-bb"></a><span class="identifier">get_subactor</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  76 <p>
  77 </p>
  78 <div class="variablelist"><table border="0" class="variablelist compact">
  79 <colgroup>
  80 <col align="left" valign="top">
  81 <col>
  82 </colgroup>
  83 <tbody><tr>
  84 <td><p><span class="term">Returns:</span></p></td>
  85 <td><p>Adopted subactor </p></td>
  86 </tr></tbody>
  87 </table></div>
  88 </li>
  89 <li class="listitem">
  90 <pre class="literallayout"><span class="identifier">impl_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45711348046848-bb"></a><span class="identifier">get_impl</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
  91 <p>
  92 </p>
  93 <div class="variablelist"><table border="0" class="variablelist compact">
  94 <colgroup>
  95 <col align="left" valign="top">
  96 <col>
  97 </colgroup>
  98 <tbody><tr>
  99 <td><p><span class="term">Returns:</span></p></td>
 100 <td><p>Implementation </p></td>
 101 </tr></tbody>
 102 </table></div>
 103 </li>
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idm45711348044736-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span><span class="special">;</span></pre>
 106 <p>Invokation operator </p>
 107 </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idm45711348041936-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 110 <p>Invokation operator </p>
 111 </li>
 112 </ol></div>
 113 </div>
 114 </div>
 115 </div>
 116 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 117 <td align="left"></td>
 118 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
 119         Distributed under the Boost Software License, Version 1.0. (See accompanying
 120         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>).
 121       </p>
 122 </div></td>
 123 </tr></table>
 124 <hr>
 125 <div class="spirit-nav">
 126 <a accesskey="p" href="char_decorator_actor.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.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 127 </div>
 128 </body>
 129 </html>