contrib/llvm/tools/clang/include/clang/Basic/SourceManager.h

   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
  30 namespace clang {
  31
  32 class DiagnosticsEngine;
  33 class SourceManager;
  34 class FileManager;
  35 class FileEntry;
  36 class LineTableInfo;
  37 class LangOptions;
  38 class ASTWriter;
  39 class 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 ///
  60 namespace 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     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.
 391 class ExternalSLocEntrySource {
 392 public:
 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.
 407 class 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;
 425 public:
 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.
 486 class SourceManager : public 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   mutable 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   mutable SrcMgr::ContentCache *FakeContentCacheForRecovery;
 580
 581   /// \brief Lazily computed map of macro argument chunks to their expanded
 582   /// source location.
 583   typedef std::map<unsigned, SourceLocation> MacroArgsMap;
 584
 585   mutable llvm::DenseMap<FileID, MacroArgsMap *> MacroArgsCacheMap;
 586
 587   // SourceManager doesn't support copy construction.
 588   explicit SourceManager(const SourceManager&);
 589   void operator=(const SourceManager&);
 590 public:
 591   SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr);
 592   ~SourceManager();
 593
 594   void clearIDTables();
 595
 596   DiagnosticsEngine &getDiagnostics() const { return Diag; }
 597
 598   FileManager &getFileManager() const { return FileMgr; }
 599
 600   /// \brief Set true if the SourceManager should report the original file name
 601   /// for contents of files that were overriden by other files.Defaults to true.
 602   void setOverridenFilesKeepOriginalName(bool value) {
 603     OverridenFilesKeepOriginalName = value;
 604   }
 605
 606   /// createMainFileIDForMembuffer - Create the FileID for a memory buffer
 607   ///  that will represent the FileID for the main source.  One example
 608   ///  of when this would be used is when the main source is read from STDIN.
 609   FileID createMainFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer) {
 610     assert(MainFileID.isInvalid() && "MainFileID already set!");
 611     MainFileID = createFileIDForMemBuffer(Buffer);
 612     return MainFileID;
 613   }
 614
 615   //===--------------------------------------------------------------------===//
 616   // MainFileID creation and querying methods.
 617   //===--------------------------------------------------------------------===//
 618
 619   /// getMainFileID - Returns the FileID of the main source file.
 620   FileID getMainFileID() const { return MainFileID; }
 621
 622   /// createMainFileID - Create the FileID for the main source file.
 623   FileID createMainFileID(const FileEntry *SourceFile,
 624                           SrcMgr::CharacteristicKind Kind = SrcMgr::C_User) {
 625     assert(MainFileID.isInvalid() && "MainFileID already set!");
 626     MainFileID = createFileID(SourceFile, SourceLocation(), Kind);
 627     return MainFileID;
 628   }
 629
 630   /// \brief Set the file ID for the main source file.
 631   void setMainFileID(FileID FID) {
 632     assert(MainFileID.isInvalid() && "MainFileID already set!");
 633     MainFileID = FID;
 634   }
 635
 636   /// \brief Set the file ID for the precompiled preamble.
 637   void setPreambleFileID(FileID Preamble) {
 638     assert(PreambleFileID.isInvalid() && "PreambleFileID already set!");
 639     PreambleFileID = Preamble;
 640   }
 641
 642   /// \brief Get the file ID for the precompiled preamble if there is one.
 643   FileID getPreambleFileID() const { return PreambleFileID; }
 644
 645   //===--------------------------------------------------------------------===//
 646   // Methods to create new FileID's and macro expansions.
 647   //===--------------------------------------------------------------------===//
 648
 649   /// createFileID - Create a new FileID that represents the specified file
 650   /// being #included from the specified IncludePosition.  This translates NULL
 651   /// into standard input.
 652   FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos,
 653                       SrcMgr::CharacteristicKind FileCharacter,
 654                       int LoadedID = 0, unsigned LoadedOffset = 0) {
 655     const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile);
 656     assert(IR && "getOrCreateContentCache() cannot return NULL");
 657     return createFileID(IR, IncludePos, FileCharacter, LoadedID, LoadedOffset);
 658   }
 659
 660   /// createFileIDForMemBuffer - Create a new FileID that represents the
 661   /// specified memory buffer.  This does no caching of the buffer and takes
 662   /// ownership of the MemoryBuffer, so only pass a MemoryBuffer to this once.
 663   FileID createFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer,
 664                                   int LoadedID = 0, unsigned LoadedOffset = 0,
 665                                  SourceLocation IncludeLoc = SourceLocation()) {
 666     return createFileID(createMemBufferContentCache(Buffer), IncludeLoc,
 667                         SrcMgr::C_User, LoadedID, LoadedOffset);
 668   }
 669
 670   /// createMacroArgExpansionLoc - Return a new SourceLocation that encodes the
 671   /// fact that a token from SpellingLoc should actually be referenced from
 672   /// ExpansionLoc, and that it represents the expansion of a macro argument
 673   /// into the function-like macro body.
 674   SourceLocation createMacroArgExpansionLoc(SourceLocation Loc,
 675                                             SourceLocation ExpansionLoc,
 676                                             unsigned TokLength);
 677
 678   /// createExpansionLoc - Return a new SourceLocation that encodes the fact
 679   /// that a token from SpellingLoc should actually be referenced from
 680   /// ExpansionLoc.
 681   SourceLocation createExpansionLoc(SourceLocation Loc,
 682                                     SourceLocation ExpansionLocStart,
 683                                     SourceLocation ExpansionLocEnd,
 684                                     unsigned TokLength,
 685                                     int LoadedID = 0,
 686                                     unsigned LoadedOffset = 0);
 687
 688   /// \brief Retrieve the memory buffer associated with the given file.
 689   ///
 690   /// \param Invalid If non-NULL, will be set \c true if an error
 691   /// occurs while retrieving the memory buffer.
 692   const llvm::MemoryBuffer *getMemoryBufferForFile(const FileEntry *File,
 693                                                    bool *Invalid = 0);
 694
 695   /// \brief Override the contents of the given source file by providing an
 696   /// already-allocated buffer.
 697   ///
 698   /// \param SourceFile the source file whose contents will be overriden.
 699   ///
 700   /// \param Buffer the memory buffer whose contents will be used as the
 701   /// data in the given source file.
 702   ///
 703   /// \param DoNotFree If true, then the buffer will not be freed when the
 704   /// source manager is destroyed.
 705   void overrideFileContents(const FileEntry *SourceFile,
 706                             const llvm::MemoryBuffer *Buffer,
 707                             bool DoNotFree = false);
 708
 709   /// \brief Override the the given source file with another one.
 710   ///
 711   /// \param SourceFile the source file which will be overriden.
 712   ///
 713   /// \param NewFile the file whose contents will be used as the
 714   /// data instead of the contents of the given source file.
 715   void overrideFileContents(const FileEntry *SourceFile,
 716                             const FileEntry *NewFile);
 717
 718   //===--------------------------------------------------------------------===//
 719   // FileID manipulation methods.
 720   //===--------------------------------------------------------------------===//
 721
 722   /// getBuffer - Return the buffer for the specified FileID. If there is an
 723   /// error opening this buffer the first time, this manufactures a temporary
 724   /// buffer and returns a non-empty error string.
 725   const llvm::MemoryBuffer *getBuffer(FileID FID, SourceLocation Loc,
 726                                       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, Loc,
 737                                                         Invalid);
 738   }
 739
 740   const llvm::MemoryBuffer *getBuffer(FileID FID, bool *Invalid = 0) const {
 741     bool MyInvalid = false;
 742     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
 743     if (MyInvalid || !Entry.isFile()) {
 744       if (Invalid)
 745         *Invalid = true;
 746
 747       return getFakeBufferForRecovery();
 748     }
 749
 750     return Entry.getFile().getContentCache()->getBuffer(Diag, *this,
 751                                                         SourceLocation(),
 752                                                         Invalid);
 753   }
 754
 755   /// getFileEntryForID - Returns the FileEntry record for the provided FileID.
 756   const FileEntry *getFileEntryForID(FileID FID) const {
 757     bool MyInvalid = false;
 758     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
 759     if (MyInvalid || !Entry.isFile())
 760       return 0;
 761
 762     const SrcMgr::ContentCache *Content = Entry.getFile().getContentCache();
 763     if (!Content)
 764       return 0;
 765     return Content->OrigEntry;
 766   }
 767
 768   /// Returns the FileEntry record for the provided SLocEntry.
 769   const FileEntry *getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const
 770   {
 771     const SrcMgr::ContentCache *Content = sloc.getFile().getContentCache();
 772     if (!Content)
 773       return 0;
 774     return Content->OrigEntry;
 775   }
 776
 777   /// getBufferData - Return a StringRef to the source buffer data for the
 778   /// specified FileID.
 779   ///
 780   /// \param FID The file ID whose contents will be returned.
 781   /// \param Invalid If non-NULL, will be set true if an error occurred.
 782   StringRef getBufferData(FileID FID, bool *Invalid = 0) const;
 783
 784   /// \brief Get the number of FileIDs (files and macros) that were created
 785   /// during preprocessing of \p FID, including it.
 786   unsigned getNumCreatedFIDsForFileID(FileID FID) const {
 787     bool Invalid = false;
 788     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
 789     if (Invalid || !Entry.isFile())
 790       return 0;
 791
 792     return Entry.getFile().NumCreatedFIDs;
 793   }
 794
 795   /// \brief Set the number of FileIDs (files and macros) that were created
 796   /// during preprocessing of \p FID, including it.
 797   void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs) const {
 798     bool Invalid = false;
 799     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
 800     if (Invalid || !Entry.isFile())
 801       return;
 802
 803     assert(Entry.getFile().NumCreatedFIDs == 0 && "Already set!");
 804     const_cast<SrcMgr::FileInfo &>(Entry.getFile()).NumCreatedFIDs = NumFIDs;
 805   }
 806
 807   //===--------------------------------------------------------------------===//
 808   // SourceLocation manipulation methods.
 809   //===--------------------------------------------------------------------===//
 810
 811   /// getFileID - Return the FileID for a SourceLocation.  This is a very
 812   /// hot method that is used for all SourceManager queries that start with a
 813   /// SourceLocation object.  It is responsible for finding the entry in
 814   /// SLocEntryTable which contains the specified location.
 815   ///
 816   FileID getFileID(SourceLocation SpellingLoc) const {
 817     unsigned SLocOffset = SpellingLoc.getOffset();
 818
 819     // If our one-entry cache covers this offset, just return it.
 820     if (isOffsetInFileID(LastFileIDLookup, SLocOffset))
 821       return LastFileIDLookup;
 822
 823     return getFileIDSlow(SLocOffset);
 824   }
 825
 826   /// getLocForStartOfFile - Return the source location corresponding to the
 827   /// first byte of the specified file.
 828   SourceLocation getLocForStartOfFile(FileID FID) const {
 829     bool Invalid = false;
 830     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
 831     if (Invalid || !Entry.isFile())
 832       return SourceLocation();
 833
 834     unsigned FileOffset = Entry.getOffset();
 835     return SourceLocation::getFileLoc(FileOffset);
 836   }
 837
 838   /// \brief Return the source location corresponding to the last byte of the
 839   /// specified file.
 840   SourceLocation getLocForEndOfFile(FileID FID) const {
 841     bool Invalid = false;
 842     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
 843     if (Invalid || !Entry.isFile())
 844       return SourceLocation();
 845
 846     unsigned FileOffset = Entry.getOffset();
 847     return SourceLocation::getFileLoc(FileOffset + getFileIDSize(FID) - 1);
 848   }
 849
 850   /// \brief Returns the include location if \p FID is a #include'd file
 851   /// otherwise it returns an invalid location.
 852   SourceLocation getIncludeLoc(FileID FID) const {
 853     bool Invalid = false;
 854     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
 855     if (Invalid || !Entry.isFile())
 856       return SourceLocation();
 857
 858     return Entry.getFile().getIncludeLoc();
 859   }
 860
 861   /// getExpansionLoc - Given a SourceLocation object, return the expansion
 862   /// location referenced by the ID.
 863   SourceLocation getExpansionLoc(SourceLocation Loc) const {
 864     // Handle the non-mapped case inline, defer to out of line code to handle
 865     // expansions.
 866     if (Loc.isFileID()) return Loc;
 867     return getExpansionLocSlowCase(Loc);
 868   }
 869
 870   /// \brief Given \p Loc, if it is a macro location return the expansion
 871   /// location or the spelling location, depending on if it comes from a
 872   /// macro argument or not.
 873   SourceLocation getFileLoc(SourceLocation Loc) const {
 874     if (Loc.isFileID()) return Loc;
 875     return getFileLocSlowCase(Loc);
 876   }
 877
 878   /// getImmediateExpansionRange - Loc is required to be an expansion location.
 879   /// Return the start/end of the expansion information.
 880   std::pair<SourceLocation,SourceLocation>
 881   getImmediateExpansionRange(SourceLocation Loc) const;
 882
 883   /// getExpansionRange - Given a SourceLocation object, return the range of
 884   /// tokens covered by the expansion the ultimate file.
 885   std::pair<SourceLocation,SourceLocation>
 886   getExpansionRange(SourceLocation Loc) const;
 887
 888
 889   /// getSpellingLoc - Given a SourceLocation object, return the spelling
 890   /// location referenced by the ID.  This is the place where the characters
 891   /// that make up the lexed token can be found.
 892   SourceLocation getSpellingLoc(SourceLocation Loc) const {
 893     // Handle the non-mapped case inline, defer to out of line code to handle
 894     // expansions.
 895     if (Loc.isFileID()) return Loc;
 896     return getSpellingLocSlowCase(Loc);
 897   }
 898
 899   /// getImmediateSpellingLoc - Given a SourceLocation object, return the
 900   /// spelling location referenced by the ID.  This is the first level down
 901   /// towards the place where the characters that make up the lexed token can be
 902   /// found.  This should not generally be used by clients.
 903   SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const;
 904
 905   /// getDecomposedLoc - Decompose the specified location into a raw FileID +
 906   /// Offset pair.  The first element is the FileID, the second is the
 907   /// offset from the start of the buffer of the location.
 908   std::pair<FileID, unsigned> getDecomposedLoc(SourceLocation Loc) const {
 909     FileID FID = getFileID(Loc);
 910     bool Invalid = false;
 911     const SrcMgr::SLocEntry &E = getSLocEntry(FID, &Invalid);
 912     if (Invalid)
 913       return std::make_pair(FileID(), 0);
 914     return std::make_pair(FID, Loc.getOffset()-E.getOffset());
 915   }
 916
 917   /// getDecomposedExpansionLoc - Decompose the specified location into a raw
 918   /// FileID + Offset pair. If the location is an expansion record, walk
 919   /// through it until we find the final location expanded.
 920   std::pair<FileID, unsigned>
 921   getDecomposedExpansionLoc(SourceLocation Loc) const {
 922     FileID FID = getFileID(Loc);
 923     bool Invalid = false;
 924     const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid);
 925     if (Invalid)
 926       return std::make_pair(FileID(), 0);
 927
 928     unsigned Offset = Loc.getOffset()-E->getOffset();
 929     if (Loc.isFileID())
 930       return std::make_pair(FID, Offset);
 931
 932     return getDecomposedExpansionLocSlowCase(E);
 933   }
 934
 935   /// getDecomposedSpellingLoc - Decompose the specified location into a raw
 936   /// FileID + Offset pair.  If the location is an expansion record, walk
 937   /// through it until we find its spelling record.
 938   std::pair<FileID, unsigned>
 939   getDecomposedSpellingLoc(SourceLocation Loc) const {
 940     FileID FID = getFileID(Loc);
 941     bool Invalid = false;
 942     const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid);
 943     if (Invalid)
 944       return std::make_pair(FileID(), 0);
 945
 946     unsigned Offset = Loc.getOffset()-E->getOffset();
 947     if (Loc.isFileID())
 948       return std::make_pair(FID, Offset);
 949     return getDecomposedSpellingLocSlowCase(E, Offset);
 950   }
 951
 952   /// getFileOffset - This method returns the offset from the start
 953   /// of the file that the specified SourceLocation represents. This is not very
 954   /// meaningful for a macro ID.
 955   unsigned getFileOffset(SourceLocation SpellingLoc) const {
 956     return getDecomposedLoc(SpellingLoc).second;
 957   }
 958
 959   /// isMacroArgExpansion - This method tests whether the given source location
 960   /// represents a macro argument's expansion into the function-like macro
 961   /// definition. Such source locations only appear inside of the expansion
 962   /// locations representing where a particular function-like macro was
 963   /// expanded.
 964   bool isMacroArgExpansion(SourceLocation Loc) const;
 965
 966   /// \brief Returns true if \p Loc is inside the [\p Start, +\p Length)
 967   /// chunk of the source location address space.
 968   /// If it's true and \p RelativeOffset is non-null, it will be set to the
 969   /// relative offset of \p Loc inside the chunk.
 970   bool isInSLocAddrSpace(SourceLocation Loc,
 971                          SourceLocation Start, unsigned Length,
 972                          unsigned *RelativeOffset = 0) const {
 973     assert(((Start.getOffset() < NextLocalOffset &&
 974                Start.getOffset()+Length <= NextLocalOffset) ||
 975             (Start.getOffset() >= CurrentLoadedOffset &&
 976                 Start.getOffset()+Length < MaxLoadedOffset)) &&
 977            "Chunk is not valid SLoc address space");
 978     unsigned LocOffs = Loc.getOffset();
 979     unsigned BeginOffs = Start.getOffset();
 980     unsigned EndOffs = BeginOffs + Length;
 981     if (LocOffs >= BeginOffs && LocOffs < EndOffs) {
 982       if (RelativeOffset)
 983         *RelativeOffset = LocOffs - BeginOffs;
 984       return true;
 985     }
 986
 987     return false;
 988   }
 989
 990   /// \brief Return true if both \p LHS and \p RHS are in the local source
 991   /// location address space or the loaded one. If it's true and \p
 992   /// RelativeOffset is non-null, it will be set to the offset of \p RHS
 993   /// relative to \p LHS.
 994   bool isInSameSLocAddrSpace(SourceLocation LHS, SourceLocation RHS,
 995                              int *RelativeOffset) const {
 996     unsigned LHSOffs = LHS.getOffset(), RHSOffs = RHS.getOffset();
 997     bool LHSLoaded = LHSOffs >= CurrentLoadedOffset;
 998     bool RHSLoaded = RHSOffs >= CurrentLoadedOffset;
 999
1000     if (LHSLoaded == RHSLoaded) {
1001       if (RelativeOffset)
1002         *RelativeOffset = RHSOffs - LHSOffs;
1003       return true;
1004     }
1005
1006     return false;
1007   }
1008
1009   //===--------------------------------------------------------------------===//
1010   // Queries about the code at a SourceLocation.
1011   //===--------------------------------------------------------------------===//
1012
1013   /// getCharacterData - Return a pointer to the start of the specified location
1014   /// in the appropriate spelling MemoryBuffer.
1015   ///
1016   /// \param Invalid If non-NULL, will be set \c true if an error occurs.
1017   const char *getCharacterData(SourceLocation SL, bool *Invalid = 0) const;
1018
1019   /// getColumnNumber - Return the column # for the specified file position.
1020   /// This is significantly cheaper to compute than the line number.  This
1021   /// returns zero if the column number isn't known.  This may only be called
1022   /// on a file sloc, so you must choose a spelling or expansion location
1023   /// before calling this method.
1024   unsigned getColumnNumber(FileID FID, unsigned FilePos,
1025                            bool *Invalid = 0) const;
1026   unsigned getSpellingColumnNumber(SourceLocation Loc, bool *Invalid = 0) const;
1027   unsigned getExpansionColumnNumber(SourceLocation Loc,
1028                                     bool *Invalid = 0) const;
1029   unsigned getPresumedColumnNumber(SourceLocation Loc, bool *Invalid = 0) const;
1030
1031
1032   /// getLineNumber - Given a SourceLocation, return the spelling line number
1033   /// for the position indicated.  This requires building and caching a table of
1034   /// line offsets for the MemoryBuffer, so this is not cheap: use only when
1035   /// about to emit a diagnostic.
1036   unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid = 0) const;
1037   unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid = 0) const;
1038   unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid = 0) const;
1039   unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid = 0) const;
1040
1041   /// Return the filename or buffer identifier of the buffer the location is in.
1042   /// Note that this name does not respect #line directives.  Use getPresumedLoc
1043   /// for normal clients.
1044   const char *getBufferName(SourceLocation Loc, bool *Invalid = 0) const;
1045
1046   /// getFileCharacteristic - return the file characteristic of the specified
1047   /// source location, indicating whether this is a normal file, a system
1048   /// header, or an "implicit extern C" system header.
1049   ///
1050   /// This state can be modified with flags on GNU linemarker directives like:
1051   ///   # 4 "foo.h" 3
1052   /// which changes all source locations in the current file after that to be
1053   /// considered to be from a system header.
1054   SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const;
1055
1056   /// getPresumedLoc - This method returns the "presumed" location of a
1057   /// SourceLocation specifies.  A "presumed location" can be modified by #line
1058   /// or GNU line marker directives.  This provides a view on the data that a
1059   /// user should see in diagnostics, for example.
1060   ///
1061   /// Note that a presumed location is always given as the expansion point of
1062   /// an expansion location, not at the spelling location.
1063   ///
1064   /// \returns The presumed location of the specified SourceLocation. If the
1065   /// presumed location cannot be calculate (e.g., because \p Loc is invalid
1066   /// or the file containing \p Loc has changed on disk), returns an invalid
1067   /// presumed location.
1068   PresumedLoc getPresumedLoc(SourceLocation Loc) const;
1069
1070   /// isFromSameFile - Returns true if both SourceLocations correspond to
1071   ///  the same file.
1072   bool isFromSameFile(SourceLocation Loc1, SourceLocation Loc2) const {
1073     return getFileID(Loc1) == getFileID(Loc2);
1074   }
1075
1076   /// isFromMainFile - Returns true if the file of provided SourceLocation is
1077   ///   the main file.
1078   bool isFromMainFile(SourceLocation Loc) const {
1079     return getFileID(Loc) == getMainFileID();
1080   }
1081
1082   /// isInSystemHeader - Returns if a SourceLocation is in a system header.
1083   bool isInSystemHeader(SourceLocation Loc) const {
1084     return getFileCharacteristic(Loc) != SrcMgr::C_User;
1085   }
1086
1087   /// isInExternCSystemHeader - Returns if a SourceLocation is in an "extern C"
1088   /// system header.
1089   bool isInExternCSystemHeader(SourceLocation Loc) const {
1090     return getFileCharacteristic(Loc) == SrcMgr::C_ExternCSystem;
1091   }
1092
1093   /// \brief Returns whether \p Loc is expanded from a macro in a system header.
1094   bool isInSystemMacro(SourceLocation loc) {
1095     return loc.isMacroID() && isInSystemHeader(getSpellingLoc(loc));
1096   }
1097
1098   /// \brief The size of the SLocEnty that \p FID represents.
1099   unsigned getFileIDSize(FileID FID) const;
1100
1101   /// \brief Given a specific FileID, returns true if \p Loc is inside that
1102   /// FileID chunk and sets relative offset (offset of \p Loc from beginning
1103   /// of FileID) to \p relativeOffset.
1104   bool isInFileID(SourceLocation Loc, FileID FID,
1105                   unsigned *RelativeOffset = 0) const {
1106     unsigned Offs = Loc.getOffset();
1107     if (isOffsetInFileID(FID, Offs)) {
1108       if (RelativeOffset)
1109         *RelativeOffset = Offs - getSLocEntry(FID).getOffset();
1110       return true;
1111     }
1112
1113     return false;
1114   }
1115
1116   //===--------------------------------------------------------------------===//
1117   // Line Table Manipulation Routines
1118   //===--------------------------------------------------------------------===//
1119
1120   /// getLineTableFilenameID - Return the uniqued ID for the specified filename.
1121   ///
1122   unsigned getLineTableFilenameID(StringRef Str);
1123
1124   /// AddLineNote - Add a line note to the line table for the FileID and offset
1125   /// specified by Loc.  If FilenameID is -1, it is considered to be
1126   /// unspecified.
1127   void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID);
1128   void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID,
1129                    bool IsFileEntry, bool IsFileExit,
1130                    bool IsSystemHeader, bool IsExternCHeader);
1131
1132   /// \brief Determine if the source manager has a line table.
1133   bool hasLineTable() const { return LineTable != 0; }
1134
1135   /// \brief Retrieve the stored line table.
1136   LineTableInfo &getLineTable();
1137
1138   //===--------------------------------------------------------------------===//
1139   // Queries for performance analysis.
1140   //===--------------------------------------------------------------------===//
1141
1142   /// Return the total amount of physical memory allocated by the
1143   /// ContentCache allocator.
1144   size_t getContentCacheSize() const {
1145     return ContentCacheAlloc.getTotalMemory();
1146   }
1147
1148   struct MemoryBufferSizes {
1149     const size_t malloc_bytes;
1150     const size_t mmap_bytes;
1151
1152     MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes)
1153       : malloc_bytes(malloc_bytes), mmap_bytes(mmap_bytes) {}
1154   };
1155
1156   /// Return the amount of memory used by memory buffers, breaking down
1157   /// by heap-backed versus mmap'ed memory.
1158   MemoryBufferSizes getMemoryBufferSizes() const;
1159
1160   // Return the amount of memory used for various side tables and
1161   // data structures in the SourceManager.
1162   size_t getDataStructureSizes() const;
1163
1164   //===--------------------------------------------------------------------===//
1165   // Other miscellaneous methods.
1166   //===--------------------------------------------------------------------===//
1167
1168   /// \brief Get the source location for the given file:line:col triplet.
1169   ///
1170   /// If the source file is included multiple times, the source location will
1171   /// be based upon the first inclusion.
1172   SourceLocation translateFileLineCol(const FileEntry *SourceFile,
1173                                       unsigned Line, unsigned Col) const;
1174
1175   /// \brief Get the FileID for the given file.
1176   ///
1177   /// If the source file is included multiple times, the FileID will be the
1178   /// first inclusion.
1179   FileID translateFile(const FileEntry *SourceFile) const;
1180
1181   /// \brief Get the source location in \p FID for the given line:col.
1182   /// Returns null location if \p FID is not a file SLocEntry.
1183   SourceLocation translateLineCol(FileID FID,
1184                                   unsigned Line, unsigned Col) const;
1185
1186   /// \brief If \p Loc points inside a function macro argument, the returned
1187   /// location will be the macro location in which the argument was expanded.
1188   /// If a macro argument is used multiple times, the expanded location will
1189   /// be at the first expansion of the argument.
1190   /// e.g.
1191   ///   MY_MACRO(foo);
1192   ///             ^
1193   /// Passing a file location pointing at 'foo', will yield a macro location
1194   /// where 'foo' was expanded into.
1195   SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const;
1196
1197   /// \brief Determines the order of 2 source locations in the translation unit.
1198   ///
1199   /// \returns true if LHS source location comes before RHS, false otherwise.
1200   bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const;
1201
1202   /// \brief Comparison function class.
1203   class LocBeforeThanCompare : public std::binary_function<SourceLocation,
1204                                                          SourceLocation, bool> {
1205     SourceManager &SM;
1206
1207   public:
1208     explicit LocBeforeThanCompare(SourceManager &SM) : SM(SM) { }
1209
1210     bool operator()(SourceLocation LHS, SourceLocation RHS) const {
1211       return SM.isBeforeInTranslationUnit(LHS, RHS);
1212     }
1213   };
1214
1215   /// \brief Determines the order of 2 source locations in the "source location
1216   /// address space".
1217   bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const {
1218     return isBeforeInSLocAddrSpace(LHS, RHS.getOffset());
1219   }
1220
1221   /// \brief Determines the order of a source location and a source location
1222   /// offset in the "source location address space".
1223   ///
1224   /// Note that we always consider source locations loaded from
1225   bool isBeforeInSLocAddrSpace(SourceLocation LHS, unsigned RHS) const {
1226     unsigned LHSOffset = LHS.getOffset();
1227     bool LHSLoaded = LHSOffset >= CurrentLoadedOffset;
1228     bool RHSLoaded = RHS >= CurrentLoadedOffset;
1229     if (LHSLoaded == RHSLoaded)
1230       return LHSOffset < RHS;
1231
1232     return LHSLoaded;
1233   }
1234
1235   // Iterators over FileInfos.
1236   typedef llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>
1237       ::const_iterator fileinfo_iterator;
1238   fileinfo_iterator fileinfo_begin() const { return FileInfos.begin(); }
1239   fileinfo_iterator fileinfo_end() const { return FileInfos.end(); }
1240   bool hasFileInfo(const FileEntry *File) const {
1241     return FileInfos.find(File) != FileInfos.end();
1242   }
1243
1244   /// PrintStats - Print statistics to stderr.
1245   ///
1246   void PrintStats() const;
1247
1248   /// \brief Get the number of local SLocEntries we have.
1249   unsigned local_sloc_entry_size() const { return LocalSLocEntryTable.size(); }
1250
1251   /// \brief Get a local SLocEntry. This is exposed for indexing.
1252   const SrcMgr::SLocEntry &getLocalSLocEntry(unsigned Index,
1253                                              bool *Invalid = 0) const {
1254     assert(Index < LocalSLocEntryTable.size() && "Invalid index");
1255     return LocalSLocEntryTable[Index];
1256   }
1257
1258   /// \brief Get the number of loaded SLocEntries we have.
1259   unsigned loaded_sloc_entry_size() const { return LoadedSLocEntryTable.size();}
1260
1261   /// \brief Get a loaded SLocEntry. This is exposed for indexing.
1262   const SrcMgr::SLocEntry &getLoadedSLocEntry(unsigned Index,
1263                                               bool *Invalid = 0) const {
1264     assert(Index < LoadedSLocEntryTable.size() && "Invalid index");
1265     if (SLocEntryLoaded[Index])
1266       return LoadedSLocEntryTable[Index];
1267     return loadSLocEntry(Index, Invalid);
1268   }
1269
1270   const SrcMgr::SLocEntry &getSLocEntry(FileID FID, bool *Invalid = 0) const {
1271     if (FID.ID == 0 || FID.ID == -1) {
1272       if (Invalid) *Invalid = true;
1273       return LocalSLocEntryTable[0];
1274     }
1275     return getSLocEntryByID(FID.ID);
1276   }
1277
1278   unsigned getNextLocalOffset() const { return NextLocalOffset; }
1279
1280   void setExternalSLocEntrySource(ExternalSLocEntrySource *Source) {
1281     assert(LoadedSLocEntryTable.empty() &&
1282            "Invalidating existing loaded entries");
1283     ExternalSLocEntries = Source;
1284   }
1285
1286   /// \brief Allocate a number of loaded SLocEntries, which will be actually
1287   /// loaded on demand from the external source.
1288   ///
1289   /// NumSLocEntries will be allocated, which occupy a total of TotalSize space
1290   /// in the global source view. The lowest ID and the base offset of the
1291   /// entries will be returned.
1292   std::pair<int, unsigned>
1293   AllocateLoadedSLocEntries(unsigned NumSLocEntries, unsigned TotalSize);
1294
1295   /// \brief Returns true if \p Loc came from a PCH/Module.
1296   bool isLoadedSourceLocation(SourceLocation Loc) const {
1297     return Loc.getOffset() >= CurrentLoadedOffset;
1298   }
1299
1300   /// \brief Returns true if \p Loc did not come from a PCH/Module.
1301   bool isLocalSourceLocation(SourceLocation Loc) const {
1302     return Loc.getOffset() < NextLocalOffset;
1303   }
1304
1305   /// \brief Returns true if \p FID came from a PCH/Module.
1306   bool isLoadedFileID(FileID FID) const {
1307     assert(FID.ID != -1 && "Using FileID sentinel value");
1308     return FID.ID < 0;
1309   }
1310
1311   /// \brief Returns true if \p FID did not come from a PCH/Module.
1312   bool isLocalFileID(FileID FID) const {
1313     return !isLoadedFileID(FID);
1314   }
1315
1316 private:
1317   const llvm::MemoryBuffer *getFakeBufferForRecovery() const;
1318   const SrcMgr::ContentCache *getFakeContentCacheForRecovery() const;
1319
1320   const SrcMgr::SLocEntry &loadSLocEntry(unsigned Index, bool *Invalid) const;
1321
1322   /// \brief Get the entry with the given unwrapped FileID.
1323   const SrcMgr::SLocEntry &getSLocEntryByID(int ID) const {
1324     assert(ID != -1 && "Using FileID sentinel value");
1325     if (ID < 0)
1326       return getLoadedSLocEntryByID(ID);
1327     return getLocalSLocEntry(static_cast<unsigned>(ID));
1328   }
1329
1330   const SrcMgr::SLocEntry &getLoadedSLocEntryByID(int ID,
1331                                                   bool *Invalid = 0) const {
1332     return getLoadedSLocEntry(static_cast<unsigned>(-ID - 2), Invalid);
1333   }
1334
1335   /// createExpansionLoc - Implements the common elements of storing an
1336   /// expansion info struct into the SLocEntry table and producing a source
1337   /// location that refers to it.
1338   SourceLocation createExpansionLocImpl(const SrcMgr::ExpansionInfo &Expansion,
1339                                         unsigned TokLength,
1340                                         int LoadedID = 0,
1341                                         unsigned LoadedOffset = 0);
1342
1343   /// isOffsetInFileID - Return true if the specified FileID contains the
1344   /// specified SourceLocation offset.  This is a very hot method.
1345   inline bool isOffsetInFileID(FileID FID, unsigned SLocOffset) const {
1346     const SrcMgr::SLocEntry &Entry = getSLocEntry(FID);
1347     // If the entry is after the offset, it can't contain it.
1348     if (SLocOffset < Entry.getOffset()) return false;
1349
1350     // If this is the very last entry then it does.
1351     if (FID.ID == -2)
1352       return true;
1353
1354     // If it is the last local entry, then it does if the location is local.
1355     if (static_cast<unsigned>(FID.ID+1) == LocalSLocEntryTable.size()) {
1356       return SLocOffset < NextLocalOffset;
1357     }
1358
1359     // Otherwise, the entry after it has to not include it. This works for both
1360     // local and loaded entries.
1361     return SLocOffset < getSLocEntry(FileID::get(FID.ID+1)).getOffset();
1362   }
1363
1364   /// createFileID - Create a new fileID for the specified ContentCache and
1365   ///  include position.  This works regardless of whether the ContentCache
1366   ///  corresponds to a file or some other input source.
1367   FileID createFileID(const SrcMgr::ContentCache* File,
1368                       SourceLocation IncludePos,
1369                       SrcMgr::CharacteristicKind DirCharacter,
1370                       int LoadedID, unsigned LoadedOffset);
1371
1372   const SrcMgr::ContentCache *
1373     getOrCreateContentCache(const FileEntry *SourceFile);
1374
1375   /// createMemBufferContentCache - Create a new ContentCache for the specified
1376   ///  memory buffer.
1377   const SrcMgr::ContentCache*
1378   createMemBufferContentCache(const llvm::MemoryBuffer *Buf);
1379
1380   FileID getFileIDSlow(unsigned SLocOffset) const;
1381   FileID getFileIDLocal(unsigned SLocOffset) const;
1382   FileID getFileIDLoaded(unsigned SLocOffset) const;
1383
1384   SourceLocation getExpansionLocSlowCase(SourceLocation Loc) const;
1385   SourceLocation getSpellingLocSlowCase(SourceLocation Loc) const;
1386   SourceLocation getFileLocSlowCase(SourceLocation Loc) const;
1387
1388   std::pair<FileID, unsigned>
1389   getDecomposedExpansionLocSlowCase(const SrcMgr::SLocEntry *E) const;
1390   std::pair<FileID, unsigned>
1391   getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
1392                                    unsigned Offset) const;
1393   void computeMacroArgsCache(MacroArgsMap *&MacroArgsCache, FileID FID) const;
1394
1395   friend class ASTReader;
1396   friend class ASTWriter;
1397 };
1398
1399
1400 }  // end namespace clang
1401
1402 #endif