this module implement the list support used in various place in the library. Table of ContentsStructure xmlLink struct _xmlLink
The content of this structure is not made public by the API.
Typedef xmlLink * xmlLinkPtr
Structure xmlList struct _xmlList
The content of this structure is not made public by the API.
Typedef xmlList * xmlListPtr
void * xmlLinkGetData (xmlLinkPtr lk)
int xmlListAppend (xmlListPtr l, void * data)
void xmlListClear (xmlListPtr l)
int xmlListCopy (xmlListPtr cur, const xmlListPtr old)
xmlListPtr xmlListCreate (xmlListDeallocator deallocator, xmlListDataCompare compare)
Function type: xmlListDataCompare
int xmlListDataCompare (const void * data0, const void * data1)
Function type: xmlListDeallocator
void xmlListDeallocator (xmlLinkPtr lk)
void xmlListDelete (xmlListPtr l)
xmlListPtr xmlListDup (const xmlListPtr old)
int xmlListEmpty (xmlListPtr l)
xmlLinkPtr xmlListEnd (xmlListPtr l)
xmlLinkPtr xmlListFront (xmlListPtr l)
int xmlListInsert (xmlListPtr l, void * data)
void xmlListMerge (xmlListPtr l1, xmlListPtr l2)
void xmlListPopBack (xmlListPtr l)
void xmlListPopFront (xmlListPtr l)
int xmlListPushBack (xmlListPtr l, void * data)
int xmlListPushFront (xmlListPtr l, void * data)
int xmlListRemoveAll (xmlListPtr l, void * data)
int xmlListRemoveFirst (xmlListPtr l, void * data)
int xmlListRemoveLast (xmlListPtr l, void * data)
void xmlListReverse (xmlListPtr l)
void * xmlListReverseSearch (xmlListPtr l, void * data)
void xmlListReverseWalk (xmlListPtr l, xmlListWalker walker, const void * user)
void * xmlListSearch (xmlListPtr l, void * data)
int xmlListSize (xmlListPtr l)
void xmlListSort (xmlListPtr l)
void xmlListWalk (xmlListPtr l, xmlListWalker walker, const void * user)
Function type: xmlListWalker
int xmlListWalker (const void * data, const void * user)
Description
Structure xmlLink struct _xmlLink {
The content of this structure is not made public by the API.
} Structure xmlList struct _xmlList {
The content of this structure is not made public by the API.
} Function: xmlLinkGetDatavoid * xmlLinkGetData (xmlLinkPtr lk)
See Returns.
lk: | a link | Returns: | a pointer to the data referenced from this link |
Function: xmlListAppendint xmlListAppend (xmlListPtr l, void * data)
Insert data in the ordered list at the end for this value
l: | a list | data: | the data | Returns: | 0 in case of success, 1 in case of failure |
Function: xmlListClearvoid xmlListClear (xmlListPtr l)
Remove the all data in the list
Function: xmlListCopyint xmlListCopy (xmlListPtr cur, const xmlListPtr old)
Move all the element from the old list in the new list
cur: | the new list | old: | the old list | Returns: | 0 in case of success 1 in case of error |
Function: xmlListCreatexmlListPtr xmlListCreate (xmlListDeallocator deallocator, xmlListDataCompare compare)
Create a new list
deallocator: | an optional deallocator function | compare: | an optional comparison function | Returns: | the new list or NULL in case of error |
Function type: xmlListDataCompareFunction type: xmlListDataCompare
int xmlListDataCompare (const void * data0, const void * data1)
Callback function used to compare 2 data. data0: | the first data | data1: | the second data | Returns: | 0 is equality, -1 or 1 otherwise depending on the ordering. |
Function type: xmlListDeallocatorFunction type: xmlListDeallocator
void xmlListDeallocator (xmlLinkPtr lk)
Callback function used to free data from a list. lk: | the data to deallocate |
Function: xmlListDeletevoid xmlListDelete (xmlListPtr l)
Deletes the list and its associated data
Function: xmlListDupxmlListPtr xmlListDup (const xmlListPtr old)
Duplicate the list
old: | the list | Returns: | a new copy of the list or NULL in case of error |
Function: xmlListEmptyint xmlListEmpty (xmlListPtr l)
Is the list empty ?
l: | a list | Returns: | 1 if the list is empty, 0 if not empty and -1 in case of error |
Function: xmlListEndxmlLinkPtr xmlListEnd (xmlListPtr l)
Get the last element in the list
l: | a list | Returns: | the last element in the list, or NULL |
Function: xmlListFrontxmlLinkPtr xmlListFront (xmlListPtr l)
Get the first element in the list
l: | a list | Returns: | the first element in the list, or NULL |
Function: xmlListInsertint xmlListInsert (xmlListPtr l, void * data)
Insert data in the ordered list at the beginning for this value
l: | a list | data: | the data | Returns: | 0 in case of success, 1 in case of failure |
Function: xmlListMergevoid xmlListMerge (xmlListPtr l1, xmlListPtr l2)
include all the elements of the second list in the first one and clear the second list
l1: | the original list | l2: | the new list |
Function: xmlListPopBackvoid xmlListPopBack (xmlListPtr l)
Removes the last element in the list
Function: xmlListPopFrontvoid xmlListPopFront (xmlListPtr l)
Removes the first element in the list
Function: xmlListPushBackint xmlListPushBack (xmlListPtr l, void * data)
add the new data at the end of the list
l: | a list | data: | new data | Returns: | 1 if successful, 0 otherwise |
Function: xmlListPushFrontint xmlListPushFront (xmlListPtr l, void * data)
add the new data at the beginning of the list
l: | a list | data: | new data | Returns: | 1 if successful, 0 otherwise |
Function: xmlListRemoveAllint xmlListRemoveAll (xmlListPtr l, void * data)
Remove the all instance associated to data in the list
l: | a list | data: | list data | Returns: | the number of deallocation, or 0 if not found |
Function: xmlListRemoveFirstint xmlListRemoveFirst (xmlListPtr l, void * data)
Remove the first instance associated to data in the list
l: | a list | data: | list data | Returns: | 1 if a deallocation occured, or 0 if not found |
Function: xmlListRemoveLastint xmlListRemoveLast (xmlListPtr l, void * data)
Remove the last instance associated to data in the list
l: | a list | data: | list data | Returns: | 1 if a deallocation occured, or 0 if not found |
Function: xmlListReversevoid xmlListReverse (xmlListPtr l)
Reverse the order of the elements in the list
Function: xmlListReverseSearchvoid * xmlListReverseSearch (xmlListPtr l, void * data)
Search the list in reverse order for an existing value of @data
l: | a list | data: | a search value | Returns: | the value associated to @data or NULL in case of error |
Function: xmlListReverseWalkvoid xmlListReverseWalk (xmlListPtr l, xmlListWalker walker, const void * user)
Walk all the element of the list in reverse order and apply the walker function to it
l: | a list | walker: | a processing function | user: | a user parameter passed to the walker function |
Function: xmlListSearchvoid * xmlListSearch (xmlListPtr l, void * data)
Search the list for an existing value of @data
l: | a list | data: | a search value | Returns: | the value associated to @data or NULL in case of error |
Function: xmlListSizeint xmlListSize (xmlListPtr l)
Get the number of elements in the list
l: | a list | Returns: | the number of elements in the list or -1 in case of error |
Function: xmlListSortvoid xmlListSort (xmlListPtr l)
Sort all the elements in the list
Function: xmlListWalkvoid xmlListWalk (xmlListPtr l, xmlListWalker walker, const void * user)
Walk all the element of the first from first to last and apply the walker function to it
l: | a list | walker: | a processing function | user: | a user parameter passed to the walker function |
Function type: xmlListWalkerFunction type: xmlListWalker
int xmlListWalker (const void * data, const void * user)
Callback function used when walking a list with xmlListWalk(). data: | the data found in the list | user: | extra user provided data to the walker | Returns: | 0 to stop walking the list, 1 otherwise. |
Daniel Veillard |