![]() |
libgpac
Documentation of the core library of GPAC
|
List object. More...
Functions | |
GF_List * | gf_list_new () |
list constructor More... | |
void | gf_list_del (GF_List *ptr) |
list destructor More... | |
u32 | gf_list_count (const GF_List *ptr) |
get count More... | |
GF_Err | gf_list_add (GF_List *ptr, void *item) |
add item More... | |
GF_Err | gf_list_insert (GF_List *ptr, void *item, u32 position) |
inserts item More... | |
GF_Err | gf_list_rem (GF_List *ptr, u32 position) |
removes item More... | |
void * | gf_list_get (GF_List *ptr, u32 position) |
gets item More... | |
s32 | gf_list_find (GF_List *ptr, void *item) |
finds item More... | |
s32 | gf_list_del_item (GF_List *ptr, void *item) |
deletes item More... | |
void | gf_list_reset (GF_List *ptr) |
resets list More... | |
void * | gf_list_last (GF_List *ptr) |
gets last item More... | |
GF_Err | gf_list_rem_last (GF_List *ptr) |
removes last item More... | |
void * | gf_list_enum (GF_List *ptr, u32 *pos) |
list enumerator More... | |
GF_Err | gf_list_swap (GF_List *l1, GF_List *l2) |
list swap More... | |
GF_Err | gf_list_transfer (GF_List *dst, GF_List *src) |
list transfer More... | |
GF_List * | gf_list_clone (GF_List *ptr) |
clone list More... | |
void * | gf_list_pop_front (GF_List *ptr) |
Pop the first element in the list. More... | |
void * | gf_list_pop_back (GF_List *ptr) |
Pop the last element in the list. More... | |
List object.
This section documents the list object of the GPAC framework.
GF_List* gf_list_new | ( | ) |
list constructor
Constructs a new list object
void gf_list_del | ( | GF_List * | ptr | ) |
list destructor
Destructs a list object
ptr | list object to destruct |
u32 gf_list_count | ( | const GF_List * | ptr | ) |
get count
Returns number of items in the list
ptr | target list object |
GF_Err gf_list_add | ( | GF_List * | ptr, |
void * | item | ||
) |
add item
Adds an item at the end of the list
ptr | target list object |
item | item to add |
inserts item
Insert an item in the list
ptr | target list object |
item | item to add |
position | insertion position. It is expressed between 0 and gf_list_count-1, and any bigger value is equivalent to gf_list_add |
removes item
Removes an item from the list given its position
ptr | target list object |
position | position of the item to remove. It is expressed between 0 and gf_list_count-1. |
void* gf_list_get | ( | GF_List * | ptr, |
u32 | position | ||
) |
gets item
Gets an item from the list given its position
ptr | target list object |
position | position of the item to get. It is expressed between 0 and gf_list_count-1. |
s32 gf_list_find | ( | GF_List * | ptr, |
void * | item | ||
) |
finds item
Finds an item in the list
ptr | target list object. |
item | the item to find. |
s32 gf_list_del_item | ( | GF_List * | ptr, |
void * | item | ||
) |
deletes item
Deletes an item from the list
ptr | target list object. |
item | the item to find. |
void gf_list_reset | ( | GF_List * | ptr | ) |
resets list
Resets the content of the list
ptr | target list object. |
void* gf_list_last | ( | GF_List * | ptr | ) |
gets last item
Gets last item o fthe list
ptr | target list object |
GF_Err gf_list_rem_last | ( | GF_List * | ptr | ) |
removes last item
Removes the last item of the list
ptr | target list object |
void* gf_list_enum | ( | GF_List * | ptr, |
u32 * | pos | ||
) |
list enumerator
Retrieves given list item and increment current position
ptr | target list object |
pos | target item position. The position is automatically incremented regardless of the return value |
GF_Err gf_list_swap | ( | GF_List * | l1, |
GF_List * | l2 | ||
) |
list swap
Swaps content of two lists
l1 | first list object |
l2 | second list object |
GF_Err gf_list_transfer | ( | GF_List * | dst, |
GF_List * | src | ||
) |
list transfer
Transfer content between lists
dst | destination list object |
src | source list object |
GF_List* gf_list_clone | ( | GF_List * | ptr | ) |
clone list
Returns a new list as an exact copy of the given list
ptr | the list to clone |
void* gf_list_pop_front | ( | GF_List * | ptr | ) |
Pop the first element in the list.
Removes the first element in the list container, effectively reducing its size by one and returns the popped element.
ptr | the list to pop |
void* gf_list_pop_back | ( | GF_List * | ptr | ) |
Pop the last element in the list.
Removes the last element in the list container, effectively reducing the container size by one and return the popped element.
ptr | the list to pop |