| Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 1 | /* |
| 2 | * xpath.c: internal interfaces for XML Path Language implementation |
| 3 | * used to build new modules on top of XPath |
| 4 | * |
| 5 | * See COPYRIGHT for the status of this software |
| 6 | * |
| 7 | * Author: Daniel.Veillard@w3.org |
| 8 | */ |
| 9 | |
| 10 | #ifndef __XML_XPATH_INTERNALS_H__ |
| 11 | #define __XML_XPATH_INTERNALS_H__ |
| 12 | |
| 13 | #include <libxml/xpath.h> |
| 14 | |
| 15 | #ifdef __cplusplus |
| 16 | extern "C" { |
| 17 | #endif |
| 18 | |
| 19 | /************************************************************************ |
| 20 | * * |
| 21 | * Helpers * |
| 22 | * * |
| 23 | ************************************************************************/ |
| 24 | |
| 25 | #define CHECK_ERROR \ |
| 26 | if (ctxt->error != XPATH_EXPRESSION_OK) return |
| 27 | |
| 28 | #define CHECK_ERROR0 \ |
| 29 | if (ctxt->error != XPATH_EXPRESSION_OK) return(0) |
| 30 | |
| 31 | #define XP_ERROR(X) \ |
| 32 | { xmlXPatherror(ctxt, __FILE__, __LINE__, X); \ |
| 33 | ctxt->error = (X); return; } |
| 34 | |
| 35 | #define XP_ERROR0(X) \ |
| 36 | { xmlXPatherror(ctxt, __FILE__, __LINE__, X); \ |
| 37 | ctxt->error = (X); return(0); } |
| 38 | |
| 39 | #define CHECK_TYPE(typeval) \ |
| 40 | if ((ctxt->value == NULL) || (ctxt->value->type != typeval)) \ |
| 41 | XP_ERROR(XPATH_INVALID_TYPE) |
| 42 | |
| 43 | #define CHECK_ARITY(x) \ |
| 44 | if (nargs != (x)) \ |
| 45 | XP_ERROR(XPATH_INVALID_ARITY); |
| 46 | |
| 47 | #define CAST_TO_STRING \ |
| 48 | if ((ctxt->value != NULL) && (ctxt->value->type != XPATH_STRING)) \ |
| 49 | xmlXPathStringFunction(ctxt, 1); |
| 50 | |
| 51 | #define CAST_TO_NUMBER \ |
| 52 | if ((ctxt->value != NULL) && (ctxt->value->type != XPATH_NUMBER)) \ |
| 53 | xmlXPathNumberFunction(ctxt, 1); |
| 54 | |
| 55 | #define CAST_TO_BOOLEAN \ |
| 56 | if ((ctxt->value != NULL) && (ctxt->value->type != XPATH_BOOLEAN)) \ |
| 57 | xmlXPathBooleanFunction(ctxt, 1); |
| 58 | |
| 59 | /* |
| 60 | * Varibale Lookup forwarding |
| 61 | */ |
| 62 | typedef xmlXPathObjectPtr |
| 63 | (*xmlXPathVariableLookupFunc) (void *ctxt, |
| 64 | const xmlChar *name, |
| 65 | const xmlChar *ns_uri); |
| 66 | |
| 67 | void xmlXPathRegisterVariableLookup (xmlXPathContextPtr ctxt, |
| 68 | xmlXPathVariableLookupFunc f, |
| 69 | void *varCtxt); |
| 70 | |
| 71 | /* |
| 72 | * Error reporting |
| 73 | */ |
| 74 | void xmlXPatherror (xmlXPathParserContextPtr ctxt, |
| 75 | const char *file, |
| 76 | int line, |
| 77 | int no); |
| 78 | |
| 79 | void xmlXPathDebugDumpObject (FILE *output, |
| 80 | xmlXPathObjectPtr cur, |
| 81 | int depth); |
| 82 | |
| 83 | /** |
| 84 | * Extending a context |
| 85 | */ |
| 86 | |
| 87 | int xmlXPathRegisterNs (xmlXPathContextPtr ctxt, |
| 88 | const xmlChar *prefix, |
| 89 | const xmlChar *ns_uri); |
| 90 | const xmlChar * xmlXPathNsLookup (xmlXPathContextPtr ctxt, |
| 91 | const xmlChar *ns_uri); |
| 92 | void xmlXPathRegisteredNsCleanup (xmlXPathContextPtr ctxt); |
| 93 | |
| 94 | int xmlXPathRegisterFunc (xmlXPathContextPtr ctxt, |
| 95 | const xmlChar *name, |
| 96 | xmlXPathFunction f); |
| 97 | int xmlXPathRegisterFuncNS (xmlXPathContextPtr ctxt, |
| 98 | const xmlChar *name, |
| 99 | const xmlChar *ns_uri, |
| 100 | xmlXPathFunction f); |
| 101 | int xmlXPathRegisterVariable (xmlXPathContextPtr ctxt, |
| 102 | const xmlChar *name, |
| 103 | xmlXPathObjectPtr value); |
| 104 | int xmlXPathRegisterVariableNS (xmlXPathContextPtr ctxt, |
| 105 | const xmlChar *name, |
| 106 | const xmlChar *ns_uri, |
| 107 | xmlXPathObjectPtr value); |
| 108 | xmlXPathFunction xmlXPathFunctionLookup (xmlXPathContextPtr ctxt, |
| 109 | const xmlChar *name); |
| 110 | xmlXPathFunction xmlXPathFunctionLookupNS (xmlXPathContextPtr ctxt, |
| 111 | const xmlChar *name, |
| 112 | const xmlChar *ns_uri); |
| 113 | void xmlXPathRegisteredFuncsCleanup(xmlXPathContextPtr ctxt); |
| 114 | xmlXPathObjectPtr xmlXPathVariableLookup (xmlXPathContextPtr ctxt, |
| 115 | const xmlChar *name); |
| 116 | xmlXPathObjectPtr xmlXPathVariableLookupNS (xmlXPathContextPtr ctxt, |
| 117 | const xmlChar *name, |
| 118 | const xmlChar *ns_uri); |
| 119 | void xmlXPathRegisteredVariablesCleanup(xmlXPathContextPtr ctxt); |
| 120 | |
| 121 | /** |
| 122 | * Utilities to extend XPath |
| 123 | */ |
| 124 | xmlXPathParserContextPtr |
| 125 | xmlXPathNewParserContext (const xmlChar *str, |
| 126 | xmlXPathContextPtr ctxt); |
| 127 | void xmlXPathFreeParserContext (xmlXPathParserContextPtr ctxt); |
| 128 | |
| 129 | /* TODO: remap to xmlXPathValuePop and Push */ |
| 130 | xmlXPathObjectPtr valuePop (xmlXPathParserContextPtr ctxt); |
| 131 | int valuePush (xmlXPathParserContextPtr ctxt, |
| 132 | xmlXPathObjectPtr value); |
| 133 | |
| 134 | xmlXPathObjectPtr xmlXPathNewString (const xmlChar *val); |
| 135 | xmlXPathObjectPtr xmlXPathNewCString (const char *val); |
| 136 | xmlXPathObjectPtr xmlXPathNewFloat (double val); |
| 137 | xmlXPathObjectPtr xmlXPathNewBoolean (int val); |
| 138 | xmlXPathObjectPtr xmlXPathNewNodeSet (xmlNodePtr val); |
| 139 | xmlXPathObjectPtr xmlXPathNewValueTree (xmlNodePtr val); |
| 140 | void xmlXPathNodeSetAdd (xmlNodeSetPtr cur, |
| 141 | xmlNodePtr val); |
| 142 | |
| 143 | |
| 144 | void xmlXPathIdFunction (xmlXPathParserContextPtr ctxt, |
| 145 | int nargs); |
| 146 | void xmlXPathRoot (xmlXPathParserContextPtr ctxt); |
| 147 | void xmlXPathEvalExpr (xmlXPathParserContextPtr ctxt); |
| 148 | xmlChar * xmlXPathParseName (xmlXPathParserContextPtr ctxt); |
| 149 | xmlChar * xmlXPathParseNCName (xmlXPathParserContextPtr ctxt); |
| 150 | |
| 151 | /* |
| 152 | * Debug |
| 153 | */ |
| 154 | #ifdef LIBXML_DEBUG_ENABLED |
| 155 | double xmlXPathStringEvalNumber(const xmlChar *str); |
| 156 | void xmlXPathDebugDumpObject(FILE *output, xmlXPathObjectPtr cur, int depth); |
| 157 | #endif |
| 158 | /* |
| 159 | * Existing functions |
| 160 | */ |
| 161 | |
| 162 | int xmlXPathEvaluatePredicateResult(xmlXPathParserContextPtr ctxt, |
| 163 | xmlXPathObjectPtr res); |
| 164 | void xmlXPathInit(void); |
| 165 | void xmlXPathStringFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 166 | void xmlXPathRegisterAllFunctions(xmlXPathContextPtr ctxt); |
| 167 | xmlNodeSetPtr xmlXPathNodeSetCreate(xmlNodePtr val); |
| 168 | void xmlXPathNodeSetAdd(xmlNodeSetPtr cur, xmlNodePtr val); |
| 169 | xmlNodeSetPtr xmlXPathNodeSetMerge(xmlNodeSetPtr val1, xmlNodeSetPtr val2); |
| 170 | void xmlXPathNodeSetDel(xmlNodeSetPtr cur, xmlNodePtr val); |
| 171 | void xmlXPathNodeSetRemove(xmlNodeSetPtr cur, int val); |
| 172 | void xmlXPathFreeNodeSet(xmlNodeSetPtr obj); |
| 173 | xmlXPathObjectPtr xmlXPathNewNodeSet(xmlNodePtr val); |
| 174 | xmlXPathObjectPtr xmlXPathNewNodeSetList(xmlNodeSetPtr val); |
| 175 | xmlXPathObjectPtr xmlXPathWrapNodeSet(xmlNodeSetPtr val); |
| 176 | void xmlXPathFreeNodeSetList(xmlXPathObjectPtr obj); |
| 177 | |
| 178 | |
| 179 | xmlXPathObjectPtr xmlXPathNewFloat(double val); |
| 180 | xmlXPathObjectPtr xmlXPathNewBoolean(int val); |
| 181 | xmlXPathObjectPtr xmlXPathNewString(const xmlChar *val); |
| 182 | xmlXPathObjectPtr xmlXPathNewCString(const char *val); |
| 183 | void xmlXPathFreeObject(xmlXPathObjectPtr obj); |
| 184 | xmlXPathContextPtr xmlXPathNewContext(xmlDocPtr doc); |
| 185 | void xmlXPathFreeContext(xmlXPathContextPtr ctxt); |
| 186 | |
| 187 | int xmlXPathEqualValues(xmlXPathParserContextPtr ctxt); |
| 188 | int xmlXPathCompareValues(xmlXPathParserContextPtr ctxt, int inf, int strict); |
| 189 | void xmlXPathValueFlipSign(xmlXPathParserContextPtr ctxt); |
| 190 | void xmlXPathAddValues(xmlXPathParserContextPtr ctxt); |
| 191 | void xmlXPathSubValues(xmlXPathParserContextPtr ctxt); |
| 192 | void xmlXPathMultValues(xmlXPathParserContextPtr ctxt); |
| 193 | void xmlXPathDivValues(xmlXPathParserContextPtr ctxt); |
| 194 | void xmlXPathModValues(xmlXPathParserContextPtr ctxt); |
| 195 | |
| 196 | |
| 197 | /* |
| 198 | * Some of the axis navigation routines |
| 199 | */ |
| 200 | xmlNodePtr xmlXPathNextPreceding(xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
| 201 | xmlNodePtr xmlXPathNextAncestor(xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
| 202 | xmlNodePtr xmlXPathNextPrecedingSibling(xmlXPathParserContextPtr ctxt, xmlNodePtr cur); |
| 203 | /* |
| 204 | * The official core of XPath functions |
| 205 | */ |
| 206 | void xmlXPathRoot(xmlXPathParserContextPtr ctxt); |
| 207 | void xmlXPathLastFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 208 | void xmlXPathPositionFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 209 | void xmlXPathCountFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 210 | void xmlXPathIdFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 211 | void xmlXPathLocalNameFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 212 | void xmlXPathNamespaceURIFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 213 | void xmlXPathStringFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 214 | void xmlXPathStringLengthFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 215 | void xmlXPathConcatFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 216 | void xmlXPathContainsFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 217 | void xmlXPathStartsWithFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 218 | void xmlXPathSubstringFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 219 | void xmlXPathSubstringBeforeFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 220 | void xmlXPathSubstringAfterFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 221 | void xmlXPathNormalizeFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 222 | void xmlXPathTranslateFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 223 | void xmlXPathNotFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 224 | void xmlXPathTrueFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 225 | void xmlXPathFalseFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 226 | void xmlXPathLangFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 227 | void xmlXPathNumberFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 228 | void xmlXPathSumFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 229 | void xmlXPathFloorFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 230 | void xmlXPathCeilingFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 231 | void xmlXPathRoundFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 232 | void xmlXPathBooleanFunction(xmlXPathParserContextPtr ctxt, int nargs); |
| 233 | #ifdef __cplusplus |
| 234 | } |
| 235 | #endif |
| 236 | #endif /* ! __XML_XPATH_INTERNALS_H__ */ |