NuSMV/code/nusmv/core/utils/list.h

Go to the documentation of this file.

/*
 * Revision Control Information
 *
 * /projects/hsis/CVS/utilities/list/list.h,v
 * shiple
 * 1.5
 * 1995/08/30 17:37:15
 *
 */
/*
 * List Management Package Header File
 *
 * David Harrison
 * University of California, 1985
 *
 * This file contains public type definitions for the List Managment
 * package implemented in list.c.  This is stand alone package.
 */

#ifndef __NUSMV_CORE_UTILS_LIST_H__
#define __NUSMV_CORE_UTILS_LIST_H__

#define LS_DEFINED

#if HAVE_CONFIG_H
#  include "nusmv-config.h"
#endif


/* This can be typedef'ed to void if supported */
typedef struct ls_dummy_defn {
    int dummy;                  /* Not used */
} ls_dummy;

typedef ls_dummy *lsList;       /* List handle           */
typedef ls_dummy *lsGen;        /* List generator handle */
typedef ls_dummy *lsHandle;     /* Handle to an item     */

typedef int lsStatus;

typedef void *lsGeneric;

#define LS_NIL          0

#define LS_BADSTATE     -3

#define LS_BADPARAM     -2

#define LS_NOMORE       -1

#define LS_OK           0

#define LS_BEFORE       1

#define LS_AFTER        2

#define LS_STOP         3

#define LS_DELETE       4

#define LS_NH           (lsHandle *) 0


typedef lsGeneric (*LS_PFLSG)(lsGeneric);

#define LS_COPY         (LS_PFLSG) (-1)

lsList lsCreate(void);

lsList lsSingleton(lsGeneric, lsHandle *);

lsStatus lsDestroy(lsList, void (*)(lsGeneric));

lsStatus lsDestroyListList(lsList);

lsList lsCopy(lsList, LS_PFLSG);

lsList lsCopyListList(lsList);

lsList lsAppend(lsList, lsList, LS_PFLSG);

void lsJoin(lsList, lsList, LS_PFLSG);

lsStatus lsFirstItem(lsList, lsGeneric *, lsHandle *);

lsStatus lsLastItem(lsList, lsGeneric *, lsHandle *);

lsStatus lsNewBegin(lsList, lsGeneric, lsHandle *);

lsStatus lsNewEnd(lsList, lsGeneric, lsHandle *);

lsStatus lsDelBegin(lsList, lsGeneric *);

lsStatus lsDelEnd(lsList, lsGeneric *);

int lsLength(lsList);

lsGen lsStart(lsList);

lsGen lsEnd(lsList);

lsGen lsGenHandle(lsHandle, lsGeneric *, int);

lsStatus lsNext(lsGen, lsGeneric *, lsHandle *);

lsStatus lsPrev(lsGen, lsGeneric *, lsHandle *);

lsStatus lsInBefore(lsGen, lsGeneric, lsHandle *);

lsStatus lsInAfter(lsGen, lsGeneric, lsHandle *);

lsStatus lsDelBefore(lsGen, lsGeneric *);

lsStatus lsDelAfter(lsGen, lsGeneric *);

lsStatus lsFinish(lsGen);

lsList lsQueryHandle(lsHandle);

lsGeneric lsFetchHandle(lsHandle);

lsStatus lsRemoveItem(lsHandle, lsGeneric *);

lsStatus lsSort(lsList, int (*compare)(char*, char*));

lsStatus lsUniq(lsList, int (*compare)(char*, char*), void (*delFunc)(lsGeneric));

lsStatus lsForeach(lsList list,
                   lsStatus (*userFunc)(lsGeneric, lsGeneric),
                   lsGeneric arg);

lsStatus lsBackeach(lsList list,
                    lsStatus (*userFunc)(lsGeneric, lsGeneric),
                    lsGeneric arg);

#define lsForEachItem(                                         \
  list,  /* lsList, list to iterate */                         \
  gen,   /* lsGen, local variable for iterator */              \
  data   /* lsGeneric, variable to return data */              \
)                                                              \
  for(gen = lsStart(list);                                     \
      (lsNext(gen, (lsGeneric *) &data, LS_NH) == LS_OK)       \
      || ((void) lsFinish(gen), 0);                            \
      )


#endif /* __NUSMV_CORE_UTILS_LIST_H__ */

---