1 //===--- SourceManager.h - Track and cache source files ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Defines the SourceManager interface.
13 /// There are three different types of locations in a %file: a spelling
14 /// location, an expansion location, and a presumed location.
16 /// Given an example of:
18 /// #define min(x, y) x < y ? x : y
21 /// and then later on a use of min:
27 /// The expansion location is the line in the source code where the macro
28 /// was expanded (the return statement), the spelling location is the
29 /// location in the source where the macro was originally defined,
30 /// and the presumed location is where the line directive states that
31 /// the line is 17, or any other line.
33 //===----------------------------------------------------------------------===//
35 #ifndef LLVM_CLANG_SOURCEMANAGER_H
36 #define LLVM_CLANG_SOURCEMANAGER_H
38 #include "clang/Basic/FileManager.h"
39 #include "clang/Basic/LLVM.h"
40 #include "clang/Basic/SourceLocation.h"
41 #include "llvm/ADT/ArrayRef.h"
42 #include "llvm/ADT/DenseMap.h"
43 #include "llvm/ADT/DenseSet.h"
44 #include "llvm/ADT/IntrusiveRefCntPtr.h"
45 #include "llvm/ADT/OwningPtr.h"
46 #include "llvm/ADT/PointerIntPair.h"
47 #include "llvm/ADT/PointerUnion.h"
48 #include "llvm/Support/Allocator.h"
49 #include "llvm/Support/DataTypes.h"
50 #include "llvm/Support/MemoryBuffer.h"
57 class DiagnosticsEngine;
66 /// \brief Public enums and private classes that are part of the
67 /// SourceManager implementation.
70 /// \brief Indicates whether a file or directory holds normal user code,
71 /// system code, or system code which is implicitly 'extern "C"' in C++ mode.
73 /// Entire directories can be tagged with this (this is maintained by
74 /// DirectoryLookup and friends) as can specific FileInfos when a \#pragma
75 /// system_header is seen or in various other cases.
77 enum CharacteristicKind {
78 C_User, C_System, C_ExternCSystem
81 /// \brief One instance of this struct is kept for every file loaded or used.
83 /// This object owns the MemoryBuffer object.
86 /// \brief Whether the buffer is invalid.
88 /// \brief Whether the buffer should not be freed on destruction.
92 /// \brief The actual buffer containing the characters from the input
95 /// This is owned by the ContentCache object. The bits indicate
96 /// whether the buffer is invalid.
97 mutable llvm::PointerIntPair<const llvm::MemoryBuffer *, 2> Buffer;
100 /// \brief Reference to the file entry representing this ContentCache.
102 /// This reference does not own the FileEntry object.
104 /// It is possible for this to be NULL if the ContentCache encapsulates
105 /// an imaginary text buffer.
106 const FileEntry *OrigEntry;
108 /// \brief References the file which the contents were actually loaded from.
110 /// Can be different from 'Entry' if we overridden the contents of one file
111 /// with the contents of another file.
112 const FileEntry *ContentsEntry;
114 /// \brief A bump pointer allocated array of offsets for each source line.
116 /// This is lazily computed. This is owned by the SourceManager
117 /// BumpPointerAllocator object.
118 unsigned *SourceLineCache;
120 /// \brief The number of lines in this ContentCache.
122 /// This is only valid if SourceLineCache is non-null.
123 unsigned NumLines : 31;
125 /// \brief Indicates whether the buffer itself was provided to override
126 /// the actual file contents.
128 /// When true, the original entry may be a virtual file that does not
130 unsigned BufferOverridden : 1;
132 /// \brief True if this content cache was initially created for a source
133 /// file considered as a system one.
134 unsigned IsSystemFile : 1;
136 ContentCache(const FileEntry *Ent = 0)
137 : Buffer(0, false), OrigEntry(Ent), ContentsEntry(Ent),
138 SourceLineCache(0), NumLines(0), BufferOverridden(false),
139 IsSystemFile(false) {}
141 ContentCache(const FileEntry *Ent, const FileEntry *contentEnt)
142 : Buffer(0, false), OrigEntry(Ent), ContentsEntry(contentEnt),
143 SourceLineCache(0), NumLines(0), BufferOverridden(false),
144 IsSystemFile(false) {}
148 /// The copy ctor does not allow copies where source object has either
149 /// a non-NULL Buffer or SourceLineCache. Ownership of allocated memory
150 /// is not transferred, so this is a logical error.
151 ContentCache(const ContentCache &RHS)
152 : Buffer(0, false), SourceLineCache(0), BufferOverridden(false),
155 OrigEntry = RHS.OrigEntry;
156 ContentsEntry = RHS.ContentsEntry;
158 assert (RHS.Buffer.getPointer() == 0 && RHS.SourceLineCache == 0 &&
159 "Passed ContentCache object cannot own a buffer.");
161 NumLines = RHS.NumLines;
164 /// \brief Returns the memory buffer for the associated content.
166 /// \param Diag Object through which diagnostics will be emitted if the
167 /// buffer cannot be retrieved.
169 /// \param Loc If specified, is the location that invalid file diagnostics
170 /// will be emitted at.
172 /// \param Invalid If non-NULL, will be set \c true if an error occurred.
173 const llvm::MemoryBuffer *getBuffer(DiagnosticsEngine &Diag,
174 const SourceManager &SM,
175 SourceLocation Loc = SourceLocation(),
176 bool *Invalid = 0) const;
178 /// \brief Returns the size of the content encapsulated by this
181 /// This can be the size of the source file or the size of an
182 /// arbitrary scratch buffer. If the ContentCache encapsulates a source
183 /// file this size is retrieved from the file's FileEntry.
184 unsigned getSize() const;
186 /// \brief Returns the number of bytes actually mapped for this
189 /// This can be 0 if the MemBuffer was not actually expanded.
190 unsigned getSizeBytesMapped() const;
192 /// Returns the kind of memory used to back the memory buffer for
193 /// this content cache. This is used for performance analysis.
194 llvm::MemoryBuffer::BufferKind getMemoryBufferKind() const;
196 void setBuffer(const llvm::MemoryBuffer *B) {
197 assert(!Buffer.getPointer() && "MemoryBuffer already set.");
198 Buffer.setPointer(B);
199 Buffer.setInt(false);
202 /// \brief Get the underlying buffer, returning NULL if the buffer is not
204 const llvm::MemoryBuffer *getRawBuffer() const {
205 return Buffer.getPointer();
208 /// \brief Replace the existing buffer (which will be deleted)
209 /// with the given buffer.
210 void replaceBuffer(const llvm::MemoryBuffer *B, bool DoNotFree = false);
212 /// \brief Determine whether the buffer itself is invalid.
213 bool isBufferInvalid() const {
214 return Buffer.getInt() & InvalidFlag;
217 /// \brief Determine whether the buffer should be freed.
218 bool shouldFreeBuffer() const {
219 return (Buffer.getInt() & DoNotFreeFlag) == 0;
223 // Disable assignments.
224 ContentCache &operator=(const ContentCache& RHS) LLVM_DELETED_FUNCTION;
227 /// \brief Information about a FileID, basically just the logical file
228 /// that it represents and include stack information.
230 /// Each FileInfo has include stack information, indicating where it came
231 /// from. This information encodes the \#include chain that a token was
232 /// expanded from. The main include file has an invalid IncludeLoc.
234 /// FileInfos contain a "ContentCache *", with the contents of the file.
237 /// \brief The location of the \#include that brought in this file.
239 /// This is an invalid SLOC for the main file (top of the \#include chain).
240 unsigned IncludeLoc; // Really a SourceLocation
242 /// \brief Number of FileIDs (files and macros) that were created during
243 /// preprocessing of this \#include, including this SLocEntry.
245 /// Zero means the preprocessor didn't provide such info for this SLocEntry.
246 unsigned NumCreatedFIDs;
248 /// \brief Contains the ContentCache* and the bits indicating the
249 /// characteristic of the file and whether it has \#line info, all
250 /// bitmangled together.
253 friend class clang::SourceManager;
254 friend class clang::ASTWriter;
255 friend class clang::ASTReader;
257 /// \brief Return a FileInfo object.
258 static FileInfo get(SourceLocation IL, const ContentCache *Con,
259 CharacteristicKind FileCharacter) {
261 X.IncludeLoc = IL.getRawEncoding();
262 X.NumCreatedFIDs = 0;
263 X.Data = (uintptr_t)Con;
264 assert((X.Data & 7) == 0 &&"ContentCache pointer insufficiently aligned");
265 assert((unsigned)FileCharacter < 4 && "invalid file character");
266 X.Data |= (unsigned)FileCharacter;
270 SourceLocation getIncludeLoc() const {
271 return SourceLocation::getFromRawEncoding(IncludeLoc);
273 const ContentCache* getContentCache() const {
274 return reinterpret_cast<const ContentCache*>(Data & ~uintptr_t(7));
277 /// \brief Return whether this is a system header or not.
278 CharacteristicKind getFileCharacteristic() const {
279 return (CharacteristicKind)(Data & 3);
282 /// \brief Return true if this FileID has \#line directives in it.
283 bool hasLineDirectives() const { return (Data & 4) != 0; }
285 /// \brief Set the flag that indicates that this FileID has
286 /// line table entries associated with it.
287 void setHasLineDirectives() {
292 /// \brief Each ExpansionInfo encodes the expansion location - where
293 /// the token was ultimately expanded, and the SpellingLoc - where the actual
294 /// character data for the token came from.
295 class ExpansionInfo {
296 // Really these are all SourceLocations.
298 /// \brief Where the spelling for the token can be found.
299 unsigned SpellingLoc;
301 /// In a macro expansion, ExpansionLocStart and ExpansionLocEnd
302 /// indicate the start and end of the expansion. In object-like macros,
303 /// they will be the same. In a function-like macro expansion, the start
304 /// will be the identifier and the end will be the ')'. Finally, in
305 /// macro-argument instantiations, the end will be 'SourceLocation()', an
306 /// invalid location.
307 unsigned ExpansionLocStart, ExpansionLocEnd;
310 SourceLocation getSpellingLoc() const {
311 return SourceLocation::getFromRawEncoding(SpellingLoc);
313 SourceLocation getExpansionLocStart() const {
314 return SourceLocation::getFromRawEncoding(ExpansionLocStart);
316 SourceLocation getExpansionLocEnd() const {
317 SourceLocation EndLoc =
318 SourceLocation::getFromRawEncoding(ExpansionLocEnd);
319 return EndLoc.isInvalid() ? getExpansionLocStart() : EndLoc;
322 std::pair<SourceLocation,SourceLocation> getExpansionLocRange() const {
323 return std::make_pair(getExpansionLocStart(), getExpansionLocEnd());
326 bool isMacroArgExpansion() const {
327 // Note that this needs to return false for default constructed objects.
328 return getExpansionLocStart().isValid() &&
329 SourceLocation::getFromRawEncoding(ExpansionLocEnd).isInvalid();
332 bool isMacroBodyExpansion() const {
333 return getExpansionLocStart().isValid() &&
334 SourceLocation::getFromRawEncoding(ExpansionLocEnd).isValid();
337 bool isFunctionMacroExpansion() const {
338 return getExpansionLocStart().isValid() &&
339 getExpansionLocStart() != getExpansionLocEnd();
342 /// \brief Return a ExpansionInfo for an expansion.
344 /// Start and End specify the expansion range (where the macro is
345 /// expanded), and SpellingLoc specifies the spelling location (where
346 /// the characters from the token come from). All three can refer to
347 /// normal File SLocs or expansion locations.
348 static ExpansionInfo create(SourceLocation SpellingLoc,
349 SourceLocation Start, SourceLocation End) {
351 X.SpellingLoc = SpellingLoc.getRawEncoding();
352 X.ExpansionLocStart = Start.getRawEncoding();
353 X.ExpansionLocEnd = End.getRawEncoding();
357 /// \brief Return a special ExpansionInfo for the expansion of
358 /// a macro argument into a function-like macro's body.
360 /// ExpansionLoc specifies the expansion location (where the macro is
361 /// expanded). This doesn't need to be a range because a macro is always
362 /// expanded at a macro parameter reference, and macro parameters are
363 /// always exactly one token. SpellingLoc specifies the spelling location
364 /// (where the characters from the token come from). ExpansionLoc and
365 /// SpellingLoc can both refer to normal File SLocs or expansion locations.
369 /// #define F(x) f(x)
373 /// When expanding '\c F(42)', the '\c x' would call this with an
374 /// SpellingLoc pointing at '\c 42' and an ExpansionLoc pointing at its
375 /// location in the definition of '\c F'.
376 static ExpansionInfo createForMacroArg(SourceLocation SpellingLoc,
377 SourceLocation ExpansionLoc) {
378 // We store an intentionally invalid source location for the end of the
379 // expansion range to mark that this is a macro argument ion rather than
381 return create(SpellingLoc, ExpansionLoc, SourceLocation());
385 /// \brief This is a discriminated union of FileInfo and ExpansionInfo.
387 /// SourceManager keeps an array of these objects, and they are uniquely
388 /// identified by the FileID datatype.
390 unsigned Offset; // low bit is set for expansion info.
393 ExpansionInfo Expansion;
396 unsigned getOffset() const { return Offset >> 1; }
398 bool isExpansion() const { return Offset & 1; }
399 bool isFile() const { return !isExpansion(); }
401 const FileInfo &getFile() const {
402 assert(isFile() && "Not a file SLocEntry!");
406 const ExpansionInfo &getExpansion() const {
407 assert(isExpansion() && "Not a macro expansion SLocEntry!");
411 static SLocEntry get(unsigned Offset, const FileInfo &FI) {
413 E.Offset = Offset << 1;
418 static SLocEntry get(unsigned Offset, const ExpansionInfo &Expansion) {
420 E.Offset = (Offset << 1) | 1;
421 E.Expansion = Expansion;
425 } // end SrcMgr namespace.
427 /// \brief External source of source location entries.
428 class ExternalSLocEntrySource {
430 virtual ~ExternalSLocEntrySource();
432 /// \brief Read the source location entry with index ID, which will always be
435 /// \returns true if an error occurred that prevented the source-location
436 /// entry from being loaded.
437 virtual bool ReadSLocEntry(int ID) = 0;
439 /// \brief Retrieve the module import location and name for the given ID, if
440 /// in fact it was loaded from a module (rather than, say, a precompiled
442 virtual std::pair<SourceLocation, StringRef> getModuleImportLoc(int ID) = 0;
446 /// \brief Holds the cache used by isBeforeInTranslationUnit.
448 /// The cache structure is complex enough to be worth breaking out of
450 class InBeforeInTUCacheEntry {
451 /// \brief The FileID's of the cached query.
453 /// If these match up with a subsequent query, the result can be reused.
454 FileID LQueryFID, RQueryFID;
456 /// \brief True if LQueryFID was created before RQueryFID.
458 /// This is used to compare macro expansion locations.
459 bool IsLQFIDBeforeRQFID;
461 /// \brief The file found in common between the two \#include traces, i.e.,
462 /// the nearest common ancestor of the \#include tree.
465 /// \brief The offset of the previous query in CommonFID.
467 /// Usually, this represents the location of the \#include for QueryFID, but
468 /// if LQueryFID is a parent of RQueryFID (or vice versa) then these can be a
469 /// random token in the parent.
470 unsigned LCommonOffset, RCommonOffset;
472 /// \brief Return true if the currently cached values match up with
473 /// the specified LHS/RHS query.
475 /// If not, we can't use the cache.
476 bool isCacheValid(FileID LHS, FileID RHS) const {
477 return LQueryFID == LHS && RQueryFID == RHS;
480 /// \brief If the cache is valid, compute the result given the
481 /// specified offsets in the LHS/RHS FileID's.
482 bool getCachedResult(unsigned LOffset, unsigned ROffset) const {
483 // If one of the query files is the common file, use the offset. Otherwise,
484 // use the #include loc in the common file.
485 if (LQueryFID != CommonFID) LOffset = LCommonOffset;
486 if (RQueryFID != CommonFID) ROffset = RCommonOffset;
488 // It is common for multiple macro expansions to be "included" from the same
489 // location (expansion location), in which case use the order of the FileIDs
490 // to determine which came first. This will also take care the case where
491 // one of the locations points at the inclusion/expansion point of the other
492 // in which case its FileID will come before the other.
493 if (LOffset == ROffset)
494 return IsLQFIDBeforeRQFID;
496 return LOffset < ROffset;
499 /// \brief Set up a new query.
500 void setQueryFIDs(FileID LHS, FileID RHS, bool isLFIDBeforeRFID) {
504 IsLQFIDBeforeRQFID = isLFIDBeforeRFID;
508 LQueryFID = RQueryFID = FileID();
509 IsLQFIDBeforeRQFID = false;
512 void setCommonLoc(FileID commonFID, unsigned lCommonOffset,
513 unsigned rCommonOffset) {
514 CommonFID = commonFID;
515 LCommonOffset = lCommonOffset;
516 RCommonOffset = rCommonOffset;
521 /// \brief The stack used when building modules on demand, which is used
522 /// to provide a link between the source managers of the different compiler
524 typedef ArrayRef<std::pair<std::string, FullSourceLoc> > ModuleBuildStack;
526 /// \brief This class handles loading and caching of source files into memory.
528 /// This object owns the MemoryBuffer objects for all of the loaded
529 /// files and assigns unique FileID's for each unique \#include chain.
531 /// The SourceManager can be queried for information about SourceLocation
532 /// objects, turning them into either spelling or expansion locations. Spelling
533 /// locations represent where the bytes corresponding to a token came from and
534 /// expansion locations represent where the location is in the user's view. In
535 /// the case of a macro expansion, for example, the spelling location indicates
536 /// where the expanded token came from and the expansion location specifies
537 /// where it was expanded.
538 class SourceManager : public RefCountedBase<SourceManager> {
539 /// \brief DiagnosticsEngine object.
540 DiagnosticsEngine &Diag;
542 FileManager &FileMgr;
544 mutable llvm::BumpPtrAllocator ContentCacheAlloc;
546 /// \brief Memoized information about all of the files tracked by this
549 /// This map allows us to merge ContentCache entries based
550 /// on their FileEntry*. All ContentCache objects will thus have unique,
551 /// non-null, FileEntry pointers.
552 llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> FileInfos;
554 /// \brief True if the ContentCache for files that are overriden by other
555 /// files, should report the original file name. Defaults to true.
556 bool OverridenFilesKeepOriginalName;
558 /// \brief True if non-system source files should be treated as volatile
559 /// (likely to change while trying to use them). Defaults to false.
560 bool UserFilesAreVolatile;
562 struct OverriddenFilesInfoTy {
563 /// \brief Files that have been overriden with the contents from another
565 llvm::DenseMap<const FileEntry *, const FileEntry *> OverriddenFiles;
566 /// \brief Files that were overridden with a memory buffer.
567 llvm::DenseSet<const FileEntry *> OverriddenFilesWithBuffer;
570 /// \brief Lazily create the object keeping overridden files info, since
571 /// it is uncommonly used.
572 OwningPtr<OverriddenFilesInfoTy> OverriddenFilesInfo;
574 OverriddenFilesInfoTy &getOverriddenFilesInfo() {
575 if (!OverriddenFilesInfo)
576 OverriddenFilesInfo.reset(new OverriddenFilesInfoTy);
577 return *OverriddenFilesInfo;
580 /// \brief Information about various memory buffers that we have read in.
582 /// All FileEntry* within the stored ContentCache objects are NULL,
583 /// as they do not refer to a file.
584 std::vector<SrcMgr::ContentCache*> MemBufferInfos;
586 /// \brief The table of SLocEntries that are local to this module.
588 /// Positive FileIDs are indexes into this table. Entry 0 indicates an invalid
590 SmallVector<SrcMgr::SLocEntry, 0> LocalSLocEntryTable;
592 /// \brief The table of SLocEntries that are loaded from other modules.
594 /// Negative FileIDs are indexes into this table. To get from ID to an index,
596 mutable SmallVector<SrcMgr::SLocEntry, 0> LoadedSLocEntryTable;
598 /// \brief The starting offset of the next local SLocEntry.
600 /// This is LocalSLocEntryTable.back().Offset + the size of that entry.
601 unsigned NextLocalOffset;
603 /// \brief The starting offset of the latest batch of loaded SLocEntries.
605 /// This is LoadedSLocEntryTable.back().Offset, except that that entry might
606 /// not have been loaded, so that value would be unknown.
607 unsigned CurrentLoadedOffset;
609 /// \brief The highest possible offset is 2^31-1, so CurrentLoadedOffset
611 static const unsigned MaxLoadedOffset = 1U << 31U;
613 /// \brief A bitmap that indicates whether the entries of LoadedSLocEntryTable
614 /// have already been loaded from the external source.
616 /// Same indexing as LoadedSLocEntryTable.
617 std::vector<bool> SLocEntryLoaded;
619 /// \brief An external source for source location entries.
620 ExternalSLocEntrySource *ExternalSLocEntries;
622 /// \brief A one-entry cache to speed up getFileID.
624 /// LastFileIDLookup records the last FileID looked up or created, because it
625 /// is very common to look up many tokens from the same file.
626 mutable FileID LastFileIDLookup;
628 /// \brief Holds information for \#line directives.
630 /// This is referenced by indices from SLocEntryTable.
631 LineTableInfo *LineTable;
633 /// \brief These ivars serve as a cache used in the getLineNumber
634 /// method which is used to speedup getLineNumber calls to nearby locations.
635 mutable FileID LastLineNoFileIDQuery;
636 mutable SrcMgr::ContentCache *LastLineNoContentCache;
637 mutable unsigned LastLineNoFilePos;
638 mutable unsigned LastLineNoResult;
640 /// \brief The file ID for the main source file of the translation unit.
643 /// \brief The file ID for the precompiled preamble there is one.
644 FileID PreambleFileID;
646 // Statistics for -print-stats.
647 mutable unsigned NumLinearScans, NumBinaryProbes;
649 /// \brief Associates a FileID with its "included/expanded in" decomposed
652 /// Used to cache results from and speed-up \c getDecomposedIncludedLoc
654 mutable llvm::DenseMap<FileID, std::pair<FileID, unsigned> > IncludedLocMap;
656 /// The key value into the IsBeforeInTUCache table.
657 typedef std::pair<FileID, FileID> IsBeforeInTUCacheKey;
659 /// The IsBeforeInTranslationUnitCache is a mapping from FileID pairs
660 /// to cache results.
661 typedef llvm::DenseMap<IsBeforeInTUCacheKey, InBeforeInTUCacheEntry>
664 /// Cache results for the isBeforeInTranslationUnit method.
665 mutable InBeforeInTUCache IBTUCache;
666 mutable InBeforeInTUCacheEntry IBTUCacheOverflow;
668 /// Return the cache entry for comparing the given file IDs
669 /// for isBeforeInTranslationUnit.
670 InBeforeInTUCacheEntry &getInBeforeInTUCache(FileID LFID, FileID RFID) const;
672 // Cache for the "fake" buffer used for error-recovery purposes.
673 mutable llvm::MemoryBuffer *FakeBufferForRecovery;
675 mutable SrcMgr::ContentCache *FakeContentCacheForRecovery;
677 /// \brief Lazily computed map of macro argument chunks to their expanded
679 typedef std::map<unsigned, SourceLocation> MacroArgsMap;
681 mutable llvm::DenseMap<FileID, MacroArgsMap *> MacroArgsCacheMap;
683 /// \brief The stack of modules being built, which is used to detect
684 /// cycles in the module dependency graph as modules are being built, as
685 /// well as to describe why we're rebuilding a particular module.
687 /// There is no way to set this value from the command line. If we ever need
688 /// to do so (e.g., if on-demand module construction moves out-of-process),
689 /// we can add a cc1-level option to do so.
690 SmallVector<std::pair<std::string, FullSourceLoc>, 2> StoredModuleBuildStack;
692 // SourceManager doesn't support copy construction.
693 explicit SourceManager(const SourceManager&) LLVM_DELETED_FUNCTION;
694 void operator=(const SourceManager&) LLVM_DELETED_FUNCTION;
696 SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr,
697 bool UserFilesAreVolatile = false);
700 void clearIDTables();
702 DiagnosticsEngine &getDiagnostics() const { return Diag; }
704 FileManager &getFileManager() const { return FileMgr; }
706 /// \brief Set true if the SourceManager should report the original file name
707 /// for contents of files that were overriden by other files.Defaults to true.
708 void setOverridenFilesKeepOriginalName(bool value) {
709 OverridenFilesKeepOriginalName = value;
712 /// \brief True if non-system source files should be treated as volatile
713 /// (likely to change while trying to use them).
714 bool userFilesAreVolatile() const { return UserFilesAreVolatile; }
716 /// \brief Retrieve the module build stack.
717 ModuleBuildStack getModuleBuildStack() const {
718 return StoredModuleBuildStack;
721 /// \brief Set the module build stack.
722 void setModuleBuildStack(ModuleBuildStack stack) {
723 StoredModuleBuildStack.clear();
724 StoredModuleBuildStack.append(stack.begin(), stack.end());
727 /// \brief Push an entry to the module build stack.
728 void pushModuleBuildStack(StringRef moduleName, FullSourceLoc importLoc) {
729 StoredModuleBuildStack.push_back(std::make_pair(moduleName.str(),importLoc));
732 /// \brief Create the FileID for a memory buffer that will represent the
733 /// FileID for the main source.
735 /// One example of when this would be used is when the main source is read
737 FileID createMainFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer,
738 SrcMgr::CharacteristicKind Kind = SrcMgr::C_User) {
739 assert(MainFileID.isInvalid() && "MainFileID already set!");
740 MainFileID = createFileIDForMemBuffer(Buffer, Kind);
744 //===--------------------------------------------------------------------===//
745 // MainFileID creation and querying methods.
746 //===--------------------------------------------------------------------===//
748 /// \brief Returns the FileID of the main source file.
749 FileID getMainFileID() const { return MainFileID; }
751 /// \brief Create the FileID for the main source file.
752 FileID createMainFileID(const FileEntry *SourceFile,
753 SrcMgr::CharacteristicKind Kind = SrcMgr::C_User) {
754 assert(MainFileID.isInvalid() && "MainFileID already set!");
755 MainFileID = createFileID(SourceFile, SourceLocation(), Kind);
759 /// \brief Set the file ID for the main source file.
760 void setMainFileID(FileID FID) {
761 assert(MainFileID.isInvalid() && "MainFileID already set!");
765 /// \brief Set the file ID for the precompiled preamble.
766 void setPreambleFileID(FileID Preamble) {
767 assert(PreambleFileID.isInvalid() && "PreambleFileID already set!");
768 PreambleFileID = Preamble;
771 /// \brief Get the file ID for the precompiled preamble if there is one.
772 FileID getPreambleFileID() const { return PreambleFileID; }
774 //===--------------------------------------------------------------------===//
775 // Methods to create new FileID's and macro expansions.
776 //===--------------------------------------------------------------------===//
778 /// \brief Create a new FileID that represents the specified file
779 /// being \#included from the specified IncludePosition.
781 /// This translates NULL into standard input.
782 FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos,
783 SrcMgr::CharacteristicKind FileCharacter,
784 int LoadedID = 0, unsigned LoadedOffset = 0) {
785 const SrcMgr::ContentCache *
786 IR = getOrCreateContentCache(SourceFile,
787 /*isSystemFile=*/FileCharacter != SrcMgr::C_User);
788 assert(IR && "getOrCreateContentCache() cannot return NULL");
789 return createFileID(IR, IncludePos, FileCharacter, LoadedID, LoadedOffset);
792 /// \brief Create a new FileID that represents the specified memory buffer.
794 /// This does no caching of the buffer and takes ownership of the
795 /// MemoryBuffer, so only pass a MemoryBuffer to this once.
796 FileID createFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer,
797 SrcMgr::CharacteristicKind FileCharacter = SrcMgr::C_User,
798 int LoadedID = 0, unsigned LoadedOffset = 0,
799 SourceLocation IncludeLoc = SourceLocation()) {
800 return createFileID(createMemBufferContentCache(Buffer), IncludeLoc,
801 FileCharacter, LoadedID, LoadedOffset);
804 /// \brief Return a new SourceLocation that encodes the
805 /// fact that a token from SpellingLoc should actually be referenced from
806 /// ExpansionLoc, and that it represents the expansion of a macro argument
807 /// into the function-like macro body.
808 SourceLocation createMacroArgExpansionLoc(SourceLocation Loc,
809 SourceLocation ExpansionLoc,
812 /// \brief Return a new SourceLocation that encodes the fact
813 /// that a token from SpellingLoc should actually be referenced from
815 SourceLocation createExpansionLoc(SourceLocation Loc,
816 SourceLocation ExpansionLocStart,
817 SourceLocation ExpansionLocEnd,
820 unsigned LoadedOffset = 0);
822 /// \brief Retrieve the memory buffer associated with the given file.
824 /// \param Invalid If non-NULL, will be set \c true if an error
825 /// occurs while retrieving the memory buffer.
826 const llvm::MemoryBuffer *getMemoryBufferForFile(const FileEntry *File,
829 /// \brief Override the contents of the given source file by providing an
830 /// already-allocated buffer.
832 /// \param SourceFile the source file whose contents will be overriden.
834 /// \param Buffer the memory buffer whose contents will be used as the
835 /// data in the given source file.
837 /// \param DoNotFree If true, then the buffer will not be freed when the
838 /// source manager is destroyed.
839 void overrideFileContents(const FileEntry *SourceFile,
840 const llvm::MemoryBuffer *Buffer,
841 bool DoNotFree = false);
843 /// \brief Override the given source file with another one.
845 /// \param SourceFile the source file which will be overriden.
847 /// \param NewFile the file whose contents will be used as the
848 /// data instead of the contents of the given source file.
849 void overrideFileContents(const FileEntry *SourceFile,
850 const FileEntry *NewFile);
852 /// \brief Returns true if the file contents have been overridden.
853 bool isFileOverridden(const FileEntry *File) {
854 if (OverriddenFilesInfo) {
855 if (OverriddenFilesInfo->OverriddenFilesWithBuffer.count(File))
857 if (OverriddenFilesInfo->OverriddenFiles.find(File) !=
858 OverriddenFilesInfo->OverriddenFiles.end())
864 /// \brief Disable overridding the contents of a file, previously enabled
865 /// with #overrideFileContents.
867 /// This should be called before parsing has begun.
868 void disableFileContentsOverride(const FileEntry *File);
870 //===--------------------------------------------------------------------===//
871 // FileID manipulation methods.
872 //===--------------------------------------------------------------------===//
874 /// \brief Return the buffer for the specified FileID.
876 /// If there is an error opening this buffer the first time, this
877 /// manufactures a temporary buffer and returns a non-empty error string.
878 const llvm::MemoryBuffer *getBuffer(FileID FID, SourceLocation Loc,
879 bool *Invalid = 0) const {
880 bool MyInvalid = false;
881 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
882 if (MyInvalid || !Entry.isFile()) {
886 return getFakeBufferForRecovery();
889 return Entry.getFile().getContentCache()->getBuffer(Diag, *this, Loc,
893 const llvm::MemoryBuffer *getBuffer(FileID FID, bool *Invalid = 0) const {
894 bool MyInvalid = false;
895 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
896 if (MyInvalid || !Entry.isFile()) {
900 return getFakeBufferForRecovery();
903 return Entry.getFile().getContentCache()->getBuffer(Diag, *this,
908 /// \brief Returns the FileEntry record for the provided FileID.
909 const FileEntry *getFileEntryForID(FileID FID) const {
910 bool MyInvalid = false;
911 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid);
912 if (MyInvalid || !Entry.isFile())
915 const SrcMgr::ContentCache *Content = Entry.getFile().getContentCache();
918 return Content->OrigEntry;
921 /// \brief Returns the FileEntry record for the provided SLocEntry.
922 const FileEntry *getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const
924 const SrcMgr::ContentCache *Content = sloc.getFile().getContentCache();
927 return Content->OrigEntry;
930 /// \brief Return a StringRef to the source buffer data for the
931 /// specified FileID.
933 /// \param FID The file ID whose contents will be returned.
934 /// \param Invalid If non-NULL, will be set true if an error occurred.
935 StringRef getBufferData(FileID FID, bool *Invalid = 0) const;
937 /// \brief Get the number of FileIDs (files and macros) that were created
938 /// during preprocessing of \p FID, including it.
939 unsigned getNumCreatedFIDsForFileID(FileID FID) const {
940 bool Invalid = false;
941 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
942 if (Invalid || !Entry.isFile())
945 return Entry.getFile().NumCreatedFIDs;
948 /// \brief Set the number of FileIDs (files and macros) that were created
949 /// during preprocessing of \p FID, including it.
950 void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs) const {
951 bool Invalid = false;
952 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
953 if (Invalid || !Entry.isFile())
956 assert(Entry.getFile().NumCreatedFIDs == 0 && "Already set!");
957 const_cast<SrcMgr::FileInfo &>(Entry.getFile()).NumCreatedFIDs = NumFIDs;
960 //===--------------------------------------------------------------------===//
961 // SourceLocation manipulation methods.
962 //===--------------------------------------------------------------------===//
964 /// \brief Return the FileID for a SourceLocation.
966 /// This is a very hot method that is used for all SourceManager queries
967 /// that start with a SourceLocation object. It is responsible for finding
968 /// the entry in SLocEntryTable which contains the specified location.
970 FileID getFileID(SourceLocation SpellingLoc) const {
971 unsigned SLocOffset = SpellingLoc.getOffset();
973 // If our one-entry cache covers this offset, just return it.
974 if (isOffsetInFileID(LastFileIDLookup, SLocOffset))
975 return LastFileIDLookup;
977 return getFileIDSlow(SLocOffset);
980 /// \brief Return the filename of the file containing a SourceLocation.
981 StringRef getFilename(SourceLocation SpellingLoc) const {
982 if (const FileEntry *F = getFileEntryForID(getFileID(SpellingLoc)))
987 /// \brief Return the source location corresponding to the first byte of
988 /// the specified file.
989 SourceLocation getLocForStartOfFile(FileID FID) const {
990 bool Invalid = false;
991 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
992 if (Invalid || !Entry.isFile())
993 return SourceLocation();
995 unsigned FileOffset = Entry.getOffset();
996 return SourceLocation::getFileLoc(FileOffset);
999 /// \brief Return the source location corresponding to the last byte of the
1001 SourceLocation getLocForEndOfFile(FileID FID) const {
1002 bool Invalid = false;
1003 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1004 if (Invalid || !Entry.isFile())
1005 return SourceLocation();
1007 unsigned FileOffset = Entry.getOffset();
1008 return SourceLocation::getFileLoc(FileOffset + getFileIDSize(FID) - 1);
1011 /// \brief Returns the include location if \p FID is a \#include'd file
1012 /// otherwise it returns an invalid location.
1013 SourceLocation getIncludeLoc(FileID FID) const {
1014 bool Invalid = false;
1015 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
1016 if (Invalid || !Entry.isFile())
1017 return SourceLocation();
1019 return Entry.getFile().getIncludeLoc();
1022 // \brief Returns the import location if the given source location is
1023 // located within a module, or an invalid location if the source location
1024 // is within the current translation unit.
1025 std::pair<SourceLocation, StringRef>
1026 getModuleImportLoc(SourceLocation Loc) const {
1027 FileID FID = getFileID(Loc);
1029 // Positive file IDs are in the current translation unit, and -1 is a
1032 return std::make_pair(SourceLocation(), "");
1034 return ExternalSLocEntries->getModuleImportLoc(FID.ID);
1037 /// \brief Given a SourceLocation object \p Loc, return the expansion
1038 /// location referenced by the ID.
1039 SourceLocation getExpansionLoc(SourceLocation Loc) const {
1040 // Handle the non-mapped case inline, defer to out of line code to handle
1042 if (Loc.isFileID()) return Loc;
1043 return getExpansionLocSlowCase(Loc);
1046 /// \brief Given \p Loc, if it is a macro location return the expansion
1047 /// location or the spelling location, depending on if it comes from a
1048 /// macro argument or not.
1049 SourceLocation getFileLoc(SourceLocation Loc) const {
1050 if (Loc.isFileID()) return Loc;
1051 return getFileLocSlowCase(Loc);
1054 /// \brief Return the start/end of the expansion information for an
1055 /// expansion location.
1057 /// \pre \p Loc is required to be an expansion location.
1058 std::pair<SourceLocation,SourceLocation>
1059 getImmediateExpansionRange(SourceLocation Loc) const;
1061 /// \brief Given a SourceLocation object, return the range of
1062 /// tokens covered by the expansion the ultimate file.
1063 std::pair<SourceLocation,SourceLocation>
1064 getExpansionRange(SourceLocation Loc) const;
1067 /// \brief Given a SourceLocation object, return the spelling
1068 /// location referenced by the ID.
1070 /// This is the place where the characters that make up the lexed token
1072 SourceLocation getSpellingLoc(SourceLocation Loc) const {
1073 // Handle the non-mapped case inline, defer to out of line code to handle
1075 if (Loc.isFileID()) return Loc;
1076 return getSpellingLocSlowCase(Loc);
1079 /// \brief Given a SourceLocation object, return the spelling location
1080 /// referenced by the ID.
1082 /// This is the first level down towards the place where the characters
1083 /// that make up the lexed token can be found. This should not generally
1084 /// be used by clients.
1085 SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const;
1087 /// \brief Decompose the specified location into a raw FileID + Offset pair.
1089 /// The first element is the FileID, the second is the offset from the
1090 /// start of the buffer of the location.
1091 std::pair<FileID, unsigned> getDecomposedLoc(SourceLocation Loc) const {
1092 FileID FID = getFileID(Loc);
1093 bool Invalid = false;
1094 const SrcMgr::SLocEntry &E = getSLocEntry(FID, &Invalid);
1096 return std::make_pair(FileID(), 0);
1097 return std::make_pair(FID, Loc.getOffset()-E.getOffset());
1100 /// \brief Decompose the specified location into a raw FileID + Offset pair.
1102 /// If the location is an expansion record, walk through it until we find
1103 /// the final location expanded.
1104 std::pair<FileID, unsigned>
1105 getDecomposedExpansionLoc(SourceLocation Loc) const {
1106 FileID FID = getFileID(Loc);
1107 bool Invalid = false;
1108 const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid);
1110 return std::make_pair(FileID(), 0);
1112 unsigned Offset = Loc.getOffset()-E->getOffset();
1114 return std::make_pair(FID, Offset);
1116 return getDecomposedExpansionLocSlowCase(E);
1119 /// \brief Decompose the specified location into a raw FileID + Offset pair.
1121 /// If the location is an expansion record, walk through it until we find
1122 /// its spelling record.
1123 std::pair<FileID, unsigned>
1124 getDecomposedSpellingLoc(SourceLocation Loc) const {
1125 FileID FID = getFileID(Loc);
1126 bool Invalid = false;
1127 const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid);
1129 return std::make_pair(FileID(), 0);
1131 unsigned Offset = Loc.getOffset()-E->getOffset();
1133 return std::make_pair(FID, Offset);
1134 return getDecomposedSpellingLocSlowCase(E, Offset);
1137 /// \brief Returns the "included/expanded in" decomposed location of the given
1139 std::pair<FileID, unsigned> getDecomposedIncludedLoc(FileID FID) const;
1141 /// \brief Returns the offset from the start of the file that the
1142 /// specified SourceLocation represents.
1144 /// This is not very meaningful for a macro ID.
1145 unsigned getFileOffset(SourceLocation SpellingLoc) const {
1146 return getDecomposedLoc(SpellingLoc).second;
1149 /// \brief Tests whether the given source location represents a macro
1150 /// argument's expansion into the function-like macro definition.
1152 /// Such source locations only appear inside of the expansion
1153 /// locations representing where a particular function-like macro was
1155 bool isMacroArgExpansion(SourceLocation Loc) const;
1157 /// \brief Tests whether the given source location represents the expansion of
1160 /// This is equivalent to testing whether the location is part of a macro
1161 /// expansion but not the expansion of an argument to a function-like macro.
1162 bool isMacroBodyExpansion(SourceLocation Loc) const;
1164 /// \brief Returns true if \p Loc is inside the [\p Start, +\p Length)
1165 /// chunk of the source location address space.
1167 /// If it's true and \p RelativeOffset is non-null, it will be set to the
1168 /// relative offset of \p Loc inside the chunk.
1169 bool isInSLocAddrSpace(SourceLocation Loc,
1170 SourceLocation Start, unsigned Length,
1171 unsigned *RelativeOffset = 0) const {
1172 assert(((Start.getOffset() < NextLocalOffset &&
1173 Start.getOffset()+Length <= NextLocalOffset) ||
1174 (Start.getOffset() >= CurrentLoadedOffset &&
1175 Start.getOffset()+Length < MaxLoadedOffset)) &&
1176 "Chunk is not valid SLoc address space");
1177 unsigned LocOffs = Loc.getOffset();
1178 unsigned BeginOffs = Start.getOffset();
1179 unsigned EndOffs = BeginOffs + Length;
1180 if (LocOffs >= BeginOffs && LocOffs < EndOffs) {
1182 *RelativeOffset = LocOffs - BeginOffs;
1189 /// \brief Return true if both \p LHS and \p RHS are in the local source
1190 /// location address space or the loaded one.
1192 /// If it's true and \p RelativeOffset is non-null, it will be set to the
1193 /// offset of \p RHS relative to \p LHS.
1194 bool isInSameSLocAddrSpace(SourceLocation LHS, SourceLocation RHS,
1195 int *RelativeOffset) const {
1196 unsigned LHSOffs = LHS.getOffset(), RHSOffs = RHS.getOffset();
1197 bool LHSLoaded = LHSOffs >= CurrentLoadedOffset;
1198 bool RHSLoaded = RHSOffs >= CurrentLoadedOffset;
1200 if (LHSLoaded == RHSLoaded) {
1202 *RelativeOffset = RHSOffs - LHSOffs;
1209 //===--------------------------------------------------------------------===//
1210 // Queries about the code at a SourceLocation.
1211 //===--------------------------------------------------------------------===//
1213 /// \brief Return a pointer to the start of the specified location
1214 /// in the appropriate spelling MemoryBuffer.
1216 /// \param Invalid If non-NULL, will be set \c true if an error occurs.
1217 const char *getCharacterData(SourceLocation SL, bool *Invalid = 0) const;
1219 /// \brief Return the column # for the specified file position.
1221 /// This is significantly cheaper to compute than the line number. This
1222 /// returns zero if the column number isn't known. This may only be called
1223 /// on a file sloc, so you must choose a spelling or expansion location
1224 /// before calling this method.
1225 unsigned getColumnNumber(FileID FID, unsigned FilePos,
1226 bool *Invalid = 0) const;
1227 unsigned getSpellingColumnNumber(SourceLocation Loc, bool *Invalid = 0) const;
1228 unsigned getExpansionColumnNumber(SourceLocation Loc,
1229 bool *Invalid = 0) const;
1230 unsigned getPresumedColumnNumber(SourceLocation Loc, bool *Invalid = 0) const;
1233 /// \brief Given a SourceLocation, return the spelling line number
1234 /// for the position indicated.
1236 /// This requires building and caching a table of line offsets for the
1237 /// MemoryBuffer, so this is not cheap: use only when about to emit a
1239 unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid = 0) const;
1240 unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid = 0) const;
1241 unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid = 0) const;
1242 unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid = 0) const;
1244 /// \brief Return the filename or buffer identifier of the buffer the
1247 /// Note that this name does not respect \#line directives. Use
1248 /// getPresumedLoc for normal clients.
1249 const char *getBufferName(SourceLocation Loc, bool *Invalid = 0) const;
1251 /// \brief Return the file characteristic of the specified source
1252 /// location, indicating whether this is a normal file, a system
1253 /// header, or an "implicit extern C" system header.
1255 /// This state can be modified with flags on GNU linemarker directives like:
1259 /// which changes all source locations in the current file after that to be
1260 /// considered to be from a system header.
1261 SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const;
1263 /// \brief Returns the "presumed" location of a SourceLocation specifies.
1265 /// A "presumed location" can be modified by \#line or GNU line marker
1266 /// directives. This provides a view on the data that a user should see
1267 /// in diagnostics, for example.
1269 /// Note that a presumed location is always given as the expansion point of
1270 /// an expansion location, not at the spelling location.
1272 /// \returns The presumed location of the specified SourceLocation. If the
1273 /// presumed location cannot be calculate (e.g., because \p Loc is invalid
1274 /// or the file containing \p Loc has changed on disk), returns an invalid
1275 /// presumed location.
1276 PresumedLoc getPresumedLoc(SourceLocation Loc,
1277 bool UseLineDirectives = true) const;
1279 /// \brief Returns true if both SourceLocations correspond to the same file.
1280 bool isFromSameFile(SourceLocation Loc1, SourceLocation Loc2) const {
1281 return getFileID(Loc1) == getFileID(Loc2);
1284 /// \brief Returns true if the file of provided SourceLocation is the main
1286 bool isFromMainFile(SourceLocation Loc) const {
1287 return getFileID(Loc) == getMainFileID();
1290 /// \brief Returns if a SourceLocation is in a system header.
1291 bool isInSystemHeader(SourceLocation Loc) const {
1292 return getFileCharacteristic(Loc) != SrcMgr::C_User;
1295 /// \brief Returns if a SourceLocation is in an "extern C" system header.
1296 bool isInExternCSystemHeader(SourceLocation Loc) const {
1297 return getFileCharacteristic(Loc) == SrcMgr::C_ExternCSystem;
1300 /// \brief Returns whether \p Loc is expanded from a macro in a system header.
1301 bool isInSystemMacro(SourceLocation loc) {
1302 return loc.isMacroID() && isInSystemHeader(getSpellingLoc(loc));
1305 /// \brief The size of the SLocEnty that \p FID represents.
1306 unsigned getFileIDSize(FileID FID) const;
1308 /// \brief Given a specific FileID, returns true if \p Loc is inside that
1309 /// FileID chunk and sets relative offset (offset of \p Loc from beginning
1310 /// of FileID) to \p relativeOffset.
1311 bool isInFileID(SourceLocation Loc, FileID FID,
1312 unsigned *RelativeOffset = 0) const {
1313 unsigned Offs = Loc.getOffset();
1314 if (isOffsetInFileID(FID, Offs)) {
1316 *RelativeOffset = Offs - getSLocEntry(FID).getOffset();
1323 //===--------------------------------------------------------------------===//
1324 // Line Table Manipulation Routines
1325 //===--------------------------------------------------------------------===//
1327 /// \brief Return the uniqued ID for the specified filename.
1329 unsigned getLineTableFilenameID(StringRef Str);
1331 /// \brief Add a line note to the line table for the FileID and offset
1332 /// specified by Loc.
1334 /// If FilenameID is -1, it is considered to be unspecified.
1335 void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID);
1336 void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID,
1337 bool IsFileEntry, bool IsFileExit,
1338 bool IsSystemHeader, bool IsExternCHeader);
1340 /// \brief Determine if the source manager has a line table.
1341 bool hasLineTable() const { return LineTable != 0; }
1343 /// \brief Retrieve the stored line table.
1344 LineTableInfo &getLineTable();
1346 //===--------------------------------------------------------------------===//
1347 // Queries for performance analysis.
1348 //===--------------------------------------------------------------------===//
1350 /// \brief Return the total amount of physical memory allocated by the
1351 /// ContentCache allocator.
1352 size_t getContentCacheSize() const {
1353 return ContentCacheAlloc.getTotalMemory();
1356 struct MemoryBufferSizes {
1357 const size_t malloc_bytes;
1358 const size_t mmap_bytes;
1360 MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes)
1361 : malloc_bytes(malloc_bytes), mmap_bytes(mmap_bytes) {}
1364 /// \brief Return the amount of memory used by memory buffers, breaking down
1365 /// by heap-backed versus mmap'ed memory.
1366 MemoryBufferSizes getMemoryBufferSizes() const;
1368 /// \brief Return the amount of memory used for various side tables and
1369 /// data structures in the SourceManager.
1370 size_t getDataStructureSizes() const;
1372 //===--------------------------------------------------------------------===//
1373 // Other miscellaneous methods.
1374 //===--------------------------------------------------------------------===//
1376 /// \brief Get the source location for the given file:line:col triplet.
1378 /// If the source file is included multiple times, the source location will
1379 /// be based upon the first inclusion.
1380 SourceLocation translateFileLineCol(const FileEntry *SourceFile,
1381 unsigned Line, unsigned Col) const;
1383 /// \brief Get the FileID for the given file.
1385 /// If the source file is included multiple times, the FileID will be the
1386 /// first inclusion.
1387 FileID translateFile(const FileEntry *SourceFile) const;
1389 /// \brief Get the source location in \p FID for the given line:col.
1390 /// Returns null location if \p FID is not a file SLocEntry.
1391 SourceLocation translateLineCol(FileID FID,
1392 unsigned Line, unsigned Col) const;
1394 /// \brief If \p Loc points inside a function macro argument, the returned
1395 /// location will be the macro location in which the argument was expanded.
1396 /// If a macro argument is used multiple times, the expanded location will
1397 /// be at the first expansion of the argument.
1401 /// Passing a file location pointing at 'foo', will yield a macro location
1402 /// where 'foo' was expanded into.
1403 SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const;
1405 /// \brief Determines the order of 2 source locations in the translation unit.
1407 /// \returns true if LHS source location comes before RHS, false otherwise.
1408 bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const;
1410 /// \brief Determines the order of 2 source locations in the "source location
1412 bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const {
1413 return isBeforeInSLocAddrSpace(LHS, RHS.getOffset());
1416 /// \brief Determines the order of a source location and a source location
1417 /// offset in the "source location address space".
1419 /// Note that we always consider source locations loaded from
1420 bool isBeforeInSLocAddrSpace(SourceLocation LHS, unsigned RHS) const {
1421 unsigned LHSOffset = LHS.getOffset();
1422 bool LHSLoaded = LHSOffset >= CurrentLoadedOffset;
1423 bool RHSLoaded = RHS >= CurrentLoadedOffset;
1424 if (LHSLoaded == RHSLoaded)
1425 return LHSOffset < RHS;
1430 // Iterators over FileInfos.
1431 typedef llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>
1432 ::const_iterator fileinfo_iterator;
1433 fileinfo_iterator fileinfo_begin() const { return FileInfos.begin(); }
1434 fileinfo_iterator fileinfo_end() const { return FileInfos.end(); }
1435 bool hasFileInfo(const FileEntry *File) const {
1436 return FileInfos.find(File) != FileInfos.end();
1439 /// \brief Print statistics to stderr.
1441 void PrintStats() const;
1443 /// \brief Get the number of local SLocEntries we have.
1444 unsigned local_sloc_entry_size() const { return LocalSLocEntryTable.size(); }
1446 /// \brief Get a local SLocEntry. This is exposed for indexing.
1447 const SrcMgr::SLocEntry &getLocalSLocEntry(unsigned Index,
1448 bool *Invalid = 0) const {
1449 assert(Index < LocalSLocEntryTable.size() && "Invalid index");
1450 return LocalSLocEntryTable[Index];
1453 /// \brief Get the number of loaded SLocEntries we have.
1454 unsigned loaded_sloc_entry_size() const { return LoadedSLocEntryTable.size();}
1456 /// \brief Get a loaded SLocEntry. This is exposed for indexing.
1457 const SrcMgr::SLocEntry &getLoadedSLocEntry(unsigned Index,
1458 bool *Invalid = 0) const {
1459 assert(Index < LoadedSLocEntryTable.size() && "Invalid index");
1460 if (SLocEntryLoaded[Index])
1461 return LoadedSLocEntryTable[Index];
1462 return loadSLocEntry(Index, Invalid);
1465 const SrcMgr::SLocEntry &getSLocEntry(FileID FID, bool *Invalid = 0) const {
1466 if (FID.ID == 0 || FID.ID == -1) {
1467 if (Invalid) *Invalid = true;
1468 return LocalSLocEntryTable[0];
1470 return getSLocEntryByID(FID.ID);
1473 unsigned getNextLocalOffset() const { return NextLocalOffset; }
1475 void setExternalSLocEntrySource(ExternalSLocEntrySource *Source) {
1476 assert(LoadedSLocEntryTable.empty() &&
1477 "Invalidating existing loaded entries");
1478 ExternalSLocEntries = Source;
1481 /// \brief Allocate a number of loaded SLocEntries, which will be actually
1482 /// loaded on demand from the external source.
1484 /// NumSLocEntries will be allocated, which occupy a total of TotalSize space
1485 /// in the global source view. The lowest ID and the base offset of the
1486 /// entries will be returned.
1487 std::pair<int, unsigned>
1488 AllocateLoadedSLocEntries(unsigned NumSLocEntries, unsigned TotalSize);
1490 /// \brief Returns true if \p Loc came from a PCH/Module.
1491 bool isLoadedSourceLocation(SourceLocation Loc) const {
1492 return Loc.getOffset() >= CurrentLoadedOffset;
1495 /// \brief Returns true if \p Loc did not come from a PCH/Module.
1496 bool isLocalSourceLocation(SourceLocation Loc) const {
1497 return Loc.getOffset() < NextLocalOffset;
1500 /// \brief Returns true if \p FID came from a PCH/Module.
1501 bool isLoadedFileID(FileID FID) const {
1502 assert(FID.ID != -1 && "Using FileID sentinel value");
1506 /// \brief Returns true if \p FID did not come from a PCH/Module.
1507 bool isLocalFileID(FileID FID) const {
1508 return !isLoadedFileID(FID);
1511 /// Gets the location of the immediate macro caller, one level up the stack
1512 /// toward the initial macro typed into the source.
1513 SourceLocation getImmediateMacroCallerLoc(SourceLocation Loc) const {
1514 if (!Loc.isMacroID()) return Loc;
1516 // When we have the location of (part of) an expanded parameter, its
1517 // spelling location points to the argument as expanded in the macro call,
1518 // and therefore is used to locate the macro caller.
1519 if (isMacroArgExpansion(Loc))
1520 return getImmediateSpellingLoc(Loc);
1522 // Otherwise, the caller of the macro is located where this macro is
1523 // expanded (while the spelling is part of the macro definition).
1524 return getImmediateExpansionRange(Loc).first;
1528 const llvm::MemoryBuffer *getFakeBufferForRecovery() const;
1529 const SrcMgr::ContentCache *getFakeContentCacheForRecovery() const;
1531 const SrcMgr::SLocEntry &loadSLocEntry(unsigned Index, bool *Invalid) const;
1533 /// \brief Get the entry with the given unwrapped FileID.
1534 const SrcMgr::SLocEntry &getSLocEntryByID(int ID) const {
1535 assert(ID != -1 && "Using FileID sentinel value");
1537 return getLoadedSLocEntryByID(ID);
1538 return getLocalSLocEntry(static_cast<unsigned>(ID));
1541 const SrcMgr::SLocEntry &getLoadedSLocEntryByID(int ID,
1542 bool *Invalid = 0) const {
1543 return getLoadedSLocEntry(static_cast<unsigned>(-ID - 2), Invalid);
1546 /// Implements the common elements of storing an expansion info struct into
1547 /// the SLocEntry table and producing a source location that refers to it.
1548 SourceLocation createExpansionLocImpl(const SrcMgr::ExpansionInfo &Expansion,
1551 unsigned LoadedOffset = 0);
1553 /// \brief Return true if the specified FileID contains the
1554 /// specified SourceLocation offset. This is a very hot method.
1555 inline bool isOffsetInFileID(FileID FID, unsigned SLocOffset) const {
1556 const SrcMgr::SLocEntry &Entry = getSLocEntry(FID);
1557 // If the entry is after the offset, it can't contain it.
1558 if (SLocOffset < Entry.getOffset()) return false;
1560 // If this is the very last entry then it does.
1564 // If it is the last local entry, then it does if the location is local.
1565 if (FID.ID+1 == static_cast<int>(LocalSLocEntryTable.size()))
1566 return SLocOffset < NextLocalOffset;
1568 // Otherwise, the entry after it has to not include it. This works for both
1569 // local and loaded entries.
1570 return SLocOffset < getSLocEntryByID(FID.ID+1).getOffset();
1573 /// \brief Create a new fileID for the specified ContentCache and
1574 /// include position.
1576 /// This works regardless of whether the ContentCache corresponds to a
1577 /// file or some other input source.
1578 FileID createFileID(const SrcMgr::ContentCache* File,
1579 SourceLocation IncludePos,
1580 SrcMgr::CharacteristicKind DirCharacter,
1581 int LoadedID, unsigned LoadedOffset);
1583 const SrcMgr::ContentCache *
1584 getOrCreateContentCache(const FileEntry *SourceFile,
1585 bool isSystemFile = false);
1587 /// \brief Create a new ContentCache for the specified memory buffer.
1588 const SrcMgr::ContentCache*
1589 createMemBufferContentCache(const llvm::MemoryBuffer *Buf);
1591 FileID getFileIDSlow(unsigned SLocOffset) const;
1592 FileID getFileIDLocal(unsigned SLocOffset) const;
1593 FileID getFileIDLoaded(unsigned SLocOffset) const;
1595 SourceLocation getExpansionLocSlowCase(SourceLocation Loc) const;
1596 SourceLocation getSpellingLocSlowCase(SourceLocation Loc) const;
1597 SourceLocation getFileLocSlowCase(SourceLocation Loc) const;
1599 std::pair<FileID, unsigned>
1600 getDecomposedExpansionLocSlowCase(const SrcMgr::SLocEntry *E) const;
1601 std::pair<FileID, unsigned>
1602 getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
1603 unsigned Offset) const;
1604 void computeMacroArgsCache(MacroArgsMap *&MacroArgsCache, FileID FID) const;
1605 void associateFileChunkWithMacroArgExp(MacroArgsMap &MacroArgsCache,
1607 SourceLocation SpellLoc,
1608 SourceLocation ExpansionLoc,
1609 unsigned ExpansionLength) const;
1610 friend class ASTReader;
1611 friend class ASTWriter;
1614 /// \brief Comparison function object.
1615 template<typename T>
1616 class BeforeThanCompare;
1618 /// \brief Compare two source locations.
1620 class BeforeThanCompare<SourceLocation> {
1624 explicit BeforeThanCompare(SourceManager &SM) : SM(SM) { }
1626 bool operator()(SourceLocation LHS, SourceLocation RHS) const {
1627 return SM.isBeforeInTranslationUnit(LHS, RHS);
1631 /// \brief Compare two non-overlapping source ranges.
1633 class BeforeThanCompare<SourceRange> {
1637 explicit BeforeThanCompare(SourceManager &SM) : SM(SM) { }
1639 bool operator()(SourceRange LHS, SourceRange RHS) {
1640 return SM.isBeforeInTranslationUnit(LHS.getBegin(), RHS.getBegin());
1644 } // end namespace clang