NuSMV/code/nusmv/core/enc/be/BeEnc.h

Go to the documentation of this file.

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


  This file is part of the ``enc.be'' 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_ENC_BE_BE_ENC_H__
#define __NUSMV_CORE_ENC_BE_BE_ENC_H__


#include "nusmv/core/enc/base/BoolEncClient.h" 
#include "nusmv/core/enc/bool/BoolEnc.h"
#include "nusmv/core/compile/symb_table/SymbTable.h"
#include "nusmv/core/be/be.h"
#include "nusmv/core/node/node.h"

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

typedef struct BeEnc_TAG*  BeEnc_ptr;

#define BE_ENC(self) \
         ((BeEnc_ptr) self)

#define BE_ENC_CHECK_INSTANCE(self) \
         (nusmv_assert(BE_ENC(self) != BE_ENC(NULL)))

#define BE_CURRENT_UNTIMED -1


typedef enum BeVarType_TAG {
  BE_VAR_TYPE_CURR   = 0x1 << 0, 
  BE_VAR_TYPE_FROZEN = 0x1 << 1, 
  BE_VAR_TYPE_INPUT  = 0x1 << 2, 
  BE_VAR_TYPE_NEXT   = 0x1 << 3,

  /* a shorthand for all legal types */
  BE_VAR_TYPE_ALL    = BE_VAR_TYPE_CURR | BE_VAR_TYPE_FROZEN | 
                       BE_VAR_TYPE_INPUT | BE_VAR_TYPE_NEXT,
  /* this value is used internally to represent erroneous situations */
  BE_VAR_TYPE_ERROR  = 0x1 << 4,
} BeVarType;

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

BeEnc_ptr BeEnc_create(SymbTable_ptr symb_table, 
                              BoolEnc_ptr bool_enc);

VIRTUAL 
void BeEnc_destroy(BeEnc_ptr self);

/* Getters: */

Be_Manager_ptr BeEnc_get_be_manager(const BeEnc_ptr self);

int BeEnc_get_state_vars_num(const BeEnc_ptr self);

int BeEnc_get_frozen_vars_num(const BeEnc_ptr self);

int BeEnc_get_input_vars_num(const BeEnc_ptr self);

int BeEnc_get_vars_num(const BeEnc_ptr self);

int BeEnc_get_max_time(const BeEnc_ptr self);


/* Conversion of name to something */

be_ptr 
BeEnc_name_to_untimed(const BeEnc_ptr self, const node_ptr var_name);

int 
BeEnc_name_to_index(const BeEnc_ptr self, const node_ptr name);

be_ptr 
BeEnc_name_to_timed(const BeEnc_ptr self, 
                    const node_ptr name, const int time);


/* Conversion of index to something */

node_ptr 
BeEnc_index_to_name(const BeEnc_ptr self, const int index);

be_ptr 
BeEnc_index_to_var(const BeEnc_ptr self, const int index);

be_ptr 
BeEnc_index_to_timed(const BeEnc_ptr self, const int index, 
                     const int time);

int BeEnc_index_to_time(const BeEnc_ptr self, const int index);

int 
BeEnc_index_to_untimed_index(const BeEnc_ptr self, const int index);

/* Conversion of be variable to something */

node_ptr 
BeEnc_var_to_name(const BeEnc_ptr self, be_ptr be_var);

int 
BeEnc_var_to_index(const BeEnc_ptr self, const be_ptr var);

be_ptr 
BeEnc_var_to_timed(const BeEnc_ptr self, const be_ptr var, 
                   const int time);

be_ptr 
BeEnc_var_to_untimed(const BeEnc_ptr self, const be_ptr var);

be_ptr 
BeEnc_var_curr_to_next(const BeEnc_ptr self, const be_ptr curr);

be_ptr 
BeEnc_var_next_to_curr(const BeEnc_ptr self, const be_ptr next); 


/* Shifting of expressions */

be_ptr 
BeEnc_shift_curr_to_next(BeEnc_ptr self, const be_ptr exp);

be_ptr 
BeEnc_untimed_expr_to_timed(BeEnc_ptr self, const be_ptr exp, 
                            const int time);

be_ptr 
BeEnc_untimed_expr_to_times(BeEnc_ptr self, const be_ptr exp, 
                            const int ctime, 
                            const int ftime, 
                            const int itime, 
                            const int ntime);

be_ptr 
BeEnc_untimed_to_timed_and_interval(BeEnc_ptr self, 
                                    const be_ptr exp, 
                                    const int from, const int to);

be_ptr 
BeEnc_untimed_to_timed_or_interval(BeEnc_ptr self, 
                                   const be_ptr exp, 
                                   const int from, const int to);


/* Tests on type of be variables' indices */

boolean 
BeEnc_is_index_state_var(const BeEnc_ptr self, const int index);

boolean 
BeEnc_is_index_frozen_var(const BeEnc_ptr self, const int index);

boolean 
BeEnc_is_index_input_var(const BeEnc_ptr self, const int index);

boolean 
BeEnc_is_index_untimed(const BeEnc_ptr self, const int index);

boolean 
BeEnc_is_index_untimed_curr(const BeEnc_ptr self, const int index);

boolean 
BeEnc_is_index_untimed_frozen(const BeEnc_ptr self, const int index);

boolean 
BeEnc_is_index_untimed_input(const BeEnc_ptr self, const int index);

boolean 
BeEnc_is_index_untimed_curr_frozen_input(const BeEnc_ptr self, 
                                         const int index);

boolean 
BeEnc_is_index_untimed_next(const BeEnc_ptr self, const int index);


/* Iteration over set of untimed variables */

int 
BeEnc_get_first_untimed_var_index(const BeEnc_ptr self, BeVarType type);

int 
BeEnc_get_next_var_index(const BeEnc_ptr self, 
                         int var_index, BeVarType type);

int 
BeEnc_get_var_index_with_offset(const BeEnc_ptr self, 
                                int from_index, int offset, 
                                BeVarType type);

boolean 
BeEnc_is_var_index_valid(const BeEnc_ptr self, int var_index);




#endif /* __NUSMV_CORE_ENC_BE_BE_ENC_H__ */

---