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