gdb/mi/mi-cmds.h

   1 /* MI Command Set for GDB, the GNU debugger.
   2
   3    Copyright (C) 2000-2021 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 3 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, see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef MI_MI_CMDS_H
  23 #define MI_MI_CMDS_H
  24
  25 enum print_values {
  26    PRINT_NO_VALUES,
  27    PRINT_ALL_VALUES,
  28    PRINT_SIMPLE_VALUES
  29 };
  30
  31 typedef void (mi_cmd_argv_ftype) (const char *command, char **argv, int argc);
  32
  33 /* Declarations of the functions implementing each command.  */
  34
  35 extern mi_cmd_argv_ftype mi_cmd_ada_task_info;
  36 extern mi_cmd_argv_ftype mi_cmd_add_inferior;
  37 extern mi_cmd_argv_ftype mi_cmd_break_insert;
  38 extern mi_cmd_argv_ftype mi_cmd_dprintf_insert;
  39 extern mi_cmd_argv_ftype mi_cmd_break_condition;
  40 extern mi_cmd_argv_ftype mi_cmd_break_commands;
  41 extern mi_cmd_argv_ftype mi_cmd_break_passcount;
  42 extern mi_cmd_argv_ftype mi_cmd_break_watch;
  43 extern mi_cmd_argv_ftype mi_cmd_catch_assert;
  44 extern mi_cmd_argv_ftype mi_cmd_catch_exception;
  45 extern mi_cmd_argv_ftype mi_cmd_catch_handlers;
  46 extern mi_cmd_argv_ftype mi_cmd_catch_load;
  47 extern mi_cmd_argv_ftype mi_cmd_catch_unload;
  48 extern mi_cmd_argv_ftype mi_cmd_catch_throw;
  49 extern mi_cmd_argv_ftype mi_cmd_catch_rethrow;
  50 extern mi_cmd_argv_ftype mi_cmd_catch_catch;
  51 extern mi_cmd_argv_ftype mi_cmd_disassemble;
  52 extern mi_cmd_argv_ftype mi_cmd_data_evaluate_expression;
  53 extern mi_cmd_argv_ftype mi_cmd_data_list_register_names;
  54 extern mi_cmd_argv_ftype mi_cmd_data_list_register_values;
  55 extern mi_cmd_argv_ftype mi_cmd_data_list_changed_registers;
  56 extern mi_cmd_argv_ftype mi_cmd_data_read_memory;
  57 extern mi_cmd_argv_ftype mi_cmd_data_read_memory_bytes;
  58 extern mi_cmd_argv_ftype mi_cmd_data_write_memory;
  59 extern mi_cmd_argv_ftype mi_cmd_data_write_memory_bytes;
  60 extern mi_cmd_argv_ftype mi_cmd_data_write_register_values;
  61 extern mi_cmd_argv_ftype mi_cmd_enable_timings;
  62 extern mi_cmd_argv_ftype mi_cmd_env_cd;
  63 extern mi_cmd_argv_ftype mi_cmd_env_dir;
  64 extern mi_cmd_argv_ftype mi_cmd_env_path;
  65 extern mi_cmd_argv_ftype mi_cmd_env_pwd;
  66 extern mi_cmd_argv_ftype mi_cmd_exec_continue;
  67 extern mi_cmd_argv_ftype mi_cmd_exec_finish;
  68 extern mi_cmd_argv_ftype mi_cmd_exec_interrupt;
  69 extern mi_cmd_argv_ftype mi_cmd_exec_jump;
  70 extern mi_cmd_argv_ftype mi_cmd_exec_next;
  71 extern mi_cmd_argv_ftype mi_cmd_exec_next_instruction;
  72 extern mi_cmd_argv_ftype mi_cmd_exec_return;
  73 extern mi_cmd_argv_ftype mi_cmd_exec_run;
  74 extern mi_cmd_argv_ftype mi_cmd_exec_step;
  75 extern mi_cmd_argv_ftype mi_cmd_exec_step_instruction;
  76 extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_file;
  77 extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_files;
  78 extern mi_cmd_argv_ftype mi_cmd_file_list_shared_libraries;
  79 extern mi_cmd_argv_ftype mi_cmd_gdb_exit;
  80 extern mi_cmd_argv_ftype mi_cmd_inferior_tty_set;
  81 extern mi_cmd_argv_ftype mi_cmd_inferior_tty_show;
  82 extern mi_cmd_argv_ftype mi_cmd_info_ada_exceptions;
  83 extern mi_cmd_argv_ftype mi_cmd_info_gdb_mi_command;
  84 extern mi_cmd_argv_ftype mi_cmd_info_os;
  85 extern mi_cmd_argv_ftype mi_cmd_interpreter_exec;
  86 extern mi_cmd_argv_ftype mi_cmd_list_features;
  87 extern mi_cmd_argv_ftype mi_cmd_list_target_features;
  88 extern mi_cmd_argv_ftype mi_cmd_list_thread_groups;
  89 extern mi_cmd_argv_ftype mi_cmd_remove_inferior;
  90 extern mi_cmd_argv_ftype mi_cmd_stack_info_depth;
  91 extern mi_cmd_argv_ftype mi_cmd_stack_info_frame;
  92 extern mi_cmd_argv_ftype mi_cmd_stack_list_args;
  93 extern mi_cmd_argv_ftype mi_cmd_stack_list_frames;
  94 extern mi_cmd_argv_ftype mi_cmd_stack_list_locals;
  95 extern mi_cmd_argv_ftype mi_cmd_stack_list_variables;
  96 extern mi_cmd_argv_ftype mi_cmd_stack_select_frame;
  97 extern mi_cmd_argv_ftype mi_cmd_symbol_list_lines;
  98 extern mi_cmd_argv_ftype mi_cmd_symbol_info_functions;
  99 extern mi_cmd_argv_ftype mi_cmd_symbol_info_module_functions;
 100 extern mi_cmd_argv_ftype mi_cmd_symbol_info_module_variables;
 101 extern mi_cmd_argv_ftype mi_cmd_symbol_info_modules;
 102 extern mi_cmd_argv_ftype mi_cmd_symbol_info_types;
 103 extern mi_cmd_argv_ftype mi_cmd_symbol_info_variables;
 104 extern mi_cmd_argv_ftype mi_cmd_target_detach;
 105 extern mi_cmd_argv_ftype mi_cmd_target_file_get;
 106 extern mi_cmd_argv_ftype mi_cmd_target_file_put;
 107 extern mi_cmd_argv_ftype mi_cmd_target_file_delete;
 108 extern mi_cmd_argv_ftype mi_cmd_target_flash_erase;
 109 extern mi_cmd_argv_ftype mi_cmd_thread_info;
 110 extern mi_cmd_argv_ftype mi_cmd_thread_list_ids;
 111 extern mi_cmd_argv_ftype mi_cmd_thread_select;
 112 extern mi_cmd_argv_ftype mi_cmd_trace_define_variable;
 113 extern mi_cmd_argv_ftype mi_cmd_trace_find;
 114 extern mi_cmd_argv_ftype mi_cmd_trace_frame_collected;
 115 extern mi_cmd_argv_ftype mi_cmd_trace_list_variables;
 116 extern mi_cmd_argv_ftype mi_cmd_trace_save;
 117 extern mi_cmd_argv_ftype mi_cmd_trace_start;
 118 extern mi_cmd_argv_ftype mi_cmd_trace_status;
 119 extern mi_cmd_argv_ftype mi_cmd_trace_stop;
 120 extern mi_cmd_argv_ftype mi_cmd_var_assign;
 121 extern mi_cmd_argv_ftype mi_cmd_var_create;
 122 extern mi_cmd_argv_ftype mi_cmd_var_delete;
 123 extern mi_cmd_argv_ftype mi_cmd_var_evaluate_expression;
 124 extern mi_cmd_argv_ftype mi_cmd_var_info_expression;
 125 extern mi_cmd_argv_ftype mi_cmd_var_info_path_expression;
 126 extern mi_cmd_argv_ftype mi_cmd_var_info_num_children;
 127 extern mi_cmd_argv_ftype mi_cmd_var_info_type;
 128 extern mi_cmd_argv_ftype mi_cmd_var_list_children;
 129 extern mi_cmd_argv_ftype mi_cmd_var_set_format;
 130 extern mi_cmd_argv_ftype mi_cmd_var_set_frozen;
 131 extern mi_cmd_argv_ftype mi_cmd_var_set_visualizer;
 132 extern mi_cmd_argv_ftype mi_cmd_var_show_attributes;
 133 extern mi_cmd_argv_ftype mi_cmd_var_show_format;
 134 extern mi_cmd_argv_ftype mi_cmd_var_update;
 135 extern mi_cmd_argv_ftype mi_cmd_enable_pretty_printing;
 136 extern mi_cmd_argv_ftype mi_cmd_enable_frame_filters;
 137 extern mi_cmd_argv_ftype mi_cmd_var_set_update_range;
 138 extern mi_cmd_argv_ftype mi_cmd_complete;
 139
 140 /* Description of a single command.  */
 141
 142 struct mi_cli
 143 {
 144   /* Corresponding CLI command.  If ARGS_P is non-zero, the MI
 145      command's argument list is appended to the CLI command.  */
 146   const char *cmd;
 147   int args_p;
 148 };
 149
 150 struct mi_cmd
 151 {
 152   /* Official name of the command.  */
 153   const char *name;
 154   /* The corresponding CLI command that can be used to implement this
 155      MI command (if cli.lhs is non NULL).  */
 156   struct mi_cli cli;
 157   /* If non-null, the function implementing the MI command.  */
 158   mi_cmd_argv_ftype *argv_func;
 159   /* If non-null, the pointer to a field in
 160      'struct mi_suppress_notification', which will be set to true by MI
 161      command processor (mi-main.c:mi_cmd_execute) when this command is
 162      being executed.  It will be set back to false when command has been
 163      executed.  */
 164   int *suppress_notification;
 165 };
 166
 167 /* Lookup a command in the MI command table, returns nullptr if COMMAND is
 168    not found.  */
 169
 170 extern struct mi_cmd *mi_cmd_lookup (const char *command);
 171
 172 /* Debug flag */
 173 extern int mi_debug_p;
 174
 175 extern void mi_execute_command (const char *cmd, int from_tty);
 176
 177 #endif /* MI_MI_CMDS_H */