gdb/interps.h

   1 /* Manages interpreters for GDB, the GNU debugger.
   2
   3    Copyright (C) 2000-2018 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
  29 typedef struct interp *(*interp_factory_func) (const char *name);
  30
  31 /* Each interpreter kind (CLI, MI, etc.) registers itself with a call
  32    to this function, passing along its name, and a pointer to a
  33    function that creates a new instance of an interpreter with that
  34    name.  */
  35 extern void interp_factory_register (const char *name,
  36                                      interp_factory_func func);
  37
  38 extern struct gdb_exception interp_exec (struct interp *interp,
  39                                          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 gdb_exception 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) = 0;
  65
  66   /* Called before starting an event loop, to give the interpreter a
  67      chance to e.g., print a prompt.  */
  68   virtual void pre_command_loop ()
  69   {}
  70
  71   /* Returns true if this interpreter supports using the readline
  72      library; false if it uses GDB's own simplified readline
  73      emulation.  */
  74   virtual bool supports_command_editing ()
  75   { return false; }
  76
  77   /* This is the name in "-i=" and "set interpreter".  */
  78   const char *name;
  79
  80   /* Interpreters are stored in a linked list, this is the next
  81      one...  */
  82   struct interp *next;
  83
  84   /* Has the init method been run?  */
  85   bool inited;
  86 };
  87
  88 extern void interp_add (struct ui *ui, struct interp *interp);
  89
  90 /* Look up the interpreter for NAME, creating one if none exists yet.
  91    If NAME is not a interpreter type previously registered with
  92    interp_factory_register, return NULL; otherwise return a pointer to
  93    the interpreter.  */
  94 extern struct interp *interp_lookup (struct ui *ui, const char *name);
  95
  96 /* Set the current UI's top level interpreter to the interpreter named
  97    NAME.  Throws an error if NAME is not a known interpreter or the
  98    interpreter fails to initialize.  */
  99 extern void set_top_level_interpreter (const char *name);
 100
 101 extern const char *interp_name (struct interp *interp);
 102
 103 /* Temporarily set the current interpreter, and reset it on
 104    destruction.  */
 105 class scoped_restore_interp
 106 {
 107 public:
 108
 109   scoped_restore_interp (const char *name)
 110     : m_interp (set_interp (name))
 111   {
 112   }
 113
 114   ~scoped_restore_interp ()
 115   {
 116     set_interp (interp_name (m_interp));
 117   }
 118
 119   scoped_restore_interp (const scoped_restore_interp &) = delete;
 120   scoped_restore_interp &operator= (const scoped_restore_interp &) = delete;
 121
 122 private:
 123
 124   struct interp *set_interp (const char *name);
 125
 126   struct interp *m_interp;
 127 };
 128
 129 extern int current_interp_named_p (const char *name);
 130
 131 /* Call this function to give the current interpreter an opportunity
 132    to do any special handling of streams when logging is enabled or
 133    disabled.  LOGFILE is the stream for the log file when logging is
 134    starting and is NULL when logging is ending.  LOGGING_REDIRECT is
 135    the value of the "set logging redirect" setting.  If true, the
 136    interpreter should configure the output streams to send output only
 137    to the logfile.  If false, the interpreter should configure the
 138    output streams to send output to both the current output stream
 139    (i.e., the terminal) and the log file.  */
 140 extern void current_interp_set_logging (ui_file_up logfile,
 141                                         bool logging_redirect);
 142
 143 /* Returns the top-level interpreter.  */
 144 extern struct interp *top_level_interpreter (void);
 145
 146 /* Return the current UI's current interpreter.  */
 147 extern struct interp *current_interpreter (void);
 148
 149 extern struct interp *command_interp (void);
 150
 151 extern void clear_interpreter_hooks (void);
 152
 153 /* Returns true if INTERP supports using the readline library; false
 154    if it uses GDB's own simplified form of readline.  */
 155 extern int interp_supports_command_editing (struct interp *interp);
 156
 157 /* Called before starting an event loop, to give the interpreter a
 158    chance to e.g., print a prompt.  */
 159 extern void interp_pre_command_loop (struct interp *interp);
 160
 161 /* List the possible interpreters which could complete the given
 162    text.  */
 163 extern void interpreter_completer (struct cmd_list_element *ignore,
 164                                    completion_tracker &tracker,
 165                                    const char *text,
 166                                    const char *word);
 167
 168 /* well-known interpreters */
 169 #define INTERP_CONSOLE          "console"
 170 #define INTERP_MI1             "mi1"
 171 #define INTERP_MI2             "mi2"
 172 #define INTERP_MI3             "mi3"
 173 #define INTERP_MI               "mi"
 174 #define INTERP_TUI              "tui"
 175 #define INTERP_INSIGHT          "insight"
 176
 177 #endif