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 "coretypes.h"
27 #include "pretty-print.h"
29 #define obstack_chunk_alloc xmalloc
30 #define obstack_chunk_free free
32 /* A pointer to the formatted diagnostic message. */
33 #define pp_formatted_text_data(PP) \
34 ((const char *) obstack_base (&pp_base (PP)->buffer->obstack))
36 /* Format an integer given by va_arg (ARG, type-specifier T) where
37 type-specifier is a precision modifier as indicated by PREC. F is
38 a string used to construct the appropriate format-specifier. */
39 #define pp_integer_with_precision(PP, ARG, PREC, T, F) \
44 pp_scalar (PP, "%" F, va_arg (ARG, T)); \
48 pp_scalar (PP, "%l" F, va_arg (ARG, long T)); \
52 pp_scalar (PP, "%ll" F, va_arg (ARG, long long T)); \
61 /* Subroutine of pp_set_maximum_length. Set up PRETTY-PRINTER's
62 internal maximum characters per line. */
64 pp_set_real_maximum_length (pretty_printer *pp)
66 /* If we're told not to wrap lines then do the obvious thing. In case
67 we'll emit prefix only once per message, it is appropriate
68 not to increase unnecessarily the line-length cut-off. */
69 if (!pp_is_wrapping_line (pp)
70 || pp_prefixing_rule (pp) == DIAGNOSTICS_SHOW_PREFIX_ONCE
71 || pp_prefixing_rule (pp) == DIAGNOSTICS_SHOW_PREFIX_NEVER)
72 pp->maximum_length = pp_line_cutoff (pp);
75 int prefix_length = pp->prefix ? strlen (pp->prefix) : 0;
76 /* If the prefix is ridiculously too long, output at least
78 if (pp_line_cutoff (pp) - prefix_length < 32)
79 pp->maximum_length = pp_line_cutoff (pp) + 32;
81 pp->maximum_length = pp_line_cutoff (pp);
85 /* Clear PRETTY-PRINTER's output state. */
87 pp_clear_state (pretty_printer *pp)
89 pp->emitted_prefix = false;
90 pp_indentation (pp) = 0;
93 /* Flush the formatted text of PRETTY-PRINTER onto the attached stream. */
95 pp_write_text_to_stream (pretty_printer *pp)
97 const char *text = pp_formatted_text (pp);
98 fputs (text, pp->buffer->stream);
99 pp_clear_output_area (pp);
102 /* Wrap a text delimited by START and END into PRETTY-PRINTER. */
104 pp_wrap_text (pretty_printer *pp, const char *start, const char *end)
106 bool wrapping_line = pp_is_wrapping_line (pp);
110 /* Dump anything bordered by whitespaces. */
112 const char *p = start;
113 while (p != end && !ISBLANK (*p) && *p != '\n')
116 && p - start >= pp_remaining_character_count_for_line (pp))
118 pp_append_text (pp, start, p);
122 if (start != end && ISBLANK (*start))
127 if (start != end && *start == '\n')
135 /* Same as pp_wrap_text but wrap text only when in line-wrapping mode. */
137 pp_maybe_wrap_text (pretty_printer *pp, const char *start, const char *end)
139 if (pp_is_wrapping_line (pp))
140 pp_wrap_text (pp, start, end);
142 pp_append_text (pp, start, end);
145 /* Append to the output area of PRETTY-PRINTER a string specified by its
146 STARTing character and LENGTH. */
148 pp_append_r (pretty_printer *pp, const char *start, int length)
150 obstack_grow (&pp->buffer->obstack, start, length);
151 pp->buffer->line_length += length;
154 /* Insert enough spaces into the output area of PRETTY-PRINTER to bring
155 the column position to the current indentation level, assuming that a
156 newline has just been written to the buffer. */
158 pp_base_indent (pretty_printer *pp)
160 int n = pp_indentation (pp);
163 for (i = 0; i < n; ++i)
167 /* Format a message pointed to by TEXT. The following format specifiers are
168 recognized as being client independent:
169 %d, %i: (signed) integer in base ten.
170 %u: unsigned integer in base ten.
171 %o: unsigned integer in base eight.
172 %x: unsigned integer in base sixteen.
173 %ld, %li, %lo, %lu, %lx: long versions of the above.
174 %lld, %lli, %llo, %llu, %llx: long long versions.
175 %wd, %wi, %wo, %wu, %wx: HOST_WIDE_INT versions.
179 %m: strerror(text->err_no) - does not consume a value from args_ptr.
181 %*.s: a substring the length of which is specified by an integer.
184 pp_base_format_text (pretty_printer *pp, text_info *text)
186 for (; *text->format_spec; ++text->format_spec)
193 const char *p = text->format_spec;
194 while (*p && *p != '%')
196 pp_wrap_text (pp, text->format_spec, p);
197 text->format_spec = p;
200 if (*text->format_spec == '\0')
203 /* We got a '%'. Parse precision modifiers, if any. */
204 switch (*++text->format_spec)
214 while (*++text->format_spec == 'l');
220 /* We don't support precision beyond that of "long long". */
224 switch (*text->format_spec)
227 pp_character (pp, va_arg (*text->args_ptr, int));
233 pp_wide_integer (pp, va_arg (*text->args_ptr, HOST_WIDE_INT));
235 pp_integer_with_precision
236 (pp, *text->args_ptr, precision, int, "d");
241 pp_scalar (pp, "%" HOST_WIDE_INT_PRINT "o",
242 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
244 pp_integer_with_precision
245 (pp, *text->args_ptr, precision, unsigned, "u");
249 pp_string (pp, va_arg (*text->args_ptr, const char *));
253 pp_pointer (pp, va_arg (*text->args_ptr, void *));
258 pp_scalar (pp, HOST_WIDE_INT_PRINT_UNSIGNED,
259 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
261 pp_integer_with_precision
262 (pp, *text->args_ptr, precision, unsigned, "u");
267 pp_scalar (pp, HOST_WIDE_INT_PRINT_HEX,
268 va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
270 pp_integer_with_precision
271 (pp, *text->args_ptr, precision, unsigned, "x");
275 pp_string (pp, xstrerror (text->err_no));
279 pp_character (pp, '%');
284 const location_t *locus = va_arg (*text->args_ptr, location_t *);
285 pp_string (pp, "file '");
286 pp_string (pp, locus->file);
287 pp_string (pp, "', line ");
288 pp_decimal_int (pp, locus->line);
296 /* We handle no precision specifier but `%.*s'. */
297 if (*++text->format_spec != '*')
299 else if (*++text->format_spec != 's')
301 n = va_arg (*text->args_ptr, int);
302 s = va_arg (*text->args_ptr, const char *);
303 pp_append_text (pp, s, s + n);
308 if (!pp_format_decoder (pp) || !(*pp_format_decoder (pp)) (pp, text))
310 /* Hmmm. The client failed to install a format translator
311 but called us with an unrecognized format. Or, maybe, the
312 translated string just contains an invalid format, or
313 has formats in the wrong order. Sorry. */
320 /* Helper subroutine of output_verbatim and verbatim. Do the appropriate
321 settings needed by BUFFER for a verbatim formatting. */
323 pp_base_format_verbatim (pretty_printer *pp, text_info *text)
325 diagnostic_prefixing_rule_t rule = pp_prefixing_rule (pp);
326 int line_cutoff = pp_line_cutoff (pp);
328 /* Set verbatim mode. */
329 pp->prefixing_rule = DIAGNOSTICS_SHOW_PREFIX_NEVER;
330 pp_line_cutoff (pp) = 0;
331 /* Do the actual formatting. */
332 pp_format_text (pp, text);
333 /* Restore previous settings. */
334 pp_prefixing_rule (pp) = rule;
335 pp_line_cutoff (pp) = line_cutoff;
338 /* Flush the content of BUFFER onto the attached stream. */
340 pp_base_flush (pretty_printer *pp)
342 pp_write_text_to_stream (pp);
344 fputc ('\n', pp->buffer->stream);
345 fflush (pp->buffer->stream);
346 pp_needs_newline (pp) = false;
349 /* Sets the number of maximum characters per line PRETTY-PRINTER can
350 output in line-wrapping mode. A LENGTH value 0 suppresses
353 pp_base_set_line_maximum_length (pretty_printer *pp, int length)
355 pp_line_cutoff (pp) = length;
356 pp_set_real_maximum_length (pp);
359 /* Clear PRETTY-PRINTER output area text info. */
361 pp_base_clear_output_area (pretty_printer *pp)
363 obstack_free (&pp->buffer->obstack, obstack_base (&pp->buffer->obstack));
364 pp->buffer->line_length = 0;
367 /* Set PREFIX for PRETTY-PRINTER. */
369 pp_base_set_prefix (pretty_printer *pp, const char *prefix)
372 pp_set_real_maximum_length (pp);
373 pp->emitted_prefix = false;
374 pp_indentation (pp) = 0;
377 /* Free PRETTY-PRINTER's prefix, a previously malloc()'d string. */
379 pp_base_destroy_prefix (pretty_printer *pp)
381 if (pp->prefix != NULL)
383 free ((char *) pp->prefix);
388 /* Write out PRETTY-PRINTER's prefix. */
390 pp_base_emit_prefix (pretty_printer *pp)
392 if (pp->prefix != NULL)
394 switch (pp_prefixing_rule (pp))
397 case DIAGNOSTICS_SHOW_PREFIX_NEVER:
400 case DIAGNOSTICS_SHOW_PREFIX_ONCE:
401 if (pp->emitted_prefix)
406 pp_indentation (pp) += 3;
409 case DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE:
411 int prefix_length = strlen (pp->prefix);
412 pp_append_r (pp, pp->prefix, prefix_length);
413 pp->emitted_prefix = true;
420 /* Construct a PRETTY-PRINTER with PREFIX and of MAXIMUM_LENGTH
421 characters per line. */
423 pp_construct (pretty_printer *pp, const char *prefix, int maximum_length)
425 memset (pp, 0, sizeof (pretty_printer));
426 pp->buffer = xcalloc (1, sizeof (output_buffer));
427 obstack_init (&pp->buffer->obstack);
428 pp->buffer->stream = stderr;
429 pp_line_cutoff (pp) = maximum_length;
430 pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_ONCE;
431 pp_set_prefix (pp, prefix);
434 /* Append a string delimited by START and END to the output area of
435 PRETTY-PRINTER. No line wrapping is done. However, if beginning a
436 new line then emit PRETTY-PRINTER's prefix and skip any leading
437 whitespace if appropriate. The caller must ensure that it is
440 pp_base_append_text (pretty_printer *pp, const char *start, const char *end)
442 /* Emit prefix and skip whitespace if we're starting a new line. */
443 if (pp->buffer->line_length == 0)
446 if (pp_is_wrapping_line (pp))
447 while (start != end && *start == ' ')
450 pp_append_r (pp, start, end - start);
453 /* Finishes constructing a NULL-terminated character string representing
454 the PRETTY-PRINTED text. */
456 pp_base_formatted_text (pretty_printer *pp)
458 obstack_1grow (&pp->buffer->obstack, '\0');
459 return pp_formatted_text_data (pp);
462 /* Return a pointer to the last character emitted in PRETTY-PRINTER's
463 output area. A NULL pointer means no character available. */
465 pp_base_last_position_in_text (const pretty_printer *pp)
467 const char *p = NULL;
468 struct obstack *text = &pp->buffer->obstack;
470 if (obstack_base (text) != obstack_next_free (text))
471 p = ((const char *) obstack_next_free (text)) - 1;
475 /* Return the amount of characters PRETTY-PRINTER can accept to
476 make a full line. Meaningful only in line-wrapping mode. */
478 pp_base_remaining_character_count_for_line (pretty_printer *pp)
480 return pp->maximum_length - pp->buffer->line_length;
484 /* Format a message into BUFFER a la printf. */
486 pp_printf (pretty_printer *pp, const char *msg, ...)
494 text.format_spec = msg;
495 pp_format_text (pp, &text);
500 /* Output MESSAGE verbatim into BUFFER. */
502 pp_verbatim (pretty_printer *pp, const char *msg, ...)
510 text.format_spec = msg;
511 pp_format_verbatim (pp, &text);
517 /* Have PRETTY-PRINTER start a new line. */
519 pp_base_newline (pretty_printer *pp)
521 obstack_1grow (&pp->buffer->obstack, '\n');
522 pp->buffer->line_length = 0;
525 /* Have PRETTY-PRINTER add a CHARACTER. */
527 pp_base_character (pretty_printer *pp, int c)
529 if (pp_is_wrapping_line (pp)
530 && pp_remaining_character_count_for_line (pp) <= 0)
536 obstack_1grow (&pp->buffer->obstack, c);
537 ++pp->buffer->line_length;
540 /* Append a STRING to the output area of PRETTY-PRINTER; the STRING may
541 be line-wrapped if in appropriate mode. */
543 pp_base_string (pretty_printer *pp, const char *str)
545 pp_maybe_wrap_text (pp, str, str + (str ? strlen (str) : 0));
548 /* Maybe print out a whitespace if needed. */
551 pp_base_maybe_space (pretty_printer *pp)
553 if (pp_base (pp)->padding != pp_none)
556 pp_base (pp)->padding = pp_none;