gcc/pretty-print.h

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