xref: /netbsd-src/external/gpl3/gdb.old/dist/gdb/event-top.h (revision 8b657b0747480f8989760d71343d6dd33f8d4cf9)
1 /* Definitions used by event-top.c, for GDB, the GNU debugger.
2 
3    Copyright (C) 1999-2023 Free Software Foundation, Inc.
4 
5    Written by Elena Zannoni <ezannoni@cygnus.com> of Cygnus Solutions.
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 EVENT_TOP_H
23 #define EVENT_TOP_H
24 
25 #include <signal.h>
26 
27 struct cmd_list_element;
28 
29 /* Exported functions from event-top.c.
30    FIXME: these should really go into top.h.  */
31 
32 extern void display_gdb_prompt (const char *new_prompt);
33 extern void gdb_setup_readline (int);
34 extern void gdb_disable_readline (void);
35 extern void gdb_init_signals (void);
36 extern void change_line_handler (int);
37 
38 extern void command_line_handler (gdb::unique_xmalloc_ptr<char> &&rl);
39 extern void command_handler (const char *command);
40 
41 #ifdef SIGTSTP
42 extern void handle_sigtstp (int sig);
43 #endif
44 
45 extern void handle_sigint (int sig);
46 extern void handle_sigterm (int sig);
47 extern void async_request_quit (void *arg);
48 extern void async_disable_stdin (void);
49 extern void async_enable_stdin (void);
50 
51 /* Exported variables from event-top.c.
52    FIXME: these should really go into top.h.  */
53 
54 extern bool set_editing_cmd_var;
55 extern bool exec_done_display_p;
56 extern struct prompts the_prompts;
57 extern void (*after_char_processing_hook) (void);
58 extern int call_stdin_event_handler_again_p;
59 extern void gdb_readline_no_editing_callback (void *client_data);
60 
61 /* Wrappers for rl_callback_handler_remove and
62    rl_callback_handler_install that keep track of whether the callback
63    handler is installed in readline.  Do not call the readline
64    versions directly.  */
65 extern void gdb_rl_callback_handler_remove (void);
66 extern void gdb_rl_callback_handler_install (const char *prompt);
67 
68 /* Reinstall the readline callback handler (with no prompt), if not
69    currently installed.  */
70 extern void gdb_rl_callback_handler_reinstall (void);
71 
72 /* Called by readline after a complete line has been gathered from the
73    user, but before the line is dispatched to back to GDB.  This function
74    is a wrapper around readline's builtin rl_deprep_terminal function, and
75    handles the case where readline received EOF.  */
76 extern void gdb_rl_deprep_term_function (void);
77 
78 typedef void (*segv_handler_t) (int);
79 
80 /* On construction, replaces the current thread's SIGSEGV handler with
81    the provided one.  On destruction, restores the handler to the
82    original one.  */
83 class scoped_segv_handler_restore
84 {
85  public:
86   scoped_segv_handler_restore (segv_handler_t new_handler);
87   ~scoped_segv_handler_restore ();
88 
89  private:
90   segv_handler_t m_old_handler;
91 };
92 
93 #endif
94