SourceManager.h revision cee5ec9df479994e4ba27fb65b7ded5bb5a980eb
1edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project//===--- SourceManager.h - Track and cache source files ---------*- C++ -*-===// 2edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// 3edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// The LLVM Compiler Infrastructure 4edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// 5edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// This file is distributed under the University of Illinois Open Source 6edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// License. See LICENSE.TXT for details. 7edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// 8edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project//===----------------------------------------------------------------------===// 9edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// 10edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// This file defines the SourceManager interface. 11edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project// 12edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project//===----------------------------------------------------------------------===// 13edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 14edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#ifndef LLVM_CLANG_SOURCEMANAGER_H 15edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#define LLVM_CLANG_SOURCEMANAGER_H 16edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 17edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include "clang/Basic/LLVM.h" 18edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include "clang/Basic/SourceLocation.h" 19edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include "llvm/Support/Allocator.h" 2008ff802151ea3089a5f352dfc795c99017c1d122Hans Boehm#include "llvm/Support/DataTypes.h" 2108ff802151ea3089a5f352dfc795c99017c1d122Hans Boehm#include "llvm/ADT/PointerIntPair.h" 22c5b2c0bf8007562536b822eb060fc54a01f8e08bMathias Agopian#include "llvm/ADT/PointerUnion.h" 23edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include "llvm/ADT/IntrusiveRefCntPtr.h" 24edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include "llvm/ADT/DenseMap.h" 25edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include "llvm/Support/MemoryBuffer.h" 26edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <map> 27edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <vector> 28edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project#include <cassert> 29edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 30edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace clang { 31edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 3283c0446f27b9542d6c2e724817b2b2d8d1f55085Mathias Agopianclass DiagnosticsEngine; 33edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass SourceManager; 34edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass FileManager; 35edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass FileEntry; 36edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass LineTableInfo; 37edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass LangOptions; 38edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass ASTWriter; 39edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectclass ASTReader; 40edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 41edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// There are three different types of locations in a file: a spelling 42edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// location, an expansion location, and a presumed location. 43edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// 44edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// Given an example of: 45edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// #define min(x, y) x < y ? x : y 46edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// 47edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// and then later on a use of min: 48edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// #line 17 49edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// return min(a, b); 50edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// 51edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// The expansion location is the line in the source code where the macro 52edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// was expanded (the return statement), the spelling location is the 53edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// location in the source where the macro was originally defined, 54edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// and the presumed location is where the line directive states that 55edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// the line is 17, or any other line. 56edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 57edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// SrcMgr - Public enums and private classes that are part of the 58edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// SourceManager implementation. 59edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project/// 60edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Projectnamespace SrcMgr { 61edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// CharacteristicKind - This is used to represent whether a file or directory 62edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// holds normal user code, system code, or system code which is implicitly 63edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// 'extern "C"' in C++ mode. Entire directories can be tagged with this 64edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// (this is maintained by DirectoryLookup and friends) as can specific 65edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// FileInfos when a #pragma system_header is seen or various other cases. 66edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// 67edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project enum CharacteristicKind { 68edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project C_User, C_System, C_ExternCSystem 69edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project }; 70edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 71edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// ContentCache - One instance of this struct is kept for every file 72edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// loaded or used. This object owns the MemoryBuffer object. 73edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project class ContentCache { 7408ff802151ea3089a5f352dfc795c99017c1d122Hans Boehm enum CCFlags { 75edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// \brief Whether the buffer is invalid. 76edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project InvalidFlag = 0x01, 77edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// \brief Whether the buffer should not be freed on destruction. 78edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project DoNotFreeFlag = 0x02 79edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project }; 80edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 81edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// Buffer - The actual buffer containing the characters from the input 82edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// file. This is owned by the ContentCache object. 83edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// The bits indicate indicates whether the buffer is invalid. 84edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project mutable llvm::PointerIntPair<const llvm::MemoryBuffer *, 2> Buffer; 85edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 86edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project public: 87edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// Reference to the file entry representing this ContentCache. 88edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// This reference does not own the FileEntry object. 89edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// It is possible for this to be NULL if 90edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// the ContentCache encapsulates an imaginary text buffer. 91edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const FileEntry *OrigEntry; 92edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 93edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// \brief References the file which the contents were actually loaded from. 94edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// Can be different from 'Entry' if we overridden the contents of one file 95edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// with the contents of another file. 96edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project const FileEntry *ContentsEntry; 97edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 98edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// SourceLineCache - A bump pointer allocated array of offsets for each 99edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// source line. This is lazily computed. This is owned by the 100edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// SourceManager BumpPointerAllocator object. 101edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project unsigned *SourceLineCache; 102edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project 103edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// NumLines - The number of lines in this ContentCache. This is only valid 104edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project /// if SourceLineCache is non-null. 105edbf3b6af777b721cd2a1ef461947e51e88241e1The Android Open Source Project unsigned NumLines : 31; 106 107 /// \brief Indicates whether the buffer itself was provided to override 108 /// the actual file contents. 109 /// 110 /// When true, the original entry may be a virtual file that does not 111 /// exist. 112 unsigned BufferOverridden : 1; 113 114 ContentCache(const FileEntry *Ent = 0) 115 : Buffer(0, false), OrigEntry(Ent), ContentsEntry(Ent), 116 SourceLineCache(0), NumLines(0), BufferOverridden(false) {} 117 118 ContentCache(const FileEntry *Ent, const FileEntry *contentEnt) 119 : Buffer(0, false), OrigEntry(Ent), ContentsEntry(contentEnt), 120 SourceLineCache(0), NumLines(0), BufferOverridden(false) {} 121 122 ~ContentCache(); 123 124 /// The copy ctor does not allow copies where source object has either 125 /// a non-NULL Buffer or SourceLineCache. Ownership of allocated memory 126 /// is not transferred, so this is a logical error. 127 ContentCache(const ContentCache &RHS) 128 : Buffer(0, false), SourceLineCache(0), BufferOverridden(false) 129 { 130 OrigEntry = RHS.OrigEntry; 131 ContentsEntry = RHS.ContentsEntry; 132 133 assert (RHS.Buffer.getPointer() == 0 && RHS.SourceLineCache == 0 && 134 "Passed ContentCache object cannot own a buffer."); 135 136 NumLines = RHS.NumLines; 137 } 138 139 /// getBuffer - Returns the memory buffer for the associated content. 140 /// 141 /// \param Diag Object through which diagnostics will be emitted if the 142 /// buffer cannot be retrieved. 143 /// 144 /// \param Loc If specified, is the location that invalid file diagnostics 145 /// will be emitted at. 146 /// 147 /// \param Invalid If non-NULL, will be set \c true if an error occurred. 148 const llvm::MemoryBuffer *getBuffer(DiagnosticsEngine &Diag, 149 const SourceManager &SM, 150 SourceLocation Loc = SourceLocation(), 151 bool *Invalid = 0) const; 152 153 /// getSize - Returns the size of the content encapsulated by this 154 /// ContentCache. This can be the size of the source file or the size of an 155 /// arbitrary scratch buffer. If the ContentCache encapsulates a source 156 /// file this size is retrieved from the file's FileEntry. 157 unsigned getSize() const; 158 159 /// getSizeBytesMapped - Returns the number of bytes actually mapped for 160 /// this ContentCache. This can be 0 if the MemBuffer was not actually 161 /// expanded. 162 unsigned getSizeBytesMapped() const; 163 164 /// Returns the kind of memory used to back the memory buffer for 165 /// this content cache. This is used for performance analysis. 166 llvm::MemoryBuffer::BufferKind getMemoryBufferKind() const; 167 168 void setBuffer(const llvm::MemoryBuffer *B) { 169 assert(!Buffer.getPointer() && "MemoryBuffer already set."); 170 Buffer.setPointer(B); 171 Buffer.setInt(false); 172 } 173 174 /// \brief Get the underlying buffer, returning NULL if the buffer is not 175 /// yet available. 176 const llvm::MemoryBuffer *getRawBuffer() const { 177 return Buffer.getPointer(); 178 } 179 180 /// \brief Replace the existing buffer (which will be deleted) 181 /// with the given buffer. 182 void replaceBuffer(const llvm::MemoryBuffer *B, bool DoNotFree = false); 183 184 /// \brief Determine whether the buffer itself is invalid. 185 bool isBufferInvalid() const { 186 return Buffer.getInt() & InvalidFlag; 187 } 188 189 /// \brief Determine whether the buffer should be freed. 190 bool shouldFreeBuffer() const { 191 return (Buffer.getInt() & DoNotFreeFlag) == 0; 192 } 193 194 private: 195 // Disable assignments. 196 ContentCache &operator=(const ContentCache& RHS); 197 }; 198 199 /// FileInfo - Information about a FileID, basically just the logical file 200 /// that it represents and include stack information. 201 /// 202 /// Each FileInfo has include stack information, indicating where it came 203 /// from. This information encodes the #include chain that a token was 204 /// expanded from. The main include file has an invalid IncludeLoc. 205 /// 206 /// FileInfos contain a "ContentCache *", with the contents of the file. 207 /// 208 class FileInfo { 209 /// IncludeLoc - The location of the #include that brought in this file. 210 /// This is an invalid SLOC for the main file (top of the #include chain). 211 unsigned IncludeLoc; // Really a SourceLocation 212 213 /// \brief Number of FileIDs (files and macros) that were created during 214 /// preprocessing of this #include, including this SLocEntry. 215 /// Zero means the preprocessor didn't provide such info for this SLocEntry. 216 unsigned NumCreatedFIDs; 217 218 /// Data - This contains the ContentCache* and the bits indicating the 219 /// characteristic of the file and whether it has #line info, all bitmangled 220 /// together. 221 uintptr_t Data; 222 223 friend class clang::SourceManager; 224 friend class clang::ASTWriter; 225 friend class clang::ASTReader; 226 public: 227 /// get - Return a FileInfo object. 228 static FileInfo get(SourceLocation IL, const ContentCache *Con, 229 CharacteristicKind FileCharacter) { 230 FileInfo X; 231 X.IncludeLoc = IL.getRawEncoding(); 232 X.NumCreatedFIDs = 0; 233 X.Data = (uintptr_t)Con; 234 assert((X.Data & 7) == 0 &&"ContentCache pointer insufficiently aligned"); 235 assert((unsigned)FileCharacter < 4 && "invalid file character"); 236 X.Data |= (unsigned)FileCharacter; 237 return X; 238 } 239 240 SourceLocation getIncludeLoc() const { 241 return SourceLocation::getFromRawEncoding(IncludeLoc); 242 } 243 const ContentCache* getContentCache() const { 244 return reinterpret_cast<const ContentCache*>(Data & ~7UL); 245 } 246 247 /// getCharacteristic - Return whether this is a system header or not. 248 CharacteristicKind getFileCharacteristic() const { 249 return (CharacteristicKind)(Data & 3); 250 } 251 252 /// hasLineDirectives - Return true if this FileID has #line directives in 253 /// it. 254 bool hasLineDirectives() const { return (Data & 4) != 0; } 255 256 /// setHasLineDirectives - Set the flag that indicates that this FileID has 257 /// line table entries associated with it. 258 void setHasLineDirectives() { 259 Data |= 4; 260 } 261 }; 262 263 /// ExpansionInfo - Each ExpansionInfo encodes the expansion location - where 264 /// the token was ultimately expanded, and the SpellingLoc - where the actual 265 /// character data for the token came from. 266 class ExpansionInfo { 267 // Really these are all SourceLocations. 268 269 /// SpellingLoc - Where the spelling for the token can be found. 270 unsigned SpellingLoc; 271 272 /// ExpansionLocStart/ExpansionLocEnd - In a macro expansion, these 273 /// indicate the start and end of the expansion. In object-like macros, 274 /// these will be the same. In a function-like macro expansion, the start 275 /// will be the identifier and the end will be the ')'. Finally, in 276 /// macro-argument instantitions, the end will be 'SourceLocation()', an 277 /// invalid location. 278 unsigned ExpansionLocStart, ExpansionLocEnd; 279 280 public: 281 SourceLocation getSpellingLoc() const { 282 return SourceLocation::getFromRawEncoding(SpellingLoc); 283 } 284 SourceLocation getExpansionLocStart() const { 285 return SourceLocation::getFromRawEncoding(ExpansionLocStart); 286 } 287 SourceLocation getExpansionLocEnd() const { 288 SourceLocation EndLoc = 289 SourceLocation::getFromRawEncoding(ExpansionLocEnd); 290 return EndLoc.isInvalid() ? getExpansionLocStart() : EndLoc; 291 } 292 293 std::pair<SourceLocation,SourceLocation> getExpansionLocRange() const { 294 return std::make_pair(getExpansionLocStart(), getExpansionLocEnd()); 295 } 296 297 bool isMacroArgExpansion() const { 298 // Note that this needs to return false for default constructed objects. 299 return getExpansionLocStart().isValid() && 300 SourceLocation::getFromRawEncoding(ExpansionLocEnd).isInvalid(); 301 } 302 303 bool isFunctionMacroExpansion() const { 304 return getExpansionLocStart().isValid() && 305 getExpansionLocStart() != getExpansionLocEnd(); 306 } 307 308 /// create - Return a ExpansionInfo for an expansion. Start and End specify 309 /// the expansion range (where the macro is expanded), and SpellingLoc 310 /// specifies the spelling location (where the characters from the token 311 /// come from). All three can refer to normal File SLocs or expansion 312 /// locations. 313 static ExpansionInfo create(SourceLocation SpellingLoc, 314 SourceLocation Start, SourceLocation End) { 315 ExpansionInfo X; 316 X.SpellingLoc = SpellingLoc.getRawEncoding(); 317 X.ExpansionLocStart = Start.getRawEncoding(); 318 X.ExpansionLocEnd = End.getRawEncoding(); 319 return X; 320 } 321 322 /// createForMacroArg - Return a special ExpansionInfo for the expansion of 323 /// a macro argument into a function-like macro's body. ExpansionLoc 324 /// specifies the expansion location (where the macro is expanded). This 325 /// doesn't need to be a range because a macro is always expanded at 326 /// a macro parameter reference, and macro parameters are always exactly 327 /// one token. SpellingLoc specifies the spelling location (where the 328 /// characters from the token come from). ExpansionLoc and SpellingLoc can 329 /// both refer to normal File SLocs or expansion locations. 330 /// 331 /// Given the code: 332 /// \code 333 /// #define F(x) f(x) 334 /// F(42); 335 /// \endcode 336 /// 337 /// When expanding '\c F(42)', the '\c x' would call this with an 338 /// SpellingLoc pointing at '\c 42' anad an ExpansionLoc pointing at its 339 /// location in the definition of '\c F'. 340 static ExpansionInfo createForMacroArg(SourceLocation SpellingLoc, 341 SourceLocation ExpansionLoc) { 342 // We store an intentionally invalid source location for the end of the 343 // expansion range to mark that this is a macro argument ion rather than 344 // a normal one. 345 return create(SpellingLoc, ExpansionLoc, SourceLocation()); 346 } 347 }; 348 349 /// SLocEntry - This is a discriminated union of FileInfo and 350 /// ExpansionInfo. SourceManager keeps an array of these objects, and 351 /// they are uniquely identified by the FileID datatype. 352 class SLocEntry { 353 unsigned Offset; // low bit is set for expansion info. 354 union { 355 FileInfo File; 356 ExpansionInfo Expansion; 357 }; 358 public: 359 unsigned getOffset() const { return Offset >> 1; } 360 361 bool isExpansion() const { return Offset & 1; } 362 bool isFile() const { return !isExpansion(); } 363 364 const FileInfo &getFile() const { 365 assert(isFile() && "Not a file SLocEntry!"); 366 return File; 367 } 368 369 const ExpansionInfo &getExpansion() const { 370 assert(isExpansion() && "Not a macro expansion SLocEntry!"); 371 return Expansion; 372 } 373 374 static SLocEntry get(unsigned Offset, const FileInfo &FI) { 375 SLocEntry E; 376 E.Offset = Offset << 1; 377 E.File = FI; 378 return E; 379 } 380 381 static SLocEntry get(unsigned Offset, const ExpansionInfo &Expansion) { 382 SLocEntry E; 383 E.Offset = (Offset << 1) | 1; 384 E.Expansion = Expansion; 385 return E; 386 } 387 }; 388} // end SrcMgr namespace. 389 390/// \brief External source of source location entries. 391class ExternalSLocEntrySource { 392public: 393 virtual ~ExternalSLocEntrySource(); 394 395 /// \brief Read the source location entry with index ID, which will always be 396 /// less than -1. 397 /// 398 /// \returns true if an error occurred that prevented the source-location 399 /// entry from being loaded. 400 virtual bool ReadSLocEntry(int ID) = 0; 401}; 402 403 404/// IsBeforeInTranslationUnitCache - This class holds the cache used by 405/// isBeforeInTranslationUnit. The cache structure is complex enough to be 406/// worth breaking out of SourceManager. 407class IsBeforeInTranslationUnitCache { 408 /// L/R QueryFID - These are the FID's of the cached query. If these match up 409 /// with a subsequent query, the result can be reused. 410 FileID LQueryFID, RQueryFID; 411 412 /// \brief True if LQueryFID was created before RQueryFID. This is used 413 /// to compare macro expansion locations. 414 bool IsLQFIDBeforeRQFID; 415 416 /// CommonFID - This is the file found in common between the two #include 417 /// traces. It is the nearest common ancestor of the #include tree. 418 FileID CommonFID; 419 420 /// L/R CommonOffset - This is the offset of the previous query in CommonFID. 421 /// Usually, this represents the location of the #include for QueryFID, but if 422 /// LQueryFID is a parent of RQueryFID (or vise versa) then these can be a 423 /// random token in the parent. 424 unsigned LCommonOffset, RCommonOffset; 425public: 426 427 /// isCacheValid - Return true if the currently cached values match up with 428 /// the specified LHS/RHS query. If not, we can't use the cache. 429 bool isCacheValid(FileID LHS, FileID RHS) const { 430 return LQueryFID == LHS && RQueryFID == RHS; 431 } 432 433 /// getCachedResult - If the cache is valid, compute the result given the 434 /// specified offsets in the LHS/RHS FID's. 435 bool getCachedResult(unsigned LOffset, unsigned ROffset) const { 436 // If one of the query files is the common file, use the offset. Otherwise, 437 // use the #include loc in the common file. 438 if (LQueryFID != CommonFID) LOffset = LCommonOffset; 439 if (RQueryFID != CommonFID) ROffset = RCommonOffset; 440 441 // It is common for multiple macro expansions to be "included" from the same 442 // location (expansion location), in which case use the order of the FileIDs 443 // to determine which came first. This will also take care the case where 444 // one of the locations points at the inclusion/expansion point of the other 445 // in which case its FileID will come before the other. 446 if (LOffset == ROffset) 447 return IsLQFIDBeforeRQFID; 448 449 return LOffset < ROffset; 450 } 451 452 // Set up a new query. 453 void setQueryFIDs(FileID LHS, FileID RHS, bool isLFIDBeforeRFID) { 454 assert(LHS != RHS); 455 LQueryFID = LHS; 456 RQueryFID = RHS; 457 IsLQFIDBeforeRQFID = isLFIDBeforeRFID; 458 } 459 460 void clear() { 461 LQueryFID = RQueryFID = FileID(); 462 IsLQFIDBeforeRQFID = false; 463 } 464 465 void setCommonLoc(FileID commonFID, unsigned lCommonOffset, 466 unsigned rCommonOffset) { 467 CommonFID = commonFID; 468 LCommonOffset = lCommonOffset; 469 RCommonOffset = rCommonOffset; 470 } 471 472}; 473 474/// \brief This class handles loading and caching of source files into memory. 475/// 476/// This object owns the MemoryBuffer objects for all of the loaded 477/// files and assigns unique FileID's for each unique #include chain. 478/// 479/// The SourceManager can be queried for information about SourceLocation 480/// objects, turning them into either spelling or expansion locations. Spelling 481/// locations represent where the bytes corresponding to a token came from and 482/// expansion locations represent where the location is in the user's view. In 483/// the case of a macro expansion, for example, the spelling location indicates 484/// where the expanded token came from and the expansion location specifies 485/// where it was expanded. 486class SourceManager : public llvm::RefCountedBase<SourceManager> { 487 /// \brief DiagnosticsEngine object. 488 DiagnosticsEngine &Diag; 489 490 FileManager &FileMgr; 491 492 mutable llvm::BumpPtrAllocator ContentCacheAlloc; 493 494 /// FileInfos - Memoized information about all of the files tracked by this 495 /// SourceManager. This set allows us to merge ContentCache entries based 496 /// on their FileEntry*. All ContentCache objects will thus have unique, 497 /// non-null, FileEntry pointers. 498 llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> FileInfos; 499 500 /// \brief True if the ContentCache for files that are overriden by other 501 /// files, should report the original file name. Defaults to true. 502 bool OverridenFilesKeepOriginalName; 503 504 /// \brief Files that have been overriden with the contents from another file. 505 llvm::DenseMap<const FileEntry *, const FileEntry *> OverriddenFiles; 506 507 /// MemBufferInfos - Information about various memory buffers that we have 508 /// read in. All FileEntry* within the stored ContentCache objects are NULL, 509 /// as they do not refer to a file. 510 std::vector<SrcMgr::ContentCache*> MemBufferInfos; 511 512 /// \brief The table of SLocEntries that are local to this module. 513 /// 514 /// Positive FileIDs are indexes into this table. Entry 0 indicates an invalid 515 /// expansion. 516 std::vector<SrcMgr::SLocEntry> LocalSLocEntryTable; 517 518 /// \brief The table of SLocEntries that are loaded from other modules. 519 /// 520 /// Negative FileIDs are indexes into this table. To get from ID to an index, 521 /// use (-ID - 2). 522 std::vector<SrcMgr::SLocEntry> LoadedSLocEntryTable; 523 524 /// \brief The starting offset of the next local SLocEntry. 525 /// 526 /// This is LocalSLocEntryTable.back().Offset + the size of that entry. 527 unsigned NextLocalOffset; 528 529 /// \brief The starting offset of the latest batch of loaded SLocEntries. 530 /// 531 /// This is LoadedSLocEntryTable.back().Offset, except that that entry might 532 /// not have been loaded, so that value would be unknown. 533 unsigned CurrentLoadedOffset; 534 535 /// \brief The highest possible offset is 2^31-1, so CurrentLoadedOffset 536 /// starts at 2^31. 537 static const unsigned MaxLoadedOffset = 1U << 31U; 538 539 /// \brief A bitmap that indicates whether the entries of LoadedSLocEntryTable 540 /// have already been loaded from the external source. 541 /// 542 /// Same indexing as LoadedSLocEntryTable. 543 std::vector<bool> SLocEntryLoaded; 544 545 /// \brief An external source for source location entries. 546 ExternalSLocEntrySource *ExternalSLocEntries; 547 548 /// LastFileIDLookup - This is a one-entry cache to speed up getFileID. 549 /// LastFileIDLookup records the last FileID looked up or created, because it 550 /// is very common to look up many tokens from the same file. 551 mutable FileID LastFileIDLookup; 552 553 /// LineTable - This holds information for #line directives. It is referenced 554 /// by indices from SLocEntryTable. 555 LineTableInfo *LineTable; 556 557 /// LastLineNo - These ivars serve as a cache used in the getLineNumber 558 /// method which is used to speedup getLineNumber calls to nearby locations. 559 mutable FileID LastLineNoFileIDQuery; 560 mutable SrcMgr::ContentCache *LastLineNoContentCache; 561 mutable unsigned LastLineNoFilePos; 562 mutable unsigned LastLineNoResult; 563 564 /// MainFileID - The file ID for the main source file of the translation unit. 565 FileID MainFileID; 566 567 /// \brief The file ID for the precompiled preamble there is one. 568 FileID PreambleFileID; 569 570 // Statistics for -print-stats. 571 mutable unsigned NumLinearScans, NumBinaryProbes; 572 573 // Cache results for the isBeforeInTranslationUnit method. 574 mutable IsBeforeInTranslationUnitCache IsBeforeInTUCache; 575 576 // Cache for the "fake" buffer used for error-recovery purposes. 577 mutable llvm::MemoryBuffer *FakeBufferForRecovery; 578 579 /// \brief Lazily computed map of macro argument chunks to their expanded 580 /// source location. 581 typedef std::map<unsigned, SourceLocation> MacroArgsMap; 582 583 mutable llvm::DenseMap<FileID, MacroArgsMap *> MacroArgsCacheMap; 584 585 // SourceManager doesn't support copy construction. 586 explicit SourceManager(const SourceManager&); 587 void operator=(const SourceManager&); 588public: 589 SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr); 590 ~SourceManager(); 591 592 void clearIDTables(); 593 594 DiagnosticsEngine &getDiagnostics() const { return Diag; } 595 596 FileManager &getFileManager() const { return FileMgr; } 597 598 /// \brief Set true if the SourceManager should report the original file name 599 /// for contents of files that were overriden by other files.Defaults to true. 600 void setOverridenFilesKeepOriginalName(bool value) { 601 OverridenFilesKeepOriginalName = value; 602 } 603 604 /// createMainFileIDForMembuffer - Create the FileID for a memory buffer 605 /// that will represent the FileID for the main source. One example 606 /// of when this would be used is when the main source is read from STDIN. 607 FileID createMainFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer) { 608 assert(MainFileID.isInvalid() && "MainFileID already set!"); 609 MainFileID = createFileIDForMemBuffer(Buffer); 610 return MainFileID; 611 } 612 613 //===--------------------------------------------------------------------===// 614 // MainFileID creation and querying methods. 615 //===--------------------------------------------------------------------===// 616 617 /// getMainFileID - Returns the FileID of the main source file. 618 FileID getMainFileID() const { return MainFileID; } 619 620 /// createMainFileID - Create the FileID for the main source file. 621 FileID createMainFileID(const FileEntry *SourceFile) { 622 assert(MainFileID.isInvalid() && "MainFileID already set!"); 623 MainFileID = createFileID(SourceFile, SourceLocation(), SrcMgr::C_User); 624 return MainFileID; 625 } 626 627 /// \brief Set the file ID for the precompiled preamble. 628 void setPreambleFileID(FileID Preamble) { 629 assert(PreambleFileID.isInvalid() && "PreambleFileID already set!"); 630 PreambleFileID = Preamble; 631 } 632 633 /// \brief Get the file ID for the precompiled preamble if there is one. 634 FileID getPreambleFileID() const { return PreambleFileID; } 635 636 //===--------------------------------------------------------------------===// 637 // Methods to create new FileID's and macro expansions. 638 //===--------------------------------------------------------------------===// 639 640 /// createFileID - Create a new FileID that represents the specified file 641 /// being #included from the specified IncludePosition. This translates NULL 642 /// into standard input. 643 FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos, 644 SrcMgr::CharacteristicKind FileCharacter, 645 int LoadedID = 0, unsigned LoadedOffset = 0) { 646 const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile); 647 assert(IR && "getOrCreateContentCache() cannot return NULL"); 648 return createFileID(IR, IncludePos, FileCharacter, LoadedID, LoadedOffset); 649 } 650 651 /// createFileIDForMemBuffer - Create a new FileID that represents the 652 /// specified memory buffer. This does no caching of the buffer and takes 653 /// ownership of the MemoryBuffer, so only pass a MemoryBuffer to this once. 654 FileID createFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer, 655 int LoadedID = 0, unsigned LoadedOffset = 0, 656 SourceLocation IncludeLoc = SourceLocation()) { 657 return createFileID(createMemBufferContentCache(Buffer), IncludeLoc, 658 SrcMgr::C_User, LoadedID, LoadedOffset); 659 } 660 661 /// createMacroArgExpansionLoc - Return a new SourceLocation that encodes the 662 /// fact that a token from SpellingLoc should actually be referenced from 663 /// ExpansionLoc, and that it represents the expansion of a macro argument 664 /// into the function-like macro body. 665 SourceLocation createMacroArgExpansionLoc(SourceLocation Loc, 666 SourceLocation ExpansionLoc, 667 unsigned TokLength); 668 669 /// createExpansionLoc - Return a new SourceLocation that encodes the fact 670 /// that a token from SpellingLoc should actually be referenced from 671 /// ExpansionLoc. 672 SourceLocation createExpansionLoc(SourceLocation Loc, 673 SourceLocation ExpansionLocStart, 674 SourceLocation ExpansionLocEnd, 675 unsigned TokLength, 676 int LoadedID = 0, 677 unsigned LoadedOffset = 0); 678 679 /// \brief Retrieve the memory buffer associated with the given file. 680 /// 681 /// \param Invalid If non-NULL, will be set \c true if an error 682 /// occurs while retrieving the memory buffer. 683 const llvm::MemoryBuffer *getMemoryBufferForFile(const FileEntry *File, 684 bool *Invalid = 0); 685 686 /// \brief Override the contents of the given source file by providing an 687 /// already-allocated buffer. 688 /// 689 /// \param SourceFile the source file whose contents will be overriden. 690 /// 691 /// \param Buffer the memory buffer whose contents will be used as the 692 /// data in the given source file. 693 /// 694 /// \param DoNotFree If true, then the buffer will not be freed when the 695 /// source manager is destroyed. 696 void overrideFileContents(const FileEntry *SourceFile, 697 const llvm::MemoryBuffer *Buffer, 698 bool DoNotFree = false); 699 700 /// \brief Override the the given source file with another one. 701 /// 702 /// \param SourceFile the source file which will be overriden. 703 /// 704 /// \param NewFile the file whose contents will be used as the 705 /// data instead of the contents of the given source file. 706 void overrideFileContents(const FileEntry *SourceFile, 707 const FileEntry *NewFile); 708 709 //===--------------------------------------------------------------------===// 710 // FileID manipulation methods. 711 //===--------------------------------------------------------------------===// 712 713 /// getBuffer - Return the buffer for the specified FileID. If there is an 714 /// error opening this buffer the first time, this manufactures a temporary 715 /// buffer and returns a non-empty error string. 716 const llvm::MemoryBuffer *getBuffer(FileID FID, SourceLocation Loc, 717 bool *Invalid = 0) const { 718 bool MyInvalid = false; 719 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 720 if (MyInvalid || !Entry.isFile()) { 721 if (Invalid) 722 *Invalid = true; 723 724 return getFakeBufferForRecovery(); 725 } 726 727 return Entry.getFile().getContentCache()->getBuffer(Diag, *this, Loc, 728 Invalid); 729 } 730 731 const llvm::MemoryBuffer *getBuffer(FileID FID, bool *Invalid = 0) const { 732 bool MyInvalid = false; 733 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 734 if (MyInvalid || !Entry.isFile()) { 735 if (Invalid) 736 *Invalid = true; 737 738 return getFakeBufferForRecovery(); 739 } 740 741 return Entry.getFile().getContentCache()->getBuffer(Diag, *this, 742 SourceLocation(), 743 Invalid); 744 } 745 746 /// getFileEntryForID - Returns the FileEntry record for the provided FileID. 747 const FileEntry *getFileEntryForID(FileID FID) const { 748 bool MyInvalid = false; 749 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 750 if (MyInvalid || !Entry.isFile()) 751 return 0; 752 753 return Entry.getFile().getContentCache()->OrigEntry; 754 } 755 756 /// Returns the FileEntry record for the provided SLocEntry. 757 const FileEntry *getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const 758 { 759 return sloc.getFile().getContentCache()->OrigEntry; 760 } 761 762 /// getBufferData - Return a StringRef to the source buffer data for the 763 /// specified FileID. 764 /// 765 /// \param FID The file ID whose contents will be returned. 766 /// \param Invalid If non-NULL, will be set true if an error occurred. 767 StringRef getBufferData(FileID FID, bool *Invalid = 0) const; 768 769 /// \brief Get the number of FileIDs (files and macros) that were created 770 /// during preprocessing of \p FID, including it. 771 unsigned getNumCreatedFIDsForFileID(FileID FID) const { 772 bool Invalid = false; 773 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 774 if (Invalid || !Entry.isFile()) 775 return 0; 776 777 return Entry.getFile().NumCreatedFIDs; 778 } 779 780 /// \brief Set the number of FileIDs (files and macros) that were created 781 /// during preprocessing of \p FID, including it. 782 void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs) const { 783 bool Invalid = false; 784 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 785 if (Invalid || !Entry.isFile()) 786 return; 787 788 assert(Entry.getFile().NumCreatedFIDs == 0 && "Already set!"); 789 const_cast<SrcMgr::FileInfo &>(Entry.getFile()).NumCreatedFIDs = NumFIDs; 790 } 791 792 //===--------------------------------------------------------------------===// 793 // SourceLocation manipulation methods. 794 //===--------------------------------------------------------------------===// 795 796 /// getFileID - Return the FileID for a SourceLocation. This is a very 797 /// hot method that is used for all SourceManager queries that start with a 798 /// SourceLocation object. It is responsible for finding the entry in 799 /// SLocEntryTable which contains the specified location. 800 /// 801 FileID getFileID(SourceLocation SpellingLoc) const { 802 unsigned SLocOffset = SpellingLoc.getOffset(); 803 804 // If our one-entry cache covers this offset, just return it. 805 if (isOffsetInFileID(LastFileIDLookup, SLocOffset)) 806 return LastFileIDLookup; 807 808 return getFileIDSlow(SLocOffset); 809 } 810 811 /// getLocForStartOfFile - Return the source location corresponding to the 812 /// first byte of the specified file. 813 SourceLocation getLocForStartOfFile(FileID FID) const { 814 bool Invalid = false; 815 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 816 if (Invalid || !Entry.isFile()) 817 return SourceLocation(); 818 819 unsigned FileOffset = Entry.getOffset(); 820 return SourceLocation::getFileLoc(FileOffset); 821 } 822 823 /// \brief Return the source location corresponding to the last byte of the 824 /// specified file. 825 SourceLocation getLocForEndOfFile(FileID FID) const { 826 bool Invalid = false; 827 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 828 if (Invalid || !Entry.isFile()) 829 return SourceLocation(); 830 831 unsigned FileOffset = Entry.getOffset(); 832 return SourceLocation::getFileLoc(FileOffset + getFileIDSize(FID) - 1); 833 } 834 835 /// \brief Returns the include location if \p FID is a #include'd file 836 /// otherwise it returns an invalid location. 837 SourceLocation getIncludeLoc(FileID FID) const { 838 bool Invalid = false; 839 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 840 if (Invalid || !Entry.isFile()) 841 return SourceLocation(); 842 843 return Entry.getFile().getIncludeLoc(); 844 } 845 846 /// getExpansionLoc - Given a SourceLocation object, return the expansion 847 /// location referenced by the ID. 848 SourceLocation getExpansionLoc(SourceLocation Loc) const { 849 // Handle the non-mapped case inline, defer to out of line code to handle 850 // expansions. 851 if (Loc.isFileID()) return Loc; 852 return getExpansionLocSlowCase(Loc); 853 } 854 855 /// \brief Given \p Loc, if it is a macro location return the expansion 856 /// location or the spelling location, depending on if it comes from a 857 /// macro argument or not. 858 SourceLocation getFileLoc(SourceLocation Loc) const { 859 if (Loc.isFileID()) return Loc; 860 return getFileLocSlowCase(Loc); 861 } 862 863 /// getImmediateExpansionRange - Loc is required to be an expansion location. 864 /// Return the start/end of the expansion information. 865 std::pair<SourceLocation,SourceLocation> 866 getImmediateExpansionRange(SourceLocation Loc) const; 867 868 /// getExpansionRange - Given a SourceLocation object, return the range of 869 /// tokens covered by the expansion the ultimate file. 870 std::pair<SourceLocation,SourceLocation> 871 getExpansionRange(SourceLocation Loc) const; 872 873 874 /// getSpellingLoc - Given a SourceLocation object, return the spelling 875 /// location referenced by the ID. This is the place where the characters 876 /// that make up the lexed token can be found. 877 SourceLocation getSpellingLoc(SourceLocation Loc) const { 878 // Handle the non-mapped case inline, defer to out of line code to handle 879 // expansions. 880 if (Loc.isFileID()) return Loc; 881 return getSpellingLocSlowCase(Loc); 882 } 883 884 /// getImmediateSpellingLoc - Given a SourceLocation object, return the 885 /// spelling location referenced by the ID. This is the first level down 886 /// towards the place where the characters that make up the lexed token can be 887 /// found. This should not generally be used by clients. 888 SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const; 889 890 /// getDecomposedLoc - Decompose the specified location into a raw FileID + 891 /// Offset pair. The first element is the FileID, the second is the 892 /// offset from the start of the buffer of the location. 893 std::pair<FileID, unsigned> getDecomposedLoc(SourceLocation Loc) const { 894 FileID FID = getFileID(Loc); 895 bool Invalid = false; 896 const SrcMgr::SLocEntry &E = getSLocEntry(FID, &Invalid); 897 if (Invalid) 898 return std::make_pair(FileID(), 0); 899 return std::make_pair(FID, Loc.getOffset()-E.getOffset()); 900 } 901 902 /// getDecomposedExpansionLoc - Decompose the specified location into a raw 903 /// FileID + Offset pair. If the location is an expansion record, walk 904 /// through it until we find the final location expanded. 905 std::pair<FileID, unsigned> 906 getDecomposedExpansionLoc(SourceLocation Loc) const { 907 FileID FID = getFileID(Loc); 908 bool Invalid = false; 909 const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid); 910 if (Invalid) 911 return std::make_pair(FileID(), 0); 912 913 unsigned Offset = Loc.getOffset()-E->getOffset(); 914 if (Loc.isFileID()) 915 return std::make_pair(FID, Offset); 916 917 return getDecomposedExpansionLocSlowCase(E); 918 } 919 920 /// getDecomposedSpellingLoc - Decompose the specified location into a raw 921 /// FileID + Offset pair. If the location is an expansion record, walk 922 /// through it until we find its spelling record. 923 std::pair<FileID, unsigned> 924 getDecomposedSpellingLoc(SourceLocation Loc) const { 925 FileID FID = getFileID(Loc); 926 bool Invalid = false; 927 const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid); 928 if (Invalid) 929 return std::make_pair(FileID(), 0); 930 931 unsigned Offset = Loc.getOffset()-E->getOffset(); 932 if (Loc.isFileID()) 933 return std::make_pair(FID, Offset); 934 return getDecomposedSpellingLocSlowCase(E, Offset); 935 } 936 937 /// getFileOffset - This method returns the offset from the start 938 /// of the file that the specified SourceLocation represents. This is not very 939 /// meaningful for a macro ID. 940 unsigned getFileOffset(SourceLocation SpellingLoc) const { 941 return getDecomposedLoc(SpellingLoc).second; 942 } 943 944 /// isMacroArgExpansion - This method tests whether the given source location 945 /// represents a macro argument's expansion into the function-like macro 946 /// definition. Such source locations only appear inside of the expansion 947 /// locations representing where a particular function-like macro was 948 /// expanded. 949 bool isMacroArgExpansion(SourceLocation Loc) const; 950 951 /// \brief Returns true if \p Loc is inside the [\p Start, +\p Length) 952 /// chunk of the source location address space. 953 /// If it's true and \p RelativeOffset is non-null, it will be set to the 954 /// relative offset of \p Loc inside the chunk. 955 bool isInSLocAddrSpace(SourceLocation Loc, 956 SourceLocation Start, unsigned Length, 957 unsigned *RelativeOffset = 0) const { 958 assert(((Start.getOffset() < NextLocalOffset && 959 Start.getOffset()+Length <= NextLocalOffset) || 960 (Start.getOffset() >= CurrentLoadedOffset && 961 Start.getOffset()+Length < MaxLoadedOffset)) && 962 "Chunk is not valid SLoc address space"); 963 unsigned LocOffs = Loc.getOffset(); 964 unsigned BeginOffs = Start.getOffset(); 965 unsigned EndOffs = BeginOffs + Length; 966 if (LocOffs >= BeginOffs && LocOffs < EndOffs) { 967 if (RelativeOffset) 968 *RelativeOffset = LocOffs - BeginOffs; 969 return true; 970 } 971 972 return false; 973 } 974 975 /// \brief Return true if both \p LHS and \p RHS are in the local source 976 /// location address space or the loaded one. If it's true and \p 977 /// RelativeOffset is non-null, it will be set to the offset of \p RHS 978 /// relative to \p LHS. 979 bool isInSameSLocAddrSpace(SourceLocation LHS, SourceLocation RHS, 980 int *RelativeOffset) const { 981 unsigned LHSOffs = LHS.getOffset(), RHSOffs = RHS.getOffset(); 982 bool LHSLoaded = LHSOffs >= CurrentLoadedOffset; 983 bool RHSLoaded = RHSOffs >= CurrentLoadedOffset; 984 985 if (LHSLoaded == RHSLoaded) { 986 if (RelativeOffset) 987 *RelativeOffset = RHSOffs - LHSOffs; 988 return true; 989 } 990 991 return false; 992 } 993 994 //===--------------------------------------------------------------------===// 995 // Queries about the code at a SourceLocation. 996 //===--------------------------------------------------------------------===// 997 998 /// getCharacterData - Return a pointer to the start of the specified location 999 /// in the appropriate spelling MemoryBuffer. 1000 /// 1001 /// \param Invalid If non-NULL, will be set \c true if an error occurs. 1002 const char *getCharacterData(SourceLocation SL, bool *Invalid = 0) const; 1003 1004 /// getColumnNumber - Return the column # for the specified file position. 1005 /// This is significantly cheaper to compute than the line number. This 1006 /// returns zero if the column number isn't known. This may only be called 1007 /// on a file sloc, so you must choose a spelling or expansion location 1008 /// before calling this method. 1009 unsigned getColumnNumber(FileID FID, unsigned FilePos, 1010 bool *Invalid = 0) const; 1011 unsigned getSpellingColumnNumber(SourceLocation Loc, bool *Invalid = 0) const; 1012 unsigned getExpansionColumnNumber(SourceLocation Loc, 1013 bool *Invalid = 0) const; 1014 unsigned getPresumedColumnNumber(SourceLocation Loc, bool *Invalid = 0) const; 1015 1016 1017 /// getLineNumber - Given a SourceLocation, return the spelling line number 1018 /// for the position indicated. This requires building and caching a table of 1019 /// line offsets for the MemoryBuffer, so this is not cheap: use only when 1020 /// about to emit a diagnostic. 1021 unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid = 0) const; 1022 unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 1023 unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 1024 unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 1025 1026 /// Return the filename or buffer identifier of the buffer the location is in. 1027 /// Note that this name does not respect #line directives. Use getPresumedLoc 1028 /// for normal clients. 1029 const char *getBufferName(SourceLocation Loc, bool *Invalid = 0) const; 1030 1031 /// getFileCharacteristic - return the file characteristic of the specified 1032 /// source location, indicating whether this is a normal file, a system 1033 /// header, or an "implicit extern C" system header. 1034 /// 1035 /// This state can be modified with flags on GNU linemarker directives like: 1036 /// # 4 "foo.h" 3 1037 /// which changes all source locations in the current file after that to be 1038 /// considered to be from a system header. 1039 SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const; 1040 1041 /// getPresumedLoc - This method returns the "presumed" location of a 1042 /// SourceLocation specifies. A "presumed location" can be modified by #line 1043 /// or GNU line marker directives. This provides a view on the data that a 1044 /// user should see in diagnostics, for example. 1045 /// 1046 /// Note that a presumed location is always given as the expansion point of 1047 /// an expansion location, not at the spelling location. 1048 /// 1049 /// \returns The presumed location of the specified SourceLocation. If the 1050 /// presumed location cannot be calculate (e.g., because \p Loc is invalid 1051 /// or the file containing \p Loc has changed on disk), returns an invalid 1052 /// presumed location. 1053 PresumedLoc getPresumedLoc(SourceLocation Loc) const; 1054 1055 /// isFromSameFile - Returns true if both SourceLocations correspond to 1056 /// the same file. 1057 bool isFromSameFile(SourceLocation Loc1, SourceLocation Loc2) const { 1058 return getFileID(Loc1) == getFileID(Loc2); 1059 } 1060 1061 /// isFromMainFile - Returns true if the file of provided SourceLocation is 1062 /// the main file. 1063 bool isFromMainFile(SourceLocation Loc) const { 1064 return getFileID(Loc) == getMainFileID(); 1065 } 1066 1067 /// isInSystemHeader - Returns if a SourceLocation is in a system header. 1068 bool isInSystemHeader(SourceLocation Loc) const { 1069 return getFileCharacteristic(Loc) != SrcMgr::C_User; 1070 } 1071 1072 /// isInExternCSystemHeader - Returns if a SourceLocation is in an "extern C" 1073 /// system header. 1074 bool isInExternCSystemHeader(SourceLocation Loc) const { 1075 return getFileCharacteristic(Loc) == SrcMgr::C_ExternCSystem; 1076 } 1077 1078 /// \brief The size of the SLocEnty that \p FID represents. 1079 unsigned getFileIDSize(FileID FID) const; 1080 1081 /// \brief Given a specific FileID, returns true if \p Loc is inside that 1082 /// FileID chunk and sets relative offset (offset of \p Loc from beginning 1083 /// of FileID) to \p relativeOffset. 1084 bool isInFileID(SourceLocation Loc, FileID FID, 1085 unsigned *RelativeOffset = 0) const { 1086 unsigned Offs = Loc.getOffset(); 1087 if (isOffsetInFileID(FID, Offs)) { 1088 if (RelativeOffset) 1089 *RelativeOffset = Offs - getSLocEntry(FID).getOffset(); 1090 return true; 1091 } 1092 1093 return false; 1094 } 1095 1096 //===--------------------------------------------------------------------===// 1097 // Line Table Manipulation Routines 1098 //===--------------------------------------------------------------------===// 1099 1100 /// getLineTableFilenameID - Return the uniqued ID for the specified filename. 1101 /// 1102 unsigned getLineTableFilenameID(StringRef Str); 1103 1104 /// AddLineNote - Add a line note to the line table for the FileID and offset 1105 /// specified by Loc. If FilenameID is -1, it is considered to be 1106 /// unspecified. 1107 void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID); 1108 void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID, 1109 bool IsFileEntry, bool IsFileExit, 1110 bool IsSystemHeader, bool IsExternCHeader); 1111 1112 /// \brief Determine if the source manager has a line table. 1113 bool hasLineTable() const { return LineTable != 0; } 1114 1115 /// \brief Retrieve the stored line table. 1116 LineTableInfo &getLineTable(); 1117 1118 //===--------------------------------------------------------------------===// 1119 // Queries for performance analysis. 1120 //===--------------------------------------------------------------------===// 1121 1122 /// Return the total amount of physical memory allocated by the 1123 /// ContentCache allocator. 1124 size_t getContentCacheSize() const { 1125 return ContentCacheAlloc.getTotalMemory(); 1126 } 1127 1128 struct MemoryBufferSizes { 1129 const size_t malloc_bytes; 1130 const size_t mmap_bytes; 1131 1132 MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes) 1133 : malloc_bytes(malloc_bytes), mmap_bytes(mmap_bytes) {} 1134 }; 1135 1136 /// Return the amount of memory used by memory buffers, breaking down 1137 /// by heap-backed versus mmap'ed memory. 1138 MemoryBufferSizes getMemoryBufferSizes() const; 1139 1140 // Return the amount of memory used for various side tables and 1141 // data structures in the SourceManager. 1142 size_t getDataStructureSizes() const; 1143 1144 //===--------------------------------------------------------------------===// 1145 // Other miscellaneous methods. 1146 //===--------------------------------------------------------------------===// 1147 1148 /// \brief Get the source location for the given file:line:col triplet. 1149 /// 1150 /// If the source file is included multiple times, the source location will 1151 /// be based upon the first inclusion. 1152 SourceLocation translateFileLineCol(const FileEntry *SourceFile, 1153 unsigned Line, unsigned Col) const; 1154 1155 /// \brief Get the FileID for the given file. 1156 /// 1157 /// If the source file is included multiple times, the FileID will be the 1158 /// first inclusion. 1159 FileID translateFile(const FileEntry *SourceFile) const; 1160 1161 /// \brief Get the source location in \p FID for the given line:col. 1162 /// Returns null location if \p FID is not a file SLocEntry. 1163 SourceLocation translateLineCol(FileID FID, 1164 unsigned Line, unsigned Col) const; 1165 1166 /// \brief If \p Loc points inside a function macro argument, the returned 1167 /// location will be the macro location in which the argument was expanded. 1168 /// If a macro argument is used multiple times, the expanded location will 1169 /// be at the first expansion of the argument. 1170 /// e.g. 1171 /// MY_MACRO(foo); 1172 /// ^ 1173 /// Passing a file location pointing at 'foo', will yield a macro location 1174 /// where 'foo' was expanded into. 1175 SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const; 1176 1177 /// \brief Determines the order of 2 source locations in the translation unit. 1178 /// 1179 /// \returns true if LHS source location comes before RHS, false otherwise. 1180 bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const; 1181 1182 /// \brief Comparison function class. 1183 class LocBeforeThanCompare : public std::binary_function<SourceLocation, 1184 SourceLocation, bool> { 1185 SourceManager &SM; 1186 1187 public: 1188 explicit LocBeforeThanCompare(SourceManager &SM) : SM(SM) { } 1189 1190 bool operator()(SourceLocation LHS, SourceLocation RHS) const { 1191 return SM.isBeforeInTranslationUnit(LHS, RHS); 1192 } 1193 }; 1194 1195 /// \brief Determines the order of 2 source locations in the "source location 1196 /// address space". 1197 bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const { 1198 return isBeforeInSLocAddrSpace(LHS, RHS.getOffset()); 1199 } 1200 1201 /// \brief Determines the order of a source location and a source location 1202 /// offset in the "source location address space". 1203 /// 1204 /// Note that we always consider source locations loaded from 1205 bool isBeforeInSLocAddrSpace(SourceLocation LHS, unsigned RHS) const { 1206 unsigned LHSOffset = LHS.getOffset(); 1207 bool LHSLoaded = LHSOffset >= CurrentLoadedOffset; 1208 bool RHSLoaded = RHS >= CurrentLoadedOffset; 1209 if (LHSLoaded == RHSLoaded) 1210 return LHSOffset < RHS; 1211 1212 return LHSLoaded; 1213 } 1214 1215 // Iterators over FileInfos. 1216 typedef llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> 1217 ::const_iterator fileinfo_iterator; 1218 fileinfo_iterator fileinfo_begin() const { return FileInfos.begin(); } 1219 fileinfo_iterator fileinfo_end() const { return FileInfos.end(); } 1220 bool hasFileInfo(const FileEntry *File) const { 1221 return FileInfos.find(File) != FileInfos.end(); 1222 } 1223 1224 /// PrintStats - Print statistics to stderr. 1225 /// 1226 void PrintStats() const; 1227 1228 /// \brief Get the number of local SLocEntries we have. 1229 unsigned local_sloc_entry_size() const { return LocalSLocEntryTable.size(); } 1230 1231 /// \brief Get a local SLocEntry. This is exposed for indexing. 1232 const SrcMgr::SLocEntry &getLocalSLocEntry(unsigned Index, 1233 bool *Invalid = 0) const { 1234 assert(Index < LocalSLocEntryTable.size() && "Invalid index"); 1235 return LocalSLocEntryTable[Index]; 1236 } 1237 1238 /// \brief Get the number of loaded SLocEntries we have. 1239 unsigned loaded_sloc_entry_size() const { return LoadedSLocEntryTable.size();} 1240 1241 /// \brief Get a loaded SLocEntry. This is exposed for indexing. 1242 const SrcMgr::SLocEntry &getLoadedSLocEntry(unsigned Index, 1243 bool *Invalid = 0) const { 1244 assert(Index < LoadedSLocEntryTable.size() && "Invalid index"); 1245 if (!SLocEntryLoaded[Index]) 1246 ExternalSLocEntries->ReadSLocEntry(-(static_cast<int>(Index) + 2)); 1247 return LoadedSLocEntryTable[Index]; 1248 } 1249 1250 const SrcMgr::SLocEntry &getSLocEntry(FileID FID, bool *Invalid = 0) const { 1251 if (FID.ID == 0 || FID.ID == -1) { 1252 if (Invalid) *Invalid = true; 1253 return LocalSLocEntryTable[0]; 1254 } 1255 return getSLocEntryByID(FID.ID); 1256 } 1257 1258 unsigned getNextLocalOffset() const { return NextLocalOffset; } 1259 1260 void setExternalSLocEntrySource(ExternalSLocEntrySource *Source) { 1261 assert(LoadedSLocEntryTable.empty() && 1262 "Invalidating existing loaded entries"); 1263 ExternalSLocEntries = Source; 1264 } 1265 1266 /// \brief Allocate a number of loaded SLocEntries, which will be actually 1267 /// loaded on demand from the external source. 1268 /// 1269 /// NumSLocEntries will be allocated, which occupy a total of TotalSize space 1270 /// in the global source view. The lowest ID and the base offset of the 1271 /// entries will be returned. 1272 std::pair<int, unsigned> 1273 AllocateLoadedSLocEntries(unsigned NumSLocEntries, unsigned TotalSize); 1274 1275 /// \brief Returns true if \p Loc came from a PCH/Module. 1276 bool isLoadedSourceLocation(SourceLocation Loc) const { 1277 return Loc.getOffset() >= CurrentLoadedOffset; 1278 } 1279 1280 /// \brief Returns true if \p Loc did not come from a PCH/Module. 1281 bool isLocalSourceLocation(SourceLocation Loc) const { 1282 return Loc.getOffset() < NextLocalOffset; 1283 } 1284 1285 /// \brief Returns true if \p FID came from a PCH/Module. 1286 bool isLoadedFileID(FileID FID) const { 1287 assert(FID.ID != -1 && "Using FileID sentinel value"); 1288 return FID.ID < 0; 1289 } 1290 1291 /// \brief Returns true if \p FID did not come from a PCH/Module. 1292 bool isLocalFileID(FileID FID) const { 1293 return !isLoadedFileID(FID); 1294 } 1295 1296private: 1297 const llvm::MemoryBuffer *getFakeBufferForRecovery() const; 1298 1299 /// \brief Get the entry with the given unwrapped FileID. 1300 const SrcMgr::SLocEntry &getSLocEntryByID(int ID) const { 1301 assert(ID != -1 && "Using FileID sentinel value"); 1302 if (ID < 0) 1303 return getLoadedSLocEntryByID(ID); 1304 return getLocalSLocEntry(static_cast<unsigned>(ID)); 1305 } 1306 1307 const SrcMgr::SLocEntry &getLoadedSLocEntryByID(int ID) const { 1308 return getLoadedSLocEntry(static_cast<unsigned>(-ID - 2)); 1309 } 1310 1311 /// createExpansionLoc - Implements the common elements of storing an 1312 /// expansion info struct into the SLocEntry table and producing a source 1313 /// location that refers to it. 1314 SourceLocation createExpansionLocImpl(const SrcMgr::ExpansionInfo &Expansion, 1315 unsigned TokLength, 1316 int LoadedID = 0, 1317 unsigned LoadedOffset = 0); 1318 1319 /// isOffsetInFileID - Return true if the specified FileID contains the 1320 /// specified SourceLocation offset. This is a very hot method. 1321 inline bool isOffsetInFileID(FileID FID, unsigned SLocOffset) const { 1322 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID); 1323 // If the entry is after the offset, it can't contain it. 1324 if (SLocOffset < Entry.getOffset()) return false; 1325 1326 // If this is the very last entry then it does. 1327 if (FID.ID == -2) 1328 return true; 1329 1330 // If it is the last local entry, then it does if the location is local. 1331 if (static_cast<unsigned>(FID.ID+1) == LocalSLocEntryTable.size()) { 1332 return SLocOffset < NextLocalOffset; 1333 } 1334 1335 // Otherwise, the entry after it has to not include it. This works for both 1336 // local and loaded entries. 1337 return SLocOffset < getSLocEntry(FileID::get(FID.ID+1)).getOffset(); 1338 } 1339 1340 /// createFileID - Create a new fileID for the specified ContentCache and 1341 /// include position. This works regardless of whether the ContentCache 1342 /// corresponds to a file or some other input source. 1343 FileID createFileID(const SrcMgr::ContentCache* File, 1344 SourceLocation IncludePos, 1345 SrcMgr::CharacteristicKind DirCharacter, 1346 int LoadedID, unsigned LoadedOffset); 1347 1348 const SrcMgr::ContentCache * 1349 getOrCreateContentCache(const FileEntry *SourceFile); 1350 1351 /// createMemBufferContentCache - Create a new ContentCache for the specified 1352 /// memory buffer. 1353 const SrcMgr::ContentCache* 1354 createMemBufferContentCache(const llvm::MemoryBuffer *Buf); 1355 1356 FileID getFileIDSlow(unsigned SLocOffset) const; 1357 FileID getFileIDLocal(unsigned SLocOffset) const; 1358 FileID getFileIDLoaded(unsigned SLocOffset) const; 1359 1360 SourceLocation getExpansionLocSlowCase(SourceLocation Loc) const; 1361 SourceLocation getSpellingLocSlowCase(SourceLocation Loc) const; 1362 SourceLocation getFileLocSlowCase(SourceLocation Loc) const; 1363 1364 std::pair<FileID, unsigned> 1365 getDecomposedExpansionLocSlowCase(const SrcMgr::SLocEntry *E) const; 1366 std::pair<FileID, unsigned> 1367 getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E, 1368 unsigned Offset) const; 1369 void computeMacroArgsCache(MacroArgsMap *&MacroArgsCache, FileID FID) const; 1370 1371 friend class ASTReader; 1372 friend class ASTWriter; 1373}; 1374 1375 1376} // end namespace clang 1377 1378#endif 1379