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: lists interfaces |
| 3 | * Description: this module implement the list support used in |
| 4 | * various place in the library. |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 5 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 6 | * Copy: See Copyright for the status of this software. |
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 | * Author: Gary Pennington <Gary.Pennington@uk.sun.com> |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 11 | #ifndef __XML_LINK_INCLUDE__ |
| 12 | #define __XML_LINK_INCLUDE__ |
| 13 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 14 | #include <libxml/xmlversion.h> |
| 15 | |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 16 | #ifdef __cplusplus |
| 17 | extern "C" { |
| 18 | #endif |
| 19 | |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 20 | typedef struct _xmlLink xmlLink; |
| 21 | typedef xmlLink *xmlLinkPtr; |
| 22 | |
| 23 | typedef struct _xmlList xmlList; |
| 24 | typedef xmlList *xmlListPtr; |
| 25 | |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 26 | /** |
| 27 | * xmlListDeallocator: |
| 28 | * @lk: the data to deallocate |
| 29 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 30 | * Callback function used to free data from a list. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 31 | */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 32 | typedef void (*xmlListDeallocator) (xmlLinkPtr lk); |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 33 | /** |
| 34 | * xmlListDataCompare: |
| 35 | * @data0: the first data |
| 36 | * @data1: the second data |
| 37 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 38 | * Callback function used to compare 2 data. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 39 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 40 | * Returns 0 is equality, -1 or 1 otherwise depending on the ordering. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 41 | */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 42 | typedef int (*xmlListDataCompare) (const void *data0, const void *data1); |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 43 | /** |
| 44 | * xmlListWalker: |
| 45 | * @data: the data found in the list |
| 46 | * @user: extra user provided data to the walker |
| 47 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 48 | * Callback function used when walking a list with xmlListWalk(). |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 49 | * |
Daniel Veillard | 61f2617 | 2002-03-12 18:46:39 +0000 | [diff] [blame] | 50 | * Returns 0 to stop walking the list, 1 otherwise. |
Daniel Veillard | 9d06d30 | 2002-01-22 18:15:52 +0000 | [diff] [blame] | 51 | */ |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 52 | typedef int (*xmlListWalker) (const void *data, const void *user); |
| 53 | |
| 54 | /* Creation/Deletion */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 55 | XMLPUBFUN xmlListPtr XMLCALL |
| 56 | xmlListCreate (xmlListDeallocator deallocator, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 57 | xmlListDataCompare compare); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 58 | XMLPUBFUN void XMLCALL |
| 59 | xmlListDelete (xmlListPtr l); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 60 | |
| 61 | /* Basic Operators */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 62 | XMLPUBFUN void * XMLCALL |
| 63 | xmlListSearch (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 64 | void *data); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 65 | XMLPUBFUN void * XMLCALL |
| 66 | xmlListReverseSearch (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 67 | void *data); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 68 | XMLPUBFUN int XMLCALL |
| 69 | xmlListInsert (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 70 | void *data) ; |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 71 | XMLPUBFUN int XMLCALL |
| 72 | xmlListAppend (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 73 | void *data) ; |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 74 | XMLPUBFUN int XMLCALL |
| 75 | xmlListRemoveFirst (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 76 | void *data); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 77 | XMLPUBFUN int XMLCALL |
| 78 | xmlListRemoveLast (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 79 | void *data); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 80 | XMLPUBFUN int XMLCALL |
| 81 | xmlListRemoveAll (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 82 | void *data); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 83 | XMLPUBFUN void XMLCALL |
| 84 | xmlListClear (xmlListPtr l); |
| 85 | XMLPUBFUN int XMLCALL |
| 86 | xmlListEmpty (xmlListPtr l); |
| 87 | XMLPUBFUN xmlLinkPtr XMLCALL |
| 88 | xmlListFront (xmlListPtr l); |
| 89 | XMLPUBFUN xmlLinkPtr XMLCALL |
| 90 | xmlListEnd (xmlListPtr l); |
| 91 | XMLPUBFUN int XMLCALL |
| 92 | xmlListSize (xmlListPtr l); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 93 | |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 94 | XMLPUBFUN void XMLCALL |
| 95 | xmlListPopFront (xmlListPtr l); |
| 96 | XMLPUBFUN void XMLCALL |
| 97 | xmlListPopBack (xmlListPtr l); |
| 98 | XMLPUBFUN int XMLCALL |
| 99 | xmlListPushFront (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 100 | void *data); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 101 | XMLPUBFUN int XMLCALL |
| 102 | xmlListPushBack (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 103 | void *data); |
| 104 | |
| 105 | /* Advanced Operators */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 106 | XMLPUBFUN void XMLCALL |
| 107 | xmlListReverse (xmlListPtr l); |
| 108 | XMLPUBFUN void XMLCALL |
| 109 | xmlListSort (xmlListPtr l); |
| 110 | XMLPUBFUN void XMLCALL |
| 111 | xmlListWalk (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 112 | xmlListWalker walker, |
| 113 | const void *user); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 114 | XMLPUBFUN void XMLCALL |
| 115 | xmlListReverseWalk (xmlListPtr l, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 116 | xmlListWalker walker, |
| 117 | const void *user); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 118 | XMLPUBFUN void XMLCALL |
| 119 | xmlListMerge (xmlListPtr l1, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 120 | xmlListPtr l2); |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 121 | XMLPUBFUN xmlListPtr XMLCALL |
| 122 | xmlListDup (const xmlListPtr old); |
| 123 | XMLPUBFUN int XMLCALL |
| 124 | xmlListCopy (xmlListPtr cur, |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 125 | const xmlListPtr old); |
| 126 | /* Link operators */ |
Igor Zlatkovic | 76874e4 | 2003-08-25 09:05:12 +0000 | [diff] [blame] | 127 | XMLPUBFUN void * XMLCALL |
| 128 | xmlLinkGetData (xmlLinkPtr lk); |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 129 | |
| 130 | /* xmlListUnique() */ |
| 131 | /* xmlListSwap */ |
| 132 | |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 133 | #ifdef __cplusplus |
| 134 | } |
| 135 | #endif |
Owen Taylor | 3473f88 | 2001-02-23 17:55:21 +0000 | [diff] [blame] | 136 | |
Daniel Veillard | 56a4cb8 | 2001-03-24 17:00:36 +0000 | [diff] [blame] | 137 | #endif /* __XML_LINK_INCLUDE__ */ |