1 //===- SourceMgr.cpp - Manager for Simple Source Buffers & Diagnostics ----===//
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 implements the SourceMgr class. This class is used as a simple
11 // substrate for diagnostics, #include handling, and other low level things for
14 //===----------------------------------------------------------------------===//
16 #include "llvm/ADT/Twine.h"
17 #include "llvm/Support/SourceMgr.h"
18 #include "llvm/Support/MemoryBuffer.h"
19 #include "llvm/ADT/OwningPtr.h"
20 #include "llvm/Support/raw_ostream.h"
21 #include "llvm/Support/system_error.h"
25 struct LineNoCacheTy {
26 int LastQueryBufferID;
27 const char *LastQuery;
28 unsigned LineNoOfQuery;
32 static LineNoCacheTy *getCache(void *Ptr) {
33 return (LineNoCacheTy*)Ptr;
37 SourceMgr::~SourceMgr() {
38 // Delete the line # cache if allocated.
39 if (LineNoCacheTy *Cache = getCache(LineNoCache))
42 while (!Buffers.empty()) {
43 delete Buffers.back().Buffer;
48 /// AddIncludeFile - Search for a file with the specified name in the current
49 /// directory or in one of the IncludeDirs. If no file is found, this returns
50 /// ~0, otherwise it returns the buffer ID of the stacked file.
51 unsigned SourceMgr::AddIncludeFile(const std::string &Filename,
53 std::string &IncludedFile) {
54 OwningPtr<MemoryBuffer> NewBuf;
55 IncludedFile = Filename;
56 MemoryBuffer::getFile(IncludedFile.c_str(), NewBuf);
58 // If the file didn't exist directly, see if it's in an include path.
59 for (unsigned i = 0, e = IncludeDirectories.size(); i != e && !NewBuf; ++i) {
60 IncludedFile = IncludeDirectories[i] + "/" + Filename;
61 MemoryBuffer::getFile(IncludedFile.c_str(), NewBuf);
64 if (NewBuf == 0) return ~0U;
66 return AddNewSourceBuffer(NewBuf.take(), IncludeLoc);
70 /// FindBufferContainingLoc - Return the ID of the buffer containing the
71 /// specified location, returning -1 if not found.
72 int SourceMgr::FindBufferContainingLoc(SMLoc Loc) const {
73 for (unsigned i = 0, e = Buffers.size(); i != e; ++i)
74 if (Loc.getPointer() >= Buffers[i].Buffer->getBufferStart() &&
75 // Use <= here so that a pointer to the null at the end of the buffer
76 // is included as part of the buffer.
77 Loc.getPointer() <= Buffers[i].Buffer->getBufferEnd())
82 /// FindLineNumber - Find the line number for the specified location in the
83 /// specified file. This is not a fast method.
84 unsigned SourceMgr::FindLineNumber(SMLoc Loc, int BufferID) const {
85 if (BufferID == -1) BufferID = FindBufferContainingLoc(Loc);
86 assert(BufferID != -1 && "Invalid Location!");
88 MemoryBuffer *Buff = getBufferInfo(BufferID).Buffer;
90 // Count the number of \n's between the start of the file and the specified
94 const char *Ptr = Buff->getBufferStart();
96 // If we have a line number cache, and if the query is to a later point in the
97 // same file, start searching from the last query location. This optimizes
98 // for the case when multiple diagnostics come out of one file in order.
99 if (LineNoCacheTy *Cache = getCache(LineNoCache))
100 if (Cache->LastQueryBufferID == BufferID &&
101 Cache->LastQuery <= Loc.getPointer()) {
102 Ptr = Cache->LastQuery;
103 LineNo = Cache->LineNoOfQuery;
106 // Scan for the location being queried, keeping track of the number of lines
108 for (; SMLoc::getFromPointer(Ptr) != Loc; ++Ptr)
109 if (*Ptr == '\n') ++LineNo;
112 // Allocate the line number cache if it doesn't exist.
113 if (LineNoCache == 0)
114 LineNoCache = new LineNoCacheTy();
116 // Update the line # cache.
117 LineNoCacheTy &Cache = *getCache(LineNoCache);
118 Cache.LastQueryBufferID = BufferID;
119 Cache.LastQuery = Ptr;
120 Cache.LineNoOfQuery = LineNo;
124 void SourceMgr::PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const {
125 if (IncludeLoc == SMLoc()) return; // Top of stack.
127 int CurBuf = FindBufferContainingLoc(IncludeLoc);
128 assert(CurBuf != -1 && "Invalid or unspecified location!");
130 PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS);
132 OS << "Included from "
133 << getBufferInfo(CurBuf).Buffer->getBufferIdentifier()
134 << ":" << FindLineNumber(IncludeLoc, CurBuf) << ":\n";
138 /// GetMessage - Return an SMDiagnostic at the specified location with the
139 /// specified string.
141 /// @param Type - If non-null, the kind of message (e.g., "error") which is
142 /// prefixed to the message.
143 SMDiagnostic SourceMgr::GetMessage(SMLoc Loc, SourceMgr::DiagKind Kind,
145 ArrayRef<SMRange> Ranges) const {
147 // First thing to do: find the current buffer containing the specified
149 int CurBuf = FindBufferContainingLoc(Loc);
150 assert(CurBuf != -1 && "Invalid or unspecified location!");
152 MemoryBuffer *CurMB = getBufferInfo(CurBuf).Buffer;
154 // Scan backward to find the start of the line.
155 const char *LineStart = Loc.getPointer();
156 while (LineStart != CurMB->getBufferStart() &&
157 LineStart[-1] != '\n' && LineStart[-1] != '\r')
160 // Get the end of the line.
161 const char *LineEnd = Loc.getPointer();
162 while (LineEnd != CurMB->getBufferEnd() &&
163 LineEnd[0] != '\n' && LineEnd[0] != '\r')
165 std::string LineStr(LineStart, LineEnd);
167 // Convert any ranges to column ranges that only intersect the line of the
169 SmallVector<std::pair<unsigned, unsigned>, 4> ColRanges;
170 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) {
171 SMRange R = Ranges[i];
172 if (!R.isValid()) continue;
174 // If the line doesn't contain any part of the range, then ignore it.
175 if (R.Start.getPointer() > LineEnd || R.End.getPointer() < LineStart)
178 // Ignore pieces of the range that go onto other lines.
179 if (R.Start.getPointer() < LineStart)
180 R.Start = SMLoc::getFromPointer(LineStart);
181 if (R.End.getPointer() > LineEnd)
182 R.End = SMLoc::getFromPointer(LineEnd);
184 // Translate from SMLoc ranges to column ranges.
185 ColRanges.push_back(std::make_pair(R.Start.getPointer()-LineStart,
186 R.End.getPointer()-LineStart));
189 return SMDiagnostic(*this, Loc,
190 CurMB->getBufferIdentifier(), FindLineNumber(Loc, CurBuf),
191 Loc.getPointer()-LineStart, Kind, Msg.str(),
195 void SourceMgr::PrintMessage(SMLoc Loc, SourceMgr::DiagKind Kind,
196 const Twine &Msg, ArrayRef<SMRange> Ranges) const {
197 SMDiagnostic Diagnostic = GetMessage(Loc, Kind, Msg, Ranges);
199 // Report the message with the diagnostic handler if present.
201 DiagHandler(Diagnostic, DiagContext);
205 raw_ostream &OS = errs();
207 int CurBuf = FindBufferContainingLoc(Loc);
208 assert(CurBuf != -1 && "Invalid or unspecified location!");
209 PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS);
211 Diagnostic.print(0, OS);
214 //===----------------------------------------------------------------------===//
215 // SMDiagnostic Implementation
216 //===----------------------------------------------------------------------===//
218 SMDiagnostic::SMDiagnostic(const SourceMgr &sm, SMLoc L, const std::string &FN,
219 int Line, int Col, SourceMgr::DiagKind Kind,
220 const std::string &Msg,
221 const std::string &LineStr,
222 ArrayRef<std::pair<unsigned,unsigned> > Ranges)
223 : SM(&sm), Loc(L), Filename(FN), LineNo(Line), ColumnNo(Col), Kind(Kind),
224 Message(Msg), LineContents(LineStr), Ranges(Ranges.vec()) {
228 void SMDiagnostic::print(const char *ProgName, raw_ostream &S) const {
229 if (ProgName && ProgName[0])
230 S << ProgName << ": ";
232 if (!Filename.empty()) {
241 S << ':' << (ColumnNo+1);
247 case SourceMgr::DK_Error: S << "error: "; break;
248 case SourceMgr::DK_Warning: S << "warning: "; break;
249 case SourceMgr::DK_Note: S << "note: "; break;
252 S << Message << '\n';
254 if (LineNo == -1 || ColumnNo == -1)
257 // Build the line with the caret and ranges.
258 std::string CaretLine(LineContents.size()+1, ' ');
260 // Expand any ranges.
261 for (unsigned r = 0, e = Ranges.size(); r != e; ++r) {
262 std::pair<unsigned, unsigned> R = Ranges[r];
263 for (unsigned i = R.first,
264 e = std::min(R.second, (unsigned)LineContents.size())+1; i != e; ++i)
268 // Finally, plop on the caret.
269 if (unsigned(ColumnNo) <= LineContents.size())
270 CaretLine[ColumnNo] = '^';
272 CaretLine[LineContents.size()] = '^';
274 // ... and remove trailing whitespace so the output doesn't wrap for it. We
275 // know that the line isn't completely empty because it has the caret in it at
277 CaretLine.erase(CaretLine.find_last_not_of(' ')+1);
279 // Print out the source line one character at a time, so we can expand tabs.
280 for (unsigned i = 0, e = LineContents.size(), OutCol = 0; i != e; ++i) {
281 if (LineContents[i] != '\t') {
282 S << LineContents[i];
287 // If we have a tab, emit at least one space, then round up to 8 columns.
291 } while (OutCol & 7);
295 // Print out the caret line, matching tabs in the source line.
296 for (unsigned i = 0, e = CaretLine.size(), OutCol = 0; i != e; ++i) {
297 if (i >= LineContents.size() || LineContents[i] != '\t') {
303 // Okay, we have a tab. Insert the appropriate number of characters.
307 } while (OutCol & 7);