slist.h

Go to the documentation of this file.

/*
 *       _____
 * ANSI / ___/
 *     / /__  
 *     \___/  
 *
 * Filename: slist.h
 * Author  : Kyle Loudon/Dan Levin
 * Date    : Fri Mar 22 12:40:45 GMT 2013
 * Version : 0.51
 * ---
 * Description: A singly-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  Made following changes to function 'int SLISTremnode(Slist list, void **data)':
 *             - Changed function name to - 'int SLISTfind_remove(Slist list, void **data)'
 *             - Changed return value - for missing "match-callback"(=not set) - from -1 to -2
 *             - Changed return value - for node not found - from -1 to 1.
 * 2013-02-19  Made some revision to the Doxygen documentation. Enhanced the description of
 *             in/out parameters - i.e. double-pointers.             
 * 2013-04-14  Added a new "getter" function - match_callback SLISTgetmatch(Slist list), that
 *             simply returns the reference to the formerly added match callback stored in 
 *             the ADT header. The data type "match_callback" is the following typedef:
 *             typedef int (*match_callback)(const void *, const void *).
 * 2015-03-31  This code ready for version 0.51
 *
 */

#ifndef _SLIST_H_
#define _SLIST_H_

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

#ifdef __cplusplus
extern "C" {
#endif

#define SLIST_FWD 1

#define SLIST_BWD -1

  typedef struct SList_ *Slist;

  typedef struct SListElmt_ *SlistNode;

  typedef int (*match_callback)(const void *, const void *);

  /* FUNCTION DECLARATIONS */

  Slist SLISTinit(void (*destroy)(void *data));

  void SLISTdestroy(Slist list);

  int SLISTinsnext(Slist list, SlistNode node, const void *data);

  int SLISTremnext(Slist list, SlistNode node, void **data);

  int SLISTsize(Slist list);

  SlistNode SLISThead(Slist list);

  SlistNode SLISTtail(Slist list);

  int SLISTishead(Slist list, SlistNode node);

  int SLISTistail(Slist list, SlistNode node);

  void *SLISTdata(SlistNode node);

  SlistNode SLISTnext(SlistNode node);

  SlistNode SLISTfindnode(Slist list, const void *data);

  void SLISTsetmatch(Slist list, int (*match)(const void *key1, 
                                              const void *key2));

  match_callback SLISTgetmatch(Slist list);

  int SLISTfind_remove(Slist list, void **data);

  void SLISTreverse(Slist list);

  void SLISTsort(Slist list, int (*cmp)(const void *key1, const void *key2));

  void SLISTtraverse(Slist list, void (*callback)(const void *data), int direction);

#ifdef __cplusplus
}
#endif 

#endif /* _SLIST_H_ */