blob: b16a8d49bae8b95340157ebd801a49f2d23b0db3 [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>XalanBitmap.hpp</h1> </div>
</div>
<div class="contents">
<a href="XalanBitmap_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(XALANBITMAP_HEADER_GUARD_1357924680)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALANBITMAP_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 &lt;<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>&gt;</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 &lt;<a class="code" href="XalanVector_8hpp.html">xalanc/Include/XalanVector.hpp</a>&gt;</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00032"></a>00032 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035
<a name="l00036"></a><a class="code" href="classXalanBitmap.html">00036</a> <span class="keyword">class </span><a class="code" href="PlatformSupportDefinitions_8hpp.html#a72e8d5d428f0210697564ce111006fde">XALAN_PLATFORMSUPPORT_EXPORT</a> <a class="code" href="classXalanBitmap.html">XalanBitmap</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">public</span>:
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// The basic storage unit for the bitmaps.</span>
<a name="l00041"></a><a class="code" href="classXalanBitmap.html#a9a76cbe5f9dba0f6802b6af438cbaa26">00041</a> <span class="keyword">typedef</span> <span class="keywordtype">char</span> UnitType;
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="comment">// A handy typedef...</span>
<a name="l00044"></a><a class="code" href="classXalanBitmap.html#aa33c28a0203d5a0c87910b0c26eb9206">00044</a> <span class="keyword">typedef</span> <span class="keywordtype">size_t</span> size_type;
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="comment">// Really all we&#39;re assuming is that a char is at least</span>
<a name="l00047"></a>00047 <span class="comment">// 8 bits. If it&#39;s more, then we&#39;ll just waste some</span>
<a name="l00048"></a>00048 <span class="comment">// space. This may need to be adjusted for various</span>
<a name="l00049"></a>00049 <span class="comment">// platforms, or perhaps change to using an integral of</span>
<a name="l00050"></a>00050 <span class="comment">// a known size, so that we don&#39;t waste any space.</span>
<a name="l00051"></a><a class="code" href="classXalanBitmap.html#a64d4da536b44179c0479a49e439c4b6aad6eaa383f28d9c77c9b5e5fb22c1f5ba">00051</a> <span class="keyword">enum</span> { eBitsPerUnit = 8 };
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment"> /**</span>
<a name="l00055"></a>00055 <span class="comment"> * Construct an instance with room for the specified number</span>
<a name="l00056"></a>00056 <span class="comment"> * of bits.</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * @param theSize The number of bits in the map.</span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a>00060 <a class="code" href="classXalanBitmap.html">XalanBitmap</a>(MemoryManager&amp; theManager, <a class="code" href="XalanMap_8hpp.html#a39efc23c4f36ef6389e4a1fbe96c5f2e">size_type</a> theSize);
<a name="l00061"></a>00061
<a name="l00062"></a>00062 ~<a class="code" href="classXalanBitmap.html">XalanBitmap</a>();
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /**</span>
<a name="l00066"></a>00066 <span class="comment"> * Determine if a bit is set.</span>
<a name="l00067"></a>00067 <span class="comment"> *</span>
<a name="l00068"></a>00068 <span class="comment"> * @param theBit The number of the bit to check.</span>
<a name="l00069"></a>00069 <span class="comment"> * @return true if the bit is set, false if not.</span>
<a name="l00070"></a>00070 <span class="comment"> */</span>
<a name="l00071"></a>00071 <span class="keywordtype">bool</span>
<a name="l00072"></a><a class="code" href="classXalanBitmap.html#a2af082fd05e0b15fe43fb2ca6d90295e">00072</a> isSet(<a class="code" href="classXalanBitmap.html#aa33c28a0203d5a0c87910b0c26eb9206">size_type</a> theBit)<span class="keyword"> const</span>
<a name="l00073"></a>00073 <span class="keyword"> </span>{
<a name="l00074"></a>00074 assert(theBit &gt;= m_size);
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordflow">return</span> m_bitmap[theBit / eBitsPerUnit] &amp; s_setMasks[theBit % eBitsPerUnit] ? <span class="keyword">true</span> : <span class="keyword">false</span>;
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment"> /**</span>
<a name="l00080"></a>00080 <span class="comment"> * Set a bit.</span>
<a name="l00081"></a>00081 <span class="comment"> *</span>
<a name="l00082"></a>00082 <span class="comment"> * @param theBit The number of the bit to set.</span>
<a name="l00083"></a>00083 <span class="comment"> */</span>
<a name="l00084"></a>00084 <span class="keywordtype">void</span>
<a name="l00085"></a><a class="code" href="classXalanBitmap.html#a1cb38ebef6ab025c8ceb359cc4f677db">00085</a> <span class="keyword">set</span>(<a class="code" href="classXalanBitmap.html#aa33c28a0203d5a0c87910b0c26eb9206">size_type</a> theBit)
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087 assert(theBit &lt; m_size);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 m_bitmap[theBit / eBitsPerUnit] |= s_setMasks[theBit % eBitsPerUnit];
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /**</span>
<a name="l00093"></a>00093 <span class="comment"> * Clear a bit.</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * @param theBit The number of the bit to clear.</span>
<a name="l00096"></a>00096 <span class="comment"> */</span>
<a name="l00097"></a>00097 <span class="keywordtype">void</span>
<a name="l00098"></a><a class="code" href="classXalanBitmap.html#ac1dd954c8d3b28977f714c3d2759c173">00098</a> <a class="code" href="DOMStringHelper_8hpp.html#a3beaa7474ee8377a7de5fe4eceddcc94" title="Remove all elements from target string.">clear</a>(<a class="code" href="classXalanBitmap.html#aa33c28a0203d5a0c87910b0c26eb9206">size_type</a> theBit)
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 assert(theBit &lt; m_size);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 m_bitmap[theBit / eBitsPerUnit] &amp;= s_clearMasks[theBit % eBitsPerUnit];
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment"> /**</span>
<a name="l00106"></a>00106 <span class="comment"> * Toggle a bit.</span>
<a name="l00107"></a>00107 <span class="comment"> *</span>
<a name="l00108"></a>00108 <span class="comment"> * @param theBit The number of the bit to toggle.</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a>00110 <span class="keywordtype">void</span>
<a name="l00111"></a><a class="code" href="classXalanBitmap.html#ab3a1426a785b8aab2fbb27d69f1025fa">00111</a> toggle(<a class="code" href="classXalanBitmap.html#aa33c28a0203d5a0c87910b0c26eb9206">size_type</a> theBit)
<a name="l00112"></a>00112 {
<a name="l00113"></a>00113 assert(theBit &lt; m_size);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 m_bitmap[theBit / eBitsPerUnit] ^= s_setMasks[theBit % eBitsPerUnit];
<a name="l00116"></a>00116 }
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment"> /**</span>
<a name="l00119"></a>00119 <span class="comment"> * Clear all of the bits.</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <span class="keywordtype">void</span>
<a name="l00122"></a>00122 clearAll();
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment"> /**</span>
<a name="l00125"></a>00125 <span class="comment"> * Get the size of the map.</span>
<a name="l00126"></a>00126 <span class="comment"> *</span>
<a name="l00127"></a>00127 <span class="comment"> * @return The number of bits in the map.</span>
<a name="l00128"></a>00128 <span class="comment"> */</span>
<a name="l00129"></a>00129 <a class="code" href="XalanMap_8hpp.html#a39efc23c4f36ef6389e4a1fbe96c5f2e">size_type</a>
<a name="l00130"></a><a class="code" href="classXalanBitmap.html#a2d362b5d85c040d43b44aeac24e86ea8">00130</a> getSize()<span class="keyword"> const</span>
<a name="l00131"></a>00131 <span class="keyword"> </span>{
<a name="l00132"></a>00132 <span class="keywordflow">return</span> m_size;
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">private</span>:
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> s_setMasks[];
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> s_clearMasks[];
<a name="l00140"></a>00140
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">typedef</span> <a class="code" href="classXalanVector.html">XalanVector&lt;UnitType&gt;</a> BitmapVectorType;
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="keyword">const</span> <a class="code" href="XalanMap_8hpp.html#a39efc23c4f36ef6389e4a1fbe96c5f2e">size_type</a> m_size;
<a name="l00145"></a>00145
<a name="l00146"></a>00146 BitmapVectorType m_bitmap;
<a name="l00147"></a>00147 };
<a name="l00148"></a>00148
<a name="l00149"></a>00149
<a name="l00150"></a>00150
<a name="l00151"></a>00151 XALAN_CPP_NAMESPACE_END
<a name="l00152"></a>00152
<a name="l00153"></a>00153
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="preprocessor">#endif // XALANBITMAP_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>