gdb/top.h

   1 /* Top level stuff for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986-2016 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef TOP_H
  21 #define TOP_H
  22
  23 #include "buffer.h"
  24 #include "event-loop.h"
  25
  26 /* All about a user interface instance.  Each user interface has its
  27    own I/O files/streams, readline state, its own top level
  28    interpreter (for the main UI, this is the interpreter specified
  29    with -i on the command line) and secondary interpreters (for
  30    interpreter-exec ...), etc.  There's always one UI associated with
  31    stdin/stdout/stderr, but the user can create secondary UIs, for
  32    example, to create a separate MI channel on its own stdio
  33    streams.  */
  34
  35 struct ui
  36 {
  37   /* The UI's command line buffer.  This is to used to accumulate
  38      input until we have a whole command line.  */
  39   struct buffer line_buffer;
  40
  41   /* The callback used by the event loop whenever an event is detected
  42      on the UI's input file descriptor.  This function incrementally
  43      builds a buffer where it accumulates the line read up to the
  44      point of invocation.  In the special case in which the character
  45      read is newline, the function invokes the INPUT_HANDLER callback
  46      (see below).  */
  47   void (*call_readline) (gdb_client_data);
  48
  49   /* The function to invoke when a complete line of input is ready for
  50      processing.  */
  51   void (*input_handler) (char *);
  52
  53   /* The fields below that start with "m_" are "private".  They're
  54      meant to be accessed through wrapper macros that make them look
  55      like globals.  */
  56
  57   /* The ui_file streams.  */
  58   /* Normal results */
  59   struct ui_file *m_gdb_stdout;
  60   /* Input stream */
  61   struct ui_file *m_gdb_stdin;
  62   /* Serious error notifications */
  63   struct ui_file *m_gdb_stderr;
  64   /* Log/debug/trace messages that should bypass normal stdout/stderr
  65      filtering.  For moment, always call this stream using
  66      *_unfiltered.  In the very near future that restriction shall be
  67      removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
  68   struct ui_file *m_gdb_stdlog;
  69 };
  70
  71 extern struct ui *current_ui;
  72
  73 /* From top.c.  */
  74 extern char *saved_command_line;
  75 extern FILE *instream;
  76 extern int in_user_command;
  77 extern int confirm;
  78 extern char gdb_dirbuf[1024];
  79 extern int inhibit_gdbinit;
  80 extern const char gdbinit[];
  81
  82 extern void print_gdb_version (struct ui_file *);
  83 extern void print_gdb_configuration (struct ui_file *);
  84
  85 extern void read_command_file (FILE *);
  86 extern void init_history (void);
  87 extern void command_loop (void);
  88 extern int quit_confirm (void);
  89 extern void quit_force (char *, int);
  90 extern void quit_command (char *, int);
  91 extern void quit_cover (void);
  92 extern void execute_command (char *, int);
  93
  94 /* If the interpreter is in sync mode (we're running a user command's
  95    list, running command hooks or similars), and we just ran a
  96    synchronous command that started the target, wait for that command
  97    to end.  WAS_SYNC indicates whether sync_execution was set before
  98    the command was run.  */
  99
 100 extern void maybe_wait_sync_command_done (int was_sync);
 101
 102 /* Wait for a synchronous execution command to end.  */
 103 extern void wait_sync_command_done (void);
 104
 105 extern void check_frame_language_change (void);
 106
 107 /* Prepare for execution of a command.
 108    Call this before every command, CLI or MI.
 109    Returns a cleanup to be run after the command is completed.  */
 110 extern struct cleanup *prepare_execute_command (void);
 111
 112 /* This function returns a pointer to the string that is used
 113    by gdb for its command prompt.  */
 114 extern char *get_prompt (void);
 115
 116 /* This function returns a pointer to the string that is used
 117    by gdb for its command prompt.  */
 118 extern void set_prompt (const char *s);
 119
 120 /* Return 1 if the current input handler is a secondary prompt, 0 otherwise.  */
 121
 122 extern int gdb_in_secondary_prompt_p (void);
 123
 124 /* From random places.  */
 125 extern int readnow_symbol_files;
 126
 127 /* Perform _initialize initialization.  */
 128 extern void gdb_init (char *);
 129
 130 /* For use by event-top.c.  */
 131 /* Variables from top.c.  */
 132 extern int source_line_number;
 133 extern const char *source_file_name;
 134 extern int history_expansion_p;
 135 extern int server_command;
 136 extern char *lim_at_start;
 137
 138 extern void gdb_add_history (const char *);
 139
 140 extern void show_commands (char *args, int from_tty);
 141
 142 extern void set_history (char *, int);
 143
 144 extern void show_history (char *, int);
 145
 146 extern void set_verbose (char *, int, struct cmd_list_element *);
 147
 148 extern void do_restore_instream_cleanup (void *stream);
 149
 150 extern char *handle_line_of_input (struct buffer *cmd_line_buffer,
 151                                    char *rl, int repeat,
 152                                    char *annotation_suffix);
 153
 154 #endif