dlist.h

#ifndef _AVRIO_DLIST_H_
#define _AVRIO_DLIST_H_
#include <stdlib.h>
#include <avrio/defs.h>

__BEGIN_C_DECLS
/* ========================================================================== */
struct xDListElmt;
typedef struct xDListElmt xDListElmt;

/* types ==================================================================== */
typedef void (*vDListElmtDestroy) (void *data);

typedef int  (*iDListElmtMatch) (const void *key1, const void *key2);

typedef const void * (*pvDListElmtKey) (const xDListElmt * element);

/* structures =============================================================== */

struct xDListElmt {

  void               *data;
  struct xDListElmt  *prev;
  struct xDListElmt  *next;

} ;

typedef struct xDList {

  int                 size;
  xDListElmt          *head;
  xDListElmt          *tail;
  vDListElmtDestroy   destroy;
  pvDListElmtKey      key;
  iDListElmtMatch     match;
} xDList;

/* macros =================================================================== */
#define pxDListElmtDataPtr(element, t) ((t *)pvDListElmtData(element))

/* internal public functions ================================================ */
int iDListInit (xDList *list, vDListElmtDestroy fdestroy);

int iDListInitSearch (xDList *list, pvDListElmtKey fkey, iDListElmtMatch fmatch);

int iDListDestroy (xDList *list);

int iDListInsertAfter (xDList *list, xDListElmt *element, const void *data);

int iDListInsertBefore (xDList *list, xDListElmt *element, const void *data);

int iDListRemove (xDList *list, xDListElmt *element, void **data);

xDListElmt * pxDListFindFirst (xDList *list, const void * key);

int iDListSize (const xDList *list);

int iDListPrepend (xDList *list,const void *data);

int iDListAppend (xDList *list,const void *data);

xDListElmt * pxDListHead (const xDList *list);

xDListElmt * pxDListTail (const xDList *list);

bool bDListElmtIsHead (const xDListElmt *element);

bool bDListElmtIsTail (const xDListElmt *element);

void * pvDListElmtData (const xDListElmt *element);

xDListElmt * pxDListElmtNext (const xDListElmt *element);

xDListElmt * pxDListElmtPrev (const xDListElmt *element);

/* ========================================================================== */
__END_C_DECLS
#endif /* _AVRIO_DLIST_H_ */