<!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 52.1: localpointer.h File 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="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 52.1  <span id="projectnumber">52.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.2 --> <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="namespaces.html"><span>Namespaces</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> </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> <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="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#namespaces">Namespaces</a> | <a href="#define-members">Macros</a> </div> <div class="headertitle"> <div class="title">localpointer.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>C++ API: "Smart pointers" for use with and in ICU4C C++ code. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/> </div> <p><a href="localpointer_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html">icu::LocalPointerBase< T ></a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">"Smart pointer" base class; do not use directly: use <a class="el" href="classicu_1_1LocalPointer.html" title=""Smart pointer" class, deletes objects via the standard C++ delete operator.">LocalPointer</a> etc. <a href="classicu_1_1LocalPointerBase.html#details">More...</a><br/></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointer.html">icu::LocalPointer< T ></a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">"Smart pointer" class, deletes objects via the standard C++ delete operator. <a href="classicu_1_1LocalPointer.html#details">More...</a><br/></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalArray.html">icu::LocalArray< T ></a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">"Smart pointer" class, deletes objects via the C++ array delete[] operator. <a href="classicu_1_1LocalArray.html#details">More...</a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="namespaces"></a> Namespaces</h2></td></tr> <tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr> <tr class="memdesc:namespaceicu"><td class="mdescLeft"> </td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service.">coll.h</a>. <br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a3030f841466c4bbbd465ac9c4b999549"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="localpointer_8h.html#a3030f841466c4bbbd465ac9c4b999549">U_DEFINE_LOCAL_OPEN_POINTER</a>(LocalPointerClassName, Type, closeFunction)</td></tr> <tr class="memdesc:a3030f841466c4bbbd465ac9c4b999549"><td class="mdescLeft"> </td><td class="mdescRight">"Smart pointer" definition macro, deletes objects via the closeFunction. <a href="#a3030f841466c4bbbd465ac9c4b999549"></a><br/></td></tr> </table> <a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>C++ API: "Smart pointers" for use with and in ICU4C C++ code. </p> <p>These classes are inspired by</p> <ul> <li>std::auto_ptr</li> <li>boost::scoped_ptr & boost::scoped_array</li> <li>Taligent Safe Pointers (TOnlyPointerTo)</li> </ul> <p>but none of those provide for all of the goals for ICU smart pointers:</p> <ul> <li>Smart pointer owns the object and releases it when it goes out of scope.</li> <li>No transfer of ownership via copy/assignment to reduce misuse. Simpler & more robust.</li> <li>ICU-compatible: No exceptions.</li> <li>Need to be able to orphan/release the pointer and its ownership.</li> <li>Need variants for normal C++ object pointers, C++ arrays, and ICU C service objects.</li> </ul> <p>For details see <a href="http://site.icu-project.org/design/cpp/scoped_ptr">http://site.icu-project.org/design/cpp/scoped_ptr</a> </p> <p>Definition in file <a class="el" href="localpointer_8h_source.html">localpointer.h</a>.</p> </div><h2>Macro Definition Documentation</h2> <a class="anchor" id="a3030f841466c4bbbd465ac9c4b999549"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define U_DEFINE_LOCAL_OPEN_POINTER</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">LocalPointerClassName, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">Type, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">closeFunction </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line"><span class="keyword">class </span>LocalPointerClassName : <span class="keyword">public</span> LocalPointerBase<Type> { \</div> <div class="line"> public: \</div> <div class="line"> explicit LocalPointerClassName(Type *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<Type>(p) {} \</div> <div class="line"> ~LocalPointerClassName() { closeFunction(ptr); } \</div> <div class="line"> void adoptInstead(Type *p) { \</div> <div class="line"> closeFunction(ptr); \</div> <div class="line"> ptr=p; \</div> <div class="line"> } \</div> <div class="line"> }</div> </div><!-- fragment --> <p>"Smart pointer" definition macro, deletes objects via the closeFunction. </p> <p>Defines a subclass of LocalPointerBase which works just like LocalPointer<Type> except that this subclass will use the closeFunction rather than the C++ delete operator.</p> <p>Requirement: The closeFunction must tolerate a NULL pointer. (We could add a NULL check here but it is normally redundant.)</p> <p>Usage example: </p> <div class="fragment"><div class="line"><a class="code" href="classLocalUCaseMapPointer.html" title=""Smart pointer" class, closes a UCaseMap via ucasemap_close().">LocalUCaseMapPointer</a> csm(<a class="code" href="ucasemap_8h.html#a40df152b19d07dba4cc9d5b3015b27d1" title="Open a UCaseMap service object for a locale and a set of options.">ucasemap_open</a>(localeID, options, &errorCode));</div> <div class="line">utf8OutLength=<a class="code" href="ucasemap_8h.html#a8d14045335e130a16b68213194a04cc0" title="Lowercase the characters in a UTF-8 string.">ucasemap_utf8ToLower</a>(csm.getAlias(),</div> <div class="line"> utf8Out, (int32_t)<span class="keyword">sizeof</span>(utf8Out),</div> <div class="line"> utf8In, utf8InLength, &errorCode);</div> <div class="line"><span class="keywordflow">if</span>(<a class="code" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE</a>(errorCode)) { <span class="keywordflow">return</span>; } <span class="comment">// no need to explicitly delete the UCaseMap</span></div> </div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd>LocalPointerBase </dd> <dd> LocalPointer </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable000208">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl> <p>Definition at line <a class="el" href="localpointer_8h_source.html#l00290">290</a> of file <a class="el" href="localpointer_8h_source.html">localpointer.h</a>.</p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 4 2013 14:10:22 for ICU 52.1 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.2 </small></address> </body> </html>