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