gcc/pretty-print.h

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