gcc/pretty-print.h

   1 /* Various declarations for language-independent pretty-print subroutines.
   2    Copyright (C) 2002-2023 Free Software Foundation, Inc.
   3    Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net>
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GCC_PRETTY_PRINT_H
  22 #define GCC_PRETTY_PRINT_H
  23
  24 #include "obstack.h"
  25 #include "rich-location.h"
  26 #include "diagnostic-url.h"
  27
  28 /* Maximum number of format string arguments.  */
  29 #define PP_NL_ARGMAX   30
  30
  31 /* The type of a text to be formatted according a format specification
  32    along with a list of things.  */
  33 struct text_info
  34 {
  35   text_info () = default;
  36   text_info (const char *format_spec,
  37              va_list *args_ptr,
  38              int err_no,
  39              void **data = nullptr,
  40              rich_location *rich_loc = nullptr)
  41   : m_format_spec (format_spec),
  42     m_args_ptr (args_ptr),
  43     m_err_no (err_no),
  44     m_data (data),
  45     m_richloc (rich_loc)
  46   {
  47   }
  48
  49   void set_location (unsigned int idx, location_t loc,
  50                      enum range_display_kind range_display_kind);
  51   location_t get_location (unsigned int index_of_location) const;
  52
  53   const char *m_format_spec;
  54   va_list *m_args_ptr;
  55   int m_err_no;  /* for %m */
  56   void **m_data;
  57   rich_location *m_richloc;
  58 };
  59
  60 /* How often diagnostics are prefixed by their locations:
  61    o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
  62    o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
  63    o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
  64    line is started.  */
  65 enum diagnostic_prefixing_rule_t
  66 {
  67   DIAGNOSTICS_SHOW_PREFIX_ONCE       = 0x0,
  68   DIAGNOSTICS_SHOW_PREFIX_NEVER      = 0x1,
  69   DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
  70 };
  71
  72 /* The chunk_info data structure forms a stack of the results from the
  73    first phase of formatting (pp_format) which have not yet been
  74    output (pp_output_formatted_text).  A stack is necessary because
  75    the diagnostic starter may decide to generate its own output by way
  76    of the formatter.  */
  77 struct chunk_info
  78 {
  79   /* Pointer to previous chunk on the stack.  */
  80   struct chunk_info *prev;
  81
  82   /* Array of chunks to output.  Each chunk is a NUL-terminated string.
  83      In the first phase of formatting, even-numbered chunks are
  84      to be output verbatim, odd-numbered chunks are format specifiers.
  85      The second phase replaces all odd-numbered chunks with formatted
  86      text, and the third phase simply emits all the chunks in sequence
  87      with appropriate line-wrapping.  */
  88   const char *args[PP_NL_ARGMAX * 2];
  89 };
  90
  91 /* The output buffer datatype.  This is best seen as an abstract datatype
  92    whose fields should not be accessed directly by clients.  */
  93 class output_buffer
  94 {
  95 public:
  96   output_buffer ();
  97   ~output_buffer ();
  98
  99   /* Obstack where the text is built up.  */
 100   struct obstack formatted_obstack;
 101
 102   /* Obstack containing a chunked representation of the format
 103      specification plus arguments.  */
 104   struct obstack chunk_obstack;
 105
 106   /* Currently active obstack: one of the above two.  This is used so
 107      that the text formatters don't need to know which phase we're in.  */
 108   struct obstack *obstack;
 109
 110   /* Stack of chunk arrays.  These come from the chunk_obstack.  */
 111   struct chunk_info *cur_chunk_array;
 112
 113   /* Where to output formatted text.  */
 114   FILE *stream;
 115
 116   /* The amount of characters output so far.  */
 117   int line_length;
 118
 119   /* This must be large enough to hold any printed integer or
 120      floating-point value.  */
 121   char digit_buffer[128];
 122
 123   /* Nonzero means that text should be flushed when
 124      appropriate. Otherwise, text is buffered until either
 125      pp_really_flush or pp_clear_output_area are called.  */
 126   bool flush_p;
 127 };
 128
 129 /* Finishes constructing a NULL-terminated character string representing
 130    the buffered text.  */
 131 inline const char *
 132 output_buffer_formatted_text (output_buffer *buff)
 133 {
 134   obstack_1grow (buff->obstack, '\0');
 135   return (const char *) obstack_base (buff->obstack);
 136 }
 137
 138 /* Append to the output buffer a string specified by its
 139    STARTing character and LENGTH.  */
 140 inline void
 141 output_buffer_append_r (output_buffer *buff, const char *start, int length)
 142 {
 143   gcc_checking_assert (start);
 144   obstack_grow (buff->obstack, start, length);
 145   for (int i = 0; i < length; i++)
 146     if (start[i] == '\n')
 147       buff->line_length = 0;
 148     else
 149       buff->line_length++;
 150 }
 151
 152 /*  Return a pointer to the last character emitted in the
 153     output_buffer.  A NULL pointer means no character available.  */
 154 inline const char *
 155 output_buffer_last_position_in_text (const output_buffer *buff)
 156 {
 157   const char *p = NULL;
 158   struct obstack *text = buff->obstack;
 159
 160   if (obstack_base (text) != obstack_next_free (text))
 161     p = ((const char *) obstack_next_free (text)) - 1;
 162   return p;
 163 }
 164
 165
 166 /* The type of pretty-printer flags passed to clients.  */
 167 typedef unsigned int pp_flags;
 168
 169 enum pp_padding
 170 {
 171   pp_none, pp_before, pp_after
 172 };
 173
 174 /* Structure for switching in and out of verbatim mode in a convenient
 175    manner.  */
 176 struct pp_wrapping_mode_t
 177 {
 178   /* Current prefixing rule.  */
 179   diagnostic_prefixing_rule_t rule;
 180
 181   /* The ideal upper bound of number of characters per line, as suggested
 182      by front-end.  */
 183   int line_cutoff;
 184 };
 185
 186 /* Maximum characters per line in automatic line wrapping mode.
 187    Zero means don't wrap lines.  */
 188 #define pp_line_cutoff(PP)  (PP)->wrapping.line_cutoff
 189
 190 /* Prefixing rule used in formatting a diagnostic message.  */
 191 #define pp_prefixing_rule(PP)  (PP)->wrapping.rule
 192
 193 /* Get or set the wrapping mode as a single entity.  */
 194 #define pp_wrapping_mode(PP) (PP)->wrapping
 195
 196 /* The type of a hook that formats client-specific data onto a pretty_printer.
 197    A client-supplied formatter returns true if everything goes well,
 198    otherwise it returns false.  */
 199 typedef bool (*printer_fn) (pretty_printer *, text_info *, const char *,
 200                             int, bool, bool, bool, bool *, const char **);
 201
 202 /* Client supplied function used to decode formats.  */
 203 #define pp_format_decoder(PP) (PP)->format_decoder
 204
 205 /* Base class for an optional client-supplied object for doing additional
 206    processing between stages 2 and 3 of formatted printing.  */
 207 class format_postprocessor
 208 {
 209  public:
 210   virtual ~format_postprocessor () {}
 211   virtual format_postprocessor *clone() const = 0;
 212   virtual void handle (pretty_printer *) = 0;
 213 };
 214
 215 /* TRUE if a newline character needs to be added before further
 216    formatting.  */
 217 #define pp_needs_newline(PP)  (PP)->need_newline
 218
 219 /* True if PRETTY-PRINTER is in line-wrapping mode.  */
 220 #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0)
 221
 222 /* The amount of whitespace to be emitted when starting a new line.  */
 223 #define pp_indentation(PP) (PP)->indent_skip
 224
 225 /* True if identifiers are translated to the locale character set on
 226    output.  */
 227 #define pp_translate_identifiers(PP) (PP)->translate_identifiers
 228
 229 /* True if colors should be shown.  */
 230 #define pp_show_color(PP) (PP)->show_color
 231
 232 class urlifier;
 233
 234 /* The data structure that contains the bare minimum required to do
 235    proper pretty-printing.  Clients may derived from this structure
 236    and add additional fields they need.  */
 237 class pretty_printer
 238 {
 239 public:
 240   /* Default construct a pretty printer with specified
 241      maximum line length cut off limit.  */
 242   explicit pretty_printer (int = 0);
 243   explicit pretty_printer (const pretty_printer &other);
 244
 245   virtual ~pretty_printer ();
 246
 247   virtual pretty_printer *clone () const;
 248
 249   /* Where we print external representation of ENTITY.  */
 250   output_buffer *buffer;
 251
 252   /* The prefix for each new line.  If non-NULL, this is "owned" by the
 253      pretty_printer, and will eventually be free-ed.  */
 254   char *prefix;
 255
 256   /* Where to put whitespace around the entity being formatted.  */
 257   pp_padding padding;
 258
 259   /* The real upper bound of number of characters per line, taking into
 260      account the case of a very very looong prefix.  */
 261   int maximum_length;
 262
 263   /* Indentation count.  */
 264   int indent_skip;
 265
 266   /* Current wrapping mode.  */
 267   pp_wrapping_mode_t wrapping;
 268
 269   /* If non-NULL, this function formats a TEXT into the BUFFER.  When called,
 270      TEXT->format_spec points to a format code.  FORMAT_DECODER should call
 271      pp_string (and related functions) to add data to the BUFFER.
 272      FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
 273      If the BUFFER needs additional characters from the format string, it
 274      should advance the TEXT->format_spec as it goes.  When FORMAT_DECODER
 275      returns, TEXT->format_spec should point to the last character processed.
 276      The QUOTE and BUFFER_PTR are passed in, to allow for deferring-handling
 277      of format codes (e.g. %H and %I in the C++ frontend).  */
 278   printer_fn format_decoder;
 279
 280   /* If non-NULL, this is called by pp_format once after all format codes
 281      have been processed, to allow for client-specific postprocessing.
 282      This is used by the C++ frontend for handling the %H and %I
 283      format codes (which interract with each other).  */
 284   format_postprocessor *m_format_postprocessor;
 285
 286   /* Nonzero if current PREFIX was emitted at least once.  */
 287   bool emitted_prefix;
 288
 289   /* Nonzero means one should emit a newline before outputting anything.  */
 290   bool need_newline;
 291
 292   /* Nonzero means identifiers are translated to the locale character
 293      set on output.  */
 294   bool translate_identifiers;
 295
 296   /* Nonzero means that text should be colorized.  */
 297   bool show_color;
 298
 299   /* Whether URLs should be emitted, and which terminator to use.  */
 300   diagnostic_url_format url_format;
 301
 302   /* If true, then we've had a pp_begin_url (nullptr), and so the
 303      next pp_end_url should be a no-op.  */
 304   bool m_skipping_null_url;
 305 };
 306
 307 inline const char *
 308 pp_get_prefix (const pretty_printer *pp) { return pp->prefix; }
 309
 310 #define pp_space(PP)            pp_character (PP, ' ')
 311 #define pp_left_paren(PP)       pp_character (PP, '(')
 312 #define pp_right_paren(PP)      pp_character (PP, ')')
 313 #define pp_left_bracket(PP)     pp_character (PP, '[')
 314 #define pp_right_bracket(PP)    pp_character (PP, ']')
 315 #define pp_left_brace(PP)       pp_character (PP, '{')
 316 #define pp_right_brace(PP)      pp_character (PP, '}')
 317 #define pp_semicolon(PP)        pp_character (PP, ';')
 318 #define pp_comma(PP)            pp_character (PP, ',')
 319 #define pp_dot(PP)              pp_character (PP, '.')
 320 #define pp_colon(PP)            pp_character (PP, ':')
 321 #define pp_colon_colon(PP)      pp_string (PP, "::")
 322 #define pp_arrow(PP)            pp_string (PP, "->")
 323 #define pp_equal(PP)            pp_character (PP, '=')
 324 #define pp_question(PP)         pp_character (PP, '?')
 325 #define pp_bar(PP)              pp_character (PP, '|')
 326 #define pp_bar_bar(PP)          pp_string (PP, "||")
 327 #define pp_carret(PP)           pp_character (PP, '^')
 328 #define pp_ampersand(PP)        pp_character (PP, '&')
 329 #define pp_ampersand_ampersand(PP) pp_string (PP, "&&")
 330 #define pp_less(PP)             pp_character (PP, '<')
 331 #define pp_less_equal(PP)       pp_string (PP, "<=")
 332 #define pp_greater(PP)          pp_character (PP, '>')
 333 #define pp_greater_equal(PP)    pp_string (PP, ">=")
 334 #define pp_plus(PP)             pp_character (PP, '+')
 335 #define pp_minus(PP)            pp_character (PP, '-')
 336 #define pp_star(PP)             pp_character (PP, '*')
 337 #define pp_slash(PP)            pp_character (PP, '/')
 338 #define pp_modulo(PP)           pp_character (PP, '%')
 339 #define pp_exclamation(PP)      pp_character (PP, '!')
 340 #define pp_complement(PP)       pp_character (PP, '~')
 341 #define pp_quote(PP)            pp_character (PP, '\'')
 342 #define pp_backquote(PP)        pp_character (PP, '`')
 343 #define pp_doublequote(PP)      pp_character (PP, '"')
 344 #define pp_underscore(PP)       pp_character (PP, '_')
 345 #define pp_maybe_newline_and_indent(PP, N) \
 346   if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N)
 347 #define pp_scalar(PP, FORMAT, SCALAR)                         \
 348   do                                                          \
 349     {                                                         \
 350       sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
 351       pp_string (PP, pp_buffer (PP)->digit_buffer);           \
 352     }                                                         \
 353   while (0)
 354 #define pp_decimal_int(PP, I)  pp_scalar (PP, "%d", I)
 355 #define pp_unsigned_wide_integer(PP, I) \
 356    pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I)
 357 #define pp_vrange(PP, R)                                        \
 358   do                                                            \
 359     {                                                           \
 360       vrange_printer vrange_pp (PP);                            \
 361       (R)->accept (vrange_pp);                                  \
 362     }                                                           \
 363   while (0)
 364 #define pp_double(PP, F)       pp_scalar (PP, "%f", F)
 365 #define pp_pointer(PP, P)      pp_scalar (PP, "%p", P)
 366
 367 #define pp_identifier(PP, ID)  pp_string (PP, (pp_translate_identifiers (PP) \
 368                                           ? identifier_to_locale (ID)   \
 369                                           : (ID)))
 370
 371
 372 #define pp_buffer(PP) (PP)->buffer
 373
 374 extern void pp_set_line_maximum_length (pretty_printer *, int);
 375 extern void pp_set_prefix (pretty_printer *, char *);
 376 extern char *pp_take_prefix (pretty_printer *);
 377 extern void pp_destroy_prefix (pretty_printer *);
 378 extern int pp_remaining_character_count_for_line (pretty_printer *);
 379 extern void pp_clear_output_area (pretty_printer *);
 380 extern const char *pp_formatted_text (pretty_printer *);
 381 extern const char *pp_last_position_in_text (const pretty_printer *);
 382 extern void pp_emit_prefix (pretty_printer *);
 383 extern void pp_append_text (pretty_printer *, const char *, const char *);
 384 extern void pp_newline_and_flush (pretty_printer *);
 385 extern void pp_newline_and_indent (pretty_printer *, int);
 386 extern void pp_separate_with (pretty_printer *, char);
 387
 388 /* If we haven't already defined a front-end-specific diagnostics
 389    style, use the generic one.  */
 390 #ifdef GCC_DIAG_STYLE
 391 #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE
 392 #else
 393 #define GCC_PPDIAG_STYLE __gcc_diag__
 394 #endif
 395
 396 /* This header may be included before diagnostics-core.h, hence the duplicate
 397    definitions to allow for GCC-specific formats.  */
 398 #if GCC_VERSION >= 3005
 399 #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m)
 400 #else
 401 #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m)
 402 #endif
 403 extern void pp_printf (pretty_printer *, const char *, ...)
 404      ATTRIBUTE_GCC_PPDIAG(2,3);
 405
 406 extern void pp_verbatim (pretty_printer *, const char *, ...)
 407      ATTRIBUTE_GCC_PPDIAG(2,3);
 408 extern void pp_flush (pretty_printer *);
 409 extern void pp_really_flush (pretty_printer *);
 410 extern void pp_format (pretty_printer *, text_info *,
 411                        const urlifier * = nullptr);
 412 extern void pp_output_formatted_text (pretty_printer *);
 413 extern void pp_format_verbatim (pretty_printer *, text_info *);
 414
 415 extern void pp_indent (pretty_printer *);
 416 extern void pp_newline (pretty_printer *);
 417 extern void pp_character (pretty_printer *, int);
 418 extern void pp_string (pretty_printer *, const char *);
 419 extern void pp_unicode_character (pretty_printer *, unsigned);
 420
 421 extern void pp_write_text_to_stream (pretty_printer *);
 422 extern void pp_write_text_as_dot_label_to_stream (pretty_printer *, bool);
 423 extern void pp_write_text_as_html_like_dot_to_stream (pretty_printer *pp);
 424
 425 extern void pp_maybe_space (pretty_printer *);
 426
 427 extern void pp_begin_quote (pretty_printer *, bool);
 428 extern void pp_end_quote (pretty_printer *, bool);
 429
 430 extern void pp_begin_url (pretty_printer *pp, const char *url);
 431 extern void pp_end_url (pretty_printer *pp);
 432
 433 /* Switch into verbatim mode and return the old mode.  */
 434 inline pp_wrapping_mode_t
 435 pp_set_verbatim_wrapping_ (pretty_printer *pp)
 436 {
 437   pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp);
 438   pp_line_cutoff (pp) = 0;
 439   pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER;
 440   return oldmode;
 441 }
 442 #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (PP)
 443
 444 extern const char *identifier_to_locale (const char *);
 445 extern void *(*identifier_to_locale_alloc) (size_t);
 446 extern void (*identifier_to_locale_free) (void *);
 447
 448 /* Print I to PP in decimal.  */
 449
 450 inline void
 451 pp_wide_integer (pretty_printer *pp, HOST_WIDE_INT i)
 452 {
 453   pp_scalar (pp, HOST_WIDE_INT_PRINT_DEC, i);
 454 }
 455
 456 inline void
 457 pp_wide_int (pretty_printer *pp, const wide_int_ref &w, signop sgn)
 458 {
 459   unsigned int len;
 460   print_dec_buf_size (w, sgn, &len);
 461   if (UNLIKELY (len > sizeof (pp_buffer (pp)->digit_buffer)))
 462     pp_wide_int_large (pp, w, sgn);
 463   else
 464     {
 465       print_dec (w, pp_buffer (pp)->digit_buffer, sgn);
 466       pp_string (pp, pp_buffer (pp)->digit_buffer);
 467     }
 468 }
 469
 470 template<unsigned int N, typename T>
 471 void pp_wide_integer (pretty_printer *pp, const poly_int<N, T> &);
 472
 473 #endif /* GCC_PRETTY_PRINT_H */