1 /* Various declarations for language-independent pretty-print subroutines.
2 Copyright (C) 2003, 2004 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
23 #undef FLOAT /* This is for hpux. They should change hpux. */
24 #undef FFS /* Some systems define this in param.h. */
26 #include "coretypes.h"
28 #include "pretty-print.h"
30 #define obstack_chunk_alloc xmalloc
31 #define obstack_chunk_free free
33 /* A pointer to the formatted diagnostic message. */
34 #define pp_formatted_text_data(PP) \
35 ((const char *) obstack_base (&pp_base (PP)->buffer->obstack))
37 /* Format an integer given by va_arg (ARG, type-specifier T) where
38 type-specifier is a precision modifier as indicated by PREC. F is
39 a string used to construct the appropriate format-specifier. */
40 #define pp_integer_with_precision(PP, ARG, PREC, T, F) \
45 pp_scalar (PP, "%" F, va_arg (ARG, T)); \
49 pp_scalar (PP, "%l" F, va_arg (ARG, long T)); \
53 pp_scalar (PP, "%ll" F, va_arg (ARG, long long T)); \
62 /* Subroutine of pp_set_maximum_length. Set up PRETTY-PRINTER's
63 internal maximum characters per line. */
65 pp_set_real_maximum_length (pretty_printer *pp)
67 /* If we're told not to wrap lines then do the obvious thing. In case
68 we'll emit prefix only once per message, it is appropriate
69 not to increase unnecessarily the line-length cut-off. */
70 if (!pp_is_wrapping_line (pp)
71 || pp_prefixing_rule (pp) == DIAGNOSTICS_SHOW_PREFIX_ONCE
72 || pp_prefixing_rule (pp) == DIAGNOSTICS_SHOW_PREFIX_NEVER)
73 pp->maximum_length = pp_line_cutoff (pp);
76 int prefix_length = pp->prefix ? strlen (pp->prefix) : 0;
77 /* If the prefix is ridiculously too long, output at least
79 if (pp_line_cutoff (pp) - prefix_length < 32)
80 pp->maximum_length = pp_line_cutoff (pp) + 32;
82 pp->maximum_length = pp_line_cutoff (pp);
86 /* Clear PRETTY-PRINTER's output state. */
88 pp_clear_state (pretty_printer *pp)
90 pp->emitted_prefix = false;
91 pp_indentation (pp) = 0;
94 /* Flush the formatted text of PRETTY-PRINTER onto the attached stream. */
96 pp_write_text_to_stream (pretty_printer *pp)
98 const char *text = pp_formatted_text (pp);
99 fputs (text, pp->buffer->stream);
100 pp_clear_output_area (pp);
103 /* Wrap a text delimited by START and END into PRETTY-PRINTER. */
105 pp_wrap_text (pretty_printer *pp, const char *start, const char *end)
107 bool wrapping_line = pp_is_wrapping_line (pp);
111 /* Dump anything bordered by whitespaces. */
113 const char *p = start;
114 while (p != end && !ISBLANK (*p) && *p != '\n')
117 && p - start >= pp_remaining_character_count_for_line (pp))
119 pp_append_text (pp, start, p);
123 if (start != end && ISBLANK (*start))
128 if (start != end && *start == '\n')
136 /* Same as pp_wrap_text but wrap text only when in line-wrapping mode. */
138 pp_maybe_wrap_text (pretty_printer *pp, const char *start, const char *end)
140 if (pp_is_wrapping_line (pp))
141 pp_wrap_text (pp, start, end);
143 pp_append_text (pp, start, end);
146 /* Append to the output area of PRETTY-PRINTER a string specified by its
147 STARTing character and LENGTH. */
149 pp_append_r (pretty_printer *pp, const char *start, int length)
151 obstack_grow (&pp->buffer->obstack, start, length);
152 pp->buffer->line_length += length;
155 /* Insert enough spaces into the output area of PRETTY-PRINTER to bring
156 the column position to the current indentation level, assuming that a
157 newline has just been written to the buffer. */
159 pp_base_indent (pretty_printer *pp)
161 int n = pp_indentation (pp);
164 for (i = 0; i < n; ++i)
168 /* Format a message pointed to by TEXT. The following format specifiers are
169 recognized as being client independent:
170 %d, %i: (signed) integer in base ten.
171 %u: unsigned integer in base ten.
172 %o: unsigned integer in base eight.
173 %x: unsigned integer in base sixteen.
174 %ld, %li, %lo, %lu, %lx: long versions of the above.
175 %lld, %lli, %llo, %llu, %llx: long long versions.
176 %wd, %wi, %wo, %wu, %wx: HOST_WIDE_INT versions.
180 %m: strerror(text->err_no) - does not consume a value from args_ptr.
184 %': apostrophe (should only be used in untranslated messages;
185 translations should use appropriate punctuation directly).
186 %.*s: a substring the length of which is specified by an integer.
188 Flag 'q': quote formatted text (must come immediately after '%'). */
190 pp_base_format_text (pretty_printer *pp, text_info *text)
192 for (; *text->format_spec; ++text->format_spec)
200 const char *p = text->format_spec;
201 while (*p && *p != '%')
203 pp_wrap_text (pp, text->format_spec, p);
204 text->format_spec = p;
207 if (*text->format_spec == '\0')
210 /* We got a '%'. Check for 'q', then parse precision modifiers,
212 if (*++text->format_spec == 'q')
217 switch (*text->format_spec)
227 while (*++text->format_spec == 'l');
233 /* We don't support precision beyond that of "long long". */
238 pp_string (pp, open_quote);
239 switch (*text->format_spec)
242 pp_character (pp, va_arg (*text->args_ptr, int));
248 pp_wide_integer (pp, va_arg (*text->args_ptr, HOST_WIDE_INT));
250 pp_integer_with_precision
251 (pp, *text->args_ptr, precision, int, "d");
256 pp_scalar (pp, "%" HOST_WIDE_INT_PRINT "o",
257 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
259 pp_integer_with_precision
260 (pp, *text->args_ptr, precision, unsigned, "u");
264 pp_string (pp, va_arg (*text->args_ptr, const char *));
268 pp_pointer (pp, va_arg (*text->args_ptr, void *));
273 pp_scalar (pp, HOST_WIDE_INT_PRINT_UNSIGNED,
274 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
276 pp_integer_with_precision
277 (pp, *text->args_ptr, precision, unsigned, "u");
282 pp_scalar (pp, HOST_WIDE_INT_PRINT_HEX,
283 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
285 pp_integer_with_precision
286 (pp, *text->args_ptr, precision, unsigned, "x");
290 pp_string (pp, xstrerror (text->err_no));
294 pp_character (pp, '%');
298 pp_string (pp, open_quote);
303 pp_string (pp, close_quote);
308 location_t *locus = va_arg (*text->args_ptr, location_t *);
309 expanded_location s = expand_location (*locus);
310 pp_string (pp, "file '");
311 pp_string (pp, s.file);
312 pp_string (pp, "', line ");
313 pp_decimal_int (pp, s.line);
321 /* We handle no precision specifier but '%.*s'. */
322 if (*++text->format_spec != '*')
324 else if (*++text->format_spec != 's')
326 n = va_arg (*text->args_ptr, int);
327 s = va_arg (*text->args_ptr, const char *);
328 pp_append_text (pp, s, s + n);
333 if (!pp_format_decoder (pp) || !(*pp_format_decoder (pp)) (pp, text))
335 /* Hmmm. The client failed to install a format translator
336 but called us with an unrecognized format. Or, maybe, the
337 translated string just contains an invalid format, or
338 has formats in the wrong order. Sorry. */
343 pp_string (pp, close_quote);
347 /* Helper subroutine of output_verbatim and verbatim. Do the appropriate
348 settings needed by BUFFER for a verbatim formatting. */
350 pp_base_format_verbatim (pretty_printer *pp, text_info *text)
352 diagnostic_prefixing_rule_t rule = pp_prefixing_rule (pp);
353 int line_cutoff = pp_line_cutoff (pp);
355 /* Set verbatim mode. */
356 pp->prefixing_rule = DIAGNOSTICS_SHOW_PREFIX_NEVER;
357 pp_line_cutoff (pp) = 0;
358 /* Do the actual formatting. */
359 pp_format_text (pp, text);
360 /* Restore previous settings. */
361 pp_prefixing_rule (pp) = rule;
362 pp_line_cutoff (pp) = line_cutoff;
365 /* Flush the content of BUFFER onto the attached stream. */
367 pp_base_flush (pretty_printer *pp)
369 pp_write_text_to_stream (pp);
371 fputc ('\n', pp->buffer->stream);
372 fflush (pp->buffer->stream);
373 pp_needs_newline (pp) = false;
376 /* Sets the number of maximum characters per line PRETTY-PRINTER can
377 output in line-wrapping mode. A LENGTH value 0 suppresses
380 pp_base_set_line_maximum_length (pretty_printer *pp, int length)
382 pp_line_cutoff (pp) = length;
383 pp_set_real_maximum_length (pp);
386 /* Clear PRETTY-PRINTER output area text info. */
388 pp_base_clear_output_area (pretty_printer *pp)
390 obstack_free (&pp->buffer->obstack, obstack_base (&pp->buffer->obstack));
391 pp->buffer->line_length = 0;
394 /* Set PREFIX for PRETTY-PRINTER. */
396 pp_base_set_prefix (pretty_printer *pp, const char *prefix)
399 pp_set_real_maximum_length (pp);
400 pp->emitted_prefix = false;
401 pp_indentation (pp) = 0;
404 /* Free PRETTY-PRINTER's prefix, a previously malloc()'d string. */
406 pp_base_destroy_prefix (pretty_printer *pp)
408 if (pp->prefix != NULL)
410 free ((char *) pp->prefix);
415 /* Write out PRETTY-PRINTER's prefix. */
417 pp_base_emit_prefix (pretty_printer *pp)
419 if (pp->prefix != NULL)
421 switch (pp_prefixing_rule (pp))
424 case DIAGNOSTICS_SHOW_PREFIX_NEVER:
427 case DIAGNOSTICS_SHOW_PREFIX_ONCE:
428 if (pp->emitted_prefix)
433 pp_indentation (pp) += 3;
436 case DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE:
438 int prefix_length = strlen (pp->prefix);
439 pp_append_r (pp, pp->prefix, prefix_length);
440 pp->emitted_prefix = true;
447 /* Construct a PRETTY-PRINTER with PREFIX and of MAXIMUM_LENGTH
448 characters per line. */
450 pp_construct (pretty_printer *pp, const char *prefix, int maximum_length)
452 memset (pp, 0, sizeof (pretty_printer));
453 pp->buffer = xcalloc (1, sizeof (output_buffer));
454 obstack_init (&pp->buffer->obstack);
455 pp->buffer->stream = stderr;
456 pp_line_cutoff (pp) = maximum_length;
457 pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_ONCE;
458 pp_set_prefix (pp, prefix);
461 /* Append a string delimited by START and END to the output area of
462 PRETTY-PRINTER. No line wrapping is done. However, if beginning a
463 new line then emit PRETTY-PRINTER's prefix and skip any leading
464 whitespace if appropriate. The caller must ensure that it is
467 pp_base_append_text (pretty_printer *pp, const char *start, const char *end)
469 /* Emit prefix and skip whitespace if we're starting a new line. */
470 if (pp->buffer->line_length == 0)
473 if (pp_is_wrapping_line (pp))
474 while (start != end && *start == ' ')
477 pp_append_r (pp, start, end - start);
480 /* Finishes constructing a NULL-terminated character string representing
481 the PRETTY-PRINTED text. */
483 pp_base_formatted_text (pretty_printer *pp)
485 obstack_1grow (&pp->buffer->obstack, '\0');
486 return pp_formatted_text_data (pp);
489 /* Return a pointer to the last character emitted in PRETTY-PRINTER's
490 output area. A NULL pointer means no character available. */
492 pp_base_last_position_in_text (const pretty_printer *pp)
494 const char *p = NULL;
495 struct obstack *text = &pp->buffer->obstack;
497 if (obstack_base (text) != obstack_next_free (text))
498 p = ((const char *) obstack_next_free (text)) - 1;
502 /* Return the amount of characters PRETTY-PRINTER can accept to
503 make a full line. Meaningful only in line-wrapping mode. */
505 pp_base_remaining_character_count_for_line (pretty_printer *pp)
507 return pp->maximum_length - pp->buffer->line_length;
511 /* Format a message into BUFFER a la printf. */
513 pp_printf (pretty_printer *pp, const char *msg, ...)
521 text.format_spec = msg;
522 pp_format_text (pp, &text);
527 /* Output MESSAGE verbatim into BUFFER. */
529 pp_verbatim (pretty_printer *pp, const char *msg, ...)
537 text.format_spec = msg;
538 pp_format_verbatim (pp, &text);
544 /* Have PRETTY-PRINTER start a new line. */
546 pp_base_newline (pretty_printer *pp)
548 obstack_1grow (&pp->buffer->obstack, '\n');
549 pp->buffer->line_length = 0;
552 /* Have PRETTY-PRINTER add a CHARACTER. */
554 pp_base_character (pretty_printer *pp, int c)
556 if (pp_is_wrapping_line (pp)
557 && pp_remaining_character_count_for_line (pp) <= 0)
563 obstack_1grow (&pp->buffer->obstack, c);
564 ++pp->buffer->line_length;
567 /* Append a STRING to the output area of PRETTY-PRINTER; the STRING may
568 be line-wrapped if in appropriate mode. */
570 pp_base_string (pretty_printer *pp, const char *str)
572 pp_maybe_wrap_text (pp, str, str + (str ? strlen (str) : 0));
575 /* Maybe print out a whitespace if needed. */
578 pp_base_maybe_space (pretty_printer *pp)
580 if (pp_base (pp)->padding != pp_none)
583 pp_base (pp)->padding = pp_none;