34#ifndef LLVM_CLANG_BASIC_SOURCEMANAGER_H
35#define LLVM_CLANG_BASIC_SOURCEMANAGER_H
41#include "llvm/ADT/ArrayRef.h"
42#include "llvm/ADT/BitVector.h"
43#include "llvm/ADT/DenseMap.h"
44#include "llvm/ADT/DenseSet.h"
45#include "llvm/ADT/IntrusiveRefCntPtr.h"
46#include "llvm/ADT/PointerIntPair.h"
47#include "llvm/ADT/SmallVector.h"
48#include "llvm/ADT/StringRef.h"
49#include "llvm/Support/Allocator.h"
50#include "llvm/Support/Compiler.h"
51#include "llvm/Support/MemoryBuffer.h"
102 explicit operator bool()
const {
return Storage; }
116 llvm::BumpPtrAllocator &Alloc);
120 llvm::BumpPtrAllocator &Alloc);
124 unsigned *Storage =
nullptr;
133 mutable std::unique_ptr<llvm::MemoryBuffer> Buffer;
203 "Passed ContentCache object cannot own a buffer.");
215 std::optional<llvm::MemoryBufferRef>
240 return Buffer->getMemBufferRef();
248 return Buffer->getBuffer();
255 Buffer = std::move(B);
262 assert(!Buffer &&
"Expected to be called right after construction");
264 setBuffer(llvm::MemoryBuffer::getMemBuffer(*B));
274static_assert(
alignof(ContentCache) >= 8,
275 "ContentCache must be 8-byte aligned.");
304 unsigned NumCreatedFIDs : 31;
307 unsigned HasLineDirectives : 1;
310 llvm::PointerIntPair<const ContentCache *, 3, CharacteristicKind>
319 X.NumCreatedFIDs = 0;
320 X.HasLineDirectives =
false;
321 X.ContentAndKind.setPointer(&Con);
322 X.ContentAndKind.setInt(FileCharacter);
332 return *ContentAndKind.getPointer();
337 return ContentAndKind.getInt();
370 bool ExpansionIsTokenRange;
378 return ExpansionLocStart;
416 bool ExpansionIsTokenRange =
true) {
418 X.SpellingLoc = SpellingLoc;
419 X.ExpansionLocStart = Start;
420 X.ExpansionLocEnd = End;
421 X.ExpansionIsTokenRange = ExpansionIsTokenRange;
460 return create(SpellingLoc, Start, End,
false);
468static_assert(
sizeof(FileInfo) <=
sizeof(ExpansionInfo),
469 "FileInfo must be no larger than ExpansionInfo.");
493 assert(
isFile() &&
"Not a file SLocEntry!");
498 assert(
isExpansion() &&
"Not a macro expansion SLocEntry!");
503 assert(!(Offset & (1ULL << OffsetBits)) &&
"Offset is too large");
506 E.IsExpansion =
false;
513 assert(!(Offset & (1ULL << OffsetBits)) &&
"Offset is too large");
516 E.IsExpansion =
true;
550 FileID LQueryFID, RQueryFID;
555 bool LChildBeforeRChild;
566 unsigned LCommonOffset, RCommonOffset;
587 if (LQueryFID != CommonFID) LOffset = LCommonOffset;
588 if (RQueryFID != CommonFID) ROffset = RCommonOffset;
595 if (LOffset == ROffset)
596 return LChildBeforeRChild;
598 return LOffset < ROffset;
605 if (LQueryFID != LHS || RQueryFID != RHS) {
613 unsigned rCommonOffset,
bool LParentBeforeRParent) {
614 CommonFID = commonFID;
615 LCommonOffset = lCommonOffset;
616 RCommonOffset = rCommonOffset;
617 LChildBeforeRChild = LParentBeforeRParent;
644 mutable llvm::BumpPtrAllocator ContentCacheAlloc;
652 llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> FileInfos;
656 bool OverridenFilesKeepOriginalName =
true;
660 bool UserFilesAreVolatile;
665 bool FilesAreTransient =
false;
667 struct OverriddenFilesInfoTy {
670 llvm::DenseMap<const FileEntry *, FileEntryRef> OverriddenFiles;
678 std::unique_ptr<OverriddenFilesInfoTy> OverriddenFilesInfo;
680 OverriddenFilesInfoTy &getOverriddenFilesInfo() {
681 if (!OverriddenFilesInfo)
682 OverriddenFilesInfo.reset(
new OverriddenFilesInfoTy);
683 return *OverriddenFilesInfo;
690 std::vector<SrcMgr::ContentCache*> MemBufferInfos;
724 llvm::BitVector SLocEntryLoaded;
733 mutable FileID LastFileIDLookup;
738 std::unique_ptr<LineTableInfo> LineTable;
742 mutable FileID LastLineNoFileIDQuery;
744 mutable unsigned LastLineNoFilePos;
745 mutable unsigned LastLineNoResult;
754 mutable unsigned NumLinearScans = 0;
755 mutable unsigned NumBinaryProbes = 0;
762 mutable llvm::DenseMap<FileID, std::pair<FileID, unsigned>> IncludedLocMap;
765 using IsBeforeInTUCacheKey = std::pair<FileID, FileID>;
769 using InBeforeInTUCache =
770 llvm::DenseMap<IsBeforeInTUCacheKey, InBeforeInTUCacheEntry>;
773 mutable InBeforeInTUCache IBTUCache;
781 mutable std::unique_ptr<llvm::MemoryBuffer> FakeBufferForRecovery;
783 mutable std::unique_ptr<SrcMgr::ContentCache> FakeContentCacheForRecovery;
785 mutable std::unique_ptr<SrcMgr::SLocEntry> FakeSLocEntryForRecovery;
789 using MacroArgsMap = std::map<unsigned, SourceLocation>;
791 mutable llvm::DenseMap<FileID, std::unique_ptr<MacroArgsMap>>
805 bool UserFilesAreVolatile =
false);
824 OverridenFilesKeepOriginalName = value;
833 return StoredModuleBuildStack;
838 StoredModuleBuildStack.clear();
839 StoredModuleBuildStack.append(stack.begin(), stack.end());
844 StoredModuleBuildStack.push_back(std::make_pair(moduleName.str(),importLoc));
866 assert(PreambleFileID.
isInvalid() &&
"PreambleFileID already set!");
931 bool ExpansionIsTokenRange =
true,
944 std::optional<llvm::MemoryBufferRef>
953 return getFakeBufferForRecovery();
964 const llvm::MemoryBufferRef &Buffer) {
976 std::unique_ptr<llvm::MemoryBuffer> Buffer);
978 std::unique_ptr<llvm::MemoryBuffer> Buffer) {
992 if (OverriddenFilesInfo) {
993 if (OverriddenFilesInfo->OverriddenFilesWithBuffer.count(
File))
995 if (OverriddenFilesInfo->OverriddenFiles.contains(
File))
1014 FilesAreTransient = Transient;
1025 std::optional<llvm::MemoryBufferRef>
1027 if (
auto *Entry = getSLocEntryForFile(FID))
1028 return Entry->getFile().getContentCache().getBufferOrNone(
1030 return std::nullopt;
1037 llvm::MemoryBufferRef
1041 return getFakeBufferForRecovery();
1046 if (
auto *Entry = getSLocEntryForFile(FID))
1047 return Entry->getFile().getContentCache().OrigEntry;
1053 if (
auto *Entry = getSLocEntryForFile(FID))
1054 return Entry->getFile().getContentCache().OrigEntry;
1055 return std::nullopt;
1092 if (
auto *Entry = getSLocEntryForFile(FID))
1093 return Entry->getFile().NumCreatedFIDs;
1100 bool Force =
false)
const {
1101 auto *Entry = getSLocEntryForFile(FID);
1104 assert((Force || Entry->getFile().NumCreatedFIDs == 0) &&
"Already set!");
1119 return getFileID(SpellingLoc.getOffset());
1128 if (
auto *Entry = getSLocEntryForFile(FID))
1129 return SourceLocation::getFileLoc(Entry->getOffset());
1136 if (
auto *Entry = getSLocEntryForFile(FID))
1137 return SourceLocation::getFileLoc(Entry->getOffset() +
1145 if (
auto *Entry = getSLocEntryForFile(FID))
1146 return Entry->getFile().getIncludeLoc();
1153 std::pair<SourceLocation, StringRef>
1171 return getExpansionLocSlowCase(Loc);
1179 return getFileLocSlowCase(Loc);
1198 End.isTokenRange());
1205 if (Expansion.
getEnd() == Range.getEnd())
1219 return getSpellingLocSlowCase(Loc);
1232 auto *Entry = getSLocEntryOrNull(FID);
1237 return Entry->isFile() ? SourceLocation::getFileLoc(GlobalOffset)
1238 : SourceLocation::getMacroLoc(GlobalOffset);
1247 auto *Entry = getSLocEntryOrNull(FID);
1249 return std::make_pair(
FileID(), 0);
1250 return std::make_pair(FID, Loc.getOffset() - Entry->getOffset());
1257 std::pair<FileID, unsigned>
1260 auto *E = getSLocEntryOrNull(FID);
1262 return std::make_pair(
FileID(), 0);
1264 unsigned Offset = Loc.getOffset()-E->getOffset();
1266 return std::make_pair(FID, Offset);
1268 return getDecomposedExpansionLocSlowCase(E);
1275 std::pair<FileID, unsigned>
1278 auto *E = getSLocEntryOrNull(FID);
1280 return std::make_pair(
FileID(), 0);
1282 unsigned Offset = Loc.getOffset()-E->getOffset();
1284 return std::make_pair(FID, Offset);
1285 return getDecomposedSpellingLocSlowCase(E, Offset);
1344 assert(((Start.getOffset() < NextLocalOffset &&
1345 Start.getOffset()+Length <= NextLocalOffset) ||
1346 (Start.getOffset() >= CurrentLoadedOffset &&
1347 Start.getOffset()+Length < MaxLoadedOffset)) &&
1348 "Chunk is not valid SLoc address space");
1352 if (LocOffs >= BeginOffs && LocOffs < EndOffs) {
1354 *RelativeOffset = LocOffs - BeginOffs;
1369 bool LHSLoaded = LHSOffs >= CurrentLoadedOffset;
1370 bool RHSLoaded = RHSOffs >= CurrentLoadedOffset;
1372 if (LHSLoaded == RHSLoaded) {
1374 *RelativeOffset = RHSOffs - LHSOffs;
1390 bool *
Invalid =
nullptr)
const;
1399 bool *
Invalid =
nullptr)
const;
1401 bool *
Invalid =
nullptr)
const;
1403 bool *
Invalid =
nullptr)
const;
1405 bool *
Invalid =
nullptr)
const;
1451 bool UseLineDirectives =
true)
const;
1484 return Filename.equals(
"<built-in>");
1493 return Filename.equals(
"<command line>");
1502 return Filename.equals(
"<scratch space>");
1542 unsigned *RelativeOffset =
nullptr)
const {
1544 if (isOffsetInFileID(FID, Offs)) {
1565 bool IsFileEntry,
bool IsFileExit,
1581 return ContentCacheAlloc.getTotalMemory();
1609 unsigned Line,
unsigned Col)
const;
1623 unsigned Line,
unsigned Col)
const;
1648 std::pair<bool, bool>
1650 std::pair<FileID, unsigned> &ROffs)
const;
1665 bool LHSLoaded = LHSOffset >= CurrentLoadedOffset;
1666 bool RHSLoaded = RHS >= CurrentLoadedOffset;
1667 if (LHSLoaded == RHSLoaded)
1668 return LHSOffset < RHS;
1676 return Location == Start || Location == End ||
1683 llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::const_iterator;
1688 return FileInfos.contains(
File);
1698 std::optional<unsigned> MaxNotes = 32)
const;
1705 assert(Index < LocalSLocEntryTable.size() &&
"Invalid index");
1706 return LocalSLocEntryTable[Index];
1714 bool *
Invalid =
nullptr)
const {
1715 assert(Index < LoadedSLocEntryTable.size() &&
"Invalid index");
1716 if (SLocEntryLoaded[Index])
1717 return LoadedSLocEntryTable[Index];
1718 return loadSLocEntry(Index,
Invalid);
1722 bool *
Invalid =
nullptr)
const {
1723 if (FID.ID == 0 || FID.ID == -1) {
1725 return LocalSLocEntryTable[0];
1727 return getSLocEntryByID(FID.ID,
Invalid);
1733 assert(LoadedSLocEntryTable.empty() &&
1734 "Invalidating existing loaded entries");
1735 ExternalSLocEntries = Source;
1744 std::pair<int, SourceLocation::UIntTy>
1750 return isLoadedOffset(Loc.getOffset());
1755 return isLocalOffset(Loc.getOffset());
1760 assert(FID.ID != -1 &&
"Using FileID sentinel value");
1792 llvm::MemoryBufferRef getFakeBufferForRecovery()
const;
1800 return Invalid ? nullptr : &Entry;
1804 if (
auto *Entry = getSLocEntryOrNull(FID))
1805 if (Entry->isFile())
1812 const SrcMgr::SLocEntry &getSLocEntryByID(
int ID,
1813 bool *
Invalid =
nullptr)
const {
1814 assert(
ID != -1 &&
"Using FileID sentinel value");
1816 return getLoadedSLocEntryByID(
ID,
Invalid);
1820 const SrcMgr::SLocEntry &
1821 getLoadedSLocEntryByID(
int ID,
bool *
Invalid =
nullptr)
const {
1827 if (isOffsetInFileID(LastFileIDLookup, SLocOffset))
1828 return LastFileIDLookup;
1830 return getFileIDSlow(SLocOffset);
1834 return SLocOffset < CurrentLoadedOffset;
1838 return SLocOffset >= CurrentLoadedOffset;
1844 createExpansionLocImpl(
const SrcMgr::ExpansionInfo &Expansion,
1845 unsigned Length,
int LoadedID = 0,
1850 inline bool isOffsetInFileID(FileID FID,
1854 if (SLocOffset < Entry.getOffset())
return false;
1861 if (FID.ID+1 ==
static_cast<int>(LocalSLocEntryTable.size()))
1862 return SLocOffset < NextLocalOffset;
1866 return SLocOffset < getSLocEntryByID(FID.ID+1).
getOffset();
1871 FileID getPreviousFileID(FileID FID)
const;
1875 FileID getNextFileID(FileID FID)
const;
1882 FileID createFileIDImpl(SrcMgr::ContentCache &
File, StringRef
Filename,
1883 SourceLocation IncludePos,
1887 SrcMgr::ContentCache &getOrCreateContentCache(FileEntryRef SourceFile,
1888 bool isSystemFile =
false);
1891 SrcMgr::ContentCache &
1892 createMemBufferContentCache(std::unique_ptr<llvm::MemoryBuffer> Buf);
1898 SourceLocation getExpansionLocSlowCase(SourceLocation Loc)
const;
1899 SourceLocation getSpellingLocSlowCase(SourceLocation Loc)
const;
1900 SourceLocation getFileLocSlowCase(SourceLocation Loc)
const;
1902 std::pair<FileID, unsigned>
1903 getDecomposedExpansionLocSlowCase(
const SrcMgr::SLocEntry *E)
const;
1904 std::pair<FileID, unsigned>
1905 getDecomposedSpellingLocSlowCase(
const SrcMgr::SLocEntry *E,
1906 unsigned Offset)
const;
1907 void computeMacroArgsCache(MacroArgsMap &MacroArgsCache, FileID FID)
const;
1908 void associateFileChunkWithMacroArgExp(MacroArgsMap &MacroArgsCache,
1910 SourceLocation SpellLoc,
1911 SourceLocation ExpansionLoc,
1912 unsigned ExpansionLength)
const;
1928 return SM.isBeforeInTranslationUnit(LHS, RHS);
1962 std::unique_ptr<FileManager> FileMgr;
1963 std::unique_ptr<DiagnosticsEngine> Diagnostics;
1964 std::unique_ptr<SourceManager> SourceMgr;
Defines the Diagnostic-related interfaces.
Defines interfaces for clang::FileEntry and clang::FileEntryRef.
Defines the clang::FileManager interface and associated types.
static DiagnosticBuilder Diag(DiagnosticsEngine *Diags, const LangOptions &Features, FullSourceLoc TokLoc, const char *TokBegin, const char *TokRangeBegin, const char *TokRangeEnd, unsigned DiagID)
Produce a diagnostic highlighting some portion of a literal.
Defines the clang::SourceLocation class and associated facilities.
Reads an AST files chain containing the contents of a translation unit.
Writes an AST file containing the contents of a translation unit.
bool operator()(SourceLocation LHS, SourceLocation RHS) const
BeforeThanCompare(SourceManager &SM)
BeforeThanCompare(SourceManager &SM)
bool operator()(SourceRange LHS, SourceRange RHS) const
Comparison function object.
Represents a character-granular source range.
SourceLocation getEnd() const
SourceLocation getBegin() const
void setTokenRange(bool TR)
Concrete class used by the front-end to report problems and issues.
External source of source location entries.
virtual std::pair< SourceLocation, StringRef > getModuleImportLoc(int ID)=0
Retrieve the module import location and name for the given ID, if in fact it was loaded from a module...
virtual ~ExternalSLocEntrySource()
virtual bool ReadSLocEntry(int ID)=0
Read the source location entry with index ID, which will always be less than -1.
A reference to a FileEntry that includes the name of the file as it was accessed by the FileManager's...
const FileEntry & getFileEntry() const
Cached information about one file (either on disk or in the virtual file system).
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Implements support for file system lookup, file system caching, and directory search management.
A SourceLocation and its associated SourceManager.
Holds the cache used by isBeforeInTranslationUnit.
void setCommonLoc(FileID commonFID, unsigned lCommonOffset, unsigned rCommonOffset, bool LParentBeforeRParent)
bool getCachedResult(unsigned LOffset, unsigned ROffset) const
If the cache is valid, compute the result given the specified offsets in the LHS/RHS FileID's.
void setQueryFIDs(FileID LHS, FileID RHS)
Set up a new query.
InBeforeInTUCacheEntry(FileID L, FileID R)
InBeforeInTUCacheEntry()=default
bool isCacheValid() const
Return true if the currently cached values match up with the specified LHS/RHS query.
Used to hold and unique data used to represent #line information.
Wrapper around OptionalFileEntryRef that degrades to 'const FileEntry*', facilitating incremental pat...
Represents an unpacked "presumed" location which can be presented to the user.
const char * getFilename() const
Return the presumed filename of this location.
bool isInvalid() const
Return true if this object is invalid or uninitialized.
Encodes a location in the source.
bool isValid() const
Return true if this is a valid SourceLocation object.
SourceManager and necessary dependencies (e.g.
This class handles loading and caching of source files into memory.
std::optional< StringRef > getNonBuiltinFilenameForID(FileID FID) const
Returns the filename for the provided FileID, unless it's a built-in buffer that's not represented by...
bool isMacroBodyExpansion(SourceLocation Loc) const
Tests whether the given source location represents the expansion of a macro body.
llvm::MemoryBufferRef getMemoryBufferForFileOrFake(const FileEntry *File)
Retrieve the memory buffer associated with the given file.
unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid=nullptr) const
bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const
Determines the order of 2 source locations in the "source location address space".
FileID getFileID(SourceLocation SpellingLoc) const
Return the FileID for a SourceLocation.
bool isAtEndOfImmediateMacroExpansion(SourceLocation Loc, SourceLocation *MacroEnd=nullptr) const
Returns true if the given MacroID location points at the character end of the immediate macro expansi...
DiagnosticsEngine & getDiagnostics() const
SourceLocation::UIntTy getNextLocalOffset() const
void setFileIsTransient(const FileEntry *SourceFile)
Specify that a file is transient.
bool isWrittenInBuiltinFile(SourceLocation Loc) const
Returns whether Loc is located in a <built-in> file.
unsigned getColumnNumber(FileID FID, unsigned FilePos, bool *Invalid=nullptr) const
Return the column # for the specified file position.
void noteSLocAddressSpaceUsage(DiagnosticsEngine &Diag, std::optional< unsigned > MaxNotes=32) const
void setAllFilesAreTransient(bool Transient)
Specify that all files that are read during this compilation are transient.
unsigned getFileOffset(SourceLocation SpellingLoc) const
Returns the offset from the start of the file that the specified SourceLocation represents.
bool isLocalSourceLocation(SourceLocation Loc) const
Returns true if Loc did not come from a PCH/Module.
bool isInMainFile(SourceLocation Loc) const
Returns whether the PresumedLoc for a given SourceLocation is in the main file.
void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID, bool IsFileEntry, bool IsFileExit, SrcMgr::CharacteristicKind FileKind)
Add a line note to the line table for the FileID and offset specified by Loc.
SourceLocation createTokenSplitLoc(SourceLocation SpellingLoc, SourceLocation TokenStart, SourceLocation TokenEnd)
Return a new SourceLocation that encodes that the token starting at TokenStart ends prematurely at To...
PresumedLoc getPresumedLoc(SourceLocation Loc, bool UseLineDirectives=true) const
Returns the "presumed" location of a SourceLocation specifies.
bool isWrittenInCommandLineFile(SourceLocation Loc) const
Returns whether Loc is located in a <command line> file.
MemoryBufferSizes getMemoryBufferSizes() const
Return the amount of memory used by memory buffers, breaking down by heap-backed versus mmap'ed memor...
bool isFileOverridden(const FileEntry *File) const
Returns true if the file contents have been overridden.
OptionalFileEntryRef getFileEntryRefForID(FileID FID) const
Returns the FileEntryRef for the provided FileID.
CharSourceRange getExpansionRange(SourceRange Range) const
Given a SourceRange object, return the range of tokens or characters covered by the expansion in the ...
SourceLocation getFileLoc(SourceLocation Loc) const
Given Loc, if it is a macro location return the expansion location or the spelling location,...
bool isInSLocAddrSpace(SourceLocation Loc, SourceLocation Start, unsigned Length, SourceLocation::UIntTy *RelativeOffset=nullptr) const
Returns true if Loc is inside the [Start, +Length) chunk of the source location address space.
SourceLocation translateLineCol(FileID FID, unsigned Line, unsigned Col) const
Get the source location in FID for the given line:col.
size_t getContentCacheSize() const
Return the total amount of physical memory allocated by the ContentCache allocator.
StringRef getBufferName(SourceLocation Loc, bool *Invalid=nullptr) const
Return the filename or buffer identifier of the buffer the location is in.
SourceLocation getTopMacroCallerLoc(SourceLocation Loc) const
std::optional< StringRef > getBufferDataOrNone(FileID FID) const
Return a StringRef to the source buffer data for the specified FileID, returning std::nullopt if inva...
unsigned getExpansionColumnNumber(SourceLocation Loc, bool *Invalid=nullptr) const
FileID translateFile(const FileEntry *SourceFile) const
Get the FileID for the given file.
CharSourceRange getExpansionRange(CharSourceRange Range) const
Given a CharSourceRange object, return the range of tokens or characters covered by the expansion in ...
void setModuleBuildStack(ModuleBuildStack stack)
Set the module build stack.
StringRef getBufferData(FileID FID, bool *Invalid=nullptr) const
Return a StringRef to the source buffer data for the specified FileID.
void overrideFileContents(const FileEntry *SourceFile, const llvm::MemoryBufferRef &Buffer)
Override the contents of the given source file by providing an already-allocated buffer.
void PrintStats() const
Print statistics to stderr.
bool isMainFile(const FileEntry &SourceFile)
Returns true when the given FileEntry corresponds to the main file.
size_t getDataStructureSizes() const
Return the amount of memory used for various side tables and data structures in the SourceManager.
bool isMacroArgExpansion(SourceLocation Loc, SourceLocation *StartLoc=nullptr) const
Tests whether the given source location represents a macro argument's expansion into the function-lik...
void overrideFileContents(FileEntryRef SourceFile, std::unique_ptr< llvm::MemoryBuffer > Buffer)
const SrcMgr::SLocEntry & getLocalSLocEntry(unsigned Index) const
Get a local SLocEntry. This is exposed for indexing.
SourceLocation getComposedLoc(FileID FID, unsigned Offset) const
Form a SourceLocation from a FileID and Offset pair.
void setPreambleFileID(FileID Preamble)
Set the file ID for the precompiled preamble.
OptionalFileEntryRef bypassFileContentsOverride(FileEntryRef File)
Bypass the overridden contents of a file.
bool userFilesAreVolatile() const
True if non-system source files should be treated as volatile (likely to change while trying to use t...
const SrcMgr::SLocEntry & getLoadedSLocEntry(unsigned Index, bool *Invalid=nullptr) const
Get a loaded SLocEntry. This is exposed for indexing.
SourceLocation getSpellingLoc(SourceLocation Loc) const
Given a SourceLocation object, return the spelling location referenced by the ID.
FileManager & getFileManager() const
void setOverridenFilesKeepOriginalName(bool value)
Set true if the SourceManager should report the original file name for contents of files that were ov...
fileinfo_iterator fileinfo_end() const
FileID translateFile(FileEntryRef SourceFile) const
ModuleBuildStack getModuleBuildStack() const
Retrieve the module build stack.
unsigned local_sloc_entry_size() const
Get the number of local SLocEntries we have.
std::optional< StringRef > getBufferDataIfLoaded(FileID FID) const
Return a StringRef to the source buffer data for the specified FileID, returning std::nullopt if it's...
SourceLocation getLocForEndOfFile(FileID FID) const
Return the source location corresponding to the last byte of the specified file.
FileID getMainFileID() const
Returns the FileID of the main source file.
SourceLocation getImmediateMacroCallerLoc(SourceLocation Loc) const
Gets the location of the immediate macro caller, one level up the stack toward the initial macro type...
const char * getCharacterData(SourceLocation SL, bool *Invalid=nullptr) const
Return a pointer to the start of the specified location in the appropriate spelling MemoryBuffer.
std::pair< int, SourceLocation::UIntTy > AllocateLoadedSLocEntries(unsigned NumSLocEntries, SourceLocation::UIntTy TotalSize)
Allocate a number of loaded SLocEntries, which will be actually loaded on demand from the external so...
void pushModuleBuildStack(StringRef moduleName, FullSourceLoc importLoc)
Push an entry to the module build stack.
SourceLocation getIncludeLoc(FileID FID) const
Returns the include location if FID is a #include'd file otherwise it returns an invalid location.
FileID getOrCreateFileID(const FileEntry *SourceFile, SrcMgr::CharacteristicKind FileCharacter)
Get the FileID for SourceFile if it exists.
llvm::MemoryBufferRef getBufferOrFake(FileID FID, SourceLocation Loc=SourceLocation()) const
Return the buffer for the specified FileID.
unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid=nullptr) const
FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos, SrcMgr::CharacteristicKind FileCharacter, int LoadedID=0, SourceLocation::UIntTy LoadedOffset=0)
Create a new FileID that represents the specified file being #included from the specified IncludePosi...
unsigned getFileIDSize(FileID FID) const
The size of the SLocEntry that FID represents.
bool isInSystemMacro(SourceLocation loc) const
Returns whether Loc is expanded from a macro in a system header.
void setMainFileID(FileID FID)
Set the file ID for the main source file.
unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid=nullptr) const
Given a SourceLocation, return the spelling line number for the position indicated.
const FileEntry * getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const
Returns the FileEntry record for the provided SLocEntry.
std::pair< bool, bool > isInTheSameTranslationUnit(std::pair< FileID, unsigned > &LOffs, std::pair< FileID, unsigned > &ROffs) const
Determines whether the two decomposed source location is in the same translation unit.
std::optional< llvm::MemoryBufferRef > getMemoryBufferForFileOrNone(const FileEntry *File)
Retrieve the memory buffer associated with the given file.
CharSourceRange getImmediateExpansionRange(SourceLocation Loc) const
Return the start/end of the expansion information for an expansion location.
unsigned getSpellingColumnNumber(SourceLocation Loc, bool *Invalid=nullptr) const
bool hasLineTable() const
Determine if the source manager has a line table.
CharSourceRange getExpansionRange(SourceLocation Loc) const
Given a SourceLocation object, return the range of tokens covered by the expansion in the ultimate fi...
bool isWrittenInScratchSpace(SourceLocation Loc) const
Returns whether Loc is located in a <scratch space> file.
bool isInFileID(SourceLocation Loc, FileID FID, unsigned *RelativeOffset=nullptr) const
Given a specific FileID, returns true if Loc is inside that FileID chunk and sets relative offset (of...
void setExternalSLocEntrySource(ExternalSLocEntrySource *Source)
unsigned getLineTableFilenameID(StringRef Str)
Return the uniqued ID for the specified filename.
bool isLocalFileID(FileID FID) const
Returns true if FID did not come from a PCH/Module.
bool isInSystemHeader(SourceLocation Loc) const
Returns if a SourceLocation is in a system header.
llvm::DenseMap< const FileEntry *, SrcMgr::ContentCache * >::const_iterator fileinfo_iterator
FileID getPreambleFileID() const
Get the file ID for the precompiled preamble if there is one.
std::pair< FileID, unsigned > getDecomposedExpansionLoc(SourceLocation Loc) const
Decompose the specified location into a raw FileID + Offset pair.
unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid=nullptr) const
void initializeForReplay(const SourceManager &Old)
Initialize this source manager suitably to replay the compilation described by Old.
bool isLoadedSourceLocation(SourceLocation Loc) const
Returns true if Loc came from a PCH/Module.
unsigned loaded_sloc_entry_size() const
Get the number of loaded SLocEntries we have.
SourceManager & operator=(const SourceManager &)=delete
bool hasFileInfo(const FileEntry *File) const
SourceLocation translateFileLineCol(const FileEntry *SourceFile, unsigned Line, unsigned Col) const
Get the source location for the given file:line:col triplet.
std::pair< SourceLocation, StringRef > getModuleImportLoc(SourceLocation Loc) const
std::pair< FileID, unsigned > getDecomposedLoc(SourceLocation Loc) const
Decompose the specified location into a raw FileID + Offset pair.
bool isLoadedFileID(FileID FID) const
Returns true if FID came from a PCH/Module.
const FileEntry * getFileEntryForID(FileID FID) const
Returns the FileEntry record for the provided FileID.
std::pair< FileID, unsigned > getDecomposedSpellingLoc(SourceLocation Loc) const
Decompose the specified location into a raw FileID + Offset pair.
bool isInSameSLocAddrSpace(SourceLocation LHS, SourceLocation RHS, SourceLocation::IntTy *RelativeOffset) const
Return true if both LHS and RHS are in the local source location address space or the loaded one.
SourceLocation getLocForStartOfFile(FileID FID) const
Return the source location corresponding to the first byte of the specified file.
bool isAtStartOfImmediateMacroExpansion(SourceLocation Loc, SourceLocation *MacroBegin=nullptr) const
Returns true if the given MacroID location points at the beginning of the immediate macro expansion.
SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const
Return the file characteristic of the specified source location, indicating whether this is a normal ...
SourceLocation createExpansionLoc(SourceLocation SpellingLoc, SourceLocation ExpansionLocStart, SourceLocation ExpansionLocEnd, unsigned Length, bool ExpansionIsTokenRange=true, int LoadedID=0, SourceLocation::UIntTy LoadedOffset=0)
Creates an expansion SLocEntry for a macro use.
bool isWrittenInSameFile(SourceLocation Loc1, SourceLocation Loc2) const
Returns true if the spelling locations for both SourceLocations are part of the same file buffer.
bool isInExternCSystemHeader(SourceLocation Loc) const
Returns if a SourceLocation is in an "extern C" system header.
unsigned getPresumedColumnNumber(SourceLocation Loc, bool *Invalid=nullptr) const
bool isWrittenInMainFile(SourceLocation Loc) const
Returns true if the spelling location for the given location is in the main file buffer.
void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs, bool Force=false) const
Set the number of FileIDs (files and macros) that were created during preprocessing of FID,...
bool isPointWithin(SourceLocation Location, SourceLocation Start, SourceLocation End) const
Return true if the Point is within Start and End.
SourceManager(const SourceManager &)=delete
std::pair< FileID, unsigned > getDecomposedIncludedLoc(FileID FID) const
Returns the "included/expanded in" decomposed location of the given FileID.
StringRef getFilename(SourceLocation SpellingLoc) const
Return the filename of the file containing a SourceLocation.
SourceLocation getExpansionLoc(SourceLocation Loc) const
Given a SourceLocation object Loc, return the expansion location referenced by the ID.
SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const
If Loc points inside a function macro argument, the returned location will be the macro location in w...
bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const
Determines the order of 2 source locations in the translation unit.
unsigned getNumCreatedFIDsForFileID(FileID FID) const
Get the number of FileIDs (files and macros) that were created during preprocessing of FID,...
std::optional< llvm::MemoryBufferRef > getBufferOrNone(FileID FID, SourceLocation Loc=SourceLocation()) const
Return the buffer for the specified FileID.
fileinfo_iterator fileinfo_begin() const
bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation::UIntTy RHS) const
Determines the order of a source location and a source location offset in the "source location addres...
LineTableInfo & getLineTable()
Retrieve the stored line table.
SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const
Given a SourceLocation object, return the spelling location referenced by the ID.
const SrcMgr::SLocEntry & getSLocEntry(FileID FID, bool *Invalid=nullptr) const
SourceLocation createMacroArgExpansionLoc(SourceLocation SpellingLoc, SourceLocation ExpansionLoc, unsigned Length)
Creates an expansion SLocEntry for the substitution of an argument into a function-like macro's body.
A trivial tuple used to represent a source range.
SourceLocation getBegin() const
One instance of this struct is kept for every file loaded or used.
void setBuffer(std::unique_ptr< llvm::MemoryBuffer > B)
Set the buffer.
std::optional< StringRef > getBufferDataIfLoaded() const
Return a StringRef to the source buffer data, only if it has already been loaded.
void setUnownedBuffer(std::optional< llvm::MemoryBufferRef > B)
Set the buffer to one that's not owned (or to nullptr).
OptionalFileEntryRef ContentsEntry
References the file which the contents were actually loaded from.
unsigned getSizeBytesMapped() const
Returns the number of bytes actually mapped for this ContentCache.
unsigned IsTransient
True if this file may be transient, that is, if it might not exist at some later point in time when t...
StringRef Filename
The filename that is used to access OrigEntry.
ContentCache(FileEntryRef Ent)
OptionalFileEntryRefDegradesToFileEntryPtr OrigEntry
Reference to the file entry representing this ContentCache.
ContentCache(FileEntryRef Ent, FileEntryRef contentEnt)
unsigned getSize() const
Returns the size of the content encapsulated by this ContentCache.
llvm::MemoryBuffer::BufferKind getMemoryBufferKind() const
Returns the kind of memory used to back the memory buffer for this content cache.
unsigned IsFileVolatile
True if this content cache was initially created for a source file considered to be volatile (likely ...
LineOffsetMapping SourceLineCache
A bump pointer allocated array of offsets for each source line.
std::optional< llvm::MemoryBufferRef > getBufferOrNone(DiagnosticsEngine &Diag, FileManager &FM, SourceLocation Loc=SourceLocation()) const
Returns the memory buffer for the associated content.
static const char * getInvalidBOM(StringRef BufStr)
std::optional< llvm::MemoryBufferRef > getBufferIfLoaded() const
Return the buffer, only if it has been loaded.
unsigned BufferOverridden
Indicates whether the buffer itself was provided to override the actual file contents.
ContentCache(const ContentCache &RHS)
The copy ctor does not allow copies where source object has either a non-NULL Buffer or SourceLineCac...
ContentCache & operator=(const ContentCache &RHS)=delete
Each ExpansionInfo encodes the expansion location - where the token was ultimately expanded,...
SourceLocation getExpansionLocStart() const
static ExpansionInfo create(SourceLocation SpellingLoc, SourceLocation Start, SourceLocation End, bool ExpansionIsTokenRange=true)
Return a ExpansionInfo for an expansion.
bool isMacroBodyExpansion() const
bool isExpansionTokenRange() const
bool isFunctionMacroExpansion() const
SourceLocation getSpellingLoc() const
CharSourceRange getExpansionLocRange() const
bool isMacroArgExpansion() const
static ExpansionInfo createForMacroArg(SourceLocation SpellingLoc, SourceLocation ExpansionLoc)
Return a special ExpansionInfo for the expansion of a macro argument into a function-like macro's bod...
static ExpansionInfo createForTokenSplit(SourceLocation SpellingLoc, SourceLocation Start, SourceLocation End)
Return a special ExpansionInfo representing a token that ends prematurely.
SourceLocation getExpansionLocEnd() const
Information about a FileID, basically just the logical file that it represents and include stack info...
const ContentCache & getContentCache() const
CharacteristicKind getFileCharacteristic() const
Return whether this is a system header or not.
static FileInfo get(SourceLocation IL, ContentCache &Con, CharacteristicKind FileCharacter, StringRef Filename)
Return a FileInfo object.
bool hasLineDirectives() const
Return true if this FileID has #line directives in it.
void setHasLineDirectives()
Set the flag that indicates that this FileID has line table entries associated with it.
SourceLocation getIncludeLoc() const
StringRef getName() const
Returns the name of the file that was used when the file was loaded from the underlying file system.
Mapping of line offsets into a source file.
const unsigned * begin() const
LineOffsetMapping()=default
const unsigned * end() const
const unsigned & operator[](int I) const
static LineOffsetMapping get(llvm::MemoryBufferRef Buffer, llvm::BumpPtrAllocator &Alloc)
ArrayRef< unsigned > getLines() const
This is a discriminated union of FileInfo and ExpansionInfo.
SourceLocation::UIntTy getOffset() const
static SLocEntry get(SourceLocation::UIntTy Offset, const FileInfo &FI)
const FileInfo & getFile() const
static SLocEntry get(SourceLocation::UIntTy Offset, const ExpansionInfo &Expansion)
const ExpansionInfo & getExpansion() const
CharacteristicKind
Indicates whether a file or directory holds normal user code, system code, or system code which is im...
bool isSystem(CharacteristicKind CK)
Determine whether a file / directory characteristic is for system code.
bool isModuleMap(CharacteristicKind CK)
Determine whether a file characteristic is for a module map.
const size_t malloc_bytes
MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes)