NuSMV/code/nusmv/core/cinit/NuSMVEnv.h

Go to the documentation of this file.

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


  This file is part of the ``cinit'' 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_CINIT_NU_SMVENV_H__
#define __NUSMV_CORE_CINIT_NU_SMVENV_H__

#include "nusmv/core/utils/defs.h"
#include "cudd/st.h"

typedef struct NuSMVEnv_TAG*  NuSMVEnv_ptr;

#define NUSMV_ENV(self) \
         ((NuSMVEnv_ptr) self)

#define NUSMV_ENV_CHECK_INSTANCE(self) \
         (nusmv_assert(NUSMV_ENV(self) != NUSMV_ENV(NULL)))

/* Common used keys. Those are "fast" keys, since they start with a
   "+" and have a ascii character that follows it. All printable ASCII
   characters can be used, the rest of the string will be ignored, but
   it is left for debugging purposes */

#define ENV_LOGGER          "+!_logger"

#define ENV_STREAM_MANAGER  "+\"_stream_mgr"

#define ENV_STRING_MGR      "+#_ustring_manager"

#define ENV_WORD_NUMBER_MGR "+$_word_number_mgr"

#define ENV_NODE_MGR        "+%_node_manager"

#define ENV_ERROR_MANAGER   "+&_error_manager"

#define ENV_EXPR_MANAGER    "+'_expr_manager"

#define ENV_WFF_PRINTER     "+(_wff_printer"

#define ENV_IWFF_PRINTER    "+)_iwff_printer"

#define ENV_SEXP_PRINTER    "+*_sexp_printer"

#define ENV_NODE_NORMALIZER "++_normalizer"

#define ENV_OPTS_HANDLER    "+,_opts_handler"

#define ENV_SYMB_TABLE      "+-_symb_table"

#define ENV_FLAT_HIERARCHY  "+._flat_hierarchy"

#define ENV_PROP_DB         "+/_prop_db"

#define ENV_HRC_HIERARCHY   "+0_hrc_hierarchy"

#define ENV_FSM_BUILDER     "+1_fsm_builder"

#define ENV_DD_MGR          "+2_dd_manager"

#define ENV_DD_VARS_HANDLER "+3_dd_vars_hand"

#define ENV_TRACE_MGR       "+4_trace_mgr"

#define ENV_SEXP_FSM        "+5_sexp_fsm"

#define ENV_BOOL_FSM        "+6_bool_fsm"

#define ENV_BDD_FSM         "+7_bdd_fsm"

#define ENV_BE_FSM          "+8_be_fsm"

#define ENV_BOOL_ENCODER    "+9_bool_enc"

#define ENV_BDD_ENCODER     "+:_bdd_enc"

#define ENV_BE_ENCODER      "+;_be_enc"

#define ENV_MSAT_ENCODER    "+<_msat_enc"

#define ENV_FLATTENER       "+=_flattener"

#define ENV_DEPENDENCY      "+>_dependency"

#define ENV_MASTER_LOGIC_RECOGNIZER "+?_master_logic_recognizer"
/* next ascii is "@" */

/*---------------------------------------------------------------------------*/
/* Function prototypes                                                       */
/*---------------------------------------------------------------------------*/
/* Constructors, Destructors, Copiers and Cleaners ****************************/

NuSMVEnv_ptr NuSMVEnv_create(void);

void NuSMVEnv_destroy(NuSMVEnv_ptr self);


/* Getters and Setters ********************************************************/

void* NuSMVEnv_get_value(const NuSMVEnv_ptr self, const char* key);

boolean NuSMVEnv_has_value(const NuSMVEnv_ptr self, const char* key);

void NuSMVEnv_set_value(NuSMVEnv_ptr self, const char* key, void* value);

void* NuSMVEnv_set_or_replace_value(NuSMVEnv_ptr self,
                                           const char* key,
                                           void* value);

void* NuSMVEnv_remove_value(NuSMVEnv_ptr self, const char* key);

boolean NuSMVEnv_get_flag(NuSMVEnv_ptr self, const char* flag);

void NuSMVEnv_set_flag(NuSMVEnv_ptr self,
                              const char* flag, boolean value);

boolean NuSMVEnv_has_flag(NuSMVEnv_ptr self, const char* flag);

boolean NuSMVEnv_remove_flag(NuSMVEnv_ptr self, const char* flag);


/* Self-handled structures */

st_table* NuSMVEnv_get_handled_hash_ptr(NuSMVEnv_ptr self,
                                               const char* key);

#endif /* __NUSMV_CORE_CINIT_NU_SMVENV_H__ */

---