gcc/pretty-print.c

   1 /* Various declarations for language-independent pretty-print subroutines.
   2    Copyright (C) 2003, 2004, 2005, 2007 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 #include "config.h"
  22 #undef FLOAT /* This is for hpux. They should change hpux.  */
  23 #undef FFS  /* Some systems define this in param.h.  */
  24 #include "system.h"
  25 #include "coretypes.h"
  26 #include "intl.h"
  27 #include "pretty-print.h"
  28 #include "tree.h"
  29
  30 #define obstack_chunk_alloc xmalloc
  31 #define obstack_chunk_free  free
  32
  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))
  36
  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)       \
  41   do                                                         \
  42     switch (PREC)                                            \
  43       {                                                      \
  44       case 0:                                                \
  45         pp_scalar (PP, "%" F, va_arg (ARG, T));              \
  46         break;                                               \
  47                                                              \
  48       case 1:                                                \
  49         pp_scalar (PP, "%l" F, va_arg (ARG, long T));        \
  50         break;                                               \
  51                                                              \
  52       case 2:                                                \
  53         pp_scalar (PP, "%ll" F, va_arg (ARG, long long T));  \
  54         break;                                               \
  55                                                              \
  56       default:                                               \
  57         break;                                               \
  58       }                                                      \
  59   while (0)
  60
  61
  62 /* Subroutine of pp_set_maximum_length.  Set up PRETTY-PRINTER's
  63    internal maximum characters per line.  */
  64 static void
  65 pp_set_real_maximum_length (pretty_printer *pp)
  66 {
  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);
  74   else
  75     {
  76       int prefix_length = pp->prefix ? strlen (pp->prefix) : 0;
  77       /* If the prefix is ridiculously too long, output at least
  78          32 characters.  */
  79       if (pp_line_cutoff (pp) - prefix_length < 32)
  80         pp->maximum_length = pp_line_cutoff (pp) + 32;
  81       else
  82         pp->maximum_length = pp_line_cutoff (pp);
  83     }
  84 }
  85
  86 /* Clear PRETTY-PRINTER's output state.  */
  87 static inline void
  88 pp_clear_state (pretty_printer *pp)
  89 {
  90   pp->emitted_prefix = false;
  91   pp_indentation (pp) = 0;
  92 }
  93
  94 /* Flush the formatted text of PRETTY-PRINTER onto the attached stream.  */
  95 void
  96 pp_write_text_to_stream (pretty_printer *pp)
  97 {
  98   const char *text = pp_formatted_text (pp);
  99   fputs (text, pp->buffer->stream);
 100   pp_clear_output_area (pp);
 101 }
 102
 103 /* Wrap a text delimited by START and END into PRETTY-PRINTER.  */
 104 static void
 105 pp_wrap_text (pretty_printer *pp, const char *start, const char *end)
 106 {
 107   bool wrapping_line = pp_is_wrapping_line (pp);
 108
 109   while (start != end)
 110     {
 111       /* Dump anything bordered by whitespaces.  */
 112       {
 113         const char *p = start;
 114         while (p != end && !ISBLANK (*p) && *p != '\n')
 115           ++p;
 116         if (wrapping_line
 117             && p - start >= pp_remaining_character_count_for_line (pp))
 118           pp_newline (pp);
 119         pp_append_text (pp, start, p);
 120         start = p;
 121       }
 122
 123       if (start != end && ISBLANK (*start))
 124         {
 125           pp_space (pp);
 126           ++start;
 127         }
 128       if (start != end && *start == '\n')
 129         {
 130           pp_newline (pp);
 131           ++start;
 132         }
 133     }
 134 }
 135
 136 /* Same as pp_wrap_text but wrap text only when in line-wrapping mode.  */
 137 static inline void
 138 pp_maybe_wrap_text (pretty_printer *pp, const char *start, const char *end)
 139 {
 140   if (pp_is_wrapping_line (pp))
 141     pp_wrap_text (pp, start, end);
 142   else
 143     pp_append_text (pp, start, end);
 144 }
 145
 146 /* Append to the output area of PRETTY-PRINTER a string specified by its
 147    STARTing character and LENGTH.  */
 148 static inline void
 149 pp_append_r (pretty_printer *pp, const char *start, int length)
 150 {
 151   obstack_grow (pp->buffer->obstack, start, length);
 152   pp->buffer->line_length += length;
 153 }
 154
 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.  */
 158 void
 159 pp_base_indent (pretty_printer *pp)
 160 {
 161   int n = pp_indentation (pp);
 162   int i;
 163
 164   for (i = 0; i < n; ++i)
 165     pp_space (pp);
 166 }
 167
 168 /* The following format specifiers are 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.
 176    %c: character.
 177    %s: string.
 178    %p: pointer.
 179    %m: strerror(text->err_no) - does not consume a value from args_ptr.
 180    %%: '%'.
 181    %<: opening quote.
 182    %>: closing quote.
 183    %': apostrophe (should only be used in untranslated messages;
 184        translations should use appropriate punctuation directly).
 185    %.*s: a substring the length of which is specified by an argument
 186          integer.
 187    %Ns: likewise, but length specified as constant in the format string.
 188    %H: location_t.
 189    %J: a decl tree, from which DECL_SOURCE_LOCATION will be recorded.
 190    %K: a statement, from which EXPR_LOCATION and TREE_BLOCK will be recorded.
 191    Flag 'q': quote formatted text (must come immediately after '%').
 192
 193    Arguments can be used sequentially, or through %N$ resp. *N$
 194    notation Nth argument after the format string.  If %N$ / *N$
 195    notation is used, it must be used for all arguments, except %m, %%,
 196    %<, %> and %', which may not have a number, as they do not consume
 197    an argument.  When %M$.*N$s is used, M must be N + 1.  (This may
 198    also be written %M$.*s, provided N is not otherwise used.)  The
 199    format string must have conversion specifiers with argument numbers
 200    1 up to highest argument; each argument may only be used once.
 201    A format string can have at most 30 arguments.  */
 202
 203 /* Formatting phases 1 and 2: render TEXT->format_spec plus
 204    TEXT->args_ptr into a series of chunks in PP->buffer->args[].
 205    Phase 3 is in pp_base_format_text.  */
 206
 207 void
 208 pp_base_format (pretty_printer *pp, text_info *text)
 209 {
 210   output_buffer *buffer = pp->buffer;
 211   const char *p;
 212   const char **args;
 213   struct chunk_info *new_chunk_array;
 214
 215   unsigned int curarg = 0, chunk = 0, argno;
 216   pp_wrapping_mode_t old_wrapping_mode;
 217   bool any_unnumbered = false, any_numbered = false;
 218   const char **formatters[PP_NL_ARGMAX];
 219
 220   /* Allocate a new chunk structure.  */
 221   new_chunk_array = XOBNEW (&buffer->chunk_obstack, struct chunk_info);
 222   new_chunk_array->prev = buffer->cur_chunk_array;
 223   buffer->cur_chunk_array = new_chunk_array;
 224   args = new_chunk_array->args;
 225
 226   /* Formatting phase 1: split up TEXT->format_spec into chunks in
 227      PP->buffer->args[].  Even-numbered chunks are to be output
 228      verbatim, odd-numbered chunks are format specifiers.
 229      %m, %%, %<, %>, and %' are replaced with the appropriate text at
 230      this point.  */
 231
 232   memset (formatters, 0, sizeof formatters);
 233
 234   for (p = text->format_spec; *p; )
 235     {
 236       while (*p != '\0' && *p != '%')
 237         {
 238           obstack_1grow (&buffer->chunk_obstack, *p);
 239           p++;
 240         }
 241
 242       if (*p == '\0')
 243         break;
 244
 245       switch (*++p)
 246         {
 247         case '\0':
 248           gcc_unreachable ();
 249
 250         case '%':
 251           obstack_1grow (&buffer->chunk_obstack, '%');
 252           p++;
 253           continue;
 254
 255         case '<':
 256           obstack_grow (&buffer->chunk_obstack,
 257                         open_quote, strlen (open_quote));
 258           p++;
 259           continue;
 260
 261         case '>':
 262         case '\'':
 263           obstack_grow (&buffer->chunk_obstack,
 264                         close_quote, strlen (close_quote));
 265           p++;
 266           continue;
 267
 268         case 'm':
 269           {
 270             const char *errstr = xstrerror (text->err_no);
 271             obstack_grow (&buffer->chunk_obstack, errstr, strlen (errstr));
 272           }
 273           p++;
 274           continue;
 275
 276         default:
 277           /* Handled in phase 2.  Terminate the plain chunk here.  */
 278           obstack_1grow (&buffer->chunk_obstack, '\0');
 279           gcc_assert (chunk < PP_NL_ARGMAX * 2);
 280           args[chunk++] = XOBFINISH (&buffer->chunk_obstack, const char *);
 281           break;
 282         }
 283
 284       if (ISDIGIT (*p))
 285         {
 286           char *end;
 287           argno = strtoul (p, &end, 10) - 1;
 288           p = end;
 289           gcc_assert (*p == '$');
 290           p++;
 291
 292           any_numbered = true;
 293           gcc_assert (!any_unnumbered);
 294         }
 295       else
 296         {
 297           argno = curarg++;
 298           any_unnumbered = true;
 299           gcc_assert (!any_numbered);
 300         }
 301       gcc_assert (argno < PP_NL_ARGMAX);
 302       gcc_assert (!formatters[argno]);
 303       formatters[argno] = &args[chunk];
 304       do
 305         {
 306           obstack_1grow (&buffer->chunk_obstack, *p);
 307           p++;
 308         }
 309       while (strchr ("qwl+#", p[-1]));
 310
 311       if (p[-1] == '.')
 312         {
 313           /* We handle '%.Ns' and '%.*s' or '%M$.*N$s'
 314              (where M == N + 1).  */
 315           if (ISDIGIT (*p))
 316             {
 317               do
 318                 {
 319                   obstack_1grow (&buffer->chunk_obstack, *p);
 320                   p++;
 321                 }
 322               while (ISDIGIT (p[-1]));
 323               gcc_assert (p[-1] == 's');
 324             }
 325           else
 326             {
 327               gcc_assert (*p == '*');
 328               obstack_1grow (&buffer->chunk_obstack, '*');
 329               p++;
 330
 331               if (ISDIGIT (*p))
 332                 {
 333                   char *end;
 334                   unsigned int argno2 = strtoul (p, &end, 10) - 1;
 335                   p = end;
 336                   gcc_assert (argno2 == argno - 1);
 337                   gcc_assert (!any_unnumbered);
 338                   gcc_assert (*p == '$');
 339
 340                   p++;
 341                   formatters[argno2] = formatters[argno];
 342                 }
 343               else
 344                 {
 345                   gcc_assert (!any_numbered);
 346                   formatters[argno+1] = formatters[argno];
 347                   curarg++;
 348                 }
 349               gcc_assert (*p == 's');
 350               obstack_1grow (&buffer->chunk_obstack, 's');
 351               p++;
 352             }
 353         }
 354       if (*p == '\0')
 355         break;
 356
 357       obstack_1grow (&buffer->chunk_obstack, '\0');
 358       gcc_assert (chunk < PP_NL_ARGMAX * 2);
 359       args[chunk++] = XOBFINISH (&buffer->chunk_obstack, const char *);
 360     }
 361
 362   obstack_1grow (&buffer->chunk_obstack, '\0');
 363   gcc_assert (chunk < PP_NL_ARGMAX * 2);
 364   args[chunk++] = XOBFINISH (&buffer->chunk_obstack, const char *);
 365   args[chunk] = 0;
 366
 367   /* Set output to the argument obstack, and switch line-wrapping and
 368      prefixing off.  */
 369   buffer->obstack = &buffer->chunk_obstack;
 370   old_wrapping_mode = pp_set_verbatim_wrapping (pp);
 371
 372   /* Second phase.  Replace each formatter with the formatted text it
 373      corresponds to.  */
 374
 375   for (argno = 0; formatters[argno]; argno++)
 376     {
 377       int precision = 0;
 378       bool wide = false;
 379       bool plus = false;
 380       bool hash = false;
 381       bool quote = false;
 382
 383       /* We do not attempt to enforce any ordering on the modifier
 384          characters.  */
 385
 386       for (p = *formatters[argno];; p++)
 387         {
 388           switch (*p)
 389             {
 390             case 'q':
 391               gcc_assert (!quote);
 392               quote = true;
 393               continue;
 394
 395             case '+':
 396               gcc_assert (!plus);
 397               plus = true;
 398               continue;
 399
 400             case '#':
 401               gcc_assert (!hash);
 402               hash = true;
 403               continue;
 404
 405             case 'w':
 406               gcc_assert (!wide);
 407               wide = true;
 408               continue;
 409
 410             case 'l':
 411               /* We don't support precision beyond that of "long long".  */
 412               gcc_assert (precision < 2);
 413               precision++;
 414               continue;
 415             }
 416           break;
 417         }
 418
 419       gcc_assert (!wide || precision == 0);
 420
 421       if (quote)
 422         pp_string (pp, open_quote);
 423
 424       switch (*p)
 425         {
 426         case 'c':
 427           pp_character (pp, va_arg (*text->args_ptr, int));
 428           break;
 429
 430         case 'd':
 431         case 'i':
 432           if (wide)
 433             pp_wide_integer (pp, va_arg (*text->args_ptr, HOST_WIDE_INT));
 434           else
 435             pp_integer_with_precision
 436               (pp, *text->args_ptr, precision, int, "d");
 437           break;
 438
 439         case 'o':
 440           if (wide)
 441             pp_scalar (pp, "%" HOST_WIDE_INT_PRINT "o",
 442                        va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
 443           else
 444             pp_integer_with_precision
 445               (pp, *text->args_ptr, precision, unsigned, "o");
 446           break;
 447
 448         case 's':
 449           pp_string (pp, va_arg (*text->args_ptr, const char *));
 450           break;
 451
 452         case 'p':
 453           pp_pointer (pp, va_arg (*text->args_ptr, void *));
 454           break;
 455
 456         case 'u':
 457           if (wide)
 458             pp_scalar (pp, HOST_WIDE_INT_PRINT_UNSIGNED,
 459                        va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
 460           else
 461             pp_integer_with_precision
 462               (pp, *text->args_ptr, precision, unsigned, "u");
 463           break;
 464
 465         case 'x':
 466           if (wide)
 467             pp_scalar (pp, HOST_WIDE_INT_PRINT_HEX,
 468                        va_arg (*text->args_ptr, unsigned HOST_WIDE_INT));
 469           else
 470             pp_integer_with_precision
 471               (pp, *text->args_ptr, precision, unsigned, "x");
 472           break;
 473
 474         case 'H':
 475           {
 476             location_t *locus = va_arg (*text->args_ptr, location_t *);
 477             gcc_assert (text->locus != NULL);
 478             *text->locus = *locus;
 479           }
 480           break;
 481
 482         case 'J':
 483           {
 484             tree t = va_arg (*text->args_ptr, tree);
 485             gcc_assert (text->locus != NULL);
 486             *text->locus = DECL_SOURCE_LOCATION (t);
 487           }
 488           break;
 489
 490         case 'K':
 491           {
 492             tree t = va_arg (*text->args_ptr, tree), block;
 493             gcc_assert (text->locus != NULL);
 494             *text->locus = EXPR_LOCATION (t);
 495             gcc_assert (text->abstract_origin != NULL);
 496             block = TREE_BLOCK (t);
 497             *text->abstract_origin = NULL;
 498             while (block
 499                    && TREE_CODE (block) == BLOCK
 500                    && BLOCK_ABSTRACT_ORIGIN (block))
 501               {
 502                 tree ao = BLOCK_ABSTRACT_ORIGIN (block);
 503
 504                 while (TREE_CODE (ao) == BLOCK && BLOCK_ABSTRACT_ORIGIN (ao))
 505                   ao = BLOCK_ABSTRACT_ORIGIN (ao);
 506
 507                 if (TREE_CODE (ao) == FUNCTION_DECL)
 508                   {
 509                     *text->abstract_origin = block;
 510                     break;
 511                   }
 512                 block = BLOCK_SUPERCONTEXT (block);
 513               }
 514           }
 515           break;
 516
 517         case '.':
 518           {
 519             int n;
 520             const char *s;
 521
 522             /* We handle '%.Ns' and '%.*s' or '%M$.*N$s'
 523                (where M == N + 1).  The format string should be verified
 524                already from the first phase.  */
 525             p++;
 526             if (ISDIGIT (*p))
 527               {
 528                 char *end;
 529                 n = strtoul (p, &end, 10);
 530                 p = end;
 531                 gcc_assert (*p == 's');
 532               }
 533             else
 534               {
 535                 gcc_assert (*p == '*');
 536                 p++;
 537                 gcc_assert (*p == 's');
 538                 n = va_arg (*text->args_ptr, int);
 539
 540                 /* This consumes a second entry in the formatters array.  */
 541                 gcc_assert (formatters[argno] == formatters[argno+1]);
 542                 argno++;
 543               }
 544
 545             s = va_arg (*text->args_ptr, const char *);
 546             pp_append_text (pp, s, s + n);
 547           }
 548           break;
 549
 550         default:
 551           {
 552             bool ok;
 553
 554             gcc_assert (pp_format_decoder (pp));
 555             ok = pp_format_decoder (pp) (pp, text, p,
 556                                          precision, wide, plus, hash);
 557             gcc_assert (ok);
 558           }
 559         }
 560
 561       if (quote)
 562         pp_string (pp, close_quote);
 563
 564       obstack_1grow (&buffer->chunk_obstack, '\0');
 565       *formatters[argno] = XOBFINISH (&buffer->chunk_obstack, const char *);
 566     }
 567
 568 #ifdef ENABLE_CHECKING
 569   for (; argno < PP_NL_ARGMAX; argno++)
 570     gcc_assert (!formatters[argno]);
 571 #endif
 572
 573   /* Revert to normal obstack and wrapping mode.  */
 574   buffer->obstack = &buffer->formatted_obstack;
 575   buffer->line_length = 0;
 576   pp_wrapping_mode (pp) = old_wrapping_mode;
 577   pp_clear_state (pp);
 578 }
 579
 580 /* Format of a message pointed to by TEXT.  */
 581 void
 582 pp_base_output_formatted_text (pretty_printer *pp)
 583 {
 584   unsigned int chunk;
 585   output_buffer *buffer = pp_buffer (pp);
 586   struct chunk_info *chunk_array = buffer->cur_chunk_array;
 587   const char **args = chunk_array->args;
 588
 589   gcc_assert (buffer->obstack == &buffer->formatted_obstack);
 590   gcc_assert (buffer->line_length == 0);
 591
 592   /* This is a third phase, first 2 phases done in pp_base_format_args.
 593      Now we actually print it.  */
 594   for (chunk = 0; args[chunk]; chunk++)
 595     pp_string (pp, args[chunk]);
 596
 597   /* Deallocate the chunk structure and everything after it (i.e. the
 598      associated series of formatted strings).  */
 599   buffer->cur_chunk_array = chunk_array->prev;
 600   obstack_free (&buffer->chunk_obstack, chunk_array);
 601 }
 602
 603 /* Helper subroutine of output_verbatim and verbatim. Do the appropriate
 604    settings needed by BUFFER for a verbatim formatting.  */
 605 void
 606 pp_base_format_verbatim (pretty_printer *pp, text_info *text)
 607 {
 608   /* Set verbatim mode.  */
 609   pp_wrapping_mode_t oldmode = pp_set_verbatim_wrapping (pp);
 610
 611   /* Do the actual formatting.  */
 612   pp_format (pp, text);
 613   pp_output_formatted_text (pp);
 614
 615   /* Restore previous settings.  */
 616   pp_wrapping_mode (pp) = oldmode;
 617 }
 618
 619 /* Flush the content of BUFFER onto the attached stream.  */
 620 void
 621 pp_base_flush (pretty_printer *pp)
 622 {
 623   pp_write_text_to_stream (pp);
 624   pp_clear_state (pp);
 625   fputc ('\n', pp->buffer->stream);
 626   fflush (pp->buffer->stream);
 627   pp_needs_newline (pp) = false;
 628 }
 629
 630 /* Sets the number of maximum characters per line PRETTY-PRINTER can
 631    output in line-wrapping mode.  A LENGTH value 0 suppresses
 632    line-wrapping.  */
 633 void
 634 pp_base_set_line_maximum_length (pretty_printer *pp, int length)
 635 {
 636   pp_line_cutoff (pp) = length;
 637   pp_set_real_maximum_length (pp);
 638 }
 639
 640 /* Clear PRETTY-PRINTER output area text info.  */
 641 void
 642 pp_base_clear_output_area (pretty_printer *pp)
 643 {
 644   obstack_free (pp->buffer->obstack, obstack_base (pp->buffer->obstack));
 645   pp->buffer->line_length = 0;
 646 }
 647
 648 /* Set PREFIX for PRETTY-PRINTER.  */
 649 void
 650 pp_base_set_prefix (pretty_printer *pp, const char *prefix)
 651 {
 652   pp->prefix = prefix;
 653   pp_set_real_maximum_length (pp);
 654   pp->emitted_prefix = false;
 655   pp_indentation (pp) = 0;
 656 }
 657
 658 /* Free PRETTY-PRINTER's prefix, a previously malloc()'d string.  */
 659 void
 660 pp_base_destroy_prefix (pretty_printer *pp)
 661 {
 662   if (pp->prefix != NULL)
 663     {
 664       free (CONST_CAST (char *, pp->prefix));
 665       pp->prefix = NULL;
 666     }
 667 }
 668
 669 /* Write out PRETTY-PRINTER's prefix.  */
 670 void
 671 pp_base_emit_prefix (pretty_printer *pp)
 672 {
 673   if (pp->prefix != NULL)
 674     {
 675       switch (pp_prefixing_rule (pp))
 676         {
 677         default:
 678         case DIAGNOSTICS_SHOW_PREFIX_NEVER:
 679           break;
 680
 681         case DIAGNOSTICS_SHOW_PREFIX_ONCE:
 682           if (pp->emitted_prefix)
 683             {
 684               pp_base_indent (pp);
 685               break;
 686             }
 687           pp_indentation (pp) += 3;
 688           /* Fall through.  */
 689
 690         case DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE:
 691           {
 692             int prefix_length = strlen (pp->prefix);
 693             pp_append_r (pp, pp->prefix, prefix_length);
 694             pp->emitted_prefix = true;
 695           }
 696           break;
 697         }
 698     }
 699 }
 700
 701 /* Construct a PRETTY-PRINTER with PREFIX and of MAXIMUM_LENGTH
 702    characters per line.  */
 703 void
 704 pp_construct (pretty_printer *pp, const char *prefix, int maximum_length)
 705 {
 706   memset (pp, 0, sizeof (pretty_printer));
 707   pp->buffer = XCNEW (output_buffer);
 708   obstack_init (&pp->buffer->chunk_obstack);
 709   obstack_init (&pp->buffer->formatted_obstack);
 710   pp->buffer->obstack = &pp->buffer->formatted_obstack;
 711   pp->buffer->stream = stderr;
 712   pp_line_cutoff (pp) = maximum_length;
 713   pp_prefixing_rule (pp) = DIAGNOSTICS_SHOW_PREFIX_ONCE;
 714   pp_set_prefix (pp, prefix);
 715 }
 716
 717 /* Append a string delimited by START and END to the output area of
 718    PRETTY-PRINTER.  No line wrapping is done.  However, if beginning a
 719    new line then emit PRETTY-PRINTER's prefix and skip any leading
 720    whitespace if appropriate.  The caller must ensure that it is
 721    safe to do so.  */
 722 void
 723 pp_base_append_text (pretty_printer *pp, const char *start, const char *end)
 724 {
 725   /* Emit prefix and skip whitespace if we're starting a new line.  */
 726   if (pp->buffer->line_length == 0)
 727     {
 728       pp_emit_prefix (pp);
 729       if (pp_is_wrapping_line (pp))
 730         while (start != end && *start == ' ')
 731           ++start;
 732     }
 733   pp_append_r (pp, start, end - start);
 734 }
 735
 736 /* Finishes constructing a NULL-terminated character string representing
 737    the PRETTY-PRINTED text.  */
 738 const char *
 739 pp_base_formatted_text (pretty_printer *pp)
 740 {
 741   obstack_1grow (pp->buffer->obstack, '\0');
 742   return pp_formatted_text_data (pp);
 743 }
 744
 745 /*  Return a pointer to the last character emitted in PRETTY-PRINTER's
 746     output area.  A NULL pointer means no character available.  */
 747 const char *
 748 pp_base_last_position_in_text (const pretty_printer *pp)
 749 {
 750   const char *p = NULL;
 751   struct obstack *text = pp->buffer->obstack;
 752
 753   if (obstack_base (text) != obstack_next_free (text))
 754     p = ((const char *) obstack_next_free (text)) - 1;
 755   return p;
 756 }
 757
 758 /* Return the amount of characters PRETTY-PRINTER can accept to
 759    make a full line.  Meaningful only in line-wrapping mode.  */
 760 int
 761 pp_base_remaining_character_count_for_line (pretty_printer *pp)
 762 {
 763   return pp->maximum_length - pp->buffer->line_length;
 764 }
 765
 766
 767 /* Format a message into BUFFER a la printf.  */
 768 void
 769 pp_printf (pretty_printer *pp, const char *msg, ...)
 770 {
 771   text_info text;
 772   va_list ap;
 773
 774   va_start (ap, msg);
 775   text.err_no = errno;
 776   text.args_ptr = &ap;
 777   text.format_spec = msg;
 778   text.locus = NULL;
 779   pp_format (pp, &text);
 780   pp_output_formatted_text (pp);
 781   va_end (ap);
 782 }
 783
 784
 785 /* Output MESSAGE verbatim into BUFFER.  */
 786 void
 787 pp_verbatim (pretty_printer *pp, const char *msg, ...)
 788 {
 789   text_info text;
 790   va_list ap;
 791
 792   va_start (ap, msg);
 793   text.err_no = errno;
 794   text.args_ptr = &ap;
 795   text.format_spec = msg;
 796   text.locus = NULL;
 797   pp_format_verbatim (pp, &text);
 798   va_end (ap);
 799 }
 800
 801
 802
 803 /* Have PRETTY-PRINTER start a new line.  */
 804 void
 805 pp_base_newline (pretty_printer *pp)
 806 {
 807   obstack_1grow (pp->buffer->obstack, '\n');
 808   pp->buffer->line_length = 0;
 809 }
 810
 811 /* Have PRETTY-PRINTER add a CHARACTER.  */
 812 void
 813 pp_base_character (pretty_printer *pp, int c)
 814 {
 815   if (pp_is_wrapping_line (pp)
 816       && pp_remaining_character_count_for_line (pp) <= 0)
 817     {
 818       pp_newline (pp);
 819       if (ISSPACE (c))
 820         return;
 821     }
 822   obstack_1grow (pp->buffer->obstack, c);
 823   ++pp->buffer->line_length;
 824 }
 825
 826 /* Append a STRING to the output area of PRETTY-PRINTER; the STRING may
 827    be line-wrapped if in appropriate mode.  */
 828 void
 829 pp_base_string (pretty_printer *pp, const char *str)
 830 {
 831   pp_maybe_wrap_text (pp, str, str + (str ? strlen (str) : 0));
 832 }
 833
 834 /* Maybe print out a whitespace if needed.  */
 835
 836 void
 837 pp_base_maybe_space (pretty_printer *pp)
 838 {
 839   if (pp_base (pp)->padding != pp_none)
 840     {
 841       pp_space (pp);
 842       pp_base (pp)->padding = pp_none;
 843     }
 844 }