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

Go to the documentation of this file.

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


  This file is part of the ``utils'' package of NuSMV version 2.
  Copyright (C) 1998-2001 by CMU and FBK-irst.

  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_ASSOC_H__
#define __NUSMV_CORE_UTILS_ASSOC_H__

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

#include "cudd/util.h" /* for ARGS and EXTERN */
#include "nusmv/core/node/node.h" /* for node_ptr */
#include "cudd/st.h"

/*---------------------------------------------------------------------------*/
/* Constant declarations                                                     */
/*---------------------------------------------------------------------------*/

#define ASSOC_DELETE ST_DELETE

#define ASSOC_CONTINUE ST_CONTINUE

#define ASSOC_STOP ST_STOP

#define ASSOC_FOREACH(table, iter, key, value)  \
  st_foreach_item(table, iter, key, value)

#define assoc_iter_init(table)                  \
  st_init_gen(table)

#define assoc_iter_next(iter, key, value)       \
  st_gen(iter, key, value)

#define assoc_iter_free(iter)                   \
  st_free_gen(iter)

#define assoc_get_size(table)                   \
  st_count(table)

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

typedef struct st_table* hash_ptr;
typedef enum st_retval assoc_retval;

typedef st_generator* assoc_iter;

typedef ST_PFSR PF_STCPCPCP;

typedef struct AssocAndDestroy_TAG
{
  hash_ptr assoc;
  PF_STCPCPCP destroy_func;
} AssocAndDestroy;

typedef struct AssocAndDestroy_TAG* AssocAndDestroy_ptr;

/*---------------------------------------------------------------------------*/
/* Function prototypes                                                       */
/*---------------------------------------------------------------------------*/
/* Constructors, Destructors, Copiers and Cleaners ****************************/

hash_ptr new_assoc(void);

hash_ptr new_assoc_with_size(int initial_size);

hash_ptr new_assoc_with_params(ST_PFICPCP compare_fun,
                                      ST_PFICPI hash_fun);

hash_ptr new_assoc_string_key(void);

void free_assoc(hash_ptr hash);

hash_ptr copy_assoc(hash_ptr hash);
hash_ptr assoc_deep_copy(hash_ptr hash, ST_PFSR copy_fun);

void clear_assoc(hash_ptr hash);

void clear_assoc_and_free_entries(hash_ptr, ST_PFSR);

void
clear_assoc_and_free_entries_arg(hash_ptr hash, ST_PFSR fn, char* arg);


/* Getters and Setters ********************************************************/

node_ptr find_assoc(hash_ptr, node_ptr);

void insert_assoc(hash_ptr, node_ptr, node_ptr);

node_ptr remove_assoc(hash_ptr hash, node_ptr key);

node_ptr assoc_get_keys(hash_ptr hash,
                        NodeMgr_ptr nodemgr,
                        boolean ignore_nils);


/* Miscellaneous **************************************************************/

void assoc_foreach(hash_ptr hash, ST_PFSR fn, char *arg);

#endif /* __NUSMV_CORE_UTILS_ASSOC_H__ */

---