SourceMgr.cpp revision bf0e32368e704b46b414f2e0323575a0ff370bda
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/// getLineAndColumn - Find the line and column number for the specified 83/// location in the specified file. This is not a fast method. 84std::pair<unsigned, unsigned> 85SourceMgr::getLineAndColumn(SMLoc Loc, int BufferID) const { 86 if (BufferID == -1) BufferID = FindBufferContainingLoc(Loc); 87 assert(BufferID != -1 && "Invalid Location!"); 88 89 MemoryBuffer *Buff = getBufferInfo(BufferID).Buffer; 90 91 // Count the number of \n's between the start of the file and the specified 92 // location. 93 unsigned LineNo = 1; 94 95 const char *BufStart = Buff->getBufferStart(); 96 const char *Ptr = BufStart; 97 98 // If we have a line number cache, and if the query is to a later point in the 99 // same file, start searching from the last query location. This optimizes 100 // for the case when multiple diagnostics come out of one file in order. 101 if (LineNoCacheTy *Cache = getCache(LineNoCache)) 102 if (Cache->LastQueryBufferID == BufferID && 103 Cache->LastQuery <= Loc.getPointer()) { 104 Ptr = Cache->LastQuery; 105 LineNo = Cache->LineNoOfQuery; 106 } 107 108 // Scan for the location being queried, keeping track of the number of lines 109 // we see. 110 for (; SMLoc::getFromPointer(Ptr) != Loc; ++Ptr) 111 if (*Ptr == '\n') ++LineNo; 112 113 // Allocate the line number cache if it doesn't exist. 114 if (LineNoCache == 0) 115 LineNoCache = new LineNoCacheTy(); 116 117 // Update the line # cache. 118 LineNoCacheTy &Cache = *getCache(LineNoCache); 119 Cache.LastQueryBufferID = BufferID; 120 Cache.LastQuery = Ptr; 121 Cache.LineNoOfQuery = LineNo; 122 123 size_t NewlineOffs = StringRef(BufStart, Ptr-BufStart).find_last_of("\n\r"); 124 if (NewlineOffs == StringRef::npos) NewlineOffs = ~0ULL; 125 return std::make_pair(LineNo, Ptr-BufStart-NewlineOffs); 126} 127 128void SourceMgr::PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const { 129 if (IncludeLoc == SMLoc()) return; // Top of stack. 130 131 int CurBuf = FindBufferContainingLoc(IncludeLoc); 132 assert(CurBuf != -1 && "Invalid or unspecified location!"); 133 134 PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS); 135 136 OS << "Included from " 137 << getBufferInfo(CurBuf).Buffer->getBufferIdentifier() 138 << ":" << FindLineNumber(IncludeLoc, CurBuf) << ":\n"; 139} 140 141 142/// GetMessage - Return an SMDiagnostic at the specified location with the 143/// specified string. 144/// 145/// @param Type - If non-null, the kind of message (e.g., "error") which is 146/// prefixed to the message. 147SMDiagnostic SourceMgr::GetMessage(SMLoc Loc, SourceMgr::DiagKind Kind, 148 const Twine &Msg, 149 ArrayRef<SMRange> Ranges) const { 150 151 // First thing to do: find the current buffer containing the specified 152 // location. 153 int CurBuf = FindBufferContainingLoc(Loc); 154 assert(CurBuf != -1 && "Invalid or unspecified location!"); 155 156 MemoryBuffer *CurMB = getBufferInfo(CurBuf).Buffer; 157 158 // Scan backward to find the start of the line. 159 const char *LineStart = Loc.getPointer(); 160 const char *BufStart = CurMB->getBufferStart(); 161 while (LineStart != BufStart && LineStart[-1] != '\n' && 162 LineStart[-1] != '\r') 163 --LineStart; 164 165 // Get the end of the line. 166 const char *LineEnd = Loc.getPointer(); 167 const char *BufEnd = CurMB->getBufferEnd(); 168 while (LineEnd != BufEnd && LineEnd[0] != '\n' && LineEnd[0] != '\r') 169 ++LineEnd; 170 std::string LineStr(LineStart, LineEnd); 171 172 // Convert any ranges to column ranges that only intersect the line of the 173 // location. 174 SmallVector<std::pair<unsigned, unsigned>, 4> ColRanges; 175 for (unsigned i = 0, e = Ranges.size(); i != e; ++i) { 176 SMRange R = Ranges[i]; 177 if (!R.isValid()) continue; 178 179 // If the line doesn't contain any part of the range, then ignore it. 180 if (R.Start.getPointer() > LineEnd || R.End.getPointer() < LineStart) 181 continue; 182 183 // Ignore pieces of the range that go onto other lines. 184 if (R.Start.getPointer() < LineStart) 185 R.Start = SMLoc::getFromPointer(LineStart); 186 if (R.End.getPointer() > LineEnd) 187 R.End = SMLoc::getFromPointer(LineEnd); 188 189 // Translate from SMLoc ranges to column ranges. 190 ColRanges.push_back(std::make_pair(R.Start.getPointer()-LineStart, 191 R.End.getPointer()-LineStart)); 192 } 193 194 std::pair<unsigned, unsigned> LineAndCol = getLineAndColumn(Loc, CurBuf); 195 return SMDiagnostic(*this, Loc, 196 CurMB->getBufferIdentifier(), LineAndCol.first, 197 LineAndCol.second, Kind, Msg.str(), 198 LineStr, ColRanges); 199} 200 201void SourceMgr::PrintMessage(SMLoc Loc, SourceMgr::DiagKind Kind, 202 const Twine &Msg, ArrayRef<SMRange> Ranges, 203 bool ShowColors) const { 204 SMDiagnostic Diagnostic = GetMessage(Loc, Kind, Msg, Ranges); 205 206 // Report the message with the diagnostic handler if present. 207 if (DiagHandler) { 208 DiagHandler(Diagnostic, DiagContext); 209 return; 210 } 211 212 raw_ostream &OS = errs(); 213 214 int CurBuf = FindBufferContainingLoc(Loc); 215 assert(CurBuf != -1 && "Invalid or unspecified location!"); 216 PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS); 217 218 Diagnostic.print(0, OS, ShowColors); 219} 220 221//===----------------------------------------------------------------------===// 222// SMDiagnostic Implementation 223//===----------------------------------------------------------------------===// 224 225SMDiagnostic::SMDiagnostic(const SourceMgr &sm, SMLoc L, const std::string &FN, 226 int Line, int Col, SourceMgr::DiagKind Kind, 227 const std::string &Msg, 228 const std::string &LineStr, 229 ArrayRef<std::pair<unsigned,unsigned> > Ranges) 230 : SM(&sm), Loc(L), Filename(FN), LineNo(Line), ColumnNo(Col), Kind(Kind), 231 Message(Msg), LineContents(LineStr), Ranges(Ranges.vec()) { 232} 233 234 235void SMDiagnostic::print(const char *ProgName, raw_ostream &S, 236 bool ShowColors) const { 237 // Display colors only if OS goes to a tty. 238 ShowColors &= S.is_displayed(); 239 240 if (ShowColors) 241 S.changeColor(raw_ostream::SAVEDCOLOR, true); 242 243 if (ProgName && ProgName[0]) 244 S << ProgName << ": "; 245 246 if (!Filename.empty()) { 247 if (Filename == "-") 248 S << "<stdin>"; 249 else 250 S << Filename; 251 252 if (LineNo != -1) { 253 S << ':' << LineNo; 254 if (ColumnNo != -1) 255 S << ':' << (ColumnNo+1); 256 } 257 S << ": "; 258 } 259 260 switch (Kind) { 261 case SourceMgr::DK_Error: 262 if (ShowColors) 263 S.changeColor(raw_ostream::RED, true); 264 S << "error: "; 265 break; 266 case SourceMgr::DK_Warning: 267 if (ShowColors) 268 S.changeColor(raw_ostream::MAGENTA, true); 269 S << "warning: "; 270 break; 271 case SourceMgr::DK_Note: 272 if (ShowColors) 273 S.changeColor(raw_ostream::BLACK, true); 274 S << "note: "; 275 break; 276 } 277 278 if (ShowColors) { 279 S.resetColor(); 280 S.changeColor(raw_ostream::SAVEDCOLOR, true); 281 } 282 283 S << Message << '\n'; 284 285 if (ShowColors) 286 S.resetColor(); 287 288 if (LineNo == -1 || ColumnNo == -1) 289 return; 290 291 // Build the line with the caret and ranges. 292 std::string CaretLine(LineContents.size()+1, ' '); 293 294 // Expand any ranges. 295 for (unsigned r = 0, e = Ranges.size(); r != e; ++r) { 296 std::pair<unsigned, unsigned> R = Ranges[r]; 297 for (unsigned i = R.first, 298 e = std::min(R.second, (unsigned)LineContents.size())+1; i != e; ++i) 299 CaretLine[i] = '~'; 300 } 301 302 // Finally, plop on the caret. 303 if (unsigned(ColumnNo) <= LineContents.size()) 304 CaretLine[ColumnNo] = '^'; 305 else 306 CaretLine[LineContents.size()] = '^'; 307 308 // ... and remove trailing whitespace so the output doesn't wrap for it. We 309 // know that the line isn't completely empty because it has the caret in it at 310 // least. 311 CaretLine.erase(CaretLine.find_last_not_of(' ')+1); 312 313 // Print out the source line one character at a time, so we can expand tabs. 314 for (unsigned i = 0, e = LineContents.size(), OutCol = 0; i != e; ++i) { 315 if (LineContents[i] != '\t') { 316 S << LineContents[i]; 317 ++OutCol; 318 continue; 319 } 320 321 // If we have a tab, emit at least one space, then round up to 8 columns. 322 do { 323 S << ' '; 324 ++OutCol; 325 } while (OutCol & 7); 326 } 327 S << '\n'; 328 329 if (ShowColors) 330 S.changeColor(raw_ostream::GREEN, true); 331 332 // Print out the caret line, matching tabs in the source line. 333 for (unsigned i = 0, e = CaretLine.size(), OutCol = 0; i != e; ++i) { 334 if (i >= LineContents.size() || LineContents[i] != '\t') { 335 S << CaretLine[i]; 336 ++OutCol; 337 continue; 338 } 339 340 // Okay, we have a tab. Insert the appropriate number of characters. 341 do { 342 S << CaretLine[i]; 343 ++OutCol; 344 } while (OutCol & 7); 345 } 346 347 if (ShowColors) 348 S.resetColor(); 349 350 S << '\n'; 351} 352 353 354