Referencia del Archivo src/libdigidoc/libxml2/include/libxml/list.h

#include <libxml/xmlversion.h>

Ir al código fuente de este archivo.

'typedefs'
typedef struct _xmlLink	xmlLink
typedef xmlLink *	xmlLinkPtr
typedef struct _xmlList	xmlList
typedef xmlList *	xmlListPtr
typedef void(*	xmlListDeallocator )(xmlLinkPtr lk)
typedef int(*	xmlListDataCompare )(const void *data0, const void *data1)
typedef int(*	xmlListWalker )(const void *data, const void *user)
Funciones
XMLPUBFUN xmlListPtr XMLCALL	xmlListCreate (xmlListDeallocator deallocator, xmlListDataCompare compare)
XMLPUBFUN void XMLCALL	xmlListDelete (xmlListPtr l)
XMLPUBFUN void *XMLCALL	xmlListSearch (xmlListPtr l, void *data)
XMLPUBFUN void *XMLCALL	xmlListReverseSearch (xmlListPtr l, void *data)
XMLPUBFUN int XMLCALL	xmlListInsert (xmlListPtr l, void *data)
XMLPUBFUN int XMLCALL	xmlListAppend (xmlListPtr l, void *data)
XMLPUBFUN int XMLCALL	xmlListRemoveFirst (xmlListPtr l, void *data)
XMLPUBFUN int XMLCALL	xmlListRemoveLast (xmlListPtr l, void *data)
XMLPUBFUN int XMLCALL	xmlListRemoveAll (xmlListPtr l, void *data)
XMLPUBFUN void XMLCALL	xmlListClear (xmlListPtr l)
XMLPUBFUN int XMLCALL	xmlListEmpty (xmlListPtr l)
XMLPUBFUN xmlLinkPtr XMLCALL	xmlListFront (xmlListPtr l)
XMLPUBFUN xmlLinkPtr XMLCALL	xmlListEnd (xmlListPtr l)
XMLPUBFUN int XMLCALL	xmlListSize (xmlListPtr l)
XMLPUBFUN void XMLCALL	xmlListPopFront (xmlListPtr l)
XMLPUBFUN void XMLCALL	xmlListPopBack (xmlListPtr l)
XMLPUBFUN int XMLCALL	xmlListPushFront (xmlListPtr l, void *data)
XMLPUBFUN int XMLCALL	xmlListPushBack (xmlListPtr l, void *data)
XMLPUBFUN void XMLCALL	xmlListReverse (xmlListPtr l)
XMLPUBFUN void XMLCALL	xmlListSort (xmlListPtr l)
XMLPUBFUN void XMLCALL	xmlListWalk (xmlListPtr l, xmlListWalker walker, const void *user)
XMLPUBFUN void XMLCALL	xmlListReverseWalk (xmlListPtr l, xmlListWalker walker, const void *user)
XMLPUBFUN void XMLCALL	xmlListMerge (xmlListPtr l1, xmlListPtr l2)
XMLPUBFUN xmlListPtr XMLCALL	xmlListDup (const xmlListPtr old)
XMLPUBFUN int XMLCALL	xmlListCopy (xmlListPtr cur, const xmlListPtr old)
XMLPUBFUN void *XMLCALL	xmlLinkGetData (xmlLinkPtr lk)

---

Documentación de los 'typedefs'

typedef struct _xmlLink xmlLink

typedef xmlLink* xmlLinkPtr

typedef struct _xmlList xmlList

typedef int(* xmlListDataCompare)(const void *data0, const void *data1)

xmlListDataCompare: : the first data : the second data

Callback function used to compare 2 data.

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

typedef void(* xmlListDeallocator)(xmlLinkPtr lk)

xmlListDeallocator: : the data to deallocate

Callback function used to free data from a list.

typedef xmlList* xmlListPtr

typedef int(* xmlListWalker)(const void *data, const void *user)

xmlListWalker: : the data found in the list : extra user provided data to the walker

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

Returns 0 to stop walking the list, 1 otherwise.

---

Documentación de las funciones

XMLPUBFUN void* XMLCALL xmlLinkGetData

(

xmlLinkPtr

lk

)

xmlLinkGetData: : a link

See Returns.

Returns a pointer to the data referenced from this link

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

xmlListAppend: : a list : the data

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

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

XMLPUBFUN void XMLCALL xmlListClear

(

xmlListPtr

l

)

xmlListClear: : a list

Remove the all data in the list

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

xmlListCopy: : the new list : the old list

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

Returns 0 in case of success 1 in case of error

XMLPUBFUN xmlListPtr XMLCALL xmlListCreate	(	xmlListDeallocator	deallocator,
		xmlListDataCompare	compare
	)

xmlListCreate: : an optional deallocator function : an optional comparison function

Create a new list

Returns the new list or NULL in case of error

XMLPUBFUN void XMLCALL xmlListDelete

(

xmlListPtr

l

)

xmlListDelete: : a list

Deletes the list and its associated data

XMLPUBFUN xmlListPtr XMLCALL xmlListDup

(

const xmlListPtr

old

)

xmlListDup: : the list

Duplicate the list

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

XMLPUBFUN int XMLCALL xmlListEmpty

(

xmlListPtr

l

)

xmlListEmpty: : a list

Is the list empty ?

Returns 1 if the list is empty, 0 if not empty and -1 in case of error

XMLPUBFUN xmlLinkPtr XMLCALL xmlListEnd

(

xmlListPtr

l

)

xmlListEnd: : a list

Get the last element in the list

Returns the last element in the list, or NULL

XMLPUBFUN xmlLinkPtr XMLCALL xmlListFront

(

xmlListPtr

l

)

xmlListFront: : a list

Get the first element in the list

Returns the first element in the list, or NULL

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

xmlListInsert: : a list : the data

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

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

XMLPUBFUN void XMLCALL xmlListMerge	(	xmlListPtr	l1,
		xmlListPtr	l2
	)

xmlListMerge: : the original list : the new list

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

XMLPUBFUN void XMLCALL xmlListPopBack

(

xmlListPtr

l

)

xmlListPopBack: : a list

Removes the last element in the list

XMLPUBFUN void XMLCALL xmlListPopFront

(

xmlListPtr

l

)

xmlListPopFront: : a list

Removes the first element in the list

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

xmlListPushBack: : a list : new data

add the new data at the end of the list

Returns 1 if successful, 0 otherwise

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

xmlListPushFront: : a list : new data

add the new data at the beginning of the list

Returns 1 if successful, 0 otherwise

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

xmlListRemoveAll: : a list : list data

Remove the all instance associated to data in the list

Returns the number of deallocation, or 0 if not found

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

xmlListRemoveFirst: : a list : list data

Remove the first instance associated to data in the list

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

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

xmlListRemoveLast: : a list : list data

Remove the last instance associated to data in the list

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

XMLPUBFUN void XMLCALL xmlListReverse

(

xmlListPtr

l

)

xmlListReverse: : a list

Reverse the order of the elements in the list

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

xmlListReverseSearch: : a list : a search value

Search the list in reverse order for an existing value of

Returns the value associated to or NULL in case of error

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

xmlListReverseWalk: : a list : a processing function : a user parameter passed to the walker function

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

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

xmlListSearch: : a list : a search value

Search the list for an existing value of

Returns the value associated to or NULL in case of error

XMLPUBFUN int XMLCALL xmlListSize

(

xmlListPtr

l

)

xmlListSize: : a list

Get the number of elements in the list

Returns the number of elements in the list or -1 in case of error

XMLPUBFUN void XMLCALL xmlListSort

(

xmlListPtr

l

)

xmlListSort: : a list

Sort all the elements in the list

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

xmlListWalk: : a list : a processing function : a user parameter passed to the walker function

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