NuSMV/code/nusmv/core/compile/symb_table/SymbCache_private.h

Go to the documentation of this file.

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


  This file is part of the ``compile.symb_table'' package of NuSMV
  version 2.  Copyright (C) 2004 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_COMPILE_SYMB_TABLE_SYMB_CACHE_PRIVATE_H__
#define __NUSMV_CORE_COMPILE_SYMB_TABLE_SYMB_CACHE_PRIVATE_H__


#include "nusmv/core/compile/symb_table/SymbCache.h"
#include "nusmv/core/compile/symb_table/SymbTable.h"

#include "nusmv/core/utils/utils.h"
#include "nusmv/core/compile/symb_table/NFunction.h"
#include "nusmv/core/node/node.h"

/*---------------------------------------------------------------------------*/
/* Type definitions                                                          */
/*---------------------------------------------------------------------------*/

/* ---------------------------------------------------------------------- */
/*     Private methods                                                    */
/* ---------------------------------------------------------------------- */

SymbCache_ptr SymbCache_create(SymbTable_ptr symb_table,
                                      NuSMVEnv_ptr env);

void SymbCache_destroy(SymbCache_ptr self);

void
SymbCache_new_input_var(SymbCache_ptr self,
                        node_ptr var, SymbType_ptr type);

void
SymbCache_new_state_var(SymbCache_ptr self,
                        node_ptr var, SymbType_ptr type);

void
SymbCache_new_frozen_var(SymbCache_ptr self,
                          node_ptr var, SymbType_ptr type);

void
SymbCache_redeclare_state_as_frozen_var(SymbCache_ptr self,
                                        node_ptr var);

void
SymbCache_remove_var(SymbCache_ptr self, node_ptr var);

void
SymbCache_new_define(SymbCache_ptr self,
                     node_ptr name,
                     node_ptr context, node_ptr definition);

void
SymbCache_new_function(SymbCache_ptr self, node_ptr name,
                       node_ptr context, SymbType_ptr type);

void
SymbCache_new_parameter(SymbCache_ptr self,
                        node_ptr formal,
                        node_ptr context, node_ptr actual);

void
SymbCache_new_array_define(SymbCache_ptr self, node_ptr name,
                            node_ptr ctx, node_ptr definition);

void
SymbCache_new_variable_array(SymbCache_ptr self, node_ptr name,
                             SymbType_ptr type);

void
SymbCache_remove_define(SymbCache_ptr self, node_ptr define);

void
SymbCache_remove_function(SymbCache_ptr self, node_ptr name);

void
SymbCache_new_constant(SymbCache_ptr self, node_ptr name);

void
SymbCache_remove_constant(SymbCache_ptr self, node_ptr constant);

void
SymbCache_remove_symbols(SymbCache_ptr self,
                         const node_ptr* symbols,
                         const unsigned int size);

SymbTableType
SymbCache_get_symbol_type(const SymbCache_ptr self,
                          const node_ptr symbol);

void
SymbCache_gen_iter(const SymbCache_ptr self,
                   SymbTableIter* iter,
                   const unsigned int mask);

void
SymbCache_next_iter(const SymbCache_ptr self,
                    SymbTableIter* iter);

boolean SymbCache_is_iter_end(const SymbCache_ptr self,
                                     const SymbTableIter* iter);

node_ptr SymbCache_iter_get_symbol(const SymbCache_ptr self,
                                          const SymbTableIter* iter);

void SymbCache_iter_set_filter(const SymbCache_ptr self,
                                      SymbTableIter* iter,
                                      SymbTableIterFilterFun filter,
                                      void* arg);

int SymbCache_get_constants_num(const SymbCache_ptr self);

int SymbCache_get_state_vars_num(const SymbCache_ptr self);

int SymbCache_get_frozen_vars_num(const SymbCache_ptr self);

int SymbCache_get_input_vars_num(const SymbCache_ptr self);

int SymbCache_get_defines_num(const SymbCache_ptr self);

int SymbCache_get_functions_num(const SymbCache_ptr self);

int SymbCache_get_parameters_num(const SymbCache_ptr self);

int SymbCache_get_array_defines_num(const SymbCache_ptr self);

int SymbCache_get_variable_arrays_num(const SymbCache_ptr self);

int SymbCache_get_symbols_num(const SymbCache_ptr self);


void
SymbCache_add_trigger(const SymbCache_ptr self,
                      SymbTableTriggerFun trigger,
                      SymbTableTriggerAction action,
                      void* arg1, boolean must_free_arg);

void
SymbCache_remove_trigger(const SymbCache_ptr self,
                         SymbTableTriggerFun trigger,
                         SymbTableTriggerAction action);


void SymbCache_remove_parameter(SymbCache_ptr self, node_ptr formal);

void SymbCache_remove_variable_array(SymbCache_ptr self, node_ptr symbol);


#endif /* __NUSMV_CORE_COMPILE_SYMB_TABLE_SYMB_CACHE_PRIVATE_H__ */

---