These functions manage iterators on containers. More...
Data Structures | |
struct | _Eina_Iterator |
structure of an iterator More... | |
Macros | |
#define | FUNC_ITERATOR_NEXT(Function) ((Eina_Iterator_Next_Callback)Function) |
Helper macro to cast Function to a Eina_Iterator_Next_Callback. | |
#define | FUNC_ITERATOR_GET_CONTAINER(Function) ((Eina_Iterator_Get_Container_Callback)Function) |
Helper macro to cast Function to a Eina_Iterator_Get_Container_Callback. | |
#define | FUNC_ITERATOR_FREE(Function) ((Eina_Iterator_Free_Callback)Function) |
Helper macro to cast Function to a Eina_Iterator_Free_Callback. | |
#define | FUNC_ITERATOR_LOCK(Function) ((Eina_Iterator_Lock_Callback)Function) |
Helper macro to cast Function to a Eina_Iterator_Lock_Callback. | |
#define | EINA_ITERATOR_FOREACH(itr,data) |
Macro to iterate over all elements easily. More... | |
Typedefs | |
typedef struct _Eina_Iterator | Eina_Iterator |
Abstract type for iterators. | |
typedef Eina_Bool(* | Eina_Iterator_Next_Callback )(Eina_Iterator *it, void **data) |
Type for a callback that returns the next element in a container. | |
typedef void *(* | Eina_Iterator_Get_Container_Callback )(Eina_Iterator *it) |
Type for a callback that returns the container. | |
typedef void(* | Eina_Iterator_Free_Callback )(Eina_Iterator *it) |
Type for a callback that frees the container. | |
typedef Eina_Bool(* | Eina_Iterator_Lock_Callback )(Eina_Iterator *it) |
Type for a callback that lock the container. | |
Functions | |
void | eina_iterator_free (Eina_Iterator *iterator) |
Free an iterator. More... | |
void * | eina_iterator_container_get (Eina_Iterator *iterator) |
Return the container of an iterator. More... | |
Eina_Bool | eina_iterator_next (Eina_Iterator *iterator, void **data) |
Return the value of the current element and go to the next one. More... | |
void | eina_iterator_foreach (Eina_Iterator *iterator, Eina_Each_Cb callback, const void *fdata) |
Iterate over the container and execute a callback on each element. More... | |
Eina_Bool | eina_iterator_lock (Eina_Iterator *iterator) |
Lock the container of the iterator. More... | |
Eina_Bool | eina_iterator_unlock (Eina_Iterator *iterator) |
Unlock the container of the iterator. More... | |
Detailed Description
These functions manage iterators on containers.
These functions allow to access elements of a container in a generic way, without knowing which container is used (a bit like iterators in the C++ STL). Iterators only allows sequential access (that is, from an element to the next one). For random access, see Accessor Functions.
An iterator is created from container data types, so no creation function is available here. An iterator is deleted with eina_iterator_free(). To get the data and iterate, use eina_iterator_next(). To call a function on all the elements of a container, use eina_iterator_foreach().
Here an example
Macro Definition Documentation
#define EINA_ITERATOR_FOREACH | ( | itr, | |
data | |||
) |
Macro to iterate over all elements easily.
- Parameters
-
itr The iterator to use. data Where to store * data, must be a pointer support getting its address since * eina_iterator_next() requires a pointer to pointer!
This macro is a convenient way to use iterators, very similar to EINA_LIST_FOREACH().
This macro can be used for freeing the data of a list, like in the following example. It has the same goal as the one documented in EINA_LIST_FOREACH(), but using iterators:
- Note
- this example is not optimal algorithm to release a list since it will walk the list twice, but it serves as an example. For optimized version use EINA_LIST_FREE()
- Warning
- The order in which the elements will be traversed depends on the underlying container and shouldn't be relied upon.
- unless explicitly stated in functions returning iterators, do not modify the iterated object while you walk it, in this example using lists, do not remove list nodes or you might crash! This is not a limitiation of iterators themselves, rather in the iterators implementations to keep them as simple and fast as possible.
- Examples:
- eina_file_01.c, eina_list_03.c, and eina_tiler_01.c.
Referenced by eina_file_dir_list().
Function Documentation
void eina_iterator_free | ( | Eina_Iterator * | iterator | ) |
Free an iterator.
- Parameters
-
iterator The iterator to free.
This function frees iterator
if it is not NULL
;
- Examples:
- eina_file_01.c, eina_hash_01.c, eina_hash_03.c, eina_hash_04.c, eina_hash_05.c, eina_hash_06.c, eina_hash_07.c, eina_iterator_01.c, eina_list_03.c, and eina_tiler_01.c.
References _Eina_Iterator::free.
Referenced by eina_file_dir_list(), and eina_hash_foreach().
void* eina_iterator_container_get | ( | Eina_Iterator * | iterator | ) |
Return the container of an iterator.
- Parameters
-
iterator The iterator.
- Returns
- The container which created the iterator.
This function returns the container which created iterator
. If iterator
is NULL
, this function returns NULL
.
- Examples:
- eina_iterator_01.c.
References _Eina_Iterator::get_container.
Eina_Bool eina_iterator_next | ( | Eina_Iterator * | iterator, |
void ** | data | ||
) |
Return the value of the current element and go to the next one.
- Parameters
-
iterator The iterator. data The data of the element.
- Returns
- EINA_TRUE on success, EINA_FALSE otherwise.
This function returns the value of the current element pointed by iterator
in data
, then goes to the next element. If iterator
is NULL
or if a problem occurred, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
- Examples:
- eina_hash_01.c, eina_hash_03.c, eina_hash_04.c, eina_hash_05.c, eina_hash_06.c, eina_hash_07.c, and eina_iterator_01.c.
References EINA_FALSE, and _Eina_Iterator::next.
void eina_iterator_foreach | ( | Eina_Iterator * | iterator, |
Eina_Each_Cb | callback, | ||
const void * | fdata | ||
) |
Iterate over the container and execute a callback on each element.
- Parameters
-
iterator The iterator. callback The callback called on each iteration. fdata The data passed to the callback.
This function iterates over the elements pointed by iterator
, beginning from the current element. For Each element, the callback cb
is called with the data fdata
. If iterator
is NULL
, the function returns immediately. Also, if cb
returns EINA_FALSE
, the iteration stops at that point, if cb
returns EINA_TRUE
the iteration continues.
- Examples:
- eina_iterator_01.c.
References eina_iterator_lock(), eina_iterator_unlock(), EINA_TRUE, _Eina_Iterator::get_container, and _Eina_Iterator::next.
Referenced by eina_hash_foreach().
Eina_Bool eina_iterator_lock | ( | Eina_Iterator * | iterator | ) |
Lock the container of the iterator.
- Parameters
-
iterator The iterator.
- Returns
- EINA_TRUE on success, EINA_FALSE otherwise.
If the container of the iterator
permits it, it will be locked. When a container is locked calling eina_iterator_foreach() on it will return immediately. If iterator
is NULL
or if a problem occurred, EINA_FALSE is returned, otherwise EINA_TRUE is returned. If the container isn't lockable, it will return EINA_TRUE.
- Warning
- None of the existing eina data structures are lockable.
References EINA_FALSE, EINA_TRUE, and _Eina_Iterator::lock.
Referenced by eina_iterator_foreach().
Eina_Bool eina_iterator_unlock | ( | Eina_Iterator * | iterator | ) |
Unlock the container of the iterator.
- Parameters
-
iterator The iterator.
- Returns
- EINA_TRUE on success, EINA_FALSE otherwise.
If the container of the iterator
permits it and was previously locked, it will be unlocked. If iterator
is NULL
or if a problem occurred, EINA_FALSE is returned, otherwise EINA_TRUE is returned. If the container is not lockable, it will return EINA_TRUE.
- Warning
- None of the existing eina data structures are lockable.
References EINA_FALSE, EINA_TRUE, and _Eina_Iterator::unlock.
Referenced by eina_iterator_foreach().