0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
1 //===--- MemoryBuffer.h - Memory Buffer Interface ---------------*- C++ -*-===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
2 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
3 // The LLVM Compiler Infrastructure
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
4 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
5 // This file is distributed under the University of Illinois Open Source
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
6 // License. See LICENSE.TXT for details.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
7 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
8 //===----------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
9 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
10 // This file defines the MemoryBuffer interface.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
11 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
12 //===----------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
13
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
14 #ifndef LLVM_SUPPORT_MEMORYBUFFER_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
15 #define LLVM_SUPPORT_MEMORYBUFFER_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
16
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
17 #include "llvm/ADT/Twine.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
18 #include "llvm/Support/CBindingWrapping.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
19 #include "llvm/Support/DataTypes.h"
|
77
|
20 #include "llvm/Support/ErrorOr.h"
|
|
21 #include <memory>
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
22
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
23 namespace llvm {
|
77
|
24 class MemoryBufferRef;
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
25
|
77
|
26 /// This interface provides simple read-only access to a block of memory, and
|
|
27 /// provides simple methods for reading files and standard input into a memory
|
|
28 /// buffer. In addition to basic access to the characters in the file, this
|
|
29 /// interface guarantees you can read one character past the end of the file,
|
|
30 /// and that this character will read as '\0'.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
31 ///
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
32 /// The '\0' guarantee is needed to support an optimization -- it's intended to
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
33 /// be more efficient for clients which are reading all the data to stop
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
34 /// reading when they encounter a '\0' than to continually check the file
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
35 /// position to see if it has reached the end of the file.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
36 class MemoryBuffer {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
37 const char *BufferStart; // Start of the buffer.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
38 const char *BufferEnd; // End of the buffer.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
39
|
83
|
40 MemoryBuffer(const MemoryBuffer &) = delete;
|
|
41 MemoryBuffer &operator=(const MemoryBuffer &) = delete;
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
42 protected:
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
43 MemoryBuffer() {}
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
44 void init(const char *BufStart, const char *BufEnd,
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
45 bool RequiresNullTerminator);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
46 public:
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
47 virtual ~MemoryBuffer();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
48
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
49 const char *getBufferStart() const { return BufferStart; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
50 const char *getBufferEnd() const { return BufferEnd; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
51 size_t getBufferSize() const { return BufferEnd-BufferStart; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
52
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
53 StringRef getBuffer() const {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
54 return StringRef(BufferStart, getBufferSize());
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
55 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
56
|
77
|
57 /// Return an identifier for this buffer, typically the filename it was read
|
|
58 /// from.
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
59 virtual const char *getBufferIdentifier() const {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
60 return "Unknown buffer";
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
61 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
62
|
77
|
63 /// Open the specified file as a MemoryBuffer, returning a new MemoryBuffer
|
|
64 /// if successful, otherwise returning null. If FileSize is specified, this
|
|
65 /// means that the client knows that the file exists and that it has the
|
|
66 /// specified size.
|
|
67 ///
|
|
68 /// \param IsVolatileSize Set to true to indicate that the file size may be
|
|
69 /// changing, e.g. when libclang tries to parse while the user is
|
|
70 /// editing/updating the file.
|
|
71 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
83
|
72 getFile(const Twine &Filename, int64_t FileSize = -1,
|
77
|
73 bool RequiresNullTerminator = true, bool IsVolatileSize = false);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
74
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
75 /// Given an already-open file descriptor, map some slice of it into a
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
76 /// MemoryBuffer. The slice is specified by an \p Offset and \p MapSize.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
77 /// Since this is in the middle of a file, the buffer is not null terminated.
|
77
|
78 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
83
|
79 getOpenFileSlice(int FD, const Twine &Filename, uint64_t MapSize,
|
|
80 int64_t Offset);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
81
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
82 /// Given an already-open file descriptor, read the file and return a
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
83 /// MemoryBuffer.
|
77
|
84 ///
|
|
85 /// \param IsVolatileSize Set to true to indicate that the file size may be
|
|
86 /// changing, e.g. when libclang tries to parse while the user is
|
|
87 /// editing/updating the file.
|
|
88 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
83
|
89 getOpenFile(int FD, const Twine &Filename, uint64_t FileSize,
|
77
|
90 bool RequiresNullTerminator = true, bool IsVolatileSize = false);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
91
|
77
|
92 /// Open the specified memory range as a MemoryBuffer. Note that InputData
|
|
93 /// must be null terminated if RequiresNullTerminator is true.
|
|
94 static std::unique_ptr<MemoryBuffer>
|
|
95 getMemBuffer(StringRef InputData, StringRef BufferName = "",
|
|
96 bool RequiresNullTerminator = true);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
97
|
77
|
98 static std::unique_ptr<MemoryBuffer>
|
|
99 getMemBuffer(MemoryBufferRef Ref, bool RequiresNullTerminator = true);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
100
|
77
|
101 /// Open the specified memory range as a MemoryBuffer, copying the contents
|
|
102 /// and taking ownership of it. InputData does not have to be null terminated.
|
|
103 static std::unique_ptr<MemoryBuffer>
|
83
|
104 getMemBufferCopy(StringRef InputData, const Twine &BufferName = "");
|
77
|
105
|
|
106 /// Allocate a new zero-initialized MemoryBuffer of the specified size. Note
|
|
107 /// that the caller need not initialize the memory allocated by this method.
|
|
108 /// The memory is owned by the MemoryBuffer object.
|
|
109 static std::unique_ptr<MemoryBuffer>
|
|
110 getNewMemBuffer(size_t Size, StringRef BufferName = "");
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
111
|
77
|
112 /// Allocate a new MemoryBuffer of the specified size that is not initialized.
|
|
113 /// Note that the caller should initialize the memory allocated by this
|
|
114 /// method. The memory is owned by the MemoryBuffer object.
|
|
115 static std::unique_ptr<MemoryBuffer>
|
83
|
116 getNewUninitMemBuffer(size_t Size, const Twine &BufferName = "");
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
117
|
77
|
118 /// Read all of stdin into a file buffer, and return it.
|
|
119 static ErrorOr<std::unique_ptr<MemoryBuffer>> getSTDIN();
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
120
|
77
|
121 /// Open the specified file as a MemoryBuffer, or open stdin if the Filename
|
|
122 /// is "-".
|
|
123 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
100
|
124 getFileOrSTDIN(const Twine &Filename, int64_t FileSize = -1,
|
|
125 bool RequiresNullTerminator = true);
|
83
|
126
|
95
|
127 /// Map a subrange of the specified file as a MemoryBuffer.
|
83
|
128 static ErrorOr<std::unique_ptr<MemoryBuffer>>
|
|
129 getFileSlice(const Twine &Filename, uint64_t MapSize, uint64_t Offset);
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
130
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
131 //===--------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
132 // Provided for performance analysis.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
133 //===--------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
134
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
135 /// The kind of memory backing used to support the MemoryBuffer.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
136 enum BufferKind {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
137 MemoryBuffer_Malloc,
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
138 MemoryBuffer_MMap
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
139 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
140
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
141 /// Return information on the memory mechanism used to support the
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
142 /// MemoryBuffer.
|
77
|
143 virtual BufferKind getBufferKind() const = 0;
|
|
144
|
|
145 MemoryBufferRef getMemBufferRef() const;
|
|
146 };
|
|
147
|
|
148 class MemoryBufferRef {
|
|
149 StringRef Buffer;
|
|
150 StringRef Identifier;
|
|
151
|
|
152 public:
|
|
153 MemoryBufferRef() {}
|
100
|
154 MemoryBufferRef(MemoryBuffer& Buffer)
|
|
155 : Buffer(Buffer.getBuffer()), Identifier(Buffer.getBufferIdentifier()) {}
|
77
|
156 MemoryBufferRef(StringRef Buffer, StringRef Identifier)
|
|
157 : Buffer(Buffer), Identifier(Identifier) {}
|
|
158
|
|
159 StringRef getBuffer() const { return Buffer; }
|
|
160
|
|
161 StringRef getBufferIdentifier() const { return Identifier; }
|
|
162
|
|
163 const char *getBufferStart() const { return Buffer.begin(); }
|
|
164 const char *getBufferEnd() const { return Buffer.end(); }
|
|
165 size_t getBufferSize() const { return Buffer.size(); }
|
0
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
166 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
167
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
168 // Create wrappers for C Binding types (see CBindingWrapping.h).
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
169 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef)
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
170
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
171 } // end namespace llvm
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
172
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
173 #endif
|