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     if (Size) {
 169       memcpy(OutBufCur, Str.data(), Size);
 170       OutBufCur += Size;
 171     }
 172     return *this;
 173   }
 174
 175   raw_ostream &operator<<(const char *Str) {
 176     // Inline fast path, particularly for constant strings where a sufficiently
 177     // smart compiler will simplify strlen.
 178
 179     return this->operator<<(StringRef(Str));
 180   }
 181
 182   raw_ostream &operator<<(const std::string &Str) {
 183     // Avoid the fast path, it would only increase code size for a marginal win.
 184     return write(Str.data(), Str.length());
 185   }
 186
 187   raw_ostream &operator<<(const llvm::SmallVectorImpl<char> &Str) {
 188     return write(Str.data(), Str.size());
 189   }
 190
 191   raw_ostream &operator<<(unsigned long N);
 192   raw_ostream &operator<<(long N);
 193   raw_ostream &operator<<(unsigned long long N);
 194   raw_ostream &operator<<(long long N);
 195   raw_ostream &operator<<(const void *P);
 196   raw_ostream &operator<<(unsigned int N) {
 197     return this->operator<<(static_cast<unsigned long>(N));
 198   }
 199
 200   raw_ostream &operator<<(int N) {
 201     return this->operator<<(static_cast<long>(N));
 202   }
 203
 204   raw_ostream &operator<<(double N);
 205
 206   /// Output \p N in hexadecimal, without any prefix or padding.
 207   raw_ostream &write_hex(unsigned long long N);
 208
 209   /// Output \p Str, turning '\\', '\t', '\n', '"', and anything that doesn't
 210   /// satisfy std::isprint into an escape sequence.
 211   raw_ostream &write_escaped(StringRef Str, bool UseHexEscapes = false);
 212
 213   raw_ostream &write(unsigned char C);
 214   raw_ostream &write(const char *Ptr, size_t Size);
 215
 216   // Formatted output, see the format() function in Support/Format.h.
 217   raw_ostream &operator<<(const format_object_base &Fmt);
 218
 219   // Formatted output, see the leftJustify() function in Support/Format.h.
 220   raw_ostream &operator<<(const FormattedString &);
 221
 222   // Formatted output, see the formatHex() function in Support/Format.h.
 223   raw_ostream &operator<<(const FormattedNumber &);
 224
 225   /// indent - Insert 'NumSpaces' spaces.
 226   raw_ostream &indent(unsigned NumSpaces);
 227
 228   /// Changes the foreground color of text that will be output from this point
 229   /// forward.
 230   /// @param Color ANSI color to use, the special SAVEDCOLOR can be used to
 231   /// change only the bold attribute, and keep colors untouched
 232   /// @param Bold bold/brighter text, default false
 233   /// @param BG if true change the background, default: change foreground
 234   /// @returns itself so it can be used within << invocations
 235   virtual raw_ostream &changeColor(enum Colors Color,
 236                                    bool Bold = false,
 237                                    bool BG = false) {
 238     (void)Color;
 239     (void)Bold;
 240     (void)BG;
 241     return *this;
 242   }
 243
 244   /// Resets the colors to terminal defaults. Call this when you are done
 245   /// outputting colored text, or before program exit.
 246   virtual raw_ostream &resetColor() { return *this; }
 247
 248   /// Reverses the foreground and background colors.
 249   virtual raw_ostream &reverseColor() { return *this; }
 250
 251   /// This function determines if this stream is connected to a "tty" or
 252   /// "console" window. That is, the output would be displayed to the user
 253   /// rather than being put on a pipe or stored in a file.
 254   virtual bool is_displayed() const { return false; }
 255
 256   /// This function determines if this stream is displayed and supports colors.
 257   virtual bool has_colors() const { return is_displayed(); }
 258
 259   //===--------------------------------------------------------------------===//
 260   // Subclass Interface
 261   //===--------------------------------------------------------------------===//
 262
 263 private:
 264   /// The is the piece of the class that is implemented by subclasses.  This
 265   /// writes the \p Size bytes starting at
 266   /// \p Ptr to the underlying stream.
 267   ///
 268   /// This function is guaranteed to only be called at a point at which it is
 269   /// safe for the subclass to install a new buffer via SetBuffer.
 270   ///
 271   /// \param Ptr The start of the data to be written. For buffered streams this
 272   /// is guaranteed to be the start of the buffer.
 273   ///
 274   /// \param Size The number of bytes to be written.
 275   ///
 276   /// \invariant { Size > 0 }
 277   virtual void write_impl(const char *Ptr, size_t Size) = 0;
 278
 279   // An out of line virtual method to provide a home for the class vtable.
 280   virtual void handle();
 281
 282   /// Return the current position within the stream, not counting the bytes
 283   /// currently in the buffer.
 284   virtual uint64_t current_pos() const = 0;
 285
 286 protected:
 287   /// Use the provided buffer as the raw_ostream buffer. This is intended for
 288   /// use only by subclasses which can arrange for the output to go directly
 289   /// into the desired output buffer, instead of being copied on each flush.
 290   void SetBuffer(char *BufferStart, size_t Size) {
 291     SetBufferAndMode(BufferStart, Size, ExternalBuffer);
 292   }
 293
 294   /// Return an efficient buffer size for the underlying output mechanism.
 295   virtual size_t preferred_buffer_size() const;
 296
 297   /// Return the beginning of the current stream buffer, or 0 if the stream is
 298   /// unbuffered.
 299   const char *getBufferStart() const { return OutBufStart; }
 300
 301   //===--------------------------------------------------------------------===//
 302   // Private Interface
 303   //===--------------------------------------------------------------------===//
 304 private:
 305   /// Install the given buffer and mode.
 306   void SetBufferAndMode(char *BufferStart, size_t Size, BufferKind Mode);
 307
 308   /// Flush the current buffer, which is known to be non-empty. This outputs the
 309   /// currently buffered data and resets the buffer to empty.
 310   void flush_nonempty();
 311
 312   /// Copy data into the buffer. Size must not be greater than the number of
 313   /// unused bytes in the buffer.
 314   void copy_to_buffer(const char *Ptr, size_t Size);
 315 };
 316
 317 /// An abstract base class for streams implementations that also support a
 318 /// pwrite operation. This is useful for code that can mostly stream out data,
 319 /// but needs to patch in a header that needs to know the output size.
 320 class raw_pwrite_stream : public raw_ostream {
 321   virtual void pwrite_impl(const char *Ptr, size_t Size, uint64_t Offset) = 0;
 322
 323 public:
 324   explicit raw_pwrite_stream(bool Unbuffered = false)
 325       : raw_ostream(Unbuffered) {}
 326   void pwrite(const char *Ptr, size_t Size, uint64_t Offset) {
 327 #ifndef NDBEBUG
 328     uint64_t Pos = tell();
 329     // /dev/null always reports a pos of 0, so we cannot perform this check
 330     // in that case.
 331     if (Pos)
 332       assert(Size + Offset <= Pos && "We don't support extending the stream");
 333 #endif
 334     pwrite_impl(Ptr, Size, Offset);
 335   }
 336 };
 337
 338 //===----------------------------------------------------------------------===//
 339 // File Output Streams
 340 //===----------------------------------------------------------------------===//
 341
 342 /// A raw_ostream that writes to a file descriptor.
 343 ///
 344 class raw_fd_ostream : public raw_pwrite_stream {
 345   int FD;
 346   bool ShouldClose;
 347
 348   /// Error This flag is true if an error of any kind has been detected.
 349   ///
 350   bool Error;
 351
 352   /// Controls whether the stream should attempt to use atomic writes, when
 353   /// possible.
 354   bool UseAtomicWrites;
 355
 356   uint64_t pos;
 357
 358   bool SupportsSeeking;
 359
 360   /// See raw_ostream::write_impl.
 361   void write_impl(const char *Ptr, size_t Size) override;
 362
 363   void pwrite_impl(const char *Ptr, size_t Size, uint64_t Offset) override;
 364
 365   /// Return the current position within the stream, not counting the bytes
 366   /// currently in the buffer.
 367   uint64_t current_pos() const override { return pos; }
 368
 369   /// Determine an efficient buffer size.
 370   size_t preferred_buffer_size() const override;
 371
 372   /// Set the flag indicating that an output error has been encountered.
 373   void error_detected() { Error = true; }
 374
 375 public:
 376   /// Open the specified file for writing. If an error occurs, information
 377   /// about the error is put into EC, and the stream should be immediately
 378   /// destroyed;
 379   /// \p Flags allows optional flags to control how the file will be opened.
 380   ///
 381   /// As a special case, if Filename is "-", then the stream will use
 382   /// STDOUT_FILENO instead of opening a file. Note that it will still consider
 383   /// itself to own the file descriptor. In particular, it will close the
 384   /// file descriptor when it is done (this is necessary to detect
 385   /// output errors).
 386   raw_fd_ostream(StringRef Filename, std::error_code &EC,
 387                  sys::fs::OpenFlags Flags);
 388
 389   /// FD is the file descriptor that this writes to.  If ShouldClose is true,
 390   /// this closes the file when the stream is destroyed.
 391   raw_fd_ostream(int fd, bool shouldClose, bool unbuffered=false);
 392
 393   ~raw_fd_ostream() override;
 394
 395   /// Manually flush the stream and close the file. Note that this does not call
 396   /// fsync.
 397   void close();
 398
 399   bool supportsSeeking() { return SupportsSeeking; }
 400
 401   /// Flushes the stream and repositions the underlying file descriptor position
 402   /// to the offset specified from the beginning of the file.
 403   uint64_t seek(uint64_t off);
 404
 405   /// Set the stream to attempt to use atomic writes for individual output
 406   /// routines where possible.
 407   ///
 408   /// Note that because raw_ostream's are typically buffered, this flag is only
 409   /// sensible when used on unbuffered streams which will flush their output
 410   /// immediately.
 411   void SetUseAtomicWrites(bool Value) {
 412     UseAtomicWrites = Value;
 413   }
 414
 415   raw_ostream &changeColor(enum Colors colors, bool bold=false,
 416                            bool bg=false) override;
 417   raw_ostream &resetColor() override;
 418
 419   raw_ostream &reverseColor() override;
 420
 421   bool is_displayed() const override;
 422
 423   bool has_colors() const override;
 424
 425   /// Return the value of the flag in this raw_fd_ostream indicating whether an
 426   /// output error has been encountered.
 427   /// This doesn't implicitly flush any pending output.  Also, it doesn't
 428   /// guarantee to detect all errors unless the stream has been closed.
 429   bool has_error() const {
 430     return Error;
 431   }
 432
 433   /// Set the flag read by has_error() to false. If the error flag is set at the
 434   /// time when this raw_ostream's destructor is called, report_fatal_error is
 435   /// called to report the error. Use clear_error() after handling the error to
 436   /// avoid this behavior.
 437   ///
 438   ///   "Errors should never pass silently.
 439   ///    Unless explicitly silenced."
 440   ///      - from The Zen of Python, by Tim Peters
 441   ///
 442   void clear_error() {
 443     Error = false;
 444   }
 445 };
 446
 447 /// This returns a reference to a raw_ostream for standard output. Use it like:
 448 /// outs() << "foo" << "bar";
 449 raw_ostream &outs();
 450
 451 /// This returns a reference to a raw_ostream for standard error. Use it like:
 452 /// errs() << "foo" << "bar";
 453 raw_ostream &errs();
 454
 455 /// This returns a reference to a raw_ostream which simply discards output.
 456 raw_ostream &nulls();
 457
 458 //===----------------------------------------------------------------------===//
 459 // Output Stream Adaptors
 460 //===----------------------------------------------------------------------===//
 461
 462 /// A raw_ostream that writes to an std::string.  This is a simple adaptor
 463 /// class. This class does not encounter output errors.
 464 class raw_string_ostream : public raw_ostream {
 465   std::string &OS;
 466
 467   /// See raw_ostream::write_impl.
 468   void write_impl(const char *Ptr, size_t Size) override;
 469
 470   /// Return the current position within the stream, not counting the bytes
 471   /// currently in the buffer.
 472   uint64_t current_pos() const override { return OS.size(); }
 473
 474 public:
 475   explicit raw_string_ostream(std::string &O) : OS(O) {}
 476   ~raw_string_ostream() override;
 477
 478   /// Flushes the stream contents to the target string and returns  the string's
 479   /// reference.
 480   std::string& str() {
 481     flush();
 482     return OS;
 483   }
 484 };
 485
 486 /// A raw_ostream that writes to an SmallVector or SmallString.  This is a
 487 /// simple adaptor class. This class does not encounter output errors.
 488 /// raw_svector_ostream operates without a buffer, delegating all memory
 489 /// management to the SmallString. Thus the SmallString is always up-to-date,
 490 /// may be used directly and there is no need to call flush().
 491 class raw_svector_ostream : public raw_pwrite_stream {
 492   SmallVectorImpl<char> &OS;
 493
 494   /// See raw_ostream::write_impl.
 495   void write_impl(const char *Ptr, size_t Size) override;
 496
 497   void pwrite_impl(const char *Ptr, size_t Size, uint64_t Offset) override;
 498
 499   /// Return the current position within the stream.
 500   uint64_t current_pos() const override;
 501
 502 public:
 503   /// Construct a new raw_svector_ostream.
 504   ///
 505   /// \param O The vector to write to; this should generally have at least 128
 506   /// bytes free to avoid any extraneous memory overhead.
 507   explicit raw_svector_ostream(SmallVectorImpl<char> &O) : OS(O) {
 508     SetUnbuffered();
 509   }
 510   ~raw_svector_ostream() override = default;
 511
 512   void flush() = delete;
 513
 514   /// Return a StringRef for the vector contents.
 515   StringRef str() { return StringRef(OS.data(), OS.size()); }
 516 };
 517
 518 /// A raw_ostream that discards all output.
 519 class raw_null_ostream : public raw_pwrite_stream {
 520   /// See raw_ostream::write_impl.
 521   void write_impl(const char *Ptr, size_t size) override;
 522   void pwrite_impl(const char *Ptr, size_t Size, uint64_t Offset) override;
 523
 524   /// Return the current position within the stream, not counting the bytes
 525   /// currently in the buffer.
 526   uint64_t current_pos() const override;
 527
 528 public:
 529   explicit raw_null_ostream() {}
 530   ~raw_null_ostream() override;
 531 };
 532
 533 class buffer_ostream : public raw_svector_ostream {
 534   raw_ostream &OS;
 535   SmallVector<char, 0> Buffer;
 536
 537 public:
 538   buffer_ostream(raw_ostream &OS) : raw_svector_ostream(Buffer), OS(OS) {}
 539   ~buffer_ostream() override { OS << str(); }
 540 };
 541
 542 } // end llvm namespace
 543
 544 #endif // LLVM_SUPPORT_RAW_OSTREAM_H