typedef struct OmtkList

typedef struct
{
} OmtkList;

You shouldn't access this structure directly, because it may change.

OMTK_LIST_FOREACH()

#define OMTK_LIST_FOREACH(list, var)

The block followed by this instruction is invoked for every object of list. It is possible to add or remove elements of the same list in this block! The object of the list will be stored in var. Note that this is a preprocessor directive and take a look at the example.

Do not put a semicolon behind this instruction!

Example:

OmtkList *list = omtk_list_create();
int var;

omtk_list_append(list, (void *)1);
omtk_list_append(list, (void *)2);
omtk_list_append(list, (void *)3);

OMTK_LIST_FOREACH(list, &var) /* do NOT use any casting operators here */
{
  printf("%d\n", var);
}

omtk_list_create()

OmtkList *omtk_list_create(void);

Creates a new list.

omtk_list_append()

void omtk_list_append(OmtkList *list, void *object);

Appends an object to a list.

omtk_list_insert_at()

void omtk_list_insert_at(OmtkList *list, int position, void *object);

Inserts an object at the given position.

omtk_list_remove()

int omtk_list_remove(OmtkList *list, void *object);

Removes the first occurence of object from the list. Returns 1 if the object was removed or 0 if the object isn't in the list.

Added in omtk 0.1.2.

omtk_list_remove_at()

void omtk_list_remove_at(OmtkList *list, int position);

Removes the object at the given position from the list.

omtk_list_rewind()

void omtk_list_rewind(OmtkList *list);

Sets the element pointer of the list to the begin of the list.

If you want to traverse the list, use OMTK_LIST_FOREACH().

omtk_list_next()

int omtk_list_next(OmtkList *list, void **var);

Returns the current element pointer and sets it to the next element.

If you want to traverse the list, use OMTK_LIST_FOREACH().

Added in omtk 0.1.2.

omtk_list_object_at()

void *omtk_list_object_at(OmtkList *list, int position);

Returns the object at the given position of the list.

omtk_list_count()

int omtk_list_count(OmtkList *list);

Returns the number of elements of the list.

omtk_list_print()

void omtk_list_print(OmtkList *list);

Prints the list. This function should be used for debugging purposes only.

omtk_list_free()

void omtk_list_free(OmtkList *list);

You have to call this function to free the list.