xmlschemas		API documentation		The XML C parser and toolkit of Gnome	xmlstring

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

Table of Contents

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)

int	xmlSchemaCompareValuesWhtsp	(xmlSchemaValPtr x, 
					 xmlSchemaWhitespaceValueType xws, 
					 xmlSchemaValPtr y, 
					 xmlSchemaWhitespaceValueType yws)

xmlSchemaValPtr	xmlSchemaCopyValue	(xmlSchemaValPtr val)

void	xmlSchemaFreeFacet		(xmlSchemaFacetPtr facet)

void	xmlSchemaFreeValue		(xmlSchemaValPtr value)

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)

void	xmlSchemaInitTypes		(void)

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)

int	xmlSchemaValidateFacet		(xmlSchemaTypePtr base, 
					 xmlSchemaFacetPtr facet, 
					 const xmlChar * value, 
					 xmlSchemaValPtr val)

int	xmlSchemaValidateFacetWhtsp	(xmlSchemaFacetPtr facet, 
					 xmlSchemaWhitespaceValueType fws, 
					 xmlSchemaValType valType, 
					 const xmlChar * value, 
					 xmlSchemaValPtr val, 
					 xmlSchemaWhitespaceValueType ws)

int	xmlSchemaValidateLengthFacet	(xmlSchemaTypePtr type, 
					 xmlSchemaFacetPtr facet, 
					 const xmlChar * value, 
					 xmlSchemaValPtr val, 
					 unsigned long * length)

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 {
    XML_SCHEMA_WHITESPACE_UNKNOWN = 0
    XML_SCHEMA_WHITESPACE_PRESERVE = 1
    XML_SCHEMA_WHITESPACE_REPLACE = 2
    XML_SCHEMA_WHITESPACE_COLLAPSE = 3
}

Function: xmlSchemaCheckFacet

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

Checks and computes the values of facets.

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

Function: xmlSchemaCompareValues

int	xmlSchemaCompareValues		(xmlSchemaValPtr x, 
					 xmlSchemaValPtr y)

Compare 2 values

Function: xmlSchemaCompareValuesWhtsp

int	xmlSchemaCompareValuesWhtsp	(xmlSchemaValPtr x, 
					 xmlSchemaWhitespaceValueType xws, 
					 xmlSchemaValPtr y, 
					 xmlSchemaWhitespaceValueType yws)

Compare 2 values

Function: xmlSchemaCopyValue

xmlSchemaValPtr	xmlSchemaCopyValue	(xmlSchemaValPtr val)

Copies the precomputed value. This duplicates any string within.

Function: xmlSchemaFreeFacet

void	xmlSchemaFreeFacet		(xmlSchemaFacetPtr facet)

Deallocate a Schema Facet structure.

Function: xmlSchemaFreeValue

void	xmlSchemaFreeValue		(xmlSchemaValPtr value)

Cleanup the default XML Schemas type library

Function: xmlSchemaGetBuiltInListSimpleTypeItemType

xmlSchemaTypePtr	xmlSchemaGetBuiltInListSimpleTypeItemType	(xmlSchemaTypePtr type)

Lookup function

Function: xmlSchemaGetBuiltInType

xmlSchemaTypePtr	xmlSchemaGetBuiltInType	(xmlSchemaValType type)

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

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

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.

Function: xmlSchemaGetFacetValueAsULong

unsigned long	xmlSchemaGetFacetValueAsULong	(xmlSchemaFacetPtr facet)

Extract the value of a facet

Function: xmlSchemaGetPredefinedType

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

Lookup a type in the default XML Schemas type library

Function: xmlSchemaGetValType

xmlSchemaValType	xmlSchemaGetValType	(xmlSchemaValPtr val)

Accessor for the type of a value

Function: xmlSchemaInitTypes

void	xmlSchemaInitTypes		(void)

Initialize the default XML Schemas type library

Function: xmlSchemaIsBuiltInTypeFacet

int	xmlSchemaIsBuiltInTypeFacet	(xmlSchemaTypePtr type, 
					 int facetType)

Evaluates if a specific facet can be used in conjunction with a type.

Function: xmlSchemaNewFacet

xmlSchemaFacetPtr	xmlSchemaNewFacet	(void)

Allocate a new Facet structure.

Function: xmlSchemaNewNOTATIONValue

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

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

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.

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.

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.

Function: xmlSchemaValPredefTypeNodeNoNorm

int	xmlSchemaValPredefTypeNodeNoNorm	(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. This one does apply any normalization to the value.

Function: xmlSchemaValidateFacet

int	xmlSchemaValidateFacet		(xmlSchemaTypePtr base, 
					 xmlSchemaFacetPtr facet, 
					 const xmlChar * value, 
					 xmlSchemaValPtr val)

Check a value against a facet condition

Function: xmlSchemaValidateFacetWhtsp

int	xmlSchemaValidateFacetWhtsp	(xmlSchemaFacetPtr facet, 
					 xmlSchemaWhitespaceValueType fws, 
					 xmlSchemaValType valType, 
					 const xmlChar * value, 
					 xmlSchemaValPtr val, 
					 xmlSchemaWhitespaceValueType ws)

Check a value against a facet condition. This takes value normalization according to the specified whitespace types into account. Note that @value needs to be the *normalized* value if the facet is of type "pattern".

Function: xmlSchemaValidateLengthFacet

int	xmlSchemaValidateLengthFacet	(xmlSchemaTypePtr type, 
					 xmlSchemaFacetPtr facet, 
					 const xmlChar * value, 
					 xmlSchemaValPtr val, 
					 unsigned long * length)

Checka a value against a "length", "minLength" and "maxLength" facet; sets @length to the computed length of @value.

Function: xmlSchemaValidateLengthFacetWhtsp

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

Checka a value against a "length", "minLength" and "maxLength" facet; sets @length to the computed length of @value.

Function: xmlSchemaValidateListSimpleTypeFacet

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

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

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.

Function: xmlSchemaValueAppend

int	xmlSchemaValueAppend		(xmlSchemaValPtr prev, 
					 xmlSchemaValPtr cur)

Appends a next sibling to a list of computed values.

Function: xmlSchemaValueGetAsBoolean

int	xmlSchemaValueGetAsBoolean	(xmlSchemaValPtr val)

Accessor for the boolean value of a computed value.

Function: xmlSchemaValueGetAsString

const xmlChar *	xmlSchemaValueGetAsString	(xmlSchemaValPtr val)

Accessor for the string value of a computed value.

Function: xmlSchemaValueGetNext

xmlSchemaValPtr	xmlSchemaValueGetNext	(xmlSchemaValPtr cur)

Accessor for the next sibling of a list of computed values.

Function: xmlSchemaWhiteSpaceReplace

xmlChar *	xmlSchemaWhiteSpaceReplace	(const xmlChar * value)

Replaces 0xd, 0x9 and 0xa with a space.

Daniel Veillard