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-pattern.html | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) (limited to 'doc/html/libxml-pattern.html') diff --git a/doc/html/libxml-pattern.html b/doc/html/libxml-pattern.html index 2d56c1c..0659588 100644 --- a/doc/html/libxml-pattern.html +++ b/doc/html/libxml-pattern.html @@ -10,8 +10,9 @@ A:link, A:visited, A:active { text-decoration: underline } Module pattern from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module pattern from libxml2

API Menu
API Indexes
Related links
PrevparserInternalsUpAPI documentationHomeThe XML C parser and toolkit of GnomerelaxngNext

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
+    Module pattern from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo
Module pattern from libxml2
API Menu
API Indexes
Related links
PrevparserInternalsUpAPI documentationHomeThe XML C parser and toolkit of GnomerelaxngNext
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.
@@ -24,14 +25,20 @@ The content of this structure is not made public by the API.
 
int	xmlPatternMatch			(xmlPatternPtr comp, 
					 xmlNodePtr node)

 
int	xmlPatternMaxDepth		(xmlPatternPtr comp)

 
int	xmlPatternStreamable		(xmlPatternPtr comp)

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

+
xmlPatternPtr	xmlPatterncompile	(const xmlChar * pattern, 
					 xmlDict * dict, 
					 xmlPatternFlags 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)

 
Description

 
Structure xmlPattern
Structure xmlPattern
struct _xmlPattern {
 The content of this structure is not made public by the API.
-}
Structure xmlStreamCtxt
Structure xmlStreamCtxt
struct _xmlStreamCtxt {
+}
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

@@ -44,17 +51,17 @@ The content of this structure is not made public by the API.
 
comp:the precompiled pattern
Returns:1 if true, 0 if false and -1 in case of error
Function: xmlPatternGetStreamCtxt
xmlStreamCtxtPtr	xmlPatternGetStreamCtxt	(xmlPatternPtr comp)

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

 
comp:the precompiled pattern
Returns:a pointer to the context or NULL in case of failure
Function: xmlPatternMatch
int	xmlPatternMatch			(xmlPatternPtr comp, 
					 xmlNodePtr node)

-
Test wether the node matches the pattern

+
Test whether the node matches the pattern

 
comp:the precompiled pattern
node:a node
Returns:1 if it matches, 0 if it doesn't and -1 in case of failure
Function: xmlPatternMaxDepth
int	xmlPatternMaxDepth		(xmlPatternPtr comp)

 
Check the maximum depth reachable by a pattern

 
comp:the precompiled pattern
Returns:-2 if no limit (using //), otherwise the depth, and -1 in case of error
Function: xmlPatternStreamable
int	xmlPatternStreamable		(xmlPatternPtr comp)

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

-
comp:the precompiled pattern
Returns:1 if streamable, 0 if not and -1 in case of error.
Function: xmlPatterncompile
xmlPatternPtr	xmlPatterncompile	(const xmlChar * pattern, 
					 xmlDict * dict, 
					 int flags, 
					 const xmlChar ** namespaces)

+
comp:the precompiled pattern
Returns:1 if streamable, 0 if not and -1 in case of error.
Function: xmlPatterncompile
xmlPatternPtr	xmlPatterncompile	(const xmlChar * pattern, 
					 xmlDict * dict, 
					 xmlPatternFlags flags, 
					 const xmlChar ** namespaces)

 
Compile a pattern.

-
pattern:the pattern to compile
dict:an optional dictionnary for interned strings
flags:compilation flags, undefined yet
namespaces:the prefix definitions, array of [URI, prefix] or NULL
Returns:the compiled for of the pattern or NULL in case of error
Function: xmlStreamPop
int	xmlStreamPop			(xmlStreamCtxtPtr stream)

+
pattern:the pattern to compile
dict:an optional dictionary for interned strings
flags:compilation flags, undefined yet
namespaces:the prefix definitions, array of [URI, prefix] or NULL
Returns:the compiled form of the pattern or NULL in case of error
Function: xmlStreamPop
int	xmlStreamPop			(xmlStreamCtxtPtr stream)

 
push one level from the stream.

 
stream:the stream context
Returns:-1 in case of error, 0 otherwise.
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 dictionnary, 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.

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

 
stream:the stream context
name:the current name
ns:the namespace name
Returns:-1 in case of error, 1 if the current state in the stream is a match and 0 otherwise.
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 dictionnary, 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.

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

 
stream:the stream context
name:the current name
ns:the namespace name
Returns:-1 in case of error, 1 if the current state in the stream is a match and 0 otherwise.
Daniel Veillard

-- 
cgit v1.2.3