libxml2_list.h File Reference

Typedef xmlLink

typedef struct _xmlLink

xmlLink

Typedef xmlLinkPtr

typedef xmlLink *

xmlLinkPtr

Typedef xmlList

typedef struct _xmlList

xmlList

Typedef xmlListPtr

typedef xmlList *

xmlListPtr

Typedef xmlListDeallocator

typedef void(*

xmlListDeallocator

xmlListDeallocator: Callback function used to free data from a list.

Typedef xmlListDataCompare

typedef int(*

xmlListDataCompare

xmlListDataCompare: Callback function used to compare 2 data.

Returns 0 is equality, -1 or 1 otherwise depending on the ordering.

Typedef xmlListWalker

typedef int(*

xmlListWalker

xmlListWalker: Callback function used when walking a list with xmlListWalk().

Returns 0 to stop walking the list, 1 otherwise.

xmlListCreate ( xmlListDeallocator, xmlListDataCompare )

XMLPUBFUN xmlListPtr XMLCALL	xmlListCreate	(	xmlListDeallocator	deallocator,
			xmlListDataCompare	compare
		)

xmlListCreate: Create a new list

Returns the new list or NULL in case of error

Parameters
deallocator	an optional deallocator function
compare	an optional comparison function

xmlListDelete ( xmlListPtr )

XMLPUBFUN void XMLCALL

xmlListDelete

(

xmlListPtr

)

xmlListDelete: Deletes the list and its associated data

Parameters
l	a list

xmlListInsert ( xmlListPtr, void * )

XMLPUBFUN int XMLCALL	xmlListInsert	(	xmlListPtr	l,
			void *	data
		)

xmlListInsert: Insert data in the ordered list at the beginning for this value

Returns 0 in case of success, 1 in case of failure

Parameters
l	a list
data	the data

xmlListAppend ( xmlListPtr, void * )

XMLPUBFUN int XMLCALL	xmlListAppend	(	xmlListPtr	l,
			void *	data
		)

xmlListAppend: Insert data in the ordered list at the end for this value

Returns 0 in case of success, 1 in case of failure

Parameters
l	a list
data	the data

xmlListRemoveFirst ( xmlListPtr, void * )

XMLPUBFUN int XMLCALL	xmlListRemoveFirst	(	xmlListPtr	l,
			void *	data
		)

xmlListRemoveFirst: Remove the first instance associated to data in the list

Returns 1 if a deallocation occured, or 0 if not found

Parameters
l	a list
data	list data

xmlListClear ( xmlListPtr )

XMLPUBFUN void XMLCALL

xmlListClear

(

xmlListPtr

)

xmlListClear: Remove the all data in the list

Parameters
l	a list

xmlListEmpty ( xmlListPtr )

XMLPUBFUN int XMLCALL

xmlListEmpty

(

xmlListPtr

)

xmlListEmpty: Is the list empty ?

Returns 1 if the list is empty, 0 otherwise

Parameters
l	a list

xmlListFront ( xmlListPtr )

XMLPUBFUN xmlLinkPtr XMLCALL

xmlListFront

(

xmlListPtr

)

xmlListFront: Get the first element in the list

Returns the first element in the list, or NULL

Parameters
l	a list

xmlListEnd ( xmlListPtr )

XMLPUBFUN xmlLinkPtr XMLCALL

xmlListEnd

(

xmlListPtr

)

xmlListEnd: Get the last element in the list

Returns the last element in the list, or NULL

Parameters
l	a list

xmlListReverse ( xmlListPtr )

XMLPUBFUN void XMLCALL

xmlListReverse

(

xmlListPtr

)

xmlListReverse: Reverse the order of the elements in the list

Parameters
l	a list

xmlListPopBack ( xmlListPtr )

XMLPUBFUN void XMLCALL

xmlListPopBack

(

xmlListPtr

)

xmlListPopBack: Removes the last element in the list

Parameters
l	a list

xmlListSort ( xmlListPtr )

XMLPUBFUN void XMLCALL

xmlListSort

(

xmlListPtr

)

xmlListSort: Sort all the elements in the list

Parameters
l	a list

xmlListSearch ( xmlListPtr, void * )

XMLPUBFUN void *XMLCALL	xmlListSearch	(	xmlListPtr	l,
			void *	data
		)

xmlListSearch: Search the list for an existing value of data

Returns the value associated to data or NULL in case of error

Parameters
l	a list
data	a search value

xmlListReverseSearch ( xmlListPtr, void * )

XMLPUBFUN void *XMLCALL	xmlListReverseSearch	(	xmlListPtr	l,
			void *	data
		)

xmlListReverseSearch: Search the list in reverse order for an existing value of data

Returns the value associated to data or NULL in case of error

Parameters
l	a list
data	a search value

xmlListRemoveLast ( xmlListPtr, void * )

XMLPUBFUN int XMLCALL	xmlListRemoveLast	(	xmlListPtr	l,
			void *	data
		)

xmlListRemoveLast: Remove the last instance associated to data in the list

Returns 1 if a deallocation occured, or 0 if not found

Parameters
l	a list
data	list data

xmlListRemoveAll ( xmlListPtr, void * )

XMLPUBFUN int XMLCALL	xmlListRemoveAll	(	xmlListPtr	l,
			void *	data
		)

xmlListRemoveAll: Remove the all instance associated to data in the list

Returns the number of deallocation, or 0 if not found

Parameters
l	a list
data	list data

xmlListPushBack ( xmlListPtr, void * )

XMLPUBFUN int XMLCALL	xmlListPushBack	(	xmlListPtr	l,
			void *	data
		)

xmlListPushBack: add the new data at the end of the list

Returns 1 if successful, 0 otherwise

Parameters
l	a list
data	new data

xmlListReverseWalk ( xmlListPtr, xmlListWalker, const void * )

XMLPUBFUN void XMLCALL	xmlListReverseWalk	(	xmlListPtr	l,
			xmlListWalker	walker,
			const void *	user
		)

xmlListReverseWalk: Walk all the element of the list in reverse order and apply the walker function to it

Parameters
l	a list
walker	a processing function
user	a user parameter passed to the walker function

xmlListDup ( const xmlListPtr )

XMLPUBFUN xmlListPtr XMLCALL

xmlListDup

(

const xmlListPtr

old

)

xmlListDup: Duplicate the list

Returns a new copy of the list or NULL in case of error

Parameters
old	the list

xmlListSize ( xmlListPtr )

XMLPUBFUN int XMLCALL

xmlListSize

(

xmlListPtr

)

xmlListSize: Get the number of elements in the list

Returns the number of elements in the list

Parameters
l	a list

xmlListPopFront ( xmlListPtr )

XMLPUBFUN void XMLCALL

xmlListPopFront

(

xmlListPtr

)

xmlListPopFront: Removes the first element in the list

Parameters
l	a list

xmlListPushFront ( xmlListPtr, void * )

XMLPUBFUN int XMLCALL	xmlListPushFront	(	xmlListPtr	l,
			void *	data
		)

xmlListPushFront: add the new data at the beginning of the list

Returns 1 if successful, 0 otherwise

Parameters
l	a list
data	new data

xmlListWalk ( xmlListPtr, xmlListWalker, const void * )

XMLPUBFUN void XMLCALL	xmlListWalk	(	xmlListPtr	l,
			xmlListWalker	walker,
			const void *	user
		)

xmlListWalk: Walk all the element of the first from first to last and apply the walker function to it

Parameters
l	a list
walker	a processing function
user	a user parameter passed to the walker function

xmlListMerge ( xmlListPtr, xmlListPtr )

XMLPUBFUN void XMLCALL	xmlListMerge	(	xmlListPtr	l1,
			xmlListPtr	l2
		)

xmlListMerge: include all the elements of the second list in the first one and clear the second list

Parameters
l1	the original list
l2	the new list

xmlListCopy ( xmlListPtr, const xmlListPtr )

XMLPUBFUN int XMLCALL	xmlListCopy	(	xmlListPtr	cur,
			const xmlListPtr	old
		)

xmlListCopy: Move all the element from the old list in the new list

Returns 0 in case of success 1 in case of error

Parameters
cur	the new list
old	the old list

xmlLinkGetData ( xmlLinkPtr )

XMLPUBFUN void *XMLCALL

xmlLinkGetData

(

xmlLinkPtr

)

xmlLinkGetData: See Returns.

Returns a pointer to the data referenced from this link

Parameters
lk	a link