This file is indexed.

/usr/share/doc/libucommon-dev/a00036.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<!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::charbuf&lt; S &gt; Class Template 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="a00214.html">ucc</a>::<a class="el" href="a00036.html">charbuf</a>
  </div>
</div>
<div class="contents">
<h1>ucc::charbuf&lt; S &gt; Class Template Reference</h1><!-- doxytag: class="ucc::charbuf" -->
<p>A template to create a character array that can be manipulated as a string.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00207_source.html">string.h</a>&gt;</code></p>
<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#af214eb61cb02a190d8b868b7aeafdf2a">charbuf</a> (const char *text)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a character buffer with assigned text.  <a href="#af214eb61cb02a190d8b868b7aeafdf2a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad842b599b7ee687973256e8a146c6931"></a><!-- doxytag: member="ucc::charbuf::charbuf" ref="ad842b599b7ee687973256e8a146c6931" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#ad842b599b7ee687973256e8a146c6931">charbuf</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new character buffer with an empty string. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a3b953412a21aaccefe9d4847da402d0e">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test if data is contained in the object.  <a href="#a3b953412a21aaccefe9d4847da402d0e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a4452addedebdcfb58df370348dc5554a">operator char *</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get text by casting reference.  <a href="#a4452addedebdcfb58df370348dc5554a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a5f74d8ab7dc014963b2ca7c1af884daa">operator!</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test if the object is empty.  <a href="#a5f74d8ab7dc014963b2ca7c1af884daa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a6fb8dd3a2629d29fb4051fa9c65e2c4b">operator()</a> (size_t offset)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a pointer to an offset in the object by expression operator.  <a href="#a6fb8dd3a2629d29fb4051fa9c65e2c4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a996d0b39fff9ecb8889ecc56da0ac6c7">operator*</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get text by object pointer reference.  <a href="#a996d0b39fff9ecb8889ecc56da0ac6c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#afdf2fa38edf84e4aa5496ae719b7fa34">operator+=</a> (const char *text)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Concatenate text into the object.  <a href="#afdf2fa38edf84e4aa5496ae719b7fa34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#aacf0ff6e8ca5701084148350a5a152ae">operator=</a> (const char *text)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assign null terminated text to the object.  <a href="#aacf0ff6e8ca5701084148350a5a152ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00036.html#a41a1aa560a47bb03357d2e86b32cac73">operator[]</a> (size_t offset) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array operator to get a character from the object.  <a href="#a41a1aa560a47bb03357d2e86b32cac73"></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="a00036.html#af4fe653d12de12e2494756e377a62e9f">size</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get allocated size of the object.  <a href="#af4fe653d12de12e2494756e377a62e9f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;size_t S&gt;<br/>
 class ucc::charbuf&lt; S &gt;</h3>

<p>A template to create a character array that can be manipulated as a string. </p>
<p>This is a mini string/stringbuf class that supports a subset of functionality but does not require a complex supporting object. Like stringbuf, this can be used to create local string variables. </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="a00207_source.html#l01523">1523</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af214eb61cb02a190d8b868b7aeafdf2a"></a><!-- doxytag: member="ucc::charbuf::charbuf" ref="af214eb61cb02a190d8b868b7aeafdf2a" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::<a class="el" href="a00036.html">charbuf</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a character buffer with assigned text. </p>
<p>If the text is larger than the size of the object, it is truncated. </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 assign. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01540">1540</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3b953412a21aaccefe9d4847da402d0e"></a><!-- doxytag: member="ucc::charbuf::operator bool" ref="a3b953412a21aaccefe9d4847da402d0e" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator bool </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Test if data is contained in the object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if there is text. </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01562">1562</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<a class="anchor" id="a4452addedebdcfb58df370348dc5554a"></a><!-- doxytag: member="ucc::charbuf::operator char *" ref="a4452addedebdcfb58df370348dc5554a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator char * </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get text by casting reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to text in object. </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01576">1576</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5f74d8ab7dc014963b2ca7c1af884daa"></a><!-- doxytag: member="ucc::charbuf::operator!" ref="a5f74d8ab7dc014963b2ca7c1af884daa" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator! </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Test if the object is empty. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the object is empty. </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01569">1569</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6fb8dd3a2629d29fb4051fa9c65e2c4b"></a><!-- doxytag: member="ucc::charbuf::operator()" ref="a6fb8dd3a2629d29fb4051fa9c65e2c4b" args="(size_t offset)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator() </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get a pointer to an offset in the object by expression operator. </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>of character in string buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to offset in object. </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01599">1599</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<a class="anchor" id="a996d0b39fff9ecb8889ecc56da0ac6c7"></a><!-- doxytag: member="ucc::charbuf::operator*" ref="a996d0b39fff9ecb8889ecc56da0ac6c7" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator* </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get text by object pointer reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to text in object. </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01583">1583</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<a class="anchor" id="afdf2fa38edf84e4aa5496ae719b7fa34"></a><!-- doxytag: member="ucc::charbuf::operator+=" ref="afdf2fa38edf84e4aa5496ae719b7fa34" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator+= </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Concatenate text into the object. </p>
<p>If the text is larger than the size of the object, then it is truncated. </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 append. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01555">1555</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00036_afdf2fa38edf84e4aa5496ae719b7fa34_cgraph.png" border="0" usemap="#a00036_afdf2fa38edf84e4aa5496ae719b7fa34_cgraph_map" alt=""></div>
<map name="a00036_afdf2fa38edf84e4aa5496ae719b7fa34_cgraph_map" id="a00036_afdf2fa38edf84e4aa5496ae719b7fa34_cgraph">
<area shape="rect" id="node3" href="a00214.html#aad0ef1f27ebf9203be99b1824400e269" title="Add a linked object onto a stack of linked objects." alt="" coords="241,5,316,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="aacf0ff6e8ca5701084148350a5a152ae"></a><!-- doxytag: member="ucc::charbuf::operator=" ref="aacf0ff6e8ca5701084148350a5a152ae" args="(const char *text)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>text</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Assign null terminated text to the 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>&nbsp;</td><td>to assign. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01547">1547</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<a class="anchor" id="a41a1aa560a47bb03357d2e86b32cac73"></a><!-- doxytag: member="ucc::charbuf::operator[]" ref="a41a1aa560a47bb03357d2e86b32cac73" args="(size_t offset) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::operator[] </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Array operator to get a character from the 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>offset</em>&nbsp;</td><td>of character in string buffer. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>character at offset. </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01591">1591</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>

</div>
</div>
<a class="anchor" id="af4fe653d12de12e2494756e377a62e9f"></a><!-- doxytag: member="ucc::charbuf::size" ref="af4fe653d12de12e2494756e377a62e9f" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;size_t S&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">size_t <a class="el" href="a00036.html">ucc::charbuf</a>&lt; S &gt;::size </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get allocated size of the object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>allocated size. </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01606">1606</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:26 2010 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>