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 #include "common/enum-flags.h"
  27
  28 /* The ui_out structure */
  29
  30 struct ui_out;
  31 struct ui_file;
  32
  33 /* the current ui_out */
  34
  35 /* FIXME: This should not be a global but something passed down from main.c
  36    or top.c.  */
  37 extern struct ui_out **current_ui_current_uiout_ptr (void);
  38 #define current_uiout (*current_ui_current_uiout_ptr ())
  39
  40 /* alignment enum */
  41 enum ui_align
  42   {
  43     ui_left = -1,
  44     ui_center,
  45     ui_right,
  46     ui_noalign
  47   };
  48
  49 /* flags enum */
  50 enum ui_out_flag
  51   {
  52     ui_source_list = (1 << 0),
  53   };
  54
  55 DEF_ENUM_FLAGS_TYPE (ui_out_flag, ui_out_flags);
  56
  57 /* Prototypes for ui-out API.  */
  58
  59 /* A result is a recursive data structure consisting of lists and
  60    tuples.  */
  61
  62 enum ui_out_type
  63   {
  64     ui_out_type_tuple,
  65     ui_out_type_list
  66   };
  67
  68 extern void ui_out_begin (struct ui_out *uiout,
  69                           enum ui_out_type level_type,
  70                           const char *id);
  71
  72 extern void ui_out_end (struct ui_out *uiout, enum ui_out_type type);
  73
  74 /* A table can be considered a special tuple/list combination with the
  75    implied structure: ``table = { hdr = { header, ... } , body = [ {
  76    field, ... }, ... ] }''.  If NR_ROWS is negative then there is at
  77    least one row.  */
  78 extern void ui_out_table_header (struct ui_out *uiout, int width,
  79                                  enum ui_align align,
  80                                  const std::string &col_name,
  81                                  const std::string &col_hdr);
  82
  83 extern void ui_out_table_body (struct ui_out *uiout);
  84
  85 extern struct cleanup *make_cleanup_ui_out_table_begin_end (struct ui_out *ui_out,
  86                                                             int nr_cols,
  87                                                             int nr_rows,
  88                                                             const char *tblid);
  89 /* Compatibility wrappers.  */
  90
  91 extern struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *uiout,
  92                                                            const char *id);
  93
  94 extern struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *uiout,
  95                                                             const char *id);
  96
  97 extern void ui_out_field_int (struct ui_out *uiout, const char *fldname,
  98                               int value);
  99
 100 extern void ui_out_field_fmt_int (struct ui_out *uiout, int width,
 101                                   enum ui_align align, const char *fldname,
 102                                   int value);
 103
 104 /* Output a field containing an address.  */
 105
 106 extern void ui_out_field_core_addr (struct ui_out *uiout, const char *fldname,
 107                                     struct gdbarch *gdbarch, CORE_ADDR address);
 108
 109 extern void ui_out_field_string (struct ui_out * uiout, const char *fldname,
 110                                  const char *string);
 111
 112 extern void ui_out_field_stream (struct ui_out *uiout, const char *fldname,
 113                                  struct ui_file *stream);
 114
 115 extern void ui_out_field_fmt (struct ui_out *uiout, const char *fldname,
 116                               const char *format, ...)
 117      ATTRIBUTE_PRINTF (3, 4);
 118
 119 extern void ui_out_field_skip (struct ui_out *uiout, const char *fldname);
 120
 121 extern void ui_out_spaces (struct ui_out *uiout, int numspaces);
 122
 123 extern void ui_out_text (struct ui_out *uiout, const char *string);
 124
 125 extern void ui_out_message (struct ui_out *uiout, const char *format, ...)
 126      ATTRIBUTE_PRINTF (2, 3);
 127
 128 extern void ui_out_wrap_hint (struct ui_out *uiout, const char *identstring);
 129
 130 extern void ui_out_flush (struct ui_out *uiout);
 131
 132 extern int ui_out_test_flags (struct ui_out *uiout, ui_out_flags mask);
 133
 134 extern int ui_out_query_field (struct ui_out *uiout, int colno,
 135                                int *width, int *alignment,
 136                                const char **col_name);
 137
 138 /* HACK: Code in GDB is currently checking to see the type of ui_out
 139    builder when determining which output to produce.  This function is
 140    a hack to encapsulate that test.  Once GDB manages to separate the
 141    CLI/MI from the core of GDB the problem should just go away ....  */
 142
 143 extern int ui_out_is_mi_like_p (struct ui_out *uiout);
 144
 145 /* From here on we have things that are only needed by implementation
 146    routines and main.c.   We should pehaps have a separate file for that,
 147    like a  ui-out-impl.h  file.  */
 148
 149 /* User Interface Output Implementation Function Table */
 150
 151 /* Type definition of all implementation functions.  */
 152
 153 typedef void (table_begin_ftype) (struct ui_out * uiout,
 154                                   int nbrofcols, int nr_rows,
 155                                   const char *tblid);
 156 typedef void (table_body_ftype) (struct ui_out * uiout);
 157 typedef void (table_end_ftype) (struct ui_out * uiout);
 158 typedef void (table_header_ftype) (struct ui_out * uiout, int width,
 159                                    enum ui_align align,
 160                                    const std::string &col_name,
 161                                    const std::string &col_hdr);
 162
 163 typedef void (ui_out_begin_ftype) (struct ui_out *uiout,
 164                                    enum ui_out_type type,
 165                                    const char *id);
 166 typedef void (ui_out_end_ftype) (struct ui_out *uiout,
 167                                  enum ui_out_type type);
 168 typedef void (field_int_ftype) (struct ui_out * uiout, int fldno, int width,
 169                                 enum ui_align align,
 170                                 const char *fldname, int value);
 171 typedef void (field_skip_ftype) (struct ui_out * uiout, int fldno, int width,
 172                                  enum ui_align align,
 173                                  const char *fldname);
 174 typedef void (field_string_ftype) (struct ui_out * uiout, int fldno, int width,
 175                                    enum ui_align align,
 176                                    const char *fldname,
 177                                    const char *string);
 178 typedef void (field_fmt_ftype) (struct ui_out * uiout, int fldno, int width,
 179                                 enum ui_align align,
 180                                 const char *fldname,
 181                                 const char *format,
 182                                 va_list args) ATTRIBUTE_FPTR_PRINTF(6,0);
 183 typedef void (spaces_ftype) (struct ui_out * uiout, int numspaces);
 184 typedef void (text_ftype) (struct ui_out * uiout,
 185                            const char *string);
 186 typedef void (message_ftype) (struct ui_out * uiout,
 187                               const char *format, va_list args)
 188      ATTRIBUTE_FPTR_PRINTF(2,0);
 189 typedef void (wrap_hint_ftype) (struct ui_out * uiout, const char *identstring);
 190 typedef void (flush_ftype) (struct ui_out * uiout);
 191 typedef int (redirect_ftype) (struct ui_out * uiout,
 192                               struct ui_file * outstream);
 193 typedef void (data_destroy_ftype) (struct ui_out *uiout);
 194
 195 /* ui-out-impl */
 196
 197 struct ui_out_impl
 198   {
 199     table_begin_ftype *table_begin;
 200     table_body_ftype *table_body;
 201     table_end_ftype *table_end;
 202     table_header_ftype *table_header;
 203     ui_out_begin_ftype *begin;
 204     ui_out_end_ftype *end;
 205     field_int_ftype *field_int;
 206     field_skip_ftype *field_skip;
 207     field_string_ftype *field_string;
 208     field_fmt_ftype *field_fmt;
 209     spaces_ftype *spaces;
 210     text_ftype *text;
 211     message_ftype *message;
 212     wrap_hint_ftype *wrap_hint;
 213     flush_ftype *flush;
 214     redirect_ftype *redirect;
 215     data_destroy_ftype *data_destroy;
 216     int is_mi_like_p;
 217   };
 218
 219 extern void *ui_out_data (struct ui_out *uiout);
 220
 221 extern void uo_field_string (struct ui_out *uiout, int fldno, int width,
 222                              enum ui_align align, const char *fldname,
 223                              const char *string);
 224
 225 /* Create a ui_out object */
 226
 227 extern struct ui_out *ui_out_new (const struct ui_out_impl *impl, void *data,
 228                                   ui_out_flags flags);
 229
 230 /* Redirect the ouptut of a ui_out object temporarily.  */
 231
 232 extern int ui_out_redirect (struct ui_out *uiout, struct ui_file *outstream);
 233
 234 #endif /* UI_OUT_H */