Gnome XML Library Reference Manual | |||
---|---|---|---|
<<< Previous Page | Home | Up | Next Page >>> |
#define xmlXPathGetError(ctxt) ((ctxt)->error) |
Get the error code of an XPath context.
#define xmlXPathCheckError(ctxt) ((ctxt)->error != XPATH_EXPRESSION_OK) |
Check if an XPath error was raised.
#define xmlXPathGetDocument(ctxt) ((ctxt)->context->doc) |
Get the document of an XPath context.
#define xmlXPathGetContextNode(ctxt) ((ctxt)->context->node) |
Get the context node of an XPath context.
int xmlXPathPopBoolean (xmlXPathParserContextPtr ctxt); |
Pops a boolean from the stack, handling conversion if needed. Check error with xmlXPathCheckError.
|
Pops a number from the stack, handling conversion if needed. Check error with xmlXPathCheckError.
xmlChar* xmlXPathPopString (xmlXPathParserContextPtr ctxt); |
Pops a string from the stack, handling conversion if needed. Check error with xmlXPathCheckError.
xmlNodeSetPtr xmlXPathPopNodeSet (xmlXPathParserContextPtr ctxt); |
Pops a node-set from the stack, handling conversion if needed. Check error with xmlXPathCheckError.
void* xmlXPathPopExternal (xmlXPathParserContextPtr ctxt); |
Pops an external object from the stack, handling conversion if needed. Check error with xmlXPathCheckError.
#define xmlXPathReturnBoolean(ctxt, val) |
Pushes the boolean val on the context stack.
#define xmlXPathReturnTrue(ctxt) xmlXPathReturnBoolean((ctxt), 1) |
Pushes true on the context stack.
#define xmlXPathReturnFalse(ctxt) xmlXPathReturnBoolean((ctxt), 0) |
Pushes false on the context stack.
#define xmlXPathReturnNumber(ctxt, val) |
Pushes the double val on the context stack.
#define xmlXPathReturnString(ctxt, str) |
Pushes the string str on the context stack.
#define xmlXPathReturnEmptyString(ctxt) |
Pushes an empty string on the stack.
#define xmlXPathReturnNodeSet(ctxt, ns) |
Pushes the node-set ns on the context stack.
#define xmlXPathReturnEmptyNodeSet(ctxt) |
Pushes an empty node-set on the context stack.
#define xmlXPathReturnExternal(ctxt, val) |
Pushes user data on the context stack.
#define xmlXPathStackIsNodeSet(ctxt) |
Check if the current value on the XPath stack is a node set or an XSLT value tree.
#define xmlXPathStackIsExternal(ctxt) |
Checks if the current value on the XPath stack is an external object.
#define CHECK_TYPE(typeval) |
Macro to check that the value on top of the XPath stack is of a given type.
#define CHECK_TYPE0(typeval) |
Macro to check that the value on top of the XPath stack is of a given type. Return(0) in case of failure
#define CHECK_ARITY(x) |
Macro to check that the number of args passed to an XPath function matches.
#define CAST_TO_STRING |
Macro to try to cast the value on the top of the XPath stack to a string.
#define CAST_TO_NUMBER |
Macro to try to cast the value on the top of the XPath stack to a number.
#define CAST_TO_BOOLEAN |
Macro to try to cast the value on the top of the XPath stack to a boolean.
xmlXPathObjectPtr (*xmlXPathVariableLookupFunc) (void *ctxt, const xmlChar *name, const xmlChar *ns_uri); |
Prototype for callbacks used to plug variable lookup in the XPath engine.
void xmlXPathRegisterVariableLookup (xmlXPathContextPtr ctxt, xmlXPathVariableLookupFunc f, void *data); |
register an external mechanism to do variable lookup
xmlXPathFunction (*xmlXPathFuncLookupFunc) (void *ctxt, const xmlChar *name, const xmlChar *ns_uri); |
Prototype for callbacks used to plug function lookup in the XPath engine.
void xmlXPathRegisterFuncLookup (xmlXPathContextPtr ctxt, xmlXPathFuncLookupFunc f, void *funcCtxt); |
Registers an external mechanism to do function lookup.
void xmlXPatherror (xmlXPathParserContextPtr ctxt, const char *file, int line, int no); |
Formats an error message.
void xmlXPathDebugDumpObject ( |
Dump the content of the object for debugging purposes
void xmlXPathDebugDumpCompExpr ( |
Dumps the tree of the compiled XPath expression.
int xmlXPathNodeSetContains (xmlNodeSetPtr cur, xmlNodePtr val); |
checks whether cur contains val
xmlNodeSetPtr xmlXPathDifference (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathIntersection (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathDistinctSorted (xmlNodeSetPtr nodes); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathDistinct (xmlNodeSetPtr nodes); |
Implements the EXSLT - Sets
int xmlXPathHasSameNodes (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2); |
Implements the EXSLT - Sets has-same-nodes function: boolean set:has-same-node(node-set, node-set)
xmlNodeSetPtr xmlXPathNodeLeadingSorted (xmlNodeSetPtr nodes, xmlNodePtr node); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathLeadingSorted (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathNodeLeading (xmlNodeSetPtr nodes, xmlNodePtr node); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathLeading (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathNodeTrailingSorted (xmlNodeSetPtr nodes, xmlNodePtr node); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathTrailingSorted (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathNodeTrailing (xmlNodeSetPtr nodes, xmlNodePtr node); |
Implements the EXSLT - Sets
xmlNodeSetPtr xmlXPathTrailing (xmlNodeSetPtr nodes1, xmlNodeSetPtr nodes2); |
Implements the EXSLT - Sets
int xmlXPathRegisterNs (xmlXPathContextPtr ctxt, const xmlChar *prefix, const xmlChar *ns_uri); |
Register a new namespace. If ns_uri is NULL it unregisters the namespace
const xmlChar* xmlXPathNsLookup (xmlXPathContextPtr ctxt, const xmlChar *prefix); |
Search in the namespace declaration array of the context for the given namespace name associated to the given prefix
void xmlXPathRegisteredNsCleanup (xmlXPathContextPtr ctxt); |
Cleanup the XPath context data associated to registered variables
int xmlXPathRegisterFunc (xmlXPathContextPtr ctxt, const xmlChar *name, xmlXPathFunction f); |
Register a new function. If f is NULL it unregisters the function
int xmlXPathRegisterFuncNS (xmlXPathContextPtr ctxt, const xmlChar *name, const xmlChar *ns_uri, xmlXPathFunction f); |
Register a new function. If f is NULL it unregisters the function
int xmlXPathRegisterVariable (xmlXPathContextPtr ctxt, const xmlChar *name, xmlXPathObjectPtr value); |
Register a new variable value. If value is NULL it unregisters the variable
int xmlXPathRegisterVariableNS (xmlXPathContextPtr ctxt, const xmlChar *name, const xmlChar *ns_uri, xmlXPathObjectPtr value); |
Register a new variable value. If value is NULL it unregisters the variable
xmlXPathFunction xmlXPathFunctionLookup (xmlXPathContextPtr ctxt, const xmlChar *name); |
Search in the Function array of the context for the given function.
xmlXPathFunction xmlXPathFunctionLookupNS (xmlXPathContextPtr ctxt, const xmlChar *name, const xmlChar *ns_uri); |
Search in the Function array of the context for the given function.
void xmlXPathRegisteredFuncsCleanup (xmlXPathContextPtr ctxt); |
Cleanup the XPath context data associated to registered functions
xmlXPathObjectPtr xmlXPathVariableLookup (xmlXPathContextPtr ctxt, const xmlChar *name); |
Search in the Variable array of the context for the given variable value.
xmlXPathObjectPtr xmlXPathVariableLookupNS (xmlXPathContextPtr ctxt, const xmlChar *name, const xmlChar *ns_uri); |
Search in the Variable array of the context for the given variable value.
void xmlXPathRegisteredVariablesCleanup (xmlXPathContextPtr ctxt); |
Cleanup the XPath context data associated to registered variables
xmlXPathParserContextPtr xmlXPathNewParserContext (const xmlChar *str, xmlXPathContextPtr ctxt); |
Create a new xmlXPathParserContext
void xmlXPathFreeParserContext (xmlXPathParserContextPtr ctxt); |
Free up an xmlXPathParserContext
xmlXPathObjectPtr valuePop (xmlXPathParserContextPtr ctxt); |
Pops the top XPath object from the value stack
int valuePush (xmlXPathParserContextPtr ctxt, xmlXPathObjectPtr value); |
Pushes a new XPath object on top of the value stack
xmlXPathObjectPtr xmlXPathNewString (const xmlChar *val); |
Create a new xmlXPathObjectPtr of type string and of value val
xmlXPathObjectPtr xmlXPathNewCString (const char *val); |
Create a new xmlXPathObjectPtr of type string and of value val
xmlXPathObjectPtr xmlXPathWrapString (xmlChar *val); |
Wraps the val string into an XPath object.
xmlXPathObjectPtr xmlXPathWrapCString (char *val); |
Wraps a string into an XPath object.
xmlXPathObjectPtr xmlXPathNewFloat ( |
Create a new xmlXPathObjectPtr of type double and of value val
xmlXPathObjectPtr xmlXPathNewBoolean (int val); |
Create a new xmlXPathObjectPtr of type boolean and of value val
xmlXPathObjectPtr xmlXPathNewNodeSet (xmlNodePtr val); |
Create a new xmlXPathObjectPtr of type NodeSet and initialize it with the single Node val
xmlXPathObjectPtr xmlXPathNewValueTree (xmlNodePtr val); |
Create a new xmlXPathObjectPtr of type Value Tree (XSLT) and initialize it with the tree root val
void xmlXPathNodeSetAdd (xmlNodeSetPtr cur, xmlNodePtr val); |
add a new xmlNodePtr to an existing NodeSet
void xmlXPathNodeSetAddUnique (xmlNodeSetPtr cur, xmlNodePtr val); |
add a new xmlNodePtr to an existing NodeSet, optimized version when we are sure the node is not already in the set.
void xmlXPathNodeSetSort (xmlNodeSetPtr set); |
Sort the node set in document order
void xmlXPathRoot (xmlXPathParserContextPtr ctxt); |
Initialize the context to the root of the document
void xmlXPathEvalExpr (xmlXPathParserContextPtr ctxt); |
Parse and evaluate an XPath expression in the given context, then push the result on the context stack
xmlChar* xmlXPathParseName (xmlXPathParserContextPtr ctxt); |
parse an XML name
[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' | CombiningChar | Extender
[5] Name ::= (Letter | '_' | ':') (NameChar)*
xmlChar* xmlXPathParseNCName (xmlXPathParserContextPtr ctxt); |
parse an XML namespace non qualified name.
[NS 3] NCName ::= (Letter | '_') (NCNameChar)*
[NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' | CombiningChar | Extender
|
[30a] Float ::= Number ('e' Digits?)?
[30] Number ::= Digits ('.' Digits?)? | '.' Digits [31] Digits ::= [0-9]+
Compile a Number in the string In complement of the Number expression, this function also handles negative values : '-' Number.
int xmlXPathEvaluatePredicateResult (xmlXPathParserContextPtr ctxt, xmlXPathObjectPtr res); |
Evaluate a predicate result for the current node. A PredicateExpr is evaluated by evaluating the Expr and converting the result to a boolean. If the result is a number, the result will be converted to true if the number is equal to the position of the context node in the context node list (as returned by the position function) and will be converted to false otherwise; if the result is not a number, then the result will be converted as if by a call to the boolean function.
void xmlXPathRegisterAllFunctions (xmlXPathContextPtr ctxt); |
Registers all default XPath functions in this context
xmlNodeSetPtr xmlXPathNodeSetMerge (xmlNodeSetPtr val1, xmlNodeSetPtr val2); |
Merges two nodesets, all nodes from val2 are added to val1 if val1 is NULL, a new set is created and copied from val2
void xmlXPathNodeSetDel (xmlNodeSetPtr cur, xmlNodePtr val); |
Removes an xmlNodePtr from an existing NodeSet
void xmlXPathNodeSetRemove (xmlNodeSetPtr cur, int val); |
Removes an entry from an existing NodeSet list.
xmlXPathObjectPtr xmlXPathNewNodeSetList (xmlNodeSetPtr val); |
Create a new xmlXPathObjectPtr of type NodeSet and initialize it with the Nodeset val
xmlXPathObjectPtr xmlXPathWrapNodeSet (xmlNodeSetPtr val); |
Wrap the Nodeset val in a new xmlXPathObjectPtr
xmlXPathObjectPtr xmlXPathWrapExternal (void *val); |
Wraps the val data into an XPath object.
int xmlXPathEqualValues (xmlXPathParserContextPtr ctxt); |
Implement the equal operation on XPath objects content: arg1 == arg2
int xmlXPathCompareValues (xmlXPathParserContextPtr ctxt, int inf, int strict); |
Implement the compare operation on XPath objects: arg1 < arg2 (1, 1, ... arg1 <= arg2 (1, 0, ... arg1 > arg2 (0, 1, ... arg1 >= arg2 (0, 0, ...
When neither object to be compared is a node-set and the operator is <=, <, >=, >, then the objects are compared by converted both objects to numbers and comparing the numbers according to IEEE 754. The < comparison will be true if and only if the first number is less than the second number. The <= comparison will be true if and only if the first number is less than or equal to the second number. The > comparison will be true if and only if the first number is greater than the second number. The >= comparison will be true if and only if the first number is greater than or equal to the second number.
void xmlXPathValueFlipSign (xmlXPathParserContextPtr ctxt); |
Implement the unary - operation on an XPath object The numeric operators convert their operands to numbers as if by calling the number function.
void xmlXPathAddValues (xmlXPathParserContextPtr ctxt); |
Implement the add operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.
void xmlXPathSubValues (xmlXPathParserContextPtr ctxt); |
Implement the subtraction operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.
void xmlXPathMultValues (xmlXPathParserContextPtr ctxt); |
Implement the multiply operation on XPath objects: The numeric operators convert their operands to numbers as if by calling the number function.
void xmlXPathDivValues (xmlXPathParserContextPtr ctxt); |
Implement the div operation on XPath objects arg1 / arg2: The numeric operators convert their operands to numbers as if by calling the number function.
void xmlXPathModValues (xmlXPathParserContextPtr ctxt); |
Implement the mod operation on XPath objects: arg1 / arg2 The numeric operators convert their operands to numbers as if by calling the number function.
int xmlXPathIsNodeType (const xmlChar *name); |
Is the name given a NodeType one.
[38] NodeType ::= 'comment' | 'text' | 'processing-instruction' | 'node'
xmlNodePtr xmlXPathNextSelf (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "self" direction The self axis contains just the context node itself
xmlNodePtr xmlXPathNextChild (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "child" direction The child axis contains the children of the context node in document order.
xmlNodePtr xmlXPathNextDescendant (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "descendant" direction the descendant axis contains the descendants of the context node in document order; a descendant is a child or a child of a child and so on.
xmlNodePtr xmlXPathNextDescendantOrSelf (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "descendant-or-self" direction the descendant-or-self axis contains the context node and the descendants of the context node in document order; thus the context node is the first node on the axis, and the first child of the context node is the second node on the axis
xmlNodePtr xmlXPathNextParent (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "parent" direction The parent axis contains the parent of the context node, if there is one.
xmlNodePtr xmlXPathNextAncestorOrSelf (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "ancestor-or-self" direction he ancestor-or-self axis contains the context node and ancestors of the context node in reverse document order; thus the context node is the first node on the axis, and the context node's parent the second; parent here is defined the same as with the parent axis.
xmlNodePtr xmlXPathNextFollowingSibling (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "following-sibling" direction The following-sibling axis contains the following siblings of the context node in document order.
xmlNodePtr xmlXPathNextFollowing (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "following" direction The following axis contains all nodes in the same document as the context node that are after the context node in document order, excluding any descendants and excluding attribute nodes and namespace nodes; the nodes are ordered in document order
xmlNodePtr xmlXPathNextNamespace (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "namespace" direction the namespace axis contains the namespace nodes of the context node; the order of nodes on this axis is implementation-defined; the axis will be empty unless the context node is an element
We keep the XML namespace node at the end of the list.
xmlNodePtr xmlXPathNextAttribute (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "attribute" direction TODO: support DTD inherited default attributes
xmlNodePtr xmlXPathNextPreceding (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "preceding" direction the preceding axis contains all nodes in the same document as the context node that are before the context node in document order, excluding any ancestors and excluding attribute nodes and namespace nodes; the nodes are ordered in reverse document order
xmlNodePtr xmlXPathNextAncestor (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "ancestor" direction the ancestor axis contains the ancestors of the context node; the ancestors of the context node consist of the parent of context node and the parent's parent and so on; the nodes are ordered in reverse document order; thus the parent is the first node on the axis, and the parent's parent is the second node on the axis
xmlNodePtr xmlXPathNextPrecedingSibling (xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
Traversal function for the "preceding-sibling" direction The preceding-sibling axis contains the preceding siblings of the context node in reverse document order; the first preceding sibling is first on the axis; the sibling preceding that node is the second on the axis and so on.
void xmlXPathLastFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathPositionFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathCountFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathIdFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathLocalNameFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the local-
void xmlXPathNamespaceURIFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the namespace-
void xmlXPathStringFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
If the argument is omitted, it defaults to a node-set with the context node as its only member.
void xmlXPathStringLengthFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the string-
void xmlXPathConcatFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathContainsFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathStartsWithFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the starts-
void xmlXPathSubstringFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathSubstringBeforeFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the substring-
void xmlXPathSubstringAfterFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the substring-
void xmlXPathNormalizeFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the normalize-
void xmlXPathTranslateFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathNotFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathTrueFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathFalseFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathLangFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathNumberFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathSumFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathFloorFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathCeilingFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathRoundFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the
void xmlXPathBooleanFunction (xmlXPathParserContextPtr ctxt, int nargs); |
Implement the