diff --git a/ChangeLog b/ChangeLog index 5f18ff63..2f9141a4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +Mon Nov 17 14:54:38 CET 2003 Daniel Veillard + + * doc/Makefile.am doc/apibuild.py doc/libxml2-api.xml doc/newapi.xsl: + improvement of the stylesheets, fixed a API generation problem, + switched the stylesheet and Makefile to build the HTML output. + * doc/html/*.html: complete update, ditched some old files, might + introduce some breakage... + Mon Nov 17 12:50:28 CET 2003 Daniel Veillard * doc/newapi.xsl: lot of improvements, this starts looking good diff --git a/doc/Makefile.am b/doc/Makefile.am index 521af3ae..91891116 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -59,16 +59,14 @@ xmllint.1: xmllint.xml xmlcatalog.1: xmlcatalog_man.xml -@(xsltproc --nonet xmlcatalog_man.xml) -scan: - -gtkdoc-scan --module=libxml --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="acconfig.h config.h win32config.h trio.h triostr.h triop.h config-mac.h XMLTestPrefix2.h XMLTestPrefix.h triodef.h trionan.h xlink.h libxml.h libxml2-py.h libxml_wrap.h" - -templates: scan - -gtkdoc-mktmpl --module=libxml - -xml: templates - if test -d xml ; then rm -f xml/* ; else mkdir xml ; fi - -gtkdoc-mkdb --module=libxml --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --main-sgml-file=$(DOC_MAIN_XML_FILE) - +html: libxml2-api.xml $(srcdir)/newapi.xsl + -@(if [ -x $(bindir)/xsltproc ] ; then \ + echo "Rebuilding the HTML pages from the XML API" ; \ + $(bindir)/xsltproc \ + --nonet $(srcdir)/newapi.xsl libxml2-api.xml ; fi ) + -@(if [ -x $(bindir)/xmllint ] ; then \ + echo "Validating the resulting XHTML pages" ; \ + $(bindir)/xmllint --nonet --valid --noout html/*.html ; fi ); libxml2-api.xml: apibuild.py ../include/libxml/*.h ../*.c -(./apibuild.py) @@ -80,22 +78,13 @@ $(WIN32_DIR)/libxml2.def.src: libxml2-api.xml api: libxml2-api.xml libxml2-refs.xml $(WIN32_DIR)/libxml2.def.src -html: - if test ! -d html ; then mkdir html ; fi - -cd html && gtkdoc-mkhtml libxml ../$(DOC_MAIN_XML_FILE) - clean-local: rm -f *~ *.bak *.hierarchy *.signals *-unused.txt maintainer-clean-local: clean rm -rf libxml-decl-list.txt libxml-decl.txt -libxml-decl-list.txt libxml-decl.txt : templates - -libxml-sections.txt : scan - cp libxml-decl-list.txt libxml-sections.txt - -rebuild: libxml-sections.txt templates xml html api +rebuild: api html install-data-local: $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) diff --git a/doc/apibuild.py b/doc/apibuild.py index 520ef09a..d91d8983 100755 --- a/doc/apibuild.py +++ b/doc/apibuild.py @@ -49,6 +49,12 @@ def escape(raw): raw = string.replace(raw, '"', '"') return raw +def uniq(items): + d = {} + for item in items: + d[item]=1 + return d.keys() + class identifier: def __init__(self, name, module=None, type=None, lineno = 0, info=None, extra=None): @@ -1497,7 +1503,7 @@ class docBuilder: dict.macros.keys() + dict.typedefs.keys() + \ dict.structs.keys() + dict.enums.keys() ids.sort() - for id in ids: + for id in uniq(ids): output.write(" \n" % (id)) output.write(" \n") diff --git a/doc/html/book1.html b/doc/html/book1.html deleted file mode 100644 index 117b3ee7..00000000 --- a/doc/html/book1.html +++ /dev/null @@ -1,372 +0,0 @@ -Gnome XML Library Reference Manual

Gnome XML Library Reference Manual

Daniel Veillard

    daniel@veillard.com
-   

Copyright © 1999 by Daniel Veillard

This manual documents the interfaces of the libxml - library and has some short notes to help get you up to speed - with using the library.

Permission is granted to make and distribute verbatim - copies of this manual provided the copyright notice and this - permission notice are preserved on all copies.

Permission is granted to copy and distribute modified - versions of this manual under the conditions for verbatim - copying, provided also that the entire resulting derived work is - distributed under the terms of a permission notice identical to - this one.

Permission is granted to copy and distribute translations - of this manual into another language, under the above conditions - for modified versions.

Table of Contents
Libxml Programming Notes
Libxml Library Reference
parser -- 
xmlreader -- 
SAX -- 
tree -- 
entities -- 
valid -- 
relaxng -- 
uri -- 
xmlerror -- 
HTMLparser -- 
HTMLtree -- 
xpath -- 
xpathInternals -- 
xpointer -- 
xinclude -- 
nanohttp -- 
nanoftp -- 
xmlIO -- 
catalog -- 
c14n -- 
threads -- 
globals -- 
DOCBparser -- 
parserInternals -- 
encoding -- 
hash -- 
debugXML -- 
xmlmemory -- 
xmlregexp -- 
xmlautomata -- 
xmlunicode -- 
xmlschemas -- 
xmlschemastypes -- 
schemasInternals -- 


   Next Page >>>
 Libxml Programming Notes
\ No newline at end of file diff --git a/doc/html/index.html b/doc/html/index.html index fd635852..09971bca 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -1,31 +1,10 @@ -[Insert name here] Reference Manual

[Insert name here] Reference Manual

Table of Contents

[Insert title here]
[Insert title here] >>
+ + +Reference Manual for libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Reference Manual for libxml2

Main Menu
Related links

Table of Contents

Daniel Veillard

diff --git a/doc/html/libxml-DOCBparser.html b/doc/html/libxml-DOCBparser.html index c94746b7..68225596 100644 --- a/doc/html/libxml-DOCBparser.html +++ b/doc/html/libxml-DOCBparser.html @@ -1,206 +1,55 @@ -DOCBparser
PrevUpHomeGnome XML Library Reference ManualNext

DOCBparser

DOCBparser —

Synopsis

+
+
+Module DOCBparser from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module DOCBparser from libxml2
Main Menu
Related links
Table of Contents
void	docbFreeParserCtxt	(docbParserCtxtPtr ctxt)

+
docbDocPtr	docbParseDoc	(xmlChar * cur, 
				 const char * encoding)

+
Typedef xmlDocPtr docbDocPtr
 
+
docbParserCtxtPtr	docbCreateFileParserCtxt	(const char * filename, 
				 const char * encoding)

+
Typedef xmlParserCtxtPtr docbParserCtxtPtr
 
+
docbDocPtr	docbSAXParseDoc	(xmlChar * cur, 
				 const char * encoding, 
				 docbSAXHandlerPtr sax, 
				 void * userData)

+
docbDocPtr	docbSAXParseFile	(const char * filename, 
				 const char * encoding, 
				 docbSAXHandlerPtr sax, 
				 void * userData)

+
docbParserCtxtPtr	docbCreatePushParserCtxt	(docbSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * chunk, 
				 int size, 
				 const char * filename, 
				 xmlCharEncoding enc)

+
int	docbEncodeEntities	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen, 
				 int quoteChar)

+
docbDocPtr	docbParseFile	(const char * filename, 
				 const char * encoding)

+
int	docbParseDocument	(docbParserCtxtPtr ctxt)

+
Typedef xmlParserInput docbParserInput
 
-typedef     docbParserCtxt;
-typedef     docbParserCtxtPtr;
-typedef     docbSAXHandler;
-typedef     docbSAXHandlerPtr;
-typedef     docbParserInput;
-typedef     docbParserInputPtr;
-typedef     docbDocPtr;
-int         docbEncodeEntities              (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen,
-                                             int quoteChar);
-docbDocPtr  docbSAXParseDoc                 (xmlChar *cur,
-                                             const char *encoding,
-                                             docbSAXHandlerPtr sax,
-                                             void *userData);
-docbDocPtr  docbParseDoc                    (xmlChar *cur,
-                                             const char *encoding);
-docbDocPtr  docbSAXParseFile                (const char *filename,
-                                             const char *encoding,
-                                             docbSAXHandlerPtr sax,
-                                             void *userData);
-docbDocPtr  docbParseFile                   (const char *filename,
-                                             const char *encoding);
-void        docbFreeParserCtxt              (docbParserCtxtPtr ctxt);
-docbParserCtxtPtr docbCreatePushParserCtxt  (docbSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename,
-                                             xmlCharEncoding enc);
-int         docbParseChunk                  (docbParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             int terminate);
-docbParserCtxtPtr docbCreateFileParserCtxt  (const char *filename,
-                                             const char *encoding);
-int         docbParseDocument               (docbParserCtxtPtr ctxt);
-
Description

+
Typedef xmlSAXHandler docbSAXHandler
 
-
Details
docbParserCtxt
typedef xmlParserCtxt docbParserCtxt;
-

+
Typedef xmlParserCtxt docbParserCtxt
 
-
docbParserCtxtPtr
typedef xmlParserCtxtPtr docbParserCtxtPtr;
-

+
Typedef xmlSAXHandlerPtr docbSAXHandlerPtr
 
-
docbSAXHandler
typedef xmlSAXHandler docbSAXHandler;
-

+
int	docbParseChunk	(docbParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 int terminate)

+
Typedef xmlParserInputPtr docbParserInputPtr
 
-
docbSAXHandlerPtr
typedef xmlSAXHandlerPtr docbSAXHandlerPtr;
-

-
-
docbParserInput
typedef xmlParserInput docbParserInput;
-

-
-
docbParserInputPtr
typedef xmlParserInputPtr docbParserInputPtr;
-

-
-
docbDocPtr
typedef xmlDocPtr docbDocPtr;
-

-
-
docbEncodeEntities ()
int         docbEncodeEntities              (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen,
-                                             int quoteChar);

-Take a block of UTF-8 chars in and try to convert it to an ASCII
-plus SGML entities block of chars out.

-
-
out:  a pointer to an array of bytes to store the result
-
outlen:  the length of out
-
in:  a pointer to an array of UTF-8 chars
-
inlen:  the length of in
-
quoteChar: the quote character to escape (' or ") or zero.
-
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise
-The value of inlen after return is the number of octets consumed
-    as the return value is positive, else unpredictable.
-The value of outlen after return is the number of octets consumed.
-
docbSAXParseDoc ()
docbDocPtr  docbSAXParseDoc                 (xmlChar *cur,
-                                             const char *encoding,
-                                             docbSAXHandlerPtr sax,
-                                             void *userData);

-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.

-
-
cur:  a pointer to an array of xmlChar
-
encoding:  a free form C string describing the SGML document encoding, or NULL
-
sax:  the SAX handler block
-
userData: if using SAX, this pointer will be provided on callbacks. 
-
Returns :the resulting document tree
-
docbParseDoc ()
docbDocPtr  docbParseDoc                    (xmlChar *cur,
-                                             const char *encoding);

-parse an SGML in-memory document and build a tree.

-
-
cur:  a pointer to an array of xmlChar
-
encoding:  a free form C string describing the SGML document encoding, or NULL
-
Returns :the resulting document tree
-
docbSAXParseFile ()
docbDocPtr  docbSAXParseFile                (const char *filename,
-                                             const char *encoding,
-                                             docbSAXHandlerPtr sax,
-                                             void *userData);

-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.

-
-
filename:  the filename
-
encoding:  a free form C string describing the SGML document encoding, or NULL
-
sax:  the SAX handler block
-
userData: if using SAX, this pointer will be provided on callbacks. 
-
Returns :the resulting document tree
-
docbParseFile ()
docbDocPtr  docbParseFile                   (const char *filename,
-                                             const char *encoding);

-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.

-
-
filename:  the filename
-
encoding:  a free form C string describing document encoding, or NULL
-
Returns :the resulting document tree
-
docbFreeParserCtxt ()
void        docbFreeParserCtxt              (docbParserCtxtPtr ctxt);

-Free all the memory used by a parser context. However the parsed
-document in ctxt->myDoc is not freed.

-
-
ctxt:  an SGML parser context
-
docbCreatePushParserCtxt ()
docbParserCtxtPtr docbCreatePushParserCtxt  (docbSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename,
-                                             xmlCharEncoding enc);

-Create a parser context for using the DocBook SGML parser in push mode
-To allow content encoding detection, size should be >= 4
-The value of filename is used for fetching external entities
-and error/warning reports.

-
-
sax:  a SAX handler
-
user_data:  The user data returned on SAX callbacks
-
chunk:  a pointer to an array of chars
-
size:  number of chars in the array
-
filename:  an optional file name or URI
-
enc:  an optional encoding
-
Returns :the new parser context or NULL
-
docbParseChunk ()
int         docbParseChunk                  (docbParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             int terminate);

-Parse a Chunk of memory

-
-
ctxt:  an XML parser context
-
chunk:  an char array
-
size:  the size in byte of the chunk
-
terminate:  last chunk indicator
-
Returns :zero if no error, the xmlParserErrors otherwise.
-
docbCreateFileParserCtxt ()
docbParserCtxtPtr docbCreateFileParserCtxt  (const char *filename,
-                                             const char *encoding);

-Create a parser context for a file content. 
-Automatic support for ZLIB/Compress compressed document is provided
-by default if found at compile-time.

-
-
filename:  the filename
-
encoding:  the SGML document encoding, or NULL
-
Returns :the new parser context or NULL
-
docbParseDocument ()
int         docbParseDocument               (docbParserCtxtPtr ctxt);

-parse an SGML document (and build a tree if using the standard SAX
-interface).

-
-
ctxt:  an SGML parser context
-
Returns :0, -1 in case of error. the parser context is augmented
-               as a result of the parsing.
-
<< xmlwin32versiondict >>

+
Description

+
Function: docbFreeParserCtxt
void	docbFreeParserCtxt	(docbParserCtxtPtr ctxt)

+
Free all the memory used by a parser context. However the parsed document in ctxt->myDoc is not freed.

+
ctxt:an SGML parser context
Function: docbParseDoc
docbDocPtr	docbParseDoc	(xmlChar * cur, 
				 const char * encoding)

+
parse an SGML in-memory document and build a tree.

+
cur:a pointer to an array of xmlChar
encoding:a free form C string describing the SGML document encoding, or NULL
Returns:the resulting document tree
Function: docbCreateFileParserCtxt
docbParserCtxtPtr	docbCreateFileParserCtxt	(const char * filename, 
				 const char * encoding)

+
Create a parser context for a file content. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

+
filename:the filename
encoding:the SGML document encoding, or NULL
Returns:the new parser context or NULL
Function: docbSAXParseDoc
docbDocPtr	docbSAXParseDoc	(xmlChar * cur, 
				 const char * encoding, 
				 docbSAXHandlerPtr sax, 
				 void * userData)

+
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.

+
cur:a pointer to an array of xmlChar
encoding:a free form C string describing the SGML document encoding, or NULL
sax:the SAX handler block
userData:if using SAX, this pointer will be provided on callbacks.
Returns:the resulting document tree
Function: docbSAXParseFile
docbDocPtr	docbSAXParseFile	(const char * filename, 
				 const char * encoding, 
				 docbSAXHandlerPtr sax, 
				 void * userData)

+
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.

+
filename:the filename
encoding:a free form C string describing the SGML document encoding, or NULL
sax:the SAX handler block
userData:if using SAX, this pointer will be provided on callbacks.
Returns:the resulting document tree
Function: docbCreatePushParserCtxt
docbParserCtxtPtr	docbCreatePushParserCtxt	(docbSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * chunk, 
				 int size, 
				 const char * filename, 
				 xmlCharEncoding enc)

+
Create a parser context for using the DocBook SGML parser in push mode To allow content encoding detection, @size should be >= 4 The value of @filename is used for fetching external entities and error/warning reports.

+
sax:a SAX handler
user_data:The user data returned on SAX callbacks
chunk:a pointer to an array of chars
size:number of chars in the array
filename:an optional file name or URI
enc:an optional encoding
Returns:the new parser context or NULL
Function: docbEncodeEntities
int	docbEncodeEntities	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen, 
				 int quoteChar)

+
Take a block of UTF-8 chars in and try to convert it to an ASCII plus SGML entities block of chars out.

+
out:a pointer to an array of bytes to store the result
outlen:the length of @out
in:a pointer to an array of UTF-8 chars
inlen:the length of @in
quoteChar:the quote character to escape (' or ") or zero.
Returns:0 if success, -2 if the transcoding fails, or -1 otherwise The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictable. The value of @outlen after return is the number of octets consumed.
Function: docbParseFile
docbDocPtr	docbParseFile	(const char * filename, 
				 const char * encoding)

+
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.

+
filename:the filename
encoding:a free form C string describing document encoding, or NULL
Returns:the resulting document tree
Function: docbParseDocument
int	docbParseDocument	(docbParserCtxtPtr ctxt)

+
parse an SGML document (and build a tree if using the standard SAX interface).

+
ctxt:an SGML parser context
Returns:0, -1 in case of error. the parser context is augmented as a result of the parsing.
Function: docbParseChunk
int	docbParseChunk	(docbParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 int terminate)

+
Parse a Chunk of memory

+
ctxt:an XML parser context
chunk:an char array
size:the size in byte of the chunk
terminate:last chunk indicator
Returns:zero if no error, the xmlParserErrors otherwise.
Daniel Veillard

diff --git a/doc/html/libxml-HTMLparser.html b/doc/html/libxml-HTMLparser.html
index 35f63e3a..a8b7aeb5 100644
--- a/doc/html/libxml-HTMLparser.html
+++ b/doc/html/libxml-HTMLparser.html
@@ -1,579 +1,207 @@
-HTMLparser
PrevUpHomeGnome XML Library Reference ManualNext
HTMLparser
HTMLparser — 
Synopsis
+
+
+Module HTMLparser from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module HTMLparser from libxml2
Main Menu
Related links
Table of Contents
Typedef xmlParserNodeInfo htmlParserNodeInfo
 
+
int	htmlIsScriptAttribute	(const xmlChar * name)

+
int	htmlHandleOmittedElem	(int val)

+
htmlDocPtr	htmlCtxtReadDoc	(htmlParserCtxtPtr ctxt, 
				 const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Typedef xmlNodePtr htmlNodePtr
 
+
Typedef xmlParserCtxtPtr htmlParserCtxtPtr
 
-typedef     htmlParserCtxt;
-typedef     htmlParserCtxtPtr;
-typedef     htmlParserNodeInfo;
-typedef     htmlSAXHandler;
-typedef     htmlSAXHandlerPtr;
-typedef     htmlParserInput;
-typedef     htmlParserInputPtr;
-typedef     htmlDocPtr;
-typedef     htmlNodePtr;
-struct      htmlElemDesc;
-typedef     htmlElemDescPtr;
-struct      htmlEntityDesc;
-typedef     htmlEntityDescPtr;
-const htmlElemDesc* htmlTagLookup           (const xmlChar *tag);
-const htmlEntityDesc* htmlEntityLookup      (const xmlChar *name);
-const htmlEntityDesc* htmlEntityValueLookup (unsigned int value);
-int         htmlIsAutoClosed                (htmlDocPtr doc,
-                                             htmlNodePtr elem);
-int         htmlAutoCloseTag                (htmlDocPtr doc,
-                                             const xmlChar *name,
-                                             htmlNodePtr elem);
-const htmlEntityDesc* htmlParseEntityRef    (htmlParserCtxtPtr ctxt,
-                                             const xmlChar **str);
-int         htmlParseCharRef                (htmlParserCtxtPtr ctxt);
-void        htmlParseElement                (htmlParserCtxtPtr ctxt);
-htmlParserCtxtPtr htmlCreateMemoryParserCtxt
-                                            (const char *buffer,
-                                             int size);
-int         htmlParseDocument               (htmlParserCtxtPtr ctxt);
-htmlDocPtr  htmlSAXParseDoc                 (xmlChar *cur,
-                                             const char *encoding,
-                                             htmlSAXHandlerPtr sax,
-                                             void *userData);
-htmlDocPtr  htmlParseDoc                    (xmlChar *cur,
-                                             const char *encoding);
-htmlDocPtr  htmlSAXParseFile                (const char *filename,
-                                             const char *encoding,
-                                             htmlSAXHandlerPtr sax,
-                                             void *userData);
-htmlDocPtr  htmlParseFile                   (const char *filename,
-                                             const char *encoding);
-int         UTF8ToHtml                      (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);
-int         htmlEncodeEntities              (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen,
-                                             int quoteChar);
-int         htmlIsScriptAttribute           (const xmlChar *name);
-int         htmlHandleOmittedElem           (int val);
-htmlParserCtxtPtr htmlCreatePushParserCtxt  (htmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename,
-                                             xmlCharEncoding enc);
-int         htmlParseChunk                  (htmlParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             int terminate);
-void        htmlFreeParserCtxt              (htmlParserCtxtPtr ctxt);
-enum        htmlParserOption;
-void        htmlCtxtReset                   (htmlParserCtxtPtr ctxt);
-int         htmlCtxtUseOptions              (htmlParserCtxtPtr ctxt,
-                                             int options);
-htmlDocPtr  htmlReadDoc                     (const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlReadFile                    (const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlReadMemory                  (const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlReadFd                      (int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlReadIO                      (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlCtxtReadDoc                 (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlCtxtReadFile                (xmlParserCtxtPtr ctxt,
-                                             const char *filename,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlCtxtReadMemory              (xmlParserCtxtPtr ctxt,
-                                             const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlCtxtReadFd                  (xmlParserCtxtPtr ctxt,
-                                             int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-htmlDocPtr  htmlCtxtReadIO                  (xmlParserCtxtPtr ctxt,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-
Description

+
htmlDocPtr	htmlParseFile	(const char * filename, 
				 const char * encoding)

+
htmlDocPtr	htmlReadIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
int	htmlAutoCloseTag	(htmlDocPtr doc, 
				 const xmlChar * name, 
				 htmlNodePtr elem)

+
int	htmlParseChunk	(htmlParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 int terminate)

+
const htmlElemDesc *	htmlTagLookup	(const xmlChar * tag)

+
htmlParserCtxtPtr	htmlCreateMemoryParserCtxt	(const char * buffer, 
				 int size)

+
void	htmlCtxtReset	(htmlParserCtxtPtr ctxt)

+
Typedef xmlSAXHandler htmlSAXHandler
 
-
Details
htmlParserCtxt
typedef xmlParserCtxt htmlParserCtxt;
-

+
int	htmlElementAllowedHere	(const htmlElemDesc * parent, 
				 const xmlChar * elt)

+
htmlDocPtr	htmlCtxtReadIO	(htmlParserCtxtPtr ctxt, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Typedef xmlSAXHandlerPtr htmlSAXHandlerPtr
 
-
htmlParserCtxtPtr
typedef xmlParserCtxtPtr htmlParserCtxtPtr;
-

+
Enum htmlStatus {
+    HTML_NA = 0 : something we don't check at all
+    HTML_INVALID = 1
+    HTML_DEPRECATED = 2
+    HTML_VALID = 4
+    HTML_REQUIRED = 12 : VALID bit set so ( & HTML_VALID ) is TRUE
+}
 
-
htmlParserNodeInfo
typedef xmlParserNodeInfo htmlParserNodeInfo;
-

+
htmlParserCtxtPtr	htmlCreatePushParserCtxt	(htmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * chunk, 
				 int size, 
				 const char * filename, 
				 xmlCharEncoding enc)

+
htmlDocPtr	htmlReadMemory	(const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
int	htmlIsAutoClosed	(htmlDocPtr doc, 
				 htmlNodePtr elem)

+
Typedef xmlDocPtr htmlDocPtr
 
-
htmlSAXHandler
typedef xmlSAXHandler htmlSAXHandler;
-

+
htmlDocPtr	htmlReadDoc	(const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Enum htmlParserOption {
+    HTML_PARSE_NOERROR = 32 : suppress error reports
+    HTML_PARSE_NOWARNING = 64 : suppress warning reports
+    HTML_PARSE_PEDANTIC = 128 : pedantic error reporting
+    HTML_PARSE_NOBLANKS = 256 : remove blank nodes
+    HTML_PARSE_NONET = 2048 : Forbid network access
+}
 
-
htmlSAXHandlerPtr
typedef xmlSAXHandlerPtr htmlSAXHandlerPtr;
-

+
Typedef htmlEntityDesc * htmlEntityDescPtr
 
-
htmlParserInput
typedef xmlParserInput htmlParserInput;
-

+
int	htmlEncodeEntities	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen, 
				 int quoteChar)

+
Typedef xmlParserCtxt htmlParserCtxt
 
-
htmlParserInputPtr
typedef xmlParserInputPtr htmlParserInputPtr;
-

+
htmlStatus	htmlNodeStatus	(const htmlNodePtr node, 
				 int legacy)

+
htmlStatus	htmlAttrAllowed	(const htmlElemDesc * elt, 
				 const xmlChar * attr, 
				 int legacy)

+
#define htmlDefaultSubelement
 
-
htmlDocPtr
typedef xmlDocPtr htmlDocPtr;
-

+
int	htmlParseCharRef	(htmlParserCtxtPtr ctxt)

+
htmlDocPtr	htmlSAXParseFile	(const char * filename, 
				 const char * encoding, 
				 htmlSAXHandlerPtr sax, 
				 void * userData)

+
const htmlEntityDesc *	htmlParseEntityRef	(htmlParserCtxtPtr ctxt, 
				 const xmlChar ** str)

+
Typedef xmlParserInput htmlParserInput
 
-
htmlNodePtr
typedef xmlNodePtr htmlNodePtr;
-

+
htmlStatus	htmlElementStatusHere	(const htmlElemDesc * parent, 
				 const htmlElemDesc * elt)

+
const htmlEntityDesc *	htmlEntityValueLookup	(unsigned int value)

+
void	htmlParseElement	(htmlParserCtxtPtr ctxt)

+
int	UTF8ToHtml	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)

+
#define htmlRequiredAttrs
 
-
struct htmlElemDesc
struct htmlElemDesc {
+
const htmlEntityDesc *	htmlEntityLookup	(const xmlChar * name)

+
void	htmlFreeParserCtxt	(htmlParserCtxtPtr ctxt)

+
htmlDocPtr	htmlCtxtReadMemory	(htmlParserCtxtPtr ctxt, 
				 const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
htmlDocPtr	htmlCtxtReadFd	(htmlParserCtxtPtr ctxt, 
				 int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Structure htmlEntityDesc
struct _htmlEntityDesc {
+    unsigned int	value	: the UNICODE value for the character
+    const char *	name	: The entity name
+    const char *	desc	: the description
+}

#define htmlElementAllowedHereDesc
 
-    const char *name;	/* The tag name */
-    char startTag;      /* Whether the start tag can be implied */
-    char endTag;        /* Whether the end tag can be implied */
-    char saveEndTag;    /* Whether the end tag should be saved */
-    char empty;         /* Is this an empty element ? */
-    char depr;          /* Is this a deprecated element ? */
-    char dtd;           /* 1: only in Loose DTD, 2: only Frameset one */
-    char isinline;      /* is this a block 0 or inline 1 element */
-    const char *desc;   /* the description */
+
htmlDocPtr	htmlReadFile	(const char * filename, 
				 const char * encoding, 
				 int options)

+
htmlDocPtr	htmlCtxtReadFile	(htmlParserCtxtPtr ctxt, 
				 const char * filename, 
				 const char * encoding, 
				 int options)

+
Typedef htmlElemDesc * htmlElemDescPtr
 
-/* NRK Jan.2003
- * New fields encapsulating HTML structure
- *
- * Bugs:
- *	This is a very limited representation.  It fails to tell us when
- *	an element *requires* subelements (we only have whether they're
- *	allowed or not), and it doesn't tell us where CDATA and PCDATA
- *	are allowed.  Some element relationships are not fully represented:
- *	these are flagged with the word MODIFIER
- */
-    const char** subelts;		/* allowed sub-elements of this element */
-    const char* defaultsubelt;	/* subelement for suggested auto-repair
-					   if necessary or NULL */
-    const char** attrs_opt;		/* Optional Attributes */
-    const char** attrs_depr;		/* Additional deprecated attributes */
-    const char** attrs_req;		/* Required attributes */
-};
-

+
Structure htmlElemDesc
struct _htmlElemDesc {
+    const char *	name	: The tag name
+    char	startTag	: Whether the start tag can be implied
+    char	endTag	: Whether the end tag can be implied
+    char	saveEndTag	: Whether the end tag should be saved
+    char	empty	: Is this an empty element ?
+    char	depr	: Is this a deprecated element ?
+    char	dtd	: 1: only in Loose DTD, 2: only Frameset one
+    char	isinline	: is this a block 0 or inline 1 element
+    const char *	desc	: the description NRK Jan.2003 * New fields encapsu
+    const char **	subelts	: allowed sub-elements of this element
+    const char *	defaultsubelt	: subelement for suggested auto-repair if necessary
+    const char **	attrs_opt	: Optional Attributes
+    const char **	attrs_depr	: Additional deprecated attributes
+    const char **	attrs_req	: Required attributes
+}

htmlDocPtr	htmlSAXParseDoc	(xmlChar * cur, 
				 const char * encoding, 
				 htmlSAXHandlerPtr sax, 
				 void * userData)

+
int	htmlCtxtUseOptions	(htmlParserCtxtPtr ctxt, 
				 int options)

+
Typedef xmlParserInputPtr htmlParserInputPtr
 
-
htmlElemDescPtr
typedef htmlElemDesc *htmlElemDescPtr;
-

-
-
struct htmlEntityDesc
struct htmlEntityDesc {
-
-    unsigned int value;	/* the UNICODE value for the character */
-    const char *name;	/* The entity name */
-    const char *desc;   /* the description */
-};
-

-
-
htmlEntityDescPtr
typedef htmlEntityDesc *htmlEntityDescPtr;
-

-
-
htmlTagLookup ()
const htmlElemDesc* htmlTagLookup           (const xmlChar *tag);

-Lookup the HTML tag in the ElementTable

-
-
tag:  The tag name in lowercase
-
Returns :the related htmlElemDescPtr or NULL if not found.
-
htmlEntityLookup ()
const htmlEntityDesc* htmlEntityLookup      (const xmlChar *name);

-Lookup the given entity in EntitiesTable
-

-TODO: the linear scan is really ugly, an hash table is really needed.

-
-
name: the entity name
-
Returns :the associated htmlEntityDescPtr if found, NULL otherwise.
-
htmlEntityValueLookup ()
const htmlEntityDesc* htmlEntityValueLookup (unsigned int value);

-Lookup the given entity in EntitiesTable
-

-TODO: the linear scan is really ugly, an hash table is really needed.

-
-
value: the entity's unicode value
-
Returns :the associated htmlEntityDescPtr if found, NULL otherwise.
-
htmlIsAutoClosed ()
int         htmlIsAutoClosed                (htmlDocPtr doc,
-                                             htmlNodePtr elem);

-The HTML DTD allows a tag to implicitly close other tags.
-The list is kept in htmlStartClose array. This function checks
-if a tag is autoclosed by one of it's child

-
-
doc:  the HTML document
-
elem:  the HTML element
-
Returns :1 if autoclosed, 0 otherwise
-
htmlAutoCloseTag ()
int         htmlAutoCloseTag                (htmlDocPtr doc,
-                                             const xmlChar *name,
-                                             htmlNodePtr elem);

-The HTML DTD allows a tag to implicitly close other tags.
-The list is kept in htmlStartClose array. This function checks
-if the element or one of it's children would autoclose the
-given tag.

-
-
doc:  the HTML document
-
name:  The tag name
-
elem:  the HTML element
-
Returns :1 if autoclose, 0 otherwise
-
htmlParseEntityRef ()
const htmlEntityDesc* htmlParseEntityRef    (htmlParserCtxtPtr ctxt,
-                                             const xmlChar **str);

-parse an HTML ENTITY references
-

-[68] EntityRef ::= '&' Name ';'

-
-
ctxt:  an HTML parser context
-
str:  location to store the entity name
-
Returns :the associated htmlEntityDescPtr if found, or NULL otherwise,
-        if non-NULL *str will have to be freed by the caller.
-
htmlParseCharRef ()
int         htmlParseCharRef                (htmlParserCtxtPtr ctxt);

-parse Reference declarations
-

-[66] CharRef ::= '&#' [0-9]+ ';' |
-                 '&x' [0-9a-fA-F]+ ';'

-
-
ctxt:  an HTML parser context
-
Returns :the value parsed (as an int)
-
htmlParseElement ()
void        htmlParseElement                (htmlParserCtxtPtr ctxt);

-parse an HTML element, this is highly recursive
-

-[39] element ::= EmptyElemTag | STag content ETag
-

-[41] Attribute ::= Name Eq AttValue

-
-
ctxt:  an HTML parser context
-
htmlCreateMemoryParserCtxt ()
htmlParserCtxtPtr htmlCreateMemoryParserCtxt
-                                            (const char *buffer,
-                                             int size);

-Create a parser context for an HTML in-memory document.

-
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
Returns :the new parser context or NULL
-
htmlParseDocument ()
int         htmlParseDocument               (htmlParserCtxtPtr ctxt);

-parse an HTML document (and build a tree if using the standard SAX
-interface).

-
-
ctxt:  an HTML parser context
-
Returns :0, -1 in case of error. the parser context is augmented
-               as a result of the parsing.
-
htmlSAXParseDoc ()
htmlDocPtr  htmlSAXParseDoc                 (xmlChar *cur,
-                                             const char *encoding,
-                                             htmlSAXHandlerPtr sax,
-                                             void *userData);

-Parse an HTML in-memory document. If sax is not NULL, use the SAX callbacks
-to handle parse events. If sax is NULL, fallback to the default DOM
-behavior and return a tree.

-
-
cur:  a pointer to an array of xmlChar
-
encoding:  a free form C string describing the HTML document encoding, or NULL
-
sax:  the SAX handler block
-
userData: if using SAX, this pointer will be provided on callbacks. 
-
Returns :the resulting document tree unless SAX is NULL or the document is
-    not well formed.
-
htmlParseDoc ()
htmlDocPtr  htmlParseDoc                    (xmlChar *cur,
-                                             const char *encoding);

-parse an HTML in-memory document and build a tree.

-
-
cur:  a pointer to an array of xmlChar
-
encoding:  a free form C string describing the HTML document encoding, or NULL
-
Returns :the resulting document tree
-
htmlSAXParseFile ()
htmlDocPtr  htmlSAXParseFile                (const char *filename,
-                                             const char *encoding,
-                                             htmlSAXHandlerPtr sax,
-                                             void *userData);

-parse an HTML 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.

-
-
filename:  the filename
-
encoding:  a free form C string describing the HTML document encoding, or NULL
-
sax:  the SAX handler block
-
userData: if using SAX, this pointer will be provided on callbacks. 
-
Returns :the resulting document tree unless SAX is NULL or the document is
-    not well formed.
-
htmlParseFile ()
htmlDocPtr  htmlParseFile                   (const char *filename,
-                                             const char *encoding);

-parse an HTML file and build a tree. Automatic support for ZLIB/Compress
-compressed document is provided by default if found at compile-time.

-
-
filename:  the filename
-
encoding:  a free form C string describing the HTML document encoding, or NULL
-
Returns :the resulting document tree
-
UTF8ToHtml ()
int         UTF8ToHtml                      (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);

-Take a block of UTF-8 chars in and try to convert it to an ASCII
-plus HTML entities block of chars out.

-
-
out:  a pointer to an array of bytes to store the result
-
outlen:  the length of out
-
in:  a pointer to an array of UTF-8 chars
-
inlen:  the length of in
-
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise
-The value of inlen after return is the number of octets consumed
-    as the return value is positive, else unpredictable.
-The value of outlen after return is the number of octets consumed.
-
htmlEncodeEntities ()
int         htmlEncodeEntities              (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen,
-                                             int quoteChar);

-Take a block of UTF-8 chars in and try to convert it to an ASCII
-plus HTML entities block of chars out.

-
-
out:  a pointer to an array of bytes to store the result
-
outlen:  the length of out
-
in:  a pointer to an array of UTF-8 chars
-
inlen:  the length of in
-
quoteChar: the quote character to escape (' or ") or zero.
-
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise
-The value of inlen after return is the number of octets consumed
-    as the return value is positive, else unpredictable.
-The value of outlen after return is the number of octets consumed.
-
htmlIsScriptAttribute ()
int         htmlIsScriptAttribute           (const xmlChar *name);

-Check if an attribute is of content type Script

-
-
name:  an attribute name
-
Returns :1 is the attribute is a script 0 otherwise
-
htmlHandleOmittedElem ()
int         htmlHandleOmittedElem           (int val);

-Set and return the previous value for handling HTML omitted tags.

-
-
val:  int 0 or 1 
-
Returns :the last value for 0 for no handling, 1 for auto insertion.
-
htmlCreatePushParserCtxt ()
htmlParserCtxtPtr htmlCreatePushParserCtxt  (htmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename,
-                                             xmlCharEncoding enc);

-Create a parser context for using the HTML parser in push mode
-The value of filename is used for fetching external entities
-and error/warning reports.

-
-
sax:  a SAX handler
-
user_data:  The user data returned on SAX callbacks
-
chunk:  a pointer to an array of chars
-
size:  number of chars in the array
-
filename:  an optional file name or URI
-
enc:  an optional encoding
-
Returns :the new parser context or NULL
-
htmlParseChunk ()
int         htmlParseChunk                  (htmlParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             int terminate);

-Parse a Chunk of memory

-
-
ctxt:  an HTML parser context
-
chunk:  an char array
-
size:  the size in byte of the chunk
-
terminate:  last chunk indicator
-
Returns :zero if no error, the xmlParserErrors otherwise.
-
htmlFreeParserCtxt ()
void        htmlFreeParserCtxt              (htmlParserCtxtPtr ctxt);

-Free all the memory used by a parser context. However the parsed
-document in ctxt->myDoc is not freed.

-
-
ctxt:  an HTML parser context
-
enum htmlParserOption
typedef enum {
-    HTML_PARSE_NOERROR	= 1<<5,	/* suppress error reports */
-    HTML_PARSE_NOWARNING= 1<<6,	/* suppress warning reports */
-    HTML_PARSE_PEDANTIC	= 1<<7,	/* pedantic error reporting */
-    HTML_PARSE_NOBLANKS	= 1<<8,	/* remove blank nodes */
-    HTML_PARSE_NONET	= 1<<11 /* Forbid network access */
-} htmlParserOption;
-

-
-
htmlCtxtReset ()
void        htmlCtxtReset                   (htmlParserCtxtPtr ctxt);

-Reset a parser context

-
-
ctxt: an HTML parser context
-
htmlCtxtUseOptions ()
int         htmlCtxtUseOptions              (htmlParserCtxtPtr ctxt,
-                                             int options);

-Applies the options to the parser context

-
-
ctxt: an HTML parser context
-
options:  a combination of htmlParserOption(s)
-
Returns :0 in case of success, the set of unknown or unimplemented options
-        in case of error.
-
htmlReadDoc ()
htmlDocPtr  htmlReadDoc                     (const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.

-
-
cur:  a pointer to a zero terminated string
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlReadFile ()
htmlDocPtr  htmlReadFile                    (const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML file from the filesystem or the network.

-
-
URL:
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlReadMemory ()
htmlDocPtr  htmlReadMemory                  (const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.

-
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlReadFd ()
htmlDocPtr  htmlReadFd                      (int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML from a file descriptor and build a tree.

-
-
fd:  an open file descriptor
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlReadIO ()
htmlDocPtr  htmlReadIO                      (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an HTML document from I/O functions and source and build a tree.

-
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlCtxtReadDoc ()
htmlDocPtr  htmlCtxtReadDoc                 (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an HTML parser context
-
cur:  a pointer to a zero terminated string
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlCtxtReadFile ()
htmlDocPtr  htmlCtxtReadFile                (xmlParserCtxtPtr ctxt,
-                                             const char *filename,
-                                             const char *encoding,
-                                             int options);

-parse an XML file from the filesystem or the network.
-This reuses the existing ctxt parser context

-
-
ctxt:  an HTML parser context
-
filename:  a file or URL
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlCtxtReadMemory ()
htmlDocPtr  htmlCtxtReadMemory              (xmlParserCtxtPtr ctxt,
-                                             const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an HTML parser context
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlCtxtReadFd ()
htmlDocPtr  htmlCtxtReadFd                  (xmlParserCtxtPtr ctxt,
-                                             int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML from a file descriptor and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an HTML parser context
-
fd:  an open file descriptor
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
htmlCtxtReadIO ()
htmlDocPtr  htmlCtxtReadIO                  (xmlParserCtxtPtr ctxt,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an HTML document from I/O functions and source and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an HTML parser context
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of htmlParserOption(s)
-
Returns :the resulting document tree
-
<< entitiesvalid >>

+
htmlDocPtr	htmlReadFd	(int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
htmlDocPtr	htmlParseDoc	(xmlChar * cur, 
				 const char * encoding)

+
int	htmlParseDocument	(htmlParserCtxtPtr ctxt)

+
Description

+
Function: htmlIsScriptAttribute
int	htmlIsScriptAttribute	(const xmlChar * name)

+
Check if an attribute is of content type Script

+
name:an attribute name
Returns:1 is the attribute is a script 0 otherwise
Function: htmlHandleOmittedElem
int	htmlHandleOmittedElem	(int val)

+
Set and return the previous value for handling HTML omitted tags.

+
val:int 0 or 1
Returns:the last value for 0 for no handling, 1 for auto insertion.
Function: htmlCtxtReadDoc
htmlDocPtr	htmlCtxtReadDoc	(htmlParserCtxtPtr ctxt, 
				 const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an HTML parser context
cur:a pointer to a zero terminated string
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlParseFile
htmlDocPtr	htmlParseFile	(const char * filename, 
				 const char * encoding)

+
parse an HTML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

+
filename:the filename
encoding:a free form C string describing the HTML document encoding, or NULL
Returns:the resulting document tree
Function: htmlReadIO
htmlDocPtr	htmlReadIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an HTML document from I/O functions and source and build a tree.

+
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlAutoCloseTag
int	htmlAutoCloseTag	(htmlDocPtr doc, 
				 const xmlChar * name, 
				 htmlNodePtr elem)

+
The HTML DTD allows a tag to implicitly close other tags. The list is kept in htmlStartClose array. This function checks if the element or one of it's children would autoclose the given tag.

+
doc:the HTML document
name:The tag name
elem:the HTML element
Returns:1 if autoclose, 0 otherwise
Function: htmlParseChunk
int	htmlParseChunk	(htmlParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 int terminate)

+
Parse a Chunk of memory

+
ctxt:an HTML parser context
chunk:an char array
size:the size in byte of the chunk
terminate:last chunk indicator
Returns:zero if no error, the xmlParserErrors otherwise.
Function: htmlTagLookup
const htmlElemDesc *	htmlTagLookup	(const xmlChar * tag)

+
Lookup the HTML tag in the ElementTable

+
tag:The tag name in lowercase
Returns:the related htmlElemDescPtr or NULL if not found.
Function: htmlCreateMemoryParserCtxt
htmlParserCtxtPtr	htmlCreateMemoryParserCtxt	(const char * buffer, 
				 int size)

+
Create a parser context for an HTML in-memory document.

+
buffer:a pointer to a char array
size:the size of the array
Returns:the new parser context or NULL
Function: htmlCtxtReset
void	htmlCtxtReset	(htmlParserCtxtPtr ctxt)

+
Reset a parser context

+
ctxt:an HTML parser context
Function: htmlElementAllowedHere
int	htmlElementAllowedHere	(const htmlElemDesc * parent, 
				 const xmlChar * elt)

+
Checks whether an HTML element may be a direct child of a parent element. Note - doesn't check for deprecated elements

+
parent:HTML parent element
elt:HTML element
Returns:1 if allowed; 0 otherwise.
Function: htmlCtxtReadIO
htmlDocPtr	htmlCtxtReadIO	(htmlParserCtxtPtr ctxt, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an HTML document from I/O functions and source and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an HTML parser context
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlCreatePushParserCtxt
htmlParserCtxtPtr	htmlCreatePushParserCtxt	(htmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * chunk, 
				 int size, 
				 const char * filename, 
				 xmlCharEncoding enc)

+
Create a parser context for using the HTML parser in push mode The value of @filename is used for fetching external entities and error/warning reports.

+
sax:a SAX handler
user_data:The user data returned on SAX callbacks
chunk:a pointer to an array of chars
size:number of chars in the array
filename:an optional file name or URI
enc:an optional encoding
Returns:the new parser context or NULL
Function: htmlReadMemory
htmlDocPtr	htmlReadMemory	(const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree.

+
buffer:a pointer to a char array
size:the size of the array
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlIsAutoClosed
int	htmlIsAutoClosed	(htmlDocPtr doc, 
				 htmlNodePtr elem)

+
The HTML DTD allows a tag to implicitly close other tags. The list is kept in htmlStartClose array. This function checks if a tag is autoclosed by one of it's child

+
doc:the HTML document
elem:the HTML element
Returns:1 if autoclosed, 0 otherwise
Function: htmlReadDoc
htmlDocPtr	htmlReadDoc	(const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree.

+
cur:a pointer to a zero terminated string
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlEncodeEntities
int	htmlEncodeEntities	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen, 
				 int quoteChar)

+
Take a block of UTF-8 chars in and try to convert it to an ASCII plus HTML entities block of chars out.

+
out:a pointer to an array of bytes to store the result
outlen:the length of @out
in:a pointer to an array of UTF-8 chars
inlen:the length of @in
quoteChar:the quote character to escape (' or ") or zero.
Returns:0 if success, -2 if the transcoding fails, or -1 otherwise The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictable. The value of @outlen after return is the number of octets consumed.
Function: htmlNodeStatus
htmlStatus	htmlNodeStatus	(const htmlNodePtr node, 
				 int legacy)

+
Checks whether the tree node is valid. Experimental (the author only uses the HTML enhancements in a SAX parser)

+
node:an htmlNodePtr in a tree
legacy:whether to allow deprecated elements (YES is faster here for Element nodes)
Returns:for Element nodes, a return from htmlElementAllowedHere (if legacy allowed) or htmlElementStatusHere (otherwise). for Attribute nodes, a return from htmlAttrAllowed for other nodes, HTML_NA (no checks performed)
Function: htmlAttrAllowed
htmlStatus	htmlAttrAllowed	(const htmlElemDesc * elt, 
				 const xmlChar * attr, 
				 int legacy)

+
Checks whether an attribute is valid for an element Has full knowledge of Required and Deprecated attributes

+
elt:HTML element
attr:HTML attribute
legacy:whether to allow deprecated attributes
Returns:one of HTML_REQUIRED, HTML_VALID, HTML_DEPRECATED, HTML_INVALID
Macro: htmlDefaultSubelement
#define htmlDefaultSubelement
Returns the default subelement for this element

+
Function: htmlParseCharRef
int	htmlParseCharRef	(htmlParserCtxtPtr ctxt)

+
parse Reference declarations [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'

+
ctxt:an HTML parser context
Returns:the value parsed (as an int)
Function: htmlSAXParseFile
htmlDocPtr	htmlSAXParseFile	(const char * filename, 
				 const char * encoding, 
				 htmlSAXHandlerPtr sax, 
				 void * userData)

+
parse an HTML 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.

+
filename:the filename
encoding:a free form C string describing the HTML document encoding, or NULL
sax:the SAX handler block
userData:if using SAX, this pointer will be provided on callbacks.
Returns:the resulting document tree unless SAX is NULL or the document is not well formed.
Function: htmlParseEntityRef
const htmlEntityDesc *	htmlParseEntityRef	(htmlParserCtxtPtr ctxt, 
				 const xmlChar ** str)

+
parse an HTML ENTITY references [68] EntityRef ::= '&' Name ';'

+
ctxt:an HTML parser context
str:location to store the entity name
Returns:the associated htmlEntityDescPtr if found, or NULL otherwise, if non-NULL *str will have to be freed by the caller.
Function: htmlElementStatusHere
htmlStatus	htmlElementStatusHere	(const htmlElemDesc * parent, 
				 const htmlElemDesc * elt)

+
Checks whether an HTML element may be a direct child of a parent element. and if so whether it is valid or deprecated.

+
parent:HTML parent element
elt:HTML element
Returns:one of HTML_VALID, HTML_DEPRECATED, HTML_INVALID
Function: htmlEntityValueLookup
const htmlEntityDesc *	htmlEntityValueLookup	(unsigned int value)

+
Lookup the given entity in EntitiesTable TODO: the linear scan is really ugly, an hash table is really needed.

+
value:the entity's unicode value
Returns:the associated htmlEntityDescPtr if found, NULL otherwise.
Function: htmlParseElement
void	htmlParseElement	(htmlParserCtxtPtr ctxt)

+
parse an HTML element, this is highly recursive [39] element ::= EmptyElemTag | STag content ETag [41] Attribute ::= Name Eq AttValue

+
ctxt:an HTML parser context
Function: UTF8ToHtml
int	UTF8ToHtml	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)

+
Take a block of UTF-8 chars in and try to convert it to an ASCII plus HTML entities block of chars out.

+
out:a pointer to an array of bytes to store the result
outlen:the length of @out
in:a pointer to an array of UTF-8 chars
inlen:the length of @in
Returns:0 if success, -2 if the transcoding fails, or -1 otherwise The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictable. The value of @outlen after return is the number of octets consumed.
Macro: htmlRequiredAttrs
#define htmlRequiredAttrs
Returns the attributes required for the specified element.

+
Function: htmlEntityLookup
const htmlEntityDesc *	htmlEntityLookup	(const xmlChar * name)

+
Lookup the given entity in EntitiesTable TODO: the linear scan is really ugly, an hash table is really needed.

+
name:the entity name
Returns:the associated htmlEntityDescPtr if found, NULL otherwise.
Function: htmlFreeParserCtxt
void	htmlFreeParserCtxt	(htmlParserCtxtPtr ctxt)

+
Free all the memory used by a parser context. However the parsed document in ctxt->myDoc is not freed.

+
ctxt:an HTML parser context
Function: htmlCtxtReadMemory
htmlDocPtr	htmlCtxtReadMemory	(htmlParserCtxtPtr ctxt, 
				 const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an HTML parser context
buffer:a pointer to a char array
size:the size of the array
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlCtxtReadFd
htmlDocPtr	htmlCtxtReadFd	(htmlParserCtxtPtr ctxt, 
				 int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML from a file descriptor and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an HTML parser context
fd:an open file descriptor
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree

+      
+      
+      
+    
Macro: htmlElementAllowedHereDesc
#define htmlElementAllowedHereDesc
Checks whether an HTML element description may be a direct child of the specified element. Returns 1 if allowed; 0 otherwise.

+
Function: htmlReadFile
htmlDocPtr	htmlReadFile	(const char * filename, 
				 const char * encoding, 
				 int options)

+
parse an XML file from the filesystem or the network.

+
filename:a file or URL
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlCtxtReadFile
htmlDocPtr	htmlCtxtReadFile	(htmlParserCtxtPtr ctxt, 
				 const char * filename, 
				 const char * encoding, 
				 int options)

+
parse an XML file from the filesystem or the network. This reuses the existing @ctxt parser context

+
ctxt:an HTML parser context
filename:a file or URL
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: htmlSAXParseDoc
htmlDocPtr	htmlSAXParseDoc	(xmlChar * cur, 
				 const char * encoding, 
				 htmlSAXHandlerPtr sax, 
				 void * userData)

+
Parse an HTML in-memory document. If sax is not NULL, use the SAX callbacks to handle parse events. If sax is NULL, fallback to the default DOM behavior and return a tree.

+
cur:a pointer to an array of xmlChar
encoding:a free form C string describing the HTML document encoding, or NULL
sax:the SAX handler block
userData:if using SAX, this pointer will be provided on callbacks.
Returns:the resulting document tree unless SAX is NULL or the document is not well formed.
Function: htmlCtxtUseOptions
int	htmlCtxtUseOptions	(htmlParserCtxtPtr ctxt, 
				 int options)

+
Applies the options to the parser context

+
ctxt:an HTML parser context
options:a combination of htmlParserOption(s)
Returns:0 in case of success, the set of unknown or unimplemented options in case of error.
Function: htmlReadFd
htmlDocPtr	htmlReadFd	(int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML from a file descriptor and build a tree.

+
fd:an open file descriptor
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of htmlParserOption(s)
Returns:the resulting document tree
Function: htmlParseDoc
htmlDocPtr	htmlParseDoc	(xmlChar * cur, 
				 const char * encoding)

+
parse an HTML in-memory document and build a tree.

+
cur:a pointer to an array of xmlChar
encoding:a free form C string describing the HTML document encoding, or NULL
Returns:the resulting document tree
Function: htmlParseDocument
int	htmlParseDocument	(htmlParserCtxtPtr ctxt)

+
parse an HTML document (and build a tree if using the standard SAX interface).

+
ctxt:an HTML parser context
Returns:0, -1 in case of error. the parser context is augmented as a result of the parsing.
Daniel Veillard

diff --git a/doc/html/libxml-HTMLtree.html b/doc/html/libxml-HTMLtree.html
index 7bb2f163..29482c66 100644
--- a/doc/html/libxml-HTMLtree.html
+++ b/doc/html/libxml-HTMLtree.html
@@ -1,270 +1,77 @@
-HTMLtree
PrevUpHomeGnome XML Library Reference ManualNext
HTMLtree
HTMLtree — 
Synopsis
+
+
+Module HTMLtree from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module HTMLtree from libxml2
Main Menu
Related links
Table of Contents
void	htmlDocDumpMemory	(xmlDocPtr cur, 
				 xmlChar ** mem, 
				 int * size)

+
int	htmlSaveFile	(const char * filename, 
				 xmlDocPtr cur)

+
#define HTML_TEXT_NODE
 
+
int	htmlNodeDump	(xmlBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur)

+
void	htmlNodeDumpFormatOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 const char * encoding, 
				 int format)

+
int	htmlSaveFileEnc	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
void	htmlNodeDumpOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 const char * encoding)

+
int	htmlDocDump	(FILE * f, 
				 xmlDocPtr cur)

+
htmlDocPtr	htmlNewDoc	(const xmlChar * URI, 
				 const xmlChar * ExternalID)

+
const xmlChar *	htmlGetMetaEncoding	(htmlDocPtr doc)

+
void	htmlNodeDumpFile	(FILE * out, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur)

+
int	htmlNodeDumpFileFormat	(FILE * out, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 const char * encoding, 
				 int format)

+
#define HTML_PRESERVE_NODE
 
+
int	htmlSetMetaEncoding	(htmlDocPtr doc, 
				 const xmlChar * encoding)

+
htmlDocPtr	htmlNewDocNoDtD	(const xmlChar * URI, 
				 const xmlChar * ExternalID)

+
#define HTML_COMMENT_NODE
 
-#define     HTML_TEXT_NODE
-#define     HTML_ENTITY_REF_NODE
-#define     HTML_COMMENT_NODE
-#define     HTML_PRESERVE_NODE
-#define     HTML_PI_NODE
-htmlDocPtr  htmlNewDoc                      (const xmlChar *URI,
-                                             const xmlChar *ExternalID);
-htmlDocPtr  htmlNewDocNoDtD                 (const xmlChar *URI,
-                                             const xmlChar *ExternalID);
-const xmlChar* htmlGetMetaEncoding          (htmlDocPtr doc);
-int         htmlSetMetaEncoding             (htmlDocPtr doc,
-                                             const xmlChar *encoding);
-void        htmlDocDumpMemory               (xmlDocPtr cur,
-                                             xmlChar **mem,
-                                             int *size);
-int         htmlDocDump                     (FILE *f,
-                                             xmlDocPtr cur);
-int         htmlSaveFile                    (const char *filename,
-                                             xmlDocPtr cur);
-int         htmlNodeDump                    (xmlBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);
-void        htmlNodeDumpFile                (FILE *out,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);
-int         htmlNodeDumpFileFormat          (FILE *out,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             const char *encoding,
-                                             int format);
-int         htmlSaveFileEnc                 (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding);
-int         htmlSaveFileFormat              (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);
-void        htmlNodeDumpFormatOutput        (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             const char *encoding,
-                                             int format);
-void        htmlDocContentDumpOutput        (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding);
-void        htmlDocContentDumpFormatOutput  (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);
-void        htmlNodeDumpOutput              (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             const char *encoding);
-int         htmlIsBooleanAttr               (const xmlChar *name);
-
Description

+
int	htmlIsBooleanAttr	(const xmlChar * name)

+
#define HTML_PI_NODE
 
-
Details
HTML_TEXT_NODE
#define HTML_TEXT_NODE		XML_TEXT_NODE
-

-Macro. A text node in a HTML document is really implemented
-the same way as a text node in an XML document.

+
#define HTML_ENTITY_REF_NODE
 
-
HTML_ENTITY_REF_NODE
#define HTML_ENTITY_REF_NODE	XML_ENTITY_REF_NODE
-

-Macro. An entity reference in a HTML document is really implemented
-the same way as an entity reference in an XML document.

-
-
HTML_COMMENT_NODE
#define HTML_COMMENT_NODE	XML_COMMENT_NODE
-

-Macro. A comment in a HTML document is really implemented
-the same way as a comment in an XML document.

-
-
HTML_PRESERVE_NODE
#define HTML_PRESERVE_NODE	XML_CDATA_SECTION_NODE
-

-Macro. A preserved node in a HTML document is really implemented
-the same way as a CDATA section in an XML document.

-
-
HTML_PI_NODE
#define HTML_PI_NODE		XML_PI_NODE
-

-Macro. A processing instruction in a HTML document is really implemented
-the same way as a processing instruction in an XML document.

-
-
htmlNewDoc ()
htmlDocPtr  htmlNewDoc                      (const xmlChar *URI,
-                                             const xmlChar *ExternalID);

-Creates a new HTML document

-
-
URI:  URI for the dtd, or NULL
-
ExternalID:  the external ID of the DTD, or NULL
-
Returns :a new document
-
htmlNewDocNoDtD ()
htmlDocPtr  htmlNewDocNoDtD                 (const xmlChar *URI,
-                                             const xmlChar *ExternalID);

-Creates a new HTML document without a DTD node if URI and ExternalID
-are NULL

-
-
URI:  URI for the dtd, or NULL
-
ExternalID:  the external ID of the DTD, or NULL
-
Returns :a new document, do not initialize the DTD if not provided
-
htmlGetMetaEncoding ()
const xmlChar* htmlGetMetaEncoding          (htmlDocPtr doc);

-Encoding definition lookup in the Meta tags

-
-
doc:  the document
-
Returns :the current encoding as flagged in the HTML source
-
htmlSetMetaEncoding ()
int         htmlSetMetaEncoding             (htmlDocPtr doc,
-                                             const xmlChar *encoding);

-Sets the current encoding in the Meta tags
-NOTE: this will not change the document content encoding, just
-the META flag associated.

-
-
doc:  the document
-
encoding:  the encoding string
-
Returns :0 in case of success and -1 in case of error
-
htmlDocDumpMemory ()
void        htmlDocDumpMemory               (xmlDocPtr cur,
-                                             xmlChar **mem,
-                                             int *size);

-Dump an HTML document in memory and return the xmlChar * and it's size.
-It's up to the caller to free the memory.

-
-
cur:  the document
-
mem:  OUT: the memory pointer
-
size:  OUT: the memory length
-
htmlDocDump ()
int         htmlDocDump                     (FILE *f,
-                                             xmlDocPtr cur);

-Dump an HTML document to an open FILE.

-
-
f:  the FILE*
-
cur:  the document
-
Returns : the number of byte written or -1 in case of failure.
-
htmlSaveFile ()
int         htmlSaveFile                    (const char *filename,
-                                             xmlDocPtr cur);

-Dump an HTML document to a file. If filename is "-" the stdout file is
-used.

-
-
filename:  the filename (or URL)
-
cur:  the document
-
Returns : the number of byte written or -1 in case of failure.
-
htmlNodeDump ()
int         htmlNodeDump                    (xmlBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);

-Dump an HTML node, recursive behaviour,children are printed too,
-and formatting returns are added.

-
-
buf:  the HTML buffer output
-
doc:  the document
-
cur:  the current node
-
Returns :the number of byte written or -1 in case of error
-
htmlNodeDumpFile ()
void        htmlNodeDumpFile                (FILE *out,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);

-Dump an HTML node, recursive behaviour,children are printed too,
-and formatting returns are added.

-
-
out:  the FILE pointer
-
doc:  the document
-
cur:  the current node
-
htmlNodeDumpFileFormat ()
int         htmlNodeDumpFileFormat          (FILE *out,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             const char *encoding,
-                                             int format);

-Dump an HTML node, recursive behaviour,children are printed too.
-

-TODO: if encoding == NULL try to save in the doc encoding

-
-
out:  the FILE pointer
-
doc:  the document
-
cur:  the current node
-
encoding: the document encoding
-
format:  should formatting spaces been added
-
Returns : the number of byte written or -1 in case of failure.
-
htmlSaveFileEnc ()
int         htmlSaveFileEnc                 (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding);

-Dump an HTML document to a file using a given encoding
-and formatting returns/spaces are added.

-
-
filename:  the filename
-
cur:  the document
-
encoding: the document encoding
-
Returns : the number of byte written or -1 in case of failure.
-
htmlSaveFileFormat ()
int         htmlSaveFileFormat              (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);

-Dump an HTML document to a file using a given encoding.

-
-
filename:  the filename
-
cur:  the document
-
encoding: the document encoding
-
format:  should formatting spaces been added
-
Returns : the number of byte written or -1 in case of failure.
-
htmlNodeDumpFormatOutput ()
void        htmlNodeDumpFormatOutput        (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             const char *encoding,
-                                             int format);

-Dump an HTML node, recursive behaviour,children are printed too.

-
-
buf:  the HTML buffer output
-
doc:  the document
-
cur:  the current node
-
encoding:  the encoding string
-
format:  should formatting spaces been added
-
htmlDocContentDumpOutput ()
void        htmlDocContentDumpOutput        (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding);

-Dump an HTML document. Formating return/spaces are added.

-
-
buf:  the HTML buffer output
-
cur:  the document
-
encoding:  the encoding string
-
htmlDocContentDumpFormatOutput ()
void        htmlDocContentDumpFormatOutput  (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);

-Dump an HTML document.

-
-
buf:  the HTML buffer output
-
cur:  the document
-
encoding:  the encoding string
-
format:  should formatting spaces been added
-
htmlNodeDumpOutput ()
void        htmlNodeDumpOutput              (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             const char *encoding);

-Dump an HTML node, recursive behaviour,children are printed too,
-and formatting returns/spaces are added.

-
-
buf:  the HTML buffer output
-
doc:  the document
-
cur:  the current node
-
encoding:  the encoding string
-
htmlIsBooleanAttr ()
int         htmlIsBooleanAttr               (const xmlChar *name);

-Determine if a given attribute is a boolean attribute.

-
-
name:  the name of the attribute to check
-
Returns : false if the attribute is not boolean, true otherwise.
-
<< listparserInternals >>

+
void	htmlDocContentDumpFormatOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
int	htmlSaveFileFormat	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
void	htmlDocContentDumpOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
Description

+
Function: htmlDocDumpMemory
void	htmlDocDumpMemory	(xmlDocPtr cur, 
				 xmlChar ** mem, 
				 int * size)

+
Dump an HTML document in memory and return the xmlChar * and it's size. It's up to the caller to free the memory.

+
cur:the document
mem:OUT: the memory pointer
size:OUT: the memory length
Function: htmlSaveFile
int	htmlSaveFile	(const char * filename, 
				 xmlDocPtr cur)

+
Dump an HTML document to a file. If @filename is "-" the stdout file is used.

+
filename:the filename (or URL)
cur:the document
Returns:the number of byte written or -1 in case of failure.
Macro: HTML_TEXT_NODE
#define HTML_TEXT_NODE
Macro. A text node in a HTML document is really implemented the same way as a text node in an XML document.

+
Function: htmlNodeDump
int	htmlNodeDump	(xmlBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur)

+
Dump an HTML node, recursive behaviour,children are printed too, and formatting returns are added.

+
buf:the HTML buffer output
doc:the document
cur:the current node
Returns:the number of byte written or -1 in case of error
Function: htmlNodeDumpFormatOutput
void	htmlNodeDumpFormatOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 const char * encoding, 
				 int format)

+
Dump an HTML node, recursive behaviour,children are printed too.

+
buf:the HTML buffer output
doc:the document
cur:the current node
encoding:the encoding string
format:should formatting spaces been added
Function: htmlSaveFileEnc
int	htmlSaveFileEnc	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
Dump an HTML document to a file using a given encoding and formatting returns/spaces are added.

+
filename:the filename
cur:the document
encoding:the document encoding
Returns:the number of byte written or -1 in case of failure.
Function: htmlNodeDumpOutput
void	htmlNodeDumpOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 const char * encoding)

+
Dump an HTML node, recursive behaviour,children are printed too, and formatting returns/spaces are added.

+
buf:the HTML buffer output
doc:the document
cur:the current node
encoding:the encoding string
Function: htmlDocDump
int	htmlDocDump	(FILE * f, 
				 xmlDocPtr cur)

+
Dump an HTML document to an open FILE.

+
f:the FILE*
cur:the document
Returns:the number of byte written or -1 in case of failure.
Function: htmlNewDoc
htmlDocPtr	htmlNewDoc	(const xmlChar * URI, 
				 const xmlChar * ExternalID)

+
Creates a new HTML document

+
URI:URI for the dtd, or NULL
ExternalID:the external ID of the DTD, or NULL
Returns:a new document
Function: htmlGetMetaEncoding
const xmlChar *	htmlGetMetaEncoding	(htmlDocPtr doc)

+
Encoding definition lookup in the Meta tags

+
doc:the document
Returns:the current encoding as flagged in the HTML source
Function: htmlNodeDumpFile
void	htmlNodeDumpFile	(FILE * out, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur)

+
Dump an HTML node, recursive behaviour,children are printed too, and formatting returns are added.

+
out:the FILE pointer
doc:the document
cur:the current node
Function: htmlNodeDumpFileFormat
int	htmlNodeDumpFileFormat	(FILE * out, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 const char * encoding, 
				 int format)

+
Dump an HTML node, recursive behaviour,children are printed too. TODO: if encoding == NULL try to save in the doc encoding

+
out:the FILE pointer
doc:the document
cur:the current node
encoding:the document encoding
format:should formatting spaces been added
Returns:the number of byte written or -1 in case of failure.
Macro: HTML_PRESERVE_NODE
#define HTML_PRESERVE_NODE
Macro. A preserved node in a HTML document is really implemented the same way as a CDATA section in an XML document.

+
Function: htmlSetMetaEncoding
int	htmlSetMetaEncoding	(htmlDocPtr doc, 
				 const xmlChar * encoding)

+
Sets the current encoding in the Meta tags NOTE: this will not change the document content encoding, just the META flag associated.

+
doc:the document
encoding:the encoding string
Returns:0 in case of success and -1 in case of error
Function: htmlNewDocNoDtD
htmlDocPtr	htmlNewDocNoDtD	(const xmlChar * URI, 
				 const xmlChar * ExternalID)

+
Creates a new HTML document without a DTD node if @URI and @ExternalID are NULL

+
URI:URI for the dtd, or NULL
ExternalID:the external ID of the DTD, or NULL
Returns:a new document, do not initialize the DTD if not provided
Macro: HTML_COMMENT_NODE
#define HTML_COMMENT_NODE
Macro. A comment in a HTML document is really implemented the same way as a comment in an XML document.

+
Function: htmlIsBooleanAttr
int	htmlIsBooleanAttr	(const xmlChar * name)

+
Determine if a given attribute is a boolean attribute.

+
name:the name of the attribute to check
Returns:false if the attribute is not boolean, true otherwise.
Macro: HTML_PI_NODE
#define HTML_PI_NODE
Macro. A processing instruction in a HTML document is really implemented the same way as a processing instruction in an XML document.

+
Macro: HTML_ENTITY_REF_NODE
#define HTML_ENTITY_REF_NODE
Macro. An entity reference in a HTML document is really implemented the same way as an entity reference in an XML document.

+
Function: htmlDocContentDumpFormatOutput
void	htmlDocContentDumpFormatOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
Dump an HTML document.

+
buf:the HTML buffer output
cur:the document
encoding:the encoding string
format:should formatting spaces been added
Function: htmlSaveFileFormat
int	htmlSaveFileFormat	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
Dump an HTML document to a file using a given encoding.

+
filename:the filename
cur:the document
encoding:the document encoding
format:should formatting spaces been added
Returns:the number of byte written or -1 in case of failure.
Function: htmlDocContentDumpOutput
void	htmlDocContentDumpOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
Dump an HTML document. Formating return/spaces are added.

+
buf:the HTML buffer output
cur:the document
encoding:the encoding string
Daniel Veillard

diff --git a/doc/html/libxml-SAX.html b/doc/html/libxml-SAX.html
index feea9e59..358e25fc 100644
--- a/doc/html/libxml-SAX.html
+++ b/doc/html/libxml-SAX.html
@@ -1,423 +1,122 @@
-SAX
PrevUpHomeGnome XML Library Reference ManualNext
SAX
SAX — 
Synopsis
-
-
-
-const xmlChar* getPublicId                  (void *ctx);
-const xmlChar* getSystemId                  (void *ctx);
-void        setDocumentLocator              (void *ctx,
-                                             xmlSAXLocatorPtr loc);
-int         getLineNumber                   (void *ctx);
-int         getColumnNumber                 (void *ctx);
-int         isStandalone                    (void *ctx);
-int         hasInternalSubset               (void *ctx);
-int         hasExternalSubset               (void *ctx);
-void        internalSubset                  (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-void        externalSubset                  (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlEntityPtr getEntity                      (void *ctx,
-                                             const xmlChar *name);
-xmlEntityPtr getParameterEntity             (void *ctx,
-                                             const xmlChar *name);
-xmlParserInputPtr resolveEntity             (void *ctx,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
-void        entityDecl                      (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             xmlChar *content);
-void        attributeDecl                   (void *ctx,
-                                             const xmlChar *elem,
-                                             const xmlChar *fullname,
-                                             int type,
-                                             int def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);
-void        elementDecl                     (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             xmlElementContentPtr content);
-void        notationDecl                    (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
-void        unparsedEntityDecl              (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             const xmlChar *notationName);
-void        startDocument                   (void *ctx);
-void        endDocument                     (void *ctx);
-void        attribute                       (void *ctx,
-                                             const xmlChar *fullname,
-                                             const xmlChar *value);
-void        startElement                    (void *ctx,
-                                             const xmlChar *fullname,
-                                             const xmlChar **atts);
-void        endElement                      (void *ctx,
-                                             const xmlChar *name);
-void        reference                       (void *ctx,
-                                             const xmlChar *name);
-void        characters                      (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);
-void        ignorableWhitespace             (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);
-void        processingInstruction           (void *ctx,
-                                             const xmlChar *target,
-                                             const xmlChar *data);
-void        globalNamespace                 (void *ctx,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);
-void        setNamespace                    (void *ctx,
-                                             const xmlChar *name);
-xmlNsPtr    getNamespace                    (void *ctx);
-int         checkNamespace                  (void *ctx,
-                                             xmlChar *nameSpace);
-void        namespaceDecl                   (void *ctx,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);
-void        comment                         (void *ctx,
-                                             const xmlChar *value);
-void        cdataBlock                      (void *ctx,
-                                             const xmlChar *value,
-                                             int len);
-void        initxmlDefaultSAXHandler        (xmlSAXHandlerV1 *hdlr,
-                                             int warning);
-void        inithtmlDefaultSAXHandler       (xmlSAXHandlerV1 *hdlr);
-void        initdocbDefaultSAXHandler       (xmlSAXHandlerV1 *hdlr);
-
Description

-
-
Details
getPublicId ()
const xmlChar* getPublicId                  (void *ctx);
Warning
getPublicId is deprecated and should not be used in newly-written code. use xmlSAX2GetPublicId()

-Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN"
-Returns

-
-
ctx: the user data (XML parser context)
-
Returns :a xmlChar *
-
getSystemId ()
const xmlChar* getSystemId                  (void *ctx);
Warning
getSystemId is deprecated and should not be used in newly-written code. use xmlSAX2GetSystemId()

-Provides the system ID, basically URL or filename e.g.
-http://www.sgmlsource.com/dtds/memo.dtd
-Returns

-
-
ctx: the user data (XML parser context)
-
Returns :a xmlChar *
-
setDocumentLocator ()
void        setDocumentLocator              (void *ctx,
-                                             xmlSAXLocatorPtr loc);

-Receive the document locator at startup, actually xmlDefaultSAXLocator
-Everything is available on the context, so this is useless in our case.
-DEPRECATED

-
-
ctx: the user data (XML parser context)
-
loc: A SAX Locator
-
getLineNumber ()
int         getLineNumber                   (void *ctx);
Warning
getLineNumber is deprecated and should not be used in newly-written code. use xmlSAX2GetLineNumber()

-Provide the line number of the current parsing point.
-Returns

-
-
ctx: the user data (XML parser context)
-
Returns :an int
-
getColumnNumber ()
int         getColumnNumber                 (void *ctx);
Warning
getColumnNumber is deprecated and should not be used in newly-written code. use xmlSAX2GetColumnNumber()

-Provide the column number of the current parsing point.
-Returns

-
-
ctx: the user data (XML parser context)
-
Returns :an int
-
isStandalone ()
int         isStandalone                    (void *ctx);
Warning
isStandalone is deprecated and should not be used in newly-written code. use xmlSAX2IsStandalone()

-Is this document tagged standalone ?
-Returns

-
-
ctx: the user data (XML parser context)
-
Returns :1 if true
-
hasInternalSubset ()
int         hasInternalSubset               (void *ctx);
Warning
hasInternalSubset is deprecated and should not be used in newly-written code. use xmlSAX2HasInternalSubset()

-Does this document has an internal subset
-Returns

-
-
ctx: the user data (XML parser context)
-
Returns :1 if true
-
hasExternalSubset ()
int         hasExternalSubset               (void *ctx);
Warning
hasExternalSubset is deprecated and should not be used in newly-written code. use xmlSAX2HasExternalSubset()

-Does this document has an external subset
-Returns

-
-
ctx: the user data (XML parser context)
-
Returns :1 if true
-
internalSubset ()
void        internalSubset                  (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
Warning
internalSubset is deprecated and should not be used in newly-written code. use xmlSAX2InternalSubset()

-Callback on internal subset declaration.

-
-
ctx:  the user data (XML parser context)
-
name:  the root element name
-
ExternalID:  the external ID
-
SystemID:  the SYSTEM ID (e.g. filename or URL)
-
externalSubset ()
void        externalSubset                  (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
Warning
externalSubset is deprecated and should not be used in newly-written code. use xmlSAX2ExternalSubset()

-Callback on external subset declaration.

-
-
ctx: the user data (XML parser context)
-
name:  the root element name
-
ExternalID:  the external ID
-
SystemID:  the SYSTEM ID (e.g. filename or URL)
-
getEntity ()
xmlEntityPtr getEntity                      (void *ctx,
-                                             const xmlChar *name);
Warning
getEntity is deprecated and should not be used in newly-written code. use xmlSAX2GetEntity()

-Get an entity by name
-Returns

-
-
ctx: the user data (XML parser context)
-
name: The entity name
-
Returns :the xmlEntityPtr if found.
-
getParameterEntity ()
xmlEntityPtr getParameterEntity             (void *ctx,
-                                             const xmlChar *name);
Warning
getParameterEntity is deprecated and should not be used in newly-written code. use xmlSAX2GetParameterEntity()

-Get a parameter entity by name
-Returns

-
-
ctx: the user data (XML parser context)
-
name: The entity name
-
Returns :the xmlEntityPtr if found.
-
resolveEntity ()
xmlParserInputPtr resolveEntity             (void *ctx,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
Warning
resolveEntity is deprecated and should not be used in newly-written code. use xmlSAX2ResolveEntity()

-The entity loader, to control the loading of external entities,
-the application can either:
-   - override this resolveEntity() callback in the SAX block
-   - or better use the xmlSetExternalEntityLoader() function to
-     set up it's own entity resolution routine
-Returns

-
-
ctx: the user data (XML parser context)
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
Returns :the xmlParserInputPtr if inlined or NULL for DOM behaviour.
-
entityDecl ()
void        entityDecl                      (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             xmlChar *content);
Warning
entityDecl is deprecated and should not be used in newly-written code. use xmlSAX2EntityDecl()

-An entity definition has been parsed

-
-
ctx: the user data (XML parser context)
-
name:  the entity name 
-
type:  the entity type 
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
content: the entity value (without processing).
-
attributeDecl ()
void        attributeDecl                   (void *ctx,
-                                             const xmlChar *elem,
-                                             const xmlChar *fullname,
-                                             int type,
-                                             int def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);
Warning
attributeDecl is deprecated and should not be used in newly-written code. use xmlSAX2AttributeDecl()

-An attribute definition has been parsed

-
-
ctx: the user data (XML parser context)
-
elem:  the name of the element
-
fullname:  the attribute name 
-
type:  the attribute type 
-
def:  the type of default value
-
defaultValue: the attribute default value
-
tree:  the tree of enumerated value set
-
elementDecl ()
void        elementDecl                     (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             xmlElementContentPtr content);
Warning
elementDecl is deprecated and should not be used in newly-written code. use xmlSAX2ElementDecl()

-An element definition has been parsed

-
-
ctx: the user data (XML parser context)
-
name:  the element name 
-
type:  the element type 
-
content: the element value tree
-
notationDecl ()
void        notationDecl                    (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
Warning
notationDecl is deprecated and should not be used in newly-written code. use xmlSAX2NotationDecl()

-What to do when a notation declaration has been parsed.

-
-
ctx: the user data (XML parser context)
-
name: The name of the notation
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
unparsedEntityDecl ()
void        unparsedEntityDecl              (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             const xmlChar *notationName);
Warning
unparsedEntityDecl is deprecated and should not be used in newly-written code. use xmlSAX2UnparsedEntityDecl()

-What to do when an unparsed entity declaration is parsed

-
-
ctx: the user data (XML parser context)
-
name: The name of the entity
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
notationName: the name of the notation
-
startDocument ()
void        startDocument                   (void *ctx);
Warning
startDocument is deprecated and should not be used in newly-written code. use xmlSAX2StartDocument()

-called when the document start being processed.

-
-
ctx: the user data (XML parser context)
-
endDocument ()
void        endDocument                     (void *ctx);
Warning
endDocument is deprecated and should not be used in newly-written code. use xmlSAX2EndDocument()

-called when the document end has been detected.

-
-
ctx: the user data (XML parser context)
-
attribute ()
void        attribute                       (void *ctx,
-                                             const xmlChar *fullname,
-                                             const xmlChar *value);
Warning
attribute is deprecated and should not be used in newly-written code. use xmlSAX2Attribute()

-Handle an attribute that has been read by the parser.
-The default handling is to convert the attribute into an
-DOM subtree and past it in a new xmlAttr element added to
-the element.

-
-
ctx: the user data (XML parser context)
-
fullname:  The attribute name, including namespace prefix
-
value:  The attribute value
-
startElement ()
void        startElement                    (void *ctx,
-                                             const xmlChar *fullname,
-                                             const xmlChar **atts);
Warning
startElement is deprecated and should not be used in newly-written code. use xmlSAX2StartElement()

-called when an opening tag has been processed.

-
-
ctx: the user data (XML parser context)
-
fullname:  The element name, including namespace prefix
-
atts:  An array of name/value attributes pairs, NULL terminated
-
endElement ()
void        endElement                      (void *ctx,
-                                             const xmlChar *name);
Warning
endElement is deprecated and should not be used in newly-written code. use xmlSAX2EndElement()

-called when the end of an element has been detected.

-
-
ctx: the user data (XML parser context)
-
name:  The element name
-
reference ()
void        reference                       (void *ctx,
-                                             const xmlChar *name);
Warning
reference is deprecated and should not be used in newly-written code. use xmlSAX2Reference()

-called when an entity reference is detected.

-
-
ctx: the user data (XML parser context)
-
name:  The entity name
-
characters ()
void        characters                      (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);
Warning
characters is deprecated and should not be used in newly-written code. use xmlSAX2Characters()

-receiving some chars from the parser.

-
-
ctx: the user data (XML parser context)
-
ch:  a xmlChar string
-
len: the number of xmlChar
-
ignorableWhitespace ()
void        ignorableWhitespace             (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);
Warning
ignorableWhitespace is deprecated and should not be used in newly-written code. use xmlSAX2IgnorableWhitespace()

-receiving some ignorable whitespaces from the parser.
-UNUSED: by default the DOM building will use characters

-
-
ctx: the user data (XML parser context)
-
ch:  a xmlChar string
-
len: the number of xmlChar
-
processingInstruction ()
void        processingInstruction           (void *ctx,
-                                             const xmlChar *target,
-                                             const xmlChar *data);
Warning
processingInstruction is deprecated and should not be used in newly-written code. use xmlSAX2ProcessingInstruction()

-A processing instruction has been parsed.

-
-
ctx: the user data (XML parser context)
-
target:  the target name
-
data: the PI data's
-
globalNamespace ()
void        globalNamespace                 (void *ctx,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);

-An old global namespace has been parsed.
-DEPRECATED

-
-
ctx: the user data (XML parser context)
-
href:  the namespace associated URN
-
prefix: the namespace prefix
-
setNamespace ()
void        setNamespace                    (void *ctx,
-                                             const xmlChar *name);

-Set the current element namespace.
-DEPRECATED

-
-
ctx: the user data (XML parser context)
-
name:  the namespace prefix
-
getNamespace ()
xmlNsPtr    getNamespace                    (void *ctx);

-Get the current element namespace.
-DEPRECATED

-
-
ctx: the user data (XML parser context)
-
Returns :the xmlNsPtr or NULL if none
-
checkNamespace ()
int         checkNamespace                  (void *ctx,
-                                             xmlChar *nameSpace);

-Check that the current element namespace is the same as the
-one read upon parsing.
-DEPRECATED

-
-
ctx: the user data (XML parser context)
-
nameSpace: the namespace to check against
-
Returns :1 if true 0 otherwise
-
namespaceDecl ()
void        namespaceDecl                   (void *ctx,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);

-A namespace has been parsed.
-DEPRECATED

-
-
ctx: the user data (XML parser context)
-
href:  the namespace associated URN
-
prefix: the namespace prefix
-
comment ()
void        comment                         (void *ctx,
-                                             const xmlChar *value);
Warning
comment is deprecated and should not be used in newly-written code. use xmlSAX2Comment()

-A comment has been parsed.

-
-
ctx: the user data (XML parser context)
-
value:  the comment content
-
cdataBlock ()
void        cdataBlock                      (void *ctx,
-                                             const xmlChar *value,
-                                             int len);
Warning
cdataBlock is deprecated and should not be used in newly-written code. use xmlSAX2CDataBlock()

-called when a pcdata block has been parsed

-
-
ctx: the user data (XML parser context)
-
value:  The pcdata content
-
len:  the block length
-
initxmlDefaultSAXHandler ()
void        initxmlDefaultSAXHandler        (xmlSAXHandlerV1 *hdlr,
-                                             int warning);
Warning
initxmlDefaultSAXHandler is deprecated and should not be used in newly-written code. use xmlSAX2InitDefaultSAXHandler() for the new SAX2 blocks

-Initialize the default XML SAX version 1 handler

-
-
hdlr:  the SAX handler
-
warning:  flag if non-zero sets the handler warning procedure
-
inithtmlDefaultSAXHandler ()
void        inithtmlDefaultSAXHandler       (xmlSAXHandlerV1 *hdlr);
Warning
inithtmlDefaultSAXHandler is deprecated and should not be used in newly-written code. use xmlSAX2InitHtmlDefaultSAXHandler() for the new SAX2 blocks

-Initialize the default HTML SAX version 1 handler

-
-
hdlr:  the SAX handler
-
initdocbDefaultSAXHandler ()
void        initdocbDefaultSAXHandler       (xmlSAXHandlerV1 *hdlr);
Warning
initdocbDefaultSAXHandler is deprecated and should not be used in newly-written code. use xmlSAX2InitDocbDefaultSAXHandler() for the new SAX2 blocks

-Initialize the default DocBook SAX version 1 handler

-
-
hdlr:  the SAX handler
-
<< xpathchvalid >>

+
+
+Module SAX from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module SAX from libxml2
Main Menu
Related links
Table of Contents
void	cdataBlock	(void * ctx, 
				 const xmlChar * value, 
				 int len)

+
void	comment	(void * ctx, 
				 const xmlChar * value)

+
int	checkNamespace	(void * ctx, 
				 xmlChar * namespace)

+
void	startElement	(void * ctx, 
				 const xmlChar * fullname, 
				 const xmlChar ** atts)

+
void	inithtmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)

+
int	getColumnNumber	(void * ctx)

+
void	endElement	(void * ctx, 
				 const xmlChar * name)

+
void	attribute	(void * ctx, 
				 const xmlChar * fullname, 
				 const xmlChar * value)

+
void	namespaceDecl	(void * ctx, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
xmlNsPtr	getNamespace	(void * ctx)

+
void	initdocbDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)

+
void	setDocumentLocator	(void * ctx, 
				 xmlSAXLocatorPtr loc)

+
const xmlChar *	getPublicId	(void * ctx)

+
xmlEntityPtr	getEntity	(void * ctx, 
				 const xmlChar * name)

+
void	characters	(void * ctx, 
				 const xmlChar * ch, 
				 int len)

+
void	elementDecl	(void * ctx, 
				 const xmlChar * name, 
				 int type, 
				 xmlElementContentPtr content)

+
void	ignorableWhitespace	(void * ctx, 
				 const xmlChar * ch, 
				 int len)

+
int	hasExternalSubset	(void * ctx)

+
int	isStandalone	(void * ctx)

+
void	unparsedEntityDecl	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId, 
				 const xmlChar * notationName)

+
void	reference	(void * ctx, 
				 const xmlChar * name)

+
void	globalNamespace	(void * ctx, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
void	initxmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr, 
				 int warning)

+
int	hasInternalSubset	(void * ctx)

+
void	processingInstruction	(void * ctx, 
				 const xmlChar * target, 
				 const xmlChar * data)

+
xmlEntityPtr	getParameterEntity	(void * ctx, 
				 const xmlChar * name)

+
void	attributeDecl	(void * ctx, 
				 const xmlChar * elem, 
				 const xmlChar * fullname, 
				 int type, 
				 int def, 
				 const xmlChar * defaultValue, 
				 xmlEnumerationPtr tree)

+
void	notationDecl	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId)

+
void	entityDecl	(void * ctx, 
				 const xmlChar * name, 
				 int type, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId, 
				 xmlChar * content)

+
void	setNamespace	(void * ctx, 
				 const xmlChar * name)

+
void	externalSubset	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
xmlParserInputPtr	resolveEntity	(void * ctx, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId)

+
const xmlChar *	getSystemId	(void * ctx)

+
void	startDocument	(void * ctx)

+
void	internalSubset	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
void	endDocument	(void * ctx)

+
int	getLineNumber	(void * ctx)

+
Description

+
Function: cdataBlock
void	cdataBlock	(void * ctx, 
				 const xmlChar * value, 
				 int len)

+
called when a pcdata block has been parsed DEPRECATED: use xmlSAX2CDataBlock()

+
ctx:the user data (XML parser context)
value:The pcdata content
len:the block length
Function: comment
void	comment	(void * ctx, 
				 const xmlChar * value)

+
A comment has been parsed. DEPRECATED: use xmlSAX2Comment()

+
ctx:the user data (XML parser context)
value:the comment content
Function: checkNamespace
int	checkNamespace	(void * ctx, 
				 xmlChar * namespace)

+
Check that the current element namespace is the same as the one read upon parsing. DEPRECATED

+
ctx:the user data (XML parser context)
namespace:the namespace to check against
Returns:1 if true 0 otherwise
Function: startElement
void	startElement	(void * ctx, 
				 const xmlChar * fullname, 
				 const xmlChar ** atts)

+
called when an opening tag has been processed. DEPRECATED: use xmlSAX2StartElement()

+
ctx:the user data (XML parser context)
fullname:The element name, including namespace prefix
atts:An array of name/value attributes pairs, NULL terminated
Function: inithtmlDefaultSAXHandler
void	inithtmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)

+
Initialize the default HTML SAX version 1 handler DEPRECATED: use xmlSAX2InitHtmlDefaultSAXHandler() for the new SAX2 blocks

+
hdlr:the SAX handler
Function: getColumnNumber
int	getColumnNumber	(void * ctx)

+
Provide the column number of the current parsing point. DEPRECATED: use xmlSAX2GetColumnNumber()

+
ctx:the user data (XML parser context)
Returns:an int
Function: endElement
void	endElement	(void * ctx, 
				 const xmlChar * name)

+
called when the end of an element has been detected. DEPRECATED: use xmlSAX2EndElement()

+
ctx:the user data (XML parser context)
name:The element name
Function: attribute
void	attribute	(void * ctx, 
				 const xmlChar * fullname, 
				 const xmlChar * value)

+
Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to the element. DEPRECATED: use xmlSAX2Attribute()

+
ctx:the user data (XML parser context)
fullname:The attribute name, including namespace prefix
value:The attribute value
Function: namespaceDecl
void	namespaceDecl	(void * ctx, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
A namespace has been parsed. DEPRECATED

+
ctx:the user data (XML parser context)
href:the namespace associated URN
prefix:the namespace prefix
Function: getNamespace
xmlNsPtr	getNamespace	(void * ctx)

+
Get the current element namespace. DEPRECATED

+
ctx:the user data (XML parser context)
Returns:the xmlNsPtr or NULL if none
Function: initdocbDefaultSAXHandler
void	initdocbDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr)

+
Initialize the default DocBook SAX version 1 handler DEPRECATED: use xmlSAX2InitDocbDefaultSAXHandler() for the new SAX2 blocks

+
hdlr:the SAX handler
Function: setDocumentLocator
void	setDocumentLocator	(void * ctx, 
				 xmlSAXLocatorPtr loc)

+
Receive the document locator at startup, actually xmlDefaultSAXLocator Everything is available on the context, so this is useless in our case. DEPRECATED

+
ctx:the user data (XML parser context)
loc:A SAX Locator
Function: getPublicId
const xmlChar *	getPublicId	(void * ctx)

+
Provides the public ID e.g. "-//SGMLSOURCE//DTD DEMO//EN" DEPRECATED: use xmlSAX2GetPublicId()

+
ctx:the user data (XML parser context)
Returns:a xmlChar *
Function: getEntity
xmlEntityPtr	getEntity	(void * ctx, 
				 const xmlChar * name)

+
Get an entity by name DEPRECATED: use xmlSAX2GetEntity()

+
ctx:the user data (XML parser context)
name:The entity name
Returns:the xmlEntityPtr if found.
Function: characters
void	characters	(void * ctx, 
				 const xmlChar * ch, 
				 int len)

+
receiving some chars from the parser. DEPRECATED: use xmlSAX2Characters()

+
ctx:the user data (XML parser context)
ch:a xmlChar string
len:the number of xmlChar
Function: elementDecl
void	elementDecl	(void * ctx, 
				 const xmlChar * name, 
				 int type, 
				 xmlElementContentPtr content)

+
An element definition has been parsed DEPRECATED: use xmlSAX2ElementDecl()

+
ctx:the user data (XML parser context)
name:the element name
type:the element type
content:the element value tree
Function: ignorableWhitespace
void	ignorableWhitespace	(void * ctx, 
				 const xmlChar * ch, 
				 int len)

+
receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use characters DEPRECATED: use xmlSAX2IgnorableWhitespace()

+
ctx:the user data (XML parser context)
ch:a xmlChar string
len:the number of xmlChar
Function: hasExternalSubset
int	hasExternalSubset	(void * ctx)

+
Does this document has an external subset DEPRECATED: use xmlSAX2HasExternalSubset()

+
ctx:the user data (XML parser context)
Returns:1 if true
Function: isStandalone
int	isStandalone	(void * ctx)

+
Is this document tagged standalone ? DEPRECATED: use xmlSAX2IsStandalone()

+
ctx:the user data (XML parser context)
Returns:1 if true
Function: unparsedEntityDecl
void	unparsedEntityDecl	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId, 
				 const xmlChar * notationName)

+
What to do when an unparsed entity declaration is parsed DEPRECATED: use xmlSAX2UnparsedEntityDecl()

+
ctx:the user data (XML parser context)
name:The name of the entity
publicId:The public ID of the entity
systemId:The system ID of the entity
notationName:the name of the notation
Function: reference
void	reference	(void * ctx, 
				 const xmlChar * name)

+
called when an entity reference is detected. DEPRECATED: use xmlSAX2Reference()

+
ctx:the user data (XML parser context)
name:The entity name
Function: globalNamespace
void	globalNamespace	(void * ctx, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
An old global namespace has been parsed. DEPRECATED

+
ctx:the user data (XML parser context)
href:the namespace associated URN
prefix:the namespace prefix
Function: initxmlDefaultSAXHandler
void	initxmlDefaultSAXHandler	(xmlSAXHandlerV1 * hdlr, 
				 int warning)

+
Initialize the default XML SAX version 1 handler DEPRECATED: use xmlSAX2InitDefaultSAXHandler() for the new SAX2 blocks

+
hdlr:the SAX handler
warning:flag if non-zero sets the handler warning procedure
Function: hasInternalSubset
int	hasInternalSubset	(void * ctx)

+
Does this document has an internal subset DEPRECATED: use xmlSAX2HasInternalSubset()

+
ctx:the user data (XML parser context)
Returns:1 if true
Function: processingInstruction
void	processingInstruction	(void * ctx, 
				 const xmlChar * target, 
				 const xmlChar * data)

+
A processing instruction has been parsed. DEPRECATED: use xmlSAX2ProcessingInstruction()

+
ctx:the user data (XML parser context)
target:the target name
data:the PI data's
Function: getParameterEntity
xmlEntityPtr	getParameterEntity	(void * ctx, 
				 const xmlChar * name)

+
Get a parameter entity by name DEPRECATED: use xmlSAX2GetParameterEntity()

+
ctx:the user data (XML parser context)
name:The entity name
Returns:the xmlEntityPtr if found.
Function: attributeDecl
void	attributeDecl	(void * ctx, 
				 const xmlChar * elem, 
				 const xmlChar * fullname, 
				 int type, 
				 int def, 
				 const xmlChar * defaultValue, 
				 xmlEnumerationPtr tree)

+
An attribute definition has been parsed DEPRECATED: use xmlSAX2AttributeDecl()

+
ctx:the user data (XML parser context)
elem:the name of the element
fullname:the attribute name
type:the attribute type
def:the type of default value
defaultValue:the attribute default value
tree:the tree of enumerated value set
Function: notationDecl
void	notationDecl	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId)

+
What to do when a notation declaration has been parsed. DEPRECATED: use xmlSAX2NotationDecl()

+
ctx:the user data (XML parser context)
name:The name of the notation
publicId:The public ID of the entity
systemId:The system ID of the entity
Function: entityDecl
void	entityDecl	(void * ctx, 
				 const xmlChar * name, 
				 int type, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId, 
				 xmlChar * content)

+
An entity definition has been parsed DEPRECATED: use xmlSAX2EntityDecl()

+
ctx:the user data (XML parser context)
name:the entity name
type:the entity type
publicId:The public ID of the entity
systemId:The system ID of the entity
content:the entity value (without processing).
Function: setNamespace
void	setNamespace	(void * ctx, 
				 const xmlChar * name)

+
Set the current element namespace. DEPRECATED

+
ctx:the user data (XML parser context)
name:the namespace prefix
Function: externalSubset
void	externalSubset	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Callback on external subset declaration. DEPRECATED: use xmlSAX2ExternalSubset()

+
ctx:the user data (XML parser context)
name:the root element name
ExternalID:the external ID
SystemID:the SYSTEM ID (e.g. filename or URL)
Function: resolveEntity
xmlParserInputPtr	resolveEntity	(void * ctx, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId)

+
The entity loader, to control the loading of external entities, the application can either: - override this resolveEntity() callback in the SAX block - or better use the xmlSetExternalEntityLoader() function to set up it's own entity resolution routine DEPRECATED: use xmlSAX2ResolveEntity()

+
ctx:the user data (XML parser context)
publicId:The public ID of the entity
systemId:The system ID of the entity
Returns:the xmlParserInputPtr if inlined or NULL for DOM behaviour.
Function: getSystemId
const xmlChar *	getSystemId	(void * ctx)

+
Provides the system ID, basically URL or filename e.g. http://www.sgmlsource.com/dtds/memo.dtd DEPRECATED: use xmlSAX2GetSystemId()

+
ctx:the user data (XML parser context)
Returns:a xmlChar *
Function: startDocument
void	startDocument	(void * ctx)

+
called when the document start being processed. DEPRECATED: use xmlSAX2StartDocument()

+
ctx:the user data (XML parser context)
Function: internalSubset
void	internalSubset	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Callback on internal subset declaration. DEPRECATED: use xmlSAX2InternalSubset()

+
ctx:the user data (XML parser context)
name:the root element name
ExternalID:the external ID
SystemID:the SYSTEM ID (e.g. filename or URL)
Function: endDocument
void	endDocument	(void * ctx)

+
called when the document end has been detected. DEPRECATED: use xmlSAX2EndDocument()

+
ctx:the user data (XML parser context)
Function: getLineNumber
int	getLineNumber	(void * ctx)

+
Provide the line number of the current parsing point. DEPRECATED: use xmlSAX2GetLineNumber()

+
ctx:the user data (XML parser context)
Returns:an int
Daniel Veillard

diff --git a/doc/html/libxml-c14n.html b/doc/html/libxml-c14n.html
index a0554d8b..f93f9bb5 100644
--- a/doc/html/libxml-c14n.html
+++ b/doc/html/libxml-c14n.html
@@ -1,178 +1,32 @@
-c14n
PrevUpHomeGnome XML Library Reference ManualNext
c14n
c14n — 
Synopsis
-
-
-
-int         xmlC14NDocSaveTo                (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             xmlOutputBufferPtr buf);
-int         xmlC14NDocDumpMemory            (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             xmlChar **doc_txt_ptr);
-int         xmlC14NDocSave                  (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             const char *filename,
-                                             int compression);
-int         (*xmlC14NIsVisibleCallback)     (void *user_data,
-                                             xmlNodePtr node,
-                                             xmlNodePtr parent);
-int         xmlC14NExecute                  (xmlDocPtr doc,
-                                             xmlC14NIsVisibleCallback is_visible_callback,
-                                             void *user_data,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             xmlOutputBufferPtr buf);
-
Description

-
-
Details
xmlC14NDocSaveTo ()
int         xmlC14NDocSaveTo                (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             xmlOutputBufferPtr buf);

-Dumps the canonized image of given XML document into the provided buffer.
-For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
-"Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

-
-
doc: 		the XML document for canonization
-
nodes: 		the nodes set to be included in the canonized image
-     		or NULL if all document nodes should be included
-
exclusive:		the exclusive flag (0 - non-exclusive canonicalization;
-		otherwise - exclusive canonicalization)
-
inclusive_ns_prefixes: the list of inclusive namespace prefixes 
-		ended with a NULL or NULL if there is no
-		inclusive namespaces (only for exclusive 
-		canonicalization, ignored otherwise)
-
with_comments: 	include comments in the result (!=0) or not (==0)
-
buf: 		the output buffer to store canonical XML; this 
-		buffer MUST have encoder==NULL because C14N requires
-		UTF-8 output
-
Returns :non-negative value on success or a negative value on fail  
-
xmlC14NDocDumpMemory ()
int         xmlC14NDocDumpMemory            (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             xmlChar **doc_txt_ptr);

-Dumps the canonized image of given XML document into memory.
-For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
-"Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

-
-
doc: 		the XML document for canonization
-
nodes: 		the nodes set to be included in the canonized image
-     		or NULL if all document nodes should be included
-
exclusive:		the exclusive flag (0 - non-exclusive canonicalization;
-		otherwise - exclusive canonicalization)
-
inclusive_ns_prefixes: the list of inclusive namespace prefixes 
-		ended with a NULL or NULL if there is no
-		inclusive namespaces (only for exclusive 
-		canonicalization, ignored otherwise)
-
with_comments: 	include comments in the result (!=0) or not (==0)
-
doc_txt_ptr: 	the memory pointer for allocated canonical XML text;
-		the caller of this functions is responsible for calling
-		xmlFree() to free allocated memory 
-
Returns :the number of bytes written on success or a negative value on fail  
-
xmlC14NDocSave ()
int         xmlC14NDocSave                  (xmlDocPtr doc,
-                                             xmlNodeSetPtr nodes,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             const char *filename,
-                                             int compression);

-Dumps the canonized image of given XML document into the file.
-For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
-"Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

-
-
doc: 		the XML document for canonization
-
nodes: 		the nodes set to be included in the canonized image
-     		or NULL if all document nodes should be included
-
exclusive:		the exclusive flag (0 - non-exclusive canonicalization;
-		otherwise - exclusive canonicalization)
-
inclusive_ns_prefixes: the list of inclusive namespace prefixes 
-		ended with a NULL or NULL if there is no
-		inclusive namespaces (only for exclusive 
-		canonicalization, ignored otherwise)
-
with_comments: 	include comments in the result (!=0) or not (==0)
-
filename: 		the filename to store canonical XML image
-
compression:	the compression level (zlib requred): 
-			-1 - libxml default,
-			 0 - uncompressed, 
-			>0 - compression level
-
Returns :the number of bytes written success or a negative value on fail  
-
xmlC14NIsVisibleCallback ()
int         (*xmlC14NIsVisibleCallback)     (void *user_data,
-                                             xmlNodePtr node,
-                                             xmlNodePtr parent);

-
-
user_data:
-
node:
-
parent:
-
Returns :
-
-
-
xmlC14NExecute ()
int         xmlC14NExecute                  (xmlDocPtr doc,
-                                             xmlC14NIsVisibleCallback is_visible_callback,
-                                             void *user_data,
-                                             int exclusive,
-                                             xmlChar **inclusive_ns_prefixes,
-                                             int with_comments,
-                                             xmlOutputBufferPtr buf);

-Dumps the canonized image of given XML document into the provided buffer.
-For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or
-"Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

-
-
doc: 		the XML document for canonization
-
is_visible_callback:the function to use to determine is node visible 
-		or not
-
user_data: 		the first parameter for is_visible_callback function
-		(in most cases, it is nodes set)
-
exclusive:		the exclusive flag (0 - non-exclusive canonicalization;
-		otherwise - exclusive canonicalization)
-
inclusive_ns_prefixes: the list of inclusive namespace prefixes 
-		ended with a NULL or NULL if there is no
-		inclusive namespaces (only for exclusive 
-		canonicalization, ignored otherwise)
-
with_comments: 	include comments in the result (!=0) or not (==0)
-
buf: 		the output buffer to store canonical XML; this 
-		buffer MUST have encoder==NULL because C14N requires
-		UTF-8 output
-
Returns :non-negative value on success or a negative value on fail  
-
<< parserxmlerror >>

+
+
+Module c14n from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module c14n from libxml2
Main Menu
Related links
Table of Contents
int	xmlC14NExecute	(xmlDocPtr doc, 
				 xmlC14NIsVisibleCallback is_visible_callback, 
				 void * user_data, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 xmlOutputBufferPtr buf)

+
int	xmlC14NDocSaveTo	(xmlDocPtr doc, 
				 xmlNodeSetPtr nodes, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 xmlOutputBufferPtr buf)

+
Function type: xmlC14NIsVisibleCallback
+int	xmlC14NIsVisibleCallback	(void * user_data, 
				 xmlNodePtr node, 
				 xmlNodePtr parent)
+
user_data:
node:
parent:
Returns:


+
int	xmlC14NDocSave	(xmlDocPtr doc, 
				 xmlNodeSetPtr nodes, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 const char * filename, 
				 int compression)

+
int	xmlC14NDocDumpMemory	(xmlDocPtr doc, 
				 xmlNodeSetPtr nodes, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 xmlChar ** doc_txt_ptr)

+
Description

+
Function: xmlC14NExecute
int	xmlC14NExecute	(xmlDocPtr doc, 
				 xmlC14NIsVisibleCallback is_visible_callback, 
				 void * user_data, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 xmlOutputBufferPtr buf)

+
Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+
doc:the XML document for canonization
is_visible_callback:the function to use to determine is node visible or not
user_data:the first parameter for @is_visible_callback function (in most cases, it is nodes set)
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
buf:the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output
Returns:non-negative value on success or a negative value on fail
Function: xmlC14NDocSaveTo
int	xmlC14NDocSaveTo	(xmlDocPtr doc, 
				 xmlNodeSetPtr nodes, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 xmlOutputBufferPtr buf)

+
Dumps the canonized image of given XML document into the provided buffer. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+
doc:the XML document for canonization
nodes:the nodes set to be included in the canonized image or NULL if all document nodes should be included
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
buf:the output buffer to store canonical XML; this buffer MUST have encoder==NULL because C14N requires UTF-8 output
Returns:non-negative value on success or a negative value on fail

+      
+      
+      
+      
+      
+    
Function: xmlC14NDocSave
int	xmlC14NDocSave	(xmlDocPtr doc, 
				 xmlNodeSetPtr nodes, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 const char * filename, 
				 int compression)

+
Dumps the canonized image of given XML document into the file. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+
doc:the XML document for canonization
nodes:the nodes set to be included in the canonized image or NULL if all document nodes should be included
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
filename:the filename to store canonical XML image
compression:the compression level (zlib requred): -1 - libxml default, 0 - uncompressed, >0 - compression level
Returns:the number of bytes written success or a negative value on fail
Function: xmlC14NDocDumpMemory
int	xmlC14NDocDumpMemory	(xmlDocPtr doc, 
				 xmlNodeSetPtr nodes, 
				 int exclusive, 
				 xmlChar ** inclusive_ns_prefixes, 
				 int with_comments, 
				 xmlChar ** doc_txt_ptr)

+
Dumps the canonized image of given XML document into memory. For details see "Canonical XML" (http://www.w3.org/TR/xml-c14n) or "Exclusive XML Canonicalization" (http://www.w3.org/TR/xml-exc-c14n)

+
doc:the XML document for canonization
nodes:the nodes set to be included in the canonized image or NULL if all document nodes should be included
exclusive:the exclusive flag (0 - non-exclusive canonicalization; otherwise - exclusive canonicalization)
inclusive_ns_prefixes:the list of inclusive namespace prefixes ended with a NULL or NULL if there is no inclusive namespaces (only for exclusive canonicalization, ignored otherwise)
with_comments:include comments in the result (!=0) or not (==0)
doc_txt_ptr:the memory pointer for allocated canonical XML text; the caller of this functions is responsible for calling xmlFree() to free allocated memory
Returns:the number of bytes written on success or a negative value on fail
Daniel Veillard

diff --git a/doc/html/libxml-catalog.html b/doc/html/libxml-catalog.html
index ab86fb4b..a5b39fd8 100644
--- a/doc/html/libxml-catalog.html
+++ b/doc/html/libxml-catalog.html
@@ -1,362 +1,142 @@
-catalog
PrevUpHomeGnome XML Library Reference ManualNext
catalog
catalog — 
Synopsis
+
+
+Module catalog from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module catalog from libxml2
Main Menu
Related links
Table of Contents
#define XML_CATALOGS_NAMESPACE
 
+
xmlChar *	xmlCatalogLocalResolve	(void * catalogs, 
				 const xmlChar * pubID, 
				 const xmlChar * sysID)

+
int	xmlACatalogAdd	(xmlCatalogPtr catal, 
				 const xmlChar * type, 
				 const xmlChar * orig, 
				 const xmlChar * replace)

+
xmlChar *	xmlCatalogResolvePublic	(const xmlChar * pubID)

+
xmlCatalogAllow	xmlCatalogGetDefaults	(void)

+
int	xmlCatalogAdd	(const xmlChar * type, 
				 const xmlChar * orig, 
				 const xmlChar * replace)

+
xmlCatalogPrefer	xmlCatalogSetDefaultPrefer	(xmlCatalogPrefer prefer)

+
xmlDocPtr	xmlParseCatalogFile	(const char * filename)

+
xmlChar *	xmlACatalogResolveURI	(xmlCatalogPtr catal, 
				 const xmlChar * URI)

+
int	xmlACatalogRemove	(xmlCatalogPtr catal, 
				 const xmlChar * value)

+
void	xmlLoadCatalogs	(const char * pathss)

+
const xmlChar *	xmlCatalogGetSystem	(const xmlChar * sysID)

+
void	xmlInitializeCatalog	(void)

+
int	xmlLoadCatalog	(const char * filename)

+
#define XML_CATALOG_PI
 
+
int	xmlCatalogIsEmpty	(xmlCatalogPtr catal)

+
void	xmlACatalogDump	(xmlCatalogPtr catal, 
				 FILE * out)

+
Typedef xmlCatalog * xmlCatalogPtr
 
-#define     XML_CATALOGS_NAMESPACE
-#define     XML_CATALOG_PI
-enum        xmlCatalogPrefer;
-enum        xmlCatalogAllow;
-struct      xmlCatalog;
-typedef     xmlCatalogPtr;
-xmlCatalogPtr xmlNewCatalog                 (int sgml);
-xmlCatalogPtr xmlLoadACatalog               (const char *filename);
-xmlCatalogPtr xmlLoadSGMLSuperCatalog       (const char *filename);
-int         xmlConvertSGMLCatalog           (xmlCatalogPtr catal);
-int         xmlACatalogAdd                  (xmlCatalogPtr catal,
-                                             const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);
-int         xmlACatalogRemove               (xmlCatalogPtr catal,
-                                             const xmlChar *value);
-xmlChar*    xmlACatalogResolve              (xmlCatalogPtr catal,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);
-xmlChar*    xmlACatalogResolveSystem        (xmlCatalogPtr catal,
-                                             const xmlChar *sysID);
-xmlChar*    xmlACatalogResolvePublic        (xmlCatalogPtr catal,
-                                             const xmlChar *pubID);
-xmlChar*    xmlACatalogResolveURI           (xmlCatalogPtr catal,
-                                             const xmlChar *URI);
-void        xmlACatalogDump                 (xmlCatalogPtr catal,
-                                             FILE *out);
-void        xmlFreeCatalog                  (xmlCatalogPtr catal);
-int         xmlCatalogIsEmpty               (xmlCatalogPtr catal);
-void        xmlInitializeCatalog            (void);
-int         xmlLoadCatalog                  (const char *filename);
-void        xmlLoadCatalogs                 (const char *paths);
-void        xmlCatalogCleanup               (void);
-void        xmlCatalogDump                  (FILE *out);
-xmlChar*    xmlCatalogResolve               (const xmlChar *pubID,
-                                             const xmlChar *sysID);
-xmlChar*    xmlCatalogResolveSystem         (const xmlChar *sysID);
-xmlChar*    xmlCatalogResolvePublic         (const xmlChar *pubID);
-xmlChar*    xmlCatalogResolveURI            (const xmlChar *URI);
-int         xmlCatalogAdd                   (const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);
-int         xmlCatalogRemove                (const xmlChar *value);
-xmlDocPtr   xmlParseCatalogFile             (const char *filename);
-int         xmlCatalogConvert               (void);
-void        xmlCatalogFreeLocal             (void *catalogs);
-void*       xmlCatalogAddLocal              (void *catalogs,
-                                             const xmlChar *URL);
-xmlChar*    xmlCatalogLocalResolve          (void *catalogs,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);
-xmlChar*    xmlCatalogLocalResolveURI       (void *catalogs,
-                                             const xmlChar *URI);
-int         xmlCatalogSetDebug              (int level);
-xmlCatalogPrefer xmlCatalogSetDefaultPrefer (xmlCatalogPrefer prefer);
-void        xmlCatalogSetDefaults           (xmlCatalogAllow allow);
-xmlCatalogAllow xmlCatalogGetDefaults       (void);
-const xmlChar* xmlCatalogGetSystem          (const xmlChar *sysID);
-const xmlChar* xmlCatalogGetPublic          (const xmlChar *pubID);
-
Description

+
void	xmlCatalogFreeLocal	(void * catalogs)

+
xmlChar *	xmlACatalogResolve	(xmlCatalogPtr catal, 
				 const xmlChar * pubID, 
				 const xmlChar * sysID)

+
xmlChar *	xmlCatalogResolveSystem	(const xmlChar * sysID)

+
Enum xmlCatalogPrefer {
+    XML_CATA_PREFER_NONE = 0
+    XML_CATA_PREFER_PUBLIC = 1
+    XML_CATA_PREFER_SYSTEM = 2
+}
 
-
Details
XML_CATALOGS_NAMESPACE
#define     XML_CATALOGS_NAMESPACE

-The namespace for the XML Catalogs elements.

+
xmlCatalogPtr	xmlLoadSGMLSuperCatalog	(const char * filename)

+
int	xmlCatalogConvert	(void)

+
const xmlChar *	xmlCatalogGetPublic	(const xmlChar * pubID)

+
xmlCatalogPtr	xmlLoadACatalog	(const char * filename)

+
xmlChar *	xmlACatalogResolveSystem	(xmlCatalogPtr catal, 
				 const xmlChar * sysID)

+
xmlChar *	xmlCatalogLocalResolveURI	(void * catalogs, 
				 const xmlChar * URI)

+
int	xmlConvertSGMLCatalog	(xmlCatalogPtr catal)

+
xmlChar *	xmlACatalogResolvePublic	(xmlCatalogPtr catal, 
				 const xmlChar * pubID)

+
void *	xmlCatalogAddLocal	(void * catalogs, 
				 const xmlChar * URL)

+
int	xmlCatalogRemove	(const xmlChar * value)

+
void	xmlFreeCatalog	(xmlCatalogPtr catal)

+
xmlCatalogPtr	xmlNewCatalog	(int sgml)

+
Enum xmlCatalogAllow {
+    XML_CATA_ALLOW_NONE = 0
+    XML_CATA_ALLOW_GLOBAL = 1
+    XML_CATA_ALLOW_DOCUMENT = 2
+    XML_CATA_ALLOW_ALL = 3
+}
 
-
XML_CATALOG_PI
#define     XML_CATALOG_PI

-The specific XML Catalog Processing Instuction name.

-
-
enum xmlCatalogPrefer
typedef enum {
-    XML_CATA_PREFER_NONE = 0,
-    XML_CATA_PREFER_PUBLIC = 1,
-    XML_CATA_PREFER_SYSTEM
-} xmlCatalogPrefer;
-

-
-
enum xmlCatalogAllow
typedef enum {
-    XML_CATA_ALLOW_NONE = 0,
-    XML_CATA_ALLOW_GLOBAL = 1,
-    XML_CATA_ALLOW_DOCUMENT = 2,
-    XML_CATA_ALLOW_ALL = 3
-} xmlCatalogAllow;
-

-
-
struct xmlCatalog
struct xmlCatalog;

-
-
xmlCatalogPtr
typedef xmlCatalog *xmlCatalogPtr;
-

-
-
xmlNewCatalog ()
xmlCatalogPtr xmlNewCatalog                 (int sgml);

-create a new Catalog.

-
-
sgml:  should this create an SGML catalog
-
Returns :the xmlCatalogPtr or NULL in case of error
-
xmlLoadACatalog ()
xmlCatalogPtr xmlLoadACatalog               (const char *filename);

-Load the catalog and build the associated data structures.
-This can be either an XML Catalog or an SGML Catalog
-It will recurse in SGML CATALOG entries. On the other hand XML
-Catalogs are not handled recursively.

-
-
filename:  a file path
-
Returns :the catalog parsed or NULL in case of error
-
xmlLoadSGMLSuperCatalog ()
xmlCatalogPtr xmlLoadSGMLSuperCatalog       (const char *filename);

-Load an SGML super catalog. It won't expand CATALOG or DELEGATE
-references. This is only needed for manipulating SGML Super Catalogs
-like adding and removing CATALOG or DELEGATE entries.

-
-
filename:  a file path
-
Returns :the catalog parsed or NULL in case of error
-
xmlConvertSGMLCatalog ()
int         xmlConvertSGMLCatalog           (xmlCatalogPtr catal);

-Convert all the SGML catalog entries as XML ones

-
-
catal: the catalog
-
Returns :the number of entries converted if successful, -1 otherwise
-
xmlACatalogAdd ()
int         xmlACatalogAdd                  (xmlCatalogPtr catal,
-                                             const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);

-Add an entry in the catalog, it may overwrite existing but
-different entries.

-
-
catal:  a Catalog
-
type:  the type of record to add to the catalog
-
orig:  the system, public or prefix to match 
-
replace:  the replacement value for the match
-
Returns :0 if successful, -1 otherwise
-
xmlACatalogRemove ()
int         xmlACatalogRemove               (xmlCatalogPtr catal,
-                                             const xmlChar *value);

-Remove an entry from the catalog

-
-
catal:  a Catalog
-
value:  the value to remove
-
Returns :the number of entries removed if successful, -1 otherwise
-
xmlACatalogResolve ()
xmlChar*    xmlACatalogResolve              (xmlCatalogPtr catal,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);

-Do a complete resolution lookup of an External Identifier

-
-
catal:  a Catalog
-
pubID:  the public ID string
-
sysID:  the system ID string
-
Returns :the URI of the resource or NULL if not found, it must be freed
-     by the caller.
-
xmlACatalogResolveSystem ()
xmlChar*    xmlACatalogResolveSystem        (xmlCatalogPtr catal,
-                                             const xmlChar *sysID);

-Try to lookup the catalog resource for a system ID

-
-
catal:  a Catalog
-
sysID:  the public ID string
-
Returns :the system ID if found or NULL otherwise, the value returned
-     must be freed by the caller.
-
xmlACatalogResolvePublic ()
xmlChar*    xmlACatalogResolvePublic        (xmlCatalogPtr catal,
-                                             const xmlChar *pubID);

-Try to lookup the system ID associated to a public ID in that catalog

-
-
catal:  a Catalog
-
pubID:  the public ID string
-
Returns :the system ID if found or NULL otherwise, the value returned
-     must be freed by the caller.
-
xmlACatalogResolveURI ()
xmlChar*    xmlACatalogResolveURI           (xmlCatalogPtr catal,
-                                             const xmlChar *URI);

-Do a complete resolution lookup of an URI

-
-
catal:  a Catalog
-
URI:  the URI
-
Returns :the URI of the resource or NULL if not found, it must be freed
-     by the caller.
-
xmlACatalogDump ()
void        xmlACatalogDump                 (xmlCatalogPtr catal,
-                                             FILE *out);

-Free up all the memory associated with catalogs

-
-
catal:  a Catalog
-
out:  the file.
-
xmlFreeCatalog ()
void        xmlFreeCatalog                  (xmlCatalogPtr catal);

-Free the memory allocated to a Catalog

-
-
catal:  a Catalog entry
-
xmlCatalogIsEmpty ()
int         xmlCatalogIsEmpty               (xmlCatalogPtr catal);

-Check is a catalog is empty

-
-
catal:  should this create an SGML catalog
-
Returns :1 if the catalog is empty, 0 if not, amd -1 in case of error.
-
xmlInitializeCatalog ()
void        xmlInitializeCatalog            (void);

-Do the catalog initialization.
-this function is not thread safe, catalog initialization should
-preferably be done once at startup

-
-
xmlLoadCatalog ()
int         xmlLoadCatalog                  (const char *filename);

-Load the catalog and makes its definitions effective for the default
-external entity loader. It will recurse in SGML CATALOG entries.
-this function is not thread safe, catalog initialization should
-preferably be done once at startup

-
-
filename:  a file path
-
Returns :0 in case of success -1 in case of error
-
xmlLoadCatalogs ()
void        xmlLoadCatalogs                 (const char *paths);

-Load the catalogs and makes their definitions effective for the default
-external entity loader.
-this function is not thread safe, catalog initialization should
-preferably be done once at startup

-
-
paths:
-
-
-
xmlCatalogCleanup ()
void        xmlCatalogCleanup               (void);

-Free up all the memory associated with catalogs

-
-
xmlCatalogDump ()
void        xmlCatalogDump                  (FILE *out);

-Free up all the memory associated with catalogs

-
-
out:  the file.
-
xmlCatalogResolve ()
xmlChar*    xmlCatalogResolve               (const xmlChar *pubID,
-                                             const xmlChar *sysID);

-Do a complete resolution lookup of an External Identifier

-
-
pubID:  the public ID string
-
sysID:  the system ID string
-
Returns :the URI of the resource or NULL if not found, it must be freed
-     by the caller.
-
xmlCatalogResolveSystem ()
xmlChar*    xmlCatalogResolveSystem         (const xmlChar *sysID);

-Try to lookup the catalog resource for a system ID

-
-
sysID:  the public ID string
-
Returns :the system ID if found or NULL otherwise, the value returned
-     must be freed by the caller.
-
xmlCatalogResolvePublic ()
xmlChar*    xmlCatalogResolvePublic         (const xmlChar *pubID);

-Try to lookup the system ID associated to a public ID

-
-
pubID:  the public ID string
-
Returns :the system ID if found or NULL otherwise, the value returned
-     must be freed by the caller.
-
xmlCatalogResolveURI ()
xmlChar*    xmlCatalogResolveURI            (const xmlChar *URI);

-Do a complete resolution lookup of an URI

-
-
URI:  the URI
-
Returns :the URI of the resource or NULL if not found, it must be freed
-     by the caller.
-
xmlCatalogAdd ()
int         xmlCatalogAdd                   (const xmlChar *type,
-                                             const xmlChar *orig,
-                                             const xmlChar *replace);

-Add an entry in the catalog, it may overwrite existing but
-different entries.
-If called before any other catalog routine, allows to override the
-default shared catalog put in place by xmlInitializeCatalog();

-
-
type:  the type of record to add to the catalog
-
orig:  the system, public or prefix to match 
-
replace:  the replacement value for the match
-
Returns :0 if successful, -1 otherwise
-
xmlCatalogRemove ()
int         xmlCatalogRemove                (const xmlChar *value);

-Remove an entry from the catalog

-
-
value:  the value to remove
-
Returns :the number of entries removed if successful, -1 otherwise
-
xmlParseCatalogFile ()
xmlDocPtr   xmlParseCatalogFile             (const char *filename);

-parse an XML file and build a tree. It's like xmlParseFile()
-except it bypass all catalog lookups.

-
-
filename:  the filename
-
Returns :the resulting document tree or NULL in case of error
-
xmlCatalogConvert ()
int         xmlCatalogConvert               (void);

-Convert all the SGML catalog entries as XML ones

-
-
Returns :the number of entries converted if successful, -1 otherwise
-
xmlCatalogFreeLocal ()
void        xmlCatalogFreeLocal             (void *catalogs);

-Free up the memory associated to the catalog list

-
-
catalogs:  a document's list of catalogs
-
xmlCatalogAddLocal ()
void*       xmlCatalogAddLocal              (void *catalogs,
-                                             const xmlChar *URL);

-Add the new entry to the catalog list

-
-
catalogs:  a document's list of catalogs
-
URL:  the URL to a new local catalog
-
xmlCatalogLocalResolve ()
xmlChar*    xmlCatalogLocalResolve          (void *catalogs,
-                                             const xmlChar *pubID,
-                                             const xmlChar *sysID);

-Do a complete resolution lookup of an External Identifier using a 
-document's private catalog list

-
-
catalogs:  a document's list of catalogs
-
pubID:  the public ID string
-
sysID:  the system ID string
-
Returns :the URI of the resource or NULL if not found, it must be freed
-     by the caller.
-
xmlCatalogLocalResolveURI ()
xmlChar*    xmlCatalogLocalResolveURI       (void *catalogs,
-                                             const xmlChar *URI);

-Do a complete resolution lookup of an URI using a 
-document's private catalog list

-
-
catalogs:  a document's list of catalogs
-
URI:  the URI
-
Returns :the URI of the resource or NULL if not found, it must be freed
-     by the caller.
-
xmlCatalogSetDebug ()
int         xmlCatalogSetDebug              (int level);

-Used to set the debug level for catalog operation, 0 disable
-debugging, 1 enable it

-
-
level:  the debug level of catalogs required
-
Returns :the previous value of the catalog debugging level
-
xmlCatalogSetDefaultPrefer ()
xmlCatalogPrefer xmlCatalogSetDefaultPrefer (xmlCatalogPrefer prefer);

-Allows to set the preference between public and system for deletion
-in XML Catalog resolution. C.f. section 4.1.1 of the spec
-Values accepted are XML_CATA_PREFER_PUBLIC or XML_CATA_PREFER_SYSTEM

-
-
prefer:  the default preference for delegation
-
Returns :the previous value of the default preference for delegation
-
xmlCatalogSetDefaults ()
void        xmlCatalogSetDefaults           (xmlCatalogAllow allow);

-Used to set the user preference w.r.t. to what catalogs should
-be accepted

-
-
allow:  what catalogs should be accepted
-
xmlCatalogGetDefaults ()
xmlCatalogAllow xmlCatalogGetDefaults       (void);

-Used to get the user preference w.r.t. to what catalogs should
-be accepted

-
-
Returns :the current xmlCatalogAllow value
-
xmlCatalogGetSystem ()
const xmlChar* xmlCatalogGetSystem          (const xmlChar *sysID);

-Try to lookup the system ID associated to a public ID
-DEPRECATED, use xmlCatalogResolveSystem()

-
-
sysID:  the system ID string
-
Returns :the system ID if found or NULL otherwise.
-
xmlCatalogGetPublic ()
const xmlChar* xmlCatalogGetPublic          (const xmlChar *pubID);

-Try to lookup the system ID associated to a public ID
-DEPRECATED, use xmlCatalogResolvePublic()

-
-
pubID:  the public ID string
-
Returns :the system ID if found or NULL otherwise.
-
<< validtree >>

+
int	xmlCatalogSetDebug	(int level)

+
xmlChar *	xmlCatalogResolve	(const xmlChar * pubID, 
				 const xmlChar * sysID)

+
Structure xmlCatalog
struct _xmlCatalog {
+The content of this structure is not made public by the API.
+}

void	xmlCatalogSetDefaults	(xmlCatalogAllow allow)

+
void	xmlCatalogDump	(FILE * out)

+
void	xmlCatalogCleanup	(void)

+
xmlChar *	xmlCatalogResolveURI	(const xmlChar * URI)

+
Description

+
Macro: XML_CATALOGS_NAMESPACE
#define XML_CATALOGS_NAMESPACE
The namespace for the XML Catalogs elements.

+
Function: xmlCatalogLocalResolve
xmlChar *	xmlCatalogLocalResolve	(void * catalogs, 
				 const xmlChar * pubID, 
				 const xmlChar * sysID)

+
Do a complete resolution lookup of an External Identifier using a document's private catalog list

+
catalogs:a document's list of catalogs
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlACatalogAdd
int	xmlACatalogAdd	(xmlCatalogPtr catal, 
				 const xmlChar * type, 
				 const xmlChar * orig, 
				 const xmlChar * replace)

+
Add an entry in the catalog, it may overwrite existing but different entries.

+
catal:a Catalog
type:the type of record to add to the catalog
orig:the system, public or prefix to match
replace:the replacement value for the match
Returns:0 if successful, -1 otherwise
Function: xmlCatalogResolvePublic
xmlChar *	xmlCatalogResolvePublic	(const xmlChar * pubID)

+
Try to lookup the system ID associated to a public ID

+
pubID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlCatalogGetDefaults
xmlCatalogAllow	xmlCatalogGetDefaults	(void)

+
Used to get the user preference w.r.t. to what catalogs should be accepted

+
Returns:the current xmlCatalogAllow value
Function: xmlCatalogAdd
int	xmlCatalogAdd	(const xmlChar * type, 
				 const xmlChar * orig, 
				 const xmlChar * replace)

+
Add an entry in the catalog, it may overwrite existing but different entries. If called before any other catalog routine, allows to override the default shared catalog put in place by xmlInitializeCatalog();

+
type:the type of record to add to the catalog
orig:the system, public or prefix to match
replace:the replacement value for the match
Returns:0 if successful, -1 otherwise
Function: xmlCatalogSetDefaultPrefer
xmlCatalogPrefer	xmlCatalogSetDefaultPrefer	(xmlCatalogPrefer prefer)

+
Allows to set the preference between public and system for deletion in XML Catalog resolution. C.f. section 4.1.1 of the spec Values accepted are XML_CATA_PREFER_PUBLIC or XML_CATA_PREFER_SYSTEM

+
prefer:the default preference for delegation
Returns:the previous value of the default preference for delegation
Function: xmlParseCatalogFile
xmlDocPtr	xmlParseCatalogFile	(const char * filename)

+
parse an XML file and build a tree. It's like xmlParseFile() except it bypass all catalog lookups.

+
filename:the filename
Returns:the resulting document tree or NULL in case of error
Function: xmlACatalogResolveURI
xmlChar *	xmlACatalogResolveURI	(xmlCatalogPtr catal, 
				 const xmlChar * URI)

+
Do a complete resolution lookup of an URI

+
catal:a Catalog
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlACatalogRemove
int	xmlACatalogRemove	(xmlCatalogPtr catal, 
				 const xmlChar * value)

+
Remove an entry from the catalog

+
catal:a Catalog
value:the value to remove
Returns:the number of entries removed if successful, -1 otherwise
Function: xmlLoadCatalogs
void	xmlLoadCatalogs	(const char * pathss)

+
Load the catalogs and makes their definitions effective for the default external entity loader. this function is not thread safe, catalog initialization should preferably be done once at startup

+
pathss:a list of directories separated by a colon or a space.
Function: xmlCatalogGetSystem
const xmlChar *	xmlCatalogGetSystem	(const xmlChar * sysID)

+
Try to lookup the system ID associated to a public ID DEPRECATED, use xmlCatalogResolveSystem()

+
sysID:the system ID string
Returns:the system ID if found or NULL otherwise.
Function: xmlInitializeCatalog
void	xmlInitializeCatalog	(void)

+
Do the catalog initialization. this function is not thread safe, catalog initialization should preferably be done once at startup

+
Function: xmlLoadCatalog
int	xmlLoadCatalog	(const char * filename)

+
Load the catalog and makes its definitions effective for the default external entity loader. It will recurse in SGML CATALOG entries. this function is not thread safe, catalog initialization should preferably be done once at startup

+
filename:a file path
Returns:0 in case of success -1 in case of error
Macro: XML_CATALOG_PI
#define XML_CATALOG_PI
The specific XML Catalog Processing Instuction name.

+
Function: xmlCatalogIsEmpty
int	xmlCatalogIsEmpty	(xmlCatalogPtr catal)

+
Check is a catalog is empty

+
catal:should this create an SGML catalog
Returns:1 if the catalog is empty, 0 if not, amd -1 in case of error.
Function: xmlACatalogDump
void	xmlACatalogDump	(xmlCatalogPtr catal, 
				 FILE * out)

+
Free up all the memory associated with catalogs

+
catal:a Catalog
out:the file.
Function: xmlCatalogFreeLocal
void	xmlCatalogFreeLocal	(void * catalogs)

+
Free up the memory associated to the catalog list

+
catalogs:a document's list of catalogs
Function: xmlACatalogResolve
xmlChar *	xmlACatalogResolve	(xmlCatalogPtr catal, 
				 const xmlChar * pubID, 
				 const xmlChar * sysID)

+
Do a complete resolution lookup of an External Identifier

+
catal:a Catalog
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlCatalogResolveSystem
xmlChar *	xmlCatalogResolveSystem	(const xmlChar * sysID)

+
Try to lookup the catalog resource for a system ID

+
sysID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlLoadSGMLSuperCatalog
xmlCatalogPtr	xmlLoadSGMLSuperCatalog	(const char * filename)

+
Load an SGML super catalog. It won't expand CATALOG or DELEGATE references. This is only needed for manipulating SGML Super Catalogs like adding and removing CATALOG or DELEGATE entries.

+
filename:a file path
Returns:the catalog parsed or NULL in case of error
Function: xmlCatalogConvert
int	xmlCatalogConvert	(void)

+
Convert all the SGML catalog entries as XML ones

+
Returns:the number of entries converted if successful, -1 otherwise
Function: xmlCatalogGetPublic
const xmlChar *	xmlCatalogGetPublic	(const xmlChar * pubID)

+
Try to lookup the system ID associated to a public ID DEPRECATED, use xmlCatalogResolvePublic()

+
pubID:the public ID string
Returns:the system ID if found or NULL otherwise.
Function: xmlLoadACatalog
xmlCatalogPtr	xmlLoadACatalog	(const char * filename)

+
Load the catalog and build the associated data structures. This can be either an XML Catalog or an SGML Catalog It will recurse in SGML CATALOG entries. On the other hand XML Catalogs are not handled recursively.

+
filename:a file path
Returns:the catalog parsed or NULL in case of error
Function: xmlACatalogResolveSystem
xmlChar *	xmlACatalogResolveSystem	(xmlCatalogPtr catal, 
				 const xmlChar * sysID)

+
Try to lookup the catalog resource for a system ID

+
catal:a Catalog
sysID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlCatalogLocalResolveURI
xmlChar *	xmlCatalogLocalResolveURI	(void * catalogs, 
				 const xmlChar * URI)

+
Do a complete resolution lookup of an URI using a document's private catalog list

+
catalogs:a document's list of catalogs
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlConvertSGMLCatalog
int	xmlConvertSGMLCatalog	(xmlCatalogPtr catal)

+
Convert all the SGML catalog entries as XML ones

+
catal:the catalog
Returns:the number of entries converted if successful, -1 otherwise
Function: xmlACatalogResolvePublic
xmlChar *	xmlACatalogResolvePublic	(xmlCatalogPtr catal, 
				 const xmlChar * pubID)

+
Try to lookup the system ID associated to a public ID in that catalog

+
catal:a Catalog
pubID:the public ID string
Returns:the system ID if found or NULL otherwise, the value returned must be freed by the caller.
Function: xmlCatalogAddLocal
void *	xmlCatalogAddLocal	(void * catalogs, 
				 const xmlChar * URL)

+
Add the new entry to the catalog list

+
catalogs:a document's list of catalogs
URL:the URL to a new local catalog
Returns:the updated list
Function: xmlCatalogRemove
int	xmlCatalogRemove	(const xmlChar * value)

+
Remove an entry from the catalog

+
value:the value to remove
Returns:the number of entries removed if successful, -1 otherwise
Function: xmlFreeCatalog
void	xmlFreeCatalog	(xmlCatalogPtr catal)

+
Free the memory allocated to a Catalog

+
catal:a Catalog entry
Function: xmlNewCatalog
xmlCatalogPtr	xmlNewCatalog	(int sgml)

+
create a new Catalog.

+
sgml:should this create an SGML catalog
Returns:the xmlCatalogPtr or NULL in case of error
Function: xmlCatalogSetDebug
int	xmlCatalogSetDebug	(int level)

+
Used to set the debug level for catalog operation, 0 disable debugging, 1 enable it

+
level:the debug level of catalogs required
Returns:the previous value of the catalog debugging level
Function: xmlCatalogResolve
xmlChar *	xmlCatalogResolve	(const xmlChar * pubID, 
				 const xmlChar * sysID)

+
Do a complete resolution lookup of an External Identifier

+
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Function: xmlCatalogSetDefaults
void	xmlCatalogSetDefaults	(xmlCatalogAllow allow)

+
Used to set the user preference w.r.t. to what catalogs should be accepted

+
allow:what catalogs should be accepted
Function: xmlCatalogDump
void	xmlCatalogDump	(FILE * out)

+
Free up all the memory associated with catalogs

+
out:the file.
Function: xmlCatalogCleanup
void	xmlCatalogCleanup	(void)

+
Free up all the memory associated with catalogs

+
Function: xmlCatalogResolveURI
xmlChar *	xmlCatalogResolveURI	(const xmlChar * URI)

+
Do a complete resolution lookup of an URI

+
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.
Daniel Veillard

diff --git a/doc/html/libxml-chvalid.html b/doc/html/libxml-chvalid.html
index e4a722cf..2459e4ed 100644
--- a/doc/html/libxml-chvalid.html
+++ b/doc/html/libxml-chvalid.html
@@ -1,238 +1,122 @@
-chvalid
PrevUpHomeGnome XML Library Reference ManualNext
chvalid
chvalid — 
Synopsis
+
+
+Module chvalid from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module chvalid from libxml2
Main Menu
Related links
Table of Contents
#define xmlIsPubidChar_ch
 
+
int	xmlIsBlank	(unsigned int ch)

+
Structure xmlChLRange
struct _xmlChLRange {
+    unsigned int	low
+    unsigned int	high
+}

#define xmlIsIdeographicQ
 
+
int	xmlCharInRange	(unsigned int val, 
				 const xmlChRangeGroupPtr rptr)

+
#define xmlIsBaseCharQ
 
-struct      xmlChSRange;
-typedef     xmlChSRangePtr;
-struct      xmlChLRange;
-typedef     xmlChLRangePtr;
-struct      xmlChRangeGroup;
-typedef     xmlChRangeGroupPtr;
-int         xmlCharInRange                  (unsigned int val,
-                                             const xmlChRangeGroupPtr group);
-#define     xmlIsBaseChar_ch                (c)
-#define     xmlIsBaseCharQ                  (c)
-extern      xmlChRangeGroup xmlIsBaseCharGroup;
-#define     xmlIsBlank_ch                   (c)
-#define     xmlIsBlankQ                     (c)
-#define     xmlIsChar_ch                    (c)
-#define     xmlIsCharQ                      (c)
-extern      xmlChRangeGroup xmlIsCharGroup;
-#define     xmlIsCombiningQ                 (c)
-extern      xmlChRangeGroup xmlIsCombiningGroup;
-#define     xmlIsDigit_ch                   (c)
-#define     xmlIsDigitQ                     (c)
-extern      xmlChRangeGroup xmlIsDigitGroup;
-#define     xmlIsExtender_ch                (c)
-#define     xmlIsExtenderQ                  (c)
-extern      xmlChRangeGroup xmlIsExtenderGroup;
-#define     xmlIsIdeographicQ               (c)
-extern      xmlChRangeGroup xmlIsIdeographicGroup;
-#define     xmlIsPubidChar_ch               (c)
-#define     xmlIsPubidCharQ                 (c)
-int         xmlIsBaseChar                   (unsigned int ch);
-int         xmlIsBlank                      (unsigned int ch);
-int         xmlIsChar                       (unsigned int ch);
-int         xmlIsCombining                  (unsigned int ch);
-int         xmlIsDigit                      (unsigned int ch);
-int         xmlIsExtender                   (unsigned int ch);
-int         xmlIsIdeographic                (unsigned int ch);
-int         xmlIsPubidChar                  (unsigned int ch);
-
Description

+
#define xmlIsDigitQ
 
-
Details
struct xmlChSRange
struct xmlChSRange {
+
Variable xmlChRangeGroup xmlIsExtenderGroup
 
-    unsigned short	low;
-    unsigned short	high;
-};
-

+
#define xmlIsBaseChar_ch
 
-
xmlChSRangePtr
typedef xmlChSRange *xmlChSRangePtr;
-

+
#define xmlIsPubidCharQ
 
-
struct xmlChLRange
struct xmlChLRange {
+
int	xmlIsCombining	(unsigned int ch)

+
int	xmlIsIdeographic	(unsigned int ch)

+
Typedef xmlChLRange * xmlChLRangePtr
 
-    unsigned int	low;
-    unsigned int	high;
-};
-

+
#define xmlIsCharQ
 
-
xmlChLRangePtr
typedef xmlChLRange *xmlChLRangePtr;
-

+
Structure xmlChRangeGroup
struct _xmlChRangeGroup {
+    int	nbShortRange
+    int	nbLongRange
+    xmlChSRangePtr	shortRange	: points to an array of ranges
+    xmlChLRangePtr	longRange
+}

#define xmlIsChar_ch
 
-
struct xmlChRangeGroup
struct xmlChRangeGroup {
+
int	xmlIsExtender	(unsigned int ch)

+
Variable xmlChRangeGroup xmlIsDigitGroup
 
-    int			nbShortRange;
-    int			nbLongRange;
-    xmlChSRangePtr	shortRange;	/* points to an array of ranges */
-    xmlChLRangePtr	longRange;
-};
-

+
int	xmlIsChar	(unsigned int ch)

+
Variable xmlChRangeGroup xmlIsBaseCharGroup
 
-
xmlChRangeGroupPtr
typedef xmlChRangeGroup *xmlChRangeGroupPtr;
-

+
int	xmlIsDigit	(unsigned int ch)

+
#define xmlIsExtender_ch
 
-
xmlCharInRange ()
int         xmlCharInRange                  (unsigned int val,
-                                             const xmlChRangeGroupPtr group);

-Does a binary search of the range table to determine if char
-is valid

+
int	xmlIsPubidChar	(unsigned int ch)

+
Typedef xmlChSRange * xmlChSRangePtr
 
-
val: character to be validated
-
group:
-
Returns : true if character valid, false otherwise
-
xmlIsBaseChar_ch()
#define     xmlIsBaseChar_ch(c)

-Automatically generated by genChRanges.py

+
#define xmlIsExtenderQ
 
-
c: char to validate
-
xmlIsBaseCharQ()
#define     xmlIsBaseCharQ(c)

-Automatically generated by genChRanges.py

+
Variable xmlChRangeGroup xmlIsIdeographicGroup
 
-
c: char to validate
-
xmlIsBaseCharGroup
extern xmlChRangeGroup xmlIsBaseCharGroup;
-

+
#define xmlIsCombiningQ
 
-
xmlIsBlank_ch()
#define     xmlIsBlank_ch(c)

-Automatically generated by genChRanges.py

+
#define xmlIsDigit_ch
 
-
c: char to validate
-
xmlIsBlankQ()
#define     xmlIsBlankQ(c)

-Automatically generated by genChRanges.py

+
Typedef xmlChRangeGroup * xmlChRangeGroupPtr
 
-
c: char to validate
-
xmlIsChar_ch()
#define     xmlIsChar_ch(c)

-Automatically generated by genChRanges.py

+
Structure xmlChSRange
struct _xmlChSRange {
+    unsigned short	low
+    unsigned short	high
+}

Variable unsigned charxmlIsPubidChar_tab[256] xmlIsPubidChar_tab
 
-
c: char to validate
-
xmlIsCharQ()
#define     xmlIsCharQ(c)

-Automatically generated by genChRanges.py

+
Variable xmlChRangeGroup xmlIsCharGroup
 
-
c: char to validate
-
xmlIsCharGroup
extern xmlChRangeGroup xmlIsCharGroup;
-

+
#define xmlIsBlankQ
 
-
xmlIsCombiningQ()
#define     xmlIsCombiningQ(c)

-Automatically generated by genChRanges.py

+
#define xmlIsBlank_ch
 
-
c: char to validate
-
xmlIsCombiningGroup
extern xmlChRangeGroup xmlIsCombiningGroup;
-

+
Variable xmlChRangeGroup xmlIsCombiningGroup
 
-
xmlIsDigit_ch()
#define xmlIsDigit_ch(c)	(((0x30 <= (c)) && ((c) <= 0x39)))
-

-Automatically generated by genChRanges.py

+
int	xmlIsBaseChar	(unsigned int ch)

+
Description

+
Macro: xmlIsPubidChar_ch
#define xmlIsPubidChar_ch
Automatically generated by genChRanges.py

+
Function: xmlIsBlank
int	xmlIsBlank	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsBlank_ch or xmlIsBlankQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise

+      
+      
+    
Macro: xmlIsIdeographicQ
#define xmlIsIdeographicQ
Automatically generated by genChRanges.py

+
Function: xmlCharInRange
int	xmlCharInRange	(unsigned int val, 
				 const xmlChRangeGroupPtr rptr)

+
Does a binary search of the range table to determine if char is valid

+
val:character to be validated
rptr:pointer to range to be used to validate
Returns:true if character valid, false otherwise
Macro: xmlIsBaseCharQ
#define xmlIsBaseCharQ
Automatically generated by genChRanges.py

+
Macro: xmlIsDigitQ
#define xmlIsDigitQ
Automatically generated by genChRanges.py

+
Macro: xmlIsBaseChar_ch
#define xmlIsBaseChar_ch
Automatically generated by genChRanges.py

+
Macro: xmlIsPubidCharQ
#define xmlIsPubidCharQ
Automatically generated by genChRanges.py

+
Function: xmlIsCombining
int	xmlIsCombining	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsCombining_ch or xmlIsCombiningQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
Function: xmlIsIdeographic
int	xmlIsIdeographic	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsIdeographic_ch or xmlIsIdeographicQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
Macro: xmlIsCharQ
#define xmlIsCharQ
Automatically generated by genChRanges.py

 
-
c: char to validate
-
xmlIsDigitQ()
#define     xmlIsDigitQ(c)

-Automatically generated by genChRanges.py

+      
+      
+      
+      
+    
Macro: xmlIsChar_ch
#define xmlIsChar_ch
Automatically generated by genChRanges.py

+
Function: xmlIsExtender
int	xmlIsExtender	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsExtender_ch or xmlIsExtenderQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
Function: xmlIsChar
int	xmlIsChar	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsChar_ch or xmlIsCharQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
Function: xmlIsDigit
int	xmlIsDigit	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsDigit_ch or xmlIsDigitQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
Macro: xmlIsExtender_ch
#define xmlIsExtender_ch
Automatically generated by genChRanges.py

+
Function: xmlIsPubidChar
int	xmlIsPubidChar	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsPubidChar_ch or xmlIsPubidCharQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
Macro: xmlIsExtenderQ
#define xmlIsExtenderQ
Automatically generated by genChRanges.py

+
Macro: xmlIsCombiningQ
#define xmlIsCombiningQ
Automatically generated by genChRanges.py

+
Macro: xmlIsDigit_ch
#define xmlIsDigit_ch
Automatically generated by genChRanges.py

 
-
c: char to validate
-
xmlIsDigitGroup
extern xmlChRangeGroup xmlIsDigitGroup;
-

-
-
xmlIsExtender_ch()
#define xmlIsExtender_ch(c)	(((c) == 0xb7))
-

-Automatically generated by genChRanges.py

-
-
c: char to validate
-
xmlIsExtenderQ()
#define     xmlIsExtenderQ(c)

-Automatically generated by genChRanges.py

-
-
c: char to validate
-
xmlIsExtenderGroup
extern xmlChRangeGroup xmlIsExtenderGroup;
-

-
-
xmlIsIdeographicQ()
#define     xmlIsIdeographicQ(c)

-Automatically generated by genChRanges.py

-
-
c: char to validate
-
xmlIsIdeographicGroup
extern xmlChRangeGroup xmlIsIdeographicGroup;
-

-
-
xmlIsPubidChar_ch()
#define xmlIsPubidChar_ch(c)	(xmlIsPubidChar_tab[(c)])
-

-Automatically generated by genChRanges.py

-
-
c: char to validate
-
xmlIsPubidCharQ()
#define     xmlIsPubidCharQ(c)

-Automatically generated by genChRanges.py

-
-
c: char to validate
-
xmlIsBaseChar ()
int         xmlIsBaseChar                   (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsBaseChar_ch
-or xmlIsBaseCharQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
xmlIsBlank ()
int         xmlIsBlank                      (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsBlank_ch
-or xmlIsBlankQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
xmlIsChar ()
int         xmlIsChar                       (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsChar_ch
-or xmlIsCharQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
xmlIsCombining ()
int         xmlIsCombining                  (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsCombining_ch
-or xmlIsCombiningQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
xmlIsDigit ()
int         xmlIsDigit                      (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsDigit_ch
-or xmlIsDigitQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
xmlIsExtender ()
int         xmlIsExtender                   (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsExtender_ch
-or xmlIsExtenderQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
xmlIsIdeographic ()
int         xmlIsIdeographic                (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsIdeographic_ch
-or xmlIsIdeographicQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
xmlIsPubidChar ()
int         xmlIsPubidChar                  (unsigned int ch);

-This function is DEPRECATED.  Use xmlIsPubidChar_ch
-or xmlIsPubidCharQ instead

-
-
ch:  character to validate
-
Returns :true if argument valid, false otherwise
-
<< SAXuri >>

+      
+      
+    
Macro: xmlIsBlankQ
#define xmlIsBlankQ
Automatically generated by genChRanges.py

+
Macro: xmlIsBlank_ch
#define xmlIsBlank_ch
Automatically generated by genChRanges.py

+
Function: xmlIsBaseChar
int	xmlIsBaseChar	(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsBaseChar_ch or xmlIsBaseCharQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
Daniel Veillard

diff --git a/doc/html/libxml-debugXML.html b/doc/html/libxml-debugXML.html
index 23dfa7b3..f698512f 100644
--- a/doc/html/libxml-debugXML.html
+++ b/doc/html/libxml-debugXML.html
@@ -1,391 +1,127 @@
-debugXML
PrevUpHomeGnome XML Library Reference ManualNext
debugXML
debugXML — 
Synopsis
+
+
+Module debugXML from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module debugXML from libxml2
Main Menu
Related links
Table of Contents
int	xmlShellWrite	(xmlShellCtxtPtr ctxt, 
				 char * filename, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
void	xmlDebugDumpEntities	(FILE * output, 
				 xmlDocPtr doc)

+
Structure xmlShellCtxt
struct _xmlShellCtxt {
+    char *	filename
+    xmlDocPtr	doc
+    xmlNodePtr	node
+    xmlXPathContextPtr	pctxt
+    int	loaded
+    FILE *	output
+    xmlShellReadlineFunc	input
+}

void	xmlDebugDumpDTD	(FILE * output, 
				 xmlDtdPtr dtd)

+
void	xmlDebugDumpNode	(FILE * output, 
				 xmlNodePtr node, 
				 int depth)

+
void	xmlDebugDumpAttrList	(FILE * output, 
				 xmlAttrPtr attr, 
				 int depth)

+
void	xmlShellPrintNode	(xmlNodePtr node)

+
void	xmlLsOneNode	(FILE * output, 
				 xmlNodePtr node)

+
Function type: xmlShellReadlineFunc
+char *	xmlShellReadlineFunc	(char * prompt)
+
This is a generic signature for the XML shell input function.
prompt:a string prompt
Returns:a string which will be freed by the Shell.


+
int	xmlShellSave	(xmlShellCtxtPtr ctxt, 
				 char * filename, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
int	xmlShellPwd	(xmlShellCtxtPtr ctxt, 
				 char * buffer, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
const char *	xmlBoolToText	(int boolval)

+
int	xmlShellBase	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
void	xmlDebugDumpString	(FILE * output, 
				 const xmlChar * str)

+
void	xmlDebugDumpAttr	(FILE * output, 
				 xmlAttrPtr attr, 
				 int depth)

+
int	xmlShellDu	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr tree, 
				 xmlNodePtr node2)

+
void	xmlDebugDumpNodeList	(FILE * output, 
				 xmlNodePtr node, 
				 int depth)

+
void	xmlDebugDumpDocument	(FILE * output, 
				 xmlDocPtr doc)

+
int	xmlShellCat	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
int	xmlShellDir	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
int	xmlLsCountNode	(xmlNodePtr node)

+
int	xmlShellValidate	(xmlShellCtxtPtr ctxt, 
				 char * dtd, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
void	xmlShellPrintXPathError	(int errorType, 
				 const char * arg)

+
Typedef xmlShellCtxt * xmlShellCtxtPtr
 
-
-
-void        xmlDebugDumpString              (FILE *output,
-                                             const xmlChar *str);
-void        xmlDebugDumpAttr                (FILE *output,
-                                             xmlAttrPtr attr,
-                                             int depth);
-void        xmlDebugDumpAttrList            (FILE *output,
-                                             xmlAttrPtr attr,
-                                             int depth);
-void        xmlDebugDumpOneNode             (FILE *output,
-                                             xmlNodePtr node,
-                                             int depth);
-void        xmlDebugDumpNode                (FILE *output,
-                                             xmlNodePtr node,
-                                             int depth);
-void        xmlDebugDumpNodeList            (FILE *output,
-                                             xmlNodePtr node,
-                                             int depth);
-void        xmlDebugDumpDocumentHead        (FILE *output,
-                                             xmlDocPtr doc);
-void        xmlDebugDumpDocument            (FILE *output,
-                                             xmlDocPtr doc);
-void        xmlDebugDumpDTD                 (FILE *output,
-                                             xmlDtdPtr dtd);
-void        xmlDebugDumpEntities            (FILE *output,
-                                             xmlDocPtr doc);
-void        xmlLsOneNode                    (FILE *output,
-                                             xmlNodePtr node);
-int         xmlLsCountNode                  (xmlNodePtr node);
-const char* xmlBoolToText                   (int boolval);
-char*       (*xmlShellReadlineFunc)         (char *prompt);
-struct      xmlShellCtxt;
-typedef     xmlShellCtxtPtr;
-int         (*xmlShellCmd)                  (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-void        xmlShellPrintXPathError         (int errorType,
-                                             const char *arg);
-void        xmlShellPrintNode               (xmlNodePtr node);
-void        xmlShellPrintXPathResult        (xmlXPathObjectPtr list);
-int         xmlShellList                    (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellBase                    (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellDir                     (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellCat                     (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellLoad                    (xmlShellCtxtPtr ctxt,
-                                             char *filename,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellWrite                   (xmlShellCtxtPtr ctxt,
-                                             char *filename,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellSave                    (xmlShellCtxtPtr ctxt,
-                                             char *filename,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellValidate                (xmlShellCtxtPtr ctxt,
-                                             char *dtd,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-int         xmlShellDu                      (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr tree,
-                                             xmlNodePtr node2);
-int         xmlShellPwd                     (xmlShellCtxtPtr ctxt,
-                                             char *buffer,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);
-void        xmlShell                        (xmlDocPtr doc,
-                                             char *filename,
-                                             xmlShellReadlineFunc input,
-                                             FILE *output);
-
Description

-
-
Details
xmlDebugDumpString ()
void        xmlDebugDumpString              (FILE *output,
-                                             const xmlChar *str);

-Dumps informations about the string, shorten it if necessary

-
-
output:  the FILE * for the output
-
str:  the string
-
xmlDebugDumpAttr ()
void        xmlDebugDumpAttr                (FILE *output,
-                                             xmlAttrPtr attr,
-                                             int depth);

-Dumps debug information for the attribute

-
-
output:  the FILE * for the output
-
attr:  the attribute
-
depth:  the indentation level.
-
xmlDebugDumpAttrList ()
void        xmlDebugDumpAttrList            (FILE *output,
-                                             xmlAttrPtr attr,
-                                             int depth);

-Dumps debug information for the attribute list

-
-
output:  the FILE * for the output
-
attr:  the attribute list
-
depth:  the indentation level.
-
xmlDebugDumpOneNode ()
void        xmlDebugDumpOneNode             (FILE *output,
-                                             xmlNodePtr node,
-                                             int depth);

-Dumps debug information for the element node, it is not recursive

-
-
output:  the FILE * for the output
-
node:  the node
-
depth:  the indentation level.
-
xmlDebugDumpNode ()
void        xmlDebugDumpNode                (FILE *output,
-                                             xmlNodePtr node,
-                                             int depth);

-Dumps debug information for the element node, it is recursive

-
-
output:  the FILE * for the output
-
node:  the node
-
depth:  the indentation level.
-
xmlDebugDumpNodeList ()
void        xmlDebugDumpNodeList            (FILE *output,
-                                             xmlNodePtr node,
-                                             int depth);

-Dumps debug information for the list of element node, it is recursive

-
-
output:  the FILE * for the output
-
node:  the node list
-
depth:  the indentation level.
-
xmlDebugDumpDocumentHead ()
void        xmlDebugDumpDocumentHead        (FILE *output,
-                                             xmlDocPtr doc);

-Dumps debug information cncerning the document, not recursive

-
-
output:  the FILE * for the output
-
doc:  the document
-
xmlDebugDumpDocument ()
void        xmlDebugDumpDocument            (FILE *output,
-                                             xmlDocPtr doc);

-Dumps debug information for the document, it's recursive

-
-
output:  the FILE * for the output
-
doc:  the document
-
xmlDebugDumpDTD ()
void        xmlDebugDumpDTD                 (FILE *output,
-                                             xmlDtdPtr dtd);

-Dumps debug information for the DTD

-
-
output:  the FILE * for the output
-
dtd:  the DTD
-
xmlDebugDumpEntities ()
void        xmlDebugDumpEntities            (FILE *output,
-                                             xmlDocPtr doc);

-Dumps debug information for all the entities in use by the document

-
-
output:  the FILE * for the output
-
doc:  the document
-
xmlLsOneNode ()
void        xmlLsOneNode                    (FILE *output,
-                                             xmlNodePtr node);

-Dump to output the type and name of node.

-
-
output:  the FILE * for the output
-
node:  the node to dump
-
xmlLsCountNode ()
int         xmlLsCountNode                  (xmlNodePtr node);

-Count the children of node.

-
-
node:  the node to count
-
Returns :the number of children of node.
-
xmlBoolToText ()
const char* xmlBoolToText                   (int boolval);

-Convenient way to turn bool into text

-
-
boolval: a bool to turn into text
-
Returns :a pointer to either "True" or "False"
-
xmlShellReadlineFunc ()
char*       (*xmlShellReadlineFunc)         (char *prompt);

-This is a generic signature for the XML shell input function.

-
-
prompt:  a string prompt
-
Returns :a string which will be freed by the Shell.
-
struct xmlShellCtxt
struct xmlShellCtxt {
-
-    char *filename;
-    xmlDocPtr doc;
-    xmlNodePtr node;
-    xmlXPathContextPtr pctxt;
-    int loaded;
-    FILE *output;
-    xmlShellReadlineFunc input;
-};
-

-A debugging shell context.
-TODO: add the defined function tables.

-
-
xmlShellCtxtPtr
typedef xmlShellCtxt *xmlShellCtxtPtr;
-

-
-
xmlShellCmd ()
int         (*xmlShellCmd)                  (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-This is a generic signature for the XML shell functions.

-
-
ctxt:  a shell context
-
arg:  a string argument
-
node:  a first node
-
node2:  a second node
-
Returns :an int, negative returns indicating errors.
-
xmlShellPrintXPathError ()
void        xmlShellPrintXPathError         (int errorType,
-                                             const char *arg);

-Print the xpath error to libxml default error channel

-
-
errorType: valid xpath error id
-
arg: the argument that cause xpath to fail
-
xmlShellPrintNode ()
void        xmlShellPrintNode               (xmlNodePtr node);

-Print node to the output FILE

-
-
node: a non-null node to print to the output FILE
-
xmlShellPrintXPathResult ()
void        xmlShellPrintXPathResult        (xmlXPathObjectPtr list);

-Prints result to the output FILE

-
-
list: a valid result generated by an xpath evaluation
-
xmlShellList ()
int         xmlShellList                    (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "ls"
-Does an Unix like listing of the given node (like a directory)

-
-
ctxt:  the shell context
-
arg:  unused
-
node:  a node
-
node2:  unused
-
Returns :0
-
xmlShellBase ()
int         xmlShellBase                    (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "base"
-dumps the current XML base of the node

-
-
ctxt:  the shell context
-
arg:  unused
-
node:  a node
-
node2:  unused
-
Returns :0
-
xmlShellDir ()
int         xmlShellDir                     (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "dir"
-dumps informations about the node (namespace, attributes, content).

-
-
ctxt:  the shell context
-
arg:  unused
-
node:  a node
-
node2:  unused
-
Returns :0
-
xmlShellCat ()
int         xmlShellCat                     (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "cat"
-dumps the serialization node content (XML or HTML).

-
-
ctxt:  the shell context
-
arg:  unused
-
node:  a node
-
node2:  unused
-
Returns :0
-
xmlShellLoad ()
int         xmlShellLoad                    (xmlShellCtxtPtr ctxt,
-                                             char *filename,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "load"
-loads a new document specified by the filename

-
-
ctxt:  the shell context
-
filename:  the file name
-
node:  unused
-
node2:  unused
-
Returns :0 or -1 if loading failed
-
xmlShellWrite ()
int         xmlShellWrite                   (xmlShellCtxtPtr ctxt,
-                                             char *filename,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "write"
-Write the current node to the filename, it saves the serialization
-of the subtree under the node specified

-
-
ctxt:  the shell context
-
filename:  the file name
-
node:  a node in the tree
-
node2:  unused
-
Returns :0 or -1 in case of error
-
xmlShellSave ()
int         xmlShellSave                    (xmlShellCtxtPtr ctxt,
-                                             char *filename,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "save"
-Write the current document to the filename, or it's original name

-
-
ctxt:  the shell context
-
filename:  the file name (optional)
-
node:  unused
-
node2:  unused
-
Returns :0 or -1 in case of error
-
xmlShellValidate ()
int         xmlShellValidate                (xmlShellCtxtPtr ctxt,
-                                             char *dtd,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "validate"
-Validate the document, if a DTD path is provided, then the validation
-is done against the given DTD.

-
-
ctxt:  the shell context
-
dtd:  the DTD URI (optional)
-
node:  unused
-
node2:  unused
-
Returns :0 or -1 in case of error
-
xmlShellDu ()
int         xmlShellDu                      (xmlShellCtxtPtr ctxt,
-                                             char *arg,
-                                             xmlNodePtr tree,
-                                             xmlNodePtr node2);

-Implements the XML shell function "du"
-show the structure of the subtree under node tree
-If tree is null, the command works on the current node.

-
-
ctxt:  the shell context
-
arg:  unused
-
tree:  a node defining a subtree
-
node2:  unused
-
Returns :0 or -1 in case of error
-
xmlShellPwd ()
int         xmlShellPwd                     (xmlShellCtxtPtr ctxt,
-                                             char *buffer,
-                                             xmlNodePtr node,
-                                             xmlNodePtr node2);

-Implements the XML shell function "pwd"
-Show the full path from the root to the node, if needed building
-thumblers when similar elements exists at a given ancestor level.
-The output is compatible with XPath commands.

-
-
ctxt:  the shell context
-
buffer:  the output buffer
-
node:  a node 
-
node2:  unused
-
Returns :0 or -1 in case of error
-
xmlShell ()
void        xmlShell                        (xmlDocPtr doc,
-                                             char *filename,
-                                             xmlShellReadlineFunc input,
-                                             FILE *output);

-Implements the XML shell 
-This allow to load, validate, view, modify and save a document
-using a environment similar to a UNIX commandline.

-
-
doc:  the initial document
-
filename:  the output buffer
-
input:  the line reading function
-
output:  the output FILE*, defaults to stdout if NULL
-
<< xmlreaderxmlwriter >>

+
void	xmlShellPrintXPathResult	(xmlXPathObjectPtr list)

+
void	xmlDebugDumpOneNode	(FILE * output, 
				 xmlNodePtr node, 
				 int depth)

+
Function type: xmlShellCmd
+int	xmlShellCmd	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)
+
This is a generic signature for the XML shell functions.
ctxt:a shell context
arg:a string argument
node:a first node
node2:a second node
Returns:an int, negative returns indicating errors.


+
int	xmlShellLoad	(xmlShellCtxtPtr ctxt, 
				 char * filename, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
int	xmlShellList	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
void	xmlDebugDumpDocumentHead	(FILE * output, 
				 xmlDocPtr doc)

+
void	xmlShell	(xmlDocPtr doc, 
				 char * filename, 
				 xmlShellReadlineFunc input, 
				 FILE * output)

+
Description

+
Function: xmlShellWrite
int	xmlShellWrite	(xmlShellCtxtPtr ctxt, 
				 char * filename, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "write" Write the current node to the filename, it saves the serialization of the subtree under the @node specified

+
ctxt:the shell context
filename:the file name
node:a node in the tree
node2:unused
Returns:0 or -1 in case of error
Function: xmlDebugDumpEntities
void	xmlDebugDumpEntities	(FILE * output, 
				 xmlDocPtr doc)

+
Dumps debug information for all the entities in use by the document

+
output:the FILE * for the output
doc:the document

+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlDebugDumpDTD
void	xmlDebugDumpDTD	(FILE * output, 
				 xmlDtdPtr dtd)

+
Dumps debug information for the DTD

+
output:the FILE * for the output
dtd:the DTD
Function: xmlDebugDumpNode
void	xmlDebugDumpNode	(FILE * output, 
				 xmlNodePtr node, 
				 int depth)

+
Dumps debug information for the element node, it is recursive

+
output:the FILE * for the output
node:the node
depth:the indentation level.
Function: xmlDebugDumpAttrList
void	xmlDebugDumpAttrList	(FILE * output, 
				 xmlAttrPtr attr, 
				 int depth)

+
Dumps debug information for the attribute list

+
output:the FILE * for the output
attr:the attribute list
depth:the indentation level.
Function: xmlShellPrintNode
void	xmlShellPrintNode	(xmlNodePtr node)

+
Print node to the output FILE

+
node:a non-null node to print to the output FILE
Function: xmlLsOneNode
void	xmlLsOneNode	(FILE * output, 
				 xmlNodePtr node)

+
Dump to @output the type and name of @node.

+
output:the FILE * for the output
node:the node to dump

+      This is a generic signature for the XML shell input function.
+      
+      
+    
Function: xmlShellSave
int	xmlShellSave	(xmlShellCtxtPtr ctxt, 
				 char * filename, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "save" Write the current document to the filename, or it's original name

+
ctxt:the shell context
filename:the file name (optional)
node:unused
node2:unused
Returns:0 or -1 in case of error
Function: xmlShellPwd
int	xmlShellPwd	(xmlShellCtxtPtr ctxt, 
				 char * buffer, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "pwd" Show the full path from the root to the node, if needed building thumblers when similar elements exists at a given ancestor level. The output is compatible with XPath commands.

+
ctxt:the shell context
buffer:the output buffer
node:a node
node2:unused
Returns:0 or -1 in case of error
Function: xmlBoolToText
const char *	xmlBoolToText	(int boolval)

+
Convenient way to turn bool into text

+
boolval:a bool to turn into text
Returns:a pointer to either "True" or "False"
Function: xmlShellBase
int	xmlShellBase	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "base" dumps the current XML base of the node

+
ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0
Function: xmlDebugDumpString
void	xmlDebugDumpString	(FILE * output, 
				 const xmlChar * str)

+
Dumps informations about the string, shorten it if necessary

+
output:the FILE * for the output
str:the string
Function: xmlDebugDumpAttr
void	xmlDebugDumpAttr	(FILE * output, 
				 xmlAttrPtr attr, 
				 int depth)

+
Dumps debug information for the attribute

+
output:the FILE * for the output
attr:the attribute
depth:the indentation level.
Function: xmlShellDu
int	xmlShellDu	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr tree, 
				 xmlNodePtr node2)

+
Implements the XML shell function "du" show the structure of the subtree under node @tree If @tree is null, the command works on the current node.

+
ctxt:the shell context
arg:unused
tree:a node defining a subtree
node2:unused
Returns:0 or -1 in case of error
Function: xmlDebugDumpNodeList
void	xmlDebugDumpNodeList	(FILE * output, 
				 xmlNodePtr node, 
				 int depth)

+
Dumps debug information for the list of element node, it is recursive

+
output:the FILE * for the output
node:the node list
depth:the indentation level.
Function: xmlDebugDumpDocument
void	xmlDebugDumpDocument	(FILE * output, 
				 xmlDocPtr doc)

+
Dumps debug information for the document, it's recursive

+
output:the FILE * for the output
doc:the document
Function: xmlShellCat
int	xmlShellCat	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "cat" dumps the serialization node content (XML or HTML).

+
ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0
Function: xmlShellDir
int	xmlShellDir	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "dir" dumps informations about the node (namespace, attributes, content).

+
ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0
Function: xmlLsCountNode
int	xmlLsCountNode	(xmlNodePtr node)

+
Count the children of @node.

+
node:the node to count
Returns:the number of children of @node.
Function: xmlShellValidate
int	xmlShellValidate	(xmlShellCtxtPtr ctxt, 
				 char * dtd, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "validate" Validate the document, if a DTD path is provided, then the validation is done against the given DTD.

+
ctxt:the shell context
dtd:the DTD URI (optional)
node:unused
node2:unused
Returns:0 or -1 in case of error
Function: xmlShellPrintXPathError
void	xmlShellPrintXPathError	(int errorType, 
				 const char * arg)

+
Print the xpath error to libxml default error channel

+
errorType:valid xpath error id
arg:the argument that cause xpath to fail
Function: xmlShellPrintXPathResult
void	xmlShellPrintXPathResult	(xmlXPathObjectPtr list)

+
Prints result to the output FILE

+
list:a valid result generated by an xpath evaluation
Function: xmlDebugDumpOneNode
void	xmlDebugDumpOneNode	(FILE * output, 
				 xmlNodePtr node, 
				 int depth)

+
Dumps debug information for the element node, it is not recursive

+
output:the FILE * for the output
node:the node
depth:the indentation level.

+      This is a generic signature for the XML shell functions.
+      
+      
+      
+      
+      
+    
Function: xmlShellLoad
int	xmlShellLoad	(xmlShellCtxtPtr ctxt, 
				 char * filename, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "load" loads a new document specified by the filename

+
ctxt:the shell context
filename:the file name
node:unused
node2:unused
Returns:0 or -1 if loading failed
Function: xmlShellList
int	xmlShellList	(xmlShellCtxtPtr ctxt, 
				 char * arg, 
				 xmlNodePtr node, 
				 xmlNodePtr node2)

+
Implements the XML shell function "ls" Does an Unix like listing of the given node (like a directory)

+
ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0
Function: xmlDebugDumpDocumentHead
void	xmlDebugDumpDocumentHead	(FILE * output, 
				 xmlDocPtr doc)

+
Dumps debug information cncerning the document, not recursive

+
output:the FILE * for the output
doc:the document
Function: xmlShell
void	xmlShell	(xmlDocPtr doc, 
				 char * filename, 
				 xmlShellReadlineFunc input, 
				 FILE * output)

+
Implements the XML shell This allow to load, validate, view, modify and save a document using a environment similar to a UNIX commandline.

+
doc:the initial document
filename:the output buffer
input:the line reading function
output:the output FILE*, defaults to stdout if NULL
Daniel Veillard

diff --git a/doc/html/libxml-dict.html b/doc/html/libxml-dict.html
index b67319e2..4dea706b 100644
--- a/doc/html/libxml-dict.html
+++ b/doc/html/libxml-dict.html
@@ -1,102 +1,36 @@
-dict
PrevUpHomeGnome XML Library Reference ManualNext
dict
dict — 
Synopsis
+
+
+Module dict from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module dict from libxml2
Main Menu
Related links
Table of Contents
const xmlChar *	xmlDictQLookup	(xmlDictPtr dict, 
				 const xmlChar * prefix, 
				 const xmlChar * name)

+
Typedef xmlDict * xmlDictPtr
 
-
-
-struct      xmlDict;
-typedef     xmlDictPtr;
-xmlDictPtr  xmlDictCreate                   (void);
-int         xmlDictReference                (xmlDictPtr dict);
-void        xmlDictFree                     (xmlDictPtr dict);
-const xmlChar* xmlDictLookup                (xmlDictPtr dict,
-                                             const xmlChar *name,
-                                             int len);
-const xmlChar* xmlDictQLookup               (xmlDictPtr dict,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name);
-int         xmlDictOwns                     (xmlDictPtr dict,
-                                             const xmlChar *str);
-int         xmlDictSize                     (xmlDictPtr dict);
-
Description

-
-
Details
struct xmlDict
struct xmlDict;

-
-
xmlDictPtr
typedef xmlDict *xmlDictPtr;
-

-
-
xmlDictCreate ()
xmlDictPtr  xmlDictCreate                   (void);

-Create a new dictionary

-
-
Returns :the newly created object, or NULL if an error occured.
-
xmlDictReference ()
int         xmlDictReference                (xmlDictPtr dict);

-Increment the reference counter of a dictionary

-
-
dict: the dictionnary
-
Returns :0 in case of success and -1 in case of error
-
xmlDictFree ()
void        xmlDictFree                     (xmlDictPtr dict);

-Free the hash dict and its contents. The userdata is
-deallocated with f if provided.

-
-
dict: the dictionnary
-
xmlDictLookup ()
const xmlChar* xmlDictLookup                (xmlDictPtr dict,
-                                             const xmlChar *name,
-                                             int len);

-Add the name to the hash dict if not present.

-
-
dict: the dictionnary
-
name: the name of the userdata
-
len: the length of the name, if -1 it is recomputed
-
Returns :the internal copy of the name or NULL in case of internal error
-
xmlDictQLookup ()
const xmlChar* xmlDictQLookup               (xmlDictPtr dict,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name);

-Add the QName prefix:name to the hash dict if not present.

-
-
dict: the dictionnary
-
prefix: the prefix 
-
name: the name
-
Returns :the internal copy of the QName or NULL in case of internal error
-
xmlDictOwns ()
int         xmlDictOwns                     (xmlDictPtr dict,
-                                             const xmlChar *str);

-check if a string is owned by the disctionary

-
-
dict: the dictionnary
-
str: the string
-
Returns :1 if true, 0 if false and -1 in case of error
--1 in case of error
-
xmlDictSize ()
int         xmlDictSize                     (xmlDictPtr dict);

-Query the number of elements installed in the hash dict.

-
-
dict: the dictionnary
-
Returns :the number of elements in the dictionnary or
--1 in case of error
-
<< DOCBparserxmlautomata >>

+
int	xmlDictReference	(xmlDictPtr dict)

+
int	xmlDictSize	(xmlDictPtr dict)

+
Structure xmlDict
struct _xmlDict {
+The content of this structure is not made public by the API.
+}

xmlDictPtr	xmlDictCreate	(void)

+
const xmlChar *	xmlDictLookup	(xmlDictPtr dict, 
				 const xmlChar * name, 
				 int len)

+
void	xmlDictFree	(xmlDictPtr dict)

+
int	xmlDictOwns	(xmlDictPtr dict, 
				 const xmlChar * str)

+
Description

+
Function: xmlDictQLookup
const xmlChar *	xmlDictQLookup	(xmlDictPtr dict, 
				 const xmlChar * prefix, 
				 const xmlChar * name)

+
Add the QName @prefix:@name to the hash @dict if not present.

+
dict:the dictionnary
prefix:the prefix
name:the name
Returns:the internal copy of the QName or NULL in case of internal error
Function: xmlDictReference
int	xmlDictReference	(xmlDictPtr dict)

+
Increment the reference counter of a dictionary

+
dict:the dictionnary
Returns:0 in case of success and -1 in case of error
Function: xmlDictSize
int	xmlDictSize	(xmlDictPtr dict)

+
Query the number of elements installed in the hash @dict.

+
dict:the dictionnary
Returns:the number of elements in the dictionnary or -1 in case of error
Function: xmlDictCreate
xmlDictPtr	xmlDictCreate	(void)

+
Create a new dictionary

+
Returns:the newly created object, or NULL if an error occured.
Function: xmlDictLookup
const xmlChar *	xmlDictLookup	(xmlDictPtr dict, 
				 const xmlChar * name, 
				 int len)

+
Add the @name to the hash @dict if not present.

+
dict:the dictionnary
name:the name of the userdata
len:the length of the name, if -1 it is recomputed
Returns:the internal copy of the name or NULL in case of internal error
Function: xmlDictFree
void	xmlDictFree	(xmlDictPtr dict)

+
Free the hash @dict and its contents. The userdata is deallocated with @f if provided.

+
dict:the dictionnary
Function: xmlDictOwns
int	xmlDictOwns	(xmlDictPtr dict, 
				 const xmlChar * str)

+
check if a string is owned by the disctionary

+
dict:the dictionnary
str:the string
Returns:1 if true, 0 if false and -1 in case of error -1 in case of error
Daniel Veillard

diff --git a/doc/html/libxml-encoding.html b/doc/html/libxml-encoding.html
index 26e43a0f..c1f420c3 100644
--- a/doc/html/libxml-encoding.html
+++ b/doc/html/libxml-encoding.html
@@ -1,417 +1,159 @@
-encoding
PrevUpHomeGnome XML Library Reference ManualNext
encoding
encoding — 
Synopsis
+
+
+Module encoding from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module encoding from libxml2
Main Menu
Related links
Table of Contents
int	xmlDelEncodingAlias	(const char * alias)

+
const char *	xmlGetEncodingAlias	(const char * alias)

+
int	xmlUTF8Strloc	(const xmlChar * utf, 
				 const xmlChar * utfchar)

+
void	xmlCleanupCharEncodingHandlers	(void)

+
xmlCharEncodingHandlerPtr	xmlFindCharEncodingHandler	(const char * name)

+
int	xmlCharEncCloseFunc	(xmlCharEncodingHandler * handler)

+
int	xmlUTF8Size	(const xmlChar * utf)

+
xmlCharEncoding	xmlParseCharEncoding	(const char * name)

+
xmlChar *	xmlUTF8Strpos	(const xmlChar * utf, 
				 int pos)

+
Structure xmlCharEncodingHandler
struct _xmlCharEncodingHandler {
+    char *	name
+    xmlCharEncodingInputFunc	input
+    xmlCharEncodingOutputFunc	output
+    iconv_t	iconv_in
+    iconv_t	iconv_out
+}

const char *	xmlGetCharEncodingName	(xmlCharEncoding enc)

+
int	xmlCheckUTF8	(const unsigned char * utf)

+
int	UTF8Toisolat1	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)

+
int	xmlCharEncInFunc	(xmlCharEncodingHandler * handler, 
				 xmlBufferPtr out, 
				 xmlBufferPtr in)

+
int	xmlAddEncodingAlias	(const char * name, 
				 const char * alias)

+
Typedef xmlCharEncodingHandler * xmlCharEncodingHandlerPtr
 
+
int	xmlCharEncOutFunc	(xmlCharEncodingHandler * handler, 
				 xmlBufferPtr out, 
				 xmlBufferPtr in)

+
Function type: xmlCharEncodingInputFunc
+int	xmlCharEncodingInputFunc	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)
+
Take a block of chars in the original encoding and try to convert it to an UTF-8 block of chars out.
out:a pointer to an array of bytes to store the UTF-8 result
outlen:the length of @out
in:a pointer to an array of chars in the original encoding
inlen:the length of @in
Returns:the number of byte written, or -1 by lack of space, or -2 if the transcoding failed. The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictiable. The value of @outlen after return is the number of octets consumed.


+
xmlCharEncodingHandlerPtr	xmlGetCharEncodingHandler	(xmlCharEncoding enc)

+
xmlChar *	xmlUTF8Strsub	(const xmlChar * utf, 
				 int start, 
				 int len)

+
int	xmlGetUTF8Char	(const unsigned char * utf, 
				 int * len)

+
int	isolat1ToUTF8	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)

+
xmlCharEncodingHandlerPtr	xmlNewCharEncodingHandler	(const char * name, 
				 xmlCharEncodingInputFunc input, 
				 xmlCharEncodingOutputFunc output)

+
void	xmlInitCharEncodingHandlers	(void)

+
void	xmlRegisterCharEncodingHandler	(xmlCharEncodingHandlerPtr handler)

+
int	xmlCharEncFirstLine	(xmlCharEncodingHandler * handler, 
				 xmlBufferPtr out, 
				 xmlBufferPtr in)

+
Enum xmlCharEncoding {
+    XML_CHAR_ENCODING_ERROR = -1 : No char encoding detected
+    XML_CHAR_ENCODING_NONE = 0 : No char encoding detected
+    XML_CHAR_ENCODING_UTF8 = 1 : UTF-8
+    XML_CHAR_ENCODING_UTF16LE = 2 : UTF-16 little endian
+    XML_CHAR_ENCODING_UTF16BE = 3 : UTF-16 big endian
+    XML_CHAR_ENCODING_UCS4LE = 4 : UCS-4 little endian
+    XML_CHAR_ENCODING_UCS4BE = 5 : UCS-4 big endian
+    XML_CHAR_ENCODING_EBCDIC = 6 : EBCDIC uh!
+    XML_CHAR_ENCODING_UCS4_2143 = 7 : UCS-4 unusual ordering
+    XML_CHAR_ENCODING_UCS4_3412 = 8 : UCS-4 unusual ordering
+    XML_CHAR_ENCODING_UCS2 = 9 : UCS-2
+    XML_CHAR_ENCODING_8859_1 = 10 : ISO-8859-1 ISO Latin 1
+    XML_CHAR_ENCODING_8859_2 = 11 : ISO-8859-2 ISO Latin 2
+    XML_CHAR_ENCODING_8859_3 = 12 : ISO-8859-3
+    XML_CHAR_ENCODING_8859_4 = 13 : ISO-8859-4
+    XML_CHAR_ENCODING_8859_5 = 14 : ISO-8859-5
+    XML_CHAR_ENCODING_8859_6 = 15 : ISO-8859-6
+    XML_CHAR_ENCODING_8859_7 = 16 : ISO-8859-7
+    XML_CHAR_ENCODING_8859_8 = 17 : ISO-8859-8
+    XML_CHAR_ENCODING_8859_9 = 18 : ISO-8859-9
+    XML_CHAR_ENCODING_2022_JP = 19 : ISO-2022-JP
+    XML_CHAR_ENCODING_SHIFT_JIS = 20 : Shift_JIS
+    XML_CHAR_ENCODING_EUC_JP = 21 : EUC-JP
+    XML_CHAR_ENCODING_ASCII = 22 : pure ASCII
+}
 
-
-enum        xmlCharEncoding;
-int         (*xmlCharEncodingInputFunc)     (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);
-int         (*xmlCharEncodingOutputFunc)    (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);
-struct      xmlCharEncodingHandler;
-typedef     xmlCharEncodingHandlerPtr;
-void        xmlInitCharEncodingHandlers     (void);
-void        xmlCleanupCharEncodingHandlers  (void);
-void        xmlRegisterCharEncodingHandler  (xmlCharEncodingHandlerPtr handler);
-xmlCharEncodingHandlerPtr xmlGetCharEncodingHandler
-                                            (xmlCharEncoding enc);
-xmlCharEncodingHandlerPtr xmlFindCharEncodingHandler
-                                            (const char *name);
-xmlCharEncodingHandlerPtr xmlNewCharEncodingHandler
-                                            (const char *name,
-                                             xmlCharEncodingInputFunc input,
-                                             xmlCharEncodingOutputFunc output);
-int         xmlAddEncodingAlias             (const char *name,
-                                             const char *alias);
-int         xmlDelEncodingAlias             (const char *alias);
-const char* xmlGetEncodingAlias             (const char *alias);
-void        xmlCleanupEncodingAliases       (void);
-xmlCharEncoding xmlParseCharEncoding        (const char *name);
-const char* xmlGetCharEncodingName          (xmlCharEncoding enc);
-xmlCharEncoding xmlDetectCharEncoding       (unsigned char *in,
-                                             int len);
-int         xmlCharEncOutFunc               (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);
-int         xmlCharEncInFunc                (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);
-int         xmlCharEncFirstLine             (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);
-int         xmlCharEncCloseFunc             (xmlCharEncodingHandler *handler);
-int         UTF8Toisolat1                   (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);
-int         isolat1ToUTF8                   (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);
-int         xmlGetUTF8Char                  (unsigned char *utf,
-                                             int *len);
-int         xmlCheckUTF8                    (unsigned char *utf);
-int         xmlUTF8Strsize                  (const xmlChar *utf,
-                                             int len);
-xmlChar*    xmlUTF8Strndup                  (const xmlChar *utf,
-                                             int len);
-xmlChar*    xmlUTF8Strpos                   (const xmlChar *utf,
-                                             int pos);
-int         xmlUTF8Strloc                   (const xmlChar *utf,
-                                             const xmlChar *utfchar);
-xmlChar*    xmlUTF8Strsub                   (const xmlChar *utf,
-                                             int start,
-                                             int len);
-int         xmlUTF8Strlen                   (const xmlChar *utf);
-int         xmlUTF8Size                     (const xmlChar *utf);
-int         xmlUTF8Charcmp                  (const xmlChar *utf1,
-                                             const xmlChar *utf2);
-
Description

-
-
Details
enum xmlCharEncoding
typedef enum {
-    XML_CHAR_ENCODING_ERROR=   -1, /* No char encoding detected */
-    XML_CHAR_ENCODING_NONE=	0, /* No char encoding detected */
-    XML_CHAR_ENCODING_UTF8=	1, /* UTF-8 */
-    XML_CHAR_ENCODING_UTF16LE=	2, /* UTF-16 little endian */
-    XML_CHAR_ENCODING_UTF16BE=	3, /* UTF-16 big endian */
-    XML_CHAR_ENCODING_UCS4LE=	4, /* UCS-4 little endian */
-    XML_CHAR_ENCODING_UCS4BE=	5, /* UCS-4 big endian */
-    XML_CHAR_ENCODING_EBCDIC=	6, /* EBCDIC uh! */
-    XML_CHAR_ENCODING_UCS4_2143=7, /* UCS-4 unusual ordering */
-    XML_CHAR_ENCODING_UCS4_3412=8, /* UCS-4 unusual ordering */
-    XML_CHAR_ENCODING_UCS2=	9, /* UCS-2 */
-    XML_CHAR_ENCODING_8859_1=	10,/* ISO-8859-1 ISO Latin 1 */
-    XML_CHAR_ENCODING_8859_2=	11,/* ISO-8859-2 ISO Latin 2 */
-    XML_CHAR_ENCODING_8859_3=	12,/* ISO-8859-3 */
-    XML_CHAR_ENCODING_8859_4=	13,/* ISO-8859-4 */
-    XML_CHAR_ENCODING_8859_5=	14,/* ISO-8859-5 */
-    XML_CHAR_ENCODING_8859_6=	15,/* ISO-8859-6 */
-    XML_CHAR_ENCODING_8859_7=	16,/* ISO-8859-7 */
-    XML_CHAR_ENCODING_8859_8=	17,/* ISO-8859-8 */
-    XML_CHAR_ENCODING_8859_9=	18,/* ISO-8859-9 */
-    XML_CHAR_ENCODING_2022_JP=  19,/* ISO-2022-JP */
-    XML_CHAR_ENCODING_SHIFT_JIS=20,/* Shift_JIS */
-    XML_CHAR_ENCODING_EUC_JP=   21,/* EUC-JP */
-    XML_CHAR_ENCODING_ASCII=    22 /* pure ASCII */
-} xmlCharEncoding;
-

-
-
xmlCharEncodingInputFunc ()
int         (*xmlCharEncodingInputFunc)     (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);

-Take a block of chars in the original encoding and try to convert
-it to an UTF-8 block of chars out.

-
-
out:  a pointer to an array of bytes to store the UTF-8 result
-
outlen:  the length of out
-
in:  a pointer to an array of chars in the original encoding
-
inlen:  the length of in
-
Returns :the number of byte written, or -1 by lack of space, or -2
-    if the transcoding failed.
-The value of inlen after return is the number of octets consumed
-    as the return value is positive, else unpredictiable.
-The value of outlen after return is the number of octets consumed.
-
xmlCharEncodingOutputFunc ()
int         (*xmlCharEncodingOutputFunc)    (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);

-Take a block of UTF-8 chars in and try to convert it to an other
-encoding.
-Note: a first call designed to produce heading info is called with
-in = NULL. If stateful this should also initialize the encoder state.

-
-
out:  a pointer to an array of bytes to store the result
-
outlen:  the length of out
-
in:  a pointer to an array of UTF-8 chars
-
inlen:  the length of in
-
Returns :the number of byte written, or -1 by lack of space, or -2
-    if the transcoding failed.
-The value of inlen after return is the number of octets consumed
-    as the return value is positive, else unpredictiable.
-The value of outlen after return is the number of ocetes consumed.
-
struct xmlCharEncodingHandler
struct xmlCharEncodingHandler {
-
-    char                       *name;
-    xmlCharEncodingInputFunc   input;
-    xmlCharEncodingOutputFunc  output;
-#ifdef LIBXML_ICONV_ENABLED
-    iconv_t                    iconv_in;
-    iconv_t                    iconv_out;
-#endif /* LIBXML_ICONV_ENABLED */
-};
-

-
-
xmlCharEncodingHandlerPtr
typedef xmlCharEncodingHandler *xmlCharEncodingHandlerPtr;
-

-
-
xmlInitCharEncodingHandlers ()
void        xmlInitCharEncodingHandlers     (void);

-Initialize the char encoding support, it registers the default
-encoding supported.
-NOTE: while public, this function usually doesn't need to be called
-      in normal processing.

-
-
xmlCleanupCharEncodingHandlers ()
void        xmlCleanupCharEncodingHandlers  (void);

-Cleanup the memory allocated for the char encoding support, it
-unregisters all the encoding handlers and the aliases.

-
-
xmlRegisterCharEncodingHandler ()
void        xmlRegisterCharEncodingHandler  (xmlCharEncodingHandlerPtr handler);

-Register the char encoding handler, surprising, isn't it ?

-
-
handler:  the xmlCharEncodingHandlerPtr handler block
-
xmlGetCharEncodingHandler ()
xmlCharEncodingHandlerPtr xmlGetCharEncodingHandler
-                                            (xmlCharEncoding enc);

-Search in the registered set the handler able to read/write that encoding.

-
-
enc:  an xmlCharEncoding value.
-
Returns :the handler or NULL if not found
-
xmlFindCharEncodingHandler ()
xmlCharEncodingHandlerPtr xmlFindCharEncodingHandler
-                                            (const char *name);

-Search in the registered set the handler able to read/write that encoding.

-
-
name:  a string describing the char encoding.
-
Returns :the handler or NULL if not found
-
xmlNewCharEncodingHandler ()
xmlCharEncodingHandlerPtr xmlNewCharEncodingHandler
-                                            (const char *name,
-                                             xmlCharEncodingInputFunc input,
-                                             xmlCharEncodingOutputFunc output);

-Create and registers an xmlCharEncodingHandler.

-
-
name:  the encoding name, in UTF-8 format (ASCII actually)
-
input:  the xmlCharEncodingInputFunc to read that encoding
-
output:  the xmlCharEncodingOutputFunc to write that encoding
-
Returns :the xmlCharEncodingHandlerPtr created (or NULL in case of error).
-
xmlAddEncodingAlias ()
int         xmlAddEncodingAlias             (const char *name,
-                                             const char *alias);

-Registers and alias alias for an encoding named name. Existing alias
-will be overwritten.

-
-
name:  the encoding name as parsed, in UTF-8 format (ASCII actually)
-
alias:  the alias name as parsed, in UTF-8 format (ASCII actually)
-
Returns :0 in case of success, -1 in case of error
-
xmlDelEncodingAlias ()
int         xmlDelEncodingAlias             (const char *alias);

-Unregisters an encoding alias alias

-
-
alias:  the alias name as parsed, in UTF-8 format (ASCII actually)
-
Returns :0 in case of success, -1 in case of error
-
xmlGetEncodingAlias ()
const char* xmlGetEncodingAlias             (const char *alias);

-Lookup an encoding name for the given alias.

-
-
alias:  the alias name as parsed, in UTF-8 format (ASCII actually)
-
Returns :NULL if not found the original name otherwise
-
xmlCleanupEncodingAliases ()
void        xmlCleanupEncodingAliases       (void);

-Unregisters all aliases

-
-
xmlParseCharEncoding ()
xmlCharEncoding xmlParseCharEncoding        (const char *name);

-Compare the string to the known encoding schemes already known. Note
-that the comparison is case insensitive accordingly to the section
-[XML] 4.3.3 Character Encoding in Entities.

-
-
name:  the encoding name as parsed, in UTF-8 format (ASCII actually)
-
Returns :one of the XML_CHAR_ENCODING_... values or XML_CHAR_ENCODING_NONE
-if not recognized.
-
xmlGetCharEncodingName ()
const char* xmlGetCharEncodingName          (xmlCharEncoding enc);

-The "canonical" name for XML encoding.
-C.f. http://www.w3.org/TR/REC-xmlcharencoding
-Section 4.3.3  Character Encoding in Entities

-
-
enc:  the encoding
-
Returns :the canonical name for the given encoding
-
xmlDetectCharEncoding ()
xmlCharEncoding xmlDetectCharEncoding       (unsigned char *in,
-                                             int len);

-Guess the encoding of the entity using the first bytes of the entity content
-accordingly of the non-normative appendix F of the XML-1.0 recommendation.

-
-
in:  a pointer to the first bytes of the XML entity, must be at least
-      4 bytes long.
-
len:  pointer to the length of the buffer
-
Returns :one of the XML_CHAR_ENCODING_... values.
-
xmlCharEncOutFunc ()
int         xmlCharEncOutFunc               (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);

-Generic front-end for the encoding handler output function
-a first call with in == NULL has to be made firs to initiate the 
-output in case of non-stateless encoding needing to initiate their
-state or the output (like the BOM in UTF16).
-In case of UTF8 sequence conversion errors for the given encoder,
-the content will be automatically remapped to a CharRef sequence.

-
-
handler:	char enconding transformation data structure
-
out:  an xmlBuffer for the output.
-
in:  an xmlBuffer for the input
-
Returns :the number of byte written if success, or 
-    -1 general error
-    -2 if the transcoding fails (for *in is not valid utf8 string or
-       the result of transformation can't fit into the encoding we want), or
-
xmlCharEncInFunc ()
int         xmlCharEncInFunc                (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);

-Generic front-end for the encoding handler input function

-
-
handler:	char encoding transformation data structure
-
out:  an xmlBuffer for the output.
-
in:  an xmlBuffer for the input
-
Returns :the number of byte written if success, or 
-    -1 general error
-    -2 if the transcoding fails (for *in is not valid utf8 string or
-       the result of transformation can't fit into the encoding we want), or
-
xmlCharEncFirstLine ()
int         xmlCharEncFirstLine             (xmlCharEncodingHandler *handler,
-                                             xmlBufferPtr out,
-                                             xmlBufferPtr in);

-Front-end for the encoding handler input function, but handle only
-the very first line, i.e. limit itself to 45 chars.

-
-
handler:	char enconding transformation data structure
-
out:  an xmlBuffer for the output.
-
in:  an xmlBuffer for the input
-
Returns :the number of byte written if success, or 
-    -1 general error
-    -2 if the transcoding fails (for *in is not valid utf8 string or
-       the result of transformation can't fit into the encoding we want), or
-
xmlCharEncCloseFunc ()
int         xmlCharEncCloseFunc             (xmlCharEncodingHandler *handler);

-Generic front-end for encoding handler close function

-
-
handler:	char enconding transformation data structure
-
Returns :0 if success, or -1 in case of error
-
UTF8Toisolat1 ()
int         UTF8Toisolat1                   (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);

-Take a block of UTF-8 chars in and try to convert it to an ISO Latin 1
-block of chars out.

-
-
out:  a pointer to an array of bytes to store the result
-
outlen:  the length of out
-
in:  a pointer to an array of UTF-8 chars
-
inlen:  the length of in
-
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise
-The value of inlen after return is the number of octets consumed
-    as the return value is positive, else unpredictable.
-The value of outlen after return is the number of ocetes consumed.
-
isolat1ToUTF8 ()
int         isolat1ToUTF8                   (unsigned char *out,
-                                             int *outlen,
-                                             unsigned char *in,
-                                             int *inlen);

-Take a block of ISO Latin 1 chars in and try to convert it to an UTF-8
-block of chars out.

-
-
out:  a pointer to an array of bytes to store the result
-
outlen:  the length of out
-
in:  a pointer to an array of ISO Latin 1 chars
-
inlen:  the length of in
-
Returns :0 if success, or -1 otherwise
-The value of inlen after return is the number of octets consumed
-    as the return value is positive, else unpredictable.
-The value of outlen after return is the number of ocetes consumed.
-
xmlGetUTF8Char ()
int         xmlGetUTF8Char                  (unsigned char *utf,
-                                             int *len);

-Read one UTF8 Char from utf

-
-
utf:  a sequence of UTF-8 encoded bytes
-
len:  a pointer to bytes len
-
Returns :the char value or -1 in case of error and update len with the
-       number of bytes used
-
xmlCheckUTF8 ()
int         xmlCheckUTF8                    (unsigned char *utf);

-Checks utf for being valid utf-8. utf is assumed to be
-null-terminated. This function is not super-strict, as it will
-allow longer utf-8 sequences than necessary. Note that Java is
-capable of producing these sequences if provoked. Also note, this
-routine checks for the 4-byte maximum size, but does not check for
-0x10ffff maximum value.

-
-
utf: Pointer to putative utf-8 encoded string.
-
Returns : true if utf is valid.
-
xmlUTF8Strsize ()
int         xmlUTF8Strsize                  (const xmlChar *utf,
-                                             int len);

-storage size of an UTF8 string

-
-
utf:  a sequence of UTF-8 encoded bytes
-
len:  the number of characters in the array
-
Returns :the storage size of
-the first 'len' characters of ARRAY
-
-
xmlUTF8Strndup ()
xmlChar*    xmlUTF8Strndup                  (const xmlChar *utf,
-                                             int len);

-a strndup for array of UTF8's

-
-
utf:  the input UTF8 *
-
len:  the len of utf (in chars)
-
Returns :a new UTF8 * or NULL
-
xmlUTF8Strpos ()
xmlChar*    xmlUTF8Strpos                   (const xmlChar *utf,
-                                             int pos);

-a function to provide the equivalent of fetching a
-character from a string array

-
-
utf:  the input UTF8 *
-
pos:  the position of the desired UTF8 char (in chars)
-
Returns :a pointer to the UTF8 character or NULL
-
xmlUTF8Strloc ()
int         xmlUTF8Strloc                   (const xmlChar *utf,
-                                             const xmlChar *utfchar);

-a function to provide relative location of a UTF8 char

-
-
utf:  the input UTF8 *
-
utfchar:  the UTF8 character to be found
-
Returns :the relative character position of the desired char
-or -1 if not found
-
xmlUTF8Strsub ()
xmlChar*    xmlUTF8Strsub                   (const xmlChar *utf,
-                                             int start,
-                                             int len);

-Note:  positions are given in units of UTF-8 chars

-
-
utf:  a sequence of UTF-8 encoded bytes
-
start: relative pos of first char
-
len:   total number to copy
-
Returns :a pointer to a newly created string
-or NULL if any problem
-
xmlUTF8Strlen ()
int         xmlUTF8Strlen                   (const xmlChar *utf);

-compute the length of an UTF8 string, it doesn't do a full UTF8
-checking of the content of the string.

-
-
utf:  a sequence of UTF-8 encoded bytes
-
Returns :the number of characters in the string or -1 in case of error
-
xmlUTF8Size ()
int         xmlUTF8Size                     (const xmlChar *utf);

-calulates the internal size of a UTF8 character

-
-
utf: pointer to the UTF8 character
-
Returns :the numbers of bytes in the character, -1 on format error
-
xmlUTF8Charcmp ()
int         xmlUTF8Charcmp                  (const xmlChar *utf1,
-                                             const xmlChar *utf2);

-compares the two UCS4 values

-
-
utf1: pointer to first UTF8 char
-
utf2: pointer to second UTF8 char
-
Returns :result of the compare as with xmlStrncmp
-
<< wsockcompatxmlregexp >>

+
int	xmlUTF8Strsize	(const xmlChar * utf, 
				 int len)

+
int	xmlUTF8Charcmp	(const xmlChar * utf1, 
				 const xmlChar * utf2)

+
int	xmlUTF8Strlen	(const xmlChar * utf)

+
Function type: xmlCharEncodingOutputFunc
+int	xmlCharEncodingOutputFunc	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)
+
Take a block of UTF-8 chars in and try to convert it to an other encoding. Note: a first call designed to produce heading info is called with in = NULL. If stateful this should also initialize the encoder state.
out:a pointer to an array of bytes to store the result
outlen:the length of @out
in:a pointer to an array of UTF-8 chars
inlen:the length of @in
Returns:the number of byte written, or -1 by lack of space, or -2 if the transcoding failed. The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictiable. The value of @outlen after return is the number of ocetes consumed.


+
xmlChar *	xmlUTF8Strndup	(const xmlChar * utf, 
				 int len)

+
xmlCharEncoding	xmlDetectCharEncoding	(const unsigned char * in, 
				 int len)

+
void	xmlCleanupEncodingAliases	(void)

+
Description

+
Function: xmlDelEncodingAlias
int	xmlDelEncodingAlias	(const char * alias)

+
Unregisters an encoding alias @alias

+
alias:the alias name as parsed, in UTF-8 format (ASCII actually)
Returns:0 in case of success, -1 in case of error
Function: xmlGetEncodingAlias
const char *	xmlGetEncodingAlias	(const char * alias)

+
Lookup an encoding name for the given alias.

+
alias:the alias name as parsed, in UTF-8 format (ASCII actually)
Returns:NULL if not found the original name otherwise
Function: xmlUTF8Strloc
int	xmlUTF8Strloc	(const xmlChar * utf, 
				 const xmlChar * utfchar)

+
a function to provide relative location of a UTF8 char

+
utf:the input UTF8 *
utfchar:the UTF8 character to be found
Returns:the relative character position of the desired char or -1 if not found
Function: xmlCleanupCharEncodingHandlers
void	xmlCleanupCharEncodingHandlers	(void)

+
Cleanup the memory allocated for the char encoding support, it unregisters all the encoding handlers and the aliases.

+
Function: xmlFindCharEncodingHandler
xmlCharEncodingHandlerPtr	xmlFindCharEncodingHandler	(const char * name)

+
Search in the registered set the handler able to read/write that encoding.

+
name:a string describing the char encoding.
Returns:the handler or NULL if not found
Function: xmlCharEncCloseFunc
int	xmlCharEncCloseFunc	(xmlCharEncodingHandler * handler)

+
Generic front-end for encoding handler close function

+
handler:char enconding transformation data structure
Returns:0 if success, or -1 in case of error
Function: xmlUTF8Size
int	xmlUTF8Size	(const xmlChar * utf)

+
calulates the internal size of a UTF8 character

+
utf:pointer to the UTF8 character
Returns:the numbers of bytes in the character, -1 on format error
Function: xmlParseCharEncoding
xmlCharEncoding	xmlParseCharEncoding	(const char * name)

+
Compare the string to the known encoding schemes already known. Note that the comparison is case insensitive accordingly to the section [XML] 4.3.3 Character Encoding in Entities.

+
name:the encoding name as parsed, in UTF-8 format (ASCII actually)
Returns:one of the XML_CHAR_ENCODING_... values or XML_CHAR_ENCODING_NONE if not recognized.
Function: xmlUTF8Strpos
xmlChar *	xmlUTF8Strpos	(const xmlChar * utf, 
				 int pos)

+
a function to provide the equivalent of fetching a character from a string array

+
utf:the input UTF8 *
pos:the position of the desired UTF8 char (in chars)
Returns:a pointer to the UTF8 character or NULL

+      
+      
+      
+      
+      
+    
Function: xmlGetCharEncodingName
const char *	xmlGetCharEncodingName	(xmlCharEncoding enc)

+
The "canonical" name for XML encoding. C.f. http://www.w3.org/TR/REC-xml#charencoding Section 4.3.3 Character Encoding in Entities

+
enc:the encoding
Returns:the canonical name for the given encoding
Function: xmlCheckUTF8
int	xmlCheckUTF8	(const unsigned char * utf)

+
Checks @utf for being valid utf-8. @utf is assumed to be null-terminated. This function is not super-strict, as it will allow longer utf-8 sequences than necessary. Note that Java is capable of producing these sequences if provoked. Also note, this routine checks for the 4-byte maximum size, but does not check for 0x10ffff maximum value.

+
utf:Pointer to putative utf-8 encoded string.
Returns:value: true if @utf is valid.
Function: UTF8Toisolat1
int	UTF8Toisolat1	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)

+
Take a block of UTF-8 chars in and try to convert it to an ISO Latin 1 block of chars out.

+
out:a pointer to an array of bytes to store the result
outlen:the length of @out
in:a pointer to an array of UTF-8 chars
inlen:the length of @in
Returns:0 if success, -2 if the transcoding fails, or -1 otherwise The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictable. The value of @outlen after return is the number of ocetes consumed.
Function: xmlCharEncInFunc
int	xmlCharEncInFunc	(xmlCharEncodingHandler * handler, 
				 xmlBufferPtr out, 
				 xmlBufferPtr in)

+
Generic front-end for the encoding handler input function

+
handler:char encoding transformation data structure
out:an xmlBuffer for the output.
in:an xmlBuffer for the input
Returns:the number of byte written if success, or -1 general error -2 if the transcoding fails (for *in is not valid utf8 string or the result of transformation can't fit into the encoding we want), or
Function: xmlAddEncodingAlias
int	xmlAddEncodingAlias	(const char * name, 
				 const char * alias)

+
Registers and alias @alias for an encoding named @name. Existing alias will be overwritten.

+
name:the encoding name as parsed, in UTF-8 format (ASCII actually)
alias:the alias name as parsed, in UTF-8 format (ASCII actually)
Returns:0 in case of success, -1 in case of error
Function: xmlCharEncOutFunc
int	xmlCharEncOutFunc	(xmlCharEncodingHandler * handler, 
				 xmlBufferPtr out, 
				 xmlBufferPtr in)

+
Generic front-end for the encoding handler output function a first call with @in == NULL has to be made firs to initiate the output in case of non-stateless encoding needing to initiate their state or the output (like the BOM in UTF16). In case of UTF8 sequence conversion errors for the given encoder, the content will be automatically remapped to a CharRef sequence.

+
handler:char enconding transformation data structure
out:an xmlBuffer for the output.
in:an xmlBuffer for the input
Returns:the number of byte written if success, or -1 general error -2 if the transcoding fails (for *in is not valid utf8 string or the result of transformation can't fit into the encoding we want), or

+      Take a block of chars in the original encoding and try to convert it to an UTF-8 block of chars out.
+      
+      
+      
+      
+      
+    
Function: xmlGetCharEncodingHandler
xmlCharEncodingHandlerPtr	xmlGetCharEncodingHandler	(xmlCharEncoding enc)

+
Search in the registered set the handler able to read/write that encoding.

+
enc:an xmlCharEncoding value.
Returns:the handler or NULL if not found
Function: xmlUTF8Strsub
xmlChar *	xmlUTF8Strsub	(const xmlChar * utf, 
				 int start, 
				 int len)

+
Note: positions are given in units of UTF-8 chars

+
utf:a sequence of UTF-8 encoded bytes
start:relative pos of first char
len:total number to copy
Returns:a pointer to a newly created string or NULL if any problem
Function: xmlGetUTF8Char
int	xmlGetUTF8Char	(const unsigned char * utf, 
				 int * len)

+
Read one UTF8 Char from @utf

+
utf:a sequence of UTF-8 encoded bytes
len:a pointer to @bytes len
Returns:the char value or -1 in case of error and update @len with the number of bytes used
Function: isolat1ToUTF8
int	isolat1ToUTF8	(unsigned char * out, 
				 int * outlen, 
				 const unsigned char * in, 
				 int * inlen)

+
Take a block of ISO Latin 1 chars in and try to convert it to an UTF-8 block of chars out.

+
out:a pointer to an array of bytes to store the result
outlen:the length of @out
in:a pointer to an array of ISO Latin 1 chars
inlen:the length of @in
Returns:0 if success, or -1 otherwise The value of @inlen after return is the number of octets consumed as the return value is positive, else unpredictable. The value of @outlen after return is the number of ocetes consumed.
Function: xmlNewCharEncodingHandler
xmlCharEncodingHandlerPtr	xmlNewCharEncodingHandler	(const char * name, 
				 xmlCharEncodingInputFunc input, 
				 xmlCharEncodingOutputFunc output)

+
Create and registers an xmlCharEncodingHandler.

+
name:the encoding name, in UTF-8 format (ASCII actually)
input:the xmlCharEncodingInputFunc to read that encoding
output:the xmlCharEncodingOutputFunc to write that encoding
Returns:the xmlCharEncodingHandlerPtr created (or NULL in case of error).
Function: xmlInitCharEncodingHandlers
void	xmlInitCharEncodingHandlers	(void)

+
Initialize the char encoding support, it registers the default encoding supported. NOTE: while public, this function usually doesn't need to be called in normal processing.

+
Function: xmlRegisterCharEncodingHandler
void	xmlRegisterCharEncodingHandler	(xmlCharEncodingHandlerPtr handler)

+
Register the char encoding handler, surprising, isn't it ?

+
handler:the xmlCharEncodingHandlerPtr handler block
Function: xmlCharEncFirstLine
int	xmlCharEncFirstLine	(xmlCharEncodingHandler * handler, 
				 xmlBufferPtr out, 
				 xmlBufferPtr in)

+
Front-end for the encoding handler input function, but handle only the very first line, i.e. limit itself to 45 chars.

+
handler:char enconding transformation data structure
out:an xmlBuffer for the output.
in:an xmlBuffer for the input
Returns:the number of byte written if success, or -1 general error -2 if the transcoding fails (for *in is not valid utf8 string or the result of transformation can't fit into the encoding we want), or
Function: xmlUTF8Strsize
int	xmlUTF8Strsize	(const xmlChar * utf, 
				 int len)

+
storage size of an UTF8 string

+
utf:a sequence of UTF-8 encoded bytes
len:the number of characters in the array
Returns:the storage size of the first 'len' characters of ARRAY
Function: xmlUTF8Charcmp
int	xmlUTF8Charcmp	(const xmlChar * utf1, 
				 const xmlChar * utf2)

+
compares the two UCS4 values

+
utf1:pointer to first UTF8 char
utf2:pointer to second UTF8 char
Returns:result of the compare as with xmlStrncmp
Function: xmlUTF8Strlen
int	xmlUTF8Strlen	(const xmlChar * utf)

+
compute the length of an UTF8 string, it doesn't do a full UTF8 checking of the content of the string.

+
utf:a sequence of UTF-8 encoded bytes
Returns:the number of characters in the string or -1 in case of error

+      Take a block of UTF-8 chars in and try to convert it to an other encoding. Note: a first call designed to produce heading info is called with in = NULL. If stateful this should also initialize the encoder state.
+      
+      
+      
+      
+      
+    
Function: xmlUTF8Strndup
xmlChar *	xmlUTF8Strndup	(const xmlChar * utf, 
				 int len)

+
a strndup for array of UTF8's

+
utf:the input UTF8 *
len:the len of @utf (in chars)
Returns:a new UTF8 * or NULL
Function: xmlDetectCharEncoding
xmlCharEncoding	xmlDetectCharEncoding	(const unsigned char * in, 
				 int len)

+
Guess the encoding of the entity using the first bytes of the entity content accordingly of the non-normative appendix F of the XML-1.0 recommendation.

+
in:a pointer to the first bytes of the XML entity, must be at least 4 bytes long.
len:pointer to the length of the buffer
Returns:one of the XML_CHAR_ENCODING_... values.
Function: xmlCleanupEncodingAliases
void	xmlCleanupEncodingAliases	(void)

+
Unregisters all aliases

+
Daniel Veillard

diff --git a/doc/html/libxml-entities.html b/doc/html/libxml-entities.html
index e0822fa0..672dd72f 100644
--- a/doc/html/libxml-entities.html
+++ b/doc/html/libxml-entities.html
@@ -1,235 +1,72 @@
-entities
PrevUpHomeGnome XML Library Reference ManualNext
entities
entities — 
Synopsis
+
+
+Module entities from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module entities from libxml2
Main Menu
Related links
Table of Contents
xmlEntityPtr	xmlAddDocEntity	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 int type, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID, 
				 const xmlChar * content)

+
xmlEntityPtr	xmlGetDtdEntity	(xmlDocPtr doc, 
				 const xmlChar * name)

+
xmlEntityPtr	xmlAddDtdEntity	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 int type, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID, 
				 const xmlChar * content)

+
void	xmlFreeEntitiesTable	(xmlEntitiesTablePtr table)

+
Structure xmlEntitiesTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}

xmlChar *	xmlEncodeSpecialChars	(xmlDocPtr doc, 
				 const xmlChar * input)

+
xmlEntityPtr	xmlGetDocEntity	(xmlDocPtr doc, 
				 const xmlChar * name)

+
const xmlChar *	xmlEncodeEntities	(xmlDocPtr doc, 
				 const xmlChar * input)

+
xmlEntityPtr	xmlGetPredefinedEntity	(const xmlChar * name)

+
void	xmlInitializePredefinedEntities	(void)

+
Typedef xmlEntitiesTable * xmlEntitiesTablePtr
 
+
xmlChar *	xmlEncodeEntitiesReentrant	(xmlDocPtr doc, 
				 const xmlChar * input)

+
Enum xmlEntityType {
+    XML_INTERNAL_GENERAL_ENTITY = 1
+    XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2
+    XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3
+    XML_INTERNAL_PARAMETER_ENTITY = 4
+    XML_EXTERNAL_PARAMETER_ENTITY = 5
+    XML_INTERNAL_PREDEFINED_ENTITY = 6
+}
 
-
-enum        xmlEntityType;
-struct      xmlEntity;
-typedef     xmlEntitiesTablePtr;
-void        xmlInitializePredefinedEntities (void);
-xmlEntityPtr xmlAddDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);
-xmlEntityPtr xmlAddDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);
-xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);
-xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
-                                             const xmlChar *name);
-const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
-                                             const xmlChar *input);
-xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
-                                             const xmlChar *input);
-xmlChar*    xmlEncodeSpecialChars           (xmlDocPtr doc,
-                                             const xmlChar *input);
-xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);
-xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);
-void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);
-void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
-                                             xmlEntitiesTablePtr table);
-void        xmlDumpEntityDecl               (xmlBufferPtr buf,
-                                             xmlEntityPtr ent);
-void        xmlCleanupPredefinedEntities    (void);
-
Description

-
-
Details
enum xmlEntityType
typedef enum {
-    XML_INTERNAL_GENERAL_ENTITY = 1,
-    XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2,
-    XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3,
-    XML_INTERNAL_PARAMETER_ENTITY = 4,
-    XML_EXTERNAL_PARAMETER_ENTITY = 5,
-    XML_INTERNAL_PREDEFINED_ENTITY = 6
-} xmlEntityType;
-

-
-
struct xmlEntity
struct xmlEntity {
-
-    void           *_private;	        /* application data */
-    xmlElementType          type;       /* XML_ENTITY_DECL, must be second ! */
-    const xmlChar          *name;	/* Entity name */
-    struct _xmlNode    *children;	/* First child link */
-    struct _xmlNode        *last;	/* Last child link */
-    struct _xmlDtd       *parent;	/* -> DTD */
-    struct _xmlNode        *next;	/* next sibling link  */
-    struct _xmlNode        *prev;	/* previous sibling link  */
-    struct _xmlDoc          *doc;       /* the containing document */
-
-    xmlChar                *orig;	/* content without ref substitution */
-    xmlChar             *content;	/* content or ndata if unparsed */
-    int                   length;	/* the content length */
-    xmlEntityType          etype;	/* The entity type */
-    const xmlChar    *ExternalID;	/* External identifier for PUBLIC */
-    const xmlChar      *SystemID;	/* URI for a SYSTEM or PUBLIC Entity */
-
-    struct _xmlEntity     *nexte;	/* unused */
-    const xmlChar           *URI;	/* the full URI as computed */
-    int                    owner;	/* does the entity own the childrens */
-};
-

-
-
xmlEntitiesTablePtr
typedef xmlEntitiesTable *xmlEntitiesTablePtr;
-

-
-
xmlInitializePredefinedEntities ()
void        xmlInitializePredefinedEntities (void);

-Set up the predefined entities.
-Deprecated call

-
-
xmlAddDocEntity ()
xmlEntityPtr xmlAddDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);

-Register a new entity for this document.

-
-
doc:  the document
-
name:  the entity name
-
type:  the entity type XML_xxx_yyy_ENTITY
-
ExternalID:  the entity external ID if available
-
SystemID:  the entity system ID if available
-
content:  the entity content
-
Returns :a pointer to the entity or NULL in case of error
-
xmlAddDtdEntity ()
xmlEntityPtr xmlAddDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID,
-                                             const xmlChar *content);

-Register a new entity for this document DTD external subset.

-
-
doc:  the document
-
name:  the entity name
-
type:  the entity type XML_xxx_yyy_ENTITY
-
ExternalID:  the entity external ID if available
-
SystemID:  the entity system ID if available
-
content:  the entity content
-
Returns :a pointer to the entity or NULL in case of error
-
xmlGetPredefinedEntity ()
xmlEntityPtr xmlGetPredefinedEntity         (const xmlChar *name);

-Check whether this name is an predefined entity.

-
-
name:  the entity name
-
Returns :NULL if not, otherwise the entity
-
xmlGetDocEntity ()
xmlEntityPtr xmlGetDocEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);

-Do an entity lookup in the document entity hash table and
-returns the corresponding entity, otherwise a lookup is done
-in the predefined entities too.

-
-
doc:  the document referencing the entity
-
name:  the entity name
-
Returns :A pointer to the entity structure or NULL if not found.
-
xmlGetDtdEntity ()
xmlEntityPtr xmlGetDtdEntity                (xmlDocPtr doc,
-                                             const xmlChar *name);

-Do an entity lookup in the DTD entity hash table and
-returns the corresponding entity, if found.
-Note: the first argument is the document node, not the DTD node.

-
-
doc:  the document referencing the entity
-
name:  the entity name
-
Returns :A pointer to the entity structure or NULL if not found.
-
xmlGetParameterEntity ()
xmlEntityPtr xmlGetParameterEntity          (xmlDocPtr doc,
-                                             const xmlChar *name);

-Do an entity lookup in the internal and external subsets and
-returns the corresponding parameter entity, if found.

-
-
doc:  the document referencing the entity
-
name:  the entity name
-
Returns :A pointer to the entity structure or NULL if not found.
-
xmlEncodeEntities ()
const xmlChar* xmlEncodeEntities            (xmlDocPtr doc,
-                                             const xmlChar *input);

-TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary
-      compatibility
-

-People must migrate their code to xmlEncodeEntitiesReentrant !
-This routine will issue a warning when encountered.

-
-
doc:  the document containing the string
-
input:  A string to convert to XML.
-
Returns :NULL
-
xmlEncodeEntitiesReentrant ()
xmlChar*    xmlEncodeEntitiesReentrant      (xmlDocPtr doc,
-                                             const xmlChar *input);

-Do a global encoding of a string, replacing the predefined entities
-and non ASCII values with their entities and CharRef counterparts.
-Contrary to xmlEncodeEntities, this routine is reentrant, and result
-must be deallocated.

-
-
doc:  the document containing the string
-
input:  A string to convert to XML.
-
Returns :A newly allocated string with the substitution done.
-
xmlEncodeSpecialChars ()
xmlChar*    xmlEncodeSpecialChars           (xmlDocPtr doc,
-                                             const xmlChar *input);

-Do a global encoding of a string, replacing the predefined entities
-this routine is reentrant, and result must be deallocated.

-
-
doc:  the document containing the string
-
input:  A string to convert to XML.
-
Returns :A newly allocated string with the substitution done.
-
xmlCreateEntitiesTable ()
xmlEntitiesTablePtr xmlCreateEntitiesTable  (void);

-create and initialize an empty entities hash table.

-
-
Returns :the xmlEntitiesTablePtr just created or NULL in case of error.
-
xmlCopyEntitiesTable ()
xmlEntitiesTablePtr xmlCopyEntitiesTable    (xmlEntitiesTablePtr table);

-Build a copy of an entity table.

-
-
table:  An entity table
-
Returns :the new xmlEntitiesTablePtr or NULL in case of error.
-
xmlFreeEntitiesTable ()
void        xmlFreeEntitiesTable            (xmlEntitiesTablePtr table);

-Deallocate the memory used by an entities hash table.

-
-
table:  An entity table
-
xmlDumpEntitiesTable ()
void        xmlDumpEntitiesTable            (xmlBufferPtr buf,
-                                             xmlEntitiesTablePtr table);

-This will dump the content of the entity table as an XML DTD definition

-
-
buf:  An XML buffer.
-
table:  An entity table
-
xmlDumpEntityDecl ()
void        xmlDumpEntityDecl               (xmlBufferPtr buf,
-                                             xmlEntityPtr ent);

-This will dump the content of the entity table as an XML DTD definition

-
-
buf:  An XML buffer.
-
ent:  An entity table
-
xmlCleanupPredefinedEntities ()
void        xmlCleanupPredefinedEntities    (void);

-Cleanup up the predefined entities table.
-Deprecated call

-
-
<< parserInternalsHTMLparser >>

+
xmlEntitiesTablePtr	xmlCopyEntitiesTable	(xmlEntitiesTablePtr table)

+
xmlEntityPtr	xmlGetParameterEntity	(xmlDocPtr doc, 
				 const xmlChar * name)

+
void	xmlDumpEntitiesTable	(xmlBufferPtr buf, 
				 xmlEntitiesTablePtr table)

+
void	xmlDumpEntityDecl	(xmlBufferPtr buf, 
				 xmlEntityPtr ent)

+
void	xmlCleanupPredefinedEntities	(void)

+
xmlEntitiesTablePtr	xmlCreateEntitiesTable	(void)

+
Description

+
Function: xmlAddDocEntity
xmlEntityPtr	xmlAddDocEntity	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 int type, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID, 
				 const xmlChar * content)

+
Register a new entity for this document.

+
doc:the document
name:the entity name
type:the entity type XML_xxx_yyy_ENTITY
ExternalID:the entity external ID if available
SystemID:the entity system ID if available
content:the entity content
Returns:a pointer to the entity or NULL in case of error
Function: xmlGetDtdEntity
xmlEntityPtr	xmlGetDtdEntity	(xmlDocPtr doc, 
				 const xmlChar * name)

+
Do an entity lookup in the DTD entity hash table and

+
doc:the document referencing the entity
name:the entity name
Returns:the corresponding entity, if found. Note: the first argument is the document node, not the DTD node. Returns A pointer to the entity structure or NULL if not found.
Function: xmlAddDtdEntity
xmlEntityPtr	xmlAddDtdEntity	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 int type, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID, 
				 const xmlChar * content)

+
Register a new entity for this document DTD external subset.

+
doc:the document
name:the entity name
type:the entity type XML_xxx_yyy_ENTITY
ExternalID:the entity external ID if available
SystemID:the entity system ID if available
content:the entity content
Returns:a pointer to the entity or NULL in case of error
Function: xmlFreeEntitiesTable
void	xmlFreeEntitiesTable	(xmlEntitiesTablePtr table)

+
Deallocate the memory used by an entities hash table.

+
table:An entity table
Function: xmlEncodeSpecialChars
xmlChar *	xmlEncodeSpecialChars	(xmlDocPtr doc, 
				 const xmlChar * input)

+
Do a global encoding of a string, replacing the predefined entities this routine is reentrant, and result must be deallocated.

+
doc:the document containing the string
input:A string to convert to XML.
Returns:A newly allocated string with the substitution done.
Function: xmlGetDocEntity
xmlEntityPtr	xmlGetDocEntity	(xmlDocPtr doc, 
				 const xmlChar * name)

+
Do an entity lookup in the document entity hash table and

+
doc:the document referencing the entity
name:the entity name
Returns:the corresponding entity, otherwise a lookup is done in the predefined entities too. Returns A pointer to the entity structure or NULL if not found.
Function: xmlEncodeEntities
const xmlChar *	xmlEncodeEntities	(xmlDocPtr doc, 
				 const xmlChar * input)

+
TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary compatibility People must migrate their code to xmlEncodeEntitiesReentrant ! This routine will issue a warning when encountered.

+
doc:the document containing the string
input:A string to convert to XML.
Returns:NULL
Function: xmlGetPredefinedEntity
xmlEntityPtr	xmlGetPredefinedEntity	(const xmlChar * name)

+
Check whether this name is an predefined entity.

+
name:the entity name
Returns:NULL if not, otherwise the entity
Function: xmlInitializePredefinedEntities
void	xmlInitializePredefinedEntities	(void)

+
Set up the predefined entities. Deprecated call

+
Function: xmlEncodeEntitiesReentrant
xmlChar *	xmlEncodeEntitiesReentrant	(xmlDocPtr doc, 
				 const xmlChar * input)

+
Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts. Contrary to xmlEncodeEntities, this routine is reentrant, and result must be deallocated.

+
doc:the document containing the string
input:A string to convert to XML.
Returns:A newly allocated string with the substitution done.
Function: xmlCopyEntitiesTable
xmlEntitiesTablePtr	xmlCopyEntitiesTable	(xmlEntitiesTablePtr table)

+
Build a copy of an entity table.

+
table:An entity table
Returns:the new xmlEntitiesTablePtr or NULL in case of error.
Function: xmlGetParameterEntity
xmlEntityPtr	xmlGetParameterEntity	(xmlDocPtr doc, 
				 const xmlChar * name)

+
Do an entity lookup in the internal and external subsets and

+
doc:the document referencing the entity
name:the entity name
Returns:the corresponding parameter entity, if found. Returns A pointer to the entity structure or NULL if not found.
Function: xmlDumpEntitiesTable
void	xmlDumpEntitiesTable	(xmlBufferPtr buf, 
				 xmlEntitiesTablePtr table)

+
This will dump the content of the entity table as an XML DTD definition

+
buf:An XML buffer.
table:An entity table
Function: xmlDumpEntityDecl
void	xmlDumpEntityDecl	(xmlBufferPtr buf, 
				 xmlEntityPtr ent)

+
This will dump the content of the entity table as an XML DTD definition

+
buf:An XML buffer.
ent:An entity table
Function: xmlCleanupPredefinedEntities
void	xmlCleanupPredefinedEntities	(void)

+
Cleanup up the predefined entities table. Deprecated call

+
Function: xmlCreateEntitiesTable
xmlEntitiesTablePtr	xmlCreateEntitiesTable	(void)

+
create and initialize an empty entities hash table.

+
Returns:the xmlEntitiesTablePtr just created or NULL in case of error.
Daniel Veillard

diff --git a/doc/html/libxml-globals.html b/doc/html/libxml-globals.html
index 73f6ea43..addf945e 100644
--- a/doc/html/libxml-globals.html
+++ b/doc/html/libxml-globals.html
@@ -1,418 +1,215 @@
-globals
PrevUpHomeGnome XML Library Reference ManualNext
globals
globals — 
Synopsis
-
-
-
-void        xmlInitGlobals                  (void);
-void        xmlCleanupGlobals               (void);
-void        (*xmlRegisterNodeFunc)          (xmlNodePtr node);
-void        (*xmlDeregisterNodeFunc)        (xmlNodePtr node);
-struct      xmlGlobalState;
-typedef     xmlGlobalStatePtr;
-void        xmlInitializeGlobalState        (xmlGlobalStatePtr gs);
-void        xmlThrDefSetGenericErrorFunc    (void *ctx,
-                                             xmlGenericErrorFunc handler);
-void        xmlThrDefSetStructuredErrorFunc (void *ctx,
-                                             xmlStructuredErrorFunc handler);
-xmlRegisterNodeFunc xmlRegisterNodeDefault  (xmlRegisterNodeFunc func);
-xmlRegisterNodeFunc xmlThrDefRegisterNodeDefault
-                                            (xmlRegisterNodeFunc func);
-xmlDeregisterNodeFunc xmlDeregisterNodeDefault
-                                            (xmlDeregisterNodeFunc func);
-xmlDeregisterNodeFunc xmlThrDefDeregisterNodeDefault
-                                            (xmlDeregisterNodeFunc func);
-#define     xmlMalloc                       (size)
-#define     xmlMallocAtomic                 (size)
-#define     xmlRealloc                      (ptr, size)
-#define     xmlFree
-#define     xmlMemStrdup                    (str)
-#define     docbDefaultSAXHandler
-#define     htmlDefaultSAXHandler
-#define     xmlLastError
-#define     oldXMLWDcompatibility
-#define     xmlBufferAllocScheme
-xmlBufferAllocationScheme xmlThrDefBufferAllocScheme
-                                            (xmlBufferAllocationScheme v);
-#define     xmlDefaultBufferSize
-int         xmlThrDefDefaultBufferSize      (int v);
-#define     xmlDefaultSAXHandler
-#define     xmlDefaultSAXLocator
-#define     xmlDoValidityCheckingDefaultValue
-int         xmlThrDefDoValidityCheckingDefaultValue
-                                            (int v);
-#define     xmlGenericError
-#define     xmlStructuredError
-#define     xmlGenericErrorContext
-#define     xmlGetWarningsDefaultValue
-int         xmlThrDefGetWarningsDefaultValue
-                                            (int v);
-#define     xmlIndentTreeOutput
-int         xmlThrDefIndentTreeOutput       (int v);
-#define     xmlTreeIndentString
-const char* xmlThrDefTreeIndentString       (const char *v);
-#define     xmlKeepBlanksDefaultValue
-int         xmlThrDefKeepBlanksDefaultValue (int v);
-#define     xmlLineNumbersDefaultValue
-int         xmlThrDefLineNumbersDefaultValue
-                                            (int v);
-#define     xmlLoadExtDtdDefaultValue
-int         xmlThrDefLoadExtDtdDefaultValue (int v);
-#define     xmlParserDebugEntities
-int         xmlThrDefParserDebugEntities    (int v);
-#define     xmlParserVersion
-#define     xmlPedanticParserDefaultValue
-int         xmlThrDefPedanticParserDefaultValue
-                                            (int v);
-#define     xmlSaveNoEmptyTags
-int         xmlThrDefSaveNoEmptyTags        (int v);
-#define     xmlSubstituteEntitiesDefaultValue
-int         xmlThrDefSubstituteEntitiesDefaultValue
-                                            (int v);
-#define     xmlRegisterNodeDefaultValue
-#define     xmlDeregisterNodeDefaultValue
-
Description

-
-
Details
xmlInitGlobals ()
void        xmlInitGlobals                  (void);

-
-
xmlCleanupGlobals ()
void        xmlCleanupGlobals               (void);

-
-
xmlRegisterNodeFunc ()
void        (*xmlRegisterNodeFunc)          (xmlNodePtr node);

-
-
node:
-
-
-
xmlDeregisterNodeFunc ()
void        (*xmlDeregisterNodeFunc)        (xmlNodePtr node);

-
-
node:
-
-
-
struct xmlGlobalState
struct xmlGlobalState {
-
-	const char *xmlParserVersion;
-
-	xmlSAXLocator xmlDefaultSAXLocator;
-	xmlSAXHandlerV1 xmlDefaultSAXHandler;
-	xmlSAXHandlerV1 docbDefaultSAXHandler;
-	xmlSAXHandlerV1 htmlDefaultSAXHandler;
-
-	xmlFreeFunc xmlFree;
-	xmlMallocFunc xmlMalloc;
-	xmlStrdupFunc xmlMemStrdup;
-	xmlReallocFunc xmlRealloc;
-
-	xmlGenericErrorFunc xmlGenericError;
-	xmlStructuredErrorFunc xmlStructuredError;
-	void *xmlGenericErrorContext;
-
-	int oldXMLWDcompatibility;
-
-	xmlBufferAllocationScheme xmlBufferAllocScheme;
-	int xmlDefaultBufferSize;
-
-	int xmlSubstituteEntitiesDefaultValue;
-	int xmlDoValidityCheckingDefaultValue;
-	int xmlGetWarningsDefaultValue;
-	int xmlKeepBlanksDefaultValue;
-	int xmlLineNumbersDefaultValue;
-	int xmlLoadExtDtdDefaultValue;
-	int xmlParserDebugEntities;
-	int xmlPedanticParserDefaultValue;
-
-	int xmlSaveNoEmptyTags;
-	int xmlIndentTreeOutput;
-	const char *xmlTreeIndentString;
-
-  	xmlRegisterNodeFunc xmlRegisterNodeDefaultValue;
-  	xmlDeregisterNodeFunc xmlDeregisterNodeDefaultValue;
-
-	xmlMallocFunc xmlMallocAtomic;
-	xmlError xmlLastError;
-};
-

-
-
xmlGlobalStatePtr
typedef xmlGlobalState *xmlGlobalStatePtr;
-

-
-
xmlInitializeGlobalState ()
void        xmlInitializeGlobalState        (xmlGlobalStatePtr gs);

-xmlInitializeGlobalState() initialize a global state with all the
-default values of the library.

-
-
gs: a pointer to a newly allocated global state
-
xmlThrDefSetGenericErrorFunc ()
void        xmlThrDefSetGenericErrorFunc    (void *ctx,
-                                             xmlGenericErrorFunc handler);

-
-
ctx:
-
handler:
-
-
-
xmlThrDefSetStructuredErrorFunc ()
void        xmlThrDefSetStructuredErrorFunc (void *ctx,
-                                             xmlStructuredErrorFunc handler);

-
-
ctx:
-
handler:
-
-
-
xmlRegisterNodeDefault ()
xmlRegisterNodeFunc xmlRegisterNodeDefault  (xmlRegisterNodeFunc func);

-Registers a callback for node creation

-
-
func: function pointer to the new RegisterNodeFunc
-
Returns :the old value of the registration function
-
xmlThrDefRegisterNodeDefault ()
xmlRegisterNodeFunc xmlThrDefRegisterNodeDefault
-                                            (xmlRegisterNodeFunc func);

-
-
func:
-
Returns :
-
-
-
xmlDeregisterNodeDefault ()
xmlDeregisterNodeFunc xmlDeregisterNodeDefault
-                                            (xmlDeregisterNodeFunc func);

-Registers a callback for node destruction

-
-
func: function pointer to the new DeregisterNodeFunc
-
Returns :the previous value of the deregistration function
-
xmlThrDefDeregisterNodeDefault ()
xmlDeregisterNodeFunc xmlThrDefDeregisterNodeDefault
-                                            (xmlDeregisterNodeFunc func);

-
-
func:
-
Returns :
-
-
-
xmlMalloc()
#define     xmlMalloc(size)

-Wrapper for the malloc() function used in the XML library.

-
-
size:
-
-
-
xmlMallocAtomic()
#define     xmlMallocAtomic(size)

-Wrapper for the malloc() function used in the XML library for allocation
-of block not containing pointers to other areas.

-
-
size:
-
-
-
xmlRealloc()
#define     xmlRealloc(ptr, size)

-Wrapper for the realloc() function used in the XML library.

-
-
ptr:
-
size:
-
-
-
xmlFree
#define     xmlFree

-The variable holding the libxml free() implementation

-
-
xmlMemStrdup()
#define     xmlMemStrdup(str)

-Wrapper for the strdup() function, xmlStrdup() is usually preferred.

-
-
str:
-
-
-
docbDefaultSAXHandler
#define     docbDefaultSAXHandler

-Default old SAX v1 handler for SGML DocBook, builds the DOM tree

-
-
htmlDefaultSAXHandler
#define     htmlDefaultSAXHandler

-Default old SAX v1 handler for HTML, builds the DOM tree

-
-
xmlLastError
#define     xmlLastError

-
-
oldXMLWDcompatibility
#define     oldXMLWDcompatibility

-Global setting, DEPRECATED.

-
-
xmlBufferAllocScheme
#define     xmlBufferAllocScheme

-Global setting, default allocation policy for buffers, default is
-XML_BUFFER_ALLOC_EXACT

-
-
xmlThrDefBufferAllocScheme ()
xmlBufferAllocationScheme xmlThrDefBufferAllocScheme
-                                            (xmlBufferAllocationScheme v);

-
-
v:
-
Returns :
-
-
-
xmlDefaultBufferSize
#define     xmlDefaultBufferSize

-Global setting, default buffer size. Default value is BASE_BUFFER_SIZE

-
-
xmlThrDefDefaultBufferSize ()
int         xmlThrDefDefaultBufferSize      (int v);

-
-
v:
-
Returns :
-
-
-
xmlDefaultSAXHandler
#define     xmlDefaultSAXHandler

-Default SAX version1 handler for XML, builds the DOM tree

-
-
xmlDefaultSAXLocator
#define     xmlDefaultSAXLocator

-The default SAX Locator
-{ getPublicId, getSystemId, getLineNumber, getColumnNumber}

-
-
xmlDoValidityCheckingDefaultValue
#define     xmlDoValidityCheckingDefaultValue

-Global setting, indicate that the parser should work in validating mode.
-Disabled by default.

-
-
xmlThrDefDoValidityCheckingDefaultValue ()
int         xmlThrDefDoValidityCheckingDefaultValue
-                                            (int v);

-
-
v:
-
Returns :
-
-
-
xmlGenericError
#define     xmlGenericError

-Global setting: function used for generic error callbacks

-
-
xmlStructuredError
#define     xmlStructuredError

-Global setting: function used for structured error callbacks

-
-
xmlGenericErrorContext
#define     xmlGenericErrorContext

-Global setting passed to generic error callbacks

-
-
xmlGetWarningsDefaultValue
#define     xmlGetWarningsDefaultValue

-Global setting, indicate that the parser should provide warnings.
-Activated by default.

-
-
xmlThrDefGetWarningsDefaultValue ()
int         xmlThrDefGetWarningsDefaultValue
-                                            (int v);

-
-
v:
-
Returns :
-
-
-
xmlIndentTreeOutput
#define     xmlIndentTreeOutput

-Global setting, asking the serializer to indent the output tree by default
-Enabled by default

-
-
xmlThrDefIndentTreeOutput ()
int         xmlThrDefIndentTreeOutput       (int v);

-
-
v:
-
Returns :
-
-
-
xmlTreeIndentString
#define     xmlTreeIndentString

-The string used to do one-level indent. By default is equal to "  " (two spaces)

-
-
xmlThrDefTreeIndentString ()
const char* xmlThrDefTreeIndentString       (const char *v);

-
-
v:
-
Returns :
-
-
-
xmlKeepBlanksDefaultValue
#define     xmlKeepBlanksDefaultValue

-Global setting, indicate that the parser should keep all blanks
-nodes found in the content
-Activated by default, this is actually needed to have the parser
-conformant to the XML Recommendation, however the option is kept
-for some applications since this was libxml1 default behaviour.

-
-
xmlThrDefKeepBlanksDefaultValue ()
int         xmlThrDefKeepBlanksDefaultValue (int v);

-
-
v:
-
Returns :
-
-
-
xmlLineNumbersDefaultValue
#define     xmlLineNumbersDefaultValue

-Global setting, indicate that the parser should store the line number
-in the content field of elements in the DOM tree. 
-Disabled by default since this may not be safe for old classes of
-applicaton.

-
-
xmlThrDefLineNumbersDefaultValue ()
int         xmlThrDefLineNumbersDefaultValue
-                                            (int v);

-
-
v:
-
Returns :
-
-
-
xmlLoadExtDtdDefaultValue
#define     xmlLoadExtDtdDefaultValue

-Global setting, indicate that the parser should load DTD while not
-validating.
-Disabled by default.

-
-
xmlThrDefLoadExtDtdDefaultValue ()
int         xmlThrDefLoadExtDtdDefaultValue (int v);

-
-
v:
-
Returns :
-
-
-
xmlParserDebugEntities
#define     xmlParserDebugEntities

-Global setting, asking the parser to print out debugging informations.
-while handling entities.
-Disabled by default

-
-
xmlThrDefParserDebugEntities ()
int         xmlThrDefParserDebugEntities    (int v);

-
-
v:
-
Returns :
-
-
-
xmlParserVersion
#define     xmlParserVersion

-Constant string describing the internal version of the library

-
-
xmlPedanticParserDefaultValue
#define     xmlPedanticParserDefaultValue

-Global setting, indicate that the parser be pedantic
-Disabled by default.

-
-
xmlThrDefPedanticParserDefaultValue ()
int         xmlThrDefPedanticParserDefaultValue
-                                            (int v);

-
-
v:
-
Returns :
-
-
-
xmlSaveNoEmptyTags
#define     xmlSaveNoEmptyTags

-Global setting, asking the serializer to not output empty tags
-as <empty/> but <empty></empty>. those two forms are undistinguishable
-once parsed.
-Disabled by default

-
-
xmlThrDefSaveNoEmptyTags ()
int         xmlThrDefSaveNoEmptyTags        (int v);

-
-
v:
-
Returns :
-
-
-
xmlSubstituteEntitiesDefaultValue
#define     xmlSubstituteEntitiesDefaultValue

-Global setting, indicate that the parser should not generate entity
-references but replace them with the actual content of the entity
-Disabled by default, this should be activated when using XPath since
-the XPath data model requires entities replacement and the XPath
-engine does not handle entities references transparently.

-
-
xmlThrDefSubstituteEntitiesDefaultValue ()
int         xmlThrDefSubstituteEntitiesDefaultValue
-                                            (int v);

-
-
v:
-
Returns :
-
-
-
xmlRegisterNodeDefaultValue
#define     xmlRegisterNodeDefaultValue

-
-
xmlDeregisterNodeDefaultValue
#define     xmlDeregisterNodeDefaultValue

-
-
<< treexmlunicode >>

+
+
+Module globals from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module globals from libxml2
Main Menu
Related links
Table of Contents
void	xmlThrDefSetStructuredErrorFunc	(void * ctx, 
				 xmlStructuredErrorFunc handler)

+
void	xmlInitializeGlobalState	(xmlGlobalStatePtr gs)

+
Variable const char * xmlTreeIndentString
+
+
xmlBufferAllocationScheme	xmlThrDefBufferAllocScheme	(xmlBufferAllocationScheme v)

+
Variable int xmlIndentTreeOutput
+
+
int	xmlThrDefPedanticParserDefaultValue	(int v)

+
Variable xmlBufferAllocationScheme xmlBufferAllocScheme
+
+
xmlRegisterNodeFunc	xmlRegisterNodeDefault	(xmlRegisterNodeFunc func)

+
Variable int xmlDefaultBufferSize
+
+
Variable xmlRegisterNodeFunc xmlRegisterNodeDefaultValue
+
+
Variable int xmlGetWarningsDefaultValue
+
+
const char *	xmlThrDefTreeIndentString	(const char * v)

+
Variable xmlSAXHandlerV1 docbDefaultSAXHandler
+
+
Variable void * xmlGenericErrorContext
+
+
int	xmlThrDefDefaultBufferSize	(int v)

+
int	xmlThrDefLoadExtDtdDefaultValue	(int v)

+
Variable xmlDeregisterNodeFunc xmlDeregisterNodeDefaultValue
+
+
Variable xmlGenericErrorFunc xmlGenericError
+
+
xmlDeregisterNodeFunc	xmlDeregisterNodeDefault	(xmlDeregisterNodeFunc func)

+
Variable xmlMallocFunc xmlMalloc
+
+
Variable const char * xmlParserVersion
+
+
Variable xmlStructuredErrorFunc xmlStructuredError
+
+
int	xmlThrDefKeepBlanksDefaultValue	(int v)

+
Variable int xmlSaveNoEmptyTags
+
+
Function type: xmlDeregisterNodeFunc
+void	xmlDeregisterNodeFunc	(xmlNodePtr node)
+
node:


+
Variable int xmlPedanticParserDefaultValue
+
+
Variable int xmlParserDebugEntities
+
+
Typedef xmlGlobalState * xmlGlobalStatePtr
+
+
Variable xmlReallocFunc xmlRealloc
+
+
xmlRegisterNodeFunc	xmlThrDefRegisterNodeDefault	(xmlRegisterNodeFunc func)

+
int	xmlThrDefParserDebugEntities	(int v)

+
Variable xmlStrdupFunc xmlMemStrdup
+
+
Variable xmlSAXHandlerV1 htmlDefaultSAXHandler
+
+
void	xmlThrDefSetGenericErrorFunc	(void * ctx, 
				 xmlGenericErrorFunc handler)

+
Structure xmlGlobalState
struct _xmlGlobalState {
+    const char *	xmlParserVersion
+    xmlSAXLocator	xmlDefaultSAXLocator
+    xmlSAXHandlerV1	xmlDefaultSAXHandler
+    xmlSAXHandlerV1	docbDefaultSAXHandler
+    xmlSAXHandlerV1	htmlDefaultSAXHandler
+    xmlFreeFunc	xmlFree
+    xmlMallocFunc	xmlMalloc
+    xmlStrdupFunc	xmlMemStrdup
+    xmlReallocFunc	xmlRealloc
+    xmlGenericErrorFunc	xmlGenericError
+    xmlStructuredErrorFunc	xmlStructuredError
+    void *	xmlGenericErrorContext
+    int	oldXMLWDcompatibility
+    xmlBufferAllocationScheme	xmlBufferAllocScheme
+    int	xmlDefaultBufferSize
+    int	xmlSubstituteEntitiesDefaultValue
+    int	xmlDoValidityCheckingDefaultValue
+    int	xmlGetWarningsDefaultValue
+    int	xmlKeepBlanksDefaultValue
+    int	xmlLineNumbersDefaultValue
+    int	xmlLoadExtDtdDefaultValue
+    int	xmlParserDebugEntities
+    int	xmlPedanticParserDefaultValue
+    int	xmlSaveNoEmptyTags
+    int	xmlIndentTreeOutput
+    const char *	xmlTreeIndentString
+    xmlRegisterNodeFunc	xmlRegisterNodeDefaultValue
+    xmlDeregisterNodeFunc	xmlDeregisterNodeDefaultValue
+    xmlMallocFunc	xmlMallocAtomic
+    xmlError	xmlLastError
+}

int	xmlThrDefDoValidityCheckingDefaultValue	(int v)

+
void	xmlCleanupGlobals	(void)

+
Variable int xmlDoValidityCheckingDefaultValue
+
+
int	xmlThrDefGetWarningsDefaultValue	(int v)

+
Variable int xmlKeepBlanksDefaultValue
+
+
xmlDeregisterNodeFunc	xmlThrDefDeregisterNodeDefault	(xmlDeregisterNodeFunc func)

+
int	xmlThrDefSubstituteEntitiesDefaultValue	(int v)

+
Function type: xmlRegisterNodeFunc
+void	xmlRegisterNodeFunc	(xmlNodePtr node)
+
node:


+
int	xmlThrDefSaveNoEmptyTags	(int v)

+
Variable xmlMallocFunc xmlMallocAtomic
+
+
int	xmlThrDefIndentTreeOutput	(int v)

+
Variable int xmlSubstituteEntitiesDefaultValue
+
+
Variable int oldXMLWDcompatibility
+
+
Variable xmlFreeFunc xmlFree
+
+
Variable int xmlLoadExtDtdDefaultValue
+
+
Variable xmlError xmlLastError
+
+
void	xmlInitGlobals	(void)

+
Variable int xmlLineNumbersDefaultValue
+
+
int	xmlThrDefLineNumbersDefaultValue	(int v)

+
Variable xmlSAXHandlerV1 xmlDefaultSAXHandler
+
+
Variable xmlSAXLocator xmlDefaultSAXLocator
+
+
Description

+
Function: xmlThrDefSetStructuredErrorFunc
void	xmlThrDefSetStructuredErrorFunc	(void * ctx, 
				 xmlStructuredErrorFunc handler)

+

+
ctx:
handler:
Function: xmlInitializeGlobalState
void	xmlInitializeGlobalState	(xmlGlobalStatePtr gs)

+
xmlInitializeGlobalState() initialize a global state with all the default values of the library.

+
gs:a pointer to a newly allocated global state
Function: xmlThrDefBufferAllocScheme
xmlBufferAllocationScheme	xmlThrDefBufferAllocScheme	(xmlBufferAllocationScheme v)

+

+
v:
Returns:
Function: xmlThrDefPedanticParserDefaultValue
int	xmlThrDefPedanticParserDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlRegisterNodeDefault
xmlRegisterNodeFunc	xmlRegisterNodeDefault	(xmlRegisterNodeFunc func)

+
Registers a callback for node creation

+
func:function pointer to the new RegisterNodeFunc
Returns:the old value of the registration function
Function: xmlThrDefTreeIndentString
const char *	xmlThrDefTreeIndentString	(const char * v)

+

+
v:
Returns:
Function: xmlThrDefDefaultBufferSize
int	xmlThrDefDefaultBufferSize	(int v)

+

+
v:
Returns:
Function: xmlThrDefLoadExtDtdDefaultValue
int	xmlThrDefLoadExtDtdDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlDeregisterNodeDefault
xmlDeregisterNodeFunc	xmlDeregisterNodeDefault	(xmlDeregisterNodeFunc func)

+
Registers a callback for node destruction

+
func:function pointer to the new DeregisterNodeFunc
Returns:the previous value of the deregistration function
Function: xmlThrDefKeepBlanksDefaultValue
int	xmlThrDefKeepBlanksDefaultValue	(int v)

+

+
v:
Returns:

+      
+      
+      
+    
Function: xmlThrDefRegisterNodeDefault
xmlRegisterNodeFunc	xmlThrDefRegisterNodeDefault	(xmlRegisterNodeFunc func)

+

+
func:
Returns:
Function: xmlThrDefParserDebugEntities
int	xmlThrDefParserDebugEntities	(int v)

+

+
v:
Returns:
Function: xmlThrDefSetGenericErrorFunc
void	xmlThrDefSetGenericErrorFunc	(void * ctx, 
				 xmlGenericErrorFunc handler)

+

+
ctx:
handler:

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlThrDefDoValidityCheckingDefaultValue
int	xmlThrDefDoValidityCheckingDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlCleanupGlobals
void	xmlCleanupGlobals	(void)

+

+
Function: xmlThrDefGetWarningsDefaultValue
int	xmlThrDefGetWarningsDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlThrDefDeregisterNodeDefault
xmlDeregisterNodeFunc	xmlThrDefDeregisterNodeDefault	(xmlDeregisterNodeFunc func)

+

+
func:
Returns:
Function: xmlThrDefSubstituteEntitiesDefaultValue
int	xmlThrDefSubstituteEntitiesDefaultValue	(int v)

+

+
v:
Returns:

+      
+      
+      
+    
Function: xmlThrDefSaveNoEmptyTags
int	xmlThrDefSaveNoEmptyTags	(int v)

+

+
v:
Returns:
Function: xmlThrDefIndentTreeOutput
int	xmlThrDefIndentTreeOutput	(int v)

+

+
v:
Returns:
Function: xmlInitGlobals
void	xmlInitGlobals	(void)

+

+
Function: xmlThrDefLineNumbersDefaultValue
int	xmlThrDefLineNumbersDefaultValue	(int v)

+

+
v:
Returns:
Daniel Veillard

diff --git a/doc/html/libxml-hash.html b/doc/html/libxml-hash.html
index 782ce935..57129607 100644
--- a/doc/html/libxml-hash.html
+++ b/doc/html/libxml-hash.html
@@ -1,429 +1,120 @@
-hash
PrevUpHomeGnome XML Library Reference ManualNext
hash
hash — 
Synopsis
+
+
+Module hash from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module hash from libxml2
Main Menu
Related links
Table of Contents
void	xmlHashScanFull	(xmlHashTablePtr table, 
				 xmlHashScannerFull f, 
				 void * data)

+
Function type: xmlHashDeallocator
+void	xmlHashDeallocator	(void * payload, 
				 xmlChar * name)
+
Callback to free data from a hash.
payload:the data in the hash
name:the name associated


+
Function type: xmlHashScannerFull
+void	xmlHashScannerFull	(void * payload, 
				 void * data, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3)
+
Callback when scanning data in a hash with the full scanner.
payload:the data in the hash
data:extra scannner data
name:the name associated
name2:the second name associated
name3:the third name associated


+
xmlHashTablePtr	xmlHashCopy	(xmlHashTablePtr table, 
				 xmlHashCopier f)

+
void	xmlHashScanFull3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 xmlHashScannerFull f, 
				 void * data)

+
int	xmlHashUpdateEntry3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 void * userdata, 
				 xmlHashDeallocator f)

+
void	xmlHashScan	(xmlHashTablePtr table, 
				 xmlHashScanner f, 
				 void * data)

+
void *	xmlHashLookup3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3)

+
void *	xmlHashLookup2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2)

+
int	xmlHashUpdateEntry	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 void * userdata, 
				 xmlHashDeallocator f)

+
int	xmlHashRemoveEntry	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 xmlHashDeallocator f)

+
int	xmlHashRemoveEntry2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 xmlHashDeallocator f)

+
void *	xmlHashQLookup3	(xmlHashTablePtr table, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * prefix2, 
				 const xmlChar * name2, 
				 const xmlChar * prefix3, 
				 const xmlChar * name3)

+
void *	xmlHashQLookup2	(xmlHashTablePtr table, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * prefix2, 
				 const xmlChar * name2)

+
int	xmlHashAddEntry3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 void * userdata)

+
void	xmlHashScan3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 xmlHashScanner f, 
				 void * data)

+
Function type: xmlHashScanner
+void	xmlHashScanner	(void * payload, 
				 void * data, 
				 xmlChar * name)
+
Callback when scanning data in a hash with the simple scanner.
payload:the data in the hash
data:extra scannner data
name:the name associated


+
int	xmlHashAddEntry	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 void * userdata)

+
Function type: xmlHashCopier
+void *	xmlHashCopier	(void * payload, 
				 xmlChar * name)
+
Callback to copy data from a hash.
payload:the data in the hash
name:the name associated
Returns:a copy of the data or NULL in case of error.


+
xmlHashTablePtr	xmlHashCreate	(int size)

+
void	xmlHashFree	(xmlHashTablePtr table, 
				 xmlHashDeallocator f)

+
int	xmlHashUpdateEntry2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 void * userdata, 
				 xmlHashDeallocator f)

+
void *	xmlHashLookup	(xmlHashTablePtr table, 
				 const xmlChar * name)

+
Typedef xmlHashTable * xmlHashTablePtr
 
-
-
-struct      xmlHashTable;
-typedef     xmlHashTablePtr;
-void        (*xmlHashDeallocator)           (void *payload,
-                                             xmlChar *name);
-void*       (*xmlHashCopier)                (void *payload,
-                                             xmlChar *name);
-void        (*xmlHashScanner)               (void *payload,
-                                             void *data,
-                                             xmlChar *name);
-void        (*xmlHashScannerFull)           (void *payload,
-                                             void *data,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);
-xmlHashTablePtr xmlHashCreate               (int size);
-void        xmlHashFree                     (xmlHashTablePtr table,
-                                             xmlHashDeallocator f);
-int         xmlHashAddEntry                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             void *userdata);
-int         xmlHashUpdateEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             void *userdata,
-                                             xmlHashDeallocator f);
-int         xmlHashAddEntry2                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             void *userdata);
-int         xmlHashUpdateEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             void *userdata,
-                                             xmlHashDeallocator f);
-int         xmlHashAddEntry3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             void *userdata);
-int         xmlHashUpdateEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             void *userdata,
-                                             xmlHashDeallocator f);
-int         xmlHashRemoveEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             xmlHashDeallocator f);
-int         xmlHashRemoveEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             xmlHashDeallocator f);
-int         xmlHashRemoveEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashDeallocator f);
-void*       xmlHashLookup                   (xmlHashTablePtr table,
-                                             const xmlChar *name);
-void*       xmlHashLookup2                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2);
-void*       xmlHashLookup3                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);
-void*       xmlHashQLookup                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);
-void*       xmlHashQLookup2                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name2,
-                                             const xmlChar *prefix2);
-void*       xmlHashQLookup3                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name2,
-                                             const xmlChar *prefix2,
-                                             const xmlChar *name3,
-                                             const xmlChar *prefix3);
-xmlHashTablePtr xmlHashCopy                 (xmlHashTablePtr table,
-                                             xmlHashCopier f);
-int         xmlHashSize                     (xmlHashTablePtr table);
-void        xmlHashScan                     (xmlHashTablePtr table,
-                                             xmlHashScanner f,
-                                             void *data);
-void        xmlHashScan3                    (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScanner f,
-                                             void *data);
-void        xmlHashScanFull                 (xmlHashTablePtr table,
-                                             xmlHashScannerFull f,
-                                             void *data);
-void        xmlHashScanFull3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScannerFull f,
-                                             void *data);
-
Description

-
-
Details
struct xmlHashTable
struct xmlHashTable;

-
-
xmlHashTablePtr
typedef xmlHashTable *xmlHashTablePtr;
-

-
-
xmlHashDeallocator ()
void        (*xmlHashDeallocator)           (void *payload,
-                                             xmlChar *name);

-Callback to free data from a hash.

-
-
payload:  the data in the hash
-
name:  the name associated
-
xmlHashCopier ()
void*       (*xmlHashCopier)                (void *payload,
-                                             xmlChar *name);

-Callback to copy data from a hash.

-
-
payload:  the data in the hash
-
name:  the name associated
-
xmlHashScanner ()
void        (*xmlHashScanner)               (void *payload,
-                                             void *data,
-                                             xmlChar *name);

-Callback when scanning data in a hash with the simple scanner.

-
-
payload:  the data in the hash
-
data:  extra scannner data
-
name:  the name associated
-
xmlHashScannerFull ()
void        (*xmlHashScannerFull)           (void *payload,
-                                             void *data,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);

-Callback when scanning data in a hash with the full scanner.

-
-
payload:  the data in the hash
-
data:  extra scannner data
-
name:  the name associated
-
name2:  the second name associated
-
name3:  the third name associated
-
xmlHashCreate ()
xmlHashTablePtr xmlHashCreate               (int size);

-Create a new xmlHashTablePtr.

-
-
size: the size of the hash table
-
Returns :the newly created object, or NULL if an error occured.
-
xmlHashFree ()
void        xmlHashFree                     (xmlHashTablePtr table,
-                                             xmlHashDeallocator f);

-Free the hash table and its contents. The userdata is
-deallocated with f if provided.

-
-
table: the hash table
-
f:  the deallocator function for items in the hash
-
xmlHashAddEntry ()
int         xmlHashAddEntry                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             void *userdata);

-Add the userdata to the hash table. This can later be retrieved
-by using the name. Duplicate names generate errors.

-
-
table: the hash table
-
name: the name of the userdata
-
userdata: a pointer to the userdata
-
Returns :0 the addition succeeded and -1 in case of error.
-
xmlHashUpdateEntry ()
int         xmlHashUpdateEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             void *userdata,
-                                             xmlHashDeallocator f);

-Add the userdata to the hash table. This can later be retrieved
-by using the name. Existing entry for this name will be removed
-and freed with f if found.

-
-
table: the hash table
-
name: the name of the userdata
-
userdata: a pointer to the userdata
-
f: the deallocator function for replaced item (if any)
-
Returns :0 the addition succeeded and -1 in case of error.
-
xmlHashAddEntry2 ()
int         xmlHashAddEntry2                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             void *userdata);

-Add the userdata to the hash table. This can later be retrieved
-by using the (name, name2) tuple. Duplicate tuples generate errors.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
userdata: a pointer to the userdata
-
Returns :0 the addition succeeded and -1 in case of error.
-
xmlHashUpdateEntry2 ()
int         xmlHashUpdateEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             void *userdata,
-                                             xmlHashDeallocator f);

-Add the userdata to the hash table. This can later be retrieved
-by using the (name, name2) tuple. Existing entry for this tuple will
-be removed and freed with f if found.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
userdata: a pointer to the userdata
-
f: the deallocator function for replaced item (if any)
-
Returns :0 the addition succeeded and -1 in case of error.
-
xmlHashAddEntry3 ()
int         xmlHashAddEntry3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             void *userdata);

-Add the userdata to the hash table. This can later be retrieved
-by using the tuple (name, name2, name3). Duplicate entries generate
-errors.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
name3: a third name of the userdata
-
userdata: a pointer to the userdata
-
Returns :0 the addition succeeded and -1 in case of error.
-
xmlHashUpdateEntry3 ()
int         xmlHashUpdateEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             void *userdata,
-                                             xmlHashDeallocator f);

-Add the userdata to the hash table. This can later be retrieved
-by using the tuple (name, name2, name3). Existing entry for this tuple
-will be removed and freed with f if found.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
name3: a third name of the userdata
-
userdata: a pointer to the userdata
-
f: the deallocator function for replaced item (if any)
-
Returns :0 the addition succeeded and -1 in case of error.
-
xmlHashRemoveEntry ()
int         xmlHashRemoveEntry              (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             xmlHashDeallocator f);

-Find the userdata specified by the name and remove
-it from the hash table. Existing userdata for this tuple will be removed
-and freed with f.

-
-
table: the hash table
-
name: the name of the userdata
-
f: the deallocator function for removed item (if any)
-
Returns :0 if the removal succeeded and -1 in case of error or not found.
-
xmlHashRemoveEntry2 ()
int         xmlHashRemoveEntry2             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             xmlHashDeallocator f);

-Find the userdata specified by the (name, name2) tuple and remove
-it from the hash table. Existing userdata for this tuple will be removed
-and freed with f.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
f: the deallocator function for removed item (if any)
-
Returns :0 if the removal succeeded and -1 in case of error or not found.
-
xmlHashRemoveEntry3 ()
int         xmlHashRemoveEntry3             (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashDeallocator f);

-Find the userdata specified by the (name, name2, name3) tuple and remove
-it from the hash table. Existing userdata for this tuple will be removed
-and freed with f.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
name3: a third name of the userdata
-
f: the deallocator function for removed item (if any)
-
Returns :0 if the removal succeeded and -1 in case of error or not found.
-
xmlHashLookup ()
void*       xmlHashLookup                   (xmlHashTablePtr table,
-                                             const xmlChar *name);

-Find the userdata specified by the name.

-
-
table: the hash table
-
name: the name of the userdata
-
xmlHashLookup2 ()
void*       xmlHashLookup2                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2);

-Find the userdata specified by the (name, name2) tuple.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
xmlHashLookup3 ()
void*       xmlHashLookup3                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3);

-Find the userdata specified by the (name, name2, name3) tuple.

-
-
table: the hash table
-
name: the name of the userdata
-
name2: a second name of the userdata
-
name3: a third name of the userdata
-
xmlHashQLookup ()
void*       xmlHashQLookup                  (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);

-Find the userdata specified by the QName prefix:name/name.

-
-
table: the hash table
-
name: the name of the userdata
-
prefix: the prefix of the userdata
-
xmlHashQLookup2 ()
void*       xmlHashQLookup2                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name2,
-                                             const xmlChar *prefix2);

-Find the userdata specified by the QNames tuple

-
-
table: the hash table
-
name: the name of the userdata
-
prefix: the prefix of the userdata
-
name2: a second name of the userdata
-
prefix2: the second prefix of the userdata
-
xmlHashQLookup3 ()
void*       xmlHashQLookup3                 (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name2,
-                                             const xmlChar *prefix2,
-                                             const xmlChar *name3,
-                                             const xmlChar *prefix3);

-Find the userdata specified by the (name, name2, name3) tuple.

-
-
table: the hash table
-
name: the name of the userdata
-
prefix: the prefix of the userdata
-
name2: a second name of the userdata
-
prefix2: the second prefix of the userdata
-
name3: a third name of the userdata
-
prefix3: the third prefix of the userdata
-
xmlHashCopy ()
xmlHashTablePtr xmlHashCopy                 (xmlHashTablePtr table,
-                                             xmlHashCopier f);

-Scan the hash table and applied f to each value.

-
-
table: the hash table
-
f:  the copier function for items in the hash
-
Returns :the new table or NULL in case of error.
-
xmlHashSize ()
int         xmlHashSize                     (xmlHashTablePtr table);

-Query the number of elements installed in the hash table.

-
-
table: the hash table
-
Returns :the number of elements in the hash table or
--1 in case of error
-
xmlHashScan ()
void        xmlHashScan                     (xmlHashTablePtr table,
-                                             xmlHashScanner f,
-                                             void *data);

-Scan the hash table and applied f to each value.

-
-
table: the hash table
-
f:  the scanner function for items in the hash
-
data:  extra data passed to f
-
xmlHashScan3 ()
void        xmlHashScan3                    (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScanner f,
-                                             void *data);

-Scan the hash table and applied f to each value matching
-(name, name2, name3) tuple. If one of the names is null,
-the comparison is considered to match.

-
-
table: the hash table
-
name: the name of the userdata or NULL
-
name2: a second name of the userdata or NULL
-
name3: a third name of the userdata or NULL
-
f:  the scanner function for items in the hash
-
data:  extra data passed to f
-
xmlHashScanFull ()
void        xmlHashScanFull                 (xmlHashTablePtr table,
-                                             xmlHashScannerFull f,
-                                             void *data);

-Scan the hash table and applied f to each value.

-
-
table: the hash table
-
f:  the scanner function for items in the hash
-
data:  extra data passed to f
-
xmlHashScanFull3 ()
void        xmlHashScanFull3                (xmlHashTablePtr table,
-                                             const xmlChar *name,
-                                             const xmlChar *name2,
-                                             const xmlChar *name3,
-                                             xmlHashScannerFull f,
-                                             void *data);

-Scan the hash table and applied f to each value matching
-(name, name2, name3) tuple. If one of the names is null,
-the comparison is considered to match.

-
-
table: the hash table
-
name: the name of the userdata or NULL
-
name2: a second name of the userdata or NULL
-
name3: a third name of the userdata or NULL
-
f:  the scanner function for items in the hash
-
data:  extra data passed to f
-
<< xpointernanohttp >>

+
void *	xmlHashQLookup	(xmlHashTablePtr table, 
				 const xmlChar * prefix, 
				 const xmlChar * name)

+
Structure xmlHashTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}

int	xmlHashAddEntry2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 void * userdata)

+
int	xmlHashRemoveEntry3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 xmlHashDeallocator f)

+
int	xmlHashSize	(xmlHashTablePtr table)

+
Description

+
Function: xmlHashScanFull
void	xmlHashScanFull	(xmlHashTablePtr table, 
				 xmlHashScannerFull f, 
				 void * data)

+
Scan the hash @table and applied @f to each value.

+
table:the hash table
f:the scanner function for items in the hash
data:extra data passed to f

+      Callback to free data from a hash.
+      
+      
+      
+    
+      Callback when scanning data in a hash with the full scanner.
+      
+      
+      
+      
+      
+      
+    
Function: xmlHashCopy
xmlHashTablePtr	xmlHashCopy	(xmlHashTablePtr table, 
				 xmlHashCopier f)

+
Scan the hash @table and applied @f to each value.

+
table:the hash table
f:the copier function for items in the hash
Returns:the new table or NULL in case of error.
Function: xmlHashScanFull3
void	xmlHashScanFull3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 xmlHashScannerFull f, 
				 void * data)

+
Scan the hash @table and applied @f to each value matching (@name, @name2, @name3) tuple. If one of the names is null, the comparison is considered to match.

+
table:the hash table
name:the name of the userdata or NULL
name2:a second name of the userdata or NULL
name3:a third name of the userdata or NULL
f:the scanner function for items in the hash
data:extra data passed to f
Function: xmlHashUpdateEntry3
int	xmlHashUpdateEntry3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 void * userdata, 
				 xmlHashDeallocator f)

+
Add the @userdata to the hash @table. This can later be retrieved by using the tuple (@name, @name2, @name3). Existing entry for this tuple will be removed and freed with @f if found.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
name3:a third name of the userdata
userdata:a pointer to the userdata
f:the deallocator function for replaced item (if any)
Returns:0 the addition succeeded and -1 in case of error.
Function: xmlHashScan
void	xmlHashScan	(xmlHashTablePtr table, 
				 xmlHashScanner f, 
				 void * data)

+
Scan the hash @table and applied @f to each value.

+
table:the hash table
f:the scanner function for items in the hash
data:extra data passed to f
Function: xmlHashLookup3
void *	xmlHashLookup3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3)

+
Find the userdata specified by the (@name, @name2, @name3) tuple.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
name3:a third name of the userdata
Returns:the a pointer to the userdata
Function: xmlHashLookup2
void *	xmlHashLookup2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2)

+
Find the userdata specified by the (@name, @name2) tuple.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
Returns:the pointer to the userdata
Function: xmlHashUpdateEntry
int	xmlHashUpdateEntry	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 void * userdata, 
				 xmlHashDeallocator f)

+
Add the @userdata to the hash @table. This can later be retrieved by using the @name. Existing entry for this @name will be removed and freed with @f if found.

+
table:the hash table
name:the name of the userdata
userdata:a pointer to the userdata
f:the deallocator function for replaced item (if any)
Returns:0 the addition succeeded and -1 in case of error.
Function: xmlHashRemoveEntry
int	xmlHashRemoveEntry	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 xmlHashDeallocator f)

+
Find the userdata specified by the @name and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.

+
table:the hash table
name:the name of the userdata
f:the deallocator function for removed item (if any)
Returns:0 if the removal succeeded and -1 in case of error or not found.
Function: xmlHashRemoveEntry2
int	xmlHashRemoveEntry2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 xmlHashDeallocator f)

+
Find the userdata specified by the (@name, @name2) tuple and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
f:the deallocator function for removed item (if any)
Returns:0 if the removal succeeded and -1 in case of error or not found.
Function: xmlHashQLookup3
void *	xmlHashQLookup3	(xmlHashTablePtr table, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * prefix2, 
				 const xmlChar * name2, 
				 const xmlChar * prefix3, 
				 const xmlChar * name3)

+
Find the userdata specified by the (@name, @name2, @name3) tuple.

+
table:the hash table
prefix:the prefix of the userdata
name:the name of the userdata
prefix2:the second prefix of the userdata
name2:a second name of the userdata
prefix3:the third prefix of the userdata
name3:a third name of the userdata
Returns:the a pointer to the userdata
Function: xmlHashQLookup2
void *	xmlHashQLookup2	(xmlHashTablePtr table, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * prefix2, 
				 const xmlChar * name2)

+
Find the userdata specified by the QNames tuple

+
table:the hash table
prefix:the prefix of the userdata
name:the name of the userdata
prefix2:the second prefix of the userdata
name2:a second name of the userdata
Returns:the pointer to the userdata
Function: xmlHashAddEntry3
int	xmlHashAddEntry3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 void * userdata)

+
Add the @userdata to the hash @table. This can later be retrieved by using the tuple (@name, @name2, @name3). Duplicate entries generate errors.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
name3:a third name of the userdata
userdata:a pointer to the userdata
Returns:0 the addition succeeded and -1 in case of error.
Function: xmlHashScan3
void	xmlHashScan3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 xmlHashScanner f, 
				 void * data)

+
Scan the hash @table and applied @f to each value matching (@name, @name2, @name3) tuple. If one of the names is null, the comparison is considered to match.

+
table:the hash table
name:the name of the userdata or NULL
name2:a second name of the userdata or NULL
name3:a third name of the userdata or NULL
f:the scanner function for items in the hash
data:extra data passed to f

+      Callback when scanning data in a hash with the simple scanner.
+      
+      
+      
+      
+    
Function: xmlHashAddEntry
int	xmlHashAddEntry	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 void * userdata)

+
Add the @userdata to the hash @table. This can later be retrieved by using the @name. Duplicate names generate errors.

+
table:the hash table
name:the name of the userdata
userdata:a pointer to the userdata
Returns:0 the addition succeeded and -1 in case of error.

+      Callback to copy data from a hash.
+      
+      
+      
+    
Function: xmlHashCreate
xmlHashTablePtr	xmlHashCreate	(int size)

+
Create a new xmlHashTablePtr.

+
size:the size of the hash table
Returns:the newly created object, or NULL if an error occured.
Function: xmlHashFree
void	xmlHashFree	(xmlHashTablePtr table, 
				 xmlHashDeallocator f)

+
Free the hash @table and its contents. The userdata is deallocated with @f if provided.

+
table:the hash table
f:the deallocator function for items in the hash
Function: xmlHashUpdateEntry2
int	xmlHashUpdateEntry2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 void * userdata, 
				 xmlHashDeallocator f)

+
Add the @userdata to the hash @table. This can later be retrieved by using the (@name, @name2) tuple. Existing entry for this tuple will be removed and freed with @f if found.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
userdata:a pointer to the userdata
f:the deallocator function for replaced item (if any)
Returns:0 the addition succeeded and -1 in case of error.
Function: xmlHashLookup
void *	xmlHashLookup	(xmlHashTablePtr table, 
				 const xmlChar * name)

+
Find the userdata specified by the @name.

+
table:the hash table
name:the name of the userdata
Returns:the pointer to the userdata
Function: xmlHashQLookup
void *	xmlHashQLookup	(xmlHashTablePtr table, 
				 const xmlChar * prefix, 
				 const xmlChar * name)

+
Find the userdata specified by the QName @prefix:@name/@name.

+
table:the hash table
prefix:the prefix of the userdata
name:the name of the userdata
Returns:the pointer to the userdata
Function: xmlHashAddEntry2
int	xmlHashAddEntry2	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 void * userdata)

+
Add the @userdata to the hash @table. This can later be retrieved by using the (@name, @name2) tuple. Duplicate tuples generate errors.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
userdata:a pointer to the userdata
Returns:0 the addition succeeded and -1 in case of error.
Function: xmlHashRemoveEntry3
int	xmlHashRemoveEntry3	(xmlHashTablePtr table, 
				 const xmlChar * name, 
				 const xmlChar * name2, 
				 const xmlChar * name3, 
				 xmlHashDeallocator f)

+
Find the userdata specified by the (@name, @name2, @name3) tuple and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
name3:a third name of the userdata
f:the deallocator function for removed item (if any)
Returns:0 if the removal succeeded and -1 in case of error or not found.
Function: xmlHashSize
int	xmlHashSize	(xmlHashTablePtr table)

+
Query the number of elements installed in the hash @table.

+
table:the hash table
Returns:the number of elements in the hash table or -1 in case of error
Daniel Veillard

diff --git a/doc/html/libxml-lib.html b/doc/html/libxml-lib.html
deleted file mode 100644
index 1030bd7a..00000000
--- a/doc/html/libxml-lib.html
+++ /dev/null
@@ -1,33 +0,0 @@
-Libxml Library Reference
PrevHomeGnome XML Library Reference ManualNext
Libxml Library Reference
Table of Contents
parser - 
xmlreader - 
SAX - 
tree - 
entities - 
valid - 
relaxng - 
uri - 
xmlerror - 
HTMLparser - 
HTMLtree - 
xpath - 
xpathInternals - 
xpointer - 
xinclude - 
nanohttp - 
nanoftp - 
xmlIO - 
catalog - 
c14n - 
threads - 
globals - 
DOCBparser - 
parserInternals - 
encoding - 
hash - 
debugXML - 
xmlmemory - 
xmlregexp - 
xmlautomata - 
xmlunicode - 
xmlschemas - 
xmlschemastypes - 
schemasInternals - 
This section contains the API reference for libxml. All
-    the public interfaces are documented here. This reference guide is
-    build by extracting comments from the code sources. 
<< Libxml Programming Notesparser >>

diff --git a/doc/html/libxml-list.html b/doc/html/libxml-list.html
index 4867f959..6c0bb6c6 100644
--- a/doc/html/libxml-list.html
+++ b/doc/html/libxml-list.html
@@ -1,269 +1,120 @@
-list
PrevUpHomeGnome XML Library Reference ManualNext
list
list — 
Synopsis
+
+
+Module list from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module list from libxml2
Main Menu
Related links
Table of Contents
Function type: xmlListWalker
+int	xmlListWalker	(const void * data, 
				 const void * user)
+
Callback function used when walking a list with xmlListWalk().
data:the data found in the list
user:extra user provided data to the walker
Returns:0 to stop walking the list, 1 otherwise.


+
Typedef xmlLink * xmlLinkPtr
 
+
void	xmlListReverseWalk	(xmlListPtr l, 
				 xmlListWalker walker, 
				 const void * user)

+
void *	xmlLinkGetData	(xmlLinkPtr lk)

+
int	xmlListInsert	(xmlListPtr l, 
				 void * data)

+
int	xmlListEmpty	(xmlListPtr l)

+
int	xmlListRemoveFirst	(xmlListPtr l, 
				 void * data)

+
xmlLinkPtr	xmlListFront	(xmlListPtr l)

+
void	xmlListSort	(xmlListPtr l)

+
void	xmlListClear	(xmlListPtr l)

+
Function type: xmlListDeallocator
+void	xmlListDeallocator	(xmlLinkPtr lk)
+
Callback function used to free data from a list.
lk:the data to deallocate


+
Structure xmlList
struct _xmlList {
+The content of this structure is not made public by the API.
+}

Structure xmlLink
struct _xmlLink {
+The content of this structure is not made public by the API.
+}

xmlListPtr	xmlListCreate	(xmlListDeallocator deallocator, 
				 xmlListDataCompare compare)

+
int	xmlListAppend	(xmlListPtr l, 
				 void * data)

+
int	xmlListRemoveAll	(xmlListPtr l, 
				 void * data)

+
xmlListPtr	xmlListDup	(const xmlListPtr old)

+
Typedef xmlList * xmlListPtr
 
+
int	xmlListRemoveLast	(xmlListPtr l, 
				 void * data)

+
void	xmlListWalk	(xmlListPtr l, 
				 xmlListWalker walker, 
				 const void * user)

+
void	xmlListReverse	(xmlListPtr l)

+
Function type: xmlListDataCompare
+int	xmlListDataCompare	(const void * data0, 
				 const void * data1)
+
Callback function used to compare 2 data.
data0:the first data
data1:the second data
Returns:0 is equality, -1 or 1 otherwise depending on the ordering.


+
int	xmlListSize	(xmlListPtr l)

+
int	xmlListPushFront	(xmlListPtr l, 
				 void * data)

+
xmlLinkPtr	xmlListEnd	(xmlListPtr l)

+
int	xmlListCopy	(xmlListPtr cur, 
				 const xmlListPtr old)

+
void	xmlListPopBack	(xmlListPtr l)

+
int	xmlListPushBack	(xmlListPtr l, 
				 void * data)

+
void	xmlListPopFront	(xmlListPtr l)

+
void	xmlListDelete	(xmlListPtr l)

+
void *	xmlListReverseSearch	(xmlListPtr l, 
				 void * data)

+
void *	xmlListSearch	(xmlListPtr l, 
				 void * data)

+
void	xmlListMerge	(xmlListPtr l1, 
				 xmlListPtr l2)

+
Description

 
-struct      xmlLink;
-typedef     xmlLinkPtr;
-struct      xmlList;
-typedef     xmlListPtr;
-void        (*xmlListDeallocator)           (xmlLinkPtr lk);
-int         (*xmlListDataCompare)           (const void *data0,
-                                             const void *data1);
-int         (*xmlListWalker)                (const void *data,
-                                             const void *user);
-xmlListPtr  xmlListCreate                   (xmlListDeallocator deallocator,
-                                             xmlListDataCompare compare);
-void        xmlListDelete                   (xmlListPtr l);
-void*       xmlListSearch                   (xmlListPtr l,
-                                             void *data);
-void*       xmlListReverseSearch            (xmlListPtr l,
-                                             void *data);
-int         xmlListInsert                   (xmlListPtr l,
-                                             void *data);
-int         xmlListAppend                   (xmlListPtr l,
-                                             void *data);
-int         xmlListRemoveFirst              (xmlListPtr l,
-                                             void *data);
-int         xmlListRemoveLast               (xmlListPtr l,
-                                             void *data);
-int         xmlListRemoveAll                (xmlListPtr l,
-                                             void *data);
-void        xmlListClear                    (xmlListPtr l);
-int         xmlListEmpty                    (xmlListPtr l);
-xmlLinkPtr  xmlListFront                    (xmlListPtr l);
-xmlLinkPtr  xmlListEnd                      (xmlListPtr l);
-int         xmlListSize                     (xmlListPtr l);
-void        xmlListPopFront                 (xmlListPtr l);
-void        xmlListPopBack                  (xmlListPtr l);
-int         xmlListPushFront                (xmlListPtr l,
-                                             void *data);
-int         xmlListPushBack                 (xmlListPtr l,
-                                             void *data);
-void        xmlListReverse                  (xmlListPtr l);
-void        xmlListSort                     (xmlListPtr l);
-void        xmlListWalk                     (xmlListPtr l,
-                                             xmlListWalker walker,
-                                             const void *user);
-void        xmlListReverseWalk              (xmlListPtr l,
-                                             xmlListWalker walker,
-                                             const void *user);
-void        xmlListMerge                    (xmlListPtr l1,
-                                             xmlListPtr l2);
-xmlListPtr  xmlListDup                      (const xmlListPtr old);
-int         xmlListCopy                     (xmlListPtr cur,
-                                             const xmlListPtr old);
-void*       xmlLinkGetData                  (xmlLinkPtr lk);
-
Description

-
-
Details
struct xmlLink
struct xmlLink;

-
-
xmlLinkPtr
typedef xmlLink *xmlLinkPtr;
-

-
-
struct xmlList
struct xmlList;

-
-
xmlListPtr
typedef xmlList *xmlListPtr;
-

-
-
xmlListDeallocator ()
void        (*xmlListDeallocator)           (xmlLinkPtr lk);

-Callback function used to free data from a list.

-
-
lk:  the data to deallocate
-
xmlListDataCompare ()
int         (*xmlListDataCompare)           (const void *data0,
-                                             const void *data1);

-Callback function used to compare 2 data.

-
-
data0: the first data
-
data1: the second data
-
Returns :0 is equality, -1 or 1 otherwise depending on the ordering.
-
xmlListWalker ()
int         (*xmlListWalker)                (const void *data,
-                                             const void *user);

-Callback function used when walking a list with xmlListWalk().

-
-
data: the data found in the list
-
user: extra user provided data to the walker
-
Returns :0 to stop walking the list, 1 otherwise.
-
xmlListCreate ()
xmlListPtr  xmlListCreate                   (xmlListDeallocator deallocator,
-                                             xmlListDataCompare compare);

-Create a new list

-
-
deallocator:  an optional deallocator function
-
compare:  an optional comparison function
-
Returns :the new list or NULL in case of error
-
xmlListDelete ()
void        xmlListDelete                   (xmlListPtr l);

-Deletes the list and its associated data

-
-
l:  a list
-
xmlListSearch ()
void*       xmlListSearch                   (xmlListPtr l,
-                                             void *data);

-Search the list for an existing value of data

-
-
l:  a list
-
data:  a search value
-
xmlListReverseSearch ()
void*       xmlListReverseSearch            (xmlListPtr l,
-                                             void *data);

-Search the list in reverse order for an existing value of data

-
-
l:  a list
-
data:  a search value
-
xmlListInsert ()
int         xmlListInsert                   (xmlListPtr l,
-                                             void *data);

-Insert data in the ordered list at the beginning for this value

-
-
l:  a list
-
data:  the data
-
Returns :0 in case of success, 1 in case of failure
-
xmlListAppend ()
int         xmlListAppend                   (xmlListPtr l,
-                                             void *data);

-Insert data in the ordered list at the end for this value

-
-
l:  a list
-
data:  the data
-
Returns :0 in case of success, 1 in case of failure
-
xmlListRemoveFirst ()
int         xmlListRemoveFirst              (xmlListPtr l,
-                                             void *data);

-Remove the first instance associated to data in the list

-
-
l:  a list
-
data:  list data
-
Returns :1 if a deallocation occured, or 0 if not found
-
xmlListRemoveLast ()
int         xmlListRemoveLast               (xmlListPtr l,
-                                             void *data);

-Remove the last instance associated to data in the list

-
-
l:  a list
-
data:  list data
-
Returns :1 if a deallocation occured, or 0 if not found
-
xmlListRemoveAll ()
int         xmlListRemoveAll                (xmlListPtr l,
-                                             void *data);

-Remove the all instance associated to data in the list

-
-
l:  a list
-
data:  list data
-
Returns :the number of deallocation, or 0 if not found
-
xmlListClear ()
void        xmlListClear                    (xmlListPtr l);

-Remove the all data in the list

-
-
l:  a list
-
xmlListEmpty ()
int         xmlListEmpty                    (xmlListPtr l);

-Is the list empty ?

-
-
l:  a list
-
Returns :1 if the list is empty, 0 otherwise
-
xmlListFront ()
xmlLinkPtr  xmlListFront                    (xmlListPtr l);

-Get the first element in the list

-
-
l:  a list
-
Returns :the first element in the list, or NULL
-
xmlListEnd ()
xmlLinkPtr  xmlListEnd                      (xmlListPtr l);

-Get the last element in the list

-
-
l:  a list
-
Returns :the last element in the list, or NULL
-
xmlListSize ()
int         xmlListSize                     (xmlListPtr l);

-Get the number of elements in the list

-
-
l:  a list
-
Returns :the number of elements in the list
-
xmlListPopFront ()
void        xmlListPopFront                 (xmlListPtr l);

-Removes the first element in the list

-
-
l:  a list
-
xmlListPopBack ()
void        xmlListPopBack                  (xmlListPtr l);

-Removes the last element in the list

-
-
l:  a list
-
xmlListPushFront ()
int         xmlListPushFront                (xmlListPtr l,
-                                             void *data);

-add the new data at the beginning of the list

-
-
l:  a list
-
data:  new data
-
Returns :1 if successful, 0 otherwise
-
xmlListPushBack ()
int         xmlListPushBack                 (xmlListPtr l,
-                                             void *data);

-add the new data at the end of the list

-
-
l:  a list
-
data:  new data
-
Returns :1 if successful, 0 otherwise
-
xmlListReverse ()
void        xmlListReverse                  (xmlListPtr l);

-Reverse the order of the elements in the list

-
-
l:  a list
-
xmlListSort ()
void        xmlListSort                     (xmlListPtr l);

-Sort all the elements in the list

-
-
l:  a list
-
xmlListWalk ()
void        xmlListWalk                     (xmlListPtr l,
-                                             xmlListWalker walker,
-                                             const void *user);

-Walk all the element of the first from first to last and
-apply the walker function to it

-
-
l:  a list
-
walker:  a processing function
-
user:  a user parameter passed to the walker function
-
xmlListReverseWalk ()
void        xmlListReverseWalk              (xmlListPtr l,
-                                             xmlListWalker walker,
-                                             const void *user);

-Walk all the element of the list in reverse order and
-apply the walker function to it

-
-
l:  a list
-
walker:  a processing function
-
user:  a user parameter passed to the walker function
-
xmlListMerge ()
void        xmlListMerge                    (xmlListPtr l1,
-                                             xmlListPtr l2);

-include all the elements of the second list in the first one and
-clear the second list

-
-
l1:  the original list
-
l2:  the new list
-
xmlListDup ()
xmlListPtr  xmlListDup                      (const xmlListPtr old);

-Duplicate the list

-
-
old:  the list
-
Returns :a new copy of the list or NULL in case of error
-
xmlListCopy ()
int         xmlListCopy                     (xmlListPtr cur,
-                                             const xmlListPtr old);

-Move all the element from the old list in the new list

-
-
cur:  the new list
-
old:  the old list
-
Returns :0 in case of success 1 in case of error
-
xmlLinkGetData ()
void*       xmlLinkGetData                  (xmlLinkPtr lk);

-See Returns.

-
-
lk:  a link
-
<< xmlversionHTMLtree >>

+      Callback function used when walking a list with xmlListWalk().
+      
+      
+      
+    
Function: xmlListReverseWalk
void	xmlListReverseWalk	(xmlListPtr l, 
				 xmlListWalker walker, 
				 const void * user)

+
Walk all the element of the list in reverse order and apply the walker function to it

+
l:a list
walker:a processing function
user:a user parameter passed to the walker function
Function: xmlLinkGetData
void *	xmlLinkGetData	(xmlLinkPtr lk)

+
See Returns.

+
lk:a link
Returns:a pointer to the data referenced from this link
Function: xmlListInsert
int	xmlListInsert	(xmlListPtr l, 
				 void * data)

+
Insert data in the ordered list at the beginning for this value

+
l:a list
data:the data
Returns:0 in case of success, 1 in case of failure
Function: xmlListEmpty
int	xmlListEmpty	(xmlListPtr l)

+
Is the list empty ?

+
l:a list
Returns:1 if the list is empty, 0 otherwise
Function: xmlListRemoveFirst
int	xmlListRemoveFirst	(xmlListPtr l, 
				 void * data)

+
Remove the first instance associated to data in the list

+
l:a list
data:list data
Returns:1 if a deallocation occured, or 0 if not found
Function: xmlListFront
xmlLinkPtr	xmlListFront	(xmlListPtr l)

+
Get the first element in the list

+
l:a list
Returns:the first element in the list, or NULL
Function: xmlListSort
void	xmlListSort	(xmlListPtr l)

+
Sort all the elements in the list

+
l:a list
Function: xmlListClear
void	xmlListClear	(xmlListPtr l)

+
Remove the all data in the list

+
l:a list

+      Callback function used to free data from a list.
+      
+      
+    
Function: xmlListCreate
xmlListPtr	xmlListCreate	(xmlListDeallocator deallocator, 
				 xmlListDataCompare compare)

+
Create a new list

+
deallocator:an optional deallocator function
compare:an optional comparison function
Returns:the new list or NULL in case of error
Function: xmlListAppend
int	xmlListAppend	(xmlListPtr l, 
				 void * data)

+
Insert data in the ordered list at the end for this value

+
l:a list
data:the data
Returns:0 in case of success, 1 in case of failure
Function: xmlListRemoveAll
int	xmlListRemoveAll	(xmlListPtr l, 
				 void * data)

+
Remove the all instance associated to data in the list

+
l:a list
data:list data
Returns:the number of deallocation, or 0 if not found
Function: xmlListDup
xmlListPtr	xmlListDup	(const xmlListPtr old)

+
Duplicate the list

+
old:the list
Returns:a new copy of the list or NULL in case of error
Function: xmlListRemoveLast
int	xmlListRemoveLast	(xmlListPtr l, 
				 void * data)

+
Remove the last instance associated to data in the list

+
l:a list
data:list data
Returns:1 if a deallocation occured, or 0 if not found
Function: xmlListWalk
void	xmlListWalk	(xmlListPtr l, 
				 xmlListWalker walker, 
				 const void * user)

+
Walk all the element of the first from first to last and apply the walker function to it

+
l:a list
walker:a processing function
user:a user parameter passed to the walker function
Function: xmlListReverse
void	xmlListReverse	(xmlListPtr l)

+
Reverse the order of the elements in the list

+
l:a list

+      Callback function used to compare 2 data.
+      
+      
+      
+    
Function: xmlListSize
int	xmlListSize	(xmlListPtr l)

+
Get the number of elements in the list

+
l:a list
Returns:the number of elements in the list
Function: xmlListPushFront
int	xmlListPushFront	(xmlListPtr l, 
				 void * data)

+
add the new data at the beginning of the list

+
l:a list
data:new data
Returns:1 if successful, 0 otherwise
Function: xmlListEnd
xmlLinkPtr	xmlListEnd	(xmlListPtr l)

+
Get the last element in the list

+
l:a list
Returns:the last element in the list, or NULL
Function: xmlListCopy
int	xmlListCopy	(xmlListPtr cur, 
				 const xmlListPtr old)

+
Move all the element from the old list in the new list

+
cur:the new list
old:the old list
Returns:0 in case of success 1 in case of error
Function: xmlListPopBack
void	xmlListPopBack	(xmlListPtr l)

+
Removes the last element in the list

+
l:a list
Function: xmlListPushBack
int	xmlListPushBack	(xmlListPtr l, 
				 void * data)

+
add the new data at the end of the list

+
l:a list
data:new data
Returns:1 if successful, 0 otherwise
Function: xmlListPopFront
void	xmlListPopFront	(xmlListPtr l)

+
Removes the first element in the list

+
l:a list
Function: xmlListDelete
void	xmlListDelete	(xmlListPtr l)

+
Deletes the list and its associated data

+
l:a list
Function: xmlListReverseSearch
void *	xmlListReverseSearch	(xmlListPtr l, 
				 void * data)

+
Search the list in reverse order for an existing value of @data

+
l:a list
data:a search value
Returns:the value associated to @data or NULL in case of error
Function: xmlListSearch
void *	xmlListSearch	(xmlListPtr l, 
				 void * data)

+
Search the list for an existing value of @data

+
l:a list
data:a search value
Returns:the value associated to @data or NULL in case of error
Function: xmlListMerge
void	xmlListMerge	(xmlListPtr l1, 
				 xmlListPtr l2)

+
include all the elements of the second list in the first one and clear the second list

+
l1:the original list
l2:the new list
Daniel Veillard

diff --git a/doc/html/libxml-nanoftp.html b/doc/html/libxml-nanoftp.html
index 6b04db5d..52f85e5d 100644
--- a/doc/html/libxml-nanoftp.html
+++ b/doc/html/libxml-nanoftp.html
@@ -1,276 +1,104 @@
-nanoftp
PrevUpHomeGnome XML Library Reference ManualNext
nanoftp
nanoftp — 
Synopsis
-
-
-
-void        (*ftpListCallback)              (void *userData,
-                                             const char *filename,
-                                             const char *attrib,
-                                             const char *owner,
-                                             const char *group,
-                                             unsigned long size,
-                                             int links,
-                                             int year,
-                                             const char *month,
-                                             int day,
-                                             int hour,
-                                             int minute);
-void        (*ftpDataCallback)              (void *userData,
-                                             const char *data,
-                                             int len);
-void        xmlNanoFTPInit                  (void);
-void        xmlNanoFTPCleanup               (void);
-void*       xmlNanoFTPNewCtxt               (const char *URL);
-void        xmlNanoFTPFreeCtxt              (void *ctx);
-void*       xmlNanoFTPConnectTo             (const char *server,
-                                             int port);
-void*       xmlNanoFTPOpen                  (const char *URL);
-int         xmlNanoFTPConnect               (void *ctx);
-int         xmlNanoFTPClose                 (void *ctx);
-int         xmlNanoFTPQuit                  (void *ctx);
-void        xmlNanoFTPScanProxy             (const char *URL);
-void        xmlNanoFTPProxy                 (const char *host,
-                                             int port,
-                                             const char *user,
-                                             const char *passwd,
-                                             int type);
-int         xmlNanoFTPUpdateURL             (void *ctx,
-                                             const char *URL);
-int         xmlNanoFTPGetResponse           (void *ctx);
-int         xmlNanoFTPCheckResponse         (void *ctx);
-int         xmlNanoFTPCwd                   (void *ctx,
-                                             char *directory);
-int         xmlNanoFTPDele                  (void *ctx,
-                                             char *file);
-int         xmlNanoFTPGetConnection         (void *ctx);
-int         xmlNanoFTPCloseConnection       (void *ctx);
-int         xmlNanoFTPList                  (void *ctx,
-                                             ftpListCallback callback,
-                                             void *userData,
-                                             char *filename);
-int         xmlNanoFTPGetSocket             (void *ctx,
-                                             const char *filename);
-int         xmlNanoFTPGet                   (void *ctx,
-                                             ftpDataCallback callback,
-                                             void *userData,
-                                             const char *filename);
-int         xmlNanoFTPRead                  (void *ctx,
-                                             void *dest,
-                                             int len);
-
Description

-
-
Details
ftpListCallback ()
void        (*ftpListCallback)              (void *userData,
-                                             const char *filename,
-                                             const char *attrib,
-                                             const char *owner,
-                                             const char *group,
-                                             unsigned long size,
-                                             int links,
-                                             int year,
-                                             const char *month,
-                                             int day,
-                                             int hour,
-                                             int minute);

-A callback for the xmlNanoFTPList command.
-Note that only one of year and day:minute are specified.

-
-
userData:  user provided data for the callback
-
filename:  the file name (including "->" when links are shown)
-
attrib:  the attribute string
-
owner:  the owner string
-
group:  the group string
-
Param6:
-
links:  the link count
-
year:  the year
-
month:  the month
-
day:  the day
-
hour:  the hour
-
minute:  the minute
-
ftpDataCallback ()
void        (*ftpDataCallback)              (void *userData,
-                                             const char *data,
-                                             int len);

-A callback for the xmlNanoFTPGet command.

-
-
userData: the user provided context
-
data: the data received
-
len: its size in bytes
-
xmlNanoFTPInit ()
void        xmlNanoFTPInit                  (void);

-Initialize the FTP protocol layer.
-Currently it just checks for proxy informations,
-and get the hostname

-
-
xmlNanoFTPCleanup ()
void        xmlNanoFTPCleanup               (void);

-Cleanup the FTP protocol layer. This cleanup proxy informations.

-
-
xmlNanoFTPNewCtxt ()
void*       xmlNanoFTPNewCtxt               (const char *URL);

-Allocate and initialize a new FTP context.

-
-
URL:  The URL used to initialize the context
-
xmlNanoFTPFreeCtxt ()
void        xmlNanoFTPFreeCtxt              (void *ctx);

-Frees the context after closing the connection.

-
-
ctx:  an FTP context
-
xmlNanoFTPConnectTo ()
void*       xmlNanoFTPConnectTo             (const char *server,
-                                             int port);

-Tries to open a control connection to the given server/port

-
-
server:  an FTP server name
-
port:  the port (use 21 if 0)
-
xmlNanoFTPOpen ()
void*       xmlNanoFTPOpen                  (const char *URL);

-Start to fetch the given ftp:// resource

-
-
URL: the URL to the resource
-
xmlNanoFTPConnect ()
int         xmlNanoFTPConnect               (void *ctx);

-Tries to open a control connection

-
-
ctx:  an FTP context
-
Returns :-1 in case of error, 0 otherwise
-
xmlNanoFTPClose ()
int         xmlNanoFTPClose                 (void *ctx);

-Close the connection and both control and transport

-
-
ctx: an FTP context
-
Returns :-1 incase of error, 0 otherwise
-
xmlNanoFTPQuit ()
int         xmlNanoFTPQuit                  (void *ctx);

-Send a QUIT command to the server

-
-
ctx:  an FTP context
-
Returns :-1 in case of error, 0 otherwise
-
xmlNanoFTPScanProxy ()
void        xmlNanoFTPScanProxy             (const char *URL);

-(Re)Initialize the FTP Proxy context by parsing the URL and finding
-the protocol host port it indicates.
-Should be like ftp://myproxy/ or ftp://myproxy:3128/
-A NULL URL cleans up proxy informations.

-
-
URL:  The proxy URL used to initialize the proxy context
-
xmlNanoFTPProxy ()
void        xmlNanoFTPProxy                 (const char *host,
-                                             int port,
-                                             const char *user,
-                                             const char *passwd,
-                                             int type);

-Setup the FTP proxy informations.
-This can also be done by using ftp_proxy ftp_proxy_user and
-ftp_proxy_password environment variables.

-
-
host:  the proxy host name
-
port:  the proxy port
-
user:  the proxy user name
-
passwd:  the proxy password
-
type:  the type of proxy 1 for using SITE, 2 for USER ab
-
xmlNanoFTPUpdateURL ()
int         xmlNanoFTPUpdateURL             (void *ctx,
-                                             const char *URL);

-Update an FTP context by parsing the URL and finding
-new path it indicates. If there is an error in the 
-protocol, hostname, port or other information, the
-error is raised. It indicates a new connection has to
-be established.

-
-
ctx:  an FTP context
-
URL:  The URL used to update the context
-
Returns :0 if Ok, -1 in case of error (other host).
-
xmlNanoFTPGetResponse ()
int         xmlNanoFTPGetResponse           (void *ctx);

-Get the response from the FTP server after a command.

-
-
ctx:  an FTP context
-
Returns :the code number
-
xmlNanoFTPCheckResponse ()
int         xmlNanoFTPCheckResponse         (void *ctx);

-Check if there is a response from the FTP server after a command.

-
-
ctx:  an FTP context
-
Returns :the code number, or 0
-
xmlNanoFTPCwd ()
int         xmlNanoFTPCwd                   (void *ctx,
-                                             char *directory);

-Tries to change the remote directory

-
-
ctx:  an FTP context
-
directory:  a directory on the server
-
Returns :-1 incase of error, 1 if CWD worked, 0 if it failed
-
xmlNanoFTPDele ()
int         xmlNanoFTPDele                  (void *ctx,
-                                             char *file);

-Tries to delete an item (file or directory) from server

-
-
ctx:  an FTP context
-
file:  a file or directory on the server
-
Returns :-1 incase of error, 1 if DELE worked, 0 if it failed
-
xmlNanoFTPGetConnection ()
int         xmlNanoFTPGetConnection         (void *ctx);

-Try to open a data connection to the server. Currently only
-passive mode is supported.

-
-
ctx:  an FTP context
-
Returns :-1 incase of error, 0 otherwise
-
xmlNanoFTPCloseConnection ()
int         xmlNanoFTPCloseConnection       (void *ctx);

-Close the data connection from the server

-
-
ctx:  an FTP context
-
Returns :-1 incase of error, 0 otherwise
-
xmlNanoFTPList ()
int         xmlNanoFTPList                  (void *ctx,
-                                             ftpListCallback callback,
-                                             void *userData,
-                                             char *filename);

-Do a listing on the server. All files info are passed back
-in the callbacks.

-
-
ctx:  an FTP context
-
callback:  the user callback
-
userData:  the user callback data
-
filename:  optional files to list
-
Returns :-1 incase of error, 0 otherwise
-
xmlNanoFTPGetSocket ()
int         xmlNanoFTPGetSocket             (void *ctx,
-                                             const char *filename);

-Initiate fetch of the given file from the server.

-
-
ctx:  an FTP context
-
filename:  the file to retrieve (or NULL if path is in context).
-
Returns :the socket for the data connection, or <0 in case of error
-
xmlNanoFTPGet ()
int         xmlNanoFTPGet                   (void *ctx,
-                                             ftpDataCallback callback,
-                                             void *userData,
-                                             const char *filename);

-Fetch the given file from the server. All data are passed back
-in the callbacks. The last callback has a size of 0 block.

-
-
ctx:  an FTP context
-
callback:  the user callback
-
userData:  the user callback data
-
filename:  the file to retrieve
-
Returns :-1 incase of error, 0 otherwise
-
xmlNanoFTPRead ()
int         xmlNanoFTPRead                  (void *ctx,
-                                             void *dest,
-                                             int len);

-This function tries to read len bytes from the existing FTP connection
-and saves them in dest. This is a blocking call.

-
-
ctx:  the FTP context
-
dest:  a buffer
-
len:  the buffer length
-
Returns :the number of byte read. 0 is an indication of an end of connection.
-        -1 indicates a parameter error.
-
<< SAX2schemasInternals >>

+
+
+Module nanoftp from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module nanoftp from libxml2
Main Menu
Related links
Table of Contents
void	xmlNanoFTPScanProxy	(const char * URL)

+
int	xmlNanoFTPQuit	(void * ctx)

+
int	xmlNanoFTPClose	(void * ctx)

+
Function type: ftpDataCallback
+void	ftpDataCallback	(void * userData, 
				 const char * data, 
				 int len)
+
A callback for the xmlNanoFTPGet command.
userData:the user provided context
data:the data received
len:its size in bytes


+
int	xmlNanoFTPGetResponse	(void * ctx)

+
Function type: ftpListCallback
+void	ftpListCallback	(void * userData, 
				 const char * filename, 
				 const char * attrib, 
				 const char * owner, 
				 const char * group, 
				 unsigned long size, 
				 int links, 
				 int year, 
				 const char * month, 
				 int day, 
				 int hour, 
				 int minute)
+
A callback for the xmlNanoFTPList command. Note that only one of year and day:minute are specified.
userData:user provided data for the callback
filename:the file name (including "->" when links are shown)
attrib:the attribute string
owner:the owner string
group:the group string
size:the file size
links:the link count
year:the year
month:the month
day:the day
hour:the hour
minute:the minute


+
int	xmlNanoFTPCwd	(void * ctx, 
				 char * directory)

+
int	xmlNanoFTPCloseConnection	(void * ctx)

+
void	xmlNanoFTPProxy	(const char * host, 
				 int port, 
				 const char * user, 
				 const char * passwd, 
				 int type)

+
void	xmlNanoFTPInit	(void)

+
void *	xmlNanoFTPConnectTo	(const char * server, 
				 int port)

+
int	xmlNanoFTPList	(void * ctx, 
				 ftpListCallback callback, 
				 void * userData, 
				 char * filename)

+
int	xmlNanoFTPUpdateURL	(void * ctx, 
				 const char * URL)

+
void *	xmlNanoFTPOpen	(const char * URL)

+
int	xmlNanoFTPConnect	(void * ctx)

+
int	xmlNanoFTPDele	(void * ctx, 
				 char * file)

+
int	xmlNanoFTPGet	(void * ctx, 
				 ftpDataCallback callback, 
				 void * userData, 
				 const char * filename)

+
int	xmlNanoFTPGetSocket	(void * ctx, 
				 const char * filename)

+
void *	xmlNanoFTPNewCtxt	(const char * URL)

+
int	xmlNanoFTPCheckResponse	(void * ctx)

+
int	xmlNanoFTPRead	(void * ctx, 
				 void * dest, 
				 int len)

+
void	xmlNanoFTPFreeCtxt	(void * ctx)

+
void	xmlNanoFTPCleanup	(void)

+
int	xmlNanoFTPGetConnection	(void * ctx)

+
Description

+
Function: xmlNanoFTPScanProxy
void	xmlNanoFTPScanProxy	(const char * URL)

+
(Re)Initialize the FTP Proxy context by parsing the URL and finding the protocol host port it indicates. Should be like ftp://myproxy/ or ftp://myproxy:3128/ A NULL URL cleans up proxy informations.

+
URL:The proxy URL used to initialize the proxy context
Function: xmlNanoFTPQuit
int	xmlNanoFTPQuit	(void * ctx)

+
Send a QUIT command to the server

+
ctx:an FTP context
Returns:-1 in case of error, 0 otherwise
Function: xmlNanoFTPClose
int	xmlNanoFTPClose	(void * ctx)

+
Close the connection and both control and transport

+
ctx:an FTP context
Returns:-1 incase of error, 0 otherwise

+      A callback for the xmlNanoFTPGet command.
+      
+      
+      
+      
+    
Function: xmlNanoFTPGetResponse
int	xmlNanoFTPGetResponse	(void * ctx)

+
Get the response from the FTP server after a command.

+
ctx:an FTP context
Returns:the code number

+      A callback for the xmlNanoFTPList command. Note that only one of year and day:minute are specified.
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlNanoFTPCwd
int	xmlNanoFTPCwd	(void * ctx, 
				 char * directory)

+
Tries to change the remote directory

+
ctx:an FTP context
directory:a directory on the server
Returns:-1 incase of error, 1 if CWD worked, 0 if it failed
Function: xmlNanoFTPCloseConnection
int	xmlNanoFTPCloseConnection	(void * ctx)

+
Close the data connection from the server

+
ctx:an FTP context
Returns:-1 incase of error, 0 otherwise
Function: xmlNanoFTPProxy
void	xmlNanoFTPProxy	(const char * host, 
				 int port, 
				 const char * user, 
				 const char * passwd, 
				 int type)

+
Setup the FTP proxy informations. This can also be done by using ftp_proxy ftp_proxy_user and ftp_proxy_password environment variables.

+
host:the proxy host name
port:the proxy port
user:the proxy user name
passwd:the proxy password
type:the type of proxy 1 for using SITE, 2 for USER a@b
Function: xmlNanoFTPInit
void	xmlNanoFTPInit	(void)

+
Initialize the FTP protocol layer. Currently it just checks for proxy informations, and get the hostname

+
Function: xmlNanoFTPConnectTo
void *	xmlNanoFTPConnectTo	(const char * server, 
				 int port)

+
Tries to open a control connection to the given server/port

+
server:an FTP server name
port:the port (use 21 if 0)
Returns:an fTP context or NULL if it failed
Function: xmlNanoFTPList
int	xmlNanoFTPList	(void * ctx, 
				 ftpListCallback callback, 
				 void * userData, 
				 char * filename)

+
Do a listing on the server. All files info are passed back in the callbacks.

+
ctx:an FTP context
callback:the user callback
userData:the user callback data
filename:optional files to list
Returns:-1 incase of error, 0 otherwise
Function: xmlNanoFTPUpdateURL
int	xmlNanoFTPUpdateURL	(void * ctx, 
				 const char * URL)

+
Update an FTP context by parsing the URL and finding new path it indicates. If there is an error in the protocol, hostname, port or other information, the error is raised. It indicates a new connection has to be established.

+
ctx:an FTP context
URL:The URL used to update the context
Returns:0 if Ok, -1 in case of error (other host).
Function: xmlNanoFTPOpen
void *	xmlNanoFTPOpen	(const char * URL)

+
Start to fetch the given ftp:// resource

+
URL:the URL to the resource
Returns:an FTP context, or NULL
Function: xmlNanoFTPConnect
int	xmlNanoFTPConnect	(void * ctx)

+
Tries to open a control connection

+
ctx:an FTP context
Returns:-1 in case of error, 0 otherwise
Function: xmlNanoFTPDele
int	xmlNanoFTPDele	(void * ctx, 
				 char * file)

+
Tries to delete an item (file or directory) from server

+
ctx:an FTP context
file:a file or directory on the server
Returns:-1 incase of error, 1 if DELE worked, 0 if it failed
Function: xmlNanoFTPGet
int	xmlNanoFTPGet	(void * ctx, 
				 ftpDataCallback callback, 
				 void * userData, 
				 const char * filename)

+
Fetch the given file from the server. All data are passed back in the callbacks. The last callback has a size of 0 block.

+
ctx:an FTP context
callback:the user callback
userData:the user callback data
filename:the file to retrieve
Returns:-1 incase of error, 0 otherwise
Function: xmlNanoFTPGetSocket
int	xmlNanoFTPGetSocket	(void * ctx, 
				 const char * filename)

+
Initiate fetch of the given file from the server.

+
ctx:an FTP context
filename:the file to retrieve (or NULL if path is in context).
Returns:the socket for the data connection, or <0 in case of error
Function: xmlNanoFTPNewCtxt
void *	xmlNanoFTPNewCtxt	(const char * URL)

+
Allocate and initialize a new FTP context.

+
URL:The URL used to initialize the context
Returns:an FTP context or NULL in case of error.
Function: xmlNanoFTPCheckResponse
int	xmlNanoFTPCheckResponse	(void * ctx)

+
Check if there is a response from the FTP server after a command.

+
ctx:an FTP context
Returns:the code number, or 0
Function: xmlNanoFTPRead
int	xmlNanoFTPRead	(void * ctx, 
				 void * dest, 
				 int len)

+
This function tries to read @len bytes from the existing FTP connection and saves them in @dest. This is a blocking call.

+
ctx:the FTP context
dest:a buffer
len:the buffer length
Returns:the number of byte read. 0 is an indication of an end of connection. -1 indicates a parameter error.
Function: xmlNanoFTPFreeCtxt
void	xmlNanoFTPFreeCtxt	(void * ctx)

+
Frees the context after closing the connection.

+
ctx:an FTP context
Function: xmlNanoFTPCleanup
void	xmlNanoFTPCleanup	(void)

+
Cleanup the FTP protocol layer. This cleanup proxy informations.

+
Function: xmlNanoFTPGetConnection
int	xmlNanoFTPGetConnection	(void * ctx)

+
Try to open a data connection to the server. Currently only passive mode is supported.

+
ctx:an FTP context
Returns:-1 incase of error, 0 otherwise
Daniel Veillard

diff --git a/doc/html/libxml-nanohttp.html b/doc/html/libxml-nanohttp.html
index f4f7a6d8..cacefd9a 100644
--- a/doc/html/libxml-nanohttp.html
+++ b/doc/html/libxml-nanohttp.html
@@ -1,212 +1,59 @@
-nanohttp
PrevUpHomeGnome XML Library Reference ManualNext
nanohttp
nanohttp — 
Synopsis
-
-
-
-void        xmlNanoHTTPInit                 (void);
-void        xmlNanoHTTPCleanup              (void);
-void        xmlNanoHTTPScanProxy            (const char *URL);
-int         xmlNanoHTTPFetch                (const char *URL,
-                                             const char *filename,
-                                             char **contentType);
-void*       xmlNanoHTTPMethod               (const char *URL,
-                                             const char *method,
-                                             const char *input,
-                                             char **contentType,
-                                             const char *headers,
-                                             int ilen);
-void*       xmlNanoHTTPMethodRedir          (const char *URL,
-                                             const char *method,
-                                             const char *input,
-                                             char **contentType,
-                                             char **redir,
-                                             const char *headers,
-                                             int ilen);
-void*       xmlNanoHTTPOpen                 (const char *URL,
-                                             char **contentType);
-void*       xmlNanoHTTPOpenRedir            (const char *URL,
-                                             char **contentType,
-                                             char **redir);
-int         xmlNanoHTTPReturnCode           (void *ctx);
-const char* xmlNanoHTTPAuthHeader           (void *ctx);
-const char* xmlNanoHTTPRedir                (void *ctx);
-const char* xmlNanoHTTPEncoding             (void *ctx);
-const char* xmlNanoHTTPMimeType             (void *ctx);
-int         xmlNanoHTTPRead                 (void *ctx,
-                                             void *dest,
-                                             int len);
-int         xmlNanoHTTPSave                 (void *ctxt,
-                                             const char *filename);
-void        xmlNanoHTTPClose                (void *ctx);
-
Description

-
-
Details
xmlNanoHTTPInit ()
void        xmlNanoHTTPInit                 (void);

-Initialize the HTTP protocol layer.
-Currently it just checks for proxy informations

-
-
xmlNanoHTTPCleanup ()
void        xmlNanoHTTPCleanup              (void);

-Cleanup the HTTP protocol layer.

-
-
xmlNanoHTTPScanProxy ()
void        xmlNanoHTTPScanProxy            (const char *URL);

-(Re)Initialize the HTTP Proxy context by parsing the URL and finding
-the protocol host port it indicates.
-Should be like http://myproxy/ or http://myproxy:3128/
-A NULL URL cleans up proxy informations.

-
-
URL:  The proxy URL used to initialize the proxy context
-
xmlNanoHTTPFetch ()
int         xmlNanoHTTPFetch                (const char *URL,
-                                             const char *filename,
-                                             char **contentType);

-This function try to fetch the indicated resource via HTTP GET
-and save it's content in the file.

-
-
URL:  The URL to load
-
filename:  the filename where the content should be saved
-
contentType:  if available the Content-Type information will be
-               returned at that location
-
Returns :-1 in case of failure, 0 incase of success. The contentType,
-    if provided must be freed by the caller
-
xmlNanoHTTPMethod ()
void*       xmlNanoHTTPMethod               (const char *URL,
-                                             const char *method,
-                                             const char *input,
-                                             char **contentType,
-                                             const char *headers,
-                                             int ilen);

-This function try to open a connection to the indicated resource
-via HTTP using the given method, adding the given extra headers
-and the input buffer for the request content.

-
-
URL:  The URL to load
-
method:  the HTTP method to use
-
input:  the input string if any
-
contentType:  the Content-Type information IN and OUT
-
headers:  the extra headers
-
ilen:  input length
-
xmlNanoHTTPMethodRedir ()
void*       xmlNanoHTTPMethodRedir          (const char *URL,
-                                             const char *method,
-                                             const char *input,
-                                             char **contentType,
-                                             char **redir,
-                                             const char *headers,
-                                             int ilen);

-This function try to open a connection to the indicated resource
-via HTTP using the given method, adding the given extra headers
-and the input buffer for the request content.

-
-
URL:  The URL to load
-
method:  the HTTP method to use
-
input:  the input string if any
-
contentType:  the Content-Type information IN and OUT
-
redir:  the redirected URL OUT
-
headers:  the extra headers
-
ilen:  input length
-
xmlNanoHTTPOpen ()
void*       xmlNanoHTTPOpen                 (const char *URL,
-                                             char **contentType);

-This function try to open a connection to the indicated resource
-via HTTP GET.

-
-
URL:  The URL to load
-
contentType:  if available the Content-Type information will be
-               returned at that location
-
xmlNanoHTTPOpenRedir ()
void*       xmlNanoHTTPOpenRedir            (const char *URL,
-                                             char **contentType,
-                                             char **redir);

-This function try to open a connection to the indicated resource
-via HTTP GET.

-
-
URL:  The URL to load
-
contentType:  if available the Content-Type information will be
-               returned at that location
-
redir: if available the redirected URL will be returned
-
xmlNanoHTTPReturnCode ()
int         xmlNanoHTTPReturnCode           (void *ctx);

-Get the latest HTTP return code received

-
-
ctx:  the HTTP context
-
Returns :the HTTP return code for the request.
-
xmlNanoHTTPAuthHeader ()
const char* xmlNanoHTTPAuthHeader           (void *ctx);

-Get the authentication header of an HTTP context

-
-
ctx:  the HTTP context
-
Returns :the stashed value of the WWW-Authenticate or Proxy-Authenticate
-header.
-
xmlNanoHTTPRedir ()
const char* xmlNanoHTTPRedir                (void *ctx);

-Provides the specified redirection URL if available from the HTTP header.
-

-Return the specified redirection URL or NULL if not redirected.

-
-
ctx:  the HTTP context
-
Returns :
-
-
-
xmlNanoHTTPEncoding ()
const char* xmlNanoHTTPEncoding             (void *ctx);

-Provides the specified encoding if specified in the HTTP headers.
-

-Return the specified encoding or NULL if not available

-
-
ctx:  the HTTP context
-
Returns :
-
-
-
xmlNanoHTTPMimeType ()
const char* xmlNanoHTTPMimeType             (void *ctx);

-Provides the specified Mime-Type if specified in the HTTP headers.
-

-Return the specified Mime-Type or NULL if not available

-
-
ctx:  the HTTP context
-
Returns :
-
-
-
xmlNanoHTTPRead ()
int         xmlNanoHTTPRead                 (void *ctx,
-                                             void *dest,
-                                             int len);

-This function tries to read len bytes from the existing HTTP connection
-and saves them in dest. This is a blocking call.

-
-
ctx:  the HTTP context
-
dest:  a buffer
-
len:  the buffer length
-
Returns :the number of byte read. 0 is an indication of an end of connection.
-        -1 indicates a parameter error.
-
xmlNanoHTTPSave ()
int         xmlNanoHTTPSave                 (void *ctxt,
-                                             const char *filename);

-This function saves the output of the HTTP transaction to a file
-It closes and free the context at the end

-
-
ctxt:  the HTTP context
-
filename:  the filename where the content should be saved
-
Returns :-1 in case of failure, 0 incase of success.
-
xmlNanoHTTPClose ()
void        xmlNanoHTTPClose                (void *ctx);

-This function closes an HTTP context, it ends up the connection and
-free all data related to it.

-
-
ctx:  the HTTP context
-
<< hashrelaxng >>

+
+
+Module nanohttp from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module nanohttp from libxml2
Main Menu
Related links
Table of Contents
int	xmlNanoHTTPSave	(void * ctxt, 
				 const char * filename)

+
const char *	xmlNanoHTTPRedir	(void * ctx)

+
const char *	xmlNanoHTTPAuthHeader	(void * ctx)

+
int	xmlNanoHTTPFetch	(const char * URL, 
				 const char * filename, 
				 char ** contentType)

+
void	xmlNanoHTTPInit	(void)

+
const char *	xmlNanoHTTPMimeType	(void * ctx)

+
void	xmlNanoHTTPClose	(void * ctx)

+
void	xmlNanoHTTPCleanup	(void)

+
void *	xmlNanoHTTPMethod	(const char * URL, 
				 const char * method, 
				 const char * input, 
				 char ** contentType, 
				 const char * headers, 
				 int ilen)

+
int	xmlNanoHTTPRead	(void * ctx, 
				 void * dest, 
				 int len)

+
void *	xmlNanoHTTPOpen	(const char * URL, 
				 char ** contentType)

+
void *	xmlNanoHTTPOpenRedir	(const char * URL, 
				 char ** contentType, 
				 char ** redir)

+
void *	xmlNanoHTTPMethodRedir	(const char * URL, 
				 const char * method, 
				 const char * input, 
				 char ** contentType, 
				 char ** redir, 
				 const char * headers, 
				 int ilen)

+
void	xmlNanoHTTPScanProxy	(const char * URL)

+
const char *	xmlNanoHTTPEncoding	(void * ctx)

+
int	xmlNanoHTTPReturnCode	(void * ctx)

+
Description

+
Function: xmlNanoHTTPSave
int	xmlNanoHTTPSave	(void * ctxt, 
				 const char * filename)

+
This function saves the output of the HTTP transaction to a file It closes and free the context at the end

+
ctxt:the HTTP context
filename:the filename where the content should be saved
Returns:-1 in case of failure, 0 incase of success.
Function: xmlNanoHTTPRedir
const char *	xmlNanoHTTPRedir	(void * ctx)

+
Provides the specified redirection URL if available from the HTTP header.

+
ctx:the HTTP context
Returns:the specified redirection URL or NULL if not redirected.
Function: xmlNanoHTTPAuthHeader
const char *	xmlNanoHTTPAuthHeader	(void * ctx)

+
Get the authentication header of an HTTP context

+
ctx:the HTTP context
Returns:the stashed value of the WWW-Authenticate or Proxy-Authenticate header.
Function: xmlNanoHTTPFetch
int	xmlNanoHTTPFetch	(const char * URL, 
				 const char * filename, 
				 char ** contentType)

+
This function try to fetch the indicated resource via HTTP GET and save it's content in the file.

+
URL:The URL to load
filename:the filename where the content should be saved
contentType:if available the Content-Type information will be returned at that location
Returns:-1 in case of failure, 0 incase of success. The contentType, if provided must be freed by the caller
Function: xmlNanoHTTPInit
void	xmlNanoHTTPInit	(void)

+
Initialize the HTTP protocol layer. Currently it just checks for proxy informations

+
Function: xmlNanoHTTPMimeType
const char *	xmlNanoHTTPMimeType	(void * ctx)

+
Provides the specified Mime-Type if specified in the HTTP headers.

+
ctx:the HTTP context
Returns:the specified Mime-Type or NULL if not available
Function: xmlNanoHTTPClose
void	xmlNanoHTTPClose	(void * ctx)

+
This function closes an HTTP context, it ends up the connection and free all data related to it.

+
ctx:the HTTP context
Function: xmlNanoHTTPCleanup
void	xmlNanoHTTPCleanup	(void)

+
Cleanup the HTTP protocol layer.

+
Function: xmlNanoHTTPMethod
void *	xmlNanoHTTPMethod	(const char * URL, 
				 const char * method, 
				 const char * input, 
				 char ** contentType, 
				 const char * headers, 
				 int ilen)

+
This function try to open a connection to the indicated resource via HTTP using the given @method, adding the given extra headers and the input buffer for the request content.

+
URL:The URL to load
method:the HTTP method to use
input:the input string if any
contentType:the Content-Type information IN and OUT
headers:the extra headers
ilen:input length
Returns:NULL in case of failure, otherwise a request handler. The contentType, if provided must be freed by the caller
Function: xmlNanoHTTPRead
int	xmlNanoHTTPRead	(void * ctx, 
				 void * dest, 
				 int len)

+
This function tries to read @len bytes from the existing HTTP connection and saves them in @dest. This is a blocking call.

+
ctx:the HTTP context
dest:a buffer
len:the buffer length
Returns:the number of byte read. 0 is an indication of an end of connection. -1 indicates a parameter error.
Function: xmlNanoHTTPOpen
void *	xmlNanoHTTPOpen	(const char * URL, 
				 char ** contentType)

+
This function try to open a connection to the indicated resource via HTTP GET.

+
URL:The URL to load
contentType:if available the Content-Type information will be returned at that location
Returns:NULL in case of failure, otherwise a request handler. The contentType, if provided must be freed by the caller
Function: xmlNanoHTTPOpenRedir
void *	xmlNanoHTTPOpenRedir	(const char * URL, 
				 char ** contentType, 
				 char ** redir)

+
This function try to open a connection to the indicated resource via HTTP GET.

+
URL:The URL to load
contentType:if available the Content-Type information will be returned at that location
redir:if available the redirected URL will be returned
Returns:NULL in case of failure, otherwise a request handler. The contentType, if provided must be freed by the caller
Function: xmlNanoHTTPMethodRedir
void *	xmlNanoHTTPMethodRedir	(const char * URL, 
				 const char * method, 
				 const char * input, 
				 char ** contentType, 
				 char ** redir, 
				 const char * headers, 
				 int ilen)

+
This function try to open a connection to the indicated resource via HTTP using the given @method, adding the given extra headers and the input buffer for the request content.

+
URL:The URL to load
method:the HTTP method to use
input:the input string if any
contentType:the Content-Type information IN and OUT
redir:the redirected URL OUT
headers:the extra headers
ilen:input length
Returns:NULL in case of failure, otherwise a request handler. The contentType, or redir, if provided must be freed by the caller
Function: xmlNanoHTTPScanProxy
void	xmlNanoHTTPScanProxy	(const char * URL)

+
(Re)Initialize the HTTP Proxy context by parsing the URL and finding the protocol host port it indicates. Should be like http://myproxy/ or http://myproxy:3128/ A NULL URL cleans up proxy informations.

+
URL:The proxy URL used to initialize the proxy context
Function: xmlNanoHTTPEncoding
const char *	xmlNanoHTTPEncoding	(void * ctx)

+
Provides the specified encoding if specified in the HTTP headers.

+
ctx:the HTTP context
Returns:the specified encoding or NULL if not available
Function: xmlNanoHTTPReturnCode
int	xmlNanoHTTPReturnCode	(void * ctx)

+
Get the latest HTTP return code received

+
ctx:the HTTP context
Returns:the HTTP return code for the request.
Daniel Veillard

diff --git a/doc/html/libxml-notes.html b/doc/html/libxml-notes.html
deleted file mode 100644
index 5c6ab7fa..00000000
--- a/doc/html/libxml-notes.html
+++ /dev/null
@@ -1,33 +0,0 @@
-Libxml Programming Notes
PrevHomeGnome XML Library Reference ManualNext
Libxml Programming Notes
Libxml is an XML toolkit library, it allows to parse, edit
-     search and write XML documents. There is also an HTML parser front-end
-     so the same range of tools can be used with HTML input.
<< Gnome XML Library Reference ManualLibxml Library Reference >>

diff --git a/doc/html/libxml-parser.html b/doc/html/libxml-parser.html
index 2354b851..fa496cb7 100644
--- a/doc/html/libxml-parser.html
+++ b/doc/html/libxml-parser.html
@@ -1,1850 +1,697 @@
-parser
PrevUpHomeGnome XML Library Reference ManualNext
parser
parser — 
Synopsis
-
-
-
-#define     XML_DEFAULT_VERSION
-void        (*xmlParserInputDeallocate)     (xmlChar *str);
-struct      xmlParserInput;
-struct      xmlParserNodeInfo;
-typedef     xmlParserNodeInfoPtr;
-struct      xmlParserNodeInfoSeq;
-typedef     xmlParserNodeInfoSeqPtr;
-enum        xmlParserInputState;
-#define     XML_DETECT_IDS
-#define     XML_COMPLETE_ATTRS
-#define     XML_SKIP_IDS
-struct      xmlParserCtxt;
-struct      xmlSAXLocator;
-xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
-void        (*internalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-void        (*externalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
-                                             const xmlChar *name);
-xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *name);
-void        (*entityDeclSAXFunc)            (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             xmlChar *content);
-void        (*notationDeclSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);
-void        (*attributeDeclSAXFunc)         (void *ctx,
-                                             const xmlChar *elem,
-                                             const xmlChar *fullname,
-                                             int type,
-                                             int def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);
-void        (*elementDeclSAXFunc)           (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             xmlElementContentPtr content);
-void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             const xmlChar *notationName);
-void        (*setDocumentLocatorSAXFunc)    (void *ctx,
-                                             xmlSAXLocatorPtr loc);
-void        (*startDocumentSAXFunc)         (void *ctx);
-void        (*endDocumentSAXFunc)           (void *ctx);
-void        (*startElementSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar **atts);
-void        (*endElementSAXFunc)            (void *ctx,
-                                             const xmlChar *name);
-void        (*attributeSAXFunc)             (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-void        (*referenceSAXFunc)             (void *ctx,
-                                             const xmlChar *name);
-void        (*charactersSAXFunc)            (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);
-void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);
-void        (*processingInstructionSAXFunc) (void *ctx,
-                                             const xmlChar *target,
-                                             const xmlChar *data);
-void        (*commentSAXFunc)               (void *ctx,
-                                             const xmlChar *value);
-void        (*cdataBlockSAXFunc)            (void *ctx,
-                                             const xmlChar *value,
-                                             int len);
-void        (*warningSAXFunc)               (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        (*errorSAXFunc)                 (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        (*fatalErrorSAXFunc)            (void *ctx,
-                                             const char *msg,
-                                             ...);
-int         (*isStandaloneSAXFunc)          (void *ctx);
-int         (*hasInternalSubsetSAXFunc)     (void *ctx);
-int         (*hasExternalSubsetSAXFunc)     (void *ctx);
-#define     XML_SAX2_MAGIC
-void        (*startElementNsSAX2Func)       (void *ctx,
-                                             const xmlChar *localname,
-                                             const xmlChar *prefix,
-                                             const xmlChar *URI,
-                                             int nb_namespaces,
-                                             const xmlChar **namespaces,
-                                             int nb_attributes,
-                                             int nb_defaulted,
-                                             const xmlChar **attributes);
-void        (*endElementNsSAX2Func)         (void *ctx,
-                                             const xmlChar *localname,
-                                             const xmlChar *prefix,
-                                             const xmlChar *URI);
-struct      xmlSAXHandler;
-struct      xmlSAXHandlerV1;
-typedef     xmlSAXHandlerV1Ptr;
-xmlParserInputPtr (*xmlExternalEntityLoader)
-                                            (const char *URL,
-                                             const char *ID,
-                                             xmlParserCtxtPtr context);
-void        xmlInitParser                   (void);
-void        xmlCleanupParser                (void);
-int         xmlParserInputRead              (xmlParserInputPtr in,
-                                             int len);
-int         xmlParserInputGrow              (xmlParserInputPtr in,
-                                             int len);
-xmlChar*    xmlStrdup                       (const xmlChar *cur);
-xmlChar*    xmlStrndup                      (const xmlChar *cur,
-                                             int len);
-xmlChar*    xmlCharStrndup                  (const char *cur,
-                                             int len);
-xmlChar*    xmlCharStrdup                   (const char *cur);
-xmlChar*    xmlStrsub                       (const xmlChar *str,
-                                             int start,
-                                             int len);
-const xmlChar* xmlStrchr                    (const xmlChar *str,
-                                             xmlChar val);
-const xmlChar* xmlStrstr                    (const xmlChar *str,
-                                             const xmlChar *val);
-const xmlChar* xmlStrcasestr                (const xmlChar *str,
-                                             xmlChar *val);
-int         xmlStrcmp                       (const xmlChar *str1,
-                                             const xmlChar *str2);
-int         xmlStrncmp                      (const xmlChar *str1,
-                                             const xmlChar *str2,
-                                             int len);
-int         xmlStrcasecmp                   (const xmlChar *str1,
-                                             const xmlChar *str2);
-int         xmlStrncasecmp                  (const xmlChar *str1,
-                                             const xmlChar *str2,
-                                             int len);
-int         xmlStrEqual                     (const xmlChar *str1,
-                                             const xmlChar *str2);
-int         xmlStrQEqual                    (const xmlChar *pref,
-                                             const xmlChar *name,
-                                             const xmlChar *str);
-int         xmlStrlen                       (const xmlChar *str);
-xmlChar*    xmlStrcat                       (xmlChar *cur,
-                                             const xmlChar *add);
-xmlChar*    xmlStrncat                      (xmlChar *cur,
-                                             const xmlChar *add,
-                                             int len);
-int         xmlStrPrintf                    (xmlChar *buf,
-                                             int len,
-                                             const xmlChar *msg,
-                                             ...);
-int         xmlStrVPrintf                   (xmlChar *buf,
-                                             int len,
-                                             const xmlChar *msg,
-                                             va_list ap);
-xmlDocPtr   xmlParseDoc                     (xmlChar *cur);
-xmlDocPtr   xmlParseMemory                  (const char *buffer,
-                                             int size);
-xmlDocPtr   xmlParseFile                    (const char *filename);
-int         xmlSubstituteEntitiesDefault    (int val);
-int         xmlKeepBlanksDefault            (int val);
-void        xmlStopParser                   (xmlParserCtxtPtr ctxt);
-int         xmlPedanticParserDefault        (int val);
-int         xmlLineNumbersDefault           (int val);
-xmlDocPtr   xmlRecoverDoc                   (xmlChar *cur);
-xmlDocPtr   xmlRecoverMemory                (const char *buffer,
-                                             int size);
-xmlDocPtr   xmlRecoverFile                  (const char *filename);
-int         xmlParseDocument                (xmlParserCtxtPtr ctxt);
-int         xmlParseExtParsedEnt            (xmlParserCtxtPtr ctxt);
-xmlDocPtr   xmlSAXParseDoc                  (xmlSAXHandlerPtr sax,
-                                             xmlChar *cur,
-                                             int recovery);
-int         xmlSAXUserParseFile             (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *filename);
-int         xmlSAXUserParseMemory           (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *buffer,
-                                             int size);
-xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
-                                             const char *buffer,
-                                             int size,
-                                             int recovery);
-xmlDocPtr   xmlSAXParseMemoryWithData       (xmlSAXHandlerPtr sax,
-                                             const char *buffer,
-                                             int size,
-                                             int recovery,
-                                             void *data);
-xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
-                                             const char *filename,
-                                             int recovery);
-xmlDocPtr   xmlSAXParseFileWithData         (xmlSAXHandlerPtr sax,
-                                             const char *filename,
-                                             int recovery,
-                                             void *data);
-xmlDocPtr   xmlSAXParseEntity               (xmlSAXHandlerPtr sax,
-                                             const char *filename);
-xmlDocPtr   xmlParseEntity                  (const char *filename);
-xmlDtdPtr   xmlParseDTD                     (const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlIOParseDTD                   (xmlSAXHandlerPtr sax,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);
-int         xmlParseBalancedChunkMemory     (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst);
-int         xmlParseBalancedChunkMemoryRecover
-                                            (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst,
-                                             int recover);
-int         xmlParseExternalEntity          (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             int depth,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);
-int         xmlParseCtxtExternalEntity      (xmlParserCtxtPtr ctx,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);
-xmlParserCtxtPtr xmlNewParserCtxt           (void);
-int         xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);
-void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);
-void        xmlFreeParserCtxt               (xmlParserCtxtPtr ctxt);
-void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *buffer,
-                                             const char *filename);
-xmlParserCtxtPtr xmlCreateDocParserCtxt     (const xmlChar *cur);
-int         xmlGetFeaturesList              (int *len,
-                                             const char **result);
-int         xmlGetFeature                   (xmlParserCtxtPtr ctxt,
-                                             const char *name,
-                                             void *result);
-int         xmlSetFeature                   (xmlParserCtxtPtr ctxt,
-                                             const char *name,
-                                             void *value);
-xmlParserCtxtPtr xmlCreatePushParserCtxt    (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename);
-int         xmlParseChunk                   (xmlParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             int terminate);
-xmlParserCtxtPtr xmlCreateIOParserCtxt      (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             xmlCharEncoding enc);
-xmlParserInputPtr xmlNewIOInputStream       (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);
-const xmlParserNodeInfo* xmlParserFindNodeInfo
-                                            (const xmlParserCtxtPtr ctxt,
-                                             const xmlNodePtr node);
-void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);
-void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);
-void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
-                                             const xmlParserNodeInfoPtr info);
-void        xmlSetExternalEntityLoader      (xmlExternalEntityLoader f);
-xmlExternalEntityLoader xmlGetExternalEntityLoader
-                                            (void);
-xmlParserInputPtr xmlLoadExternalEntity     (const char *URL,
-                                             const char *ID,
-                                             xmlParserCtxtPtr ctxt);
-enum        xmlParserOption;
-void        xmlCtxtReset                    (xmlParserCtxtPtr ctxt);
-int         xmlCtxtResetPush                (xmlParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename,
-                                             const char *encoding);
-int         xmlCtxtUseOptions               (xmlParserCtxtPtr ctxt,
-                                             int options);
-xmlDocPtr   xmlReadDoc                      (const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlReadFile                     (const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlReadMemory                   (const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlReadFd                       (int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlReadIO                       (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlCtxtReadDoc                  (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlCtxtReadFile                 (xmlParserCtxtPtr ctxt,
-                                             const char *filename,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlCtxtReadMemory               (xmlParserCtxtPtr ctxt,
-                                             const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlCtxtReadFd                   (xmlParserCtxtPtr ctxt,
-                                             int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlDocPtr   xmlCtxtReadIO                   (xmlParserCtxtPtr ctxt,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-
Description

-
-
Details
XML_DEFAULT_VERSION
#define XML_DEFAULT_VERSION	"1.0"
-

-The default version of XML used: 1.0

-
-
xmlParserInputDeallocate ()
void        (*xmlParserInputDeallocate)     (xmlChar *str);

-Callback for freeing some parser input allocations.

-
-
str:  the string to deallocate
-
struct xmlParserInput
struct xmlParserInput {
-
-    /* Input buffer */
-    xmlParserInputBufferPtr buf;      /* UTF-8 encoded buffer */
-
-    const char *filename;             /* The file analyzed, if any */
-    const char *directory;            /* the directory/base of the file */
-    const xmlChar *base;              /* Base of the array to parse */
-    const xmlChar *cur;               /* Current char being parsed */
-    const xmlChar *end;               /* end of the array to parse */
-    int length;                       /* length if known */
-    int line;                         /* Current line */
-    int col;                          /* Current column */
-    /*
-     * NOTE: consumed is only tested for equality in the parser code,
-     *       so even if there is an overflow this should not give troubles
-     *       for parsing very large instances.
-     */
-    unsigned long consumed;           /* How many xmlChars already consumed */
-    xmlParserInputDeallocate free;    /* function to deallocate the base */
-    const xmlChar *encoding;          /* the encoding string for entity */
-    const xmlChar *version;           /* the version string for entity */
-    int standalone;                   /* Was that entity marked standalone */
-    int id;                           /* an unique identifier for the entity */
-};
-

-An xmlParserInput is an input flow for the XML processor.
-Each entity parsed is associated an xmlParserInput (except the
-few predefined ones). This is the case both for internal entities
-- in which case the flow is already completely in memory - or
-external entities - in which case we use the buf structure for
-progressive reading and I18N conversions to the internal UTF-8 format.

-
-
struct xmlParserNodeInfo
struct xmlParserNodeInfo {
-
-  const struct _xmlNode* node;
-  /* Position & line # that text that created the node begins & ends on */
-  unsigned long begin_pos;
-  unsigned long begin_line;
-  unsigned long end_pos;
-  unsigned long end_line;
-};
-

-The parser can be asked to collect Node informations, i.e. at what
-place in the file they were detected. 
-NOTE: This is off by default and not very well tested.

-
-
xmlParserNodeInfoPtr
typedef xmlParserNodeInfo *xmlParserNodeInfoPtr;
-

-
-
struct xmlParserNodeInfoSeq
struct xmlParserNodeInfoSeq {
-
-  unsigned long maximum;
-  unsigned long length;
-  xmlParserNodeInfo* buffer;
-};
-

-
-
xmlParserNodeInfoSeqPtr
typedef xmlParserNodeInfoSeq *xmlParserNodeInfoSeqPtr;
-

-
-
enum xmlParserInputState
typedef enum {
-    XML_PARSER_EOF = -1,	/* nothing is to be parsed */
-    XML_PARSER_START = 0,	/* nothing has been parsed */
-    XML_PARSER_MISC,		/* Misc* before int subset */
-    XML_PARSER_PI,		/* Within a processing instruction */
-    XML_PARSER_DTD,		/* within some DTD content */
-    XML_PARSER_PROLOG,		/* Misc* after internal subset */
-    XML_PARSER_COMMENT,		/* within a comment */
-    XML_PARSER_START_TAG,	/* within a start tag */
-    XML_PARSER_CONTENT,		/* within the content */
-    XML_PARSER_CDATA_SECTION,	/* within a CDATA section */
-    XML_PARSER_END_TAG,		/* within a closing tag */
-    XML_PARSER_ENTITY_DECL,	/* within an entity declaration */
-    XML_PARSER_ENTITY_VALUE,	/* within an entity value in a decl */
-    XML_PARSER_ATTRIBUTE_VALUE,	/* within an attribute value */
-    XML_PARSER_SYSTEM_LITERAL,	/* within a SYSTEM value */
-    XML_PARSER_EPILOG, 		/* the Misc* after the last end tag */
-    XML_PARSER_IGNORE,		/* within an IGNORED section */
-    XML_PARSER_PUBLIC_LITERAL 	/* within a PUBLIC value */
-} xmlParserInputState;
-

-The parser is now working also as a state based parser.
-The recursive one use the state info for entities processing.

-
-
XML_DETECT_IDS
#define XML_DETECT_IDS		2
-

-Bit in the loadsubset context field to tell to do ID/REFs lookups.
-Use it to initialize xmlLoadExtDtdDefaultValue.

-
-
XML_COMPLETE_ATTRS
#define XML_COMPLETE_ATTRS	4
-

-Bit in the loadsubset context field to tell to do complete the
-elements attributes lists with the ones defaulted from the DTDs.
-Use it to initialize xmlLoadExtDtdDefaultValue.

-
-
XML_SKIP_IDS
#define XML_SKIP_IDS		8
-

-Bit in the loadsubset context field to tell to not do ID/REFs registration.
-Used to initialize xmlLoadExtDtdDefaultValue in some special cases.

-
-
struct xmlParserCtxt
struct xmlParserCtxt {
-
-    struct _xmlSAXHandler *sax;       /* The SAX handler */
-    void            *userData;        /* For SAX interface only, used by DOM build */
-    xmlDocPtr           myDoc;        /* the document being built */
-    int            wellFormed;        /* is the document well formed */
-    int       replaceEntities;        /* shall we replace entities ? */
-    const xmlChar    *version;        /* the XML version string */
-    const xmlChar   *encoding;        /* the declared encoding, if any */
-    int            standalone;        /* standalone document */
-    int                  html;        /* an HTML(1)/Docbook(2) document */
-
-    /* Input stream stack */
-    xmlParserInputPtr  input;         /* Current input stream */
-    int                inputNr;       /* Number of current input streams */
-    int                inputMax;      /* Max number of input streams */
-    xmlParserInputPtr *inputTab;      /* stack of inputs */
-
-    /* Node analysis stack only used for DOM building */
-    xmlNodePtr         node;          /* Current parsed Node */
-    int                nodeNr;        /* Depth of the parsing stack */
-    int                nodeMax;       /* Max depth of the parsing stack */
-    xmlNodePtr        *nodeTab;       /* array of nodes */
-
-    int record_info;                  /* Whether node info should be kept */
-    xmlParserNodeInfoSeq node_seq;    /* info about each node parsed */
-
-    int errNo;                        /* error code */
-
-    int     hasExternalSubset;        /* reference and external subset */
-    int             hasPErefs;        /* the internal subset has PE refs */
-    int              external;        /* are we parsing an external entity */
-
-    int                 valid;        /* is the document valid */
-    int              validate;        /* shall we try to validate ? */
-    xmlValidCtxt        vctxt;        /* The validity context */
-
-    xmlParserInputState instate;      /* current type of input */
-    int                 token;        /* next char look-ahead */    
-
-    char           *directory;        /* the data directory */
-
-    /* Node name stack */
-    const xmlChar     *name;          /* Current parsed Node */
-    int                nameNr;        /* Depth of the parsing stack */
-    int                nameMax;       /* Max depth of the parsing stack */
-    const xmlChar *   *nameTab;       /* array of nodes */
-
-    long               nbChars;       /* number of xmlChar processed */
-    long            checkIndex;       /* used by progressive parsing lookup */
-    int             keepBlanks;       /* ugly but ... */
-    int             disableSAX;       /* SAX callbacks are disabled */
-    int               inSubset;       /* Parsing is in int 1/ext 2 subset */
-    const xmlChar *    intSubName;    /* name of subset */
-    xmlChar *          extSubURI;     /* URI of external subset */
-    xmlChar *          extSubSystem;  /* SYSTEM ID of external subset */
-
-    /* xml:space values */
-    int *              space;         /* Should the parser preserve spaces */
-    int                spaceNr;       /* Depth of the parsing stack */
-    int                spaceMax;      /* Max depth of the parsing stack */
-    int *              spaceTab;      /* array of space infos */
-
-    int                depth;         /* to prevent entity substitution loops */
-    xmlParserInputPtr  entity;        /* used to check entities boundaries */
-    int                charset;       /* encoding of the in-memory content
-				         actually an xmlCharEncoding */
-    int                nodelen;       /* Those two fields are there to */
-    int                nodemem;       /* Speed up large node parsing */
-    int                pedantic;      /* signal pedantic warnings */
-    void              *_private;      /* For user data, libxml won't touch it */
-
-    int                loadsubset;    /* should the external subset be loaded */
-    int                linenumbers;   /* set line number in element content */
-    void              *catalogs;       /* document's own catalog */
-    int                recovery;      /* run in recovery mode */
-    int                progressive;   /* is this a progressive parsing */
-    xmlDictPtr         dict;          /* dictionnary for the parser */
-    const xmlChar *   *atts;          /* array for the attributes callbacks */
-    int                maxatts;       /* the size of the array */
-    int                docdict;       /* use strings from dict to build tree */
-
-    /*
-     * pre-interned strings
-     */
-    const xmlChar *str_xml;
-    const xmlChar *str_xmlns;
-    const xmlChar *str_xml_ns;
-
-    /*
-     * Everything below is used only by the new SAX mode
-     */
-    int                sax2;          /* operating in the new SAX mode */
-    int                nsNr;          /* the number of inherited namespaces */
-    int                nsMax;         /* the size of the arrays */
-    const xmlChar *   *nsTab;         /* the array of prefix/namespace name */
-    int               *attallocs;     /* which attribute were allocated */
-    void *            *pushTab;       /* array of data for push */
-    xmlHashTablePtr    attsDefault;   /* defaulted attributes if any */
-    xmlHashTablePtr    attsSpecial;   /* non-CDATA attributes if any */
-    int                nsWellFormed;  /* is the document XML Nanespace okay */
-    int                options;       /* Extra options */
-
-    /*
-     * Those fields are needed only for treaming parsing so far
-     */
-    int               dictNames;    /* Use dictionary names for the tree */
-    int               freeElemsNr;  /* number of freed element nodes */
-    xmlNodePtr        freeElems;    /* List of freed element nodes */
-    int               freeAttrsNr;  /* number of freed attributes nodes */
-    xmlAttrPtr        freeAttrs;    /* List of freed attributes nodes */
-
-    /*
-     * the complete error informations for the last error.
-     */
-    xmlError          lastError;
-};
-

-The parser context.
-NOTE This doesn't completely define the parser state, the (current ?)
-     design of the parser uses recursive function calls since this allow
-     and easy mapping from the production rules of the specification
-     to the actual code. The drawback is that the actual function call
-     also reflect the parser state. However most of the parsing routines
-     takes as the only argument the parser context pointer, so migrating
-     to a state based parser for progressive parsing shouldn't be too hard.

-
-
struct xmlSAXLocator
struct xmlSAXLocator {
-
-    const xmlChar *(*getPublicId)(void *ctx);
-    const xmlChar *(*getSystemId)(void *ctx);
-    int (*getLineNumber)(void *ctx);
-    int (*getColumnNumber)(void *ctx);
-};
-

-A SAX Locator.

-
-
resolveEntitySAXFunc ()
xmlParserInputPtr (*resolveEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);

-Callback:
-The entity loader, to control the loading of external entities,
-the application can either:
-   - override this resolveEntity() callback in the SAX block
-   - or better use the xmlSetExternalEntityLoader() function to
-     set up it's own entity resolution routine

-
-
ctx:  the user data (XML parser context)
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
Returns :the xmlParserInputPtr if inlined or NULL for DOM behaviour.
-
internalSubsetSAXFunc ()
void        (*internalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

-Callback on internal subset declaration.

-
-
ctx:  the user data (XML parser context)
-
name:  the root element name
-
ExternalID:  the external ID
-
SystemID:  the SYSTEM ID (e.g. filename or URL)
-
externalSubsetSAXFunc ()
void        (*externalSubsetSAXFunc)        (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

-Callback on external subset declaration.

-
-
ctx:  the user data (XML parser context)
-
name:  the root element name
-
ExternalID:  the external ID
-
SystemID:  the SYSTEM ID (e.g. filename or URL)
-
getEntitySAXFunc ()
xmlEntityPtr (*getEntitySAXFunc)            (void *ctx,
-                                             const xmlChar *name);

-Get an entity by name.

-
-
ctx:  the user data (XML parser context)
-
name: The entity name
-
Returns :the xmlEntityPtr if found.
-
getParameterEntitySAXFunc ()
xmlEntityPtr (*getParameterEntitySAXFunc)   (void *ctx,
-                                             const xmlChar *name);

-Get a parameter entity by name.

-
-
ctx:  the user data (XML parser context)
-
name: The entity name
-
Returns :the xmlEntityPtr if found.
-
entityDeclSAXFunc ()
void        (*entityDeclSAXFunc)            (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             xmlChar *content);

-An entity definition has been parsed.

-
-
ctx:  the user data (XML parser context)
-
name:  the entity name 
-
type:  the entity type 
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
content: the entity value (without processing).
-
notationDeclSAXFunc ()
void        (*notationDeclSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId);

-What to do when a notation declaration has been parsed.

-
-
ctx:  the user data (XML parser context)
-
name: The name of the notation
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
attributeDeclSAXFunc ()
void        (*attributeDeclSAXFunc)         (void *ctx,
-                                             const xmlChar *elem,
-                                             const xmlChar *fullname,
-                                             int type,
-                                             int def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);

-An attribute definition has been parsed.

-
-
ctx:  the user data (XML parser context)
-
elem:  the name of the element
-
fullname:  the attribute name 
-
type:  the attribute type 
-
def:  the type of default value
-
defaultValue: the attribute default value
-
tree:  the tree of enumerated value set
-
elementDeclSAXFunc ()
void        (*elementDeclSAXFunc)           (void *ctx,
-                                             const xmlChar *name,
-                                             int type,
-                                             xmlElementContentPtr content);

-An element definition has been parsed.

-
-
ctx:  the user data (XML parser context)
-
name:  the element name 
-
type:  the element type 
-
content: the element value tree
-
unparsedEntityDeclSAXFunc ()
void        (*unparsedEntityDeclSAXFunc)    (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *publicId,
-                                             const xmlChar *systemId,
-                                             const xmlChar *notationName);

-What to do when an unparsed entity declaration is parsed.

-
-
ctx:  the user data (XML parser context)
-
name: The name of the entity
-
publicId: The public ID of the entity
-
systemId: The system ID of the entity
-
notationName: the name of the notation
-
setDocumentLocatorSAXFunc ()
void        (*setDocumentLocatorSAXFunc)    (void *ctx,
-                                             xmlSAXLocatorPtr loc);

-Receive the document locator at startup, actually xmlDefaultSAXLocator.
-Everything is available on the context, so this is useless in our case.

-
-
ctx:  the user data (XML parser context)
-
loc: A SAX Locator
-
startDocumentSAXFunc ()
void        (*startDocumentSAXFunc)         (void *ctx);

-Called when the document start being processed.

-
-
ctx:  the user data (XML parser context)
-
endDocumentSAXFunc ()
void        (*endDocumentSAXFunc)           (void *ctx);

-Called when the document end has been detected.

-
-
ctx:  the user data (XML parser context)
-
startElementSAXFunc ()
void        (*startElementSAXFunc)          (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar **atts);

-Called when an opening tag has been processed.

-
-
ctx:  the user data (XML parser context)
-
name:  The element name, including namespace prefix
-
atts:  An array of name/value attributes pairs, NULL terminated
-
endElementSAXFunc ()
void        (*endElementSAXFunc)            (void *ctx,
-                                             const xmlChar *name);

-Called when the end of an element has been detected.

-
-
ctx:  the user data (XML parser context)
-
name:  The element name
-
attributeSAXFunc ()
void        (*attributeSAXFunc)             (void *ctx,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Handle an attribute that has been read by the parser.
-The default handling is to convert the attribute into an
-DOM subtree and past it in a new xmlAttr element added to
-the element.

-
-
ctx:  the user data (XML parser context)
-
name:  The attribute name, including namespace prefix
-
value:  The attribute value
-
referenceSAXFunc ()
void        (*referenceSAXFunc)             (void *ctx,
-                                             const xmlChar *name);

-Called when an entity reference is detected.

-
-
ctx:  the user data (XML parser context)
-
name:  The entity name
-
charactersSAXFunc ()
void        (*charactersSAXFunc)            (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);

-Receiving some chars from the parser.

-
-
ctx:  the user data (XML parser context)
-
ch:  a xmlChar string
-
len: the number of xmlChar
-
ignorableWhitespaceSAXFunc ()
void        (*ignorableWhitespaceSAXFunc)   (void *ctx,
-                                             const xmlChar *ch,
-                                             int len);

-Receiving some ignorable whitespaces from the parser.
-UNUSED: by default the DOM building will use characters.

-
-
ctx:  the user data (XML parser context)
-
ch:  a xmlChar string
-
len: the number of xmlChar
-
processingInstructionSAXFunc ()
void        (*processingInstructionSAXFunc) (void *ctx,
-                                             const xmlChar *target,
-                                             const xmlChar *data);

-A processing instruction has been parsed.

-
-
ctx:  the user data (XML parser context)
-
target:  the target name
-
data: the PI data's
-
commentSAXFunc ()
void        (*commentSAXFunc)               (void *ctx,
-                                             const xmlChar *value);

-A comment has been parsed.

-
-
ctx:  the user data (XML parser context)
-
value:  the comment content
-
cdataBlockSAXFunc ()
void        (*cdataBlockSAXFunc)            (void *ctx,
-                                             const xmlChar *value,
-                                             int len);

-Called when a pcdata block has been parsed.

-
-
ctx:  the user data (XML parser context)
-
value:  The pcdata content
-
len:  the block length
-
warningSAXFunc ()
void        (*warningSAXFunc)               (void *ctx,
-                                             const char *msg,
-                                             ...);

-Display and format a warning messages, callback.

-
-
ctx:  an XML parser context
-
msg:  the message to display/transmit
-
...:  extra parameters for the message display
-
errorSAXFunc ()
void        (*errorSAXFunc)                 (void *ctx,
-                                             const char *msg,
-                                             ...);

-Display and format an error messages, callback.

-
-
ctx:  an XML parser context
-
msg:  the message to display/transmit
-
...:  extra parameters for the message display
-
fatalErrorSAXFunc ()
void        (*fatalErrorSAXFunc)            (void *ctx,
-                                             const char *msg,
-                                             ...);

-Display and format fatal error messages, callback.
-Note: so far fatalError() SAX callbacks are not used, error()
-      get all the callbacks for errors.

-
-
ctx:  an XML parser context
-
msg:  the message to display/transmit
-
...:  extra parameters for the message display
-
isStandaloneSAXFunc ()
int         (*isStandaloneSAXFunc)          (void *ctx);

-Is this document tagged standalone?

-
-
ctx:  the user data (XML parser context)
-
Returns :1 if true
-
hasInternalSubsetSAXFunc ()
int         (*hasInternalSubsetSAXFunc)     (void *ctx);

-Does this document has an internal subset.

-
-
ctx:  the user data (XML parser context)
-
Returns :1 if true
-
hasExternalSubsetSAXFunc ()
int         (*hasExternalSubsetSAXFunc)     (void *ctx);

-Does this document has an external subset?

-
-
ctx:  the user data (XML parser context)
-
Returns :1 if true
-
XML_SAX2_MAGIC
#define XML_SAX2_MAGIC 0xDEEDBEAF
-

-Special constant found in SAX2 blocks initialized fields

-
-
startElementNsSAX2Func ()
void        (*startElementNsSAX2Func)       (void *ctx,
-                                             const xmlChar *localname,
-                                             const xmlChar *prefix,
-                                             const xmlChar *URI,
-                                             int nb_namespaces,
-                                             const xmlChar **namespaces,
-                                             int nb_attributes,
-                                             int nb_defaulted,
-                                             const xmlChar **attributes);

-SAX2 callback when an element start has been detected by the parser.
-It provides the namespace informations for the element, as well as
-the new namespace declarations on the element.

-
-
ctx:  the user data (XML parser context)
-
localname:  the local name of the element
-
prefix:  the element namespace prefix if available
-
URI:  the element namespace name if available
-
nb_namespaces:  number of namespace definitions on that node
-
namespaces:  pointer to the array of prefix/URI pairs namespace definitions
-
nb_attributes:  the number of attributes on that node
-
nb_defaulted:  the number of defaulted attributes. The defaulted
-                 ones are at the end of the array
-
attributes:  pointer to the array of (localname/prefix/URI/value/end)
-              attribute values.
-
endElementNsSAX2Func ()
void        (*endElementNsSAX2Func)         (void *ctx,
-                                             const xmlChar *localname,
-                                             const xmlChar *prefix,
-                                             const xmlChar *URI);

-SAX2 callback when an element end has been detected by the parser.
-It provides the namespace informations for the element.

-
-
ctx:  the user data (XML parser context)
-
localname:  the local name of the element
-
prefix:  the element namespace prefix if available
-
URI:  the element namespace name if available
-
struct xmlSAXHandler
struct xmlSAXHandler {
-
-    internalSubsetSAXFunc internalSubset;
-    isStandaloneSAXFunc isStandalone;
-    hasInternalSubsetSAXFunc hasInternalSubset;
-    hasExternalSubsetSAXFunc hasExternalSubset;
-    resolveEntitySAXFunc resolveEntity;
-    getEntitySAXFunc getEntity;
-    entityDeclSAXFunc entityDecl;
-    notationDeclSAXFunc notationDecl;
-    attributeDeclSAXFunc attributeDecl;
-    elementDeclSAXFunc elementDecl;
-    unparsedEntityDeclSAXFunc unparsedEntityDecl;
-    setDocumentLocatorSAXFunc setDocumentLocator;
-    startDocumentSAXFunc startDocument;
-    endDocumentSAXFunc endDocument;
-    startElementSAXFunc startElement;
-    endElementSAXFunc endElement;
-    referenceSAXFunc reference;
-    charactersSAXFunc characters;
-    ignorableWhitespaceSAXFunc ignorableWhitespace;
-    processingInstructionSAXFunc processingInstruction;
-    commentSAXFunc comment;
-    warningSAXFunc warning;
-    errorSAXFunc error;
-    fatalErrorSAXFunc fatalError; /* unused error() get all the errors */
-    getParameterEntitySAXFunc getParameterEntity;
-    cdataBlockSAXFunc cdataBlock;
-    externalSubsetSAXFunc externalSubset;
-    unsigned int initialized;
-    /* The following fields are extensions available only on version 2 */
-    void *_private;
-    startElementNsSAX2Func startElementNs;
-    endElementNsSAX2Func endElementNs;
-    xmlStructuredErrorFunc serror;
-};
-

-A SAX handler is bunch of callbacks called by the parser when processing
-of the input generate data or structure informations.

-
-
struct xmlSAXHandlerV1
struct xmlSAXHandlerV1 {
-
-    internalSubsetSAXFunc internalSubset;
-    isStandaloneSAXFunc isStandalone;
-    hasInternalSubsetSAXFunc hasInternalSubset;
-    hasExternalSubsetSAXFunc hasExternalSubset;
-    resolveEntitySAXFunc resolveEntity;
-    getEntitySAXFunc getEntity;
-    entityDeclSAXFunc entityDecl;
-    notationDeclSAXFunc notationDecl;
-    attributeDeclSAXFunc attributeDecl;
-    elementDeclSAXFunc elementDecl;
-    unparsedEntityDeclSAXFunc unparsedEntityDecl;
-    setDocumentLocatorSAXFunc setDocumentLocator;
-    startDocumentSAXFunc startDocument;
-    endDocumentSAXFunc endDocument;
-    startElementSAXFunc startElement;
-    endElementSAXFunc endElement;
-    referenceSAXFunc reference;
-    charactersSAXFunc characters;
-    ignorableWhitespaceSAXFunc ignorableWhitespace;
-    processingInstructionSAXFunc processingInstruction;
-    commentSAXFunc comment;
-    warningSAXFunc warning;
-    errorSAXFunc error;
-    fatalErrorSAXFunc fatalError; /* unused error() get all the errors */
-    getParameterEntitySAXFunc getParameterEntity;
-    cdataBlockSAXFunc cdataBlock;
-    externalSubsetSAXFunc externalSubset;
-    unsigned int initialized;
-};
-

-
-
xmlSAXHandlerV1Ptr
typedef xmlSAXHandlerV1 *xmlSAXHandlerV1Ptr;
-

-
-
xmlExternalEntityLoader ()
xmlParserInputPtr (*xmlExternalEntityLoader)
-                                            (const char *URL,
-                                             const char *ID,
-                                             xmlParserCtxtPtr context);

-External entity loaders types.

-
-
URL: The System ID of the resource requested
-
ID: The Public ID of the resource requested
-
context: the XML parser context 
-
Returns :the entity input parser.
-
xmlInitParser ()
void        xmlInitParser                   (void);

-Initialization function for the XML parser.
-This is not reentrant. Call once before processing in case of
-use in multithreaded programs.

-
-
xmlCleanupParser ()
void        xmlCleanupParser                (void);

-Cleanup function for the XML library. It tries to reclaim all
-parsing related global memory allocated for the library processing.
-It doesn't deallocate any document related memory. Calling this
-function should not prevent reusing the library but one should
-call xmlCleanupParser() only when the process has
-finished using the library or XML document built with it.

-
-
xmlParserInputRead ()
int         xmlParserInputRead              (xmlParserInputPtr in,
-                                             int len);

-This function refresh the input for the parser. It doesn't try to
-preserve pointers to the input buffer, and discard already read data

-
-
in:  an XML parser input
-
len:  an indicative size for the lookahead
-
Returns :the number of xmlChars read, or -1 in case of error, 0 indicate the
-end of this entity
-
xmlParserInputGrow ()
int         xmlParserInputGrow              (xmlParserInputPtr in,
-                                             int len);

-This function increase the input for the parser. It tries to
-preserve pointers to the input buffer, and keep already read data

-
-
in:  an XML parser input
-
len:  an indicative size for the lookahead
-
Returns :the number of xmlChars read, or -1 in case of error, 0 indicate the
-end of this entity
-
xmlStrdup ()
xmlChar*    xmlStrdup                       (const xmlChar *cur);

-a strdup for array of xmlChar's. Since they are supposed to be
-encoded in UTF-8 or an encoding with 8bit based chars, we assume
-a termination mark of '0'.

-
-
cur:  the input xmlChar *
-
Returns :a new xmlChar * or NULL
-
xmlStrndup ()
xmlChar*    xmlStrndup                      (const xmlChar *cur,
-                                             int len);

-a strndup for array of xmlChar's

-
-
cur:  the input xmlChar *
-
len:  the len of cur
-
Returns :a new xmlChar * or NULL
-
xmlCharStrndup ()
xmlChar*    xmlCharStrndup                  (const char *cur,
-                                             int len);

-a strndup for char's to xmlChar's

-
-
cur:  the input char *
-
len:  the len of cur
-
Returns :a new xmlChar * or NULL
-
xmlCharStrdup ()
xmlChar*    xmlCharStrdup                   (const char *cur);

-a strdup for char's to xmlChar's

-
-
cur:  the input char *
-
Returns :a new xmlChar * or NULL
-
xmlStrsub ()
xmlChar*    xmlStrsub                       (const xmlChar *str,
-                                             int start,
-                                             int len);

-Extract a substring of a given string

-
-
str:  the xmlChar * array (haystack)
-
start:  the index of the first char (zero based)
-
len:  the length of the substring
-
Returns :the xmlChar * for the first occurrence or NULL.
-
xmlStrchr ()
const xmlChar* xmlStrchr                    (const xmlChar *str,
-                                             xmlChar val);

-a strchr for xmlChar's

-
-
str:  the xmlChar * array
-
val:  the xmlChar to search
-
Returns :the xmlChar * for the first occurrence or NULL.
-
xmlStrstr ()
const xmlChar* xmlStrstr                    (const xmlChar *str,
-                                             const xmlChar *val);

-a strstr for xmlChar's

-
-
str:  the xmlChar * array (haystack)
-
val:  the xmlChar to search (needle)
-
Returns :the xmlChar * for the first occurrence or NULL.
-
xmlStrcasestr ()
const xmlChar* xmlStrcasestr                (const xmlChar *str,
-                                             xmlChar *val);

-a case-ignoring strstr for xmlChar's

-
-
str:  the xmlChar * array (haystack)
-
val:  the xmlChar to search (needle)
-
Returns :the xmlChar * for the first occurrence or NULL.
-
xmlStrcmp ()
int         xmlStrcmp                       (const xmlChar *str1,
-                                             const xmlChar *str2);

-a strcmp for xmlChar's

-
-
str1:  the first xmlChar *
-
str2:  the second xmlChar *
-
Returns :the integer result of the comparison
-
xmlStrncmp ()
int         xmlStrncmp                      (const xmlChar *str1,
-                                             const xmlChar *str2,
-                                             int len);

-a strncmp for xmlChar's

-
-
str1:  the first xmlChar *
-
str2:  the second xmlChar *
-
len:  the max comparison length
-
Returns :the integer result of the comparison
-
xmlStrcasecmp ()
int         xmlStrcasecmp                   (const xmlChar *str1,
-                                             const xmlChar *str2);

-a strcasecmp for xmlChar's

-
-
str1:  the first xmlChar *
-
str2:  the second xmlChar *
-
Returns :the integer result of the comparison
-
xmlStrncasecmp ()
int         xmlStrncasecmp                  (const xmlChar *str1,
-                                             const xmlChar *str2,
-                                             int len);

-a strncasecmp for xmlChar's

-
-
str1:  the first xmlChar *
-
str2:  the second xmlChar *
-
len:  the max comparison length
-
Returns :the integer result of the comparison
-
xmlStrEqual ()
int         xmlStrEqual                     (const xmlChar *str1,
-                                             const xmlChar *str2);

-Check if both string are equal of have same content
-Should be a bit more readable and faster than xmlStrEqual()

-
-
str1:  the first xmlChar *
-
str2:  the second xmlChar *
-
Returns :1 if they are equal, 0 if they are different
-
xmlStrQEqual ()
int         xmlStrQEqual                    (const xmlChar *pref,
-                                             const xmlChar *name,
-                                             const xmlChar *str);

-Check if a QName is Equal to a given string

-
-
pref:  the prefix of the QName
-
name:  the localname of the QName
-
str:  the second xmlChar *
-
Returns :1 if they are equal, 0 if they are different
-
xmlStrlen ()
int         xmlStrlen                       (const xmlChar *str);

-length of a xmlChar's string

-
-
str:  the xmlChar * array
-
Returns :the number of xmlChar contained in the ARRAY.
-
xmlStrcat ()
xmlChar*    xmlStrcat                       (xmlChar *cur,
-                                             const xmlChar *add);

-a strcat for array of xmlChar's. Since they are supposed to be
-encoded in UTF-8 or an encoding with 8bit based chars, we assume
-a termination mark of '0'.

-
-
cur:  the original xmlChar * array
-
add:  the xmlChar * array added
-
Returns :a new xmlChar * containing the concatenated string.
-
xmlStrncat ()
xmlChar*    xmlStrncat                      (xmlChar *cur,
-                                             const xmlChar *add,
-                                             int len);

-a strncat for array of xmlChar's, it will extend cur with the len
-first bytes of add.

-
-
cur:  the original xmlChar * array
-
add:  the xmlChar * array added
-
len:  the length of add
-
Returns :a new xmlChar *, the original cur is reallocated if needed
-and should not be freed
-
xmlStrPrintf ()
int         xmlStrPrintf                    (xmlChar *buf,
-                                             int len,
-                                             const xmlChar *msg,
-                                             ...);

-Formats msg and places result into buf.

-
-
buf:   the result buffer.
-
len:   the result buffer length.
-
msg:   the message with printf formatting.
-
...:   extra parameters for the message.
-
Returns :the number of characters written to buf or -1 if an error occurs.
-
xmlStrVPrintf ()
int         xmlStrVPrintf                   (xmlChar *buf,
-                                             int len,
-                                             const xmlChar *msg,
-                                             va_list ap);

-Formats msg and places result into buf.

-
-
buf:   the result buffer.
-
len:   the result buffer length.
-
msg:   the message with printf formatting.
-
ap:    extra parameters for the message.
-
Returns :the number of characters written to buf or -1 if an error occurs.
-
xmlParseDoc ()
xmlDocPtr   xmlParseDoc                     (xmlChar *cur);

-parse an XML in-memory document and build a tree.

-
-
cur:  a pointer to an array of xmlChar
-
Returns :the resulting document tree
-
xmlParseMemory ()
xmlDocPtr   xmlParseMemory                  (const char *buffer,
-                                             int size);

-parse an XML in-memory block and build a tree.

-
-
buffer:  an pointer to a char array
-
size:  the size of the array
-
Returns :the resulting document tree
-
xmlParseFile ()
xmlDocPtr   xmlParseFile                    (const char *filename);

-parse an XML file and build a tree. Automatic support for ZLIB/Compress
-compressed document is provided by default if found at compile-time.

-
-
filename:  the filename
-
Returns :the resulting document tree if the file was wellformed,
-NULL otherwise.
-
xmlSubstituteEntitiesDefault ()
int         xmlSubstituteEntitiesDefault    (int val);

-Set and return the previous value for default entity support.
-Initially the parser always keep entity references instead of substituting
-entity values in the output. This function has to be used to change the
-default parser behavior
-SAX::substituteEntities() has to be used for changing that on a file by
-file basis.

-
-
val:  int 0 or 1 
-
Returns :the last value for 0 for no substitution, 1 for substitution.
-
xmlKeepBlanksDefault ()
int         xmlKeepBlanksDefault            (int val);

-Set and return the previous value for default blanks text nodes support.
-The 1.x version of the parser used an heuristic to try to detect
-ignorable white spaces. As a result the SAX callback was generating
-xmlSAX2IgnorableWhitespace() callbacks instead of characters() one, and when
-using the DOM output text nodes containing those blanks were not generated.
-The 2.x and later version will switch to the XML standard way and
-ignorableWhitespace() are only generated when running the parser in
-validating mode and when the current element doesn't allow CDATA or
-mixed content.
-This function is provided as a way to force the standard behavior 
-on 1.X libs and to switch back to the old mode for compatibility when
-running 1.X client code on 2.X . Upgrade of 1.X code should be done
-by using xmlIsBlankNode() commodity function to detect the "empty"
-nodes generated.
-This value also affect autogeneration of indentation when saving code
-if blanks sections are kept, indentation is not generated.

-
-
val:  int 0 or 1 
-
Returns :the last value for 0 for no substitution, 1 for substitution.
-
xmlStopParser ()
void        xmlStopParser                   (xmlParserCtxtPtr ctxt);

-Blocks further parser processing

-
-
ctxt:  an XML parser context
-
xmlPedanticParserDefault ()
int         xmlPedanticParserDefault        (int val);

-Set and return the previous value for enabling pedantic warnings.

-
-
val:  int 0 or 1 
-
Returns :the last value for 0 for no substitution, 1 for substitution.
-
xmlLineNumbersDefault ()
int         xmlLineNumbersDefault           (int val);

-Set and return the previous value for enabling line numbers in elements
-contents. This may break on old application and is turned off by default.

-
-
val:  int 0 or 1 
-
Returns :the last value for 0 for no substitution, 1 for substitution.
-
xmlRecoverDoc ()
xmlDocPtr   xmlRecoverDoc                   (xmlChar *cur);

-parse an XML in-memory document and build a tree.
-In the case the document is not Well Formed, a tree is built anyway

-
-
cur:  a pointer to an array of xmlChar
-
Returns :the resulting document tree
-
xmlRecoverMemory ()
xmlDocPtr   xmlRecoverMemory                (const char *buffer,
-                                             int size);

-parse an XML in-memory block and build a tree.
-In the case the document is not Well Formed, a tree is built anyway

-
-
buffer:  an pointer to a char array
-
size:  the size of the array
-
Returns :the resulting document tree
-
xmlRecoverFile ()
xmlDocPtr   xmlRecoverFile                  (const char *filename);

-parse an XML file and build a tree. Automatic support for ZLIB/Compress
-compressed document is provided by default if found at compile-time.
-In the case the document is not Well Formed, a tree is built anyway

-
-
filename:  the filename
-
Returns :the resulting document tree
-
xmlParseDocument ()
int         xmlParseDocument                (xmlParserCtxtPtr ctxt);

-parse an XML document (and build a tree if using the standard SAX
-interface).
-

-[1] document ::= prolog element Misc*
-

-[22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?

-
-
ctxt:  an XML parser context
-
Returns :0, -1 in case of error. the parser context is augmented
-               as a result of the parsing.
-
xmlParseExtParsedEnt ()
int         xmlParseExtParsedEnt            (xmlParserCtxtPtr ctxt);

-parse a general parsed entity
-An external general parsed entity is well-formed if it matches the
-production labeled extParsedEnt.
-

-[78] extParsedEnt ::= TextDecl? content

-
-
ctxt:  an XML parser context
-
Returns :0, -1 in case of error. the parser context is augmented
-               as a result of the parsing.
-
xmlSAXParseDoc ()
xmlDocPtr   xmlSAXParseDoc                  (xmlSAXHandlerPtr sax,
-                                             xmlChar *cur,
-                                             int recovery);

-parse an XML 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.

-
-
sax:  the SAX handler block
-
cur:  a pointer to an array of xmlChar
-
recovery:  work in recovery mode, i.e. tries to read no Well Formed
-            documents
-
Returns :the resulting document tree
-
xmlSAXUserParseFile ()
int         xmlSAXUserParseFile             (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *filename);

-parse an XML file and call the given SAX handler routines.
-Automatic support for ZLIB/Compress compressed document is provided

-
-
sax:  a SAX handler
-
user_data:  The user data returned on SAX callbacks
-
filename:  a file name
-
Returns :0 in case of success or a error number otherwise
-
xmlSAXUserParseMemory ()
int         xmlSAXUserParseMemory           (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *buffer,
-                                             int size);

-A better SAX parsing routine.
-parse an XML in-memory buffer and call the given SAX handler routines.

-
-
sax:  a SAX handler
-
user_data:  The user data returned on SAX callbacks
-
buffer:  an in-memory XML document input
-
size:  the length of the XML document in bytes
-
Returns :0 in case of success or a error number otherwise
-
xmlSAXParseMemory ()
xmlDocPtr   xmlSAXParseMemory               (xmlSAXHandlerPtr sax,
-                                             const char *buffer,
-                                             int size,
-                                             int recovery);

-parse an XML in-memory block and use the given SAX function block
-to handle the parsing callback. If sax is NULL, fallback to the default
-DOM tree building routines.

-
-
sax:  the SAX handler block
-
buffer:  an pointer to a char array
-
size:  the size of the array
-
recovery:  work in recovery mode, i.e. tries to read not Well Formed
-            documents
-
Returns :the resulting document tree
-
xmlSAXParseMemoryWithData ()
xmlDocPtr   xmlSAXParseMemoryWithData       (xmlSAXHandlerPtr sax,
-                                             const char *buffer,
-                                             int size,
-                                             int recovery,
-                                             void *data);

-parse an XML in-memory block and use the given SAX function block
-to handle the parsing callback. If sax is NULL, fallback to the default
-DOM tree building routines.
-

-User data (void *) is stored within the parser context in the
-context's _private member, so it is available nearly everywhere in libxml

-
-
sax:  the SAX handler block
-
buffer:  an pointer to a char array
-
size:  the size of the array
-
recovery:  work in recovery mode, i.e. tries to read no Well Formed
-            documents
-
data:  the userdata
-
Returns :the resulting document tree
-
xmlSAXParseFile ()
xmlDocPtr   xmlSAXParseFile                 (xmlSAXHandlerPtr sax,
-                                             const char *filename,
-                                             int recovery);

-parse an XML 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.

-
-
sax:  the SAX handler block
-
filename:  the filename
-
recovery:  work in recovery mode, i.e. tries to read no Well Formed
-            documents
-
Returns :the resulting document tree
-
xmlSAXParseFileWithData ()
xmlDocPtr   xmlSAXParseFileWithData         (xmlSAXHandlerPtr sax,
-                                             const char *filename,
-                                             int recovery,
-                                             void *data);

-parse an XML 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.
-

-User data (void *) is stored within the parser context in the
-context's _private member, so it is available nearly everywhere in libxml

-
-
sax:  the SAX handler block
-
filename:  the filename
-
recovery:  work in recovery mode, i.e. tries to read no Well Formed
-            documents
-
data:  the userdata
-
Returns :the resulting document tree
-
xmlSAXParseEntity ()
xmlDocPtr   xmlSAXParseEntity               (xmlSAXHandlerPtr sax,
-                                             const char *filename);

-parse an XML external entity out of context 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.
-

-[78] extParsedEnt ::= TextDecl? content
-

-This correspond to a "Well Balanced" chunk

-
-
sax:  the SAX handler block
-
filename:  the filename
-
Returns :the resulting document tree
-
xmlParseEntity ()
xmlDocPtr   xmlParseEntity                  (const char *filename);

-parse an XML external entity out of context and build a tree.
-

-[78] extParsedEnt ::= TextDecl? content
-

-This correspond to a "Well Balanced" chunk

-
-
filename:  the filename
-
Returns :the resulting document tree
-
xmlParseDTD ()
xmlDtdPtr   xmlParseDTD                     (const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

-Load and parse an external subset.

-
-
ExternalID:  a NAME* containing the External ID of the DTD
-
SystemID:  a NAME* containing the URL to the DTD
-
Returns :the resulting xmlDtdPtr or NULL in case of error.
-
xmlSAXParseDTD ()
xmlDtdPtr   xmlSAXParseDTD                  (xmlSAXHandlerPtr sax,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

-Load and parse an external subset.

-
-
sax:  the SAX handler block
-
ExternalID:  a NAME* containing the External ID of the DTD
-
SystemID:  a NAME* containing the URL to the DTD
-
Returns :the resulting xmlDtdPtr or NULL in case of error.
-
xmlIOParseDTD ()
xmlDtdPtr   xmlIOParseDTD                   (xmlSAXHandlerPtr sax,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);

-Load and parse a DTD

-
-
sax:  the SAX handler block or NULL
-
input:  an Input Buffer
-
enc:  the charset encoding if known
-
Returns :the resulting xmlDtdPtr or NULL in case of error.
-input will be freed at parsing end.
-
xmlParseBalancedChunkMemory ()
int         xmlParseBalancedChunkMemory     (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst);

-Parse a well-balanced chunk of an XML document
-called by the parser
-The allowed sequence for the Well Balanced Chunk is the one defined by
-the content production in the XML grammar:
-

-[43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

-
-
doc:  the document the chunk pertains to
-
sax:  the SAX handler bloc (possibly NULL)
-
user_data:  The user data returned on SAX callbacks (possibly NULL)
-
depth:  Used for loop detection, use 0
-
string:  the input string in UTF8 or ISO-Latin (zero terminated)
-
lst:  the return value for the set of parsed nodes
-
Returns :0 if the chunk is well balanced, -1 in case of args problem and
-   the parser error code otherwise
-
xmlParseBalancedChunkMemoryRecover ()
int         xmlParseBalancedChunkMemoryRecover
-                                            (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             int depth,
-                                             const xmlChar *string,
-                                             xmlNodePtr *lst,
-                                             int recover);

-Parse a well-balanced chunk of an XML document
-called by the parser
-The allowed sequence for the Well Balanced Chunk is the one defined by
-the content production in the XML grammar:
-

-[43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

-
-
doc:  the document the chunk pertains to
-
sax:  the SAX handler bloc (possibly NULL)
-
user_data:  The user data returned on SAX callbacks (possibly NULL)
-
depth:  Used for loop detection, use 0
-
string:  the input string in UTF8 or ISO-Latin (zero terminated)
-
lst:  the return value for the set of parsed nodes
-
recover: return nodes even if the data is broken (use 0)
-
Returns :0 if the chunk is well balanced, -1 in case of args problem and
-   the parser error code otherwise
-   
-In case recover is set to 1, the nodelist will not be empty even if
-the parsed chunk is not well balanced. 
-
xmlParseExternalEntity ()
int         xmlParseExternalEntity          (xmlDocPtr doc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             int depth,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);

-Parse an external general entity
-An external general parsed entity is well-formed if it matches the
-production labeled extParsedEnt.
-

-[78] extParsedEnt ::= TextDecl? content

-
-
doc:  the document the chunk pertains to
-
sax:  the SAX handler bloc (possibly NULL)
-
user_data:  The user data returned on SAX callbacks (possibly NULL)
-
depth:  Used for loop detection, use 0
-
URL:  the URL for the entity to load
-
ID:  the System ID for the entity to load
-
lst:  the return value for the set of parsed nodes
-
Returns :0 if the entity is well formed, -1 in case of args problem and
-   the parser error code otherwise
-
xmlParseCtxtExternalEntity ()
int         xmlParseCtxtExternalEntity      (xmlParserCtxtPtr ctx,
-                                             const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             xmlNodePtr *lst);

-Parse an external general entity within an existing parsing context
-An external general parsed entity is well-formed if it matches the
-production labeled extParsedEnt.
-

-[78] extParsedEnt ::= TextDecl? content

-
-
ctx:  the existing parsing context
-
URL:  the URL for the entity to load
-
ID:  the System ID for the entity to load
-
lst:  the return value for the set of parsed nodes
-
Returns :0 if the entity is well formed, -1 in case of args problem and
-   the parser error code otherwise
-
xmlNewParserCtxt ()
xmlParserCtxtPtr xmlNewParserCtxt           (void);

-Allocate and initialize a new parser context.

-
-
Returns :the xmlParserCtxtPtr or NULL
-
xmlInitParserCtxt ()
int         xmlInitParserCtxt               (xmlParserCtxtPtr ctxt);

-Initialize a parser context

-
-
ctxt:  an HTML parser context
-
Returns :0 in case of success and -1 in case of error
-
xmlClearParserCtxt ()
void        xmlClearParserCtxt              (xmlParserCtxtPtr ctxt);

-Clear (release owned resources) and reinitialize a parser context

-
-
ctxt:  an XML parser context
-
xmlFreeParserCtxt ()
void        xmlFreeParserCtxt               (xmlParserCtxtPtr ctxt);

-Free all the memory used by a parser context. However the parsed
-document in ctxt->myDoc is not freed.

-
-
ctxt:  an XML parser context
-
xmlSetupParserForBuffer ()
void        xmlSetupParserForBuffer         (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *buffer,
-                                             const char *filename);

-Setup the parser context to parse a new buffer; Clears any prior
-contents from the parser context. The buffer parameter must not be
-NULL, but the filename parameter can be

-
-
ctxt:  an XML parser context
-
buffer:  a xmlChar * buffer
-
filename:  a file name
-
xmlCreateDocParserCtxt ()
xmlParserCtxtPtr xmlCreateDocParserCtxt     (const xmlChar *cur);

-Creates a parser context for an XML in-memory document.

-
-
cur:  a pointer to an array of xmlChar
-
Returns :the new parser context or NULL
-
xmlGetFeaturesList ()
int         xmlGetFeaturesList              (int *len,
-                                             const char **result);

-Copy at most *len feature names into the result array

-
-
len:  the length of the features name array (input/output)
-
result:  an array of string to be filled with the features name.
-
Returns :-1 in case or error, or the total number of features,
-           len is updated with the number of strings copied,
-           strings must not be deallocated
-
xmlGetFeature ()
int         xmlGetFeature                   (xmlParserCtxtPtr ctxt,
-                                             const char *name,
-                                             void *result);

-Read the current value of one feature of this parser instance

-
-
ctxt:  an XML/HTML parser context
-
name:  the feature name
-
result:  location to store the result
-
Returns :-1 in case or error, 0 otherwise
-
xmlSetFeature ()
int         xmlSetFeature                   (xmlParserCtxtPtr ctxt,
-                                             const char *name,
-                                             void *value);

-Change the current value of one feature of this parser instance

-
-
ctxt:  an XML/HTML parser context
-
name:  the feature name
-
value:  pointer to the location of the new value
-
Returns :-1 in case or error, 0 otherwise
-
xmlCreatePushParserCtxt ()
xmlParserCtxtPtr xmlCreatePushParserCtxt    (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename);

-Create a parser context for using the XML parser in push mode.
-If buffer and size are non-NULL, the data is used to detect
-the encoding.  The remaining characters will be parsed so they
-don't need to be fed in again through xmlParseChunk.
-To allow content encoding detection, size should be >= 4
-The value of filename is used for fetching external entities
-and error/warning reports.

-
-
sax:  a SAX handler
-
user_data:  The user data returned on SAX callbacks
-
chunk:  a pointer to an array of chars
-
size:  number of chars in the array
-
filename:  an optional file name or URI
-
Returns :the new parser context or NULL
-
xmlParseChunk ()
int         xmlParseChunk                   (xmlParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             int terminate);

-Parse a Chunk of memory

-
-
ctxt:  an XML parser context
-
chunk:  an char array
-
size:  the size in byte of the chunk
-
terminate:  last chunk indicator
-
Returns :zero if no error, the xmlParserErrors otherwise.
-
xmlCreateIOParserCtxt ()
xmlParserCtxtPtr xmlCreateIOParserCtxt      (xmlSAXHandlerPtr sax,
-                                             void *user_data,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             xmlCharEncoding enc);

-Create a parser context for using the XML parser with an existing
-I/O stream

-
-
sax:  a SAX handler
-
user_data:  The user data returned on SAX callbacks
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
enc:  the charset encoding if known
-
Returns :the new parser context or NULL
-
xmlNewIOInputStream ()
xmlParserInputPtr xmlNewIOInputStream       (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc);

-Create a new input stream structure encapsulating the input into
-a stream suitable for the parser.

-
-
ctxt:  an XML parser context
-
input:  an I/O Input
-
enc:  the charset encoding if known
-
Returns :the new input stream or NULL
-
xmlParserFindNodeInfo ()
const xmlParserNodeInfo* xmlParserFindNodeInfo
-                                            (const xmlParserCtxtPtr ctxt,
-                                             const xmlNodePtr node);

-Find the parser node info struct for a given node

-
-
ctxt:
-
node:  an XML node within the tree
-
Returns :an xmlParserNodeInfo block pointer or NULL
-
xmlInitNodeInfoSeq ()
void        xmlInitNodeInfoSeq              (xmlParserNodeInfoSeqPtr seq);

--- Initialize (set to initial state) node info sequence

-
-
seq:  a node info sequence pointer
-
xmlClearNodeInfoSeq ()
void        xmlClearNodeInfoSeq             (xmlParserNodeInfoSeqPtr seq);

--- Clear (release memory and reinitialize) node
-  info sequence

-
-
seq:  a node info sequence pointer
-
xmlParserAddNodeInfo ()
void        xmlParserAddNodeInfo            (xmlParserCtxtPtr ctxt,
-                                             const xmlParserNodeInfoPtr info);

-Insert node info record into the sorted sequence

-
-
ctxt:  an XML parser context
-
info:  a node info sequence pointer
-
xmlSetExternalEntityLoader ()
void        xmlSetExternalEntityLoader      (xmlExternalEntityLoader f);

-Changes the defaultexternal entity resolver function for the application

-
-
f:  the new entity resolver function
-
xmlGetExternalEntityLoader ()
xmlExternalEntityLoader xmlGetExternalEntityLoader
-                                            (void);

-Get the default external entity resolver function for the application

-
-
Returns :the xmlExternalEntityLoader function pointer
-
xmlLoadExternalEntity ()
xmlParserInputPtr xmlLoadExternalEntity     (const char *URL,
-                                             const char *ID,
-                                             xmlParserCtxtPtr ctxt);

-Load an external entity, note that the use of this function for
-unparsed entities may generate problems
-TODO: a more generic External entity API must be designed

-
-
URL:  the URL for the entity to load
-
ID:  the Public ID for the entity to load
-
ctxt:  the context in which the entity is called or NULL
-
Returns :the xmlParserInputPtr or NULL
-
enum xmlParserOption
typedef enum {
-    XML_PARSE_RECOVER	= 1<<0,	/* recover on errors */
-    XML_PARSE_NOENT	= 1<<1,	/* substitute entities */
-    XML_PARSE_DTDLOAD	= 1<<2,	/* load the external subset */
-    XML_PARSE_DTDATTR	= 1<<3,	/* default DTD attributes */
-    XML_PARSE_DTDVALID	= 1<<4,	/* validate with the DTD */
-    XML_PARSE_NOERROR	= 1<<5,	/* suppress error reports */
-    XML_PARSE_NOWARNING	= 1<<6,	/* suppress warning reports */
-    XML_PARSE_PEDANTIC	= 1<<7,	/* pedantic error reporting */
-    XML_PARSE_NOBLANKS	= 1<<8,	/* remove blank nodes */
-    XML_PARSE_SAX1	= 1<<9,	/* use the SAX1 interface internally */
-    XML_PARSE_XINCLUDE	= 1<<10,/* Implement XInclude substitition  */
-    XML_PARSE_NONET	= 1<<11,/* Forbid network access */
-    XML_PARSE_NODICT	= 1<<12,/* Do not reuse the context dictionnary */
-    XML_PARSE_NSCLEAN	= 1<<13,/* remove redundant namespaces declarations */
-    XML_PARSE_NOCDATA	= 1<<14 /* merge CDATA as text nodes */
-} xmlParserOption;
-

-This is the set of XML parser options that can be passed down
-to the xmlReadDoc() and similar calls.

-
-
xmlCtxtReset ()
void        xmlCtxtReset                    (xmlParserCtxtPtr ctxt);

-Reset a parser context

-
-
ctxt: an XML parser context
-
xmlCtxtResetPush ()
int         xmlCtxtResetPush                (xmlParserCtxtPtr ctxt,
-                                             const char *chunk,
-                                             int size,
-                                             const char *filename,
-                                             const char *encoding);

-Reset a push parser context

-
-
ctxt: an XML parser context
-
chunk:  a pointer to an array of chars
-
size:  number of chars in the array
-
filename:  an optional file name or URI
-
encoding:  the document encoding, or NULL
-
Returns :0 in case of success and 1 in case of error
-
xmlCtxtUseOptions ()
int         xmlCtxtUseOptions               (xmlParserCtxtPtr ctxt,
-                                             int options);

-Applies the options to the parser context

-
-
ctxt: an XML parser context
-
options:  a combination of xmlParserOption(s)
-
Returns :0 in case of success, the set of unknown or unimplemented options
-        in case of error.
-
xmlReadDoc ()
xmlDocPtr   xmlReadDoc                      (const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.

-
-
cur:  a pointer to a zero terminated string
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlReadFile ()
xmlDocPtr   xmlReadFile                     (const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML file from the filesystem or the network.

-
-
URL:
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlReadMemory ()
xmlDocPtr   xmlReadMemory                   (const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.

-
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlReadFd ()
xmlDocPtr   xmlReadFd                       (int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML from a file descriptor and build a tree.

-
-
fd:  an open file descriptor
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlReadIO ()
xmlDocPtr   xmlReadIO                       (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML document from I/O functions and source and build a tree.

-
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlCtxtReadDoc ()
xmlDocPtr   xmlCtxtReadDoc                  (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an XML parser context
-
cur:  a pointer to a zero terminated string
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlCtxtReadFile ()
xmlDocPtr   xmlCtxtReadFile                 (xmlParserCtxtPtr ctxt,
-                                             const char *filename,
-                                             const char *encoding,
-                                             int options);

-parse an XML file from the filesystem or the network.
-This reuses the existing ctxt parser context

-
-
ctxt:  an XML parser context
-
filename:  a file or URL
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlCtxtReadMemory ()
xmlDocPtr   xmlCtxtReadMemory               (xmlParserCtxtPtr ctxt,
-                                             const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML in-memory document and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an XML parser context
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlCtxtReadFd ()
xmlDocPtr   xmlCtxtReadFd                   (xmlParserCtxtPtr ctxt,
-                                             int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML from a file descriptor and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an XML parser context
-
fd:  an open file descriptor
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
xmlCtxtReadIO ()
xmlDocPtr   xmlCtxtReadIO                   (xmlParserCtxtPtr ctxt,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-parse an XML document from I/O functions and source and build a tree.
-This reuses the existing ctxt parser context

-
-
ctxt:  an XML parser context
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the resulting document tree
-
<< threadsc14n >>

+
+
+Module parser from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module parser from libxml2
Main Menu
Related links
Table of Contents
void	xmlSetupParserForBuffer	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * buffer, 
				 const char * filename)

+
xmlDocPtr	xmlCtxtReadFile	(xmlParserCtxtPtr ctxt, 
				 const char * filename, 
				 const char * encoding, 
				 int options)

+
int	xmlStrcmp	(const xmlChar * str1, 
				 const xmlChar * str2)

+
xmlDocPtr	xmlParseMemory	(const char * buffer, 
				 int size)

+
int	xmlParseCtxtExternalEntity	(xmlParserCtxtPtr ctx, 
				 const xmlChar * URL, 
				 const xmlChar * ID, 
				 xmlNodePtr * lst)

+
Structure xmlParserNodeInfoSeq
struct _xmlParserNodeInfoSeq {
+    unsigned long	maximum
+    unsigned long	length
+    xmlParserNodeInfo *	buffer
+}

const xmlChar *	xmlStrcasestr	(const xmlChar * str, 
				 xmlChar * val)

+
xmlChar *	xmlStrcat	(xmlChar * cur, 
				 const xmlChar * add)

+
Function type: attributeDeclSAXFunc
+void	attributeDeclSAXFunc	(void * ctx, 
				 const xmlChar * elem, 
				 const xmlChar * fullname, 
				 int type, 
				 int def, 
				 const xmlChar * defaultValue, 
				 xmlEnumerationPtr tree)
+
An attribute definition has been parsed.
ctx:the user data (XML parser context)
elem:the name of the element
fullname:the attribute name
type:the attribute type
def:the type of default value
defaultValue:the attribute default value
tree:the tree of enumerated value set


+
Function type: getEntitySAXFunc
+xmlEntityPtr	getEntitySAXFunc	(void * ctx, 
				 const xmlChar * name)
+
Get an entity by name.
ctx:the user data (XML parser context)
name:The entity name
Returns:the xmlEntityPtr if found.


+
const xmlChar *	xmlStrstr	(const xmlChar * str, 
				 const xmlChar * val)

+
Function type: startElementSAXFunc
+void	startElementSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar ** atts)
+
Called when an opening tag has been processed.
ctx:the user data (XML parser context)
name:The element name, including namespace prefix
atts:An array of name/value attributes pairs, NULL terminated


+
Function type: charactersSAXFunc
+void	charactersSAXFunc	(void * ctx, 
				 const xmlChar * ch, 
				 int len)
+
Receiving some chars from the parser.
ctx:the user data (XML parser context)
ch:a xmlChar string
len:the number of xmlChar


+
void	xmlClearNodeInfoSeq	(xmlParserNodeInfoSeqPtr seq)

+
int	xmlParseChunk	(xmlParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 int terminate)

+
xmlDocPtr	xmlReadMemory	(const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
xmlDocPtr	xmlParseEntity	(const char * filename)

+
xmlDocPtr	xmlRecoverFile	(const char * filename)

+
xmlChar *	xmlStrdup	(const xmlChar * cur)

+
Function type: unparsedEntityDeclSAXFunc
+void	unparsedEntityDeclSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId, 
				 const xmlChar * notationName)
+
What to do when an unparsed entity declaration is parsed.
ctx:the user data (XML parser context)
name:The name of the entity
publicId:The public ID of the entity
systemId:The system ID of the entity
notationName:the name of the notation


+
Function type: startElementNsSAX2Func
+void	startElementNsSAX2Func	(void * ctx, 
				 const xmlChar * localname, 
				 const xmlChar * prefix, 
				 const xmlChar * URI, 
				 int nb_namespaces, 
				 const xmlChar ** namespaces, 
				 int nb_attributes, 
				 int nb_defaulted, 
				 const xmlChar ** attributes)
+
SAX2 callback when an element start has been detected by the parser. It provides the namespace informations for the element, as well as the new namespace declarations on the element.
ctx:the user data (XML parser context)
localname:the local name of the element
prefix:the element namespace prefix if available
URI:the element namespace name if available
nb_namespaces:number of namespace definitions on that node
namespaces:pointer to the array of prefix/URI pairs namespace definitions
nb_attributes:the number of attributes on that node
nb_defaulted:the number of defaulted attributes. The defaulted ones are at the end of the array
attributes:pointer to the array of (localname/prefix/URI/value/end) attribute values.


+
xmlParserCtxtPtr	xmlCreateIOParserCtxt	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 xmlCharEncoding enc)

+
Function type: referenceSAXFunc
+void	referenceSAXFunc	(void * ctx, 
				 const xmlChar * name)
+
Called when an entity reference is detected.
ctx:the user data (XML parser context)
name:The entity name


+
xmlChar *	xmlStrncat	(xmlChar * cur, 
				 const xmlChar * add, 
				 int len)

+
Function type: hasExternalSubsetSAXFunc
+int	hasExternalSubsetSAXFunc	(void * ctx)
+
Does this document has an external subset?
ctx:the user data (XML parser context)
Returns:1 if true


+
Typedef xmlSAXHandlerV1 * xmlSAXHandlerV1Ptr
+
+
int	xmlStrPrintf	(xmlChar * buf, 
				 int len, 
				 const xmlChar * msg, 
				 ... ...)

+
xmlDocPtr	xmlSAXParseDoc	(xmlSAXHandlerPtr sax, 
				 xmlChar * cur, 
				 int recovery)

+
xmlChar *	xmlStrndup	(const xmlChar * cur, 
				 int len)

+
xmlChar *	xmlCharStrdup	(const char * cur)

+
xmlParserInputPtr	xmlNewIOInputStream	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputBufferPtr input, 
				 xmlCharEncoding enc)

+
Function type: processingInstructionSAXFunc
+void	processingInstructionSAXFunc	(void * ctx, 
				 const xmlChar * target, 
				 const xmlChar * data)
+
A processing instruction has been parsed.
ctx:the user data (XML parser context)
target:the target name
data:the PI data's


+
int	xmlParseBalancedChunkMemoryRecover	(xmlDocPtr doc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 int depth, 
				 const xmlChar * string, 
				 xmlNodePtr * lst, 
				 int recover)

+
void	xmlInitParser	(void)

+
Function type: errorSAXFunc
+void	errorSAXFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
Display and format an error messages, callback.
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display


+
Enum xmlParserInputState {
+    XML_PARSER_EOF = -1 : nothing is to be parsed
+    XML_PARSER_START = 0 : nothing has been parsed
+    XML_PARSER_MISC = 1 : Misc* before int subset
+    XML_PARSER_PI = 2 : Within a processing instruction
+    XML_PARSER_DTD = 3 : within some DTD content
+    XML_PARSER_PROLOG = 4 : Misc* after internal subset
+    XML_PARSER_COMMENT = 5 : within a comment
+    XML_PARSER_START_TAG = 6 : within a start tag
+    XML_PARSER_CONTENT = 7 : within the content
+    XML_PARSER_CDATA_SECTION = 8 : within a CDATA section
+    XML_PARSER_END_TAG = 9 : within a closing tag
+    XML_PARSER_ENTITY_DECL = 10 : within an entity declaration
+    XML_PARSER_ENTITY_VALUE = 11 : within an entity value in a decl
+    XML_PARSER_ATTRIBUTE_VALUE = 12 : within an attribute value
+    XML_PARSER_SYSTEM_LITERAL = 13 : within a SYSTEM value
+    XML_PARSER_EPILOG = 14 : the Misc* after the last end tag
+    XML_PARSER_IGNORE = 15 : within an IGNORED section
+    XML_PARSER_PUBLIC_LITERAL = 16 : within a PUBLIC value
+}
+
+
xmlDocPtr	xmlSAXParseMemory	(xmlSAXHandlerPtr sax, 
				 const char * buffer, 
				 int size, 
				 int recovery)

+
xmlDocPtr	xmlRecoverMemory	(const char * buffer, 
				 int size)

+
Function type: xmlExternalEntityLoader
+xmlParserInputPtr	xmlExternalEntityLoader	(const char * URL, 
				 const char * ID, 
				 xmlParserCtxtPtr context)
+
External entity loaders types.
URL:The System ID of the resource requested
ID:The Public ID of the resource requested
context:the XML parser context
Returns:the entity input parser.


+
Function type: hasInternalSubsetSAXFunc
+int	hasInternalSubsetSAXFunc	(void * ctx)
+
Does this document has an internal subset.
ctx:the user data (XML parser context)
Returns:1 if true


+
xmlDocPtr	xmlReadDoc	(const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Function type: cdataBlockSAXFunc
+void	cdataBlockSAXFunc	(void * ctx, 
				 const xmlChar * value, 
				 int len)
+
Called when a pcdata block has been parsed.
ctx:the user data (XML parser context)
value:The pcdata content
len:the block length


+
#define XML_COMPLETE_ATTRS
+
+
xmlDocPtr	xmlSAXParseFile	(xmlSAXHandlerPtr sax, 
				 const char * filename, 
				 int recovery)

+
Function type: xmlParserInputDeallocate
+void	xmlParserInputDeallocate	(xmlChar * str)
+
Callback for freeing some parser input allocations.
str:the string to deallocate


+
Typedef xmlParserNodeInfo * xmlParserNodeInfoPtr
+
+
xmlDocPtr	xmlCtxtReadIO	(xmlParserCtxtPtr ctxt, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
xmlDocPtr	xmlSAXParseMemoryWithData	(xmlSAXHandlerPtr sax, 
				 const char * buffer, 
				 int size, 
				 int recovery, 
				 void * data)

+
const xmlParserNodeInfo *	xmlParserFindNodeInfo	(const xmlParserCtxtPtr ctx, 
				 const xmlNodePtr node)

+
int	xmlGetFeature	(xmlParserCtxtPtr ctxt, 
				 const char * name, 
				 void * result)

+
Structure xmlParserNodeInfo
struct _xmlParserNodeInfo {
+    const struct _xmlNode *	node	: Position & line # that text that created the node
+    unsigned long	begin_pos
+    unsigned long	begin_line
+    unsigned long	end_pos
+    unsigned long	end_line
+}

const xmlChar *	xmlStrchr	(const xmlChar * str, 
				 xmlChar val)

+
xmlDtdPtr	xmlIOParseDTD	(xmlSAXHandlerPtr sax, 
				 xmlParserInputBufferPtr input, 
				 xmlCharEncoding enc)

+
void	xmlFreeParserCtxt	(xmlParserCtxtPtr ctxt)

+
xmlDtdPtr	xmlParseDTD	(const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Function type: commentSAXFunc
+void	commentSAXFunc	(void * ctx, 
				 const xmlChar * value)
+
A comment has been parsed.
ctx:the user data (XML parser context)
value:the comment content


+
int	xmlInitParserCtxt	(xmlParserCtxtPtr ctxt)

+
Function type: attributeSAXFunc
+void	attributeSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * value)
+
Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to the element.
ctx:the user data (XML parser context)
name:The attribute name, including namespace prefix
value:The attribute value


+
int	xmlStrQEqual	(const xmlChar * pref, 
				 const xmlChar * name, 
				 const xmlChar * str)

+
int	xmlParserInputGrow	(xmlParserInputPtr in, 
				 int len)

+
xmlDocPtr	xmlCtxtReadMemory	(xmlParserCtxtPtr ctxt, 
				 const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Function type: externalSubsetSAXFunc
+void	externalSubsetSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)
+
Callback on external subset declaration.
ctx:the user data (XML parser context)
name:the root element name
ExternalID:the external ID
SystemID:the SYSTEM ID (e.g. filename or URL)


+
Function type: resolveEntitySAXFunc
+xmlParserInputPtr	resolveEntitySAXFunc	(void * ctx, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId)
+
Callback: The entity loader, to control the loading of external entities, the application can either: - override this resolveEntity() callback in the SAX block - or better use the xmlSetExternalEntityLoader() function to set up it's own entity resolution routine
ctx:the user data (XML parser context)
publicId:The public ID of the entity
systemId:The system ID of the entity
Returns:the xmlParserInputPtr if inlined or NULL for DOM behaviour.


+
Enum xmlParserOption {
+    XML_PARSE_RECOVER = 1 : recover on errors
+    XML_PARSE_NOENT = 2 : substitute entities
+    XML_PARSE_DTDLOAD = 4 : load the external subset
+    XML_PARSE_DTDATTR = 8 : default DTD attributes
+    XML_PARSE_DTDVALID = 16 : validate with the DTD
+    XML_PARSE_NOERROR = 32 : suppress error reports
+    XML_PARSE_NOWARNING = 64 : suppress warning reports
+    XML_PARSE_PEDANTIC = 128 : pedantic error reporting
+    XML_PARSE_NOBLANKS = 256 : remove blank nodes
+    XML_PARSE_SAX1 = 512 : use the SAX1 interface internally
+    XML_PARSE_XINCLUDE = 1024 : Implement XInclude substitition
+    XML_PARSE_NONET = 2048 : Forbid network access
+    XML_PARSE_NODICT = 4096 : Do not reuse the context dictionnary
+    XML_PARSE_NSCLEAN = 8192 : remove redundant namespaces declarations
+    XML_PARSE_NOCDATA = 16384 : merge CDATA as text nodes
+}
+
+
int	xmlPedanticParserDefault	(int val)

+
xmlDocPtr	xmlSAXParseEntity	(xmlSAXHandlerPtr sax, 
				 const char * filename)

+
xmlDocPtr	xmlParseDoc	(xmlChar * cur)

+
void	xmlParserAddNodeInfo	(xmlParserCtxtPtr ctxt, 
				 const xmlParserNodeInfoPtr info)

+
#define XML_SAX2_MAGIC
+
+
xmlDocPtr	xmlSAXParseFileWithData	(xmlSAXHandlerPtr sax, 
				 const char * filename, 
				 int recovery, 
				 void * data)

+
int	xmlLineNumbersDefault	(int val)

+
xmlExternalEntityLoader	xmlGetExternalEntityLoader	(void)

+
Function type: elementDeclSAXFunc
+void	elementDeclSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 int type, 
				 xmlElementContentPtr content)
+
An element definition has been parsed.
ctx:the user data (XML parser context)
name:the element name
type:the element type
content:the element value tree


+
int	xmlCtxtUseOptions	(xmlParserCtxtPtr ctxt, 
				 int options)

+
xmlParserCtxtPtr	xmlCreatePushParserCtxt	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * chunk, 
				 int size, 
				 const char * filename)

+
xmlChar *	xmlCharStrndup	(const char * cur, 
				 int len)

+
xmlDocPtr	xmlCtxtReadFd	(xmlParserCtxtPtr ctxt, 
				 int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Function type: internalSubsetSAXFunc
+void	internalSubsetSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)
+
Callback on internal subset declaration.
ctx:the user data (XML parser context)
name:the root element name
ExternalID:the external ID
SystemID:the SYSTEM ID (e.g. filename or URL)


+
xmlParserCtxtPtr	xmlNewParserCtxt	(void)

+
Function type: endDocumentSAXFunc
+void	endDocumentSAXFunc	(void * ctx)
+
Called when the document end has been detected.
ctx:the user data (XML parser context)


+
xmlDocPtr	xmlParseFile	(const char * filename)

+
Typedef xmlParserNodeInfoSeq * xmlParserNodeInfoSeqPtr
+
+
int	xmlParseDocument	(xmlParserCtxtPtr ctxt)

+
int	xmlStrncmp	(const xmlChar * str1, 
				 const xmlChar * str2, 
				 int len)

+
Function type: setDocumentLocatorSAXFunc
+void	setDocumentLocatorSAXFunc	(void * ctx, 
				 xmlSAXLocatorPtr loc)
+
Receive the document locator at startup, actually xmlDefaultSAXLocator. Everything is available on the context, so this is useless in our case.
ctx:the user data (XML parser context)
loc:A SAX Locator


+
Function type: endElementSAXFunc
+void	endElementSAXFunc	(void * ctx, 
				 const xmlChar * name)
+
Called when the end of an element has been detected.
ctx:the user data (XML parser context)
name:The element name


+
#define XML_DETECT_IDS
+
+
Function type: getParameterEntitySAXFunc
+xmlEntityPtr	getParameterEntitySAXFunc	(void * ctx, 
				 const xmlChar * name)
+
Get a parameter entity by name.
ctx:the user data (XML parser context)
name:The entity name
Returns:the xmlEntityPtr if found.


+
Function type: endElementNsSAX2Func
+void	endElementNsSAX2Func	(void * ctx, 
				 const xmlChar * localname, 
				 const xmlChar * prefix, 
				 const xmlChar * URI)
+
SAX2 callback when an element end has been detected by the parser. It provides the namespace informations for the element.
ctx:the user data (XML parser context)
localname:the local name of the element
prefix:the element namespace prefix if available
URI:the element namespace name if available


+
Function type: ignorableWhitespaceSAXFunc
+void	ignorableWhitespaceSAXFunc	(void * ctx, 
				 const xmlChar * ch, 
				 int len)
+
Receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use characters.
ctx:the user data (XML parser context)
ch:a xmlChar string
len:the number of xmlChar


+
void	xmlInitNodeInfoSeq	(xmlParserNodeInfoSeqPtr seq)

+
int	xmlStrlen	(const xmlChar * str)

+
int	xmlSubstituteEntitiesDefault	(int val)

+
int	xmlStrncasecmp	(const xmlChar * str1, 
				 const xmlChar * str2, 
				 int len)

+
unsigned long	xmlParserFindNodeInfoIndex	(const xmlParserNodeInfoSeqPtr seq, 
				 const xmlNodePtr node)

+
int	xmlSAXUserParseMemory	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * buffer, 
				 int size)

+
void	xmlCtxtReset	(xmlParserCtxtPtr ctxt)

+
int	xmlSetFeature	(xmlParserCtxtPtr ctxt, 
				 const char * name, 
				 void * value)

+
int	xmlStrEqual	(const xmlChar * str1, 
				 const xmlChar * str2)

+
int	xmlKeepBlanksDefault	(int val)

+
int	xmlParserInputRead	(xmlParserInputPtr in, 
				 int len)

+
xmlDocPtr	xmlReadFile	(const char * filename, 
				 const char * encoding, 
				 int options)

+
int	xmlGetFeaturesList	(int * len, 
				 const char ** result)

+
xmlDocPtr	xmlCtxtReadDoc	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Structure xmlSAXHandlerV1
struct _xmlSAXHandlerV1 {
+    internalSubsetSAXFunc	internalSubset
+    isStandaloneSAXFunc	isStandalone
+    hasInternalSubsetSAXFunc	hasInternalSubset
+    hasExternalSubsetSAXFunc	hasExternalSubset
+    resolveEntitySAXFunc	resolveEntity
+    getEntitySAXFunc	getEntity
+    entityDeclSAXFunc	entityDecl
+    notationDeclSAXFunc	notationDecl
+    attributeDeclSAXFunc	attributeDecl
+    elementDeclSAXFunc	elementDecl
+    unparsedEntityDeclSAXFunc	unparsedEntityDecl
+    setDocumentLocatorSAXFunc	setDocumentLocator
+    startDocumentSAXFunc	startDocument
+    endDocumentSAXFunc	endDocument
+    startElementSAXFunc	startElement
+    endElementSAXFunc	endElement
+    referenceSAXFunc	reference
+    charactersSAXFunc	characters
+    ignorableWhitespaceSAXFunc	ignorableWhitespace
+    processingInstructionSAXFunc	processingInstruction
+    commentSAXFunc	comment
+    warningSAXFunc	warning
+    errorSAXFunc	error
+    fatalErrorSAXFunc	fatalError	: unused error() get all the errors
+    getParameterEntitySAXFunc	getParameterEntity
+    cdataBlockSAXFunc	cdataBlock
+    externalSubsetSAXFunc	externalSubset
+    unsigned int	initialized
+}

int	xmlSAXUserParseFile	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * filename)

+
Function type: fatalErrorSAXFunc
+void	fatalErrorSAXFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
Display and format fatal error messages, callback. Note: so far fatalError() SAX callbacks are not used, error() get all the callbacks for errors.
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display


+
xmlDtdPtr	xmlSAXParseDTD	(xmlSAXHandlerPtr sax, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Function type: entityDeclSAXFunc
+void	entityDeclSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 int type, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId, 
				 xmlChar * content)
+
An entity definition has been parsed.
ctx:the user data (XML parser context)
name:the entity name
type:the entity type
publicId:The public ID of the entity
systemId:The system ID of the entity
content:the entity value (without processing).


+
xmlParserInputPtr	xmlLoadExternalEntity	(const char * URL, 
				 const char * ID, 
				 xmlParserCtxtPtr ctxt)

+
#define XML_DEFAULT_VERSION
+
+
void	xmlStopParser	(xmlParserCtxtPtr ctxt)

+
xmlDocPtr	xmlReadFd	(int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
int	xmlParseExtParsedEnt	(xmlParserCtxtPtr ctxt)

+
xmlDocPtr	xmlReadIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
int	xmlStrVPrintf	(xmlChar * buf, 
				 int len, 
				 const xmlChar * msg, 
				 va_list ap)

+
xmlParserCtxtPtr	xmlCreateDocParserCtxt	(const xmlChar * cur)

+
xmlChar *	xmlStrsub	(const xmlChar * str, 
				 int start, 
				 int len)

+
int	xmlParseBalancedChunkMemory	(xmlDocPtr doc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 int depth, 
				 const xmlChar * string, 
				 xmlNodePtr * lst)

+
xmlDocPtr	xmlRecoverDoc	(xmlChar * cur)

+
void	xmlCleanupParser	(void)

+
int	xmlStrcasecmp	(const xmlChar * str1, 
				 const xmlChar * str2)

+
int	xmlCtxtResetPush	(xmlParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 const char * filename, 
				 const char * encoding)

+
Function type: isStandaloneSAXFunc
+int	isStandaloneSAXFunc	(void * ctx)
+
Is this document tagged standalone?
ctx:the user data (XML parser context)
Returns:1 if true


+
Function type: startDocumentSAXFunc
+void	startDocumentSAXFunc	(void * ctx)
+
Called when the document start being processed.
ctx:the user data (XML parser context)


+
#define XML_SKIP_IDS
+
+
void	xmlClearParserCtxt	(xmlParserCtxtPtr ctxt)

+
int	xmlParseExternalEntity	(xmlDocPtr doc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 int depth, 
				 const xmlChar * URL, 
				 const xmlChar * ID, 
				 xmlNodePtr * lst)

+
Function type: notationDeclSAXFunc
+void	notationDeclSAXFunc	(void * ctx, 
				 const xmlChar * name, 
				 const xmlChar * publicId, 
				 const xmlChar * systemId)
+
What to do when a notation declaration has been parsed.
ctx:the user data (XML parser context)
name:The name of the notation
publicId:The public ID of the entity
systemId:The system ID of the entity


+
Function type: warningSAXFunc
+void	warningSAXFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
Display and format a warning messages, callback.
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display


+
void	xmlSetExternalEntityLoader	(xmlExternalEntityLoader f)

+
Description

+
Function: xmlSetupParserForBuffer
void	xmlSetupParserForBuffer	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * buffer, 
				 const char * filename)

+
Setup the parser context to parse a new buffer; Clears any prior contents from the parser context. The buffer parameter must not be NULL, but the filename parameter can be

+
ctxt:an XML parser context
buffer:a xmlChar * buffer
filename:a file name
Function: xmlCtxtReadFile
xmlDocPtr	xmlCtxtReadFile	(xmlParserCtxtPtr ctxt, 
				 const char * filename, 
				 const char * encoding, 
				 int options)

+
parse an XML file from the filesystem or the network. This reuses the existing @ctxt parser context

+
ctxt:an XML parser context
filename:a file or URL
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree
Function: xmlStrcmp
int	xmlStrcmp	(const xmlChar * str1, 
				 const xmlChar * str2)

+
a strcmp for xmlChar's

+
str1:the first xmlChar *
str2:the second xmlChar *
Returns:the integer result of the comparison
Function: xmlParseMemory
xmlDocPtr	xmlParseMemory	(const char * buffer, 
				 int size)

+
parse an XML in-memory block and build a tree.

+
buffer:an pointer to a char array
size:the size of the array
Returns:the resulting document tree
Function: xmlParseCtxtExternalEntity
int	xmlParseCtxtExternalEntity	(xmlParserCtxtPtr ctx, 
				 const xmlChar * URL, 
				 const xmlChar * ID, 
				 xmlNodePtr * lst)

+
Parse an external general entity within an existing parsing context An external general parsed entity is well-formed if it matches the production labeled extParsedEnt. [78] extParsedEnt ::= TextDecl? content

+
ctx:the existing parsing context
URL:the URL for the entity to load
ID:the System ID for the entity to load
lst:the return value for the set of parsed nodes
Returns:0 if the entity is well formed, -1 in case of args problem and the parser error code otherwise

+      
+      
+      
+    
Function: xmlStrcasestr
const xmlChar *	xmlStrcasestr	(const xmlChar * str, 
				 xmlChar * val)

+
a case-ignoring strstr for xmlChar's

+
str:the xmlChar * array (haystack)
val:the xmlChar to search (needle)
Returns:the xmlChar * for the first occurrence or NULL.
Function: xmlStrcat
xmlChar *	xmlStrcat	(xmlChar * cur, 
				 const xmlChar * add)

+
a strcat for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume a termination mark of '0'.

+
cur:the original xmlChar * array
add:the xmlChar * array added
Returns:a new xmlChar * containing the concatenated string.

+      An attribute definition has been parsed.
+      
+      
+      
+      
+      
+      
+      
+      
+    
+      Get an entity by name.
+      
+      
+      
+    
Function: xmlStrstr
const xmlChar *	xmlStrstr	(const xmlChar * str, 
				 const xmlChar * val)

+
a strstr for xmlChar's

+
str:the xmlChar * array (haystack)
val:the xmlChar to search (needle)
Returns:the xmlChar * for the first occurrence or NULL.

+      Called when an opening tag has been processed.
+      
+      
+      
+      
+    
+      Receiving some chars from the parser.
+      
+      
+      
+      
+    
Function: xmlClearNodeInfoSeq
void	xmlClearNodeInfoSeq	(xmlParserNodeInfoSeqPtr seq)

+
-- Clear (release memory and reinitialize) node info sequence

+
seq:a node info sequence pointer
Function: xmlParseChunk
int	xmlParseChunk	(xmlParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 int terminate)

+
Parse a Chunk of memory

+
ctxt:an XML parser context
chunk:an char array
size:the size in byte of the chunk
terminate:last chunk indicator
Returns:zero if no error, the xmlParserErrors otherwise.
Function: xmlReadMemory
xmlDocPtr	xmlReadMemory	(const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree.

+
buffer:a pointer to a char array
size:the size of the array
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree
Function: xmlParseEntity
xmlDocPtr	xmlParseEntity	(const char * filename)

+
parse an XML external entity out of context and build a tree. [78] extParsedEnt ::= TextDecl? content This correspond to a "Well Balanced" chunk

+
filename:the filename
Returns:the resulting document tree
Function: xmlRecoverFile
xmlDocPtr	xmlRecoverFile	(const char * filename)

+
parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. In the case the document is not Well Formed, a tree is built anyway

+
filename:the filename
Returns:the resulting document tree
Function: xmlStrdup
xmlChar *	xmlStrdup	(const xmlChar * cur)

+
a strdup for array of xmlChar's. Since they are supposed to be encoded in UTF-8 or an encoding with 8bit based chars, we assume a termination mark of '0'.

+
cur:the input xmlChar *
Returns:a new xmlChar * or NULL

+      What to do when an unparsed entity declaration is parsed.
+      
+      
+      
+      
+      
+      
+    
+      SAX2 callback when an element start has been detected by the parser. It provides the namespace informations for the element, as well as the new namespace declarations on the element.
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlCreateIOParserCtxt
xmlParserCtxtPtr	xmlCreateIOParserCtxt	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 xmlCharEncoding enc)

+
Create a parser context for using the XML parser with an existing I/O stream

+
sax:a SAX handler
user_data:The user data returned on SAX callbacks
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
enc:the charset encoding if known
Returns:the new parser context or NULL

+      Called when an entity reference is detected.
+      
+      
+      
+    
Function: xmlStrncat
xmlChar *	xmlStrncat	(xmlChar * cur, 
				 const xmlChar * add, 
				 int len)

+
a strncat for array of xmlChar's, it will extend @cur with the len first bytes of @add.

+
cur:the original xmlChar * array
add:the xmlChar * array added
len:the length of @add
Returns:a new xmlChar *, the original @cur is reallocated if needed and should not be freed

+      Does this document has an external subset?
+      
+      
+    
Function: xmlStrPrintf
int	xmlStrPrintf	(xmlChar * buf, 
				 int len, 
				 const xmlChar * msg, 
				 ... ...)

+
Formats @msg and places result into @buf.

+
buf:the result buffer.
len:the result buffer length.
msg:the message with printf formatting.
...:extra parameters for the message.
Returns:the number of characters written to @buf or -1 if an error occurs.
Function: xmlSAXParseDoc
xmlDocPtr	xmlSAXParseDoc	(xmlSAXHandlerPtr sax, 
				 xmlChar * cur, 
				 int recovery)

+
parse an XML 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.

+
sax:the SAX handler block
cur:a pointer to an array of xmlChar
recovery:work in recovery mode, i.e. tries to read no Well Formed documents
Returns:the resulting document tree
Function: xmlStrndup
xmlChar *	xmlStrndup	(const xmlChar * cur, 
				 int len)

+
a strndup for array of xmlChar's

+
cur:the input xmlChar *
len:the len of @cur
Returns:a new xmlChar * or NULL
Function: xmlCharStrdup
xmlChar *	xmlCharStrdup	(const char * cur)

+
a strdup for char's to xmlChar's

+
cur:the input char *
Returns:a new xmlChar * or NULL
Function: xmlNewIOInputStream
xmlParserInputPtr	xmlNewIOInputStream	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputBufferPtr input, 
				 xmlCharEncoding enc)

+
Create a new input stream structure encapsulating the @input into a stream suitable for the parser.

+
ctxt:an XML parser context
input:an I/O Input
enc:the charset encoding if known
Returns:the new input stream or NULL

+      A processing instruction has been parsed.
+      
+      
+      
+      
+    
Function: xmlParseBalancedChunkMemoryRecover
int	xmlParseBalancedChunkMemoryRecover	(xmlDocPtr doc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 int depth, 
				 const xmlChar * string, 
				 xmlNodePtr * lst, 
				 int recover)

+
Parse a well-balanced chunk of an XML document called by the parser The allowed sequence for the Well Balanced Chunk is the one defined by the content production in the XML grammar: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

+
doc:the document the chunk pertains to
sax:the SAX handler bloc (possibly NULL)
user_data:The user data returned on SAX callbacks (possibly NULL)
depth:Used for loop detection, use 0
string:the input string in UTF8 or ISO-Latin (zero terminated)
lst:the return value for the set of parsed nodes
recover:return nodes even if the data is broken (use 0)
Returns:0 if the chunk is well balanced, -1 in case of args problem and the parser error code otherwise In case recover is set to 1, the nodelist will not be empty even if the parsed chunk is not well balanced.
Function: xmlInitParser
void	xmlInitParser	(void)

+
Initialization function for the XML parser. This is not reentrant. Call once before processing in case of use in multithreaded programs.

+
+      Display and format an error messages, callback.
+      
+      
+      
+      
+    
Function: xmlSAXParseMemory
xmlDocPtr	xmlSAXParseMemory	(xmlSAXHandlerPtr sax, 
				 const char * buffer, 
				 int size, 
				 int recovery)

+
parse an XML in-memory block and use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines.

+
sax:the SAX handler block
buffer:an pointer to a char array
size:the size of the array
recovery:work in recovery mode, i.e. tries to read not Well Formed documents
Returns:the resulting document tree
Function: xmlRecoverMemory
xmlDocPtr	xmlRecoverMemory	(const char * buffer, 
				 int size)

+
parse an XML in-memory block and build a tree. In the case the document is not Well Formed, a tree is built anyway

+
buffer:an pointer to a char array
size:the size of the array
Returns:the resulting document tree

+      External entity loaders types.
+      
+      
+      
+      
+    
+      Does this document has an internal subset.
+      
+      
+    
Function: xmlReadDoc
xmlDocPtr	xmlReadDoc	(const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree.

+
cur:a pointer to a zero terminated string
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree

+      Called when a pcdata block has been parsed.
+      
+      
+      
+      
+    
Macro: XML_COMPLETE_ATTRS
#define XML_COMPLETE_ATTRS
Bit in the loadsubset context field to tell to do complete the elements attributes lists with the ones defaulted from the DTDs. Use it to initialize xmlLoadExtDtdDefaultValue.

+
Function: xmlSAXParseFile
xmlDocPtr	xmlSAXParseFile	(xmlSAXHandlerPtr sax, 
				 const char * filename, 
				 int recovery)

+
parse an XML 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.

+
sax:the SAX handler block
filename:the filename
recovery:work in recovery mode, i.e. tries to read no Well Formed documents
Returns:the resulting document tree

+      Callback for freeing some parser input allocations.
+      
+      
+    
Function: xmlCtxtReadIO
xmlDocPtr	xmlCtxtReadIO	(xmlParserCtxtPtr ctxt, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML document from I/O functions and source and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an XML parser context
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree
Function: xmlSAXParseMemoryWithData
xmlDocPtr	xmlSAXParseMemoryWithData	(xmlSAXHandlerPtr sax, 
				 const char * buffer, 
				 int size, 
				 int recovery, 
				 void * data)

+
parse an XML in-memory block and use the given SAX function block to handle the parsing callback. If sax is NULL, fallback to the default DOM tree building routines. User data (void *) is stored within the parser context in the context's _private member, so it is available nearly everywhere in libxml

+
sax:the SAX handler block
buffer:an pointer to a char array
size:the size of the array
recovery:work in recovery mode, i.e. tries to read no Well Formed documents
data:the userdata
Returns:the resulting document tree
Function: xmlParserFindNodeInfo
const xmlParserNodeInfo *	xmlParserFindNodeInfo	(const xmlParserCtxtPtr ctx, 
				 const xmlNodePtr node)

+
Find the parser node info struct for a given node

+
ctx:an XML parser context
node:an XML node within the tree
Returns:an xmlParserNodeInfo block pointer or NULL
Function: xmlGetFeature
int	xmlGetFeature	(xmlParserCtxtPtr ctxt, 
				 const char * name, 
				 void * result)

+
Read the current value of one feature of this parser instance

+
ctxt:an XML/HTML parser context
name:the feature name
result:location to store the result
Returns:-1 in case or error, 0 otherwise

+      
+      
+      
+      
+      
+    
Function: xmlStrchr
const xmlChar *	xmlStrchr	(const xmlChar * str, 
				 xmlChar val)

+
a strchr for xmlChar's

+
str:the xmlChar * array
val:the xmlChar to search
Returns:the xmlChar * for the first occurrence or NULL.
Function: xmlIOParseDTD
xmlDtdPtr	xmlIOParseDTD	(xmlSAXHandlerPtr sax, 
				 xmlParserInputBufferPtr input, 
				 xmlCharEncoding enc)

+
Load and parse a DTD

+
sax:the SAX handler block or NULL
input:an Input Buffer
enc:the charset encoding if known
Returns:the resulting xmlDtdPtr or NULL in case of error. @input will be freed at parsing end.
Function: xmlFreeParserCtxt
void	xmlFreeParserCtxt	(xmlParserCtxtPtr ctxt)

+
Free all the memory used by a parser context. However the parsed document in ctxt->myDoc is not freed.

+
ctxt:an XML parser context
Function: xmlParseDTD
xmlDtdPtr	xmlParseDTD	(const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Load and parse an external subset.

+
ExternalID:a NAME* containing the External ID of the DTD
SystemID:a NAME* containing the URL to the DTD
Returns:the resulting xmlDtdPtr or NULL in case of error.

+      A comment has been parsed.
+      
+      
+      
+    
Function: xmlInitParserCtxt
int	xmlInitParserCtxt	(xmlParserCtxtPtr ctxt)

+
Initialize a parser context

+
ctxt:an XML parser context
Returns:0 in case of success and -1 in case of error

+      Handle an attribute that has been read by the parser. The default handling is to convert the attribute into an DOM subtree and past it in a new xmlAttr element added to the element.
+      
+      
+      
+      
+    
Function: xmlStrQEqual
int	xmlStrQEqual	(const xmlChar * pref, 
				 const xmlChar * name, 
				 const xmlChar * str)

+
Check if a QName is Equal to a given string

+
pref:the prefix of the QName
name:the localname of the QName
str:the second xmlChar *
Returns:1 if they are equal, 0 if they are different
Function: xmlParserInputGrow
int	xmlParserInputGrow	(xmlParserInputPtr in, 
				 int len)

+
This function increase the input for the parser. It tries to preserve pointers to the input buffer, and keep already read data

+
in:an XML parser input
len:an indicative size for the lookahead
Returns:the number of xmlChars read, or -1 in case of error, 0 indicate the end of this entity
Function: xmlCtxtReadMemory
xmlDocPtr	xmlCtxtReadMemory	(xmlParserCtxtPtr ctxt, 
				 const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an XML parser context
buffer:a pointer to a char array
size:the size of the array
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree

+      Callback on external subset declaration.
+      
+      
+      
+      
+      
+    
+      Callback: The entity loader, to control the loading of external entities, the application can either: - override this resolveEntity() callback in the SAX block - or better use the xmlSetExternalEntityLoader() function to set up it's own entity resolution routine
+      
+      
+      
+      
+    
Function: xmlPedanticParserDefault
int	xmlPedanticParserDefault	(int val)

+
Set and return the previous value for enabling pedantic warnings.

+
val:int 0 or 1
Returns:the last value for 0 for no substitution, 1 for substitution.
Function: xmlSAXParseEntity
xmlDocPtr	xmlSAXParseEntity	(xmlSAXHandlerPtr sax, 
				 const char * filename)

+
parse an XML external entity out of context 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. [78] extParsedEnt ::= TextDecl? content This correspond to a "Well Balanced" chunk

+
sax:the SAX handler block
filename:the filename
Returns:the resulting document tree
Function: xmlParseDoc
xmlDocPtr	xmlParseDoc	(xmlChar * cur)

+
parse an XML in-memory document and build a tree.

+
cur:a pointer to an array of xmlChar
Returns:the resulting document tree
Function: xmlParserAddNodeInfo
void	xmlParserAddNodeInfo	(xmlParserCtxtPtr ctxt, 
				 const xmlParserNodeInfoPtr info)

+
Insert node info record into the sorted sequence

+
ctxt:an XML parser context
info:a node info sequence pointer
Macro: XML_SAX2_MAGIC
#define XML_SAX2_MAGIC
Special constant found in SAX2 blocks initialized fields

+
Function: xmlSAXParseFileWithData
xmlDocPtr	xmlSAXParseFileWithData	(xmlSAXHandlerPtr sax, 
				 const char * filename, 
				 int recovery, 
				 void * data)

+
parse an XML 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. User data (void *) is stored within the parser context in the context's _private member, so it is available nearly everywhere in libxml

+
sax:the SAX handler block
filename:the filename
recovery:work in recovery mode, i.e. tries to read no Well Formed documents
data:the userdata
Returns:the resulting document tree
Function: xmlLineNumbersDefault
int	xmlLineNumbersDefault	(int val)

+
Set and return the previous value for enabling line numbers in elements contents. This may break on old application and is turned off by default.

+
val:int 0 or 1
Returns:the last value for 0 for no substitution, 1 for substitution.
Function: xmlGetExternalEntityLoader
xmlExternalEntityLoader	xmlGetExternalEntityLoader	(void)

+
Get the default external entity resolver function for the application

+
Returns:the xmlExternalEntityLoader function pointer

+      An element definition has been parsed.
+      
+      
+      
+      
+      
+    
Function: xmlCtxtUseOptions
int	xmlCtxtUseOptions	(xmlParserCtxtPtr ctxt, 
				 int options)

+
Applies the options to the parser context

+
ctxt:an XML parser context
options:a combination of xmlParserOption(s)
Returns:0 in case of success, the set of unknown or unimplemented options in case of error.
Function: xmlCreatePushParserCtxt
xmlParserCtxtPtr	xmlCreatePushParserCtxt	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * chunk, 
				 int size, 
				 const char * filename)

+
Create a parser context for using the XML parser in push mode. If @buffer and @size are non-NULL, the data is used to detect the encoding. The remaining characters will be parsed so they don't need to be fed in again through xmlParseChunk. To allow content encoding detection, @size should be >= 4 The value of @filename is used for fetching external entities and error/warning reports.

+
sax:a SAX handler
user_data:The user data returned on SAX callbacks
chunk:a pointer to an array of chars
size:number of chars in the array
filename:an optional file name or URI
Returns:the new parser context or NULL
Function: xmlCharStrndup
xmlChar *	xmlCharStrndup	(const char * cur, 
				 int len)

+
a strndup for char's to xmlChar's

+
cur:the input char *
len:the len of @cur
Returns:a new xmlChar * or NULL
Function: xmlCtxtReadFd
xmlDocPtr	xmlCtxtReadFd	(xmlParserCtxtPtr ctxt, 
				 int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML from a file descriptor and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an XML parser context
fd:an open file descriptor
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree

+      Callback on internal subset declaration.
+      
+      
+      
+      
+      
+    
Function: xmlNewParserCtxt
xmlParserCtxtPtr	xmlNewParserCtxt	(void)

+
Allocate and initialize a new parser context.

+
Returns:the xmlParserCtxtPtr or NULL

+      Called when the document end has been detected.
+      
+      
+    
Function: xmlParseFile
xmlDocPtr	xmlParseFile	(const char * filename)

+
parse an XML file and build a tree. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

+
filename:the filename
Returns:the resulting document tree if the file was wellformed, NULL otherwise.
Function: xmlParseDocument
int	xmlParseDocument	(xmlParserCtxtPtr ctxt)

+
parse an XML document (and build a tree if using the standard SAX interface). [1] document ::= prolog element Misc* [22] prolog ::= XMLDecl? Misc* (doctypedecl Misc*)?

+
ctxt:an XML parser context
Returns:0, -1 in case of error. the parser context is augmented as a result of the parsing.
Function: xmlStrncmp
int	xmlStrncmp	(const xmlChar * str1, 
				 const xmlChar * str2, 
				 int len)

+
a strncmp for xmlChar's

+
str1:the first xmlChar *
str2:the second xmlChar *
len:the max comparison length
Returns:the integer result of the comparison

+      Receive the document locator at startup, actually xmlDefaultSAXLocator. Everything is available on the context, so this is useless in our case.
+      
+      
+      
+    
+      Called when the end of an element has been detected.
+      
+      
+      
+    
Macro: XML_DETECT_IDS
#define XML_DETECT_IDS
Bit in the loadsubset context field to tell to do ID/REFs lookups. Use it to initialize xmlLoadExtDtdDefaultValue.

+
+      Get a parameter entity by name.
+      
+      
+      
+    
+      SAX2 callback when an element end has been detected by the parser. It provides the namespace informations for the element.
+      
+      
+      
+      
+      
+    
+      Receiving some ignorable whitespaces from the parser. UNUSED: by default the DOM building will use characters.
+      
+      
+      
+      
+    
Function: xmlInitNodeInfoSeq
void	xmlInitNodeInfoSeq	(xmlParserNodeInfoSeqPtr seq)

+
-- Initialize (set to initial state) node info sequence

+
seq:a node info sequence pointer
Function: xmlStrlen
int	xmlStrlen	(const xmlChar * str)

+
length of a xmlChar's string

+
str:the xmlChar * array
Returns:the number of xmlChar contained in the ARRAY.
Function: xmlSubstituteEntitiesDefault
int	xmlSubstituteEntitiesDefault	(int val)

+
Set and return the previous value for default entity support. Initially the parser always keep entity references instead of substituting entity values in the output. This function has to be used to change the default parser behavior SAX::substituteEntities() has to be used for changing that on a file by file basis.

+
val:int 0 or 1
Returns:the last value for 0 for no substitution, 1 for substitution.
Function: xmlStrncasecmp
int	xmlStrncasecmp	(const xmlChar * str1, 
				 const xmlChar * str2, 
				 int len)

+
a strncasecmp for xmlChar's

+
str1:the first xmlChar *
str2:the second xmlChar *
len:the max comparison length
Returns:the integer result of the comparison
Function: xmlParserFindNodeInfoIndex
unsigned long	xmlParserFindNodeInfoIndex	(const xmlParserNodeInfoSeqPtr seq, 
				 const xmlNodePtr node)

+
xmlParserFindNodeInfoIndex : Find the index that the info record for the given node is or should be at in a sorted sequence

+
seq:a node info sequence pointer
node:an XML node pointer
Returns:a long indicating the position of the record
Function: xmlSAXUserParseMemory
int	xmlSAXUserParseMemory	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * buffer, 
				 int size)

+
A better SAX parsing routine. parse an XML in-memory buffer and call the given SAX handler routines.

+
sax:a SAX handler
user_data:The user data returned on SAX callbacks
buffer:an in-memory XML document input
size:the length of the XML document in bytes
Returns:0 in case of success or a error number otherwise
Function: xmlCtxtReset
void	xmlCtxtReset	(xmlParserCtxtPtr ctxt)

+
Reset a parser context

+
ctxt:an XML parser context
Function: xmlSetFeature
int	xmlSetFeature	(xmlParserCtxtPtr ctxt, 
				 const char * name, 
				 void * value)

+
Change the current value of one feature of this parser instance

+
ctxt:an XML/HTML parser context
name:the feature name
value:pointer to the location of the new value
Returns:-1 in case or error, 0 otherwise
Function: xmlStrEqual
int	xmlStrEqual	(const xmlChar * str1, 
				 const xmlChar * str2)

+
Check if both string are equal of have same content Should be a bit more readable and faster than xmlStrEqual()

+
str1:the first xmlChar *
str2:the second xmlChar *
Returns:1 if they are equal, 0 if they are different
Function: xmlKeepBlanksDefault
int	xmlKeepBlanksDefault	(int val)

+
Set and return the previous value for default blanks text nodes support. The 1.x version of the parser used an heuristic to try to detect ignorable white spaces. As a result the SAX callback was generating xmlSAX2IgnorableWhitespace() callbacks instead of characters() one, and when using the DOM output text nodes containing those blanks were not generated. The 2.x and later version will switch to the XML standard way and ignorableWhitespace() are only generated when running the parser in validating mode and when the current element doesn't allow CDATA or mixed content. This function is provided as a way to force the standard behavior on 1.X libs and to switch back to the old mode for compatibility when running 1.X client code on 2.X . Upgrade of 1.X code should be done by using xmlIsBlankNode() commodity function to detect the "empty" nodes generated. This value also affect autogeneration of indentation when saving code if blanks sections are kept, indentation is not generated.

+
val:int 0 or 1
Returns:the last value for 0 for no substitution, 1 for substitution.
Function: xmlParserInputRead
int	xmlParserInputRead	(xmlParserInputPtr in, 
				 int len)

+
This function refresh the input for the parser. It doesn't try to preserve pointers to the input buffer, and discard already read data

+
in:an XML parser input
len:an indicative size for the lookahead
Returns:the number of xmlChars read, or -1 in case of error, 0 indicate the end of this entity
Function: xmlReadFile
xmlDocPtr	xmlReadFile	(const char * filename, 
				 const char * encoding, 
				 int options)

+
parse an XML file from the filesystem or the network.

+
filename:a file or URL
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree
Function: xmlGetFeaturesList
int	xmlGetFeaturesList	(int * len, 
				 const char ** result)

+
Copy at most *@len feature names into the @result array

+
len:the length of the features name array (input/output)
result:an array of string to be filled with the features name.
Returns:-1 in case or error, or the total number of features, len is updated with the number of strings copied, strings must not be deallocated
Function: xmlCtxtReadDoc
xmlDocPtr	xmlCtxtReadDoc	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML in-memory document and build a tree. This reuses the existing @ctxt parser context

+
ctxt:an XML parser context
cur:a pointer to a zero terminated string
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlSAXUserParseFile
int	xmlSAXUserParseFile	(xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 const char * filename)

+
parse an XML file and call the given SAX handler routines. Automatic support for ZLIB/Compress compressed document is provided

+
sax:a SAX handler
user_data:The user data returned on SAX callbacks
filename:a file name
Returns:0 in case of success or a error number otherwise

+      Display and format fatal error messages, callback. Note: so far fatalError() SAX callbacks are not used, error() get all the callbacks for errors.
+      
+      
+      
+      
+    
Function: xmlSAXParseDTD
xmlDtdPtr	xmlSAXParseDTD	(xmlSAXHandlerPtr sax, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Load and parse an external subset.

+
sax:the SAX handler block
ExternalID:a NAME* containing the External ID of the DTD
SystemID:a NAME* containing the URL to the DTD
Returns:the resulting xmlDtdPtr or NULL in case of error.

+      An entity definition has been parsed.
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlLoadExternalEntity
xmlParserInputPtr	xmlLoadExternalEntity	(const char * URL, 
				 const char * ID, 
				 xmlParserCtxtPtr ctxt)

+
Load an external entity, note that the use of this function for unparsed entities may generate problems TODO: a more generic External entity API must be designed

+
URL:the URL for the entity to load
ID:the Public ID for the entity to load
ctxt:the context in which the entity is called or NULL
Returns:the xmlParserInputPtr or NULL
Macro: XML_DEFAULT_VERSION
#define XML_DEFAULT_VERSION
The default version of XML used: 1.0

+
Function: xmlStopParser
void	xmlStopParser	(xmlParserCtxtPtr ctxt)

+
Blocks further parser processing

+
ctxt:an XML parser context
Function: xmlReadFd
xmlDocPtr	xmlReadFd	(int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML from a file descriptor and build a tree.

+
fd:an open file descriptor
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree
Function: xmlParseExtParsedEnt
int	xmlParseExtParsedEnt	(xmlParserCtxtPtr ctxt)

+
parse a general parsed entity An external general parsed entity is well-formed if it matches the production labeled extParsedEnt. [78] extParsedEnt ::= TextDecl? content

+
ctxt:an XML parser context
Returns:0, -1 in case of error. the parser context is augmented as a result of the parsing.
Function: xmlReadIO
xmlDocPtr	xmlReadIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
parse an XML document from I/O functions and source and build a tree.

+
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the resulting document tree
Function: xmlStrVPrintf
int	xmlStrVPrintf	(xmlChar * buf, 
				 int len, 
				 const xmlChar * msg, 
				 va_list ap)

+
Formats @msg and places result into @buf.

+
buf:the result buffer.
len:the result buffer length.
msg:the message with printf formatting.
ap:extra parameters for the message.
Returns:the number of characters written to @buf or -1 if an error occurs.
Function: xmlCreateDocParserCtxt
xmlParserCtxtPtr	xmlCreateDocParserCtxt	(const xmlChar * cur)

+
Creates a parser context for an XML in-memory document.

+
cur:a pointer to an array of xmlChar
Returns:the new parser context or NULL
Function: xmlStrsub
xmlChar *	xmlStrsub	(const xmlChar * str, 
				 int start, 
				 int len)

+
Extract a substring of a given string

+
str:the xmlChar * array (haystack)
start:the index of the first char (zero based)
len:the length of the substring
Returns:the xmlChar * for the first occurrence or NULL.
Function: xmlParseBalancedChunkMemory
int	xmlParseBalancedChunkMemory	(xmlDocPtr doc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 int depth, 
				 const xmlChar * string, 
				 xmlNodePtr * lst)

+
Parse a well-balanced chunk of an XML document called by the parser The allowed sequence for the Well Balanced Chunk is the one defined by the content production in the XML grammar: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

+
doc:the document the chunk pertains to
sax:the SAX handler bloc (possibly NULL)
user_data:The user data returned on SAX callbacks (possibly NULL)
depth:Used for loop detection, use 0
string:the input string in UTF8 or ISO-Latin (zero terminated)
lst:the return value for the set of parsed nodes
Returns:0 if the chunk is well balanced, -1 in case of args problem and the parser error code otherwise
Function: xmlRecoverDoc
xmlDocPtr	xmlRecoverDoc	(xmlChar * cur)

+
parse an XML in-memory document and build a tree. In the case the document is not Well Formed, a tree is built anyway

+
cur:a pointer to an array of xmlChar
Returns:the resulting document tree
Function: xmlCleanupParser
void	xmlCleanupParser	(void)

+
Cleanup function for the XML library. It tries to reclaim all parsing related global memory allocated for the library processing. It doesn't deallocate any document related memory. Calling this function should not prevent reusing the library but one should call xmlCleanupParser() only when the process has finished using the library or XML document built with it.

+
Function: xmlStrcasecmp
int	xmlStrcasecmp	(const xmlChar * str1, 
				 const xmlChar * str2)

+
a strcasecmp for xmlChar's

+
str1:the first xmlChar *
str2:the second xmlChar *
Returns:the integer result of the comparison
Function: xmlCtxtResetPush
int	xmlCtxtResetPush	(xmlParserCtxtPtr ctxt, 
				 const char * chunk, 
				 int size, 
				 const char * filename, 
				 const char * encoding)

+
Reset a push parser context

+
ctxt:an XML parser context
chunk:a pointer to an array of chars
size:number of chars in the array
filename:an optional file name or URI
encoding:the document encoding, or NULL
Returns:0 in case of success and 1 in case of error

+      Is this document tagged standalone?
+      
+      
+    
+      Called when the document start being processed.
+      
+      
+    
Macro: XML_SKIP_IDS
#define XML_SKIP_IDS
Bit in the loadsubset context field to tell to not do ID/REFs registration. Used to initialize xmlLoadExtDtdDefaultValue in some special cases.

+
Function: xmlClearParserCtxt
void	xmlClearParserCtxt	(xmlParserCtxtPtr ctxt)

+
Clear (release owned resources) and reinitialize a parser context

+
ctxt:an XML parser context
Function: xmlParseExternalEntity
int	xmlParseExternalEntity	(xmlDocPtr doc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data, 
				 int depth, 
				 const xmlChar * URL, 
				 const xmlChar * ID, 
				 xmlNodePtr * lst)

+
Parse an external general entity An external general parsed entity is well-formed if it matches the production labeled extParsedEnt. [78] extParsedEnt ::= TextDecl? content

+
doc:the document the chunk pertains to
sax:the SAX handler bloc (possibly NULL)
user_data:The user data returned on SAX callbacks (possibly NULL)
depth:Used for loop detection, use 0
URL:the URL for the entity to load
ID:the System ID for the entity to load
lst:the return value for the set of parsed nodes
Returns:0 if the entity is well formed, -1 in case of args problem and the parser error code otherwise

+      What to do when a notation declaration has been parsed.
+      
+      
+      
+      
+      
+    
+      Display and format a warning messages, callback.
+      
+      
+      
+      
+    
Function: xmlSetExternalEntityLoader
void	xmlSetExternalEntityLoader	(xmlExternalEntityLoader f)

+
Changes the defaultexternal entity resolver function for the application

+
f:the new entity resolver function
Daniel Veillard

diff --git a/doc/html/libxml-parserInternals.html b/doc/html/libxml-parserInternals.html
index 7882e8df..2c195480 100644
--- a/doc/html/libxml-parserInternals.html
+++ b/doc/html/libxml-parserInternals.html
@@ -1,1413 +1,376 @@
-parserInternals
PrevUpHomeGnome XML Library Reference ManualNext
parserInternals
parserInternals — 
Synopsis
-
-
-
-extern      unsigned int xmlParserMaxDepth;
-#define     XML_MAX_NAMELEN
-#define     INPUT_CHUNK
-#define     IS_BYTE_CHAR                    (c)
-#define     IS_CHAR                         (c)
-#define     IS_CHAR_CH                      (c)
-#define     IS_BLANK                        (c)
-#define     IS_BLANK_CH                     (c)
-#define     IS_BASECHAR                     (c)
-#define     IS_DIGIT                        (c)
-#define     IS_DIGIT_CH                     (c)
-#define     IS_COMBINING                    (c)
-#define     IS_COMBINING_CH                 (c)
-#define     IS_EXTENDER                     (c)
-#define     IS_EXTENDER_CH                  (c)
-#define     IS_IDEOGRAPHIC                  (c)
-#define     IS_LETTER                       (c)
-#define     IS_LETTER_CH                    (c)
-#define     IS_PUBIDCHAR                    (c)
-#define     IS_PUBIDCHAR_CH                 (c)
-#define     SKIP_EOL                        (p)
-#define     MOVETO_ENDTAG                   (p)
-#define     MOVETO_STARTTAG                 (p)
-int         xmlIsLetter                     (int c);
-xmlParserCtxtPtr xmlCreateFileParserCtxt    (const char *filename);
-xmlParserCtxtPtr xmlCreateURLParserCtxt     (const char *filename,
-                                             int options);
-xmlParserCtxtPtr xmlCreateMemoryParserCtxt  (const char *buffer,
-                                             int size);
-xmlParserCtxtPtr xmlCreateEntityParserCtxt  (const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             const xmlChar *base);
-int         xmlSwitchEncoding               (xmlParserCtxtPtr ctxt,
-                                             xmlCharEncoding enc);
-int         xmlSwitchToEncoding             (xmlParserCtxtPtr ctxt,
-                                             xmlCharEncodingHandlerPtr handler);
-int         xmlSwitchInputEncoding          (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr input,
-                                             xmlCharEncodingHandlerPtr handler);
-void        xmlHandleEntity                 (xmlParserCtxtPtr ctxt,
-                                             xmlEntityPtr entity);
-xmlParserInputPtr xmlNewStringInputStream   (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *buffer);
-xmlParserInputPtr xmlNewEntityInputStream   (xmlParserCtxtPtr ctxt,
-                                             xmlEntityPtr entity);
-void        xmlPushInput                    (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr input);
-xmlChar     xmlPopInput                     (xmlParserCtxtPtr ctxt);
-void        xmlFreeInputStream              (xmlParserInputPtr input);
-xmlParserInputPtr xmlNewInputFromFile       (xmlParserCtxtPtr ctxt,
-                                             const char *filename);
-xmlParserInputPtr xmlNewInputStream         (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlSplitQName                   (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlChar **prefix);
-xmlChar*    xmlNamespaceParseNCName         (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlNamespaceParseQName          (xmlParserCtxtPtr ctxt,
-                                             xmlChar **prefix);
-xmlChar*    xmlNamespaceParseNSDef          (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParseQuotedString            (xmlParserCtxtPtr ctxt);
-void        xmlParseNamespace               (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlScanName                     (xmlParserCtxtPtr ctxt);
-const xmlChar* xmlParseName                 (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParseNmtoken                 (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParseEntityValue             (xmlParserCtxtPtr ctxt,
-                                             xmlChar **orig);
-xmlChar*    xmlParseAttValue                (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParseSystemLiteral           (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParsePubidLiteral            (xmlParserCtxtPtr ctxt);
-void        xmlParseCharData                (xmlParserCtxtPtr ctxt,
-                                             int cdata);
-xmlChar*    xmlParseExternalID              (xmlParserCtxtPtr ctxt,
-                                             xmlChar **publicID,
-                                             int strict);
-void        xmlParseComment                 (xmlParserCtxtPtr ctxt);
-const xmlChar* xmlParsePITarget             (xmlParserCtxtPtr ctxt);
-void        xmlParsePI                      (xmlParserCtxtPtr ctxt);
-void        xmlParseNotationDecl            (xmlParserCtxtPtr ctxt);
-void        xmlParseEntityDecl              (xmlParserCtxtPtr ctxt);
-int         xmlParseDefaultDecl             (xmlParserCtxtPtr ctxt,
-                                             xmlChar **value);
-xmlEnumerationPtr xmlParseNotationType      (xmlParserCtxtPtr ctxt);
-xmlEnumerationPtr xmlParseEnumerationType   (xmlParserCtxtPtr ctxt);
-int         xmlParseEnumeratedType          (xmlParserCtxtPtr ctxt,
-                                             xmlEnumerationPtr *tree);
-int         xmlParseAttributeType           (xmlParserCtxtPtr ctxt,
-                                             xmlEnumerationPtr *tree);
-void        xmlParseAttributeListDecl       (xmlParserCtxtPtr ctxt);
-int         xmlParseElementContentDecl      (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlElementContentPtr *result);
-int         xmlParseElementDecl             (xmlParserCtxtPtr ctxt);
-void        xmlParseMarkupDecl              (xmlParserCtxtPtr ctxt);
-int         xmlParseCharRef                 (xmlParserCtxtPtr ctxt);
-xmlEntityPtr xmlParseEntityRef              (xmlParserCtxtPtr ctxt);
-void        xmlParseReference               (xmlParserCtxtPtr ctxt);
-void        xmlParsePEReference             (xmlParserCtxtPtr ctxt);
-void        xmlParseDocTypeDecl             (xmlParserCtxtPtr ctxt);
-const xmlChar* xmlParseAttribute            (xmlParserCtxtPtr ctxt,
-                                             xmlChar **value);
-const xmlChar* xmlParseStartTag             (xmlParserCtxtPtr ctxt);
-void        xmlParseEndTag                  (xmlParserCtxtPtr ctxt);
-void        xmlParseCDSect                  (xmlParserCtxtPtr ctxt);
-void        xmlParseContent                 (xmlParserCtxtPtr ctxt);
-void        xmlParseElement                 (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParseVersionNum              (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParseVersionInfo             (xmlParserCtxtPtr ctxt);
-xmlChar*    xmlParseEncName                 (xmlParserCtxtPtr ctxt);
-const xmlChar* xmlParseEncodingDecl         (xmlParserCtxtPtr ctxt);
-int         xmlParseSDDecl                  (xmlParserCtxtPtr ctxt);
-void        xmlParseXMLDecl                 (xmlParserCtxtPtr ctxt);
-void        xmlParseTextDecl                (xmlParserCtxtPtr ctxt);
-void        xmlParseMisc                    (xmlParserCtxtPtr ctxt);
-void        xmlParseExternalSubset          (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-#define     XML_SUBSTITUTE_NONE
-#define     XML_SUBSTITUTE_REF
-#define     XML_SUBSTITUTE_PEREF
-#define     XML_SUBSTITUTE_BOTH
-xmlChar*    xmlDecodeEntities               (xmlParserCtxtPtr ctxt,
-                                             int len,
-                                             int what,
-                                             xmlChar end,
-                                             xmlChar end2,
-                                             xmlChar end3);
-xmlChar*    xmlStringDecodeEntities         (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *str,
-                                             int what,
-                                             xmlChar end,
-                                             xmlChar end2,
-                                             xmlChar end3);
-xmlChar*    xmlStringLenDecodeEntities      (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *str,
-                                             int len,
-                                             int what,
-                                             xmlChar end,
-                                             xmlChar end2,
-                                             xmlChar end3);
-int         nodePush                        (xmlParserCtxtPtr ctxt,
-                                             xmlNodePtr value);
-xmlNodePtr  nodePop                         (xmlParserCtxtPtr ctxt);
-int         inputPush                       (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr value);
-xmlParserInputPtr inputPop                  (xmlParserCtxtPtr ctxt);
-const xmlChar* namePop                      (xmlParserCtxtPtr ctxt);
-int         namePush                        (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *value);
-int         xmlSkipBlankChars               (xmlParserCtxtPtr ctxt);
-int         xmlStringCurrentChar            (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *cur,
-                                             int *len);
-void        xmlParserHandlePEReference      (xmlParserCtxtPtr ctxt);
-void        xmlParserHandleReference        (xmlParserCtxtPtr ctxt);
-int         xmlCheckLanguageID              (const xmlChar *lang);
-int         xmlCurrentChar                  (xmlParserCtxtPtr ctxt,
-                                             int *len);
-int         xmlCopyCharMultiByte            (xmlChar *out,
-                                             int val);
-int         xmlCopyChar                     (int len,
-                                             xmlChar *out,
-                                             int val);
-void        xmlNextChar                     (xmlParserCtxtPtr ctxt);
-void        xmlParserInputShrink            (xmlParserInputPtr in);
-void        htmlInitAutoClose               (void);
-htmlParserCtxtPtr htmlCreateFileParserCtxt  (const char *filename,
-                                             const char *encoding);
-void        (*xmlEntityReferenceFunc)       (xmlEntityPtr ent,
-                                             xmlNodePtr firstNode,
-                                             xmlNodePtr lastNode);
-void        xmlSetEntityReferenceFunc       (xmlEntityReferenceFunc func);
-void        xmlErrMemory                    (xmlParserCtxtPtr ctxt,
-                                             const char *extra);
-
Description

-
-
Details
xmlParserMaxDepth
extern unsigned int xmlParserMaxDepth;
-

-arbitrary depth limit for the XML documents that we allow to 
-process. This is not a limitation of the parser but a safety 
-boundary feature.

-
-
XML_MAX_NAMELEN
#define XML_MAX_NAMELEN 100
-

-Identifiers can be longer, but this will be more costly
-at runtime.

-
-
INPUT_CHUNK
#define INPUT_CHUNK	250
-

-The parser tries to always have that amount of input ready.
-One of the point is providing context when reporting errors.

-
-
IS_BYTE_CHAR()
#define IS_BYTE_CHAR(c)	 xmlIsChar_ch(c)
-

-Macro to check the following production in the XML spec:
-

-[2] Char ::= x9 | xA | xD | [x20...]
-any byte character in the accepted range

-
-
c:  an byte value (int)
-
IS_CHAR()
#define IS_CHAR(c)   xmlIsCharQ(c)
-

-Macro to check the following production in the XML spec:
-

-[2] Char ::= x9 | xA | xD | [x20-xD7FF] | [xE000-xFFFD]
-                 | [x10000-x10FFFF]
-any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.

-
-
c:  an UNICODE value (int)
-
IS_CHAR_CH()
#define IS_CHAR_CH(c)  xmlIsChar_ch(c)
-

-Behaves like IS_CHAR on single-byte value

-
-
c: an xmlChar (usually an unsigned char)
-
IS_BLANK()
#define IS_BLANK(c)  xmlIsBlankQ(c)
-

-Macro to check the following production in the XML spec:
-

-[3] S ::= (x20 | x9 | xD | xA)+

-
-
c:  an UNICODE value (int)
-
IS_BLANK_CH()
#define IS_BLANK_CH(c)  xmlIsBlank_ch(c)
-

-Behaviour same as IS_BLANK

-
-
c:  an xmlChar value (normally unsigned char)
-
IS_BASECHAR()
#define IS_BASECHAR(c) xmlIsBaseCharQ(c)
-

-Macro to check the following production in the XML spec:
-

-[85] BaseChar ::= ... long list see REC ...

-
-
c:  an UNICODE value (int)
-
IS_DIGIT()
#define IS_DIGIT(c) xmlIsDigitQ(c)
-

-Macro to check the following production in the XML spec:
-

-[88] Digit ::= ... long list see REC ...

-
-
c:  an UNICODE value (int)
-
IS_DIGIT_CH()
#define IS_DIGIT_CH(c)  xmlIsDigit_ch(c)
-

-Behaves like IS_DIGIT but with a single byte argument

-
-
c:  an xmlChar value (usually an unsigned char)
-
IS_COMBINING()
#define IS_COMBINING(c) xmlIsCombiningQ(c)
-

-Macro to check the following production in the XML spec:
-

-[87] CombiningChar ::= ... long list see REC ...

-
-
c:  an UNICODE value (int)
-
IS_COMBINING_CH()
#define IS_COMBINING_CH(c) 0 
-

-Always false (all combining chars > 0xff)

-
-
c:  an xmlChar (usually an unsigned char)
-
IS_EXTENDER()
#define IS_EXTENDER(c) xmlIsExtenderQ(c)
-

-Macro to check the following production in the XML spec:
-

-[89] Extender ::= x00B7 | x02D0 | x02D1 | x0387 | x0640 |
-                  x0E46 | x0EC6 | x3005 | [x3031-x3035] |
-                  [x309D-x309E] | [x30FC-x30FE]

-
-
c:  an UNICODE value (int)
-
IS_EXTENDER_CH()
#define IS_EXTENDER_CH(c)  xmlIsExtender_ch(c)
-

-Behaves like IS_EXTENDER but with a single-byte argument

-
-
c:  an xmlChar value (usually an unsigned char)
-
IS_IDEOGRAPHIC()
#define IS_IDEOGRAPHIC(c) xmlIsIdeographicQ(c)
-

-Macro to check the following production in the XML spec:
-

-[86] Ideographic ::= [x4E00-x9FA5] | x3007 | [x3021-x3029]

-
-
c:  an UNICODE value (int)
-
IS_LETTER()
#define IS_LETTER(c) (IS_BASECHAR(c) || IS_IDEOGRAPHIC(c))
-

-Macro to check the following production in the XML spec:
-

-[84] Letter ::= BaseChar | Ideographic

-
-
c:  an UNICODE value (int)
-
IS_LETTER_CH()
#define IS_LETTER_CH(c) xmlIsBaseChar_ch(c)
-

-Macro behaves like IS_LETTER, but only check base chars

-
-
c:  an xmlChar value (normally unsigned char)
-
IS_PUBIDCHAR()
#define IS_PUBIDCHAR(c)	xmlIsPubidCharQ(c)
-

-Macro to check the following production in the XML spec:
-

-[13] PubidChar ::= x20 | xD | xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]

-
-
c:  an UNICODE value (int)
-
IS_PUBIDCHAR_CH()
#define IS_PUBIDCHAR_CH(c) xmlIsPubidChar_ch(c)
-

-Same as IS_PUBIDCHAR but for single-byte value

-
-
c:  an xmlChar value (normally unsigned char)
-
SKIP_EOL()
#define     SKIP_EOL(p)

-Skips the end of line chars.

-
-
p:  and UTF8 string pointer
-
MOVETO_ENDTAG()
#define     MOVETO_ENDTAG(p)

-Skips to the next '>' char.

-
-
p:  and UTF8 string pointer
-
MOVETO_STARTTAG()
#define     MOVETO_STARTTAG(p)

-Skips to the next '<' char.

-
-
p:  and UTF8 string pointer
-
xmlIsLetter ()
int         xmlIsLetter                     (int c);

-Check whether the character is allowed by the production
-[84] Letter ::= BaseChar | Ideographic

-
-
c:  an unicode character (int)
-
Returns :0 if not, non-zero otherwise
-
xmlCreateFileParserCtxt ()
xmlParserCtxtPtr xmlCreateFileParserCtxt    (const char *filename);

-Create a parser context for a file content. 
-Automatic support for ZLIB/Compress compressed document is provided
-by default if found at compile-time.

-
-
filename:  the filename
-
Returns :the new parser context or NULL
-
xmlCreateURLParserCtxt ()
xmlParserCtxtPtr xmlCreateURLParserCtxt     (const char *filename,
-                                             int options);

-Create a parser context for a file or URL content. 
-Automatic support for ZLIB/Compress compressed document is provided
-by default if found at compile-time and for file accesses

-
-
filename:  the filename or URL
-
options:  a combination of xmlParserOption(s)
-
Returns :the new parser context or NULL
-
xmlCreateMemoryParserCtxt ()
xmlParserCtxtPtr xmlCreateMemoryParserCtxt  (const char *buffer,
-                                             int size);

-Create a parser context for an XML in-memory document.

-
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
Returns :the new parser context or NULL
-
xmlCreateEntityParserCtxt ()
xmlParserCtxtPtr xmlCreateEntityParserCtxt  (const xmlChar *URL,
-                                             const xmlChar *ID,
-                                             const xmlChar *base);

-Create a parser context for an external entity
-Automatic support for ZLIB/Compress compressed document is provided
-by default if found at compile-time.

-
-
URL:  the entity URL
-
ID:  the entity PUBLIC ID
-
base:  a possible base for the target URI
-
Returns :the new parser context or NULL
-
xmlSwitchEncoding ()
int         xmlSwitchEncoding               (xmlParserCtxtPtr ctxt,
-                                             xmlCharEncoding enc);

-change the input functions when discovering the character encoding
-of a given entity.

-
-
ctxt:  the parser context
-
enc:  the encoding value (number)
-
Returns :0 in case of success, -1 otherwise
-
xmlSwitchToEncoding ()
int         xmlSwitchToEncoding             (xmlParserCtxtPtr ctxt,
-                                             xmlCharEncodingHandlerPtr handler);

-change the input functions when discovering the character encoding
-of a given entity.

-
-
ctxt:  the parser context
-
handler:  the encoding handler
-
Returns :0 in case of success, -1 otherwise
-
xmlSwitchInputEncoding ()
int         xmlSwitchInputEncoding          (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr input,
-                                             xmlCharEncodingHandlerPtr handler);

-change the input functions when discovering the character encoding
-of a given entity.

-
-
ctxt:  the parser context
-
input:  the input stream
-
handler:  the encoding handler
-
Returns :0 in case of success, -1 otherwise
-
xmlHandleEntity ()
void        xmlHandleEntity                 (xmlParserCtxtPtr ctxt,
-                                             xmlEntityPtr entity);

-Default handling of defined entities, when should we define a new input
-stream ? When do we just handle that as a set of chars ?
-

-OBSOLETE: to be removed at some point.

-
-
ctxt:  an XML parser context
-
entity:  an XML entity pointer.
-
xmlNewStringInputStream ()
xmlParserInputPtr xmlNewStringInputStream   (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *buffer);

-Create a new input stream based on a memory buffer.

-
-
ctxt:  an XML parser context
-
buffer:  an memory buffer
-
Returns :the new input stream
-
xmlNewEntityInputStream ()
xmlParserInputPtr xmlNewEntityInputStream   (xmlParserCtxtPtr ctxt,
-                                             xmlEntityPtr entity);

-Create a new input stream based on an xmlEntityPtr

-
-
ctxt:  an XML parser context
-
entity:  an Entity pointer
-
Returns :the new input stream or NULL
-
xmlPushInput ()
void        xmlPushInput                    (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr input);

-xmlPushInput: switch to a new input stream which is stacked on top
-              of the previous one(s).

-
-
ctxt:  an XML parser context
-
input:  an XML parser input fragment (entity, XML fragment ...).
-
xmlPopInput ()
xmlChar     xmlPopInput                     (xmlParserCtxtPtr ctxt);

-xmlPopInput: the current input pointed by ctxt->input came to an end
-         pop it and return the next char.

-
-
ctxt:  an XML parser context
-
Returns :the current xmlChar in the parser context
-
xmlFreeInputStream ()
void        xmlFreeInputStream              (xmlParserInputPtr input);

-Free up an input stream.

-
-
input:  an xmlParserInputPtr
-
xmlNewInputFromFile ()
xmlParserInputPtr xmlNewInputFromFile       (xmlParserCtxtPtr ctxt,
-                                             const char *filename);

-Create a new input stream based on a file or an URL.

-
-
ctxt:  an XML parser context
-
filename:  the filename to use as entity
-
Returns :the new input stream or NULL in case of error
-
xmlNewInputStream ()
xmlParserInputPtr xmlNewInputStream         (xmlParserCtxtPtr ctxt);

-Create a new input stream structure

-
-
ctxt:  an XML parser context
-
Returns :the new input stream or NULL
-
xmlSplitQName ()
xmlChar*    xmlSplitQName                   (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlChar **prefix);

-parse an UTF8 encoded XML qualified name string
-

-[NS 5] QName ::= (Prefix ':')? LocalPart
-

-[NS 6] Prefix ::= NCName
-

-[NS 7] LocalPart ::= NCName

-
-
ctxt:  an XML parser context
-
name:  an XML parser context
-
prefix:  a xmlChar ** 
-
Returns :the local part, and prefix is updated
-  to get the Prefix if any.
-
xmlNamespaceParseNCName ()
xmlChar*    xmlNamespaceParseNCName         (xmlParserCtxtPtr ctxt);

-parse an XML namespace name.
-

-TODO: this seems not in use anymore, the namespace handling is done on
-      top of the SAX interfaces, i.e. not on raw input.
-

-[NS 3] NCName ::= (Letter | '_') (NCNameChar)*
-

-[NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' |
-                      CombiningChar | Extender

-
-
ctxt:  an XML parser context
-
Returns :the namespace name or NULL
-
xmlNamespaceParseQName ()
xmlChar*    xmlNamespaceParseQName          (xmlParserCtxtPtr ctxt,
-                                             xmlChar **prefix);

-TODO: this seems not in use anymore, the namespace handling is done on
-      top of the SAX interfaces, i.e. not on raw input.
-

-parse an XML qualified name
-

-[NS 5] QName ::= (Prefix ':')? LocalPart
-

-[NS 6] Prefix ::= NCName
-

-[NS 7] LocalPart ::= NCName

-
-
ctxt:  an XML parser context
-
prefix:  a xmlChar ** 
-
Returns :the local part, and prefix is updated
-  to get the Prefix if any.
-
xmlNamespaceParseNSDef ()
xmlChar*    xmlNamespaceParseNSDef          (xmlParserCtxtPtr ctxt);

-parse a namespace prefix declaration
-

-TODO: this seems not in use anymore, the namespace handling is done on
-      top of the SAX interfaces, i.e. not on raw input.
-

-[NS 1] NSDef ::= PrefixDef Eq SystemLiteral
-

-[NS 2] PrefixDef ::= 'xmlns' (':' NCName)?

-
-
ctxt:  an XML parser context
-
Returns :the namespace name
-
xmlParseQuotedString ()
xmlChar*    xmlParseQuotedString            (xmlParserCtxtPtr ctxt);

-Parse and return a string between quotes or doublequotes
-

-TODO: Deprecated, to  be removed at next drop of binary compatibility

-
-
ctxt:  an XML parser context
-
Returns :the string parser or NULL.
-
xmlParseNamespace ()
void        xmlParseNamespace               (xmlParserCtxtPtr ctxt);

-xmlParseNamespace: parse specific PI '<?namespace ...' constructs.
-

-This is what the older xml-name Working Draft specified, a bunch of
-other stuff may still rely on it, so support is still here as
-if it was declared on the root of the Tree:-(
-

-TODO: remove from library
-

-To be removed at next drop of binary compatibility

-
-
ctxt:  an XML parser context
-
xmlScanName ()
xmlChar*    xmlScanName                     (xmlParserCtxtPtr ctxt);

-Trickery: parse an XML name but without consuming the input flow
-Needed for rollback cases. Used only when parsing entities references.
-

-TODO: seems deprecated now, only used in the default part of
-      xmlParserHandleReference
-

-[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
-                 CombiningChar | Extender
-

-[5] Name ::= (Letter | '_' | ':') (NameChar)*
-

-[6] Names ::= Name (S Name)*

-
-
ctxt:  an XML parser context
-
Returns :the Name parsed or NULL
-
xmlParseName ()
const xmlChar* xmlParseName                 (xmlParserCtxtPtr ctxt);

-parse an XML name.
-

-[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
-                 CombiningChar | Extender
-

-[5] Name ::= (Letter | '_' | ':') (NameChar)*
-

-[6] Names ::= Name (S Name)*

-
-
ctxt:  an XML parser context
-
Returns :the Name parsed or NULL
-
xmlParseNmtoken ()
xmlChar*    xmlParseNmtoken                 (xmlParserCtxtPtr ctxt);

-parse an XML Nmtoken.
-

-[7] Nmtoken ::= (NameChar)+
-

-[8] Nmtokens ::= Nmtoken (S Nmtoken)*

-
-
ctxt:  an XML parser context
-
Returns :the Nmtoken parsed or NULL
-
xmlParseEntityValue ()
xmlChar*    xmlParseEntityValue             (xmlParserCtxtPtr ctxt,
-                                             xmlChar **orig);

-parse a value for ENTITY declarations
-

-[9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' |
-               "'" ([^%&'] | PEReference | Reference)* "'"

-
-
ctxt:  an XML parser context
-
orig:  if non-NULL store a copy of the original entity value
-
Returns :the EntityValue parsed with reference substituted or NULL
-
xmlParseAttValue ()
xmlChar*    xmlParseAttValue                (xmlParserCtxtPtr ctxt);

-parse a value for an attribute
-Note: the parser won't do substitution of entities here, this
-will be handled later in xmlStringGetNodeList
-

-[10] AttValue ::= '"' ([^<&"] | Reference)* '"' |
-                  "'" ([^<&'] | Reference)* "'"
-

-3.3.3 Attribute-Value Normalization:
-Before the value of an attribute is passed to the application or
-checked for validity, the XML processor must normalize it as follows: 
-- a character reference is processed by appending the referenced
-  character to the attribute value
-- an entity reference is processed by recursively processing the
-  replacement text of the entity 
-- a whitespace character (x20, xD, xA, x9) is processed by
-  appending x20 to the normalized value, except that only a single
-  x20 is appended for a "xDxA" sequence that is part of an external
-  parsed entity or the literal entity value of an internal parsed entity 
-- other characters are processed by appending them to the normalized value 
-If the declared value is not CDATA, then the XML processor must further
-process the normalized attribute value by discarding any leading and
-trailing space (x20) characters, and by replacing sequences of space
-(x20) characters by a single space (x20) character.  
-All attributes for which no declaration has been read should be treated
-by a non-validating parser as if declared CDATA.

-
-
ctxt:  an XML parser context
-
Returns :the AttValue parsed or NULL. The value has to be freed by the caller.
-
xmlParseSystemLiteral ()
xmlChar*    xmlParseSystemLiteral           (xmlParserCtxtPtr ctxt);

-parse an XML Literal
-

-[11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")

-
-
ctxt:  an XML parser context
-
Returns :the SystemLiteral parsed or NULL
-
xmlParsePubidLiteral ()
xmlChar*    xmlParsePubidLiteral            (xmlParserCtxtPtr ctxt);

-parse an XML public literal
-

-[12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"

-
-
ctxt:  an XML parser context
-
Returns :the PubidLiteral parsed or NULL.
-
xmlParseCharData ()
void        xmlParseCharData                (xmlParserCtxtPtr ctxt,
-                                             int cdata);

-parse a CharData section.
-if we are within a CDATA section ']]>' marks an end of section.
-

-The right angle bracket (>) may be represented using the string "&gt;",
-and must, for compatibility, be escaped using "&gt;" or a character
-reference when it appears in the string "]]>" in content, when that
-string is not marking the end of a CDATA section. 
-

-[14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<&]*)

-
-
ctxt:  an XML parser context
-
cdata:  int indicating whether we are within a CDATA section
-
xmlParseExternalID ()
xmlChar*    xmlParseExternalID              (xmlParserCtxtPtr ctxt,
-                                             xmlChar **publicID,
-                                             int strict);

-Parse an External ID or a Public ID
-

-NOTE: Productions [75] and [83] interact badly since [75] can generate
-      'PUBLIC' S PubidLiteral S SystemLiteral
-

-[75] ExternalID ::= 'SYSTEM' S SystemLiteral
-                  | 'PUBLIC' S PubidLiteral S SystemLiteral
-

-[83] PublicID ::= 'PUBLIC' S PubidLiteral

-
-
ctxt:  an XML parser context
-
publicID:  a xmlChar** receiving PubidLiteral
-
strict: indicate whether we should restrict parsing to only
-         production [75], see NOTE below
-
Returns :the function returns SystemLiteral and in the second
-               case publicID receives PubidLiteral, is strict is off
-               it is possible to return NULL and have publicID set.
-
xmlParseComment ()
void        xmlParseComment                 (xmlParserCtxtPtr ctxt);

-Skip an XML (SGML) comment <!-- .... -->
- The spec says that "For compatibility, the string "--" (double-hyphen)
- must not occur within comments. "
-

-[15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

-
-
ctxt:  an XML parser context
-
xmlParsePITarget ()
const xmlChar* xmlParsePITarget             (xmlParserCtxtPtr ctxt);

-parse the name of a PI
-

-[17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))

-
-
ctxt:  an XML parser context
-
Returns :the PITarget name or NULL
-
xmlParsePI ()
void        xmlParsePI                      (xmlParserCtxtPtr ctxt);

-parse an XML Processing Instruction.
-

-[16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
-

-The processing is transfered to SAX once parsed.

-
-
ctxt:  an XML parser context
-
xmlParseNotationDecl ()
void        xmlParseNotationDecl            (xmlParserCtxtPtr ctxt);

-parse a notation declaration
-

-[82] NotationDecl ::= '<!NOTATION' S Name S (ExternalID |  PublicID) S? '>'
-

-Hence there is actually 3 choices:
-    'PUBLIC' S PubidLiteral
-    'PUBLIC' S PubidLiteral S SystemLiteral
-and 'SYSTEM' S SystemLiteral
-

-See the NOTE on xmlParseExternalID().

-
-
ctxt:  an XML parser context
-
xmlParseEntityDecl ()
void        xmlParseEntityDecl              (xmlParserCtxtPtr ctxt);

-parse <!ENTITY declarations
-

-[70] EntityDecl ::= GEDecl | PEDecl
-

-[71] GEDecl ::= '<!ENTITY' S Name S EntityDef S? '>'
-

-[72] PEDecl ::= '<!ENTITY' S '%' S Name S PEDef S? '>'
-

-[73] EntityDef ::= EntityValue | (ExternalID NDataDecl?)
-

-[74] PEDef ::= EntityValue | ExternalID
-

-[76] NDataDecl ::= S 'NDATA' S Name
-

-[ VC: Notation Declared ]
-The Name must match the declared name of a notation.

-
-
ctxt:  an XML parser context
-
xmlParseDefaultDecl ()
int         xmlParseDefaultDecl             (xmlParserCtxtPtr ctxt,
-                                             xmlChar **value);

-Parse an attribute default declaration
-

-[60] DefaultDecl ::= 'REQUIRED' | 'IMPLIED' | (('FIXED' S)? AttValue)
-

-[ VC: Required Attribute ]
-if the default declaration is the keyword REQUIRED, then the
-attribute must be specified for all elements of the type in the
-attribute-list declaration.
-

-[ VC: Attribute Default Legal ]
-The declared default value must meet the lexical constraints of
-the declared attribute type c.f. xmlValidateAttributeDecl()
-

-[ VC: Fixed Attribute Default ]
-if an attribute has a default value declared with the FIXED
-keyword, instances of that attribute must match the default value. 
-

-[ WFC: No < in Attribute Values ]
-handled in xmlParseAttValue()

-
-
ctxt:  an XML parser context
-
value:  Receive a possible fixed default value for the attribute
-
Returns : XML_ATTRIBUTE_NONE, XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_IMPLIED
-         or XML_ATTRIBUTE_FIXED. 
-
xmlParseNotationType ()
xmlEnumerationPtr xmlParseNotationType      (xmlParserCtxtPtr ctxt);

-parse an Notation attribute type.
-

-Note: the leading 'NOTATION' S part has already being parsed...
-

-[58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'
-

-[ VC: Notation Attributes ]
-Values of this type must match one of the notation names included
-in the declaration; all notation names in the declaration must be declared.

-
-
ctxt:  an XML parser context
-
Returns : the notation attribute tree built while parsing
-
xmlParseEnumerationType ()
xmlEnumerationPtr xmlParseEnumerationType   (xmlParserCtxtPtr ctxt);

-parse an Enumeration attribute type.
-

-[59] Enumeration ::= '(' S? Nmtoken (S? '|' S? Nmtoken)* S? ')'
-

-[ VC: Enumeration ]
-Values of this type must match one of the Nmtoken tokens in
-the declaration

-
-
ctxt:  an XML parser context
-
Returns : the enumeration attribute tree built while parsing
-
xmlParseEnumeratedType ()
int         xmlParseEnumeratedType          (xmlParserCtxtPtr ctxt,
-                                             xmlEnumerationPtr *tree);

-parse an Enumerated attribute type.
-

-[57] EnumeratedType ::= NotationType | Enumeration
-

-[58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'

-
-
ctxt:  an XML parser context
-
tree:  the enumeration tree built while parsing
-
Returns : XML_ATTRIBUTE_ENUMERATION or XML_ATTRIBUTE_NOTATION
-
xmlParseAttributeType ()
int         xmlParseAttributeType           (xmlParserCtxtPtr ctxt,
-                                             xmlEnumerationPtr *tree);

-parse the Attribute list def for an element
-

-[54] AttType ::= StringType | TokenizedType | EnumeratedType
-

-[55] StringType ::= 'CDATA'
-

-[56] TokenizedType ::= 'ID' | 'IDREF' | 'IDREFS' | 'ENTITY' |
-                       'ENTITIES' | 'NMTOKEN' | 'NMTOKENS'
-

-Validity constraints for attribute values syntax are checked in
-xmlValidateAttributeValue()
-

-[ VC: ID ]
-Values of type ID must match the Name production. A name must not
-appear more than once in an XML document as a value of this type;
-i.e., ID values must uniquely identify the elements which bear them.
-

-[ VC: One ID per Element Type ]
-No element type may have more than one ID attribute specified.
-

-[ VC: ID Attribute Default ]
-An ID attribute must have a declared default of IMPLIED or REQUIRED.
-

-[ VC: IDREF ]
-Values of type IDREF must match the Name production, and values
-of type IDREFS must match Names; each IDREF Name must match the value
-of an ID attribute on some element in the XML document; i.e. IDREF
-values must match the value of some ID attribute.
-

-[ VC: Entity Name ]
-Values of type ENTITY must match the Name production, values
-of type ENTITIES must match Names; each Entity Name must match the
-name of an unparsed entity declared in the DTD.  
-

-[ VC: Name Token ]
-Values of type NMTOKEN must match the Nmtoken production; values
-of type NMTOKENS must match Nmtokens.

-
-
ctxt:  an XML parser context
-
tree:  the enumeration tree built while parsing
-
Returns :the attribute type
-
xmlParseAttributeListDecl ()
void        xmlParseAttributeListDecl       (xmlParserCtxtPtr ctxt);

-: parse the Attribute list def for an element
-

-[52] AttlistDecl ::= '<!ATTLIST' S Name AttDef* S? '>'
-

-[53] AttDef ::= S Name S AttType S DefaultDecl

-
-
ctxt:  an XML parser context
-
xmlParseElementContentDecl ()
int         xmlParseElementContentDecl      (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlElementContentPtr *result);

-parse the declaration for an Element content either Mixed or Children,
-the cases EMPTY and ANY are handled directly in xmlParseElementDecl
-

-[46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children

-
-
ctxt:  an XML parser context
-
name:  the name of the element being defined.
-
result:  the Element Content pointer will be stored here if any
-
Returns : the type of element content XML_ELEMENT_TYPE_xxx
-
xmlParseElementDecl ()
int         xmlParseElementDecl             (xmlParserCtxtPtr ctxt);

-parse an Element declaration.
-

-[45] elementdecl ::= '<!ELEMENT' S Name S contentspec S? '>'
-

-[ VC: Unique Element Type Declaration ]
-No element type may be declared more than once

-
-
ctxt:  an XML parser context
-
Returns :the type of the element, or -1 in case of error
-
xmlParseMarkupDecl ()
void        xmlParseMarkupDecl              (xmlParserCtxtPtr ctxt);

-parse Markup declarations
-

-[29] markupdecl ::= elementdecl | AttlistDecl | EntityDecl |
-                    NotationDecl | PI | Comment
-

-[ VC: Proper Declaration/PE Nesting ]
-Parameter-entity replacement text must be properly nested with
-markup declarations. That is to say, if either the first character
-or the last character of a markup declaration (markupdecl above) is
-contained in the replacement text for a parameter-entity reference,
-both must be contained in the same replacement text.
-

-[ WFC: PEs in Internal Subset ]
-In the internal DTD subset, parameter-entity references can occur
-only where markup declarations can occur, not within markup declarations.
-(This does not apply to references that occur in external parameter
-entities or to the external subset.)

-
-
ctxt:  an XML parser context
-
xmlParseCharRef ()
int         xmlParseCharRef                 (xmlParserCtxtPtr ctxt);

-parse Reference declarations
-

-[66] CharRef ::= '&#' [0-9]+ ';' |
-                 '&x' [0-9a-fA-F]+ ';'
-

-[ WFC: Legal Character ]
-Characters referred to using character references must match the
-production for Char.

-
-
ctxt:  an XML parser context
-
Returns :the value parsed (as an int), 0 in case of error
-
xmlParseEntityRef ()
xmlEntityPtr xmlParseEntityRef              (xmlParserCtxtPtr ctxt);

-parse ENTITY references declarations
-

-[68] EntityRef ::= '&' Name ';'
-

-[ WFC: Entity Declared ]
-In a document without any DTD, a document with only an internal DTD
-subset which contains no parameter entity references, or a document
-with "standalone='yes'", the Name given in the entity reference
-must match that in an entity declaration, except that well-formed
-documents need not declare any of the following entities: amp, lt,
-gt, apos, quot.  The declaration of a parameter entity must precede
-any reference to it.  Similarly, the declaration of a general entity
-must precede any reference to it which appears in a default value in an
-attribute-list declaration. Note that if entities are declared in the
-external subset or in external parameter entities, a non-validating
-processor is not obligated to read and process their declarations;
-for such documents, the rule that an entity must be declared is a
-well-formedness constraint only if standalone='yes'.
-

-[ WFC: Parsed Entity ]
-An entity reference must not contain the name of an unparsed entity

-
-
ctxt:  an XML parser context
-
Returns :the xmlEntityPtr if found, or NULL otherwise.
-
xmlParseReference ()
void        xmlParseReference               (xmlParserCtxtPtr ctxt);

-parse and handle entity references in content, depending on the SAX
-interface, this may end-up in a call to character() if this is a
-CharRef, a predefined entity, if there is no reference() callback.
-or if the parser was asked to switch to that mode.
-

-[67] Reference ::= EntityRef | CharRef

-
-
ctxt:  an XML parser context
-
xmlParsePEReference ()
void        xmlParsePEReference             (xmlParserCtxtPtr ctxt);

-parse PEReference declarations
-The entity content is handled directly by pushing it's content as
-a new input stream.
-

-[69] PEReference ::= '%' Name ';'
-

-[ WFC: No Recursion ]
-A parsed entity must not contain a recursive
-reference to itself, either directly or indirectly. 
-

-[ WFC: Entity Declared ]
-In a document without any DTD, a document with only an internal DTD
-subset which contains no parameter entity references, or a document
-with "standalone='yes'", ...  ... The declaration of a parameter
-entity must precede any reference to it...
-

-[ VC: Entity Declared ]
-In a document with an external subset or external parameter entities
-with "standalone='no'", ...  ... The declaration of a parameter entity
-must precede any reference to it...
-

-[ WFC: In DTD ]
-Parameter-entity references may only appear in the DTD.
-NOTE: misleading but this is handled.

-
-
ctxt:  an XML parser context
-
xmlParseDocTypeDecl ()
void        xmlParseDocTypeDecl             (xmlParserCtxtPtr ctxt);

-parse a DOCTYPE declaration
-

-[28] doctypedecl ::= '<!DOCTYPE' S Name (S ExternalID)? S? 
-                     ('[' (markupdecl | PEReference | S)* ']' S?)? '>'
-

-[ VC: Root Element Type ]
-The Name in the document type declaration must match the element
-type of the root element.

-
-
ctxt:  an XML parser context
-
xmlParseAttribute ()
const xmlChar* xmlParseAttribute            (xmlParserCtxtPtr ctxt,
-                                             xmlChar **value);

-parse an attribute
-

-[41] Attribute ::= Name Eq AttValue
-

-[ WFC: No External Entity References ]
-Attribute values cannot contain direct or indirect entity references
-to external entities.
-

-[ WFC: No < in Attribute Values ]
-The replacement text of any entity referred to directly or indirectly in
-an attribute value (other than "&lt;") must not contain a <. 
-

-[ VC: Attribute Value Type ]
-The attribute must have been declared; the value must be of the type
-declared for it.
-

-[25] Eq ::= S? '=' S?
-

-With namespace:
-

-[NS 11] Attribute ::= QName Eq AttValue
-

-Also the case QName == xmlns:??? is handled independently as a namespace
-definition.

-
-
ctxt:  an XML parser context
-
value:  a xmlChar ** used to store the value of the attribute
-
Returns :the attribute name, and the value in *value.
-
xmlParseStartTag ()
const xmlChar* xmlParseStartTag             (xmlParserCtxtPtr ctxt);

-parse a start of tag either for rule element or
-EmptyElement. In both case we don't parse the tag closing chars.
-

-[40] STag ::= '<' Name (S Attribute)* S? '>'
-

-[ WFC: Unique Att Spec ]
-No attribute name may appear more than once in the same start-tag or
-empty-element tag. 
-

-[44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>'
-

-[ WFC: Unique Att Spec ]
-No attribute name may appear more than once in the same start-tag or
-empty-element tag. 
-

-With namespace:
-

-[NS 8] STag ::= '<' QName (S Attribute)* S? '>'
-

-[NS 10] EmptyElement ::= '<' QName (S Attribute)* S? '/>'

-
-
ctxt:  an XML parser context
-
Returns :the element name parsed
-
xmlParseEndTag ()
void        xmlParseEndTag                  (xmlParserCtxtPtr ctxt);

-parse an end of tag
-

-[42] ETag ::= '</' Name S? '>'
-

-With namespace
-

-[NS 9] ETag ::= '</' QName S? '>'

-
-
ctxt:  an XML parser context
-
xmlParseCDSect ()
void        xmlParseCDSect                  (xmlParserCtxtPtr ctxt);

-Parse escaped pure raw content.
-

-[18] CDSect ::= CDStart CData CDEnd
-

-[19] CDStart ::= '<![CDATA['
-

-[20] Data ::= (Char* - (Char* ']]>' Char*))
-

-[21] CDEnd ::= ']]>'

-
-
ctxt:  an XML parser context
-
xmlParseContent ()
void        xmlParseContent                 (xmlParserCtxtPtr ctxt);

-Parse a content:
-

-[43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

-
-
ctxt:  an XML parser context
-
xmlParseElement ()
void        xmlParseElement                 (xmlParserCtxtPtr ctxt);

-parse an XML element, this is highly recursive
-

-[39] element ::= EmptyElemTag | STag content ETag
-

-[ WFC: Element Type Match ]
-The Name in an element's end-tag must match the element type in the
-start-tag.

-
-
ctxt:  an XML parser context
-
xmlParseVersionNum ()
xmlChar*    xmlParseVersionNum              (xmlParserCtxtPtr ctxt);

-parse the XML version value.
-

-[26] VersionNum ::= ([a-zA-Z0-9_.:] | '-')+

-
-
ctxt:  an XML parser context
-
Returns :the string giving the XML version number, or NULL
-
xmlParseVersionInfo ()
xmlChar*    xmlParseVersionInfo             (xmlParserCtxtPtr ctxt);

-parse the XML version.
-

-[24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ")
-

-[25] Eq ::= S? '=' S?

-
-
ctxt:  an XML parser context
-
Returns :the version string, e.g. "1.0"
-
xmlParseEncName ()
xmlChar*    xmlParseEncName                 (xmlParserCtxtPtr ctxt);

-parse the XML encoding name
-

-[81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*

-
-
ctxt:  an XML parser context
-
Returns :the encoding name value or NULL
-
xmlParseEncodingDecl ()
const xmlChar* xmlParseEncodingDecl         (xmlParserCtxtPtr ctxt);

-parse the XML encoding declaration
-

-[80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' |  "'" EncName "'")
-

-this setups the conversion filters.

-
-
ctxt:  an XML parser context
-
Returns :the encoding value or NULL
-
xmlParseSDDecl ()
int         xmlParseSDDecl                  (xmlParserCtxtPtr ctxt);

-parse the XML standalone declaration
-

-[32] SDDecl ::= S 'standalone' Eq
-                (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no')'"')) 
-

-[ VC: Standalone Document Declaration ]
-TODO The standalone document declaration must have the value "no"
-if any external markup declarations contain declarations of:
- - attributes with default values, if elements to which these
-   attributes apply appear in the document without specifications
-   of values for these attributes, or
- - entities (other than amp, lt, gt, apos, quot), if references
-   to those entities appear in the document, or
- - attributes with values subject to normalization, where the
-   attribute appears in the document with a value which will change
-   as a result of normalization, or
- - element types with element content, if white space occurs directly
-   within any instance of those types.

-
-
ctxt:  an XML parser context
-
Returns :1 if standalone, 0 otherwise
-
xmlParseXMLDecl ()
void        xmlParseXMLDecl                 (xmlParserCtxtPtr ctxt);

-parse an XML declaration header
-

-[23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'

-
-
ctxt:  an XML parser context
-
xmlParseTextDecl ()
void        xmlParseTextDecl                (xmlParserCtxtPtr ctxt);

-parse an XML declaration header for external entities
-

-[77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'
-

-Question: Seems that EncodingDecl is mandatory ? Is that a typo ?

-
-
ctxt:  an XML parser context
-
xmlParseMisc ()
void        xmlParseMisc                    (xmlParserCtxtPtr ctxt);

-parse an XML Misc* optional field.
-

-[27] Misc ::= Comment | PI |  S

-
-
ctxt:  an XML parser context
-
xmlParseExternalSubset ()
void        xmlParseExternalSubset          (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

-parse Markup declarations from an external subset
-

-[30] extSubset ::= textDecl? extSubsetDecl
-

-[31] extSubsetDecl ::= (markupdecl | conditionalSect | PEReference | S) *

-
-
ctxt:  an XML parser context
-
ExternalID: the external identifier
-
SystemID: the system identifier (or URL)
-
XML_SUBSTITUTE_NONE
#define XML_SUBSTITUTE_NONE	0
-

-If no entities need to be substituted.

-
-
XML_SUBSTITUTE_REF
#define XML_SUBSTITUTE_REF	1
-

-Whether general entities need to be substituted.

-
-
XML_SUBSTITUTE_PEREF
#define XML_SUBSTITUTE_PEREF	2
-

-Whether parameter entities need to be substituted.

-
-
XML_SUBSTITUTE_BOTH
#define XML_SUBSTITUTE_BOTH 	3
-

-Both general and parameter entities need to be substituted.

-
-
xmlDecodeEntities ()
xmlChar*    xmlDecodeEntities               (xmlParserCtxtPtr ctxt,
-                                             int len,
-                                             int what,
-                                             xmlChar end,
-                                             xmlChar end2,
-                                             xmlChar end3);

-This function is deprecated, we now always process entities content
-through xmlStringDecodeEntities
-

-TODO: remove it in next major release.
-

-[67] Reference ::= EntityRef | CharRef
-

-[69] PEReference ::= '%' Name ';'

-
-
ctxt:  the parser context
-
len:  the len to decode (in bytes !), -1 for no size limit
-
what:  combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
-
end:  an end marker xmlChar, 0 if none
-
end2:  an end marker xmlChar, 0 if none
-
end3:  an end marker xmlChar, 0 if none
-
Returns :A newly allocated string with the substitution done. The caller
-     must deallocate it !
-
xmlStringDecodeEntities ()
xmlChar*    xmlStringDecodeEntities         (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *str,
-                                             int what,
-                                             xmlChar end,
-                                             xmlChar end2,
-                                             xmlChar end3);

-Takes a entity string content and process to do the adequate substitutions.
-

-[67] Reference ::= EntityRef | CharRef
-

-[69] PEReference ::= '%' Name ';'

-
-
ctxt:  the parser context
-
str:  the input string
-
what:  combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
-
end:  an end marker xmlChar, 0 if none
-
end2:  an end marker xmlChar, 0 if none
-
end3:  an end marker xmlChar, 0 if none
-
Returns :A newly allocated string with the substitution done. The caller
-     must deallocate it !
-
xmlStringLenDecodeEntities ()
xmlChar*    xmlStringLenDecodeEntities      (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *str,
-                                             int len,
-                                             int what,
-                                             xmlChar end,
-                                             xmlChar end2,
-                                             xmlChar end3);

-Takes a entity string content and process to do the adequate substitutions.
-

-[67] Reference ::= EntityRef | CharRef
-

-[69] PEReference ::= '%' Name ';'

-
-
ctxt:  the parser context
-
str:  the input string
-
len: the string length
-
what:  combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
-
end:  an end marker xmlChar, 0 if none
-
end2:  an end marker xmlChar, 0 if none
-
end3:  an end marker xmlChar, 0 if none
-
Returns :A newly allocated string with the substitution done. The caller
-     must deallocate it !
-
nodePush ()
int         nodePush                        (xmlParserCtxtPtr ctxt,
-                                             xmlNodePtr value);

-Pushes a new element node on top of the node stack

-
-
ctxt:  an XML parser context
-
value:  the element node
-
Returns :0 in case of error, the index in the stack otherwise
-
nodePop ()
xmlNodePtr  nodePop                         (xmlParserCtxtPtr ctxt);

-Pops the top element node from the node stack

-
-
ctxt: an XML parser context
-
Returns :the node just removed
-
inputPush ()
int         inputPush                       (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr value);

-Pushes a new parser input on top of the input stack

-
-
ctxt:  an XML parser context
-
value:  the parser input
-
Returns :0 in case of error, the index in the stack otherwise
-
inputPop ()
xmlParserInputPtr inputPop                  (xmlParserCtxtPtr ctxt);

-Pops the top parser input from the input stack

-
-
ctxt: an XML parser context
-
Returns :the input just removed
-
namePop ()
const xmlChar* namePop                      (xmlParserCtxtPtr ctxt);

-Pops the top element name from the name stack

-
-
ctxt: an XML parser context
-
Returns :the name just removed
-
namePush ()
int         namePush                        (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *value);

-Pushes a new element name on top of the name stack

-
-
ctxt:  an XML parser context
-
value:  the element name
-
Returns :-1 in case of error, the index in the stack otherwise
-
xmlSkipBlankChars ()
int         xmlSkipBlankChars               (xmlParserCtxtPtr ctxt);

-skip all blanks character found at that point in the input streams.
-It pops up finished entities in the process if allowable at that point.

-
-
ctxt:  the XML parser context
-
Returns :the number of space chars skipped
-
xmlStringCurrentChar ()
int         xmlStringCurrentChar            (xmlParserCtxtPtr ctxt,
-                                             const xmlChar *cur,
-                                             int *len);

-The current char value, if using UTF-8 this may actually span multiple
-bytes in the input buffer.

-
-
ctxt:  the XML parser context
-
cur:  pointer to the beginning of the char
-
len:  pointer to the length of the char read
-
Returns :the current char value and its length
-
xmlParserHandlePEReference ()
void        xmlParserHandlePEReference      (xmlParserCtxtPtr ctxt);

-[69] PEReference ::= '%' Name ';'
-

-[ WFC: No Recursion ]
-A parsed entity must not contain a recursive
-reference to itself, either directly or indirectly. 
-

-[ WFC: Entity Declared ]
-In a document without any DTD, a document with only an internal DTD
-subset which contains no parameter entity references, or a document
-with "standalone='yes'", ...  ... The declaration of a parameter
-entity must precede any reference to it...
-

-[ VC: Entity Declared ]
-In a document with an external subset or external parameter entities
-with "standalone='no'", ...  ... The declaration of a parameter entity
-must precede any reference to it...
-

-[ WFC: In DTD ]
-Parameter-entity references may only appear in the DTD.
-NOTE: misleading but this is handled.
-

-A PEReference may have been detected in the current input stream
-the handling is done accordingly to 
-     http://www.w3.org/TR/REC-xmlentproc
-i.e. 
-  - Included in literal in entity values
-  - Included as Parameter Entity reference within DTDs

-
-
ctxt:  the parser context
-
xmlParserHandleReference ()
void        xmlParserHandleReference        (xmlParserCtxtPtr ctxt);

-TODO: Remove, now deprecated ... the test is done directly in the
-      content parsing
-routines.
-

-[67] Reference ::= EntityRef | CharRef
-

-[68] EntityRef ::= '&' Name ';'
-

-[ WFC: Entity Declared ]
-the Name given in the entity reference must match that in an entity
-declaration, except that well-formed documents need not declare any
-of the following entities: amp, lt, gt, apos, quot. 
-

-[ WFC: Parsed Entity ]
-An entity reference must not contain the name of an unparsed entity
-

-[66] CharRef ::= '&#' [0-9]+ ';' |
-                 '&x' [0-9a-fA-F]+ ';'
-

-A PEReference may have been detected in the current input stream
-the handling is done accordingly to 
-     http://www.w3.org/TR/REC-xmlentproc

-
-
ctxt:  the parser context
-
xmlCheckLanguageID ()
int         xmlCheckLanguageID              (const xmlChar *lang);

-Checks that the value conforms to the LanguageID production:
-

-NOTE: this is somewhat deprecated, those productions were removed from
-      the XML Second edition.
-

-[33] LanguageID ::= Langcode ('-' Subcode)*
-[34] Langcode ::= ISO639Code |  IanaCode |  UserCode
-[35] ISO639Code ::= ([a-z] | [A-Z]) ([a-z] | [A-Z])
-[36] IanaCode ::= ('i' | 'I') '-' ([a-z] | [A-Z])+
-[37] UserCode ::= ('x' | 'X') '-' ([a-z] | [A-Z])+
-[38] Subcode ::= ([a-z] | [A-Z])+

-
-
lang:  pointer to the string value
-
Returns :1 if correct 0 otherwise
-
xmlCurrentChar ()
int         xmlCurrentChar                  (xmlParserCtxtPtr ctxt,
-                                             int *len);

-The current char value, if using UTF-8 this may actually span multiple
-bytes in the input buffer. Implement the end of line normalization:
-2.11 End-of-Line Handling
-Wherever an external parsed entity or the literal entity value
-of an internal parsed entity contains either the literal two-character
-sequence "xDxA" or a standalone literal xD, an XML processor
-must pass to the application the single character xA.
-This behavior can conveniently be produced by normalizing all
-line breaks to xA on input, before parsing.)

-
-
ctxt:  the XML parser context
-
len:  pointer to the length of the char read
-
Returns :the current char value and its length
-
xmlCopyCharMultiByte ()
int         xmlCopyCharMultiByte            (xmlChar *out,
-                                             int val);

-append the char value in the array

-
-
out:  pointer to an array of xmlChar
-
val:  the char value
-
Returns :the number of xmlChar written
-
xmlCopyChar ()
int         xmlCopyChar                     (int len,
-                                             xmlChar *out,
-                                             int val);

-append the char value in the array

-
-
len:  Ignored, compatibility
-
out:  pointer to an array of xmlChar
-
val:  the char value
-
Returns :the number of xmlChar written
-
xmlNextChar ()
void        xmlNextChar                     (xmlParserCtxtPtr ctxt);

-Skip to the next char input char.

-
-
ctxt:  the XML parser context
-
xmlParserInputShrink ()
void        xmlParserInputShrink            (xmlParserInputPtr in);

-This function removes used input for the parser.

-
-
in:  an XML parser input
-
htmlInitAutoClose ()
void        htmlInitAutoClose               (void);

-Initialize the htmlStartCloseIndex for fast lookup of closing tags names.
-This is not reentrant. Call xmlInitParser() once before processing in
-case of use in multithreaded programs.

-
-
htmlCreateFileParserCtxt ()
htmlParserCtxtPtr htmlCreateFileParserCtxt  (const char *filename,
-                                             const char *encoding);

-Create a parser context for a file content. 
-Automatic support for ZLIB/Compress compressed document is provided
-by default if found at compile-time.

-
-
filename:  the filename
-
encoding:  a free form C string describing the HTML document encoding, or NULL
-
Returns :the new parser context or NULL
-
xmlEntityReferenceFunc ()
void        (*xmlEntityReferenceFunc)       (xmlEntityPtr ent,
-                                             xmlNodePtr firstNode,
-                                             xmlNodePtr lastNode);

-Callback function used when one needs to be able to track back the
-provenance of a chunk of nodes inherited from an entity replacement.

-
-
ent: the entity
-
firstNode:  the fist node in the chunk
-
lastNode:  the last nod in the chunk
-
xmlSetEntityReferenceFunc ()
void        xmlSetEntityReferenceFunc       (xmlEntityReferenceFunc func);

-Set the function to call call back when a xml reference has been made

-
-
func: A valid function
-
xmlErrMemory ()
void        xmlErrMemory                    (xmlParserCtxtPtr ctxt,
-                                             const char *extra);

-Handle a redefinition of attribute error

-
-
ctxt:  an HTML parser context
-
extra:  extra informations
-
<< HTMLtreeentities >>

+
+
+Module parserInternals from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module parserInternals from libxml2
Main Menu
Related links
Table of Contents
xmlChar *	xmlParseAttValue	(xmlParserCtxtPtr ctxt)

+
xmlParserCtxtPtr	xmlCreateMemoryParserCtxt	(const char * buffer, 
				 int size)

+
void	xmlParseAttributeListDecl	(xmlParserCtxtPtr ctxt)

+
xmlNodePtr	nodePop	(xmlParserCtxtPtr ctxt)

+
int	xmlSkipBlankChars	(xmlParserCtxtPtr ctxt)

+
#define IS_CHAR
+
+
const xmlChar *	xmlParseName	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlParseEncName	(xmlParserCtxtPtr ctxt)

+
int	nodePush	(xmlParserCtxtPtr ctxt, 
				 xmlNodePtr value)

+
int	xmlSwitchEncoding	(xmlParserCtxtPtr ctxt, 
				 xmlCharEncoding enc)

+
void	xmlParseNotationDecl	(xmlParserCtxtPtr ctxt)

+
void	xmlParseExternalSubset	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
#define IS_PUBIDCHAR
+
+
int	xmlSwitchToEncoding	(xmlParserCtxtPtr ctxt, 
				 xmlCharEncodingHandlerPtr handler)

+
void	xmlParseMisc	(xmlParserCtxtPtr ctxt)

+
int	xmlSwitchInputEncoding	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr input, 
				 xmlCharEncodingHandlerPtr handler)

+
#define IS_COMBINING_CH
+
+
xmlParserInputPtr	xmlNewStringInputStream	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * buffer)

+
xmlChar *	xmlParseExternalID	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** publicID, 
				 int strict)

+
xmlEntityPtr	xmlParseEntityRef	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlScanName	(xmlParserCtxtPtr ctxt)

+
int	xmlParseElementDecl	(xmlParserCtxtPtr ctxt)

+
const xmlChar *	xmlParseAttribute	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** value)

+
void	xmlParseEndTag	(xmlParserCtxtPtr ctxt)

+
const xmlChar *	xmlParseEncodingDecl	(xmlParserCtxtPtr ctxt)

+
void	htmlInitAutoClose	(void)

+
#define IS_LETTER
+
+
#define IS_EXTENDER_CH
+
+
htmlParserCtxtPtr	htmlCreateFileParserCtxt	(const char * filename, 
				 const char * encoding)

+
xmlParserCtxtPtr	xmlCreateEntityParserCtxt	(const xmlChar * URL, 
				 const xmlChar * ID, 
				 const xmlChar * base)

+
xmlEnumerationPtr	xmlParseNotationType	(xmlParserCtxtPtr ctxt)

+
int	inputPush	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr value)

+
int	namePush	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * value)

+
xmlChar *	xmlStringLenDecodeEntities	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * str, 
				 int len, 
				 int what, 
				 xmlChar end, 
				 xmlChar end2, 
				 xmlChar end3)

+
xmlParserInputPtr	xmlNewEntityInputStream	(xmlParserCtxtPtr ctxt, 
				 xmlEntityPtr entity)

+
const xmlChar *	namePop	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlSplitQName	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * name, 
				 xmlChar ** prefix)

+
#define MOVETO_ENDTAG
+
+
void	xmlParseContent	(xmlParserCtxtPtr ctxt)

+
Variable const xmlCharxmlStringComment[] xmlStringComment
+
+
#define SKIP_EOL
+
+
void	xmlParseMarkupDecl	(xmlParserCtxtPtr ctxt)

+
xmlParserInputPtr	xmlNewInputStream	(xmlParserCtxtPtr ctxt)

+
void	xmlParserHandleReference	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlNamespaceParseQName	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** prefix)

+
const xmlChar *	xmlParsePITarget	(xmlParserCtxtPtr ctxt)

+
#define IS_LETTER_CH
+
+
int	xmlParseElementContentDecl	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * name, 
				 xmlElementContentPtr * result)

+
#define XML_SUBSTITUTE_NONE
+
+
xmlParserInputPtr	xmlNewInputFromFile	(xmlParserCtxtPtr ctxt, 
				 const char * filename)

+
xmlParserInputPtr	inputPop	(xmlParserCtxtPtr ctxt)

+
void	xmlParserHandlePEReference	(xmlParserCtxtPtr ctxt)

+
xmlChar	xmlPopInput	(xmlParserCtxtPtr ctxt)

+
void	xmlParsePEReference	(xmlParserCtxtPtr ctxt)

+
void	xmlPushInput	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr input)

+
Variable const xmlCharxmlStringTextNoenc[] xmlStringTextNoenc
+
+
xmlChar *	xmlParseEntityValue	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** orig)

+
xmlChar *	xmlStringDecodeEntities	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * str, 
				 int what, 
				 xmlChar end, 
				 xmlChar end2, 
				 xmlChar end3)

+
xmlParserCtxtPtr	xmlCreateFileParserCtxt	(const char * filename)

+
void	xmlParseNamespace	(xmlParserCtxtPtr ctxt)

+
#define XML_SUBSTITUTE_REF
+
+
#define IS_BLANK
+
+
int	xmlParseCharRef	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlParseVersionNum	(xmlParserCtxtPtr ctxt)

+
void	xmlParseElement	(xmlParserCtxtPtr ctxt)

+
#define IS_BYTE_CHAR
+
+
void	xmlParseTextDecl	(xmlParserCtxtPtr ctxt)

+
void	xmlParseXMLDecl	(xmlParserCtxtPtr ctxt)

+
Function type: xmlEntityReferenceFunc
+void	xmlEntityReferenceFunc	(xmlEntityPtr ent, 
				 xmlNodePtr firstNode, 
				 xmlNodePtr lastNode)
+
Callback function used when one needs to be able to track back the provenance of a chunk of nodes inherited from an entity replacement.
ent:the entity
firstNode:the fist node in the chunk
lastNode:the last nod in the chunk


+
Variable unsigned int xmlParserMaxDepth
+
+
xmlElementContentPtr	xmlParseElementMixedContentDecl	(xmlParserCtxtPtr ctxt, 
				 int inputchk)

+
int	xmlCopyCharMultiByte	(xmlChar * out, 
				 int val)

+
xmlElementContentPtr	xmlParseElementChildrenContentDecl	(xmlParserCtxtPtr ctxt, 
				 int inputchk)

+
xmlChar *	xmlParseQuotedString	(xmlParserCtxtPtr ctxt)

+
#define IS_DIGIT_CH
+
+
void	xmlParseCharData	(xmlParserCtxtPtr ctxt, 
				 int cdata)

+
#define IS_EXTENDER
+
+
xmlChar *	xmlNamespaceParseNSDef	(xmlParserCtxtPtr ctxt)

+
void	xmlParseCDSect	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlParseVersionInfo	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlDecodeEntities	(xmlParserCtxtPtr ctxt, 
				 int len, 
				 int what, 
				 xmlChar end, 
				 xmlChar end2, 
				 xmlChar end3)

+
void	xmlParseComment	(xmlParserCtxtPtr ctxt)

+
void	xmlErrMemory	(xmlParserCtxtPtr ctxt, 
				 const char * extra)

+
void	xmlHandleEntity	(xmlParserCtxtPtr ctxt, 
				 xmlEntityPtr entity)

+
int	xmlCurrentChar	(xmlParserCtxtPtr ctxt, 
				 int * len)

+
xmlChar *	xmlNamespaceParseNCName	(xmlParserCtxtPtr ctxt)

+
void	xmlParsePI	(xmlParserCtxtPtr ctxt)

+
xmlChar *	xmlParseNmtoken	(xmlParserCtxtPtr ctxt)

+
#define IS_IDEOGRAPHIC
+
+
#define MOVETO_STARTTAG
+
+
void	xmlParserInputShrink	(xmlParserInputPtr in)

+
void	xmlParseReference	(xmlParserCtxtPtr ctxt)

+
xmlParserCtxtPtr	xmlCreateURLParserCtxt	(const char * filename, 
				 int options)

+
void	xmlSetEntityReferenceFunc	(xmlEntityReferenceFunc func)

+
void	xmlFreeInputStream	(xmlParserInputPtr input)

+
#define IS_DIGIT
+
+
xmlChar *	xmlParsePubidLiteral	(xmlParserCtxtPtr ctxt)

+
Variable const xmlCharxmlStringText[] xmlStringText
+
+
int	xmlStringCurrentChar	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * cur, 
				 int * len)

+
#define XML_SUBSTITUTE_PEREF
+
+
int	xmlParseDefaultDecl	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** value)

+
#define INPUT_CHUNK
+
+
int	xmlIsLetter	(int c)

+
int	xmlCheckLanguageID	(const xmlChar * lang)

+
int	xmlCopyChar	(int len, 
				 xmlChar * out, 
				 int val)

+
void	xmlNextChar	(xmlParserCtxtPtr ctxt)

+
#define IS_BLANK_CH
+
+
const xmlChar *	xmlParseStartTag	(xmlParserCtxtPtr ctxt)

+
xmlEnumerationPtr	xmlParseEnumerationType	(xmlParserCtxtPtr ctxt)

+
int	xmlParseSDDecl	(xmlParserCtxtPtr ctxt)

+
int	xmlParseAttributeType	(xmlParserCtxtPtr ctxt, 
				 xmlEnumerationPtr * tree)

+
xmlChar *	xmlParseSystemLiteral	(xmlParserCtxtPtr ctxt)

+
int	xmlParseEnumeratedType	(xmlParserCtxtPtr ctxt, 
				 xmlEnumerationPtr * tree)

+
#define IS_COMBINING
+
+
#define XML_MAX_NAMELEN
+
+
#define IS_BASECHAR
+
+
void	xmlParseDocTypeDecl	(xmlParserCtxtPtr ctxt)

+
#define XML_SUBSTITUTE_BOTH
+
+
#define IS_PUBIDCHAR_CH
+
+
#define IS_CHAR_CH
+
+
void	xmlParseEntityDecl	(xmlParserCtxtPtr ctxt)

+
Description

+
Function: xmlParseAttValue
xmlChar *	xmlParseAttValue	(xmlParserCtxtPtr ctxt)

+
parse a value for an attribute Note: the parser won't do substitution of entities here, this will be handled later in xmlStringGetNodeList [10] AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" 3.3.3 Attribute-Value Normalization: Before the value of an attribute is passed to the application or checked for validity, the XML processor must normalize it as follows: - a character reference is processed by appending the referenced character to the attribute value - an entity reference is processed by recursively processing the replacement text of the entity - a whitespace character (#x20, #xD, #xA, #x9) is processed by appending #x20 to the normalized value, except that only a single #x20 is appended for a "#xD#xA" sequence that is part of an external parsed entity or the literal entity value of an internal parsed entity - other characters are processed by appending them to the normalized value If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and trailing space (#x20) characters, and by replacing sequences of space (#x20) characters by a single space (#x20) character. All attributes for which no declaration has been read should be treated by a non-validating parser as if declared CDATA.

+
ctxt:an XML parser context
Returns:the AttValue parsed or NULL. The value has to be freed by the caller.
Function: xmlCreateMemoryParserCtxt
xmlParserCtxtPtr	xmlCreateMemoryParserCtxt	(const char * buffer, 
				 int size)

+
Create a parser context for an XML in-memory document.

+
buffer:a pointer to a char array
size:the size of the array
Returns:the new parser context or NULL
Function: xmlParseAttributeListDecl
void	xmlParseAttributeListDecl	(xmlParserCtxtPtr ctxt)

+
: parse the Attribute list def for an element [52] AttlistDecl ::= '<!ATTLIST' S Name AttDef* S? '>' [53] AttDef ::= S Name S AttType S DefaultDecl

+
ctxt:an XML parser context
Function: nodePop
xmlNodePtr	nodePop	(xmlParserCtxtPtr ctxt)

+
Pops the top element node from the node stack

+
ctxt:an XML parser context
Returns:the node just removed
Function: xmlSkipBlankChars
int	xmlSkipBlankChars	(xmlParserCtxtPtr ctxt)

+
skip all blanks character found at that point in the input streams. It pops up finished entities in the process if allowable at that point.

+
ctxt:the XML parser context
Returns:the number of space chars skipped
Macro: IS_CHAR
#define IS_CHAR
Macro to check the following production in the XML spec: [2] Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.

+
Function: xmlParseName
const xmlChar *	xmlParseName	(xmlParserCtxtPtr ctxt)

+
parse an XML name. [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)* [6] Names ::= Name (S Name)*

+
ctxt:an XML parser context
Returns:the Name parsed or NULL
Function: xmlParseEncName
xmlChar *	xmlParseEncName	(xmlParserCtxtPtr ctxt)

+
parse the XML encoding name [81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*

+
ctxt:an XML parser context
Returns:the encoding name value or NULL
Function: nodePush
int	nodePush	(xmlParserCtxtPtr ctxt, 
				 xmlNodePtr value)

+
Pushes a new element node on top of the node stack

+
ctxt:an XML parser context
value:the element node
Returns:0 in case of error, the index in the stack otherwise
Function: xmlSwitchEncoding
int	xmlSwitchEncoding	(xmlParserCtxtPtr ctxt, 
				 xmlCharEncoding enc)

+
change the input functions when discovering the character encoding of a given entity.

+
ctxt:the parser context
enc:the encoding value (number)
Returns:0 in case of success, -1 otherwise
Function: xmlParseNotationDecl
void	xmlParseNotationDecl	(xmlParserCtxtPtr ctxt)

+
parse a notation declaration [82] NotationDecl ::= '<!NOTATION' S Name S (ExternalID | PublicID) S? '>' Hence there is actually 3 choices: 'PUBLIC' S PubidLiteral 'PUBLIC' S PubidLiteral S SystemLiteral and 'SYSTEM' S SystemLiteral See the NOTE on xmlParseExternalID().

+
ctxt:an XML parser context
Function: xmlParseExternalSubset
void	xmlParseExternalSubset	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
parse Markup declarations from an external subset [30] extSubset ::= textDecl? extSubsetDecl [31] extSubsetDecl ::= (markupdecl | conditionalSect | PEReference | S) *

+
ctxt:an XML parser context
ExternalID:the external identifier
SystemID:the system identifier (or URL)
Macro: IS_PUBIDCHAR
#define IS_PUBIDCHAR
Macro to check the following production in the XML spec: [13] PubidChar ::= #x20 | #xD | #xA | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]

+
Function: xmlSwitchToEncoding
int	xmlSwitchToEncoding	(xmlParserCtxtPtr ctxt, 
				 xmlCharEncodingHandlerPtr handler)

+
change the input functions when discovering the character encoding of a given entity.

+
ctxt:the parser context
handler:the encoding handler
Returns:0 in case of success, -1 otherwise
Function: xmlParseMisc
void	xmlParseMisc	(xmlParserCtxtPtr ctxt)

+
parse an XML Misc* optional field. [27] Misc ::= Comment | PI | S

+
ctxt:an XML parser context
Function: xmlSwitchInputEncoding
int	xmlSwitchInputEncoding	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr input, 
				 xmlCharEncodingHandlerPtr handler)

+
change the input functions when discovering the character encoding of a given entity.

+
ctxt:the parser context
input:the input stream
handler:the encoding handler
Returns:0 in case of success, -1 otherwise
Macro: IS_COMBINING_CH
#define IS_COMBINING_CH
Always false (all combining chars > 0xff)

+
Function: xmlNewStringInputStream
xmlParserInputPtr	xmlNewStringInputStream	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * buffer)

+
Create a new input stream based on a memory buffer.

+
ctxt:an XML parser context
buffer:an memory buffer
Returns:the new input stream
Function: xmlParseExternalID
xmlChar *	xmlParseExternalID	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** publicID, 
				 int strict)

+
Parse an External ID or a Public ID NOTE: Productions [75] and [83] interact badly since [75] can generate 'PUBLIC' S PubidLiteral S SystemLiteral [75] ExternalID ::= 'SYSTEM' S SystemLiteral | 'PUBLIC' S PubidLiteral S SystemLiteral [83] PublicID ::= 'PUBLIC' S PubidLiteral

+
ctxt:an XML parser context
publicID:a xmlChar** receiving PubidLiteral
strict:indicate whether we should restrict parsing to only production [75], see NOTE below
Returns:the function returns SystemLiteral and in the second case publicID receives PubidLiteral, is strict is off it is possible to return NULL and have publicID set.
Function: xmlParseEntityRef
xmlEntityPtr	xmlParseEntityRef	(xmlParserCtxtPtr ctxt)

+
parse ENTITY references declarations [68] EntityRef ::= '&' Name ';' [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", the Name given in the entity reference must match that in an entity declaration, except that well-formed documents need not declare any of the following entities: amp, lt, gt, apos, quot. The declaration of a parameter entity must precede any reference to it. Similarly, the declaration of a general entity must precede any reference to it which appears in a default value in an attribute-list declaration. Note that if entities are declared in the external subset or in external parameter entities, a non-validating processor is not obligated to read and process their declarations; for such documents, the rule that an entity must be declared is a well-formedness constraint only if standalone='yes'. [ WFC: Parsed Entity ] An entity reference must not contain the name of an unparsed entity

+
ctxt:an XML parser context
Returns:the xmlEntityPtr if found, or NULL otherwise.
Function: xmlScanName
xmlChar *	xmlScanName	(xmlParserCtxtPtr ctxt)

+
Trickery: parse an XML name but without consuming the input flow Needed for rollback cases. Used only when parsing entities references. TODO: seems deprecated now, only used in the default part of xmlParserHandleReference [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)* [6] Names ::= Name (S Name)*

+
ctxt:an XML parser context
Returns:the Name parsed or NULL
Function: xmlParseElementDecl
int	xmlParseElementDecl	(xmlParserCtxtPtr ctxt)

+
parse an Element declaration. [45] elementdecl ::= '<!ELEMENT' S Name S contentspec S? '>' [ VC: Unique Element Type Declaration ] No element type may be declared more than once

+
ctxt:an XML parser context
Returns:the type of the element, or -1 in case of error
Function: xmlParseAttribute
const xmlChar *	xmlParseAttribute	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** value)

+
parse an attribute [41] Attribute ::= Name Eq AttValue [ WFC: No External Entity References ] Attribute values cannot contain direct or indirect entity references to external entities. [ WFC: No < in Attribute Values ] The replacement text of any entity referred to directly or indirectly in an attribute value (other than "&lt;") must not contain a <. [ VC: Attribute Value Type ] The attribute must have been declared; the value must be of the type declared for it. [25] Eq ::= S? '=' S? With namespace: [NS 11] Attribute ::= QName Eq AttValue Also the case QName == xmlns:??? is handled independently as a namespace definition.

+
ctxt:an XML parser context
value:a xmlChar ** used to store the value of the attribute
Returns:the attribute name, and the value in *value.
Function: xmlParseEndTag
void	xmlParseEndTag	(xmlParserCtxtPtr ctxt)

+
parse an end of tag [42] ETag ::= '</' Name S? '>' With namespace [NS 9] ETag ::= '</' QName S? '>'

+
ctxt:an XML parser context
Function: xmlParseEncodingDecl
const xmlChar *	xmlParseEncodingDecl	(xmlParserCtxtPtr ctxt)

+
parse the XML encoding declaration [80] EncodingDecl ::= S 'encoding' Eq ('"' EncName '"' | "'" EncName "'") this setups the conversion filters.

+
ctxt:an XML parser context
Returns:the encoding value or NULL
Function: htmlInitAutoClose
void	htmlInitAutoClose	(void)

+
Initialize the htmlStartCloseIndex for fast lookup of closing tags names. This is not reentrant. Call xmlInitParser() once before processing in case of use in multithreaded programs.

+
Macro: IS_LETTER
#define IS_LETTER
Macro to check the following production in the XML spec: [84] Letter ::= BaseChar | Ideographic

+
Macro: IS_EXTENDER_CH
#define IS_EXTENDER_CH
Behaves like IS_EXTENDER but with a single-byte argument

+
Function: htmlCreateFileParserCtxt
htmlParserCtxtPtr	htmlCreateFileParserCtxt	(const char * filename, 
				 const char * encoding)

+
Create a parser context for a file content. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

+
filename:the filename
encoding:a free form C string describing the HTML document encoding, or NULL
Returns:the new parser context or NULL
Function: xmlCreateEntityParserCtxt
xmlParserCtxtPtr	xmlCreateEntityParserCtxt	(const xmlChar * URL, 
				 const xmlChar * ID, 
				 const xmlChar * base)

+
Create a parser context for an external entity Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

+
URL:the entity URL
ID:the entity PUBLIC ID
base:a possible base for the target URI
Returns:the new parser context or NULL
Function: xmlParseNotationType
xmlEnumerationPtr	xmlParseNotationType	(xmlParserCtxtPtr ctxt)

+
parse an Notation attribute type. Note: the leading 'NOTATION' S part has already being parsed... [58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')' [ VC: Notation Attributes ] Values of this type must match one of the notation names included in the declaration; all notation names in the declaration must be declared.

+
ctxt:an XML parser context
Returns:the notation attribute tree built while parsing
Function: inputPush
int	inputPush	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr value)

+
Pushes a new parser input on top of the input stack

+
ctxt:an XML parser context
value:the parser input
Returns:0 in case of error, the index in the stack otherwise
Function: namePush
int	namePush	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * value)

+
Pushes a new element name on top of the name stack

+
ctxt:an XML parser context
value:the element name
Returns:-1 in case of error, the index in the stack otherwise
Function: xmlStringLenDecodeEntities
xmlChar *	xmlStringLenDecodeEntities	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * str, 
				 int len, 
				 int what, 
				 xmlChar end, 
				 xmlChar end2, 
				 xmlChar end3)

+
Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'

+
ctxt:the parser context
str:the input string
len:the string length
what:combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
end:an end marker xmlChar, 0 if none
end2:an end marker xmlChar, 0 if none
end3:an end marker xmlChar, 0 if none
Returns:A newly allocated string with the substitution done. The caller must deallocate it !
Function: xmlNewEntityInputStream
xmlParserInputPtr	xmlNewEntityInputStream	(xmlParserCtxtPtr ctxt, 
				 xmlEntityPtr entity)

+
Create a new input stream based on an xmlEntityPtr

+
ctxt:an XML parser context
entity:an Entity pointer
Returns:the new input stream or NULL
Function: namePop
const xmlChar *	namePop	(xmlParserCtxtPtr ctxt)

+
Pops the top element name from the name stack

+
ctxt:an XML parser context
Returns:the name just removed
Function: xmlSplitQName
xmlChar *	xmlSplitQName	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * name, 
				 xmlChar ** prefix)

+
parse an UTF8 encoded XML qualified name string [NS 5] QName ::= (Prefix ':')? LocalPart [NS 6] Prefix ::= NCName [NS 7] LocalPart ::= NCName

+
ctxt:an XML parser context
name:an XML parser context
prefix:a xmlChar **
Returns:the local part, and prefix is updated to get the Prefix if any.
Macro: MOVETO_ENDTAG
#define MOVETO_ENDTAG
Skips to the next '>' char.

+
Function: xmlParseContent
void	xmlParseContent	(xmlParserCtxtPtr ctxt)

+
Parse a content: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

+
ctxt:an XML parser context
Macro: SKIP_EOL
#define SKIP_EOL
Skips the end of line chars.

+
Function: xmlParseMarkupDecl
void	xmlParseMarkupDecl	(xmlParserCtxtPtr ctxt)

+
parse Markup declarations [29] markupdecl ::= elementdecl | AttlistDecl | EntityDecl | NotationDecl | PI | Comment [ VC: Proper Declaration/PE Nesting ] Parameter-entity replacement text must be properly nested with markup declarations. That is to say, if either the first character or the last character of a markup declaration (markupdecl above) is contained in the replacement text for a parameter-entity reference, both must be contained in the same replacement text. [ WFC: PEs in Internal Subset ] In the internal DTD subset, parameter-entity references can occur only where markup declarations can occur, not within markup declarations. (This does not apply to references that occur in external parameter entities or to the external subset.)

+
ctxt:an XML parser context
Function: xmlNewInputStream
xmlParserInputPtr	xmlNewInputStream	(xmlParserCtxtPtr ctxt)

+
Create a new input stream structure

+
ctxt:an XML parser context
Returns:the new input stream or NULL
Function: xmlParserHandleReference
void	xmlParserHandleReference	(xmlParserCtxtPtr ctxt)

+
TODO: Remove, now deprecated ... the test is done directly in the content parsing routines. [67] Reference ::= EntityRef | CharRef [68] EntityRef ::= '&' Name ';' [ WFC: Entity Declared ] the Name given in the entity reference must match that in an entity declaration, except that well-formed documents need not declare any of the following entities: amp, lt, gt, apos, quot. [ WFC: Parsed Entity ] An entity reference must not contain the name of an unparsed entity [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';' A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc

+
ctxt:the parser context
Function: xmlNamespaceParseQName
xmlChar *	xmlNamespaceParseQName	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** prefix)

+
TODO: this seems not in use anymore, the namespace handling is done on top of the SAX interfaces, i.e. not on raw input. parse an XML qualified name [NS 5] QName ::= (Prefix ':')? LocalPart [NS 6] Prefix ::= NCName [NS 7] LocalPart ::= NCName

+
ctxt:an XML parser context
prefix:a xmlChar **
Returns:the local part, and prefix is updated to get the Prefix if any.
Function: xmlParsePITarget
const xmlChar *	xmlParsePITarget	(xmlParserCtxtPtr ctxt)

+
parse the name of a PI [17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))

+
ctxt:an XML parser context
Returns:the PITarget name or NULL
Macro: IS_LETTER_CH
#define IS_LETTER_CH
Macro behaves like IS_LETTER, but only check base chars

+
Function: xmlParseElementContentDecl
int	xmlParseElementContentDecl	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * name, 
				 xmlElementContentPtr * result)

+
parse the declaration for an Element content either Mixed or Children, the cases EMPTY and ANY are handled directly in xmlParseElementDecl [46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children

+
ctxt:an XML parser context
name:the name of the element being defined.
result:the Element Content pointer will be stored here if any
Returns:the type of element content XML_ELEMENT_TYPE_xxx
Macro: XML_SUBSTITUTE_NONE
#define XML_SUBSTITUTE_NONE
If no entities need to be substituted.

+
Function: xmlNewInputFromFile
xmlParserInputPtr	xmlNewInputFromFile	(xmlParserCtxtPtr ctxt, 
				 const char * filename)

+
Create a new input stream based on a file or an URL.

+
ctxt:an XML parser context
filename:the filename to use as entity
Returns:the new input stream or NULL in case of error
Function: inputPop
xmlParserInputPtr	inputPop	(xmlParserCtxtPtr ctxt)

+
Pops the top parser input from the input stack

+
ctxt:an XML parser context
Returns:the input just removed
Function: xmlParserHandlePEReference
void	xmlParserHandlePEReference	(xmlParserCtxtPtr ctxt)

+
[69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled. A PEReference may have been detected in the current input stream the handling is done accordingly to http://www.w3.org/TR/REC-xml#entproc i.e. - Included in literal in entity values - Included as Parameter Entity reference within DTDs

+
ctxt:the parser context
Function: xmlPopInput
xmlChar	xmlPopInput	(xmlParserCtxtPtr ctxt)

+
xmlPopInput: the current input pointed by ctxt->input came to an end pop it and return the next char.

+
ctxt:an XML parser context
Returns:the current xmlChar in the parser context
Function: xmlParsePEReference
void	xmlParsePEReference	(xmlParserCtxtPtr ctxt)

+
parse PEReference declarations The entity content is handled directly by pushing it's content as a new input stream. [69] PEReference ::= '%' Name ';' [ WFC: No Recursion ] A parsed entity must not contain a recursive reference to itself, either directly or indirectly. [ WFC: Entity Declared ] In a document without any DTD, a document with only an internal DTD subset which contains no parameter entity references, or a document with "standalone='yes'", ... ... The declaration of a parameter entity must precede any reference to it... [ VC: Entity Declared ] In a document with an external subset or external parameter entities with "standalone='no'", ... ... The declaration of a parameter entity must precede any reference to it... [ WFC: In DTD ] Parameter-entity references may only appear in the DTD. NOTE: misleading but this is handled.

+
ctxt:an XML parser context
Function: xmlPushInput
void	xmlPushInput	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr input)

+
xmlPushInput: switch to a new input stream which is stacked on top of the previous one(s).

+
ctxt:an XML parser context
input:an XML parser input fragment (entity, XML fragment ...).
Function: xmlParseEntityValue
xmlChar *	xmlParseEntityValue	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** orig)

+
parse a value for ENTITY declarations [9] EntityValue ::= '"' ([^%&"] | PEReference | Reference)* '"' | "'" ([^%&'] | PEReference | Reference)* "'"

+
ctxt:an XML parser context
orig:if non-NULL store a copy of the original entity value
Returns:the EntityValue parsed with reference substituted or NULL
Function: xmlStringDecodeEntities
xmlChar *	xmlStringDecodeEntities	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * str, 
				 int what, 
				 xmlChar end, 
				 xmlChar end2, 
				 xmlChar end3)

+
Takes a entity string content and process to do the adequate substitutions. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'

+
ctxt:the parser context
str:the input string
what:combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
end:an end marker xmlChar, 0 if none
end2:an end marker xmlChar, 0 if none
end3:an end marker xmlChar, 0 if none
Returns:A newly allocated string with the substitution done. The caller must deallocate it !
Function: xmlCreateFileParserCtxt
xmlParserCtxtPtr	xmlCreateFileParserCtxt	(const char * filename)

+
Create a parser context for a file content. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time.

+
filename:the filename
Returns:the new parser context or NULL
Function: xmlParseNamespace
void	xmlParseNamespace	(xmlParserCtxtPtr ctxt)

+
xmlParseNamespace: parse specific PI '<?namespace ...' constructs. This is what the older xml-name Working Draft specified, a bunch of other stuff may still rely on it, so support is still here as if it was declared on the root of the Tree:-( TODO: remove from library To be removed at next drop of binary compatibility

+
ctxt:an XML parser context
Macro: XML_SUBSTITUTE_REF
#define XML_SUBSTITUTE_REF
Whether general entities need to be substituted.

+
Macro: IS_BLANK
#define IS_BLANK
Macro to check the following production in the XML spec: [3] S ::= (#x20 | #x9 | #xD | #xA)+

+
Function: xmlParseCharRef
int	xmlParseCharRef	(xmlParserCtxtPtr ctxt)

+
parse Reference declarations [66] CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';' [ WFC: Legal Character ] Characters referred to using character references must match the production for Char.

+
ctxt:an XML parser context
Returns:the value parsed (as an int), 0 in case of error
Function: xmlParseVersionNum
xmlChar *	xmlParseVersionNum	(xmlParserCtxtPtr ctxt)

+
parse the XML version value. [26] VersionNum ::= ([a-zA-Z0-9_.:] | '-')+

+
ctxt:an XML parser context
Returns:the string giving the XML version number, or NULL
Function: xmlParseElement
void	xmlParseElement	(xmlParserCtxtPtr ctxt)

+
parse an XML element, this is highly recursive [39] element ::= EmptyElemTag | STag content ETag [ WFC: Element Type Match ] The Name in an element's end-tag must match the element type in the start-tag.

+
ctxt:an XML parser context
Macro: IS_BYTE_CHAR
#define IS_BYTE_CHAR
Macro to check the following production in the XML spec: [2] Char ::= #x9 | #xA | #xD | [#x20...] any byte character in the accepted range

+
Function: xmlParseTextDecl
void	xmlParseTextDecl	(xmlParserCtxtPtr ctxt)

+
parse an XML declaration header for external entities [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>' Question: Seems that EncodingDecl is mandatory ? Is that a typo ?

+
ctxt:an XML parser context
Function: xmlParseXMLDecl
void	xmlParseXMLDecl	(xmlParserCtxtPtr ctxt)

+
parse an XML declaration header [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'

+
ctxt:an XML parser context

+      Callback function used when one needs to be able to track back the provenance of a chunk of nodes inherited from an entity replacement.
+      
+      
+      
+      
+    
Function: xmlParseElementMixedContentDecl
xmlElementContentPtr	xmlParseElementMixedContentDecl	(xmlParserCtxtPtr ctxt, 
				 int inputchk)

+
parse the declaration for a Mixed Element content The leading '(' and spaces have been skipped in xmlParseElementContentDecl [51] Mixed ::= '(' S? '#PCDATA' (S? '|' S? Name)* S? ')*' | '(' S? '#PCDATA' S? ')' [ VC: Proper Group/PE Nesting ] applies to [51] too (see [49]) [ VC: No Duplicate Types ] The same name must not appear more than once in a single mixed-content declaration.

+
ctxt:an XML parser context
inputchk:the input used for the current entity, needed for boundary checks
Returns:the list of the xmlElementContentPtr describing the element choices
Function: xmlCopyCharMultiByte
int	xmlCopyCharMultiByte	(xmlChar * out, 
				 int val)

+
append the char value in the array

+
out:pointer to an array of xmlChar
val:the char value
Returns:the number of xmlChar written
Function: xmlParseElementChildrenContentDecl
xmlElementContentPtr	xmlParseElementChildrenContentDecl	(xmlParserCtxtPtr ctxt, 
				 int inputchk)

+
parse the declaration for a Mixed Element content The leading '(' and spaces have been skipped in xmlParseElementContentDecl [47] children ::= (choice | seq) ('?' | '*' | '+')? [48] cp ::= (Name | choice | seq) ('?' | '*' | '+')? [49] choice ::= '(' S? cp ( S? '|' S? cp )* S? ')' [50] seq ::= '(' S? cp ( S? ',' S? cp )* S? ')' [ VC: Proper Group/PE Nesting ] applies to [49] and [50] TODO Parameter-entity replacement text must be properly nested with parenthesized groups. That is to say, if either of the opening or closing parentheses in a choice, seq, or Mixed construct is contained in the replacement text for a parameter entity, both must be contained in the same replacement text. For interoperability, if a parameter-entity reference appears in a choice, seq, or Mixed construct, its replacement text should not be empty, and neither the first nor last non-blank character of the replacement text should be a connector (| or ,).

+
ctxt:an XML parser context
inputchk:the input used for the current entity, needed for boundary checks
Returns:the tree of xmlElementContentPtr describing the element hierarchy.
Function: xmlParseQuotedString
xmlChar *	xmlParseQuotedString	(xmlParserCtxtPtr ctxt)

+
Parse and return a string between quotes or doublequotes TODO: Deprecated, to be removed at next drop of binary compatibility

+
ctxt:an XML parser context
Returns:the string parser or NULL.
Macro: IS_DIGIT_CH
#define IS_DIGIT_CH
Behaves like IS_DIGIT but with a single byte argument

+
Function: xmlParseCharData
void	xmlParseCharData	(xmlParserCtxtPtr ctxt, 
				 int cdata)

+
parse a CharData section. if we are within a CDATA section ']]>' marks an end of section. The right angle bracket (>) may be represented using the string "&gt;", and must, for compatibility, be escaped using "&gt;" or a character reference when it appears in the string "]]>" in content, when that string is not marking the end of a CDATA section. [14] CharData ::= [^<&]* - ([^<&]* ']]>' [^<

+
ctxt:an XML parser context
cdata:int indicating whether we are within a CDATA section
Macro: IS_EXTENDER
#define IS_EXTENDER
Macro to check the following production in the XML spec: [89] Extender ::= #x00B7 | #x02D0 | #x02D1 | #x0387 | #x0640 | #x0E46 | #x0EC6 | #x3005 | [#x3031-#x3035] | [#x309D-#x309E] | [#x30FC-#x30FE]

+
Function: xmlNamespaceParseNSDef
xmlChar *	xmlNamespaceParseNSDef	(xmlParserCtxtPtr ctxt)

+
parse a namespace prefix declaration TODO: this seems not in use anymore, the namespace handling is done on top of the SAX interfaces, i.e. not on raw input. [NS 1] NSDef ::= PrefixDef Eq SystemLiteral [NS 2] PrefixDef ::= 'xmlns' (':' NCName)?

+
ctxt:an XML parser context
Returns:the namespace name
Function: xmlParseCDSect
void	xmlParseCDSect	(xmlParserCtxtPtr ctxt)

+
Parse escaped pure raw content. [18] CDSect ::= CDStart CData CDEnd [19] CDStart ::= '<![CDATA[' [20] Data ::= (Char* - (Char* ']]>' Char*)) [21] CDEnd ::= ']]>'

+
ctxt:an XML parser context
Function: xmlParseVersionInfo
xmlChar *	xmlParseVersionInfo	(xmlParserCtxtPtr ctxt)

+
parse the XML version. [24] VersionInfo ::= S 'version' Eq (' VersionNum ' | " VersionNum ") [25] Eq ::= S? '=' S?

+
ctxt:an XML parser context
Returns:the version string, e.g. "1.0"
Function: xmlDecodeEntities
xmlChar *	xmlDecodeEntities	(xmlParserCtxtPtr ctxt, 
				 int len, 
				 int what, 
				 xmlChar end, 
				 xmlChar end2, 
				 xmlChar end3)

+
This function is deprecated, we now always process entities content through xmlStringDecodeEntities TODO: remove it in next major release. [67] Reference ::= EntityRef | CharRef [69] PEReference ::= '%' Name ';'

+
ctxt:the parser context
len:the len to decode (in bytes !), -1 for no size limit
what:combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
end:an end marker xmlChar, 0 if none
end2:an end marker xmlChar, 0 if none
end3:an end marker xmlChar, 0 if none
Returns:A newly allocated string with the substitution done. The caller must deallocate it !
Function: xmlParseComment
void	xmlParseComment	(xmlParserCtxtPtr ctxt)

+
Skip an XML (SGML) comment <!-- .... --> The spec says that "For compatibility, the string "--" (double-hyphen) must not occur within comments. " [15] Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'

+
ctxt:an XML parser context
Function: xmlErrMemory
void	xmlErrMemory	(xmlParserCtxtPtr ctxt, 
				 const char * extra)

+
Handle a redefinition of attribute error

+
ctxt:an XML parser context
extra:extra informations
Function: xmlHandleEntity
void	xmlHandleEntity	(xmlParserCtxtPtr ctxt, 
				 xmlEntityPtr entity)

+
Default handling of defined entities, when should we define a new input stream ? When do we just handle that as a set of chars ? OBSOLETE: to be removed at some point.

+
ctxt:an XML parser context
entity:an XML entity pointer.
Function: xmlCurrentChar
int	xmlCurrentChar	(xmlParserCtxtPtr ctxt, 
				 int * len)

+
The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer. Implement the end of line normalization: 2.11 End-of-Line Handling Wherever an external parsed entity or the literal entity value of an internal parsed entity contains either the literal two-character sequence "#xD#xA" or a standalone literal #xD, an XML processor must pass to the application the single character #xA. This behavior can conveniently be produced by normalizing all line breaks to #xA on input, before parsing.)

+
ctxt:the XML parser context
len:pointer to the length of the char read
Returns:the current char value and its length
Function: xmlNamespaceParseNCName
xmlChar *	xmlNamespaceParseNCName	(xmlParserCtxtPtr ctxt)

+
parse an XML namespace name. TODO: this seems not in use anymore, the namespace handling is done on top of the SAX interfaces, i.e. not on raw input. [NS 3] NCName ::= (Letter | '_') (NCNameChar)* [NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' | CombiningChar | Extender

+
ctxt:an XML parser context
Returns:the namespace name or NULL
Function: xmlParsePI
void	xmlParsePI	(xmlParserCtxtPtr ctxt)

+
parse an XML Processing Instruction. [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>' The processing is transfered to SAX once parsed.

+
ctxt:an XML parser context
Function: xmlParseNmtoken
xmlChar *	xmlParseNmtoken	(xmlParserCtxtPtr ctxt)

+
parse an XML Nmtoken. [7] Nmtoken ::= (NameChar)+ [8] Nmtokens ::= Nmtoken (S Nmtoken)*

+
ctxt:an XML parser context
Returns:the Nmtoken parsed or NULL
Macro: IS_IDEOGRAPHIC
#define IS_IDEOGRAPHIC
Macro to check the following production in the XML spec: [86] Ideographic ::= [#x4E00-#x9FA5] | #x3007 | [#x3021-#x3029]

+
Macro: MOVETO_STARTTAG
#define MOVETO_STARTTAG
Skips to the next '<' char.

+
Function: xmlParserInputShrink
void	xmlParserInputShrink	(xmlParserInputPtr in)

+
This function removes used input for the parser.

+
in:an XML parser input
Function: xmlParseReference
void	xmlParseReference	(xmlParserCtxtPtr ctxt)

+
parse and handle entity references in content, depending on the SAX interface, this may end-up in a call to character() if this is a CharRef, a predefined entity, if there is no reference() callback. or if the parser was asked to switch to that mode. [67] Reference ::= EntityRef | CharRef

+
ctxt:an XML parser context
Function: xmlCreateURLParserCtxt
xmlParserCtxtPtr	xmlCreateURLParserCtxt	(const char * filename, 
				 int options)

+
Create a parser context for a file or URL content. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time and for file accesses

+
filename:the filename or URL
options:a combination of xmlParserOption(s)
Returns:the new parser context or NULL
Function: xmlSetEntityReferenceFunc
void	xmlSetEntityReferenceFunc	(xmlEntityReferenceFunc func)

+
Set the function to call call back when a xml reference has been made

+
func:A valid function
Function: xmlFreeInputStream
void	xmlFreeInputStream	(xmlParserInputPtr input)

+
Free up an input stream.

+
input:an xmlParserInputPtr
Macro: IS_DIGIT
#define IS_DIGIT
Macro to check the following production in the XML spec: [88] Digit ::= ... long list see REC ...

+
Function: xmlParsePubidLiteral
xmlChar *	xmlParsePubidLiteral	(xmlParserCtxtPtr ctxt)

+
parse an XML public literal [12] PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"

+
ctxt:an XML parser context
Returns:the PubidLiteral parsed or NULL.
Function: xmlStringCurrentChar
int	xmlStringCurrentChar	(xmlParserCtxtPtr ctxt, 
				 const xmlChar * cur, 
				 int * len)

+
The current char value, if using UTF-8 this may actually span multiple bytes in the input buffer.

+
ctxt:the XML parser context
cur:pointer to the beginning of the char
len:pointer to the length of the char read
Returns:the current char value and its length
Macro: XML_SUBSTITUTE_PEREF
#define XML_SUBSTITUTE_PEREF
Whether parameter entities need to be substituted.

+
Function: xmlParseDefaultDecl
int	xmlParseDefaultDecl	(xmlParserCtxtPtr ctxt, 
				 xmlChar ** value)

+
Parse an attribute default declaration [60] DefaultDecl ::= '#REQUIRED' | '#IMPLIED' | (('#FIXED' S)? AttValue) [ VC: Required Attribute ] if the default declaration is the keyword #REQUIRED, then the attribute must be specified for all elements of the type in the attribute-list declaration. [ VC: Attribute Default Legal ] The declared default value must meet the lexical constraints of the declared attribute type c.f. xmlValidateAttributeDecl() [ VC: Fixed Attribute Default ] if an attribute has a default value declared with the #FIXED keyword, instances of that attribute must match the default value. [ WFC: No < in Attribute Values ] handled in xmlParseAttValue()

+
ctxt:an XML parser context
value:Receive a possible fixed default value for the attribute
Returns:XML_ATTRIBUTE_NONE, XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_IMPLIED or XML_ATTRIBUTE_FIXED.
Macro: INPUT_CHUNK
#define INPUT_CHUNK
The parser tries to always have that amount of input ready. One of the point is providing context when reporting errors.

+
Function: xmlIsLetter
int	xmlIsLetter	(int c)

+
Check whether the character is allowed by the production [84] Letter ::= BaseChar | Ideographic

+
c:an unicode character (int)
Returns:0 if not, non-zero otherwise
Function: xmlCheckLanguageID
int	xmlCheckLanguageID	(const xmlChar * lang)

+
Checks that the value conforms to the LanguageID production: NOTE: this is somewhat deprecated, those productions were removed from the XML Second edition. [33] LanguageID ::= Langcode ('-' Subcode)* [34] Langcode ::= ISO639Code | IanaCode | UserCode [35] ISO639Code ::= ([a-z] | [A-Z]) ([a-z] | [A-Z]) [36] IanaCode ::= ('i' | 'I') '-' ([a-z] | [A-Z])+ [37] UserCode ::= ('x' | 'X') '-' ([a-z] | [A-Z])+ [38] Subcode ::= ([a-z] | [A-Z])+

+
lang:pointer to the string value
Returns:1 if correct 0 otherwise
Function: xmlCopyChar
int	xmlCopyChar	(int len, 
				 xmlChar * out, 
				 int val)

+
append the char value in the array

+
len:Ignored, compatibility
out:pointer to an array of xmlChar
val:the char value
Returns:the number of xmlChar written
Function: xmlNextChar
void	xmlNextChar	(xmlParserCtxtPtr ctxt)

+
Skip to the next char input char.

+
ctxt:the XML parser context
Macro: IS_BLANK_CH
#define IS_BLANK_CH
Behaviour same as IS_BLANK

+
Function: xmlParseStartTag
const xmlChar *	xmlParseStartTag	(xmlParserCtxtPtr ctxt)

+
parse a start of tag either for rule element or EmptyElement. In both case we don't parse the tag closing chars. [40] STag ::= '<' Name (S Attribute)* S? '>' [ WFC: Unique Att Spec ] No attribute name may appear more than once in the same start-tag or empty-element tag. [44] EmptyElemTag ::= '<' Name (S Attribute)* S? '/>' [ WFC: Unique Att Spec ] No attribute name may appear more than once in the same start-tag or empty-element tag. With namespace: [NS 8] STag ::= '<' QName (S Attribute)* S? '>' [NS 10] EmptyElement ::= '<' QName (S Attribute)* S? '/>'

+
ctxt:an XML parser context
Returns:the element name parsed
Function: xmlParseEnumerationType
xmlEnumerationPtr	xmlParseEnumerationType	(xmlParserCtxtPtr ctxt)

+
parse an Enumeration attribute type. [59] Enumeration ::= '(' S? Nmtoken (S? '|' S? Nmtoken)* S? ')' [ VC: Enumeration ] Values of this type must match one of the Nmtoken tokens in the declaration

+
ctxt:an XML parser context
Returns:the enumeration attribute tree built while parsing
Function: xmlParseSDDecl
int	xmlParseSDDecl	(xmlParserCtxtPtr ctxt)

+
parse the XML standalone declaration [32] SDDecl ::= S 'standalone' Eq (("'" ('yes' | 'no') "'") | ('"' ('yes' | 'no')'"')) [ VC: Standalone Document Declaration ] TODO The standalone document declaration must have the value "no" if any external markup declarations contain declarations of: - attributes with default values, if elements to which these attributes apply appear in the document without specifications of values for these attributes, or - entities (other than amp, lt, gt, apos, quot), if references to those entities appear in the document, or - attributes with values subject to normalization, where the attribute appears in the document with a value which will change as a result of normalization, or - element types with element content, if white space occurs directly within any instance of those types.

+
ctxt:an XML parser context
Returns:1 if standalone, 0 otherwise
Function: xmlParseAttributeType
int	xmlParseAttributeType	(xmlParserCtxtPtr ctxt, 
				 xmlEnumerationPtr * tree)

+
parse the Attribute list def for an element [54] AttType ::= StringType | TokenizedType | EnumeratedType [55] StringType ::= 'CDATA' [56] TokenizedType ::= 'ID' | 'IDREF' | 'IDREFS' | 'ENTITY' | 'ENTITIES' | 'NMTOKEN' | 'NMTOKENS' Validity constraints for attribute values syntax are checked in xmlValidateAttributeValue() [ VC: ID ] Values of type ID must match the Name production. A name must not appear more than once in an XML document as a value of this type; i.e., ID values must uniquely identify the elements which bear them. [ VC: One ID per Element Type ] No element type may have more than one ID attribute specified. [ VC: ID Attribute Default ] An ID attribute must have a declared default of #IMPLIED or #REQUIRED. [ VC: IDREF ] Values of type IDREF must match the Name production, and values of type IDREFS must match Names; each IDREF Name must match the value of an ID attribute on some element in the XML document; i.e. IDREF values must match the value of some ID attribute. [ VC: Entity Name ] Values of type ENTITY must match the Name production, values of type ENTITIES must match Names; each Entity Name must match the name of an unparsed entity declared in the DTD. [ VC: Name Token ] Values of type NMTOKEN must match the Nmtoken production; values of type NMTOKENS must match Nmtokens.

+
ctxt:an XML parser context
tree:the enumeration tree built while parsing
Returns:the attribute type
Function: xmlParseSystemLiteral
xmlChar *	xmlParseSystemLiteral	(xmlParserCtxtPtr ctxt)

+
parse an XML Literal [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")

+
ctxt:an XML parser context
Returns:the SystemLiteral parsed or NULL
Function: xmlParseEnumeratedType
int	xmlParseEnumeratedType	(xmlParserCtxtPtr ctxt, 
				 xmlEnumerationPtr * tree)

+
parse an Enumerated attribute type. [57] EnumeratedType ::= NotationType | Enumeration [58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'

+
ctxt:an XML parser context
tree:the enumeration tree built while parsing
Returns:XML_ATTRIBUTE_ENUMERATION or XML_ATTRIBUTE_NOTATION
Macro: IS_COMBINING
#define IS_COMBINING
Macro to check the following production in the XML spec: [87] CombiningChar ::= ... long list see REC ...

+
Macro: XML_MAX_NAMELEN
#define XML_MAX_NAMELEN
Identifiers can be longer, but this will be more costly at runtime.

+
Macro: IS_BASECHAR
#define IS_BASECHAR
Macro to check the following production in the XML spec: [85] BaseChar ::= ... long list see REC ...

+
Function: xmlParseDocTypeDecl
void	xmlParseDocTypeDecl	(xmlParserCtxtPtr ctxt)

+
parse a DOCTYPE declaration [28] doctypedecl ::= '<!DOCTYPE' S Name (S ExternalID)? S? ('[' (markupdecl | PEReference | S)* ']' S?)? '>' [ VC: Root Element Type ] The Name in the document type declaration must match the element type of the root element.

+
ctxt:an XML parser context
Macro: XML_SUBSTITUTE_BOTH
#define XML_SUBSTITUTE_BOTH
Both general and parameter entities need to be substituted.

+
Macro: IS_PUBIDCHAR_CH
#define IS_PUBIDCHAR_CH
Same as IS_PUBIDCHAR but for single-byte value

+
Macro: IS_CHAR_CH
#define IS_CHAR_CH
Behaves like IS_CHAR on single-byte value

+
Function: xmlParseEntityDecl
void	xmlParseEntityDecl	(xmlParserCtxtPtr ctxt)

+
parse <!ENTITY declarations [70] EntityDecl ::= GEDecl | PEDecl [71] GEDecl ::= '<!ENTITY' S Name S EntityDef S? '>' [72] PEDecl ::= '<!ENTITY' S '%' S Name S PEDef S? '>' [73] EntityDef ::= EntityValue | (ExternalID NDataDecl?) [74] PEDef ::= EntityValue | ExternalID [76] NDataDecl ::= S 'NDATA' S Name [ VC: Notation Declared ] The Name must match the declared name of a notation.

+
ctxt:an XML parser context
Daniel Veillard

diff --git a/doc/html/libxml-relaxng.html b/doc/html/libxml-relaxng.html
index e6a7f254..ffde9126 100644
--- a/doc/html/libxml-relaxng.html
+++ b/doc/html/libxml-relaxng.html
@@ -1,331 +1,144 @@
-relaxng
PrevUpHomeGnome XML Library Reference ManualNext
relaxng
relaxng — 
Synopsis
+
+
+Module relaxng from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module relaxng from libxml2
Main Menu
Related links
Table of Contents
void	xmlRelaxNGFreeValidCtxt	(xmlRelaxNGValidCtxtPtr ctxt)

+
void	xmlRelaxNGSetValidErrors	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc err, 
				 xmlRelaxNGValidityWarningFunc warn, 
				 void * ctx)

+
void	xmlRelaxNGSetParserErrors	(xmlRelaxNGParserCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc err, 
				 xmlRelaxNGValidityWarningFunc warn, 
				 void * ctx)

+
xmlRelaxNGParserCtxtPtr	xmlRelaxNGNewMemParserCtxt	(const char * buffer, 
				 int size)

+
int	xmlRelaxNGValidatePopElement	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
xmlRelaxNGValidCtxtPtr	xmlRelaxNGNewValidCtxt	(xmlRelaxNGPtr schema)

+
Typedef xmlRelaxNGValidCtxt * xmlRelaxNGValidCtxtPtr
 
+
void	xmlRelaxNGDump	(FILE * output, 
				 xmlRelaxNGPtr schema)

+
Typedef xmlRelaxNGParserCtxt * xmlRelaxNGParserCtxtPtr
 
+
Structure xmlRelaxNG
struct _xmlRelaxNG {
+The content of this structure is not made public by the API.
+}

Structure xmlRelaxNGParserCtxt
struct _xmlRelaxNGParserCtxt {
+The content of this structure is not made public by the API.
+}

int	xmlRelaxNGValidateDoc	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
xmlRelaxNGPtr	xmlRelaxNGParse	(xmlRelaxNGParserCtxtPtr ctxt)

+
Structure xmlRelaxNGValidCtxt
struct _xmlRelaxNGValidCtxt {
+The content of this structure is not made public by the API.
+}

int	xmlRelaxNGValidatePushElement	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
int	xmlRelaxNGValidateFullElement	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
xmlRelaxNGParserCtxtPtr	xmlRelaxNGNewParserCtxt	(const char * URL)

+
Function type: xmlRelaxNGValidityErrorFunc
+void	xmlRelaxNGValidityErrorFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
ctx:
msg:
...:


+
void	xmlRelaxNGFree	(xmlRelaxNGPtr schema)

+
void	xmlRelaxNGFreeParserCtxt	(xmlRelaxNGParserCtxtPtr ctxt)

+
xmlRelaxNGParserCtxtPtr	xmlRelaxNGNewDocParserCtxt	(xmlDocPtr doc)

+
int	xmlRelaxNGGetValidErrors	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc * err, 
				 xmlRelaxNGValidityWarningFunc * warn, 
				 void ** ctx)

+
void	xmlRelaxNGCleanupTypes	(void)

+
Typedef xmlRelaxNG * xmlRelaxNGPtr
 
-struct      xmlRelaxNG;
-typedef     xmlRelaxNGPtr;
-void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        (*xmlRelaxNGValidityWarningFunc)
-                                            (void *ctx,
-                                             const char *msg,
-                                             ...);
-struct      xmlRelaxNGParserCtxt;
-typedef     xmlRelaxNGParserCtxtPtr;
-struct      xmlRelaxNGValidCtxt;
-typedef     xmlRelaxNGValidCtxtPtr;
-enum        xmlRelaxNGValidErr;
-xmlRelaxNGParserCtxtPtr xmlRelaxNGNewParserCtxt
-                                            (const char *URL);
-xmlRelaxNGParserCtxtPtr xmlRelaxNGNewMemParserCtxt
-                                            (const char *buffer,
-                                             int size);
-xmlRelaxNGParserCtxtPtr xmlRelaxNGNewDocParserCtxt
-                                            (xmlDocPtr doc);
-void        xmlRelaxNGFreeParserCtxt        (xmlRelaxNGParserCtxtPtr ctxt);
-void        xmlRelaxNGSetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc err,
-                                             xmlRelaxNGValidityWarningFunc warn,
-                                             void *ctx);
-int         xmlRelaxNGGetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc *err,
-                                             xmlRelaxNGValidityWarningFunc *warn,
-                                             void **ctx);
-xmlRelaxNGPtr xmlRelaxNGParse               (xmlRelaxNGParserCtxtPtr ctxt);
-void        xmlRelaxNGFree                  (xmlRelaxNGPtr schema);
-void        xmlRelaxNGDump                  (FILE *output,
-                                             xmlRelaxNGPtr schema);
-void        xmlRelaxNGDumpTree              (FILE *output,
-                                             xmlRelaxNGPtr schema);
-void        xmlRelaxNGSetValidErrors        (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc err,
-                                             xmlRelaxNGValidityWarningFunc warn,
-                                             void *ctx);
-int         xmlRelaxNGGetValidErrors        (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc *err,
-                                             xmlRelaxNGValidityWarningFunc *warn,
-                                             void **ctx);
-xmlRelaxNGValidCtxtPtr xmlRelaxNGNewValidCtxt
-                                            (xmlRelaxNGPtr schema);
-void        xmlRelaxNGFreeValidCtxt         (xmlRelaxNGValidCtxtPtr ctxt);
-int         xmlRelaxNGValidateDoc           (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-void        xmlRelaxNGCleanupTypes          (void);
-int         xmlRelaxNGValidatePushElement   (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);
-int         xmlRelaxNGValidatePushCData     (xmlRelaxNGValidCtxtPtr ctxt,
-                                             const xmlChar *data,
-                                             int len);
-int         xmlRelaxNGValidatePopElement    (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);
-int         xmlRelaxNGValidateFullElement   (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);
-
Description

+
Enum xmlRelaxNGValidErr {
+    XML_RELAXNG_OK = 0
+    XML_RELAXNG_ERR_MEMORY = 1
+    XML_RELAXNG_ERR_TYPE = 2
+    XML_RELAXNG_ERR_TYPEVAL = 3
+    XML_RELAXNG_ERR_DUPID = 4
+    XML_RELAXNG_ERR_TYPECMP = 5
+    XML_RELAXNG_ERR_NOSTATE = 6
+    XML_RELAXNG_ERR_NODEFINE = 7
+    XML_RELAXNG_ERR_LISTEXTRA = 8
+    XML_RELAXNG_ERR_LISTEMPTY = 9
+    XML_RELAXNG_ERR_INTERNODATA = 10
+    XML_RELAXNG_ERR_INTERSEQ = 11
+    XML_RELAXNG_ERR_INTEREXTRA = 12
+    XML_RELAXNG_ERR_ELEMNAME = 13
+    XML_RELAXNG_ERR_ATTRNAME = 14
+    XML_RELAXNG_ERR_ELEMNONS = 15
+    XML_RELAXNG_ERR_ATTRNONS = 16
+    XML_RELAXNG_ERR_ELEMWRONGNS = 17
+    XML_RELAXNG_ERR_ATTRWRONGNS = 18
+    XML_RELAXNG_ERR_ELEMEXTRANS = 19
+    XML_RELAXNG_ERR_ATTREXTRANS = 20
+    XML_RELAXNG_ERR_ELEMNOTEMPTY = 21
+    XML_RELAXNG_ERR_NOELEM = 22
+    XML_RELAXNG_ERR_NOTELEM = 23
+    XML_RELAXNG_ERR_ATTRVALID = 24
+    XML_RELAXNG_ERR_CONTENTVALID = 25
+    XML_RELAXNG_ERR_EXTRACONTENT = 26
+    XML_RELAXNG_ERR_INVALIDATTR = 27
+    XML_RELAXNG_ERR_DATAELEM = 28
+    XML_RELAXNG_ERR_VALELEM = 29
+    XML_RELAXNG_ERR_LISTELEM = 30
+    XML_RELAXNG_ERR_DATATYPE = 31
+    XML_RELAXNG_ERR_VALUE = 32
+    XML_RELAXNG_ERR_LIST = 33
+    XML_RELAXNG_ERR_NOGRAMMAR = 34
+    XML_RELAXNG_ERR_EXTRADATA = 35
+    XML_RELAXNG_ERR_LACKDATA = 36
+    XML_RELAXNG_ERR_INTERNAL = 37
+    XML_RELAXNG_ERR_ELEMWRONG = 38
+    XML_RELAXNG_ERR_TEXTWRONG = 39
+}
 
-
Details
struct xmlRelaxNG
struct xmlRelaxNG;

-
-
xmlRelaxNGPtr
typedef xmlRelaxNG *xmlRelaxNGPtr;
-

-
-
xmlRelaxNGValidityErrorFunc ()
void        (*xmlRelaxNGValidityErrorFunc)  (void *ctx,
-                                             const char *msg,
-                                             ...);

-
-
ctx:
-
msg:
-
...:
-
-
-
xmlRelaxNGValidityWarningFunc ()
void        (*xmlRelaxNGValidityWarningFunc)
-                                            (void *ctx,
-                                             const char *msg,
-                                             ...);

-
-
ctx:
-
msg:
-
...:
-
-
-
struct xmlRelaxNGParserCtxt
struct xmlRelaxNGParserCtxt;

-
-
xmlRelaxNGParserCtxtPtr
typedef xmlRelaxNGParserCtxt *xmlRelaxNGParserCtxtPtr;
-

-
-
struct xmlRelaxNGValidCtxt
struct xmlRelaxNGValidCtxt;

-A RelaxNGs validation context

-
-
xmlRelaxNGValidCtxtPtr
typedef xmlRelaxNGValidCtxt *xmlRelaxNGValidCtxtPtr;
-

-
-
enum xmlRelaxNGValidErr
typedef enum {
-    XML_RELAXNG_OK = 0,
-    XML_RELAXNG_ERR_MEMORY,
-    XML_RELAXNG_ERR_TYPE,
-    XML_RELAXNG_ERR_TYPEVAL,
-    XML_RELAXNG_ERR_DUPID,
-    XML_RELAXNG_ERR_TYPECMP,
-    XML_RELAXNG_ERR_NOSTATE,
-    XML_RELAXNG_ERR_NODEFINE,
-    XML_RELAXNG_ERR_LISTEXTRA,
-    XML_RELAXNG_ERR_LISTEMPTY,
-    XML_RELAXNG_ERR_INTERNODATA,
-    XML_RELAXNG_ERR_INTERSEQ,
-    XML_RELAXNG_ERR_INTEREXTRA,
-    XML_RELAXNG_ERR_ELEMNAME,
-    XML_RELAXNG_ERR_ATTRNAME,
-    XML_RELAXNG_ERR_ELEMNONS,
-    XML_RELAXNG_ERR_ATTRNONS,
-    XML_RELAXNG_ERR_ELEMWRONGNS,
-    XML_RELAXNG_ERR_ATTRWRONGNS,
-    XML_RELAXNG_ERR_ELEMEXTRANS,
-    XML_RELAXNG_ERR_ATTREXTRANS,
-    XML_RELAXNG_ERR_ELEMNOTEMPTY,
-    XML_RELAXNG_ERR_NOELEM,
-    XML_RELAXNG_ERR_NOTELEM,
-    XML_RELAXNG_ERR_ATTRVALID,
-    XML_RELAXNG_ERR_CONTENTVALID,
-    XML_RELAXNG_ERR_EXTRACONTENT,
-    XML_RELAXNG_ERR_INVALIDATTR,
-    XML_RELAXNG_ERR_DATAELEM,
-    XML_RELAXNG_ERR_VALELEM,
-    XML_RELAXNG_ERR_LISTELEM,
-    XML_RELAXNG_ERR_DATATYPE,
-    XML_RELAXNG_ERR_VALUE,
-    XML_RELAXNG_ERR_LIST,
-    XML_RELAXNG_ERR_NOGRAMMAR,
-    XML_RELAXNG_ERR_EXTRADATA,
-    XML_RELAXNG_ERR_LACKDATA,
-    XML_RELAXNG_ERR_INTERNAL,
-    XML_RELAXNG_ERR_ELEMWRONG,
-    XML_RELAXNG_ERR_TEXTWRONG
-} xmlRelaxNGValidErr;
-

-
-
xmlRelaxNGNewParserCtxt ()
xmlRelaxNGParserCtxtPtr xmlRelaxNGNewParserCtxt
-                                            (const char *URL);

-Create an XML RelaxNGs parse context for that file/resource expected
-to contain an XML RelaxNGs file.

-
-
URL:  the location of the schema
-
Returns :the parser context or NULL in case of error
-
xmlRelaxNGNewMemParserCtxt ()
xmlRelaxNGParserCtxtPtr xmlRelaxNGNewMemParserCtxt
-                                            (const char *buffer,
-                                             int size);

-Create an XML RelaxNGs parse context for that memory buffer expected
-to contain an XML RelaxNGs file.

-
-
buffer:  a pointer to a char array containing the schemas
-
size:  the size of the array
-
Returns :the parser context or NULL in case of error
-
xmlRelaxNGNewDocParserCtxt ()
xmlRelaxNGParserCtxtPtr xmlRelaxNGNewDocParserCtxt
-                                            (xmlDocPtr doc);

-Create an XML RelaxNGs parser context for that document.
-Note: since the process of compiling a RelaxNG schemas modifies the
-      document, the doc parameter is duplicated internally.

-
-
doc:  a preparsed document tree
-
Returns :the parser context or NULL in case of error
-
xmlRelaxNGFreeParserCtxt ()
void        xmlRelaxNGFreeParserCtxt        (xmlRelaxNGParserCtxtPtr ctxt);

-Free the resources associated to the schema parser context

-
-
ctxt:  the schema parser context
-
xmlRelaxNGSetParserErrors ()
void        xmlRelaxNGSetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc err,
-                                             xmlRelaxNGValidityWarningFunc warn,
-                                             void *ctx);

-Set the callback functions used to handle errors for a validation context

-
-
ctxt:  a Relax-NG validation context
-
err:  the error callback
-
warn:  the warning callback
-
ctx:  contextual data for the callbacks
-
xmlRelaxNGGetParserErrors ()
int         xmlRelaxNGGetParserErrors       (xmlRelaxNGParserCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc *err,
-                                             xmlRelaxNGValidityWarningFunc *warn,
-                                             void **ctx);

-Get the callback information used to handle errors for a validation context

-
-
ctxt:  a Relax-NG validation context
-
err:  the error callback result
-
warn:  the warning callback result
-
ctx:  contextual data for the callbacks result
-
Returns :-1 in case of failure, 0 otherwise.
-
xmlRelaxNGParse ()
xmlRelaxNGPtr xmlRelaxNGParse               (xmlRelaxNGParserCtxtPtr ctxt);

-parse a schema definition resource and build an internal
-XML Shema struture which can be used to validate instances.
-*WARNING* this interface is highly subject to change

-
-
ctxt:  a Relax-NG parser context
-
Returns :the internal XML RelaxNG structure built from the resource or
-        NULL in case of error
-
xmlRelaxNGFree ()
void        xmlRelaxNGFree                  (xmlRelaxNGPtr schema);

-Deallocate a RelaxNG structure.

-
-
schema:  a schema structure
-
xmlRelaxNGDump ()
void        xmlRelaxNGDump                  (FILE *output,
-                                             xmlRelaxNGPtr schema);

-Dump a RelaxNG structure back

-
-
output:  the file output
-
schema:  a schema structure
-
xmlRelaxNGDumpTree ()
void        xmlRelaxNGDumpTree              (FILE *output,
-                                             xmlRelaxNGPtr schema);

-Dump the transformed RelaxNG tree.

-
-
output:  the file output
-
schema:  a schema structure
-
xmlRelaxNGSetValidErrors ()
void        xmlRelaxNGSetValidErrors        (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc err,
-                                             xmlRelaxNGValidityWarningFunc warn,
-                                             void *ctx);

-Set the error and warning callback informations

-
-
ctxt:  a Relax-NG validation context
-
err:  the error function
-
warn: the warning function
-
ctx: the functions context
-
xmlRelaxNGGetValidErrors ()
int         xmlRelaxNGGetValidErrors        (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlRelaxNGValidityErrorFunc *err,
-                                             xmlRelaxNGValidityWarningFunc *warn,
-                                             void **ctx);

-Get the error and warning callback informations

-
-
ctxt:  a Relax-NG validation context
-
err:  the error function result
-
warn: the warning function result
-
ctx: the functions context result
-
Returns :-1 in case of error and 0 otherwise
-
xmlRelaxNGNewValidCtxt ()
xmlRelaxNGValidCtxtPtr xmlRelaxNGNewValidCtxt
-                                            (xmlRelaxNGPtr schema);

-Create an XML RelaxNGs validation context based on the given schema

-
-
schema:  a precompiled XML RelaxNGs
-
Returns :the validation context or NULL in case of error
-
xmlRelaxNGFreeValidCtxt ()
void        xmlRelaxNGFreeValidCtxt         (xmlRelaxNGValidCtxtPtr ctxt);

-Free the resources associated to the schema validation context

-
-
ctxt:  the schema validation context
-
xmlRelaxNGValidateDoc ()
int         xmlRelaxNGValidateDoc           (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

-Validate a document tree in memory.

-
-
ctxt:  a Relax-NG validation context
-
doc:  a parsed document tree
-
Returns :0 if the document is valid, a positive error code
-    number otherwise and -1 in case of internal or API error.
-
xmlRelaxNGCleanupTypes ()
void        xmlRelaxNGCleanupTypes          (void);

-Cleanup the default Schemas type library associated to RelaxNG

-
-
xmlRelaxNGValidatePushElement ()
int         xmlRelaxNGValidatePushElement   (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);

-Push a new element start on the RelaxNG validation stack.

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
Returns :1 if no validation problem was found or 0 if validating the
-        element requires a full node, and -1 in case of error.
-
xmlRelaxNGValidatePushCData ()
int         xmlRelaxNGValidatePushCData     (xmlRelaxNGValidCtxtPtr ctxt,
-                                             const xmlChar *data,
-                                             int len);

-check the CData parsed for validation in the current stack

-
-
ctxt:  the RelaxNG validation context
-
data:  some character data read
-
len:  the lenght of the data
-
Returns :1 if no validation problem was found or -1 otherwise
-
xmlRelaxNGValidatePopElement ()
int         xmlRelaxNGValidatePopElement    (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);

-Pop the element end from the RelaxNG validation stack.

-
-
ctxt:  the RelaxNG validation context
-
doc:  a document instance
-
elem:  an element instance
-
Returns :1 if no validation problem was found or 0 otherwise
-
xmlRelaxNGValidateFullElement ()
int         xmlRelaxNGValidateFullElement   (xmlRelaxNGValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);

-Validate a full subtree when xmlRelaxNGValidatePushElement() returned
-0 and the content of the node has been expanded.

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
Returns :1 if no validation problem was found or -1 in case of error.
-
<< nanohttpxpathInternals >>

+
int	xmlRelaxNGGetParserErrors	(xmlRelaxNGParserCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc * err, 
				 xmlRelaxNGValidityWarningFunc * warn, 
				 void ** ctx)

+
void	xmlRelaxNGDumpTree	(FILE * output, 
				 xmlRelaxNGPtr schema)

+
int	xmlRelaxNGValidatePushCData	(xmlRelaxNGValidCtxtPtr ctxt, 
				 const xmlChar * data, 
				 int len)

+
Function type: xmlRelaxNGValidityWarningFunc
+void	xmlRelaxNGValidityWarningFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
ctx:
msg:
...:


+
Description

+
Function: xmlRelaxNGFreeValidCtxt
void	xmlRelaxNGFreeValidCtxt	(xmlRelaxNGValidCtxtPtr ctxt)

+
Free the resources associated to the schema validation context

+
ctxt:the schema validation context
Function: xmlRelaxNGSetValidErrors
void	xmlRelaxNGSetValidErrors	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc err, 
				 xmlRelaxNGValidityWarningFunc warn, 
				 void * ctx)

+
Set the error and warning callback informations

+
ctxt:a Relax-NG validation context
err:the error function
warn:the warning function
ctx:the functions context
Function: xmlRelaxNGSetParserErrors
void	xmlRelaxNGSetParserErrors	(xmlRelaxNGParserCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc err, 
				 xmlRelaxNGValidityWarningFunc warn, 
				 void * ctx)

+
Set the callback functions used to handle errors for a validation context

+
ctxt:a Relax-NG validation context
err:the error callback
warn:the warning callback
ctx:contextual data for the callbacks
Function: xmlRelaxNGNewMemParserCtxt
xmlRelaxNGParserCtxtPtr	xmlRelaxNGNewMemParserCtxt	(const char * buffer, 
				 int size)

+
Create an XML RelaxNGs parse context for that memory buffer expected to contain an XML RelaxNGs file.

+
buffer:a pointer to a char array containing the schemas
size:the size of the array
Returns:the parser context or NULL in case of error
Function: xmlRelaxNGValidatePopElement
int	xmlRelaxNGValidatePopElement	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
Pop the element end from the RelaxNG validation stack.

+
ctxt:the RelaxNG validation context
doc:a document instance
elem:an element instance
Returns:1 if no validation problem was found or 0 otherwise
Function: xmlRelaxNGNewValidCtxt
xmlRelaxNGValidCtxtPtr	xmlRelaxNGNewValidCtxt	(xmlRelaxNGPtr schema)

+
Create an XML RelaxNGs validation context based on the given schema

+
schema:a precompiled XML RelaxNGs
Returns:the validation context or NULL in case of error
Function: xmlRelaxNGDump
void	xmlRelaxNGDump	(FILE * output, 
				 xmlRelaxNGPtr schema)

+
Dump a RelaxNG structure back

+
output:the file output
schema:a schema structure
Function: xmlRelaxNGValidateDoc
int	xmlRelaxNGValidateDoc	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Validate a document tree in memory.

+
ctxt:a Relax-NG validation context
doc:a parsed document tree
Returns:0 if the document is valid, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlRelaxNGParse
xmlRelaxNGPtr	xmlRelaxNGParse	(xmlRelaxNGParserCtxtPtr ctxt)

+
parse a schema definition resource and build an internal XML Shema struture which can be used to validate instances. *WARNING* this interface is highly subject to change

+
ctxt:a Relax-NG parser context
Returns:the internal XML RelaxNG structure built from the resource or NULL in case of error
Function: xmlRelaxNGValidatePushElement
int	xmlRelaxNGValidatePushElement	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
Push a new element start on the RelaxNG validation stack.

+
ctxt:the validation context
doc:a document instance
elem:an element instance
Returns:1 if no validation problem was found or 0 if validating the element requires a full node, and -1 in case of error.
Function: xmlRelaxNGValidateFullElement
int	xmlRelaxNGValidateFullElement	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
Validate a full subtree when xmlRelaxNGValidatePushElement() returned 0 and the content of the node has been expanded.

+
ctxt:the validation context
doc:a document instance
elem:an element instance
Returns:1 if no validation problem was found or -1 in case of error.
Function: xmlRelaxNGNewParserCtxt
xmlRelaxNGParserCtxtPtr	xmlRelaxNGNewParserCtxt	(const char * URL)

+
Create an XML RelaxNGs parse context for that file/resource expected to contain an XML RelaxNGs file.

+
URL:the location of the schema
Returns:the parser context or NULL in case of error

+      
+      
+      
+      
+      
+    
Function: xmlRelaxNGFree
void	xmlRelaxNGFree	(xmlRelaxNGPtr schema)

+
Deallocate a RelaxNG structure.

+
schema:a schema structure
Function: xmlRelaxNGFreeParserCtxt
void	xmlRelaxNGFreeParserCtxt	(xmlRelaxNGParserCtxtPtr ctxt)

+
Free the resources associated to the schema parser context

+
ctxt:the schema parser context
Function: xmlRelaxNGNewDocParserCtxt
xmlRelaxNGParserCtxtPtr	xmlRelaxNGNewDocParserCtxt	(xmlDocPtr doc)

+
Create an XML RelaxNGs parser context for that document. Note: since the process of compiling a RelaxNG schemas modifies the document, the @doc parameter is duplicated internally.

+
doc:a preparsed document tree
Returns:the parser context or NULL in case of error
Function: xmlRelaxNGGetValidErrors
int	xmlRelaxNGGetValidErrors	(xmlRelaxNGValidCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc * err, 
				 xmlRelaxNGValidityWarningFunc * warn, 
				 void ** ctx)

+
Get the error and warning callback informations

+
ctxt:a Relax-NG validation context
err:the error function result
warn:the warning function result
ctx:the functions context result
Returns:-1 in case of error and 0 otherwise
Function: xmlRelaxNGCleanupTypes
void	xmlRelaxNGCleanupTypes	(void)

+
Cleanup the default Schemas type library associated to RelaxNG

+
Function: xmlRelaxNGGetParserErrors
int	xmlRelaxNGGetParserErrors	(xmlRelaxNGParserCtxtPtr ctxt, 
				 xmlRelaxNGValidityErrorFunc * err, 
				 xmlRelaxNGValidityWarningFunc * warn, 
				 void ** ctx)

+
Get the callback information used to handle errors for a validation context

+
ctxt:a Relax-NG validation context
err:the error callback result
warn:the warning callback result
ctx:contextual data for the callbacks result
Returns:-1 in case of failure, 0 otherwise.
Function: xmlRelaxNGDumpTree
void	xmlRelaxNGDumpTree	(FILE * output, 
				 xmlRelaxNGPtr schema)

+
Dump the transformed RelaxNG tree.

+
output:the file output
schema:a schema structure
Function: xmlRelaxNGValidatePushCData
int	xmlRelaxNGValidatePushCData	(xmlRelaxNGValidCtxtPtr ctxt, 
				 const xmlChar * data, 
				 int len)

+
check the CData parsed for validation in the current stack

+
ctxt:the RelaxNG validation context
data:some character data read
len:the lenght of the data
Returns:1 if no validation problem was found or -1 otherwise

+      
+      
+      
+      
+      
+    
Daniel Veillard

diff --git a/doc/html/libxml-schemasInternals.html b/doc/html/libxml-schemasInternals.html
index 6306c91b..06848052 100644
--- a/doc/html/libxml-schemasInternals.html
+++ b/doc/html/libxml-schemasInternals.html
@@ -1,355 +1,303 @@
-schemasInternals
PrevUpHomeGnome XML Library Reference ManualNext
schemasInternals
schemasInternals — 
Synopsis
+
+
+Module schemasInternals from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module schemasInternals from libxml2
Main Menu
Related links
Table of Contents
Typedef xmlSchemaNotation * xmlSchemaNotationPtr
 
+
Typedef xmlSchemaAttributeGroup * xmlSchemaAttributeGroupPtr
 
+
#define XML_SCHEMAS_QUALIF_ATTR
 
-enum        xmlSchemaTypeType;
-enum        xmlSchemaContentType;
-struct      xmlSchemaVal;
-typedef     xmlSchemaValPtr;
-struct      xmlSchemaType;
-typedef     xmlSchemaTypePtr;
-struct      xmlSchemaFacet;
-typedef     xmlSchemaFacetPtr;
-struct      xmlSchemaAnnot;
-typedef     xmlSchemaAnnotPtr;
-#define     XML_SCHEMAS_ANYATTR_SKIP
-#define     XML_SCHEMAS_ANYATTR_LAX
-#define     XML_SCHEMAS_ANYATTR_STRICT
-struct      xmlSchemaAttribute;
-typedef     xmlSchemaAttributePtr;
-struct      xmlSchemaAttributeGroup;
-typedef     xmlSchemaAttributeGroupPtr;
-#define     XML_SCHEMAS_TYPE_MIXED
-#define     XML_SCHEMAS_ELEM_NILLABLE
-#define     XML_SCHEMAS_ELEM_GLOBAL
-#define     XML_SCHEMAS_ELEM_DEFAULT
-#define     XML_SCHEMAS_ELEM_FIXED
-#define     XML_SCHEMAS_ELEM_ABSTRACT
-#define     XML_SCHEMAS_ELEM_TOPLEVEL
-#define     XML_SCHEMAS_ELEM_REF
-struct      xmlSchemaElement;
-typedef     xmlSchemaElementPtr;
-#define     XML_SCHEMAS_FACET_UNKNOWN
-#define     XML_SCHEMAS_FACET_PRESERVE
-#define     XML_SCHEMAS_FACET_REPLACE
-#define     XML_SCHEMAS_FACET_COLLAPSE
-struct      xmlSchemaNotation;
-typedef     xmlSchemaNotationPtr;
-#define     XML_SCHEMAS_QUALIF_ELEM
-#define     XML_SCHEMAS_QUALIF_ATTR
-struct      xmlSchema;
-void        xmlSchemaFreeType               (xmlSchemaTypePtr type);
-
Description

+
Typedef xmlSchemaElement * xmlSchemaElementPtr
 
-
Details
enum xmlSchemaTypeType
typedef enum {
-    XML_SCHEMA_TYPE_BASIC = 1,
-    XML_SCHEMA_TYPE_ANY,
-    XML_SCHEMA_TYPE_FACET,
-    XML_SCHEMA_TYPE_SIMPLE,
-    XML_SCHEMA_TYPE_COMPLEX,
-    XML_SCHEMA_TYPE_SEQUENCE,
-    XML_SCHEMA_TYPE_CHOICE,
-    XML_SCHEMA_TYPE_ALL,
-    XML_SCHEMA_TYPE_SIMPLE_CONTENT,
-    XML_SCHEMA_TYPE_COMPLEX_CONTENT,
-    XML_SCHEMA_TYPE_UR,
-    XML_SCHEMA_TYPE_RESTRICTION,
-    XML_SCHEMA_TYPE_EXTENSION,
-    XML_SCHEMA_TYPE_ELEMENT,
-    XML_SCHEMA_TYPE_ATTRIBUTE,
-    XML_SCHEMA_TYPE_ATTRIBUTEGROUP,
-    XML_SCHEMA_TYPE_GROUP,
-    XML_SCHEMA_TYPE_NOTATION,
-    XML_SCHEMA_TYPE_LIST,
-    XML_SCHEMA_TYPE_UNION,
-    XML_SCHEMA_FACET_MININCLUSIVE = 1000,
-    XML_SCHEMA_FACET_MINEXCLUSIVE,
-    XML_SCHEMA_FACET_MAXINCLUSIVE,
-    XML_SCHEMA_FACET_MAXEXCLUSIVE,
-    XML_SCHEMA_FACET_TOTALDIGITS,
-    XML_SCHEMA_FACET_FRACTIONDIGITS,
-    XML_SCHEMA_FACET_PATTERN,
-    XML_SCHEMA_FACET_ENUMERATION,
-    XML_SCHEMA_FACET_WHITESPACE,
-    XML_SCHEMA_FACET_LENGTH,
-    XML_SCHEMA_FACET_MAXLENGTH,
-    XML_SCHEMA_FACET_MINLENGTH
-} xmlSchemaTypeType;
-

+
void	xmlSchemaFreeType	(xmlSchemaTypePtr type)

+
#define XML_SCHEMAS_FACET_COLLAPSE
 
-
enum xmlSchemaContentType
typedef enum {
-    XML_SCHEMA_CONTENT_UNKNOWN = 0,
-    XML_SCHEMA_CONTENT_EMPTY = 1,
-    XML_SCHEMA_CONTENT_ELEMENTS,
-    XML_SCHEMA_CONTENT_MIXED,
-    XML_SCHEMA_CONTENT_SIMPLE,
-    XML_SCHEMA_CONTENT_MIXED_OR_ELEMENTS,
-    XML_SCHEMA_CONTENT_BASIC,
-    XML_SCHEMA_CONTENT_ANY
-} xmlSchemaContentType;
-

+
Enum xmlSchemaContentType {
+    XML_SCHEMA_CONTENT_UNKNOWN = 0
+    XML_SCHEMA_CONTENT_EMPTY = 1
+    XML_SCHEMA_CONTENT_ELEMENTS = 2
+    XML_SCHEMA_CONTENT_MIXED = 3
+    XML_SCHEMA_CONTENT_SIMPLE = 4
+    XML_SCHEMA_CONTENT_MIXED_OR_ELEMENTS = 5
+    XML_SCHEMA_CONTENT_BASIC = 6
+    XML_SCHEMA_CONTENT_ANY = 7
+}
 
-
struct xmlSchemaVal
struct xmlSchemaVal;

+
Enum xmlSchemaTypeType {
+    XML_SCHEMA_TYPE_BASIC = 1
+    XML_SCHEMA_TYPE_ANY = 2
+    XML_SCHEMA_TYPE_FACET = 3
+    XML_SCHEMA_TYPE_SIMPLE = 4
+    XML_SCHEMA_TYPE_COMPLEX = 5
+    XML_SCHEMA_TYPE_SEQUENCE = 6
+    XML_SCHEMA_TYPE_CHOICE = 7
+    XML_SCHEMA_TYPE_ALL = 8
+    XML_SCHEMA_TYPE_SIMPLE_CONTENT = 9
+    XML_SCHEMA_TYPE_COMPLEX_CONTENT = 10
+    XML_SCHEMA_TYPE_UR = 11
+    XML_SCHEMA_TYPE_RESTRICTION = 12
+    XML_SCHEMA_TYPE_EXTENSION = 13
+    XML_SCHEMA_TYPE_ELEMENT = 14
+    XML_SCHEMA_TYPE_ATTRIBUTE = 15
+    XML_SCHEMA_TYPE_ATTRIBUTEGROUP = 16
+    XML_SCHEMA_TYPE_GROUP = 17
+    XML_SCHEMA_TYPE_NOTATION = 18
+    XML_SCHEMA_TYPE_LIST = 19
+    XML_SCHEMA_TYPE_UNION = 20
+    XML_SCHEMA_FACET_MININCLUSIVE = 1000
+    XML_SCHEMA_FACET_MINEXCLUSIVE = 1001
+    XML_SCHEMA_FACET_MAXINCLUSIVE = 1002
+    XML_SCHEMA_FACET_MAXEXCLUSIVE = 1003
+    XML_SCHEMA_FACET_TOTALDIGITS = 1004
+    XML_SCHEMA_FACET_FRACTIONDIGITS = 1005
+    XML_SCHEMA_FACET_PATTERN = 1006
+    XML_SCHEMA_FACET_ENUMERATION = 1007
+    XML_SCHEMA_FACET_WHITESPACE = 1008
+    XML_SCHEMA_FACET_LENGTH = 1009
+    XML_SCHEMA_FACET_MAXLENGTH = 1010
+    XML_SCHEMA_FACET_MINLENGTH = 1011
+}
 
-
xmlSchemaValPtr
typedef xmlSchemaVal *xmlSchemaValPtr;
-

+
Structure xmlSchemaAnnot
struct _xmlSchemaAnnot {
+    struct _xmlSchemaAnnot *	next
+    xmlNodePtr	content	: the annotation
+}

#define XML_SCHEMAS_FACET_UNKNOWN
 
-
struct xmlSchemaType
struct xmlSchemaType {
+
Structure xmlSchemaAttribute
struct _xmlSchemaAttribute {
+    xmlSchemaTypeType	type	: The kind of type
+    struct _xmlSchemaAttribute *	next	: the next attribute if in a group ...
+    xmlChar *	name
+    xmlChar *	id
+    xmlChar *	ref
+    xmlChar *	refNs
+    xmlChar *	typeName
+    xmlChar *	typeNs
+    xmlSchemaAnnotPtr	annot
+    xmlSchemaTypePtr	base
+    int	occurs
+    xmlChar *	defValue
+    xmlSchemaTypePtr	subtypes
+    xmlNodePtr	node
+}

Structure xmlSchemaElement
struct _xmlSchemaElement {
+    xmlSchemaTypeType	type	: The kind of type
+    struct _xmlSchemaType *	next	: the next type if in a sequence ...
+    xmlChar *	name
+    xmlChar *	id
+    xmlChar *	ref
+    xmlChar *	refNs
+    xmlSchemaAnnotPtr	annot
+    xmlSchemaTypePtr	subtypes
+    xmlSchemaAttributePtr	attributes
+    xmlNodePtr	node
+    int	minOccurs
+    int	maxOccurs
+    int	flags
+    xmlChar *	targetNamespace
+    xmlChar *	namedType
+    xmlChar *	namedTypeNs
+    xmlChar *	substGroup
+    xmlChar *	substGroupNs
+    xmlChar *	scope
+    xmlChar *	value
+    struct _xmlSchemaElement *	refDecl
+    xmlRegexpPtr	contModel
+    xmlSchemaContentType	contentType
+}

#define XML_SCHEMAS_ELEM_FIXED
 
-    xmlSchemaTypeType type;	/* The kind of type */
-    struct _xmlSchemaType *next;/* the next type if in a sequence ... */
-    xmlChar *name;
-    xmlChar *id;
-    xmlChar *ref;
-    xmlChar *refNs;
-    xmlSchemaAnnotPtr annot;
-    xmlSchemaTypePtr subtypes;
-    xmlSchemaAttributePtr attributes;
-    xmlNodePtr node;
-    int minOccurs;
-    int maxOccurs;
+
Structure xmlSchemaNotation
struct _xmlSchemaNotation {
+    xmlSchemaTypeType	type	: The kind of type
+    xmlChar *	name
+    xmlSchemaAnnotPtr	annot
+    xmlChar *	identifier
+}

Typedef xmlSchemaFacet * xmlSchemaFacetPtr
 
-    int flags;
-    xmlSchemaContentType contentType;
-    xmlChar *base;
-    xmlChar *baseNs;
-    xmlSchemaTypePtr baseType;
-    xmlSchemaFacetPtr facets;
-};
-

+
#define XML_SCHEMAS_ANYATTR_STRICT
 
-
xmlSchemaTypePtr
typedef xmlSchemaType *xmlSchemaTypePtr;
-

+
#define XML_SCHEMAS_FACET_PRESERVE
 
-
struct xmlSchemaFacet
struct xmlSchemaFacet {
+
#define XML_SCHEMAS_ANYATTR_SKIP
 
-    xmlSchemaTypeType type;	/* The kind of type */
-    struct _xmlSchemaFacet *next;/* the next type if in a sequence ... */
-    xmlChar *value;
-    xmlChar *id;
-    xmlSchemaAnnotPtr annot;
-    xmlNodePtr node;
-    int fixed;
-    int whitespace;
-    xmlSchemaValPtr val;
-    xmlRegexpPtr    regexp;
-};
-

+
Typedef xmlSchemaVal * xmlSchemaValPtr
 
-
xmlSchemaFacetPtr
typedef xmlSchemaFacet *xmlSchemaFacetPtr;
-

+
#define XML_SCHEMAS_ANYATTR_LAX
 
-
struct xmlSchemaAnnot
struct xmlSchemaAnnot {
+
Structure xmlSchemaAttributeGroup
struct _xmlSchemaAttributeGroup {
+    xmlSchemaTypeType	type	: The kind of type
+    struct _xmlSchemaAttribute *	next	: the next attribute if in a group ...
+    xmlChar *	name
+    xmlChar *	id
+    xmlChar *	ref
+    xmlChar *	refNs
+    xmlSchemaAnnotPtr	annot
+    xmlSchemaAttributePtr	attributes
+    xmlNodePtr	node
+}

#define XML_SCHEMAS_ELEM_NILLABLE
 
-    struct _xmlSchemaAnnot *next;
-    xmlNodePtr content;         /* the annotation */
-};
-

+
Typedef xmlSchemaType * xmlSchemaTypePtr
 
-
xmlSchemaAnnotPtr
typedef xmlSchemaAnnot *xmlSchemaAnnotPtr;
-

+
#define XML_SCHEMAS_ELEM_GLOBAL
 
-
XML_SCHEMAS_ANYATTR_SKIP
#define XML_SCHEMAS_ANYATTR_SKIP	1
-

+
#define XML_SCHEMAS_ELEM_TOPLEVEL
 
-
XML_SCHEMAS_ANYATTR_LAX
#define XML_SCHEMAS_ANYATTR_LAX		2
-

+
Typedef xmlSchemaAttribute * xmlSchemaAttributePtr
 
-
XML_SCHEMAS_ANYATTR_STRICT
#define XML_SCHEMAS_ANYATTR_STRICT	3
-

+
Typedef xmlSchemaAnnot * xmlSchemaAnnotPtr
 
-
struct xmlSchemaAttribute
struct xmlSchemaAttribute {
+
Structure xmlSchemaVal
struct _xmlSchemaVal {
+The content of this structure is not made public by the API.
+}

#define XML_SCHEMAS_TYPE_MIXED
 
-    xmlSchemaTypeType type;	/* The kind of type */
-    struct _xmlSchemaAttribute *next;/* the next attribute if in a group ... */
-    xmlChar *name;
-    xmlChar *id;
-    xmlChar *ref;
-    xmlChar *refNs;
-    xmlChar *typeName;
-    xmlChar *typeNs;
-    xmlSchemaAnnotPtr annot;
+
#define XML_SCHEMAS_ELEM_ABSTRACT
 
-    xmlSchemaTypePtr base;
-    int occurs;
-    xmlChar *defValue;
-    xmlSchemaTypePtr subtypes;
-    xmlNodePtr node;
-};
-

+
Structure xmlSchemaFacet
struct _xmlSchemaFacet {
+    xmlSchemaTypeType	type	: The kind of type
+    struct _xmlSchemaFacet *	next	: the next type if in a sequence ...
+    xmlChar *	value
+    xmlChar *	id
+    xmlSchemaAnnotPtr	annot
+    xmlNodePtr	node
+    int	fixed
+    int	whitespace
+    xmlSchemaValPtr	val
+    xmlRegexpPtr	regexp
+}

#define XML_SCHEMAS_QUALIF_ELEM
 
-
xmlSchemaAttributePtr
typedef xmlSchemaAttribute *xmlSchemaAttributePtr;
-

+
Structure xmlSchemaType
struct _xmlSchemaType {
+    xmlSchemaTypeType	type	: The kind of type
+    struct _xmlSchemaType *	next	: the next type if in a sequence ...
+    xmlChar *	name
+    xmlChar *	id
+    xmlChar *	ref
+    xmlChar *	refNs
+    xmlSchemaAnnotPtr	annot
+    xmlSchemaTypePtr	subtypes
+    xmlSchemaAttributePtr	attributes
+    xmlNodePtr	node
+    int	minOccurs
+    int	maxOccurs
+    int	flags
+    xmlSchemaContentType	contentType
+    xmlChar *	base
+    xmlChar *	baseNs
+    xmlSchemaTypePtr	baseType
+    xmlSchemaFacetPtr	facets
+}

#define XML_SCHEMAS_ELEM_REF
 
-
struct xmlSchemaAttributeGroup
struct xmlSchemaAttributeGroup {
+
#define XML_SCHEMAS_ELEM_DEFAULT
 
-    xmlSchemaTypeType type;	/* The kind of type */
-    struct _xmlSchemaAttribute *next;/* the next attribute if in a group ... */
-    xmlChar *name;
-    xmlChar *id;
-    xmlChar *ref;
-    xmlChar *refNs;
-    xmlSchemaAnnotPtr annot;
+
#define XML_SCHEMAS_FACET_REPLACE
 
-    xmlSchemaAttributePtr attributes;
-    xmlNodePtr node;
-};
-

+
Description

+
Macro: XML_SCHEMAS_QUALIF_ATTR
#define XML_SCHEMAS_QUALIF_ATTR
the shemas requires qualified attributes

+
Function: xmlSchemaFreeType
void	xmlSchemaFreeType	(xmlSchemaTypePtr type)

+
Deallocate a Schema Type structure.

+
type:a schema type structure
Macro: XML_SCHEMAS_FACET_COLLAPSE
#define XML_SCHEMAS_FACET_COLLAPSE
collapse the types of the facet

 
-
xmlSchemaAttributeGroupPtr
typedef xmlSchemaAttributeGroup *xmlSchemaAttributeGroupPtr;
-

+      
+      
+    
Macro: XML_SCHEMAS_FACET_UNKNOWN
#define XML_SCHEMAS_FACET_UNKNOWN
unknown facet handling

 
-
XML_SCHEMAS_TYPE_MIXED
#define XML_SCHEMAS_TYPE_MIXED		1 << 0
-

-the element content type is mixed

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Macro: XML_SCHEMAS_ELEM_FIXED
#define XML_SCHEMAS_ELEM_FIXED
the element has a fixed value

 
-
XML_SCHEMAS_ELEM_NILLABLE
#define XML_SCHEMAS_ELEM_NILLABLE	1 << 0
-

-the element is nillable

+      
+      
+      
+      
+    
Macro: XML_SCHEMAS_ANYATTR_STRICT
#define XML_SCHEMAS_ANYATTR_STRICT

+
Macro: XML_SCHEMAS_FACET_PRESERVE
#define XML_SCHEMAS_FACET_PRESERVE
preserve the type of the facet

+
Macro: XML_SCHEMAS_ANYATTR_SKIP
#define XML_SCHEMAS_ANYATTR_SKIP

+
Macro: XML_SCHEMAS_ANYATTR_LAX
#define XML_SCHEMAS_ANYATTR_LAX

 
-
XML_SCHEMAS_ELEM_GLOBAL
#define XML_SCHEMAS_ELEM_GLOBAL		1 << 1
-

-the element is global

+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Macro: XML_SCHEMAS_ELEM_NILLABLE
#define XML_SCHEMAS_ELEM_NILLABLE
the element is nillable

+
Macro: XML_SCHEMAS_ELEM_GLOBAL
#define XML_SCHEMAS_ELEM_GLOBAL
the element is global

+
Macro: XML_SCHEMAS_ELEM_TOPLEVEL
#define XML_SCHEMAS_ELEM_TOPLEVEL
the element is top level

+
Macro: XML_SCHEMAS_TYPE_MIXED
#define XML_SCHEMAS_TYPE_MIXED
the element content type is mixed

+
Macro: XML_SCHEMAS_ELEM_ABSTRACT
#define XML_SCHEMAS_ELEM_ABSTRACT
the element is abstract

 
-
XML_SCHEMAS_ELEM_DEFAULT
#define XML_SCHEMAS_ELEM_DEFAULT	1 << 2
-

-the element has a default value

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Macro: XML_SCHEMAS_QUALIF_ELEM
#define XML_SCHEMAS_QUALIF_ELEM
the shemas requires qualified elements

 
-
XML_SCHEMAS_ELEM_FIXED
#define XML_SCHEMAS_ELEM_FIXED		1 << 3
-

-the element has a fixed value

-
-
XML_SCHEMAS_ELEM_ABSTRACT
#define XML_SCHEMAS_ELEM_ABSTRACT	1 << 4
-

-the element is abstract

-
-
XML_SCHEMAS_ELEM_TOPLEVEL
#define XML_SCHEMAS_ELEM_TOPLEVEL	1 << 5
-

-the element is top level

-
-
XML_SCHEMAS_ELEM_REF
#define XML_SCHEMAS_ELEM_REF		1 << 6
-

-the element is a reference to a type

-
-
struct xmlSchemaElement
struct xmlSchemaElement {
-
-    xmlSchemaTypeType type;	/* The kind of type */
-    struct _xmlSchemaType *next;/* the next type if in a sequence ... */
-    xmlChar *name;
-    xmlChar *id;
-    xmlChar *ref;
-    xmlChar *refNs;
-    xmlSchemaAnnotPtr annot;
-    xmlSchemaTypePtr subtypes;
-    xmlSchemaAttributePtr attributes;
-    xmlNodePtr node;
-    int minOccurs;
-    int maxOccurs;
-
-    int flags;
-    xmlChar *targetNamespace;
-    xmlChar *namedType;
-    xmlChar *namedTypeNs;
-    xmlChar *substGroup;
-    xmlChar *substGroupNs;
-    xmlChar *scope;
-    xmlChar *value;
-    struct _xmlSchemaElement *refDecl;
-    xmlRegexpPtr contModel;
-    xmlSchemaContentType contentType;
-};
-

-
-
xmlSchemaElementPtr
typedef xmlSchemaElement *xmlSchemaElementPtr;
-

-
-
XML_SCHEMAS_FACET_UNKNOWN
#define XML_SCHEMAS_FACET_UNKNOWN	0
-

-
-
XML_SCHEMAS_FACET_PRESERVE
#define XML_SCHEMAS_FACET_PRESERVE	1
-

-
-
XML_SCHEMAS_FACET_REPLACE
#define XML_SCHEMAS_FACET_REPLACE	2
-

-
-
XML_SCHEMAS_FACET_COLLAPSE
#define XML_SCHEMAS_FACET_COLLAPSE	3
-

-
-
struct xmlSchemaNotation
struct xmlSchemaNotation {
-
-    xmlSchemaTypeType type;	/* The kind of type */
-    xmlChar *name;
-    xmlSchemaAnnotPtr annot;
-    xmlChar *identifier;
-};
-

-
-
xmlSchemaNotationPtr
typedef xmlSchemaNotation *xmlSchemaNotationPtr;
-

-
-
XML_SCHEMAS_QUALIF_ELEM
#define XML_SCHEMAS_QUALIF_ELEM		1 << 0
-

-the shemas requires qualified elements

-
-
XML_SCHEMAS_QUALIF_ATTR
#define XML_SCHEMAS_QUALIF_ATTR		1 << 1
-

-the shemas requires qualified attributes

-
-
struct xmlSchema
struct xmlSchema {
-
-    xmlChar *name;        /* schema name */
-    xmlChar *targetNamespace;     /* the target namespace */
-    xmlChar *version;
-    xmlChar *id;
-    xmlDocPtr doc;
-    xmlSchemaAnnotPtr annot;
-    int flags;
-
-    xmlHashTablePtr typeDecl;
-    xmlHashTablePtr attrDecl;
-    xmlHashTablePtr attrgrpDecl;
-    xmlHashTablePtr elemDecl;
-    xmlHashTablePtr notaDecl;
-
-    xmlHashTablePtr schemasImports;
-
-    void *_private;	/* unused by the library for users or bindings */
-    xmlHashTablePtr groupDecl;
-};
-

-
-
xmlSchemaFreeType ()
void        xmlSchemaFreeType               (xmlSchemaTypePtr type);

-Deallocate a Schema Type structure.

-
-
type:  a schema type structure
-
<< nanoftpthreads >>

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Macro: XML_SCHEMAS_ELEM_REF
#define XML_SCHEMAS_ELEM_REF
the element is a reference to a type

+
Macro: XML_SCHEMAS_ELEM_DEFAULT
#define XML_SCHEMAS_ELEM_DEFAULT
the element has a default value

+
Macro: XML_SCHEMAS_FACET_REPLACE
#define XML_SCHEMAS_FACET_REPLACE
replace the type of the facet

+
Daniel Veillard

diff --git a/doc/html/libxml-testOOMlib.html b/doc/html/libxml-testOOMlib.html
deleted file mode 100644
index c0017728..00000000
--- a/doc/html/libxml-testOOMlib.html
+++ /dev/null
@@ -1,93 +0,0 @@
-testOOMlib
PrevUpHomeGnome XML Library Reference ManualNext
testOOMlib
testOOMlib — 
Synopsis
-
-
-
-void*       test_malloc                     (size_t bytes);
-void*       test_realloc                    (void *memory,
-                                             size_t bytes);
-void        test_free                       (void *memory);
-char*       test_strdup                     (const char *str);
-int         (*TestMemoryFunction)           (void *data);
-int         test_oom_handling               (TestMemoryFunction func,
-                                             void *data);
-int         test_get_malloc_blocks_outstanding
-                                            (void);
-
Description

-
-
Details
test_malloc ()
void*       test_malloc                     (size_t bytes);

-
-
bytes:
-
-
-
test_realloc ()
void*       test_realloc                    (void *memory,
-                                             size_t bytes);

-
-
memory:
-
bytes:
-
-
-
test_free ()
void        test_free                       (void *memory);

-
-
memory:
-
-
-
test_strdup ()
char*       test_strdup                     (const char *str);

-
-
str:
-
Returns :
-
-
-
TestMemoryFunction ()
int         (*TestMemoryFunction)           (void *data);

-
-
data:
-
Returns :
-
-
-
test_oom_handling ()
int         test_oom_handling               (TestMemoryFunction func,
-                                             void *data);

-Tests how well the given function responds to out-of-memory
-situations. Calls the function repeatedly, failing a different
-call to malloc() each time. If the function ever returns FALSE,
-the test fails. The function should return TRUE whenever something
-valid (such as returning an error, or succeeding) occurs, and FALSE
-if it gets confused in some way.

-
-
func: function to call
-
data: data to pass to function
-
Returns :TRUE if the function never returns FALSE
-
test_get_malloc_blocks_outstanding ()
int         test_get_malloc_blocks_outstanding
-                                            (void);

-Get the number of outstanding malloc()'d blocks.

-
-
Returns :number of blocks
-
<< Libxml Programming Noteswincecompat >>

diff --git a/doc/html/libxml-threads.html b/doc/html/libxml-threads.html
index 08dbe8d7..f18c4cad 100644
--- a/doc/html/libxml-threads.html
+++ b/doc/html/libxml-threads.html
@@ -1,132 +1,64 @@
-threads
PrevUpHomeGnome XML Library Reference ManualNext
threads
threads — 
Synopsis
+
+
+Module threads from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module threads from libxml2
Main Menu
Related links
Table of Contents
Typedef xmlRMutex * xmlRMutexPtr
 
+
void	xmlFreeRMutex	(xmlRMutexPtr tok)

+
int	xmlGetThreadId	(void)

+
Typedef xmlMutex * xmlMutexPtr
 
-
-struct      xmlMutex;
-typedef     xmlMutexPtr;
-struct      xmlRMutex;
-typedef     xmlRMutexPtr;
-xmlMutexPtr xmlNewMutex                     (void);
-void        xmlMutexLock                    (xmlMutexPtr tok);
-void        xmlMutexUnlock                  (xmlMutexPtr tok);
-void        xmlFreeMutex                    (xmlMutexPtr tok);
-xmlRMutexPtr xmlNewRMutex                   (void);
-void        xmlRMutexLock                   (xmlRMutexPtr tok);
-void        xmlRMutexUnlock                 (xmlRMutexPtr tok);
-void        xmlFreeRMutex                   (xmlRMutexPtr tok);
-void        xmlInitThreads                  (void);
-void        xmlLockLibrary                  (void);
-void        xmlUnlockLibrary                (void);
-int         xmlGetThreadId                  (void);
-int         xmlIsMainThread                 (void);
-void        xmlCleanupThreads               (void);
-xmlGlobalStatePtr xmlGetGlobalState         (void);
-
Description

-
-
Details
struct xmlMutex
struct xmlMutex;

-
-
xmlMutexPtr
typedef xmlMutex *xmlMutexPtr;
-

-
-
struct xmlRMutex
struct xmlRMutex;

-
-
xmlRMutexPtr
typedef xmlRMutex *xmlRMutexPtr;
-

-
-
xmlNewMutex ()
xmlMutexPtr xmlNewMutex                     (void);

-xmlNewMutex() is used to allocate a libxml2 token struct for use in
-synchronizing access to data.

-
-
Returns :a new simple mutex pointer or NULL in case of error
-
xmlMutexLock ()
void        xmlMutexLock                    (xmlMutexPtr tok);

-xmlMutexLock() is used to lock a libxml2 token.

-
-
tok:  the simple mutex
-
xmlMutexUnlock ()
void        xmlMutexUnlock                  (xmlMutexPtr tok);

-xmlMutexUnlock() is used to unlock a libxml2 token.

-
-
tok:  the simple mutex
-
xmlFreeMutex ()
void        xmlFreeMutex                    (xmlMutexPtr tok);

-xmlFreeMutex() is used to reclaim resources associated with a libxml2 token
-struct.

-
-
tok:  the simple mutex
-
xmlNewRMutex ()
xmlRMutexPtr xmlNewRMutex                   (void);

-xmlRNewMutex() is used to allocate a reentrant mutex for use in
-synchronizing access to data. token_r is a re-entrant lock and thus useful
-for synchronizing access to data structures that may be manipulated in a
-recursive fashion.

-
-
Returns :the new reentrant mutex pointer or NULL in case of error
-
xmlRMutexLock ()
void        xmlRMutexLock                   (xmlRMutexPtr tok);

-xmlRMutexLock() is used to lock a libxml2 token_r.

-
-
tok:  the reentrant mutex
-
xmlRMutexUnlock ()
void        xmlRMutexUnlock                 (xmlRMutexPtr tok);

-xmlRMutexUnlock() is used to unlock a libxml2 token_r.

-
-
tok:  the reentrant mutex
-
xmlFreeRMutex ()
void        xmlFreeRMutex                   (xmlRMutexPtr tok);

-xmlRFreeMutex() is used to reclaim resources associated with a
-reentrant mutex.

-
-
tok:  the reentrant mutex
-
xmlInitThreads ()
void        xmlInitThreads                  (void);

-xmlInitThreads() is used to to initialize all the thread related
-data of the libxml2 library.

-
-
xmlLockLibrary ()
void        xmlLockLibrary                  (void);

-xmlLockLibrary() is used to take out a re-entrant lock on the libxml2
-library.

-
-
xmlUnlockLibrary ()
void        xmlUnlockLibrary                (void);

-xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2
-library.

-
-
xmlGetThreadId ()
int         xmlGetThreadId                  (void);

-xmlGetThreadId() find the current thread ID number

-
-
Returns :the current thread ID number
-
xmlIsMainThread ()
int         xmlIsMainThread                 (void);

-xmlIsMainThread() check whether the current thread is the main thread.

-
-
Returns :1 if the current thread is the main thread, 0 otherwise
-
xmlCleanupThreads ()
void        xmlCleanupThreads               (void);

-xmlCleanupThreads() is used to to cleanup all the thread related
-data of the libxml2 library once processing has ended.

-
-
xmlGetGlobalState ()
xmlGlobalStatePtr xmlGetGlobalState         (void);

-xmlGetGlobalState() is called to retrieve the global state for a thread.

-
-
Returns :the thread global state or NULL in case of error
-
<< schemasInternalsparser >>

+
Structure xmlRMutex
struct _xmlRMutex {
+The content of this structure is not made public by the API.
+}

void	xmlFreeMutex	(xmlMutexPtr tok)

+
void	xmlCleanupThreads	(void)

+
void	xmlMutexUnlock	(xmlMutexPtr tok)

+
xmlRMutexPtr	xmlNewRMutex	(void)

+
void	xmlMutexLock	(xmlMutexPtr tok)

+
int	xmlIsMainThread	(void)

+
void	xmlRMutexUnlock	(xmlRMutexPtr tok)

+
xmlGlobalStatePtr	xmlGetGlobalState	(void)

+
xmlMutexPtr	xmlNewMutex	(void)

+
Structure xmlMutex
struct _xmlMutex {
+The content of this structure is not made public by the API.
+}

void	xmlInitThreads	(void)

+
void	xmlUnlockLibrary	(void)

+
void	xmlLockLibrary	(void)

+
void	xmlRMutexLock	(xmlRMutexPtr tok)

+
Description

+
Function: xmlFreeRMutex
void	xmlFreeRMutex	(xmlRMutexPtr tok)

+
xmlRFreeMutex() is used to reclaim resources associated with a reentrant mutex.

+
tok:the reentrant mutex
Function: xmlGetThreadId
int	xmlGetThreadId	(void)

+
xmlGetThreadId() find the current thread ID number

+
Returns:the current thread ID number
Function: xmlFreeMutex
void	xmlFreeMutex	(xmlMutexPtr tok)

+
xmlFreeMutex() is used to reclaim resources associated with a libxml2 token struct.

+
tok:the simple mutex
Function: xmlCleanupThreads
void	xmlCleanupThreads	(void)

+
xmlCleanupThreads() is used to to cleanup all the thread related data of the libxml2 library once processing has ended.

+
Function: xmlMutexUnlock
void	xmlMutexUnlock	(xmlMutexPtr tok)

+
xmlMutexUnlock() is used to unlock a libxml2 token.

+
tok:the simple mutex
Function: xmlNewRMutex
xmlRMutexPtr	xmlNewRMutex	(void)

+
xmlRNewMutex() is used to allocate a reentrant mutex for use in synchronizing access to data. token_r is a re-entrant lock and thus useful for synchronizing access to data structures that may be manipulated in a recursive fashion.

+
Returns:the new reentrant mutex pointer or NULL in case of error
Function: xmlMutexLock
void	xmlMutexLock	(xmlMutexPtr tok)

+
xmlMutexLock() is used to lock a libxml2 token.

+
tok:the simple mutex
Function: xmlIsMainThread
int	xmlIsMainThread	(void)

+
xmlIsMainThread() check whether the current thread is the main thread.

+
Returns:1 if the current thread is the main thread, 0 otherwise
Function: xmlRMutexUnlock
void	xmlRMutexUnlock	(xmlRMutexPtr tok)

+
xmlRMutexUnlock() is used to unlock a libxml2 token_r.

+
tok:the reentrant mutex
Function: xmlGetGlobalState
xmlGlobalStatePtr	xmlGetGlobalState	(void)

+
xmlGetGlobalState() is called to retrieve the global state for a thread.

+
Returns:the thread global state or NULL in case of error
Function: xmlNewMutex
xmlMutexPtr	xmlNewMutex	(void)

+
xmlNewMutex() is used to allocate a libxml2 token struct for use in synchronizing access to data.

+
Returns:a new simple mutex pointer or NULL in case of error
Function: xmlInitThreads
void	xmlInitThreads	(void)

+
xmlInitThreads() is used to to initialize all the thread related data of the libxml2 library.

+
Function: xmlUnlockLibrary
void	xmlUnlockLibrary	(void)

+
xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 library.

+
Function: xmlLockLibrary
void	xmlLockLibrary	(void)

+
xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 library.

+
Function: xmlRMutexLock
void	xmlRMutexLock	(xmlRMutexPtr tok)

+
xmlRMutexLock() is used to lock a libxml2 token_r.

+
tok:the reentrant mutex
Daniel Veillard

diff --git a/doc/html/libxml-tree.html b/doc/html/libxml-tree.html
index bc4db6e0..f0da6f26 100644
--- a/doc/html/libxml-tree.html
+++ b/doc/html/libxml-tree.html
@@ -1,2297 +1,1208 @@
-tree
PrevUpHomeGnome XML Library Reference ManualNext
tree
tree — 
Synopsis
-
-
-
-struct      xmlParserInputBuffer;
-typedef     xmlParserInputBufferPtr;
-struct      xmlOutputBuffer;
-typedef     xmlOutputBufferPtr;
-struct      xmlParserInput;
-typedef     xmlParserInputPtr;
-struct      xmlParserCtxt;
-typedef     xmlParserCtxtPtr;
-struct      xmlSAXLocator;
-typedef     xmlSAXLocatorPtr;
-struct      xmlSAXHandler;
-typedef     xmlSAXHandlerPtr;
-struct      xmlEntity;
-typedef     xmlEntityPtr;
-#define     BASE_BUFFER_SIZE
-#define     XML_XML_NAMESPACE
-enum        xmlElementType;
-typedef     xmlChar;
-#define     BAD_CAST
-struct      xmlNotation;
-typedef     xmlNotationPtr;
-enum        xmlAttributeType;
-enum        xmlAttributeDefault;
-struct      xmlEnumeration;
-typedef     xmlEnumerationPtr;
-struct      xmlAttribute;
-typedef     xmlAttributePtr;
-enum        xmlElementContentType;
-enum        xmlElementContentOccur;
-struct      xmlElementContent;
-typedef     xmlElementContentPtr;
-enum        xmlElementTypeVal;
-struct      xmlElement;
-typedef     xmlElementPtr;
-#define     XML_LOCAL_NAMESPACE
-typedef     xmlNsType;
-struct      xmlNs;
-typedef     xmlNsPtr;
-struct      xmlDtd;
-typedef     xmlDtdPtr;
-struct      xmlAttr;
-typedef     xmlAttrPtr;
-struct      xmlID;
-typedef     xmlIDPtr;
-struct      xmlRef;
-typedef     xmlRefPtr;
-enum        xmlBufferAllocationScheme;
-struct      xmlBuffer;
-typedef     xmlBufferPtr;
-struct      xmlNode;
-typedef     xmlNodePtr;
-#define     XML_GET_CONTENT                 (n)
-#define     XML_GET_LINE                    (n)
-struct      xmlDoc;
-typedef     xmlDocPtr;
-#define     xmlChildrenNode
-#define     xmlRootNode
-int         xmlValidateNCName               (const xmlChar *value,
-                                             int space);
-int         xmlValidateQName                (const xmlChar *value,
-                                             int space);
-int         xmlValidateName                 (const xmlChar *value,
-                                             int space);
-int         xmlValidateNMToken              (const xmlChar *value,
-                                             int space);
-xmlChar*    xmlBuildQName                   (const xmlChar *ncname,
-                                             const xmlChar *prefix,
-                                             xmlChar *memory,
-                                             int len);
-xmlChar*    xmlSplitQName2                  (const xmlChar *name,
-                                             xmlChar **prefix);
-const xmlChar* xmlSplitQName3               (const xmlChar *name,
-                                             int *len);
-void        xmlSetBufferAllocationScheme    (xmlBufferAllocationScheme scheme);
-xmlBufferAllocationScheme xmlGetBufferAllocationScheme
-                                            (void);
-xmlBufferPtr xmlBufferCreate                (void);
-xmlBufferPtr xmlBufferCreateSize            (size_t size);
-xmlBufferPtr xmlBufferCreateStatic          (void *mem,
-                                             size_t size);
-int         xmlBufferResize                 (xmlBufferPtr buf,
-                                             unsigned int size);
-void        xmlBufferFree                   (xmlBufferPtr buf);
-int         xmlBufferDump                   (FILE *file,
-                                             xmlBufferPtr buf);
-void        xmlBufferAdd                    (xmlBufferPtr buf,
-                                             const xmlChar *str,
-                                             int len);
-void        xmlBufferAddHead                (xmlBufferPtr buf,
-                                             const xmlChar *str,
-                                             int len);
-void        xmlBufferCat                    (xmlBufferPtr buf,
-                                             const xmlChar *str);
-void        xmlBufferCCat                   (xmlBufferPtr buf,
-                                             const char *str);
-int         xmlBufferShrink                 (xmlBufferPtr buf,
-                                             unsigned int len);
-int         xmlBufferGrow                   (xmlBufferPtr buf,
-                                             unsigned int len);
-void        xmlBufferEmpty                  (xmlBufferPtr buf);
-const xmlChar* xmlBufferContent             (const xmlBufferPtr buf);
-void        xmlBufferSetAllocationScheme    (xmlBufferPtr buf,
-                                             xmlBufferAllocationScheme scheme);
-int         xmlBufferLength                 (const xmlBufferPtr buf);
-xmlDtdPtr   xmlCreateIntSubset              (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlNewDtd                       (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);
-xmlDtdPtr   xmlGetIntSubset                 (xmlDocPtr doc);
-void        xmlFreeDtd                      (xmlDtdPtr cur);
-xmlNsPtr    xmlNewGlobalNs                  (xmlDocPtr doc,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);
-xmlNsPtr    xmlNewNs                        (xmlNodePtr node,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);
-void        xmlFreeNs                       (xmlNsPtr cur);
-void        xmlFreeNsList                   (xmlNsPtr cur);
-xmlDocPtr   xmlNewDoc                       (const xmlChar *version);
-void        xmlFreeDoc                      (xmlDocPtr cur);
-xmlAttrPtr  xmlNewDocProp                   (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlAttrPtr  xmlNewProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlAttrPtr  xmlNewNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlAttrPtr  xmlNewNsPropEatName             (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *value);
-void        xmlFreePropList                 (xmlAttrPtr cur);
-void        xmlFreeProp                     (xmlAttrPtr cur);
-xmlAttrPtr  xmlCopyProp                     (xmlNodePtr target,
-                                             xmlAttrPtr cur);
-xmlAttrPtr  xmlCopyPropList                 (xmlNodePtr target,
-                                             xmlAttrPtr cur);
-xmlDtdPtr   xmlCopyDtd                      (xmlDtdPtr dtd);
-xmlDocPtr   xmlCopyDoc                      (xmlDocPtr doc,
-                                             int recursive);
-xmlNodePtr  xmlNewDocNode                   (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocNodeEatName            (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocRawNode                (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewNode                      (xmlNsPtr ns,
-                                             const xmlChar *name);
-xmlNodePtr  xmlNewNodeEatName               (xmlNsPtr ns,
-                                             xmlChar *name);
-xmlNodePtr  xmlNewChild                     (xmlNodePtr parent,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewTextChild                 (xmlNodePtr parent,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocText                   (xmlDocPtr doc,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewText                      (const xmlChar *content);
-xmlNodePtr  xmlNewPI                        (const xmlChar *name,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewDocTextLen                (xmlDocPtr doc,
-                                             const xmlChar *content,
-                                             int len);
-xmlNodePtr  xmlNewTextLen                   (const xmlChar *content,
-                                             int len);
-xmlNodePtr  xmlNewDocComment                (xmlDocPtr doc,
-                                             const xmlChar *content);
-xmlNodePtr  xmlNewComment                   (const xmlChar *content);
-xmlNodePtr  xmlNewCDataBlock                (xmlDocPtr doc,
-                                             const xmlChar *content,
-                                             int len);
-xmlNodePtr  xmlNewCharRef                   (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlNodePtr  xmlNewReference                 (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlNodePtr  xmlCopyNode                     (const xmlNodePtr node,
-                                             int recursive);
-xmlNodePtr  xmlDocCopyNode                  (const xmlNodePtr node,
-                                             xmlDocPtr doc,
-                                             int recursive);
-xmlNodePtr  xmlCopyNodeList                 (const xmlNodePtr node);
-xmlNodePtr  xmlNewDocFragment               (xmlDocPtr doc);
-long        xmlGetLineNo                    (xmlNodePtr node);
-xmlChar*    xmlGetNodePath                  (xmlNodePtr node);
-xmlNodePtr  xmlDocGetRootElement            (xmlDocPtr doc);
-xmlNodePtr  xmlGetLastChild                 (xmlNodePtr parent);
-int         xmlNodeIsText                   (xmlNodePtr node);
-int         xmlIsBlankNode                  (xmlNodePtr node);
-xmlNodePtr  xmlDocSetRootElement            (xmlDocPtr doc,
-                                             xmlNodePtr root);
-void        xmlNodeSetName                  (xmlNodePtr cur,
-                                             const xmlChar *name);
-xmlNodePtr  xmlAddChild                     (xmlNodePtr parent,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlAddChildList                 (xmlNodePtr parent,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlReplaceNode                  (xmlNodePtr old,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlAddPrevSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);
-xmlNodePtr  xmlAddSibling                   (xmlNodePtr cur,
-                                             xmlNodePtr elem);
-xmlNodePtr  xmlAddNextSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);
-void        xmlUnlinkNode                   (xmlNodePtr cur);
-xmlNodePtr  xmlTextMerge                    (xmlNodePtr first,
-                                             xmlNodePtr second);
-int         xmlTextConcat                   (xmlNodePtr node,
-                                             const xmlChar *content,
-                                             int len);
-void        xmlFreeNodeList                 (xmlNodePtr cur);
-void        xmlFreeNode                     (xmlNodePtr cur);
-void        xmlSetTreeDoc                   (xmlNodePtr tree,
-                                             xmlDocPtr doc);
-void        xmlSetListDoc                   (xmlNodePtr list,
-                                             xmlDocPtr doc);
-xmlNsPtr    xmlSearchNs                     (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *nameSpace);
-xmlNsPtr    xmlSearchNsByHref               (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *href);
-xmlNsPtr*   xmlGetNsList                    (xmlDocPtr doc,
-                                             xmlNodePtr node);
-void        xmlSetNs                        (xmlNodePtr node,
-                                             xmlNsPtr ns);
-xmlNsPtr    xmlCopyNamespace                (xmlNsPtr cur);
-xmlNsPtr    xmlCopyNamespaceList            (xmlNsPtr cur);
-xmlAttrPtr  xmlSetProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlChar*    xmlGetNoNsProp                  (xmlNodePtr node,
-                                             const xmlChar *name);
-xmlChar*    xmlGetProp                      (xmlNodePtr node,
-                                             const xmlChar *name);
-xmlAttrPtr  xmlHasProp                      (xmlNodePtr node,
-                                             const xmlChar *name);
-xmlAttrPtr  xmlHasNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);
-xmlAttrPtr  xmlSetNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlChar*    xmlGetNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);
-xmlNodePtr  xmlStringGetNodeList            (xmlDocPtr doc,
-                                             const xmlChar *value);
-xmlNodePtr  xmlStringLenGetNodeList         (xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             int len);
-xmlChar*    xmlNodeListGetString            (xmlDocPtr doc,
-                                             xmlNodePtr list,
-                                             int inLine);
-xmlChar*    xmlNodeListGetRawString         (xmlDocPtr doc,
-                                             xmlNodePtr list,
-                                             int inLine);
-void        xmlNodeSetContent               (xmlNodePtr cur,
-                                             const xmlChar *content);
-void        xmlNodeSetContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
-                                             int len);
-void        xmlNodeAddContent               (xmlNodePtr cur,
-                                             const xmlChar *content);
-void        xmlNodeAddContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
-                                             int len);
-xmlChar*    xmlNodeGetContent               (xmlNodePtr cur);
-int         xmlNodeBufGetContent            (xmlBufferPtr buffer,
-                                             xmlNodePtr cur);
-xmlChar*    xmlNodeGetLang                  (xmlNodePtr cur);
-int         xmlNodeGetSpacePreserve         (xmlNodePtr cur);
-void        xmlNodeSetLang                  (xmlNodePtr cur,
-                                             const xmlChar *lang);
-void        xmlNodeSetSpacePreserve         (xmlNodePtr cur,
-                                             int val);
-xmlChar*    xmlNodeGetBase                  (xmlDocPtr doc,
-                                             xmlNodePtr cur);
-void        xmlNodeSetBase                  (xmlNodePtr cur,
-                                             const xmlChar *uri);
-int         xmlRemoveProp                   (xmlAttrPtr cur);
-int         xmlUnsetProp                    (xmlNodePtr node,
-                                             const xmlChar *name);
-int         xmlUnsetNsProp                  (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name);
-void        xmlBufferWriteCHAR              (xmlBufferPtr buf,
-                                             const xmlChar *string);
-void        xmlBufferWriteChar              (xmlBufferPtr buf,
-                                             const char *string);
-void        xmlBufferWriteQuotedString      (xmlBufferPtr buf,
-                                             const xmlChar *string);
-int         xmlReconciliateNs               (xmlDocPtr doc,
-                                             xmlNodePtr tree);
-void        xmlDocDumpFormatMemory          (xmlDocPtr cur,
-                                             xmlChar **mem,
-                                             int *size,
-                                             int format);
-void        xmlDocDumpMemory                (xmlDocPtr cur,
-                                             xmlChar **mem,
-                                             int *size);
-void        xmlDocDumpMemoryEnc             (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
-                                             int *doc_txt_len,
-                                             const char *txt_encoding);
-void        xmlDocDumpFormatMemoryEnc       (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
-                                             int *doc_txt_len,
-                                             const char *txt_encoding,
-                                             int format);
-int         xmlDocFormatDump                (FILE *f,
-                                             xmlDocPtr cur,
-                                             int format);
-int         xmlDocDump                      (FILE *f,
-                                             xmlDocPtr cur);
-void        xmlElemDump                     (FILE *f,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);
-int         xmlSaveFile                     (const char *filename,
-                                             xmlDocPtr cur);
-int         xmlSaveFormatFile               (const char *filename,
-                                             xmlDocPtr cur,
-                                             int format);
-int         xmlNodeDump                     (xmlBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             int level,
-                                             int format);
-int         xmlSaveFileTo                   (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding);
-int         xmlSaveFormatFileTo             (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);
-void        xmlNodeDumpOutput               (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             int level,
-                                             int format,
-                                             const char *encoding);
-int         xmlSaveFormatFileEnc            (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);
-int         xmlSaveFileEnc                  (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding);
-int         xmlIsXHTML                      (const xmlChar *systemID,
-                                             const xmlChar *publicID);
-int         xmlGetDocCompressMode           (xmlDocPtr doc);
-void        xmlSetDocCompressMode           (xmlDocPtr doc,
-                                             int mode);
-int         xmlGetCompressMode              (void);
-void        xmlSetCompressMode              (int mode);
-
Description

-
-
Details
struct xmlParserInputBuffer
struct xmlParserInputBuffer {
-
-    void*                  context;
-    xmlInputReadCallback   readcallback;
-    xmlInputCloseCallback  closecallback;
-    
-    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
-    
-    xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 */
-    xmlBufferPtr raw;       /* if encoder != NULL buffer for raw input */
-    int	compressed;	    /* -1=unknown, 0=not compressed, 1=compressed */
-    int error;
-};
-

-
-
xmlParserInputBufferPtr
typedef xmlParserInputBuffer *xmlParserInputBufferPtr;
-

-
-
struct xmlOutputBuffer
struct xmlOutputBuffer {
-
-    void*                   context;
-    xmlOutputWriteCallback  writecallback;
-    xmlOutputCloseCallback  closecallback;
-    
-    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
-    
-    xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 or ISOLatin */
-    xmlBufferPtr conv;      /* if encoder != NULL buffer for output */
-    int written;            /* total number of byte written */
-    int error;
-};
-

-
-
xmlOutputBufferPtr
typedef xmlOutputBuffer *xmlOutputBufferPtr;
-

-
-
struct xmlParserInput
struct xmlParserInput {
-
-    /* Input buffer */
-    xmlParserInputBufferPtr buf;      /* UTF-8 encoded buffer */
-
-    const char *filename;             /* The file analyzed, if any */
-    const char *directory;            /* the directory/base of the file */
-    const xmlChar *base;              /* Base of the array to parse */
-    const xmlChar *cur;               /* Current char being parsed */
-    const xmlChar *end;               /* end of the array to parse */
-    int length;                       /* length if known */
-    int line;                         /* Current line */
-    int col;                          /* Current column */
-    /*
-     * NOTE: consumed is only tested for equality in the parser code,
-     *       so even if there is an overflow this should not give troubles
-     *       for parsing very large instances.
-     */
-    unsigned long consumed;           /* How many xmlChars already consumed */
-    xmlParserInputDeallocate free;    /* function to deallocate the base */
-    const xmlChar *encoding;          /* the encoding string for entity */
-    const xmlChar *version;           /* the version string for entity */
-    int standalone;                   /* Was that entity marked standalone */
-    int id;                           /* an unique identifier for the entity */
-};
-

-An xmlParserInput is an input flow for the XML processor.
-Each entity parsed is associated an xmlParserInput (except the
-few predefined ones). This is the case both for internal entities
-- in which case the flow is already completely in memory - or
-external entities - in which case we use the buf structure for
-progressive reading and I18N conversions to the internal UTF-8 format.

-
-
xmlParserInputPtr
typedef xmlParserInput *xmlParserInputPtr;
-

-
-
struct xmlParserCtxt
struct xmlParserCtxt {
-
-    struct _xmlSAXHandler *sax;       /* The SAX handler */
-    void            *userData;        /* For SAX interface only, used by DOM build */
-    xmlDocPtr           myDoc;        /* the document being built */
-    int            wellFormed;        /* is the document well formed */
-    int       replaceEntities;        /* shall we replace entities ? */
-    const xmlChar    *version;        /* the XML version string */
-    const xmlChar   *encoding;        /* the declared encoding, if any */
-    int            standalone;        /* standalone document */
-    int                  html;        /* an HTML(1)/Docbook(2) document */
-
-    /* Input stream stack */
-    xmlParserInputPtr  input;         /* Current input stream */
-    int                inputNr;       /* Number of current input streams */
-    int                inputMax;      /* Max number of input streams */
-    xmlParserInputPtr *inputTab;      /* stack of inputs */
-
-    /* Node analysis stack only used for DOM building */
-    xmlNodePtr         node;          /* Current parsed Node */
-    int                nodeNr;        /* Depth of the parsing stack */
-    int                nodeMax;       /* Max depth of the parsing stack */
-    xmlNodePtr        *nodeTab;       /* array of nodes */
-
-    int record_info;                  /* Whether node info should be kept */
-    xmlParserNodeInfoSeq node_seq;    /* info about each node parsed */
-
-    int errNo;                        /* error code */
-
-    int     hasExternalSubset;        /* reference and external subset */
-    int             hasPErefs;        /* the internal subset has PE refs */
-    int              external;        /* are we parsing an external entity */
-
-    int                 valid;        /* is the document valid */
-    int              validate;        /* shall we try to validate ? */
-    xmlValidCtxt        vctxt;        /* The validity context */
-
-    xmlParserInputState instate;      /* current type of input */
-    int                 token;        /* next char look-ahead */    
-
-    char           *directory;        /* the data directory */
-
-    /* Node name stack */
-    const xmlChar     *name;          /* Current parsed Node */
-    int                nameNr;        /* Depth of the parsing stack */
-    int                nameMax;       /* Max depth of the parsing stack */
-    const xmlChar *   *nameTab;       /* array of nodes */
-
-    long               nbChars;       /* number of xmlChar processed */
-    long            checkIndex;       /* used by progressive parsing lookup */
-    int             keepBlanks;       /* ugly but ... */
-    int             disableSAX;       /* SAX callbacks are disabled */
-    int               inSubset;       /* Parsing is in int 1/ext 2 subset */
-    const xmlChar *    intSubName;    /* name of subset */
-    xmlChar *          extSubURI;     /* URI of external subset */
-    xmlChar *          extSubSystem;  /* SYSTEM ID of external subset */
-
-    /* xml:space values */
-    int *              space;         /* Should the parser preserve spaces */
-    int                spaceNr;       /* Depth of the parsing stack */
-    int                spaceMax;      /* Max depth of the parsing stack */
-    int *              spaceTab;      /* array of space infos */
-
-    int                depth;         /* to prevent entity substitution loops */
-    xmlParserInputPtr  entity;        /* used to check entities boundaries */
-    int                charset;       /* encoding of the in-memory content
-				         actually an xmlCharEncoding */
-    int                nodelen;       /* Those two fields are there to */
-    int                nodemem;       /* Speed up large node parsing */
-    int                pedantic;      /* signal pedantic warnings */
-    void              *_private;      /* For user data, libxml won't touch it */
-
-    int                loadsubset;    /* should the external subset be loaded */
-    int                linenumbers;   /* set line number in element content */
-    void              *catalogs;       /* document's own catalog */
-    int                recovery;      /* run in recovery mode */
-    int                progressive;   /* is this a progressive parsing */
-    xmlDictPtr         dict;          /* dictionnary for the parser */
-    const xmlChar *   *atts;          /* array for the attributes callbacks */
-    int                maxatts;       /* the size of the array */
-    int                docdict;       /* use strings from dict to build tree */
-
-    /*
-     * pre-interned strings
-     */
-    const xmlChar *str_xml;
-    const xmlChar *str_xmlns;
-    const xmlChar *str_xml_ns;
-
-    /*
-     * Everything below is used only by the new SAX mode
-     */
-    int                sax2;          /* operating in the new SAX mode */
-    int                nsNr;          /* the number of inherited namespaces */
-    int                nsMax;         /* the size of the arrays */
-    const xmlChar *   *nsTab;         /* the array of prefix/namespace name */
-    int               *attallocs;     /* which attribute were allocated */
-    void *            *pushTab;       /* array of data for push */
-    xmlHashTablePtr    attsDefault;   /* defaulted attributes if any */
-    xmlHashTablePtr    attsSpecial;   /* non-CDATA attributes if any */
-    int                nsWellFormed;  /* is the document XML Nanespace okay */
-    int                options;       /* Extra options */
-
-    /*
-     * Those fields are needed only for treaming parsing so far
-     */
-    int               dictNames;    /* Use dictionary names for the tree */
-    int               freeElemsNr;  /* number of freed element nodes */
-    xmlNodePtr        freeElems;    /* List of freed element nodes */
-    int               freeAttrsNr;  /* number of freed attributes nodes */
-    xmlAttrPtr        freeAttrs;    /* List of freed attributes nodes */
-
-    /*
-     * the complete error informations for the last error.
-     */
-    xmlError          lastError;
-};
-

-The parser context.
-NOTE This doesn't completely define the parser state, the (current ?)
-     design of the parser uses recursive function calls since this allow
-     and easy mapping from the production rules of the specification
-     to the actual code. The drawback is that the actual function call
-     also reflect the parser state. However most of the parsing routines
-     takes as the only argument the parser context pointer, so migrating
-     to a state based parser for progressive parsing shouldn't be too hard.

-
-
xmlParserCtxtPtr
typedef xmlParserCtxt *xmlParserCtxtPtr;
-

-
-
struct xmlSAXLocator
struct xmlSAXLocator {
-
-    const xmlChar *(*getPublicId)(void *ctx);
-    const xmlChar *(*getSystemId)(void *ctx);
-    int (*getLineNumber)(void *ctx);
-    int (*getColumnNumber)(void *ctx);
-};
-

-A SAX Locator.

-
-
xmlSAXLocatorPtr
typedef xmlSAXLocator *xmlSAXLocatorPtr;
-

-
-
struct xmlSAXHandler
struct xmlSAXHandler {
-
-    internalSubsetSAXFunc internalSubset;
-    isStandaloneSAXFunc isStandalone;
-    hasInternalSubsetSAXFunc hasInternalSubset;
-    hasExternalSubsetSAXFunc hasExternalSubset;
-    resolveEntitySAXFunc resolveEntity;
-    getEntitySAXFunc getEntity;
-    entityDeclSAXFunc entityDecl;
-    notationDeclSAXFunc notationDecl;
-    attributeDeclSAXFunc attributeDecl;
-    elementDeclSAXFunc elementDecl;
-    unparsedEntityDeclSAXFunc unparsedEntityDecl;
-    setDocumentLocatorSAXFunc setDocumentLocator;
-    startDocumentSAXFunc startDocument;
-    endDocumentSAXFunc endDocument;
-    startElementSAXFunc startElement;
-    endElementSAXFunc endElement;
-    referenceSAXFunc reference;
-    charactersSAXFunc characters;
-    ignorableWhitespaceSAXFunc ignorableWhitespace;
-    processingInstructionSAXFunc processingInstruction;
-    commentSAXFunc comment;
-    warningSAXFunc warning;
-    errorSAXFunc error;
-    fatalErrorSAXFunc fatalError; /* unused error() get all the errors */
-    getParameterEntitySAXFunc getParameterEntity;
-    cdataBlockSAXFunc cdataBlock;
-    externalSubsetSAXFunc externalSubset;
-    unsigned int initialized;
-    /* The following fields are extensions available only on version 2 */
-    void *_private;
-    startElementNsSAX2Func startElementNs;
-    endElementNsSAX2Func endElementNs;
-    xmlStructuredErrorFunc serror;
-};
-

-A SAX handler is bunch of callbacks called by the parser when processing
-of the input generate data or structure informations.

-
-
xmlSAXHandlerPtr
typedef xmlSAXHandler *xmlSAXHandlerPtr;
-

-
-
struct xmlEntity
struct xmlEntity {
-
-    void           *_private;	        /* application data */
-    xmlElementType          type;       /* XML_ENTITY_DECL, must be second ! */
-    const xmlChar          *name;	/* Entity name */
-    struct _xmlNode    *children;	/* First child link */
-    struct _xmlNode        *last;	/* Last child link */
-    struct _xmlDtd       *parent;	/* -> DTD */
-    struct _xmlNode        *next;	/* next sibling link  */
-    struct _xmlNode        *prev;	/* previous sibling link  */
-    struct _xmlDoc          *doc;       /* the containing document */
-
-    xmlChar                *orig;	/* content without ref substitution */
-    xmlChar             *content;	/* content or ndata if unparsed */
-    int                   length;	/* the content length */
-    xmlEntityType          etype;	/* The entity type */
-    const xmlChar    *ExternalID;	/* External identifier for PUBLIC */
-    const xmlChar      *SystemID;	/* URI for a SYSTEM or PUBLIC Entity */
-
-    struct _xmlEntity     *nexte;	/* unused */
-    const xmlChar           *URI;	/* the full URI as computed */
-    int                    owner;	/* does the entity own the childrens */
-};
-

-
-
xmlEntityPtr
typedef xmlEntity *xmlEntityPtr;
-

-
-
BASE_BUFFER_SIZE
#define BASE_BUFFER_SIZE 4096
-

-default buffer size 4000.

-
-
XML_XML_NAMESPACE
#define     XML_XML_NAMESPACE

-This is the namespace for the special xml: prefix predefined in the
-XML Namespace specification.

-
-
enum xmlElementType
typedef enum {
-    XML_ELEMENT_NODE=		1,
-    XML_ATTRIBUTE_NODE=		2,
-    XML_TEXT_NODE=		3,
-    XML_CDATA_SECTION_NODE=	4,
-    XML_ENTITY_REF_NODE=	5,
-    XML_ENTITY_NODE=		6,
-    XML_PI_NODE=		7,
-    XML_COMMENT_NODE=		8,
-    XML_DOCUMENT_NODE=		9,
-    XML_DOCUMENT_TYPE_NODE=	10,
-    XML_DOCUMENT_FRAG_NODE=	11,
-    XML_NOTATION_NODE=		12,
-    XML_HTML_DOCUMENT_NODE=	13,
-    XML_DTD_NODE=		14,
-    XML_ELEMENT_DECL=		15,
-    XML_ATTRIBUTE_DECL=		16,
-    XML_ENTITY_DECL=		17,
-    XML_NAMESPACE_DECL=		18,
-    XML_XINCLUDE_START=		19,
-    XML_XINCLUDE_END=		20
-#ifdef LIBXML_DOCB_ENABLED
-   ,XML_DOCB_DOCUMENT_NODE=	21
-#endif
-} xmlElementType;
-

-
-
xmlChar
typedef unsigned char xmlChar;
-

-This is a basic byte in an UTF-8 encoded string.
-It's unsigned allowing to pinpoint case where char * are assigned
-to xmlChar * (possibly making serialization back impossible).

-
-
BAD_CAST
#define BAD_CAST (xmlChar *)
-

-Macro to cast a string to an xmlChar * when one know its safe.

-
-
struct xmlNotation
struct xmlNotation {
-
-    const xmlChar               *name;	        /* Notation name */
-    const xmlChar               *PublicID;	/* Public identifier, if any */
-    const xmlChar               *SystemID;	/* System identifier, if any */
-};
-

-A DTD Notation definition.

-
-
xmlNotationPtr
typedef xmlNotation *xmlNotationPtr;
-

-
-
enum xmlAttributeType
typedef enum {
-    XML_ATTRIBUTE_CDATA = 1,
-    XML_ATTRIBUTE_ID,
-    XML_ATTRIBUTE_IDREF	,
-    XML_ATTRIBUTE_IDREFS,
-    XML_ATTRIBUTE_ENTITY,
-    XML_ATTRIBUTE_ENTITIES,
-    XML_ATTRIBUTE_NMTOKEN,
-    XML_ATTRIBUTE_NMTOKENS,
-    XML_ATTRIBUTE_ENUMERATION,
-    XML_ATTRIBUTE_NOTATION
-} xmlAttributeType;
-

-A DTD Attribute type definition.

-
-
enum xmlAttributeDefault
typedef enum {
-    XML_ATTRIBUTE_NONE = 1,
-    XML_ATTRIBUTE_REQUIRED,
-    XML_ATTRIBUTE_IMPLIED,
-    XML_ATTRIBUTE_FIXED
-} xmlAttributeDefault;
-

-A DTD Attribute default definition.

-
-
struct xmlEnumeration
struct xmlEnumeration {
-
-    struct _xmlEnumeration    *next;	/* next one */
-    const xmlChar            *name;	/* Enumeration name */
-};
-

-List structure used when there is an enumeration in DTDs.

-
-
xmlEnumerationPtr
typedef xmlEnumeration *xmlEnumerationPtr;
-

-
-
struct xmlAttribute
struct xmlAttribute {
-
-    void           *_private;	        /* application data */
-    xmlElementType          type;       /* XML_ATTRIBUTE_DECL, must be second ! */
-    const xmlChar          *name;	/* Attribute name */
-    struct _xmlNode    *children;	/* NULL */
-    struct _xmlNode        *last;	/* NULL */
-    struct _xmlDtd       *parent;	/* -> DTD */
-    struct _xmlNode        *next;	/* next sibling link  */
-    struct _xmlNode        *prev;	/* previous sibling link  */
-    struct _xmlDoc          *doc;       /* the containing document */
-
-    struct _xmlAttribute  *nexth;	/* next in hash table */
-    xmlAttributeType       atype;	/* The attribute type */
-    xmlAttributeDefault      def;	/* the default */
-    const xmlChar  *defaultValue;	/* or the default value */
-    xmlEnumerationPtr       tree;       /* or the enumeration tree if any */
-    const xmlChar        *prefix;	/* the namespace prefix if any */
-    const xmlChar          *elem;	/* Element holding the attribute */
-};
-

-An Attribute declaration in a DTD.

-
-
xmlAttributePtr
typedef xmlAttribute *xmlAttributePtr;
-

-
-
enum xmlElementContentType
typedef enum {
-    XML_ELEMENT_CONTENT_PCDATA = 1,
-    XML_ELEMENT_CONTENT_ELEMENT,
-    XML_ELEMENT_CONTENT_SEQ,
-    XML_ELEMENT_CONTENT_OR
-} xmlElementContentType;
-

-Possible definitions of element content types.

-
-
enum xmlElementContentOccur
typedef enum {
-    XML_ELEMENT_CONTENT_ONCE = 1,
-    XML_ELEMENT_CONTENT_OPT,
-    XML_ELEMENT_CONTENT_MULT,
-    XML_ELEMENT_CONTENT_PLUS
-} xmlElementContentOccur;
-

-Possible definitions of element content occurrences.

-
-
struct xmlElementContent
struct xmlElementContent {
-
-    xmlElementContentType     type;	/* PCDATA, ELEMENT, SEQ or OR */
-    xmlElementContentOccur    ocur;	/* ONCE, OPT, MULT or PLUS */
-    const xmlChar             *name;	/* Element name */
-    struct _xmlElementContent *c1;	/* first child */
-    struct _xmlElementContent *c2;	/* second child */
-    struct _xmlElementContent *parent;	/* parent */
-    const xmlChar             *prefix;	/* Namespace prefix */
-};
-

-An XML Element content as stored after parsing an element definition
-in a DTD.

-
-
xmlElementContentPtr
typedef xmlElementContent *xmlElementContentPtr;
-

-
-
enum xmlElementTypeVal
typedef enum {
-    XML_ELEMENT_TYPE_UNDEFINED = 0,
-    XML_ELEMENT_TYPE_EMPTY = 1,
-    XML_ELEMENT_TYPE_ANY,
-    XML_ELEMENT_TYPE_MIXED,
-    XML_ELEMENT_TYPE_ELEMENT
-} xmlElementTypeVal;
-

-The different possibilities for an element content type.

-
-
struct xmlElement
struct xmlElement {
-
-    void           *_private;	        /* application data */
-    xmlElementType          type;       /* XML_ELEMENT_DECL, must be second ! */
-    const xmlChar          *name;	/* Element name */
-    struct _xmlNode    *children;	/* NULL */
-    struct _xmlNode        *last;	/* NULL */
-    struct _xmlDtd       *parent;	/* -> DTD */
-    struct _xmlNode        *next;	/* next sibling link  */
-    struct _xmlNode        *prev;	/* previous sibling link  */
-    struct _xmlDoc          *doc;       /* the containing document */
-
-    xmlElementTypeVal      etype;	/* The type */
-    xmlElementContentPtr content;	/* the allowed element content */
-    xmlAttributePtr   attributes;	/* List of the declared attributes */
-    const xmlChar        *prefix;	/* the namespace prefix if any */
-#ifdef LIBXML_REGEXP_ENABLED
-    xmlRegexpPtr       contModel;	/* the validating regexp */
-#else
-    void	      *contModel;
-#endif
-};
-

-An XML Element declaration from a DTD.

-
-
xmlElementPtr
typedef xmlElement *xmlElementPtr;
-

-
-
XML_LOCAL_NAMESPACE
#define XML_LOCAL_NAMESPACE XML_NAMESPACE_DECL
-

-A namespace declaration node.

-
-
xmlNsType
typedef xmlElementType xmlNsType;
-

-
-
struct xmlNs
struct xmlNs {
-
-    struct _xmlNs  *next;	/* next Ns link for this node  */
-    xmlNsType      type;	/* global or local */
-    const xmlChar *href;	/* URL for the namespace */
-    const xmlChar *prefix;	/* prefix for the namespace */
-    void           *_private;   /* application data */
-};
-

-An XML namespace.
-Note that prefix == NULL is valid, it defines the default namespace
-within the subtree (until overridden).
-

-xmlNsType is unified with xmlElementType.

-
-
xmlNsPtr
typedef xmlNs *xmlNsPtr;
-

-
-
struct xmlDtd
struct xmlDtd {
-
-    void           *_private;	/* application data */
-    xmlElementType  type;       /* XML_DTD_NODE, must be second ! */
-    const xmlChar *name;	/* Name of the DTD */
-    struct _xmlNode *children;	/* the value of the property link */
-    struct _xmlNode *last;	/* last child link */
-    struct _xmlDoc  *parent;	/* child->parent link */
-    struct _xmlNode *next;	/* next sibling link  */
-    struct _xmlNode *prev;	/* previous sibling link  */
-    struct _xmlDoc  *doc;	/* the containing document */
-
-    /* End of common part */
-    void          *notations;   /* Hash table for notations if any */
-    void          *elements;    /* Hash table for elements if any */
-    void          *attributes;  /* Hash table for attributes if any */
-    void          *entities;    /* Hash table for entities if any */
-    const xmlChar *ExternalID;	/* External identifier for PUBLIC DTD */
-    const xmlChar *SystemID;	/* URI for a SYSTEM or PUBLIC DTD */
-    void          *pentities;   /* Hash table for param entities if any */
-};
-

-An XML DTD, as defined by <!DOCTYPE ... There is actually one for
-the internal subset and for the external subset.

-
-
xmlDtdPtr
typedef xmlDtd *xmlDtdPtr;
-

-
-
struct xmlAttr
struct xmlAttr {
-
-    void           *_private;	/* application data */
-    xmlElementType   type;      /* XML_ATTRIBUTE_NODE, must be second ! */
-    const xmlChar   *name;      /* the name of the property */
-    struct _xmlNode *children;	/* the value of the property */
-    struct _xmlNode *last;	/* NULL */
-    struct _xmlNode *parent;	/* child->parent link */
-    struct _xmlAttr *next;	/* next sibling link  */
-    struct _xmlAttr *prev;	/* previous sibling link  */
-    struct _xmlDoc  *doc;	/* the containing document */
-    xmlNs           *ns;        /* pointer to the associated namespace */
-    xmlAttributeType atype;     /* the attribute type if validating */
-    void            *psvi;	/* for type/PSVI informations */
-};
-

-An attribute on an XML node.

-
-
xmlAttrPtr
typedef xmlAttr *xmlAttrPtr;
-

-
-
struct xmlID
struct xmlID {
-
-    struct _xmlID    *next;	/* next ID */
-    const xmlChar    *value;	/* The ID name */
-    xmlAttrPtr        attr;	/* The attribute holding it */
-    const xmlChar    *name;	/* The attribute if attr is not available */
-    int               lineno;	/* The line number if attr is not available */
-    struct _xmlDoc   *doc;	/* The document holding the ID */
-};
-

-An XML ID instance.

-
-
xmlIDPtr
typedef xmlID *xmlIDPtr;
-

-
-
struct xmlRef
struct xmlRef {
-
-    struct _xmlRef    *next;	/* next Ref */
-    const xmlChar     *value;	/* The Ref name */
-    xmlAttrPtr        attr;	/* The attribute holding it */
-    const xmlChar    *name;	/* The attribute if attr is not available */
-    int               lineno;	/* The line number if attr is not available */
-};
-

-An XML IDREF instance.

-
-
xmlRefPtr
typedef xmlRef *xmlRefPtr;
-

-
-
enum xmlBufferAllocationScheme
typedef enum {
-    XML_BUFFER_ALLOC_DOUBLEIT,
-    XML_BUFFER_ALLOC_EXACT,
-    XML_BUFFER_ALLOC_IMMUTABLE
-} xmlBufferAllocationScheme;
-

-A buffer allocation scheme can be defined to either match exactly the
-need or double it's allocated size each time it is found too small.

-
-
struct xmlBuffer
struct xmlBuffer {
-
-    xmlChar *content;		/* The buffer content UTF8 */
-    unsigned int use;		/* The buffer size used */
-    unsigned int size;		/* The buffer size */
-    xmlBufferAllocationScheme alloc; /* The realloc method */
-};
-

-A buffer structure.

-
-
xmlBufferPtr
typedef xmlBuffer *xmlBufferPtr;
-

-
-
struct xmlNode
struct xmlNode {
-
-    void           *_private;	/* application data */
-    xmlElementType   type;	/* type number, must be second ! */
-    const xmlChar   *name;      /* the name of the node, or the entity */
-    struct _xmlNode *children;	/* parent->childs link */
-    struct _xmlNode *last;	/* last child link */
-    struct _xmlNode *parent;	/* child->parent link */
-    struct _xmlNode *next;	/* next sibling link  */
-    struct _xmlNode *prev;	/* previous sibling link  */
-    struct _xmlDoc  *doc;	/* the containing document */
-
-    /* End of common part */
-    xmlNs           *ns;        /* pointer to the associated namespace */
-    xmlChar         *content;   /* the content */
-    struct _xmlAttr *properties;/* properties list */
-    xmlNs           *nsDef;     /* namespace definitions on this node */
-    void            *psvi;	/* for type/PSVI informations */
-    unsigned short   line;	/* line number */
-    unsigned short   extra;	/* extra data for XPath/XSLT */
-};
-

-A node in an XML tree.

-
-
xmlNodePtr
typedef xmlNode *xmlNodePtr;
-

-
-
XML_GET_CONTENT()
#define     XML_GET_CONTENT(n)

-Macro to extract the content pointer of a node.

-
-
n:
-
-
-
XML_GET_LINE()
#define     XML_GET_LINE(n)

-Macro to extract the line number of an element node. 
-This will work only if line numbering is activated by
-calling xmlLineNumbersDefault(1) before parsing.

-
-
n:
-
-
-
struct xmlDoc
struct xmlDoc {
-
-    void           *_private;	/* application data */
-    xmlElementType  type;       /* XML_DOCUMENT_NODE, must be second ! */
-    char           *name;	/* name/filename/URI of the document */
-    struct _xmlNode *children;	/* the document tree */
-    struct _xmlNode *last;	/* last child link */
-    struct _xmlNode *parent;	/* child->parent link */
-    struct _xmlNode *next;	/* next sibling link  */
-    struct _xmlNode *prev;	/* previous sibling link  */
-    struct _xmlDoc  *doc;	/* autoreference to itself */
-
-    /* End of common part */
-    int             compression;/* level of zlib compression */
-    int             standalone; /* standalone document (no external refs) */
-    struct _xmlDtd  *intSubset;	/* the document internal subset */
-    struct _xmlDtd  *extSubset;	/* the document external subset */
-    struct _xmlNs   *oldNs;	/* Global namespace, the old way */
-    const xmlChar  *version;	/* the XML version string */
-    const xmlChar  *encoding;   /* external initial encoding, if any */
-    void           *ids;        /* Hash table for ID attributes if any */
-    void           *refs;       /* Hash table for IDREFs attributes if any */
-    const xmlChar  *URL;	/* The URI for that document */
-    int             charset;    /* encoding of the in-memory content
-				   actually an xmlCharEncoding */
-    struct _xmlDict *dict;      /* dict used to allocate names or NULL */
-    void           *psvi;	/* for type/PSVI informations */
-};
-

-An XML document.

-
-
xmlDocPtr
typedef xmlDoc *xmlDocPtr;
-

-
-
xmlChildrenNode
#define xmlChildrenNode children
-

-Macro for compatibility naming layer with libxml1.

-
-
xmlRootNode
#define xmlRootNode children
-

-Macro for compatibility naming layer with libxml1.

-
-
xmlValidateNCName ()
int         xmlValidateNCName               (const xmlChar *value,
-                                             int space);

-Check that a value conforms to the lexical space of NCName

-
-
value: the value to check
-
space: allow spaces in front and end of the string
-
Returns :0 if this validates, a positive error code number otherwise
-        and -1 in case of internal or API error.
-
xmlValidateQName ()
int         xmlValidateQName                (const xmlChar *value,
-                                             int space);

-Check that a value conforms to the lexical space of QName

-
-
value: the value to check
-
space: allow spaces in front and end of the string
-
Returns :0 if this validates, a positive error code number otherwise
-        and -1 in case of internal or API error.
-
xmlValidateName ()
int         xmlValidateName                 (const xmlChar *value,
-                                             int space);

-Check that a value conforms to the lexical space of Name

-
-
value: the value to check
-
space: allow spaces in front and end of the string
-
Returns :0 if this validates, a positive error code number otherwise
-        and -1 in case of internal or API error.
-
xmlValidateNMToken ()
int         xmlValidateNMToken              (const xmlChar *value,
-                                             int space);

-Check that a value conforms to the lexical space of NMToken

-
-
value: the value to check
-
space: allow spaces in front and end of the string
-
Returns :0 if this validates, a positive error code number otherwise
-        and -1 in case of internal or API error.
-
xmlBuildQName ()
xmlChar*    xmlBuildQName                   (const xmlChar *ncname,
-                                             const xmlChar *prefix,
-                                             xmlChar *memory,
-                                             int len);

-Builds the QName prefix:ncname in memory if there is enough space
-and prefix is not NULL nor empty, otherwise allocate a new string.
-If prefix is NULL or empty it returns ncname.

-
-
ncname:  the Name
-
prefix:  the prefix
-
memory:  preallocated memory
-
len:  preallocated memory length
-
Returns :the new string which must be freed by the caller if different from
-        memory and ncname or NULL in case of error
-
xmlSplitQName2 ()
xmlChar*    xmlSplitQName2                  (const xmlChar *name,
-                                             xmlChar **prefix);

-parse an XML qualified name string
-

-[NS 5] QName ::= (Prefix ':')? LocalPart
-

-[NS 6] Prefix ::= NCName
-

-[NS 7] LocalPart ::= NCName

-
-
name:  the full QName
-
prefix:  a xmlChar ** 
-
Returns :NULL if not a QName, otherwise the local part, and prefix
-  is updated to get the Prefix if any.
-
xmlSplitQName3 ()
const xmlChar* xmlSplitQName3               (const xmlChar *name,
-                                             int *len);

-parse an XML qualified name string,i

-
-
name:  the full QName
-
len: an int *
-
Returns :NULL if it is not a Qualified Name, otherwise, update len
-        with the lenght in byte of the prefix and return a pointer
-
xmlSetBufferAllocationScheme ()
void        xmlSetBufferAllocationScheme    (xmlBufferAllocationScheme scheme);

-Set the buffer allocation method.  Types are
-XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down
-XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, 
-                            improves performance

-
-
scheme:  allocation method to use
-
xmlGetBufferAllocationScheme ()
xmlBufferAllocationScheme xmlGetBufferAllocationScheme
-                                            (void);

-Types are
-XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down
-XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, 
-                            improves performance

-
-
Returns :the current allocation scheme
-
xmlBufferCreate ()
xmlBufferPtr xmlBufferCreate                (void);

-routine to create an XML buffer.

-
-
Returns :the new structure.
-
xmlBufferCreateSize ()
xmlBufferPtr xmlBufferCreateSize            (size_t size);

-routine to create an XML buffer.

-
-
size: initial size of buffer
-
Returns :the new structure.
-
xmlBufferCreateStatic ()
xmlBufferPtr xmlBufferCreateStatic          (void *mem,
-                                             size_t size);

-routine to create an XML buffer from an immutable memory area,
-The are won't be modified nor copied, and is expected to be
-present until the end of the buffer lifetime.

-
-
mem: the memory area
-
size:  the size in byte
-
Returns :the new structure.
-
xmlBufferResize ()
int         xmlBufferResize                 (xmlBufferPtr buf,
-                                             unsigned int size);

-Resize a buffer to accommodate minimum size of size.

-
-
buf:  the buffer to resize
-
size:  the desired size
-
Returns :0 in case of problems, 1 otherwise
-
xmlBufferFree ()
void        xmlBufferFree                   (xmlBufferPtr buf);

-Frees an XML buffer. It frees both the content and the structure which
-encapsulate it.

-
-
buf:  the buffer to free
-
xmlBufferDump ()
int         xmlBufferDump                   (FILE *file,
-                                             xmlBufferPtr buf);

-Dumps an XML buffer to  a FILE *.

-
-
file:  the file output
-
buf:  the buffer to dump
-
Returns :the number of xmlChar written
-
xmlBufferAdd ()
void        xmlBufferAdd                    (xmlBufferPtr buf,
-                                             const xmlChar *str,
-                                             int len);

-Add a string range to an XML buffer. if len == -1, the length of
-str is recomputed.

-
-
buf:  the buffer to dump
-
str:  the xmlChar string
-
len:  the number of xmlChar to add
-
xmlBufferAddHead ()
void        xmlBufferAddHead                (xmlBufferPtr buf,
-                                             const xmlChar *str,
-                                             int len);

-Add a string range to the beginning of an XML buffer.
-if len == -1, the length of str is recomputed.

-
-
buf:  the buffer
-
str:  the xmlChar string
-
len:  the number of xmlChar to add
-
xmlBufferCat ()
void        xmlBufferCat                    (xmlBufferPtr buf,
-                                             const xmlChar *str);

-Append a zero terminated string to an XML buffer.

-
-
buf:  the buffer to dump
-
str:  the xmlChar string
-
xmlBufferCCat ()
void        xmlBufferCCat                   (xmlBufferPtr buf,
-                                             const char *str);

-Append a zero terminated C string to an XML buffer.

-
-
buf:  the buffer to dump
-
str:  the C char string
-
xmlBufferShrink ()
int         xmlBufferShrink                 (xmlBufferPtr buf,
-                                             unsigned int len);

-Remove the beginning of an XML buffer.

-
-
buf:  the buffer to dump
-
len:  the number of xmlChar to remove
-
Returns :the number of xmlChar removed, or -1 in case of failure.
-
xmlBufferGrow ()
int         xmlBufferGrow                   (xmlBufferPtr buf,
-                                             unsigned int len);

-Grow the available space of an XML buffer.

-
-
buf:  the buffer
-
len:  the minimum free size to allocate
-
Returns :the new available space or -1 in case of error
-
xmlBufferEmpty ()
void        xmlBufferEmpty                  (xmlBufferPtr buf);

-empty a buffer.

-
-
buf:  the buffer
-
xmlBufferContent ()
const xmlChar* xmlBufferContent             (const xmlBufferPtr buf);

-Function to extract the content of a buffer

-
-
buf:  the buffer
-
Returns :the internal content
-
xmlBufferSetAllocationScheme ()
void        xmlBufferSetAllocationScheme    (xmlBufferPtr buf,
-                                             xmlBufferAllocationScheme scheme);

-Sets the allocation scheme for this buffer

-
-
buf:  the buffer to tune
-
scheme:  allocation scheme to use
-
xmlBufferLength ()
int         xmlBufferLength                 (const xmlBufferPtr buf);

-Function to get the length of a buffer

-
-
buf:  the buffer 
-
Returns :the length of data in the internal content
-
xmlCreateIntSubset ()
xmlDtdPtr   xmlCreateIntSubset              (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

-Create the internal subset of a document

-
-
doc:  the document pointer
-
name:  the DTD name
-
ExternalID:  the external (PUBLIC) ID
-
SystemID:  the system ID
-
Returns :a pointer to the new DTD structure
-
xmlNewDtd ()
xmlDtdPtr   xmlNewDtd                       (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *ExternalID,
-                                             const xmlChar *SystemID);

-Creation of a new DTD for the external subset. To create an
-internal subset, use xmlCreateIntSubset().

-
-
doc:  the document pointer
-
name:  the DTD name
-
ExternalID:  the external ID
-
SystemID:  the system ID
-
Returns :a pointer to the new DTD structure
-
xmlGetIntSubset ()
xmlDtdPtr   xmlGetIntSubset                 (xmlDocPtr doc);

-Get the internal subset of a document

-
-
doc:  the document pointer
-
Returns :a pointer to the DTD structure or NULL if not found
-
xmlFreeDtd ()
void        xmlFreeDtd                      (xmlDtdPtr cur);

-Free a DTD structure.

-
-
cur:  the DTD structure to free up
-
xmlNewGlobalNs ()
xmlNsPtr    xmlNewGlobalNs                  (xmlDocPtr doc,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);

-Creation of a Namespace, the old way using PI and without scoping
-  DEPRECATED !!!
-It now create a namespace on the root element of the document if found.

-
-
doc:  the document carrying the namespace
-
href:  the URI associated
-
prefix:  the prefix for the namespace
-
Returns :NULL this functionality had been removed
-
xmlNewNs ()
xmlNsPtr    xmlNewNs                        (xmlNodePtr node,
-                                             const xmlChar *href,
-                                             const xmlChar *prefix);

-Creation of a new Namespace. This function will refuse to create
-a namespace with a similar prefix than an existing one present on this
-node.
-We use href==NULL in the case of an element creation where the namespace
-was not defined.

-
-
node:  the element carrying the namespace
-
href:  the URI associated
-
prefix:  the prefix for the namespace
-
Returns :a new namespace pointer or NULL
-
xmlFreeNs ()
void        xmlFreeNs                       (xmlNsPtr cur);

-Free up the structures associated to a namespace

-
-
cur:  the namespace pointer
-
xmlFreeNsList ()
void        xmlFreeNsList                   (xmlNsPtr cur);

-Free up all the structures associated to the chained namespaces.

-
-
cur:  the first namespace pointer
-
xmlNewDoc ()
xmlDocPtr   xmlNewDoc                       (const xmlChar *version);

-Creates a new XML document

-
-
version:  xmlChar string giving the version of XML "1.0"
-
Returns :a new document
-
xmlFreeDoc ()
void        xmlFreeDoc                      (xmlDocPtr cur);

-Free up all the structures used by a document, tree included.

-
-
cur:  pointer to the document
-
xmlNewDocProp ()
xmlAttrPtr  xmlNewDocProp                   (xmlDocPtr doc,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Create a new property carried by a document.

-
-
doc:  the document
-
name:  the name of the attribute
-
value:  the value of the attribute
-
Returns :a pointer to the attribute
-
xmlNewProp ()
xmlAttrPtr  xmlNewProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Create a new property carried by a node.

-
-
node:  the holding node
-
name:  the name of the attribute
-
value:  the value of the attribute
-
Returns :a pointer to the attribute
-
xmlNewNsProp ()
xmlAttrPtr  xmlNewNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Create a new property tagged with a namespace and carried by a node.

-
-
node:  the holding node
-
ns:  the namespace
-
name:  the name of the attribute
-
value:  the value of the attribute
-
Returns :a pointer to the attribute
-
xmlNewNsPropEatName ()
xmlAttrPtr  xmlNewNsPropEatName             (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *value);

-Create a new property tagged with a namespace and carried by a node.

-
-
node:  the holding node
-
ns:  the namespace
-
name:  the name of the attribute
-
value:  the value of the attribute
-
Returns :a pointer to the attribute
-
xmlFreePropList ()
void        xmlFreePropList                 (xmlAttrPtr cur);

-Free a property and all its siblings, all the children are freed too.

-
-
cur:  the first property in the list
-
xmlFreeProp ()
void        xmlFreeProp                     (xmlAttrPtr cur);

-Free one attribute, all the content is freed too

-
-
cur:  an attribute
-
xmlCopyProp ()
xmlAttrPtr  xmlCopyProp                     (xmlNodePtr target,
-                                             xmlAttrPtr cur);

-Do a copy of the attribute.

-
-
target:  the element where the attribute will be grafted
-
cur:  the attribute
-
Returns : a new xmlAttrPtr, or NULL in case of error.
-
xmlCopyPropList ()
xmlAttrPtr  xmlCopyPropList                 (xmlNodePtr target,
-                                             xmlAttrPtr cur);

-Do a copy of an attribute list.

-
-
target:  the element where the attributes will be grafted
-
cur:  the first attribute
-
Returns : a new xmlAttrPtr, or NULL in case of error.
-
xmlCopyDtd ()
xmlDtdPtr   xmlCopyDtd                      (xmlDtdPtr dtd);

-Do a copy of the dtd.

-
-
dtd:  the dtd
-
Returns : a new xmlDtdPtr, or NULL in case of error.
-
xmlCopyDoc ()
xmlDocPtr   xmlCopyDoc                      (xmlDocPtr doc,
-                                             int recursive);

-Do a copy of the document info. If recursive, the content tree will
-be copied too as well as DTD, namespaces and entities.

-
-
doc:  the document
-
recursive:  if 1 do a recursive copy.
-
Returns : a new xmlDocPtr, or NULL in case of error.
-
xmlNewDocNode ()
xmlNodePtr  xmlNewDocNode                   (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-Creation of a new node element within a document. ns and content
-are optional (NULL).
-NOTE: content is supposed to be a piece of XML CDATA, so it allow entities
-      references, but XML special chars need to be escaped first by using
-      xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't
-      need entities support.

-
-
doc:  the document
-
ns:  namespace if any
-
name:  the node name
-
content:  the XML text content if any
-
Returns :a pointer to the new node object.
-
xmlNewDocNodeEatName ()
xmlNodePtr  xmlNewDocNodeEatName            (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             xmlChar *name,
-                                             const xmlChar *content);

-Creation of a new node element within a document. ns and content
-are optional (NULL).
-NOTE: content is supposed to be a piece of XML CDATA, so it allow entities
-      references, but XML special chars need to be escaped first by using
-      xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't
-      need entities support.

-
-
doc:  the document
-
ns:  namespace if any
-
name:  the node name
-
content:  the XML text content if any
-
Returns :a pointer to the new node object.
-
xmlNewDocRawNode ()
xmlNodePtr  xmlNewDocRawNode                (xmlDocPtr doc,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-Creation of a new node element within a document. ns and content
-are optional (NULL).

-
-
doc:  the document
-
ns:  namespace if any
-
name:  the node name
-
content:  the text content if any
-
Returns :a pointer to the new node object.
-
xmlNewNode ()
xmlNodePtr  xmlNewNode                      (xmlNsPtr ns,
-                                             const xmlChar *name);

-Creation of a new node element. ns is optional (NULL).

-
-
ns:  namespace if any
-
name:  the node name
-
Returns :a pointer to the new node object. Uses xmlStrdup() to make
-copy of name.
-
xmlNewNodeEatName ()
xmlNodePtr  xmlNewNodeEatName               (xmlNsPtr ns,
-                                             xmlChar *name);

-Creation of a new node element. ns is optional (NULL).

-
-
ns:  namespace if any
-
name:  the node name
-
Returns :a pointer to the new node object, with pointer name as
-new node's name. Use xmlNewNode() if a copy of name string is
-is needed as new node's name.
-
xmlNewChild ()
xmlNodePtr  xmlNewChild                     (xmlNodePtr parent,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-Creation of a new child element, added at the end of parent children list.
-ns and content parameters are optional (NULL). If content is non NULL,
-a child list containing the TEXTs and ENTITY_REFs node will be created.
-NOTE: content is supposed to be a piece of XML CDATA, so it allow entities
-      references, but XML special chars need to be escaped first by using
-      xmlEncodeEntitiesReentrant(). Use xmlNewTextChild() if entities
-      support is not needed.

-
-
parent:  the parent node
-
ns:  a namespace if any
-
name:  the name of the child
-
content:  the XML content of the child if any.
-
Returns :a pointer to the new node object.
-
xmlNewTextChild ()
xmlNodePtr  xmlNewTextChild                 (xmlNodePtr parent,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-Creation of a new child element, added at the end of parent children list.
-ns and content parameters are optional (NULL). If content is non NULL,
-a child TEXT node will be created containing the string content.
-NOTE: Use xmlNewChild() if entity support for content is needed.

-
-
parent:  the parent node
-
ns:  a namespace if any
-
name:  the name of the child
-
content:  the text content of the child if any.
-
Returns :a pointer to the new node object.
-
xmlNewDocText ()
xmlNodePtr  xmlNewDocText                   (xmlDocPtr doc,
-                                             const xmlChar *content);

-Creation of a new text node within a document.

-
-
doc: the document
-
content:  the text content
-
Returns :a pointer to the new node object.
-
xmlNewText ()
xmlNodePtr  xmlNewText                      (const xmlChar *content);

-Creation of a new text node.

-
-
content:  the text content
-
Returns :a pointer to the new node object.
-
xmlNewPI ()
xmlNodePtr  xmlNewPI                        (const xmlChar *name,
-                                             const xmlChar *content);

-Creation of a processing instruction element.

-
-
name:  the processing instruction name
-
content:  the PI content
-
Returns :a pointer to the new node object.
-
xmlNewDocTextLen ()
xmlNodePtr  xmlNewDocTextLen                (xmlDocPtr doc,
-                                             const xmlChar *content,
-                                             int len);

-Creation of a new text node with an extra content length parameter. The
-text node pertain to a given document.

-
-
doc: the document
-
content:  the text content
-
len:  the text len.
-
Returns :a pointer to the new node object.
-
xmlNewTextLen ()
xmlNodePtr  xmlNewTextLen                   (const xmlChar *content,
-                                             int len);

-Creation of a new text node with an extra parameter for the content's length

-
-
content:  the text content
-
len:  the text len.
-
Returns :a pointer to the new node object.
-
xmlNewDocComment ()
xmlNodePtr  xmlNewDocComment                (xmlDocPtr doc,
-                                             const xmlChar *content);

-Creation of a new node containing a comment within a document.

-
-
doc:  the document
-
content:  the comment content
-
Returns :a pointer to the new node object.
-
xmlNewComment ()
xmlNodePtr  xmlNewComment                   (const xmlChar *content);

-Creation of a new node containing a comment.

-
-
content:  the comment content
-
Returns :a pointer to the new node object.
-
xmlNewCDataBlock ()
xmlNodePtr  xmlNewCDataBlock                (xmlDocPtr doc,
-                                             const xmlChar *content,
-                                             int len);

-Creation of a new node containing a CDATA block.

-
-
doc:  the document
-
content:  the CDATA block content content
-
len:  the length of the block
-
Returns :a pointer to the new node object.
-
xmlNewCharRef ()
xmlNodePtr  xmlNewCharRef                   (xmlDocPtr doc,
-                                             const xmlChar *name);

-Creation of a new character reference node.

-
-
doc: the document
-
name:  the char ref string, starting with # or "&# ... ;"
-
Returns :a pointer to the new node object.
-
xmlNewReference ()
xmlNodePtr  xmlNewReference                 (xmlDocPtr doc,
-                                             const xmlChar *name);

-Creation of a new reference node.

-
-
doc: the document
-
name:  the reference name, or the reference string with & and ;
-
Returns :a pointer to the new node object.
-
xmlCopyNode ()
xmlNodePtr  xmlCopyNode                     (const xmlNodePtr node,
-                                             int recursive);

-Do a copy of the node.

-
-
node:  the node
-
recursive:  if 1 do a recursive copy.
-
Returns : a new xmlNodePtr, or NULL in case of error.
-
xmlDocCopyNode ()
xmlNodePtr  xmlDocCopyNode                  (const xmlNodePtr node,
-                                             xmlDocPtr doc,
-                                             int recursive);

-Do a copy of the node to a given document.

-
-
node:  the node
-
doc:  the document
-
recursive:  if 1 do a recursive copy.
-
Returns : a new xmlNodePtr, or NULL in case of error.
-
xmlCopyNodeList ()
xmlNodePtr  xmlCopyNodeList                 (const xmlNodePtr node);

-Do a recursive copy of the node list.

-
-
node:  the first node in the list.
-
Returns : a new xmlNodePtr, or NULL in case of error.
-
xmlNewDocFragment ()
xmlNodePtr  xmlNewDocFragment               (xmlDocPtr doc);

-Creation of a new Fragment node.

-
-
doc:  the document owning the fragment
-
Returns :a pointer to the new node object.
-
xmlGetLineNo ()
long        xmlGetLineNo                    (xmlNodePtr node);

-Get line number of node. This requires activation of this option
-before invoking the parser by calling xmlLineNumbersDefault(1)

-
-
node: valid node
-
Returns :the line number if successful, -1 otherwise
-
xmlGetNodePath ()
xmlChar*    xmlGetNodePath                  (xmlNodePtr node);

-Build a structure based Path for the given node

-
-
node: a node
-
Returns :the new path or NULL in case of error. The caller must free
-    the returned string
-
xmlDocGetRootElement ()
xmlNodePtr  xmlDocGetRootElement            (xmlDocPtr doc);

-Get the root element of the document (doc->children is a list
-containing possibly comments, PIs, etc ...).

-
-
doc:  the document
-
Returns :the xmlNodePtr for the root or NULL
-
xmlGetLastChild ()
xmlNodePtr  xmlGetLastChild                 (xmlNodePtr parent);

-Search the last child of a node.

-
-
parent:  the parent node
-
Returns :the last child or NULL if none.
-
xmlNodeIsText ()
int         xmlNodeIsText                   (xmlNodePtr node);

-Is this node a Text node ?

-
-
node:  the node
-
Returns :1 yes, 0 no
-
xmlIsBlankNode ()
int         xmlIsBlankNode                  (xmlNodePtr node);

-Checks whether this node is an empty or whitespace only
-(and possibly ignorable) text-node.

-
-
node:  the node
-
Returns :1 yes, 0 no
-
xmlDocSetRootElement ()
xmlNodePtr  xmlDocSetRootElement            (xmlDocPtr doc,
-                                             xmlNodePtr root);

-Set the root element of the document (doc->children is a list
-containing possibly comments, PIs, etc ...).

-
-
doc:  the document
-
root:  the new document root element
-
Returns :the old root element if any was found
-
xmlNodeSetName ()
void        xmlNodeSetName                  (xmlNodePtr cur,
-                                             const xmlChar *name);

-Set (or reset) the name of a node.

-
-
cur:  the node being changed
-
name:  the new tag name
-
xmlAddChild ()
xmlNodePtr  xmlAddChild                     (xmlNodePtr parent,
-                                             xmlNodePtr cur);

-Add a new node to parent, at the end of the child (or property) list
-merging adjacent TEXT nodes (in which case cur is freed)
-If the new node is ATTRIBUTE, it is added into properties instead of children.
-If there is an attribute with equal name, it is first destroyed.

-
-
parent:  the parent node
-
cur:  the child node
-
Returns :the child or NULL in case of error.
-
xmlAddChildList ()
xmlNodePtr  xmlAddChildList                 (xmlNodePtr parent,
-                                             xmlNodePtr cur);

-Add a list of node at the end of the child list of the parent
-merging adjacent TEXT nodes (cur may be freed)

-
-
parent:  the parent node
-
cur:  the first node in the list
-
Returns :the last child or NULL in case of error.
-
xmlReplaceNode ()
xmlNodePtr  xmlReplaceNode                  (xmlNodePtr old,
-                                             xmlNodePtr cur);

-Unlink the old node from its current context, prune the new one
-at the same place. If cur was already inserted in a document it is
-first unlinked from its existing context.

-
-
old:  the old node
-
cur:  the node
-
Returns :the old node
-
xmlAddPrevSibling ()
xmlNodePtr  xmlAddPrevSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);

-Add a new node elem as the previous sibling of cur
-merging adjacent TEXT nodes (elem may be freed)
-If the new node was already inserted in a document it is
-first unlinked from its existing context.
-If the new node is ATTRIBUTE, it is added into properties instead of children.
-If there is an attribute with equal name, it is first destroyed.

-
-
cur:  the child node
-
elem:  the new node
-
Returns :the new node or NULL in case of error.
-
xmlAddSibling ()
xmlNodePtr  xmlAddSibling                   (xmlNodePtr cur,
-                                             xmlNodePtr elem);

-Add a new element elem to the list of siblings of cur
-merging adjacent TEXT nodes (elem may be freed)
-If the new element was already inserted in a document it is
-first unlinked from its existing context.

-
-
cur:  the child node
-
elem:  the new node
-
Returns :the new element or NULL in case of error.
-
xmlAddNextSibling ()
xmlNodePtr  xmlAddNextSibling               (xmlNodePtr cur,
-                                             xmlNodePtr elem);

-Add a new node elem as the next sibling of cur
-If the new node was already inserted in a document it is
-first unlinked from its existing context.
-As a result of text merging elem may be freed.
-If the new node is ATTRIBUTE, it is added into properties instead of children.
-If there is an attribute with equal name, it is first destroyed.

-
-
cur:  the child node
-
elem:  the new node
-
Returns :the new node or NULL in case of error.
-
xmlUnlinkNode ()
void        xmlUnlinkNode                   (xmlNodePtr cur);

-Unlink a node from it's current context, the node is not freed

-
-
cur:  the node
-
xmlTextMerge ()
xmlNodePtr  xmlTextMerge                    (xmlNodePtr first,
-                                             xmlNodePtr second);

-Merge two text nodes into one

-
-
first:  the first text node
-
second:  the second text node being merged
-
Returns :the first text node augmented
-
xmlTextConcat ()
int         xmlTextConcat                   (xmlNodePtr node,
-                                             const xmlChar *content,
-                                             int len);

-Concat the given string at the end of the existing node content

-
-
node:  the node
-
content:  the content
-
len:  content length
-
Returns :-1 in case of error, 0 otherwise
-
xmlFreeNodeList ()
void        xmlFreeNodeList                 (xmlNodePtr cur);

-Free a node and all its siblings, this is a recursive behaviour, all
-the children are freed too.

-
-
cur:  the first node in the list
-
xmlFreeNode ()
void        xmlFreeNode                     (xmlNodePtr cur);

-Free a node, this is a recursive behaviour, all the children are freed too.
-This doesn't unlink the child from the list, use xmlUnlinkNode() first.

-
-
cur:  the node
-
xmlSetTreeDoc ()
void        xmlSetTreeDoc                   (xmlNodePtr tree,
-                                             xmlDocPtr doc);

-update all nodes under the tree to point to the right document

-
-
tree:  the top element
-
doc:  the document
-
xmlSetListDoc ()
void        xmlSetListDoc                   (xmlNodePtr list,
-                                             xmlDocPtr doc);

-update all nodes in the list to point to the right document

-
-
list:  the first element
-
doc:  the document
-
xmlSearchNs ()
xmlNsPtr    xmlSearchNs                     (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *nameSpace);

-Search a Ns registered under a given name space for a document.
-recurse on the parents until it finds the defined namespace
-or return NULL otherwise.
-nameSpace can be NULL, this is a search for the default namespace.
-We don't allow to cross entities boundaries. If you don't declare
-the namespace within those you will be in troubles !!! A warning
-is generated to cover this case.

-
-
doc:  the document
-
node:  the current node
-
nameSpace:  the namespace prefix
-
Returns :the namespace pointer or NULL.
-
xmlSearchNsByHref ()
xmlNsPtr    xmlSearchNsByHref               (xmlDocPtr doc,
-                                             xmlNodePtr node,
-                                             const xmlChar *href);

-Search a Ns aliasing a given URI. Recurse on the parents until it finds
-the defined namespace or return NULL otherwise.

-
-
doc:  the document
-
node:  the current node
-
href:  the namespace value
-
Returns :the namespace pointer or NULL.
-
xmlGetNsList ()
xmlNsPtr*   xmlGetNsList                    (xmlDocPtr doc,
-                                             xmlNodePtr node);

-Search all the namespace applying to a given element.

-
-
doc:  the document
-
node:  the current node
-
Returns :an NULL terminated array of all the xmlNsPtr found
-        that need to be freed by the caller or NULL if no
-        namespace if defined
-
xmlSetNs ()
void        xmlSetNs                        (xmlNodePtr node,
-                                             xmlNsPtr ns);

-Associate a namespace to a node, a posteriori.

-
-
node:  a node in the document
-
ns:  a namespace pointer
-
xmlCopyNamespace ()
xmlNsPtr    xmlCopyNamespace                (xmlNsPtr cur);

-Do a copy of the namespace.

-
-
cur:  the namespace
-
Returns : a new xmlNsPtr, or NULL in case of error.
-
xmlCopyNamespaceList ()
xmlNsPtr    xmlCopyNamespaceList            (xmlNsPtr cur);

-Do a copy of an namespace list.

-
-
cur:  the first namespace
-
Returns : a new xmlNsPtr, or NULL in case of error.
-
xmlSetProp ()
xmlAttrPtr  xmlSetProp                      (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Set (or reset) an attribute carried by a node.

-
-
node:  the node
-
name:  the attribute name
-
value:  the attribute value
-
Returns :the attribute pointer.
-
xmlGetNoNsProp ()
xmlChar*    xmlGetNoNsProp                  (xmlNodePtr node,
-                                             const xmlChar *name);

-Search and get the value of an attribute associated to a node
-This does the entity substitution.
-This function looks in DTD attribute declaration for FIXED or
-default declaration values unless DTD use has been turned off.
-This function is similar to xmlGetProp except it will accept only
-an attribute in no namespace.

-
-
node:  the node
-
name:  the attribute name
-
Returns :the attribute value or NULL if not found.
-    It's up to the caller to free the memory with xmlFree().
-
xmlGetProp ()
xmlChar*    xmlGetProp                      (xmlNodePtr node,
-                                             const xmlChar *name);

-Search and get the value of an attribute associated to a node
-This does the entity substitution.
-This function looks in DTD attribute declaration for FIXED or
-default declaration values unless DTD use has been turned off.
-NOTE: this function acts independently of namespaces associated
-      to the attribute. Use xmlGetNsProp() or xmlGetNoNsProp()
-      for namespace aware processing.

-
-
node:  the node
-
name:  the attribute name
-
Returns :the attribute value or NULL if not found.
-    It's up to the caller to free the memory with xmlFree().
-
xmlHasProp ()
xmlAttrPtr  xmlHasProp                      (xmlNodePtr node,
-                                             const xmlChar *name);

-Search an attribute associated to a node
-This function also looks in DTD attribute declaration for FIXED or
-default declaration values unless DTD use has been turned off.

-
-
node:  the node
-
name:  the attribute name
-
Returns :the attribute or the attribute declaration or NULL if 
-        neither was found.
-
xmlHasNsProp ()
xmlAttrPtr  xmlHasNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);

-Search for an attribute associated to a node
-This attribute has to be anchored in the namespace specified.
-This does the entity substitution.
-This function looks in DTD attribute declaration for FIXED or
-default declaration values unless DTD use has been turned off.

-
-
node:  the node
-
name:  the attribute name
-
nameSpace:  the URI of the namespace
-
Returns :the attribute or the attribute declaration or NULL
-    if neither was found.
-
xmlSetNsProp ()
xmlAttrPtr  xmlSetNsProp                    (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Set (or reset) an attribute carried by a node.
-The ns structure must be in scope, this is not checked.

-
-
node:  the node
-
ns:  the namespace definition
-
name:  the attribute name
-
value:  the attribute value
-
Returns :the attribute pointer.
-
xmlGetNsProp ()
xmlChar*    xmlGetNsProp                    (xmlNodePtr node,
-                                             const xmlChar *name,
-                                             const xmlChar *nameSpace);

-Search and get the value of an attribute associated to a node
-This attribute has to be anchored in the namespace specified.
-This does the entity substitution.
-This function looks in DTD attribute declaration for FIXED or
-default declaration values unless DTD use has been turned off.

-
-
node:  the node
-
name:  the attribute name
-
nameSpace:  the URI of the namespace
-
Returns :the attribute value or NULL if not found.
-    It's up to the caller to free the memory with xmlFree().
-
xmlStringGetNodeList ()
xmlNodePtr  xmlStringGetNodeList            (xmlDocPtr doc,
-                                             const xmlChar *value);

-Parse the value string and build the node list associated. Should
-produce a flat tree with only TEXTs and ENTITY_REFs.

-
-
doc:  the document
-
value:  the value of the attribute
-
Returns :a pointer to the first child
-
xmlStringLenGetNodeList ()
xmlNodePtr  xmlStringLenGetNodeList         (xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             int len);

-Parse the value string and build the node list associated. Should
-produce a flat tree with only TEXTs and ENTITY_REFs.

-
-
doc:  the document
-
value:  the value of the text
-
len:  the length of the string value
-
Returns :a pointer to the first child
-
xmlNodeListGetString ()
xmlChar*    xmlNodeListGetString            (xmlDocPtr doc,
-                                             xmlNodePtr list,
-                                             int inLine);

-Build the string equivalent to the text contained in the Node list
-made of TEXTs and ENTITY_REFs

-
-
doc:  the document
-
list:  a Node list
-
inLine:  should we replace entity contents or show their external form
-
Returns :a pointer to the string copy, the caller must free it with xmlFree().
-
xmlNodeListGetRawString ()
xmlChar*    xmlNodeListGetRawString         (xmlDocPtr doc,
-                                             xmlNodePtr list,
-                                             int inLine);

-Builds the string equivalent to the text contained in the Node list
-made of TEXTs and ENTITY_REFs, contrary to xmlNodeListGetString()
-this function doesn't do any character encoding handling.

-
-
doc:  the document
-
list:  a Node list
-
inLine:  should we replace entity contents or show their external form
-
Returns :a pointer to the string copy, the caller must free it with xmlFree().
-
xmlNodeSetContent ()
void        xmlNodeSetContent               (xmlNodePtr cur,
-                                             const xmlChar *content);

-Replace the content of a node.

-
-
cur:  the node being modified
-
content:  the new value of the content
-
xmlNodeSetContentLen ()
void        xmlNodeSetContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
-                                             int len);

-Replace the content of a node.

-
-
cur:  the node being modified
-
content:  the new value of the content
-
len:  the size of content
-
xmlNodeAddContent ()
void        xmlNodeAddContent               (xmlNodePtr cur,
-                                             const xmlChar *content);

-Append the extra substring to the node content.

-
-
cur:  the node being modified
-
content:  extra content
-
xmlNodeAddContentLen ()
void        xmlNodeAddContentLen            (xmlNodePtr cur,
-                                             const xmlChar *content,
-                                             int len);

-Append the extra substring to the node content.

-
-
cur:  the node being modified
-
content:  extra content
-
len:  the size of content
-
xmlNodeGetContent ()
xmlChar*    xmlNodeGetContent               (xmlNodePtr cur);

-Read the value of a node, this can be either the text carried
-directly by this node if it's a TEXT node or the aggregate string
-of the values carried by this node child's (TEXT and ENTITY_REF).
-Entity references are substituted.

-
-
cur:  the node being read
-
Returns :a new xmlChar * or NULL if no content is available.
-    It's up to the caller to free the memory with xmlFree().
-
xmlNodeBufGetContent ()
int         xmlNodeBufGetContent            (xmlBufferPtr buffer,
-                                             xmlNodePtr cur);

-Read the value of a node cur, this can be either the text carried
-directly by this node if it's a TEXT node or the aggregate string
-of the values carried by this node child's (TEXT and ENTITY_REF).
-Entity references are substituted.
-Fills up the buffer buffer with this value

-
-
buffer:  a buffer
-
cur:  the node being read
-
Returns :0 in case of success and -1 in case of error.
-
xmlNodeGetLang ()
xmlChar*    xmlNodeGetLang                  (xmlNodePtr cur);

-Searches the language of a node, i.e. the values of the xml:lang
-attribute or the one carried by the nearest ancestor.

-
-
cur:  the node being checked
-
Returns :a pointer to the lang value, or NULL if not found
-    It's up to the caller to free the memory with xmlFree().
-
xmlNodeGetSpacePreserve ()
int         xmlNodeGetSpacePreserve         (xmlNodePtr cur);

-Searches the space preserving behaviour of a node, i.e. the values
-of the xml:space attribute or the one carried by the nearest
-ancestor.

-
-
cur:  the node being checked
-
Returns :-1 if xml:space is not inherited, 0 if "default", 1 if "preserve"
-
xmlNodeSetLang ()
void        xmlNodeSetLang                  (xmlNodePtr cur,
-                                             const xmlChar *lang);

-Set the language of a node, i.e. the values of the xml:lang
-attribute.

-
-
cur:  the node being changed
-
lang:  the language description
-
xmlNodeSetSpacePreserve ()
void        xmlNodeSetSpacePreserve         (xmlNodePtr cur,
-                                             int val);

-Set (or reset) the space preserving behaviour of a node, i.e. the
-value of the xml:space attribute.

-
-
cur:  the node being changed
-
val:  the xml:space value ("0": default, 1: "preserve")
-
xmlNodeGetBase ()
xmlChar*    xmlNodeGetBase                  (xmlDocPtr doc,
-                                             xmlNodePtr cur);

-Searches for the BASE URL. The code should work on both XML
-and HTML document even if base mechanisms are completely different.
-It returns the base as defined in RFC 2396 sections
-5.1.1. Base URI within Document Content
-and
-5.1.2. Base URI from the Encapsulating Entity
-However it does not return the document base (5.1.3), use
-xmlDocumentGetBase() for this

-
-
doc:  the document the node pertains to
-
cur:  the node being checked
-
Returns :a pointer to the base URL, or NULL if not found
-    It's up to the caller to free the memory with xmlFree().
-
xmlNodeSetBase ()
void        xmlNodeSetBase                  (xmlNodePtr cur,
-                                             const xmlChar *uri);

-Set (or reset) the base URI of a node, i.e. the value of the
-xml:base attribute.

-
-
cur:  the node being changed
-
uri:  the new base URI
-
xmlRemoveProp ()
int         xmlRemoveProp                   (xmlAttrPtr cur);

-Unlink and free one attribute, all the content is freed too
-Note this doesn't work for namespace definition attributes

-
-
cur:  an attribute
-
Returns :0 if success and -1 in case of error.
-
xmlUnsetProp ()
int         xmlUnsetProp                    (xmlNodePtr node,
-                                             const xmlChar *name);

-Remove an attribute carried by a node.

-
-
node:  the node
-
name:  the attribute name
-
Returns :0 if successful, -1 if not found
-
xmlUnsetNsProp ()
int         xmlUnsetNsProp                  (xmlNodePtr node,
-                                             xmlNsPtr ns,
-                                             const xmlChar *name);

-Remove an attribute carried by a node.

-
-
node:  the node
-
ns:  the namespace definition
-
name:  the attribute name
-
Returns :0 if successful, -1 if not found
-
xmlBufferWriteCHAR ()
void        xmlBufferWriteCHAR              (xmlBufferPtr buf,
-                                             const xmlChar *string);

-routine which manages and grows an output buffer. This one adds
-xmlChars at the end of the buffer.

-
-
buf:  the XML buffer
-
string:  the string to add
-
xmlBufferWriteChar ()
void        xmlBufferWriteChar              (xmlBufferPtr buf,
-                                             const char *string);

-routine which manage and grows an output buffer. This one add
-C chars at the end of the array.

-
-
buf:  the XML buffer output
-
string:  the string to add
-
xmlBufferWriteQuotedString ()
void        xmlBufferWriteQuotedString      (xmlBufferPtr buf,
-                                             const xmlChar *string);

-routine which manage and grows an output buffer. This one writes
-a quoted or double quoted xmlChar string, checking first if it holds
-quote or double-quotes internally

-
-
buf:  the XML buffer output
-
string:  the string to add
-
xmlReconciliateNs ()
int         xmlReconciliateNs               (xmlDocPtr doc,
-                                             xmlNodePtr tree);

-This function checks that all the namespaces declared within the given
-tree are properly declared. This is needed for example after Copy or Cut
-and then paste operations. The subtree may still hold pointers to
-namespace declarations outside the subtree or invalid/masked. As much
-as possible the function try to reuse the existing namespaces found in
-the new environment. If not possible the new namespaces are redeclared
-on tree at the top of the given subtree.

-
-
doc:  the document
-
tree:  a node defining the subtree to reconciliate
-
Returns :the number of namespace declarations created or -1 in case of error.
-
xmlDocDumpFormatMemory ()
void        xmlDocDumpFormatMemory          (xmlDocPtr cur,
-                                             xmlChar **mem,
-                                             int *size,
-                                             int format);

-Dump an XML document in memory and return the xmlChar * and it's size.
-It's up to the caller to free the memory with xmlFree().
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called

-
-
cur:  the document
-
mem:  OUT: the memory pointer
-
size:  OUT: the memory length
-
format:  should formatting spaces been added
-
xmlDocDumpMemory ()
void        xmlDocDumpMemory                (xmlDocPtr cur,
-                                             xmlChar **mem,
-                                             int *size);

-Dump an XML document in memory and return the xmlChar * and it's size.
-It's up to the caller to free the memory with xmlFree().

-
-
cur:  the document
-
mem:  OUT: the memory pointer
-
size:  OUT: the memory length
-
xmlDocDumpMemoryEnc ()
void        xmlDocDumpMemoryEnc             (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
-                                             int *doc_txt_len,
-                                             const char *txt_encoding);

-Dump the current DOM tree into memory using the character encoding specified
-by the caller.  Note it is up to the caller of this function to free the
-allocated memory with xmlFree().

-
-
out_doc:  Document to generate XML text from
-
doc_txt_ptr:  Memory pointer for allocated XML text
-
doc_txt_len:  Length of the generated XML text
-
txt_encoding:  Character encoding to use when generating XML text
-
xmlDocDumpFormatMemoryEnc ()
void        xmlDocDumpFormatMemoryEnc       (xmlDocPtr out_doc,
-                                             xmlChar **doc_txt_ptr,
-                                             int *doc_txt_len,
-                                             const char *txt_encoding,
-                                             int format);

-Dump the current DOM tree into memory using the character encoding specified
-by the caller.  Note it is up to the caller of this function to free the
-allocated memory with xmlFree().
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called

-
-
out_doc:  Document to generate XML text from
-
doc_txt_ptr:  Memory pointer for allocated XML text
-
doc_txt_len:  Length of the generated XML text
-
txt_encoding:  Character encoding to use when generating XML text
-
format:  should formatting spaces been added
-
xmlDocFormatDump ()
int         xmlDocFormatDump                (FILE *f,
-                                             xmlDocPtr cur,
-                                             int format);

-Dump an XML document to an open FILE.

-
-
f:  the FILE*
-
cur:  the document
-
format: should formatting spaces been added
-
Returns : the number of bytes written or -1 in case of failure.
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called
-
xmlDocDump ()
int         xmlDocDump                      (FILE *f,
-                                             xmlDocPtr cur);

-Dump an XML document to an open FILE.

-
-
f:  the FILE*
-
cur:  the document
-
Returns : the number of bytes written or -1 in case of failure.
-
xmlElemDump ()
void        xmlElemDump                     (FILE *f,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur);

-Dump an XML/HTML node, recursive behaviour, children are printed too.

-
-
f:  the FILE * for the output
-
doc:  the document
-
cur:  the current node
-
xmlSaveFile ()
int         xmlSaveFile                     (const char *filename,
-                                             xmlDocPtr cur);

-Dump an XML document to a file. Will use compression if
-compiled in and enabled. If filename is "-" the stdout file is
-used.

-
-
filename:  the filename (or URL)
-
cur:  the document
-
Returns : the number of bytes written or -1 in case of failure.
-
xmlSaveFormatFile ()
int         xmlSaveFormatFile               (const char *filename,
-                                             xmlDocPtr cur,
-                                             int format);

-Dump an XML document to a file. Will use compression if
-compiled in and enabled. If filename is "-" the stdout file is
-used. If format is set then the document will be indented on output.
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called

-
-
filename:  the filename (or URL)
-
cur:  the document
-
format:  should formatting spaces been added
-
Returns : the number of bytes written or -1 in case of failure.
-
xmlNodeDump ()
int         xmlNodeDump                     (xmlBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             int level,
-                                             int format);

-Dump an XML node, recursive behaviour,children are printed too.
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called

-
-
buf:  the XML buffer output
-
doc:  the document
-
cur:  the current node
-
level: the imbrication level for indenting
-
format: is formatting allowed
-
Returns :the number of bytes written to the buffer or -1 in case of error
-
xmlSaveFileTo ()
int         xmlSaveFileTo                   (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding);

-Dump an XML document to an I/O buffer.

-
-
buf:  an output I/O buffer
-
cur:  the document
-
encoding:  the encoding if any assuming the I/O layer handles the trancoding
-
Returns : the number of bytes written or -1 in case of failure.
-
xmlSaveFormatFileTo ()
int         xmlSaveFormatFileTo             (xmlOutputBufferPtr buf,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);

-Dump an XML document to an I/O buffer.

-
-
buf:  an output I/O buffer
-
cur:  the document
-
encoding:  the encoding if any assuming the I/O layer handles the trancoding
-
format: should formatting spaces been added
-
Returns : the number of bytes written or -1 in case of failure.
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called
-
xmlNodeDumpOutput ()
void        xmlNodeDumpOutput               (xmlOutputBufferPtr buf,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr cur,
-                                             int level,
-                                             int format,
-                                             const char *encoding);

-Dump an XML node, recursive behaviour, children are printed too.
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called

-
-
buf:  the XML buffer output
-
doc:  the document
-
cur:  the current node
-
level: the imbrication level for indenting
-
format: is formatting allowed
-
encoding:  an optional encoding string
-
xmlSaveFormatFileEnc ()
int         xmlSaveFormatFileEnc            (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding,
-                                             int format);

-Dump an XML document to a file or an URL.

-
-
filename:  the filename or URL to output
-
cur:  the document being saved
-
encoding:  the name of the encoding to use or NULL.
-
format:  should formatting spaces be added.
-
Returns :the number of bytes written or -1 in case of error.
-Note that format = 1 provide node indenting only if xmlIndentTreeOutput = 1
-or xmlKeepBlanksDefault(0) was called
-
xmlSaveFileEnc ()
int         xmlSaveFileEnc                  (const char *filename,
-                                             xmlDocPtr cur,
-                                             const char *encoding);

-Dump an XML document, converting it to the given encoding

-
-
filename:  the filename (or URL)
-
cur:  the document
-
encoding:  the name of an encoding (or NULL)
-
Returns : the number of bytes written or -1 in case of failure.
-
xmlIsXHTML ()
int         xmlIsXHTML                      (const xmlChar *systemID,
-                                             const xmlChar *publicID);

-Try to find if the document correspond to an XHTML DTD

-
-
systemID:  the system identifier
-
publicID:  the public identifier
-
Returns :1 if true, 0 if not and -1 in case of error
-
xmlGetDocCompressMode ()
int         xmlGetDocCompressMode           (xmlDocPtr doc);

-get the compression ratio for a document, ZLIB based

-
-
doc:  the document
-
Returns :0 (uncompressed) to 9 (max compression)
-
xmlSetDocCompressMode ()
void        xmlSetDocCompressMode           (xmlDocPtr doc,
-                                             int mode);

-set the compression ratio for a document, ZLIB based
-Correct values: 0 (uncompressed) to 9 (max compression)

-
-
doc:  the document
-
mode:  the compression ratio
-
xmlGetCompressMode ()
int         xmlGetCompressMode              (void);

-get the default compression mode used, ZLIB based.

-
-
Returns :0 (uncompressed) to 9 (max compression)
-
xmlSetCompressMode ()
void        xmlSetCompressMode              (int mode);

-set the default compression mode used, ZLIB based
-Correct values: 0 (uncompressed) to 9 (max compression)

-
-
mode:  the compression ratio
-
<< catalogglobals >>

+
+
+Module tree from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module tree from libxml2
Main Menu
Related links
Table of Contents
xmlNodePtr	xmlNewDocRawNode	(xmlDocPtr doc, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Structure xmlElementContent
struct _xmlElementContent {
+    xmlElementContentType	type	: PCDATA, ELEMENT, SEQ or OR
+    xmlElementContentOccur	ocur	: ONCE, OPT, MULT or PLUS
+    const xmlChar *	name	: Element name
+    struct _xmlElementContent *	c1	: first child
+    struct _xmlElementContent *	c2	: second child
+    struct _xmlElementContent *	parent	: parent
+    const xmlChar *	prefix	: Namespace prefix
+}

xmlChar *	xmlGetProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
xmlAttrPtr	xmlNewNsPropEatName	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 xmlChar * name, 
				 const xmlChar * value)

+
Typedef xmlElement * xmlElementPtr
+
+
xmlNodePtr	xmlDocCopyNode	(const xmlNodePtr node, 
				 xmlDocPtr doc, 
				 int recursive)

+
xmlNodePtr	xmlStringGetNodeList	(xmlDocPtr doc, 
				 const xmlChar * value)

+
void	xmlBufferWriteCHAR	(xmlBufferPtr buf, 
				 const xmlChar * string)

+
#define BAD_CAST
+
+
Structure xmlElement
struct _xmlElement {
+    void *	_private	: application data
+    xmlElementType	type	: XML_ELEMENT_DECL, must be second !
+    const xmlChar *	name	: Element name
+    struct _xmlNode *	children	: NULL
+    struct _xmlNode *	last	: NULL
+    struct _xmlDtd *	parent	: -> DTD
+    struct _xmlNode *	next	: next sibling link
+    struct _xmlNode *	prev	: previous sibling link
+    struct _xmlDoc *	doc	: the containing document
+    xmlElementTypeVal	etype	: The type
+    xmlElementContentPtr	content	: the allowed element content
+    xmlAttributePtr	attributes	: List of the declared attributes
+    const xmlChar *	prefix	: the namespace prefix if any
+    xmlRegexpPtr	contModel	: the validating regexp
+    void *	contModel
+}

xmlChar *	xmlNodeGetBase	(xmlDocPtr doc, 
				 xmlNodePtr cur)

+
Typedef xmlAttribute * xmlAttributePtr
+
+
void	xmlBufferEmpty	(xmlBufferPtr buf)

+
int	xmlSaveFormatFile	(const char * filename, 
				 xmlDocPtr cur, 
				 int format)

+
xmlNodePtr	xmlNewDocNodeEatName	(xmlDocPtr doc, 
				 xmlNsPtr ns, 
				 xmlChar * name, 
				 const xmlChar * content)

+
xmlNodePtr	xmlAddSibling	(xmlNodePtr cur, 
				 xmlNodePtr elem)

+
xmlNodePtr	xmlNewDocFragment	(xmlDocPtr doc)

+
xmlNodePtr	xmlDocGetRootElement	(xmlDocPtr doc)

+
void	xmlNodeAddContentLen	(xmlNodePtr cur, 
				 const xmlChar * content, 
				 int len)

+
Structure xmlNotation
struct _xmlNotation {
+    const xmlChar *	name	: Notation name
+    const xmlChar *	PublicID	: Public identifier, if any
+    const xmlChar *	SystemID	: System identifier, if any
+}

Enum xmlElementType {
+    XML_ELEMENT_NODE = 1
+    XML_ATTRIBUTE_NODE = 2
+    XML_TEXT_NODE = 3
+    XML_CDATA_SECTION_NODE = 4
+    XML_ENTITY_REF_NODE = 5
+    XML_ENTITY_NODE = 6
+    XML_PI_NODE = 7
+    XML_COMMENT_NODE = 8
+    XML_DOCUMENT_NODE = 9
+    XML_DOCUMENT_TYPE_NODE = 10
+    XML_DOCUMENT_FRAG_NODE = 11
+    XML_NOTATION_NODE = 12
+    XML_HTML_DOCUMENT_NODE = 13
+    XML_DTD_NODE = 14
+    XML_ELEMENT_DECL = 15
+    XML_ATTRIBUTE_DECL = 16
+    XML_ENTITY_DECL = 17
+    XML_NAMESPACE_DECL = 18
+    XML_XINCLUDE_START = 19
+    XML_XINCLUDE_END = 20
+    XML_DOCB_DOCUMENT_NODE = 21
+}
+
+
Typedef xmlNs * xmlNsPtr
+
+
int	xmlValidateQName	(const xmlChar * value, 
				 int space)

+
xmlAttrPtr	xmlHasNsProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * nameSpace)

+
xmlNodePtr	xmlAddPrevSibling	(xmlNodePtr cur, 
				 xmlNodePtr elem)

+
void	xmlBufferAddHead	(xmlBufferPtr buf, 
				 const xmlChar * str, 
				 int len)

+
void	xmlSetListDoc	(xmlNodePtr list, 
				 xmlDocPtr doc)

+
xmlNodePtr	xmlNewPI	(const xmlChar * name, 
				 const xmlChar * content)

+
Enum xmlElementContentOccur {
+    XML_ELEMENT_CONTENT_ONCE = 1
+    XML_ELEMENT_CONTENT_OPT = 2
+    XML_ELEMENT_CONTENT_MULT = 3
+    XML_ELEMENT_CONTENT_PLUS = 4
+}
+
+
int	xmlDocFormatDump	(FILE * f, 
				 xmlDocPtr cur, 
				 int format)

+
xmlAttrPtr	xmlSetProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Typedef xmlParserInput * xmlParserInputPtr
+
+
void	xmlElemDump	(FILE * f, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur)

+
Structure xmlID
struct _xmlID {
+    struct _xmlID *	next	: next ID
+    const xmlChar *	value	: The ID name
+    xmlAttrPtr	attr	: The attribute holding it
+    const xmlChar *	name	: The attribute if attr is not available
+    int	lineno	: The line number if attr is not available
+    struct _xmlDoc *	doc	: The document holding the ID
+}

int	xmlSaveFormatFileTo	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
xmlDtdPtr	xmlGetIntSubset	(xmlDocPtr doc)

+
int	xmlNodeBufGetContent	(xmlBufferPtr buffer, 
				 xmlNodePtr cur)

+
void	xmlBufferFree	(xmlBufferPtr buf)

+
xmlNodePtr	xmlReplaceNode	(xmlNodePtr old, 
				 xmlNodePtr cur)

+
xmlNodePtr	xmlNewNode	(xmlNsPtr ns, 
				 const xmlChar * name)

+
int	xmlSaveFileTo	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
Typedef xmlID * xmlIDPtr
+
+
Structure xmlAttribute
struct _xmlAttribute {
+    void *	_private	: application data
+    xmlElementType	type	: XML_ATTRIBUTE_DECL, must be second !
+    const xmlChar *	name	: Attribute name
+    struct _xmlNode *	children	: NULL
+    struct _xmlNode *	last	: NULL
+    struct _xmlDtd *	parent	: -> DTD
+    struct _xmlNode *	next	: next sibling link
+    struct _xmlNode *	prev	: previous sibling link
+    struct _xmlDoc *	doc	: the containing document
+    struct _xmlAttribute *	nexth	: next in hash table
+    xmlAttributeType	atype	: The attribute type
+    xmlAttributeDefault	def	: the default
+    const xmlChar *	defaultValue	: or the default value
+    xmlEnumerationPtr	tree	: or the enumeration tree if any
+    const xmlChar *	prefix	: the namespace prefix if any
+    const xmlChar *	elem	: Element holding the attribute
+}

Typedef xmlSAXHandler * xmlSAXHandlerPtr
+
+
void	xmlNodeSetContent	(xmlNodePtr cur, 
				 const xmlChar * content)

+
void	xmlBufferAdd	(xmlBufferPtr buf, 
				 const xmlChar * str, 
				 int len)

+
void	xmlNodeDumpOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 int level, 
				 int format, 
				 const char * encoding)

+
xmlNsPtr	xmlCopyNamespace	(xmlNsPtr cur)

+
xmlNsPtr	xmlSearchNsByHref	(xmlDocPtr doc, 
				 xmlNodePtr node, 
				 const xmlChar * href)

+
xmlNodePtr	xmlAddChild	(xmlNodePtr parent, 
				 xmlNodePtr cur)

+
int	xmlReconciliateNs	(xmlDocPtr doc, 
				 xmlNodePtr tree)

+
Typedef xmlSAXLocator * xmlSAXLocatorPtr
+
+
Structure xmlParserInput
struct _xmlParserInput {
+    xmlParserInputBufferPtr	buf	: UTF-8 encoded buffer
+    const char *	filename	: The file analyzed, if any
+    const char *	directory	: the directory/base of the file
+    const xmlChar *	base	: Base of the array to parse
+    const xmlChar *	cur	: Current char being parsed
+    const xmlChar *	end	: end of the array to parse
+    int	length	: length if known
+    int	line	: Current line
+    int	col	: * NOTE: consumed is only tested for equality in th
+    unsigned long	consumed	: How many xmlChars already consumed
+    xmlParserInputDeallocate	free	: function to deallocate the base
+    const xmlChar *	encoding	: the encoding string for entity
+    const xmlChar *	version	: the version string for entity
+    int	standalone	: Was that entity marked standalone
+    int	id	: an unique identifier for the entity
+}

#define XML_GET_CONTENT
+
+
void	xmlNodeSetName	(xmlNodePtr cur, 
				 const xmlChar * name)

+
int	xmlValidateNCName	(const xmlChar * value, 
				 int space)

+
xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
				 const xmlChar * content)

+
Structure xmlRef
struct _xmlRef {
+    struct _xmlRef *	next	: next Ref
+    const xmlChar *	value	: The Ref name
+    xmlAttrPtr	attr	: The attribute holding it
+    const xmlChar *	name	: The attribute if attr is not available
+    int	lineno	: The line number if attr is not available
+}

int	xmlGetCompressMode	(void)

+
#define xmlRootNode
+
+
xmlBufferPtr	xmlBufferCreateSize	(size_t size)

+
xmlChar *	xmlNodeListGetString	(xmlDocPtr doc, 
				 xmlNodePtr list, 
				 int inLine)

+
void	xmlSetCompressMode	(int mode)

+
void	xmlSetTreeDoc	(xmlNodePtr tree, 
				 xmlDocPtr doc)

+
xmlBufferPtr	xmlBufferCreate	(void)

+
xmlNodePtr	xmlCopyNodeList	(const xmlNodePtr node)

+
Typedef xmlDoc * xmlDocPtr
+
+
int	xmlBufferGrow	(xmlBufferPtr buf, 
				 unsigned int len)

+
xmlNodePtr	xmlAddChildList	(xmlNodePtr parent, 
				 xmlNodePtr cur)

+
xmlChar *	xmlGetNodePath	(xmlNodePtr node)

+
Typedef xmlParserCtxt * xmlParserCtxtPtr
+
+
void	xmlFreePropList	(xmlAttrPtr cur)

+
void	xmlNodeAddContent	(xmlNodePtr cur, 
				 const xmlChar * content)

+
int	xmlUnsetNsProp	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 const xmlChar * name)

+
int	xmlNodeIsText	(xmlNodePtr node)

+
Structure xmlAttr
struct _xmlAttr {
+    void *	_private	: application data
+    xmlElementType	type	: XML_ATTRIBUTE_NODE, must be second !
+    const xmlChar *	name	: the name of the property
+    struct _xmlNode *	children	: the value of the property
+    struct _xmlNode *	last	: NULL
+    struct _xmlNode *	parent	: child->parent link
+    struct _xmlAttr *	next	: next sibling link
+    struct _xmlAttr *	prev	: previous sibling link
+    struct _xmlDoc *	doc	: the containing document
+    xmlNs *	ns	: pointer to the associated namespace
+    xmlAttributeType	atype	: the attribute type if validating
+    void *	psvi	: for type/PSVI informations
+}

xmlNodePtr	xmlAddNextSibling	(xmlNodePtr cur, 
				 xmlNodePtr elem)

+
int	xmlIsBlankNode	(xmlNodePtr node)

+
Structure xmlEntity
struct _xmlEntity {
+    void *	_private	: application data
+    xmlElementType	type	: XML_ENTITY_DECL, must be second !
+    const xmlChar *	name	: Entity name
+    struct _xmlNode *	children	: First child link
+    struct _xmlNode *	last	: Last child link
+    struct _xmlDtd *	parent	: -> DTD
+    struct _xmlNode *	next	: next sibling link
+    struct _xmlNode *	prev	: previous sibling link
+    struct _xmlDoc *	doc	: the containing document
+    xmlChar *	orig	: content without ref substitution
+    xmlChar *	content	: content or ndata if unparsed
+    int	length	: the content length
+    xmlEntityType	etype	: The entity type
+    const xmlChar *	ExternalID	: External identifier for PUBLIC
+    const xmlChar *	SystemID	: URI for a SYSTEM or PUBLIC Entity
+    struct _xmlEntity *	nexte	: unused
+    const xmlChar *	URI	: the full URI as computed
+    int	owner	: does the entity own the childrens
+}

int	xmlValidateName	(const xmlChar * value, 
				 int space)

+
xmlNsPtr	xmlNewGlobalNs	(xmlDocPtr doc, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
int	xmlBufferDump	(FILE * file, 
				 xmlBufferPtr buf)

+
xmlNsPtr	xmlNewNs	(xmlNodePtr node, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
xmlDocPtr	xmlCopyDoc	(xmlDocPtr doc, 
				 int recursive)

+
void	xmlDocDumpMemoryEnc	(xmlDocPtr out_doc, 
				 xmlChar ** doc_txt_ptr, 
				 int * doc_txt_len, 
				 const char * txt_encoding)

+
xmlNodePtr	xmlTextMerge	(xmlNodePtr first, 
				 xmlNodePtr second)

+
void	xmlDocDumpMemory	(xmlDocPtr cur, 
				 xmlChar ** mem, 
				 int * size)

+
xmlNodePtr	xmlNewTextLen	(const xmlChar * content, 
				 int len)

+
void	xmlFreeNs	(xmlNsPtr cur)

+
int	xmlDocDump	(FILE * f, 
				 xmlDocPtr cur)

+
#define BASE_BUFFER_SIZE
+
+
void	xmlFreeProp	(xmlAttrPtr cur)

+
Structure xmlEnumeration
struct _xmlEnumeration {
+    struct _xmlEnumeration *	next	: next one
+    const xmlChar *	name	: Enumeration name
+}

void	xmlBufferWriteChar	(xmlBufferPtr buf, 
				 const char * string)

+
xmlChar *	xmlGetNoNsProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
xmlChar *	xmlSplitQName2	(const xmlChar * name, 
				 xmlChar ** prefix)

+
Structure xmlSAXHandler
struct _xmlSAXHandler {
+    internalSubsetSAXFunc	internalSubset
+    isStandaloneSAXFunc	isStandalone
+    hasInternalSubsetSAXFunc	hasInternalSubset
+    hasExternalSubsetSAXFunc	hasExternalSubset
+    resolveEntitySAXFunc	resolveEntity
+    getEntitySAXFunc	getEntity
+    entityDeclSAXFunc	entityDecl
+    notationDeclSAXFunc	notationDecl
+    attributeDeclSAXFunc	attributeDecl
+    elementDeclSAXFunc	elementDecl
+    unparsedEntityDeclSAXFunc	unparsedEntityDecl
+    setDocumentLocatorSAXFunc	setDocumentLocator
+    startDocumentSAXFunc	startDocument
+    endDocumentSAXFunc	endDocument
+    startElementSAXFunc	startElement
+    endElementSAXFunc	endElement
+    referenceSAXFunc	reference
+    charactersSAXFunc	characters
+    ignorableWhitespaceSAXFunc	ignorableWhitespace
+    processingInstructionSAXFunc	processingInstruction
+    commentSAXFunc	comment
+    warningSAXFunc	warning
+    errorSAXFunc	error
+    fatalErrorSAXFunc	fatalError	: unused error() get all the errors
+    getParameterEntitySAXFunc	getParameterEntity
+    cdataBlockSAXFunc	cdataBlock
+    externalSubsetSAXFunc	externalSubset
+    unsigned int	initialized	: The following fields are extensions available onl
+    void *	_private
+    startElementNsSAX2Func	startElementNs
+    endElementNsSAX2Func	endElementNs
+    xmlStructuredErrorFunc	serror
+}

#define XML_GET_LINE
+
+
Typedef xmlRef * xmlRefPtr
+
+
xmlAttrPtr	xmlNewProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
int	xmlTextConcat	(xmlNodePtr node, 
				 const xmlChar * content, 
				 int len)

+
Structure xmlSAXLocator
struct _xmlSAXLocator {
+    const xmlChar *(*getPublicId)	getPublicId
+    const xmlChar *(*getSystemId)	getSystemId
+    int(*getLineNumber)	getLineNumber
+    int(*getColumnNumber)	getColumnNumber
+}

Typedef xmlOutputBuffer * xmlOutputBufferPtr
+
+
int	xmlNodeGetSpacePreserve	(xmlNodePtr cur)

+
Typedef xmlNotation * xmlNotationPtr
+
+
int	xmlBufferShrink	(xmlBufferPtr buf, 
				 unsigned int len)

+
xmlChar *	xmlNodeGetContent	(xmlNodePtr cur)

+
#define XML_LOCAL_NAMESPACE
+
+
xmlNodePtr	xmlStringLenGetNodeList	(xmlDocPtr doc, 
				 const xmlChar * value, 
				 int len)

+
xmlChar *	xmlBuildQName	(const xmlChar * ncname, 
				 const xmlChar * prefix, 
				 xmlChar * memory, 
				 int len)

+
Typedef xmlBuffer * xmlBufferPtr
+
+
Typedef xmlEnumeration * xmlEnumerationPtr
+
+
Structure xmlBuffer
struct _xmlBuffer {
+    xmlChar *	content	: The buffer content UTF8
+    unsigned int	use	: The buffer size used
+    unsigned int	size	: The buffer size
+    xmlBufferAllocationScheme	alloc	: The realloc method
+}

void	xmlBufferWriteQuotedString	(xmlBufferPtr buf, 
				 const xmlChar * string)

+
xmlAttrPtr	xmlCopyProp	(xmlNodePtr target, 
				 xmlAttrPtr cur)

+
Structure xmlNs
struct _xmlNs {
+    struct _xmlNs *	next	: next Ns link for this node
+    xmlNsType	type	: global or local
+    const xmlChar *	href	: URL for the namespace
+    const xmlChar *	prefix	: prefix for the namespace
+    void *	_private	: application data
+}

Enum xmlAttributeType {
+    XML_ATTRIBUTE_CDATA = 1
+    XML_ATTRIBUTE_ID = 2
+    XML_ATTRIBUTE_IDREF = 3
+    XML_ATTRIBUTE_IDREFS = 4
+    XML_ATTRIBUTE_ENTITY = 5
+    XML_ATTRIBUTE_ENTITIES = 6
+    XML_ATTRIBUTE_NMTOKEN = 7
+    XML_ATTRIBUTE_NMTOKENS = 8
+    XML_ATTRIBUTE_ENUMERATION = 9
+    XML_ATTRIBUTE_NOTATION = 10
+}
+
+
void	xmlSetDocCompressMode	(xmlDocPtr doc, 
				 int mode)

+
xmlNodePtr	xmlCopyNode	(const xmlNodePtr node, 
				 int recursive)

+
void	xmlUnlinkNode	(xmlNodePtr cur)

+
const xmlChar *	xmlSplitQName3	(const xmlChar * name, 
				 int * len)

+
Structure xmlParserInputBuffer
struct _xmlParserInputBuffer {
+    void *	context
+    xmlInputReadCallback	readcallback
+    xmlInputCloseCallback	closecallback
+    xmlCharEncodingHandlerPtr	encoder	: I18N conversions to UTF-8
+    xmlBufferPtr	buffer	: Local buffer encoded in UTF-8
+    xmlBufferPtr	raw	: if encoder != NULL buffer for raw input
+    int	compressed	: -1=unknown, 0=not compressed, 1=compressed
+    int	error
+}

xmlNodePtr	xmlDocSetRootElement	(xmlDocPtr doc, 
				 xmlNodePtr root)

+
xmlNsPtr	xmlSearchNs	(xmlDocPtr doc, 
				 xmlNodePtr node, 
				 const xmlChar * nameSpace)

+
long	xmlGetLineNo	(xmlNodePtr node)

+
Typedef xmlNode * xmlNodePtr
+
+
int	xmlRemoveProp	(xmlAttrPtr cur)

+
Structure xmlParserCtxt
struct _xmlParserCtxt {
+    struct _xmlSAXHandler *	sax	: The SAX handler
+    void *	userData	: For SAX interface only, used by DOM build
+    xmlDocPtr	myDoc	: the document being built
+    int	wellFormed	: is the document well formed
+    int	replaceEntities	: shall we replace entities ?
+    const xmlChar *	version	: the XML version string
+    const xmlChar *	encoding	: the declared encoding, if any
+    int	standalone	: standalone document
+    int	html	: an HTML(1)/Docbook(2) document Input stream stack
+    xmlParserInputPtr	input	: Current input stream
+    int	inputNr	: Number of current input streams
+    int	inputMax	: Max number of input streams
+    xmlParserInputPtr *	inputTab	: stack of inputs Node analysis stack only used for
+    xmlNodePtr	node	: Current parsed Node
+    int	nodeNr	: Depth of the parsing stack
+    int	nodeMax	: Max depth of the parsing stack
+    xmlNodePtr *	nodeTab	: array of nodes
+    int	record_info	: Whether node info should be kept
+    xmlParserNodeInfoSeq	node_seq	: info about each node parsed
+    int	errNo	: error code
+    int	hasExternalSubset	: reference and external subset
+    int	hasPErefs	: the internal subset has PE refs
+    int	external	: are we parsing an external entity
+    int	valid	: is the document valid
+    int	validate	: shall we try to validate ?
+    xmlValidCtxt	vctxt	: The validity context
+    xmlParserInputState	instate	: current type of input
+    int	token	: next char look-ahead
+    char *	directory	: the data directory Node name stack
+    const xmlChar *	name	: Current parsed Node
+    int	nameNr	: Depth of the parsing stack
+    int	nameMax	: Max depth of the parsing stack
+    const xmlChar * *	nameTab	: array of nodes
+    long	nbChars	: number of xmlChar processed
+    long	checkIndex	: used by progressive parsing lookup
+    int	keepBlanks	: ugly but ...
+    int	disableSAX	: SAX callbacks are disabled
+    int	inSubset	: Parsing is in int 1/ext 2 subset
+    const xmlChar *	intSubName	: name of subset
+    xmlChar *	extSubURI	: URI of external subset
+    xmlChar *	extSubSystem	: SYSTEM ID of external subset xml:space values
+    int *	space	: Should the parser preserve spaces
+    int	spaceNr	: Depth of the parsing stack
+    int	spaceMax	: Max depth of the parsing stack
+    int *	spaceTab	: array of space infos
+    int	depth	: to prevent entity substitution loops
+    xmlParserInputPtr	entity	: used to check entities boundaries
+    int	charset	: encoding of the in-memory content actually an xml
+    int	nodelen	: Those two fields are there to
+    int	nodemem	: Speed up large node parsing
+    int	pedantic	: signal pedantic warnings
+    void *	_private	: For user data, libxml won't touch it
+    int	loadsubset	: should the external subset be loaded
+    int	linenumbers	: set line number in element content
+    void *	catalogs	: document's own catalog
+    int	recovery	: run in recovery mode
+    int	progressive	: is this a progressive parsing
+    xmlDictPtr	dict	: dictionnary for the parser
+    const xmlChar * *	atts	: array for the attributes callbacks
+    int	maxatts	: the size of the array
+    int	docdict	: * pre-interned strings *
+    const xmlChar *	str_xml
+    const xmlChar *	str_xmlns
+    const xmlChar *	str_xml_ns	: * Everything below is used only by the new SAX mod
+    int	sax2	: operating in the new SAX mode
+    int	nsNr	: the number of inherited namespaces
+    int	nsMax	: the size of the arrays
+    const xmlChar * *	nsTab	: the array of prefix/namespace name
+    int *	attallocs	: which attribute were allocated
+    void * *	pushTab	: array of data for push
+    xmlHashTablePtr	attsDefault	: defaulted attributes if any
+    xmlHashTablePtr	attsSpecial	: non-CDATA attributes if any
+    int	nsWellFormed	: is the document XML Nanespace okay
+    int	options	: * Those fields are needed only for treaming parsin
+    int	dictNames	: Use dictionary names for the tree
+    int	freeElemsNr	: number of freed element nodes
+    xmlNodePtr	freeElems	: List of freed element nodes
+    int	freeAttrsNr	: number of freed attributes nodes
+    xmlAttrPtr	freeAttrs	: * the complete error informations for the last err
+    xmlError	lastError
+}

xmlNodePtr	xmlNewTextChild	(xmlNodePtr parent, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
void	xmlDocDumpFormatMemoryEnc	(xmlDocPtr out_doc, 
				 xmlChar ** doc_txt_ptr, 
				 int * doc_txt_len, 
				 const char * txt_encoding, 
				 int format)

+
xmlAttrPtr	xmlNewDocProp	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
void	xmlFreeNode	(xmlNodePtr cur)

+
xmlNodePtr	xmlNewDocTextLen	(xmlDocPtr doc, 
				 const xmlChar * content, 
				 int len)

+
const xmlChar *	xmlBufferContent	(const xmlBufferPtr buf)

+
xmlChar *	xmlNodeGetLang	(xmlNodePtr cur)

+
int	xmlValidateNMToken	(const xmlChar * value, 
				 int space)

+
void	xmlBufferSetAllocationScheme	(xmlBufferPtr buf, 
				 xmlBufferAllocationScheme scheme)

+
xmlNodePtr	xmlNewChild	(xmlNodePtr parent, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
int	xmlGetDocCompressMode	(xmlDocPtr doc)

+
int	xmlSaveFileEnc	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
Typedef xmlAttr * xmlAttrPtr
+
+
xmlAttrPtr	xmlCopyPropList	(xmlNodePtr target, 
				 xmlAttrPtr cur)

+
#define XML_XML_NAMESPACE
+
+
void	xmlNodeSetContentLen	(xmlNodePtr cur, 
				 const xmlChar * content, 
				 int len)

+
Enum xmlElementContentType {
+    XML_ELEMENT_CONTENT_PCDATA = 1
+    XML_ELEMENT_CONTENT_ELEMENT = 2
+    XML_ELEMENT_CONTENT_SEQ = 3
+    XML_ELEMENT_CONTENT_OR = 4
+}
+
+
void	xmlNodeSetSpacePreserve	(xmlNodePtr cur, 
				 int val)

+
xmlAttrPtr	xmlSetNsProp	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
xmlAttrPtr	xmlHasProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
void	xmlBufferCat	(xmlBufferPtr buf, 
				 const xmlChar * str)

+
xmlDtdPtr	xmlCreateIntSubset	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
xmlDocPtr	xmlNewDoc	(const xmlChar * version)

+
xmlNodePtr	xmlNewCharRef	(xmlDocPtr doc, 
				 const xmlChar * name)

+
xmlNsPtr	xmlCopyNamespaceList	(xmlNsPtr cur)

+
xmlNodePtr	xmlNewNodeEatName	(xmlNsPtr ns, 
				 xmlChar * name)

+
int	xmlBufferResize	(xmlBufferPtr buf, 
				 unsigned int size)

+
void	xmlNodeSetBase	(xmlNodePtr cur, 
				 const xmlChar * uri)

+
Typedef xmlElementType xmlNsType
+
+
xmlNodePtr	xmlNewComment	(const xmlChar * content)

+
#define xmlChildrenNode
+
+
int	xmlBufferLength	(const xmlBufferPtr buf)

+
Enum xmlBufferAllocationScheme {
+    XML_BUFFER_ALLOC_DOUBLEIT = 1
+    XML_BUFFER_ALLOC_EXACT = 2
+    XML_BUFFER_ALLOC_IMMUTABLE = 3
+}
+
+
Typedef unsigned char xmlChar
+
+
Enum xmlAttributeDefault {
+    XML_ATTRIBUTE_NONE = 1
+    XML_ATTRIBUTE_REQUIRED = 2
+    XML_ATTRIBUTE_IMPLIED = 3
+    XML_ATTRIBUTE_FIXED = 4
+}
+
+
xmlNodePtr	xmlNewText	(const xmlChar * content)

+
int	xmlUnsetProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
xmlBufferAllocationScheme	xmlGetBufferAllocationScheme	(void)

+
int	xmlSaveFile	(const char * filename, 
				 xmlDocPtr cur)

+
void	xmlSetNs	(xmlNodePtr node, 
				 xmlNsPtr ns)

+
Structure xmlNode
struct _xmlNode {
+    void *	_private	: application data
+    xmlElementType	type	: type number, must be second !
+    const xmlChar *	name	: the name of the node, or the entity
+    struct _xmlNode *	children	: parent->childs link
+    struct _xmlNode *	last	: last child link
+    struct _xmlNode *	parent	: child->parent link
+    struct _xmlNode *	next	: next sibling link
+    struct _xmlNode *	prev	: previous sibling link
+    struct _xmlDoc *	doc	: the containing document End of common part
+    xmlNs *	ns	: pointer to the associated namespace
+    xmlChar *	content	: the content
+    struct _xmlAttr *	properties	: properties list
+    xmlNs *	nsDef	: namespace definitions on this node
+    void *	psvi	: for type/PSVI informations
+    unsigned short	line	: line number
+    unsigned short	extra	: extra data for XPath/XSLT
+}

xmlChar *	xmlGetNsProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * nameSpace)

+
xmlNodePtr	xmlNewCDataBlock	(xmlDocPtr doc, 
				 const xmlChar * content, 
				 int len)

+
int	xmlSaveFormatFileEnc	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
xmlDtdPtr	xmlCopyDtd	(xmlDtdPtr dtd)

+
xmlNodePtr	xmlNewDocText	(xmlDocPtr doc, 
				 const xmlChar * content)

+
Typedef xmlDtd * xmlDtdPtr
+
+
xmlChar *	xmlNodeListGetRawString	(xmlDocPtr doc, 
				 xmlNodePtr list, 
				 int inLine)

+
xmlBufferPtr	xmlBufferCreateStatic	(void * mem, 
				 size_t size)

+
xmlNodePtr	xmlNewReference	(xmlDocPtr doc, 
				 const xmlChar * name)

+
void	xmlBufferCCat	(xmlBufferPtr buf, 
				 const char * str)

+
xmlNsPtr *	xmlGetNsList	(xmlDocPtr doc, 
				 xmlNodePtr node)

+
Typedef xmlEntity * xmlEntityPtr
+
+
void	xmlSetBufferAllocationScheme	(xmlBufferAllocationScheme scheme)

+
int	xmlNodeDump	(xmlBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 int level, 
				 int format)

+
int	xmlIsXHTML	(const xmlChar * systemID, 
				 const xmlChar * publicID)

+
void	xmlNodeSetLang	(xmlNodePtr cur, 
				 const xmlChar * lang)

+
void	xmlFreeDtd	(xmlDtdPtr cur)

+
void	xmlFreeNodeList	(xmlNodePtr cur)

+
void	xmlFreeDoc	(xmlDocPtr cur)

+
Structure xmlDoc
struct _xmlDoc {
+    void *	_private	: application data
+    xmlElementType	type	: XML_DOCUMENT_NODE, must be second !
+    char *	name	: name/filename/URI of the document
+    struct _xmlNode *	children	: the document tree
+    struct _xmlNode *	last	: last child link
+    struct _xmlNode *	parent	: child->parent link
+    struct _xmlNode *	next	: next sibling link
+    struct _xmlNode *	prev	: previous sibling link
+    struct _xmlDoc *	doc	: autoreference to itself End of common part
+    int	compression	: level of zlib compression
+    int	standalone	: standalone document (no external refs)
+    struct _xmlDtd *	intSubset	: the document internal subset
+    struct _xmlDtd *	extSubset	: the document external subset
+    struct _xmlNs *	oldNs	: Global namespace, the old way
+    const xmlChar *	version	: the XML version string
+    const xmlChar *	encoding	: external initial encoding, if any
+    void *	ids	: Hash table for ID attributes if any
+    void *	refs	: Hash table for IDREFs attributes if any
+    const xmlChar *	URL	: The URI for that document
+    int	charset	: encoding of the in-memory content actually an xml
+    struct _xmlDict *	dict	: dict used to allocate names or NULL
+    void *	psvi	: for type/PSVI informations
+}

xmlNodePtr	xmlNewDocNode	(xmlDocPtr doc, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Structure xmlDtd
struct _xmlDtd {
+    void *	_private	: application data
+    xmlElementType	type	: XML_DTD_NODE, must be second !
+    const xmlChar *	name	: Name of the DTD
+    struct _xmlNode *	children	: the value of the property link
+    struct _xmlNode *	last	: last child link
+    struct _xmlDoc *	parent	: child->parent link
+    struct _xmlNode *	next	: next sibling link
+    struct _xmlNode *	prev	: previous sibling link
+    struct _xmlDoc *	doc	: the containing document End of common part
+    void *	notations	: Hash table for notations if any
+    void *	elements	: Hash table for elements if any
+    void *	attributes	: Hash table for attributes if any
+    void *	entities	: Hash table for entities if any
+    const xmlChar *	ExternalID	: External identifier for PUBLIC DTD
+    const xmlChar *	SystemID	: URI for a SYSTEM or PUBLIC DTD
+    void *	pentities	: Hash table for param entities if any
+}

void	xmlDocDumpFormatMemory	(xmlDocPtr cur, 
				 xmlChar ** mem, 
				 int * size, 
				 int format)

+
Structure xmlOutputBuffer
struct _xmlOutputBuffer {
+    void *	context
+    xmlOutputWriteCallback	writecallback
+    xmlOutputCloseCallback	closecallback
+    xmlCharEncodingHandlerPtr	encoder	: I18N conversions to UTF-8
+    xmlBufferPtr	buffer	: Local buffer encoded in UTF-8 or ISOLatin
+    xmlBufferPtr	conv	: if encoder != NULL buffer for output
+    int	written	: total number of byte written
+    int	error
+}

Typedef xmlElementContent * xmlElementContentPtr
+
+
Enum xmlElementTypeVal {
+    XML_ELEMENT_TYPE_UNDEFINED = 0
+    XML_ELEMENT_TYPE_EMPTY = 1
+    XML_ELEMENT_TYPE_ANY = 2
+    XML_ELEMENT_TYPE_MIXED = 3
+    XML_ELEMENT_TYPE_ELEMENT = 4
+}
+
+
xmlDtdPtr	xmlNewDtd	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Typedef xmlParserInputBuffer * xmlParserInputBufferPtr
+
+
xmlAttrPtr	xmlNewNsProp	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
void	xmlFreeNsList	(xmlNsPtr cur)

+
xmlNodePtr	xmlGetLastChild	(xmlNodePtr parent)

+
Description

+
Function: xmlNewDocRawNode
xmlNodePtr	xmlNewDocRawNode	(xmlDocPtr doc, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Creation of a new node element within a document. @ns and @content are optional (NULL).

+
doc:the document
ns:namespace if any
name:the node name
content:the text content if any
Returns:a pointer to the new node object.

+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlGetProp
xmlChar *	xmlGetProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
Search and get the value of an attribute associated to a node This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. NOTE: this function acts independently of namespaces associated to the attribute. Use xmlGetNsProp() or xmlGetNoNsProp() for namespace aware processing.

+
node:the node
name:the attribute name
Returns:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().
Function: xmlNewNsPropEatName
xmlAttrPtr	xmlNewNsPropEatName	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 xmlChar * name, 
				 const xmlChar * value)

+
Create a new property tagged with a namespace and carried by a node.

+
node:the holding node
ns:the namespace
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute
Function: xmlDocCopyNode
xmlNodePtr	xmlDocCopyNode	(const xmlNodePtr node, 
				 xmlDocPtr doc, 
				 int recursive)

+
Do a copy of the node to a given document.

+
node:the node
doc:the document
recursive:if 1 do a recursive copy.
Returns:a new #xmlNodePtr, or NULL in case of error.
Function: xmlStringGetNodeList
xmlNodePtr	xmlStringGetNodeList	(xmlDocPtr doc, 
				 const xmlChar * value)

+
Parse the value string and build the node list associated. Should produce a flat tree with only TEXTs and ENTITY_REFs.

+
doc:the document
value:the value of the attribute
Returns:a pointer to the first child
Function: xmlBufferWriteCHAR
void	xmlBufferWriteCHAR	(xmlBufferPtr buf, 
				 const xmlChar * string)

+
routine which manages and grows an output buffer. This one adds xmlChars at the end of the buffer.

+
buf:the XML buffer
string:the string to add
Macro: BAD_CAST
#define BAD_CAST
Macro to cast a string to an xmlChar * when one know its safe.

+
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlNodeGetBase
xmlChar *	xmlNodeGetBase	(xmlDocPtr doc, 
				 xmlNodePtr cur)

+
Searches for the BASE URL. The code should work on both XML and HTML document even if base mechanisms are completely different. It returns the base as defined in RFC 2396 sections 5.1.1. Base URI within Document Content and 5.1.2. Base URI from the Encapsulating Entity However it does not return the document base (5.1.3), use xmlDocumentGetBase() for this

+
doc:the document the node pertains to
cur:the node being checked
Returns:a pointer to the base URL, or NULL if not found It's up to the caller to free the memory with xmlFree().
Function: xmlBufferEmpty
void	xmlBufferEmpty	(xmlBufferPtr buf)

+
empty a buffer.

+
buf:the buffer
Function: xmlSaveFormatFile
int	xmlSaveFormatFile	(const char * filename, 
				 xmlDocPtr cur, 
				 int format)

+
Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used. If @format is set then the document will be indented on output. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

+
filename:the filename (or URL)
cur:the document
format:should formatting spaces been added
Returns:the number of bytes written or -1 in case of failure.
Function: xmlNewDocNodeEatName
xmlNodePtr	xmlNewDocNodeEatName	(xmlDocPtr doc, 
				 xmlNsPtr ns, 
				 xmlChar * name, 
				 const xmlChar * content)

+
Creation of a new node element within a document. @ns and @content are optional (NULL). NOTE: @content is supposed to be a piece of XML CDATA, so it allow entities references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't need entities support.

+
doc:the document
ns:namespace if any
name:the node name
content:the XML text content if any
Returns:a pointer to the new node object.
Function: xmlAddSibling
xmlNodePtr	xmlAddSibling	(xmlNodePtr cur, 
				 xmlNodePtr elem)

+
Add a new element @elem to the list of siblings of @cur merging adjacent TEXT nodes (@elem may be freed) If the new element was already inserted in a document it is first unlinked from its existing context.

+
cur:the child node
elem:the new node
Returns:the new element or NULL in case of error.
Function: xmlNewDocFragment
xmlNodePtr	xmlNewDocFragment	(xmlDocPtr doc)

+
Creation of a new Fragment node.

+
doc:the document owning the fragment
Returns:a pointer to the new node object.
Function: xmlDocGetRootElement
xmlNodePtr	xmlDocGetRootElement	(xmlDocPtr doc)

+
Get the root element of the document (doc->children is a list containing possibly comments, PIs, etc ...).

+
doc:the document
Returns:the #xmlNodePtr for the root or NULL
Function: xmlNodeAddContentLen
void	xmlNodeAddContentLen	(xmlNodePtr cur, 
				 const xmlChar * content, 
				 int len)

+
Append the extra substring to the node content.

+
cur:the node being modified
content:extra content
len:the size of @content

+      
+      
+      
+    
Function: xmlValidateQName
int	xmlValidateQName	(const xmlChar * value, 
				 int space)

+
Check that a value conforms to the lexical space of QName

+
value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlHasNsProp
xmlAttrPtr	xmlHasNsProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * nameSpace)

+
Search for an attribute associated to a node This attribute has to be anchored in the namespace specified. This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off.

+
node:the node
name:the attribute name
nameSpace:the URI of the namespace
Returns:the attribute or the attribute declaration or NULL if neither was found.
Function: xmlAddPrevSibling
xmlNodePtr	xmlAddPrevSibling	(xmlNodePtr cur, 
				 xmlNodePtr elem)

+
Add a new node @elem as the previous sibling of @cur merging adjacent TEXT nodes (@elem may be freed) If the new node was already inserted in a document it is first unlinked from its existing context. If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

+
cur:the child node
elem:the new node
Returns:the new node or NULL in case of error.
Function: xmlBufferAddHead
void	xmlBufferAddHead	(xmlBufferPtr buf, 
				 const xmlChar * str, 
				 int len)

+
Add a string range to the beginning of an XML buffer. if len == -1, the length of @str is recomputed.

+
buf:the buffer
str:the #xmlChar string
len:the number of #xmlChar to add
Function: xmlSetListDoc
void	xmlSetListDoc	(xmlNodePtr list, 
				 xmlDocPtr doc)

+
update all nodes in the list to point to the right document

+
list:the first element
doc:the document
Function: xmlNewPI
xmlNodePtr	xmlNewPI	(const xmlChar * name, 
				 const xmlChar * content)

+
Creation of a processing instruction element.

+
name:the processing instruction name
content:the PI content
Returns:a pointer to the new node object.
Function: xmlDocFormatDump
int	xmlDocFormatDump	(FILE * f, 
				 xmlDocPtr cur, 
				 int format)

+
Dump an XML document to an open FILE.

+
f:the FILE*
cur:the document
format:should formatting spaces been added
Returns:the number of bytes written or -1 in case of failure. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called
Function: xmlSetProp
xmlAttrPtr	xmlSetProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Set (or reset) an attribute carried by a node.

+
node:the node
name:the attribute name
value:the attribute value
Returns:the attribute pointer.
Function: xmlElemDump
void	xmlElemDump	(FILE * f, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur)

+
Dump an XML/HTML node, recursive behaviour, children are printed too.

+
f:the FILE * for the output
doc:the document
cur:the current node

+      
+      
+      
+      
+      
+      
+    
Function: xmlSaveFormatFileTo
int	xmlSaveFormatFileTo	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
Dump an XML document to an I/O buffer.

+
buf:an output I/O buffer
cur:the document
encoding:the encoding if any assuming the I/O layer handles the trancoding
format:should formatting spaces been added
Returns:the number of bytes written or -1 in case of failure. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called
Function: xmlGetIntSubset
xmlDtdPtr	xmlGetIntSubset	(xmlDocPtr doc)

+
Get the internal subset of a document

+
doc:the document pointer
Returns:a pointer to the DTD structure or NULL if not found
Function: xmlNodeBufGetContent
int	xmlNodeBufGetContent	(xmlBufferPtr buffer, 
				 xmlNodePtr cur)

+
Read the value of a node @cur, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted. Fills up the buffer @buffer with this value

+
buffer:a buffer
cur:the node being read
Returns:0 in case of success and -1 in case of error.
Function: xmlBufferFree
void	xmlBufferFree	(xmlBufferPtr buf)

+
Frees an XML buffer. It frees both the content and the structure which encapsulate it.

+
buf:the buffer to free
Function: xmlReplaceNode
xmlNodePtr	xmlReplaceNode	(xmlNodePtr old, 
				 xmlNodePtr cur)

+
Unlink the old node from its current context, prune the new one at the same place. If @cur was already inserted in a document it is first unlinked from its existing context.

+
old:the old node
cur:the node
Returns:the @old node
Function: xmlNewNode
xmlNodePtr	xmlNewNode	(xmlNsPtr ns, 
				 const xmlChar * name)

+
Creation of a new node element. @ns is optional (NULL).

+
ns:namespace if any
name:the node name
Returns:a pointer to the new node object. Uses xmlStrdup() to make copy of @name.
Function: xmlSaveFileTo
int	xmlSaveFileTo	(xmlOutputBufferPtr buf, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
Dump an XML document to an I/O buffer.

+
buf:an output I/O buffer
cur:the document
encoding:the encoding if any assuming the I/O layer handles the trancoding
Returns:the number of bytes written or -1 in case of failure.

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlNodeSetContent
void	xmlNodeSetContent	(xmlNodePtr cur, 
				 const xmlChar * content)

+
Replace the content of a node.

+
cur:the node being modified
content:the new value of the content
Function: xmlBufferAdd
void	xmlBufferAdd	(xmlBufferPtr buf, 
				 const xmlChar * str, 
				 int len)

+
Add a string range to an XML buffer. if len == -1, the length of str is recomputed.

+
buf:the buffer to dump
str:the #xmlChar string
len:the number of #xmlChar to add
Function: xmlNodeDumpOutput
void	xmlNodeDumpOutput	(xmlOutputBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 int level, 
				 int format, 
				 const char * encoding)

+
Dump an XML node, recursive behaviour, children are printed too. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

+
buf:the XML buffer output
doc:the document
cur:the current node
level:the imbrication level for indenting
format:is formatting allowed
encoding:an optional encoding string
Function: xmlCopyNamespace
xmlNsPtr	xmlCopyNamespace	(xmlNsPtr cur)

+
Do a copy of the namespace.

+
cur:the namespace
Returns:a new #xmlNsPtr, or NULL in case of error.
Function: xmlSearchNsByHref
xmlNsPtr	xmlSearchNsByHref	(xmlDocPtr doc, 
				 xmlNodePtr node, 
				 const xmlChar * href)

+
Search a Ns aliasing a given URI. Recurse on the parents until it finds the defined namespace or return NULL otherwise.

+
doc:the document
node:the current node
href:the namespace value
Returns:the namespace pointer or NULL.
Function: xmlAddChild
xmlNodePtr	xmlAddChild	(xmlNodePtr parent, 
				 xmlNodePtr cur)

+
Add a new node to @parent, at the end of the child (or property) list merging adjacent TEXT nodes (in which case @cur is freed) If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

+
parent:the parent node
cur:the child node
Returns:the child or NULL in case of error.
Function: xmlReconciliateNs
int	xmlReconciliateNs	(xmlDocPtr doc, 
				 xmlNodePtr tree)

+
This function checks that all the namespaces declared within the given tree are properly declared. This is needed for example after Copy or Cut and then paste operations. The subtree may still hold pointers to namespace declarations outside the subtree or invalid/masked. As much as possible the function try to reuse the existing namespaces found in the new environment. If not possible the new namespaces are redeclared on @tree at the top of the given subtree.

+
doc:the document
tree:a node defining the subtree to reconciliate
Returns:the number of namespace declarations created or -1 in case of error.

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Macro: XML_GET_CONTENT
#define XML_GET_CONTENT
Macro to extract the content pointer of a node.

+
Function: xmlNodeSetName
void	xmlNodeSetName	(xmlNodePtr cur, 
				 const xmlChar * name)

+
Set (or reset) the name of a node.

+
cur:the node being changed
name:the new tag name
Function: xmlValidateNCName
int	xmlValidateNCName	(const xmlChar * value, 
				 int space)

+
Check that a value conforms to the lexical space of NCName

+
value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlNewDocComment
xmlNodePtr	xmlNewDocComment	(xmlDocPtr doc, 
				 const xmlChar * content)

+
Creation of a new node containing a comment within a document.

+
doc:the document
content:the comment content
Returns:a pointer to the new node object.

+      
+      
+      
+      
+      
+    
Function: xmlGetCompressMode
int	xmlGetCompressMode	(void)

+
get the default compression mode used, ZLIB based.

+
Returns:0 (uncompressed) to 9 (max compression)
Macro: xmlRootNode
#define xmlRootNode
Macro for compatibility naming layer with libxml1.

+
Function: xmlBufferCreateSize
xmlBufferPtr	xmlBufferCreateSize	(size_t size)

+
routine to create an XML buffer.

+
size:initial size of buffer
Returns:the new structure.
Function: xmlNodeListGetString
xmlChar *	xmlNodeListGetString	(xmlDocPtr doc, 
				 xmlNodePtr list, 
				 int inLine)

+
Build the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs

+
doc:the document
list:a Node list
inLine:should we replace entity contents or show their external form
Returns:a pointer to the string copy, the caller must free it with xmlFree().
Function: xmlSetCompressMode
void	xmlSetCompressMode	(int mode)

+
set the default compression mode used, ZLIB based Correct values: 0 (uncompressed) to 9 (max compression)

+
mode:the compression ratio
Function: xmlSetTreeDoc
void	xmlSetTreeDoc	(xmlNodePtr tree, 
				 xmlDocPtr doc)

+
update all nodes under the tree to point to the right document

+
tree:the top element
doc:the document
Function: xmlBufferCreate
xmlBufferPtr	xmlBufferCreate	(void)

+
routine to create an XML buffer.

+
Returns:the new structure.
Function: xmlCopyNodeList
xmlNodePtr	xmlCopyNodeList	(const xmlNodePtr node)

+
Do a recursive copy of the node list.

+
node:the first node in the list.
Returns:a new #xmlNodePtr, or NULL in case of error.
Function: xmlBufferGrow
int	xmlBufferGrow	(xmlBufferPtr buf, 
				 unsigned int len)

+
Grow the available space of an XML buffer.

+
buf:the buffer
len:the minimum free size to allocate
Returns:the new available space or -1 in case of error
Function: xmlAddChildList
xmlNodePtr	xmlAddChildList	(xmlNodePtr parent, 
				 xmlNodePtr cur)

+
Add a list of node at the end of the child list of the parent merging adjacent TEXT nodes (@cur may be freed)

+
parent:the parent node
cur:the first node in the list
Returns:the last child or NULL in case of error.
Function: xmlGetNodePath
xmlChar *	xmlGetNodePath	(xmlNodePtr node)

+
Build a structure based Path for the given node

+
node:a node
Returns:the new path or NULL in case of error. The caller must free the returned string
Function: xmlFreePropList
void	xmlFreePropList	(xmlAttrPtr cur)

+
Free a property and all its siblings, all the children are freed too.

+
cur:the first property in the list
Function: xmlNodeAddContent
void	xmlNodeAddContent	(xmlNodePtr cur, 
				 const xmlChar * content)

+
Append the extra substring to the node content.

+
cur:the node being modified
content:extra content
Function: xmlUnsetNsProp
int	xmlUnsetNsProp	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 const xmlChar * name)

+
Remove an attribute carried by a node.

+
node:the node
ns:the namespace definition
name:the attribute name
Returns:0 if successful, -1 if not found
Function: xmlNodeIsText
int	xmlNodeIsText	(xmlNodePtr node)

+
Is this node a Text node ?

+
node:the node
Returns:1 yes, 0 no

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlAddNextSibling
xmlNodePtr	xmlAddNextSibling	(xmlNodePtr cur, 
				 xmlNodePtr elem)

+
Add a new node @elem as the next sibling of @cur If the new node was already inserted in a document it is first unlinked from its existing context. As a result of text merging @elem may be freed. If the new node is ATTRIBUTE, it is added into properties instead of children. If there is an attribute with equal name, it is first destroyed.

+
cur:the child node
elem:the new node
Returns:the new node or NULL in case of error.
Function: xmlIsBlankNode
int	xmlIsBlankNode	(xmlNodePtr node)

+
Checks whether this node is an empty or whitespace only (and possibly ignorable) text-node.

+
node:the node
Returns:1 yes, 0 no

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlValidateName
int	xmlValidateName	(const xmlChar * value, 
				 int space)

+
Check that a value conforms to the lexical space of Name

+
value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlNewGlobalNs
xmlNsPtr	xmlNewGlobalNs	(xmlDocPtr doc, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
Creation of a Namespace, the old way using PI and without scoping DEPRECATED !!! It now create a namespace on the root element of the document if found.

+
doc:the document carrying the namespace
href:the URI associated
prefix:the prefix for the namespace
Returns:NULL this functionality had been removed
Function: xmlBufferDump
int	xmlBufferDump	(FILE * file, 
				 xmlBufferPtr buf)

+
Dumps an XML buffer to a FILE *.

+
file:the file output
buf:the buffer to dump
Returns:the number of #xmlChar written
Function: xmlNewNs
xmlNsPtr	xmlNewNs	(xmlNodePtr node, 
				 const xmlChar * href, 
				 const xmlChar * prefix)

+
Creation of a new Namespace. This function will refuse to create a namespace with a similar prefix than an existing one present on this node. We use href==NULL in the case of an element creation where the namespace was not defined.

+
node:the element carrying the namespace
href:the URI associated
prefix:the prefix for the namespace
Returns:a new namespace pointer or NULL
Function: xmlCopyDoc
xmlDocPtr	xmlCopyDoc	(xmlDocPtr doc, 
				 int recursive)

+
Do a copy of the document info. If recursive, the content tree will be copied too as well as DTD, namespaces and entities.

+
doc:the document
recursive:if 1 do a recursive copy.
Returns:a new #xmlDocPtr, or NULL in case of error.
Function: xmlDocDumpMemoryEnc
void	xmlDocDumpMemoryEnc	(xmlDocPtr out_doc, 
				 xmlChar ** doc_txt_ptr, 
				 int * doc_txt_len, 
				 const char * txt_encoding)

+
Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the allocated memory with xmlFree().

+
out_doc:Document to generate XML text from
doc_txt_ptr:Memory pointer for allocated XML text
doc_txt_len:Length of the generated XML text
txt_encoding:Character encoding to use when generating XML text
Function: xmlTextMerge
xmlNodePtr	xmlTextMerge	(xmlNodePtr first, 
				 xmlNodePtr second)

+
Merge two text nodes into one

+
first:the first text node
second:the second text node being merged
Returns:the first text node augmented
Function: xmlDocDumpMemory
void	xmlDocDumpMemory	(xmlDocPtr cur, 
				 xmlChar ** mem, 
				 int * size)

+
Dump an XML document in memory and return the #xmlChar * and it's size. It's up to the caller to free the memory with xmlFree().

+
cur:the document
mem:OUT: the memory pointer
size:OUT: the memory length
Function: xmlNewTextLen
xmlNodePtr	xmlNewTextLen	(const xmlChar * content, 
				 int len)

+
Creation of a new text node with an extra parameter for the content's length

+
content:the text content
len:the text len.
Returns:a pointer to the new node object.
Function: xmlFreeNs
void	xmlFreeNs	(xmlNsPtr cur)

+
Free up the structures associated to a namespace

+
cur:the namespace pointer
Function: xmlDocDump
int	xmlDocDump	(FILE * f, 
				 xmlDocPtr cur)

+
Dump an XML document to an open FILE.

+
f:the FILE*
cur:the document
Returns:the number of bytes written or -1 in case of failure.
Macro: BASE_BUFFER_SIZE
#define BASE_BUFFER_SIZE
default buffer size 4000.

+
Function: xmlFreeProp
void	xmlFreeProp	(xmlAttrPtr cur)

+
Free one attribute, all the content is freed too

+
cur:an attribute

+      
+      
+    
Function: xmlBufferWriteChar
void	xmlBufferWriteChar	(xmlBufferPtr buf, 
				 const char * string)

+
routine which manage and grows an output buffer. This one add C chars at the end of the array.

+
buf:the XML buffer output
string:the string to add
Function: xmlGetNoNsProp
xmlChar *	xmlGetNoNsProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
Search and get the value of an attribute associated to a node This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off. This function is similar to xmlGetProp except it will accept only an attribute in no namespace.

+
node:the node
name:the attribute name
Returns:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().
Function: xmlSplitQName2
xmlChar *	xmlSplitQName2	(const xmlChar * name, 
				 xmlChar ** prefix)

+
parse an XML qualified name string [NS 5] QName ::= (Prefix ':')? LocalPart [NS 6] Prefix ::= NCName [NS 7] LocalPart ::= NCName

+
name:the full QName
prefix:a xmlChar **
Returns:NULL if not a QName, otherwise the local part, and prefix is updated to get the Prefix if any.

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Macro: XML_GET_LINE
#define XML_GET_LINE
Macro to extract the line number of an element node. This will work only if line numbering is activated by calling xmlLineNumbersDefault(1) before parsing.

+
Function: xmlNewProp
xmlAttrPtr	xmlNewProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Create a new property carried by a node.

+
node:the holding node
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute
Function: xmlTextConcat
int	xmlTextConcat	(xmlNodePtr node, 
				 const xmlChar * content, 
				 int len)

+
Concat the given string at the end of the existing node content

+
node:the node
content:the content
len:@content length
Returns:-1 in case of error, 0 otherwise

+      
+      
+      
+      
+    
Function: xmlNodeGetSpacePreserve
int	xmlNodeGetSpacePreserve	(xmlNodePtr cur)

+
Searches the space preserving behaviour of a node, i.e. the values of the xml:space attribute or the one carried by the nearest ancestor.

+
cur:the node being checked
Returns:-1 if xml:space is not inherited, 0 if "default", 1 if "preserve"
Function: xmlBufferShrink
int	xmlBufferShrink	(xmlBufferPtr buf, 
				 unsigned int len)

+
Remove the beginning of an XML buffer.

+
buf:the buffer to dump
len:the number of xmlChar to remove
Returns:the number of #xmlChar removed, or -1 in case of failure.
Function: xmlNodeGetContent
xmlChar *	xmlNodeGetContent	(xmlNodePtr cur)

+
Read the value of a node, this can be either the text carried directly by this node if it's a TEXT node or the aggregate string of the values carried by this node child's (TEXT and ENTITY_REF). Entity references are substituted.

+
cur:the node being read
Returns:a new #xmlChar * or NULL if no content is available. It's up to the caller to free the memory with xmlFree().
Macro: XML_LOCAL_NAMESPACE
#define XML_LOCAL_NAMESPACE
A namespace declaration node.

+
Function: xmlStringLenGetNodeList
xmlNodePtr	xmlStringLenGetNodeList	(xmlDocPtr doc, 
				 const xmlChar * value, 
				 int len)

+
Parse the value string and build the node list associated. Should produce a flat tree with only TEXTs and ENTITY_REFs.

+
doc:the document
value:the value of the text
len:the length of the string value
Returns:a pointer to the first child
Function: xmlBuildQName
xmlChar *	xmlBuildQName	(const xmlChar * ncname, 
				 const xmlChar * prefix, 
				 xmlChar * memory, 
				 int len)

+
Builds the QName @prefix:@ncname in @memory if there is enough space and prefix is not NULL nor empty, otherwise allocate a new string. If prefix is NULL or empty it returns ncname.

+
ncname:the Name
prefix:the prefix
memory:preallocated memory
len:preallocated memory length
Returns:the new string which must be freed by the caller if different from @memory and @ncname or NULL in case of error

+      
+      
+      
+      
+    
Function: xmlBufferWriteQuotedString
void	xmlBufferWriteQuotedString	(xmlBufferPtr buf, 
				 const xmlChar * string)

+
routine which manage and grows an output buffer. This one writes a quoted or double quoted #xmlChar string, checking first if it holds quote or double-quotes internally

+
buf:the XML buffer output
string:the string to add
Function: xmlCopyProp
xmlAttrPtr	xmlCopyProp	(xmlNodePtr target, 
				 xmlAttrPtr cur)

+
Do a copy of the attribute.

+
target:the element where the attribute will be grafted
cur:the attribute
Returns:a new #xmlAttrPtr, or NULL in case of error.

+      
+      
+      
+      
+      
+    
Function: xmlSetDocCompressMode
void	xmlSetDocCompressMode	(xmlDocPtr doc, 
				 int mode)

+
set the compression ratio for a document, ZLIB based Correct values: 0 (uncompressed) to 9 (max compression)

+
doc:the document
mode:the compression ratio
Function: xmlCopyNode
xmlNodePtr	xmlCopyNode	(const xmlNodePtr node, 
				 int recursive)

+
Do a copy of the node.

+
node:the node
recursive:if 1 do a recursive copy.
Returns:a new #xmlNodePtr, or NULL in case of error.
Function: xmlUnlinkNode
void	xmlUnlinkNode	(xmlNodePtr cur)

+
Unlink a node from it's current context, the node is not freed

+
cur:the node
Function: xmlSplitQName3
const xmlChar *	xmlSplitQName3	(const xmlChar * name, 
				 int * len)

+
parse an XML qualified name string,i

+
name:the full QName
len:an int *
Returns:NULL if it is not a Qualified Name, otherwise, update len with the lenght in byte of the prefix and return a pointer

+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlDocSetRootElement
xmlNodePtr	xmlDocSetRootElement	(xmlDocPtr doc, 
				 xmlNodePtr root)

+
Set the root element of the document (doc->children is a list containing possibly comments, PIs, etc ...).

+
doc:the document
root:the new document root element
Returns:the old root element if any was found
Function: xmlSearchNs
xmlNsPtr	xmlSearchNs	(xmlDocPtr doc, 
				 xmlNodePtr node, 
				 const xmlChar * nameSpace)

+
Search a Ns registered under a given name space for a document. recurse on the parents until it finds the defined namespace or return NULL otherwise. @nameSpace can be NULL, this is a search for the default namespace. We don't allow to cross entities boundaries. If you don't declare the namespace within those you will be in troubles !!! A warning is generated to cover this case.

+
doc:the document
node:the current node
nameSpace:the namespace prefix
Returns:the namespace pointer or NULL.
Function: xmlGetLineNo
long	xmlGetLineNo	(xmlNodePtr node)

+
Get line number of @node. This requires activation of this option before invoking the parser by calling xmlLineNumbersDefault(1)

+
node:valid node
Returns:the line number if successful, -1 otherwise
Function: xmlRemoveProp
int	xmlRemoveProp	(xmlAttrPtr cur)

+
Unlink and free one attribute, all the content is freed too Note this doesn't work for namespace definition attributes

+
cur:an attribute
Returns:0 if success and -1 in case of error.

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlNewTextChild
xmlNodePtr	xmlNewTextChild	(xmlNodePtr parent, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Creation of a new child element, added at the end of @parent children list. @ns and @content parameters are optional (NULL). If @content is non NULL, a child TEXT node will be created containing the string @content. NOTE: Use xmlNewChild() if entity support for @content is needed.

+
parent:the parent node
ns:a namespace if any
name:the name of the child
content:the text content of the child if any.
Returns:a pointer to the new node object.
Function: xmlDocDumpFormatMemoryEnc
void	xmlDocDumpFormatMemoryEnc	(xmlDocPtr out_doc, 
				 xmlChar ** doc_txt_ptr, 
				 int * doc_txt_len, 
				 const char * txt_encoding, 
				 int format)

+
Dump the current DOM tree into memory using the character encoding specified by the caller. Note it is up to the caller of this function to free the allocated memory with xmlFree(). Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

+
out_doc:Document to generate XML text from
doc_txt_ptr:Memory pointer for allocated XML text
doc_txt_len:Length of the generated XML text
txt_encoding:Character encoding to use when generating XML text
format:should formatting spaces been added
Function: xmlNewDocProp
xmlAttrPtr	xmlNewDocProp	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Create a new property carried by a document.

+
doc:the document
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute
Function: xmlFreeNode
void	xmlFreeNode	(xmlNodePtr cur)

+
Free a node, this is a recursive behaviour, all the children are freed too. This doesn't unlink the child from the list, use xmlUnlinkNode() first.

+
cur:the node
Function: xmlNewDocTextLen
xmlNodePtr	xmlNewDocTextLen	(xmlDocPtr doc, 
				 const xmlChar * content, 
				 int len)

+
Creation of a new text node with an extra content length parameter. The text node pertain to a given document.

+
doc:the document
content:the text content
len:the text len.
Returns:a pointer to the new node object.
Function: xmlBufferContent
const xmlChar *	xmlBufferContent	(const xmlBufferPtr buf)

+
Function to extract the content of a buffer

+
buf:the buffer
Returns:the internal content
Function: xmlNodeGetLang
xmlChar *	xmlNodeGetLang	(xmlNodePtr cur)

+
Searches the language of a node, i.e. the values of the xml:lang attribute or the one carried by the nearest ancestor.

+
cur:the node being checked
Returns:a pointer to the lang value, or NULL if not found It's up to the caller to free the memory with xmlFree().
Function: xmlValidateNMToken
int	xmlValidateNMToken	(const xmlChar * value, 
				 int space)

+
Check that a value conforms to the lexical space of NMToken

+
value:the value to check
space:allow spaces in front and end of the string
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlBufferSetAllocationScheme
void	xmlBufferSetAllocationScheme	(xmlBufferPtr buf, 
				 xmlBufferAllocationScheme scheme)

+
Sets the allocation scheme for this buffer

+
buf:the buffer to tune
scheme:allocation scheme to use
Function: xmlNewChild
xmlNodePtr	xmlNewChild	(xmlNodePtr parent, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Creation of a new child element, added at the end of @parent children list. @ns and @content parameters are optional (NULL). If @content is non NULL, a child list containing the TEXTs and ENTITY_REFs node will be created. NOTE: @content is supposed to be a piece of XML CDATA, so it allow entities references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant(). Use xmlNewTextChild() if entities support is not needed.

+
parent:the parent node
ns:a namespace if any
name:the name of the child
content:the XML content of the child if any.
Returns:a pointer to the new node object.
Function: xmlGetDocCompressMode
int	xmlGetDocCompressMode	(xmlDocPtr doc)

+
get the compression ratio for a document, ZLIB based

+
doc:the document
Returns:0 (uncompressed) to 9 (max compression)
Function: xmlSaveFileEnc
int	xmlSaveFileEnc	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding)

+
Dump an XML document, converting it to the given encoding

+
filename:the filename (or URL)
cur:the document
encoding:the name of an encoding (or NULL)
Returns:the number of bytes written or -1 in case of failure.
Function: xmlCopyPropList
xmlAttrPtr	xmlCopyPropList	(xmlNodePtr target, 
				 xmlAttrPtr cur)

+
Do a copy of an attribute list.

+
target:the element where the attributes will be grafted
cur:the first attribute
Returns:a new #xmlAttrPtr, or NULL in case of error.
Macro: XML_XML_NAMESPACE
#define XML_XML_NAMESPACE
This is the namespace for the special xml: prefix predefined in the XML Namespace specification.

+
Function: xmlNodeSetContentLen
void	xmlNodeSetContentLen	(xmlNodePtr cur, 
				 const xmlChar * content, 
				 int len)

+
Replace the content of a node.

+
cur:the node being modified
content:the new value of the content
len:the size of @content
Function: xmlNodeSetSpacePreserve
void	xmlNodeSetSpacePreserve	(xmlNodePtr cur, 
				 int val)

+
Set (or reset) the space preserving behaviour of a node, i.e. the value of the xml:space attribute.

+
cur:the node being changed
val:the xml:space value ("0": default, 1: "preserve")
Function: xmlSetNsProp
xmlAttrPtr	xmlSetNsProp	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Set (or reset) an attribute carried by a node. The ns structure must be in scope, this is not checked.

+
node:the node
ns:the namespace definition
name:the attribute name
value:the attribute value
Returns:the attribute pointer.
Function: xmlHasProp
xmlAttrPtr	xmlHasProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
Search an attribute associated to a node This function also looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off.

+
node:the node
name:the attribute name
Returns:the attribute or the attribute declaration or NULL if neither was found.
Function: xmlBufferCat
void	xmlBufferCat	(xmlBufferPtr buf, 
				 const xmlChar * str)

+
Append a zero terminated string to an XML buffer.

+
buf:the buffer to dump
str:the #xmlChar string
Function: xmlCreateIntSubset
xmlDtdPtr	xmlCreateIntSubset	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Create the internal subset of a document

+
doc:the document pointer
name:the DTD name
ExternalID:the external (PUBLIC) ID
SystemID:the system ID
Returns:a pointer to the new DTD structure
Function: xmlNewDoc
xmlDocPtr	xmlNewDoc	(const xmlChar * version)

+
Creates a new XML document

+
version:xmlChar string giving the version of XML "1.0"
Returns:a new document
Function: xmlNewCharRef
xmlNodePtr	xmlNewCharRef	(xmlDocPtr doc, 
				 const xmlChar * name)

+
Creation of a new character reference node.

+
doc:the document
name:the char ref string, starting with # or "&# ... ;"
Returns:a pointer to the new node object.
Function: xmlCopyNamespaceList
xmlNsPtr	xmlCopyNamespaceList	(xmlNsPtr cur)

+
Do a copy of an namespace list.

+
cur:the first namespace
Returns:a new #xmlNsPtr, or NULL in case of error.
Function: xmlNewNodeEatName
xmlNodePtr	xmlNewNodeEatName	(xmlNsPtr ns, 
				 xmlChar * name)

+
Creation of a new node element. @ns is optional (NULL).

+
ns:namespace if any
name:the node name
Returns:a pointer to the new node object, with pointer @name as new node's name. Use xmlNewNode() if a copy of @name string is is needed as new node's name.
Function: xmlBufferResize
int	xmlBufferResize	(xmlBufferPtr buf, 
				 unsigned int size)

+
Resize a buffer to accommodate minimum size of @size.

+
buf:the buffer to resize
size:the desired size
Returns:0 in case of problems, 1 otherwise
Function: xmlNodeSetBase
void	xmlNodeSetBase	(xmlNodePtr cur, 
				 const xmlChar * uri)

+
Set (or reset) the base URI of a node, i.e. the value of the xml:base attribute.

+
cur:the node being changed
uri:the new base URI
Function: xmlNewComment
xmlNodePtr	xmlNewComment	(const xmlChar * content)

+
Creation of a new node containing a comment.

+
content:the comment content
Returns:a pointer to the new node object.
Macro: xmlChildrenNode
#define xmlChildrenNode
Macro for compatibility naming layer with libxml1.

+
Function: xmlBufferLength
int	xmlBufferLength	(const xmlBufferPtr buf)

+
Function to get the length of a buffer

+
buf:the buffer
Returns:the length of data in the internal content
Function: xmlNewText
xmlNodePtr	xmlNewText	(const xmlChar * content)

+
Creation of a new text node.

+
content:the text content
Returns:a pointer to the new node object.
Function: xmlUnsetProp
int	xmlUnsetProp	(xmlNodePtr node, 
				 const xmlChar * name)

+
Remove an attribute carried by a node.

+
node:the node
name:the attribute name
Returns:0 if successful, -1 if not found
Function: xmlGetBufferAllocationScheme
xmlBufferAllocationScheme	xmlGetBufferAllocationScheme	(void)

+
Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, improves performance

+
Returns:the current allocation scheme
Function: xmlSaveFile
int	xmlSaveFile	(const char * filename, 
				 xmlDocPtr cur)

+
Dump an XML document to a file. Will use compression if compiled in and enabled. If @filename is "-" the stdout file is used.

+
filename:the filename (or URL)
cur:the document
Returns:the number of bytes written or -1 in case of failure.
Function: xmlSetNs
void	xmlSetNs	(xmlNodePtr node, 
				 xmlNsPtr ns)

+
Associate a namespace to a node, a posteriori.

+
node:a node in the document
ns:a namespace pointer

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlGetNsProp
xmlChar *	xmlGetNsProp	(xmlNodePtr node, 
				 const xmlChar * name, 
				 const xmlChar * nameSpace)

+
Search and get the value of an attribute associated to a node This attribute has to be anchored in the namespace specified. This does the entity substitution. This function looks in DTD attribute declaration for #FIXED or default declaration values unless DTD use has been turned off.

+
node:the node
name:the attribute name
nameSpace:the URI of the namespace
Returns:the attribute value or NULL if not found. It's up to the caller to free the memory with xmlFree().
Function: xmlNewCDataBlock
xmlNodePtr	xmlNewCDataBlock	(xmlDocPtr doc, 
				 const xmlChar * content, 
				 int len)

+
Creation of a new node containing a CDATA block.

+
doc:the document
content:the CDATA block content content
len:the length of the block
Returns:a pointer to the new node object.
Function: xmlSaveFormatFileEnc
int	xmlSaveFormatFileEnc	(const char * filename, 
				 xmlDocPtr cur, 
				 const char * encoding, 
				 int format)

+
Dump an XML document to a file or an URL.

+
filename:the filename or URL to output
cur:the document being saved
encoding:the name of the encoding to use or NULL.
format:should formatting spaces be added.
Returns:the number of bytes written or -1 in case of error. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called
Function: xmlCopyDtd
xmlDtdPtr	xmlCopyDtd	(xmlDtdPtr dtd)

+
Do a copy of the dtd.

+
dtd:the dtd
Returns:a new #xmlDtdPtr, or NULL in case of error.
Function: xmlNewDocText
xmlNodePtr	xmlNewDocText	(xmlDocPtr doc, 
				 const xmlChar * content)

+
Creation of a new text node within a document.

+
doc:the document
content:the text content
Returns:a pointer to the new node object.
Function: xmlNodeListGetRawString
xmlChar *	xmlNodeListGetRawString	(xmlDocPtr doc, 
				 xmlNodePtr list, 
				 int inLine)

+
Builds the string equivalent to the text contained in the Node list made of TEXTs and ENTITY_REFs, contrary to xmlNodeListGetString() this function doesn't do any character encoding handling.

+
doc:the document
list:a Node list
inLine:should we replace entity contents or show their external form
Returns:a pointer to the string copy, the caller must free it with xmlFree().
Function: xmlBufferCreateStatic
xmlBufferPtr	xmlBufferCreateStatic	(void * mem, 
				 size_t size)

+
routine to create an XML buffer from an immutable memory area, The are won't be modified nor copied, and is expected to be present until the end of the buffer lifetime.

+
mem:the memory area
size:the size in byte
Returns:the new structure.
Function: xmlNewReference
xmlNodePtr	xmlNewReference	(xmlDocPtr doc, 
				 const xmlChar * name)

+
Creation of a new reference node.

+
doc:the document
name:the reference name, or the reference string with & and ;
Returns:a pointer to the new node object.
Function: xmlBufferCCat
void	xmlBufferCCat	(xmlBufferPtr buf, 
				 const char * str)

+
Append a zero terminated C string to an XML buffer.

+
buf:the buffer to dump
str:the C char string
Function: xmlGetNsList
xmlNsPtr *	xmlGetNsList	(xmlDocPtr doc, 
				 xmlNodePtr node)

+
Search all the namespace applying to a given element.

+
doc:the document
node:the current node
Returns:an NULL terminated array of all the #xmlNsPtr found that need to be freed by the caller or NULL if no namespace if defined
Function: xmlSetBufferAllocationScheme
void	xmlSetBufferAllocationScheme	(xmlBufferAllocationScheme scheme)

+
Set the buffer allocation method. Types are XML_BUFFER_ALLOC_EXACT - use exact sizes, keeps memory usage down XML_BUFFER_ALLOC_DOUBLEIT - double buffer when extra needed, improves performance

+
scheme:allocation method to use
Function: xmlNodeDump
int	xmlNodeDump	(xmlBufferPtr buf, 
				 xmlDocPtr doc, 
				 xmlNodePtr cur, 
				 int level, 
				 int format)

+
Dump an XML node, recursive behaviour,children are printed too. Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

+
buf:the XML buffer output
doc:the document
cur:the current node
level:the imbrication level for indenting
format:is formatting allowed
Returns:the number of bytes written to the buffer or -1 in case of error
Function: xmlIsXHTML
int	xmlIsXHTML	(const xmlChar * systemID, 
				 const xmlChar * publicID)

+
Try to find if the document correspond to an XHTML DTD

+
systemID:the system identifier
publicID:the public identifier
Returns:1 if true, 0 if not and -1 in case of error
Function: xmlNodeSetLang
void	xmlNodeSetLang	(xmlNodePtr cur, 
				 const xmlChar * lang)

+
Set the language of a node, i.e. the values of the xml:lang attribute.

+
cur:the node being changed
lang:the language description
Function: xmlFreeDtd
void	xmlFreeDtd	(xmlDtdPtr cur)

+
Free a DTD structure.

+
cur:the DTD structure to free up
Function: xmlFreeNodeList
void	xmlFreeNodeList	(xmlNodePtr cur)

+
Free a node and all its siblings, this is a recursive behaviour, all the children are freed too.

+
cur:the first node in the list
Function: xmlFreeDoc
void	xmlFreeDoc	(xmlDocPtr cur)

+
Free up all the structures used by a document, tree included.

+
cur:pointer to the document

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlNewDocNode
xmlNodePtr	xmlNewDocNode	(xmlDocPtr doc, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Creation of a new node element within a document. @ns and @content are optional (NULL). NOTE: @content is supposed to be a piece of XML CDATA, so it allow entities references, but XML special chars need to be escaped first by using xmlEncodeEntitiesReentrant(). Use xmlNewDocRawNode() if you don't need entities support.

+
doc:the document
ns:namespace if any
name:the node name
content:the XML text content if any
Returns:a pointer to the new node object.

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlDocDumpFormatMemory
void	xmlDocDumpFormatMemory	(xmlDocPtr cur, 
				 xmlChar ** mem, 
				 int * size, 
				 int format)

+
Dump an XML document in memory and return the #xmlChar * and it's size. It's up to the caller to free the memory with xmlFree(). Note that @format = 1 provide node indenting only if xmlIndentTreeOutput = 1 or xmlKeepBlanksDefault(0) was called

+
cur:the document
mem:OUT: the memory pointer
size:OUT: the memory length
format:should formatting spaces been added

+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlNewDtd
xmlDtdPtr	xmlNewDtd	(xmlDocPtr doc, 
				 const xmlChar * name, 
				 const xmlChar * ExternalID, 
				 const xmlChar * SystemID)

+
Creation of a new DTD for the external subset. To create an internal subset, use xmlCreateIntSubset().

+
doc:the document pointer
name:the DTD name
ExternalID:the external ID
SystemID:the system ID
Returns:a pointer to the new DTD structure
Function: xmlNewNsProp
xmlAttrPtr	xmlNewNsProp	(xmlNodePtr node, 
				 xmlNsPtr ns, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Create a new property tagged with a namespace and carried by a node.

+
node:the holding node
ns:the namespace
name:the name of the attribute
value:the value of the attribute
Returns:a pointer to the attribute
Function: xmlFreeNsList
void	xmlFreeNsList	(xmlNsPtr cur)

+
Free up all the structures associated to the chained namespaces.

+
cur:the first namespace pointer
Function: xmlGetLastChild
xmlNodePtr	xmlGetLastChild	(xmlNodePtr parent)

+
Search the last child of a node.

+
parent:the parent node
Returns:the last child or NULL if none.
Daniel Veillard

diff --git a/doc/html/libxml-uri.html b/doc/html/libxml-uri.html
index 503a567e..6cea12e4 100644
--- a/doc/html/libxml-uri.html
+++ b/doc/html/libxml-uri.html
@@ -1,172 +1,71 @@
-uri
PrevUpHomeGnome XML Library Reference ManualNext
uri
uri — 
Synopsis
+
+
+Module uri from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module uri from libxml2
Main Menu
Related links
Table of Contents
int	xmlNormalizeURIPath	(char * path)

+
void	xmlPrintURI	(FILE * stream, 
				 xmlURIPtr uri)

+
char *	xmlURIUnescapeString	(const char * str, 
				 int len, 
				 char * target)

+
xmlURIPtr	xmlParseURI	(const char * str)

+
xmlURIPtr	xmlCreateURI	(void)

+
xmlChar *	xmlURIEscapeStr	(const xmlChar * str, 
				 const xmlChar * list)

+
xmlChar *	xmlCanonicPath	(const xmlChar * path)

+
void	xmlFreeURI	(xmlURIPtr uri)

+
int	xmlParseURIReference	(xmlURIPtr uri, 
				 const char * str)

+
Typedef xmlURI * xmlURIPtr
 
-
-
-struct      xmlURI;
-typedef     xmlURIPtr;
-xmlURIPtr   xmlCreateURI                    (void);
-xmlChar*    xmlBuildURI                     (const xmlChar *URI,
-                                             const xmlChar *base);
-xmlURIPtr   xmlParseURI                     (const char *str);
-int         xmlParseURIReference            (xmlURIPtr uri,
-                                             const char *str);
-xmlChar*    xmlSaveUri                      (xmlURIPtr uri);
-void        xmlPrintURI                     (FILE *stream,
-                                             xmlURIPtr uri);
-xmlChar*    xmlURIEscapeStr                 (const xmlChar *str,
-                                             const xmlChar *list);
-char*       xmlURIUnescapeString            (const char *str,
-                                             int len,
-                                             char *target);
-int         xmlNormalizeURIPath             (char *path);
-xmlChar*    xmlURIEscape                    (const xmlChar *str);
-void        xmlFreeURI                      (xmlURIPtr uri);
-xmlChar*    xmlCanonicPath                  (const xmlChar *path);
-
Description

-
-
Details
struct xmlURI
struct xmlURI {
-
-    char *scheme;	/* the URI scheme */
-    char *opaque;	/* opaque part */
-    char *authority;	/* the authority part */
-    char *server;	/* the server part */
-    char *user;		/* the user part */
-    int port;		/* the port number */
-    char *path;		/* the path string */
-    char *query;	/* the query string */
-    char *fragment;	/* the fragment identifier */
-    int  cleanup;	/* parsing potentially unclean URI */
-};
-

-A parsed URI reference. This is a struct containing the various fields
-as described in RFC 2396 but separated for further processing.

-
-
xmlURIPtr
typedef xmlURI *xmlURIPtr;
-

-
-
xmlCreateURI ()
xmlURIPtr   xmlCreateURI                    (void);

-Simply creates an empty xmlURI

-
-
Returns :the new structure or NULL in case of error
-
xmlBuildURI ()
xmlChar*    xmlBuildURI                     (const xmlChar *URI,
-                                             const xmlChar *base);

-Computes he final URI of the reference done by checking that
-the given URI is valid, and building the final URI using the
-base URI. This is processed according to section 5.2 of the 
-RFC 2396
-

-5.2. Resolving Relative References to Absolute Form

-
-
URI:  the URI instance found in the document
-
base:  the base value
-
Returns :a new URI string (to be freed by the caller) or NULL in case
-        of error.
-
xmlParseURI ()
xmlURIPtr   xmlParseURI                     (const char *str);

-Parse an URI 
-

-URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

-
-
str:  the URI string to analyze
-
Returns :a newly build xmlURIPtr or NULL in case of error
-
xmlParseURIReference ()
int         xmlParseURIReference            (xmlURIPtr uri,
-                                             const char *str);

-Parse an URI reference string and fills in the appropriate fields
-of the uri structure
-

-URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

-
-
uri:  pointer to an URI structure
-
str:  the string to analyze
-
Returns :0 or the error code
-
xmlSaveUri ()
xmlChar*    xmlSaveUri                      (xmlURIPtr uri);

-Save the URI as an escaped string

-
-
uri:  pointer to an xmlURI
-
Returns :a new string (to be deallocated by caller)
-
xmlPrintURI ()
void        xmlPrintURI                     (FILE *stream,
-                                             xmlURIPtr uri);

-Prints the URI in the stream steam.

-
-
stream:  a FILE* for the output
-
uri:  pointer to an xmlURI
-
xmlURIEscapeStr ()
xmlChar*    xmlURIEscapeStr                 (const xmlChar *str,
-                                             const xmlChar *list);

-This routine escapes a string to hex, ignoring reserved characters (a-z)
-and the characters in the exception list.

-
-
str:  string to escape
-
list: exception list string of chars not to escape
-
Returns :a new escaped string or NULL in case of error.
-
xmlURIUnescapeString ()
char*       xmlURIUnescapeString            (const char *str,
-                                             int len,
-                                             char *target);

-Unescaping routine, does not do validity checks !
-Output is direct unsigned char translation of XX values (no encoding)

-
-
str:  the string to unescape
-
len:   the length in bytes to unescape (or <= 0 to indicate full string)
-
target:  optional destination buffer
-
Returns :an copy of the string, but unescaped
-
xmlNormalizeURIPath ()
int         xmlNormalizeURIPath             (char *path);

-Applies the 5 normalization steps to a path string--that is, RFC 2396
-Section 5.2, steps 6.c through 6.g.
-

-Normalization occurs directly on the string, no new allocation is done

-
-
path:  pointer to the path string
-
Returns :0 or an error code
-
xmlURIEscape ()
xmlChar*    xmlURIEscape                    (const xmlChar *str);

-Escaping routine, does not do validity checks !
-It will try to escape the chars needing this, but this is heuristic
-based it's impossible to be sure.

-
-
str:  the string of the URI to escape
-
Returns :an copy of the string, but escaped
-
-25 May 2001
-Uses xmlParseURI and xmlURIEscapeStr to try to escape correctly
-according to RFC2396.
-  - Carl Douglas
-
xmlFreeURI ()
void        xmlFreeURI                      (xmlURIPtr uri);

-Free up the xmlURI struct

-
-
uri:  pointer to an xmlURI
-
xmlCanonicPath ()
xmlChar*    xmlCanonicPath                  (const xmlChar *path);

-Constructs a canonic path from the specified path.

-
-
path:  the resource locator in a filesystem notation
-
Returns :a new canonic path, or a duplicate of the path parameter if the 
-construction fails. The caller is responsible for freeing the memory occupied
-by the returned string. If there is insufficient memory available, or the 
-argument is NULL, the function returns NULL.
-
<< chvalidSAX2 >>

+
xmlChar *	xmlSaveUri	(xmlURIPtr uri)

+
xmlChar *	xmlURIEscape	(const xmlChar * str)

+
Structure xmlURI
struct _xmlURI {
+    char *	scheme	: the URI scheme
+    char *	opaque	: opaque part
+    char *	authority	: the authority part
+    char *	server	: the server part
+    char *	user	: the user part
+    int	port	: the port number
+    char *	path	: the path string
+    char *	query	: the query string
+    char *	fragment	: the fragment identifier
+    int	cleanup	: parsing potentially unclean URI
+}

xmlChar *	xmlBuildURI	(const xmlChar * URI, 
				 const xmlChar * base)

+
Description

+
Function: xmlNormalizeURIPath
int	xmlNormalizeURIPath	(char * path)

+
Applies the 5 normalization steps to a path string--that is, RFC 2396 Section 5.2, steps 6.c through 6.g. Normalization occurs directly on the string, no new allocation is done

+
path:pointer to the path string
Returns:0 or an error code
Function: xmlPrintURI
void	xmlPrintURI	(FILE * stream, 
				 xmlURIPtr uri)

+
Prints the URI in the stream @steam.

+
stream:a FILE* for the output
uri:pointer to an xmlURI
Function: xmlURIUnescapeString
char *	xmlURIUnescapeString	(const char * str, 
				 int len, 
				 char * target)

+
Unescaping routine, does not do validity checks ! Output is direct unsigned char translation of %XX values (no encoding)

+
str:the string to unescape
len:the length in bytes to unescape (or <= 0 to indicate full string)
target:optional destination buffer
Returns:an copy of the string, but unescaped
Function: xmlParseURI
xmlURIPtr	xmlParseURI	(const char * str)

+
Parse an URI URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

+
str:the URI string to analyze
Returns:a newly build xmlURIPtr or NULL in case of error
Function: xmlCreateURI
xmlURIPtr	xmlCreateURI	(void)

+
Simply creates an empty xmlURI

+
Returns:the new structure or NULL in case of error
Function: xmlURIEscapeStr
xmlChar *	xmlURIEscapeStr	(const xmlChar * str, 
				 const xmlChar * list)

+
This routine escapes a string to hex, ignoring reserved characters (a-z) and the characters in the exception list.

+
str:string to escape
list:exception list string of chars not to escape
Returns:a new escaped string or NULL in case of error.
Function: xmlCanonicPath
xmlChar *	xmlCanonicPath	(const xmlChar * path)

+
Constructs a canonic path from the specified path.

+
path:the resource locator in a filesystem notation
Returns:a new canonic path, or a duplicate of the path parameter if the construction fails. The caller is responsible for freeing the memory occupied by the returned string. If there is insufficient memory available, or the argument is NULL, the function returns NULL.
Function: xmlFreeURI
void	xmlFreeURI	(xmlURIPtr uri)

+
Free up the xmlURI struct

+
uri:pointer to an xmlURI
Function: xmlParseURIReference
int	xmlParseURIReference	(xmlURIPtr uri, 
				 const char * str)

+
Parse an URI reference string and fills in the appropriate fields of the @uri structure URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

+
uri:pointer to an URI structure
str:the string to analyze
Returns:0 or the error code
Function: xmlSaveUri
xmlChar *	xmlSaveUri	(xmlURIPtr uri)

+
Save the URI as an escaped string

+
uri:pointer to an xmlURI
Returns:a new string (to be deallocated by caller)
Function: xmlURIEscape
xmlChar *	xmlURIEscape	(const xmlChar * str)

+
Escaping routine, does not do validity checks ! It will try to escape the chars needing this, but this is heuristic based it's impossible to be sure.

+
str:the string of the URI to escape
Returns:an copy of the string, but escaped 25 May 2001 Uses xmlParseURI and xmlURIEscapeStr to try to escape correctly according to RFC2396. - Carl Douglas

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlBuildURI
xmlChar *	xmlBuildURI	(const xmlChar * URI, 
				 const xmlChar * base)

+
Computes he final URI of the reference done by checking that the given URI is valid, and building the final URI using the base URI. This is processed according to section 5.2 of the RFC 2396 5.2. Resolving Relative References to Absolute Form

+
URI:the URI instance found in the document
base:the base value
Returns:a new URI string (to be freed by the caller) or NULL in case of error.
Daniel Veillard

diff --git a/doc/html/libxml-valid.html b/doc/html/libxml-valid.html
index 81eada89..c6c75780 100644
--- a/doc/html/libxml-valid.html
+++ b/doc/html/libxml-valid.html
@@ -1,954 +1,294 @@
-valid
PrevUpHomeGnome XML Library Reference ManualNext
valid
valid — 
Synopsis
-
-
-
-struct      xmlValidState;
-typedef     xmlValidStatePtr;
-void        (*xmlValidityErrorFunc)         (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        (*xmlValidityWarningFunc)       (void *ctx,
-                                             const char *msg,
-                                             ...);
-struct      xmlValidCtxt;
-typedef     xmlValidCtxtPtr;
-typedef     xmlNotationTablePtr;
-typedef     xmlElementTablePtr;
-typedef     xmlAttributeTablePtr;
-typedef     xmlIDTablePtr;
-typedef     xmlRefTablePtr;
-xmlValidCtxtPtr xmlNewValidCtxt             (void);
-void        xmlFreeValidCtxt                (xmlValidCtxtPtr);
-xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *PublicID,
-                                             const xmlChar *SystemID);
-xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);
-void        xmlFreeNotationTable            (xmlNotationTablePtr table);
-void        xmlDumpNotationDecl             (xmlBufferPtr buf,
-                                             xmlNotationPtr nota);
-void        xmlDumpNotationTable            (xmlBufferPtr buf,
-                                             xmlNotationTablePtr table);
-xmlElementContentPtr xmlNewElementContent   (const xmlChar *name,
-                                             xmlElementContentType type);
-xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);
-void        xmlFreeElementContent           (xmlElementContentPtr cur);
-void        xmlSnprintfElementContent       (char *buf,
-                                             int size,
-                                             xmlElementContentPtr content,
-                                             int glob);
-void        xmlSprintfElementContent        (char *buf,
-                                             xmlElementContentPtr content,
-                                             int glob);
-xmlElementPtr xmlAddElementDecl             (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             xmlElementTypeVal type,
-                                             xmlElementContentPtr content);
-xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);
-void        xmlFreeElementTable             (xmlElementTablePtr table);
-void        xmlDumpElementTable             (xmlBufferPtr buf,
-                                             xmlElementTablePtr table);
-void        xmlDumpElementDecl              (xmlBufferPtr buf,
-                                             xmlElementPtr elem);
-xmlEnumerationPtr xmlCreateEnumeration      (const xmlChar *name);
-void        xmlFreeEnumeration              (xmlEnumerationPtr cur);
-xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);
-xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *ns,
-                                             xmlAttributeType type,
-                                             xmlAttributeDefault def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);
-xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);
-void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);
-void        xmlDumpAttributeTable           (xmlBufferPtr buf,
-                                             xmlAttributeTablePtr table);
-void        xmlDumpAttributeDecl            (xmlBufferPtr buf,
-                                             xmlAttributePtr attr);
-xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);
-void        xmlFreeIDTable                  (xmlIDTablePtr table);
-xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
-                                             const xmlChar *ID);
-int         xmlIsID                         (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);
-int         xmlRemoveID                     (xmlDocPtr doc,
-                                             xmlAttrPtr attr);
-xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);
-void        xmlFreeRefTable                 (xmlRefTablePtr table);
-int         xmlIsRef                        (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);
-int         xmlRemoveRef                    (xmlDocPtr doc,
-                                             xmlAttrPtr attr);
-xmlListPtr  xmlGetRefs                      (xmlDocPtr doc,
-                                             const xmlChar *ID);
-int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlElementPtr elem);
-xmlChar*    xmlValidNormalizeAttributeValue (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-xmlChar*    xmlValidCtxtNormalizeAttributeValue
-                                            (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);
-int         xmlValidateAttributeDecl        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlAttributePtr attr);
-int         xmlValidateAttributeValue       (xmlAttributeType type,
-                                             const xmlChar *value);
-int         xmlValidateNotationDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNotationPtr nota);
-int         xmlValidateDtd                  (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlDtdPtr dtd);
-int         xmlValidateDtdFinal             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateDocument             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateElement              (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);
-int         xmlValidateOneElement           (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);
-int         xmlValidateOneAttribute         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr,
-                                             const xmlChar *value);
-int         xmlValidateOneNamespace         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *prefix,
-                                             xmlNsPtr ns,
-                                             const xmlChar *value);
-int         xmlValidateDocumentFinal        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);
-int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *notationName);
-int         xmlIsMixedElement               (xmlDocPtr doc,
-                                             const xmlChar *name);
-xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name);
-xmlAttributePtr xmlGetDtdQAttrDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);
-xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
-                                             const xmlChar *name);
-xmlElementPtr xmlGetDtdQElementDesc         (xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);
-xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *name);
-int         xmlValidGetValidElements        (xmlNode *prev,
-                                             xmlNode *next,
-                                             const xmlChar **list,
-                                             int max);
-int         xmlValidGetPotentialChildren    (xmlElementContent *ctree,
-                                             const xmlChar **list,
-                                             int *len,
-                                             int max);
-int         xmlValidateNameValue            (const xmlChar *value);
-int         xmlValidateNamesValue           (const xmlChar *value);
-int         xmlValidateNmtokenValue         (const xmlChar *value);
-int         xmlValidateNmtokensValue        (const xmlChar *value);
-int         xmlValidBuildContentModel       (xmlValidCtxtPtr ctxt,
-                                             xmlElementPtr elem);
-int         xmlValidatePushElement          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *qname);
-int         xmlValidatePushCData            (xmlValidCtxtPtr ctxt,
-                                             const xmlChar *data,
-                                             int len);
-int         xmlValidatePopElement           (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *qname);
-
Description

-
-
Details
struct xmlValidState
struct xmlValidState;

-
-
xmlValidStatePtr
typedef xmlValidState *xmlValidStatePtr;
-

-
-
xmlValidityErrorFunc ()
void        (*xmlValidityErrorFunc)         (void *ctx,
-                                             const char *msg,
-                                             ...);

-Callback called when a validity error is found. This is a message
-oriented function similar to an *printf function.

-
-
ctx:  an xmlValidCtxtPtr validity error context
-
msg:  the string to format *printf like vararg
-
...:  remaining arguments to the format
-
xmlValidityWarningFunc ()
void        (*xmlValidityWarningFunc)       (void *ctx,
-                                             const char *msg,
-                                             ...);

-Callback called when a validity warning is found. This is a message
-oriented function similar to an *printf function.

-
-
ctx:  an xmlValidCtxtPtr validity error context
-
msg:  the string to format *printf like vararg
-
...:  remaining arguments to the format
-
struct xmlValidCtxt
struct xmlValidCtxt {
-
-    void *userData;			/* user specific data block */
-    xmlValidityErrorFunc error;		/* the callback in case of errors */
-    xmlValidityWarningFunc warning;	/* the callback in case of warning */
-
-    /* Node analysis stack used when validating within entities */
-    xmlNodePtr         node;          /* Current parsed Node */
-    int                nodeNr;        /* Depth of the parsing stack */
-    int                nodeMax;       /* Max depth of the parsing stack */
-    xmlNodePtr        *nodeTab;       /* array of nodes */
-
-    int              finishDtd;       /* finished validating the Dtd ? */
-    xmlDocPtr              doc;       /* the document */
-    int                  valid;       /* temporary validity check result */
-
-    /* state state used for non-determinist content validation */
-    xmlValidState     *vstate;        /* current state */
-    int                vstateNr;      /* Depth of the validation stack */
-    int                vstateMax;     /* Max depth of the validation stack */
-    xmlValidState     *vstateTab;     /* array of validation states */
-
-#ifdef LIBXML_REGEXP_ENABLED
-    xmlAutomataPtr            am;     /* the automata */
-    xmlAutomataStatePtr    state;     /* used to build the automata */
-#else
-    void                     *am;
-    void                  *state;
-#endif
-};
-

-
-
xmlValidCtxtPtr
typedef xmlValidCtxt *xmlValidCtxtPtr;
-

-
-
xmlNotationTablePtr
typedef xmlNotationTable *xmlNotationTablePtr;
-

-
-
xmlElementTablePtr
typedef xmlElementTable *xmlElementTablePtr;
-

-
-
xmlAttributeTablePtr
typedef xmlAttributeTable *xmlAttributeTablePtr;
-

-
-
xmlIDTablePtr
typedef xmlIDTable *xmlIDTablePtr;
-

-
-
xmlRefTablePtr
typedef xmlRefTable *xmlRefTablePtr;
-

-
-
xmlNewValidCtxt ()
xmlValidCtxtPtr xmlNewValidCtxt             (void);

-Allocate a validation context structure.

-
-
Returns :NULL if not, otherwise the new validation context structure
-
xmlFreeValidCtxt ()
void        xmlFreeValidCtxt                (xmlValidCtxtPtr);

-Free a validation context structure.

-
-
Param1:
-
-
-
xmlAddNotationDecl ()
xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *PublicID,
-                                             const xmlChar *SystemID);

-Register a new notation declaration

-
-
ctxt:  the validation context
-
dtd:  pointer to the DTD
-
name:  the entity name
-
PublicID:  the public identifier or NULL
-
SystemID:  the system identifier or NULL
-
Returns :NULL if not, otherwise the entity
-
xmlCopyNotationTable ()
xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);

-Build a copy of a notation table.

-
-
table:  A notation table
-
Returns :the new xmlNotationTablePtr or NULL in case of error.
-
xmlFreeNotationTable ()
void        xmlFreeNotationTable            (xmlNotationTablePtr table);

-Deallocate the memory used by an entities hash table.

-
-
table:  An notation table
-
xmlDumpNotationDecl ()
void        xmlDumpNotationDecl             (xmlBufferPtr buf,
-                                             xmlNotationPtr nota);

-This will dump the content the notation declaration as an XML DTD definition

-
-
buf:  the XML buffer output
-
nota:  A notation declaration
-
xmlDumpNotationTable ()
void        xmlDumpNotationTable            (xmlBufferPtr buf,
-                                             xmlNotationTablePtr table);

-This will dump the content of the notation table as an XML DTD definition

-
-
buf:  the XML buffer output
-
table:  A notation table
-
xmlNewElementContent ()
xmlElementContentPtr xmlNewElementContent   (const xmlChar *name,
-                                             xmlElementContentType type);

-Allocate an element content structure.

-
-
name:  the subelement name or NULL
-
type:  the type of element content decl
-
Returns :NULL if not, otherwise the new element content structure
-
xmlCopyElementContent ()
xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);

-Build a copy of an element content description.

-
-
content:
-
Returns :the new xmlElementContentPtr or NULL in case of error.
-
xmlFreeElementContent ()
void        xmlFreeElementContent           (xmlElementContentPtr cur);

-Free an element content structure. This is a recursive call !

-
-
cur:  the element content tree to free
-
xmlSnprintfElementContent ()
void        xmlSnprintfElementContent       (char *buf,
-                                             int size,
-                                             xmlElementContentPtr content,
-                                             int glob);

-This will dump the content of the element content definition
-Intended just for the debug routine

-
-
buf:  an output buffer
-
size:  the buffer size
-
content:  An element table
-
glob: 1 if one must print the englobing parenthesis, 0 otherwise
-
xmlSprintfElementContent ()
void        xmlSprintfElementContent        (char *buf,
-                                             xmlElementContentPtr content,
-                                             int glob);

-Deprecated, unsafe, use xmlSnprintfElementContent

-
-
buf:  an output buffer
-
content:  An element table
-
glob: 1 if one must print the englobing parenthesis, 0 otherwise
-
xmlAddElementDecl ()
xmlElementPtr xmlAddElementDecl             (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             xmlElementTypeVal type,
-                                             xmlElementContentPtr content);

-Register a new element declaration

-
-
ctxt:  the validation context
-
dtd:  pointer to the DTD
-
name:  the entity name
-
type:  the element type
-
content:  the element content tree or NULL
-
Returns :NULL if not, otherwise the entity
-
xmlCopyElementTable ()
xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);

-Build a copy of an element table.

-
-
table:  An element table
-
Returns :the new xmlElementTablePtr or NULL in case of error.
-
xmlFreeElementTable ()
void        xmlFreeElementTable             (xmlElementTablePtr table);

-Deallocate the memory used by an element hash table.

-
-
table:  An element table
-
xmlDumpElementTable ()
void        xmlDumpElementTable             (xmlBufferPtr buf,
-                                             xmlElementTablePtr table);

-This will dump the content of the element table as an XML DTD definition

-
-
buf:  the XML buffer output
-
table:  An element table
-
xmlDumpElementDecl ()
void        xmlDumpElementDecl              (xmlBufferPtr buf,
-                                             xmlElementPtr elem);

-This will dump the content of the element declaration as an XML
-DTD definition

-
-
buf:  the XML buffer output
-
elem:  An element table
-
xmlCreateEnumeration ()
xmlEnumerationPtr xmlCreateEnumeration      (const xmlChar *name);

-create and initialize an enumeration attribute node.

-
-
name:  the enumeration name or NULL
-
Returns :the xmlEnumerationPtr just created or NULL in case
-               of error.
-
xmlFreeEnumeration ()
void        xmlFreeEnumeration              (xmlEnumerationPtr cur);

-free an enumeration attribute node (recursive).

-
-
cur:  the tree to free.
-
xmlCopyEnumeration ()
xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);

-Copy an enumeration attribute node (recursive).

-
-
cur:  the tree to copy.
-
Returns :the xmlEnumerationPtr just created or NULL in case
-               of error.
-
xmlAddAttributeDecl ()
xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *ns,
-                                             xmlAttributeType type,
-                                             xmlAttributeDefault def,
-                                             const xmlChar *defaultValue,
-                                             xmlEnumerationPtr tree);

-Register a new attribute declaration
-Note that tree becomes the ownership of the DTD

-
-
ctxt:  the validation context
-
dtd:  pointer to the DTD
-
elem:  the element name
-
name:  the attribute name
-
ns:  the attribute namespace prefix
-
type:  the attribute type
-
def:  the attribute default type
-
defaultValue:  the attribute default value
-
tree:  if it's an enumeration, the associated list
-
Returns :NULL if not new, otherwise the attribute decl
-
xmlCopyAttributeTable ()
xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);

-Build a copy of an attribute table.

-
-
table:  An attribute table
-
Returns :the new xmlAttributeTablePtr or NULL in case of error.
-
xmlFreeAttributeTable ()
void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);

-Deallocate the memory used by an entities hash table.

-
-
table:  An attribute table
-
xmlDumpAttributeTable ()
void        xmlDumpAttributeTable           (xmlBufferPtr buf,
-                                             xmlAttributeTablePtr table);

-This will dump the content of the attribute table as an XML DTD definition

-
-
buf:  the XML buffer output
-
table:  An attribute table
-
xmlDumpAttributeDecl ()
void        xmlDumpAttributeDecl            (xmlBufferPtr buf,
-                                             xmlAttributePtr attr);

-This will dump the content of the attribute declaration as an XML
-DTD definition

-
-
buf:  the XML buffer output
-
attr:  An attribute declaration
-
xmlAddID ()
xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);

-Register a new id declaration

-
-
ctxt:  the validation context
-
doc:  pointer to the document
-
value:  the value name
-
attr:  the attribute holding the ID
-
Returns :NULL if not, otherwise the new xmlIDPtr
-
xmlFreeIDTable ()
void        xmlFreeIDTable                  (xmlIDTablePtr table);

-Deallocate the memory used by an ID hash table.

-
-
table:  An id table
-
xmlGetID ()
xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
-                                             const xmlChar *ID);

-Search the attribute declaring the given ID

-
-
doc:  pointer to the document
-
ID:  the ID value
-
Returns :NULL if not found, otherwise the xmlAttrPtr defining the ID
-
xmlIsID ()
int         xmlIsID                         (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);

-Determine whether an attribute is of type ID. In case we have DTD(s)
-then this is done if DTD loading has been requested. In the case
-of HTML documents parsed with the HTML parser, then ID detection is
-done systematically.

-
-
doc:  the document
-
elem:  the element carrying the attribute
-
attr:  the attribute
-
Returns :0 or 1 depending on the lookup result
-
xmlRemoveID ()
int         xmlRemoveID                     (xmlDocPtr doc,
-                                             xmlAttrPtr attr);

-Remove the given attribute from the ID table maintained internally.

-
-
doc:  the document
-
attr:  the attribute
-
Returns :-1 if the lookup failed and 0 otherwise
-
xmlAddRef ()
xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *value,
-                                             xmlAttrPtr attr);

-Register a new ref declaration

-
-
ctxt:  the validation context
-
doc:  pointer to the document
-
value:  the value name
-
attr:  the attribute holding the Ref
-
Returns :NULL if not, otherwise the new xmlRefPtr
-
xmlFreeRefTable ()
void        xmlFreeRefTable                 (xmlRefTablePtr table);

-Deallocate the memory used by an Ref hash table.

-
-
table:  An ref table
-
xmlIsRef ()
int         xmlIsRef                        (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr);

-Determine whether an attribute is of type Ref. In case we have DTD(s)
-then this is simple, otherwise we use an heuristic: name Ref (upper
-or lowercase).

-
-
doc:  the document
-
elem:  the element carrying the attribute
-
attr:  the attribute
-
Returns :0 or 1 depending on the lookup result
-
xmlRemoveRef ()
int         xmlRemoveRef                    (xmlDocPtr doc,
-                                             xmlAttrPtr attr);

-Remove the given attribute from the Ref table maintained internally.

-
-
doc:  the document
-
attr:  the attribute
-
Returns :-1 if the lookup failed and 0 otherwise
-
xmlGetRefs ()
xmlListPtr  xmlGetRefs                      (xmlDocPtr doc,
-                                             const xmlChar *ID);

-Find the set of references for the supplied ID.

-
-
doc:  pointer to the document
-
ID:  the ID value
-
Returns :NULL if not found, otherwise node set for the ID.
-
xmlValidateRoot ()
int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

-Try to validate a the root element
-basically it does the following check as described by the
-XML-1.0 recommendation:
- - [ VC: Root Element Type ]
-it doesn't try to recurse or apply other check to the element

-
-
ctxt:  the validation context
-
doc:  a document instance
-
Returns :1 if valid or 0 otherwise
-
xmlValidateElementDecl ()
int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlElementPtr elem);

-Try to validate a single element definition
-basically it does the following checks as described by the
-XML-1.0 recommendation:
- - [ VC: One ID per Element Type ]
- - [ VC: No Duplicate Types ]
- - [ VC: Unique Element Type Declaration ]

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element definition
-
Returns :1 if valid or 0 otherwise
-
xmlValidNormalizeAttributeValue ()
xmlChar*    xmlValidNormalizeAttributeValue (xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Does the validation related extra step of the normalization of attribute
-values:
-

-If the declared value is not CDATA, then the XML processor must further
-process the normalized attribute value by discarding any leading and
-trailing space (x20) characters, and by replacing sequences of space
-(x20) characters by single space (x20) character.

-
-
doc:  the document
-
elem:  the parent
-
name:  the attribute name
-
value:  the attribute value
-
Returns :a new normalized string if normalization is needed, NULL otherwise
-     the caller must free the returned value.
-
xmlValidCtxtNormalizeAttributeValue ()
xmlChar*    xmlValidCtxtNormalizeAttributeValue
-                                            (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *name,
-                                             const xmlChar *value);

-Does the validation related extra step of the normalization of attribute
-values:
-

-If the declared value is not CDATA, then the XML processor must further
-process the normalized attribute value by discarding any leading and
-trailing space (x20) characters, and by replacing sequences of space
-(x20) characters by single space (x20) character.
-

-Also  check VC: Standalone Document Declaration in P32, and update
- ctxt->valid accordingly

-
-
ctxt: the validation context
-
doc:  the document
-
elem:  the parent
-
name:  the attribute name
-
value:  the attribute value
-
Returns :a new normalized string if normalization is needed, NULL otherwise
-     the caller must free the returned value.
-
xmlValidateAttributeDecl ()
int         xmlValidateAttributeDecl        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlAttributePtr attr);

-Try to validate a single attribute definition
-basically it does the following checks as described by the
-XML-1.0 recommendation:
- - [ VC: Attribute Default Legal ]
- - [ VC: Enumeration ]
- - [ VC: ID Attribute Default ]
-

-The ID/IDREF uniqueness and matching are done separately

-
-
ctxt:  the validation context
-
doc:  a document instance
-
attr:  an attribute definition
-
Returns :1 if valid or 0 otherwise
-
xmlValidateAttributeValue ()
int         xmlValidateAttributeValue       (xmlAttributeType type,
-                                             const xmlChar *value);

-Validate that the given attribute value match  the proper production
-

-[ VC: ID ]
-Values of type ID must match the Name production....
-

-[ VC: IDREF ]
-Values of type IDREF must match the Name production, and values
-of type IDREFS must match Names ...
-

-[ VC: Entity Name ]
-Values of type ENTITY must match the Name production, values
-of type ENTITIES must match Names ...
-

-[ VC: Name Token ]
-Values of type NMTOKEN must match the Nmtoken production; values
-of type NMTOKENS must match Nmtokens.

-
-
type:  an attribute type
-
value:  an attribute value
-
Returns :1 if valid or 0 otherwise
-
xmlValidateNotationDecl ()
int         xmlValidateNotationDecl         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNotationPtr nota);

-Try to validate a single notation definition
-basically it does the following checks as described by the
-XML-1.0 recommendation:
- - it seems that no validity constraint exists on notation declarations
-But this function get called anyway ...

-
-
ctxt:  the validation context
-
doc:  a document instance
-
nota:  a notation definition
-
Returns :1 if valid or 0 otherwise
-
xmlValidateDtd ()
int         xmlValidateDtd                  (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlDtdPtr dtd);

-Try to validate the document against the dtd instance
-

-basically it does check all the definitions in the DtD.

-
-
ctxt:  the validation context
-
doc:  a document instance
-
dtd:  a dtd instance
-
Returns :1 if valid or 0 otherwise
-
xmlValidateDtdFinal ()
int         xmlValidateDtdFinal             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

-Does the final step for the dtds validation once all the
-subsets have been parsed
-

-basically it does the following checks described by the XML Rec
-- check that ENTITY and ENTITIES type attributes default or 
-  possible values matches one of the defined entities.
-- check that NOTATION type attributes default or 
-  possible values matches one of the defined notations.

-
-
ctxt:  the validation context
-
doc:  a document instance
-
Returns :1 if valid or 0 if invalid and -1 if not well-formed
-
xmlValidateDocument ()
int         xmlValidateDocument             (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

-Try to validate the document instance
-

-basically it does the all the checks described by the XML Rec
-i.e. validates the internal and external subset (if present)
-and validate the document tree.

-
-
ctxt:  the validation context
-
doc:  a document instance
-
Returns :1 if valid or 0 otherwise
-
xmlValidateElement ()
int         xmlValidateElement              (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);

-Try to validate the subtree under an element

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
Returns :1 if valid or 0 otherwise
-
xmlValidateOneElement ()
int         xmlValidateOneElement           (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem);

-Try to validate a single element and it's attributes,
-basically it does the following checks as described by the
-XML-1.0 recommendation:
- - [ VC: Element Valid ]
- - [ VC: Required Attribute ]
-Then call xmlValidateOneAttribute() for each attribute present.
-

-The ID/IDREF checkings are done separately

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
Returns :1 if valid or 0 otherwise
-
xmlValidateOneAttribute ()
int         xmlValidateOneAttribute         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             xmlAttrPtr attr,
-                                             const xmlChar *value);

-Try to validate a single attribute for an element
-basically it does the following checks as described by the
-XML-1.0 recommendation:
- - [ VC: Attribute Value Type ]
- - [ VC: Fixed Attribute Default ]
- - [ VC: Entity Name ]
- - [ VC: Name Token ]
- - [ VC: ID ]
- - [ VC: IDREF ]
- - [ VC: Entity Name ]
- - [ VC: Notation Attributes ]
-

-The ID/IDREF uniqueness and matching are done separately

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
attr:  an attribute instance
-
value:  the attribute value (without entities processing)
-
Returns :1 if valid or 0 otherwise
-
xmlValidateOneNamespace ()
int         xmlValidateOneNamespace         (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *prefix,
-                                             xmlNsPtr ns,
-                                             const xmlChar *value);

-Try to validate a single namespace declaration for an element
-basically it does the following checks as described by the
-XML-1.0 recommendation:
- - [ VC: Attribute Value Type ]
- - [ VC: Fixed Attribute Default ]
- - [ VC: Entity Name ]
- - [ VC: Name Token ]
- - [ VC: ID ]
- - [ VC: IDREF ]
- - [ VC: Entity Name ]
- - [ VC: Notation Attributes ]
-

-The ID/IDREF uniqueness and matching are done separately

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
prefix:  the namespace prefix
-
ns:  an namespace declaration instance
-
value:  the attribute value (without entities processing)
-
Returns :1 if valid or 0 otherwise
-
xmlValidateDocumentFinal ()
int         xmlValidateDocumentFinal        (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc);

-Does the final step for the document validation once all the
-incremental validation steps have been completed
-

-basically it does the following checks described by the XML Rec
-

-Check all the IDREF/IDREFS attributes definition for validity

-
-
ctxt:  the validation context
-
doc:  a document instance
-
Returns :1 if valid or 0 otherwise
-
xmlValidateNotationUse ()
int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             const xmlChar *notationName);

-Validate that the given name match a notation declaration.
-- [ VC: Notation Declared ]

-
-
ctxt:  the validation context
-
doc:  the document
-
notationName:  the notation name to check
-
Returns :1 if valid or 0 otherwise
-
xmlIsMixedElement ()
int         xmlIsMixedElement               (xmlDocPtr doc,
-                                             const xmlChar *name);

-Search in the DtDs whether an element accept Mixed content (or ANY)
-basically if it is supposed to accept text childs

-
-
doc:  the document
-
name:  the element name
-
Returns :0 if no, 1 if yes, and -1 if no element description is available
-
xmlGetDtdAttrDesc ()
xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name);

-Search the DTD for the description of this attribute on
-this element.

-
-
dtd:  a pointer to the DtD to search
-
elem:  the element name
-
name:  the attribute name
-
Returns :the xmlAttributePtr if found or NULL
-
xmlGetDtdQAttrDesc ()
xmlAttributePtr xmlGetDtdQAttrDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *elem,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);

-Search the DTD for the description of this qualified attribute on
-this element.

-
-
dtd:  a pointer to the DtD to search
-
elem:  the element name
-
name:  the attribute name
-
prefix:  the attribute namespace prefix
-
Returns :the xmlAttributePtr if found or NULL
-
xmlGetDtdNotationDesc ()
xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
-                                             const xmlChar *name);

-Search the DTD for the description of this notation

-
-
dtd:  a pointer to the DtD to search
-
name:  the notation name
-
Returns :the xmlNotationPtr if found or NULL
-
xmlGetDtdQElementDesc ()
xmlElementPtr xmlGetDtdQElementDesc         (xmlDtdPtr dtd,
-                                             const xmlChar *name,
-                                             const xmlChar *prefix);

-Search the DTD for the description of this element

-
-
dtd:  a pointer to the DtD to search
-
name:  the element name
-
prefix:  the element namespace prefix
-
Returns :the xmlElementPtr if found or NULL
-
xmlGetDtdElementDesc ()
xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
-                                             const xmlChar *name);

-Search the DTD for the description of this element

-
-
dtd:  a pointer to the DtD to search
-
name:  the element name
-
Returns :the xmlElementPtr if found or NULL
-
xmlValidGetValidElements ()
int         xmlValidGetValidElements        (xmlNode *prev,
-                                             xmlNode *next,
-                                             const xmlChar **list,
-                                             int max);

-This function returns the list of authorized children to insert
-within an existing tree while respecting the validity constraints
-forced by the Dtd. The insertion point is defined using prev and
-next in the following ways:
- to insert before 'node': xmlValidGetValidElements(node->prev, node, ...
- to insert next 'node': xmlValidGetValidElements(node, node->next, ...
- to replace 'node': xmlValidGetValidElements(node->prev, node->next, ...
- to prepend a child to 'node': xmlValidGetValidElements(NULL, node->childs,
- to append a child to 'node': xmlValidGetValidElements(node->last, NULL, ...
-

-pointers to the element names are inserted at the beginning of the array
-and do not need to be freed.

-
-
prev:  an element to insert after
-
next:  an element to insert next
-
list:  an array to store the list of child names
-
max:  the size of the array
-
Returns :the number of element in the list, or -1 in case of error. If
-   the function returns the value max the caller is invited to grow the
-   receiving array and retry.
-
xmlValidGetPotentialChildren ()
int         xmlValidGetPotentialChildren    (xmlElementContent *ctree,
-                                             const xmlChar **list,
-                                             int *len,
-                                             int max);

-Build/extend a list of  potential children allowed by the content tree

-
-
ctree:  an element content tree
-
list:  an array to store the list of child names
-
len:  a pointer to the number of element in the list
-
max:  the size of the array
-
Returns :the number of element in the list, or -1 in case of error.
-
xmlValidateNameValue ()
int         xmlValidateNameValue            (const xmlChar *value);

-Validate that the given value match Name production

-
-
value:  an Name value
-
Returns :1 if valid or 0 otherwise
-
xmlValidateNamesValue ()
int         xmlValidateNamesValue           (const xmlChar *value);

-Validate that the given value match Names production

-
-
value:  an Names value
-
Returns :1 if valid or 0 otherwise
-
xmlValidateNmtokenValue ()
int         xmlValidateNmtokenValue         (const xmlChar *value);

-Validate that the given value match Nmtoken production
-

-[ VC: Name Token ]

-
-
value:  an Nmtoken value
-
Returns :1 if valid or 0 otherwise
-
xmlValidateNmtokensValue ()
int         xmlValidateNmtokensValue        (const xmlChar *value);

-Validate that the given value match Nmtokens production
-

-[ VC: Name Token ]

-
-
value:  an Nmtokens value
-
Returns :1 if valid or 0 otherwise
-
xmlValidBuildContentModel ()
int         xmlValidBuildContentModel       (xmlValidCtxtPtr ctxt,
-                                             xmlElementPtr elem);

-(Re)Build the automata associated to the content model of this
-element

-
-
ctxt:  a validation context
-
elem:  an element declaration node
-
Returns :1 in case of success, 0 in case of error
-
xmlValidatePushElement ()
int         xmlValidatePushElement          (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *qname);

-Push a new element start on the validation stack.

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
qname:  the qualified name as appearing in the serialization
-
Returns :1 if no validation problem was found or 0 otherwise
-
xmlValidatePushCData ()
int         xmlValidatePushCData            (xmlValidCtxtPtr ctxt,
-                                             const xmlChar *data,
-                                             int len);

-check the CData parsed for validation in the current stack

-
-
ctxt:  the validation context
-
data:  some character data read
-
len:  the lenght of the data
-
Returns :1 if no validation problem was found or 0 otherwise
-
xmlValidatePopElement ()
int         xmlValidatePopElement           (xmlValidCtxtPtr ctxt,
-                                             xmlDocPtr doc,
-                                             xmlNodePtr elem,
-                                             const xmlChar *qname);

-Pop the element end from the validation stack.

-
-
ctxt:  the validation context
-
doc:  a document instance
-
elem:  an element instance
-
qname:  the qualified name as appearing in the serialization
-
Returns :1 if no validation problem was found or 0 otherwise
-
<< HTMLparsercatalog >>

+
+
+Module valid from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module valid from libxml2
Main Menu
Related links
Table of Contents
int	xmlValidateDocument	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
void	xmlFreeNotationTable	(xmlNotationTablePtr table)

+
Structure xmlNotationTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}

int	xmlValidateNameValue	(const xmlChar * value)

+
void	xmlSnprintfElementContent	(char * buf, 
				 int size, 
				 xmlElementContentPtr content, 
				 int glob)

+
xmlRefPtr	xmlAddRef	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 const xmlChar * value, 
				 xmlAttrPtr attr)

+
void	xmlDumpAttributeDecl	(xmlBufferPtr buf, 
				 xmlAttributePtr attr)

+
int	xmlValidateDocumentFinal	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Typedef xmlElementTable * xmlElementTablePtr
+
+
int	xmlValidateDtdFinal	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
void	xmlDumpAttributeTable	(xmlBufferPtr buf, 
				 xmlAttributeTablePtr table)

+
xmlEnumerationPtr	xmlCreateEnumeration	(const xmlChar * name)

+
int	xmlValidateOneAttribute	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 xmlAttrPtr attr, 
				 const xmlChar * value)

+
int	xmlValidGetValidElements	(xmlNode * prev, 
				 xmlNode * next, 
				 const xmlChar ** list, 
				 int max)

+
void	xmlDumpNotationTable	(xmlBufferPtr buf, 
				 xmlNotationTablePtr table)

+
void	xmlDumpNotationDecl	(xmlBufferPtr buf, 
				 xmlNotationPtr nota)

+
int	xmlIsID	(xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 xmlAttrPtr attr)

+
xmlAttributePtr	xmlGetDtdQAttrDesc	(xmlDtdPtr dtd, 
				 const xmlChar * elem, 
				 const xmlChar * name, 
				 const xmlChar * prefix)

+
void	xmlFreeAttributeTable	(xmlAttributeTablePtr table)

+
Function type: xmlValidityErrorFunc
+void	xmlValidityErrorFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
Callback called when a validity error is found. This is a message oriented function similar to an *printf function.
ctx:an xmlValidCtxtPtr validity error context
msg:the string to format *printf like vararg
...:remaining arguments to the format


+
int	xmlValidateAttributeDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlAttributePtr attr)

+
xmlElementPtr	xmlGetDtdQElementDesc	(xmlDtdPtr dtd, 
				 const xmlChar * name, 
				 const xmlChar * prefix)

+
xmlListPtr	xmlGetRefs	(xmlDocPtr doc, 
				 const xmlChar * ID)

+
xmlNotationTablePtr	xmlCopyNotationTable	(xmlNotationTablePtr table)

+
Typedef xmlNotationTable * xmlNotationTablePtr
+
+
Structure xmlElementTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}

int	xmlValidGetPotentialChildren	(xmlElementContent * ctree, 
				 const xmlChar ** list, 
				 int * len, 
				 int max)

+
xmlNotationPtr	xmlAddNotationDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDtdPtr dtd, 
				 const xmlChar * name, 
				 const xmlChar * PublicID, 
				 const xmlChar * SystemID)

+
int	xmlValidateElementDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlElementPtr elem)

+
xmlAttributePtr	xmlAddAttributeDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDtdPtr dtd, 
				 const xmlChar * elem, 
				 const xmlChar * name, 
				 const xmlChar * ns, 
				 xmlAttributeType type, 
				 xmlAttributeDefault def, 
				 const xmlChar * defaultValue, 
				 xmlEnumerationPtr tree)

+
xmlAttrPtr	xmlGetID	(xmlDocPtr doc, 
				 const xmlChar * ID)

+
xmlIDPtr	xmlAddID	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 const xmlChar * value, 
				 xmlAttrPtr attr)

+
Structure xmlValidState
struct _xmlValidState {
+The content of this structure is not made public by the API.
+}

void	xmlSprintfElementContent	(char * buf, 
				 xmlElementContentPtr content, 
				 int glob)

+
int	xmlValidateOneElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
int	xmlValidateNmtokenValue	(const xmlChar * value)

+
void	xmlDumpElementTable	(xmlBufferPtr buf, 
				 xmlElementTablePtr table)

+
Typedef xmlAttributeTable * xmlAttributeTablePtr
+
+
Structure xmlIDTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}

xmlElementPtr	xmlAddElementDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDtdPtr dtd, 
				 const xmlChar * name, 
				 xmlElementTypeVal type, 
				 xmlElementContentPtr content)

+
xmlNotationPtr	xmlGetDtdNotationDesc	(xmlDtdPtr dtd, 
				 const xmlChar * name)

+
int	xmlValidateOneNamespace	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * prefix, 
				 xmlNsPtr ns, 
				 const xmlChar * value)

+
int	xmlValidatePushElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * qname)

+
int	xmlIsRef	(xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 xmlAttrPtr attr)

+
int	xmlRemoveRef	(xmlDocPtr doc, 
				 xmlAttrPtr attr)

+
xmlElementTablePtr	xmlCopyElementTable	(xmlElementTablePtr table)

+
int	xmlValidateNmtokensValue	(const xmlChar * value)

+
void	xmlFreeRefTable	(xmlRefTablePtr table)

+
Typedef xmlValidCtxt * xmlValidCtxtPtr
+
+
Structure xmlRefTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}

Function type: xmlValidityWarningFunc
+void	xmlValidityWarningFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
Callback called when a validity warning is found. This is a message oriented function similar to an *printf function.
ctx:an xmlValidCtxtPtr validity error context
msg:the string to format *printf like vararg
...:remaining arguments to the format


+
int	xmlRemoveID	(xmlDocPtr doc, 
				 xmlAttrPtr attr)

+
void	xmlFreeElementTable	(xmlElementTablePtr table)

+
int	xmlValidatePopElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * qname)

+
void	xmlFreeIDTable	(xmlIDTablePtr table)

+
Structure xmlValidCtxt
struct _xmlValidCtxt {
+    void *	userData	: user specific data block
+    xmlValidityErrorFunc	error	: the callback in case of errors
+    xmlValidityWarningFunc	warning	: the callback in case of warning Node analysis sta
+    xmlNodePtr	node	: Current parsed Node
+    int	nodeNr	: Depth of the parsing stack
+    int	nodeMax	: Max depth of the parsing stack
+    xmlNodePtr *	nodeTab	: array of nodes
+    int	finishDtd	: finished validating the Dtd ?
+    xmlDocPtr	doc	: the document
+    int	valid	: temporary validity check result state state used
+    xmlValidState *	vstate	: current state
+    int	vstateNr	: Depth of the validation stack
+    int	vstateMax	: Max depth of the validation stack
+    xmlValidState *	vstateTab	: array of validation states
+    xmlAutomataPtr	am	: the automata
+    xmlAutomataStatePtr	state	: used to build the automata
+    void *	am
+    void *	state
+}

void	xmlFreeValidCtxt	(xmlValidCtxtPtr cur)

+
xmlAttributeTablePtr	xmlCopyAttributeTable	(xmlAttributeTablePtr table)

+
xmlElementContentPtr	xmlCopyElementContent	(xmlElementContentPtr cur)

+
int	xmlValidateAttributeValue	(xmlAttributeType type, 
				 const xmlChar * value)

+
int	xmlValidateRoot	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
xmlChar *	xmlValidCtxtNormalizeAttributeValue	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Typedef xmlValidState * xmlValidStatePtr
+
+
Typedef xmlIDTable * xmlIDTablePtr
+
+
void	xmlFreeEnumeration	(xmlEnumerationPtr cur)

+
int	xmlValidateNamesValue	(const xmlChar * value)

+
xmlEnumerationPtr	xmlCopyEnumeration	(xmlEnumerationPtr cur)

+
xmlAttributePtr	xmlGetDtdAttrDesc	(xmlDtdPtr dtd, 
				 const xmlChar * elem, 
				 const xmlChar * name)

+
int	xmlValidateDtd	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlDtdPtr dtd)

+
xmlValidCtxtPtr	xmlNewValidCtxt	(void)

+
int	xmlIsMixedElement	(xmlDocPtr doc, 
				 const xmlChar * name)

+
void	xmlDumpElementDecl	(xmlBufferPtr buf, 
				 xmlElementPtr elem)

+
xmlChar *	xmlValidNormalizeAttributeValue	(xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
int	xmlValidBuildContentModel	(xmlValidCtxtPtr ctxt, 
				 xmlElementPtr elem)

+
int	xmlValidateElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
int	xmlValidateNotationUse	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 const xmlChar * notationName)

+
Structure xmlAttributeTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}

int	xmlValidateNotationDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNotationPtr nota)

+
xmlElementContentPtr	xmlNewElementContent	(const xmlChar * name, 
				 xmlElementContentType type)

+
xmlElementPtr	xmlGetDtdElementDesc	(xmlDtdPtr dtd, 
				 const xmlChar * name)

+
void	xmlFreeElementContent	(xmlElementContentPtr cur)

+
int	xmlValidatePushCData	(xmlValidCtxtPtr ctxt, 
				 const xmlChar * data, 
				 int len)

+
Typedef xmlRefTable * xmlRefTablePtr
+
+
Description

+
Function: xmlValidateDocument
int	xmlValidateDocument	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Try to validate the document instance basically it does the all the checks described by the XML Rec i.e. validates the internal and external subset (if present) and validate the document tree.

+
ctxt:the validation context
doc:a document instance
Returns:1 if valid or 0 otherwise
Function: xmlFreeNotationTable
void	xmlFreeNotationTable	(xmlNotationTablePtr table)

+
Deallocate the memory used by an entities hash table.

+
table:An notation table
Function: xmlValidateNameValue
int	xmlValidateNameValue	(const xmlChar * value)

+
Validate that the given value match Name production

+
value:an Name value
Returns:1 if valid or 0 otherwise
Function: xmlSnprintfElementContent
void	xmlSnprintfElementContent	(char * buf, 
				 int size, 
				 xmlElementContentPtr content, 
				 int glob)

+
This will dump the content of the element content definition Intended just for the debug routine

+
buf:an output buffer
size:the buffer size
content:An element table
glob:1 if one must print the englobing parenthesis, 0 otherwise
Function: xmlAddRef
xmlRefPtr	xmlAddRef	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 const xmlChar * value, 
				 xmlAttrPtr attr)

+
Register a new ref declaration

+
ctxt:the validation context
doc:pointer to the document
value:the value name
attr:the attribute holding the Ref
Returns:NULL if not, otherwise the new xmlRefPtr
Function: xmlDumpAttributeDecl
void	xmlDumpAttributeDecl	(xmlBufferPtr buf, 
				 xmlAttributePtr attr)

+
This will dump the content of the attribute declaration as an XML DTD definition

+
buf:the XML buffer output
attr:An attribute declaration
Function: xmlValidateDocumentFinal
int	xmlValidateDocumentFinal	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Does the final step for the document validation once all the incremental validation steps have been completed basically it does the following checks described by the XML Rec Check all the IDREF/IDREFS attributes definition for validity

+
ctxt:the validation context
doc:a document instance
Returns:1 if valid or 0 otherwise
Function: xmlValidateDtdFinal
int	xmlValidateDtdFinal	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Does the final step for the dtds validation once all the subsets have been parsed basically it does the following checks described by the XML Rec - check that ENTITY and ENTITIES type attributes default or possible values matches one of the defined entities. - check that NOTATION type attributes default or possible values matches one of the defined notations.

+
ctxt:the validation context
doc:a document instance
Returns:1 if valid or 0 if invalid and -1 if not well-formed
Function: xmlDumpAttributeTable
void	xmlDumpAttributeTable	(xmlBufferPtr buf, 
				 xmlAttributeTablePtr table)

+
This will dump the content of the attribute table as an XML DTD definition

+
buf:the XML buffer output
table:An attribute table
Function: xmlCreateEnumeration
xmlEnumerationPtr	xmlCreateEnumeration	(const xmlChar * name)

+
create and initialize an enumeration attribute node.

+
name:the enumeration name or NULL
Returns:the xmlEnumerationPtr just created or NULL in case of error.
Function: xmlValidateOneAttribute
int	xmlValidateOneAttribute	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 xmlAttrPtr attr, 
				 const xmlChar * value)

+
Try to validate a single attribute for an element basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Attribute Value Type ] - [ VC: Fixed Attribute Default ] - [ VC: Entity Name ] - [ VC: Name Token ] - [ VC: ID ] - [ VC: IDREF ] - [ VC: Entity Name ] - [ VC: Notation Attributes ] The ID/IDREF uniqueness and matching are done separately

+
ctxt:the validation context
doc:a document instance
elem:an element instance
attr:an attribute instance
value:the attribute value (without entities processing)
Returns:1 if valid or 0 otherwise
Function: xmlValidGetValidElements
int	xmlValidGetValidElements	(xmlNode * prev, 
				 xmlNode * next, 
				 const xmlChar ** list, 
				 int max)

+
This function returns the list of authorized children to insert within an existing tree while respecting the validity constraints forced by the Dtd. The insertion point is defined using @prev and @next in the following ways: to insert before 'node': xmlValidGetValidElements(node->prev, node, ... to insert next 'node': xmlValidGetValidElements(node, node->next, ... to replace 'node': xmlValidGetValidElements(node->prev, node->next, ... to prepend a child to 'node': xmlValidGetValidElements(NULL, node->childs, to append a child to 'node': xmlValidGetValidElements(node->last, NULL, ... pointers to the element names are inserted at the beginning of the array and do not need to be freed.

+
prev:an element to insert after
next:an element to insert next
list:an array to store the list of child names
max:the size of the array
Returns:the number of element in the list, or -1 in case of error. If the function returns the value @max the caller is invited to grow the receiving array and retry.
Function: xmlDumpNotationTable
void	xmlDumpNotationTable	(xmlBufferPtr buf, 
				 xmlNotationTablePtr table)

+
This will dump the content of the notation table as an XML DTD definition

+
buf:the XML buffer output
table:A notation table
Function: xmlDumpNotationDecl
void	xmlDumpNotationDecl	(xmlBufferPtr buf, 
				 xmlNotationPtr nota)

+
This will dump the content the notation declaration as an XML DTD definition

+
buf:the XML buffer output
nota:A notation declaration
Function: xmlIsID
int	xmlIsID	(xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 xmlAttrPtr attr)

+
Determine whether an attribute is of type ID. In case we have DTD(s) then this is done if DTD loading has been requested. In the case of HTML documents parsed with the HTML parser, then ID detection is done systematically.

+
doc:the document
elem:the element carrying the attribute
attr:the attribute
Returns:0 or 1 depending on the lookup result
Function: xmlGetDtdQAttrDesc
xmlAttributePtr	xmlGetDtdQAttrDesc	(xmlDtdPtr dtd, 
				 const xmlChar * elem, 
				 const xmlChar * name, 
				 const xmlChar * prefix)

+
Search the DTD for the description of this qualified attribute on this element.

+
dtd:a pointer to the DtD to search
elem:the element name
name:the attribute name
prefix:the attribute namespace prefix
Returns:the xmlAttributePtr if found or NULL
Function: xmlFreeAttributeTable
void	xmlFreeAttributeTable	(xmlAttributeTablePtr table)

+
Deallocate the memory used by an entities hash table.

+
table:An attribute table

+      Callback called when a validity error is found. This is a message oriented function similar to an *printf function.
+      
+      
+      
+      
+    
Function: xmlValidateAttributeDecl
int	xmlValidateAttributeDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlAttributePtr attr)

+
Try to validate a single attribute definition basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Attribute Default Legal ] - [ VC: Enumeration ] - [ VC: ID Attribute Default ] The ID/IDREF uniqueness and matching are done separately

+
ctxt:the validation context
doc:a document instance
attr:an attribute definition
Returns:1 if valid or 0 otherwise
Function: xmlGetDtdQElementDesc
xmlElementPtr	xmlGetDtdQElementDesc	(xmlDtdPtr dtd, 
				 const xmlChar * name, 
				 const xmlChar * prefix)

+
Search the DTD for the description of this element

+
dtd:a pointer to the DtD to search
name:the element name
prefix:the element namespace prefix
Returns:the xmlElementPtr if found or NULL
Function: xmlGetRefs
xmlListPtr	xmlGetRefs	(xmlDocPtr doc, 
				 const xmlChar * ID)

+
Find the set of references for the supplied ID.

+
doc:pointer to the document
ID:the ID value
Returns:NULL if not found, otherwise node set for the ID.
Function: xmlCopyNotationTable
xmlNotationTablePtr	xmlCopyNotationTable	(xmlNotationTablePtr table)

+
Build a copy of a notation table.

+
table:A notation table
Returns:the new xmlNotationTablePtr or NULL in case of error.
Function: xmlValidGetPotentialChildren
int	xmlValidGetPotentialChildren	(xmlElementContent * ctree, 
				 const xmlChar ** list, 
				 int * len, 
				 int max)

+
Build/extend a list of potential children allowed by the content tree

+
ctree:an element content tree
list:an array to store the list of child names
len:a pointer to the number of element in the list
max:the size of the array
Returns:the number of element in the list, or -1 in case of error.
Function: xmlAddNotationDecl
xmlNotationPtr	xmlAddNotationDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDtdPtr dtd, 
				 const xmlChar * name, 
				 const xmlChar * PublicID, 
				 const xmlChar * SystemID)

+
Register a new notation declaration

+
ctxt:the validation context
dtd:pointer to the DTD
name:the entity name
PublicID:the public identifier or NULL
SystemID:the system identifier or NULL
Returns:NULL if not, otherwise the entity
Function: xmlValidateElementDecl
int	xmlValidateElementDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlElementPtr elem)

+
Try to validate a single element definition basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: One ID per Element Type ] - [ VC: No Duplicate Types ] - [ VC: Unique Element Type Declaration ]

+
ctxt:the validation context
doc:a document instance
elem:an element definition
Returns:1 if valid or 0 otherwise
Function: xmlAddAttributeDecl
xmlAttributePtr	xmlAddAttributeDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDtdPtr dtd, 
				 const xmlChar * elem, 
				 const xmlChar * name, 
				 const xmlChar * ns, 
				 xmlAttributeType type, 
				 xmlAttributeDefault def, 
				 const xmlChar * defaultValue, 
				 xmlEnumerationPtr tree)

+
Register a new attribute declaration Note that @tree becomes the ownership of the DTD

+
ctxt:the validation context
dtd:pointer to the DTD
elem:the element name
name:the attribute name
ns:the attribute namespace prefix
type:the attribute type
def:the attribute default type
defaultValue:the attribute default value
tree:if it's an enumeration, the associated list
Returns:NULL if not new, otherwise the attribute decl
Function: xmlGetID
xmlAttrPtr	xmlGetID	(xmlDocPtr doc, 
				 const xmlChar * ID)

+
Search the attribute declaring the given ID

+
doc:pointer to the document
ID:the ID value
Returns:NULL if not found, otherwise the xmlAttrPtr defining the ID
Function: xmlAddID
xmlIDPtr	xmlAddID	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 const xmlChar * value, 
				 xmlAttrPtr attr)

+
Register a new id declaration

+
ctxt:the validation context
doc:pointer to the document
value:the value name
attr:the attribute holding the ID
Returns:NULL if not, otherwise the new xmlIDPtr
Function: xmlSprintfElementContent
void	xmlSprintfElementContent	(char * buf, 
				 xmlElementContentPtr content, 
				 int glob)

+
Deprecated, unsafe, use xmlSnprintfElementContent

+
buf:an output buffer
content:An element table
glob:1 if one must print the englobing parenthesis, 0 otherwise
Function: xmlValidateOneElement
int	xmlValidateOneElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
Try to validate a single element and it's attributes, basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Element Valid ] - [ VC: Required Attribute ] Then call xmlValidateOneAttribute() for each attribute present. The ID/IDREF checkings are done separately

+
ctxt:the validation context
doc:a document instance
elem:an element instance
Returns:1 if valid or 0 otherwise
Function: xmlValidateNmtokenValue
int	xmlValidateNmtokenValue	(const xmlChar * value)

+
Validate that the given value match Nmtoken production [ VC: Name Token ]

+
value:an Nmtoken value
Returns:1 if valid or 0 otherwise
Function: xmlDumpElementTable
void	xmlDumpElementTable	(xmlBufferPtr buf, 
				 xmlElementTablePtr table)

+
This will dump the content of the element table as an XML DTD definition

+
buf:the XML buffer output
table:An element table
Function: xmlAddElementDecl
xmlElementPtr	xmlAddElementDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDtdPtr dtd, 
				 const xmlChar * name, 
				 xmlElementTypeVal type, 
				 xmlElementContentPtr content)

+
Register a new element declaration

+
ctxt:the validation context
dtd:pointer to the DTD
name:the entity name
type:the element type
content:the element content tree or NULL
Returns:NULL if not, otherwise the entity
Function: xmlGetDtdNotationDesc
xmlNotationPtr	xmlGetDtdNotationDesc	(xmlDtdPtr dtd, 
				 const xmlChar * name)

+
Search the DTD for the description of this notation

+
dtd:a pointer to the DtD to search
name:the notation name
Returns:the xmlNotationPtr if found or NULL
Function: xmlValidateOneNamespace
int	xmlValidateOneNamespace	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * prefix, 
				 xmlNsPtr ns, 
				 const xmlChar * value)

+
Try to validate a single namespace declaration for an element basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Attribute Value Type ] - [ VC: Fixed Attribute Default ] - [ VC: Entity Name ] - [ VC: Name Token ] - [ VC: ID ] - [ VC: IDREF ] - [ VC: Entity Name ] - [ VC: Notation Attributes ] The ID/IDREF uniqueness and matching are done separately

+
ctxt:the validation context
doc:a document instance
elem:an element instance
prefix:the namespace prefix
ns:an namespace declaration instance
value:the attribute value (without entities processing)
Returns:1 if valid or 0 otherwise
Function: xmlValidatePushElement
int	xmlValidatePushElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * qname)

+
Push a new element start on the validation stack.

+
ctxt:the validation context
doc:a document instance
elem:an element instance
qname:the qualified name as appearing in the serialization
Returns:1 if no validation problem was found or 0 otherwise
Function: xmlIsRef
int	xmlIsRef	(xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 xmlAttrPtr attr)

+
Determine whether an attribute is of type Ref. In case we have DTD(s) then this is simple, otherwise we use an heuristic: name Ref (upper or lowercase).

+
doc:the document
elem:the element carrying the attribute
attr:the attribute
Returns:0 or 1 depending on the lookup result
Function: xmlRemoveRef
int	xmlRemoveRef	(xmlDocPtr doc, 
				 xmlAttrPtr attr)

+
Remove the given attribute from the Ref table maintained internally.

+
doc:the document
attr:the attribute
Returns:-1 if the lookup failed and 0 otherwise
Function: xmlCopyElementTable
xmlElementTablePtr	xmlCopyElementTable	(xmlElementTablePtr table)

+
Build a copy of an element table.

+
table:An element table
Returns:the new xmlElementTablePtr or NULL in case of error.
Function: xmlValidateNmtokensValue
int	xmlValidateNmtokensValue	(const xmlChar * value)

+
Validate that the given value match Nmtokens production [ VC: Name Token ]

+
value:an Nmtokens value
Returns:1 if valid or 0 otherwise
Function: xmlFreeRefTable
void	xmlFreeRefTable	(xmlRefTablePtr table)

+
Deallocate the memory used by an Ref hash table.

+
table:An ref table

+      Callback called when a validity warning is found. This is a message oriented function similar to an *printf function.
+      
+      
+      
+      
+    
Function: xmlRemoveID
int	xmlRemoveID	(xmlDocPtr doc, 
				 xmlAttrPtr attr)

+
Remove the given attribute from the ID table maintained internally.

+
doc:the document
attr:the attribute
Returns:-1 if the lookup failed and 0 otherwise
Function: xmlFreeElementTable
void	xmlFreeElementTable	(xmlElementTablePtr table)

+
Deallocate the memory used by an element hash table.

+
table:An element table
Function: xmlValidatePopElement
int	xmlValidatePopElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * qname)

+
Pop the element end from the validation stack.

+
ctxt:the validation context
doc:a document instance
elem:an element instance
qname:the qualified name as appearing in the serialization
Returns:1 if no validation problem was found or 0 otherwise
Function: xmlFreeIDTable
void	xmlFreeIDTable	(xmlIDTablePtr table)

+
Deallocate the memory used by an ID hash table.

+
table:An id table

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlFreeValidCtxt
void	xmlFreeValidCtxt	(xmlValidCtxtPtr cur)

+
Free a validation context structure.

+
cur:the validation context to free
Function: xmlCopyAttributeTable
xmlAttributeTablePtr	xmlCopyAttributeTable	(xmlAttributeTablePtr table)

+
Build a copy of an attribute table.

+
table:An attribute table
Returns:the new xmlAttributeTablePtr or NULL in case of error.
Function: xmlCopyElementContent
xmlElementContentPtr	xmlCopyElementContent	(xmlElementContentPtr cur)

+
Build a copy of an element content description.

+
cur:An element content pointer.
Returns:the new xmlElementContentPtr or NULL in case of error.
Function: xmlValidateAttributeValue
int	xmlValidateAttributeValue	(xmlAttributeType type, 
				 const xmlChar * value)

+
Validate that the given attribute value match the proper production [ VC: ID ] Values of type ID must match the Name production.... [ VC: IDREF ] Values of type IDREF must match the Name production, and values of type IDREFS must match Names ... [ VC: Entity Name ] Values of type ENTITY must match the Name production, values of type ENTITIES must match Names ... [ VC: Name Token ] Values of type NMTOKEN must match the Nmtoken production; values of type NMTOKENS must match Nmtokens.

+
type:an attribute type
value:an attribute value
Returns:1 if valid or 0 otherwise
Function: xmlValidateRoot
int	xmlValidateRoot	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Try to validate a the root element basically it does the following check as described by the XML-1.0 recommendation: - [ VC: Root Element Type ] it doesn't try to recurse or apply other check to the element

+
ctxt:the validation context
doc:a document instance
Returns:1 if valid or 0 otherwise
Function: xmlValidCtxtNormalizeAttributeValue
xmlChar *	xmlValidCtxtNormalizeAttributeValue	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Does the validation related extra step of the normalization of attribute values: If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and trailing space (#x20) characters, and by replacing sequences of space (#x20) characters by single space (#x20) character. Also check VC: Standalone Document Declaration in P32, and update ctxt->valid accordingly

+
ctxt:the validation context or NULL
doc:the document
elem:the parent
name:the attribute name
value:the attribute value
Returns:a new normalized string if normalization is needed, NULL otherwise the caller must free the returned value.
Function: xmlFreeEnumeration
void	xmlFreeEnumeration	(xmlEnumerationPtr cur)

+
free an enumeration attribute node (recursive).

+
cur:the tree to free.
Function: xmlValidateNamesValue
int	xmlValidateNamesValue	(const xmlChar * value)

+
Validate that the given value match Names production

+
value:an Names value
Returns:1 if valid or 0 otherwise
Function: xmlCopyEnumeration
xmlEnumerationPtr	xmlCopyEnumeration	(xmlEnumerationPtr cur)

+
Copy an enumeration attribute node (recursive).

+
cur:the tree to copy.
Returns:the xmlEnumerationPtr just created or NULL in case of error.
Function: xmlGetDtdAttrDesc
xmlAttributePtr	xmlGetDtdAttrDesc	(xmlDtdPtr dtd, 
				 const xmlChar * elem, 
				 const xmlChar * name)

+
Search the DTD for the description of this attribute on this element.

+
dtd:a pointer to the DtD to search
elem:the element name
name:the attribute name
Returns:the xmlAttributePtr if found or NULL
Function: xmlValidateDtd
int	xmlValidateDtd	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlDtdPtr dtd)

+
Try to validate the document against the dtd instance basically it does check all the definitions in the DtD.

+
ctxt:the validation context
doc:a document instance
dtd:a dtd instance
Returns:1 if valid or 0 otherwise
Function: xmlNewValidCtxt
xmlValidCtxtPtr	xmlNewValidCtxt	(void)

+
Allocate a validation context structure.

+
Returns:NULL if not, otherwise the new validation context structure
Function: xmlIsMixedElement
int	xmlIsMixedElement	(xmlDocPtr doc, 
				 const xmlChar * name)

+
Search in the DtDs whether an element accept Mixed content (or ANY) basically if it is supposed to accept text childs

+
doc:the document
name:the element name
Returns:0 if no, 1 if yes, and -1 if no element description is available
Function: xmlDumpElementDecl
void	xmlDumpElementDecl	(xmlBufferPtr buf, 
				 xmlElementPtr elem)

+
This will dump the content of the element declaration as an XML DTD definition

+
buf:the XML buffer output
elem:An element table
Function: xmlValidNormalizeAttributeValue
xmlChar *	xmlValidNormalizeAttributeValue	(xmlDocPtr doc, 
				 xmlNodePtr elem, 
				 const xmlChar * name, 
				 const xmlChar * value)

+
Does the validation related extra step of the normalization of attribute values: If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and trailing space (#x20) characters, and by replacing sequences of space (#x20) characters by single space (#x20) character.

+
doc:the document
elem:the parent
name:the attribute name
value:the attribute value
Returns:a new normalized string if normalization is needed, NULL otherwise the caller must free the returned value.
Function: xmlValidBuildContentModel
int	xmlValidBuildContentModel	(xmlValidCtxtPtr ctxt, 
				 xmlElementPtr elem)

+
(Re)Build the automata associated to the content model of this element

+
ctxt:a validation context
elem:an element declaration node
Returns:1 in case of success, 0 in case of error
Function: xmlValidateElement
int	xmlValidateElement	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNodePtr elem)

+
Try to validate the subtree under an element

+
ctxt:the validation context
doc:a document instance
elem:an element instance
Returns:1 if valid or 0 otherwise
Function: xmlValidateNotationUse
int	xmlValidateNotationUse	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 const xmlChar * notationName)

+
Validate that the given name match a notation declaration. - [ VC: Notation Declared ]

+
ctxt:the validation context
doc:the document
notationName:the notation name to check
Returns:1 if valid or 0 otherwise
Function: xmlValidateNotationDecl
int	xmlValidateNotationDecl	(xmlValidCtxtPtr ctxt, 
				 xmlDocPtr doc, 
				 xmlNotationPtr nota)

+
Try to validate a single notation definition basically it does the following checks as described by the XML-1.0 recommendation: - it seems that no validity constraint exists on notation declarations But this function get called anyway ...

+
ctxt:the validation context
doc:a document instance
nota:a notation definition
Returns:1 if valid or 0 otherwise
Function: xmlNewElementContent
xmlElementContentPtr	xmlNewElementContent	(const xmlChar * name, 
				 xmlElementContentType type)

+
Allocate an element content structure.

+
name:the subelement name or NULL
type:the type of element content decl
Returns:NULL if not, otherwise the new element content structure
Function: xmlGetDtdElementDesc
xmlElementPtr	xmlGetDtdElementDesc	(xmlDtdPtr dtd, 
				 const xmlChar * name)

+
Search the DTD for the description of this element

+
dtd:a pointer to the DtD to search
name:the element name
Returns:the xmlElementPtr if found or NULL
Function: xmlFreeElementContent
void	xmlFreeElementContent	(xmlElementContentPtr cur)

+
Free an element content structure. This is a recursive call !

+
cur:the element content tree to free
Function: xmlValidatePushCData
int	xmlValidatePushCData	(xmlValidCtxtPtr ctxt, 
				 const xmlChar * data, 
				 int len)

+
check the CData parsed for validation in the current stack

+
ctxt:the validation context
data:some character data read
len:the lenght of the data
Returns:1 if no validation problem was found or 0 otherwise
Daniel Veillard

diff --git a/doc/html/libxml-wincecompat.html b/doc/html/libxml-wincecompat.html
deleted file mode 100644
index 749049fc..00000000
--- a/doc/html/libxml-wincecompat.html
+++ /dev/null
@@ -1,154 +0,0 @@
-wincecompat
PrevUpHomeGnome XML Library Reference ManualNext
wincecompat
wincecompat — 
Synopsis
-
-
-
-#define     MAX_STRERROR
-#define     O_RDONLY
-#define     O_WRONLY
-#define     O_RDWR
-#define     O_APPEND
-#define     O_CREAT
-#define     O_TRUNC
-#define     O_EXCL
-extern      int errno;
-int         read                            (int handle,
-                                             char *buffer,
-                                             unsigned int len);
-int         write                           (int handle,
-                                             const char *buffer,
-                                             unsigned int len);
-int         open                            (const char *filename,
-                                             int oflag,
-                                             ...);
-int         close                           (int handle);
-char*       getenv                          (const char *varname);
-char*       strerror                        (int errnum);
-#define     snprintf
-#define     vsnprintf                       (b,c,f,a)
-#define     perror                          (_t)
-
Description

-
-
Details
MAX_STRERROR
#define MAX_STRERROR 31
-

-
-
O_RDONLY
#define O_RDONLY       0x0000  /* open for reading only */
-

-
-
O_WRONLY
#define O_WRONLY       0x0001  /* open for writing only */
-

-
-
O_RDWR
#define O_RDWR         0x0002  /* open for reading and writing */
-

-
-
O_APPEND
#define O_APPEND       0x0008  /* writes done at eof */
-

-
-
O_CREAT
#define O_CREAT        0x0100  /* create and open file */
-

-
-
O_TRUNC
#define O_TRUNC        0x0200  /* open and truncate */
-

-
-
O_EXCL
#define O_EXCL         0x0400  /* open only if file doesn't already exist */
-

-
-
errno
extern int errno;
-

-
-
read ()
int         read                            (int handle,
-                                             char *buffer,
-                                             unsigned int len);

-
-
handle:
-
buffer:
-
len:
-
Returns :
-
-
-
write ()
int         write                           (int handle,
-                                             const char *buffer,
-                                             unsigned int len);

-
-
handle:
-
buffer:
-
len:
-
Returns :
-
-
-
open ()
int         open                            (const char *filename,
-                                             int oflag,
-                                             ...);

-
-
filename:
-
oflag:
-
...:
-
Returns :
-
-
-
close ()
int         close                           (int handle);

-
-
handle:
-
Returns :
-
-
-
getenv ()
char*       getenv                          (const char *varname);

-
-
varname:
-
Returns :
-
-
-
strerror ()
char*       strerror                        (int errnum);

-
-
errnum:
-
Returns :
-
-
-
snprintf
#define snprintf _snprintf
-

-
-
vsnprintf()
#define vsnprintf(b,c,f,a) _vsnprintf(b,c,f,a)
-

-
-
b:
-
c:
-
f:
-
a:
-
-
-
perror()
#define perror(_t) MessageBox(NULL, _T("_t"), _T("Error/Warning"), MB_OK)
-

-
-
_t:
-
-
-
<< testOOMlibwsockcompat >>

diff --git a/doc/html/libxml-wsockcompat.html b/doc/html/libxml-wsockcompat.html
deleted file mode 100644
index 3d6bee3f..00000000
--- a/doc/html/libxml-wsockcompat.html
+++ /dev/null
@@ -1,181 +0,0 @@
-wsockcompat
PrevUpHomeGnome XML Library Reference ManualNext
wsockcompat
wsockcompat — 
Synopsis
-
-
-
-#define     SOCKLEN_T
-#define     EWOULDBLOCK
-#define     EINPROGRESS
-#define     EALREADY
-#define     ENOTSOCK
-#define     EDESTADDRREQ
-#define     EMSGSIZE
-#define     EPROTOTYPE
-#define     ENOPROTOOPT
-#define     EPROTONOSUPPORT
-#define     ESOCKTNOSUPPORT
-#define     EOPNOTSUPP
-#define     EPFNOSUPPORT
-#define     EAFNOSUPPORT
-#define     EADDRINUSE
-#define     EADDRNOTAVAIL
-#define     ENETDOWN
-#define     ENETUNREACH
-#define     ENETRESET
-#define     ECONNABORTED
-#define     ECONNRESET
-#define     ENOBUFS
-#define     EISCONN
-#define     ENOTCONN
-#define     ESHUTDOWN
-#define     ETOOMANYREFS
-#define     ETIMEDOUT
-#define     ECONNREFUSED
-#define     ELOOP
-#define     EHOSTDOWN
-#define     EHOSTUNREACH
-#define     EPROCLIM
-#define     EUSERS
-#define     EDQUOT
-#define     ESTALE
-#define     EREMOTE
-
Description

-
-
Details
SOCKLEN_T
#define SOCKLEN_T int
-

-
-
EWOULDBLOCK
#define EWOULDBLOCK             WSAEWOULDBLOCK
-

-
-
EINPROGRESS
#define EINPROGRESS             WSAEINPROGRESS
-

-
-
EALREADY
#define EALREADY                WSAEALREADY
-

-
-
ENOTSOCK
#define ENOTSOCK                WSAENOTSOCK
-

-
-
EDESTADDRREQ
#define EDESTADDRREQ            WSAEDESTADDRREQ
-

-
-
EMSGSIZE
#define EMSGSIZE                WSAEMSGSIZE
-

-
-
EPROTOTYPE
#define EPROTOTYPE              WSAEPROTOTYPE
-

-
-
ENOPROTOOPT
#define ENOPROTOOPT             WSAENOPROTOOPT
-

-
-
EPROTONOSUPPORT
#define EPROTONOSUPPORT         WSAEPROTONOSUPPORT
-

-
-
ESOCKTNOSUPPORT
#define ESOCKTNOSUPPORT         WSAESOCKTNOSUPPORT
-

-
-
EOPNOTSUPP
#define EOPNOTSUPP              WSAEOPNOTSUPP
-

-
-
EPFNOSUPPORT
#define EPFNOSUPPORT            WSAEPFNOSUPPORT
-

-
-
EAFNOSUPPORT
#define EAFNOSUPPORT            WSAEAFNOSUPPORT
-

-
-
EADDRINUSE
#define EADDRINUSE              WSAEADDRINUSE
-

-
-
EADDRNOTAVAIL
#define EADDRNOTAVAIL           WSAEADDRNOTAVAIL
-

-
-
ENETDOWN
#define ENETDOWN                WSAENETDOWN
-

-
-
ENETUNREACH
#define ENETUNREACH             WSAENETUNREACH
-

-
-
ENETRESET
#define ENETRESET               WSAENETRESET
-

-
-
ECONNABORTED
#define ECONNABORTED            WSAECONNABORTED
-

-
-
ECONNRESET
#define ECONNRESET              WSAECONNRESET
-

-
-
ENOBUFS
#define ENOBUFS                 WSAENOBUFS
-

-
-
EISCONN
#define EISCONN                 WSAEISCONN
-

-
-
ENOTCONN
#define ENOTCONN                WSAENOTCONN
-

-
-
ESHUTDOWN
#define ESHUTDOWN               WSAESHUTDOWN
-

-
-
ETOOMANYREFS
#define ETOOMANYREFS            WSAETOOMANYREFS
-

-
-
ETIMEDOUT
#define ETIMEDOUT               WSAETIMEDOUT
-

-
-
ECONNREFUSED
#define ECONNREFUSED            WSAECONNREFUSED
-

-
-
ELOOP
#define ELOOP                   WSAELOOP
-

-
-
EHOSTDOWN
#define EHOSTDOWN               WSAEHOSTDOWN
-

-
-
EHOSTUNREACH
#define EHOSTUNREACH            WSAEHOSTUNREACH
-

-
-
EPROCLIM
#define EPROCLIM                WSAEPROCLIM
-

-
-
EUSERS
#define EUSERS                  WSAEUSERS
-

-
-
EDQUOT
#define EDQUOT                  WSAEDQUOT
-

-
-
ESTALE
#define ESTALE                  WSAESTALE
-

-
-
EREMOTE
#define EREMOTE                 WSAEREMOTE
-

-
-
<< wincecompatencoding >>

diff --git a/doc/html/libxml-xinclude.html b/doc/html/libxml-xinclude.html
index 470676ff..3da82264 100644
--- a/doc/html/libxml-xinclude.html
+++ b/doc/html/libxml-xinclude.html
@@ -1,112 +1,54 @@
-xinclude
PrevUpHomeGnome XML Library Reference ManualNext
xinclude
xinclude — 
Synopsis
+
+
+Module xinclude from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xinclude from libxml2
Main Menu
Related links
Table of Contents
#define XINCLUDE_PARSE_TEXT
 
+
Structure xmlXIncludeCtxt
struct _xmlXIncludeCtxt {
+The content of this structure is not made public by the API.
+}

#define XINCLUDE_HREF
 
+
int	xmlXIncludeProcessNode	(xmlXIncludeCtxtPtr ctxt, 
				 xmlNodePtr node)

+
#define XINCLUDE_FALLBACK
 
-#define     XINCLUDE_NS
-#define     XINCLUDE_NODE
-#define     XINCLUDE_FALLBACK
-#define     XINCLUDE_HREF
-#define     XINCLUDE_PARSE
-#define     XINCLUDE_PARSE_XML
-#define     XINCLUDE_PARSE_TEXT
-#define     XINCLUDE_PARSE_ENCODING
-struct      xmlXIncludeCtxt;
-typedef     xmlXIncludeCtxtPtr;
-int         xmlXIncludeProcess              (xmlDocPtr doc);
-int         xmlXIncludeProcessTree          (xmlNodePtr tree);
-xmlXIncludeCtxtPtr xmlXIncludeNewContext    (xmlDocPtr doc);
-void        xmlXIncludeFreeContext          (xmlXIncludeCtxtPtr ctxt);
-int         xmlXIncludeProcessNode          (xmlXIncludeCtxtPtr ctxt,
-                                             xmlNodePtr tree);
-
Description

+
#define XINCLUDE_NS
 
-
Details
XINCLUDE_NS
#define XINCLUDE_NS (const xmlChar *) "http://www.w3.org/2001/XInclude"
-

+
Typedef xmlXIncludeCtxt * xmlXIncludeCtxtPtr
 
-
XINCLUDE_NODE
#define XINCLUDE_NODE (const xmlChar *) "include"
-

+
int	xmlXIncludeProcessTree	(xmlNodePtr tree)

+
int	xmlXIncludeProcess	(xmlDocPtr doc)

+
void	xmlXIncludeFreeContext	(xmlXIncludeCtxtPtr ctxt)

+
#define XINCLUDE_PARSE
 
-
XINCLUDE_FALLBACK
#define XINCLUDE_FALLBACK (const xmlChar *) "fallback"
-

+
#define XINCLUDE_NODE
 
-
XINCLUDE_HREF
#define XINCLUDE_HREF (const xmlChar *) "href"
-

+
#define XINCLUDE_PARSE_XML
 
-
XINCLUDE_PARSE
#define XINCLUDE_PARSE (const xmlChar *) "parse"
-

+
xmlXIncludeCtxtPtr	xmlXIncludeNewContext	(xmlDocPtr doc)

+
#define XINCLUDE_PARSE_ENCODING
 
-
XINCLUDE_PARSE_XML
#define XINCLUDE_PARSE_XML (const xmlChar *) "xml"
-

-
-
XINCLUDE_PARSE_TEXT
#define XINCLUDE_PARSE_TEXT (const xmlChar *) "text"
-

-
-
XINCLUDE_PARSE_ENCODING
#define XINCLUDE_PARSE_ENCODING (const xmlChar *) "encoding"
-

-
-
struct xmlXIncludeCtxt
struct xmlXIncludeCtxt;

-
-
xmlXIncludeCtxtPtr
typedef xmlXIncludeCtxt *xmlXIncludeCtxtPtr;
-

-
-
xmlXIncludeProcess ()
int         xmlXIncludeProcess              (xmlDocPtr doc);

-Implement the XInclude substitution on the XML document doc

-
-
doc: an XML document
-
Returns :0 if no substitution were done, -1 if some processing failed
-   or the number of substitutions done.
-
xmlXIncludeProcessTree ()
int         xmlXIncludeProcessTree          (xmlNodePtr tree);

-Implement the XInclude substitution for the given subtree

-
-
tree: a node in an XML document
-
Returns :0 if no substitution were done, -1 if some processing failed
-   or the number of substitutions done.
-
xmlXIncludeNewContext ()
xmlXIncludeCtxtPtr xmlXIncludeNewContext    (xmlDocPtr doc);

-Creates a new XInclude context

-
-
doc:  an XML Document
-
Returns :the new set
-
xmlXIncludeFreeContext ()
void        xmlXIncludeFreeContext          (xmlXIncludeCtxtPtr ctxt);

-Free an XInclude context

-
-
ctxt: the XInclude context
-
xmlXIncludeProcessNode ()
int         xmlXIncludeProcessNode          (xmlXIncludeCtxtPtr ctxt,
-                                             xmlNodePtr tree);

-Implement the XInclude substitution for the given subtree reusing
-the informations and data coming from the given context.

-
-
ctxt: an existing XInclude context
-
tree:
-
Returns :0 if no substitution were done, -1 if some processing failed
-   or the number of substitutions done.
-
<< xmlexportsxmlreader >>

+
Description

+
Macro: XINCLUDE_PARSE_TEXT
#define XINCLUDE_PARSE_TEXT

+
Macro: XINCLUDE_HREF
#define XINCLUDE_HREF

+
Function: xmlXIncludeProcessNode
int	xmlXIncludeProcessNode	(xmlXIncludeCtxtPtr ctxt, 
				 xmlNodePtr node)

+
Implement the XInclude substitution for the given subtree reusing the informations and data coming from the given context.

+
ctxt:an existing XInclude context
node:a node in an XML document
Returns:0 if no substitution were done, -1 if some processing failed or the number of substitutions done.
Macro: XINCLUDE_FALLBACK
#define XINCLUDE_FALLBACK

+
Macro: XINCLUDE_NS
#define XINCLUDE_NS

+
Function: xmlXIncludeProcessTree
int	xmlXIncludeProcessTree	(xmlNodePtr tree)

+
Implement the XInclude substitution for the given subtree

+
tree:a node in an XML document
Returns:0 if no substitution were done, -1 if some processing failed or the number of substitutions done.
Function: xmlXIncludeProcess
int	xmlXIncludeProcess	(xmlDocPtr doc)

+
Implement the XInclude substitution on the XML document @doc

+
doc:an XML document
Returns:0 if no substitution were done, -1 if some processing failed or the number of substitutions done.
Function: xmlXIncludeFreeContext
void	xmlXIncludeFreeContext	(xmlXIncludeCtxtPtr ctxt)

+
Free an XInclude context

+
ctxt:the XInclude context
Macro: XINCLUDE_PARSE
#define XINCLUDE_PARSE

+
Macro: XINCLUDE_NODE
#define XINCLUDE_NODE

+
Macro: XINCLUDE_PARSE_XML
#define XINCLUDE_PARSE_XML

+
Function: xmlXIncludeNewContext
xmlXIncludeCtxtPtr	xmlXIncludeNewContext	(xmlDocPtr doc)

+
Creates a new XInclude context

+
doc:an XML Document
Returns:the new set
Macro: XINCLUDE_PARSE_ENCODING
#define XINCLUDE_PARSE_ENCODING

+
Daniel Veillard

diff --git a/doc/html/libxml-xmlIO.html b/doc/html/libxml-xmlIO.html
index ebc342af..8c63b4c0 100644
--- a/doc/html/libxml-xmlIO.html
+++ b/doc/html/libxml-xmlIO.html
@@ -1,585 +1,206 @@
-xmlIO
PrevUpHomeGnome XML Library Reference ManualNext
xmlIO
xmlIO — 
Synopsis
+
+
+Module xmlIO from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlIO from libxml2
Main Menu
Related links
Table of Contents
int	xmlIOHTTPRead	(void * context, 
				 char * buffer, 
				 int len)

+
Function type: xmlInputMatchCallback
+int	xmlInputMatchCallback	(char const * filename)
+
Callback used in the I/O Input API to detect if the current handler can provide input fonctionnalities for this resource.
filename:the filename or URI
Returns:1 if yes and 0 if another Input module should be used


+
void	xmlRegisterDefaultOutputCallbacks	(void)

+
int	xmlFileClose	(void * context)

+
Function type: xmlOutputMatchCallback
+int	xmlOutputMatchCallback	(char const * filename)
+
Callback used in the I/O Output API to detect if the current handler can provide output fonctionnalities for this resource.
filename:the filename or URI
Returns:1 if yes and 0 if another Output module should be used


+
int	xmlIOFTPRead	(void * context, 
				 char * buffer, 
				 int len)

+
void	xmlRegisterHTTPPostCallbacks	(void)

+
void *	xmlIOFTPOpen	(const char * filename)

+
int	xmlIOFTPClose	(void * context)

+
void *	xmlFileOpen	(const char * filename)

+
xmlOutputBufferPtr	xmlOutputBufferCreateFile	(FILE * file, 
				 xmlCharEncodingHandlerPtr encoder)

+
int	xmlCheckFilename	(const char * path)

+
Function type: xmlOutputOpenCallback
+void *	xmlOutputOpenCallback	(char const * filename)
+
Callback used in the I/O Output API to open the resource
filename:the filename or URI
Returns:an Output context or NULL in case or error


+
xmlParserInputBufferPtr	xmlParserInputBufferCreateFilename	(const char * URI, 
				 xmlCharEncoding enc)

+
int	xmlOutputBufferClose	(xmlOutputBufferPtr out)

+
xmlParserInputBufferPtr	xmlParserInputBufferCreateFd	(int fd, 
				 xmlCharEncoding enc)

+
xmlOutputBufferPtr	xmlOutputBufferCreateIO	(xmlOutputWriteCallback iowrite, 
				 xmlOutputCloseCallback ioclose, 
				 void * ioctx, 
				 xmlCharEncodingHandlerPtr encoder)

+
Function type: xmlOutputWriteCallback
+int	xmlOutputWriteCallback	(void * context, 
				 const char * buffer, 
				 int len)
+
Callback used in the I/O Output API to write to the resource
context:an Output context
buffer:the buffer of data to write
len:the length of the buffer in bytes
Returns:the number of bytes written or -1 in case of error


+
int	xmlOutputBufferFlush	(xmlOutputBufferPtr out)

+
xmlParserInputPtr	xmlCheckHTTPInput	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr ret)

+
int	xmlRegisterOutputCallbacks	(xmlOutputMatchCallback matchFunc, 
				 xmlOutputOpenCallback openFunc, 
				 xmlOutputWriteCallback writeFunc, 
				 xmlOutputCloseCallback closeFunc)

+
xmlParserInputBufferPtr	xmlParserInputBufferCreateMem	(const char * mem, 
				 int size, 
				 xmlCharEncoding enc)

+
int	xmlIOFTPMatch	(const char * filename)

+
int	xmlRegisterInputCallbacks	(xmlInputMatchCallback matchFunc, 
				 xmlInputOpenCallback openFunc, 
				 xmlInputReadCallback readFunc, 
				 xmlInputCloseCallback closeFunc)

+
void	xmlFreeParserInputBuffer	(xmlParserInputBufferPtr in)

+
void	xmlRegisterDefaultInputCallbacks	(void)

+
int	xmlParserInputBufferGrow	(xmlParserInputBufferPtr in, 
				 int len)

+
xmlOutputBufferPtr	xmlAllocOutputBuffer	(xmlCharEncodingHandlerPtr encoder)

+
xmlParserInputPtr	xmlNoNetExternalEntityLoader	(const char * URL, 
				 const char * ID, 
				 xmlParserCtxtPtr ctxt)

+
Function type: xmlOutputCloseCallback
+int	xmlOutputCloseCallback	(void * context)
+
Callback used in the I/O Output API to close the resource
context:an Output context
Returns:0 or -1 in case of error


+
int	xmlIOHTTPMatch	(const char * filename)

+
void *	xmlIOHTTPOpen	(const char * filename)

+
xmlParserInputBufferPtr	xmlParserInputBufferCreateIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 xmlCharEncoding enc)

+
xmlOutputBufferPtr	xmlOutputBufferCreateFd	(int fd, 
				 xmlCharEncodingHandlerPtr encoder)

+
xmlChar *	xmlNormalizeWindowsPath	(const xmlChar * path)

+
Function type: xmlInputReadCallback
+int	xmlInputReadCallback	(void * context, 
				 char * buffer, 
				 int len)
+
Callback used in the I/O Input API to read the resource
context:an Input context
buffer:the buffer to store data read
len:the length of the buffer in bytes
Returns:the number of bytes read or -1 in case of error


+
int	xmlIOHTTPClose	(void * context)

+
int	xmlParserInputBufferPush	(xmlParserInputBufferPtr in, 
				 int len, 
				 const char * buf)

+
xmlOutputBufferPtr	xmlOutputBufferCreateFilename	(const char * URI, 
				 xmlCharEncodingHandlerPtr encoder, 
				 int compression)

+
void	xmlCleanupOutputCallbacks	(void)

+
Function type: xmlInputOpenCallback
+void *	xmlInputOpenCallback	(char const * filename)
+
Callback used in the I/O Input API to open the resource
filename:the filename or URI
Returns:an Input context or NULL in case or error


+
int	xmlParserInputBufferRead	(xmlParserInputBufferPtr in, 
				 int len)

+
int	xmlOutputBufferWriteString	(xmlOutputBufferPtr out, 
				 const char * str)

+
int	xmlFileMatch	(const char * filename)

+
int	xmlFileRead	(void * context, 
				 char * buffer, 
				 int len)

+
xmlParserInputBufferPtr	xmlParserInputBufferCreateFile	(FILE * file, 
				 xmlCharEncoding enc)

+
xmlParserInputBufferPtr	xmlParserInputBufferCreateStatic	(const char * mem, 
				 int size, 
				 xmlCharEncoding enc)

+
char *	xmlParserGetDirectory	(const char * filename)

+
int	xmlOutputBufferWrite	(xmlOutputBufferPtr out, 
				 int len, 
				 const char * buf)

+
void	xmlCleanupInputCallbacks	(void)

+
Function type: xmlInputCloseCallback
+int	xmlInputCloseCallback	(void * context)
+
Callback used in the I/O Input API to close the resource
context:an Input context
Returns:0 or -1 in case of error


+
void *	xmlIOHTTPOpenW	(const char * post_uri, 
				 int compression)

+
xmlParserInputBufferPtr	xmlAllocParserInputBuffer	(xmlCharEncoding enc)

+
Description

+
Function: xmlIOHTTPRead
int	xmlIOHTTPRead	(void * context, 
				 char * buffer, 
				 int len)

+
Read @len bytes to @buffer from the I/O channel.

+
context:the I/O context
buffer:where to drop data
len:number of bytes to write
Returns:the number of bytes written

+      Callback used in the I/O Input API to detect if the current handler can provide input fonctionnalities for this resource.
+      
+      
+    
Function: xmlRegisterDefaultOutputCallbacks
void	xmlRegisterDefaultOutputCallbacks	(void)

+
Registers the default compiled-in I/O handlers.

+
Function: xmlFileClose
int	xmlFileClose	(void * context)

+
Close an I/O channel

+
context:the I/O context
Returns:0 or -1 in case of error

+      Callback used in the I/O Output API to detect if the current handler can provide output fonctionnalities for this resource.
+      
+      
+    
Function: xmlIOFTPRead
int	xmlIOFTPRead	(void * context, 
				 char * buffer, 
				 int len)

+
Read @len bytes to @buffer from the I/O channel.

+
context:the I/O context
buffer:where to drop data
len:number of bytes to write
Returns:the number of bytes written
Function: xmlRegisterHTTPPostCallbacks
void	xmlRegisterHTTPPostCallbacks	(void)

+
By default, libxml submits HTTP output requests using the "PUT" method. Calling this method changes the HTTP output method to use the "POST" method instead.

+
Function: xmlIOFTPOpen
void *	xmlIOFTPOpen	(const char * filename)

+
open an FTP I/O channel

+
filename:the URI for matching
Returns:an I/O context or NULL in case of error
Function: xmlIOFTPClose
int	xmlIOFTPClose	(void * context)

+
Close an FTP I/O channel

+
context:the I/O context
Returns:0
Function: xmlFileOpen
void *	xmlFileOpen	(const char * filename)

+
Wrapper around xmlFileOpen_real that try it with an unescaped version of @filename, if this fails fallback to @filename

+
filename:the URI for matching
Returns:a handler or NULL in case or failure
Function: xmlOutputBufferCreateFile
xmlOutputBufferPtr	xmlOutputBufferCreateFile	(FILE * file, 
				 xmlCharEncodingHandlerPtr encoder)

+
Create a buffered output for the progressive saving to a FILE * buffered C I/O

+
file:a FILE*
encoder:the encoding converter or NULL
Returns:the new parser output or NULL
Function: xmlCheckFilename
int	xmlCheckFilename	(const char * path)

+
function checks to see if @path is a valid source (file, socket...) for XML. if stat is not available on the target machine,

+
path:the path to check
Returns:1. if stat fails, returns 0 (if calling stat on the filename fails, it can't be right). if stat succeeds and the file is a directory, returns 2. otherwise returns 1.

+      Callback used in the I/O Output API to open the resource
+      
+      
+    
Function: xmlParserInputBufferCreateFilename
xmlParserInputBufferPtr	xmlParserInputBufferCreateFilename	(const char * URI, 
				 xmlCharEncoding enc)

+
Create a buffered parser input for the progressive parsing of a file If filename is "-' then we use stdin as the input. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. Do an encoding check if enc == XML_CHAR_ENCODING_NONE

+
URI:a C string containing the URI or filename
enc:the charset encoding if known
Returns:the new parser input or NULL
Function: xmlOutputBufferClose
int	xmlOutputBufferClose	(xmlOutputBufferPtr out)

+
flushes and close the output I/O channel and free up all the associated resources

+
out:a buffered output
Returns:the number of byte written or -1 in case of error.
Function: xmlParserInputBufferCreateFd
xmlParserInputBufferPtr	xmlParserInputBufferCreateFd	(int fd, 
				 xmlCharEncoding enc)

+
Create a buffered parser input for the progressive parsing for the input from a file descriptor

+
fd:a file descriptor number
enc:the charset encoding if known
Returns:the new parser input or NULL
Function: xmlOutputBufferCreateIO
xmlOutputBufferPtr	xmlOutputBufferCreateIO	(xmlOutputWriteCallback iowrite, 
				 xmlOutputCloseCallback ioclose, 
				 void * ioctx, 
				 xmlCharEncodingHandlerPtr encoder)

+
Create a buffered output for the progressive saving to an I/O handler

+
iowrite:an I/O write function
ioclose:an I/O close function
ioctx:an I/O handler
encoder:the charset encoding if known
Returns:the new parser output or NULL

+      Callback used in the I/O Output API to write to the resource
+      
+      
+      
+      
+    
Function: xmlOutputBufferFlush
int	xmlOutputBufferFlush	(xmlOutputBufferPtr out)

+
flushes the output I/O channel

+
out:a buffered output
Returns:the number of byte written or -1 in case of error.
Function: xmlCheckHTTPInput
xmlParserInputPtr	xmlCheckHTTPInput	(xmlParserCtxtPtr ctxt, 
				 xmlParserInputPtr ret)

+
Check an input in case it was created from an HTTP stream, in that case it will handle encoding and update of the base URL in case of redirection. It also checks for HTTP errors in which case the input is cleanly freed up and an appropriate error is raised in context

+
ctxt:an XML parser context
ret:an XML parser input
Returns:the input or NULL in case of HTTP error.
Function: xmlRegisterOutputCallbacks
int	xmlRegisterOutputCallbacks	(xmlOutputMatchCallback matchFunc, 
				 xmlOutputOpenCallback openFunc, 
				 xmlOutputWriteCallback writeFunc, 
				 xmlOutputCloseCallback closeFunc)

+
Register a new set of I/O callback for handling output.

+
matchFunc:the xmlOutputMatchCallback
openFunc:the xmlOutputOpenCallback
writeFunc:the xmlOutputWriteCallback
closeFunc:the xmlOutputCloseCallback
Returns:the registered handler number or -1 in case of error
Function: xmlParserInputBufferCreateMem
xmlParserInputBufferPtr	xmlParserInputBufferCreateMem	(const char * mem, 
				 int size, 
				 xmlCharEncoding enc)

+
Create a buffered parser input for the progressive parsing for the input from a memory area.

+
mem:the memory input
size:the length of the memory block
enc:the charset encoding if known
Returns:the new parser input or NULL
Function: xmlIOFTPMatch
int	xmlIOFTPMatch	(const char * filename)

+
check if the URI matches an FTP one

+
filename:the URI for matching
Returns:1 if matches, 0 otherwise
Function: xmlRegisterInputCallbacks
int	xmlRegisterInputCallbacks	(xmlInputMatchCallback matchFunc, 
				 xmlInputOpenCallback openFunc, 
				 xmlInputReadCallback readFunc, 
				 xmlInputCloseCallback closeFunc)

+
Register a new set of I/O callback for handling parser input.

+
matchFunc:the xmlInputMatchCallback
openFunc:the xmlInputOpenCallback
readFunc:the xmlInputReadCallback
closeFunc:the xmlInputCloseCallback
Returns:the registered handler number or -1 in case of error
Function: xmlFreeParserInputBuffer
void	xmlFreeParserInputBuffer	(xmlParserInputBufferPtr in)

+
Free up the memory used by a buffered parser input

+
in:a buffered parser input
Function: xmlRegisterDefaultInputCallbacks
void	xmlRegisterDefaultInputCallbacks	(void)

+
Registers the default compiled-in I/O handlers.

+
Function: xmlParserInputBufferGrow
int	xmlParserInputBufferGrow	(xmlParserInputBufferPtr in, 
				 int len)

+
Grow up the content of the input buffer, the old data are preserved This routine handle the I18N transcoding to internal UTF-8 This routine is used when operating the parser in normal (pull) mode TODO: one should be able to remove one extra copy by copying directly onto in->buffer or in->raw

+
in:a buffered parser input
len:indicative value of the amount of chars to read
Returns:the number of chars read and stored in the buffer, or -1 in case of error.
Function: xmlAllocOutputBuffer
xmlOutputBufferPtr	xmlAllocOutputBuffer	(xmlCharEncodingHandlerPtr encoder)

+
Create a buffered parser output

+
encoder:the encoding converter or NULL
Returns:the new parser output or NULL
Function: xmlNoNetExternalEntityLoader
xmlParserInputPtr	xmlNoNetExternalEntityLoader	(const char * URL, 
				 const char * ID, 
				 xmlParserCtxtPtr ctxt)

+
A specific entity loader disabling network accesses, though still allowing local catalog accesses for resolution.

+
URL:the URL for the entity to load
ID:the System ID for the entity to load
ctxt:the context in which the entity is called or NULL
Returns:a new allocated xmlParserInputPtr, or NULL.

+      Callback used in the I/O Output API to close the resource
+      
+      
+    
Function: xmlIOHTTPMatch
int	xmlIOHTTPMatch	(const char * filename)

+
check if the URI matches an HTTP one

+
filename:the URI for matching
Returns:1 if matches, 0 otherwise
Function: xmlIOHTTPOpen
void *	xmlIOHTTPOpen	(const char * filename)

+
open an HTTP I/O channel

+
filename:the URI for matching
Returns:an I/O context or NULL in case of error
Function: xmlParserInputBufferCreateIO
xmlParserInputBufferPtr	xmlParserInputBufferCreateIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 xmlCharEncoding enc)

+
Create a buffered parser input for the progressive parsing for the input from an I/O handler

+
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
enc:the charset encoding if known
Returns:the new parser input or NULL
Function: xmlOutputBufferCreateFd
xmlOutputBufferPtr	xmlOutputBufferCreateFd	(int fd, 
				 xmlCharEncodingHandlerPtr encoder)

+
Create a buffered output for the progressive saving to a file descriptor

+
fd:a file descriptor number
encoder:the encoding converter or NULL
Returns:the new parser output or NULL
Function: xmlNormalizeWindowsPath
xmlChar *	xmlNormalizeWindowsPath	(const xmlChar * path)

+
This function is obsolete. Please see xmlURIFromPath in uri.c for a better solution.

+
path:the input file path
Returns:a canonicalized version of the path

+      Callback used in the I/O Input API to read the resource
+      
+      
+      
+      
+    
Function: xmlIOHTTPClose
int	xmlIOHTTPClose	(void * context)

+
Close an HTTP I/O channel

+
context:the I/O context
Returns:0
Function: xmlParserInputBufferPush
int	xmlParserInputBufferPush	(xmlParserInputBufferPtr in, 
				 int len, 
				 const char * buf)

+
Push the content of the arry in the input buffer This routine handle the I18N transcoding to internal UTF-8 This is used when operating the parser in progressive (push) mode.

+
in:a buffered parser input
len:the size in bytes of the array.
buf:an char array
Returns:the number of chars read and stored in the buffer, or -1 in case of error.
Function: xmlOutputBufferCreateFilename
xmlOutputBufferPtr	xmlOutputBufferCreateFilename	(const char * URI, 
				 xmlCharEncodingHandlerPtr encoder, 
				 int compression)

+
Create a buffered output for the progressive saving of a file If filename is "-' then we use stdout as the output. Automatic support for ZLIB/Compress compressed document is provided by default if found at compile-time. TODO: currently if compression is set, the library only support writing to a local file.

+
URI:a C string containing the URI or filename
encoder:the encoding converter or NULL
compression:the compression ration (0 none, 9 max).
Returns:the new output or NULL
Function: xmlCleanupOutputCallbacks
void	xmlCleanupOutputCallbacks	(void)

+
clears the entire output callback table. this includes the compiled-in I/O callbacks.

 
+      Callback used in the I/O Input API to open the resource
+      
+      
+    
Function: xmlParserInputBufferRead
int	xmlParserInputBufferRead	(xmlParserInputBufferPtr in, 
				 int len)

+
Refresh the content of the input buffer, the old data are considered consumed This routine handle the I18N transcoding to internal UTF-8

+
in:a buffered parser input
len:indicative value of the amount of chars to read
Returns:the number of chars read and stored in the buffer, or -1 in case of error.
Function: xmlOutputBufferWriteString
int	xmlOutputBufferWriteString	(xmlOutputBufferPtr out, 
				 const char * str)

+
Write the content of the string in the output I/O buffer This routine handle the I18N transcoding from internal UTF-8 The buffer is lossless, i.e. will store in case of partial or delayed writes.

+
out:a buffered parser output
str:a zero terminated C string
Returns:the number of chars immediately written, or -1 in case of error.
Function: xmlFileMatch
int	xmlFileMatch	(const char * filename)

+
input from FILE *

+
filename:the URI for matching
Returns:1 if matches, 0 otherwise
Function: xmlFileRead
int	xmlFileRead	(void * context, 
				 char * buffer, 
				 int len)

+
Read @len bytes to @buffer from the I/O channel.

+
context:the I/O context
buffer:where to drop data
len:number of bytes to write
Returns:the number of bytes written
Function: xmlParserInputBufferCreateFile
xmlParserInputBufferPtr	xmlParserInputBufferCreateFile	(FILE * file, 
				 xmlCharEncoding enc)

+
Create a buffered parser input for the progressive parsing of a FILE * buffered C I/O

+
file:a FILE*
enc:the charset encoding if known
Returns:the new parser input or NULL
Function: xmlParserInputBufferCreateStatic
xmlParserInputBufferPtr	xmlParserInputBufferCreateStatic	(const char * mem, 
				 int size, 
				 xmlCharEncoding enc)

+
Create a buffered parser input for the progressive parsing for the input from an immutable memory area. This will not copy the memory area to the buffer, but the memory is expected to be available until the end of the parsing, this is useful for example when using mmap'ed file.

+
mem:the memory input
size:the length of the memory block
enc:the charset encoding if known
Returns:the new parser input or NULL
Function: xmlParserGetDirectory
char *	xmlParserGetDirectory	(const char * filename)

+
lookup the directory for that file

+
filename:the path to a file
Returns:a new allocated string containing the directory, or NULL.
Function: xmlOutputBufferWrite
int	xmlOutputBufferWrite	(xmlOutputBufferPtr out, 
				 int len, 
				 const char * buf)

+
Write the content of the array in the output I/O buffer This routine handle the I18N transcoding from internal UTF-8 The buffer is lossless, i.e. will store in case of partial or delayed writes.

+
out:a buffered parser output
len:the size in bytes of the array.
buf:an char array
Returns:the number of chars immediately written, or -1 in case of error.
Function: xmlCleanupInputCallbacks
void	xmlCleanupInputCallbacks	(void)

+
clears the entire input callback table. this includes the compiled-in I/O.

 
-
-int         (*xmlInputMatchCallback)        (char const *filename);
-void*       (*xmlInputOpenCallback)         (char const *filename);
-int         (*xmlInputReadCallback)         (void *context,
-                                             char *buffer,
-                                             int len);
-int         (*xmlInputCloseCallback)        (void *context);
-int         (*xmlOutputMatchCallback)       (char const *filename);
-void*       (*xmlOutputOpenCallback)        (char const *filename);
-int         (*xmlOutputWriteCallback)       (void *context,
-                                             const char *buffer,
-                                             int len);
-int         (*xmlOutputCloseCallback)       (void *context);
-struct      xmlParserInputBuffer;
-struct      xmlOutputBuffer;
-void        xmlCleanupInputCallbacks        (void);
-void        xmlRegisterDefaultInputCallbacks
-                                            (void);
-xmlParserInputBufferPtr xmlAllocParserInputBuffer
-                                            (xmlCharEncoding enc);
-xmlParserInputBufferPtr xmlParserInputBufferCreateFilename
-                                            (const char *URI,
-                                             xmlCharEncoding enc);
-xmlParserInputBufferPtr xmlParserInputBufferCreateFile
-                                            (FILE *file,
-                                             xmlCharEncoding enc);
-xmlParserInputBufferPtr xmlParserInputBufferCreateFd
-                                            (int fd,
-                                             xmlCharEncoding enc);
-xmlParserInputBufferPtr xmlParserInputBufferCreateMem
-                                            (const char *mem,
-                                             int size,
-                                             xmlCharEncoding enc);
-xmlParserInputBufferPtr xmlParserInputBufferCreateStatic
-                                            (const char *mem,
-                                             int size,
-                                             xmlCharEncoding enc);
-xmlParserInputBufferPtr xmlParserInputBufferCreateIO
-                                            (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             xmlCharEncoding enc);
-int         xmlParserInputBufferRead        (xmlParserInputBufferPtr in,
-                                             int len);
-int         xmlParserInputBufferGrow        (xmlParserInputBufferPtr in,
-                                             int len);
-int         xmlParserInputBufferPush        (xmlParserInputBufferPtr in,
-                                             int len,
-                                             const char *buf);
-void        xmlFreeParserInputBuffer        (xmlParserInputBufferPtr in);
-char*       xmlParserGetDirectory           (const char *filename);
-int         xmlRegisterInputCallbacks       (xmlInputMatchCallback matchFunc,
-                                             xmlInputOpenCallback openFunc,
-                                             xmlInputReadCallback readFunc,
-                                             xmlInputCloseCallback closeFunc);
-void        xmlCleanupOutputCallbacks       (void);
-void        xmlRegisterDefaultOutputCallbacks
-                                            (void);
-xmlOutputBufferPtr xmlAllocOutputBuffer     (xmlCharEncodingHandlerPtr encoder);
-xmlOutputBufferPtr xmlOutputBufferCreateFilename
-                                            (const char *URI,
-                                             xmlCharEncodingHandlerPtr encoder,
-                                             int compression);
-xmlOutputBufferPtr xmlOutputBufferCreateFile
-                                            (FILE *file,
-                                             xmlCharEncodingHandlerPtr encoder);
-xmlOutputBufferPtr xmlOutputBufferCreateFd  (int fd,
-                                             xmlCharEncodingHandlerPtr encoder);
-xmlOutputBufferPtr xmlOutputBufferCreateIO  (xmlOutputWriteCallback iowrite,
-                                             xmlOutputCloseCallback ioclose,
-                                             void *ioctx,
-                                             xmlCharEncodingHandlerPtr encoder);
-int         xmlOutputBufferWrite            (xmlOutputBufferPtr out,
-                                             int len,
-                                             const char *buf);
-int         xmlOutputBufferWriteString      (xmlOutputBufferPtr out,
-                                             const char *str);
-int         xmlOutputBufferFlush            (xmlOutputBufferPtr out);
-int         xmlOutputBufferClose            (xmlOutputBufferPtr out);
-int         xmlRegisterOutputCallbacks      (xmlOutputMatchCallback matchFunc,
-                                             xmlOutputOpenCallback openFunc,
-                                             xmlOutputWriteCallback writeFunc,
-                                             xmlOutputCloseCallback closeFunc);
-void*       xmlIOHTTPOpenW                  (const char *post_uri,
-                                             int compression);
-void        xmlRegisterHTTPPostCallbacks    (void);
-xmlParserInputPtr xmlCheckHTTPInput         (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr ret);
-xmlParserInputPtr xmlNoNetExternalEntityLoader
-                                            (const char *URL,
-                                             const char *ID,
-                                             xmlParserCtxtPtr ctxt);
-xmlChar*    xmlNormalizeWindowsPath         (const xmlChar *path);
-int         xmlCheckFilename                (const char *path);
-int         xmlFileMatch                    (const char *filename);
-void*       xmlFileOpen                     (const char *filename);
-int         xmlFileRead                     (void *context,
-                                             char *buffer,
-                                             int len);
-int         xmlFileClose                    (void *context);
-int         xmlIOHTTPMatch                  (const char *filename);
-void*       xmlIOHTTPOpen                   (const char *filename);
-int         xmlIOHTTPRead                   (void *context,
-                                             char *buffer,
-                                             int len);
-int         xmlIOHTTPClose                  (void *context);
-int         xmlIOFTPMatch                   (const char *filename);
-void*       xmlIOFTPOpen                    (const char *filename);
-int         xmlIOFTPRead                    (void *context,
-                                             char *buffer,
-                                             int len);
-int         xmlIOFTPClose                   (void *context);
-
Description

-
-
Details
xmlInputMatchCallback ()
int         (*xmlInputMatchCallback)        (char const *filename);

-Callback used in the I/O Input API to detect if the current handler 
-can provide input fonctionnalities for this resource.

-
-
filename: the filename or URI
-
Returns :1 if yes and 0 if another Input module should be used
-
xmlInputOpenCallback ()
void*       (*xmlInputOpenCallback)         (char const *filename);

-Callback used in the I/O Input API to open the resource

-
-
filename: the filename or URI
-
xmlInputReadCallback ()
int         (*xmlInputReadCallback)         (void *context,
-                                             char *buffer,
-                                             int len);

-Callback used in the I/O Input API to read the resource

-
-
context:  an Input context
-
buffer:  the buffer to store data read
-
len:  the length of the buffer in bytes
-
Returns :the number of bytes read or -1 in case of error
-
xmlInputCloseCallback ()
int         (*xmlInputCloseCallback)        (void *context);

-Callback used in the I/O Input API to close the resource

-
-
context:  an Input context
-
Returns :0 or -1 in case of error
-
xmlOutputMatchCallback ()
int         (*xmlOutputMatchCallback)       (char const *filename);

-Callback used in the I/O Output API to detect if the current handler 
-can provide output fonctionnalities for this resource.

-
-
filename: the filename or URI
-
Returns :1 if yes and 0 if another Output module should be used
-
xmlOutputOpenCallback ()
void*       (*xmlOutputOpenCallback)        (char const *filename);

-Callback used in the I/O Output API to open the resource

-
-
filename: the filename or URI
-
xmlOutputWriteCallback ()
int         (*xmlOutputWriteCallback)       (void *context,
-                                             const char *buffer,
-                                             int len);

-Callback used in the I/O Output API to write to the resource

-
-
context:  an Output context
-
buffer:  the buffer of data to write
-
len:  the length of the buffer in bytes
-
Returns :the number of bytes written or -1 in case of error
-
xmlOutputCloseCallback ()
int         (*xmlOutputCloseCallback)       (void *context);

-Callback used in the I/O Output API to close the resource

-
-
context:  an Output context
-
Returns :0 or -1 in case of error
-
struct xmlParserInputBuffer
struct xmlParserInputBuffer {
-
-    void*                  context;
-    xmlInputReadCallback   readcallback;
-    xmlInputCloseCallback  closecallback;
-    
-    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
-    
-    xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 */
-    xmlBufferPtr raw;       /* if encoder != NULL buffer for raw input */
-    int	compressed;	    /* -1=unknown, 0=not compressed, 1=compressed */
-    int error;
-};
-

-
-
struct xmlOutputBuffer
struct xmlOutputBuffer {
-
-    void*                   context;
-    xmlOutputWriteCallback  writecallback;
-    xmlOutputCloseCallback  closecallback;
-    
-    xmlCharEncodingHandlerPtr encoder; /* I18N conversions to UTF-8 */
-    
-    xmlBufferPtr buffer;    /* Local buffer encoded in UTF-8 or ISOLatin */
-    xmlBufferPtr conv;      /* if encoder != NULL buffer for output */
-    int written;            /* total number of byte written */
-    int error;
-};
-

-
-
xmlCleanupInputCallbacks ()
void        xmlCleanupInputCallbacks        (void);

-clears the entire input callback table. this includes the
-compiled-in I/O.

-
-
xmlRegisterDefaultInputCallbacks ()
void        xmlRegisterDefaultInputCallbacks
-                                            (void);

-Registers the default compiled-in I/O handlers.

-
-
xmlAllocParserInputBuffer ()
xmlParserInputBufferPtr xmlAllocParserInputBuffer
-                                            (xmlCharEncoding enc);

-Create a buffered parser input for progressive parsing

-
-
enc:  the charset encoding if known
-
Returns :the new parser input or NULL
-
xmlParserInputBufferCreateFilename ()
xmlParserInputBufferPtr xmlParserInputBufferCreateFilename
-                                            (const char *URI,
-                                             xmlCharEncoding enc);

-Create a buffered parser input for the progressive parsing of a file
-If filename is "-' then we use stdin as the input.
-Automatic support for ZLIB/Compress compressed document is provided
-by default if found at compile-time.
-Do an encoding check if enc == XML_CHAR_ENCODING_NONE

-
-
URI:  a C string containing the URI or filename
-
enc:  the charset encoding if known
-
Returns :the new parser input or NULL
-
xmlParserInputBufferCreateFile ()
xmlParserInputBufferPtr xmlParserInputBufferCreateFile
-                                            (FILE *file,
-                                             xmlCharEncoding enc);

-Create a buffered parser input for the progressive parsing of a FILE *
-buffered C I/O

-
-
file:  a FILE* 
-
enc:  the charset encoding if known
-
Returns :the new parser input or NULL
-
xmlParserInputBufferCreateFd ()
xmlParserInputBufferPtr xmlParserInputBufferCreateFd
-                                            (int fd,
-                                             xmlCharEncoding enc);

-Create a buffered parser input for the progressive parsing for the input
-from a file descriptor

-
-
fd:  a file descriptor number
-
enc:  the charset encoding if known
-
Returns :the new parser input or NULL
-
xmlParserInputBufferCreateMem ()
xmlParserInputBufferPtr xmlParserInputBufferCreateMem
-                                            (const char *mem,
-                                             int size,
-                                             xmlCharEncoding enc);

-Create a buffered parser input for the progressive parsing for the input
-from a memory area.

-
-
mem:  the memory input
-
size:  the length of the memory block
-
enc:  the charset encoding if known
-
Returns :the new parser input or NULL
-
xmlParserInputBufferCreateStatic ()
xmlParserInputBufferPtr xmlParserInputBufferCreateStatic
-                                            (const char *mem,
-                                             int size,
-                                             xmlCharEncoding enc);

-Create a buffered parser input for the progressive parsing for the input
-from an immutable memory area. This will not copy the memory area to
-the buffer, but the memory is expected to be available until the end of
-the parsing, this is useful for example when using mmap'ed file.

-
-
mem:  the memory input
-
size:  the length of the memory block
-
enc:  the charset encoding if known
-
Returns :the new parser input or NULL
-
xmlParserInputBufferCreateIO ()
xmlParserInputBufferPtr xmlParserInputBufferCreateIO
-                                            (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             xmlCharEncoding enc);

-Create a buffered parser input for the progressive parsing for the input
-from an I/O handler

-
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
enc:  the charset encoding if known
-
Returns :the new parser input or NULL
-
xmlParserInputBufferRead ()
int         xmlParserInputBufferRead        (xmlParserInputBufferPtr in,
-                                             int len);

-Refresh the content of the input buffer, the old data are considered
-consumed
-This routine handle the I18N transcoding to internal UTF-8

-
-
in:  a buffered parser input
-
len:  indicative value of the amount of chars to read
-
Returns :the number of chars read and stored in the buffer, or -1
-        in case of error.
-
xmlParserInputBufferGrow ()
int         xmlParserInputBufferGrow        (xmlParserInputBufferPtr in,
-                                             int len);

-Grow up the content of the input buffer, the old data are preserved
-This routine handle the I18N transcoding to internal UTF-8
-This routine is used when operating the parser in normal (pull) mode
-

-TODO: one should be able to remove one extra copy by copying directly
-      onto in->buffer or in->raw

-
-
in:  a buffered parser input
-
len:  indicative value of the amount of chars to read
-
Returns :the number of chars read and stored in the buffer, or -1
-        in case of error.
-
xmlParserInputBufferPush ()
int         xmlParserInputBufferPush        (xmlParserInputBufferPtr in,
-                                             int len,
-                                             const char *buf);

-Push the content of the arry in the input buffer
-This routine handle the I18N transcoding to internal UTF-8
-This is used when operating the parser in progressive (push) mode.

-
-
in:  a buffered parser input
-
len:  the size in bytes of the array.
-
buf:  an char array
-
Returns :the number of chars read and stored in the buffer, or -1
-        in case of error.
-
xmlFreeParserInputBuffer ()
void        xmlFreeParserInputBuffer        (xmlParserInputBufferPtr in);

-Free up the memory used by a buffered parser input

-
-
in:  a buffered parser input
-
xmlParserGetDirectory ()
char*       xmlParserGetDirectory           (const char *filename);

-lookup the directory for that file

-
-
filename:  the path to a file
-
Returns :a new allocated string containing the directory, or NULL.
-
xmlRegisterInputCallbacks ()
int         xmlRegisterInputCallbacks       (xmlInputMatchCallback matchFunc,
-                                             xmlInputOpenCallback openFunc,
-                                             xmlInputReadCallback readFunc,
-                                             xmlInputCloseCallback closeFunc);

-Register a new set of I/O callback for handling parser input.

-
-
matchFunc:  the xmlInputMatchCallback
-
openFunc:  the xmlInputOpenCallback
-
readFunc:  the xmlInputReadCallback
-
closeFunc:  the xmlInputCloseCallback
-
Returns :the registered handler number or -1 in case of error
-
xmlCleanupOutputCallbacks ()
void        xmlCleanupOutputCallbacks       (void);

-clears the entire output callback table. this includes the
-compiled-in I/O callbacks.

-
-
xmlRegisterDefaultOutputCallbacks ()
void        xmlRegisterDefaultOutputCallbacks
-                                            (void);

-Registers the default compiled-in I/O handlers.

-
-
xmlAllocOutputBuffer ()
xmlOutputBufferPtr xmlAllocOutputBuffer     (xmlCharEncodingHandlerPtr encoder);

-Create a buffered parser output

-
-
encoder:  the encoding converter or NULL
-
Returns :the new parser output or NULL
-
xmlOutputBufferCreateFilename ()
xmlOutputBufferPtr xmlOutputBufferCreateFilename
-                                            (const char *URI,
-                                             xmlCharEncodingHandlerPtr encoder,
-                                             int compression);

-Create a buffered  output for the progressive saving of a file
-If filename is "-' then we use stdout as the output.
-Automatic support for ZLIB/Compress compressed document is provided
-by default if found at compile-time.
-TODO: currently if compression is set, the library only support
-      writing to a local file.

-
-
URI:  a C string containing the URI or filename
-
encoder:  the encoding converter or NULL
-
compression:  the compression ration (0 none, 9 max).
-
Returns :the new output or NULL
-
xmlOutputBufferCreateFile ()
xmlOutputBufferPtr xmlOutputBufferCreateFile
-                                            (FILE *file,
-                                             xmlCharEncodingHandlerPtr encoder);

-Create a buffered output for the progressive saving to a FILE *
-buffered C I/O

-
-
file:  a FILE* 
-
encoder:  the encoding converter or NULL
-
Returns :the new parser output or NULL
-
xmlOutputBufferCreateFd ()
xmlOutputBufferPtr xmlOutputBufferCreateFd  (int fd,
-                                             xmlCharEncodingHandlerPtr encoder);

-Create a buffered output for the progressive saving 
-to a file descriptor

-
-
fd:  a file descriptor number
-
encoder:  the encoding converter or NULL
-
Returns :the new parser output or NULL
-
xmlOutputBufferCreateIO ()
xmlOutputBufferPtr xmlOutputBufferCreateIO  (xmlOutputWriteCallback iowrite,
-                                             xmlOutputCloseCallback ioclose,
-                                             void *ioctx,
-                                             xmlCharEncodingHandlerPtr encoder);

-Create a buffered output for the progressive saving
-to an I/O handler

-
-
iowrite:  an I/O write function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
encoder:  the charset encoding if known
-
Returns :the new parser output or NULL
-
xmlOutputBufferWrite ()
int         xmlOutputBufferWrite            (xmlOutputBufferPtr out,
-                                             int len,
-                                             const char *buf);

-Write the content of the array in the output I/O buffer
-This routine handle the I18N transcoding from internal UTF-8
-The buffer is lossless, i.e. will store in case of partial
-or delayed writes.

-
-
out:  a buffered parser output
-
len:  the size in bytes of the array.
-
buf:  an char array
-
Returns :the number of chars immediately written, or -1
-        in case of error.
-
xmlOutputBufferWriteString ()
int         xmlOutputBufferWriteString      (xmlOutputBufferPtr out,
-                                             const char *str);

-Write the content of the string in the output I/O buffer
-This routine handle the I18N transcoding from internal UTF-8
-The buffer is lossless, i.e. will store in case of partial
-or delayed writes.

-
-
out:  a buffered parser output
-
str:  a zero terminated C string
-
Returns :the number of chars immediately written, or -1
-        in case of error.
-
xmlOutputBufferFlush ()
int         xmlOutputBufferFlush            (xmlOutputBufferPtr out);

-flushes the output I/O channel

-
-
out:  a buffered output
-
Returns :the number of byte written or -1 in case of error.
-
xmlOutputBufferClose ()
int         xmlOutputBufferClose            (xmlOutputBufferPtr out);

-flushes and close the output I/O channel
-and free up all the associated resources

-
-
out:  a buffered output
-
Returns :the number of byte written or -1 in case of error.
-
xmlRegisterOutputCallbacks ()
int         xmlRegisterOutputCallbacks      (xmlOutputMatchCallback matchFunc,
-                                             xmlOutputOpenCallback openFunc,
-                                             xmlOutputWriteCallback writeFunc,
-                                             xmlOutputCloseCallback closeFunc);

-Register a new set of I/O callback for handling output.

-
-
matchFunc:  the xmlOutputMatchCallback
-
openFunc:  the xmlOutputOpenCallback
-
writeFunc:  the xmlOutputWriteCallback
-
closeFunc:  the xmlOutputCloseCallback
-
Returns :the registered handler number or -1 in case of error
-
xmlIOHTTPOpenW ()
void*       xmlIOHTTPOpenW                  (const char *post_uri,
-                                             int compression);

-Open a temporary buffer to collect the document for a subsequent HTTP POST
-request.  Non-static as is called from the output buffer creation routine.

-
-
post_uri:  The destination URI for the document
-
compression:  The compression desired for the document.
-
xmlRegisterHTTPPostCallbacks ()
void        xmlRegisterHTTPPostCallbacks    (void);

-By default, libxml submits HTTP output requests using the "PUT" method.
-Calling this method changes the HTTP output method to use the "POST"
-method instead.

-
-
xmlCheckHTTPInput ()
xmlParserInputPtr xmlCheckHTTPInput         (xmlParserCtxtPtr ctxt,
-                                             xmlParserInputPtr ret);

-Check an input in case it was created from an HTTP stream, in that
-case it will handle encoding and update of the base URL in case of
-redirection. It also checks for HTTP errors in which case the input
-is cleanly freed up and an appropriate error is raised in context

-
-
ctxt: an XML parser context
-
ret: an XML parser input
-
Returns :the input or NULL in case of HTTP error.
-
xmlNoNetExternalEntityLoader ()
xmlParserInputPtr xmlNoNetExternalEntityLoader
-                                            (const char *URL,
-                                             const char *ID,
-                                             xmlParserCtxtPtr ctxt);

-A specific entity loader disabling network accesses, though still
-allowing local catalog accesses for resolution.

-
-
URL:  the URL for the entity to load
-
ID:  the System ID for the entity to load
-
ctxt:  the context in which the entity is called or NULL
-
Returns :a new allocated xmlParserInputPtr, or NULL.
-
xmlNormalizeWindowsPath ()
xmlChar*    xmlNormalizeWindowsPath         (const xmlChar *path);

-This function is obsolete. Please see xmlURIFromPath in uri.c for
-a better solution.

-
-
path: the input file path
-
Returns :a canonicalized version of the path
-
xmlCheckFilename ()
int         xmlCheckFilename                (const char *path);

-function checks to see if path is a valid source
-(file, socket...) for XML.
-

-if stat is not available on the target machine,
-returns 1.  if stat fails, returns 0 (if calling
-stat on the filename fails, it can't be right).
-if stat succeeds and the file is a directory,

-
-
path:  the path to check
-
Returns :2.  otherwise returns 1.
-
xmlFileMatch ()
int         xmlFileMatch                    (const char *filename);

-input from FILE *

-
-
filename:  the URI for matching
-
Returns :1 if matches, 0 otherwise
-
xmlFileOpen ()
void*       xmlFileOpen                     (const char *filename);

-Wrapper around xmlFileOpen_real that try it with an unescaped
-version of filename, if this fails fallback to filename

-
-
filename:  the URI for matching
-
xmlFileRead ()
int         xmlFileRead                     (void *context,
-                                             char *buffer,
-                                             int len);

-Read len bytes to buffer from the I/O channel.

-
-
context:  the I/O context
-
buffer:  where to drop data
-
len:  number of bytes to write
-
Returns :the number of bytes written
-
xmlFileClose ()
int         xmlFileClose                    (void *context);

-Close an I/O channel

-
-
context:  the I/O context
-
Returns :0 or -1 in case of error
-
xmlIOHTTPMatch ()
int         xmlIOHTTPMatch                  (const char *filename);

-check if the URI matches an HTTP one

-
-
filename:  the URI for matching
-
Returns :1 if matches, 0 otherwise
-
xmlIOHTTPOpen ()
void*       xmlIOHTTPOpen                   (const char *filename);

-open an HTTP I/O channel

-
-
filename:  the URI for matching
-
xmlIOHTTPRead ()
int         xmlIOHTTPRead                   (void *context,
-                                             char *buffer,
-                                             int len);

-Read len bytes to buffer from the I/O channel.

-
-
context:  the I/O context
-
buffer:  where to drop data
-
len:  number of bytes to write
-
Returns :the number of bytes written
-
xmlIOHTTPClose ()
int         xmlIOHTTPClose                  (void *context);

-Close an HTTP I/O channel

-
-
context:  the I/O context
-
Returns :0
-
xmlIOFTPMatch ()
int         xmlIOFTPMatch                   (const char *filename);

-check if the URI matches an FTP one

-
-
filename:  the URI for matching
-
Returns :1 if matches, 0 otherwise
-
xmlIOFTPOpen ()
void*       xmlIOFTPOpen                    (const char *filename);

-open an FTP I/O channel

-
-
filename:  the URI for matching
-
xmlIOFTPRead ()
int         xmlIOFTPRead                    (void *context,
-                                             char *buffer,
-                                             int len);

-Read len bytes to buffer from the I/O channel.

-
-
context:  the I/O context
-
buffer:  where to drop data
-
len:  number of bytes to write
-
Returns :the number of bytes written
-
xmlIOFTPClose ()
int         xmlIOFTPClose                   (void *context);

-Close an FTP I/O channel

-
-
context:  the I/O context
-
Returns :0
-
<< xmlmemoryxpath >>

+      Callback used in the I/O Input API to close the resource
+      
+      
+    
Function: xmlIOHTTPOpenW
void *	xmlIOHTTPOpenW	(const char * post_uri, 
				 int compression)

+
Open a temporary buffer to collect the document for a subsequent HTTP POST request. Non-static as is called from the output buffer creation routine.

+
post_uri:The destination URI for the document
compression:The compression desired for the document.
Returns:an I/O context or NULL in case of error.
Function: xmlAllocParserInputBuffer
xmlParserInputBufferPtr	xmlAllocParserInputBuffer	(xmlCharEncoding enc)

+
Create a buffered parser input for progressive parsing

+
enc:the charset encoding if known
Returns:the new parser input or NULL
Daniel Veillard

diff --git a/doc/html/libxml-xmlautomata.html b/doc/html/libxml-xmlautomata.html
index 1bc8538a..d8c76774 100644
--- a/doc/html/libxml-xmlautomata.html
+++ b/doc/html/libxml-xmlautomata.html
@@ -1,283 +1,67 @@
-xmlautomata
PrevUpHomeGnome XML Library Reference ManualNext
xmlautomata
xmlautomata — 
Synopsis
+
+
+Module xmlautomata from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlautomata from libxml2
Main Menu
Related links
Table of Contents
void	xmlFreeAutomata	(xmlAutomataPtr am)

+
int	xmlAutomataNewCounter	(xmlAutomataPtr am, 
				 int min, 
				 int max)

+
xmlAutomataStatePtr	xmlAutomataGetInitState	(xmlAutomataPtr am)

+
xmlAutomataStatePtr	xmlAutomataNewTransition2	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 const xmlChar * token2, 
				 void * data)

+
Structure xmlAutomataState
struct _xmlAutomataState {
+The content of this structure is not made public by the API.
+}

xmlAutomataStatePtr	xmlAutomataNewState	(xmlAutomataPtr am)

+
Typedef xmlAutomata * xmlAutomataPtr
 
+
xmlAutomataStatePtr	xmlAutomataNewCountTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 int min, 
				 int max, 
				 void * data)

+
xmlAutomataStatePtr	xmlAutomataNewAllTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 int lax)

+
xmlAutomataStatePtr	xmlAutomataNewOnceTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 int min, 
				 int max, 
				 void * data)

+
xmlAutomataStatePtr	xmlAutomataNewCounterTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 int counter)

+
xmlRegexpPtr	xmlAutomataCompile	(xmlAutomataPtr am)

+
xmlAutomataPtr	xmlNewAutomata	(void)

+
xmlAutomataStatePtr	xmlAutomataNewEpsilon	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to)

+
Typedef xmlAutomataState * xmlAutomataStatePtr
 
-
-struct      xmlAutomata;
-typedef     xmlAutomataPtr;
-struct      xmlAutomataState;
-typedef     xmlAutomataStatePtr;
-xmlAutomataPtr xmlNewAutomata               (void);
-void        xmlFreeAutomata                 (xmlAutomataPtr am);
-xmlAutomataStatePtr xmlAutomataGetInitState (xmlAutomataPtr am);
-int         xmlAutomataSetFinalState        (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr state);
-xmlAutomataStatePtr xmlAutomataNewState     (xmlAutomataPtr am);
-xmlAutomataStatePtr xmlAutomataNewTransition
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             void *data);
-xmlAutomataStatePtr xmlAutomataNewTransition2
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             const xmlChar *token2,
-                                             void *data);
-xmlAutomataStatePtr xmlAutomataNewCountTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             int min,
-                                             int max,
-                                             void *data);
-xmlAutomataStatePtr xmlAutomataNewOnceTrans (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             int min,
-                                             int max,
-                                             void *data);
-xmlAutomataStatePtr xmlAutomataNewAllTrans  (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int lax);
-xmlAutomataStatePtr xmlAutomataNewEpsilon   (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to);
-xmlAutomataStatePtr xmlAutomataNewCountedTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int counter);
-xmlAutomataStatePtr xmlAutomataNewCounterTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int counter);
-int         xmlAutomataNewCounter           (xmlAutomataPtr am,
-                                             int min,
-                                             int max);
-xmlRegexpPtr xmlAutomataCompile             (xmlAutomataPtr am);
-int         xmlAutomataIsDeterminist        (xmlAutomataPtr am);
-
Description

-
-
Details
struct xmlAutomata
struct xmlAutomata;

-
-
xmlAutomataPtr
typedef xmlAutomata *xmlAutomataPtr;
-

-A libxml automata description, It can be compiled into a regexp

-
-
struct xmlAutomataState
struct xmlAutomataState;

-
-
xmlAutomataStatePtr
typedef xmlAutomataState *xmlAutomataStatePtr;
-

-A state int the automata description,

-
-
xmlNewAutomata ()
xmlAutomataPtr xmlNewAutomata               (void);

-Create a new automata

-
-
Returns :the new object or NULL in case of failure
-
xmlFreeAutomata ()
void        xmlFreeAutomata                 (xmlAutomataPtr am);

-Free an automata

-
-
am: an automata
-
xmlAutomataGetInitState ()
xmlAutomataStatePtr xmlAutomataGetInitState (xmlAutomataPtr am);

-Initial state lookup

-
-
am: an automata
-
Returns :the initial state of the automata
-
xmlAutomataSetFinalState ()
int         xmlAutomataSetFinalState        (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr state);

-Makes that state a final state

-
-
am: an automata
-
state: a state in this automata
-
Returns :0 or -1 in case of error
-
xmlAutomataNewState ()
xmlAutomataStatePtr xmlAutomataNewState     (xmlAutomataPtr am);

-Create a new disconnected state in the automata

-
-
am: an automata
-
Returns :the new state or NULL in case of error
-
xmlAutomataNewTransition ()
xmlAutomataStatePtr xmlAutomataNewTransition
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             void *data);

-If to is NULL, this create first a new target state in the automata
-and then adds a transition from the from state to the target state
-activated by the value of token

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
token: the input string associated to that transition
-
data: data passed to the callback function if the transition is activated
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewTransition2 ()
xmlAutomataStatePtr xmlAutomataNewTransition2
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             const xmlChar *token2,
-                                             void *data);

-If to is NULL, this create first a new target state in the automata
-and then adds a transition from the from state to the target state
-activated by the value of token

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
token: the first input string associated to that transition
-
token2: the second input string associated to that transition
-
data: data passed to the callback function if the transition is activated
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewCountTrans ()
xmlAutomataStatePtr xmlAutomataNewCountTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             int min,
-                                             int max,
-                                             void *data);

-If to is NULL, this create first a new target state in the automata
-and then adds a transition from the from state to the target state
-activated by a succession of input of value token and whose number
-is between min and max

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
token: the input string associated to that transition
-
min:  the minimum successive occurences of token
-
max:  the maximum successive occurences of token
-
data:  data associated to the transition
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewOnceTrans ()
xmlAutomataStatePtr xmlAutomataNewOnceTrans (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             const xmlChar *token,
-                                             int min,
-                                             int max,
-                                             void *data);

-If to is NULL, this create first a new target state in the automata
-and then adds a transition from the from state to the target state
-activated by a succession of input of value token and whose number
-is between min and max, moreover that transistion can only be crossed
-once.

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
token: the input string associated to that transition
-
min:  the minimum successive occurences of token
-
max:  the maximum successive occurences of token
-
data:  data associated to the transition
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewAllTrans ()
xmlAutomataStatePtr xmlAutomataNewAllTrans  (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int lax);

-If to is NULL, this create first a new target state in the automata
-and then adds a an ALL transition from the from state to the
-target state. That transition is an epsilon transition allowed only when
-all transitions from the from node have been activated.

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
lax: allow to transition if not all all transitions have been activated
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewEpsilon ()
xmlAutomataStatePtr xmlAutomataNewEpsilon   (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to);

-If to is NULL, this create first a new target state in the automata
-and then adds a an epsilon transition from the from state to the
-target state

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewCountedTrans ()
xmlAutomataStatePtr xmlAutomataNewCountedTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int counter);

-If to is NULL, this create first a new target state in the automata
-and then adds an epsilon transition from the from state to the target state
-which will increment the counter provided

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
counter: the counter associated to that transition
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewCounterTrans ()
xmlAutomataStatePtr xmlAutomataNewCounterTrans
-                                            (xmlAutomataPtr am,
-                                             xmlAutomataStatePtr from,
-                                             xmlAutomataStatePtr to,
-                                             int counter);

-If to is NULL, this create first a new target state in the automata
-and then adds an epsilon transition from the from state to the target state
-which will be allowed only if the counter is within the right range.

-
-
am: an automata
-
from: the starting point of the transition
-
to: the target point of the transition or NULL
-
counter: the counter associated to that transition
-
Returns :the target state or NULL in case of error
-
xmlAutomataNewCounter ()
int         xmlAutomataNewCounter           (xmlAutomataPtr am,
-                                             int min,
-                                             int max);

-Create a new counter

-
-
am: an automata
-
min:  the minimal value on the counter
-
max:  the maximal value on the counter
-
Returns :the counter number or -1 in case of error
-
xmlAutomataCompile ()
xmlRegexpPtr xmlAutomataCompile             (xmlAutomataPtr am);

-Compile the automata into a Reg Exp ready for being executed.
-The automata should be free after this point.

-
-
am: an automata
-
Returns :the compiled regexp or NULL in case of error
-
xmlAutomataIsDeterminist ()
int         xmlAutomataIsDeterminist        (xmlAutomataPtr am);

-Checks if an automata is determinist.

-
-
am: an automata
-
Returns :1 if true, 0 if not, and -1 in case of error
-
<< dictxmlschemastypes >>

+
int	xmlAutomataSetFinalState	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr state)

+
Structure xmlAutomata
struct _xmlAutomata {
+The content of this structure is not made public by the API.
+}

xmlAutomataStatePtr	xmlAutomataNewCountedTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 int counter)

+
xmlAutomataStatePtr	xmlAutomataNewTransition	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 void * data)

+
int	xmlAutomataIsDeterminist	(xmlAutomataPtr am)

+
Description

+
Function: xmlFreeAutomata
void	xmlFreeAutomata	(xmlAutomataPtr am)

+
Free an automata

+
am:an automata
Function: xmlAutomataNewCounter
int	xmlAutomataNewCounter	(xmlAutomataPtr am, 
				 int min, 
				 int max)

+
Create a new counter

+
am:an automata
min:the minimal value on the counter
max:the maximal value on the counter
Returns:the counter number or -1 in case of error
Function: xmlAutomataGetInitState
xmlAutomataStatePtr	xmlAutomataGetInitState	(xmlAutomataPtr am)

+
Initial state lookup

+
am:an automata
Returns:the initial state of the automata
Function: xmlAutomataNewTransition2
xmlAutomataStatePtr	xmlAutomataNewTransition2	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 const xmlChar * token2, 
				 void * data)

+
If @to is NULL, this create first a new target state in the automata and then adds a transition from the @from state to the target state activated by the value of @token

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
token:the first input string associated to that transition
token2:the second input string associated to that transition
data:data passed to the callback function if the transition is activated
Returns:the target state or NULL in case of error
Function: xmlAutomataNewState
xmlAutomataStatePtr	xmlAutomataNewState	(xmlAutomataPtr am)

+
Create a new disconnected state in the automata

+
am:an automata
Returns:the new state or NULL in case of error
Function: xmlAutomataNewCountTrans
xmlAutomataStatePtr	xmlAutomataNewCountTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 int min, 
				 int max, 
				 void * data)

+
If @to is NULL, this create first a new target state in the automata and then adds a transition from the @from state to the target state activated by a succession of input of value @token and whose number is between @min and @max

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
token:the input string associated to that transition
min:the minimum successive occurences of token
max:the maximum successive occurences of token
data:data associated to the transition
Returns:the target state or NULL in case of error
Function: xmlAutomataNewAllTrans
xmlAutomataStatePtr	xmlAutomataNewAllTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 int lax)

+
If @to is NULL, this create first a new target state in the automata and then adds a an ALL transition from the @from state to the target state. That transition is an epsilon transition allowed only when all transitions from the @from node have been activated.

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
lax:allow to transition if not all all transitions have been activated
Returns:the target state or NULL in case of error
Function: xmlAutomataNewOnceTrans
xmlAutomataStatePtr	xmlAutomataNewOnceTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 int min, 
				 int max, 
				 void * data)

+
If @to is NULL, this create first a new target state in the automata and then adds a transition from the @from state to the target state activated by a succession of input of value @token and whose number is between @min and @max, moreover that transistion can only be crossed once.

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
token:the input string associated to that transition
min:the minimum successive occurences of token
max:the maximum successive occurences of token
data:data associated to the transition
Returns:the target state or NULL in case of error
Function: xmlAutomataNewCounterTrans
xmlAutomataStatePtr	xmlAutomataNewCounterTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 int counter)

+
If @to is NULL, this create first a new target state in the automata and then adds an epsilon transition from the @from state to the target state which will be allowed only if the counter is within the right range.

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
counter:the counter associated to that transition
Returns:the target state or NULL in case of error
Function: xmlAutomataCompile
xmlRegexpPtr	xmlAutomataCompile	(xmlAutomataPtr am)

+
Compile the automata into a Reg Exp ready for being executed. The automata should be free after this point.

+
am:an automata
Returns:the compiled regexp or NULL in case of error
Function: xmlNewAutomata
xmlAutomataPtr	xmlNewAutomata	(void)

+
Create a new automata

+
Returns:the new object or NULL in case of failure
Function: xmlAutomataNewEpsilon
xmlAutomataStatePtr	xmlAutomataNewEpsilon	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to)

+
If @to is NULL, this create first a new target state in the automata and then adds a an epsilon transition from the @from state to the target state

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
Returns:the target state or NULL in case of error
Function: xmlAutomataSetFinalState
int	xmlAutomataSetFinalState	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr state)

+
Makes that state a final state

+
am:an automata
state:a state in this automata
Returns:0 or -1 in case of error
Function: xmlAutomataNewCountedTrans
xmlAutomataStatePtr	xmlAutomataNewCountedTrans	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 int counter)

+
If @to is NULL, this create first a new target state in the automata and then adds an epsilon transition from the @from state to the target state which will increment the counter provided

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
counter:the counter associated to that transition
Returns:the target state or NULL in case of error
Function: xmlAutomataNewTransition
xmlAutomataStatePtr	xmlAutomataNewTransition	(xmlAutomataPtr am, 
				 xmlAutomataStatePtr from, 
				 xmlAutomataStatePtr to, 
				 const xmlChar * token, 
				 void * data)

+
If @to is NULL, this create first a new target state in the automata and then adds a transition from the @from state to the target state activated by the value of @token

+
am:an automata
from:the starting point of the transition
to:the target point of the transition or NULL
token:the input string associated to that transition
data:data passed to the callback function if the transition is activated
Returns:the target state or NULL in case of error
Function: xmlAutomataIsDeterminist
int	xmlAutomataIsDeterminist	(xmlAutomataPtr am)

+
Checks if an automata is determinist.

+
am:an automata
Returns:1 if true, 0 if not, and -1 in case of error
Daniel Veillard

diff --git a/doc/html/libxml-xmlerror.html b/doc/html/libxml-xmlerror.html
index f101c56f..2d18dbca 100644
--- a/doc/html/libxml-xmlerror.html
+++ b/doc/html/libxml-xmlerror.html
@@ -1,737 +1,622 @@
-xmlerror
PrevUpHomeGnome XML Library Reference ManualNext
xmlerror
xmlerror — 
Synopsis
+
+
+Module xmlerror from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlerror from libxml2
Main Menu
Related links
Table of Contents
void	xmlParserWarning	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
Enum xmlErrorDomain {
+    XML_FROM_NONE = 0
+    XML_FROM_PARSER = 1 : The XML parser
+    XML_FROM_TREE = 2 : The tree module
+    XML_FROM_NAMESPACE = 3 : The XML Namespace module
+    XML_FROM_DTD = 4 : The XML DTD validation with parser contex
+    XML_FROM_HTML = 5 : The HTML parser
+    XML_FROM_MEMORY = 6 : The memory allocator
+    XML_FROM_OUTPUT = 7 : The serialization code
+    XML_FROM_IO = 8 : The Input/Output stack
+    XML_FROM_FTP = 9 : The FTP module
+    XML_FROM_HTTP = 10 : The FTP module
+    XML_FROM_XINCLUDE = 11 : The XInclude processing
+    XML_FROM_XPATH = 12 : The XPath module
+    XML_FROM_XPOINTER = 13 : The XPointer module
+    XML_FROM_REGEXP = 14 : The regular expressions module
+    XML_FROM_DATATYPE = 15 : The W3C XML Schemas Datatype module
+    XML_FROM_SCHEMASP = 16 : The W3C XML Schemas parser module
+    XML_FROM_SCHEMASV = 17 : The W3C XML Schemas validation module
+    XML_FROM_RELAXNGP = 18 : The Relax-NG parser module
+    XML_FROM_RELAXNGV = 19 : The Relax-NG validator module
+    XML_FROM_CATALOG = 20 : The Catalog module
+    XML_FROM_C14N = 21 : The Canonicalization module
+    XML_FROM_XSLT = 22 : The XSLT engine from libxslt
+    XML_FROM_VALID = 23 : The XML DTD validation with valid context
+}
 
+
Function type: xmlStructuredErrorFunc
+void	xmlStructuredErrorFunc	(void * userData, 
				 xmlErrorPtr error)
+
Signature of the function to use when there is an error and the module handles the new error reporting mechanism.
userData:user provided data for the error callback
error:the error being raised.


+
void	xmlParserValidityError	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
void	xmlParserValidityWarning	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
void	xmlSetGenericErrorFunc	(void * ctx, 
				 xmlGenericErrorFunc handler)

+
void	xmlParserPrintFileContext	(xmlParserInputPtr input)

+
Structure xmlError
struct _xmlError {
+    int	domain	: What part of the library raised this error
+    int	code	: The error code, e.g. an xmlParserError
+    char *	message	: human-readable informative error message
+    xmlErrorLevel	level	: how consequent is the error
+    char *	file	: the filename
+    int	line	: the line number if available
+    char *	str1	: extra string information
+    char *	str2	: extra string information
+    char *	str3	: extra string information
+    int	int1	: extra number information
+    int	int2	: extra number information
+    void *	ctxt	: the parser context if available
+    void *	node	: the node in the tree
+}

void	initGenericErrorDefaultFunc	(xmlGenericErrorFunc * handler)

+
Enum xmlErrorLevel {
+    XML_ERR_NONE = 0
+    XML_ERR_WARNING = 1 : A simple warning
+    XML_ERR_ERROR = 2 : A recoverable error
+    XML_ERR_FATAL = 3 : A fatal error
+}
 
+
void	xmlParserPrintFileInfo	(xmlParserInputPtr input)

+
Enum xmlParserErrors {
+    XML_ERR_OK = 0
+    XML_ERR_INTERNAL_ERROR = 1 : 1
+    XML_ERR_NO_MEMORY = 2 : 2
+    XML_ERR_DOCUMENT_START = 3 : 3
+    XML_ERR_DOCUMENT_EMPTY = 4 : 4
+    XML_ERR_DOCUMENT_END = 5 : 5
+    XML_ERR_INVALID_HEX_CHARREF = 6 : 6
+    XML_ERR_INVALID_DEC_CHARREF = 7 : 7
+    XML_ERR_INVALID_CHARREF = 8 : 8
+    XML_ERR_INVALID_CHAR = 9 : 9
+    XML_ERR_CHARREF_AT_EOF = 10 : 10
+    XML_ERR_CHARREF_IN_PROLOG = 11 : 11
+    XML_ERR_CHARREF_IN_EPILOG = 12 : 12
+    XML_ERR_CHARREF_IN_DTD = 13 : 13
+    XML_ERR_ENTITYREF_AT_EOF = 14 : 14
+    XML_ERR_ENTITYREF_IN_PROLOG = 15 : 15
+    XML_ERR_ENTITYREF_IN_EPILOG = 16 : 16
+    XML_ERR_ENTITYREF_IN_DTD = 17 : 17
+    XML_ERR_PEREF_AT_EOF = 18 : 18
+    XML_ERR_PEREF_IN_PROLOG = 19 : 19
+    XML_ERR_PEREF_IN_EPILOG = 20 : 20
+    XML_ERR_PEREF_IN_INT_SUBSET = 21 : 21
+    XML_ERR_ENTITYREF_NO_NAME = 22 : 22
+    XML_ERR_ENTITYREF_SEMICOL_MISSING = 23 : 23
+    XML_ERR_PEREF_NO_NAME = 24 : 24
+    XML_ERR_PEREF_SEMICOL_MISSING = 25 : 25
+    XML_ERR_UNDECLARED_ENTITY = 26 : 26
+    XML_WAR_UNDECLARED_ENTITY = 27 : 27
+    XML_ERR_UNPARSED_ENTITY = 28 : 28
+    XML_ERR_ENTITY_IS_EXTERNAL = 29 : 29
+    XML_ERR_ENTITY_IS_PARAMETER = 30 : 30
+    XML_ERR_UNKNOWN_ENCODING = 31 : 31
+    XML_ERR_UNSUPPORTED_ENCODING = 32 : 32
+    XML_ERR_STRING_NOT_STARTED = 33 : 33
+    XML_ERR_STRING_NOT_CLOSED = 34 : 34
+    XML_ERR_NS_DECL_ERROR = 35 : 35
+    XML_ERR_ENTITY_NOT_STARTED = 36 : 36
+    XML_ERR_ENTITY_NOT_FINISHED = 37 : 37
+    XML_ERR_LT_IN_ATTRIBUTE = 38 : 38
+    XML_ERR_ATTRIBUTE_NOT_STARTED = 39 : 39
+    XML_ERR_ATTRIBUTE_NOT_FINISHED = 40 : 40
+    XML_ERR_ATTRIBUTE_WITHOUT_VALUE = 41 : 41
+    XML_ERR_ATTRIBUTE_REDEFINED = 42 : 42
+    XML_ERR_LITERAL_NOT_STARTED = 43 : 43
+    XML_ERR_LITERAL_NOT_FINISHED = 44 : 44
+    XML_ERR_COMMENT_NOT_FINISHED = 45 : 45
+    XML_ERR_PI_NOT_STARTED = 46 : 46
+    XML_ERR_PI_NOT_FINISHED = 47 : 47
+    XML_ERR_NOTATION_NOT_STARTED = 48 : 48
+    XML_ERR_NOTATION_NOT_FINISHED = 49 : 49
+    XML_ERR_ATTLIST_NOT_STARTED = 50 : 50
+    XML_ERR_ATTLIST_NOT_FINISHED = 51 : 51
+    XML_ERR_MIXED_NOT_STARTED = 52 : 52
+    XML_ERR_MIXED_NOT_FINISHED = 53 : 53
+    XML_ERR_ELEMCONTENT_NOT_STARTED = 54 : 54
+    XML_ERR_ELEMCONTENT_NOT_FINISHED = 55 : 55
+    XML_ERR_XMLDECL_NOT_STARTED = 56 : 56
+    XML_ERR_XMLDECL_NOT_FINISHED = 57 : 57
+    XML_ERR_CONDSEC_NOT_STARTED = 58 : 58
+    XML_ERR_CONDSEC_NOT_FINISHED = 59 : 59
+    XML_ERR_EXT_SUBSET_NOT_FINISHED = 60 : 60
+    XML_ERR_DOCTYPE_NOT_FINISHED = 61 : 61
+    XML_ERR_MISPLACED_CDATA_END = 62 : 62
+    XML_ERR_CDATA_NOT_FINISHED = 63 : 63
+    XML_ERR_RESERVED_XML_NAME = 64 : 64
+    XML_ERR_SPACE_REQUIRED = 65 : 65
+    XML_ERR_SEPARATOR_REQUIRED = 66 : 66
+    XML_ERR_NMTOKEN_REQUIRED = 67 : 67
+    XML_ERR_NAME_REQUIRED = 68 : 68
+    XML_ERR_PCDATA_REQUIRED = 69 : 69
+    XML_ERR_URI_REQUIRED = 70 : 70
+    XML_ERR_PUBID_REQUIRED = 71 : 71
+    XML_ERR_LT_REQUIRED = 72 : 72
+    XML_ERR_GT_REQUIRED = 73 : 73
+    XML_ERR_LTSLASH_REQUIRED = 74 : 74
+    XML_ERR_EQUAL_REQUIRED = 75 : 75
+    XML_ERR_TAG_NAME_MISMATCH = 76 : 76
+    XML_ERR_TAG_NOT_FINISHED = 77 : 77
+    XML_ERR_STANDALONE_VALUE = 78 : 78
+    XML_ERR_ENCODING_NAME = 79 : 79
+    XML_ERR_HYPHEN_IN_COMMENT = 80 : 80
+    XML_ERR_INVALID_ENCODING = 81 : 81
+    XML_ERR_EXT_ENTITY_STANDALONE = 82 : 82
+    XML_ERR_CONDSEC_INVALID = 83 : 83
+    XML_ERR_VALUE_REQUIRED = 84 : 84
+    XML_ERR_NOT_WELL_BALANCED = 85 : 85
+    XML_ERR_EXTRA_CONTENT = 86 : 86
+    XML_ERR_ENTITY_CHAR_ERROR = 87 : 87
+    XML_ERR_ENTITY_PE_INTERNAL = 88 : 88
+    XML_ERR_ENTITY_LOOP = 89 : 89
+    XML_ERR_ENTITY_BOUNDARY = 90 : 90
+    XML_ERR_INVALID_URI = 91 : 91
+    XML_ERR_URI_FRAGMENT = 92 : 92
+    XML_WAR_CATALOG_PI = 93 : 93
+    XML_ERR_NO_DTD = 94 : 94
+    XML_ERR_CONDSEC_INVALID_KEYWORD = 95 : 95
+    XML_ERR_VERSION_MISSING = 96 : 96
+    XML_WAR_UNKNOWN_VERSION = 97 : 97
+    XML_WAR_LANG_VALUE = 98 : 98
+    XML_WAR_NS_URI = 99 : 99
+    XML_WAR_NS_URI_RELATIVE = 100 : 100
+    XML_ERR_MISSING_ENCODING = 101 : 101
+    XML_NS_ERR_XML_NAMESPACE = 200
+    XML_NS_ERR_UNDEFINED_NAMESPACE = 201 : 201
+    XML_NS_ERR_QNAME = 202 : 202
+    XML_NS_ERR_ATTRIBUTE_REDEFINED = 203 : 203
+    XML_DTD_ATTRIBUTE_DEFAULT = 500
+    XML_DTD_ATTRIBUTE_REDEFINED = 501 : 501
+    XML_DTD_ATTRIBUTE_VALUE = 502 : 502
+    XML_DTD_CONTENT_ERROR = 503 : 503
+    XML_DTD_CONTENT_MODEL = 504 : 504
+    XML_DTD_CONTENT_NOT_DETERMINIST = 505 : 505
+    XML_DTD_DIFFERENT_PREFIX = 506 : 506
+    XML_DTD_ELEM_DEFAULT_NAMESPACE = 507 : 507
+    XML_DTD_ELEM_NAMESPACE = 508 : 508
+    XML_DTD_ELEM_REDEFINED = 509 : 509
+    XML_DTD_EMPTY_NOTATION = 510 : 510
+    XML_DTD_ENTITY_TYPE = 511 : 511
+    XML_DTD_ID_FIXED = 512 : 512
+    XML_DTD_ID_REDEFINED = 513 : 513
+    XML_DTD_ID_SUBSET = 514 : 514
+    XML_DTD_INVALID_CHILD = 515 : 515
+    XML_DTD_INVALID_DEFAULT = 516 : 516
+    XML_DTD_LOAD_ERROR = 517 : 517
+    XML_DTD_MISSING_ATTRIBUTE = 518 : 518
+    XML_DTD_MIXED_CORRUPT = 519 : 519
+    XML_DTD_MULTIPLE_ID = 520 : 520
+    XML_DTD_NO_DOC = 521 : 521
+    XML_DTD_NO_DTD = 522 : 522
+    XML_DTD_NO_ELEM_NAME = 523 : 523
+    XML_DTD_NO_PREFIX = 524 : 524
+    XML_DTD_NO_ROOT = 525 : 525
+    XML_DTD_NOTATION_REDEFINED = 526 : 526
+    XML_DTD_NOTATION_VALUE = 527 : 527
+    XML_DTD_NOT_EMPTY = 528 : 528
+    XML_DTD_NOT_PCDATA = 529 : 529
+    XML_DTD_NOT_STANDALONE = 530 : 530
+    XML_DTD_ROOT_NAME = 531 : 531
+    XML_DTD_STANDALONE_WHITE_SPACE = 532 : 532
+    XML_DTD_UNKNOWN_ATTRIBUTE = 533 : 533
+    XML_DTD_UNKNOWN_ELEM = 534 : 534
+    XML_DTD_UNKNOWN_ENTITY = 535 : 535
+    XML_DTD_UNKNOWN_ID = 536 : 536
+    XML_DTD_UNKNOWN_NOTATION = 537 : 537
+    XML_HTML_STRUCURE_ERROR = 800
+    XML_HTML_UNKNOWN_TAG = 801 : 801
+    XML_RNGP_ANYNAME_ATTR_ANCESTOR = 1000
+    XML_RNGP_ATTR_CONFLICT = 1001 : 1001
+    XML_RNGP_ATTRIBUTE_CHILDREN = 1002 : 1002
+    XML_RNGP_ATTRIBUTE_CONTENT = 1003 : 1003
+    XML_RNGP_ATTRIBUTE_EMPTY = 1004 : 1004
+    XML_RNGP_ATTRIBUTE_NOOP = 1005 : 1005
+    XML_RNGP_CHOICE_CONTENT = 1006 : 1006
+    XML_RNGP_CHOICE_EMPTY = 1007 : 1007
+    XML_RNGP_CREATE_FAILURE = 1008 : 1008
+    XML_RNGP_DATA_CONTENT = 1009 : 1009
+    XML_RNGP_DEF_CHOICE_AND_INTERLEAVE = 1010 : 1010
+    XML_RNGP_DEFINE_CREATE_FAILED = 1011 : 1011
+    XML_RNGP_DEFINE_EMPTY = 1012 : 1012
+    XML_RNGP_DEFINE_MISSING = 1013 : 1013
+    XML_RNGP_DEFINE_NAME_MISSING = 1014 : 1014
+    XML_RNGP_ELEM_CONTENT_EMPTY = 1015 : 1015
+    XML_RNGP_ELEM_CONTENT_ERROR = 1016 : 1016
+    XML_RNGP_ELEMENT_EMPTY = 1017 : 1017
+    XML_RNGP_ELEMENT_CONTENT = 1018 : 1018
+    XML_RNGP_ELEMENT_NAME = 1019 : 1019
+    XML_RNGP_ELEMENT_NO_CONTENT = 1020 : 1020
+    XML_RNGP_ELEM_TEXT_CONFLICT = 1021 : 1021
+    XML_RNGP_EMPTY = 1022 : 1022
+    XML_RNGP_EMPTY_CONSTRUCT = 1023 : 1023
+    XML_RNGP_EMPTY_CONTENT = 1024 : 1024
+    XML_RNGP_EMPTY_NOT_EMPTY = 1025 : 1025
+    XML_RNGP_ERROR_TYPE_LIB = 1026 : 1026
+    XML_RNGP_EXCEPT_EMPTY = 1027 : 1027
+    XML_RNGP_EXCEPT_MISSING = 1028 : 1028
+    XML_RNGP_EXCEPT_MULTIPLE = 1029 : 1029
+    XML_RNGP_EXCEPT_NO_CONTENT = 1030 : 1030
+    XML_RNGP_EXTERNALREF_EMTPY = 1031 : 1031
+    XML_RNGP_EXTERNAL_REF_FAILURE = 1032 : 1032
+    XML_RNGP_EXTERNALREF_RECURSE = 1033 : 1033
+    XML_RNGP_FORBIDDEN_ATTRIBUTE = 1034 : 1034
+    XML_RNGP_FOREIGN_ELEMENT = 1035 : 1035
+    XML_RNGP_GRAMMAR_CONTENT = 1036 : 1036
+    XML_RNGP_GRAMMAR_EMPTY = 1037 : 1037
+    XML_RNGP_GRAMMAR_MISSING = 1038 : 1038
+    XML_RNGP_GRAMMAR_NO_START = 1039 : 1039
+    XML_RNGP_GROUP_ATTR_CONFLICT = 1040 : 1040
+    XML_RNGP_HREF_ERROR = 1041 : 1041
+    XML_RNGP_INCLUDE_EMPTY = 1042 : 1042
+    XML_RNGP_INCLUDE_FAILURE = 1043 : 1043
+    XML_RNGP_INCLUDE_RECURSE = 1044 : 1044
+    XML_RNGP_INTERLEAVE_ADD = 1045 : 1045
+    XML_RNGP_INTERLEAVE_CREATE_FAILED = 1046 : 1046
+    XML_RNGP_INTERLEAVE_EMPTY = 1047 : 1047
+    XML_RNGP_INTERLEAVE_NO_CONTENT = 1048 : 1048
+    XML_RNGP_INVALID_DEFINE_NAME = 1049 : 1049
+    XML_RNGP_INVALID_URI = 1050 : 1050
+    XML_RNGP_INVALID_VALUE = 1051 : 1051
+    XML_RNGP_MISSING_HREF = 1052 : 1052
+    XML_RNGP_NAME_MISSING = 1053 : 1053
+    XML_RNGP_NEED_COMBINE = 1054 : 1054
+    XML_RNGP_NOTALLOWED_NOT_EMPTY = 1055 : 1055
+    XML_RNGP_NSNAME_ATTR_ANCESTOR = 1056 : 1056
+    XML_RNGP_NSNAME_NO_NS = 1057 : 1057
+    XML_RNGP_PARAM_FORBIDDEN = 1058 : 1058
+    XML_RNGP_PARAM_NAME_MISSING = 1059 : 1059
+    XML_RNGP_PARENTREF_CREATE_FAILED = 1060 : 1060
+    XML_RNGP_PARENTREF_NAME_INVALID = 1061 : 1061
+    XML_RNGP_PARENTREF_NO_NAME = 1062 : 1062
+    XML_RNGP_PARENTREF_NO_PARENT = 1063 : 1063
+    XML_RNGP_PARENTREF_NOT_EMPTY = 1064 : 1064
+    XML_RNGP_PARSE_ERROR = 1065 : 1065
+    XML_RNGP_PAT_ANYNAME_EXCEPT_ANYNAME = 1066 : 1066
+    XML_RNGP_PAT_ATTR_ATTR = 1067 : 1067
+    XML_RNGP_PAT_ATTR_ELEM = 1068 : 1068
+    XML_RNGP_PAT_DATA_EXCEPT_ATTR = 1069 : 1069
+    XML_RNGP_PAT_DATA_EXCEPT_ELEM = 1070 : 1070
+    XML_RNGP_PAT_DATA_EXCEPT_EMPTY = 1071 : 1071
+    XML_RNGP_PAT_DATA_EXCEPT_GROUP = 1072 : 1072
+    XML_RNGP_PAT_DATA_EXCEPT_INTERLEAVE = 1073 : 1073
+    XML_RNGP_PAT_DATA_EXCEPT_LIST = 1074 : 1074
+    XML_RNGP_PAT_DATA_EXCEPT_ONEMORE = 1075 : 1075
+    XML_RNGP_PAT_DATA_EXCEPT_REF = 1076 : 1076
+    XML_RNGP_PAT_DATA_EXCEPT_TEXT = 1077 : 1077
+    XML_RNGP_PAT_LIST_ATTR = 1078 : 1078
+    XML_RNGP_PAT_LIST_ELEM = 1079 : 1079
+    XML_RNGP_PAT_LIST_INTERLEAVE = 1080 : 1080
+    XML_RNGP_PAT_LIST_LIST = 1081 : 1081
+    XML_RNGP_PAT_LIST_REF = 1082 : 1082
+    XML_RNGP_PAT_LIST_TEXT = 1083 : 1083
+    XML_RNGP_PAT_NSNAME_EXCEPT_ANYNAME = 1084 : 1084
+    XML_RNGP_PAT_NSNAME_EXCEPT_NSNAME = 1085 : 1085
+    XML_RNGP_PAT_ONEMORE_GROUP_ATTR = 1086 : 1086
+    XML_RNGP_PAT_ONEMORE_INTERLEAVE_ATTR = 1087 : 1087
+    XML_RNGP_PAT_START_ATTR = 1088 : 1088
+    XML_RNGP_PAT_START_DATA = 1089 : 1089
+    XML_RNGP_PAT_START_EMPTY = 1090 : 1090
+    XML_RNGP_PAT_START_GROUP = 1091 : 1091
+    XML_RNGP_PAT_START_INTERLEAVE = 1092 : 1092
+    XML_RNGP_PAT_START_LIST = 1093 : 1093
+    XML_RNGP_PAT_START_ONEMORE = 1094 : 1094
+    XML_RNGP_PAT_START_TEXT = 1095 : 1095
+    XML_RNGP_PAT_START_VALUE = 1096 : 1096
+    XML_RNGP_PREFIX_UNDEFINED = 1097 : 1097
+    XML_RNGP_REF_CREATE_FAILED = 1098 : 1098
+    XML_RNGP_REF_CYCLE = 1099 : 1099
+    XML_RNGP_REF_NAME_INVALID = 1100 : 1100
+    XML_RNGP_REF_NO_DEF = 1101 : 1101
+    XML_RNGP_REF_NO_NAME = 1102 : 1102
+    XML_RNGP_REF_NOT_EMPTY = 1103 : 1103
+    XML_RNGP_START_CHOICE_AND_INTERLEAVE = 1104 : 1104
+    XML_RNGP_START_CONTENT = 1105 : 1105
+    XML_RNGP_START_EMPTY = 1106 : 1106
+    XML_RNGP_START_MISSING = 1107 : 1107
+    XML_RNGP_TEXT_EXPECTED = 1108 : 1108
+    XML_RNGP_TEXT_HAS_CHILD = 1109 : 1109
+    XML_RNGP_TYPE_MISSING = 1110 : 1110
+    XML_RNGP_TYPE_NOT_FOUND = 1111 : 1111
+    XML_RNGP_TYPE_VALUE = 1112 : 1112
+    XML_RNGP_UNKNOWN_ATTRIBUTE = 1113 : 1113
+    XML_RNGP_UNKNOWN_COMBINE = 1114 : 1114
+    XML_RNGP_UNKNOWN_CONSTRUCT = 1115 : 1115
+    XML_RNGP_UNKNOWN_TYPE_LIB = 1116 : 1116
+    XML_RNGP_URI_FRAGMENT = 1117 : 1117
+    XML_RNGP_URI_NOT_ABSOLUTE = 1118 : 1118
+    XML_RNGP_VALUE_EMPTY = 1119 : 1119
+    XML_RNGP_VALUE_NO_CONTENT = 1120 : 1120
+    XML_RNGP_XMLNS_NAME = 1121 : 1121
+    XML_RNGP_XML_NS = 1122 : 1122
+    XML_XPATH_EXPRESSION_OK = 1200
+    XML_XPATH_NUMBER_ERROR = 1201 : 1201
+    XML_XPATH_UNFINISHED_LITERAL_ERROR = 1202 : 1202
+    XML_XPATH_START_LITERAL_ERROR = 1203 : 1203
+    XML_XPATH_VARIABLE_REF_ERROR = 1204 : 1204
+    XML_XPATH_UNDEF_VARIABLE_ERROR = 1205 : 1205
+    XML_XPATH_INVALID_PREDICATE_ERROR = 1206 : 1206
+    XML_XPATH_EXPR_ERROR = 1207 : 1207
+    XML_XPATH_UNCLOSED_ERROR = 1208 : 1208
+    XML_XPATH_UNKNOWN_FUNC_ERROR = 1209 : 1209
+    XML_XPATH_INVALID_OPERAND = 1210 : 1210
+    XML_XPATH_INVALID_TYPE = 1211 : 1211
+    XML_XPATH_INVALID_ARITY = 1212 : 1212
+    XML_XPATH_INVALID_CTXT_SIZE = 1213 : 1213
+    XML_XPATH_INVALID_CTXT_POSITION = 1214 : 1214
+    XML_XPATH_MEMORY_ERROR = 1215 : 1215
+    XML_XPTR_SYNTAX_ERROR = 1216 : 1216
+    XML_XPTR_RESOURCE_ERROR = 1217 : 1217
+    XML_XPTR_SUB_RESOURCE_ERROR = 1218 : 1218
+    XML_XPATH_UNDEF_PREFIX_ERROR = 1219 : 1219
+    XML_XPATH_ENCODING_ERROR = 1220 : 1220
+    XML_XPATH_INVALID_CHAR_ERROR = 1221 : 1221
+    XML_TREE_INVALID_HEX = 1300
+    XML_TREE_INVALID_DEC = 1301 : 1301
+    XML_TREE_UNTERMINATED_ENTITY = 1302 : 1302
+    XML_SAVE_NOT_UTF8 = 1400
+    XML_SAVE_CHAR_INVALID = 1401 : 1401
+    XML_SAVE_NO_DOCTYPE = 1402 : 1402
+    XML_SAVE_UNKNOWN_ENCODING = 1403 : 1403
+    XML_REGEXP_COMPILE_ERROR = 1450
+    XML_IO_UNKNOWN = 1500
+    XML_IO_EACCES = 1501 : 1501
+    XML_IO_EAGAIN = 1502 : 1502
+    XML_IO_EBADF = 1503 : 1503
+    XML_IO_EBADMSG = 1504 : 1504
+    XML_IO_EBUSY = 1505 : 1505
+    XML_IO_ECANCELED = 1506 : 1506
+    XML_IO_ECHILD = 1507 : 1507
+    XML_IO_EDEADLK = 1508 : 1508
+    XML_IO_EDOM = 1509 : 1509
+    XML_IO_EEXIST = 1510 : 1510
+    XML_IO_EFAULT = 1511 : 1511
+    XML_IO_EFBIG = 1512 : 1512
+    XML_IO_EINPROGRESS = 1513 : 1513
+    XML_IO_EINTR = 1514 : 1514
+    XML_IO_EINVAL = 1515 : 1515
+    XML_IO_EIO = 1516 : 1516
+    XML_IO_EISDIR = 1517 : 1517
+    XML_IO_EMFILE = 1518 : 1518
+    XML_IO_EMLINK = 1519 : 1519
+    XML_IO_EMSGSIZE = 1520 : 1520
+    XML_IO_ENAMETOOLONG = 1521 : 1521
+    XML_IO_ENFILE = 1522 : 1522
+    XML_IO_ENODEV = 1523 : 1523
+    XML_IO_ENOENT = 1524 : 1524
+    XML_IO_ENOEXEC = 1525 : 1525
+    XML_IO_ENOLCK = 1526 : 1526
+    XML_IO_ENOMEM = 1527 : 1527
+    XML_IO_ENOSPC = 1528 : 1528
+    XML_IO_ENOSYS = 1529 : 1529
+    XML_IO_ENOTDIR = 1530 : 1530
+    XML_IO_ENOTEMPTY = 1531 : 1531
+    XML_IO_ENOTSUP = 1532 : 1532
+    XML_IO_ENOTTY = 1533 : 1533
+    XML_IO_ENXIO = 1534 : 1534
+    XML_IO_EPERM = 1535 : 1535
+    XML_IO_EPIPE = 1536 : 1536
+    XML_IO_ERANGE = 1537 : 1537
+    XML_IO_EROFS = 1538 : 1538
+    XML_IO_ESPIPE = 1539 : 1539
+    XML_IO_ESRCH = 1540 : 1540
+    XML_IO_ETIMEDOUT = 1541 : 1541
+    XML_IO_EXDEV = 1542 : 1542
+    XML_IO_NETWORK_ATTEMPT = 1543 : 1543
+    XML_IO_ENCODER = 1544 : 1544
+    XML_IO_FLUSH = 1545 : 1545
+    XML_IO_WRITE = 1546 : 1546
+    XML_IO_NO_INPUT = 1547 : 1547
+    XML_IO_BUFFER_FULL = 1548 : 1548
+    XML_IO_LOAD_ERROR = 1549 : 1549
+    XML_IO_ENOTSOCK = 1550 : 1550
+    XML_IO_EISCONN = 1551 : 1551
+    XML_IO_ECONNREFUSED = 1552 : 1552
+    XML_IO_ENETUNREACH = 1553 : 1553
+    XML_IO_EADDRINUSE = 1554 : 1554
+    XML_IO_EALREADY = 1555 : 1555
+    XML_IO_EAFNOSUPPORT = 1556 : 1556
+    XML_XINCLUDE_RECURSION = 1600
+    XML_XINCLUDE_PARSE_VALUE = 1601 : 1601
+    XML_XINCLUDE_ENTITY_DEF_MISMATCH = 1602 : 1602
+    XML_XINCLUDE_NO_HREF = 1603 : 1603
+    XML_XINCLUDE_NO_FALLBACK = 1604 : 1604
+    XML_XINCLUDE_HREF_URI = 1605 : 1605
+    XML_XINCLUDE_TEXT_FRAGMENT = 1606 : 1606
+    XML_XINCLUDE_TEXT_DOCUMENT = 1607 : 1607
+    XML_XINCLUDE_INVALID_CHAR = 1608 : 1608
+    XML_XINCLUDE_BUILD_FAILED = 1609 : 1609
+    XML_XINCLUDE_UNKNOWN_ENCODING = 1610 : 1610
+    XML_XINCLUDE_MULTIPLE_ROOT = 1611 : 1611
+    XML_XINCLUDE_XPTR_FAILED = 1612 : 1612
+    XML_XINCLUDE_XPTR_RESULT = 1613 : 1613
+    XML_XINCLUDE_INCLUDE_IN_INCLUDE = 1614 : 1614
+    XML_XINCLUDE_FALLBACKS_IN_INCLUDE = 1615 : 1615
+    XML_XINCLUDE_FALLBACK_NOT_IN_INCLUDE = 1616 : 1616
+    XML_CATALOG_MISSING_ATTR = 1650
+    XML_CATALOG_ENTRY_BROKEN = 1651 : 1651
+    XML_CATALOG_PREFER_VALUE = 1652 : 1652
+    XML_CATALOG_NOT_CATALOG = 1653 : 1653
+    XML_CATALOG_RECURSION = 1654 : 1654
+    XML_SCHEMAP_PREFIX_UNDEFINED = 1700
+    XML_SCHEMAP_ATTRFORMDEFAULT_VALUE = 1701 : 1701
+    XML_SCHEMAP_ATTRGRP_NONAME_NOREF = 1702 : 1702
+    XML_SCHEMAP_ATTR_NONAME_NOREF = 1703 : 1703
+    XML_SCHEMAP_COMPLEXTYPE_NONAME_NOREF = 1704 : 1704
+    XML_SCHEMAP_ELEMFORMDEFAULT_VALUE = 1705 : 1705
+    XML_SCHEMAP_ELEM_NONAME_NOREF = 1706 : 1706
+    XML_SCHEMAP_EXTENSION_NO_BASE = 1707 : 1707
+    XML_SCHEMAP_FACET_NO_VALUE = 1708 : 1708
+    XML_SCHEMAP_FAILED_BUILD_IMPORT = 1709 : 1709
+    XML_SCHEMAP_GROUP_NONAME_NOREF = 1710 : 1710
+    XML_SCHEMAP_IMPORT_NAMESPACE_NOT_URI = 1711 : 1711
+    XML_SCHEMAP_IMPORT_REDEFINE_NSNAME = 1712 : 1712
+    XML_SCHEMAP_IMPORT_SCHEMA_NOT_URI = 1713 : 1713
+    XML_SCHEMAP_INVALID_BOOLEAN = 1714 : 1714
+    XML_SCHEMAP_INVALID_ENUM = 1715 : 1715
+    XML_SCHEMAP_INVALID_FACET = 1716 : 1716
+    XML_SCHEMAP_INVALID_FACET_VALUE = 1717 : 1717
+    XML_SCHEMAP_INVALID_MAXOCCURS = 1718 : 1718
+    XML_SCHEMAP_INVALID_MINOCCURS = 1719 : 1719
+    XML_SCHEMAP_INVALID_REF_AND_SUBTYPE = 1720 : 1720
+    XML_SCHEMAP_INVALID_WHITE_SPACE = 1721 : 1721
+    XML_SCHEMAP_NOATTR_NOREF = 1722 : 1722
+    XML_SCHEMAP_NOTATION_NO_NAME = 1723 : 1723
+    XML_SCHEMAP_NOTYPE_NOREF = 1724 : 1724
+    XML_SCHEMAP_REF_AND_SUBTYPE = 1725 : 1725
+    XML_SCHEMAP_RESTRICTION_NONAME_NOREF = 1726 : 1726
+    XML_SCHEMAP_SIMPLETYPE_NONAME = 1727 : 1727
+    XML_SCHEMAP_TYPE_AND_SUBTYPE = 1728 : 1728
+    XML_SCHEMAP_UNKNOWN_ALL_CHILD = 1729 : 1729
+    XML_SCHEMAP_UNKNOWN_ANYATTRIBUTE_CHILD = 1730 : 1730
+    XML_SCHEMAP_UNKNOWN_ATTR_CHILD = 1731 : 1731
+    XML_SCHEMAP_UNKNOWN_ATTRGRP_CHILD = 1732 : 1732
+    XML_SCHEMAP_UNKNOWN_ATTRIBUTE_GROUP = 1733 : 1733
+    XML_SCHEMAP_UNKNOWN_BASE_TYPE = 1734 : 1734
+    XML_SCHEMAP_UNKNOWN_CHOICE_CHILD = 1735 : 1735
+    XML_SCHEMAP_UNKNOWN_COMPLEXCONTENT_CHILD = 1736 : 1736
+    XML_SCHEMAP_UNKNOWN_COMPLEXTYPE_CHILD = 1737 : 1737
+    XML_SCHEMAP_UNKNOWN_ELEM_CHILD = 1738 : 1738
+    XML_SCHEMAP_UNKNOWN_EXTENSION_CHILD = 1739 : 1739
+    XML_SCHEMAP_UNKNOWN_FACET_CHILD = 1740 : 1740
+    XML_SCHEMAP_UNKNOWN_FACET_TYPE = 1741 : 1741
+    XML_SCHEMAP_UNKNOWN_GROUP_CHILD = 1742 : 1742
+    XML_SCHEMAP_UNKNOWN_IMPORT_CHILD = 1743 : 1743
+    XML_SCHEMAP_UNKNOWN_LIST_CHILD = 1744 : 1744
+    XML_SCHEMAP_UNKNOWN_NOTATION_CHILD = 1745 : 1745
+    XML_SCHEMAP_UNKNOWN_PROCESSCONTENT_CHILD = 1746 : 1746
+    XML_SCHEMAP_UNKNOWN_REF = 1747 : 1747
+    XML_SCHEMAP_UNKNOWN_RESTRICTION_CHILD = 1748 : 1748
+    XML_SCHEMAP_UNKNOWN_SCHEMAS_CHILD = 1749 : 1749
+    XML_SCHEMAP_UNKNOWN_SEQUENCE_CHILD = 1750 : 1750
+    XML_SCHEMAP_UNKNOWN_SIMPLECONTENT_CHILD = 1751 : 1751
+    XML_SCHEMAP_UNKNOWN_SIMPLETYPE_CHILD = 1752 : 1752
+    XML_SCHEMAP_UNKNOWN_TYPE = 1753 : 1753
+    XML_SCHEMAP_UNKNOWN_UNION_CHILD = 1754 : 1754
+    XML_SCHEMAP_ELEM_DEFAULT_FIXED = 1755 : 1755
+    XML_SCHEMAP_REGEXP_INVALID = 1756 : 1756
+    XML_SCHEMAP_FAILED_LOAD = 1757 : 1756
+    XML_SCHEMAP_NOTHING_TO_PARSE = 1758 : 1757
+    XML_SCHEMAP_NOROOT = 1759 : 1758
+    XML_SCHEMAP_REDEFINED_GROUP = 1760 : 1759
+    XML_SCHEMAP_REDEFINED_TYPE = 1761 : 1760
+    XML_SCHEMAP_REDEFINED_ELEMENT = 1762 : 1761
+    XML_SCHEMAP_REDEFINED_ATTRGROUP = 1763 : 1762
+    XML_SCHEMAP_REDEFINED_ATTR = 1764 : 1763
+    XML_SCHEMAP_REDEFINED_NOTATION = 1765 : 1764
+    XML_SCHEMAP_FAILED_PARSE = 1766 : 1765
+    XML_SCHEMAV_NOROOT = 1800
+    XML_SCHEMAV_UNDECLAREDELEM = 1801 : 1801
+    XML_SCHEMAV_NOTTOPLEVEL = 1802 : 1802
+    XML_SCHEMAV_MISSING = 1803 : 1803
+    XML_SCHEMAV_WRONGELEM = 1804 : 1804
+    XML_SCHEMAV_NOTYPE = 1805 : 1805
+    XML_SCHEMAV_NOROLLBACK = 1806 : 1806
+    XML_SCHEMAV_ISABSTRACT = 1807 : 1807
+    XML_SCHEMAV_NOTEMPTY = 1808 : 1808
+    XML_SCHEMAV_ELEMCONT = 1809 : 1809
+    XML_SCHEMAV_HAVEDEFAULT = 1810 : 1810
+    XML_SCHEMAV_NOTNILLABLE = 1811 : 1811
+    XML_SCHEMAV_EXTRACONTENT = 1812 : 1812
+    XML_SCHEMAV_INVALIDATTR = 1813 : 1813
+    XML_SCHEMAV_INVALIDELEM = 1814 : 1814
+    XML_SCHEMAV_NOTDETERMINIST = 1815 : 1815
+    XML_SCHEMAV_CONSTRUCT = 1816 : 1816
+    XML_SCHEMAV_INTERNAL = 1817 : 1817
+    XML_SCHEMAV_NOTSIMPLE = 1818 : 1818
+    XML_SCHEMAV_ATTRUNKNOWN = 1819 : 1819
+    XML_SCHEMAV_ATTRINVALID = 1820 : 1820
+    XML_SCHEMAV_VALUE = 1821 : 1821
+    XML_SCHEMAV_FACET = 1822 : 1822
+    XML_XPTR_UNKNOWN_SCHEME = 1900
+    XML_XPTR_CHILDSEQ_START = 1901 : 1901
+    XML_XPTR_EVAL_FAILED = 1902 : 1902
+    XML_XPTR_EXTRA_OBJECTS = 1903 : 1903
+    XML_C14N_CREATE_CTXT = 1950
+    XML_C14N_REQUIRES_UTF8 = 1951 : 1951
+    XML_C14N_CREATE_STACK = 1952 : 1952
+    XML_C14N_INVALID_NODE = 1953 : 1953
+    XML_FTP_PASV_ANSWER = 2000
+    XML_FTP_EPSV_ANSWER = 2001 : 2001
+    XML_FTP_ACCNT = 2002 : 2002
+    XML_HTTP_URL_SYNTAX = 2020
+    XML_HTTP_USE_IP = 2021 : 2021
+    XML_HTTP_UNKNOWN_HOST = 2022 : 2022
+}
 
-enum        xmlErrorLevel;
-enum        xmlErrorDomain;
-struct      xmlError;
-typedef     xmlErrorPtr;
-enum        xmlParserErrors;
-void        (*xmlGenericErrorFunc)          (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        (*xmlStructuredErrorFunc)       (void *userData,
-                                             xmlErrorPtr error);
-void        xmlSetGenericErrorFunc          (void *ctx,
-                                             xmlGenericErrorFunc handler);
-void        initGenericErrorDefaultFunc     (xmlGenericErrorFunc *handler);
-void        xmlSetStructuredErrorFunc       (void *ctx,
-                                             xmlStructuredErrorFunc handler);
-void        xmlParserError                  (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        xmlParserWarning                (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        xmlParserValidityError          (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        xmlParserValidityWarning        (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        xmlParserPrintFileInfo          (xmlParserInputPtr input);
-void        xmlParserPrintFileContext       (xmlParserInputPtr input);
-xmlErrorPtr xmlGetLastError                 (void);
-void        xmlResetLastError               (void);
-xmlErrorPtr xmlCtxtGetLastError             (void *ctx);
-void        xmlCtxtResetLastError           (void *ctx);
-void        xmlResetError                   (xmlErrorPtr err);
-int         xmlCopyError                    (xmlErrorPtr from,
-                                             xmlErrorPtr to);
-
Description

+
xmlErrorPtr	xmlGetLastError	(void)

+
void	xmlParserError	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
void	xmlSetStructuredErrorFunc	(void * ctx, 
				 xmlStructuredErrorFunc handler)

+
void	xmlResetError	(xmlErrorPtr err)

+
Typedef xmlError * xmlErrorPtr
 
-
Details
enum xmlErrorLevel
typedef enum {
-    XML_ERR_NONE = 0,
-    XML_ERR_WARNING = 1,	/* A simple warning */
-    XML_ERR_ERROR = 2,		/* A recoverable error */
-    XML_ERR_FATAL = 3		/* A fatal error */
-} xmlErrorLevel;
-

-Indicates the level of an error

-
-
enum xmlErrorDomain
typedef enum {
-    XML_FROM_NONE = 0,
-    XML_FROM_PARSER,	/* The XML parser */
-    XML_FROM_TREE,	/* The tree module */
-    XML_FROM_NAMESPACE,	/* The XML Namespace module */
-    XML_FROM_DTD,	/* The XML DTD validation with parser context*/
-    XML_FROM_HTML,	/* The HTML parser */
-    XML_FROM_MEMORY,	/* The memory allocator */
-    XML_FROM_OUTPUT,	/* The serialization code */
-    XML_FROM_IO,	/* The Input/Output stack */
-    XML_FROM_FTP,	/* The FTP module */
-    XML_FROM_HTTP,	/* The FTP module */
-    XML_FROM_XINCLUDE,	/* The XInclude processing */
-    XML_FROM_XPATH,	/* The XPath module */
-    XML_FROM_XPOINTER,	/* The XPointer module */
-    XML_FROM_REGEXP,	/* The regular expressions module */
-    XML_FROM_DATATYPE,	/* The W3C XML Schemas Datatype module */
-    XML_FROM_SCHEMASP,	/* The W3C XML Schemas parser module */
-    XML_FROM_SCHEMASV,	/* The W3C XML Schemas validation module */
-    XML_FROM_RELAXNGP,	/* The Relax-NG parser module */
-    XML_FROM_RELAXNGV,	/* The Relax-NG validator module */
-    XML_FROM_CATALOG,	/* The Catalog module */
-    XML_FROM_C14N,	/* The Canonicalization module */
-    XML_FROM_XSLT,	/* The XSLT engine from libxslt */
-    XML_FROM_VALID	/* The XML DTD validation with valid context */
-} xmlErrorDomain;
-

-Indicates where an error may have come from

-
-
struct xmlError
struct xmlError {
-
-    int		domain;	/* What part of the library raised this error */
-    int		code;	/* The error code, e.g. an xmlParserError */
-    char       *message;/* human-readable informative error message */
-    xmlErrorLevel level;/* how consequent is the error */
-    char       *file;	/* the filename */
-    int		line;	/* the line number if available */
-    char       *str1;	/* extra string information */
-    char       *str2;	/* extra string information */
-    char       *str3;	/* extra string information */
-    int		int1;	/* extra number information */
-    int		int2;	/* extra number information */
-    void       *ctxt;   /* the parser context if available */
-    void       *node;   /* the node in the tree */
-};
-

-An XML Error instance.

-
-
xmlErrorPtr
typedef xmlError *xmlErrorPtr;
-

-
-
enum xmlParserErrors
typedef enum {
-    XML_ERR_OK = 0,
-    XML_ERR_INTERNAL_ERROR, /* 1 */
-    XML_ERR_NO_MEMORY, /* 2 */
-    XML_ERR_DOCUMENT_START, /* 3 */
-    XML_ERR_DOCUMENT_EMPTY, /* 4 */
-    XML_ERR_DOCUMENT_END, /* 5 */
-    XML_ERR_INVALID_HEX_CHARREF, /* 6 */
-    XML_ERR_INVALID_DEC_CHARREF, /* 7 */
-    XML_ERR_INVALID_CHARREF, /* 8 */
-    XML_ERR_INVALID_CHAR, /* 9 */
-    XML_ERR_CHARREF_AT_EOF, /* 10 */
-    XML_ERR_CHARREF_IN_PROLOG, /* 11 */
-    XML_ERR_CHARREF_IN_EPILOG, /* 12 */
-    XML_ERR_CHARREF_IN_DTD, /* 13 */
-    XML_ERR_ENTITYREF_AT_EOF, /* 14 */
-    XML_ERR_ENTITYREF_IN_PROLOG, /* 15 */
-    XML_ERR_ENTITYREF_IN_EPILOG, /* 16 */
-    XML_ERR_ENTITYREF_IN_DTD, /* 17 */
-    XML_ERR_PEREF_AT_EOF, /* 18 */
-    XML_ERR_PEREF_IN_PROLOG, /* 19 */
-    XML_ERR_PEREF_IN_EPILOG, /* 20 */
-    XML_ERR_PEREF_IN_INT_SUBSET, /* 21 */
-    XML_ERR_ENTITYREF_NO_NAME, /* 22 */
-    XML_ERR_ENTITYREF_SEMICOL_MISSING, /* 23 */
-    XML_ERR_PEREF_NO_NAME, /* 24 */
-    XML_ERR_PEREF_SEMICOL_MISSING, /* 25 */
-    XML_ERR_UNDECLARED_ENTITY, /* 26 */
-    XML_WAR_UNDECLARED_ENTITY, /* 27 */
-    XML_ERR_UNPARSED_ENTITY, /* 28 */
-    XML_ERR_ENTITY_IS_EXTERNAL, /* 29 */
-    XML_ERR_ENTITY_IS_PARAMETER, /* 30 */
-    XML_ERR_UNKNOWN_ENCODING, /* 31 */
-    XML_ERR_UNSUPPORTED_ENCODING, /* 32 */
-    XML_ERR_STRING_NOT_STARTED, /* 33 */
-    XML_ERR_STRING_NOT_CLOSED, /* 34 */
-    XML_ERR_NS_DECL_ERROR, /* 35 */
-    XML_ERR_ENTITY_NOT_STARTED, /* 36 */
-    XML_ERR_ENTITY_NOT_FINISHED, /* 37 */
-    XML_ERR_LT_IN_ATTRIBUTE, /* 38 */
-    XML_ERR_ATTRIBUTE_NOT_STARTED, /* 39 */
-    XML_ERR_ATTRIBUTE_NOT_FINISHED, /* 40 */
-    XML_ERR_ATTRIBUTE_WITHOUT_VALUE, /* 41 */
-    XML_ERR_ATTRIBUTE_REDEFINED, /* 42 */
-    XML_ERR_LITERAL_NOT_STARTED, /* 43 */
-    XML_ERR_LITERAL_NOT_FINISHED, /* 44 */
-    XML_ERR_COMMENT_NOT_FINISHED, /* 45 */
-    XML_ERR_PI_NOT_STARTED, /* 46 */
-    XML_ERR_PI_NOT_FINISHED, /* 47 */
-    XML_ERR_NOTATION_NOT_STARTED, /* 48 */
-    XML_ERR_NOTATION_NOT_FINISHED, /* 49 */
-    XML_ERR_ATTLIST_NOT_STARTED, /* 50 */
-    XML_ERR_ATTLIST_NOT_FINISHED, /* 51 */
-    XML_ERR_MIXED_NOT_STARTED, /* 52 */
-    XML_ERR_MIXED_NOT_FINISHED, /* 53 */
-    XML_ERR_ELEMCONTENT_NOT_STARTED, /* 54 */
-    XML_ERR_ELEMCONTENT_NOT_FINISHED, /* 55 */
-    XML_ERR_XMLDECL_NOT_STARTED, /* 56 */
-    XML_ERR_XMLDECL_NOT_FINISHED, /* 57 */
-    XML_ERR_CONDSEC_NOT_STARTED, /* 58 */
-    XML_ERR_CONDSEC_NOT_FINISHED, /* 59 */
-    XML_ERR_EXT_SUBSET_NOT_FINISHED, /* 60 */
-    XML_ERR_DOCTYPE_NOT_FINISHED, /* 61 */
-    XML_ERR_MISPLACED_CDATA_END, /* 62 */
-    XML_ERR_CDATA_NOT_FINISHED, /* 63 */
-    XML_ERR_RESERVED_XML_NAME, /* 64 */
-    XML_ERR_SPACE_REQUIRED, /* 65 */
-    XML_ERR_SEPARATOR_REQUIRED, /* 66 */
-    XML_ERR_NMTOKEN_REQUIRED, /* 67 */
-    XML_ERR_NAME_REQUIRED, /* 68 */
-    XML_ERR_PCDATA_REQUIRED, /* 69 */
-    XML_ERR_URI_REQUIRED, /* 70 */
-    XML_ERR_PUBID_REQUIRED, /* 71 */
-    XML_ERR_LT_REQUIRED, /* 72 */
-    XML_ERR_GT_REQUIRED, /* 73 */
-    XML_ERR_LTSLASH_REQUIRED, /* 74 */
-    XML_ERR_EQUAL_REQUIRED, /* 75 */
-    XML_ERR_TAG_NAME_MISMATCH, /* 76 */
-    XML_ERR_TAG_NOT_FINISHED, /* 77 */
-    XML_ERR_STANDALONE_VALUE, /* 78 */
-    XML_ERR_ENCODING_NAME, /* 79 */
-    XML_ERR_HYPHEN_IN_COMMENT, /* 80 */
-    XML_ERR_INVALID_ENCODING, /* 81 */
-    XML_ERR_EXT_ENTITY_STANDALONE, /* 82 */
-    XML_ERR_CONDSEC_INVALID, /* 83 */
-    XML_ERR_VALUE_REQUIRED, /* 84 */
-    XML_ERR_NOT_WELL_BALANCED, /* 85 */
-    XML_ERR_EXTRA_CONTENT, /* 86 */
-    XML_ERR_ENTITY_CHAR_ERROR, /* 87 */
-    XML_ERR_ENTITY_PE_INTERNAL, /* 88 */
-    XML_ERR_ENTITY_LOOP, /* 89 */
-    XML_ERR_ENTITY_BOUNDARY, /* 90 */
-    XML_ERR_INVALID_URI, /* 91 */
-    XML_ERR_URI_FRAGMENT, /* 92 */
-    XML_WAR_CATALOG_PI, /* 93 */
-    XML_ERR_NO_DTD, /* 94 */
-    XML_ERR_CONDSEC_INVALID_KEYWORD, /* 95 */
-    XML_ERR_VERSION_MISSING, /* 96 */
-    XML_WAR_UNKNOWN_VERSION, /* 97 */
-    XML_WAR_LANG_VALUE, /* 98 */
-    XML_WAR_NS_URI, /* 99 */
-    XML_WAR_NS_URI_RELATIVE, /* 100 */
-    XML_ERR_MISSING_ENCODING, /* 101 */
-    XML_NS_ERR_XML_NAMESPACE = 200,
-    XML_NS_ERR_UNDEFINED_NAMESPACE, /* 201 */
-    XML_NS_ERR_QNAME, /* 202 */
-    XML_NS_ERR_ATTRIBUTE_REDEFINED, /* 203 */
-    XML_DTD_ATTRIBUTE_DEFAULT = 500,
-    XML_DTD_ATTRIBUTE_REDEFINED, /* 501 */
-    XML_DTD_ATTRIBUTE_VALUE, /* 502 */
-    XML_DTD_CONTENT_ERROR, /* 503 */
-    XML_DTD_CONTENT_MODEL, /* 504 */
-    XML_DTD_CONTENT_NOT_DETERMINIST, /* 505 */
-    XML_DTD_DIFFERENT_PREFIX, /* 506 */
-    XML_DTD_ELEM_DEFAULT_NAMESPACE, /* 507 */
-    XML_DTD_ELEM_NAMESPACE, /* 508 */
-    XML_DTD_ELEM_REDEFINED, /* 509 */
-    XML_DTD_EMPTY_NOTATION, /* 510 */
-    XML_DTD_ENTITY_TYPE, /* 511 */
-    XML_DTD_ID_FIXED, /* 512 */
-    XML_DTD_ID_REDEFINED, /* 513 */
-    XML_DTD_ID_SUBSET, /* 514 */
-    XML_DTD_INVALID_CHILD, /* 515 */
-    XML_DTD_INVALID_DEFAULT, /* 516 */
-    XML_DTD_LOAD_ERROR, /* 517 */
-    XML_DTD_MISSING_ATTRIBUTE, /* 518 */
-    XML_DTD_MIXED_CORRUPT, /* 519 */
-    XML_DTD_MULTIPLE_ID, /* 520 */
-    XML_DTD_NO_DOC, /* 521 */
-    XML_DTD_NO_DTD, /* 522 */
-    XML_DTD_NO_ELEM_NAME, /* 523 */
-    XML_DTD_NO_PREFIX, /* 524 */
-    XML_DTD_NO_ROOT, /* 525 */
-    XML_DTD_NOTATION_REDEFINED, /* 526 */
-    XML_DTD_NOTATION_VALUE, /* 527 */
-    XML_DTD_NOT_EMPTY, /* 528 */
-    XML_DTD_NOT_PCDATA, /* 529 */
-    XML_DTD_NOT_STANDALONE, /* 530 */
-    XML_DTD_ROOT_NAME, /* 531 */
-    XML_DTD_STANDALONE_WHITE_SPACE, /* 532 */
-    XML_DTD_UNKNOWN_ATTRIBUTE, /* 533 */
-    XML_DTD_UNKNOWN_ELEM, /* 534 */
-    XML_DTD_UNKNOWN_ENTITY, /* 535 */
-    XML_DTD_UNKNOWN_ID, /* 536 */
-    XML_DTD_UNKNOWN_NOTATION, /* 537 */
-    XML_HTML_STRUCURE_ERROR = 800,
-    XML_HTML_UNKNOWN_TAG, /* 801 */
-    XML_RNGP_ANYNAME_ATTR_ANCESTOR = 1000,
-    XML_RNGP_ATTR_CONFLICT, /* 1001 */
-    XML_RNGP_ATTRIBUTE_CHILDREN, /* 1002 */
-    XML_RNGP_ATTRIBUTE_CONTENT, /* 1003 */
-    XML_RNGP_ATTRIBUTE_EMPTY, /* 1004 */
-    XML_RNGP_ATTRIBUTE_NOOP, /* 1005 */
-    XML_RNGP_CHOICE_CONTENT, /* 1006 */
-    XML_RNGP_CHOICE_EMPTY, /* 1007 */
-    XML_RNGP_CREATE_FAILURE, /* 1008 */
-    XML_RNGP_DATA_CONTENT, /* 1009 */
-    XML_RNGP_DEF_CHOICE_AND_INTERLEAVE, /* 1010 */
-    XML_RNGP_DEFINE_CREATE_FAILED, /* 1011 */
-    XML_RNGP_DEFINE_EMPTY, /* 1012 */
-    XML_RNGP_DEFINE_MISSING, /* 1013 */
-    XML_RNGP_DEFINE_NAME_MISSING, /* 1014 */
-    XML_RNGP_ELEM_CONTENT_EMPTY, /* 1015 */
-    XML_RNGP_ELEM_CONTENT_ERROR, /* 1016 */
-    XML_RNGP_ELEMENT_EMPTY, /* 1017 */
-    XML_RNGP_ELEMENT_CONTENT, /* 1018 */
-    XML_RNGP_ELEMENT_NAME, /* 1019 */
-    XML_RNGP_ELEMENT_NO_CONTENT, /* 1020 */
-    XML_RNGP_ELEM_TEXT_CONFLICT, /* 1021 */
-    XML_RNGP_EMPTY, /* 1022 */
-    XML_RNGP_EMPTY_CONSTRUCT, /* 1023 */
-    XML_RNGP_EMPTY_CONTENT, /* 1024 */
-    XML_RNGP_EMPTY_NOT_EMPTY, /* 1025 */
-    XML_RNGP_ERROR_TYPE_LIB, /* 1026 */
-    XML_RNGP_EXCEPT_EMPTY, /* 1027 */
-    XML_RNGP_EXCEPT_MISSING, /* 1028 */
-    XML_RNGP_EXCEPT_MULTIPLE, /* 1029 */
-    XML_RNGP_EXCEPT_NO_CONTENT, /* 1030 */
-    XML_RNGP_EXTERNALREF_EMTPY, /* 1031 */
-    XML_RNGP_EXTERNAL_REF_FAILURE, /* 1032 */
-    XML_RNGP_EXTERNALREF_RECURSE, /* 1033 */
-    XML_RNGP_FORBIDDEN_ATTRIBUTE, /* 1034 */
-    XML_RNGP_FOREIGN_ELEMENT, /* 1035 */
-    XML_RNGP_GRAMMAR_CONTENT, /* 1036 */
-    XML_RNGP_GRAMMAR_EMPTY, /* 1037 */
-    XML_RNGP_GRAMMAR_MISSING, /* 1038 */
-    XML_RNGP_GRAMMAR_NO_START, /* 1039 */
-    XML_RNGP_GROUP_ATTR_CONFLICT, /* 1040 */
-    XML_RNGP_HREF_ERROR, /* 1041 */
-    XML_RNGP_INCLUDE_EMPTY, /* 1042 */
-    XML_RNGP_INCLUDE_FAILURE, /* 1043 */
-    XML_RNGP_INCLUDE_RECURSE, /* 1044 */
-    XML_RNGP_INTERLEAVE_ADD, /* 1045 */
-    XML_RNGP_INTERLEAVE_CREATE_FAILED, /* 1046 */
-    XML_RNGP_INTERLEAVE_EMPTY, /* 1047 */
-    XML_RNGP_INTERLEAVE_NO_CONTENT, /* 1048 */
-    XML_RNGP_INVALID_DEFINE_NAME, /* 1049 */
-    XML_RNGP_INVALID_URI, /* 1050 */
-    XML_RNGP_INVALID_VALUE, /* 1051 */
-    XML_RNGP_MISSING_HREF, /* 1052 */
-    XML_RNGP_NAME_MISSING, /* 1053 */
-    XML_RNGP_NEED_COMBINE, /* 1054 */
-    XML_RNGP_NOTALLOWED_NOT_EMPTY, /* 1055 */
-    XML_RNGP_NSNAME_ATTR_ANCESTOR, /* 1056 */
-    XML_RNGP_NSNAME_NO_NS, /* 1057 */
-    XML_RNGP_PARAM_FORBIDDEN, /* 1058 */
-    XML_RNGP_PARAM_NAME_MISSING, /* 1059 */
-    XML_RNGP_PARENTREF_CREATE_FAILED, /* 1060 */
-    XML_RNGP_PARENTREF_NAME_INVALID, /* 1061 */
-    XML_RNGP_PARENTREF_NO_NAME, /* 1062 */
-    XML_RNGP_PARENTREF_NO_PARENT, /* 1063 */
-    XML_RNGP_PARENTREF_NOT_EMPTY, /* 1064 */
-    XML_RNGP_PARSE_ERROR, /* 1065 */
-    XML_RNGP_PAT_ANYNAME_EXCEPT_ANYNAME, /* 1066 */
-    XML_RNGP_PAT_ATTR_ATTR, /* 1067 */
-    XML_RNGP_PAT_ATTR_ELEM, /* 1068 */
-    XML_RNGP_PAT_DATA_EXCEPT_ATTR, /* 1069 */
-    XML_RNGP_PAT_DATA_EXCEPT_ELEM, /* 1070 */
-    XML_RNGP_PAT_DATA_EXCEPT_EMPTY, /* 1071 */
-    XML_RNGP_PAT_DATA_EXCEPT_GROUP, /* 1072 */
-    XML_RNGP_PAT_DATA_EXCEPT_INTERLEAVE, /* 1073 */
-    XML_RNGP_PAT_DATA_EXCEPT_LIST, /* 1074 */
-    XML_RNGP_PAT_DATA_EXCEPT_ONEMORE, /* 1075 */
-    XML_RNGP_PAT_DATA_EXCEPT_REF, /* 1076 */
-    XML_RNGP_PAT_DATA_EXCEPT_TEXT, /* 1077 */
-    XML_RNGP_PAT_LIST_ATTR, /* 1078 */
-    XML_RNGP_PAT_LIST_ELEM, /* 1079 */
-    XML_RNGP_PAT_LIST_INTERLEAVE, /* 1080 */
-    XML_RNGP_PAT_LIST_LIST, /* 1081 */
-    XML_RNGP_PAT_LIST_REF, /* 1082 */
-    XML_RNGP_PAT_LIST_TEXT, /* 1083 */
-    XML_RNGP_PAT_NSNAME_EXCEPT_ANYNAME, /* 1084 */
-    XML_RNGP_PAT_NSNAME_EXCEPT_NSNAME, /* 1085 */
-    XML_RNGP_PAT_ONEMORE_GROUP_ATTR, /* 1086 */
-    XML_RNGP_PAT_ONEMORE_INTERLEAVE_ATTR, /* 1087 */
-    XML_RNGP_PAT_START_ATTR, /* 1088 */
-    XML_RNGP_PAT_START_DATA, /* 1089 */
-    XML_RNGP_PAT_START_EMPTY, /* 1090 */
-    XML_RNGP_PAT_START_GROUP, /* 1091 */
-    XML_RNGP_PAT_START_INTERLEAVE, /* 1092 */
-    XML_RNGP_PAT_START_LIST, /* 1093 */
-    XML_RNGP_PAT_START_ONEMORE, /* 1094 */
-    XML_RNGP_PAT_START_TEXT, /* 1095 */
-    XML_RNGP_PAT_START_VALUE, /* 1096 */
-    XML_RNGP_PREFIX_UNDEFINED, /* 1097 */
-    XML_RNGP_REF_CREATE_FAILED, /* 1098 */
-    XML_RNGP_REF_CYCLE, /* 1099 */
-    XML_RNGP_REF_NAME_INVALID, /* 1100 */
-    XML_RNGP_REF_NO_DEF, /* 1101 */
-    XML_RNGP_REF_NO_NAME, /* 1102 */
-    XML_RNGP_REF_NOT_EMPTY, /* 1103 */
-    XML_RNGP_START_CHOICE_AND_INTERLEAVE, /* 1104 */
-    XML_RNGP_START_CONTENT, /* 1105 */
-    XML_RNGP_START_EMPTY, /* 1106 */
-    XML_RNGP_START_MISSING, /* 1107 */
-    XML_RNGP_TEXT_EXPECTED, /* 1108 */
-    XML_RNGP_TEXT_HAS_CHILD, /* 1109 */
-    XML_RNGP_TYPE_MISSING, /* 1110 */
-    XML_RNGP_TYPE_NOT_FOUND, /* 1111 */
-    XML_RNGP_TYPE_VALUE, /* 1112 */
-    XML_RNGP_UNKNOWN_ATTRIBUTE, /* 1113 */
-    XML_RNGP_UNKNOWN_COMBINE, /* 1114 */
-    XML_RNGP_UNKNOWN_CONSTRUCT, /* 1115 */
-    XML_RNGP_UNKNOWN_TYPE_LIB, /* 1116 */
-    XML_RNGP_URI_FRAGMENT, /* 1117 */
-    XML_RNGP_URI_NOT_ABSOLUTE, /* 1118 */
-    XML_RNGP_VALUE_EMPTY, /* 1119 */
-    XML_RNGP_VALUE_NO_CONTENT, /* 1120 */
-    XML_RNGP_XMLNS_NAME, /* 1121 */
-    XML_RNGP_XML_NS, /* 1122 */
-    XML_XPATH_EXPRESSION_OK = 1200,
-    XML_XPATH_NUMBER_ERROR, /* 1201 */
-    XML_XPATH_UNFINISHED_LITERAL_ERROR, /* 1202 */
-    XML_XPATH_START_LITERAL_ERROR, /* 1203 */
-    XML_XPATH_VARIABLE_REF_ERROR, /* 1204 */
-    XML_XPATH_UNDEF_VARIABLE_ERROR, /* 1205 */
-    XML_XPATH_INVALID_PREDICATE_ERROR, /* 1206 */
-    XML_XPATH_EXPR_ERROR, /* 1207 */
-    XML_XPATH_UNCLOSED_ERROR, /* 1208 */
-    XML_XPATH_UNKNOWN_FUNC_ERROR, /* 1209 */
-    XML_XPATH_INVALID_OPERAND, /* 1210 */
-    XML_XPATH_INVALID_TYPE, /* 1211 */
-    XML_XPATH_INVALID_ARITY, /* 1212 */
-    XML_XPATH_INVALID_CTXT_SIZE, /* 1213 */
-    XML_XPATH_INVALID_CTXT_POSITION, /* 1214 */
-    XML_XPATH_MEMORY_ERROR, /* 1215 */
-    XML_XPTR_SYNTAX_ERROR, /* 1216 */
-    XML_XPTR_RESOURCE_ERROR, /* 1217 */
-    XML_XPTR_SUB_RESOURCE_ERROR, /* 1218 */
-    XML_XPATH_UNDEF_PREFIX_ERROR, /* 1219 */
-    XML_XPATH_ENCODING_ERROR, /* 1220 */
-    XML_XPATH_INVALID_CHAR_ERROR, /* 1221 */
-    XML_TREE_INVALID_HEX = 1300,
-    XML_TREE_INVALID_DEC, /* 1301 */
-    XML_TREE_UNTERMINATED_ENTITY, /* 1302 */
-    XML_SAVE_NOT_UTF8 = 1400,
-    XML_SAVE_CHAR_INVALID, /* 1401 */
-    XML_SAVE_NO_DOCTYPE, /* 1402 */
-    XML_SAVE_UNKNOWN_ENCODING, /* 1403 */
-    XML_REGEXP_COMPILE_ERROR = 1450,
-    XML_IO_UNKNOWN = 1500,
-    XML_IO_EACCES, /* 1501 */
-    XML_IO_EAGAIN, /* 1502 */
-    XML_IO_EBADF, /* 1503 */
-    XML_IO_EBADMSG, /* 1504 */
-    XML_IO_EBUSY, /* 1505 */
-    XML_IO_ECANCELED, /* 1506 */
-    XML_IO_ECHILD, /* 1507 */
-    XML_IO_EDEADLK, /* 1508 */
-    XML_IO_EDOM, /* 1509 */
-    XML_IO_EEXIST, /* 1510 */
-    XML_IO_EFAULT, /* 1511 */
-    XML_IO_EFBIG, /* 1512 */
-    XML_IO_EINPROGRESS, /* 1513 */
-    XML_IO_EINTR, /* 1514 */
-    XML_IO_EINVAL, /* 1515 */
-    XML_IO_EIO, /* 1516 */
-    XML_IO_EISDIR, /* 1517 */
-    XML_IO_EMFILE, /* 1518 */
-    XML_IO_EMLINK, /* 1519 */
-    XML_IO_EMSGSIZE, /* 1520 */
-    XML_IO_ENAMETOOLONG, /* 1521 */
-    XML_IO_ENFILE, /* 1522 */
-    XML_IO_ENODEV, /* 1523 */
-    XML_IO_ENOENT, /* 1524 */
-    XML_IO_ENOEXEC, /* 1525 */
-    XML_IO_ENOLCK, /* 1526 */
-    XML_IO_ENOMEM, /* 1527 */
-    XML_IO_ENOSPC, /* 1528 */
-    XML_IO_ENOSYS, /* 1529 */
-    XML_IO_ENOTDIR, /* 1530 */
-    XML_IO_ENOTEMPTY, /* 1531 */
-    XML_IO_ENOTSUP, /* 1532 */
-    XML_IO_ENOTTY, /* 1533 */
-    XML_IO_ENXIO, /* 1534 */
-    XML_IO_EPERM, /* 1535 */
-    XML_IO_EPIPE, /* 1536 */
-    XML_IO_ERANGE, /* 1537 */
-    XML_IO_EROFS, /* 1538 */
-    XML_IO_ESPIPE, /* 1539 */
-    XML_IO_ESRCH, /* 1540 */
-    XML_IO_ETIMEDOUT, /* 1541 */
-    XML_IO_EXDEV, /* 1542 */
-    XML_IO_NETWORK_ATTEMPT, /* 1543 */
-    XML_IO_ENCODER, /* 1544 */
-    XML_IO_FLUSH, /* 1545 */
-    XML_IO_WRITE, /* 1546 */
-    XML_IO_NO_INPUT, /* 1547 */
-    XML_IO_BUFFER_FULL, /* 1548 */
-    XML_IO_LOAD_ERROR, /* 1549 */
-    XML_IO_ENOTSOCK, /* 1550 */
-    XML_IO_EISCONN, /* 1551 */
-    XML_IO_ECONNREFUSED, /* 1552 */
-    XML_IO_ENETUNREACH, /* 1553 */
-    XML_IO_EADDRINUSE, /* 1554 */
-    XML_IO_EALREADY, /* 1555 */
-    XML_IO_EAFNOSUPPORT, /* 1556 */
-    XML_XINCLUDE_RECURSION=1600,
-    XML_XINCLUDE_PARSE_VALUE, /* 1601 */
-    XML_XINCLUDE_ENTITY_DEF_MISMATCH, /* 1602 */
-    XML_XINCLUDE_NO_HREF, /* 1603 */
-    XML_XINCLUDE_NO_FALLBACK, /* 1604 */
-    XML_XINCLUDE_HREF_URI, /* 1605 */
-    XML_XINCLUDE_TEXT_FRAGMENT, /* 1606 */
-    XML_XINCLUDE_TEXT_DOCUMENT, /* 1607 */
-    XML_XINCLUDE_INVALID_CHAR, /* 1608 */
-    XML_XINCLUDE_BUILD_FAILED, /* 1609 */
-    XML_XINCLUDE_UNKNOWN_ENCODING, /* 1610 */
-    XML_XINCLUDE_MULTIPLE_ROOT, /* 1611 */
-    XML_XINCLUDE_XPTR_FAILED, /* 1612 */
-    XML_XINCLUDE_XPTR_RESULT, /* 1613 */
-    XML_XINCLUDE_INCLUDE_IN_INCLUDE, /* 1614 */
-    XML_XINCLUDE_FALLBACKS_IN_INCLUDE, /* 1615 */
-    XML_XINCLUDE_FALLBACK_NOT_IN_INCLUDE, /* 1616 */
-    XML_CATALOG_MISSING_ATTR = 1650,
-    XML_CATALOG_ENTRY_BROKEN, /* 1651 */
-    XML_CATALOG_PREFER_VALUE, /* 1652 */
-    XML_CATALOG_NOT_CATALOG, /* 1653 */
-    XML_CATALOG_RECURSION, /* 1654 */
-    XML_SCHEMAP_PREFIX_UNDEFINED = 1700,
-    XML_SCHEMAP_ATTRFORMDEFAULT_VALUE, /* 1701 */
-    XML_SCHEMAP_ATTRGRP_NONAME_NOREF, /* 1702 */
-    XML_SCHEMAP_ATTR_NONAME_NOREF, /* 1703 */
-    XML_SCHEMAP_COMPLEXTYPE_NONAME_NOREF, /* 1704 */
-    XML_SCHEMAP_ELEMFORMDEFAULT_VALUE, /* 1705 */
-    XML_SCHEMAP_ELEM_NONAME_NOREF, /* 1706 */
-    XML_SCHEMAP_EXTENSION_NO_BASE, /* 1707 */
-    XML_SCHEMAP_FACET_NO_VALUE, /* 1708 */
-    XML_SCHEMAP_FAILED_BUILD_IMPORT, /* 1709 */
-    XML_SCHEMAP_GROUP_NONAME_NOREF, /* 1710 */
-    XML_SCHEMAP_IMPORT_NAMESPACE_NOT_URI, /* 1711 */
-    XML_SCHEMAP_IMPORT_REDEFINE_NSNAME, /* 1712 */
-    XML_SCHEMAP_IMPORT_SCHEMA_NOT_URI, /* 1713 */
-    XML_SCHEMAP_INVALID_BOOLEAN, /* 1714 */
-    XML_SCHEMAP_INVALID_ENUM, /* 1715 */
-    XML_SCHEMAP_INVALID_FACET, /* 1716 */
-    XML_SCHEMAP_INVALID_FACET_VALUE, /* 1717 */
-    XML_SCHEMAP_INVALID_MAXOCCURS, /* 1718 */
-    XML_SCHEMAP_INVALID_MINOCCURS, /* 1719 */
-    XML_SCHEMAP_INVALID_REF_AND_SUBTYPE, /* 1720 */
-    XML_SCHEMAP_INVALID_WHITE_SPACE, /* 1721 */
-    XML_SCHEMAP_NOATTR_NOREF, /* 1722 */
-    XML_SCHEMAP_NOTATION_NO_NAME, /* 1723 */
-    XML_SCHEMAP_NOTYPE_NOREF, /* 1724 */
-    XML_SCHEMAP_REF_AND_SUBTYPE, /* 1725 */
-    XML_SCHEMAP_RESTRICTION_NONAME_NOREF, /* 1726 */
-    XML_SCHEMAP_SIMPLETYPE_NONAME, /* 1727 */
-    XML_SCHEMAP_TYPE_AND_SUBTYPE, /* 1728 */
-    XML_SCHEMAP_UNKNOWN_ALL_CHILD, /* 1729 */
-    XML_SCHEMAP_UNKNOWN_ANYATTRIBUTE_CHILD, /* 1730 */
-    XML_SCHEMAP_UNKNOWN_ATTR_CHILD, /* 1731 */
-    XML_SCHEMAP_UNKNOWN_ATTRGRP_CHILD, /* 1732 */
-    XML_SCHEMAP_UNKNOWN_ATTRIBUTE_GROUP, /* 1733 */
-    XML_SCHEMAP_UNKNOWN_BASE_TYPE, /* 1734 */
-    XML_SCHEMAP_UNKNOWN_CHOICE_CHILD, /* 1735 */
-    XML_SCHEMAP_UNKNOWN_COMPLEXCONTENT_CHILD, /* 1736 */
-    XML_SCHEMAP_UNKNOWN_COMPLEXTYPE_CHILD, /* 1737 */
-    XML_SCHEMAP_UNKNOWN_ELEM_CHILD, /* 1738 */
-    XML_SCHEMAP_UNKNOWN_EXTENSION_CHILD, /* 1739 */
-    XML_SCHEMAP_UNKNOWN_FACET_CHILD, /* 1740 */
-    XML_SCHEMAP_UNKNOWN_FACET_TYPE, /* 1741 */
-    XML_SCHEMAP_UNKNOWN_GROUP_CHILD, /* 1742 */
-    XML_SCHEMAP_UNKNOWN_IMPORT_CHILD, /* 1743 */
-    XML_SCHEMAP_UNKNOWN_LIST_CHILD, /* 1744 */
-    XML_SCHEMAP_UNKNOWN_NOTATION_CHILD, /* 1745 */
-    XML_SCHEMAP_UNKNOWN_PROCESSCONTENT_CHILD, /* 1746 */
-    XML_SCHEMAP_UNKNOWN_REF, /* 1747 */
-    XML_SCHEMAP_UNKNOWN_RESTRICTION_CHILD, /* 1748 */
-    XML_SCHEMAP_UNKNOWN_SCHEMAS_CHILD, /* 1749 */
-    XML_SCHEMAP_UNKNOWN_SEQUENCE_CHILD, /* 1750 */
-    XML_SCHEMAP_UNKNOWN_SIMPLECONTENT_CHILD, /* 1751 */
-    XML_SCHEMAP_UNKNOWN_SIMPLETYPE_CHILD, /* 1752 */
-    XML_SCHEMAP_UNKNOWN_TYPE, /* 1753 */
-    XML_SCHEMAP_UNKNOWN_UNION_CHILD, /* 1754 */
-    XML_SCHEMAP_ELEM_DEFAULT_FIXED, /* 1755 */
-    XML_SCHEMAP_REGEXP_INVALID, /* 1756 */
-    XML_SCHEMAP_FAILED_LOAD, /* 1756 */
-    XML_SCHEMAP_NOTHING_TO_PARSE, /* 1757 */
-    XML_SCHEMAP_NOROOT, /* 1758 */
-    XML_SCHEMAP_REDEFINED_GROUP, /* 1759 */
-    XML_SCHEMAP_REDEFINED_TYPE, /* 1760 */
-    XML_SCHEMAP_REDEFINED_ELEMENT, /* 1761 */
-    XML_SCHEMAP_REDEFINED_ATTRGROUP, /* 1762 */
-    XML_SCHEMAP_REDEFINED_ATTR, /* 1763 */
-    XML_SCHEMAP_REDEFINED_NOTATION, /* 1764 */
-    XML_SCHEMAP_FAILED_PARSE, /* 1765 */
-    XML_SCHEMAV_NOROOT = 1800,
-    XML_SCHEMAV_UNDECLAREDELEM, /* 1801 */
-    XML_SCHEMAV_NOTTOPLEVEL, /* 1802 */
-    XML_SCHEMAV_MISSING, /* 1803 */
-    XML_SCHEMAV_WRONGELEM, /* 1804 */
-    XML_SCHEMAV_NOTYPE, /* 1805 */
-    XML_SCHEMAV_NOROLLBACK, /* 1806 */
-    XML_SCHEMAV_ISABSTRACT, /* 1807 */
-    XML_SCHEMAV_NOTEMPTY, /* 1808 */
-    XML_SCHEMAV_ELEMCONT, /* 1809 */
-    XML_SCHEMAV_HAVEDEFAULT, /* 1810 */
-    XML_SCHEMAV_NOTNILLABLE, /* 1811 */
-    XML_SCHEMAV_EXTRACONTENT, /* 1812 */
-    XML_SCHEMAV_INVALIDATTR, /* 1813 */
-    XML_SCHEMAV_INVALIDELEM, /* 1814 */
-    XML_SCHEMAV_NOTDETERMINIST, /* 1815 */
-    XML_SCHEMAV_CONSTRUCT, /* 1816 */
-    XML_SCHEMAV_INTERNAL, /* 1817 */
-    XML_SCHEMAV_NOTSIMPLE, /* 1818 */
-    XML_SCHEMAV_ATTRUNKNOWN, /* 1819 */
-    XML_SCHEMAV_ATTRINVALID, /* 1820 */
-    XML_SCHEMAV_VALUE, /* 1821 */
-    XML_SCHEMAV_FACET, /* 1822 */
-    XML_XPTR_UNKNOWN_SCHEME = 1900,
-    XML_XPTR_CHILDSEQ_START, /* 1901 */
-    XML_XPTR_EVAL_FAILED, /* 1902 */
-    XML_XPTR_EXTRA_OBJECTS, /* 1903 */
-    XML_C14N_CREATE_CTXT = 1950,
-    XML_C14N_REQUIRES_UTF8, /* 1951 */
-    XML_C14N_CREATE_STACK, /* 1952 */
-    XML_C14N_INVALID_NODE, /* 1953 */
-    XML_FTP_PASV_ANSWER = 2000,
-    XML_FTP_EPSV_ANSWER, /* 2001 */
-    XML_FTP_ACCNT, /* 2002 */
-    XML_HTTP_URL_SYNTAX = 2020,
-    XML_HTTP_USE_IP, /* 2021 */
-    XML_HTTP_UNKNOWN_HOST /* 2022 */
-} xmlParserErrors;
-

-
-
xmlGenericErrorFunc ()
void        (*xmlGenericErrorFunc)          (void *ctx,
-                                             const char *msg,
-                                             ...);

-Signature of the function to use when there is an error and
-no parsing or validity context available .

-
-
ctx:  a parsing context
-
msg:  the message
-
...:  the extra arguments of the varags to format the message
-
xmlStructuredErrorFunc ()
void        (*xmlStructuredErrorFunc)       (void *userData,
-                                             xmlErrorPtr error);

-Signature of the function to use when there is an error and
-the module handles the new error reporting mechanism.

-
-
userData:  user provided data for the error callback
-
error:  the error being raised.
-
xmlSetGenericErrorFunc ()
void        xmlSetGenericErrorFunc          (void *ctx,
-                                             xmlGenericErrorFunc handler);

-Function to reset the handler and the error context for out of
-context error messages.
-This simply means that handler will be called for subsequent
-error messages while not parsing nor validating. And ctx will
-be passed as first argument to handler
-One can simply force messages to be emitted to another FILE * than
-stderr by setting ctx to this file handle and handler to NULL.

-
-
ctx:  the new error handling context
-
handler:  the new handler function
-
initGenericErrorDefaultFunc ()
void        initGenericErrorDefaultFunc     (xmlGenericErrorFunc *handler);

-Set or reset (if NULL) the default handler for generic errors
-to the builtin error function.

-
-
handler:  the handler
-
xmlSetStructuredErrorFunc ()
void        xmlSetStructuredErrorFunc       (void *ctx,
-                                             xmlStructuredErrorFunc handler);

-Function to reset the handler and the error context for out of
-context structured error messages.
-This simply means that handler will be called for subsequent
-error messages while not parsing nor validating. And ctx will
-be passed as first argument to handler

-
-
ctx:  the new error handling context
-
handler:  the new handler function
-
xmlParserError ()
void        xmlParserError                  (void *ctx,
-                                             const char *msg,
-                                             ...);

-This is an error that the XML (or HTML) parser can generate

-
-
ctx:
-
msg:
-
...:
-
-
-
xmlParserWarning ()
void        xmlParserWarning                (void *ctx,
-                                             const char *msg,
-                                             ...);

-Display and format a warning messages, gives file, line, position and
-extra parameters.

-
-
ctx:  an XML parser context
-
msg:  the message to display/transmit
-
...:  extra parameters for the message display
-
xmlParserValidityError ()
void        xmlParserValidityError          (void *ctx,
-                                             const char *msg,
-                                             ...);

-Display and format an validity error messages, gives file,
-line, position and extra parameters.

-
-
ctx:  an XML parser context
-
msg:  the message to display/transmit
-
...:  extra parameters for the message display
-
xmlParserValidityWarning ()
void        xmlParserValidityWarning        (void *ctx,
-                                             const char *msg,
-                                             ...);

-Display and format a validity warning messages, gives file, line,
-position and extra parameters.

-
-
ctx:  an XML parser context
-
msg:  the message to display/transmit
-
...:  extra parameters for the message display
-
xmlParserPrintFileInfo ()
void        xmlParserPrintFileInfo          (xmlParserInputPtr input);

-Displays the associated file and line informations for the current input

-
-
input:  an xmlParserInputPtr input
-
xmlParserPrintFileContext ()
void        xmlParserPrintFileContext       (xmlParserInputPtr input);

-Displays current context within the input content for error tracking

-
-
input:  an xmlParserInputPtr input
-
xmlGetLastError ()
xmlErrorPtr xmlGetLastError                 (void);

-Get the last global error registered. This is per thread if compiled
-with thread support.

-
-
Returns :NULL if no error occured or a pointer to the error
-
xmlResetLastError ()
void        xmlResetLastError               (void);

-Cleanup the last global error registered. For parsing error
-this does not change the well-formedness result.

-
-
xmlCtxtGetLastError ()
xmlErrorPtr xmlCtxtGetLastError             (void *ctx);

-Get the last parsing error registered.

-
-
ctx:  an XML parser context
-
Returns :NULL if no error occured or a pointer to the error
-
xmlCtxtResetLastError ()
void        xmlCtxtResetLastError           (void *ctx);

-Cleanup the last global error registered. For parsing error
-this does not change the well-formedness result.

-
-
ctx:  an XML parser context
-
xmlResetError ()
void        xmlResetError                   (xmlErrorPtr err);

-Cleanup the error.

-
-
err: pointer to the error.
-
xmlCopyError ()
int         xmlCopyError                    (xmlErrorPtr from,
-                                             xmlErrorPtr to);

-Save the original error to the new place.

-
-
from:  a source error
-
to:  a target error
-
Returns :0 in case of success and -1 in case of error.
-
<< c14nxmlwin32version >>

+
void	xmlResetLastError	(void)

+
void	xmlCtxtResetLastError	(void * ctx)

+
xmlErrorPtr	xmlCtxtGetLastError	(void * ctx)

+
int	xmlCopyError	(xmlErrorPtr from, 
				 xmlErrorPtr to)

+
Function type: xmlGenericErrorFunc
+void	xmlGenericErrorFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
Signature of the function to use when there is an error and no parsing or validity context available .
ctx:a parsing context
msg:the message
...:the extra arguments of the varags to format the message


+
Description

+
Function: xmlParserWarning
void	xmlParserWarning	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
Display and format a warning messages, gives file, line, position and extra parameters.

+
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display

+      Signature of the function to use when there is an error and the module handles the new error reporting mechanism.
+      
+      
+      
+    
Function: xmlParserValidityError
void	xmlParserValidityError	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
Display and format an validity error messages, gives file, line, position and extra parameters.

+
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display
Function: xmlParserValidityWarning
void	xmlParserValidityWarning	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
Display and format a validity warning messages, gives file, line, position and extra parameters.

+
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display
Function: xmlSetGenericErrorFunc
void	xmlSetGenericErrorFunc	(void * ctx, 
				 xmlGenericErrorFunc handler)

+
Function to reset the handler and the error context for out of context error messages. This simply means that @handler will be called for subsequent error messages while not parsing nor validating. And @ctx will be passed as first argument to @handler One can simply force messages to be emitted to another FILE * than stderr by setting @ctx to this file handle and @handler to NULL.

+
ctx:the new error handling context
handler:the new handler function
Function: xmlParserPrintFileContext
void	xmlParserPrintFileContext	(xmlParserInputPtr input)

+
Displays current context within the input content for error tracking

+
input:an xmlParserInputPtr input

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: initGenericErrorDefaultFunc
void	initGenericErrorDefaultFunc	(xmlGenericErrorFunc * handler)

+
Set or reset (if NULL) the default handler for generic errors to the builtin error function.

+
handler:the handler
Function: xmlParserPrintFileInfo
void	xmlParserPrintFileInfo	(xmlParserInputPtr input)

+
Displays the associated file and line informations for the current input

+
input:an xmlParserInputPtr input
Function: xmlGetLastError
xmlErrorPtr	xmlGetLastError	(void)

+
Get the last global error registered. This is per thread if compiled with thread support.

+
Returns:NULL if no error occured or a pointer to the error
Function: xmlParserError
void	xmlParserError	(void * ctx, 
				 const char * msg, 
				 ... ...)

+
Display and format an error messages, gives file, line, position and extra parameters.

+
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display
Function: xmlSetStructuredErrorFunc
void	xmlSetStructuredErrorFunc	(void * ctx, 
				 xmlStructuredErrorFunc handler)

+
Function to reset the handler and the error context for out of context structured error messages. This simply means that @handler will be called for subsequent error messages while not parsing nor validating. And @ctx will be passed as first argument to @handler

+
ctx:the new error handling context
handler:the new handler function
Function: xmlResetError
void	xmlResetError	(xmlErrorPtr err)

+
Cleanup the error.

+
err:pointer to the error.
Function: xmlResetLastError
void	xmlResetLastError	(void)

+
Cleanup the last global error registered. For parsing error this does not change the well-formedness result.

+
Function: xmlCtxtResetLastError
void	xmlCtxtResetLastError	(void * ctx)

+
Cleanup the last global error registered. For parsing error this does not change the well-formedness result.

+
ctx:an XML parser context
Function: xmlCtxtGetLastError
xmlErrorPtr	xmlCtxtGetLastError	(void * ctx)

+
Get the last parsing error registered.

+
ctx:an XML parser context
Returns:NULL if no error occured or a pointer to the error
Function: xmlCopyError
int	xmlCopyError	(xmlErrorPtr from, 
				 xmlErrorPtr to)

+
Save the original error to the new place.

+
from:a source error
to:a target error
Returns:0 in case of success and -1 in case of error.

+      Signature of the function to use when there is an error and no parsing or validity context available .
+      
+      
+      
+      
+    
Daniel Veillard

diff --git a/doc/html/libxml-xmlexports.html b/doc/html/libxml-xmlexports.html
index cbe47c1a..a4183ad3 100644
--- a/doc/html/libxml-xmlexports.html
+++ b/doc/html/libxml-xmlexports.html
@@ -1,59 +1,26 @@
-xmlexports
PrevUpHomeGnome XML Library Reference ManualNext
xmlexports
xmlexports — 
Synopsis
+
+
+Module xmlexports from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlexports from libxml2
Main Menu
Related links
Table of Contents
#define XMLCALL
 
+
#define _REENTRANT
 
+
#define XMLPUBFUN
 
-#define     XMLPUBFUN
-#define     XMLPUBVAR
-#define     LIBXML_DLL_IMPORT
-
Description

+
#define XMLPUBVAR
 
-
Details
XMLPUBFUN
#define     XMLPUBFUN

-Macros which declare an exportable function

+
#define LIBXML_DLL_IMPORT
 
-
XMLPUBVAR
#define     XMLPUBVAR

-Macros which declare an exportable variable

-
-
LIBXML_DLL_IMPORT
#define     LIBXML_DLL_IMPORT

-Used on Windows (MS C compiler only) to declare a variable as 
-imported from the library. This macro should be empty when compiling
-libxml itself. It should expand to __declspec(dllimport)
-when the client code includes this header, and that only if the client
-links dynamically against libxml.
-For this to work, we need three macros. One tells us which compiler is
-being used and luckily the compiler defines such a thing: _MSC_VER. The
-second macro tells us if we are compiling libxml or the client code and
-we define the macro IN_LIBXML on the compiler's command line for this 
-purpose. The third macro, LIBXML_STATIC, must be defined by any client 
-code which links against libxml statically.

-
-
<< xmlunicodexinclude >>

+
Description

+
Macro: XMLCALL
#define XMLCALL
Macros which declare the called convention for exported functions Windows platform with MS compiler Windows platform with Borland compiler Windows platform with GNU compiler (Mingw) Cygwin platform, GNU compiler

+
Macro: _REENTRANT
#define _REENTRANT

+
Macro: XMLPUBFUN
#define XMLPUBFUN

+
Macro: XMLPUBVAR
#define XMLPUBVAR

+
Macro: LIBXML_DLL_IMPORT
#define LIBXML_DLL_IMPORT

+
Daniel Veillard

diff --git a/doc/html/libxml-xmlmemory.html b/doc/html/libxml-xmlmemory.html
index 9e2fd5ba..d04fcb66 100644
--- a/doc/html/libxml-xmlmemory.html
+++ b/doc/html/libxml-xmlmemory.html
@@ -1,270 +1,102 @@
-xmlmemory
PrevUpHomeGnome XML Library Reference ManualNext
xmlmemory
xmlmemory — 
Synopsis
+
+
+Module xmlmemory from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlmemory from libxml2
Main Menu
Related links
Table of Contents
void *	xmlMemRealloc	(void * ptr, 
				 size_t size)

+
void *	xmlReallocLoc	(void * ptr, 
				 size_t size, 
				 const char * file, 
				 int line)

+
int	xmlGcMemGet	(xmlFreeFunc * freeFunc, 
				 xmlMallocFunc * mallocFunc, 
				 xmlMallocFunc * mallocAtomicFunc, 
				 xmlReallocFunc * reallocFunc, 
				 xmlStrdupFunc * strdupFunc)

+
Function type: xmlStrdupFunc
+char *	xmlStrdupFunc	(const char * str)
+
Signature for an strdup() implementation.
str:a zero terminated string
Returns:the copy of the string or NULL in case of error.


+
Function type: xmlFreeFunc
+void	xmlFreeFunc	(void * mem)
+
Signature for a free() implementation.
mem:an already allocated block of memory


+
int	xmlInitMemory	(void)

+
Variable xmlStrdupFunc xmlMemStrdup
 
+
Variable xmlReallocFunc xmlRealloc
 
+
void	xmlMemFree	(void * ptr)

+
int	xmlMemGet	(xmlFreeFunc * freeFunc, 
				 xmlMallocFunc * mallocFunc, 
				 xmlReallocFunc * reallocFunc, 
				 xmlStrdupFunc * strdupFunc)

+
void *	xmlMallocAtomicLoc	(size_t size, 
				 const char * file, 
				 int line)

+
void *	xmlMemMalloc	(size_t size)

+
void	xmlMemDisplay	(FILE * fp)

+
int	xmlMemUsed	(void)

+
int	xmlMemSetup	(xmlFreeFunc freeFunc, 
				 xmlMallocFunc mallocFunc, 
				 xmlReallocFunc reallocFunc, 
				 xmlStrdupFunc strdupFunc)

+
Variable xmlMallocFunc xmlMallocAtomic
 
-#define     DEBUG_MEMORY
-void        (*xmlFreeFunc)                  (void *mem);
-void*       (*xmlMallocFunc)                (size_t size);
-void*       (*xmlReallocFunc)               (void *mem,
-                                             size_t size);
-char*       (*xmlStrdupFunc)                (const char *str);
-int         xmlMemSetup                     (xmlFreeFunc freeFunc,
-                                             xmlMallocFunc mallocFunc,
-                                             xmlReallocFunc reallocFunc,
-                                             xmlStrdupFunc strdupFunc);
-int         xmlMemGet                       (xmlFreeFunc *freeFunc,
-                                             xmlMallocFunc *mallocFunc,
-                                             xmlReallocFunc *reallocFunc,
-                                             xmlStrdupFunc *strdupFunc);
-int         xmlGcMemSetup                   (xmlFreeFunc freeFunc,
-                                             xmlMallocFunc mallocFunc,
-                                             xmlMallocFunc mallocAtomicFunc,
-                                             xmlReallocFunc reallocFunc,
-                                             xmlStrdupFunc strdupFunc);
-int         xmlGcMemGet                     (xmlFreeFunc *freeFunc,
-                                             xmlMallocFunc *mallocFunc,
-                                             xmlMallocFunc *mallocAtomicFunc,
-                                             xmlReallocFunc *reallocFunc,
-                                             xmlStrdupFunc *strdupFunc);
-int         xmlInitMemory                   (void);
-int         xmlMemUsed                      (void);
-void        xmlMemDisplay                   (FILE *fp);
-void        xmlMemShow                      (FILE *fp,
-                                             int nr);
-void        xmlMemoryDump                   (void);
-void*       xmlMemMalloc                    (size_t size);
-void*       xmlMemRealloc                   (void *ptr,
-                                             size_t size);
-void        xmlMemFree                      (void *ptr);
-char*       xmlMemoryStrdup                 (const char *str);
-void*       xmlMallocLoc                    (size_t size,
-                                             const char *file,
-                                             int line);
-void*       xmlReallocLoc                   (void *ptr,
-                                             size_t size,
-                                             const char *file,
-                                             int line);
-void*       xmlMallocAtomicLoc              (size_t size,
-                                             const char *file,
-                                             int line);
-char*       xmlMemStrdupLoc                 (const char *str,
-                                             const char *file,
-                                             int line);
-#define     xmlMalloc                       (size)
-#define     xmlMallocAtomic                 (size)
-#define     xmlRealloc                      (ptr, size)
-#define     xmlMemStrdup                    (str)
-
Description

+
void	xmlMemoryDump	(void)

+
void *	xmlMallocLoc	(size_t size, 
				 const char * file, 
				 int line)

+
void	xmlMemShow	(FILE * fp, 
				 int nr)

+
Function type: xmlReallocFunc
+void *	xmlReallocFunc	(void * mem, 
				 size_t size)
+
Signature for a realloc() implementation.
mem:an already allocated block of memory
size:the new size requested in bytes
Returns:a pointer to the newly reallocated block or NULL in case of error.


+
Variable xmlMallocFunc xmlMalloc
 
-
Details
DEBUG_MEMORY
#define DEBUG_MEMORY
-

-DEBUG_MEMORY replaces the allocator with a collect and debug
-shell to the libc allocator.
-DEBUG_MEMORY should only be activated when debugging 
-libxml i.e. if libxml has been configured with --with-debug-mem too.

+
Function type: xmlMallocFunc
+void *	xmlMallocFunc	(size_t size)
+
Signature for a malloc() implementation.
size:the size requested in bytes
Returns:a pointer to the newly allocated block or NULL in case of error.


+
#define DEBUG_MEMORY
 
-
xmlFreeFunc ()
void        (*xmlFreeFunc)                  (void *mem);

-Signature for a free() implementation.

-
-
mem: an already allocated block of memory
-
xmlMallocFunc ()
void*       (*xmlMallocFunc)                (size_t size);

-Signature for a malloc() implementation.

-
-
size:  the size requested in bytes
-
xmlReallocFunc ()
void*       (*xmlReallocFunc)               (void *mem,
-                                             size_t size);

-Signature for a realloc() implementation.

-
-
mem: an already allocated block of memory
-
size:  the new size requested in bytes
-
xmlStrdupFunc ()
char*       (*xmlStrdupFunc)                (const char *str);

-Signature for an strdup() implementation.

-
-
str: a zero terminated string
-
Returns :the copy of the string or NULL in case of error.
-
xmlMemSetup ()
int         xmlMemSetup                     (xmlFreeFunc freeFunc,
-                                             xmlMallocFunc mallocFunc,
-                                             xmlReallocFunc reallocFunc,
-                                             xmlStrdupFunc strdupFunc);

-Override the default memory access functions with a new set
-This has to be called before any other libxml routines !
-

-Should this be blocked if there was already some allocations
-done ?

-
-
freeFunc: the free() function to use
-
mallocFunc: the malloc() function to use
-
reallocFunc: the realloc() function to use
-
strdupFunc: the strdup() function to use
-
Returns :0 on success
-
xmlMemGet ()
int         xmlMemGet                       (xmlFreeFunc *freeFunc,
-                                             xmlMallocFunc *mallocFunc,
-                                             xmlReallocFunc *reallocFunc,
-                                             xmlStrdupFunc *strdupFunc);

-Provides the memory access functions set currently in use

-
-
freeFunc: place to save the free() function in use
-
mallocFunc: place to save the malloc() function in use
-
reallocFunc: place to save the realloc() function in use
-
strdupFunc: place to save the strdup() function in use
-
Returns :0 on success
-
xmlGcMemSetup ()
int         xmlGcMemSetup                   (xmlFreeFunc freeFunc,
-                                             xmlMallocFunc mallocFunc,
-                                             xmlMallocFunc mallocAtomicFunc,
-                                             xmlReallocFunc reallocFunc,
-                                             xmlStrdupFunc strdupFunc);

-Override the default memory access functions with a new set
-This has to be called before any other libxml routines !
-The mallocAtomicFunc is specialized for atomic block
-allocations (i.e. of areas  useful for garbage collected memory allocators
-

-Should this be blocked if there was already some allocations
-done ?

-
-
freeFunc: the free() function to use
-
mallocFunc: the malloc() function to use
-
mallocAtomicFunc: the malloc() function to use for atomic allocations
-
reallocFunc: the realloc() function to use
-
strdupFunc: the strdup() function to use
-
Returns :0 on success
-
xmlGcMemGet ()
int         xmlGcMemGet                     (xmlFreeFunc *freeFunc,
-                                             xmlMallocFunc *mallocFunc,
-                                             xmlMallocFunc *mallocAtomicFunc,
-                                             xmlReallocFunc *reallocFunc,
-                                             xmlStrdupFunc *strdupFunc);

-Provides the memory access functions set currently in use
-The mallocAtomicFunc is specialized for atomic block
-allocations (i.e. of areas  useful for garbage collected memory allocators

-
-
freeFunc: place to save the free() function in use
-
mallocFunc: place to save the malloc() function in use
-
mallocAtomicFunc: place to save the atomic malloc() function in use
-
reallocFunc: place to save the realloc() function in use
-
strdupFunc: place to save the strdup() function in use
-
Returns :0 on success
-
xmlInitMemory ()
int         xmlInitMemory                   (void);

-Initialize the memory layer.

-
-
Returns :0 on success
-
xmlMemUsed ()
int         xmlMemUsed                      (void);

-Provides the amount of memory currently allocated

-
-
Returns :an int representing the amount of memory allocated.
-
xmlMemDisplay ()
void        xmlMemDisplay                   (FILE *fp);

-show in-extenso the memory blocks allocated

-
-
fp:  a FILE descriptor used as the output file, if NULL, the result is
-      written to the file .memorylist
-
xmlMemShow ()
void        xmlMemShow                      (FILE *fp,
-                                             int nr);

-show a show display of the memory allocated, and dump
-the nr last allocated areas which were not freed

-
-
fp:  a FILE descriptor used as the output file
-
nr:  number of entries to dump
-
xmlMemoryDump ()
void        xmlMemoryDump                   (void);

-Dump in-extenso the memory blocks allocated to the file .memorylist

-
-
xmlMemMalloc ()
void*       xmlMemMalloc                    (size_t size);

-a malloc() equivalent, with logging of the allocation info.

-
-
size:  an int specifying the size in byte to allocate.
-
xmlMemRealloc ()
void*       xmlMemRealloc                   (void *ptr,
-                                             size_t size);

-a realloc() equivalent, with logging of the allocation info.

-
-
ptr:  the initial memory block pointer
-
size:  an int specifying the size in byte to allocate.
-
xmlMemFree ()
void        xmlMemFree                      (void *ptr);

-a free() equivalent, with error checking.

-
-
ptr:  the memory block pointer
-
xmlMemoryStrdup ()
char*       xmlMemoryStrdup                 (const char *str);

-a strdup() equivalent, with logging of the allocation info.

-
-
str:  the initial string pointer
-
Returns :a pointer to the new string or NULL if allocation error occurred.
-
xmlMallocLoc ()
void*       xmlMallocLoc                    (size_t size,
-                                             const char *file,
-                                             int line);

-a malloc() equivalent, with logging of the allocation info.

-
-
size:  an int specifying the size in byte to allocate.
-
file:  the file name or NULL
-
line:  the line number
-
xmlReallocLoc ()
void*       xmlReallocLoc                   (void *ptr,
-                                             size_t size,
-                                             const char *file,
-                                             int line);

-a realloc() equivalent, with logging of the allocation info.

-
-
ptr:  the initial memory block pointer
-
size:  an int specifying the size in byte to allocate.
-
file:  the file name or NULL
-
line:  the line number
-
xmlMallocAtomicLoc ()
void*       xmlMallocAtomicLoc              (size_t size,
-                                             const char *file,
-                                             int line);

-a malloc() equivalent, with logging of the allocation info.

-
-
size:  an int specifying the size in byte to allocate.
-
file:  the file name or NULL
-
line:  the line number
-
xmlMemStrdupLoc ()
char*       xmlMemStrdupLoc                 (const char *str,
-                                             const char *file,
-                                             int line);

-a strdup() equivalent, with logging of the allocation info.

-
-
str:  the initial string pointer
-
file:  the file name or NULL
-
line:  the line number
-
Returns :a pointer to the new string or NULL if allocation error occurred.
-
xmlMalloc()
#define     xmlMalloc(size)

-Wrapper for the malloc() function used in the XML library.

-
-
size:  number of bytes to allocate
-
xmlMallocAtomic()
#define     xmlMallocAtomic(size)

-Wrapper for the malloc() function used in the XML library for allocation
-of block not containing pointers to other areas.

-
-
size:  number of bytes to allocate
-
xmlRealloc()
#define     xmlRealloc(ptr, size)

-Wrapper for the realloc() function used in the XML library.

-
-
ptr:  pointer to the existing allocated area
-
size:  number of bytes to allocate
-
xmlMemStrdup()
#define     xmlMemStrdup(str)

-Wrapper for the strdup() function, xmlStrdup() is usually preferred.

-
-
str:  pointer to the existing string
-
<< xmlregexpxmlIO >>

+
int	xmlGcMemSetup	(xmlFreeFunc freeFunc, 
				 xmlMallocFunc mallocFunc, 
				 xmlMallocFunc mallocAtomicFunc, 
				 xmlReallocFunc reallocFunc, 
				 xmlStrdupFunc strdupFunc)

+
char *	xmlMemoryStrdup	(const char * str)

+
char *	xmlMemStrdupLoc	(const char * str, 
				 const char * file, 
				 int line)

+
Description

+
Function: xmlMemRealloc
void *	xmlMemRealloc	(void * ptr, 
				 size_t size)

+
a realloc() equivalent, with logging of the allocation info.

+
ptr:the initial memory block pointer
size:an int specifying the size in byte to allocate.
Returns:a pointer to the allocated area or NULL in case of lack of memory.
Function: xmlReallocLoc
void *	xmlReallocLoc	(void * ptr, 
				 size_t size, 
				 const char * file, 
				 int line)

+
a realloc() equivalent, with logging of the allocation info.

+
ptr:the initial memory block pointer
size:an int specifying the size in byte to allocate.
file:the file name or NULL
line:the line number
Returns:a pointer to the allocated area or NULL in case of lack of memory.
Function: xmlGcMemGet
int	xmlGcMemGet	(xmlFreeFunc * freeFunc, 
				 xmlMallocFunc * mallocFunc, 
				 xmlMallocFunc * mallocAtomicFunc, 
				 xmlReallocFunc * reallocFunc, 
				 xmlStrdupFunc * strdupFunc)

+
Provides the memory access functions set currently in use The mallocAtomicFunc is specialized for atomic block allocations (i.e. of areas useful for garbage collected memory allocators

+
freeFunc:place to save the free() function in use
mallocFunc:place to save the malloc() function in use
mallocAtomicFunc:place to save the atomic malloc() function in use
reallocFunc:place to save the realloc() function in use
strdupFunc:place to save the strdup() function in use
Returns:0 on success

+      Signature for an strdup() implementation.
+      
+      
+    
+      Signature for a free() implementation.
+      
+      
+    
Function: xmlInitMemory
int	xmlInitMemory	(void)

+
Initialize the memory layer.

+
Returns:0 on success
Function: xmlMemFree
void	xmlMemFree	(void * ptr)

+
a free() equivalent, with error checking.

+
ptr:the memory block pointer
Function: xmlMemGet
int	xmlMemGet	(xmlFreeFunc * freeFunc, 
				 xmlMallocFunc * mallocFunc, 
				 xmlReallocFunc * reallocFunc, 
				 xmlStrdupFunc * strdupFunc)

+
Provides the memory access functions set currently in use

+
freeFunc:place to save the free() function in use
mallocFunc:place to save the malloc() function in use
reallocFunc:place to save the realloc() function in use
strdupFunc:place to save the strdup() function in use
Returns:0 on success
Function: xmlMallocAtomicLoc
void *	xmlMallocAtomicLoc	(size_t size, 
				 const char * file, 
				 int line)

+
a malloc() equivalent, with logging of the allocation info.

+
size:an int specifying the size in byte to allocate.
file:the file name or NULL
line:the line number
Returns:a pointer to the allocated area or NULL in case of lack of memory.
Function: xmlMemMalloc
void *	xmlMemMalloc	(size_t size)

+
a malloc() equivalent, with logging of the allocation info.

+
size:an int specifying the size in byte to allocate.
Returns:a pointer to the allocated area or NULL in case of lack of memory.
Function: xmlMemDisplay
void	xmlMemDisplay	(FILE * fp)

+
show in-extenso the memory blocks allocated

+
fp:a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist
Function: xmlMemUsed
int	xmlMemUsed	(void)

+
Provides the amount of memory currently allocated

+
Returns:an int representing the amount of memory allocated.
Function: xmlMemSetup
int	xmlMemSetup	(xmlFreeFunc freeFunc, 
				 xmlMallocFunc mallocFunc, 
				 xmlReallocFunc reallocFunc, 
				 xmlStrdupFunc strdupFunc)

+
Override the default memory access functions with a new set This has to be called before any other libxml routines ! Should this be blocked if there was already some allocations done ?

+
freeFunc:the free() function to use
mallocFunc:the malloc() function to use
reallocFunc:the realloc() function to use
strdupFunc:the strdup() function to use
Returns:0 on success
Function: xmlMemoryDump
void	xmlMemoryDump	(void)

+
Dump in-extenso the memory blocks allocated to the file .memorylist

+
Function: xmlMallocLoc
void *	xmlMallocLoc	(size_t size, 
				 const char * file, 
				 int line)

+
a malloc() equivalent, with logging of the allocation info.

+
size:an int specifying the size in byte to allocate.
file:the file name or NULL
line:the line number
Returns:a pointer to the allocated area or NULL in case of lack of memory.
Function: xmlMemShow
void	xmlMemShow	(FILE * fp, 
				 int nr)

+
show a show display of the memory allocated, and dump the @nr last allocated areas which were not freed

+
fp:a FILE descriptor used as the output file
nr:number of entries to dump

+      Signature for a realloc() implementation.
+      
+      
+      
+    
+      Signature for a malloc() implementation.
+      
+      
+    
Macro: DEBUG_MEMORY
#define DEBUG_MEMORY
DEBUG_MEMORY replaces the allocator with a collect and debug shell to the libc allocator. DEBUG_MEMORY should only be activated when debugging libxml i.e. if libxml has been configured with --with-debug-mem too. #define DEBUG_MEMORY_FREED #define DEBUG_MEMORY_LOCATION

+
Function: xmlGcMemSetup
int	xmlGcMemSetup	(xmlFreeFunc freeFunc, 
				 xmlMallocFunc mallocFunc, 
				 xmlMallocFunc mallocAtomicFunc, 
				 xmlReallocFunc reallocFunc, 
				 xmlStrdupFunc strdupFunc)

+
Override the default memory access functions with a new set This has to be called before any other libxml routines ! The mallocAtomicFunc is specialized for atomic block allocations (i.e. of areas useful for garbage collected memory allocators Should this be blocked if there was already some allocations done ?

+
freeFunc:the free() function to use
mallocFunc:the malloc() function to use
mallocAtomicFunc:the malloc() function to use for atomic allocations
reallocFunc:the realloc() function to use
strdupFunc:the strdup() function to use
Returns:0 on success
Function: xmlMemoryStrdup
char *	xmlMemoryStrdup	(const char * str)

+
a strdup() equivalent, with logging of the allocation info.

+
str:the initial string pointer
Returns:a pointer to the new string or NULL if allocation error occurred.
Function: xmlMemStrdupLoc
char *	xmlMemStrdupLoc	(const char * str, 
				 const char * file, 
				 int line)

+
a strdup() equivalent, with logging of the allocation info.

+
str:the initial string pointer
file:the file name or NULL
line:the line number
Returns:a pointer to the new string or NULL if allocation error occurred.
Daniel Veillard

diff --git a/doc/html/libxml-xmlreader.html b/doc/html/libxml-xmlreader.html
index afc58c34..40662bd3 100644
--- a/doc/html/libxml-xmlreader.html
+++ b/doc/html/libxml-xmlreader.html
@@ -1,803 +1,278 @@
-xmlreader
PrevUpHomeGnome XML Library Reference ManualNext
xmlreader
xmlreader — 
Synopsis
-
-
-
-enum        xmlParserProperties;
-enum        xmlParserSeverities;
-enum        xmlReaderTypes;
-struct      xmlTextReader;
-typedef     xmlTextReaderPtr;
-xmlTextReaderPtr xmlNewTextReader           (xmlParserInputBufferPtr input,
-                                             const char *URI);
-xmlTextReaderPtr xmlNewTextReaderFilename   (const char *URI);
-void        xmlFreeTextReader               (xmlTextReaderPtr reader);
-int         xmlTextReaderRead               (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderReadInnerXml       (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderReadOuterXml       (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderReadString         (xmlTextReaderPtr reader);
-int         xmlTextReaderReadAttributeValue (xmlTextReaderPtr reader);
-int         xmlTextReaderAttributeCount     (xmlTextReaderPtr reader);
-int         xmlTextReaderDepth              (xmlTextReaderPtr reader);
-int         xmlTextReaderHasAttributes      (xmlTextReaderPtr reader);
-int         xmlTextReaderHasValue           (xmlTextReaderPtr reader);
-int         xmlTextReaderIsDefault          (xmlTextReaderPtr reader);
-int         xmlTextReaderIsEmptyElement     (xmlTextReaderPtr reader);
-int         xmlTextReaderNodeType           (xmlTextReaderPtr reader);
-int         xmlTextReaderQuoteChar          (xmlTextReaderPtr reader);
-int         xmlTextReaderReadState          (xmlTextReaderPtr reader);
-const xmlChar* xmlTextReaderConstBaseUri    (xmlTextReaderPtr reader);
-const xmlChar* xmlTextReaderConstLocalName  (xmlTextReaderPtr reader);
-const xmlChar* xmlTextReaderConstName       (xmlTextReaderPtr reader);
-const xmlChar* xmlTextReaderConstNamespaceUri
-                                            (xmlTextReaderPtr reader);
-const xmlChar* xmlTextReaderConstPrefix     (xmlTextReaderPtr reader);
-const xmlChar* xmlTextReaderConstXmlLang    (xmlTextReaderPtr reader);
-const xmlChar* xmlTextReaderConstString     (xmlTextReaderPtr reader,
-                                             const xmlChar *str);
-const xmlChar* xmlTextReaderConstValue      (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderBaseUri            (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderLocalName          (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderName               (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderNamespaceUri       (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderPrefix             (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderXmlLang            (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderValue              (xmlTextReaderPtr reader);
-int         xmlTextReaderClose              (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderGetAttributeNo     (xmlTextReaderPtr reader,
-                                             int no);
-xmlChar*    xmlTextReaderGetAttribute       (xmlTextReaderPtr reader,
-                                             const xmlChar *name);
-xmlChar*    xmlTextReaderGetAttributeNs     (xmlTextReaderPtr reader,
-                                             const xmlChar *localName,
-                                             const xmlChar *namespaceURI);
-xmlParserInputBufferPtr xmlTextReaderGetRemainder
-                                            (xmlTextReaderPtr reader);
-xmlChar*    xmlTextReaderLookupNamespace    (xmlTextReaderPtr reader,
-                                             const xmlChar *prefix);
-int         xmlTextReaderMoveToAttributeNo  (xmlTextReaderPtr reader,
-                                             int no);
-int         xmlTextReaderMoveToAttribute    (xmlTextReaderPtr reader,
-                                             const xmlChar *name);
-int         xmlTextReaderMoveToAttributeNs  (xmlTextReaderPtr reader,
-                                             const xmlChar *localName,
-                                             const xmlChar *namespaceURI);
-int         xmlTextReaderMoveToFirstAttribute
-                                            (xmlTextReaderPtr reader);
-int         xmlTextReaderMoveToNextAttribute
-                                            (xmlTextReaderPtr reader);
-int         xmlTextReaderMoveToElement      (xmlTextReaderPtr reader);
-int         xmlTextReaderNormalization      (xmlTextReaderPtr reader);
-int         xmlTextReaderSetParserProp      (xmlTextReaderPtr reader,
-                                             int prop,
-                                             int value);
-int         xmlTextReaderGetParserProp      (xmlTextReaderPtr reader,
-                                             int prop);
-xmlNodePtr  xmlTextReaderCurrentNode        (xmlTextReaderPtr reader);
-xmlNodePtr  xmlTextReaderPreserve           (xmlTextReaderPtr reader);
-xmlDocPtr   xmlTextReaderCurrentDoc         (xmlTextReaderPtr reader);
-xmlNodePtr  xmlTextReaderExpand             (xmlTextReaderPtr reader);
-int         xmlTextReaderNext               (xmlTextReaderPtr reader);
-int         xmlTextReaderNextSibling        (xmlTextReaderPtr reader);
-int         xmlTextReaderIsValid            (xmlTextReaderPtr reader);
-int         xmlTextReaderRelaxNGValidate    (xmlTextReaderPtr reader,
-                                             const char *rng);
-int         xmlTextReaderRelaxNGSetSchema   (xmlTextReaderPtr reader,
-                                             xmlRelaxNGPtr schema);
-xmlTextReaderPtr xmlReaderWalker            (xmlDocPtr doc);
-xmlTextReaderPtr xmlReaderForDoc            (const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlTextReaderPtr xmlReaderForFile           (const char *filename,
-                                             const char *encoding,
-                                             int options);
-xmlTextReaderPtr xmlReaderForMemory         (const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlTextReaderPtr xmlReaderForFd             (int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-xmlTextReaderPtr xmlReaderForIO             (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-int         xmlReaderNewWalker              (xmlTextReaderPtr reader,
-                                             xmlDocPtr doc);
-int         xmlReaderNewDoc                 (xmlTextReaderPtr reader,
-                                             const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-int         xmlReaderNewFile                (xmlTextReaderPtr reader,
-                                             const char *filename,
-                                             const char *encoding,
-                                             int options);
-int         xmlReaderNewMemory              (xmlTextReaderPtr reader,
-                                             const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-int         xmlReaderNewFd                  (xmlTextReaderPtr reader,
-                                             int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-int         xmlReaderNewIO                  (xmlTextReaderPtr reader,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);
-typedef     xmlTextReaderLocatorPtr;
-void        (*xmlTextReaderErrorFunc)       (void *arg,
-                                             const char *msg,
-                                             xmlParserSeverities severity,
-                                             xmlTextReaderLocatorPtr locator);
-int         xmlTextReaderLocatorLineNumber  (xmlTextReaderLocatorPtr locator);
-xmlChar*    xmlTextReaderLocatorBaseURI     (xmlTextReaderLocatorPtr locator);
-void        xmlTextReaderSetErrorHandler    (xmlTextReaderPtr reader,
-                                             xmlTextReaderErrorFunc f,
-                                             void *arg);
-void        xmlTextReaderGetErrorHandler    (xmlTextReaderPtr reader,
-                                             xmlTextReaderErrorFunc *f,
-                                             void **arg);
-
Description

-
-
Details
enum xmlParserProperties
typedef enum {
-    XML_PARSER_LOADDTD = 1,
-    XML_PARSER_DEFAULTATTRS = 2,
-    XML_PARSER_VALIDATE = 3,
-    XML_PARSER_SUBST_ENTITIES = 4
-} xmlParserProperties;
-

-
-
enum xmlParserSeverities
typedef enum {
-    XML_PARSER_SEVERITY_VALIDITY_WARNING = 1,
-    XML_PARSER_SEVERITY_VALIDITY_ERROR = 2,
-    XML_PARSER_SEVERITY_WARNING = 3,
-    XML_PARSER_SEVERITY_ERROR = 4
-} xmlParserSeverities;
-

-
-
enum xmlReaderTypes
typedef enum {
-    XML_READER_TYPE_NONE = 0,
-    XML_READER_TYPE_ELEMENT = 1,
-    XML_READER_TYPE_ATTRIBUTE = 2,
-    XML_READER_TYPE_TEXT = 3,
-    XML_READER_TYPE_CDATA = 4,
-    XML_READER_TYPE_ENTITY_REFERENCE = 5,
-    XML_READER_TYPE_ENTITY = 6,
-    XML_READER_TYPE_PROCESSING_INSTRUCTION = 7,
-    XML_READER_TYPE_COMMENT = 8,
-    XML_READER_TYPE_DOCUMENT = 9,
-    XML_READER_TYPE_DOCUMENT_TYPE = 10,
-    XML_READER_TYPE_DOCUMENT_FRAGMENT = 11,
-    XML_READER_TYPE_NOTATION = 12,
-    XML_READER_TYPE_WHITESPACE = 13,
-    XML_READER_TYPE_SIGNIFICANT_WHITESPACE = 14,
-    XML_READER_TYPE_END_ELEMENT = 15,
-    XML_READER_TYPE_END_ENTITY = 16,
-    XML_READER_TYPE_XML_DECLARATION = 17
-} xmlReaderTypes;
-

-
-
struct xmlTextReader
struct xmlTextReader;

-
-
xmlTextReaderPtr
typedef xmlTextReader *xmlTextReaderPtr;
-

-
-
xmlNewTextReader ()
xmlTextReaderPtr xmlNewTextReader           (xmlParserInputBufferPtr input,
-                                             const char *URI);

-Create an xmlTextReader structure fed with input

-
-
input: the xmlParserInputBufferPtr used to read data
-
URI: the URI information for the source if available
-
Returns :the new xmlTextReaderPtr or NULL in case of error
-
xmlNewTextReaderFilename ()
xmlTextReaderPtr xmlNewTextReaderFilename   (const char *URI);

-Create an xmlTextReader structure fed with the resource at URI

-
-
URI: the URI of the resource to process
-
Returns :the new xmlTextReaderPtr or NULL in case of error
-
xmlFreeTextReader ()
void        xmlFreeTextReader               (xmlTextReaderPtr reader);

-Deallocate all the resources associated to the reader

-
-
reader:  the xmlTextReaderPtr
-
xmlTextReaderRead ()
int         xmlTextReaderRead               (xmlTextReaderPtr reader);

-Moves the position of the current instance to the next node in
- the stream, exposing its properties.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 if the node was read successfully, 0 if there is no more
-         nodes to read, or -1 in case of error
-
xmlTextReaderReadInnerXml ()
xmlChar*    xmlTextReaderReadInnerXml       (xmlTextReaderPtr reader);

-Reads the contents of the current node, including child nodes and markup.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :a string containing the XML content, or NULL if the current node
-        is neither an element nor attribute, or has no child nodes. The 
-        string must be deallocated by the caller.
-
xmlTextReaderReadOuterXml ()
xmlChar*    xmlTextReaderReadOuterXml       (xmlTextReaderPtr reader);

-Reads the contents of the current node, including child nodes and markup.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :a string containing the XML content, or NULL if the current node
-        is neither an element nor attribute, or has no child nodes. The 
-        string must be deallocated by the caller.
-
xmlTextReaderReadString ()
xmlChar*    xmlTextReaderReadString         (xmlTextReaderPtr reader);

-Reads the contents of an element or a text node as a string.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :a string containing the contents of the Element or Text node,
-        or NULL if the reader is positioned on any other type of node.
-        The string must be deallocated by the caller.
-
xmlTextReaderReadAttributeValue ()
int         xmlTextReaderReadAttributeValue (xmlTextReaderPtr reader);

-Parses an attribute value into one or more Text and EntityReference nodes.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 in case of success, 0 if the reader was not positionned on an
-        ttribute node or all the attribute values have been read, or -1
-        in case of error.
-
xmlTextReaderAttributeCount ()
int         xmlTextReaderAttributeCount     (xmlTextReaderPtr reader);

-Provides the number of attributes of the current node

-
-
reader:  the xmlTextReaderPtr used
-
Returns :0 i no attributes, -1 in case of error or the attribute count
-
xmlTextReaderDepth ()
int         xmlTextReaderDepth              (xmlTextReaderPtr reader);

-The depth of the node in the tree.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the depth or -1 in case of error
-
xmlTextReaderHasAttributes ()
int         xmlTextReaderHasAttributes      (xmlTextReaderPtr reader);

-Whether the node has attributes.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 if true, 0 if false, and -1 in case or error
-
xmlTextReaderHasValue ()
int         xmlTextReaderHasValue           (xmlTextReaderPtr reader);

-Whether the node can have a text value.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 if true, 0 if false, and -1 in case or error
-
xmlTextReaderIsDefault ()
int         xmlTextReaderIsDefault          (xmlTextReaderPtr reader);

-Whether an Attribute  node was generated from the default value
-defined in the DTD or schema.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :0 if not defaulted, 1 if defaulted, and -1 in case of error
-
xmlTextReaderIsEmptyElement ()
int         xmlTextReaderIsEmptyElement     (xmlTextReaderPtr reader);

-Check if the current node is empty

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 if empty, 0 if not and -1 in case of error
-
xmlTextReaderNodeType ()
int         xmlTextReaderNodeType           (xmlTextReaderPtr reader);

-Get the node type of the current node
-Reference:
-http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the xmlNodeType of the current node or -1 in case of error
-
xmlTextReaderQuoteChar ()
int         xmlTextReaderQuoteChar          (xmlTextReaderPtr reader);

-The quotation mark character used to enclose the value of an attribute.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :" or ' and -1 in case of error
-
xmlTextReaderReadState ()
int         xmlTextReaderReadState          (xmlTextReaderPtr reader);

-Gets the read state of the reader.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the state value, or -1 in case of error
-
xmlTextReaderConstBaseUri ()
const xmlChar* xmlTextReaderConstBaseUri    (xmlTextReaderPtr reader);

-The base URI of the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the base URI or NULL if not available, the string
-        will be deallocated with the reader
-
xmlTextReaderConstLocalName ()
const xmlChar* xmlTextReaderConstLocalName  (xmlTextReaderPtr reader);

-The local name of the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the local name or NULL if not available, the
-        string will be deallocated with the reader.
-
xmlTextReaderConstName ()
const xmlChar* xmlTextReaderConstName       (xmlTextReaderPtr reader);

-The qualified name of the node, equal to Prefix :LocalName.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the local name or NULL if not available, the string is
-        deallocated with the reader.
-
xmlTextReaderConstNamespaceUri ()
const xmlChar* xmlTextReaderConstNamespaceUri
-                                            (xmlTextReaderPtr reader);

-The URI defining the namespace associated with the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the namespace URI or NULL if not available, the string
-        will be deallocated with the reader
-
xmlTextReaderConstPrefix ()
const xmlChar* xmlTextReaderConstPrefix     (xmlTextReaderPtr reader);

-A shorthand reference to the namespace associated with the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the prefix or NULL if not available, the string is deallocated
-        with the reader.
-
xmlTextReaderConstXmlLang ()
const xmlChar* xmlTextReaderConstXmlLang    (xmlTextReaderPtr reader);

-The xml:lang scope within which the node resides.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the xml:lang value or NULL if none exists.
-
xmlTextReaderConstString ()
const xmlChar* xmlTextReaderConstString     (xmlTextReaderPtr reader,
-                                             const xmlChar *str);

-Get an interned string from the reader, allows for example to
-speedup string name comparisons

-
-
reader:  the xmlTextReaderPtr used
-
str:  the string to intern.
-
Returns :an interned copy of the string or NULL in case of error. The
-        string will be deallocated with the reader.
-
xmlTextReaderConstValue ()
const xmlChar* xmlTextReaderConstValue      (xmlTextReaderPtr reader);

-Provides the text value of the node if present

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the string or NULL if not available. The result will be
-    deallocated on the next Read() operation.
-
xmlTextReaderBaseUri ()
xmlChar*    xmlTextReaderBaseUri            (xmlTextReaderPtr reader);

-The base URI of the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the base URI or NULL if not available
-
xmlTextReaderLocalName ()
xmlChar*    xmlTextReaderLocalName          (xmlTextReaderPtr reader);

-The local name of the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the local name or NULL if not available
-
xmlTextReaderName ()
xmlChar*    xmlTextReaderName               (xmlTextReaderPtr reader);

-The qualified name of the node, equal to Prefix :LocalName.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the local name or NULL if not available
-
xmlTextReaderNamespaceUri ()
xmlChar*    xmlTextReaderNamespaceUri       (xmlTextReaderPtr reader);

-The URI defining the namespace associated with the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the namespace URI or NULL if not available
-
xmlTextReaderPrefix ()
xmlChar*    xmlTextReaderPrefix             (xmlTextReaderPtr reader);

-A shorthand reference to the namespace associated with the node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the prefix or NULL if not available
-
xmlTextReaderXmlLang ()
xmlChar*    xmlTextReaderXmlLang            (xmlTextReaderPtr reader);

-The xml:lang scope within which the node resides.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the xml:lang value or NULL if none exists.
-
xmlTextReaderValue ()
xmlChar*    xmlTextReaderValue              (xmlTextReaderPtr reader);

-Provides the text value of the node if present

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the string or NULL if not available. The retsult must be deallocated
-    with xmlFree()
-
xmlTextReaderClose ()
int         xmlTextReaderClose              (xmlTextReaderPtr reader);

-This method releases any resources allocated by the current instance
-changes the state to Closed and close any underlying input.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :0 or -1 in case of error
-
xmlTextReaderGetAttributeNo ()
xmlChar*    xmlTextReaderGetAttributeNo     (xmlTextReaderPtr reader,
-                                             int no);

-Provides the value of the attribute with the specified index relative
-to the containing element.

-
-
reader:  the xmlTextReaderPtr used
-
no: the zero-based index of the attribute relative to the containing element
-
Returns :a string containing the value of the specified attribute, or NULL
-   in case of error. The string must be deallocated by the caller.
-
xmlTextReaderGetAttribute ()
xmlChar*    xmlTextReaderGetAttribute       (xmlTextReaderPtr reader,
-                                             const xmlChar *name);

-Provides the value of the attribute with the specified qualified name.

-
-
reader:  the xmlTextReaderPtr used
-
name: the qualified name of the attribute.
-
Returns :a string containing the value of the specified attribute, or NULL
-   in case of error. The string must be deallocated by the caller.
-
xmlTextReaderGetAttributeNs ()
xmlChar*    xmlTextReaderGetAttributeNs     (xmlTextReaderPtr reader,
-                                             const xmlChar *localName,
-                                             const xmlChar *namespaceURI);

-Provides the value of the specified attribute

-
-
reader:  the xmlTextReaderPtr used
-
localName: the local name of the attribute.
-
namespaceURI: the namespace URI of the attribute.
-
Returns :a string containing the value of the specified attribute, or NULL
-   in case of error. The string must be deallocated by the caller.
-
xmlTextReaderGetRemainder ()
xmlParserInputBufferPtr xmlTextReaderGetRemainder
-                                            (xmlTextReaderPtr reader);

-Method to get the remainder of the buffered XML. this method stops the
-parser, set its state to End Of File and return the input stream with
-what is left that the parser did not use.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the xmlParserInputBufferPtr attached to the XML or NULL
-   in case of error.
-
xmlTextReaderLookupNamespace ()
xmlChar*    xmlTextReaderLookupNamespace    (xmlTextReaderPtr reader,
-                                             const xmlChar *prefix);

-Resolves a namespace prefix in the scope of the current element.

-
-
reader:  the xmlTextReaderPtr used
-
prefix: the prefix whose namespace URI is to be resolved. To return
-         the default namespace, specify NULL
-
Returns :a string containing the namespace URI to which the prefix maps
-   or NULL in case of error. The string must be deallocated by the caller.
-
xmlTextReaderMoveToAttributeNo ()
int         xmlTextReaderMoveToAttributeNo  (xmlTextReaderPtr reader,
-                                             int no);

-Moves the position of the current instance to the attribute with
-the specified index relative to the containing element.

-
-
reader:  the xmlTextReaderPtr used
-
no: the zero-based index of the attribute relative to the containing
-     element.
-
Returns :1 in case of success, -1 in case of error, 0 if not found
-
xmlTextReaderMoveToAttribute ()
int         xmlTextReaderMoveToAttribute    (xmlTextReaderPtr reader,
-                                             const xmlChar *name);

-Moves the position of the current instance to the attribute with
-the specified qualified name.

-
-
reader:  the xmlTextReaderPtr used
-
name: the qualified name of the attribute.
-
Returns :1 in case of success, -1 in case of error, 0 if not found
-
xmlTextReaderMoveToAttributeNs ()
int         xmlTextReaderMoveToAttributeNs  (xmlTextReaderPtr reader,
-                                             const xmlChar *localName,
-                                             const xmlChar *namespaceURI);

-Moves the position of the current instance to the attribute with the
-specified local name and namespace URI.

-
-
reader:  the xmlTextReaderPtr used
-
localName:  the local name of the attribute.
-
namespaceURI:  the namespace URI of the attribute.
-
Returns :1 in case of success, -1 in case of error, 0 if not found
-
xmlTextReaderMoveToFirstAttribute ()
int         xmlTextReaderMoveToFirstAttribute
-                                            (xmlTextReaderPtr reader);

-Moves the position of the current instance to the first attribute
-associated with the current node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 in case of success, -1 in case of error, 0 if not found
-
xmlTextReaderMoveToNextAttribute ()
int         xmlTextReaderMoveToNextAttribute
-                                            (xmlTextReaderPtr reader);

-Moves the position of the current instance to the next attribute
-associated with the current node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 in case of success, -1 in case of error, 0 if not found
-
xmlTextReaderMoveToElement ()
int         xmlTextReaderMoveToElement      (xmlTextReaderPtr reader);

-Moves the position of the current instance to the node that
-contains the current Attribute  node.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 in case of success, -1 in case of error, 0 if not moved
-
xmlTextReaderNormalization ()
int         xmlTextReaderNormalization      (xmlTextReaderPtr reader);

-The value indicating whether to normalize white space and attribute values.
-Since attribute value and end of line normalizations are a MUST in the XML
-specification only the value true is accepted. The broken bahaviour of
-accepting out of range character entities like &0; is of course not
-supported either.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 or -1 in case of error.
-
xmlTextReaderSetParserProp ()
int         xmlTextReaderSetParserProp      (xmlTextReaderPtr reader,
-                                             int prop,
-                                             int value);

-Change the parser processing behaviour by changing some of its internal
-properties. Note that some properties can only be changed before any
-read has been done.

-
-
reader:  the xmlTextReaderPtr used
-
prop:  the xmlParserProperties to set
-
value:  usually 0 or 1 to (de)activate it
-
Returns :0 if the call was successful, or -1 in case of error
-
xmlTextReaderGetParserProp ()
int         xmlTextReaderGetParserProp      (xmlTextReaderPtr reader,
-                                             int prop);

-Read the parser internal property.

-
-
reader:  the xmlTextReaderPtr used
-
prop:  the xmlParserProperties to get
-
Returns :the value, usually 0 or 1, or -1 in case of error.
-
xmlTextReaderCurrentNode ()
xmlNodePtr  xmlTextReaderCurrentNode        (xmlTextReaderPtr reader);

-Hacking interface allowing to get the xmlNodePtr correponding to the
-current node being accessed by the xmlTextReader. This is dangerous
-because the underlying node may be destroyed on the next Reads.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the xmlNodePtr or NULL in case of error.
-
xmlTextReaderPreserve ()
xmlNodePtr  xmlTextReaderPreserve           (xmlTextReaderPtr reader);

-current node being accessed by the xmlTextReader. This is dangerous
-because the underlying node may be destroyed on the next Reads.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the xmlNodePtr or NULL in case of error.
-
xmlTextReaderCurrentDoc ()
xmlDocPtr   xmlTextReaderCurrentDoc         (xmlTextReaderPtr reader);

-Hacking interface allowing to get the xmlDocPtr correponding to the
-current document being accessed by the xmlTextReader. This is dangerous
-because the associated node may be destroyed on the next Reads.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the xmlDocPtr or NULL in case of error.
-
xmlTextReaderExpand ()
xmlNodePtr  xmlTextReaderExpand             (xmlTextReaderPtr reader);

-Reads the contents of the current node and the full subtree. It then makes
-the subtree available until the next xmlTextReaderRead() call

-
-
reader:  the xmlTextReaderPtr used
-
Returns :a node pointer valid until the next xmlTextReaderRead() call
-        or NULL in case of error.
-
xmlTextReaderNext ()
int         xmlTextReaderNext               (xmlTextReaderPtr reader);

-Skip to the node following the current one in document order while
-avoiding the subtree if any.

-
-
reader:  the xmlTextReaderPtr used
-
Returns :1 if the node was read successfully, 0 if there is no more
-         nodes to read, or -1 in case of error
-
xmlTextReaderNextSibling ()
int         xmlTextReaderNextSibling        (xmlTextReaderPtr reader);

-
-
reader:
-
Returns :
-
-
-
xmlTextReaderIsValid ()
int         xmlTextReaderIsValid            (xmlTextReaderPtr reader);

-Retrieve the validity status from the parser context

-
-
reader:  the xmlTextReaderPtr used
-
Returns :the flag value 1 if valid, 0 if no, and -1 in case of error
-
xmlTextReaderRelaxNGValidate ()
int         xmlTextReaderRelaxNGValidate    (xmlTextReaderPtr reader,
-                                             const char *rng);

-Use RelaxNG to validate the document as it is processed.
-Activation is only possible before the first Read().
-if rng is NULL, then RelaxNG validation is desactivated.

-
-
reader:  the xmlTextReaderPtr used
-
rng:  the path to a RelaxNG schema or NULL
-
Returns :0 in case the RelaxNG validation could be (des)activated and
-        -1 in case of error.
-
xmlTextReaderRelaxNGSetSchema ()
int         xmlTextReaderRelaxNGSetSchema   (xmlTextReaderPtr reader,
-                                             xmlRelaxNGPtr schema);

-Use RelaxNG to validate the document as it is processed.
-Activation is only possible before the first Read().
-if schema is NULL, then RelaxNG validation is desactivated.
- @ The schema should not be freed until the reader is deallocated
-or its use has been deactivated.

-
-
reader:  the xmlTextReaderPtr used
-
schema:  a precompiled RelaxNG schema
-
Returns :0 in case the RelaxNG validation could be (des)activated and
-        -1 in case of error.
-
xmlReaderWalker ()
xmlTextReaderPtr xmlReaderWalker            (xmlDocPtr doc);

-Create an xmltextReader for a preparsed document.

-
-
doc:  a preparsed document
-
Returns :the new reader or NULL in case of error.
-
xmlReaderForDoc ()
xmlTextReaderPtr xmlReaderForDoc            (const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Create an xmltextReader for an XML in-memory document.
-The parsing flags options are a combination of xmlParserOption(s).

-
-
cur:  a pointer to a zero terminated string
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the new reader or NULL in case of error.
-
xmlReaderForFile ()
xmlTextReaderPtr xmlReaderForFile           (const char *filename,
-                                             const char *encoding,
-                                             int options);

-parse an XML file from the filesystem or the network.
-The parsing flags options are a combination of xmlParserOption(s).

-
-
filename:  a file or URL
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the new reader or NULL in case of error.
-
xmlReaderForMemory ()
xmlTextReaderPtr xmlReaderForMemory         (const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Create an xmltextReader for an XML in-memory document.
-The parsing flags options are a combination of xmlParserOption(s).

-
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the new reader or NULL in case of error.
-
xmlReaderForFd ()
xmlTextReaderPtr xmlReaderForFd             (int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Create an xmltextReader for an XML from a file descriptor.
-The parsing flags options are a combination of xmlParserOption(s).

-
-
fd:  an open file descriptor
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the new reader or NULL in case of error.
-
xmlReaderForIO ()
xmlTextReaderPtr xmlReaderForIO             (xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Create an xmltextReader for an XML document from I/O functions and source.
-The parsing flags options are a combination of xmlParserOption(s).

-
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :the new reader or NULL in case of error.
-
xmlReaderNewWalker ()
int         xmlReaderNewWalker              (xmlTextReaderPtr reader,
-                                             xmlDocPtr doc);

-Setup an xmltextReader to parse a preparsed XML document.
-This reuses the existing reader xmlTextReader.

-
-
reader:  an XML reader
-
doc:  a preparsed document
-
Returns :0 in case of success and -1 in case of error
-
xmlReaderNewDoc ()
int         xmlReaderNewDoc                 (xmlTextReaderPtr reader,
-                                             const xmlChar *cur,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Setup an xmltextReader to parse an XML in-memory document.
-The parsing flags options are a combination of xmlParserOption(s).
-This reuses the existing reader xmlTextReader.

-
-
reader:  an XML reader
-
cur:  a pointer to a zero terminated string
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :0 in case of success and -1 in case of error
-
xmlReaderNewFile ()
int         xmlReaderNewFile                (xmlTextReaderPtr reader,
-                                             const char *filename,
-                                             const char *encoding,
-                                             int options);

-parse an XML file from the filesystem or the network.
-The parsing flags options are a combination of xmlParserOption(s).
-This reuses the existing reader xmlTextReader.

-
-
reader:  an XML reader
-
filename:  a file or URL
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :0 in case of success and -1 in case of error
-
xmlReaderNewMemory ()
int         xmlReaderNewMemory              (xmlTextReaderPtr reader,
-                                             const char *buffer,
-                                             int size,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Setup an xmltextReader to parse an XML in-memory document.
-The parsing flags options are a combination of xmlParserOption(s).
-This reuses the existing reader xmlTextReader.

-
-
reader:  an XML reader
-
buffer:  a pointer to a char array
-
size:  the size of the array
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :0 in case of success and -1 in case of error
-
xmlReaderNewFd ()
int         xmlReaderNewFd                  (xmlTextReaderPtr reader,
-                                             int fd,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Setup an xmltextReader to parse an XML from a file descriptor.
-The parsing flags options are a combination of xmlParserOption(s).
-This reuses the existing reader xmlTextReader.

-
-
reader:  an XML reader
-
fd:  an open file descriptor
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :0 in case of success and -1 in case of error
-
xmlReaderNewIO ()
int         xmlReaderNewIO                  (xmlTextReaderPtr reader,
-                                             xmlInputReadCallback ioread,
-                                             xmlInputCloseCallback ioclose,
-                                             void *ioctx,
-                                             const char *URL,
-                                             const char *encoding,
-                                             int options);

-Setup an xmltextReader to parse an XML document from I/O functions
-and source.
-The parsing flags options are a combination of xmlParserOption(s).
-This reuses the existing reader xmlTextReader.

-
-
reader:  an XML reader
-
ioread:  an I/O read function
-
ioclose:  an I/O close function
-
ioctx:  an I/O handler
-
URL:  the base URL to use for the document
-
encoding:  the document encoding, or NULL
-
options:  a combination of xmlParserOption(s)
-
Returns :0 in case of success and -1 in case of error
-
xmlTextReaderLocatorPtr
typedef void *  xmlTextReaderLocatorPtr;
-

-
-
xmlTextReaderErrorFunc ()
void        (*xmlTextReaderErrorFunc)       (void *arg,
-                                             const char *msg,
-                                             xmlParserSeverities severity,
-                                             xmlTextReaderLocatorPtr locator);

-
-
arg:
-
msg:
-
severity:
-
locator:
-
-
-
xmlTextReaderLocatorLineNumber ()
int         xmlTextReaderLocatorLineNumber  (xmlTextReaderLocatorPtr locator);

-Obtain the line number for the given locator.

-
-
locator: the xmlTextReaderLocatorPtr used
-
Returns :the line number or -1 in case of error.
-
xmlTextReaderLocatorBaseURI ()
xmlChar*    xmlTextReaderLocatorBaseURI     (xmlTextReaderLocatorPtr locator);

-Obtain the base URI for the given locator.

-
-
locator: the xmlTextReaderLocatorPtr used
-
Returns :the base URI or NULL in case of error.
-
xmlTextReaderSetErrorHandler ()
void        xmlTextReaderSetErrorHandler    (xmlTextReaderPtr reader,
-                                             xmlTextReaderErrorFunc f,
-                                             void *arg);

-Register a callback function that will be called on error and warnings.
-

-If f is NULL, the default error and warning handlers are restored.

-
-
reader:  the xmlTextReaderPtr used
-
f:	the callback function to call on error and warnings
-
arg:    a user argument to pass to the callback function
-
xmlTextReaderGetErrorHandler ()
void        xmlTextReaderGetErrorHandler    (xmlTextReaderPtr reader,
-                                             xmlTextReaderErrorFunc *f,
-                                             void **arg);

-Retrieve the error callback function and user argument.

-
-
reader:  the xmlTextReaderPtr used
-
f:	the callback function or NULL is no callback has been registered
-
arg:    a user argument
-
<< xincludedebugXML >>

+
+
+Module xmlreader from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlreader from libxml2
Main Menu
Related links
Table of Contents
xmlChar *	xmlTextReaderBaseUri	(xmlTextReaderPtr reader)

+
xmlTextReaderPtr	xmlNewTextReaderFilename	(const char * URI)

+
int	xmlTextReaderMoveToAttributeNo	(xmlTextReaderPtr reader, 
				 int no)

+
int	xmlTextReaderHasAttributes	(xmlTextReaderPtr reader)

+
int	xmlTextReaderLocatorLineNumber	(xmlTextReaderLocatorPtr locator)

+
int	xmlReaderNewIO	(xmlTextReaderPtr reader, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
int	xmlTextReaderMoveToAttributeNs	(xmlTextReaderPtr reader, 
				 const xmlChar * localName, 
				 const xmlChar * namespaceURI)

+
int	xmlTextReaderNext	(xmlTextReaderPtr reader)

+
xmlDocPtr	xmlTextReaderCurrentDoc	(xmlTextReaderPtr reader)

+
xmlTextReaderPtr	xmlReaderForFile	(const char * filename, 
				 const char * encoding, 
				 int options)

+
const xmlChar *	xmlTextReaderConstNamespaceUri	(xmlTextReaderPtr reader)

+
xmlChar *	xmlTextReaderValue	(xmlTextReaderPtr reader)

+
xmlNodePtr	xmlTextReaderExpand	(xmlTextReaderPtr reader)

+
int	xmlTextReaderAttributeCount	(xmlTextReaderPtr reader)

+
xmlChar *	xmlTextReaderXmlLang	(xmlTextReaderPtr reader)

+
xmlTextReaderPtr	xmlReaderForDoc	(const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Enum xmlParserProperties {
+    XML_PARSER_LOADDTD = 1
+    XML_PARSER_DEFAULTATTRS = 2
+    XML_PARSER_VALIDATE = 3
+    XML_PARSER_SUBST_ENTITIES = 4
+}
+
+
xmlChar *	xmlTextReaderLookupNamespace	(xmlTextReaderPtr reader, 
				 const xmlChar * prefix)

+
int	xmlTextReaderMoveToElement	(xmlTextReaderPtr reader)

+
int	xmlTextReaderClose	(xmlTextReaderPtr reader)

+
xmlChar *	xmlTextReaderReadInnerXml	(xmlTextReaderPtr reader)

+
xmlTextReaderPtr	xmlReaderForIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
xmlTextReaderPtr	xmlReaderForFd	(int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
xmlChar *	xmlTextReaderReadOuterXml	(xmlTextReaderPtr reader)

+
int	xmlTextReaderNormalization	(xmlTextReaderPtr reader)

+
int	xmlTextReaderGetParserProp	(xmlTextReaderPtr reader, 
				 int prop)

+
xmlChar *	xmlTextReaderPrefix	(xmlTextReaderPtr reader)

+
int	xmlTextReaderMoveToAttribute	(xmlTextReaderPtr reader, 
				 const xmlChar * name)

+
int	xmlTextReaderQuoteChar	(xmlTextReaderPtr reader)

+
int	xmlTextReaderNextSibling	(xmlTextReaderPtr reader)

+
xmlParserInputBufferPtr	xmlTextReaderGetRemainder	(xmlTextReaderPtr reader)

+
xmlChar *	xmlTextReaderReadString	(xmlTextReaderPtr reader)

+
int	xmlTextReaderIsValid	(xmlTextReaderPtr reader)

+
int	xmlTextReaderMoveToFirstAttribute	(xmlTextReaderPtr reader)

+
Typedef xmlTextReader * xmlTextReaderPtr
+
+
xmlChar *	xmlTextReaderGetAttribute	(xmlTextReaderPtr reader, 
				 const xmlChar * name)

+
const xmlChar *	xmlTextReaderConstValue	(xmlTextReaderPtr reader)

+
Typedef void * xmlTextReaderLocatorPtr
+
+
int	xmlReaderNewMemory	(xmlTextReaderPtr reader, 
				 const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
xmlChar *	xmlTextReaderGetAttributeNo	(xmlTextReaderPtr reader, 
				 int no)

+
xmlChar *	xmlTextReaderLocalName	(xmlTextReaderPtr reader)

+
xmlChar *	xmlTextReaderGetAttributeNs	(xmlTextReaderPtr reader, 
				 const xmlChar * localName, 
				 const xmlChar * namespaceURI)

+
const xmlChar *	xmlTextReaderConstName	(xmlTextReaderPtr reader)

+
xmlNodePtr	xmlTextReaderPreserve	(xmlTextReaderPtr reader)

+
int	xmlTextReaderReadState	(xmlTextReaderPtr reader)

+
xmlNodePtr	xmlTextReaderCurrentNode	(xmlTextReaderPtr reader)

+
const xmlChar *	xmlTextReaderConstString	(xmlTextReaderPtr reader, 
				 const xmlChar * str)

+
int	xmlTextReaderSetParserProp	(xmlTextReaderPtr reader, 
				 int prop, 
				 int value)

+
xmlTextReaderPtr	xmlNewTextReader	(xmlParserInputBufferPtr input, 
				 const char * URI)

+
int	xmlTextReaderDepth	(xmlTextReaderPtr reader)

+
Function type: xmlTextReaderErrorFunc
+void	xmlTextReaderErrorFunc	(void * arg, 
				 const char * msg, 
				 xmlParserSeverities severity, 
				 xmlTextReaderLocatorPtr locator)
+
arg:
msg:
severity:
locator:


+
void	xmlTextReaderSetErrorHandler	(xmlTextReaderPtr reader, 
				 xmlTextReaderErrorFunc f, 
				 void * arg)

+
Enum xmlParserSeverities {
+    XML_PARSER_SEVERITY_VALIDITY_WARNING = 1
+    XML_PARSER_SEVERITY_VALIDITY_ERROR = 2
+    XML_PARSER_SEVERITY_WARNING = 3
+    XML_PARSER_SEVERITY_ERROR = 4
+}
+
+
int	xmlTextReaderMoveToNextAttribute	(xmlTextReaderPtr reader)

+
int	xmlReaderNewWalker	(xmlTextReaderPtr reader, 
				 xmlDocPtr doc)

+
int	xmlReaderNewDoc	(xmlTextReaderPtr reader, 
				 const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
const xmlChar *	xmlTextReaderConstPrefix	(xmlTextReaderPtr reader)

+
xmlTextReaderPtr	xmlReaderWalker	(xmlDocPtr doc)

+
const xmlChar *	xmlTextReaderConstXmlLang	(xmlTextReaderPtr reader)

+
const xmlChar *	xmlTextReaderConstLocalName	(xmlTextReaderPtr reader)

+
int	xmlTextReaderNodeType	(xmlTextReaderPtr reader)

+
void	xmlTextReaderGetErrorHandler	(xmlTextReaderPtr reader, 
				 xmlTextReaderErrorFunc * f, 
				 void ** arg)

+
Enum xmlReaderTypes {
+    XML_READER_TYPE_NONE = 0
+    XML_READER_TYPE_ELEMENT = 1
+    XML_READER_TYPE_ATTRIBUTE = 2
+    XML_READER_TYPE_TEXT = 3
+    XML_READER_TYPE_CDATA = 4
+    XML_READER_TYPE_ENTITY_REFERENCE = 5
+    XML_READER_TYPE_ENTITY = 6
+    XML_READER_TYPE_PROCESSING_INSTRUCTION = 7
+    XML_READER_TYPE_COMMENT = 8
+    XML_READER_TYPE_DOCUMENT = 9
+    XML_READER_TYPE_DOCUMENT_TYPE = 10
+    XML_READER_TYPE_DOCUMENT_FRAGMENT = 11
+    XML_READER_TYPE_NOTATION = 12
+    XML_READER_TYPE_WHITESPACE = 13
+    XML_READER_TYPE_SIGNIFICANT_WHITESPACE = 14
+    XML_READER_TYPE_END_ELEMENT = 15
+    XML_READER_TYPE_END_ENTITY = 16
+    XML_READER_TYPE_XML_DECLARATION = 17
+}
+
+
int	xmlReaderNewFile	(xmlTextReaderPtr reader, 
				 const char * filename, 
				 const char * encoding, 
				 int options)

+
void	xmlFreeTextReader	(xmlTextReaderPtr reader)

+
int	xmlTextReaderIsDefault	(xmlTextReaderPtr reader)

+
xmlChar *	xmlTextReaderName	(xmlTextReaderPtr reader)

+
int	xmlReaderNewFd	(xmlTextReaderPtr reader, 
				 int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
int	xmlTextReaderRead	(xmlTextReaderPtr reader)

+
int	xmlTextReaderRelaxNGValidate	(xmlTextReaderPtr reader, 
				 const char * rng)

+
int	xmlTextReaderIsEmptyElement	(xmlTextReaderPtr reader)

+
xmlTextReaderPtr	xmlReaderForMemory	(const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Structure xmlTextReader
struct _xmlTextReader {
+The content of this structure is not made public by the API.
+}

xmlChar *	xmlTextReaderLocatorBaseURI	(xmlTextReaderLocatorPtr locator)

+
xmlChar *	xmlTextReaderNamespaceUri	(xmlTextReaderPtr reader)

+
int	xmlTextReaderRelaxNGSetSchema	(xmlTextReaderPtr reader, 
				 xmlRelaxNGPtr schema)

+
int	xmlTextReaderReadAttributeValue	(xmlTextReaderPtr reader)

+
int	xmlTextReaderHasValue	(xmlTextReaderPtr reader)

+
const xmlChar *	xmlTextReaderConstBaseUri	(xmlTextReaderPtr reader)

+
Description

+
Function: xmlTextReaderBaseUri
xmlChar *	xmlTextReaderBaseUri	(xmlTextReaderPtr reader)

+
The base URI of the node.

+
reader:the xmlTextReaderPtr used
Returns:the base URI or NULL if not available
Function: xmlNewTextReaderFilename
xmlTextReaderPtr	xmlNewTextReaderFilename	(const char * URI)

+
Create an xmlTextReader structure fed with the resource at @URI

+
URI:the URI of the resource to process
Returns:the new xmlTextReaderPtr or NULL in case of error
Function: xmlTextReaderMoveToAttributeNo
int	xmlTextReaderMoveToAttributeNo	(xmlTextReaderPtr reader, 
				 int no)

+
Moves the position of the current instance to the attribute with the specified index relative to the containing element.

+
reader:the xmlTextReaderPtr used
no:the zero-based index of the attribute relative to the containing element.
Returns:1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderHasAttributes
int	xmlTextReaderHasAttributes	(xmlTextReaderPtr reader)

+
Whether the node has attributes.

+
reader:the xmlTextReaderPtr used
Returns:1 if true, 0 if false, and -1 in case or error
Function: xmlTextReaderLocatorLineNumber
int	xmlTextReaderLocatorLineNumber	(xmlTextReaderLocatorPtr locator)

+
Obtain the line number for the given locator.

+
locator:the xmlTextReaderLocatorPtr used
Returns:the line number or -1 in case of error.
Function: xmlReaderNewIO
int	xmlReaderNewIO	(xmlTextReaderPtr reader, 
				 xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Setup an xmltextReader to parse an XML document from I/O functions and source. The parsing flags @options are a combination of xmlParserOption(s). This reuses the existing @reader xmlTextReader.

+
reader:an XML reader
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:0 in case of success and -1 in case of error
Function: xmlTextReaderMoveToAttributeNs
int	xmlTextReaderMoveToAttributeNs	(xmlTextReaderPtr reader, 
				 const xmlChar * localName, 
				 const xmlChar * namespaceURI)

+
Moves the position of the current instance to the attribute with the specified local name and namespace URI.

+
reader:the xmlTextReaderPtr used
localName:the local name of the attribute.
namespaceURI:the namespace URI of the attribute.
Returns:1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderNext
int	xmlTextReaderNext	(xmlTextReaderPtr reader)

+
Skip to the node following the current one in document order while avoiding the subtree if any.

+
reader:the xmlTextReaderPtr used
Returns:1 if the node was read successfully, 0 if there is no more nodes to read, or -1 in case of error
Function: xmlTextReaderCurrentDoc
xmlDocPtr	xmlTextReaderCurrentDoc	(xmlTextReaderPtr reader)

+
Hacking interface allowing to get the xmlDocPtr correponding to the current document being accessed by the xmlTextReader. NOTE: as a result of this call, the reader will not destroy the associated XML document and calling xmlFreeDoc() on the result is needed once the reader parsing has finished.

+
reader:the xmlTextReaderPtr used
Returns:the xmlDocPtr or NULL in case of error.
Function: xmlReaderForFile
xmlTextReaderPtr	xmlReaderForFile	(const char * filename, 
				 const char * encoding, 
				 int options)

+
parse an XML file from the filesystem or the network. The parsing flags @options are a combination of xmlParserOption(s).

+
filename:a file or URL
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the new reader or NULL in case of error.
Function: xmlTextReaderConstNamespaceUri
const xmlChar *	xmlTextReaderConstNamespaceUri	(xmlTextReaderPtr reader)

+
The URI defining the namespace associated with the node.

+
reader:the xmlTextReaderPtr used
Returns:the namespace URI or NULL if not available, the string will be deallocated with the reader
Function: xmlTextReaderValue
xmlChar *	xmlTextReaderValue	(xmlTextReaderPtr reader)

+
Provides the text value of the node if present

+
reader:the xmlTextReaderPtr used
Returns:the string or NULL if not available. The result must be deallocated with xmlFree()
Function: xmlTextReaderExpand
xmlNodePtr	xmlTextReaderExpand	(xmlTextReaderPtr reader)

+
Reads the contents of the current node and the full subtree. It then makes the subtree available until the next xmlTextReaderRead() call

+
reader:the xmlTextReaderPtr used
Returns:a node pointer valid until the next xmlTextReaderRead() call or NULL in case of error.
Function: xmlTextReaderAttributeCount
int	xmlTextReaderAttributeCount	(xmlTextReaderPtr reader)

+
Provides the number of attributes of the current node

+
reader:the xmlTextReaderPtr used
Returns:0 i no attributes, -1 in case of error or the attribute count
Function: xmlTextReaderXmlLang
xmlChar *	xmlTextReaderXmlLang	(xmlTextReaderPtr reader)

+
The xml:lang scope within which the node resides.

+
reader:the xmlTextReaderPtr used
Returns:the xml:lang value or NULL if none exists.
Function: xmlReaderForDoc
xmlTextReaderPtr	xmlReaderForDoc	(const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Create an xmltextReader for an XML in-memory document. The parsing flags @options are a combination of xmlParserOption(s).

+
cur:a pointer to a zero terminated string
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the new reader or NULL in case of error.
Function: xmlTextReaderLookupNamespace
xmlChar *	xmlTextReaderLookupNamespace	(xmlTextReaderPtr reader, 
				 const xmlChar * prefix)

+
Resolves a namespace prefix in the scope of the current element.

+
reader:the xmlTextReaderPtr used
prefix:the prefix whose namespace URI is to be resolved. To return the default namespace, specify NULL
Returns:a string containing the namespace URI to which the prefix maps or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderMoveToElement
int	xmlTextReaderMoveToElement	(xmlTextReaderPtr reader)

+
Moves the position of the current instance to the node that contains the current Attribute node.

+
reader:the xmlTextReaderPtr used
Returns:1 in case of success, -1 in case of error, 0 if not moved
Function: xmlTextReaderClose
int	xmlTextReaderClose	(xmlTextReaderPtr reader)

+
This method releases any resources allocated by the current instance changes the state to Closed and close any underlying input.

+
reader:the xmlTextReaderPtr used
Returns:0 or -1 in case of error
Function: xmlTextReaderReadInnerXml
xmlChar *	xmlTextReaderReadInnerXml	(xmlTextReaderPtr reader)

+
Reads the contents of the current node, including child nodes and markup.

+
reader:the xmlTextReaderPtr used
Returns:a string containing the XML content, or NULL if the current node is neither an element nor attribute, or has no child nodes. The string must be deallocated by the caller.
Function: xmlReaderForIO
xmlTextReaderPtr	xmlReaderForIO	(xmlInputReadCallback ioread, 
				 xmlInputCloseCallback ioclose, 
				 void * ioctx, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Create an xmltextReader for an XML document from I/O functions and source. The parsing flags @options are a combination of xmlParserOption(s).

+
ioread:an I/O read function
ioclose:an I/O close function
ioctx:an I/O handler
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the new reader or NULL in case of error.
Function: xmlReaderForFd
xmlTextReaderPtr	xmlReaderForFd	(int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Create an xmltextReader for an XML from a file descriptor. The parsing flags @options are a combination of xmlParserOption(s).

+
fd:an open file descriptor
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the new reader or NULL in case of error.
Function: xmlTextReaderReadOuterXml
xmlChar *	xmlTextReaderReadOuterXml	(xmlTextReaderPtr reader)

+
Reads the contents of the current node, including child nodes and markup.

+
reader:the xmlTextReaderPtr used
Returns:a string containing the XML content, or NULL if the current node is neither an element nor attribute, or has no child nodes. The string must be deallocated by the caller.
Function: xmlTextReaderNormalization
int	xmlTextReaderNormalization	(xmlTextReaderPtr reader)

+
The value indicating whether to normalize white space and attribute values. Since attribute value and end of line normalizations are a MUST in the XML specification only the value true is accepted. The broken bahaviour of accepting out of range character entities like &#0; is of course not supported either.

+
reader:the xmlTextReaderPtr used
Returns:1 or -1 in case of error.
Function: xmlTextReaderGetParserProp
int	xmlTextReaderGetParserProp	(xmlTextReaderPtr reader, 
				 int prop)

+
Read the parser internal property.

+
reader:the xmlTextReaderPtr used
prop:the xmlParserProperties to get
Returns:the value, usually 0 or 1, or -1 in case of error.
Function: xmlTextReaderPrefix
xmlChar *	xmlTextReaderPrefix	(xmlTextReaderPtr reader)

+
A shorthand reference to the namespace associated with the node.

+
reader:the xmlTextReaderPtr used
Returns:the prefix or NULL if not available
Function: xmlTextReaderMoveToAttribute
int	xmlTextReaderMoveToAttribute	(xmlTextReaderPtr reader, 
				 const xmlChar * name)

+
Moves the position of the current instance to the attribute with the specified qualified name.

+
reader:the xmlTextReaderPtr used
name:the qualified name of the attribute.
Returns:1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderQuoteChar
int	xmlTextReaderQuoteChar	(xmlTextReaderPtr reader)

+
The quotation mark character used to enclose the value of an attribute.

+
reader:the xmlTextReaderPtr used
Returns:" or ' and -1 in case of error
Function: xmlTextReaderNextSibling
int	xmlTextReaderNextSibling	(xmlTextReaderPtr reader)

+

+
reader:
Returns:
Function: xmlTextReaderGetRemainder
xmlParserInputBufferPtr	xmlTextReaderGetRemainder	(xmlTextReaderPtr reader)

+
Method to get the remainder of the buffered XML. this method stops the parser, set its state to End Of File and return the input stream with what is left that the parser did not use.

+
reader:the xmlTextReaderPtr used
Returns:the xmlParserInputBufferPtr attached to the XML or NULL in case of error.
Function: xmlTextReaderReadString
xmlChar *	xmlTextReaderReadString	(xmlTextReaderPtr reader)

+
Reads the contents of an element or a text node as a string.

+
reader:the xmlTextReaderPtr used
Returns:a string containing the contents of the Element or Text node, or NULL if the reader is positioned on any other type of node. The string must be deallocated by the caller.
Function: xmlTextReaderIsValid
int	xmlTextReaderIsValid	(xmlTextReaderPtr reader)

+
Retrieve the validity status from the parser context

+
reader:the xmlTextReaderPtr used
Returns:the flag value 1 if valid, 0 if no, and -1 in case of error
Function: xmlTextReaderMoveToFirstAttribute
int	xmlTextReaderMoveToFirstAttribute	(xmlTextReaderPtr reader)

+
Moves the position of the current instance to the first attribute associated with the current node.

+
reader:the xmlTextReaderPtr used
Returns:1 in case of success, -1 in case of error, 0 if not found
Function: xmlTextReaderGetAttribute
xmlChar *	xmlTextReaderGetAttribute	(xmlTextReaderPtr reader, 
				 const xmlChar * name)

+
Provides the value of the attribute with the specified qualified name.

+
reader:the xmlTextReaderPtr used
name:the qualified name of the attribute.
Returns:a string containing the value of the specified attribute, or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderConstValue
const xmlChar *	xmlTextReaderConstValue	(xmlTextReaderPtr reader)

+
Provides the text value of the node if present

+
reader:the xmlTextReaderPtr used
Returns:the string or NULL if not available. The result will be deallocated on the next Read() operation.
Function: xmlReaderNewMemory
int	xmlReaderNewMemory	(xmlTextReaderPtr reader, 
				 const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Setup an xmltextReader to parse an XML in-memory document. The parsing flags @options are a combination of xmlParserOption(s). This reuses the existing @reader xmlTextReader.

+
reader:an XML reader
buffer:a pointer to a char array
size:the size of the array
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:0 in case of success and -1 in case of error
Function: xmlTextReaderGetAttributeNo
xmlChar *	xmlTextReaderGetAttributeNo	(xmlTextReaderPtr reader, 
				 int no)

+
Provides the value of the attribute with the specified index relative to the containing element.

+
reader:the xmlTextReaderPtr used
no:the zero-based index of the attribute relative to the containing element
Returns:a string containing the value of the specified attribute, or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderLocalName
xmlChar *	xmlTextReaderLocalName	(xmlTextReaderPtr reader)

+
The local name of the node.

+
reader:the xmlTextReaderPtr used
Returns:the local name or NULL if not available
Function: xmlTextReaderGetAttributeNs
xmlChar *	xmlTextReaderGetAttributeNs	(xmlTextReaderPtr reader, 
				 const xmlChar * localName, 
				 const xmlChar * namespaceURI)

+
Provides the value of the specified attribute

+
reader:the xmlTextReaderPtr used
localName:the local name of the attribute.
namespaceURI:the namespace URI of the attribute.
Returns:a string containing the value of the specified attribute, or NULL in case of error. The string must be deallocated by the caller.
Function: xmlTextReaderConstName
const xmlChar *	xmlTextReaderConstName	(xmlTextReaderPtr reader)

+
The qualified name of the node, equal to Prefix :LocalName.

+
reader:the xmlTextReaderPtr used
Returns:the local name or NULL if not available, the string is deallocated with the reader.
Function: xmlTextReaderPreserve
xmlNodePtr	xmlTextReaderPreserve	(xmlTextReaderPtr reader)

+
current node being accessed by the xmlTextReader. This is dangerous because the underlying node may be destroyed on the next Reads.

+
reader:the xmlTextReaderPtr used
Returns:the xmlNodePtr or NULL in case of error.
Function: xmlTextReaderReadState
int	xmlTextReaderReadState	(xmlTextReaderPtr reader)

+
Gets the read state of the reader.

+
reader:the xmlTextReaderPtr used
Returns:the state value, or -1 in case of error
Function: xmlTextReaderCurrentNode
xmlNodePtr	xmlTextReaderCurrentNode	(xmlTextReaderPtr reader)

+
Hacking interface allowing to get the xmlNodePtr correponding to the current node being accessed by the xmlTextReader. This is dangerous because the underlying node may be destroyed on the next Reads.

+
reader:the xmlTextReaderPtr used
Returns:the xmlNodePtr or NULL in case of error.
Function: xmlTextReaderConstString
const xmlChar *	xmlTextReaderConstString	(xmlTextReaderPtr reader, 
				 const xmlChar * str)

+
Get an interned string from the reader, allows for example to speedup string name comparisons

+
reader:the xmlTextReaderPtr used
str:the string to intern.
Returns:an interned copy of the string or NULL in case of error. The string will be deallocated with the reader.
Function: xmlTextReaderSetParserProp
int	xmlTextReaderSetParserProp	(xmlTextReaderPtr reader, 
				 int prop, 
				 int value)

+
Change the parser processing behaviour by changing some of its internal properties. Note that some properties can only be changed before any read has been done.

+
reader:the xmlTextReaderPtr used
prop:the xmlParserProperties to set
value:usually 0 or 1 to (de)activate it
Returns:0 if the call was successful, or -1 in case of error
Function: xmlNewTextReader
xmlTextReaderPtr	xmlNewTextReader	(xmlParserInputBufferPtr input, 
				 const char * URI)

+
Create an xmlTextReader structure fed with @input

+
input:the xmlParserInputBufferPtr used to read data
URI:the URI information for the source if available
Returns:the new xmlTextReaderPtr or NULL in case of error
Function: xmlTextReaderDepth
int	xmlTextReaderDepth	(xmlTextReaderPtr reader)

+
The depth of the node in the tree.

+
reader:the xmlTextReaderPtr used
Returns:the depth or -1 in case of error

+      
+      
+      
+      
+      
+      
+    
Function: xmlTextReaderSetErrorHandler
void	xmlTextReaderSetErrorHandler	(xmlTextReaderPtr reader, 
				 xmlTextReaderErrorFunc f, 
				 void * arg)

+
Register a callback function that will be called on error and warnings. If @f is NULL, the default error and warning handlers are restored.

+
reader:the xmlTextReaderPtr used
f:the callback function to call on error and warnings
arg:a user argument to pass to the callback function
Function: xmlTextReaderMoveToNextAttribute
int	xmlTextReaderMoveToNextAttribute	(xmlTextReaderPtr reader)

+
Moves the position of the current instance to the next attribute associated with the current node.

+
reader:the xmlTextReaderPtr used
Returns:1 in case of success, -1 in case of error, 0 if not found
Function: xmlReaderNewWalker
int	xmlReaderNewWalker	(xmlTextReaderPtr reader, 
				 xmlDocPtr doc)

+
Setup an xmltextReader to parse a preparsed XML document. This reuses the existing @reader xmlTextReader.

+
reader:an XML reader
doc:a preparsed document
Returns:0 in case of success and -1 in case of error
Function: xmlReaderNewDoc
int	xmlReaderNewDoc	(xmlTextReaderPtr reader, 
				 const xmlChar * cur, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Setup an xmltextReader to parse an XML in-memory document. The parsing flags @options are a combination of xmlParserOption(s). This reuses the existing @reader xmlTextReader.

+
reader:an XML reader
cur:a pointer to a zero terminated string
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:0 in case of success and -1 in case of error
Function: xmlTextReaderConstPrefix
const xmlChar *	xmlTextReaderConstPrefix	(xmlTextReaderPtr reader)

+
A shorthand reference to the namespace associated with the node.

+
reader:the xmlTextReaderPtr used
Returns:the prefix or NULL if not available, the string is deallocated with the reader.
Function: xmlReaderWalker
xmlTextReaderPtr	xmlReaderWalker	(xmlDocPtr doc)

+
Create an xmltextReader for a preparsed document.

+
doc:a preparsed document
Returns:the new reader or NULL in case of error.
Function: xmlTextReaderConstXmlLang
const xmlChar *	xmlTextReaderConstXmlLang	(xmlTextReaderPtr reader)

+
The xml:lang scope within which the node resides.

+
reader:the xmlTextReaderPtr used
Returns:the xml:lang value or NULL if none exists.
Function: xmlTextReaderConstLocalName
const xmlChar *	xmlTextReaderConstLocalName	(xmlTextReaderPtr reader)

+
The local name of the node.

+
reader:the xmlTextReaderPtr used
Returns:the local name or NULL if not available, the string will be deallocated with the reader.
Function: xmlTextReaderNodeType
int	xmlTextReaderNodeType	(xmlTextReaderPtr reader)

+
Get the node type of the current node Reference: http://dotgnu.org/pnetlib-doc/System/Xml/XmlNodeType.html

+
reader:the xmlTextReaderPtr used
Returns:the xmlNodeType of the current node or -1 in case of error
Function: xmlTextReaderGetErrorHandler
void	xmlTextReaderGetErrorHandler	(xmlTextReaderPtr reader, 
				 xmlTextReaderErrorFunc * f, 
				 void ** arg)

+
Retrieve the error callback function and user argument.

+
reader:the xmlTextReaderPtr used
f:the callback function or NULL is no callback has been registered
arg:a user argument
Function: xmlReaderNewFile
int	xmlReaderNewFile	(xmlTextReaderPtr reader, 
				 const char * filename, 
				 const char * encoding, 
				 int options)

+
parse an XML file from the filesystem or the network. The parsing flags @options are a combination of xmlParserOption(s). This reuses the existing @reader xmlTextReader.

+
reader:an XML reader
filename:a file or URL
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:0 in case of success and -1 in case of error
Function: xmlFreeTextReader
void	xmlFreeTextReader	(xmlTextReaderPtr reader)

+
Deallocate all the resources associated to the reader

+
reader:the xmlTextReaderPtr
Function: xmlTextReaderIsDefault
int	xmlTextReaderIsDefault	(xmlTextReaderPtr reader)

+
Whether an Attribute node was generated from the default value defined in the DTD or schema.

+
reader:the xmlTextReaderPtr used
Returns:0 if not defaulted, 1 if defaulted, and -1 in case of error
Function: xmlTextReaderName
xmlChar *	xmlTextReaderName	(xmlTextReaderPtr reader)

+
The qualified name of the node, equal to Prefix :LocalName.

+
reader:the xmlTextReaderPtr used
Returns:the local name or NULL if not available
Function: xmlReaderNewFd
int	xmlReaderNewFd	(xmlTextReaderPtr reader, 
				 int fd, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Setup an xmltextReader to parse an XML from a file descriptor. The parsing flags @options are a combination of xmlParserOption(s). This reuses the existing @reader xmlTextReader.

+
reader:an XML reader
fd:an open file descriptor
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:0 in case of success and -1 in case of error
Function: xmlTextReaderRead
int	xmlTextReaderRead	(xmlTextReaderPtr reader)

+
Moves the position of the current instance to the next node in the stream, exposing its properties.

+
reader:the xmlTextReaderPtr used
Returns:1 if the node was read successfully, 0 if there is no more nodes to read, or -1 in case of error
Function: xmlTextReaderRelaxNGValidate
int	xmlTextReaderRelaxNGValidate	(xmlTextReaderPtr reader, 
				 const char * rng)

+
Use RelaxNG to validate the document as it is processed. Activation is only possible before the first Read(). if @rng is NULL, then RelaxNG validation is desactivated.

+
reader:the xmlTextReaderPtr used
rng:the path to a RelaxNG schema or NULL
Returns:0 in case the RelaxNG validation could be (des)activated and -1 in case of error.
Function: xmlTextReaderIsEmptyElement
int	xmlTextReaderIsEmptyElement	(xmlTextReaderPtr reader)

+
Check if the current node is empty

+
reader:the xmlTextReaderPtr used
Returns:1 if empty, 0 if not and -1 in case of error
Function: xmlReaderForMemory
xmlTextReaderPtr	xmlReaderForMemory	(const char * buffer, 
				 int size, 
				 const char * URL, 
				 const char * encoding, 
				 int options)

+
Create an xmltextReader for an XML in-memory document. The parsing flags @options are a combination of xmlParserOption(s).

+
buffer:a pointer to a char array
size:the size of the array
URL:the base URL to use for the document
encoding:the document encoding, or NULL
options:a combination of xmlParserOption(s)
Returns:the new reader or NULL in case of error.
Function: xmlTextReaderLocatorBaseURI
xmlChar *	xmlTextReaderLocatorBaseURI	(xmlTextReaderLocatorPtr locator)

+
Obtain the base URI for the given locator.

+
locator:the xmlTextReaderLocatorPtr used
Returns:the base URI or NULL in case of error.
Function: xmlTextReaderNamespaceUri
xmlChar *	xmlTextReaderNamespaceUri	(xmlTextReaderPtr reader)

+
The URI defining the namespace associated with the node.

+
reader:the xmlTextReaderPtr used
Returns:the namespace URI or NULL if not available
Function: xmlTextReaderRelaxNGSetSchema
int	xmlTextReaderRelaxNGSetSchema	(xmlTextReaderPtr reader, 
				 xmlRelaxNGPtr schema)

+
Use RelaxNG to validate the document as it is processed. Activation is only possible before the first Read(). if @schema is NULL, then RelaxNG validation is desactivated. @ The @schema should not be freed until the reader is deallocated or its use has been deactivated.

+
reader:the xmlTextReaderPtr used
schema:a precompiled RelaxNG schema
Returns:0 in case the RelaxNG validation could be (des)activated and -1 in case of error.
Function: xmlTextReaderReadAttributeValue
int	xmlTextReaderReadAttributeValue	(xmlTextReaderPtr reader)

+
Parses an attribute value into one or more Text and EntityReference nodes.

+
reader:the xmlTextReaderPtr used
Returns:1 in case of success, 0 if the reader was not positionned on an ttribute node or all the attribute values have been read, or -1 in case of error.
Function: xmlTextReaderHasValue
int	xmlTextReaderHasValue	(xmlTextReaderPtr reader)

+
Whether the node can have a text value.

+
reader:the xmlTextReaderPtr used
Returns:1 if true, 0 if false, and -1 in case or error
Function: xmlTextReaderConstBaseUri
const xmlChar *	xmlTextReaderConstBaseUri	(xmlTextReaderPtr reader)

+
The base URI of the node.

+
reader:the xmlTextReaderPtr used
Returns:the base URI or NULL if not available, the string will be deallocated with the reader
Daniel Veillard

diff --git a/doc/html/libxml-xmlregexp.html b/doc/html/libxml-xmlregexp.html
index 75eee447..36fed5ca 100644
--- a/doc/html/libxml-xmlregexp.html
+++ b/doc/html/libxml-xmlregexp.html
@@ -1,152 +1,56 @@
-xmlregexp
PrevUpHomeGnome XML Library Reference ManualNext
xmlregexp
xmlregexp — 
Synopsis
+
+
+Module xmlregexp from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlregexp from libxml2
Main Menu
Related links
Table of Contents
void	xmlRegFreeExecCtxt	(xmlRegExecCtxtPtr exec)

+
int	xmlRegexpExec	(xmlRegexpPtr comp, 
				 const xmlChar * content)

+
Function type: xmlRegExecCallbacks
+void	xmlRegExecCallbacks	(xmlRegExecCtxtPtr exec, 
				 const xmlChar * token, 
				 void * transdata, 
				 void * inputdata)
+
exec:
token:
transdata:
inputdata:


+
Typedef xmlRegExecCtxt * xmlRegExecCtxtPtr
 
+
int	xmlRegExecPushString2	(xmlRegExecCtxtPtr exec, 
				 const xmlChar * value, 
				 const xmlChar * value2, 
				 void * data)

+
void	xmlRegFreeRegexp	(xmlRegexpPtr regexp)

+
Structure xmlRegExecCtxt
struct _xmlRegExecCtxt {
+The content of this structure is not made public by the API.
+}

Structure xmlRegexp
struct _xmlRegexp {
+The content of this structure is not made public by the API.
+}

Typedef xmlRegexp * xmlRegexpPtr
 
-
-struct      xmlRegexp;
-typedef     xmlRegexpPtr;
-struct      xmlRegExecCtxt;
-typedef     xmlRegExecCtxtPtr;
-xmlRegexpPtr xmlRegexpCompile               (const xmlChar *regexp);
-void        xmlRegFreeRegexp                (xmlRegexpPtr regexp);
-int         xmlRegexpExec                   (xmlRegexpPtr comp,
-                                             const xmlChar *value);
-void        xmlRegexpPrint                  (FILE *output,
-                                             xmlRegexpPtr regexp);
-int         xmlRegexpIsDeterminist          (xmlRegexpPtr comp);
-void        (*xmlRegExecCallbacks)          (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *token,
-                                             void *transdata,
-                                             void *inputdata);
-xmlRegExecCtxtPtr xmlRegNewExecCtxt         (xmlRegexpPtr comp,
-                                             xmlRegExecCallbacks callback,
-                                             void *data);
-void        xmlRegFreeExecCtxt              (xmlRegExecCtxtPtr exec);
-int         xmlRegExecPushString            (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *value,
-                                             void *data);
-int         xmlRegExecPushString2           (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *value,
-                                             const xmlChar *value2,
-                                             void *data);
-
Description

-
-
Details
struct xmlRegexp
struct xmlRegexp;

-
-
xmlRegexpPtr
typedef xmlRegexp *xmlRegexpPtr;
-

-A libxml regular expression, they can actually be far more complex
-thank the POSIX regex expressions.

-
-
struct xmlRegExecCtxt
struct xmlRegExecCtxt;

-
-
xmlRegExecCtxtPtr
typedef xmlRegExecCtxt *xmlRegExecCtxtPtr;
-

-A libxml progressive regular expression evaluation context

-
-
xmlRegexpCompile ()
xmlRegexpPtr xmlRegexpCompile               (const xmlChar *regexp);

-Parses a regular expression conforming to XML Schemas Part 2 Datatype
-Appendix F and build an automata suitable for testing strings against
-that regular expression

-
-
regexp:  a regular expression string
-
Returns :the compiled expression or NULL in case of error
-
xmlRegFreeRegexp ()
void        xmlRegFreeRegexp                (xmlRegexpPtr regexp);

-Free a regexp

-
-
regexp:  the regexp
-
xmlRegexpExec ()
int         xmlRegexpExec                   (xmlRegexpPtr comp,
-                                             const xmlChar *value);

-Check if the regular expression generate the value

-
-
comp:  the compiled regular expression
-
value:
-
Returns :1 if it matches, 0 if not and a negativa value in case of error
-
xmlRegexpPrint ()
void        xmlRegexpPrint                  (FILE *output,
-                                             xmlRegexpPtr regexp);

-Print the content of the compiled regular expression

-
-
output: the file for the output debug
-
regexp: the compiled regexp
-
xmlRegexpIsDeterminist ()
int         xmlRegexpIsDeterminist          (xmlRegexpPtr comp);

-Check if the regular expression is determinist

-
-
comp:  the compiled regular expression
-
Returns :1 if it yes, 0 if not and a negativa value in case of error
-
xmlRegExecCallbacks ()
void        (*xmlRegExecCallbacks)          (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *token,
-                                             void *transdata,
-                                             void *inputdata);

-
-
exec:
-
token:
-
transdata:
-
inputdata:
-
-
-
xmlRegNewExecCtxt ()
xmlRegExecCtxtPtr xmlRegNewExecCtxt         (xmlRegexpPtr comp,
-                                             xmlRegExecCallbacks callback,
-                                             void *data);

-Build a context used for progressive evaluation of a regexp.

-
-
comp: a precompiled regular expression
-
callback: a callback function used for handling progresses in the
-           automata matching phase
-
data: the context data associated to the callback in this context
-
Returns :the new context
-
xmlRegFreeExecCtxt ()
void        xmlRegFreeExecCtxt              (xmlRegExecCtxtPtr exec);

-Free the structures associated to a regular expression evaulation context.

-
-
exec: a regular expression evaulation context
-
xmlRegExecPushString ()
int         xmlRegExecPushString            (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *value,
-                                             void *data);

-Push one input token in the execution context

-
-
exec: a regexp execution context or NULL to indicate the end
-
value: a string token input
-
data: data associated to the token to reuse in callbacks
-
Returns : 1 if the regexp reached a final state, 0 if non-final, and
-    a negative value in case of error.
-
xmlRegExecPushString2 ()
int         xmlRegExecPushString2           (xmlRegExecCtxtPtr exec,
-                                             const xmlChar *value,
-                                             const xmlChar *value2,
-                                             void *data);

-Push one input token in the execution context

-
-
exec: a regexp execution context or NULL to indicate the end
-
value: the first string token input
-
value2: the second string token input
-
data: data associated to the token to reuse in callbacks
-
Returns : 1 if the regexp reached a final state, 0 if non-final, and
-    a negative value in case of error.
-
<< encodingxmlmemory >>

+
int	xmlRegExecPushString	(xmlRegExecCtxtPtr exec, 
				 const xmlChar * value, 
				 void * data)

+
int	xmlRegexpIsDeterminist	(xmlRegexpPtr comp)

+
xmlRegExecCtxtPtr	xmlRegNewExecCtxt	(xmlRegexpPtr comp, 
				 xmlRegExecCallbacks callback, 
				 void * data)

+
xmlRegexpPtr	xmlRegexpCompile	(const xmlChar * regexp)

+
void	xmlRegexpPrint	(FILE * output, 
				 xmlRegexpPtr regexp)

+
Description

+
Function: xmlRegFreeExecCtxt
void	xmlRegFreeExecCtxt	(xmlRegExecCtxtPtr exec)

+
Free the structures associated to a regular expression evaulation context.

+
exec:a regular expression evaulation context
Function: xmlRegexpExec
int	xmlRegexpExec	(xmlRegexpPtr comp, 
				 const xmlChar * content)

+
Check if the regular expression generate the value

+
comp:the compiled regular expression
content:the value to check against the regular expression
Returns:1 if it matches, 0 if not and a negativa value in case of error

+      
+      
+      
+      
+      
+      
+    
Function: xmlRegExecPushString2
int	xmlRegExecPushString2	(xmlRegExecCtxtPtr exec, 
				 const xmlChar * value, 
				 const xmlChar * value2, 
				 void * data)

+
Push one input token in the execution context

+
exec:a regexp execution context or NULL to indicate the end
value:the first string token input
value2:the second string token input
data:data associated to the token to reuse in callbacks
Returns:1 if the regexp reached a final state, 0 if non-final, and a negative value in case of error.
Function: xmlRegFreeRegexp
void	xmlRegFreeRegexp	(xmlRegexpPtr regexp)

+
Free a regexp

+
regexp:the regexp
Function: xmlRegExecPushString
int	xmlRegExecPushString	(xmlRegExecCtxtPtr exec, 
				 const xmlChar * value, 
				 void * data)

+
Push one input token in the execution context

+
exec:a regexp execution context or NULL to indicate the end
value:a string token input
data:data associated to the token to reuse in callbacks
Returns:1 if the regexp reached a final state, 0 if non-final, and a negative value in case of error.
Function: xmlRegexpIsDeterminist
int	xmlRegexpIsDeterminist	(xmlRegexpPtr comp)

+
Check if the regular expression is determinist

+
comp:the compiled regular expression
Returns:1 if it yes, 0 if not and a negativa value in case of error
Function: xmlRegNewExecCtxt
xmlRegExecCtxtPtr	xmlRegNewExecCtxt	(xmlRegexpPtr comp, 
				 xmlRegExecCallbacks callback, 
				 void * data)

+
Build a context used for progressive evaluation of a regexp.

+
comp:a precompiled regular expression
callback:a callback function used for handling progresses in the automata matching phase
data:the context data associated to the callback in this context
Returns:the new context
Function: xmlRegexpCompile
xmlRegexpPtr	xmlRegexpCompile	(const xmlChar * regexp)

+
Parses a regular expression conforming to XML Schemas Part 2 Datatype Appendix F and build an automata suitable for testing strings against that regular expression

+
regexp:a regular expression string
Returns:the compiled expression or NULL in case of error
Function: xmlRegexpPrint
void	xmlRegexpPrint	(FILE * output, 
				 xmlRegexpPtr regexp)

+
Print the content of the compiled regular expression

+
output:the file for the output debug
regexp:the compiled regexp
Daniel Veillard

diff --git a/doc/html/libxml-xmlschemas.html b/doc/html/libxml-xmlschemas.html
index fe208c59..d825f183 100644
--- a/doc/html/libxml-xmlschemas.html
+++ b/doc/html/libxml-xmlschemas.html
@@ -1,260 +1,139 @@
-xmlschemas
PrevUpHomeGnome XML Library Reference Manual
xmlschemas
xmlschemas — 
Synopsis
+
+
+Module xmlschemas from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlschemas from libxml2
Main Menu
Related links
Table of Contents
Structure xmlSchemaParserCtxt
struct _xmlSchemaParserCtxt {
+The content of this structure is not made public by the API.
+}

xmlSchemaParserCtxtPtr	xmlSchemaNewDocParserCtxt	(xmlDocPtr doc)

+
void	xmlSchemaFree	(xmlSchemaPtr schema)

+
void	xmlSchemaFreeValidCtxt	(xmlSchemaValidCtxtPtr ctxt)

+
Enum xmlSchemaValidError {
+    XML_SCHEMAS_ERR_OK = 0
+    XML_SCHEMAS_ERR_NOROOT = 1
+    XML_SCHEMAS_ERR_UNDECLAREDELEM = 2
+    XML_SCHEMAS_ERR_NOTTOPLEVEL = 3
+    XML_SCHEMAS_ERR_MISSING = 4
+    XML_SCHEMAS_ERR_WRONGELEM = 5
+    XML_SCHEMAS_ERR_NOTYPE = 6
+    XML_SCHEMAS_ERR_NOROLLBACK = 7
+    XML_SCHEMAS_ERR_ISABSTRACT = 8
+    XML_SCHEMAS_ERR_NOTEMPTY = 9
+    XML_SCHEMAS_ERR_ELEMCONT = 10
+    XML_SCHEMAS_ERR_HAVEDEFAULT = 11
+    XML_SCHEMAS_ERR_NOTNILLABLE = 12
+    XML_SCHEMAS_ERR_EXTRACONTENT = 13
+    XML_SCHEMAS_ERR_INVALIDATTR = 14
+    XML_SCHEMAS_ERR_INVALIDELEM = 15
+    XML_SCHEMAS_ERR_NOTDETERMINIST = 16
+    XML_SCHEMAS_ERR_CONSTRUCT = 17
+    XML_SCHEMAS_ERR_INTERNAL = 18
+    XML_SCHEMAS_ERR_NOTSIMPLE = 19
+    XML_SCHEMAS_ERR_ATTRUNKNOWN = 20
+    XML_SCHEMAS_ERR_ATTRINVALID = 21
+    XML_SCHEMAS_ERR_VALUE = 22
+    XML_SCHEMAS_ERR_FACET = 23
+    XML_SCHEMAS_ERR_ = 24
+    XML_SCHEMAS_ERR_XXX = 25
+}
 
+
void	xmlSchemaFreeParserCtxt	(xmlSchemaParserCtxtPtr ctxt)

+
xmlSchemaParserCtxtPtr	xmlSchemaNewParserCtxt	(const char * URL)

+
int	xmlSchemaValidateStream	(xmlSchemaValidCtxtPtr ctxt, 
				 xmlParserInputBufferPtr input, 
				 xmlCharEncoding enc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data)

+
Typedef xmlSchemaParserCtxt * xmlSchemaParserCtxtPtr
 
+
void	xmlSchemaDump	(FILE * output, 
				 xmlSchemaPtr schema)

+
void	xmlSchemaSetValidErrors	(xmlSchemaValidCtxtPtr ctxt, 
				 xmlSchemaValidityErrorFunc err, 
				 xmlSchemaValidityWarningFunc warn, 
				 void * ctx)

+
Structure xmlSchemaValidCtxt
struct _xmlSchemaValidCtxt {
+The content of this structure is not made public by the API.
+}

int	xmlSchemaValidateDoc	(xmlSchemaValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Function type: xmlSchemaValidityErrorFunc
+void	xmlSchemaValidityErrorFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
ctx:
msg:
...:


+
Typedef xmlSchema * xmlSchemaPtr
 
-enum        xmlSchemaValidError;
-struct      xmlSchema;
-typedef     xmlSchemaPtr;
-void        (*xmlSchemaValidityErrorFunc)   (void *ctx,
-                                             const char *msg,
-                                             ...);
-void        (*xmlSchemaValidityWarningFunc) (void *ctx,
-                                             const char *msg,
-                                             ...);
-struct      xmlSchemaParserCtxt;
-typedef     xmlSchemaParserCtxtPtr;
-struct      xmlSchemaValidCtxt;
-typedef     xmlSchemaValidCtxtPtr;
-xmlSchemaParserCtxtPtr xmlSchemaNewParserCtxt
-                                            (const char *URL);
-xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt
-                                            (const char *buffer,
-                                             int size);
-xmlSchemaParserCtxtPtr xmlSchemaNewDocParserCtxt
-                                            (xmlDocPtr doc);
-void        xmlSchemaFreeParserCtxt         (xmlSchemaParserCtxtPtr ctxt);
-void        xmlSchemaSetParserErrors        (xmlSchemaParserCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
-                                             void *ctx);
-xmlSchemaPtr xmlSchemaParse                 (xmlSchemaParserCtxtPtr ctxt);
-void        xmlSchemaFree                   (xmlSchemaPtr schema);
-void        xmlSchemaDump                   (FILE *output,
-                                             xmlSchemaPtr schema);
-void        xmlSchemaSetValidErrors         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
-                                             void *ctx);
-xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema);
-void        xmlSchemaFreeValidCtxt          (xmlSchemaValidCtxtPtr ctxt);
-int         xmlSchemaValidateDoc            (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlDocPtr instance);
-int         xmlSchemaValidateStream         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data);
-
Description

+
void	xmlSchemaSetParserErrors	(xmlSchemaParserCtxtPtr ctxt, 
				 xmlSchemaValidityErrorFunc err, 
				 xmlSchemaValidityWarningFunc warn, 
				 void * ctx)

+
xmlSchemaPtr	xmlSchemaParse	(xmlSchemaParserCtxtPtr ctxt)

+
Function type: xmlSchemaValidityWarningFunc
+void	xmlSchemaValidityWarningFunc	(void * ctx, 
				 const char * msg, 
				 ... ...)
+
ctx:
msg:
...:


+
xmlSchemaParserCtxtPtr	xmlSchemaNewMemParserCtxt	(const char * buffer, 
				 int size)

+
Typedef xmlSchemaValidCtxt * xmlSchemaValidCtxtPtr
 
-
Details
enum xmlSchemaValidError
typedef enum {
-    XML_SCHEMAS_ERR_OK		= 0,
-    XML_SCHEMAS_ERR_NOROOT	= 1,
-    XML_SCHEMAS_ERR_UNDECLAREDELEM,
-    XML_SCHEMAS_ERR_NOTTOPLEVEL,
-    XML_SCHEMAS_ERR_MISSING,
-    XML_SCHEMAS_ERR_WRONGELEM,
-    XML_SCHEMAS_ERR_NOTYPE,
-    XML_SCHEMAS_ERR_NOROLLBACK,
-    XML_SCHEMAS_ERR_ISABSTRACT,
-    XML_SCHEMAS_ERR_NOTEMPTY,
-    XML_SCHEMAS_ERR_ELEMCONT,
-    XML_SCHEMAS_ERR_HAVEDEFAULT,
-    XML_SCHEMAS_ERR_NOTNILLABLE,
-    XML_SCHEMAS_ERR_EXTRACONTENT,
-    XML_SCHEMAS_ERR_INVALIDATTR,
-    XML_SCHEMAS_ERR_INVALIDELEM,
-    XML_SCHEMAS_ERR_NOTDETERMINIST,
-    XML_SCHEMAS_ERR_CONSTRUCT,
-    XML_SCHEMAS_ERR_INTERNAL,
-    XML_SCHEMAS_ERR_NOTSIMPLE,
-    XML_SCHEMAS_ERR_ATTRUNKNOWN,
-    XML_SCHEMAS_ERR_ATTRINVALID,
-    XML_SCHEMAS_ERR_VALUE,
-    XML_SCHEMAS_ERR_FACET,
-    XML_SCHEMAS_ERR_,
-    XML_SCHEMAS_ERR_XXX
-} xmlSchemaValidError;
-

-
-
struct xmlSchema
struct xmlSchema {
-
-    xmlChar *name;        /* schema name */
-    xmlChar *targetNamespace;     /* the target namespace */
-    xmlChar *version;
-    xmlChar *id;
-    xmlDocPtr doc;
-    xmlSchemaAnnotPtr annot;
-    int flags;
-
-    xmlHashTablePtr typeDecl;
-    xmlHashTablePtr attrDecl;
-    xmlHashTablePtr attrgrpDecl;
-    xmlHashTablePtr elemDecl;
-    xmlHashTablePtr notaDecl;
-
-    xmlHashTablePtr schemasImports;
-
-    void *_private;	/* unused by the library for users or bindings */
-    xmlHashTablePtr groupDecl;
-};
-

-
-
xmlSchemaPtr
typedef xmlSchema *xmlSchemaPtr;
-

-
-
xmlSchemaValidityErrorFunc ()
void        (*xmlSchemaValidityErrorFunc)   (void *ctx,
-                                             const char *msg,
-                                             ...);

-
-
ctx:
-
msg:
-
...:
-
-
-
xmlSchemaValidityWarningFunc ()
void        (*xmlSchemaValidityWarningFunc) (void *ctx,
-                                             const char *msg,
-                                             ...);

-
-
ctx:
-
msg:
-
...:
-
-
-
struct xmlSchemaParserCtxt
struct xmlSchemaParserCtxt;

-
-
xmlSchemaParserCtxtPtr
typedef xmlSchemaParserCtxt *xmlSchemaParserCtxtPtr;
-

-
-
struct xmlSchemaValidCtxt
struct xmlSchemaValidCtxt;

-A Schemas validation context

-
-
xmlSchemaValidCtxtPtr
typedef xmlSchemaValidCtxt *xmlSchemaValidCtxtPtr;
-

-
-
xmlSchemaNewParserCtxt ()
xmlSchemaParserCtxtPtr xmlSchemaNewParserCtxt
-                                            (const char *URL);

-Create an XML Schemas parse context for that file/resource expected
-to contain an XML Schemas file.

-
-
URL:  the location of the schema
-
Returns :the parser context or NULL in case of error
-
xmlSchemaNewMemParserCtxt ()
xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt
-                                            (const char *buffer,
-                                             int size);

-Create an XML Schemas parse context for that memory buffer expected
-to contain an XML Schemas file.

-
-
buffer:  a pointer to a char array containing the schemas
-
size:  the size of the array
-
Returns :the parser context or NULL in case of error
-
xmlSchemaNewDocParserCtxt ()
xmlSchemaParserCtxtPtr xmlSchemaNewDocParserCtxt
-                                            (xmlDocPtr doc);

-Create an XML Schemas parse context for that document.
-NB. The document may be modified during the parsing process.

-
-
doc:  a preparsed document tree
-
Returns :the parser context or NULL in case of error
-
xmlSchemaFreeParserCtxt ()
void        xmlSchemaFreeParserCtxt         (xmlSchemaParserCtxtPtr ctxt);

-Free the resources associated to the schema parser context

-
-
ctxt:  the schema parser context
-
xmlSchemaSetParserErrors ()
void        xmlSchemaSetParserErrors        (xmlSchemaParserCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
-                                             void *ctx);

-Set the callback functions used to handle errors for a validation context

-
-
ctxt:  a schema validation context
-
err:  the error callback
-
warn:  the warning callback
-
ctx:  contextual data for the callbacks
-
xmlSchemaParse ()
xmlSchemaPtr xmlSchemaParse                 (xmlSchemaParserCtxtPtr ctxt);

-parse a schema definition resource and build an internal
-XML Shema struture which can be used to validate instances.
-*WARNING* this interface is highly subject to change

-
-
ctxt:  a schema validation context
-
Returns :the internal XML Schema structure built from the resource or
-        NULL in case of error
-
xmlSchemaFree ()
void        xmlSchemaFree                   (xmlSchemaPtr schema);

-Deallocate a Schema structure.

-
-
schema:  a schema structure
-
xmlSchemaDump ()
void        xmlSchemaDump                   (FILE *output,
-                                             xmlSchemaPtr schema);

-Dump a Schema structure.

-
-
output:  the file output
-
schema:  a schema structure
-
xmlSchemaSetValidErrors ()
void        xmlSchemaSetValidErrors         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlSchemaValidityErrorFunc err,
-                                             xmlSchemaValidityWarningFunc warn,
-                                             void *ctx);

-Set the error and warning callback informations

-
-
ctxt:  a schema validation context
-
err:  the error function
-
warn: the warning function
-
ctx: the functions context
-
xmlSchemaNewValidCtxt ()
xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema);

-Create an XML Schemas validation context based on the given schema

-
-
schema:  a precompiled XML Schemas
-
Returns :the validation context or NULL in case of error
-
xmlSchemaFreeValidCtxt ()
void        xmlSchemaFreeValidCtxt          (xmlSchemaValidCtxtPtr ctxt);

-Free the resources associated to the schema validation context

-
-
ctxt:  the schema validation context
-
xmlSchemaValidateDoc ()
int         xmlSchemaValidateDoc            (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlDocPtr instance);

-Validate a document tree in memory.

-
-
ctxt:  a schema validation context
-
instance:
-
Returns :0 if the document is schemas valid, a positive error code
-    number otherwise and -1 in case of internal or API error.
-
xmlSchemaValidateStream ()
int         xmlSchemaValidateStream         (xmlSchemaValidCtxtPtr ctxt,
-                                             xmlParserInputBufferPtr input,
-                                             xmlCharEncoding enc,
-                                             xmlSAXHandlerPtr sax,
-                                             void *user_data);

-Validate a document tree in memory.

-
-
ctxt:  a schema validation context
-
input:  the input to use for reading the data
-
enc:  an optional encoding information
-
sax:  a SAX handler for the resulting events
-
user_data:  the context to provide to the SAX handler.
-
Returns :0 if the document is schemas valid, a positive error code
-    number otherwise and -1 in case of internal or API error.
-
<< xmlwriter

+
Structure xmlSchema
struct _xmlSchema {
+    xmlChar *	name	: schema name
+    xmlChar *	targetNamespace	: the target namespace
+    xmlChar *	version
+    xmlChar *	id
+    xmlDocPtr	doc
+    xmlSchemaAnnotPtr	annot
+    int	flags
+    xmlHashTablePtr	typeDecl
+    xmlHashTablePtr	attrDecl
+    xmlHashTablePtr	attrgrpDecl
+    xmlHashTablePtr	elemDecl
+    xmlHashTablePtr	notaDecl
+    xmlHashTablePtr	schemasImports
+    void *	_private	: unused by the library for users or bindings
+    xmlHashTablePtr	groupDecl
+}

xmlSchemaValidCtxtPtr	xmlSchemaNewValidCtxt	(xmlSchemaPtr schema)

+
Description

+
Function: xmlSchemaNewDocParserCtxt
xmlSchemaParserCtxtPtr	xmlSchemaNewDocParserCtxt	(xmlDocPtr doc)

+
Create an XML Schemas parse context for that document. NB. The document may be modified during the parsing process.

+
doc:a preparsed document tree
Returns:the parser context or NULL in case of error
Function: xmlSchemaFree
void	xmlSchemaFree	(xmlSchemaPtr schema)

+
Deallocate a Schema structure.

+
schema:a schema structure
Function: xmlSchemaFreeValidCtxt
void	xmlSchemaFreeValidCtxt	(xmlSchemaValidCtxtPtr ctxt)

+
Free the resources associated to the schema validation context

+
ctxt:the schema validation context
Function: xmlSchemaFreeParserCtxt
void	xmlSchemaFreeParserCtxt	(xmlSchemaParserCtxtPtr ctxt)

+
Free the resources associated to the schema parser context

+
ctxt:the schema parser context
Function: xmlSchemaNewParserCtxt
xmlSchemaParserCtxtPtr	xmlSchemaNewParserCtxt	(const char * URL)

+
Create an XML Schemas parse context for that file/resource expected to contain an XML Schemas file.

+
URL:the location of the schema
Returns:the parser context or NULL in case of error
Function: xmlSchemaValidateStream
int	xmlSchemaValidateStream	(xmlSchemaValidCtxtPtr ctxt, 
				 xmlParserInputBufferPtr input, 
				 xmlCharEncoding enc, 
				 xmlSAXHandlerPtr sax, 
				 void * user_data)

+
Validate a document tree in memory.

+
ctxt:a schema validation context
input:the input to use for reading the data
enc:an optional encoding information
sax:a SAX handler for the resulting events
user_data:the context to provide to the SAX handler.
Returns:0 if the document is schemas valid, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlSchemaDump
void	xmlSchemaDump	(FILE * output, 
				 xmlSchemaPtr schema)

+
Dump a Schema structure.

+
output:the file output
schema:a schema structure
Function: xmlSchemaSetValidErrors
void	xmlSchemaSetValidErrors	(xmlSchemaValidCtxtPtr ctxt, 
				 xmlSchemaValidityErrorFunc err, 
				 xmlSchemaValidityWarningFunc warn, 
				 void * ctx)

+
Set the error and warning callback informations

+
ctxt:a schema validation context
err:the error function
warn:the warning function
ctx:the functions context
Function: xmlSchemaValidateDoc
int	xmlSchemaValidateDoc	(xmlSchemaValidCtxtPtr ctxt, 
				 xmlDocPtr doc)

+
Validate a document tree in memory.

+
ctxt:a schema validation context
doc:a parsed document tree
Returns:0 if the document is schemas valid, a positive error code number otherwise and -1 in case of internal or API error.

+      
+      
+      
+      
+      
+    
Function: xmlSchemaSetParserErrors
void	xmlSchemaSetParserErrors	(xmlSchemaParserCtxtPtr ctxt, 
				 xmlSchemaValidityErrorFunc err, 
				 xmlSchemaValidityWarningFunc warn, 
				 void * ctx)

+
Set the callback functions used to handle errors for a validation context

+
ctxt:a schema validation context
err:the error callback
warn:the warning callback
ctx:contextual data for the callbacks
Function: xmlSchemaParse
xmlSchemaPtr	xmlSchemaParse	(xmlSchemaParserCtxtPtr ctxt)

+
parse a schema definition resource and build an internal XML Shema struture which can be used to validate instances. *WARNING* this interface is highly subject to change

+
ctxt:a schema validation context
Returns:the internal XML Schema structure built from the resource or NULL in case of error

+      
+      
+      
+      
+      
+    
Function: xmlSchemaNewMemParserCtxt
xmlSchemaParserCtxtPtr	xmlSchemaNewMemParserCtxt	(const char * buffer, 
				 int size)

+
Create an XML Schemas parse context for that memory buffer expected to contain an XML Schemas file.

+
buffer:a pointer to a char array containing the schemas
size:the size of the array
Returns:the parser context or NULL in case of error

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlSchemaNewValidCtxt
xmlSchemaValidCtxtPtr	xmlSchemaNewValidCtxt	(xmlSchemaPtr schema)

+
Create an XML Schemas validation context based on the given schema

+
schema:a precompiled XML Schemas
Returns:the validation context or NULL in case of error
Daniel Veillard

diff --git a/doc/html/libxml-xmlschemastypes.html b/doc/html/libxml-xmlschemastypes.html
index 7f89f6eb..a5a0a45b 100644
--- a/doc/html/libxml-xmlschemastypes.html
+++ b/doc/html/libxml-xmlschemastypes.html
@@ -1,142 +1,44 @@
-xmlschemastypes
PrevUpHomeGnome XML Library Reference ManualNext
xmlschemastypes
xmlschemastypes — 
Synopsis
-
-
-
-void        xmlSchemaInitTypes              (void);
-void        xmlSchemaCleanupTypes           (void);
-xmlSchemaTypePtr xmlSchemaGetPredefinedType (const xmlChar *name,
-                                             const xmlChar *ns);
-int         xmlSchemaValidatePredefinedType (xmlSchemaTypePtr type,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr *val);
-int         xmlSchemaValPredefTypeNode      (xmlSchemaTypePtr type,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr *val,
-                                             xmlNodePtr node);
-int         xmlSchemaValidateFacet          (xmlSchemaTypePtr base,
-                                             xmlSchemaFacetPtr facet,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr val);
-void        xmlSchemaFreeValue              (xmlSchemaValPtr val);
-xmlSchemaFacetPtr xmlSchemaNewFacet         (void);
-int         xmlSchemaCheckFacet             (xmlSchemaFacetPtr facet,
-                                             xmlSchemaTypePtr typeDecl,
-                                             xmlSchemaParserCtxtPtr ctxt,
-                                             const xmlChar *name);
-void        xmlSchemaFreeFacet              (xmlSchemaFacetPtr facet);
-int         xmlSchemaCompareValues          (xmlSchemaValPtr x,
-                                             xmlSchemaValPtr y);
-
Description

-
-
Details
xmlSchemaInitTypes ()
void        xmlSchemaInitTypes              (void);

-
-
xmlSchemaCleanupTypes ()
void        xmlSchemaCleanupTypes           (void);

-Cleanup the default XML Schemas type library

-
-
xmlSchemaGetPredefinedType ()
xmlSchemaTypePtr xmlSchemaGetPredefinedType (const xmlChar *name,
-                                             const xmlChar *ns);

-Lookup a type in the default XML Schemas type library

-
-
name: the type name
-
ns:  the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"
-
Returns :the type if found, NULL otherwise
-
xmlSchemaValidatePredefinedType ()
int         xmlSchemaValidatePredefinedType (xmlSchemaTypePtr type,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr *val);

-Check that a value conforms to the lexical space of the predefined type.
-if true a value is computed and returned in val.

-
-
type: the predefined type
-
value: the value to check
-
val:  the return computed value
-
Returns :0 if this validates, a positive error code number otherwise
-        and -1 in case of internal or API error.
-
xmlSchemaValPredefTypeNode ()
int         xmlSchemaValPredefTypeNode      (xmlSchemaTypePtr type,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr *val,
-                                             xmlNodePtr node);

-Check that a value conforms to the lexical space of the predefined type.
-if true a value is computed and returned in val.

-
-
type: the predefined type
-
value: the value to check
-
val:  the return computed value
-
node:  the node containing the value
-
Returns :0 if this validates, a positive error code number otherwise
-        and -1 in case of internal or API error.
-
xmlSchemaValidateFacet ()
int         xmlSchemaValidateFacet          (xmlSchemaTypePtr base,
-                                             xmlSchemaFacetPtr facet,
-                                             const xmlChar *value,
-                                             xmlSchemaValPtr val);

-Check a value against a facet condition

-
-
base:  the base type
-
facet:  the facet to check
-
value:  the lexical repr of the value to validate
-
val:  the precomputed value
-
Returns :0 if the element is schemas valid, a positive error code
-    number otherwise and -1 in case of internal or API error.
-
xmlSchemaFreeValue ()
void        xmlSchemaFreeValue              (xmlSchemaValPtr val);

-Cleanup the default XML Schemas type library

-
-
val:
-
-
-
xmlSchemaNewFacet ()
xmlSchemaFacetPtr xmlSchemaNewFacet         (void);

-Allocate a new Facet structure.

-
-
Returns :the newly allocated structure or NULL in case or error
-
xmlSchemaCheckFacet ()
int         xmlSchemaCheckFacet             (xmlSchemaFacetPtr facet,
-                                             xmlSchemaTypePtr typeDecl,
-                                             xmlSchemaParserCtxtPtr ctxt,
-                                             const xmlChar *name);

-Checks the default values types, especially for facets

-
-
facet:  the facet
-
typeDecl:  the schema type definition
-
ctxt:  the schema parser context or NULL
-
name: name of the type
-
Returns :0 if okay or -1 in cae of error
-
xmlSchemaFreeFacet ()
void        xmlSchemaFreeFacet              (xmlSchemaFacetPtr facet);

-Deallocate a Schema Facet structure.

-
-
facet:  a schema facet structure
-
xmlSchemaCompareValues ()
int         xmlSchemaCompareValues          (xmlSchemaValPtr x,
-                                             xmlSchemaValPtr y);

-Compare 2 values

-
-
x:  a first value
-
y:  a second value
-
Returns :-1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in
-case of error
-
<< xmlautomataxpointer >>

+
+
+Module xmlschemastypes from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlschemastypes from libxml2
Main Menu
Related links
Table of Contents
xmlSchemaFacetPtr	xmlSchemaNewFacet	(void)

+
int	xmlSchemaValPredefTypeNode	(xmlSchemaTypePtr type, 
				 const xmlChar * value, 
				 xmlSchemaValPtr * val, 
				 xmlNodePtr node)

+
void	xmlSchemaFreeFacet	(xmlSchemaFacetPtr facet)

+
int	xmlSchemaValidatePredefinedType	(xmlSchemaTypePtr type, 
				 const xmlChar * value, 
				 xmlSchemaValPtr * val)

+
int	xmlSchemaCompareValues	(xmlSchemaValPtr x, 
				 xmlSchemaValPtr y)

+
int	xmlSchemaValidateFacet	(xmlSchemaTypePtr base, 
				 xmlSchemaFacetPtr facet, 
				 const xmlChar * value, 
				 xmlSchemaValPtr val)

+
void	xmlSchemaCleanupTypes	(void)

+
void	xmlSchemaInitTypes	(void)

+
void	xmlSchemaFreeValue	(xmlSchemaValPtr value)

+
xmlSchemaTypePtr	xmlSchemaGetPredefinedType	(const xmlChar * name, 
				 const xmlChar * ns)

+
int	xmlSchemaCheckFacet	(xmlSchemaFacetPtr facet, 
				 xmlSchemaTypePtr typeDecl, 
				 xmlSchemaParserCtxtPtr ctxt, 
				 const xmlChar * name)

+
Description

+
Function: xmlSchemaNewFacet
xmlSchemaFacetPtr	xmlSchemaNewFacet	(void)

+
Allocate a new Facet structure.

+
Returns:the newly allocated structure or NULL in case or error
Function: xmlSchemaValPredefTypeNode
int	xmlSchemaValPredefTypeNode	(xmlSchemaTypePtr type, 
				 const xmlChar * value, 
				 xmlSchemaValPtr * val, 
				 xmlNodePtr node)

+
Check that a value conforms to the lexical space of the predefined type. if true a value is computed and returned in @val.

+
type:the predefined type
value:the value to check
val:the return computed value
node:the node containing the value
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlSchemaFreeFacet
void	xmlSchemaFreeFacet	(xmlSchemaFacetPtr facet)

+
Deallocate a Schema Facet structure.

+
facet:a schema facet structure
Function: xmlSchemaValidatePredefinedType
int	xmlSchemaValidatePredefinedType	(xmlSchemaTypePtr type, 
				 const xmlChar * value, 
				 xmlSchemaValPtr * val)

+
Check that a value conforms to the lexical space of the predefined type. if true a value is computed and returned in @val.

+
type:the predefined type
value:the value to check
val:the return computed value
Returns:0 if this validates, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlSchemaCompareValues
int	xmlSchemaCompareValues	(xmlSchemaValPtr x, 
				 xmlSchemaValPtr y)

+
Compare 2 values

+
x:a first value
y:a second value
Returns:-1 if x < y, 0 if x == y, 1 if x > y, 2 if x <> y, and -2 in case of error
Function: xmlSchemaValidateFacet
int	xmlSchemaValidateFacet	(xmlSchemaTypePtr base, 
				 xmlSchemaFacetPtr facet, 
				 const xmlChar * value, 
				 xmlSchemaValPtr val)

+
Check a value against a facet condition

+
base:the base type
facet:the facet to check
value:the lexical repr of the value to validate
val:the precomputed value
Returns:0 if the element is schemas valid, a positive error code number otherwise and -1 in case of internal or API error.
Function: xmlSchemaCleanupTypes
void	xmlSchemaCleanupTypes	(void)

+
Cleanup the default XML Schemas type library

+
Function: xmlSchemaInitTypes
void	xmlSchemaInitTypes	(void)

+
Initialize the default XML Schemas type library

+
Function: xmlSchemaFreeValue
void	xmlSchemaFreeValue	(xmlSchemaValPtr value)

+
Cleanup the default XML Schemas type library

+
value:the value to free
Function: xmlSchemaGetPredefinedType
xmlSchemaTypePtr	xmlSchemaGetPredefinedType	(const xmlChar * name, 
				 const xmlChar * ns)

+
Lookup a type in the default XML Schemas type library

+
name:the type name
ns:the URI of the namespace usually "http://www.w3.org/2001/XMLSchema"
Returns:the type if found, NULL otherwise
Function: xmlSchemaCheckFacet
int	xmlSchemaCheckFacet	(xmlSchemaFacetPtr facet, 
				 xmlSchemaTypePtr typeDecl, 
				 xmlSchemaParserCtxtPtr ctxt, 
				 const xmlChar * name)

+
Checks the default values types, especially for facets

+
facet:the facet
typeDecl:the schema type definition
ctxt:the schema parser context or NULL
name:name of the type
Returns:0 if okay or -1 in cae of error
Daniel Veillard

diff --git a/doc/html/libxml-xmlunicode.html b/doc/html/libxml-xmlunicode.html
index 1ca76c47..e9fef27e 100644
--- a/doc/html/libxml-xmlunicode.html
+++ b/doc/html/libxml-xmlunicode.html
@@ -1,1093 +1,509 @@
-xmlunicode
PrevUpHomeGnome XML Library Reference ManualNext
xmlunicode
xmlunicode — 
Synopsis
-
-
-
-int         xmlUCSIsAegeanNumbers           (int code);
-int         xmlUCSIsAlphabeticPresentationForms
-                                            (int code);
-int         xmlUCSIsArabic                  (int code);
-int         xmlUCSIsArabicPresentationFormsA
-                                            (int code);
-int         xmlUCSIsArabicPresentationFormsB
-                                            (int code);
-int         xmlUCSIsArmenian                (int code);
-int         xmlUCSIsArrows                  (int code);
-int         xmlUCSIsBasicLatin              (int code);
-int         xmlUCSIsBengali                 (int code);
-int         xmlUCSIsBlockElements           (int code);
-int         xmlUCSIsBopomofo                (int code);
-int         xmlUCSIsBopomofoExtended        (int code);
-int         xmlUCSIsBoxDrawing              (int code);
-int         xmlUCSIsBraillePatterns         (int code);
-int         xmlUCSIsBuhid                   (int code);
-int         xmlUCSIsByzantineMusicalSymbols (int code);
-int         xmlUCSIsCJKCompatibility        (int code);
-int         xmlUCSIsCJKCompatibilityForms   (int code);
-int         xmlUCSIsCJKCompatibilityIdeographs
-                                            (int code);
-int         xmlUCSIsCJKCompatibilityIdeographsSupplement
-                                            (int code);
-int         xmlUCSIsCJKRadicalsSupplement   (int code);
-int         xmlUCSIsCJKSymbolsandPunctuation
-                                            (int code);
-int         xmlUCSIsCJKUnifiedIdeographs    (int code);
-int         xmlUCSIsCJKUnifiedIdeographsExtensionA
-                                            (int code);
-int         xmlUCSIsCJKUnifiedIdeographsExtensionB
-                                            (int code);
-int         xmlUCSIsCherokee                (int code);
-int         xmlUCSIsCombiningDiacriticalMarks
-                                            (int code);
-int         xmlUCSIsCombiningDiacriticalMarksforSymbols
-                                            (int code);
-int         xmlUCSIsCombiningHalfMarks      (int code);
-int         xmlUCSIsCombiningMarksforSymbols
-                                            (int code);
-int         xmlUCSIsControlPictures         (int code);
-int         xmlUCSIsCurrencySymbols         (int code);
-int         xmlUCSIsCypriotSyllabary        (int code);
-int         xmlUCSIsCyrillic                (int code);
-int         xmlUCSIsCyrillicSupplement      (int code);
-int         xmlUCSIsDeseret                 (int code);
-int         xmlUCSIsDevanagari              (int code);
-int         xmlUCSIsDingbats                (int code);
-int         xmlUCSIsEnclosedAlphanumerics   (int code);
-int         xmlUCSIsEnclosedCJKLettersandMonths
-                                            (int code);
-int         xmlUCSIsEthiopic                (int code);
-int         xmlUCSIsGeneralPunctuation      (int code);
-int         xmlUCSIsGeometricShapes         (int code);
-int         xmlUCSIsGeorgian                (int code);
-int         xmlUCSIsGothic                  (int code);
-int         xmlUCSIsGreek                   (int code);
-int         xmlUCSIsGreekExtended           (int code);
-int         xmlUCSIsGreekandCoptic          (int code);
-int         xmlUCSIsGujarati                (int code);
-int         xmlUCSIsGurmukhi                (int code);
-int         xmlUCSIsHalfwidthandFullwidthForms
-                                            (int code);
-int         xmlUCSIsHangulCompatibilityJamo (int code);
-int         xmlUCSIsHangulJamo              (int code);
-int         xmlUCSIsHangulSyllables         (int code);
-int         xmlUCSIsHanunoo                 (int code);
-int         xmlUCSIsHebrew                  (int code);
-int         xmlUCSIsHighPrivateUseSurrogates
-                                            (int code);
-int         xmlUCSIsHighSurrogates          (int code);
-int         xmlUCSIsHiragana                (int code);
-int         xmlUCSIsIPAExtensions           (int code);
-int         xmlUCSIsIdeographicDescriptionCharacters
-                                            (int code);
-int         xmlUCSIsKanbun                  (int code);
-int         xmlUCSIsKangxiRadicals          (int code);
-int         xmlUCSIsKannada                 (int code);
-int         xmlUCSIsKatakana                (int code);
-int         xmlUCSIsKatakanaPhoneticExtensions
-                                            (int code);
-int         xmlUCSIsKhmer                   (int code);
-int         xmlUCSIsKhmerSymbols            (int code);
-int         xmlUCSIsLao                     (int code);
-int         xmlUCSIsLatin1Supplement        (int code);
-int         xmlUCSIsLatinExtendedA          (int code);
-int         xmlUCSIsLatinExtendedB          (int code);
-int         xmlUCSIsLatinExtendedAdditional (int code);
-int         xmlUCSIsLetterlikeSymbols       (int code);
-int         xmlUCSIsLimbu                   (int code);
-int         xmlUCSIsLinearBIdeograms        (int code);
-int         xmlUCSIsLinearBSyllabary        (int code);
-int         xmlUCSIsLowSurrogates           (int code);
-int         xmlUCSIsMalayalam               (int code);
-int         xmlUCSIsMathematicalAlphanumericSymbols
-                                            (int code);
-int         xmlUCSIsMathematicalOperators   (int code);
-int         xmlUCSIsMiscellaneousMathematicalSymbolsA
-                                            (int code);
-int         xmlUCSIsMiscellaneousMathematicalSymbolsB
-                                            (int code);
-int         xmlUCSIsMiscellaneousSymbols    (int code);
-int         xmlUCSIsMiscellaneousSymbolsandArrows
-                                            (int code);
-int         xmlUCSIsMiscellaneousTechnical  (int code);
-int         xmlUCSIsMongolian               (int code);
-int         xmlUCSIsMusicalSymbols          (int code);
-int         xmlUCSIsMyanmar                 (int code);
-int         xmlUCSIsNumberForms             (int code);
-int         xmlUCSIsOgham                   (int code);
-int         xmlUCSIsOldItalic               (int code);
-int         xmlUCSIsOpticalCharacterRecognition
-                                            (int code);
-int         xmlUCSIsOriya                   (int code);
-int         xmlUCSIsOsmanya                 (int code);
-int         xmlUCSIsPhoneticExtensions      (int code);
-int         xmlUCSIsPrivateUse              (int code);
-int         xmlUCSIsPrivateUseArea          (int code);
-int         xmlUCSIsRunic                   (int code);
-int         xmlUCSIsShavian                 (int code);
-int         xmlUCSIsSinhala                 (int code);
-int         xmlUCSIsSmallFormVariants       (int code);
-int         xmlUCSIsSpacingModifierLetters  (int code);
-int         xmlUCSIsSpecials                (int code);
-int         xmlUCSIsSuperscriptsandSubscripts
-                                            (int code);
-int         xmlUCSIsSupplementalArrowsA     (int code);
-int         xmlUCSIsSupplementalArrowsB     (int code);
-int         xmlUCSIsSupplementalMathematicalOperators
-                                            (int code);
-int         xmlUCSIsSupplementaryPrivateUseAreaA
-                                            (int code);
-int         xmlUCSIsSupplementaryPrivateUseAreaB
-                                            (int code);
-int         xmlUCSIsSyriac                  (int code);
-int         xmlUCSIsTagalog                 (int code);
-int         xmlUCSIsTagbanwa                (int code);
-int         xmlUCSIsTags                    (int code);
-int         xmlUCSIsTaiLe                   (int code);
-int         xmlUCSIsTaiXuanJingSymbols      (int code);
-int         xmlUCSIsTamil                   (int code);
-int         xmlUCSIsTelugu                  (int code);
-int         xmlUCSIsThaana                  (int code);
-int         xmlUCSIsThai                    (int code);
-int         xmlUCSIsTibetan                 (int code);
-int         xmlUCSIsUgaritic                (int code);
-int         xmlUCSIsUnifiedCanadianAboriginalSyllabics
-                                            (int code);
-int         xmlUCSIsVariationSelectors      (int code);
-int         xmlUCSIsVariationSelectorsSupplement
-                                            (int code);
-int         xmlUCSIsYiRadicals              (int code);
-int         xmlUCSIsYiSyllables             (int code);
-int         xmlUCSIsYijingHexagramSymbols   (int code);
-int         xmlUCSIsBlock                   (int code,
-                                             const char *block);
-int         xmlUCSIsCatC                    (int code);
-int         xmlUCSIsCatCc                   (int code);
-int         xmlUCSIsCatCf                   (int code);
-int         xmlUCSIsCatCo                   (int code);
-int         xmlUCSIsCatCs                   (int code);
-int         xmlUCSIsCatL                    (int code);
-int         xmlUCSIsCatLl                   (int code);
-int         xmlUCSIsCatLm                   (int code);
-int         xmlUCSIsCatLo                   (int code);
-int         xmlUCSIsCatLt                   (int code);
-int         xmlUCSIsCatLu                   (int code);
-int         xmlUCSIsCatM                    (int code);
-int         xmlUCSIsCatMc                   (int code);
-int         xmlUCSIsCatMe                   (int code);
-int         xmlUCSIsCatMn                   (int code);
-int         xmlUCSIsCatN                    (int code);
-int         xmlUCSIsCatNd                   (int code);
-int         xmlUCSIsCatNl                   (int code);
-int         xmlUCSIsCatNo                   (int code);
-int         xmlUCSIsCatP                    (int code);
-int         xmlUCSIsCatPc                   (int code);
-int         xmlUCSIsCatPd                   (int code);
-int         xmlUCSIsCatPe                   (int code);
-int         xmlUCSIsCatPf                   (int code);
-int         xmlUCSIsCatPi                   (int code);
-int         xmlUCSIsCatPo                   (int code);
-int         xmlUCSIsCatPs                   (int code);
-int         xmlUCSIsCatS                    (int code);
-int         xmlUCSIsCatSc                   (int code);
-int         xmlUCSIsCatSk                   (int code);
-int         xmlUCSIsCatSm                   (int code);
-int         xmlUCSIsCatSo                   (int code);
-int         xmlUCSIsCatZ                    (int code);
-int         xmlUCSIsCatZl                   (int code);
-int         xmlUCSIsCatZp                   (int code);
-int         xmlUCSIsCatZs                   (int code);
-int         xmlUCSIsCat                     (int code,
-                                             const char *cat);
-
Description

-
-
Details
xmlUCSIsAegeanNumbers ()
int         xmlUCSIsAegeanNumbers           (int code);

-Check whether the character is part of AegeanNumbers UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsAlphabeticPresentationForms ()
int         xmlUCSIsAlphabeticPresentationForms
-                                            (int code);

-Check whether the character is part of AlphabeticPresentationForms UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsArabic ()
int         xmlUCSIsArabic                  (int code);

-Check whether the character is part of Arabic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsArabicPresentationFormsA ()
int         xmlUCSIsArabicPresentationFormsA
-                                            (int code);

-Check whether the character is part of ArabicPresentationForms-A UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsArabicPresentationFormsB ()
int         xmlUCSIsArabicPresentationFormsB
-                                            (int code);

-Check whether the character is part of ArabicPresentationForms-B UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsArmenian ()
int         xmlUCSIsArmenian                (int code);

-Check whether the character is part of Armenian UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsArrows ()
int         xmlUCSIsArrows                  (int code);

-Check whether the character is part of Arrows UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBasicLatin ()
int         xmlUCSIsBasicLatin              (int code);

-Check whether the character is part of BasicLatin UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBengali ()
int         xmlUCSIsBengali                 (int code);

-Check whether the character is part of Bengali UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBlockElements ()
int         xmlUCSIsBlockElements           (int code);

-Check whether the character is part of BlockElements UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBopomofo ()
int         xmlUCSIsBopomofo                (int code);

-Check whether the character is part of Bopomofo UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBopomofoExtended ()
int         xmlUCSIsBopomofoExtended        (int code);

-Check whether the character is part of BopomofoExtended UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBoxDrawing ()
int         xmlUCSIsBoxDrawing              (int code);

-Check whether the character is part of BoxDrawing UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBraillePatterns ()
int         xmlUCSIsBraillePatterns         (int code);

-Check whether the character is part of BraillePatterns UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBuhid ()
int         xmlUCSIsBuhid                   (int code);

-Check whether the character is part of Buhid UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsByzantineMusicalSymbols ()
int         xmlUCSIsByzantineMusicalSymbols (int code);

-Check whether the character is part of ByzantineMusicalSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKCompatibility ()
int         xmlUCSIsCJKCompatibility        (int code);

-Check whether the character is part of CJKCompatibility UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKCompatibilityForms ()
int         xmlUCSIsCJKCompatibilityForms   (int code);

-Check whether the character is part of CJKCompatibilityForms UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKCompatibilityIdeographs ()
int         xmlUCSIsCJKCompatibilityIdeographs
-                                            (int code);

-Check whether the character is part of CJKCompatibilityIdeographs UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKCompatibilityIdeographsSupplement ()
int         xmlUCSIsCJKCompatibilityIdeographsSupplement
-                                            (int code);

-Check whether the character is part of CJKCompatibilityIdeographsSupplement UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKRadicalsSupplement ()
int         xmlUCSIsCJKRadicalsSupplement   (int code);

-Check whether the character is part of CJKRadicalsSupplement UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKSymbolsandPunctuation ()
int         xmlUCSIsCJKSymbolsandPunctuation
-                                            (int code);

-Check whether the character is part of CJKSymbolsandPunctuation UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKUnifiedIdeographs ()
int         xmlUCSIsCJKUnifiedIdeographs    (int code);

-Check whether the character is part of CJKUnifiedIdeographs UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKUnifiedIdeographsExtensionA ()
int         xmlUCSIsCJKUnifiedIdeographsExtensionA
-                                            (int code);

-Check whether the character is part of CJKUnifiedIdeographsExtensionA UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCJKUnifiedIdeographsExtensionB ()
int         xmlUCSIsCJKUnifiedIdeographsExtensionB
-                                            (int code);

-Check whether the character is part of CJKUnifiedIdeographsExtensionB UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCherokee ()
int         xmlUCSIsCherokee                (int code);

-Check whether the character is part of Cherokee UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCombiningDiacriticalMarks ()
int         xmlUCSIsCombiningDiacriticalMarks
-                                            (int code);

-Check whether the character is part of CombiningDiacriticalMarks UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCombiningDiacriticalMarksforSymbols ()
int         xmlUCSIsCombiningDiacriticalMarksforSymbols
-                                            (int code);

-Check whether the character is part of CombiningDiacriticalMarksforSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCombiningHalfMarks ()
int         xmlUCSIsCombiningHalfMarks      (int code);

-Check whether the character is part of CombiningHalfMarks UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCombiningMarksforSymbols ()
int         xmlUCSIsCombiningMarksforSymbols
-                                            (int code);

-Check whether the character is part of CombiningMarksforSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsControlPictures ()
int         xmlUCSIsControlPictures         (int code);

-Check whether the character is part of ControlPictures UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCurrencySymbols ()
int         xmlUCSIsCurrencySymbols         (int code);

-Check whether the character is part of CurrencySymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCypriotSyllabary ()
int         xmlUCSIsCypriotSyllabary        (int code);

-Check whether the character is part of CypriotSyllabary UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCyrillic ()
int         xmlUCSIsCyrillic                (int code);

-Check whether the character is part of Cyrillic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCyrillicSupplement ()
int         xmlUCSIsCyrillicSupplement      (int code);

-Check whether the character is part of CyrillicSupplement UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsDeseret ()
int         xmlUCSIsDeseret                 (int code);

-Check whether the character is part of Deseret UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsDevanagari ()
int         xmlUCSIsDevanagari              (int code);

-Check whether the character is part of Devanagari UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsDingbats ()
int         xmlUCSIsDingbats                (int code);

-Check whether the character is part of Dingbats UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsEnclosedAlphanumerics ()
int         xmlUCSIsEnclosedAlphanumerics   (int code);

-Check whether the character is part of EnclosedAlphanumerics UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsEnclosedCJKLettersandMonths ()
int         xmlUCSIsEnclosedCJKLettersandMonths
-                                            (int code);

-Check whether the character is part of EnclosedCJKLettersandMonths UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsEthiopic ()
int         xmlUCSIsEthiopic                (int code);

-Check whether the character is part of Ethiopic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGeneralPunctuation ()
int         xmlUCSIsGeneralPunctuation      (int code);

-Check whether the character is part of GeneralPunctuation UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGeometricShapes ()
int         xmlUCSIsGeometricShapes         (int code);

-Check whether the character is part of GeometricShapes UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGeorgian ()
int         xmlUCSIsGeorgian                (int code);

-Check whether the character is part of Georgian UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGothic ()
int         xmlUCSIsGothic                  (int code);

-Check whether the character is part of Gothic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGreek ()
int         xmlUCSIsGreek                   (int code);

-Check whether the character is part of Greek UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGreekExtended ()
int         xmlUCSIsGreekExtended           (int code);

-Check whether the character is part of GreekExtended UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGreekandCoptic ()
int         xmlUCSIsGreekandCoptic          (int code);

-Check whether the character is part of GreekandCoptic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGujarati ()
int         xmlUCSIsGujarati                (int code);

-Check whether the character is part of Gujarati UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsGurmukhi ()
int         xmlUCSIsGurmukhi                (int code);

-Check whether the character is part of Gurmukhi UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHalfwidthandFullwidthForms ()
int         xmlUCSIsHalfwidthandFullwidthForms
-                                            (int code);

-Check whether the character is part of HalfwidthandFullwidthForms UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHangulCompatibilityJamo ()
int         xmlUCSIsHangulCompatibilityJamo (int code);

-Check whether the character is part of HangulCompatibilityJamo UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHangulJamo ()
int         xmlUCSIsHangulJamo              (int code);

-Check whether the character is part of HangulJamo UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHangulSyllables ()
int         xmlUCSIsHangulSyllables         (int code);

-Check whether the character is part of HangulSyllables UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHanunoo ()
int         xmlUCSIsHanunoo                 (int code);

-Check whether the character is part of Hanunoo UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHebrew ()
int         xmlUCSIsHebrew                  (int code);

-Check whether the character is part of Hebrew UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHighPrivateUseSurrogates ()
int         xmlUCSIsHighPrivateUseSurrogates
-                                            (int code);

-Check whether the character is part of HighPrivateUseSurrogates UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHighSurrogates ()
int         xmlUCSIsHighSurrogates          (int code);

-Check whether the character is part of HighSurrogates UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsHiragana ()
int         xmlUCSIsHiragana                (int code);

-Check whether the character is part of Hiragana UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsIPAExtensions ()
int         xmlUCSIsIPAExtensions           (int code);

-Check whether the character is part of IPAExtensions UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsIdeographicDescriptionCharacters ()
int         xmlUCSIsIdeographicDescriptionCharacters
-                                            (int code);

-Check whether the character is part of IdeographicDescriptionCharacters UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsKanbun ()
int         xmlUCSIsKanbun                  (int code);

-Check whether the character is part of Kanbun UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsKangxiRadicals ()
int         xmlUCSIsKangxiRadicals          (int code);

-Check whether the character is part of KangxiRadicals UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsKannada ()
int         xmlUCSIsKannada                 (int code);

-Check whether the character is part of Kannada UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsKatakana ()
int         xmlUCSIsKatakana                (int code);

-Check whether the character is part of Katakana UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsKatakanaPhoneticExtensions ()
int         xmlUCSIsKatakanaPhoneticExtensions
-                                            (int code);

-Check whether the character is part of KatakanaPhoneticExtensions UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsKhmer ()
int         xmlUCSIsKhmer                   (int code);

-Check whether the character is part of Khmer UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsKhmerSymbols ()
int         xmlUCSIsKhmerSymbols            (int code);

-Check whether the character is part of KhmerSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLao ()
int         xmlUCSIsLao                     (int code);

-Check whether the character is part of Lao UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLatin1Supplement ()
int         xmlUCSIsLatin1Supplement        (int code);

-Check whether the character is part of Latin-1Supplement UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLatinExtendedA ()
int         xmlUCSIsLatinExtendedA          (int code);

-Check whether the character is part of LatinExtended-A UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLatinExtendedB ()
int         xmlUCSIsLatinExtendedB          (int code);

-Check whether the character is part of LatinExtended-B UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLatinExtendedAdditional ()
int         xmlUCSIsLatinExtendedAdditional (int code);

-Check whether the character is part of LatinExtendedAdditional UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLetterlikeSymbols ()
int         xmlUCSIsLetterlikeSymbols       (int code);

-Check whether the character is part of LetterlikeSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLimbu ()
int         xmlUCSIsLimbu                   (int code);

-Check whether the character is part of Limbu UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLinearBIdeograms ()
int         xmlUCSIsLinearBIdeograms        (int code);

-Check whether the character is part of LinearBIdeograms UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLinearBSyllabary ()
int         xmlUCSIsLinearBSyllabary        (int code);

-Check whether the character is part of LinearBSyllabary UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsLowSurrogates ()
int         xmlUCSIsLowSurrogates           (int code);

-Check whether the character is part of LowSurrogates UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMalayalam ()
int         xmlUCSIsMalayalam               (int code);

-Check whether the character is part of Malayalam UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMathematicalAlphanumericSymbols ()
int         xmlUCSIsMathematicalAlphanumericSymbols
-                                            (int code);

-Check whether the character is part of MathematicalAlphanumericSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMathematicalOperators ()
int         xmlUCSIsMathematicalOperators   (int code);

-Check whether the character is part of MathematicalOperators UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMiscellaneousMathematicalSymbolsA ()
int         xmlUCSIsMiscellaneousMathematicalSymbolsA
-                                            (int code);

-Check whether the character is part of MiscellaneousMathematicalSymbols-A UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMiscellaneousMathematicalSymbolsB ()
int         xmlUCSIsMiscellaneousMathematicalSymbolsB
-                                            (int code);

-Check whether the character is part of MiscellaneousMathematicalSymbols-B UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMiscellaneousSymbols ()
int         xmlUCSIsMiscellaneousSymbols    (int code);

-Check whether the character is part of MiscellaneousSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMiscellaneousSymbolsandArrows ()
int         xmlUCSIsMiscellaneousSymbolsandArrows
-                                            (int code);

-Check whether the character is part of MiscellaneousSymbolsandArrows UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMiscellaneousTechnical ()
int         xmlUCSIsMiscellaneousTechnical  (int code);

-Check whether the character is part of MiscellaneousTechnical UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMongolian ()
int         xmlUCSIsMongolian               (int code);

-Check whether the character is part of Mongolian UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMusicalSymbols ()
int         xmlUCSIsMusicalSymbols          (int code);

-Check whether the character is part of MusicalSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsMyanmar ()
int         xmlUCSIsMyanmar                 (int code);

-Check whether the character is part of Myanmar UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsNumberForms ()
int         xmlUCSIsNumberForms             (int code);

-Check whether the character is part of NumberForms UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsOgham ()
int         xmlUCSIsOgham                   (int code);

-Check whether the character is part of Ogham UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsOldItalic ()
int         xmlUCSIsOldItalic               (int code);

-Check whether the character is part of OldItalic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsOpticalCharacterRecognition ()
int         xmlUCSIsOpticalCharacterRecognition
-                                            (int code);

-Check whether the character is part of OpticalCharacterRecognition UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsOriya ()
int         xmlUCSIsOriya                   (int code);

-Check whether the character is part of Oriya UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsOsmanya ()
int         xmlUCSIsOsmanya                 (int code);

-Check whether the character is part of Osmanya UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsPhoneticExtensions ()
int         xmlUCSIsPhoneticExtensions      (int code);

-Check whether the character is part of PhoneticExtensions UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsPrivateUse ()
int         xmlUCSIsPrivateUse              (int code);

-Check whether the character is part of PrivateUse UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsPrivateUseArea ()
int         xmlUCSIsPrivateUseArea          (int code);

-Check whether the character is part of PrivateUseArea UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsRunic ()
int         xmlUCSIsRunic                   (int code);

-Check whether the character is part of Runic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsShavian ()
int         xmlUCSIsShavian                 (int code);

-Check whether the character is part of Shavian UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSinhala ()
int         xmlUCSIsSinhala                 (int code);

-Check whether the character is part of Sinhala UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSmallFormVariants ()
int         xmlUCSIsSmallFormVariants       (int code);

-Check whether the character is part of SmallFormVariants UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSpacingModifierLetters ()
int         xmlUCSIsSpacingModifierLetters  (int code);

-Check whether the character is part of SpacingModifierLetters UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSpecials ()
int         xmlUCSIsSpecials                (int code);

-Check whether the character is part of Specials UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSuperscriptsandSubscripts ()
int         xmlUCSIsSuperscriptsandSubscripts
-                                            (int code);

-Check whether the character is part of SuperscriptsandSubscripts UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSupplementalArrowsA ()
int         xmlUCSIsSupplementalArrowsA     (int code);

-Check whether the character is part of SupplementalArrows-A UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSupplementalArrowsB ()
int         xmlUCSIsSupplementalArrowsB     (int code);

-Check whether the character is part of SupplementalArrows-B UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSupplementalMathematicalOperators ()
int         xmlUCSIsSupplementalMathematicalOperators
-                                            (int code);

-Check whether the character is part of SupplementalMathematicalOperators UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSupplementaryPrivateUseAreaA ()
int         xmlUCSIsSupplementaryPrivateUseAreaA
-                                            (int code);

-Check whether the character is part of SupplementaryPrivateUseArea-A UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSupplementaryPrivateUseAreaB ()
int         xmlUCSIsSupplementaryPrivateUseAreaB
-                                            (int code);

-Check whether the character is part of SupplementaryPrivateUseArea-B UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsSyriac ()
int         xmlUCSIsSyriac                  (int code);

-Check whether the character is part of Syriac UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTagalog ()
int         xmlUCSIsTagalog                 (int code);

-Check whether the character is part of Tagalog UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTagbanwa ()
int         xmlUCSIsTagbanwa                (int code);

-Check whether the character is part of Tagbanwa UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTags ()
int         xmlUCSIsTags                    (int code);

-Check whether the character is part of Tags UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTaiLe ()
int         xmlUCSIsTaiLe                   (int code);

-Check whether the character is part of TaiLe UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTaiXuanJingSymbols ()
int         xmlUCSIsTaiXuanJingSymbols      (int code);

-Check whether the character is part of TaiXuanJingSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTamil ()
int         xmlUCSIsTamil                   (int code);

-Check whether the character is part of Tamil UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTelugu ()
int         xmlUCSIsTelugu                  (int code);

-Check whether the character is part of Telugu UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsThaana ()
int         xmlUCSIsThaana                  (int code);

-Check whether the character is part of Thaana UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsThai ()
int         xmlUCSIsThai                    (int code);

-Check whether the character is part of Thai UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsTibetan ()
int         xmlUCSIsTibetan                 (int code);

-Check whether the character is part of Tibetan UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsUgaritic ()
int         xmlUCSIsUgaritic                (int code);

-Check whether the character is part of Ugaritic UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsUnifiedCanadianAboriginalSyllabics ()
int         xmlUCSIsUnifiedCanadianAboriginalSyllabics
-                                            (int code);

-Check whether the character is part of UnifiedCanadianAboriginalSyllabics UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsVariationSelectors ()
int         xmlUCSIsVariationSelectors      (int code);

-Check whether the character is part of VariationSelectors UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsVariationSelectorsSupplement ()
int         xmlUCSIsVariationSelectorsSupplement
-                                            (int code);

-Check whether the character is part of VariationSelectorsSupplement UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsYiRadicals ()
int         xmlUCSIsYiRadicals              (int code);

-Check whether the character is part of YiRadicals UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsYiSyllables ()
int         xmlUCSIsYiSyllables             (int code);

-Check whether the character is part of YiSyllables UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsYijingHexagramSymbols ()
int         xmlUCSIsYijingHexagramSymbols   (int code);

-Check whether the character is part of YijingHexagramSymbols UCS Block

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsBlock ()
int         xmlUCSIsBlock                   (int code,
-                                             const char *block);

-Check whether the character is part of the UCS Block

-
-
code: UCS code point
-
block: UCS block name
-
Returns :1 if true, 0 if false and -1 on unknown block
-
xmlUCSIsCatC ()
int         xmlUCSIsCatC                    (int code);

-Check whether the character is part of C UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatCc ()
int         xmlUCSIsCatCc                   (int code);

-Check whether the character is part of Cc UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatCf ()
int         xmlUCSIsCatCf                   (int code);

-Check whether the character is part of Cf UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatCo ()
int         xmlUCSIsCatCo                   (int code);

-Check whether the character is part of Co UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatCs ()
int         xmlUCSIsCatCs                   (int code);

-Check whether the character is part of Cs UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatL ()
int         xmlUCSIsCatL                    (int code);

-Check whether the character is part of L UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatLl ()
int         xmlUCSIsCatLl                   (int code);

-Check whether the character is part of Ll UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatLm ()
int         xmlUCSIsCatLm                   (int code);

-Check whether the character is part of Lm UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatLo ()
int         xmlUCSIsCatLo                   (int code);

-Check whether the character is part of Lo UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatLt ()
int         xmlUCSIsCatLt                   (int code);

-Check whether the character is part of Lt UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatLu ()
int         xmlUCSIsCatLu                   (int code);

-Check whether the character is part of Lu UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatM ()
int         xmlUCSIsCatM                    (int code);

-Check whether the character is part of M UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatMc ()
int         xmlUCSIsCatMc                   (int code);

-Check whether the character is part of Mc UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatMe ()
int         xmlUCSIsCatMe                   (int code);

-Check whether the character is part of Me UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatMn ()
int         xmlUCSIsCatMn                   (int code);

-Check whether the character is part of Mn UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatN ()
int         xmlUCSIsCatN                    (int code);

-Check whether the character is part of N UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatNd ()
int         xmlUCSIsCatNd                   (int code);

-Check whether the character is part of Nd UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatNl ()
int         xmlUCSIsCatNl                   (int code);

-Check whether the character is part of Nl UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatNo ()
int         xmlUCSIsCatNo                   (int code);

-Check whether the character is part of No UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatP ()
int         xmlUCSIsCatP                    (int code);

-Check whether the character is part of P UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatPc ()
int         xmlUCSIsCatPc                   (int code);

-Check whether the character is part of Pc UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatPd ()
int         xmlUCSIsCatPd                   (int code);

-Check whether the character is part of Pd UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatPe ()
int         xmlUCSIsCatPe                   (int code);

-Check whether the character is part of Pe UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatPf ()
int         xmlUCSIsCatPf                   (int code);

-Check whether the character is part of Pf UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatPi ()
int         xmlUCSIsCatPi                   (int code);

-Check whether the character is part of Pi UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatPo ()
int         xmlUCSIsCatPo                   (int code);

-Check whether the character is part of Po UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatPs ()
int         xmlUCSIsCatPs                   (int code);

-Check whether the character is part of Ps UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatS ()
int         xmlUCSIsCatS                    (int code);

-Check whether the character is part of S UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatSc ()
int         xmlUCSIsCatSc                   (int code);

-Check whether the character is part of Sc UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatSk ()
int         xmlUCSIsCatSk                   (int code);

-Check whether the character is part of Sk UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatSm ()
int         xmlUCSIsCatSm                   (int code);

-Check whether the character is part of Sm UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatSo ()
int         xmlUCSIsCatSo                   (int code);

-Check whether the character is part of So UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatZ ()
int         xmlUCSIsCatZ                    (int code);

-Check whether the character is part of Z UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatZl ()
int         xmlUCSIsCatZl                   (int code);

-Check whether the character is part of Zl UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatZp ()
int         xmlUCSIsCatZp                   (int code);

-Check whether the character is part of Zp UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCatZs ()
int         xmlUCSIsCatZs                   (int code);

-Check whether the character is part of Zs UCS Category

-
-
code: UCS code point
-
Returns :1 if true 0 otherwise
-
xmlUCSIsCat ()
int         xmlUCSIsCat                     (int code,
-                                             const char *cat);

-Check whether the character is part of the UCS Category

-
-
code: UCS code point
-
cat: UCS Category name
-
Returns :1 if true, 0 if false and -1 on unknown category
-
<< globalsxmlexports >>

+
+
+Module xmlunicode from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlunicode from libxml2
Main Menu
Related links
Table of Contents
int	xmlUCSIsBlockElements	(int code)

+
int	xmlUCSIsVariationSelectorsSupplement	(int code)

+
int	xmlUCSIsTags	(int code)

+
int	xmlUCSIsEnclosedAlphanumerics	(int code)

+
int	xmlUCSIsBopomofo	(int code)

+
int	xmlUCSIsSinhala	(int code)

+
int	xmlUCSIsDingbats	(int code)

+
int	xmlUCSIsLatinExtendedB	(int code)

+
int	xmlUCSIsCombiningHalfMarks	(int code)

+
int	xmlUCSIsSupplementalArrowsA	(int code)

+
int	xmlUCSIsLatinExtendedA	(int code)

+
int	xmlUCSIsYiRadicals	(int code)

+
int	xmlUCSIsCombiningDiacriticalMarks	(int code)

+
int	xmlUCSIsCombiningMarksforSymbols	(int code)

+
int	xmlUCSIsHalfwidthandFullwidthForms	(int code)

+
int	xmlUCSIsBasicLatin	(int code)

+
int	xmlUCSIsOldItalic	(int code)

+
int	xmlUCSIsLimbu	(int code)

+
int	xmlUCSIsCat	(int code, 
				 const char * cat)

+
int	xmlUCSIsCatSo	(int code)

+
int	xmlUCSIsCatLu	(int code)

+
int	xmlUCSIsCatLt	(int code)

+
int	xmlUCSIsYiSyllables	(int code)

+
int	xmlUCSIsCatSk	(int code)

+
int	xmlUCSIsCatLo	(int code)

+
int	xmlUCSIsKhmerSymbols	(int code)

+
int	xmlUCSIsCatLm	(int code)

+
int	xmlUCSIsAlphabeticPresentationForms	(int code)

+
int	xmlUCSIsMiscellaneousTechnical	(int code)

+
int	xmlUCSIsMongolian	(int code)

+
int	xmlUCSIsUgaritic	(int code)

+
int	xmlUCSIsCJKCompatibilityIdeographsSupplement	(int code)

+
int	xmlUCSIsKannada	(int code)

+
int	xmlUCSIsMalayalam	(int code)

+
int	xmlUCSIsCypriotSyllabary	(int code)

+
int	xmlUCSIsTamil	(int code)

+
int	xmlUCSIsCatC	(int code)

+
int	xmlUCSIsUnifiedCanadianAboriginalSyllabics	(int code)

+
int	xmlUCSIsCatN	(int code)

+
int	xmlUCSIsCatLl	(int code)

+
int	xmlUCSIsCatL	(int code)

+
int	xmlUCSIsCatM	(int code)

+
int	xmlUCSIsTelugu	(int code)

+
int	xmlUCSIsMathematicalAlphanumericSymbols	(int code)

+
int	xmlUCSIsLowSurrogates	(int code)

+
int	xmlUCSIsOsmanya	(int code)

+
int	xmlUCSIsGreek	(int code)

+
int	xmlUCSIsEthiopic	(int code)

+
int	xmlUCSIsCatP	(int code)

+
int	xmlUCSIsBoxDrawing	(int code)

+
int	xmlUCSIsGeorgian	(int code)

+
int	xmlUCSIsOgham	(int code)

+
int	xmlUCSIsCatZ	(int code)

+
int	xmlUCSIsGreekandCoptic	(int code)

+
int	xmlUCSIsIPAExtensions	(int code)

+
int	xmlUCSIsByzantineMusicalSymbols	(int code)

+
int	xmlUCSIsKangxiRadicals	(int code)

+
int	xmlUCSIsEnclosedCJKLettersandMonths	(int code)

+
int	xmlUCSIsCJKCompatibilityForms	(int code)

+
int	xmlUCSIsCatCs	(int code)

+
int	xmlUCSIsHanunoo	(int code)

+
int	xmlUCSIsGreekExtended	(int code)

+
int	xmlUCSIsCJKRadicalsSupplement	(int code)

+
int	xmlUCSIsArmenian	(int code)

+
int	xmlUCSIsCatCf	(int code)

+
int	xmlUCSIsSmallFormVariants	(int code)

+
int	xmlUCSIsHangulCompatibilityJamo	(int code)

+
int	xmlUCSIsSupplementaryPrivateUseAreaB	(int code)

+
int	xmlUCSIsCatCc	(int code)

+
int	xmlUCSIsSupplementaryPrivateUseAreaA	(int code)

+
int	xmlUCSIsCatCo	(int code)

+
int	xmlUCSIsCherokee	(int code)

+
int	xmlUCSIsCatPe	(int code)

+
int	xmlUCSIsKatakanaPhoneticExtensions	(int code)

+
int	xmlUCSIsLinearBSyllabary	(int code)

+
int	xmlUCSIsGothic	(int code)

+
int	xmlUCSIsLetterlikeSymbols	(int code)

+
int	xmlUCSIsKhmer	(int code)

+
int	xmlUCSIsCatNd	(int code)

+
int	xmlUCSIsPhoneticExtensions	(int code)

+
int	xmlUCSIsTaiLe	(int code)

+
int	xmlUCSIsArabic	(int code)

+
int	xmlUCSIsHebrew	(int code)

+
int	xmlUCSIsMiscellaneousMathematicalSymbolsB	(int code)

+
int	xmlUCSIsCombiningDiacriticalMarksforSymbols	(int code)

+
int	xmlUCSIsVariationSelectors	(int code)

+
int	xmlUCSIsArabicPresentationFormsA	(int code)

+
int	xmlUCSIsCatZp	(int code)

+
int	xmlUCSIsCatZs	(int code)

+
int	xmlUCSIsArabicPresentationFormsB	(int code)

+
int	xmlUCSIsGeometricShapes	(int code)

+
int	xmlUCSIsCatZl	(int code)

+
int	xmlUCSIsTagalog	(int code)

+
int	xmlUCSIsSpecials	(int code)

+
int	xmlUCSIsGujarati	(int code)

+
int	xmlUCSIsLinearBIdeograms	(int code)

+
int	xmlUCSIsMiscellaneousMathematicalSymbolsA	(int code)

+
int	xmlUCSIsBlock	(int code, 
				 const char * block)

+
int	xmlUCSIsBopomofoExtended	(int code)

+
int	xmlUCSIsThaana	(int code)

+
int	xmlUCSIsIdeographicDescriptionCharacters	(int code)

+
int	xmlUCSIsHangulJamo	(int code)

+
int	xmlUCSIsShavian	(int code)

+
int	xmlUCSIsTagbanwa	(int code)

+
int	xmlUCSIsGeneralPunctuation	(int code)

+
int	xmlUCSIsCyrillic	(int code)

+
int	xmlUCSIsArrows	(int code)

+
int	xmlUCSIsControlPictures	(int code)

+
int	xmlUCSIsYijingHexagramSymbols	(int code)

+
int	xmlUCSIsCJKUnifiedIdeographs	(int code)

+
int	xmlUCSIsCatNl	(int code)

+
int	xmlUCSIsCatNo	(int code)

+
int	xmlUCSIsDeseret	(int code)

+
int	xmlUCSIsCatSm	(int code)

+
int	xmlUCSIsBengali	(int code)

+
int	xmlUCSIsPrivateUse	(int code)

+
int	xmlUCSIsMusicalSymbols	(int code)

+
int	xmlUCSIsBuhid	(int code)

+
int	xmlUCSIsHangulSyllables	(int code)

+
int	xmlUCSIsCJKCompatibility	(int code)

+
int	xmlUCSIsCJKCompatibilityIdeographs	(int code)

+
int	xmlUCSIsOpticalCharacterRecognition	(int code)

+
int	xmlUCSIsLatin1Supplement	(int code)

+
int	xmlUCSIsAegeanNumbers	(int code)

+
int	xmlUCSIsKatakana	(int code)

+
int	xmlUCSIsCJKSymbolsandPunctuation	(int code)

+
int	xmlUCSIsTaiXuanJingSymbols	(int code)

+
int	xmlUCSIsGurmukhi	(int code)

+
int	xmlUCSIsMiscellaneousSymbols	(int code)

+
int	xmlUCSIsDevanagari	(int code)

+
int	xmlUCSIsPrivateUseArea	(int code)

+
int	xmlUCSIsMathematicalOperators	(int code)

+
int	xmlUCSIsMiscellaneousSymbolsandArrows	(int code)

+
int	xmlUCSIsSupplementalArrowsB	(int code)

+
int	xmlUCSIsCurrencySymbols	(int code)

+
int	xmlUCSIsNumberForms	(int code)

+
int	xmlUCSIsTibetan	(int code)

+
int	xmlUCSIsSupplementalMathematicalOperators	(int code)

+
int	xmlUCSIsCJKUnifiedIdeographsExtensionA	(int code)

+
int	xmlUCSIsKanbun	(int code)

+
int	xmlUCSIsCJKUnifiedIdeographsExtensionB	(int code)

+
int	xmlUCSIsThai	(int code)

+
int	xmlUCSIsSpacingModifierLetters	(int code)

+
int	xmlUCSIsRunic	(int code)

+
int	xmlUCSIsCatSc	(int code)

+
int	xmlUCSIsCatPc	(int code)

+
int	xmlUCSIsCatMc	(int code)

+
int	xmlUCSIsCatPf	(int code)

+
int	xmlUCSIsCyrillicSupplement	(int code)

+
int	xmlUCSIsCatPd	(int code)

+
int	xmlUCSIsMyanmar	(int code)

+
int	xmlUCSIsCatPi	(int code)

+
int	xmlUCSIsHiragana	(int code)

+
int	xmlUCSIsCatPo	(int code)

+
int	xmlUCSIsHighPrivateUseSurrogates	(int code)

+
int	xmlUCSIsLatinExtendedAdditional	(int code)

+
int	xmlUCSIsCatPs	(int code)

+
int	xmlUCSIsSyriac	(int code)

+
int	xmlUCSIsSuperscriptsandSubscripts	(int code)

+
int	xmlUCSIsHighSurrogates	(int code)

+
int	xmlUCSIsCatMn	(int code)

+
int	xmlUCSIsLao	(int code)

+
int	xmlUCSIsOriya	(int code)

+
int	xmlUCSIsBraillePatterns	(int code)

+
int	xmlUCSIsCatMe	(int code)

+
int	xmlUCSIsCatS	(int code)

+
Description

+
Function: xmlUCSIsBlockElements
int	xmlUCSIsBlockElements	(int code)

+
Check whether the character is part of BlockElements UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsVariationSelectorsSupplement
int	xmlUCSIsVariationSelectorsSupplement	(int code)

+
Check whether the character is part of VariationSelectorsSupplement UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTags
int	xmlUCSIsTags	(int code)

+
Check whether the character is part of Tags UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsEnclosedAlphanumerics
int	xmlUCSIsEnclosedAlphanumerics	(int code)

+
Check whether the character is part of EnclosedAlphanumerics UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsBopomofo
int	xmlUCSIsBopomofo	(int code)

+
Check whether the character is part of Bopomofo UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSinhala
int	xmlUCSIsSinhala	(int code)

+
Check whether the character is part of Sinhala UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsDingbats
int	xmlUCSIsDingbats	(int code)

+
Check whether the character is part of Dingbats UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLatinExtendedB
int	xmlUCSIsLatinExtendedB	(int code)

+
Check whether the character is part of LatinExtended-B UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCombiningHalfMarks
int	xmlUCSIsCombiningHalfMarks	(int code)

+
Check whether the character is part of CombiningHalfMarks UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSupplementalArrowsA
int	xmlUCSIsSupplementalArrowsA	(int code)

+
Check whether the character is part of SupplementalArrows-A UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLatinExtendedA
int	xmlUCSIsLatinExtendedA	(int code)

+
Check whether the character is part of LatinExtended-A UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsYiRadicals
int	xmlUCSIsYiRadicals	(int code)

+
Check whether the character is part of YiRadicals UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCombiningDiacriticalMarks
int	xmlUCSIsCombiningDiacriticalMarks	(int code)

+
Check whether the character is part of CombiningDiacriticalMarks UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCombiningMarksforSymbols
int	xmlUCSIsCombiningMarksforSymbols	(int code)

+
Check whether the character is part of CombiningMarksforSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHalfwidthandFullwidthForms
int	xmlUCSIsHalfwidthandFullwidthForms	(int code)

+
Check whether the character is part of HalfwidthandFullwidthForms UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsBasicLatin
int	xmlUCSIsBasicLatin	(int code)

+
Check whether the character is part of BasicLatin UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsOldItalic
int	xmlUCSIsOldItalic	(int code)

+
Check whether the character is part of OldItalic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLimbu
int	xmlUCSIsLimbu	(int code)

+
Check whether the character is part of Limbu UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCat
int	xmlUCSIsCat	(int code, 
				 const char * cat)

+
Check whether the character is part of the UCS Category

+
code:UCS code point
cat:UCS Category name
Returns:1 if true, 0 if false and -1 on unknown category
Function: xmlUCSIsCatSo
int	xmlUCSIsCatSo	(int code)

+
Check whether the character is part of So UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatLu
int	xmlUCSIsCatLu	(int code)

+
Check whether the character is part of Lu UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatLt
int	xmlUCSIsCatLt	(int code)

+
Check whether the character is part of Lt UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsYiSyllables
int	xmlUCSIsYiSyllables	(int code)

+
Check whether the character is part of YiSyllables UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatSk
int	xmlUCSIsCatSk	(int code)

+
Check whether the character is part of Sk UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatLo
int	xmlUCSIsCatLo	(int code)

+
Check whether the character is part of Lo UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsKhmerSymbols
int	xmlUCSIsKhmerSymbols	(int code)

+
Check whether the character is part of KhmerSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatLm
int	xmlUCSIsCatLm	(int code)

+
Check whether the character is part of Lm UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsAlphabeticPresentationForms
int	xmlUCSIsAlphabeticPresentationForms	(int code)

+
Check whether the character is part of AlphabeticPresentationForms UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMiscellaneousTechnical
int	xmlUCSIsMiscellaneousTechnical	(int code)

+
Check whether the character is part of MiscellaneousTechnical UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMongolian
int	xmlUCSIsMongolian	(int code)

+
Check whether the character is part of Mongolian UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsUgaritic
int	xmlUCSIsUgaritic	(int code)

+
Check whether the character is part of Ugaritic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKCompatibilityIdeographsSupplement
int	xmlUCSIsCJKCompatibilityIdeographsSupplement	(int code)

+
Check whether the character is part of CJKCompatibilityIdeographsSupplement UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsKannada
int	xmlUCSIsKannada	(int code)

+
Check whether the character is part of Kannada UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMalayalam
int	xmlUCSIsMalayalam	(int code)

+
Check whether the character is part of Malayalam UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCypriotSyllabary
int	xmlUCSIsCypriotSyllabary	(int code)

+
Check whether the character is part of CypriotSyllabary UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTamil
int	xmlUCSIsTamil	(int code)

+
Check whether the character is part of Tamil UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatC
int	xmlUCSIsCatC	(int code)

+
Check whether the character is part of C UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsUnifiedCanadianAboriginalSyllabics
int	xmlUCSIsUnifiedCanadianAboriginalSyllabics	(int code)

+
Check whether the character is part of UnifiedCanadianAboriginalSyllabics UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatN
int	xmlUCSIsCatN	(int code)

+
Check whether the character is part of N UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatLl
int	xmlUCSIsCatLl	(int code)

+
Check whether the character is part of Ll UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatL
int	xmlUCSIsCatL	(int code)

+
Check whether the character is part of L UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatM
int	xmlUCSIsCatM	(int code)

+
Check whether the character is part of M UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTelugu
int	xmlUCSIsTelugu	(int code)

+
Check whether the character is part of Telugu UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMathematicalAlphanumericSymbols
int	xmlUCSIsMathematicalAlphanumericSymbols	(int code)

+
Check whether the character is part of MathematicalAlphanumericSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLowSurrogates
int	xmlUCSIsLowSurrogates	(int code)

+
Check whether the character is part of LowSurrogates UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsOsmanya
int	xmlUCSIsOsmanya	(int code)

+
Check whether the character is part of Osmanya UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGreek
int	xmlUCSIsGreek	(int code)

+
Check whether the character is part of Greek UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsEthiopic
int	xmlUCSIsEthiopic	(int code)

+
Check whether the character is part of Ethiopic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatP
int	xmlUCSIsCatP	(int code)

+
Check whether the character is part of P UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsBoxDrawing
int	xmlUCSIsBoxDrawing	(int code)

+
Check whether the character is part of BoxDrawing UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGeorgian
int	xmlUCSIsGeorgian	(int code)

+
Check whether the character is part of Georgian UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsOgham
int	xmlUCSIsOgham	(int code)

+
Check whether the character is part of Ogham UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatZ
int	xmlUCSIsCatZ	(int code)

+
Check whether the character is part of Z UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGreekandCoptic
int	xmlUCSIsGreekandCoptic	(int code)

+
Check whether the character is part of GreekandCoptic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsIPAExtensions
int	xmlUCSIsIPAExtensions	(int code)

+
Check whether the character is part of IPAExtensions UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsByzantineMusicalSymbols
int	xmlUCSIsByzantineMusicalSymbols	(int code)

+
Check whether the character is part of ByzantineMusicalSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsKangxiRadicals
int	xmlUCSIsKangxiRadicals	(int code)

+
Check whether the character is part of KangxiRadicals UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsEnclosedCJKLettersandMonths
int	xmlUCSIsEnclosedCJKLettersandMonths	(int code)

+
Check whether the character is part of EnclosedCJKLettersandMonths UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKCompatibilityForms
int	xmlUCSIsCJKCompatibilityForms	(int code)

+
Check whether the character is part of CJKCompatibilityForms UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatCs
int	xmlUCSIsCatCs	(int code)

+
Check whether the character is part of Cs UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHanunoo
int	xmlUCSIsHanunoo	(int code)

+
Check whether the character is part of Hanunoo UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGreekExtended
int	xmlUCSIsGreekExtended	(int code)

+
Check whether the character is part of GreekExtended UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKRadicalsSupplement
int	xmlUCSIsCJKRadicalsSupplement	(int code)

+
Check whether the character is part of CJKRadicalsSupplement UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsArmenian
int	xmlUCSIsArmenian	(int code)

+
Check whether the character is part of Armenian UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatCf
int	xmlUCSIsCatCf	(int code)

+
Check whether the character is part of Cf UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSmallFormVariants
int	xmlUCSIsSmallFormVariants	(int code)

+
Check whether the character is part of SmallFormVariants UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHangulCompatibilityJamo
int	xmlUCSIsHangulCompatibilityJamo	(int code)

+
Check whether the character is part of HangulCompatibilityJamo UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSupplementaryPrivateUseAreaB
int	xmlUCSIsSupplementaryPrivateUseAreaB	(int code)

+
Check whether the character is part of SupplementaryPrivateUseArea-B UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatCc
int	xmlUCSIsCatCc	(int code)

+
Check whether the character is part of Cc UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSupplementaryPrivateUseAreaA
int	xmlUCSIsSupplementaryPrivateUseAreaA	(int code)

+
Check whether the character is part of SupplementaryPrivateUseArea-A UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatCo
int	xmlUCSIsCatCo	(int code)

+
Check whether the character is part of Co UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCherokee
int	xmlUCSIsCherokee	(int code)

+
Check whether the character is part of Cherokee UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatPe
int	xmlUCSIsCatPe	(int code)

+
Check whether the character is part of Pe UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsKatakanaPhoneticExtensions
int	xmlUCSIsKatakanaPhoneticExtensions	(int code)

+
Check whether the character is part of KatakanaPhoneticExtensions UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLinearBSyllabary
int	xmlUCSIsLinearBSyllabary	(int code)

+
Check whether the character is part of LinearBSyllabary UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGothic
int	xmlUCSIsGothic	(int code)

+
Check whether the character is part of Gothic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLetterlikeSymbols
int	xmlUCSIsLetterlikeSymbols	(int code)

+
Check whether the character is part of LetterlikeSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsKhmer
int	xmlUCSIsKhmer	(int code)

+
Check whether the character is part of Khmer UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatNd
int	xmlUCSIsCatNd	(int code)

+
Check whether the character is part of Nd UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsPhoneticExtensions
int	xmlUCSIsPhoneticExtensions	(int code)

+
Check whether the character is part of PhoneticExtensions UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTaiLe
int	xmlUCSIsTaiLe	(int code)

+
Check whether the character is part of TaiLe UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsArabic
int	xmlUCSIsArabic	(int code)

+
Check whether the character is part of Arabic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHebrew
int	xmlUCSIsHebrew	(int code)

+
Check whether the character is part of Hebrew UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMiscellaneousMathematicalSymbolsB
int	xmlUCSIsMiscellaneousMathematicalSymbolsB	(int code)

+
Check whether the character is part of MiscellaneousMathematicalSymbols-B UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCombiningDiacriticalMarksforSymbols
int	xmlUCSIsCombiningDiacriticalMarksforSymbols	(int code)

+
Check whether the character is part of CombiningDiacriticalMarksforSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsVariationSelectors
int	xmlUCSIsVariationSelectors	(int code)

+
Check whether the character is part of VariationSelectors UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsArabicPresentationFormsA
int	xmlUCSIsArabicPresentationFormsA	(int code)

+
Check whether the character is part of ArabicPresentationForms-A UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatZp
int	xmlUCSIsCatZp	(int code)

+
Check whether the character is part of Zp UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatZs
int	xmlUCSIsCatZs	(int code)

+
Check whether the character is part of Zs UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsArabicPresentationFormsB
int	xmlUCSIsArabicPresentationFormsB	(int code)

+
Check whether the character is part of ArabicPresentationForms-B UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGeometricShapes
int	xmlUCSIsGeometricShapes	(int code)

+
Check whether the character is part of GeometricShapes UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatZl
int	xmlUCSIsCatZl	(int code)

+
Check whether the character is part of Zl UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTagalog
int	xmlUCSIsTagalog	(int code)

+
Check whether the character is part of Tagalog UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSpecials
int	xmlUCSIsSpecials	(int code)

+
Check whether the character is part of Specials UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGujarati
int	xmlUCSIsGujarati	(int code)

+
Check whether the character is part of Gujarati UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLinearBIdeograms
int	xmlUCSIsLinearBIdeograms	(int code)

+
Check whether the character is part of LinearBIdeograms UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMiscellaneousMathematicalSymbolsA
int	xmlUCSIsMiscellaneousMathematicalSymbolsA	(int code)

+
Check whether the character is part of MiscellaneousMathematicalSymbols-A UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsBlock
int	xmlUCSIsBlock	(int code, 
				 const char * block)

+
Check whether the character is part of the UCS Block

+
code:UCS code point
block:UCS block name
Returns:1 if true, 0 if false and -1 on unknown block
Function: xmlUCSIsBopomofoExtended
int	xmlUCSIsBopomofoExtended	(int code)

+
Check whether the character is part of BopomofoExtended UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsThaana
int	xmlUCSIsThaana	(int code)

+
Check whether the character is part of Thaana UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsIdeographicDescriptionCharacters
int	xmlUCSIsIdeographicDescriptionCharacters	(int code)

+
Check whether the character is part of IdeographicDescriptionCharacters UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHangulJamo
int	xmlUCSIsHangulJamo	(int code)

+
Check whether the character is part of HangulJamo UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsShavian
int	xmlUCSIsShavian	(int code)

+
Check whether the character is part of Shavian UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTagbanwa
int	xmlUCSIsTagbanwa	(int code)

+
Check whether the character is part of Tagbanwa UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGeneralPunctuation
int	xmlUCSIsGeneralPunctuation	(int code)

+
Check whether the character is part of GeneralPunctuation UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCyrillic
int	xmlUCSIsCyrillic	(int code)

+
Check whether the character is part of Cyrillic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsArrows
int	xmlUCSIsArrows	(int code)

+
Check whether the character is part of Arrows UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsControlPictures
int	xmlUCSIsControlPictures	(int code)

+
Check whether the character is part of ControlPictures UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsYijingHexagramSymbols
int	xmlUCSIsYijingHexagramSymbols	(int code)

+
Check whether the character is part of YijingHexagramSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKUnifiedIdeographs
int	xmlUCSIsCJKUnifiedIdeographs	(int code)

+
Check whether the character is part of CJKUnifiedIdeographs UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatNl
int	xmlUCSIsCatNl	(int code)

+
Check whether the character is part of Nl UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatNo
int	xmlUCSIsCatNo	(int code)

+
Check whether the character is part of No UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsDeseret
int	xmlUCSIsDeseret	(int code)

+
Check whether the character is part of Deseret UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatSm
int	xmlUCSIsCatSm	(int code)

+
Check whether the character is part of Sm UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsBengali
int	xmlUCSIsBengali	(int code)

+
Check whether the character is part of Bengali UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsPrivateUse
int	xmlUCSIsPrivateUse	(int code)

+
Check whether the character is part of PrivateUse UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMusicalSymbols
int	xmlUCSIsMusicalSymbols	(int code)

+
Check whether the character is part of MusicalSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsBuhid
int	xmlUCSIsBuhid	(int code)

+
Check whether the character is part of Buhid UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHangulSyllables
int	xmlUCSIsHangulSyllables	(int code)

+
Check whether the character is part of HangulSyllables UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKCompatibility
int	xmlUCSIsCJKCompatibility	(int code)

+
Check whether the character is part of CJKCompatibility UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKCompatibilityIdeographs
int	xmlUCSIsCJKCompatibilityIdeographs	(int code)

+
Check whether the character is part of CJKCompatibilityIdeographs UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsOpticalCharacterRecognition
int	xmlUCSIsOpticalCharacterRecognition	(int code)

+
Check whether the character is part of OpticalCharacterRecognition UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLatin1Supplement
int	xmlUCSIsLatin1Supplement	(int code)

+
Check whether the character is part of Latin-1Supplement UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsAegeanNumbers
int	xmlUCSIsAegeanNumbers	(int code)

+
Check whether the character is part of AegeanNumbers UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsKatakana
int	xmlUCSIsKatakana	(int code)

+
Check whether the character is part of Katakana UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKSymbolsandPunctuation
int	xmlUCSIsCJKSymbolsandPunctuation	(int code)

+
Check whether the character is part of CJKSymbolsandPunctuation UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTaiXuanJingSymbols
int	xmlUCSIsTaiXuanJingSymbols	(int code)

+
Check whether the character is part of TaiXuanJingSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsGurmukhi
int	xmlUCSIsGurmukhi	(int code)

+
Check whether the character is part of Gurmukhi UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMiscellaneousSymbols
int	xmlUCSIsMiscellaneousSymbols	(int code)

+
Check whether the character is part of MiscellaneousSymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsDevanagari
int	xmlUCSIsDevanagari	(int code)

+
Check whether the character is part of Devanagari UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsPrivateUseArea
int	xmlUCSIsPrivateUseArea	(int code)

+
Check whether the character is part of PrivateUseArea UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMathematicalOperators
int	xmlUCSIsMathematicalOperators	(int code)

+
Check whether the character is part of MathematicalOperators UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMiscellaneousSymbolsandArrows
int	xmlUCSIsMiscellaneousSymbolsandArrows	(int code)

+
Check whether the character is part of MiscellaneousSymbolsandArrows UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSupplementalArrowsB
int	xmlUCSIsSupplementalArrowsB	(int code)

+
Check whether the character is part of SupplementalArrows-B UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCurrencySymbols
int	xmlUCSIsCurrencySymbols	(int code)

+
Check whether the character is part of CurrencySymbols UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsNumberForms
int	xmlUCSIsNumberForms	(int code)

+
Check whether the character is part of NumberForms UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsTibetan
int	xmlUCSIsTibetan	(int code)

+
Check whether the character is part of Tibetan UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSupplementalMathematicalOperators
int	xmlUCSIsSupplementalMathematicalOperators	(int code)

+
Check whether the character is part of SupplementalMathematicalOperators UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKUnifiedIdeographsExtensionA
int	xmlUCSIsCJKUnifiedIdeographsExtensionA	(int code)

+
Check whether the character is part of CJKUnifiedIdeographsExtensionA UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsKanbun
int	xmlUCSIsKanbun	(int code)

+
Check whether the character is part of Kanbun UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCJKUnifiedIdeographsExtensionB
int	xmlUCSIsCJKUnifiedIdeographsExtensionB	(int code)

+
Check whether the character is part of CJKUnifiedIdeographsExtensionB UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsThai
int	xmlUCSIsThai	(int code)

+
Check whether the character is part of Thai UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSpacingModifierLetters
int	xmlUCSIsSpacingModifierLetters	(int code)

+
Check whether the character is part of SpacingModifierLetters UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsRunic
int	xmlUCSIsRunic	(int code)

+
Check whether the character is part of Runic UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatSc
int	xmlUCSIsCatSc	(int code)

+
Check whether the character is part of Sc UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatPc
int	xmlUCSIsCatPc	(int code)

+
Check whether the character is part of Pc UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatMc
int	xmlUCSIsCatMc	(int code)

+
Check whether the character is part of Mc UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatPf
int	xmlUCSIsCatPf	(int code)

+
Check whether the character is part of Pf UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCyrillicSupplement
int	xmlUCSIsCyrillicSupplement	(int code)

+
Check whether the character is part of CyrillicSupplement UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatPd
int	xmlUCSIsCatPd	(int code)

+
Check whether the character is part of Pd UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsMyanmar
int	xmlUCSIsMyanmar	(int code)

+
Check whether the character is part of Myanmar UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatPi
int	xmlUCSIsCatPi	(int code)

+
Check whether the character is part of Pi UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHiragana
int	xmlUCSIsHiragana	(int code)

+
Check whether the character is part of Hiragana UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatPo
int	xmlUCSIsCatPo	(int code)

+
Check whether the character is part of Po UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHighPrivateUseSurrogates
int	xmlUCSIsHighPrivateUseSurrogates	(int code)

+
Check whether the character is part of HighPrivateUseSurrogates UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLatinExtendedAdditional
int	xmlUCSIsLatinExtendedAdditional	(int code)

+
Check whether the character is part of LatinExtendedAdditional UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatPs
int	xmlUCSIsCatPs	(int code)

+
Check whether the character is part of Ps UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSyriac
int	xmlUCSIsSyriac	(int code)

+
Check whether the character is part of Syriac UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsSuperscriptsandSubscripts
int	xmlUCSIsSuperscriptsandSubscripts	(int code)

+
Check whether the character is part of SuperscriptsandSubscripts UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsHighSurrogates
int	xmlUCSIsHighSurrogates	(int code)

+
Check whether the character is part of HighSurrogates UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatMn
int	xmlUCSIsCatMn	(int code)

+
Check whether the character is part of Mn UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsLao
int	xmlUCSIsLao	(int code)

+
Check whether the character is part of Lao UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsOriya
int	xmlUCSIsOriya	(int code)

+
Check whether the character is part of Oriya UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsBraillePatterns
int	xmlUCSIsBraillePatterns	(int code)

+
Check whether the character is part of BraillePatterns UCS Block

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatMe
int	xmlUCSIsCatMe	(int code)

+
Check whether the character is part of Me UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Function: xmlUCSIsCatS
int	xmlUCSIsCatS	(int code)

+
Check whether the character is part of S UCS Category

+
code:UCS code point
Returns:1 if true 0 otherwise
Daniel Veillard

diff --git a/doc/html/libxml-xmlversion.html b/doc/html/libxml-xmlversion.html
index ab39bd57..f9f3f737 100644
--- a/doc/html/libxml-xmlversion.html
+++ b/doc/html/libxml-xmlversion.html
@@ -1,191 +1,113 @@
-xmlversion
PrevUpHomeGnome XML Library Reference ManualNext
xmlversion
xmlversion — 
Synopsis
+
+
+Module xmlversion from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlversion from libxml2
Main Menu
Related links
Table of Contents
#define LIBXML_VERSION_STRING
 
+
#define LIBXML_DOCB_ENABLED
 
+
#define LIBXML_CATALOG_ENABLED
 
-void        xmlCheckVersion                 (int version);
-#define     LIBXML_DOTTED_VERSION
-#define     LIBXML_VERSION
-#define     LIBXML_VERSION_STRING
-#define     LIBXML_TEST_VERSION
-#define     WITH_TRIO
-#define     WITHOUT_TRIO
-#define     LIBXML_THREAD_ENABLED
-#define     LIBXML_TREE_ENABLED
-#define     LIBXML_OUTPUT_ENABLED
-#define     LIBXML_PUSH_ENABLED
-#define     LIBXML_READER_ENABLED
-#define     LIBXML_WRITER_ENABLED
-#define     LIBXML_SAX1_ENABLED
-#define     LIBXML_FTP_ENABLED
-#define     LIBXML_HTTP_ENABLED
-#define     LIBXML_VALID_ENABLED
-#define     LIBXML_HTML_ENABLED
-#define     LIBXML_LEGACY_ENABLED
-#define     LIBXML_C14N_ENABLED
-#define     LIBXML_CATALOG_ENABLED
-#define     LIBXML_DOCB_ENABLED
-#define     LIBXML_XPATH_ENABLED
-#define     LIBXML_XPTR_ENABLED
-#define     LIBXML_XINCLUDE_ENABLED
-#define     LIBXML_ICONV_ENABLED
-#define     LIBXML_ISO8859X_ENABLED
-#define     LIBXML_DEBUG_ENABLED
-#define     DEBUG_MEMORY_LOCATION
-#define     LIBXML_UNICODE_ENABLED
-#define     LIBXML_REGEXP_ENABLED
-#define     LIBXML_AUTOMATA_ENABLED
-#define     LIBXML_SCHEMAS_ENABLED
-#define     ATTRIBUTE_UNUSED
-
Description

+
#define LIBXML_LEGACY_ENABLED
 
-
Details
xmlCheckVersion ()
void        xmlCheckVersion                 (int version);

-check the compiled lib version against the include one.
-This can warn or immediately kill the application

+
void	xmlCheckVersion	(int version)

+
#define LIBXML_REGEXP_ENABLED
 
-
version:
+
#define LIBXML_XPTR_ENABLED
 
+
#define LIBXML_READER_ENABLED
 
-
LIBXML_DOTTED_VERSION
#define     LIBXML_DOTTED_VERSION

-the version string like "1.2.3"

+
#define LIBXML_ICONV_ENABLED
 
-
LIBXML_VERSION
#define     LIBXML_VERSION

-the version number: 1.2.3 value is 1002003

+
#define LIBXML_HTML_ENABLED
 
-
LIBXML_VERSION_STRING
#define     LIBXML_VERSION_STRING

-the version number string, 1.2.3 value is "1002003"

+
#define LIBXML_DOTTED_VERSION
 
-
LIBXML_TEST_VERSION
#define     LIBXML_TEST_VERSION

-Macro to check that the libxml version in use is compatible with
-the version the software has been compiled against

+
#define LIBXML_UNICODE_ENABLED
 
-
WITH_TRIO
#define     WITH_TRIO

-defined if the trio support need to be configured in

+
#define LIBXML_ISO8859X_ENABLED
 
-
WITHOUT_TRIO
#define     WITHOUT_TRIO

-defined if the trio support should not be configured in

+
#define LIBXML_DEBUG_ENABLED
 
-
LIBXML_THREAD_ENABLED
#define     LIBXML_THREAD_ENABLED

-Whether the thread support is configured in

+
#define LIBXML_XINCLUDE_ENABLED
 
-
LIBXML_TREE_ENABLED
#define LIBXML_TREE_ENABLED
-

-Whether the DOM like tree manipulation API support is configured in

+
#define LIBXML_FTP_ENABLED
 
-
LIBXML_OUTPUT_ENABLED
#define LIBXML_OUTPUT_ENABLED
-

-Whether the serialization/saving support is configured in

+
#define LIBXML_AUTOMATA_ENABLED
 
-
LIBXML_PUSH_ENABLED
#define LIBXML_PUSH_ENABLED
-

-Whether the push parsing interfaces are configured in

+
#define ATTRIBUTE_UNUSED
 
-
LIBXML_READER_ENABLED
#define LIBXML_READER_ENABLED
-

-Whether the xmlReader parsing interface is configured in

+
#define LIBXML_PUSH_ENABLED
 
-
LIBXML_WRITER_ENABLED
#define LIBXML_WRITER_ENABLED
-

-Whether the xmlWriter saving interface is configured in

+
#define WITHOUT_TRIO
 
-
LIBXML_SAX1_ENABLED
#define LIBXML_SAX1_ENABLED
-

-Whether the older SAX1 interface is configured in

+
#define LIBXML_C14N_ENABLED
 
-
LIBXML_FTP_ENABLED
#define     LIBXML_FTP_ENABLED

-Whether the FTP support is configured in

+
#define LIBXML_SCHEMAS_ENABLED
 
-
LIBXML_HTTP_ENABLED
#define     LIBXML_HTTP_ENABLED

-Whether the HTTP support is configured in

+
#define DEBUG_MEMORY_LOCATION
 
-
LIBXML_VALID_ENABLED
#define LIBXML_VALID_ENABLED
-

-Whether the DTD validation support is configured in

+
#define LIBXML_SAX1_ENABLED
 
-
LIBXML_HTML_ENABLED
#define     LIBXML_HTML_ENABLED

-Whether the HTML support is configured in

+
#define LIBXML_TEST_VERSION
 
-
LIBXML_LEGACY_ENABLED
#define LIBXML_LEGACY_ENABLED
-

-Whether the deprecated APIs are compiled in for compatibility

+
#define LIBXML_HTTP_ENABLED
 
-
LIBXML_C14N_ENABLED
#define     LIBXML_C14N_ENABLED

-Whether the Canonicalization support is configured in

+
#define LIBXML_OUTPUT_ENABLED
 
-
LIBXML_CATALOG_ENABLED
#define     LIBXML_CATALOG_ENABLED

-Whether the Catalog support is configured in

+
#define WITH_TRIO
 
-
LIBXML_DOCB_ENABLED
#define     LIBXML_DOCB_ENABLED

-Whether the SGML Docbook support is configured in

+
#define LIBXML_THREAD_ENABLED
 
-
LIBXML_XPATH_ENABLED
#define     LIBXML_XPATH_ENABLED

-Whether XPath is configured in

+
#define LIBXML_XPATH_ENABLED
 
-
LIBXML_XPTR_ENABLED
#define     LIBXML_XPTR_ENABLED

-Whether XPointer is configured in

+
#define LIBXML_VERSION
 
-
LIBXML_XINCLUDE_ENABLED
#define     LIBXML_XINCLUDE_ENABLED

-Whether XInclude is configured in

+
#define LIBXML_VALID_ENABLED
 
-
LIBXML_ICONV_ENABLED
#define     LIBXML_ICONV_ENABLED

-Whether iconv support is available

+
#define LIBXML_TREE_ENABLED
 
-
LIBXML_ISO8859X_ENABLED
#define LIBXML_ISO8859X_ENABLED
-

-Whether ISO-8859-* support is made available in case iconv is not

+
#define LIBXML_WRITER_ENABLED
 
-
LIBXML_DEBUG_ENABLED
#define     LIBXML_DEBUG_ENABLED

-Whether Debugging module is configured in

-
-
DEBUG_MEMORY_LOCATION
#define     DEBUG_MEMORY_LOCATION

-Whether the memory debugging is configured in

-
-
LIBXML_UNICODE_ENABLED
#define LIBXML_UNICODE_ENABLED
-

-Whether the Unicode related interfaces are compiled in

-
-
LIBXML_REGEXP_ENABLED
#define LIBXML_REGEXP_ENABLED
-

-Whether the regular expressions interfaces are compiled in

-
-
LIBXML_AUTOMATA_ENABLED
#define LIBXML_AUTOMATA_ENABLED
-

-Whether the automata interfaces are compiled in

-
-
LIBXML_SCHEMAS_ENABLED
#define LIBXML_SCHEMAS_ENABLED
-

-Whether the Schemas validation interfaces are compiled in

-
-
ATTRIBUTE_UNUSED
#define     ATTRIBUTE_UNUSED

-Macro used to signal to GCC unused function parameters

-
-
<< xpathInternalslist >>

+
Description

+
Macro: LIBXML_VERSION_STRING
#define LIBXML_VERSION_STRING
the version number string, 1.2.3 value is "1002003"

+
Macro: LIBXML_DOCB_ENABLED
#define LIBXML_DOCB_ENABLED
Whether the SGML Docbook support is configured in

+
Macro: LIBXML_CATALOG_ENABLED
#define LIBXML_CATALOG_ENABLED
Whether the Catalog support is configured in

+
Macro: LIBXML_LEGACY_ENABLED
#define LIBXML_LEGACY_ENABLED
Whether the deprecated APIs are compiled in for compatibility

+
Function: xmlCheckVersion
void	xmlCheckVersion	(int version)

+
check the compiled lib version against the include one. This can warn or immediately kill the application

+
version:the include version number
Macro: LIBXML_REGEXP_ENABLED
#define LIBXML_REGEXP_ENABLED
Whether the regular expressions interfaces are compiled in

+
Macro: LIBXML_XPTR_ENABLED
#define LIBXML_XPTR_ENABLED
Whether XPointer is configured in

+
Macro: LIBXML_READER_ENABLED
#define LIBXML_READER_ENABLED
Whether the xmlReader parsing interface is configured in

+
Macro: LIBXML_ICONV_ENABLED
#define LIBXML_ICONV_ENABLED
Whether iconv support is available

+
Macro: LIBXML_HTML_ENABLED
#define LIBXML_HTML_ENABLED
Whether the HTML support is configured in

+
Macro: LIBXML_DOTTED_VERSION
#define LIBXML_DOTTED_VERSION
the version string like "1.2.3"

+
Macro: LIBXML_UNICODE_ENABLED
#define LIBXML_UNICODE_ENABLED
Whether the Unicode related interfaces are compiled in

+
Macro: LIBXML_ISO8859X_ENABLED
#define LIBXML_ISO8859X_ENABLED
Whether ISO-8859-* support is made available in case iconv is not

+
Macro: LIBXML_DEBUG_ENABLED
#define LIBXML_DEBUG_ENABLED
Whether Debugging module is configured in

+
Macro: LIBXML_XINCLUDE_ENABLED
#define LIBXML_XINCLUDE_ENABLED
Whether XInclude is configured in

+
Macro: LIBXML_FTP_ENABLED
#define LIBXML_FTP_ENABLED
Whether the FTP support is configured in

+
Macro: LIBXML_AUTOMATA_ENABLED
#define LIBXML_AUTOMATA_ENABLED
Whether the automata interfaces are compiled in

+
Macro: ATTRIBUTE_UNUSED
#define ATTRIBUTE_UNUSED
Macro used to signal to GCC unused function parameters

+
Macro: LIBXML_PUSH_ENABLED
#define LIBXML_PUSH_ENABLED
Whether the push parsing interfaces are configured in

+
Macro: WITHOUT_TRIO
#define WITHOUT_TRIO
defined if the trio support should not be configured in

+
Macro: LIBXML_C14N_ENABLED
#define LIBXML_C14N_ENABLED
Whether the Canonicalization support is configured in

+
Macro: LIBXML_SCHEMAS_ENABLED
#define LIBXML_SCHEMAS_ENABLED
Whether the Schemas validation interfaces are compiled in

+
Macro: DEBUG_MEMORY_LOCATION
#define DEBUG_MEMORY_LOCATION
Whether the memory debugging is configured in

+
Macro: LIBXML_SAX1_ENABLED
#define LIBXML_SAX1_ENABLED
Whether the older SAX1 interface is configured in

+
Macro: LIBXML_TEST_VERSION
#define LIBXML_TEST_VERSION
Macro to check that the libxml version in use is compatible with the version the software has been compiled against

+
Macro: LIBXML_HTTP_ENABLED
#define LIBXML_HTTP_ENABLED
Whether the HTTP support is configured in

+
Macro: LIBXML_OUTPUT_ENABLED
#define LIBXML_OUTPUT_ENABLED
Whether the serialization/saving support is configured in

+
Macro: WITH_TRIO
#define WITH_TRIO

+
Macro: LIBXML_THREAD_ENABLED
#define LIBXML_THREAD_ENABLED
Whether the thread support is configured in

+
Macro: LIBXML_XPATH_ENABLED
#define LIBXML_XPATH_ENABLED
Whether XPath is configured in

+
Macro: LIBXML_VERSION
#define LIBXML_VERSION
the version number: 1.2.3 value is 1002003

+
Macro: LIBXML_VALID_ENABLED
#define LIBXML_VALID_ENABLED
Whether the DTD validation support is configured in

+
Macro: LIBXML_TREE_ENABLED
#define LIBXML_TREE_ENABLED
Whether the DOM like tree manipulation API support is configured in

+
Macro: LIBXML_WRITER_ENABLED
#define LIBXML_WRITER_ENABLED
Whether the xmlWriter saving interface is configured in

+
Daniel Veillard

diff --git a/doc/html/libxml-xmlwin32version.html b/doc/html/libxml-xmlwin32version.html
deleted file mode 100644
index 58b59c49..00000000
--- a/doc/html/libxml-xmlwin32version.html
+++ /dev/null
@@ -1,138 +0,0 @@
-xmlwin32version
PrevUpHomeGnome XML Library Reference ManualNext
xmlwin32version
xmlwin32version — 
Synopsis
-
-
-
-void        xmlCheckVersion                 (int version);
-#define     LIBXML_DOTTED_VERSION
-#define     LIBXML_VERSION
-#define     LIBXML_VERSION_STRING
-#define     LIBXML_TEST_VERSION
-#define     WITH_TRIO
-#define     WITHOUT_TRIO
-#define     LIBXML_THREAD_ENABLED
-#define     LIBXML_FTP_ENABLED
-#define     LIBXML_HTTP_ENABLED
-#define     LIBXML_HTML_ENABLED
-#define     LIBXML_CATALOG_ENABLED
-#define     LIBXML_DOCB_ENABLED
-#define     LIBXML_XPATH_ENABLED
-#define     LIBXML_XPTR_ENABLED
-#define     LIBXML_C14N_ENABLED
-#define     LIBXML_XINCLUDE_ENABLED
-#define     LIBXML_ICONV_ENABLED
-#define     LIBXML_DEBUG_ENABLED
-#define     DEBUG_MEMORY_LOCATION
-#define     LIBXML_DLL_IMPORT
-#define     ATTRIBUTE_UNUSED
-
Description

-
-
Details
xmlCheckVersion ()
void        xmlCheckVersion                 (int version);

-check the compiled lib version against the include one.
-This can warn or immediately kill the application

-
-
version: the include version number
-
LIBXML_DOTTED_VERSION
#define     LIBXML_DOTTED_VERSION

-the version string like "1.2.3"

-
-
LIBXML_VERSION
#define     LIBXML_VERSION

-the version number: 1.2.3 value is 1002003

-
-
LIBXML_VERSION_STRING
#define     LIBXML_VERSION_STRING

-the version number string, 1.2.3 value is "1002003"

-
-
LIBXML_TEST_VERSION
#define     LIBXML_TEST_VERSION

-Macro to check that the libxml version in use is compatible with
-the version the software has been compiled against

-
-
WITH_TRIO
#define     WITH_TRIO

-defined if the trio support need to be configured in

-
-
WITHOUT_TRIO
#define     WITHOUT_TRIO

-defined if the trio support should not be configured in

-
-
LIBXML_THREAD_ENABLED
#define     LIBXML_THREAD_ENABLED

-Whether the thread support is configured in

-
-
LIBXML_FTP_ENABLED
#define     LIBXML_FTP_ENABLED

-Whether the FTP support is configured in

-
-
LIBXML_HTTP_ENABLED
#define     LIBXML_HTTP_ENABLED

-Whether the HTTP support is configured in

-
-
LIBXML_HTML_ENABLED
#define     LIBXML_HTML_ENABLED

-Whether the HTML support is configured in

-
-
LIBXML_CATALOG_ENABLED
#define     LIBXML_CATALOG_ENABLED

-Whether the Catalog support is configured in

-
-
LIBXML_DOCB_ENABLED
#define     LIBXML_DOCB_ENABLED

-Whether the SGML Docbook support is configured in

-
-
LIBXML_XPATH_ENABLED
#define     LIBXML_XPATH_ENABLED

-Whether XPath is configured in

-
-
LIBXML_XPTR_ENABLED
#define     LIBXML_XPTR_ENABLED

-Whether XPointer is configured in

-
-
LIBXML_C14N_ENABLED
#define     LIBXML_C14N_ENABLED

-Whether the Canonicalization support is configured in

-
-
LIBXML_XINCLUDE_ENABLED
#define     LIBXML_XINCLUDE_ENABLED

-Whether XInclude is configured in

-
-
LIBXML_ICONV_ENABLED
#define     LIBXML_ICONV_ENABLED

-Whether iconv support is available

-
-
LIBXML_DEBUG_ENABLED
#define     LIBXML_DEBUG_ENABLED

-Whether Debugging module is configured in

-
-
DEBUG_MEMORY_LOCATION
#define     DEBUG_MEMORY_LOCATION

-Whether the memory debugging is configured in

-
-
LIBXML_DLL_IMPORT
#define     LIBXML_DLL_IMPORT

-Used on Windows (MS C compiler only) to declare a variable as 
-imported from the library. This macro should be empty when compiling
-libxml itself. It should expand to __declspec(dllimport)
-when the client code includes this header, and that only if the client
-links dynamically against libxml.
-For this to work, we need three macros. One tells us which compiler is
-being used and luckily the compiler defines such a thing: _MSC_VER. The
-second macro tells us if we are compiling libxml or the client code and
-we define the macro IN_LIBXML on the compiler's command line for this 
-purpose. The third macro, LIBXML_STATIC, must be defined by any client 
-code which links against libxml statically.

-
-
ATTRIBUTE_UNUSED
#define     ATTRIBUTE_UNUSED

-Macro used to signal to GCC unused function parameters

-
-
<< xmlerrorDOCBparser >>

diff --git a/doc/html/libxml-xmlwriter.html b/doc/html/libxml-xmlwriter.html
index 1ae2bf7d..d333e472 100644
--- a/doc/html/libxml-xmlwriter.html
+++ b/doc/html/libxml-xmlwriter.html
@@ -1,988 +1,234 @@
-xmlwriter
PrevUpHomeGnome XML Library Reference ManualNext
xmlwriter
xmlwriter — 
Synopsis
-
-
-
-struct      xmlTextWriter;
-typedef     xmlTextWriterPtr;
-xmlTextWriterPtr xmlNewTextWriter           (xmlOutputBufferPtr out);
-xmlTextWriterPtr xmlNewTextWriterFilename   (const char *uri,
-                                             int compression);
-xmlTextWriterPtr xmlNewTextWriterMemory     (xmlBufferPtr buf,
-                                             int compression);
-void        xmlFreeTextWriter               (xmlTextWriterPtr writer);
-int         xmlTextWriterStartDocument      (xmlTextWriterPtr writer,
-                                             const char *version,
-                                             const char *encoding,
-                                             const char *standalone);
-int         xmlTextWriterEndDocument        (xmlTextWriterPtr writer);
-int         xmlTextWriterWriteFormatComment (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatComment
-                                            (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteComment       (xmlTextWriterPtr writer,
-                                             const xmlChar *content);
-int         xmlTextWriterStartElement       (xmlTextWriterPtr writer,
-                                             const xmlChar *name);
-int         xmlTextWriterStartElementNS     (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI);
-int         xmlTextWriterEndElement         (xmlTextWriterPtr writer);
-int         xmlTextWriterFullEndElement     (xmlTextWriterPtr writer);
-int         xmlTextWriterWriteFormatElement (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatElement
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteElement       (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-int         xmlTextWriterWriteFormatElementNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatElementNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteElementNS     (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const xmlChar *content);
-int         xmlTextWriterWriteFormatRaw     (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatRaw    (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteRawLen        (xmlTextWriterPtr writer,
-                                             const xmlChar *content,
-                                             int len);
-int         xmlTextWriterWriteRaw           (xmlTextWriterPtr writer,
-                                             const xmlChar *content);
-int         xmlTextWriterWriteFormatString  (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatString (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteString        (xmlTextWriterPtr writer,
-                                             const xmlChar *content);
-int         xmlTextWriterWriteBase64        (xmlTextWriterPtr writer,
-                                             const char *data,
-                                             int start,
-                                             int len);
-int         xmlTextWriterWriteBinHex        (xmlTextWriterPtr writer,
-                                             const char *data,
-                                             int start,
-                                             int len);
-int         xmlTextWriterStartAttribute     (xmlTextWriterPtr writer,
-                                             const xmlChar *name);
-int         xmlTextWriterStartAttributeNS   (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI);
-int         xmlTextWriterEndAttribute       (xmlTextWriterPtr writer);
-int         xmlTextWriterWriteFormatAttribute
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatAttribute
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteAttribute     (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-int         xmlTextWriterWriteFormatAttributeNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatAttributeNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteAttributeNS   (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const xmlChar *content);
-int         xmlTextWriterStartPI            (xmlTextWriterPtr writer,
-                                             const xmlChar *target);
-int         xmlTextWriterEndPI              (xmlTextWriterPtr writer);
-int         xmlTextWriterWriteFormatPI      (xmlTextWriterPtr writer,
-                                             const xmlChar *target,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatPI     (xmlTextWriterPtr writer,
-                                             const xmlChar *target,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWritePI            (xmlTextWriterPtr writer,
-                                             const xmlChar *target,
-                                             const xmlChar *content);
-#define     xmlTextWriterWriteProcessingInstruction
-int         xmlTextWriterStartCDATA         (xmlTextWriterPtr writer);
-int         xmlTextWriterEndCDATA           (xmlTextWriterPtr writer);
-int         xmlTextWriterWriteFormatCDATA   (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatCDATA  (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteCDATA         (xmlTextWriterPtr writer,
-                                             const xmlChar *content);
-int         xmlTextWriterStartDTD           (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid);
-int         xmlTextWriterEndDTD             (xmlTextWriterPtr writer);
-int         xmlTextWriterWriteFormatDTD     (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatDTD    (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteDTD           (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const xmlChar *subset);
-#define     xmlTextWriterWriteDocType
-int         xmlTextWriterStartDTDElement    (xmlTextWriterPtr writer,
-                                             const xmlChar *name);
-#define     xmlTextWriterEndDTDElement
-int         xmlTextWriterWriteFormatDTDElement
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatDTDElement
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteDTDElement    (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-int         xmlTextWriterStartDTDAttlist    (xmlTextWriterPtr writer,
-                                             const xmlChar *name);
-#define     xmlTextWriterEndDTDAttlist
-int         xmlTextWriterWriteFormatDTDAttlist
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatDTDAttlist
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteDTDAttlist    (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-int         xmlTextWriterStartDTDEntity     (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name);
-#define     xmlTextWriterEndDTDEntity
-int         xmlTextWriterWriteFormatDTDInternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);
-int         xmlTextWriterWriteVFormatDTDInternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);
-int         xmlTextWriterWriteDTDInternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const xmlChar *content);
-int         xmlTextWriterWriteDTDExternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const xmlChar *ndataid);
-int         xmlTextWriterWriteDTDEntity     (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const xmlChar *ndataid,
-                                             const xmlChar *content);
-int         xmlTextWriterWriteDTDNotation   (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid);
-int         xmlTextWriterFlush              (xmlTextWriterPtr writer);
-
Description

-
-
Details
struct xmlTextWriter
struct xmlTextWriter;

-
-
xmlTextWriterPtr
typedef xmlTextWriter *xmlTextWriterPtr;
-

-
-
xmlNewTextWriter ()
xmlTextWriterPtr xmlNewTextWriter           (xmlOutputBufferPtr out);

-Create a new xmlNewTextWriter structure using an xmlOutputBufferPtr

-
-
out:  an xmlOutputBufferPtr
-
Returns :the new xmlTextWriterPtr or NULL in case of error
-
xmlNewTextWriterFilename ()
xmlTextWriterPtr xmlNewTextWriterFilename   (const char *uri,
-                                             int compression);

-Create a new xmlNewTextWriter structure with uri as output

-
-
uri:  the URI of the resource for the output
-
compression:  compress the output?
-
Returns :the new xmlTextWriterPtr or NULL in case of error
-
xmlNewTextWriterMemory ()
xmlTextWriterPtr xmlNewTextWriterMemory     (xmlBufferPtr buf,
-                                             int compression);

-Create a new xmlNewTextWriter structure with buf as output
-TODO: handle compression

-
-
buf:  xmlBufferPtr
-
compression:  compress the output?
-
Returns :the new xmlTextWriterPtr or NULL in case of error
-
xmlFreeTextWriter ()
void        xmlFreeTextWriter               (xmlTextWriterPtr writer);

-Deallocate all the resources associated to the writer

-
-
writer:  the xmlTextWriterPtr
-
xmlTextWriterStartDocument ()
int         xmlTextWriterStartDocument      (xmlTextWriterPtr writer,
-                                             const char *version,
-                                             const char *encoding,
-                                             const char *standalone);

-Start a new xml document

-
-
writer:  the xmlTextWriterPtr
-
version:  the xml version ("1.0") or NULL for default ("1.0")
-
encoding:  the encoding or NULL for default
-
standalone: "yes" or "no" or NULL for default
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterEndDocument ()
int         xmlTextWriterEndDocument        (xmlTextWriterPtr writer);

-End an xml document. All open elements are closed

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatComment ()
int         xmlTextWriterWriteFormatComment (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);

-Write an xml comment.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatComment ()
int         xmlTextWriterWriteVFormatComment
-                                            (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);

-Write an xml comment.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
argptr:  pointer to the first member of the variable argument list.
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteComment ()
int         xmlTextWriterWriteComment       (xmlTextWriterPtr writer,
-                                             const xmlChar *content);

-Write an xml comment.

-
-
writer:  the xmlTextWriterPtr
-
content:  comment string
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterStartElement ()
int         xmlTextWriterStartElement       (xmlTextWriterPtr writer,
-                                             const xmlChar *name);

-Start an xml element.

-
-
writer:  the xmlTextWriterPtr
-
name:  element name
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterStartElementNS ()
int         xmlTextWriterStartElementNS     (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI);

-Start an xml element with namespace support.

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix or NULL
-
name:  element local name
-
namespaceURI:  namespace URI or NULL
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterEndElement ()
int         xmlTextWriterEndElement         (xmlTextWriterPtr writer);

-End the current xml element.

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterFullEndElement ()
int         xmlTextWriterFullEndElement     (xmlTextWriterPtr writer);

-End the current xml element. Writes an end tag even if the element is empty

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatElement ()
int         xmlTextWriterWriteFormatElement (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);

-Write a formatted xml element.

-
-
writer:  the xmlTextWriterPtr
-
name:  element name
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatElement ()
int         xmlTextWriterWriteVFormatElement
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted xml element.

-
-
writer:  the xmlTextWriterPtr
-
name:  element name
-
format:  format string (see printf)
-
argptr:  pointer to the first member of the variable argument list.
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteElement ()
int         xmlTextWriterWriteElement       (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-Write an xml element.

-
-
writer:  the xmlTextWriterPtr
-
name:  element name
-
content:  element content
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatElementNS ()
int         xmlTextWriterWriteFormatElementNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             ...);

-Write a formatted xml element with namespace support.

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix
-
name:  element local name
-
namespaceURI:  namespace URI
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatElementNS ()
int         xmlTextWriterWriteVFormatElementNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted xml element with namespace support.

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix
-
name:  element local name
-
namespaceURI:  namespace URI
-
format:  format string (see printf)
-
argptr:  pointer to the first member of the variable argument list.
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteElementNS ()
int         xmlTextWriterWriteElementNS     (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const xmlChar *content);

-Write an xml element with namespace support.

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix
-
name:  element local name
-
namespaceURI:  namespace URI
-
content:  element content
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatRaw ()
int         xmlTextWriterWriteFormatRaw     (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);

-Write a formatted raw xml text.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatRaw ()
int         xmlTextWriterWriteVFormatRaw    (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted raw xml text.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
argptr:  pointer to the first member of the variable argument list.
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteRawLen ()
int         xmlTextWriterWriteRawLen        (xmlTextWriterPtr writer,
-                                             const xmlChar *content,
-                                             int len);

-
-
writer:
-
content:
-
len:
-
Returns :
-
-
-
xmlTextWriterWriteRaw ()
int         xmlTextWriterWriteRaw           (xmlTextWriterPtr writer,
-                                             const xmlChar *content);

-Write a raw xml text.

-
-
writer:  the xmlTextWriterPtr
-
content:  text string
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatString ()
int         xmlTextWriterWriteFormatString  (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);

-Write a formatted xml text.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatString ()
int         xmlTextWriterWriteVFormatString (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted xml text.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
argptr:  pointer to the first member of the variable argument list.
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteString ()
int         xmlTextWriterWriteString        (xmlTextWriterPtr writer,
-                                             const xmlChar *content);

-Write an xml text.

-
-
writer:  the xmlTextWriterPtr
-
content:  text string
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteBase64 ()
int         xmlTextWriterWriteBase64        (xmlTextWriterPtr writer,
-                                             const char *data,
-                                             int start,
-                                             int len);

-Write an base64 encoded xml text.

-
-
writer: the xmlTextWriterPtr
-
data:   binary data
-
start:  the position within the data of the first byte to encode
-
len:  the number of bytes to encode
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteBinHex ()
int         xmlTextWriterWriteBinHex        (xmlTextWriterPtr writer,
-                                             const char *data,
-                                             int start,
-                                             int len);

-Write a BinHex encoded xml text.

-
-
writer: the xmlTextWriterPtr
-
data:   binary data
-
start:  the position within the data of the first byte to encode
-
len:  the number of bytes to encode
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterStartAttribute ()
int         xmlTextWriterStartAttribute     (xmlTextWriterPtr writer,
-                                             const xmlChar *name);

-Start an xml attribute.

-
-
writer:  the xmlTextWriterPtr
-
name:  element name
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterStartAttributeNS ()
int         xmlTextWriterStartAttributeNS   (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI);

-Start an xml attribute with namespace support.

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix or NULL
-
name:  element local name
-
namespaceURI:  namespace URI or NULL
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterEndAttribute ()
int         xmlTextWriterEndAttribute       (xmlTextWriterPtr writer);

-End the current xml element.

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatAttribute ()
int         xmlTextWriterWriteFormatAttribute
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);

-Write a formatted xml attribute.

-
-
writer:  the xmlTextWriterPtr
-
name:  attribute name
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatAttribute ()
int         xmlTextWriterWriteVFormatAttribute
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted xml attribute.

-
-
writer:  the xmlTextWriterPtr
-
name:  attribute name
-
format:  format string (see printf)
-
argptr:  pointer to the first member of the variable argument list.
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteAttribute ()
int         xmlTextWriterWriteAttribute     (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-Write an xml attribute.

-
-
writer:  the xmlTextWriterPtr
-
name:  attribute name
-
content:  attribute content
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatAttributeNS ()
int         xmlTextWriterWriteFormatAttributeNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             ...);

-Write a formatted xml attribute.with namespace support

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix
-
name:  attribute local name
-
namespaceURI:  namespace URI
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatAttributeNS ()
int         xmlTextWriterWriteVFormatAttributeNS
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted xml attribute.with namespace support

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix
-
name:  attribute local name
-
namespaceURI:  namespace URI
-
format:  format string (see printf)
-
argptr:  pointer to the first member of the variable argument list.
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteAttributeNS ()
int         xmlTextWriterWriteAttributeNS   (xmlTextWriterPtr writer,
-                                             const xmlChar *prefix,
-                                             const xmlChar *name,
-                                             const xmlChar *namespaceURI,
-                                             const xmlChar *content);

-Write an xml attribute.

-
-
writer:  the xmlTextWriterPtr
-
prefix:  namespace prefix
-
name:  attribute local name
-
namespaceURI:  namespace URI
-
content:  attribute content
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterStartPI ()
int         xmlTextWriterStartPI            (xmlTextWriterPtr writer,
-                                             const xmlChar *target);

-Start an xml PI.

-
-
writer:  the xmlTextWriterPtr
-
target:  PI target
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterEndPI ()
int         xmlTextWriterEndPI              (xmlTextWriterPtr writer);

-End the current xml PI.

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatPI ()
int         xmlTextWriterWriteFormatPI      (xmlTextWriterPtr writer,
-                                             const xmlChar *target,
-                                             const char *format,
-                                             ...);

-Write a formatted PI.

-
-
writer:  the xmlTextWriterPtr
-
target:  PI target
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatPI ()
int         xmlTextWriterWriteVFormatPI     (xmlTextWriterPtr writer,
-                                             const xmlChar *target,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted xml PI.

-
-
writer:  the xmlTextWriterPtr
-
target:  PI target
-
format:  format string (see printf)
-
argptr:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWritePI ()
int         xmlTextWriterWritePI            (xmlTextWriterPtr writer,
-                                             const xmlChar *target,
-                                             const xmlChar *content);

-Write an xml PI.

-
-
writer:  the xmlTextWriterPtr
-
target:  PI target
-
content:  PI content
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteProcessingInstruction
#define xmlTextWriterWriteProcessingInstruction xmlTextWriterWritePI
-

-
-
xmlTextWriterStartCDATA ()
int         xmlTextWriterStartCDATA         (xmlTextWriterPtr writer);

-Start an xml CDATA section.

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterEndCDATA ()
int         xmlTextWriterEndCDATA           (xmlTextWriterPtr writer);

-End an xml CDATA section.

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatCDATA ()
int         xmlTextWriterWriteFormatCDATA   (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             ...);

-Write a formatted xml CDATA.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatCDATA ()
int         xmlTextWriterWriteVFormatCDATA  (xmlTextWriterPtr writer,
-                                             const char *format,
-                                             va_list argptr);

-Write a formatted xml CDATA.

-
-
writer:  the xmlTextWriterPtr
-
format:  format string (see printf)
-
argptr:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteCDATA ()
int         xmlTextWriterWriteCDATA         (xmlTextWriterPtr writer,
-                                             const xmlChar *content);

-Write an xml CDATA.

-
-
writer:  the xmlTextWriterPtr
-
content:  CDATA content
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterStartDTD ()
int         xmlTextWriterStartDTD           (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid);

-Start an xml DTD.

-
-
writer:  the xmlTextWriterPtr
-
name:  the name of the DTD
-
pubid:  the public identifier, which is an alternative to the system identifier
-
sysid:  the system identifier, which is the URI of the DTD
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterEndDTD ()
int         xmlTextWriterEndDTD             (xmlTextWriterPtr writer);

-End an xml DTD.

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteFormatDTD ()
int         xmlTextWriterWriteFormatDTD     (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const char *format,
-                                             ...);

-Write a DTD with a formatted markup declarations part.

-
-
writer:  the xmlTextWriterPtr
-
name:  the name of the DTD
-
pubid:  the public identifier, which is an alternative to the system identifier
-
sysid:  the system identifier, which is the URI of the DTD
-
format:  format string (see printf)
-
...:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteVFormatDTD ()
int         xmlTextWriterWriteVFormatDTD    (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const char *format,
-                                             va_list argptr);

-Write a DTD with a formatted markup declarations part.

-
-
writer:  the xmlTextWriterPtr
-
name:  the name of the DTD
-
pubid:  the public identifier, which is an alternative to the system identifier
-
sysid:  the system identifier, which is the URI of the DTD
-
format:  format string (see printf)
-
argptr:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteDTD ()
int         xmlTextWriterWriteDTD           (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const xmlChar *subset);

-Write a DTD.

-
-
writer:  the xmlTextWriterPtr
-
name:  the name of the DTD
-
pubid:  the public identifier, which is an alternative to the system identifier
-
sysid:  the system identifier, which is the URI of the DTD
-
subset:
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
xmlTextWriterWriteDocType
#define xmlTextWriterWriteDocType xmlTextWriterWriteDTD
-

-
-
xmlTextWriterStartDTDElement ()
int         xmlTextWriterStartDTDElement    (xmlTextWriterPtr writer,
-                                             const xmlChar *name);

-
-
writer:
-
name:
-
Returns :
-
-
-
xmlTextWriterEndDTDElement
#define xmlTextWriterEndDTDElement xmlTextWriterEndDTD
-

-
-
xmlTextWriterWriteFormatDTDElement ()
int         xmlTextWriterWriteFormatDTDElement
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);

-
-
writer:
-
name:
-
format:
-
...:
-
Returns :
-
-
-
xmlTextWriterWriteVFormatDTDElement ()
int         xmlTextWriterWriteVFormatDTDElement
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);

-
-
writer:
-
name:
-
format:
-
argptr:
-
Returns :
-
-
-
xmlTextWriterWriteDTDElement ()
int         xmlTextWriterWriteDTDElement    (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-
-
writer:
-
name:
-
content:
-
Returns :
-
-
-
xmlTextWriterStartDTDAttlist ()
int         xmlTextWriterStartDTDAttlist    (xmlTextWriterPtr writer,
-                                             const xmlChar *name);

-
-
writer:
-
name:
-
Returns :
-
-
-
xmlTextWriterEndDTDAttlist
#define xmlTextWriterEndDTDAttlist xmlTextWriterEndDTD
-

-
-
xmlTextWriterWriteFormatDTDAttlist ()
int         xmlTextWriterWriteFormatDTDAttlist
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);

-
-
writer:
-
name:
-
format:
-
...:
-
Returns :
-
-
-
xmlTextWriterWriteVFormatDTDAttlist ()
int         xmlTextWriterWriteVFormatDTDAttlist
-                                            (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);

-
-
writer:
-
name:
-
format:
-
argptr:
-
Returns :
-
-
-
xmlTextWriterWriteDTDAttlist ()
int         xmlTextWriterWriteDTDAttlist    (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-
-
writer:
-
name:
-
content:
-
Returns :
-
-
-
xmlTextWriterStartDTDEntity ()
int         xmlTextWriterStartDTDEntity     (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name);

-
-
writer:
-
pe:
-
name:
-
Returns :
-
-
-
xmlTextWriterEndDTDEntity
#define xmlTextWriterEndDTDEntity xmlTextWriterEndDTD
-

-
-
xmlTextWriterWriteFormatDTDInternalEntity ()
int         xmlTextWriterWriteFormatDTDInternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             ...);

-
-
writer:
-
pe:
-
name:
-
format:
-
...:
-
Returns :
-
-
-
xmlTextWriterWriteVFormatDTDInternalEntity ()
int         xmlTextWriterWriteVFormatDTDInternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const char *format,
-                                             va_list argptr);

-
-
writer:
-
pe:
-
name:
-
format:
-
argptr:
-
Returns :
-
-
-
xmlTextWriterWriteDTDInternalEntity ()
int         xmlTextWriterWriteDTDInternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const xmlChar *content);

-
-
writer:
-
pe:
-
name:
-
content:
-
Returns :
-
-
-
xmlTextWriterWriteDTDExternalEntity ()
int         xmlTextWriterWriteDTDExternalEntity
-                                            (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const xmlChar *ndataid);

-
-
writer:
-
pe:
-
name:
-
pubid:
-
sysid:
-
ndataid:
-
Returns :
-
-
-
xmlTextWriterWriteDTDEntity ()
int         xmlTextWriterWriteDTDEntity     (xmlTextWriterPtr writer,
-                                             int pe,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid,
-                                             const xmlChar *ndataid,
-                                             const xmlChar *content);

-
-
writer:
-
pe:
-
name:
-
pubid:
-
sysid:
-
ndataid:
-
content:
-
Returns :
-
-
-
xmlTextWriterWriteDTDNotation ()
int         xmlTextWriterWriteDTDNotation   (xmlTextWriterPtr writer,
-                                             const xmlChar *name,
-                                             const xmlChar *pubid,
-                                             const xmlChar *sysid);

-
-
writer:
-
name:
-
pubid:
-
sysid:
-
Returns :
-
-
-
xmlTextWriterFlush ()
int         xmlTextWriterFlush              (xmlTextWriterPtr writer);

-Flush the output buffer.

-
-
writer:  the xmlTextWriterPtr
-
Returns :the bytes written (may be 0 because of buffering) or -1 in case of error
-
<< debugXMLxmlschemas >>

+
+
+Module xmlwriter from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlwriter from libxml2
Main Menu
Related links
Table of Contents
int	xmlTextWriterStartDocument	(xmlTextWriterPtr writer, 
				 const char * version, 
				 const char * encoding, 
				 const char * standalone)

+
int	xmlTextWriterEndPI	(xmlTextWriterPtr writer)

+
int	xmlTextWriterWriteBase64	(xmlTextWriterPtr writer, 
				 const char * data, 
				 int start, 
				 int len)

+
#define xmlTextWriterWriteProcessingInstruction
+
+
int	xmlTextWriterStartAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+
int	xmlTextWriterWriteComment	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteRawLen	(xmlTextWriterPtr writer, 
				 const xmlChar * content, 
				 int len)

+
int	xmlTextWriterWriteVFormatDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteVFormatCDATA	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterStartAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI)

+
int	xmlTextWriterWriteFormatAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterWriteDTDEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const xmlChar * ndataid, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteVFormatPI	(xmlTextWriterPtr writer, 
				 const xmlChar * target, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteBinHex	(xmlTextWriterPtr writer, 
				 const char * data, 
				 int start, 
				 int len)

+
int	xmlTextWriterEndAttribute	(xmlTextWriterPtr writer)

+
int	xmlTextWriterWriteVFormatDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteFormatPI	(xmlTextWriterPtr writer, 
				 const xmlChar * target, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterEndDocument	(xmlTextWriterPtr writer)

+
int	xmlTextWriterWriteDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteFormatString	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterEndCDATA	(xmlTextWriterPtr writer)

+
int	xmlTextWriterStartElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI)

+
Structure xmlTextWriter
struct _xmlTextWriter {
+The content of this structure is not made public by the API.
+}

xmlTextWriterPtr	xmlNewTextWriter	(xmlOutputBufferPtr out)

+
void	xmlFreeTextWriter	(xmlTextWriterPtr writer)

+
#define xmlTextWriterWriteDocType
+
+
int	xmlTextWriterStartPI	(xmlTextWriterPtr writer, 
				 const xmlChar * target)

+
int	xmlTextWriterStartElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+
int	xmlTextWriterWriteDTDExternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const xmlChar * ndataid)

+
int	xmlTextWriterWriteFormatRaw	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterWriteCDATA	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteVFormatDTDInternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteVFormatAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+
#define xmlTextWriterEndDTDElement
+
+
int	xmlTextWriterEndDTD	(xmlTextWriterPtr writer)

+
int	xmlTextWriterWriteElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
int	xmlTextWriterEndElement	(xmlTextWriterPtr writer)

+
int	xmlTextWriterWriteVFormatComment	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterStartCDATA	(xmlTextWriterPtr writer)

+
xmlTextWriterPtr	xmlNewTextWriterFilename	(const char * uri, 
				 int compression)

+
int	xmlTextWriterWriteVFormatElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteFormatComment	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterWriteAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const xmlChar * content)

+
int	xmlTextWriterWritePI	(xmlTextWriterPtr writer, 
				 const xmlChar * target, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteVFormatRaw	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteFormatDTDInternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterWriteVFormatString	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteDTDInternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteVFormatElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterWriteDTDNotation	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid)

+
int	xmlTextWriterWriteFormatElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterWriteElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteString	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteRaw	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
int	xmlTextWriterFullEndElement	(xmlTextWriterPtr writer)

+
int	xmlTextWriterWriteVFormatAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 va_list argptr)

+
int	xmlTextWriterFlush	(xmlTextWriterPtr writer)

+
int	xmlTextWriterStartDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid)

+
int	xmlTextWriterWriteAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteFormatDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+
#define xmlTextWriterEndDTDAttlist
+
+
xmlTextWriterPtr	xmlNewTextWriterMemory	(xmlBufferPtr buf, 
				 int compression)

+
int	xmlTextWriterWriteFormatCDATA	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterStartDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+
int	xmlTextWriterStartDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+
int	xmlTextWriterWriteFormatDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterWriteFormatDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+
Typedef xmlTextWriter * xmlTextWriterPtr
+
+
int	xmlTextWriterWriteDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
int	xmlTextWriterWriteDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const xmlChar * subset)

+
int	xmlTextWriterWriteFormatAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+
int	xmlTextWriterStartDTDEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name)

+
int	xmlTextWriterWriteVFormatDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+
#define xmlTextWriterEndDTDEntity
+
+
int	xmlTextWriterWriteFormatElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 ... ...)

+
Description

+
Function: xmlTextWriterStartDocument
int	xmlTextWriterStartDocument	(xmlTextWriterPtr writer, 
				 const char * version, 
				 const char * encoding, 
				 const char * standalone)

+
Start a new xml document

+
writer:the xmlTextWriterPtr
version:the xml version ("1.0") or NULL for default ("1.0")
encoding:the encoding or NULL for default
standalone:"yes" or "no" or NULL for default
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterEndPI
int	xmlTextWriterEndPI	(xmlTextWriterPtr writer)

+
End the current xml PI.

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteBase64
int	xmlTextWriterWriteBase64	(xmlTextWriterPtr writer, 
				 const char * data, 
				 int start, 
				 int len)

+
Write an base64 encoded xml text.

+
writer:the xmlTextWriterPtr
data:binary data
start:the position within the data of the first byte to encode
len:the number of bytes to encode
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Macro: xmlTextWriterWriteProcessingInstruction
#define xmlTextWriterWriteProcessingInstruction

+
Function: xmlTextWriterStartAttribute
int	xmlTextWriterStartAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+
Start an xml attribute.

+
writer:the xmlTextWriterPtr
name:element name
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteComment
int	xmlTextWriterWriteComment	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
Write an xml comment.

+
writer:the xmlTextWriterPtr
content:comment string
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteRawLen
int	xmlTextWriterWriteRawLen	(xmlTextWriterPtr writer, 
				 const xmlChar * content, 
				 int len)

+

+
writer:
content:
len:
Returns:
Function: xmlTextWriterWriteVFormatDTD
int	xmlTextWriterWriteVFormatDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const char * format, 
				 va_list argptr)

+
Write a DTD with a formatted markup declarations part.

+
writer:the xmlTextWriterPtr
name:the name of the DTD
pubid:the public identifier, which is an alternative to the system identifier
sysid:the system identifier, which is the URI of the DTD
format:format string (see printf)
argptr:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteVFormatCDATA
int	xmlTextWriterWriteVFormatCDATA	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted xml CDATA.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
argptr:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterStartAttributeNS
int	xmlTextWriterStartAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI)

+
Start an xml attribute with namespace support.

+
writer:the xmlTextWriterPtr
prefix:namespace prefix or NULL
name:element local name
namespaceURI:namespace URI or NULL
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteFormatAttributeNS
int	xmlTextWriterWriteFormatAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 ... ...)

+
Write a formatted xml attribute.with namespace support

+
writer:the xmlTextWriterPtr
prefix:namespace prefix
name:attribute local name
namespaceURI:namespace URI
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteDTDEntity
int	xmlTextWriterWriteDTDEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const xmlChar * ndataid, 
				 const xmlChar * content)

+

+
writer:
pe:
name:
pubid:
sysid:
ndataid:
content:
Returns:
Function: xmlTextWriterWriteVFormatPI
int	xmlTextWriterWriteVFormatPI	(xmlTextWriterPtr writer, 
				 const xmlChar * target, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted xml PI.

+
writer:the xmlTextWriterPtr
target:PI target
format:format string (see printf)
argptr:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteBinHex
int	xmlTextWriterWriteBinHex	(xmlTextWriterPtr writer, 
				 const char * data, 
				 int start, 
				 int len)

+
Write a BinHex encoded xml text.

+
writer:the xmlTextWriterPtr
data:binary data
start:the position within the data of the first byte to encode
len:the number of bytes to encode
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterEndAttribute
int	xmlTextWriterEndAttribute	(xmlTextWriterPtr writer)

+
End the current xml element.

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteVFormatDTDAttlist
int	xmlTextWriterWriteVFormatDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+

+
writer:
name:
format:
argptr:
Returns:
Function: xmlTextWriterWriteFormatPI
int	xmlTextWriterWriteFormatPI	(xmlTextWriterPtr writer, 
				 const xmlChar * target, 
				 const char * format, 
				 ... ...)

+
Write a formatted PI.

+
writer:the xmlTextWriterPtr
target:PI target
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterEndDocument
int	xmlTextWriterEndDocument	(xmlTextWriterPtr writer)

+
End an xml document. All open elements are closed

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteDTDAttlist
int	xmlTextWriterWriteDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+

+
writer:
name:
content:
Returns:
Function: xmlTextWriterWriteFormatString
int	xmlTextWriterWriteFormatString	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
Write a formatted xml text.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterEndCDATA
int	xmlTextWriterEndCDATA	(xmlTextWriterPtr writer)

+
End an xml CDATA section.

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterStartElementNS
int	xmlTextWriterStartElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI)

+
Start an xml element with namespace support.

+
writer:the xmlTextWriterPtr
prefix:namespace prefix or NULL
name:element local name
namespaceURI:namespace URI or NULL
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlNewTextWriter
xmlTextWriterPtr	xmlNewTextWriter	(xmlOutputBufferPtr out)

+
Create a new xmlNewTextWriter structure using an xmlOutputBufferPtr

+
out:an xmlOutputBufferPtr
Returns:the new xmlTextWriterPtr or NULL in case of error
Function: xmlFreeTextWriter
void	xmlFreeTextWriter	(xmlTextWriterPtr writer)

+
Deallocate all the resources associated to the writer

+
writer:the xmlTextWriterPtr
Macro: xmlTextWriterWriteDocType
#define xmlTextWriterWriteDocType

+
Function: xmlTextWriterStartPI
int	xmlTextWriterStartPI	(xmlTextWriterPtr writer, 
				 const xmlChar * target)

+
Start an xml PI.

+
writer:the xmlTextWriterPtr
target:PI target
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterStartElement
int	xmlTextWriterStartElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+
Start an xml element.

+
writer:the xmlTextWriterPtr
name:element name
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteDTDExternalEntity
int	xmlTextWriterWriteDTDExternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const xmlChar * ndataid)

+

+
writer:
pe:
name:
pubid:
sysid:
ndataid:
Returns:
Function: xmlTextWriterWriteFormatRaw
int	xmlTextWriterWriteFormatRaw	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
Write a formatted raw xml text.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteCDATA
int	xmlTextWriterWriteCDATA	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
Write an xml CDATA.

+
writer:the xmlTextWriterPtr
content:CDATA content
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteVFormatDTDInternalEntity
int	xmlTextWriterWriteVFormatDTDInternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+

+
writer:
pe:
name:
format:
argptr:
Returns:
Function: xmlTextWriterWriteVFormatAttribute
int	xmlTextWriterWriteVFormatAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted xml attribute.

+
writer:the xmlTextWriterPtr
name:attribute name
format:format string (see printf)
argptr:pointer to the first member of the variable argument list.
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Macro: xmlTextWriterEndDTDElement
#define xmlTextWriterEndDTDElement

+
Function: xmlTextWriterEndDTD
int	xmlTextWriterEndDTD	(xmlTextWriterPtr writer)

+
End an xml DTD.

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteElement
int	xmlTextWriterWriteElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Write an xml element.

+
writer:the xmlTextWriterPtr
name:element name
content:element content
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterEndElement
int	xmlTextWriterEndElement	(xmlTextWriterPtr writer)

+
End the current xml element.

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteVFormatComment
int	xmlTextWriterWriteVFormatComment	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
Write an xml comment.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
argptr:pointer to the first member of the variable argument list.
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterStartCDATA
int	xmlTextWriterStartCDATA	(xmlTextWriterPtr writer)

+
Start an xml CDATA section.

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlNewTextWriterFilename
xmlTextWriterPtr	xmlNewTextWriterFilename	(const char * uri, 
				 int compression)

+
Create a new xmlNewTextWriter structure with @uri as output

+
uri:the URI of the resource for the output
compression:compress the output?
Returns:the new xmlTextWriterPtr or NULL in case of error
Function: xmlTextWriterWriteVFormatElement
int	xmlTextWriterWriteVFormatElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted xml element.

+
writer:the xmlTextWriterPtr
name:element name
format:format string (see printf)
argptr:pointer to the first member of the variable argument list.
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteFormatComment
int	xmlTextWriterWriteFormatComment	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
Write an xml comment.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteAttributeNS
int	xmlTextWriterWriteAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const xmlChar * content)

+
Write an xml attribute.

+
writer:the xmlTextWriterPtr
prefix:namespace prefix
name:attribute local name
namespaceURI:namespace URI
content:attribute content
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWritePI
int	xmlTextWriterWritePI	(xmlTextWriterPtr writer, 
				 const xmlChar * target, 
				 const xmlChar * content)

+
Write an xml PI.

+
writer:the xmlTextWriterPtr
target:PI target
content:PI content
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteVFormatRaw
int	xmlTextWriterWriteVFormatRaw	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted raw xml text.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
argptr:pointer to the first member of the variable argument list.
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteFormatDTDInternalEntity
int	xmlTextWriterWriteFormatDTDInternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+

+
writer:
pe:
name:
format:
...:
Returns:
Function: xmlTextWriterWriteVFormatString
int	xmlTextWriterWriteVFormatString	(xmlTextWriterPtr writer, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted xml text.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
argptr:pointer to the first member of the variable argument list.
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteDTDInternalEntity
int	xmlTextWriterWriteDTDInternalEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name, 
				 const xmlChar * content)

+

+
writer:
pe:
name:
content:
Returns:
Function: xmlTextWriterWriteVFormatElementNS
int	xmlTextWriterWriteVFormatElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted xml element with namespace support.

+
writer:the xmlTextWriterPtr
prefix:namespace prefix
name:element local name
namespaceURI:namespace URI
format:format string (see printf)
argptr:pointer to the first member of the variable argument list.
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteDTDNotation
int	xmlTextWriterWriteDTDNotation	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid)

+

+
writer:
name:
pubid:
sysid:
Returns:
Function: xmlTextWriterWriteFormatElement
int	xmlTextWriterWriteFormatElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+
Write a formatted xml element.

+
writer:the xmlTextWriterPtr
name:element name
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteElementNS
int	xmlTextWriterWriteElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const xmlChar * content)

+
Write an xml element with namespace support.

+
writer:the xmlTextWriterPtr
prefix:namespace prefix
name:element local name
namespaceURI:namespace URI
content:element content
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteString
int	xmlTextWriterWriteString	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
Write an xml text.

+
writer:the xmlTextWriterPtr
content:text string
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteRaw
int	xmlTextWriterWriteRaw	(xmlTextWriterPtr writer, 
				 const xmlChar * content)

+
Write a raw xml text.

+
writer:the xmlTextWriterPtr
content:text string
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterFullEndElement
int	xmlTextWriterFullEndElement	(xmlTextWriterPtr writer)

+
End the current xml element. Writes an end tag even if the element is empty

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteVFormatAttributeNS
int	xmlTextWriterWriteVFormatAttributeNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 va_list argptr)

+
Write a formatted xml attribute.with namespace support

+
writer:the xmlTextWriterPtr
prefix:namespace prefix
name:attribute local name
namespaceURI:namespace URI
format:format string (see printf)
argptr:pointer to the first member of the variable argument list.
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterFlush
int	xmlTextWriterFlush	(xmlTextWriterPtr writer)

+
Flush the output buffer.

+
writer:the xmlTextWriterPtr
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterStartDTD
int	xmlTextWriterStartDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid)

+
Start an xml DTD.

+
writer:the xmlTextWriterPtr
name:the name of the DTD
pubid:the public identifier, which is an alternative to the system identifier
sysid:the system identifier, which is the URI of the DTD
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteAttribute
int	xmlTextWriterWriteAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+
Write an xml attribute.

+
writer:the xmlTextWriterPtr
name:attribute name
content:attribute content
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteFormatDTDElement
int	xmlTextWriterWriteFormatDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+

+
writer:
name:
format:
...:
Returns:
Macro: xmlTextWriterEndDTDAttlist
#define xmlTextWriterEndDTDAttlist

+
Function: xmlNewTextWriterMemory
xmlTextWriterPtr	xmlNewTextWriterMemory	(xmlBufferPtr buf, 
				 int compression)

+
Create a new xmlNewTextWriter structure with @buf as output TODO: handle compression

+
buf:xmlBufferPtr
compression:compress the output?
Returns:the new xmlTextWriterPtr or NULL in case of error
Function: xmlTextWriterWriteFormatCDATA
int	xmlTextWriterWriteFormatCDATA	(xmlTextWriterPtr writer, 
				 const char * format, 
				 ... ...)

+
Write a formatted xml CDATA.

+
writer:the xmlTextWriterPtr
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterStartDTDAttlist
int	xmlTextWriterStartDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+

+
writer:
name:
Returns:
Function: xmlTextWriterStartDTDElement
int	xmlTextWriterStartDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name)

+

+
writer:
name:
Returns:
Function: xmlTextWriterWriteFormatDTD
int	xmlTextWriterWriteFormatDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const char * format, 
				 ... ...)

+
Write a DTD with a formatted markup declarations part.

+
writer:the xmlTextWriterPtr
name:the name of the DTD
pubid:the public identifier, which is an alternative to the system identifier
sysid:the system identifier, which is the URI of the DTD
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteFormatDTDAttlist
int	xmlTextWriterWriteFormatDTDAttlist	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+

+
writer:
name:
format:
...:
Returns:
Function: xmlTextWriterWriteDTDElement
int	xmlTextWriterWriteDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * content)

+

+
writer:
name:
content:
Returns:
Function: xmlTextWriterWriteDTD
int	xmlTextWriterWriteDTD	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const xmlChar * pubid, 
				 const xmlChar * sysid, 
				 const xmlChar * subset)

+
Write a DTD.

+
writer:the xmlTextWriterPtr
name:the name of the DTD
pubid:the public identifier, which is an alternative to the system identifier
sysid:the system identifier, which is the URI of the DTD
subset:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterWriteFormatAttribute
int	xmlTextWriterWriteFormatAttribute	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 ... ...)

+
Write a formatted xml attribute.

+
writer:the xmlTextWriterPtr
name:attribute name
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Function: xmlTextWriterStartDTDEntity
int	xmlTextWriterStartDTDEntity	(xmlTextWriterPtr writer, 
				 int pe, 
				 const xmlChar * name)

+

+
writer:
pe:
name:
Returns:
Function: xmlTextWriterWriteVFormatDTDElement
int	xmlTextWriterWriteVFormatDTDElement	(xmlTextWriterPtr writer, 
				 const xmlChar * name, 
				 const char * format, 
				 va_list argptr)

+

+
writer:
name:
format:
argptr:
Returns:
Macro: xmlTextWriterEndDTDEntity
#define xmlTextWriterEndDTDEntity

+
Function: xmlTextWriterWriteFormatElementNS
int	xmlTextWriterWriteFormatElementNS	(xmlTextWriterPtr writer, 
				 const xmlChar * prefix, 
				 const xmlChar * name, 
				 const xmlChar * namespaceURI, 
				 const char * format, 
				 ... ...)

+
Write a formatted xml element with namespace support.

+
writer:the xmlTextWriterPtr
prefix:namespace prefix
name:element local name
namespaceURI:namespace URI
format:format string (see printf)
...:
Returns:the bytes written (may be 0 because of buffering) or -1 in case of error
Daniel Veillard

diff --git a/doc/html/libxml-xpath.html b/doc/html/libxml-xpath.html
index 31928cc1..6dea37f0 100644
--- a/doc/html/libxml-xpath.html
+++ b/doc/html/libxml-xpath.html
@@ -1,583 +1,371 @@
-xpath
PrevUpHomeGnome XML Library Reference ManualNext
xpath
xpath — 
Synopsis
-
-
-
-struct      xmlXPathContext;
-typedef     xmlXPathContextPtr;
-struct      xmlXPathParserContext;
-typedef     xmlXPathParserContextPtr;
-enum        xmlXPathError;
-struct      xmlNodeSet;
-typedef     xmlNodeSetPtr;
-enum        xmlXPathObjectType;
-struct      xmlXPathObject;
-typedef     xmlXPathObjectPtr;
-int         (*xmlXPathConvertFunc)          (xmlXPathObjectPtr obj,
-                                             int type);
-struct      xmlXPathType;
-typedef     xmlXPathTypePtr;
-struct      xmlXPathVariable;
-typedef     xmlXPathVariablePtr;
-void        (*xmlXPathEvalFunc)             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-struct      xmlXPathFunct;
-typedef     xmlXPathFuncPtr;
-xmlXPathObjectPtr (*xmlXPathAxisFunc)       (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr cur);
-struct      xmlXPathAxis;
-typedef     xmlXPathAxisPtr;
-struct      xmlXPathCompExpr;
-typedef     xmlXPathCompExprPtr;
-void        (*xmlXPathFunction)             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-extern      double xmlXPathNAN;
-extern      double xmlXPathPINF;
-extern      double xmlXPathNINF;
-int         xmlXPathIsNaN                   (double val);
-int         xmlXPathIsInf                   (double val);
-#define     xmlXPathNodeSetGetLength        (ns)
-#define     xmlXPathNodeSetItem             (ns, index)
-#define     xmlXPathNodeSetIsEmpty          (ns)
-void        xmlXPathFreeObject              (xmlXPathObjectPtr obj);
-xmlNodeSetPtr xmlXPathNodeSetCreate         (xmlNodePtr val);
-void        xmlXPathFreeNodeSetList         (xmlXPathObjectPtr obj);
-void        xmlXPathFreeNodeSet             (xmlNodeSetPtr obj);
-xmlXPathObjectPtr xmlXPathObjectCopy        (xmlXPathObjectPtr val);
-int         xmlXPathCmpNodes                (xmlNodePtr node1,
-                                             xmlNodePtr node2);
-int         xmlXPathCastNumberToBoolean     (double val);
-int         xmlXPathCastStringToBoolean     (const xmlChar *val);
-int         xmlXPathCastNodeSetToBoolean    (xmlNodeSetPtr ns);
-int         xmlXPathCastToBoolean           (xmlXPathObjectPtr val);
-double      xmlXPathCastBooleanToNumber     (int val);
-double      xmlXPathCastStringToNumber      (const xmlChar *val);
-double      xmlXPathCastNodeToNumber        (xmlNodePtr node);
-double      xmlXPathCastNodeSetToNumber     (xmlNodeSetPtr ns);
-double      xmlXPathCastToNumber            (xmlXPathObjectPtr val);
-xmlChar*    xmlXPathCastBooleanToString     (int val);
-xmlChar*    xmlXPathCastNumberToString      (double val);
-xmlChar*    xmlXPathCastNodeToString        (xmlNodePtr node);
-xmlChar*    xmlXPathCastNodeSetToString     (xmlNodeSetPtr ns);
-xmlChar*    xmlXPathCastToString            (xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPathConvertBoolean    (xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPathConvertNumber     (xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPathConvertString     (xmlXPathObjectPtr val);
-void        xmlXPathInit                    (void);
-xmlXPathContextPtr xmlXPathNewContext       (xmlDocPtr doc);
-void        xmlXPathFreeContext             (xmlXPathContextPtr ctxt);
-long        xmlXPathOrderDocElems           (xmlDocPtr doc);
-xmlXPathObjectPtr xmlXPathEval              (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);
-xmlXPathObjectPtr xmlXPathEvalExpression    (const xmlChar *str,
-                                             xmlXPathContextPtr ctxt);
-int         xmlXPathEvalPredicate           (xmlXPathContextPtr ctxt,
-                                             xmlXPathObjectPtr res);
-xmlXPathCompExprPtr xmlXPathCompile         (const xmlChar *str);
-xmlXPathObjectPtr xmlXPathCompiledEval      (xmlXPathCompExprPtr comp,
-                                             xmlXPathContextPtr ctx);
-void        xmlXPathFreeCompExpr            (xmlXPathCompExprPtr comp);
-
Description

-
-
Details
struct xmlXPathContext
struct xmlXPathContext {
-
-    xmlDocPtr doc;			/* The current document */
-    xmlNodePtr node;			/* The current node */
-
-    int nb_variables_unused;		/* unused (hash table) */
-    int max_variables_unused;		/* unused (hash table) */
-    xmlHashTablePtr varHash;		/* Hash table of defined variables */
-
-    int nb_types;			/* number of defined types */
-    int max_types;			/* max number of types */
-    xmlXPathTypePtr types;		/* Array of defined types */
-
-    int nb_funcs_unused;		/* unused (hash table) */
-    int max_funcs_unused;		/* unused (hash table) */
-    xmlHashTablePtr funcHash;		/* Hash table of defined funcs */
-
-    int nb_axis;			/* number of defined axis */
-    int max_axis;			/* max number of axis */
-    xmlXPathAxisPtr axis;		/* Array of defined axis */
-
-    /* the namespace nodes of the context node */
-    xmlNsPtr *namespaces;		/* Array of namespaces */
-    int nsNr;				/* number of namespace in scope */
-    void *user;				/* function to free */
-
-    /* extra variables */
-    int contextSize;			/* the context size */
-    int proximityPosition;		/* the proximity position */
-
-    /* extra stuff for XPointer */
-    int xptr;				/* it this an XPointer context */
-    xmlNodePtr here;			/* for here() */
-    xmlNodePtr origin;			/* for origin() */
-
-    /* the set of namespace declarations in scope for the expression */
-    xmlHashTablePtr nsHash;		/* The namespaces hash table */
-    void *varLookupFunc;		/* variable lookup func */
-    void *varLookupData;		/* variable lookup data */
-
-    /* Possibility to link in an extra item */
-    void *extra;                        /* needed for XSLT */
-
-    /* The function name and URI when calling a function */
-    const xmlChar *function;
-    const xmlChar *functionURI;
-
-    /* function lookup function and data */
-    void *funcLookupFunc;		/* function lookup func */
-    void *funcLookupData;		/* function lookup data */
-
-    /* temporary namespace lists kept for walking the namespace axis */
-    xmlNsPtr *tmpNsList;		/* Array of namespaces */
-    int tmpNsNr;			/* number of namespace in scope */
-
-    /* error reporting mechanism */
-    void *userData;                     /* user specific data block */
-    xmlStructuredErrorFunc error;       /* the callback in case of errors */
-    xmlError lastError;			/* the last error */
-    xmlNodePtr debugNode;		/* the source node XSLT */
-};
-

-Expression evaluation occurs with respect to a context.
-he context consists of:
-   - a node (the context node) 
-   - a node list (the context node list) 
-   - a set of variable bindings 
-   - a function library 
-   - the set of namespace declarations in scope for the expression 
-Following the switch to hash tables, this need to be trimmed up at
-the next binary incompatible release.

-
-
xmlXPathContextPtr
typedef xmlXPathContext *xmlXPathContextPtr;
-

-
-
struct xmlXPathParserContext
struct xmlXPathParserContext {
-
-    const xmlChar *cur;			/* the current char being parsed */
-    const xmlChar *base;			/* the full expression */
-
-    int error;				/* error code */
-
-    xmlXPathContextPtr  context;	/* the evaluation context */
-    xmlXPathObjectPtr     value;	/* the current value */
-    int                 valueNr;	/* number of values stacked */
-    int                valueMax;	/* max number of values stacked */
-    xmlXPathObjectPtr *valueTab;	/* stack of values */
-
-    xmlXPathCompExprPtr comp;		/* the precompiled expression */
-    int xptr;				/* it this an XPointer expression */
-    xmlNodePtr         ancestor;	/* used for walking preceding axis */
-};
-

-An XPath parser context. It contains pure parsing informations,
-an xmlXPathContext, and the stack of objects.

-
-
xmlXPathParserContextPtr
typedef xmlXPathParserContext *xmlXPathParserContextPtr;
-

-
-
enum xmlXPathError
typedef enum {
-    XPATH_EXPRESSION_OK = 0,
-    XPATH_NUMBER_ERROR,
-    XPATH_UNFINISHED_LITERAL_ERROR,
-    XPATH_START_LITERAL_ERROR,
-    XPATH_VARIABLE_REF_ERROR,
-    XPATH_UNDEF_VARIABLE_ERROR,
-    XPATH_INVALID_PREDICATE_ERROR,
-    XPATH_EXPR_ERROR,
-    XPATH_UNCLOSED_ERROR,
-    XPATH_UNKNOWN_FUNC_ERROR,
-    XPATH_INVALID_OPERAND,
-    XPATH_INVALID_TYPE,
-    XPATH_INVALID_ARITY,
-    XPATH_INVALID_CTXT_SIZE,
-    XPATH_INVALID_CTXT_POSITION,
-    XPATH_MEMORY_ERROR,
-    XPTR_SYNTAX_ERROR,
-    XPTR_RESOURCE_ERROR,
-    XPTR_SUB_RESOURCE_ERROR,
-    XPATH_UNDEF_PREFIX_ERROR,
-    XPATH_ENCODING_ERROR,
-    XPATH_INVALID_CHAR_ERROR
-} xmlXPathError;
-

-
-
struct xmlNodeSet
struct xmlNodeSet {
-
-    int nodeNr;			/* number of nodes in the set */
-    int nodeMax;		/* size of the array as allocated */
-    xmlNodePtr *nodeTab;	/* array of nodes in no particular order */
-    /* @@ with_ns to check wether namespace nodes should be looked at @@ */
-};
-

-
-
xmlNodeSetPtr
typedef xmlNodeSet *xmlNodeSetPtr;
-

-
-
enum xmlXPathObjectType
typedef enum {
-    XPATH_UNDEFINED = 0,
-    XPATH_NODESET = 1,
-    XPATH_BOOLEAN = 2,
-    XPATH_NUMBER = 3,
-    XPATH_STRING = 4,
-    XPATH_POINT = 5,
-    XPATH_RANGE = 6,
-    XPATH_LOCATIONSET = 7,
-    XPATH_USERS = 8,
-    XPATH_XSLT_TREE = 9  /* An XSLT value tree, non modifiable */
-} xmlXPathObjectType;
-

-
-
struct xmlXPathObject
struct xmlXPathObject {
-
-    xmlXPathObjectType type;
-    xmlNodeSetPtr nodesetval;
-    int boolval;
-    double floatval;
-    xmlChar *stringval;
-    void *user;
-    int index;
-    void *user2;
-    int index2;
-};
-

-
-
xmlXPathObjectPtr
typedef xmlXPathObject *xmlXPathObjectPtr;
-

-
-
xmlXPathConvertFunc ()
int         (*xmlXPathConvertFunc)          (xmlXPathObjectPtr obj,
-                                             int type);

-A conversion function is associated to a type and used to cast
-the new type to primitive values.

-
-
obj:  an XPath object
-
type:  the number of the target type
-
Returns :-1 in case of error, 0 otherwise
-
struct xmlXPathType
struct xmlXPathType {
-
-    const xmlChar         *name;		/* the type name */
-    xmlXPathConvertFunc func;		/* the conversion function */
-};
-

-
-
xmlXPathTypePtr
typedef xmlXPathType *xmlXPathTypePtr;
-

-
-
struct xmlXPathVariable
struct xmlXPathVariable {
-
-    const xmlChar       *name;		/* the variable name */
-    xmlXPathObjectPtr value;		/* the value */
-};
-

-
-
xmlXPathVariablePtr
typedef xmlXPathVariable *xmlXPathVariablePtr;
-

-
-
xmlXPathEvalFunc ()
void        (*xmlXPathEvalFunc)             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-An XPath evaluation function, the parameters are on the XPath context stack.

-
-
ctxt: an XPath parser context
-
nargs: the number of arguments passed to the function
-
struct xmlXPathFunct
struct xmlXPathFunct {
-
-    const xmlChar      *name;		/* the function name */
-    xmlXPathEvalFunc func;		/* the evaluation function */
-};
-

-
-
xmlXPathFuncPtr
typedef xmlXPathFunct *xmlXPathFuncPtr;
-

-
-
xmlXPathAxisFunc ()
xmlXPathObjectPtr (*xmlXPathAxisFunc)       (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr cur);

-An axis traversal function. To traverse an axis, the engine calls
-the first time with cur == NULL and repeat until the function returns
-NULL indicating the end of the axis traversal.

-
-
ctxt:  the XPath interpreter context
-
cur:  the previous node being explored on that axis
-
Returns :the next node in that axis or NULL if at the end of the axis.
-
struct xmlXPathAxis
struct xmlXPathAxis {
-
-    const xmlChar      *name;		/* the axis name */
-    xmlXPathAxisFunc func;		/* the search function */
-};
-

-
-
xmlXPathAxisPtr
typedef xmlXPathAxis *xmlXPathAxisPtr;
-

-
-
struct xmlXPathCompExpr
struct xmlXPathCompExpr;

-
-
xmlXPathCompExprPtr
typedef xmlXPathCompExpr *xmlXPathCompExprPtr;
-

-
-
xmlXPathFunction ()
void        (*xmlXPathFunction)             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-An XPath function.
-The arguments (if any) are popped out from the context stack
-and the result is pushed on the stack.

-
-
ctxt:  the XPath interprestation context
-
nargs:  the number of arguments
-
xmlXPathNAN
extern double xmlXPathNAN;
-

-
-
xmlXPathPINF
extern double xmlXPathPINF;
-

-
-
xmlXPathNINF
extern double xmlXPathNINF;
-

-
-
xmlXPathIsNaN ()
int         xmlXPathIsNaN                   (double val);

-Provides a portable isnan() function to detect whether a double
-is a NotaNumber. Based on trio code
-http://sourceforge.net/projects/ctrio/

-
-
val:  a double value
-
Returns :1 if the value is a NaN, 0 otherwise
-
xmlXPathIsInf ()
int         xmlXPathIsInf                   (double val);

-Provides a portable isinf() function to detect whether a double
-is a +Infinite or -Infinite. Based on trio code
-http://sourceforge.net/projects/ctrio/

-
-
val:  a double value
-
Returns :1 vi the value is +Infinite, -1 if -Infinite, 0 otherwise
-
xmlXPathNodeSetGetLength()
#define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0)
-

-Implement a functionality similar to the DOM NodeList.length.

-
-
ns:  a node-set
-
xmlXPathNodeSetItem()
#define     xmlXPathNodeSetItem(ns, index)

-Implements a functionality similar to the DOM NodeList.item().

-
-
ns:  a node-set
-
index:  index of a node in the set
-
xmlXPathNodeSetIsEmpty()
#define     xmlXPathNodeSetIsEmpty(ns)

-Checks whether ns is empty or not.

-
-
ns: a node-set
-
xmlXPathFreeObject ()
void        xmlXPathFreeObject              (xmlXPathObjectPtr obj);

-Free up an xmlXPathObjectPtr object.

-
-
obj:  the object to free
-
xmlXPathNodeSetCreate ()
xmlNodeSetPtr xmlXPathNodeSetCreate         (xmlNodePtr val);

-Create a new xmlNodeSetPtr of type double and of value val

-
-
val:  an initial xmlNodePtr, or NULL
-
Returns :the newly created object.
-
xmlXPathFreeNodeSetList ()
void        xmlXPathFreeNodeSetList         (xmlXPathObjectPtr obj);

-Free up the xmlXPathObjectPtr obj but don't deallocate the objects in
-the list contrary to xmlXPathFreeObject().

-
-
obj:  an existing NodeSetList object
-
xmlXPathFreeNodeSet ()
void        xmlXPathFreeNodeSet             (xmlNodeSetPtr obj);

-Free the NodeSet compound (not the actual nodes !).

-
-
obj:  the xmlNodeSetPtr to free
-
xmlXPathObjectCopy ()
xmlXPathObjectPtr xmlXPathObjectCopy        (xmlXPathObjectPtr val);

-allocate a new copy of a given object

-
-
val:  the original object
-
Returns :the newly created object.
-
xmlXPathCmpNodes ()
int         xmlXPathCmpNodes                (xmlNodePtr node1,
-                                             xmlNodePtr node2);

-Compare two nodes w.r.t document order

-
-
node1:  the first node
-
node2:  the second node
-
Returns :-2 in case of error 1 if first point < second point, 0 if
-        that's the same node, -1 otherwise
-
xmlXPathCastNumberToBoolean ()
int         xmlXPathCastNumberToBoolean     (double val);

-Converts a number to its boolean value

-
-
val:  a number
-
Returns :the boolean value
-
xmlXPathCastStringToBoolean ()
int         xmlXPathCastStringToBoolean     (const xmlChar *val);

-Converts a string to its boolean value

-
-
val:  a string
-
Returns :the boolean value
-
xmlXPathCastNodeSetToBoolean ()
int         xmlXPathCastNodeSetToBoolean    (xmlNodeSetPtr ns);

-Converts a node-set to its boolean value

-
-
ns:  a node-set
-
Returns :the boolean value
-
xmlXPathCastToBoolean ()
int         xmlXPathCastToBoolean           (xmlXPathObjectPtr val);

-Converts an XPath object to its boolean value

-
-
val:  an XPath object
-
Returns :the boolean value
-
xmlXPathCastBooleanToNumber ()
double      xmlXPathCastBooleanToNumber     (int val);

-Converts a boolean to its number value

-
-
val:  a boolean
-
Returns :the number value
-
xmlXPathCastStringToNumber ()
double      xmlXPathCastStringToNumber      (const xmlChar *val);

-Converts a string to its number value

-
-
val:  a string
-
Returns :the number value
-
xmlXPathCastNodeToNumber ()
double      xmlXPathCastNodeToNumber        (xmlNodePtr node);

-Converts a node to its number value

-
-
node:  a node
-
Returns :the number value
-
xmlXPathCastNodeSetToNumber ()
double      xmlXPathCastNodeSetToNumber     (xmlNodeSetPtr ns);

-Converts a node-set to its number value

-
-
ns:  a node-set
-
Returns :the number value
-
xmlXPathCastToNumber ()
double      xmlXPathCastToNumber            (xmlXPathObjectPtr val);

-Converts an XPath object to its number value

-
-
val:  an XPath object
-
Returns :the number value
-
xmlXPathCastBooleanToString ()
xmlChar*    xmlXPathCastBooleanToString     (int val);

-Converts a boolean to its string value.

-
-
val:  a boolean
-
Returns :a newly allocated string.
-
xmlXPathCastNumberToString ()
xmlChar*    xmlXPathCastNumberToString      (double val);

-Converts a number to its string value.

-
-
val:  a number
-
Returns :a newly allocated string.
-
xmlXPathCastNodeToString ()
xmlChar*    xmlXPathCastNodeToString        (xmlNodePtr node);

-Converts a node to its string value.

-
-
node:  a node
-
Returns :a newly allocated string.
-
xmlXPathCastNodeSetToString ()
xmlChar*    xmlXPathCastNodeSetToString     (xmlNodeSetPtr ns);

-Converts a node-set to its string value.

-
-
ns:  a node-set
-
Returns :a newly allocated string.
-
xmlXPathCastToString ()
xmlChar*    xmlXPathCastToString            (xmlXPathObjectPtr val);

-Converts an existing object to its string() equivalent

-
-
val:  an XPath object
-
Returns :the string value of the object, NULL in case of error.
-        A new string is allocated only if needed (val isn't a
-        string object).
-
xmlXPathConvertBoolean ()
xmlXPathObjectPtr xmlXPathConvertBoolean    (xmlXPathObjectPtr val);

-Converts an existing object to its boolean() equivalent

-
-
val:  an XPath object
-
Returns :the new object, the old one is freed (or the operation
-        is done directly on val)
-
xmlXPathConvertNumber ()
xmlXPathObjectPtr xmlXPathConvertNumber     (xmlXPathObjectPtr val);

-Converts an existing object to its number() equivalent

-
-
val:  an XPath object
-
Returns :the new object, the old one is freed (or the operation
-        is done directly on val)
-
xmlXPathConvertString ()
xmlXPathObjectPtr xmlXPathConvertString     (xmlXPathObjectPtr val);

-Converts an existing object to its string() equivalent

-
-
val:  an XPath object
-
Returns :the new object, the old one is freed (or the operation
-        is done directly on val)
-
xmlXPathInit ()
void        xmlXPathInit                    (void);

-Initialize the XPath environment

-
-
xmlXPathNewContext ()
xmlXPathContextPtr xmlXPathNewContext       (xmlDocPtr doc);

-Create a new xmlXPathContext

-
-
doc:  the XML document
-
Returns :the xmlXPathContext just allocated. The caller will need to free it.
-
xmlXPathFreeContext ()
void        xmlXPathFreeContext             (xmlXPathContextPtr ctxt);

-Free up an xmlXPathContext

-
-
ctxt:  the context to free
-
xmlXPathOrderDocElems ()
long        xmlXPathOrderDocElems           (xmlDocPtr doc);

-Call this routine to speed up XPath computation on static documents.
-This stamps all the element nodes with the document order
-Like for line information, the order is kept in the element->content
-field, the value stored is actually - the node number (startting at -1)
-to be able to differenciate from line numbers.

-
-
doc:  an input document
-
Returns :the number of element found in the document or -1 in case
-   of error.
-
xmlXPathEval ()
xmlXPathObjectPtr xmlXPathEval              (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);

-Evaluate the XPath Location Path in the given context.

-
-
str:  the XPath expression
-
ctx:  the XPath context
-
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL.
-        the caller has to free the object.
-
xmlXPathEvalExpression ()
xmlXPathObjectPtr xmlXPathEvalExpression    (const xmlChar *str,
-                                             xmlXPathContextPtr ctxt);

-Evaluate the XPath expression in the given context.

-
-
str:  the XPath expression
-
ctxt:  the XPath context
-
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL.
-        the caller has to free the object.
-
xmlXPathEvalPredicate ()
int         xmlXPathEvalPredicate           (xmlXPathContextPtr ctxt,
-                                             xmlXPathObjectPtr res);

-Evaluate a predicate result for the current node.
-A PredicateExpr is evaluated by evaluating the Expr and converting
-the result to a boolean. If the result is a number, the result will
-be converted to true if the number is equal to the position of the
-context node in the context node list (as returned by the position
-function) and will be converted to false otherwise; if the result
-is not a number, then the result will be converted as if by a call
-to the boolean function.

-
-
ctxt:  the XPath context
-
res:  the Predicate Expression evaluation result
-
Returns :1 if predicate is true, 0 otherwise
-
xmlXPathCompile ()
xmlXPathCompExprPtr xmlXPathCompile         (const xmlChar *str);

-Compile an XPath expression

-
-
str:  the XPath expression
-
Returns :the xmlXPathCompExprPtr resulting from the compilation or NULL.
-        the caller has to free the object.
-
xmlXPathCompiledEval ()
xmlXPathObjectPtr xmlXPathCompiledEval      (xmlXPathCompExprPtr comp,
-                                             xmlXPathContextPtr ctx);

-Evaluate the Precompiled XPath expression in the given context.

-
-
comp:  the compiled XPath expression
-
ctx:  the XPath context
-
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL.
-        the caller has to free the object.
-
xmlXPathFreeCompExpr ()
void        xmlXPathFreeCompExpr            (xmlXPathCompExprPtr comp);

-Free up the memory allocated by comp

-
-
comp:  an XPATH comp
-
<< xmlIOSAX >>

+
+
+Module xpath from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xpath from libxml2
Main Menu
Related links
Table of Contents
int	xmlXPathCastNodeSetToBoolean	(xmlNodeSetPtr ns)

+
Typedef xmlXPathObject * xmlXPathObjectPtr
+
+
int	xmlXPathIsNaN	(double val)

+
xmlXPathObjectPtr	xmlXPathConvertString	(xmlXPathObjectPtr val)

+
xmlXPathObjectPtr	xmlXPathConvertBoolean	(xmlXPathObjectPtr val)

+
xmlNodeSetPtr	xmlXPathNodeSetCreate	(xmlNodePtr val)

+
double	xmlXPathCastBooleanToNumber	(int val)

+
Variable double xmlXPathPINF
+
+
Function type: xmlXPathAxisFunc
+xmlXPathObjectPtr	xmlXPathAxisFunc	(xmlXPathParserContextPtr ctxt, 
				 xmlXPathObjectPtr cur)
+
An axis traversal function. To traverse an axis, the engine calls the first time with cur == NULL and repeat until the function returns NULL indicating the end of the axis traversal.
ctxt:the XPath interpreter context
cur:the previous node being explored on that axis
Returns:the next node in that axis or NULL if at the end of the axis.


+
double	xmlXPathCastToNumber	(xmlXPathObjectPtr val)

+
int	xmlXPathCastStringToBoolean	(const xmlChar * val)

+
#define xmlXPathNodeSetItem
+
+
void	xmlXPathFreeObject	(xmlXPathObjectPtr obj)

+
Typedef xmlNodeSet * xmlNodeSetPtr
+
+
int	xmlXPathEvalPredicate	(xmlXPathContextPtr ctxt, 
				 xmlXPathObjectPtr res)

+
void	xmlXPathFreeContext	(xmlXPathContextPtr ctxt)

+
void	xmlXPathFreeNodeSetList	(xmlXPathObjectPtr obj)

+
xmlXPathObjectPtr	xmlXPathEval	(const xmlChar * str, 
				 xmlXPathContextPtr ctx)

+
Typedef xmlXPathAxis * xmlXPathAxisPtr
+
+
xmlXPathObjectPtr	xmlXPathConvertNumber	(xmlXPathObjectPtr val)

+
xmlChar *	xmlXPathCastNodeSetToString	(xmlNodeSetPtr ns)

+
xmlXPathObjectPtr	xmlXPathEvalExpression	(const xmlChar * str, 
				 xmlXPathContextPtr ctxt)

+
Variable double xmlXPathNINF
+
+
Structure xmlXPathVariable
struct _xmlXPathVariable {
+    const xmlChar *	name	: the variable name
+    xmlXPathObjectPtr	value	: the value
+}

xmlChar *	xmlXPathCastToString	(xmlXPathObjectPtr val)

+
xmlXPathObjectPtr	xmlXPathObjectCopy	(xmlXPathObjectPtr val)

+
xmlChar *	xmlXPathCastBooleanToString	(int val)

+
int	xmlXPathCastNumberToBoolean	(double val)

+
void	xmlXPathFreeNodeSet	(xmlNodeSetPtr obj)

+
xmlXPathContextPtr	xmlXPathNewContext	(xmlDocPtr doc)

+
#define xmlXPathNodeSetIsEmpty
+
+
Variable double xmlXPathNAN
+
+
Enum xmlXPathError {
+    XPATH_EXPRESSION_OK = 0
+    XPATH_NUMBER_ERROR = 1
+    XPATH_UNFINISHED_LITERAL_ERROR = 2
+    XPATH_START_LITERAL_ERROR = 3
+    XPATH_VARIABLE_REF_ERROR = 4
+    XPATH_UNDEF_VARIABLE_ERROR = 5
+    XPATH_INVALID_PREDICATE_ERROR = 6
+    XPATH_EXPR_ERROR = 7
+    XPATH_UNCLOSED_ERROR = 8
+    XPATH_UNKNOWN_FUNC_ERROR = 9
+    XPATH_INVALID_OPERAND = 10
+    XPATH_INVALID_TYPE = 11
+    XPATH_INVALID_ARITY = 12
+    XPATH_INVALID_CTXT_SIZE = 13
+    XPATH_INVALID_CTXT_POSITION = 14
+    XPATH_MEMORY_ERROR = 15
+    XPTR_SYNTAX_ERROR = 16
+    XPTR_RESOURCE_ERROR = 17
+    XPTR_SUB_RESOURCE_ERROR = 18
+    XPATH_UNDEF_PREFIX_ERROR = 19
+    XPATH_ENCODING_ERROR = 20
+    XPATH_INVALID_CHAR_ERROR = 21
+}
+
+
int	xmlXPathCastToBoolean	(xmlXPathObjectPtr val)

+
Typedef xmlXPathVariable * xmlXPathVariablePtr
+
+
xmlChar *	xmlXPathCastNodeToString	(xmlNodePtr node)

+
Structure xmlXPathFunct
struct _xmlXPathFunct {
+    const xmlChar *	name	: the function name
+    xmlXPathEvalFunc	func	: the evaluation function
+}

Typedef xmlXPathCompExpr * xmlXPathCompExprPtr
+
+
Structure xmlXPathObject
struct _xmlXPathObject {
+    xmlXPathObjectType	type
+    xmlNodeSetPtr	nodesetval
+    int	boolval
+    double	floatval
+    xmlChar *	stringval
+    void *	user
+    int	index
+    void *	user2
+    int	index2
+}

long	xmlXPathOrderDocElems	(xmlDocPtr doc)

+
#define xmlXPathNodeSetGetLength
+
+
double	xmlXPathCastNodeToNumber	(xmlNodePtr node)

+
double	xmlXPathCastStringToNumber	(const xmlChar * val)

+
Structure xmlXPathContext
struct _xmlXPathContext {
+    xmlDocPtr	doc	: The current document
+    xmlNodePtr	node	: The current node
+    int	nb_variables_unused	: unused (hash table)
+    int	max_variables_unused	: unused (hash table)
+    xmlHashTablePtr	varHash	: Hash table of defined variables
+    int	nb_types	: number of defined types
+    int	max_types	: max number of types
+    xmlXPathTypePtr	types	: Array of defined types
+    int	nb_funcs_unused	: unused (hash table)
+    int	max_funcs_unused	: unused (hash table)
+    xmlHashTablePtr	funcHash	: Hash table of defined funcs
+    int	nb_axis	: number of defined axis
+    int	max_axis	: max number of axis
+    xmlXPathAxisPtr	axis	: Array of defined axis the namespace nodes of the
+    xmlNsPtr *	namespaces	: Array of namespaces
+    int	nsNr	: number of namespace in scope
+    void *	user	: function to free extra variables
+    int	contextSize	: the context size
+    int	proximityPosition	: the proximity position extra stuff for XPointer
+    int	xptr	: it this an XPointer context
+    xmlNodePtr	here	: for here()
+    xmlNodePtr	origin	: for origin() the set of namespace declarations in
+    xmlHashTablePtr	nsHash	: The namespaces hash table
+    void *	varLookupFunc	: variable lookup func
+    void *	varLookupData	: variable lookup data Possibility to link in an ex
+    void *	extra	: needed for XSLT The function name and URI when ca
+    const xmlChar *	function
+    const xmlChar *	functionURI	: function lookup function and data
+    void *	funcLookupFunc	: function lookup func
+    void *	funcLookupData	: function lookup data temporary namespace lists ke
+    xmlNsPtr *	tmpNsList	: Array of namespaces
+    int	tmpNsNr	: number of namespace in scope error reporting mech
+    void *	userData	: user specific data block
+    xmlStructuredErrorFunc	error	: the callback in case of errors
+    xmlError	lastError	: the last error
+    xmlNodePtr	debugNode	: the source node XSLT
+}

Structure xmlXPathParserContext
struct _xmlXPathParserContext {
+    const xmlChar *	cur	: the current char being parsed
+    const xmlChar *	base	: the full expression
+    int	error	: error code
+    xmlXPathContextPtr	context	: the evaluation context
+    xmlXPathObjectPtr	value	: the current value
+    int	valueNr	: number of values stacked
+    int	valueMax	: max number of values stacked
+    xmlXPathObjectPtr *	valueTab	: stack of values
+    xmlXPathCompExprPtr	comp	: the precompiled expression
+    int	xptr	: it this an XPointer expression
+    xmlNodePtr	ancestor	: used for walking preceding axis
+}

Typedef xmlXPathType * xmlXPathTypePtr
+
+
Structure xmlXPathType
struct _xmlXPathType {
+    const xmlChar *	name	: the type name
+    xmlXPathConvertFunc	func	: the conversion function
+}

int	xmlXPathIsInf	(double val)

+
Structure xmlXPathAxis
struct _xmlXPathAxis {
+    const xmlChar *	name	: the axis name
+    xmlXPathAxisFunc	func	: the search function
+}

xmlXPathObjectPtr	xmlXPathCompiledEval	(xmlXPathCompExprPtr comp, 
				 xmlXPathContextPtr ctx)

+
Structure xmlNodeSet
struct _xmlNodeSet {
+    int	nodeNr	: number of nodes in the set
+    int	nodeMax	: size of the array as allocated
+    xmlNodePtr *	nodeTab	: array of nodes in no particular order @@ with_ns
+}

Typedef xmlXPathFunct * xmlXPathFuncPtr
+
+
Function type: xmlXPathConvertFunc
+int	xmlXPathConvertFunc	(xmlXPathObjectPtr obj, 
				 int type)
+
A conversion function is associated to a type and used to cast the new type to primitive values.
obj:an XPath object
type:the number of the target type
Returns:-1 in case of error, 0 otherwise


+
void	xmlXPathInit	(void)

+
int	xmlXPathCmpNodes	(xmlNodePtr node1, 
				 xmlNodePtr node2)

+
xmlChar *	xmlXPathCastNumberToString	(double val)

+
Function type: xmlXPathEvalFunc
+void	xmlXPathEvalFunc	(xmlXPathParserContextPtr ctxt, 
				 int nargs)
+
An XPath evaluation function, the parameters are on the XPath context stack.
ctxt:an XPath parser context
nargs:the number of arguments passed to the function


+
Function type: xmlXPathFunction
+void	xmlXPathFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)
+
An XPath function. The arguments (if any) are popped out from the context stack and the result is pushed on the stack.
ctxt:the XPath interprestation context
nargs:the number of arguments


+
void	xmlXPathFreeCompExpr	(xmlXPathCompExprPtr comp)

+
Typedef xmlXPathParserContext * xmlXPathParserContextPtr
+
+
Structure xmlXPathCompExpr
struct _xmlXPathCompExpr {
+The content of this structure is not made public by the API.
+}

Typedef xmlXPathContext * xmlXPathContextPtr
+
+
xmlXPathCompExprPtr	xmlXPathCompile	(const xmlChar * str)

+
double	xmlXPathCastNodeSetToNumber	(xmlNodeSetPtr ns)

+
Enum xmlXPathObjectType {
+    XPATH_UNDEFINED = 0
+    XPATH_NODESET = 1
+    XPATH_BOOLEAN = 2
+    XPATH_NUMBER = 3
+    XPATH_STRING = 4
+    XPATH_POINT = 5
+    XPATH_RANGE = 6
+    XPATH_LOCATIONSET = 7
+    XPATH_USERS = 8
+    XPATH_XSLT_TREE = 9 : An XSLT value tree, non modifiable
+}
+
+
Description

+
Function: xmlXPathCastNodeSetToBoolean
int	xmlXPathCastNodeSetToBoolean	(xmlNodeSetPtr ns)

+
Converts a node-set to its boolean value

+
ns:a node-set
Returns:the boolean value
Function: xmlXPathIsNaN
int	xmlXPathIsNaN	(double val)

+
Provides a portable isnan() function to detect whether a double is a NotaNumber. Based on trio code http://sourceforge.net/projects/ctrio/

+
val:a double value
Returns:1 if the value is a NaN, 0 otherwise
Function: xmlXPathConvertString
xmlXPathObjectPtr	xmlXPathConvertString	(xmlXPathObjectPtr val)

+
Converts an existing object to its string() equivalent

+
val:an XPath object
Returns:the new object, the old one is freed (or the operation is done directly on @val)
Function: xmlXPathConvertBoolean
xmlXPathObjectPtr	xmlXPathConvertBoolean	(xmlXPathObjectPtr val)

+
Converts an existing object to its boolean() equivalent

+
val:an XPath object
Returns:the new object, the old one is freed (or the operation is done directly on @val)
Function: xmlXPathNodeSetCreate
xmlNodeSetPtr	xmlXPathNodeSetCreate	(xmlNodePtr val)

+
Create a new xmlNodeSetPtr of type double and of value @val

+
val:an initial xmlNodePtr, or NULL
Returns:the newly created object.
Function: xmlXPathCastBooleanToNumber
double	xmlXPathCastBooleanToNumber	(int val)

+
Converts a boolean to its number value

+
val:a boolean
Returns:the number value

+      An axis traversal function. To traverse an axis, the engine calls the first time with cur == NULL and repeat until the function returns NULL indicating the end of the axis traversal.
+      
+      
+      
+    
Function: xmlXPathCastToNumber
double	xmlXPathCastToNumber	(xmlXPathObjectPtr val)

+
Converts an XPath object to its number value

+
val:an XPath object
Returns:the number value
Function: xmlXPathCastStringToBoolean
int	xmlXPathCastStringToBoolean	(const xmlChar * val)

+
Converts a string to its boolean value

+
val:a string
Returns:the boolean value
Macro: xmlXPathNodeSetItem
#define xmlXPathNodeSetItem
Implements a functionality similar to the DOM NodeList.item(). Returns the xmlNodePtr at the given @index in @ns or NULL if @index is out of range (0 to length-1)

+
Function: xmlXPathFreeObject
void	xmlXPathFreeObject	(xmlXPathObjectPtr obj)

+
Free up an xmlXPathObjectPtr object.

+
obj:the object to free
Function: xmlXPathEvalPredicate
int	xmlXPathEvalPredicate	(xmlXPathContextPtr ctxt, 
				 xmlXPathObjectPtr res)

+
Evaluate a predicate result for the current node. A PredicateExpr is evaluated by evaluating the Expr and converting the result to a boolean. If the result is a number, the result will be converted to true if the number is equal to the position of the context node in the context node list (as returned by the position function) and will be converted to false otherwise; if the result is not a number, then the result will be converted as if by a call to the boolean function.

+
ctxt:the XPath context
res:the Predicate Expression evaluation result
Returns:1 if predicate is true, 0 otherwise
Function: xmlXPathFreeContext
void	xmlXPathFreeContext	(xmlXPathContextPtr ctxt)

+
Free up an xmlXPathContext

+
ctxt:the context to free
Function: xmlXPathFreeNodeSetList
void	xmlXPathFreeNodeSetList	(xmlXPathObjectPtr obj)

+
Free up the xmlXPathObjectPtr @obj but don't deallocate the objects in the list contrary to xmlXPathFreeObject().

+
obj:an existing NodeSetList object
Function: xmlXPathEval
xmlXPathObjectPtr	xmlXPathEval	(const xmlChar * str, 
				 xmlXPathContextPtr ctx)

+
Evaluate the XPath Location Path in the given context.

+
str:the XPath expression
ctx:the XPath context
Returns:the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object.
Function: xmlXPathConvertNumber
xmlXPathObjectPtr	xmlXPathConvertNumber	(xmlXPathObjectPtr val)

+
Converts an existing object to its number() equivalent

+
val:an XPath object
Returns:the new object, the old one is freed (or the operation is done directly on @val)
Function: xmlXPathCastNodeSetToString
xmlChar *	xmlXPathCastNodeSetToString	(xmlNodeSetPtr ns)

+
Converts a node-set to its string value.

+
ns:a node-set
Returns:a newly allocated string.
Function: xmlXPathEvalExpression
xmlXPathObjectPtr	xmlXPathEvalExpression	(const xmlChar * str, 
				 xmlXPathContextPtr ctxt)

+
Evaluate the XPath expression in the given context.

+
str:the XPath expression
ctxt:the XPath context
Returns:the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object.

+      
+      
+    
Function: xmlXPathCastToString
xmlChar *	xmlXPathCastToString	(xmlXPathObjectPtr val)

+
Converts an existing object to its string() equivalent

+
val:an XPath object
Returns:the string value of the object, NULL in case of error. A new string is allocated only if needed (@val isn't a string object).
Function: xmlXPathObjectCopy
xmlXPathObjectPtr	xmlXPathObjectCopy	(xmlXPathObjectPtr val)

+
allocate a new copy of a given object

+
val:the original object
Returns:the newly created object.
Function: xmlXPathCastBooleanToString
xmlChar *	xmlXPathCastBooleanToString	(int val)

+
Converts a boolean to its string value.

+
val:a boolean
Returns:a newly allocated string.
Function: xmlXPathCastNumberToBoolean
int	xmlXPathCastNumberToBoolean	(double val)

+
Converts a number to its boolean value

+
val:a number
Returns:the boolean value
Function: xmlXPathFreeNodeSet
void	xmlXPathFreeNodeSet	(xmlNodeSetPtr obj)

+
Free the NodeSet compound (not the actual nodes !).

+
obj:the xmlNodeSetPtr to free
Function: xmlXPathNewContext
xmlXPathContextPtr	xmlXPathNewContext	(xmlDocPtr doc)

+
Create a new xmlXPathContext

+
doc:the XML document
Returns:the xmlXPathContext just allocated. The caller will need to free it.
Macro: xmlXPathNodeSetIsEmpty
#define xmlXPathNodeSetIsEmpty
Checks whether @ns is empty or not. Returns %TRUE if @ns is an empty node-set.

+
Function: xmlXPathCastToBoolean
int	xmlXPathCastToBoolean	(xmlXPathObjectPtr val)

+
Converts an XPath object to its boolean value

+
val:an XPath object
Returns:the boolean value
Function: xmlXPathCastNodeToString
xmlChar *	xmlXPathCastNodeToString	(xmlNodePtr node)

+
Converts a node to its string value.

+
node:a node
Returns:a newly allocated string.

+      
+      
+    
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
Function: xmlXPathOrderDocElems
long	xmlXPathOrderDocElems	(xmlDocPtr doc)

+
Call this routine to speed up XPath computation on static documents. This stamps all the element nodes with the document order Like for line information, the order is kept in the element->content field, the value stored is actually - the node number (startting at -1) to be able to differenciate from line numbers.

+
doc:an input document
Returns:the number of element found in the document or -1 in case of error.
Macro: xmlXPathNodeSetGetLength
#define xmlXPathNodeSetGetLength
Implement a functionality similar to the DOM NodeList.length. Returns the number of nodes in the node-set.

+
Function: xmlXPathCastNodeToNumber
double	xmlXPathCastNodeToNumber	(xmlNodePtr node)

+
Converts a node to its number value

+
node:a node
Returns:the number value
Function: xmlXPathCastStringToNumber
double	xmlXPathCastStringToNumber	(const xmlChar * val)

+
Converts a string to its number value

+
val:a string
Returns:the number value

+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    
+      
+      
+    
Function: xmlXPathIsInf
int	xmlXPathIsInf	(double val)

+
Provides a portable isinf() function to detect whether a double is a +Infinite or -Infinite. Based on trio code http://sourceforge.net/projects/ctrio/

+
val:a double value
Returns:1 vi the value is +Infinite, -1 if -Infinite, 0 otherwise

+      
+      
+    
Function: xmlXPathCompiledEval
xmlXPathObjectPtr	xmlXPathCompiledEval	(xmlXPathCompExprPtr comp, 
				 xmlXPathContextPtr ctx)

+
Evaluate the Precompiled XPath expression in the given context.

+
comp:the compiled XPath expression
ctx:the XPath context
Returns:the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object.

+      
+      
+      
+    
+      A conversion function is associated to a type and used to cast the new type to primitive values.
+      
+      
+      
+    
Function: xmlXPathInit
void	xmlXPathInit	(void)

+
Initialize the XPath environment

+
Function: xmlXPathCmpNodes
int	xmlXPathCmpNodes	(xmlNodePtr node1, 
				 xmlNodePtr node2)

+
Compare two nodes w.r.t document order

+
node1:the first node
node2:the second node
Returns:-2 in case of error 1 if first point < second point, 0 if that's the same node, -1 otherwise
Function: xmlXPathCastNumberToString
xmlChar *	xmlXPathCastNumberToString	(double val)

+
Converts a number to its string value.

+
val:a number
Returns:a newly allocated string.

+      An XPath evaluation function, the parameters are on the XPath context stack.
+      
+      
+      
+    
+      An XPath function. The arguments (if any) are popped out from the context stack and the result is pushed on the stack.
+      
+      
+      
+    
Function: xmlXPathFreeCompExpr
void	xmlXPathFreeCompExpr	(xmlXPathCompExprPtr comp)

+
Free up the memory allocated by @comp

+
comp:an XPATH comp
Function: xmlXPathCompile
xmlXPathCompExprPtr	xmlXPathCompile	(const xmlChar * str)

+
Compile an XPath expression

+
str:the XPath expression
Returns:the xmlXPathCompExprPtr resulting from the compilation or NULL. the caller has to free the object.
Function: xmlXPathCastNodeSetToNumber
double	xmlXPathCastNodeSetToNumber	(xmlNodeSetPtr ns)

+
Converts a node-set to its number value

+
ns:a node-set
Returns:the number value
Daniel Veillard

diff --git a/doc/html/libxml-xpathInternals.html b/doc/html/libxml-xpathInternals.html
index 2a73d1d1..a9c19ea3 100644
--- a/doc/html/libxml-xpathInternals.html
+++ b/doc/html/libxml-xpathInternals.html
@@ -1,1472 +1,467 @@
-xpathInternals
PrevUpHomeGnome XML Library Reference ManualNext
xpathInternals
xpathInternals — 
Synopsis
-
-
-
-#define     xmlXPathSetError                (ctxt, err)
-#define     xmlXPathSetArityError           (ctxt)
-#define     xmlXPathSetTypeError            (ctxt)
-#define     xmlXPathGetError                (ctxt)
-#define     xmlXPathCheckError              (ctxt)
-#define     xmlXPathGetDocument             (ctxt)
-#define     xmlXPathGetContextNode          (ctxt)
-int         xmlXPathPopBoolean              (xmlXPathParserContextPtr ctxt);
-double      xmlXPathPopNumber               (xmlXPathParserContextPtr ctxt);
-xmlChar*    xmlXPathPopString               (xmlXPathParserContextPtr ctxt);
-xmlNodeSetPtr xmlXPathPopNodeSet            (xmlXPathParserContextPtr ctxt);
-void*       xmlXPathPopExternal             (xmlXPathParserContextPtr ctxt);
-#define     xmlXPathReturnBoolean           (ctxt, val)
-#define     xmlXPathReturnTrue              (ctxt)
-#define     xmlXPathReturnFalse             (ctxt)
-#define     xmlXPathReturnNumber            (ctxt, val)
-#define     xmlXPathReturnString            (ctxt, str)
-#define     xmlXPathReturnEmptyString       (ctxt)
-#define     xmlXPathReturnNodeSet           (ctxt, ns)
-#define     xmlXPathReturnEmptyNodeSet      (ctxt)
-#define     xmlXPathReturnExternal          (ctxt, val)
-#define     xmlXPathStackIsNodeSet          (ctxt)
-#define     xmlXPathStackIsExternal         (ctxt)
-#define     xmlXPathEmptyNodeSet            (ns)
-#define     CHECK_ERROR
-#define     CHECK_ERROR0
-#define     XP_ERROR                        (X)
-#define     XP_ERROR0                       (X)
-#define     CHECK_TYPE                      (typeval)
-#define     CHECK_TYPE0                     (typeval)
-#define     CHECK_ARITY                     (x)
-#define     CAST_TO_STRING
-#define     CAST_TO_NUMBER
-#define     CAST_TO_BOOLEAN
-xmlXPathObjectPtr (*xmlXPathVariableLookupFunc)
-                                            (void *ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);
-void        xmlXPathRegisterVariableLookup  (xmlXPathContextPtr ctxt,
-                                             xmlXPathVariableLookupFunc f,
-                                             void *data);
-xmlXPathFunction (*xmlXPathFuncLookupFunc)  (void *ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);
-void        xmlXPathRegisterFuncLookup      (xmlXPathContextPtr ctxt,
-                                             xmlXPathFuncLookupFunc f,
-                                             void *funcCtxt);
-void        xmlXPatherror                   (xmlXPathParserContextPtr ctxt,
-                                             const char *file,
-                                             int line,
-                                             int no);
-void        xmlXPathErr                     (xmlXPathParserContextPtr ctxt,
-                                             int error);
-void        xmlXPathDebugDumpObject         (FILE *output,
-                                             xmlXPathObjectPtr cur,
-                                             int depth);
-void        xmlXPathDebugDumpCompExpr       (FILE *output,
-                                             xmlXPathCompExprPtr comp,
-                                             int depth);
-int         xmlXPathNodeSetContains         (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);
-xmlNodeSetPtr xmlXPathDifference            (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);
-xmlNodeSetPtr xmlXPathIntersection          (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);
-xmlNodeSetPtr xmlXPathDistinctSorted        (xmlNodeSetPtr nodes);
-xmlNodeSetPtr xmlXPathDistinct              (xmlNodeSetPtr nodes);
-int         xmlXPathHasSameNodes            (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);
-xmlNodeSetPtr xmlXPathNodeLeadingSorted     (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);
-xmlNodeSetPtr xmlXPathLeadingSorted         (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);
-xmlNodeSetPtr xmlXPathNodeLeading           (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);
-xmlNodeSetPtr xmlXPathLeading               (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);
-xmlNodeSetPtr xmlXPathNodeTrailingSorted    (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);
-xmlNodeSetPtr xmlXPathTrailingSorted        (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);
-xmlNodeSetPtr xmlXPathNodeTrailing          (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);
-xmlNodeSetPtr xmlXPathTrailing              (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);
-int         xmlXPathRegisterNs              (xmlXPathContextPtr ctxt,
-                                             const xmlChar *prefix,
-                                             const xmlChar *ns_uri);
-const xmlChar* xmlXPathNsLookup             (xmlXPathContextPtr ctxt,
-                                             const xmlChar *prefix);
-void        xmlXPathRegisteredNsCleanup     (xmlXPathContextPtr ctxt);
-int         xmlXPathRegisterFunc            (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlXPathFunction f);
-int         xmlXPathRegisterFuncNS          (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri,
-                                             xmlXPathFunction f);
-int         xmlXPathRegisterVariable        (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlXPathObjectPtr value);
-int         xmlXPathRegisterVariableNS      (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri,
-                                             xmlXPathObjectPtr value);
-xmlXPathFunction xmlXPathFunctionLookup     (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name);
-xmlXPathFunction xmlXPathFunctionLookupNS   (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);
-void        xmlXPathRegisteredFuncsCleanup  (xmlXPathContextPtr ctxt);
-xmlXPathObjectPtr xmlXPathVariableLookup    (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name);
-xmlXPathObjectPtr xmlXPathVariableLookupNS  (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);
-void        xmlXPathRegisteredVariablesCleanup
-                                            (xmlXPathContextPtr ctxt);
-xmlXPathParserContextPtr xmlXPathNewParserContext
-                                            (const xmlChar *str,
-                                             xmlXPathContextPtr ctxt);
-void        xmlXPathFreeParserContext       (xmlXPathParserContextPtr ctxt);
-xmlXPathObjectPtr valuePop                  (xmlXPathParserContextPtr ctxt);
-int         valuePush                       (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr value);
-xmlXPathObjectPtr xmlXPathNewString         (const xmlChar *val);
-xmlXPathObjectPtr xmlXPathNewCString        (const char *val);
-xmlXPathObjectPtr xmlXPathWrapString        (xmlChar *val);
-xmlXPathObjectPtr xmlXPathWrapCString       (char *val);
-xmlXPathObjectPtr xmlXPathNewFloat          (double val);
-xmlXPathObjectPtr xmlXPathNewBoolean        (int val);
-xmlXPathObjectPtr xmlXPathNewNodeSet        (xmlNodePtr val);
-xmlXPathObjectPtr xmlXPathNewValueTree      (xmlNodePtr val);
-void        xmlXPathNodeSetAdd              (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);
-void        xmlXPathNodeSetAddUnique        (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);
-void        xmlXPathNodeSetAddNs            (xmlNodeSetPtr cur,
-                                             xmlNodePtr node,
-                                             xmlNsPtr ns);
-void        xmlXPathNodeSetSort             (xmlNodeSetPtr set);
-void        xmlXPathRoot                    (xmlXPathParserContextPtr ctxt);
-void        xmlXPathEvalExpr                (xmlXPathParserContextPtr ctxt);
-xmlChar*    xmlXPathParseName               (xmlXPathParserContextPtr ctxt);
-xmlChar*    xmlXPathParseNCName             (xmlXPathParserContextPtr ctxt);
-double      xmlXPathStringEvalNumber        (const xmlChar *str);
-int         xmlXPathEvaluatePredicateResult (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr res);
-void        xmlXPathRegisterAllFunctions    (xmlXPathContextPtr ctxt);
-xmlNodeSetPtr xmlXPathNodeSetMerge          (xmlNodeSetPtr val1,
-                                             xmlNodeSetPtr val2);
-void        xmlXPathNodeSetDel              (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);
-void        xmlXPathNodeSetRemove           (xmlNodeSetPtr cur,
-                                             int val);
-xmlXPathObjectPtr xmlXPathNewNodeSetList    (xmlNodeSetPtr val);
-xmlXPathObjectPtr xmlXPathWrapNodeSet       (xmlNodeSetPtr val);
-xmlXPathObjectPtr xmlXPathWrapExternal      (void *val);
-int         xmlXPathEqualValues             (xmlXPathParserContextPtr ctxt);
-int         xmlXPathNotEqualValues          (xmlXPathParserContextPtr ctxt);
-int         xmlXPathCompareValues           (xmlXPathParserContextPtr ctxt,
-                                             int inf,
-                                             int strict);
-void        xmlXPathValueFlipSign           (xmlXPathParserContextPtr ctxt);
-void        xmlXPathAddValues               (xmlXPathParserContextPtr ctxt);
-void        xmlXPathSubValues               (xmlXPathParserContextPtr ctxt);
-void        xmlXPathMultValues              (xmlXPathParserContextPtr ctxt);
-void        xmlXPathDivValues               (xmlXPathParserContextPtr ctxt);
-void        xmlXPathModValues               (xmlXPathParserContextPtr ctxt);
-int         xmlXPathIsNodeType              (const xmlChar *name);
-xmlNodePtr  xmlXPathNextSelf                (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextChild               (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextDescendant          (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextDescendantOrSelf    (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextParent              (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextAncestorOrSelf      (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextFollowingSibling    (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextFollowing           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextNamespace           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextAttribute           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextPreceding           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextAncestor            (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-xmlNodePtr  xmlXPathNextPrecedingSibling    (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);
-void        xmlXPathLastFunction            (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathPositionFunction        (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathCountFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathIdFunction              (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathLocalNameFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathNamespaceURIFunction    (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathStringFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathStringLengthFunction    (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathConcatFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathContainsFunction        (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathStartsWithFunction      (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathSubstringFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathSubstringBeforeFunction (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathSubstringAfterFunction  (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathNormalizeFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathTranslateFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathNotFunction             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathTrueFunction            (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathFalseFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathLangFunction            (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathNumberFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathSumFunction             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathFloorFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathCeilingFunction         (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathRoundFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathBooleanFunction         (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-void        xmlXPathNodeSetFreeNs           (xmlNsPtr ns);
-
Description

-
-
Details
xmlXPathSetError()
#define     xmlXPathSetError(ctxt, err)

-Raises an error.

-
-
ctxt:  an XPath parser context
-
err:  an xmlXPathError code
-
xmlXPathSetArityError()
#define     xmlXPathSetArityError(ctxt)

-Raises an XPATH_INVALID_ARITY error.

-
-
ctxt:  an XPath parser context
-
xmlXPathSetTypeError()
#define     xmlXPathSetTypeError(ctxt)

-Raises an XPATH_INVALID_TYPE error.

-
-
ctxt:  an XPath parser context
-
xmlXPathGetError()
#define xmlXPathGetError(ctxt)	  ((ctxt)->error)
-

-Get the error code of an XPath context.

-
-
ctxt:  an XPath parser context
-
xmlXPathCheckError()
#define xmlXPathCheckError(ctxt)  ((ctxt)->error != XPATH_EXPRESSION_OK)
-

-Check if an XPath error was raised.

-
-
ctxt:  an XPath parser context
-
xmlXPathGetDocument()
#define xmlXPathGetDocument(ctxt)	((ctxt)->context->doc)
-

-Get the document of an XPath context.

-
-
ctxt:  an XPath parser context
-
xmlXPathGetContextNode()
#define xmlXPathGetContextNode(ctxt)	((ctxt)->context->node)
-

-Get the context node of an XPath context.

-
-
ctxt: an XPath parser context
-
xmlXPathPopBoolean ()
int         xmlXPathPopBoolean              (xmlXPathParserContextPtr ctxt);

-Pops a boolean from the stack, handling conversion if needed.
-Check error with xmlXPathCheckError.

-
-
ctxt:  an XPath parser context
-
Returns :the boolean
-
xmlXPathPopNumber ()
double      xmlXPathPopNumber               (xmlXPathParserContextPtr ctxt);

-Pops a number from the stack, handling conversion if needed.
-Check error with xmlXPathCheckError.

-
-
ctxt:  an XPath parser context
-
Returns :the number
-
xmlXPathPopString ()
xmlChar*    xmlXPathPopString               (xmlXPathParserContextPtr ctxt);

-Pops a string from the stack, handling conversion if needed.
-Check error with xmlXPathCheckError.

-
-
ctxt:  an XPath parser context
-
Returns :the string
-
xmlXPathPopNodeSet ()
xmlNodeSetPtr xmlXPathPopNodeSet            (xmlXPathParserContextPtr ctxt);

-Pops a node-set from the stack, handling conversion if needed.
-Check error with xmlXPathCheckError.

-
-
ctxt:  an XPath parser context
-
Returns :the node-set
-
xmlXPathPopExternal ()
void*       xmlXPathPopExternal             (xmlXPathParserContextPtr ctxt);

-Pops an external object from the stack, handling conversion if needed.
-Check error with xmlXPathCheckError.

-
-
ctxt:  an XPath parser context
-
xmlXPathReturnBoolean()
#define     xmlXPathReturnBoolean(ctxt, val)

-Pushes the boolean val on the context stack.

-
-
ctxt:  an XPath parser context
-
val:  a boolean
-
xmlXPathReturnTrue()
#define xmlXPathReturnTrue(ctxt)   xmlXPathReturnBoolean((ctxt), 1)
-

-Pushes true on the context stack.

-
-
ctxt:  an XPath parser context
-
xmlXPathReturnFalse()
#define xmlXPathReturnFalse(ctxt)  xmlXPathReturnBoolean((ctxt), 0)
-

-Pushes false on the context stack.

-
-
ctxt:  an XPath parser context
-
xmlXPathReturnNumber()
#define     xmlXPathReturnNumber(ctxt, val)

-Pushes the double val on the context stack.

-
-
ctxt:  an XPath parser context
-
val:  a double
-
xmlXPathReturnString()
#define     xmlXPathReturnString(ctxt, str)

-Pushes the string str on the context stack.

-
-
ctxt:  an XPath parser context
-
str:  a string
-
xmlXPathReturnEmptyString()
#define     xmlXPathReturnEmptyString(ctxt)

-Pushes an empty string on the stack.

-
-
ctxt:  an XPath parser context
-
xmlXPathReturnNodeSet()
#define     xmlXPathReturnNodeSet(ctxt, ns)

-Pushes the node-set ns on the context stack.

-
-
ctxt:  an XPath parser context
-
ns:  a node-set
-
xmlXPathReturnEmptyNodeSet()
#define     xmlXPathReturnEmptyNodeSet(ctxt)

-Pushes an empty node-set on the context stack.

-
-
ctxt:  an XPath parser context
-
xmlXPathReturnExternal()
#define     xmlXPathReturnExternal(ctxt, val)

-Pushes user data on the context stack.

-
-
ctxt:  an XPath parser context
-
val:  user data
-
xmlXPathStackIsNodeSet()
#define     xmlXPathStackIsNodeSet(ctxt)

-Check if the current value on the XPath stack is a node set or
-an XSLT value tree.

-
-
ctxt: an XPath parser context
-
xmlXPathStackIsExternal()
#define     xmlXPathStackIsExternal(ctxt)

-Checks if the current value on the XPath stack is an external
-object.

-
-
ctxt: an XPath parser context
-
xmlXPathEmptyNodeSet()
#define     xmlXPathEmptyNodeSet(ns)

-Empties a node-set.

-
-
ns:  a node-set
-
CHECK_ERROR
#define     CHECK_ERROR

-Macro to return from the function if an XPath error was detected.

-
-
CHECK_ERROR0
#define     CHECK_ERROR0

-Macro to return 0 from the function if an XPath error was detected.

-
-
XP_ERROR()
#define     XP_ERROR(X)

-Macro to raise an XPath error and return.

-
-
X:  the error code
-
XP_ERROR0()
#define     XP_ERROR0(X)

-Macro to raise an XPath error and return 0.

-
-
X:  the error code
-
CHECK_TYPE()
#define     CHECK_TYPE(typeval)

-Macro to check that the value on top of the XPath stack is of a given
-type.

-
-
typeval:  the XPath type
-
CHECK_TYPE0()
#define     CHECK_TYPE0(typeval)

-Macro to check that the value on top of the XPath stack is of a given
-type. Return(0) in case of failure

-
-
typeval:  the XPath type
-
CHECK_ARITY()
#define     CHECK_ARITY(x)

-Macro to check that the number of args passed to an XPath function matches.

-
-
x:  the number of expected args
-
CAST_TO_STRING
#define     CAST_TO_STRING

-Macro to try to cast the value on the top of the XPath stack to a string.

-
-
CAST_TO_NUMBER
#define     CAST_TO_NUMBER

-Macro to try to cast the value on the top of the XPath stack to a number.

-
-
CAST_TO_BOOLEAN
#define     CAST_TO_BOOLEAN

-Macro to try to cast the value on the top of the XPath stack to a boolean.

-
-
xmlXPathVariableLookupFunc ()
xmlXPathObjectPtr (*xmlXPathVariableLookupFunc)
-                                            (void *ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);

-Prototype for callbacks used to plug variable lookup in the XPath
-engine.

-
-
ctxt:  an XPath context
-
name:  name of the variable
-
ns_uri:  the namespace name hosting this variable
-
Returns :the XPath object value or NULL if not found.
-
xmlXPathRegisterVariableLookup ()
void        xmlXPathRegisterVariableLookup  (xmlXPathContextPtr ctxt,
-                                             xmlXPathVariableLookupFunc f,
-                                             void *data);

-register an external mechanism to do variable lookup

-
-
ctxt:  the XPath context
-
f:  the lookup function
-
data:  the lookup data
-
xmlXPathFuncLookupFunc ()
xmlXPathFunction (*xmlXPathFuncLookupFunc)  (void *ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);

-Prototype for callbacks used to plug function lookup in the XPath
-engine.

-
-
ctxt:  an XPath context
-
name:  name of the function
-
ns_uri:  the namespace name hosting this function
-
Returns :the XPath function or NULL if not found.
-
xmlXPathRegisterFuncLookup ()
void        xmlXPathRegisterFuncLookup      (xmlXPathContextPtr ctxt,
-                                             xmlXPathFuncLookupFunc f,
-                                             void *funcCtxt);

-Registers an external mechanism to do function lookup.

-
-
ctxt:  the XPath context
-
f:  the lookup function
-
funcCtxt:  the lookup data
-
xmlXPatherror ()
void        xmlXPatherror                   (xmlXPathParserContextPtr ctxt,
-                                             const char *file,
-                                             int line,
-                                             int no);

-Formats an error message.

-
-
ctxt:  the XPath Parser context
-
file:  the file name
-
line:  the line number
-
no:  the error number
-
xmlXPathErr ()
void        xmlXPathErr                     (xmlXPathParserContextPtr ctxt,
-                                             int error);

-Handle a Relax NG Parsing error

-
-
ctxt:  a XPath parser context
-
error:  the error code
-
xmlXPathDebugDumpObject ()
void        xmlXPathDebugDumpObject         (FILE *output,
-                                             xmlXPathObjectPtr cur,
-                                             int depth);

-Dump the content of the object for debugging purposes

-
-
output:  the FILE * to dump the output
-
cur:  the object to inspect
-
depth:  indentation level
-
xmlXPathDebugDumpCompExpr ()
void        xmlXPathDebugDumpCompExpr       (FILE *output,
-                                             xmlXPathCompExprPtr comp,
-                                             int depth);

-Dumps the tree of the compiled XPath expression.

-
-
output:  the FILE * for the output
-
comp:  the precompiled XPath expression
-
depth:  the indentation level.
-
xmlXPathNodeSetContains ()
int         xmlXPathNodeSetContains         (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);

-checks whether cur contains val

-
-
cur:  the node-set
-
val:  the node
-
Returns :true (1) if cur contains val, false (0) otherwise
-
xmlXPathDifference ()
xmlNodeSetPtr xmlXPathDifference            (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);

-Implements the EXSLT - Sets difference() function:
-   node-set set:difference (node-set, node-set)

-
-
nodes1:  a node-set
-
nodes2:  a node-set
-
Returns :the difference between the two node sets, or nodes1 if
-        nodes2 is empty
-
xmlXPathIntersection ()
xmlNodeSetPtr xmlXPathIntersection          (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);

-Implements the EXSLT - Sets intersection() function:
-   node-set set:intersection (node-set, node-set)

-
-
nodes1:  a node-set
-
nodes2:  a node-set
-
Returns :a node set comprising the nodes that are within both the
-        node sets passed as arguments
-
xmlXPathDistinctSorted ()
xmlNodeSetPtr xmlXPathDistinctSorted        (xmlNodeSetPtr nodes);

-Implements the EXSLT - Sets distinct() function:
-   node-set set:distinct (node-set)

-
-
nodes:  a node-set, sorted by document order
-
Returns :a subset of the nodes contained in nodes, or nodes if
-        it is empty
-
xmlXPathDistinct ()
xmlNodeSetPtr xmlXPathDistinct              (xmlNodeSetPtr nodes);

-Implements the EXSLT - Sets distinct() function:
-   node-set set:distinct (node-set)
-nodes is sorted by document order, then exslSetsDistinctSorted
-is called with the sorted node-set

-
-
nodes:  a node-set
-
Returns :a subset of the nodes contained in nodes, or nodes if
-        it is empty
-
xmlXPathHasSameNodes ()
int         xmlXPathHasSameNodes            (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);

-Implements the EXSLT - Sets has-same-nodes function:
-   boolean set:has-same-node(node-set, node-set)

-
-
nodes1:  a node-set
-
nodes2:  a node-set
-
Returns :true (1) if nodes1 shares any node with nodes2, false (0)
-        otherwise
-
xmlXPathNodeLeadingSorted ()
xmlNodeSetPtr xmlXPathNodeLeadingSorted     (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);

-Implements the EXSLT - Sets leading() function:
-   node-set set:leading (node-set, node-set)

-
-
nodes: a node-set, sorted by document order
-
node: a node
-
Returns :the nodes in nodes that precede node in document order,
-        nodes if node is NULL or an empty node-set if nodes
-        doesn't contain node
-
xmlXPathLeadingSorted ()
xmlNodeSetPtr xmlXPathLeadingSorted         (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);

-Implements the EXSLT - Sets leading() function:
-   node-set set:leading (node-set, node-set)

-
-
nodes1:  a node-set, sorted by document order
-
nodes2:  a node-set, sorted by document order
-
Returns :the nodes in nodes1 that precede the first node in nodes2
-        in document order, nodes1 if nodes2 is NULL or empty or
-        an empty node-set if nodes1 doesn't contain nodes2
-
xmlXPathNodeLeading ()
xmlNodeSetPtr xmlXPathNodeLeading           (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);

-Implements the EXSLT - Sets leading() function:
-   node-set set:leading (node-set, node-set)
-nodes is sorted by document order, then exslSetsNodeLeadingSorted
-is called.

-
-
nodes:  a node-set
-
node:  a node
-
Returns :the nodes in nodes that precede node in document order,
-        nodes if node is NULL or an empty node-set if nodes
-        doesn't contain node
-
xmlXPathLeading ()
xmlNodeSetPtr xmlXPathLeading               (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);

-Implements the EXSLT - Sets leading() function:
-   node-set set:leading (node-set, node-set)
-nodes1 and nodes2 are sorted by document order, then
-exslSetsLeadingSorted is called.

-
-
nodes1:  a node-set
-
nodes2:  a node-set
-
Returns :the nodes in nodes1 that precede the first node in nodes2
-        in document order, nodes1 if nodes2 is NULL or empty or
-        an empty node-set if nodes1 doesn't contain nodes2
-
xmlXPathNodeTrailingSorted ()
xmlNodeSetPtr xmlXPathNodeTrailingSorted    (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);

-Implements the EXSLT - Sets trailing() function:
-   node-set set:trailing (node-set, node-set)

-
-
nodes: a node-set, sorted by document order
-
node: a node
-
Returns :the nodes in nodes that follow node in document order,
-        nodes if node is NULL or an empty node-set if nodes
-        doesn't contain node
-
xmlXPathTrailingSorted ()
xmlNodeSetPtr xmlXPathTrailingSorted        (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);

-Implements the EXSLT - Sets trailing() function:
-   node-set set:trailing (node-set, node-set)

-
-
nodes1:  a node-set, sorted by document order
-
nodes2:  a node-set, sorted by document order
-
Returns :the nodes in nodes1 that follow the first node in nodes2
-        in document order, nodes1 if nodes2 is NULL or empty or
-        an empty node-set if nodes1 doesn't contain nodes2
-
xmlXPathNodeTrailing ()
xmlNodeSetPtr xmlXPathNodeTrailing          (xmlNodeSetPtr nodes,
-                                             xmlNodePtr node);

-Implements the EXSLT - Sets trailing() function:
-   node-set set:trailing (node-set, node-set)
-nodes is sorted by document order, then xmlXPathNodeTrailingSorted
-is called.

-
-
nodes:  a node-set
-
node:  a node
-
Returns :the nodes in nodes that follow node in document order,
-        nodes if node is NULL or an empty node-set if nodes
-        doesn't contain node
-
xmlXPathTrailing ()
xmlNodeSetPtr xmlXPathTrailing              (xmlNodeSetPtr nodes1,
-                                             xmlNodeSetPtr nodes2);

-Implements the EXSLT - Sets trailing() function:
-   node-set set:trailing (node-set, node-set)
-nodes1 and nodes2 are sorted by document order, then
-xmlXPathTrailingSorted is called.

-
-
nodes1:  a node-set
-
nodes2:  a node-set
-
Returns :the nodes in nodes1 that follow the first node in nodes2
-        in document order, nodes1 if nodes2 is NULL or empty or
-        an empty node-set if nodes1 doesn't contain nodes2
-
xmlXPathRegisterNs ()
int         xmlXPathRegisterNs              (xmlXPathContextPtr ctxt,
-                                             const xmlChar *prefix,
-                                             const xmlChar *ns_uri);

-Register a new namespace. If ns_uri is NULL it unregisters
-the namespace

-
-
ctxt:  the XPath context
-
prefix:  the namespace prefix
-
ns_uri:  the namespace name
-
Returns :0 in case of success, -1 in case of error
-
xmlXPathNsLookup ()
const xmlChar* xmlXPathNsLookup             (xmlXPathContextPtr ctxt,
-                                             const xmlChar *prefix);

-Search in the namespace declaration array of the context for the given
-namespace name associated to the given prefix

-
-
ctxt:  the XPath context
-
prefix:  the namespace prefix value
-
Returns :the value or NULL if not found
-
xmlXPathRegisteredNsCleanup ()
void        xmlXPathRegisteredNsCleanup     (xmlXPathContextPtr ctxt);

-Cleanup the XPath context data associated to registered variables

-
-
ctxt:  the XPath context
-
xmlXPathRegisterFunc ()
int         xmlXPathRegisterFunc            (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlXPathFunction f);

-Register a new function. If f is NULL it unregisters the function

-
-
ctxt:  the XPath context
-
name:  the function name
-
f:  the function implementation or NULL
-
Returns :0 in case of success, -1 in case of error
-
xmlXPathRegisterFuncNS ()
int         xmlXPathRegisterFuncNS          (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri,
-                                             xmlXPathFunction f);

-Register a new function. If f is NULL it unregisters the function

-
-
ctxt:  the XPath context
-
name:  the function name
-
ns_uri:  the function namespace URI
-
f:  the function implementation or NULL
-
Returns :0 in case of success, -1 in case of error
-
xmlXPathRegisterVariable ()
int         xmlXPathRegisterVariable        (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             xmlXPathObjectPtr value);

-Register a new variable value. If value is NULL it unregisters
-the variable

-
-
ctxt:  the XPath context
-
name:  the variable name
-
value:  the variable value or NULL
-
Returns :0 in case of success, -1 in case of error
-
xmlXPathRegisterVariableNS ()
int         xmlXPathRegisterVariableNS      (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri,
-                                             xmlXPathObjectPtr value);

-Register a new variable value. If value is NULL it unregisters
-the variable

-
-
ctxt:  the XPath context
-
name:  the variable name
-
ns_uri:  the variable namespace URI
-
value:  the variable value or NULL
-
Returns :0 in case of success, -1 in case of error
-
xmlXPathFunctionLookup ()
xmlXPathFunction xmlXPathFunctionLookup     (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name);

-Search in the Function array of the context for the given
-function.

-
-
ctxt:  the XPath context
-
name:  the function name
-
Returns :the xmlXPathFunction or NULL if not found
-
xmlXPathFunctionLookupNS ()
xmlXPathFunction xmlXPathFunctionLookupNS   (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);

-Search in the Function array of the context for the given
-function.

-
-
ctxt:  the XPath context
-
name:  the function name
-
ns_uri:  the function namespace URI
-
Returns :the xmlXPathFunction or NULL if not found
-
xmlXPathRegisteredFuncsCleanup ()
void        xmlXPathRegisteredFuncsCleanup  (xmlXPathContextPtr ctxt);

-Cleanup the XPath context data associated to registered functions

-
-
ctxt:  the XPath context
-
xmlXPathVariableLookup ()
xmlXPathObjectPtr xmlXPathVariableLookup    (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name);

-Search in the Variable array of the context for the given
-variable value.

-
-
ctxt:  the XPath context
-
name:  the variable name
-
Returns :a copy of the value or NULL if not found
-
xmlXPathVariableLookupNS ()
xmlXPathObjectPtr xmlXPathVariableLookupNS  (xmlXPathContextPtr ctxt,
-                                             const xmlChar *name,
-                                             const xmlChar *ns_uri);

-Search in the Variable array of the context for the given
-variable value.

-
-
ctxt:  the XPath context
-
name:  the variable name
-
ns_uri:  the variable namespace URI
-
Returns :the a copy of the value or NULL if not found
-
xmlXPathRegisteredVariablesCleanup ()
void        xmlXPathRegisteredVariablesCleanup
-                                            (xmlXPathContextPtr ctxt);

-Cleanup the XPath context data associated to registered variables

-
-
ctxt:  the XPath context
-
xmlXPathNewParserContext ()
xmlXPathParserContextPtr xmlXPathNewParserContext
-                                            (const xmlChar *str,
-                                             xmlXPathContextPtr ctxt);

-Create a new xmlXPathParserContext

-
-
str:  the XPath expression
-
ctxt:  the XPath context
-
Returns :the xmlXPathParserContext just allocated.
-
xmlXPathFreeParserContext ()
void        xmlXPathFreeParserContext       (xmlXPathParserContextPtr ctxt);

-Free up an xmlXPathParserContext

-
-
ctxt:  the context to free
-
valuePop ()
xmlXPathObjectPtr valuePop                  (xmlXPathParserContextPtr ctxt);

-Pops the top XPath object from the value stack

-
-
ctxt: an XPath evaluation context
-
Returns :the XPath object just removed
-
valuePush ()
int         valuePush                       (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr value);

-Pushes a new XPath object on top of the value stack

-
-
ctxt:  an XPath evaluation context
-
value:  the XPath object
-
Returns :the number of items on the value stack
-
xmlXPathNewString ()
xmlXPathObjectPtr xmlXPathNewString         (const xmlChar *val);

-Create a new xmlXPathObjectPtr of type string and of value val

-
-
val:  the xmlChar * value
-
Returns :the newly created object.
-
xmlXPathNewCString ()
xmlXPathObjectPtr xmlXPathNewCString        (const char *val);

-Create a new xmlXPathObjectPtr of type string and of value val

-
-
val:  the char * value
-
Returns :the newly created object.
-
xmlXPathWrapString ()
xmlXPathObjectPtr xmlXPathWrapString        (xmlChar *val);

-Wraps the val string into an XPath object.

-
-
val:  the xmlChar * value
-
Returns :the newly created object.
-
xmlXPathWrapCString ()
xmlXPathObjectPtr xmlXPathWrapCString       (char *val);

-Wraps a string into an XPath object.

-
-
val:  the char * value
-
Returns :the newly created object.
-
xmlXPathNewFloat ()
xmlXPathObjectPtr xmlXPathNewFloat          (double val);

-Create a new xmlXPathObjectPtr of type double and of value val

-
-
val:  the double value
-
Returns :the newly created object.
-
xmlXPathNewBoolean ()
xmlXPathObjectPtr xmlXPathNewBoolean        (int val);

-Create a new xmlXPathObjectPtr of type boolean and of value val

-
-
val:  the boolean value
-
Returns :the newly created object.
-
xmlXPathNewNodeSet ()
xmlXPathObjectPtr xmlXPathNewNodeSet        (xmlNodePtr val);

-Create a new xmlXPathObjectPtr of type NodeSet and initialize
-it with the single Node val

-
-
val:  the NodePtr value
-
Returns :the newly created object.
-
xmlXPathNewValueTree ()
xmlXPathObjectPtr xmlXPathNewValueTree      (xmlNodePtr val);

-Create a new xmlXPathObjectPtr of type Value Tree (XSLT) and initialize
-it with the tree root val

-
-
val:  the NodePtr value
-
Returns :the newly created object.
-
xmlXPathNodeSetAdd ()
void        xmlXPathNodeSetAdd              (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);

-add a new xmlNodePtr to an existing NodeSet

-
-
cur:  the initial node set
-
val:  a new xmlNodePtr
-
xmlXPathNodeSetAddUnique ()
void        xmlXPathNodeSetAddUnique        (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);

-add a new xmlNodePtr to an existing NodeSet, optimized version
-when we are sure the node is not already in the set.

-
-
cur:  the initial node set
-
val:  a new xmlNodePtr
-
xmlXPathNodeSetAddNs ()
void        xmlXPathNodeSetAddNs            (xmlNodeSetPtr cur,
-                                             xmlNodePtr node,
-                                             xmlNsPtr ns);

-add a new namespace node to an existing NodeSet

-
-
cur:  the initial node set
-
node:  the hosting node
-
ns:  a the namespace node
-
xmlXPathNodeSetSort ()
void        xmlXPathNodeSetSort             (xmlNodeSetPtr set);

-Sort the node set in document order

-
-
set:  the node set
-
xmlXPathRoot ()
void        xmlXPathRoot                    (xmlXPathParserContextPtr ctxt);

-Initialize the context to the root of the document

-
-
ctxt:  the XPath Parser context
-
xmlXPathEvalExpr ()
void        xmlXPathEvalExpr                (xmlXPathParserContextPtr ctxt);

-Parse and evaluate an XPath expression in the given context,
-then push the result on the context stack

-
-
ctxt:  the XPath Parser context
-
xmlXPathParseName ()
xmlChar*    xmlXPathParseName               (xmlXPathParserContextPtr ctxt);

-parse an XML name
-

-[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
-                 CombiningChar | Extender
-

-[5] Name ::= (Letter | '_' | ':') (NameChar)*

-
-
ctxt:  the XPath Parser context
-
Returns :the namespace name or NULL
-
xmlXPathParseNCName ()
xmlChar*    xmlXPathParseNCName             (xmlXPathParserContextPtr ctxt);

-parse an XML namespace non qualified name.
-

-[NS 3] NCName ::= (Letter | '_') (NCNameChar)*
-

-[NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' |
-                      CombiningChar | Extender

-
-
ctxt:  the XPath Parser context
-
Returns :the namespace name or NULL
-
xmlXPathStringEvalNumber ()
double      xmlXPathStringEvalNumber        (const xmlChar *str);

-[30a]  Float  ::= Number ('e' Digits?)?
-

- [30]   Number ::=   Digits ('.' Digits?)?
-                   | '.' Digits 
- [31]   Digits ::=   [0-9]+
-

-Compile a Number in the string
-In complement of the Number expression, this function also handles
-negative values : '-' Number.

-
-
str:  A string to scan
-
Returns :the double value.
-
xmlXPathEvaluatePredicateResult ()
int         xmlXPathEvaluatePredicateResult (xmlXPathParserContextPtr ctxt,
-                                             xmlXPathObjectPtr res);

-Evaluate a predicate result for the current node.
-A PredicateExpr is evaluated by evaluating the Expr and converting
-the result to a boolean. If the result is a number, the result will
-be converted to true if the number is equal to the position of the
-context node in the context node list (as returned by the position
-function) and will be converted to false otherwise; if the result
-is not a number, then the result will be converted as if by a call
-to the boolean function.

-
-
ctxt:  the XPath Parser context
-
res:  the Predicate Expression evaluation result
-
Returns :1 if predicate is true, 0 otherwise
-
xmlXPathRegisterAllFunctions ()
void        xmlXPathRegisterAllFunctions    (xmlXPathContextPtr ctxt);

-Registers all default XPath functions in this context

-
-
ctxt:  the XPath context
-
xmlXPathNodeSetMerge ()
xmlNodeSetPtr xmlXPathNodeSetMerge          (xmlNodeSetPtr val1,
-                                             xmlNodeSetPtr val2);

-Merges two nodesets, all nodes from val2 are added to val1
-if val1 is NULL, a new set is created and copied from val2

-
-
val1:  the first NodeSet or NULL
-
val2:  the second NodeSet
-
Returns :val1 once extended or NULL in case of error.
-
xmlXPathNodeSetDel ()
void        xmlXPathNodeSetDel              (xmlNodeSetPtr cur,
-                                             xmlNodePtr val);

-Removes an xmlNodePtr from an existing NodeSet

-
-
cur:  the initial node set
-
val:  an xmlNodePtr
-
xmlXPathNodeSetRemove ()
void        xmlXPathNodeSetRemove           (xmlNodeSetPtr cur,
-                                             int val);

-Removes an entry from an existing NodeSet list.

-
-
cur:  the initial node set
-
val:  the index to remove
-
xmlXPathNewNodeSetList ()
xmlXPathObjectPtr xmlXPathNewNodeSetList    (xmlNodeSetPtr val);

-Create a new xmlXPathObjectPtr of type NodeSet and initialize
-it with the Nodeset val

-
-
val:  an existing NodeSet
-
Returns :the newly created object.
-
xmlXPathWrapNodeSet ()
xmlXPathObjectPtr xmlXPathWrapNodeSet       (xmlNodeSetPtr val);

-Wrap the Nodeset val in a new xmlXPathObjectPtr

-
-
val:  the NodePtr value
-
Returns :the newly created object.
-
xmlXPathWrapExternal ()
xmlXPathObjectPtr xmlXPathWrapExternal      (void *val);

-Wraps the val data into an XPath object.

-
-
val:  the user data
-
Returns :the newly created object.
-
xmlXPathEqualValues ()
int         xmlXPathEqualValues             (xmlXPathParserContextPtr ctxt);

-Implement the equal operation on XPath objects content: arg1 == arg2

-
-
ctxt:  the XPath Parser context
-
Returns :0 or 1 depending on the results of the test.
-
xmlXPathNotEqualValues ()
int         xmlXPathNotEqualValues          (xmlXPathParserContextPtr ctxt);

-Implement the equal operation on XPath objects content: arg1 == arg2

-
-
ctxt:  the XPath Parser context
-
Returns :0 or 1 depending on the results of the test.
-
xmlXPathCompareValues ()
int         xmlXPathCompareValues           (xmlXPathParserContextPtr ctxt,
-                                             int inf,
-                                             int strict);

-Implement the compare operation on XPath objects: 
-    arg1 < arg2    (1, 1, ...
-    arg1 <= arg2   (1, 0, ...
-    arg1 > arg2    (0, 1, ...
-    arg1 >= arg2   (0, 0, ...
-

-When neither object to be compared is a node-set and the operator is
-<=, <, >=, >, then the objects are compared by converted both objects
-to numbers and comparing the numbers according to IEEE 754. The <
-comparison will be true if and only if the first number is less than the
-second number. The <= comparison will be true if and only if the first
-number is less than or equal to the second number. The > comparison
-will be true if and only if the first number is greater than the second
-number. The >= comparison will be true if and only if the first number
-is greater than or equal to the second number.

-
-
ctxt:  the XPath Parser context
-
inf:  less than (1) or greater than (0)
-
strict:  is the comparison strict
-
Returns :1 if the comparison succeeded, 0 if it failed
-
xmlXPathValueFlipSign ()
void        xmlXPathValueFlipSign           (xmlXPathParserContextPtr ctxt);

-Implement the unary - operation on an XPath object
-The numeric operators convert their operands to numbers as if
-by calling the number function.

-
-
ctxt:  the XPath Parser context
-
xmlXPathAddValues ()
void        xmlXPathAddValues               (xmlXPathParserContextPtr ctxt);

-Implement the add operation on XPath objects:
-The numeric operators convert their operands to numbers as if
-by calling the number function.

-
-
ctxt:  the XPath Parser context
-
xmlXPathSubValues ()
void        xmlXPathSubValues               (xmlXPathParserContextPtr ctxt);

-Implement the subtraction operation on XPath objects:
-The numeric operators convert their operands to numbers as if
-by calling the number function.

-
-
ctxt:  the XPath Parser context
-
xmlXPathMultValues ()
void        xmlXPathMultValues              (xmlXPathParserContextPtr ctxt);

-Implement the multiply operation on XPath objects:
-The numeric operators convert their operands to numbers as if
-by calling the number function.

-
-
ctxt:  the XPath Parser context
-
xmlXPathDivValues ()
void        xmlXPathDivValues               (xmlXPathParserContextPtr ctxt);

-Implement the div operation on XPath objects arg1 / arg2:
-The numeric operators convert their operands to numbers as if
-by calling the number function.

-
-
ctxt:  the XPath Parser context
-
xmlXPathModValues ()
void        xmlXPathModValues               (xmlXPathParserContextPtr ctxt);

-Implement the mod operation on XPath objects: arg1 / arg2
-The numeric operators convert their operands to numbers as if
-by calling the number function.

-
-
ctxt:  the XPath Parser context
-
xmlXPathIsNodeType ()
int         xmlXPathIsNodeType              (const xmlChar *name);

-Is the name given a NodeType one.
-

- [38]   NodeType ::=   'comment'
-                   | 'text'
-                   | 'processing-instruction'
-                   | 'node'

-
-
name:  a name string
-
Returns :1 if true 0 otherwise
-
xmlXPathNextSelf ()
xmlNodePtr  xmlXPathNextSelf                (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "self" direction
-The self axis contains just the context node itself

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextChild ()
xmlNodePtr  xmlXPathNextChild               (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "child" direction
-The child axis contains the children of the context node in document order.

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextDescendant ()
xmlNodePtr  xmlXPathNextDescendant          (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "descendant" direction
-the descendant axis contains the descendants of the context node in document
-order; a descendant is a child or a child of a child and so on.

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextDescendantOrSelf ()
xmlNodePtr  xmlXPathNextDescendantOrSelf    (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "descendant-or-self" direction
-the descendant-or-self axis contains the context node and the descendants
-of the context node in document order; thus the context node is the first
-node on the axis, and the first child of the context node is the second node
-on the axis

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextParent ()
xmlNodePtr  xmlXPathNextParent              (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "parent" direction
-The parent axis contains the parent of the context node, if there is one.

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextAncestorOrSelf ()
xmlNodePtr  xmlXPathNextAncestorOrSelf      (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "ancestor-or-self" direction
-he ancestor-or-self axis contains the context node and ancestors of
-the context node in reverse document order; thus the context node is
-the first node on the axis, and the context node's parent the second;
-parent here is defined the same as with the parent axis.

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextFollowingSibling ()
xmlNodePtr  xmlXPathNextFollowingSibling    (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "following-sibling" direction
-The following-sibling axis contains the following siblings of the context
-node in document order.

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextFollowing ()
xmlNodePtr  xmlXPathNextFollowing           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "following" direction
-The following axis contains all nodes in the same document as the context
-node that are after the context node in document order, excluding any
-descendants and excluding attribute nodes and namespace nodes; the nodes
-are ordered in document order

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextNamespace ()
xmlNodePtr  xmlXPathNextNamespace           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "namespace" direction
-the namespace axis contains the namespace nodes of the context node;
-the order of nodes on this axis is implementation-defined; the axis will
-be empty unless the context node is an element
-

-We keep the XML namespace node at the end of the list.

-
-
ctxt:  the XPath Parser context
-
cur:  the current attribute in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextAttribute ()
xmlNodePtr  xmlXPathNextAttribute           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "attribute" direction
-TODO: support DTD inherited default attributes

-
-
ctxt:  the XPath Parser context
-
cur:  the current attribute in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextPreceding ()
xmlNodePtr  xmlXPathNextPreceding           (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "preceding" direction
-the preceding axis contains all nodes in the same document as the context
-node that are before the context node in document order, excluding any
-ancestors and excluding attribute nodes and namespace nodes; the nodes are
-ordered in reverse document order

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextAncestor ()
xmlNodePtr  xmlXPathNextAncestor            (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "ancestor" direction
-the ancestor axis contains the ancestors of the context node; the ancestors
-of the context node consist of the parent of context node and the parent's
-parent and so on; the nodes are ordered in reverse document order; thus the
-parent is the first node on the axis, and the parent's parent is the second
-node on the axis

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathNextPrecedingSibling ()
xmlNodePtr  xmlXPathNextPrecedingSibling    (xmlXPathParserContextPtr ctxt,
-                                             xmlNodePtr cur);

-Traversal function for the "preceding-sibling" direction
-The preceding-sibling axis contains the preceding siblings of the context
-node in reverse document order; the first preceding sibling is first on the
-axis; the sibling preceding that node is the second on the axis and so on.

-
-
ctxt:  the XPath Parser context
-
cur:  the current node in the traversal
-
Returns :the next element following that axis
-
xmlXPathLastFunction ()
void        xmlXPathLastFunction            (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the last() XPath function
-   number last()
-The last function returns the number of nodes in the context node list.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathPositionFunction ()
void        xmlXPathPositionFunction        (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the position() XPath function
-   number position()
-The position function returns the position of the context node in the
-context node list. The first position is 1, and so the last position
-will be equal to last().

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathCountFunction ()
void        xmlXPathCountFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the count() XPath function
-   number count(node-set)

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathIdFunction ()
void        xmlXPathIdFunction              (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the id() XPath function
-   node-set id(object)
-The id function selects elements by their unique ID
-(see [5.2.1 Unique IDs]). When the argument to id is of type node-set,
-then the result is the union of the result of applying id to the
-string value of each of the nodes in the argument node-set. When the
-argument to id is of any other type, the argument is converted to a
-string as if by a call to the string function; the string is split
-into a whitespace-separated list of tokens (whitespace is any sequence
-of characters matching the production S); the result is a node-set
-containing the elements in the same document as the context node that
-have a unique ID equal to any of the tokens in the list.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathLocalNameFunction ()
void        xmlXPathLocalNameFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the local-name() XPath function
-   string local-name(node-set?)
-The local-name function returns a string containing the local part
-of the name of the node in the argument node-set that is first in
-document order. If the node-set is empty or the first node has no
-name, an empty string is returned. If the argument is omitted it
-defaults to the context node.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathNamespaceURIFunction ()
void        xmlXPathNamespaceURIFunction    (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the namespace-uri() XPath function
-   string namespace-uri(node-set?)
-The namespace-uri function returns a string containing the
-namespace URI of the expanded name of the node in the argument
-node-set that is first in document order. If the node-set is empty,
-the first node has no name, or the expanded name has no namespace
-URI, an empty string is returned. If the argument is omitted it
-defaults to the context node.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathStringFunction ()
void        xmlXPathStringFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the string() XPath function
-   string string(object?)
-he string function converts an object to a string as follows:
-   - A node-set is converted to a string by returning the value of
-     the node in the node-set that is first in document order.
-     If the node-set is empty, an empty string is returned.
-   - A number is converted to a string as follows
-     + NaN is converted to the string NaN 
-     + positive zero is converted to the string 0 
-     + negative zero is converted to the string 0 
-     + positive infinity is converted to the string Infinity 
-     + negative infinity is converted to the string -Infinity 
-     + if the number is an integer, the number is represented in
-       decimal form as a Number with no decimal point and no leading
-       zeros, preceded by a minus sign (-) if the number is negative
-     + otherwise, the number is represented in decimal form as a
-       Number including a decimal point with at least one digit
-       before the decimal point and at least one digit after the
-       decimal point, preceded by a minus sign (-) if the number
-       is negative; there must be no leading zeros before the decimal
-       point apart possibly from the one required digit immediately
-       before the decimal point; beyond the one required digit
-       after the decimal point there must be as many, but only as
-       many, more digits as are needed to uniquely distinguish the
-       number from all other IEEE 754 numeric values.
-   - The boolean false value is converted to the string false.
-     The boolean true value is converted to the string true.
-

-If the argument is omitted, it defaults to a node-set with the
-context node as its only member.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathStringLengthFunction ()
void        xmlXPathStringLengthFunction    (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the string-length() XPath function
-   number string-length(string?)
-The string-length returns the number of characters in the string
-(see [3.6 Strings]). If the argument is omitted, it defaults to
-the context node converted to a string, in other words the value
-of the context node.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathConcatFunction ()
void        xmlXPathConcatFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the concat() XPath function
-   string concat(string, string, string*)
-The concat function returns the concatenation of its arguments.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathContainsFunction ()
void        xmlXPathContainsFunction        (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the contains() XPath function
-   boolean contains(string, string)
-The contains function returns true if the first argument string
-contains the second argument string, and otherwise returns false.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathStartsWithFunction ()
void        xmlXPathStartsWithFunction      (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the starts-with() XPath function
-   boolean starts-with(string, string)
-The starts-with function returns true if the first argument string
-starts with the second argument string, and otherwise returns false.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathSubstringFunction ()
void        xmlXPathSubstringFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the substring() XPath function
-   string substring(string, number, number?)
-The substring function returns the substring of the first argument
-starting at the position specified in the second argument with
-length specified in the third argument. For example,
-substring("12345",2,3) returns "234". If the third argument is not
-specified, it returns the substring starting at the position specified
-in the second argument and continuing to the end of the string. For
-example, substring("12345",2) returns "2345".  More precisely, each
-character in the string (see [3.6 Strings]) is considered to have a
-numeric position: the position of the first character is 1, the position
-of the second character is 2 and so on. The returned substring contains
-those characters for which the position of the character is greater than
-or equal to the second argument and, if the third argument is specified,
-less than the sum of the second and third arguments; the comparisons
-and addition used for the above follow the standard IEEE 754 rules. Thus:
- - substring("12345", 1.5, 2.6) returns "234" 
- - substring("12345", 0, 3) returns "12" 
- - substring("12345", 0 div 0, 3) returns "" 
- - substring("12345", 1, 0 div 0) returns "" 
- - substring("12345", -42, 1 div 0) returns "12345" 
- - substring("12345", -1 div 0, 1 div 0) returns ""

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathSubstringBeforeFunction ()
void        xmlXPathSubstringBeforeFunction (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the substring-before() XPath function
-   string substring-before(string, string)
-The substring-before function returns the substring of the first
-argument string that precedes the first occurrence of the second
-argument string in the first argument string, or the empty string
-if the first argument string does not contain the second argument
-string. For example, substring-before("1999/04/01","/") returns 1999.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathSubstringAfterFunction ()
void        xmlXPathSubstringAfterFunction  (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the substring-after() XPath function
-   string substring-after(string, string)
-The substring-after function returns the substring of the first
-argument string that follows the first occurrence of the second
-argument string in the first argument string, or the empty stringi
-if the first argument string does not contain the second argument
-string. For example, substring-after("1999/04/01","/") returns 04/01,
-and substring-after("1999/04/01","19") returns 99/04/01.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathNormalizeFunction ()
void        xmlXPathNormalizeFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the normalize-space() XPath function
-   string normalize-space(string?)
-The normalize-space function returns the argument string with white
-space normalized by stripping leading and trailing whitespace
-and replacing sequences of whitespace characters by a single
-space. Whitespace characters are the same allowed by the S production
-in XML. If the argument is omitted, it defaults to the context
-node converted to a string, in other words the value of the context node.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathTranslateFunction ()
void        xmlXPathTranslateFunction       (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the translate() XPath function
-   string translate(string, string, string)
-The translate function returns the first argument string with
-occurrences of characters in the second argument string replaced
-by the character at the corresponding position in the third argument
-string. For example, translate("bar","abc","ABC") returns the string
-BAr. If there is a character in the second argument string with no
-character at a corresponding position in the third argument string
-(because the second argument string is longer than the third argument
-string), then occurrences of that character in the first argument
-string are removed. For example, translate("--aaa--","abc-","ABC")

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathNotFunction ()
void        xmlXPathNotFunction             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the not() XPath function
-   boolean not(boolean)
-The not function returns true if its argument is false,
-and false otherwise.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathTrueFunction ()
void        xmlXPathTrueFunction            (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the true() XPath function
-   boolean true()

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathFalseFunction ()
void        xmlXPathFalseFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the false() XPath function
-   boolean false()

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathLangFunction ()
void        xmlXPathLangFunction            (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the lang() XPath function
-   boolean lang(string)
-The lang function returns true or false depending on whether the
-language of the context node as specified by xml:lang attributes
-is the same as or is a sublanguage of the language specified by
-the argument string. The language of the context node is determined
-by the value of the xml:lang attribute on the context node, or, if
-the context node has no xml:lang attribute, by the value of the
-xml:lang attribute on the nearest ancestor of the context node that
-has an xml:lang attribute. If there is no such attribute, then lang

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathNumberFunction ()
void        xmlXPathNumberFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the number() XPath function
-   number number(object?)

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathSumFunction ()
void        xmlXPathSumFunction             (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the sum() XPath function
-   number sum(node-set)
-The sum function returns the sum of the values of the nodes in
-the argument node-set.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathFloorFunction ()
void        xmlXPathFloorFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the floor() XPath function
-   number floor(number)
-The floor function returns the largest (closest to positive infinity)
-number that is not greater than the argument and that is an integer.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathCeilingFunction ()
void        xmlXPathCeilingFunction         (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the ceiling() XPath function
-   number ceiling(number)
-The ceiling function returns the smallest (closest to negative infinity)
-number that is not less than the argument and that is an integer.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathRoundFunction ()
void        xmlXPathRoundFunction           (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the round() XPath function
-   number round(number)
-The round function returns the number that is closest to the
-argument and that is an integer. If there are two such numbers,
-then the one that is even is returned.

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathBooleanFunction ()
void        xmlXPathBooleanFunction         (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the boolean() XPath function
-   boolean boolean(object)
-he boolean function converts its argument to a boolean as follows:
-   - a number is true if and only if it is neither positive or
-     negative zero nor NaN
-   - a node-set is true if and only if it is non-empty
-   - a string is true if and only if its length is non-zero

-
-
ctxt:  the XPath Parser context
-
nargs:  the number of arguments
-
xmlXPathNodeSetFreeNs ()
void        xmlXPathNodeSetFreeNs           (xmlNsPtr ns);

-Namespace node in libxml don't match the XPath semantic. In a node set
-the namespace nodes are duplicated and the next pointer is set to the
-parent node in the XPath semantic. Check if such a node need to be freed

-
-
ns:  the XPath namespace node found in a nodeset.
-
<< relaxngxmlversion >>

+
+
+Module xpathInternals from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xpathInternals from libxml2
Main Menu
Related links
Table of Contents
xmlNodeSetPtr	xmlXPathNodeSetMerge	(xmlNodeSetPtr val1, 
				 xmlNodeSetPtr val2)

+
void	xmlXPathRoundFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
#define CAST_TO_NUMBER
+
+
void	xmlXPathNumberFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
int	xmlXPathNotEqualValues	(xmlXPathParserContextPtr ctxt)

+
#define xmlXPathStackIsNodeSet
+
+
const xmlChar *	xmlXPathNsLookup	(xmlXPathContextPtr ctxt, 
				 const xmlChar * prefix)

+
void	xmlXPathCountFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
xmlChar *	xmlXPathParseNCName	(xmlXPathParserContextPtr ctxt)

+
xmlXPathObjectPtr	xmlXPathNewNodeSet	(xmlNodePtr val)

+
#define xmlXPathReturnNumber
+
+
xmlXPathObjectPtr	xmlXPathVariableLookupNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri)

+
xmlNodePtr	xmlXPathNextAncestorOrSelf	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
xmlXPathObjectPtr	xmlXPathNewBoolean	(int val)

+
void	xmlXPathNodeSetRemove	(xmlNodeSetPtr cur, 
				 int val)

+
void	xmlXPathSubValues	(xmlXPathParserContextPtr ctxt)

+
xmlXPathObjectPtr	xmlXPathNewNodeSetList	(xmlNodeSetPtr val)

+
int	xmlXPathPopBoolean	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPathNotFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
int	xmlXPathEqualValues	(xmlXPathParserContextPtr ctxt)

+
#define xmlXPathGetContextNode
+
+
xmlXPathObjectPtr	xmlXPathNewString	(const xmlChar * val)

+
xmlNodeSetPtr	xmlXPathTrailingSorted	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
void	xmlXPathMultValues	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPathModValues	(xmlXPathParserContextPtr ctxt)

+
xmlNodeSetPtr	xmlXPathNodeLeadingSorted	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
int	xmlXPathEvaluatePredicateResult	(xmlXPathParserContextPtr ctxt, 
				 xmlXPathObjectPtr res)

+
#define CHECK_ARITY
+
+
xmlNodePtr	xmlXPathNextChild	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
#define CAST_TO_STRING
+
+
#define xmlXPathReturnExternal
+
+
xmlNodePtr	xmlXPathNextFollowingSibling	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
void	xmlXPathBooleanFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
xmlXPathParserContextPtr	xmlXPathNewParserContext	(const xmlChar * str, 
				 xmlXPathContextPtr ctxt)

+
void	xmlXPathNamespaceURIFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathSubstringAfterFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathRoot	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPathLangFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
#define CHECK_TYPE0
+
+
int	xmlXPathCompareValues	(xmlXPathParserContextPtr ctxt, 
				 int inf, 
				 int strict)

+
xmlNodeSetPtr	xmlXPathPopNodeSet	(xmlXPathParserContextPtr ctxt)

+
#define xmlXPathCheckError
+
+
void	xmlXPathConcatFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathNodeSetAddNs	(xmlNodeSetPtr cur, 
				 xmlNodePtr node, 
				 xmlNsPtr ns)

+
int	xmlXPathRegisterFunc	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 xmlXPathFunction f)

+
int	xmlXPathNodeSetContains	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
int	xmlXPathRegisterFuncNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri, 
				 xmlXPathFunction f)

+
void	xmlXPatherror	(xmlXPathParserContextPtr ctxt, 
				 const char * file, 
				 int line, 
				 int no)

+
xmlNodePtr	xmlXPathNextAncestor	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
xmlNodePtr	xmlXPathNextFollowing	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
int	xmlXPathRegisterVariableNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri, 
				 xmlXPathObjectPtr value)

+
#define CAST_TO_BOOLEAN
+
+
int	xmlXPathIsNodeType	(const xmlChar * name)

+
xmlChar *	xmlXPathPopString	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPathLocalNameFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathAddValues	(xmlXPathParserContextPtr ctxt)

+
xmlNodeSetPtr	xmlXPathDifference	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
int	xmlXPathRegisterVariable	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 xmlXPathObjectPtr value)

+
xmlXPathObjectPtr	valuePop	(xmlXPathParserContextPtr ctxt)

+
#define CHECK_ERROR0
+
+
void	xmlXPathCeilingFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
xmlNodeSetPtr	xmlXPathIntersection	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
xmlNodeSetPtr	xmlXPathLeadingSorted	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
#define xmlXPathReturnFalse
+
+
void	xmlXPathContainsFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
xmlNodePtr	xmlXPathNextPrecedingSibling	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
void	xmlXPathNodeSetSort	(xmlNodeSetPtr set)

+
void	xmlXPathStartsWithFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void *	xmlXPathPopExternal	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPathNormalizeFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
xmlNodeSetPtr	xmlXPathNodeLeading	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
void	xmlXPathSumFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathRegisterVariableLookup	(xmlXPathContextPtr ctxt, 
				 xmlXPathVariableLookupFunc f, 
				 void * data)

+
Function type: xmlXPathFuncLookupFunc
+xmlXPathFunction	xmlXPathFuncLookupFunc	(void * ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri)
+
Prototype for callbacks used to plug function lookup in the XPath engine.
ctxt:an XPath context
name:name of the function
ns_uri:the namespace name hosting this function
Returns:the XPath function or NULL if not found.


+
void	xmlXPathNodeSetDel	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
#define xmlXPathStackIsExternal
+
+
#define xmlXPathReturnEmptyString
+
+
#define XP_ERROR0
+
+
xmlNodeSetPtr	xmlXPathNodeTrailingSorted	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
void	xmlXPathErr	(xmlXPathParserContextPtr ctxt, 
				 int error)

+
xmlNodePtr	xmlXPathNextPreceding	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
xmlXPathFunction	xmlXPathFunctionLookupNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri)

+
xmlXPathObjectPtr	xmlXPathWrapNodeSet	(xmlNodeSetPtr val)

+
#define xmlXPathSetTypeError
+
+
#define xmlXPathReturnTrue
+
+
void	xmlXPathRegisteredFuncsCleanup	(xmlXPathContextPtr ctxt)

+
void	xmlXPathRegisterAllFunctions	(xmlXPathContextPtr ctxt)

+
#define xmlXPathReturnEmptyNodeSet
+
+
xmlXPathFunction	xmlXPathFunctionLookup	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name)

+
#define xmlXPathGetDocument
+
+
#define xmlXPathReturnBoolean
+
+
void	xmlXPathPositionFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Function type: xmlXPathVariableLookupFunc
+xmlXPathObjectPtr	xmlXPathVariableLookupFunc	(void * ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri)
+
Prototype for callbacks used to plug variable lookup in the XPath engine.
ctxt:an XPath context
name:name of the variable
ns_uri:the namespace name hosting this variable
Returns:the XPath object value or NULL if not found.


+
void	xmlXPathSubstringBeforeFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathRegisteredVariablesCleanup	(xmlXPathContextPtr ctxt)

+
xmlNodePtr	xmlXPathNextDescendant	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
xmlNodePtr	xmlXPathNextNamespace	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
xmlXPathObjectPtr	xmlXPathWrapCString	(char * val)

+
xmlXPathObjectPtr	xmlXPathNewFloat	(double val)

+
int	xmlXPathRegisterNs	(xmlXPathContextPtr ctxt, 
				 const xmlChar * prefix, 
				 const xmlChar * ns_uri)

+
xmlXPathObjectPtr	xmlXPathWrapExternal	(void * val)

+
void	xmlXPathTranslateFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
xmlNodePtr	xmlXPathNextParent	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
void	xmlXPathNodeSetFreeNs	(xmlNsPtr ns)

+
xmlNodeSetPtr	xmlXPathTrailing	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
int	xmlXPathHasSameNodes	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
xmlNodeSetPtr	xmlXPathDistinctSorted	(xmlNodeSetPtr nodes)

+
void	xmlXPathFreeParserContext	(xmlXPathParserContextPtr ctxt)

+
xmlNodeSetPtr	xmlXPathNodeTrailing	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
xmlXPathObjectPtr	xmlXPathNewCString	(const char * val)

+
int	valuePush	(xmlXPathParserContextPtr ctxt, 
				 xmlXPathObjectPtr value)

+
void	xmlXPathNodeSetAdd	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
void	xmlXPathSubstringFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathStringFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathFloorFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathNodeSetAddUnique	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
xmlXPathObjectPtr	xmlXPathNewValueTree	(xmlNodePtr val)

+
xmlXPathObjectPtr	xmlXPathVariableLookup	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name)

+
xmlNodeSetPtr	xmlXPathDistinct	(xmlNodeSetPtr nodes)

+
void	xmlXPathIdFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
#define xmlXPathSetError
+
+
#define CHECK_ERROR
+
+
#define CHECK_TYPE
+
+
xmlNodePtr	xmlXPathNextDescendantOrSelf	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
void	xmlXPathRegisterFuncLookup	(xmlXPathContextPtr ctxt, 
				 xmlXPathFuncLookupFunc f, 
				 void * funcCtxt)

+
xmlNodePtr	xmlXPathNextAttribute	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
void	xmlXPathDivValues	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPathStringLengthFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathLastFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
#define xmlXPathSetArityError
+
+
xmlNodePtr	xmlXPathNextSelf	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
void	xmlXPathDebugDumpCompExpr	(FILE * output, 
				 xmlXPathCompExprPtr comp, 
				 int depth)

+
void	xmlXPathEvalExpr	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPathFalseFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
void	xmlXPathDebugDumpObject	(FILE * output, 
				 xmlXPathObjectPtr cur, 
				 int depth)

+
void	xmlXPathValueFlipSign	(xmlXPathParserContextPtr ctxt)

+
double	xmlXPathStringEvalNumber	(const xmlChar * str)

+
xmlXPathObjectPtr	xmlXPathWrapString	(xmlChar * val)

+
#define xmlXPathEmptyNodeSet
+
+
#define xmlXPathReturnString
+
+
#define xmlXPathGetError
+
+
#define XP_ERROR
+
+
xmlNodeSetPtr	xmlXPathLeading	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
void	xmlXPathRegisteredNsCleanup	(xmlXPathContextPtr ctxt)

+
xmlChar *	xmlXPathParseName	(xmlXPathParserContextPtr ctxt)

+
#define xmlXPathReturnNodeSet
+
+
void	xmlXPathTrueFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
double	xmlXPathPopNumber	(xmlXPathParserContextPtr ctxt)

+
Description

+
Function: xmlXPathNodeSetMerge
xmlNodeSetPtr	xmlXPathNodeSetMerge	(xmlNodeSetPtr val1, 
				 xmlNodeSetPtr val2)

+
Merges two nodesets, all nodes from @val2 are added to @val1 if @val1 is NULL, a new set is created and copied from @val2

+
val1:the first NodeSet or NULL
val2:the second NodeSet
Returns:@val1 once extended or NULL in case of error.
Function: xmlXPathRoundFunction
void	xmlXPathRoundFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the round() XPath function number round(number) The round function returns the number that is closest to the argument and that is an integer. If there are two such numbers, then the one that is even is returned.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Macro: CAST_TO_NUMBER
#define CAST_TO_NUMBER
Macro to try to cast the value on the top of the XPath stack to a number.

+
Function: xmlXPathNumberFunction
void	xmlXPathNumberFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the number() XPath function number number(object?)

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathNotEqualValues
int	xmlXPathNotEqualValues	(xmlXPathParserContextPtr ctxt)

+
Implement the equal operation on XPath objects content: @arg1 == @arg2

+
ctxt:the XPath Parser context
Returns:0 or 1 depending on the results of the test.
Macro: xmlXPathStackIsNodeSet
#define xmlXPathStackIsNodeSet
Check if the current value on the XPath stack is a node set or an XSLT value tree. Returns true if the current object on the stack is a node-set.

+
Function: xmlXPathNsLookup
const xmlChar *	xmlXPathNsLookup	(xmlXPathContextPtr ctxt, 
				 const xmlChar * prefix)

+
Search in the namespace declaration array of the context for the given namespace name associated to the given prefix

+
ctxt:the XPath context
prefix:the namespace prefix value
Returns:the value or NULL if not found
Function: xmlXPathCountFunction
void	xmlXPathCountFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the count() XPath function number count(node-set)

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathParseNCName
xmlChar *	xmlXPathParseNCName	(xmlXPathParserContextPtr ctxt)

+
parse an XML namespace non qualified name. [NS 3] NCName ::= (Letter | '_') (NCNameChar)* [NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' | CombiningChar | Extender

+
ctxt:the XPath Parser context
Returns:the namespace name or NULL
Function: xmlXPathNewNodeSet
xmlXPathObjectPtr	xmlXPathNewNodeSet	(xmlNodePtr val)

+
Create a new xmlXPathObjectPtr of type NodeSet and initialize it with the single Node @val

+
val:the NodePtr value
Returns:the newly created object.
Macro: xmlXPathReturnNumber
#define xmlXPathReturnNumber
Pushes the double @val on the context stack.

+
Function: xmlXPathVariableLookupNS
xmlXPathObjectPtr	xmlXPathVariableLookupNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri)

+
Search in the Variable array of the context for the given variable value.

+
ctxt:the XPath context
name:the variable name
ns_uri:the variable namespace URI
Returns:the a copy of the value or NULL if not found
Function: xmlXPathNextAncestorOrSelf
xmlNodePtr	xmlXPathNextAncestorOrSelf	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "ancestor-or-self" direction he ancestor-or-self axis contains the context node and ancestors of the context node in reverse document order; thus the context node is the first node on the axis, and the context node's parent the second; parent here is defined the same as with the parent axis.

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathNewBoolean
xmlXPathObjectPtr	xmlXPathNewBoolean	(int val)

+
Create a new xmlXPathObjectPtr of type boolean and of value @val

+
val:the boolean value
Returns:the newly created object.
Function: xmlXPathNodeSetRemove
void	xmlXPathNodeSetRemove	(xmlNodeSetPtr cur, 
				 int val)

+
Removes an entry from an existing NodeSet list.

+
cur:the initial node set
val:the index to remove
Function: xmlXPathSubValues
void	xmlXPathSubValues	(xmlXPathParserContextPtr ctxt)

+
Implement the subtraction operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.

+
ctxt:the XPath Parser context
Function: xmlXPathNewNodeSetList
xmlXPathObjectPtr	xmlXPathNewNodeSetList	(xmlNodeSetPtr val)

+
Create a new xmlXPathObjectPtr of type NodeSet and initialize it with the Nodeset @val

+
val:an existing NodeSet
Returns:the newly created object.
Function: xmlXPathPopBoolean
int	xmlXPathPopBoolean	(xmlXPathParserContextPtr ctxt)

+
Pops a boolean from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

+
ctxt:an XPath parser context
Returns:the boolean
Function: xmlXPathNotFunction
void	xmlXPathNotFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the not() XPath function boolean not(boolean) The not function returns true if its argument is false, and false otherwise.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathEqualValues
int	xmlXPathEqualValues	(xmlXPathParserContextPtr ctxt)

+
Implement the equal operation on XPath objects content: @arg1 == @arg2

+
ctxt:the XPath Parser context
Returns:0 or 1 depending on the results of the test.
Macro: xmlXPathGetContextNode
#define xmlXPathGetContextNode
Get the context node of an XPath context. Returns the context node.

+
Function: xmlXPathNewString
xmlXPathObjectPtr	xmlXPathNewString	(const xmlChar * val)

+
Create a new xmlXPathObjectPtr of type string and of value @val

+
val:the xmlChar * value
Returns:the newly created object.
Function: xmlXPathTrailingSorted
xmlNodeSetPtr	xmlXPathTrailingSorted	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
Implements the EXSLT - Sets trailing() function: node-set set:trailing (node-set, node-set)

+
nodes1:a node-set, sorted by document order
nodes2:a node-set, sorted by document order
Returns:the nodes in @nodes1 that follow the first node in @nodes2 in document order, @nodes1 if @nodes2 is NULL or empty or an empty node-set if @nodes1 doesn't contain @nodes2
Function: xmlXPathMultValues
void	xmlXPathMultValues	(xmlXPathParserContextPtr ctxt)

+
Implement the multiply operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.

+
ctxt:the XPath Parser context
Function: xmlXPathModValues
void	xmlXPathModValues	(xmlXPathParserContextPtr ctxt)

+
Implement the mod operation on XPath objects: @arg1 / @arg2 The numeric operators convert their operands to numbers as if by calling the number function.

+
ctxt:the XPath Parser context
Function: xmlXPathNodeLeadingSorted
xmlNodeSetPtr	xmlXPathNodeLeadingSorted	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
Implements the EXSLT - Sets leading() function: node-set set:leading (node-set, node-set)

+
nodes:a node-set, sorted by document order
node:a node
Returns:the nodes in @nodes that precede @node in document order, @nodes if @node is NULL or an empty node-set if @nodes doesn't contain @node
Function: xmlXPathEvaluatePredicateResult
int	xmlXPathEvaluatePredicateResult	(xmlXPathParserContextPtr ctxt, 
				 xmlXPathObjectPtr res)

+
Evaluate a predicate result for the current node. A PredicateExpr is evaluated by evaluating the Expr and converting the result to a boolean. If the result is a number, the result will be converted to true if the number is equal to the position of the context node in the context node list (as returned by the position function) and will be converted to false otherwise; if the result is not a number, then the result will be converted as if by a call to the boolean function.

+
ctxt:the XPath Parser context
res:the Predicate Expression evaluation result
Returns:1 if predicate is true, 0 otherwise
Macro: CHECK_ARITY
#define CHECK_ARITY
Macro to check that the number of args passed to an XPath function matches.

+
Function: xmlXPathNextChild
xmlNodePtr	xmlXPathNextChild	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "child" direction The child axis contains the children of the context node in document order.

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Macro: CAST_TO_STRING
#define CAST_TO_STRING
Macro to try to cast the value on the top of the XPath stack to a string.

+
Macro: xmlXPathReturnExternal
#define xmlXPathReturnExternal
Pushes user data on the context stack.

+
Function: xmlXPathNextFollowingSibling
xmlNodePtr	xmlXPathNextFollowingSibling	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "following-sibling" direction The following-sibling axis contains the following siblings of the context node in document order.

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathBooleanFunction
void	xmlXPathBooleanFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the boolean() XPath function boolean boolean(object) he boolean function converts its argument to a boolean as follows: - a number is true if and only if it is neither positive or negative zero nor NaN - a node-set is true if and only if it is non-empty - a string is true if and only if its length is non-zero

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathNewParserContext
xmlXPathParserContextPtr	xmlXPathNewParserContext	(const xmlChar * str, 
				 xmlXPathContextPtr ctxt)

+
Create a new xmlXPathParserContext

+
str:the XPath expression
ctxt:the XPath context
Returns:the xmlXPathParserContext just allocated.
Function: xmlXPathNamespaceURIFunction
void	xmlXPathNamespaceURIFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the namespace-uri() XPath function string namespace-uri(node-set?) The namespace-uri function returns a string containing the namespace URI of the expanded name of the node in the argument node-set that is first in document order. If the node-set is empty, the first node has no name, or the expanded name has no namespace URI, an empty string is returned. If the argument is omitted it defaults to the context node.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathSubstringAfterFunction
void	xmlXPathSubstringAfterFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the substring-after() XPath function string substring-after(string, string) The substring-after function returns the substring of the first argument string that follows the first occurrence of the second argument string in the first argument string, or the empty stringi if the first argument string does not contain the second argument string. For example, substring-after("1999/04/01","/") returns 04/01, and substring-after("1999/04/01","19") returns 99/04/01.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathRoot
void	xmlXPathRoot	(xmlXPathParserContextPtr ctxt)

+
Initialize the context to the root of the document

+
ctxt:the XPath Parser context
Function: xmlXPathLangFunction
void	xmlXPathLangFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the lang() XPath function boolean lang(string) The lang function returns true or false depending on whether the language of the context node as specified by xml:lang attributes is the same as or is a sublanguage of the language specified by the argument string. The language of the context node is determined by the value of the xml:lang attribute on the context node, or, if the context node has no xml:lang attribute, by the value of the xml:lang attribute on the nearest ancestor of the context node that has an xml:lang attribute. If there is no such attribute, then lang

+
ctxt:the XPath Parser context
nargs:the number of arguments
Macro: CHECK_TYPE0
#define CHECK_TYPE0
Macro to check that the value on top of the XPath stack is of a given type. Return(0) in case of failure

+
Function: xmlXPathCompareValues
int	xmlXPathCompareValues	(xmlXPathParserContextPtr ctxt, 
				 int inf, 
				 int strict)

+
Implement the compare operation on XPath objects: @arg1 < @arg2 (1, 1, ... @arg1 <= @arg2 (1, 0, ... @arg1 > @arg2 (0, 1, ... @arg1 >= @arg2 (0, 0, ... When neither object to be compared is a node-set and the operator is <=, <, >=, >, then the objects are compared by converted both objects to numbers and comparing the numbers according to IEEE 754. The < comparison will be true if and only if the first number is less than the second number. The <= comparison will be true if and only if the first number is less than or equal to the second number. The > comparison will be true if and only if the first number is greater than the second number. The >= comparison will be true if and only if the first number is greater than or equal to the second number.

+
ctxt:the XPath Parser context
inf:less than (1) or greater than (0)
strict:is the comparison strict
Returns:1 if the comparison succeeded, 0 if it failed
Function: xmlXPathPopNodeSet
xmlNodeSetPtr	xmlXPathPopNodeSet	(xmlXPathParserContextPtr ctxt)

+
Pops a node-set from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

+
ctxt:an XPath parser context
Returns:the node-set
Macro: xmlXPathCheckError
#define xmlXPathCheckError
Check if an XPath error was raised. Returns true if an error has been raised, false otherwise.

+
Function: xmlXPathConcatFunction
void	xmlXPathConcatFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the concat() XPath function string concat(string, string, string*) The concat function returns the concatenation of its arguments.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathNodeSetAddNs
void	xmlXPathNodeSetAddNs	(xmlNodeSetPtr cur, 
				 xmlNodePtr node, 
				 xmlNsPtr ns)

+
add a new namespace node to an existing NodeSet

+
cur:the initial node set
node:the hosting node
ns:a the namespace node
Function: xmlXPathRegisterFunc
int	xmlXPathRegisterFunc	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 xmlXPathFunction f)

+
Register a new function. If @f is NULL it unregisters the function

+
ctxt:the XPath context
name:the function name
f:the function implementation or NULL
Returns:0 in case of success, -1 in case of error
Function: xmlXPathNodeSetContains
int	xmlXPathNodeSetContains	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
checks whether @cur contains @val

+
cur:the node-set
val:the node
Returns:true (1) if @cur contains @val, false (0) otherwise
Function: xmlXPathRegisterFuncNS
int	xmlXPathRegisterFuncNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri, 
				 xmlXPathFunction f)

+
Register a new function. If @f is NULL it unregisters the function

+
ctxt:the XPath context
name:the function name
ns_uri:the function namespace URI
f:the function implementation or NULL
Returns:0 in case of success, -1 in case of error
Function: xmlXPatherror
void	xmlXPatherror	(xmlXPathParserContextPtr ctxt, 
				 const char * file, 
				 int line, 
				 int no)

+
Formats an error message.

+
ctxt:the XPath Parser context
file:the file name
line:the line number
no:the error number
Function: xmlXPathNextAncestor
xmlNodePtr	xmlXPathNextAncestor	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "ancestor" direction the ancestor axis contains the ancestors of the context node; the ancestors of the context node consist of the parent of context node and the parent's parent and so on; the nodes are ordered in reverse document order; thus the parent is the first node on the axis, and the parent's parent is the second node on the axis

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathNextFollowing
xmlNodePtr	xmlXPathNextFollowing	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "following" direction The following axis contains all nodes in the same document as the context node that are after the context node in document order, excluding any descendants and excluding attribute nodes and namespace nodes; the nodes are ordered in document order

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathRegisterVariableNS
int	xmlXPathRegisterVariableNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri, 
				 xmlXPathObjectPtr value)

+
Register a new variable value. If @value is NULL it unregisters the variable

+
ctxt:the XPath context
name:the variable name
ns_uri:the variable namespace URI
value:the variable value or NULL
Returns:0 in case of success, -1 in case of error
Macro: CAST_TO_BOOLEAN
#define CAST_TO_BOOLEAN
Macro to try to cast the value on the top of the XPath stack to a boolean.

+
Function: xmlXPathIsNodeType
int	xmlXPathIsNodeType	(const xmlChar * name)

+
Is the name given a NodeType one. [38] NodeType ::= 'comment' | 'text' | 'processing-instruction' | 'node'

+
name:a name string
Returns:1 if true 0 otherwise
Function: xmlXPathPopString
xmlChar *	xmlXPathPopString	(xmlXPathParserContextPtr ctxt)

+
Pops a string from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

+
ctxt:an XPath parser context
Returns:the string
Function: xmlXPathLocalNameFunction
void	xmlXPathLocalNameFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the local-name() XPath function string local-name(node-set?) The local-name function returns a string containing the local part of the name of the node in the argument node-set that is first in document order. If the node-set is empty or the first node has no name, an empty string is returned. If the argument is omitted it defaults to the context node.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathAddValues
void	xmlXPathAddValues	(xmlXPathParserContextPtr ctxt)

+
Implement the add operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.

+
ctxt:the XPath Parser context
Function: xmlXPathDifference
xmlNodeSetPtr	xmlXPathDifference	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
Implements the EXSLT - Sets difference() function: node-set set:difference (node-set, node-set)

+
nodes1:a node-set
nodes2:a node-set
Returns:the difference between the two node sets, or nodes1 if nodes2 is empty
Function: xmlXPathRegisterVariable
int	xmlXPathRegisterVariable	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 xmlXPathObjectPtr value)

+
Register a new variable value. If @value is NULL it unregisters the variable

+
ctxt:the XPath context
name:the variable name
value:the variable value or NULL
Returns:0 in case of success, -1 in case of error
Function: valuePop
xmlXPathObjectPtr	valuePop	(xmlXPathParserContextPtr ctxt)

+
Pops the top XPath object from the value stack

+
ctxt:an XPath evaluation context
Returns:the XPath object just removed
Macro: CHECK_ERROR0
#define CHECK_ERROR0
Macro to return 0 from the function if an XPath error was detected.

+
Function: xmlXPathCeilingFunction
void	xmlXPathCeilingFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the ceiling() XPath function number ceiling(number) The ceiling function returns the smallest (closest to negative infinity) number that is not less than the argument and that is an integer.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathIntersection
xmlNodeSetPtr	xmlXPathIntersection	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
Implements the EXSLT - Sets intersection() function: node-set set:intersection (node-set, node-set)

+
nodes1:a node-set
nodes2:a node-set
Returns:a node set comprising the nodes that are within both the node sets passed as arguments
Function: xmlXPathLeadingSorted
xmlNodeSetPtr	xmlXPathLeadingSorted	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
Implements the EXSLT - Sets leading() function: node-set set:leading (node-set, node-set)

+
nodes1:a node-set, sorted by document order
nodes2:a node-set, sorted by document order
Returns:the nodes in @nodes1 that precede the first node in @nodes2 in document order, @nodes1 if @nodes2 is NULL or empty or an empty node-set if @nodes1 doesn't contain @nodes2
Macro: xmlXPathReturnFalse
#define xmlXPathReturnFalse
Pushes false on the context stack.

+
Function: xmlXPathContainsFunction
void	xmlXPathContainsFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the contains() XPath function boolean contains(string, string) The contains function returns true if the first argument string contains the second argument string, and otherwise returns false.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathNextPrecedingSibling
xmlNodePtr	xmlXPathNextPrecedingSibling	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "preceding-sibling" direction The preceding-sibling axis contains the preceding siblings of the context node in reverse document order; the first preceding sibling is first on the axis; the sibling preceding that node is the second on the axis and so on.

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathNodeSetSort
void	xmlXPathNodeSetSort	(xmlNodeSetPtr set)

+
Sort the node set in document order

+
set:the node set
Function: xmlXPathStartsWithFunction
void	xmlXPathStartsWithFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the starts-with() XPath function boolean starts-with(string, string) The starts-with function returns true if the first argument string starts with the second argument string, and otherwise returns false.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathPopExternal
void *	xmlXPathPopExternal	(xmlXPathParserContextPtr ctxt)

+
Pops an external object from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

+
ctxt:an XPath parser context
Returns:the object
Function: xmlXPathNormalizeFunction
void	xmlXPathNormalizeFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the normalize-space() XPath function string normalize-space(string?) The normalize-space function returns the argument string with white space normalized by stripping leading and trailing whitespace and replacing sequences of whitespace characters by a single space. Whitespace characters are the same allowed by the S production in XML. If the argument is omitted, it defaults to the context node converted to a string, in other words the value of the context node.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathNodeLeading
xmlNodeSetPtr	xmlXPathNodeLeading	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
Implements the EXSLT - Sets leading() function: node-set set:leading (node-set, node-set) @nodes is sorted by document order, then #exslSetsNodeLeadingSorted is called.

+
nodes:a node-set
node:a node
Returns:the nodes in @nodes that precede @node in document order, @nodes if @node is NULL or an empty node-set if @nodes doesn't contain @node
Function: xmlXPathSumFunction
void	xmlXPathSumFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the sum() XPath function number sum(node-set) The sum function returns the sum of the values of the nodes in the argument node-set.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathRegisterVariableLookup
void	xmlXPathRegisterVariableLookup	(xmlXPathContextPtr ctxt, 
				 xmlXPathVariableLookupFunc f, 
				 void * data)

+
register an external mechanism to do variable lookup

+
ctxt:the XPath context
f:the lookup function
data:the lookup data

+      Prototype for callbacks used to plug function lookup in the XPath engine.
+      
+      
+      
+      
+    
Function: xmlXPathNodeSetDel
void	xmlXPathNodeSetDel	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
Removes an xmlNodePtr from an existing NodeSet

+
cur:the initial node set
val:an xmlNodePtr
Macro: xmlXPathStackIsExternal
#define xmlXPathStackIsExternal
Checks if the current value on the XPath stack is an external object. Returns true if the current object on the stack is an external object.

+
Macro: xmlXPathReturnEmptyString
#define xmlXPathReturnEmptyString
Pushes an empty string on the stack.

+
Macro: XP_ERROR0
#define XP_ERROR0
Macro to raise an XPath error and return 0.

+
Function: xmlXPathNodeTrailingSorted
xmlNodeSetPtr	xmlXPathNodeTrailingSorted	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
Implements the EXSLT - Sets trailing() function: node-set set:trailing (node-set, node-set)

+
nodes:a node-set, sorted by document order
node:a node
Returns:the nodes in @nodes that follow @node in document order, @nodes if @node is NULL or an empty node-set if @nodes doesn't contain @node
Function: xmlXPathErr
void	xmlXPathErr	(xmlXPathParserContextPtr ctxt, 
				 int error)

+
Handle a Relax NG Parsing error

+
ctxt:a XPath parser context
error:the error code
Function: xmlXPathNextPreceding
xmlNodePtr	xmlXPathNextPreceding	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "preceding" direction the preceding axis contains all nodes in the same document as the context node that are before the context node in document order, excluding any ancestors and excluding attribute nodes and namespace nodes; the nodes are ordered in reverse document order

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathFunctionLookupNS
xmlXPathFunction	xmlXPathFunctionLookupNS	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name, 
				 const xmlChar * ns_uri)

+
Search in the Function array of the context for the given function.

+
ctxt:the XPath context
name:the function name
ns_uri:the function namespace URI
Returns:the xmlXPathFunction or NULL if not found
Function: xmlXPathWrapNodeSet
xmlXPathObjectPtr	xmlXPathWrapNodeSet	(xmlNodeSetPtr val)

+
Wrap the Nodeset @val in a new xmlXPathObjectPtr

+
val:the NodePtr value
Returns:the newly created object.
Macro: xmlXPathSetTypeError
#define xmlXPathSetTypeError
Raises an XPATH_INVALID_TYPE error.

+
Macro: xmlXPathReturnTrue
#define xmlXPathReturnTrue
Pushes true on the context stack.

+
Function: xmlXPathRegisteredFuncsCleanup
void	xmlXPathRegisteredFuncsCleanup	(xmlXPathContextPtr ctxt)

+
Cleanup the XPath context data associated to registered functions

+
ctxt:the XPath context
Function: xmlXPathRegisterAllFunctions
void	xmlXPathRegisterAllFunctions	(xmlXPathContextPtr ctxt)

+
Registers all default XPath functions in this context

+
ctxt:the XPath context
Macro: xmlXPathReturnEmptyNodeSet
#define xmlXPathReturnEmptyNodeSet
Pushes an empty node-set on the context stack.

+
Function: xmlXPathFunctionLookup
xmlXPathFunction	xmlXPathFunctionLookup	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name)

+
Search in the Function array of the context for the given function.

+
ctxt:the XPath context
name:the function name
Returns:the xmlXPathFunction or NULL if not found
Macro: xmlXPathGetDocument
#define xmlXPathGetDocument
Get the document of an XPath context. Returns the context document.

+
Macro: xmlXPathReturnBoolean
#define xmlXPathReturnBoolean
Pushes the boolean @val on the context stack.

+
Function: xmlXPathPositionFunction
void	xmlXPathPositionFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the position() XPath function number position() The position function returns the position of the context node in the context node list. The first position is 1, and so the last position will be equal to last().

+
ctxt:the XPath Parser context
nargs:the number of arguments

+      Prototype for callbacks used to plug variable lookup in the XPath engine.
+      
+      
+      
+      
+    
Function: xmlXPathSubstringBeforeFunction
void	xmlXPathSubstringBeforeFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the substring-before() XPath function string substring-before(string, string) The substring-before function returns the substring of the first argument string that precedes the first occurrence of the second argument string in the first argument string, or the empty string if the first argument string does not contain the second argument string. For example, substring-before("1999/04/01","/") returns 1999.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathRegisteredVariablesCleanup
void	xmlXPathRegisteredVariablesCleanup	(xmlXPathContextPtr ctxt)

+
Cleanup the XPath context data associated to registered variables

+
ctxt:the XPath context
Function: xmlXPathNextDescendant
xmlNodePtr	xmlXPathNextDescendant	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "descendant" direction the descendant axis contains the descendants of the context node in document order; a descendant is a child or a child of a child and so on.

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathNextNamespace
xmlNodePtr	xmlXPathNextNamespace	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "namespace" direction the namespace axis contains the namespace nodes of the context node; the order of nodes on this axis is implementation-defined; the axis will be empty unless the context node is an element We keep the XML namespace node at the end of the list.

+
ctxt:the XPath Parser context
cur:the current attribute in the traversal
Returns:the next element following that axis
Function: xmlXPathWrapCString
xmlXPathObjectPtr	xmlXPathWrapCString	(char * val)

+
Wraps a string into an XPath object.

+
val:the char * value
Returns:the newly created object.
Function: xmlXPathNewFloat
xmlXPathObjectPtr	xmlXPathNewFloat	(double val)

+
Create a new xmlXPathObjectPtr of type double and of value @val

+
val:the double value
Returns:the newly created object.
Function: xmlXPathRegisterNs
int	xmlXPathRegisterNs	(xmlXPathContextPtr ctxt, 
				 const xmlChar * prefix, 
				 const xmlChar * ns_uri)

+
Register a new namespace. If @ns_uri is NULL it unregisters the namespace

+
ctxt:the XPath context
prefix:the namespace prefix
ns_uri:the namespace name
Returns:0 in case of success, -1 in case of error
Function: xmlXPathWrapExternal
xmlXPathObjectPtr	xmlXPathWrapExternal	(void * val)

+
Wraps the @val data into an XPath object.

+
val:the user data
Returns:the newly created object.
Function: xmlXPathTranslateFunction
void	xmlXPathTranslateFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the translate() XPath function string translate(string, string, string) The translate function returns the first argument string with occurrences of characters in the second argument string replaced by the character at the corresponding position in the third argument string. For example, translate("bar","abc","ABC") returns the string BAr. If there is a character in the second argument string with no character at a corresponding position in the third argument string (because the second argument string is longer than the third argument string), then occurrences of that character in the first argument string are removed. For example, translate("--aaa--","abc-","ABC")

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathNextParent
xmlNodePtr	xmlXPathNextParent	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "parent" direction The parent axis contains the parent of the context node, if there is one.

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathNodeSetFreeNs
void	xmlXPathNodeSetFreeNs	(xmlNsPtr ns)

+
Namespace node in libxml don't match the XPath semantic. In a node set the namespace nodes are duplicated and the next pointer is set to the parent node in the XPath semantic. Check if such a node need to be freed

+
ns:the XPath namespace node found in a nodeset.
Function: xmlXPathTrailing
xmlNodeSetPtr	xmlXPathTrailing	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
Implements the EXSLT - Sets trailing() function: node-set set:trailing (node-set, node-set) @nodes1 and @nodes2 are sorted by document order, then #xmlXPathTrailingSorted is called.

+
nodes1:a node-set
nodes2:a node-set
Returns:the nodes in @nodes1 that follow the first node in @nodes2 in document order, @nodes1 if @nodes2 is NULL or empty or an empty node-set if @nodes1 doesn't contain @nodes2
Function: xmlXPathHasSameNodes
int	xmlXPathHasSameNodes	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
Implements the EXSLT - Sets has-same-nodes function: boolean set:has-same-node(node-set, node-set)

+
nodes1:a node-set
nodes2:a node-set
Returns:true (1) if @nodes1 shares any node with @nodes2, false (0) otherwise
Function: xmlXPathDistinctSorted
xmlNodeSetPtr	xmlXPathDistinctSorted	(xmlNodeSetPtr nodes)

+
Implements the EXSLT - Sets distinct() function: node-set set:distinct (node-set)

+
nodes:a node-set, sorted by document order
Returns:a subset of the nodes contained in @nodes, or @nodes if it is empty
Function: xmlXPathFreeParserContext
void	xmlXPathFreeParserContext	(xmlXPathParserContextPtr ctxt)

+
Free up an xmlXPathParserContext

+
ctxt:the context to free
Function: xmlXPathNodeTrailing
xmlNodeSetPtr	xmlXPathNodeTrailing	(xmlNodeSetPtr nodes, 
				 xmlNodePtr node)

+
Implements the EXSLT - Sets trailing() function: node-set set:trailing (node-set, node-set) @nodes is sorted by document order, then #xmlXPathNodeTrailingSorted is called.

+
nodes:a node-set
node:a node
Returns:the nodes in @nodes that follow @node in document order, @nodes if @node is NULL or an empty node-set if @nodes doesn't contain @node
Function: xmlXPathNewCString
xmlXPathObjectPtr	xmlXPathNewCString	(const char * val)

+
Create a new xmlXPathObjectPtr of type string and of value @val

+
val:the char * value
Returns:the newly created object.
Function: valuePush
int	valuePush	(xmlXPathParserContextPtr ctxt, 
				 xmlXPathObjectPtr value)

+
Pushes a new XPath object on top of the value stack

+
ctxt:an XPath evaluation context
value:the XPath object
Returns:the number of items on the value stack
Function: xmlXPathNodeSetAdd
void	xmlXPathNodeSetAdd	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
add a new xmlNodePtr to an existing NodeSet

+
cur:the initial node set
val:a new xmlNodePtr
Function: xmlXPathSubstringFunction
void	xmlXPathSubstringFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the substring() XPath function string substring(string, number, number?) The substring function returns the substring of the first argument starting at the position specified in the second argument with length specified in the third argument. For example, substring("12345",2,3) returns "234". If the third argument is not specified, it returns the substring starting at the position specified in the second argument and continuing to the end of the string. For example, substring("12345",2) returns "2345". More precisely, each character in the string (see [3.6 Strings]) is considered to have a numeric position: the position of the first character is 1, the position of the second character is 2 and so on. The returned substring contains those characters for which the position of the character is greater than or equal to the second argument and, if the third argument is specified, less than the sum of the second and third arguments; the comparisons and addition used for the above follow the standard IEEE 754 rules. Thus: - substring("12345", 1.5, 2.6) returns "234" - substring("12345", 0, 3) returns "12" - substring("12345", 0 div 0, 3) returns "" - substring("12345", 1, 0 div 0) returns "" - substring("12345", -42, 1 div 0) returns "12345" - substring("12345", -1 div 0, 1 div 0) returns ""

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathStringFunction
void	xmlXPathStringFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the string() XPath function string string(object?) he string function converts an object to a string as follows: - A node-set is converted to a string by returning the value of the node in the node-set that is first in document order. If the node-set is empty, an empty string is returned. - A number is converted to a string as follows + NaN is converted to the string NaN + positive zero is converted to the string 0 + negative zero is converted to the string 0 + positive infinity is converted to the string Infinity + negative infinity is converted to the string -Infinity + if the number is an integer, the number is represented in decimal form as a Number with no decimal point and no leading zeros, preceded by a minus sign (-) if the number is negative + otherwise, the number is represented in decimal form as a Number including a decimal point with at least one digit before the decimal point and at least one digit after the decimal point, preceded by a minus sign (-) if the number is negative; there must be no leading zeros before the decimal point apart possibly from the one required digit immediately before the decimal point; beyond the one required digit after the decimal point there must be as many, but only as many, more digits as are needed to uniquely distinguish the number from all other IEEE 754 numeric values. - The boolean false value is converted to the string false. The boolean true value is converted to the string true. If the argument is omitted, it defaults to a node-set with the context node as its only member.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathFloorFunction
void	xmlXPathFloorFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the floor() XPath function number floor(number) The floor function returns the largest (closest to positive infinity) number that is not greater than the argument and that is an integer.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathNodeSetAddUnique
void	xmlXPathNodeSetAddUnique	(xmlNodeSetPtr cur, 
				 xmlNodePtr val)

+
add a new xmlNodePtr to an existing NodeSet, optimized version when we are sure the node is not already in the set.

+
cur:the initial node set
val:a new xmlNodePtr
Function: xmlXPathNewValueTree
xmlXPathObjectPtr	xmlXPathNewValueTree	(xmlNodePtr val)

+
Create a new xmlXPathObjectPtr of type Value Tree (XSLT) and initialize it with the tree root @val

+
val:the NodePtr value
Returns:the newly created object.
Function: xmlXPathVariableLookup
xmlXPathObjectPtr	xmlXPathVariableLookup	(xmlXPathContextPtr ctxt, 
				 const xmlChar * name)

+
Search in the Variable array of the context for the given variable value.

+
ctxt:the XPath context
name:the variable name
Returns:a copy of the value or NULL if not found
Function: xmlXPathDistinct
xmlNodeSetPtr	xmlXPathDistinct	(xmlNodeSetPtr nodes)

+
Implements the EXSLT - Sets distinct() function: node-set set:distinct (node-set) @nodes is sorted by document order, then #exslSetsDistinctSorted is called with the sorted node-set

+
nodes:a node-set
Returns:a subset of the nodes contained in @nodes, or @nodes if it is empty
Function: xmlXPathIdFunction
void	xmlXPathIdFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the id() XPath function node-set id(object) The id function selects elements by their unique ID (see [5.2.1 Unique IDs]). When the argument to id is of type node-set, then the result is the union of the result of applying id to the string value of each of the nodes in the argument node-set. When the argument to id is of any other type, the argument is converted to a string as if by a call to the string function; the string is split into a whitespace-separated list of tokens (whitespace is any sequence of characters matching the production S); the result is a node-set containing the elements in the same document as the context node that have a unique ID equal to any of the tokens in the list.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Macro: xmlXPathSetError
#define xmlXPathSetError
Raises an error.

+
Macro: CHECK_ERROR
#define CHECK_ERROR
Macro to return from the function if an XPath error was detected.

+
Macro: CHECK_TYPE
#define CHECK_TYPE
Macro to check that the value on top of the XPath stack is of a given type.

+
Function: xmlXPathNextDescendantOrSelf
xmlNodePtr	xmlXPathNextDescendantOrSelf	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "descendant-or-self" direction the descendant-or-self axis contains the context node and the descendants of the context node in document order; thus the context node is the first node on the axis, and the first child of the context node is the second node on the axis

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathRegisterFuncLookup
void	xmlXPathRegisterFuncLookup	(xmlXPathContextPtr ctxt, 
				 xmlXPathFuncLookupFunc f, 
				 void * funcCtxt)

+
Registers an external mechanism to do function lookup.

+
ctxt:the XPath context
f:the lookup function
funcCtxt:the lookup data
Function: xmlXPathNextAttribute
xmlNodePtr	xmlXPathNextAttribute	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "attribute" direction TODO: support DTD inherited default attributes

+
ctxt:the XPath Parser context
cur:the current attribute in the traversal
Returns:the next element following that axis
Function: xmlXPathDivValues
void	xmlXPathDivValues	(xmlXPathParserContextPtr ctxt)

+
Implement the div operation on XPath objects @arg1 / @arg2: The numeric operators convert their operands to numbers as if by calling the number function.

+
ctxt:the XPath Parser context
Function: xmlXPathStringLengthFunction
void	xmlXPathStringLengthFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the string-length() XPath function number string-length(string?) The string-length returns the number of characters in the string (see [3.6 Strings]). If the argument is omitted, it defaults to the context node converted to a string, in other words the value of the context node.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathLastFunction
void	xmlXPathLastFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the last() XPath function number last() The last function returns the number of nodes in the context node list.

+
ctxt:the XPath Parser context
nargs:the number of arguments
Macro: xmlXPathSetArityError
#define xmlXPathSetArityError
Raises an XPATH_INVALID_ARITY error.

+
Function: xmlXPathNextSelf
xmlNodePtr	xmlXPathNextSelf	(xmlXPathParserContextPtr ctxt, 
				 xmlNodePtr cur)

+
Traversal function for the "self" direction The self axis contains just the context node itself

+
ctxt:the XPath Parser context
cur:the current node in the traversal
Returns:the next element following that axis
Function: xmlXPathDebugDumpCompExpr
void	xmlXPathDebugDumpCompExpr	(FILE * output, 
				 xmlXPathCompExprPtr comp, 
				 int depth)

+
Dumps the tree of the compiled XPath expression.

+
output:the FILE * for the output
comp:the precompiled XPath expression
depth:the indentation level.
Function: xmlXPathEvalExpr
void	xmlXPathEvalExpr	(xmlXPathParserContextPtr ctxt)

+
Parse and evaluate an XPath expression in the given context, then push the result on the context stack

+
ctxt:the XPath Parser context
Function: xmlXPathFalseFunction
void	xmlXPathFalseFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the false() XPath function boolean false()

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathDebugDumpObject
void	xmlXPathDebugDumpObject	(FILE * output, 
				 xmlXPathObjectPtr cur, 
				 int depth)

+
Dump the content of the object for debugging purposes

+
output:the FILE * to dump the output
cur:the object to inspect
depth:indentation level
Function: xmlXPathValueFlipSign
void	xmlXPathValueFlipSign	(xmlXPathParserContextPtr ctxt)

+
Implement the unary - operation on an XPath object The numeric operators convert their operands to numbers as if by calling the number function.

+
ctxt:the XPath Parser context
Function: xmlXPathStringEvalNumber
double	xmlXPathStringEvalNumber	(const xmlChar * str)

+
[30a] Float ::= Number ('e' Digits?)? [30] Number ::= Digits ('.' Digits?)? | '.' Digits [31] Digits ::= [0-9]+ Compile a Number in the string In complement of the Number expression, this function also handles negative values : '-' Number.

+
str:A string to scan
Returns:the double value.
Function: xmlXPathWrapString
xmlXPathObjectPtr	xmlXPathWrapString	(xmlChar * val)

+
Wraps the @val string into an XPath object.

+
val:the xmlChar * value
Returns:the newly created object.
Macro: xmlXPathEmptyNodeSet
#define xmlXPathEmptyNodeSet
Empties a node-set.

+
Macro: xmlXPathReturnString
#define xmlXPathReturnString
Pushes the string @str on the context stack.

+
Macro: xmlXPathGetError
#define xmlXPathGetError
Get the error code of an XPath context. Returns the context error.

+
Macro: XP_ERROR
#define XP_ERROR
Macro to raise an XPath error and return.

+
Function: xmlXPathLeading
xmlNodeSetPtr	xmlXPathLeading	(xmlNodeSetPtr nodes1, 
				 xmlNodeSetPtr nodes2)

+
Implements the EXSLT - Sets leading() function: node-set set:leading (node-set, node-set) @nodes1 and @nodes2 are sorted by document order, then #exslSetsLeadingSorted is called.

+
nodes1:a node-set
nodes2:a node-set
Returns:the nodes in @nodes1 that precede the first node in @nodes2 in document order, @nodes1 if @nodes2 is NULL or empty or an empty node-set if @nodes1 doesn't contain @nodes2
Function: xmlXPathRegisteredNsCleanup
void	xmlXPathRegisteredNsCleanup	(xmlXPathContextPtr ctxt)

+
Cleanup the XPath context data associated to registered variables

+
ctxt:the XPath context
Function: xmlXPathParseName
xmlChar *	xmlXPathParseName	(xmlXPathParserContextPtr ctxt)

+
parse an XML name [4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender [5] Name ::= (Letter | '_' | ':') (NameChar)*

+
ctxt:the XPath Parser context
Returns:the namespace name or NULL
Macro: xmlXPathReturnNodeSet
#define xmlXPathReturnNodeSet
Pushes the node-set @ns on the context stack.

+
Function: xmlXPathTrueFunction
void	xmlXPathTrueFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the true() XPath function boolean true()

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathPopNumber
double	xmlXPathPopNumber	(xmlXPathParserContextPtr ctxt)

+
Pops a number from the stack, handling conversion if needed. Check error with #xmlXPathCheckError.

+
ctxt:an XPath parser context
Returns:the number
Daniel Veillard

diff --git a/doc/html/libxml-xpointer.html b/doc/html/libxml-xpointer.html
index 12484999..f4e4c887 100644
--- a/doc/html/libxml-xpointer.html
+++ b/doc/html/libxml-xpointer.html
@@ -1,236 +1,84 @@
-xpointer
PrevUpHomeGnome XML Library Reference ManualNext
xpointer
xpointer — 
Synopsis
+
+
+Module xpointer from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xpointer from libxml2
Main Menu
Related links
Table of Contents
xmlXPathObjectPtr	xmlXPtrNewRangePoints	(xmlXPathObjectPtr start, 
				 xmlXPathObjectPtr end)

+
Typedef xmlLocationSet * xmlLocationSetPtr
 
-
-
-struct      xmlLocationSet;
-typedef     xmlLocationSetPtr;
-xmlLocationSetPtr xmlXPtrLocationSetCreate  (xmlXPathObjectPtr val);
-void        xmlXPtrFreeLocationSet          (xmlLocationSetPtr obj);
-xmlLocationSetPtr xmlXPtrLocationSetMerge   (xmlLocationSetPtr val1,
-                                             xmlLocationSetPtr val2);
-xmlXPathObjectPtr xmlXPtrNewRange           (xmlNodePtr start,
-                                             int startindex,
-                                             xmlNodePtr end,
-                                             int endindex);
-xmlXPathObjectPtr xmlXPtrNewRangePoints     (xmlXPathObjectPtr start,
-                                             xmlXPathObjectPtr end);
-xmlXPathObjectPtr xmlXPtrNewRangeNodePoint  (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);
-xmlXPathObjectPtr xmlXPtrNewRangePointNode  (xmlXPathObjectPtr start,
-                                             xmlNodePtr end);
-xmlXPathObjectPtr xmlXPtrNewRangeNodes      (xmlNodePtr start,
-                                             xmlNodePtr end);
-xmlXPathObjectPtr xmlXPtrNewLocationSetNodes
-                                            (xmlNodePtr start,
-                                             xmlNodePtr end);
-xmlXPathObjectPtr xmlXPtrNewLocationSetNodeSet
-                                            (xmlNodeSetPtr set);
-xmlXPathObjectPtr xmlXPtrNewRangeNodeObject (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);
-xmlXPathObjectPtr xmlXPtrNewCollapsedRange  (xmlNodePtr start);
-void        xmlXPtrLocationSetAdd           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);
-xmlXPathObjectPtr xmlXPtrWrapLocationSet    (xmlLocationSetPtr val);
-void        xmlXPtrLocationSetDel           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);
-void        xmlXPtrLocationSetRemove        (xmlLocationSetPtr cur,
-                                             int val);
-xmlXPathContextPtr xmlXPtrNewContext        (xmlDocPtr doc,
-                                             xmlNodePtr here,
-                                             xmlNodePtr origin);
-xmlXPathObjectPtr xmlXPtrEval               (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);
-void        xmlXPtrRangeToFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);
-xmlNodePtr  xmlXPtrBuildNodeList            (xmlXPathObjectPtr obj);
-void        xmlXPtrEvalRangePredicate       (xmlXPathParserContextPtr ctxt);
-
Description

-
-
Details
struct xmlLocationSet
struct xmlLocationSet {
-
-    int locNr;		      /* number of locations in the set */
-    int locMax;		      /* size of the array as allocated */
-    xmlXPathObjectPtr *locTab;/* array of locations */
-};
-

-
-
xmlLocationSetPtr
typedef xmlLocationSet *xmlLocationSetPtr;
-

-
-
xmlXPtrLocationSetCreate ()
xmlLocationSetPtr xmlXPtrLocationSetCreate  (xmlXPathObjectPtr val);

-Create a new xmlLocationSetPtr of type double and of value val

-
-
val:  an initial xmlXPathObjectPtr, or NULL
-
Returns :the newly created object.
-
xmlXPtrFreeLocationSet ()
void        xmlXPtrFreeLocationSet          (xmlLocationSetPtr obj);

-Free the LocationSet compound (not the actual ranges !).

-
-
obj:  the xmlLocationSetPtr to free
-
xmlXPtrLocationSetMerge ()
xmlLocationSetPtr xmlXPtrLocationSetMerge   (xmlLocationSetPtr val1,
-                                             xmlLocationSetPtr val2);

-Merges two rangesets, all ranges from val2 are added to val1

-
-
val1:  the first LocationSet
-
val2:  the second LocationSet
-
Returns :val1 once extended or NULL in case of error.
-
xmlXPtrNewRange ()
xmlXPathObjectPtr xmlXPtrNewRange           (xmlNodePtr start,
-                                             int startindex,
-                                             xmlNodePtr end,
-                                             int endindex);

-Create a new xmlXPathObjectPtr of type range

-
-
start:  the starting node
-
startindex:  the start index
-
end:  the ending point
-
endindex:  the ending index
-
Returns :the newly created object.
-
xmlXPtrNewRangePoints ()
xmlXPathObjectPtr xmlXPtrNewRangePoints     (xmlXPathObjectPtr start,
-                                             xmlXPathObjectPtr end);

-Create a new xmlXPathObjectPtr of type range using 2 Points

-
-
start:  the starting point
-
end:  the ending point
-
Returns :the newly created object.
-
xmlXPtrNewRangeNodePoint ()
xmlXPathObjectPtr xmlXPtrNewRangeNodePoint  (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);

-Create a new xmlXPathObjectPtr of type range from a node to a point

-
-
start:  the starting node
-
end:  the ending point
-
Returns :the newly created object.
-
xmlXPtrNewRangePointNode ()
xmlXPathObjectPtr xmlXPtrNewRangePointNode  (xmlXPathObjectPtr start,
-                                             xmlNodePtr end);

-Create a new xmlXPathObjectPtr of type range from a point to a node

-
-
start:  the starting point
-
end:  the ending node
-
Returns :the newly created object.
-
xmlXPtrNewRangeNodes ()
xmlXPathObjectPtr xmlXPtrNewRangeNodes      (xmlNodePtr start,
-                                             xmlNodePtr end);

-Create a new xmlXPathObjectPtr of type range using 2 nodes

-
-
start:  the starting node
-
end:  the ending node
-
Returns :the newly created object.
-
xmlXPtrNewLocationSetNodes ()
xmlXPathObjectPtr xmlXPtrNewLocationSetNodes
-                                            (xmlNodePtr start,
-                                             xmlNodePtr end);

-Create a new xmlXPathObjectPtr of type LocationSet and initialize
-it with the single range made of the two nodes start and end

-
-
start:  the start NodePtr value
-
end:  the end NodePtr value or NULL
-
Returns :the newly created object.
-
xmlXPtrNewLocationSetNodeSet ()
xmlXPathObjectPtr xmlXPtrNewLocationSetNodeSet
-                                            (xmlNodeSetPtr set);

-Create a new xmlXPathObjectPtr of type LocationSet and initialize
-it with all the nodes from set

-
-
set:  a node set
-
Returns :the newly created object.
-
xmlXPtrNewRangeNodeObject ()
xmlXPathObjectPtr xmlXPtrNewRangeNodeObject (xmlNodePtr start,
-                                             xmlXPathObjectPtr end);

-Create a new xmlXPathObjectPtr of type range from a not to an object

-
-
start:  the starting node
-
end:  the ending object
-
Returns :the newly created object.
-
xmlXPtrNewCollapsedRange ()
xmlXPathObjectPtr xmlXPtrNewCollapsedRange  (xmlNodePtr start);

-Create a new xmlXPathObjectPtr of type range using a single nodes

-
-
start:  the starting and ending node
-
Returns :the newly created object.
-
xmlXPtrLocationSetAdd ()
void        xmlXPtrLocationSetAdd           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);

-add a new xmlXPathObjectPtr to an existing LocationSet
-If the location already exist in the set val is freed.

-
-
cur:  the initial range set
-
val:  a new xmlXPathObjectPtr
-
xmlXPtrWrapLocationSet ()
xmlXPathObjectPtr xmlXPtrWrapLocationSet    (xmlLocationSetPtr val);

-Wrap the LocationSet val in a new xmlXPathObjectPtr

-
-
val:  the LocationSet value
-
Returns :the newly created object.
-
xmlXPtrLocationSetDel ()
void        xmlXPtrLocationSetDel           (xmlLocationSetPtr cur,
-                                             xmlXPathObjectPtr val);

-Removes an xmlXPathObjectPtr from an existing LocationSet

-
-
cur:  the initial range set
-
val:  an xmlXPathObjectPtr
-
xmlXPtrLocationSetRemove ()
void        xmlXPtrLocationSetRemove        (xmlLocationSetPtr cur,
-                                             int val);

-Removes an entry from an existing LocationSet list.

-
-
cur:  the initial range set
-
val:  the index to remove
-
xmlXPtrNewContext ()
xmlXPathContextPtr xmlXPtrNewContext        (xmlDocPtr doc,
-                                             xmlNodePtr here,
-                                             xmlNodePtr origin);

-Create a new XPointer context

-
-
doc:  the XML document
-
here:  the node that directly contains the XPointer being evaluated or NULL
-
origin:  the element from which a user or program initiated traversal of
-          the link, or NULL.
-
Returns :the xmlXPathContext just allocated.
-
xmlXPtrEval ()
xmlXPathObjectPtr xmlXPtrEval               (const xmlChar *str,
-                                             xmlXPathContextPtr ctx);

-Evaluate the XPath Location Path in the given context.

-
-
str:  the XPointer expression
-
ctx:  the XPointer context
-
Returns :the xmlXPathObjectPtr resulting from the evaluation or NULL.
-        the caller has to free the object.
-
xmlXPtrRangeToFunction ()
void        xmlXPtrRangeToFunction          (xmlXPathParserContextPtr ctxt,
-                                             int nargs);

-Implement the range-to() XPointer function

-
-
ctxt:  the XPointer Parser context
-
nargs:  the number of args
-
xmlXPtrBuildNodeList ()
xmlNodePtr  xmlXPtrBuildNodeList            (xmlXPathObjectPtr obj);

-Build a node list tree copy of the XPointer result.
-This will drop Attributes and Namespace declarations.

-
-
obj:  the XPointer result from the evaluation.
-
Returns :an xmlNodePtr list or NULL.
-        the caller has to free the node tree.
-
xmlXPtrEvalRangePredicate ()
void        xmlXPtrEvalRangePredicate       (xmlXPathParserContextPtr ctxt);

-[8]   Predicate ::=   '[' PredicateExpr ']'
- [9]   PredicateExpr ::=   Expr 
-

-Evaluate a predicate as in xmlXPathEvalPredicate() but for
-a Location Set instead of a node set

-
-
ctxt:  the XPointer Parser context
-
<< xmlschemastypeshash >>

+
xmlNodePtr	xmlXPtrBuildNodeList	(xmlXPathObjectPtr obj)

+
xmlXPathObjectPtr	xmlXPtrEval	(const xmlChar * str, 
				 xmlXPathContextPtr ctx)

+
xmlXPathObjectPtr	xmlXPtrNewCollapsedRange	(xmlNodePtr start)

+
Structure xmlLocationSet
struct _xmlLocationSet {
+    int	locNr	: number of locations in the set
+    int	locMax	: size of the array as allocated
+    xmlXPathObjectPtr *	locTab	: array of locations
+}

xmlXPathObjectPtr	xmlXPtrNewLocationSetNodeSet	(xmlNodeSetPtr set)

+
xmlXPathObjectPtr	xmlXPtrNewRangePointNode	(xmlXPathObjectPtr start, 
				 xmlNodePtr end)

+
xmlLocationSetPtr	xmlXPtrLocationSetMerge	(xmlLocationSetPtr val1, 
				 xmlLocationSetPtr val2)

+
void	xmlXPtrEvalRangePredicate	(xmlXPathParserContextPtr ctxt)

+
void	xmlXPtrLocationSetDel	(xmlLocationSetPtr cur, 
				 xmlXPathObjectPtr val)

+
xmlXPathObjectPtr	xmlXPtrNewRange	(xmlNodePtr start, 
				 int startindex, 
				 xmlNodePtr end, 
				 int endindex)

+
void	xmlXPtrFreeLocationSet	(xmlLocationSetPtr obj)

+
xmlXPathObjectPtr	xmlXPtrWrapLocationSet	(xmlLocationSetPtr val)

+
xmlXPathObjectPtr	xmlXPtrNewRangeNodes	(xmlNodePtr start, 
				 xmlNodePtr end)

+
xmlLocationSetPtr	xmlXPtrLocationSetCreate	(xmlXPathObjectPtr val)

+
void	xmlXPtrLocationSetAdd	(xmlLocationSetPtr cur, 
				 xmlXPathObjectPtr val)

+
void	xmlXPtrRangeToFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodes	(xmlNodePtr start, 
				 xmlNodePtr end)

+
xmlXPathContextPtr	xmlXPtrNewContext	(xmlDocPtr doc, 
				 xmlNodePtr here, 
				 xmlNodePtr origin)

+
xmlXPathObjectPtr	xmlXPtrNewRangeNodeObject	(xmlNodePtr start, 
				 xmlXPathObjectPtr end)

+
void	xmlXPtrLocationSetRemove	(xmlLocationSetPtr cur, 
				 int val)

+
xmlXPathObjectPtr	xmlXPtrNewRangeNodePoint	(xmlNodePtr start, 
				 xmlXPathObjectPtr end)

+
Description

+
Function: xmlXPtrNewRangePoints
xmlXPathObjectPtr	xmlXPtrNewRangePoints	(xmlXPathObjectPtr start, 
				 xmlXPathObjectPtr end)

+
Create a new xmlXPathObjectPtr of type range using 2 Points

+
start:the starting point
end:the ending point
Returns:the newly created object.
Function: xmlXPtrBuildNodeList
xmlNodePtr	xmlXPtrBuildNodeList	(xmlXPathObjectPtr obj)

+
Build a node list tree copy of the XPointer result. This will drop Attributes and Namespace declarations.

+
obj:the XPointer result from the evaluation.
Returns:an xmlNodePtr list or NULL. the caller has to free the node tree.
Function: xmlXPtrEval
xmlXPathObjectPtr	xmlXPtrEval	(const xmlChar * str, 
				 xmlXPathContextPtr ctx)

+
Evaluate the XPath Location Path in the given context.

+
str:the XPointer expression
ctx:the XPointer context
Returns:the xmlXPathObjectPtr resulting from the evaluation or NULL. the caller has to free the object.
Function: xmlXPtrNewCollapsedRange
xmlXPathObjectPtr	xmlXPtrNewCollapsedRange	(xmlNodePtr start)

+
Create a new xmlXPathObjectPtr of type range using a single nodes

+
start:the starting and ending node
Returns:the newly created object.

+      
+      
+      
+    
Function: xmlXPtrNewLocationSetNodeSet
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodeSet	(xmlNodeSetPtr set)

+
Create a new xmlXPathObjectPtr of type LocationSet and initialize it with all the nodes from @set

+
set:a node set
Returns:the newly created object.
Function: xmlXPtrNewRangePointNode
xmlXPathObjectPtr	xmlXPtrNewRangePointNode	(xmlXPathObjectPtr start, 
				 xmlNodePtr end)

+
Create a new xmlXPathObjectPtr of type range from a point to a node

+
start:the starting point
end:the ending node
Returns:the newly created object.
Function: xmlXPtrLocationSetMerge
xmlLocationSetPtr	xmlXPtrLocationSetMerge	(xmlLocationSetPtr val1, 
				 xmlLocationSetPtr val2)

+
Merges two rangesets, all ranges from @val2 are added to @val1

+
val1:the first LocationSet
val2:the second LocationSet
Returns:val1 once extended or NULL in case of error.
Function: xmlXPtrEvalRangePredicate
void	xmlXPtrEvalRangePredicate	(xmlXPathParserContextPtr ctxt)

+
[8] Predicate ::= '[' PredicateExpr ']' [9] PredicateExpr ::= Expr Evaluate a predicate as in xmlXPathEvalPredicate() but for a Location Set instead of a node set

+
ctxt:the XPointer Parser context
Function: xmlXPtrLocationSetDel
void	xmlXPtrLocationSetDel	(xmlLocationSetPtr cur, 
				 xmlXPathObjectPtr val)

+
Removes an xmlXPathObjectPtr from an existing LocationSet

+
cur:the initial range set
val:an xmlXPathObjectPtr
Function: xmlXPtrNewRange
xmlXPathObjectPtr	xmlXPtrNewRange	(xmlNodePtr start, 
				 int startindex, 
				 xmlNodePtr end, 
				 int endindex)

+
Create a new xmlXPathObjectPtr of type range

+
start:the starting node
startindex:the start index
end:the ending point
endindex:the ending index
Returns:the newly created object.
Function: xmlXPtrFreeLocationSet
void	xmlXPtrFreeLocationSet	(xmlLocationSetPtr obj)

+
Free the LocationSet compound (not the actual ranges !).

+
obj:the xmlLocationSetPtr to free
Function: xmlXPtrWrapLocationSet
xmlXPathObjectPtr	xmlXPtrWrapLocationSet	(xmlLocationSetPtr val)

+
Wrap the LocationSet @val in a new xmlXPathObjectPtr

+
val:the LocationSet value
Returns:the newly created object.
Function: xmlXPtrNewRangeNodes
xmlXPathObjectPtr	xmlXPtrNewRangeNodes	(xmlNodePtr start, 
				 xmlNodePtr end)

+
Create a new xmlXPathObjectPtr of type range using 2 nodes

+
start:the starting node
end:the ending node
Returns:the newly created object.
Function: xmlXPtrLocationSetCreate
xmlLocationSetPtr	xmlXPtrLocationSetCreate	(xmlXPathObjectPtr val)

+
Create a new xmlLocationSetPtr of type double and of value @val

+
val:an initial xmlXPathObjectPtr, or NULL
Returns:the newly created object.
Function: xmlXPtrLocationSetAdd
void	xmlXPtrLocationSetAdd	(xmlLocationSetPtr cur, 
				 xmlXPathObjectPtr val)

+
add a new xmlXPathObjectPtr to an existing LocationSet If the location already exist in the set @val is freed.

+
cur:the initial range set
val:a new xmlXPathObjectPtr
Function: xmlXPtrRangeToFunction
void	xmlXPtrRangeToFunction	(xmlXPathParserContextPtr ctxt, 
				 int nargs)

+
Implement the range-to() XPointer function

+
ctxt:the XPointer Parser context
nargs:the number of args
Function: xmlXPtrNewLocationSetNodes
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodes	(xmlNodePtr start, 
				 xmlNodePtr end)

+
Create a new xmlXPathObjectPtr of type LocationSet and initialize it with the single range made of the two nodes @start and @end

+
start:the start NodePtr value
end:the end NodePtr value or NULL
Returns:the newly created object.
Function: xmlXPtrNewContext
xmlXPathContextPtr	xmlXPtrNewContext	(xmlDocPtr doc, 
				 xmlNodePtr here, 
				 xmlNodePtr origin)

+
Create a new XPointer context

+
doc:the XML document
here:the node that directly contains the XPointer being evaluated or NULL
origin:the element from which a user or program initiated traversal of the link, or NULL.
Returns:the xmlXPathContext just allocated.
Function: xmlXPtrNewRangeNodeObject
xmlXPathObjectPtr	xmlXPtrNewRangeNodeObject	(xmlNodePtr start, 
				 xmlXPathObjectPtr end)

+
Create a new xmlXPathObjectPtr of type range from a not to an object

+
start:the starting node
end:the ending object
Returns:the newly created object.
Function: xmlXPtrLocationSetRemove
void	xmlXPtrLocationSetRemove	(xmlLocationSetPtr cur, 
				 int val)

+
Removes an entry from an existing LocationSet list.

+
cur:the initial range set
val:the index to remove
Function: xmlXPtrNewRangeNodePoint
xmlXPathObjectPtr	xmlXPtrNewRangeNodePoint	(xmlNodePtr start, 
				 xmlXPathObjectPtr end)

+
Create a new xmlXPathObjectPtr of type range from a node to a point

+
start:the starting node
end:the ending point
Returns:the newly created object.
Daniel Veillard

diff --git a/doc/libxml2-api.xml b/doc/libxml2-api.xml
index cb21d74c..9884db12 100644
--- a/doc/libxml2-api.xml
+++ b/doc/libxml2-api.xml
@@ -2,2922 +2,2892 @@
 
   
     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
-     
-     
+     
+     
+     
      
-     
-     
-     
+     
      
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
+     
      
      
      
-     
-     
-     
-     
-     
-     
-     
      
-     
+     
      
-     
-     
-     
-     
-     
      
-     
-     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
      
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
      
+     
      
+     
+     
     
     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
      
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
+     
+     
      
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
      
      
-     
+     
      
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
      
-     
      
-     
-     
-     
+     
+     
      
-     
-     
-     
-     
      
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
      
-     
      
-     
-     
-     
-     
+     
      
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
      
-     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
+     
+     
      
-     
+     
+     
      
-     
-     
-     
-     
-     
-     
+     
+     
      
      
+     
      
-     
-     
-     
-     
-     
+     
      
+     
+     
      
-     
-     
+     
+     
      
-     
-     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
+     
+     
+     
+     
+     
      
+     
+     
+     
      
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
+     
+     
+     
+     
      
-     
-     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
-     
-     
-     
-     
+     
      
-     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
-     
-     
-     
-     
-     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
      
-     
-     
-     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
+     
+     
+     
+     
      
      
-     
-     
+     
+     
+     
+     
      
-     
      
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
+     
      
     
     
-     
-     
-     
-     
-     
-     
      
+     
      
      
+     
+     
+     
+     
+     
     
     
-     
      
+     
      
      
-     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
+     
+     
      
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
      
+     
+     
     
     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
+     
+     
+     
+     
+     
      
-     
-     
-     
+     
+     
      
      
-     
-     
+     
+     
+     
      
-     
-     
      
-     
-     
-     
-     
-     
+     
+     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
      
-     
-     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
     
     
+     
+     
      
-     
-     
-     
      
      
-     
-     
      
+     
+     
+     
+     
      
      
-     
-     
-     
-     
+     
      
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
-     
-     
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
      
-     
-     
      
-     
-     
-     
-     
-     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
+     
      
      
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
+     
      
-     
-     
-     
-     
-     
-     
-     
-     
      
-     
+     
+     
+     
+     
+     
+     
+     
      
-     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
      
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
     
   
   
@@ -4593,6 +4563,7 @@ actually an xmlCharEncoding'/>
       
       
       
+      
     
     
     
diff --git a/doc/newapi.xsl b/doc/newapi.xsl
index d17efc66..6ad33ba4 100644
--- a/doc/newapi.xsl
+++ b/doc/newapi.xsl
@@ -23,8 +23,8 @@
   
   
 
-  
-  newhtml
+  
+  html