gcc/pretty-print.h

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