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