llvm/Support/MemoryBuffer.h

1 //===--- MemoryBuffer.h - Memory Buffer Interface ---------------*- C++ -*-===//
10 //  This file defines the MemoryBuffer interface.
28 /// MemoryBuffer - This interface provides simple read-only access to a block
38 class MemoryBuffer {
42   MemoryBuffer(const MemoryBuffer &) LLVM_DELETED_FUNCTION;
43   MemoryBuffer &operator=(const MemoryBuffer &) LLVM_DELETED_FUNCTION;
45   MemoryBuffer() {}
49   virtual ~MemoryBuffer();
65   /// getFile - Open the specified file as a MemoryBuffer, returning a new
66   /// MemoryBuffer if successful, otherwise returning null.  If FileSize is
69   static error_code getFile(Twine Filename, OwningPtr<MemoryBuffer> &result,
74   /// MemoryBuffer. The slice is specified by an \p Offset and \p MapSize.
77                                      OwningPtr<MemoryBuffer> &Result,
81   /// MemoryBuffer.
83                                 OwningPtr<MemoryBuffer> &Result,
87   /// getMemBuffer - Open the specified memory range as a MemoryBuffer.  Note
89   static MemoryBuffer *getMemBuffer(StringRef InputData,
93   /// getMemBufferCopy - Open the specified memory range as a MemoryBuffer,
96   static MemoryBuffer *getMemBufferCopy(StringRef InputData,
99   /// getNewMemBuffer - Allocate a new MemoryBuffer of the specified size that
102   /// the MemoryBuffer object.
103   static MemoryBuffer *getNewMemBuffer(size_t Size, StringRef BufferName = "");
105   /// getNewUninitMemBuffer - Allocate a new MemoryBuffer of the specified size
107   /// memory allocated by this method.  The memory is owned by the MemoryBuffer
109   static MemoryBuffer *getNewUninitMemBuffer(size_t Size,
114   static error_code getSTDIN(OwningPtr<MemoryBuffer> &result);
117   /// getFileOrSTDIN - Open the specified file as a MemoryBuffer, or open stdin
121                                    OwningPtr<MemoryBuffer> &result,
128   /// The kind of memory backing used to support the MemoryBuffer.
135   /// MemoryBuffer.
140 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef)