xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/cli/cli-interp.h (revision 2718af68c3efc72c9769069b5c7f9ed36f6b9def)
1 /* CLI Definitions for GDB, the GNU debugger.
2 
3    Copyright (C) 2016-2019 Free Software Foundation, Inc.
4 
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 3 of the License, or
8    (at your option) any later version.
9 
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14 
15    You should have received a copy of the GNU General Public License
16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
17 
18 #ifndef CLI_CLI_INTERP_H
19 #define CLI_CLI_INTERP_H
20 
21 #include "interps.h"
22 
23 /* A console-like interpreter.  Implements functionality common to the
24    CLI and the TUI.  */
25 class cli_interp_base : public interp
26 {
27 public:
28   explicit cli_interp_base (const char *name);
29   virtual ~cli_interp_base () = 0;
30 
31   void set_logging (ui_file_up logfile, bool logging_redirect) override;
32   void pre_command_loop () override;
33   bool supports_command_editing () override;
34 };
35 
36 /* Make the output ui_file to use when logging is enabled.
37    CURR_OUTPUT is the stream where output is currently being sent to
38    (e.g., gdb_stdout for the CLI, raw output stream for the MI).
39    LOGFILE is the log file already opened by the caller.
40    LOGGING_REDIRECT is the value of the "set logging redirect"
41    setting.  If true, the resulting output is the logfile.  If false,
42    the output stream is a tee, with the log file as one of the
43    outputs.  Ownership of LOGFILE is transferred to the returned
44    output file, which is an owning pointer.  */
45 extern ui_file *make_logging_output (ui_file *curr_output,
46 				     ui_file_up logfile,
47 				     bool logging_redirect);
48 
49 /* The CLI interpreter's set_logging_proc method.  Exported so other
50    interpreters can reuse it.  */
51 extern void cli_set_logging (struct interp *interp,
52 			     ui_file_up logfile, bool logging_redirect);
53 
54 extern int cli_interpreter_supports_command_editing (struct interp *interp);
55 
56 extern void cli_interpreter_pre_command_loop (struct interp *self);
57 
58 /* Returns true if the current stop should be printed to
59    CONSOLE_INTERP.  */
60 extern int should_print_stop_to_console (struct interp *interp,
61 					 struct thread_info *tp);
62 
63 #endif /* CLI_CLI_INTERP_H */
64