1 /* Manages interpreters for GDB, the GNU debugger. 2 3 Copyright (C) 2000-2013 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 #include "exceptions.h" 26 27 struct ui_out; 28 struct interp; 29 30 extern int interp_resume (struct interp *interp); 31 extern int interp_suspend (struct interp *interp); 32 extern int interp_prompt_p (struct interp *interp); 33 extern int interp_exec_p (struct interp *interp); 34 extern struct gdb_exception interp_exec (struct interp *interp, 35 const char *command); 36 extern int interp_quiet_p (struct interp *interp); 37 38 typedef void *(interp_init_ftype) (struct interp *self, int top_level); 39 typedef int (interp_resume_ftype) (void *data); 40 typedef int (interp_suspend_ftype) (void *data); 41 typedef int (interp_prompt_p_ftype) (void *data); 42 typedef struct gdb_exception (interp_exec_ftype) (void *data, 43 const char *command); 44 typedef void (interp_command_loop_ftype) (void *data); 45 typedef struct ui_out *(interp_ui_out_ftype) (struct interp *self); 46 47 typedef int (interp_set_logging_ftype) (struct interp *self, int start_log, 48 struct ui_file *out, 49 struct ui_file *logfile); 50 51 struct interp_procs 52 { 53 interp_init_ftype *init_proc; 54 interp_resume_ftype *resume_proc; 55 interp_suspend_ftype *suspend_proc; 56 interp_exec_ftype *exec_proc; 57 interp_prompt_p_ftype *prompt_proc_p; 58 59 /* Returns the ui_out currently used to collect results for this 60 interpreter. It can be a formatter for stdout, as is the case 61 for the console & mi outputs, or it might be a result 62 formatter. */ 63 interp_ui_out_ftype *ui_out_proc; 64 65 /* Provides a hook for interpreters to do any additional 66 setup/cleanup that they might need when logging is enabled or 67 disabled. */ 68 interp_set_logging_ftype *set_logging_proc; 69 70 interp_command_loop_ftype *command_loop_proc; 71 }; 72 73 extern struct interp *interp_new (const char *name, const struct interp_procs *procs); 74 extern void interp_add (struct interp *interp); 75 extern int interp_set (struct interp *interp, int top_level); 76 extern struct interp *interp_lookup (const char *name); 77 extern struct ui_out *interp_ui_out (struct interp *interp); 78 extern void *interp_data (struct interp *interp); 79 extern const char *interp_name (struct interp *interp); 80 extern struct interp *interp_set_temp (const char *name); 81 82 extern int current_interp_named_p (const char *name); 83 extern int current_interp_display_prompt_p (void); 84 extern void current_interp_command_loop (void); 85 86 /* Call this function to give the current interpreter an opportunity 87 to do any special handling of streams when logging is enabled or 88 disabled. START_LOG is 1 when logging is starting, 0 when it ends, 89 and OUT is the stream for the log file; it will be NULL when 90 logging is ending. LOGFILE is non-NULL if the output streams 91 are to be tees, with the log file as one of the outputs. */ 92 93 extern int current_interp_set_logging (int start_log, struct ui_file *out, 94 struct ui_file *logfile); 95 96 /* Returns opaque data associated with the top-level interpreter. */ 97 extern void *top_level_interpreter_data (void); 98 extern struct interp *top_level_interpreter (void); 99 100 /* True if the current interpreter is in async mode, false if in sync 101 mode. If in sync mode, running a synchronous execution command 102 (with execute_command, e.g, "next") will not return until the 103 command is finished. If in async mode, then running a synchronous 104 command returns right after resuming the target. Waiting for the 105 command's completion is later done on the top event loop (using 106 continuations). */ 107 extern int interpreter_async; 108 109 extern void clear_interpreter_hooks (void); 110 111 /* well-known interpreters */ 112 #define INTERP_CONSOLE "console" 113 #define INTERP_MI1 "mi1" 114 #define INTERP_MI2 "mi2" 115 #define INTERP_MI3 "mi3" 116 #define INTERP_MI "mi" 117 #define INTERP_TUI "tui" 118 #define INTERP_INSIGHT "insight" 119 120 #endif 121