NuSMV Developers Manual: NuSMV/code/nusmv/shell/cmd/cmdCmd.h Source File

00001 /* ---------------------------------------------------------------------------
00002 
00003 
00004   This file is part of the ``required'' package.
00005   %COPYRIGHT%
00006   
00007 
00008 -----------------------------------------------------------------------------*/
00009 
00019 #ifndef __NUSMV_SHELL_CMD_CMD_CMD_H__
00020 #define __NUSMV_SHELL_CMD_CMD_CMD_H__
00021 
00022 #include "nusmv/core/cinit/NuSMVEnv.h"
00023 
00024 /*---------------------------------------------------------------------------*/
00025 /* Constant declarations                                                     */
00026 /*---------------------------------------------------------------------------*/
00027 
00028 
00029 /*---------------------------------------------------------------------------*/
00030 /* Type declarations                                                         */
00031 /*---------------------------------------------------------------------------*/
00032 
00033 
00034 /*---------------------------------------------------------------------------*/
00035 /* Structure declarations                                                    */
00036 /*---------------------------------------------------------------------------*/
00037 
00038 
00039 //used to import command help list from cmdHelp.c
00040 typedef struct command_item_TAG {
00041       const char* command_name;
00042       const char* command_description;
00043 } command_item;
00044 
00045 extern command_item command_help[];
00046 extern int command_number;
00047 
00048 
00049 /*---------------------------------------------------------------------------*/
00050 /* Variable declarations                                                     */
00051 /*---------------------------------------------------------------------------*/
00052 
00053 
00054 /*---------------------------------------------------------------------------*/
00055 /* Macro declarations                                                        */
00056 /*---------------------------------------------------------------------------*/
00057 
00063 #define ENV_CMD_HELP           "CMD_HELP"
00064 
00067 /*---------------------------------------------------------------------------*/
00068 /* Function prototypes                                                       */
00069 /*---------------------------------------------------------------------------*/
00070 
00076 char* cmd_help_get(NuSMVEnv_ptr env, char* command_name);
00077 
00083 void cmd_help_add(NuSMVEnv_ptr env, const char* command_name, const char* command_description);
00084 
00090 void cmd_help_remove(NuSMVEnv_ptr env, char* command_name);
00091 
00097 void Cmd_init_cmd(NuSMVEnv_ptr env);
00098 
00104 void Cmd_quit_cmd(NuSMVEnv_ptr env);
00105 
00113 int Cmd_command_not_available(NuSMVEnv_ptr env, int argc, char** argv);
00114 
00117 #endif /* __NUSMV_SHELL_CMD_CMD_CMD_H__ */