<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>log4shib: PatternLayout.hh Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">log4shib
 <span id="projectnumber">1.0.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1eb1cafafd84a09ddbe9fda5c5189f10.html">log4shib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">PatternLayout.hh</div> </div>
</div><!--header-->
<div class="contents">
<a href="PatternLayout_8hh.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * PatternLayout.hh</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright 2002, Bastiaan Bakker. All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * See the COPYING file for the terms of usage and distribution.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef _LOG4SHIB_PATTERNLAYOUT_HH</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span><span class="preprocessor">#define _LOG4SHIB_PATTERNLAYOUT_HH</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <<a class="code" href="Portability_8hh.html">log4shib/Portability.hh</a>></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <<a class="code" href="Layout_8hh.html">log4shib/Layout.hh</a>></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <<a class="code" href="Configurator_8hh.html">log4shib/Configurator.hh</a>></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifdef LOG4SHIB_HAVE_SSTREAM</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span><span class="preprocessor">#include <sstream></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>log4shib {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classlog4shib_1_1PatternLayout.html"> 25</a></span>  <span class="keyword">class </span><a class="code" href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a> <a class="code" href="classlog4shib_1_1PatternLayout.html">PatternLayout</a> : <span class="keyword">public</span> <a class="code" href="classlog4shib_1_1Layout.html">Layout</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classlog4shib_1_1PatternLayout.html#a3fd23581d942074e625b9f4629b84efa"> 30</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classlog4shib_1_1PatternLayout.html#a3fd23581d942074e625b9f4629b84efa">DEFAULT_CONVERSION_PATTERN</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classlog4shib_1_1PatternLayout.html#a4097e716bda9125820ab2619fdabc2fc"> 35</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classlog4shib_1_1PatternLayout.html#a4097e716bda9125820ab2619fdabc2fc">SIMPLE_CONVERSION_PATTERN</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classlog4shib_1_1PatternLayout.html#a54137fa016cdd2be7ba7a7f1e6716661"> 40</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classlog4shib_1_1PatternLayout.html#a54137fa016cdd2be7ba7a7f1e6716661">BASIC_CONVERSION_PATTERN</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classlog4shib_1_1PatternLayout.html#ae1e083c03410ccacdd884e58d9321ad1"> 46</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classlog4shib_1_1PatternLayout.html#ae1e083c03410ccacdd884e58d9321ad1">TTCC_CONVERSION_PATTERN</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classlog4shib_1_1PatternLayout.html">PatternLayout</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">virtual</span> ~<a class="code" href="classlog4shib_1_1PatternLayout.html">PatternLayout</a>();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// NOTE: All double percentage signs ('%%') followed by a character</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// in the following comments should actually be a single char.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// The doubles are included so that doxygen will print them correctly.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> <span class="keyword">virtual</span> std::string format(<span class="keyword">const</span> <a class="code" href="structlog4shib_1_1LoggingEvent.html">LoggingEvent</a>& event);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> setConversionPattern(<span class="keyword">const</span> std::string& conversionPattern)</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">throw</span>(<a class="code" href="classlog4shib_1_1ConfigureFailure.html">ConfigureFailure</a>);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">virtual</span> std::string getConversionPattern() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> clearConversionPattern();</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classlog4shib_1_1PatternLayout_1_1PatternComponent.html"> 91</a></span>  <span class="keyword">class </span><a class="code" href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a> <a class="code" href="classlog4shib_1_1PatternLayout_1_1PatternComponent.html">PatternComponent</a> {</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classlog4shib_1_1PatternLayout_1_1PatternComponent.html#a1ed1d0f2f22cf000bd87e3c411150360"> 93</a></span>  <span class="keyword">inline</span> <span class="keyword">virtual</span> <a class="code" href="classlog4shib_1_1PatternLayout_1_1PatternComponent.html#a1ed1d0f2f22cf000bd87e3c411150360">~PatternComponent</a>() {};</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> append(<a class="code" href="classstd_1_1ostringstream.html">std::ostringstream</a>& out, <span class="keyword">const</span> <a class="code" href="structlog4shib_1_1LoggingEvent.html">LoggingEvent</a>& event) = 0;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  };</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">typedef</span> std::vector<PatternComponent*> ComponentVector; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  ComponentVector _components;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  std::string _conversionPattern;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif // _LOG4SHIB_PATTERNLAYOUT_HH</span></div>
<div class="ttc" id="Configurator_8hh_html"><div class="ttname"><a href="Configurator_8hh.html">Configurator.hh</a></div></div>
<div class="ttc" id="structlog4shib_1_1LoggingEvent_html"><div class="ttname"><a href="structlog4shib_1_1LoggingEvent.html">log4shib::LoggingEvent</a></div><div class="ttdoc">The internal representation of logging events. </div><div class="ttdef"><b>Definition:</b> LoggingEvent.hh:32</div></div>
<div class="ttc" id="Layout_8hh_html"><div class="ttname"><a href="Layout_8hh.html">Layout.hh</a></div></div>
<div class="ttc" id="classlog4shib_1_1PatternLayout_html_a4097e716bda9125820ab2619fdabc2fc"><div class="ttname"><a href="classlog4shib_1_1PatternLayout.html#a4097e716bda9125820ab2619fdabc2fc">log4shib::PatternLayout::SIMPLE_CONVERSION_PATTERN</a></div><div class="ttdeci">static const char * SIMPLE_CONVERSION_PATTERN</div><div class="ttdoc">A conversion pattern equivalent to the SimpleLayout. </div><div class="ttdef"><b>Definition:</b> PatternLayout.hh:35</div></div>
<div class="ttc" id="classlog4shib_1_1PatternLayout_html_ae1e083c03410ccacdd884e58d9321ad1"><div class="ttname"><a href="classlog4shib_1_1PatternLayout.html#ae1e083c03410ccacdd884e58d9321ad1">log4shib::PatternLayout::TTCC_CONVERSION_PATTERN</a></div><div class="ttdeci">static const char * TTCC_CONVERSION_PATTERN</div><div class="ttdoc">A conversion pattern equivalent to the TTCCLayout. </div><div class="ttdef"><b>Definition:</b> PatternLayout.hh:46</div></div>
<div class="ttc" id="classlog4shib_1_1PatternLayout_1_1PatternComponent_html_a1ed1d0f2f22cf000bd87e3c411150360"><div class="ttname"><a href="classlog4shib_1_1PatternLayout_1_1PatternComponent.html#a1ed1d0f2f22cf000bd87e3c411150360">log4shib::PatternLayout::PatternComponent::~PatternComponent</a></div><div class="ttdeci">virtual ~PatternComponent()</div><div class="ttdef"><b>Definition:</b> PatternLayout.hh:93</div></div>
<div class="ttc" id="Portability_8hh_html"><div class="ttname"><a href="Portability_8hh.html">Portability.hh</a></div></div>
<div class="ttc" id="Export_8hh_html_aa6b9f4ade013cd7ea2ec951901330156"><div class="ttname"><a href="Export_8hh.html#aa6b9f4ade013cd7ea2ec951901330156">LOG4SHIB_EXPORT</a></div><div class="ttdeci">#define LOG4SHIB_EXPORT</div><div class="ttdef"><b>Definition:</b> Export.hh:11</div></div>
<div class="ttc" id="classlog4shib_1_1PatternLayout_html"><div class="ttname"><a href="classlog4shib_1_1PatternLayout.html">log4shib::PatternLayout</a></div><div class="ttdoc">PatternLayout is a simple fixed format Layout implementation. </div><div class="ttdef"><b>Definition:</b> PatternLayout.hh:25</div></div>
<div class="ttc" id="classlog4shib_1_1PatternLayout_html_a3fd23581d942074e625b9f4629b84efa"><div class="ttname"><a href="classlog4shib_1_1PatternLayout.html#a3fd23581d942074e625b9f4629b84efa">log4shib::PatternLayout::DEFAULT_CONVERSION_PATTERN</a></div><div class="ttdeci">static const char * DEFAULT_CONVERSION_PATTERN</div><div class="ttdoc">The default conversion pattern. </div><div class="ttdef"><b>Definition:</b> PatternLayout.hh:30</div></div>
<div class="ttc" id="classlog4shib_1_1Layout_html"><div class="ttname"><a href="classlog4shib_1_1Layout.html">log4shib::Layout</a></div><div class="ttdoc">Extend this abstract class to create your own log layout format. </div><div class="ttdef"><b>Definition:</b> Layout.hh:22</div></div>
<div class="ttc" id="classlog4shib_1_1PatternLayout_html_a54137fa016cdd2be7ba7a7f1e6716661"><div class="ttname"><a href="classlog4shib_1_1PatternLayout.html#a54137fa016cdd2be7ba7a7f1e6716661">log4shib::PatternLayout::BASIC_CONVERSION_PATTERN</a></div><div class="ttdeci">static const char * BASIC_CONVERSION_PATTERN</div><div class="ttdoc">A conversion pattern equivalent to the BasicLayout. </div><div class="ttdef"><b>Definition:</b> PatternLayout.hh:40</div></div>
<div class="ttc" id="classlog4shib_1_1ConfigureFailure_html"><div class="ttname"><a href="classlog4shib_1_1ConfigureFailure.html">log4shib::ConfigureFailure</a></div><div class="ttdoc">Exception class for configuration. </div><div class="ttdef"><b>Definition:</b> Configurator.hh:26</div></div>
<div class="ttc" id="classstd_1_1ostringstream_html"><div class="ttname"><a href="classstd_1_1ostringstream.html">std::ostringstream</a></div><div class="ttdef"><b>Definition:</b> Portability.hh:38</div></div>
<div class="ttc" id="classlog4shib_1_1PatternLayout_1_1PatternComponent_html"><div class="ttname"><a href="classlog4shib_1_1PatternLayout_1_1PatternComponent.html">log4shib::PatternLayout::PatternComponent</a></div><div class="ttdef"><b>Definition:</b> PatternLayout.hh:91</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 19 2013 07:04:31 for log4shib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
