gdb/mi/mi-common.h

   1 /* Interface for common GDB/MI data
   2    Copyright (C) 2005-2022 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef MI_MI_COMMON_H
  20 #define MI_MI_COMMON_H
  21
  22 #include "interps.h"
  23
  24 struct mi_console_file;
  25
  26 /* Represents the reason why GDB is sending an asynchronous command to
  27    the front end.  NOTE: When modifing this, don't forget to update
  28    gdb.texinfo!  */
  29 enum async_reply_reason
  30 {
  31   EXEC_ASYNC_BREAKPOINT_HIT = 0,
  32   EXEC_ASYNC_WATCHPOINT_TRIGGER,
  33   EXEC_ASYNC_READ_WATCHPOINT_TRIGGER,
  34   EXEC_ASYNC_ACCESS_WATCHPOINT_TRIGGER,
  35   EXEC_ASYNC_FUNCTION_FINISHED,
  36   EXEC_ASYNC_LOCATION_REACHED,
  37   EXEC_ASYNC_WATCHPOINT_SCOPE,
  38   EXEC_ASYNC_END_STEPPING_RANGE,
  39   EXEC_ASYNC_EXITED_SIGNALLED,
  40   EXEC_ASYNC_EXITED,
  41   EXEC_ASYNC_EXITED_NORMALLY,
  42   EXEC_ASYNC_SIGNAL_RECEIVED,
  43   EXEC_ASYNC_SOLIB_EVENT,
  44   EXEC_ASYNC_FORK,
  45   EXEC_ASYNC_VFORK,
  46   EXEC_ASYNC_SYSCALL_ENTRY,
  47   EXEC_ASYNC_SYSCALL_RETURN,
  48   EXEC_ASYNC_EXEC,
  49   /* This is here only to represent the number of enums.  */
  50   EXEC_ASYNC_LAST
  51 };
  52
  53 const char *async_reason_lookup (enum async_reply_reason reason);
  54
  55 /* An MI interpreter.  */
  56
  57 class mi_interp final : public interp
  58 {
  59 public:
  60   mi_interp (const char *name)
  61     : interp (name)
  62   {}
  63
  64   void init (bool top_level) override;
  65   void resume () override;
  66   void suspend () override;
  67   gdb_exception exec (const char *command_str) override;
  68   ui_out *interp_ui_out () override;
  69   void set_logging (ui_file_up logfile, bool logging_redirect,
  70                     bool debug_redirect) override;
  71   void pre_command_loop () override;
  72
  73   /* MI's output channels */
  74   mi_console_file *out;
  75   mi_console_file *err;
  76   mi_console_file *log;
  77   mi_console_file *targ;
  78   mi_console_file *event_channel;
  79
  80   /* Raw console output.  */
  81   struct ui_file *raw_stdout;
  82
  83   /* Raw logfile output.  */
  84   struct ui_file *raw_stdlog;
  85
  86   /* Save the original value of raw_stdout and raw_stdlog here when logging, and
  87      the file which we need to delete, so we can restore correctly when
  88      done.  */
  89   struct ui_file *saved_raw_stdout;
  90   struct ui_file *saved_raw_stdlog;
  91   struct ui_file *saved_raw_file_to_delete;
  92
  93
  94   /* MI's builder.  */
  95   struct ui_out *mi_uiout;
  96
  97   /* MI's CLI builder (wraps OUT).  */
  98   struct ui_out *cli_uiout;
  99 };
 100
 101 #endif /* MI_MI_COMMON_H */