Module xmlschemastypes from libxml2

From 112cb5bb5475afec1c1cbf1d6728ce4880d0fee8 Mon Sep 17 00:00:00 2001 From: Mike Hommey Date: Tue, 12 Jul 2005 19:58:48 +0000 Subject: Load /tmp/tmp.zfIyNk/libxml2-2.6.20 into packages/libxml2/branches/upstream/current. --- doc/html/libxml-xmlschemastypes.html | 40 ++++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 11 deletions(-) (limited to 'doc/html/libxml-xmlschemastypes.html') diff --git a/doc/html/libxml-xmlschemastypes.html b/doc/html/libxml-xmlschemastypes.html index ced84aa..382652f 100644 --- a/doc/html/libxml-xmlschemastypes.html +++ b/doc/html/libxml-xmlschemastypes.html @@ -10,8 +10,8 @@ A:link, A:visited, A:active { text-decoration: underline } Module xmlschemastypes from libxml2

Module xmlschemastypes from libxml2

API Menu

API Indexes

Related links

module providing the XML Schema Datatypes implementation both definition and validity checking

Enum xmlSchemaWhitespaceValueType
-

int	xmlSchemaCheckFacet		(xmlSchemaFacetPtr facet, 
					 xmlSchemaTypePtr typeDecl, 
					 xmlSchemaParserCtxtPtr ctxt, 
					 const xmlChar * name)

+ Module xmlschemastypes from libxml2

Module xmlschemastypes from libxml2

API Menu

API Indexes

Related links

module providing the XML Schema Datatypes implementation both definition and validity checking

Enum xmlSchemaWhitespaceValueType
+

int	xmlSchemaCheckFacet		(xmlSchemaFacetPtr facet, 
					 xmlSchemaTypePtr typeDecl, 
					 xmlSchemaParserCtxtPtr pctxt, 
					 const xmlChar * name)

void	xmlSchemaCleanupTypes		(void)

xmlChar *	xmlSchemaCollapseString	(const xmlChar * value)

int	xmlSchemaCompareValues		(xmlSchemaValPtr x, 
					 xmlSchemaValPtr y)

@@ -22,6 +22,7 @@ A:link, A:visited, A:active { text-decoration: underline }

xmlSchemaTypePtr	xmlSchemaGetBuiltInListSimpleTypeItemType	(xmlSchemaTypePtr type)

xmlSchemaTypePtr	xmlSchemaGetBuiltInType	(xmlSchemaValType type)

int	xmlSchemaGetCanonValue		(xmlSchemaValPtr val, 
					 const xmlChar ** retValue)

int	xmlSchemaGetCanonValueWhtsp	(xmlSchemaValPtr val, 
					 const xmlChar ** retValue, 
					 xmlSchemaWhitespaceValueType ws)

unsigned long	xmlSchemaGetFacetValueAsULong	(xmlSchemaFacetPtr facet)

xmlSchemaTypePtr	xmlSchemaGetPredefinedType	(const xmlChar * name, 
							 const xmlChar * ns)

xmlSchemaValType	xmlSchemaGetValType	(xmlSchemaValPtr val)

@@ -29,6 +30,7 @@ A:link, A:visited, A:active { text-decoration: underline }

int	xmlSchemaIsBuiltInTypeFacet	(xmlSchemaTypePtr type, 
					 int facetType)

xmlSchemaFacetPtr	xmlSchemaNewFacet	(void)

xmlSchemaValPtr	xmlSchemaNewNOTATIONValue	(const xmlChar * name, 
						 const xmlChar * ns)

xmlSchemaValPtr	xmlSchemaNewQNameValue	(const xmlChar * namespaceName, 
					 const xmlChar * localName)

xmlSchemaValPtr	xmlSchemaNewStringValue	(xmlSchemaValType type, 
					 const xmlChar * value)

int	xmlSchemaValPredefTypeNode	(xmlSchemaTypePtr type, 
					 const xmlChar * value, 
					 xmlSchemaValPtr * val, 
					 xmlNodePtr node)

int	xmlSchemaValPredefTypeNodeNoNorm	(xmlSchemaTypePtr type, 
						 const xmlChar * value, 
						 xmlSchemaValPtr * val, 
						 xmlNodePtr node)

@@ -38,6 +40,10 @@ A:link, A:visited, A:active { text-decoration: underline }

int	xmlSchemaValidateLengthFacetWhtsp	(xmlSchemaFacetPtr facet, 
						 xmlSchemaValType valType, 
						 const xmlChar * value, 
						 xmlSchemaValPtr val, 
						 unsigned long * length, 
						 xmlSchemaWhitespaceValueType ws)

int	xmlSchemaValidateListSimpleTypeFacet	(xmlSchemaFacetPtr facet, 
						 const xmlChar * value, 
						 unsigned long actualLen, 
						 unsigned long * expectedLen)

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

int	xmlSchemaValueAppend		(xmlSchemaValPtr prev, 
					 xmlSchemaValPtr cur)

int	xmlSchemaValueGetAsBoolean	(xmlSchemaValPtr val)

const xmlChar *	xmlSchemaValueGetAsString	(xmlSchemaValPtr val)

xmlSchemaValPtr	xmlSchemaValueGetNext	(xmlSchemaValPtr cur)

xmlChar *	xmlSchemaWhiteSpaceReplace	(const xmlChar * value)

Description

Enum xmlSchemaWhitespaceValueType

Enum xmlSchemaWhitespaceValueType {
@@ -46,9 +52,9 @@ A:link, A:visited, A:active { text-decoration: underline }
     XML_SCHEMA_WHITESPACE_REPLACE = 2
     XML_SCHEMA_WHITESPACE_COLLAPSE = 3
 }
-

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)

+

Function: xmlSchemaCheckFacet

int	xmlSchemaCheckFacet		(xmlSchemaFacetPtr facet, 
					 xmlSchemaTypePtr typeDecl, 
					 xmlSchemaParserCtxtPtr pctxt, 
					 const xmlChar * name)

+

Checks and computes the values of facets.

`facet`:	the facet
`typeDecl`:	the schema type definition
`pctxt`:	the schema parser context or NULL
`name`:	the optional name of the type
`Returns`:	0 if valid, a positive error code if not valid and -1 in case of an internal or API error.

Function: xmlSchemaCleanupTypes

void	xmlSchemaCleanupTypes		(void)

Cleanup the default XML Schemas type library

Function: xmlSchemaCollapseString

xmlChar *	xmlSchemaCollapseString	(const xmlChar * value)

Removes and normalize white spaces in the string

@@ -67,8 +73,10 @@ A:link, A:visited, A:active { text-decoration: underline }

`type`:	the built-in simple type.
`Returns`:	the item type of @type as defined by the built-in datatype hierarchy of XML Schema Part 2: Datatypes, or NULL in case of an error.

Function: xmlSchemaGetBuiltInType

xmlSchemaTypePtr	xmlSchemaGetBuiltInType	(xmlSchemaValType type)

Gives you the type struct for a built-in type by its type id.

`type`:	the type of the built in type
`Returns`:	the type if found, NULL otherwise.

Function: xmlSchemaGetCanonValue

int	xmlSchemaGetCanonValue		(xmlSchemaValPtr val, 
					 const xmlChar ** retValue)

-

Get a the cononical lexical representation of the value. The caller has to free the returned retValue. WARNING: Some value types are not supported yet, resulting in a @retValue of "???".

`val`:	the precomputed value
`retValue`:	the returned value
`Returns`:	0 if the value could be built and -1 in case of API errors.

Function: xmlSchemaGetFacetValueAsULong

unsigned long	xmlSchemaGetFacetValueAsULong	(xmlSchemaFacetPtr facet)

+

Get a the cononical lexical representation of the value. The caller has to FREE the returned retValue. WARNING: Some value types are not supported yet, resulting in a @retValue of "???". TODO: XML Schema 1.0 does not define canonical representations for: duration, gYearMonth, gYear, gMonthDay, gMonth, gDay, anyURI, QName, NOTATION. This will be fixed in XML Schema 1.1.

`val`:	the precomputed value
`retValue`:	the returned value
`Returns`:	0 if the value could be built, 1 if the value type is not supported yet and -1 in case of API errors.

Function: xmlSchemaGetCanonValueWhtsp

int	xmlSchemaGetCanonValueWhtsp	(xmlSchemaValPtr val, 
					 const xmlChar ** retValue, 
					 xmlSchemaWhitespaceValueType ws)

+

Get a the cononical representation of the value. The caller has to free the returned @retValue.

`val`:	the precomputed value
`retValue`:	the returned value
`ws`:	the whitespace type of the value
`Returns`:	0 if the value could be built, 1 if the value type is not supported yet and -1 in case of API errors.

Function: xmlSchemaGetFacetValueAsULong

unsigned long	xmlSchemaGetFacetValueAsULong	(xmlSchemaFacetPtr facet)

Extract the value of a facet

`facet`:	an schemas type facet
`Returns`:	the value as a long

Function: xmlSchemaGetPredefinedType

xmlSchemaTypePtr	xmlSchemaGetPredefinedType	(const xmlChar * name, 
							 const xmlChar * ns)

Lookup a type in the default XML Schemas type library

@@ -81,9 +89,11 @@ A:link, A:visited, A:active { text-decoration: underline }

`type`:	the built-in type
`facetType`:	the facet type
`Returns`:	1 if the facet can be used with the given built-in type, 0 otherwise and -1 in case the type is not a built-in type.

Function: xmlSchemaNewFacet

xmlSchemaFacetPtr	xmlSchemaNewFacet	(void)

Allocate a new Facet structure.

Returns: the newly allocated structure or NULL in case or error

Function: xmlSchemaNewNOTATIONValue

xmlSchemaValPtr	xmlSchemaNewNOTATIONValue	(const xmlChar * name, 
						 const xmlChar * ns)

-

Allocate a new NOTATION value.

`name`:	the notation name
`ns`:	the notation namespace name or NULL
`Returns`:	a pointer to the new value or NULL in case of error

Function: xmlSchemaNewStringValue

xmlSchemaValPtr	xmlSchemaNewStringValue	(xmlSchemaValType type, 
					 const xmlChar * value)

-

Allocate a new simple type value. The type can be of XML_SCHEMAS_STRING. WARNING: This one is intended to be expanded for other string based types. We need this for anySimpleType as well.

Allocate a new NOTATION value. The given values are consumed and freed with the struct.

`name`:	the notation name
`ns`:	the notation namespace name or NULL
`Returns`:	a pointer to the new value or NULL in case of error

Function: xmlSchemaNewQNameValue

xmlSchemaValPtr	xmlSchemaNewQNameValue	(const xmlChar * namespaceName, 
					 const xmlChar * localName)

+

Allocate a new QName value. The given values are consumed and freed with the struct.

`namespaceName`:	the namespace name
`localName`:	the local name
`Returns`:	a pointer to the new value or NULL in case of an error.

Function: xmlSchemaNewStringValue

xmlSchemaValPtr	xmlSchemaNewStringValue	(xmlSchemaValType type, 
					 const xmlChar * value)

+

Allocate a new simple type value. The type can be of XML_SCHEMAS_STRING. WARNING: This one is intended to be expanded for other string based types. We need this for anySimpleType as well. The given value is consumed and freed with the struct.

`type`:	the value type
`value`:	the value
`Returns`:	a pointer to the new value or NULL in case of 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: xmlSchemaValPredefTypeNodeNoNorm

int	xmlSchemaValPredefTypeNodeNoNorm	(xmlSchemaTypePtr type, 
						 const xmlChar * value, 
						 xmlSchemaValPtr * val, 
						 xmlNodePtr node)

@@ -100,6 +110,14 @@ A:link, A:visited, A:active { text-decoration: underline }

Checks the value of a list simple type against a facet.

`facet`:	the facet to check
`value`:	the lexical repr of the value to validate
`actualLen`:	the number of list items
`expectedLen`:	the resulting expected number of list items
`Returns`:	0 if the value is valid, a positive error code number otherwise and -1 in case of an internal 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.

Function: xmlSchemaWhiteSpaceReplace

xmlChar *	xmlSchemaWhiteSpaceReplace	(const xmlChar * value)

+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: xmlSchemaValueAppend
int	xmlSchemaValueAppend		(xmlSchemaValPtr prev, 
					 xmlSchemaValPtr cur)

+
Appends a next sibling to a list of computed values.
+prev: the value
cur: the value to be appended
Returns: 0 if succeeded and -1 on API errors.
Function: xmlSchemaValueGetAsBoolean
int	xmlSchemaValueGetAsBoolean	(xmlSchemaValPtr val)

+
Accessor for the boolean value of a computed value.
+val: the value
Returns: 1 if true and 0 if false, or in case of an error. Hmm.
Function: xmlSchemaValueGetAsString
const xmlChar *	xmlSchemaValueGetAsString	(xmlSchemaValPtr val)

+
Accessor for the string value of a computed value.
+val: the value
Returns: the string value or NULL if there was none, or on API errors.
Function: xmlSchemaValueGetNext
xmlSchemaValPtr	xmlSchemaValueGetNext	(xmlSchemaValPtr cur)

+
Accessor for the next sibling of a list of computed values.
+cur: the value
Returns: the next value or NULL if there was none, or on API errors.
Function: xmlSchemaWhiteSpaceReplace
xmlChar *	xmlSchemaWhiteSpaceReplace	(const xmlChar * value)

 
Replaces 0xd, 0x9 and 0xa with a space.
 value: a value
Returns: the new string or NULL if no change was required.
Daniel Veillard

-- cgit v1.2.3

Module xmlschemastypes from libxml2

Table of Contents

Module xmlschemastypes from libxml2

Table of Contents

Description

Enum xmlSchemaWhitespaceValueType

Function: xmlSchemaCheckFacet

Function: xmlSchemaCleanupTypes

Function: xmlSchemaCheckFacet

Function: xmlSchemaCleanupTypes

Function: xmlSchemaCollapseString

Function: xmlSchemaGetBuiltInType

Function: xmlSchemaGetCanonValue

Function: xmlSchemaGetFacetValueAsULong

Function: xmlSchemaGetCanonValueWhtsp

Function: xmlSchemaGetFacetValueAsULong

Function: xmlSchemaGetPredefinedType

Function: xmlSchemaNewFacet

Function: xmlSchemaNewNOTATIONValue

Function: xmlSchemaNewStringValue

Function: xmlSchemaNewQNameValue

Function: xmlSchemaNewStringValue

Function: xmlSchemaValPredefTypeNode

Function: xmlSchemaValPredefTypeNodeNoNorm

Function: xmlSchemaValidatePredefinedType

Function: xmlSchemaWhiteSpaceReplace

Function: xmlSchemaValueAppend

Function: xmlSchemaValueGetAsBoolean

Function: xmlSchemaValueGetAsString

Function: xmlSchemaValueGetNext

Function: xmlSchemaWhiteSpaceReplace