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