#include <cybergarage/typedef.h>
Define Documentation
| #define cg_list_gets |
( |
|
headList | ) |
cg_list_next(headList) |
Get the first actual item from a list for iteration
- Parameters:
-
Typedef Documentation
Prototype for individual list node destructor functions
The generic list interface in CyberLinkC.
Each struct in CyberLinkC, that is designed to be a part of a list, must have these elements in their definition before the actual struct definition. The struct pointers are then cast to CgList* and operated with cg_list_* functions.
Function Documentation
- Todo:
This works essentially like insert, although it is more error-prone?!
There might be a bug in this function.
Clear the list and delete all of its contents with CG_LIST_DESTRUCTORFUNC
- Parameters:
-
| headList | List header |
| destructorFunc | Function pointer that clears the contents of individual nodes |
Get an item from the list by the item's index
- Parameters:
-
| headList | List header |
| index | The index of the item to get |
| void cg_list_header_init |
( |
CgList * |
list | ) |
|
Initialize a list node to act as the first node
- Parameters:
-
Insert a list node or a complete list structure after the given node
- Parameters:
-
| prevList | Insert after this node |
| list | List node or list structure to insert |
Get the next node. Returns NULL if end has been reached.
- Parameters:
-
Get the next node. Wrap around if the end has been reached.
- Parameters:
-
| void cg_list_node_init |
( |
CgList * |
list | ) |
|
Initialize a list node to act as a regular node, part of a list.
- Parameters:
-
Get the previous node. Returns NULL if beginning has been reached
- Parameters:
-
Get the previous node. Wrap around if the beginning has been reached.
- Parameters:
-
| void cg_list_remove |
( |
CgList * |
list | ) |
|
Remove a node from a list. Does not free any memory, but only removes the next and previous link associations regarding the given node.
- Parameters:
-
| int cg_list_size |
( |
CgList * |
headList | ) |
|
Get the number of nodes in the current list structure. Counts forwards from the given node, so if you want to get the complete size, give a header node as the parameter.
- Parameters:
-