1 //===- SourceMgr.h - Manager for Source Buffers & Diagnostics ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the SMDiagnostic and SourceMgr classes. This
11 // provides a simple substrate for diagnostics, #include handling, and other low
12 // level things for simple parsers.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_SUPPORT_SOURCEMGR_H
17 #define LLVM_SUPPORT_SOURCEMGR_H
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/ADT/Twine.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/SMLoc.h"
33 /// This owns the files read by a parser, handles include stacks,
34 /// and handles diagnostic wrangling.
43 /// Clients that want to handle their own diagnostics in a custom way can
44 /// register a function pointer+context as a diagnostic handler.
45 /// It gets called each time PrintMessage is invoked.
46 typedef void (*DiagHandlerTy)(const SMDiagnostic &, void *Context);
49 /// The memory buffer for the file.
50 std::unique_ptr<MemoryBuffer> Buffer;
52 /// This is the location of the parent include, or null if at the top level.
56 /// This is all of the buffers that we are reading from.
57 std::vector<SrcBuffer> Buffers;
59 // This is the list of directories we should search for include files in.
60 std::vector<std::string> IncludeDirectories;
62 /// This is a cache for line number queries, its implementation is really
63 /// private to SourceMgr.cpp.
64 mutable void *LineNoCache;
66 DiagHandlerTy DiagHandler;
69 bool isValidBufferID(unsigned i) const { return i && i <= Buffers.size(); }
71 SourceMgr(const SourceMgr&) LLVM_DELETED_FUNCTION;
72 void operator=(const SourceMgr&) LLVM_DELETED_FUNCTION;
75 : LineNoCache(nullptr), DiagHandler(nullptr), DiagContext(nullptr) {}
78 void setIncludeDirs(const std::vector<std::string> &Dirs) {
79 IncludeDirectories = Dirs;
82 /// Specify a diagnostic handler to be invoked every time PrintMessage is
83 /// called. \p Ctx is passed into the handler when it is invoked.
84 void setDiagHandler(DiagHandlerTy DH, void *Ctx = nullptr) {
89 DiagHandlerTy getDiagHandler() const { return DiagHandler; }
90 void *getDiagContext() const { return DiagContext; }
92 const SrcBuffer &getBufferInfo(unsigned i) const {
93 assert(isValidBufferID(i));
94 return Buffers[i - 1];
97 const MemoryBuffer *getMemoryBuffer(unsigned i) const {
98 assert(isValidBufferID(i));
99 return Buffers[i - 1].Buffer.get();
102 unsigned getNumBuffers() const {
103 return Buffers.size();
106 unsigned getMainFileID() const {
107 assert(getNumBuffers());
111 SMLoc getParentIncludeLoc(unsigned i) const {
112 assert(isValidBufferID(i));
113 return Buffers[i - 1].IncludeLoc;
116 /// Add a new source buffer to this source manager. This takes ownership of
117 /// the memory buffer.
118 unsigned AddNewSourceBuffer(std::unique_ptr<MemoryBuffer> F,
121 NB.Buffer = std::move(F);
122 NB.IncludeLoc = IncludeLoc;
123 Buffers.push_back(std::move(NB));
124 return Buffers.size();
127 /// Search for a file with the specified name in the current directory or in
128 /// one of the IncludeDirs.
130 /// If no file is found, this returns 0, otherwise it returns the buffer ID
131 /// of the stacked file. The full path to the included file can be found in
133 unsigned AddIncludeFile(const std::string &Filename, SMLoc IncludeLoc,
134 std::string &IncludedFile);
136 /// Return the ID of the buffer containing the specified location.
138 /// 0 is returned if the buffer is not found.
139 unsigned FindBufferContainingLoc(SMLoc Loc) const;
141 /// Find the line number for the specified location in the specified file.
142 /// This is not a fast method.
143 unsigned FindLineNumber(SMLoc Loc, unsigned BufferID = 0) const {
144 return getLineAndColumn(Loc, BufferID).first;
147 /// Find the line and column number for the specified location in the
148 /// specified file. This is not a fast method.
149 std::pair<unsigned, unsigned> getLineAndColumn(SMLoc Loc,
150 unsigned BufferID = 0) const;
152 /// Emit a message about the specified location with the specified string.
154 /// \param ShowColors Display colored messages if output is a terminal and
155 /// the default error handler is used.
156 void PrintMessage(raw_ostream &OS, SMLoc Loc, DiagKind Kind,
158 ArrayRef<SMRange> Ranges = None,
159 ArrayRef<SMFixIt> FixIts = None,
160 bool ShowColors = true) const;
162 /// Emits a diagnostic to llvm::errs().
163 void PrintMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
164 ArrayRef<SMRange> Ranges = None,
165 ArrayRef<SMFixIt> FixIts = None,
166 bool ShowColors = true) const;
168 /// Emits a manually-constructed diagnostic to the given output stream.
170 /// \param ShowColors Display colored messages if output is a terminal and
171 /// the default error handler is used.
172 void PrintMessage(raw_ostream &OS, const SMDiagnostic &Diagnostic,
173 bool ShowColors = true) const;
175 /// Return an SMDiagnostic at the specified location with the specified
178 /// \param Msg If non-null, the kind of message (e.g., "error") which is
179 /// prefixed to the message.
180 SMDiagnostic GetMessage(SMLoc Loc, DiagKind Kind, const Twine &Msg,
181 ArrayRef<SMRange> Ranges = None,
182 ArrayRef<SMFixIt> FixIts = None) const;
184 /// Prints the names of included files and the line of the file they were
185 /// included from. A diagnostic handler can use this before printing its
186 /// custom formatted message.
188 /// \param IncludeLoc The location of the include.
189 /// \param OS the raw_ostream to print on.
190 void PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const;
194 /// Represents a single fixit, a replacement of one range of text with another.
201 // FIXME: Twine.str() is not very efficient.
202 SMFixIt(SMLoc Loc, const Twine &Insertion)
203 : Range(Loc, Loc), Text(Insertion.str()) {
204 assert(Loc.isValid());
207 // FIXME: Twine.str() is not very efficient.
208 SMFixIt(SMRange R, const Twine &Replacement)
209 : Range(R), Text(Replacement.str()) {
213 StringRef getText() const { return Text; }
214 SMRange getRange() const { return Range; }
216 bool operator<(const SMFixIt &Other) const {
217 if (Range.Start.getPointer() != Other.Range.Start.getPointer())
218 return Range.Start.getPointer() < Other.Range.Start.getPointer();
219 if (Range.End.getPointer() != Other.Range.End.getPointer())
220 return Range.End.getPointer() < Other.Range.End.getPointer();
221 return Text < Other.Text;
226 /// Instances of this class encapsulate one diagnostic report, allowing
227 /// printing to a raw_ostream as a caret diagnostic.
231 std::string Filename;
232 int LineNo, ColumnNo;
233 SourceMgr::DiagKind Kind;
234 std::string Message, LineContents;
235 std::vector<std::pair<unsigned, unsigned> > Ranges;
236 SmallVector<SMFixIt, 4> FixIts;
241 : SM(nullptr), LineNo(0), ColumnNo(0), Kind(SourceMgr::DK_Error) {}
242 // Diagnostic with no location (e.g. file not found, command line arg error).
243 SMDiagnostic(StringRef filename, SourceMgr::DiagKind Knd, StringRef Msg)
244 : SM(nullptr), Filename(filename), LineNo(-1), ColumnNo(-1), Kind(Knd),
247 // Diagnostic with a location.
248 SMDiagnostic(const SourceMgr &sm, SMLoc L, StringRef FN,
249 int Line, int Col, SourceMgr::DiagKind Kind,
250 StringRef Msg, StringRef LineStr,
251 ArrayRef<std::pair<unsigned,unsigned> > Ranges,
252 ArrayRef<SMFixIt> FixIts = None);
254 const SourceMgr *getSourceMgr() const { return SM; }
255 SMLoc getLoc() const { return Loc; }
256 StringRef getFilename() const { return Filename; }
257 int getLineNo() const { return LineNo; }
258 int getColumnNo() const { return ColumnNo; }
259 SourceMgr::DiagKind getKind() const { return Kind; }
260 StringRef getMessage() const { return Message; }
261 StringRef getLineContents() const { return LineContents; }
262 ArrayRef<std::pair<unsigned, unsigned> > getRanges() const {
266 void addFixIt(const SMFixIt &Hint) {
267 FixIts.push_back(Hint);
270 ArrayRef<SMFixIt> getFixIts() const {
274 void print(const char *ProgName, raw_ostream &S,
275 bool ShowColors = true) const;
278 } // end llvm namespace