SourceManager.h revision a081da5e44600d02983d6562bed1b4fd61e410fd
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//===----------------------------------------------------------------------===// 95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file defines the SourceManager interface. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_SOURCEMANAGER_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_SOURCEMANAGER_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 17d47d3b0cfeb7e8564ff77f48130fe63282b6d127Chris Lattner#include "clang/Basic/LLVM.h" 185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 190d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner#include "llvm/Support/Allocator.h" 2003013fa9a0bf1ef4b907f5fec006c8f4000fdd21Michael J. Spencer#include "llvm/Support/DataTypes.h" 21c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor#include "llvm/ADT/PointerIntPair.h" 22aea67dbd653a2dd6dd5cc2159279e81e855b2482Douglas Gregor#include "llvm/ADT/PointerUnion.h" 234f32786ac45210143654390177105eb749b614e9Ted Kremenek#include "llvm/ADT/IntrusiveRefCntPtr.h" 240d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner#include "llvm/ADT/DenseMap.h" 25f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek#include "llvm/Support/MemoryBuffer.h" 26d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis#include <map> 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <vector> 289dc62f044a6ba21f503bd56607d94b32704e7945Chris Lattner#include <cassert> 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 32d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikieclass DiagnosticsEngine; 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 34099b4747042352f69184481a48508b599a8d3f73Ted Kremenekclass FileManager; 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 365b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattnerclass LineTableInfo; 37b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidisclass LangOptions; 38d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidisclass ASTWriter; 39d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidisclass ASTReader; 405330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 4129f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// There are three different types of locations in a file: a spelling 4229f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// location, an expansion location, and a presumed location. 4329f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// 4429f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// Given an example of: 4529f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// #define min(x, y) x < y ? x : y 4629f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// 4729f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// and then later on a use of min: 4829f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// #line 17 495330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher/// return min(a, b); 5029f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// 5129f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// The expansion location is the line in the source code where the macro 5229f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// was expanded (the return statement), the spelling location is the 5329f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// location in the source where the macro was originally defined, 5429f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// and the presumed location is where the line directive states that 5529f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher/// the line is 17, or any other line. 5629f39425fc7fcaede88a7e573f392975f8dc5e3eEric Christopher 570b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner/// SrcMgr - Public enums and private classes that are part of the 580b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner/// SourceManager implementation. 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace SrcMgr { 619d72851fec9e9c62570a027d42701562bbf29751Chris Lattner /// CharacteristicKind - This is used to represent whether a file or directory 620b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// holds normal user code, system code, or system code which is implicitly 630b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// 'extern "C"' in C++ mode. Entire directories can be tagged with this 640b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// (this is maintained by DirectoryLookup and friends) as can specific 65f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// FileInfos when a #pragma system_header is seen or various other cases. 660b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// 679d72851fec9e9c62570a027d42701562bbf29751Chris Lattner enum CharacteristicKind { 680b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner C_User, C_System, C_ExternCSystem 690b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner }; 701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 714710a8ea766b45079bf1c1dd36e29b59bb90829dDan Gohman /// ContentCache - One instance of this struct is kept for every file 7206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner /// loaded or used. This object owns the MemoryBuffer object. 73c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek class ContentCache { 74f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor enum CCFlags { 75f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the buffer is invalid. 76f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor InvalidFlag = 0x01, 77f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the buffer should not be freed on destruction. 78f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor DoNotFreeFlag = 0x02 79f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor }; 805330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 81c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// Buffer - The actual buffer containing the characters from the input 82c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// file. This is owned by the ContentCache object. 83f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// The bits indicate indicates whether the buffer is invalid. 84f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor mutable llvm::PointerIntPair<const llvm::MemoryBuffer *, 2> Buffer; 85c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek 86c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek public: 87b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// Reference to the file entry representing this ContentCache. 88b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// This reference does not own the FileEntry object. 89b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// It is possible for this to be NULL if 9078d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// the ContentCache encapsulates an imaginary text buffer. 91b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *OrigEntry; 92b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 93b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \brief References the file which the contents were actually loaded from. 94b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// Can be different from 'Entry' if we overridden the contents of one file 95b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// with the contents of another file. 96b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *ContentsEntry; 971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 980d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// SourceLineCache - A bump pointer allocated array of offsets for each 990d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// source line. This is lazily computed. This is owned by the 1000d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// SourceManager BumpPointerAllocator object. 10105816591ec488a933dfecc9ff9f3cbf3c32767c2Chris Lattner unsigned *SourceLineCache; 1021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// NumLines - The number of lines in this ContentCache. This is only valid 104b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// if SourceLineCache is non-null. 105a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor unsigned NumLines : 31; 10610b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis 107a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// \brief Indicates whether the buffer itself was provided to override 108a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// the actual file contents. 109a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// 110a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// When true, the original entry may be a virtual file that does not 111a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor /// exist. 112a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor unsigned BufferOverridden : 1; 113a081da5e44600d02983d6562bed1b4fd61e410fdDouglas Gregor 11436c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// getBuffer - Returns the memory buffer for the associated content. 11536c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// 116a92d7e7a55a35b28437103130904a6401bf35408Jonathan D. Turner /// \param Diag Object through which diagnostics will be emitted if the 11736c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// buffer cannot be retrieved. 1185330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher /// 119e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// \param Loc If specified, is the location that invalid file diagnostics 120e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// will be emitted at. 121e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// 12236c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error occurred. 123d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie const llvm::MemoryBuffer *getBuffer(DiagnosticsEngine &Diag, 124e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const SourceManager &SM, 125e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc = SourceLocation(), 12636c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor bool *Invalid = 0) const; 1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 128c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// getSize - Returns the size of the content encapsulated by this 129c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// ContentCache. This can be the size of the source file or the size of an 130c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// arbitrary scratch buffer. If the ContentCache encapsulates a source 131c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// file this size is retrieved from the file's FileEntry. 132c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek unsigned getSize() const; 1331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 134c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// getSizeBytesMapped - Returns the number of bytes actually mapped for 1353201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// this ContentCache. This can be 0 if the MemBuffer was not actually 1363201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expanded. 137c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek unsigned getSizeBytesMapped() const; 1385330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 139f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// Returns the kind of memory used to back the memory buffer for 140f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// this content cache. This is used for performance analysis. 141f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek llvm::MemoryBuffer::BufferKind getMemoryBufferKind() const; 1421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 14305816591ec488a933dfecc9ff9f3cbf3c32767c2Chris Lattner void setBuffer(const llvm::MemoryBuffer *B) { 144c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor assert(!Buffer.getPointer() && "MemoryBuffer already set."); 145c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor Buffer.setPointer(B); 146c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor Buffer.setInt(false); 147c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek } 1485330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 149cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Get the underlying buffer, returning NULL if the buffer is not 150cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// yet available. 151cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor const llvm::MemoryBuffer *getRawBuffer() const { 152cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor return Buffer.getPointer(); 153cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor } 1541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1552968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Replace the existing buffer (which will be deleted) 1562968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// with the given buffer. 157f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor void replaceBuffer(const llvm::MemoryBuffer *B, bool DoNotFree = false); 1582968442603b029949246467253eeac8139a5b6d8Douglas Gregor 159f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Determine whether the buffer itself is invalid. 160f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool isBufferInvalid() const { 161f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor return Buffer.getInt() & InvalidFlag; 162f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 1635330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 164f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Determine whether the buffer should be freed. 165f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool shouldFreeBuffer() const { 166f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor return (Buffer.getInt() & DoNotFreeFlag) == 0; 167f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 1685330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1690d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner ContentCache(const FileEntry *Ent = 0) 170b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis : Buffer(0, false), OrigEntry(Ent), ContentsEntry(Ent), 171fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis SourceLineCache(0), NumLines(0) {} 172b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 173b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis ContentCache(const FileEntry *Ent, const FileEntry *contentEnt) 174b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis : Buffer(0, false), OrigEntry(Ent), ContentsEntry(contentEnt), 175fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis SourceLineCache(0), NumLines(0) {} 17678d85f53b093867bbb0123f016956178eea7343eTed Kremenek 17778d85f53b093867bbb0123f016956178eea7343eTed Kremenek ~ContentCache(); 1781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1790d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// The copy ctor does not allow copies where source object has either 1800d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// a non-NULL Buffer or SourceLineCache. Ownership of allocated memory 181fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// is not transferred, so this is a logical error. 1825330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher ContentCache(const ContentCache &RHS) 183fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis : Buffer(0, false), SourceLineCache(0) 184c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor { 185b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis OrigEntry = RHS.OrigEntry; 186b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis ContentsEntry = RHS.ContentsEntry; 1870d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek 188d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis assert (RHS.Buffer.getPointer() == 0 && RHS.SourceLineCache == 0 && 189fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis "Passed ContentCache object cannot own a buffer."); 1901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump NumLines = RHS.NumLines; 1920d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek } 1931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1940d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek private: 1950d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek // Disable assignments. 1961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ContentCache &operator=(const ContentCache& RHS); 1971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 1985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 199de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// FileInfo - Information about a FileID, basically just the logical file 200de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// that it represents and include stack information. 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 202de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// Each FileInfo has include stack information, indicating where it came 2033201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// from. This information encodes the #include chain that a token was 2043201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expanded from. The main include file has an invalid IncludeLoc. 2055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 206de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// FileInfos contain a "ContentCache *", with the contents of the file. 2075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 208de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner class FileInfo { 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeLoc - The location of the #include that brought in this file. 210de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// This is an invalid SLOC for the main file (top of the #include chain). 211de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned IncludeLoc; // Really a SourceLocation 2121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 213d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Number of FileIDs (files and macros) that were created during 214d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// preprocessing of this #include, including this SLocEntry. 215d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// Zero means the preprocessor didn't provide such info for this SLocEntry. 216d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis unsigned NumCreatedFIDs; 217d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 2186e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner /// Data - This contains the ContentCache* and the bits indicating the 2196e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner /// characteristic of the file and whether it has #line info, all bitmangled 2206e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner /// together. 2216e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner uintptr_t Data; 222d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 22321032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::SourceManager; 22421032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::ASTWriter; 22521032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::ASTReader; 22678d85f53b093867bbb0123f016956178eea7343eTed Kremenek public: 227de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// get - Return a FileInfo object. 228de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileInfo get(SourceLocation IL, const ContentCache *Con, 229de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner CharacteristicKind FileCharacter) { 230de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileInfo X; 231de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner X.IncludeLoc = IL.getRawEncoding(); 232d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis X.NumCreatedFIDs = 0; 2336e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner X.Data = (uintptr_t)Con; 23400282d6e1194655a2e89f940bd6fa8484b52e666Chris Lattner assert((X.Data & 7) == 0 &&"ContentCache pointer insufficiently aligned"); 2356e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner assert((unsigned)FileCharacter < 4 && "invalid file character"); 2366e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner X.Data |= (unsigned)FileCharacter; 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 2385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 240de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getIncludeLoc() const { 241de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFromRawEncoding(IncludeLoc); 242de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 2436e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner const ContentCache* getContentCache() const { 24400282d6e1194655a2e89f940bd6fa8484b52e666Chris Lattner return reinterpret_cast<const ContentCache*>(Data & ~7UL); 2456e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner } 2461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2470b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// getCharacteristic - Return whether this is a system header or not. 2481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump CharacteristicKind getFileCharacteristic() const { 2496e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner return (CharacteristicKind)(Data & 3); 2500b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner } 251ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner 252ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// hasLineDirectives - Return true if this FileID has #line directives in 253ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// it. 254ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner bool hasLineDirectives() const { return (Data & 4) != 0; } 2551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 256ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// setHasLineDirectives - Set the flag that indicates that this FileID has 257ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// line table entries associated with it. 258ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner void setHasLineDirectives() { 259ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner Data |= 4; 260ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner } 2619dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner }; 2621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 26378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// ExpansionInfo - Each ExpansionInfo encodes the expansion location - where 26478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// the token was ultimately expanded, and the SpellingLoc - where the actual 26578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// character data for the token came from. 26678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth class ExpansionInfo { 26778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // Really these are all SourceLocations. 2681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 269e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// SpellingLoc - Where the spelling for the token can be found. 270e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner unsigned SpellingLoc; 2711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// ExpansionLocStart/ExpansionLocEnd - In a macro expansion, these 27378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// indicate the start and end of the expansion. In object-like macros, 2743201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// these will be the same. In a function-like macro expansion, the start 2753201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// will be the identifier and the end will be the ')'. Finally, in 276c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// macro-argument instantitions, the end will be 'SourceLocation()', an 277c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// invalid location. 27878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth unsigned ExpansionLocStart, ExpansionLocEnd; 279c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 2809dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner public: 281de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getSpellingLoc() const { 282de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFromRawEncoding(SpellingLoc); 283de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 28478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation getExpansionLocStart() const { 28578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return SourceLocation::getFromRawEncoding(ExpansionLocStart); 286e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 28778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation getExpansionLocEnd() const { 288c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth SourceLocation EndLoc = 28978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation::getFromRawEncoding(ExpansionLocEnd); 29078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return EndLoc.isInvalid() ? getExpansionLocStart() : EndLoc; 291e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 2921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth std::pair<SourceLocation,SourceLocation> getExpansionLocRange() const { 29478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return std::make_pair(getExpansionLocStart(), getExpansionLocEnd()); 295e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 2961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29796d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth bool isMacroArgExpansion() const { 298c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth // Note that this needs to return false for default constructed objects. 29978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return getExpansionLocStart().isValid() && 30078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation::getFromRawEncoding(ExpansionLocEnd).isInvalid(); 301c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth } 302c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 30378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// create - Return a ExpansionInfo for an expansion. Start and End specify 30478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// the expansion range (where the macro is expanded), and SpellingLoc 30578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// specifies the spelling location (where the characters from the token 30678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// come from). All three can refer to normal File SLocs or expansion 30778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// locations. 30878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static ExpansionInfo create(SourceLocation SpellingLoc, 30978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation Start, SourceLocation End) { 31078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth ExpansionInfo X; 31178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.SpellingLoc = SpellingLoc.getRawEncoding(); 31278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.ExpansionLocStart = Start.getRawEncoding(); 31378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.ExpansionLocEnd = End.getRawEncoding(); 3149dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return X; 3155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 316c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 31778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// createForMacroArg - Return a special ExpansionInfo for the expansion of 31878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// a macro argument into a function-like macro's body. ExpansionLoc 31978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// specifies the expansion location (where the macro is expanded). This 32078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// doesn't need to be a range because a macro is always expanded at 32178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// a macro parameter reference, and macro parameters are always exactly 32278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// one token. SpellingLoc specifies the spelling location (where the 32378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// characters from the token come from). ExpansionLoc and SpellingLoc can 32478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// both refer to normal File SLocs or expansion locations. 325c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// 326c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// Given the code: 327c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// \code 328c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// #define F(x) f(x) 329c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// F(42); 330c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// \endcode 331c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// 33278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// When expanding '\c F(42)', the '\c x' would call this with an 33378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// SpellingLoc pointing at '\c 42' anad an ExpansionLoc pointing at its 33478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// location in the definition of '\c F'. 33578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static ExpansionInfo createForMacroArg(SourceLocation SpellingLoc, 33678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation ExpansionLoc) { 337c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth // We store an intentionally invalid source location for the end of the 33878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // expansion range to mark that this is a macro argument ion rather than 33978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // a normal one. 34078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return create(SpellingLoc, ExpansionLoc, SourceLocation()); 341c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth } 342de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner }; 3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 344de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// SLocEntry - This is a discriminated union of FileInfo and 34578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// ExpansionInfo. SourceManager keeps an array of these objects, and 346de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// they are uniquely identified by the FileID datatype. 347de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner class SLocEntry { 3483201f382956ed9beee9fb31229c2835c1208889cChandler Carruth unsigned Offset; // low bit is set for expansion info. 349de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner union { 350de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileInfo File; 3511728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth ExpansionInfo Expansion; 352de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner }; 353de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner public: 354de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned getOffset() const { return Offset >> 1; } 3551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3561728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth bool isExpansion() const { return Offset & 1; } 3571728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth bool isFile() const { return !isExpansion(); } 3581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 359de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const FileInfo &getFile() const { 360de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert(isFile() && "Not a file SLocEntry!"); 361de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return File; 362de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 363de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 3641728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth const ExpansionInfo &getExpansion() const { 3651728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth assert(isExpansion() && "Not a macro expansion SLocEntry!"); 3661728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth return Expansion; 367de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 369de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SLocEntry get(unsigned Offset, const FileInfo &FI) { 370de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SLocEntry E; 371de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner E.Offset = Offset << 1; 372de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner E.File = FI; 373de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return E; 374de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 375de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 37678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static SLocEntry get(unsigned Offset, const ExpansionInfo &Expansion) { 377de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SLocEntry E; 378de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner E.Offset = (Offset << 1) | 1; 3791728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth E.Expansion = Expansion; 380de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return E; 381de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 3825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 3835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end SrcMgr namespace. 3847f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 3857f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor/// \brief External source of source location entries. 3867f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregorclass ExternalSLocEntrySource { 3877f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregorpublic: 3887f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor virtual ~ExternalSLocEntrySource(); 3897f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 390f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Read the source location entry with index ID, which will always be 391f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// less than -1. 392e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// 393e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// \returns true if an error occurred that prevented the source-location 394e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// entry from being loaded. 395f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor virtual bool ReadSLocEntry(int ID) = 0; 3967f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor}; 3975330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 398dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 399dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner/// IsBeforeInTranslationUnitCache - This class holds the cache used by 400dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner/// isBeforeInTranslationUnit. The cache structure is complex enough to be 401dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner/// worth breaking out of SourceManager. 402dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattnerclass IsBeforeInTranslationUnitCache { 403dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// L/R QueryFID - These are the FID's of the cached query. If these match up 404dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// with a subsequent query, the result can be reused. 405dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner FileID LQueryFID, RQueryFID; 40637e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 40737e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis /// \brief True if LQueryFID was created before RQueryFID. This is used 40837e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis /// to compare macro expansion locations. 40937e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis bool IsLQFIDBeforeRQFID; 41037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 411dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// CommonFID - This is the file found in common between the two #include 412dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// traces. It is the nearest common ancestor of the #include tree. 413dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner FileID CommonFID; 4145330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 415dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// L/R CommonOffset - This is the offset of the previous query in CommonFID. 416dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// Usually, this represents the location of the #include for QueryFID, but if 417dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// LQueryFID is a parent of RQueryFID (or vise versa) then these can be a 418dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// random token in the parent. 419dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner unsigned LCommonOffset, RCommonOffset; 420dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattnerpublic: 4215330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 422dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// isCacheValid - Return true if the currently cached values match up with 423dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// the specified LHS/RHS query. If not, we can't use the cache. 424dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner bool isCacheValid(FileID LHS, FileID RHS) const { 425dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner return LQueryFID == LHS && RQueryFID == RHS; 426dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 4275330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 428dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// getCachedResult - If the cache is valid, compute the result given the 429dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// specified offsets in the LHS/RHS FID's. 430dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner bool getCachedResult(unsigned LOffset, unsigned ROffset) const { 431dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // If one of the query files is the common file, use the offset. Otherwise, 432dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // use the #include loc in the common file. 433dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner if (LQueryFID != CommonFID) LOffset = LCommonOffset; 434dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner if (RQueryFID != CommonFID) ROffset = RCommonOffset; 43537e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 43637e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis // It is common for multiple macro expansions to be "included" from the same 43737e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis // location (expansion location), in which case use the order of the FileIDs 4384d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis // to determine which came first. This will also take care the case where 4394d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis // one of the locations points at the inclusion/expansion point of the other 4404d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis // in which case its FileID will come before the other. 4414d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis if (LOffset == ROffset && 4424d1cbcf6b9aaae7f82c6e332f46b2ad2d8971bd0Argyrios Kyrtzidis (LQueryFID != CommonFID || RQueryFID != CommonFID)) 44337e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis return IsLQFIDBeforeRQFID; 44437e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 445dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner return LOffset < ROffset; 446dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 4475330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 448dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // Set up a new query. 44937e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis void setQueryFIDs(FileID LHS, FileID RHS, bool isLFIDBeforeRFID) { 45037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis assert(LHS != RHS); 451dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner LQueryFID = LHS; 452dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner RQueryFID = RHS; 45337e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis IsLQFIDBeforeRQFID = isLFIDBeforeRFID; 45437e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis } 45537e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 45637e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis void clear() { 45737e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis LQueryFID = RQueryFID = FileID(); 45837e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis IsLQFIDBeforeRQFID = false; 459dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 4605330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 461dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner void setCommonLoc(FileID commonFID, unsigned lCommonOffset, 462dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner unsigned rCommonOffset) { 463dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner CommonFID = commonFID; 464dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner LCommonOffset = lCommonOffset; 465dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner RCommonOffset = rCommonOffset; 466dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 4675330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 468dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner}; 4697f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 470f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// \brief This class handles loading and caching of source files into memory. 471f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// 472f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// This object owns the MemoryBuffer objects for all of the loaded 4735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// files and assigns unique FileID's for each unique #include chain. 4745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 4755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// The SourceManager can be queried for information about SourceLocation 4763201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// objects, turning them into either spelling or expansion locations. Spelling 4773201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// locations represent where the bytes corresponding to a token came from and 4783201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// expansion locations represent where the location is in the user's view. In 4793201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// the case of a macro expansion, for example, the spelling location indicates 4803201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// where the expanded token came from and the expansion location specifies 4813201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// where it was expanded. 4824f32786ac45210143654390177105eb749b614e9Ted Kremenekclass SourceManager : public llvm::RefCountedBase<SourceManager> { 483d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie /// \brief DiagnosticsEngine object. 484d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &Diag; 485389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 486389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileManager &FileMgr; 487389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 4880d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner mutable llvm::BumpPtrAllocator ContentCacheAlloc; 4891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileInfos - Memoized information about all of the files tracked by this 4910d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// SourceManager. This set allows us to merge ContentCache entries based 4920d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// on their FileEntry*. All ContentCache objects will thus have unique, 4931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// non-null, FileEntry pointers. 4940d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> FileInfos; 4951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 496299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// \brief True if the ContentCache for files that are overriden by other 497299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// files, should report the original file name. Defaults to true. 498299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool OverridenFilesKeepOriginalName; 499299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis 500b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \brief Files that have been overriden with the contents from another file. 501b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis llvm::DenseMap<const FileEntry *, const FileEntry *> OverriddenFiles; 502b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 5035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MemBufferInfos - Information about various memory buffers that we have 5040d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// read in. All FileEntry* within the stored ContentCache objects are NULL, 5050d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// as they do not refer to a file. 5060d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner std::vector<SrcMgr::ContentCache*> MemBufferInfos; 5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 508f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The table of SLocEntries that are local to this module. 509f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 510f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Positive FileIDs are indexes into this table. Entry 0 indicates an invalid 5113201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expansion. 512f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor std::vector<SrcMgr::SLocEntry> LocalSLocEntryTable; 513f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 514f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The table of SLocEntries that are loaded from other modules. 515f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 516f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Negative FileIDs are indexes into this table. To get from ID to an index, 517f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// use (-ID - 2). 518f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor std::vector<SrcMgr::SLocEntry> LoadedSLocEntryTable; 5197f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 520f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The starting offset of the next local SLocEntry. 521f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 522f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// This is LocalSLocEntryTable.back().Offset + the size of that entry. 523f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned NextLocalOffset; 524f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 525f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The starting offset of the latest batch of loaded SLocEntries. 526f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 527f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// This is LoadedSLocEntryTable.back().Offset, except that that entry might 528f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// not have been loaded, so that value would be unknown. 529f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned CurrentLoadedOffset; 530f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 531ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// \brief The highest possible offset is 2^31-1, so CurrentLoadedOffset 532ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// starts at 2^31. 533ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis static const unsigned MaxLoadedOffset = 1U << 31U; 534ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis 535f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief A bitmap that indicates whether the entries of LoadedSLocEntryTable 536f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// have already been loaded from the external source. 537f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 538f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Same indexing as LoadedSLocEntryTable. 5397f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor std::vector<bool> SLocEntryLoaded; 5407f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 5417f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor /// \brief An external source for source location entries. 5427f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor ExternalSLocEntrySource *ExternalSLocEntries; 5437f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 544de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// LastFileIDLookup - This is a one-entry cache to speed up getFileID. 545de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// LastFileIDLookup records the last FileID looked up or created, because it 546de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// is very common to look up many tokens from the same file. 547de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner mutable FileID LastFileIDLookup; 5481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5495b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner /// LineTable - This holds information for #line directives. It is referenced 5505b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner /// by indices from SLocEntryTable. 5515b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner LineTableInfo *LineTable; 5521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5535e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner /// LastLineNo - These ivars serve as a cache used in the getLineNumber 5545e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner /// method which is used to speedup getLineNumber calls to nearby locations. 5552b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner mutable FileID LastLineNoFileIDQuery; 556f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable SrcMgr::ContentCache *LastLineNoContentCache; 557f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable unsigned LastLineNoFilePos; 558f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable unsigned LastLineNoResult; 5591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56076edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek /// MainFileID - The file ID for the main source file of the translation unit. 5612b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID MainFileID; 56249c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff 563507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief The file ID for the precompiled preamble there is one. 564507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis FileID PreambleFileID; 565507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 566de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // Statistics for -print-stats. 567de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner mutable unsigned NumLinearScans, NumBinaryProbes; 5681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5692aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis // Cache results for the isBeforeInTranslationUnit method. 570dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner mutable IsBeforeInTranslationUnitCache IsBeforeInTUCache; 5711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 572e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor // Cache for the "fake" buffer used for error-recovery purposes. 573e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor mutable llvm::MemoryBuffer *FakeBufferForRecovery; 5745330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 575fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis /// \brief Lazily computed map of macro argument chunks to their expanded 576fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis /// source location. 577fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis typedef std::map<unsigned, SourceLocation> MacroArgsMap; 578fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis 57970042f5d1ca378138f90b7b9384023701f5d03d8David Blaikie mutable llvm::DenseMap<FileID, MacroArgsMap *> MacroArgsCacheMap; 580fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis 58149c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff // SourceManager doesn't support copy construction. 58249c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff explicit SourceManager(const SourceManager&); 5831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void operator=(const SourceManager&); 5845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 585d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr); 5865b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner ~SourceManager(); 5871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5885b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner void clearIDTables(); 5891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 590d6471f7c1921c7802804ce3ff6fe9768310f72b9David Blaikie DiagnosticsEngine &getDiagnostics() const { return Diag; } 59178a916ec5ff5b66adec3c499e1b9af7b87668309Argyrios Kyrtzidis 592389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileManager &getFileManager() const { return FileMgr; } 593389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 594299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// \brief Set true if the SourceManager should report the original file name 595299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// for contents of files that were overriden by other files.Defaults to true. 596299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis void setOverridenFilesKeepOriginalName(bool value) { 597299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis OverridenFilesKeepOriginalName = value; 598299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis } 599299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis 600f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// createMainFileIDForMembuffer - Create the FileID for a memory buffer 601f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// that will represent the FileID for the main source. One example 602f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// of when this would be used is when the main source is read from STDIN. 603f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID createMainFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer) { 604f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(MainFileID.isInvalid() && "MainFileID already set!"); 605f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor MainFileID = createFileIDForMemBuffer(Buffer); 606f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return MainFileID; 607f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 608f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 60906a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 61006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // MainFileID creation and querying methods. 61106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 61206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner 61376edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek /// getMainFileID - Returns the FileID of the main source file. 6142b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID getMainFileID() const { return MainFileID; } 6151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 61606a062dc784c609b75dca15fd97f468d0d846596Chris Lattner /// createMainFileID - Create the FileID for the main source file. 617f155dfa4e284be7dca8f1abf002476b2aaee8546Dan Gohman FileID createMainFileID(const FileEntry *SourceFile) { 61806a062dc784c609b75dca15fd97f468d0d846596Chris Lattner assert(MainFileID.isInvalid() && "MainFileID already set!"); 619f155dfa4e284be7dca8f1abf002476b2aaee8546Dan Gohman MainFileID = createFileID(SourceFile, SourceLocation(), SrcMgr::C_User); 62006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner return MainFileID; 62106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 6221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 623507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Set the file ID for the precompiled preamble. 624507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis void setPreambleFileID(FileID Preamble) { 625507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis assert(PreambleFileID.isInvalid() && "PreambleFileID already set!"); 626507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis PreambleFileID = Preamble; 627414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor } 6285330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 629507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis /// \brief Get the file ID for the precompiled preamble if there is one. 630507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis FileID getPreambleFileID() const { return PreambleFileID; } 631507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis 63206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 6333201f382956ed9beee9fb31229c2835c1208889cChandler Carruth // Methods to create new FileID's and macro expansions. 63406a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 6351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// createFileID - Create a new FileID that represents the specified file 637d57b7ff9bebc4c45f325fc1be6f238cfcd4c3732Peter Collingbourne /// being #included from the specified IncludePosition. This translates NULL 638d57b7ff9bebc4c45f325fc1be6f238cfcd4c3732Peter Collingbourne /// into standard input. 6392b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos, 6407f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor SrcMgr::CharacteristicKind FileCharacter, 641f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor int LoadedID = 0, unsigned LoadedOffset = 0) { 642de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile); 6430d06e998910934e5ef070f53f4c272e7c6b846c6Dan Gohman assert(IR && "getOrCreateContentCache() cannot return NULL"); 644f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return createFileID(IR, IncludePos, FileCharacter, LoadedID, LoadedOffset); 6455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// createFileIDForMemBuffer - Create a new FileID that represents the 6485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// specified memory buffer. This does no caching of the buffer and takes 6495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ownership of the MemoryBuffer, so only pass a MemoryBuffer to this once. 6507f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor FileID createFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer, 651f453cb9f677e16c00b358ec91eccf5f003765dc6Axel Naumann int LoadedID = 0, unsigned LoadedOffset = 0, 652f453cb9f677e16c00b358ec91eccf5f003765dc6Axel Naumann SourceLocation IncludeLoc = SourceLocation()) { 653f453cb9f677e16c00b358ec91eccf5f003765dc6Axel Naumann return createFileID(createMemBufferContentCache(Buffer), IncludeLoc, 654f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor SrcMgr::C_User, LoadedID, LoadedOffset); 6551036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek } 65606a062dc784c609b75dca15fd97f468d0d846596Chris Lattner 657bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// createMacroArgExpansionLoc - Return a new SourceLocation that encodes the 658bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// fact that a token from SpellingLoc should actually be referenced from 6593201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// ExpansionLoc, and that it represents the expansion of a macro argument 6603201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// into the function-like macro body. 661bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation createMacroArgExpansionLoc(SourceLocation Loc, 662bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLoc, 663bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength); 664c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 665bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// createExpansionLoc - Return a new SourceLocation that encodes the fact 666c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// that a token from SpellingLoc should actually be referenced from 667bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// ExpansionLoc. 668bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation createExpansionLoc(SourceLocation Loc, 669bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLocStart, 670bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLocEnd, 671bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength, 672bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth int LoadedID = 0, 673bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned LoadedOffset = 0); 6741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6752968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Retrieve the memory buffer associated with the given file. 67650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 67750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error 67850f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// occurs while retrieving the memory buffer. 67950f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor const llvm::MemoryBuffer *getMemoryBufferForFile(const FileEntry *File, 68050f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0); 6812968442603b029949246467253eeac8139a5b6d8Douglas Gregor 6822968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Override the contents of the given source file by providing an 6832968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// already-allocated buffer. 6842968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 685afbf5f810652f04c0bba235c0fa079885fb3caa8Dan Gohman /// \param SourceFile the source file whose contents will be overriden. 6862968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6872968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Buffer the memory buffer whose contents will be used as the 6882968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// data in the given source file. 6892968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 690f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \param DoNotFree If true, then the buffer will not be freed when the 691f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// source manager is destroyed. 6920d06e998910934e5ef070f53f4c272e7c6b846c6Dan Gohman void overrideFileContents(const FileEntry *SourceFile, 693f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor const llvm::MemoryBuffer *Buffer, 694f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool DoNotFree = false); 6952968442603b029949246467253eeac8139a5b6d8Douglas Gregor 696b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \brief Override the the given source file with another one. 697b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// 698b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \param SourceFile the source file which will be overriden. 699b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// 700b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \param NewFile the file whose contents will be used as the 701b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// data instead of the contents of the given source file. 702b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis void overrideFileContents(const FileEntry *SourceFile, 703b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *NewFile); 704b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 70506a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 70606a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // FileID manipulation methods. 70706a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 7081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7092ffb14f004affc363d86d6c7c63c356190db3679Daniel Dunbar /// getBuffer - Return the buffer for the specified FileID. If there is an 7102ffb14f004affc363d86d6c7c63c356190db3679Daniel Dunbar /// error opening this buffer the first time, this manufactures a temporary 7112ffb14f004affc363d86d6c7c63c356190db3679Daniel Dunbar /// buffer and returns a non-empty error string. 712e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const llvm::MemoryBuffer *getBuffer(FileID FID, SourceLocation Loc, 713e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner bool *Invalid = 0) const { 714e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 715e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 716e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) { 717e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid) 718e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor *Invalid = true; 7195330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 720e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return getFakeBufferForRecovery(); 721e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor } 7225330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 7235330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher return Entry.getFile().getContentCache()->getBuffer(Diag, *this, Loc, 724e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor Invalid); 72506a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 7261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 727e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const llvm::MemoryBuffer *getBuffer(FileID FID, bool *Invalid = 0) const { 728e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 729e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 730e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) { 731e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid) 732e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor *Invalid = true; 7335330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 734e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return getFakeBufferForRecovery(); 735e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor } 736e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 7375330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher return Entry.getFile().getContentCache()->getBuffer(Diag, *this, 7385330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher SourceLocation(), 739e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor Invalid); 740e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner } 7415330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 74206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner /// getFileEntryForID - Returns the FileEntry record for the provided FileID. 74306a062dc784c609b75dca15fd97f468d0d846596Chris Lattner const FileEntry *getFileEntryForID(FileID FID) const { 744e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 745e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 746e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) 747e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return 0; 7485330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 749e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return Entry.getFile().getContentCache()->OrigEntry; 75006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 7511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7529d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek /// Returns the FileEntry record for the provided SLocEntry. 7539d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek const FileEntry *getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const 7549d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek { 7559d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek return sloc.getFile().getContentCache()->OrigEntry; 7569d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek } 7579d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek 758ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// getBufferData - Return a StringRef to the source buffer data for the 759ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// specified FileID. 760ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// 761f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor /// \param FID The file ID whose contents will be returned. 762f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor /// \param Invalid If non-NULL, will be set true if an error occurred. 763686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getBufferData(FileID FID, bool *Invalid = 0) const; 764f6ac97b101c8840efa92bf29166077ce4049e293Benjamin Kramer 765d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Get the number of FileIDs (files and macros) that were created 766d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// during preprocessing of \arg FID, including it. 767d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis unsigned getNumCreatedFIDsForFileID(FileID FID) const { 768d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 769d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 770d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 771d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return 0; 772d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 773d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return Entry.getFile().NumCreatedFIDs; 774d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 775d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 776d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Set the number of FileIDs (files and macros) that were created 777d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// during preprocessing of \arg FID, including it. 778d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs) const { 779d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 780d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 781d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 782d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return; 783d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 784d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis assert(Entry.getFile().NumCreatedFIDs == 0 && "Already set!"); 785d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const_cast<SrcMgr::FileInfo &>(Entry.getFile()).NumCreatedFIDs = NumFIDs; 786d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 7871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 78806a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 78906a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // SourceLocation manipulation methods. 79006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 7911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 792668ab1a36d6a5731c71a75a5f388ecafd538a896Chris Lattner /// getFileID - Return the FileID for a SourceLocation. This is a very 793de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// hot method that is used for all SourceManager queries that start with a 794de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// SourceLocation object. It is responsible for finding the entry in 795de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// SLocEntryTable which contains the specified location. 796de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// 797de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID getFileID(SourceLocation SpellingLoc) const { 798de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned SLocOffset = SpellingLoc.getOffset(); 7991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 800de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // If our one-entry cache covers this offset, just return it. 801de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (isOffsetInFileID(LastFileIDLookup, SLocOffset)) 802de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return LastFileIDLookup; 803de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 804de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getFileIDSlow(SLocOffset); 805de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 8061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8072b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// getLocForStartOfFile - Return the source location corresponding to the 8082b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// first byte of the specified file. 8092b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation getLocForStartOfFile(FileID FID) const { 810e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool Invalid = false; 811e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 812e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid || !Entry.isFile()) 813e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return SourceLocation(); 8145330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 815e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor unsigned FileOffset = Entry.getOffset(); 816de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFileLoc(FileOffset); 8172b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 818f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 819f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis /// \brief Return the source location corresponding to the last byte of the 820f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis /// specified file. 821f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis SourceLocation getLocForEndOfFile(FileID FID) const { 822f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis bool Invalid = false; 823f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 824f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 825f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis return SourceLocation(); 826f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis 827f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis unsigned FileOffset = Entry.getOffset(); 828f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis return SourceLocation::getFileLoc(FileOffset + getFileIDSize(FID) - 1); 829f226ff9fe8c8db6c5b74a61ce649eda1491c3502Argyrios Kyrtzidis } 8301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 831d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Returns the include location if \arg FID is a #include'd file 832d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// otherwise it returns an invalid location. 833d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis SourceLocation getIncludeLoc(FileID FID) const { 834d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 835d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 836d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 837d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return SourceLocation(); 8385330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 839d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return Entry.getFile().getIncludeLoc(); 840d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 841d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 842402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth /// getExpansionLoc - Given a SourceLocation object, return the expansion 843402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth /// location referenced by the ID. 844402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation getExpansionLoc(SourceLocation Loc) const { 845addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner // Handle the non-mapped case inline, defer to out of line code to handle 846402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth // expansions. 847de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) return Loc; 848f84ef95ecec34f27fd05eb4e0392ca6bd3bd0be0Chandler Carruth return getExpansionLocSlowCase(Loc); 849de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 8501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 851796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis /// \brief Given \arg Loc, if it is a macro location return the expansion 852796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis /// location or the spelling location, depending on if it comes from a 853796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis /// macro argument or not. 854796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis SourceLocation getFileLoc(SourceLocation Loc) const { 855796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis if (Loc.isFileID()) return Loc; 856796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis return getFileLocSlowCase(Loc); 857796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis } 858796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis 859999f739404edf2078cf9f9c28b4dc45c19765842Chandler Carruth /// getImmediateExpansionRange - Loc is required to be an expansion location. 860999f739404edf2078cf9f9c28b4dc45c19765842Chandler Carruth /// Return the start/end of the expansion information. 861e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner std::pair<SourceLocation,SourceLocation> 862999f739404edf2078cf9f9c28b4dc45c19765842Chandler Carruth getImmediateExpansionRange(SourceLocation Loc) const; 8631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 864edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth /// getExpansionRange - Given a SourceLocation object, return the range of 865edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth /// tokens covered by the expansion the ultimate file. 8666678133b8ce642f93e5141f056fa643112041ad0Chris Lattner std::pair<SourceLocation,SourceLocation> 867edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth getExpansionRange(SourceLocation Loc) const; 8681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 870de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getSpellingLoc - Given a SourceLocation object, return the spelling 871de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// location referenced by the ID. This is the place where the characters 872de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// that make up the lexed token can be found. 873de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getSpellingLoc(SourceLocation Loc) const { 874addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner // Handle the non-mapped case inline, defer to out of line code to handle 8753201f382956ed9beee9fb31229c2835c1208889cChandler Carruth // expansions. 876de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) return Loc; 877addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner return getSpellingLocSlowCase(Loc); 878de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 8791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 880387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// getImmediateSpellingLoc - Given a SourceLocation object, return the 881387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// spelling location referenced by the ID. This is the first level down 882387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// towards the place where the characters that make up the lexed token can be 883387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// found. This should not generally be used by clients. 8841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const; 885de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 886de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getDecomposedLoc - Decompose the specified location into a raw FileID + 887de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// Offset pair. The first element is the FileID, the second is the 888de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// offset from the start of the buffer of the location. 889de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> getDecomposedLoc(SourceLocation Loc) const { 890de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 891a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis bool Invalid = false; 892a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis const SrcMgr::SLocEntry &E = getSLocEntry(FID, &Invalid); 893a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis if (Invalid) 894a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FileID(), 0); 895a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FID, Loc.getOffset()-E.getOffset()); 896de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 8971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8983201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// getDecomposedExpansionLoc - Decompose the specified location into a raw 8993201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// FileID + Offset pair. If the location is an expansion record, walk 9003201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// through it until we find the final location expanded. 901de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 902e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth getDecomposedExpansionLoc(SourceLocation Loc) const { 903de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 904a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis bool Invalid = false; 905a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid); 906a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis if (Invalid) 907a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FileID(), 0); 9081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 909de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset = Loc.getOffset()-E->getOffset(); 910de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) 911de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return std::make_pair(FID, Offset); 9121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 913e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth return getDecomposedExpansionLocSlowCase(E); 914de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 915de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 916de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getDecomposedSpellingLoc - Decompose the specified location into a raw 9173201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// FileID + Offset pair. If the location is an expansion record, walk 918de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// through it until we find its spelling record. 919de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 920de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getDecomposedSpellingLoc(SourceLocation Loc) const { 921de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 922a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis bool Invalid = false; 923a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis const SrcMgr::SLocEntry *E = &getSLocEntry(FID, &Invalid); 924a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis if (Invalid) 925a246d270156a55999ecfa4099a0967ec4c9a254eArgyrios Kyrtzidis return std::make_pair(FileID(), 0); 9261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 927de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset = Loc.getOffset()-E->getOffset(); 928de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) 929de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return std::make_pair(FID, Offset); 930de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getDecomposedSpellingLocSlowCase(E, Offset); 9311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 93352c29081281955d3db9e11d10573b2d38f709099Chris Lattner /// getFileOffset - This method returns the offset from the start 93452c29081281955d3db9e11d10573b2d38f709099Chris Lattner /// of the file that the specified SourceLocation represents. This is not very 93552c29081281955d3db9e11d10573b2d38f709099Chris Lattner /// meaningful for a macro ID. 93652c29081281955d3db9e11d10573b2d38f709099Chris Lattner unsigned getFileOffset(SourceLocation SpellingLoc) const { 937de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getDecomposedLoc(SpellingLoc).second; 9385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 9391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 94096d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// isMacroArgExpansion - This method tests whether the given source location 94196d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// represents a macro argument's expansion into the function-like macro 94296d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// definition. Such source locations only appear inside of the expansion 94396d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// locations representing where a particular function-like macro was 94496d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// expanded. 94596d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth bool isMacroArgExpansion(SourceLocation Loc) const; 9461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 947499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// \brief Returns true if \arg Loc is inside the [\arg Start, +\arg Length) 948499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// chunk of the source location address space. 949499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// If it's true and \arg RelativeOffset is non-null, it will be set to the 950499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// relative offset of \arg Loc inside the chunk. 951499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis bool isInSLocAddrSpace(SourceLocation Loc, 952499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis SourceLocation Start, unsigned Length, 953499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned *RelativeOffset = 0) const { 954499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis assert(((Start.getOffset() < NextLocalOffset && 955499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis Start.getOffset()+Length <= NextLocalOffset) || 956499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis (Start.getOffset() >= CurrentLoadedOffset && 957499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis Start.getOffset()+Length < MaxLoadedOffset)) && 958499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis "Chunk is not valid SLoc address space"); 959499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned LocOffs = Loc.getOffset(); 960499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned BeginOffs = Start.getOffset(); 961499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned EndOffs = BeginOffs + Length; 962499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis if (LocOffs >= BeginOffs && LocOffs < EndOffs) { 963499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis if (RelativeOffset) 964499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis *RelativeOffset = LocOffs - BeginOffs; 965499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis return true; 966499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis } 967499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis 968499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis return false; 969499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis } 970499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis 971b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis /// \brief Return true if both \arg LHS and \arg RHS are in the local source 972b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis /// location address space or the loaded one. If it's true and 973b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis /// \arg RelativeOffset is non-null, it will be set to the offset of \arg RHS 974b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis /// relative to \arg LHS. 975b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis bool isInSameSLocAddrSpace(SourceLocation LHS, SourceLocation RHS, 976b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis int *RelativeOffset) const { 977b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis unsigned LHSOffs = LHS.getOffset(), RHSOffs = RHS.getOffset(); 978b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis bool LHSLoaded = LHSOffs >= CurrentLoadedOffset; 979b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis bool RHSLoaded = RHSOffs >= CurrentLoadedOffset; 980b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis 981b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis if (LHSLoaded == RHSLoaded) { 982b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis if (RelativeOffset) 983b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis *RelativeOffset = RHSOffs - LHSOffs; 984b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis return true; 985b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis } 986b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis 987b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis return false; 988b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis } 989b6c465e17ec37390667223a18a340e8652c212ffArgyrios Kyrtzidis 990de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner //===--------------------------------------------------------------------===// 991de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // Queries about the code at a SourceLocation. 992de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner //===--------------------------------------------------------------------===// 9931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getCharacterData - Return a pointer to the start of the specified location 995de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// in the appropriate spelling MemoryBuffer. 99650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 99750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error occurs. 99850f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor const char *getCharacterData(SourceLocation SL, bool *Invalid = 0) const; 9991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10009dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getColumnNumber - Return the column # for the specified file position. 10019dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// This is significantly cheaper to compute than the line number. This 10023201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// returns zero if the column number isn't known. This may only be called 10033201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// on a file sloc, so you must choose a spelling or expansion location 1004f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner /// before calling this method. 10055330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher unsigned getColumnNumber(FileID FID, unsigned FilePos, 100650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const; 10075ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getSpellingColumnNumber(SourceLocation Loc, bool *Invalid = 0) const; 1008a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth unsigned getExpansionColumnNumber(SourceLocation Loc, 1009b49dcd249c7f4f034493741f95394987a4ccf244Chandler Carruth bool *Invalid = 0) const; 10105ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getPresumedColumnNumber(SourceLocation Loc, bool *Invalid = 0) const; 10111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1013df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner /// getLineNumber - Given a SourceLocation, return the spelling line number 10145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// for the position indicated. This requires building and caching a table of 10155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// line offsets for the MemoryBuffer, so this is not cheap: use only when 10165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// about to emit a diagnostic. 101750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid = 0) const; 10185ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 1019642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 10205ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 10211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1022bff5c512af8ca7ac92e974e04c06ff4f820e4ee1Chris Lattner /// Return the filename or buffer identifier of the buffer the location is in. 1023bff5c512af8ca7ac92e974e04c06ff4f820e4ee1Chris Lattner /// Note that this name does not respect #line directives. Use getPresumedLoc 1024bff5c512af8ca7ac92e974e04c06ff4f820e4ee1Chris Lattner /// for normal clients. 102550f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor const char *getBufferName(SourceLocation Loc, bool *Invalid = 0) const; 10261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10276b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// getFileCharacteristic - return the file characteristic of the specified 10281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// source location, indicating whether this is a normal file, a system 10296b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// header, or an "implicit extern C" system header. 10306b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// 10316b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// This state can be modified with flags on GNU linemarker directives like: 10326b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// # 4 "foo.h" 3 10336b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// which changes all source locations in the current file after that to be 10346b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// considered to be from a system header. 10356b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const; 10361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1037b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getPresumedLoc - This method returns the "presumed" location of a 1038b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// SourceLocation specifies. A "presumed location" can be modified by #line 1039b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// or GNU line marker directives. This provides a view on the data that a 1040b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// user should see in diagnostics, for example. 1041b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// 10423201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// Note that a presumed location is always given as the expansion point of 10433201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// an expansion location, not at the spelling location. 1044cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// 1045cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// \returns The presumed location of the specified SourceLocation. If the 1046cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// presumed location cannot be calculate (e.g., because \p Loc is invalid 1047cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// or the file containing \p Loc has changed on disk), returns an invalid 1048cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// presumed location. 1049b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc getPresumedLoc(SourceLocation Loc) const; 10501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10519fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// isFromSameFile - Returns true if both SourceLocations correspond to 10529fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// the same file. 10539fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek bool isFromSameFile(SourceLocation Loc1, SourceLocation Loc2) const { 1054a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner return getFileID(Loc1) == getFileID(Loc2); 10559fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek } 10561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10579fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// isFromMainFile - Returns true if the file of provided SourceLocation is 10589fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// the main file. 10599fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek bool isFromMainFile(SourceLocation Loc) const { 1060a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner return getFileID(Loc) == getMainFileID(); 10611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 10621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10637bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber /// isInSystemHeader - Returns if a SourceLocation is in a system header. 10647bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader(SourceLocation Loc) const { 10650b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner return getFileCharacteristic(Loc) != SrcMgr::C_User; 1066721818304ac462d8c6ce05eecd02884033db78f1Chris Lattner } 10671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10680d456588acac0713a7c33063922d35a8cc8c658eChris Lattner /// isInExternCSystemHeader - Returns if a SourceLocation is in an "extern C" 10690d456588acac0713a7c33063922d35a8cc8c658eChris Lattner /// system header. 10700d456588acac0713a7c33063922d35a8cc8c658eChris Lattner bool isInExternCSystemHeader(SourceLocation Loc) const { 10710d456588acac0713a7c33063922d35a8cc8c658eChris Lattner return getFileCharacteristic(Loc) == SrcMgr::C_ExternCSystem; 10720d456588acac0713a7c33063922d35a8cc8c658eChris Lattner } 10731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 107454232ade44d31e98ea83f43ca066128e315dcbdaArgyrios Kyrtzidis /// \brief The size of the SLocEnty that \arg FID represents. 1075984e42ca1ff7775ce39372c314f1cb7d6862c4c7Argyrios Kyrtzidis unsigned getFileIDSize(FileID FID) const; 107654232ade44d31e98ea83f43ca066128e315dcbdaArgyrios Kyrtzidis 1077d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis /// \brief Given a specific FileID, returns true if \arg Loc is inside that 1078d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis /// FileID chunk and sets relative offset (offset of \arg Loc from beginning 1079d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis /// of FileID) to \arg relativeOffset. 1080d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis bool isInFileID(SourceLocation Loc, FileID FID, 1081d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis unsigned *RelativeOffset = 0) const { 1082d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis unsigned Offs = Loc.getOffset(); 1083d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis if (isOffsetInFileID(FID, Offs)) { 1084d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis if (RelativeOffset) 1085d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis *RelativeOffset = Offs - getSLocEntry(FID).getOffset(); 1086d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis return true; 1087d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis } 1088d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis 1089d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis return false; 1090d7cb46c316808169679a8d72c69f02a1e55d78a8Argyrios Kyrtzidis } 1091469244a322dd5d35cee1d02d70a2edbc12ac5ce7Argyrios Kyrtzidis 109206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 10935b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner // Line Table Manipulation Routines 10945b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner //===--------------------------------------------------------------------===// 10951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10965b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner /// getLineTableFilenameID - Return the uniqued ID for the specified filename. 10971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 1098686775deca8b8685eb90801495880e3abdd844c2Chris Lattner unsigned getLineTableFilenameID(StringRef Str); 10991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11004c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner /// AddLineNote - Add a line note to the line table for the FileID and offset 11014c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner /// specified by Loc. If FilenameID is -1, it is considered to be 11024c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner /// unspecified. 11034c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID); 11049d79ebac47ffde6a1cb312f4c09b66b1b9a397fbChris Lattner void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID, 11051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool IsFileEntry, bool IsFileExit, 11069d79ebac47ffde6a1cb312f4c09b66b1b9a397fbChris Lattner bool IsSystemHeader, bool IsExternCHeader); 1107bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1108bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor /// \brief Determine if the source manager has a line table. 1109bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor bool hasLineTable() const { return LineTable != 0; } 1110bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1111bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor /// \brief Retrieve the stored line table. 1112bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor LineTableInfo &getLineTable(); 1113bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 11145b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner //===--------------------------------------------------------------------===// 1115457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek // Queries for performance analysis. 1116457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek //===--------------------------------------------------------------------===// 1117457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek 1118457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek /// Return the total amount of physical memory allocated by the 1119457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek /// ContentCache allocator. 1120457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek size_t getContentCacheSize() const { 1121457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek return ContentCacheAlloc.getTotalMemory(); 1122457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek } 11235330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1124f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek struct MemoryBufferSizes { 1125f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek const size_t malloc_bytes; 1126f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek const size_t mmap_bytes; 11275330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1128f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes) 1129f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek : malloc_bytes(malloc_bytes), mmap_bytes(mmap_bytes) {} 1130f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek }; 1131f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek 1132f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// Return the amount of memory used by memory buffers, breaking down 1133f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// by heap-backed versus mmap'ed memory. 1134f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek MemoryBufferSizes getMemoryBufferSizes() const; 11355330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1136ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek // Return the amount of memory used for various side tables and 1137ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek // data structures in the SourceManager. 1138ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek size_t getDataStructureSizes() const; 1139457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek 1140457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek //===--------------------------------------------------------------------===// 114106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // Other miscellaneous methods. 114206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 114310b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis 114410b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 114510b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// 114610b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// If the source file is included multiple times, the source location will 114710b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// be based upon the first inclusion. 1148ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis SourceLocation translateFileLineCol(const FileEntry *SourceFile, 1149507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 1150ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis 1151b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// \brief Get the FileID for the given file. 1152b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// 1153b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// If the source file is included multiple times, the FileID will be the 1154b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis /// first inclusion. 1155b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis FileID translateFile(const FileEntry *SourceFile) const; 1156b201e16e0c331b0bdeae7b30f9f79aae32beb1b2Argyrios Kyrtzidis 1157efa2ff8603dae51f5f5ed7509a503f477498ad22Argyrios Kyrtzidis /// \brief Get the source location in \arg FID for the given line:col. 1158efa2ff8603dae51f5f5ed7509a503f477498ad22Argyrios Kyrtzidis /// Returns null location if \arg FID is not a file SLocEntry. 1159507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation translateLineCol(FileID FID, 1160507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis unsigned Line, unsigned Col) const; 1161efa2ff8603dae51f5f5ed7509a503f477498ad22Argyrios Kyrtzidis 1162ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// \brief If \arg Loc points inside a function macro argument, the returned 1163ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// location will be the macro location in which the argument was expanded. 1164ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// If a macro argument is used multiple times, the expanded location will 1165ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// be at the first expansion of the argument. 1166ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// e.g. 1167ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// MY_MACRO(foo); 1168ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// ^ 1169ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// Passing a file location pointing at 'foo', will yield a macro location 1170ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// where 'foo' was expanded into. 1171507097ec40105ed927cb5a744fad98f5875aacacArgyrios Kyrtzidis SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const; 11721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 11732aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the translation unit. 11742aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// 11752aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// \returns true if LHS source location comes before RHS, false otherwise. 11762aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const; 11772aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis 1178aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis /// \brief Comparison function class. 1179aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis class LocBeforeThanCompare : public std::binary_function<SourceLocation, 1180aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis SourceLocation, bool> { 1181aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis SourceManager &SM; 1182aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis 1183aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis public: 1184aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis explicit LocBeforeThanCompare(SourceManager &SM) : SM(SM) { } 1185aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis 1186aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis bool operator()(SourceLocation LHS, SourceLocation RHS) const { 1187aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis return SM.isBeforeInTranslationUnit(LHS, RHS); 1188aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis } 1189aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis }; 1190aec230d29835285777ecc467e268c83b33a2addeArgyrios Kyrtzidis 1191b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the "source location 1192b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// address space". 11935d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const { 11945d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis return isBeforeInSLocAddrSpace(LHS, RHS.getOffset()); 1195b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis } 1196b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 1197b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// \brief Determines the order of a source location and a source location 1198b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// offset in the "source location address space". 1199f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 12005330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher /// Note that we always consider source locations loaded from 12015d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis bool isBeforeInSLocAddrSpace(SourceLocation LHS, unsigned RHS) const { 1202f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned LHSOffset = LHS.getOffset(); 1203f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool LHSLoaded = LHSOffset >= CurrentLoadedOffset; 1204f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool RHSLoaded = RHS >= CurrentLoadedOffset; 1205f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (LHSLoaded == RHSLoaded) 12065d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis return LHSOffset < RHS; 12075330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1208f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LHSLoaded; 1209b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis } 1210b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 1211c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner // Iterators over FileInfos. 12120d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner typedef llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> 12130d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner ::const_iterator fileinfo_iterator; 1214c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner fileinfo_iterator fileinfo_begin() const { return FileInfos.begin(); } 1215c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner fileinfo_iterator fileinfo_end() const { return FileInfos.end(); } 1216d93256e55673a17d18543397ec462416acb13792Douglas Gregor bool hasFileInfo(const FileEntry *File) const { 1217d93256e55673a17d18543397ec462416acb13792Douglas Gregor return FileInfos.find(File) != FileInfos.end(); 1218d93256e55673a17d18543397ec462416acb13792Douglas Gregor } 1219c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner 12205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PrintStats - Print statistics to stderr. 12215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 12225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats() const; 122378d85f53b093867bbb0123f016956178eea7343eTed Kremenek 1224f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the number of local SLocEntries we have. 1225f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned local_sloc_entry_size() const { return LocalSLocEntryTable.size(); } 12265330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1227f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get a local SLocEntry. This is exposed for indexing. 12285330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher const SrcMgr::SLocEntry &getLocalSLocEntry(unsigned Index, 1229f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool *Invalid = 0) const { 1230f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(Index < LocalSLocEntryTable.size() && "Invalid index"); 1231f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LocalSLocEntryTable[Index]; 1232bdfe48ac80573e026595af91e541474dbf02565fDouglas Gregor } 12335330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1234f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the number of loaded SLocEntries we have. 1235f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned loaded_sloc_entry_size() const { return LoadedSLocEntryTable.size();} 12365330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1237f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get a loaded SLocEntry. This is exposed for indexing. 123870042f5d1ca378138f90b7b9384023701f5d03d8David Blaikie const SrcMgr::SLocEntry &getLoadedSLocEntry(unsigned Index, 123970042f5d1ca378138f90b7b9384023701f5d03d8David Blaikie bool *Invalid = 0) const { 1240f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(Index < LoadedSLocEntryTable.size() && "Invalid index"); 1241f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (!SLocEntryLoaded[Index]) 1242f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor ExternalSLocEntries->ReadSLocEntry(-(static_cast<int>(Index) + 2)); 1243f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LoadedSLocEntryTable[Index]; 1244f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 12455330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1246e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &getSLocEntry(FileID FID, bool *Invalid = 0) const { 1247c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis if (FID.ID == 0 || FID.ID == -1) { 1248c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis if (Invalid) *Invalid = true; 1249c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis return LocalSLocEntryTable[0]; 1250c705d2520a51de1dc38d36efada8e9bc2d8b0d1fArgyrios Kyrtzidis } 1251f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getSLocEntryByID(FID.ID); 1252bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor } 1253bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1254f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned getNextLocalOffset() const { return NextLocalOffset; } 12555330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1256f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor void setExternalSLocEntrySource(ExternalSLocEntrySource *Source) { 1257f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(LoadedSLocEntryTable.empty() && 1258f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor "Invalidating existing loaded entries"); 1259f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor ExternalSLocEntries = Source; 1260f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 12615330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1262f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Allocate a number of loaded SLocEntries, which will be actually 1263f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// loaded on demand from the external source. 1264f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 1265f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// NumSLocEntries will be allocated, which occupy a total of TotalSize space 1266f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// in the global source view. The lowest ID and the base offset of the 1267f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// entries will be returned. 1268f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor std::pair<int, unsigned> 1269f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor AllocateLoadedSLocEntries(unsigned NumSLocEntries, unsigned TotalSize); 12705330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1271aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis /// \brief Returns true if \arg Loc came from a PCH/Module. 1272aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis bool isLoadedSourceLocation(SourceLocation Loc) const { 1273aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis return Loc.getOffset() >= CurrentLoadedOffset; 1274aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis } 1275aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis 1276aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis /// \brief Returns true if \arg Loc did not come from a PCH/Module. 1277aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis bool isLocalSourceLocation(SourceLocation Loc) const { 1278aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis return Loc.getOffset() < NextLocalOffset; 1279aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis } 1280aa6edaeb35e02a07bd4840c0159900754f083ce5Argyrios Kyrtzidis 1281718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis /// \brief Returns true if \arg FID came from a PCH/Module. 1282718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis bool isLoadedFileID(FileID FID) const { 1283718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis assert(FID.ID != -1 && "Using FileID sentinel value"); 1284718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis return FID.ID < 0; 1285718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis } 1286718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis 1287718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis /// \brief Returns true if \arg FID did not come from a PCH/Module. 1288718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis bool isLocalFileID(FileID FID) const { 1289718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis return !isLoadedFileID(FID); 1290718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis } 1291718699169a7ccaf623e375031789efeed82f869bArgyrios Kyrtzidis 12925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 1293e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const llvm::MemoryBuffer *getFakeBufferForRecovery() const; 1294e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 1295f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the entry with the given unwrapped FileID. 1296f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor const SrcMgr::SLocEntry &getSLocEntryByID(int ID) const { 1297f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(ID != -1 && "Using FileID sentinel value"); 1298f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (ID < 0) 1299f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getLoadedSLocEntryByID(ID); 1300f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getLocalSLocEntry(static_cast<unsigned>(ID)); 1301f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 13025330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1303f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor const SrcMgr::SLocEntry &getLoadedSLocEntryByID(int ID) const { 1304f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getLoadedSLocEntry(static_cast<unsigned>(-ID - 2)); 1305f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 13065330ee071743b8a896aa46979b020e6c3ca9b1ccEric Christopher 1307bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// createExpansionLoc - Implements the common elements of storing an 13083201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expansion info struct into the SLocEntry table and producing a source 1309c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// location that refers to it. 131078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation createExpansionLocImpl(const SrcMgr::ExpansionInfo &Expansion, 1311bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength, 1312bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth int LoadedID = 0, 1313bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned LoadedOffset = 0); 1314c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 1315de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// isOffsetInFileID - Return true if the specified FileID contains the 1316de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// specified SourceLocation offset. This is a very hot method. 1317de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner inline bool isOffsetInFileID(FileID FID, unsigned SLocOffset) const { 1318de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::SLocEntry &Entry = getSLocEntry(FID); 1319de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // If the entry is after the offset, it can't contain it. 1320de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (SLocOffset < Entry.getOffset()) return false; 13211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1322f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // If this is the very last entry then it does. 1323f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (FID.ID == -2) 1324f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return true; 1325f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1326f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // If it is the last local entry, then it does if the location is local. 1327f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (static_cast<unsigned>(FID.ID+1) == LocalSLocEntryTable.size()) { 1328f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return SLocOffset < NextLocalOffset; 1329f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 13307f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 1331f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // Otherwise, the entry after it has to not include it. This works for both 1332f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // local and loaded entries. 13337f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor return SLocOffset < getSLocEntry(FileID::get(FID.ID+1)).getOffset(); 1334de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 13351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 133678d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// createFileID - Create a new fileID for the specified ContentCache and 133778d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// include position. This works regardless of whether the ContentCache 133878d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// corresponds to a file or some other input source. 13392b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID createFileID(const SrcMgr::ContentCache* File, 13402b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation IncludePos, 13417f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor SrcMgr::CharacteristicKind DirCharacter, 1342f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor int LoadedID, unsigned LoadedOffset); 13431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1344de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::ContentCache * 1345de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getOrCreateContentCache(const FileEntry *SourceFile); 1346c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek 134778d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// createMemBufferContentCache - Create a new ContentCache for the specified 134878d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// memory buffer. 13491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const SrcMgr::ContentCache* 13502b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner createMemBufferContentCache(const llvm::MemoryBuffer *Buf); 13511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1352de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID getFileIDSlow(unsigned SLocOffset) const; 1353f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID getFileIDLocal(unsigned SLocOffset) const; 1354f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID getFileIDLoaded(unsigned SLocOffset) const; 1355de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 1356f84ef95ecec34f27fd05eb4e0392ca6bd3bd0be0Chandler Carruth SourceLocation getExpansionLocSlowCase(SourceLocation Loc) const; 1357addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner SourceLocation getSpellingLocSlowCase(SourceLocation Loc) const; 1358796dbfb6c43336f58c026137c438e53eadc381f7Argyrios Kyrtzidis SourceLocation getFileLocSlowCase(SourceLocation Loc) const; 1359addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner 1360de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1361e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth getDecomposedExpansionLocSlowCase(const SrcMgr::SLocEntry *E) const; 1362de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1363de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E, 1364de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset) const; 1365fb3612ef197cb8532c05f33889ec1aed7c26e5cbArgyrios Kyrtzidis void computeMacroArgsCache(MacroArgsMap *&MacroArgsCache, FileID FID) const; 1366ac1ffcc55b861737ba2466cd1ca1accd8eafceaaArgyrios Kyrtzidis 1367ac1ffcc55b861737ba2466cd1ca1accd8eafceaaArgyrios Kyrtzidis friend class ASTReader; 1368ac1ffcc55b861737ba2466cd1ca1accd8eafceaaArgyrios Kyrtzidis friend class ASTWriter; 13695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 13705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 13735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 13745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1375