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
|
<link rel="stylesheet" type="text/css" href="doxygen.css">
<center>
<a href="http://ekhtml.sourceforge.net">[El-Kabong Home]</a>
</center>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>ekhtml.h File Reference</h1>Main El-Kabong header file.
<a href="#_details">More...</a>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structekhtml__attr__t.html">ekhtml_attr_t</a></td></tr>
<tr><td> </td><td><font size=-1><em>Attribute object, passed into callbacks.</em> <a href="structekhtml__attr__t.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a></td></tr>
<tr><td> </td><td><font size=-1><em>A string object, which is not NUL terminated.</em> <a href="structekhtml__string__t.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="ekhtml.h::EKHTML_BLOCKSIZE"></a>
#define </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a0">EKHTML_BLOCKSIZE</a> (1024 * 4)</td></tr>
<tr><td> </td><td><font size=-1><em>EKHTML_BLOCKSIZE = # of blocks to allocate per chunk.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef ekhtml_string_t </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a1">ekhtml_string_t</a></td></tr>
<tr><td> </td><td><font size=-1><em>A string object, which is not NUL terminated.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>typedef ekhtml_attr_t </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a2">ekhtml_attr_t</a></td></tr>
<tr><td> </td><td><font size=-1><em>Attribute object, passed into callbacks.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>typedef ekhtml_parser_t </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a></td></tr>
<tr><td> </td><td><font size=-1><em>The parser object.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a4">ekhtml_data_cb_t</a> )(void *cbdata, <a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> *data)</td></tr>
<tr><td> </td><td><font size=-1><em>Callback for simple data.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a5">ekhtml_starttag_cb_t</a> )(void *cbdata, <a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> *tag, <a class="el" href="structekhtml__attr__t.html">ekhtml_attr_t</a> *attrs)</td></tr>
<tr><td> </td><td><font size=-1><em>Callback for start tags.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>typedef void(* </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a6">ekhtml_endtag_cb_t</a> )(void *cbdata, <a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> *tag)</td></tr>
<tr><td> </td><td><font size=-1><em>Callback for end tags.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a7">ekhtml_parser_new</a> (void *cbdata)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a new parser object.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a8">ekhtml_parser_destroy</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser)</td></tr>
<tr><td> </td><td><font size=-1><em>Destroys a parser object and all memory associated with it.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a9">ekhtml_parser_cbdata_set</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser, void *cbdata)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the callback data for the parser.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a10">ekhtml_parser_datacb_set</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser, <a class="el" href="ekhtml_8h.html#a4">ekhtml_data_cb_t</a> cb)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the parser's data callback.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a11">ekhtml_parser_commentcb_set</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser, <a class="el" href="ekhtml_8h.html#a4">ekhtml_data_cb_t</a> cb)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the parser's comment callback.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a12">ekhtml_parser_feed</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser, <a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> *data)</td></tr>
<tr><td> </td><td><font size=-1><em>Feed data for the parser to process.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a13">ekhtml_parser_flush</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser, int flushall)</td></tr>
<tr><td> </td><td><font size=-1><em>Flush the parser innards.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a14">ekhtml_parser_startcb_add</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser, const char *tag, <a class="el" href="ekhtml_8h.html#a5">ekhtml_starttag_cb_t</a> cb)</td></tr>
<tr><td> </td><td><font size=-1><em>Add a callback for a start tag.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="ekhtml_8h.html#a15">ekhtml_parser_endcb_add</a> (<a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> *parser, const char *tag, <a class="el" href="ekhtml_8h.html#a6">ekhtml_endtag_cb_t</a> cb)</td></tr>
<tr><td> </td><td><font size=-1><em>Add a callback for an end tag.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Main El-Kabong header file.
<p>
<p>
<p>
This header defines everything that a program should need to use the El-Kabong library.
<p>
<hr><h2>Typedef Documentation</h2>
<a name="a2" doxytag="ekhtml.h::ekhtml_attr_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct ekhtml_attr_t ekhtml_attr_t
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Attribute object, passed into callbacks.
<p>
When ekhtml parses tags containing key/value attributes, it will pass this structure representing those values into the callbacks. Note, for speed reasons, things such as the 'name' and 'value' fields are not terminated with '\0', and therefore have an associated length field (namelen, vallen). </td>
</tr>
</table>
<a name="a4" doxytag="ekhtml.h::ekhtml_data_cb_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef void(* ekhtml_data_cb_t)(void *cbdata, <a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> *data)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Callback for simple data.
<p>
Callback functions of this form are used to process data which is not part of a start or end tag. This callback may also be used to process the body of comment tags.
<p>
I.e. <FOO>data_to_process</FOO> The data passed into the callback function will be "data_to_process"<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cbdata</em> </td><td>
Callback data, as previously set by ekhtml_parser_cbdata_set </td></tr>
<tr><td valign=top><em>data</em> </td><td>
A pointer to the data in-between tags.</td></tr>
</table>
</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="ekhtml_8h.html#a9">ekhtml_parser_cbdata_set</a>() , <a class="el" href="ekhtml_8h.html#a10">ekhtml_parser_datacb_set</a>() </dl> </td>
</tr>
</table>
<a name="a6" doxytag="ekhtml.h::ekhtml_endtag_cb_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef void(* ekhtml_endtag_cb_t)(void *cbdata, <a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> *tag)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Callback for end tags.
<p>
Callback functions of this form are used to process end tags.
<p>
I.e. <FOO>data_to_process</FOO> The tag passed into the callback will be "FOO" with a length of 3.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cbdata</em> </td><td>
Callback data, as previously set by ekhtml_parser_cbdata_set </td></tr>
<tr><td valign=top><em>tag</em> </td><td>
A pointer to tag name. This is a traditional NUL terminated string.</td></tr>
</table>
</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="ekhtml_8h.html#a9">ekhtml_parser_cbdata_set</a>() , <a class="el" href="ekhtml_8h.html#a15">ekhtml_parser_endcb_add</a>() </dl> </td>
</tr>
</table>
<a name="a3" doxytag="ekhtml.h::ekhtml_parser_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct ekhtml_parser_t ekhtml_parser_t
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The parser object.
<p>
The parser object holds state information, such as which callbacks to invoke when reading tags, how much data is being processed, etc. </td>
</tr>
</table>
<a name="a5" doxytag="ekhtml.h::ekhtml_starttag_cb_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef void(* ekhtml_starttag_cb_t)(void *cbdata, <a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> *tag, <a class="el" href="structekhtml__attr__t.html">ekhtml_attr_t</a> *attrs)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Callback for start tags.
<p>
Callback functions of this form are used to process start tags.
<p>
I.e. <FOO>data_to_process</FOO> The tag passed into the callback will be "FOO" with a length of 3.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cbdata</em> </td><td>
Callback data, as previously set by ekhtml_parser_cbdata_set </td></tr>
<tr><td valign=top><em>tag</em> </td><td>
A pointer to tag name. This is a traditional NUL terminated string. </td></tr>
<tr><td valign=top><em>attrs</em> </td><td>
Attributes of the tag.</td></tr>
</table>
</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="ekhtml_8h.html#a9">ekhtml_parser_cbdata_set</a>() , <a class="el" href="ekhtml_8h.html#a14">ekhtml_parser_startcb_add</a>() </dl> </td>
</tr>
</table>
<a name="a1" doxytag="ekhtml.h::ekhtml_string_t"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct ekhtml_string_t ekhtml_string_t
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
A string object, which is not NUL terminated.
<p>
For speed reasons, El-Kabong does not deal with zero-terminated strings. </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a9" doxytag="ekhtml.h::ekhtml_parser_cbdata_set"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ekhtml_parser_cbdata_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname" nowrap> <em>parser</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>cbdata</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the callback data for the parser.
<p>
This routine sets the callback data which is passed to set callbacks.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
Parser to set the callback data for </td></tr>
<tr><td valign=top><em>cbdata</em> </td><td>
Callback data the parser should use to pass to callbacks </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a11" doxytag="ekhtml.h::ekhtml_parser_commentcb_set"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ekhtml_parser_commentcb_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname" nowrap> <em>parser</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="ekhtml_8h.html#a4">ekhtml_data_cb_t</a> </td>
<td class="mdname" nowrap> <em>cb</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the parser's comment callback.
<p>
This routine sets the callback which should be invoked when the parser processes a comment.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
Parser to set the callback for </td></tr>
<tr><td valign=top><em>cb</em> </td><td>
Callback to invoke when processing a comment </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a10" doxytag="ekhtml.h::ekhtml_parser_datacb_set"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ekhtml_parser_datacb_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname" nowrap> <em>parser</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="ekhtml_8h.html#a4">ekhtml_data_cb_t</a> </td>
<td class="mdname" nowrap> <em>cb</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the parser's data callback.
<p>
This routine sets the callback which should be invoked for non-tagged data.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
Parser to set the callback for </td></tr>
<tr><td valign=top><em>cb</em> </td><td>
Callback to invoke when processing non-tagged data </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a8" doxytag="ekhtml.h::ekhtml_parser_destroy"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ekhtml_parser_destroy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>parser</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destroys a parser object and all memory associated with it.
<p>
After calling this routine, the parser should no longer be used, as any results would be undefined.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
The parser to destroy</td></tr>
</table>
</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="ekhtml_8h.html#a7">ekhtml_parser_new</a>() </dl> </td>
</tr>
</table>
<a name="a15" doxytag="ekhtml.h::ekhtml_parser_endcb_add"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ekhtml_parser_endcb_add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname" nowrap> <em>parser</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>tag</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="ekhtml_8h.html#a6">ekhtml_endtag_cb_t</a> </td>
<td class="mdname" nowrap> <em>cb</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add a callback for an end tag.
<p>
This routine sets the callback which should be invoked when the parser processes an end tag. Both specific tags, and unknown tags can be used with this method.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
Parser to set the callback for </td></tr>
<tr><td valign=top><em>tag</em> </td><td>
Name of the tag to call `cb` for. If `tag` is NULL, then any tags which are unknown to the parser will be sent to the callback specified by `cb`. </td></tr>
<tr><td valign=top><em>cb</em> </td><td>
Callback to invoke </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a12" doxytag="ekhtml.h::ekhtml_parser_feed"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ekhtml_parser_feed </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname" nowrap> <em>parser</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structekhtml__string__t.html">ekhtml_string_t</a> * </td>
<td class="mdname" nowrap> <em>data</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Feed data for the parser to process.
<p>
Feed data into the HTML parser. This routine will fill up the internal buffer until it can go no more, then flush the data and refill. If there is more data that is required than the internal buffer can hold, it will be resized<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
Parser to feed data to </td></tr>
<tr><td valign=top><em>data</em> </td><td>
Data to feed to the parser </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a13" doxytag="ekhtml.h::ekhtml_parser_flush"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ekhtml_parser_flush </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname" nowrap> <em>parser</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>flushall</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Flush the parser innards.
<p>
When this function is invoked, the parser will flush all data that is currently held, and any remaining state is saved. All data which is processed is removed from the parser, and the internal buffer is reshuffled.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
Parser to flush </td></tr>
<tr><td valign=top><em>flushall</em> </td><td>
If true, will flush all data, even if tags are not complete (i.e. "<FO") </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
1 if action was taken (i.e. bytes were processed and the internal buffer was reshuffled) else 0 </dl> </td>
</tr>
</table>
<a name="a7" doxytag="ekhtml.h::ekhtml_parser_new"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a>* ekhtml_parser_new </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname1" valign="top" nowrap> <em>cbdata</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a new parser object.
<p>
This routine creates a new parser object, with no set callback functions or state.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>cbdata</em> </td><td>
Callback data to use when invoking callbacks</td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
A new ekhtml_parser_t object</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="ekhtml_8h.html#a9">ekhtml_parser_cbdata_set</a>() </dl> </td>
</tr>
</table>
<a name="a14" doxytag="ekhtml.h::ekhtml_parser_startcb_add"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ekhtml_parser_startcb_add </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="ekhtml_8h.html#a3">ekhtml_parser_t</a> * </td>
<td class="mdname" nowrap> <em>parser</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>tag</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="ekhtml_8h.html#a5">ekhtml_starttag_cb_t</a> </td>
<td class="mdname" nowrap> <em>cb</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add a callback for a start tag.
<p>
This routine sets the callback which should be invoked when the parser processes a start tag. Both specific tags, and unknown tags can be used with this method.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parser</em> </td><td>
Parser to set the callback for </td></tr>
<tr><td valign=top><em>tag</em> </td><td>
Name of the tag to call `cb` for. If `tag` is NULL, then any tags which are unknown to the parser will be sent to the callback specified by `cb`. </td></tr>
<tr><td valign=top><em>cb</em> </td><td>
Callback to invoke </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr><address><small>Generated on Sun Nov 10 15:54:34 2002 for ekhtml by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2002</small></address>
</body>
</html>
|
