From d03a853bb0370d89552eceee59df1746da4a37f8 Mon Sep 17 00:00:00 2001 From: Mike Hommey Date: Sun, 1 Mar 2009 10:53:23 +0100 Subject: Import upstream version 2.7.0 --- doc/devhelp/Makefile.in | 4 +- doc/devhelp/libxml2-c14n.html | 4 +- doc/devhelp/libxml2-entities.html | 5 +++ doc/devhelp/libxml2-globals.html | 16 +++---- doc/devhelp/libxml2-parser.html | 5 ++- doc/devhelp/libxml2-parserInternals.html | 14 +++--- doc/devhelp/libxml2-relaxng.html | 8 ++-- doc/devhelp/libxml2-schematron.html | 8 ++-- doc/devhelp/libxml2-tree.html | 28 ++++++++++-- doc/devhelp/libxml2-uri.html | 6 +-- doc/devhelp/libxml2-valid.html | 4 +- doc/devhelp/libxml2-xmlerror.html | 4 ++ doc/devhelp/libxml2-xmlmemory.html | 5 +++ doc/devhelp/libxml2-xmlreader.html | 4 +- doc/devhelp/libxml2-xmlregexp.html | 4 +- doc/devhelp/libxml2-xmlschemas.html | 73 +++++++++++++++++--------------- doc/devhelp/libxml2.devhelp | 20 +++++++++ 17 files changed, 137 insertions(+), 75 deletions(-) (limited to 'doc/devhelp') diff --git a/doc/devhelp/Makefile.in b/doc/devhelp/Makefile.in index 169521d..1257ad4 100644 --- a/doc/devhelp/Makefile.in +++ b/doc/devhelp/Makefile.in @@ -1,8 +1,8 @@ -# Makefile.in generated by automake 1.10 from Makefile.am. +# Makefile.in generated by automake 1.10.1 from Makefile.am. # @configure_input@ # Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, -# 2003, 2004, 2005, 2006 Free Software Foundation, Inc. +# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. # This Makefile.in is free software; the Free Software Foundation # gives unlimited permission to copy and/or distribute it, # with or without modifications, as long as this notice is preserved. diff --git a/doc/devhelp/libxml2-c14n.html b/doc/devhelp/libxml2-c14n.html index 72f53b6..e60f229 100644 --- a/doc/devhelp/libxml2-c14n.html +++ b/doc/devhelp/libxml2-c14n.html @@ -57,8 +57,8 @@ int xmlC14NDocDumpMemory (

Function type xmlC14NIsVisibleCallback

int	xmlC14NIsVisibleCallback	(void * user_data, 
xmlNodePtr node,
xmlNodePtr parent)
-

-

user_data:
node:
parent:
Returns:
+

Signature for a C14N callback on visible nodes

+
user_data:user data
node:the curent node
parent:the parent node
Returns:1 if the node should be included

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)

diff --git a/doc/devhelp/libxml2-entities.html b/doc/devhelp/libxml2-entities.html index cd1e9a8..0d0effb 100644 --- a/doc/devhelp/libxml2-entities.html +++ b/doc/devhelp/libxml2-entities.html @@ -47,6 +47,7 @@ typedef struct _xmlHashTable xmlEntitiesTable; typedef xmlEntitiesTable * xmlEntitiesTablePtr; xmlEntityPtr xmlAddDocEntity (xmlDocPtr doc,
const xmlChar * name,
int type,
const xmlChar * ExternalID,
const xmlChar * SystemID,
const xmlChar * content); +xmlEntityPtr xmlNewEntity (xmlDocPtr doc,
const xmlChar * name,
int type,
const xmlChar * ExternalID,
const xmlChar * SystemID,
const xmlChar * content); xmlChar * xmlEncodeEntitiesReentrant (xmlDocPtr doc,
const xmlChar * input); xmlEntityPtr xmlGetDocEntity (xmlDocPtr doc,
const xmlChar * name); xmlEntityPtr xmlGetDtdEntity (xmlDocPtr doc,
const xmlChar * name); @@ -155,6 +156,10 @@ The content of this structure is not made public by the API.

Set up the predefined entities. Deprecated call


+

xmlNewEntity ()

xmlEntityPtr	xmlNewEntity		(xmlDocPtr doc, 
const xmlChar * name,
int type,
const xmlChar * ExternalID,
const xmlChar * SystemID,
const xmlChar * content)
+

Create a new entity, this differs from xmlAddDocEntity() that if the document is NULL or has no internal subset defined, then an unlinked entity structure will be returned, it is then the responsability of the caller to link it to the document later or free it when not needed anymore.

+
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
+
diff --git a/doc/devhelp/libxml2-globals.html b/doc/devhelp/libxml2-globals.html index c7f396e..449049e 100644 --- a/doc/devhelp/libxml2-globals.html +++ b/doc/devhelp/libxml2-globals.html @@ -125,20 +125,20 @@ const char * xmlThrDefTreeIndentString

Function type xmlDeregisterNodeFunc

void	xmlDeregisterNodeFunc		(xmlNodePtr node)
-

-

node:
+

Signature for the deregistration callback of a discarded node

+
node:the current node

Function type xmlOutputBufferCreateFilenameFunc

xmlOutputBufferPtr	xmlOutputBufferCreateFilenameFunc	(const char * URI, 
xmlCharEncodingHandlerPtr encoder,
int compression)
-

-

URI:
encoder:
compression:
Returns:
+

Signature for the function doing the lookup for a suitable output method corresponding to an URI.

+
URI:the URI to write to
encoder:
compression:
Returns:the new xmlOutputBufferPtr in case of success or NULL if no method was found.

Function type xmlParserInputBufferCreateFilenameFunc

xmlParserInputBufferPtr	xmlParserInputBufferCreateFilenameFunc	(const char * URI, 
xmlCharEncoding enc)
-

-

URI:
enc:
Returns:
+

Signature for the function doing the lookup for a suitable input method corresponding to an URI.

+
URI:the URI to read from
enc:the requested source encoding
Returns:the new xmlParserInputBufferPtr in case of success or NULL if no method was found.

Function type xmlRegisterNodeFunc

void	xmlRegisterNodeFunc		(xmlNodePtr node)
-

-

node:
+

Signature for the registration callback of a created node

+
node:the current node

Variable docbDefaultSAXHandler

xmlSAXHandlerV1 docbDefaultSAXHandler;
 

diff --git a/doc/devhelp/libxml2-parser.html b/doc/devhelp/libxml2-parser.html index 76b4967..ea0697f 100644 --- a/doc/devhelp/libxml2-parser.html +++ b/doc/devhelp/libxml2-parser.html @@ -302,7 +302,10 @@ void xmlSetExternalEntityLoader (XML_PARSE_NSCLEAN = 8192 /* remove redundant namespaces declarations */ XML_PARSE_NOCDATA = 16384 /* merge CDATA as text nodes */ XML_PARSE_NOXINCNODE = 32768 /* do not generate XINCLUDE START/END nodes */ - XML_PARSE_COMPACT = 65536 /* compact small text nodes; no modification of the tree allowed afterwards (will possibly crash if you try to modify the tree) */ + XML_PARSE_COMPACT = 65536 /* compact small text nodes; no modification of the tree allowed afterwards (will possibly crash if you try to modify the tree) */ + XML_PARSE_OLD10 = 131072 /* parse using XML-1.0 before update 5 */ + XML_PARSE_NOBASEFIX = 262144 /* do not fixup XINCLUDE xml:base uris */ + XML_PARSE_HUGE = 524288 /* relax any hardcoded limit from the parser */ };

diff --git a/doc/devhelp/libxml2-parserInternals.html b/doc/devhelp/libxml2-parserInternals.html index 1e575f8..cdae32e 100644 --- a/doc/devhelp/libxml2-parserInternals.html +++ b/doc/devhelp/libxml2-parserInternals.html @@ -139,7 +139,7 @@ int xmlParseElementContentDecl (xmlParserInputPtr inputPop (xmlParserCtxtPtr ctxt); xmlChar xmlPopInput (xmlParserCtxtPtr ctxt); xmlChar * xmlParsePubidLiteral (xmlParserCtxtPtr ctxt); -void xmlPushInput (xmlParserCtxtPtr ctxt,
xmlParserInputPtr input); +int xmlPushInput (xmlParserCtxtPtr ctxt,
xmlParserInputPtr input); xmlChar * xmlParseEntityValue (xmlParserCtxtPtr ctxt,
xmlChar ** orig); xmlChar * xmlDecodeEntities (xmlParserCtxtPtr ctxt,
int len,
int what,
xmlChar end,
xmlChar end2,
xmlChar end3); xmlChar * xmlParseVersionNum (xmlParserCtxtPtr ctxt); @@ -316,7 +316,7 @@ void xmlParseEntityDecl (

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
+
ctxt:an XML parser context
value:the parser input
Returns:-1 in case of error, the index in the stack otherwise

namePop ()

const xmlChar *	namePop			(xmlParserCtxtPtr ctxt)

Pops the top element name from the name stack

@@ -332,7 +332,7 @@ void xmlParseEntityDecl (

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
+
ctxt:an XML parser context
value:the element node
Returns:-1 in case of error, the index in the stack otherwise

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

@@ -587,7 +587,7 @@ void xmlParseEntityDecl (
ctxt:an XML parser context
Returns:the SystemLiteral parsed or NULL

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 ?

+

parse an XML declaration header for external entities [77] TextDecl ::= '<?xml' VersionInfo? EncodingDecl S? '?>'

ctxt:an XML parser context

xmlParseVersionInfo ()

xmlChar *	xmlParseVersionInfo	(xmlParserCtxtPtr ctxt)
@@ -595,7 +595,7 @@ void xmlParseEntityDecl (
ctxt:an XML parser context
Returns:the version string, e.g. "1.0"

xmlParseVersionNum ()

xmlChar *	xmlParseVersionNum	(xmlParserCtxtPtr ctxt)
-

parse the XML version value. [26] VersionNum ::= ([a-zA-Z0-9_.:] | '-')+

+

parse the XML version value. [26] VersionNum ::= '1.' [0-9]+ In practice allow [0-9].[0-9]+ at that level

ctxt:an XML parser context
Returns:the string giving the XML version number, or NULL

xmlParseXMLDecl ()

void	xmlParseXMLDecl			(xmlParserCtxtPtr ctxt)
@@ -618,9 +618,9 @@ void xmlParseEntityDecl (
ctxt:an XML parser context
Returns:the current xmlChar in the parser context

-

xmlPushInput ()

void	xmlPushInput			(xmlParserCtxtPtr ctxt, 
xmlParserInputPtr input)
+

xmlPushInput ()

int	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 ...).
+
ctxt:an XML parser context
input:an XML parser input fragment (entity, XML fragment ...).
Returns:-1 in case of error or the index in the input stack

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

diff --git a/doc/devhelp/libxml2-relaxng.html b/doc/devhelp/libxml2-relaxng.html index d7da3e5..a89b58f 100644 --- a/doc/devhelp/libxml2-relaxng.html +++ b/doc/devhelp/libxml2-relaxng.html @@ -169,12 +169,12 @@ The content of this structure is not made public by the API.

Function type xmlRelaxNGValidityErrorFunc

void	xmlRelaxNGValidityErrorFunc	(void * ctx, 
const char * msg,
... ...)
-

-

ctx:
msg:
...:
+

Signature of an error callback from a Relax-NG validation

+
ctx:the validation context
msg:the message
...:extra arguments

Function type xmlRelaxNGValidityWarningFunc

void	xmlRelaxNGValidityWarningFunc	(void * ctx, 
const char * msg,
... ...)
-

-

ctx:
msg:
...:
+

Signature of a warning callback from a Relax-NG validation

+
ctx:the validation context
msg:the message
...:extra arguments

xmlRelaxNGCleanupTypes ()

void	xmlRelaxNGCleanupTypes		(void)

Cleanup the default Schemas type library associated to RelaxNG

diff --git a/doc/devhelp/libxml2-schematron.html b/doc/devhelp/libxml2-schematron.html index bdcb944..c99e33e 100644 --- a/doc/devhelp/libxml2-schematron.html +++ b/doc/devhelp/libxml2-schematron.html @@ -113,12 +113,12 @@ The content of this structure is not made public by the API.

Function type xmlSchematronValidityErrorFunc

void	xmlSchematronValidityErrorFunc	(void * ctx, 
const char * msg,
... ...)
-

-

ctx:
msg:
...:
+

Signature of an error callback from a Schematron validation

+
ctx:the validation context
msg:the message
...:extra arguments

Function type xmlSchematronValidityWarningFunc

void	xmlSchematronValidityWarningFunc	(void * ctx, 
const char * msg,
... ...)
-

-

ctx:
msg:
...:
+

Signature of a warning callback from a Schematron validation

+
ctx:the validation context
msg:the message
...:extra arguments

xmlSchematronFree ()

void	xmlSchematronFree		(xmlSchematronPtr schema)

Deallocate a Schematron structure.

diff --git a/doc/devhelp/libxml2-tree.html b/doc/devhelp/libxml2-tree.html index d5879f5..188d43b 100644 --- a/doc/devhelp/libxml2-tree.html +++ b/doc/devhelp/libxml2-tree.html @@ -96,6 +96,7 @@ typedef struct _xmlOutputBuffer xmlOutputBuffer; typedef struct _xmlSAXLocator xmlSAXLocator; typedef xmlElementContent * xmlElementContentPtr; typedef enum xmlElementContentType; +typedef enum xmlDocProperties; typedef xmlID * xmlIDPtr; typedef struct _xmlDtd xmlDtd; typedef struct _xmlAttribute xmlAttribute; @@ -369,14 +370,16 @@ void xmlFreeNsList (xmlBufferAllocationScheme alloc : The realloc method + xmlChar * contentIO : in IO mode we may have a different base } xmlBuffer;


Enum xmlBufferAllocationScheme

enum xmlBufferAllocationScheme {
-    XML_BUFFER_ALLOC_DOUBLEIT = 1
-    XML_BUFFER_ALLOC_EXACT = 2
-    XML_BUFFER_ALLOC_IMMUTABLE = 3
+    XML_BUFFER_ALLOC_DOUBLEIT = 1 /* double each time one need to grow */
+    XML_BUFFER_ALLOC_EXACT = 2 /* grow only to the minimal size */
+    XML_BUFFER_ALLOC_IMMUTABLE = 3 /* immutable buffer */
+    XML_BUFFER_ALLOC_IO = 4 /*  special allocation scheme used for I/O */
 };
 

@@ -421,8 +424,23 @@ void xmlFreeNsList (xmlCharEncoding struct _xmlDict * dict : dict used to allocate names or NULL void * psvi : for type/PSVI informations + int parseFlags : set of xmlParserOption used to parse the document + int properties : set of xmlDocProperties for this document set at the end of parsing } xmlDoc;

+ +


+

Enum xmlDocProperties

enum xmlDocProperties {
+    XML_DOC_WELLFORMED = 1 /* document is XML well formed */
+    XML_DOC_NSVALID = 2 /* document is Namespace valid */
+    XML_DOC_OLD10 = 4 /* parsed with old XML-1.0 parser */
+    XML_DOC_DTDVALID = 8 /* DTD validation was successful */
+    XML_DOC_XINCLUDE = 16 /* XInclude substitution was done */
+    XML_DOC_USERBUILT = 32 /* Document was built using the API and not by parsing an instance */
+    XML_DOC_INTERNAL = 64 /* built for internal processing */
+    XML_DOC_HTML = 128 /*  parsed or built HTML document */
+};
+


Typedef xmlDocPtr

xmlDoc * xmlDocPtr;
@@ -567,7 +585,7 @@ void	xmlFreeNsList			(xmlChar *	URI	: the full URI as computed
     int	owner	: does the entity own the childrens
-    int	checked	: was the entity content checked
+    int	checked	: was the entity content checked this is also used to count entites * r
 } xmlEntity;
 

@@ -757,6 +775,8 @@ void xmlFreeNsList (xmlAttrPtr freeAttrs : * the complete error informations for the last error. * xmlError lastError xmlParserMode parseMode : the parser mode + unsigned long nbentities : number of entities references + unsigned long sizeentities : size of parsed entities } xmlParserCtxt;

diff --git a/doc/devhelp/libxml2-uri.html b/doc/devhelp/libxml2-uri.html index c67dacf..8b33c4e 100644 --- a/doc/devhelp/libxml2-uri.html +++ b/doc/devhelp/libxml2-uri.html @@ -113,15 +113,15 @@ int xmlParseURIReference (
path:pointer to the path string
Returns:0 or an error code


xmlParseURI ()

xmlURIPtr	xmlParseURI		(const char * str)
-

Parse an URI URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

+

Parse an URI based on RFC 3986 URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

str:the URI string to analyze
Returns:a newly built xmlURIPtr or NULL in case of error

xmlParseURIRaw ()

xmlURIPtr	xmlParseURIRaw		(const char * str, 
int raw)
-

Parse an URI but allows to keep intact the original fragments. URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

+

Parse an URI but allows to keep intact the original fragments. URI-reference = URI / relative-ref

str:the URI string to analyze
raw:if 1 unescaping of URI pieces are disabled
Returns:a newly built xmlURIPtr or NULL in case of error

xmlParseURIReference ()

int	xmlParseURIReference		(xmlURIPtr uri, 
const char * str)
-

Parse an URI reference string and fills in the appropriate fields of the @uri structure URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]

+

Parse an URI reference string based on RFC 3986 and fills in the appropriate fields of the @uri structure URI-reference = URI / relative-ref

uri:pointer to an URI structure
str:the string to analyze
Returns:0 or the error code

xmlPathToURI ()

xmlChar *	xmlPathToURI		(const xmlChar * path)
diff --git a/doc/devhelp/libxml2-valid.html b/doc/devhelp/libxml2-valid.html index 3480214..15b3371 100644 --- a/doc/devhelp/libxml2-valid.html +++ b/doc/devhelp/libxml2-valid.html @@ -443,8 +443,8 @@ The content of this structure is not made public by the API.
ctxt:the validation context
doc:a document instance
attr:an attribute definition
Returns:1 if valid or 0 otherwise

xmlValidateAttributeValue ()

int	xmlValidateAttributeValue	(xmlAttributeType type, 
const xmlChar * value)
-

Validate that the given attribute value match the proper production [ VC: ID ] Values of type ID must match the Name production.... [ VC: IDREF ] Values of type IDREF must match the Name production, and values of type IDREFS must match Names ... [ VC: Entity Name ] Values of type ENTITY must match the Name production, values of type ENTITIES must match Names ... [ VC: Name Token ] Values of type NMTOKEN must match the Nmtoken production; values of type NMTOKENS must match Nmtokens.

-
type:an attribute type
value:an attribute value
Returns:1 if valid or 0 otherwise
+

+

type:
value:
Returns:

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.

diff --git a/doc/devhelp/libxml2-xmlerror.html b/doc/devhelp/libxml2-xmlerror.html index eaacd0b..cf445dd 100644 --- a/doc/devhelp/libxml2-xmlerror.html +++ b/doc/devhelp/libxml2-xmlerror.html @@ -247,11 +247,14 @@ void xmlResetError (XML_ERR_NOTATION_PROCESSING = 105 /* 105 */ XML_WAR_NS_COLUMN = 106 /* 106 */ XML_WAR_ENTITY_REDEFINED = 107 /* 107 */ + XML_ERR_UNKNOWN_VERSION = 108 /* 108 */ + XML_ERR_VERSION_MISMATCH = 109 /* 109 */ XML_NS_ERR_XML_NAMESPACE = 200 XML_NS_ERR_UNDEFINED_NAMESPACE = 201 /* 201 */ XML_NS_ERR_QNAME = 202 /* 202 */ XML_NS_ERR_ATTRIBUTE_REDEFINED = 203 /* 203 */ XML_NS_ERR_EMPTY = 204 /* 204 */ + XML_NS_ERR_COLON = 205 /* 205 */ XML_DTD_ATTRIBUTE_DEFAULT = 500 XML_DTD_ATTRIBUTE_REDEFINED = 501 /* 501 */ XML_DTD_ATTRIBUTE_VALUE = 502 /* 502 */ @@ -293,6 +296,7 @@ void xmlResetError (XML_DTD_STANDALONE_DEFAULTED = 538 /* 538 */ XML_DTD_XMLID_VALUE = 539 /* 539 */ XML_DTD_XMLID_TYPE = 540 /* 540 */ + XML_DTD_DUP_TOKEN = 541 /* 541 */ XML_HTML_STRUCURE_ERROR = 800 XML_HTML_UNKNOWN_TAG = 801 /* 801 */ XML_RNGP_ANYNAME_ATTR_ANCESTOR = 1000 diff --git a/doc/devhelp/libxml2-xmlmemory.html b/doc/devhelp/libxml2-xmlmemory.html index eabbbf9..8610538 100644 --- a/doc/devhelp/libxml2-xmlmemory.html +++ b/doc/devhelp/libxml2-xmlmemory.html @@ -52,6 +52,7 @@ void * xmlMemRealloc (void * ptr,
size int xmlInitMemory (void); void xmlMemFree (void * ptr); void * xmlMemMalloc (size_t size); +void xmlMemDisplayLast (FILE * fp,
long nbBytes); int xmlMemGet (xmlFreeFunc * freeFunc,
xmlMallocFunc * mallocFunc,
xmlReallocFunc * reallocFunc,
xmlStrdupFunc * strdupFunc); void xmlMemoryDump (void); void * xmlMallocLoc (size_t size,
const char * file,
int line); @@ -130,6 +131,10 @@ char * xmlMemStrdupLoc (const char * str,
+
+


+

Signature of an error callback from a reader parser

+
arg:the user argument
msg:the message
severity:the severity of the error
locator:a locator indicating where the error occured

xmlFreeTextReader ()

void	xmlFreeTextReader		(xmlTextReaderPtr reader)

Deallocate all the resources associated to the reader

diff --git a/doc/devhelp/libxml2-xmlregexp.html b/doc/devhelp/libxml2-xmlregexp.html index e783648..4d11966 100644 --- a/doc/devhelp/libxml2-xmlregexp.html +++ b/doc/devhelp/libxml2-xmlregexp.html @@ -143,8 +143,8 @@ The content of this structure is not made public by the API.

Function type xmlRegExecCallbacks

void	xmlRegExecCallbacks		(xmlRegExecCtxtPtr exec, 
const xmlChar * token,
void * transdata,
void * inputdata)
-

-

exec:
token:
transdata:
inputdata:
+

Callback function when doing a transition in the automata

+
exec:the regular expression context
token:the current token string
transdata:transition data
inputdata:input data

Variable emptyExp

xmlExpNodePtr emptyExp;
 

diff --git a/doc/devhelp/libxml2-xmlschemas.html b/doc/devhelp/libxml2-xmlschemas.html index 4801ea5..cc49dfa 100644 --- a/doc/devhelp/libxml2-xmlschemas.html +++ b/doc/devhelp/libxml2-xmlschemas.html @@ -68,7 +68,7 @@ void xmlSchemaSetValidStructuredErr void xmlSchemaSetValidErrors (xmlSchemaValidCtxtPtr ctxt,
xmlSchemaValidityErrorFunc err,
xmlSchemaValidityWarningFunc warn,
void * ctx); int xmlSchemaValidCtxtGetOptions (xmlSchemaValidCtxtPtr ctxt); int xmlSchemaValidateFile (xmlSchemaValidCtxtPtr ctxt,
const char * filename,
int options); -int xmlSchemaValidateDoc (xmlSchemaValidCtxtPtr ctxt,
xmlDocPtr instance); +int xmlSchemaValidateDoc (xmlSchemaValidCtxtPtr ctxt,
xmlDocPtr doc); void xmlSchemaFree (xmlSchemaPtr schema); xmlSchemaParserCtxtPtr xmlSchemaNewMemParserCtxt (const char * buffer,
int size); int xmlSchemaGetValidErrors (xmlSchemaValidCtxtPtr ctxt,
xmlSchemaValidityErrorFunc * err,
xmlSchemaValidityWarningFunc * warn,
void ** ctx); @@ -77,6 +77,7 @@ void xmlSchemaSetParserErrors (xmlSchemaValidityWarningFunc (void * ctx,
const char * msg,
... ...); void xmlSchemaDump (FILE * output,
xmlSchemaPtr schema); void xmlSchemaFreeValidCtxt (xmlSchemaValidCtxtPtr ctxt); +xmlParserCtxtPtr xmlSchemaValidCtxtGetParserCtxt (xmlSchemaValidCtxtPtr ctxt); void xmlSchemaSetParserStructuredErrors (xmlSchemaParserCtxtPtr ctxt,
xmlStructuredErrorFunc serror,
void * ctx); xmlSchemaValidCtxtPtr xmlSchemaNewValidCtxt (xmlSchemaPtr schema); @@ -185,12 +186,12 @@ The content of this structure is not made public by the API.


Function type xmlSchemaValidityErrorFunc

void	xmlSchemaValidityErrorFunc	(void * ctx, 
const char * msg,
... ...)
-

-

ctx:
msg:
...:
+

Signature of an error callback from an XSD validation

+
ctx:the validation context
msg:the message
...:extra arguments

Function type xmlSchemaValidityWarningFunc

void	xmlSchemaValidityWarningFunc	(void * ctx, 
const char * msg,
... ...)
-

-

ctx:
msg:
...:
+

Signature of a warning callback from an XSD validation

+
ctx:the validation context
msg:the message
...:extra arguments

xmlSchemaDump ()

void	xmlSchemaDump			(FILE * output, 
xmlSchemaPtr schema)

Dump a Schema structure.

@@ -205,20 +206,20 @@ The content of this structure is not made public by the API.
ctxt:the schema parser context

xmlSchemaFreeValidCtxt ()

void	xmlSchemaFreeValidCtxt		(xmlSchemaValidCtxtPtr ctxt)
-

-

ctxt:
+

Free the resources associated to the schema validation context

+
ctxt:the schema validation context

xmlSchemaGetParserErrors ()

int	xmlSchemaGetParserErrors	(xmlSchemaParserCtxtPtr ctxt, 
xmlSchemaValidityErrorFunc * err,
xmlSchemaValidityWarningFunc * warn,
void ** ctx)

Get the callback information used to handle errors for a parser context

ctxt:a XMl-Schema parser 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

xmlSchemaGetValidErrors ()

int	xmlSchemaGetValidErrors		(xmlSchemaValidCtxtPtr ctxt, 
xmlSchemaValidityErrorFunc * err,
xmlSchemaValidityWarningFunc * warn,
void ** ctx)
-

-

ctxt:
err:
warn:
ctx:
Returns:
+

Get the error and warning callback informations

+
ctxt:a XML-Schema 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

xmlSchemaIsValid ()

int	xmlSchemaIsValid		(xmlSchemaValidCtxtPtr ctxt)
-

-

ctxt:
Returns:
+

Check if any error was detected during validation.

+
ctxt:the schema validation context
Returns:1 if valid so far, 0 if errors were detected, and -1 in case of internal error.

xmlSchemaNewDocParserCtxt ()

xmlSchemaParserCtxtPtr	xmlSchemaNewDocParserCtxt	(xmlDocPtr doc)

Create an XML Schemas parse context for that document. NB. The document may be modified during the parsing process.

@@ -233,20 +234,20 @@ The content of this structure is not made public by the API.
URL:the location of the schema
Returns:the parser context or NULL in case of error

xmlSchemaNewValidCtxt ()

xmlSchemaValidCtxtPtr	xmlSchemaNewValidCtxt	(xmlSchemaPtr schema)
-

-

schema:
Returns:
+

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

xmlSchemaParse ()

xmlSchemaPtr	xmlSchemaParse		(xmlSchemaParserCtxtPtr ctxt)

parse a schema definition resource and build an internal XML Shema struture which can be used to validate instances.

ctxt:a schema validation context
Returns:the internal XML Schema structure built from the resource or NULL in case of error

xmlSchemaSAXPlug ()

xmlSchemaSAXPlugPtr	xmlSchemaSAXPlug	(xmlSchemaValidCtxtPtr ctxt, 
xmlSAXHandlerPtr * sax,
void ** user_data)
-

-

ctxt:
sax:
user_data:
Returns:
+

Plug a SAX based validation layer in a SAX parsing event flow. The original @saxptr and @dataptr data are replaced by new pointers but the calls to the original will be maintained.

+
ctxt:a schema validation context
sax:a pointer to the original xmlSAXHandlerPtr
user_data:a pointer to the original SAX user data pointer
Returns:a pointer to a data structure needed to unplug the validation layer or NULL in case of errors.

xmlSchemaSAXUnplug ()

int	xmlSchemaSAXUnplug		(xmlSchemaSAXPlugPtr plug)
-

-

plug:
Returns:
+

Unplug a SAX based validation layer in a SAX parsing event flow. The original pointers used in the call are restored.

+
plug:a data structure returned by xmlSchemaSAXPlug
Returns:0 in case of success and -1 in case of failure.

xmlSchemaSetParserErrors ()

void	xmlSchemaSetParserErrors	(xmlSchemaParserCtxtPtr ctxt, 
xmlSchemaValidityErrorFunc err,
xmlSchemaValidityWarningFunc warn,
void * ctx)

Set the callback functions used to handle errors for a validation context

@@ -257,36 +258,40 @@ The content of this structure is not made public by the API.
ctxt:a schema parser context
serror:the structured error function
ctx:the functions context

xmlSchemaSetValidErrors ()

void	xmlSchemaSetValidErrors		(xmlSchemaValidCtxtPtr ctxt, 
xmlSchemaValidityErrorFunc err,
xmlSchemaValidityWarningFunc warn,
void * ctx)
-

-

ctxt:
err:
warn:
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

xmlSchemaSetValidOptions ()

int	xmlSchemaSetValidOptions	(xmlSchemaValidCtxtPtr ctxt, 
int options)
-

-

ctxt:
options:
Returns:
+

Sets the options to be used during the validation.

+
ctxt:a schema validation context
options:a combination of xmlSchemaValidOption
Returns:0 in case of success, -1 in case of an API error.

xmlSchemaSetValidStructuredErrors ()

void	xmlSchemaSetValidStructuredErrors	(xmlSchemaValidCtxtPtr ctxt, 
xmlStructuredErrorFunc serror,
void * ctx)
-

-

ctxt:
serror:
ctx:
+

Set the structured error callback

+
ctxt:a schema validation context
serror:the structured error function
ctx:the functions context

xmlSchemaValidCtxtGetOptions ()

int	xmlSchemaValidCtxtGetOptions	(xmlSchemaValidCtxtPtr ctxt)
-

-

ctxt:
Returns:
+

Get the validation context options.

+
ctxt:a schema validation context
Returns:the option combination or -1 on error.

-

xmlSchemaValidateDoc ()

int	xmlSchemaValidateDoc		(xmlSchemaValidCtxtPtr ctxt, 
xmlDocPtr instance)
-

-

ctxt:
instance:
Returns:
+

xmlSchemaValidCtxtGetParserCtxt ()

xmlParserCtxtPtr	xmlSchemaValidCtxtGetParserCtxt	(xmlSchemaValidCtxtPtr ctxt)
+

allow access to the parser context of the schema validation context

+
ctxt:a schema validation context
Returns:the parser context of the schema validation context or NULL in case of error.
+
+

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.

xmlSchemaValidateFile ()

int	xmlSchemaValidateFile		(xmlSchemaValidCtxtPtr ctxt, 
const char * filename,
int options)
-

-

ctxt:
filename:
options:
Returns:
+

Do a schemas validation of the given resource, it will use the SAX streamable validation internally.

+
ctxt:a schema validation context
filename:the URI of the instance
options:a future set of options, currently unused
Returns:0 if the document is valid, a positive error code number otherwise and -1 in case of an internal or API error.

xmlSchemaValidateOneElement ()

int	xmlSchemaValidateOneElement	(xmlSchemaValidCtxtPtr ctxt, 
xmlNodePtr elem)
-

-

ctxt:
elem:
Returns:
+

Validate a branch of a tree, starting with the given @elem.

+
ctxt:a schema validation context
elem:an element node
Returns:0 if the element and its subtree is valid, a positive error code number otherwise and -1 in case of an internal or API error.

xmlSchemaValidateStream ()

int	xmlSchemaValidateStream		(xmlSchemaValidCtxtPtr ctxt, 
xmlParserInputBufferPtr input,
xmlCharEncoding enc,
xmlSAXHandlerPtr sax,
void * user_data)
-

-

ctxt:
input:
enc:
sax:
user_data:
Returns:
+

Validate an input based on a flow of SAX event from the parser and forward the events to the @sax handler with the provided @user_data the user provided @sax handler must be a SAX2 one.

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

diff --git a/doc/devhelp/libxml2.devhelp b/doc/devhelp/libxml2.devhelp index 499bcb9..1288b18 100644 --- a/doc/devhelp/libxml2.devhelp +++ b/doc/devhelp/libxml2.devhelp @@ -339,6 +339,7 @@ + @@ -427,6 +428,14 @@ + + + + + + + + @@ -434,6 +443,7 @@ + @@ -581,11 +591,13 @@ + + @@ -710,6 +722,7 @@ + @@ -745,6 +758,8 @@ + + @@ -754,6 +769,7 @@ + @@ -1547,6 +1563,7 @@ + @@ -2414,6 +2431,7 @@ + @@ -2492,6 +2510,7 @@ + @@ -2835,6 +2854,7 @@ + -- cgit v1.2.3