| 1 | /* MI Command Set for GDB, the GNU debugger. |
| 2 | |
| 3 | Copyright 2000, 2003, 2004 Free Software Foundation, Inc. |
| 4 | |
| 5 | Contributed by Cygnus Solutions (a Red Hat company). |
| 6 | |
| 7 | This file is part of GDB. |
| 8 | |
| 9 | This program is free software; you can redistribute it and/or modify |
| 10 | it under the terms of the GNU General Public License as published by |
| 11 | the Free Software Foundation; either version 2 of the License, or |
| 12 | (at your option) any later version. |
| 13 | |
| 14 | This program is distributed in the hope that it will be useful, |
| 15 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | GNU General Public License for more details. |
| 18 | |
| 19 | You should have received a copy of the GNU General Public License |
| 20 | along with this program; if not, write to the Free Software |
| 21 | Foundation, Inc., 59 Temple Place - Suite 330, |
| 22 | Boston, MA 02111-1307, USA. */ |
| 23 | |
| 24 | #ifndef MI_CMDS_H |
| 25 | #define MI_CMDS_H |
| 26 | |
| 27 | /* An MI command can return any of the following. */ |
| 28 | |
| 29 | enum mi_cmd_result |
| 30 | { |
| 31 | /* Report the command as ``done''. Display both the ``NNN^done'' |
| 32 | message and the completion prompt. */ |
| 33 | MI_CMD_DONE = 0, |
| 34 | /* The command is still running in the forground. Main loop should |
| 35 | display the completion prompt. */ |
| 36 | MI_CMD_FORGROUND, |
| 37 | /* An error condition was detected and an error message was |
| 38 | asprintf'd into the mi_error_message buffer. The main loop will |
| 39 | display the error message and the completion prompt. */ |
| 40 | MI_CMD_ERROR, |
| 41 | /* The MI command has already displayed its completion message. |
| 42 | Main loop will not display a completion message but will display |
| 43 | the completion prompt. */ |
| 44 | MI_CMD_QUIET |
| 45 | }; |
| 46 | |
| 47 | enum print_values { |
| 48 | PRINT_NO_VALUES, |
| 49 | PRINT_ALL_VALUES, |
| 50 | PRINT_SIMPLE_VALUES |
| 51 | }; |
| 52 | |
| 53 | typedef enum mi_cmd_result (mi_cmd_argv_ftype) (char *command, char **argv, int argc); |
| 54 | |
| 55 | /* Older MI commands have this interface. Retained until all old |
| 56 | commands are flushed. */ |
| 57 | |
| 58 | typedef enum mi_cmd_result (mi_cmd_args_ftype) ( /*ui */ char *args, int from_tty); |
| 59 | |
| 60 | /* Function implementing each command */ |
| 61 | extern mi_cmd_argv_ftype mi_cmd_break_insert; |
| 62 | extern mi_cmd_argv_ftype mi_cmd_break_watch; |
| 63 | extern mi_cmd_argv_ftype mi_cmd_disassemble; |
| 64 | extern mi_cmd_argv_ftype mi_cmd_data_evaluate_expression; |
| 65 | extern mi_cmd_argv_ftype mi_cmd_data_list_register_names; |
| 66 | extern mi_cmd_argv_ftype mi_cmd_data_list_register_values; |
| 67 | extern mi_cmd_argv_ftype mi_cmd_data_list_changed_registers; |
| 68 | extern mi_cmd_argv_ftype mi_cmd_data_read_memory; |
| 69 | extern mi_cmd_argv_ftype mi_cmd_data_write_memory; |
| 70 | extern mi_cmd_argv_ftype mi_cmd_data_write_register_values; |
| 71 | extern mi_cmd_argv_ftype mi_cmd_env_cd; |
| 72 | extern mi_cmd_argv_ftype mi_cmd_env_dir; |
| 73 | extern mi_cmd_argv_ftype mi_cmd_env_path; |
| 74 | extern mi_cmd_argv_ftype mi_cmd_env_pwd; |
| 75 | extern mi_cmd_args_ftype mi_cmd_exec_continue; |
| 76 | extern mi_cmd_args_ftype mi_cmd_exec_finish; |
| 77 | extern mi_cmd_args_ftype mi_cmd_exec_next; |
| 78 | extern mi_cmd_args_ftype mi_cmd_exec_next_instruction; |
| 79 | extern mi_cmd_args_ftype mi_cmd_exec_return; |
| 80 | extern mi_cmd_args_ftype mi_cmd_exec_run; |
| 81 | extern mi_cmd_args_ftype mi_cmd_exec_step; |
| 82 | extern mi_cmd_args_ftype mi_cmd_exec_step_instruction; |
| 83 | extern mi_cmd_args_ftype mi_cmd_exec_until; |
| 84 | extern mi_cmd_args_ftype mi_cmd_exec_interrupt; |
| 85 | extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_file; |
| 86 | extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_files; |
| 87 | extern mi_cmd_argv_ftype mi_cmd_gdb_exit; |
| 88 | extern mi_cmd_argv_ftype mi_cmd_interpreter_exec; |
| 89 | extern mi_cmd_argv_ftype mi_cmd_stack_info_depth; |
| 90 | extern mi_cmd_argv_ftype mi_cmd_stack_info_frame; |
| 91 | extern mi_cmd_argv_ftype mi_cmd_stack_list_args; |
| 92 | extern mi_cmd_argv_ftype mi_cmd_stack_list_frames; |
| 93 | extern mi_cmd_argv_ftype mi_cmd_stack_list_locals; |
| 94 | extern mi_cmd_argv_ftype mi_cmd_stack_select_frame; |
| 95 | extern mi_cmd_argv_ftype mi_cmd_symbol_list_lines; |
| 96 | extern mi_cmd_args_ftype mi_cmd_target_download; |
| 97 | extern mi_cmd_args_ftype mi_cmd_target_select; |
| 98 | extern mi_cmd_argv_ftype mi_cmd_thread_list_ids; |
| 99 | extern mi_cmd_argv_ftype mi_cmd_thread_select; |
| 100 | extern mi_cmd_argv_ftype mi_cmd_var_assign; |
| 101 | extern mi_cmd_argv_ftype mi_cmd_var_create; |
| 102 | extern mi_cmd_argv_ftype mi_cmd_var_delete; |
| 103 | extern mi_cmd_argv_ftype mi_cmd_var_evaluate_expression; |
| 104 | extern mi_cmd_argv_ftype mi_cmd_var_info_expression; |
| 105 | extern mi_cmd_argv_ftype mi_cmd_var_info_num_children; |
| 106 | extern mi_cmd_argv_ftype mi_cmd_var_info_type; |
| 107 | extern mi_cmd_argv_ftype mi_cmd_var_list_children; |
| 108 | extern mi_cmd_argv_ftype mi_cmd_var_set_format; |
| 109 | extern mi_cmd_argv_ftype mi_cmd_var_show_attributes; |
| 110 | extern mi_cmd_argv_ftype mi_cmd_var_show_format; |
| 111 | extern mi_cmd_argv_ftype mi_cmd_var_update; |
| 112 | |
| 113 | /* Description of a single command. */ |
| 114 | |
| 115 | struct mi_cli |
| 116 | { |
| 117 | /* Corresponding CLI command. If ARGS_P is non-zero, the MI |
| 118 | command's argument list is appended to the CLI command. */ |
| 119 | const char *cmd; |
| 120 | int args_p; |
| 121 | }; |
| 122 | |
| 123 | struct mi_cmd |
| 124 | { |
| 125 | /* official name of the command. */ |
| 126 | const char *name; |
| 127 | /* The corresponding CLI command that can be used to implement this |
| 128 | MI command (if cli.lhs is non NULL). */ |
| 129 | struct mi_cli cli; |
| 130 | /* If non-null, the function implementing the MI command. */ |
| 131 | mi_cmd_args_ftype *args_func; |
| 132 | /* If non-null, the function implementing the MI command. */ |
| 133 | mi_cmd_argv_ftype *argv_func; |
| 134 | }; |
| 135 | |
| 136 | /* Lookup a command in the mi comand table */ |
| 137 | |
| 138 | extern struct mi_cmd *mi_lookup (const char *command); |
| 139 | |
| 140 | /* Debug flag */ |
| 141 | extern int mi_debug_p; |
| 142 | |
| 143 | /* Raw console output - FIXME: should this be a parameter? */ |
| 144 | extern struct ui_file *raw_stdout; |
| 145 | |
| 146 | extern char *mi_error_message; |
| 147 | extern void mi_execute_command (char *cmd, int from_tty); |
| 148 | |
| 149 | #endif |