SourceMgr.cpp revision 462b43cbf61fd38db5f2467175c4a51ac1aba154
1//===- SourceMgr.cpp - Manager for Simple Source Buffers & Diagnostics ----===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 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 12// simple parsers. 13// 14//===----------------------------------------------------------------------===// 15 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" 22using namespace llvm; 23 24namespace { 25 struct LineNoCacheTy { 26 int LastQueryBufferID; 27 const char *LastQuery; 28 unsigned LineNoOfQuery; 29 }; 30} 31 32static LineNoCacheTy *getCache(void *Ptr) { 33 return (LineNoCacheTy*)Ptr; 34} 35 36 37SourceMgr::~SourceMgr() { 38 // Delete the line # cache if allocated. 39 if (LineNoCacheTy *Cache = getCache(LineNoCache)) 40 delete Cache; 41 42 while (!Buffers.empty()) { 43 delete Buffers.back().Buffer; 44 Buffers.pop_back(); 45 } 46} 47 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. 51unsigned SourceMgr::AddIncludeFile(const std::string &Filename, 52 SMLoc IncludeLoc, 53 std::string &IncludedFile) { 54 OwningPtr<MemoryBuffer> NewBuf; 55 IncludedFile = Filename; 56 MemoryBuffer::getFile(IncludedFile.c_str(), NewBuf); 57 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); 62 } 63 64 if (NewBuf == 0) return ~0U; 65 66 return AddNewSourceBuffer(NewBuf.take(), IncludeLoc); 67} 68 69 70/// FindBufferContainingLoc - Return the ID of the buffer containing the 71/// specified location, returning -1 if not found. 72int 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()) 78 return i; 79 return -1; 80} 81 82/// FindLineNumber - Find the line number for the specified location in the 83/// specified file. This is not a fast method. 84unsigned SourceMgr::FindLineNumber(SMLoc Loc, int BufferID) const { 85 if (BufferID == -1) BufferID = FindBufferContainingLoc(Loc); 86 assert(BufferID != -1 && "Invalid Location!"); 87 88 MemoryBuffer *Buff = getBufferInfo(BufferID).Buffer; 89 90 // Count the number of \n's between the start of the file and the specified 91 // location. 92 unsigned LineNo = 1; 93 94 const char *Ptr = Buff->getBufferStart(); 95 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; 104 } 105 106 // Scan for the location being queried, keeping track of the number of lines 107 // we see. 108 for (; SMLoc::getFromPointer(Ptr) != Loc; ++Ptr) 109 if (*Ptr == '\n') ++LineNo; 110 111 112 // Allocate the line number cache if it doesn't exist. 113 if (LineNoCache == 0) 114 LineNoCache = new LineNoCacheTy(); 115 116 // Update the line # cache. 117 LineNoCacheTy &Cache = *getCache(LineNoCache); 118 Cache.LastQueryBufferID = BufferID; 119 Cache.LastQuery = Ptr; 120 Cache.LineNoOfQuery = LineNo; 121 return LineNo; 122} 123 124void SourceMgr::PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const { 125 if (IncludeLoc == SMLoc()) return; // Top of stack. 126 127 int CurBuf = FindBufferContainingLoc(IncludeLoc); 128 assert(CurBuf != -1 && "Invalid or unspecified location!"); 129 130 PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS); 131 132 OS << "Included from " 133 << getBufferInfo(CurBuf).Buffer->getBufferIdentifier() 134 << ":" << FindLineNumber(IncludeLoc, CurBuf) << ":\n"; 135} 136 137 138/// GetMessage - Return an SMDiagnostic at the specified location with the 139/// specified string. 140/// 141/// @param Type - If non-null, the kind of message (e.g., "error") which is 142/// prefixed to the message. 143SMDiagnostic SourceMgr::GetMessage(SMLoc Loc, SourceMgr::DiagKind Kind, 144 const Twine &Msg, 145 ArrayRef<SMRange> Ranges) const { 146 147 // First thing to do: find the current buffer containing the specified 148 // location. 149 int CurBuf = FindBufferContainingLoc(Loc); 150 assert(CurBuf != -1 && "Invalid or unspecified location!"); 151 152 MemoryBuffer *CurMB = getBufferInfo(CurBuf).Buffer; 153 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') 158 --LineStart; 159 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') 164 ++LineEnd; 165 std::string LineStr(LineStart, LineEnd); 166 167 // Convert any ranges to column ranges that only intersect the line of the 168 // location. 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; 173 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) 176 continue; 177 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); 183 184 // Translate from SMLoc ranges to column ranges. 185 ColRanges.push_back(std::make_pair(R.Start.getPointer()-LineStart, 186 R.End.getPointer()-LineStart)); 187 } 188 189 return SMDiagnostic(*this, Loc, 190 CurMB->getBufferIdentifier(), FindLineNumber(Loc, CurBuf), 191 Loc.getPointer()-LineStart, Kind, Msg.str(), 192 LineStr, ColRanges); 193} 194 195void SourceMgr::PrintMessage(SMLoc Loc, SourceMgr::DiagKind Kind, 196 const Twine &Msg, ArrayRef<SMRange> Ranges) const { 197 SMDiagnostic Diagnostic = GetMessage(Loc, Kind, Msg, Ranges); 198 199 // Report the message with the diagnostic handler if present. 200 if (DiagHandler) { 201 DiagHandler(Diagnostic, DiagContext); 202 return; 203 } 204 205 raw_ostream &OS = errs(); 206 207 int CurBuf = FindBufferContainingLoc(Loc); 208 assert(CurBuf != -1 && "Invalid or unspecified location!"); 209 PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS); 210 211 Diagnostic.print(0, OS); 212} 213 214//===----------------------------------------------------------------------===// 215// SMDiagnostic Implementation 216//===----------------------------------------------------------------------===// 217 218SMDiagnostic::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()) { 225} 226 227 228void SMDiagnostic::print(const char *ProgName, raw_ostream &S) const { 229 if (ProgName && ProgName[0]) 230 S << ProgName << ": "; 231 232 if (!Filename.empty()) { 233 if (Filename == "-") 234 S << "<stdin>"; 235 else 236 S << Filename; 237 238 if (LineNo != -1) { 239 S << ':' << LineNo; 240 if (ColumnNo != -1) 241 S << ':' << (ColumnNo+1); 242 } 243 S << ": "; 244 } 245 246 switch (Kind) { 247 default: assert(0 && "Unknown diagnostic kind"); 248 case SourceMgr::DK_Error: S << "error: "; break; 249 case SourceMgr::DK_Warning: S << "warning: "; break; 250 case SourceMgr::DK_Note: S << "note: "; break; 251 } 252 253 S << Message << '\n'; 254 255 if (LineNo == -1 || ColumnNo == -1) 256 return; 257 258 // Build the line with the caret and ranges. 259 std::string CaretLine(LineContents.size()+1, ' '); 260 261 // Expand any ranges. 262 for (unsigned r = 0, e = Ranges.size(); r != e; ++r) { 263 std::pair<unsigned, unsigned> R = Ranges[r]; 264 for (unsigned i = R.first, 265 e = std::min(R.second, (unsigned)LineContents.size())+1; i != e; ++i) 266 CaretLine[i] = '~'; 267 } 268 269 // Finally, plop on the caret. 270 if (unsigned(ColumnNo) <= LineContents.size()) 271 CaretLine[ColumnNo] = '^'; 272 else 273 CaretLine[LineContents.size()] = '^'; 274 275 // ... and remove trailing whitespace so the output doesn't wrap for it. We 276 // know that the line isn't completely empty because it has the caret in it at 277 // least. 278 CaretLine.erase(CaretLine.find_last_not_of(' ')+1); 279 280 // Print out the source line one character at a time, so we can expand tabs. 281 for (unsigned i = 0, e = LineContents.size(), OutCol = 0; i != e; ++i) { 282 if (LineContents[i] != '\t') { 283 S << LineContents[i]; 284 ++OutCol; 285 continue; 286 } 287 288 // If we have a tab, emit at least one space, then round up to 8 columns. 289 do { 290 S << ' '; 291 ++OutCol; 292 } while (OutCol & 7); 293 } 294 S << '\n'; 295 296 // Print out the caret line, matching tabs in the source line. 297 for (unsigned i = 0, e = CaretLine.size(), OutCol = 0; i != e; ++i) { 298 if (i >= LineContents.size() || LineContents[i] != '\t') { 299 S << CaretLine[i]; 300 ++OutCol; 301 continue; 302 } 303 304 // Okay, we have a tab. Insert the appropriate number of characters. 305 do { 306 S << CaretLine[i]; 307 ++OutCol; 308 } while (OutCol & 7); 309 } 310 311 S << '\n'; 312} 313 314 315