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/StringExtras.h"
  18 #include <cassert>
  19 #include <cstring>
  20 #include <string>
  21 #include <iosfwd>
  22
  23 namespace llvm {
  24   class format_object_base;
  25   template <typename T>
  26   class SmallVectorImpl;
  27
  28 /// raw_ostream - This class implements an extremely fast bulk output stream
  29 /// that can *only* output to a stream.  It does not support seeking, reopening,
  30 /// rewinding, line buffered disciplines etc. It is a simple buffer that outputs
  31 /// a chunk at a time.
  32 class raw_ostream {
  33 protected:
  34   char *OutBufStart, *OutBufEnd, *OutBufCur;
  35 public:
  36   raw_ostream() {
  37     // Start out ready to flush.
  38     OutBufStart = OutBufEnd = OutBufCur = 0;
  39   }
  40
  41   virtual ~raw_ostream() {
  42     delete [] OutBufStart;
  43   }
  44
  45   //===--------------------------------------------------------------------===//
  46   // Configuration Interface
  47   //===--------------------------------------------------------------------===//
  48
  49   /// SetBufferSize - Set the internal buffer size to the specified amount
  50   /// instead of the default.
  51   void SetBufferSize(unsigned Size) {
  52     assert(Size >= 64 &&
  53            "Buffer size must be somewhat large for invariants to hold");
  54     flush();
  55
  56     delete [] OutBufStart;
  57     OutBufStart = new char[Size];
  58     OutBufEnd = OutBufStart+Size;
  59     OutBufCur = OutBufStart;
  60   }
  61
  62   //===--------------------------------------------------------------------===//
  63   // Data Output Interface
  64   //===--------------------------------------------------------------------===//
  65
  66   void flush() {
  67     if (OutBufCur != OutBufStart)
  68       flush_impl();
  69   }
  70
  71   raw_ostream &operator<<(char C) {
  72     if (OutBufCur >= OutBufEnd)
  73       flush_impl();
  74     *OutBufCur++ = C;
  75     return *this;
  76   }
  77
  78   raw_ostream &operator<<(unsigned char C) {
  79     if (OutBufCur >= OutBufEnd)
  80       flush_impl();
  81     *OutBufCur++ = C;
  82     return *this;
  83   }
  84
  85   raw_ostream &operator<<(signed char C) {
  86     if (OutBufCur >= OutBufEnd)
  87       flush_impl();
  88     *OutBufCur++ = C;
  89     return *this;
  90   }
  91
  92   raw_ostream &operator<<(const char *Str) {
  93     return write(Str, strlen(Str));
  94   }
  95
  96   raw_ostream &operator<<(const std::string& Str) {
  97     return write(Str.data(), Str.length());
  98   }
  99
 100   raw_ostream &operator<<(unsigned long N);
 101   raw_ostream &operator<<(long N);
 102   raw_ostream &operator<<(unsigned long long N);
 103   raw_ostream &operator<<(long long N);
 104   raw_ostream &operator<<(const void *P);
 105   raw_ostream &operator<<(unsigned int N) {
 106     return this->operator<<(static_cast<unsigned long>(N));
 107   }
 108
 109   raw_ostream &operator<<(int N) {
 110     return this->operator<<(static_cast<long>(N));
 111   }
 112
 113   raw_ostream &operator<<(double N) {
 114     return this->operator<<(ftostr(N));
 115   }
 116
 117   raw_ostream &write(const char *Ptr, unsigned Size);
 118
 119   // Formatted output, see the format() function in Support/Format.h.
 120   raw_ostream &operator<<(const format_object_base &Fmt);
 121
 122   //===--------------------------------------------------------------------===//
 123   // Subclass Interface
 124   //===--------------------------------------------------------------------===//
 125
 126 protected:
 127
 128   /// flush_impl - The is the piece of the class that is implemented by
 129   /// subclasses.  This outputs the currently buffered data and resets the
 130   /// buffer to empty.
 131   virtual void flush_impl() = 0;
 132
 133   /// HandleFlush - A stream's implementation of flush should call this after
 134   /// emitting the bytes to the data sink.
 135   void HandleFlush() {
 136     if (OutBufStart == 0)
 137       SetBufferSize(4096);
 138     OutBufCur = OutBufStart;
 139   }
 140 private:
 141   // An out of line virtual method to provide a home for the class vtable.
 142   virtual void handle();
 143 };
 144
 145 //===----------------------------------------------------------------------===//
 146 // File Output Streams
 147 //===----------------------------------------------------------------------===//
 148
 149 /// raw_fd_ostream - A raw_ostream that writes to a file descriptor.
 150 ///
 151 class raw_fd_ostream : public raw_ostream {
 152   int FD;
 153   bool ShouldClose;
 154   uint64_t pos;
 155 public:
 156   /// raw_fd_ostream - Open the specified file for writing. If an
 157   /// error occurs, information about the error is put into ErrorInfo,
 158   /// and the stream should be immediately destroyed; the string will
 159   /// be empty if no error occurred.
 160   ///
 161   /// \param Filename - The file to open. If this is "-" then the
 162   /// stream will use stdout instead.
 163   /// \param Binary - The file should be opened in binary mode on
 164   /// platforms that support this distinction.
 165   raw_fd_ostream(const char *Filename, bool Binary, std::string &ErrorInfo);
 166
 167   /// raw_fd_ostream ctor - FD is the file descriptor that this writes to.  If
 168   /// ShouldClose is true, this closes the file when
 169   raw_fd_ostream(int fd, bool shouldClose) : FD(fd), ShouldClose(shouldClose) {}
 170
 171   ~raw_fd_ostream();
 172
 173   /// flush_impl - The is the piece of the class that is implemented by
 174   /// subclasses.  This outputs the currently buffered data and resets the
 175   /// buffer to empty.
 176   virtual void flush_impl();
 177
 178   /// close - Manually flush the stream and close the file.
 179   void close();
 180
 181   /// tell - Return the current offset with the file.
 182   uint64_t tell() {
 183     return pos + (OutBufCur - OutBufStart);
 184   }
 185
 186   /// seek - Flushes the stream and repositions the underlying file descriptor
 187   ///  positition to the offset specified from the beginning of the file.
 188   uint64_t seek(uint64_t off);
 189 };
 190
 191 /// raw_stdout_ostream - This is a stream that always prints to stdout.
 192 ///
 193 class raw_stdout_ostream : public raw_fd_ostream {
 194   // An out of line virtual method to provide a home for the class vtable.
 195   virtual void handle();
 196 public:
 197   raw_stdout_ostream();
 198 };
 199
 200 /// raw_stderr_ostream - This is a stream that always prints to stderr.
 201 ///
 202 class raw_stderr_ostream : public raw_fd_ostream {
 203   // An out of line virtual method to provide a home for the class vtable.
 204   virtual void handle();
 205 public:
 206   raw_stderr_ostream();
 207 };
 208
 209 /// outs() - This returns a reference to a raw_ostream for standard output.
 210 /// Use it like: outs() << "foo" << "bar";
 211 raw_ostream &outs();
 212
 213 /// errs() - This returns a reference to a raw_ostream for standard error.
 214 /// Use it like: errs() << "foo" << "bar";
 215 raw_ostream &errs();
 216
 217
 218 //===----------------------------------------------------------------------===//
 219 // Output Stream Adaptors
 220 //===----------------------------------------------------------------------===//
 221
 222 /// raw_os_ostream - A raw_ostream that writes to an std::ostream.  This is a
 223 /// simple adaptor class.
 224 class raw_os_ostream : public raw_ostream {
 225   std::ostream &OS;
 226 public:
 227   raw_os_ostream(std::ostream &O) : OS(O) {}
 228   ~raw_os_ostream();
 229
 230   /// flush_impl - The is the piece of the class that is implemented by
 231   /// subclasses.  This outputs the currently buffered data and resets the
 232   /// buffer to empty.
 233   virtual void flush_impl();
 234 };
 235
 236 /// raw_string_ostream - A raw_ostream that writes to an std::string.  This is a
 237 /// simple adaptor class.
 238 class raw_string_ostream : public raw_ostream {
 239   std::string &OS;
 240 public:
 241   raw_string_ostream(std::string &O) : OS(O) {}
 242   ~raw_string_ostream();
 243
 244   /// str - Flushes the stream contents to the target string and returns
 245   ///  the string's reference.
 246   std::string& str() {
 247     flush();
 248     return OS;
 249   }
 250
 251   /// flush_impl - The is the piece of the class that is implemented by
 252   /// subclasses.  This outputs the currently buffered data and resets the
 253   /// buffer to empty.
 254   virtual void flush_impl();
 255 };
 256
 257 /// raw_svector_ostream - A raw_ostream that writes to an SmallVector or
 258 /// SmallString.  This is a simple adaptor class.
 259 class raw_svector_ostream : public raw_ostream {
 260   SmallVectorImpl<char> &OS;
 261 public:
 262   raw_svector_ostream(SmallVectorImpl<char> &O) : OS(O) {}
 263   ~raw_svector_ostream();
 264
 265   /// flush_impl - The is the piece of the class that is implemented by
 266   /// subclasses.  This outputs the currently buffered data and resets the
 267   /// buffer to empty.
 268   virtual void flush_impl();
 269 };
 270
 271 } // end llvm namespace
 272
 273 #endif