gdb/ui-out.h

   1 /* Output generating routines for GDB.
   2
   3    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2005, 2007
   4    Free Software Foundation, Inc.
   5
   6    Contributed by Cygnus Solutions.
   7    Written by Fernando Nasser for Cygnus.
   8
   9    This file is part of GDB.
  10
  11    This program is free software; you can redistribute it and/or modify
  12    it under the terms of the GNU General Public License as published by
  13    the Free Software Foundation; either version 2 of the License, or
  14    (at your option) any later version.
  15
  16    This program is distributed in the hope that it will be useful,
  17    but WITHOUT ANY WARRANTY; without even the implied warranty of
  18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19    GNU General Public License for more details.
  20
  21    You should have received a copy of the GNU General Public License
  22    along with this program; if not, write to the Free Software
  23    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24    Boston, MA 02110-1301, USA.  */
  25
  26 #ifndef UI_OUT_H
  27 #define UI_OUT_H 1
  28
  29 /* The ui_out structure */
  30
  31 struct ui_out;
  32 struct ui_out_data;
  33 struct ui_file;
  34
  35 /* the current ui_out */
  36
  37 /* FIXME: This should not be a global but something passed down from main.c
  38    or top.c */
  39 extern struct ui_out *uiout;
  40
  41 /* alignment enum */
  42 enum ui_align
  43   {
  44     ui_left = -1,
  45     ui_center,
  46     ui_right,
  47     ui_noalign
  48   };
  49
  50 /* flags enum */
  51 enum ui_flags
  52   {
  53     ui_from_tty = 1,
  54     ui_source_list = 2
  55   };
  56
  57
  58 /* The ui_out stream structure. */
  59 /* NOTE: cagney/2000-02-01: The ui_stream object can be subsumed by
  60    the more generic ui_file object.  */
  61
  62 struct ui_stream
  63   {
  64     struct ui_out *uiout;
  65     struct ui_file *stream;
  66   };
  67
  68
  69 /* Prototypes for ui-out API. */
  70
  71 /* A result is a recursive data structure consisting of lists and
  72    tuples. */
  73
  74 enum ui_out_type
  75   {
  76     ui_out_type_tuple,
  77     ui_out_type_list
  78   };
  79
  80 extern void ui_out_begin (struct ui_out *uiout,
  81                           enum ui_out_type level_type,
  82                           const char *id);
  83
  84 extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
  85
  86 extern struct cleanup *ui_out_begin_cleanup_end (struct ui_out *uiout,
  87                                                  enum ui_out_type level_type,
  88                                                  const char *id);
  89
  90 /* A table can be considered a special tuple/list combination with the
  91    implied structure: ``table = { hdr = { header, ... } , body = [ {
  92    field, ... }, ... ] }''. If NR_ROWS is negative then there is at
  93    least one row. */
  94 extern void ui_out_table_header (struct ui_out *uiout, int width,
  95                                  enum ui_align align, const char *col_name,
  96                                  const char *colhdr);
  97
  98 extern void ui_out_table_body (struct ui_out *uiout);
  99
 100 extern struct cleanup *make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out,
 101                                                             int nr_cols,
 102                                                            int nr_rows,
 103                                                            const char *tblid);
 104 /* Compatibility wrappers.  */
 105
 106 extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
 107                                                            const char *id);
 108
 109 extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
 110                                                             const char *id);
 111
 112 extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
 113                               int value);
 114
 115 extern void ui_out_field_fmt_int (struct ui_out *uiout, int width,
 116                                   enum ui_align align, const char *fldname,
 117                                   int value);
 118
 119 extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
 120                                     CORE_ADDR address);
 121
 122 extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
 123                                  const char *string);
 124
 125 extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
 126                                  struct ui_stream *buf);
 127
 128 extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
 129                               const char *format, ...)
 130      ATTR_FORMAT (printf, 3, 4);
 131
 132 extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
 133
 134 extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
 135
 136 extern void ui_out_text (struct ui_out *uiout, const char *string);
 137
 138 extern void ui_out_message (struct ui_out *uiout, int verbosity,
 139                             const char *format, ...)
 140      ATTR_FORMAT (printf, 3, 4);
 141
 142 extern struct ui_stream *ui_out_stream_new (struct ui_out *uiout);
 143
 144 extern void ui_out_stream_delete (struct ui_stream *buf);
 145
 146 struct cleanup *make_cleanup_ui_out_stream_delete (struct ui_stream *buf);
 147
 148 extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
 149
 150 extern void ui_out_flush (struct ui_out *uiout);
 151
 152 extern void ui_out_get_field_separator (struct ui_out *uiout);
 153
 154 extern int ui_out_set_flags (struct ui_out *uiout, int mask);
 155
 156 extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
 157
 158 extern int ui_out_get_verblvl (struct ui_out *uiout);
 159
 160 extern int ui_out_test_flags (struct ui_out *uiout, int mask);
 161
 162 #if 0
 163 extern void ui_out_result_begin (struct ui_out *uiout, char *class);
 164
 165 extern void ui_out_result_end (struct ui_out *uiout);
 166
 167 extern void ui_out_info_begin (struct ui_out *uiout, char *class);
 168
 169 extern void ui_out_info_end (struct ui_out *uiout);
 170
 171 extern void ui_out_notify_begin (struct ui_out *uiout, char *class);
 172
 173 extern void ui_out_notify_end (struct ui_out *uiout);
 174
 175 extern void ui_out_error_begin (struct ui_out *uiout, char *class);
 176
 177 extern void ui_out_error_end (struct ui_out *uiout);
 178 #endif
 179
 180 #if 0
 181 extern void gdb_error (struct ui_out *uiout, int severity, char *format, ...);
 182
 183 extern void gdb_query (struct ui_out *uiout, int qflags, char *qprompt);
 184 #endif
 185
 186 /* HACK: Code in GDB is currently checking to see the type of ui_out
 187    builder when determining which output to produce.  This function is
 188    a hack to encapsulate that test.  Once GDB manages to separate the
 189    CLI/MI from the core of GDB the problem should just go away ....  */
 190
 191 extern int ui_out_is_mi_like_p (struct ui_out *uiout);
 192
 193 /* From here on we have things that are only needed by implementation
 194    routines and main.c.   We should pehaps have a separate file for that,
 195    like a  ui-out-impl.h  file */
 196
 197 /* User Interface Output Implementation Function Table */
 198
 199 /* Type definition of all implementation functions. */
 200
 201 typedef void (table_begin_ftype) (struct ui_out * uiout,
 202                                   int nbrofcols, int nr_rows,
 203                                   const char *tblid);
 204 typedef void (table_body_ftype) (struct ui_out * uiout);
 205 typedef void (table_end_ftype) (struct ui_out * uiout);
 206 typedef void (table_header_ftype) (struct ui_out * uiout, int width,
 207                                    enum ui_align align, const char *col_name,
 208                                    const char *colhdr);
 209 /* Note: level 0 is the top-level so LEVEL is always greater than
 210    zero. */
 211 typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
 212                                    enum ui_out_type type,
 213                                    int level, const char *id);
 214 typedef void (ui_out_end_ftype) (struct ui_out *uiout,
 215                                  enum ui_out_type type,
 216                                  int level);
 217 typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
 218                                 enum ui_align align,
 219                                 const char *fldname, int value);
 220 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
 221                                  enum ui_align align,
 222                                  const char *fldname);
 223 typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
 224                                    enum ui_align align,
 225                                    const char *fldname,
 226                                    const char *string);
 227 typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
 228                                 enum ui_align align,
 229                                 const char *fldname,
 230                                 const char *format,
 231                                 va_list args) ATTRIBUTE_FPTR_PRINTF(6,0);
 232 typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
 233 typedef void (text_ftype) (struct ui_out * uiout,
 234                            const char *string);
 235 typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
 236                               const char *format, va_list args)
 237      ATTRIBUTE_FPTR_PRINTF(3,0);
 238 typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
 239 typedef void (flush_ftype) (struct ui_out * uiout);
 240 typedef int (redirect_ftype) (struct ui_out * uiout,
 241                               struct ui_file * outstream);
 242
 243 /* ui-out-impl */
 244
 245 /* IMPORTANT: If you change this structure, make sure to change the default
 246    initialization in ui-out.c */
 247
 248 struct ui_out_impl
 249   {
 250     table_begin_ftype *table_begin;
 251     table_body_ftype *table_body;
 252     table_end_ftype *table_end;
 253     table_header_ftype *table_header;
 254     ui_out_begin_ftype *begin;
 255     ui_out_end_ftype *end;
 256     field_int_ftype *field_int;
 257     field_skip_ftype *field_skip;
 258     field_string_ftype *field_string;
 259     field_fmt_ftype *field_fmt;
 260     spaces_ftype *spaces;
 261     text_ftype *text;
 262     message_ftype *message;
 263     wrap_hint_ftype *wrap_hint;
 264     flush_ftype *flush;
 265     redirect_ftype *redirect;
 266     int is_mi_like_p;
 267   };
 268
 269 extern struct ui_out_data *ui_out_data (struct ui_out *uiout);
 270
 271
 272 /* Create a ui_out object */
 273
 274 extern struct ui_out *ui_out_new (struct ui_out_impl *impl,
 275                                   struct ui_out_data *data,
 276                                   int flags);
 277
 278 /* Redirect the ouptut of a ui_out object temporarily.  */
 279
 280 extern int ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream);
 281
 282 #endif /* UI_OUT_H */