Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 1 | /* |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 2 | * Summary: XML Path Language implementation |
| 3 | * Description: API for the XML Path Language implementation |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 4 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 5 | * XML Path Language implementation |
| 6 | * XPath is a language for addressing parts of an XML document, |
| 7 | * designed to be used by both XSLT and XPointer |
| 8 | * http://www.w3.org/TR/xpath |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 9 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 10 | * Implements |
| 11 | * W3C Recommendation 16 November 1999 |
| 12 | * http://www.w3.org/TR/1999/REC-xpath-19991116 |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 13 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 14 | * Copy: See Copyright for the status of this software. |
| 15 | * |
| 16 | * Author: Daniel Veillard |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 17 | */ |
| 18 | |
| 19 | #ifndef __XML_XPATH_H__ |
| 20 | #define __XML_XPATH_H__ |
| 21 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 22 | #include <libxml/xmlversion.h> |
Daniel Veillard | d96f6d3 | 2003-10-07 21:25:12 +0000 | [diff] [blame] | 23 | #include <libxml/xmlerror.h> |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 24 | #include <libxml/tree.h> |
| 25 | #include <libxml/hash.h> |
| 26 | |
| 27 | #ifdef __cplusplus |
| 28 | extern "C" { |
| 29 | #endif |
| 30 | |
| 31 | typedef struct _xmlXPathContext xmlXPathContext; |
| 32 | typedef xmlXPathContext *xmlXPathContextPtr; |
| 33 | typedef struct _xmlXPathParserContext xmlXPathParserContext; |
| 34 | typedef xmlXPathParserContext *xmlXPathParserContextPtr; |
| 35 | |
| 36 | /** |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 37 | * The set of XPath error codes. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 38 | */ |
| 39 | |
| 40 | typedef enum { |
| 41 | XPATH_EXPRESSION_OK = 0, |
| 42 | XPATH_NUMBER_ERROR, |
| 43 | XPATH_UNFINISHED_LITERAL_ERROR, |
| 44 | XPATH_START_LITERAL_ERROR, |
| 45 | XPATH_VARIABLE_REF_ERROR, |
| 46 | XPATH_UNDEF_VARIABLE_ERROR, |
| 47 | XPATH_INVALID_PREDICATE_ERROR, |
| 48 | XPATH_EXPR_ERROR, |
| 49 | XPATH_UNCLOSED_ERROR, |
| 50 | XPATH_UNKNOWN_FUNC_ERROR, |
| 51 | XPATH_INVALID_OPERAND, |
| 52 | XPATH_INVALID_TYPE, |
| 53 | XPATH_INVALID_ARITY, |
| 54 | XPATH_INVALID_CTXT_SIZE, |
| 55 | XPATH_INVALID_CTXT_POSITION, |
| 56 | XPATH_MEMORY_ERROR, |
| 57 | XPTR_SYNTAX_ERROR, |
| 58 | XPTR_RESOURCE_ERROR, |
| 59 | XPTR_SUB_RESOURCE_ERROR, |
Daniel Veillard | 61d80a2 | 2001-04-27 17:13:01 +0000 | [diff] [blame] | 60 | XPATH_UNDEF_PREFIX_ERROR, |
| 61 | XPATH_ENCODING_ERROR, |
| 62 | XPATH_INVALID_CHAR_ERROR |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 63 | } xmlXPathError; |
| 64 | |
| 65 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 66 | * A node-set (an unordered collection of nodes without duplicates). |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 67 | */ |
| 68 | typedef struct _xmlNodeSet xmlNodeSet; |
| 69 | typedef xmlNodeSet *xmlNodeSetPtr; |
| 70 | struct _xmlNodeSet { |
| 71 | int nodeNr; /* number of nodes in the set */ |
| 72 | int nodeMax; /* size of the array as allocated */ |
| 73 | xmlNodePtr *nodeTab; /* array of nodes in no particular order */ |
Daniel Veillard | 044fc6b | 2002-03-04 17:09:44 +0000 | [diff] [blame] | 74 | /* @@ with_ns to check wether namespace nodes should be looked at @@ */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 75 | }; |
| 76 | |
| 77 | /* |
| 78 | * An expression is evaluated to yield an object, which |
| 79 | * has one of the following four basic types: |
| 80 | * - node-set |
| 81 | * - boolean |
| 82 | * - number |
| 83 | * - string |
| 84 | * |
| 85 | * @@ XPointer will add more types ! |
| 86 | */ |
| 87 | |
| 88 | typedef enum { |
| 89 | XPATH_UNDEFINED = 0, |
| 90 | XPATH_NODESET = 1, |
| 91 | XPATH_BOOLEAN = 2, |
| 92 | XPATH_NUMBER = 3, |
| 93 | XPATH_STRING = 4, |
| 94 | XPATH_POINT = 5, |
| 95 | XPATH_RANGE = 6, |
| 96 | XPATH_LOCATIONSET = 7, |
| 97 | XPATH_USERS = 8, |
| 98 | XPATH_XSLT_TREE = 9 /* An XSLT value tree, non modifiable */ |
| 99 | } xmlXPathObjectType; |
| 100 | |
| 101 | typedef struct _xmlXPathObject xmlXPathObject; |
| 102 | typedef xmlXPathObject *xmlXPathObjectPtr; |
| 103 | struct _xmlXPathObject { |
| 104 | xmlXPathObjectType type; |
| 105 | xmlNodeSetPtr nodesetval; |
| 106 | int boolval; |
| 107 | double floatval; |
| 108 | xmlChar *stringval; |
| 109 | void *user; |
| 110 | int index; |
| 111 | void *user2; |
| 112 | int index2; |
| 113 | }; |
| 114 | |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 115 | /** |
| 116 | * xmlXPathConvertFunc: |
| 117 | * @obj: an XPath object |
| 118 | * @type: the number of the target type |
| 119 | * |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 120 | * A conversion function is associated to a type and used to cast |
| 121 | * the new type to primitive values. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 122 | * |
| 123 | * Returns -1 in case of error, 0 otherwise |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 124 | */ |
| 125 | typedef int (*xmlXPathConvertFunc) (xmlXPathObjectPtr obj, int type); |
| 126 | |
| 127 | /* |
| 128 | * Extra type: a name and a conversion function. |
| 129 | */ |
| 130 | |
| 131 | typedef struct _xmlXPathType xmlXPathType; |
| 132 | typedef xmlXPathType *xmlXPathTypePtr; |
| 133 | struct _xmlXPathType { |
| 134 | const xmlChar *name; /* the type name */ |
| 135 | xmlXPathConvertFunc func; /* the conversion function */ |
| 136 | }; |
| 137 | |
| 138 | /* |
| 139 | * Extra variable: a name and a value. |
| 140 | */ |
| 141 | |
| 142 | typedef struct _xmlXPathVariable xmlXPathVariable; |
| 143 | typedef xmlXPathVariable *xmlXPathVariablePtr; |
| 144 | struct _xmlXPathVariable { |
| 145 | const xmlChar *name; /* the variable name */ |
| 146 | xmlXPathObjectPtr value; /* the value */ |
| 147 | }; |
| 148 | |
Daniel Veillard | 5168dbf | 2001-07-07 00:18:23 +0000 | [diff] [blame] | 149 | /** |
| 150 | * xmlXPathEvalFunc: |
| 151 | * @ctxt: an XPath parser context |
| 152 | * @nargs: the number of arguments passed to the function |
| 153 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 154 | * An XPath evaluation function, the parameters are on the XPath context stack. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 155 | */ |
| 156 | |
Daniel Veillard | 5168dbf | 2001-07-07 00:18:23 +0000 | [diff] [blame] | 157 | typedef void (*xmlXPathEvalFunc)(xmlXPathParserContextPtr ctxt, |
| 158 | int nargs); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 159 | |
| 160 | /* |
| 161 | * Extra function: a name and a evaluation function. |
| 162 | */ |
| 163 | |
| 164 | typedef struct _xmlXPathFunct xmlXPathFunct; |
| 165 | typedef xmlXPathFunct *xmlXPathFuncPtr; |
| 166 | struct _xmlXPathFunct { |
| 167 | const xmlChar *name; /* the function name */ |
| 168 | xmlXPathEvalFunc func; /* the evaluation function */ |
| 169 | }; |
| 170 | |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 171 | /** |
| 172 | * xmlXPathAxisFunc: |
| 173 | * @ctxt: the XPath interpreter context |
| 174 | * @cur: the previous node being explored on that axis |
| 175 | * |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 176 | * An axis traversal function. To traverse an axis, the engine calls |
| 177 | * the first time with cur == NULL and repeat until the function returns |
| 178 | * NULL indicating the end of the axis traversal. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 179 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 180 | * Returns the next node in that axis or NULL if at the end of the axis. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 181 | */ |
| 182 | |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 183 | typedef xmlXPathObjectPtr (*xmlXPathAxisFunc) (xmlXPathParserContextPtr ctxt, |
| 184 | xmlXPathObjectPtr cur); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 185 | |
| 186 | /* |
| 187 | * Extra axis: a name and an axis function. |
| 188 | */ |
| 189 | |
| 190 | typedef struct _xmlXPathAxis xmlXPathAxis; |
| 191 | typedef xmlXPathAxis *xmlXPathAxisPtr; |
| 192 | struct _xmlXPathAxis { |
| 193 | const xmlChar *name; /* the axis name */ |
| 194 | xmlXPathAxisFunc func; /* the search function */ |
| 195 | }; |
| 196 | |
Daniel Veillard | bed7b05 | 2001-05-19 14:59:49 +0000 | [diff] [blame] | 197 | /** |
| 198 | * xmlXPathContext: |
| 199 | * |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 200 | * Expression evaluation occurs with respect to a context. |
| 201 | * he context consists of: |
| 202 | * - a node (the context node) |
| 203 | * - a node list (the context node list) |
| 204 | * - a set of variable bindings |
| 205 | * - a function library |
| 206 | * - the set of namespace declarations in scope for the expression |
| 207 | * Following the switch to hash tables, this need to be trimmed up at |
| 208 | * the next binary incompatible release. |
| 209 | */ |
| 210 | |
| 211 | struct _xmlXPathContext { |
| 212 | xmlDocPtr doc; /* The current document */ |
| 213 | xmlNodePtr node; /* The current node */ |
| 214 | |
| 215 | int nb_variables_unused; /* unused (hash table) */ |
| 216 | int max_variables_unused; /* unused (hash table) */ |
| 217 | xmlHashTablePtr varHash; /* Hash table of defined variables */ |
| 218 | |
| 219 | int nb_types; /* number of defined types */ |
| 220 | int max_types; /* max number of types */ |
| 221 | xmlXPathTypePtr types; /* Array of defined types */ |
| 222 | |
| 223 | int nb_funcs_unused; /* unused (hash table) */ |
| 224 | int max_funcs_unused; /* unused (hash table) */ |
| 225 | xmlHashTablePtr funcHash; /* Hash table of defined funcs */ |
| 226 | |
| 227 | int nb_axis; /* number of defined axis */ |
| 228 | int max_axis; /* max number of axis */ |
| 229 | xmlXPathAxisPtr axis; /* Array of defined axis */ |
| 230 | |
| 231 | /* the namespace nodes of the context node */ |
| 232 | xmlNsPtr *namespaces; /* Array of namespaces */ |
| 233 | int nsNr; /* number of namespace in scope */ |
| 234 | void *user; /* function to free */ |
| 235 | |
| 236 | /* extra variables */ |
| 237 | int contextSize; /* the context size */ |
| 238 | int proximityPosition; /* the proximity position */ |
| 239 | |
| 240 | /* extra stuff for XPointer */ |
| 241 | int xptr; /* it this an XPointer context */ |
| 242 | xmlNodePtr here; /* for here() */ |
| 243 | xmlNodePtr origin; /* for origin() */ |
| 244 | |
| 245 | /* the set of namespace declarations in scope for the expression */ |
| 246 | xmlHashTablePtr nsHash; /* The namespaces hash table */ |
| 247 | void *varLookupFunc; /* variable lookup func */ |
| 248 | void *varLookupData; /* variable lookup data */ |
| 249 | |
| 250 | /* Possibility to link in an extra item */ |
| 251 | void *extra; /* needed for XSLT */ |
Daniel Veillard | 42596ad | 2001-05-22 16:57:14 +0000 | [diff] [blame] | 252 | |
| 253 | /* The function name and URI when calling a function */ |
| 254 | const xmlChar *function; |
| 255 | const xmlChar *functionURI; |
Thomas Broyer | ba4ad32 | 2001-07-26 16:55:21 +0000 | [diff] [blame] | 256 | |
| 257 | /* function lookup function and data */ |
| 258 | void *funcLookupFunc; /* function lookup func */ |
| 259 | void *funcLookupData; /* function lookup data */ |
Daniel Veillard | 7d7e379 | 2001-07-30 13:42:13 +0000 | [diff] [blame] | 260 | |
| 261 | /* temporary namespace lists kept for walking the namespace axis */ |
| 262 | xmlNsPtr *tmpNsList; /* Array of namespaces */ |
| 263 | int tmpNsNr; /* number of namespace in scope */ |
Daniel Veillard | d96f6d3 | 2003-10-07 21:25:12 +0000 | [diff] [blame] | 264 | |
| 265 | /* error reporting mechanism */ |
| 266 | void *userData; /* user specific data block */ |
| 267 | xmlStructuredErrorFunc error; /* the callback in case of errors */ |
| 268 | xmlError lastError; /* the last error */ |
| 269 | xmlNodePtr debugNode; /* the source node XSLT */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 270 | }; |
| 271 | |
| 272 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 273 | * The structure of a compiled expression form is not public. |
Daniel Veillard | 9e7160d | 2001-03-18 23:17:47 +0000 | [diff] [blame] | 274 | */ |
| 275 | |
| 276 | typedef struct _xmlXPathCompExpr xmlXPathCompExpr; |
| 277 | typedef xmlXPathCompExpr *xmlXPathCompExprPtr; |
| 278 | |
Daniel Veillard | bed7b05 | 2001-05-19 14:59:49 +0000 | [diff] [blame] | 279 | /** |
| 280 | * xmlXPathParserContext: |
| 281 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 282 | * An XPath parser context. It contains pure parsing informations, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 283 | * an xmlXPathContext, and the stack of objects. |
| 284 | */ |
| 285 | struct _xmlXPathParserContext { |
| 286 | const xmlChar *cur; /* the current char being parsed */ |
| 287 | const xmlChar *base; /* the full expression */ |
| 288 | |
| 289 | int error; /* error code */ |
| 290 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 291 | xmlXPathContextPtr context; /* the evaluation context */ |
| 292 | xmlXPathObjectPtr value; /* the current value */ |
| 293 | int valueNr; /* number of values stacked */ |
| 294 | int valueMax; /* max number of values stacked */ |
| 295 | xmlXPathObjectPtr *valueTab; /* stack of values */ |
Daniel Veillard | d007d6c | 2001-03-19 00:01:07 +0000 | [diff] [blame] | 296 | |
| 297 | xmlXPathCompExprPtr comp; /* the precompiled expression */ |
Daniel Veillard | fbf8a2d | 2001-03-19 15:58:54 +0000 | [diff] [blame] | 298 | int xptr; /* it this an XPointer expression */ |
Daniel Veillard | f06307e | 2001-07-03 10:35:50 +0000 | [diff] [blame] | 299 | xmlNodePtr ancestor; /* used for walking preceding axis */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 300 | }; |
| 301 | |
Daniel Veillard | bed7b05 | 2001-05-19 14:59:49 +0000 | [diff] [blame] | 302 | /** |
| 303 | * xmlXPathFunction: |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 304 | * @ctxt: the XPath interprestation context |
| 305 | * @nargs: the number of arguments |
Daniel Veillard | bed7b05 | 2001-05-19 14:59:49 +0000 | [diff] [blame] | 306 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 307 | * An XPath function. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 308 | * The arguments (if any) are popped out from the context stack |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 309 | * and the result is pushed on the stack. |
| 310 | */ |
| 311 | |
| 312 | typedef void (*xmlXPathFunction) (xmlXPathParserContextPtr ctxt, int nargs); |
| 313 | |
| 314 | /************************************************************************ |
| 315 | * * |
| 316 | * Public API * |
| 317 | * * |
| 318 | ************************************************************************/ |
| 319 | |
| 320 | /** |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 321 | * Objects and Nodesets handling |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 322 | */ |
Daniel Veillard | 790142b | 2001-05-15 10:51:53 +0000 | [diff] [blame] | 323 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 324 | XMLPUBVAR double xmlXPathNAN; |
| 325 | XMLPUBVAR double xmlXPathPINF; |
| 326 | XMLPUBVAR double xmlXPathNINF; |
Thomas Broyer | 496be68 | 2001-07-15 22:59:18 +0000 | [diff] [blame] | 327 | |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 328 | XMLPUBFUN int XMLCALL |
| 329 | xmlXPathIsNaN (double val); |
| 330 | XMLPUBFUN int XMLCALL |
| 331 | xmlXPathIsInf (double val); |
Daniel Veillard | cda9692 | 2001-08-21 10:56:31 +0000 | [diff] [blame] | 332 | |
Daniel Veillard | 790142b | 2001-05-15 10:51:53 +0000 | [diff] [blame] | 333 | /* These macros may later turn into functions */ |
Thomas Broyer | f06a3d8 | 2001-07-16 04:52:57 +0000 | [diff] [blame] | 334 | /** |
| 335 | * xmlXPathNodeSetGetLength: |
| 336 | * @ns: a node-set |
| 337 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 338 | * Implement a functionality similar to the DOM NodeList.length. |
Thomas Broyer | f06a3d8 | 2001-07-16 04:52:57 +0000 | [diff] [blame] | 339 | * |
| 340 | * Returns the number of nodes in the node-set. |
| 341 | */ |
Daniel Veillard | 790142b | 2001-05-15 10:51:53 +0000 | [diff] [blame] | 342 | #define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0) |
Thomas Broyer | f06a3d8 | 2001-07-16 04:52:57 +0000 | [diff] [blame] | 343 | /** |
| 344 | * xmlXPathNodeSetItem: |
| 345 | * @ns: a node-set |
| 346 | * @index: index of a node in the set |
| 347 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 348 | * Implements a functionality similar to the DOM NodeList.item(). |
Thomas Broyer | f06a3d8 | 2001-07-16 04:52:57 +0000 | [diff] [blame] | 349 | * |
| 350 | * Returns the xmlNodePtr at the given @index in @ns or NULL if |
| 351 | * @index is out of range (0 to length-1) |
| 352 | */ |
Daniel Veillard | 790142b | 2001-05-15 10:51:53 +0000 | [diff] [blame] | 353 | #define xmlXPathNodeSetItem(ns, index) \ |
| 354 | ((((ns) != NULL) && \ |
Thomas Broyer | 496be68 | 2001-07-15 22:59:18 +0000 | [diff] [blame] | 355 | ((index) >= 0) && ((index) < (ns)->nodeNr)) ? \ |
Daniel Veillard | 790142b | 2001-05-15 10:51:53 +0000 | [diff] [blame] | 356 | (ns)->nodeTab[(index)] \ |
| 357 | : NULL) |
Thomas Broyer | f06a3d8 | 2001-07-16 04:52:57 +0000 | [diff] [blame] | 358 | /** |
| 359 | * xmlXPathNodeSetIsEmpty: |
| 360 | * @ns: a node-set |
| 361 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 362 | * Checks whether @ns is empty or not. |
Thomas Broyer | f06a3d8 | 2001-07-16 04:52:57 +0000 | [diff] [blame] | 363 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 364 | * Returns %TRUE if @ns is an empty node-set. |
Thomas Broyer | f06a3d8 | 2001-07-16 04:52:57 +0000 | [diff] [blame] | 365 | */ |
| 366 | #define xmlXPathNodeSetIsEmpty(ns) \ |
| 367 | (((ns) == NULL) || ((ns)->nodeNr == 0) || ((ns)->nodeTab == NULL)) |
Daniel Veillard | 790142b | 2001-05-15 10:51:53 +0000 | [diff] [blame] | 368 | |
| 369 | |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 370 | XMLPUBFUN void XMLCALL |
| 371 | xmlXPathFreeObject (xmlXPathObjectPtr obj); |
| 372 | XMLPUBFUN xmlNodeSetPtr XMLCALL |
| 373 | xmlXPathNodeSetCreate (xmlNodePtr val); |
| 374 | XMLPUBFUN void XMLCALL |
| 375 | xmlXPathFreeNodeSetList (xmlXPathObjectPtr obj); |
| 376 | XMLPUBFUN void XMLCALL |
| 377 | xmlXPathFreeNodeSet (xmlNodeSetPtr obj); |
| 378 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 379 | xmlXPathObjectCopy (xmlXPathObjectPtr val); |
| 380 | XMLPUBFUN int XMLCALL |
| 381 | xmlXPathCmpNodes (xmlNodePtr node1, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 382 | xmlNodePtr node2); |
Daniel Veillard | fbf8a2d | 2001-03-19 15:58:54 +0000 | [diff] [blame] | 383 | /** |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 384 | * Conversion functions to basic types. |
Daniel Veillard | fbf8a2d | 2001-03-19 15:58:54 +0000 | [diff] [blame] | 385 | */ |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 386 | XMLPUBFUN int XMLCALL |
| 387 | xmlXPathCastNumberToBoolean (double val); |
| 388 | XMLPUBFUN int XMLCALL |
| 389 | xmlXPathCastStringToBoolean (const xmlChar * val); |
| 390 | XMLPUBFUN int XMLCALL |
| 391 | xmlXPathCastNodeSetToBoolean(xmlNodeSetPtr ns); |
| 392 | XMLPUBFUN int XMLCALL |
| 393 | xmlXPathCastToBoolean (xmlXPathObjectPtr val); |
Daniel Veillard | ba0b8c9 | 2001-05-15 09:43:47 +0000 | [diff] [blame] | 394 | |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 395 | XMLPUBFUN double XMLCALL |
| 396 | xmlXPathCastBooleanToNumber (int val); |
| 397 | XMLPUBFUN double XMLCALL |
| 398 | xmlXPathCastStringToNumber (const xmlChar * val); |
| 399 | XMLPUBFUN double XMLCALL |
| 400 | xmlXPathCastNodeToNumber (xmlNodePtr node); |
| 401 | XMLPUBFUN double XMLCALL |
| 402 | xmlXPathCastNodeSetToNumber (xmlNodeSetPtr ns); |
| 403 | XMLPUBFUN double XMLCALL |
| 404 | xmlXPathCastToNumber (xmlXPathObjectPtr val); |
Daniel Veillard | ba0b8c9 | 2001-05-15 09:43:47 +0000 | [diff] [blame] | 405 | |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 406 | XMLPUBFUN xmlChar * XMLCALL |
| 407 | xmlXPathCastBooleanToString (int val); |
| 408 | XMLPUBFUN xmlChar * XMLCALL |
| 409 | xmlXPathCastNumberToString (double val); |
| 410 | XMLPUBFUN xmlChar * XMLCALL |
| 411 | xmlXPathCastNodeToString (xmlNodePtr node); |
| 412 | XMLPUBFUN xmlChar * XMLCALL |
| 413 | xmlXPathCastNodeSetToString (xmlNodeSetPtr ns); |
| 414 | XMLPUBFUN xmlChar * XMLCALL |
| 415 | xmlXPathCastToString (xmlXPathObjectPtr val); |
Daniel Veillard | ba0b8c9 | 2001-05-15 09:43:47 +0000 | [diff] [blame] | 416 | |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 417 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 418 | xmlXPathConvertBoolean (xmlXPathObjectPtr val); |
| 419 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 420 | xmlXPathConvertNumber (xmlXPathObjectPtr val); |
| 421 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 422 | xmlXPathConvertString (xmlXPathObjectPtr val); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 423 | |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 424 | /** |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 425 | * Context handling. |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 426 | */ |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 427 | XMLPUBFUN void XMLCALL |
| 428 | xmlXPathInit (void); |
| 429 | XMLPUBFUN xmlXPathContextPtr XMLCALL |
| 430 | xmlXPathNewContext (xmlDocPtr doc); |
| 431 | XMLPUBFUN void XMLCALL |
| 432 | xmlXPathFreeContext (xmlXPathContextPtr ctxt); |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 433 | |
| 434 | /** |
| 435 | * Evaluation functions. |
| 436 | */ |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 437 | XMLPUBFUN long XMLCALL |
| 438 | xmlXPathOrderDocElems (xmlDocPtr doc); |
| 439 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 440 | xmlXPathEval (const xmlChar *str, |
Daniel Veillard | cbaf399 | 2001-12-31 16:16:02 +0000 | [diff] [blame] | 441 | xmlXPathContextPtr ctx); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 442 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 443 | xmlXPathEvalExpression (const xmlChar *str, |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 444 | xmlXPathContextPtr ctxt); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 445 | XMLPUBFUN int XMLCALL |
| 446 | xmlXPathEvalPredicate (xmlXPathContextPtr ctxt, |
Daniel Veillard | fbf8a2d | 2001-03-19 15:58:54 +0000 | [diff] [blame] | 447 | xmlXPathObjectPtr res); |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 448 | /** |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 449 | * Separate compilation/evaluation entry points. |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 450 | */ |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 451 | XMLPUBFUN xmlXPathCompExprPtr XMLCALL |
| 452 | xmlXPathCompile (const xmlChar *str); |
| 453 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 454 | xmlXPathCompiledEval (xmlXPathCompExprPtr comp, |
Daniel Veillard | afcbe1c | 2001-03-19 10:57:13 +0000 | [diff] [blame] | 455 | xmlXPathContextPtr ctx); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 456 | XMLPUBFUN void XMLCALL |
| 457 | xmlXPathFreeCompExpr (xmlXPathCompExprPtr comp); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 458 | #ifdef __cplusplus |
| 459 | } |
| 460 | #endif |
| 461 | #endif /* ! __XML_XPATH_H__ */ |