X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Ftop.h;h=638e02cad4cf3f59435fcf64edfc13197d7712ab;hb=f3f8ece4b1c77c925d1f1566df0bf632790a4d24;hp=2de78bf43884d515b6901bcb60fc95277830bb62;hpb=4cc23edeb96576c3bea1a99c32cb9c83c471ac17;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/top.h b/gdb/top.h index 2de78bf438..638e02cad4 100644 --- a/gdb/top.h +++ b/gdb/top.h @@ -1,8 +1,6 @@ /* Top level stuff for GDB, the GNU debugger. - Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1996, - 1997, 1998, 1999, 2000, 2005, 2006, 2007, 2008, 2009, 2010 - Free Software Foundation, Inc. + Copyright (C) 1986-2020 Free Software Foundation, Inc. This file is part of GDB. @@ -22,65 +20,282 @@ #ifndef TOP_H #define TOP_H +#include "gdbsupport/buffer.h" +#include "event-loop.h" +#include "value.h" + +struct tl_interp_info; + +/* Prompt state. */ + +enum prompt_state +{ + /* The command line is blocked simulating synchronous execution. + This is used to implement the foreground execution commands + ('run', 'continue', etc.). We won't display the prompt and + accept further commands until the execution is actually over. */ + PROMPT_BLOCKED, + + /* The command finished; display the prompt before returning back to + the top level. */ + PROMPT_NEEDED, + + /* We've displayed the prompt already, ready for input. */ + PROMPTED, +}; + +/* All about a user interface instance. Each user interface has its + own I/O files/streams, readline state, its own top level + interpreter (for the main UI, this is the interpreter specified + with -i on the command line) and secondary interpreters (for + interpreter-exec ...), etc. There's always one UI associated with + stdin/stdout/stderr, but the user can create secondary UIs, for + example, to create a separate MI channel on its own stdio + streams. */ + +struct ui +{ + /* Create a new UI. */ + ui (FILE *instream, FILE *outstream, FILE *errstream); + ~ui (); + + DISABLE_COPY_AND_ASSIGN (ui); + + /* Pointer to next in singly-linked list. */ + struct ui *next; + + /* Convenient handle (UI number). Unique across all UIs. */ + int num; + + /* The UI's command line buffer. This is to used to accumulate + input until we have a whole command line. */ + struct buffer line_buffer; + + /* The callback used by the event loop whenever an event is detected + on the UI's input file descriptor. This function incrementally + builds a buffer where it accumulates the line read up to the + point of invocation. In the special case in which the character + read is newline, the function invokes the INPUT_HANDLER callback + (see below). */ + void (*call_readline) (gdb_client_data); + + /* The function to invoke when a complete line of input is ready for + processing. */ + void (*input_handler) (gdb::unique_xmalloc_ptr &&); + + /* True if this UI is using the readline library for command + editing; false if using GDB's own simple readline emulation, with + no editing support. */ + int command_editing; + + /* Each UI has its own independent set of interpreters. */ + struct ui_interp_info *interp_info; + + /* True if the UI is in async mode, false if in sync mode. If in + sync mode, a synchronous execution command (e.g, "next") does not + return until the command is finished. If in async mode, then + running a synchronous command returns right after resuming the + target. Waiting for the command's completion is later done on + the top event loop. For the main UI, this starts out disabled, + until all the explicit command line arguments (e.g., `gdb -ex + "start" -ex "next"') are processed. */ + int async; + + /* The number of nested readline secondary prompts that are + currently active. */ + int secondary_prompt_depth; + + /* The UI's stdin. Set to stdin for the main UI. */ + FILE *stdin_stream; + + /* stdio stream that command input is being read from. Set to stdin + normally. Set by source_command to the file we are sourcing. + Set to NULL if we are executing a user-defined command or + interacting via a GUI. */ + FILE *instream; + /* Standard output stream. */ + FILE *outstream; + /* Standard error stream. */ + FILE *errstream; + + /* The file descriptor for the input stream, so that we can register + it with the event loop. */ + int input_fd; + + /* Whether ISATTY returns true on input_fd. Cached here because + quit_force needs to know this _after_ input_fd might be + closed. */ + int input_interactive_p; + + /* See enum prompt_state's description. */ + enum prompt_state prompt_state; + + /* The fields below that start with "m_" are "private". They're + meant to be accessed through wrapper macros that make them look + like globals. */ + + /* The ui_file streams. */ + /* Normal results */ + struct ui_file *m_gdb_stdout; + /* Input stream */ + struct ui_file *m_gdb_stdin; + /* Serious error notifications */ + struct ui_file *m_gdb_stderr; + /* Log/debug/trace messages that should bypass normal stdout/stderr + filtering. For moment, always call this stream using + *_unfiltered. In the very near future that restriction shall be + removed - either call shall be unfiltered. (cagney 1999-06-13). */ + struct ui_file *m_gdb_stdlog; + + /* The current ui_out. */ + struct ui_out *m_current_uiout; +}; + +/* The main UI. This is the UI that is bound to stdin/stdout/stderr. + It always exists and is created automatically when GDB starts + up. */ +extern struct ui *main_ui; + +/* The current UI. */ +extern struct ui *current_ui; + +/* The list of all UIs. */ +extern struct ui *ui_list; + +/* State for SWITCH_THRU_ALL_UIS. */ +class switch_thru_all_uis +{ +public: + + switch_thru_all_uis () : m_iter (ui_list), m_save_ui (¤t_ui) + { + current_ui = ui_list; + } + + /* If done iterating, return true; otherwise return false. */ + bool done () const + { + return m_iter == NULL; + } + + /* Move to the next UI, setting current_ui if iteration is not yet + complete. */ + void next () + { + m_iter = m_iter->next; + if (m_iter != NULL) + current_ui = m_iter; + } + + private: + + /* No need for these. They are intentionally not defined + anywhere. */ + switch_thru_all_uis &operator= (const switch_thru_all_uis &); + switch_thru_all_uis (const switch_thru_all_uis &); + + /* Used to iterate through the UIs. */ + struct ui *m_iter; + + /* Save and restore current_ui. */ + scoped_restore_tmpl m_save_ui; +}; + + /* Traverse through all UI, and switch the current UI to the one + being iterated. */ +#define SWITCH_THRU_ALL_UIS() \ + for (switch_thru_all_uis stau_state; !stau_state.done (); stau_state.next ()) + +/* Traverse over all UIs. */ +#define ALL_UIS(UI) \ + for (UI = ui_list; UI; UI = UI->next) \ + +/* Register the UI's input file descriptor in the event loop. */ +extern void ui_register_input_event_handler (struct ui *ui); + +/* Unregister the UI's input file descriptor from the event loop. */ +extern void ui_unregister_input_event_handler (struct ui *ui); + /* From top.c. */ -extern char *line; -extern int linesize; -extern FILE *instream; -extern int in_user_command; -extern int caution; -extern char gdb_dirbuf[1024]; +extern bool confirm; extern int inhibit_gdbinit; -extern int epoch_interface; -extern char gdbinit[]; -extern void print_gdb_version (struct ui_file *); +/* Print the GDB version banner to STREAM. If INTERACTIVE is false, + then information referring to commands (e.g., "show configuration") + is omitted; this mode is used for the --version command line + option. If INTERACTIVE is true, then interactive commands are + mentioned. */ +extern void print_gdb_version (struct ui_file *stream, bool interactive); + +extern void print_gdb_configuration (struct ui_file *); extern void read_command_file (FILE *); extern void init_history (void); extern void command_loop (void); -extern void simplified_command_loop (char *(*read_input_func) (char *), - void (*execute_command_func) (char *, - int)); extern int quit_confirm (void); -extern void quit_force (char *, int); -extern void quit_command (char *, int); -extern int quit_cover (void *); -extern void execute_command (char *, int); +extern void quit_force (int *, int); +extern void quit_command (const char *, int); +extern void quit_cover (void); +extern void execute_command (const char *, int); + +/* If the interpreter is in sync mode (we're running a user command's + list, running command hooks or similars), and we just ran a + synchronous command that started the target, wait for that command + to end. WAS_SYNC indicates whether sync_execution was set before + the command was run. */ + +extern void maybe_wait_sync_command_done (int was_sync); + +/* Wait for a synchronous execution command to end. */ +extern void wait_sync_command_done (void); + +extern void check_frame_language_change (void); /* Prepare for execution of a command. - Call this before every command, CLI or MI. */ -extern void prepare_execute_command (void); + Call this before every command, CLI or MI. + Returns a cleanup to be run after the command is completed. */ +extern scoped_value_mark prepare_execute_command (void); /* This function returns a pointer to the string that is used - by gdb for its command prompt. */ + by gdb for its command prompt. */ extern char *get_prompt (void); -/* This function copies the specified string into the string that - is used by gdb for its command prompt. */ -extern void set_prompt (char *); +/* This function returns a pointer to the string that is used + by gdb for its command prompt. */ +extern void set_prompt (const char *s); + +/* Return 1 if UI's current input handler is a secondary prompt, 0 + otherwise. */ + +extern int gdb_in_secondary_prompt_p (struct ui *ui); /* From random places. */ extern int readnow_symbol_files; +extern int readnever_symbol_files; -/* Perform _initialize initialization */ +/* Perform _initialize initialization. */ extern void gdb_init (char *); -/* For use by event-top.c */ -/* Variables from top.c. */ +/* For use by event-top.c. */ +/* Variables from top.c. */ extern int source_line_number; -extern char *source_file_name; -extern int history_expansion_p; +extern std::string source_file_name; +extern bool history_expansion_p; extern int server_command; extern char *lim_at_start; -extern void show_commands (char *args, int from_tty); +extern void gdb_add_history (const char *); + +extern void show_commands (const char *args, int from_tty); -extern void set_history (char *, int); +extern void set_history (const char *, int); -extern void show_history (char *, int); +extern void show_history (const char *, int); -extern void set_verbose (char *, int, struct cmd_list_element *); +extern void set_verbose (const char *, int, struct cmd_list_element *); -extern void do_restore_instream_cleanup (void *stream); +extern char *handle_line_of_input (struct buffer *cmd_line_buffer, + const char *rl, int repeat, + const char *annotation_suffix); #endif