blob: 2d79e1047a6eec2a19030e16c8c568eb29d473a1 [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 Veillard539638b2002-07-06 19:55:14 +0000120NAME="LIBXML-DOCBPARSER">DOCBparser</H1
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000121><DIV
122CLASS="REFNAMEDIV"
123><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000124NAME="AEN21191"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000125></A
126><H2
127>Name</H2
128>DOCBparser&nbsp;--&nbsp;</DIV
129><DIV
130CLASS="REFSYNOPSISDIV"
131><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000132NAME="AEN21194"><H2
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000133>Synopsis</H2
134><TABLE
135BORDER="0"
136BGCOLOR="#D6E8FF"
137WIDTH="100%"
138CELLPADDING="6"
139><TR
140><TD
141><PRE
142CLASS="SYNOPSIS"
143>&#13;
144
145typedef <A
146HREF="libxml-docbparser.html#DOCBPARSERCTXT"
147>docbParserCtxt</A
148>;
149typedef <A
150HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
151>docbParserCtxtPtr</A
152>;
153typedef <A
154HREF="libxml-docbparser.html#DOCBPARSERNODEINFO"
155>docbParserNodeInfo</A
156>;
157typedef <A
158HREF="libxml-docbparser.html#DOCBSAXHANDLER"
159>docbSAXHandler</A
160>;
161typedef <A
162HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
163>docbSAXHandlerPtr</A
164>;
165typedef <A
166HREF="libxml-docbparser.html#DOCBPARSERINPUT"
167>docbParserInput</A
168>;
169typedef <A
170HREF="libxml-docbparser.html#DOCBPARSERINPUTPTR"
171>docbParserInputPtr</A
172>;
173typedef <A
174HREF="libxml-docbparser.html#DOCBDOCPTR"
175>docbDocPtr</A
176>;
177typedef <A
178HREF="libxml-docbparser.html#DOCBNODEPTR"
179>docbNodePtr</A
180>;
181int <A
182HREF="libxml-docbparser.html#DOCBENCODEENTITIES"
183>docbEncodeEntities</A
184> (unsigned char *out,
185 int *outlen,
186 unsigned char *in,
187 int *inlen,
188 int quoteChar);
189<A
190HREF="libxml-docbparser.html#DOCBDOCPTR"
191>docbDocPtr</A
192> <A
193HREF="libxml-docbparser.html#DOCBSAXPARSEDOC"
194>docbSAXParseDoc</A
195> (<A
196HREF="libxml-tree.html#XMLCHAR"
197>xmlChar</A
198> *cur,
199 const char *encoding,
200 <A
201HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
202>docbSAXHandlerPtr</A
203> sax,
204 void *userData);
205<A
206HREF="libxml-docbparser.html#DOCBDOCPTR"
207>docbDocPtr</A
208> <A
209HREF="libxml-docbparser.html#DOCBPARSEDOC"
210>docbParseDoc</A
211> (<A
212HREF="libxml-tree.html#XMLCHAR"
213>xmlChar</A
214> *cur,
215 const char *encoding);
216<A
217HREF="libxml-docbparser.html#DOCBDOCPTR"
218>docbDocPtr</A
219> <A
220HREF="libxml-docbparser.html#DOCBSAXPARSEFILE"
221>docbSAXParseFile</A
222> (const char *filename,
223 const char *encoding,
224 <A
225HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
226>docbSAXHandlerPtr</A
227> sax,
228 void *userData);
229<A
230HREF="libxml-docbparser.html#DOCBDOCPTR"
231>docbDocPtr</A
232> <A
233HREF="libxml-docbparser.html#DOCBPARSEFILE"
234>docbParseFile</A
235> (const char *filename,
236 const char *encoding);
237void <A
238HREF="libxml-docbparser.html#DOCBFREEPARSERCTXT"
239>docbFreeParserCtxt</A
240> (<A
241HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
242>docbParserCtxtPtr</A
243> ctxt);
244<A
245HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
246>docbParserCtxtPtr</A
247> <A
248HREF="libxml-docbparser.html#DOCBCREATEPUSHPARSERCTXT"
249>docbCreatePushParserCtxt</A
250> (<A
251HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
252>docbSAXHandlerPtr</A
253> sax,
254 void *user_data,
255 const char *chunk,
256 int size,
257 const char *filename,
258 <A
259HREF="libxml-encoding.html#XMLCHARENCODING"
260>xmlCharEncoding</A
261> enc);
262int <A
263HREF="libxml-docbparser.html#DOCBPARSECHUNK"
264>docbParseChunk</A
265> (<A
266HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
267>docbParserCtxtPtr</A
268> ctxt,
269 const char *chunk,
270 int size,
271 int terminate);
272<A
273HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
274>docbParserCtxtPtr</A
275> <A
276HREF="libxml-docbparser.html#DOCBCREATEFILEPARSERCTXT"
277>docbCreateFileParserCtxt</A
278> (const char *filename,
279 const char *encoding);
280int <A
281HREF="libxml-docbparser.html#DOCBPARSEDOCUMENT"
282>docbParseDocument</A
283> (<A
284HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
285>docbParserCtxtPtr</A
286> ctxt);</PRE
287></TD
288></TR
289></TABLE
290></DIV
291><DIV
292CLASS="REFSECT1"
293><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000294NAME="AEN21231"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000295></A
296><H2
297>Description</H2
298><P
299></P
300></DIV
301><DIV
302CLASS="REFSECT1"
303><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000304NAME="AEN21234"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000305></A
306><H2
307>Details</H2
308><DIV
309CLASS="REFSECT2"
310><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000311NAME="AEN21236"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000312></A
313><H3
314><A
315NAME="DOCBPARSERCTXT"
316></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000317>docbParserCtxt</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000318><TABLE
319BORDER="0"
320BGCOLOR="#D6E8FF"
321WIDTH="100%"
322CELLPADDING="6"
323><TR
324><TD
325><PRE
326CLASS="PROGRAMLISTING"
327>typedef xmlParserCtxt docbParserCtxt;</PRE
328></TD
329></TR
330></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000331><P
332></P
333></DIV
334><HR><DIV
335CLASS="REFSECT2"
336><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000337NAME="AEN21241"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000338></A
339><H3
340><A
341NAME="DOCBPARSERCTXTPTR"
342></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000343>docbParserCtxtPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000344><TABLE
345BORDER="0"
346BGCOLOR="#D6E8FF"
347WIDTH="100%"
348CELLPADDING="6"
349><TR
350><TD
351><PRE
352CLASS="PROGRAMLISTING"
353>typedef xmlParserCtxtPtr docbParserCtxtPtr;</PRE
354></TD
355></TR
356></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000357><P
358></P
359></DIV
360><HR><DIV
361CLASS="REFSECT2"
362><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000363NAME="AEN21246"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000364></A
365><H3
366><A
367NAME="DOCBPARSERNODEINFO"
368></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000369>docbParserNodeInfo</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000370><TABLE
371BORDER="0"
372BGCOLOR="#D6E8FF"
373WIDTH="100%"
374CELLPADDING="6"
375><TR
376><TD
377><PRE
378CLASS="PROGRAMLISTING"
379>typedef xmlParserNodeInfo docbParserNodeInfo;</PRE
380></TD
381></TR
382></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000383><P
384></P
385></DIV
386><HR><DIV
387CLASS="REFSECT2"
388><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000389NAME="AEN21251"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000390></A
391><H3
392><A
393NAME="DOCBSAXHANDLER"
394></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000395>docbSAXHandler</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000396><TABLE
397BORDER="0"
398BGCOLOR="#D6E8FF"
399WIDTH="100%"
400CELLPADDING="6"
401><TR
402><TD
403><PRE
404CLASS="PROGRAMLISTING"
405>typedef xmlSAXHandler docbSAXHandler;</PRE
406></TD
407></TR
408></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000409><P
410></P
411></DIV
412><HR><DIV
413CLASS="REFSECT2"
414><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000415NAME="AEN21256"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000416></A
417><H3
418><A
419NAME="DOCBSAXHANDLERPTR"
420></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000421>docbSAXHandlerPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000422><TABLE
423BORDER="0"
424BGCOLOR="#D6E8FF"
425WIDTH="100%"
426CELLPADDING="6"
427><TR
428><TD
429><PRE
430CLASS="PROGRAMLISTING"
431>typedef xmlSAXHandlerPtr docbSAXHandlerPtr;</PRE
432></TD
433></TR
434></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000435><P
436></P
437></DIV
438><HR><DIV
439CLASS="REFSECT2"
440><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000441NAME="AEN21261"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000442></A
443><H3
444><A
445NAME="DOCBPARSERINPUT"
446></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000447>docbParserInput</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000448><TABLE
449BORDER="0"
450BGCOLOR="#D6E8FF"
451WIDTH="100%"
452CELLPADDING="6"
453><TR
454><TD
455><PRE
456CLASS="PROGRAMLISTING"
457>typedef xmlParserInput docbParserInput;</PRE
458></TD
459></TR
460></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000461><P
462></P
463></DIV
464><HR><DIV
465CLASS="REFSECT2"
466><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000467NAME="AEN21266"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000468></A
469><H3
470><A
471NAME="DOCBPARSERINPUTPTR"
472></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000473>docbParserInputPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000474><TABLE
475BORDER="0"
476BGCOLOR="#D6E8FF"
477WIDTH="100%"
478CELLPADDING="6"
479><TR
480><TD
481><PRE
482CLASS="PROGRAMLISTING"
483>typedef xmlParserInputPtr docbParserInputPtr;</PRE
484></TD
485></TR
486></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000487><P
488></P
489></DIV
490><HR><DIV
491CLASS="REFSECT2"
492><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000493NAME="AEN21271"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000494></A
495><H3
496><A
497NAME="DOCBDOCPTR"
498></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000499>docbDocPtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000500><TABLE
501BORDER="0"
502BGCOLOR="#D6E8FF"
503WIDTH="100%"
504CELLPADDING="6"
505><TR
506><TD
507><PRE
508CLASS="PROGRAMLISTING"
509>typedef xmlDocPtr docbDocPtr;</PRE
510></TD
511></TR
512></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000513><P
514></P
515></DIV
516><HR><DIV
517CLASS="REFSECT2"
518><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000519NAME="AEN21276"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000520></A
521><H3
522><A
523NAME="DOCBNODEPTR"
524></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000525>docbNodePtr</H3
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000526><TABLE
527BORDER="0"
528BGCOLOR="#D6E8FF"
529WIDTH="100%"
530CELLPADDING="6"
531><TR
532><TD
533><PRE
534CLASS="PROGRAMLISTING"
535>typedef xmlNodePtr docbNodePtr;</PRE
536></TD
537></TR
538></TABLE
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000539><P
540></P
541></DIV
542><HR><DIV
543CLASS="REFSECT2"
544><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000545NAME="AEN21281"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000546></A
547><H3
548><A
549NAME="DOCBENCODEENTITIES"
550></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000551>docbEncodeEntities ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000552><TABLE
553BORDER="0"
554BGCOLOR="#D6E8FF"
555WIDTH="100%"
556CELLPADDING="6"
557><TR
558><TD
559><PRE
560CLASS="PROGRAMLISTING"
561>int docbEncodeEntities (unsigned char *out,
562 int *outlen,
563 unsigned char *in,
564 int *inlen,
565 int quoteChar);</PRE
566></TD
567></TR
568></TABLE
569><P
570>Take a block of UTF-8 chars in and try to convert it to an ASCII
571plus SGML entities block of chars out.</P
572><P
573></P
574><DIV
575CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000576><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000577NAME="AEN21287"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000578></P
579><TABLE
580BORDER="0"
581WIDTH="100%"
582BGCOLOR="#FFD0D0"
583CELLSPACING="0"
584CELLPADDING="4"
585CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000586><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000587><TR
588><TD
589WIDTH="20%"
590ALIGN="RIGHT"
591VALIGN="TOP"
592><TT
593CLASS="PARAMETER"
594><I
595>out</I
596></TT
597>&nbsp;:</TD
598><TD
599WIDTH="80%"
600ALIGN="LEFT"
601VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000602> a pointer to an array of bytes to store the result</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000603></TR
604><TR
605><TD
606WIDTH="20%"
607ALIGN="RIGHT"
608VALIGN="TOP"
609><TT
610CLASS="PARAMETER"
611><I
612>outlen</I
613></TT
614>&nbsp;:</TD
615><TD
616WIDTH="80%"
617ALIGN="LEFT"
618VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000619> the length of <TT
620CLASS="PARAMETER"
621><I
622>out</I
623></TT
624></TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000625></TR
626><TR
627><TD
628WIDTH="20%"
629ALIGN="RIGHT"
630VALIGN="TOP"
631><TT
632CLASS="PARAMETER"
633><I
634>in</I
635></TT
636>&nbsp;:</TD
637><TD
638WIDTH="80%"
639ALIGN="LEFT"
640VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000641> a pointer to an array of UTF-8 chars</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000642></TR
643><TR
644><TD
645WIDTH="20%"
646ALIGN="RIGHT"
647VALIGN="TOP"
648><TT
649CLASS="PARAMETER"
650><I
651>inlen</I
652></TT
653>&nbsp;:</TD
654><TD
655WIDTH="80%"
656ALIGN="LEFT"
657VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000658> the length of <TT
659CLASS="PARAMETER"
660><I
661>in</I
662></TT
663></TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000664></TR
665><TR
666><TD
667WIDTH="20%"
668ALIGN="RIGHT"
669VALIGN="TOP"
670><TT
671CLASS="PARAMETER"
672><I
673>quoteChar</I
674></TT
675>&nbsp;:</TD
676><TD
677WIDTH="80%"
678ALIGN="LEFT"
679VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000680> the quote character to escape (' or ") or zero.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000681></TR
682><TR
683><TD
684WIDTH="20%"
685ALIGN="RIGHT"
686VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +0000687><SPAN
688CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000689><I
690CLASS="EMPHASIS"
691>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +0000692></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000693> :</TD
694><TD
695WIDTH="80%"
696ALIGN="LEFT"
697VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000698>0 if success, -2 if the transcoding fails, or -1 otherwise
699The value of <TT
700CLASS="PARAMETER"
701><I
702>inlen</I
703></TT
704> after return is the number of octets consumed
Daniel Veillardaf43f632002-03-08 15:05:20 +0000705as the return value is positive, else unpredictable.
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000706The value of <TT
707CLASS="PARAMETER"
708><I
709>outlen</I
710></TT
711> after return is the number of octets consumed.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000712></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000713></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000714></TABLE
715><P
716></P
717></DIV
718></DIV
719><HR><DIV
720CLASS="REFSECT2"
721><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000722NAME="AEN21320"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000723></A
724><H3
725><A
726NAME="DOCBSAXPARSEDOC"
727></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000728>docbSAXParseDoc ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000729><TABLE
730BORDER="0"
731BGCOLOR="#D6E8FF"
732WIDTH="100%"
733CELLPADDING="6"
734><TR
735><TD
736><PRE
737CLASS="PROGRAMLISTING"
738><A
739HREF="libxml-docbparser.html#DOCBDOCPTR"
740>docbDocPtr</A
741> docbSAXParseDoc (<A
742HREF="libxml-tree.html#XMLCHAR"
743>xmlChar</A
744> *cur,
745 const char *encoding,
746 <A
747HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
748>docbSAXHandlerPtr</A
749> sax,
750 void *userData);</PRE
751></TD
752></TR
753></TABLE
754><P
755>parse an SGML in-memory document and build a tree.
756It use the given SAX function block to handle the parsing callback.
757If sax is NULL, fallback to the default DOM tree building routines.</P
758><P
759></P
760><DIV
761CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000762><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000763NAME="AEN21329"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000764></P
765><TABLE
766BORDER="0"
767WIDTH="100%"
768BGCOLOR="#FFD0D0"
769CELLSPACING="0"
770CELLPADDING="4"
771CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000772><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000773><TR
774><TD
775WIDTH="20%"
776ALIGN="RIGHT"
777VALIGN="TOP"
778><TT
779CLASS="PARAMETER"
780><I
781>cur</I
782></TT
783>&nbsp;:</TD
784><TD
785WIDTH="80%"
786ALIGN="LEFT"
787VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000788> a pointer to an array of xmlChar</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000789></TR
790><TR
791><TD
792WIDTH="20%"
793ALIGN="RIGHT"
794VALIGN="TOP"
795><TT
796CLASS="PARAMETER"
797><I
798>encoding</I
799></TT
800>&nbsp;:</TD
801><TD
802WIDTH="80%"
803ALIGN="LEFT"
804VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000805> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000806></TR
807><TR
808><TD
809WIDTH="20%"
810ALIGN="RIGHT"
811VALIGN="TOP"
812><TT
813CLASS="PARAMETER"
814><I
815>sax</I
816></TT
817>&nbsp;:</TD
818><TD
819WIDTH="80%"
820ALIGN="LEFT"
821VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000822> the SAX handler block</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000823></TR
824><TR
825><TD
826WIDTH="20%"
827ALIGN="RIGHT"
828VALIGN="TOP"
829><TT
830CLASS="PARAMETER"
831><I
832>userData</I
833></TT
834>&nbsp;:</TD
835><TD
836WIDTH="80%"
837ALIGN="LEFT"
838VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000839> if using SAX, this pointer will be provided on callbacks. </TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000840></TR
841><TR
842><TD
843WIDTH="20%"
844ALIGN="RIGHT"
845VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +0000846><SPAN
847CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000848><I
849CLASS="EMPHASIS"
850>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +0000851></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000852> :</TD
853><TD
854WIDTH="80%"
855ALIGN="LEFT"
856VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000857>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000858></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000859></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000860></TABLE
861><P
862></P
863></DIV
864></DIV
865><HR><DIV
866CLASS="REFSECT2"
867><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000868NAME="AEN21354"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000869></A
870><H3
871><A
872NAME="DOCBPARSEDOC"
873></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000874>docbParseDoc ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000875><TABLE
876BORDER="0"
877BGCOLOR="#D6E8FF"
878WIDTH="100%"
879CELLPADDING="6"
880><TR
881><TD
882><PRE
883CLASS="PROGRAMLISTING"
884><A
885HREF="libxml-docbparser.html#DOCBDOCPTR"
886>docbDocPtr</A
887> docbParseDoc (<A
888HREF="libxml-tree.html#XMLCHAR"
889>xmlChar</A
890> *cur,
891 const char *encoding);</PRE
892></TD
893></TR
894></TABLE
895><P
896>parse an SGML in-memory document and build a tree.</P
897><P
898></P
899><DIV
900CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000901><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000902NAME="AEN21362"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000903></P
904><TABLE
905BORDER="0"
906WIDTH="100%"
907BGCOLOR="#FFD0D0"
908CELLSPACING="0"
909CELLPADDING="4"
910CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +0000911><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000912><TR
913><TD
914WIDTH="20%"
915ALIGN="RIGHT"
916VALIGN="TOP"
917><TT
918CLASS="PARAMETER"
919><I
920>cur</I
921></TT
922>&nbsp;:</TD
923><TD
924WIDTH="80%"
925ALIGN="LEFT"
926VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000927> a pointer to an array of xmlChar</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000928></TR
929><TR
930><TD
931WIDTH="20%"
932ALIGN="RIGHT"
933VALIGN="TOP"
934><TT
935CLASS="PARAMETER"
936><I
937>encoding</I
938></TT
939>&nbsp;:</TD
940><TD
941WIDTH="80%"
942ALIGN="LEFT"
943VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000944> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000945></TR
946><TR
947><TD
948WIDTH="20%"
949ALIGN="RIGHT"
950VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +0000951><SPAN
952CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000953><I
954CLASS="EMPHASIS"
955>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +0000956></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000957> :</TD
958><TD
959WIDTH="80%"
960ALIGN="LEFT"
961VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +0000962>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000963></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +0000964></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000965></TABLE
966><P
967></P
968></DIV
969></DIV
970><HR><DIV
971CLASS="REFSECT2"
972><A
Daniel Veillard539638b2002-07-06 19:55:14 +0000973NAME="AEN21379"
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000974></A
975><H3
976><A
977NAME="DOCBSAXPARSEFILE"
978></A
Daniel Veillardaf43f632002-03-08 15:05:20 +0000979>docbSAXParseFile ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +0000980><TABLE
981BORDER="0"
982BGCOLOR="#D6E8FF"
983WIDTH="100%"
984CELLPADDING="6"
985><TR
986><TD
987><PRE
988CLASS="PROGRAMLISTING"
989><A
990HREF="libxml-docbparser.html#DOCBDOCPTR"
991>docbDocPtr</A
992> docbSAXParseFile (const char *filename,
993 const char *encoding,
994 <A
995HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
996>docbSAXHandlerPtr</A
997> sax,
998 void *userData);</PRE
999></TD
1000></TR
1001></TABLE
1002><P
1003>parse an SGML file and build a tree. Automatic support for ZLIB/Compress
1004compressed document is provided by default if found at compile-time.
1005It use the given SAX function block to handle the parsing callback.
1006If sax is NULL, fallback to the default DOM tree building routines.</P
1007><P
1008></P
1009><DIV
1010CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001011><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001012NAME="AEN21387"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001013></P
1014><TABLE
1015BORDER="0"
1016WIDTH="100%"
1017BGCOLOR="#FFD0D0"
1018CELLSPACING="0"
1019CELLPADDING="4"
1020CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001021><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001022><TR
1023><TD
1024WIDTH="20%"
1025ALIGN="RIGHT"
1026VALIGN="TOP"
1027><TT
1028CLASS="PARAMETER"
1029><I
1030>filename</I
1031></TT
1032>&nbsp;:</TD
1033><TD
1034WIDTH="80%"
1035ALIGN="LEFT"
1036VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001037> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001038></TR
1039><TR
1040><TD
1041WIDTH="20%"
1042ALIGN="RIGHT"
1043VALIGN="TOP"
1044><TT
1045CLASS="PARAMETER"
1046><I
1047>encoding</I
1048></TT
1049>&nbsp;:</TD
1050><TD
1051WIDTH="80%"
1052ALIGN="LEFT"
1053VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001054> a free form C string describing the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001055></TR
1056><TR
1057><TD
1058WIDTH="20%"
1059ALIGN="RIGHT"
1060VALIGN="TOP"
1061><TT
1062CLASS="PARAMETER"
1063><I
1064>sax</I
1065></TT
1066>&nbsp;:</TD
1067><TD
1068WIDTH="80%"
1069ALIGN="LEFT"
1070VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001071> the SAX handler block</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001072></TR
1073><TR
1074><TD
1075WIDTH="20%"
1076ALIGN="RIGHT"
1077VALIGN="TOP"
1078><TT
1079CLASS="PARAMETER"
1080><I
1081>userData</I
1082></TT
1083>&nbsp;:</TD
1084><TD
1085WIDTH="80%"
1086ALIGN="LEFT"
1087VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001088> if using SAX, this pointer will be provided on callbacks. </TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001089></TR
1090><TR
1091><TD
1092WIDTH="20%"
1093ALIGN="RIGHT"
1094VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001095><SPAN
1096CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001097><I
1098CLASS="EMPHASIS"
1099>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001100></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001101> :</TD
1102><TD
1103WIDTH="80%"
1104ALIGN="LEFT"
1105VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001106>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001107></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001108></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001109></TABLE
1110><P
1111></P
1112></DIV
1113></DIV
1114><HR><DIV
1115CLASS="REFSECT2"
1116><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001117NAME="AEN21412"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001118></A
1119><H3
1120><A
1121NAME="DOCBPARSEFILE"
1122></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001123>docbParseFile ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001124><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 +00001149><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001150NAME="AEN21419"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001151></P
1152><TABLE
1153BORDER="0"
1154WIDTH="100%"
1155BGCOLOR="#FFD0D0"
1156CELLSPACING="0"
1157CELLPADDING="4"
1158CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001159><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001160><TR
1161><TD
1162WIDTH="20%"
1163ALIGN="RIGHT"
1164VALIGN="TOP"
1165><TT
1166CLASS="PARAMETER"
1167><I
1168>filename</I
1169></TT
1170>&nbsp;:</TD
1171><TD
1172WIDTH="80%"
1173ALIGN="LEFT"
1174VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001175> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001176></TR
1177><TR
1178><TD
1179WIDTH="20%"
1180ALIGN="RIGHT"
1181VALIGN="TOP"
1182><TT
1183CLASS="PARAMETER"
1184><I
1185>encoding</I
1186></TT
1187>&nbsp;:</TD
1188><TD
1189WIDTH="80%"
1190ALIGN="LEFT"
1191VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001192> a free form C string describing document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001193></TR
1194><TR
1195><TD
1196WIDTH="20%"
1197ALIGN="RIGHT"
1198VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001199><SPAN
1200CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001201><I
1202CLASS="EMPHASIS"
1203>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001204></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001205> :</TD
1206><TD
1207WIDTH="80%"
1208ALIGN="LEFT"
1209VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001210>the resulting document tree</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001211></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001212></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001213></TABLE
1214><P
1215></P
1216></DIV
1217></DIV
1218><HR><DIV
1219CLASS="REFSECT2"
1220><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001221NAME="AEN21436"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001222></A
1223><H3
1224><A
1225NAME="DOCBFREEPARSERCTXT"
1226></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001227>docbFreeParserCtxt ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001228><TABLE
1229BORDER="0"
1230BGCOLOR="#D6E8FF"
1231WIDTH="100%"
1232CELLPADDING="6"
1233><TR
1234><TD
1235><PRE
1236CLASS="PROGRAMLISTING"
1237>void docbFreeParserCtxt (<A
1238HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1239>docbParserCtxtPtr</A
1240> ctxt);</PRE
1241></TD
1242></TR
1243></TABLE
1244><P
1245>Free all the memory used by a parser context. However the parsed
1246document in ctxt-&gt;myDoc is not freed.</P
1247><P
1248></P
1249><DIV
1250CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001251><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001252NAME="AEN21443"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001253></P
1254><TABLE
1255BORDER="0"
1256WIDTH="100%"
1257BGCOLOR="#FFD0D0"
1258CELLSPACING="0"
1259CELLPADDING="4"
1260CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001261><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001262><TR
1263><TD
1264WIDTH="20%"
1265ALIGN="RIGHT"
1266VALIGN="TOP"
1267><TT
1268CLASS="PARAMETER"
1269><I
1270>ctxt</I
1271></TT
1272>&nbsp;:</TD
1273><TD
1274WIDTH="80%"
1275ALIGN="LEFT"
1276VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001277> an SGML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001278></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001279></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001280></TABLE
1281><P
1282></P
1283></DIV
1284></DIV
1285><HR><DIV
1286CLASS="REFSECT2"
1287><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001288NAME="AEN21452"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001289></A
1290><H3
1291><A
1292NAME="DOCBCREATEPUSHPARSERCTXT"
1293></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001294>docbCreatePushParserCtxt ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001295><TABLE
1296BORDER="0"
1297BGCOLOR="#D6E8FF"
1298WIDTH="100%"
1299CELLPADDING="6"
1300><TR
1301><TD
1302><PRE
1303CLASS="PROGRAMLISTING"
1304><A
1305HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1306>docbParserCtxtPtr</A
1307> docbCreatePushParserCtxt (<A
1308HREF="libxml-docbparser.html#DOCBSAXHANDLERPTR"
1309>docbSAXHandlerPtr</A
1310> sax,
1311 void *user_data,
1312 const char *chunk,
1313 int size,
1314 const char *filename,
1315 <A
1316HREF="libxml-encoding.html#XMLCHARENCODING"
1317>xmlCharEncoding</A
1318> enc);</PRE
1319></TD
1320></TR
1321></TABLE
1322><P
1323>Create a parser context for using the DocBook SGML parser in push mode
1324To allow content encoding detection, <TT
1325CLASS="PARAMETER"
1326><I
1327>size</I
1328></TT
1329> should be &gt;= 4
1330The value of <TT
1331CLASS="PARAMETER"
1332><I
1333>filename</I
1334></TT
1335> is used for fetching external entities
1336and error/warning reports.</P
1337><P
1338></P
1339><DIV
1340CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001341><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001342NAME="AEN21463"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001343></P
1344><TABLE
1345BORDER="0"
1346WIDTH="100%"
1347BGCOLOR="#FFD0D0"
1348CELLSPACING="0"
1349CELLPADDING="4"
1350CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001351><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001352><TR
1353><TD
1354WIDTH="20%"
1355ALIGN="RIGHT"
1356VALIGN="TOP"
1357><TT
1358CLASS="PARAMETER"
1359><I
1360>sax</I
1361></TT
1362>&nbsp;:</TD
1363><TD
1364WIDTH="80%"
1365ALIGN="LEFT"
1366VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001367> a SAX handler</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001368></TR
1369><TR
1370><TD
1371WIDTH="20%"
1372ALIGN="RIGHT"
1373VALIGN="TOP"
1374><TT
1375CLASS="PARAMETER"
1376><I
1377>user_data</I
1378></TT
1379>&nbsp;:</TD
1380><TD
1381WIDTH="80%"
1382ALIGN="LEFT"
1383VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001384> The user data returned on SAX callbacks</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001385></TR
1386><TR
1387><TD
1388WIDTH="20%"
1389ALIGN="RIGHT"
1390VALIGN="TOP"
1391><TT
1392CLASS="PARAMETER"
1393><I
1394>chunk</I
1395></TT
1396>&nbsp;:</TD
1397><TD
1398WIDTH="80%"
1399ALIGN="LEFT"
1400VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001401> a pointer to an array of chars</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001402></TR
1403><TR
1404><TD
1405WIDTH="20%"
1406ALIGN="RIGHT"
1407VALIGN="TOP"
1408><TT
1409CLASS="PARAMETER"
1410><I
1411>size</I
1412></TT
1413>&nbsp;:</TD
1414><TD
1415WIDTH="80%"
1416ALIGN="LEFT"
1417VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001418> number of chars in the array</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001419></TR
1420><TR
1421><TD
1422WIDTH="20%"
1423ALIGN="RIGHT"
1424VALIGN="TOP"
1425><TT
1426CLASS="PARAMETER"
1427><I
1428>filename</I
1429></TT
1430>&nbsp;:</TD
1431><TD
1432WIDTH="80%"
1433ALIGN="LEFT"
1434VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001435> an optional file name or URI</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001436></TR
1437><TR
1438><TD
1439WIDTH="20%"
1440ALIGN="RIGHT"
1441VALIGN="TOP"
1442><TT
1443CLASS="PARAMETER"
1444><I
1445>enc</I
1446></TT
1447>&nbsp;:</TD
1448><TD
1449WIDTH="80%"
1450ALIGN="LEFT"
1451VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001452> an optional encoding</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001453></TR
1454><TR
1455><TD
1456WIDTH="20%"
1457ALIGN="RIGHT"
1458VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001459><SPAN
1460CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001461><I
1462CLASS="EMPHASIS"
1463>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001464></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001465> :</TD
1466><TD
1467WIDTH="80%"
1468ALIGN="LEFT"
1469VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001470>the new parser context or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001471></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001472></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001473></TABLE
1474><P
1475></P
1476></DIV
1477></DIV
1478><HR><DIV
1479CLASS="REFSECT2"
1480><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001481NAME="AEN21496"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001482></A
1483><H3
1484><A
1485NAME="DOCBPARSECHUNK"
1486></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001487>docbParseChunk ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001488><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 +00001513><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001514NAME="AEN21503"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001515></P
1516><TABLE
1517BORDER="0"
1518WIDTH="100%"
1519BGCOLOR="#FFD0D0"
1520CELLSPACING="0"
1521CELLPADDING="4"
1522CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001523><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001524><TR
1525><TD
1526WIDTH="20%"
1527ALIGN="RIGHT"
1528VALIGN="TOP"
1529><TT
1530CLASS="PARAMETER"
1531><I
1532>ctxt</I
1533></TT
1534>&nbsp;:</TD
1535><TD
1536WIDTH="80%"
1537ALIGN="LEFT"
1538VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001539> an XML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001540></TR
1541><TR
1542><TD
1543WIDTH="20%"
1544ALIGN="RIGHT"
1545VALIGN="TOP"
1546><TT
1547CLASS="PARAMETER"
1548><I
1549>chunk</I
1550></TT
1551>&nbsp;:</TD
1552><TD
1553WIDTH="80%"
1554ALIGN="LEFT"
1555VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001556> an char array</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001557></TR
1558><TR
1559><TD
1560WIDTH="20%"
1561ALIGN="RIGHT"
1562VALIGN="TOP"
1563><TT
1564CLASS="PARAMETER"
1565><I
1566>size</I
1567></TT
1568>&nbsp;:</TD
1569><TD
1570WIDTH="80%"
1571ALIGN="LEFT"
1572VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001573> the size in byte of the chunk</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001574></TR
1575><TR
1576><TD
1577WIDTH="20%"
1578ALIGN="RIGHT"
1579VALIGN="TOP"
1580><TT
1581CLASS="PARAMETER"
1582><I
1583>terminate</I
1584></TT
1585>&nbsp;:</TD
1586><TD
1587WIDTH="80%"
1588ALIGN="LEFT"
1589VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001590> last chunk indicator</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001591></TR
1592><TR
1593><TD
1594WIDTH="20%"
1595ALIGN="RIGHT"
1596VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001597><SPAN
1598CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001599><I
1600CLASS="EMPHASIS"
1601>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001602></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001603> :</TD
1604><TD
1605WIDTH="80%"
1606ALIGN="LEFT"
1607VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001608>zero if no error, the xmlParserErrors otherwise.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001609></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001610></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001611></TABLE
1612><P
1613></P
1614></DIV
1615></DIV
1616><HR><DIV
1617CLASS="REFSECT2"
1618><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001619NAME="AEN21528"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001620></A
1621><H3
1622><A
1623NAME="DOCBCREATEFILEPARSERCTXT"
1624></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001625>docbCreateFileParserCtxt ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001626><TABLE
1627BORDER="0"
1628BGCOLOR="#D6E8FF"
1629WIDTH="100%"
1630CELLPADDING="6"
1631><TR
1632><TD
1633><PRE
1634CLASS="PROGRAMLISTING"
1635><A
1636HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1637>docbParserCtxtPtr</A
1638> docbCreateFileParserCtxt (const char *filename,
1639 const char *encoding);</PRE
1640></TD
1641></TR
1642></TABLE
1643><P
1644>Create a parser context for a file content.
1645Automatic support for ZLIB/Compress compressed document is provided
1646by default if found at compile-time.</P
1647><P
1648></P
1649><DIV
1650CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001651><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001652NAME="AEN21535"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001653></P
1654><TABLE
1655BORDER="0"
1656WIDTH="100%"
1657BGCOLOR="#FFD0D0"
1658CELLSPACING="0"
1659CELLPADDING="4"
1660CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001661><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001662><TR
1663><TD
1664WIDTH="20%"
1665ALIGN="RIGHT"
1666VALIGN="TOP"
1667><TT
1668CLASS="PARAMETER"
1669><I
1670>filename</I
1671></TT
1672>&nbsp;:</TD
1673><TD
1674WIDTH="80%"
1675ALIGN="LEFT"
1676VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001677> the filename</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001678></TR
1679><TR
1680><TD
1681WIDTH="20%"
1682ALIGN="RIGHT"
1683VALIGN="TOP"
1684><TT
1685CLASS="PARAMETER"
1686><I
1687>encoding</I
1688></TT
1689>&nbsp;:</TD
1690><TD
1691WIDTH="80%"
1692ALIGN="LEFT"
1693VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001694> the SGML document encoding, or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001695></TR
1696><TR
1697><TD
1698WIDTH="20%"
1699ALIGN="RIGHT"
1700VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001701><SPAN
1702CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001703><I
1704CLASS="EMPHASIS"
1705>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001706></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001707> :</TD
1708><TD
1709WIDTH="80%"
1710ALIGN="LEFT"
1711VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001712>the new parser context or NULL</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001713></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001714></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001715></TABLE
1716><P
1717></P
1718></DIV
1719></DIV
1720><HR><DIV
1721CLASS="REFSECT2"
1722><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001723NAME="AEN21552"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001724></A
1725><H3
1726><A
1727NAME="DOCBPARSEDOCUMENT"
1728></A
Daniel Veillardaf43f632002-03-08 15:05:20 +00001729>docbParseDocument ()</H3
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001730><TABLE
1731BORDER="0"
1732BGCOLOR="#D6E8FF"
1733WIDTH="100%"
1734CELLPADDING="6"
1735><TR
1736><TD
1737><PRE
1738CLASS="PROGRAMLISTING"
1739>int docbParseDocument (<A
1740HREF="libxml-docbparser.html#DOCBPARSERCTXTPTR"
1741>docbParserCtxtPtr</A
1742> ctxt);</PRE
1743></TD
1744></TR
1745></TABLE
1746><P
1747>parse an SGML document (and build a tree if using the standard SAX
1748interface).</P
1749><P
1750></P
1751><DIV
1752CLASS="INFORMALTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001753><A
Daniel Veillard539638b2002-07-06 19:55:14 +00001754NAME="AEN21559"><P
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001755></P
1756><TABLE
1757BORDER="0"
1758WIDTH="100%"
1759BGCOLOR="#FFD0D0"
1760CELLSPACING="0"
1761CELLPADDING="4"
1762CLASS="CALSTABLE"
Daniel Veillardbed7b052001-05-19 14:59:49 +00001763><TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001764><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 +00001779> an SGML parser context</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001780></TR
1781><TR
1782><TD
1783WIDTH="20%"
1784ALIGN="RIGHT"
1785VALIGN="TOP"
Daniel Veillard539638b2002-07-06 19:55:14 +00001786><SPAN
1787CLASS="emphasis"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001788><I
1789CLASS="EMPHASIS"
1790>Returns</I
Daniel Veillard539638b2002-07-06 19:55:14 +00001791></SPAN
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001792> :</TD
1793><TD
1794WIDTH="80%"
1795ALIGN="LEFT"
1796VALIGN="TOP"
Daniel Veillard4b8328d2001-07-05 22:48:42 +00001797>0, -1 in case of error. the parser context is augmented
Daniel Veillardaf43f632002-03-08 15:05:20 +00001798as a result of the parsing.</TD
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001799></TR
Daniel Veillardbed7b052001-05-19 14:59:49 +00001800></TBODY
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001801></TABLE
1802><P
1803></P
1804></DIV
1805></DIV
1806></DIV
1807><DIV
1808CLASS="NAVFOOTER"
1809><BR
1810CLEAR="all"><BR><TABLE
1811WIDTH="100%"
1812BORDER="0"
1813BGCOLOR="#000000"
1814CELLPADDING="1"
1815CELLSPACING="0"
1816><TR
1817><TD
1818WIDTH="25%"
1819BGCOLOR="#C00000"
1820ALIGN="left"
1821><A
Daniel Veillard52dcab32001-10-30 12:51:17 +00001822HREF="libxml-globals.html"
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001823><FONT
1824COLOR="#FFFFFF"
1825SIZE="3"
1826><B
1827>&#60;&#60;&#60; Previous Page</B
1828></FONT
1829></A
1830></TD
1831><TD
1832WIDTH="25%"
1833BGCOLOR="#0000C0"
1834ALIGN="center"
1835><FONT
1836COLOR="#FFFFFF"
1837SIZE="3"
1838><B
1839><A
1840HREF="book1.html"
1841><FONT
1842COLOR="#FFFFFF"
1843SIZE="3"
1844><B
1845>Home</B
1846></FONT
1847></A
1848></B
1849></FONT
1850></TD
1851><TD
1852WIDTH="25%"
1853BGCOLOR="#00C000"
1854ALIGN="center"
1855><FONT
1856COLOR="#FFFFFF"
1857SIZE="3"
1858><B
1859><A
1860HREF="libxml-lib.html"
1861><FONT
1862COLOR="#FFFFFF"
1863SIZE="3"
1864><B
1865>Up</B
1866></FONT
1867></A
1868></B
1869></FONT
1870></TD
1871><TD
1872WIDTH="25%"
1873BGCOLOR="#C00000"
1874ALIGN="right"
1875><A
1876HREF="libxml-parserinternals.html"
1877><FONT
1878COLOR="#FFFFFF"
1879SIZE="3"
1880><B
1881>Next Page &#62;&#62;&#62;</B
1882></FONT
1883></A
1884></TD
1885></TR
1886><TR
1887><TD
1888COLSPAN="2"
1889ALIGN="left"
1890><FONT
1891COLOR="#FFFFFF"
1892SIZE="3"
1893><B
Daniel Veillard52dcab32001-10-30 12:51:17 +00001894>globals</B
Daniel Veillard7d6fd212001-05-10 15:34:11 +00001895></FONT
1896></TD
1897><TD
1898COLSPAN="2"
1899ALIGN="right"
1900><FONT
1901COLOR="#FFFFFF"
1902SIZE="3"
1903><B
1904>parserInternals</B
1905></FONT
1906></TD
1907></TR
1908></TABLE
1909></DIV
1910></BODY
1911></HTML
1912>