Daily bump.
[official-gcc.git] / gcc / pretty-print.h
blob2decc516b1f08790598913b92e7eb75cc73dd536
1 /* Various declarations for language-independent pretty-print subroutines.
2 Copyright (C) 2002-2018 Free Software Foundation, Inc.
3 Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net>
5 This file is part of GCC.
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.
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.
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/>. */
21 #ifndef GCC_PRETTY_PRINT_H
22 #define GCC_PRETTY_PRINT_H
24 #include "obstack.h"
26 /* Maximum number of format string arguments. */
27 #define PP_NL_ARGMAX 30
29 /* The type of a text to be formatted according a format specification
30 along with a list of things. */
31 struct text_info
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;
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;
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
51 DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0,
52 DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1,
53 DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
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
63 /* Pointer to previous chunk on the stack. */
64 struct chunk_info *prev;
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];
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
79 output_buffer ();
80 ~output_buffer ();
82 /* Obstack where the text is built up. */
83 struct obstack formatted_obstack;
85 /* Obstack containing a chunked representation of the format
86 specification plus arguments. */
87 struct obstack chunk_obstack;
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;
93 /* Stack of chunk arrays. These come from the chunk_obstack. */
94 struct chunk_info *cur_chunk_array;
96 /* Where to output formatted text. */
97 FILE *stream;
99 /* The amount of characters output so far. */
100 int line_length;
102 /* This must be large enough to hold any printed integer or
103 floating-point value. */
104 char digit_buffer[128];
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;
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)
117 obstack_1grow (buff->obstack, '\0');
118 return (const char *) obstack_base (buff->obstack);
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)
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++;
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)
140 const char *p = NULL;
141 struct obstack *text = buff->obstack;
143 if (obstack_base (text) != obstack_next_free (text))
144 p = ((const char *) obstack_next_free (text)) - 1;
145 return p;
149 /* The type of pretty-printer flags passed to clients. */
150 typedef unsigned int pp_flags;
152 enum pp_padding
154 pp_none, pp_before, pp_after
157 /* Structure for switching in and out of verbatim mode in a convenient
158 manner. */
159 struct pp_wrapping_mode_t
161 /* Current prefixing rule. */
162 diagnostic_prefixing_rule_t rule;
164 /* The ideal upper bound of number of characters per line, as suggested
165 by front-end. */
166 int line_cutoff;
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
173 /* Prefixing rule used in formatting a diagnostic message. */
174 #define pp_prefixing_rule(PP) (PP)->wrapping.rule
176 /* Get or set the wrapping mode as a single entity. */
177 #define pp_wrapping_mode(PP) (PP)->wrapping
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, bool *, const char **);
185 /* Client supplied function used to decode formats. */
186 #define pp_format_decoder(PP) (PP)->format_decoder
188 /* Base class for an optional client-supplied object for doing additional
189 processing between stages 2 and 3 of formatted printing. */
190 class format_postprocessor
192 public:
193 virtual ~format_postprocessor () {}
194 virtual void handle (pretty_printer *) = 0;
197 /* TRUE if a newline character needs to be added before further
198 formatting. */
199 #define pp_needs_newline(PP) (PP)->need_newline
201 /* True if PRETTY-PRINTER is in line-wrapping mode. */
202 #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0)
204 /* The amount of whitespace to be emitted when starting a new line. */
205 #define pp_indentation(PP) (PP)->indent_skip
207 /* True if identifiers are translated to the locale character set on
208 output. */
209 #define pp_translate_identifiers(PP) (PP)->translate_identifiers
211 /* True if colors should be shown. */
212 #define pp_show_color(PP) (PP)->show_color
214 /* The data structure that contains the bare minimum required to do
215 proper pretty-printing. Clients may derived from this structure
216 and add additional fields they need. */
217 struct pretty_printer
219 /* Default construct a pretty printer with specified
220 maximum line length cut off limit. */
221 explicit pretty_printer (int = 0);
223 virtual ~pretty_printer ();
225 /* Where we print external representation of ENTITY. */
226 output_buffer *buffer;
228 /* The prefix for each new line. If non-NULL, this is "owned" by the
229 pretty_printer, and will eventually be free-ed. */
230 char *prefix;
232 /* Where to put whitespace around the entity being formatted. */
233 pp_padding padding;
235 /* The real upper bound of number of characters per line, taking into
236 account the case of a very very looong prefix. */
237 int maximum_length;
239 /* Indentation count. */
240 int indent_skip;
242 /* Current wrapping mode. */
243 pp_wrapping_mode_t wrapping;
245 /* If non-NULL, this function formats a TEXT into the BUFFER. When called,
246 TEXT->format_spec points to a format code. FORMAT_DECODER should call
247 pp_string (and related functions) to add data to the BUFFER.
248 FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
249 If the BUFFER needs additional characters from the format string, it
250 should advance the TEXT->format_spec as it goes. When FORMAT_DECODER
251 returns, TEXT->format_spec should point to the last character processed.
252 The QUOTE and BUFFER_PTR are passed in, to allow for deferring-handling
253 of format codes (e.g. %H and %I in the C++ frontend). */
254 printer_fn format_decoder;
256 /* If non-NULL, this is called by pp_format once after all format codes
257 have been processed, to allow for client-specific postprocessing.
258 This is used by the C++ frontend for handling the %H and %I
259 format codes (which interract with each other). */
260 format_postprocessor *m_format_postprocessor;
262 /* Nonzero if current PREFIX was emitted at least once. */
263 bool emitted_prefix;
265 /* Nonzero means one should emit a newline before outputting anything. */
266 bool need_newline;
268 /* Nonzero means identifiers are translated to the locale character
269 set on output. */
270 bool translate_identifiers;
272 /* Nonzero means that text should be colorized. */
273 bool show_color;
276 static inline const char *
277 pp_get_prefix (const pretty_printer *pp) { return pp->prefix; }
279 #define pp_space(PP) pp_character (PP, ' ')
280 #define pp_left_paren(PP) pp_character (PP, '(')
281 #define pp_right_paren(PP) pp_character (PP, ')')
282 #define pp_left_bracket(PP) pp_character (PP, '[')
283 #define pp_right_bracket(PP) pp_character (PP, ']')
284 #define pp_left_brace(PP) pp_character (PP, '{')
285 #define pp_right_brace(PP) pp_character (PP, '}')
286 #define pp_semicolon(PP) pp_character (PP, ';')
287 #define pp_comma(PP) pp_character (PP, ',')
288 #define pp_dot(PP) pp_character (PP, '.')
289 #define pp_colon(PP) pp_character (PP, ':')
290 #define pp_colon_colon(PP) pp_string (PP, "::")
291 #define pp_arrow(PP) pp_string (PP, "->")
292 #define pp_equal(PP) pp_character (PP, '=')
293 #define pp_question(PP) pp_character (PP, '?')
294 #define pp_bar(PP) pp_character (PP, '|')
295 #define pp_bar_bar(PP) pp_string (PP, "||")
296 #define pp_carret(PP) pp_character (PP, '^')
297 #define pp_ampersand(PP) pp_character (PP, '&')
298 #define pp_ampersand_ampersand(PP) pp_string (PP, "&&")
299 #define pp_less(PP) pp_character (PP, '<')
300 #define pp_less_equal(PP) pp_string (PP, "<=")
301 #define pp_greater(PP) pp_character (PP, '>')
302 #define pp_greater_equal(PP) pp_string (PP, ">=")
303 #define pp_plus(PP) pp_character (PP, '+')
304 #define pp_minus(PP) pp_character (PP, '-')
305 #define pp_star(PP) pp_character (PP, '*')
306 #define pp_slash(PP) pp_character (PP, '/')
307 #define pp_modulo(PP) pp_character (PP, '%')
308 #define pp_exclamation(PP) pp_character (PP, '!')
309 #define pp_complement(PP) pp_character (PP, '~')
310 #define pp_quote(PP) pp_character (PP, '\'')
311 #define pp_backquote(PP) pp_character (PP, '`')
312 #define pp_doublequote(PP) pp_character (PP, '"')
313 #define pp_underscore(PP) pp_character (PP, '_')
314 #define pp_maybe_newline_and_indent(PP, N) \
315 if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N)
316 #define pp_scalar(PP, FORMAT, SCALAR) \
317 do \
319 sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
320 pp_string (PP, pp_buffer (PP)->digit_buffer); \
322 while (0)
323 #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I)
324 #define pp_unsigned_wide_integer(PP, I) \
325 pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I)
326 #define pp_wide_int(PP, W, SGN) \
327 do \
329 print_dec (W, pp_buffer (PP)->digit_buffer, SGN); \
330 pp_string (PP, pp_buffer (PP)->digit_buffer); \
332 while (0)
333 #define pp_pointer(PP, P) pp_scalar (PP, "%p", P)
335 #define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \
336 ? identifier_to_locale (ID) \
337 : (ID)))
340 #define pp_buffer(PP) (PP)->buffer
342 extern void pp_set_line_maximum_length (pretty_printer *, int);
343 extern void pp_set_prefix (pretty_printer *, char *);
344 extern char *pp_take_prefix (pretty_printer *);
345 extern void pp_destroy_prefix (pretty_printer *);
346 extern int pp_remaining_character_count_for_line (pretty_printer *);
347 extern void pp_clear_output_area (pretty_printer *);
348 extern const char *pp_formatted_text (pretty_printer *);
349 extern const char *pp_last_position_in_text (const pretty_printer *);
350 extern void pp_emit_prefix (pretty_printer *);
351 extern void pp_append_text (pretty_printer *, const char *, const char *);
352 extern void pp_newline_and_flush (pretty_printer *);
353 extern void pp_newline_and_indent (pretty_printer *, int);
354 extern void pp_separate_with (pretty_printer *, char);
356 /* If we haven't already defined a front-end-specific diagnostics
357 style, use the generic one. */
358 #ifdef GCC_DIAG_STYLE
359 #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE
360 #else
361 #define GCC_PPDIAG_STYLE __gcc_diag__
362 #endif
364 /* This header may be included before diagnostics-core.h, hence the duplicate
365 definitions to allow for GCC-specific formats. */
366 #if GCC_VERSION >= 3005
367 #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m)
368 #else
369 #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m)
370 #endif
371 extern void pp_printf (pretty_printer *, const char *, ...)
372 ATTRIBUTE_GCC_PPDIAG(2,3);
374 extern void pp_verbatim (pretty_printer *, const char *, ...)
375 ATTRIBUTE_GCC_PPDIAG(2,3);
376 extern void pp_flush (pretty_printer *);
377 extern void pp_really_flush (pretty_printer *);
378 extern void pp_format (pretty_printer *, text_info *);
379 extern void pp_output_formatted_text (pretty_printer *);
380 extern void pp_format_verbatim (pretty_printer *, text_info *);
382 extern void pp_indent (pretty_printer *);
383 extern void pp_newline (pretty_printer *);
384 extern void pp_character (pretty_printer *, int);
385 extern void pp_string (pretty_printer *, const char *);
386 extern void pp_write_text_to_stream (pretty_printer *);
387 extern void pp_write_text_as_dot_label_to_stream (pretty_printer *, bool);
388 extern void pp_maybe_space (pretty_printer *);
390 extern void pp_begin_quote (pretty_printer *, bool);
391 extern void pp_end_quote (pretty_printer *, bool);
393 /* Switch into verbatim mode and return the old mode. */
394 static inline pp_wrapping_mode_t
395 pp_set_verbatim_wrapping_ (pretty_printer *pp)
397 pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp);
398 pp_line_cutoff (pp) = 0;
399 pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER;
400 return oldmode;
402 #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (PP)
404 extern const char *identifier_to_locale (const char *);
405 extern void *(*identifier_to_locale_alloc) (size_t);
406 extern void (*identifier_to_locale_free) (void *);
408 /* Print I to PP in decimal. */
410 inline void
411 pp_wide_integer (pretty_printer *pp, HOST_WIDE_INT i)
413 pp_scalar (pp, HOST_WIDE_INT_PRINT_DEC, i);
416 template<unsigned int N, typename T>
417 void pp_wide_integer (pretty_printer *pp, const poly_int_pod<N, T> &);
419 #endif /* GCC_PRETTY_PRINT_H */