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