blob: 1767145f5f5cc6ef3ec1a7f10fcfa44a094efddb [file] [log] [blame]
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001<HTML
2><HEAD
3><TITLE
4>DOCBparser</TITLE
5><META
6NAME="GENERATOR"
Daniel Veillard539638b2002-07-06 19:55:14 +00007CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
Daniel Veillard60087f32001-10-10 09:45:09 +00008"><LINK
Daniel Veillard7d6fd212001-05-10 15:34:11 +00009REL="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 +000016TITLE="globals"
17HREF="libxml-globals.html"><LINK
Daniel Veillard7d6fd212001-05-10 15:34:11 +000018REL="NEXT"
19TITLE="parserInternals"
20HREF="libxml-parserinternals.html"></HEAD
21><BODY
Daniel Veillardbed7b052001-05-19 14:59:49 +000022CLASS="REFENTRY"
Daniel Veillard7d6fd212001-05-10 15:34:11 +000023BGCOLOR="#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 +000052HREF="libxml-globals.html"
Daniel Veillard7d6fd212001-05-10 15:34:11 +000053><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
Daniel Veillardaec63562003-03-23 20:42:17 +0000120NAME="LIBXML-DOCBPARSER"
121></A
122>DOCBparser</H1
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000123><DIV
124CLASS="REFNAMEDIV"
125><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000126NAME="AEN23612"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000127></A
128><H2
129>Name</H2
130>DOCBparser&nbsp;--&nbsp;</DIV
131><DIV
132CLASS="REFSYNOPSISDIV"
133><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000134NAME="AEN23615"
135></A
136><H2
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000137>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 Veillardaec63562003-03-23 20:42:17 +0000298NAME="AEN23652"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000299></A
300><H2
301>Description</H2
302><P
303></P
304></DIV
305><DIV
306CLASS="REFSECT1"
307><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000308NAME="AEN23655"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000309></A
310><H2
311>Details</H2
312><DIV
313CLASS="REFSECT2"
314><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000315NAME="AEN23657"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000316></A
317><H3
318><A
319NAME="DOCBPARSERCTXT"
320></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000321>docbParserCtxt</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000322><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 +0000335><P
336></P
337></DIV
338><HR><DIV
339CLASS="REFSECT2"
340><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000341NAME="AEN23662"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000342></A
343><H3
344><A
345NAME="DOCBPARSERCTXTPTR"
346></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000347>docbParserCtxtPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000348><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 +0000361><P
362></P
363></DIV
364><HR><DIV
365CLASS="REFSECT2"
366><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000367NAME="AEN23667"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000368></A
369><H3
370><A
371NAME="DOCBPARSERNODEINFO"
372></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000373>docbParserNodeInfo</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000374><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 +0000387><P
388></P
389></DIV
390><HR><DIV
391CLASS="REFSECT2"
392><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000393NAME="AEN23672"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000394></A
395><H3
396><A
397NAME="DOCBSAXHANDLER"
398></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000399>docbSAXHandler</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000400><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 +0000413><P
414></P
415></DIV
416><HR><DIV
417CLASS="REFSECT2"
418><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000419NAME="AEN23677"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000420></A
421><H3
422><A
423NAME="DOCBSAXHANDLERPTR"
424></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000425>docbSAXHandlerPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000426><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 +0000439><P
440></P
441></DIV
442><HR><DIV
443CLASS="REFSECT2"
444><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000445NAME="AEN23682"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000446></A
447><H3
448><A
449NAME="DOCBPARSERINPUT"
450></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000451>docbParserInput</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000452><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 +0000465><P
466></P
467></DIV
468><HR><DIV
469CLASS="REFSECT2"
470><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000471NAME="AEN23687"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000472></A
473><H3
474><A
475NAME="DOCBPARSERINPUTPTR"
476></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000477>docbParserInputPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000478><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 +0000491><P
492></P
493></DIV
494><HR><DIV
495CLASS="REFSECT2"
496><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000497NAME="AEN23692"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000498></A
499><H3
500><A
501NAME="DOCBDOCPTR"
502></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000503>docbDocPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000504><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 +0000517><P
518></P
519></DIV
520><HR><DIV
521CLASS="REFSECT2"
522><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000523NAME="AEN23697"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000524></A
525><H3
526><A
527NAME="DOCBNODEPTR"
528></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000529>docbNodePtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000530><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 +0000543><P
544></P
545></DIV
546><HR><DIV
547CLASS="REFSECT2"
548><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000549NAME="AEN23702"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000550></A
551><H3
552><A
553NAME="DOCBENCODEENTITIES"
554></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000555>docbEncodeEntities ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000556><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 +0000580><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000581NAME="AEN23708"
582></A
583><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000584></P
585><TABLE
586BORDER="0"
587WIDTH="100%"
588BGCOLOR="#FFD0D0"
589CELLSPACING="0"
590CELLPADDING="4"
591CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000592><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000593><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 +0000608> a pointer to an array of bytes to store the result</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000609></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 +0000625> the length of <TT
626CLASS="PARAMETER"
627><I
628>out</I
629></TT
630></TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000631></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 +0000647> a pointer to an array of UTF-8 chars</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000648></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 +0000664> the length of <TT
665CLASS="PARAMETER"
666><I
667>in</I
668></TT
669></TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000670></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 +0000686> the quote character to escape (' or ") or zero.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000687></TR
688><TR
689><TD
690WIDTH="20%"
691ALIGN="RIGHT"
692VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +0000693><SPAN
694CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000695><I
696CLASS="EMPHASIS"
697>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +0000698></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000699> :</TD
700><TD
701WIDTH="80%"
702ALIGN="LEFT"
703VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000704>0 if success, -2 if the transcoding fails, or -1 otherwise
705The value of <TT
706CLASS="PARAMETER"
707><I
708>inlen</I
709></TT
710> after return is the number of octets consumed
Daniel Veillardaec63562003-03-23 20:42:17 +0000711 as the return value is positive, else unpredictable.
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000712The value of <TT
713CLASS="PARAMETER"
714><I
715>outlen</I
716></TT
717> after return is the number of octets consumed.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000718></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000719></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000720></TABLE
721><P
722></P
723></DIV
724></DIV
725><HR><DIV
726CLASS="REFSECT2"
727><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000728NAME="AEN23741"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000729></A
730><H3
731><A
732NAME="DOCBSAXPARSEDOC"
733></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000734>docbSAXParseDoc ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000735><TABLE
736BORDER="0"
737BGCOLOR="#D6E8FF"
738WIDTH="100%"
739CELLPADDING="6"
740><TR
741><TD
742><PRE
743CLASS="PROGRAMLISTING"
744><A
745HREF="libxml-docbparser.html#DOCBDOCPTR"
746>docbDocPtr</A
747> docbSAXParseDoc (<A
748HREF="libxml-tree.html#XMLCHAR"
749>xmlChar</A
750> *cur,
751 const char *encoding,
752 <A
753HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
754>docbSAXHandlerPtr</A
755> sax,
756 void *userData);</PRE
757></TD
758></TR
759></TABLE
760><P
761>parse an SGML in-memory document and build a tree.
762It use the given SAX function block to handle the parsing callback.
763If sax is NULL, fallback to the default DOM tree building routines.</P
764><P
765></P
766><DIV
767CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000768><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000769NAME="AEN23750"
770></A
771><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000772></P
773><TABLE
774BORDER="0"
775WIDTH="100%"
776BGCOLOR="#FFD0D0"
777CELLSPACING="0"
778CELLPADDING="4"
779CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000780><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000781><TR
782><TD
783WIDTH="20%"
784ALIGN="RIGHT"
785VALIGN="TOP"
786><TT
787CLASS="PARAMETER"
788><I
789>cur</I
790></TT
791>&nbsp;:</TD
792><TD
793WIDTH="80%"
794ALIGN="LEFT"
795VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000796> a pointer to an array of xmlChar</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000797></TR
798><TR
799><TD
800WIDTH="20%"
801ALIGN="RIGHT"
802VALIGN="TOP"
803><TT
804CLASS="PARAMETER"
805><I
806>encoding</I
807></TT
808>&nbsp;:</TD
809><TD
810WIDTH="80%"
811ALIGN="LEFT"
812VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000813> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000814></TR
815><TR
816><TD
817WIDTH="20%"
818ALIGN="RIGHT"
819VALIGN="TOP"
820><TT
821CLASS="PARAMETER"
822><I
823>sax</I
824></TT
825>&nbsp;:</TD
826><TD
827WIDTH="80%"
828ALIGN="LEFT"
829VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000830> the SAX handler block</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000831></TR
832><TR
833><TD
834WIDTH="20%"
835ALIGN="RIGHT"
836VALIGN="TOP"
837><TT
838CLASS="PARAMETER"
839><I
840>userData</I
841></TT
842>&nbsp;:</TD
843><TD
844WIDTH="80%"
845ALIGN="LEFT"
846VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000847> if using SAX, this pointer will be provided on callbacks. </TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000848></TR
849><TR
850><TD
851WIDTH="20%"
852ALIGN="RIGHT"
853VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +0000854><SPAN
855CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000856><I
857CLASS="EMPHASIS"
858>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +0000859></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000860> :</TD
861><TD
862WIDTH="80%"
863ALIGN="LEFT"
864VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000865>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000866></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000867></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000868></TABLE
869><P
870></P
871></DIV
872></DIV
873><HR><DIV
874CLASS="REFSECT2"
875><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000876NAME="AEN23775"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000877></A
878><H3
879><A
880NAME="DOCBPARSEDOC"
881></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000882>docbParseDoc ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000883><TABLE
884BORDER="0"
885BGCOLOR="#D6E8FF"
886WIDTH="100%"
887CELLPADDING="6"
888><TR
889><TD
890><PRE
891CLASS="PROGRAMLISTING"
892><A
893HREF="libxml-docbparser.html#DOCBDOCPTR"
894>docbDocPtr</A
895> docbParseDoc (<A
896HREF="libxml-tree.html#XMLCHAR"
897>xmlChar</A
898> *cur,
899 const char *encoding);</PRE
900></TD
901></TR
902></TABLE
903><P
904>parse an SGML in-memory document and build a tree.</P
905><P
906></P
907><DIV
908CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000909><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000910NAME="AEN23783"
911></A
912><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000913></P
914><TABLE
915BORDER="0"
916WIDTH="100%"
917BGCOLOR="#FFD0D0"
918CELLSPACING="0"
919CELLPADDING="4"
920CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000921><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000922><TR
923><TD
924WIDTH="20%"
925ALIGN="RIGHT"
926VALIGN="TOP"
927><TT
928CLASS="PARAMETER"
929><I
930>cur</I
931></TT
932>&nbsp;:</TD
933><TD
934WIDTH="80%"
935ALIGN="LEFT"
936VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000937> a pointer to an array of xmlChar</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000938></TR
939><TR
940><TD
941WIDTH="20%"
942ALIGN="RIGHT"
943VALIGN="TOP"
944><TT
945CLASS="PARAMETER"
946><I
947>encoding</I
948></TT
949>&nbsp;:</TD
950><TD
951WIDTH="80%"
952ALIGN="LEFT"
953VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000954> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000955></TR
956><TR
957><TD
958WIDTH="20%"
959ALIGN="RIGHT"
960VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +0000961><SPAN
962CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000963><I
964CLASS="EMPHASIS"
965>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +0000966></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000967> :</TD
968><TD
969WIDTH="80%"
970ALIGN="LEFT"
971VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000972>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000973></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000974></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000975></TABLE
976><P
977></P
978></DIV
979></DIV
980><HR><DIV
981CLASS="REFSECT2"
982><A
Daniel Veillardaec63562003-03-23 20:42:17 +0000983NAME="AEN23800"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000984></A
985><H3
986><A
987NAME="DOCBSAXPARSEFILE"
988></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000989>docbSAXParseFile ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000990><TABLE
991BORDER="0"
992BGCOLOR="#D6E8FF"
993WIDTH="100%"
994CELLPADDING="6"
995><TR
996><TD
997><PRE
998CLASS="PROGRAMLISTING"
999><A
1000HREF="libxml-docbparser.html#DOCBDOCPTR"
1001>docbDocPtr</A
1002> docbSAXParseFile (const char *filename,
1003 const char *encoding,
1004 <A
1005HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
1006>docbSAXHandlerPtr</A
1007> sax,
1008 void *userData);</PRE
1009></TD
1010></TR
1011></TABLE
1012><P
1013>parse an SGML file and build a tree. Automatic support for ZLIB/Compress
1014compressed document is provided by default if found at compile-time.
1015It use the given SAX function block to handle the parsing callback.
1016If sax is NULL, fallback to the default DOM tree building routines.</P
1017><P
1018></P
1019><DIV
1020CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001021><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001022NAME="AEN23808"
1023></A
1024><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001025></P
1026><TABLE
1027BORDER="0"
1028WIDTH="100%"
1029BGCOLOR="#FFD0D0"
1030CELLSPACING="0"
1031CELLPADDING="4"
1032CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001033><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001034><TR
1035><TD
1036WIDTH="20%"
1037ALIGN="RIGHT"
1038VALIGN="TOP"
1039><TT
1040CLASS="PARAMETER"
1041><I
1042>filename</I
1043></TT
1044>&nbsp;:</TD
1045><TD
1046WIDTH="80%"
1047ALIGN="LEFT"
1048VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001049> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001050></TR
1051><TR
1052><TD
1053WIDTH="20%"
1054ALIGN="RIGHT"
1055VALIGN="TOP"
1056><TT
1057CLASS="PARAMETER"
1058><I
1059>encoding</I
1060></TT
1061>&nbsp;:</TD
1062><TD
1063WIDTH="80%"
1064ALIGN="LEFT"
1065VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001066> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001067></TR
1068><TR
1069><TD
1070WIDTH="20%"
1071ALIGN="RIGHT"
1072VALIGN="TOP"
1073><TT
1074CLASS="PARAMETER"
1075><I
1076>sax</I
1077></TT
1078>&nbsp;:</TD
1079><TD
1080WIDTH="80%"
1081ALIGN="LEFT"
1082VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001083> the SAX handler block</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001084></TR
1085><TR
1086><TD
1087WIDTH="20%"
1088ALIGN="RIGHT"
1089VALIGN="TOP"
1090><TT
1091CLASS="PARAMETER"
1092><I
1093>userData</I
1094></TT
1095>&nbsp;:</TD
1096><TD
1097WIDTH="80%"
1098ALIGN="LEFT"
1099VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001100> if using SAX, this pointer will be provided on callbacks. </TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001101></TR
1102><TR
1103><TD
1104WIDTH="20%"
1105ALIGN="RIGHT"
1106VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001107><SPAN
1108CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001109><I
1110CLASS="EMPHASIS"
1111>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001112></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001113> :</TD
1114><TD
1115WIDTH="80%"
1116ALIGN="LEFT"
1117VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001118>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001119></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001120></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001121></TABLE
1122><P
1123></P
1124></DIV
1125></DIV
1126><HR><DIV
1127CLASS="REFSECT2"
1128><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001129NAME="AEN23833"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001130></A
1131><H3
1132><A
1133NAME="DOCBPARSEFILE"
1134></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001135>docbParseFile ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001136><TABLE
1137BORDER="0"
1138BGCOLOR="#D6E8FF"
1139WIDTH="100%"
1140CELLPADDING="6"
1141><TR
1142><TD
1143><PRE
1144CLASS="PROGRAMLISTING"
1145><A
1146HREF="libxml-docbparser.html#DOCBDOCPTR"
1147>docbDocPtr</A
1148> docbParseFile (const char *filename,
1149 const char *encoding);</PRE
1150></TD
1151></TR
1152></TABLE
1153><P
1154>parse a Docbook SGML file and build a tree. Automatic support for
1155ZLIB/Compress compressed document is provided by default if found
1156at compile-time.</P
1157><P
1158></P
1159><DIV
1160CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001161><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001162NAME="AEN23840"
1163></A
1164><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001165></P
1166><TABLE
1167BORDER="0"
1168WIDTH="100%"
1169BGCOLOR="#FFD0D0"
1170CELLSPACING="0"
1171CELLPADDING="4"
1172CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001173><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001174><TR
1175><TD
1176WIDTH="20%"
1177ALIGN="RIGHT"
1178VALIGN="TOP"
1179><TT
1180CLASS="PARAMETER"
1181><I
1182>filename</I
1183></TT
1184>&nbsp;:</TD
1185><TD
1186WIDTH="80%"
1187ALIGN="LEFT"
1188VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001189> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001190></TR
1191><TR
1192><TD
1193WIDTH="20%"
1194ALIGN="RIGHT"
1195VALIGN="TOP"
1196><TT
1197CLASS="PARAMETER"
1198><I
1199>encoding</I
1200></TT
1201>&nbsp;:</TD
1202><TD
1203WIDTH="80%"
1204ALIGN="LEFT"
1205VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001206> a free form C string describing document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001207></TR
1208><TR
1209><TD
1210WIDTH="20%"
1211ALIGN="RIGHT"
1212VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001213><SPAN
1214CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001215><I
1216CLASS="EMPHASIS"
1217>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001218></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001219> :</TD
1220><TD
1221WIDTH="80%"
1222ALIGN="LEFT"
1223VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001224>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001225></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001226></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001227></TABLE
1228><P
1229></P
1230></DIV
1231></DIV
1232><HR><DIV
1233CLASS="REFSECT2"
1234><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001235NAME="AEN23857"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001236></A
1237><H3
1238><A
1239NAME="DOCBFREEPARSERCTXT"
1240></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001241>docbFreeParserCtxt ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001242><TABLE
1243BORDER="0"
1244BGCOLOR="#D6E8FF"
1245WIDTH="100%"
1246CELLPADDING="6"
1247><TR
1248><TD
1249><PRE
1250CLASS="PROGRAMLISTING"
1251>void docbFreeParserCtxt (<A
1252HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1253>docbParserCtxtPtr</A
1254> ctxt);</PRE
1255></TD
1256></TR
1257></TABLE
1258><P
1259>Free all the memory used by a parser context. However the parsed
1260document in ctxt-&gt;myDoc is not freed.</P
1261><P
1262></P
1263><DIV
1264CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001265><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001266NAME="AEN23864"
1267></A
1268><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001269></P
1270><TABLE
1271BORDER="0"
1272WIDTH="100%"
1273BGCOLOR="#FFD0D0"
1274CELLSPACING="0"
1275CELLPADDING="4"
1276CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001277><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001278><TR
1279><TD
1280WIDTH="20%"
1281ALIGN="RIGHT"
1282VALIGN="TOP"
1283><TT
1284CLASS="PARAMETER"
1285><I
1286>ctxt</I
1287></TT
1288>&nbsp;:</TD
1289><TD
1290WIDTH="80%"
1291ALIGN="LEFT"
1292VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001293> an SGML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001294></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001295></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001296></TABLE
1297><P
1298></P
1299></DIV
1300></DIV
1301><HR><DIV
1302CLASS="REFSECT2"
1303><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001304NAME="AEN23873"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001305></A
1306><H3
1307><A
1308NAME="DOCBCREATEPUSHPARSERCTXT"
1309></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001310>docbCreatePushParserCtxt ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001311><TABLE
1312BORDER="0"
1313BGCOLOR="#D6E8FF"
1314WIDTH="100%"
1315CELLPADDING="6"
1316><TR
1317><TD
1318><PRE
1319CLASS="PROGRAMLISTING"
1320><A
1321HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1322>docbParserCtxtPtr</A
1323> docbCreatePushParserCtxt (<A
1324HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
1325>docbSAXHandlerPtr</A
1326> sax,
1327 void *user_data,
1328 const char *chunk,
1329 int size,
1330 const char *filename,
1331 <A
1332HREF="libxml-encoding.html#XMLCHARENCODING"
1333>xmlCharEncoding</A
1334> enc);</PRE
1335></TD
1336></TR
1337></TABLE
1338><P
1339>Create a parser context for using the DocBook SGML parser in push mode
1340To allow content encoding detection, <TT
1341CLASS="PARAMETER"
1342><I
1343>size</I
1344></TT
1345> should be &gt;= 4
1346The value of <TT
1347CLASS="PARAMETER"
1348><I
1349>filename</I
1350></TT
1351> is used for fetching external entities
1352and error/warning reports.</P
1353><P
1354></P
1355><DIV
1356CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001357><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001358NAME="AEN23884"
1359></A
1360><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001361></P
1362><TABLE
1363BORDER="0"
1364WIDTH="100%"
1365BGCOLOR="#FFD0D0"
1366CELLSPACING="0"
1367CELLPADDING="4"
1368CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001369><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001370><TR
1371><TD
1372WIDTH="20%"
1373ALIGN="RIGHT"
1374VALIGN="TOP"
1375><TT
1376CLASS="PARAMETER"
1377><I
1378>sax</I
1379></TT
1380>&nbsp;:</TD
1381><TD
1382WIDTH="80%"
1383ALIGN="LEFT"
1384VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001385> a SAX handler</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001386></TR
1387><TR
1388><TD
1389WIDTH="20%"
1390ALIGN="RIGHT"
1391VALIGN="TOP"
1392><TT
1393CLASS="PARAMETER"
1394><I
1395>user_data</I
1396></TT
1397>&nbsp;:</TD
1398><TD
1399WIDTH="80%"
1400ALIGN="LEFT"
1401VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001402> The user data returned on SAX callbacks</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001403></TR
1404><TR
1405><TD
1406WIDTH="20%"
1407ALIGN="RIGHT"
1408VALIGN="TOP"
1409><TT
1410CLASS="PARAMETER"
1411><I
1412>chunk</I
1413></TT
1414>&nbsp;:</TD
1415><TD
1416WIDTH="80%"
1417ALIGN="LEFT"
1418VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001419> a pointer to an array of chars</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001420></TR
1421><TR
1422><TD
1423WIDTH="20%"
1424ALIGN="RIGHT"
1425VALIGN="TOP"
1426><TT
1427CLASS="PARAMETER"
1428><I
1429>size</I
1430></TT
1431>&nbsp;:</TD
1432><TD
1433WIDTH="80%"
1434ALIGN="LEFT"
1435VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001436> number of chars in the array</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001437></TR
1438><TR
1439><TD
1440WIDTH="20%"
1441ALIGN="RIGHT"
1442VALIGN="TOP"
1443><TT
1444CLASS="PARAMETER"
1445><I
1446>filename</I
1447></TT
1448>&nbsp;:</TD
1449><TD
1450WIDTH="80%"
1451ALIGN="LEFT"
1452VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001453> an optional file name or URI</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001454></TR
1455><TR
1456><TD
1457WIDTH="20%"
1458ALIGN="RIGHT"
1459VALIGN="TOP"
1460><TT
1461CLASS="PARAMETER"
1462><I
1463>enc</I
1464></TT
1465>&nbsp;:</TD
1466><TD
1467WIDTH="80%"
1468ALIGN="LEFT"
1469VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001470> an optional encoding</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001471></TR
1472><TR
1473><TD
1474WIDTH="20%"
1475ALIGN="RIGHT"
1476VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001477><SPAN
1478CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001479><I
1480CLASS="EMPHASIS"
1481>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001482></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001483> :</TD
1484><TD
1485WIDTH="80%"
1486ALIGN="LEFT"
1487VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001488>the new parser context or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001489></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001490></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001491></TABLE
1492><P
1493></P
1494></DIV
1495></DIV
1496><HR><DIV
1497CLASS="REFSECT2"
1498><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001499NAME="AEN23917"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001500></A
1501><H3
1502><A
1503NAME="DOCBPARSECHUNK"
1504></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001505>docbParseChunk ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001506><TABLE
1507BORDER="0"
1508BGCOLOR="#D6E8FF"
1509WIDTH="100%"
1510CELLPADDING="6"
1511><TR
1512><TD
1513><PRE
1514CLASS="PROGRAMLISTING"
1515>int docbParseChunk (<A
1516HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1517>docbParserCtxtPtr</A
1518> ctxt,
1519 const char *chunk,
1520 int size,
1521 int terminate);</PRE
1522></TD
1523></TR
1524></TABLE
1525><P
1526>Parse a Chunk of memory</P
1527><P
1528></P
1529><DIV
1530CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001531><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001532NAME="AEN23924"
1533></A
1534><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001535></P
1536><TABLE
1537BORDER="0"
1538WIDTH="100%"
1539BGCOLOR="#FFD0D0"
1540CELLSPACING="0"
1541CELLPADDING="4"
1542CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001543><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001544><TR
1545><TD
1546WIDTH="20%"
1547ALIGN="RIGHT"
1548VALIGN="TOP"
1549><TT
1550CLASS="PARAMETER"
1551><I
1552>ctxt</I
1553></TT
1554>&nbsp;:</TD
1555><TD
1556WIDTH="80%"
1557ALIGN="LEFT"
1558VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001559> an XML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001560></TR
1561><TR
1562><TD
1563WIDTH="20%"
1564ALIGN="RIGHT"
1565VALIGN="TOP"
1566><TT
1567CLASS="PARAMETER"
1568><I
1569>chunk</I
1570></TT
1571>&nbsp;:</TD
1572><TD
1573WIDTH="80%"
1574ALIGN="LEFT"
1575VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001576> an char array</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001577></TR
1578><TR
1579><TD
1580WIDTH="20%"
1581ALIGN="RIGHT"
1582VALIGN="TOP"
1583><TT
1584CLASS="PARAMETER"
1585><I
1586>size</I
1587></TT
1588>&nbsp;:</TD
1589><TD
1590WIDTH="80%"
1591ALIGN="LEFT"
1592VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001593> the size in byte of the chunk</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001594></TR
1595><TR
1596><TD
1597WIDTH="20%"
1598ALIGN="RIGHT"
1599VALIGN="TOP"
1600><TT
1601CLASS="PARAMETER"
1602><I
1603>terminate</I
1604></TT
1605>&nbsp;:</TD
1606><TD
1607WIDTH="80%"
1608ALIGN="LEFT"
1609VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001610> last chunk indicator</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001611></TR
1612><TR
1613><TD
1614WIDTH="20%"
1615ALIGN="RIGHT"
1616VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001617><SPAN
1618CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001619><I
1620CLASS="EMPHASIS"
1621>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001622></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001623> :</TD
1624><TD
1625WIDTH="80%"
1626ALIGN="LEFT"
1627VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001628>zero if no error, the xmlParserErrors otherwise.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001629></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001630></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001631></TABLE
1632><P
1633></P
1634></DIV
1635></DIV
1636><HR><DIV
1637CLASS="REFSECT2"
1638><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001639NAME="AEN23949"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001640></A
1641><H3
1642><A
1643NAME="DOCBCREATEFILEPARSERCTXT"
1644></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001645>docbCreateFileParserCtxt ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001646><TABLE
1647BORDER="0"
1648BGCOLOR="#D6E8FF"
1649WIDTH="100%"
1650CELLPADDING="6"
1651><TR
1652><TD
1653><PRE
1654CLASS="PROGRAMLISTING"
1655><A
1656HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1657>docbParserCtxtPtr</A
1658> docbCreateFileParserCtxt (const char *filename,
1659 const char *encoding);</PRE
1660></TD
1661></TR
1662></TABLE
1663><P
1664>Create a parser context for a file content.
1665Automatic support for ZLIB/Compress compressed document is provided
1666by default if found at compile-time.</P
1667><P
1668></P
1669><DIV
1670CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001671><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001672NAME="AEN23956"
1673></A
1674><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001675></P
1676><TABLE
1677BORDER="0"
1678WIDTH="100%"
1679BGCOLOR="#FFD0D0"
1680CELLSPACING="0"
1681CELLPADDING="4"
1682CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001683><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001684><TR
1685><TD
1686WIDTH="20%"
1687ALIGN="RIGHT"
1688VALIGN="TOP"
1689><TT
1690CLASS="PARAMETER"
1691><I
1692>filename</I
1693></TT
1694>&nbsp;:</TD
1695><TD
1696WIDTH="80%"
1697ALIGN="LEFT"
1698VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001699> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001700></TR
1701><TR
1702><TD
1703WIDTH="20%"
1704ALIGN="RIGHT"
1705VALIGN="TOP"
1706><TT
1707CLASS="PARAMETER"
1708><I
1709>encoding</I
1710></TT
1711>&nbsp;:</TD
1712><TD
1713WIDTH="80%"
1714ALIGN="LEFT"
1715VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001716> the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001717></TR
1718><TR
1719><TD
1720WIDTH="20%"
1721ALIGN="RIGHT"
1722VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001723><SPAN
1724CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001725><I
1726CLASS="EMPHASIS"
1727>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001728></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001729> :</TD
1730><TD
1731WIDTH="80%"
1732ALIGN="LEFT"
1733VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001734>the new parser context or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001735></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001736></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001737></TABLE
1738><P
1739></P
1740></DIV
1741></DIV
1742><HR><DIV
1743CLASS="REFSECT2"
1744><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001745NAME="AEN23973"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001746></A
1747><H3
1748><A
1749NAME="DOCBPARSEDOCUMENT"
1750></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001751>docbParseDocument ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001752><TABLE
1753BORDER="0"
1754BGCOLOR="#D6E8FF"
1755WIDTH="100%"
1756CELLPADDING="6"
1757><TR
1758><TD
1759><PRE
1760CLASS="PROGRAMLISTING"
1761>int docbParseDocument (<A
1762HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1763>docbParserCtxtPtr</A
1764> ctxt);</PRE
1765></TD
1766></TR
1767></TABLE
1768><P
1769>parse an SGML document (and build a tree if using the standard SAX
1770interface).</P
1771><P
1772></P
1773><DIV
1774CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001775><A
Daniel Veillardaec63562003-03-23 20:42:17 +00001776NAME="AEN23980"
1777></A
1778><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001779></P
1780><TABLE
1781BORDER="0"
1782WIDTH="100%"
1783BGCOLOR="#FFD0D0"
1784CELLSPACING="0"
1785CELLPADDING="4"
1786CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001787><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001788><TR
1789><TD
1790WIDTH="20%"
1791ALIGN="RIGHT"
1792VALIGN="TOP"
1793><TT
1794CLASS="PARAMETER"
1795><I
1796>ctxt</I
1797></TT
1798>&nbsp;:</TD
1799><TD
1800WIDTH="80%"
1801ALIGN="LEFT"
1802VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001803> an SGML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001804></TR
1805><TR
1806><TD
1807WIDTH="20%"
1808ALIGN="RIGHT"
1809VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001810><SPAN
1811CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001812><I
1813CLASS="EMPHASIS"
1814>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001815></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001816> :</TD
1817><TD
1818WIDTH="80%"
1819ALIGN="LEFT"
1820VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001821>0, -1 in case of error. the parser context is augmented
Daniel Veillardaec63562003-03-23 20:42:17 +00001822 as a result of the parsing.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001823></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001824></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001825></TABLE
1826><P
1827></P
1828></DIV
1829></DIV
1830></DIV
1831><DIV
1832CLASS="NAVFOOTER"
1833><BR
1834CLEAR="all"><BR><TABLE
1835WIDTH="100%"
1836BORDER="0"
1837BGCOLOR="#000000"
1838CELLPADDING="1"
1839CELLSPACING="0"
1840><TR
1841><TD
1842WIDTH="25%"
1843BGCOLOR="#C00000"
1844ALIGN="left"
1845><A
Daniel Veillard52dcab32001-10-30 12:51:17 +00001846HREF="libxml-globals.html"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001847><FONT
1848COLOR="#FFFFFF"
1849SIZE="3"
1850><B
1851>&#60;&#60;&#60; Previous Page</B
1852></FONT
1853></A
1854></TD
1855><TD
1856WIDTH="25%"
1857BGCOLOR="#0000C0"
1858ALIGN="center"
1859><FONT
1860COLOR="#FFFFFF"
1861SIZE="3"
1862><B
1863><A
1864HREF="book1.html"
1865><FONT
1866COLOR="#FFFFFF"
1867SIZE="3"
1868><B
1869>Home</B
1870></FONT
1871></A
1872></B
1873></FONT
1874></TD
1875><TD
1876WIDTH="25%"
1877BGCOLOR="#00C000"
1878ALIGN="center"
1879><FONT
1880COLOR="#FFFFFF"
1881SIZE="3"
1882><B
1883><A
1884HREF="libxml-lib.html"
1885><FONT
1886COLOR="#FFFFFF"
1887SIZE="3"
1888><B
1889>Up</B
1890></FONT
1891></A
1892></B
1893></FONT
1894></TD
1895><TD
1896WIDTH="25%"
1897BGCOLOR="#C00000"
1898ALIGN="right"
1899><A
1900HREF="libxml-parserinternals.html"
1901><FONT
1902COLOR="#FFFFFF"
1903SIZE="3"
1904><B
1905>Next Page &#62;&#62;&#62;</B
1906></FONT
1907></A
1908></TD
1909></TR
1910><TR
1911><TD
1912COLSPAN="2"
1913ALIGN="left"
1914><FONT
1915COLOR="#FFFFFF"
1916SIZE="3"
1917><B
Daniel Veillard52dcab32001-10-30 12:51:17 +00001918>globals</B
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001919></FONT
1920></TD
1921><TD
1922COLSPAN="2"
1923ALIGN="right"
1924><FONT
1925COLOR="#FFFFFF"
1926SIZE="3"
1927><B
1928>parserInternals</B
1929></FONT
1930></TD
1931></TR
1932></TABLE
1933></DIV
1934></BODY
1935></HTML
1936>