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   /* Pointer to next in singly-linked list.  */
  40   struct ui *next;
  41
  42   /* The UI's command line buffer.  This is to used to accumulate
  43      input until we have a whole command line.  */
  44   struct buffer line_buffer;
  45
  46   /* The callback used by the event loop whenever an event is detected
  47      on the UI's input file descriptor.  This function incrementally
  48      builds a buffer where it accumulates the line read up to the
  49      point of invocation.  In the special case in which the character
  50      read is newline, the function invokes the INPUT_HANDLER callback
  51      (see below).  */
  52   void (*call_readline) (gdb_client_data);
  53
  54   /* The function to invoke when a complete line of input is ready for
  55      processing.  */
  56   void (*input_handler) (char *);
  57
  58   /* Each UI has its own independent set of interpreters.  */
  59   struct ui_interp_info *interp_info;
  60
  61   /* True if the UI is in async mode, false if in sync mode.  If in
  62      sync mode, a synchronous execution command (e.g, "next") does not
  63      return until the command is finished.  If in async mode, then
  64      running a synchronous command returns right after resuming the
  65      target.  Waiting for the command's completion is later done on
  66      the top event loop.  For the main UI, this starts out disabled,
  67      until all the explicit command line arguments (e.g., `gdb -ex
  68      "start" -ex "next"') are processed.  */
  69   int async;
  70
  71   /* The fields below that start with "m_" are "private".  They're
  72      meant to be accessed through wrapper macros that make them look
  73      like globals.  */
  74
  75   /* The ui_file streams.  */
  76   /* Normal results */
  77   struct ui_file *m_gdb_stdout;
  78   /* Input stream */
  79   struct ui_file *m_gdb_stdin;
  80   /* Serious error notifications */
  81   struct ui_file *m_gdb_stderr;
  82   /* Log/debug/trace messages that should bypass normal stdout/stderr
  83      filtering.  For moment, always call this stream using
  84      *_unfiltered.  In the very near future that restriction shall be
  85      removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
  86   struct ui_file *m_gdb_stdlog;
  87 };
  88
  89 /* The main UI.  This is the UI that is bound to stdin/stdout/stderr.
  90    It always exists and is created automatically when GDB starts
  91    up.  */
  92 extern struct ui *main_ui;
  93
  94 /* The current UI.  */
  95 extern struct ui *current_ui;
  96
  97 /* The list of all UIs.  */
  98 extern struct ui *ui_list;
  99
 100 /* State for SWITCH_THRU_ALL_UIS.  Declared here because it is meant
 101    to be created on the stack, but should be treated as opaque.  */
 102 struct switch_thru_all_uis
 103 {
 104   struct ui *iter;
 105   struct cleanup *old_chain;
 106 };
 107
 108 /* Functions to drive SWITCH_THRU_ALL_UIS.  Though declared here by
 109    necessity, these functions should not be used other than via the
 110    SWITCH_THRU_ALL_UIS macro defined below.  */
 111 extern void switch_thru_all_uis_init (struct switch_thru_all_uis *state);
 112 extern int switch_thru_all_uis_cond (struct switch_thru_all_uis *state);
 113 extern void switch_thru_all_uis_next (struct switch_thru_all_uis *state);
 114
 115   /* Traverse through all UI, and switch the current UI to the one
 116      being iterated.  */
 117 #define SWITCH_THRU_ALL_UIS(STATE)              \
 118   for (switch_thru_all_uis_init (&STATE);               \
 119        switch_thru_all_uis_cond (&STATE);               \
 120        switch_thru_all_uis_next (&STATE))
 121
 122 /* From top.c.  */
 123 extern char *saved_command_line;
 124 extern FILE *instream;
 125 extern int in_user_command;
 126 extern int confirm;
 127 extern char gdb_dirbuf[1024];
 128 extern int inhibit_gdbinit;
 129 extern const char gdbinit[];
 130
 131 extern void print_gdb_version (struct ui_file *);
 132 extern void print_gdb_configuration (struct ui_file *);
 133
 134 extern void read_command_file (FILE *);
 135 extern void init_history (void);
 136 extern void command_loop (void);
 137 extern int quit_confirm (void);
 138 extern void quit_force (char *, int);
 139 extern void quit_command (char *, int);
 140 extern void quit_cover (void);
 141 extern void execute_command (char *, int);
 142
 143 /* If the interpreter is in sync mode (we're running a user command's
 144    list, running command hooks or similars), and we just ran a
 145    synchronous command that started the target, wait for that command
 146    to end.  WAS_SYNC indicates whether sync_execution was set before
 147    the command was run.  */
 148
 149 extern void maybe_wait_sync_command_done (int was_sync);
 150
 151 /* Wait for a synchronous execution command to end.  */
 152 extern void wait_sync_command_done (void);
 153
 154 extern void check_frame_language_change (void);
 155
 156 /* Prepare for execution of a command.
 157    Call this before every command, CLI or MI.
 158    Returns a cleanup to be run after the command is completed.  */
 159 extern struct cleanup *prepare_execute_command (void);
 160
 161 /* This function returns a pointer to the string that is used
 162    by gdb for its command prompt.  */
 163 extern char *get_prompt (void);
 164
 165 /* This function returns a pointer to the string that is used
 166    by gdb for its command prompt.  */
 167 extern void set_prompt (const char *s);
 168
 169 /* Return 1 if the current input handler is a secondary prompt, 0 otherwise.  */
 170
 171 extern int gdb_in_secondary_prompt_p (void);
 172
 173 /* From random places.  */
 174 extern int readnow_symbol_files;
 175
 176 /* Perform _initialize initialization.  */
 177 extern void gdb_init (char *);
 178
 179 /* For use by event-top.c.  */
 180 /* Variables from top.c.  */
 181 extern int source_line_number;
 182 extern const char *source_file_name;
 183 extern int history_expansion_p;
 184 extern int server_command;
 185 extern char *lim_at_start;
 186
 187 extern void gdb_add_history (const char *);
 188
 189 extern void show_commands (char *args, int from_tty);
 190
 191 extern void set_history (char *, int);
 192
 193 extern void show_history (char *, int);
 194
 195 extern void set_verbose (char *, int, struct cmd_list_element *);
 196
 197 extern void do_restore_instream_cleanup (void *stream);
 198
 199 extern char *handle_line_of_input (struct buffer *cmd_line_buffer,
 200                                    char *rl, int repeat,
 201                                    char *annotation_suffix);
 202
 203 #endif