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

Go to the documentation of this file.

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


   This file is part of the ``utils'' package of NuSMV version 2.
   Copyright (C) 2011 by 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_OAHASH_H__
#define __NUSMV_CORE_UTILS_OAHASH_H__


#include "nusmv/core/utils/utils.h"

typedef struct OAHash_TAG*  OAHash_ptr;

typedef size_t OAHashIter;

typedef boolean (*OA_HASH_EQ_FUN)(const void*, const void*, void*);

typedef size_t (*OA_HASH_HASH_FUN)(const void*, void*);

typedef void (*OA_HASH_FREE_FUN)(void* key, void* value, void* arg);

#define OA_HASH(self)                           \
  ((OAHash_ptr) self)

#define OA_HASH_CHECK_INSTANCE(self)                    \
  (nusmv_assert(OA_HASH(self) != OA_HASH(NULL)))

#define OA_HASH_FOREACH(self, iter)             \
  for (iter = OAHash_get_first_iter(self);      \
       !OAHash_iter_is_end(self, iter);         \
       iter = OAHash_iter_next(self, iter))

#define OA_HASH_FOREACH_ENTRY(self, iter, key, value)                   \
  for (iter = OAHash_get_first_iter(self);                              \
       !OAHash_iter_is_end(self, iter) &&                               \
         (OAHash_iter_values(self, iter, (void**)key, (void**)value), true); \
       iter = OAHash_iter_next(self, iter))



/*---------------------------------------------------------------------------*/
/* Function prototypes                                                       */
/*---------------------------------------------------------------------------*/

OAHash_ptr OAHash_create(OA_HASH_EQ_FUN key_eq_fun,
                         OA_HASH_HASH_FUN key_hash_fun,
                         OA_HASH_FREE_FUN free_entry_fun,
                         void* custom_arg);

OAHash_ptr OAHash_copy(const OAHash_ptr self);

void OAHash_destroy(OAHash_ptr self);

boolean OAHash_insert(OAHash_ptr self,
                      const void* key,
                      const void* value);

void* OAHash_lookup(OAHash_ptr self,
                    const void* key);

boolean OAHash_has_key(OAHash_ptr self,
                       const void* key);

boolean OAHash_remove(OAHash_ptr self,
                      const void* key);

void OAHash_clear(OAHash_ptr self);

size_t OAHash_get_size(OAHash_ptr self);

OAHashIter OAHash_get_first_iter(const OAHash_ptr self);

OAHashIter OAHash_iter_next(const OAHash_ptr self, const OAHashIter iter);

boolean OAHash_iter_is_end(const OAHash_ptr self, const OAHashIter iter);

void OAHash_iter_values(const OAHash_ptr self, const OAHashIter iter,
                        void** key, void** value);



/* Functions for key_eq_fun and key_hash_fun */

/* Pointers based */

boolean OAHash_pointer_eq_fun(const void* k1, const void* k2, void* arg);

size_t OAHash_pointer_hash_fun(const void* key, void* arg);

boolean OAHash_string_eq_fun(const void* k1, const void* k2, void* arg);

size_t OAHash_string_hash_fun(const void* key, void* arg);



#endif /* __NUSMV_CORE_UTILS_OAHASH_H__ */

---