2008-08-11 09:30:16 -07:00
|
|
|
/* EINA - EFL data type library
|
2008-09-01 05:42:16 -07:00
|
|
|
* Copyright (C) 2002-2008 Cedric Bail
|
2008-08-11 09:30:16 -07:00
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library;
|
|
|
|
* if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
|
|
# include "config.h"
|
|
|
|
#endif
|
|
|
|
|
2008-08-28 00:46:42 -07:00
|
|
|
#include <stdlib.h>
|
|
|
|
|
2009-08-28 05:03:34 -07:00
|
|
|
#include "eina_config.h"
|
2008-08-11 09:30:16 -07:00
|
|
|
#include "eina_private.h"
|
2009-09-06 15:21:56 -07:00
|
|
|
|
|
|
|
/* undefs EINA_ARG_NONULL() so NULL checks are not compiled out! */
|
2008-12-26 10:31:14 -08:00
|
|
|
#include "eina_safety_checks.h"
|
2009-08-28 05:03:34 -07:00
|
|
|
#include "eina_iterator.h"
|
2008-12-09 05:06:17 -08:00
|
|
|
|
Make it possible to create iterators outside Eina.
Many places in EFL we just create walk something, create a list with
walked data, return, then the user walks it again and then deletes
(which will walk again). For such cases it's way better to define
iterators or accessors.
I'm not moving any EFL code to it now, but if people are interested,
things like evas_render_method_list(), evas_font_available_list(),
evas_objects_at_xy_get(), evas_objects_in_rectangle_get(),
evas_object_smart_members_get() are good candidates. If the subject is
already using Eina list, then you can just use
eina_list_iterator_new() and return it, otherwise you can define your
own iterator, which is very easy.
SVN revision: 37956
2008-12-05 19:41:03 -08:00
|
|
|
/*============================================================================*
|
2010-07-27 19:37:05 -07:00
|
|
|
* Local *
|
|
|
|
*============================================================================*/
|
Make it possible to create iterators outside Eina.
Many places in EFL we just create walk something, create a list with
walked data, return, then the user walks it again and then deletes
(which will walk again). For such cases it's way better to define
iterators or accessors.
I'm not moving any EFL code to it now, but if people are interested,
things like evas_render_method_list(), evas_font_available_list(),
evas_objects_at_xy_get(), evas_objects_in_rectangle_get(),
evas_object_smart_members_get() are good candidates. If the subject is
already using Eina list, then you can just use
eina_list_iterator_new() and return it, otherwise you can define your
own iterator, which is very easy.
SVN revision: 37956
2008-12-05 19:41:03 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @cond LOCAL
|
|
|
|
*/
|
|
|
|
|
2009-09-06 20:32:22 -07:00
|
|
|
static const char EINA_MAGIC_ITERATOR_STR[] = "Eina Iterator";
|
|
|
|
|
2010-07-27 19:37:05 -07:00
|
|
|
#define EINA_MAGIC_CHECK_ITERATOR(d) \
|
|
|
|
do { \
|
|
|
|
if (!EINA_MAGIC_CHECK(d, EINA_MAGIC_ITERATOR)) { \
|
|
|
|
EINA_MAGIC_FAIL(d, EINA_MAGIC_ITERATOR); } \
|
|
|
|
} while(0)
|
Make it possible to create iterators outside Eina.
Many places in EFL we just create walk something, create a list with
walked data, return, then the user walks it again and then deletes
(which will walk again). For such cases it's way better to define
iterators or accessors.
I'm not moving any EFL code to it now, but if people are interested,
things like evas_render_method_list(), evas_font_available_list(),
evas_objects_at_xy_get(), evas_objects_in_rectangle_get(),
evas_object_smart_members_get() are good candidates. If the subject is
already using Eina list, then you can just use
eina_list_iterator_new() and return it, otherwise you can define your
own iterator, which is very easy.
SVN revision: 37956
2008-12-05 19:41:03 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @endcond
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
2008-08-28 00:46:42 -07:00
|
|
|
/*============================================================================*
|
2010-07-27 19:37:05 -07:00
|
|
|
* Global *
|
|
|
|
*============================================================================*/
|
2008-08-28 00:46:42 -07:00
|
|
|
|
2009-09-06 19:33:54 -07:00
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
* @brief Initialize the iterator module.
|
|
|
|
*
|
|
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
|
|
*
|
|
|
|
* This function sets up the iterator module of Eina. It is called by
|
|
|
|
* eina_init().
|
|
|
|
*
|
|
|
|
* @see eina_init()
|
|
|
|
*/
|
|
|
|
Eina_Bool
|
|
|
|
eina_iterator_init(void)
|
|
|
|
{
|
2009-09-06 20:32:22 -07:00
|
|
|
return eina_magic_string_set(EINA_MAGIC_ITERATOR, EINA_MAGIC_ITERATOR_STR);
|
2009-09-06 19:33:54 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal
|
|
|
|
* @brief Shut down the iterator module.
|
|
|
|
*
|
|
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
|
|
*
|
|
|
|
* This function shuts down the iterator module set up by
|
|
|
|
* eina_iterator_init(). It is called by eina_shutdown().
|
|
|
|
*
|
|
|
|
* @see eina_shutdown()
|
|
|
|
*/
|
|
|
|
Eina_Bool
|
|
|
|
eina_iterator_shutdown(void)
|
|
|
|
{
|
|
|
|
return EINA_TRUE;
|
|
|
|
}
|
|
|
|
|
2009-12-27 00:45:30 -08:00
|
|
|
/*============================================================================*
|
2010-07-27 19:37:05 -07:00
|
|
|
* API *
|
|
|
|
*============================================================================*/
|
2009-12-27 00:45:30 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup Eina_Iterator_Group Iterator Functions
|
|
|
|
*
|
|
|
|
* @brief 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
|
|
|
|
* @ref Eina_Accessor_Group.
|
|
|
|
*
|
|
|
|
* 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().
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2008-09-06 22:44:00 -07:00
|
|
|
/**
|
2008-09-07 00:19:19 -07:00
|
|
|
* @brief Free an iterator.
|
2008-09-06 22:44:00 -07:00
|
|
|
*
|
|
|
|
* @param iterator The iterator to free.
|
|
|
|
*
|
|
|
|
* This function frees @p iterator if it is not @c NULL;
|
|
|
|
*/
|
2008-08-11 09:30:16 -07:00
|
|
|
EAPI void
|
|
|
|
eina_iterator_free(Eina_Iterator *iterator)
|
|
|
|
{
|
Make it possible to create iterators outside Eina.
Many places in EFL we just create walk something, create a list with
walked data, return, then the user walks it again and then deletes
(which will walk again). For such cases it's way better to define
iterators or accessors.
I'm not moving any EFL code to it now, but if people are interested,
things like evas_render_method_list(), evas_font_available_list(),
evas_objects_at_xy_get(), evas_objects_in_rectangle_get(),
evas_object_smart_members_get() are good candidates. If the subject is
already using Eina list, then you can just use
eina_list_iterator_new() and return it, otherwise you can define your
own iterator, which is very easy.
SVN revision: 37956
2008-12-05 19:41:03 -08:00
|
|
|
EINA_MAGIC_CHECK_ITERATOR(iterator);
|
2008-12-26 10:31:14 -08:00
|
|
|
EINA_SAFETY_ON_NULL_RETURN(iterator);
|
|
|
|
EINA_SAFETY_ON_NULL_RETURN(iterator->free);
|
|
|
|
iterator->free(iterator);
|
2008-08-11 09:30:16 -07:00
|
|
|
}
|
|
|
|
|
2008-09-06 22:44:00 -07:00
|
|
|
/**
|
|
|
|
* @brief Return the container of an iterator.
|
|
|
|
*
|
|
|
|
* @param iterator The iterator.
|
|
|
|
* @return The container which created the iterator.
|
|
|
|
*
|
|
|
|
* This function returns the container which created @p iterator. If
|
|
|
|
* @p iterator is @c NULL, this function returns @c NULL.
|
|
|
|
*/
|
2008-08-11 09:30:16 -07:00
|
|
|
EAPI void *
|
|
|
|
eina_iterator_container_get(Eina_Iterator *iterator)
|
|
|
|
{
|
Make it possible to create iterators outside Eina.
Many places in EFL we just create walk something, create a list with
walked data, return, then the user walks it again and then deletes
(which will walk again). For such cases it's way better to define
iterators or accessors.
I'm not moving any EFL code to it now, but if people are interested,
things like evas_render_method_list(), evas_font_available_list(),
evas_objects_at_xy_get(), evas_objects_in_rectangle_get(),
evas_object_smart_members_get() are good candidates. If the subject is
already using Eina list, then you can just use
eina_list_iterator_new() and return it, otherwise you can define your
own iterator, which is very easy.
SVN revision: 37956
2008-12-05 19:41:03 -08:00
|
|
|
EINA_MAGIC_CHECK_ITERATOR(iterator);
|
2010-07-27 19:37:05 -07:00
|
|
|
EINA_SAFETY_ON_NULL_RETURN_VAL(iterator, NULL);
|
2008-12-26 10:31:14 -08:00
|
|
|
EINA_SAFETY_ON_NULL_RETURN_VAL(iterator->get_container, NULL);
|
2008-08-11 09:30:16 -07:00
|
|
|
return iterator->get_container(iterator);
|
|
|
|
}
|
|
|
|
|
2008-09-06 22:44:00 -07:00
|
|
|
/**
|
|
|
|
* @brief Return the value of the current element and go to the next one.
|
|
|
|
*
|
|
|
|
* @param iterator The iterator.
|
|
|
|
* @param data The data of the element.
|
|
|
|
* @return #EINA_TRUE on success, #EINA_FALSE otherwise.
|
|
|
|
*
|
|
|
|
* This function returns the value of the current element pointed by
|
|
|
|
* @p iterator in @p data, then goes to the next element. If @p
|
|
|
|
* iterator is @c NULL or if a problem occured, #EINA_FALSE is
|
|
|
|
* returned, otherwise #EINA_TRUE is returned.
|
|
|
|
*/
|
2008-08-12 01:40:36 -07:00
|
|
|
EAPI Eina_Bool
|
|
|
|
eina_iterator_next(Eina_Iterator *iterator, void **data)
|
2008-08-11 09:30:16 -07:00
|
|
|
{
|
2010-07-27 19:37:05 -07:00
|
|
|
if (!iterator)
|
|
|
|
return EINA_FALSE;
|
|
|
|
|
2008-12-11 05:54:59 -08:00
|
|
|
EINA_MAGIC_CHECK_ITERATOR(iterator);
|
2010-07-27 19:37:05 -07:00
|
|
|
EINA_SAFETY_ON_NULL_RETURN_VAL(iterator, EINA_FALSE);
|
2008-12-26 10:31:14 -08:00
|
|
|
EINA_SAFETY_ON_NULL_RETURN_VAL(iterator->next, EINA_FALSE);
|
2010-07-27 19:37:05 -07:00
|
|
|
EINA_SAFETY_ON_NULL_RETURN_VAL(data, EINA_FALSE);
|
2008-08-12 01:40:36 -07:00
|
|
|
return iterator->next(iterator, data);
|
2008-08-11 09:30:16 -07:00
|
|
|
}
|
|
|
|
|
2008-09-06 22:44:00 -07:00
|
|
|
/**
|
|
|
|
* @brief Iterate over the container and execute a callback on each element.
|
|
|
|
*
|
|
|
|
* @param iterator The iterator.
|
|
|
|
* @param cb The callback called on each iteration.
|
|
|
|
* @param fdata The data passed to the callback.
|
|
|
|
*
|
|
|
|
* This function iterates over the elements pointed by @p iterator,
|
|
|
|
* beginning from the current element. For Each element, the callback
|
2010-06-30 11:41:16 -07:00
|
|
|
* @p cb is called with the data @p fdata. If @p iterator is @c NULL,
|
|
|
|
* the function returns immediatly. Also, if @p cb returns @c
|
|
|
|
* EINA_FALSE, the iteration stops at that point.
|
2008-09-06 22:44:00 -07:00
|
|
|
*/
|
2008-08-11 09:30:16 -07:00
|
|
|
EAPI void
|
|
|
|
eina_iterator_foreach(Eina_Iterator *iterator,
|
2010-07-27 19:37:05 -07:00
|
|
|
Eina_Each cb,
|
|
|
|
const void *fdata)
|
2008-08-11 09:30:16 -07:00
|
|
|
{
|
2008-12-26 10:31:14 -08:00
|
|
|
const void *container;
|
2008-08-11 09:30:16 -07:00
|
|
|
void *data;
|
|
|
|
|
2008-12-11 05:54:59 -08:00
|
|
|
EINA_MAGIC_CHECK_ITERATOR(iterator);
|
2008-12-26 10:31:14 -08:00
|
|
|
EINA_SAFETY_ON_NULL_RETURN(iterator);
|
|
|
|
EINA_SAFETY_ON_NULL_RETURN(iterator->get_container);
|
|
|
|
EINA_SAFETY_ON_NULL_RETURN(iterator->next);
|
|
|
|
EINA_SAFETY_ON_NULL_RETURN(cb);
|
2008-12-11 05:54:59 -08:00
|
|
|
|
2008-08-11 09:30:16 -07:00
|
|
|
container = iterator->get_container(iterator);
|
2008-08-12 01:40:36 -07:00
|
|
|
while (iterator->next(iterator, &data) == EINA_TRUE) {
|
2010-07-27 19:37:05 -07:00
|
|
|
if (cb(container, data, (void *)fdata) != EINA_TRUE)
|
|
|
|
return;
|
|
|
|
}
|
2008-08-11 09:30:16 -07:00
|
|
|
}
|
2008-09-06 22:44:00 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|