deps/src/libxml2-2.9.1/doc/html/libxml-list.html
| |
|
|
|
|
|
|
|
|
|
| API Menu | |
|
| API Indexes | |
|
| Related links | |
|
|
|
|
|
|
| | hash | | API documentation | | The XML C parser and toolkit of Gnome | nanoftp | |
this module implement the list support used in various place in the library.
Structure[xmlLink](#xmlLink)
struct _xmlLink
The content of this structure is not made public by the API.
Typedef[xmlLink](libxml-list.html#xmlLink)*xmlLinkPtr
Structure[xmlList](#xmlList)
struct _xmlList
The content of this structure is not made public by the API.
Typedef[xmlList](libxml-list.html#xmlList)*xmlListPtr
void *[xmlLinkGetData](#xmlLinkGetData)([xmlLinkPtr](libxml-list.html#xmlLinkPtr)lk)
int[xmlListAppend](#xmlListAppend)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
void[xmlListClear](#xmlListClear)([xmlListPtr](libxml-list.html#xmlListPtr)l)
int[xmlListCopy](#xmlListCopy)([xmlListPtr](libxml-list.html#xmlListPtr)cur,
const[xmlListPtr](libxml-list.html#xmlListPtr)old)
[xmlListPtr](libxml-list.html#xmlListPtr)[xmlListCreate](#xmlListCreate)([xmlListDeallocator](libxml-list.html#xmlListDeallocator)deallocator,
[xmlListDataCompare](libxml-list.html#xmlListDataCompare)compare)
Function type:[xmlListDataCompare](#xmlListDataCompare)int[xmlListDataCompare](#xmlListDataCompare)(const void * data0,
const void * data1)
Function type:[xmlListDeallocator](#xmlListDeallocator)void[xmlListDeallocator](#xmlListDeallocator)([xmlLinkPtr](libxml-list.html#xmlLinkPtr)lk)
void[xmlListDelete](#xmlListDelete)([xmlListPtr](libxml-list.html#xmlListPtr)l)
[xmlListPtr](libxml-list.html#xmlListPtr)[xmlListDup](#xmlListDup)(const[xmlListPtr](libxml-list.html#xmlListPtr)old)
int[xmlListEmpty](#xmlListEmpty)([xmlListPtr](libxml-list.html#xmlListPtr)l)
[xmlLinkPtr](libxml-list.html#xmlLinkPtr)[xmlListEnd](#xmlListEnd)([xmlListPtr](libxml-list.html#xmlListPtr)l)
[xmlLinkPtr](libxml-list.html#xmlLinkPtr)[xmlListFront](#xmlListFront)([xmlListPtr](libxml-list.html#xmlListPtr)l)
int[xmlListInsert](#xmlListInsert)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
void[xmlListMerge](#xmlListMerge)([xmlListPtr](libxml-list.html#xmlListPtr)l1,
[xmlListPtr](libxml-list.html#xmlListPtr)l2)
void[xmlListPopBack](#xmlListPopBack)([xmlListPtr](libxml-list.html#xmlListPtr)l)
void[xmlListPopFront](#xmlListPopFront)([xmlListPtr](libxml-list.html#xmlListPtr)l)
int[xmlListPushBack](#xmlListPushBack)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
int[xmlListPushFront](#xmlListPushFront)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
int[xmlListRemoveAll](#xmlListRemoveAll)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
int[xmlListRemoveFirst](#xmlListRemoveFirst)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
int[xmlListRemoveLast](#xmlListRemoveLast)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
void[xmlListReverse](#xmlListReverse)([xmlListPtr](libxml-list.html#xmlListPtr)l)
void *[xmlListReverseSearch](#xmlListReverseSearch)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
void[xmlListReverseWalk](#xmlListReverseWalk)([xmlListPtr](libxml-list.html#xmlListPtr)l,
[xmlListWalker](libxml-list.html#xmlListWalker)walker,
const void * user)
void *[xmlListSearch](#xmlListSearch)([xmlListPtr](libxml-list.html#xmlListPtr)l,
void * data)
int[xmlListSize](#xmlListSize)([xmlListPtr](libxml-list.html#xmlListPtr)l)
void[xmlListSort](#xmlListSort)([xmlListPtr](libxml-list.html#xmlListPtr)l)
void[xmlListWalk](#xmlListWalk)([xmlListPtr](libxml-list.html#xmlListPtr)l,
[xmlListWalker](libxml-list.html#xmlListWalker)walker,
const void * user)
Function type:[xmlListWalker](#xmlListWalker)int[xmlListWalker](#xmlListWalker)(const void * data,
const void * user)
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.
}
void * xmlLinkGetData ([xmlLinkPtr](libxml-list.html#xmlLinkPtr)lk)
See Returns.
| lk: | a link | | Returns: | a pointer to the data referenced from this link |
int xmlListAppend ([xmlListPtr](libxml-list.html#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 |
void xmlListClear ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Remove the all data in the list
| l: | a list |
int xmlListCopy ([xmlListPtr](libxml-list.html#xmlListPtr)cur,
const[xmlListPtr](libxml-list.html#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 |
[xmlListPtr](libxml-list.html#xmlListPtr)xmlListCreate ([xmlListDeallocator](libxml-list.html#xmlListDeallocator)deallocator,
[xmlListDataCompare](libxml-list.html#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: 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: xmlListDeallocator
void xmlListDeallocator ([xmlLinkPtr](libxml-list.html#xmlLinkPtr)lk)
Callback function used to free data from a list.
| lk: | the data to deallocate |
void xmlListDelete ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Deletes the list and its associated data
| l: | a list |
[xmlListPtr](libxml-list.html#xmlListPtr)xmlListDup (const[xmlListPtr](libxml-list.html#xmlListPtr)old)
Duplicate the list
| old: | the list | | Returns: | a new copy of the list or NULL in case of error |
int xmlListEmpty ([xmlListPtr](libxml-list.html#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 |
[xmlLinkPtr](libxml-list.html#xmlLinkPtr)xmlListEnd ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Get the last element in the list
| l: | a list | | Returns: | the last element in the list, or NULL |
[xmlLinkPtr](libxml-list.html#xmlLinkPtr)xmlListFront ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Get the first element in the list
| l: | a list | | Returns: | the first element in the list, or NULL |
int xmlListInsert ([xmlListPtr](libxml-list.html#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 |
void xmlListMerge ([xmlListPtr](libxml-list.html#xmlListPtr)l1,
[xmlListPtr](libxml-list.html#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 |
void xmlListPopBack ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Removes the last element in the list
| l: | a list |
void xmlListPopFront ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Removes the first element in the list
| l: | a list |
int xmlListPushBack ([xmlListPtr](libxml-list.html#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 |
int xmlListPushFront ([xmlListPtr](libxml-list.html#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 |
int xmlListRemoveAll ([xmlListPtr](libxml-list.html#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 |
int xmlListRemoveFirst ([xmlListPtr](libxml-list.html#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 |
int xmlListRemoveLast ([xmlListPtr](libxml-list.html#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 |
void xmlListReverse ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Reverse the order of the elements in the list
| l: | a list |
void * xmlListReverseSearch ([xmlListPtr](libxml-list.html#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 |
void xmlListReverseWalk ([xmlListPtr](libxml-list.html#xmlListPtr)l,
[xmlListWalker](libxml-list.html#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 |
void * xmlListSearch ([xmlListPtr](libxml-list.html#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 |
int xmlListSize ([xmlListPtr](libxml-list.html#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 |
void xmlListSort ([xmlListPtr](libxml-list.html#xmlListPtr)l)
Sort all the elements in the list
| l: | a list |
void xmlListWalk ([xmlListPtr](libxml-list.html#xmlListPtr)l,
[xmlListWalker](libxml-list.html#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: 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. |
|
|
|
|
|