gdb/ui-out.h

   1 /* Output generating routines for GDB.
   2
   3    Copyright (C) 1999-2016 Free Software Foundation, Inc.
   4
   5    Contributed by Cygnus Solutions.
   6    Written by Fernando Nasser for Cygnus.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  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_file;
  30
  31 /* the current ui_out */
  32
  33 /* FIXME: This should not be a global but something passed down from main.c
  34    or top.c.  */
  35 extern struct ui_out **current_ui_current_uiout_ptr (void);
  36 #define current_uiout (*current_ui_current_uiout_ptr ())
  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 /* Prototypes for ui-out API.  */
  56
  57 /* A result is a recursive data structure consisting of lists and
  58    tuples.  */
  59
  60 enum ui_out_type
  61   {
  62     ui_out_type_tuple,
  63     ui_out_type_list
  64   };
  65
  66 extern void ui_out_begin (struct ui_out *uiout,
  67                           enum ui_out_type level_type,
  68                           const char *id);
  69
  70 extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
  71
  72 extern struct cleanup *ui_out_begin_cleanup_end (struct ui_out *uiout,
  73                                                  enum ui_out_type level_type,
  74                                                  const char *id);
  75
  76 /* A table can be considered a special tuple/list combination with the
  77    implied structure: ``table = { hdr = { header, ... } , body = [ {
  78    field, ... }, ... ] }''.  If NR_ROWS is negative then there is at
  79    least one row.  */
  80 extern void ui_out_table_header (struct ui_out *uiout, int width,
  81                                  enum ui_align align, const char *col_name,
  82                                  const char *colhdr);
  83
  84 extern void ui_out_table_body (struct ui_out *uiout);
  85
  86 extern struct cleanup *make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out,
  87                                                             int nr_cols,
  88                                                             int nr_rows,
  89                                                             const char *tblid);
  90 /* Compatibility wrappers.  */
  91
  92 extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
  93                                                            const char *id);
  94
  95 extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
  96                                                             const char *id);
  97
  98 extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
  99                               int value);
 100
 101 extern void ui_out_field_fmt_int (struct ui_out *uiout, int width,
 102                                   enum ui_align align, const char *fldname,
 103                                   int value);
 104
 105 /* Output a field containing an address.  */
 106
 107 extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
 108                                     struct gdbarch *gdbarch, CORE_ADDR address);
 109
 110 extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
 111                                  const char *string);
 112
 113 extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
 114                                  struct ui_file *stream);
 115
 116 extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
 117                               const char *format, ...)
 118      ATTRIBUTE_PRINTF (3, 4);
 119
 120 extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
 121
 122 extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
 123
 124 extern void ui_out_text (struct ui_out *uiout, const char *string);
 125
 126 extern void ui_out_message (struct ui_out *uiout, int verbosity,
 127                             const char *format, ...)
 128      ATTRIBUTE_PRINTF (3, 4);
 129
 130 extern void ui_out_wrap_hint (struct ui_out *uiout, char *identstring);
 131
 132 extern void ui_out_flush (struct ui_out *uiout);
 133
 134 extern int ui_out_set_flags (struct ui_out *uiout, int mask);
 135
 136 extern int ui_out_clear_flags (struct ui_out *uiout, int mask);
 137
 138 extern int ui_out_get_verblvl (struct ui_out *uiout);
 139
 140 extern int ui_out_test_flags (struct ui_out *uiout, int mask);
 141
 142 extern int ui_out_query_field (struct ui_out *uiout, int colno,
 143                                int *width, int *alignment, char **col_name);
 144
 145 /* HACK: Code in GDB is currently checking to see the type of ui_out
 146    builder when determining which output to produce.  This function is
 147    a hack to encapsulate that test.  Once GDB manages to separate the
 148    CLI/MI from the core of GDB the problem should just go away ....  */
 149
 150 extern int ui_out_is_mi_like_p (struct ui_out *uiout);
 151
 152 /* From here on we have things that are only needed by implementation
 153    routines and main.c.   We should pehaps have a separate file for that,
 154    like a  ui-out-impl.h  file.  */
 155
 156 /* User Interface Output Implementation Function Table */
 157
 158 /* Type definition of all implementation functions.  */
 159
 160 typedef void (table_begin_ftype) (struct ui_out * uiout,
 161                                   int nbrofcols, int nr_rows,
 162                                   const char *tblid);
 163 typedef void (table_body_ftype) (struct ui_out * uiout);
 164 typedef void (table_end_ftype) (struct ui_out * uiout);
 165 typedef void (table_header_ftype) (struct ui_out * uiout, int width,
 166                                    enum ui_align align, const char *col_name,
 167                                    const char *colhdr);
 168 /* Note: level 0 is the top-level so LEVEL is always greater than
 169    zero.  */
 170 typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
 171                                    enum ui_out_type type,
 172                                    int level, const char *id);
 173 typedef void (ui_out_end_ftype) (struct ui_out *uiout,
 174                                  enum ui_out_type type,
 175                                  int level);
 176 typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
 177                                 enum ui_align align,
 178                                 const char *fldname, int value);
 179 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
 180                                  enum ui_align align,
 181                                  const char *fldname);
 182 typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
 183                                    enum ui_align align,
 184                                    const char *fldname,
 185                                    const char *string);
 186 typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
 187                                 enum ui_align align,
 188                                 const char *fldname,
 189                                 const char *format,
 190                                 va_list args) ATTRIBUTE_FPTR_PRINTF(6,0);
 191 typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
 192 typedef void (text_ftype) (struct ui_out * uiout,
 193                            const char *string);
 194 typedef void (message_ftype) (struct ui_out * uiout, int verbosity,
 195                               const char *format, va_list args)
 196      ATTRIBUTE_FPTR_PRINTF(3,0);
 197 typedef void (wrap_hint_ftype) (struct ui_out * uiout, char *identstring);
 198 typedef void (flush_ftype) (struct ui_out * uiout);
 199 typedef int (redirect_ftype) (struct ui_out * uiout,
 200                               struct ui_file * outstream);
 201 typedef void (data_destroy_ftype) (struct ui_out *uiout);
 202
 203 /* ui-out-impl */
 204
 205 /* IMPORTANT: If you change this structure, make sure to change the default
 206    initialization in ui-out.c.  */
 207
 208 struct ui_out_impl
 209   {
 210     table_begin_ftype *table_begin;
 211     table_body_ftype *table_body;
 212     table_end_ftype *table_end;
 213     table_header_ftype *table_header;
 214     ui_out_begin_ftype *begin;
 215     ui_out_end_ftype *end;
 216     field_int_ftype *field_int;
 217     field_skip_ftype *field_skip;
 218     field_string_ftype *field_string;
 219     field_fmt_ftype *field_fmt;
 220     spaces_ftype *spaces;
 221     text_ftype *text;
 222     message_ftype *message;
 223     wrap_hint_ftype *wrap_hint;
 224     flush_ftype *flush;
 225     redirect_ftype *redirect;
 226     data_destroy_ftype *data_destroy;
 227     int is_mi_like_p;
 228   };
 229
 230 extern void *ui_out_data (struct ui_out *uiout);
 231
 232 extern void uo_field_string (struct ui_out *uiout, int fldno, int width,
 233                              enum ui_align align, const char *fldname,
 234                              const char *string);
 235
 236 /* Create a ui_out object */
 237
 238 extern struct ui_out *ui_out_new (const struct ui_out_impl *impl,
 239                                   void *data,
 240                                   int flags);
 241
 242 /* Destroy a ui_out object.  */
 243
 244 extern void ui_out_destroy (struct ui_out *uiout);
 245
 246 /* Redirect the ouptut of a ui_out object temporarily.  */
 247
 248 extern int ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream);
 249
 250 /* Make a cleanup that restores the previous current uiout.  */
 251
 252 extern struct cleanup *make_cleanup_restore_current_uiout (void);
 253
 254 #endif /* UI_OUT_H */