Sophie

Sophie

distrib > Mandriva > 2010.2 > i586 > media > contrib-backports > by-pkgid > 4f5f2dc0f55b453456458df885792b0b > files > 444

ucommon-doc-5.0.4-1mdv2010.2.i586.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"/>
<title>ucommon: ucommon::UString Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00169.html">UString</a>
  </div>
</div>
<div class="contents">
<h1>ucommon::UString Class Reference</h1><!-- doxytag: class="ucommon::UString" --><!-- doxytag: inherits="ucommon::string,ucommon::utf8" -->
<p>A copy-on-write <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> string class that operates by reference count.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00205_source.html">unicode.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucommon::UString:</div>
<div class="dynsection">
<div class="center"><img src="a00564.png" border="0" usemap="#ucommon_1_1_u_string_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_u_string_inherit__map" id="ucommon_1_1_u_string_inherit__map">
<area shape="rect" id="node2" href="a00148.html" title="A copy&#45;on&#45;write string class that operates by reference count." alt="" coords="89,80,172,107"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,32"/><area shape="rect" id="node6" href="a00170.html" title="A core class of ut8 encoded string functions." alt="" coords="196,80,348,107"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::UString:</div>
<div class="dynsection">
<div class="center"><img src="a00565.png" border="0" usemap="#ucommon_1_1_u_string_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_u_string_coll__map" id="ucommon_1_1_u_string_coll__map">
<area shape="rect" id="node2" href="a00148.html" title="A copy&#45;on&#45;write string class that operates by reference count." alt="" coords="63,251,145,277"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="5,5,256,32"/><area shape="rect" id="node8" href="a00039.html" title="A base class for reference counted objects." alt="" coords="123,83,365,109"/><area shape="rect" id="node6" href="a00149.html" title="This is an internal class which contains the actual string data along with some control..." alt="" coords="120,160,381,187"/><area shape="rect" id="node11" href="a00170.html" title="A core class of ut8 encoded string functions." alt="" coords="169,251,321,277"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#abce215d50aeca2dad1092a05a00a70a7">add</a> (const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> unicode)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add (append) unicode to a <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> encoded string.  <a href="#abce215d50aeca2dad1092a05a00a70a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#ae1d667c9af8d18939b7a31b6c6adafe5">at</a> (int position) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return unicode character found at a specific codepoint in the string.  <a href="#ae1d667c9af8d18939b7a31b6c6adafe5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a5c81d14806ed5420286e8a6a8f35819c">ccount</a> (<a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a> character) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Count occurrences of a unicode character in string.  <a href="#a5c81d14806ed5420286e8a6a8f35819c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a775a5940fcb10992645c12b786ee00c2">count</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Count codepoints in current string.  <a href="#a775a5940fcb10992645c12b786ee00c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#af92f22b8503d5f026b1dfe38f52f8e0a">find</a> (<a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a> character, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> start=0) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find first occurrence of character in string.  <a href="#af92f22b8503d5f026b1dfe38f52f8e0a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a4c8bcb6539398abfae933507ff5971de">get</a> (<a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> unicode, size_t size) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extract a unicode byte sequence from <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> object.  <a href="#a4c8bcb6539398abfae933507ff5971de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">UString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a5fd8069f83deadd65525b4cdee181baf">get</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> codepoint, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size=0) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a new string object as a substring of the current object.  <a href="#a5fd8069f83deadd65525b4cdee181baf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a6d44d293377496374917508fd2f87b97">operator()</a> (int offset) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference a string in the object by codepoint offset.  <a href="#a6d44d293377496374917508fd2f87b97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00169.html">UString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a1b940ca7746f0532e2f12a7f0eec8138">operator()</a> (int codepoint, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a new substring through object expression.  <a href="#a1b940ca7746f0532e2f12a7f0eec8138"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a94d0ace6224e9cc5563c94e77ab714a5">operator()</a> (<a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> unicode, size_t size) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extract a unicode byte sequence from <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> object.  <a href="#a94d0ace6224e9cc5563c94e77ab714a5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#ac1e4964d8304356efebf7f43476caa40">operator[]</a> (int position) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference a unicode character in string object by array offset.  <a href="#ac1e4964d8304356efebf7f43476caa40"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a6d1c7db66afcb7b311c07b8b3d86a03e">rfind</a> (<a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a> character, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> end=<a class="el" href="a00148.html#a9bd0be57a8419e9634004f92678f240b">npos</a>) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find last occurrence of character in string.  <a href="#a6d1c7db66afcb7b311c07b8b3d86a03e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a1c6020e521b77ab9b1f9e0700188c9ac">set</a> (const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> unicode)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> encoded string based on unicode data.  <a href="#a1c6020e521b77ab9b1f9e0700188c9ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#aac211ceee845d88e85197e90b0697ae5">UString</a> (const <a class="el" href="a00169.html">UString</a> &amp;existing)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a copy of a string object.  <a href="#aac211ceee845d88e85197e90b0697ae5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a39d23ba4f6136fb4d856e21d6a1c3f95">UString</a> (const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> *text, const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> *end)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a string for a substring.  <a href="#a39d23ba4f6136fb4d856e21d6a1c3f95"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a079960cefbb2e5b1759f25bf6f44f139">UString</a> (const char *text, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a string from null terminated text up to a maximum specified size.  <a href="#a079960cefbb2e5b1759f25bf6f44f139"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a517d9aa330373b755721f406e922af0d">UString</a> (const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> text)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> aware string for a null terminated unicode string.  <a href="#a517d9aa330373b755721f406e922af0d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a1f74753cb5c13429f363fbb95c93d361">UString</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an empty string with a buffer pre-allocated to a specified size.  <a href="#a1f74753cb5c13429f363fbb95c93d361"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af501da5bf1d17d3fde83c1eeafc21f79"></a><!-- doxytag: member="ucommon::UString::UString" ref="af501da5bf1d17d3fde83c1eeafc21f79" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#af501da5bf1d17d3fde83c1eeafc21f79">UString</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new empty <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> aware string object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00169.html#a3bc1f81936a67d978e0e9034e900c172">~UString</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy string.  <a href="#a3bc1f81936a67d978e0e9034e900c172"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A copy-on-write <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> string class that operates by reference count. </p>
<p>This is derived from the classic uCommon String class by adding operations that are <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> encoding aware. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00205_source.html#l00193">193</a> of file <a class="el" href="a00205_source.html">unicode.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1f74753cb5c13429f363fbb95c93d361"></a><!-- doxytag: member="ucommon::UString::UString" ref="a1f74753cb5c13429f363fbb95c93d361" args="(strsize_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucommon::UString::UString </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create an empty string with a buffer pre-allocated to a specified size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of buffer to allocate. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a517d9aa330373b755721f406e922af0d"></a><!-- doxytag: member="ucommon::UString::UString" ref="a517d9aa330373b755721f406e922af0d" args="(const unicode_t text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucommon::UString::UString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a>&nbsp;</td>
          <td class="paramname"> <em>text</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> aware string for a null terminated unicode string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>of ucs4 encoded data. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a079960cefbb2e5b1759f25bf6f44f139"></a><!-- doxytag: member="ucommon::UString::UString" ref="a079960cefbb2e5b1759f25bf6f44f139" args="(const char *text, strsize_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucommon::UString::UString </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a string from null terminated text up to a maximum specified size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>to use for string. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>limit of new string. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a39d23ba4f6136fb4d856e21d6a1c3f95"></a><!-- doxytag: member="ucommon::UString::UString" ref="a39d23ba4f6136fb4d856e21d6a1c3f95" args="(const unicode_t *text, const unicode_t *end)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucommon::UString::UString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> *&nbsp;</td>
          <td class="paramname"> <em>text</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a> *&nbsp;</td>
          <td class="paramname"> <em>end</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a string for a substring. </p>
<p>The end of the substring is a pointer within the substring itself. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>to use for string. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>end</em>&nbsp;</td><td>of text in substring. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aac211ceee845d88e85197e90b0697ae5"></a><!-- doxytag: member="ucommon::UString::UString" ref="aac211ceee845d88e85197e90b0697ae5" args="(const UString &amp;existing)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucommon::UString::UString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00169.html">UString</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>existing</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct a copy of a string object. </p>
<p>Our copy inherits the same reference counted instance of cstring as in the original. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>existing</em>&nbsp;</td><td>string to copy from. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3bc1f81936a67d978e0e9034e900c172"></a><!-- doxytag: member="ucommon::UString::~UString" ref="a3bc1f81936a67d978e0e9034e900c172" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ucommon::UString::~UString </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destroy string. </p>
<p>De-reference cstring. If last reference to cstring, then also remove cstring from heap. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abce215d50aeca2dad1092a05a00a70a7"></a><!-- doxytag: member="ucommon::UString::add" ref="abce215d50aeca2dad1092a05a00a70a7" args="(const unicode_t unicode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucommon::UString::add </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a>&nbsp;</td>
          <td class="paramname"> <em>unicode</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Add (append) unicode to a <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> encoded string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>unicode</em>&nbsp;</td><td>text to add. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae1d667c9af8d18939b7a31b6c6adafe5"></a><!-- doxytag: member="ucommon::UString::at" ref="ae1d667c9af8d18939b7a31b6c6adafe5" args="(int position) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a> ucommon::UString::at </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>position</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Return unicode character found at a specific codepoint in the string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>position</em>&nbsp;</td><td>of codepoint in string, negative values computed from end. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>character code at specified position in string. </dd></dl>

<p>Reimplemented from <a class="el" href="a00148.html#aa9dcf23de080193f9d5f4089a9d3236b">ucommon::string</a>.</p>

</div>
</div>
<a class="anchor" id="a5c81d14806ed5420286e8a6a8f35819c"></a><!-- doxytag: member="ucommon::UString::ccount" ref="a5c81d14806ed5420286e8a6a8f35819c" args="(ucs4_t character) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned ucommon::UString::ccount </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a>&nbsp;</td>
          <td class="paramname"> <em>character</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Count occurrences of a unicode character in string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>character</em>&nbsp;</td><td>code to search for. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>count of occurrences. </dd></dl>

</div>
</div>
<a class="anchor" id="a775a5940fcb10992645c12b786ee00c2"></a><!-- doxytag: member="ucommon::UString::count" ref="a775a5940fcb10992645c12b786ee00c2" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> ucommon::UString::count </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Count codepoints in current string. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>count of codepoints. </dd></dl>

<p>Reimplemented from <a class="el" href="a00148.html#a178d708f8c2019954ea86a3688f77e3b">ucommon::string</a>.</p>

<p>Definition at line <a class="el" href="a00205_source.html#l00315">315</a> of file <a class="el" href="a00205_source.html">unicode.h</a>.</p>

</div>
</div>
<a class="anchor" id="af92f22b8503d5f026b1dfe38f52f8e0a"></a><!-- doxytag: member="ucommon::UString::find" ref="af92f22b8503d5f026b1dfe38f52f8e0a" args="(ucs4_t character, strsize_t start=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ucommon::UString::find </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a>&nbsp;</td>
          <td class="paramname"> <em>character</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>start</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Find first occurrence of character in string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>character</em>&nbsp;</td><td>code to search for. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>start</em>&nbsp;</td><td>offset in string in codepoints. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to first instance or NULL if not found. </dd></dl>

</div>
</div>
<a class="anchor" id="a4c8bcb6539398abfae933507ff5971de"></a><!-- doxytag: member="ucommon::UString::get" ref="a4c8bcb6539398abfae933507ff5971de" args="(unicode_t unicode, size_t size) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucommon::UString::get </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a>&nbsp;</td>
          <td class="paramname"> <em>unicode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Extract a unicode byte sequence from <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>unicode</em>&nbsp;</td><td>data buffer. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of data buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>codepoints copied. </dd></dl>

</div>
</div>
<a class="anchor" id="a5fd8069f83deadd65525b4cdee181baf"></a><!-- doxytag: member="ucommon::UString::get" ref="a5fd8069f83deadd65525b4cdee181baf" args="(strsize_t codepoint, strsize_t size=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00169.html">UString</a> ucommon::UString::get </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>codepoint</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get a new string object as a substring of the current object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>codepoint</em>&nbsp;</td><td>offset of substring. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of substring in codepoints or 0 if to end. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string object holding substring. </dd></dl>

<p>Reimplemented from <a class="el" href="a00148.html#ad2d52ee908980c305d6f9f383b940b66">ucommon::string</a>.</p>

</div>
</div>
<a class="anchor" id="a6d44d293377496374917508fd2f87b97"></a><!-- doxytag: member="ucommon::UString::operator()" ref="a6d44d293377496374917508fd2f87b97" args="(int offset) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ucommon::UString::operator() </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reference a string in the object by codepoint offset. </p>
<p>Positive offsets are from the start of the string, negative from the end. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>to string position. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to string data or NULL if invalid offset. </dd></dl>

<p>Reimplemented from <a class="el" href="a00148.html#adab43f47e887fd85c641f9cbbeaa44ef">ucommon::string</a>.</p>

</div>
</div>
<a class="anchor" id="a1b940ca7746f0532e2f12a7f0eec8138"></a><!-- doxytag: member="ucommon::UString::operator()" ref="a1b940ca7746f0532e2f12a7f0eec8138" args="(int codepoint, strsize_t size) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00169.html">UString</a> ucommon::UString::operator() </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>codepoint</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get a new substring through object expression. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>codepoint</em>&nbsp;</td><td>offset of substring. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of substring or 0 if to end. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>string object holding substring. </dd></dl>

<p>Reimplemented from <a class="el" href="a00148.html#a4836156a7833e37354a0773c0427de04">ucommon::string</a>.</p>

</div>
</div>
<a class="anchor" id="a94d0ace6224e9cc5563c94e77ab714a5"></a><!-- doxytag: member="ucommon::UString::operator()" ref="a94d0ace6224e9cc5563c94e77ab714a5" args="(unicode_t unicode, size_t size) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucommon::UString::operator() </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a>&nbsp;</td>
          <td class="paramname"> <em>unicode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Extract a unicode byte sequence from <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>unicode</em>&nbsp;</td><td>data buffer. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of data buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>codepoints copied. </dd></dl>

<p>Definition at line <a class="el" href="a00205_source.html#l00283">283</a> of file <a class="el" href="a00205_source.html">unicode.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac1e4964d8304356efebf7f43476caa40"></a><!-- doxytag: member="ucommon::UString::operator[]" ref="ac1e4964d8304356efebf7f43476caa40" args="(int position) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a> ucommon::UString::operator[] </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>position</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reference a unicode character in string object by array offset. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>position</em>&nbsp;</td><td>of codepoint offset to character. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>character value at offset. </dd></dl>

<p>Reimplemented from <a class="el" href="a00148.html#a5345c861dff19ab98d28a8f4a1d6b74c">ucommon::string</a>.</p>

<p>Definition at line <a class="el" href="a00205_source.html#l00308">308</a> of file <a class="el" href="a00205_source.html">unicode.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6d1c7db66afcb7b311c07b8b3d86a03e"></a><!-- doxytag: member="ucommon::UString::rfind" ref="a6d1c7db66afcb7b311c07b8b3d86a03e" args="(ucs4_t character, strsize_t end=npos) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ucommon::UString::rfind </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00208.html#aaa2499ef76785d12d303b525ad1a042e">ucs4_t</a>&nbsp;</td>
          <td class="paramname"> <em>character</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>end</em> = <code><a class="el" href="a00148.html#a9bd0be57a8419e9634004f92678f240b">npos</a></code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Find last occurrence of character in string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>character</em>&nbsp;</td><td>code to search for. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>end</em>&nbsp;</td><td>offset to start from in codepoints. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to last instance or NULL if not found. </dd></dl>

</div>
</div>
<a class="anchor" id="a1c6020e521b77ab9b1f9e0700188c9ac"></a><!-- doxytag: member="ucommon::UString::set" ref="a1c6020e521b77ab9b1f9e0700188c9ac" args="(const unicode_t unicode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucommon::UString::set </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00208.html#adca8b750ad72af446956b5a97570b53f">unicode_t</a>&nbsp;</td>
          <td class="paramname"> <em>unicode</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set a <a class="el" href="a00170.html" title="A core class of ut8 encoded string functions.">utf8</a> encoded string based on unicode data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>unicode</em>&nbsp;</td><td>text to set. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00205_source.html">unicode.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:11 2011 for ucommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>