gdb/interps.h

   1 /* Manages interpreters for GDB, the GNU debugger.
   2
   3    Copyright (C) 2000-2023 Free Software Foundation, Inc.
   4
   5    Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
   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 INTERPS_H
  23 #define INTERPS_H
  24
  25 struct ui_out;
  26 struct interp;
  27 struct ui;
  28 class completion_tracker;
  29
  30 typedef struct interp *(*interp_factory_func) (const char *name);
  31
  32 /* Each interpreter kind (CLI, MI, etc.) registers itself with a call
  33    to this function, passing along its name, and a pointer to a
  34    function that creates a new instance of an interpreter with that
  35    name.  */
  36 extern void interp_factory_register (const char *name,
  37                                      interp_factory_func func);
  38
  39 extern void interp_exec (struct interp *interp, const char *command);
  40
  41 class interp
  42 {
  43 public:
  44   explicit interp (const char *name);
  45   virtual ~interp () = 0;
  46
  47   virtual void init (bool top_level)
  48   {}
  49
  50   virtual void resume () = 0;
  51   virtual void suspend () = 0;
  52
  53   virtual void exec (const char *command) = 0;
  54
  55   /* Returns the ui_out currently used to collect results for this
  56      interpreter.  It can be a formatter for stdout, as is the case
  57      for the console & mi outputs, or it might be a result
  58      formatter.  */
  59   virtual ui_out *interp_ui_out () = 0;
  60
  61   /* Provides a hook for interpreters to do any additional
  62      setup/cleanup that they might need when logging is enabled or
  63      disabled.  */
  64   virtual void set_logging (ui_file_up logfile, bool logging_redirect,
  65                             bool debug_redirect) = 0;
  66
  67   /* Called before starting an event loop, to give the interpreter a
  68      chance to e.g., print a prompt.  */
  69   virtual void pre_command_loop ()
  70   {}
  71
  72   /* Returns true if this interpreter supports using the readline
  73      library; false if it uses GDB's own simplified readline
  74      emulation.  */
  75   virtual bool supports_command_editing ()
  76   { return false; }
  77
  78   const char *name () const
  79   {
  80     return m_name.get ();
  81   }
  82
  83 private:
  84   /* This is the name in "-i=" and "set interpreter".  */
  85   gdb::unique_xmalloc_ptr<char> m_name;
  86
  87 public:
  88   /* Interpreters are stored in a linked list, this is the next
  89      one...  */
  90   struct interp *next;
  91
  92   /* Has the init method been run?  */
  93   bool inited = false;
  94 };
  95
  96 /* Look up the interpreter for NAME, creating one if none exists yet.
  97    If NAME is not a interpreter type previously registered with
  98    interp_factory_register, return NULL; otherwise return a pointer to
  99    the interpreter.  */
 100 extern struct interp *interp_lookup (struct ui *ui, const char *name);
 101
 102 /* Set the current UI's top level interpreter to the interpreter named
 103    NAME.  Throws an error if NAME is not a known interpreter or the
 104    interpreter fails to initialize.  */
 105 extern void set_top_level_interpreter (const char *name);
 106
 107 /* Temporarily set the current interpreter, and reset it on
 108    destruction.  */
 109 class scoped_restore_interp
 110 {
 111 public:
 112
 113   scoped_restore_interp (const char *name)
 114     : m_interp (set_interp (name))
 115   {
 116   }
 117
 118   ~scoped_restore_interp ()
 119   {
 120     set_interp (m_interp->name ());
 121   }
 122
 123   scoped_restore_interp (const scoped_restore_interp &) = delete;
 124   scoped_restore_interp &operator= (const scoped_restore_interp &) = delete;
 125
 126 private:
 127
 128   struct interp *set_interp (const char *name);
 129
 130   struct interp *m_interp;
 131 };
 132
 133 extern int current_interp_named_p (const char *name);
 134
 135 /* Call this function to give the current interpreter an opportunity
 136    to do any special handling of streams when logging is enabled or
 137    disabled.  LOGFILE is the stream for the log file when logging is
 138    starting and is NULL when logging is ending.  LOGGING_REDIRECT is
 139    the value of the "set logging redirect" setting.  If true, the
 140    interpreter should configure the output streams to send output only
 141    to the logfile.  If false, the interpreter should configure the
 142    output streams to send output to both the current output stream
 143    (i.e., the terminal) and the log file.  DEBUG_REDIRECT is same as
 144    LOGGING_REDIRECT, but for the value of "set logging debugredirect"
 145    instead.  */
 146 extern void current_interp_set_logging (ui_file_up logfile,
 147                                         bool logging_redirect,
 148                                         bool debug_redirect);
 149
 150 /* Returns the top-level interpreter.  */
 151 extern struct interp *top_level_interpreter (void);
 152
 153 /* Return the current UI's current interpreter.  */
 154 extern struct interp *current_interpreter (void);
 155
 156 extern struct interp *command_interp (void);
 157
 158 extern void clear_interpreter_hooks (void);
 159
 160 /* Returns true if INTERP supports using the readline library; false
 161    if it uses GDB's own simplified form of readline.  */
 162 extern int interp_supports_command_editing (struct interp *interp);
 163
 164 /* Called before starting an event loop, to give the interpreter a
 165    chance to e.g., print a prompt.  */
 166 extern void interp_pre_command_loop (struct interp *interp);
 167
 168 /* List the possible interpreters which could complete the given
 169    text.  */
 170 extern void interpreter_completer (struct cmd_list_element *ignore,
 171                                    completion_tracker &tracker,
 172                                    const char *text,
 173                                    const char *word);
 174
 175 /* well-known interpreters */
 176 #define INTERP_CONSOLE          "console"
 177 #define INTERP_MI2             "mi2"
 178 #define INTERP_MI3             "mi3"
 179 #define INTERP_MI4             "mi4"
 180 #define INTERP_MI               "mi"
 181 #define INTERP_TUI              "tui"
 182 #define INTERP_INSIGHT          "insight"
 183
 184 #endif