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/html/libxml-c14n.html | 2 +- doc/html/libxml-entities.html | 5 ++- doc/html/libxml-globals.html | 8 ++--- doc/html/libxml-parser.html | 3 ++ doc/html/libxml-parserInternals.html | 14 ++++---- doc/html/libxml-relaxng.html | 4 +-- doc/html/libxml-schematron.html | 4 +-- doc/html/libxml-tree.html | 27 ++++++++++++--- doc/html/libxml-uri.html | 6 ++-- doc/html/libxml-valid.html | 4 +-- doc/html/libxml-xmlerror.html | 4 +++ doc/html/libxml-xmlmemory.html | 5 ++- doc/html/libxml-xmlreader.html | 2 +- doc/html/libxml-xmlregexp.html | 2 +- doc/html/libxml-xmlschemas.html | 65 +++++++++++++++++++----------------- 15 files changed, 94 insertions(+), 61 deletions(-) (limited to 'doc/html') diff --git a/doc/html/libxml-c14n.html b/doc/html/libxml-c14n.html index f4b3ecd..dfcb9c5 100644 --- a/doc/html/libxml-c14n.html +++ b/doc/html/libxml-c14n.html @@ -28,5 +28,5 @@ int xmlC14NIsVisibleCallback (void * use

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

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

Daniel Veillard

diff --git a/doc/html/libxml-entities.html b/doc/html/libxml-entities.html index fe4ea86..406e64e 100644 --- a/doc/html/libxml-entities.html +++ b/doc/html/libxml-entities.html @@ -30,6 +30,7 @@ The content of this structure is not made public by the API.
xmlEntityPtr	xmlGetParameterEntity	(xmlDocPtr doc, 
const xmlChar * name)
xmlEntityPtr	xmlGetPredefinedEntity	(const xmlChar * name)
void	xmlInitializePredefinedEntities	(void)
+
xmlEntityPtr	xmlNewEntity		(xmlDocPtr doc, 
const xmlChar * name,
int type,
const xmlChar * ExternalID,
const xmlChar * SystemID,
const xmlChar * content)

Description

Structure xmlEntitiesTable

Structure xmlEntitiesTable
struct _xmlHashTable { The content of this structure is not made public by the API. @@ -73,4 +74,6 @@ The content of this structure is not made public by the API.

Check whether this name is an predefined entity.

name:the entity name
Returns:NULL if not, otherwise the entity

Function: xmlInitializePredefinedEntities

void	xmlInitializePredefinedEntities	(void)

Set up the predefined entities. Deprecated call

-

Daniel Veillard

+

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

Daniel Veillard

diff --git a/doc/html/libxml-globals.html b/doc/html/libxml-globals.html index fd9a06c..148d6a1 100644 --- a/doc/html/libxml-globals.html +++ b/doc/html/libxml-globals.html @@ -90,7 +90,7 @@ void xmlRegisterNodeFunc (
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:

+

Signature for the deregistration callback of a discarded node

node:the current node

Function: xmlInitGlobals

void	xmlInitGlobals			(void)

Additional initialisation for multi-threading

Function: xmlInitializeGlobalState

void	xmlInitializeGlobalState	(xmlGlobalStatePtr gs)
@@ -99,17 +99,17 @@ void xmlDeregisterNodeFunc (xmlNodePtr

Registers a callback for URI output file handling

func:function pointer to the new OutputBufferCreateFilenameFunc
Returns:the old value of the registration function

Function type: xmlOutputBufferCreateFilenameFunc

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

xmlParserInputBufferCreateFilenameFunc	xmlParserInputBufferCreateFilenameDefault	(xmlParserInputBufferCreateFilenameFunc func)

Registers a callback for URI input file handling

func:function pointer to the new ParserInputBufferCreateFilenameFunc
Returns:the old value of the registration function

Function type: xmlParserInputBufferCreateFilenameFunc

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

Function type: xmlRegisterNodeFunc
 void	xmlRegisterNodeFunc		(xmlNodePtr node)
-

node:

+

Signature for the registration callback of a created node

node:the current node

Function: xmlThrDefBufferAllocScheme

xmlBufferAllocationScheme	xmlThrDefBufferAllocScheme	(xmlBufferAllocationScheme v)

v:
Returns:

Function: xmlThrDefDefaultBufferSize

int	xmlThrDefDefaultBufferSize	(int v)
diff --git a/doc/html/libxml-parser.html b/doc/html/libxml-parser.html index 82c6f8e..82dbf95 100644 --- a/doc/html/libxml-parser.html +++ b/doc/html/libxml-parser.html @@ -282,6 +282,9 @@ void xmlParserInputDeallocate (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_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 }

Structure xmlSAXHandlerV1

Structure xmlSAXHandlerV1
struct _xmlSAXHandlerV1 { internalSubsetSAXFunc internalSubset diff --git a/doc/html/libxml-parserInternals.html b/doc/html/libxml-parserInternals.html index 3c12a6a..ad1fb8e 100644 --- a/doc/html/libxml-parserInternals.html +++ b/doc/html/libxml-parserInternals.html @@ -92,7 +92,7 @@ void xmlEntityReferenceFunc (void xmlParserHandleReference (xmlParserCtxtPtr ctxt)
void	xmlParserInputShrink		(xmlParserInputPtr in)
xmlChar	xmlPopInput			(xmlParserCtxtPtr ctxt)
-
void	xmlPushInput			(xmlParserCtxtPtr ctxt, 
xmlParserInputPtr input)
+
int	xmlPushInput			(xmlParserCtxtPtr ctxt, 
xmlParserInputPtr input)
xmlChar *	xmlScanName		(xmlParserCtxtPtr ctxt)
void	xmlSetEntityReferenceFunc	(xmlEntityReferenceFunc func)
int	xmlSkipBlankChars		(xmlParserCtxtPtr ctxt)
@@ -140,7 +140,7 @@ void xmlEntityReferenceFunc (
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: namePop

const xmlChar *	namePop			(xmlParserCtxtPtr ctxt)
+
ctxt:an XML parser context
value:the parser input
Returns:-1 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: namePush

int	namePush			(xmlParserCtxtPtr ctxt, 
const xmlChar * value)

Pushes a new element name on top of the name stack

@@ -148,7 +148,7 @@ void xmlEntityReferenceFunc (
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)
+
ctxt:an XML parser context
value:the element node
Returns:-1 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

@@ -278,11 +278,11 @@ void xmlEntityReferenceFunc (xmlEntityP
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: 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

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

+

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

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)
@@ -293,9 +293,9 @@ void xmlEntityReferenceFunc (xmlEntityP

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)
+
ctxt:an XML parser context
Returns:the current xmlChar in the parser context

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

Function: xmlScanName

xmlChar *	xmlScanName		(xmlParserCtxtPtr ctxt)
+
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

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

diff --git a/doc/html/libxml-relaxng.html b/doc/html/libxml-relaxng.html index 650d058..b631a1a 100644 --- a/doc/html/libxml-relaxng.html +++ b/doc/html/libxml-relaxng.html @@ -153,10 +153,10 @@ The content of this structure is not made public by the API.

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

+

Signature of an error callback from a Relax-NG validation

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

Function type: xmlRelaxNGValidityWarningFunc

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

Function: xmlRelaxParserSetFlag

int	xmlRelaxParserSetFlag		(xmlRelaxNGParserCtxtPtr ctxt, 
int flags)

Semi private function used to pass informations to a parser context which are a combination of xmlRelaxNGParserFlag .

ctxt:a RelaxNG parser context
flags:a set of flags values
Returns:0 if success and -1 in case of error

Daniel Veillard

diff --git a/doc/html/libxml-schematron.html b/doc/html/libxml-schematron.html index 5ec67e5..1dcd73a 100644 --- a/doc/html/libxml-schematron.html +++ b/doc/html/libxml-schematron.html @@ -74,8 +74,8 @@ The content of this structure is not made public by the API.

Validate a tree instance against the schematron

ctxt:the schema validation context
instance:the document instace tree
Returns:0 in case of success, -1 in case of internal error and an error count otherwise.

Function type: xmlSchematronValidityErrorFunc

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

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

Daniel Veillard

diff --git a/doc/html/libxml-tree.html b/doc/html/libxml-tree.html index 34914cb..ab57566 100644 --- a/doc/html/libxml-tree.html +++ b/doc/html/libxml-tree.html @@ -22,6 +22,7 @@ A:link, A:visited, A:active { text-decoration: underline }
Structure xmlDOMWrapCtxt
struct _xmlDOMWrapCtxt
Typedef xmlDOMWrapCtxt * xmlDOMWrapCtxtPtr
 
Structure xmlDoc
struct _xmlDoc +
Enum xmlDocProperties
 
Typedef xmlDoc * xmlDocPtr
 
Structure xmlDtd
struct _xmlDtd
Typedef xmlDtd * xmlDtdPtr
@@ -277,10 +278,12 @@ A:link, A:visited, A:active { text-decoration: underline }
     unsigned int	use	: The buffer size used
     unsigned int	size	: The buffer size
     xmlBufferAllocationScheme	alloc	: The realloc method
+    xmlChar *	contentIO	: in IO mode we may have a different base
 }

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
 }
 

Structure xmlDOMWrapCtxt

Structure xmlDOMWrapCtxt
struct _xmlDOMWrapCtxt { void * _private : * The type of this context, just in case @@ -310,7 +313,19 @@ 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 { + int parseFlags : set of xmlParserOption used to parse th + int properties : set of xmlDocProperties for this docume +}

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

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 @@ -412,7 +427,7 @@ A:link, A:visited, A:active { text-decoration: underline } struct _xmlEntity * nexte : unused const 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 }

Structure xmlEnumeration

Structure xmlEnumeration
struct _xmlEnumeration { struct _xmlEnumeration * next : next one const xmlChar * name : Enumeration name @@ -542,6 +557,8 @@ A:link, A:visited, A:active { text-decoration: underline } xmlAttrPtr freeAttrs : * the complete error informations for th xmlError lastError xmlParserMode parseMode : the parser mode + unsigned long nbentities : number of entities references + unsigned long sizeentities : size of parsed entities }

Structure xmlParserInput

Structure xmlParserInput
struct _xmlParserInput { xmlParserInputBufferPtr buf : UTF-8 encoded buffer const char * filename : The file analyzed, if any diff --git a/doc/html/libxml-uri.html b/doc/html/libxml-uri.html index 9b8cdb6..61d4dba 100644 --- a/doc/html/libxml-uri.html +++ b/doc/html/libxml-uri.html @@ -53,11 +53,11 @@ A:link, A:visited, A:active { text-decoration: underline }
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 ]

+

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

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

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 ]

+

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

Function: xmlPathToURI

xmlChar *	xmlPathToURI		(const xmlChar * path)

Constructs an URI expressing the existing path

path:the resource locator in a filesystem notation
Returns:a new URI, 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: xmlPrintURI

void	xmlPrintURI			(FILE * stream, 
xmlURIPtr uri)
diff --git a/doc/html/libxml-valid.html b/doc/html/libxml-valid.html index 30ef3cd..eb9f667 100644 --- a/doc/html/libxml-valid.html +++ b/doc/html/libxml-valid.html @@ -241,8 +241,8 @@ The content of this structure is not made public by the API.
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)
+

+
type:
value:
Returns:

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

diff --git a/doc/html/libxml-xmlerror.html b/doc/html/libxml-xmlerror.html index 9803b4a..74af5ed 100644 --- a/doc/html/libxml-xmlerror.html +++ b/doc/html/libxml-xmlerror.html @@ -197,11 +197,14 @@ void xmlStructuredErrorFunc (void * userD 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 @@ -243,6 +246,7 @@ void xmlStructuredErrorFunc (void * userD 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/html/libxml-xmlmemory.html b/doc/html/libxml-xmlmemory.html index ea62ae7..8dd16ec 100644 --- a/doc/html/libxml-xmlmemory.html +++ b/doc/html/libxml-xmlmemory.html @@ -32,6 +32,7 @@ void * xmlMallocFunc (size_t size)
void *	xmlMallocLoc			(size_t size, 
const char * file,
int line)
int	xmlMemBlocks			(void)
void	xmlMemDisplay			(FILE * fp)
+
void	xmlMemDisplayLast		(FILE * fp, 
long nbBytes)
void	xmlMemFree			(void * ptr)
int	xmlMemGet			(xmlFreeFunc * freeFunc, 
xmlMallocFunc * mallocFunc,
xmlReallocFunc * reallocFunc,
xmlStrdupFunc * strdupFunc)
void *	xmlMemMalloc			(size_t size)
@@ -73,7 +74,9 @@ void * xmlMallocFunc (size_t size)

Provides the number of memory areas currently allocated

Returns:an int representing the number of blocks

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

void	xmlMemFree			(void * ptr)
+
fp:a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist

Function: xmlMemDisplayLast

void	xmlMemDisplayLast		(FILE * fp, 
long nbBytes)
+

the last nbBytes of memory allocated and not freed, useful for dumping the memory left allocated between two places at runtime.

+
fp:a FILE descriptor used as the output file, if NULL, the result is written to the file .memorylist
nbBytes:the amount of memory to dump

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

diff --git a/doc/html/libxml-xmlreader.html b/doc/html/libxml-xmlreader.html index b4c1cbc..f02707a 100644 --- a/doc/html/libxml-xmlreader.html +++ b/doc/html/libxml-xmlreader.html @@ -217,7 +217,7 @@ The content of this structure is not made public by the API.

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:

+

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

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

xmlChar *	xmlTextReaderGetAttribute	(xmlTextReaderPtr reader, 
const xmlChar * name)
diff --git a/doc/html/libxml-xmlregexp.html b/doc/html/libxml-xmlregexp.html index 642e930..15de2f4 100644 --- a/doc/html/libxml-xmlregexp.html +++ b/doc/html/libxml-xmlregexp.html @@ -117,7 +117,7 @@ The content of this structure is not made public by the API.

Check whether @exp accepts all the languages accexpted by @sub the input being a subexpression.

ctxt:the expressions context
exp:the englobing expression
sub:the subexpression
Returns:1 if true 0 if false and -1 in case of failure.

Function type: xmlRegExecCallbacks

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

Function: xmlRegExecErrInfo

int	xmlRegExecErrInfo		(xmlRegExecCtxtPtr exec, 
const xmlChar ** string,
int * nbval,
int * nbneg,
xmlChar ** values,
int * terminal)

Extract error informations from the regexp execution, the parameter @string will be updated with the value pushed and not accepted, the parameter @values must point to an array of @nbval string pointers on return nbval will contain the number of possible strings in that state and the @values array will be updated with them. The string values

exec:a regexp execution context generating an error
string:return value for the error string
nbval:pointer to the number of accepted values IN/OUT
nbneg:return number of negative transitions
values:pointer to the array of acceptable values
terminal:return value if this was a terminal state
Returns:will be freed with the @exec context and don't need to be deallocated. Returns: 0 in case of success or -1 in case of error.

Function: xmlRegExecNextValues

int	xmlRegExecNextValues		(xmlRegExecCtxtPtr exec, 
int * nbval,
int * nbneg,
xmlChar ** values,
int * terminal)
diff --git a/doc/html/libxml-xmlschemas.html b/doc/html/libxml-xmlschemas.html index 261f221..aa4b76f 100644 --- a/doc/html/libxml-xmlschemas.html +++ b/doc/html/libxml-xmlschemas.html @@ -43,7 +43,8 @@ The content of this structure is not made public by the API.
int	xmlSchemaSetValidOptions	(xmlSchemaValidCtxtPtr ctxt, 
int options)
void	xmlSchemaSetValidStructuredErrors	(xmlSchemaValidCtxtPtr ctxt, 
xmlStructuredErrorFunc serror,
void * ctx)
int	xmlSchemaValidCtxtGetOptions	(xmlSchemaValidCtxtPtr ctxt)
-
int	xmlSchemaValidateDoc		(xmlSchemaValidCtxtPtr ctxt, 
xmlDocPtr instance)
+
xmlParserCtxtPtr	xmlSchemaValidCtxtGetParserCtxt	(xmlSchemaValidCtxtPtr ctxt)
+
int	xmlSchemaValidateDoc		(xmlSchemaValidCtxtPtr ctxt, 
xmlDocPtr doc)
int	xmlSchemaValidateFile		(xmlSchemaValidCtxtPtr ctxt, 
const char * filename,
int options)
int	xmlSchemaValidateOneElement	(xmlSchemaValidCtxtPtr ctxt, 
xmlNodePtr elem)
int	xmlSchemaValidateStream		(xmlSchemaValidCtxtPtr ctxt, 
xmlParserInputBufferPtr input,
xmlCharEncoding enc,
xmlSAXHandlerPtr sax,
void * user_data)
@@ -120,51 +121,53 @@ The content of this structure is not made public by the API.
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)
-

-
ctxt:

Function: xmlSchemaGetParserErrors

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

Free the resources associated to the schema validation context

+
ctxt:the schema validation context

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

Function: xmlSchemaGetValidErrors

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

-
ctxt:
err:
warn:
ctx:
Returns:

Function: xmlSchemaIsValid

int	xmlSchemaIsValid		(xmlSchemaValidCtxtPtr ctxt)
-

-
ctxt:
Returns:

Function: xmlSchemaNewDocParserCtxt

xmlSchemaParserCtxtPtr	xmlSchemaNewDocParserCtxt	(xmlDocPtr doc)
+

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

Function: xmlSchemaIsValid

int	xmlSchemaIsValid		(xmlSchemaValidCtxtPtr ctxt)
+

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.

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

-
schema:
Returns:

Function: xmlSchemaParse

xmlSchemaPtr	xmlSchemaParse		(xmlSchemaParserCtxtPtr ctxt)
+

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

Function: xmlSchemaSAXPlug

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

-
ctxt:
sax:
user_data:
Returns:

Function: xmlSchemaSAXUnplug

int	xmlSchemaSAXUnplug		(xmlSchemaSAXPlugPtr plug)
-

-
plug:
Returns:

Function: xmlSchemaSetParserErrors

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

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.

Function: xmlSchemaSAXUnplug

int	xmlSchemaSAXUnplug		(xmlSchemaSAXPlugPtr plug)
+

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.

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

void	xmlSchemaSetParserStructuredErrors	(xmlSchemaParserCtxtPtr ctxt, 
xmlStructuredErrorFunc serror,
void * ctx)

Set the structured error callback

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

Function: xmlSchemaSetValidErrors

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

-
ctxt:
err:
warn:
ctx:

Function: xmlSchemaSetValidOptions

int	xmlSchemaSetValidOptions	(xmlSchemaValidCtxtPtr ctxt, 
int options)
-

-
ctxt:
options:
Returns:

Function: xmlSchemaSetValidStructuredErrors

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

-
ctxt:
serror:
ctx:

Function: xmlSchemaValidCtxtGetOptions

int	xmlSchemaValidCtxtGetOptions	(xmlSchemaValidCtxtPtr ctxt)
-

-
ctxt:
Returns:

Function: xmlSchemaValidateDoc

int	xmlSchemaValidateDoc		(xmlSchemaValidCtxtPtr ctxt, 
xmlDocPtr instance)
-

-
ctxt:
instance:
Returns:

Function: xmlSchemaValidateFile

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

-
ctxt:
filename:
options:
Returns:

Function: xmlSchemaValidateOneElement

int	xmlSchemaValidateOneElement	(xmlSchemaValidCtxtPtr ctxt, 
xmlNodePtr elem)
-

-
ctxt:
elem:
Returns:

Function: xmlSchemaValidateStream

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

-
ctxt:
input:
enc:
sax:
user_data:
Returns:

Function type: xmlSchemaValidityErrorFunc

Function type: xmlSchemaValidityErrorFunc
+

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

int	xmlSchemaSetValidOptions	(xmlSchemaValidCtxtPtr ctxt, 
int options)
+

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.

Function: xmlSchemaSetValidStructuredErrors

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

Set the structured error callback

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

Function: xmlSchemaValidCtxtGetOptions

int	xmlSchemaValidCtxtGetOptions	(xmlSchemaValidCtxtPtr ctxt)
+

Get the validation context options.

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

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

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

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

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.

Function: xmlSchemaValidateOneElement

int	xmlSchemaValidateOneElement	(xmlSchemaValidCtxtPtr ctxt, 
xmlNodePtr elem)
+

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.

Function: xmlSchemaValidateStream

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

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.

Function type: xmlSchemaValidityErrorFunc

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

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

Daniel Veillard

-- cgit v1.2.3