kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
efl/legacy/eina/src/include/eina_inlist.h

91 lines
3.5 KiB
C
Raw Normal View History

License changes (BSD -> LGPL) SVN revision: 35360
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/>.
*/
Adding turran work to unify EFL data types and functions. SVN revision: 35248
2008-07-30 05:46:55 -07:00
#ifndef EINA_INLIST_H_
#define EINA_INLIST_H_
Use only the needed headers per file and remove some warning. SVN revision: 35253
2008-07-30 06:35:49 -07:00
#include "eina_types.h"
Expose Iterator/Accessor API for Inlist. SVN revision: 35447
2008-08-12 09:02:09 -07:00
#include "eina_iterator.h"
#include "eina_accessor.h"
add missing stddef.h, required by offsetof() SVN revision: 41327
2009-07-14 08:32:01 -07:00
#include <stddef.h>
Use only the needed headers per file and remove some warning. SVN revision: 35253
2008-07-30 06:35:49 -07:00
Adding turran work to unify EFL data types and functions. SVN revision: 35248
2008-07-30 05:46:55 -07:00
/**
fix a bit the documentation, but there are still a lot of doc to write... SVN revision: 41164
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
*
Adding turran work to unify EFL data types and functions. SVN revision: 35248
2008-07-30 05:46:55 -07:00
* @{
*/
typedef struct _Eina_Inlist Eina_Inlist;
struct _Eina_Inlist
{
Eina_Inlist *next;
Eina_Inlist *prev;
Eina_Inlist *last;
};
Add some type checking to Inlined List. SVN revision: 36084
2008-09-18 07:22:48 -07:00
#define EINA_INLIST Eina_Inlist __in_list
Fix EINA_INLIST_GET() macro. now EINA_INLIST_GET(bla)->next will work, before it was like &bla->__in_list->next which is wrong, since __in_list is not a pointer, rather the memory itself. SVN revision: 39210
2009-02-25 08:24:00 -08:00
#define EINA_INLIST_GET(Inlist) (&((Inlist)->__in_list))
Support EINA_INLIST to be anywhere in the struct with _FOREACH macros. Fix pointer arithmetic with EINA_CONTAINER_GET. Change Inlist test to have the int first and not assume a direct cast works. SVN revision: 42366
2009-09-09 07:05:31 -07:00
#define EINA_INLIST_CONTAINER_GET(ptr, type) ((type *) ((char *) ptr - offsetof(type, __in_list)))
Add some type checking to Inlined List. SVN revision: 36084
2008-09-18 07:22:48 -07:00
eina gets lots of gcc attributes to its api. this should help with optimizations and code correctness, please see "info gcc" for detailed explanation on these. if you experience some functions not working as expected, please double check if they're not marked with EINA_PURE or EINA_CONST, maybe I misused them. Remove the macro and try again. brief explanation: * EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some function, it will emit a warning (and -Werror will make it an error). This way it will be harder to miss the attribution "l = eina_list_append(l, v)". * EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL argument, or some tool (ie: clang) finds it could get a NULL but this is not accepted by API, then a warning will be emitted. This will help those that still use eina_hash_add() as if it is evas_hash_add(). * EINA_MALLOC: any non-NULL pointer it returns cannot alias any other pointer valid when function returns. * EINA_PURE: function have no effects other than the return and this return just depend on parameters and/or globals. You might call this function in a loop a thousand times and it will return the same value, thus you may move this function outside the loop and remove it. * EINA_CONST: stricter version of EINA_PURE, it will not check for global parameters, that is, you cannot consider pointer arguments. Use it for math things like "int sqrt(int)". * EINA_PRINTF(fmt, arg): will check format parameter specified in position "fmt" and passed arguments starting at position "arg", it will check for things like giving integers where short or strings were expected. * EINA_SCANF(fmt, arg): similar to eina_printf(). * EINA_FORMAT(fmt): for use with things like dgettext(), it will get a printf-like format string and modifies it. Please review and test it with your software, make sure you make clean before you install the new version so it has any effect. If you find some functions are missing EINA_WARN_UNUSED_RESULT and EINA_ARG_NONNULL or others, please add them. SVN revision: 38323
2008-12-26 05:17:51 -08:00
EAPI Eina_Inlist * eina_inlist_append(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
EAPI Eina_Inlist * eina_inlist_prepend(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
eina safety checks. safety checks will report null pointers and other error conditions on public api's and can be disabled by compile time check. note that in order to have these checks working we need to make EINA_ARG_NONNULL() void, otherwise GCC can remove these checks since they're known to be false. This commit also make two minor changes: * list and hash accessors and iterators are created even for empty entities. This is correct in my point of view since NULL should indicate error. Having these in were an optimziation, but not worth it, these are not the most common case and hitting this path is not of much cost. * unmarked some parameters as nonnull, mainly on list and inlist. SVN revision: 38327
2008-12-26 10:31:14 -08: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;
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;
eina gets lots of gcc attributes to its api. this should help with optimizations and code correctness, please see "info gcc" for detailed explanation on these. if you experience some functions not working as expected, please double check if they're not marked with EINA_PURE or EINA_CONST, maybe I misused them. Remove the macro and try again. brief explanation: * EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some function, it will emit a warning (and -Werror will make it an error). This way it will be harder to miss the attribution "l = eina_list_append(l, v)". * EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL argument, or some tool (ie: clang) finds it could get a NULL but this is not accepted by API, then a warning will be emitted. This will help those that still use eina_hash_add() as if it is evas_hash_add(). * EINA_MALLOC: any non-NULL pointer it returns cannot alias any other pointer valid when function returns. * EINA_PURE: function have no effects other than the return and this return just depend on parameters and/or globals. You might call this function in a loop a thousand times and it will return the same value, thus you may move this function outside the loop and remove it. * EINA_CONST: stricter version of EINA_PURE, it will not check for global parameters, that is, you cannot consider pointer arguments. Use it for math things like "int sqrt(int)". * EINA_PRINTF(fmt, arg): will check format parameter specified in position "fmt" and passed arguments starting at position "arg", it will check for things like giving integers where short or strings were expected. * EINA_SCANF(fmt, arg): similar to eina_printf(). * EINA_FORMAT(fmt): for use with things like dgettext(), it will get a printf-like format string and modifies it. Please review and test it with your software, make sure you make clean before you install the new version so it has any effect. If you find some functions are missing EINA_WARN_UNUSED_RESULT and EINA_ARG_NONNULL or others, please add them. SVN revision: 38323
2008-12-26 05:17:51 -08:00
EAPI Eina_Inlist * eina_inlist_remove(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
eina safety checks. safety checks will report null pointers and other error conditions on public api's and can be disabled by compile time check. note that in order to have these checks working we need to make EINA_ARG_NONNULL() void, otherwise GCC can remove these checks since they're known to be false. This commit also make two minor changes: * list and hash accessors and iterators are created even for empty entities. This is correct in my point of view since NULL should indicate error. Having these in were an optimziation, but not worth it, these are not the most common case and hitting this path is not of much cost. * unmarked some parameters as nonnull, mainly on list and inlist. SVN revision: 38327
2008-12-26 10:31:14 -08:00
EAPI Eina_Inlist * eina_inlist_find(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT;
eina gets lots of gcc attributes to its api. this should help with optimizations and code correctness, please see "info gcc" for detailed explanation on these. if you experience some functions not working as expected, please double check if they're not marked with EINA_PURE or EINA_CONST, maybe I misused them. Remove the macro and try again. brief explanation: * EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some function, it will emit a warning (and -Werror will make it an error). This way it will be harder to miss the attribution "l = eina_list_append(l, v)". * EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL argument, or some tool (ie: clang) finds it could get a NULL but this is not accepted by API, then a warning will be emitted. This will help those that still use eina_hash_add() as if it is evas_hash_add(). * EINA_MALLOC: any non-NULL pointer it returns cannot alias any other pointer valid when function returns. * EINA_PURE: function have no effects other than the return and this return just depend on parameters and/or globals. You might call this function in a loop a thousand times and it will return the same value, thus you may move this function outside the loop and remove it. * EINA_CONST: stricter version of EINA_PURE, it will not check for global parameters, that is, you cannot consider pointer arguments. Use it for math things like "int sqrt(int)". * EINA_PRINTF(fmt, arg): will check format parameter specified in position "fmt" and passed arguments starting at position "arg", it will check for things like giving integers where short or strings were expected. * EINA_SCANF(fmt, arg): similar to eina_printf(). * EINA_FORMAT(fmt): for use with things like dgettext(), it will get a printf-like format string and modifies it. Please review and test it with your software, make sure you make clean before you install the new version so it has any effect. If you find some functions are missing EINA_WARN_UNUSED_RESULT and EINA_ARG_NONNULL or others, please add them. SVN revision: 38323
2008-12-26 05:17:51 -08:00
EAPI Eina_Inlist * eina_inlist_promote(Eina_Inlist *list, Eina_Inlist *item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
EAPI Eina_Inlist * eina_inlist_demote(Eina_Inlist *list, Eina_Inlist *item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
inlist: add count. SVN revision: 39465
2009-03-13 04:32:56 -07:00
EAPI unsigned int eina_inlist_count(const Eina_Inlist *list) EINA_WARN_UNUSED_RESULT;
eina gets lots of gcc attributes to its api. this should help with optimizations and code correctness, please see "info gcc" for detailed explanation on these. if you experience some functions not working as expected, please double check if they're not marked with EINA_PURE or EINA_CONST, maybe I misused them. Remove the macro and try again. brief explanation: * EINA_WARN_UNUSED_RESULT: if you forgot to use the return of some function, it will emit a warning (and -Werror will make it an error). This way it will be harder to miss the attribution "l = eina_list_append(l, v)". * EINA_ARG_NONNULL(index, index...): if you give it an explicit NULL argument, or some tool (ie: clang) finds it could get a NULL but this is not accepted by API, then a warning will be emitted. This will help those that still use eina_hash_add() as if it is evas_hash_add(). * EINA_MALLOC: any non-NULL pointer it returns cannot alias any other pointer valid when function returns. * EINA_PURE: function have no effects other than the return and this return just depend on parameters and/or globals. You might call this function in a loop a thousand times and it will return the same value, thus you may move this function outside the loop and remove it. * EINA_CONST: stricter version of EINA_PURE, it will not check for global parameters, that is, you cannot consider pointer arguments. Use it for math things like "int sqrt(int)". * EINA_PRINTF(fmt, arg): will check format parameter specified in position "fmt" and passed arguments starting at position "arg", it will check for things like giving integers where short or strings were expected. * EINA_SCANF(fmt, arg): similar to eina_printf(). * EINA_FORMAT(fmt): for use with things like dgettext(), it will get a printf-like format string and modifies it. Please review and test it with your software, make sure you make clean before you install the new version so it has any effect. If you find some functions are missing EINA_WARN_UNUSED_RESULT and EINA_ARG_NONNULL or others, please add them. SVN revision: 38323
2008-12-26 05:17:51 -08:00
EAPI Eina_Iterator *eina_inlist_iterator_new(const Eina_Inlist *in_list) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
EAPI Eina_Accessor *eina_inlist_accessor_new(const Eina_Inlist *in_list) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
Expose Iterator/Accessor API for Inlist. SVN revision: 35447
2008-08-12 09:02:09 -07:00
Support EINA_INLIST to be anywhere in the struct with _FOREACH macros. Fix pointer arithmetic with EINA_CONTAINER_GET. Change Inlist test to have the int first and not assume a direct cast works. SVN revision: 42366
2009-09-09 07:05:31 -07:00
/* This two macros are helpers for the _FOREACH ones, don't use them */
Avoid clashes. SVN revision: 42368
2009-09-09 08:53:50 -07:00
#define _EINA_INLIST_OFFSET(ref) ((char*)&(ref)->__in_list - (char*)(ref))
#define _EINA_INLIST_CONTAINER(ref, ptr) (void*)((char*)(ptr) - _EINA_INLIST_OFFSET(ref))
Support EINA_INLIST to be anywhere in the struct with _FOREACH macros. Fix pointer arithmetic with EINA_CONTAINER_GET. Change Inlist test to have the int first and not assume a direct cast works. SVN revision: 42366
2009-09-09 07:05:31 -07:00
* eina: This initialisation is not needed, but will reduce llvm warning noise. SVN revision: 42935
2009-10-07 05:06:52 -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))
#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))
Support EINA_INLIST to be anywhere in the struct with _FOREACH macros. Fix pointer arithmetic with EINA_CONTAINER_GET. Change Inlist test to have the int first and not assume a direct cast works. SVN revision: 42366
2009-09-09 07:05:31 -07:00
Adding turran work to unify EFL data types and functions. SVN revision: 35248
2008-07-30 05:46:55 -07:00
fix a bit the documentation, but there are still a lot of doc to write... SVN revision: 41164
2009-06-22 13:03:58 -07:00
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
Adding turran work to unify EFL data types and functions. SVN revision: 35248
2008-07-30 05:46:55 -07:00
#endif /*EINA_INLIST_H_*/