Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / ef90ba7e3b530a8eb9ed27f57f0ced139b839780 / . / doc / html / libxml-docbparser.html
blob: d205393e7393cee0b9348797e6137857598899bd [file] [log] [blame]
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1<HTML
2><HEAD
3><TITLE
4>DOCBparser</TITLE
5><META
6NAME="GENERATOR"
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]7CONTENT="Modular DocBook HTML Stylesheet Version 1.64
8"><LINK
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]9REL="HOME"
10TITLE="Gnome XML Library Reference Manual"
11HREF="book1.html"><LINK
12REL="UP"
13TITLE="Libxml Library Reference"
14HREF="libxml-lib.html"><LINK
15REL="PREVIOUS"
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]16TITLE="globals"
17HREF="libxml-globals.html"><LINK
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]18REL="NEXT"
19TITLE="parserInternals"
20HREF="libxml-parserinternals.html"></HEAD
21><BODY
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]22CLASS="REFENTRY"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]23BGCOLOR="#FFFFFF"
24TEXT="#000000"
25LINK="#0000FF"
26VLINK="#840084"
27ALINK="#0000FF"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31WIDTH="100%"
32BORDER="0"
33BGCOLOR="#000000"
34CELLPADDING="1"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="4"
39ALIGN="center"
40><FONT
41COLOR="#FFFFFF"
42SIZE="5"
43>Gnome XML Library Reference Manual</FONT
44></TH
45></TR
46><TR
47><TD
48WIDTH="25%"
49BGCOLOR="#C00000"
50ALIGN="left"
51><A
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]52HREF="libxml-globals.html"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]53><FONT
54COLOR="#FFFFFF"
55SIZE="3"
56><B
57>&#60;&#60;&#60; Previous Page</B
58></FONT
59></A
60></TD
61><TD
62WIDTH="25%"
63BGCOLOR="#0000C0"
64ALIGN="center"
65><FONT
66COLOR="#FFFFFF"
67SIZE="3"
68><B
69><A
70HREF="book1.html"
71><FONT
72COLOR="#FFFFFF"
73SIZE="3"
74><B
75>Home</B
76></FONT
77></A
78></B
79></FONT
80></TD
81><TD
82WIDTH="25%"
83BGCOLOR="#00C000"
84ALIGN="center"
85><FONT
86COLOR="#FFFFFF"
87SIZE="3"
88><B
89><A
90HREF="libxml-lib.html"
91><FONT
92COLOR="#FFFFFF"
93SIZE="3"
94><B
95>Up</B
96></FONT
97></A
98></B
99></FONT
100></TD
101><TD
102WIDTH="25%"
103BGCOLOR="#C00000"
104ALIGN="right"
105><A
106HREF="libxml-parserinternals.html"
107><FONT
108COLOR="#FFFFFF"
109SIZE="3"
110><B
111>Next Page &#62;&#62;&#62;</B
112></FONT
113></A
114></TD
115></TR
116></TABLE
117></DIV
118><H1
119><A
120NAME="LIBXML-DOCBPARSER"
121>DOCBparser</A
122></H1
123><DIV
124CLASS="REFNAMEDIV"
125><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]126NAME="AEN20408"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]127></A
128><H2
129>Name</H2
130>DOCBparser&nbsp;--&nbsp;</DIV
131><DIV
132CLASS="REFSYNOPSISDIV"
133><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]134NAME="AEN20411"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]135></A
136><H2
137>Synopsis</H2
138><TABLE
139BORDER="0"
140BGCOLOR="#D6E8FF"
141WIDTH="100%"
142CELLPADDING="6"
143><TR
144><TD
145><PRE
146CLASS="SYNOPSIS"
147>&#13;
148
149typedef <A
150HREF="libxml-docbparser.html#DOCBPARSERCTXT"
151>docbParserCtxt</A
152>;
153typedef <A
154HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
155>docbParserCtxtPtr</A
156>;
157typedef <A
158HREF="libxml-docbparser.html#DOCBPARSERNODEINFO"
159>docbParserNodeInfo</A
160>;
161typedef <A
162HREF="libxml-docbparser.html#DOCBSAXHANDLER"
163>docbSAXHandler</A
164>;
165typedef <A
166HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
167>docbSAXHandlerPtr</A
168>;
169typedef <A
170HREF="libxml-docbparser.html#DOCBPARSERINPUT"
171>docbParserInput</A
172>;
173typedef <A
174HREF="libxml-docbparser.html#DOCBPARSERINPUTPTR"
175>docbParserInputPtr</A
176>;
177typedef <A
178HREF="libxml-docbparser.html#DOCBDOCPTR"
179>docbDocPtr</A
180>;
181typedef <A
182HREF="libxml-docbparser.html#DOCBNODEPTR"
183>docbNodePtr</A
184>;
185int <A
186HREF="libxml-docbparser.html#DOCBENCODEENTITIES"
187>docbEncodeEntities</A
188> (unsigned char *out,
189 int *outlen,
190 unsigned char *in,
191 int *inlen,
192 int quoteChar);
193<A
194HREF="libxml-docbparser.html#DOCBDOCPTR"
195>docbDocPtr</A
196> <A
197HREF="libxml-docbparser.html#DOCBSAXPARSEDOC"
198>docbSAXParseDoc</A
199> (<A
200HREF="libxml-tree.html#XMLCHAR"
201>xmlChar</A
202> *cur,
203 const char *encoding,
204 <A
205HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
206>docbSAXHandlerPtr</A
207> sax,
208 void *userData);
209<A
210HREF="libxml-docbparser.html#DOCBDOCPTR"
211>docbDocPtr</A
212> <A
213HREF="libxml-docbparser.html#DOCBPARSEDOC"
214>docbParseDoc</A
215> (<A
216HREF="libxml-tree.html#XMLCHAR"
217>xmlChar</A
218> *cur,
219 const char *encoding);
220<A
221HREF="libxml-docbparser.html#DOCBDOCPTR"
222>docbDocPtr</A
223> <A
224HREF="libxml-docbparser.html#DOCBSAXPARSEFILE"
225>docbSAXParseFile</A
226> (const char *filename,
227 const char *encoding,
228 <A
229HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
230>docbSAXHandlerPtr</A
231> sax,
232 void *userData);
233<A
234HREF="libxml-docbparser.html#DOCBDOCPTR"
235>docbDocPtr</A
236> <A
237HREF="libxml-docbparser.html#DOCBPARSEFILE"
238>docbParseFile</A
239> (const char *filename,
240 const char *encoding);
241void <A
242HREF="libxml-docbparser.html#DOCBFREEPARSERCTXT"
243>docbFreeParserCtxt</A
244> (<A
245HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
246>docbParserCtxtPtr</A
247> ctxt);
248<A
249HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
250>docbParserCtxtPtr</A
251> <A
252HREF="libxml-docbparser.html#DOCBCREATEPUSHPARSERCTXT"
253>docbCreatePushParserCtxt</A
254> (<A
255HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
256>docbSAXHandlerPtr</A
257> sax,
258 void *user_data,
259 const char *chunk,
260 int size,
261 const char *filename,
262 <A
263HREF="libxml-encoding.html#XMLCHARENCODING"
264>xmlCharEncoding</A
265> enc);
266int <A
267HREF="libxml-docbparser.html#DOCBPARSECHUNK"
268>docbParseChunk</A
269> (<A
270HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
271>docbParserCtxtPtr</A
272> ctxt,
273 const char *chunk,
274 int size,
275 int terminate);
276<A
277HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
278>docbParserCtxtPtr</A
279> <A
280HREF="libxml-docbparser.html#DOCBCREATEFILEPARSERCTXT"
281>docbCreateFileParserCtxt</A
282> (const char *filename,
283 const char *encoding);
284int <A
285HREF="libxml-docbparser.html#DOCBPARSEDOCUMENT"
286>docbParseDocument</A
287> (<A
288HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
289>docbParserCtxtPtr</A
290> ctxt);</PRE
291></TD
292></TR
293></TABLE
294></DIV
295><DIV
296CLASS="REFSECT1"
297><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]298NAME="AEN20448"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]299></A
300><H2
301>Description</H2
302><P
303></P
304></DIV
305><DIV
306CLASS="REFSECT1"
307><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]308NAME="AEN20451"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]309></A
310><H2
311>Details</H2
312><DIV
313CLASS="REFSECT2"
314><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]315NAME="AEN20453"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]316></A
317><H3
318><A
319NAME="DOCBPARSERCTXT"
320></A
321>docbParserCtxt</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]322><TABLE
323BORDER="0"
324BGCOLOR="#D6E8FF"
325WIDTH="100%"
326CELLPADDING="6"
327><TR
328><TD
329><PRE
330CLASS="PROGRAMLISTING"
331>typedef xmlParserCtxt docbParserCtxt;</PRE
332></TD
333></TR
334></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]335><P
336></P
337></DIV
338><HR><DIV
339CLASS="REFSECT2"
340><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]341NAME="AEN20458"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]342></A
343><H3
344><A
345NAME="DOCBPARSERCTXTPTR"
346></A
347>docbParserCtxtPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]348><TABLE
349BORDER="0"
350BGCOLOR="#D6E8FF"
351WIDTH="100%"
352CELLPADDING="6"
353><TR
354><TD
355><PRE
356CLASS="PROGRAMLISTING"
357>typedef xmlParserCtxtPtr docbParserCtxtPtr;</PRE
358></TD
359></TR
360></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]361><P
362></P
363></DIV
364><HR><DIV
365CLASS="REFSECT2"
366><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]367NAME="AEN20463"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]368></A
369><H3
370><A
371NAME="DOCBPARSERNODEINFO"
372></A
373>docbParserNodeInfo</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]374><TABLE
375BORDER="0"
376BGCOLOR="#D6E8FF"
377WIDTH="100%"
378CELLPADDING="6"
379><TR
380><TD
381><PRE
382CLASS="PROGRAMLISTING"
383>typedef xmlParserNodeInfo docbParserNodeInfo;</PRE
384></TD
385></TR
386></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]387><P
388></P
389></DIV
390><HR><DIV
391CLASS="REFSECT2"
392><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]393NAME="AEN20468"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]394></A
395><H3
396><A
397NAME="DOCBSAXHANDLER"
398></A
399>docbSAXHandler</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]400><TABLE
401BORDER="0"
402BGCOLOR="#D6E8FF"
403WIDTH="100%"
404CELLPADDING="6"
405><TR
406><TD
407><PRE
408CLASS="PROGRAMLISTING"
409>typedef xmlSAXHandler docbSAXHandler;</PRE
410></TD
411></TR
412></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]413><P
414></P
415></DIV
416><HR><DIV
417CLASS="REFSECT2"
418><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]419NAME="AEN20473"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]420></A
421><H3
422><A
423NAME="DOCBSAXHANDLERPTR"
424></A
425>docbSAXHandlerPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]426><TABLE
427BORDER="0"
428BGCOLOR="#D6E8FF"
429WIDTH="100%"
430CELLPADDING="6"
431><TR
432><TD
433><PRE
434CLASS="PROGRAMLISTING"
435>typedef xmlSAXHandlerPtr docbSAXHandlerPtr;</PRE
436></TD
437></TR
438></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]439><P
440></P
441></DIV
442><HR><DIV
443CLASS="REFSECT2"
444><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]445NAME="AEN20478"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]446></A
447><H3
448><A
449NAME="DOCBPARSERINPUT"
450></A
451>docbParserInput</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]452><TABLE
453BORDER="0"
454BGCOLOR="#D6E8FF"
455WIDTH="100%"
456CELLPADDING="6"
457><TR
458><TD
459><PRE
460CLASS="PROGRAMLISTING"
461>typedef xmlParserInput docbParserInput;</PRE
462></TD
463></TR
464></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]465><P
466></P
467></DIV
468><HR><DIV
469CLASS="REFSECT2"
470><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]471NAME="AEN20483"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]472></A
473><H3
474><A
475NAME="DOCBPARSERINPUTPTR"
476></A
477>docbParserInputPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]478><TABLE
479BORDER="0"
480BGCOLOR="#D6E8FF"
481WIDTH="100%"
482CELLPADDING="6"
483><TR
484><TD
485><PRE
486CLASS="PROGRAMLISTING"
487>typedef xmlParserInputPtr docbParserInputPtr;</PRE
488></TD
489></TR
490></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]491><P
492></P
493></DIV
494><HR><DIV
495CLASS="REFSECT2"
496><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]497NAME="AEN20488"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]498></A
499><H3
500><A
501NAME="DOCBDOCPTR"
502></A
503>docbDocPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]504><TABLE
505BORDER="0"
506BGCOLOR="#D6E8FF"
507WIDTH="100%"
508CELLPADDING="6"
509><TR
510><TD
511><PRE
512CLASS="PROGRAMLISTING"
513>typedef xmlDocPtr docbDocPtr;</PRE
514></TD
515></TR
516></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]517><P
518></P
519></DIV
520><HR><DIV
521CLASS="REFSECT2"
522><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]523NAME="AEN20493"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]524></A
525><H3
526><A
527NAME="DOCBNODEPTR"
528></A
529>docbNodePtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]530><TABLE
531BORDER="0"
532BGCOLOR="#D6E8FF"
533WIDTH="100%"
534CELLPADDING="6"
535><TR
536><TD
537><PRE
538CLASS="PROGRAMLISTING"
539>typedef xmlNodePtr docbNodePtr;</PRE
540></TD
541></TR
542></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]543><P
544></P
545></DIV
546><HR><DIV
547CLASS="REFSECT2"
548><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]549NAME="AEN20498"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]550></A
551><H3
552><A
553NAME="DOCBENCODEENTITIES"
554></A
555>docbEncodeEntities ()</H3
556><TABLE
557BORDER="0"
558BGCOLOR="#D6E8FF"
559WIDTH="100%"
560CELLPADDING="6"
561><TR
562><TD
563><PRE
564CLASS="PROGRAMLISTING"
565>int docbEncodeEntities (unsigned char *out,
566 int *outlen,
567 unsigned char *in,
568 int *inlen,
569 int quoteChar);</PRE
570></TD
571></TR
572></TABLE
573><P
574>Take a block of UTF-8 chars in and try to convert it to an ASCII
575plus SGML entities block of chars out.</P
576><P
577></P
578><DIV
579CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]580><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]581NAME="AEN20504"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]582></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]583><P
584></P
585><TABLE
586BORDER="0"
587WIDTH="100%"
588BGCOLOR="#FFD0D0"
589CELLSPACING="0"
590CELLPADDING="4"
591CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]592><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]593><TR
594><TD
595WIDTH="20%"
596ALIGN="RIGHT"
597VALIGN="TOP"
598><TT
599CLASS="PARAMETER"
600><I
601>out</I
602></TT
603>&nbsp;:</TD
604><TD
605WIDTH="80%"
606ALIGN="LEFT"
607VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]608> a pointer to an array of bytes to store the result</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]609></TR
610><TR
611><TD
612WIDTH="20%"
613ALIGN="RIGHT"
614VALIGN="TOP"
615><TT
616CLASS="PARAMETER"
617><I
618>outlen</I
619></TT
620>&nbsp;:</TD
621><TD
622WIDTH="80%"
623ALIGN="LEFT"
624VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]625> the length of <TT
626CLASS="PARAMETER"
627><I
628>out</I
629></TT
630></TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]631></TR
632><TR
633><TD
634WIDTH="20%"
635ALIGN="RIGHT"
636VALIGN="TOP"
637><TT
638CLASS="PARAMETER"
639><I
640>in</I
641></TT
642>&nbsp;:</TD
643><TD
644WIDTH="80%"
645ALIGN="LEFT"
646VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]647> a pointer to an array of UTF-8 chars</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]648></TR
649><TR
650><TD
651WIDTH="20%"
652ALIGN="RIGHT"
653VALIGN="TOP"
654><TT
655CLASS="PARAMETER"
656><I
657>inlen</I
658></TT
659>&nbsp;:</TD
660><TD
661WIDTH="80%"
662ALIGN="LEFT"
663VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]664> the length of <TT
665CLASS="PARAMETER"
666><I
667>in</I
668></TT
669></TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]670></TR
671><TR
672><TD
673WIDTH="20%"
674ALIGN="RIGHT"
675VALIGN="TOP"
676><TT
677CLASS="PARAMETER"
678><I
679>quoteChar</I
680></TT
681>&nbsp;:</TD
682><TD
683WIDTH="80%"
684ALIGN="LEFT"
685VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]686> the quote character to escape (' or ") or zero.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]687></TR
688><TR
689><TD
690WIDTH="20%"
691ALIGN="RIGHT"
692VALIGN="TOP"
693><I
694CLASS="EMPHASIS"
695>Returns</I
696> :</TD
697><TD
698WIDTH="80%"
699ALIGN="LEFT"
700VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]701>0 if success, -2 if the transcoding fails, or -1 otherwise
702The value of <TT
703CLASS="PARAMETER"
704><I
705>inlen</I
706></TT
707> after return is the number of octets consumed
708as the return value is positive, else unpredictiable.
709The value of <TT
710CLASS="PARAMETER"
711><I
712>outlen</I
713></TT
714> after return is the number of octets consumed.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]715></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]716></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]717></TABLE
718><P
719></P
720></DIV
721></DIV
722><HR><DIV
723CLASS="REFSECT2"
724><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]725NAME="AEN20537"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]726></A
727><H3
728><A
729NAME="DOCBSAXPARSEDOC"
730></A
731>docbSAXParseDoc ()</H3
732><TABLE
733BORDER="0"
734BGCOLOR="#D6E8FF"
735WIDTH="100%"
736CELLPADDING="6"
737><TR
738><TD
739><PRE
740CLASS="PROGRAMLISTING"
741><A
742HREF="libxml-docbparser.html#DOCBDOCPTR"
743>docbDocPtr</A
744> docbSAXParseDoc (<A
745HREF="libxml-tree.html#XMLCHAR"
746>xmlChar</A
747> *cur,
748 const char *encoding,
749 <A
750HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
751>docbSAXHandlerPtr</A
752> sax,
753 void *userData);</PRE
754></TD
755></TR
756></TABLE
757><P
758>parse an SGML in-memory document and build a tree.
759It use the given SAX function block to handle the parsing callback.
760If sax is NULL, fallback to the default DOM tree building routines.</P
761><P
762></P
763><DIV
764CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]765><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]766NAME="AEN20546"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]767></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]768><P
769></P
770><TABLE
771BORDER="0"
772WIDTH="100%"
773BGCOLOR="#FFD0D0"
774CELLSPACING="0"
775CELLPADDING="4"
776CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]777><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]778><TR
779><TD
780WIDTH="20%"
781ALIGN="RIGHT"
782VALIGN="TOP"
783><TT
784CLASS="PARAMETER"
785><I
786>cur</I
787></TT
788>&nbsp;:</TD
789><TD
790WIDTH="80%"
791ALIGN="LEFT"
792VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]793> a pointer to an array of xmlChar</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]794></TR
795><TR
796><TD
797WIDTH="20%"
798ALIGN="RIGHT"
799VALIGN="TOP"
800><TT
801CLASS="PARAMETER"
802><I
803>encoding</I
804></TT
805>&nbsp;:</TD
806><TD
807WIDTH="80%"
808ALIGN="LEFT"
809VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]810> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]811></TR
812><TR
813><TD
814WIDTH="20%"
815ALIGN="RIGHT"
816VALIGN="TOP"
817><TT
818CLASS="PARAMETER"
819><I
820>sax</I
821></TT
822>&nbsp;:</TD
823><TD
824WIDTH="80%"
825ALIGN="LEFT"
826VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]827> the SAX handler block</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]828></TR
829><TR
830><TD
831WIDTH="20%"
832ALIGN="RIGHT"
833VALIGN="TOP"
834><TT
835CLASS="PARAMETER"
836><I
837>userData</I
838></TT
839>&nbsp;:</TD
840><TD
841WIDTH="80%"
842ALIGN="LEFT"
843VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]844> if using SAX, this pointer will be provided on callbacks. </TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]845></TR
846><TR
847><TD
848WIDTH="20%"
849ALIGN="RIGHT"
850VALIGN="TOP"
851><I
852CLASS="EMPHASIS"
853>Returns</I
854> :</TD
855><TD
856WIDTH="80%"
857ALIGN="LEFT"
858VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]859>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]860></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]861></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]862></TABLE
863><P
864></P
865></DIV
866></DIV
867><HR><DIV
868CLASS="REFSECT2"
869><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]870NAME="AEN20571"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]871></A
872><H3
873><A
874NAME="DOCBPARSEDOC"
875></A
876>docbParseDoc ()</H3
877><TABLE
878BORDER="0"
879BGCOLOR="#D6E8FF"
880WIDTH="100%"
881CELLPADDING="6"
882><TR
883><TD
884><PRE
885CLASS="PROGRAMLISTING"
886><A
887HREF="libxml-docbparser.html#DOCBDOCPTR"
888>docbDocPtr</A
889> docbParseDoc (<A
890HREF="libxml-tree.html#XMLCHAR"
891>xmlChar</A
892> *cur,
893 const char *encoding);</PRE
894></TD
895></TR
896></TABLE
897><P
898>parse an SGML in-memory document and build a tree.</P
899><P
900></P
901><DIV
902CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]903><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]904NAME="AEN20579"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]905></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]906><P
907></P
908><TABLE
909BORDER="0"
910WIDTH="100%"
911BGCOLOR="#FFD0D0"
912CELLSPACING="0"
913CELLPADDING="4"
914CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]915><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]916><TR
917><TD
918WIDTH="20%"
919ALIGN="RIGHT"
920VALIGN="TOP"
921><TT
922CLASS="PARAMETER"
923><I
924>cur</I
925></TT
926>&nbsp;:</TD
927><TD
928WIDTH="80%"
929ALIGN="LEFT"
930VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]931> a pointer to an array of xmlChar</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]932></TR
933><TR
934><TD
935WIDTH="20%"
936ALIGN="RIGHT"
937VALIGN="TOP"
938><TT
939CLASS="PARAMETER"
940><I
941>encoding</I
942></TT
943>&nbsp;:</TD
944><TD
945WIDTH="80%"
946ALIGN="LEFT"
947VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]948> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]949></TR
950><TR
951><TD
952WIDTH="20%"
953ALIGN="RIGHT"
954VALIGN="TOP"
955><I
956CLASS="EMPHASIS"
957>Returns</I
958> :</TD
959><TD
960WIDTH="80%"
961ALIGN="LEFT"
962VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]963>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]964></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]965></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]966></TABLE
967><P
968></P
969></DIV
970></DIV
971><HR><DIV
972CLASS="REFSECT2"
973><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]974NAME="AEN20596"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]975></A
976><H3
977><A
978NAME="DOCBSAXPARSEFILE"
979></A
980>docbSAXParseFile ()</H3
981><TABLE
982BORDER="0"
983BGCOLOR="#D6E8FF"
984WIDTH="100%"
985CELLPADDING="6"
986><TR
987><TD
988><PRE
989CLASS="PROGRAMLISTING"
990><A
991HREF="libxml-docbparser.html#DOCBDOCPTR"
992>docbDocPtr</A
993> docbSAXParseFile (const char *filename,
994 const char *encoding,
995 <A
996HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
997>docbSAXHandlerPtr</A
998> sax,
999 void *userData);</PRE
1000></TD
1001></TR
1002></TABLE
1003><P
1004>parse an SGML file and build a tree. Automatic support for ZLIB/Compress
1005compressed document is provided by default if found at compile-time.
1006It use the given SAX function block to handle the parsing callback.
1007If sax is NULL, fallback to the default DOM tree building routines.</P
1008><P
1009></P
1010><DIV
1011CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1012><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1013NAME="AEN20604"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1014></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1015><P
1016></P
1017><TABLE
1018BORDER="0"
1019WIDTH="100%"
1020BGCOLOR="#FFD0D0"
1021CELLSPACING="0"
1022CELLPADDING="4"
1023CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1024><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1025><TR
1026><TD
1027WIDTH="20%"
1028ALIGN="RIGHT"
1029VALIGN="TOP"
1030><TT
1031CLASS="PARAMETER"
1032><I
1033>filename</I
1034></TT
1035>&nbsp;:</TD
1036><TD
1037WIDTH="80%"
1038ALIGN="LEFT"
1039VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1040> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1041></TR
1042><TR
1043><TD
1044WIDTH="20%"
1045ALIGN="RIGHT"
1046VALIGN="TOP"
1047><TT
1048CLASS="PARAMETER"
1049><I
1050>encoding</I
1051></TT
1052>&nbsp;:</TD
1053><TD
1054WIDTH="80%"
1055ALIGN="LEFT"
1056VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1057> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1058></TR
1059><TR
1060><TD
1061WIDTH="20%"
1062ALIGN="RIGHT"
1063VALIGN="TOP"
1064><TT
1065CLASS="PARAMETER"
1066><I
1067>sax</I
1068></TT
1069>&nbsp;:</TD
1070><TD
1071WIDTH="80%"
1072ALIGN="LEFT"
1073VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1074> the SAX handler block</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1075></TR
1076><TR
1077><TD
1078WIDTH="20%"
1079ALIGN="RIGHT"
1080VALIGN="TOP"
1081><TT
1082CLASS="PARAMETER"
1083><I
1084>userData</I
1085></TT
1086>&nbsp;:</TD
1087><TD
1088WIDTH="80%"
1089ALIGN="LEFT"
1090VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1091> if using SAX, this pointer will be provided on callbacks. </TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1092></TR
1093><TR
1094><TD
1095WIDTH="20%"
1096ALIGN="RIGHT"
1097VALIGN="TOP"
1098><I
1099CLASS="EMPHASIS"
1100>Returns</I
1101> :</TD
1102><TD
1103WIDTH="80%"
1104ALIGN="LEFT"
1105VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1106>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1107></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1108></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1109></TABLE
1110><P
1111></P
1112></DIV
1113></DIV
1114><HR><DIV
1115CLASS="REFSECT2"
1116><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1117NAME="AEN20629"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1118></A
1119><H3
1120><A
1121NAME="DOCBPARSEFILE"
1122></A
1123>docbParseFile ()</H3
1124><TABLE
1125BORDER="0"
1126BGCOLOR="#D6E8FF"
1127WIDTH="100%"
1128CELLPADDING="6"
1129><TR
1130><TD
1131><PRE
1132CLASS="PROGRAMLISTING"
1133><A
1134HREF="libxml-docbparser.html#DOCBDOCPTR"
1135>docbDocPtr</A
1136> docbParseFile (const char *filename,
1137 const char *encoding);</PRE
1138></TD
1139></TR
1140></TABLE
1141><P
1142>parse a Docbook SGML file and build a tree. Automatic support for
1143ZLIB/Compress compressed document is provided by default if found
1144at compile-time.</P
1145><P
1146></P
1147><DIV
1148CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1149><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1150NAME="AEN20636"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1151></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1152><P
1153></P
1154><TABLE
1155BORDER="0"
1156WIDTH="100%"
1157BGCOLOR="#FFD0D0"
1158CELLSPACING="0"
1159CELLPADDING="4"
1160CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1161><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1162><TR
1163><TD
1164WIDTH="20%"
1165ALIGN="RIGHT"
1166VALIGN="TOP"
1167><TT
1168CLASS="PARAMETER"
1169><I
1170>filename</I
1171></TT
1172>&nbsp;:</TD
1173><TD
1174WIDTH="80%"
1175ALIGN="LEFT"
1176VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1177> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1178></TR
1179><TR
1180><TD
1181WIDTH="20%"
1182ALIGN="RIGHT"
1183VALIGN="TOP"
1184><TT
1185CLASS="PARAMETER"
1186><I
1187>encoding</I
1188></TT
1189>&nbsp;:</TD
1190><TD
1191WIDTH="80%"
1192ALIGN="LEFT"
1193VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1194> a free form C string describing document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1195></TR
1196><TR
1197><TD
1198WIDTH="20%"
1199ALIGN="RIGHT"
1200VALIGN="TOP"
1201><I
1202CLASS="EMPHASIS"
1203>Returns</I
1204> :</TD
1205><TD
1206WIDTH="80%"
1207ALIGN="LEFT"
1208VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1209>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1210></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1211></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1212></TABLE
1213><P
1214></P
1215></DIV
1216></DIV
1217><HR><DIV
1218CLASS="REFSECT2"
1219><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1220NAME="AEN20653"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1221></A
1222><H3
1223><A
1224NAME="DOCBFREEPARSERCTXT"
1225></A
1226>docbFreeParserCtxt ()</H3
1227><TABLE
1228BORDER="0"
1229BGCOLOR="#D6E8FF"
1230WIDTH="100%"
1231CELLPADDING="6"
1232><TR
1233><TD
1234><PRE
1235CLASS="PROGRAMLISTING"
1236>void docbFreeParserCtxt (<A
1237HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1238>docbParserCtxtPtr</A
1239> ctxt);</PRE
1240></TD
1241></TR
1242></TABLE
1243><P
1244>Free all the memory used by a parser context. However the parsed
1245document in ctxt-&gt;myDoc is not freed.</P
1246><P
1247></P
1248><DIV
1249CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1250><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1251NAME="AEN20660"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1252></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1253><P
1254></P
1255><TABLE
1256BORDER="0"
1257WIDTH="100%"
1258BGCOLOR="#FFD0D0"
1259CELLSPACING="0"
1260CELLPADDING="4"
1261CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1262><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1263><TR
1264><TD
1265WIDTH="20%"
1266ALIGN="RIGHT"
1267VALIGN="TOP"
1268><TT
1269CLASS="PARAMETER"
1270><I
1271>ctxt</I
1272></TT
1273>&nbsp;:</TD
1274><TD
1275WIDTH="80%"
1276ALIGN="LEFT"
1277VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1278> an SGML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1279></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1280></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1281></TABLE
1282><P
1283></P
1284></DIV
1285></DIV
1286><HR><DIV
1287CLASS="REFSECT2"
1288><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1289NAME="AEN20669"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1290></A
1291><H3
1292><A
1293NAME="DOCBCREATEPUSHPARSERCTXT"
1294></A
1295>docbCreatePushParserCtxt ()</H3
1296><TABLE
1297BORDER="0"
1298BGCOLOR="#D6E8FF"
1299WIDTH="100%"
1300CELLPADDING="6"
1301><TR
1302><TD
1303><PRE
1304CLASS="PROGRAMLISTING"
1305><A
1306HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1307>docbParserCtxtPtr</A
1308> docbCreatePushParserCtxt (<A
1309HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
1310>docbSAXHandlerPtr</A
1311> sax,
1312 void *user_data,
1313 const char *chunk,
1314 int size,
1315 const char *filename,
1316 <A
1317HREF="libxml-encoding.html#XMLCHARENCODING"
1318>xmlCharEncoding</A
1319> enc);</PRE
1320></TD
1321></TR
1322></TABLE
1323><P
1324>Create a parser context for using the DocBook SGML parser in push mode
1325To allow content encoding detection, <TT
1326CLASS="PARAMETER"
1327><I
1328>size</I
1329></TT
1330> should be &gt;= 4
1331The value of <TT
1332CLASS="PARAMETER"
1333><I
1334>filename</I
1335></TT
1336> is used for fetching external entities
1337and error/warning reports.</P
1338><P
1339></P
1340><DIV
1341CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1342><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1343NAME="AEN20680"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1344></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1345><P
1346></P
1347><TABLE
1348BORDER="0"
1349WIDTH="100%"
1350BGCOLOR="#FFD0D0"
1351CELLSPACING="0"
1352CELLPADDING="4"
1353CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1354><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1355><TR
1356><TD
1357WIDTH="20%"
1358ALIGN="RIGHT"
1359VALIGN="TOP"
1360><TT
1361CLASS="PARAMETER"
1362><I
1363>sax</I
1364></TT
1365>&nbsp;:</TD
1366><TD
1367WIDTH="80%"
1368ALIGN="LEFT"
1369VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1370> a SAX handler</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1371></TR
1372><TR
1373><TD
1374WIDTH="20%"
1375ALIGN="RIGHT"
1376VALIGN="TOP"
1377><TT
1378CLASS="PARAMETER"
1379><I
1380>user_data</I
1381></TT
1382>&nbsp;:</TD
1383><TD
1384WIDTH="80%"
1385ALIGN="LEFT"
1386VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1387> The user data returned on SAX callbacks</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1388></TR
1389><TR
1390><TD
1391WIDTH="20%"
1392ALIGN="RIGHT"
1393VALIGN="TOP"
1394><TT
1395CLASS="PARAMETER"
1396><I
1397>chunk</I
1398></TT
1399>&nbsp;:</TD
1400><TD
1401WIDTH="80%"
1402ALIGN="LEFT"
1403VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1404> a pointer to an array of chars</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1405></TR
1406><TR
1407><TD
1408WIDTH="20%"
1409ALIGN="RIGHT"
1410VALIGN="TOP"
1411><TT
1412CLASS="PARAMETER"
1413><I
1414>size</I
1415></TT
1416>&nbsp;:</TD
1417><TD
1418WIDTH="80%"
1419ALIGN="LEFT"
1420VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1421> number of chars in the array</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1422></TR
1423><TR
1424><TD
1425WIDTH="20%"
1426ALIGN="RIGHT"
1427VALIGN="TOP"
1428><TT
1429CLASS="PARAMETER"
1430><I
1431>filename</I
1432></TT
1433>&nbsp;:</TD
1434><TD
1435WIDTH="80%"
1436ALIGN="LEFT"
1437VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1438> an optional file name or URI</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1439></TR
1440><TR
1441><TD
1442WIDTH="20%"
1443ALIGN="RIGHT"
1444VALIGN="TOP"
1445><TT
1446CLASS="PARAMETER"
1447><I
1448>enc</I
1449></TT
1450>&nbsp;:</TD
1451><TD
1452WIDTH="80%"
1453ALIGN="LEFT"
1454VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1455> an optional encoding</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1456></TR
1457><TR
1458><TD
1459WIDTH="20%"
1460ALIGN="RIGHT"
1461VALIGN="TOP"
1462><I
1463CLASS="EMPHASIS"
1464>Returns</I
1465> :</TD
1466><TD
1467WIDTH="80%"
1468ALIGN="LEFT"
1469VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1470>the new parser context or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1471></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1472></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1473></TABLE
1474><P
1475></P
1476></DIV
1477></DIV
1478><HR><DIV
1479CLASS="REFSECT2"
1480><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1481NAME="AEN20713"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1482></A
1483><H3
1484><A
1485NAME="DOCBPARSECHUNK"
1486></A
1487>docbParseChunk ()</H3
1488><TABLE
1489BORDER="0"
1490BGCOLOR="#D6E8FF"
1491WIDTH="100%"
1492CELLPADDING="6"
1493><TR
1494><TD
1495><PRE
1496CLASS="PROGRAMLISTING"
1497>int docbParseChunk (<A
1498HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1499>docbParserCtxtPtr</A
1500> ctxt,
1501 const char *chunk,
1502 int size,
1503 int terminate);</PRE
1504></TD
1505></TR
1506></TABLE
1507><P
1508>Parse a Chunk of memory</P
1509><P
1510></P
1511><DIV
1512CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1513><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1514NAME="AEN20720"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1515></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1516><P
1517></P
1518><TABLE
1519BORDER="0"
1520WIDTH="100%"
1521BGCOLOR="#FFD0D0"
1522CELLSPACING="0"
1523CELLPADDING="4"
1524CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1525><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1526><TR
1527><TD
1528WIDTH="20%"
1529ALIGN="RIGHT"
1530VALIGN="TOP"
1531><TT
1532CLASS="PARAMETER"
1533><I
1534>ctxt</I
1535></TT
1536>&nbsp;:</TD
1537><TD
1538WIDTH="80%"
1539ALIGN="LEFT"
1540VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1541> an XML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1542></TR
1543><TR
1544><TD
1545WIDTH="20%"
1546ALIGN="RIGHT"
1547VALIGN="TOP"
1548><TT
1549CLASS="PARAMETER"
1550><I
1551>chunk</I
1552></TT
1553>&nbsp;:</TD
1554><TD
1555WIDTH="80%"
1556ALIGN="LEFT"
1557VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1558> an char array</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1559></TR
1560><TR
1561><TD
1562WIDTH="20%"
1563ALIGN="RIGHT"
1564VALIGN="TOP"
1565><TT
1566CLASS="PARAMETER"
1567><I
1568>size</I
1569></TT
1570>&nbsp;:</TD
1571><TD
1572WIDTH="80%"
1573ALIGN="LEFT"
1574VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1575> the size in byte of the chunk</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1576></TR
1577><TR
1578><TD
1579WIDTH="20%"
1580ALIGN="RIGHT"
1581VALIGN="TOP"
1582><TT
1583CLASS="PARAMETER"
1584><I
1585>terminate</I
1586></TT
1587>&nbsp;:</TD
1588><TD
1589WIDTH="80%"
1590ALIGN="LEFT"
1591VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1592> last chunk indicator</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1593></TR
1594><TR
1595><TD
1596WIDTH="20%"
1597ALIGN="RIGHT"
1598VALIGN="TOP"
1599><I
1600CLASS="EMPHASIS"
1601>Returns</I
1602> :</TD
1603><TD
1604WIDTH="80%"
1605ALIGN="LEFT"
1606VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1607>zero if no error, the xmlParserErrors otherwise.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1608></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1609></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1610></TABLE
1611><P
1612></P
1613></DIV
1614></DIV
1615><HR><DIV
1616CLASS="REFSECT2"
1617><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1618NAME="AEN20745"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1619></A
1620><H3
1621><A
1622NAME="DOCBCREATEFILEPARSERCTXT"
1623></A
1624>docbCreateFileParserCtxt ()</H3
1625><TABLE
1626BORDER="0"
1627BGCOLOR="#D6E8FF"
1628WIDTH="100%"
1629CELLPADDING="6"
1630><TR
1631><TD
1632><PRE
1633CLASS="PROGRAMLISTING"
1634><A
1635HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1636>docbParserCtxtPtr</A
1637> docbCreateFileParserCtxt (const char *filename,
1638 const char *encoding);</PRE
1639></TD
1640></TR
1641></TABLE
1642><P
1643>Create a parser context for a file content.
1644Automatic support for ZLIB/Compress compressed document is provided
1645by default if found at compile-time.</P
1646><P
1647></P
1648><DIV
1649CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1650><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1651NAME="AEN20752"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1652></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1653><P
1654></P
1655><TABLE
1656BORDER="0"
1657WIDTH="100%"
1658BGCOLOR="#FFD0D0"
1659CELLSPACING="0"
1660CELLPADDING="4"
1661CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1662><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1663><TR
1664><TD
1665WIDTH="20%"
1666ALIGN="RIGHT"
1667VALIGN="TOP"
1668><TT
1669CLASS="PARAMETER"
1670><I
1671>filename</I
1672></TT
1673>&nbsp;:</TD
1674><TD
1675WIDTH="80%"
1676ALIGN="LEFT"
1677VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1678> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1679></TR
1680><TR
1681><TD
1682WIDTH="20%"
1683ALIGN="RIGHT"
1684VALIGN="TOP"
1685><TT
1686CLASS="PARAMETER"
1687><I
1688>encoding</I
1689></TT
1690>&nbsp;:</TD
1691><TD
1692WIDTH="80%"
1693ALIGN="LEFT"
1694VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1695> the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1696></TR
1697><TR
1698><TD
1699WIDTH="20%"
1700ALIGN="RIGHT"
1701VALIGN="TOP"
1702><I
1703CLASS="EMPHASIS"
1704>Returns</I
1705> :</TD
1706><TD
1707WIDTH="80%"
1708ALIGN="LEFT"
1709VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1710>the new parser context or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1711></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1712></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1713></TABLE
1714><P
1715></P
1716></DIV
1717></DIV
1718><HR><DIV
1719CLASS="REFSECT2"
1720><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1721NAME="AEN20769"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1722></A
1723><H3
1724><A
1725NAME="DOCBPARSEDOCUMENT"
1726></A
1727>docbParseDocument ()</H3
1728><TABLE
1729BORDER="0"
1730BGCOLOR="#D6E8FF"
1731WIDTH="100%"
1732CELLPADDING="6"
1733><TR
1734><TD
1735><PRE
1736CLASS="PROGRAMLISTING"
1737>int docbParseDocument (<A
1738HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1739>docbParserCtxtPtr</A
1740> ctxt);</PRE
1741></TD
1742></TR
1743></TABLE
1744><P
1745>parse an SGML document (and build a tree if using the standard SAX
1746interface).</P
1747><P
1748></P
1749><DIV
1750CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1751><A
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame^]1752NAME="AEN20776"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1753></A
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1754><P
1755></P
1756><TABLE
1757BORDER="0"
1758WIDTH="100%"
1759BGCOLOR="#FFD0D0"
1760CELLSPACING="0"
1761CELLPADDING="4"
1762CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1763><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1764><TR
1765><TD
1766WIDTH="20%"
1767ALIGN="RIGHT"
1768VALIGN="TOP"
1769><TT
1770CLASS="PARAMETER"
1771><I
1772>ctxt</I
1773></TT
1774>&nbsp;:</TD
1775><TD
1776WIDTH="80%"
1777ALIGN="LEFT"
1778VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1779> an SGML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1780></TR
1781><TR
1782><TD
1783WIDTH="20%"
1784ALIGN="RIGHT"
1785VALIGN="TOP"
1786><I
1787CLASS="EMPHASIS"
1788>Returns</I
1789> :</TD
1790><TD
1791WIDTH="80%"
1792ALIGN="LEFT"
1793VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000[diff] [blame]1794>0, -1 in case of error. the parser context is augmented
1795as a result of the parsing.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1796></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000[diff] [blame]1797></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1798></TABLE
1799><P
1800></P
1801></DIV
1802></DIV
1803></DIV
1804><DIV
1805CLASS="NAVFOOTER"
1806><BR
1807CLEAR="all"><BR><TABLE
1808WIDTH="100%"
1809BORDER="0"
1810BGCOLOR="#000000"
1811CELLPADDING="1"
1812CELLSPACING="0"
1813><TR
1814><TD
1815WIDTH="25%"
1816BGCOLOR="#C00000"
1817ALIGN="left"
1818><A
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]1819HREF="libxml-globals.html"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1820><FONT
1821COLOR="#FFFFFF"
1822SIZE="3"
1823><B
1824>&#60;&#60;&#60; Previous Page</B
1825></FONT
1826></A
1827></TD
1828><TD
1829WIDTH="25%"
1830BGCOLOR="#0000C0"
1831ALIGN="center"
1832><FONT
1833COLOR="#FFFFFF"
1834SIZE="3"
1835><B
1836><A
1837HREF="book1.html"
1838><FONT
1839COLOR="#FFFFFF"
1840SIZE="3"
1841><B
1842>Home</B
1843></FONT
1844></A
1845></B
1846></FONT
1847></TD
1848><TD
1849WIDTH="25%"
1850BGCOLOR="#00C000"
1851ALIGN="center"
1852><FONT
1853COLOR="#FFFFFF"
1854SIZE="3"
1855><B
1856><A
1857HREF="libxml-lib.html"
1858><FONT
1859COLOR="#FFFFFF"
1860SIZE="3"
1861><B
1862>Up</B
1863></FONT
1864></A
1865></B
1866></FONT
1867></TD
1868><TD
1869WIDTH="25%"
1870BGCOLOR="#C00000"
1871ALIGN="right"
1872><A
1873HREF="libxml-parserinternals.html"
1874><FONT
1875COLOR="#FFFFFF"
1876SIZE="3"
1877><B
1878>Next Page &#62;&#62;&#62;</B
1879></FONT
1880></A
1881></TD
1882></TR
1883><TR
1884><TD
1885COLSPAN="2"
1886ALIGN="left"
1887><FONT
1888COLOR="#FFFFFF"
1889SIZE="3"
1890><B
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]1891>globals</B
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000[diff] [blame]1892></FONT
1893></TD
1894><TD
1895COLSPAN="2"
1896ALIGN="right"
1897><FONT
1898COLOR="#FFFFFF"
1899SIZE="3"
1900><B
1901>parserInternals</B
1902></FONT
1903></TD
1904></TR
1905></TABLE
1906></DIV
1907></BODY
1908></HTML
1909>