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
|
<!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">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></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="6fa380a17b3acb947d2cbee2a9319e20"></a><!-- doxytag: member="IpeString::IpeString" ref="6fa380a17b3acb947d2cbee2a9319e20" args="(const char *str)" -->
<b>IpeString</b> (const char *str)
<li><a class="anchor" name="011c1f6e518e275c18370b9792d8691e"></a><!-- doxytag: member="IpeString::IpeString" ref="011c1f6e518e275c18370b9792d8691e" args="(const IpeString &rhs)" -->
<b>IpeString</b> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs)
<li><a class="anchor" name="4ee42a4b0b126d1593e1a7e3a205e8b2"></a><!-- doxytag: member="IpeString::IpeString" ref="4ee42a4b0b126d1593e1a7e3a205e8b2" 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="f15f8d7367fa2cff0dc928a16a490562"></a><!-- doxytag: member="IpeString::operator=" ref="f15f8d7367fa2cff0dc928a16a490562" 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#dd2db7e4f81f9e45fbd843da04df1704">operator[]</a> (int i) const
<li>bool <a class="el" href="class_ipe_string.html#1f58dfb562bc67af888c9003780866af">empty</a> () const
<li>const char * <a class="el" href="class_ipe_string.html#f3a224477003933deb8f180347ca9640">data</a> () const
<li>int <a class="el" href="class_ipe_string.html#2bf7f7b36d58054bcf675c2fef7883e3">size</a> () const
<li>void <a class="el" href="class_ipe_string.html#1b41f72056c960e0c8fc4a80d10085cb">operator+=</a> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs)
<li>void <a class="el" href="class_ipe_string.html#43853ddf009eb504cb9680855544a655">operator+=</a> (char ch)
<li><a class="el" href="class_ipe_string.html">IpeString</a> <a class="el" href="class_ipe_string.html#9c60029593016a0d7af1870764b8c038">substr</a> (int i, int len=-1) const
<li>bool <a class="el" href="class_ipe_string.html#31fa4226c823cc133c7c4a4cc4513d1f">operator!=</a> (const <a class="el" href="class_ipe_string.html">IpeString</a> &rhs) const
<li><a class="anchor" name="53c5e1b68eb29ee68b6229dde2b9da3b"></a><!-- doxytag: member="IpeString::erase" ref="53c5e1b68eb29ee68b6229dde2b9da3b" args="()" -->
void <b>erase</b> ()
<li><a class="anchor" name="6c9b9e9c16334d3f8cd521a5dff1b960"></a><!-- doxytag: member="IpeString::append" ref="6c9b9e9c16334d3f8cd521a5dff1b960" 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="4fcf7262efc9c0632c8cf82ce53aaccd"></a><!-- doxytag: member="IpeString::append" ref="4fcf7262efc9c0632c8cf82ce53aaccd" args="(char ch)" -->
void <b>append</b> (char ch)
<li><a class="anchor" name="e2525dadf74d1d8587fabe053f96896f"></a><!-- doxytag: member="IpeString::operator==" ref="e2525dadf74d1d8587fabe053f96896f" 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="001d6a9771c6b73a707c85efd1e06d65"></a><!-- doxytag: member="IpeString::operator<" ref="001d6a9771c6b73a707c85efd1e06d65" 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="aeb01a88507ff849d6f380b3707c324b"></a><!-- doxytag: member="IpeString::operator+" ref="aeb01a88507ff849d6f380b3707c324b" 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#a4ba6e6cf4b5714ecfbd707a045b3b5c">unicode</a> (int &index) const
<li><a class="anchor" name="fd6b6641ca6634faf9c29ca5c21c2d53"></a><!-- doxytag: member="IpeString::CString" ref="fd6b6641ca6634faf9c29ca5c21c2d53" args="() const" -->
const char * <b>CString</b> () const
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Strings and buffers.
<p>
<a class="el" href="class_ipe_string.html">IpeString</a> 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 <a class="el" href="class_ipe_string.html">IpeString</a> is a single pointer). Sharing is implicit---the string creates its own representation as soon as it is modified.<p>
<a class="el" href="class_ipe_string.html">IpeString</a> 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, <a class="el" href="class_ipe_string.html">IpeString</a> 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, <a class="el" href="class_ipe_string.html">IpeString</a> uses lower-case member names!).
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="dd2db7e4f81f9e45fbd843da04df1704"></a><!-- doxytag: member="IpeString::operator[]" ref="dd2db7e4f81f9e45fbd843da04df1704" args="(int i) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char IpeString::operator[] </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return character at index i.
<p>
</div>
</div><p>
<a class="anchor" name="1f58dfb562bc67af888c9003780866af"></a><!-- doxytag: member="IpeString::empty" ref="1f58dfb562bc67af888c9003780866af" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IpeString::empty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Is the string empty?
<p>
</div>
</div><p>
<a class="anchor" name="f3a224477003933deb8f180347ca9640"></a><!-- doxytag: member="IpeString::data" ref="f3a224477003933deb8f180347ca9640" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* IpeString::data </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return read-only pointer to the data.
<p>
</div>
</div><p>
<a class="anchor" name="2bf7f7b36d58054bcf675c2fef7883e3"></a><!-- doxytag: member="IpeString::size" ref="2bf7f7b36d58054bcf675c2fef7883e3" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IpeString::size </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return number of bytes in the string.
<p>
</div>
</div><p>
<a class="anchor" name="1b41f72056c960e0c8fc4a80d10085cb"></a><!-- doxytag: member="IpeString::operator+=" ref="1b41f72056c960e0c8fc4a80d10085cb" args="(const IpeString &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IpeString::operator+= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_ipe_string.html">IpeString</a> & </td>
<td class="paramname"> <em>rhs</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Operator syntax for append.
<p>
</div>
</div><p>
<a class="anchor" name="43853ddf009eb504cb9680855544a655"></a><!-- doxytag: member="IpeString::operator+=" ref="43853ddf009eb504cb9680855544a655" args="(char ch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IpeString::operator+= </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"> <em>ch</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Operator syntax for append.
<p>
</div>
</div><p>
<a class="anchor" name="9c60029593016a0d7af1870764b8c038"></a><!-- doxytag: member="IpeString::substr" ref="9c60029593016a0d7af1870764b8c038" args="(int i, int len=-1) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_ipe_string.html">IpeString</a> IpeString::substr </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create substring.
<p>
</div>
</div><p>
<a class="anchor" name="31fa4226c823cc133c7c4a4cc4513d1f"></a><!-- doxytag: member="IpeString::operator!=" ref="31fa4226c823cc133c7c4a4cc4513d1f" args="(const IpeString &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IpeString::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_ipe_string.html">IpeString</a> & </td>
<td class="paramname"> <em>rhs</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Operator !=.
<p>
</div>
</div><p>
<a class="anchor" name="a4ba6e6cf4b5714ecfbd707a045b3b5c"></a><!-- doxytag: member="IpeString::unicode" ref="a4ba6e6cf4b5714ecfbd707a045b3b5c" args="(int &index) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IpeString::unicode </td>
<td>(</td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return Unicode value from UTF-8 string.
<p>
The <em>index</em> is incremented to the next UTF-8 character.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipebase.h<li>ipebase.cpp</ul>
<hr>
</body></html>
|
