/usr/share/doc/libjuce/apiref/classStringPool.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: StringPool Class Reference</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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classStringPool-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">StringPool Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="classStringPool.html" title="A StringPool holds a set of shared strings, which reduces storage overheads and improves comparison s...">StringPool</a> holds a set of shared strings, which reduces storage overheads and improves comparison speed when dealing with many duplicate strings.
<a href="classStringPool.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aab1fd1101bfe15304bd618b3eeedfc0e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#aab1fd1101bfe15304bd618b3eeedfc0e">StringPool</a> () noexcept</td></tr>
<tr class="memdesc:aab1fd1101bfe15304bd618b3eeedfc0e"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty pool. <a href="#aab1fd1101bfe15304bd618b3eeedfc0e">More...</a><br /></td></tr>
<tr class="separator:aab1fd1101bfe15304bd618b3eeedfc0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a890f0cea498819f637aff75d32e8f0dd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#a890f0cea498819f637aff75d32e8f0dd">~StringPool</a> ()</td></tr>
<tr class="memdesc:a890f0cea498819f637aff75d32e8f0dd"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a890f0cea498819f637aff75d32e8f0dd">More...</a><br /></td></tr>
<tr class="separator:a890f0cea498819f637aff75d32e8f0dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae5ff870a5147dddfc6e983f058c3a17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#aae5ff870a5147dddfc6e983f058c3a17">getPooledString</a> (const <a class="el" href="classString.html">String</a> &original)</td></tr>
<tr class="memdesc:aae5ff870a5147dddfc6e983f058c3a17"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to a shared copy of the string that is passed in. <a href="#aae5ff870a5147dddfc6e983f058c3a17">More...</a><br /></td></tr>
<tr class="separator:aae5ff870a5147dddfc6e983f058c3a17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53e9e1b9c1ad68776fe41f439b0d9d96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#a53e9e1b9c1ad68776fe41f439b0d9d96">getPooledString</a> (const char *original)</td></tr>
<tr class="memdesc:a53e9e1b9c1ad68776fe41f439b0d9d96"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to a copy of the string that is passed in. <a href="#a53e9e1b9c1ad68776fe41f439b0d9d96">More...</a><br /></td></tr>
<tr class="separator:a53e9e1b9c1ad68776fe41f439b0d9d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00c62de7b80b6a9b397b1838a77ed48b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#a00c62de7b80b6a9b397b1838a77ed48b">getPooledString</a> (<a class="el" href="classStringRef.html">StringRef</a> original)</td></tr>
<tr class="memdesc:a00c62de7b80b6a9b397b1838a77ed48b"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to a shared copy of the string that is passed in. <a href="#a00c62de7b80b6a9b397b1838a77ed48b">More...</a><br /></td></tr>
<tr class="separator:a00c62de7b80b6a9b397b1838a77ed48b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f4e16858b5b562196712c6bd7b219c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#a0f4e16858b5b562196712c6bd7b219c3">getPooledString</a> (<a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> start, <a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> end)</td></tr>
<tr class="memdesc:a0f4e16858b5b562196712c6bd7b219c3"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to a copy of the string that is passed in. <a href="#a0f4e16858b5b562196712c6bd7b219c3">More...</a><br /></td></tr>
<tr class="separator:a0f4e16858b5b562196712c6bd7b219c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a304c7b871b037a619af828a1d1300417"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#a304c7b871b037a619af828a1d1300417">garbageCollect</a> ()</td></tr>
<tr class="memdesc:a304c7b871b037a619af828a1d1300417"><td class="mdescLeft"> </td><td class="mdescRight">Scans the pool, and removes any strings that are unreferenced. <a href="#a304c7b871b037a619af828a1d1300417">More...</a><br /></td></tr>
<tr class="separator:a304c7b871b037a619af828a1d1300417"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a3fafb36830141853af13654563225ecb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classStringPool.html">StringPool</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPool.html#a3fafb36830141853af13654563225ecb">getGlobalPool</a> () noexcept</td></tr>
<tr class="memdesc:a3fafb36830141853af13654563225ecb"><td class="mdescLeft"> </td><td class="mdescRight">Returns a shared global pool which is used for things like Identifiers, XML parsing. <a href="#a3fafb36830141853af13654563225ecb">More...</a><br /></td></tr>
<tr class="separator:a3fafb36830141853af13654563225ecb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="classStringPool.html" title="A StringPool holds a set of shared strings, which reduces storage overheads and improves comparison s...">StringPool</a> holds a set of shared strings, which reduces storage overheads and improves comparison speed when dealing with many duplicate strings. </p>
<p>When you add a string to a pool using getPooledString, it'll return a character array containing the same string. This array is owned by the pool, and the same array is returned every time a matching string is asked for. This means that it's trivial to compare two pooled strings for equality, as you can simply compare their pointers. It also cuts down on storage if you're using many copies of the same string. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aab1fd1101bfe15304bd618b3eeedfc0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab1fd1101bfe15304bd618b3eeedfc0e">§ </a></span>StringPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringPool::StringPool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty pool. </p>
</div>
</div>
<a id="a890f0cea498819f637aff75d32e8f0dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a890f0cea498819f637aff75d32e8f0dd">§ </a></span>~StringPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringPool::~StringPool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aae5ff870a5147dddfc6e983f058c3a17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae5ff870a5147dddfc6e983f058c3a17">§ </a></span>getPooledString() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> StringPool::getPooledString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>original</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to a shared copy of the string that is passed in. </p>
<p>The pool will always return the same <a class="el" href="classString.html" title="The JUCE String class! ">String</a> object when asked for a string that matches it. </p>
</div>
</div>
<a id="a53e9e1b9c1ad68776fe41f439b0d9d96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53e9e1b9c1ad68776fe41f439b0d9d96">§ </a></span>getPooledString() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> StringPool::getPooledString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>original</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to a copy of the string that is passed in. </p>
<p>The pool will always return the same <a class="el" href="classString.html" title="The JUCE String class! ">String</a> object when asked for a string that matches it. </p>
</div>
</div>
<a id="a00c62de7b80b6a9b397b1838a77ed48b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00c62de7b80b6a9b397b1838a77ed48b">§ </a></span>getPooledString() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> StringPool::getPooledString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStringRef.html">StringRef</a> </td>
<td class="paramname"><em>original</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to a shared copy of the string that is passed in. </p>
<p>The pool will always return the same <a class="el" href="classString.html" title="The JUCE String class! ">String</a> object when asked for a string that matches it. </p>
</div>
</div>
<a id="a0f4e16858b5b562196712c6bd7b219c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f4e16858b5b562196712c6bd7b219c3">§ </a></span>getPooledString() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> StringPool::getPooledString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to a copy of the string that is passed in. </p>
<p>The pool will always return the same <a class="el" href="classString.html" title="The JUCE String class! ">String</a> object when asked for a string that matches it. </p>
</div>
</div>
<a id="a304c7b871b037a619af828a1d1300417"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a304c7b871b037a619af828a1d1300417">§ </a></span>garbageCollect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPool::garbageCollect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Scans the pool, and removes any strings that are unreferenced. </p>
<p>You don't generally need to call this - it'll be called automatically when the pool grows large enough to warrant it. </p>
</div>
</div>
<a id="a3fafb36830141853af13654563225ecb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fafb36830141853af13654563225ecb">§ </a></span>getGlobalPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classStringPool.html">StringPool</a>& StringPool::getGlobalPool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a shared global pool which is used for things like Identifiers, XML parsing. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__StringPool_8h.html">juce_StringPool.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|