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

Go to the documentation of this file.

/* ---------------------------------------------------------------------------


  This file is part of the ``compile'' package of NuSMV version 2.
  Copyright (C) 2008 by FBK.

  NuSMV version 2 is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  NuSMV version 2 is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

  For more information on NuSMV see <http://nusmv.fbk.eu>
  or email to <nusmv-users@fbk.eu>.
  Please report bugs to <nusmv-users@fbk.eu>.

  To contact the NuSMV development board, email to <nusmv@fbk.eu>. 

-----------------------------------------------------------------------------*/

#ifndef __NUSMV_CORE_UTILS_SLIST_H__
#define __NUSMV_CORE_UTILS_SLIST_H__

#include "nusmv/core/utils/defs.h"
#include "nusmv/core/node/printers/MasterPrinter.h"

/*---------------------------------------------------------------------------*/
/* Type declarations                                                         */
/*---------------------------------------------------------------------------*/

typedef struct Slist_TAG* Slist_ptr;

#define SLIST(x) \
         ((Slist_ptr) x)

#define SLIST_CHECK_INSTANCE(x) \
         ( nusmv_assert(SLIST(x) != SLIST(NULL)) )

#define SLIST_FOREACH(list, iter)                               \
   for (iter=Slist_first(list); !Siter_is_end(iter); \
        iter=Siter_next(iter))


/* internal type. it cannot be used outside. */

typedef struct Snode_TAG* Snode_ptr;

/* Iterator type.
   here a struct definition is used only to create a new type. Thus
   C type checker will be able to catch incorrect use of iterators.
   This does not influence on efficiency
*/
typedef struct Siter_TAG {Snode_ptr node;} Siter;

/* Frre function type */

typedef void (*Slist_free_function)(void*);

/* ---------------------------------------------------------------------- */
/* Public interface                                                       */
/* ---------------------------------------------------------------------- */

Slist_ptr Slist_create(void);

void Slist_destroy(Slist_ptr self);

void Slist_destroy_and_free_elements(Slist_ptr self,
                                            Slist_free_function f);

Slist_ptr Slist_copy(Slist_ptr self);

Slist_ptr Slist_copy_reversed(Slist_ptr self);

void Slist_reverse(Slist_ptr self);

void Slist_push(Slist_ptr self, void* element);

void* Slist_pop(Slist_ptr self);

void* Slist_top(Slist_ptr self);

boolean Slist_is_empty(Slist_ptr self);

Siter Slist_first(Slist_ptr self);

Siter Slist_end(void);

boolean Siter_is_end(Siter iter);

boolean Siter_is_last(Siter iter);

Siter Siter_next(Siter iter);

void* Siter_element(Siter iter);

Siter Slist_find(Slist_ptr self, const void* element);

boolean Slist_contains(Slist_ptr self, const void* element);

boolean Slist_remove(Slist_ptr self, const void* element);

void Slist_append(Slist_ptr self, const Slist_ptr other);

boolean Slist_equals(const Slist_ptr self, const Slist_ptr other);

unsigned int Slist_get_size(Slist_ptr self);

void Slist_sort(Slist_ptr self,
                       int (*cmp)(void* el1, void* el2, void* extra),
                       void* extra);

void Slist_clear(Slist_ptr self);

void Slist_print(Slist_ptr const self,
                        MasterPrinter_ptr wffprint,
                        void (*printer)(FILE* file, void* el, void* arg),
                        FILE* file,
                        void* printer_arg);

#endif /* __NUSMV_CORE_UTILS_SLIST_H__ */

---