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 typedef struct
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 } 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
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
72 /* The output buffer datatype. This is best seen as an abstract datatype
73 whose fields should not be accessed directly by clients. */
74 typedef struct
75 {
76 /* Obstack where the text is built up. */
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;
89
90 /* Where to output formatted text. */
91 FILE *stream;
92
93 /* The amount of characters output so far. */
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;
100
101 /* The type of pretty-printer flags passed to clients. */
102 typedef unsigned int pp_flags;
103
104 typedef enum
105 {
106 pp_none, pp_before, pp_after
107 } pp_padding;
108
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
117 by front-end. */
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
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. */
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-PRINTER 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 /* 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
154 /* The data structure that contains the bare minimum required to do
155 proper pretty-printing. Clients may derived from this structure
156 and add additional fields they need. */
157 struct pretty_print_info
158 {
159 /* Where we print external representation of ENTITY. */
160 output_buffer *buffer;
161
162 /* The prefix for each new line. */
163 const char *prefix;
164
165 /* Where to put whitespace around the entity being formatted. */
166 pp_padding padding;
167
168 /* The real upper bound of number of characters per line, taking into
169 account the case of a very very looong prefix. */
170 int maximum_length;
171
172 /* Indentation count. */
173 int indent_skip;
174
175 /* Current wrapping mode. */
176 pp_wrapping_mode_t wrapping;
177
178 /* If non-NULL, this function formats a TEXT into the BUFFER. When called,
179 TEXT->format_spec points to a format code. FORMAT_DECODER should call
180 pp_string (and related functions) to add data to the BUFFER.
181 FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
182 If the BUFFER needs additional characters from the format string, it
183 should advance the TEXT->format_spec as it goes. When FORMAT_DECODER
184 returns, TEXT->format_spec should point to the last character processed.
185 */
186 printer_fn format_decoder;
187
188 /* Nonzero if current PREFIX was emitted at least once. */
189 bool emitted_prefix;
190
191 /* Nonzero means one should emit a newline before outputting anything. */
192 bool need_newline;
193
194 /* Nonzero means identifiers are translated to the locale character
195 set on output. */
196 bool translate_identifiers;
197 };
198
199 #define pp_set_line_maximum_length(PP, L) \
200 pp_base_set_line_maximum_length (pp_base (PP), L)
201 #define pp_set_prefix(PP, P) pp_base_set_prefix (pp_base (PP), P)
202 #define pp_get_prefix(PP) pp_base_get_prefix (pp_base (PP))
203 static inline const char *
pp_base_get_prefix(const pretty_printer * pp)204 pp_base_get_prefix (const pretty_printer *pp) { return pp->prefix; }
205 #define pp_destroy_prefix(PP) pp_base_destroy_prefix (pp_base (PP))
206 #define pp_remaining_character_count_for_line(PP) \
207 pp_base_remaining_character_count_for_line (pp_base (PP))
208 #define pp_clear_output_area(PP) \
209 pp_base_clear_output_area (pp_base (PP))
210 #define pp_formatted_text(PP) pp_base_formatted_text (pp_base (PP))
211 #define pp_last_position_in_text(PP) \
212 pp_base_last_position_in_text (pp_base (PP))
213 #define pp_emit_prefix(PP) pp_base_emit_prefix (pp_base (PP))
214 #define pp_append_text(PP, B, E) \
215 pp_base_append_text (pp_base (PP), B, E)
216 #define pp_flush(PP) pp_base_flush (pp_base (PP))
217 #define pp_format(PP, TI) pp_base_format (pp_base (PP), TI)
218 #define pp_output_formatted_text(PP) \
219 pp_base_output_formatted_text (pp_base (PP))
220 #define pp_format_verbatim(PP, TI) \
221 pp_base_format_verbatim (pp_base (PP), TI)
222
223 #define pp_character(PP, C) pp_base_character (pp_base (PP), C)
224 #define pp_string(PP, S) pp_base_string (pp_base (PP), S)
225 #define pp_newline(PP) pp_base_newline (pp_base (PP))
226
227 #define pp_space(PP) pp_character (PP, ' ')
228 #define pp_left_paren(PP) pp_character (PP, '(')
229 #define pp_right_paren(PP) pp_character (PP, ')')
230 #define pp_left_bracket(PP) pp_character (PP, '[')
231 #define pp_right_bracket(PP) pp_character (PP, ']')
232 #define pp_left_brace(PP) pp_character (PP, '{')
233 #define pp_right_brace(PP) pp_character (PP, '}')
234 #define pp_semicolon(PP) pp_character (PP, ';')
235 #define pp_comma(PP) pp_string (PP, ", ")
236 #define pp_dot(PP) pp_character (PP, '.')
237 #define pp_colon(PP) pp_character (PP, ':')
238 #define pp_colon_colon(PP) pp_string (PP, "::")
239 #define pp_arrow(PP) pp_string (PP, "->")
240 #define pp_equal(PP) pp_character (PP, '=')
241 #define pp_question(PP) pp_character (PP, '?')
242 #define pp_bar(PP) pp_character (PP, '|')
243 #define pp_carret(PP) pp_character (PP, '^')
244 #define pp_ampersand(PP) pp_character (PP, '&')
245 #define pp_less(PP) pp_character (PP, '<')
246 #define pp_greater(PP) pp_character (PP, '>')
247 #define pp_plus(PP) pp_character (PP, '+')
248 #define pp_minus(PP) pp_character (PP, '-')
249 #define pp_star(PP) pp_character (PP, '*')
250 #define pp_slash(PP) pp_character (PP, '/')
251 #define pp_modulo(PP) pp_character (PP, '%')
252 #define pp_exclamation(PP) pp_character (PP, '!')
253 #define pp_complement(PP) pp_character (PP, '~')
254 #define pp_quote(PP) pp_character (PP, '\'')
255 #define pp_backquote(PP) pp_character (PP, '`')
256 #define pp_doublequote(PP) pp_character (PP, '"')
257 #define pp_newline_and_flush(PP) \
258 do { \
259 pp_newline (PP); \
260 pp_flush (PP); \
261 pp_needs_newline (PP) = false; \
262 } while (0)
263 #define pp_newline_and_indent(PP, N) \
264 do { \
265 pp_indentation (PP) += N; \
266 pp_newline (PP); \
267 pp_base_indent (pp_base (PP)); \
268 pp_needs_newline (PP) = false; \
269 } while (0)
270 #define pp_maybe_newline_and_indent(PP, N) \
271 if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N)
272 #define pp_maybe_space(PP) pp_base_maybe_space (pp_base (PP))
273 #define pp_separate_with(PP, C) \
274 do { \
275 pp_character (PP, C); \
276 pp_space (PP); \
277 } while (0)
278 #define pp_scalar(PP, FORMAT, SCALAR) \
279 do \
280 { \
281 sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
282 pp_string (PP, pp_buffer (PP)->digit_buffer); \
283 } \
284 while (0)
285 #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I)
286 #define pp_unsigned_wide_integer(PP, I) \
287 pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I)
288 #define pp_wide_integer(PP, I) \
289 pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I)
290 #define pp_widest_integer(PP, I) \
291 pp_scalar (PP, HOST_WIDEST_INT_PRINT_DEC, (HOST_WIDEST_INT) I)
292 #define pp_pointer(PP, P) pp_scalar (PP, "%p", P)
293
294 #define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \
295 ? identifier_to_locale (ID) \
296 : (ID)))
297
298
299 #define pp_buffer(PP) pp_base (PP)->buffer
300 /* Clients that directly derive from pretty_printer need to override
301 this macro to return a pointer to the base pretty_printer structure. */
302 #define pp_base(PP) (PP)
303
304 extern void pp_construct (pretty_printer *, const char *, int);
305 extern void pp_base_set_line_maximum_length (pretty_printer *, int);
306 extern void pp_base_set_prefix (pretty_printer *, const char *);
307 extern void pp_base_destroy_prefix (pretty_printer *);
308 extern int pp_base_remaining_character_count_for_line (pretty_printer *);
309 extern void pp_base_clear_output_area (pretty_printer *);
310 extern const char *pp_base_formatted_text (pretty_printer *);
311 extern const char *pp_base_last_position_in_text (const pretty_printer *);
312 extern void pp_base_emit_prefix (pretty_printer *);
313 extern void pp_base_append_text (pretty_printer *, const char *, const char *);
314
315 /* If we haven't already defined a front-end-specific diagnostics
316 style, use the generic one. */
317 #ifdef GCC_DIAG_STYLE
318 #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE
319 #else
320 #define GCC_PPDIAG_STYLE __gcc_diag__
321 #endif
322
323 /* This header may be included before diagnostics-core.h, hence the duplicate
324 definitions to allow for GCC-specific formats. */
325 #if GCC_VERSION >= 3005
326 #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m)
327 #else
328 #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m)
329 #endif
330 extern void pp_printf (pretty_printer *, const char *, ...)
331 ATTRIBUTE_GCC_PPDIAG(2,3);
332
333 extern void pp_verbatim (pretty_printer *, const char *, ...)
334 ATTRIBUTE_GCC_PPDIAG(2,3);
335 extern void pp_base_flush (pretty_printer *);
336 extern void pp_base_format (pretty_printer *, text_info *);
337 extern void pp_base_output_formatted_text (pretty_printer *);
338 extern void pp_base_format_verbatim (pretty_printer *, text_info *);
339
340 extern void pp_base_indent (pretty_printer *);
341 extern void pp_base_newline (pretty_printer *);
342 extern void pp_base_character (pretty_printer *, int);
343 extern void pp_base_string (pretty_printer *, const char *);
344 extern void pp_write_text_to_stream (pretty_printer *);
345 extern void pp_write_text_as_dot_label_to_stream (pretty_printer *, bool);
346 extern void pp_base_maybe_space (pretty_printer *);
347
348 /* Switch into verbatim mode and return the old mode. */
349 static inline pp_wrapping_mode_t
pp_set_verbatim_wrapping_(pretty_printer * pp)350 pp_set_verbatim_wrapping_ (pretty_printer *pp)
351 {
352 pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp);
353 pp_line_cutoff (pp) = 0;
354 pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER;
355 return oldmode;
356 }
357 #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (pp_base (PP))
358
359 extern const char *identifier_to_locale (const char *);
360 extern void *(*identifier_to_locale_alloc) (size_t);
361 extern void (*identifier_to_locale_free) (void *);
362
363 #endif /* GCC_PRETTY_PRINT_H */
364