parserInternals		API documentation		The XML C parser and toolkit of Gnome	relaxng

allows to compile and test pattern expressions for nodes either in a tree or based on a parser state.

Table of Contents

Structure xmlPattern
struct _xmlPattern
The content of this structure is not made public by the API.

Enum xmlPatternFlags

Typedef xmlPattern * xmlPatternPtr

Structure xmlStreamCtxt
struct _xmlStreamCtxt
The content of this structure is not made public by the API.

Typedef xmlStreamCtxt * xmlStreamCtxtPtr

void	xmlFreePattern			(xmlPatternPtr comp)

void	xmlFreePatternList		(xmlPatternPtr comp)

void	xmlFreeStreamCtxt		(xmlStreamCtxtPtr stream)

int	xmlPatternFromRoot		(xmlPatternPtr comp)

xmlStreamCtxtPtr	xmlPatternGetStreamCtxt	(xmlPatternPtr comp)

int	xmlPatternMatch			(xmlPatternPtr comp, 
					 xmlNodePtr node)

int	xmlPatternMaxDepth		(xmlPatternPtr comp)

int	xmlPatternMinDepth		(xmlPatternPtr comp)

int	xmlPatternStreamable		(xmlPatternPtr comp)

xmlPatternPtr	xmlPatterncompile	(const xmlChar * pattern, 
					 xmlDict * dict, 
					 int flags, 
					 const xmlChar ** namespaces)

int	xmlStreamPop			(xmlStreamCtxtPtr stream)

int	xmlStreamPush			(xmlStreamCtxtPtr stream, 
					 const xmlChar * name, 
					 const xmlChar * ns)

int	xmlStreamPushAttr		(xmlStreamCtxtPtr stream, 
					 const xmlChar * name, 
					 const xmlChar * ns)

int	xmlStreamPushNode		(xmlStreamCtxtPtr stream, 
					 const xmlChar * name, 
					 const xmlChar * ns, 
					 int nodeType)

int	xmlStreamWantsAnyNode		(xmlStreamCtxtPtr streamCtxt)

Description

Structure xmlPattern

Structure xmlPattern
struct _xmlPattern {
The content of this structure is not made public by the API.
}

Enum xmlPatternFlags

Enum xmlPatternFlags {
    XML_PATTERN_DEFAULT = 0 : simple pattern match
    XML_PATTERN_XPATH = 1 : standard XPath pattern
    XML_PATTERN_XSSEL = 2 : XPath subset for schema selector
    XML_PATTERN_XSFIELD = 4 : XPath subset for schema field
}

Structure xmlStreamCtxt

Structure xmlStreamCtxt
struct _xmlStreamCtxt {
The content of this structure is not made public by the API.
}

Function: xmlFreePattern

void	xmlFreePattern			(xmlPatternPtr comp)

Free up the memory allocated by @comp

Function: xmlFreePatternList

void	xmlFreePatternList		(xmlPatternPtr comp)

Free up the memory allocated by all the elements of @comp

Function: xmlFreeStreamCtxt

void	xmlFreeStreamCtxt		(xmlStreamCtxtPtr stream)

Free the stream context

Function: xmlPatternFromRoot

int	xmlPatternFromRoot		(xmlPatternPtr comp)

Check if the pattern must be looked at from the root.

Function: xmlPatternGetStreamCtxt

xmlStreamCtxtPtr	xmlPatternGetStreamCtxt	(xmlPatternPtr comp)

Get a streaming context for that pattern Use xmlFreeStreamCtxt to free the context.

Function: xmlPatternMatch

int	xmlPatternMatch			(xmlPatternPtr comp, 
					 xmlNodePtr node)

Test whether the node matches the pattern

Function: xmlPatternMaxDepth

int	xmlPatternMaxDepth		(xmlPatternPtr comp)

Check the maximum depth reachable by a pattern

Function: xmlPatternMinDepth

int	xmlPatternMinDepth		(xmlPatternPtr comp)

Check the minimum depth reachable by a pattern, 0 mean the / or . are part of the set.

Function: xmlPatternStreamable

int	xmlPatternStreamable		(xmlPatternPtr comp)

Check if the pattern is streamable i.e. xmlPatternGetStreamCtxt() should work.

Function: xmlPatterncompile

xmlPatternPtr	xmlPatterncompile	(const xmlChar * pattern, 
					 xmlDict * dict, 
					 int flags, 
					 const xmlChar ** namespaces)

Compile a pattern.

Function: xmlStreamPop

int	xmlStreamPop			(xmlStreamCtxtPtr stream)

push one level from the stream.

Function: xmlStreamPush

int	xmlStreamPush			(xmlStreamCtxtPtr stream, 
					 const xmlChar * name, 
					 const xmlChar * ns)

Push new data onto the stream. NOTE: if the call xmlPatterncompile() indicated a dictionary, then strings for name and ns will be expected to come from the dictionary. Both @name and @ns being NULL means the / i.e. the root of the document. This can also act as a reset. Otherwise the function will act as if it has been given an element-node.

Function: xmlStreamPushAttr

int	xmlStreamPushAttr		(xmlStreamCtxtPtr stream, 
					 const xmlChar * name, 
					 const xmlChar * ns)

Push new attribute data onto the stream. NOTE: if the call xmlPatterncompile() indicated a dictionary, then strings for name and ns will be expected to come from the dictionary. Both @name and @ns being NULL means the / i.e. the root of the document. This can also act as a reset. Otherwise the function will act as if it has been given an attribute-node.

Function: xmlStreamPushNode

int	xmlStreamPushNode		(xmlStreamCtxtPtr stream, 
					 const xmlChar * name, 
					 const xmlChar * ns, 
					 int nodeType)

Push new data onto the stream. NOTE: if the call xmlPatterncompile() indicated a dictionary, then strings for name and ns will be expected to come from the dictionary. Both @name and @ns being NULL means the / i.e. the root of the document. This can also act as a reset. Different from xmlStreamPush() this function can be fed with nodes of type: element-, attribute-, text-, cdata-section-, comment- and processing-instruction-node.

Function: xmlStreamWantsAnyNode

int	xmlStreamWantsAnyNode		(xmlStreamCtxtPtr streamCtxt)

Query if the streaming pattern additionally needs to be fed with text-, cdata-section-, comment- and processing-instruction-nodes. If the result is 0 then only element-nodes and attribute-nodes need to be pushed.

Daniel Veillard