This file is indexed.

/usr/share/doc/libucommon-dev/a00177.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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
<!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::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="a00214.html">ucc</a>::<a class="el" href="a00177.html">UString</a>
  </div>
</div>
<div class="contents">
<h1>ucc::UString Class Reference</h1><!-- doxytag: class="ucc::UString" --><!-- doxytag: inherits="ucc::string,ucc::utf8" -->
<p>A copy-on-write <a class="el" href="a00178.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="a00211_source.html">unicode.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::UString:</div>
<div class="dynsection">
<div class="center"><img src="a00582.png" border="0" usemap="#ucc_1_1_u_string_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_u_string_inherit__map" id="ucc_1_1_u_string_inherit__map">
<area shape="rect" id="node2" href="a00157.html" title="A copy&#45;on&#45;write string class that operates by reference count." alt="" coords="23,83,81,112"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="5,5,99,35"/><area shape="rect" id="node6" href="a00178.html" title="A core class of ut8 encoded string functions." alt="" coords="105,83,183,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::UString:</div>
<div class="dynsection">
<div class="center"><img src="a00583.png" border="0" usemap="#ucc_1_1_u_string_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_u_string_coll__map" id="ucc_1_1_u_string_coll__map">
<area shape="rect" id="node2" href="a00157.html" title="A copy&#45;on&#45;write string class that operates by reference count." alt="" coords="8,261,67,291"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="5,5,99,35"/><area shape="rect" id="node8" href="a00043.html" title="A base class for reference counted objects." alt="" coords="53,85,200,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="55,165,193,195"/><area shape="rect" id="node11" href="a00178.html" title="A core class of ut8 encoded string functions." alt="" coords="91,261,168,291"/></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="a00177.html#a2df78496a546674b1e7ae2c206dfeb83">add</a> (const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">unicode_t</a> unicode)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add (append) unicode to a <a class="el" href="a00178.html" title="A core class of ut8 encoded string functions.">utf8</a> encoded string.  <a href="#a2df78496a546674b1e7ae2c206dfeb83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">ucs4_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a2d5ad362c375cb44377fd4aa6f6b4df6">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="#a2d5ad362c375cb44377fd4aa6f6b4df6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a675ba7b4005073ec15854abe3bcc027d">ccount</a> (<a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">ucs4_t</a> character) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Count occurences of a unicode character in string.  <a href="#a675ba7b4005073ec15854abe3bcc027d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a428a1fe426d672698818eef2f2a3125b">count</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Count codepoints in current string.  <a href="#a428a1fe426d672698818eef2f2a3125b"></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="a00177.html#a2ae72942141247d7b11c5c0012c38964">find</a> (<a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">ucs4_t</a> character, <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> start=0) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find first occurance of character in string.  <a href="#a2ae72942141247d7b11c5c0012c38964"></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="a00177.html#a5787f3df9aa3f766761b37defc291f89">get</a> (<a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00178.html" title="A core class of ut8 encoded string functions.">utf8</a> object.  <a href="#a5787f3df9aa3f766761b37defc291f89"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00177.html">UString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a78d2d2b9703f7b3a2592dea117f9c209">get</a> (<a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> codepoint, <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="#a78d2d2b9703f7b3a2592dea117f9c209"></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="a00177.html#a4394f57b195c488ceeddc28cca39a1fd">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="#a4394f57b195c488ceeddc28cca39a1fd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00177.html">UString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#ae7c63bbd659d671bda1d83b2bbf9c435">operator()</a> (int codepoint, <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="#ae7c63bbd659d671bda1d83b2bbf9c435"></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="a00177.html#a9bac9731e20ef3d6843b2aac6b12bb92">operator()</a> (<a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00178.html" title="A core class of ut8 encoded string functions.">utf8</a> object.  <a href="#a9bac9731e20ef3d6843b2aac6b12bb92"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">ucs4_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#aee60a67389eddec56bfec6c5a7a56324">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="#aee60a67389eddec56bfec6c5a7a56324"></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="a00177.html#aa68de989ff3dce535c39145631dbda4c">rfind</a> (<a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">ucs4_t</a> character, <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> end=<a class="el" href="a00157.html#a0af2d44c841c0b7849967d0bd29226ac">npos</a>) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find last occurance of character in string.  <a href="#aa68de989ff3dce535c39145631dbda4c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#aa05d6b65533759004d71fa0530d9ecc3">set</a> (const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">unicode_t</a> unicode)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a <a class="el" href="a00178.html" title="A core class of ut8 encoded string functions.">utf8</a> encoded string based on unicode data.  <a href="#aa05d6b65533759004d71fa0530d9ecc3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a18b438bed90b6eb57b5a598d6d8c5d00">UString</a> (const <a class="el" href="a00177.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="#a18b438bed90b6eb57b5a598d6d8c5d00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#ac5d94ce9c35bbb65eec290a739eac1b0">UString</a> (const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">unicode_t</a> *text, const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">unicode_t</a> *end)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a string for a substring.  <a href="#ac5d94ce9c35bbb65eec290a739eac1b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#ac6b960a5367cfddd263259daa5b8472a">UString</a> (const char *text, <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="#ac6b960a5367cfddd263259daa5b8472a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a5002171c80e7d4dc0ba6e09ade6813f4">UString</a> (const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">unicode_t</a> text)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a <a class="el" href="a00178.html" title="A core class of ut8 encoded string functions.">utf8</a> aware string for a null terminated unicode string.  <a href="#a5002171c80e7d4dc0ba6e09ade6813f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a00d6d8442ca99320bebc4fd84f639ba2">UString</a> (<a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="#a00d6d8442ca99320bebc4fd84f639ba2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d2ba890e8456e41a640c3fb094fd40e"></a><!-- doxytag: member="ucc::UString::UString" ref="a5d2ba890e8456e41a640c3fb094fd40e" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00177.html#a5d2ba890e8456e41a640c3fb094fd40e">UString</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new empty <a class="el" href="a00178.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="a00177.html#a38a755c07cefe0498dd5313de14fb15a">~UString</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy string.  <a href="#a38a755c07cefe0498dd5313de14fb15a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A copy-on-write <a class="el" href="a00178.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="a00178.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="a00211_source.html#l00184">184</a> of file <a class="el" href="a00211_source.html">unicode.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a00d6d8442ca99320bebc4fd84f639ba2"></a><!-- doxytag: member="ucc::UString::UString" ref="a00d6d8442ca99320bebc4fd84f639ba2" args="(strsize_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::UString::UString </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="a5002171c80e7d4dc0ba6e09ade6813f4"></a><!-- doxytag: member="ucc::UString::UString" ref="a5002171c80e7d4dc0ba6e09ade6813f4" args="(const unicode_t text)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::UString::UString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00178.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="ac6b960a5367cfddd263259daa5b8472a"></a><!-- doxytag: member="ucc::UString::UString" ref="ac6b960a5367cfddd263259daa5b8472a" args="(const char *text, strsize_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::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="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="ac5d94ce9c35bbb65eec290a739eac1b0"></a><!-- doxytag: member="ucc::UString::UString" ref="ac5d94ce9c35bbb65eec290a739eac1b0" args="(const unicode_t *text, const unicode_t *end)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::UString::UString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a18b438bed90b6eb57b5a598d6d8c5d00"></a><!-- doxytag: member="ucc::UString::UString" ref="a18b438bed90b6eb57b5a598d6d8c5d00" args="(const UString &amp;existing)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::UString::UString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00177.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 inherets 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="a38a755c07cefe0498dd5313de14fb15a"></a><!-- doxytag: member="ucc::UString::~UString" ref="a38a755c07cefe0498dd5313de14fb15a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual ucc::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="a2df78496a546674b1e7ae2c206dfeb83"></a><!-- doxytag: member="ucc::UString::add" ref="a2df78496a546674b1e7ae2c206dfeb83" args="(const unicode_t unicode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::UString::add </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00178.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="a2d5ad362c375cb44377fd4aa6f6b4df6"></a><!-- doxytag: member="ucc::UString::at" ref="a2d5ad362c375cb44377fd4aa6f6b4df6" args="(int position) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">ucs4_t</a> ucc::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="a00157.html#a188cb7ebdef5d8d099aed66c1b7cb414">ucc::string</a>.</p>

</div>
</div>
<a class="anchor" id="a675ba7b4005073ec15854abe3bcc027d"></a><!-- doxytag: member="ucc::UString::ccount" ref="a675ba7b4005073ec15854abe3bcc027d" args="(ucs4_t character) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned ucc::UString::ccount </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">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 occurences 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 occurences. </dd></dl>

</div>
</div>
<a class="anchor" id="a428a1fe426d672698818eef2f2a3125b"></a><!-- doxytag: member="ucc::UString::count" ref="a428a1fe426d672698818eef2f2a3125b" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> ucc::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="a00157.html#a8bd3d06e4624be66bf3f51292dec61f4">ucc::string</a>.</p>

<p>Definition at line <a class="el" href="a00211_source.html#l00307">307</a> of file <a class="el" href="a00211_source.html">unicode.h</a>.</p>

</div>
</div>
<a class="anchor" id="a2ae72942141247d7b11c5c0012c38964"></a><!-- doxytag: member="ucc::UString::find" ref="a2ae72942141247d7b11c5c0012c38964" args="(ucs4_t character, strsize_t start=0) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ucc::UString::find </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">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="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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 occurance 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="a5787f3df9aa3f766761b37defc291f89"></a><!-- doxytag: member="ucc::UString::get" ref="a5787f3df9aa3f766761b37defc291f89" args="(unicode_t unicode, size_t size) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucc::UString::get </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00178.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="a00211_source.html#l00247">247</a> of file <a class="el" href="a00211_source.html">unicode.h</a>.</p>

</div>
</div>
<a class="anchor" id="a78d2d2b9703f7b3a2592dea117f9c209"></a><!-- doxytag: member="ucc::UString::get" ref="a78d2d2b9703f7b3a2592dea117f9c209" 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="a00177.html">UString</a> ucc::UString::get </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="a00157.html#a9930c0b014878ea8b265133fb8cb9ba4">ucc::string</a>.</p>

</div>
</div>
<a class="anchor" id="a4394f57b195c488ceeddc28cca39a1fd"></a><!-- doxytag: member="ucc::UString::operator()" ref="a4394f57b195c488ceeddc28cca39a1fd" args="(int offset) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ucc::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="a00157.html#abd13c5ce33bb302cb4a3f00c5681f741">ucc::string</a>.</p>

</div>
</div>
<a class="anchor" id="ae7c63bbd659d671bda1d83b2bbf9c435"></a><!-- doxytag: member="ucc::UString::operator()" ref="ae7c63bbd659d671bda1d83b2bbf9c435" args="(int codepoint, strsize_t size) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00177.html">UString</a> ucc::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="a00214.html#ab147df0377723db28a0d3ec1f419f2da">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="a00157.html#a1d383d83f27645c4101935d6fd0ee3eb">ucc::string</a>.</p>

</div>
</div>
<a class="anchor" id="a9bac9731e20ef3d6843b2aac6b12bb92"></a><!-- doxytag: member="ucc::UString::operator()" ref="a9bac9731e20ef3d6843b2aac6b12bb92" args="(unicode_t unicode, size_t size) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucc::UString::operator() </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00178.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="a00211_source.html#l00275">275</a> of file <a class="el" href="a00211_source.html">unicode.h</a>.</p>

</div>
</div>
<a class="anchor" id="aee60a67389eddec56bfec6c5a7a56324"></a><!-- doxytag: member="ucc::UString::operator[]" ref="aee60a67389eddec56bfec6c5a7a56324" args="(int position) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">ucs4_t</a> ucc::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="a00157.html#ab36586084bf6c05f0dfeee918af1f574">ucc::string</a>.</p>

<p>Definition at line <a class="el" href="a00211_source.html#l00300">300</a> of file <a class="el" href="a00211_source.html">unicode.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa68de989ff3dce535c39145631dbda4c"></a><!-- doxytag: member="ucc::UString::rfind" ref="aa68de989ff3dce535c39145631dbda4c" args="(ucs4_t character, strsize_t end=npos) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* ucc::UString::rfind </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00214.html#a3f92a2d8f1343874335bd5c2b1dfe62b">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="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a>&nbsp;</td>
          <td class="paramname"> <em>end</em> = <code><a class="el" href="a00157.html#a0af2d44c841c0b7849967d0bd29226ac">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 occurance 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="aa05d6b65533759004d71fa0530d9ecc3"></a><!-- doxytag: member="ucc::UString::set" ref="aa05d6b65533759004d71fa0530d9ecc3" args="(const unicode_t unicode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::UString::set </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00214.html#a9152ddb1a47f8f4d5fa929be5a7ff340">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="a00178.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="a00211_source.html">unicode.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:53 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>