NuSMV/code/nusmv/core/compile/symb_table/SymbCache.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_H__
#define __NUSMV_CORE_COMPILE_SYMB_TABLE_SYMB_CACHE_H__

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

typedef struct SymbCache_TAG*  SymbCache_ptr;

#define SYMB_CACHE(x) \
          ((SymbCache_ptr) x)

#define SYMB_CACHE_CHECK_INSTANCE(x) \
          ( nusmv_assert(SYMB_CACHE(x) != SYMB_CACHE(NULL)) )


/* ---------------------------------------------------------------------- */
/* Class SymbCache's public methods                                       */
/* ---------------------------------------------------------------------- */

NuSMVEnv_ptr SymbCache_get_environment(const SymbCache_ptr self);

SymbType_ptr
SymbCache_get_var_type(const SymbCache_ptr self, const node_ptr name);

node_ptr
SymbCache_get_define_body(const SymbCache_ptr self,
                          const node_ptr name);

node_ptr
SymbCache_get_actual_parameter(const SymbCache_ptr self,
                               const node_ptr name);

node_ptr
SymbCache_get_array_define_body(const SymbCache_ptr self,
                                 const node_ptr name);

SymbType_ptr
SymbCache_get_variable_array_type(const SymbCache_ptr self,
                               const node_ptr name);

SymbType_ptr
SymbCache_get_function_type(const SymbCache_ptr self,
                            const node_ptr name);

node_ptr
SymbCache_get_define_flatten_body(const SymbCache_ptr self,
                                  const node_ptr name);

node_ptr
SymbCache_get_flatten_actual_parameter(const SymbCache_ptr self,
                                       const node_ptr name);

node_ptr
SymbCache_get_define_context(const SymbCache_ptr self,
                             const node_ptr name);

node_ptr
SymbCache_get_function_context(const SymbCache_ptr self,
                                 const node_ptr name);

node_ptr
SymbCache_get_actual_parameter_context(const SymbCache_ptr self,
                                       const node_ptr name);

node_ptr
SymbCache_get_array_define_context(const SymbCache_ptr self,
                                    const node_ptr name);

boolean
SymbCache_is_symbol_state_var(const SymbCache_ptr self,
                              const node_ptr name);

boolean
SymbCache_is_symbol_frozen_var(const SymbCache_ptr self,
                                const node_ptr name);

boolean
SymbCache_is_symbol_state_frozen_var(const SymbCache_ptr self,
                                const node_ptr name);

boolean
SymbCache_is_symbol_input_var(const SymbCache_ptr self,
                              const node_ptr name);

boolean
SymbCache_is_symbol_var(const SymbCache_ptr self, const node_ptr name);

boolean
SymbCache_is_symbol_declared(const SymbCache_ptr self,
                             const node_ptr name);

boolean
SymbCache_is_symbol_define(const SymbCache_ptr self,
                           const node_ptr name);

boolean
SymbCache_is_symbol_function(const SymbCache_ptr self,
                               const node_ptr name);

boolean
SymbCache_is_symbol_parameter(const SymbCache_ptr self,
                           const node_ptr name);

boolean
SymbCache_is_symbol_array_define(const SymbCache_ptr self,
                                  const node_ptr name);

boolean
SymbCache_is_symbol_variable_array(const SymbCache_ptr self,
                                   const node_ptr name);


boolean
SymbCache_is_symbol_constant(const SymbCache_ptr self,
                             const node_ptr name);

boolean
SymbCache_list_contains_input_var(const SymbCache_ptr self,
                                  const NodeList_ptr var_list);

boolean
SymbCache_list_contains_state_frozen_var(const SymbCache_ptr self,
                                  const NodeList_ptr var_list);

boolean
SymbCache_list_contains_undef_var(const SymbCache_ptr self,
                                  const NodeList_ptr var_list);



#endif /* __NUSMV_CORE_COMPILE_SYMB_TABLE_SYMB_CACHE_H__ */

---