1 /* Various declarations for language-independent pretty-print subroutines.
2 Copyright (C) 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
23 #undef FLOAT /* This is for hpux. They should change hpux. */
24 #undef FFS /* Some systems define this in param.h. */
26 #include "pretty-print.h"
28 #define obstack_chunk_alloc xmalloc
29 #define obstack_chunk_free free
31 /* A pointer to the formatted diagnostic message. */
32 #define pp_formatted_text_data(PP) \
33 ((const char *) obstack_base (&pp_base (PP)->buffer->obstack))
35 /* Format an integer given by va_arg (ARG, type-specifier T) where
36 type-specifier is a precision modifier as indicated by PREC. F is
37 a string used to construct the appropriate format-specifier. */
38 #define pp_integer_with_precision(PP, ARG, PREC, T, F) \
43 pp_scalar (PP, "%" F, va_arg (ARG, T)); \
47 pp_scalar (PP, "%l" F, va_arg (ARG, long T)); \
51 pp_scalar (PP, "%" PRINTF_INT64_MODIFIER F, va_arg (ARG, long_long)); \
60 /* Subroutine of pp_set_maximum_length. Set up PRETTY-PRINTER's
61 internal maximum characters per line. */
63 pp_set_real_maximum_length (pretty_printer *pp)
65 /* If we're told not to wrap lines then do the obvious thing. In case
66 we'll emit prefix only once per message, it is appropriate
67 not to increase unnecessarily the line-length cut-off. */
68 if (!pp_is_wrapping_line (pp)
69 || pp_prefixing_rule (pp) == DIAGNOSTICS_SHOW_PREFIX_ONCE
70 || pp_prefixing_rule (pp) == DIAGNOSTICS_SHOW_PREFIX_NEVER)
71 pp->maximum_length = pp_line_cutoff (pp);
74 int prefix_length = pp->prefix ? strlen (pp->prefix) : 0;
75 /* If the prefix is ridiculously too long, output at least
77 if (pp_line_cutoff (pp) - prefix_length < 32)
78 pp->maximum_length = pp_line_cutoff (pp) + 32;
80 pp->maximum_length = pp_line_cutoff (pp);
84 /* Clear PRETTY-PRINTER's output state. */
86 pp_clear_state (pretty_printer *pp)
88 pp->emitted_prefix = false;
89 pp_indentation (pp) = 0;
92 /* Flush the formatted text of PRETTY-PRINTER onto the attached stream. */
94 pp_write_text_to_stream (pretty_printer *pp)
96 const char *text = pp_formatted_text (pp);
97 fputs (text, pp->buffer->stream);
98 pp_clear_output_area (pp);
101 /* Wrap a text delimited by START and END into PRETTY-PRINTER. */
103 pp_wrap_text (pretty_printer *pp, const char *start, const char *end)
105 bool wrapping_line = pp_is_wrapping_line (pp);
109 /* Dump anything bordered by whitespaces. */
111 const char *p = start;
112 while (p != end && !ISBLANK (*p) && *p != '\n')
115 && p - start >= pp_remaining_character_count_for_line (pp))
117 pp_append_text (pp, start, p);
121 if (start != end && ISBLANK (*start))
126 if (start != end && *start == '\n')
134 /* Same as pp_wrap_text but wrap text only when in line-wrapping mode. */
136 pp_maybe_wrap_text (pretty_printer *pp, const char *start, const char *end)
138 if (pp_is_wrapping_line (pp))
139 pp_wrap_text (pp, start, end);
141 pp_append_text (pp, start, end);
144 /* Append to the output area of PRETTY-PRINTER a string specified by its
145 STARTing character and LENGTH. */
147 pp_append_r (pretty_printer *pp, const char *start, int length)
149 obstack_grow (&pp->buffer->obstack, start, length);
150 pp->buffer->line_length += length;
153 /* Insert enough spaces into the output area of PRETTY-PRINTER to bring
154 the column position to the current indentation level, assuming that a
155 newline has just been written to the buffer. */
157 pp_base_indent (pretty_printer *pp)
159 int n = pp_indentation (pp);
162 for (i = 0; i < n; ++i)
166 /* Format a message pointed to by TEXT. The following format specifiers are
167 recognized as being client independent:
168 %d, %i: (signed) integer in base ten.
169 %u: unsigned integer in base ten.
170 %o: unsigned integer in base eight.
171 %x: unsigned integer in base sixteen.
172 %ld, %li, %lo, %lu, %lx: long versions of the above.
173 %lld, %lli, %llo, %llu, %llx: long long versions.
174 %wd, %wi, %wo, %wu, %wx: HOST_WIDE_INT versions.
178 %m: strerror(text->err_no) - does not consume a value from args_ptr.
180 %.*s: a substring the length of which is specified by an integer.
183 pp_base_format_text (pretty_printer *pp, text_info *text)
185 for (; *text->format_spec; ++text->format_spec)
192 const char *p = text->format_spec;
193 while (*p && *p != '%')
195 pp_wrap_text (pp, text->format_spec, p);
196 text->format_spec = p;
199 if (*text->format_spec == '\0')
202 /* We got a '%'. Parse precision modifiers, if any. */
203 switch (*++text->format_spec)
213 while (*++text->format_spec == 'l');
219 /* We don't support precision beyond that of "long long". */
223 switch (*text->format_spec)
226 pp_character (pp, va_arg (*text->args_ptr, int));
232 pp_wide_integer (pp, va_arg (*text->args_ptr, HOST_WIDE_INT));
234 pp_integer_with_precision
235 (pp, *text->args_ptr, precision, int, "d");
240 pp_scalar (pp, "%" HOST_WIDE_INT_PRINT "o",
241 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
243 pp_integer_with_precision
244 (pp, *text->args_ptr, precision, unsigned, "u");
248 pp_string (pp, va_arg (*text->args_ptr, const char *));
252 pp_pointer (pp, va_arg (*text->args_ptr, void *));
257 pp_scalar (pp, HOST_WIDE_INT_PRINT_UNSIGNED,
258 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
260 pp_integer_with_precision
261 (pp, *text->args_ptr, precision, unsigned, "u");
266 pp_scalar (pp, HOST_WIDE_INT_PRINT_HEX,
267 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
269 pp_integer_with_precision
270 (pp, *text->args_ptr, precision, unsigned, "x");
274 pp_string (pp, xstrerror (text->err_no));
278 pp_character (pp, '%');
283 const location_t *locus = va_arg (*text->args_ptr, location_t *);
284 pp_string (pp, "file '");
285 pp_string (pp, locus->file);
286 pp_string (pp, "', line ");
287 pp_decimal_int (pp, locus->line);
295 /* We handle no precision specifier but `%.*s'. */
296 if (*++text->format_spec != '*')
298 else if (*++text->format_spec != 's')
300 n = va_arg (*text->args_ptr, int);
301 s = va_arg (*text->args_ptr, const char *);
302 pp_append_text (pp, s, s + n);
307 if (!pp_format_decoder (pp) || !(*pp_format_decoder (pp)) (pp, text))
309 /* Hmmm. The client failed to install a format translator
310 but called us with an unrecognized format. Or, maybe, the
311 translated string just contains an invalid format, or
312 has formats in the wrong order. Sorry. */
319 /* Helper subroutine of output_verbatim and verbatim. Do the appropriate
320 settings needed by BUFFER for a verbatim formatting. */
322 pp_base_format_verbatim (pretty_printer *pp, text_info *text)
324 diagnostic_prefixing_rule_t rule = pp_prefixing_rule (pp);
325 int line_cutoff = pp_line_cutoff (pp);
327 /* Set verbatim mode. */
328 pp->prefixing_rule = DIAGNOSTICS_SHOW_PREFIX_NEVER;
329 pp_line_cutoff (pp) = 0;
330 /* Do the actual formatting. */
331 pp_format_text (pp, text);
332 /* Restore previous settings. */
333 pp_prefixing_rule (pp) = rule;
334 pp_line_cutoff (pp) = line_cutoff;
337 /* Flush the content of BUFFER onto the attached stream. */
339 pp_base_flush (pretty_printer *pp)
341 pp_write_text_to_stream (pp);
343 fputc ('\n', pp->buffer->stream);
344 fflush (pp->buffer->stream);
345 pp_needs_newline (pp) = false;
348 /* Sets the number of maximum characters per line PRETTY-PRINTER can
349 output in line-wrapping mode. A LENGTH value 0 suppresses
352 pp_base_set_line_maximum_length (pretty_printer *pp, int length)
354 pp_line_cutoff (pp) = length;
355 pp_set_real_maximum_length (pp);
358 /* Clear PRETTY-PRINTER output area text info. */
360 pp_base_clear_output_area (pretty_printer *pp)
362 obstack_free (&pp->buffer->obstack, obstack_base (&pp->buffer->obstack));
363 pp->buffer->line_length = 0;
366 /* Set PREFIX for PRETTY-PRINTER. */
368 pp_base_set_prefix (pretty_printer *pp, const char *prefix)
371 pp_set_real_maximum_length (pp);
372 pp->emitted_prefix = false;
373 pp_indentation (pp) = 0;
376 /* Free PRETTY-PRINTER's prefix, a previously malloc()'d string. */
378 pp_base_destroy_prefix (pretty_printer *pp)
380 if (pp->prefix != NULL)
382 free ((char *) pp->prefix);
387 /* Write out PRETTY-PRINTER's prefix. */
389 pp_base_emit_prefix (pretty_printer *pp)
391 if (pp->prefix != NULL)
393 switch (pp_prefixing_rule (pp))
396 case DIAGNOSTICS_SHOW_PREFIX_NEVER:
399 case DIAGNOSTICS_SHOW_PREFIX_ONCE:
400 if (pp->emitted_prefix)
405 pp_indentation (pp) += 3;
408 case DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE:
410 int prefix_length = strlen (pp->prefix);
411 pp_append_r (pp, pp->prefix, prefix_length);
412 pp->emitted_prefix = true;
419 /* Construct a PRETTY-PRINTER with PREFIX and of MAXIMUM_LENGTH
420 characters per line. */
422 pp_construct (pretty_printer *pp, const char *prefix, int maximum_length)
424 memset (pp, 0, sizeof (pretty_printer));
425 pp->buffer = xcalloc (1, sizeof (output_buffer));
426 obstack_init (&pp->buffer->obstack);
427 pp->buffer->stream = stderr;
428 pp_line_cutoff (pp) = maximum_length;
429 pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_ONCE;
430 pp_set_prefix (pp, prefix);
433 /* Append a string delimited by START and END to the output area of
434 PRETTY-PRINTER. No line wrapping is done. However, if beginning a
435 new line then emit PRETTY-PRINTER's prefix and skip any leading
436 whitespace if appropriate. The caller must ensure that it is
439 pp_base_append_text (pretty_printer *pp, const char *start, const char *end)
441 /* Emit prefix and skip whitespace if we're starting a new line. */
442 if (pp->buffer->line_length == 0)
445 if (pp_is_wrapping_line (pp))
446 while (start != end && *start == ' ')
449 pp_append_r (pp, start, end - start);
452 /* Finishes constructing a NULL-terminated character string representing
453 the PRETTY-PRINTED text. */
455 pp_base_formatted_text (pretty_printer *pp)
457 obstack_1grow (&pp->buffer->obstack, '\0');
458 return pp_formatted_text_data (pp);
461 /* Return a pointer to the last character emitted in PRETTY-PRINTER's
462 output area. A NULL pointer means no character available. */
464 pp_base_last_position_in_text (const pretty_printer *pp)
466 const char *p = NULL;
467 struct obstack *text = &pp->buffer->obstack;
469 if (obstack_base (text) != obstack_next_free (text))
470 p = ((const char *) obstack_next_free (text)) - 1;
474 /* Return the amount of characters PRETTY-PRINTER can accept to
475 make a full line. Meaningful only in line-wrapping mode. */
477 pp_base_remaining_character_count_for_line (pretty_printer *pp)
479 return pp->maximum_length - pp->buffer->line_length;
483 /* Format a message into BUFFER a la printf. */
485 pp_printf (pretty_printer *pp, const char *msg, ...)
493 text.format_spec = msg;
494 pp_format_text (pp, &text);
499 /* Output MESSAGE verbatim into BUFFER. */
501 pp_verbatim (pretty_printer *pp, const char *msg, ...)
509 text.format_spec = msg;
510 pp_format_verbatim (pp, &text);
516 /* Have PRETTY-PRINTER start a new line. */
518 pp_base_newline (pretty_printer *pp)
520 obstack_1grow (&pp->buffer->obstack, '\n');
521 pp->buffer->line_length = 0;
524 /* Have PRETTY-PRINTER add a CHARACTER. */
526 pp_base_character (pretty_printer *pp, int c)
528 if (pp_is_wrapping_line (pp)
529 && pp_remaining_character_count_for_line (pp) <= 0)
535 obstack_1grow (&pp->buffer->obstack, c);
536 ++pp->buffer->line_length;
539 /* Append a STRING to the output area of PRETTY-PRINTER; the STRING may
540 be line-wrapped if in appropriate mode. */
542 pp_base_string (pretty_printer *pp, const char *str)
544 pp_maybe_wrap_text (pp, str, str + (str ? strlen (str) : 0));