NuSMV/code/nusmv/core/compile/symb_table/SymbLayer.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_LAYER_H__
#define __NUSMV_CORE_COMPILE_SYMB_TABLE_SYMB_LAYER_H__

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

typedef struct SymbLayer_TAG* SymbLayer_ptr;

#define SYMB_LAYER(x)  \
        ((SymbLayer_ptr) x)

#define SYMB_LAYER_CHECK_INSTANCE(x)  \
        (nusmv_assert(SYMB_LAYER(x) != SYMB_LAYER(NULL)))


typedef enum LayerInsertPolicy_TAG {
  SYMB_LAYER_POS_DEFAULT,   /* default is equal to SYMB_LAYER_POS_TOP */
  SYMB_LAYER_POS_FORCE_TOP, /* layer is forced to be always at the top */
  SYMB_LAYER_POS_TOP,       /* Inserted before other top */
  SYMB_LAYER_POS_BOTTOM,    /* inserted after other bottom */
  SYMB_LAYER_POS_FORCE_BOTTOM /* layer is forced to be always at the bottom */
} LayerInsertPolicy;

typedef boolean (*SymbLayerIterFilterFun)(const SymbLayer_ptr layer,
                                          const node_ptr sym,
                                          void* arg);

typedef struct SymbLayerIter_TAG {
  unsigned int index;
  unsigned int mask;
  SymbLayerIterFilterFun filter;
  void* arg;
} SymbLayerIter;

#define SYMB_LAYER_FOREACH(self, iter, mask)             \
  for (SymbLayer_gen_iter(self, &iter, mask);            \
       !SymbLayer_iter_is_end(self, &iter);              \
       SymbLayer_iter_next(self, &iter))

#define SYMB_LAYER_FOREACH_FILTER(self, iter, mask, filter, arg)        \
  for (SymbLayer_gen_iter(self, &iter, mask),                           \
         SymbLayer_iter_set_filter(self, &iter, filter, arg);           \
       !SymbLayer_iter_is_end(self, &iter);                             \
       SymbLayer_iter_next(self, &iter))


/* ---------------------------------------------------------------------- */
/*     Public methods                                                     */
/* ---------------------------------------------------------------------- */


/* Iterators */

void SymbLayer_gen_iter(const SymbLayer_ptr self,
                               SymbLayerIter* iter,
                               unsigned int mask);

void SymbLayer_iter_next(const SymbLayer_ptr self,
                                SymbLayerIter* iter);

boolean SymbLayer_iter_is_end(const SymbLayer_ptr self,
                                     const SymbLayerIter* iter);

node_ptr SymbLayer_iter_get_symbol(const SymbLayer_ptr self,
                                          const SymbLayerIter* iter);

void
SymbLayer_iter_set_filter(const SymbLayer_ptr layer,
                          SymbLayerIter* iter,
                          SymbLayerIterFilterFun fun,
                          void* arg);

boolean
SymbLayer_iter_filter_bool_vars(const SymbLayer_ptr self,
                                const node_ptr sym,
                                void* arg);

Set_t
SymbLayer_iter_to_set(const SymbLayer_ptr self, SymbLayerIter iter);

NodeList_ptr
SymbLayer_iter_to_list(const SymbLayer_ptr self, SymbLayerIter iter);

unsigned int
SymbLayer_iter_count(const SymbLayer_ptr self, SymbLayerIter iter);

const char*
SymbLayer_get_name(const SymbLayer_ptr self);

boolean
SymbLayer_can_declare_constant(const SymbLayer_ptr self,
                               const node_ptr name);

void
SymbLayer_declare_constant(SymbLayer_ptr self, node_ptr name);

boolean
SymbLayer_can_declare_var(const SymbLayer_ptr self,
                          const node_ptr name);

void
SymbLayer_declare_input_var(SymbLayer_ptr self, node_ptr var,
                            SymbType_ptr type);

void
SymbLayer_declare_state_var(SymbLayer_ptr self, node_ptr var,
                            SymbType_ptr type);

void
SymbLayer_declare_frozen_var(SymbLayer_ptr self, node_ptr var,
                            SymbType_ptr type);

void
SymbLayer_redeclare_state_as_frozen_var(SymbLayer_ptr self, node_ptr var);

boolean
SymbLayer_can_declare_define(const SymbLayer_ptr self,
                             const node_ptr name);

boolean
SymbLayer_can_declare_function(const SymbLayer_ptr self,
                                 const node_ptr name);

boolean
SymbLayer_can_declare_parameter(const SymbLayer_ptr self,
                                const node_ptr name);

boolean
SymbLayer_can_declare_array_define(const SymbLayer_ptr self,
                             const node_ptr name);

boolean
SymbLayer_can_declare_variable_array(const SymbLayer_ptr self,
                                  const node_ptr name);

void
SymbLayer_declare_define(SymbLayer_ptr self, node_ptr name,
                         node_ptr ctx, node_ptr definition);

void
SymbLayer_declare_function(SymbLayer_ptr self, node_ptr name,
                           node_ptr ctx, SymbType_ptr type);

void
SymbLayer_declare_parameter(SymbLayer_ptr self, node_ptr formal,
                            node_ptr ctx, node_ptr actual);

void
SymbLayer_declare_array_define(SymbLayer_ptr self, node_ptr name,
                                node_ptr ctx, node_ptr definition);

void
SymbLayer_declare_variable_array(SymbLayer_ptr self, node_ptr var,
                              SymbType_ptr type);

void SymbLayer_remove_symbol(SymbLayer_ptr self, node_ptr name);

void SymbLayer_remove_var(SymbLayer_ptr self, node_ptr name);

void SymbLayer_remove_define(SymbLayer_ptr self, node_ptr name);

void SymbLayer_remove_function(SymbLayer_ptr self, node_ptr name);

void SymbLayer_remove_variable_array(SymbLayer_ptr self, node_ptr name);


int SymbLayer_get_symbols_num(const SymbLayer_ptr self);

int SymbLayer_get_constants_num(const SymbLayer_ptr self);

int SymbLayer_get_state_vars_num(const SymbLayer_ptr self);

int SymbLayer_get_bool_state_vars_num(const SymbLayer_ptr self);

int SymbLayer_get_frozen_vars_num(const SymbLayer_ptr self);

int SymbLayer_get_bool_frozen_vars_num(const SymbLayer_ptr self);

int SymbLayer_get_input_vars_num(const SymbLayer_ptr self);

int SymbLayer_get_vars_num(const SymbLayer_ptr self);

int SymbLayer_get_bool_input_vars_num(const SymbLayer_ptr self);

int SymbLayer_get_defines_num(const SymbLayer_ptr self);

int SymbLayer_get_functions_num(const SymbLayer_ptr self);

int SymbLayer_get_parameters_num(const SymbLayer_ptr self);

int SymbLayer_get_array_defines_num(const SymbLayer_ptr self);

int SymbLayer_get_variable_arrays_num(const SymbLayer_ptr self);

boolean
SymbLayer_must_insert_before(const SymbLayer_ptr self,
                             const SymbLayer_ptr other);

boolean
SymbLayer_is_variable_in_layer(SymbLayer_ptr self,
                               node_ptr name);

boolean
SymbLayer_is_symbol_in_layer(SymbLayer_ptr self, node_ptr name);

LayerInsertPolicy
SymbLayer_get_insert_policy(const SymbLayer_ptr self);

NuSMVEnv_ptr SymbLayer_get_environment(const SymbLayer_ptr self);

#endif /* __NUSMV_CORE_COMPILE_SYMB_TABLE_SYMB_LAYER_H__ */

---