include/llvm/Support/raw_ostream.h

   1 //===--- raw_ostream.h - Raw output stream ----------------------*- C++ -*-===//
   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 file defines the raw_ostream class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_SUPPORT_RAW_OSTREAM_H
  15 #define LLVM_SUPPORT_RAW_OSTREAM_H
  16
  17 #include "llvm/ADT/StringRef.h"
  18 #include "llvm/System/DataTypes.h"
  19
  20 namespace llvm {
  21   class format_object_base;
  22   template <typename T>
  23   class SmallVectorImpl;
  24
  25 /// raw_ostream - This class implements an extremely fast bulk output stream
  26 /// that can *only* output to a stream.  It does not support seeking, reopening,
  27 /// rewinding, line buffered disciplines etc. It is a simple buffer that outputs
  28 /// a chunk at a time.
  29 class raw_ostream {
  30 private:
  31   // Do not implement. raw_ostream is noncopyable.
  32   void operator=(const raw_ostream &);
  33   raw_ostream(const raw_ostream &);
  34
  35   /// The buffer is handled in such a way that the buffer is
  36   /// uninitialized, unbuffered, or out of space when OutBufCur >=
  37   /// OutBufEnd. Thus a single comparison suffices to determine if we
  38   /// need to take the slow path to write a single character.
  39   ///
  40   /// The buffer is in one of three states:
  41   ///  1. Unbuffered (BufferMode == Unbuffered)
  42   ///  1. Uninitialized (BufferMode != Unbuffered && OutBufStart == 0).
  43   ///  2. Buffered (BufferMode != Unbuffered && OutBufStart != 0 &&
  44   ///               OutBufEnd - OutBufStart >= 1).
  45   ///
  46   /// If buffered, then the raw_ostream owns the buffer if (BufferMode ==
  47   /// InternalBuffer); otherwise the buffer has been set via SetBuffer and is
  48   /// managed by the subclass.
  49   ///
  50   /// If a subclass installs an external buffer using SetBuffer then it can wait
  51   /// for a \see write_impl() call to handle the data which has been put into
  52   /// this buffer.
  53   char *OutBufStart, *OutBufEnd, *OutBufCur;
  54
  55   enum BufferKind {
  56     Unbuffered = 0,
  57     InternalBuffer,
  58     ExternalBuffer
  59   } BufferMode;
  60
  61   /// Error This flag is true if an error of any kind has been detected.
  62   ///
  63   bool Error;
  64
  65 public:
  66   // color order matches ANSI escape sequence, don't change
  67   enum Colors {
  68     BLACK=0,
  69     RED,
  70     GREEN,
  71     YELLOW,
  72     BLUE,
  73     MAGENTA,
  74     CYAN,
  75     WHITE,
  76     SAVEDCOLOR
  77   };
  78
  79   explicit raw_ostream(bool unbuffered=false)
  80     : BufferMode(unbuffered ? Unbuffered : InternalBuffer), Error(false) {
  81     // Start out ready to flush.
  82     OutBufStart = OutBufEnd = OutBufCur = 0;
  83   }
  84
  85   virtual ~raw_ostream();
  86
  87   /// tell - Return the current offset with the file.
  88   uint64_t tell() const { return current_pos() + GetNumBytesInBuffer(); }
  89
  90   /// has_error - Return the value of the flag in this raw_ostream indicating
  91   /// whether an output error has been encountered.
  92   bool has_error() const {
  93     return Error;
  94   }
  95
  96   /// clear_error - Set the flag read by has_error() to false. If the error
  97   /// flag is set at the time when this raw_ostream's destructor is called,
  98   /// llvm_report_error is called to report the error. Use clear_error()
  99   /// after handling the error to avoid this behavior.
 100   void clear_error() {
 101     Error = false;
 102   }
 103
 104   //===--------------------------------------------------------------------===//
 105   // Configuration Interface
 106   //===--------------------------------------------------------------------===//
 107
 108   /// SetBuffered - Set the stream to be buffered, with an automatically
 109   /// determined buffer size.
 110   void SetBuffered();
 111
 112   /// SetBufferSize - Set the stream to be buffered, using the
 113   /// specified buffer size.
 114   void SetBufferSize(size_t Size) {
 115     flush();
 116     SetBufferAndMode(new char[Size], Size, InternalBuffer);
 117   }
 118
 119   size_t GetBufferSize() const {
 120     // If we're supposed to be buffered but haven't actually gotten around
 121     // to allocating the buffer yet, return the value that would be used.
 122     if (BufferMode != Unbuffered && OutBufStart == 0)
 123       return preferred_buffer_size();
 124
 125     // Otherwise just return the size of the allocated buffer.
 126     return OutBufEnd - OutBufStart;
 127   }
 128
 129   /// SetUnbuffered - Set the stream to be unbuffered. When
 130   /// unbuffered, the stream will flush after every write. This routine
 131   /// will also flush the buffer immediately when the stream is being
 132   /// set to unbuffered.
 133   void SetUnbuffered() {
 134     flush();
 135     SetBufferAndMode(0, 0, Unbuffered);
 136   }
 137
 138   size_t GetNumBytesInBuffer() const {
 139     return OutBufCur - OutBufStart;
 140   }
 141
 142   //===--------------------------------------------------------------------===//
 143   // Data Output Interface
 144   //===--------------------------------------------------------------------===//
 145
 146   void flush() {
 147     if (OutBufCur != OutBufStart)
 148       flush_nonempty();
 149   }
 150
 151   raw_ostream &operator<<(char C) {
 152     if (OutBufCur >= OutBufEnd)
 153       return write(C);
 154     *OutBufCur++ = C;
 155     return *this;
 156   }
 157
 158   raw_ostream &operator<<(unsigned char C) {
 159     if (OutBufCur >= OutBufEnd)
 160       return write(C);
 161     *OutBufCur++ = C;
 162     return *this;
 163   }
 164
 165   raw_ostream &operator<<(signed char C) {
 166     if (OutBufCur >= OutBufEnd)
 167       return write(C);
 168     *OutBufCur++ = C;
 169     return *this;
 170   }
 171
 172   raw_ostream &operator<<(StringRef Str) {
 173     // Inline fast path, particularly for strings with a known length.
 174     size_t Size = Str.size();
 175
 176     // Make sure we can use the fast path.
 177     if (OutBufCur+Size > OutBufEnd)
 178       return write(Str.data(), Size);
 179
 180     memcpy(OutBufCur, Str.data(), Size);
 181     OutBufCur += Size;
 182     return *this;
 183   }
 184
 185   raw_ostream &operator<<(const char *Str) {
 186     // Inline fast path, particulary for constant strings where a sufficiently
 187     // smart compiler will simplify strlen.
 188
 189     return this->operator<<(StringRef(Str));
 190   }
 191
 192   raw_ostream &operator<<(const std::string &Str) {
 193     // Avoid the fast path, it would only increase code size for a marginal win.
 194     return write(Str.data(), Str.length());
 195   }
 196
 197   raw_ostream &operator<<(unsigned long N);
 198   raw_ostream &operator<<(long N);
 199   raw_ostream &operator<<(unsigned long long N);
 200   raw_ostream &operator<<(long long N);
 201   raw_ostream &operator<<(const void *P);
 202   raw_ostream &operator<<(unsigned int N) {
 203     return this->operator<<(static_cast<unsigned long>(N));
 204   }
 205
 206   raw_ostream &operator<<(int N) {
 207     return this->operator<<(static_cast<long>(N));
 208   }
 209
 210   raw_ostream &operator<<(double N);
 211
 212   /// write_hex - Output \arg N in hexadecimal, without any prefix or padding.
 213   raw_ostream &write_hex(unsigned long long N);
 214
 215   /// write_escaped - Output \arg Str, turning '\\', '\t', '\n', '"', and
 216   /// anything that doesn't satisfy std::isprint into an escape sequence.
 217   raw_ostream &write_escaped(StringRef Str);
 218
 219   raw_ostream &write(unsigned char C);
 220   raw_ostream &write(const char *Ptr, size_t Size);
 221
 222   // Formatted output, see the format() function in Support/Format.h.
 223   raw_ostream &operator<<(const format_object_base &Fmt);
 224
 225   /// indent - Insert 'NumSpaces' spaces.
 226   raw_ostream &indent(unsigned NumSpaces);
 227
 228
 229   /// Changes the foreground color of text that will be output from this point
 230   /// forward.
 231   /// @param colors ANSI color to use, the special SAVEDCOLOR can be used to
 232   /// change only the bold attribute, and keep colors untouched
 233   /// @param bold bold/brighter text, default false
 234   /// @param bg if true change the background, default: change foreground
 235   /// @returns itself so it can be used within << invocations
 236   virtual raw_ostream &changeColor(enum Colors, bool = false,
 237                                    bool = false) { return *this; }
 238
 239   /// Resets the colors to terminal defaults. Call this when you are done
 240   /// outputting colored text, or before program exit.
 241   virtual raw_ostream &resetColor() { return *this; }
 242
 243   /// This function determines if this stream is connected to a "tty" or
 244   /// "console" window. That is, the output would be displayed to the user
 245   /// rather than being put on a pipe or stored in a file.
 246   virtual bool is_displayed() const { return false; }
 247
 248   //===--------------------------------------------------------------------===//
 249   // Subclass Interface
 250   //===--------------------------------------------------------------------===//
 251
 252 private:
 253   /// write_impl - The is the piece of the class that is implemented
 254   /// by subclasses.  This writes the \args Size bytes starting at
 255   /// \arg Ptr to the underlying stream.
 256   ///
 257   /// This function is guaranteed to only be called at a point at which it is
 258   /// safe for the subclass to install a new buffer via SetBuffer.
 259   ///
 260   /// \arg Ptr - The start of the data to be written. For buffered streams this
 261   /// is guaranteed to be the start of the buffer.
 262   /// \arg Size - The number of bytes to be written.
 263   ///
 264   /// \invariant { Size > 0 }
 265   virtual void write_impl(const char *Ptr, size_t Size) = 0;
 266
 267   // An out of line virtual method to provide a home for the class vtable.
 268   virtual void handle();
 269
 270   /// current_pos - Return the current position within the stream, not
 271   /// counting the bytes currently in the buffer.
 272   virtual uint64_t current_pos() const = 0;
 273
 274 protected:
 275   /// SetBuffer - Use the provided buffer as the raw_ostream buffer. This is
 276   /// intended for use only by subclasses which can arrange for the output to go
 277   /// directly into the desired output buffer, instead of being copied on each
 278   /// flush.
 279   void SetBuffer(char *BufferStart, size_t Size) {
 280     SetBufferAndMode(BufferStart, Size, ExternalBuffer);
 281   }
 282
 283   /// preferred_buffer_size - Return an efficient buffer size for the
 284   /// underlying output mechanism.
 285   virtual size_t preferred_buffer_size() const;
 286
 287   /// error_detected - Set the flag indicating that an output error has
 288   /// been encountered.
 289   void error_detected() { Error = true; }
 290
 291   /// getBufferStart - Return the beginning of the current stream buffer, or 0
 292   /// if the stream is unbuffered.
 293   const char *getBufferStart() const { return OutBufStart; }
 294
 295   //===--------------------------------------------------------------------===//
 296   // Private Interface
 297   //===--------------------------------------------------------------------===//
 298 private:
 299   /// SetBufferAndMode - Install the given buffer and mode.
 300   void SetBufferAndMode(char *BufferStart, size_t Size, BufferKind Mode);
 301
 302   /// flush_nonempty - Flush the current buffer, which is known to be
 303   /// non-empty. This outputs the currently buffered data and resets
 304   /// the buffer to empty.
 305   void flush_nonempty();
 306
 307   /// copy_to_buffer - Copy data into the buffer. Size must not be
 308   /// greater than the number of unused bytes in the buffer.
 309   void copy_to_buffer(const char *Ptr, size_t Size);
 310 };
 311
 312 //===----------------------------------------------------------------------===//
 313 // File Output Streams
 314 //===----------------------------------------------------------------------===//
 315
 316 /// raw_fd_ostream - A raw_ostream that writes to a file descriptor.
 317 ///
 318 class raw_fd_ostream : public raw_ostream {
 319   int FD;
 320   bool ShouldClose;
 321   uint64_t pos;
 322
 323   /// write_impl - See raw_ostream::write_impl.
 324   virtual void write_impl(const char *Ptr, size_t Size);
 325
 326   /// current_pos - Return the current position within the stream, not
 327   /// counting the bytes currently in the buffer.
 328   virtual uint64_t current_pos() const { return pos; }
 329
 330   /// preferred_buffer_size - Determine an efficient buffer size.
 331   virtual size_t preferred_buffer_size() const;
 332
 333 public:
 334
 335   enum {
 336     /// F_Excl - When opening a file, this flag makes raw_fd_ostream
 337     /// report an error if the file already exists.
 338     F_Excl  = 1,
 339
 340     /// F_Append - When opening a file, if it already exists append to the
 341     /// existing file instead of returning an error.  This may not be specified
 342     /// with F_Excl.
 343     F_Append = 2,
 344
 345     /// F_Binary - The file should be opened in binary mode on platforms that
 346     /// make this distinction.
 347     F_Binary = 4
 348   };
 349
 350   /// raw_fd_ostream - Open the specified file for writing. If an error occurs,
 351   /// information about the error is put into ErrorInfo, and the stream should
 352   /// be immediately destroyed; the string will be empty if no error occurred.
 353   /// This allows optional flags to control how the file will be opened.
 354   ///
 355   /// \param Filename - The file to open. If this is "-" then the
 356   /// stream will use stdout instead.
 357   raw_fd_ostream(const char *Filename, std::string &ErrorInfo,
 358                  unsigned Flags = 0);
 359
 360   /// raw_fd_ostream ctor - FD is the file descriptor that this writes to.  If
 361   /// ShouldClose is true, this closes the file when the stream is destroyed.
 362   raw_fd_ostream(int fd, bool shouldClose,
 363                  bool unbuffered=false) : raw_ostream(unbuffered), FD(fd),
 364                                           ShouldClose(shouldClose) {}
 365
 366   ~raw_fd_ostream();
 367
 368   /// close - Manually flush the stream and close the file.
 369   void close();
 370
 371   /// seek - Flushes the stream and repositions the underlying file descriptor
 372   ///  positition to the offset specified from the beginning of the file.
 373   uint64_t seek(uint64_t off);
 374
 375   virtual raw_ostream &changeColor(enum Colors colors, bool bold=false,
 376                                    bool bg=false);
 377   virtual raw_ostream &resetColor();
 378
 379   virtual bool is_displayed() const;
 380 };
 381
 382 /// raw_stdout_ostream - This is a stream that always prints to stdout.
 383 ///
 384 class raw_stdout_ostream : public raw_fd_ostream {
 385   // An out of line virtual method to provide a home for the class vtable.
 386   virtual void handle();
 387 public:
 388   raw_stdout_ostream();
 389 };
 390
 391 /// raw_stderr_ostream - This is a stream that always prints to stderr.
 392 ///
 393 class raw_stderr_ostream : public raw_fd_ostream {
 394   // An out of line virtual method to provide a home for the class vtable.
 395   virtual void handle();
 396 public:
 397   raw_stderr_ostream();
 398 };
 399
 400 /// outs() - This returns a reference to a raw_ostream for standard output.
 401 /// Use it like: outs() << "foo" << "bar";
 402 raw_ostream &outs();
 403
 404 /// errs() - This returns a reference to a raw_ostream for standard error.
 405 /// Use it like: errs() << "foo" << "bar";
 406 raw_ostream &errs();
 407
 408 /// nulls() - This returns a reference to a raw_ostream which simply discards
 409 /// output.
 410 raw_ostream &nulls();
 411
 412 //===----------------------------------------------------------------------===//
 413 // Output Stream Adaptors
 414 //===----------------------------------------------------------------------===//
 415
 416 /// raw_string_ostream - A raw_ostream that writes to an std::string.  This is a
 417 /// simple adaptor class. This class does not encounter output errors.
 418 class raw_string_ostream : public raw_ostream {
 419   std::string &OS;
 420
 421   /// write_impl - See raw_ostream::write_impl.
 422   virtual void write_impl(const char *Ptr, size_t Size);
 423
 424   /// current_pos - Return the current position within the stream, not
 425   /// counting the bytes currently in the buffer.
 426   virtual uint64_t current_pos() const { return OS.size(); }
 427 public:
 428   explicit raw_string_ostream(std::string &O) : OS(O) {}
 429   ~raw_string_ostream();
 430
 431   /// str - Flushes the stream contents to the target string and returns
 432   ///  the string's reference.
 433   std::string& str() {
 434     flush();
 435     return OS;
 436   }
 437 };
 438
 439 /// raw_svector_ostream - A raw_ostream that writes to an SmallVector or
 440 /// SmallString.  This is a simple adaptor class. This class does not
 441 /// encounter output errors.
 442 class raw_svector_ostream : public raw_ostream {
 443   SmallVectorImpl<char> &OS;
 444
 445   /// write_impl - See raw_ostream::write_impl.
 446   virtual void write_impl(const char *Ptr, size_t Size);
 447
 448   /// current_pos - Return the current position within the stream, not
 449   /// counting the bytes currently in the buffer.
 450   virtual uint64_t current_pos() const;
 451 public:
 452   /// Construct a new raw_svector_ostream.
 453   ///
 454   /// \arg O - The vector to write to; this should generally have at least 128
 455   /// bytes free to avoid any extraneous memory overhead.
 456   explicit raw_svector_ostream(SmallVectorImpl<char> &O);
 457   ~raw_svector_ostream();
 458
 459   /// clear - Flush the stream and clear the underlying vector.
 460   void clear();
 461
 462   /// str - Flushes the stream contents to the target vector and return a
 463   /// StringRef for the vector contents.
 464   StringRef str();
 465 };
 466
 467 /// raw_null_ostream - A raw_ostream that discards all output.
 468 class raw_null_ostream : public raw_ostream {
 469   /// write_impl - See raw_ostream::write_impl.
 470   virtual void write_impl(const char *Ptr, size_t size);
 471
 472   /// current_pos - Return the current position within the stream, not
 473   /// counting the bytes currently in the buffer.
 474   virtual uint64_t current_pos() const;
 475
 476 public:
 477   explicit raw_null_ostream() {}
 478   ~raw_null_ostream();
 479 };
 480
 481 } // end llvm namespace
 482
 483 #endif