gdb/mi/mi-cmds.h

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