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: API to handle XML Pointers |
| 3 | * Description: API to handle XML Pointers |
| 4 | * Base implementation was made accordingly to |
| 5 | * W3C Candidate Recommendation 7 June 2000 |
| 6 | * http://www.w3.org/TR/2000/CR-xptr-20000607 |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 7 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 8 | * Added support for the element() scheme described in: |
| 9 | * W3C Proposed Recommendation 13 November 2002 |
| 10 | * http://www.w3.org/TR/2002/PR-xptr-element-20021113/ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 11 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 12 | * Copy: See Copyright for the status of this software. |
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 | * Author: Daniel Veillard |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 15 | */ |
| 16 | |
| 17 | #ifndef __XML_XPTR_H__ |
| 18 | #define __XML_XPTR_H__ |
| 19 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 20 | #include <libxml/xmlversion.h> |
Daniel Veillard | a235132 | 2004-06-27 12:08:10 +0000 | [diff] [blame] | 21 | |
| 22 | #ifdef LIBXML_XPTR_ENABLED |
| 23 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 24 | #include <libxml/tree.h> |
| 25 | #include <libxml/xpath.h> |
| 26 | |
| 27 | #ifdef __cplusplus |
| 28 | extern "C" { |
| 29 | #endif |
| 30 | |
| 31 | /* |
| 32 | * A Location Set |
| 33 | */ |
| 34 | typedef struct _xmlLocationSet xmlLocationSet; |
| 35 | typedef xmlLocationSet *xmlLocationSetPtr; |
| 36 | struct _xmlLocationSet { |
| 37 | int locNr; /* number of locations in the set */ |
| 38 | int locMax; /* size of the array as allocated */ |
| 39 | xmlXPathObjectPtr *locTab;/* array of locations */ |
| 40 | }; |
| 41 | |
| 42 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 43 | * Handling of location sets. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 44 | */ |
| 45 | |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 46 | XMLPUBFUN xmlLocationSetPtr XMLCALL |
| 47 | xmlXPtrLocationSetCreate (xmlXPathObjectPtr val); |
| 48 | XMLPUBFUN void XMLCALL |
| 49 | xmlXPtrFreeLocationSet (xmlLocationSetPtr obj); |
| 50 | XMLPUBFUN xmlLocationSetPtr XMLCALL |
| 51 | xmlXPtrLocationSetMerge (xmlLocationSetPtr val1, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 52 | xmlLocationSetPtr val2); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 53 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 54 | xmlXPtrNewRange (xmlNodePtr start, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 55 | int startindex, |
| 56 | xmlNodePtr end, |
| 57 | int endindex); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 58 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 59 | xmlXPtrNewRangePoints (xmlXPathObjectPtr start, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 60 | xmlXPathObjectPtr end); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 61 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 62 | xmlXPtrNewRangeNodePoint (xmlNodePtr start, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 63 | xmlXPathObjectPtr end); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 64 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 65 | xmlXPtrNewRangePointNode (xmlXPathObjectPtr start, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 66 | xmlNodePtr end); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 67 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 68 | xmlXPtrNewRangeNodes (xmlNodePtr start, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 69 | xmlNodePtr end); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 70 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 71 | xmlXPtrNewLocationSetNodes (xmlNodePtr start, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 72 | xmlNodePtr end); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 73 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 74 | xmlXPtrNewLocationSetNodeSet(xmlNodeSetPtr set); |
| 75 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 76 | xmlXPtrNewRangeNodeObject (xmlNodePtr start, |
Daniel Veillard | 9e7160d | 2001-03-18 23:17:47 +0000 | [diff] [blame] | 77 | xmlXPathObjectPtr end); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 78 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 79 | xmlXPtrNewCollapsedRange (xmlNodePtr start); |
| 80 | XMLPUBFUN void XMLCALL |
| 81 | xmlXPtrLocationSetAdd (xmlLocationSetPtr cur, |
Daniel Veillard | 9e7160d | 2001-03-18 23:17:47 +0000 | [diff] [blame] | 82 | xmlXPathObjectPtr val); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 83 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 84 | xmlXPtrWrapLocationSet (xmlLocationSetPtr val); |
| 85 | XMLPUBFUN void XMLCALL |
| 86 | xmlXPtrLocationSetDel (xmlLocationSetPtr cur, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 87 | xmlXPathObjectPtr val); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 88 | XMLPUBFUN void XMLCALL |
| 89 | xmlXPtrLocationSetRemove (xmlLocationSetPtr cur, |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 90 | int val); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 91 | |
| 92 | /* |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 93 | * Functions. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 94 | */ |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 95 | XMLPUBFUN xmlXPathContextPtr XMLCALL |
| 96 | xmlXPtrNewContext (xmlDocPtr doc, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 97 | xmlNodePtr here, |
| 98 | xmlNodePtr origin); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 99 | XMLPUBFUN xmlXPathObjectPtr XMLCALL |
| 100 | xmlXPtrEval (const xmlChar *str, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 101 | xmlXPathContextPtr ctx); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 102 | XMLPUBFUN void XMLCALL |
| 103 | xmlXPtrRangeToFunction (xmlXPathParserContextPtr ctxt, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 104 | int nargs); |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 105 | XMLPUBFUN xmlNodePtr XMLCALL |
| 106 | xmlXPtrBuildNodeList (xmlXPathObjectPtr obj); |
| 107 | XMLPUBFUN void XMLCALL |
| 108 | xmlXPtrEvalRangePredicate (xmlXPathParserContextPtr ctxt); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 109 | #ifdef __cplusplus |
| 110 | } |
| 111 | #endif |
Daniel Veillard | a235132 | 2004-06-27 12:08:10 +0000 | [diff] [blame] | 112 | |
| 113 | #endif /* LIBXML_XPTR_ENABLED */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 114 | #endif /* __XML_XPTR_H__ */ |