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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Ipelib: IpeString Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="functions.html">Class Members</a></div>
<h1>IpeString Class Reference<br>
<small>
[<a class="el" href="group__base.html">Ipe Base</a>]</small>
</h1><!-- doxytag: class="IpeString" -->Strings and buffers.
<a href="#_details">More...</a>
<p>
<a href="class_ipe_string-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="anchor" name="a1"></a><!-- doxytag: member="IpeString::IpeString" ref="a1" args="(const char *str)" -->
<b>IpeString</b> (const char *str)
<li><a class="anchor" name="a2"></a><!-- doxytag: member="IpeString::IpeString" ref="a2" args="(const IpeString &rhs)" -->
<b>IpeString</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs)
<li><a class="anchor" name="a3"></a><!-- doxytag: member="IpeString::IpeString" ref="a3" args="(const IpeString &rhs, int index, int len)" -->
<b>IpeString</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs, int index, int len)
<li><a class="anchor" name="a4"></a><!-- doxytag: member="IpeString::operator=" ref="a4" args="(const IpeString &rhs)" -->
<a class="el" href="class_ipe_string.html">IpeString</a> & <b>operator=</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs)
<li>char <a class="el" href="class_ipe_string.html#a6">operator[]</a> (int i) const
<li>bool <a class="el" href="class_ipe_string.html#a7">empty</a> () const
<li>const char * <a class="el" href="class_ipe_string.html#a8">data</a> () const
<li>int <a class="el" href="class_ipe_string.html#a9">size</a> () const
<li>void <a class="el" href="class_ipe_string.html#a10">operator+=</a> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs)
<li>void <a class="el" href="class_ipe_string.html#a11">operator+=</a> (char ch)
<li><a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_string.html#a12">substr</a> (int i, int len=-1) const
<li>bool <a class="el" href="class_ipe_string.html#a13">operator!=</a> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs) const
<li><a class="anchor" name="a14"></a><!-- doxytag: member="IpeString::erase" ref="a14" args="()" -->
void <b>erase</b> ()
<li><a class="anchor" name="a15"></a><!-- doxytag: member="IpeString::append" ref="a15" args="(const IpeString &rhs)" -->
void <b>append</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs)
<li><a class="anchor" name="a16"></a><!-- doxytag: member="IpeString::append" ref="a16" args="(char ch)" -->
void <b>append</b> (char ch)
<li><a class="anchor" name="a17"></a><!-- doxytag: member="IpeString::operator==" ref="a17" args="(const IpeString &rhs) const " -->
bool <b>operator==</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs) const
<li><a class="anchor" name="a18"></a><!-- doxytag: member="IpeString::operator<" ref="a18" args="(const IpeString &rhs) const " -->
bool <b>operator<</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs) const
<li><a class="anchor" name="a19"></a><!-- doxytag: member="IpeString::operator+" ref="a19" args="(const IpeString &rhs) const " -->
<a class="el" href="class_ipe_string.html">IpeString</a> <b>operator+</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs) const
<li>int <a class="el" href="class_ipe_string.html#a20">unicode</a> (int &index) const
<li><a class="anchor" name="a21"></a><!-- doxytag: member="IpeString::CString" ref="a21" args="() const " -->
const char * <b>CString</b> () const
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Strings and buffers.
<p>
IpeString is is an implicitly shared byte string. It is designed to be efficient for strings of arbitrary length, and supposed to be passed by value (the size of IpeString is a single pointer). Sharing is implicit---the string creates its own representation as soon as it is modified.<p>
IpeString can be used for binary data. For text, it is usually assumed that the string is UTF-8 encoded, but only the unicode member function actually requires this. In particular, all indices into the string are byte indices, not Unicode character indices.<p>
Ipe is not using the STL string type because the C++ standard does neither guarantee that passing by value is efficient, nor that std::string is efficient for very long strings (although in practice that is probably true). However, IpeString is designed to be plug-in compatible with std::string, so Ipe can switch any time it is deemed appropriate (in particular, unlike the rest of Ipe, IpeString uses lower-case member names!).
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6"></a><!-- doxytag: member="IpeString::operator[]" ref="a6" args="(int i) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">char IpeString::operator[] </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>i</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return character at index i.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="IpeString::empty" ref="a7" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool IpeString::empty </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Is the string empty?
<p>
</td>
</tr>
</table>
<a class="anchor" name="a8"></a><!-- doxytag: member="IpeString::data" ref="a8" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* IpeString::data </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return read-only pointer to the data.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a9"></a><!-- doxytag: member="IpeString::size" ref="a9" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int IpeString::size </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return number of bytes in the string.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a10"></a><!-- doxytag: member="IpeString::operator+=" ref="a10" args="(const IpeString &rhs)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void IpeString::operator+= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="class_ipe_string.html">IpeString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Operator syntax for append.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a11"></a><!-- doxytag: member="IpeString::operator+=" ref="a11" args="(char ch)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void IpeString::operator+= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char </td>
<td class="mdname1" valign="top" nowrap> <em>ch</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Operator syntax for append.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a12"></a><!-- doxytag: member="IpeString::substr" ref="a12" args="(int i, int len=-1) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a> IpeString::substr </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>i</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>len</em> = <code>-1</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create substring.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a13"></a><!-- doxytag: member="IpeString::operator!=" ref="a13" args="(const IpeString &rhs) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool IpeString::operator!= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="class_ipe_string.html">IpeString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>rhs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Operator !=.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a20"></a><!-- doxytag: member="IpeString::unicode" ref="a20" args="(int &index) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int IpeString::unicode </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int & </td>
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return Unicode value from UTF-8 string.
<p>
The <em>index</em> is incremented to the next UTF-8 character. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipebase.h<li>ipebase.cpp</ul>
<hr>
</body></html>
|
