Sophie

Sophie

distrib > Mageia > 6 > armv5tl > media > core-release > by-pkgid > 3a4e91bde08970529a0aa07935652fe8 > files > 776

icu-doc-58.2-3.mga6.noarch.rpm

<!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.11"/>
<title>ICU 58.2: 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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ICU 58.2
   &#160;<span id="projectnumber">58.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;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&#160;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_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<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 &quot;<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>&quot;</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 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointerBase.html">icu::LocalPointerBase&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">"Smart pointer" base class; do not use directly: use <a class="el" href="classicu_1_1LocalPointer.html" title="&quot;Smart pointer&quot; 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="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalPointer.html">icu::LocalPointer&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1LocalArray.html">icu::LocalArray&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft">&#160;</td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a3030f841466c4bbbd465ac9c4b999549"><td class="memItemLeft" align="right" valign="top">#define&#160;</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">&#160;</td><td class="mdescRight">"Smart pointer" definition macro, deletes objects via the closeFunction.  <a href="#a3030f841466c4bbbd465ac9c4b999549">More...</a><br /></td></tr>
<tr class="separator:a3030f841466c4bbbd465ac9c4b999549"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">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 &amp; 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 &amp; 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 class="groupheader">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">&#160;</td>
          <td class="paramname">LocalPointerClassName, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">Type, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">closeFunction&#160;</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&lt;Type&gt; { \</div><div class="line">    public: \</div><div class="line">        using LocalPointerBase&lt;Type&gt;::operator*; \</div><div class="line">        using LocalPointerBase&lt;Type&gt;::operator-&gt;; \</div><div class="line">        explicit LocalPointerClassName(Type *p=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>) : LocalPointerBase&lt;Type&gt;(p) {} \</div><div class="line">        ~LocalPointerClassName() { closeFunction(ptr); } \</div><div class="line">        LocalPointerClassName &amp;moveFrom(LocalPointerClassName &amp;src) <a class="code" href="platform_8h.html#a6e25fe50df36f1f6553f54e7e7ee3bb1">U_NOEXCEPT</a> { \</div><div class="line">            if (ptr != <a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>) { closeFunction(ptr); } \</div><div class="line">            LocalPointerBase&lt;Type&gt;::ptr=src.ptr; \</div><div class="line">            src.ptr=<a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>; \</div><div class="line">            return *<span class="keyword">this</span>; \</div><div class="line">        } \</div><div class="line">        void swap(LocalPointerClassName &amp;other) <a class="code" href="platform_8h.html#a6e25fe50df36f1f6553f54e7e7ee3bb1">U_NOEXCEPT</a> { \</div><div class="line">            Type *temp=LocalPointerBase&lt;Type&gt;::ptr; \</div><div class="line">            LocalPointerBase&lt;Type&gt;::ptr=other.ptr; \</div><div class="line">            other.ptr=temp; \</div><div class="line">        } \</div><div class="line">        friend <span class="keyword">inline</span> <span class="keywordtype">void</span> swap(LocalPointerClassName &amp;p1, LocalPointerClassName &amp;p2) <a class="code" href="platform_8h.html#a6e25fe50df36f1f6553f54e7e7ee3bb1">U_NOEXCEPT</a> { \</div><div class="line">            p1.swap(p2); \</div><div class="line">        } \</div><div class="line">        void adoptInstead(Type *p) { \</div><div class="line">            if (ptr != <a class="code" href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>) { closeFunction(ptr); } \</div><div class="line">            ptr=p; \</div><div class="line">        } \</div><div class="line">    }</div><div class="ttc" id="utypes_8h_html_a070d2ce7b6bb7e5c05602aa8c308d0c4"><div class="ttname"><a href="utypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></div><div class="ttdeci">#define NULL</div><div class="ttdoc">Define NULL if necessary, to 0 for C++ and to ((void *)0) for C. </div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00188">utypes.h:188</a></div></div>
<div class="ttc" id="platform_8h_html_a6e25fe50df36f1f6553f54e7e7ee3bb1"><div class="ttname"><a href="platform_8h.html#a6e25fe50df36f1f6553f54e7e7ee3bb1">U_NOEXCEPT</a></div><div class="ttdeci">#define U_NOEXCEPT</div><div class="ttdoc">&quot;noexcept&quot; if supported, otherwise empty. </div><div class="ttdef"><b>Definition:</b> <a href="platform_8h_source.html#l00531">platform.h:531</a></div></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&lt;Type&gt; except that this subclass will use the closeFunction rather than the C++ delete operator.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;LocalUCaseMapPointer csm(ucasemap_open(localeID, options, &amp;errorCode));</div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;utf8OutLength=ucasemap_utf8ToLower(csm.getAlias(),</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;    utf8Out, (int32_t)sizeof(utf8Out),</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;    utf8In, utf8InLength, &amp;errorCode);</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;if(U_FAILURE(errorCode)) { return; }  // no need to explicitly delete the UCaseMap</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#_stable000225">Stable:</a></b></dt><dd>ICU 4.4 </dd></dl>

<p>Definition at line <a class="el" href="localpointer_8h_source.html#l00530">530</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 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional