/usr/share/doc/libucommon-dev/a00082.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | <!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: ucc::memstring 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="a00214.html">ucc</a>::<a class="el" href="a00082.html">memstring</a>
</div>
</div>
<div class="contents">
<h1>ucc::memstring Class Reference</h1><!-- doxytag: class="ucc::memstring" --><!-- doxytag: inherits="ucc::string" -->
<p>A string class that uses a cstring buffer that is fixed in memory.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00207_source.html">string.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::memstring:</div>
<div class="dynsection">
<div class="center"><img src="a00441.png" border="0" usemap="#ucc_1_1memstring_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1memstring_inherit__map" id="ucc_1_1memstring_inherit__map">
<area shape="rect" id="node7" href="a00159.html" title="A string class that has a predefined string buffer." alt="" coords="5,237,152,267"/><area shape="rect" id="node2" href="a00157.html" title="A copy-on-write string class that operates by reference count." alt="" coords="35,83,123,112"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="32,5,125,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::memstring:</div>
<div class="dynsection">
<div class="center"><img src="a00442.png" border="0" usemap="#ucc_1_1memstring_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1memstring_coll__map" id="ucc_1_1memstring_coll__map">
<area shape="rect" id="node2" href="a00157.html" title="A copy-on-write string class that operates by reference count." alt="" coords="23,261,111,291"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="35,5,128,35"/><area shape="rect" id="node8" href="a00043.html" title="A base class for reference counted objects." alt="" coords="83,85,229,115"/><area shape="rect" id="node6" href="a00158.html" title="This is an internal class which contains the actual string data along with some control..." alt="" coords="84,165,223,195"/></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#ac6e6ad5a547868b25621a436bc23f8c7">memstring</a> (void *memory, <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> size, char fill=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of a memory string. <a href="#ac6e6ad5a547868b25621a436bc23f8c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a0574470a217e47864ecf6ca6b33290e8">operator=</a> (const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign null terminated text to our object. <a href="#a0574470a217e47864ecf6ca6b33290e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#aa5a9207b25a00f7f83b827dac97f534b">operator=</a> (<a class="el" href="a00157.html">string</a> &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign the text of a string to our object. <a href="#aa5a9207b25a00f7f83b827dac97f534b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa16fa458aef58c70292348b55277cac1"></a><!-- doxytag: member="ucc::memstring::~memstring" ref="aa16fa458aef58c70292348b55277cac1" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#aa16fa458aef58c70292348b55277cac1">~memstring</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy memory string. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00082.html">memstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a772d5a294c5b6880d064474be43ada4c">create</a> (<a class="el" href="a00081.html">mempager</a> *<a class="el" href="a00102.html">pager</a>, <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> size, char fill=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a memory string with memory allocated from a pager. <a href="#a772d5a294c5b6880d064474be43ada4c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00082.html">memstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#ad488816689490b14549ac5f59ba647d2">create</a> (<a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> size, char fill=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a memory string with memory allocated from the heap. <a href="#ad488816689490b14549ac5f59ba647d2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3177ee7a6bed30d09ba1e5f0848537cd"></a><!-- doxytag: member="ucc::memstring::header" ref="a3177ee7a6bed30d09ba1e5f0848537cd" args="" -->
static const size_t </td><td class="memItemRight" valign="bottom"><b>header</b></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00158.html">cstring</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a4fcb172a833d22c7638365713b40ed99">c_copy</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return cstring to use in copy constructors. <a href="#a4fcb172a833d22c7638365713b40ed99"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A string class that uses a cstring buffer that is fixed in memory. </p>
<p>This allows one to manipulate a fixed buffer of text in memory through the string class. The size of the memory used must include space for the overhead() size needed for the cstring object control data. </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="a00207_source.html#l01428">1428</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac6e6ad5a547868b25621a436bc23f8c7"></a><!-- doxytag: member="ucc::memstring::memstring" ref="ac6e6ad5a547868b25621a436bc23f8c7" args="(void *memory, strsize_t size, char fill=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::memstring::memstring </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>memory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an instance of a memory 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>memory</em> </td><td>to use for cstring object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of string. Total size must include space for overhead. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fill</em> </td><td>character for fixed character fields. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4fcb172a833d22c7638365713b40ed99"></a><!-- doxytag: member="ucc::memstring::c_copy" ref="a4fcb172a833d22c7638365713b40ed99" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00158.html">cstring</a>* ucc::memstring::c_copy </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return cstring to use in copy constructors. </p>
<p>Is virtual for memstring. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>cstring for copy constructor. </dd></dl>
<p>Reimplemented from <a class="el" href="a00157.html#a242d8d0fba2f8bac7fdeb2a034d0e88e">ucc::string</a>.</p>
</div>
</div>
<a class="anchor" id="a772d5a294c5b6880d064474be43ada4c"></a><!-- doxytag: member="ucc::memstring::create" ref="a772d5a294c5b6880d064474be43ada4c" args="(mempager *pager, strsize_t size, char fill=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00082.html">memstring</a>* ucc::memstring::create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00081.html">mempager</a> * </td>
<td class="paramname"> <em>pager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a memory string with memory allocated from a pager. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pager</em> </td><td>to allocate memory from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of string to allocate. Automatically adds control size. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fill</em> </td><td>character for fixed field strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad488816689490b14549ac5f59ba647d2"></a><!-- doxytag: member="ucc::memstring::create" ref="ad488816689490b14549ac5f59ba647d2" args="(strsize_t size, char fill=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00082.html">memstring</a>* ucc::memstring::create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a memory string with memory allocated from the heap. </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 to allocate. Automatically adds control size. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fill</em> </td><td>character for fixed field strings. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0574470a217e47864ecf6ca6b33290e8"></a><!-- doxytag: member="ucc::memstring::operator=" ref="a0574470a217e47864ecf6ca6b33290e8" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::memstring::operator= </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign null terminated text to our 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>text</em> </td><td>to copy. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="a00157.html#a60b72661b3f55ddb155c2bee2f37c75d">ucc::string</a>.</p>
<p>Reimplemented in <a class="el" href="a00159.html#a3e92c96e44b3fc93d60f07ecfe7599b5">ucc::stringbuf< S ></a>.</p>
<p>Definition at line <a class="el" href="a00207_source.html#l01453">1453</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa5a9207b25a00f7f83b827dac97f534b"></a><!-- doxytag: member="ucc::memstring::operator=" ref="aa5a9207b25a00f7f83b827dac97f534b" args="(string &object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::memstring::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00157.html">string</a> & </td>
<td class="paramname"> <em>object</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign the text of a string to our 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>object</em> </td><td>to copy text from. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="a00159.html#ae702e26ed8b5d84c7ecc2bf05a2b5005">ucc::stringbuf< S ></a>.</p>
<p>Definition at line <a class="el" href="a00207_source.html#l01446">1446</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00207_source.html">string.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:34 2010 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>
|