mirror of
https://gitlab.gnome.org/GNOME/libxml2.git
synced 2025-10-23 01:52:48 +03:00
Finally - found the problem with the page generation (XMLPUBFUN not
* doc/html/*.html: Finally - found the problem with the page generation (XMLPUBFUN not recognized by gtkdoc). Re-created the pages using a temporary version of include/libxml/*.h. * testOOMlib.c,include/libxml/encoding.h, include/libxml/schemasInternals.h,include/libxml/valid.h, include/libxml/xlink.h,include/libxml/xmlwin32version.h, include/libxml/xmlwin32version.h.in, include/libxml/xpathInternals.h: minor edit of comments to help automatic documentation generation * doc/docdescr.doc: small elaboration * doc/examples/test1.c,doc/examples/Makefile.am: re-commit (messed up on last try) * xmlreader.c: minor change to clear warning.
This commit is contained in:
William M. Brack
@@ -28,7 +28,7 @@
|
||||
.navigation .title {
|
||||
font-size: 200%;
|
||||
}
|
||||
</style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual "><link rel="up" href="ch01.html" title="Libxml Programming Notes"><link rel="previous" href="libxml-xmlwin32version.html" title="xmlwin32version"><link rel="next" href="libxml-dict.html" title="dict"></head><body text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-xmlwin32version.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Gnome XML Library Reference Manual </th><td><a accesskey="n" href="libxml-dict.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry"><a name="libxml-DOCBparser"></a><div class="titlepage"></div><div class="refnamediv"><h2>DOCBparser</h2><p>DOCBparser — </p></div><div class="refsynopsisdiv"><h2><h1 class="title"><a name="id2605365"></a>Synopsis</h1></h2><pre class="synopsis">
|
||||
</style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="ch01.html" title="Libxml Programming Notes"><link rel="previous" href="libxml-xmlwin32version.html" title="xmlwin32version"><link rel="next" href="libxml-dict.html" title="dict"></head><body text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-xmlwin32version.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-dict.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry"><a name="libxml-DOCBparser"></a><div class="titlepage"></div><div class="refnamediv"><h2>DOCBparser</h2><p>DOCBparser — </p></div><div class="refsynopsisdiv"><h2><h1 class="title"><a name="id2671075"></a>Synopsis</h1></h2><pre class="synopsis">
|
||||
|
||||
|
||||
|
||||
@@ -39,6 +39,37 @@ typedef <a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr
|
||||
typedef <a href="libxml-DOCBparser.html#docbParserInput">docbParserInput</a>;
|
||||
typedef <a href="libxml-DOCBparser.html#docbParserInputPtr">docbParserInputPtr</a>;
|
||||
typedef <a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a>;
|
||||
int <a href="libxml-DOCBparser.html#docbEncodeEntities">docbEncodeEntities</a> (unsigned char *out,
|
||||
int *outlen,
|
||||
unsigned char *in,
|
||||
int *inlen,
|
||||
int quoteChar);
|
||||
<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbSAXParseDoc">docbSAXParseDoc</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
|
||||
const char *encoding,
|
||||
<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
|
||||
void *userData);
|
||||
<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbParseDoc">docbParseDoc</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
|
||||
const char *encoding);
|
||||
<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbSAXParseFile">docbSAXParseFile</a> (const char *filename,
|
||||
const char *encoding,
|
||||
<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
|
||||
void *userData);
|
||||
<a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> <a href="libxml-DOCBparser.html#docbParseFile">docbParseFile</a> (const char *filename,
|
||||
const char *encoding);
|
||||
void <a href="libxml-DOCBparser.html#docbFreeParserCtxt">docbFreeParserCtxt</a> (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);
|
||||
<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> <a href="libxml-DOCBparser.html#docbCreatePushParserCtxt">docbCreatePushParserCtxt</a> (<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
|
||||
void *user_data,
|
||||
const char *chunk,
|
||||
int size,
|
||||
const char *filename,
|
||||
<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
|
||||
int <a href="libxml-DOCBparser.html#docbParseChunk">docbParseChunk</a> (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt,
|
||||
const char *chunk,
|
||||
int size,
|
||||
int terminate);
|
||||
<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> <a href="libxml-DOCBparser.html#docbCreateFileParserCtxt">docbCreateFileParserCtxt</a> (const char *filename,
|
||||
const char *encoding);
|
||||
int <a href="libxml-DOCBparser.html#docbParseDocument">docbParseDocument</a> (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);
|
||||
</pre></div><div class="refsect1"><h2>Description</h2><p>
|
||||
|
||||
</p></div><div class="refsect1"><h2>Details</h2><div class="refsect2"><h3><a name="docbParserCtxt"></a>docbParserCtxt</h3><pre class="programlisting">typedef xmlParserCtxt docbParserCtxt;
|
||||
@@ -62,4 +93,114 @@ typedef <a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a>;
|
||||
</p></div><hr><div class="refsect2"><h3><a name="docbDocPtr"></a>docbDocPtr</h3><pre class="programlisting">typedef xmlDocPtr docbDocPtr;
|
||||
</pre><p>
|
||||
|
||||
</p></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-xmlwin32version.html"><b><<<EFBFBD>xmlwin32version</b></a></td><td align="right"><a accesskey="n" href="libxml-dict.html"><b>dict<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
</p></div><hr><div class="refsect2"><h3><a name="docbEncodeEntities"></a>docbEncodeEntities ()</h3><pre class="programlisting">int docbEncodeEntities (unsigned char *out,
|
||||
int *outlen,
|
||||
unsigned char *in,
|
||||
int *inlen,
|
||||
int quoteChar);</pre><p>
|
||||
Take a block of UTF-8 chars in and try to convert it to an ASCII
|
||||
plus SGML entities block of chars out.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>out</tt></i>:</span></td><td> a pointer to an array of bytes to store the result
|
||||
</td></tr><tr><td><span class="term"><i><tt>outlen</tt></i>:</span></td><td> the length of <i><tt>out</tt></i>
|
||||
</td></tr><tr><td><span class="term"><i><tt>in</tt></i>:</span></td><td> a pointer to an array of UTF-8 chars
|
||||
</td></tr><tr><td><span class="term"><i><tt>inlen</tt></i>:</span></td><td> the length of <i><tt>in</tt></i>
|
||||
</td></tr><tr><td><span class="term"><i><tt>quoteChar</tt></i>:</span></td><td> the quote character to escape (' or ") or zero.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>0 if success, -2 if the transcoding fails, or -1 otherwise
|
||||
The value of <i><tt>inlen</tt></i> after return is the number of octets consumed
|
||||
as the return value is positive, else unpredictable.
|
||||
The value of <i><tt>outlen</tt></i> after return is the number of octets consumed.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbSAXParseDoc"></a>docbSAXParseDoc ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbSAXParseDoc (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
|
||||
const char *encoding,
|
||||
<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
|
||||
void *userData);</pre><p>
|
||||
parse an SGML in-memory document and build a tree.
|
||||
It use the given SAX function block to handle the parsing callback.
|
||||
If sax is NULL, fallback to the default DOM tree building routines.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td> a pointer to an array of xmlChar
|
||||
</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i>:</span></td><td> a free form C string describing the SGML document encoding, or NULL
|
||||
</td></tr><tr><td><span class="term"><i><tt>sax</tt></i>:</span></td><td> the SAX handler block
|
||||
</td></tr><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td> if using SAX, this pointer will be provided on callbacks.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>the resulting document tree
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbParseDoc"></a>docbParseDoc ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbParseDoc (<a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
|
||||
const char *encoding);</pre><p>
|
||||
parse an SGML in-memory document and build a tree.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>cur</tt></i>:</span></td><td> a pointer to an array of xmlChar
|
||||
</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i>:</span></td><td> a free form C string describing the SGML document encoding, or NULL
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>the resulting document tree
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbSAXParseFile"></a>docbSAXParseFile ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbSAXParseFile (const char *filename,
|
||||
const char *encoding,
|
||||
<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
|
||||
void *userData);</pre><p>
|
||||
parse an SGML file and build a tree. Automatic support for ZLIB/Compress
|
||||
compressed document is provided by default if found at compile-time.
|
||||
It use the given SAX function block to handle the parsing callback.
|
||||
If sax is NULL, fallback to the default DOM tree building routines.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td> the filename
|
||||
</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i>:</span></td><td> a free form C string describing the SGML document encoding, or NULL
|
||||
</td></tr><tr><td><span class="term"><i><tt>sax</tt></i>:</span></td><td> the SAX handler block
|
||||
</td></tr><tr><td><span class="term"><i><tt>userData</tt></i>:</span></td><td> if using SAX, this pointer will be provided on callbacks.
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>the resulting document tree
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbParseFile"></a>docbParseFile ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbDocPtr">docbDocPtr</a> docbParseFile (const char *filename,
|
||||
const char *encoding);</pre><p>
|
||||
parse a Docbook SGML file and build a tree. Automatic support for
|
||||
ZLIB/Compress compressed document is provided by default if found
|
||||
at compile-time.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td> the filename
|
||||
</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i>:</span></td><td> a free form C string describing document encoding, or NULL
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>the resulting document tree
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbFreeParserCtxt"></a>docbFreeParserCtxt ()</h3><pre class="programlisting">void docbFreeParserCtxt (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);</pre><p>
|
||||
Free all the memory used by a parser context. However the parsed
|
||||
document in ctxt->myDoc is not freed.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td> an SGML parser context
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbCreatePushParserCtxt"></a>docbCreatePushParserCtxt ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> docbCreatePushParserCtxt (<a href="libxml-DOCBparser.html#docbSAXHandlerPtr">docbSAXHandlerPtr</a> sax,
|
||||
void *user_data,
|
||||
const char *chunk,
|
||||
int size,
|
||||
const char *filename,
|
||||
<a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
|
||||
Create a parser context for using the DocBook SGML parser in push mode
|
||||
To allow content encoding detection, <i><tt>size</tt></i> should be >= 4
|
||||
The value of <i><tt>filename</tt></i> is used for fetching external entities
|
||||
and error/warning reports.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>sax</tt></i>:</span></td><td> a SAX handler
|
||||
</td></tr><tr><td><span class="term"><i><tt>user_data</tt></i>:</span></td><td> The user data returned on SAX callbacks
|
||||
</td></tr><tr><td><span class="term"><i><tt>chunk</tt></i>:</span></td><td> a pointer to an array of chars
|
||||
</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td> number of chars in the array
|
||||
</td></tr><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td> an optional file name or URI
|
||||
</td></tr><tr><td><span class="term"><i><tt>enc</tt></i>:</span></td><td> an optional encoding
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>the new parser context or NULL
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbParseChunk"></a>docbParseChunk ()</h3><pre class="programlisting">int docbParseChunk (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt,
|
||||
const char *chunk,
|
||||
int size,
|
||||
int terminate);</pre><p>
|
||||
Parse a Chunk of memory</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td> an XML parser context
|
||||
</td></tr><tr><td><span class="term"><i><tt>chunk</tt></i>:</span></td><td> an char array
|
||||
</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td> the size in byte of the chunk
|
||||
</td></tr><tr><td><span class="term"><i><tt>terminate</tt></i>:</span></td><td> last chunk indicator
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>zero if no error, the xmlParserErrors otherwise.
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbCreateFileParserCtxt"></a>docbCreateFileParserCtxt ()</h3><pre class="programlisting"><a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> docbCreateFileParserCtxt (const char *filename,
|
||||
const char *encoding);</pre><p>
|
||||
Create a parser context for a file content.
|
||||
Automatic support for ZLIB/Compress compressed document is provided
|
||||
by default if found at compile-time.</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>filename</tt></i>:</span></td><td> the filename
|
||||
</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i>:</span></td><td> the SGML document encoding, or NULL
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>the new parser context or NULL
|
||||
</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="docbParseDocument"></a>docbParseDocument ()</h3><pre class="programlisting">int docbParseDocument (<a href="libxml-DOCBparser.html#docbParserCtxtPtr">docbParserCtxtPtr</a> ctxt);</pre><p>
|
||||
parse an SGML document (and build a tree if using the standard SAX
|
||||
interface).</p><p>
|
||||
|
||||
</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i>:</span></td><td> an SGML parser context
|
||||
</td></tr><tr><td><span class="term"><span class="emphasis"><i>Returns</i></span> :</span></td><td>0, -1 in case of error. the parser context is augmented
|
||||
as a result of the parsing.
|
||||
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-xmlwin32version.html"><b><<<EFBFBD>xmlwin32version</b></a></td><td align="right"><a accesskey="n" href="libxml-dict.html"><b>dict<EFBFBD>>></b></a></td></tr></table></body></html>
|
||||
|
||||
Reference in New Issue
Block a user