<!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"/> <title>ICU 4.8.1.1: localpointer.h 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">ICU 4.8.1.1  <span id="projectnumber">4.8.1.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.1 --> <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="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</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>Globals</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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</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_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_f59c6450ff718ff1b085cfd1c36acbd7.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">localpointer.h</div> </div> </div><!--header--> <div class="contents"> <a href="localpointer_8h.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">*******************************************************************************</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 (C) 2009-2010, International Business Machines</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">*</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> <span class="comment">* file name: localpointer.h</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* encoding: US-ASCII</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* tab size: 8 (not used)</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* indentation:4</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">*</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* created on: 2009nov13</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* created by: Markus W. Scherer</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">*/</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __LOCALPOINTER_H__</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __LOCALPOINTER_H__</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">unicode/utypes.h</a>"</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#if U_SHOW_CPLUSPLUS_API</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b" title="This is used to begin a declaration of a public ICU C++ API.">U_NAMESPACE_BEGIN</a></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">class </span>LocalPointerBase {</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">explicit</span> LocalPointerBase(T *p=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4" title="Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.">NULL</a>) : ptr(p) {}</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  ~LocalPointerBase() { <span class="comment">/* delete ptr; */</span> }</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> isNull()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ptr==<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4" title="Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.">NULL</a>; }</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> isValid()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ptr!=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4" title="Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.">NULL</a>; }</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">bool</span> <a class="code" href="stringpiece_8h.html#a7652049cbac0bfeae2cd2aa4514a3352" title="Global operator == for StringPiece.">operator==</a>(<span class="keyword">const</span> T *other)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ptr==other; }</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">bool</span> <a class="code" href="stringpiece_8h.html#abf0ccab9536bab551afc07de65eb5d95" title="Global operator != for StringPiece.">operator!=</a>(<span class="keyword">const</span> T *other)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ptr!=other; }</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  T *getAlias()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ptr; }</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  T &operator*()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *ptr; }</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  T *operator->()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> ptr; }</div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  T *orphan() {</div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  T *p=ptr;</div> <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  ptr=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4" title="Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.">NULL</a>;</div> <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">return</span> p;</div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">void</span> adoptInstead(T *p) {</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// delete ptr;</span></div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  ptr=p;</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="keyword">protected</span>:</div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  T *ptr;</div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">private</span>:</div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// No comparison operators with other LocalPointerBases.</span></div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">bool</span> <a class="code" href="stringpiece_8h.html#a7652049cbac0bfeae2cd2aa4514a3352" title="Global operator == for StringPiece.">operator==</a>(<span class="keyword">const</span> LocalPointerBase &other);</div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordtype">bool</span> <a class="code" href="stringpiece_8h.html#abf0ccab9536bab551afc07de65eb5d95" title="Global operator != for StringPiece.">operator!=</a>(<span class="keyword">const</span> LocalPointerBase &other);</div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="comment">// No ownership transfer: No copy constructor, no assignment operator.</span></div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  LocalPointerBase(<span class="keyword">const</span> LocalPointerBase &other);</div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> LocalPointerBase &other);</div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="comment">// No heap allocation. Use only on the stack.</span></div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> * <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <span class="keyword">operator</span> <span class="keyword">new</span>(<span class="keywordtype">size_t</span> size);</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> * <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <span class="keyword">operator</span> <span class="keyword">new</span>[](<span class="keywordtype">size_t</span> size);</div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#if U_HAVE_PLACEMENT_NEW</span></div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor"></span> <span class="keyword">static</span> <span class="keywordtype">void</span> * <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> <span class="keyword">operator</span> <span class="keyword">new</span>(size_t, <span class="keywordtype">void</span> *ptr);</div> <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor"></span>};</div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="keyword">class </span>LocalPointer : <span class="keyword">public</span> LocalPointerBase<T> {</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keyword">explicit</span> LocalPointer(T *p=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4" title="Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.">NULL</a>) : LocalPointerBase<T>(p) {}</div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  ~LocalPointer() {</div> <div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keyword">delete</span> LocalPointerBase<T>::ptr;</div> <div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  }</div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keywordtype">void</span> adoptInstead(T *p) {</div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keyword">delete</span> LocalPointerBase<T>::ptr;</div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  LocalPointerBase<T>::ptr=p;</div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  }</div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> };</div> <div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div> <div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> <div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="keyword">class </span>LocalArray : <span class="keyword">public</span> LocalPointerBase<T> {</div> <div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="keyword">public</span>:</div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keyword">explicit</span> LocalArray(T *p=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4" title="Define NULL if necessary, to 0 for C++ and to ((void *)0) for C.">NULL</a>) : LocalPointerBase<T>(p) {}</div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  ~LocalArray() {</div> <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">delete</span>[] LocalPointerBase<T>::ptr;</div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  }</div> <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keywordtype">void</span> adoptInstead(T *p) {</div> <div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keyword">delete</span>[] LocalPointerBase<T>::ptr;</div> <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  LocalPointerBase<T>::ptr=p;</div> <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  }</div> <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  T &operator[](ptrdiff_t i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> LocalPointerBase<T>::ptr[i]; }</div> <div class="line"><a name="l00261"></a><span class="lineno"> 261</span> };</div> <div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div> <div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="preprocessor">#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction) \</span></div> <div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="preprocessor"> class LocalPointerClassName : public LocalPointerBase<Type> { \</span></div> <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="preprocessor"> public: \</span></div> <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="preprocessor"> explicit LocalPointerClassName(Type *p=NULL) : LocalPointerBase<Type>(p) {} \</span></div> <div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="preprocessor"> ~LocalPointerClassName() { closeFunction(ptr); } \</span></div> <div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="preprocessor"> void adoptInstead(Type *p) { \</span></div> <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="preprocessor"> closeFunction(ptr); \</span></div> <div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="preprocessor"> ptr=p; \</span></div> <div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="preprocessor"> } \</span></div> <div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="preprocessor"> }</span></div> <div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933" title="This is used to end a declaration of a public ICU C++ API.">U_NAMESPACE_END</a></div> <div class="line"><a name="l00298"></a><span class="lineno"> 298</span> </div> <div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="preprocessor">#endif </span><span class="comment">/* U_SHOW_CPLUSPLUS_API */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* __LOCALPOINTER_H__ */</span><span class="preprocessor"></span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.1 </small></address> </body> </html>