15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- SourceManager.h - Track and cache source files ---------*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// 102f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \file 112f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// \brief Defines the SourceManager interface. 1212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// 1349d7111bd42e38fb5f1d7ec5474b9f119e0d7b56James Dennett/// There are three different types of locations in a %file: a spelling 1412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// location, an expansion location, and a presumed location. 1512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// 1612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// Given an example of: 1712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// \code 1812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// #define min(x, y) x < y ? x : y 1912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// \endcode 2012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// 2112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// and then later on a use of min: 2212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// \code 232f7f5b1f5ff023cb8c4008ae53a12b09e3ea2622James Dennett/// #line 17 2412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// return min(a, b); 2512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// \endcode 2612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// 2712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// The expansion location is the line in the source code where the macro 2812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// was expanded (the return statement), the spelling location is the 2912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// location in the source where the macro was originally defined, 3012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// and the presumed location is where the line directive states that 3112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// the line is 17, or any other line. 3212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 35176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines#ifndef LLVM_CLANG_BASIC_SOURCEMANAGER_H 36176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines#define LLVM_CLANG_BASIC_SOURCEMANAGER_H 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 38aa48fe80a1b2000809900a437f0819d929793002Jordan Rose#include "clang/Basic/FileManager.h" 3930a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "clang/Basic/LLVM.h" 405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 41830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor#include "llvm/ADT/ArrayRef.h" 4287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar#include "llvm/ADT/BitVector.h" 430d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner#include "llvm/ADT/DenseMap.h" 44d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis#include "llvm/ADT/DenseSet.h" 4530a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/IntrusiveRefCntPtr.h" 4630a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/PointerIntPair.h" 4730a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/ADT/PointerUnion.h" 486bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines#include "llvm/Support/AlignOf.h" 4930a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/Support/Allocator.h" 5030a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include "llvm/Support/DataTypes.h" 51f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek#include "llvm/Support/MemoryBuffer.h" 5230a2e16f6c27f888dd11eba6bbbae1e980078fcbChandler Carruth#include <cassert> 53d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis#include <map> 54651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines#include <memory> 555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <vector> 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 61099b4747042352f69184481a48508b599a8d3f73Ted Kremenekclass FileManager; 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 635b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattnerclass LineTableInfo; 64d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidisclass ASTWriter; 65d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidisclass ASTReader; 665330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 67c351d9837ea1d0b04842497e76c76125426a982cJames Dennett/// \brief Public enums and private classes that are part of the 680b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner/// SourceManager implementation. 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace SrcMgr { 71af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Indicates whether a file or directory holds normal user code, 72af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// system code, or system code which is implicitly 'extern "C"' in C++ mode. 73af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 74af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Entire directories can be tagged with this (this is maintained by 75af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// DirectoryLookup and friends) as can specific FileInfos when a \#pragma 76af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// system_header is seen or in various other cases. 770b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// 789d72851fec9e9c62570a027d42701562bbf29751Chris Lattner enum CharacteristicKind { 790b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner C_User, C_System, C_ExternCSystem 800b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner }; 811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief One instance of this struct is kept for every file loaded or used. 8349d7111bd42e38fb5f1d7ec5474b9f119e0d7b56James Dennett /// 84af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This object owns the MemoryBuffer object. 8558878f85ab89b13e9eea4af3ccf055e42c557bc8Pirama Arumuga Nainar class LLVM_ALIGNAS(8) ContentCache { 86f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor enum CCFlags { 87f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the buffer is invalid. 88f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor InvalidFlag = 0x01, 89f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the buffer should not be freed on destruction. 90f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor DoNotFreeFlag = 0x02 91f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor }; 925330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 9312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief The actual buffer containing the characters from the input 9412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// file. 9512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 9612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This is owned by the ContentCache object. The bits indicate 9712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// whether the buffer is invalid. 98c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines mutable llvm::PointerIntPair<llvm::MemoryBuffer *, 2> Buffer; 99c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek 100c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek public: 10112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Reference to the file entry representing this ContentCache. 10212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 103b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// This reference does not own the FileEntry object. 104af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 105af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// It is possible for this to be NULL if the ContentCache encapsulates 106af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// an imaginary text buffer. 107b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *OrigEntry; 108b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 109b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \brief References the file which the contents were actually loaded from. 11012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 111b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// Can be different from 'Entry' if we overridden the contents of one file 112b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// with the contents of another file. 113b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *ContentsEntry; 1141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief A bump pointer allocated array of offsets for each source line. 11612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 11712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This is lazily computed. This is owned by the SourceManager 11812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// BumpPointerAllocator object. 11905816591ec488a933dfecc9ff9f3cbf3c32767c2Chris Lattner unsigned *SourceLineCache; 1201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief The number of lines in this ContentCache. 12212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 12312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This is only valid if SourceLineCache is non-null. 12487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar unsigned NumLines; 12510b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis 126a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// \brief Indicates whether the buffer itself was provided to override 127a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// the actual file contents. 128a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// 129a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// When true, the original entry may be a virtual file that does not 130a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// exist. 131a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor unsigned BufferOverridden : 1; 132ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis 133ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// \brief True if this content cache was initially created for a source 134ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// file considered as a system one. 135ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis unsigned IsSystemFile : 1; 13658878f85ab89b13e9eea4af3ccf055e42c557bc8Pirama Arumuga Nainar 13787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief True if this file may be transient, that is, if it might not 13887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// exist at some later point in time when this content entry is used, 13987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// after serialization and deserialization. 14087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar unsigned IsTransient : 1; 14187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 14258878f85ab89b13e9eea4af3ccf055e42c557bc8Pirama Arumuga Nainar ContentCache(const FileEntry *Ent = nullptr) : ContentCache(Ent, Ent) {} 14358878f85ab89b13e9eea4af3ccf055e42c557bc8Pirama Arumuga Nainar 1447955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor ContentCache(const FileEntry *Ent, const FileEntry *contentEnt) 1456bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines : Buffer(nullptr, false), OrigEntry(Ent), ContentsEntry(contentEnt), 1466bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SourceLineCache(nullptr), NumLines(0), BufferOverridden(false), 14787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar IsSystemFile(false), IsTransient(false) {} 1487955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor 1497955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor ~ContentCache(); 1507955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor 1517955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor /// The copy ctor does not allow copies where source object has either 15212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// a non-NULL Buffer or SourceLineCache. Ownership of allocated memory 15312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// is not transferred, so this is a logical error. 1547955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor ContentCache(const ContentCache &RHS) 1556bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines : Buffer(nullptr, false), SourceLineCache(nullptr), 15687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar BufferOverridden(false), IsSystemFile(false), IsTransient(false) { 1577955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor OrigEntry = RHS.OrigEntry; 1587955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor ContentsEntry = RHS.ContentsEntry; 1596bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 1606bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines assert(RHS.Buffer.getPointer() == nullptr && 1616bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines RHS.SourceLineCache == nullptr && 1626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines "Passed ContentCache object cannot own a buffer."); 1636bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 1647955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor NumLines = RHS.NumLines; 1657955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor } 1667955a25c65b3c3213a5e9375f51a02a765a3c880Douglas Gregor 16712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the memory buffer for the associated content. 16836c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// 169a92d7e7a55a35b28437103130904a6401bf35408Jonathan D. Turner /// \param Diag Object through which diagnostics will be emitted if the 17012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// buffer cannot be retrieved. 1715330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher /// 172e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// \param Loc If specified, is the location that invalid file diagnostics 17312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// will be emitted at. 174e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// 17536c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error occurred. 176c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines llvm::MemoryBuffer *getBuffer(DiagnosticsEngine &Diag, 177c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines const SourceManager &SM, 178c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines SourceLocation Loc = SourceLocation(), 179c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines bool *Invalid = nullptr) const; 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the size of the content encapsulated by this 18212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// ContentCache. 18312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 18412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This can be the size of the source file or the size of an 18512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// arbitrary scratch buffer. If the ContentCache encapsulates a source 18612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// file this size is retrieved from the file's FileEntry. 187c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek unsigned getSize() const; 1881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 18912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the number of bytes actually mapped for this 19012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// ContentCache. 19112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 19212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This can be 0 if the MemBuffer was not actually expanded. 193c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek unsigned getSizeBytesMapped() const; 1945330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 195f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// Returns the kind of memory used to back the memory buffer for 196f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// this content cache. This is used for performance analysis. 197f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek llvm::MemoryBuffer::BufferKind getMemoryBufferKind() const; 1981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 199176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines void setBuffer(std::unique_ptr<llvm::MemoryBuffer> B) { 200c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor assert(!Buffer.getPointer() && "MemoryBuffer already set."); 201176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines Buffer.setPointer(B.release()); 202176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines Buffer.setInt(0); 203c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek } 2045330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 205cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Get the underlying buffer, returning NULL if the buffer is not 206cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// yet available. 207c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines llvm::MemoryBuffer *getRawBuffer() const { return Buffer.getPointer(); } 2081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2092968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Replace the existing buffer (which will be deleted) 2102968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// with the given buffer. 211c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines void replaceBuffer(llvm::MemoryBuffer *B, bool DoNotFree = false); 2122968442603b029949246467253eeac8139a5b6d8Douglas Gregor 213f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Determine whether the buffer itself is invalid. 214f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool isBufferInvalid() const { 215f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor return Buffer.getInt() & InvalidFlag; 216f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 2175330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 218f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Determine whether the buffer should be freed. 219f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool shouldFreeBuffer() const { 220f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor return (Buffer.getInt() & DoNotFreeFlag) == 0; 221f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 2225330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 2230d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek private: 2240d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek // Disable assignments. 2250e2c34f92f00628d48968dfea096d36381f494cbStephen Hines ContentCache &operator=(const ContentCache& RHS) = delete; 2261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2286bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines // Assert that the \c ContentCache objects will always be 8-byte aligned so 2296bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines // that we can pack 3 bits of integer into pointers to such objects. 2306bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines static_assert(llvm::AlignOf<ContentCache>::Alignment >= 8, 2316bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines "ContentCache must be 8-byte aligned."); 2326bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines 23312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Information about a FileID, basically just the logical file 234de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// that it represents and include stack information. 2355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 236de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// Each FileInfo has include stack information, indicating where it came 237c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// from. This information encodes the \#include chain that a token was 2383201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expanded from. The main include file has an invalid IncludeLoc. 2395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 240de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// FileInfos contain a "ContentCache *", with the contents of the file. 2415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 242de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner class FileInfo { 24312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief The location of the \#include that brought in this file. 24412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 245c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// This is an invalid SLOC for the main file (top of the \#include chain). 246de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned IncludeLoc; // Really a SourceLocation 2471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 248d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Number of FileIDs (files and macros) that were created during 249c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// preprocessing of this \#include, including this SLocEntry. 25012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 251d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// Zero means the preprocessor didn't provide such info for this SLocEntry. 252d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis unsigned NumCreatedFIDs; 253d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 254c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \brief Contains the ContentCache* and the bits indicating the 255c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// characteristic of the file and whether it has \#line info, all 256c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// bitmangled together. 2576e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner uintptr_t Data; 258d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 25921032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::SourceManager; 26021032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::ASTWriter; 26121032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::ASTReader; 26278d85f53b093867bbb0123f016956178eea7343eTed Kremenek public: 26312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return a FileInfo object. 264de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileInfo get(SourceLocation IL, const ContentCache *Con, 265de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner CharacteristicKind FileCharacter) { 266de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileInfo X; 267de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner X.IncludeLoc = IL.getRawEncoding(); 268d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis X.NumCreatedFIDs = 0; 2696e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner X.Data = (uintptr_t)Con; 27000282d6e1194655a2e89f940bd6fa8484b52e666Chris Lattner assert((X.Data & 7) == 0 &&"ContentCache pointer insufficiently aligned"); 2716e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner assert((unsigned)FileCharacter < 4 && "invalid file character"); 2726e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner X.Data |= (unsigned)FileCharacter; 2735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 2745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 276de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getIncludeLoc() const { 277de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFromRawEncoding(IncludeLoc); 278de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 2796e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner const ContentCache* getContentCache() const { 280a5bec298d96f7eb5309df5aab9d19eb7f8b75a81Michael J. Spencer return reinterpret_cast<const ContentCache*>(Data & ~uintptr_t(7)); 2816e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner } 2821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 283c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \brief Return whether this is a system header or not. 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump CharacteristicKind getFileCharacteristic() const { 2856e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner return (CharacteristicKind)(Data & 3); 2860b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner } 287ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner 288c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \brief Return true if this FileID has \#line directives in it. 289ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner bool hasLineDirectives() const { return (Data & 4) != 0; } 2901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 291c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \brief Set the flag that indicates that this FileID has 292ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// line table entries associated with it. 293ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner void setHasLineDirectives() { 294ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner Data |= 4; 295ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner } 2969dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner }; 2971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Each ExpansionInfo encodes the expansion location - where 29978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// the token was ultimately expanded, and the SpellingLoc - where the actual 30078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// character data for the token came from. 30178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth class ExpansionInfo { 30278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // Really these are all SourceLocations. 3031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 304af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Where the spelling for the token can be found. 305e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner unsigned SpellingLoc; 3061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 307af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// In a macro expansion, ExpansionLocStart and ExpansionLocEnd 30878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// indicate the start and end of the expansion. In object-like macros, 309af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// they will be the same. In a function-like macro expansion, the start 3103201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// will be the identifier and the end will be the ')'. Finally, in 31112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// macro-argument instantiations, the end will be 'SourceLocation()', an 312c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// invalid location. 31378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth unsigned ExpansionLocStart, ExpansionLocEnd; 314c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 3159dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner public: 316de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getSpellingLoc() const { 317de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFromRawEncoding(SpellingLoc); 318de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 31978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation getExpansionLocStart() const { 32078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return SourceLocation::getFromRawEncoding(ExpansionLocStart); 321e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 32278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation getExpansionLocEnd() const { 323c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth SourceLocation EndLoc = 32478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation::getFromRawEncoding(ExpansionLocEnd); 32578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return EndLoc.isInvalid() ? getExpansionLocStart() : EndLoc; 326e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 3271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth std::pair<SourceLocation,SourceLocation> getExpansionLocRange() const { 32978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return std::make_pair(getExpansionLocStart(), getExpansionLocEnd()); 330e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 3311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 33296d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth bool isMacroArgExpansion() const { 333c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth // Note that this needs to return false for default constructed objects. 33478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return getExpansionLocStart().isValid() && 33578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation::getFromRawEncoding(ExpansionLocEnd).isInvalid(); 336c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth } 337c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 338c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay bool isMacroBodyExpansion() const { 339c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay return getExpansionLocStart().isValid() && 340c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay SourceLocation::getFromRawEncoding(ExpansionLocEnd).isValid(); 341c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay } 342c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay 343cee5ec9df479994e4ba27fb65b7ded5bb5a980ebArgyrios Kyrtzidis bool isFunctionMacroExpansion() const { 344cee5ec9df479994e4ba27fb65b7ded5bb5a980ebArgyrios Kyrtzidis return getExpansionLocStart().isValid() && 345cee5ec9df479994e4ba27fb65b7ded5bb5a980ebArgyrios Kyrtzidis getExpansionLocStart() != getExpansionLocEnd(); 346cee5ec9df479994e4ba27fb65b7ded5bb5a980ebArgyrios Kyrtzidis } 347cee5ec9df479994e4ba27fb65b7ded5bb5a980ebArgyrios Kyrtzidis 34812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return a ExpansionInfo for an expansion. 34912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 35012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// Start and End specify the expansion range (where the macro is 35112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// expanded), and SpellingLoc specifies the spelling location (where 35212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// the characters from the token come from). All three can refer to 35312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// normal File SLocs or expansion locations. 35478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static ExpansionInfo create(SourceLocation SpellingLoc, 35578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation Start, SourceLocation End) { 35678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth ExpansionInfo X; 35778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.SpellingLoc = SpellingLoc.getRawEncoding(); 35878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.ExpansionLocStart = Start.getRawEncoding(); 35978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.ExpansionLocEnd = End.getRawEncoding(); 3609dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return X; 3615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 362c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 36312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return a special ExpansionInfo for the expansion of 36412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// a macro argument into a function-like macro's body. 36512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 36612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// ExpansionLoc specifies the expansion location (where the macro is 36712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// expanded). This doesn't need to be a range because a macro is always 36812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// expanded at a macro parameter reference, and macro parameters are 36912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// always exactly one token. SpellingLoc specifies the spelling location 37012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// (where the characters from the token come from). ExpansionLoc and 37112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// SpellingLoc can both refer to normal File SLocs or expansion locations. 372c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// 373c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// Given the code: 374c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// \code 375af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// #define F(x) f(x) 376c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// F(42); 377c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// \endcode 378c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// 37978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// When expanding '\c F(42)', the '\c x' would call this with an 380af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// SpellingLoc pointing at '\c 42' and an ExpansionLoc pointing at its 38178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// location in the definition of '\c F'. 38278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static ExpansionInfo createForMacroArg(SourceLocation SpellingLoc, 38378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation ExpansionLoc) { 384c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth // We store an intentionally invalid source location for the end of the 38578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // expansion range to mark that this is a macro argument ion rather than 38678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // a normal one. 38778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return create(SpellingLoc, ExpansionLoc, SourceLocation()); 388c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth } 389de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner }; 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 39112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief This is a discriminated union of FileInfo and ExpansionInfo. 39212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 39312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// SourceManager keeps an array of these objects, and they are uniquely 39412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// identified by the FileID datatype. 395de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner class SLocEntry { 39687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar unsigned Offset : 31; 39787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar unsigned IsExpansion : 1; 398de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner union { 399de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileInfo File; 4001728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth ExpansionInfo Expansion; 401de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner }; 402de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner public: 40387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar unsigned getOffset() const { return Offset; } 4041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar bool isExpansion() const { return IsExpansion; } 4061728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth bool isFile() const { return !isExpansion(); } 4071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 408de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const FileInfo &getFile() const { 409de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert(isFile() && "Not a file SLocEntry!"); 410de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return File; 411de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 412de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 4131728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth const ExpansionInfo &getExpansion() const { 4141728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth assert(isExpansion() && "Not a macro expansion SLocEntry!"); 4151728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth return Expansion; 416de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 4171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 418de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SLocEntry get(unsigned Offset, const FileInfo &FI) { 41987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar assert(!(Offset & (1 << 31)) && "Offset is too large"); 420de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SLocEntry E; 42187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar E.Offset = Offset; 42287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar E.IsExpansion = false; 423de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner E.File = FI; 424de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return E; 425de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 426de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 42778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static SLocEntry get(unsigned Offset, const ExpansionInfo &Expansion) { 42887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar assert(!(Offset & (1 << 31)) && "Offset is too large"); 429de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SLocEntry E; 43087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar E.Offset = Offset; 43187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar E.IsExpansion = true; 4321728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth E.Expansion = Expansion; 433de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return E; 434de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 4355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 4365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end SrcMgr namespace. 4377f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 4387f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor/// \brief External source of source location entries. 4397f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregorclass ExternalSLocEntrySource { 4407f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregorpublic: 4417f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor virtual ~ExternalSLocEntrySource(); 4427f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 443f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Read the source location entry with index ID, which will always be 444f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// less than -1. 445e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// 446e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// \returns true if an error occurred that prevented the source-location 447e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// entry from being loaded. 448f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor virtual bool ReadSLocEntry(int ID) = 0; 4496c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor 4506c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor /// \brief Retrieve the module import location and name for the given ID, if 4516c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor /// in fact it was loaded from a module (rather than, say, a precompiled 4526c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor /// header). 4536c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor virtual std::pair<SourceLocation, StringRef> getModuleImportLoc(int ID) = 0; 4547f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor}; 4555330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 456dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 45712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// \brief Holds the cache used by isBeforeInTranslationUnit. 45812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// 45912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// The cache structure is complex enough to be worth breaking out of 46012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett/// SourceManager. 4612564f811ba107cb314a594d730aa3357b6181b62Ted Kremenekclass InBeforeInTUCacheEntry { 462af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The FileID's of the cached query. 463af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 464af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If these match up with a subsequent query, the result can be reused. 465dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner FileID LQueryFID, RQueryFID; 46637e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 467af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief True if LQueryFID was created before RQueryFID. 468af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 469af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is used to compare macro expansion locations. 47037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis bool IsLQFIDBeforeRQFID; 47137e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 47212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief The file found in common between the two \#include traces, i.e., 47312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// the nearest common ancestor of the \#include tree. 474dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner FileID CommonFID; 4755330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 476af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief The offset of the previous query in CommonFID. 477af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 478c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// Usually, this represents the location of the \#include for QueryFID, but 479c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// if LQueryFID is a parent of RQueryFID (or vice versa) then these can be a 480dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// random token in the parent. 481dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner unsigned LCommonOffset, RCommonOffset; 482dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattnerpublic: 48312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return true if the currently cached values match up with 484af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// the specified LHS/RHS query. 485af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 486af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// If not, we can't use the cache. 487dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner bool isCacheValid(FileID LHS, FileID RHS) const { 488dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner return LQueryFID == LHS && RQueryFID == RHS; 489dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 4905330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 49112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief If the cache is valid, compute the result given the 492af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// specified offsets in the LHS/RHS FileID's. 493dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner bool getCachedResult(unsigned LOffset, unsigned ROffset) const { 494dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // If one of the query files is the common file, use the offset. Otherwise, 495dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // use the #include loc in the common file. 496dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner if (LQueryFID != CommonFID) LOffset = LCommonOffset; 497dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner if (RQueryFID != CommonFID) ROffset = RCommonOffset; 49837e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 49937e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis // It is common for multiple macro expansions to be "included" from the same 50037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis // location (expansion location), in which case use the order of the FileIDs 5014d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis // to determine which came first. This will also take care the case where 5024d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis // one of the locations points at the inclusion/expansion point of the other 5034d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis // in which case its FileID will come before the other. 504d7711ec430fde5706f85ba6c4b85283a8e743ff7Argyrios Kyrtzidis if (LOffset == ROffset) 50537e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis return IsLQFIDBeforeRQFID; 50637e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 507dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner return LOffset < ROffset; 508dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 5095330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 510af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Set up a new query. 51137e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis void setQueryFIDs(FileID LHS, FileID RHS, bool isLFIDBeforeRFID) { 51237e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis assert(LHS != RHS); 513dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner LQueryFID = LHS; 514dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner RQueryFID = RHS; 51537e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis IsLQFIDBeforeRQFID = isLFIDBeforeRFID; 51637e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis } 51737e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 51837e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis void clear() { 51937e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis LQueryFID = RQueryFID = FileID(); 52037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis IsLQFIDBeforeRQFID = false; 521dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 5225330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 523dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner void setCommonLoc(FileID commonFID, unsigned lCommonOffset, 524dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner unsigned rCommonOffset) { 525dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner CommonFID = commonFID; 526dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner LCommonOffset = lCommonOffset; 527dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner RCommonOffset = rCommonOffset; 528dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 5295330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 530dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner}; 5317f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 5324565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor/// \brief The stack used when building modules on demand, which is used 533830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor/// to provide a link between the source managers of the different compiler 534830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor/// instances. 535cfa88f893915ceb8ae4ce2f17c46c24a4d67502fDmitri Gribenkotypedef ArrayRef<std::pair<std::string, FullSourceLoc> > ModuleBuildStack; 536830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor 537f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// \brief This class handles loading and caching of source files into memory. 538f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// 539f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// This object owns the MemoryBuffer objects for all of the loaded 540c351d9837ea1d0b04842497e76c76125426a982cJames Dennett/// files and assigns unique FileID's for each unique \#include chain. 5415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 5425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// The SourceManager can be queried for information about SourceLocation 5433201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// objects, turning them into either spelling or expansion locations. Spelling 5443201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// locations represent where the bytes corresponding to a token came from and 5453201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// expansion locations represent where the location is in the user's view. In 5463201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// the case of a macro expansion, for example, the spelling location indicates 5473201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// where the expanded token came from and the expansion location specifies 5483201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// where it was expanded. 549c93dc7889644293e318e19d82830ea2acc45b678Dylan Noblesmithclass SourceManager : public RefCountedBase<SourceManager> { 550d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief DiagnosticsEngine object. 551d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag; 552389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 553389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileManager &FileMgr; 554389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 5550d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner mutable llvm::BumpPtrAllocator ContentCacheAlloc; 5561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 55712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Memoized information about all of the files tracked by this 55812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// SourceManager. 55912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 56012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This map allows us to merge ContentCache entries based 5610d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// on their FileEntry*. All ContentCache objects will thus have unique, 5621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// non-null, FileEntry pointers. 5630d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> FileInfos; 5641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 565176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// \brief True if the ContentCache for files that are overridden by other 566299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// files, should report the original file name. Defaults to true. 567299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool OverridenFilesKeepOriginalName; 568299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis 569ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// \brief True if non-system source files should be treated as volatile 570ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// (likely to change while trying to use them). Defaults to false. 571ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile; 572ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis 57387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief True if all files read during this compilation should be treated 57487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// as transient (may not be present in later compilations using a module 57587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// file created from this compilation). Defaults to false. 57687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar bool FilesAreTransient; 57787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 578d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis struct OverriddenFilesInfoTy { 579176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// \brief Files that have been overridden with the contents from another 580d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis /// file. 581d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis llvm::DenseMap<const FileEntry *, const FileEntry *> OverriddenFiles; 582d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis /// \brief Files that were overridden with a memory buffer. 583d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis llvm::DenseSet<const FileEntry *> OverriddenFilesWithBuffer; 584d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis }; 585d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis 586d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis /// \brief Lazily create the object keeping overridden files info, since 587d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis /// it is uncommonly used. 588651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines std::unique_ptr<OverriddenFilesInfoTy> OverriddenFilesInfo; 589b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 590d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis OverriddenFilesInfoTy &getOverriddenFilesInfo() { 591d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis if (!OverriddenFilesInfo) 592d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis OverriddenFilesInfo.reset(new OverriddenFilesInfoTy); 593d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis return *OverriddenFilesInfo; 594d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis } 59512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett 59612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Information about various memory buffers that we have read in. 59712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 59812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// All FileEntry* within the stored ContentCache objects are NULL, 5990d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// as they do not refer to a file. 6000d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner std::vector<SrcMgr::ContentCache*> MemBufferInfos; 6011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 602f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The table of SLocEntries that are local to this module. 603f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 604f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Positive FileIDs are indexes into this table. Entry 0 indicates an invalid 6053201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expansion. 606f512acee01617c9da8079ed88ded3bb9f2418349Benjamin Kramer SmallVector<SrcMgr::SLocEntry, 0> LocalSLocEntryTable; 607f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 608f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The table of SLocEntries that are loaded from other modules. 609f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 610f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Negative FileIDs are indexes into this table. To get from ID to an index, 611f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// use (-ID - 2). 612f512acee01617c9da8079ed88ded3bb9f2418349Benjamin Kramer mutable SmallVector<SrcMgr::SLocEntry, 0> LoadedSLocEntryTable; 6137f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 614f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The starting offset of the next local SLocEntry. 615f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 616f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// This is LocalSLocEntryTable.back().Offset + the size of that entry. 617f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned NextLocalOffset; 618f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 619f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The starting offset of the latest batch of loaded SLocEntries. 620f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 621f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// This is LoadedSLocEntryTable.back().Offset, except that that entry might 622f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// not have been loaded, so that value would be unknown. 623f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned CurrentLoadedOffset; 624f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 625ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// \brief The highest possible offset is 2^31-1, so CurrentLoadedOffset 626ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// starts at 2^31. 627ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis static const unsigned MaxLoadedOffset = 1U << 31U; 628ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis 629f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief A bitmap that indicates whether the entries of LoadedSLocEntryTable 630f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// have already been loaded from the external source. 631f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 632f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Same indexing as LoadedSLocEntryTable. 63387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar llvm::BitVector SLocEntryLoaded; 6347f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 6357f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor /// \brief An external source for source location entries. 6367f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor ExternalSLocEntrySource *ExternalSLocEntries; 6377f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 63812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief A one-entry cache to speed up getFileID. 639c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// 640de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// LastFileIDLookup records the last FileID looked up or created, because it 641de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// is very common to look up many tokens from the same file. 642de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner mutable FileID LastFileIDLookup; 6431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 644c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \brief Holds information for \#line directives. 645c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// 646af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This is referenced by indices from SLocEntryTable. 6475b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner LineTableInfo *LineTable; 6481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 64912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief These ivars serve as a cache used in the getLineNumber 6505e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner /// method which is used to speedup getLineNumber calls to nearby locations. 6512b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner mutable FileID LastLineNoFileIDQuery; 652f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable SrcMgr::ContentCache *LastLineNoContentCache; 653f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable unsigned LastLineNoFilePos; 654f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable unsigned LastLineNoResult; 6551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 656c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \brief The file ID for the main source file of the translation unit. 6572b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID MainFileID; 65849c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff 659507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief The file ID for the precompiled preamble there is one. 660507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis FileID PreambleFileID; 661507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 662de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // Statistics for -print-stats. 663de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner mutable unsigned NumLinearScans, NumBinaryProbes; 6641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 665ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis /// \brief Associates a FileID with its "included/expanded in" decomposed 666ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis /// location. 667ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis /// 668ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis /// Used to cache results from and speed-up \c getDecomposedIncludedLoc 669ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis /// function. 670ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis mutable llvm::DenseMap<FileID, std::pair<FileID, unsigned> > IncludedLocMap; 671ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis 6722564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek /// The key value into the IsBeforeInTUCache table. 6732564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek typedef std::pair<FileID, FileID> IsBeforeInTUCacheKey; 6742564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek 6752564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek /// The IsBeforeInTranslationUnitCache is a mapping from FileID pairs 6762564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek /// to cache results. 6772564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek typedef llvm::DenseMap<IsBeforeInTUCacheKey, InBeforeInTUCacheEntry> 6782564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek InBeforeInTUCache; 6792564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek 6802564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek /// Cache results for the isBeforeInTranslationUnit method. 6812564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek mutable InBeforeInTUCache IBTUCache; 6822564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek mutable InBeforeInTUCacheEntry IBTUCacheOverflow; 6832564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek 6842564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek /// Return the cache entry for comparing the given file IDs 6852564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek /// for isBeforeInTranslationUnit. 6862564f811ba107cb314a594d730aa3357b6181b62Ted Kremenek InBeforeInTUCacheEntry &getInBeforeInTUCache(FileID LFID, FileID RFID) const; 6871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 688e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor // Cache for the "fake" buffer used for error-recovery purposes. 689176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines mutable std::unique_ptr<llvm::MemoryBuffer> FakeBufferForRecovery; 6905330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 691176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines mutable std::unique_ptr<SrcMgr::ContentCache> FakeContentCacheForRecovery; 692a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis 693fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis /// \brief Lazily computed map of macro argument chunks to their expanded 694fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis /// source location. 695fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis typedef std::map<unsigned, SourceLocation> MacroArgsMap; 696fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis 69770042f5d1ca378138f90b7b9384023701f5d03d8David Blaikie mutable llvm::DenseMap<FileID, MacroArgsMap *> MacroArgsCacheMap; 698fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis 6994565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor /// \brief The stack of modules being built, which is used to detect 700830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor /// cycles in the module dependency graph as modules are being built, as 7014565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor /// well as to describe why we're rebuilding a particular module. 702830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor /// 703830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor /// There is no way to set this value from the command line. If we ever need 704830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor /// to do so (e.g., if on-demand module construction moves out-of-process), 705830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor /// we can add a cc1-level option to do so. 7064565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor SmallVector<std::pair<std::string, FullSourceLoc>, 2> StoredModuleBuildStack; 707830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor 70849c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff // SourceManager doesn't support copy construction. 7090e2c34f92f00628d48968dfea096d36381f494cbStephen Hines explicit SourceManager(const SourceManager&) = delete; 7100e2c34f92f00628d48968dfea096d36381f494cbStephen Hines void operator=(const SourceManager&) = delete; 7115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 712ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr, 713ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool UserFilesAreVolatile = false); 7145b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner ~SourceManager(); 7151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7165b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner void clearIDTables(); 7171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 718d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() const { return Diag; } 71978a916ec5ff5b66adec3c499e1b9af7b87668309Argyrios Kyrtzidis 720389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileManager &getFileManager() const { return FileMgr; } 721389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 722299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// \brief Set true if the SourceManager should report the original file name 723176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// for contents of files that were overridden by other files. Defaults to 724176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// true. 725299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis void setOverridenFilesKeepOriginalName(bool value) { 726299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis OverridenFilesKeepOriginalName = value; 727299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis } 728299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis 729ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// \brief True if non-system source files should be treated as volatile 730ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /// (likely to change while trying to use them). 731ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool userFilesAreVolatile() const { return UserFilesAreVolatile; } 732ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis 7334565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor /// \brief Retrieve the module build stack. 7344565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor ModuleBuildStack getModuleBuildStack() const { 7354565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor return StoredModuleBuildStack; 736830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor } 737830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor 7384565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor /// \brief Set the module build stack. 7394565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor void setModuleBuildStack(ModuleBuildStack stack) { 7404565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor StoredModuleBuildStack.clear(); 7414565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor StoredModuleBuildStack.append(stack.begin(), stack.end()); 742830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor } 743830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor 7444565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor /// \brief Push an entry to the module build stack. 7454565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor void pushModuleBuildStack(StringRef moduleName, FullSourceLoc importLoc) { 7464565e487531c7bf6d348dbe9f5529784966fc7aeDouglas Gregor StoredModuleBuildStack.push_back(std::make_pair(moduleName.str(),importLoc)); 747830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor } 748830ea5b7c75413526c19531f0180fa6e45b98919Douglas Gregor 74906a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 75006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // MainFileID creation and querying methods. 75106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 75206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner 75312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the FileID of the main source file. 7542b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID getMainFileID() const { return MainFileID; } 7551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 756b8c879a5363f36bdae8831112b563333e3c05acbArgyrios Kyrtzidis /// \brief Set the file ID for the main source file. 757b8c879a5363f36bdae8831112b563333e3c05acbArgyrios Kyrtzidis void setMainFileID(FileID FID) { 758b8c879a5363f36bdae8831112b563333e3c05acbArgyrios Kyrtzidis MainFileID = FID; 759b8c879a5363f36bdae8831112b563333e3c05acbArgyrios Kyrtzidis } 760b8c879a5363f36bdae8831112b563333e3c05acbArgyrios Kyrtzidis 761507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Set the file ID for the precompiled preamble. 762507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void setPreambleFileID(FileID Preamble) { 763507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis assert(PreambleFileID.isInvalid() && "PreambleFileID already set!"); 764507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleFileID = Preamble; 765414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor } 7665330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 767507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the file ID for the precompiled preamble if there is one. 768507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis FileID getPreambleFileID() const { return PreambleFileID; } 769507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 77006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 7713201f382956ed9beee9fb31229c2835c1208889cChandler Carruth // Methods to create new FileID's and macro expansions. 77206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 7731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Create a new FileID that represents the specified file 77512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// being \#included from the specified IncludePosition. 77612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 77712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This translates NULL into standard input. 7782b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos, 7797f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor SrcMgr::CharacteristicKind FileCharacter, 780f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor int LoadedID = 0, unsigned LoadedOffset = 0) { 781ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis const SrcMgr::ContentCache * 782ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis IR = getOrCreateContentCache(SourceFile, 783ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis /*isSystemFile=*/FileCharacter != SrcMgr::C_User); 7840d06e998910934e5ef070f53f4c272e7c6b846c6Dan Gohman assert(IR && "getOrCreateContentCache() cannot return NULL"); 785f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return createFileID(IR, IncludePos, FileCharacter, LoadedID, LoadedOffset); 7865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 7871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Create a new FileID that represents the specified memory buffer. 78912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 79012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This does no caching of the buffer and takes ownership of the 79112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// MemoryBuffer, so only pass a MemoryBuffer to this once. 792176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines FileID createFileID(std::unique_ptr<llvm::MemoryBuffer> Buffer, 793ecd27bf256c92f56c7c7ede6f40ec5d31a40b35eArgyrios Kyrtzidis SrcMgr::CharacteristicKind FileCharacter = SrcMgr::C_User, 7946bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines int LoadedID = 0, unsigned LoadedOffset = 0, 7956bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SourceLocation IncludeLoc = SourceLocation()) { 796176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines return createFileID(createMemBufferContentCache(std::move(Buffer)), 797176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines IncludeLoc, FileCharacter, LoadedID, LoadedOffset); 7981036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek } 79906a062dc784c609b75dca15fd97f468d0d846596Chris Lattner 8004967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// \brief Get the FileID for \p SourceFile if it exists. Otherwise, create a 8014967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar /// new FileID for the \p SourceFile. 8024967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar FileID getOrCreateFileID(const FileEntry *SourceFile, 8034967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar SrcMgr::CharacteristicKind FileCharacter) { 8044967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar FileID ID = translateFile(SourceFile); 8054967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar return ID.isValid() ? ID : createFileID(SourceFile, SourceLocation(), 8064967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar FileCharacter); 8074967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar } 8084967a710c84587c654b56c828382219c3937dacbPirama Arumuga Nainar 80912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return a new SourceLocation that encodes the 810bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// fact that a token from SpellingLoc should actually be referenced from 8113201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// ExpansionLoc, and that it represents the expansion of a macro argument 8123201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// into the function-like macro body. 813bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation createMacroArgExpansionLoc(SourceLocation Loc, 814bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLoc, 815bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength); 816c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 81712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return a new SourceLocation that encodes the fact 818c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// that a token from SpellingLoc should actually be referenced from 819bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// ExpansionLoc. 820bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation createExpansionLoc(SourceLocation Loc, 821bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLocStart, 822bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLocEnd, 823bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength, 824bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth int LoadedID = 0, 825bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned LoadedOffset = 0); 8261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8272968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Retrieve the memory buffer associated with the given file. 82850f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 82950f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error 83050f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// occurs while retrieving the memory buffer. 831c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines llvm::MemoryBuffer *getMemoryBufferForFile(const FileEntry *File, 832c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines bool *Invalid = nullptr); 8332968442603b029949246467253eeac8139a5b6d8Douglas Gregor 8342968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Override the contents of the given source file by providing an 8352968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// already-allocated buffer. 8362968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 837176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// \param SourceFile the source file whose contents will be overridden. 8382968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 8392968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Buffer the memory buffer whose contents will be used as the 8402968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// data in the given source file. 8412968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 842f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \param DoNotFree If true, then the buffer will not be freed when the 843f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// source manager is destroyed. 8440d06e998910934e5ef070f53f4c272e7c6b846c6Dan Gohman void overrideFileContents(const FileEntry *SourceFile, 845176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines llvm::MemoryBuffer *Buffer, bool DoNotFree); 846176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines void overrideFileContents(const FileEntry *SourceFile, 847176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines std::unique_ptr<llvm::MemoryBuffer> Buffer) { 848176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines overrideFileContents(SourceFile, Buffer.release(), /*DoNotFree*/ false); 849176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines } 8502968442603b029949246467253eeac8139a5b6d8Douglas Gregor 851bed28ac1d1463adca3ecf24fca5c30646fa9dbb2Sylvestre Ledru /// \brief Override the given source file with another one. 852b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// 853176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines /// \param SourceFile the source file which will be overridden. 854b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// 855b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \param NewFile the file whose contents will be used as the 856b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// data instead of the contents of the given source file. 857b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis void overrideFileContents(const FileEntry *SourceFile, 858b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *NewFile); 859b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 860d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis /// \brief Returns true if the file contents have been overridden. 861d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis bool isFileOverridden(const FileEntry *File) { 862d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis if (OverriddenFilesInfo) { 863d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis if (OverriddenFilesInfo->OverriddenFilesWithBuffer.count(File)) 864d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis return true; 865d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis if (OverriddenFilesInfo->OverriddenFiles.find(File) != 866d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis OverriddenFilesInfo->OverriddenFiles.end()) 867d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis return true; 868d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis } 869d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis return false; 870d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis } 871d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis 872d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis /// \brief Disable overridding the contents of a file, previously enabled 873af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// with #overrideFileContents. 87412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 875d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis /// This should be called before parsing has begun. 876d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis void disableFileContentsOverride(const FileEntry *File); 877d54dff026b02303a35147224de72bb44cbb53c79Argyrios Kyrtzidis 87887d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief Specify that a file is transient. 87987d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar void setFileIsTransient(const FileEntry *SourceFile); 88087d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 88187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \brief Specify that all files that are read during this compilation are 88287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// transient. 88387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar void setAllFilesAreTransient(bool Transient) { 88487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar FilesAreTransient = Transient; 88587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar } 88687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 88706a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 88806a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // FileID manipulation methods. 88906a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 8901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 89112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the buffer for the specified FileID. 89212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 89312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// If there is an error opening this buffer the first time, this 89412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// manufactures a temporary buffer and returns a non-empty error string. 895c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines llvm::MemoryBuffer *getBuffer(FileID FID, SourceLocation Loc, 896c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines bool *Invalid = nullptr) const { 897e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 898e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 899e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) { 900e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid) 901e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor *Invalid = true; 9025330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 903e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return getFakeBufferForRecovery(); 904e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor } 9055330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 9065330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher return Entry.getFile().getContentCache()->getBuffer(Diag, *this, Loc, 907e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor Invalid); 90806a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 9091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 910c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines llvm::MemoryBuffer *getBuffer(FileID FID, bool *Invalid = nullptr) const { 911e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 912e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 913e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) { 914e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid) 915e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor *Invalid = true; 9165330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 917e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return getFakeBufferForRecovery(); 918e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor } 919e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 9205330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher return Entry.getFile().getContentCache()->getBuffer(Diag, *this, 9215330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher SourceLocation(), 922e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor Invalid); 923e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner } 9245330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 92512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the FileEntry record for the provided FileID. 92606a062dc784c609b75dca15fd97f468d0d846596Chris Lattner const FileEntry *getFileEntryForID(FileID FID) const { 927e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 928e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 929e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) 9306bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 9315330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 93239afcafe1c0f66db67648b5230b700659448432cArgyrios Kyrtzidis const SrcMgr::ContentCache *Content = Entry.getFile().getContentCache(); 93339afcafe1c0f66db67648b5230b700659448432cArgyrios Kyrtzidis if (!Content) 9346bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 93539afcafe1c0f66db67648b5230b700659448432cArgyrios Kyrtzidis return Content->OrigEntry; 93606a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 9371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 93812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the FileEntry record for the provided SLocEntry. 9399d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek const FileEntry *getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const 9409d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek { 94139afcafe1c0f66db67648b5230b700659448432cArgyrios Kyrtzidis const SrcMgr::ContentCache *Content = sloc.getFile().getContentCache(); 94239afcafe1c0f66db67648b5230b700659448432cArgyrios Kyrtzidis if (!Content) 9436bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines return nullptr; 94439afcafe1c0f66db67648b5230b700659448432cArgyrios Kyrtzidis return Content->OrigEntry; 9459d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek } 9469d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek 94712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return a StringRef to the source buffer data for the 948ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// specified FileID. 949ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// 950f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor /// \param FID The file ID whose contents will be returned. 951f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor /// \param Invalid If non-NULL, will be set true if an error occurred. 9526bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines StringRef getBufferData(FileID FID, bool *Invalid = nullptr) const; 953f6ac97b101c8840efa92bf29166077ce4049e293Benjamin Kramer 954d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Get the number of FileIDs (files and macros) that were created 9552c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// during preprocessing of \p FID, including it. 956d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis unsigned getNumCreatedFIDsForFileID(FileID FID) const { 957d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 958d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 959d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 960d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return 0; 961d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 962d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return Entry.getFile().NumCreatedFIDs; 963d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 964d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 965d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Set the number of FileIDs (files and macros) that were created 9662c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// during preprocessing of \p FID, including it. 967d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs) const { 968d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 969d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 970d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 971d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return; 972d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 973d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis assert(Entry.getFile().NumCreatedFIDs == 0 && "Already set!"); 974d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const_cast<SrcMgr::FileInfo &>(Entry.getFile()).NumCreatedFIDs = NumFIDs; 975d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 9761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 97706a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 97806a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // SourceLocation manipulation methods. 97906a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 9801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 98112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the FileID for a SourceLocation. 98212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 98312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This is a very hot method that is used for all SourceManager queries 98412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// that start with a SourceLocation object. It is responsible for finding 98512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// the entry in SLocEntryTable which contains the specified location. 986de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// 987de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID getFileID(SourceLocation SpellingLoc) const { 988de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned SLocOffset = SpellingLoc.getOffset(); 9891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 990de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // If our one-entry cache covers this offset, just return it. 991de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (isOffsetInFileID(LastFileIDLookup, SLocOffset)) 992de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return LastFileIDLookup; 993de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 994de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getFileIDSlow(SLocOffset); 995de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 9961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 997aa48fe80a1b2000809900a437f0819d929793002Jordan Rose /// \brief Return the filename of the file containing a SourceLocation. 998aa48fe80a1b2000809900a437f0819d929793002Jordan Rose StringRef getFilename(SourceLocation SpellingLoc) const { 999aa48fe80a1b2000809900a437f0819d929793002Jordan Rose if (const FileEntry *F = getFileEntryForID(getFileID(SpellingLoc))) 1000aa48fe80a1b2000809900a437f0819d929793002Jordan Rose return F->getName(); 1001aa48fe80a1b2000809900a437f0819d929793002Jordan Rose return StringRef(); 1002aa48fe80a1b2000809900a437f0819d929793002Jordan Rose } 1003aa48fe80a1b2000809900a437f0819d929793002Jordan Rose 100412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the source location corresponding to the first byte of 100512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// the specified file. 10062b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation getLocForStartOfFile(FileID FID) const { 1007e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool Invalid = false; 1008e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 1009e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid || !Entry.isFile()) 1010e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return SourceLocation(); 10115330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1012e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor unsigned FileOffset = Entry.getOffset(); 1013de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFileLoc(FileOffset); 10142b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 1015f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 1016f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis /// \brief Return the source location corresponding to the last byte of the 1017f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis /// specified file. 1018f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getLocForEndOfFile(FileID FID) const { 1019f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool Invalid = false; 1020f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 1021f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 1022f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis return SourceLocation(); 1023f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 1024f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis unsigned FileOffset = Entry.getOffset(); 1025b18840ddd6aa472bbf78ab9de59159eb128fb6a9Argyrios Kyrtzidis return SourceLocation::getFileLoc(FileOffset + getFileIDSize(FID)); 1026f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis } 10271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1028809d1be9820039b4cf6efa48246a0d70ffa13394James Dennett /// \brief Returns the include location if \p FID is a \#include'd file 1029d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// otherwise it returns an invalid location. 1030d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis SourceLocation getIncludeLoc(FileID FID) const { 1031d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 1032d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 1033d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 1034d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return SourceLocation(); 10355330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1036d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return Entry.getFile().getIncludeLoc(); 1037d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 1038d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 10396c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor // \brief Returns the import location if the given source location is 10406c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor // located within a module, or an invalid location if the source location 10416c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor // is within the current translation unit. 10426c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor std::pair<SourceLocation, StringRef> 10436c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor getModuleImportLoc(SourceLocation Loc) const { 10446c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor FileID FID = getFileID(Loc); 10456c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor 10466c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor // Positive file IDs are in the current translation unit, and -1 is a 10476c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor // placeholder. 10486c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor if (FID.ID >= -1) 10496c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor return std::make_pair(SourceLocation(), ""); 10506c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor 10516c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor return ExternalSLocEntries->getModuleImportLoc(FID.ID); 10526c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor } 10536c3254316de2d0d554b19702f4b10117ae46b77bDouglas Gregor 105412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Given a SourceLocation object \p Loc, return the expansion 1055402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth /// location referenced by the ID. 1056402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation getExpansionLoc(SourceLocation Loc) const { 1057addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner // Handle the non-mapped case inline, defer to out of line code to handle 1058402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth // expansions. 1059de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) return Loc; 1060f84ef95ecec34f27fd05eb4e0392ca6bd3bd0be0Chandler Carruth return getExpansionLocSlowCase(Loc); 1061de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 10621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10632c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Given \p Loc, if it is a macro location return the expansion 1064796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis /// location or the spelling location, depending on if it comes from a 1065796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis /// macro argument or not. 1066796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis SourceLocation getFileLoc(SourceLocation Loc) const { 1067796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis if (Loc.isFileID()) return Loc; 1068796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis return getFileLocSlowCase(Loc); 1069796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis } 1070796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis 107112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the start/end of the expansion information for an 107212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// expansion location. 107312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 107412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \pre \p Loc is required to be an expansion location. 1075e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner std::pair<SourceLocation,SourceLocation> 1076999f739404edf2078cf9f9c28b4dc45c19765842Chandler Carruth getImmediateExpansionRange(SourceLocation Loc) const; 10771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Given a SourceLocation object, return the range of 10790e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// tokens covered by the expansion in the ultimate file. 10806678133b8ce642f93e5141f056fa643112041ad0Chris Lattner std::pair<SourceLocation,SourceLocation> 1081edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth getExpansionRange(SourceLocation Loc) const; 10821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10830e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// \brief Given a SourceRange object, return the range of 10840e2c34f92f00628d48968dfea096d36381f494cbStephen Hines /// tokens covered by the expansion in the ultimate file. 10850e2c34f92f00628d48968dfea096d36381f494cbStephen Hines SourceRange getExpansionRange(SourceRange Range) const { 10860e2c34f92f00628d48968dfea096d36381f494cbStephen Hines return SourceRange(getExpansionRange(Range.getBegin()).first, 10870e2c34f92f00628d48968dfea096d36381f494cbStephen Hines getExpansionRange(Range.getEnd()).second); 10880e2c34f92f00628d48968dfea096d36381f494cbStephen Hines } 10891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 109012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Given a SourceLocation object, return the spelling 109112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// location referenced by the ID. 109212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 109312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This is the place where the characters that make up the lexed token 109412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// can be found. 1095de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getSpellingLoc(SourceLocation Loc) const { 1096addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner // Handle the non-mapped case inline, defer to out of line code to handle 10973201f382956ed9beee9fb31229c2835c1208889cChandler Carruth // expansions. 1098de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) return Loc; 1099addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner return getSpellingLocSlowCase(Loc); 1100de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 11011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 110212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Given a SourceLocation object, return the spelling location 110312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// referenced by the ID. 110412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 110512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This is the first level down towards the place where the characters 110612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// that make up the lexed token can be found. This should not generally 110712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// be used by clients. 11081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const; 1109de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 111012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Decompose the specified location into a raw FileID + Offset pair. 111112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 111212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// The first element is the FileID, the second is the offset from the 111312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// start of the buffer of the location. 1114de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> getDecomposedLoc(SourceLocation Loc) const { 1115de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 1116a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis bool Invalid = false; 1117a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis const SrcMgr::SLocEntry &E = getSLocEntry(FID, &Invalid); 1118a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis if (Invalid) 1119a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FileID(), 0); 1120a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FID, Loc.getOffset()-E.getOffset()); 1121de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 11221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 112312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Decompose the specified location into a raw FileID + Offset pair. 112412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 112512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// If the location is an expansion record, walk through it until we find 112612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// the final location expanded. 1127de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1128e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth getDecomposedExpansionLoc(SourceLocation Loc) const { 1129de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 1130a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis bool Invalid = false; 1131a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid); 1132a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis if (Invalid) 1133a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FileID(), 0); 11341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1135de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset = Loc.getOffset()-E->getOffset(); 1136de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) 1137de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return std::make_pair(FID, Offset); 11381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1139e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth return getDecomposedExpansionLocSlowCase(E); 1140de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 1141de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 114212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Decompose the specified location into a raw FileID + Offset pair. 114312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 114412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// If the location is an expansion record, walk through it until we find 114512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// its spelling record. 1146de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1147de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getDecomposedSpellingLoc(SourceLocation Loc) const { 1148de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 1149a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis bool Invalid = false; 1150a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid); 1151a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis if (Invalid) 1152a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FileID(), 0); 11531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1154de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset = Loc.getOffset()-E->getOffset(); 1155de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) 1156de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return std::make_pair(FID, Offset); 1157de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getDecomposedSpellingLocSlowCase(E, Offset); 11581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 11591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1160ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis /// \brief Returns the "included/expanded in" decomposed location of the given 1161ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis /// FileID. 1162ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis std::pair<FileID, unsigned> getDecomposedIncludedLoc(FileID FID) const; 1163ecc65238c98ba21d08763da7b7972d617677e908Argyrios Kyrtzidis 116412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the offset from the start of the file that the 116512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// specified SourceLocation represents. 116612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 116712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This is not very meaningful for a macro ID. 116852c29081281955d3db9e11d10573b2d38f709099Chris Lattner unsigned getFileOffset(SourceLocation SpellingLoc) const { 1169de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getDecomposedLoc(SpellingLoc).second; 11705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 11711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 117212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Tests whether the given source location represents a macro 117312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// argument's expansion into the function-like macro definition. 117412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 117587d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// \param StartLoc If non-null and function returns true, it is set to the 117687d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// start location of the macro argument expansion. 117787d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar /// 117812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// Such source locations only appear inside of the expansion 117996d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// locations representing where a particular function-like macro was 118096d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// expanded. 118187d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar bool isMacroArgExpansion(SourceLocation Loc, 118287d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar SourceLocation *StartLoc = nullptr) const; 11831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1184c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay /// \brief Tests whether the given source location represents the expansion of 1185c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay /// a macro body. 1186c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay /// 1187c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay /// This is equivalent to testing whether the location is part of a macro 1188c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay /// expansion but not the expansion of an argument to a function-like macro. 1189c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay bool isMacroBodyExpansion(SourceLocation Loc) const; 1190c3cd6f7a5d33ad44f6c9cf4faa7046c77baa128eMatt Beaumont-Gay 1191c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the beginning 1192c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// of the immediate macro expansion. 1193c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// 1194c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// \param MacroBegin If non-null and function returns true, it is set to the 1195c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// begin location of the immediate macro expansion. 1196c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis bool isAtStartOfImmediateMacroExpansion(SourceLocation Loc, 11976bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SourceLocation *MacroBegin = nullptr) const; 1198c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis 1199c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// \brief Returns true if the given MacroID location points at the character 1200c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// end of the immediate macro expansion. 1201c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// 1202c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// \param MacroEnd If non-null and function returns true, it is set to the 1203c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// character end location of the immediate macro expansion. 12046bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool 12056bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines isAtEndOfImmediateMacroExpansion(SourceLocation Loc, 12066bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines SourceLocation *MacroEnd = nullptr) const; 1207c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis 12082c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Returns true if \p Loc is inside the [\p Start, +\p Length) 1209499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// chunk of the source location address space. 121012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 12112c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// If it's true and \p RelativeOffset is non-null, it will be set to the 12122c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// relative offset of \p Loc inside the chunk. 1213499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis bool isInSLocAddrSpace(SourceLocation Loc, 1214499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis SourceLocation Start, unsigned Length, 12156bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned *RelativeOffset = nullptr) const { 1216499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis assert(((Start.getOffset() < NextLocalOffset && 1217499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis Start.getOffset()+Length <= NextLocalOffset) || 1218499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis (Start.getOffset() >= CurrentLoadedOffset && 1219499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis Start.getOffset()+Length < MaxLoadedOffset)) && 1220499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis "Chunk is not valid SLoc address space"); 1221499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned LocOffs = Loc.getOffset(); 1222499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned BeginOffs = Start.getOffset(); 1223499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned EndOffs = BeginOffs + Length; 1224499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis if (LocOffs >= BeginOffs && LocOffs < EndOffs) { 1225499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis if (RelativeOffset) 1226499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis *RelativeOffset = LocOffs - BeginOffs; 1227499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis return true; 1228499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis } 1229499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis 1230499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis return false; 1231499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis } 1232499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis 12332c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Return true if both \p LHS and \p RHS are in the local source 123412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// location address space or the loaded one. 123512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 123612a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// If it's true and \p RelativeOffset is non-null, it will be set to the 123712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// offset of \p RHS relative to \p LHS. 1238b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis bool isInSameSLocAddrSpace(SourceLocation LHS, SourceLocation RHS, 1239b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis int *RelativeOffset) const { 1240b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis unsigned LHSOffs = LHS.getOffset(), RHSOffs = RHS.getOffset(); 1241b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis bool LHSLoaded = LHSOffs >= CurrentLoadedOffset; 1242b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis bool RHSLoaded = RHSOffs >= CurrentLoadedOffset; 1243b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis 1244b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis if (LHSLoaded == RHSLoaded) { 1245b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis if (RelativeOffset) 1246b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis *RelativeOffset = RHSOffs - LHSOffs; 1247b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis return true; 1248b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis } 1249b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis 1250b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis return false; 1251b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis } 1252b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis 1253de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner //===--------------------------------------------------------------------===// 1254de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // Queries about the code at a SourceLocation. 1255de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner //===--------------------------------------------------------------------===// 12561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 125712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return a pointer to the start of the specified location 1258de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// in the appropriate spelling MemoryBuffer. 125950f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 126050f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error occurs. 12616bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const char *getCharacterData(SourceLocation SL, 12626bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const; 12631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 126412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the column # for the specified file position. 126512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 12669dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// This is significantly cheaper to compute than the line number. This 12673201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// returns zero if the column number isn't known. This may only be called 12683201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// on a file sloc, so you must choose a spelling or expansion location 1269f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner /// before calling this method. 12705330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher unsigned getColumnNumber(FileID FID, unsigned FilePos, 12716bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const; 12726bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned getSpellingColumnNumber(SourceLocation Loc, 12736bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const; 1274a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth unsigned getExpansionColumnNumber(SourceLocation Loc, 12756bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const; 12766bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned getPresumedColumnNumber(SourceLocation Loc, 12776bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const; 12781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 127912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Given a SourceLocation, return the spelling line number 128012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// for the position indicated. 128112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 128212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// This requires building and caching a table of line offsets for the 128312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// MemoryBuffer, so this is not cheap: use only when about to emit a 128412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// diagnostic. 12856bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid = nullptr) const; 12866bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid = nullptr) const; 12876bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid = nullptr) const; 12886bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid = nullptr) const; 12891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1290c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \brief Return the filename or buffer identifier of the buffer the 1291c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// location is in. 1292c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// 1293c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// Note that this name does not respect \#line directives. Use 1294c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// getPresumedLoc for normal clients. 12956bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const char *getBufferName(SourceLocation Loc, bool *Invalid = nullptr) const; 12961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 129712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the file characteristic of the specified source 129812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// location, indicating whether this is a normal file, a system 12996b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// header, or an "implicit extern C" system header. 13006b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// 13016b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// This state can be modified with flags on GNU linemarker directives like: 1302c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \code 13036b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// # 4 "foo.h" 3 1304c351d9837ea1d0b04842497e76c76125426a982cJames Dennett /// \endcode 13056b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// which changes all source locations in the current file after that to be 13066b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// considered to be from a system header. 13076b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const; 13081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 130912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns the "presumed" location of a SourceLocation specifies. 131012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 131112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// A "presumed location" can be modified by \#line or GNU line marker 131212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// directives. This provides a view on the data that a user should see 131312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// in diagnostics, for example. 1314b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// 13153201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// Note that a presumed location is always given as the expansion point of 13163201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// an expansion location, not at the spelling location. 1317cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// 1318cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// \returns The presumed location of the specified SourceLocation. If the 1319c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines /// presumed location cannot be calculated (e.g., because \p Loc is invalid 1320cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// or the file containing \p Loc has changed on disk), returns an invalid 1321cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// presumed location. 132262221b17c90457df9ca0ff20bb54d634e8951defRichard Smith PresumedLoc getPresumedLoc(SourceLocation Loc, 132362221b17c90457df9ca0ff20bb54d634e8951defRichard Smith bool UseLineDirectives = true) const; 13241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 132524146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// \brief Returns whether the PresumedLoc for a given SourceLocation is 132624146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// in the main file. 132724146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// 132824146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// This computes the "presumed" location for a SourceLocation, then checks 132924146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// whether it came from a file other than the main file. This is different 133024146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// from isWrittenInMainFile() because it takes line marker directives into 133124146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// account. 13321b9c5374a3cd33b0e281f494f0e322aef035abcaBenjamin Kramer bool isInMainFile(SourceLocation Loc) const; 133324146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman 133424146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// \brief Returns true if the spelling locations for both SourceLocations 133524146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// are part of the same file buffer. 133624146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// 133724146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// This check ignores line marker directives. 133824146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman bool isWrittenInSameFile(SourceLocation Loc1, SourceLocation Loc2) const { 1339a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner return getFileID(Loc1) == getFileID(Loc2); 13409fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek } 13411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134224146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// \brief Returns true if the spelling location for the given location 134324146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// is in the main file buffer. 134424146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// 134524146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman /// This check ignores line marker directives. 134624146975f1af8c1b4b14e8545f218129d0e7dfebEli Friedman bool isWrittenInMainFile(SourceLocation Loc) const { 1347a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner return getFileID(Loc) == getMainFileID(); 13481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 13491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 135012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns if a SourceLocation is in a system header. 13517bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader(SourceLocation Loc) const { 13520b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner return getFileCharacteristic(Loc) != SrcMgr::C_User; 1353721818304ac462d8c6ce05eecd02884033db78f1Chris Lattner } 13541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 135512a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Returns if a SourceLocation is in an "extern C" system header. 13560d456588acac0713a7c33063922d35a8cc8c658eChris Lattner bool isInExternCSystemHeader(SourceLocation Loc) const { 13570d456588acac0713a7c33063922d35a8cc8c658eChris Lattner return getFileCharacteristic(Loc) == SrcMgr::C_ExternCSystem; 13580d456588acac0713a7c33063922d35a8cc8c658eChris Lattner } 13591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1360d87a0cd2b3e1c9e9f01212875f4cbe5b7bb7ab57Matt Beaumont-Gay /// \brief Returns whether \p Loc is expanded from a macro in a system header. 1361d87a0cd2b3e1c9e9f01212875f4cbe5b7bb7ab57Matt Beaumont-Gay bool isInSystemMacro(SourceLocation loc) { 1362d87a0cd2b3e1c9e9f01212875f4cbe5b7bb7ab57Matt Beaumont-Gay return loc.isMacroID() && isInSystemHeader(getSpellingLoc(loc)); 1363d87a0cd2b3e1c9e9f01212875f4cbe5b7bb7ab57Matt Beaumont-Gay } 1364d87a0cd2b3e1c9e9f01212875f4cbe5b7bb7ab57Matt Beaumont-Gay 1365651f13cea278ec967336033dd032faef0e9fc2ecStephen Hines /// \brief The size of the SLocEntry that \p FID represents. 1366984e42ca1ff7775ce39372c314f1cb7d6862c4c7Argyrios Kyrtzidis unsigned getFileIDSize(FileID FID) const; 136754232ade44d31e98ea83f43ca066128e315dcbdaArgyrios Kyrtzidis 13682c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Given a specific FileID, returns true if \p Loc is inside that 13692c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// FileID chunk and sets relative offset (offset of \p Loc from beginning 13702c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// of FileID) to \p relativeOffset. 1371d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis bool isInFileID(SourceLocation Loc, FileID FID, 13726bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines unsigned *RelativeOffset = nullptr) const { 1373d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis unsigned Offs = Loc.getOffset(); 1374d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis if (isOffsetInFileID(FID, Offs)) { 1375d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis if (RelativeOffset) 1376d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis *RelativeOffset = Offs - getSLocEntry(FID).getOffset(); 1377d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis return true; 1378d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis } 1379d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis 1380d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis return false; 1381d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis } 1382469244a322dd5d35cee1d02d70a2edbc12ac5ce7Argyrios Kyrtzidis 138306a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 13845b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner // Line Table Manipulation Routines 13855b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner //===--------------------------------------------------------------------===// 13861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 138712a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the uniqued ID for the specified filename. 13881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 1389686775deca8b8685eb90801495880e3abdd844c2Chris Lattner unsigned getLineTableFilenameID(StringRef Str); 13901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 139112a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Add a line note to the line table for the FileID and offset 139212a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// specified by Loc. 139312a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// 139412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// If FilenameID is -1, it is considered to be unspecified. 13954c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID); 13969d79ebac47ffde6a1cb312f4c09b66b1b9a397fbChris Lattner void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID, 13971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool IsFileEntry, bool IsFileExit, 13989d79ebac47ffde6a1cb312f4c09b66b1b9a397fbChris Lattner bool IsSystemHeader, bool IsExternCHeader); 1399bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1400bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor /// \brief Determine if the source manager has a line table. 14016bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool hasLineTable() const { return LineTable != nullptr; } 1402bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1403bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor /// \brief Retrieve the stored line table. 1404bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor LineTableInfo &getLineTable(); 1405bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 14065b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner //===--------------------------------------------------------------------===// 1407457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek // Queries for performance analysis. 1408457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek //===--------------------------------------------------------------------===// 1409457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek 141012a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the total amount of physical memory allocated by the 1411457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek /// ContentCache allocator. 1412457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek size_t getContentCacheSize() const { 1413457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek return ContentCacheAlloc.getTotalMemory(); 1414457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek } 14155330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1416f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek struct MemoryBufferSizes { 1417f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek const size_t malloc_bytes; 1418f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek const size_t mmap_bytes; 14195330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1420f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes) 1421f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek : malloc_bytes(malloc_bytes), mmap_bytes(mmap_bytes) {} 1422f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek }; 1423f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek 142412a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the amount of memory used by memory buffers, breaking down 1425f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// by heap-backed versus mmap'ed memory. 1426f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek MemoryBufferSizes getMemoryBufferSizes() const; 14275330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 142812a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Return the amount of memory used for various side tables and 142912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// data structures in the SourceManager. 1430ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek size_t getDataStructureSizes() const; 1431457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek 1432457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek //===--------------------------------------------------------------------===// 143306a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // Other miscellaneous methods. 143406a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 143510b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis 143610b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 143710b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// 143810b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// If the source file is included multiple times, the source location will 143910b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// be based upon the first inclusion. 1440ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis SourceLocation translateFileLineCol(const FileEntry *SourceFile, 1441507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 1442ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis 1443b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// \brief Get the FileID for the given file. 1444b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// 1445b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// If the source file is included multiple times, the FileID will be the 1446b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// first inclusion. 1447b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis FileID translateFile(const FileEntry *SourceFile) const; 1448b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis 14492c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Get the source location in \p FID for the given line:col. 14502c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// Returns null location if \p FID is not a file SLocEntry. 1451507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation translateLineCol(FileID FID, 1452507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 1453efa2ff8603dae51f5f5ed7509a503f477498ad22Argyrios Kyrtzidis 14542c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief If \p Loc points inside a function macro argument, the returned 1455ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// location will be the macro location in which the argument was expanded. 1456ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// If a macro argument is used multiple times, the expanded location will 1457ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// be at the first expansion of the argument. 1458ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// e.g. 1459ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// MY_MACRO(foo); 1460ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// ^ 1461ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// Passing a file location pointing at 'foo', will yield a macro location 1462ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// where 'foo' was expanded into. 1463507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const; 14641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14652aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the translation unit. 14662aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// 14672aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// \returns true if LHS source location comes before RHS, false otherwise. 14682aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const; 14692aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis 1470b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the "source location 1471b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// address space". 14725d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const { 14735d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis return isBeforeInSLocAddrSpace(LHS, RHS.getOffset()); 1474b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis } 1475b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 1476b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// \brief Determines the order of a source location and a source location 1477b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// offset in the "source location address space". 1478f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 14795330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher /// Note that we always consider source locations loaded from 14805d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis bool isBeforeInSLocAddrSpace(SourceLocation LHS, unsigned RHS) const { 1481f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned LHSOffset = LHS.getOffset(); 1482f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool LHSLoaded = LHSOffset >= CurrentLoadedOffset; 1483f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool RHSLoaded = RHS >= CurrentLoadedOffset; 1484f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (LHSLoaded == RHSLoaded) 14855d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis return LHSOffset < RHS; 14865330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1487f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LHSLoaded; 1488b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis } 1489b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 1490c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner // Iterators over FileInfos. 14910d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner typedef llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> 14920d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner ::const_iterator fileinfo_iterator; 1493c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner fileinfo_iterator fileinfo_begin() const { return FileInfos.begin(); } 1494c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner fileinfo_iterator fileinfo_end() const { return FileInfos.end(); } 1495d93256e55673a17d18543397ec462416acb13792Douglas Gregor bool hasFileInfo(const FileEntry *File) const { 1496d93256e55673a17d18543397ec462416acb13792Douglas Gregor return FileInfos.find(File) != FileInfos.end(); 1497d93256e55673a17d18543397ec462416acb13792Douglas Gregor } 1498c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner 149912a4ced3dc30adcf2e1532c6323d517e9949a61eJames Dennett /// \brief Print statistics to stderr. 15005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 15015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats() const; 150278d85f53b093867bbb0123f016956178eea7343eTed Kremenek 150387d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar void dump() const; 150487d948ecccffea9e9e37d0d053b246e2d6d6c47bPirama Arumuga Nainar 1505f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the number of local SLocEntries we have. 1506f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned local_sloc_entry_size() const { return LocalSLocEntryTable.size(); } 15075330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1508f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get a local SLocEntry. This is exposed for indexing. 15095330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher const SrcMgr::SLocEntry &getLocalSLocEntry(unsigned Index, 15106bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const { 1511f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(Index < LocalSLocEntryTable.size() && "Invalid index"); 1512f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LocalSLocEntryTable[Index]; 1513bdfe48ac80573e026595af91e541474dbf02565fDouglas Gregor } 15145330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1515f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the number of loaded SLocEntries we have. 1516f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned loaded_sloc_entry_size() const { return LoadedSLocEntryTable.size();} 15175330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1518f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get a loaded SLocEntry. This is exposed for indexing. 151970042f5d1ca378138f90b7b9384023701f5d03d8David Blaikie const SrcMgr::SLocEntry &getLoadedSLocEntry(unsigned Index, 15206bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const { 1521f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(Index < LoadedSLocEntryTable.size() && "Invalid index"); 1522a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis if (SLocEntryLoaded[Index]) 1523a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis return LoadedSLocEntryTable[Index]; 1524a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis return loadSLocEntry(Index, Invalid); 1525f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 15265330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 15276bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const SrcMgr::SLocEntry &getSLocEntry(FileID FID, 15286bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const { 1529c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis if (FID.ID == 0 || FID.ID == -1) { 1530c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis if (Invalid) *Invalid = true; 1531c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis return LocalSLocEntryTable[0]; 1532c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis } 15334ff3225c1f343c3e0d461a0e387c7c6012cff5baArgyrios Kyrtzidis return getSLocEntryByID(FID.ID, Invalid); 1534bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor } 1535bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1536f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned getNextLocalOffset() const { return NextLocalOffset; } 15375330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1538f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor void setExternalSLocEntrySource(ExternalSLocEntrySource *Source) { 1539f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(LoadedSLocEntryTable.empty() && 1540f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor "Invalidating existing loaded entries"); 1541f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor ExternalSLocEntries = Source; 1542f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 15435330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1544f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Allocate a number of loaded SLocEntries, which will be actually 1545f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// loaded on demand from the external source. 1546f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 1547f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// NumSLocEntries will be allocated, which occupy a total of TotalSize space 1548f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// in the global source view. The lowest ID and the base offset of the 1549f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// entries will be returned. 1550f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor std::pair<int, unsigned> 1551f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor AllocateLoadedSLocEntries(unsigned NumSLocEntries, unsigned TotalSize); 15525330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 15532c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Returns true if \p Loc came from a PCH/Module. 1554aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis bool isLoadedSourceLocation(SourceLocation Loc) const { 1555aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis return Loc.getOffset() >= CurrentLoadedOffset; 1556aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis } 1557aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis 15582c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Returns true if \p Loc did not come from a PCH/Module. 1559aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis bool isLocalSourceLocation(SourceLocation Loc) const { 1560aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis return Loc.getOffset() < NextLocalOffset; 1561aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis } 1562aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis 15632c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Returns true if \p FID came from a PCH/Module. 1564718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis bool isLoadedFileID(FileID FID) const { 1565718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis assert(FID.ID != -1 && "Using FileID sentinel value"); 1566718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis return FID.ID < 0; 1567718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis } 1568718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis 15692c3c7675b4c01b9d555c47232597a000fbb93c26Matt Beaumont-Gay /// \brief Returns true if \p FID did not come from a PCH/Module. 1570718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis bool isLocalFileID(FileID FID) const { 1571718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis return !isLoadedFileID(FID); 1572718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis } 1573718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis 157429271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay /// Gets the location of the immediate macro caller, one level up the stack 157529271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay /// toward the initial macro typed into the source. 157629271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay SourceLocation getImmediateMacroCallerLoc(SourceLocation Loc) const { 157729271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay if (!Loc.isMacroID()) return Loc; 157829271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay 157929271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay // When we have the location of (part of) an expanded parameter, its 1580678839297204002df215e0be12bcd10b20a9a4a4Richard Smith // spelling location points to the argument as expanded in the macro call, 158129271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay // and therefore is used to locate the macro caller. 158229271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay if (isMacroArgExpansion(Loc)) 158329271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay return getImmediateSpellingLoc(Loc); 158429271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay 158529271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay // Otherwise, the caller of the macro is located where this macro is 158629271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay // expanded (while the spelling is part of the macro definition). 158729271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay return getImmediateExpansionRange(Loc).first; 158829271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay } 158929271fbcef645117df05d5b60e593acb6562422cMatt Beaumont-Gay 15905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 1591c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines llvm::MemoryBuffer *getFakeBufferForRecovery() const; 1592a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis const SrcMgr::ContentCache *getFakeContentCacheForRecovery() const; 1593a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis 1594a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis const SrcMgr::SLocEntry &loadSLocEntry(unsigned Index, bool *Invalid) const; 1595e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 1596f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the entry with the given unwrapped FileID. 15976bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const SrcMgr::SLocEntry &getSLocEntryByID(int ID, 15986bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines bool *Invalid = nullptr) const { 1599f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(ID != -1 && "Using FileID sentinel value"); 1600f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (ID < 0) 16014ff3225c1f343c3e0d461a0e387c7c6012cff5baArgyrios Kyrtzidis return getLoadedSLocEntryByID(ID, Invalid); 16024ff3225c1f343c3e0d461a0e387c7c6012cff5baArgyrios Kyrtzidis return getLocalSLocEntry(static_cast<unsigned>(ID), Invalid); 1603f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 16045330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 16056bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines const SrcMgr::SLocEntry & 16066bcf27bb9a4b5c3f79cb44c0e4654a6d7619ad89Stephen Hines getLoadedSLocEntryByID(int ID, bool *Invalid = nullptr) const { 1607a4c29b6e55c9d4ef44a51c45c6785e8b4fe9deedArgyrios Kyrtzidis return getLoadedSLocEntry(static_cast<unsigned>(-ID - 2), Invalid); 1608f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 16095330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1610af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// Implements the common elements of storing an expansion info struct into 1611af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// the SLocEntry table and producing a source location that refers to it. 161278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation createExpansionLocImpl(const SrcMgr::ExpansionInfo &Expansion, 1613bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength, 1614bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth int LoadedID = 0, 1615bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned LoadedOffset = 0); 1616c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 1617af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Return true if the specified FileID contains the 1618de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// specified SourceLocation offset. This is a very hot method. 1619de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner inline bool isOffsetInFileID(FileID FID, unsigned SLocOffset) const { 1620de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::SLocEntry &Entry = getSLocEntry(FID); 1621de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // If the entry is after the offset, it can't contain it. 1622de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (SLocOffset < Entry.getOffset()) return false; 16231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1624f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // If this is the very last entry then it does. 1625f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (FID.ID == -2) 1626f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return true; 1627f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1628f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // If it is the last local entry, then it does if the location is local. 1629b2efdf3e92f986956f0a755ba815f3870838583bBenjamin Kramer if (FID.ID+1 == static_cast<int>(LocalSLocEntryTable.size())) 1630f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return SLocOffset < NextLocalOffset; 16317f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 1632f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // Otherwise, the entry after it has to not include it. This works for both 1633f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // local and loaded entries. 1634b2efdf3e92f986956f0a755ba815f3870838583bBenjamin Kramer return SLocOffset < getSLocEntryByID(FID.ID+1).getOffset(); 1635de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 16361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1637c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// \brief Returns the previous in-order FileID or an invalid FileID if there 1638c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// is no previous one. 1639c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis FileID getPreviousFileID(FileID FID) const; 1640c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis 1641c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// \brief Returns the next in-order FileID or an invalid FileID if there is 1642c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis /// no next one. 1643c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis FileID getNextFileID(FileID FID) const; 1644c50c6ff49aa3648ae031349de6f09439f52425f0Argyrios Kyrtzidis 1645af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Create a new fileID for the specified ContentCache and 1646af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// include position. 1647af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// 1648af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// This works regardless of whether the ContentCache corresponds to a 1649af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// file or some other input source. 16502b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID createFileID(const SrcMgr::ContentCache* File, 16512b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation IncludePos, 16527f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor SrcMgr::CharacteristicKind DirCharacter, 1653f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor int LoadedID, unsigned LoadedOffset); 16541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1655de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::ContentCache * 1656ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis getOrCreateContentCache(const FileEntry *SourceFile, 1657ff398965a5abfaf5bc47bc022876f56a28e5b9a7Argyrios Kyrtzidis bool isSystemFile = false); 1658c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek 1659af50aab0c317462129d73ae8000c6394c718598dJames Dennett /// \brief Create a new ContentCache for the specified memory buffer. 1660c568f1e98938584c0ef0b12ae5018ff7d90a4072Stephen Hines const SrcMgr::ContentCache * 1661176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines createMemBufferContentCache(std::unique_ptr<llvm::MemoryBuffer> Buf); 16621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1663de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID getFileIDSlow(unsigned SLocOffset) const; 1664f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID getFileIDLocal(unsigned SLocOffset) const; 1665f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID getFileIDLoaded(unsigned SLocOffset) const; 1666de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 1667f84ef95ecec34f27fd05eb4e0392ca6bd3bd0be0Chandler Carruth SourceLocation getExpansionLocSlowCase(SourceLocation Loc) const; 1668addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner SourceLocation getSpellingLocSlowCase(SourceLocation Loc) const; 1669796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis SourceLocation getFileLocSlowCase(SourceLocation Loc) const; 1670addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner 1671de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1672e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth getDecomposedExpansionLocSlowCase(const SrcMgr::SLocEntry *E) const; 1673de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1674de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E, 1675de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset) const; 1676fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis void computeMacroArgsCache(MacroArgsMap *&MacroArgsCache, FileID FID) const; 16770872a06d1ee1a3b62ef833f955051418d18006a1Argyrios Kyrtzidis void associateFileChunkWithMacroArgExp(MacroArgsMap &MacroArgsCache, 16780872a06d1ee1a3b62ef833f955051418d18006a1Argyrios Kyrtzidis FileID FID, 16790872a06d1ee1a3b62ef833f955051418d18006a1Argyrios Kyrtzidis SourceLocation SpellLoc, 16800872a06d1ee1a3b62ef833f955051418d18006a1Argyrios Kyrtzidis SourceLocation ExpansionLoc, 16810872a06d1ee1a3b62ef833f955051418d18006a1Argyrios Kyrtzidis unsigned ExpansionLength) const; 1682ac1ffcc55b861737ba2466cd1ca1accd8eafceaaArgyrios Kyrtzidis friend class ASTReader; 1683ac1ffcc55b861737ba2466cd1ca1accd8eafceaaArgyrios Kyrtzidis friend class ASTWriter; 16845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 16855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1686aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko/// \brief Comparison function object. 1687aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkotemplate<typename T> 1688aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkoclass BeforeThanCompare; 1689aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 1690aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko/// \brief Compare two source locations. 1691aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkotemplate<> 1692aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkoclass BeforeThanCompare<SourceLocation> { 1693aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko SourceManager &SM; 1694aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 1695aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkopublic: 1696aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko explicit BeforeThanCompare(SourceManager &SM) : SM(SM) { } 1697aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 1698aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko bool operator()(SourceLocation LHS, SourceLocation RHS) const { 1699aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko return SM.isBeforeInTranslationUnit(LHS, RHS); 1700aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko } 1701aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko}; 1702aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 1703aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko/// \brief Compare two non-overlapping source ranges. 1704aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkotemplate<> 1705aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkoclass BeforeThanCompare<SourceRange> { 1706aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko SourceManager &SM; 1707aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 1708aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenkopublic: 1709aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko explicit BeforeThanCompare(SourceManager &SM) : SM(SM) { } 1710aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko 1711176edba5311f6eff0cad2631449885ddf4fbc9eaStephen Hines bool operator()(SourceRange LHS, SourceRange RHS) const { 1712aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko return SM.isBeforeInTranslationUnit(LHS.getBegin(), RHS.getBegin()); 1713aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko } 1714aa0cd85838f2a024e589ea4e8c2094130065af21Dmitri Gribenko}; 17155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 17165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 17175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1718b7551f71a4c5a901bbae72b0a80af3745b7a0c0dDouglas Gregor 17195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1720