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/System/Program.h"
  17 #include "llvm/ADT/SmallVector.h"
  18 #include "llvm/Config/config.h"
  19 #include <ostream>
  20
  21 #if defined(HAVE_UNISTD_H)
  22 # include <unistd.h>
  23 #endif
  24 #if defined(HAVE_FCNTL_H)
  25 # include <fcntl.h>
  26 #endif
  27
  28 #if defined(_MSC_VER)
  29 #include <io.h>
  30 #include <fcntl.h>
  31 #ifndef STDIN_FILENO
  32 # define STDIN_FILENO 0
  33 #endif
  34 #ifndef STDOUT_FILENO
  35 # define STDOUT_FILENO 1
  36 #endif
  37 #ifndef STDERR_FILENO
  38 # define STDERR_FILENO 2
  39 #endif
  40 #endif
  41
  42 using namespace llvm;
  43
  44
  45 // An out of line virtual method to provide a home for the class vtable.
  46 void raw_ostream::handle() {}
  47
  48 raw_ostream &raw_ostream::operator<<(unsigned long N) {
  49   // Zero is a special case.
  50   if (N == 0)
  51     return *this << '0';
  52
  53   char NumberBuffer[20];
  54   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
  55   char *CurPtr = EndPtr;
  56
  57   while (N) {
  58     *--CurPtr = '0' + char(N % 10);
  59     N /= 10;
  60   }
  61   return write(CurPtr, EndPtr-CurPtr);
  62 }
  63
  64 raw_ostream &raw_ostream::operator<<(long N) {
  65   if (N <  0) {
  66     if (OutBufCur >= OutBufEnd)
  67       flush_impl();
  68     *OutBufCur++ = '-';
  69
  70     N = -N;
  71   }
  72
  73   return this->operator<<(static_cast<unsigned long>(N));
  74 }
  75
  76 raw_ostream &raw_ostream::operator<<(unsigned long long N) {
  77   // Zero is a special case.
  78   if (N == 0)
  79     return *this << '0';
  80
  81   char NumberBuffer[20];
  82   char *EndPtr = NumberBuffer+sizeof(NumberBuffer);
  83   char *CurPtr = EndPtr;
  84
  85   while (N) {
  86     *--CurPtr = '0' + char(N % 10);
  87     N /= 10;
  88   }
  89   return write(CurPtr, EndPtr-CurPtr);
  90 }
  91
  92 raw_ostream &raw_ostream::operator<<(long long N) {
  93   if (N <  0) {
  94     if (OutBufCur >= OutBufEnd)
  95       flush_impl();
  96     *OutBufCur++ = '-';
  97
  98     N = -N;
  99   }
 100
 101   return this->operator<<(static_cast<unsigned long long>(N));
 102 }
 103
 104 raw_ostream &raw_ostream::operator<<(const void *P) {
 105   // FIXME: This could be much faster if it matters.
 106   return *this << format("%p", P);
 107 }
 108
 109
 110 raw_ostream &raw_ostream::write(const char *Ptr, unsigned Size) {
 111   if (OutBufCur+Size > OutBufEnd)
 112     flush_impl();
 113
 114   // Handle short strings specially, memcpy isn't very good at very short
 115   // strings.
 116   switch (Size) {
 117   case 4: OutBufCur[3] = Ptr[3]; // FALL THROUGH
 118   case 3: OutBufCur[2] = Ptr[2]; // FALL THROUGH
 119   case 2: OutBufCur[1] = Ptr[1]; // FALL THROUGH
 120   case 1: OutBufCur[0] = Ptr[0]; // FALL THROUGH
 121   case 0: break;
 122   default:
 123     // Normally the string to emit is shorter than the buffer.
 124     if (Size <= unsigned(OutBufEnd-OutBufStart)) {
 125       memcpy(OutBufCur, Ptr, Size);
 126       break;
 127     }
 128
 129     // If emitting a string larger than our buffer, emit in chunks.  In this
 130     // case we know that we just flushed the buffer.
 131     while (Size) {
 132       unsigned NumToEmit = OutBufEnd-OutBufStart;
 133       if (Size < NumToEmit) NumToEmit = Size;
 134       assert(OutBufCur == OutBufStart);
 135       memcpy(OutBufStart, Ptr, NumToEmit);
 136       Ptr += NumToEmit;
 137       Size -= NumToEmit;
 138       OutBufCur = OutBufStart + NumToEmit;
 139       flush_impl();
 140     }
 141     break;
 142   }
 143   OutBufCur += Size;
 144   return *this;
 145 }
 146
 147 // Formatted output.
 148 raw_ostream &raw_ostream::operator<<(const format_object_base &Fmt) {
 149   // If we have more than a few bytes left in our output buffer, try formatting
 150   // directly onto its end.
 151   unsigned NextBufferSize = 127;
 152   if (OutBufEnd-OutBufCur > 3) {
 153     unsigned BufferBytesLeft = OutBufEnd-OutBufCur;
 154     unsigned BytesUsed = Fmt.print(OutBufCur, BufferBytesLeft);
 155
 156     // Common case is that we have plenty of space.
 157     if (BytesUsed < BufferBytesLeft) {
 158       OutBufCur += BytesUsed;
 159       return *this;
 160     }
 161
 162     // Otherwise, we overflowed and the return value tells us the size to try
 163     // again with.
 164     NextBufferSize = BytesUsed;
 165   }
 166
 167   // If we got here, we didn't have enough space in the output buffer for the
 168   // string.  Try printing into a SmallVector that is resized to have enough
 169   // space.  Iterate until we win.
 170   SmallVector<char, 128> V;
 171
 172   while (1) {
 173     V.resize(NextBufferSize);
 174
 175     // Try formatting into the SmallVector.
 176     unsigned BytesUsed = Fmt.print(&V[0], NextBufferSize);
 177
 178     // If BytesUsed fit into the vector, we win.
 179     if (BytesUsed <= NextBufferSize)
 180       return write(&V[0], BytesUsed);
 181
 182     // Otherwise, try again with a new size.
 183     assert(BytesUsed > NextBufferSize && "Didn't grow buffer!?");
 184     NextBufferSize = BytesUsed;
 185   }
 186 }
 187
 188 //===----------------------------------------------------------------------===//
 189 //  Formatted Output
 190 //===----------------------------------------------------------------------===//
 191
 192 // Out of line virtual method.
 193 void format_object_base::home() {
 194 }
 195
 196 //===----------------------------------------------------------------------===//
 197 //  raw_fd_ostream
 198 //===----------------------------------------------------------------------===//
 199
 200 /// raw_fd_ostream - Open the specified file for writing. If an error
 201 /// occurs, information about the error is put into ErrorInfo, and the
 202 /// stream should be immediately destroyed; the string will be empty
 203 /// if no error occurred.
 204 raw_fd_ostream::raw_fd_ostream(const char *Filename, bool Binary,
 205                                std::string &ErrorInfo) : pos(0) {
 206   ErrorInfo.clear();
 207
 208   // Handle "-" as stdout.
 209   if (Filename[0] == '-' && Filename[1] == 0) {
 210     FD = STDOUT_FILENO;
 211     // If user requested binary then put stdout into binary mode if
 212     // possible.
 213     if (Binary)
 214       sys::Program::ChangeStdoutToBinary();
 215     ShouldClose = false;
 216     return;
 217   }
 218
 219   int Flags = O_WRONLY|O_CREAT|O_TRUNC;
 220 #ifdef O_BINARY
 221   if (Binary)
 222     Flags |= O_BINARY;
 223 #endif
 224   FD = open(Filename, Flags, 0644);
 225   if (FD < 0) {
 226     ErrorInfo = "Error opening output file '" + std::string(Filename) + "'";
 227     ShouldClose = false;
 228   } else {
 229     ShouldClose = true;
 230   }
 231 }
 232
 233 raw_fd_ostream::~raw_fd_ostream() {
 234   if (FD >= 0) {
 235     flush();
 236     if (ShouldClose)
 237       ::close(FD);
 238   }
 239 }
 240
 241 void raw_fd_ostream::flush_impl() {
 242   assert (FD >= 0 && "File already closed.");
 243   if (OutBufCur-OutBufStart) {
 244     pos += (OutBufCur - OutBufStart);
 245     ::write(FD, OutBufStart, OutBufCur-OutBufStart);
 246   }
 247   HandleFlush();
 248 }
 249
 250 void raw_fd_ostream::close() {
 251   assert (ShouldClose);
 252   ShouldClose = false;
 253   flush();
 254   ::close(FD);
 255   FD = -1;
 256 }
 257
 258 //===----------------------------------------------------------------------===//
 259 //  raw_stdout/err_ostream
 260 //===----------------------------------------------------------------------===//
 261
 262 raw_stdout_ostream::raw_stdout_ostream():raw_fd_ostream(STDOUT_FILENO, false) {}
 263 raw_stderr_ostream::raw_stderr_ostream():raw_fd_ostream(STDERR_FILENO, false) {}
 264
 265 // An out of line virtual method to provide a home for the class vtable.
 266 void raw_stdout_ostream::handle() {}
 267 void raw_stderr_ostream::handle() {}
 268
 269 /// outs() - This returns a reference to a raw_ostream for standard output.
 270 /// Use it like: outs() << "foo" << "bar";
 271 raw_ostream &llvm::outs() {
 272   static raw_stdout_ostream S;
 273   return S;
 274 }
 275
 276 /// errs() - This returns a reference to a raw_ostream for standard error.
 277 /// Use it like: errs() << "foo" << "bar";
 278 raw_ostream &llvm::errs() {
 279   static raw_stderr_ostream S;
 280   return S;
 281 }
 282
 283 //===----------------------------------------------------------------------===//
 284 //  raw_os_ostream
 285 //===----------------------------------------------------------------------===//
 286
 287 raw_os_ostream::~raw_os_ostream() {
 288   flush();
 289 }
 290
 291 /// flush_impl - The is the piece of the class that is implemented by
 292 /// subclasses.  This outputs the currently buffered data and resets the
 293 /// buffer to empty.
 294 void raw_os_ostream::flush_impl() {
 295   if (OutBufCur-OutBufStart)
 296     OS.write(OutBufStart, OutBufCur-OutBufStart);
 297   HandleFlush();
 298 }
 299
 300 //===----------------------------------------------------------------------===//
 301 //  raw_string_ostream
 302 //===----------------------------------------------------------------------===//
 303
 304 raw_string_ostream::~raw_string_ostream() {
 305   flush();
 306 }
 307
 308 /// flush_impl - The is the piece of the class that is implemented by
 309 /// subclasses.  This outputs the currently buffered data and resets the
 310 /// buffer to empty.
 311 void raw_string_ostream::flush_impl() {
 312   if (OutBufCur-OutBufStart)
 313     OS.append(OutBufStart, OutBufCur-OutBufStart);
 314   HandleFlush();
 315 }
 316
 317 //===----------------------------------------------------------------------===//
 318 //  raw_svector_ostream
 319 //===----------------------------------------------------------------------===//
 320
 321 raw_svector_ostream::~raw_svector_ostream() {
 322   flush();
 323 }
 324
 325 /// flush_impl - The is the piece of the class that is implemented by
 326 /// subclasses.  This outputs the currently buffered data and resets the
 327 /// buffer to empty.
 328 void raw_svector_ostream::flush_impl() {
 329   if (OutBufCur-OutBufStart)
 330     OS.append(OutBufStart, OutBufCur);
 331   HandleFlush();
 332 }
 333