NuSMV Developers Manual: NuSMV/code/nusmv/core/trace/TraceOpt.h Source File

00001 /* ---------------------------------------------------------------------------
00002 
00003 
00004   This file is part of the ``trace'' package of NuSMV version 2.
00005   Copyright (C) 2010 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 
00037 #ifndef __NUSMV_CORE_TRACE_TRACE_OPT_H__
00038 #define __NUSMV_CORE_TRACE_TRACE_OPT_H__
00039 
00040 #include "nusmv/core/utils/utils.h"
00041 #include "nusmv/core/opt/opt.h"
00042 #include "nusmv/core/utils/StreamMgr.h"
00043 #include "nusmv/core/utils/OStream.h"
00044 
00051 typedef struct TraceOpt_TAG*  TraceOpt_ptr;
00052 
00059 #define TRACE_OPT(self) \
00060          ((TraceOpt_ptr) self)
00061 
00067 #define TRACE_OPT_CHECK_INSTANCE(self) \
00068          (nusmv_assert(TRACE_OPT(self) != TRACE_OPT(NULL)))
00069 
00070 
00071 
00074 /*---------------------------------------------------------------------------*/
00075 /* Function prototypes                                                       */
00076 /*---------------------------------------------------------------------------*/
00077 
00086 TraceOpt_ptr TraceOpt_create(StreamMgr_ptr streams);
00087 
00096 TraceOpt_ptr TraceOpt_create_from_env(const NuSMVEnv_ptr env);
00097 
00106 void TraceOpt_update_from_env(TraceOpt_ptr self,
00107                                      const NuSMVEnv_ptr env);
00108 
00117 void TraceOpt_destroy(TraceOpt_ptr self);
00118 
00127 boolean TraceOpt_obfuscate(TraceOpt_ptr self);
00128 
00137 void TraceOpt_set_obfuscate(TraceOpt_ptr self, boolean obfuscate);
00138 
00147 boolean TraceOpt_show_defines(TraceOpt_ptr self);
00148 
00157 void TraceOpt_set_show_defines(TraceOpt_ptr self,
00158                                       boolean show_defines);
00159 
00168 boolean TraceOpt_show_defines_with_next(TraceOpt_ptr self);
00169 
00178 void TraceOpt_set_show_defines_with_next(TraceOpt_ptr self,
00179                                                 boolean show_next);
00180 
00189 const char* TraceOpt_hiding_prefix(TraceOpt_ptr self);
00190 
00199 void TraceOpt_set_hiding_prefix(TraceOpt_ptr self,
00200                                        const char* hiding_prefix);
00201 
00202 #if NUSMV_HAVE_REGEX_H
00203 
00212 regex_t* TraceOpt_regexp(TraceOpt_ptr self);
00213 #endif
00214 
00223 unsigned TraceOpt_from_here(TraceOpt_ptr self);
00224 
00233 void TraceOpt_set_from_here(TraceOpt_ptr self, unsigned index);
00234 
00243 unsigned TraceOpt_to_here(TraceOpt_ptr self);
00244 
00253 void TraceOpt_set_to_here(TraceOpt_ptr self, unsigned index);
00254 
00263 OStream_ptr TraceOpt_output_stream(TraceOpt_ptr self);
00264 
00273 void TraceOpt_set_output_stream(TraceOpt_ptr self, FILE* out);
00274 
00279 #endif /* __NUSMV_CORE_TRACE_TRACE_OPT_H__ */