1 /* Various declarations for language-independent pretty-print subroutines.
2 Copyright (C) 2002, 2003 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 2, 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 COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
22 #ifndef GCC_PRETTY_PRINT_H
23 #define GCC_PRETTY_PRINT_H
28 /* The type of a text to be formatted according a format specification
29 along with a list of things. */
32 const char *format_spec;
34 int err_no; /* for %m */
37 /* How often diagnostics are prefixed by their locations:
38 o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
39 o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
40 o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
44 DIAGNOSTICS_SHOW_PREFIX_ONCE = 0x0,
45 DIAGNOSTICS_SHOW_PREFIX_NEVER = 0x1,
46 DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
47 } diagnostic_prefixing_rule_t;
49 /* The output buffer datatype. This is best seen as an abstract datatype
50 whose fields should not be accessed directly by clients. */
53 /* The obstack where the text is built up. */
54 struct obstack obstack;
56 /* Where to output formatted text. */
59 /* The amount of characters output so far. */
62 /* This must be large enough to hold any printed integer or
63 floating-point value. */
64 char digit_buffer[128];
67 /* The type of pretty-printer flags passed to clients. */
68 typedef unsigned int pp_flags;
72 pp_none, pp_before, pp_after
75 /* The type of a hook that formats client-specific data onto a pretty_pinter.
76 A client-supplied formatter returns true if everything goes well,
77 otherwise it returns false. */
78 typedef struct pretty_print_info pretty_printer;
79 typedef bool (*printer_fn) (pretty_printer *, text_info *);
81 /* Client supplied function used to decode formats. */
82 #define pp_format_decoder(PP) pp_base (PP)->format_decoder
84 /* TRUE if a newline character needs to be added before further
86 #define pp_needs_newline(PP) pp_base (PP)->need_newline
88 /* Maximum characters per line in automatic line wrapping mode.
89 Zero means don't wrap lines. */
90 #define pp_line_cutoff(PP) pp_base (PP)->ideal_maximum_length
92 /* True if PRETTY-PTINTER is in line-wrapping mode. */
93 #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0)
95 /* Prefixing rule used in formatting a diagnostic message. */
96 #define pp_prefixing_rule(PP) pp_base (PP)->prefixing_rule
98 /* The amount of whitespace to be emitted when starting a new line. */
99 #define pp_indentation(PP) pp_base (PP)->indent_skip
101 /* The data structure that contains the bare minimum required to do
102 proper pretty-printing. Clients may derived from this structure
103 and add additional fields they need. */
104 struct pretty_print_info
106 /* Where we print external representation of ENTITY. */
107 output_buffer *buffer;
109 /* The prefix for each new line. */
114 /* Where to put whitespace around the entity being formatted. */
117 /* The real upper bound of number of characters per line, taking into
118 account the case of a very very looong prefix. */
121 /* The ideal upper bound of number of characters per line, as suggested
123 int ideal_maximum_length;
125 /* Indentation count. */
128 /* Current prefixing rule. */
129 diagnostic_prefixing_rule_t prefixing_rule;
131 /* If non-NULL, this function formats a TEXT into the BUFFER. When called,
132 TEXT->format_spec points to a format code. FORMAT_DECODER should call
133 pp_string (and related functions) to add data to the BUFFER.
134 FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG.
135 If the BUFFER needs additional characters from the format string, it
136 should advance the TEXT->format_spec as it goes. When FORMAT_DECODER
137 returns, TEXT->format_spec should point to the last character processed.
139 printer_fn format_decoder;
141 /* Nonzero if current PREFIX was emitted at least once. */
144 /* Nonzero means one should emit a newline before outputting anything. */
148 #define pp_character(PP, C) pp_base_character (pp_base (PP), C)
149 #define pp_string(PP, S) pp_base_string (pp_base (PP), S)
150 #define pp_newline(PP) pp_base_newline (pp_base (PP))
151 #define pp_space(PP) pp_character (PP, ' ')
152 #define pp_left_paren(PP) pp_character (PP, '(')
153 #define pp_right_paren(PP) pp_character (PP, ')')
154 #define pp_left_bracket(PP) pp_character (PP, '[')
155 #define pp_right_bracket(PP) pp_character (PP, ']')
156 #define pp_left_brace(PP) pp_character (PP, '{')
157 #define pp_right_brace(PP) pp_character (PP, '}')
158 #define pp_semicolon(PP) pp_character (PP, ';')
159 #define pp_comma(PP) pp_string (PP, ", ")
160 #define pp_dot(PP) pp_character (PP, '.')
161 #define pp_colon(PP) pp_character (PP, ':')
162 #define pp_colon_colon(PP) pp_string (PP, "::")
163 #define pp_arrow(PP) pp_string (PP, "->")
164 #define pp_equal(PP) pp_character (PP, '=')
165 #define pp_question(PP) pp_character (PP, '?')
166 #define pp_bar(PP) pp_character (PP, '|')
167 #define pp_carret(PP) pp_character (PP, '^')
168 #define pp_ampersand(PP) pp_character (PP, '&')
169 #define pp_less(PP) pp_character (PP, '<')
170 #define pp_greater(PP) pp_character (PP, '>')
171 #define pp_plus(PP) pp_character (PP, '+')
172 #define pp_minus(PP) pp_character (PP, '-')
173 #define pp_star(PP) pp_character (PP, '*')
174 #define pp_slash(PP) pp_character (PP, '/')
175 #define pp_modulo(PP) pp_character (PP, '%')
176 #define pp_exclamation(PP) pp_character (PP, '!')
177 #define pp_complement(PP) pp_character (PP, '~')
178 #define pp_quote(PP) pp_character (PP, '\'')
179 #define pp_backquote(PP) pp_character (PP, '`')
180 #define pp_doublequote(PP) pp_character (PP, '"')
181 #define pp_newline_and_indent(PP, N) \
183 pp_indentation (PP) += N; \
186 #define pp_separate_with(PP, C) \
188 pp_character (PP, C); \
191 #define pp_scalar(PP, FORMAT, SCALAR) \
194 sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \
195 pp_string (PP, pp_buffer (PP)->digit_buffer); \
198 #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I)
199 #define pp_wide_integer(PP, I) \
200 pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I)
201 #define pp_pointer(PP, P) pp_scalar (PP, "%p", P)
203 #define pp_identifier(PP, ID) pp_string (PP, ID)
204 #define pp_tree_identifier(PP, T) \
205 pp_append_text(pp_base (PP), IDENTIFIER_POINTER (T), \
206 IDENTIFIER_POINTER (T) + IDENTIFIER_LENGTH (T))
208 #define pp_unsupported_tree(PP, T) \
209 pp_verbatim (pp_base (PP), "#`%s' not supported by %s#", \
210 tree_code_name[(int) TREE_CODE (T)], __FUNCTION__)
213 #define pp_buffer(PP) pp_base (PP)->buffer
214 /* Clients that directly derive from pretty_printer need to override
215 this macro to return a pointer to the base pretty_printer structrure. */
216 #define pp_base(PP) (PP)
218 extern void pp_construct (pretty_printer *, const char *, int);
219 extern void pp_set_line_maximum_length (pretty_printer *, int);
220 extern void pp_set_prefix (pretty_printer *, const char *);
221 extern void pp_destroy_prefix (pretty_printer *);
222 extern int pp_remaining_character_count_for_line (pretty_printer *);
223 extern void pp_clear_output_area (pretty_printer *);
224 extern const char *pp_formatted_text (pretty_printer *);
225 extern const char *pp_last_position_in_text (const pretty_printer *);
226 extern void pp_emit_prefix (pretty_printer *);
227 extern void pp_append_text (pretty_printer *, const char *, const char *);
228 extern void pp_printf (pretty_printer *, const char *, ...) ATTRIBUTE_PRINTF_2;
229 extern void pp_verbatim (pretty_printer *, const char *, ...);
230 extern void pp_flush (pretty_printer *);
231 extern void pp_format_text (pretty_printer *, text_info *);
232 extern void pp_format_verbatim (pretty_printer *, text_info *);
234 extern void pp_base_newline (pretty_printer *);
235 extern void pp_base_character (pretty_printer *, int);
236 extern void pp_base_string (pretty_printer *, const char *);
238 #endif /* GCC_PRETTY_PRINT_H */