]>
Commit | Line | Data |
---|---|---|
75e76012 | 1 | /* Various declarations for language-independent pretty-print subroutines. |
711789cc | 2 | Copyright (C) 2002-2013 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" |
25 | #include "input.h" | |
26 | ||
c907c5b1 | 27 | /* Maximum number of format string arguments. */ |
28 | #define PP_NL_ARGMAX 30 | |
29 | ||
aa6db498 | 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 */ | |
c907c5b1 | 37 | location_t *locus; |
ce084dfc | 38 | void **x_data; |
aa6db498 | 39 | } text_info; |
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 | typedef enum | |
47 | { | |
48 | DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0, | |
49 | DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1, | |
50 | DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2 | |
51 | } diagnostic_prefixing_rule_t; | |
52 | ||
c907c5b1 | 53 | /* The chunk_info data structure forms a stack of the results from the |
54 | first phase of formatting (pp_base_format) which have not yet been | |
55 | output (pp_base_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 | ||
aa6db498 | 72 | /* The output buffer datatype. This is best seen as an abstract datatype |
73 | whose fields should not be accessed directly by clients. */ | |
48e1416a | 74 | typedef struct |
aa6db498 | 75 | { |
48e1416a | 76 | /* Obstack where the text is built up. */ |
c907c5b1 | 77 | struct obstack formatted_obstack; |
78 | ||
79 | /* Obstack containing a chunked representation of the format | |
80 | specification plus arguments. */ | |
81 | struct obstack chunk_obstack; | |
82 | ||
83 | /* Currently active obstack: one of the above two. This is used so | |
84 | that the text formatters don't need to know which phase we're in. */ | |
85 | struct obstack *obstack; | |
86 | ||
87 | /* Stack of chunk arrays. These come from the chunk_obstack. */ | |
88 | struct chunk_info *cur_chunk_array; | |
aa6db498 | 89 | |
90 | /* Where to output formatted text. */ | |
91 | FILE *stream; | |
92 | ||
48e1416a | 93 | /* The amount of characters output so far. */ |
aa6db498 | 94 | int line_length; |
95 | ||
96 | /* This must be large enough to hold any printed integer or | |
97 | floating-point value. */ | |
98 | char digit_buffer[128]; | |
99 | } output_buffer; | |
75e76012 | 100 | |
75e76012 | 101 | /* The type of pretty-printer flags passed to clients. */ |
102 | typedef unsigned int pp_flags; | |
103 | ||
b38e286c | 104 | typedef enum |
75e76012 | 105 | { |
71a36b9f | 106 | pp_none, pp_before, pp_after |
b38e286c | 107 | } pp_padding; |
75e76012 | 108 | |
c907c5b1 | 109 | /* Structure for switching in and out of verbatim mode in a convenient |
110 | manner. */ | |
111 | typedef struct | |
112 | { | |
113 | /* Current prefixing rule. */ | |
114 | diagnostic_prefixing_rule_t rule; | |
115 | ||
116 | /* The ideal upper bound of number of characters per line, as suggested | |
48e1416a | 117 | by front-end. */ |
c907c5b1 | 118 | int line_cutoff; |
119 | } pp_wrapping_mode_t; | |
120 | ||
121 | /* Maximum characters per line in automatic line wrapping mode. | |
122 | Zero means don't wrap lines. */ | |
123 | #define pp_line_cutoff(PP) pp_base (PP)->wrapping.line_cutoff | |
124 | ||
125 | /* Prefixing rule used in formatting a diagnostic message. */ | |
126 | #define pp_prefixing_rule(PP) pp_base (PP)->wrapping.rule | |
127 | ||
128 | /* Get or set the wrapping mode as a single entity. */ | |
129 | #define pp_wrapping_mode(PP) pp_base (PP)->wrapping | |
130 | ||
aa6db498 | 131 | /* The type of a hook that formats client-specific data onto a pretty_pinter. |
132 | A client-supplied formatter returns true if everything goes well, | |
133 | otherwise it returns false. */ | |
c907c5b1 | 134 | typedef bool (*printer_fn) (pretty_printer *, text_info *, const char *, |
135 | int, bool, bool, bool); | |
aa6db498 | 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. */ | |
48e1416a | 142 | #define pp_needs_newline(PP) pp_base (PP)->need_newline |
aa6db498 | 143 | |
f0b5f617 | 144 | /* True if PRETTY-PRINTER is in line-wrapping mode. */ |
aa6db498 | 145 | #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0) |
146 | ||
aa6db498 | 147 | /* The amount of whitespace to be emitted when starting a new line. */ |
148 | #define pp_indentation(PP) pp_base (PP)->indent_skip | |
149 | ||
a608187f | 150 | /* True if identifiers are translated to the locale character set on |
151 | output. */ | |
152 | #define pp_translate_identifiers(PP) pp_base (PP)->translate_identifiers | |
153 | ||
41609f8b | 154 | /* True if colors should be shown. */ |
155 | #define pp_show_color(PP) pp_base (PP)->show_color | |
156 | ||
aa6db498 | 157 | /* The data structure that contains the bare minimum required to do |
158 | proper pretty-printing. Clients may derived from this structure | |
159 | and add additional fields they need. */ | |
75e76012 | 160 | struct pretty_print_info |
161 | { | |
75e76012 | 162 | /* Where we print external representation of ENTITY. */ |
163 | output_buffer *buffer; | |
aa6db498 | 164 | |
165 | /* The prefix for each new line. */ | |
166 | const char *prefix; | |
48e1416a | 167 | |
b38e286c | 168 | /* Where to put whitespace around the entity being formatted. */ |
169 | pp_padding padding; | |
48e1416a | 170 | |
aa6db498 | 171 | /* The real upper bound of number of characters per line, taking into |
48e1416a | 172 | account the case of a very very looong prefix. */ |
aa6db498 | 173 | int maximum_length; |
174 | ||
aa6db498 | 175 | /* Indentation count. */ |
176 | int indent_skip; | |
177 | ||
c907c5b1 | 178 | /* Current wrapping mode. */ |
179 | pp_wrapping_mode_t wrapping; | |
aa6db498 | 180 | |
181 | /* If non-NULL, this function formats a TEXT into the BUFFER. When called, | |
182 | TEXT->format_spec points to a format code. FORMAT_DECODER should call | |
183 | pp_string (and related functions) to add data to the BUFFER. | |
184 | FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG. | |
185 | If the BUFFER needs additional characters from the format string, it | |
186 | should advance the TEXT->format_spec as it goes. When FORMAT_DECODER | |
187 | returns, TEXT->format_spec should point to the last character processed. | |
188 | */ | |
189 | printer_fn format_decoder; | |
190 | ||
191 | /* Nonzero if current PREFIX was emitted at least once. */ | |
192 | bool emitted_prefix; | |
193 | ||
194 | /* Nonzero means one should emit a newline before outputting anything. */ | |
195 | bool need_newline; | |
a608187f | 196 | |
197 | /* Nonzero means identifiers are translated to the locale character | |
198 | set on output. */ | |
199 | bool translate_identifiers; | |
41609f8b | 200 | |
201 | /* Nonzero means that text should be colorized. */ | |
202 | bool show_color; | |
75e76012 | 203 | }; |
204 | ||
0de2b732 | 205 | #define pp_set_line_maximum_length(PP, L) \ |
206 | pp_base_set_line_maximum_length (pp_base (PP), L) | |
207 | #define pp_set_prefix(PP, P) pp_base_set_prefix (pp_base (PP), P) | |
5a983084 | 208 | #define pp_get_prefix(PP) pp_base_get_prefix (pp_base (PP)) |
209 | static inline const char * | |
210 | pp_base_get_prefix (const pretty_printer *pp) { return pp->prefix; } | |
0de2b732 | 211 | #define pp_destroy_prefix(PP) pp_base_destroy_prefix (pp_base (PP)) |
212 | #define pp_remaining_character_count_for_line(PP) \ | |
213 | pp_base_remaining_character_count_for_line (pp_base (PP)) | |
214 | #define pp_clear_output_area(PP) \ | |
215 | pp_base_clear_output_area (pp_base (PP)) | |
216 | #define pp_formatted_text(PP) pp_base_formatted_text (pp_base (PP)) | |
217 | #define pp_last_position_in_text(PP) \ | |
218 | pp_base_last_position_in_text (pp_base (PP)) | |
219 | #define pp_emit_prefix(PP) pp_base_emit_prefix (pp_base (PP)) | |
220 | #define pp_append_text(PP, B, E) \ | |
221 | pp_base_append_text (pp_base (PP), B, E) | |
222 | #define pp_flush(PP) pp_base_flush (pp_base (PP)) | |
c907c5b1 | 223 | #define pp_format(PP, TI) pp_base_format (pp_base (PP), TI) |
224 | #define pp_output_formatted_text(PP) \ | |
225 | pp_base_output_formatted_text (pp_base (PP)) | |
0de2b732 | 226 | #define pp_format_verbatim(PP, TI) \ |
227 | pp_base_format_verbatim (pp_base (PP), TI) | |
228 | ||
76a6451b | 229 | #define pp_character(PP, C) pp_base_character (pp_base (PP), C) |
230 | #define pp_string(PP, S) pp_base_string (pp_base (PP), S) | |
231 | #define pp_newline(PP) pp_base_newline (pp_base (PP)) | |
0de2b732 | 232 | |
76a6451b | 233 | #define pp_space(PP) pp_character (PP, ' ') |
234 | #define pp_left_paren(PP) pp_character (PP, '(') | |
235 | #define pp_right_paren(PP) pp_character (PP, ')') | |
236 | #define pp_left_bracket(PP) pp_character (PP, '[') | |
237 | #define pp_right_bracket(PP) pp_character (PP, ']') | |
238 | #define pp_left_brace(PP) pp_character (PP, '{') | |
239 | #define pp_right_brace(PP) pp_character (PP, '}') | |
240 | #define pp_semicolon(PP) pp_character (PP, ';') | |
dda4f0ec | 241 | #define pp_comma(PP) pp_character (PP, ',') |
76a6451b | 242 | #define pp_dot(PP) pp_character (PP, '.') |
243 | #define pp_colon(PP) pp_character (PP, ':') | |
244 | #define pp_colon_colon(PP) pp_string (PP, "::") | |
245 | #define pp_arrow(PP) pp_string (PP, "->") | |
246 | #define pp_equal(PP) pp_character (PP, '=') | |
247 | #define pp_question(PP) pp_character (PP, '?') | |
248 | #define pp_bar(PP) pp_character (PP, '|') | |
70d60d1d | 249 | #define pp_bar_bar(PP) pp_string (PP, "||") |
76a6451b | 250 | #define pp_carret(PP) pp_character (PP, '^') |
251 | #define pp_ampersand(PP) pp_character (PP, '&') | |
70d60d1d | 252 | #define pp_ampersand_ampersand(PP) pp_string (PP, "&&") |
76a6451b | 253 | #define pp_less(PP) pp_character (PP, '<') |
70d60d1d | 254 | #define pp_less_equal(PP) pp_string (PP, "<=") |
76a6451b | 255 | #define pp_greater(PP) pp_character (PP, '>') |
70d60d1d | 256 | #define pp_greater_equal(PP) pp_string (PP, ">=") |
76a6451b | 257 | #define pp_plus(PP) pp_character (PP, '+') |
258 | #define pp_minus(PP) pp_character (PP, '-') | |
259 | #define pp_star(PP) pp_character (PP, '*') | |
260 | #define pp_slash(PP) pp_character (PP, '/') | |
261 | #define pp_modulo(PP) pp_character (PP, '%') | |
262 | #define pp_exclamation(PP) pp_character (PP, '!') | |
263 | #define pp_complement(PP) pp_character (PP, '~') | |
264 | #define pp_quote(PP) pp_character (PP, '\'') | |
265 | #define pp_backquote(PP) pp_character (PP, '`') | |
266 | #define pp_doublequote(PP) pp_character (PP, '"') | |
dda4f0ec | 267 | #define pp_underscore(PP) pp_character (PP, '_') |
5f7f600e | 268 | #define pp_newline_and_flush(PP) \ |
269 | do { \ | |
270 | pp_newline (PP); \ | |
271 | pp_flush (PP); \ | |
272 | pp_needs_newline (PP) = false; \ | |
273 | } while (0) | |
aa6db498 | 274 | #define pp_newline_and_indent(PP, N) \ |
275 | do { \ | |
276 | pp_indentation (PP) += N; \ | |
277 | pp_newline (PP); \ | |
bfdec0d1 | 278 | pp_base_indent (pp_base (PP)); \ |
279 | pp_needs_newline (PP) = false; \ | |
b38e286c | 280 | } while (0) |
c10de5e7 | 281 | #define pp_maybe_newline_and_indent(PP, N) \ |
282 | if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N) | |
69cb846f | 283 | #define pp_maybe_space(PP) pp_base_maybe_space (pp_base (PP)) |
aa6db498 | 284 | #define pp_separate_with(PP, C) \ |
285 | do { \ | |
76a6451b | 286 | pp_character (PP, C); \ |
aa6db498 | 287 | pp_space (PP); \ |
b38e286c | 288 | } while (0) |
76a6451b | 289 | #define pp_scalar(PP, FORMAT, SCALAR) \ |
290 | do \ | |
291 | { \ | |
292 | sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \ | |
293 | pp_string (PP, pp_buffer (PP)->digit_buffer); \ | |
294 | } \ | |
aa6db498 | 295 | while (0) |
296 | #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I) | |
d066d69a | 297 | #define pp_unsigned_wide_integer(PP, I) \ |
298 | pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I) | |
aa6db498 | 299 | #define pp_wide_integer(PP, I) \ |
300 | pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I) | |
327a38c3 | 301 | #define pp_widest_integer(PP, I) \ |
302 | pp_scalar (PP, HOST_WIDEST_INT_PRINT_DEC, (HOST_WIDEST_INT) I) | |
aa6db498 | 303 | #define pp_pointer(PP, P) pp_scalar (PP, "%p", P) |
75e76012 | 304 | |
a608187f | 305 | #define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \ |
306 | ? identifier_to_locale (ID) \ | |
307 | : (ID))) | |
71a36b9f | 308 | |
aa6db498 | 309 | |
76a6451b | 310 | #define pp_buffer(PP) pp_base (PP)->buffer |
aa6db498 | 311 | /* Clients that directly derive from pretty_printer need to override |
40e55fbb | 312 | this macro to return a pointer to the base pretty_printer structure. */ |
aa6db498 | 313 | #define pp_base(PP) (PP) |
314 | ||
315 | extern void pp_construct (pretty_printer *, const char *, int); | |
0de2b732 | 316 | extern void pp_base_set_line_maximum_length (pretty_printer *, int); |
317 | extern void pp_base_set_prefix (pretty_printer *, const char *); | |
318 | extern void pp_base_destroy_prefix (pretty_printer *); | |
319 | extern int pp_base_remaining_character_count_for_line (pretty_printer *); | |
320 | extern void pp_base_clear_output_area (pretty_printer *); | |
321 | extern const char *pp_base_formatted_text (pretty_printer *); | |
322 | extern const char *pp_base_last_position_in_text (const pretty_printer *); | |
323 | extern void pp_base_emit_prefix (pretty_printer *); | |
324 | extern void pp_base_append_text (pretty_printer *, const char *, const char *); | |
eb586f2c | 325 | |
1ea9269b | 326 | /* If we haven't already defined a front-end-specific diagnostics |
327 | style, use the generic one. */ | |
328 | #ifdef GCC_DIAG_STYLE | |
329 | #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE | |
330 | #else | |
331 | #define GCC_PPDIAG_STYLE __gcc_diag__ | |
332 | #endif | |
333 | ||
0b205f4c | 334 | /* This header may be included before diagnostics-core.h, hence the duplicate |
eb586f2c | 335 | definitions to allow for GCC-specific formats. */ |
336 | #if GCC_VERSION >= 3005 | |
1ea9269b | 337 | #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m) |
eb586f2c | 338 | #else |
339 | #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m) | |
340 | #endif | |
341 | extern void pp_printf (pretty_printer *, const char *, ...) | |
342 | ATTRIBUTE_GCC_PPDIAG(2,3); | |
343 | ||
a208cd0d | 344 | extern void pp_verbatim (pretty_printer *, const char *, ...) |
345 | ATTRIBUTE_GCC_PPDIAG(2,3); | |
0de2b732 | 346 | extern void pp_base_flush (pretty_printer *); |
c907c5b1 | 347 | extern void pp_base_format (pretty_printer *, text_info *); |
348 | extern void pp_base_output_formatted_text (pretty_printer *); | |
0de2b732 | 349 | extern void pp_base_format_verbatim (pretty_printer *, text_info *); |
aa6db498 | 350 | |
bfdec0d1 | 351 | extern void pp_base_indent (pretty_printer *); |
76a6451b | 352 | extern void pp_base_newline (pretty_printer *); |
353 | extern void pp_base_character (pretty_printer *, int); | |
354 | extern void pp_base_string (pretty_printer *, const char *); | |
3d9a4504 | 355 | extern void pp_write_text_to_stream (pretty_printer *); |
356 | extern void pp_write_text_as_dot_label_to_stream (pretty_printer *, bool); | |
69cb846f | 357 | extern void pp_base_maybe_space (pretty_printer *); |
aa6db498 | 358 | |
c907c5b1 | 359 | /* Switch into verbatim mode and return the old mode. */ |
360 | static inline pp_wrapping_mode_t | |
361 | pp_set_verbatim_wrapping_ (pretty_printer *pp) | |
362 | { | |
363 | pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp); | |
364 | pp_line_cutoff (pp) = 0; | |
365 | pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER; | |
366 | return oldmode; | |
367 | } | |
368 | #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (pp_base (PP)) | |
369 | ||
27746e01 | 370 | extern const char *identifier_to_locale (const char *); |
ddcdd2ab | 371 | extern void *(*identifier_to_locale_alloc) (size_t); |
372 | extern void (*identifier_to_locale_free) (void *); | |
27746e01 | 373 | |
75e76012 | 374 | #endif /* GCC_PRETTY_PRINT_H */ |