cslist.h

Go to the documentation of this file.

/*
 *       _____
 * ANSI / ___/
 *     / /__  
 *     \___/  
 *
 * Filename: cslist.h
 * Author  : Kyle Loudon/Dan Levin
 * Date    : Mon Apr 08 19:29:27 2013
 * Version : 0.51
 * ---
 * Description: A circular, singly-linked list - implemented as a pure, generic ADT
 * 
 * Revision history - coming up below:
 *
 * Date   Revision message
 * 130409 Created this file
 * 150331 This code ready for version 0.51
 *
 */
#ifndef _CSLIST_H_
#define _CSLIST_H_

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

#ifdef __cplusplus
extern "C" {
#endif

  typedef struct CSList_ *CSlist;

  typedef struct CSListElmt_ *CSlistNode;

  /* FUNCTION DECLARATIONS */

  CSlist CSLISTinit(void (*destroy)(void *data));

  void CSLISTdestroy(CSlist clist);

  int CSLISTinsnext(CSlist clist, CSlistNode node, const void *data);

  int CSLISTremnext(CSlist clist, CSlistNode node, void **data);

  int CSLISTsize(CSlist clist);

  CSlistNode CSLISThead(CSlist clist);

  int CSLISTishead(CSlist clist, CSlistNode node);

  void *CSLISTdata(CSlistNode node);

  CSlistNode CSLISTnext(CSlistNode node);

  CSlistNode CSLISTfindnode(CSlist clist, const void *data);

  void CSLISTsetmatch(CSlist clist, int (*match)(const void *key1, 
                                                 const void *key2));
  int CSLISTfind_remove(CSlist clist, void **data);

  void CSLISTtraverse(CSlist clist, void (*callback)(const void *data));

#ifdef __cplusplus
}
#endif 

#endif /* _CSLIST_H_ */