gdb/ui-out.h

   1 /* Output generating routines for GDB.
   2
   3    Copyright (C) 1999-2021 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 <vector>
  27
  28 #include "gdbsupport/enum-flags.h"
  29 #include "ui-style.h"
  30
  31 class ui_out_level;
  32 class ui_out_table;
  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 **current_ui_current_uiout_ptr (void);
  40 #define current_uiout (*current_ui_current_uiout_ptr ())
  41
  42 /* alignment enum */
  43 enum ui_align
  44   {
  45     ui_left = -1,
  46     ui_center,
  47     ui_right,
  48     ui_noalign
  49   };
  50
  51 /* flags enum */
  52 enum ui_out_flag
  53 {
  54   ui_source_list = (1 << 0),
  55   fix_multi_location_breakpoint_output = (1 << 1),
  56   /* For CLI output, this flag is set if unfiltered output is desired.
  57      This should only be used by low-level formatting functions.  */
  58   unfiltered_output = (1 << 2),
  59   /* This indicates that %pF should be disallowed in a printf format
  60      string.  */
  61   disallow_ui_out_field = (1 << 3)
  62 };
  63
  64 DEF_ENUM_FLAGS_TYPE (ui_out_flag, ui_out_flags);
  65
  66 /* Prototypes for ui-out API.  */
  67
  68 /* A result is a recursive data structure consisting of lists and
  69    tuples.  */
  70
  71 enum ui_out_type
  72   {
  73     ui_out_type_tuple,
  74     ui_out_type_list
  75   };
  76
  77 /* The possible kinds of fields.  */
  78 enum class field_kind
  79   {
  80     /* "FIELD_STRING" needs a funny name to avoid clashes with tokens
  81        named "STRING".  See PR build/25250.  FIELD_SIGNED is given a
  82        similar name for consistency.  */
  83     FIELD_SIGNED,
  84     FIELD_STRING,
  85   };
  86
  87 /* The base type of all fields that can be emitted using %pF.  */
  88
  89 struct base_field_s
  90 {
  91   const char *name;
  92   field_kind kind;
  93 };
  94
  95 /* A signed integer field, to be passed to %pF in format strings.  */
  96
  97 struct signed_field_s : base_field_s
  98 {
  99   LONGEST val;
 100 };
 101
 102 /* Construct a temporary signed_field_s on the caller's stack and
 103    return a pointer to the constructed object.  We use this because
 104    it's not possible to pass a reference via va_args.  */
 105
 106 static inline signed_field_s *
 107 signed_field (const char *name, LONGEST val,
 108               signed_field_s &&tmp = {})
 109 {
 110   tmp.name = name;
 111   tmp.kind = field_kind::FIELD_SIGNED;
 112   tmp.val = val;
 113   return &tmp;
 114 }
 115
 116 /* A string field, to be passed to %pF in format strings.  */
 117
 118 struct string_field_s : base_field_s
 119 {
 120   const char *str;
 121 };
 122
 123 /* Construct a temporary string_field_s on the caller's stack and
 124    return a pointer to the constructed object.  We use this because
 125    it's not possible to pass a reference via va_args.  */
 126
 127 static inline string_field_s *
 128 string_field (const char *name, const char *str,
 129               string_field_s &&tmp = {})
 130 {
 131   tmp.name = name;
 132   tmp.kind = field_kind::FIELD_STRING;
 133   tmp.str = str;
 134   return &tmp;
 135 }
 136
 137 /* A styled string.  */
 138
 139 struct styled_string_s
 140 {
 141   /* The style.  */
 142   ui_file_style style;
 143
 144   /* The string.  */
 145   const char *str;
 146 };
 147
 148 /* Construct a temporary styled_string_s on the caller's stack and
 149    return a pointer to the constructed object.  We use this because
 150    it's not possible to pass a reference via va_args.  */
 151
 152 static inline styled_string_s *
 153 styled_string (const ui_file_style &style, const char *str,
 154                styled_string_s &&tmp = {})
 155 {
 156   tmp.style = style;
 157   tmp.str = str;
 158   return &tmp;
 159 }
 160
 161 class ui_out
 162 {
 163  public:
 164
 165   explicit ui_out (ui_out_flags flags = 0);
 166   virtual ~ui_out ();
 167
 168   void push_level (ui_out_type type);
 169   void pop_level (ui_out_type type);
 170
 171   /* A table can be considered a special tuple/list combination with the
 172      implied structure: ``table = { hdr = { header, ... } , body = [ {
 173      field, ... }, ... ] }''.  If NR_ROWS is negative then there is at
 174      least one row.  */
 175
 176   void table_begin (int nr_cols, int nr_rows, const std::string &tblid);
 177   void table_header (int width, ui_align align, const std::string &col_name,
 178                      const std::string &col_hdr);
 179   void table_body ();
 180   void table_end ();
 181
 182   void begin (ui_out_type type, const char *id);
 183   void end (ui_out_type type);
 184
 185   void field_signed (const char *fldname, LONGEST value);
 186   void field_fmt_signed (int width, ui_align align, const char *fldname,
 187                          LONGEST value);
 188   /* Like field_signed, but print an unsigned value.  */
 189   void field_unsigned (const char *fldname, ULONGEST value);
 190   void field_core_addr (const char *fldname, struct gdbarch *gdbarch,
 191                         CORE_ADDR address);
 192   void field_string (const char *fldname, const char *string,
 193                      const ui_file_style &style = ui_file_style ());
 194   void field_string (const char *fldname, const std::string &string);
 195   void field_stream (const char *fldname, string_file &stream,
 196                      const ui_file_style &style = ui_file_style ());
 197   void field_skip (const char *fldname);
 198   void field_fmt (const char *fldname, const char *format, ...)
 199     ATTRIBUTE_PRINTF (3, 4);
 200   void field_fmt (const char *fldname, const ui_file_style &style,
 201                   const char *format, ...)
 202     ATTRIBUTE_PRINTF (4, 5);
 203
 204   void spaces (int numspaces);
 205   void text (const char *string);
 206   void text (const std::string &string);
 207
 208   /* Output a printf-style formatted string.  In addition to the usual
 209      printf format specs, this supports a few GDB-specific
 210      formatters:
 211
 212      - '%pF' - output a field.
 213
 214        The argument is a field, wrapped in any of the base_field_s
 215        subclasses.  signed_field for integer fields, string_field for
 216        string fields.  This is preferred over separate
 217        uiout->field_signed(), uiout_>field_string() etc. calls when
 218        the formatted message is translatable.  E.g.:
 219
 220          uiout->message (_("\nWatchpoint %pF deleted because the program has "
 221                          "left the block in\n"
 222                          "which its expression is valid.\n"),
 223                          signed_field ("wpnum", b->number));
 224
 225      - '%p[' - output the following text in a specified style.
 226        '%p]' - output the following text in the default style.
 227
 228        The argument to '%p[' is a ui_file_style pointer.  The argument
 229        to '%p]' must be nullptr.
 230
 231        This is useful when you want to output some portion of a string
 232        literal in some style.  E.g.:
 233
 234          uiout->message (_(" %p[<repeats %u times>%p]"),
 235                          metadata_style.style ().ptr (),
 236                          reps, repeats, nullptr);
 237
 238      - '%ps' - output a styled string.
 239
 240        The argument is the result of a call to styled_string.  This is
 241        useful when you want to output some runtime-generated string in
 242        some style.  E.g.:
 243
 244          uiout->message (_("this is a target address %ps.\n"),
 245                          styled_string (address_style.style (),
 246                                         paddress (gdbarch, pc)));
 247
 248      Note that these all "abuse" the %p printf format spec, in order
 249      to be compatible with GCC's printf format checking.  This is OK
 250      because code in GDB that wants to print a host address should use
 251      host_address_to_string instead of %p.  */
 252   void message (const char *format, ...) ATTRIBUTE_PRINTF (2, 3);
 253   void vmessage (const ui_file_style &in_style,
 254                  const char *format, va_list args) ATTRIBUTE_PRINTF (3, 0);
 255
 256   void wrap_hint (const char *identstring);
 257
 258   void flush ();
 259
 260   /* Redirect the output of a ui_out object temporarily.  */
 261   void redirect (ui_file *outstream);
 262
 263   ui_out_flags test_flags (ui_out_flags mask);
 264
 265   /* HACK: Code in GDB is currently checking to see the type of ui_out
 266      builder when determining which output to produce.  This function is
 267      a hack to encapsulate that test.  Once GDB manages to separate the
 268      CLI/MI from the core of GDB the problem should just go away ....  */
 269
 270   bool is_mi_like_p () const;
 271
 272   bool query_table_field (int colno, int *width, int *alignment,
 273                           const char **col_name);
 274
 275   /* Return true if this stream is prepared to handle style
 276      escapes.  */
 277   virtual bool can_emit_style_escape () const = 0;
 278
 279   /* An object that starts and finishes a progress meter.  */
 280   class progress_meter
 281   {
 282   public:
 283     /* SHOULD_PRINT indicates whether something should be printed for a tty.  */
 284     progress_meter (struct ui_out *uiout, const std::string &name,
 285                     bool should_print)
 286       : m_uiout (uiout)
 287     {
 288       m_uiout->do_progress_start (name, should_print);
 289     }
 290
 291     ~progress_meter ()
 292     {
 293       m_uiout->do_progress_notify (1.0);
 294       m_uiout->do_progress_end ();
 295     }
 296
 297     progress_meter (const progress_meter &) = delete;
 298     progress_meter &operator= (const progress_meter &) = delete;
 299
 300   private:
 301
 302     struct ui_out *m_uiout;
 303   };
 304
 305   /* Emit some progress corresponding to the most recently created
 306      progress meter.  HOWMUCH may range from 0.0 to 1.0.  */
 307   void progress (double howmuch)
 308   {
 309     do_progress_notify (howmuch);
 310   }
 311
 312  protected:
 313
 314   virtual void do_table_begin (int nbrofcols, int nr_rows, const char *tblid)
 315     = 0;
 316   virtual void do_table_body () = 0;
 317   virtual void do_table_end () = 0;
 318   virtual void do_table_header (int width, ui_align align,
 319                                 const std::string &col_name,
 320                                 const std::string &col_hdr) = 0;
 321
 322   virtual void do_begin (ui_out_type type, const char *id) = 0;
 323   virtual void do_end (ui_out_type type) = 0;
 324   virtual void do_field_signed (int fldno, int width, ui_align align,
 325                                 const char *fldname, LONGEST value) = 0;
 326   virtual void do_field_unsigned (int fldno, int width, ui_align align,
 327                                   const char *fldname, ULONGEST value) = 0;
 328   virtual void do_field_skip (int fldno, int width, ui_align align,
 329                               const char *fldname) = 0;
 330   virtual void do_field_string (int fldno, int width, ui_align align,
 331                                 const char *fldname, const char *string,
 332                                 const ui_file_style &style) = 0;
 333   virtual void do_field_fmt (int fldno, int width, ui_align align,
 334                              const char *fldname, const ui_file_style &style,
 335                              const char *format, va_list args)
 336     ATTRIBUTE_PRINTF (7, 0) = 0;
 337   virtual void do_spaces (int numspaces) = 0;
 338   virtual void do_text (const char *string) = 0;
 339   virtual void do_message (const ui_file_style &style,
 340                            const char *format, va_list args)
 341     ATTRIBUTE_PRINTF (3,0) = 0;
 342   virtual void do_wrap_hint (const char *identstring) = 0;
 343   virtual void do_flush () = 0;
 344   virtual void do_redirect (struct ui_file *outstream) = 0;
 345
 346   virtual void do_progress_start (const std::string &, bool) = 0;
 347   virtual void do_progress_notify (double) = 0;
 348   virtual void do_progress_end () = 0;
 349
 350   /* Set as not MI-like by default.  It is overridden in subclasses if
 351      necessary.  */
 352
 353   virtual bool do_is_mi_like_p () const
 354   { return false; }
 355
 356  private:
 357   void call_do_message (const ui_file_style &style, const char *format,
 358                         ...);
 359
 360   ui_out_flags m_flags;
 361
 362   /* Vector to store and track the ui-out levels.  */
 363   std::vector<std::unique_ptr<ui_out_level>> m_levels;
 364
 365   /* A table, if any.  At present only a single table is supported.  */
 366   std::unique_ptr<ui_out_table> m_table_up;
 367
 368   void verify_field (int *fldno, int *width, ui_align *align);
 369
 370   int level () const;
 371   ui_out_level *current_level () const;
 372 };
 373
 374 /* Start a new tuple or list on construction, and end it on
 375    destruction.  Normally this is used via the typedefs
 376    ui_out_emit_tuple and ui_out_emit_list.  */
 377 template<ui_out_type Type>
 378 class ui_out_emit_type
 379 {
 380 public:
 381
 382   ui_out_emit_type (struct ui_out *uiout, const char *id)
 383     : m_uiout (uiout)
 384   {
 385     uiout->begin (Type, id);
 386   }
 387
 388   ~ui_out_emit_type ()
 389   {
 390     m_uiout->end (Type);
 391   }
 392
 393   DISABLE_COPY_AND_ASSIGN (ui_out_emit_type<Type>);
 394
 395 private:
 396
 397   struct ui_out *m_uiout;
 398 };
 399
 400 typedef ui_out_emit_type<ui_out_type_tuple> ui_out_emit_tuple;
 401 typedef ui_out_emit_type<ui_out_type_list> ui_out_emit_list;
 402
 403 /* Start a new table on construction, and end the table on
 404    destruction.  */
 405 class ui_out_emit_table
 406 {
 407 public:
 408
 409   ui_out_emit_table (struct ui_out *uiout, int nr_cols, int nr_rows,
 410                      const char *tblid)
 411     : m_uiout (uiout)
 412   {
 413     m_uiout->table_begin (nr_cols, nr_rows, tblid);
 414   }
 415
 416   ~ui_out_emit_table ()
 417   {
 418     m_uiout->table_end ();
 419   }
 420
 421   ui_out_emit_table (const ui_out_emit_table &) = delete;
 422   ui_out_emit_table &operator= (const ui_out_emit_table &) = delete;
 423
 424 private:
 425
 426   struct ui_out *m_uiout;
 427 };
 428
 429 /* On destruction, pop the last redirection by calling the uiout's
 430    redirect method with a NULL parameter.  */
 431 class ui_out_redirect_pop
 432 {
 433 public:
 434
 435   ui_out_redirect_pop (ui_out *uiout)
 436     : m_uiout (uiout)
 437   {
 438   }
 439
 440   ~ui_out_redirect_pop ()
 441   {
 442     m_uiout->redirect (NULL);
 443   }
 444
 445   ui_out_redirect_pop (const ui_out_redirect_pop &) = delete;
 446   ui_out_redirect_pop &operator= (const ui_out_redirect_pop &) = delete;
 447
 448 private:
 449   struct ui_out *m_uiout;
 450 };
 451
 452 #endif /* UI_OUT_H */