src/list.h

Go to the documentation of this file.

/********************************************************************
 * sphore - SPH Opengl Rendering Engine
 *
 * This file is (or was) part of sphore.
 * sphore comes with ABSOLUTELY NO WARRANTY.
 * This is free software; and you are welcome to redistribute
 * it under the terms of the GNU General Public License
 * (see LICENSE file for details) and the provision that
 * this notice remains intact. If you modify this file, please
 * note section 2a) of the GPLv2 states that:
 *
 *  a) You must cause the modified files to carry prominent notices
 *     stating that you changed the files and the date of any change.
 *
 * Copyright (C) 2011 James Wetter. All rights reserved.
 * Contact: wetter.j@gmail.com
 *
 ********************************************************************/

#ifndef LIST_H
#define LIST_H
#include "node.h"
#include "sphore.h"

typedef struct _list list_t;
typedef struct _list_iterator list_iterator_t;

list_t *list_create (void);

void list_destroy (list_t * list);

void list_destroy_data (list_t * list, void (*destroy_func) (void *));

_SREnodeID list_add_first (list_t * list, void *data);

_SREnodeID list_add_last (list_t * list, void *data);

SREbool list_remove (list_t * list, _SREnodeID id);

SREbool list_remove_data (list_t * list, _SREnodeID id,
                          void (*destroy_func) (void *));

list_iterator_t *list_iterator_create (list_t * list);

void list_iterator_destroy (list_iterator_t * it);

_SREnodeID list_iterator_get_id (list_iterator_t * it);

void *list_iterator_get_data (list_iterator_t * it);

void list_iterator_remove (list_iterator_t * it);

void list_iterator_remove_data (list_iterator_t * it,
                                void (*destroy_func) (void *));

_SREnodeID list_iterator_add (list_iterator_t * it, void *data);

SREbool list_iterator_find (list_iterator_t * it, _SREnodeID id);

void list_iterator_reset (list_iterator_t * it);

SREbool list_iterator_move (list_iterator_t * it);

SREbool list_iterator_has_next (list_iterator_t * it);
#endif