2008-08-06 11:15:24 -07:00
|
|
|
/* EINA - EFL data type library
|
|
|
|
* Copyright (C) 2002-2008 Carsten Haitzler, Vincent Torri
|
|
|
|
*
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
2008-07-30 05:46:55 -07:00
|
|
|
#ifndef EINA_INLIST_H_
|
|
|
|
#define EINA_INLIST_H_
|
|
|
|
|
2008-07-30 06:35:49 -07:00
|
|
|
#include "eina_types.h"
|
2008-08-12 09:02:09 -07:00
|
|
|
#include "eina_iterator.h"
|
|
|
|
#include "eina_accessor.h"
|
2009-07-14 08:32:01 -07:00
|
|
|
#include <stddef.h>
|
2008-07-30 06:35:49 -07:00
|
|
|
|
2011-04-07 05:21:50 -07:00
|
|
|
/**
|
|
|
|
* @addtogroup Eina_Inline_List_Group Inline List
|
|
|
|
*
|
|
|
|
* @brief These functions provide inline list management.
|
|
|
|
*
|
|
|
|
* Inline lists mean its nodes pointers are part of same memory as
|
|
|
|
* data. This has the benefit of fragmenting memory less and avoiding
|
|
|
|
* @c node->data indirection, but has the drawback of elements only
|
|
|
|
* being able to be part of one single inlist at same time. But it is
|
|
|
|
* possible to have inlist nodes to be part of regular lists created
|
|
|
|
* with eina_list_append() or eina_list_prepend().
|
|
|
|
*
|
|
|
|
* Inline lists have their purposes, but if you don't know what those purposes are, go with
|
|
|
|
* regular lists instead.
|
|
|
|
*
|
|
|
|
* Tip: When using inlists in more than one place (that is, passing them around
|
|
|
|
* functions or keeping a pointer to them in a structure) it's more correct
|
|
|
|
* to keep a pointer to the first container, and not a pointer to the first
|
|
|
|
* inlist item (mostly they are the same, but that's not always correct).
|
|
|
|
* This lets the compiler to do type checking and let the programmer know
|
|
|
|
* exactly what type this list is.
|
|
|
|
*
|
|
|
|
* @code
|
|
|
|
* #include <Eina.h>
|
|
|
|
* #include <stdio.h>
|
|
|
|
*
|
|
|
|
* int
|
|
|
|
* main(void)
|
|
|
|
* {
|
|
|
|
* struct my_struct {
|
|
|
|
* EINA_INLIST;
|
|
|
|
* int a, b;
|
|
|
|
* } *d, *cur;
|
|
|
|
* Eina_Inlist *list, *itr;
|
|
|
|
*
|
|
|
|
* eina_init();
|
|
|
|
*
|
|
|
|
* d = malloc(sizeof(*d));
|
|
|
|
* d->a = 1;
|
|
|
|
* d->b = 10;
|
|
|
|
* list = eina_inlist_append(NULL, EINA_INLIST_GET(d));
|
|
|
|
*
|
|
|
|
* d = malloc(sizeof(*d));
|
|
|
|
* d->a = 2;
|
|
|
|
* d->b = 20;
|
|
|
|
* list = eina_inlist_append(list, EINA_INLIST_GET(d));
|
|
|
|
*
|
|
|
|
* d = malloc(sizeof(*d));
|
|
|
|
* d->a = 3;
|
|
|
|
* d->b = 30;
|
|
|
|
* list = eina_inlist_prepend(list, EINA_INLIST_GET(d));
|
|
|
|
*
|
|
|
|
* printf("list=%p\n", list);
|
|
|
|
* EINA_INLIST_FOREACH(list, cur)
|
|
|
|
* printf("\ta=%d, b=%d\n", cur->a, cur->b);
|
|
|
|
*
|
|
|
|
* list = eina_inlist_remove(list, EINA_INLIST_GET(d));
|
|
|
|
* free(d);
|
|
|
|
* printf("list=%p\n", list);
|
|
|
|
* for (itr = list; itr != NULL; itr = itr->next)
|
|
|
|
* {
|
|
|
|
* cur = EINA_INLIST_CONTAINER_GET(itr, struct my_struct);
|
|
|
|
* printf("\ta=%d, b=%d\n", cur->a, cur->b);
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* while (list)
|
|
|
|
* {
|
|
|
|
* Eina_Inlist *aux = list;
|
|
|
|
* list = eina_inlist_remove(list, list);
|
|
|
|
* free(aux);
|
|
|
|
* }
|
|
|
|
*
|
|
|
|
* eina_shutdown();
|
|
|
|
*
|
|
|
|
* return 0;
|
|
|
|
* }
|
|
|
|
* @endcode
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2008-07-30 05:46:55 -07:00
|
|
|
/**
|
2009-06-22 13:03:58 -07:00
|
|
|
* @addtogroup Eina_Data_Types_Group Data Types
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup Eina_Containers_Group Containers
|
|
|
|
*
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @defgroup Eina_Inline_List_Group Inline List
|
|
|
|
*
|
2008-07-30 05:46:55 -07:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
2009-12-27 00:45:30 -08:00
|
|
|
/**
|
|
|
|
* @typedef Eina_Inlist
|
|
|
|
* Inlined list type.
|
|
|
|
*/
|
2008-07-30 05:46:55 -07:00
|
|
|
typedef struct _Eina_Inlist Eina_Inlist;
|
2009-12-27 00:45:30 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @struct _Eina_Inlist
|
|
|
|
* Inlined list type.
|
|
|
|
*/
|
2008-07-30 05:46:55 -07:00
|
|
|
struct _Eina_Inlist
|
|
|
|
{
|
2009-12-27 00:45:30 -08:00
|
|
|
Eina_Inlist *next; /**< next node */
|
|
|
|
Eina_Inlist *prev; /**< previous node */
|
|
|
|
Eina_Inlist *last; /**< last node */
|
2008-07-30 05:46:55 -07:00
|
|
|
};
|
2011-01-28 08:05:12 -08:00
|
|
|
/** Used for declaring an inlist member in a struct */
|
2008-09-18 07:22:48 -07:00
|
|
|
#define EINA_INLIST Eina_Inlist __in_list
|
2011-01-28 08:05:12 -08:00
|
|
|
/** Utility macro to get the inlist object of a struct */
|
2010-10-22 23:41:45 -07:00
|
|
|
#define EINA_INLIST_GET(Inlist) (& ((Inlist)->__in_list))
|
2011-01-28 08:05:12 -08:00
|
|
|
/** Utility macro to get the container object of an inlist */
|
2010-10-22 23:41:45 -07:00
|
|
|
#define EINA_INLIST_CONTAINER_GET(ptr, \
|
2010-07-27 19:37:05 -07:00
|
|
|
type) ((type *)((char *)ptr - \
|
|
|
|
offsetof(type, __in_list)))
|
|
|
|
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a new node to end of a list.
|
|
|
|
*
|
|
|
|
* @note this code is meant to be fast: appends are O(1) and do not
|
|
|
|
* walk @a list.
|
|
|
|
*
|
|
|
|
* @note @a new_l is considered to be in no list. If it was in another
|
|
|
|
* list before, eina_inlist_remove() it before adding. No
|
|
|
|
* check of @a new_l prev and next pointers is done, so it's safe
|
|
|
|
* to have them uninitialized.
|
|
|
|
*
|
|
|
|
* @param list existing list head or NULL to create a new list.
|
|
|
|
* @param new_l new list node, must not be NULL.
|
|
|
|
*
|
|
|
|
* @return the new list head. Use it and not @a list anymore.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_append(Eina_Inlist *in_list,
|
|
|
|
Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a new node to beginning of list.
|
|
|
|
*
|
|
|
|
* @note this code is meant to be fast: appends are O(1) and do not
|
|
|
|
* walk @a list.
|
|
|
|
*
|
|
|
|
* @note @a new_l is considered to be in no list. If it was in another
|
|
|
|
* list before, eina_inlist_remove() it before adding. No
|
|
|
|
* check of @a new_l prev and next pointers is done, so it's safe
|
|
|
|
* to have them uninitialized.
|
|
|
|
*
|
|
|
|
* @param list existing list head or NULL to create a new list.
|
|
|
|
* @param new_l new list node, must not be NULL.
|
|
|
|
*
|
|
|
|
* @return the new list head. Use it and not @a list anymore.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_prepend(Eina_Inlist *in_list,
|
|
|
|
Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a new node after the given relative item in list.
|
|
|
|
*
|
|
|
|
* @note this code is meant to be fast: appends are O(1) and do not
|
|
|
|
* walk @a list.
|
|
|
|
*
|
|
|
|
* @note @a new_l is considered to be in no list. If it was in another
|
|
|
|
* list before, eina_inlist_remove() it before adding. No
|
|
|
|
* check of @a new_l prev and next pointers is done, so it's safe
|
|
|
|
* to have them uninitialized.
|
|
|
|
*
|
|
|
|
* @note @a relative is considered to be inside @a list, no checks are
|
|
|
|
* done to confirm that and giving nodes from different lists
|
|
|
|
* will lead to problems. Giving NULL @a relative is the same as
|
|
|
|
* eina_list_append().
|
|
|
|
*
|
|
|
|
* @param list existing list head or NULL to create a new list.
|
|
|
|
* @param new_l new list node, must not be NULL.
|
|
|
|
* @param relative reference node, @a new_l will be added after it.
|
|
|
|
*
|
|
|
|
* @return the new list head. Use it and not @a list anymore.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_append_relative(Eina_Inlist *in_list,
|
|
|
|
Eina_Inlist *in_item,
|
|
|
|
Eina_Inlist *in_relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a new node before the given relative item in list.
|
|
|
|
*
|
|
|
|
* @note this code is meant to be fast: appends are O(1) and do not
|
|
|
|
* walk @a list.
|
|
|
|
*
|
|
|
|
* @note @a new_l is considered to be in no list. If it was in another
|
|
|
|
* list before, eina_inlist_remove() it before adding. No
|
|
|
|
* check of @a new_l prev and next pointers is done, so it's safe
|
|
|
|
* to have them uninitialized.
|
|
|
|
*
|
|
|
|
* @note @a relative is considered to be inside @a list, no checks are
|
|
|
|
* done to confirm that and giving nodes from different lists
|
|
|
|
* will lead to problems. Giving NULL @a relative is the same as
|
|
|
|
* eina_list_prepend().
|
|
|
|
*
|
|
|
|
* @param list existing list head or NULL to create a new list.
|
|
|
|
* @param new_l new list node, must not be NULL.
|
|
|
|
* @param relative reference node, @a new_l will be added before it.
|
|
|
|
*
|
|
|
|
* @return the new list head. Use it and not @a list anymore.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_prepend_relative(Eina_Inlist *in_list,
|
|
|
|
Eina_Inlist *in_item,
|
|
|
|
Eina_Inlist *in_relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove node from list.
|
|
|
|
*
|
|
|
|
* @note this code is meant to be fast: appends are O(1) and do not
|
|
|
|
* walk @a list.
|
|
|
|
*
|
|
|
|
* @note @a item is considered to be inside @a list, no checks are
|
|
|
|
* done to confirm that and giving nodes from different lists
|
|
|
|
* will lead to problems, especially if @a item is the head since
|
|
|
|
* it will be different from @a list and the wrong new head will
|
|
|
|
* be returned.
|
|
|
|
*
|
|
|
|
* @param list existing list head, must not be NULL.
|
|
|
|
* @param item existing list node, must not be NULL.
|
|
|
|
*
|
|
|
|
* @return the new list head. Use it and not @a list anymore.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_remove(Eina_Inlist *in_list,
|
2010-08-12 23:36:33 -07:00
|
|
|
Eina_Inlist *in_item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Find given node in list, returns itself if found, NULL if not.
|
|
|
|
*
|
|
|
|
* @warning this is an expensive call and has O(n) cost, possibly
|
|
|
|
* walking the whole list.
|
|
|
|
*
|
|
|
|
* @param list existing list to search @a item in, must not be NULL.
|
|
|
|
* @param item what to search for, must not be NULL.
|
|
|
|
*
|
|
|
|
* @return @a item if found, NULL if not.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_find(Eina_Inlist *in_list,
|
2010-08-12 23:36:33 -07:00
|
|
|
Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Move existing node to beginning of list.
|
|
|
|
*
|
|
|
|
* @note this code is meant to be fast: appends are O(1) and do not
|
|
|
|
* walk @a list.
|
|
|
|
*
|
|
|
|
* @note @a item is considered to be inside @a list. No checks are
|
|
|
|
* done to confirm this, and giving nodes from different lists
|
|
|
|
* will lead to problems.
|
|
|
|
*
|
|
|
|
* @param list existing list head or NULL to create a new list.
|
|
|
|
* @param item list node to move to beginning (head), must not be NULL.
|
|
|
|
*
|
|
|
|
* @return the new list head. Use it and not @a list anymore.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_promote(Eina_Inlist *list,
|
2010-08-12 23:36:33 -07:00
|
|
|
Eina_Inlist *item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Move existing node to end of list.
|
|
|
|
*
|
|
|
|
* @note this code is meant to be fast: appends are O(1) and do not
|
|
|
|
* walk @a list.
|
|
|
|
*
|
|
|
|
* @note @a item is considered to be inside @a list. No checks are
|
|
|
|
* done to confirm this, and giving nodes from different lists
|
|
|
|
* will lead to problems.
|
|
|
|
*
|
|
|
|
* @param list existing list head or NULL to create a new list.
|
|
|
|
* @param item list node to move to end (tail), must not be NULL.
|
|
|
|
*
|
|
|
|
* @return the new list head. Use it and not @a list anymore.
|
|
|
|
*/
|
2010-10-22 23:41:45 -07:00
|
|
|
EAPI Eina_Inlist *eina_inlist_demote(Eina_Inlist *list,
|
2010-08-12 23:36:33 -07:00
|
|
|
Eina_Inlist *item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Get the count of the number of items in a list.
|
|
|
|
*
|
|
|
|
* @param list The list whose count to return.
|
|
|
|
* @return The number of members in the list.
|
|
|
|
*
|
|
|
|
* This function returns how many members @p list contains. If the
|
|
|
|
* list is @c NULL, 0 is returned.
|
|
|
|
*
|
|
|
|
* @warning This is an order-N operation and so the time will depend
|
|
|
|
* on the number of elements on the list, so, it might become
|
|
|
|
* slow for big lists!
|
|
|
|
*/
|
2010-08-12 23:36:33 -07:00
|
|
|
EAPI unsigned int eina_inlist_count(const Eina_Inlist *list) EINA_WARN_UNUSED_RESULT;
|
2010-07-27 19:37:05 -07:00
|
|
|
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Returns a new iterator associated 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.
|
|
|
|
*
|
|
|
|
* 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, and if you add or remove nodes iterator
|
|
|
|
* behavior is undefined, and your program may crash!
|
|
|
|
*/
|
2010-08-12 23:36:33 -07:00
|
|
|
EAPI Eina_Iterator *eina_inlist_iterator_new(const Eina_Inlist *in_list) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
|
2011-04-07 05:21:50 -07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Returns a new accessor associated to a list.
|
|
|
|
*
|
|
|
|
* @param list The list.
|
|
|
|
* @return A new accessor.
|
|
|
|
*
|
|
|
|
* This function returns a newly allocated accessor 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 returns NULL. If the memory can
|
|
|
|
* not be allocated, NULL is returned and #EINA_ERROR_OUT_OF_MEMORY is
|
|
|
|
* set. Otherwise, a valid accessor is returned.
|
|
|
|
*/
|
2010-08-12 23:36:33 -07:00
|
|
|
EAPI Eina_Accessor *eina_inlist_accessor_new(const Eina_Inlist *in_list) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
|
2008-08-12 09:02:09 -07:00
|
|
|
|
2009-09-09 07:05:31 -07:00
|
|
|
/* This two macros are helpers for the _FOREACH ones, don't use them */
|
2010-10-22 23:41:45 -07:00
|
|
|
#define _EINA_INLIST_OFFSET(ref) ((char *)&(ref)->__in_list - (char *)(ref))
|
2010-07-27 19:37:05 -07:00
|
|
|
#define _EINA_INLIST_CONTAINER(ref, ptr) (void *)((char *)(ptr) - \
|
|
|
|
_EINA_INLIST_OFFSET(ref))
|
|
|
|
|
2010-10-22 23:41:45 -07:00
|
|
|
#define EINA_INLIST_FOREACH(list, l) \
|
|
|
|
for (l = NULL, l = (list ? _EINA_INLIST_CONTAINER(l, list) : NULL); l; \
|
|
|
|
l = (EINA_INLIST_GET(l)->next ? _EINA_INLIST_CONTAINER(l, EINA_INLIST_GET(l)->next) : NULL))
|
2011-02-16 01:34:27 -08:00
|
|
|
#define EINA_INLIST_FOREACH_SAFE(list, list2, l) \
|
|
|
|
for (l = (list ? _EINA_INLIST_CONTAINER(l, list) : NULL), list2 = l ? ((EINA_INLIST_GET(l) ? EINA_INLIST_GET(l)->next : NULL)) : NULL; \
|
|
|
|
l; \
|
|
|
|
l = _EINA_INLIST_CONTAINER(l, list2), list2 = list2 ? list2->next : NULL)
|
2010-10-22 23:41:45 -07:00
|
|
|
#define EINA_INLIST_REVERSE_FOREACH(list, l) \
|
|
|
|
for (l = NULL, l = (list ? _EINA_INLIST_CONTAINER(l, list->last) : NULL); \
|
|
|
|
l; l = (EINA_INLIST_GET(l)->prev ? _EINA_INLIST_CONTAINER(l, EINA_INLIST_GET(l)->prev) : NULL))
|
2008-07-30 05:46:55 -07:00
|
|
|
|
2009-06-22 13:03:58 -07:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|
2008-07-30 05:46:55 -07:00
|
|
|
|
2011-04-07 05:21:50 -07:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|
|
|
|
|
2008-07-30 05:46:55 -07:00
|
|
|
#endif /*EINA_INLIST_H_*/
|