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/Support/SourceMgr.h"
17
#include "llvm/Support/MemoryBuffer.h"
18
#include "llvm/Support/raw_ostream.h"
22
struct LineNoCacheTy {
23
int LastQueryBufferID;
24
const char *LastQuery;
25
unsigned LineNoOfQuery;
29
static LineNoCacheTy *getCache(void *Ptr) {
30
return (LineNoCacheTy*)Ptr;
34
SourceMgr::~SourceMgr() {
35
// Delete the line # cache if allocated.
36
if (LineNoCacheTy *Cache = getCache(LineNoCache))
39
while (!Buffers.empty()) {
40
delete Buffers.back().Buffer;
45
/// AddIncludeFile - Search for a file with the specified name in the current
46
/// directory or in one of the IncludeDirs. If no file is found, this returns
47
/// ~0, otherwise it returns the buffer ID of the stacked file.
48
unsigned SourceMgr::AddIncludeFile(const std::string &Filename,
51
MemoryBuffer *NewBuf = MemoryBuffer::getFile(Filename.c_str());
53
// If the file didn't exist directly, see if it's in an include path.
54
for (unsigned i = 0, e = IncludeDirectories.size(); i != e && !NewBuf; ++i) {
55
std::string IncFile = IncludeDirectories[i] + "/" + Filename;
56
NewBuf = MemoryBuffer::getFile(IncFile.c_str());
59
if (NewBuf == 0) return ~0U;
61
return AddNewSourceBuffer(NewBuf, IncludeLoc);
65
/// FindBufferContainingLoc - Return the ID of the buffer containing the
66
/// specified location, returning -1 if not found.
67
int SourceMgr::FindBufferContainingLoc(SMLoc Loc) const {
68
for (unsigned i = 0, e = Buffers.size(); i != e; ++i)
69
if (Loc.getPointer() >= Buffers[i].Buffer->getBufferStart() &&
70
// Use <= here so that a pointer to the null at the end of the buffer
71
// is included as part of the buffer.
72
Loc.getPointer() <= Buffers[i].Buffer->getBufferEnd())
77
/// FindLineNumber - Find the line number for the specified location in the
78
/// specified file. This is not a fast method.
79
unsigned SourceMgr::FindLineNumber(SMLoc Loc, int BufferID) const {
80
if (BufferID == -1) BufferID = FindBufferContainingLoc(Loc);
81
assert(BufferID != -1 && "Invalid Location!");
83
MemoryBuffer *Buff = getBufferInfo(BufferID).Buffer;
85
// Count the number of \n's between the start of the file and the specified
89
const char *Ptr = Buff->getBufferStart();
91
// If we have a line number cache, and if the query is to a later point in the
92
// same file, start searching from the last query location. This optimizes
93
// for the case when multiple diagnostics come out of one file in order.
94
if (LineNoCacheTy *Cache = getCache(LineNoCache))
95
if (Cache->LastQueryBufferID == BufferID &&
96
Cache->LastQuery <= Loc.getPointer()) {
97
Ptr = Cache->LastQuery;
98
LineNo = Cache->LineNoOfQuery;
101
// Scan for the location being queried, keeping track of the number of lines
103
for (; SMLoc::getFromPointer(Ptr) != Loc; ++Ptr)
104
if (*Ptr == '\n') ++LineNo;
107
// Allocate the line number cache if it doesn't exist.
108
if (LineNoCache == 0)
109
LineNoCache = new LineNoCacheTy();
111
// Update the line # cache.
112
LineNoCacheTy &Cache = *getCache(LineNoCache);
113
Cache.LastQueryBufferID = BufferID;
114
Cache.LastQuery = Ptr;
115
Cache.LineNoOfQuery = LineNo;
119
void SourceMgr::PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const {
120
if (IncludeLoc == SMLoc()) return; // Top of stack.
122
int CurBuf = FindBufferContainingLoc(IncludeLoc);
123
assert(CurBuf != -1 && "Invalid or unspecified location!");
125
PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS);
127
OS << "Included from "
128
<< getBufferInfo(CurBuf).Buffer->getBufferIdentifier()
129
<< ":" << FindLineNumber(IncludeLoc, CurBuf) << ":\n";
133
/// GetMessage - Return an SMDiagnostic at the specified location with the
134
/// specified string.
136
/// @param Type - If non-null, the kind of message (e.g., "error") which is
137
/// prefixed to the message.
138
SMDiagnostic SourceMgr::GetMessage(SMLoc Loc, const std::string &Msg,
139
const char *Type, bool ShowLine) const {
141
// First thing to do: find the current buffer containing the specified
143
int CurBuf = FindBufferContainingLoc(Loc);
144
assert(CurBuf != -1 && "Invalid or unspecified location!");
146
MemoryBuffer *CurMB = getBufferInfo(CurBuf).Buffer;
148
// Scan backward to find the start of the line.
149
const char *LineStart = Loc.getPointer();
150
while (LineStart != CurMB->getBufferStart() &&
151
LineStart[-1] != '\n' && LineStart[-1] != '\r')
156
// Get the end of the line.
157
const char *LineEnd = Loc.getPointer();
158
while (LineEnd != CurMB->getBufferEnd() &&
159
LineEnd[0] != '\n' && LineEnd[0] != '\r')
161
LineStr = std::string(LineStart, LineEnd);
164
std::string PrintedMsg;
171
return SMDiagnostic(CurMB->getBufferIdentifier(), FindLineNumber(Loc, CurBuf),
172
Loc.getPointer()-LineStart, PrintedMsg,
176
void SourceMgr::PrintMessage(SMLoc Loc, const std::string &Msg,
177
const char *Type, bool ShowLine) const {
178
raw_ostream &OS = errs();
180
int CurBuf = FindBufferContainingLoc(Loc);
181
assert(CurBuf != -1 && "Invalid or unspecified location!");
182
PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS);
184
GetMessage(Loc, Msg, Type, ShowLine).Print(0, OS);
187
//===----------------------------------------------------------------------===//
188
// SMDiagnostic Implementation
189
//===----------------------------------------------------------------------===//
191
void SMDiagnostic::Print(const char *ProgName, raw_ostream &S) const {
192
if (ProgName && ProgName[0])
193
S << ProgName << ": ";
195
if (!Filename.empty()) {
204
S << ':' << (ColumnNo+1);
209
S << Message << '\n';
211
if (LineNo != -1 && ColumnNo != -1 && ShowLine) {
212
S << LineContents << '\n';
214
// Print out spaces/tabs before the caret.
215
for (unsigned i = 0; i != unsigned(ColumnNo); ++i)
216
S << (LineContents[i] == '\t' ? '\t' : ' ');