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