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