gdb/interps.h

   1 /* Manages interpreters for GDB, the GNU debugger.
   2
   3    Copyright (C) 2000-2017 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 int interp_resume (struct interp *interp);
  39 extern int interp_suspend (struct interp *interp);
  40 extern struct gdb_exception interp_exec (struct interp *interp,
  41                                          const char *command);
  42
  43 class interp
  44 {
  45 public:
  46   explicit interp (const char *name);
  47   virtual ~interp () = 0;
  48
  49   virtual void init (bool top_level)
  50   {}
  51
  52   virtual void resume () = 0;
  53   virtual void suspend () = 0;
  54
  55   virtual gdb_exception exec (const char *command) = 0;
  56
  57   /* Returns the ui_out currently used to collect results for this
  58      interpreter.  It can be a formatter for stdout, as is the case
  59      for the console & mi outputs, or it might be a result
  60      formatter.  */
  61   virtual ui_out *interp_ui_out () = 0;
  62
  63   /* Provides a hook for interpreters to do any additional
  64      setup/cleanup that they might need when logging is enabled or
  65      disabled.  */
  66   virtual void set_logging (ui_file_up logfile, bool logging_redirect) = 0;
  67
  68   /* Called before starting an event loop, to give the interpreter a
  69      chance to e.g., print a prompt.  */
  70   virtual void pre_command_loop ()
  71   {}
  72
  73   /* Returns true if this interpreter supports using the readline
  74      library; false if it uses GDB's own simplified readline
  75      emulation.  */
  76   virtual bool supports_command_editing ()
  77   { return false; }
  78
  79   /* This is the name in "-i=" and "set interpreter".  */
  80   const char *name;
  81
  82   /* Interpreters are stored in a linked list, this is the next
  83      one...  */
  84   struct interp *next;
  85
  86   /* Has the init method been run?  */
  87   bool inited;
  88 };
  89
  90 extern void interp_add (struct ui *ui, struct interp *interp);
  91
  92 /* Look up the interpreter for NAME, creating one if none exists yet.
  93    If NAME is not a interpreter type previously registered with
  94    interp_factory_register, return NULL; otherwise return a pointer to
  95    the interpreter.  */
  96 extern struct interp *interp_lookup (struct ui *ui, const char *name);
  97
  98 /* Set the current UI's top level interpreter to the interpreter named
  99    NAME.  Throws an error if NAME is not a known interpreter or the
 100    interpreter fails to initialize.  */
 101 extern void set_top_level_interpreter (const char *name);
 102
 103 extern struct ui_out *interp_ui_out (struct interp *interp);
 104 extern const char *interp_name (struct interp *interp);
 105 extern struct interp *interp_set_temp (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 (interp_name (m_interp));
 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.  */
 144 extern void current_interp_set_logging (ui_file_up logfile,
 145                                         bool logging_redirect);
 146
 147 /* Returns the top-level interpreter.  */
 148 extern struct interp *top_level_interpreter (void);
 149
 150 /* Return the current UI's current interpreter.  */
 151 extern struct interp *current_interpreter (void);
 152
 153 extern struct interp *command_interp (void);
 154
 155 extern void clear_interpreter_hooks (void);
 156
 157 /* Returns true if INTERP supports using the readline library; false
 158    if it uses GDB's own simplified form of readline.  */
 159 extern int interp_supports_command_editing (struct interp *interp);
 160
 161 /* Called before starting an event loop, to give the interpreter a
 162    chance to e.g., print a prompt.  */
 163 extern void interp_pre_command_loop (struct interp *interp);
 164
 165 /* List the possible interpreters which could complete the given
 166    text.  */
 167 extern void interpreter_completer (struct cmd_list_element *ignore,
 168                                    completion_tracker &tracker,
 169                                    const char *text,
 170                                    const char *word);
 171
 172 /* well-known interpreters */
 173 #define INTERP_CONSOLE          "console"
 174 #define INTERP_MI1             "mi1"
 175 #define INTERP_MI2             "mi2"
 176 #define INTERP_MI3             "mi3"
 177 #define INTERP_MI               "mi"
 178 #define INTERP_TUI              "tui"
 179 #define INTERP_INSIGHT          "insight"
 180
 181 #endif