dlist.h

Go to the documentation of this file.

/*
 *       _____
 * ANSI / ___/
 *     / /__  
 *     \___/  
 *
 * Filename: dlist.h
 * Author  : Kyle Loudon/Dan Levin
 * Date    : Fri Mar 22 12:40:45 GMT 2013
 * Version : 0.51
 * ---
 * Description: A doubly-linked list - implemented as a pure, generic ADT.
 *
 * Revision history - coming up below:
 *
 * Date        Revision message
 * 2012-12-03  Created this file
 * 2013-02-05  Created a new function 'int DLISTfind_remove(Dlist list, void **data)'
 * 2013-02-19  Made some revision to the Doxygen documentation. Enhanced the description of
 *             in/out parameters - i.e. double-pointers.             
 * 2015-03-31  This code ready for ver. 0.51
 */

#ifndef _DLIST_H_
#define _DLIST_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define DLIST_FWD 1

#define DLIST_BWD -1

  typedef struct DList_ *Dlist;

  typedef struct DListElmt_ *DlistNode;

  /* FUNCTION DECLARATIONS */

  Dlist DLISTinit(void (*destroy)(void *data));

  void DLISTdestroy(Dlist list);

  int DLISTinsnext(Dlist list, DlistNode node, const void *data);

  int DLISTinsprev(Dlist list, DlistNode node, const void *data);

  int DLISTremove(Dlist list, DlistNode node, void **data);
  
  int DLISTsize(Dlist list);

  DlistNode DLISThead(Dlist list);

  DlistNode DLISTtail(Dlist list);

  int DLISTishead(Dlist list, DlistNode node);

  int DLISTistail(Dlist list, DlistNode node);

  void *DLISTdata(DlistNode node);

  DlistNode DLISTnext(DlistNode node);

  DlistNode DLISTprev(DlistNode node);

  DlistNode DLISTfindnode(Dlist list, const void *data);

  void DLISTsetmatch(Dlist list, int (*match)(const void *key1, 
                                              const void *key2));
  int DLISTfind_remove(Dlist list, void **data);

  void DLISTsort(Dlist list, int (*cmp)(const void *key1, const void *key2));

  void DLISTtraverse(Dlist list, void (*callback)(const void *data), int direction);

#ifdef __cplusplus
}
#endif 

#endif /* _DLIST_H_ */