| <!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 Page</span></a></li> |
| <li><a href="pages.html"><span>Related 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 List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <div class="header"> |
| <div class="headertitle"> |
| <h1>XalanDOMStringPool.hpp</h1> </div> |
| </div> |
| <div class="contents"> |
| <a href="XalanDOMStringPool_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 "License");</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 "AS IS" 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(XALANDOMSTRINGPOOL_HEADER_GUARD_1357924680)</span> |
| <a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALANDOMSTRINGPOOL_HEADER_GUARD_1357924680</span> |
| <a name="l00020"></a>00020 <span class="preprocessor"></span> |
| <a name="l00021"></a>00021 |
| <a name="l00022"></a>00022 |
| <a name="l00023"></a>00023 <span class="comment">// Base include file. Must be first.</span> |
| <a name="l00024"></a>00024 <span class="preprocessor">#include <<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>></span> |
| <a name="l00025"></a>00025 |
| <a name="l00026"></a>00026 |
| <a name="l00027"></a>00027 |
| <a name="l00028"></a>00028 <span class="preprocessor">#include <<a class="code" href="ArenaAllocator_8hpp.html">xalanc/PlatformSupport/ArenaAllocator.hpp</a>></span> |
| <a name="l00029"></a>00029 <span class="preprocessor">#include <<a class="code" href="DOMStringHelper_8hpp.html">xalanc/PlatformSupport/DOMStringHelper.hpp</a>></span> |
| <a name="l00030"></a>00030 <span class="preprocessor">#include <<a class="code" href="XalanDOMStringAllocator_8hpp.html">xalanc/PlatformSupport/XalanDOMStringAllocator.hpp</a>></span> |
| <a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="XalanDOMStringHashTable_8hpp.html">xalanc/PlatformSupport/XalanDOMStringHashTable.hpp</a>></span> |
| <a name="l00032"></a>00032 |
| <a name="l00033"></a>00033 |
| <a name="l00034"></a>00034 |
| <a name="l00035"></a>00035 XALAN_CPP_NAMESPACE_BEGIN |
| <a name="l00036"></a>00036 |
| <a name="l00037"></a>00037 |
| <a name="l00038"></a>00038 |
| <a name="l00039"></a><a class="code" href="classXalanDOMStringPool.html">00039</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a> |
| <a name="l00040"></a>00040 { |
| <a name="l00041"></a>00041 <span class="keyword">public</span>: |
| <a name="l00042"></a>00042 |
| <a name="l00043"></a><a class="code" href="classXalanDOMStringPool.html#ac00e36b789d42b23542924a315d2c77ba4af8a3cd3aa7783b4100781258e72635">00043</a> <span class="keyword">enum</span> { eDefaultBlockSize = 32, |
| <a name="l00044"></a><a class="code" href="classXalanDOMStringPool.html#ac00e36b789d42b23542924a315d2c77ba68f5d87ee9da075157abb247966c075a">00044</a> eDefaultBucketCount = XalanDOMStringHashTable::eDefaultBucketCount, |
| <a name="l00045"></a><a class="code" href="classXalanDOMStringPool.html#ac00e36b789d42b23542924a315d2c77ba9e5234b089fc6035d984fe054fb9fa9d">00045</a> eDefaultBucketSize = <a class="code" href="classXalanDOMStringHashTable.html#a1501ea8ec372e342a7d9d2bd0688c40ba2f743fcc3c448c82be82516310b3514b">XalanDOMStringHashTable::eDefaultBucketSize</a> }; |
| <a name="l00046"></a>00046 |
| <a name="l00047"></a><a class="code" href="classXalanDOMStringPool.html#ab5808f88a3070491e5e686d79bfb6654">00047</a> <span class="keyword">typedef</span> <a class="code" href="classXalanDOMStringAllocator.html">XalanDOMStringAllocator</a> <a class="code" href="classXalanDOMStringAllocator.html">AllocatorType</a>; |
| <a name="l00048"></a>00048 |
| <a name="l00049"></a><a class="code" href="classXalanDOMStringPool.html#a47543bcbd1729605b90bec5a9bb75af7">00049</a> <span class="keyword">typedef</span> <a class="code" href="classXalanDOMStringAllocator.html#a9e22d92647c1b90f1ee86626617f77f8">AllocatorType::size_type</a> block_size_type; |
| <a name="l00050"></a><a class="code" href="classXalanDOMStringPool.html#ada0cdbb3f14287c9026992d46d805b44">00050</a> <span class="keyword">typedef</span> <span class="keywordtype">size_t</span> bucket_count_type; |
| <a name="l00051"></a><a class="code" href="classXalanDOMStringPool.html#a0de44c028785e0f78f07417d74445e9b">00051</a> <span class="keyword">typedef</span> <a class="code" href="classXalanDOMStringHashTable.html#a88fa0c7cb3137de720a23fa55ff671f4">XalanDOMStringHashTable::bucket_size_type</a> bucket_size_type; |
| <a name="l00052"></a>00052 <span class="comment"></span> |
| <a name="l00053"></a>00053 <span class="comment"> /**</span> |
| <a name="l00054"></a>00054 <span class="comment"> * Create a string pool.</span> |
| <a name="l00055"></a>00055 <span class="comment"> *</span> |
| <a name="l00056"></a>00056 <span class="comment"> * @param theBlockSize The block size for the allocator.</span> |
| <a name="l00057"></a>00057 <span class="comment"> * @param theBucketCount The number of buckets to use for the hash table. This should be a prime number for best results.</span> |
| <a name="l00058"></a>00058 <span class="comment"> * @param theBucketSize The initial size of each bucket in the hash table.</span> |
| <a name="l00059"></a>00059 <span class="comment"> */</span> |
| <a name="l00060"></a>00060 <span class="keyword">explicit</span> |
| <a name="l00061"></a>00061 <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>( |
| <a name="l00062"></a>00062 MemoryManager& theManager, |
| <a name="l00063"></a>00063 <a class="code" href="classXalanDOMStringPool.html#a47543bcbd1729605b90bec5a9bb75af7">block_size_type</a> theBlockSize = eDefaultBlockSize, |
| <a name="l00064"></a>00064 <a class="code" href="classXalanDOMStringPool.html#ada0cdbb3f14287c9026992d46d805b44">bucket_count_type</a> theBucketCount = eDefaultBucketCount, |
| <a name="l00065"></a>00065 <a class="code" href="classXalanDOMStringPool.html#a0de44c028785e0f78f07417d74445e9b">bucket_size_type</a> theBucketSize = eDefaultBucketSize); |
| <a name="l00066"></a>00066 |
| <a name="l00067"></a>00067 <span class="keyword">static</span> <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>* |
| <a name="l00068"></a>00068 create( |
| <a name="l00069"></a>00069 MemoryManager& theManager, |
| <a name="l00070"></a>00070 <a class="code" href="classXalanDOMStringPool.html#a47543bcbd1729605b90bec5a9bb75af7">block_size_type</a> theBlockSize = eDefaultBlockSize, |
| <a name="l00071"></a>00071 <a class="code" href="classXalanDOMStringPool.html#ada0cdbb3f14287c9026992d46d805b44">bucket_count_type</a> theBucketCount = eDefaultBucketCount, |
| <a name="l00072"></a>00072 <a class="code" href="classXalanDOMStringPool.html#a0de44c028785e0f78f07417d74445e9b">bucket_size_type</a> theBucketSize = eDefaultBucketSize); |
| <a name="l00073"></a>00073 |
| <a name="l00074"></a>00074 |
| <a name="l00075"></a>00075 <span class="keyword">virtual</span> |
| <a name="l00076"></a>00076 ~<a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>(); |
| <a name="l00077"></a>00077 <span class="comment"></span> |
| <a name="l00078"></a>00078 <span class="comment"> /**</span> |
| <a name="l00079"></a>00079 <span class="comment"> * Clear the pool.</span> |
| <a name="l00080"></a>00080 <span class="comment"> *</span> |
| <a name="l00081"></a>00081 <span class="comment"> */</span> |
| <a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> |
| <a name="l00083"></a>00083 <a class="code" href="DOMStringHelper_8hpp.html#a3beaa7474ee8377a7de5fe4eceddcc94" title="Remove all elements from target string.">clear</a>(); |
| <a name="l00084"></a>00084 <span class="comment"></span> |
| <a name="l00085"></a>00085 <span class="comment"> /**</span> |
| <a name="l00086"></a>00086 <span class="comment"> * Get the number of strings in the pool</span> |
| <a name="l00087"></a>00087 <span class="comment"> *</span> |
| <a name="l00088"></a>00088 <span class="comment"> * @return the size of the pool.</span> |
| <a name="l00089"></a>00089 <span class="comment"> */</span> |
| <a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> |
| <a name="l00091"></a>00091 size() <span class="keyword">const</span>; |
| <a name="l00092"></a>00092 <span class="comment"></span> |
| <a name="l00093"></a>00093 <span class="comment"> /**</span> |
| <a name="l00094"></a>00094 <span class="comment"> * Get a pooled string. If the string is not pooled, it is added.</span> |
| <a name="l00095"></a>00095 <span class="comment"> *</span> |
| <a name="l00096"></a>00096 <span class="comment"> * @param theString The string to pool.</span> |
| <a name="l00097"></a>00097 <span class="comment"> * @return a const reference to the pooled string.</span> |
| <a name="l00098"></a>00098 <span class="comment"> */</span> |
| <a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& |
| <a name="l00100"></a>00100 <span class="keyword">get</span>(<span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& theString); |
| <a name="l00101"></a>00101 <span class="comment"></span> |
| <a name="l00102"></a>00102 <span class="comment"> /**</span> |
| <a name="l00103"></a>00103 <span class="comment"> * Get a pooled string. If the string is not pooled, it is added.</span> |
| <a name="l00104"></a>00104 <span class="comment"> *</span> |
| <a name="l00105"></a>00105 <span class="comment"> * @param theString The string to pool.</span> |
| <a name="l00106"></a>00106 <span class="comment"> * @param theLength The length of the string. If XalanDOMString::npos, the string is assumed to be null-terminated.</span> |
| <a name="l00107"></a>00107 <span class="comment"> * @return a const reference to the pooled string.</span> |
| <a name="l00108"></a>00108 <span class="comment"> */</span> |
| <a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>& |
| <a name="l00110"></a>00110 <span class="keyword">get</span>( |
| <a name="l00111"></a>00111 <span class="keyword">const</span> XalanDOMChar* theString, |
| <a name="l00112"></a>00112 <a class="code" href="classXalanDOMString.html#ab8b91a47f3335d6c54c49029dd1074f2">XalanDOMString::size_type</a> theLength = XalanDOMString::npos); |
| <a name="l00113"></a>00113 <span class="comment"></span> |
| <a name="l00114"></a>00114 <span class="comment"> /**</span> |
| <a name="l00115"></a>00115 <span class="comment"> * Get a reference to the pool's hash table. Useful for diagnostic</span> |
| <a name="l00116"></a>00116 <span class="comment"> * purposes.</span> |
| <a name="l00117"></a>00117 <span class="comment"> *</span> |
| <a name="l00118"></a>00118 <span class="comment"> * @return a const reference to the hash table.</span> |
| <a name="l00119"></a>00119 <span class="comment"> */</span> |
| <a name="l00120"></a>00120 <span class="keyword">const</span> <a class="code" href="classXalanDOMStringHashTable.html">XalanDOMStringHashTable</a>& |
| <a name="l00121"></a><a class="code" href="classXalanDOMStringPool.html#a9554cb55b428c678bf55b841f23f3abe">00121</a> getHashTable()<span class="keyword"> const</span> |
| <a name="l00122"></a>00122 <span class="keyword"> </span>{ |
| <a name="l00123"></a>00123 <span class="keywordflow">return</span> m_hashTable; |
| <a name="l00124"></a>00124 } |
| <a name="l00125"></a>00125 |
| <a name="l00126"></a>00126 MemoryManager& |
| <a name="l00127"></a><a class="code" href="classXalanDOMStringPool.html#a8aaddd2926f72019ce4f596488f1cbb3">00127</a> getMemoryManager() |
| <a name="l00128"></a>00128 { |
| <a name="l00129"></a>00129 <span class="keywordflow">return</span> m_hashTable.getMemoryManager(); |
| <a name="l00130"></a>00130 } |
| <a name="l00131"></a>00131 |
| <a name="l00132"></a>00132 <span class="keyword">const</span> MemoryManager& |
| <a name="l00133"></a><a class="code" href="classXalanDOMStringPool.html#ad145a4a863402e6d15fb5e60f7f7c53f">00133</a> getMemoryManager()<span class="keyword"> const</span> |
| <a name="l00134"></a>00134 <span class="keyword"> </span>{ |
| <a name="l00135"></a>00135 <span class="keywordflow">return</span> m_hashTable.getMemoryManager(); |
| <a name="l00136"></a>00136 } |
| <a name="l00137"></a>00137 |
| <a name="l00138"></a>00138 <span class="keyword">private</span>: |
| <a name="l00139"></a>00139 |
| <a name="l00140"></a>00140 <span class="comment">// Not implemented, for now...</span> |
| <a name="l00141"></a>00141 <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>(<span class="keyword">const</span> <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>&); |
| <a name="l00142"></a>00142 |
| <a name="l00143"></a>00143 <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>& |
| <a name="l00144"></a>00144 operator=(<span class="keyword">const</span> <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>&); |
| <a name="l00145"></a>00145 |
| <a name="l00146"></a>00146 <span class="keywordtype">bool</span> |
| <a name="l00147"></a>00147 <a class="code" href="ElemAttributeSet_8hpp.html#ae199bc16afddda1065706543e752d292">operator==</a>(<span class="keyword">const</span> <a class="code" href="classXalanDOMStringPool.html">XalanDOMStringPool</a>&) <span class="keyword">const</span>; |
| <a name="l00148"></a>00148 |
| <a name="l00149"></a>00149 <span class="comment">// Data members...</span> |
| <a name="l00150"></a>00150 AllocatorType m_stringAllocator; |
| <a name="l00151"></a>00151 |
| <a name="l00152"></a>00152 <span class="keywordtype">size_t</span> m_stringCount; |
| <a name="l00153"></a>00153 |
| <a name="l00154"></a>00154 <a class="code" href="classXalanDOMStringHashTable.html">XalanDOMStringHashTable</a> m_hashTable; |
| <a name="l00155"></a>00155 |
| <a name="l00156"></a>00156 <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> s_emptyString; |
| <a name="l00157"></a>00157 }; |
| <a name="l00158"></a>00158 |
| <a name="l00159"></a>00159 |
| <a name="l00160"></a>00160 |
| <a name="l00161"></a>00161 XALAN_CPP_NAMESPACE_END |
| <a name="l00162"></a>00162 |
| <a name="l00163"></a>00163 |
| <a name="l00164"></a>00164 |
| <a name="l00165"></a>00165 <span class="preprocessor">#endif // !defined(XALANDOMSTRINGPOOL_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 © 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> |
