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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libkate: Text manipulation</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.4 -->
<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><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<h1>Text manipulation</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text.html#gae4d3d9398e169a717a953979ed13bee">kate_text_get_character</a> (<a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> text_encoding, const char **const text, size_t *len0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text.html#g05f6feee792a3f42d01c490822ff20f9">kate_text_set_character</a> (<a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> text_encoding, int c, char **const text, size_t *len0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text.html#g406a2311d578dad99bb5ec139cba2cb4">kate_text_remove_markup</a> (<a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> text_encoding, char *text, size_t *len0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__text.html#gf039cd8bf94f2ad66ad65443e3aa5525">kate_text_validate</a> (<a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> text_encoding, const char *text, size_t len0)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gae4d3d9398e169a717a953979ed13bee"></a><!-- doxytag: member="kate_text.c::kate_text_get_character" ref="gae4d3d9398e169a717a953979ed13bee" args="(kate_text_encoding text_encoding, const char **const text, size_t *len0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_text_get_character </td>
<td>(</td>
<td class="paramtype"><a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> </td>
<td class="paramname"> <em>text_encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **const </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>len0</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a code point from the string, advancing the text pointer to the next one. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text_encoding</em> </td><td>the character encoding the text is coded in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>a pointer to the text pointer, to be advanced to the next character on success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len0</em> </td><td>a pointer to the length of the buffer, including any terminating NUL, to be decreased by the number of bytes that text is advanced on success </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>>=0 success, the unicode code point read <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g406a2311d578dad99bb5ec139cba2cb4"></a><!-- doxytag: member="kate_text.c::kate_text_remove_markup" ref="g406a2311d578dad99bb5ec139cba2cb4" args="(kate_text_encoding text_encoding, char *text, size_t *len0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_text_remove_markup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> </td>
<td class="paramname"> <em>text_encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>len0</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes markup from the given text. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text_encoding</em> </td><td>the character encoding the text is coded in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>the text to remove markup from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len0</em> </td><td>the length in bytes of the text, including any terminating NUL - will be set to the length of the text with markup removed, including any terminating NUL </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="g05f6feee792a3f42d01c490822ff20f9"></a><!-- doxytag: member="kate_text.c::kate_text_set_character" ref="g05f6feee792a3f42d01c490822ff20f9" args="(kate_text_encoding text_encoding, int c, char **const text, size_t *len0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_text_set_character </td>
<td>(</td>
<td class="paramtype"><a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> </td>
<td class="paramname"> <em>text_encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char **const </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>len0</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Writes a code point to the given string, advancing the text pointer to the next byte. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text_encoding</em> </td><td>the character encoding the text is coded in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>the unicode code point to write to the string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>a pointer to the text pointer, to be advanced to the next character on success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len0</em> </td><td>a pointer to the length of the buffer, including any terminating NUL, to be decreased by the number of bytes that text is advanced on success </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>>=0 success, the number of bytes used to write this code point <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<a class="anchor" name="gf039cd8bf94f2ad66ad65443e3aa5525"></a><!-- doxytag: member="kate_text.c::kate_text_validate" ref="gf039cd8bf94f2ad66ad65443e3aa5525" args="(kate_text_encoding text_encoding, const char *text, size_t len0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_text_validate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="kate_8h.html#9e8a915382d068016312baad10053902">kate_text_encoding</a> </td>
<td class="paramname"> <em>text_encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len0</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Validates text for the given character encoding, flagging partial sequences and invalid sequences. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text_encoding</em> </td><td>the character encoding the text is coded in </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>the text to validate (may include embedded NULs) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len0</em> </td><td>the length in bytes of the text, including any terminating NUL </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Nov 15 17:26:07 2009 for libkate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
|
