/*

    viDOOM - level editor for DOOM

    Copyright (C) 2000  Ian Cowburn (ianc@noddybox.demon.co.uk)

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    -------------------------------------------------------------------------

    Provides a double-linked list

    $Id$

*/

#ifndef VIDOOM_LIST_H

#define VIDOOM_LIST_H

/* Opaque types for the list and iterator.  NULL is the null list and iterator.
*/
struct VIDOOM_List;
typedef struct VIDOOM_List *List;

struct VIDOOM_Iterator;
typedef struct VIDOOM_Iterator *Iterator;


/* Create a list
*/
List		ListNew(int type_size);

/* Free a list object
*/
List		ListClear(List l);

/* Free all elements in a list
*/
List		ListEmpty(List l);

/* Return number of elements in list
*/
int		ListSize(List l);

/* Create an iterator over the list
*/
Iterator	ListIterator(List l);

/* Destory an iterator
*/
Iterator	IteratorClear(Iterator i);

/* Get data for pointed to by this iterator object
*/
void		*IteratorData(Iterator i);

/* Move the iterator to the next element.  NULL once done.
*/
Iterator	IteratorNext(Iterator i);

/* Move the iterator to the previous element.  NULL once done.
*/
Iterator	IteratorPrev(Iterator i);

/* Replace the data currently stored in this this position with the new one
*/
Iterator	IteratorUpdate(Iterator i,void *data);

/* Delete the data currently stored in this position and move the iterator to
   the next element.
*/
Iterator	IteratorDelete(Iterator i);

/* Append to the tail of the the list
*/
void		ListAppend(List l,void *data);

/* Insert at the head of the the list
*/
void		ListInsert(List l,void *data);

/* Return an iterator for the searched element.  Note the fist void* passed
   to the predicate will be of the type stored in the lists.  The second
   argument will be whatever was passed as data.
*/
Iterator	ListFindElem(List l,int (*pred)(void *, void *),void *data);

#endif


/* END OF FILE */