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 /* Prompt state.  */
  29
  30 enum prompt_state
  31 {
  32   /* The command line is blocked simulating synchronous execution.
  33      This is used to implement the foreground execution commands
  34      ('run', 'continue', etc.).  We won't display the prompt and
  35      accept further commands until the execution is actually over.  */
  36   PROMPT_BLOCKED,
  37
  38   /* The command finished; display the prompt before returning back to
  39      the top level.  */
  40   PROMPT_NEEDED,
  41
  42   /* We've displayed the prompt already, ready for input.  */
  43   PROMPTED,
  44 };
  45
  46 /* All about a user interface instance.  Each user interface has its
  47    own I/O files/streams, readline state, its own top level
  48    interpreter (for the main UI, this is the interpreter specified
  49    with -i on the command line) and secondary interpreters (for
  50    interpreter-exec ...), etc.  There's always one UI associated with
  51    stdin/stdout/stderr, but the user can create secondary UIs, for
  52    example, to create a separate MI channel on its own stdio
  53    streams.  */
  54
  55 struct ui
  56 {
  57   /* Pointer to next in singly-linked list.  */
  58   struct ui *next;
  59
  60   /* The UI's command line buffer.  This is to used to accumulate
  61      input until we have a whole command line.  */
  62   struct buffer line_buffer;
  63
  64   /* The callback used by the event loop whenever an event is detected
  65      on the UI's input file descriptor.  This function incrementally
  66      builds a buffer where it accumulates the line read up to the
  67      point of invocation.  In the special case in which the character
  68      read is newline, the function invokes the INPUT_HANDLER callback
  69      (see below).  */
  70   void (*call_readline) (gdb_client_data);
  71
  72   /* The function to invoke when a complete line of input is ready for
  73      processing.  */
  74   void (*input_handler) (char *);
  75
  76   /* True if this UI is using the readline library for command
  77      editing; false if using GDB's own simple readline emulation, with
  78      no editing support.  */
  79   int command_editing;
  80
  81   /* Each UI has its own independent set of interpreters.  */
  82   struct ui_interp_info *interp_info;
  83
  84   /* True if the UI is in async mode, false if in sync mode.  If in
  85      sync mode, a synchronous execution command (e.g, "next") does not
  86      return until the command is finished.  If in async mode, then
  87      running a synchronous command returns right after resuming the
  88      target.  Waiting for the command's completion is later done on
  89      the top event loop.  For the main UI, this starts out disabled,
  90      until all the explicit command line arguments (e.g., `gdb -ex
  91      "start" -ex "next"') are processed.  */
  92   int async;
  93
  94   /* The number of nested readline secondary prompts that are
  95      currently active.  */
  96   int secondary_prompt_depth;
  97
  98   /* stdio stream that command input is being read from.  Set to stdin
  99      normally.  Set by source_command to the file we are sourcing.
 100      Set to NULL if we are executing a user-defined command or
 101      interacting via a GUI.  */
 102   FILE *instream;
 103   /* Standard output stream.  */
 104   FILE *outstream;
 105   /* Standard error stream.  */
 106   FILE *errstream;
 107
 108   /* The file descriptor for the input stream, so that we can register
 109      it with the event loop.  */
 110   int input_fd;
 111
 112   /* See enum prompt_state's description.  */
 113   enum prompt_state prompt_state;
 114
 115   /* The fields below that start with "m_" are "private".  They're
 116      meant to be accessed through wrapper macros that make them look
 117      like globals.  */
 118
 119   /* The ui_file streams.  */
 120   /* Normal results */
 121   struct ui_file *m_gdb_stdout;
 122   /* Input stream */
 123   struct ui_file *m_gdb_stdin;
 124   /* Serious error notifications */
 125   struct ui_file *m_gdb_stderr;
 126   /* Log/debug/trace messages that should bypass normal stdout/stderr
 127      filtering.  For moment, always call this stream using
 128      *_unfiltered.  In the very near future that restriction shall be
 129      removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 130   struct ui_file *m_gdb_stdlog;
 131
 132   /* The current ui_out.  */
 133   struct ui_out *m_current_uiout;
 134 };
 135
 136 /* The main UI.  This is the UI that is bound to stdin/stdout/stderr.
 137    It always exists and is created automatically when GDB starts
 138    up.  */
 139 extern struct ui *main_ui;
 140
 141 /* The current UI.  */
 142 extern struct ui *current_ui;
 143
 144 /* The list of all UIs.  */
 145 extern struct ui *ui_list;
 146
 147 /* State for SWITCH_THRU_ALL_UIS.  Declared here because it is meant
 148    to be created on the stack, but should be treated as opaque.  */
 149 struct switch_thru_all_uis
 150 {
 151   struct ui *iter;
 152   struct cleanup *old_chain;
 153 };
 154
 155 /* Functions to drive SWITCH_THRU_ALL_UIS.  Though declared here by
 156    necessity, these functions should not be used other than via the
 157    SWITCH_THRU_ALL_UIS macro defined below.  */
 158 extern void switch_thru_all_uis_init (struct switch_thru_all_uis *state);
 159 extern int switch_thru_all_uis_cond (struct switch_thru_all_uis *state);
 160 extern void switch_thru_all_uis_next (struct switch_thru_all_uis *state);
 161
 162   /* Traverse through all UI, and switch the current UI to the one
 163      being iterated.  */
 164 #define SWITCH_THRU_ALL_UIS(STATE)              \
 165   for (switch_thru_all_uis_init (&STATE);               \
 166        switch_thru_all_uis_cond (&STATE);               \
 167        switch_thru_all_uis_next (&STATE))
 168
 169 /* Traverse over all UIs.  */
 170 #define ALL_UIS(UI)                             \
 171   for (UI = ui_list; UI; UI = UI->next)         \
 172
 173 /* Cleanup that restores the current UI.  */
 174 extern void restore_ui_cleanup (void *data);
 175
 176 /* From top.c.  */
 177 extern char *saved_command_line;
 178 extern int in_user_command;
 179 extern int confirm;
 180 extern char gdb_dirbuf[1024];
 181 extern int inhibit_gdbinit;
 182 extern const char gdbinit[];
 183
 184 extern void print_gdb_version (struct ui_file *);
 185 extern void print_gdb_configuration (struct ui_file *);
 186
 187 extern void read_command_file (FILE *);
 188 extern void init_history (void);
 189 extern void command_loop (void);
 190 extern int quit_confirm (void);
 191 extern void quit_force (char *, int);
 192 extern void quit_command (char *, int);
 193 extern void quit_cover (void);
 194 extern void execute_command (char *, int);
 195
 196 /* If the interpreter is in sync mode (we're running a user command's
 197    list, running command hooks or similars), and we just ran a
 198    synchronous command that started the target, wait for that command
 199    to end.  WAS_SYNC indicates whether sync_execution was set before
 200    the command was run.  */
 201
 202 extern void maybe_wait_sync_command_done (int was_sync);
 203
 204 /* Wait for a synchronous execution command to end.  */
 205 extern void wait_sync_command_done (void);
 206
 207 extern void check_frame_language_change (void);
 208
 209 /* Prepare for execution of a command.
 210    Call this before every command, CLI or MI.
 211    Returns a cleanup to be run after the command is completed.  */
 212 extern struct cleanup *prepare_execute_command (void);
 213
 214 /* This function returns a pointer to the string that is used
 215    by gdb for its command prompt.  */
 216 extern char *get_prompt (void);
 217
 218 /* This function returns a pointer to the string that is used
 219    by gdb for its command prompt.  */
 220 extern void set_prompt (const char *s);
 221
 222 /* Return 1 if UI's current input handler is a secondary prompt, 0
 223    otherwise.  */
 224
 225 extern int gdb_in_secondary_prompt_p (struct ui *ui);
 226
 227 /* From random places.  */
 228 extern int readnow_symbol_files;
 229
 230 /* Perform _initialize initialization.  */
 231 extern void gdb_init (char *);
 232
 233 /* For use by event-top.c.  */
 234 /* Variables from top.c.  */
 235 extern int source_line_number;
 236 extern const char *source_file_name;
 237 extern int history_expansion_p;
 238 extern int server_command;
 239 extern char *lim_at_start;
 240
 241 extern void gdb_add_history (const char *);
 242
 243 extern void show_commands (char *args, int from_tty);
 244
 245 extern void set_history (char *, int);
 246
 247 extern void show_history (char *, int);
 248
 249 extern void set_verbose (char *, int, struct cmd_list_element *);
 250
 251 extern void do_restore_instream_cleanup (void *stream);
 252
 253 extern char *handle_line_of_input (struct buffer *cmd_line_buffer,
 254                                    char *rl, int repeat,
 255                                    char *annotation_suffix);
 256
 257 #endif