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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Error: liblangtag Documentation</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="liblangtag Documentation">
<link rel="up" href="Utilities.html" title="Utilities APIs">
<link rel="prev" href="liblangtag-Miscellaneous-Macros.html" title="Miscellaneous Macros">
<link rel="next" href="liblangtag-Doubly-Linked-Lists.html" title="Doubly-Linked Lists">
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#liblangtag-Error.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Utilities.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="liblangtag-Miscellaneous-Macros.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="liblangtag-Doubly-Linked-Lists.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="liblangtag-Error"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="liblangtag-Error.top_of_page"></a>Error</span></h2>
<p>Error — Error handling</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="liblangtag-Error.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="returnvalue">lt_error_t</span></a> *
</td>
<td class="function_name">
<a class="link" href="liblangtag-Error.html#lt-error-new" title="lt_error_new ()">lt_error_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="returnvalue">lt_error_t</span></a> *
</td>
<td class="function_name">
<a class="link" href="liblangtag-Error.html#lt-error-ref" title="lt_error_ref ()">lt_error_ref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="liblangtag-Error.html#lt-error-unref" title="lt_error_unref ()">lt_error_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="returnvalue">lt_error_t</span></a> *
</td>
<td class="function_name">
<a class="link" href="liblangtag-Error.html#lt-error-set" title="lt_error_set ()">lt_error_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="liblangtag-Error.html#lt-error-clear" title="lt_error_clear ()">lt_error_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="liblangtag-Miscellaneous-Macros.html#lt-bool-t" title="lt_bool_t"><span class="returnvalue">lt_bool_t</span></a>
</td>
<td class="function_name">
<a class="link" href="liblangtag-Error.html#lt-error-is-set" title="lt_error_is_set ()">lt_error_is_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="liblangtag-Error.html#lt-error-print" title="lt_error_print ()">lt_error_print</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="liblangtag-Error.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="liblangtag-Error.html#lt-error-type-t" title="enum lt_error_type_t">lt_error_type_t</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t">lt_error_t</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="liblangtag-Error.description"></a><h2>Description</h2>
<p>This section describes the error handling in this library.</p>
</div>
<div class="refsect1">
<a name="liblangtag-Error.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="lt-error-new"></a><h3>lt_error_new ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="returnvalue">lt_error_t</span></a> *
lt_error_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> object. this function is protected and not supposed
to use in applications directly. Use <a class="link" href="liblangtag-Error.html#lt-error-set" title="lt_error_set ()"><code class="function">lt_error_set()</code></a>.</p>
<div class="refsect3">
<a name="lt-error-new.returns"></a><h4>Returns</h4>
<p>a newly allocated <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a>. it has to be freed
with <a class="link" href="liblangtag-Error.html#lt-error-unref" title="lt_error_unref ()"><code class="function">lt_error_unref()</code></a>. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lt-error-ref"></a><h3>lt_error_ref ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="returnvalue">lt_error_t</span></a> *
lt_error_ref (<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> *error</code></em>);</pre>
<p>Inscreases the reference count of <em class="parameter"><code>error</code></em>
.</p>
<div class="refsect3">
<a name="lt-error-ref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lt-error-ref.returns"></a><h4>Returns</h4>
<p>the same <em class="parameter"><code>error</code></em>
object. </p>
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lt-error-unref"></a><h3>lt_error_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
lt_error_unref (<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> *error</code></em>);</pre>
<p>Decreases the reference count of <em class="parameter"><code>error</code></em>
. when its reference count
drops to 0, the object is finalized (i.e. its memory is freed).</p>
<div class="refsect3">
<a name="lt-error-unref.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lt-error-set"></a><h3>lt_error_set ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="returnvalue">lt_error_t</span></a> *
lt_error_set (<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> **error</code></em>,
<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-type-t" title="enum lt_error_type_t"><span class="type">lt_error_type_t</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *message</code></em>);</pre>
<p>Sets the error into <em class="parameter"><code>error</code></em>
according to the given parameters.</p>
<div class="refsect3">
<a name="lt-error-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a return location for a <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-type-t" title="enum lt_error_type_t"><span class="type">lt_error_type_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>the string format to output the error messages</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the parameters to insert into the format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lt-error-set.returns"></a><h4>Returns</h4>
<p> an instance of <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lt-error-clear"></a><h3>lt_error_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
lt_error_clear (<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> *error</code></em>);</pre>
<p>Clean up all of the errors in <em class="parameter"><code>error</code></em>
.</p>
<div class="refsect3">
<a name="lt-error-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lt-error-is-set"></a><h3>lt_error_is_set ()</h3>
<pre class="programlisting"><a class="link" href="liblangtag-Miscellaneous-Macros.html#lt-bool-t" title="lt_bool_t"><span class="returnvalue">lt_bool_t</span></a>
lt_error_is_set (<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> *error</code></em>,
<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-type-t" title="enum lt_error_type_t"><span class="type">lt_error_type_t</span></a> type</code></em>);</pre>
<p>Checks if <em class="parameter"><code>error</code></em>
contains <em class="parameter"><code>type</code></em>
of errors. if <a class="link" href="liblangtag-Error.html#LT-ERR-ANY:CAPS"><span class="type">LT_ERR_ANY</span></a> is set to <em class="parameter"><code>type</code></em>
,
all the types of the errors are targeted. otherwise the result is filtered
out by <em class="parameter"><code>type</code></em>
.</p>
<div class="refsect3">
<a name="lt-error-is-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-type-t" title="enum lt_error_type_t"><span class="type">lt_error_type_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="lt-error-is-set.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if any, otherwise <code class="literal">FALSE</code></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lt-error-print"></a><h3>lt_error_print ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
lt_error_print (<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> *error</code></em>,
<em class="parameter"><code><a class="link" href="liblangtag-Error.html#lt-error-type-t" title="enum lt_error_type_t"><span class="type">lt_error_type_t</span></a> type</code></em>);</pre>
<p>Output the error messages in <em class="parameter"><code>error</code></em>
according to <em class="parameter"><code>type</code></em>
.</p>
<div class="refsect3">
<a name="lt-error-print.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>a <a class="link" href="liblangtag-Error.html#lt-error-type-t" title="enum lt_error_type_t"><span class="type">lt_error_type_t</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="liblangtag-Error.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="lt-error-type-t"></a><h3>enum lt_error_type_t</h3>
<p>Error code used in this library.</p>
<div class="refsect3">
<a name="lt-error-type-t.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-UNKNOWN:CAPS"></a>LT_ERR_UNKNOWN</p></td>
<td class="enum_member_description">
<p>unknown error happened.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-SUCCESS:CAPS"></a>LT_ERR_SUCCESS</p></td>
<td class="enum_member_description">
<p>an operation is succeeded.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-OOM:CAPS"></a>LT_ERR_OOM</p></td>
<td class="enum_member_description">
<p>Out of memory occurred.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-FAIL-ON-XML:CAPS"></a>LT_ERR_FAIL_ON_XML</p></td>
<td class="enum_member_description">
<p>an error happened in libxml2.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-EOT:CAPS"></a>LT_ERR_EOT</p></td>
<td class="enum_member_description">
<p>No tokens to scan.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-FAIL-ON-SCANNER:CAPS"></a>LT_ERR_FAIL_ON_SCANNER</p></td>
<td class="enum_member_description">
<p>an error happened in the scanner.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-NO-TAG:CAPS"></a>LT_ERR_NO_TAG</p></td>
<td class="enum_member_description">
<p>No tags to process.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-INVALID:CAPS"></a>LT_ERR_INVALID</p></td>
<td class="enum_member_description">
<p>Invalid operation.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="LT-ERR-ANY:CAPS"></a>LT_ERR_ANY</p></td>
<td class="enum_member_description">
<p>No real error, but just a flag to query all of errors or ask
if any errors happen</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lt-error-t"></a><h3>lt_error_t</h3>
<pre class="programlisting">typedef struct _lt_error_t lt_error_t;</pre>
<p>All the fields in the <span class="structname">lt_error_t</span>
structure are private to the <a class="link" href="liblangtag-Error.html#lt-error-t" title="lt_error_t"><span class="type">lt_error_t</span></a> implementation.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>
|
