xpath.h 12.1 KB
Newer Older
1 2 3 4 5 6 7 8
/*
 * xpath.c: interface for XML Path Language implementation
 *
 * Reference: W3C Working Draft 5 July 1999
 *            http://www.w3.org/Style/XSL/Group/1999/07/xpath-19990705.html
 *
 * See COPYRIGHT for the status of this software
 *
9
 * Author: daniel@veillard.com
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 */

#ifndef __XML_XPATH_H__
#define __XML_XPATH_H__

#include <libxml/tree.h>
#include <libxml/hash.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _xmlXPathContext xmlXPathContext;
typedef xmlXPathContext *xmlXPathContextPtr;
typedef struct _xmlXPathParserContext xmlXPathParserContext;
typedef xmlXPathParserContext *xmlXPathParserContextPtr;

/**
28
 * The set of XPath error codes.
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
 */

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,
51 52 53
    XPATH_UNDEF_PREFIX_ERROR,
    XPATH_ENCODING_ERROR,
    XPATH_INVALID_CHAR_ERROR
54 55 56
} xmlXPathError;

/*
57
 * A node-set (an unordered collection of nodes without duplicates).
58 59 60 61 62 63 64
 */
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 */
65
    /* @@ with_ns to check wether namespace nodes should be looked at @@ */
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
};

/*
 * 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;
};

106 107 108 109 110
/**
 * xmlXPathConvertFunc:
 * @obj:  an XPath object
 * @type:  the number of the target type
 *
111 112
 * A conversion function is associated to a type and used to cast
 * the new type to primitive values.
113 114
 *
 * Returns -1 in case of error, 0 otherwise
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
 */
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 */
};

Daniel Veillard's avatar
Daniel Veillard committed
140 141 142 143 144
/**
 * xmlXPathEvalFunc:
 * @ctxt: an XPath parser context
 * @nargs: the number of arguments passed to the function
 *
145
 * An XPath evaluation function, the parameters are on the XPath context stack.
146 147
 */

Daniel Veillard's avatar
Daniel Veillard committed
148 149
typedef void (*xmlXPathEvalFunc)(xmlXPathParserContextPtr ctxt,
	                         int nargs);
150 151 152 153 154 155 156 157 158 159 160 161

/*
 * 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 */
};

162 163 164 165 166
/**
 * xmlXPathAxisFunc:
 * @ctxt:  the XPath interpreter context
 * @cur:  the previous node being explored on that axis
 *
167 168 169
 * 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.
170
 *
171
 * Returns the next node in that axis or NULL if at the end of the axis.
172 173
 */

174 175
typedef xmlXPathObjectPtr (*xmlXPathAxisFunc) (xmlXPathParserContextPtr ctxt,
				 xmlXPathObjectPtr cur);
176 177 178 179 180 181 182 183 184 185 186 187

/*
 * 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 */
};

188 189 190
/**
 * xmlXPathContext:
 *
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
 * 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 */
    void *varLookupFunc;		/* variable lookup func */
    void *varLookupData;		/* variable lookup data */

    /* Possibility to link in an extra item */
    void *extra;                        /* needed for XSLT */
243 244 245 246

    /* The function name and URI when calling a function */
    const xmlChar *function;
    const xmlChar *functionURI;
247 248 249 250

    /* function lookup function and data */
    void *funcLookupFunc;		/* function lookup func */
    void *funcLookupData;		/* function lookup data */
251 252 253 254

    /* temporary namespace lists kept for walking the namespace axis */
    xmlNsPtr *tmpNsList;		/* Array of namespaces */
    int tmpNsNr;			/* number of namespace in scope */
255 256
};

257
/*
258
 * The structure of a compiled expression form is not public.
259 260 261 262 263
 */

typedef struct _xmlXPathCompExpr xmlXPathCompExpr;
typedef xmlXPathCompExpr *xmlXPathCompExprPtr;

264 265 266
/**
 * xmlXPathParserContext:
 *
267
 * An XPath parser context. It contains pure parsing informations,
268 269 270 271 272 273 274 275 276 277 278 279 280
 * 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 */
281 282

    xmlXPathCompExprPtr comp;		/* the precompiled expression */
283
    int xptr;				/* it this an XPointer expression */
284
    xmlNodePtr         ancestor;	/* used for walking preceding axis */
285 286
};

287 288
/**
 * xmlXPathFunction:
289 290
 * @ctxt:  the XPath interprestation context
 * @nargs:  the number of arguments
291
 *
292
 * An XPath function.
293
 * The arguments (if any) are popped out from the context stack
294 295 296 297 298 299 300 301 302 303 304 305
 * and the result is pushed on the stack.
 */

typedef void (*xmlXPathFunction) (xmlXPathParserContextPtr ctxt, int nargs);

/************************************************************************
 *									*
 *			Public API					*
 *									*
 ************************************************************************/

/**
306 307
 * Objects and Nodesets handling
 */
308

309 310 311 312
LIBXML_DLL_IMPORT extern double xmlXPathNAN;
LIBXML_DLL_IMPORT extern double xmlXPathPINF;
LIBXML_DLL_IMPORT extern double xmlXPathNINF;

313 314 315
int		xmlXPathIsNaN	(double val);
int		xmlXPathIsInf	(double val);

316
/* These macros may later turn into functions */
317 318 319 320
/**
 * xmlXPathNodeSetGetLength:
 * @ns:  a node-set
 *
321
 * Implement a functionality similar to the DOM NodeList.length.
322 323 324
 *
 * Returns the number of nodes in the node-set.
 */
325
#define xmlXPathNodeSetGetLength(ns) ((ns) ? (ns)->nodeNr : 0)
326 327 328 329 330
/**
 * xmlXPathNodeSetItem:
 * @ns:  a node-set
 * @index:  index of a node in the set
 *
331
 * Implements a functionality similar to the DOM NodeList.item().
332 333 334 335
 *
 * Returns the xmlNodePtr at the given @index in @ns or NULL if
 *         @index is out of range (0 to length-1)
 */
336 337
#define xmlXPathNodeSetItem(ns, index)				\
		((((ns) != NULL) && 				\
338
		  ((index) >= 0) && ((index) < (ns)->nodeNr)) ?	\
339 340
		 (ns)->nodeTab[(index)]				\
		 : NULL)
341 342 343 344
/**
 * xmlXPathNodeSetIsEmpty:
 * @ns: a node-set
 *
345
 * Checks whether @ns is empty or not.
346
 *
347
 * Returns %TRUE if @ns is an empty node-set.
348 349 350
 */
#define xmlXPathNodeSetIsEmpty(ns)                                      \
    (((ns) == NULL) || ((ns)->nodeNr == 0) || ((ns)->nodeTab == NULL))
351 352


353 354 355 356 357 358 359
void		   xmlXPathFreeObject		(xmlXPathObjectPtr obj);
xmlNodeSetPtr	   xmlXPathNodeSetCreate	(xmlNodePtr val);
void		   xmlXPathFreeNodeSetList	(xmlXPathObjectPtr obj);
void		   xmlXPathFreeNodeSet		(xmlNodeSetPtr obj);
xmlXPathObjectPtr  xmlXPathObjectCopy		(xmlXPathObjectPtr val);
int		   xmlXPathCmpNodes		(xmlNodePtr node1,
						 xmlNodePtr node2);
360
/**
361
 * Conversion functions to basic types.
362
 */
363 364
int		   xmlXPathCastNumberToBoolean	(double val);
int		   xmlXPathCastStringToBoolean	(const xmlChar * val);
365
int		   xmlXPathCastNodeSetToBoolean	(xmlNodeSetPtr ns);
366 367 368 369 370 371 372 373 374 375 376 377 378 379
int		   xmlXPathCastToBoolean	(xmlXPathObjectPtr val);

double		   xmlXPathCastBooleanToNumber	(int val);
double		   xmlXPathCastStringToNumber	(const xmlChar * val);
double		   xmlXPathCastNodeToNumber	(xmlNodePtr node);
double		   xmlXPathCastNodeSetToNumber	(xmlNodeSetPtr ns);
double		   xmlXPathCastToNumber		(xmlXPathObjectPtr val);

xmlChar *	   xmlXPathCastBooleanToString	(int val);
xmlChar *	   xmlXPathCastNumberToString	(double val);
xmlChar *	   xmlXPathCastNodeToString	(xmlNodePtr node);
xmlChar *	   xmlXPathCastNodeSetToString	(xmlNodeSetPtr ns);
xmlChar *	   xmlXPathCastToString		(xmlXPathObjectPtr val);

380 381 382
xmlXPathObjectPtr  xmlXPathConvertBoolean	(xmlXPathObjectPtr val);
xmlXPathObjectPtr  xmlXPathConvertNumber	(xmlXPathObjectPtr val);
xmlXPathObjectPtr  xmlXPathConvertString	(xmlXPathObjectPtr val);
383 384

/**
385
 * Context handling.
386 387 388 389
 */
void		   xmlXPathInit			(void);
xmlXPathContextPtr xmlXPathNewContext		(xmlDocPtr doc);
void		   xmlXPathFreeContext		(xmlXPathContextPtr ctxt);
390 391 392 393

/**
 * Evaluation functions.
 */
394
xmlXPathObjectPtr  xmlXPathEval			(const xmlChar *str,
395
						 xmlXPathContextPtr ctx);
396 397
xmlXPathObjectPtr  xmlXPathEvalExpression	(const xmlChar *str,
						 xmlXPathContextPtr ctxt);
398 399
int                xmlXPathEvalPredicate	(xmlXPathContextPtr ctxt,
						 xmlXPathObjectPtr res);
400
/**
401
 * Separate compilation/evaluation entry points.
402 403 404 405
 */
xmlXPathCompExprPtr xmlXPathCompile		(const xmlChar *str);
xmlXPathObjectPtr   xmlXPathCompiledEval	(xmlXPathCompExprPtr comp,
						 xmlXPathContextPtr ctx);
406
void                xmlXPathFreeCompExpr	(xmlXPathCompExprPtr comp);
407 408 409 410
#ifdef __cplusplus
}
#endif
#endif /* ! __XML_XPATH_H__ */