Introduce interpreter factories
[deliverable/binutils-gdb.git] / gdb / top.h
index 3564169b9af39f4e649bb4cb21740fa3d8d7145a..f18b79e942d9fac8fa80fb16db6936fe78663dfa 100644 (file)
--- a/gdb/top.h
+++ b/gdb/top.h
 /* Top level stuff for GDB, the GNU debugger.
-   Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994
-   Free Software Foundation, Inc.
 
-This file is part of GDB.
+   Copyright (C) 1986-2016 Free Software Foundation, Inc.
 
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+   This file is part of GDB.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
-#include <setjmp.h>
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+#ifndef TOP_H
+#define TOP_H
+
+#include "buffer.h"
+#include "event-loop.h"
+
+struct tl_interp_info;
+
+/* 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
+{
+  /* 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) (char *);
+
+  /* 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 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;
+};
+
+extern struct ui *current_ui;
 
 /* From top.c.  */
-extern char *line;
-extern int linesize;
+extern char *saved_command_line;
 extern FILE *instream;
+extern int in_user_command;
+extern int confirm;
 extern char gdb_dirbuf[1024];
 extern int inhibit_gdbinit;
-extern int epoch_interface;
-extern char gdbinit[];
-
-/* Generally one should use catch_errors rather than manipulating these
-   directly.  The exception is main().  */
-#if defined(HAVE_SIGSETJMP)
-#define SIGJMP_BUF             sigjmp_buf
-#define SIGSETJMP(buf)         sigsetjmp(buf, 1)
-#define SIGLONGJMP(buf,val)    siglongjmp(buf,val)
-#else
-#define SIGJMP_BUF             jmp_buf
-#define SIGSETJMP(buf)         setjmp(buf)
-#define SIGLONGJMP(buf,val)    longjmp(buf,val)
-#endif
+extern const char gdbinit[];
+
+extern void print_gdb_version (struct ui_file *);
+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 int quit_confirm (void);
+extern void quit_force (char *, int);
+extern void quit_command (char *, int);
+extern void quit_cover (void);
+extern void execute_command (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 SIGJMP_BUF error_return;
-extern SIGJMP_BUF quit_return;
+extern void maybe_wait_sync_command_done (int was_sync);
 
-extern void print_gdb_version PARAMS ((GDB_FILE *));
+/* Wait for a synchronous execution command to end.  */
+extern void wait_sync_command_done (void);
 
-extern void source_command PARAMS ((char *, int));
-extern void cd_command PARAMS ((char *, int));
-extern void read_command_file PARAMS ((FILE *));
-extern void init_history PARAMS ((void));
-extern void command_loop PARAMS ((void));
-extern int quit_confirm PARAMS ((void));
-extern void quit_force PARAMS ((char *, int));
-extern void quit_command PARAMS ((char *, int));
+extern void check_frame_language_change (void);
+
+/* Prepare for execution of a command.
+   Call this before every command, CLI or MI.
+   Returns a cleanup to be run after the command is completed.  */
+extern struct cleanup *prepare_execute_command (void);
+
+/* This function returns a pointer to the string that is used
+   by gdb for its command prompt.  */
+extern char *get_prompt (void);
 
 /* This function returns a pointer to the string that is used
-   by gdb for its command prompt. */
-extern char *get_prompt PARAMS((void));
-/* This function copies the specified string into the string that
-   is used by gdb for its command prompt. */
-extern void set_prompt PARAMS ((char *));
+   by gdb for its command prompt.  */
+extern void set_prompt (const char *s);
+
+/* Return 1 if the current input handler is a secondary prompt, 0 otherwise.  */
+
+extern int gdb_in_secondary_prompt_p (void);
 
 /* From random places.  */
-extern int mapped_symbol_files;
 extern int readnow_symbol_files;
-#define        ALL_CLEANUPS    ((struct cleanup *)0)
+
+/* Perform _initialize initialization.  */
+extern void gdb_init (char *);
+
+/* For use by event-top.c.  */
+/* Variables from top.c.  */
+extern int source_line_number;
+extern const char *source_file_name;
+extern int history_expansion_p;
+extern int server_command;
+extern char *lim_at_start;
+
+extern void gdb_add_history (const char *);
+
+extern void show_commands (char *args, int from_tty);
+
+extern void set_history (char *, int);
+
+extern void show_history (char *, int);
+
+extern void set_verbose (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,
+                                  char *rl, int repeat,
+                                  char *annotation_suffix);
+
+#endif
This page took 0.02821 seconds and 4 git commands to generate.