NuSMV/code/nusmv/core/utils/Olist.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_OLIST_H__
#define __NUSMV_CORE_UTILS_OLIST_H__

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

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

typedef struct Olist_TAG* Olist_ptr;

#define OLIST(x) \
         ((Olist_ptr) x)

#define OLIST_CHECK_INSTANCE(x) \
         ( nusmv_assert(OLIST(x) != OLIST(NULL)) )

#define OLIST_FOREACH(list, iter) \
 for (iter = Olist_first(list); !Oiter_is_end(iter); iter = Oiter_next(iter))

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

typedef struct Onode_TAG* Onode_ptr;
/* 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 */
typedef struct Oiter_TAG {Onode_ptr* node;} Oiter;

/* ---------------------------------------------------------------------- */
/* Public interface                                                       */
/* ---------------------------------------------------------------------- */
/* Constructors, Destructors, Copiers and Cleaners ****************************/

Olist_ptr Olist_create(void);

void Olist_destroy(Olist_ptr self);

Olist_ptr Olist_copy(Olist_ptr self);

Olist_ptr Olist_copy_reversed(Olist_ptr self);

Olist_ptr Olist_copy_without_element(Olist_ptr self,
                                            void* element);

void Olist_reverse(Olist_ptr self);

void Olist_move(Olist_ptr self, Olist_ptr to_list,
                       Oiter iter_to);

void Olist_move_all(Olist_ptr self, Olist_ptr to_list);

void Olist_clean(Olist_ptr self);

void Olist_concat(Olist_ptr self, Olist_ptr other);

void Olist_prepend(Olist_ptr self, void* element);

void Olist_append(Olist_ptr self, void* element);

void* Olist_delete_first(Olist_ptr self);

int Olist_get_size(const Olist_ptr self);

boolean Olist_is_empty(Olist_ptr self);

Oiter Olist_first(Olist_ptr self);

Oiter Olist_last(Olist_ptr self);

Oiter Olist_end(Olist_ptr self);

boolean Olist_iter_is_first(Olist_ptr self, Oiter iter);

boolean Oiter_is_end(Oiter iter);

boolean Olist_iter_is_last(Olist_ptr self, Oiter iter);

Oiter Oiter_next(Oiter iter);

void* Oiter_element(Oiter iter);

void Oiter_set_element(Oiter iter, void* element);

Oiter Olist_insert_after(Olist_ptr self, Oiter iter,
                               void* element);

Oiter Olist_insert_before(Olist_ptr self, Oiter iter,
                          void* element);

Oiter Olist_delete(Olist_ptr self, Oiter iter, void** element);

boolean Olist_contains(const Olist_ptr self, const void* element);

boolean Olist_remove(Olist_ptr self, const void* element);

void Olist_sort(Olist_ptr self,
                       int (*cmp)(void* el1, void* el2, void* extra),
                       void* extra);

void Olist_print_node(Olist_ptr self,
                             MasterPrinter_ptr printer, FILE* output);

void olist_testing_function(const NuSMVEnv_ptr env);

void
Olist_map(Olist_ptr self, void (*func)(void* elem));

#endif /* __OLIST_H__ */

---