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 struct tl_interp_info;
  27
  28 /* All about a user interface instance.  Each user interface has its
  29    own I/O files/streams, readline state, its own top level
  30    interpreter (for the main UI, this is the interpreter specified
  31    with -i on the command line) and secondary interpreters (for
  32    interpreter-exec ...), etc.  There's always one UI associated with
  33    stdin/stdout/stderr, but the user can create secondary UIs, for
  34    example, to create a separate MI channel on its own stdio
  35    streams.  */
  36
  37 struct ui
  38 {
  39   /* The UI's command line buffer.  This is to used to accumulate
  40      input until we have a whole command line.  */
  41   struct buffer line_buffer;
  42
  43   /* The callback used by the event loop whenever an event is detected
  44      on the UI's input file descriptor.  This function incrementally
  45      builds a buffer where it accumulates the line read up to the
  46      point of invocation.  In the special case in which the character
  47      read is newline, the function invokes the INPUT_HANDLER callback
  48      (see below).  */
  49   void (*call_readline) (gdb_client_data);
  50
  51   /* The function to invoke when a complete line of input is ready for
  52      processing.  */
  53   void (*input_handler) (char *);
  54
  55   /* Each UI has its own independent set of interpreters.  */
  56   struct ui_interp_info *interp_info;
  57
  58   /* True if the UI is in async mode, false if in sync mode.  If in
  59      sync mode, a synchronous execution command (e.g, "next") does not
  60      return until the command is finished.  If in async mode, then
  61      running a synchronous command returns right after resuming the
  62      target.  Waiting for the command's completion is later done on
  63      the top event loop.  For the main UI, this starts out disabled,
  64      until all the explicit command line arguments (e.g., `gdb -ex
  65      "start" -ex "next"') are processed.  */
  66   int async;
  67
  68   /* The fields below that start with "m_" are "private".  They're
  69      meant to be accessed through wrapper macros that make them look
  70      like globals.  */
  71
  72   /* The ui_file streams.  */
  73   /* Normal results */
  74   struct ui_file *m_gdb_stdout;
  75   /* Input stream */
  76   struct ui_file *m_gdb_stdin;
  77   /* Serious error notifications */
  78   struct ui_file *m_gdb_stderr;
  79   /* Log/debug/trace messages that should bypass normal stdout/stderr
  80      filtering.  For moment, always call this stream using
  81      *_unfiltered.  In the very near future that restriction shall be
  82      removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
  83   struct ui_file *m_gdb_stdlog;
  84 };
  85
  86 extern struct ui *current_ui;
  87
  88 /* From top.c.  */
  89 extern char *saved_command_line;
  90 extern FILE *instream;
  91 extern int in_user_command;
  92 extern int confirm;
  93 extern char gdb_dirbuf[1024];
  94 extern int inhibit_gdbinit;
  95 extern const char gdbinit[];
  96
  97 extern void print_gdb_version (struct ui_file *);
  98 extern void print_gdb_configuration (struct ui_file *);
  99
 100 extern void read_command_file (FILE *);
 101 extern void init_history (void);
 102 extern void command_loop (void);
 103 extern int quit_confirm (void);
 104 extern void quit_force (char *, int);
 105 extern void quit_command (char *, int);
 106 extern void quit_cover (void);
 107 extern void execute_command (char *, int);
 108
 109 /* If the interpreter is in sync mode (we're running a user command's
 110    list, running command hooks or similars), and we just ran a
 111    synchronous command that started the target, wait for that command
 112    to end.  WAS_SYNC indicates whether sync_execution was set before
 113    the command was run.  */
 114
 115 extern void maybe_wait_sync_command_done (int was_sync);
 116
 117 /* Wait for a synchronous execution command to end.  */
 118 extern void wait_sync_command_done (void);
 119
 120 extern void check_frame_language_change (void);
 121
 122 /* Prepare for execution of a command.
 123    Call this before every command, CLI or MI.
 124    Returns a cleanup to be run after the command is completed.  */
 125 extern struct cleanup *prepare_execute_command (void);
 126
 127 /* This function returns a pointer to the string that is used
 128    by gdb for its command prompt.  */
 129 extern char *get_prompt (void);
 130
 131 /* This function returns a pointer to the string that is used
 132    by gdb for its command prompt.  */
 133 extern void set_prompt (const char *s);
 134
 135 /* Return 1 if the current input handler is a secondary prompt, 0 otherwise.  */
 136
 137 extern int gdb_in_secondary_prompt_p (void);
 138
 139 /* From random places.  */
 140 extern int readnow_symbol_files;
 141
 142 /* Perform _initialize initialization.  */
 143 extern void gdb_init (char *);
 144
 145 /* For use by event-top.c.  */
 146 /* Variables from top.c.  */
 147 extern int source_line_number;
 148 extern const char *source_file_name;
 149 extern int history_expansion_p;
 150 extern int server_command;
 151 extern char *lim_at_start;
 152
 153 extern void gdb_add_history (const char *);
 154
 155 extern void show_commands (char *args, int from_tty);
 156
 157 extern void set_history (char *, int);
 158
 159 extern void show_history (char *, int);
 160
 161 extern void set_verbose (char *, int, struct cmd_list_element *);
 162
 163 extern void do_restore_instream_cleanup (void *stream);
 164
 165 extern char *handle_line_of_input (struct buffer *cmd_line_buffer,
 166                                    char *rl, int repeat,
 167                                    char *annotation_suffix);
 168
 169 #endif