Mercurial > hg > CbC > CbC_gcc
annotate gcc/pretty-print.h @ 56:3c8a44c06a95
Added tag gcc-4.4.5 for changeset 77e2b8dfacca
| author | ryoma <e075725@ie.u-ryukyu.ac.jp> |
|---|---|
| date | Fri, 12 Feb 2010 23:41:23 +0900 |
| parents | 77e2b8dfacca |
| children | b7f97abdc517 |
| rev | line source |
|---|---|
| 0 | 1 /* Various declarations for language-independent pretty-print subroutines. |
| 2 Copyright (C) 2002, 2003, 2004, 2007, 2008 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 tree *abstract_origin; | |
| 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. */ | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
74 typedef struct |
| 0 | 75 { |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
76 /* Obstack where the text is built up. */ |
| 0 | 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 | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
93 /* The amount of characters output so far. */ |
| 0 | 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 | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
117 by front-end. */ |
| 0 | 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 struct pretty_print_info pretty_printer; | |
| 135 typedef bool (*printer_fn) (pretty_printer *, text_info *, const char *, | |
| 136 int, bool, bool, bool); | |
| 137 | |
| 138 /* Client supplied function used to decode formats. */ | |
| 139 #define pp_format_decoder(PP) pp_base (PP)->format_decoder | |
| 140 | |
| 141 /* TRUE if a newline character needs to be added before further | |
| 142 formatting. */ | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
143 #define pp_needs_newline(PP) pp_base (PP)->need_newline |
| 0 | 144 |
| 145 /* True if PRETTY-PRINTER is in line-wrapping mode. */ | |
| 146 #define pp_is_wrapping_line(PP) (pp_line_cutoff (PP) > 0) | |
| 147 | |
| 148 /* The amount of whitespace to be emitted when starting a new line. */ | |
| 149 #define pp_indentation(PP) pp_base (PP)->indent_skip | |
| 150 | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
151 /* True if identifiers are translated to the locale character set on |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
152 output. */ |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
153 #define pp_translate_identifiers(PP) pp_base (PP)->translate_identifiers |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
154 |
| 0 | 155 /* The data structure that contains the bare minimum required to do |
| 156 proper pretty-printing. Clients may derived from this structure | |
| 157 and add additional fields they need. */ | |
| 158 struct pretty_print_info | |
| 159 { | |
| 160 /* Where we print external representation of ENTITY. */ | |
| 161 output_buffer *buffer; | |
| 162 | |
| 163 /* The prefix for each new line. */ | |
| 164 const char *prefix; | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
165 |
| 0 | 166 /* Where to put whitespace around the entity being formatted. */ |
| 167 pp_padding padding; | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
168 |
| 0 | 169 /* The real upper bound of number of characters per line, taking into |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
170 account the case of a very very looong prefix. */ |
| 0 | 171 int maximum_length; |
| 172 | |
| 173 /* Indentation count. */ | |
| 174 int indent_skip; | |
| 175 | |
| 176 /* Current wrapping mode. */ | |
| 177 pp_wrapping_mode_t wrapping; | |
| 178 | |
| 179 /* If non-NULL, this function formats a TEXT into the BUFFER. When called, | |
| 180 TEXT->format_spec points to a format code. FORMAT_DECODER should call | |
| 181 pp_string (and related functions) to add data to the BUFFER. | |
| 182 FORMAT_DECODER can read arguments from *TEXT->args_pts using VA_ARG. | |
| 183 If the BUFFER needs additional characters from the format string, it | |
| 184 should advance the TEXT->format_spec as it goes. When FORMAT_DECODER | |
| 185 returns, TEXT->format_spec should point to the last character processed. | |
| 186 */ | |
| 187 printer_fn format_decoder; | |
| 188 | |
| 189 /* Nonzero if current PREFIX was emitted at least once. */ | |
| 190 bool emitted_prefix; | |
| 191 | |
| 192 /* Nonzero means one should emit a newline before outputting anything. */ | |
| 193 bool need_newline; | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
194 |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
195 /* Nonzero means identifiers are translated to the locale character |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
196 set on output. */ |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
197 bool translate_identifiers; |
| 0 | 198 }; |
| 199 | |
| 200 #define pp_set_line_maximum_length(PP, L) \ | |
| 201 pp_base_set_line_maximum_length (pp_base (PP), L) | |
| 202 #define pp_set_prefix(PP, P) pp_base_set_prefix (pp_base (PP), P) | |
| 203 #define pp_destroy_prefix(PP) pp_base_destroy_prefix (pp_base (PP)) | |
| 204 #define pp_remaining_character_count_for_line(PP) \ | |
| 205 pp_base_remaining_character_count_for_line (pp_base (PP)) | |
| 206 #define pp_clear_output_area(PP) \ | |
| 207 pp_base_clear_output_area (pp_base (PP)) | |
| 208 #define pp_formatted_text(PP) pp_base_formatted_text (pp_base (PP)) | |
| 209 #define pp_last_position_in_text(PP) \ | |
| 210 pp_base_last_position_in_text (pp_base (PP)) | |
| 211 #define pp_emit_prefix(PP) pp_base_emit_prefix (pp_base (PP)) | |
| 212 #define pp_append_text(PP, B, E) \ | |
| 213 pp_base_append_text (pp_base (PP), B, E) | |
| 214 #define pp_flush(PP) pp_base_flush (pp_base (PP)) | |
| 215 #define pp_format(PP, TI) pp_base_format (pp_base (PP), TI) | |
| 216 #define pp_output_formatted_text(PP) \ | |
| 217 pp_base_output_formatted_text (pp_base (PP)) | |
| 218 #define pp_format_verbatim(PP, TI) \ | |
| 219 pp_base_format_verbatim (pp_base (PP), TI) | |
| 220 | |
| 221 #define pp_character(PP, C) pp_base_character (pp_base (PP), C) | |
| 222 #define pp_string(PP, S) pp_base_string (pp_base (PP), S) | |
| 223 #define pp_newline(PP) pp_base_newline (pp_base (PP)) | |
| 224 | |
| 225 #define pp_space(PP) pp_character (PP, ' ') | |
| 226 #define pp_left_paren(PP) pp_character (PP, '(') | |
| 227 #define pp_right_paren(PP) pp_character (PP, ')') | |
| 228 #define pp_left_bracket(PP) pp_character (PP, '[') | |
| 229 #define pp_right_bracket(PP) pp_character (PP, ']') | |
| 230 #define pp_left_brace(PP) pp_character (PP, '{') | |
| 231 #define pp_right_brace(PP) pp_character (PP, '}') | |
| 232 #define pp_semicolon(PP) pp_character (PP, ';') | |
| 233 #define pp_comma(PP) pp_string (PP, ", ") | |
| 234 #define pp_dot(PP) pp_character (PP, '.') | |
| 235 #define pp_colon(PP) pp_character (PP, ':') | |
| 236 #define pp_colon_colon(PP) pp_string (PP, "::") | |
| 237 #define pp_arrow(PP) pp_string (PP, "->") | |
| 238 #define pp_equal(PP) pp_character (PP, '=') | |
| 239 #define pp_question(PP) pp_character (PP, '?') | |
| 240 #define pp_bar(PP) pp_character (PP, '|') | |
| 241 #define pp_carret(PP) pp_character (PP, '^') | |
| 242 #define pp_ampersand(PP) pp_character (PP, '&') | |
| 243 #define pp_less(PP) pp_character (PP, '<') | |
| 244 #define pp_greater(PP) pp_character (PP, '>') | |
| 245 #define pp_plus(PP) pp_character (PP, '+') | |
| 246 #define pp_minus(PP) pp_character (PP, '-') | |
| 247 #define pp_star(PP) pp_character (PP, '*') | |
| 248 #define pp_slash(PP) pp_character (PP, '/') | |
| 249 #define pp_modulo(PP) pp_character (PP, '%') | |
| 250 #define pp_exclamation(PP) pp_character (PP, '!') | |
| 251 #define pp_complement(PP) pp_character (PP, '~') | |
| 252 #define pp_quote(PP) pp_character (PP, '\'') | |
| 253 #define pp_backquote(PP) pp_character (PP, '`') | |
| 254 #define pp_doublequote(PP) pp_character (PP, '"') | |
| 255 #define pp_newline_and_indent(PP, N) \ | |
| 256 do { \ | |
| 257 pp_indentation (PP) += N; \ | |
| 258 pp_newline (PP); \ | |
| 259 pp_base_indent (pp_base (PP)); \ | |
| 260 pp_needs_newline (PP) = false; \ | |
| 261 } while (0) | |
| 262 #define pp_maybe_newline_and_indent(PP, N) \ | |
| 263 if (pp_needs_newline (PP)) pp_newline_and_indent (PP, N) | |
| 264 #define pp_maybe_space(PP) pp_base_maybe_space (pp_base (PP)) | |
| 265 #define pp_separate_with(PP, C) \ | |
| 266 do { \ | |
| 267 pp_character (PP, C); \ | |
| 268 pp_space (PP); \ | |
| 269 } while (0) | |
| 270 #define pp_scalar(PP, FORMAT, SCALAR) \ | |
| 271 do \ | |
| 272 { \ | |
| 273 sprintf (pp_buffer (PP)->digit_buffer, FORMAT, SCALAR); \ | |
| 274 pp_string (PP, pp_buffer (PP)->digit_buffer); \ | |
| 275 } \ | |
| 276 while (0) | |
| 277 #define pp_decimal_int(PP, I) pp_scalar (PP, "%d", I) | |
| 278 #define pp_wide_integer(PP, I) \ | |
| 279 pp_scalar (PP, HOST_WIDE_INT_PRINT_DEC, (HOST_WIDE_INT) I) | |
| 280 #define pp_widest_integer(PP, I) \ | |
| 281 pp_scalar (PP, HOST_WIDEST_INT_PRINT_DEC, (HOST_WIDEST_INT) I) | |
| 282 #define pp_pointer(PP, P) pp_scalar (PP, "%p", P) | |
| 283 | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
284 #define pp_identifier(PP, ID) pp_string (PP, (pp_translate_identifiers (PP) \ |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
285 ? identifier_to_locale (ID) \ |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
286 : (ID))) |
| 0 | 287 #define pp_tree_identifier(PP, T) \ |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
288 pp_base_tree_identifier (pp_base (PP), T) |
| 0 | 289 |
| 290 #define pp_unsupported_tree(PP, T) \ | |
| 291 pp_verbatim (pp_base (PP), "#%qs not supported by %s#", \ | |
| 292 tree_code_name[(int) TREE_CODE (T)], __FUNCTION__) | |
| 293 | |
| 294 | |
| 295 #define pp_buffer(PP) pp_base (PP)->buffer | |
| 296 /* Clients that directly derive from pretty_printer need to override | |
| 297 this macro to return a pointer to the base pretty_printer structure. */ | |
| 298 #define pp_base(PP) (PP) | |
| 299 | |
| 300 extern void pp_construct (pretty_printer *, const char *, int); | |
| 301 extern void pp_base_set_line_maximum_length (pretty_printer *, int); | |
| 302 extern void pp_base_set_prefix (pretty_printer *, const char *); | |
| 303 extern void pp_base_destroy_prefix (pretty_printer *); | |
| 304 extern int pp_base_remaining_character_count_for_line (pretty_printer *); | |
| 305 extern void pp_base_clear_output_area (pretty_printer *); | |
| 306 extern const char *pp_base_formatted_text (pretty_printer *); | |
| 307 extern const char *pp_base_last_position_in_text (const pretty_printer *); | |
| 308 extern void pp_base_emit_prefix (pretty_printer *); | |
| 309 extern void pp_base_append_text (pretty_printer *, const char *, const char *); | |
| 310 | |
| 311 /* This header may be included before toplev.h, hence the duplicate | |
| 312 definitions to allow for GCC-specific formats. */ | |
| 313 #if GCC_VERSION >= 3005 | |
| 314 #define ATTRIBUTE_GCC_PPDIAG(m, n) __attribute__ ((__format__ (__gcc_diag__, m ,n))) ATTRIBUTE_NONNULL(m) | |
| 315 #else | |
| 316 #define ATTRIBUTE_GCC_PPDIAG(m, n) ATTRIBUTE_NONNULL(m) | |
| 317 #endif | |
| 318 extern void pp_printf (pretty_printer *, const char *, ...) | |
| 319 ATTRIBUTE_GCC_PPDIAG(2,3); | |
| 320 | |
| 321 extern void pp_verbatim (pretty_printer *, const char *, ...) | |
| 322 ATTRIBUTE_GCC_PPDIAG(2,3); | |
| 323 extern void pp_base_flush (pretty_printer *); | |
| 324 extern void pp_base_format (pretty_printer *, text_info *); | |
| 325 extern void pp_base_output_formatted_text (pretty_printer *); | |
| 326 extern void pp_base_format_verbatim (pretty_printer *, text_info *); | |
| 327 | |
| 328 extern void pp_base_indent (pretty_printer *); | |
| 329 extern void pp_base_newline (pretty_printer *); | |
| 330 extern void pp_base_character (pretty_printer *, int); | |
| 331 extern void pp_base_string (pretty_printer *, const char *); | |
| 332 extern void pp_write_text_to_stream (pretty_printer *pp); | |
| 333 extern void pp_base_maybe_space (pretty_printer *); | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
334 extern void pp_base_tree_identifier (pretty_printer *, tree); |
| 0 | 335 |
| 336 /* Switch into verbatim mode and return the old mode. */ | |
| 337 static inline pp_wrapping_mode_t | |
| 338 pp_set_verbatim_wrapping_ (pretty_printer *pp) | |
| 339 { | |
| 340 pp_wrapping_mode_t oldmode = pp_wrapping_mode (pp); | |
| 341 pp_line_cutoff (pp) = 0; | |
| 342 pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_NEVER; | |
| 343 return oldmode; | |
| 344 } | |
| 345 #define pp_set_verbatim_wrapping(PP) pp_set_verbatim_wrapping_ (pp_base (PP)) | |
| 346 | |
|
55
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
347 extern const char *identifier_to_locale (const char *); |
|
77e2b8dfacca
update it from 4.4.3 to 4.5.0
ryoma <e075725@ie.u-ryukyu.ac.jp>
parents:
0
diff
changeset
|
348 |
| 0 | 349 #endif /* GCC_PRETTY_PRINT_H */ |