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