glm_list.h

Go to the documentation of this file.

#ifndef _GLM_LIST_H_
#define _GLM_LIST_H_

#ifdef  __cplusplus
extern "C" {
#endif

    
/* INCLUDES *******************************************************************/
#include <stdbool.h>
#include "../glm_intbase.h"
#include "../glm_heap.h"


/* TYPES **********************************************************************/

typedef struct
{
    void *  prev;               
    void *  object;             
    void *  next;               
} list_item_t;


typedef struct
{
    list_item_t     *first;             
    list_item_t     *last;              
    uint_base_t     length;             
} list_t;


/* PUBLIC FUNCTIONS ***********************************************************/


extern list_t * list_create(heap_id_t a_heap_id);


extern void list_destroy(list_t *a_list);


extern void list_clear(list_t *a_list);


extern uint_base_t list_length(list_t * a_list);


extern list_item_t * list_item_create(list_t * a_list, void * a_object);


extern list_item_t * list_item_delete(list_t * a_list, list_item_t * a_item);


extern void * list_item_remove( list_t * a_list, list_item_t * a_item );


extern bool list_append(list_t *a_list, list_item_t *a_item);


extern bool list_prepend(list_t *a_list, list_item_t *a_item);


extern list_item_t * list_first_item( list_t *a_list );


extern list_item_t * list_last_item( list_t *a_list );


extern bool list_insert_after_item(     list_t * a_list, list_item_t *a_item,
                                                                        list_item_t *a_item_new );


extern bool list_insert_before_item(list_t * a_list, list_item_t *a_item,
                                    list_item_t *a_item_new );


extern list_item_t * list_item_get_previous(list_item_t * a_item);


extern list_item_t * list_item_get_next(list_item_t * a_item);


extern void * list_item_get_object(list_item_t *a_item);


#ifdef  __cplusplus
}
#endif

#endif  /* _GLM_LIST_H_ */