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 extern int interp_quiet_p (struct interp *interp);
  43
  44 typedef void *(interp_init_ftype) (struct interp *self, int top_level);
  45 typedef int (interp_resume_ftype) (void *data);
  46 typedef int (interp_suspend_ftype) (void *data);
  47 typedef struct gdb_exception (interp_exec_ftype) (void *data,
  48                                                   const char *command);
  49 typedef void (interp_pre_command_loop_ftype) (struct interp *self);
  50 typedef struct ui_out *(interp_ui_out_ftype) (struct interp *self);
  51
  52 typedef void (interp_set_logging_ftype) (struct interp *self,
  53                                          ui_file_up logfile,
  54                                          bool logging_redirect);
  55
  56 typedef int (interp_supports_command_editing_ftype) (struct interp *self);
  57
  58 struct interp_procs
  59 {
  60   interp_init_ftype *init_proc;
  61   interp_resume_ftype *resume_proc;
  62   interp_suspend_ftype *suspend_proc;
  63   interp_exec_ftype *exec_proc;
  64
  65   /* Returns the ui_out currently used to collect results for this
  66      interpreter.  It can be a formatter for stdout, as is the case
  67      for the console & mi outputs, or it might be a result
  68      formatter.  */
  69   interp_ui_out_ftype *ui_out_proc;
  70
  71   /* Provides a hook for interpreters to do any additional
  72      setup/cleanup that they might need when logging is enabled or
  73      disabled.  */
  74   interp_set_logging_ftype *set_logging_proc;
  75
  76   /* Called before starting an event loop, to give the interpreter a
  77      chance to e.g., print a prompt.  */
  78   interp_pre_command_loop_ftype *pre_command_loop_proc;
  79
  80   /* Returns true if this interpreter supports using the readline
  81      library; false if it uses GDB's own simplified readline
  82      emulation.  */
  83   interp_supports_command_editing_ftype *supports_command_editing_proc;
  84 };
  85
  86 extern struct interp *interp_new (const char *name,
  87                                   const struct interp_procs *procs,
  88                                   void *data);
  89 extern void interp_add (struct ui *ui, struct interp *interp);
  90 extern int interp_set (struct interp *interp, int top_level);
  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 void *interp_data (struct interp *interp);
 105 extern const char *interp_name (struct interp *interp);
 106 extern struct interp *interp_set_temp (const char *name);
 107
 108 extern int current_interp_named_p (const char *name);
 109
 110 /* Call this function to give the current interpreter an opportunity
 111    to do any special handling of streams when logging is enabled or
 112    disabled.  LOGFILE is the stream for the log file when logging is
 113    starting and is NULL when logging is ending.  LOGGING_REDIRECT is
 114    the value of the "set logging redirect" setting.  If true, the
 115    interpreter should configure the output streams to send output only
 116    to the logfile.  If false, the interpreter should configure the
 117    output streams to send output to both the current output stream
 118    (i.e., the terminal) and the log file.  */
 119 extern void current_interp_set_logging (ui_file_up logfile,
 120                                         bool logging_redirect);
 121
 122 /* Returns opaque data associated with the top-level interpreter.  */
 123 extern void *top_level_interpreter_data (void);
 124 extern struct interp *top_level_interpreter (void);
 125
 126 /* Return the current UI's current interpreter.  */
 127 extern struct interp *current_interpreter (void);
 128
 129 extern struct interp *command_interp (void);
 130
 131 extern void clear_interpreter_hooks (void);
 132
 133 /* Returns true if INTERP supports using the readline library; false
 134    if it uses GDB's own simplified form of readline.  */
 135 extern int interp_supports_command_editing (struct interp *interp);
 136
 137 /* Called before starting an event loop, to give the interpreter a
 138    chance to e.g., print a prompt.  */
 139 extern void interp_pre_command_loop (struct interp *interp);
 140
 141 /* List the possible interpreters which could complete the given
 142    text.  */
 143 extern VEC (char_ptr) *interpreter_completer (struct cmd_list_element *ignore,
 144                                               const char *text,
 145                                               const char *word);
 146
 147 /* well-known interpreters */
 148 #define INTERP_CONSOLE          "console"
 149 #define INTERP_MI1             "mi1"
 150 #define INTERP_MI2             "mi2"
 151 #define INTERP_MI3             "mi3"
 152 #define INTERP_MI               "mi"
 153 #define INTERP_TUI              "tui"
 154 #define INTERP_INSIGHT          "insight"
 155
 156 #endif