Eina_Clist is a compact (inline) list implementation.
More...
Macros |
#define | EINA_CLIST_FOR_EACH(cursor, list) for ((cursor) = (list)->next; (cursor) != (list); (cursor) = (cursor)->next) |
| Iterate through the list.
|
#define | EINA_CLIST_FOR_EACH_SAFE(cursor, cursor2, list) |
| Iterate through the list, with safety against removal.
|
#define | EINA_CLIST_FOR_EACH_ENTRY(elem, list, type, field) |
| Iterate through the list using a list entry.
|
#define | EINA_CLIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, list, type, field) |
| Iterate through the list using a list entry, with safety against removal.
|
#define | EINA_CLIST_FOR_EACH_REV(cursor, list) for ((cursor) = (list)->prev; (cursor) != (list); (cursor) = (cursor)->prev) |
| Iterate through the list in reverse order.
|
#define | EINA_CLIST_FOR_EACH_SAFE_REV(cursor, cursor2, list) |
| Iterate through the list in reverse order, with safety against removal.
|
#define | EINA_CLIST_FOR_EACH_ENTRY_REV(elem, list, type, field) |
| Iterate through the list in reverse order using a list entry.
|
#define | EINA_CLIST_FOR_EACH_ENTRY_SAFE_REV(cursor, cursor2, list, type, field) |
| Iterate through the list in reverse order using a list entry, with safety against removal.
|
#define | EINA_CLIST_INIT(list) { &(list), &(list) } |
| Macros for statically initialized lists.
|
#define | EINA_CLIST_ENTRY(elem, type, field) ((type *)((char *)(elem) - (unsigned long)(&((type *)0)->field))) |
| Get pointer to object containing list element.
|
Detailed Description
Eina_Clist is a compact (inline) list implementation.
Elements of this list are members of the structs stored in the list
Advantages over Eina_List and Eina_Inlist :
- uses less memory (two machine words per item)
- allows removing items without knowing which list they're in using O(1) time
- no need to keep updating the head pointer as the list is changed
Disadvantages:
- O(N) time to calculate list length
- requires one list entry in a struct per list (i.e. it's an inlist)
- requires a head/tail pointer
- need to know the list head when moving to next or previous pointer
- Note
- There's no NULL at the end of the list, the last item points to the head.
-
List heads must be initialized with EINA_CLIST_INIT or by calling eina_clist_element_init
Define a list like so:
struct gadget
{
struct Eina_Clist entry; <-- doesn
't have to be the first item in the struct
int a, b;
};
static Eina_Clist global_gadgets = EINA_CLIST_INIT( global_gadgets );
or
struct some_global_thing
{
};
Manipulate it like this:
And to iterate over it:
struct gadget *gadget;
{
...
}
Macro Definition Documentation
#define EINA_CLIST_FOR_EACH |
( |
|
cursor, |
|
|
|
list |
|
) |
| for ((cursor) = (list)->next; (cursor) != (list); (cursor) = (cursor)->next) |
Iterate through the list.
- Parameters
-
cursor | The pointer to be used during the interation. |
list | The list to be interated. |
#define EINA_CLIST_FOR_EACH_SAFE |
( |
|
cursor, |
|
|
|
cursor2, |
|
|
|
list |
|
) |
| |
Value:for ((cursor) = (list)->next, (cursor2) = (cursor)->next; \
(cursor) != (list); \
(cursor) = (cursor2), (cursor2) = (cursor)->next)
Iterate through the list, with safety against removal.
- Parameters
-
cursor | The pointer to be used during the interation. |
cursor2 | The auxiliar pointer to be used during the interation. |
list | The list to be interated. |
#define EINA_CLIST_FOR_EACH_ENTRY |
( |
|
elem, |
|
|
|
list, |
|
|
|
type, |
|
|
|
field |
|
) |
| |
Value:
&(elem)->field != (list); \
Iterate through the list using a list entry.
- Parameters
-
elem | The element to be used. |
list | The list to be iterated. |
type | The type of the list. |
field | The field of the element. |
#define EINA_CLIST_FOR_EACH_ENTRY_SAFE |
( |
|
cursor, |
|
|
|
cursor2, |
|
|
|
list, |
|
|
|
type, |
|
|
|
field |
|
) |
| |
Value:
&(cursor)->field != (list); \
(cursor) = (cursor2), \
Iterate through the list using a list entry, with safety against removal.
- Parameters
-
cursor | The pointer to be used during the interation. |
cursor2 | The auxiliar pointer to be used during the interation. |
list | The list to be interated. |
type | The type of the list. |
field | The field of the element. |
#define EINA_CLIST_FOR_EACH_REV |
( |
|
cursor, |
|
|
|
list |
|
) |
| for ((cursor) = (list)->prev; (cursor) != (list); (cursor) = (cursor)->prev) |
Iterate through the list in reverse order.
- Parameters
-
cursor | The pointer to be used during the interation. |
list | The list to be interated. |
#define EINA_CLIST_FOR_EACH_SAFE_REV |
( |
|
cursor, |
|
|
|
cursor2, |
|
|
|
list |
|
) |
| |
Value:for ((cursor) = (list)->prev, (cursor2) = (cursor)->prev; \
(cursor) != (list); \
(cursor) = (cursor2), (cursor2) = (cursor)->prev)
Iterate through the list in reverse order, with safety against removal.
- Parameters
-
cursor | The pointer to be used during the interation. |
cursor2 | The auxiliar pointer to be used during the interation. |
list | The list to be interated. |
#define EINA_CLIST_FOR_EACH_ENTRY_REV |
( |
|
elem, |
|
|
|
list, |
|
|
|
type, |
|
|
|
field |
|
) |
| |
Value:
&(elem)->field != (list); \
Iterate through the list in reverse order using a list entry.
- Parameters
-
elem | The element to be used. |
list | The list to be iterated. |
type | The type of the list. |
field | The field of the element. |
#define EINA_CLIST_FOR_EACH_ENTRY_SAFE_REV |
( |
|
cursor, |
|
|
|
cursor2, |
|
|
|
list, |
|
|
|
type, |
|
|
|
field |
|
) |
| |
Value:
&(cursor)->field != (list); \
(cursor) = (cursor2), \
Iterate through the list in reverse order using a list entry, with safety against removal.
- Parameters
-
cursor | The pointer to be used during the interation. |
cursor2 | The auxiliar pointer to be used during the interation. |
list | The list to be interated. |
type | The type of the list. |
field | The field of the element. |
#define EINA_CLIST_INIT |
( |
|
list | ) |
{ &(list), &(list) } |
Macros for statically initialized lists.
- Parameters
-
#define EINA_CLIST_ENTRY |
( |
|
elem, |
|
|
|
type, |
|
|
|
field |
|
) |
| ((type *)((char *)(elem) - (unsigned long)(&((type *)0)->field))) |
Get pointer to object containing list element.
- Parameters
-
elem | The element to be used. |
type | The type of the element. |
field | The field of the element. |
Typedef Documentation
This is the list head and the list entry.
- Since
- 1.1.0
Function Documentation
Add an element after the specified one.
- Parameters
-
elem | An element in the list |
to_add | The element to add to the list |
- Precondition
- The list head must be initialized once before adding anything.
-
The element is not in any list.
- Note
- There's no need to initialize an element before adding it to the list.
- Since
- 1.1.0
Add an element before the specified one.
- Parameters
-
elem | An element in the list |
to_add | The element to add to the list |
- Precondition
- The list head must be initialized once before adding anything.
-
The element is not in any list.
- Note
- There's no need to initialize an element before adding it to the list.
- Since
- 1.1.0
Add element at the head of the list.
- Parameters
-
list | The list |
elem | An element |
- Precondition
- The list head must be initialized once before adding anything.
-
The element is not in any list.
- Note
- There's no need to initialize an element before adding it to the list.
- Since
- 1.1.0
Add element at the tail of the list.
- Parameters
-
list | The list |
elem | An element |
- Precondition
- The list head must be initialized once before adding anything.
-
The element is not in any list.
- Note
- There's no need to initialize an element before adding it to the list.
- Since
- 1.1.0
static void eina_clist_element_init |
( |
Eina_Clist * |
elem | ) |
|
|
inlinestatic |
Init an (unlinked) element.
Call this function on elements that have not been added to the list if you want eina_clist_element_init() to work correctly
- Parameters
-
- Precondition
- The element is not in any list.
- Postcondition
- The element is marked as not being in any list
- Note
- It is not necessary to call this before adding an element to this list.
- Since
- 1.1.0
static int eina_clist_element_is_linked |
( |
Eina_Clist * |
elem | ) |
|
|
inlinestatic |
Check if an element is in a list or not.
- Parameters
-
- Precondition
- Either eina_clist_element_init() has been called on elem, it has been added to a list or remove from a list.
- Since
- 1.1.0
static void eina_clist_remove |
( |
Eina_Clist * |
elem | ) |
|
|
inlinestatic |
Remove an element from its list.
- Parameters
-
- Precondition
- The element is in a list already
- Postcondition
- The element is marked as not being in any list
- Since
- 1.1.0
Get the next element.
- Parameters
-
list | The list |
elem | An element |
- Precondition
- elem is in list
- Returns
- The element after elem in list or
NULL
if elem is last in list
- Since
- 1.1.0
Get the previous element.
- Parameters
-
list | The list |
elem | An element |
- Returns
- The element before elem or NULL if elem is the first in the list
- Since
- 1.1.0
Get the first element.
- Parameters
-
- Returns
- The first element in list or NULL if list is empty
- Since
- 1.1.0
Get the last element.
- Parameters
-
- Returns
- The last element in list or NULL if list is empty
- Since
- 1.1.0
static int eina_clist_empty |
( |
const Eina_Clist * |
list | ) |
|
|
inlinestatic |
Check if a list is empty.
- Parameters
-
- Returns
- non-zero if list is empty, zero if it is not
- Since
- 1.1.0
Initialize a list.
- Parameters
-
- Precondition
- The list is uninitialized
- Postcondition
- The list contains no items
- Note
- Don't call this function on a list with items
-
This function must be called. Don't try do initialize the list by zero'ing out the list head.
- Since
- 1.1.0
static unsigned int eina_clist_count |
( |
const Eina_Clist * |
list | ) |
|
|
inlinestatic |
Count the elements of a list.
- Parameters
-
- Returns
- The number of items in the list
- Since
- 1.1.0
Move all elements from src to the tail of dst.
- Parameters
-
dst | List to be appended to |
src | List to append |
- Postcondition
- src is initialized but empty after this operation
- Since
- 1.1.0
move all elements from src to the head of dst
- Parameters
-
dst | List to be prepended to |
src | List to prepend |
- Postcondition
- src is initialized but empty after this operation
- Since
- 1.1.0