gdb/mi/mi-cmds.h

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