List.h

Go to the documentation of this file.

/* -*- Mode: C++; -*- */
/* VER: $Id$ */
// copyright (c) 2004 by Christos Dimitrakakis <dimitrak@idiap.ch>
/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef LIST_H
#define LIST_H

#include <stdlib.h>
#include <stdio.h>
#include <assert.h>

typedef struct ListItem {
    void* obj; 
    void (*free_obj) (void* obj); 
    struct ListItem* prev; 
    struct ListItem* next; 
} LISTITEM;


typedef struct List {
    LISTITEM* curr; 
    LISTITEM* head; 
    LISTITEM* tail; 
    int n; 
    LISTITEM* (*retrieve) (struct List* list, void* ptr);
} LIST;


LIST* List(void);
int ListSize(LIST* list);
LISTITEM* ListAppend(LIST* list, void* p);
LISTITEM* ListAppend(LIST* list, void* p, void (*free_obj) (void* obj));
LISTITEM* FirstListItem(LIST* list);
LISTITEM* LastListItem(LIST* list);
LISTITEM* NextListItem(LIST* list);
int PopItem(LIST* list);
int ClearList(LIST* list);
LISTITEM* FindItem (LIST* list, void* ptr);
LISTITEM* GetItem (LIST* list, int n);

LISTITEM* ListItem(void* ptr, void (*free_obj) (void* obj));
LISTITEM* GetNextItem(LISTITEM* ptr);
LISTITEM* GetPrevItem(LISTITEM* ptr);
LISTITEM* LinkNext(LISTITEM* src, void* ptr, void (*free_obj) (void* obj));
LISTITEM* LinkPrev(LISTITEM* src, void* ptr, void (*free_obj) (void* obj));
int FreeListItem(LIST* list, LISTITEM* ptr);
int RemoveListItem(LIST* list, LISTITEM* ptr);

LISTITEM* ListLinearSearchRetrieve (struct List* list, void* ptr);

#endif