diff --git a/ChangeLog b/ChangeLog index d7687a7b..6cb9d13a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Wed Nov 19 17:50:47 HKT 2003 William Brack + + * doc/newapi.xsl: improve the sort sequence for page content + * doc/html/*.html: regenerate the web pages + Wed Nov 19 00:48:56 CET 2003 Daniel Veillard * Makefile.am: do not package cvs versioning temp files. diff --git a/doc/html/libxml-HTMLparser.html b/doc/html/libxml-HTMLparser.html index b8c6eb1e..b64a9c42 100644 --- a/doc/html/libxml-HTMLparser.html +++ b/doc/html/libxml-HTMLparser.html @@ -66,18 +66,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Macro: htmlDefaultSubelement

#define htmlDefaultSubelement

Returns the default subelement for this element

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.

Macro: htmlRequiredAttrs

#define htmlRequiredAttrs

Returns the attributes required for the specified element.

-

Structure htmlEntityDesc

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

htmlStatus

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

Structure htmlElemDesc

Structure htmlElemDesc
struct _htmlElemDesc {
+
Structure htmlElemDesc
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
@@ -92,85 +81,96 @@ A:link, A:visited, A:active { text-decoration: underline }
     const char **	attrs_opt	: Optional Attributes
     const char **	attrs_depr	: Additional deprecated attributes
     const char **	attrs_req	: Required attributes
-}
htmlParserOption
Enum htmlParserOption {
+}
Structure htmlEntityDesc
Structure htmlEntityDesc
struct _htmlEntityDesc {
+    unsigned int	value	: the UNICODE value for the character
+    const char *	name	: The entity name
+    const char *	desc	: the description
+}
Enum htmlParserOption
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
 }
-
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: 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)

+
Enum htmlStatus
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
+}
+
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.
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
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: 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: 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: 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: 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: htmlCtxtReadDoc
htmlDocPtr	htmlCtxtReadDoc		(htmlParserCtxtPtr ctxt, 
					 const xmlChar * cur, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

+
elt:HTML element
attr:HTML attribute
legacy:whether to allow deprecated attributes
Returns:one of HTML_REQUIRED, HTML_VALID, HTML_DEPRECATED, HTML_INVALID
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: 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: 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: 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: htmlElementStatusHere
htmlStatus	htmlElementStatusHere	(const htmlElemDesc * parent, 
					 const htmlElemDesc * elt)

+
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: 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
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: 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: 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: htmlCtxtReset
void	htmlCtxtReset			(htmlParserCtxtPtr ctxt)

+
Reset a parser context

+
ctxt:an HTML parser context
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: 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: 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: htmlEntityLookup
const htmlEntityDesc *	htmlEntityLookup	(const xmlChar * name)

+
parent:HTML parent element
elt:HTML element
Returns:one of HTML_VALID, HTML_DEPRECATED, HTML_INVALID
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: 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: 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: 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: 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.
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: htmlFreeParserCtxt
void	htmlFreeParserCtxt		(htmlParserCtxtPtr ctxt)

+
value:the entity's unicode value
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
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: 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: 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: 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.
Function: htmlIsAutoClosed
int	htmlIsAutoClosed		(htmlDocPtr doc, 
					 htmlNodePtr elem)

+
ctxt:an HTML parser context
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: 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: htmlParseCharRef
int	htmlParseCharRef		(htmlParserCtxtPtr ctxt)

+
doc:the HTML document
elem:the HTML element
Returns:1 if autoclosed, 0 otherwise
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: 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: 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: 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: 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: htmlParseDoc
htmlDocPtr	htmlParseDoc		(xmlChar * cur, 
					 const char * encoding)

+
ctxt:an HTML parser context
Returns:the value parsed (as an int)
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: 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: 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.
Daniel Veillard

+
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.
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
Daniel Veillard

diff --git a/doc/html/libxml-HTMLtree.html b/doc/html/libxml-HTMLtree.html
index c46b5ae1..43b66555 100644
--- a/doc/html/libxml-HTMLtree.html
+++ b/doc/html/libxml-HTMLtree.html
@@ -28,43 +28,43 @@ A:link, A:visited, A:active { text-decoration: underline }
 
int	htmlSaveFileFormat		(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

 
int	htmlSetMetaEncoding		(htmlDocPtr doc, 
					 const xmlChar * encoding)

 
Description

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

 
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.

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

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

 
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.

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

-
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.
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
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: 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: htmlDocContentDumpFormatOutput
void	htmlDocContentDumpFormatOutput	(xmlOutputBufferPtr buf, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

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

+
buf:the HTML buffer output
cur:the document
encoding:the encoding string
format:should formatting spaces been added
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
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: 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: 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)

+
doc:the document
Returns:the current encoding as flagged in the HTML source
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.
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: 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
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: 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.
Function: htmlSaveFileFormat
int	htmlSaveFileFormat		(const char * filename, 
					 xmlDocPtr cur, 
					 const char * encoding, 
					 int format)

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

+
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: 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
Daniel Veillard

diff --git a/doc/html/libxml-SAX2.html b/doc/html/libxml-SAX2.html
index 31c8c9ed..c6bf5e0d 100644
--- a/doc/html/libxml-SAX2.html
+++ b/doc/html/libxml-SAX2.html
@@ -54,90 +54,90 @@ A:link, A:visited, A:active { text-decoration: underline }
 
int	xmlSAXDefaultVersion		(int version)

 
int	xmlSAXVersion			(xmlSAXHandler * hdlr, 
					 int version)

 
Description

-
Function: xmlSAX2CheckNamespace
int	xmlSAX2CheckNamespace		(void * ctx, 
					 xmlChar * nameSpace)

-

-
ctx:
nameSpace:
Returns:
Function: xmlSAX2EndElementNs
void	xmlSAX2EndElementNs		(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: xmlSAX2Reference
void	xmlSAX2Reference		(void * ctx, 
					 const xmlChar * name)

-
called when an entity xmlSAX2Reference is detected.

-
ctx:the user data (XML parser context)
name:The entity name
Function: xmlSAX2GetNamespace
xmlNsPtr	xmlSAX2GetNamespace	(void * ctx)

-

-
ctx:
Returns:
Function: xmlSAX2ElementDecl
void	xmlSAX2ElementDecl		(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
Function: xmlSAX2NamespaceDecl
void	xmlSAX2NamespaceDecl		(void * ctx, 
					 const xmlChar * href, 
					 const xmlChar * prefix)

-

-
ctx:
href:
prefix:
Function: xmlSAX2AttributeDecl
void	xmlSAX2AttributeDecl		(void * ctx, 
					 const xmlChar * elem, 
					 const xmlChar * fullname, 
					 int type, 
					 int def, 
					 const xmlChar * defaultValue, 
					 xmlEnumerationPtr tree)

+
Function: docbDefaultSAXHandlerInit
void	docbDefaultSAXHandlerInit	(void)

+
Initialize the default SAX handler

+
Function: htmlDefaultSAXHandlerInit
void	htmlDefaultSAXHandlerInit	(void)

+
Initialize the default SAX handler

+
Function: xmlDefaultSAXHandlerInit
void	xmlDefaultSAXHandlerInit	(void)

+
Initialize the default SAX2 handler

+
Function: xmlSAX2AttributeDecl
void	xmlSAX2AttributeDecl		(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: xmlSAX2EntityDecl
void	xmlSAX2EntityDecl		(void * ctx, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * publicId, 
					 const xmlChar * systemId, 
					 xmlChar * content)

+
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: xmlSAX2CDataBlock
void	xmlSAX2CDataBlock		(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
Function: xmlSAX2Characters
void	xmlSAX2Characters		(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
Function: xmlSAX2CheckNamespace
int	xmlSAX2CheckNamespace		(void * ctx, 
					 xmlChar * nameSpace)

+

+
ctx:
nameSpace:
Returns:
Function: xmlSAX2Comment
void	xmlSAX2Comment			(void * ctx, 
					 const xmlChar * value)

+
A xmlSAX2Comment has been parsed.

+
ctx:the user data (XML parser context)
value:the xmlSAX2Comment content
Function: xmlSAX2ElementDecl
void	xmlSAX2ElementDecl		(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
Function: xmlSAX2EndDocument
void	xmlSAX2EndDocument		(void * ctx)

+
called when the document end has been detected.

+
ctx:the user data (XML parser context)
Function: xmlSAX2EndElement
void	xmlSAX2EndElement		(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
Function: xmlSAX2EndElementNs
void	xmlSAX2EndElementNs		(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: xmlSAX2EntityDecl
void	xmlSAX2EntityDecl		(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).
Function: xmlSAX2GetColumnNumber
int	xmlSAX2GetColumnNumber		(void * ctx)

+
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: xmlSAX2ExternalSubset
void	xmlSAX2ExternalSubset		(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: xmlSAX2GetColumnNumber
int	xmlSAX2GetColumnNumber		(void * ctx)

 
Provide the column number of the current parsing point.

 
ctx:the user data (XML parser context)
Returns:an int
Function: xmlSAX2GetEntity
xmlEntityPtr	xmlSAX2GetEntity	(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.
Function: xmlSAX2UnparsedEntityDecl
void	xmlSAX2UnparsedEntityDecl	(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: xmlSAX2InitDocbDefaultSAXHandler
void	xmlSAX2InitDocbDefaultSAXHandler	(xmlSAXHandler * hdlr)

-
Initialize the default DocBook SAX2 handler

-
hdlr:the SAX handler
Function: xmlSAXVersion
int	xmlSAXVersion			(xmlSAXHandler * hdlr, 
					 int version)

-
Initialize the default XML SAX handler according to the version

-
hdlr:the SAX handler
version:the version, 1 or 2
Returns:0 in case of success and -1 in case of error.
Function: xmlSAX2IgnorableWhitespace
void	xmlSAX2IgnorableWhitespace	(void * ctx, 
					 const xmlChar * ch, 
					 int len)

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

-
ctx:the user data (XML parser context)
ch:a xmlChar string
len:the number of xmlChar
Function: xmlSAX2NotationDecl
void	xmlSAX2NotationDecl		(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: xmlDefaultSAXHandlerInit
void	xmlDefaultSAXHandlerInit	(void)

-
Initialize the default SAX2 handler

-
Function: xmlSAX2StartDocument
void	xmlSAX2StartDocument		(void * ctx)

-
called when the document start being processed.

-
ctx:the user data (XML parser context)
Function: xmlSAX2EndElement
void	xmlSAX2EndElement		(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
Function: xmlSAX2ResolveEntity
xmlParserInputPtr	xmlSAX2ResolveEntity	(void * ctx, 
						 const xmlChar * publicId, 
						 const xmlChar * systemId)

-
The entity loader, to control the loading of external entities, the application can either: - override this xmlSAX2ResolveEntity() 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.
Function: xmlSAX2ExternalSubset
void	xmlSAX2ExternalSubset		(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: xmlSAX2GetPublicId
const xmlChar *	xmlSAX2GetPublicId	(void * ctx)

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

-
ctx:the user data (XML parser context)
Returns:a xmlChar *
Function: xmlSAX2SetNamespace
void	xmlSAX2SetNamespace		(void * ctx, 
					 const xmlChar * name)

-

-
ctx:
name:
Function: xmlSAX2IsStandalone
int	xmlSAX2IsStandalone		(void * ctx)

-
Is this document tagged standalone ?

-
ctx:the user data (XML parser context)
Returns:1 if true
Function: xmlSAX2EndDocument
void	xmlSAX2EndDocument		(void * ctx)

-
called when the document end has been detected.

-
ctx:the user data (XML parser context)
Function: xmlSAX2ProcessingInstruction
void	xmlSAX2ProcessingInstruction	(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
Function: xmlSAX2InternalSubset
void	xmlSAX2InternalSubset		(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)
Function: xmlSAX2Characters
void	xmlSAX2Characters		(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
Function: xmlSAX2Comment
void	xmlSAX2Comment			(void * ctx, 
					 const xmlChar * value)

-
A xmlSAX2Comment has been parsed.

-
ctx:the user data (XML parser context)
value:the xmlSAX2Comment content
Function: xmlSAX2StartElement
void	xmlSAX2StartElement		(void * ctx, 
					 const xmlChar * fullname, 
					 const xmlChar ** atts)

-
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
Function: xmlSAX2SetDocumentLocator
void	xmlSAX2SetDocumentLocator	(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: xmlSAX2CDataBlock
void	xmlSAX2CDataBlock		(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
Function: htmlDefaultSAXHandlerInit
void	htmlDefaultSAXHandlerInit	(void)

-
Initialize the default SAX handler

-
Function: xmlSAX2HasExternalSubset
int	xmlSAX2HasExternalSubset	(void * ctx)

-
Does this document has an external subset

-
ctx:the user data (XML parser context)
Returns:1 if true
Function: xmlSAX2StartElementNs
void	xmlSAX2StartElementNs		(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.
attributes:pointer to the array of (localname/prefix/URI/value/end) attribute values.
Function: xmlSAX2GlobalNamespace
void	xmlSAX2GlobalNamespace		(void * ctx, 
					 const xmlChar * href, 
					 const xmlChar * prefix)

-

-
ctx:
href:
prefix:
Function: xmlSAX2GetLineNumber
int	xmlSAX2GetLineNumber		(void * ctx)

+
ctx:the user data (XML parser context)
name:The entity name
Returns:the xmlEntityPtr if found.
Function: xmlSAX2GetLineNumber
int	xmlSAX2GetLineNumber		(void * ctx)

 
Provide the line number of the current parsing point.

-
ctx:the user data (XML parser context)
Returns:an int
Function: xmlSAX2HasInternalSubset
int	xmlSAX2HasInternalSubset	(void * ctx)

-
Does this document has an internal subset

-
ctx:the user data (XML parser context)
Returns:1 if true
Function: xmlSAX2InitHtmlDefaultSAXHandler
void	xmlSAX2InitHtmlDefaultSAXHandler	(xmlSAXHandler * hdlr)

-
Initialize the default HTML SAX2 handler

-
hdlr:the SAX handler
Function: docbDefaultSAXHandlerInit
void	docbDefaultSAXHandlerInit	(void)

-
Initialize the default SAX handler

-
Function: xmlSAXDefaultVersion
int	xmlSAXDefaultVersion		(int version)

-
Set the default version of SAX used globally by the library. Note that this may not be a good thing to do from a library it is better to use xmlSAXVersion() to set up specifically the version for a given parsing context.

-
version:the version, 1 or 2
Returns:the previous value in case of success and -1 in case of error.
Function: xmlSAX2InitDefaultSAXHandler
void	xmlSAX2InitDefaultSAXHandler	(xmlSAXHandler * hdlr, 
					 int warning)

-
Initialize the default XML SAX2 handler

-
hdlr:the SAX handler
warning:flag if non-zero sets the handler warning procedure
Function: xmlSAX2GetParameterEntity
xmlEntityPtr	xmlSAX2GetParameterEntity	(void * ctx, 
						 const xmlChar * name)

+
ctx:the user data (XML parser context)
Returns:an int
Function: xmlSAX2GetNamespace
xmlNsPtr	xmlSAX2GetNamespace	(void * ctx)

+

+
ctx:
Returns:
Function: xmlSAX2GetParameterEntity
xmlEntityPtr	xmlSAX2GetParameterEntity	(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: xmlSAX2GetSystemId
const xmlChar *	xmlSAX2GetSystemId	(void * ctx)

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

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

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

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

-
ctx:the user data (XML parser context)
Returns:a xmlChar *
Daniel Veillard

+
ctx:the user data (XML parser context)
Returns:a xmlChar *
Function: xmlSAX2GlobalNamespace
void	xmlSAX2GlobalNamespace		(void * ctx, 
					 const xmlChar * href, 
					 const xmlChar * prefix)

+

+
ctx:
href:
prefix:
Function: xmlSAX2HasExternalSubset
int	xmlSAX2HasExternalSubset	(void * ctx)

+
Does this document has an external subset

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

+
Does this document has an internal subset

+
ctx:the user data (XML parser context)
Returns:1 if true
Function: xmlSAX2IgnorableWhitespace
void	xmlSAX2IgnorableWhitespace	(void * ctx, 
					 const xmlChar * ch, 
					 int len)

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

+
ctx:the user data (XML parser context)
ch:a xmlChar string
len:the number of xmlChar
Function: xmlSAX2InitDefaultSAXHandler
void	xmlSAX2InitDefaultSAXHandler	(xmlSAXHandler * hdlr, 
					 int warning)

+
Initialize the default XML SAX2 handler

+
hdlr:the SAX handler
warning:flag if non-zero sets the handler warning procedure
Function: xmlSAX2InitDocbDefaultSAXHandler
void	xmlSAX2InitDocbDefaultSAXHandler	(xmlSAXHandler * hdlr)

+
Initialize the default DocBook SAX2 handler

+
hdlr:the SAX handler
Function: xmlSAX2InitHtmlDefaultSAXHandler
void	xmlSAX2InitHtmlDefaultSAXHandler	(xmlSAXHandler * hdlr)

+
Initialize the default HTML SAX2 handler

+
hdlr:the SAX handler
Function: xmlSAX2InternalSubset
void	xmlSAX2InternalSubset		(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)
Function: xmlSAX2IsStandalone
int	xmlSAX2IsStandalone		(void * ctx)

+
Is this document tagged standalone ?

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

+

+
ctx:
href:
prefix:
Function: xmlSAX2NotationDecl
void	xmlSAX2NotationDecl		(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: xmlSAX2ProcessingInstruction
void	xmlSAX2ProcessingInstruction	(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
Function: xmlSAX2Reference
void	xmlSAX2Reference		(void * ctx, 
					 const xmlChar * name)

+
called when an entity xmlSAX2Reference is detected.

+
ctx:the user data (XML parser context)
name:The entity name
Function: xmlSAX2ResolveEntity
xmlParserInputPtr	xmlSAX2ResolveEntity	(void * ctx, 
						 const xmlChar * publicId, 
						 const xmlChar * systemId)

+
The entity loader, to control the loading of external entities, the application can either: - override this xmlSAX2ResolveEntity() 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.
Function: xmlSAX2SetDocumentLocator
void	xmlSAX2SetDocumentLocator	(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: xmlSAX2SetNamespace
void	xmlSAX2SetNamespace		(void * ctx, 
					 const xmlChar * name)

+

+
ctx:
name:
Function: xmlSAX2StartDocument
void	xmlSAX2StartDocument		(void * ctx)

+
called when the document start being processed.

+
ctx:the user data (XML parser context)
Function: xmlSAX2StartElement
void	xmlSAX2StartElement		(void * ctx, 
					 const xmlChar * fullname, 
					 const xmlChar ** atts)

+
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
Function: xmlSAX2StartElementNs
void	xmlSAX2StartElementNs		(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.
attributes:pointer to the array of (localname/prefix/URI/value/end) attribute values.
Function: xmlSAX2UnparsedEntityDecl
void	xmlSAX2UnparsedEntityDecl	(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: xmlSAXDefaultVersion
int	xmlSAXDefaultVersion		(int version)

+
Set the default version of SAX used globally by the library. Note that this may not be a good thing to do from a library it is better to use xmlSAXVersion() to set up specifically the version for a given parsing context.

+
version:the version, 1 or 2
Returns:the previous value in case of success and -1 in case of error.
Function: xmlSAXVersion
int	xmlSAXVersion			(xmlSAXHandler * hdlr, 
					 int version)

+
Initialize the default XML SAX handler according to the version

+
hdlr:the SAX handler
version:the version, 1 or 2
Returns:0 in case of success and -1 in case of error.
Daniel Veillard

diff --git a/doc/html/libxml-c14n.html b/doc/html/libxml-c14n.html
index f4223d1e..bf07602f 100644
--- a/doc/html/libxml-c14n.html
+++ b/doc/html/libxml-c14n.html
@@ -18,15 +18,15 @@ A:link, A:visited, A:active { text-decoration: underline }
 int	xmlC14NIsVisibleCallback	(void * user_data, 
					 xmlNodePtr node, 
					 xmlNodePtr parent)
 

 
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)

+
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
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: 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
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)

+
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: 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
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 type: xmlC14NIsVisibleCallback
Function type: xmlC14NIsVisibleCallback
+
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 type: xmlC14NIsVisibleCallback
Function type: xmlC14NIsVisibleCallback
 int	xmlC14NIsVisibleCallback	(void * user_data, 
					 xmlNodePtr node, 
					 xmlNodePtr parent)
 
user_data:
node:
parent:
Returns:


-
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

+
Daniel Veillard

diff --git a/doc/html/libxml-catalog.html b/doc/html/libxml-catalog.html
index e23cd818..adb0cd3d 100644
--- a/doc/html/libxml-catalog.html
+++ b/doc/html/libxml-catalog.html
@@ -52,91 +52,91 @@ The content of this structure is not made public by the API.
 
xmlCatalogPtr	xmlNewCatalog		(int sgml)

 
xmlDocPtr	xmlParseCatalogFile	(const char * filename)

 
Description

-
Macro: XML_CATALOG_PI
#define XML_CATALOG_PI
The specific XML Catalog Processing Instuction name.

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

-
xmlCatalogAllow
Enum xmlCatalogAllow {
+
Macro: XML_CATALOG_PI
#define XML_CATALOG_PI
The specific XML Catalog Processing Instuction name.

+
Structure xmlCatalog
Structure xmlCatalog
struct _xmlCatalog {
+The content of this structure is not made public by the API.
+}
Enum xmlCatalogAllow
Enum xmlCatalogAllow {
     XML_CATA_ALLOW_NONE = 0
     XML_CATA_ALLOW_GLOBAL = 1
     XML_CATA_ALLOW_DOCUMENT = 2
     XML_CATA_ALLOW_ALL = 3
 }
-
xmlCatalogPrefer
Enum xmlCatalogPrefer {
+
Enum xmlCatalogPrefer
Enum xmlCatalogPrefer {
     XML_CATA_PREFER_NONE = 0
     XML_CATA_PREFER_PUBLIC = 1
     XML_CATA_PREFER_SYSTEM = 2
 }
-
Structure xmlCatalog
Structure xmlCatalog
struct _xmlCatalog {
-The content of this structure is not made public by the API.
-}
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: xmlFreeCatalog
void	xmlFreeCatalog			(xmlCatalogPtr catal)

-
Free the memory allocated to a Catalog

-
catal:a Catalog entry
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: 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)

+
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: xmlACatalogResolvePublic
xmlChar *	xmlACatalogResolvePublic	(xmlCatalogPtr catal, 
						 const xmlChar * pubID)

+
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: xmlACatalogDump
void	xmlACatalogDump			(xmlCatalogPtr catal, 
					 FILE * out)

+
Free up all the memory associated with catalogs

+
catal:a Catalog
out:the file.
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: 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: 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: xmlCatalogGetDefaults
xmlCatalogAllow	xmlCatalogGetDefaults	(void)

+
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: 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: 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: 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: 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: xmlCatalogCleanup
void	xmlCatalogCleanup		(void)

+
Free up all the memory associated with catalogs

+
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: xmlCatalogDump
void	xmlCatalogDump			(FILE * out)

+
Free up all the memory associated with catalogs

+
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: 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: xmlInitializeCatalog
void	xmlInitializeCatalog		(void)

+
Returns:the current xmlCatalogAllow value
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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
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: 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: 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: 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: xmlFreeCatalog
void	xmlFreeCatalog			(xmlCatalogPtr catal)

+
Free the memory allocated to a Catalog

+
catal:a Catalog entry
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: 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: 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: 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: 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: xmlCatalogDump
void	xmlCatalogDump			(FILE * out)

-
Free up all the memory associated with catalogs

-
out:the file.
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: xmlCatalogCleanup
void	xmlCatalogCleanup		(void)

-
Free up all the memory associated with catalogs

-
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: 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: 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: 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: 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: 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: xmlLoadCatalog
int	xmlLoadCatalog			(const char * filename)

+
filename:a file path
Returns:the catalog parsed or NULL in case of error
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
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: 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: 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: 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: 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: 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: 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: xmlACatalogDump
void	xmlACatalogDump			(xmlCatalogPtr catal, 
					 FILE * out)

-
Free up all the memory associated with catalogs

-
catal:a Catalog
out:the file.
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: 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: 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.
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)

+
filename:a file path
Returns:0 in case of success -1 in case of error
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: 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
Daniel Veillard

+
filename:a file path
Returns:the catalog parsed or NULL in case of error
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: 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
Daniel Veillard

diff --git a/doc/html/libxml-chvalid.html b/doc/html/libxml-chvalid.html
index 89c1cbf0..761ddb3d 100644
--- a/doc/html/libxml-chvalid.html
+++ b/doc/html/libxml-chvalid.html
@@ -26,24 +26,21 @@ A:link, A:visited, A:active { text-decoration: underline }
 
int	xmlIsIdeographic		(unsigned int ch)

 
int	xmlIsPubidChar			(unsigned int ch)

 
Description

-
Macro: xmlIsExtender_ch
#define xmlIsExtender_ch
Automatically generated by genChRanges.py

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

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

-
Macro: xmlIsExtenderQ
#define xmlIsExtenderQ
Automatically generated by genChRanges.py

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

-
Macro: xmlIsCharQ
#define xmlIsCharQ
Automatically generated by genChRanges.py

-
Macro: xmlIsBaseCharQ
#define xmlIsBaseCharQ
Automatically generated by genChRanges.py

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

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

-
Structure xmlChSRange
Structure xmlChSRange
struct _xmlChSRange {
-    unsigned short	low
-    unsigned short	high
-}
Structure xmlChLRange
Structure xmlChLRange
struct _xmlChLRange {
+
Structure xmlChLRange
Structure xmlChLRange
struct _xmlChLRange {
     unsigned int	low
     unsigned int	high
 }
Structure xmlChRangeGroup
Structure xmlChRangeGroup
struct _xmlChRangeGroup {
@@ -51,22 +48,25 @@ A:link, A:visited, A:active { text-decoration: underline }
     int	nbLongRange
     xmlChSRangePtr	shortRange	: points to an array of ranges
     xmlChLRangePtr	longRange
-}
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
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
Function: xmlIsCombining
int	xmlIsCombining			(unsigned int ch)

-
This function is DEPRECATED. Use 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 xmlIsIdeographicQ instead

-
ch:character to validate
Returns:true if argument valid, false otherwise
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: xmlCharInRange
int	xmlCharInRange			(unsigned int val, 
					 const xmlChRangeGroupPtr rptr)

+}
Structure xmlChSRange
Structure xmlChSRange
struct _xmlChSRange {
+    unsigned short	low
+    unsigned short	high
+}
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
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
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
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: xmlIsCombining
int	xmlIsCombining			(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsCombiningQ 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
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: xmlIsIdeographic
int	xmlIsIdeographic		(unsigned int ch)

+
This function is DEPRECATED. Use xmlIsIdeographicQ instead

+
ch:character to validate
Returns:true if argument valid, false otherwise
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
Daniel Veillard

diff --git a/doc/html/libxml-debugXML.html b/doc/html/libxml-debugXML.html
index 66222a6d..0aeab114 100644
--- a/doc/html/libxml-debugXML.html
+++ b/doc/html/libxml-debugXML.html
@@ -54,64 +54,64 @@ char *	xmlShellReadlineFunc		(char * prompt)
     int	loaded
     FILE *	output
     xmlShellReadlineFunc	input
-}
Function: xmlDebugDumpEntities
void	xmlDebugDumpEntities		(FILE * output, 
					 xmlDocPtr doc)

+}
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: 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: 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: xmlDebugDumpDTD
void	xmlDebugDumpDTD			(FILE * output, 
					 xmlDtdPtr dtd)

+
Dumps debug information for the DTD

+
output:the FILE * for the output
dtd:the DTD
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: 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: 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: xmlShellBase
int	xmlShellBase			(xmlShellCtxtPtr ctxt, 
					 char * arg, 
					 xmlNodePtr node, 
					 xmlNodePtr node2)

+
output:the FILE * for the output
doc:the document
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: 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: 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.
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: xmlLsCountNode
int	xmlLsCountNode			(xmlNodePtr node)

+
Count the children of @node.

+
node:the node to count
Returns:the number of children of @node.
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
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
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: 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: 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)

+
ctxt:the shell context
arg:unused
node:a node
node2:unused
Returns:0
Function type: xmlShellCmd
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.


+
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: 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: 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: 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: 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
Function type: xmlShellReadlineFunc
Function type: xmlShellReadlineFunc
+
node:a non-null node to print to the output FILE
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: 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 type: xmlShellReadlineFunc
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.


 
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: 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: 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: 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)

+
ctxt:the shell context
filename:the file name (optional)
node:unused
node2:unused
Returns:0 or -1 in case of error
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: 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: xmlShellPrintXPathResult
void	xmlShellPrintXPathResult	(xmlXPathObjectPtr list)

-
Prints result to the output FILE

-
list:a valid result generated by an xpath evaluation
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: 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.
Function type: xmlShellCmd
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.


-
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: 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
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
Daniel Veillard

+
ctxt:the shell context
dtd:the DTD URI (optional)
node:unused
node2:unused
Returns:0 or -1 in case of error
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
Daniel Veillard

diff --git a/doc/html/libxml-dict.html b/doc/html/libxml-dict.html
index c30156ab..acd2c31f 100644
--- a/doc/html/libxml-dict.html
+++ b/doc/html/libxml-dict.html
@@ -23,18 +23,18 @@ The content of this structure is not made public by the API.
 
Description

 
Structure xmlDict
Structure xmlDict
struct _xmlDict {
 The content of this structure is not made public by the API.
-}
Function: xmlDictQLookup
const xmlChar *	xmlDictQLookup		(xmlDictPtr dict, 
					 const xmlChar * prefix, 
					 const xmlChar * name)

+}
Function: xmlDictCreate
xmlDictPtr	xmlDictCreate		(void)

+
Create a new dictionary

+
Returns:the newly created object, or NULL if an error occured.
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: 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: 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
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

+
dict:the dictionnary
Returns:the number of elements in the dictionnary or -1 in case of error
Daniel Veillard

diff --git a/doc/html/libxml-encoding.html b/doc/html/libxml-encoding.html
index eb5d0297..aa32dc5e 100644
--- a/doc/html/libxml-encoding.html
+++ b/doc/html/libxml-encoding.html
@@ -49,7 +49,7 @@ int	xmlCharEncodingOutputFunc	(unsigned
 
int	xmlUTF8Strsize			(const xmlChar * utf, 
					 int len)

 
xmlChar *	xmlUTF8Strsub		(const xmlChar * utf, 
					 int start, 
					 int len)

 
Description

-
xmlCharEncoding
Enum xmlCharEncoding {
+
Enum xmlCharEncoding
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
@@ -81,68 +81,68 @@ int	xmlCharEncodingOutputFunc	(unsigned
     xmlCharEncodingOutputFunc	output
     iconv_t	iconv_in
     iconv_t	iconv_out
-}
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: UTF8Toisolat1
int	UTF8Toisolat1			(unsigned char * out, 
					 int * outlen, 
					 const unsigned char * in, 
					 int * inlen)

+}
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: 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: xmlAddEncodingAlias
int	xmlAddEncodingAlias		(const char * name, 
					 const char * alias)

+
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: 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: 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)

+
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: 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: 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: 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: 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
Function type: xmlCharEncodingInputFunc
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.


-
Function: xmlCleanupCharEncodingHandlers
void	xmlCleanupCharEncodingHandlers	(void)

-
Cleanup the memory allocated for the char encoding support, it unregisters all the encoding handlers and the aliases.

-
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: 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: 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: 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: 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: 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
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: xmlCleanupEncodingAliases
void	xmlCleanupEncodingAliases	(void)

-
Unregisters all aliases

-
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: 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: 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 type: xmlCharEncodingOutputFunc
Function type: xmlCharEncodingOutputFunc
+
Function type: xmlCharEncodingOutputFunc
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.


-
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: 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: 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: 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: 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: xmlDetectCharEncoding
xmlCharEncoding	xmlDetectCharEncoding	(const unsigned char * in, 
					 int len)

+
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: xmlCleanupCharEncodingHandlers
void	xmlCleanupCharEncodingHandlers	(void)

+
Cleanup the memory allocated for the char encoding support, it unregisters all the encoding handlers and the aliases.

+
Function: xmlCleanupEncodingAliases
void	xmlCleanupEncodingAliases	(void)

+
Unregisters all aliases

+
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: 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: xmlNewCharEncodingHandler
xmlCharEncodingHandlerPtr	xmlNewCharEncodingHandler	(const char * name, 
							 xmlCharEncodingInputFunc input, 
							 xmlCharEncodingOutputFunc output)

+
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: 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: 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: 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: 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: 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: 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: 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).
Daniel Veillard

+
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: 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: xmlRegisterCharEncodingHandler
void	xmlRegisterCharEncodingHandler	(xmlCharEncodingHandlerPtr handler)

+
Register the char encoding handler, surprising, isn't it ?

+
handler:the xmlCharEncodingHandlerPtr handler block
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: 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: 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
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: 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: 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: 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: 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
Daniel Veillard

diff --git a/doc/html/libxml-entities.html b/doc/html/libxml-entities.html
index eb63bbaa..00ea8c0a 100644
--- a/doc/html/libxml-entities.html
+++ b/doc/html/libxml-entities.html
@@ -31,7 +31,9 @@ The content of this structure is not made public by the API.
 
xmlEntityPtr	xmlGetPredefinedEntity	(const xmlChar * name)

 
void	xmlInitializePredefinedEntities	(void)

 
Description

-
xmlEntityType
Enum xmlEntityType {
+
Structure xmlEntitiesTable
Structure xmlEntitiesTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}
Enum xmlEntityType
Enum xmlEntityType {
     XML_INTERNAL_GENERAL_ENTITY = 1
     XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2
     XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3
@@ -39,38 +41,36 @@ The content of this structure is not made public by the API.
     XML_EXTERNAL_PARAMETER_ENTITY = 5
     XML_INTERNAL_PREDEFINED_ENTITY = 6
 }
-
Structure xmlEntitiesTable
Structure xmlEntitiesTable
struct _xmlHashTable {
-The content of this structure is not made public by the API.
-}
Function: xmlAddDocEntity
xmlEntityPtr	xmlAddDocEntity		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID, 
					 const xmlChar * content)

+
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: 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: xmlCreateEntitiesTable
xmlEntitiesTablePtr	xmlCreateEntitiesTable	(void)

-
create and initialize an empty entities hash table.

-
Returns:the xmlEntitiesTablePtr just created 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)

+
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: 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: xmlCopyEntitiesTable
xmlEntitiesTablePtr	xmlCopyEntitiesTable	(xmlEntitiesTablePtr table)

+
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: xmlCleanupPredefinedEntities
void	xmlCleanupPredefinedEntities	(void)

+
Cleanup up the predefined entities table. Deprecated call

+
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: xmlFreeEntitiesTable
void	xmlFreeEntitiesTable		(xmlEntitiesTablePtr table)

-
Deallocate the memory used by an entities hash table.

-
table:An entity table
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)

+
table:An entity table
Returns:the new xmlEntitiesTablePtr or NULL in case of error.
Function: xmlCreateEntitiesTable
xmlEntitiesTablePtr	xmlCreateEntitiesTable	(void)

+
create and initialize an empty entities hash table.

+
Returns:the xmlEntitiesTablePtr just created or NULL in case of error.
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: 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: xmlEncodeEntities
const xmlChar *	xmlEncodeEntities	(xmlDocPtr doc, 
					 const xmlChar * input)

+
buf:An XML buffer.
ent:An entity table
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: xmlGetDocEntity
xmlEntityPtr	xmlGetDocEntity		(xmlDocPtr doc, 
					 const xmlChar * name)

+
doc:the document containing the string
input:A string to convert to XML.
Returns:NULL
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: 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: xmlFreeEntitiesTable
void	xmlFreeEntitiesTable		(xmlEntitiesTablePtr table)

+
Deallocate the memory used by an entities hash table.

+
table:An entity table
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: xmlInitializePredefinedEntities
void	xmlInitializePredefinedEntities	(void)

-
Set up the predefined entities. Deprecated call

-
Function: xmlGetPredefinedEntity
xmlEntityPtr	xmlGetPredefinedEntity	(const xmlChar * name)

+
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: 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: 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: 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
Daniel Veillard

+
name:the entity name
Returns:NULL if not, otherwise the entity
Function: xmlInitializePredefinedEntities
void	xmlInitializePredefinedEntities	(void)

+
Set up the predefined entities. Deprecated call

+
Daniel Veillard

diff --git a/doc/html/libxml-globals.html b/doc/html/libxml-globals.html
index 4e39a592..c909d255 100644
--- a/doc/html/libxml-globals.html
+++ b/doc/html/libxml-globals.html
@@ -72,53 +72,53 @@ void	xmlRegisterNodeFunc		(xmlDeregisterNodeFunc	xmlDeregisterNodeDefaultValue
     xmlMallocFunc	xmlMallocAtomic
     xmlError	xmlLastError
-}
Function: xmlThrDefSetStructuredErrorFunc
void	xmlThrDefSetStructuredErrorFunc	(void * ctx, 
					 xmlStructuredErrorFunc handler)

+}
Function: xmlCleanupGlobals
void	xmlCleanupGlobals		(void)

 

-
ctx:
handler:
Function: xmlCleanupGlobals
void	xmlCleanupGlobals		(void)

+
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 type: xmlDeregisterNodeFunc
Function type: xmlDeregisterNodeFunc
+void	xmlDeregisterNodeFunc		(xmlNodePtr node)
+
node:


+
Function: xmlInitGlobals
void	xmlInitGlobals			(void)

 

-
Function: xmlThrDefRegisterNodeDefault
xmlRegisterNodeFunc	xmlThrDefRegisterNodeDefault	(xmlRegisterNodeFunc func)

-

-
func:
Returns:
Function: xmlInitializeGlobalState
void	xmlInitializeGlobalState	(xmlGlobalStatePtr gs)

+
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: xmlThrDefSetGenericErrorFunc
void	xmlThrDefSetGenericErrorFunc	(void * ctx, 
					 xmlGenericErrorFunc handler)

-

-
ctx:
handler:
Function: xmlThrDefDoValidityCheckingDefaultValue
int	xmlThrDefDoValidityCheckingDefaultValue	(int v)

-

-
v:
Returns:
Function: xmlThrDefPedanticParserDefaultValue
int	xmlThrDefPedanticParserDefaultValue	(int v)

-

-
v:
Returns:
Function: xmlRegisterNodeDefault
xmlRegisterNodeFunc	xmlRegisterNodeDefault	(xmlRegisterNodeFunc func)

+
gs:a pointer to a newly allocated global state
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: xmlThrDefGetWarningsDefaultValue
int	xmlThrDefGetWarningsDefaultValue	(int v)

-

-
v:
Returns:
Function: xmlThrDefDeregisterNodeDefault
xmlDeregisterNodeFunc	xmlThrDefDeregisterNodeDefault	(xmlDeregisterNodeFunc func)

-

-
func:
Returns:
Function: xmlThrDefSubstituteEntitiesDefaultValue
int	xmlThrDefSubstituteEntitiesDefaultValue	(int v)

-

-
v:
Returns:
Function type: xmlRegisterNodeFunc
Function type: xmlRegisterNodeFunc
+
func:function pointer to the new RegisterNodeFunc
Returns:the old value of the registration function
Function type: xmlRegisterNodeFunc
Function type: xmlRegisterNodeFunc
 void	xmlRegisterNodeFunc		(xmlNodePtr node)
 
node:


-
Function: xmlThrDefSaveNoEmptyTags
int	xmlThrDefSaveNoEmptyTags	(int v)

-

-
v:
Returns:
Function: xmlThrDefIndentTreeOutput
int	xmlThrDefIndentTreeOutput	(int v)

+
Function: xmlThrDefBufferAllocScheme
xmlBufferAllocationScheme	xmlThrDefBufferAllocScheme	(xmlBufferAllocationScheme v)

 

 
v:
Returns:
Function: xmlThrDefDefaultBufferSize
int	xmlThrDefDefaultBufferSize	(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: xmlInitGlobals
void	xmlInitGlobals			(void)

+
v:
Returns:
Function: xmlThrDefDeregisterNodeDefault
xmlDeregisterNodeFunc	xmlThrDefDeregisterNodeDefault	(xmlDeregisterNodeFunc func)

 

-
Function: xmlThrDefLoadExtDtdDefaultValue
int	xmlThrDefLoadExtDtdDefaultValue	(int v)

+
func:
Returns:
Function: xmlThrDefDoValidityCheckingDefaultValue
int	xmlThrDefDoValidityCheckingDefaultValue	(int v)

 

-
v:
Returns:
Function: xmlThrDefLineNumbersDefaultValue
int	xmlThrDefLineNumbersDefaultValue	(int v)

+
v:
Returns:
Function: xmlThrDefGetWarningsDefaultValue
int	xmlThrDefGetWarningsDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlThrDefIndentTreeOutput
int	xmlThrDefIndentTreeOutput	(int v)

 

 
v:
Returns:
Function: xmlThrDefKeepBlanksDefaultValue
int	xmlThrDefKeepBlanksDefaultValue	(int v)

 

-
v:
Returns:
Function type: xmlDeregisterNodeFunc
Function type: xmlDeregisterNodeFunc
-void	xmlDeregisterNodeFunc		(xmlNodePtr node)
-
node:


-
Function: xmlThrDefParserDebugEntities
int	xmlThrDefParserDebugEntities	(int v)

+
v:
Returns:
Function: xmlThrDefLineNumbersDefaultValue
int	xmlThrDefLineNumbersDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlThrDefLoadExtDtdDefaultValue
int	xmlThrDefLoadExtDtdDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlThrDefParserDebugEntities
int	xmlThrDefParserDebugEntities	(int v)

+

+
v:
Returns:
Function: xmlThrDefPedanticParserDefaultValue
int	xmlThrDefPedanticParserDefaultValue	(int v)

+

+
v:
Returns:
Function: xmlThrDefRegisterNodeDefault
xmlRegisterNodeFunc	xmlThrDefRegisterNodeDefault	(xmlRegisterNodeFunc func)

+

+
func:
Returns:
Function: xmlThrDefSaveNoEmptyTags
int	xmlThrDefSaveNoEmptyTags	(int v)

+

+
v:
Returns:
Function: xmlThrDefSetGenericErrorFunc
void	xmlThrDefSetGenericErrorFunc	(void * ctx, 
					 xmlGenericErrorFunc handler)

+

+
ctx:
handler:
Function: xmlThrDefSetStructuredErrorFunc
void	xmlThrDefSetStructuredErrorFunc	(void * ctx, 
					 xmlStructuredErrorFunc handler)

+

+
ctx:
handler:
Function: xmlThrDefSubstituteEntitiesDefaultValue
int	xmlThrDefSubstituteEntitiesDefaultValue	(int v)

 

 
v:
Returns:
Function: xmlThrDefTreeIndentString
const char *	xmlThrDefTreeIndentString	(const char * v)

 

diff --git a/doc/html/libxml-hash.html b/doc/html/libxml-hash.html
index a850040b..cebc45aa 100644
--- a/doc/html/libxml-hash.html
+++ b/doc/html/libxml-hash.html
@@ -51,62 +51,62 @@ void	xmlHashScannerFull		(void * payload, 
Description
 
Structure xmlHashTable
Structure xmlHashTable
struct _xmlHashTable {
 The content of this structure is not made public by the API.
-}
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
Function type: xmlHashDeallocator
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
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


+}
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.
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: 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 type: xmlHashCopier
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.


 
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)

+
table:the hash table
f:the copier function for items in the hash
Returns:the new table or NULL in case of error.
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 type: xmlHashDeallocator
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: 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: 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: 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)

+
table:the hash table
name:the name of the userdata
name2:a second name of the userdata
Returns:the pointer to the userdata
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: 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: 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: 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: 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)

+
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: 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: 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: 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
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
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 type: xmlHashScanner
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


-
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.
Function type: xmlHashCopier
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.


-
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: 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: 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: 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)

+
Function type: xmlHashScannerFull
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


+
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

+
table:the hash table
Returns:the number of elements in the hash table or -1 in case of error
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: 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: 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.
Daniel Veillard

diff --git a/doc/html/libxml-list.html b/doc/html/libxml-list.html
index 2af621f6..14a51c96 100644
--- a/doc/html/libxml-list.html
+++ b/doc/html/libxml-list.html
@@ -56,65 +56,65 @@ int	xmlListWalker			(const void * data, 

 The content of this structure is not made public by the API.
 }
Structure xmlList
Structure xmlList
struct _xmlList {
 The content of this structure is not made public by the API.
-}
Function type: xmlListWalker
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.


-
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: 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)

+}
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: 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
Function type: xmlListDeallocator
Function type: xmlListDeallocator
-void	xmlListDeallocator		(xmlLinkPtr lk)
-
Callback function used to free data from a list.
lk:the data to deallocate


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

+
lk:a link
Returns:a pointer to the data referenced from this link
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: xmlListReverse
void	xmlListReverse			(xmlListPtr l)

-
Reverse the order of the elements in the list

-
l:a list
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 type: xmlListDataCompare
Function type: xmlListDataCompare
+
l:a list
data:the data
Returns:0 in case of success, 1 in case of failure
Function: xmlListClear
void	xmlListClear			(xmlListPtr l)

+
Remove the all data in the list

+
l:a list
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: 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 type: xmlListDataCompare
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.


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

+
Function type: xmlListDeallocator
Function type: xmlListDeallocator
+void	xmlListDeallocator		(xmlLinkPtr lk)
+
Callback function used to free data from a list.
lk:the data to deallocate


+
Function: xmlListDelete
void	xmlListDelete			(xmlListPtr l)

+
Deletes the list and its associated data

+
l:a list
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: xmlListEmpty
int	xmlListEmpty			(xmlListPtr l)

+
Is the list empty ?

+
l:a list
Returns:1 if the list is empty, 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)

+
l:a list
Returns:the last element in the list, or NULL
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: 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: 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
Function: xmlListPopBack
void	xmlListPopBack			(xmlListPtr l)

 
Removes the last element in the list

+
l:a list
Function: xmlListPopFront
void	xmlListPopFront			(xmlListPtr l)

+
Removes the first 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
data:new data
Returns:1 if successful, 0 otherwise
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: 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: 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: 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: xmlListReverse
void	xmlListReverse			(xmlListPtr l)

+
Reverse the order of the elements in the list

 
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)

+
l:a list
data:a search value
Returns:the value associated to @data or NULL in case of error
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: 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
Daniel Veillard

+
l:a list
data:a search value
Returns:the value associated to @data or NULL in case of error
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: xmlListSort
void	xmlListSort			(xmlListPtr l)

+
Sort all the elements in the list

+
l:a list
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 type: xmlListWalker
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.


+
Daniel Veillard

diff --git a/doc/html/libxml-nanoftp.html b/doc/html/libxml-nanoftp.html
index 15f8d888..9208e50c 100644
--- a/doc/html/libxml-nanoftp.html
+++ b/doc/html/libxml-nanoftp.html
@@ -39,54 +39,54 @@ void	ftpListCallback			(void * userData, 

 
void	xmlNanoFTPScanProxy		(const char * URL)

 
int	xmlNanoFTPUpdateURL		(void * ctx, 
					 const char * URL)

 
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
Function type: ftpDataCallback
Function type: ftpDataCallback
+
Function type: ftpDataCallback
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


-
Function: xmlNanoFTPGetResponse
int	xmlNanoFTPGetResponse		(void * ctx)

-
Get the response from the FTP server after a command.

-
ctx:an FTP context
Returns:the code number
Function type: ftpListCallback
Function type: ftpListCallback
+
Function type: ftpListCallback
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


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

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

+
ctx:an FTP context
Returns:the code number, or 0
Function: xmlNanoFTPCleanup
void	xmlNanoFTPCleanup		(void)

 
Cleanup the FTP protocol layer. This cleanup proxy informations.

-
Function: xmlNanoFTPGetConnection
int	xmlNanoFTPGetConnection		(void * ctx)

+
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
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: xmlNanoFTPConnect
int	xmlNanoFTPConnect		(void * ctx)

+
Tries to open a control connection

+
ctx:an FTP context
Returns:-1 in case of error, 0 otherwise
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: 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: 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: xmlNanoFTPFreeCtxt
void	xmlNanoFTPFreeCtxt		(void * ctx)

+
Frees the context after closing the connection.

+
ctx:an FTP context
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: 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

+
ctx:an FTP context
Returns:-1 incase of error, 0 otherwise
Function: xmlNanoFTPGetResponse
int	xmlNanoFTPGetResponse		(void * ctx)

+
Get the response from the FTP server after a command.

+
ctx:an FTP context
Returns:the code number
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: xmlNanoFTPInit
void	xmlNanoFTPInit			(void)

+
Initialize the FTP protocol layer. Currently it just checks for proxy informations, and get the hostname

+
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: 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: 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: 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: 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: 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: 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: 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).
Daniel Veillard

diff --git a/doc/html/libxml-nanohttp.html b/doc/html/libxml-nanohttp.html
index 2a16c373..5404a7af 100644
--- a/doc/html/libxml-nanohttp.html
+++ b/doc/html/libxml-nanohttp.html
@@ -27,36 +27,36 @@ A:link, A:visited, A:active { text-decoration: underline }
 
int	xmlNanoHTTPSave			(void * ctxt, 
					 const char * filename)

 
void	xmlNanoHTTPScanProxy		(const char * URL)

 
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)

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

+
ctx:the HTTP context
Returns:the stashed value of the WWW-Authenticate or Proxy-Authenticate header.
Function: xmlNanoHTTPCleanup
void	xmlNanoHTTPCleanup		(void)

+
Cleanup the HTTP protocol layer.

+
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: 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: 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)

+
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: 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: 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: 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)

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

+
ctx:the HTTP context
Returns:the HTTP return code for the request.
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: 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
Daniel Veillard

diff --git a/doc/html/libxml-parser.html b/doc/html/libxml-parser.html
index cd9949e6..641a5b62 100644
--- a/doc/html/libxml-parser.html
+++ b/doc/html/libxml-parser.html
@@ -202,11 +202,58 @@ void	xmlParserInputDeallocate	(int	xmlSubstituteEntitiesDefault	(int val)

 
Description

 
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.

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

-
Macro: XML_SAX2_MAGIC
#define XML_SAX2_MAGIC
Special constant found in SAX2 blocks initialized fields

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

 
Macro: XML_DEFAULT_VERSION
#define XML_DEFAULT_VERSION
The default version of XML used: 1.0

-
Structure xmlSAXHandlerV1
Structure xmlSAXHandlerV1
struct _xmlSAXHandlerV1 {
+
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.

+
Macro: XML_SAX2_MAGIC
#define XML_SAX2_MAGIC
Special constant found in SAX2 blocks initialized fields

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

+
Enum xmlParserInputState
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
+}
+
Structure xmlParserNodeInfo
Structure xmlParserNodeInfo
struct _xmlParserNodeInfo {
+    const struct _xmlNode *	node	: Position & line # that text that create
+    unsigned long	begin_pos
+    unsigned long	begin_line
+    unsigned long	end_pos
+    unsigned long	end_line
+}
Structure xmlParserNodeInfoSeq
Structure xmlParserNodeInfoSeq
struct _xmlParserNodeInfoSeq {
+    unsigned long	maximum
+    unsigned long	length
+    xmlParserNodeInfo *	buffer
+}
Enum xmlParserOption
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
+}
+
Structure xmlSAXHandlerV1
Structure xmlSAXHandlerV1
struct _xmlSAXHandlerV1 {
     internalSubsetSAXFunc	internalSubset
     isStandaloneSAXFunc	isStandalone
     hasInternalSubsetSAXFunc	hasInternalSubset
@@ -235,319 +282,272 @@ void	xmlParserInputDeallocate	(cdataBlockSAXFunc	cdataBlock
     externalSubsetSAXFunc	externalSubset
     unsigned int	initialized
-}
xmlParserInputState
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
-}
-
xmlParserOption
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
-}
-
Structure xmlParserNodeInfo
Structure xmlParserNodeInfo
struct _xmlParserNodeInfo {
-    const struct _xmlNode *	node	: Position & line # that text that create
-    unsigned long	begin_pos
-    unsigned long	begin_line
-    unsigned long	end_pos
-    unsigned long	end_line
-}
Structure xmlParserNodeInfoSeq
Structure xmlParserNodeInfoSeq
struct _xmlParserNodeInfoSeq {
-    unsigned long	maximum
-    unsigned long	length
-    xmlParserNodeInfo *	buffer
-}
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: 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: 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: 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: 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: 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: 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.
Function type: attributeDeclSAXFunc
Function type: attributeDeclSAXFunc
+}
Function type: attributeDeclSAXFunc
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
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.


-
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.
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
Function type: elementDeclSAXFunc
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


-
Function type: startElementSAXFunc
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
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


-
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: 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: 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: 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: 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: 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
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
Function type: internalSubsetSAXFunc
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)


-
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
Function: xmlNewParserCtxt
xmlParserCtxtPtr	xmlNewParserCtxt	(void)

-
Allocate and initialize a new parser context.

-
Returns:the xmlParserCtxtPtr or NULL
Function type: endDocumentSAXFunc
Function type: endDocumentSAXFunc
-void	endDocumentSAXFunc		(void * ctx)
-
Called when the document end has been detected.
ctx:the user data (XML parser context)


-
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 type: unparsedEntityDeclSAXFunc
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: 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
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
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 type: referenceSAXFunc
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


-
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
Function type: getParameterEntitySAXFunc
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: ignorableWhitespaceSAXFunc
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


-
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: 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: xmlInitNodeInfoSeq
void	xmlInitNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)

-
-- Initialize (set to initial state) node info sequence

-
seq:a node info sequence pointer
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: 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: 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 type: endElementSAXFunc
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


-
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
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: 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: xmlCtxtReset
void	xmlCtxtReset			(xmlParserCtxtPtr ctxt)

-
Reset a parser context

-
ctxt:an XML parser context
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: 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
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: 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: 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: 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.

-
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: 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: 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: 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 type: errorSAXFunc
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


-
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: 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
Function type: xmlExternalEntityLoader
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: startElementNsSAX2Func
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.


-
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
Function type: hasInternalSubsetSAXFunc
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


-
Function type: fatalErrorSAXFunc
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


-
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.
Function type: cdataBlockSAXFunc
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


-
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: 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
Function type: entityDeclSAXFunc
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).


-
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
Function type: xmlParserInputDeallocate
Function type: xmlParserInputDeallocate
-void	xmlParserInputDeallocate	(xmlChar * str)
-
Callback for freeing some parser input allocations.
str:the string to deallocate


-
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: 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: 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 type: processingInstructionSAXFunc
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


-
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: 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: 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: 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: 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: 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: 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: 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.
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 type: notationDeclSAXFunc
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: endElementNsSAX2Func
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: commentSAXFunc
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


-
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 type: attributeSAXFunc
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


-
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 type: hasExternalSubsetSAXFunc
Function type: hasExternalSubsetSAXFunc
+
Function type: cdataBlockSAXFunc
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


+
Function type: charactersSAXFunc
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


+
Function type: commentSAXFunc
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


+
Function type: elementDeclSAXFunc
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


+
Function type: endDocumentSAXFunc
Function type: endDocumentSAXFunc
+void	endDocumentSAXFunc		(void * ctx)
+
Called when the document end has been detected.
ctx:the user data (XML parser context)


+
Function type: endElementNsSAX2Func
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: endElementSAXFunc
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


+
Function type: entityDeclSAXFunc
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).


+
Function type: errorSAXFunc
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


+
Function type: externalSubsetSAXFunc
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: fatalErrorSAXFunc
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


+
Function type: getEntitySAXFunc
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.


+
Function type: getParameterEntitySAXFunc
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: hasExternalSubsetSAXFunc
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


+
Function type: hasInternalSubsetSAXFunc
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


+
Function type: ignorableWhitespaceSAXFunc
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


+
Function type: internalSubsetSAXFunc
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)


 
Function type: isStandaloneSAXFunc
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
Function type: startDocumentSAXFunc
-void	startDocumentSAXFunc		(void * ctx)
-
Called when the document start being processed.
ctx:the user data (XML parser context)


-
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
Function: xmlClearParserCtxt
void	xmlClearParserCtxt		(xmlParserCtxtPtr ctxt)

-
Clear (release owned resources) and reinitialize a parser context

-
ctxt:an XML parser context
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: 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
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
Function type: externalSubsetSAXFunc
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: notationDeclSAXFunc
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: processingInstructionSAXFunc
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


+
Function type: referenceSAXFunc
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


 
Function type: resolveEntitySAXFunc
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.


 
Function type: setDocumentLocatorSAXFunc
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: xmlSetExternalEntityLoader
void	xmlSetExternalEntityLoader	(xmlExternalEntityLoader f)

-
Changes the defaultexternal entity resolver function for the application

-
f:the new entity resolver function
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 type: warningSAXFunc
Function type: warningSAXFunc
+
Function type: startDocumentSAXFunc
Function type: startDocumentSAXFunc
+void	startDocumentSAXFunc		(void * ctx)
+
Called when the document start being processed.
ctx:the user data (XML parser context)


+
Function type: startElementNsSAX2Func
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.


+
Function type: startElementSAXFunc
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: unparsedEntityDeclSAXFunc
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: warningSAXFunc
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


-
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: xmlReadDoc
xmlDocPtr	xmlReadDoc		(const xmlChar * cur, 
					 const char * URL, 
					 const char * encoding, 
					 int options)

+
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: 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: 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: xmlClearNodeInfoSeq
void	xmlClearNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)

+
-- Clear (release memory and reinitialize) node info sequence

+
seq:a node info sequence pointer
Function: xmlClearParserCtxt
void	xmlClearParserCtxt		(xmlParserCtxtPtr ctxt)

+
Clear (release owned resources) and reinitialize a parser context

+
ctxt:an XML parser context
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: 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
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: 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: 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
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: 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: 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
Function: xmlCtxtReset
void	xmlCtxtReset			(xmlParserCtxtPtr ctxt)

+
Reset a parser context

+
ctxt:an XML parser context
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
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 type: xmlExternalEntityLoader
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: 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: xmlGetExternalEntityLoader
xmlExternalEntityLoader	xmlGetExternalEntityLoader	(void)

+
Get the default external entity resolver function for the application

+
Returns:the xmlExternalEntityLoader function pointer
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: 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: 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: xmlInitNodeInfoSeq
void	xmlInitNodeInfoSeq		(xmlParserNodeInfoSeqPtr seq)

+
-- Initialize (set to initial state) node info sequence

+
seq:a node info sequence pointer
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.

+
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
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: 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: 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
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
Function: xmlNewParserCtxt
xmlParserCtxtPtr	xmlNewParserCtxt	(void)

+
Allocate and initialize a new parser context.

+
Returns:the xmlParserCtxtPtr 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: 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: 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: 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: 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.
Function: xmlParseDoc
xmlDocPtr	xmlParseDoc		(xmlChar * cur)

 
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
Daniel Veillard

+
cur:a pointer to an array of xmlChar
Returns:the resulting document tree
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: 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: 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: 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
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: 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: 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
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: 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 type: xmlParserInputDeallocate
Function type: xmlParserInputDeallocate
+void	xmlParserInputDeallocate	(xmlChar * str)
+
Callback for freeing some parser input allocations.
str:the string to deallocate


+
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: 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: 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: 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
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: 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: 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: 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: 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: 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: 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
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.
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: 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: 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
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: 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: 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: 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
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: xmlSetExternalEntityLoader
void	xmlSetExternalEntityLoader	(xmlExternalEntityLoader f)

+
Changes the defaultexternal entity resolver function for the application

+
f:the new entity resolver function
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: 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: xmlStopParser
void	xmlStopParser			(xmlParserCtxtPtr ctxt)

+
Blocks further parser processing

+
ctxt:an XML parser context
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: 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: 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: 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: 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: 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.
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: 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: 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
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: 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: 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
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
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: 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.
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: 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.
Daniel Veillard

diff --git a/doc/html/libxml-parserInternals.html b/doc/html/libxml-parserInternals.html
index 88ef9aed..348ef2ab 100644
--- a/doc/html/libxml-parserInternals.html
+++ b/doc/html/libxml-parserInternals.html
@@ -104,213 +104,213 @@ void	xmlEntityReferenceFunc		(int	xmlSwitchInputEncoding		(xmlParserCtxtPtr ctxt, 
					 xmlParserInputPtr input, 
					 xmlCharEncodingHandlerPtr handler)

 
int	xmlSwitchToEncoding		(xmlParserCtxtPtr ctxt, 
					 xmlCharEncodingHandlerPtr handler)

 
Description

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

-
Macro: IS_EXTENDER_CH
#define IS_EXTENDER_CH
Behaves like IS_EXTENDER but with a single-byte argument

-
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

-
Macro: IS_DIGIT
#define IS_DIGIT
Macro to check the following production in the XML spec: [88] Digit ::= ... long list see REC ...

-
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] | [-'()+,./:=?;!*#@$_%]

-
Macro: XML_SUBSTITUTE_PEREF
#define XML_SUBSTITUTE_PEREF
Whether parameter entities need to be substituted.

-
Macro: MOVETO_ENDTAG
#define MOVETO_ENDTAG
Skips to the next '>' char.

-
Macro: IS_DIGIT_CH
#define IS_DIGIT_CH
Behaves like IS_DIGIT but with a single byte argument

-
Macro: SKIP_EOL
#define SKIP_EOL
Skips the end of line chars.

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

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

-
Macro: IS_COMBINING_CH
#define IS_COMBINING_CH
Always false (all combining chars > 0xff)

-
Macro: IS_PUBIDCHAR_CH
#define IS_PUBIDCHAR_CH
Same as IS_PUBIDCHAR but for single-byte value

-
Macro: IS_LETTER_CH
#define IS_LETTER_CH
Macro behaves like IS_LETTER, but only check base chars

-
Macro: XML_SUBSTITUTE_NONE
#define XML_SUBSTITUTE_NONE
If no entities need to be substituted.

-
Macro: IS_BLANK_CH
#define IS_BLANK_CH
Behaviour same as IS_BLANK

-
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_LETTER
#define IS_LETTER
Macro to check the following production in the XML spec: [84] Letter ::= BaseChar | Ideographic

-
Macro: IS_BASECHAR
#define IS_BASECHAR
Macro to check the following production in the XML spec: [85] BaseChar ::= ... long list see REC ...

 
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.

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

+
Macro: IS_BASECHAR
#define IS_BASECHAR
Macro to check the following production in the XML spec: [85] BaseChar ::= ... long list see REC ...

+
Macro: IS_BLANK
#define IS_BLANK
Macro to check the following production in the XML spec: [3] S ::= (#x20 | #x9 | #xD | #xA)+

+
Macro: IS_BLANK_CH
#define IS_BLANK_CH
Behaviour same as IS_BLANK

+
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

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

 
Macro: IS_CHAR_CH
#define IS_CHAR_CH
Behaves like IS_CHAR on single-byte value

+
Macro: IS_COMBINING
#define IS_COMBINING
Macro to check the following production in the XML spec: [87] CombiningChar ::= ... long list see REC ...

+
Macro: IS_COMBINING_CH
#define IS_COMBINING_CH
Always false (all combining chars > 0xff)

+
Macro: IS_DIGIT
#define IS_DIGIT
Macro to check the following production in the XML spec: [88] Digit ::= ... long list see REC ...

+
Macro: IS_DIGIT_CH
#define IS_DIGIT_CH
Behaves like IS_DIGIT but with a single byte argument

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

+
Macro: IS_EXTENDER_CH
#define IS_EXTENDER_CH
Behaves like IS_EXTENDER but with a single-byte argument

+
Macro: IS_IDEOGRAPHIC
#define IS_IDEOGRAPHIC
Macro to check the following production in the XML spec: [86] Ideographic ::= [#x4E00-#x9FA5] | #x3007 | [#x3021-#x3029]

+
Macro: IS_LETTER
#define IS_LETTER
Macro to check the following production in the XML spec: [84] Letter ::= BaseChar | Ideographic

+
Macro: IS_LETTER_CH
#define IS_LETTER_CH
Macro behaves like IS_LETTER, but only check base chars

+
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] | [-'()+,./:=?;!*#@$_%]

+
Macro: IS_PUBIDCHAR_CH
#define IS_PUBIDCHAR_CH
Same as IS_PUBIDCHAR but for single-byte value

+
Macro: MOVETO_ENDTAG
#define MOVETO_ENDTAG
Skips to the next '>' char.

+
Macro: MOVETO_STARTTAG
#define MOVETO_STARTTAG
Skips to the next '<' char.

+
Macro: SKIP_EOL
#define SKIP_EOL
Skips the end of line chars.

+
Macro: XML_MAX_NAMELEN
#define XML_MAX_NAMELEN
Identifiers can be longer, but this will be more costly at runtime.

 
Macro: XML_SUBSTITUTE_BOTH
#define XML_SUBSTITUTE_BOTH
Both general and parameter entities need to be substituted.

-
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: 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: 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: 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)
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
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: 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
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)

+
Macro: XML_SUBSTITUTE_NONE
#define XML_SUBSTITUTE_NONE
If no entities need to be substituted.

+
Macro: XML_SUBSTITUTE_PEREF
#define XML_SUBSTITUTE_PEREF
Whether parameter entities need to be substituted.

+
Macro: XML_SUBSTITUTE_REF
#define XML_SUBSTITUTE_REF
Whether general entities need to be substituted.

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

-
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: 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: inputPush
int	inputPush			(xmlParserCtxtPtr ctxt, 
					 xmlParserInputPtr value)

+
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: 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)

+
ctxt:an XML parser context
value:the parser input
Returns:0 in case of error, the index in the stack otherwise
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.
Function: xmlParseContent
void	xmlParseContent			(xmlParserCtxtPtr ctxt)

-
Parse a content: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

-
ctxt:an XML parser context
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
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
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
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: 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: 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: 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: 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)

+
ctxt:an XML parser context
Returns:the name just removed
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: 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: 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: 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: 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: 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: 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: 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
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
Function type: xmlEntityReferenceFunc
Function type: xmlEntityReferenceFunc
+
filename:the filename
Returns:the new parser context or NULL
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: 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: 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: 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 type: xmlEntityReferenceFunc
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


-
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.
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
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: 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
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
Function: xmlErrMemory
void	xmlErrMemory			(xmlParserCtxtPtr ctxt, 
					 const char * extra)

+
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: 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
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: 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: 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)

+
ctxt:an XML parser context
extra:extra informations
Function: xmlFreeInputStream
void	xmlFreeInputStream		(xmlParserInputPtr input)

 
Free up an input stream.

-
input:an xmlParserInputPtr
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.

+
input:an xmlParserInputPtr
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: 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: 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: 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: 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: 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: 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: xmlNewInputStream
xmlParserInputPtr	xmlNewInputStream	(xmlParserCtxtPtr ctxt)

+
Create a new input stream structure

+
ctxt:an XML parser context
Returns:the new input stream or NULL
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: xmlNextChar
void	xmlNextChar			(xmlParserCtxtPtr ctxt)

+
Skip to the next char input char.

+
ctxt:the XML parser context
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: 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: 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: 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: 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: 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
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: 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: xmlParseContent
void	xmlParseContent			(xmlParserCtxtPtr ctxt)

+
Parse a content: [43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*

 
ctxt:an XML parser context
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.
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
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: 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: xmlNextChar
void	xmlNextChar			(xmlParserCtxtPtr ctxt)

-
Skip to the next char input char.

-
ctxt:the XML parser context
Function: xmlParseEnumerationType
xmlEnumerationPtr	xmlParseEnumerationType	(xmlParserCtxtPtr ctxt)

+
ctxt:an XML parser context
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
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: 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
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: 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: 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: 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: 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: 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
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: 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: 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
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: 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
Returns:the enumeration attribute tree built while parsing
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: 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)
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: xmlParseMisc
void	xmlParseMisc			(xmlParserCtxtPtr ctxt)

+
parse an XML Misc* optional field. [27] Misc ::= Comment | PI | S

+
ctxt:an XML parser context
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: 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
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
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: 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: 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: 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: 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: xmlParseStartTag
const xmlChar *	xmlParseStartTag	(xmlParserCtxtPtr ctxt)

+
ctxt:an XML parser context
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
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: 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.
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: 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: 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: xmlParseSystemLiteral
xmlChar *	xmlParseSystemLiteral	(xmlParserCtxtPtr ctxt)

 
parse an XML Literal [11] SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'")

-
ctxt:an XML parser context
Returns:the SystemLiteral parsed or NULL
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

+
ctxt:an XML parser context
Returns:the SystemLiteral parsed or NULL
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: 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: 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: xmlParseXMLDecl
void	xmlParseXMLDecl			(xmlParserCtxtPtr ctxt)

+
parse an XML declaration header [23] XMLDecl ::= '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'

+
ctxt:an XML parser context
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: 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: xmlParserInputShrink
void	xmlParserInputShrink		(xmlParserInputPtr in)

+
This function removes used input for the parser.

+
in:an XML parser input
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: 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: 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: xmlSetEntityReferenceFunc
void	xmlSetEntityReferenceFunc	(xmlEntityReferenceFunc func)

+
Set the function to call call back when a xml reference has been made

+
func:A valid function
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
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.
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
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: 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: 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: 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
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
Daniel Veillard

diff --git a/doc/html/libxml-relaxng.html b/doc/html/libxml-relaxng.html
index 73b4894b..842d1cd8 100644
--- a/doc/html/libxml-relaxng.html
+++ b/doc/html/libxml-relaxng.html
@@ -51,7 +51,9 @@ void	xmlRelaxNGValidityWarningFunc
 The content of this structure is not made public by the API.
 }
Structure xmlRelaxNGParserCtxt
Structure xmlRelaxNGParserCtxt
struct _xmlRelaxNGParserCtxt {
 The content of this structure is not made public by the API.
-}
xmlRelaxNGValidErr
Enum xmlRelaxNGValidErr {
+}
Structure xmlRelaxNGValidCtxt
Structure xmlRelaxNGValidCtxt
struct _xmlRelaxNGValidCtxt {
+The content of this structure is not made public by the API.
+}
Enum xmlRelaxNGValidErr
Enum xmlRelaxNGValidErr {
     XML_RELAXNG_OK = 0
     XML_RELAXNG_ERR_MEMORY = 1
     XML_RELAXNG_ERR_TYPE = 2
@@ -93,52 +95,50 @@ The content of this structure is not made public by the API.
     XML_RELAXNG_ERR_ELEMWRONG = 38
     XML_RELAXNG_ERR_TEXTWRONG = 39
 }
-
Structure xmlRelaxNGValidCtxt
Structure xmlRelaxNGValidCtxt
struct _xmlRelaxNGValidCtxt {
-The content of this structure is not made public by the API.
-}
Function: xmlRelaxNGFreeValidCtxt
void	xmlRelaxNGFreeValidCtxt		(xmlRelaxNGValidCtxtPtr ctxt)

-
Free the resources associated to the schema validation context

-
ctxt:the schema validation context
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: 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: 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: 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: xmlRelaxNGFree
void	xmlRelaxNGFree			(xmlRelaxNGPtr schema)

-
Deallocate a RelaxNG structure.

-
schema:a schema structure
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: 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: 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: xmlRelaxNGFreeParserCtxt
void	xmlRelaxNGFreeParserCtxt	(xmlRelaxNGParserCtxtPtr ctxt)

-
Free the resources associated to the schema parser context

-
ctxt:the schema parser 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: 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: 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: 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: xmlRelaxNGDump
void	xmlRelaxNGDump			(FILE * output, 
					 xmlRelaxNGPtr schema)

+
Function: xmlRelaxNGCleanupTypes
void	xmlRelaxNGCleanupTypes		(void)

+
Cleanup the default Schemas type library associated to RelaxNG

+
Function: xmlRelaxNGDump
void	xmlRelaxNGDump			(FILE * output, 
					 xmlRelaxNGPtr schema)

 
Dump a RelaxNG structure back

-
output:the file output
schema:a schema structure
Function type: xmlRelaxNGValidityErrorFunc
Function type: xmlRelaxNGValidityErrorFunc
+
output:the file output
schema:a schema structure
Function: xmlRelaxNGDumpTree
void	xmlRelaxNGDumpTree		(FILE * output, 
					 xmlRelaxNGPtr schema)

+
Dump the transformed RelaxNG tree.

+
output:the file output
schema:a schema structure
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: xmlRelaxNGFreeValidCtxt
void	xmlRelaxNGFreeValidCtxt		(xmlRelaxNGValidCtxtPtr ctxt)

+
Free the resources associated to the schema validation context

+
ctxt:the schema validation context
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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
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 type: xmlRelaxNGValidityErrorFunc
Function type: xmlRelaxNGValidityErrorFunc
 void	xmlRelaxNGValidityErrorFunc	(void * ctx, 
					 const char * msg, 
					 ... ...)
 
ctx:
msg:
...:


-
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: xmlRelaxNGDumpTree
void	xmlRelaxNGDumpTree		(FILE * output, 
					 xmlRelaxNGPtr schema)

-
Dump the transformed RelaxNG tree.

-
output:the file output
schema:a schema structure
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: xmlRelaxNGCleanupTypes
void	xmlRelaxNGCleanupTypes		(void)

-
Cleanup the default Schemas type library associated to RelaxNG

-
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
Function type: xmlRelaxNGValidityWarningFunc
Function type: xmlRelaxNGValidityWarningFunc
+
Function type: xmlRelaxNGValidityWarningFunc
Function type: xmlRelaxNGValidityWarningFunc
 void	xmlRelaxNGValidityWarningFunc	(void * ctx, 
					 const char * msg, 
					 ... ...)
 
ctx:
msg:
...:


 
Daniel Veillard

diff --git a/doc/html/libxml-schemasInternals.html b/doc/html/libxml-schemasInternals.html
index 340d9ea6..184fa733 100644
--- a/doc/html/libxml-schemasInternals.html
+++ b/doc/html/libxml-schemasInternals.html
@@ -31,24 +31,42 @@ The content of this structure is not made public by the API.
 
Typedef xmlSchemaVal * xmlSchemaValPtr
 
void	xmlSchemaFreeType		(xmlSchemaTypePtr type)

 
Description

-
Macro: XML_SCHEMAS_FACET_UNKNOWN
#define XML_SCHEMAS_FACET_UNKNOWN
unknown facet handling

 
Macro: XML_SCHEMAS_ANYATTR_LAX
#define XML_SCHEMAS_ANYATTR_LAX

-
Macro: XML_SCHEMAS_ELEM_TOPLEVEL
#define XML_SCHEMAS_ELEM_TOPLEVEL
the element is top level

-
Macro: XML_SCHEMAS_ELEM_ABSTRACT
#define XML_SCHEMAS_ELEM_ABSTRACT
the element is abstract

-
Macro: XML_SCHEMAS_ANYATTR_STRICT
#define XML_SCHEMAS_ANYATTR_STRICT

-
Macro: XML_SCHEMAS_QUALIF_ATTR
#define XML_SCHEMAS_QUALIF_ATTR
the shemas requires qualified attributes

-
Macro: XML_SCHEMAS_ELEM_FIXED
#define XML_SCHEMAS_ELEM_FIXED
the element has a fixed value

-
Macro: XML_SCHEMAS_FACET_COLLAPSE
#define XML_SCHEMAS_FACET_COLLAPSE
collapse the types of the facet

-
Macro: XML_SCHEMAS_QUALIF_ELEM
#define XML_SCHEMAS_QUALIF_ELEM
the shemas requires qualified elements

-
Macro: XML_SCHEMAS_ELEM_GLOBAL
#define XML_SCHEMAS_ELEM_GLOBAL
the element is global

-
Macro: XML_SCHEMAS_TYPE_MIXED
#define XML_SCHEMAS_TYPE_MIXED
the element content type is mixed

 
Macro: XML_SCHEMAS_ANYATTR_SKIP
#define XML_SCHEMAS_ANYATTR_SKIP

+
Macro: XML_SCHEMAS_ANYATTR_STRICT
#define XML_SCHEMAS_ANYATTR_STRICT

+
Macro: XML_SCHEMAS_ELEM_ABSTRACT
#define XML_SCHEMAS_ELEM_ABSTRACT
the element is abstract

 
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

-
Macro: XML_SCHEMAS_FACET_PRESERVE
#define XML_SCHEMAS_FACET_PRESERVE
preserve the type of the facet

-
Macro: XML_SCHEMAS_ELEM_REF
#define XML_SCHEMAS_ELEM_REF
the element is a reference to a type

+
Macro: XML_SCHEMAS_ELEM_FIXED
#define XML_SCHEMAS_ELEM_FIXED
the element has a fixed value

+
Macro: XML_SCHEMAS_ELEM_GLOBAL
#define XML_SCHEMAS_ELEM_GLOBAL
the element is global

 
Macro: XML_SCHEMAS_ELEM_NILLABLE
#define XML_SCHEMAS_ELEM_NILLABLE
the element is nillable

-
Structure xmlSchemaAttributeGroup
Structure xmlSchemaAttributeGroup
struct _xmlSchemaAttributeGroup {
+
Macro: XML_SCHEMAS_ELEM_REF
#define XML_SCHEMAS_ELEM_REF
the element is a reference to a type

+
Macro: XML_SCHEMAS_ELEM_TOPLEVEL
#define XML_SCHEMAS_ELEM_TOPLEVEL
the element is top level

+
Macro: XML_SCHEMAS_FACET_COLLAPSE
#define XML_SCHEMAS_FACET_COLLAPSE
collapse the types of the facet

+
Macro: XML_SCHEMAS_FACET_PRESERVE
#define XML_SCHEMAS_FACET_PRESERVE
preserve the type of the facet

+
Macro: XML_SCHEMAS_FACET_REPLACE
#define XML_SCHEMAS_FACET_REPLACE
replace the type of the facet

+
Macro: XML_SCHEMAS_FACET_UNKNOWN
#define XML_SCHEMAS_FACET_UNKNOWN
unknown facet handling

+
Macro: XML_SCHEMAS_QUALIF_ATTR
#define XML_SCHEMAS_QUALIF_ATTR
the shemas requires qualified attributes

+
Macro: XML_SCHEMAS_QUALIF_ELEM
#define XML_SCHEMAS_QUALIF_ELEM
the shemas requires qualified elements

+
Macro: XML_SCHEMAS_TYPE_MIXED
#define XML_SCHEMAS_TYPE_MIXED
the element content type is mixed

+
Structure xmlSchemaAnnot
Structure xmlSchemaAnnot
struct _xmlSchemaAnnot {
+    struct _xmlSchemaAnnot *	next
+    xmlNodePtr	content	: the annotation
+}
Structure xmlSchemaAttribute
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 xmlSchemaAttributeGroup
Structure xmlSchemaAttributeGroup
struct _xmlSchemaAttributeGroup {
     xmlSchemaTypeType	type	: The kind of type
     struct _xmlSchemaAttribute *	next	: the next attribute if in a group ...
     xmlChar *	name
@@ -58,7 +76,17 @@ The content of this structure is not made public by the API.
     xmlSchemaAnnotPtr	annot
     xmlSchemaAttributePtr	attributes
     xmlNodePtr	node
-}
Structure xmlSchemaElement
Structure xmlSchemaElement
struct _xmlSchemaElement {
+}
Enum 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
+}
+
Structure xmlSchemaElement
Structure xmlSchemaElement
struct _xmlSchemaElement {
     xmlSchemaTypeType	type	: The kind of type
     struct _xmlSchemaType *	next	: the next type if in a sequence ...
     xmlChar *	name
@@ -93,6 +121,11 @@ The content of this structure is not made public by the API.
     int	whitespace
     xmlSchemaValPtr	val
     xmlRegexpPtr	regexp
+}
Structure xmlSchemaNotation
Structure xmlSchemaNotation
struct _xmlSchemaNotation {
+    xmlSchemaTypeType	type	: The kind of type
+    xmlChar *	name
+    xmlSchemaAnnotPtr	annot
+    xmlChar *	identifier
 }
Structure xmlSchemaType
Structure xmlSchemaType
struct _xmlSchemaType {
     xmlSchemaTypeType	type	: The kind of type
     struct _xmlSchemaType *	next	: the next type if in a sequence ...
@@ -112,17 +145,7 @@ The content of this structure is not made public by the API.
     xmlChar *	baseNs
     xmlSchemaTypePtr	baseType
     xmlSchemaFacetPtr	facets
-}
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
-}
-
xmlSchemaTypeType
Enum xmlSchemaTypeType {
+}
Enum xmlSchemaTypeType
Enum xmlSchemaTypeType {
     XML_SCHEMA_TYPE_BASIC = 1
     XML_SCHEMA_TYPE_ANY = 2
     XML_SCHEMA_TYPE_FACET = 3
@@ -156,30 +179,7 @@ The content of this structure is not made public by the API.
     XML_SCHEMA_FACET_MAXLENGTH = 1010
     XML_SCHEMA_FACET_MINLENGTH = 1011
 }
-
Structure xmlSchemaAttribute
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 xmlSchemaNotation
Structure xmlSchemaNotation
struct _xmlSchemaNotation {
-    xmlSchemaTypeType	type	: The kind of type
-    xmlChar *	name
-    xmlSchemaAnnotPtr	annot
-    xmlChar *	identifier
-}
Structure xmlSchemaAnnot
Structure xmlSchemaAnnot
struct _xmlSchemaAnnot {
-    struct _xmlSchemaAnnot *	next
-    xmlNodePtr	content	: the annotation
-}
Structure xmlSchemaVal
Structure xmlSchemaVal
struct _xmlSchemaVal {
+
Structure xmlSchemaVal
Structure xmlSchemaVal
struct _xmlSchemaVal {
 The content of this structure is not made public by the API.
 }
Function: xmlSchemaFreeType
void	xmlSchemaFreeType		(xmlSchemaTypePtr type)

 
Deallocate a Schema Type structure.

diff --git a/doc/html/libxml-threads.html b/doc/html/libxml-threads.html
index a0d8dada..520e59ed 100644
--- a/doc/html/libxml-threads.html
+++ b/doc/html/libxml-threads.html
@@ -36,34 +36,34 @@ The content of this structure is not made public by the API.
 The content of this structure is not made public by the API.
 }
Structure xmlRMutex
Structure xmlRMutex
struct _xmlRMutex {
 The content of this structure is not made public by the API.
-}
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)

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

+
Function: xmlFreeMutex
void	xmlFreeMutex			(xmlMutexPtr tok)

+
xmlFreeMutex() is used to reclaim resources associated with a libxml2 token struct.

+
tok:the simple mutex
Function: xmlFreeRMutex
void	xmlFreeRMutex			(xmlRMutexPtr tok)

+
xmlRFreeMutex() is used to reclaim resources associated with a reentrant mutex.

 
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: xmlRMutexLock
void	xmlRMutexLock			(xmlRMutexPtr tok)

-
xmlRMutexLock() is used to lock a libxml2 token_r.

-
tok:the reentrant mutex
Function: xmlInitThreads
void	xmlInitThreads			(void)

+
Returns:the thread global state or NULL in case of error
Function: xmlGetThreadId
int	xmlGetThreadId			(void)

+
xmlGetThreadId() find the current thread ID number

+
Returns:the current thread ID number
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)

+
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: xmlLockLibrary
void	xmlLockLibrary			(void)

 
xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 library.

+
Function: xmlMutexLock
void	xmlMutexLock			(xmlMutexPtr tok)

+
xmlMutexLock() is used to lock a libxml2 token.

+
tok:the simple mutex
Function: xmlMutexUnlock
void	xmlMutexUnlock			(xmlMutexPtr tok)

+
xmlMutexUnlock() is used to unlock a libxml2 token.

+
tok:the simple mutex
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: 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: xmlRMutexLock
void	xmlRMutexLock			(xmlRMutexPtr tok)

+
xmlRMutexLock() is used to lock a libxml2 token_r.

+
tok:the reentrant mutex
Function: xmlRMutexUnlock
void	xmlRMutexUnlock			(xmlRMutexPtr tok)

+
xmlRMutexUnlock() is used to unlock a libxml2 token_r.

+
tok:the reentrant mutex
Function: xmlUnlockLibrary
void	xmlUnlockLibrary		(void)

+
xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 library.

 
Daniel Veillard

diff --git a/doc/html/libxml-tree.html b/doc/html/libxml-tree.html
index 8d7df3b1..0188bda2 100644
--- a/doc/html/libxml-tree.html
+++ b/doc/html/libxml-tree.html
@@ -203,100 +203,51 @@ A:link, A:visited, A:active { text-decoration: underline }
 
int	xmlValidateName			(const xmlChar * value, 
					 int space)

 
int	xmlValidateQName		(const xmlChar * value, 
					 int space)

 
Description

-
Macro: XML_LOCAL_NAMESPACE
#define XML_LOCAL_NAMESPACE
A namespace declaration node.

 
Macro: BAD_CAST
#define BAD_CAST
Macro to cast a string to an xmlChar * when one know its safe.

-
Macro: XML_GET_CONTENT
#define XML_GET_CONTENT
Macro to extract the content pointer of a node.

 
Macro: BASE_BUFFER_SIZE
#define BASE_BUFFER_SIZE
default buffer size 4000.

+
Macro: XML_GET_CONTENT
#define XML_GET_CONTENT
Macro to extract the content pointer of a node.

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

+
Macro: XML_LOCAL_NAMESPACE
#define XML_LOCAL_NAMESPACE
A namespace declaration node.

+
Macro: XML_XML_NAMESPACE
#define XML_XML_NAMESPACE
This is the namespace for the special xml: prefix predefined in the XML Namespace specification.

 
Macro: xmlChildrenNode
#define xmlChildrenNode
Macro for compatibility naming layer with libxml1.

 
Macro: xmlRootNode
#define xmlRootNode
Macro for compatibility naming layer with libxml1.

-
Macro: XML_XML_NAMESPACE
#define XML_XML_NAMESPACE
This is the namespace for the special xml: prefix predefined in the XML Namespace specification.

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

-
Structure xmlNs
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
+
Structure xmlAttr
Structure xmlAttr
struct _xmlAttr {
     void *	_private	: application data
-}
Structure xmlBuffer
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
-}
Structure xmlParserInput
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 equa
-    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
-}
Structure xmlElement
Structure xmlElement
struct _xmlElement {
+    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
+}
Structure xmlAttribute
Structure xmlAttribute
struct _xmlAttribute {
     void *	_private	: application data
-    xmlElementType	type	: XML_ELEMENT_DECL, must be second !
-    const xmlChar *	name	: Element name
+    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
-    xmlElementTypeVal	etype	: The type
-    xmlElementContentPtr	content	: the allowed element content
-    xmlAttributePtr	attributes	: List of the declared attributes
+    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
-    xmlRegexpPtr	contModel	: the validating regexp
-    void *	contModel
-}
xmlElementType
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
+    const xmlChar *	elem	: Element holding the attribute
+}
Enum xmlAttributeDefault
Enum xmlAttributeDefault {
+    XML_ATTRIBUTE_NONE = 1
+    XML_ATTRIBUTE_REQUIRED = 2
+    XML_ATTRIBUTE_IMPLIED = 3
+    XML_ATTRIBUTE_FIXED = 4
 }
-
xmlBufferAllocationScheme
Enum xmlBufferAllocationScheme {
-    XML_BUFFER_ALLOC_DOUBLEIT = 1
-    XML_BUFFER_ALLOC_EXACT = 2
-    XML_BUFFER_ALLOC_IMMUTABLE = 3
-}
-
Structure xmlElementContent
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
-}
Structure xmlRef
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 availabl
-}
xmlAttributeType
Enum xmlAttributeType {
+
Enum xmlAttributeType
Enum xmlAttributeType {
     XML_ATTRIBUTE_CDATA = 1
     XML_ATTRIBUTE_ID = 2
     XML_ATTRIBUTE_IDREF = 3
@@ -308,33 +259,17 @@ A:link, A:visited, A:active { text-decoration: underline }
     XML_ATTRIBUTE_ENUMERATION = 9
     XML_ATTRIBUTE_NOTATION = 10
 }
-
Structure xmlParserInputBuffer
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=compres
-    int	error
-}
Structure xmlNode
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 p
-    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
-}
Structure xmlDoc
Structure xmlDoc
struct _xmlDoc {
+
Structure xmlBuffer
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
+}
Enum xmlBufferAllocationScheme
Enum xmlBufferAllocationScheme {
+    XML_BUFFER_ALLOC_DOUBLEIT = 1
+    XML_BUFFER_ALLOC_EXACT = 2
+    XML_BUFFER_ALLOC_IMMUTABLE = 3
+}
+
Structure xmlDoc
Structure xmlDoc
struct _xmlDoc {
     void *	_private	: application data
     xmlElementType	type	: XML_DOCUMENT_NODE, must be second !
     char *	name	: name/filename/URI of the document
@@ -357,6 +292,154 @@ A:link, A:visited, A:active { text-decoration: underline }
     int	charset	: encoding of the in-memory content actua
     struct _xmlDict *	dict	: dict used to allocate names or NULL
     void *	psvi	: for type/PSVI informations
+}
Structure xmlDtd
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 p
+    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
+}
Structure xmlElement
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
+}
Structure xmlElementContent
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
+}
Enum xmlElementContentOccur
Enum xmlElementContentOccur {
+    XML_ELEMENT_CONTENT_ONCE = 1
+    XML_ELEMENT_CONTENT_OPT = 2
+    XML_ELEMENT_CONTENT_MULT = 3
+    XML_ELEMENT_CONTENT_PLUS = 4
+}
+
Enum xmlElementContentType
Enum xmlElementContentType {
+    XML_ELEMENT_CONTENT_PCDATA = 1
+    XML_ELEMENT_CONTENT_ELEMENT = 2
+    XML_ELEMENT_CONTENT_SEQ = 3
+    XML_ELEMENT_CONTENT_OR = 4
+}
+
Enum xmlElementType
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
+}
+
Enum xmlElementTypeVal
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
+}
+
Structure xmlEntity
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
+}
Structure xmlEnumeration
Structure xmlEnumeration
struct _xmlEnumeration {
+    struct _xmlEnumeration *	next	: next one
+    const xmlChar *	name	: Enumeration name
+}
Structure xmlID
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 availabl
+    struct _xmlDoc *	doc	: The document holding the ID
+}
Structure xmlNode
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 p
+    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
+}
Structure xmlNotation
Structure xmlNotation
struct _xmlNotation {
+    const xmlChar *	name	: Notation name
+    const xmlChar *	PublicID	: Public identifier, if any
+    const xmlChar *	SystemID	: System identifier, if any
+}
Structure xmlNs
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
+}
Structure xmlOutputBuffer
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 ISOLat
+    xmlBufferPtr	conv	: if encoder != NULL buffer for output
+    int	written	: total number of byte written
+    int	error
 }
Structure xmlParserCtxt
Structure xmlParserCtxt
struct _xmlParserCtxt {
     struct _xmlSAXHandler *	sax	: The SAX handler
     void *	userData	: For SAX interface only, used by DOM bui
@@ -438,78 +521,38 @@ A:link, A:visited, A:active { text-decoration: underline }
     int	freeAttrsNr	: number of freed attributes nodes
     xmlAttrPtr	freeAttrs	: * the complete error informations for th
     xmlError	lastError
-}
xmlAttributeDefault
Enum xmlAttributeDefault {
-    XML_ATTRIBUTE_NONE = 1
-    XML_ATTRIBUTE_REQUIRED = 2
-    XML_ATTRIBUTE_IMPLIED = 3
-    XML_ATTRIBUTE_FIXED = 4
-}
-
Structure xmlNotation
Structure xmlNotation
struct _xmlNotation {
-    const xmlChar *	name	: Notation name
-    const xmlChar *	PublicID	: Public identifier, if any
-    const xmlChar *	SystemID	: System identifier, if any
-}
Structure xmlEntity
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
-}
Structure xmlAttr
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
-}
xmlElementTypeVal
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
-}
-
xmlElementContentOccur
Enum xmlElementContentOccur {
-    XML_ELEMENT_CONTENT_ONCE = 1
-    XML_ELEMENT_CONTENT_OPT = 2
-    XML_ELEMENT_CONTENT_MULT = 3
-    XML_ELEMENT_CONTENT_PLUS = 4
-}
-
Structure xmlID
Structure xmlID
struct _xmlID {
-    struct _xmlID *	next	: next ID
-    const xmlChar *	value	: The ID name
+}
Structure xmlParserInput
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 equa
+    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
+}
Structure xmlParserInputBuffer
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=compres
+    int	error
+}
Structure xmlRef
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 availabl
-    struct _xmlDoc *	doc	: The document holding the ID
-}
Structure xmlEnumeration
Structure xmlEnumeration
struct _xmlEnumeration {
-    struct _xmlEnumeration *	next	: next one
-    const xmlChar *	name	: Enumeration name
-}
xmlElementContentType
Enum xmlElementContentType {
-    XML_ELEMENT_CONTENT_PCDATA = 1
-    XML_ELEMENT_CONTENT_ELEMENT = 2
-    XML_ELEMENT_CONTENT_SEQ = 3
-    XML_ELEMENT_CONTENT_OR = 4
-}
-
Structure xmlSAXHandler
Structure xmlSAXHandler
struct _xmlSAXHandler {
+}
Structure xmlSAXHandler
Structure xmlSAXHandler
struct _xmlSAXHandler {
     internalSubsetSAXFunc	internalSubset
     isStandaloneSAXFunc	isStandalone
     hasInternalSubsetSAXFunc	hasInternalSubset
@@ -542,338 +585,295 @@ A:link, A:visited, A:active { text-decoration: underline }
     startElementNsSAX2Func	startElementNs
     endElementNsSAX2Func	endElementNs
     xmlStructuredErrorFunc	serror
-}
Structure xmlOutputBuffer
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 ISOLat
-    xmlBufferPtr	conv	: if encoder != NULL buffer for output
-    int	written	: total number of byte written
-    int	error
 }
Structure xmlSAXLocator
Structure xmlSAXLocator
struct _xmlSAXLocator {
     const xmlChar *(*getPublicId)	getPublicId
     const xmlChar *(*getSystemId)	getSystemId
     int(*getLineNumber)	getLineNumber
     int(*getColumnNumber)	getColumnNumber
-}
Structure xmlDtd
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 p
-    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
-}
Structure xmlAttribute
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
-}
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlBufferEmpty
void	xmlBufferEmpty			(xmlBufferPtr buf)

-
empty a buffer.

-
buf:the buffer
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: 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: 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: 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: 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: 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: 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: 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: xmlAddChild
xmlNodePtr	xmlAddChild		(xmlNodePtr parent, 
					 xmlNodePtr cur)

+}
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: 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: 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: 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: 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: xmlFreeNs
void	xmlFreeNs			(xmlNsPtr cur)

-
Free up the structures associated to a namespace

-
cur:the namespace pointer
Function: xmlBufferContent
const xmlChar *	xmlBufferContent	(const xmlBufferPtr buf)

-
Function to extract the content of a buffer

-
buf:the buffer
Returns:the internal content
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: 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: 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: 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: xmlGetCompressMode
int	xmlGetCompressMode		(void)

-
get the default compression mode used, ZLIB based.

-
Returns:0 (uncompressed) to 9 (max compression)
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: 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: 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: 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: 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: 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: 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.
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
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
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: 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: 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: 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.
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: 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: 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: 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: 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: 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: xmlBufferCreateSize
xmlBufferPtr	xmlBufferCreateSize	(size_t size)

-
routine to create an XML buffer.

-
size:initial size of buffer
Returns:the new structure.
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: 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: 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: 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: 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: 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: 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: 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: xmlAddChildList
xmlNodePtr	xmlAddChildList		(xmlNodePtr parent, 
					 xmlNodePtr cur)

+
parent:the parent node
cur:the child node
Returns:the child or NULL 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: 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: 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: 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: 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.
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: xmlAddNextSibling
xmlNodePtr	xmlAddNextSibling	(xmlNodePtr cur, 
					 xmlNodePtr elem)

+
parent:the parent node
cur:the first node in the list
Returns:the last child or NULL in case of error.
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: 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: 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: xmlNodeIsText
int	xmlNodeIsText			(xmlNodePtr node)

-
Is this node a Text node ?

-
node:the node
Returns:1 yes, 0 no
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: 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)

+
cur:the child node
elem:the new node
Returns:the new node or NULL in case of error.
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: 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: 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: 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: 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: 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: xmlBufferContent
const xmlChar *	xmlBufferContent	(const xmlBufferPtr buf)

+
Function to extract the content of a buffer

+
buf:the buffer
Returns:the internal content
Function: xmlBufferCreate
xmlBufferPtr	xmlBufferCreate		(void)

+
routine to create an XML buffer.

+
Returns:the new structure.
Function: xmlBufferCreateSize
xmlBufferPtr	xmlBufferCreateSize	(size_t size)

+
routine to create an XML buffer.

+
size:initial size of buffer
Returns:the new structure.
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: 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: 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().
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: 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: 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: 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: xmlCopyDoc
xmlDocPtr	xmlCopyDoc		(xmlDocPtr doc, 
					 int recursive)

+
file:the file output
buf:the buffer to dump
Returns:the number of #xmlChar written
Function: xmlBufferEmpty
void	xmlBufferEmpty			(xmlBufferPtr buf)

+
empty a buffer.

+
buf:the buffer
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: 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: 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: 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: 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: 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: 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
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: 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: 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: 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: 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: xmlDocDump
int	xmlDocDump			(FILE * f, 
					 xmlDocPtr cur)

+
doc:the document
recursive:if 1 do a recursive copy.
Returns:a new #xmlDocPtr, or NULL in case of error.
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: 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: 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: 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: 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: 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: 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.
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: 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: 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.
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: xmlFreeProp
void	xmlFreeProp			(xmlAttrPtr cur)

-
Free one attribute, all the content is freed too

-
cur:an attribute
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: 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: xmlDocDumpFormatMemory
void	xmlDocDumpFormatMemory		(xmlDocPtr cur, 
					 xmlChar ** mem, 
					 int * size, 
					 int format)

+
f:the FILE*
cur:the document
Returns:the number of bytes written or -1 in case of failure.
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: 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: xmlDocDumpFormatMemoryEnc
void	xmlDocDumpFormatMemoryEnc	(xmlDocPtr out_doc, 
					 xmlChar ** doc_txt_ptr, 
					 int * doc_txt_len, 
					 const char * txt_encoding, 
					 int format)

+
cur:the document
mem:OUT: the memory pointer
size:OUT: the memory length
format:should formatting spaces been added
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: 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: xmlNewDocTextLen
xmlNodePtr	xmlNewDocTextLen	(xmlDocPtr doc, 
					 const xmlChar * content, 
					 int len)

+
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: 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: 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: 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: 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: 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: 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: xmlFreeDoc
void	xmlFreeDoc			(xmlDocPtr cur)

+
Free up all the structures used by a document, tree included.

+
cur:pointer to the document
Function: xmlFreeDtd
void	xmlFreeDtd			(xmlDtdPtr cur)

+
Free a DTD structure.

+
cur:the DTD structure to free up
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: 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: xmlFreeNs
void	xmlFreeNs			(xmlNsPtr cur)

+
Free up the structures associated to a namespace

+
cur:the namespace pointer
Function: xmlFreeNsList
void	xmlFreeNsList			(xmlNsPtr cur)

+
Free up all the structures associated to the chained namespaces.

+
cur:the first namespace pointer
Function: xmlFreeProp
void	xmlFreeProp			(xmlAttrPtr cur)

+
Free one attribute, all the content is freed too

+
cur:an attribute
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: 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: xmlGetCompressMode
int	xmlGetCompressMode		(void)

+
get the default compression mode used, ZLIB based.

+
Returns:0 (uncompressed) to 9 (max compression)
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: 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: xmlGetLastChild
xmlNodePtr	xmlGetLastChild		(xmlNodePtr parent)

+
Search the last child of a node.

+
parent:the parent node
Returns:the last child or NULL if none.
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlNewNsProp
xmlAttrPtr	xmlNewNsProp		(xmlNodePtr node, 
					 xmlNsPtr ns, 
					 const xmlChar * name, 
					 const xmlChar * value)

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

+
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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().
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: 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: xmlNodeIsText
int	xmlNodeIsText			(xmlNodePtr node)

+
Is this node a Text node ?

+
node:the node
Returns:1 yes, 0 no
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: 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: 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: 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: 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: 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: 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: 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: 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.
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
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: 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: 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: 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: 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: xmlUnlinkNode
void	xmlUnlinkNode			(xmlNodePtr cur)

+
Unlink a node from it's current context, the node is not freed

+
cur:the node
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: 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: 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: 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: 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: 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.
Daniel Veillard

diff --git a/doc/html/libxml-uri.html b/doc/html/libxml-uri.html
index 3de5066e..386f0a31 100644
--- a/doc/html/libxml-uri.html
+++ b/doc/html/libxml-uri.html
@@ -36,28 +36,28 @@ A:link, A:visited, A:active { text-decoration: underline }
     char *	query	: the query string
     char *	fragment	: the fragment identifier
     int	cleanup	: parsing potentially unclean URI
-}
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)

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

+
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: xmlCreateURI
xmlURIPtr	xmlCreateURI		(void)

+
Simply creates an empty xmlURI

+
Returns:the new structure or NULL in case of error
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)

+
uri:pointer to an xmlURI
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: 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: 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)

+
uri:pointer to an URI structure
str:the string to analyze
Returns:0 or the 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: 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

+
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: 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: 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
Daniel Veillard

diff --git a/doc/html/libxml-valid.html b/doc/html/libxml-valid.html
index c56636f1..3ff2e340 100644
--- a/doc/html/libxml-valid.html
+++ b/doc/html/libxml-valid.html
@@ -104,16 +104,16 @@ void	xmlValidityErrorFunc		(void * ctx, 
xmlValidityWarningFunc		(void * ctx, 
					 const char * msg, 
					 ... ...)
 

 
Description

-
Structure xmlElementTable
Structure xmlElementTable
struct _xmlHashTable {
+
Structure xmlAttributeTable
Structure xmlAttributeTable
struct _xmlHashTable {
 The content of this structure is not made public by the API.
-}
Structure xmlAttributeTable
Structure xmlAttributeTable
struct _xmlHashTable {
+}
Structure xmlElementTable
Structure xmlElementTable
struct _xmlHashTable {
+The content of this structure is not made public by the API.
+}
Structure xmlIDTable
Structure xmlIDTable
struct _xmlHashTable {
 The content of this structure is not made public by the API.
 }
Structure xmlNotationTable
Structure xmlNotationTable
struct _xmlHashTable {
 The content of this structure is not made public by the API.
 }
Structure xmlRefTable
Structure xmlRefTable
struct _xmlHashTable {
 The content of this structure is not made public by the API.
-}
Structure xmlValidState
Structure xmlValidState
struct _xmlValidState {
-The content of this structure is not made public by the API.
 }
Structure xmlValidCtxt
Structure xmlValidCtxt
struct _xmlValidCtxt {
     void *	userData	: user specific data block
     xmlValidityErrorFunc	error	: the callback in case of errors
@@ -133,146 +133,146 @@ The content of this structure is not made public by the API.
     xmlAutomataStatePtr	state	: used to build the automata
     void *	am
     void *	state
-}
Structure xmlIDTable
Structure xmlIDTable
struct _xmlHashTable {
+}
Structure xmlValidState
Structure xmlValidState
struct _xmlValidState {
 The content of this structure is not made public by the API.
-}
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: 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: 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: xmlFreeAttributeTable
void	xmlFreeAttributeTable		(xmlAttributeTablePtr table)

-
Deallocate the memory used by an entities hash table.

-
table:An attribute table
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: 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 type: xmlValidityErrorFunc
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


-
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: 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: 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)

+}
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: 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: 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: 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: 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: xmlAddElementDecl
xmlElementPtr	xmlAddElementDecl	(xmlValidCtxtPtr ctxt, 
					 xmlDtdPtr dtd, 
					 const xmlChar * name, 
					 xmlElementTypeVal type, 
					 xmlElementContentPtr content)

+
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: 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: 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: 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: 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: 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: xmlFreeRefTable
void	xmlFreeRefTable			(xmlRefTablePtr table)

-
Deallocate the memory used by an Ref hash table.

-
table:An ref table
Function: xmlFreeElementContent
void	xmlFreeElementContent		(xmlElementContentPtr cur)

-
Free an element content structure. This is a recursive call !

-
cur:the element content tree to free
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: 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)

+
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: 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: 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: 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: 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: 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 type: xmlValidityWarningFunc
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


-
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: 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)

+
cur:An element content pointer.
Returns:the new xmlElementContentPtr or NULL in case of error.
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: 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)

+
cur:the tree to copy.
Returns:the xmlEnumerationPtr just created or NULL in case of error.
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: 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: 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: 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: 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: 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: 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: 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)

+
buf:the XML buffer output
elem:An element table
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: 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: 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: xmlFreeAttributeTable
void	xmlFreeAttributeTable		(xmlAttributeTablePtr table)

+
Deallocate the memory used by an entities hash table.

+
table:An attribute table
Function: xmlFreeElementContent
void	xmlFreeElementContent		(xmlElementContentPtr cur)

+
Free an element content structure. This is a recursive call !

+
cur:the element content tree to free
Function: xmlFreeElementTable
void	xmlFreeElementTable		(xmlElementTablePtr table)

+
Deallocate the memory used by an element hash table.

+
table:An element table
Function: xmlFreeEnumeration
void	xmlFreeEnumeration		(xmlEnumerationPtr cur)

+
free an enumeration attribute node (recursive).

+
cur:the tree to free.
Function: xmlFreeIDTable
void	xmlFreeIDTable			(xmlIDTablePtr table)

+
Deallocate the memory used by an ID hash table.

+
table:An id table
Function: xmlFreeNotationTable
void	xmlFreeNotationTable		(xmlNotationTablePtr table)

+
Deallocate the memory used by an entities hash table.

+
table:An notation table
Function: xmlFreeRefTable
void	xmlFreeRefTable			(xmlRefTablePtr table)

+
Deallocate the memory used by an Ref hash table.

+
table:An ref table
Function: xmlFreeValidCtxt
void	xmlFreeValidCtxt		(xmlValidCtxtPtr cur)

+
Free a validation context structure.

+
cur:the validation context to free
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: 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: 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: xmlValidatePushCData
int	xmlValidatePushCData		(xmlValidCtxtPtr ctxt, 
					 const xmlChar * data, 
					 int len)

+
dtd:a pointer to the DtD to search
name:the notation name
Returns:the xmlNotationPtr if found or NULL
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: 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: 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: 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: 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: 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: 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: 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: xmlNewValidCtxt
xmlValidCtxtPtr	xmlNewValidCtxt		(void)

+
Allocate a validation context structure.

+
Returns:NULL if not, otherwise the new validation context structure
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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

+
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
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: 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 type: xmlValidityErrorFunc
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


+
Function type: xmlValidityWarningFunc
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


+
Daniel Veillard

diff --git a/doc/html/libxml-xinclude.html b/doc/html/libxml-xinclude.html
index 94d7a08a..72a4f84b 100644
--- a/doc/html/libxml-xinclude.html
+++ b/doc/html/libxml-xinclude.html
@@ -19,24 +19,24 @@ The content of this structure is not made public by the API.
 
int	xmlXIncludeProcessNode		(xmlXIncludeCtxtPtr ctxt, 
					 xmlNodePtr node)

 
int	xmlXIncludeProcessTree		(xmlNodePtr tree)

 
Description

-
Macro: XINCLUDE_PARSE_TEXT
#define XINCLUDE_PARSE_TEXT

-
Macro: XINCLUDE_NODE
#define XINCLUDE_NODE

-
Macro: XINCLUDE_PARSE_XML
#define XINCLUDE_PARSE_XML

-
Macro: XINCLUDE_HREF
#define XINCLUDE_HREF

 
Macro: XINCLUDE_FALLBACK
#define XINCLUDE_FALLBACK

+
Macro: XINCLUDE_HREF
#define XINCLUDE_HREF

+
Macro: XINCLUDE_NODE
#define XINCLUDE_NODE

 
Macro: XINCLUDE_NS
#define XINCLUDE_NS

 
Macro: XINCLUDE_PARSE
#define XINCLUDE_PARSE

 
Macro: XINCLUDE_PARSE_ENCODING
#define XINCLUDE_PARSE_ENCODING

+
Macro: XINCLUDE_PARSE_TEXT
#define XINCLUDE_PARSE_TEXT

+
Macro: XINCLUDE_PARSE_XML
#define XINCLUDE_PARSE_XML

 
Structure xmlXIncludeCtxt
Structure xmlXIncludeCtxt
struct _xmlXIncludeCtxt {
 The content of this structure is not made public by the API.
-}
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: xmlXIncludeNewContext
xmlXIncludeCtxtPtr	xmlXIncludeNewContext	(xmlDocPtr doc)

+}
Function: xmlXIncludeFreeContext
void	xmlXIncludeFreeContext		(xmlXIncludeCtxtPtr ctxt)

+
Free an XInclude context

+
ctxt:the XInclude context
Function: xmlXIncludeNewContext
xmlXIncludeCtxtPtr	xmlXIncludeNewContext	(xmlDocPtr doc)

 
Creates a new XInclude context

-
doc:an XML Document
Returns:the new set
Function: xmlXIncludeProcessNode
int	xmlXIncludeProcessNode		(xmlXIncludeCtxtPtr ctxt, 
					 xmlNodePtr node)

+
doc:an XML Document
Returns:the new set
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: 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.
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: xmlXIncludeFreeContext
void	xmlXIncludeFreeContext		(xmlXIncludeCtxtPtr ctxt)

-
Free an XInclude context

-
ctxt:the XInclude context
Daniel Veillard

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

diff --git a/doc/html/libxml-xlink.html b/doc/html/libxml-xlink.html
index 43cc77db..82748177 100644
--- a/doc/html/libxml-xlink.html
+++ b/doc/html/libxml-xlink.html
@@ -36,42 +36,28 @@ void	xlinkNodeDetectFunc		(void * ctx, 

 void	xlinkSimpleLinkFunk		(void * ctx, 
					 xmlNodePtr node, 
					 const xlinkHRef href, 
					 const xlinkRole role, 
					 const xlinkTitle title)
 

 
Description

-
Structure xlinkHandler
Structure xlinkHandler
struct _xlinkHandler {
+
Enum xlinkActuate
Enum xlinkActuate {
+    XLINK_ACTUATE_NONE = 0
+    XLINK_ACTUATE_AUTO = 1
+    XLINK_ACTUATE_ONREQUEST = 2
+}
+
Structure xlinkHandler
Structure xlinkHandler
struct _xlinkHandler {
     xlinkSimpleLinkFunk	simple
     xlinkExtendedLinkFunk	extended
     xlinkExtendedLinkSetFunk	set
-}
xlinkShow
Enum xlinkShow {
+}
Enum xlinkShow
Enum xlinkShow {
     XLINK_SHOW_NONE = 0
     XLINK_SHOW_NEW = 1
     XLINK_SHOW_EMBED = 2
     XLINK_SHOW_REPLACE = 3
 }
-
xlinkType
Enum xlinkType {
+
Enum xlinkType
Enum xlinkType {
     XLINK_TYPE_NONE = 0
     XLINK_TYPE_SIMPLE = 1
     XLINK_TYPE_EXTENDED = 2
     XLINK_TYPE_EXTENDED_SET = 3
 }
-
xlinkActuate
Enum xlinkActuate {
-    XLINK_ACTUATE_NONE = 0
-    XLINK_ACTUATE_AUTO = 1
-    XLINK_ACTUATE_ONREQUEST = 2
-}
-
Function type: xlinkNodeDetectFunc
Function type: xlinkNodeDetectFunc
-void	xlinkNodeDetectFunc		(void * ctx, 
					 xmlNodePtr node)
-
This is the prototype for the link detection routine. It calls the default link detection callbacks upon link detection.
ctx:user data pointer
node:the node to check


-
Function: xlinkGetDefaultHandler
xlinkHandlerPtr	xlinkGetDefaultHandler	(void)

-
Get the default xlink handler.

-
Returns:the current xlinkHandlerPtr value.
Function: xlinkIsLink
xlinkType	xlinkIsLink		(xmlDocPtr doc, 
					 xmlNodePtr node)

-
Check whether the given node carries the attributes needed to be a link element (or is one of the linking elements issued from the (X)HTML DtDs). This routine don't try to do full checking of the link validity but tries to detect and return the appropriate link type.

-
doc:the document containing the node
node:the node pointer itself
Returns:the xlinkType of the node (XLINK_TYPE_NONE if there is no link detected.
Function type: xlinkSimpleLinkFunk
Function type: xlinkSimpleLinkFunk
-void	xlinkSimpleLinkFunk		(void * ctx, 
					 xmlNodePtr node, 
					 const xlinkHRef href, 
					 const xlinkRole role, 
					 const xlinkTitle title)
-
This is the prototype for a simple link detection callback.
ctx:user data pointer
node:the node carrying the link
href:the target of the link
role:the role string
title:the link title


-
Function: xlinkSetDefaultHandler
void	xlinkSetDefaultHandler		(xlinkHandlerPtr handler)

-
Set the default xlink handlers

-
handler:the new value for the xlink handler block
Function: xlinkSetDefaultDetect
void	xlinkSetDefaultDetect		(xlinkNodeDetectFunc func)

-
Set the default xlink detection routine

-
func:pointer to the new detection routine.
Function type: xlinkExtendedLinkFunk
Function type: xlinkExtendedLinkFunk
+
Function type: xlinkExtendedLinkFunk
Function type: xlinkExtendedLinkFunk
 void	xlinkExtendedLinkFunk		(void * ctx, 
					 xmlNodePtr node, 
					 int nbLocators, 
					 const xlinkHRef * hrefs, 
					 const xlinkRole * roles, 
					 int nbArcs, 
					 const xlinkRole * from, 
					 const xlinkRole * to, 
					 xlinkShow * show, 
					 xlinkActuate * actuate, 
					 int nbTitles, 
					 const xlinkTitle * titles, 
					 const xmlChar ** langs)
 
This is the prototype for a extended link detection callback.
ctx:user data pointer
node:the node carrying the link
nbLocators:the number of locators detected on the link
hrefs:pointer to the array of locator hrefs
roles:pointer to the array of locator roles
nbArcs:the number of arcs detected on the link
from:pointer to the array of source roles found on the arcs
to:pointer to the array of target roles found on the arcs
show:array of values for the show attributes found on the arcs
actuate:array of values for the actuate attributes found on the arcs
nbTitles:the number of titles detected on the link
titles:
langs:array of xml:lang values for the titles


 
Function type: xlinkExtendedLinkSetFunk
Function type: xlinkExtendedLinkSetFunk
@@ -79,4 +65,18 @@ void	xlinkExtendedLinkSetFunk	(void * ctx, 
					 
ctx:user data pointer
node:the node carrying the link
nbLocators:the number of locators detected on the link
hrefs:pointer to the array of locator hrefs
roles:pointer to the array of locator roles
nbTitles:the number of titles detected on the link
titles:
langs:array of xml:lang values for the titles


 
Function: xlinkGetDefaultDetect
xlinkNodeDetectFunc	xlinkGetDefaultDetect	(void)

 
Get the default xlink detection routine

-
Returns:the current function or NULL;
Daniel Veillard

+
Returns:the current function or NULL;
Function: xlinkGetDefaultHandler
xlinkHandlerPtr	xlinkGetDefaultHandler	(void)

+
Get the default xlink handler.

+
Returns:the current xlinkHandlerPtr value.
Function: xlinkIsLink
xlinkType	xlinkIsLink		(xmlDocPtr doc, 
					 xmlNodePtr node)

+
Check whether the given node carries the attributes needed to be a link element (or is one of the linking elements issued from the (X)HTML DtDs). This routine don't try to do full checking of the link validity but tries to detect and return the appropriate link type.

+
doc:the document containing the node
node:the node pointer itself
Returns:the xlinkType of the node (XLINK_TYPE_NONE if there is no link detected.
Function type: xlinkNodeDetectFunc
Function type: xlinkNodeDetectFunc
+void	xlinkNodeDetectFunc		(void * ctx, 
					 xmlNodePtr node)
+
This is the prototype for the link detection routine. It calls the default link detection callbacks upon link detection.
ctx:user data pointer
node:the node to check


+
Function: xlinkSetDefaultDetect
void	xlinkSetDefaultDetect		(xlinkNodeDetectFunc func)

+
Set the default xlink detection routine

+
func:pointer to the new detection routine.
Function: xlinkSetDefaultHandler
void	xlinkSetDefaultHandler		(xlinkHandlerPtr handler)

+
Set the default xlink handlers

+
handler:the new value for the xlink handler block
Function type: xlinkSimpleLinkFunk
Function type: xlinkSimpleLinkFunk
+void	xlinkSimpleLinkFunk		(void * ctx, 
					 xmlNodePtr node, 
					 const xlinkHRef href, 
					 const xlinkRole role, 
					 const xlinkTitle title)
+
This is the prototype for a simple link detection callback.
ctx:user data pointer
node:the node carrying the link
href:the target of the link
role:the role string
title:the link title


+
Daniel Veillard

diff --git a/doc/html/libxml-xmlIO.html b/doc/html/libxml-xmlIO.html
index 5590a863..ec556b97 100644
--- a/doc/html/libxml-xmlIO.html
+++ b/doc/html/libxml-xmlIO.html
@@ -80,118 +80,118 @@ int	xmlOutputWriteCallback		(void * contex
 
int	xmlRegisterInputCallbacks	(xmlInputMatchCallback matchFunc, 
					 xmlInputOpenCallback openFunc, 
					 xmlInputReadCallback readFunc, 
					 xmlInputCloseCallback closeFunc)

 
int	xmlRegisterOutputCallbacks	(xmlOutputMatchCallback matchFunc, 
					 xmlOutputOpenCallback openFunc, 
					 xmlOutputWriteCallback writeFunc, 
					 xmlOutputCloseCallback closeFunc)

 
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
Function type: xmlInputMatchCallback
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


-
Function: xmlRegisterDefaultOutputCallbacks
void	xmlRegisterDefaultOutputCallbacks	(void)

-
Registers the default compiled-in I/O handlers.

+
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: 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
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.
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: xmlCleanupInputCallbacks
void	xmlCleanupInputCallbacks	(void)

+
clears the entire input callback table. this includes the compiled-in I/O.

+
Function: xmlCleanupOutputCallbacks
void	xmlCleanupOutputCallbacks	(void)

+
clears the entire output callback table. this includes the compiled-in I/O callbacks.

 
Function: xmlFileClose
int	xmlFileClose			(void * context)

 
Close an I/O channel

-
context:the I/O context
Returns:0 or -1 in case of error
Function type: xmlOutputMatchCallback
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


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

+
context:the I/O context
Returns:0 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: 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.
Function type: xmlOutputOpenCallback
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


-
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
Function type: xmlOutputWriteCallback
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


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

+
filename:the URI for matching
Returns:a handler or NULL in case or failure
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: 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.
Function type: xmlOutputCloseCallback
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


-
Function: xmlIOHTTPMatch
int	xmlIOHTTPMatch			(const char * filename)

+
in:a buffered parser input
Function: xmlIOFTPClose
int	xmlIOFTPClose			(void * context)

+
Close an FTP I/O channel

+
context:the I/O context
Returns:0
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: 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: 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: xmlIOHTTPClose
int	xmlIOHTTPClose			(void * context)

+
Close an HTTP I/O channel

+
context:the I/O context
Returns:0
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
Function type: xmlInputReadCallback
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


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

+
filename:the URI for matching
Returns:an I/O context or NULL in case of error
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: 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
Function type: xmlInputCloseCallback
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


+
Function type: xmlInputMatchCallback
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


 
Function type: xmlInputOpenCallback
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


-
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: 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)

+
Function type: xmlInputReadCallback
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


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

-
Function type: xmlInputCloseCallback
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


-
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

+
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: 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 type: xmlOutputCloseCallback
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


+
Function type: xmlOutputMatchCallback
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


+
Function type: xmlOutputOpenCallback
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


+
Function type: xmlOutputWriteCallback
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


+
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlRegisterDefaultInputCallbacks
void	xmlRegisterDefaultInputCallbacks	(void)

+
Registers the default compiled-in I/O handlers.

+
Function: xmlRegisterDefaultOutputCallbacks
void	xmlRegisterDefaultOutputCallbacks	(void)

+
Registers the default compiled-in I/O handlers.

+
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: 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: 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
Daniel Veillard

diff --git a/doc/html/libxml-xmlautomata.html b/doc/html/libxml-xmlautomata.html
index e9012bd3..68ae4347 100644
--- a/doc/html/libxml-xmlautomata.html
+++ b/doc/html/libxml-xmlautomata.html
@@ -37,36 +37,36 @@ The content of this structure is not made public by the API.
 The content of this structure is not made public by the API.
 }
Structure xmlAutomataState
Structure xmlAutomataState
struct _xmlAutomataState {
 The content of this structure is not made public by the API.
-}
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: 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: 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: 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)

+}
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: 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: 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: 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: 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)

+
am:an automata
Returns:the compiled regexp or NULL in case of error
Function: xmlAutomataGetInitState
xmlAutomataStatePtr	xmlAutomataGetInitState	(xmlAutomataPtr am)

+
Initial state lookup

+
am:an automata
Returns:the initial state of the automata
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

+
am:an automata
Returns:1 if true, 0 if not, and -1 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlFreeAutomata
void	xmlFreeAutomata			(xmlAutomataPtr am)

+
Free an automata

+
am:an automata
Function: xmlNewAutomata
xmlAutomataPtr	xmlNewAutomata		(void)

+
Create a new automata

+
Returns:the new object or NULL in case of failure
Daniel Veillard

diff --git a/doc/html/libxml-xmlerror.html b/doc/html/libxml-xmlerror.html
index d3a69e98..a0eaac0d 100644
--- a/doc/html/libxml-xmlerror.html
+++ b/doc/html/libxml-xmlerror.html
@@ -37,13 +37,53 @@ void	xmlGenericErrorFunc		(void * ctx, 

 void	xmlStructuredErrorFunc		(void * userData, 
					 xmlErrorPtr error)
 

 
Description

-
xmlErrorLevel
Enum xmlErrorLevel {
+
Structure xmlError
Structure xmlError
struct _xmlError {
+    int	domain	: What part of the library raised this er
+    int	code	: The error code, e.g. an xmlParserError
+    char *	message	: human-readable informative error messag
+    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
+}
Enum xmlErrorDomain
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
+}
+
Enum xmlErrorLevel
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
 }
-
xmlParserErrors
Enum xmlParserErrors {
+
Enum xmlParserErrors
Enum xmlParserErrors {
     XML_ERR_OK = 0
     XML_ERR_INTERNAL_ERROR = 1 : 1
     XML_ERR_NO_MEMORY = 2 : 2
@@ -527,80 +567,40 @@ void	xmlStructuredErrorFunc		(void * userD
     XML_HTTP_USE_IP = 2021 : 2021
     XML_HTTP_UNKNOWN_HOST = 2022 : 2022
 }
-
xmlErrorDomain
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
-}
-
Structure xmlError
Structure xmlError
struct _xmlError {
-    int	domain	: What part of the library raised this er
-    int	code	: The error code, e.g. an xmlParserError
-    char *	message	: human-readable informative error messag
-    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
-}
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 type: xmlGenericErrorFunc
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


-
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: xmlParserPrintFileInfo
void	xmlParserPrintFileInfo		(xmlParserInputPtr input)

-
Displays the associated file and line informations for the current input

-
input:an xmlParserInputPtr input
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: xmlResetLastError
void	xmlResetLastError		(void)

-
Cleanup the last global error registered. For parsing error this does not change the well-formedness result.

-
Function: initGenericErrorDefaultFunc
void	initGenericErrorDefaultFunc	(xmlGenericErrorFunc * 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
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.
Function: xmlParserValidityWarning
void	xmlParserValidityWarning	(void * ctx, 
					 const char * msg, 
					 ... ...)

-
Display and format a validity warning messages, gives file, line, position and extra parameters.

+
from:a source error
to:a target error
Returns:0 in case of success and -1 in case of error.
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: 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 type: xmlGenericErrorFunc
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


+
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: xmlParserPrintFileContext
void	xmlParserPrintFileContext	(xmlParserInputPtr input)

 
Displays current context within the input content for error tracking

-
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: xmlParserWarning
void	xmlParserWarning		(void * ctx, 
					 const char * msg, 
					 ... ...)

+
input:an xmlParserInputPtr input
Function: xmlParserPrintFileInfo
void	xmlParserPrintFileInfo		(xmlParserInputPtr input)

+
Displays the associated file and line informations for the current input

+
input:an xmlParserInputPtr input
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: 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
Function type: xmlStructuredErrorFunc
Function type: xmlStructuredErrorFunc
+
ctx:an XML parser context
msg:the message to display/transmit
...:extra parameters for the message display
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: 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: 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 type: xmlStructuredErrorFunc
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.


-
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: 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: 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
Daniel Veillard

+
Daniel Veillard

diff --git a/doc/html/libxml-xmlexports.html b/doc/html/libxml-xmlexports.html
index 6d5616ea..d6f2806b 100644
--- a/doc/html/libxml-xmlexports.html
+++ b/doc/html/libxml-xmlexports.html
@@ -11,9 +11,9 @@ A:link, A:visited, A:active { text-decoration: underline }
       div.deprecated pre.programlisting {border-style: double;border-color:red}
       pre.programlisting {border-style: double}
     Module xmlexports from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlexports from libxml2
API Menu
API Indexes
Related links
PrevxmlerrorUpAPI documentationHomeThe XML C parser and toolkit of GnomexmlmemoryNext
macros for marking symbols as exportable/importable. 
Table of Contents
#define LIBXML_DLL_IMPORT
#define XMLCALL
#define XMLPUBFUN
#define XMLPUBVAR
#define _REENTRANT
Description

+
Macro: LIBXML_DLL_IMPORT
#define LIBXML_DLL_IMPORT

 
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

+
Macro: _REENTRANT
#define _REENTRANT

 
Daniel Veillard

diff --git a/doc/html/libxml-xmlmemory.html b/doc/html/libxml-xmlmemory.html
index e9a73e52..746188ba 100644
--- a/doc/html/libxml-xmlmemory.html
+++ b/doc/html/libxml-xmlmemory.html
@@ -49,50 +49,50 @@ char *	xmlStrdupFunc			(const char * str)
 

 
Description

 
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: 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: 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: xmlMemUsed
int	xmlMemUsed			(void)

-
Provides the amount of memory currently allocated

-
Returns:an int representing the amount of memory allocated.
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: xmlMemoryDump
void	xmlMemoryDump			(void)

-
Dump in-extenso the memory blocks allocated to the file .memorylist

-
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
Function type: xmlStrdupFunc
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: 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 type: xmlFreeFunc
Function type: xmlFreeFunc
+
Function type: xmlFreeFunc
Function type: xmlFreeFunc
 void	xmlFreeFunc			(void * mem)
 
Signature for a free() implementation.
mem:an already allocated block of memory


-
Function: xmlInitMemory
int	xmlInitMemory			(void)

+
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
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: xmlInitMemory
int	xmlInitMemory			(void)

 
Initialize the memory layer.

-
Returns:0 on success
Function type: xmlReallocFunc
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.


-
Function: xmlMemFree
void	xmlMemFree			(void * ptr)

-
a free() equivalent, with error checking.

-
ptr:the memory block pointer
Function type: xmlMallocFunc
Function type: xmlMallocFunc
+
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 type: xmlMallocFunc
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.


-
Function: xmlMemDisplay
void	xmlMemDisplay			(FILE * fp)

+
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: 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: xmlMemMalloc
void *	xmlMemMalloc			(size_t size)

+
fp:a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist
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: 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: 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: 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: 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
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: xmlMemSetup
int	xmlMemSetup			(xmlFreeFunc freeFunc, 
					 xmlMallocFunc mallocFunc, 
					 xmlReallocFunc reallocFunc, 
					 xmlStrdupFunc strdupFunc)

+
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: 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: 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: xmlMemStrdupLoc
char *	xmlMemStrdupLoc			(const char * str, 
					 const char * file, 
					 int line)

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

+
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.
Function: xmlMemUsed
int	xmlMemUsed			(void)

+
Provides the amount of memory currently allocated

+
Returns:an int representing the amount of memory allocated.
Function: xmlMemoryDump
void	xmlMemoryDump			(void)

+
Dump in-extenso the memory blocks allocated to the file .memorylist

+
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 type: xmlReallocFunc
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.


+
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 type: xmlStrdupFunc
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.


+
Daniel Veillard

diff --git a/doc/html/libxml-xmlreader.html b/doc/html/libxml-xmlreader.html
index bcab508b..ed0874fd 100644
--- a/doc/html/libxml-xmlreader.html
+++ b/doc/html/libxml-xmlreader.html
@@ -93,21 +93,19 @@ void	xmlTextReaderErrorFunc		(void * arg,
 
xmlChar *	xmlTextReaderValue	(xmlTextReaderPtr reader)

 
xmlChar *	xmlTextReaderXmlLang	(xmlTextReaderPtr reader)

 
Description

-
xmlParserProperties
Enum xmlParserProperties {
+
Enum xmlParserProperties
Enum xmlParserProperties {
     XML_PARSER_LOADDTD = 1
     XML_PARSER_DEFAULTATTRS = 2
     XML_PARSER_VALIDATE = 3
     XML_PARSER_SUBST_ENTITIES = 4
 }
-
xmlParserSeverities
Enum xmlParserSeverities {
+
Enum xmlParserSeverities
Enum xmlParserSeverities {
     XML_PARSER_SEVERITY_VALIDITY_WARNING = 1
     XML_PARSER_SEVERITY_VALIDITY_ERROR = 2
     XML_PARSER_SEVERITY_WARNING = 3
     XML_PARSER_SEVERITY_ERROR = 4
 }
-
Structure xmlTextReader
Structure xmlTextReader
struct _xmlTextReader {
-The content of this structure is not made public by the API.
-}
xmlReaderTypes
Enum xmlReaderTypes {
+
Enum xmlReaderTypes
Enum xmlReaderTypes {
     XML_READER_TYPE_NONE = 0
     XML_READER_TYPE_ELEMENT = 1
     XML_READER_TYPE_ATTRIBUTE = 2
@@ -127,151 +125,153 @@ The content of this structure is not made public by the API.
     XML_READER_TYPE_END_ENTITY = 16
     XML_READER_TYPE_XML_DECLARATION = 17
 }
-
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: 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: xmlNewTextReaderFilename
xmlTextReaderPtr	xmlNewTextReaderFilename	(const char * URI)

+
Structure xmlTextReader
Structure xmlTextReader
struct _xmlTextReader {
+The content of this structure is not made public by the API.
+}
Function: xmlFreeTextReader
void	xmlFreeTextReader		(xmlTextReaderPtr reader)

+
Deallocate all the resources associated to the reader

+
reader:the xmlTextReaderPtr
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: 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: 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: 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: 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: xmlTextReaderDepth
int	xmlTextReaderDepth		(xmlTextReaderPtr reader)

+
URI:the URI of the resource to process
Returns:the new xmlTextReaderPtr or NULL in case of error
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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
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: 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: 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: 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: 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: 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: 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: 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: 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: 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 type: xmlTextReaderErrorFunc
Function type: xmlTextReaderErrorFunc
 void	xmlTextReaderErrorFunc		(void * arg, 
					 const char * msg, 
					 xmlParserSeverities severity, 
					 xmlTextReaderLocatorPtr locator)
 
arg:
msg:
severity:
locator:


-
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlTextReaderExpand
xmlNodePtr	xmlTextReaderExpand	(xmlTextReaderPtr reader)

+
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlTextReaderGetErrorHandler
void	xmlTextReaderGetErrorHandler	(xmlTextReaderPtr reader, 
					 xmlTextReaderErrorFunc * f, 
					 void ** arg)

+
reader:the xmlTextReaderPtr used
Returns:a node pointer valid until the next xmlTextReaderRead() call or NULL in case of error.
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: 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: 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: 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: 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: xmlTextReaderGetParserProp
int	xmlTextReaderGetParserProp	(xmlTextReaderPtr reader, 
					 int prop)

+
reader:the xmlTextReaderPtr used
f:the callback function or NULL is no callback has been registered
arg:a user argument
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: 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: 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: 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: 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: 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: xmlTextReaderNextSibling
int	xmlTextReaderNextSibling	(xmlTextReaderPtr reader)

-
Skip to the node following the current one in document order while avoiding the subtree if any. Currently implemented only for Readers built on a document

-
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: 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: 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: 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
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: 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: 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: 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: 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: 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: 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: 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: 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: xmlTextReaderHasValue
int	xmlTextReaderHasValue		(xmlTextReaderPtr reader)

+
reader:the xmlTextReaderPtr used
Returns:the xmlParserInputBufferPtr attached to the XML or NULL in case of error.
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: 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: 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: 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: 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: xmlTextReaderConstLocalName
const xmlChar *	xmlTextReaderConstLocalName	(xmlTextReaderPtr reader)

+
reader:the xmlTextReaderPtr used
Returns:1 if true, 0 if false, and -1 in case or error
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: 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: 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: xmlTextReaderLocalName
xmlChar *	xmlTextReaderLocalName	(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: xmlTextReaderSetParserProp
int	xmlTextReaderSetParserProp	(xmlTextReaderPtr reader, 
					 int prop, 
					 int value)

+
reader:the xmlTextReaderPtr used
Returns:the local name or NULL if not available
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlTextReaderNextSibling
int	xmlTextReaderNextSibling	(xmlTextReaderPtr reader)

+
Skip to the node following the current one in document order while avoiding the subtree if any. Currently implemented only for Readers built on a document

+
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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
Daniel Veillard

+
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: 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: 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.
Daniel Veillard

diff --git a/doc/html/libxml-xmlregexp.html b/doc/html/libxml-xmlregexp.html
index 1a50a12a..b2b1fd85 100644
--- a/doc/html/libxml-xmlregexp.html
+++ b/doc/html/libxml-xmlregexp.html
@@ -29,29 +29,29 @@ void	xmlRegExecCallbacks		(int	xmlRegexpIsDeterminist		(xmlRegexpPtr comp)

 
void	xmlRegexpPrint			(FILE * output, 
					 xmlRegexpPtr regexp)

 
Description

-
Structure xmlRegexp
Structure xmlRegexp
struct _xmlRegexp {
+
Structure xmlRegExecCtxt
Structure xmlRegExecCtxt
struct _xmlRegExecCtxt {
 The content of this structure is not made public by the API.
-}
Structure xmlRegExecCtxt
Structure xmlRegExecCtxt
struct _xmlRegExecCtxt {
+}
Structure xmlRegexp
Structure xmlRegexp
struct _xmlRegexp {
 The content of this structure is not made public by the API.
-}
Function: xmlRegFreeExecCtxt
void	xmlRegFreeExecCtxt		(xmlRegExecCtxtPtr exec)

-
Free the structures associated to a regular expression evaulation context.

-
exec:a regular expression evaulation 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 type: xmlRegExecCallbacks
Function type: xmlRegExecCallbacks
+}
Function type: xmlRegExecCallbacks
Function type: xmlRegExecCallbacks
 void	xmlRegExecCallbacks		(xmlRegExecCtxtPtr exec, 
					 const xmlChar * token, 
					 void * transdata, 
					 void * inputdata)
 
exec:
token:
transdata:
inputdata:


-
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: 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: xmlRegExecPushString2
int	xmlRegExecPushString2		(xmlRegExecCtxtPtr exec, 
					 const xmlChar * value, 
					 const xmlChar * value2, 
					 void * data)

+
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: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: xmlRegExecPushString
int	xmlRegExecPushString		(xmlRegExecCtxtPtr exec, 
					 const xmlChar * value, 
					 void * data)

+
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: 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: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: 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: xmlRegFreeRegexp
void	xmlRegFreeRegexp		(xmlRegexpPtr regexp)

+
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: xmlRegFreeExecCtxt
void	xmlRegFreeExecCtxt		(xmlRegExecCtxtPtr exec)

+
Free the structures associated to a regular expression evaulation context.

+
exec:a regular expression evaulation context
Function: xmlRegFreeRegexp
void	xmlRegFreeRegexp		(xmlRegexpPtr regexp)

 
Free a regexp

-
regexp:the regexp
Function: xmlRegexpPrint
void	xmlRegexpPrint			(FILE * output, 
					 xmlRegexpPtr regexp)

+
regexp:the regexp
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: 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: 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: 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 d491f8c7..39ce7723 100644
--- a/doc/html/libxml-xmlschemas.html
+++ b/doc/html/libxml-xmlschemas.html
@@ -39,9 +39,7 @@ void	xmlSchemaValidityErrorFunc	(void
 void	xmlSchemaValidityWarningFunc	(void * ctx, 
					 const char * msg, 
					 ... ...)
 

 
Description

-
Structure xmlSchemaParserCtxt
Structure xmlSchemaParserCtxt
struct _xmlSchemaParserCtxt {
-The content of this structure is not made public by the API.
-}
Structure xmlSchema
Structure xmlSchema
struct _xmlSchema {
+
Structure xmlSchema
Structure xmlSchema
struct _xmlSchema {
     xmlChar *	name	: schema name
     xmlChar *	targetNamespace	: the target namespace
     xmlChar *	version
@@ -57,7 +55,11 @@ The content of this structure is not made public by the API.
     xmlHashTablePtr	schemasImports
     void *	_private	: unused by the library for users or bind
     xmlHashTablePtr	groupDecl
-}
xmlSchemaValidError
Enum xmlSchemaValidError {
+}
Structure xmlSchemaParserCtxt
Structure xmlSchemaParserCtxt
struct _xmlSchemaParserCtxt {
+The content of this structure is not made public by the API.
+}
Structure xmlSchemaValidCtxt
Structure xmlSchemaValidCtxt
struct _xmlSchemaValidCtxt {
+The content of this structure is not made public by the API.
+}
Enum xmlSchemaValidError
Enum xmlSchemaValidError {
     XML_SCHEMAS_ERR_OK = 0
     XML_SCHEMAS_ERR_NOROOT = 1
     XML_SCHEMAS_ERR_UNDECLAREDELEM = 2
@@ -85,38 +87,36 @@ The content of this structure is not made public by the API.
     XML_SCHEMAS_ERR_ = 24
     XML_SCHEMAS_ERR_XXX = 25
 }
-
Structure xmlSchemaValidCtxt
Structure xmlSchemaValidCtxt
struct _xmlSchemaValidCtxt {
-The content of this structure is not made public by the API.
-}
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: 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 type: xmlSchemaValidityWarningFunc
Function type: xmlSchemaValidityWarningFunc
-void	xmlSchemaValidityWarningFunc	(void * ctx, 
					 const char * msg, 
					 ... ...)
-
ctx:
msg:
...:


-
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: 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)

+
Function: xmlSchemaDump
void	xmlSchemaDump			(FILE * output, 
					 xmlSchemaPtr schema)

+
Dump a Schema structure.

+
output:the file output
schema:a schema structure
Function: xmlSchemaFree
void	xmlSchemaFree			(xmlSchemaPtr schema)

 
Deallocate a Schema structure.

-
schema:a schema structure
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: 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: xmlSchemaFreeParserCtxt
void	xmlSchemaFreeParserCtxt		(xmlSchemaParserCtxtPtr ctxt)

+
schema:a schema structure
Function: xmlSchemaFreeParserCtxt
void	xmlSchemaFreeParserCtxt		(xmlSchemaParserCtxtPtr ctxt)

 
Free the resources associated to the schema parser context

 
ctxt:the schema parser context
Function: xmlSchemaFreeValidCtxt
void	xmlSchemaFreeValidCtxt		(xmlSchemaValidCtxtPtr ctxt)

 
Free the resources associated to the schema validation context

-
ctxt:the schema validation context
Function: xmlSchemaNewValidCtxt
xmlSchemaValidCtxtPtr	xmlSchemaNewValidCtxt	(xmlSchemaPtr schema)

+
ctxt:the schema validation context
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: 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: 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: 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
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)

+
schema:a precompiled XML Schemas
Returns:the validation context or NULL in case of error
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: 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: 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 type: xmlSchemaValidityErrorFunc
Function type: xmlSchemaValidityErrorFunc
+
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: 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 type: xmlSchemaValidityErrorFunc
Function type: xmlSchemaValidityErrorFunc
 void	xmlSchemaValidityErrorFunc	(void * ctx, 
					 const char * msg, 
					 ... ...)
 
ctx:
msg:
...:


+
Function type: xmlSchemaValidityWarningFunc
Function type: xmlSchemaValidityWarningFunc
+void	xmlSchemaValidityWarningFunc	(void * ctx, 
					 const char * msg, 
					 ... ...)
+
ctx:
msg:
...:


 
Daniel Veillard

diff --git a/doc/html/libxml-xmlschemastypes.html b/doc/html/libxml-xmlschemastypes.html
index 4ca35a66..05ab90af 100644
--- a/doc/html/libxml-xmlschemastypes.html
+++ b/doc/html/libxml-xmlschemastypes.html
@@ -22,26 +22,26 @@ A:link, A:visited, A:active { text-decoration: underline }
 
int	xmlSchemaValidateFacet		(xmlSchemaTypePtr base, 
					 xmlSchemaFacetPtr facet, 
					 const xmlChar * value, 
					 xmlSchemaValPtr val)

 
int	xmlSchemaValidatePredefinedType	(xmlSchemaTypePtr type, 
					 const xmlChar * value, 
					 xmlSchemaValPtr * val)

 
Description

+
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
Function: xmlSchemaCleanupTypes
void	xmlSchemaCleanupTypes		(void)

+
Cleanup the default XML Schemas type library

+
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: xmlSchemaFreeFacet
void	xmlSchemaFreeFacet		(xmlSchemaFacetPtr facet)

+
Deallocate a Schema Facet structure.

+
facet:a schema facet structure
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: xmlSchemaInitTypes
void	xmlSchemaInitTypes		(void)

+
Initialize the default XML Schemas type library

 
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)

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

+
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: 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.
Daniel Veillard

diff --git a/doc/html/libxml-xmlunicode.html b/doc/html/libxml-xmlunicode.html
index 3ce7e7ad..76531931 100644
--- a/doc/html/libxml-xmlunicode.html
+++ b/doc/html/libxml-xmlunicode.html
@@ -177,336 +177,336 @@ A:link, A:visited, A:active { text-decoration: underline }
 
int	xmlUCSIsYiSyllables		(int code)

 
int	xmlUCSIsYijingHexagramSymbols	(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

+
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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
Daniel Veillard

diff --git a/doc/html/libxml-xmlversion.html b/doc/html/libxml-xmlversion.html
index 93f6d740..92c7786c 100644
--- a/doc/html/libxml-xmlversion.html
+++ b/doc/html/libxml-xmlversion.html
@@ -12,39 +12,39 @@ A:link, A:visited, A:active { text-decoration: underline }
       pre.programlisting {border-style: double}
     Module xmlversion from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module xmlversion from libxml2
API Menu
API Indexes
Related links
PrevxmlunicodeUpAPI documentationHomeThe XML C parser and toolkit of GnomexmlwriterNext
compile-time version informations for the XML library 
Table of Contents
#define ATTRIBUTE_UNUSED
#define DEBUG_MEMORY_LOCATION
#define LIBXML_AUTOMATA_ENABLED
#define LIBXML_C14N_ENABLED
#define LIBXML_CATALOG_ENABLED
#define LIBXML_DEBUG_ENABLED
#define LIBXML_DOCB_ENABLED
#define LIBXML_DOTTED_VERSION
#define LIBXML_FTP_ENABLED
#define LIBXML_HTML_ENABLED
#define LIBXML_HTTP_ENABLED
#define LIBXML_ICONV_ENABLED
#define LIBXML_ISO8859X_ENABLED
#define LIBXML_LEGACY_ENABLED
#define LIBXML_OUTPUT_ENABLED
#define LIBXML_PUSH_ENABLED
#define LIBXML_READER_ENABLED
#define LIBXML_REGEXP_ENABLED
#define LIBXML_SAX1_ENABLED
#define LIBXML_SCHEMAS_ENABLED
#define LIBXML_TEST_VERSION
#define LIBXML_THREAD_ENABLED
#define LIBXML_TREE_ENABLED
#define LIBXML_UNICODE_ENABLED
#define LIBXML_VALID_ENABLED
#define LIBXML_VERSION
#define LIBXML_VERSION_STRING
#define LIBXML_WRITER_ENABLED
#define LIBXML_XINCLUDE_ENABLED
#define LIBXML_XPATH_ENABLED
#define LIBXML_XPTR_ENABLED
#define WITHOUT_TRIO
#define WITH_TRIO
void	xmlCheckVersion			(int version)

 
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

-
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_AUTOMATA_ENABLED
#define LIBXML_AUTOMATA_ENABLED
Whether the automata interfaces are compiled in

+
Macro: LIBXML_C14N_ENABLED
#define LIBXML_C14N_ENABLED
Whether the Canonicalization support is configured in

+
Macro: LIBXML_CATALOG_ENABLED
#define LIBXML_CATALOG_ENABLED
Whether the Catalog support is configured in

+
Macro: LIBXML_DEBUG_ENABLED
#define LIBXML_DEBUG_ENABLED
Whether Debugging module is configured in

+
Macro: LIBXML_DOCB_ENABLED
#define LIBXML_DOCB_ENABLED
Whether the SGML Docbook support is configured in

+
Macro: LIBXML_DOTTED_VERSION
#define LIBXML_DOTTED_VERSION
the version string like "1.2.3"

+
Macro: LIBXML_FTP_ENABLED
#define LIBXML_FTP_ENABLED
Whether the FTP support is configured in

+
Macro: LIBXML_HTML_ENABLED
#define LIBXML_HTML_ENABLED
Whether the HTML support is configured in

 
Macro: LIBXML_HTTP_ENABLED
#define LIBXML_HTTP_ENABLED
Whether the HTTP support is configured in

+
Macro: LIBXML_ICONV_ENABLED
#define LIBXML_ICONV_ENABLED
Whether iconv support is available

+
Macro: LIBXML_ISO8859X_ENABLED
#define LIBXML_ISO8859X_ENABLED
Whether ISO-8859-* support is made available in case iconv is not

+
Macro: LIBXML_LEGACY_ENABLED
#define LIBXML_LEGACY_ENABLED
Whether the deprecated APIs are compiled in for compatibility

 
Macro: LIBXML_OUTPUT_ENABLED
#define LIBXML_OUTPUT_ENABLED
Whether the serialization/saving support is configured in

-
Macro: WITH_TRIO
#define WITH_TRIO

+
Macro: LIBXML_PUSH_ENABLED
#define LIBXML_PUSH_ENABLED
Whether the push parsing interfaces are configured in

+
Macro: LIBXML_READER_ENABLED
#define LIBXML_READER_ENABLED
Whether the xmlReader parsing interface is configured in

+
Macro: LIBXML_REGEXP_ENABLED
#define LIBXML_REGEXP_ENABLED
Whether the regular expressions interfaces are compiled in

+
Macro: LIBXML_SAX1_ENABLED
#define LIBXML_SAX1_ENABLED
Whether the older SAX1 interface is configured in

+
Macro: LIBXML_SCHEMAS_ENABLED
#define LIBXML_SCHEMAS_ENABLED
Whether the Schemas validation interfaces are compiled 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_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_UNICODE_ENABLED
#define LIBXML_UNICODE_ENABLED
Whether the Unicode related interfaces are compiled in

+
Macro: LIBXML_VALID_ENABLED
#define LIBXML_VALID_ENABLED
Whether the DTD validation support is configured in

+
Macro: LIBXML_VERSION
#define LIBXML_VERSION
the version number: 1.2.3 value is 1002003

+
Macro: LIBXML_VERSION_STRING
#define LIBXML_VERSION_STRING
the version number string, 1.2.3 value is "1002003"

 
Macro: LIBXML_WRITER_ENABLED
#define LIBXML_WRITER_ENABLED
Whether the xmlWriter saving interface is configured in

+
Macro: LIBXML_XINCLUDE_ENABLED
#define LIBXML_XINCLUDE_ENABLED
Whether XInclude is configured in

+
Macro: LIBXML_XPATH_ENABLED
#define LIBXML_XPATH_ENABLED
Whether XPath is configured in

+
Macro: LIBXML_XPTR_ENABLED
#define LIBXML_XPTR_ENABLED
Whether XPointer is configured in

+
Macro: WITHOUT_TRIO
#define WITHOUT_TRIO
defined if the trio support should not be configured in

+
Macro: WITH_TRIO
#define WITH_TRIO

 
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
Daniel Veillard

diff --git a/doc/html/libxml-xmlwriter.html b/doc/html/libxml-xmlwriter.html
index 04cf778c..888a7039 100644
--- a/doc/html/libxml-xmlwriter.html
+++ b/doc/html/libxml-xmlwriter.html
@@ -82,147 +82,147 @@ The content of this structure is not made public by the API.
 
int	xmlTextWriterWriteVFormatRaw	(xmlTextWriterPtr writer, 
					 const char * format, 
					 va_list argptr)

 
int	xmlTextWriterWriteVFormatString	(xmlTextWriterPtr writer, 
					 const char * format, 
					 va_list argptr)

 
Description

-
Macro: xmlTextWriterWriteProcessingInstruction
#define xmlTextWriterWriteProcessingInstruction

-
Macro: xmlTextWriterEndDTDEntity
#define xmlTextWriterEndDTDEntity

-
Macro: xmlTextWriterEndDTDElement
#define xmlTextWriterEndDTDElement

 
Macro: xmlTextWriterEndDTDAttlist
#define xmlTextWriterEndDTDAttlist

+
Macro: xmlTextWriterEndDTDElement
#define xmlTextWriterEndDTDElement

+
Macro: xmlTextWriterEndDTDEntity
#define xmlTextWriterEndDTDEntity

 
Macro: xmlTextWriterWriteDocType
#define xmlTextWriterWriteDocType

+
Macro: xmlTextWriterWriteProcessingInstruction
#define xmlTextWriterWriteProcessingInstruction

 
Structure xmlTextWriter
Structure xmlTextWriter
struct _xmlTextWriter {
 The content of this structure is not made public by the API.
-}
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: 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: 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
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: 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: 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)

+}
Function: xmlFreeTextWriter
void	xmlFreeTextWriter		(xmlTextWriterPtr writer)

 
Deallocate all the resources associated to the writer

-
writer:the xmlTextWriterPtr
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
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)

+
writer:the xmlTextWriterPtr
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: 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: 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: 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)

+
uri:the URI of the resource for the output
compression:compress the output?
Returns:the new xmlTextWriterPtr or NULL in case of error
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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)

+
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: xmlTextWriterStartDTDAttlist
int	xmlTextWriterStartDTDAttlist	(xmlTextWriterPtr writer, 
					 const xmlChar * name)

+

+
writer:
name:
Returns:
Function: xmlTextWriterStartDTDElement
int	xmlTextWriterStartDTDElement	(xmlTextWriterPtr writer, 
					 const xmlChar * name)

+

+
writer:
name:
Returns:
Function: xmlTextWriterStartDTDEntity
int	xmlTextWriterStartDTDEntity	(xmlTextWriterPtr writer, 
					 int pe, 
					 const xmlChar * name)

+

+
writer:
pe:
name:
Returns:
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: 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: 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: 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: 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: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: 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: 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
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: 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: 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: 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:string content of the DTD
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:
format:
...:
Returns:
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, 
					 ... ...)

+
writer:
name:
content:
Returns:
Function: xmlTextWriterWriteDTDElement
int	xmlTextWriterWriteDTDElement	(xmlTextWriterPtr writer, 
					 const xmlChar * name, 
					 const xmlChar * content)

+

+
writer:
name:
content:
Returns:
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: 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: xmlTextWriterWriteDTDInternalEntity
int	xmlTextWriterWriteDTDInternalEntity	(xmlTextWriterPtr writer, 
						 int pe, 
						 const xmlChar * name, 
						 const xmlChar * content)

+

+
writer:
pe:
name:
content:
Returns:
Function: xmlTextWriterWriteDTDNotation
int	xmlTextWriterWriteDTDNotation	(xmlTextWriterPtr writer, 
					 const xmlChar * name, 
					 const xmlChar * pubid, 
					 const xmlChar * sysid)

+

+
writer:
name:
pubid:
sysid:
Returns:
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: 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: 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: 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: 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: 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: xmlTextWriterWriteFormatDTD
int	xmlTextWriterWriteFormatDTD	(xmlTextWriterPtr writer, 
					 const xmlChar * name, 
					 const xmlChar * pubid, 
					 const xmlChar * sysid, 
					 const char * format, 
					 ... ...)

+
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: 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: 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: 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: xmlTextWriterWriteDTDElement
int	xmlTextWriterWriteDTDElement	(xmlTextWriterPtr writer, 
					 const xmlChar * name, 
					 const xmlChar * content)

+
writer:
name:
format:
...:
Returns:
Function: xmlTextWriterWriteFormatDTDElement
int	xmlTextWriterWriteFormatDTDElement	(xmlTextWriterPtr writer, 
						 const xmlChar * name, 
						 const char * format, 
						 ... ...)

 

-
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:string content of the DTD
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:
name:
format:
...:
Returns:
Function: xmlTextWriterWriteFormatDTDInternalEntity
int	xmlTextWriterWriteFormatDTDInternalEntity	(xmlTextWriterPtr writer, 
							 int pe, 
							 const xmlChar * name, 
							 const char * format, 
							 ... ...)

 

-
writer:
pe:
name:
Returns:
Function: xmlTextWriterWriteVFormatDTDElement
int	xmlTextWriterWriteVFormatDTDElement	(xmlTextWriterPtr writer, 
						 const xmlChar * name, 
						 const char * format, 
						 va_list argptr)

-

-
writer:
name:
format:
argptr:
Returns:
Function: xmlTextWriterStartDTDElement
int	xmlTextWriterStartDTDElement	(xmlTextWriterPtr writer, 
					 const xmlChar * name)

-

-
writer:
name:
Returns:
Function: xmlTextWriterWriteFormatElementNS
int	xmlTextWriterWriteFormatElementNS	(xmlTextWriterPtr writer, 
						 const xmlChar * prefix, 
						 const xmlChar * name, 
						 const xmlChar * namespaceURI, 
						 const char * format, 
						 ... ...)

+
writer:
pe:
name:
format:
...:
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: 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

+
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
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: 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: 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: 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: 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: xmlTextWriterWriteRawLen
int	xmlTextWriterWriteRawLen	(xmlTextWriterPtr writer, 
					 const xmlChar * content, 
					 int len)

+

+
writer:
content:
len:
Returns:
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: 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
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: 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: 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: 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: xmlTextWriterWriteVFormatDTDAttlist
int	xmlTextWriterWriteVFormatDTDAttlist	(xmlTextWriterPtr writer, 
						 const xmlChar * name, 
						 const char * format, 
						 va_list argptr)

+

+
writer:
name:
format:
argptr:
Returns:
Function: xmlTextWriterWriteVFormatDTDElement
int	xmlTextWriterWriteVFormatDTDElement	(xmlTextWriterPtr writer, 
						 const xmlChar * name, 
						 const char * format, 
						 va_list argptr)

+

+
writer:
name:
format:
argptr:
Returns:
Function: xmlTextWriterWriteVFormatDTDInternalEntity
int	xmlTextWriterWriteVFormatDTDInternalEntity	(xmlTextWriterPtr writer, 
							 int pe, 
							 const xmlChar * name, 
							 const char * format, 
							 va_list argptr)

+

+
writer:
pe:
name:
format:
argptr:
Returns:
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: 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: 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: 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: 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
Daniel Veillard

diff --git a/doc/html/libxml-xpath.html b/doc/html/libxml-xpath.html
index 5bc83c8a..156c37f0 100644
--- a/doc/html/libxml-xpath.html
+++ b/doc/html/libxml-xpath.html
@@ -82,19 +82,16 @@ void	xmlXPathFunction		(Macro: xmlXPathNodeSetGetLength
#define xmlXPathNodeSetGetLength
Implement a functionality similar to the DOM NodeList.length. Returns the number of nodes in the node-set.

 
Macro: xmlXPathNodeSetIsEmpty
#define xmlXPathNodeSetIsEmpty
Checks whether @ns is empty or not. Returns %TRUE if @ns is an empty node-set.

 
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)

-
xmlXPathObjectType
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
-}
-
Structure xmlXPathContext
Structure xmlXPathContext
struct _xmlXPathContext {
+
Structure xmlNodeSet
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 @
+}
Structure xmlXPathAxis
Structure xmlXPathAxis
struct _xmlXPathAxis {
+    const xmlChar *	name	: the axis name
+    xmlXPathAxisFunc	func	: the search function
+}
Structure xmlXPathCompExpr
Structure xmlXPathCompExpr
struct _xmlXPathCompExpr {
+The content of this structure is not made public by the API.
+}
Structure xmlXPathContext
Structure xmlXPathContext
struct _xmlXPathContext {
     xmlDocPtr	doc	: The current document
     xmlNodePtr	node	: The current node
     int	nb_variables_unused	: unused (hash table)
@@ -131,13 +128,7 @@ void	xmlXPathFunction		(xmlStructuredErrorFunc	error	: the callback in case of errors
     xmlError	lastError	: the last error
     xmlNodePtr	debugNode	: the source node XSLT
-}
Structure xmlXPathType
Structure xmlXPathType
struct _xmlXPathType {
-    const xmlChar *	name	: the type name
-    xmlXPathConvertFunc	func	: the conversion function
-}
Structure xmlXPathFunct
Structure xmlXPathFunct
struct _xmlXPathFunct {
-    const xmlChar *	name	: the function name
-    xmlXPathEvalFunc	func	: the evaluation function
-}
xmlXPathError
Enum xmlXPathError {
+}
Enum xmlXPathError
Enum xmlXPathError {
     XPATH_EXPRESSION_OK = 0
     XPATH_NUMBER_ERROR = 1
     XPATH_UNFINISHED_LITERAL_ERROR = 2
@@ -161,7 +152,10 @@ void	xmlXPathFunction		(XPATH_ENCODING_ERROR = 20
     XPATH_INVALID_CHAR_ERROR = 21
 }
-
Structure xmlXPathObject
Structure xmlXPathObject
struct _xmlXPathObject {
+
Structure xmlXPathFunct
Structure xmlXPathFunct
struct _xmlXPathFunct {
+    const xmlChar *	name	: the function name
+    xmlXPathEvalFunc	func	: the evaluation function
+}
Structure xmlXPathObject
Structure xmlXPathObject
struct _xmlXPathObject {
     xmlXPathObjectType	type
     xmlNodeSetPtr	nodesetval
     int	boolval
@@ -171,19 +165,19 @@ void	xmlXPathFunction		(Structure xmlXPathCompExpr
Structure xmlXPathCompExpr
struct _xmlXPathCompExpr {
-The content of this structure is not made public by the API.
-}
Structure xmlNodeSet
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 @
-}
Structure xmlXPathVariable
Structure xmlXPathVariable
struct _xmlXPathVariable {
-    const xmlChar *	name	: the variable name
-    xmlXPathObjectPtr	value	: the value
-}
Structure xmlXPathAxis
Structure xmlXPathAxis
struct _xmlXPathAxis {
-    const xmlChar *	name	: the axis name
-    xmlXPathAxisFunc	func	: the search function
-}
Structure xmlXPathParserContext
Structure xmlXPathParserContext
struct _xmlXPathParserContext {
+}
Enum xmlXPathObjectType
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
+}
+
Structure xmlXPathParserContext
Structure xmlXPathParserContext
struct _xmlXPathParserContext {
     const xmlChar *	cur	: the current char being parsed
     const xmlChar *	base	: the full expression
     int	error	: error code
@@ -195,86 +189,92 @@ The content of this structure is not made public by the API.
     xmlXPathCompExprPtr	comp	: the precompiled expression
     int	xptr	: it this an XPointer expression
     xmlNodePtr	ancestor	: used for walking preceding axis
-}
Function: xmlXPathCastNodeSetToString
xmlChar *	xmlXPathCastNodeSetToString	(xmlNodeSetPtr ns)

-
Converts a node-set to its string value.

-
ns:a node-set
Returns:a newly allocated string.
Function: xmlXPathCastNodeSetToBoolean
int	xmlXPathCastNodeSetToBoolean	(xmlNodeSetPtr ns)

-
Converts a node-set to its boolean value

-
ns:a node-set
Returns:the boolean value
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.
Function: xmlXPathCastNodeToString
xmlChar *	xmlXPathCastNodeToString	(xmlNodePtr node)

-
Converts a node to its string value.

-
node:a node
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: 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: xmlXPathInit
void	xmlXPathInit			(void)

-
Initialize the XPath environment

-
Function: xmlXPathCastStringToBoolean
int	xmlXPathCastStringToBoolean	(const xmlChar * val)

-
Converts a string to its boolean value

-
val:a string
Returns:the boolean value
Function type: xmlXPathConvertFunc
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


-
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: 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.
Function type: xmlXPathFunction
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


-
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: 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: xmlXPathCastBooleanToNumber
double	xmlXPathCastBooleanToNumber	(int val)

-
Converts a boolean to its number value

-
val:a boolean
Returns:the number value
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: xmlXPathCastStringToNumber
double	xmlXPathCastStringToNumber	(const xmlChar * val)

-
Converts a string to its number value

-
val:a string
Returns:the number value
Function type: xmlXPathAxisFunc
Function type: xmlXPathAxisFunc
+}
Structure xmlXPathType
Structure xmlXPathType
struct _xmlXPathType {
+    const xmlChar *	name	: the type name
+    xmlXPathConvertFunc	func	: the conversion function
+}
Structure xmlXPathVariable
Structure xmlXPathVariable
struct _xmlXPathVariable {
+    const xmlChar *	name	: the variable name
+    xmlXPathObjectPtr	value	: the value
+}
Function type: xmlXPathAxisFunc
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.


-
Function: xmlXPathCastToNumber
double	xmlXPathCastToNumber		(xmlXPathObjectPtr val)

-
Converts an XPath object to its number value

-
val:an XPath object
Returns:the number value
Function: xmlXPathCastBooleanToString
xmlChar *	xmlXPathCastBooleanToString	(int val)

+
Function: xmlXPathCastBooleanToNumber
double	xmlXPathCastBooleanToNumber	(int val)

+
Converts a boolean to its number value

+
val:a boolean
Returns:the number value
Function: xmlXPathCastBooleanToString
xmlChar *	xmlXPathCastBooleanToString	(int val)

 
Converts a boolean to its string value.

-
val:a boolean
Returns:a newly allocated string.
Function: xmlXPathCastNodeToNumber
double	xmlXPathCastNodeToNumber	(xmlNodePtr node)

+
val:a boolean
Returns:a newly allocated string.
Function: xmlXPathCastNodeSetToBoolean
int	xmlXPathCastNodeSetToBoolean	(xmlNodeSetPtr ns)

+
Converts a node-set to its boolean value

+
ns:a node-set
Returns:the boolean value
Function: xmlXPathCastNodeSetToNumber
double	xmlXPathCastNodeSetToNumber	(xmlNodeSetPtr ns)

+
Converts a node-set to its number value

+
ns:a node-set
Returns:the number value
Function: xmlXPathCastNodeSetToString
xmlChar *	xmlXPathCastNodeSetToString	(xmlNodeSetPtr ns)

+
Converts a node-set to its string value.

+
ns:a node-set
Returns:a newly allocated string.
Function: xmlXPathCastNodeToNumber
double	xmlXPathCastNodeToNumber	(xmlNodePtr node)

 
Converts a node to its number value

-
node:a node
Returns:the number value
Function: xmlXPathCastNumberToBoolean
int	xmlXPathCastNumberToBoolean	(double val)

+
node:a node
Returns:the number value
Function: xmlXPathCastNodeToString
xmlChar *	xmlXPathCastNodeToString	(xmlNodePtr node)

+
Converts a node to its string value.

+
node:a node
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: 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 type: xmlXPathEvalFunc
Function type: xmlXPathEvalFunc
+
val:a number
Returns:the boolean value
Function: xmlXPathCastNumberToString
xmlChar *	xmlXPathCastNumberToString	(double val)

+
Converts a number to its string value.

+
val:a number
Returns:a newly allocated string.
Function: xmlXPathCastStringToBoolean
int	xmlXPathCastStringToBoolean	(const xmlChar * val)

+
Converts a string to its boolean value

+
val:a string
Returns:the boolean value
Function: xmlXPathCastStringToNumber
double	xmlXPathCastStringToNumber	(const xmlChar * val)

+
Converts a string to its number value

+
val:a string
Returns:the number value
Function: xmlXPathCastToBoolean
int	xmlXPathCastToBoolean		(xmlXPathObjectPtr val)

+
Converts an XPath object to its boolean value

+
val:an XPath object
Returns:the boolean value
Function: xmlXPathCastToNumber
double	xmlXPathCastToNumber		(xmlXPathObjectPtr val)

+
Converts an XPath object to its number value

+
val:an XPath object
Returns:the number value
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: 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: 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: 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.
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 type: xmlXPathConvertFunc
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


+
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: 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: 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: 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 type: xmlXPathEvalFunc
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: xmlXPathFreeCompExpr
void	xmlXPathFreeCompExpr		(xmlXPathCompExprPtr comp)

-
Free up the memory allocated by @comp

-
comp:an XPATH comp
Function: xmlXPathObjectCopy
xmlXPathObjectPtr	xmlXPathObjectCopy	(xmlXPathObjectPtr val)

-
allocate a new copy of a given object

-
val:the original object
Returns:the newly created object.
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.
Function: xmlXPathEvalPredicate
int	xmlXPathEvalPredicate		(xmlXPathContextPtr ctxt, 
					 xmlXPathObjectPtr res)

+
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: 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: 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: xmlXPathFreeObject
void	xmlXPathFreeObject		(xmlXPathObjectPtr obj)

-
Free up an xmlXPathObjectPtr object.

-
obj:the object to free
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: xmlXPathFreeNodeSet
void	xmlXPathFreeNodeSet		(xmlNodeSetPtr obj)

-
Free the NodeSet compound (not the actual nodes !).

-
obj:the xmlNodeSetPtr to free
Function: xmlXPathCastNodeSetToNumber
double	xmlXPathCastNodeSetToNumber	(xmlNodeSetPtr ns)

-
Converts a node-set to its number value

-
ns:a node-set
Returns:the number value
Function: xmlXPathFreeContext
void	xmlXPathFreeContext		(xmlXPathContextPtr ctxt)

+
ctxt:the XPath context
res:the Predicate Expression evaluation result
Returns:1 if predicate is true, 0 otherwise
Function: xmlXPathFreeCompExpr
void	xmlXPathFreeCompExpr		(xmlXPathCompExprPtr comp)

+
Free up the memory allocated by @comp

+
comp:an XPATH comp
Function: xmlXPathFreeContext
void	xmlXPathFreeContext		(xmlXPathContextPtr ctxt)

 
Free up an xmlXPathContext

-
ctxt:the context to free
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: xmlXPathCastNumberToString
xmlChar *	xmlXPathCastNumberToString	(double val)

-
Converts a number to its string value.

-
val:a number
Returns:a newly allocated string.
Function: xmlXPathCastToBoolean
int	xmlXPathCastToBoolean		(xmlXPathObjectPtr val)

-
Converts an XPath object to its boolean value

-
val:an XPath object
Returns:the boolean value
Daniel Veillard

+
ctxt:the context to free
Function: xmlXPathFreeNodeSet
void	xmlXPathFreeNodeSet		(xmlNodeSetPtr obj)

+
Free the NodeSet compound (not the actual nodes !).

+
obj:the xmlNodeSetPtr 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: xmlXPathFreeObject
void	xmlXPathFreeObject		(xmlXPathObjectPtr obj)

+
Free up an xmlXPathObjectPtr object.

+
obj:the object to free
Function type: xmlXPathFunction
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


+
Function: xmlXPathInit
void	xmlXPathInit			(void)

+
Initialize the XPath environment

+
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: 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: 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.
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: xmlXPathObjectCopy
xmlXPathObjectPtr	xmlXPathObjectCopy	(xmlXPathObjectPtr val)

+
allocate a new copy of a given object

+
val:the original object
Returns:the newly created object.
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.
Daniel Veillard

diff --git a/doc/html/libxml-xpathInternals.html b/doc/html/libxml-xpathInternals.html
index 99515871..6e97b1bc 100644
--- a/doc/html/libxml-xpathInternals.html
+++ b/doc/html/libxml-xpathInternals.html
@@ -134,273 +134,273 @@ A:link, A:visited, A:active { text-decoration: underline }
 
xmlXPathObjectPtr	xmlXPathWrapString	(xmlChar * val)

 
void	xmlXPatherror			(xmlXPathParserContextPtr ctxt, 
					 const char * file, 
					 int line, 
					 int no)

 
Description

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

-
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: CAST_TO_BOOLEAN
#define CAST_TO_BOOLEAN
Macro to try to cast the value on the top of the XPath stack to a boolean.

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

+
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: CHECK_ARITY
#define CHECK_ARITY
Macro to check that the number of args passed to an XPath function matches.

+
Macro: CHECK_ERROR
#define CHECK_ERROR
Macro to return from the function if an XPath error was detected.

+
Macro: CHECK_ERROR0
#define CHECK_ERROR0
Macro to return 0 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.

+
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

+
Macro: XP_ERROR
#define XP_ERROR
Macro to raise an XPath error and return.

 
Macro: XP_ERROR0
#define XP_ERROR0
Macro to raise an XPath error and return 0.

 
Macro: xmlXPathCheckError
#define xmlXPathCheckError
Check if an XPath error was raised. Returns true if an error has been raised, false otherwise.

-
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: xmlXPathSetTypeError
#define xmlXPathSetTypeError
Raises an XPATH_INVALID_TYPE error.

-
Macro: xmlXPathReturnEmptyNodeSet
#define xmlXPathReturnEmptyNodeSet
Pushes an empty node-set on the context stack.

-
Macro: xmlXPathReturnString
#define xmlXPathReturnString
Pushes the string @str on the context stack.

-
Macro: xmlXPathReturnTrue
#define xmlXPathReturnTrue
Pushes true on the context stack.

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

-
Macro: xmlXPathSetArityError
#define xmlXPathSetArityError
Raises an XPATH_INVALID_ARITY error.

-
Macro: xmlXPathReturnBoolean
#define xmlXPathReturnBoolean
Pushes the boolean @val on the context stack.

-
Macro: CHECK_TYPE
#define CHECK_TYPE
Macro to check that the value on top of the XPath stack is of a given type.

+
Macro: xmlXPathEmptyNodeSet
#define xmlXPathEmptyNodeSet
Empties a node-set.

 
Macro: xmlXPathGetContextNode
#define xmlXPathGetContextNode
Get the context node of an XPath context. Returns the context node.

-
Macro: xmlXPathReturnFalse
#define xmlXPathReturnFalse
Pushes false on the context stack.

-
Macro: xmlXPathReturnNumber
#define xmlXPathReturnNumber
Pushes the double @val on the context stack.

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

-
Macro: CHECK_ERROR0
#define CHECK_ERROR0
Macro to return 0 from the function if an XPath error was detected.

-
Macro: xmlXPathReturnExternal
#define xmlXPathReturnExternal
Pushes user data on the context stack.

 
Macro: xmlXPathGetDocument
#define xmlXPathGetDocument
Get the document of an XPath context. Returns the context document.

 
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.

-
Macro: CHECK_ARITY
#define CHECK_ARITY
Macro to check that the number of args passed to an XPath function matches.

-
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

-
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: xmlXPathEmptyNodeSet
#define xmlXPathEmptyNodeSet
Empties a node-set.

+
Macro: xmlXPathReturnBoolean
#define xmlXPathReturnBoolean
Pushes the boolean @val on the context stack.

+
Macro: xmlXPathReturnEmptyNodeSet
#define xmlXPathReturnEmptyNodeSet
Pushes an empty node-set on the context stack.

+
Macro: xmlXPathReturnEmptyString
#define xmlXPathReturnEmptyString
Pushes an empty string on the stack.

+
Macro: xmlXPathReturnExternal
#define xmlXPathReturnExternal
Pushes user data on the context stack.

+
Macro: xmlXPathReturnFalse
#define xmlXPathReturnFalse
Pushes false on the context stack.

 
Macro: xmlXPathReturnNodeSet
#define xmlXPathReturnNodeSet
Pushes the node-set @ns on the context stack.

-
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
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: 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: 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
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.
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: 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.
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: 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
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: 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: 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: xmlXPathWrapNodeSet
xmlXPathObjectPtr	xmlXPathWrapNodeSet	(xmlNodeSetPtr val)

-
Wrap the Nodeset @val in a new xmlXPathObjectPtr

-
val:the NodePtr value
Returns:the newly created object.
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
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: 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: 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: 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: 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: 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
Function: xmlXPathRegisteredNsCleanup
void	xmlXPathRegisteredNsCleanup	(xmlXPathContextPtr ctxt)

-
Cleanup the XPath context data associated to registered variables

-
ctxt:the XPath context
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: 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)

+
Macro: xmlXPathReturnNumber
#define xmlXPathReturnNumber
Pushes the double @val on the context stack.

+
Macro: xmlXPathReturnString
#define xmlXPathReturnString
Pushes the string @str on the context stack.

+
Macro: xmlXPathReturnTrue
#define xmlXPathReturnTrue
Pushes true on the context stack.

+
Macro: xmlXPathSetArityError
#define xmlXPathSetArityError
Raises an XPATH_INVALID_ARITY error.

+
Macro: xmlXPathSetError
#define xmlXPathSetError
Raises an error.

+
Macro: xmlXPathSetTypeError
#define xmlXPathSetTypeError
Raises an XPATH_INVALID_TYPE error.

+
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: 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: 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
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
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: 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: 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
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.
Function: xmlXPathNodeSetDel
void	xmlXPathNodeSetDel		(xmlNodeSetPtr cur, 
					 xmlNodePtr val)

-
Removes an xmlNodePtr from an existing NodeSet

-
cur:the initial node set
val:an xmlNodePtr
Function: xmlXPathWrapString
xmlXPathObjectPtr	xmlXPathWrapString	(xmlChar * val)

-
Wraps the @val string into an XPath object.

-
val:the xmlChar * value
Returns:the newly created object.
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
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 type: xmlXPathFuncLookupFunc
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.


-
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
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: 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: 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
Function type: xmlXPathVariableLookupFunc
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.


-
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: 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: 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
Function: valuePush
int	valuePush			(xmlXPathParserContextPtr ctxt, 
					 xmlXPathObjectPtr value)

+
ctxt:an XPath evaluation context
Returns:the XPath object just removed
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:an XPath evaluation context
value:the XPath object
Returns:the number of items on the value stack
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.
Function: xmlXPathErr
void	xmlXPathErr			(xmlXPathParserContextPtr ctxt, 
					 int error)

+
Handle a Relax NG Parsing error

+
ctxt:a XPath parser context
error:the error code
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: 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
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: 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: 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)

+
ctxt:the XPath Parser context
nargs:the number of arguments
Function: xmlXPathFreeParserContext
void	xmlXPathFreeParserContext	(xmlXPathParserContextPtr ctxt)

+
Free up an xmlXPathParserContext

+
ctxt:the context to free
Function type: xmlXPathFuncLookupFunc
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.


+
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
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: 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: 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
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: 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: 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: 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: 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: 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: 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
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
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: 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: 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: xmlXPathParseName
xmlChar *	xmlXPathParseName	(xmlXPathParserContextPtr ctxt)

+
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: 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
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: 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: 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: 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: 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: 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: 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: 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.
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: 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: 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: 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: 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: 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: 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: 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
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: xmlXPathNodeSetDel
void	xmlXPathNodeSetDel		(xmlNodeSetPtr cur, 
					 xmlNodePtr val)

+
Removes an xmlNodePtr from an existing NodeSet

+
cur:the initial node set
val:an xmlNodePtr
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: 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: 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: xmlXPathNodeSetSort
void	xmlXPathNodeSetSort		(xmlNodeSetPtr set)

+
Sort the node set in document order

+
set:the node set
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: 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: 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: 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.
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: 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: 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: 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: 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
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)

+
ctxt:the XPath Parser context
Returns:the namespace name or NULL
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: 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: 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
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

+
ctxt:an XPath parser context
Returns:the number
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: 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
Function: xmlXPathRegisterAllFunctions
void	xmlXPathRegisterAllFunctions	(xmlXPathContextPtr ctxt)

+
Registers all default XPath functions in this context

+
ctxt:the XPath context
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: 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: 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: 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: 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: 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
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
Function: xmlXPathRegisteredFuncsCleanup
void	xmlXPathRegisteredFuncsCleanup	(xmlXPathContextPtr ctxt)

+
Cleanup the XPath context data associated to registered functions

+
ctxt:the XPath context
Function: xmlXPathRegisteredNsCleanup
void	xmlXPathRegisteredNsCleanup	(xmlXPathContextPtr ctxt)

+
Cleanup the XPath context data associated to registered variables

+
ctxt:the XPath context
Function: xmlXPathRegisteredVariablesCleanup
void	xmlXPathRegisteredVariablesCleanup	(xmlXPathContextPtr ctxt)

+
Cleanup the XPath context data associated to registered variables

+
ctxt:the XPath context
Function: xmlXPathRoot
void	xmlXPathRoot			(xmlXPathParserContextPtr ctxt)

+
Initialize the context to the root of the document

+
ctxt:the XPath Parser context
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
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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 type: xmlXPathVariableLookupFunc
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.


+
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: xmlXPathWrapCString
xmlXPathObjectPtr	xmlXPathWrapCString	(char * val)

+
Wraps a string into an XPath object.

+
val:the char * value
Returns:the newly created object.
Function: xmlXPathWrapExternal
xmlXPathObjectPtr	xmlXPathWrapExternal	(void * val)

+
Wraps the @val data into an XPath object.

+
val:the user data
Returns:the newly created object.
Function: xmlXPathWrapNodeSet
xmlXPathObjectPtr	xmlXPathWrapNodeSet	(xmlNodeSetPtr val)

+
Wrap the Nodeset @val in a new xmlXPathObjectPtr

+
val:the NodePtr value
Returns:the newly created object.
Function: xmlXPathWrapString
xmlXPathObjectPtr	xmlXPathWrapString	(xmlChar * val)

+
Wraps the @val string into an XPath object.

+
val:the xmlChar * value
Returns:the newly created object.
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
Daniel Veillard

diff --git a/doc/html/libxml-xpointer.html b/doc/html/libxml-xpointer.html
index 19e2440b..f06aea59 100644
--- a/doc/html/libxml-xpointer.html
+++ b/doc/html/libxml-xpointer.html
@@ -38,46 +38,46 @@ A:link, A:visited, A:active { text-decoration: underline }
     int	locNr	: number of locations in the set
     int	locMax	: size of the array as allocated
     xmlXPathObjectPtr *	locTab	: array of locations
-}
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: 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: xmlXPtrBuildNodeList
xmlNodePtr	xmlXPtrBuildNodeList	(xmlXPathObjectPtr obj)

+}
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: 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: 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: xmlXPtrEval
xmlXPathObjectPtr	xmlXPtrEval	(const xmlChar * str, 
					 xmlXPathContextPtr ctx)

+
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: xmlXPtrRangeToFunction
void	xmlXPtrRangeToFunction		(xmlXPathParserContextPtr ctxt, 
					 int nargs)

-
Implement the range-to() XPointer function

-
ctxt:the XPointer Parser context
nargs:the number of args
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: 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: 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: 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.
Function: xmlXPtrLocationSetDel
void	xmlXPtrLocationSetDel		(xmlLocationSetPtr cur, 
					 xmlXPathObjectPtr val)

+
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: 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: xmlXPtrFreeLocationSet
void	xmlXPtrFreeLocationSet		(xmlLocationSetPtr obj)

+
Free the LocationSet compound (not the actual ranges !).

+
obj:the xmlLocationSetPtr to free
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: 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: xmlXPtrLocationSetDel
void	xmlXPtrLocationSetDel		(xmlLocationSetPtr cur, 
					 xmlXPathObjectPtr val)

 
Removes an xmlXPathObjectPtr from an existing LocationSet

 
cur:the initial range set
val:an xmlXPathObjectPtr
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: 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: xmlXPtrNewLocationSetNodes
xmlXPathObjectPtr	xmlXPtrNewLocationSetNodes	(xmlNodePtr start, 
							 xmlNodePtr end)

+
val1:the first LocationSet
val2:the second LocationSet
Returns:val1 once extended or NULL in case of error.
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: 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: 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: 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: 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.
Daniel Veillard

+
start:the start NodePtr value
end:the end NodePtr value or NULL
Returns:the newly created object.
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: 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: 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.
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: 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: 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: xmlXPtrRangeToFunction
void	xmlXPtrRangeToFunction		(xmlXPathParserContextPtr ctxt, 
					 int nargs)

+
Implement the range-to() XPointer function

+
ctxt:the XPointer Parser context
nargs:the number of args
Function: xmlXPtrWrapLocationSet
xmlXPathObjectPtr	xmlXPtrWrapLocationSet	(xmlLocationSetPtr val)

+
Wrap the LocationSet @val in a new xmlXPathObjectPtr

+
val:the LocationSet value
Returns:the newly created object.
Daniel Veillard

diff --git a/doc/newapi.xsl b/doc/newapi.xsl
index 2748a7b7..72b8cfff 100644
--- a/doc/newapi.xsl
+++ b/doc/newapi.xsl
@@ -207,7 +207,7 @@
 
   
     
-    

+    
Enum 

     
       Enum 
       
@@ -555,6 +555,25 @@
     
   
 
+  
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+    
+      
+    
+  
+  
   
     
     Module  from 
@@ -622,7 +641,21 @@
 		
Description

 		
 
-		
+		
+		  
+		
+		
+		  
+		
+		
+		  
+		
+		
+		  
+		
+		
+		  
+		
 	      
 	    
 					
Daniel Veillard