gdb/ui-out.h

   1 /* Output generating routines for GDB.
   2    Copyright 1999, 2000, 2001 Free Software Foundation, Inc.
   3    Contributed by Cygnus Solutions.
   4    Written by Fernando Nasser for Cygnus.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 59 Temple Place - Suite 330,
  21    Boston, MA 02111-1307, USA.  */
  22
  23 #ifndef UI_OUT_H
  24 #define UI_OUT_H 1
  25
  26 /* The ui_out structure */
  27
  28 struct ui_out;
  29 struct ui_out_data;
  30
  31
  32 /* the current ui_out */
  33
  34 /* FIXME: This should not be a global but something passed down from main.c
  35    or top.c */
  36 extern struct ui_out *uiout;
  37
  38 /* alignment enum */
  39 enum ui_align
  40   {
  41     ui_left = -1,
  42     ui_center,
  43     ui_right,
  44     ui_noalign
  45   };
  46
  47 /* flags enum */
  48 enum ui_flags
  49   {
  50     ui_from_tty = 1,
  51     ui_source_list = 2
  52   };
  53
  54
  55 /* The ui_out stream structure. */
  56 /* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by
  57    the more generic ui_file object.  */
  58
  59 struct ui_stream
  60   {
  61     struct ui_out *uiout;
  62     struct ui_file *stream;
  63   };
  64
  65
  66 /* Prototypes for ui-out API. */
  67
  68 extern void ui_out_table_begin (struct ui_out *uiout, int nbrofcols,
  69                                 char *tblid);
  70
  71 extern void ui_out_table_header (struct ui_out *uiout, int width,
  72                                  enum ui_align align, char *colhdr);
  73
  74 extern void ui_out_table_body (struct ui_out *uiout);
  75
  76 extern void ui_out_table_end (struct ui_out *uiout);
  77
  78 extern void ui_out_list_begin (struct ui_out *uiout, char *lstid);
  79
  80 extern void ui_out_list_end (struct ui_out *uiout);
  81
  82 extern struct cleanup *make_cleanup_ui_out_list_end (struct ui_out *uiout);
  83
  84 extern void ui_out_field_int (struct ui_out *uiout, char *fldname, int value);
  85
  86 extern void ui_out_field_core_addr (struct ui_out *uiout, char *fldname,
  87                                     CORE_ADDR address);
  88
  89 extern void ui_out_field_string (struct ui_out * uiout, char *fldname,
  90                                  const char *string);
  91
  92 extern void ui_out_field_stream (struct ui_out *uiout, char *fldname,
  93                                  struct ui_stream *buf);
  94
  95 extern void ui_out_field_fmt (struct ui_out *uiout, char *fldname,
  96                               char *format, ...);
  97
  98 extern void ui_out_field_skip (struct ui_out *uiout, char *fldname);
  99
 100 extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
 101
 102 extern void ui_out_text (struct ui_out *uiout, char *string);
 103
 104 extern void ui_out_message (struct ui_out *uiout, int verbosity,
 105                             char *format, ...);
 106
 107 extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
 108
 109 extern void ui_out_stream_delete (struct ui_stream *buf);
 110
 111 struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf);
 112
 113 extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
 114
 115 extern void ui_out_flush (struct ui_out *uiout);
 116
 117 extern void ui_out_get_field_separator (struct ui_out *uiout);
 118
 119 extern int ui_out_set_flags (struct ui_out *uiout, int mask);
 120
 121 extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
 122
 123 extern int ui_out_get_verblvl (struct ui_out *uiout);
 124
 125 extern int ui_out_test_flags (struct ui_out *uiout, int mask);
 126
 127 #if 0
 128 extern void ui_out_result_begin (struct ui_out *uiout, char *class);
 129
 130 extern void ui_out_result_end (struct ui_out *uiout);
 131
 132 extern void ui_out_info_begin (struct ui_out *uiout, char *class);
 133
 134 extern void ui_out_info_end (struct ui_out *uiout);
 135
 136 extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
 137
 138 extern void ui_out_notify_end (struct ui_out *uiout);
 139
 140 extern void ui_out_error_begin (struct ui_out *uiout, char *class);
 141
 142 extern void ui_out_error_end (struct ui_out *uiout);
 143 #endif
 144
 145 #if 0
 146 extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...);
 147
 148 extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt);
 149 #endif
 150
 151 /* From here on we have things that are only needed by implementation
 152    routines and main.c.   We should pehaps have a separate file for that,
 153    like a  ui-out-impl.h  file */
 154
 155 /* User Interface Output Implementation Function Table */
 156
 157 /* Type definition of all implementation functions. */
 158
 159 typedef void (table_begin_ftype) (struct ui_out * uiout,
 160                                   int nbrofcols, char *tblid);
 161 typedef void (table_body_ftype) (struct ui_out * uiout);
 162 typedef void (table_end_ftype) (struct ui_out * uiout);
 163 typedef void (table_header_ftype) (struct ui_out * uiout, int width,
 164                                    enum ui_align align, char *colhdr);
 165 /* Note: level 0 is the top-level so LEVEL is always greater than
 166    zero. */
 167 typedef void (list_begin_ftype) (struct ui_out * uiout,
 168                                  int level, char *lstid);
 169 typedef void (list_end_ftype) (struct ui_out * uiout, int level);
 170 typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
 171                              enum ui_align align, char *fldname, int value);
 172 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
 173                                  enum ui_align align, char *fldname);
 174 typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
 175                                    enum ui_align align, char *fldname,
 176                                    const char *string);
 177 typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
 178                                 enum ui_align align, char *fldname,
 179                                 char *format, va_list args);
 180 typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
 181 typedef void (text_ftype) (struct ui_out * uiout, char *string);
 182 typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
 183                               char *format, va_list args);
 184 typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
 185 typedef void (flush_ftype) (struct ui_out * uiout);
 186
 187 /* ui-out-impl */
 188
 189 /* IMPORTANT: If you change this structure, make sure to change the default
 190    initialization in ui-out.c */
 191
 192 struct ui_out_impl
 193   {
 194     table_begin_ftype *table_begin;
 195     table_body_ftype *table_body;
 196     table_end_ftype *table_end;
 197     table_header_ftype *table_header;
 198     list_begin_ftype *list_begin;
 199     list_end_ftype *list_end;
 200     field_int_ftype *field_int;
 201     field_skip_ftype *field_skip;
 202     field_string_ftype *field_string;
 203     field_fmt_ftype *field_fmt;
 204     spaces_ftype *spaces;
 205     text_ftype *text;
 206     message_ftype *message;
 207     wrap_hint_ftype *wrap_hint;
 208     flush_ftype *flush;
 209   };
 210
 211 extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
 212
 213
 214 /* Create a ui_out object */
 215
 216 extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
 217                                   struct ui_out_data *data,
 218                                   int flags);
 219
 220 #endif /* UI_OUT_H */