dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix docs and add clone and reversed iterator calls. 

* docs: be clear if it's a copy or in-place.

 * clone: add some apis to create a copy while operates, sort should
   do the same.

 * reversed iterator: new call to walk the list reversed, will make
   life easier in some cases.



SVN revision: 39515
This commit is contained in:
Gustavo Sverzut Barbieri 2009-03-17 12:52:38 +00:00
parent c21896a948
commit 56d1e979ce
2 changed files with 140 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
legacy/eina/src/include/eina_list.h
View File

@ -94,6 +94,8 @@ EAPI Eina_List *eina_list_free (Eina_List *list);
EAPI void *eina_list_nth(const Eina_List *list, unsigned int n) EINA_PURE EINA_WARN_UNUSED_RESULT;
EAPI Eina_List *eina_list_nth_list (const Eina_List *list, unsigned int n) EINA_PURE EINA_WARN_UNUSED_RESULT;
EAPI Eina_List *eina_list_reverse (Eina_List *list) EINA_WARN_UNUSED_RESULT;
EAPI Eina_List *eina_list_reverse_clone(const Eina_List *list) EINA_WARN_UNUSED_RESULT;
EAPI Eina_List *eina_list_clone(const Eina_List *list) EINA_WARN_UNUSED_RESULT;
EAPI Eina_List *eina_list_sort (Eina_List *list, unsigned int size, Eina_Compare_Cb func) EINA_ARG_NONNULL(3) EINA_WARN_UNUSED_RESULT;
EAPI Eina_List *eina_list_merge (Eina_List *left, Eina_List *right) EINA_WARN_UNUSED_RESULT;
EAPI Eina_List *eina_list_sorted_merge(Eina_List *left, Eina_List *right, Eina_Compare_Cb func) EINA_ARG_NONNULL(3) EINA_WARN_UNUSED_RESULT;

140
legacy/eina/src/lib/eina_list.c
View File

@ -244,6 +244,19 @@ eina_list_iterator_next(Eina_Iterator_List *it, void **data)
return EINA_TRUE;
}
static Eina_Bool
eina_list_iterator_prev(Eina_Iterator_List *it, void **data)
{
EINA_MAGIC_CHECK_LIST_ITERATOR(it);
if (it->current == NULL) return EINA_FALSE;
if (data) *data = eina_list_data_get(it->current);
it->current = eina_list_prev(it->current);
return EINA_TRUE;
}
static Eina_List *
eina_list_iterator_get_container(Eina_Iterator_List *it)
{
@ -1225,11 +1238,17 @@ static inline unsigned int eina_list_count(const Eina_List *list);
* @brief Reverse all the elements in the list.
*
* @param list The list to reverse.
* @return The list after it has been reversed.
* @return The list head after it has been reversed.
*
* This function reverses the order of all elements in @p list, so the
* last member is now first, and so on. If @p list is @c NULL, this
* functon returns @c NULL.
*
* @note @b in-place: this will change the given list, so you should
* now point to the new list head that is returned by this function.
*
* @see eina_list_reverse_clone()
* @see eina_list_iterator_reversed_new()
*/
EAPI Eina_List *
eina_list_reverse(Eina_List *list)
@ -1257,6 +1276,73 @@ eina_list_reverse(Eina_List *list)
return list;
}
/**
* @brief Clone (copy) all the elements in the list in reverse order.
*
* @param list The list to reverse.
* @return The new list that has been reversed.
*
* This function reverses the order of all elements in @p list, so the
* last member is now first, and so on. If @p list is @c NULL, this
* functon returns @c NULL. This returns a copy of the given list.
*
* @note @b copy: this will copy the list and you should then
* eina_list_free() when it is not required anymore.
*
* @see eina_list_reverse()
* @see eina_list_clone()
*/
EAPI Eina_List *
eina_list_reverse_clone(const Eina_List *list)
{
const Eina_List *l;
Eina_List *clone;
void *data;
if (!list) return NULL;
EINA_MAGIC_CHECK_LIST(list);
clone = NULL;
EINA_LIST_FOREACH(list, l, data)
clone = eina_list_prepend(clone, data);
return clone;
}
/**
* @brief Clone (copy) all the elements in the list in exact order.
*
* @param list The list to clone.
* @return The new list that has been cloned.
*
* This function clone in order of all elements in @p list. If @p list
* is @c NULL, this functon returns @c NULL. This returns a copy of
* the given list.
*
* @note @b copy: this will copy the list and you should then
* eina_list_free() when it is not required anymore.
*
* @see eina_list_reverse_clone()
*/
EAPI Eina_List *
eina_list_clone(const Eina_List *list)
{
const Eina_List *l;
Eina_List *clone;
void *data;
if (!list) return NULL;
EINA_MAGIC_CHECK_LIST(list);
clone = NULL;
EINA_LIST_FOREACH(list, l, data)
clone = eina_list_append(clone, data);
return clone;
}
/**
* @brief Sort a list according to the ordering func will return.
*
@ -1264,7 +1350,7 @@ eina_list_reverse(Eina_List *list)
* @param size The length of the list to sort.
* @param func A function pointer that can handle comparing the list data
* nodes.
* @return A new sorted list.
* @return the new head of list.
*
* This function sorts @p list. @p size if the number of the first
* element to sort. If @p size is 0 or greater than the number of
@ -1272,6 +1358,9 @@ eina_list_reverse(Eina_List *list)
* compare two elements of @p list. If @p list or @p func are @c NULL,
* this function returns @c NULL.
*
* @note @b in-place: this will change the given list, so you should
* now point to the new list head that is returned by this function.
*
* Example:
* @code
* int
@ -1594,6 +1683,53 @@ eina_list_iterator_new(const Eina_List *list)
return &it->iterator;
}
/**
* @brief Returned a new reversed iterator asociated to a list.
*
* @param list The list.
* @return A new iterator.
*
* This function returns a newly allocated iterator associated to @p
* list. If @p list is @c NULL or the count member of @p list is less
* or equal than 0, this function still returns a valid iterator that
* will always return false on eina_iterator_next(), thus keeping API
* sane.
*
* Unlike eina_list_iterator_new(), this will walk the list backwards.
*
* If the memory can not be allocated, NULL is returned and
* #EINA_ERROR_OUT_OF_MEMORY is set. Otherwise, a valid iterator is
* returned.
*
* @warning if the list structure changes then the iterator becomes
* invalid! That is, if you add or remove nodes this iterator
* behavior is undefined and your program may crash!
*/
EAPI Eina_Iterator *
eina_list_iterator_reversed_new(const Eina_List *list)
{
Eina_Iterator_List *it;
eina_error_set(0);
it = calloc(1, sizeof (Eina_Iterator_List));
if (!it) {
eina_error_set(EINA_ERROR_OUT_OF_MEMORY);
return NULL;
}
EINA_MAGIC_SET(it, EINA_MAGIC_LIST_ITERATOR);
EINA_MAGIC_SET(&it->iterator, EINA_MAGIC_ITERATOR);
it->head = eina_list_last(list);
it->current = it->head;
it->iterator.next = FUNC_ITERATOR_NEXT(eina_list_iterator_prev);
it->iterator.get_container = FUNC_ITERATOR_GET_CONTAINER(eina_list_iterator_get_container);
it->iterator.free = FUNC_ITERATOR_FREE(eina_list_iterator_free);
return &it->iterator;
}
/**
* @brief Returned a new accessor asociated to a list.
*