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>
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
27 /* Maximum number of format string arguments. */
28 #define PP_NL_ARGMAX 30
30 /* The type of a text to be formatted according a format specification
31 along with a list of things. */
34 const char *format_spec
;
36 int err_no
; /* for %m */
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
46 enum diagnostic_prefixing_rule_t
48 DIAGNOSTICS_SHOW_PREFIX_ONCE
= 0x0,
49 DIAGNOSTICS_SHOW_PREFIX_NEVER
= 0x1,
50 DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE
= 0x2
53 /* The chunk_info data structure forms a stack of the results from the
54 first phase of formatting (pp_format) which have not yet been
55 output (pp_output_formatted_text). A stack is necessary because
56 the diagnostic starter may decide to generate its own output by way
60 /* Pointer to previous chunk on the stack. */
61 struct chunk_info
*prev
;
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];
72 /* The output buffer datatype. This is best seen as an abstract datatype
73 whose fields should not be accessed directly by clients. */
76 /* Obstack where the text is built up. */
77 struct obstack formatted_obstack
;
79 /* Obstack containing a chunked representation of the format
80 specification plus arguments. */
81 struct obstack chunk_obstack
;
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
;
87 /* Stack of chunk arrays. These come from the chunk_obstack. */
88 struct chunk_info
*cur_chunk_array
;
90 /* Where to output formatted text. */
93 /* The amount of characters output so far. */
96 /* This must be large enough to hold any printed integer or
97 floating-point value. */
98 char digit_buffer
[128];
101 /* The type of pretty-printer flags passed to clients. */
102 typedef unsigned int pp_flags
;
106 pp_none
, pp_before
, pp_after
109 /* Structure for switching in and out of verbatim mode in a convenient
111 struct pp_wrapping_mode_t
113 /* Current prefixing rule. */
114 diagnostic_prefixing_rule_t rule
;
116 /* The ideal upper bound of number of characters per line, as suggested
121 /* Maximum characters per line in automatic line wrapping mode.
122 Zero means don't wrap lines. */
123 #define pp_line_cutoff(PP) (PP)->wrapping.line_cutoff
125 /* Prefixing rule used in formatting a diagnostic message. */
126 #define pp_prefixing_rule(PP) (PP)->wrapping.rule
128 /* Get or set the wrapping mode as a single entity. */
129 #define pp_wrapping_mode(PP) (PP)->wrapping
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);
137 /* Client supplied function used to decode formats. */
138 #define pp_format_decoder(PP) (PP)->format_decoder
140 /* TRUE if a newline character needs to be added before further
142 #define pp_needs_newline(PP) (PP)->need_newline
144 /* True if PRETTY-PRINTER is in line-wrapping mode. */
145 #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0)
147 /* The amount of whitespace to be emitted when starting a new line. */
148 #define pp_indentation(PP) (PP)->indent_skip
150 /* True if identifiers are translated to the locale character set on
152 #define pp_translate_identifiers(PP) (PP)->translate_identifiers
154 /* True if colors should be shown. */
155 #define pp_show_color(PP) (PP)->show_color
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. */
160 struct pretty_print_info
162 /* Where we print external representation of ENTITY. */
163 output_buffer
*buffer
;
165 /* The prefix for each new line. */
168 /* Where to put whitespace around the entity being formatted. */
171 /* The real upper bound of number of characters per line, taking into
172 account the case of a very very looong prefix. */
175 /* Indentation count. */
178 /* Current wrapping mode. */
179 pp_wrapping_mode_t wrapping
;
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.
189 printer_fn format_decoder
;
191 /* Nonzero if current PREFIX was emitted at least once. */
194 /* Nonzero means one should emit a newline before outputting anything. */
197 /* Nonzero means identifiers are translated to the locale character
199 bool translate_identifiers
;
201 /* Nonzero means that text should be colorized. */
205 static inline const char *
206 pp_get_prefix (const pretty_printer
*pp
) { return pp
->prefix
; }
208 #define pp_space(PP) pp_character (PP, ' ')
209 #define pp_left_paren(PP) pp_character (PP, '(')
210 #define pp_right_paren(PP) pp_character (PP, ')')
211 #define pp_left_bracket(PP) pp_character (PP, '[')
212 #define pp_right_bracket(PP) pp_character (PP, ']')
213 #define pp_left_brace(PP) pp_character (PP, '{')
214 #define pp_right_brace(PP) pp_character (PP, '}')
215 #define pp_semicolon(PP) pp_character (PP, ';')
216 #define pp_comma(PP) pp_character (PP, ',')
217 #define pp_dot(PP) pp_character (PP, '.')
218 #define pp_colon(PP) pp_character (PP, ':')
219 #define pp_colon_colon(PP) pp_string (PP, "::")
220 #define pp_arrow(PP) pp_string (PP, "->")
221 #define pp_equal(PP) pp_character (PP, '=')
222 #define pp_question(PP) pp_character (PP, '?')
223 #define pp_bar(PP) pp_character (PP, '|')
224 #define pp_bar_bar(PP) pp_string (PP, "||")
225 #define pp_carret(PP) pp_character (PP, '^')
226 #define pp_ampersand(PP) pp_character (PP, '&')
227 #define pp_ampersand_ampersand(PP) pp_string (PP, "&&")
228 #define pp_less(PP) pp_character (PP, '<')
229 #define pp_less_equal(PP) pp_string (PP, "<=")
230 #define pp_greater(PP) pp_character (PP, '>')
231 #define pp_greater_equal(PP) pp_string (PP, ">=")
232 #define pp_plus(PP) pp_character (PP, '+')
233 #define pp_minus(PP) pp_character (PP, '-')
234 #define pp_star(PP) pp_character (PP, '*')
235 #define pp_slash(PP) pp_character (PP, '/')
236 #define pp_modulo(PP) pp_character (PP, '%')
237 #define pp_exclamation(PP) pp_character (PP, '!')
238 #define pp_complement(PP) pp_character (PP, '~')
239 #define pp_quote(PP) pp_character (PP, '\'')
240 #define pp_backquote(PP) pp_character (PP, '`')
241 #define pp_doublequote(PP) pp_character (PP, '"')
242 #define pp_underscore(PP) pp_character (PP, '_')
243 #define pp_newline_and_flush(PP) \
247 pp_needs_newline (PP) = false; \
249 #define pp_newline_and_indent(PP, N) \
251 pp_indentation (PP) += N; \
254 pp_needs_newline (PP) = false; \
256 #define pp_maybe_newline_and_indent(PP, N) \
257 if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N)
258 #define pp_separate_with(PP, C) \
260 pp_character (PP, C); \
263 #define pp_scalar(PP, FORMAT, SCALAR) \
266 sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
267 pp_string (PP, pp_buffer (PP)->digit_buffer); \
270 #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I)
271 #define pp_unsigned_wide_integer(PP, I) \
272 pp_scalar (PP, HOST_WIDE_INT_PRINT_UNSIGNED, (unsigned HOST_WIDE_INT) I)
273 #define pp_wide_integer(PP, I) \
274 pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I)
275 #define pp_widest_integer(PP, I) \
276 pp_scalar (PP, HOST_WIDEST_INT_PRINT_DEC, (HOST_WIDEST_INT) I)
277 #define pp_pointer(PP, P) pp_scalar (PP, "%p", P)
279 #define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \
280 ? identifier_to_locale (ID) \
284 #define pp_buffer(PP) (PP)->buffer
286 extern void pp_construct (pretty_printer
*, const char *, int);
287 extern void pp_set_line_maximum_length (pretty_printer
*, int);
288 extern void pp_set_prefix (pretty_printer
*, const char *);
289 extern void pp_destroy_prefix (pretty_printer
*);
290 extern int pp_remaining_character_count_for_line (pretty_printer
*);
291 extern void pp_clear_output_area (pretty_printer
*);
292 extern const char *pp_formatted_text (pretty_printer
*);
293 extern const char *pp_last_position_in_text (const pretty_printer
*);
294 extern void pp_emit_prefix (pretty_printer
*);
295 extern void pp_append_text (pretty_printer
*, const char *, const char *);
297 /* If we haven't already defined a front-end-specific diagnostics
298 style, use the generic one. */
299 #ifdef GCC_DIAG_STYLE
300 #define GCC_PPDIAG_STYLE GCC_DIAG_STYLE
302 #define GCC_PPDIAG_STYLE __gcc_diag__
305 /* This header may be included before diagnostics-core.h, hence the duplicate
306 definitions to allow for GCC-specific formats. */
307 #if GCC_VERSION >= 3005
308 #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (GCC_PPDIAG_STYLE, m ,n))) ATTRIBUTE_NONNULL(m)
310 #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m)
312 extern void pp_printf (pretty_printer
*, const char *, ...)
313 ATTRIBUTE_GCC_PPDIAG(2,3);
315 extern void pp_verbatim (pretty_printer
*, const char *, ...)
316 ATTRIBUTE_GCC_PPDIAG(2,3);
317 extern void pp_flush (pretty_printer
*);
318 extern void pp_format (pretty_printer
*, text_info
*);
319 extern void pp_output_formatted_text (pretty_printer
*);
320 extern void pp_format_verbatim (pretty_printer
*, text_info
*);
322 extern void pp_indent (pretty_printer
*);
323 extern void pp_newline (pretty_printer
*);
324 extern void pp_character (pretty_printer
*, int);
325 extern void pp_string (pretty_printer
*, const char *);
326 extern void pp_write_text_to_stream (pretty_printer
*);
327 extern void pp_write_text_as_dot_label_to_stream (pretty_printer
*, bool);
328 extern void pp_maybe_space (pretty_printer
*);
330 /* Switch into verbatim mode and return the old mode. */
331 static inline pp_wrapping_mode_t
332 pp_set_verbatim_wrapping_ (pretty_printer
*pp
)
334 pp_wrapping_mode_t oldmode
= pp_wrapping_mode (pp
);
335 pp_line_cutoff (pp
) = 0;
336 pp_prefixing_rule (pp
) = DIAGNOSTICS_SHOW_PREFIX_NEVER
;
339 #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (PP)
341 extern const char *identifier_to_locale (const char *);
342 extern void *(*identifier_to_locale_alloc
) (size_t);
343 extern void (*identifier_to_locale_free
) (void *);
345 #endif /* GCC_PRETTY_PRINT_H */