1 /* Various declarations for language-independent pretty-print subroutines.
2 Copyright (C) 2002-2014 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
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
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
26 #include "wide-int-print.h"
28 /* Maximum number of format string arguments. */
29 #define PP_NL_ARGMAX 30
31 /* The type of a text to be formatted according a format specification
32 along with a list of things. */
35 const char *format_spec
;
37 int err_no
; /* for %m */
42 /* How often diagnostics are prefixed by their locations:
43 o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
44 o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
45 o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
47 enum diagnostic_prefixing_rule_t
49 DIAGNOSTICS_SHOW_PREFIX_ONCE
= 0x0,
50 DIAGNOSTICS_SHOW_PREFIX_NEVER
= 0x1,
51 DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE
= 0x2
54 /* The chunk_info data structure forms a stack of the results from the
55 first phase of formatting (pp_format) which have not yet been
56 output (pp_output_formatted_text). A stack is necessary because
57 the diagnostic starter may decide to generate its own output by way
61 /* Pointer to previous chunk on the stack. */
62 struct chunk_info
*prev
;
64 /* Array of chunks to output. Each chunk is a NUL-terminated string.
65 In the first phase of formatting, even-numbered chunks are
66 to be output verbatim, odd-numbered chunks are format specifiers.
67 The second phase replaces all odd-numbered chunks with formatted
68 text, and the third phase simply emits all the chunks in sequence
69 with appropriate line-wrapping. */
70 const char *args
[PP_NL_ARGMAX
* 2];
73 /* The output buffer datatype. This is best seen as an abstract datatype
74 whose fields should not be accessed directly by clients. */
80 /* Obstack where the text is built up. */
81 struct obstack formatted_obstack
;
83 /* Obstack containing a chunked representation of the format
84 specification plus arguments. */
85 struct obstack chunk_obstack
;
87 /* Currently active obstack: one of the above two. This is used so
88 that the text formatters don't need to know which phase we're in. */
89 struct obstack
*obstack
;
91 /* Stack of chunk arrays. These come from the chunk_obstack. */
92 struct chunk_info
*cur_chunk_array
;
94 /* Where to output formatted text. */
97 /* The amount of characters output so far. */
100 /* This must be large enough to hold any printed integer or
101 floating-point value. */
102 char digit_buffer
[128];
104 /* Nonzero means that text should be flushed when
105 appropriate. Otherwise, text is buffered until either
106 pp_really_flush or pp_clear_output_area are called. */
110 /* The type of pretty-printer flags passed to clients. */
111 typedef unsigned int pp_flags
;
115 pp_none
, pp_before
, pp_after
118 /* Structure for switching in and out of verbatim mode in a convenient
120 struct pp_wrapping_mode_t
122 /* Current prefixing rule. */
123 diagnostic_prefixing_rule_t rule
;
125 /* The ideal upper bound of number of characters per line, as suggested
130 /* Maximum characters per line in automatic line wrapping mode.
131 Zero means don't wrap lines. */
132 #define pp_line_cutoff(PP) (PP)->wrapping.line_cutoff
134 /* Prefixing rule used in formatting a diagnostic message. */
135 #define pp_prefixing_rule(PP) (PP)->wrapping.rule
137 /* Get or set the wrapping mode as a single entity. */
138 #define pp_wrapping_mode(PP) (PP)->wrapping
140 /* The type of a hook that formats client-specific data onto a pretty_pinter.
141 A client-supplied formatter returns true if everything goes well,
142 otherwise it returns false. */
143 typedef bool (*printer_fn
) (pretty_printer
*, text_info
*, const char *,
144 int, bool, bool, bool);
146 /* Client supplied function used to decode formats. */
147 #define pp_format_decoder(PP) (PP)->format_decoder
149 /* TRUE if a newline character needs to be added before further
151 #define pp_needs_newline(PP) (PP)->need_newline
153 /* True if PRETTY-PRINTER is in line-wrapping mode. */
154 #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0)
156 /* The amount of whitespace to be emitted when starting a new line. */
157 #define pp_indentation(PP) (PP)->indent_skip
159 /* True if identifiers are translated to the locale character set on
161 #define pp_translate_identifiers(PP) (PP)->translate_identifiers
163 /* True if colors should be shown. */
164 #define pp_show_color(PP) (PP)->show_color
166 /* The data structure that contains the bare minimum required to do
167 proper pretty-printing. Clients may derived from this structure
168 and add additional fields they need. */
169 struct pretty_printer
171 // Default construct a pretty printer with specified prefix
172 // and a maximum line length cut off limit.
173 explicit pretty_printer (const char* = NULL
, int = 0);
175 virtual ~pretty_printer ();
177 /* Where we print external representation of ENTITY. */
178 output_buffer
*buffer
;
180 /* The prefix for each new line. */
183 /* Where to put whitespace around the entity being formatted. */
186 /* The real upper bound of number of characters per line, taking into
187 account the case of a very very looong prefix. */
190 /* Indentation count. */
193 /* Current wrapping mode. */
194 pp_wrapping_mode_t wrapping
;
196 /* If non-NULL, this function formats a TEXT into the BUFFER. When called,
197 TEXT->format_spec points to a format code. FORMAT_DECODER should call
198 pp_string (and related functions) to add data to the BUFFER.
199 FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
200 If the BUFFER needs additional characters from the format string, it
201 should advance the TEXT->format_spec as it goes. When FORMAT_DECODER
202 returns, TEXT->format_spec should point to the last character processed.
204 printer_fn format_decoder
;
206 /* Nonzero if current PREFIX was emitted at least once. */
209 /* Nonzero means one should emit a newline before outputting anything. */
212 /* Nonzero means identifiers are translated to the locale character
214 bool translate_identifiers
;
216 /* Nonzero means that text should be colorized. */
220 static inline const char *
221 pp_get_prefix (const pretty_printer
*pp
) { return pp
->prefix
; }
223 #define pp_space(PP) pp_character (PP, ' ')
224 #define pp_left_paren(PP) pp_character (PP, '(')
225 #define pp_right_paren(PP) pp_character (PP, ')')
226 #define pp_left_bracket(PP) pp_character (PP, '[')
227 #define pp_right_bracket(PP) pp_character (PP, ']')
228 #define pp_left_brace(PP) pp_character (PP, '{')
229 #define pp_right_brace(PP) pp_character (PP, '}')
230 #define pp_semicolon(PP) pp_character (PP, ';')
231 #define pp_comma(PP) pp_character (PP, ',')
232 #define pp_dot(PP) pp_character (PP, '.')
233 #define pp_colon(PP) pp_character (PP, ':')
234 #define pp_colon_colon(PP) pp_string (PP, "::")
235 #define pp_arrow(PP) pp_string (PP, "->")
236 #define pp_equal(PP) pp_character (PP, '=')
237 #define pp_question(PP) pp_character (PP, '?')
238 #define pp_bar(PP) pp_character (PP, '|')
239 #define pp_bar_bar(PP) pp_string (PP, "||")
240 #define pp_carret(PP) pp_character (PP, '^')
241 #define pp_ampersand(PP) pp_character (PP, '&')
242 #define pp_ampersand_ampersand(PP) pp_string (PP, "&&")
243 #define pp_less(PP) pp_character (PP, '<')
244 #define pp_less_equal(PP) pp_string (PP, "<=")
245 #define pp_greater(PP) pp_character (PP, '>')
246 #define pp_greater_equal(PP) pp_string (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_underscore(PP) pp_character (PP, '_')
258 #define pp_maybe_newline_and_indent(PP, N) \
259 if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N)
260 #define pp_scalar(PP, FORMAT, SCALAR) \
263 sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
264 pp_string (PP, pp_buffer (PP)->digit_buffer); \
267 #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I)
268 #define pp_unsigned_wide_integer(PP, I) \
269 pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I)
270 #define pp_wide_int(PP, W, SGN) \
273 print_dec (W, pp_buffer (PP)->digit_buffer, SGN); \
274 pp_string (PP, pp_buffer (PP)->digit_buffer); \
277 #define pp_wide_integer(PP, I) \
278 pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I)
279 #define pp_pointer(PP, P) pp_scalar (PP, "%p", P)
281 #define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \
282 ? identifier_to_locale (ID) \
286 #define pp_buffer(PP) (PP)->buffer
288 extern void pp_set_line_maximum_length (pretty_printer
*, int);
289 extern void pp_set_prefix (pretty_printer
*, const char *);
290 extern void pp_destroy_prefix (pretty_printer
*);
291 extern int pp_remaining_character_count_for_line (pretty_printer
*);
292 extern void pp_clear_output_area (pretty_printer
*);
293 extern const char *pp_formatted_text (pretty_printer
*);
294 extern const char *pp_last_position_in_text (const pretty_printer
*);
295 extern void pp_emit_prefix (pretty_printer
*);
296 extern void pp_append_text (pretty_printer
*, const char *, const char *);
297 extern void pp_newline_and_flush (pretty_printer
*);
298 extern void pp_newline_and_indent (pretty_printer
*, int);
299 extern void pp_separate_with (pretty_printer
*, char);
301 /* If we haven't already defined a front-end-specific diagnostics
302 style, use the generic one. */
303 #ifdef GCC_DIAG_STYLE
304 #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE
306 #define GCC_PPDIAG_STYLE __gcc_diag__
309 /* This header may be included before diagnostics-core.h, hence the duplicate
310 definitions to allow for GCC-specific formats. */
311 #if GCC_VERSION >= 3005
312 #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m)
314 #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m)
316 extern void pp_printf (pretty_printer
*, const char *, ...)
317 ATTRIBUTE_GCC_PPDIAG(2,3);
319 extern void pp_verbatim (pretty_printer
*, const char *, ...)
320 ATTRIBUTE_GCC_PPDIAG(2,3);
321 extern void pp_flush (pretty_printer
*);
322 extern void pp_really_flush (pretty_printer
*);
323 extern void pp_format (pretty_printer
*, text_info
*);
324 extern void pp_output_formatted_text (pretty_printer
*);
325 extern void pp_format_verbatim (pretty_printer
*, text_info
*);
327 extern void pp_indent (pretty_printer
*);
328 extern void pp_newline (pretty_printer
*);
329 extern void pp_character (pretty_printer
*, int);
330 extern void pp_string (pretty_printer
*, const char *);
331 extern void pp_write_text_to_stream (pretty_printer
*);
332 extern void pp_write_text_as_dot_label_to_stream (pretty_printer
*, bool);
333 extern void pp_maybe_space (pretty_printer
*);
335 /* Switch into verbatim mode and return the old mode. */
336 static inline pp_wrapping_mode_t
337 pp_set_verbatim_wrapping_ (pretty_printer
*pp
)
339 pp_wrapping_mode_t oldmode
= pp_wrapping_mode (pp
);
340 pp_line_cutoff (pp
) = 0;
341 pp_prefixing_rule (pp
) = DIAGNOSTICS_SHOW_PREFIX_NEVER
;
344 #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (PP)
346 extern const char *identifier_to_locale (const char *);
347 extern void *(*identifier_to_locale_alloc
) (size_t);
348 extern void (*identifier_to_locale_free
) (void *);
350 #endif /* GCC_PRETTY_PRINT_H */