include/llvm/Support/FileOutputBuffer.h

   1 //=== FileOutputBuffer.h - File Output Buffer -------------------*- 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 // Utility for creating a in-memory buffer that will be written to a file.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_SUPPORT_FILEOUTPUTBUFFER_H
  15 #define LLVM_SUPPORT_FILEOUTPUTBUFFER_H
  16
  17 #include "llvm/ADT/OwningPtr.h"
  18 #include "llvm/ADT/SmallString.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/Support/DataTypes.h"
  21 #include "llvm/Support/FileSystem.h"
  22
  23 namespace llvm {
  24 class error_code;
  25
  26 /// FileOutputBuffer - This interface provides simple way to create an in-memory
  27 /// buffer which will be written to a file. During the lifetime of these
  28 /// objects, the content or existence of the specified file is undefined. That
  29 /// is, creating an OutputBuffer for a file may immediately remove the file.
  30 /// If the FileOutputBuffer is committed, the target file's content will become
  31 /// the buffer content at the time of the commit.  If the FileOutputBuffer is
  32 /// not committed, the file will be deleted in the FileOutputBuffer destructor.
  33 class FileOutputBuffer {
  34 public:
  35
  36   enum  {
  37     F_executable = 1  /// set the 'x' bit on the resulting file
  38   };
  39
  40   /// Factory method to create an OutputBuffer object which manages a read/write
  41   /// buffer of the specified size. When committed, the buffer will be written
  42   /// to the file at the specified path.
  43   static error_code create(StringRef FilePath, size_t Size,
  44                            OwningPtr<FileOutputBuffer> &Result,
  45                            unsigned Flags = 0);
  46   static error_code create(StringRef FilePath, size_t Size,
  47                            std::unique_ptr<FileOutputBuffer> &Result,
  48                            unsigned Flags = 0);
  49
  50   /// Returns a pointer to the start of the buffer.
  51   uint8_t *getBufferStart() {
  52     return (uint8_t*)Region->data();
  53   }
  54
  55   /// Returns a pointer to the end of the buffer.
  56   uint8_t *getBufferEnd() {
  57     return (uint8_t*)Region->data() + Region->size();
  58   }
  59
  60   /// Returns size of the buffer.
  61   size_t getBufferSize() const {
  62     return Region->size();
  63   }
  64
  65   /// Returns path where file will show up if buffer is committed.
  66   StringRef getPath() const {
  67     return FinalPath;
  68   }
  69
  70   /// Flushes the content of the buffer to its file and deallocates the
  71   /// buffer.  If commit() is not called before this object's destructor
  72   /// is called, the file is deleted in the destructor. The optional parameter
  73   /// is used if it turns out you want the file size to be smaller than
  74   /// initially requested.
  75   error_code commit(int64_t NewSmallerSize = -1);
  76
  77   /// If this object was previously committed, the destructor just deletes
  78   /// this object.  If this object was not committed, the destructor
  79   /// deallocates the buffer and the target file is never written.
  80   ~FileOutputBuffer();
  81
  82 private:
  83   FileOutputBuffer(const FileOutputBuffer &) LLVM_DELETED_FUNCTION;
  84   FileOutputBuffer &operator=(const FileOutputBuffer &) LLVM_DELETED_FUNCTION;
  85
  86   FileOutputBuffer(llvm::sys::fs::mapped_file_region *R,
  87                    StringRef Path, StringRef TempPath);
  88
  89   std::unique_ptr<llvm::sys::fs::mapped_file_region> Region;
  90   SmallString<128>    FinalPath;
  91   SmallString<128>    TempPath;
  92 };
  93 } // end namespace llvm
  94
  95 #endif