contrib/llvm/lib/Support/raw_ostream.cpp

   1 //===--- raw_ostream.cpp - Implement the raw_ostream classes --------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This implements support for bulk buffered stream output.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Support/raw_ostream.h"
  15 #include "llvm/Support/Format.h"
  16 #include "llvm/Support/Program.h"
  17 #include "llvm/Support/Process.h"
  18 #include "llvm/ADT/StringExtras.h"
  19 #include "llvm/ADT/SmallVector.h"
  20 #include "llvm/Config/config.h"
  21 #include "llvm/Support/Compiler.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/ADT/STLExtras.h"
  24 #include <cctype>
  25 #include <cerrno>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28
  29 #if defined(HAVE_UNISTD_H)
  30 # include <unistd.h>
  31 #endif
  32 #if defined(HAVE_FCNTL_H)
  33 # include <fcntl.h>
  34 #endif
  35 #if defined(HAVE_SYS_UIO_H) && defined(HAVE_WRITEV)
  36 #  include <sys/uio.h>
  37 #endif
  38
  39 #if defined(__CYGWIN__)
  40 #include <io.h>
  41 #endif
  42
  43 #if defined(_MSC_VER)
  44 #include <io.h>
  45 #include <fcntl.h>
  46 #ifndef STDIN_FILENO
  47 # define STDIN_FILENO 0
  48 #endif
  49 #ifndef STDOUT_FILENO
  50 # define STDOUT_FILENO 1
  51 #endif
  52 #ifndef STDERR_FILENO
  53 # define STDERR_FILENO 2
  54 #endif
  55 #endif
  56
  57 using namespace llvm;
  58
  59 raw_ostream::~raw_ostream() {
  60   // raw_ostream's subclasses should take care to flush the buffer
  61   // in their destructors.
  62   assert(OutBufCur == OutBufStart &&
  63          "raw_ostream destructor called with non-empty buffer!");
  64
  65   if (BufferMode == InternalBuffer)
  66     delete [] OutBufStart;
  67 }
  68
  69 // An out of line virtual method to provide a home for the class vtable.
  70 void raw_ostream::handle() {}
  71
  72 size_t raw_ostream::preferred_buffer_size() const {
  73   // BUFSIZ is intended to be a reasonable default.
  74   return BUFSIZ;
  75 }
  76
  77 void raw_ostream::SetBuffered() {
  78   // Ask the subclass to determine an appropriate buffer size.
  79   if (size_t Size = preferred_buffer_size())
  80     SetBufferSize(Size);
  81   else
  82     // It may return 0, meaning this stream should be unbuffered.
  83     SetUnbuffered();
  84 }
  85
  86 void raw_ostream::SetBufferAndMode(char *BufferStart, size_t Size,
  87                                    BufferKind Mode) {
  88   assert(((Mode == Unbuffered && BufferStart == 0 && Size == 0) ||
  89           (Mode != Unbuffered && BufferStart && Size)) &&
  90          "stream must be unbuffered or have at least one byte");
  91   // Make sure the current buffer is free of content (we can't flush here; the
  92   // child buffer management logic will be in write_impl).
  93   assert(GetNumBytesInBuffer() == 0 && "Current buffer is non-empty!");
  94
  95   if (BufferMode == InternalBuffer)
  96     delete [] OutBufStart;
  97   OutBufStart = BufferStart;
  98   OutBufEnd = OutBufStart+Size;
  99   OutBufCur = OutBufStart;
 100   BufferMode = Mode;
 101
 102   assert(OutBufStart <= OutBufEnd && "Invalid size!");
 103 }
 104
 105 raw_ostream &raw_ostream::operator<<(unsigned long N) {
 106   // Zero is a special case.
 107   if (N == 0)
 108     return *this << '0';
 109
 110   char NumberBuffer[20];
 111   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 112   char *CurPtr = EndPtr;
 113
 114   while (N) {
 115     *--CurPtr = '0' + char(N % 10);
 116     N /= 10;
 117   }
 118   return write(CurPtr, EndPtr-CurPtr);
 119 }
 120
 121 raw_ostream &raw_ostream::operator<<(long N) {
 122   if (N <  0) {
 123     *this << '-';
 124     // Avoid undefined behavior on LONG_MIN with a cast.
 125     N = -(unsigned long)N;
 126   }
 127
 128   return this->operator<<(static_cast<unsigned long>(N));
 129 }
 130
 131 raw_ostream &raw_ostream::operator<<(unsigned long long N) {
 132   // Output using 32-bit div/mod when possible.
 133   if (N == static_cast<unsigned long>(N))
 134     return this->operator<<(static_cast<unsigned long>(N));
 135
 136   char NumberBuffer[20];
 137   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 138   char *CurPtr = EndPtr;
 139
 140   while (N) {
 141     *--CurPtr = '0' + char(N % 10);
 142     N /= 10;
 143   }
 144   return write(CurPtr, EndPtr-CurPtr);
 145 }
 146
 147 raw_ostream &raw_ostream::operator<<(long long N) {
 148   if (N < 0) {
 149     *this << '-';
 150     // Avoid undefined behavior on INT64_MIN with a cast.
 151     N = -(unsigned long long)N;
 152   }
 153
 154   return this->operator<<(static_cast<unsigned long long>(N));
 155 }
 156
 157 raw_ostream &raw_ostream::write_hex(unsigned long long N) {
 158   // Zero is a special case.
 159   if (N == 0)
 160     return *this << '0';
 161
 162   char NumberBuffer[20];
 163   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
 164   char *CurPtr = EndPtr;
 165
 166   while (N) {
 167     uintptr_t x = N % 16;
 168     *--CurPtr = (x < 10 ? '0' + x : 'a' + x - 10);
 169     N /= 16;
 170   }
 171
 172   return write(CurPtr, EndPtr-CurPtr);
 173 }
 174
 175 raw_ostream &raw_ostream::write_escaped(StringRef Str,
 176                                         bool UseHexEscapes) {
 177   for (unsigned i = 0, e = Str.size(); i != e; ++i) {
 178     unsigned char c = Str[i];
 179
 180     switch (c) {
 181     case '\\':
 182       *this << '\\' << '\\';
 183       break;
 184     case '\t':
 185       *this << '\\' << 't';
 186       break;
 187     case '\n':
 188       *this << '\\' << 'n';
 189       break;
 190     case '"':
 191       *this << '\\' << '"';
 192       break;
 193     default:
 194       if (std::isprint(c)) {
 195         *this << c;
 196         break;
 197       }
 198
 199       // Write out the escaped representation.
 200       if (UseHexEscapes) {
 201         *this << '\\' << 'x';
 202         *this << hexdigit((c >> 4 & 0xF));
 203         *this << hexdigit((c >> 0) & 0xF);
 204       } else {
 205         // Always use a full 3-character octal escape.
 206         *this << '\\';
 207         *this << char('0' + ((c >> 6) & 7));
 208         *this << char('0' + ((c >> 3) & 7));
 209         *this << char('0' + ((c >> 0) & 7));
 210       }
 211     }
 212   }
 213
 214   return *this;
 215 }
 216
 217 raw_ostream &raw_ostream::operator<<(const void *P) {
 218   *this << '0' << 'x';
 219
 220   return write_hex((uintptr_t) P);
 221 }
 222
 223 raw_ostream &raw_ostream::operator<<(double N) {
 224 #ifdef _WIN32
 225   // On MSVCRT and compatible, output of %e is incompatible to Posix
 226   // by default. Number of exponent digits should be at least 2. "%+03d"
 227   // FIXME: Implement our formatter to here or Support/Format.h!
 228   int fpcl = _fpclass(N);
 229
 230   // negative zero
 231   if (fpcl == _FPCLASS_NZ)
 232     return *this << "-0.000000e+00";
 233
 234   char buf[16];
 235   unsigned len;
 236   len = snprintf(buf, sizeof(buf), "%e", N);
 237   if (len <= sizeof(buf) - 2) {
 238     if (len >= 5 && buf[len - 5] == 'e' && buf[len - 3] == '0') {
 239       int cs = buf[len - 4];
 240       if (cs == '+' || cs == '-') {
 241         int c1 = buf[len - 2];
 242         int c0 = buf[len - 1];
 243         if (isdigit(c1) && isdigit(c0)) {
 244           // Trim leading '0': "...e+012" -> "...e+12\0"
 245           buf[len - 3] = c1;
 246           buf[len - 2] = c0;
 247           buf[--len] = 0;
 248         }
 249       }
 250     }
 251     return this->operator<<(buf);
 252   }
 253 #endif
 254   return this->operator<<(format("%e", N));
 255 }
 256
 257
 258
 259 void raw_ostream::flush_nonempty() {
 260   assert(OutBufCur > OutBufStart && "Invalid call to flush_nonempty.");
 261   size_t Length = OutBufCur - OutBufStart;
 262   OutBufCur = OutBufStart;
 263   write_impl(OutBufStart, Length);
 264 }
 265
 266 raw_ostream &raw_ostream::write(unsigned char C) {
 267   // Group exceptional cases into a single branch.
 268   if (BUILTIN_EXPECT(OutBufCur >= OutBufEnd, false)) {
 269     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 270       if (BufferMode == Unbuffered) {
 271         write_impl(reinterpret_cast<char*>(&C), 1);
 272         return *this;
 273       }
 274       // Set up a buffer and start over.
 275       SetBuffered();
 276       return write(C);
 277     }
 278
 279     flush_nonempty();
 280   }
 281
 282   *OutBufCur++ = C;
 283   return *this;
 284 }
 285
 286 raw_ostream &raw_ostream::write(const char *Ptr, size_t Size) {
 287   // Group exceptional cases into a single branch.
 288   if (BUILTIN_EXPECT(size_t(OutBufEnd - OutBufCur) < Size, false)) {
 289     if (BUILTIN_EXPECT(!OutBufStart, false)) {
 290       if (BufferMode == Unbuffered) {
 291         write_impl(Ptr, Size);
 292         return *this;
 293       }
 294       // Set up a buffer and start over.
 295       SetBuffered();
 296       return write(Ptr, Size);
 297     }
 298
 299     size_t NumBytes = OutBufEnd - OutBufCur;
 300
 301     // If the buffer is empty at this point we have a string that is larger
 302     // than the buffer. Directly write the chunk that is a multiple of the
 303     // preferred buffer size and put the remainder in the buffer.
 304     if (BUILTIN_EXPECT(OutBufCur == OutBufStart, false)) {
 305       size_t BytesToWrite = Size - (Size % NumBytes);
 306       write_impl(Ptr, BytesToWrite);
 307       copy_to_buffer(Ptr + BytesToWrite, Size - BytesToWrite);
 308       return *this;
 309     }
 310
 311     // We don't have enough space in the buffer to fit the string in. Insert as
 312     // much as possible, flush and start over with the remainder.
 313     copy_to_buffer(Ptr, NumBytes);
 314     flush_nonempty();
 315     return write(Ptr + NumBytes, Size - NumBytes);
 316   }
 317
 318   copy_to_buffer(Ptr, Size);
 319
 320   return *this;
 321 }
 322
 323 void raw_ostream::copy_to_buffer(const char *Ptr, size_t Size) {
 324   assert(Size <= size_t(OutBufEnd - OutBufCur) && "Buffer overrun!");
 325
 326   // Handle short strings specially, memcpy isn't very good at very short
 327   // strings.
 328   switch (Size) {
 329   case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
 330   case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
 331   case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
 332   case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
 333   case 0: break;
 334   default:
 335     memcpy(OutBufCur, Ptr, Size);
 336     break;
 337   }
 338
 339   OutBufCur += Size;
 340 }
 341
 342 // Formatted output.
 343 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
 344   // If we have more than a few bytes left in our output buffer, try
 345   // formatting directly onto its end.
 346   size_t NextBufferSize = 127;
 347   size_t BufferBytesLeft = OutBufEnd - OutBufCur;
 348   if (BufferBytesLeft > 3) {
 349     size_t BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
 350
 351     // Common case is that we have plenty of space.
 352     if (BytesUsed <= BufferBytesLeft) {
 353       OutBufCur += BytesUsed;
 354       return *this;
 355     }
 356
 357     // Otherwise, we overflowed and the return value tells us the size to try
 358     // again with.
 359     NextBufferSize = BytesUsed;
 360   }
 361
 362   // If we got here, we didn't have enough space in the output buffer for the
 363   // string.  Try printing into a SmallVector that is resized to have enough
 364   // space.  Iterate until we win.
 365   SmallVector<char, 128> V;
 366
 367   while (1) {
 368     V.resize(NextBufferSize);
 369
 370     // Try formatting into the SmallVector.
 371     size_t BytesUsed = Fmt.print(V.data(), NextBufferSize);
 372
 373     // If BytesUsed fit into the vector, we win.
 374     if (BytesUsed <= NextBufferSize)
 375       return write(V.data(), BytesUsed);
 376
 377     // Otherwise, try again with a new size.
 378     assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
 379     NextBufferSize = BytesUsed;
 380   }
 381 }
 382
 383 /// indent - Insert 'NumSpaces' spaces.
 384 raw_ostream &raw_ostream::indent(unsigned NumSpaces) {
 385   static const char Spaces[] = "                                "
 386                                "                                "
 387                                "                ";
 388
 389   // Usually the indentation is small, handle it with a fastpath.
 390   if (NumSpaces < array_lengthof(Spaces))
 391     return write(Spaces, NumSpaces);
 392
 393   while (NumSpaces) {
 394     unsigned NumToWrite = std::min(NumSpaces,
 395                                    (unsigned)array_lengthof(Spaces)-1);
 396     write(Spaces, NumToWrite);
 397     NumSpaces -= NumToWrite;
 398   }
 399   return *this;
 400 }
 401
 402
 403 //===----------------------------------------------------------------------===//
 404 //  Formatted Output
 405 //===----------------------------------------------------------------------===//
 406
 407 // Out of line virtual method.
 408 void format_object_base::home() {
 409 }
 410
 411 //===----------------------------------------------------------------------===//
 412 //  raw_fd_ostream
 413 //===----------------------------------------------------------------------===//
 414
 415 /// raw_fd_ostream - Open the specified file for writing. If an error
 416 /// occurs, information about the error is put into ErrorInfo, and the
 417 /// stream should be immediately destroyed; the string will be empty
 418 /// if no error occurred.
 419 raw_fd_ostream::raw_fd_ostream(const char *Filename, std::string &ErrorInfo,
 420                                unsigned Flags)
 421   : Error(false), UseAtomicWrites(false), pos(0)
 422 {
 423   assert(Filename != 0 && "Filename is null");
 424   // Verify that we don't have both "append" and "excl".
 425   assert((!(Flags & F_Excl) || !(Flags & F_Append)) &&
 426          "Cannot specify both 'excl' and 'append' file creation flags!");
 427
 428   ErrorInfo.clear();
 429
 430   // Handle "-" as stdout. Note that when we do this, we consider ourself
 431   // the owner of stdout. This means that we can do things like close the
 432   // file descriptor when we're done and set the "binary" flag globally.
 433   if (Filename[0] == '-' && Filename[1] == 0) {
 434     FD = STDOUT_FILENO;
 435     // If user requested binary then put stdout into binary mode if
 436     // possible.
 437     if (Flags & F_Binary)
 438       sys::Program::ChangeStdoutToBinary();
 439     // Close stdout when we're done, to detect any output errors.
 440     ShouldClose = true;
 441     return;
 442   }
 443
 444   int OpenFlags = O_WRONLY|O_CREAT;
 445 #ifdef O_BINARY
 446   if (Flags & F_Binary)
 447     OpenFlags |= O_BINARY;
 448 #endif
 449
 450   if (Flags & F_Append)
 451     OpenFlags |= O_APPEND;
 452   else
 453     OpenFlags |= O_TRUNC;
 454   if (Flags & F_Excl)
 455     OpenFlags |= O_EXCL;
 456
 457   while ((FD = open(Filename, OpenFlags, 0664)) < 0) {
 458     if (errno != EINTR) {
 459       ErrorInfo = "Error opening output file '" + std::string(Filename) + "'";
 460       ShouldClose = false;
 461       return;
 462     }
 463   }
 464
 465   // Ok, we successfully opened the file, so it'll need to be closed.
 466   ShouldClose = true;
 467 }
 468
 469 /// raw_fd_ostream ctor - FD is the file descriptor that this writes to.  If
 470 /// ShouldClose is true, this closes the file when the stream is destroyed.
 471 raw_fd_ostream::raw_fd_ostream(int fd, bool shouldClose, bool unbuffered)
 472   : raw_ostream(unbuffered), FD(fd),
 473     ShouldClose(shouldClose), Error(false), UseAtomicWrites(false) {
 474 #ifdef O_BINARY
 475   // Setting STDOUT and STDERR to binary mode is necessary in Win32
 476   // to avoid undesirable linefeed conversion.
 477   if (fd == STDOUT_FILENO || fd == STDERR_FILENO)
 478     setmode(fd, O_BINARY);
 479 #endif
 480
 481   // Get the starting position.
 482   off_t loc = ::lseek(FD, 0, SEEK_CUR);
 483   if (loc == (off_t)-1)
 484     pos = 0;
 485   else
 486     pos = static_cast<uint64_t>(loc);
 487 }
 488
 489 raw_fd_ostream::~raw_fd_ostream() {
 490   if (FD >= 0) {
 491     flush();
 492     if (ShouldClose)
 493       while (::close(FD) != 0)
 494         if (errno != EINTR) {
 495           error_detected();
 496           break;
 497         }
 498   }
 499
 500 #ifdef __MINGW32__
 501   // On mingw, global dtors should not call exit().
 502   // report_fatal_error() invokes exit(). We know report_fatal_error()
 503   // might not write messages to stderr when any errors were detected
 504   // on FD == 2.
 505   if (FD == 2) return;
 506 #endif
 507
 508   // If there are any pending errors, report them now. Clients wishing
 509   // to avoid report_fatal_error calls should check for errors with
 510   // has_error() and clear the error flag with clear_error() before
 511   // destructing raw_ostream objects which may have errors.
 512   if (has_error())
 513     report_fatal_error("IO failure on output stream.");
 514 }
 515
 516
 517 void raw_fd_ostream::write_impl(const char *Ptr, size_t Size) {
 518   assert(FD >= 0 && "File already closed.");
 519   pos += Size;
 520
 521   do {
 522     ssize_t ret;
 523
 524     // Check whether we should attempt to use atomic writes.
 525     if (BUILTIN_EXPECT(!UseAtomicWrites, true)) {
 526       ret = ::write(FD, Ptr, Size);
 527     } else {
 528       // Use ::writev() where available.
 529 #if defined(HAVE_WRITEV)
 530       struct iovec IOV = { (void*) Ptr, Size };
 531       ret = ::writev(FD, &IOV, 1);
 532 #else
 533       ret = ::write(FD, Ptr, Size);
 534 #endif
 535     }
 536
 537     if (ret < 0) {
 538       // If it's a recoverable error, swallow it and retry the write.
 539       //
 540       // Ideally we wouldn't ever see EAGAIN or EWOULDBLOCK here, since
 541       // raw_ostream isn't designed to do non-blocking I/O. However, some
 542       // programs, such as old versions of bjam, have mistakenly used
 543       // O_NONBLOCK. For compatibility, emulate blocking semantics by
 544       // spinning until the write succeeds. If you don't want spinning,
 545       // don't use O_NONBLOCK file descriptors with raw_ostream.
 546       if (errno == EINTR || errno == EAGAIN
 547 #ifdef EWOULDBLOCK
 548           || errno == EWOULDBLOCK
 549 #endif
 550           )
 551         continue;
 552
 553       // Otherwise it's a non-recoverable error. Note it and quit.
 554       error_detected();
 555       break;
 556     }
 557
 558     // The write may have written some or all of the data. Update the
 559     // size and buffer pointer to reflect the remainder that needs
 560     // to be written. If there are no bytes left, we're done.
 561     Ptr += ret;
 562     Size -= ret;
 563   } while (Size > 0);
 564 }
 565
 566 void raw_fd_ostream::close() {
 567   assert(ShouldClose);
 568   ShouldClose = false;
 569   flush();
 570   while (::close(FD) != 0)
 571     if (errno != EINTR) {
 572       error_detected();
 573       break;
 574     }
 575   FD = -1;
 576 }
 577
 578 uint64_t raw_fd_ostream::seek(uint64_t off) {
 579   flush();
 580   pos = ::lseek(FD, off, SEEK_SET);
 581   if (pos != off)
 582     error_detected();
 583   return pos;
 584 }
 585
 586 size_t raw_fd_ostream::preferred_buffer_size() const {
 587 #if !defined(_MSC_VER) && !defined(__MINGW32__) && !defined(__minix)
 588   // Windows and Minix have no st_blksize.
 589   assert(FD >= 0 && "File not yet open!");
 590   struct stat statbuf;
 591   if (fstat(FD, &statbuf) != 0)
 592     return 0;
 593
 594   // If this is a terminal, don't use buffering. Line buffering
 595   // would be a more traditional thing to do, but it's not worth
 596   // the complexity.
 597   if (S_ISCHR(statbuf.st_mode) && isatty(FD))
 598     return 0;
 599   // Return the preferred block size.
 600   return statbuf.st_blksize;
 601 #else
 602   return raw_ostream::preferred_buffer_size();
 603 #endif
 604 }
 605
 606 raw_ostream &raw_fd_ostream::changeColor(enum Colors colors, bool bold,
 607                                          bool bg) {
 608   if (sys::Process::ColorNeedsFlush())
 609     flush();
 610   const char *colorcode =
 611     (colors == SAVEDCOLOR) ? sys::Process::OutputBold(bg)
 612     : sys::Process::OutputColor(colors, bold, bg);
 613   if (colorcode) {
 614     size_t len = strlen(colorcode);
 615     write(colorcode, len);
 616     // don't account colors towards output characters
 617     pos -= len;
 618   }
 619   return *this;
 620 }
 621
 622 raw_ostream &raw_fd_ostream::resetColor() {
 623   if (sys::Process::ColorNeedsFlush())
 624     flush();
 625   const char *colorcode = sys::Process::ResetColor();
 626   if (colorcode) {
 627     size_t len = strlen(colorcode);
 628     write(colorcode, len);
 629     // don't account colors towards output characters
 630     pos -= len;
 631   }
 632   return *this;
 633 }
 634
 635 bool raw_fd_ostream::is_displayed() const {
 636   return sys::Process::FileDescriptorIsDisplayed(FD);
 637 }
 638
 639 //===----------------------------------------------------------------------===//
 640 //  outs(), errs(), nulls()
 641 //===----------------------------------------------------------------------===//
 642
 643 /// outs() - This returns a reference to a raw_ostream for standard output.
 644 /// Use it like: outs() << "foo" << "bar";
 645 raw_ostream &llvm::outs() {
 646   // Set buffer settings to model stdout behavior.
 647   // Delete the file descriptor when the program exists, forcing error
 648   // detection. If you don't want this behavior, don't use outs().
 649   static raw_fd_ostream S(STDOUT_FILENO, true);
 650   return S;
 651 }
 652
 653 /// errs() - This returns a reference to a raw_ostream for standard error.
 654 /// Use it like: errs() << "foo" << "bar";
 655 raw_ostream &llvm::errs() {
 656   // Set standard error to be unbuffered by default.
 657   static raw_fd_ostream S(STDERR_FILENO, false, true);
 658   return S;
 659 }
 660
 661 /// nulls() - This returns a reference to a raw_ostream which discards output.
 662 raw_ostream &llvm::nulls() {
 663   static raw_null_ostream S;
 664   return S;
 665 }
 666
 667
 668 //===----------------------------------------------------------------------===//
 669 //  raw_string_ostream
 670 //===----------------------------------------------------------------------===//
 671
 672 raw_string_ostream::~raw_string_ostream() {
 673   flush();
 674 }
 675
 676 void raw_string_ostream::write_impl(const char *Ptr, size_t Size) {
 677   OS.append(Ptr, Size);
 678 }
 679
 680 //===----------------------------------------------------------------------===//
 681 //  raw_svector_ostream
 682 //===----------------------------------------------------------------------===//
 683
 684 // The raw_svector_ostream implementation uses the SmallVector itself as the
 685 // buffer for the raw_ostream. We guarantee that the raw_ostream buffer is
 686 // always pointing past the end of the vector, but within the vector
 687 // capacity. This allows raw_ostream to write directly into the correct place,
 688 // and we only need to set the vector size when the data is flushed.
 689
 690 raw_svector_ostream::raw_svector_ostream(SmallVectorImpl<char> &O) : OS(O) {
 691   // Set up the initial external buffer. We make sure that the buffer has at
 692   // least 128 bytes free; raw_ostream itself only requires 64, but we want to
 693   // make sure that we don't grow the buffer unnecessarily on destruction (when
 694   // the data is flushed). See the FIXME below.
 695   OS.reserve(OS.size() + 128);
 696   SetBuffer(OS.end(), OS.capacity() - OS.size());
 697 }
 698
 699 raw_svector_ostream::~raw_svector_ostream() {
 700   // FIXME: Prevent resizing during this flush().
 701   flush();
 702 }
 703
 704 /// resync - This is called when the SmallVector we're appending to is changed
 705 /// outside of the raw_svector_ostream's control.  It is only safe to do this
 706 /// if the raw_svector_ostream has previously been flushed.
 707 void raw_svector_ostream::resync() {
 708   assert(GetNumBytesInBuffer() == 0 && "Didn't flush before mutating vector");
 709
 710   if (OS.capacity() - OS.size() < 64)
 711     OS.reserve(OS.capacity() * 2);
 712   SetBuffer(OS.end(), OS.capacity() - OS.size());
 713 }
 714
 715 void raw_svector_ostream::write_impl(const char *Ptr, size_t Size) {
 716   // If we're writing bytes from the end of the buffer into the smallvector, we
 717   // don't need to copy the bytes, just commit the bytes because they are
 718   // already in the right place.
 719   if (Ptr == OS.end()) {
 720     assert(OS.size() + Size <= OS.capacity() && "Invalid write_impl() call!");
 721     OS.set_size(OS.size() + Size);
 722   } else {
 723     assert(GetNumBytesInBuffer() == 0 &&
 724            "Should be writing from buffer if some bytes in it");
 725     // Otherwise, do copy the bytes.
 726     OS.append(Ptr, Ptr+Size);
 727   }
 728
 729   // Grow the vector if necessary.
 730   if (OS.capacity() - OS.size() < 64)
 731     OS.reserve(OS.capacity() * 2);
 732
 733   // Update the buffer position.
 734   SetBuffer(OS.end(), OS.capacity() - OS.size());
 735 }
 736
 737 uint64_t raw_svector_ostream::current_pos() const {
 738    return OS.size();
 739 }
 740
 741 StringRef raw_svector_ostream::str() {
 742   flush();
 743   return StringRef(OS.begin(), OS.size());
 744 }
 745
 746 //===----------------------------------------------------------------------===//
 747 //  raw_null_ostream
 748 //===----------------------------------------------------------------------===//
 749
 750 raw_null_ostream::~raw_null_ostream() {
 751 #ifndef NDEBUG
 752   // ~raw_ostream asserts that the buffer is empty. This isn't necessary
 753   // with raw_null_ostream, but it's better to have raw_null_ostream follow
 754   // the rules than to change the rules just for raw_null_ostream.
 755   flush();
 756 #endif
 757 }
 758
 759 void raw_null_ostream::write_impl(const char *Ptr, size_t Size) {
 760 }
 761
 762 uint64_t raw_null_ostream::current_pos() const {
 763   return 0;
 764 }