gdb/mi/mi-cmds.h

   1 /* MI Command Set for GDB, the GNU debugger.
   2
   3    Copyright (C) 2000-2022 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 #include "gdbsupport/function-view.h"
  26 #include "gdbsupport/gdb_optional.h"
  27 #include "mi/mi-main.h"
  28
  29 enum print_values {
  30    PRINT_NO_VALUES,
  31    PRINT_ALL_VALUES,
  32    PRINT_SIMPLE_VALUES
  33 };
  34
  35 typedef void (mi_cmd_argv_ftype) (const char *command, char **argv, int argc);
  36
  37 /* Declarations of the functions implementing each command.  */
  38
  39 extern mi_cmd_argv_ftype mi_cmd_ada_task_info;
  40 extern mi_cmd_argv_ftype mi_cmd_add_inferior;
  41 extern mi_cmd_argv_ftype mi_cmd_break_insert;
  42 extern mi_cmd_argv_ftype mi_cmd_dprintf_insert;
  43 extern mi_cmd_argv_ftype mi_cmd_break_condition;
  44 extern mi_cmd_argv_ftype mi_cmd_break_commands;
  45 extern mi_cmd_argv_ftype mi_cmd_break_passcount;
  46 extern mi_cmd_argv_ftype mi_cmd_break_watch;
  47 extern mi_cmd_argv_ftype mi_cmd_catch_assert;
  48 extern mi_cmd_argv_ftype mi_cmd_catch_exception;
  49 extern mi_cmd_argv_ftype mi_cmd_catch_handlers;
  50 extern mi_cmd_argv_ftype mi_cmd_catch_load;
  51 extern mi_cmd_argv_ftype mi_cmd_catch_unload;
  52 extern mi_cmd_argv_ftype mi_cmd_catch_throw;
  53 extern mi_cmd_argv_ftype mi_cmd_catch_rethrow;
  54 extern mi_cmd_argv_ftype mi_cmd_catch_catch;
  55 extern mi_cmd_argv_ftype mi_cmd_disassemble;
  56 extern mi_cmd_argv_ftype mi_cmd_data_evaluate_expression;
  57 extern mi_cmd_argv_ftype mi_cmd_data_list_register_names;
  58 extern mi_cmd_argv_ftype mi_cmd_data_list_register_values;
  59 extern mi_cmd_argv_ftype mi_cmd_data_list_changed_registers;
  60 extern mi_cmd_argv_ftype mi_cmd_data_read_memory;
  61 extern mi_cmd_argv_ftype mi_cmd_data_read_memory_bytes;
  62 extern mi_cmd_argv_ftype mi_cmd_data_write_memory;
  63 extern mi_cmd_argv_ftype mi_cmd_data_write_memory_bytes;
  64 extern mi_cmd_argv_ftype mi_cmd_data_write_register_values;
  65 extern mi_cmd_argv_ftype mi_cmd_enable_timings;
  66 extern mi_cmd_argv_ftype mi_cmd_env_cd;
  67 extern mi_cmd_argv_ftype mi_cmd_env_dir;
  68 extern mi_cmd_argv_ftype mi_cmd_env_path;
  69 extern mi_cmd_argv_ftype mi_cmd_env_pwd;
  70 extern mi_cmd_argv_ftype mi_cmd_exec_continue;
  71 extern mi_cmd_argv_ftype mi_cmd_exec_finish;
  72 extern mi_cmd_argv_ftype mi_cmd_exec_interrupt;
  73 extern mi_cmd_argv_ftype mi_cmd_exec_jump;
  74 extern mi_cmd_argv_ftype mi_cmd_exec_next;
  75 extern mi_cmd_argv_ftype mi_cmd_exec_next_instruction;
  76 extern mi_cmd_argv_ftype mi_cmd_exec_return;
  77 extern mi_cmd_argv_ftype mi_cmd_exec_run;
  78 extern mi_cmd_argv_ftype mi_cmd_exec_step;
  79 extern mi_cmd_argv_ftype mi_cmd_exec_step_instruction;
  80 extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_file;
  81 extern mi_cmd_argv_ftype mi_cmd_file_list_exec_source_files;
  82 extern mi_cmd_argv_ftype mi_cmd_file_list_shared_libraries;
  83 extern mi_cmd_argv_ftype mi_cmd_gdb_exit;
  84 extern mi_cmd_argv_ftype mi_cmd_inferior_tty_set;
  85 extern mi_cmd_argv_ftype mi_cmd_inferior_tty_show;
  86 extern mi_cmd_argv_ftype mi_cmd_info_ada_exceptions;
  87 extern mi_cmd_argv_ftype mi_cmd_info_gdb_mi_command;
  88 extern mi_cmd_argv_ftype mi_cmd_info_os;
  89 extern mi_cmd_argv_ftype mi_cmd_interpreter_exec;
  90 extern mi_cmd_argv_ftype mi_cmd_list_features;
  91 extern mi_cmd_argv_ftype mi_cmd_list_target_features;
  92 extern mi_cmd_argv_ftype mi_cmd_list_thread_groups;
  93 extern mi_cmd_argv_ftype mi_cmd_remove_inferior;
  94 extern mi_cmd_argv_ftype mi_cmd_stack_info_depth;
  95 extern mi_cmd_argv_ftype mi_cmd_stack_info_frame;
  96 extern mi_cmd_argv_ftype mi_cmd_stack_list_args;
  97 extern mi_cmd_argv_ftype mi_cmd_stack_list_frames;
  98 extern mi_cmd_argv_ftype mi_cmd_stack_list_locals;
  99 extern mi_cmd_argv_ftype mi_cmd_stack_list_variables;
 100 extern mi_cmd_argv_ftype mi_cmd_stack_select_frame;
 101 extern mi_cmd_argv_ftype mi_cmd_symbol_list_lines;
 102 extern mi_cmd_argv_ftype mi_cmd_symbol_info_functions;
 103 extern mi_cmd_argv_ftype mi_cmd_symbol_info_module_functions;
 104 extern mi_cmd_argv_ftype mi_cmd_symbol_info_module_variables;
 105 extern mi_cmd_argv_ftype mi_cmd_symbol_info_modules;
 106 extern mi_cmd_argv_ftype mi_cmd_symbol_info_types;
 107 extern mi_cmd_argv_ftype mi_cmd_symbol_info_variables;
 108 extern mi_cmd_argv_ftype mi_cmd_target_detach;
 109 extern mi_cmd_argv_ftype mi_cmd_target_file_get;
 110 extern mi_cmd_argv_ftype mi_cmd_target_file_put;
 111 extern mi_cmd_argv_ftype mi_cmd_target_file_delete;
 112 extern mi_cmd_argv_ftype mi_cmd_target_flash_erase;
 113 extern mi_cmd_argv_ftype mi_cmd_thread_info;
 114 extern mi_cmd_argv_ftype mi_cmd_thread_list_ids;
 115 extern mi_cmd_argv_ftype mi_cmd_thread_select;
 116 extern mi_cmd_argv_ftype mi_cmd_trace_define_variable;
 117 extern mi_cmd_argv_ftype mi_cmd_trace_find;
 118 extern mi_cmd_argv_ftype mi_cmd_trace_frame_collected;
 119 extern mi_cmd_argv_ftype mi_cmd_trace_list_variables;
 120 extern mi_cmd_argv_ftype mi_cmd_trace_save;
 121 extern mi_cmd_argv_ftype mi_cmd_trace_start;
 122 extern mi_cmd_argv_ftype mi_cmd_trace_status;
 123 extern mi_cmd_argv_ftype mi_cmd_trace_stop;
 124 extern mi_cmd_argv_ftype mi_cmd_var_assign;
 125 extern mi_cmd_argv_ftype mi_cmd_var_create;
 126 extern mi_cmd_argv_ftype mi_cmd_var_delete;
 127 extern mi_cmd_argv_ftype mi_cmd_var_evaluate_expression;
 128 extern mi_cmd_argv_ftype mi_cmd_var_info_expression;
 129 extern mi_cmd_argv_ftype mi_cmd_var_info_path_expression;
 130 extern mi_cmd_argv_ftype mi_cmd_var_info_num_children;
 131 extern mi_cmd_argv_ftype mi_cmd_var_info_type;
 132 extern mi_cmd_argv_ftype mi_cmd_var_list_children;
 133 extern mi_cmd_argv_ftype mi_cmd_var_set_format;
 134 extern mi_cmd_argv_ftype mi_cmd_var_set_frozen;
 135 extern mi_cmd_argv_ftype mi_cmd_var_set_visualizer;
 136 extern mi_cmd_argv_ftype mi_cmd_var_show_attributes;
 137 extern mi_cmd_argv_ftype mi_cmd_var_show_format;
 138 extern mi_cmd_argv_ftype mi_cmd_var_update;
 139 extern mi_cmd_argv_ftype mi_cmd_enable_pretty_printing;
 140 extern mi_cmd_argv_ftype mi_cmd_enable_frame_filters;
 141 extern mi_cmd_argv_ftype mi_cmd_var_set_update_range;
 142 extern mi_cmd_argv_ftype mi_cmd_complete;
 143
 144 /* The abstract base class for all MI command types.  */
 145
 146 struct mi_command
 147 {
 148   /* Constructor.  NAME is the name of this MI command, excluding any
 149      leading dash, that is the initial string the user will enter to run
 150      this command.  The SUPPRESS_NOTIFICATION pointer is a flag which will
 151      be set to 1 when this command is invoked, and reset to its previous
 152      value once the command invocation has completed.  */
 153   mi_command (const char *name, int *suppress_notification);
 154
 155   /* Destructor.  */
 156   virtual ~mi_command () = default;
 157
 158   /* Return the name of this command.  This is the command that the user
 159      will actually type in, without any arguments, and without the leading
 160      dash.  */
 161   const char *name () const
 162   { return m_name; }
 163
 164   /* Execute the MI command.  this needs to be overridden in each
 165      base class.  PARSE is the parsed command line from the user.
 166      Can throw an exception if something goes wrong.  */
 167   virtual void invoke (struct mi_parse *parse) const = 0;
 168
 169   /* Return whether this command preserves user selected context (thread
 170      and frame).  */
 171   bool preserve_user_selected_context () const
 172   {
 173     /* Here we exploit the fact that if MI command is supposed to change
 174        user context, then it should not emit change notifications.  Therefore if
 175        command does not suppress user context change notifications, then it should
 176        preserve the context.  */
 177     return m_suppress_notification != &mi_suppress_notification.user_selected_context;
 178   }
 179
 180   /* If this command was created with a suppress notifications pointer,
 181      then this function will set the suppress flag and return a
 182      gdb::optional with its value set to an object that will restore the
 183      previous value of the suppress notifications flag.
 184
 185      If this command was created without a suppress notifications points,
 186      then this function returns an empty gdb::optional.  */
 187   gdb::optional<scoped_restore_tmpl<int>> do_suppress_notification () const;
 188
 189 private:
 190
 191   /* The name of the command.  */
 192   const char *m_name;
 193
 194   /* Pointer to integer to set during command's invocation.  */
 195   int *m_suppress_notification;
 196 };
 197
 198 /* A command held in the global mi_cmd_table.  */
 199
 200 using mi_command_up = std::unique_ptr<struct mi_command>;
 201
 202 /* Lookup a command in the MI command table, returns nullptr if COMMAND is
 203    not found.  */
 204
 205 extern mi_command *mi_cmd_lookup (const char *command);
 206
 207 extern void mi_execute_command (const char *cmd, int from_tty);
 208
 209 /* Insert COMMAND into the global mi_cmd_table.  Return false if
 210    COMMAND->name already exists in mi_cmd_table, in which case COMMAND will
 211    not have been added to mi_cmd_table.  Otherwise, return true, and
 212    COMMAND was added to mi_cmd_table.  */
 213
 214 extern bool insert_mi_cmd_entry (mi_command_up command);
 215
 216 /* Remove the command called NAME from the global mi_cmd_table.  Return
 217    true if the removal was a success, otherwise return false, which
 218    indicates no command called NAME was found in the mi_cmd_table. */
 219
 220 extern bool remove_mi_cmd_entry (const std::string &name);
 221
 222 /* Call CALLBACK for each registered MI command.  Remove commands for which
 223    CALLBACK returns true.  */
 224
 225 using remove_mi_cmd_entries_ftype
 226   = gdb::function_view<bool (mi_command *)>;
 227 extern void remove_mi_cmd_entries (remove_mi_cmd_entries_ftype callback);
 228
 229 #endif /* MI_MI_CMDS_H */