<!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::string::cstring 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 Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00148.html">string</a>::<a class="el" href="a00149.html">cstring</a>
</div>
</div>
<div class="contents">
<h1>ucommon::string::cstring Class Reference</h1><!-- doxytag: class="ucommon::string::cstring" --><!-- doxytag: inherits="ucommon::CountedObject" -->
<p>This is an internal class which contains the actual string data along with some control fields.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00201_source.html">string.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::string::cstring:</div>
<div class="dynsection">
<div class="center"><img src="a00541.png" border="0" usemap="#ucommon_1_1string_1_1cstring_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1string_1_1cstring_inherit__map" id="ucommon_1_1string_1_1cstring_inherit__map">
<area shape="rect" id="node2" href="a00039.html" title="A base class for reference counted objects." alt="" coords="15,80,257,107"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="11,5,261,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::string::cstring:</div>
<div class="dynsection">
<div class="center"><img src="a00542.png" border="0" usemap="#ucommon_1_1string_1_1cstring_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1string_1_1cstring_coll__map" id="ucommon_1_1string_1_1cstring_coll__map">
<area shape="rect" id="node2" href="a00039.html" title="A base class for reference counted objects." alt="" coords="15,80,257,107"/><area shape="rect" id="node4" href="a00095.html" title="A common base class for all managed objects." alt="" coords="11,5,261,32"/></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>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#ac6aa3ab77ee5a70532da5df5519e19b0">add</a> (char character)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a single character to our string buffer. <a href="#ac6aa3ab77ee5a70532da5df5519e19b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a79770f30f891e503cdf6a913dc6d9ba4">add</a> (const char *<a class="el" href="a00149.html#a692b8f32304459057b498a5eb3eab2ad">text</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append null terminated text to our string buffer. <a href="#a79770f30f891e503cdf6a913dc6d9ba4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#ad15a382e7ee31c8e57777c24321d8a9f">clear</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> offset, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to clear a string. <a href="#ad15a382e7ee31c8e57777c24321d8a9f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a68cb6d7d6ebd1e9bb8b73a22b2faa07d">cstring</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size, char <a class="el" href="a00149.html#a2e71ddf866b7ed4534277b4f6ebc9f92">fill</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a filled cstring node allocated for specified string size. <a href="#a68cb6d7d6ebd1e9bb8b73a22b2faa07d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#ac047ef708b21eca7612854488d71a053">cstring</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a cstring node allocated for specified string size. <a href="#ac047ef708b21eca7612854488d71a053"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a81be408c9cdf9ccce3537ae2a29445d9">dec</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjust size of our string buffer by deleting characters from end of buffer. <a href="#a81be408c9cdf9ccce3537ae2a29445d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fada9f295388dedf0e034741edd2373"></a><!-- doxytag: member="ucommon::string::cstring::fix" ref="a9fada9f295388dedf0e034741edd2373" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a9fada9f295388dedf0e034741edd2373">fix</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill our string buffer to end if fill mode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a03d1b50c69eaf98cb25dbca3107e28b2">inc</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adjust size of our string buffer by deleting characters from start of buffer. <a href="#a03d1b50c69eaf98cb25dbca3107e28b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a88c05b45bbfd85b68d46cf7f9a0d748f">set</a> (const char *<a class="el" href="a00149.html#a692b8f32304459057b498a5eb3eab2ad">text</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set our string from null terminated text up to our allocated size. <a href="#a88c05b45bbfd85b68d46cf7f9a0d748f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a7ee4d6da03615d431f1a95eace05f09a">set</a> (<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> offset, const char *<a class="el" href="a00149.html#a692b8f32304459057b498a5eb3eab2ad">text</a>, <a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set part or all of a string with new text. <a href="#a7ee4d6da03615d431f1a95eace05f09a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d519b986c714ff6138fbbe236a423f6"></a><!-- doxytag: member="ucommon::string::cstring::unfix" ref="a6d519b986c714ff6138fbbe236a423f6" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a6d519b986c714ff6138fbbe236a423f6">unfix</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trim filler at end to reduce filled string to null terminated string for further processing. <br/></td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e71ddf866b7ed4534277b4f6ebc9f92"></a><!-- doxytag: member="ucommon::string::cstring::fill" ref="a2e71ddf866b7ed4534277b4f6ebc9f92" args="" -->
char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a2e71ddf866b7ed4534277b4f6ebc9f92">fill</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Filler character or 0 for none. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a961da7b5d9a2763798a482f4182d314d"></a><!-- doxytag: member="ucommon::string::cstring::len" ref="a961da7b5d9a2763798a482f4182d314d" args="" -->
<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a961da7b5d9a2763798a482f4182d314d">len</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current length of cstring text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82043f753f81fc2c3f0009d30600cf26"></a><!-- doxytag: member="ucommon::string::cstring::max" ref="a82043f753f81fc2c3f0009d30600cf26" args="" -->
<a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a82043f753f81fc2c3f0009d30600cf26">max</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocated size of cstring text. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a692b8f32304459057b498a5eb3eab2ad"></a><!-- doxytag: member="ucommon::string::cstring::text" ref="a692b8f32304459057b498a5eb3eab2ad" args="[1]" -->
char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00149.html#a692b8f32304459057b498a5eb3eab2ad">text</a> [1]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Null terminated text, in overdraft space. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is an internal class which contains the actual string data along with some control fields. </p>
<p>The string can be either NULL terminated or filled like a Pascal-style string, but with a user selected fill character. The cstring object is an overdraft object, as the actual string text which is of unknown size follows immediately after the class control data. This class is primarily for internal use. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00201_source.html#l00097">97</a> of file <a class="el" href="a00201_source.html">string.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac047ef708b21eca7612854488d71a053"></a><!-- doxytag: member="ucommon::string::cstring::cstring" ref="ac047ef708b21eca7612854488d71a053" args="(strsize_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::string::cstring::cstring </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a cstring node allocated for specified string size. </p>
<p>The new operator would also need the size as an overdraft value. </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> </td><td>of string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a68cb6d7d6ebd1e9bb8b73a22b2faa07d"></a><!-- doxytag: member="ucommon::string::cstring::cstring" ref="a68cb6d7d6ebd1e9bb8b73a22b2faa07d" args="(strsize_t size, char fill)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::string::cstring::cstring </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>fill</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a filled cstring node allocated for specified string size. </p>
<p>The new operator would also need the size as an overdraft value. The newly allocated string is filled with the fill value. </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> </td><td>of string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fill</em> </td><td>character value to fill string with. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac6aa3ab77ee5a70532da5df5519e19b0"></a><!-- doxytag: member="ucommon::string::cstring::add" ref="ac6aa3ab77ee5a70532da5df5519e19b0" args="(char character)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::string::cstring::add </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"> <em>character</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append a single character to our string buffer. </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> </td><td>to append. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a79770f30f891e503cdf6a913dc6d9ba4"></a><!-- doxytag: member="ucommon::string::cstring::add" ref="a79770f30f891e503cdf6a913dc6d9ba4" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::string::cstring::add </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append null terminated text to our string buffer. </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> </td><td>to append. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad15a382e7ee31c8e57777c24321d8a9f"></a><!-- doxytag: member="ucommon::string::cstring::clear" ref="ad15a382e7ee31c8e57777c24321d8a9f" args="(strsize_t offset, strsize_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::string::cstring::clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to clear a string. </p>
<p>If null terminated, then the string ends at the offset, otherwise it is simply filled with fill data up to the 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>offset</em> </td><td>to clear from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of field to clear. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a81be408c9cdf9ccce3537ae2a29445d9"></a><!-- doxytag: member="ucommon::string::cstring::dec" ref="a81be408c9cdf9ccce3537ae2a29445d9" args="(strsize_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::string::cstring::dec </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td>
<td class="paramname"> <em>number</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjust size of our string buffer by deleting characters from end of buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>of characters to delete. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a03d1b50c69eaf98cb25dbca3107e28b2"></a><!-- doxytag: member="ucommon::string::cstring::inc" ref="a03d1b50c69eaf98cb25dbca3107e28b2" args="(strsize_t number)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::string::cstring::inc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td>
<td class="paramname"> <em>number</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adjust size of our string buffer by deleting characters from start of buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>number</em> </td><td>of characters to delete. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a88c05b45bbfd85b68d46cf7f9a0d748f"></a><!-- doxytag: member="ucommon::string::cstring::set" ref="a88c05b45bbfd85b68d46cf7f9a0d748f" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::string::cstring::set </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set our string from null terminated text up to our allocated 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> </td><td>to set from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7ee4d6da03615d431f1a95eace05f09a"></a><!-- doxytag: member="ucommon::string::cstring::set" ref="a7ee4d6da03615d431f1a95eace05f09a" args="(strsize_t offset, const char *text, strsize_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::string::cstring::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00208.html#aff28e825082cbb9ec24f288f210f34c6">strsize_t</a> </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </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> </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set part or all of a string with new text. </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> </td><td>to set from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>to insert from null terminated string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of field to modify. This is filled for fill mode. </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="a00201_source.html">string.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:07 2011 for ucommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
