]>
Commit | Line | Data |
---|---|---|
75e76012 | 1 | /* Various declarations for language-independent pretty-print subroutines. |
fbd26352 | 2 | Copyright (C) 2002-2019 Free Software Foundation, Inc. |
75e76012 | 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 | |
8c4c00c1 | 9 | Software Foundation; either version 3, or (at your option) any later |
75e76012 | 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 | |
8c4c00c1 | 18 | along with GCC; see the file COPYING3. If not see |
19 | <http://www.gnu.org/licenses/>. */ | |
75e76012 | 20 | |
21 | #ifndef GCC_PRETTY_PRINT_H | |
22 | #define GCC_PRETTY_PRINT_H | |
23 | ||
aa6db498 | 24 | #include "obstack.h" |
aa6db498 | 25 | |
c907c5b1 | 26 | /* Maximum number of format string arguments. */ |
27 | #define PP_NL_ARGMAX 30 | |
28 | ||
aa6db498 | 29 | /* The type of a text to be formatted according a format specification |
30 | along with a list of things. */ | |
a94db6b0 | 31 | struct text_info |
aa6db498 | 32 | { |
33 | const char *format_spec; | |
34 | va_list *args_ptr; | |
35 | int err_no; /* for %m */ | |
ce084dfc | 36 | void **x_data; |
f0479000 | 37 | rich_location *m_richloc; |
389a9009 | 38 | |
5fe20025 | 39 | void set_location (unsigned int idx, location_t loc, |
40 | enum range_display_kind range_display_kind); | |
f0479000 | 41 | location_t get_location (unsigned int index_of_location) const; |
a94db6b0 | 42 | }; |
aa6db498 | 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. */ | |
a94db6b0 | 49 | enum diagnostic_prefixing_rule_t |
aa6db498 | 50 | { |
51 | DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0, | |
52 | DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1, | |
53 | DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2 | |
a94db6b0 | 54 | }; |
aa6db498 | 55 | |
c907c5b1 | 56 | /* The chunk_info data structure forms a stack of the results from the |
a94db6b0 | 57 | first phase of formatting (pp_format) which have not yet been |
58 | output (pp_output_formatted_text). A stack is necessary because | |
c907c5b1 | 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 | ||
aa6db498 | 75 | /* The output buffer datatype. This is best seen as an abstract datatype |
76 | whose fields should not be accessed directly by clients. */ | |
a94db6b0 | 77 | struct output_buffer |
aa6db498 | 78 | { |
eed6bc21 | 79 | output_buffer (); |
6f07f480 | 80 | ~output_buffer (); |
eed6bc21 | 81 | |
48e1416a | 82 | /* Obstack where the text is built up. */ |
c907c5b1 | 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; | |
aa6db498 | 95 | |
96 | /* Where to output formatted text. */ | |
97 | FILE *stream; | |
98 | ||
48e1416a | 99 | /* The amount of characters output so far. */ |
aa6db498 | 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]; | |
4166acc7 | 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; | |
a94db6b0 | 110 | }; |
75e76012 | 111 | |
716da296 | 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 | { | |
a6871bda | 126 | gcc_checking_assert (start); |
716da296 | 127 | obstack_grow (buff->obstack, start, length); |
3752e5b1 | 128 | for (int i = 0; i < length; i++) |
129 | if (start[i] == '\n') | |
130 | buff->line_length = 0; | |
131 | else | |
132 | buff->line_length++; | |
716da296 | 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 | ||
75e76012 | 149 | /* The type of pretty-printer flags passed to clients. */ |
150 | typedef unsigned int pp_flags; | |
151 | ||
a94db6b0 | 152 | enum pp_padding |
75e76012 | 153 | { |
71a36b9f | 154 | pp_none, pp_before, pp_after |
a94db6b0 | 155 | }; |
75e76012 | 156 | |
c907c5b1 | 157 | /* Structure for switching in and out of verbatim mode in a convenient |
158 | manner. */ | |
a94db6b0 | 159 | struct pp_wrapping_mode_t |
c907c5b1 | 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 | |
48e1416a | 165 | by front-end. */ |
c907c5b1 | 166 | int line_cutoff; |
a94db6b0 | 167 | }; |
c907c5b1 | 168 | |
169 | /* Maximum characters per line in automatic line wrapping mode. | |
170 | Zero means don't wrap lines. */ | |
a94db6b0 | 171 | #define pp_line_cutoff(PP) (PP)->wrapping.line_cutoff |
c907c5b1 | 172 | |
173 | /* Prefixing rule used in formatting a diagnostic message. */ | |
a94db6b0 | 174 | #define pp_prefixing_rule(PP) (PP)->wrapping.rule |
c907c5b1 | 175 | |
176 | /* Get or set the wrapping mode as a single entity. */ | |
a94db6b0 | 177 | #define pp_wrapping_mode(PP) (PP)->wrapping |
c907c5b1 | 178 | |
123ec651 | 179 | /* The type of a hook that formats client-specific data onto a pretty_printer. |
aa6db498 | 180 | A client-supplied formatter returns true if everything goes well, |
181 | otherwise it returns false. */ | |
c907c5b1 | 182 | typedef bool (*printer_fn) (pretty_printer *, text_info *, const char *, |
8e4391a5 | 183 | int, bool, bool, bool, bool *, const char **); |
aa6db498 | 184 | |
185 | /* Client supplied function used to decode formats. */ | |
a94db6b0 | 186 | #define pp_format_decoder(PP) (PP)->format_decoder |
aa6db498 | 187 | |
4d1eda3a | 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 | |
191 | { | |
192 | public: | |
193 | virtual ~format_postprocessor () {} | |
194 | virtual void handle (pretty_printer *) = 0; | |
195 | }; | |
196 | ||
aa6db498 | 197 | /* TRUE if a newline character needs to be added before further |
198 | formatting. */ | |
a94db6b0 | 199 | #define pp_needs_newline(PP) (PP)->need_newline |
aa6db498 | 200 | |
f0b5f617 | 201 | /* True if PRETTY-PRINTER is in line-wrapping mode. */ |
aa6db498 | 202 | #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0) |
203 | ||
aa6db498 | 204 | /* The amount of whitespace to be emitted when starting a new line. */ |
a94db6b0 | 205 | #define pp_indentation(PP) (PP)->indent_skip |
aa6db498 | 206 | |
a608187f | 207 | /* True if identifiers are translated to the locale character set on |
208 | output. */ | |
a94db6b0 | 209 | #define pp_translate_identifiers(PP) (PP)->translate_identifiers |
a608187f | 210 | |
41609f8b | 211 | /* True if colors should be shown. */ |
a94db6b0 | 212 | #define pp_show_color(PP) (PP)->show_color |
41609f8b | 213 | |
aa6db498 | 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. */ | |
eed6bc21 | 217 | struct pretty_printer |
75e76012 | 218 | { |
cba058c7 | 219 | /* Default construct a pretty printer with specified |
220 | maximum line length cut off limit. */ | |
221 | explicit pretty_printer (int = 0); | |
eed6bc21 | 222 | |
6f07f480 | 223 | virtual ~pretty_printer (); |
224 | ||
75e76012 | 225 | /* Where we print external representation of ENTITY. */ |
226 | output_buffer *buffer; | |
aa6db498 | 227 | |
cba058c7 | 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; | |
48e1416a | 231 | |
b38e286c | 232 | /* Where to put whitespace around the entity being formatted. */ |
233 | pp_padding padding; | |
48e1416a | 234 | |
aa6db498 | 235 | /* The real upper bound of number of characters per line, taking into |
48e1416a | 236 | account the case of a very very looong prefix. */ |
aa6db498 | 237 | int maximum_length; |
238 | ||
aa6db498 | 239 | /* Indentation count. */ |
240 | int indent_skip; | |
241 | ||
c907c5b1 | 242 | /* Current wrapping mode. */ |
243 | pp_wrapping_mode_t wrapping; | |
aa6db498 | 244 | |
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. | |
4d1eda3a | 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). */ | |
aa6db498 | 254 | printer_fn format_decoder; |
255 | ||
4d1eda3a | 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; | |
261 | ||
aa6db498 | 262 | /* Nonzero if current PREFIX was emitted at least once. */ |
263 | bool emitted_prefix; | |
264 | ||
265 | /* Nonzero means one should emit a newline before outputting anything. */ | |
266 | bool need_newline; | |
a608187f | 267 | |
268 | /* Nonzero means identifiers are translated to the locale character | |
269 | set on output. */ | |
270 | bool translate_identifiers; | |
41609f8b | 271 | |
272 | /* Nonzero means that text should be colorized. */ | |
273 | bool show_color; | |
75e76012 | 274 | }; |
275 | ||
5a983084 | 276 | static inline const char * |
a94db6b0 | 277 | pp_get_prefix (const pretty_printer *pp) { return pp->prefix; } |
0de2b732 | 278 | |
76a6451b | 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, ';') | |
dda4f0ec | 287 | #define pp_comma(PP) pp_character (PP, ',') |
76a6451b | 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, '|') | |
70d60d1d | 295 | #define pp_bar_bar(PP) pp_string (PP, "||") |
76a6451b | 296 | #define pp_carret(PP) pp_character (PP, '^') |
297 | #define pp_ampersand(PP) pp_character (PP, '&') | |
70d60d1d | 298 | #define pp_ampersand_ampersand(PP) pp_string (PP, "&&") |
76a6451b | 299 | #define pp_less(PP) pp_character (PP, '<') |
70d60d1d | 300 | #define pp_less_equal(PP) pp_string (PP, "<=") |
76a6451b | 301 | #define pp_greater(PP) pp_character (PP, '>') |
70d60d1d | 302 | #define pp_greater_equal(PP) pp_string (PP, ">=") |
76a6451b | 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, '"') | |
dda4f0ec | 313 | #define pp_underscore(PP) pp_character (PP, '_') |
c10de5e7 | 314 | #define pp_maybe_newline_and_indent(PP, N) \ |
315 | if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N) | |
76a6451b | 316 | #define pp_scalar(PP, FORMAT, SCALAR) \ |
317 | do \ | |
318 | { \ | |
319 | sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \ | |
320 | pp_string (PP, pp_buffer (PP)->digit_buffer); \ | |
321 | } \ | |
aa6db498 | 322 | while (0) |
323 | #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I) | |
d066d69a | 324 | #define pp_unsigned_wide_integer(PP, I) \ |
325 | pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I) | |
6b409616 | 326 | #define pp_wide_int(PP, W, SGN) \ |
327 | do \ | |
328 | { \ | |
329 | print_dec (W, pp_buffer (PP)->digit_buffer, SGN); \ | |
330 | pp_string (PP, pp_buffer (PP)->digit_buffer); \ | |
331 | } \ | |
332 | while (0) | |
e75dc1cb | 333 | #define pp_double(PP, F) pp_scalar (PP, "%f", F) |
aa6db498 | 334 | #define pp_pointer(PP, P) pp_scalar (PP, "%p", P) |
75e76012 | 335 | |
a608187f | 336 | #define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \ |
337 | ? identifier_to_locale (ID) \ | |
338 | : (ID))) | |
71a36b9f | 339 | |
aa6db498 | 340 | |
a94db6b0 | 341 | #define pp_buffer(PP) (PP)->buffer |
aa6db498 | 342 | |
a94db6b0 | 343 | extern void pp_set_line_maximum_length (pretty_printer *, int); |
cba058c7 | 344 | extern void pp_set_prefix (pretty_printer *, char *); |
345 | extern char *pp_take_prefix (pretty_printer *); | |
a94db6b0 | 346 | extern void pp_destroy_prefix (pretty_printer *); |
347 | extern int pp_remaining_character_count_for_line (pretty_printer *); | |
348 | extern void pp_clear_output_area (pretty_printer *); | |
349 | extern const char *pp_formatted_text (pretty_printer *); | |
350 | extern const char *pp_last_position_in_text (const pretty_printer *); | |
351 | extern void pp_emit_prefix (pretty_printer *); | |
352 | extern void pp_append_text (pretty_printer *, const char *, const char *); | |
b8ab5fbc | 353 | extern void pp_newline_and_flush (pretty_printer *); |
354 | extern void pp_newline_and_indent (pretty_printer *, int); | |
355 | extern void pp_separate_with (pretty_printer *, char); | |
eb586f2c | 356 | |
1ea9269b | 357 | /* If we haven't already defined a front-end-specific diagnostics |
358 | style, use the generic one. */ | |
359 | #ifdef GCC_DIAG_STYLE | |
360 | #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE | |
361 | #else | |
362 | #define GCC_PPDIAG_STYLE __gcc_diag__ | |
363 | #endif | |
364 | ||
0b205f4c | 365 | /* This header may be included before diagnostics-core.h, hence the duplicate |
eb586f2c | 366 | definitions to allow for GCC-specific formats. */ |
367 | #if GCC_VERSION >= 3005 | |
1ea9269b | 368 | #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m) |
eb586f2c | 369 | #else |
370 | #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m) | |
371 | #endif | |
372 | extern void pp_printf (pretty_printer *, const char *, ...) | |
373 | ATTRIBUTE_GCC_PPDIAG(2,3); | |
374 | ||
a208cd0d | 375 | extern void pp_verbatim (pretty_printer *, const char *, ...) |
376 | ATTRIBUTE_GCC_PPDIAG(2,3); | |
a94db6b0 | 377 | extern void pp_flush (pretty_printer *); |
4166acc7 | 378 | extern void pp_really_flush (pretty_printer *); |
a94db6b0 | 379 | extern void pp_format (pretty_printer *, text_info *); |
380 | extern void pp_output_formatted_text (pretty_printer *); | |
381 | extern void pp_format_verbatim (pretty_printer *, text_info *); | |
382 | ||
383 | extern void pp_indent (pretty_printer *); | |
384 | extern void pp_newline (pretty_printer *); | |
385 | extern void pp_character (pretty_printer *, int); | |
386 | extern void pp_string (pretty_printer *, const char *); | |
3d9a4504 | 387 | extern void pp_write_text_to_stream (pretty_printer *); |
388 | extern void pp_write_text_as_dot_label_to_stream (pretty_printer *, bool); | |
a94db6b0 | 389 | extern void pp_maybe_space (pretty_printer *); |
aa6db498 | 390 | |
8e4391a5 | 391 | extern void pp_begin_quote (pretty_printer *, bool); |
392 | extern void pp_end_quote (pretty_printer *, bool); | |
393 | ||
c907c5b1 | 394 | /* Switch into verbatim mode and return the old mode. */ |
395 | static inline pp_wrapping_mode_t | |
396 | pp_set_verbatim_wrapping_ (pretty_printer *pp) | |
397 | { | |
398 | pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp); | |
399 | pp_line_cutoff (pp) = 0; | |
400 | pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER; | |
401 | return oldmode; | |
402 | } | |
a94db6b0 | 403 | #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (PP) |
c907c5b1 | 404 | |
27746e01 | 405 | extern const char *identifier_to_locale (const char *); |
ddcdd2ab | 406 | extern void *(*identifier_to_locale_alloc) (size_t); |
407 | extern void (*identifier_to_locale_free) (void *); | |
27746e01 | 408 | |
28eeb147 | 409 | /* Print I to PP in decimal. */ |
410 | ||
411 | inline void | |
412 | pp_wide_integer (pretty_printer *pp, HOST_WIDE_INT i) | |
413 | { | |
414 | pp_scalar (pp, HOST_WIDE_INT_PRINT_DEC, i); | |
415 | } | |
416 | ||
417 | template<unsigned int N, typename T> | |
418 | void pp_wide_integer (pretty_printer *pp, const poly_int_pod<N, T> &); | |
419 | ||
75e76012 | 420 | #endif /* GCC_PRETTY_PRINT_H */ |