gcc/pretty-print.h

   1 /* Various declarations for language-independent pretty-print subroutines.
   2    Copyright (C) 2002-2013 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 "input.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   location_t *locus;
  38   void **x_data;
  39 };
  40
  41 /* How often diagnostics are prefixed by their locations:
  42    o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
  43    o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
  44    o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
  45    line is started.  */
  46 enum diagnostic_prefixing_rule_t
  47 {
  48   DIAGNOSTICS_SHOW_PREFIX_ONCE       = 0x0,
  49   DIAGNOSTICS_SHOW_PREFIX_NEVER      = 0x1,
  50   DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
  51 };
  52
  53 /* The chunk_info data structure forms a stack of the results from the
  54    first phase of formatting (pp_format) which have not yet been
  55    output (pp_output_formatted_text).  A stack is necessary because
  56    the diagnostic starter may decide to generate its own output by way
  57    of the formatter.  */
  58 struct chunk_info
  59 {
  60   /* Pointer to previous chunk on the stack.  */
  61   struct chunk_info *prev;
  62
  63   /* Array of chunks to output.  Each chunk is a NUL-terminated string.
  64      In the first phase of formatting, even-numbered chunks are
  65      to be output verbatim, odd-numbered chunks are format specifiers.
  66      The second phase replaces all odd-numbered chunks with formatted
  67      text, and the third phase simply emits all the chunks in sequence
  68      with appropriate line-wrapping.  */
  69   const char *args[PP_NL_ARGMAX * 2];
  70 };
  71
  72 /* The output buffer datatype.  This is best seen as an abstract datatype
  73    whose fields should not be accessed directly by clients.  */
  74 struct output_buffer
  75 {
  76   output_buffer ();
  77
  78   /* Obstack where the text is built up.  */
  79   struct obstack formatted_obstack;
  80
  81   /* Obstack containing a chunked representation of the format
  82      specification plus arguments.  */
  83   struct obstack chunk_obstack;
  84
  85   /* Currently active obstack: one of the above two.  This is used so
  86      that the text formatters don't need to know which phase we're in.  */
  87   struct obstack *obstack;
  88
  89   /* Stack of chunk arrays.  These come from the chunk_obstack.  */
  90   struct chunk_info *cur_chunk_array;
  91
  92   /* Where to output formatted text.  */
  93   FILE *stream;
  94
  95   /* The amount of characters output so far.  */
  96   int line_length;
  97
  98   /* This must be large enough to hold any printed integer or
  99      floating-point value.  */
 100   char digit_buffer[128];
 101 };
 102
 103 /* The type of pretty-printer flags passed to clients.  */
 104 typedef unsigned int pp_flags;
 105
 106 enum pp_padding
 107 {
 108   pp_none, pp_before, pp_after
 109 };
 110
 111 /* Structure for switching in and out of verbatim mode in a convenient
 112    manner.  */
 113 struct pp_wrapping_mode_t
 114 {
 115   /* Current prefixing rule.  */
 116   diagnostic_prefixing_rule_t rule;
 117
 118   /* The ideal upper bound of number of characters per line, as suggested
 119      by front-end.  */
 120   int line_cutoff;
 121 };
 122
 123 /* Maximum characters per line in automatic line wrapping mode.
 124    Zero means don't wrap lines.  */
 125 #define pp_line_cutoff(PP)  (PP)->wrapping.line_cutoff
 126
 127 /* Prefixing rule used in formatting a diagnostic message.  */
 128 #define pp_prefixing_rule(PP)  (PP)->wrapping.rule
 129
 130 /* Get or set the wrapping mode as a single entity.  */
 131 #define pp_wrapping_mode(PP) (PP)->wrapping
 132
 133 /* The type of a hook that formats client-specific data onto a pretty_pinter.
 134    A client-supplied formatter returns true if everything goes well,
 135    otherwise it returns false.  */
 136 typedef bool (*printer_fn) (pretty_printer *, text_info *, const char *,
 137                             int, bool, bool, bool);
 138
 139 /* Client supplied function used to decode formats.  */
 140 #define pp_format_decoder(PP) (PP)->format_decoder
 141
 142 /* TRUE if a newline character needs to be added before further
 143    formatting.  */
 144 #define pp_needs_newline(PP)  (PP)->need_newline
 145
 146 /* True if PRETTY-PRINTER is in line-wrapping mode.  */
 147 #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0)
 148
 149 /* The amount of whitespace to be emitted when starting a new line.  */
 150 #define pp_indentation(PP) (PP)->indent_skip
 151
 152 /* True if identifiers are translated to the locale character set on
 153    output.  */
 154 #define pp_translate_identifiers(PP) (PP)->translate_identifiers
 155
 156 /* True if colors should be shown.  */
 157 #define pp_show_color(PP) (PP)->show_color
 158
 159 /* The data structure that contains the bare minimum required to do
 160    proper pretty-printing.  Clients may derived from this structure
 161    and add additional fields they need.  */
 162 struct pretty_printer
 163 {
 164   // Default construct a pretty printer with specified prefix
 165   // and a maximum line length cut off limit.
 166   explicit pretty_printer (const char* = NULL, int = 0);
 167
 168   /* Where we print external representation of ENTITY.  */
 169   output_buffer *buffer;
 170
 171   /* The prefix for each new line.  */
 172   const char *prefix;
 173
 174   /* Where to put whitespace around the entity being formatted.  */
 175   pp_padding padding;
 176
 177   /* The real upper bound of number of characters per line, taking into
 178      account the case of a very very looong prefix.  */
 179   int maximum_length;
 180
 181   /* Indentation count.  */
 182   int indent_skip;
 183
 184   /* Current wrapping mode.  */
 185   pp_wrapping_mode_t wrapping;
 186
 187   /* If non-NULL, this function formats a TEXT into the BUFFER.  When called,
 188      TEXT->format_spec points to a format code.  FORMAT_DECODER should call
 189      pp_string (and related functions) to add data to the BUFFER.
 190      FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
 191      If the BUFFER needs additional characters from the format string, it
 192      should advance the TEXT->format_spec as it goes.  When FORMAT_DECODER
 193      returns, TEXT->format_spec should point to the last character processed.
 194   */
 195   printer_fn format_decoder;
 196
 197   /* Nonzero if current PREFIX was emitted at least once.  */
 198   bool emitted_prefix;
 199
 200   /* Nonzero means one should emit a newline before outputting anything.  */
 201   bool need_newline;
 202
 203   /* Nonzero means identifiers are translated to the locale character
 204      set on output.  */
 205   bool translate_identifiers;
 206
 207   /* Nonzero means that text should be colorized.  */
 208   bool show_color;
 209 };
 210
 211 static inline const char *
 212 pp_get_prefix (const pretty_printer *pp) { return pp->prefix; }
 213
 214 #define pp_space(PP)            pp_character (PP, ' ')
 215 #define pp_left_paren(PP)       pp_character (PP, '(')
 216 #define pp_right_paren(PP)      pp_character (PP, ')')
 217 #define pp_left_bracket(PP)     pp_character (PP, '[')
 218 #define pp_right_bracket(PP)    pp_character (PP, ']')
 219 #define pp_left_brace(PP)       pp_character (PP, '{')
 220 #define pp_right_brace(PP)      pp_character (PP, '}')
 221 #define pp_semicolon(PP)        pp_character (PP, ';')
 222 #define pp_comma(PP)            pp_character (PP, ',')
 223 #define pp_dot(PP)              pp_character (PP, '.')
 224 #define pp_colon(PP)            pp_character (PP, ':')
 225 #define pp_colon_colon(PP)      pp_string (PP, "::")
 226 #define pp_arrow(PP)            pp_string (PP, "->")
 227 #define pp_equal(PP)            pp_character (PP, '=')
 228 #define pp_question(PP)         pp_character (PP, '?')
 229 #define pp_bar(PP)              pp_character (PP, '|')
 230 #define pp_bar_bar(PP)          pp_string (PP, "||")
 231 #define pp_carret(PP)           pp_character (PP, '^')
 232 #define pp_ampersand(PP)        pp_character (PP, '&')
 233 #define pp_ampersand_ampersand(PP) pp_string (PP, "&&")
 234 #define pp_less(PP)             pp_character (PP, '<')
 235 #define pp_less_equal(PP)       pp_string (PP, "<=")
 236 #define pp_greater(PP)          pp_character (PP, '>')
 237 #define pp_greater_equal(PP)    pp_string (PP, ">=")
 238 #define pp_plus(PP)             pp_character (PP, '+')
 239 #define pp_minus(PP)            pp_character (PP, '-')
 240 #define pp_star(PP)             pp_character (PP, '*')
 241 #define pp_slash(PP)            pp_character (PP, '/')
 242 #define pp_modulo(PP)           pp_character (PP, '%')
 243 #define pp_exclamation(PP)      pp_character (PP, '!')
 244 #define pp_complement(PP)       pp_character (PP, '~')
 245 #define pp_quote(PP)            pp_character (PP, '\'')
 246 #define pp_backquote(PP)        pp_character (PP, '`')
 247 #define pp_doublequote(PP)      pp_character (PP, '"')
 248 #define pp_underscore(PP)       pp_character (PP, '_')
 249 #define pp_maybe_newline_and_indent(PP, N) \
 250   if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N)
 251 #define pp_scalar(PP, FORMAT, SCALAR)                         \
 252   do                                                          \
 253     {                                                         \
 254       sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
 255       pp_string (PP, pp_buffer (PP)->digit_buffer);           \
 256     }                                                         \
 257   while (0)
 258 #define pp_decimal_int(PP, I)  pp_scalar (PP, "%d", I)
 259 #define pp_unsigned_wide_integer(PP, I) \
 260    pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I)
 261 #define pp_wide_integer(PP, I) \
 262    pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I)
 263 #define pp_widest_integer(PP, I) \
 264    pp_scalar (PP, HOST_WIDEST_INT_PRINT_DEC, (HOST_WIDEST_INT) I)
 265 #define pp_pointer(PP, P)      pp_scalar (PP, "%p", P)
 266
 267 #define pp_identifier(PP, ID)  pp_string (PP, (pp_translate_identifiers (PP) \
 268                                           ? identifier_to_locale (ID)   \
 269                                           : (ID)))
 270
 271
 272 #define pp_buffer(PP) (PP)->buffer
 273
 274 extern void pp_set_line_maximum_length (pretty_printer *, int);
 275 extern void pp_set_prefix (pretty_printer *, const char *);
 276 extern void pp_destroy_prefix (pretty_printer *);
 277 extern int pp_remaining_character_count_for_line (pretty_printer *);
 278 extern void pp_clear_output_area (pretty_printer *);
 279 extern const char *pp_formatted_text (pretty_printer *);
 280 extern const char *pp_last_position_in_text (const pretty_printer *);
 281 extern void pp_emit_prefix (pretty_printer *);
 282 extern void pp_append_text (pretty_printer *, const char *, const char *);
 283 extern void pp_newline_and_flush (pretty_printer *);
 284 extern void pp_newline_and_indent (pretty_printer *, int);
 285 extern void pp_separate_with (pretty_printer *, char);
 286
 287 /* If we haven't already defined a front-end-specific diagnostics
 288    style, use the generic one.  */
 289 #ifdef GCC_DIAG_STYLE
 290 #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE
 291 #else
 292 #define GCC_PPDIAG_STYLE __gcc_diag__
 293 #endif
 294
 295 /* This header may be included before diagnostics-core.h, hence the duplicate
 296    definitions to allow for GCC-specific formats.  */
 297 #if GCC_VERSION >= 3005
 298 #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m)
 299 #else
 300 #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m)
 301 #endif
 302 extern void pp_printf (pretty_printer *, const char *, ...)
 303      ATTRIBUTE_GCC_PPDIAG(2,3);
 304
 305 extern void pp_verbatim (pretty_printer *, const char *, ...)
 306      ATTRIBUTE_GCC_PPDIAG(2,3);
 307 extern void pp_flush (pretty_printer *);
 308 extern void pp_format (pretty_printer *, text_info *);
 309 extern void pp_output_formatted_text (pretty_printer *);
 310 extern void pp_format_verbatim (pretty_printer *, text_info *);
 311
 312 extern void pp_indent (pretty_printer *);
 313 extern void pp_newline (pretty_printer *);
 314 extern void pp_character (pretty_printer *, int);
 315 extern void pp_string (pretty_printer *, const char *);
 316 extern void pp_write_text_to_stream (pretty_printer *);
 317 extern void pp_write_text_as_dot_label_to_stream (pretty_printer *, bool);
 318 extern void pp_maybe_space (pretty_printer *);
 319
 320 /* Switch into verbatim mode and return the old mode.  */
 321 static inline pp_wrapping_mode_t
 322 pp_set_verbatim_wrapping_ (pretty_printer *pp)
 323 {
 324   pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp);
 325   pp_line_cutoff (pp) = 0;
 326   pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER;
 327   return oldmode;
 328 }
 329 #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (PP)
 330
 331 extern const char *identifier_to_locale (const char *);
 332 extern void *(*identifier_to_locale_alloc) (size_t);
 333 extern void (*identifier_to_locale_free) (void *);
 334
 335 #endif /* GCC_PRETTY_PRINT_H */