NuSMV Developers Manual: NuSMV/code/nusmv/core/enc/base/BaseEnc.h Source File

00001 /* ---------------------------------------------------------------------------
00002 
00003 
00004   This file is part of the ``enc.base'' package of NuSMV version 2.
00005   Copyright (C) 2004 by FBK-irst.
00006 
00007   NuSMV version 2 is free software; you can redistribute it and/or
00008   modify it under the terms of the GNU Lesser General Public
00009   License as published by the Free Software Foundation; either
00010   version 2 of the License, or (at your option) any later version.
00011 
00012   NuSMV version 2 is distributed in the hope that it will be useful,
00013   but WITHOUT ANY WARRANTY; without even the implied warranty of
00014   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015   Lesser General Public License for more details.
00016 
00017   You should have received a copy of the GNU Lesser General Public
00018   License along with this library; if not, write to the Free Software
00019   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.
00020 
00021   For more information on NuSMV see <http://nusmv.fbk.eu>
00022   or email to <nusmv-users@fbk.eu>.
00023   Please report bugs to <nusmv-users@fbk.eu>.
00024 
00025   To contact the NuSMV development board, email to <nusmv@fbk.eu>. 
00026 
00027 -----------------------------------------------------------------------------*/
00028 
00039 #ifndef __NUSMV_CORE_ENC_BASE_BASE_ENC_H__
00040 #define __NUSMV_CORE_ENC_BASE_BASE_ENC_H__
00041 
00042 #include "nusmv/core/compile/symb_table/SymbTable.h"
00043 
00044 #include "nusmv/core/utils/object.h"
00045 #include "nusmv/core/utils/utils.h"
00046 
00053 typedef struct BaseEnc_TAG*  BaseEnc_ptr;
00054 
00061 #define BASE_ENC(self) \
00062          ((BaseEnc_ptr) self)
00063 
00069 #define BASE_ENC_CHECK_INSTANCE(self) \
00070          (nusmv_assert(BASE_ENC(self) != BASE_ENC(NULL)))
00071 
00072 
00073 
00076 /*---------------------------------------------------------------------------*/
00077 /* Function prototypes                                                       */
00078 /*---------------------------------------------------------------------------*/
00079 
00089 SymbTable_ptr BaseEnc_get_symb_table(const BaseEnc_ptr self);
00090 
00102 TypeChecker_ptr
00103 BaseEnc_get_type_checker(const BaseEnc_ptr self);
00104 
00112 boolean
00113 BaseEnc_layer_occurs(const BaseEnc_ptr self, const char* layer_name);
00114 
00123 NodeList_ptr
00124 BaseEnc_get_committed_layers(const BaseEnc_ptr self);
00125 
00135 const array_t*
00136 BaseEnc_get_committed_layer_names(BaseEnc_ptr self);
00137 
00145 int
00146 BaseEnc_commit_layers(BaseEnc_ptr self,
00147                       const array_t* layer_names);
00148 
00159 int
00160 BaseEnc_remove_layers(BaseEnc_ptr self,
00161                       const array_t* layer_names);
00162 
00170 VIRTUAL void BaseEnc_destroy(BaseEnc_ptr self);
00171 
00180 VIRTUAL void BaseEnc_commit_layer(BaseEnc_ptr self,
00181                                          const char* layer_name);
00182 
00192 VIRTUAL void BaseEnc_remove_layer(BaseEnc_ptr self,
00193                                          const char* layer_name);
00194 
00195 
00200 #endif /* __NUSMV_CORE_ENC_BASE_BASE_ENC_H__ */