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