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

Go to the documentation of this file.

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

  This file is part of the ``cinit'' package of NuSMV version 2.
  Copyright (C) 1998-2001 by CMU and 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_CINIT_H__
#define __NUSMV_CORE_CINIT_CINIT_H__

/*---------------------------------------------------------------------------*/
/* Nested includes                                                           */
/*---------------------------------------------------------------------------*/
#include "cudd/util.h"
#include "nusmv/core/utils/utils.h"
#include "nusmv/core/opt/OptsHandler.h"
#include "nusmv/core/cinit/NuSMVEnv.h"

/*---------------------------------------------------------------------------*/
/* Constant declarations                                                     */
/*---------------------------------------------------------------------------*/

#ifndef NUSMV_LIBRARY_NAME

#define NUSMV_LIBRARY_NAME "NuSMV"
#endif

#ifndef NUSMV_LIBRARY_VERSION

#define NUSMV_LIBRARY_VERSION "2.5.0"
#endif

#ifndef NUSMV_LIBRARY_BUILD_DATE

#define NUSMV_LIBRARY_BUILD_DATE "<compile date not supplied>"
#endif

#ifndef NUSMV_LIBRARY_EMAIL

#define NUSMV_LIBRARY_EMAIL "nusmv-users@list.fbk.eu"
#endif

#ifndef NUSMV_LIBRARY_WEBSITE

#define NUSMV_LIBRARY_WEBSITE "http://nusmv.fbk.eu"
#endif

#ifndef NUSMV_LIBRARY_BUGREPORT

#define NUSMV_LIBRARY_BUGREPORT "Please report bugs to <nusmv-users@fbk.eu>"
#endif


/*---------------------------------------------------------------------------*/
/* Variable declarations                                                     */
/*---------------------------------------------------------------------------*/
extern FILE *nusmv_historyFile;

/*---------------------------------------------------------------------------*/
/* Macro declarations                                                        */
/*---------------------------------------------------------------------------*/

typedef void (*FP_V_E)(NuSMVEnv_ptr);

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

char * CInit_NuSMVReadVersion(void);

char * CInit_NuSMVObtainLibrary(void);

void CInit_BannerPrint(FILE * file);

void CInit_BannerPrintLibrary(FILE * file);

void CInit_BannerPrint_nusmv_library(FILE * file);

void CInit_BannerPrint_cudd(FILE * file);

void CInit_BannerPrint_minisat(FILE * file);

void CInit_BannerPrint_zchaff(FILE * file);

char* get_preprocessor_call(const NuSMVEnv_ptr env, const char* name);

char* get_preprocessor_filename(const NuSMVEnv_ptr env, const char* name);

char* get_preprocessor_names(const NuSMVEnv_ptr env);

int get_preprocessors_num(const NuSMVEnv_ptr env);

char* NuSMVCore_get_tool_name(void);

char* NuSMVCore_get_tool_rc_file_name(void);

void NuSMVCore_set_tool_name(char* tool_name);

char* NuSMVCore_get_tool_version(void);

void NuSMVCore_set_tool_version(char* tool_version);

char* NuSMVCore_get_build_date(void);

void NuSMVCore_set_build_date(char* build_date);

char* NuSMVCore_get_prompt_string(void);

void NuSMVCore_set_prompt_string(char* prompt_string);

char* NuSMVCore_get_email(void);

void NuSMVCore_set_email(char* email);

char* NuSMVCore_get_website(void);

void NuSMVCore_set_website(char* website);

char* NuSMVCore_get_bug_report_message(void);

void NuSMVCore_set_bug_report_message(char* bug_report_message);

char* NuSMVCore_get_linked_addons(void);

void NuSMVCore_set_linked_addons(char* linked_addons);

char* NuSMVCore_get_library_name(void);

void  NuSMVCore_set_library_name(const char *);

char* NuSMVCore_get_library_version(void);

char* NuSMVCore_get_library_build_date(void);

void  NuSMVCore_set_library_build_date(const char *);

char* NuSMVCore_get_library_email(void);

void  NuSMVCore_set_library_email(const char *);

char* NuSMVCore_get_library_website(void);

void  NuSMVCore_set_library_website(const char *);

char* NuSMVCore_get_library_bug_report_message(void);

void NuSMVCore_set_banner_print_fun(void (*banner_print_fun)(FILE*));

void NuSMVCore_set_batch_fun(void (*batch_fun)(NuSMVEnv_ptr));

/* Macros to document the function calls */

#define CINIT_NO_PARAMETER NULL

#define CINIT_IS_DEPRECATED true

#define CINIT_IS_PUBLIC true

#define CINIT_NO_DEPENDENCY NULL

#define CINIT_NO_CONFLICT NULL

void NuSMVCore_add_env_command_line_option(char* name,
                                           char* usage,
                                           char* parameter,
                                           char* env_var,
                                           boolean is_deprecated,
                                           boolean is_public,
                                           char* dependency,
                                           char* conflict);

void
NuSMVCore_add_command_line_option(char* name,
                                  char* usage,
                                  char* parameter,
                                  boolean (*check_and_apply)(OptsHandler_ptr, char*, NuSMVEnv_ptr),
                                  boolean is_deprecated,
                                  boolean is_public,
                                  char* dependency,
                                  char* conflict);

void NuSMVCore_init_data(void);

void NuSMVCore_init(NuSMVEnv_ptr env, FP_V_E fns[][2], int);

boolean NuSMVCore_main(NuSMVEnv_ptr env, int argc,
                              char ** argv, int* status);

void NuSMVCore_init_cmd_options(NuSMVEnv_ptr env);

void NuSMVCore_reset(NuSMVEnv_ptr env);

void NuSMVCore_quit(NuSMVEnv_ptr env);

void NuSMVCore_quit_extended(NuSMVEnv_ptr env,
                                    const boolean keep_core_data);

void init_preprocessors(const NuSMVEnv_ptr env);

void quit_preprocessors(const NuSMVEnv_ptr env);

#endif /* __NUSMV_CORE_CINIT_CINIT_H__ */

---