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 /* All about a user interface instance.  Each user interface has its
  27    own I/O files/streams, readline state, its own top level
  28    interpreter (for the main UI, this is the interpreter specified
  29    with -i on the command line) and secondary interpreters (for
  30    interpreter-exec ...), etc.  There's always one UI associated with
  31    stdin/stdout/stderr, but the user can create secondary UIs, for
  32    example, to create a separate MI channel on its own stdio
  33    streams.  */
  34
  35 struct ui
  36 {
  37   /* The UI's command line buffer.  This is to used to accumulate
  38      input until we have a whole command line.  */
  39   struct buffer line_buffer;
  40
  41   /* The callback used by the event loop whenever an event is detected
  42      on the UI's input file descriptor.  This function incrementally
  43      builds a buffer where it accumulates the line read up to the
  44      point of invocation.  In the special case in which the character
  45      read is newline, the function invokes the INPUT_HANDLER callback
  46      (see below).  */
  47   void (*call_readline) (gdb_client_data);
  48
  49   /* The function to invoke when a complete line of input is ready for
  50      processing.  */
  51   void (*input_handler) (char *);
  52 };
  53
  54 extern struct ui *current_ui;
  55
  56 /* From top.c.  */
  57 extern char *saved_command_line;
  58 extern FILE *instream;
  59 extern int in_user_command;
  60 extern int confirm;
  61 extern char gdb_dirbuf[1024];
  62 extern int inhibit_gdbinit;
  63 extern const char gdbinit[];
  64
  65 extern void print_gdb_version (struct ui_file *);
  66 extern void print_gdb_configuration (struct ui_file *);
  67
  68 extern void read_command_file (FILE *);
  69 extern void init_history (void);
  70 extern void command_loop (void);
  71 extern int quit_confirm (void);
  72 extern void quit_force (char *, int);
  73 extern void quit_command (char *, int);
  74 extern void quit_cover (void);
  75 extern void execute_command (char *, int);
  76
  77 /* If the interpreter is in sync mode (we're running a user command's
  78    list, running command hooks or similars), and we just ran a
  79    synchronous command that started the target, wait for that command
  80    to end.  WAS_SYNC indicates whether sync_execution was set before
  81    the command was run.  */
  82
  83 extern void maybe_wait_sync_command_done (int was_sync);
  84
  85 /* Wait for a synchronous execution command to end.  */
  86 extern void wait_sync_command_done (void);
  87
  88 extern void check_frame_language_change (void);
  89
  90 /* Prepare for execution of a command.
  91    Call this before every command, CLI or MI.
  92    Returns a cleanup to be run after the command is completed.  */
  93 extern struct cleanup *prepare_execute_command (void);
  94
  95 /* This function returns a pointer to the string that is used
  96    by gdb for its command prompt.  */
  97 extern char *get_prompt (void);
  98
  99 /* This function returns a pointer to the string that is used
 100    by gdb for its command prompt.  */
 101 extern void set_prompt (const char *s);
 102
 103 /* Return 1 if the current input handler is a secondary prompt, 0 otherwise.  */
 104
 105 extern int gdb_in_secondary_prompt_p (void);
 106
 107 /* From random places.  */
 108 extern int readnow_symbol_files;
 109
 110 /* Perform _initialize initialization.  */
 111 extern void gdb_init (char *);
 112
 113 /* For use by event-top.c.  */
 114 /* Variables from top.c.  */
 115 extern int source_line_number;
 116 extern const char *source_file_name;
 117 extern int history_expansion_p;
 118 extern int server_command;
 119 extern char *lim_at_start;
 120
 121 extern void gdb_add_history (const char *);
 122
 123 extern void show_commands (char *args, int from_tty);
 124
 125 extern void set_history (char *, int);
 126
 127 extern void show_history (char *, int);
 128
 129 extern void set_verbose (char *, int, struct cmd_list_element *);
 130
 131 extern void do_restore_instream_cleanup (void *stream);
 132
 133 extern char *handle_line_of_input (struct buffer *cmd_line_buffer,
 134                                    char *rl, int repeat,
 135                                    char *annotation_suffix);
 136
 137 #endif