-/*\r
- * Summary: XML Path Language implementation\r
- * Description: API for the XML Path Language implementation\r
- *\r
- * XML Path Language implementation\r
- * XPath is a language for addressing parts of an XML document,\r
- * designed to be used by both XSLT and XPointer\r
- * http://www.w3.org/TR/xpath\r
- *\r
- * Implements\r
- * W3C Recommendation 16 November 1999\r
- * http://www.w3.org/TR/1999/REC-xpath-19991116\r
- *\r
- * Copy: See Copyright for the status of this software.\r
- *\r
- * Author: Daniel Veillard\r
- */\r
-\r
-#ifndef __XML_XPATH_H__\r
-#define __XML_XPATH_H__\r
-\r
-#include <libxml/xmlversion.h>\r
-\r
-#ifdef LIBXML_XPATH_ENABLED\r
-\r
-#include <libxml/xmlerror.h>\r
-#include <libxml/tree.h>\r
-#include <libxml/hash.h>\r
-#endif /* LIBXML_XPATH_ENABLED */\r
-\r
-#if defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)\r
-#ifdef __cplusplus\r
-extern "C" {\r
-#endif\r
-#endif /* LIBXML_XPATH_ENABLED or LIBXML_SCHEMAS_ENABLED */\r
- \r
-#ifdef LIBXML_XPATH_ENABLED\r
-typedef struct _xmlXPathContext xmlXPathContext;\r
-typedef xmlXPathContext *xmlXPathContextPtr;\r
-typedef struct _xmlXPathParserContext xmlXPathParserContext;\r
-typedef xmlXPathParserContext *xmlXPathParserContextPtr;\r
-\r
-/**\r
- * The set of XPath error codes.\r
- */\r
-\r
-typedef enum {\r
- XPATH_EXPRESSION_OK = 0,\r
- XPATH_NUMBER_ERROR,\r
- XPATH_UNFINISHED_LITERAL_ERROR,\r
- XPATH_START_LITERAL_ERROR,\r
- XPATH_VARIABLE_REF_ERROR,\r
- XPATH_UNDEF_VARIABLE_ERROR,\r
- XPATH_INVALID_PREDICATE_ERROR,\r
- XPATH_EXPR_ERROR,\r
- XPATH_UNCLOSED_ERROR,\r
- XPATH_UNKNOWN_FUNC_ERROR,\r
- XPATH_INVALID_OPERAND,\r
- XPATH_INVALID_TYPE,\r
- XPATH_INVALID_ARITY,\r
- XPATH_INVALID_CTXT_SIZE,\r
- XPATH_INVALID_CTXT_POSITION,\r
- XPATH_MEMORY_ERROR,\r
- XPTR_SYNTAX_ERROR,\r
- XPTR_RESOURCE_ERROR,\r
- XPTR_SUB_RESOURCE_ERROR,\r
- XPATH_UNDEF_PREFIX_ERROR,\r
- XPATH_ENCODING_ERROR,\r
- XPATH_INVALID_CHAR_ERROR,\r
- XPATH_INVALID_CTXT\r
-} xmlXPathError;\r
-\r
-/*\r
- * A node-set (an unordered collection of nodes without duplicates).\r
- */\r
-typedef struct _xmlNodeSet xmlNodeSet;\r
-typedef xmlNodeSet *xmlNodeSetPtr;\r
-struct _xmlNodeSet {\r
- int nodeNr; /* number of nodes in the set */\r
- int nodeMax; /* size of the array as allocated */\r
- xmlNodePtr *nodeTab; /* array of nodes in no particular order */\r
- /* @@ with_ns to check wether namespace nodes should be looked at @@ */\r
-};\r
-\r
-/*\r
- * An expression is evaluated to yield an object, which\r
- * has one of the following four basic types:\r
- * - node-set\r
- * - boolean\r
- * - number\r
- * - string\r
- *\r
- * @@ XPointer will add more types !\r
- */\r
-\r
-typedef enum {\r
- XPATH_UNDEFINED = 0,\r
- XPATH_NODESET = 1,\r
- XPATH_BOOLEAN = 2,\r
- XPATH_NUMBER = 3,\r
- XPATH_STRING = 4,\r
- XPATH_POINT = 5,\r
- XPATH_RANGE = 6,\r
- XPATH_LOCATIONSET = 7,\r
- XPATH_USERS = 8,\r
- XPATH_XSLT_TREE = 9 /* An XSLT value tree, non modifiable */\r
-} xmlXPathObjectType;\r
-\r
-typedef struct _xmlXPathObject xmlXPathObject;\r
-typedef xmlXPathObject *xmlXPathObjectPtr;\r
-struct _xmlXPathObject {\r
- xmlXPathObjectType type;\r
- xmlNodeSetPtr nodesetval;\r
- int boolval;\r
- double floatval;\r
- xmlChar *stringval;\r
- void *user;\r
- int index;\r
- void *user2;\r
- int index2;\r
-};\r
-\r
-/**\r
- * xmlXPathConvertFunc:\r
- * @obj: an XPath object\r
- * @type: the number of the target type\r
- *\r
- * A conversion function is associated to a type and used to cast\r
- * the new type to primitive values.\r
- *\r
- * Returns -1 in case of error, 0 otherwise\r
- */\r
-typedef int (*xmlXPathConvertFunc) (xmlXPathObjectPtr obj, int type);\r
-\r
-/*\r
- * Extra type: a name and a conversion function.\r
- */\r
-\r
-typedef struct _xmlXPathType xmlXPathType;\r
-typedef xmlXPathType *xmlXPathTypePtr;\r
-struct _xmlXPathType {\r
- const xmlChar *name; /* the type name */\r
- xmlXPathConvertFunc func; /* the conversion function */\r
-};\r
-\r
-/*\r
- * Extra variable: a name and a value.\r
- */\r
-\r
-typedef struct _xmlXPathVariable xmlXPathVariable;\r
-typedef xmlXPathVariable *xmlXPathVariablePtr;\r
-struct _xmlXPathVariable {\r
- const xmlChar *name; /* the variable name */\r
- xmlXPathObjectPtr value; /* the value */\r
-};\r
-\r
-/**\r
- * xmlXPathEvalFunc:\r
- * @ctxt: an XPath parser context\r
- * @nargs: the number of arguments passed to the function\r
- *\r
- * An XPath evaluation function, the parameters are on the XPath context stack.\r
- */\r
-\r
-typedef void (*xmlXPathEvalFunc)(xmlXPathParserContextPtr ctxt,\r
- int nargs);\r
-\r
-/*\r
- * Extra function: a name and a evaluation function.\r
- */\r
-\r
-typedef struct _xmlXPathFunct xmlXPathFunct;\r
-typedef xmlXPathFunct *xmlXPathFuncPtr;\r
-struct _xmlXPathFunct {\r
- const xmlChar *name; /* the function name */\r
- xmlXPathEvalFunc func; /* the evaluation function */\r
-};\r
-\r
-/**\r
- * xmlXPathAxisFunc:\r
- * @ctxt: the XPath interpreter context\r
- * @cur: the previous node being explored on that axis\r
- *\r
- * An axis traversal function. To traverse an axis, the engine calls\r
- * the first time with cur == NULL and repeat until the function returns\r
- * NULL indicating the end of the axis traversal.\r
- *\r
- * Returns the next node in that axis or NULL if at the end of the axis.\r
- */\r
-\r
-typedef xmlXPathObjectPtr (*xmlXPathAxisFunc) (xmlXPathParserContextPtr ctxt,\r
- xmlXPathObjectPtr cur);\r
-\r
-/*\r
- * Extra axis: a name and an axis function.\r
- */\r
-\r
-typedef struct _xmlXPathAxis xmlXPathAxis;\r
-typedef xmlXPathAxis *xmlXPathAxisPtr;\r
-struct _xmlXPathAxis {\r
- const xmlChar *name; /* the axis name */\r
- xmlXPathAxisFunc func; /* the search function */\r
-};\r
-\r
-/**\r
- * xmlXPathFunction:\r
- * @ctxt: the XPath interprestation context\r
- * @nargs: the number of arguments\r
- *\r
- * An XPath function.\r
- * The arguments (if any) are popped out from the context stack\r
- * and the result is pushed on the stack.\r
- */\r
-\r
-typedef void (*xmlXPathFunction) (xmlXPathParserContextPtr ctxt, int nargs);\r
-\r
-/*\r
- * Function and Variable Lookup.\r
- */\r
-\r
-/**\r
- * xmlXPathVariableLookupFunc:\r
- * @ctxt: an XPath context\r
- * @name: name of the variable\r
- * @ns_uri: the namespace name hosting this variable\r
- *\r
- * Prototype for callbacks used to plug variable lookup in the XPath\r
- * engine.\r
- *\r
- * Returns the XPath object value or NULL if not found.\r
- */\r
-typedef xmlXPathObjectPtr (*xmlXPathVariableLookupFunc) (void *ctxt,\r
- const xmlChar *name,\r
- const xmlChar *ns_uri);\r
-\r
-/**\r
- * xmlXPathFuncLookupFunc:\r
- * @ctxt: an XPath context\r
- * @name: name of the function\r
- * @ns_uri: the namespace name hosting this function\r
- *\r
- * Prototype for callbacks used to plug function lookup in the XPath\r
- * engine.\r
- *\r
- * Returns the XPath function or NULL if not found.\r
- */\r
-typedef xmlXPathFunction (*xmlXPathFuncLookupFunc) (void *ctxt,\r
- const xmlChar *name,\r
- const xmlChar *ns_uri);\r
-\r
-/**\r
- * xmlXPathContext:\r
- *\r
- * Expression evaluation occurs with respect to a context.\r
- * he context consists of:\r
- * - a node (the context node) \r
- * - a node list (the context node list) \r
- * - a set of variable bindings \r
- * - a function library \r
- * - the set of namespace declarations in scope for the expression \r
- * Following the switch to hash tables, this need to be trimmed up at\r
- * the next binary incompatible release.\r
- */\r
-\r
-struct _xmlXPathContext {\r
- xmlDocPtr doc; /* The current document */\r
- xmlNodePtr node; /* The current node */\r
-\r
- int nb_variables_unused; /* unused (hash table) */\r
- int max_variables_unused; /* unused (hash table) */\r
- xmlHashTablePtr varHash; /* Hash table of defined variables */\r
-\r
- int nb_types; /* number of defined types */\r
- int max_types; /* max number of types */\r
- xmlXPathTypePtr types; /* Array of defined types */\r
-\r
- int nb_funcs_unused; /* unused (hash table) */\r
- int max_funcs_unused; /* unused (hash table) */\r
- xmlHashTablePtr funcHash; /* Hash table of defined funcs */\r
-\r
- int nb_axis; /* number of defined axis */\r
- int max_axis; /* max number of axis */\r
- xmlXPathAxisPtr axis; /* Array of defined axis */\r
-\r
- /* the namespace nodes of the context node */\r
- xmlNsPtr *namespaces; /* Array of namespaces */\r
- int nsNr; /* number of namespace in scope */\r
- void *user; /* function to free */\r
-\r
- /* extra variables */\r
- int contextSize; /* the context size */\r
- int proximityPosition; /* the proximity position */\r
-\r
- /* extra stuff for XPointer */\r
- int xptr; /* it this an XPointer context */\r
- xmlNodePtr here; /* for here() */\r
- xmlNodePtr origin; /* for origin() */\r
-\r
- /* the set of namespace declarations in scope for the expression */\r
- xmlHashTablePtr nsHash; /* The namespaces hash table */\r
- xmlXPathVariableLookupFunc varLookupFunc;/* variable lookup func */\r
- void *varLookupData; /* variable lookup data */\r
-\r
- /* Possibility to link in an extra item */\r
- void *extra; /* needed for XSLT */\r
-\r
- /* The function name and URI when calling a function */\r
- const xmlChar *function;\r
- const xmlChar *functionURI;\r
-\r
- /* function lookup function and data */\r
- xmlXPathFuncLookupFunc funcLookupFunc;/* function lookup func */\r
- void *funcLookupData; /* function lookup data */\r
-\r
- /* temporary namespace lists kept for walking the namespace axis */\r
- xmlNsPtr *tmpNsList; /* Array of namespaces */\r
- int tmpNsNr; /* number of namespace in scope */\r
-\r
- /* error reporting mechanism */\r
- void *userData; /* user specific data block */\r
- xmlStructuredErrorFunc error; /* the callback in case of errors */\r
- xmlError lastError; /* the last error */\r
- xmlNodePtr debugNode; /* the source node XSLT */\r
-\r
- /* dictionnary */\r
- xmlDictPtr dict; /* dictionnary if any */\r
-};\r
-\r
-/*\r
- * The structure of a compiled expression form is not public.\r
- */\r
-\r
-typedef struct _xmlXPathCompExpr xmlXPathCompExpr;\r
-typedef xmlXPathCompExpr *xmlXPathCompExprPtr;\r
-\r
-/**\r
- * xmlXPathParserContext:\r
- *\r
- * An XPath parser context. It contains pure parsing informations,\r
- * an xmlXPathContext, and the stack of objects.\r
- */\r
-struct _xmlXPathParserContext {\r
- const xmlChar *cur; /* the current char being parsed */\r
- const xmlChar *base; /* the full expression */\r
-\r
- int error; /* error code */\r
-\r
- xmlXPathContextPtr context; /* the evaluation context */\r
- xmlXPathObjectPtr value; /* the current value */\r
- int valueNr; /* number of values stacked */\r
- int valueMax; /* max number of values stacked */\r
- xmlXPathObjectPtr *valueTab; /* stack of values */\r
-\r
- xmlXPathCompExprPtr comp; /* the precompiled expression */\r
- int xptr; /* it this an XPointer expression */\r
- xmlNodePtr ancestor; /* used for walking preceding axis */\r
-};\r
-\r
-/************************************************************************\r
- * *\r
- * Public API *\r
- * *\r
- ************************************************************************/\r
-\r
-/**\r
- * Objects and Nodesets handling\r
- */\r
-\r
-XMLPUBVAR double xmlXPathNAN;\r
-XMLPUBVAR double xmlXPathPINF;\r
-XMLPUBVAR double xmlXPathNINF;\r
-\r
-/* These macros may later turn into functions */\r
-/**\r
- * xmlXPathNodeSetGetLength:\r
- * @ns: a node-set\r
- *\r
- * Implement a functionality similar to the DOM NodeList.length.\r
- *\r
- * Returns the number of nodes in the node-set.\r
- */\r
-#define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0)\r
-/**\r
- * xmlXPathNodeSetItem:\r
- * @ns: a node-set\r
- * @index: index of a node in the set\r
- *\r
- * Implements a functionality similar to the DOM NodeList.item().\r
- *\r
- * Returns the xmlNodePtr at the given @index in @ns or NULL if\r
- * @index is out of range (0 to length-1)\r
- */\r
-#define xmlXPathNodeSetItem(ns, index) \\r
- ((((ns) != NULL) && \\r
- ((index) >= 0) && ((index) < (ns)->nodeNr)) ? \\r
- (ns)->nodeTab[(index)] \\r
- : NULL)\r
-/**\r
- * xmlXPathNodeSetIsEmpty:\r
- * @ns: a node-set\r
- *\r
- * Checks whether @ns is empty or not.\r
- *\r
- * Returns %TRUE if @ns is an empty node-set.\r
- */\r
-#define xmlXPathNodeSetIsEmpty(ns) \\r
- (((ns) == NULL) || ((ns)->nodeNr == 0) || ((ns)->nodeTab == NULL))\r
-\r
-\r
-XMLPUBFUN void XMLCALL \r
- xmlXPathFreeObject (xmlXPathObjectPtr obj);\r
-XMLPUBFUN xmlNodeSetPtr XMLCALL \r
- xmlXPathNodeSetCreate (xmlNodePtr val);\r
-XMLPUBFUN void XMLCALL \r
- xmlXPathFreeNodeSetList (xmlXPathObjectPtr obj);\r
-XMLPUBFUN void XMLCALL \r
- xmlXPathFreeNodeSet (xmlNodeSetPtr obj);\r
-XMLPUBFUN xmlXPathObjectPtr XMLCALL \r
- xmlXPathObjectCopy (xmlXPathObjectPtr val);\r
-XMLPUBFUN int XMLCALL \r
- xmlXPathCmpNodes (xmlNodePtr node1,\r
- xmlNodePtr node2);\r
-/**\r
- * Conversion functions to basic types.\r
- */\r
-XMLPUBFUN int XMLCALL \r
- xmlXPathCastNumberToBoolean (double val);\r
-XMLPUBFUN int XMLCALL \r
- xmlXPathCastStringToBoolean (const xmlChar * val);\r
-XMLPUBFUN int XMLCALL \r
- xmlXPathCastNodeSetToBoolean(xmlNodeSetPtr ns);\r
-XMLPUBFUN int XMLCALL \r
- xmlXPathCastToBoolean (xmlXPathObjectPtr val);\r
-\r
-XMLPUBFUN double XMLCALL \r
- xmlXPathCastBooleanToNumber (int val);\r
-XMLPUBFUN double XMLCALL \r
- xmlXPathCastStringToNumber (const xmlChar * val);\r
-XMLPUBFUN double XMLCALL \r
- xmlXPathCastNodeToNumber (xmlNodePtr node);\r
-XMLPUBFUN double XMLCALL \r
- xmlXPathCastNodeSetToNumber (xmlNodeSetPtr ns);\r
-XMLPUBFUN double XMLCALL \r
- xmlXPathCastToNumber (xmlXPathObjectPtr val);\r
-\r
-XMLPUBFUN xmlChar * XMLCALL \r
- xmlXPathCastBooleanToString (int val);\r
-XMLPUBFUN xmlChar * XMLCALL \r
- xmlXPathCastNumberToString (double val);\r
-XMLPUBFUN xmlChar * XMLCALL \r
- xmlXPathCastNodeToString (xmlNodePtr node);\r
-XMLPUBFUN xmlChar * XMLCALL \r
- xmlXPathCastNodeSetToString (xmlNodeSetPtr ns);\r
-XMLPUBFUN xmlChar * XMLCALL \r
- xmlXPathCastToString (xmlXPathObjectPtr val);\r
-\r
-XMLPUBFUN xmlXPathObjectPtr XMLCALL \r
- xmlXPathConvertBoolean (xmlXPathObjectPtr val);\r
-XMLPUBFUN xmlXPathObjectPtr XMLCALL \r
- xmlXPathConvertNumber (xmlXPathObjectPtr val);\r
-XMLPUBFUN xmlXPathObjectPtr XMLCALL \r
- xmlXPathConvertString (xmlXPathObjectPtr val);\r
-\r
-/**\r
- * Context handling.\r
- */\r
-XMLPUBFUN xmlXPathContextPtr XMLCALL \r
- xmlXPathNewContext (xmlDocPtr doc);\r
-XMLPUBFUN void XMLCALL \r
- xmlXPathFreeContext (xmlXPathContextPtr ctxt);\r
-\r
-/**\r
- * Evaluation functions.\r
- */\r
-XMLPUBFUN long XMLCALL \r
- xmlXPathOrderDocElems (xmlDocPtr doc);\r
-XMLPUBFUN xmlXPathObjectPtr XMLCALL \r
- xmlXPathEval (const xmlChar *str,\r
- xmlXPathContextPtr ctx);\r
-XMLPUBFUN xmlXPathObjectPtr XMLCALL \r
- xmlXPathEvalExpression (const xmlChar *str,\r
- xmlXPathContextPtr ctxt);\r
-XMLPUBFUN int XMLCALL \r
- xmlXPathEvalPredicate (xmlXPathContextPtr ctxt,\r
- xmlXPathObjectPtr res);\r
-/**\r
- * Separate compilation/evaluation entry points.\r
- */\r
-XMLPUBFUN xmlXPathCompExprPtr XMLCALL \r
- xmlXPathCompile (const xmlChar *str);\r
-XMLPUBFUN xmlXPathCompExprPtr XMLCALL \r
- xmlXPathCtxtCompile (xmlXPathContextPtr ctxt,\r
- const xmlChar *str);\r
-XMLPUBFUN xmlXPathObjectPtr XMLCALL \r
- xmlXPathCompiledEval (xmlXPathCompExprPtr comp,\r
- xmlXPathContextPtr ctx);\r
-XMLPUBFUN void XMLCALL \r
- xmlXPathFreeCompExpr (xmlXPathCompExprPtr comp);\r
-#endif /* LIBXML_XPATH_ENABLED */\r
-#if defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)\r
-XMLPUBFUN void XMLCALL \r
- xmlXPathInit (void);\r
-XMLPUBFUN int XMLCALL\r
- xmlXPathIsNaN (double val);\r
-XMLPUBFUN int XMLCALL\r
- xmlXPathIsInf (double val);\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* LIBXML_XPATH_ENABLED or LIBXML_SCHEMAS_ENABLED*/\r
-#endif /* ! __XML_XPATH_H__ */\r
+/*
+ * Summary: XML Path Language implementation
+ * Description: API for the XML Path Language implementation
+ *
+ * XML Path Language implementation
+ * XPath is a language for addressing parts of an XML document,
+ * designed to be used by both XSLT and XPointer
+ * http://www.w3.org/TR/xpath
+ *
+ * Implements
+ * W3C Recommendation 16 November 1999
+ * http://www.w3.org/TR/1999/REC-xpath-19991116
+ *
+ * Copy: See Copyright for the status of this software.
+ *
+ * Author: Daniel Veillard
+ */
+
+#ifndef __XML_XPATH_H__
+#define __XML_XPATH_H__
+
+#include <libxml/xmlversion.h>
+
+#ifdef LIBXML_XPATH_ENABLED
+
+#include <libxml/xmlerror.h>
+#include <libxml/tree.h>
+#include <libxml/hash.h>
+#endif /* LIBXML_XPATH_ENABLED */
+
+#if defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)
+#ifdef __cplusplus
+extern "C" {
+#endif
+#endif /* LIBXML_XPATH_ENABLED or LIBXML_SCHEMAS_ENABLED */
+
+#ifdef LIBXML_XPATH_ENABLED
+typedef struct _xmlXPathContext xmlXPathContext;
+typedef xmlXPathContext *xmlXPathContextPtr;
+typedef struct _xmlXPathParserContext xmlXPathParserContext;
+typedef xmlXPathParserContext *xmlXPathParserContextPtr;
+
+/**
+ * The set of XPath error codes.
+ */
+
+typedef enum {
+ XPATH_EXPRESSION_OK = 0,
+ XPATH_NUMBER_ERROR,
+ XPATH_UNFINISHED_LITERAL_ERROR,
+ XPATH_START_LITERAL_ERROR,
+ XPATH_VARIABLE_REF_ERROR,
+ XPATH_UNDEF_VARIABLE_ERROR,
+ XPATH_INVALID_PREDICATE_ERROR,
+ XPATH_EXPR_ERROR,
+ XPATH_UNCLOSED_ERROR,
+ XPATH_UNKNOWN_FUNC_ERROR,
+ XPATH_INVALID_OPERAND,
+ XPATH_INVALID_TYPE,
+ XPATH_INVALID_ARITY,
+ XPATH_INVALID_CTXT_SIZE,
+ XPATH_INVALID_CTXT_POSITION,
+ XPATH_MEMORY_ERROR,
+ XPTR_SYNTAX_ERROR,
+ XPTR_RESOURCE_ERROR,
+ XPTR_SUB_RESOURCE_ERROR,
+ XPATH_UNDEF_PREFIX_ERROR,
+ XPATH_ENCODING_ERROR,
+ XPATH_INVALID_CHAR_ERROR,
+ XPATH_INVALID_CTXT
+} xmlXPathError;
+
+/*
+ * A node-set (an unordered collection of nodes without duplicates).
+ */
+typedef struct _xmlNodeSet xmlNodeSet;
+typedef xmlNodeSet *xmlNodeSetPtr;
+struct _xmlNodeSet {
+ int nodeNr; /* number of nodes in the set */
+ int nodeMax; /* size of the array as allocated */
+ xmlNodePtr *nodeTab; /* array of nodes in no particular order */
+ /* @@ with_ns to check wether namespace nodes should be looked at @@ */
+};
+
+/*
+ * An expression is evaluated to yield an object, which
+ * has one of the following four basic types:
+ * - node-set
+ * - boolean
+ * - number
+ * - string
+ *
+ * @@ XPointer will add more types !
+ */
+
+typedef enum {
+ XPATH_UNDEFINED = 0,
+ XPATH_NODESET = 1,
+ XPATH_BOOLEAN = 2,
+ XPATH_NUMBER = 3,
+ XPATH_STRING = 4,
+ XPATH_POINT = 5,
+ XPATH_RANGE = 6,
+ XPATH_LOCATIONSET = 7,
+ XPATH_USERS = 8,
+ XPATH_XSLT_TREE = 9 /* An XSLT value tree, non modifiable */
+} xmlXPathObjectType;
+
+typedef struct _xmlXPathObject xmlXPathObject;
+typedef xmlXPathObject *xmlXPathObjectPtr;
+struct _xmlXPathObject {
+ xmlXPathObjectType type;
+ xmlNodeSetPtr nodesetval;
+ int boolval;
+ double floatval;
+ xmlChar *stringval;
+ void *user;
+ int index;
+ void *user2;
+ int index2;
+};
+
+/**
+ * xmlXPathConvertFunc:
+ * @obj: an XPath object
+ * @type: the number of the target type
+ *
+ * A conversion function is associated to a type and used to cast
+ * the new type to primitive values.
+ *
+ * Returns -1 in case of error, 0 otherwise
+ */
+typedef int (*xmlXPathConvertFunc) (xmlXPathObjectPtr obj, int type);
+
+/*
+ * Extra type: a name and a conversion function.
+ */
+
+typedef struct _xmlXPathType xmlXPathType;
+typedef xmlXPathType *xmlXPathTypePtr;
+struct _xmlXPathType {
+ const xmlChar *name; /* the type name */
+ xmlXPathConvertFunc func; /* the conversion function */
+};
+
+/*
+ * Extra variable: a name and a value.
+ */
+
+typedef struct _xmlXPathVariable xmlXPathVariable;
+typedef xmlXPathVariable *xmlXPathVariablePtr;
+struct _xmlXPathVariable {
+ const xmlChar *name; /* the variable name */
+ xmlXPathObjectPtr value; /* the value */
+};
+
+/**
+ * xmlXPathEvalFunc:
+ * @ctxt: an XPath parser context
+ * @nargs: the number of arguments passed to the function
+ *
+ * An XPath evaluation function, the parameters are on the XPath context stack.
+ */
+
+typedef void (*xmlXPathEvalFunc)(xmlXPathParserContextPtr ctxt,
+ int nargs);
+
+/*
+ * Extra function: a name and a evaluation function.
+ */
+
+typedef struct _xmlXPathFunct xmlXPathFunct;
+typedef xmlXPathFunct *xmlXPathFuncPtr;
+struct _xmlXPathFunct {
+ const xmlChar *name; /* the function name */
+ xmlXPathEvalFunc func; /* the evaluation function */
+};
+
+/**
+ * xmlXPathAxisFunc:
+ * @ctxt: the XPath interpreter context
+ * @cur: the previous node being explored on that axis
+ *
+ * An axis traversal function. To traverse an axis, the engine calls
+ * the first time with cur == NULL and repeat until the function returns
+ * NULL indicating the end of the axis traversal.
+ *
+ * Returns the next node in that axis or NULL if at the end of the axis.
+ */
+
+typedef xmlXPathObjectPtr (*xmlXPathAxisFunc) (xmlXPathParserContextPtr ctxt,
+ xmlXPathObjectPtr cur);
+
+/*
+ * Extra axis: a name and an axis function.
+ */
+
+typedef struct _xmlXPathAxis xmlXPathAxis;
+typedef xmlXPathAxis *xmlXPathAxisPtr;
+struct _xmlXPathAxis {
+ const xmlChar *name; /* the axis name */
+ xmlXPathAxisFunc func; /* the search function */
+};
+
+/**
+ * xmlXPathFunction:
+ * @ctxt: the XPath interprestation context
+ * @nargs: the number of arguments
+ *
+ * An XPath function.
+ * The arguments (if any) are popped out from the context stack
+ * and the result is pushed on the stack.
+ */
+
+typedef void (*xmlXPathFunction) (xmlXPathParserContextPtr ctxt, int nargs);
+
+/*
+ * Function and Variable Lookup.
+ */
+
+/**
+ * xmlXPathVariableLookupFunc:
+ * @ctxt: an XPath context
+ * @name: name of the variable
+ * @ns_uri: the namespace name hosting this variable
+ *
+ * Prototype for callbacks used to plug variable lookup in the XPath
+ * engine.
+ *
+ * Returns the XPath object value or NULL if not found.
+ */
+typedef xmlXPathObjectPtr (*xmlXPathVariableLookupFunc) (void *ctxt,
+ const xmlChar *name,
+ const xmlChar *ns_uri);
+
+/**
+ * xmlXPathFuncLookupFunc:
+ * @ctxt: an XPath context
+ * @name: name of the function
+ * @ns_uri: the namespace name hosting this function
+ *
+ * Prototype for callbacks used to plug function lookup in the XPath
+ * engine.
+ *
+ * Returns the XPath function or NULL if not found.
+ */
+typedef xmlXPathFunction (*xmlXPathFuncLookupFunc) (void *ctxt,
+ const xmlChar *name,
+ const xmlChar *ns_uri);
+
+/**
+ * xmlXPathContext:
+ *
+ * Expression evaluation occurs with respect to a context.
+ * he context consists of:
+ * - a node (the context node)
+ * - a node list (the context node list)
+ * - a set of variable bindings
+ * - a function library
+ * - the set of namespace declarations in scope for the expression
+ * Following the switch to hash tables, this need to be trimmed up at
+ * the next binary incompatible release.
+ */
+
+struct _xmlXPathContext {
+ xmlDocPtr doc; /* The current document */
+ xmlNodePtr node; /* The current node */
+
+ int nb_variables_unused; /* unused (hash table) */
+ int max_variables_unused; /* unused (hash table) */
+ xmlHashTablePtr varHash; /* Hash table of defined variables */
+
+ int nb_types; /* number of defined types */
+ int max_types; /* max number of types */
+ xmlXPathTypePtr types; /* Array of defined types */
+
+ int nb_funcs_unused; /* unused (hash table) */
+ int max_funcs_unused; /* unused (hash table) */
+ xmlHashTablePtr funcHash; /* Hash table of defined funcs */
+
+ int nb_axis; /* number of defined axis */
+ int max_axis; /* max number of axis */
+ xmlXPathAxisPtr axis; /* Array of defined axis */
+
+ /* the namespace nodes of the context node */
+ xmlNsPtr *namespaces; /* Array of namespaces */
+ int nsNr; /* number of namespace in scope */
+ void *user; /* function to free */
+
+ /* extra variables */
+ int contextSize; /* the context size */
+ int proximityPosition; /* the proximity position */
+
+ /* extra stuff for XPointer */
+ int xptr; /* it this an XPointer context */
+ xmlNodePtr here; /* for here() */
+ xmlNodePtr origin; /* for origin() */
+
+ /* the set of namespace declarations in scope for the expression */
+ xmlHashTablePtr nsHash; /* The namespaces hash table */
+ xmlXPathVariableLookupFunc varLookupFunc;/* variable lookup func */
+ void *varLookupData; /* variable lookup data */
+
+ /* Possibility to link in an extra item */
+ void *extra; /* needed for XSLT */
+
+ /* The function name and URI when calling a function */
+ const xmlChar *function;
+ const xmlChar *functionURI;
+
+ /* function lookup function and data */
+ xmlXPathFuncLookupFunc funcLookupFunc;/* function lookup func */
+ void *funcLookupData; /* function lookup data */
+
+ /* temporary namespace lists kept for walking the namespace axis */
+ xmlNsPtr *tmpNsList; /* Array of namespaces */
+ int tmpNsNr; /* number of namespace in scope */
+
+ /* error reporting mechanism */
+ void *userData; /* user specific data block */
+ xmlStructuredErrorFunc error; /* the callback in case of errors */
+ xmlError lastError; /* the last error */
+ xmlNodePtr debugNode; /* the source node XSLT */
+
+ /* dictionnary */
+ xmlDictPtr dict; /* dictionnary if any */
+};
+
+/*
+ * The structure of a compiled expression form is not public.
+ */
+
+typedef struct _xmlXPathCompExpr xmlXPathCompExpr;
+typedef xmlXPathCompExpr *xmlXPathCompExprPtr;
+
+/**
+ * xmlXPathParserContext:
+ *
+ * An XPath parser context. It contains pure parsing informations,
+ * an xmlXPathContext, and the stack of objects.
+ */
+struct _xmlXPathParserContext {
+ const xmlChar *cur; /* the current char being parsed */
+ const xmlChar *base; /* the full expression */
+
+ int error; /* error code */
+
+ xmlXPathContextPtr context; /* the evaluation context */
+ xmlXPathObjectPtr value; /* the current value */
+ int valueNr; /* number of values stacked */
+ int valueMax; /* max number of values stacked */
+ xmlXPathObjectPtr *valueTab; /* stack of values */
+
+ xmlXPathCompExprPtr comp; /* the precompiled expression */
+ int xptr; /* it this an XPointer expression */
+ xmlNodePtr ancestor; /* used for walking preceding axis */
+};
+
+/************************************************************************
+ * *
+ * Public API *
+ * *
+ ************************************************************************/
+
+/**
+ * Objects and Nodesets handling
+ */
+
+XMLPUBVAR double xmlXPathNAN;
+XMLPUBVAR double xmlXPathPINF;
+XMLPUBVAR double xmlXPathNINF;
+
+/* These macros may later turn into functions */
+/**
+ * xmlXPathNodeSetGetLength:
+ * @ns: a node-set
+ *
+ * Implement a functionality similar to the DOM NodeList.length.
+ *
+ * Returns the number of nodes in the node-set.
+ */
+#define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0)
+/**
+ * xmlXPathNodeSetItem:
+ * @ns: a node-set
+ * @index: index of a node in the set
+ *
+ * Implements a functionality similar to the DOM NodeList.item().
+ *
+ * Returns the xmlNodePtr at the given @index in @ns or NULL if
+ * @index is out of range (0 to length-1)
+ */
+#define xmlXPathNodeSetItem(ns, index) \
+ ((((ns) != NULL) && \
+ ((index) >= 0) && ((index) < (ns)->nodeNr)) ? \
+ (ns)->nodeTab[(index)] \
+ : NULL)
+/**
+ * xmlXPathNodeSetIsEmpty:
+ * @ns: a node-set
+ *
+ * Checks whether @ns is empty or not.
+ *
+ * Returns %TRUE if @ns is an empty node-set.
+ */
+#define xmlXPathNodeSetIsEmpty(ns) \
+ (((ns) == NULL) || ((ns)->nodeNr == 0) || ((ns)->nodeTab == NULL))
+
+
+XMLPUBFUN void XMLCALL
+ xmlXPathFreeObject (xmlXPathObjectPtr obj);
+XMLPUBFUN xmlNodeSetPtr XMLCALL
+ xmlXPathNodeSetCreate (xmlNodePtr val);
+XMLPUBFUN void XMLCALL
+ xmlXPathFreeNodeSetList (xmlXPathObjectPtr obj);
+XMLPUBFUN void XMLCALL
+ xmlXPathFreeNodeSet (xmlNodeSetPtr obj);
+XMLPUBFUN xmlXPathObjectPtr XMLCALL
+ xmlXPathObjectCopy (xmlXPathObjectPtr val);
+XMLPUBFUN int XMLCALL
+ xmlXPathCmpNodes (xmlNodePtr node1,
+ xmlNodePtr node2);
+/**
+ * Conversion functions to basic types.
+ */
+XMLPUBFUN int XMLCALL
+ xmlXPathCastNumberToBoolean (double val);
+XMLPUBFUN int XMLCALL
+ xmlXPathCastStringToBoolean (const xmlChar * val);
+XMLPUBFUN int XMLCALL
+ xmlXPathCastNodeSetToBoolean(xmlNodeSetPtr ns);
+XMLPUBFUN int XMLCALL
+ xmlXPathCastToBoolean (xmlXPathObjectPtr val);
+
+XMLPUBFUN double XMLCALL
+ xmlXPathCastBooleanToNumber (int val);
+XMLPUBFUN double XMLCALL
+ xmlXPathCastStringToNumber (const xmlChar * val);
+XMLPUBFUN double XMLCALL
+ xmlXPathCastNodeToNumber (xmlNodePtr node);
+XMLPUBFUN double XMLCALL
+ xmlXPathCastNodeSetToNumber (xmlNodeSetPtr ns);
+XMLPUBFUN double XMLCALL
+ xmlXPathCastToNumber (xmlXPathObjectPtr val);
+
+XMLPUBFUN xmlChar * XMLCALL
+ xmlXPathCastBooleanToString (int val);
+XMLPUBFUN xmlChar * XMLCALL
+ xmlXPathCastNumberToString (double val);
+XMLPUBFUN xmlChar * XMLCALL
+ xmlXPathCastNodeToString (xmlNodePtr node);
+XMLPUBFUN xmlChar * XMLCALL
+ xmlXPathCastNodeSetToString (xmlNodeSetPtr ns);
+XMLPUBFUN xmlChar * XMLCALL
+ xmlXPathCastToString (xmlXPathObjectPtr val);
+
+XMLPUBFUN xmlXPathObjectPtr XMLCALL
+ xmlXPathConvertBoolean (xmlXPathObjectPtr val);
+XMLPUBFUN xmlXPathObjectPtr XMLCALL
+ xmlXPathConvertNumber (xmlXPathObjectPtr val);
+XMLPUBFUN xmlXPathObjectPtr XMLCALL
+ xmlXPathConvertString (xmlXPathObjectPtr val);
+
+/**
+ * Context handling.
+ */
+XMLPUBFUN xmlXPathContextPtr XMLCALL
+ xmlXPathNewContext (xmlDocPtr doc);
+XMLPUBFUN void XMLCALL
+ xmlXPathFreeContext (xmlXPathContextPtr ctxt);
+
+/**
+ * Evaluation functions.
+ */
+XMLPUBFUN long XMLCALL
+ xmlXPathOrderDocElems (xmlDocPtr doc);
+XMLPUBFUN xmlXPathObjectPtr XMLCALL
+ xmlXPathEval (const xmlChar *str,
+ xmlXPathContextPtr ctx);
+XMLPUBFUN xmlXPathObjectPtr XMLCALL
+ xmlXPathEvalExpression (const xmlChar *str,
+ xmlXPathContextPtr ctxt);
+XMLPUBFUN int XMLCALL
+ xmlXPathEvalPredicate (xmlXPathContextPtr ctxt,
+ xmlXPathObjectPtr res);
+/**
+ * Separate compilation/evaluation entry points.
+ */
+XMLPUBFUN xmlXPathCompExprPtr XMLCALL
+ xmlXPathCompile (const xmlChar *str);
+XMLPUBFUN xmlXPathCompExprPtr XMLCALL
+ xmlXPathCtxtCompile (xmlXPathContextPtr ctxt,
+ const xmlChar *str);
+XMLPUBFUN xmlXPathObjectPtr XMLCALL
+ xmlXPathCompiledEval (xmlXPathCompExprPtr comp,
+ xmlXPathContextPtr ctx);
+XMLPUBFUN void XMLCALL
+ xmlXPathFreeCompExpr (xmlXPathCompExprPtr comp);
+#endif /* LIBXML_XPATH_ENABLED */
+#if defined(LIBXML_XPATH_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)
+XMLPUBFUN void XMLCALL
+ xmlXPathInit (void);
+XMLPUBFUN int XMLCALL
+ xmlXPathIsNaN (double val);
+XMLPUBFUN int XMLCALL
+ xmlXPathIsInf (double val);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* LIBXML_XPATH_ENABLED or LIBXML_SCHEMAS_ENABLED*/
+#endif /* ! __XML_XPATH_H__ */
projects / reactos.git / blobdiff