blob: df9e8baf42476d8a336ead41a23f31e09249bfe1 [file] [log] [blame]
<!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"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>XalanIndentWriter.hpp</h1> </div>
</div>
<div class="contents">
<a href="XalanIndentWriter_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<a name="l00003"></a>00003 <span class="comment"> * or more contributor license agreements. See the NOTICE file</span>
<a name="l00004"></a>00004 <span class="comment"> * distributed with this work for additional information</span>
<a name="l00005"></a>00005 <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span>
<a name="l00006"></a>00006 <span class="comment"> * to you under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<a name="l00007"></a>00007 <span class="comment"> * you may not use this file except in compliance with the License.</span>
<a name="l00008"></a>00008 <span class="comment"> * You may obtain a copy of the License at</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00013"></a>00013 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00014"></a>00014 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00015"></a>00015 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00016"></a>00016 <span class="comment"> * limitations under the License.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018 <span class="preprocessor">#if !defined(XALANIDENTWRITER_HEADER_GUARD_1357924680)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALANIDENTWRITER_HEADER_GUARD_1357924680</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment">// Base include file. Must be first.</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;<a class="code" href="XMLSupportDefinitions_8hpp.html">xalanc/XMLSupport/XMLSupportDefinitions.hpp</a>&gt;</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>&gt;</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="FormatterListener_8hpp.html">xalanc/PlatformSupport/FormatterListener.hpp</a>&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;<a class="code" href="Writer_8hpp.html">xalanc/PlatformSupport/Writer.hpp</a>&gt;</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00032"></a>00032
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">template</span>&lt;
<a name="l00035"></a>00035 <span class="keyword">class </span>WhiteSpaceWriter,
<a name="l00036"></a>00036 <span class="keyword">class </span>NewLineWriter&gt;
<a name="l00037"></a><a class="code" href="classXalanIndentWriter.html">00037</a> <span class="keyword">class </span><a class="code" href="classXalanIndentWriter.html">XalanIndentWriter</a>
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">public</span>:
<a name="l00040"></a>00040
<a name="l00041"></a><a class="code" href="classXalanIndentWriter.html#a0081154e6158310a03349fd5868f89c3">00041</a> <span class="keyword">typedef</span> <a class="code" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">FormatterListener::size_type</a> size_type;
<a name="l00042"></a><a class="code" href="classXalanIndentWriter.html#a1e137d2c9055ea5cce11e09ba992b30e">00042</a> <span class="keyword">typedef</span> <a class="code" href="classXalanVector.html">XalanVector&lt;bool&gt;</a> <a class="code" href="classXalanVector.html">BoolStackType</a>;
<a name="l00043"></a><a class="code" href="classXalanIndentWriter.html#af1900a5003c302320c7cdd2d21593e02">00043</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> WhiteSpaceWriter::writer_type writer_type;
<a name="l00044"></a>00044
<a name="l00045"></a><a class="code" href="classXalanIndentWriter.html#adbbe6f1222e7220d5da4b2725aae7d4e">00045</a> <a class="code" href="classXalanIndentWriter.html#adbbe6f1222e7220d5da4b2725aae7d4e">XalanIndentWriter</a>(
<a name="l00046"></a>00046 <a class="code" href="classXalanIndentWriter.html#af1900a5003c302320c7cdd2d21593e02">writer_type</a>&amp; writer,
<a name="l00047"></a>00047 <a class="code" href="classXalanIndentWriter.html#a0081154e6158310a03349fd5868f89c3">size_type</a> ident) :
<a name="l00048"></a>00048 m_whiteSpaceWriter(writer),
<a name="l00049"></a>00049 m_newLineWriter(writer),
<a name="l00050"></a>00050 m_indent(ident),
<a name="l00051"></a>00051 m_currentIndent(0),
<a name="l00052"></a>00052 m_startNewLine(false),
<a name="l00053"></a>00053 m_ispreserve(false),
<a name="l00054"></a>00054 m_isprevtext(false),
<a name="l00055"></a>00055 m_preserves(writer.getMemoryManager(), 5)
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 assert( m_indent != -1);
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059
<a name="l00060"></a><a class="code" href="classXalanIndentWriter.html#ace873302ba00036e8887e0aab3fb4194">00060</a> <a class="code" href="classXalanIndentWriter.html#ace873302ba00036e8887e0aab3fb4194">~XalanIndentWriter</a>()
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 }
<a name="l00063"></a>00063
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordtype">void</span>
<a name="l00066"></a><a class="code" href="classXalanIndentWriter.html#ac941a47d655d7e9915e7490bf9b6d40c">00066</a> <a class="code" href="classXalanIndentWriter.html#ac941a47d655d7e9915e7490bf9b6d40c">setIndent</a>(<a class="code" href="classXalanIndentWriter.html#a0081154e6158310a03349fd5868f89c3">size_type</a> value)
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 m_indent = value;
<a name="l00069"></a>00069 }
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <a class="code" href="classXalanIndentWriter.html#a0081154e6158310a03349fd5868f89c3">size_type</a>
<a name="l00072"></a><a class="code" href="classXalanIndentWriter.html#a8397503966d5a253516cae261ee61b1a">00072</a> <a class="code" href="classXalanIndentWriter.html#a8397503966d5a253516cae261ee61b1a">getIndent</a>()<span class="keyword">const</span>
<a name="l00073"></a>00073 <span class="keyword"> </span>{
<a name="l00074"></a>00074 <span class="keywordflow">return</span> m_indent;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keywordtype">void</span>
<a name="l00078"></a><a class="code" href="classXalanIndentWriter.html#a8ebf2be306ed4d1e04e281e358a50879">00078</a> <a class="code" href="classXalanIndentWriter.html#a8ebf2be306ed4d1e04e281e358a50879">indent</a>()
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080 <span class="keywordflow">if</span>( shouldIndent() )
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="keywordflow">if</span>(m_startNewLine == <span class="keyword">true</span>)
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 m_newLineWriter();
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086
<a name="l00087"></a>00087 m_whiteSpaceWriter(m_currentIndent);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 }
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="keywordtype">void</span>
<a name="l00093"></a><a class="code" href="classXalanIndentWriter.html#ad41894364d977c73b97dfeb3c38af761">00093</a> <a class="code" href="classXalanIndentWriter.html#ad41894364d977c73b97dfeb3c38af761">increaseIndent</a>()
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 m_currentIndent += m_indent;
<a name="l00096"></a>00096 }
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keywordtype">void</span>
<a name="l00099"></a><a class="code" href="classXalanIndentWriter.html#adc12bcb9a9b7200c4518158eae86f5bf">00099</a> <a class="code" href="classXalanIndentWriter.html#adc12bcb9a9b7200c4518158eae86f5bf">decreaseIndent</a>()
<a name="l00100"></a>00100 {
<a name="l00101"></a>00101 assert( m_currentIndent &gt;= m_indent);
<a name="l00102"></a>00102
<a name="l00103"></a>00103 m_currentIndent -= m_indent;
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keywordtype">void</span>
<a name="l00107"></a><a class="code" href="classXalanIndentWriter.html#a4a0428765bcf0425023a8e1d5b9a3baa">00107</a> <a class="code" href="classXalanIndentWriter.html#a4a0428765bcf0425023a8e1d5b9a3baa">setStartNewLine</a>(<span class="keywordtype">bool</span> value)
<a name="l00108"></a>00108 {
<a name="l00109"></a>00109 m_startNewLine = value;
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment"> /**</span>
<a name="l00113"></a>00113 <span class="comment"> * Output a line break.</span>
<a name="l00114"></a>00114 <span class="comment"> */</span>
<a name="l00115"></a>00115 <span class="keywordtype">void</span>
<a name="l00116"></a><a class="code" href="classXalanIndentWriter.html#ab51f5f754fe8efe056190f0b291f90fa">00116</a> <a class="code" href="classXalanIndentWriter.html#ab51f5f754fe8efe056190f0b291f90fa" title="Output a line break.">outputLineSep</a>()
<a name="l00117"></a>00117 {
<a name="l00118"></a>00118 m_newLineWriter();
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keywordtype">void</span>
<a name="l00122"></a><a class="code" href="classXalanIndentWriter.html#a5ea73e7b666b656de3fa6cf958d6d754">00122</a> <a class="code" href="classXalanIndentWriter.html#a5ea73e7b666b656de3fa6cf958d6d754">setPrevText</a>(<span class="keywordtype">bool</span> value)
<a name="l00123"></a>00123 {
<a name="l00124"></a>00124 m_isprevtext = value;
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keywordtype">void</span>
<a name="l00128"></a><a class="code" href="classXalanIndentWriter.html#a41feac340f763c337b774968b586b5e2">00128</a> <a class="code" href="classXalanIndentWriter.html#a41feac340f763c337b774968b586b5e2">setPreserve</a>(<span class="keywordtype">bool</span> value)
<a name="l00129"></a>00129 {
<a name="l00130"></a>00130 m_ispreserve = value;
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keywordtype">void</span>
<a name="l00134"></a><a class="code" href="classXalanIndentWriter.html#a5701a6726425d564717445090040aa82">00134</a> <a class="code" href="classXalanIndentWriter.html#a5701a6726425d564717445090040aa82">pop_preserve</a>()
<a name="l00135"></a>00135 {
<a name="l00136"></a>00136 <span class="keywordflow">if</span> ( m_preserves.<a class="code" href="classXalanVector.html#acb9782f665511a451632660341d2e2bf">empty</a>() )
<a name="l00137"></a>00137 {
<a name="l00138"></a>00138 m_ispreserve = <span class="keyword">false</span>;
<a name="l00139"></a>00139 }
<a name="l00140"></a>00140 <span class="keywordflow">else</span>
<a name="l00141"></a>00141 {
<a name="l00142"></a>00142 m_ispreserve = m_preserves.<a class="code" href="classXalanVector.html#a44dc3df7e89dd85b05c696eed6b8ec88">back</a>();
<a name="l00143"></a>00143
<a name="l00144"></a>00144 m_preserves.<a class="code" href="classXalanVector.html#af4dc80970e1a9d9488468da7f4aabb68">pop_back</a>();
<a name="l00145"></a>00145 }
<a name="l00146"></a>00146 }
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="keywordtype">void</span>
<a name="l00149"></a><a class="code" href="classXalanIndentWriter.html#a1a8eb538c1f211ca7f78562d17dce1da">00149</a> <a class="code" href="classXalanIndentWriter.html#a1a8eb538c1f211ca7f78562d17dce1da">push_preserve</a>()
<a name="l00150"></a>00150 {
<a name="l00151"></a>00151 m_preserves.<a class="code" href="classXalanVector.html#ac0ad2b04516dcca6ce35b3425368307b">push_back</a>(m_ispreserve);
<a name="l00152"></a>00152 }
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="keyword">private</span>:
<a name="l00155"></a>00155 <span class="keywordtype">bool</span>
<a name="l00156"></a>00156 shouldIndent()<span class="keyword"> const</span>
<a name="l00157"></a>00157 <span class="keyword"> </span>{
<a name="l00158"></a>00158 <span class="keywordflow">return</span> (!m_ispreserve &amp;&amp; !m_isprevtext);
<a name="l00159"></a>00159 <span class="comment">// return true;</span>
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="keyword">private</span>:
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="comment">//data members</span>
<a name="l00165"></a>00165
<a name="l00166"></a>00166 WhiteSpaceWriter m_whiteSpaceWriter;
<a name="l00167"></a>00167
<a name="l00168"></a>00168 NewLineWriter m_newLineWriter;
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment"> /**</span>
<a name="l00171"></a>00171 <span class="comment"> * Amount to indent.</span>
<a name="l00172"></a>00172 <span class="comment"> */</span>
<a name="l00173"></a>00173 <a class="code" href="classXalanIndentWriter.html#a0081154e6158310a03349fd5868f89c3">size_type</a> m_indent;
<a name="l00174"></a>00174 <span class="comment"></span>
<a name="l00175"></a>00175 <span class="comment"> /**</span>
<a name="l00176"></a>00176 <span class="comment"> * Flag to keep track of the indent amount.</span>
<a name="l00177"></a>00177 <span class="comment"> */</span>
<a name="l00178"></a>00178 <a class="code" href="classXalanIndentWriter.html#a0081154e6158310a03349fd5868f89c3">size_type</a> m_currentIndent;
<a name="l00179"></a>00179 <span class="comment"></span>
<a name="l00180"></a>00180 <span class="comment"> /**</span>
<a name="l00181"></a>00181 <span class="comment"> * Flag to signal that a newline should be added.</span>
<a name="l00182"></a>00182 <span class="comment"> */</span>
<a name="l00183"></a>00183 <span class="keywordtype">bool</span> m_startNewLine;
<a name="l00184"></a>00184 <span class="comment"></span>
<a name="l00185"></a>00185 <span class="comment"> /**</span>
<a name="l00186"></a>00186 <span class="comment"> * State flag to tell if preservation of whitespace </span>
<a name="l00187"></a>00187 <span class="comment"> * is important.</span>
<a name="l00188"></a>00188 <span class="comment"> */</span>
<a name="l00189"></a>00189 <span class="keywordtype">bool</span> m_ispreserve;
<a name="l00190"></a>00190 <span class="comment"></span>
<a name="l00191"></a>00191 <span class="comment"> /**</span>
<a name="l00192"></a>00192 <span class="comment"> * State flag that tells if the previous node processed </span>
<a name="l00193"></a>00193 <span class="comment"> * was text, so we can tell if we should preserve whitespace.</span>
<a name="l00194"></a>00194 <span class="comment"> */</span>
<a name="l00195"></a>00195 <span class="keywordtype">bool</span> m_isprevtext;
<a name="l00196"></a>00196 <span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment"> /**</span>
<a name="l00198"></a>00198 <span class="comment"> * Stack to keep track of whether or not we need to </span>
<a name="l00199"></a>00199 <span class="comment"> * preserve whitespace.</span>
<a name="l00200"></a>00200 <span class="comment"> */</span>
<a name="l00201"></a>00201 <a class="code" href="classXalanIndentWriter.html#a1e137d2c9055ea5cce11e09ba992b30e">BoolStackType</a> m_preserves;
<a name="l00202"></a>00202 };
<a name="l00203"></a>00203
<a name="l00204"></a>00204 XALAN_CPP_NAMESPACE_END
<a name="l00205"></a>00205
<a name="l00206"></a>00206
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="preprocessor">#endif // XALANIDENTWRITER_HEADER_GUARD_1357924680</span>
</pre></div></div>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>