SourceManager.h revision 499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13
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 32aea67dbd653a2dd6dd5cc2159279e81e855b2482Douglas Gregorclass Diagnostic; 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 34099b4747042352f69184481a48508b599a8d3f73Ted Kremenekclass FileManager; 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 365b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattnerclass LineTableInfo; 37b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidisclass LangOptions; 38d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidisclass ASTWriter; 39d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidisclass ASTReader; 40aea67dbd653a2dd6dd5cc2159279e81e855b2482Douglas Gregor 410b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner/// SrcMgr - Public enums and private classes that are part of the 420b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner/// SourceManager implementation. 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace SrcMgr { 459d72851fec9e9c62570a027d42701562bbf29751Chris Lattner /// CharacteristicKind - This is used to represent whether a file or directory 460b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// holds normal user code, system code, or system code which is implicitly 470b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// 'extern "C"' in C++ mode. Entire directories can be tagged with this 480b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// (this is maintained by DirectoryLookup and friends) as can specific 49f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// FileInfos when a #pragma system_header is seen or various other cases. 500b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// 519d72851fec9e9c62570a027d42701562bbf29751Chris Lattner enum CharacteristicKind { 520b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner C_User, C_System, C_ExternCSystem 530b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner }; 541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 554710a8ea766b45079bf1c1dd36e29b59bb90829dDan Gohman /// ContentCache - One instance of this struct is kept for every file 5606a062dc784c609b75dca15fd97f468d0d846596Chris Lattner /// loaded or used. This object owns the MemoryBuffer object. 57c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek class ContentCache { 58f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor enum CCFlags { 59f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the buffer is invalid. 60f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor InvalidFlag = 0x01, 61f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Whether the buffer should not be freed on destruction. 62f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor DoNotFreeFlag = 0x02 63f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor }; 64f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 65c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// Buffer - The actual buffer containing the characters from the input 66c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// file. This is owned by the ContentCache object. 67f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// The bits indicate indicates whether the buffer is invalid. 68f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor mutable llvm::PointerIntPair<const llvm::MemoryBuffer *, 2> Buffer; 69c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek 70c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek public: 71b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// Reference to the file entry representing this ContentCache. 72b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// This reference does not own the FileEntry object. 73b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// It is possible for this to be NULL if 7478d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// the ContentCache encapsulates an imaginary text buffer. 75b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *OrigEntry; 76b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 77b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \brief References the file which the contents were actually loaded from. 78b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// Can be different from 'Entry' if we overridden the contents of one file 79b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// with the contents of another file. 80b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *ContentsEntry; 811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 820d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// SourceLineCache - A bump pointer allocated array of offsets for each 830d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// source line. This is lazily computed. This is owned by the 840d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// SourceManager BumpPointerAllocator object. 8505816591ec488a933dfecc9ff9f3cbf3c32767c2Chris Lattner unsigned *SourceLineCache; 861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 87b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// NumLines - The number of lines in this ContentCache. This is only valid 88b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// if SourceLineCache is non-null. 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumLines; 9010b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis 91d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Lazily computed map of macro argument chunks to their expanded 92d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// source location. 93d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis typedef std::map<unsigned, SourceLocation> MacroArgsMap; 94d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis MacroArgsMap *MacroArgsCache; 95d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 9636c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// getBuffer - Returns the memory buffer for the associated content. 9736c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// 98a92d7e7a55a35b28437103130904a6401bf35408Jonathan D. Turner /// \param Diag Object through which diagnostics will be emitted if the 9936c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// buffer cannot be retrieved. 10036c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// 101e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// \param Loc If specified, is the location that invalid file diagnostics 102e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// will be emitted at. 103e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner /// 10436c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error occurred. 105e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const llvm::MemoryBuffer *getBuffer(Diagnostic &Diag, 106e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const SourceManager &SM, 107e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner SourceLocation Loc = SourceLocation(), 10836c35ba0aca641e60e5dbee8efbc620c08b9bd61Douglas Gregor bool *Invalid = 0) const; 1091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 110c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// getSize - Returns the size of the content encapsulated by this 111c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// ContentCache. This can be the size of the source file or the size of an 112c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// arbitrary scratch buffer. If the ContentCache encapsulates a source 113c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// file this size is retrieved from the file's FileEntry. 114c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek unsigned getSize() const; 1151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 116c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek /// getSizeBytesMapped - Returns the number of bytes actually mapped for 1173201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// this ContentCache. This can be 0 if the MemBuffer was not actually 1183201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expanded. 119c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek unsigned getSizeBytesMapped() const; 120f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek 121f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// Returns the kind of memory used to back the memory buffer for 122f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// this content cache. This is used for performance analysis. 123f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek llvm::MemoryBuffer::BufferKind getMemoryBufferKind() const; 1241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 12505816591ec488a933dfecc9ff9f3cbf3c32767c2Chris Lattner void setBuffer(const llvm::MemoryBuffer *B) { 126c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor assert(!Buffer.getPointer() && "MemoryBuffer already set."); 127c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor Buffer.setPointer(B); 128c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor Buffer.setInt(false); 129c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek } 130cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor 131cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// \brief Get the underlying buffer, returning NULL if the buffer is not 132cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor /// yet available. 133cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor const llvm::MemoryBuffer *getRawBuffer() const { 134cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor return Buffer.getPointer(); 135cc5888d833caf90ebda37f24da40d2cd06b4d820Douglas Gregor } 1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1372968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Replace the existing buffer (which will be deleted) 1382968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// with the given buffer. 139f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor void replaceBuffer(const llvm::MemoryBuffer *B, bool DoNotFree = false); 1402968442603b029949246467253eeac8139a5b6d8Douglas Gregor 141f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Determine whether the buffer itself is invalid. 142f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool isBufferInvalid() const { 143f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor return Buffer.getInt() & InvalidFlag; 144f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 145f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 146f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \brief Determine whether the buffer should be freed. 147f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool shouldFreeBuffer() const { 148f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor return (Buffer.getInt() & DoNotFreeFlag) == 0; 149f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor } 150f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor 1510d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner ContentCache(const FileEntry *Ent = 0) 152b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis : Buffer(0, false), OrigEntry(Ent), ContentsEntry(Ent), 153d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis SourceLineCache(0), NumLines(0), MacroArgsCache(0) {} 154b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 155b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis ContentCache(const FileEntry *Ent, const FileEntry *contentEnt) 156b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis : Buffer(0, false), OrigEntry(Ent), ContentsEntry(contentEnt), 157d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis SourceLineCache(0), NumLines(0), MacroArgsCache(0) {} 15878d85f53b093867bbb0123f016956178eea7343eTed Kremenek 15978d85f53b093867bbb0123f016956178eea7343eTed Kremenek ~ContentCache(); 1601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1610d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// The copy ctor does not allow copies where source object has either 1620d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// a non-NULL Buffer or SourceLineCache. Ownership of allocated memory 163fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// is not transferred, so this is a logical error. 164c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor ContentCache(const ContentCache &RHS) 165d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis : Buffer(0, false), SourceLineCache(0), MacroArgsCache(0) 166c815108d08b0417c6f1104e7df70dc5278839406Douglas Gregor { 167b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis OrigEntry = RHS.OrigEntry; 168b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis ContentsEntry = RHS.ContentsEntry; 1690d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek 170d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis assert (RHS.Buffer.getPointer() == 0 && RHS.SourceLineCache == 0 && 171d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis RHS.MacroArgsCache == 0 1720d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek && "Passed ContentCache object cannot own a buffer."); 1731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump NumLines = RHS.NumLines; 1750d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek } 1761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1770d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek private: 1780d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek // Disable assignments. 1791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump ContentCache &operator=(const ContentCache& RHS); 1801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 182de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// FileInfo - Information about a FileID, basically just the logical file 183de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// that it represents and include stack information. 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 185de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// Each FileInfo has include stack information, indicating where it came 1863201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// from. This information encodes the #include chain that a token was 1873201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expanded from. The main include file has an invalid IncludeLoc. 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 189de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// FileInfos contain a "ContentCache *", with the contents of the file. 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 191de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner class FileInfo { 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeLoc - The location of the #include that brought in this file. 193de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// This is an invalid SLOC for the main file (top of the #include chain). 194de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned IncludeLoc; // Really a SourceLocation 1951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 196d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Number of FileIDs (files and macros) that were created during 197d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// preprocessing of this #include, including this SLocEntry. 198d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// Zero means the preprocessor didn't provide such info for this SLocEntry. 199d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis unsigned NumCreatedFIDs; 200d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 2016e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner /// Data - This contains the ContentCache* and the bits indicating the 2026e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner /// characteristic of the file and whether it has #line info, all bitmangled 2036e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner /// together. 2046e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner uintptr_t Data; 205d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 20621032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::SourceManager; 20721032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::ASTWriter; 20821032df7a0dfc129a8f0c5e004811b455baafb7aArgyrios Kyrtzidis friend class clang::ASTReader; 20978d85f53b093867bbb0123f016956178eea7343eTed Kremenek public: 210de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// get - Return a FileInfo object. 211de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static FileInfo get(SourceLocation IL, const ContentCache *Con, 212de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner CharacteristicKind FileCharacter) { 213de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileInfo X; 214de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner X.IncludeLoc = IL.getRawEncoding(); 215d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis X.NumCreatedFIDs = 0; 2166e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner X.Data = (uintptr_t)Con; 21700282d6e1194655a2e89f940bd6fa8484b52e666Chris Lattner assert((X.Data & 7) == 0 &&"ContentCache pointer insufficiently aligned"); 2186e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner assert((unsigned)FileCharacter < 4 && "invalid file character"); 2196e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner X.Data |= (unsigned)FileCharacter; 2205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 2215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 223de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getIncludeLoc() const { 224de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFromRawEncoding(IncludeLoc); 225de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 2266e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner const ContentCache* getContentCache() const { 22700282d6e1194655a2e89f940bd6fa8484b52e666Chris Lattner return reinterpret_cast<const ContentCache*>(Data & ~7UL); 2286e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner } 2291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2300b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner /// getCharacteristic - Return whether this is a system header or not. 2311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump CharacteristicKind getFileCharacteristic() const { 2326e1aff2f586025f2d385ee49239f626b0fc63fd7Chris Lattner return (CharacteristicKind)(Data & 3); 2330b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner } 234ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner 235ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// hasLineDirectives - Return true if this FileID has #line directives in 236ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// it. 237ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner bool hasLineDirectives() const { return (Data & 4) != 0; } 2381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 239ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// setHasLineDirectives - Set the flag that indicates that this FileID has 240ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner /// line table entries associated with it. 241ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner void setHasLineDirectives() { 242ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner Data |= 4; 243ac50e3427cb9eb3dc9f13f29a78f00ef3122433dChris Lattner } 2449dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner }; 2451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 24678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// ExpansionInfo - Each ExpansionInfo encodes the expansion location - where 24778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// the token was ultimately expanded, and the SpellingLoc - where the actual 24878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// character data for the token came from. 24978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth class ExpansionInfo { 25078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // Really these are all SourceLocations. 2511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 252e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner /// SpellingLoc - Where the spelling for the token can be found. 253e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner unsigned SpellingLoc; 2541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// ExpansionLocStart/ExpansionLocEnd - In a macro expansion, these 25678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// indicate the start and end of the expansion. In object-like macros, 2573201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// these will be the same. In a function-like macro expansion, the start 2583201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// will be the identifier and the end will be the ')'. Finally, in 259c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// macro-argument instantitions, the end will be 'SourceLocation()', an 260c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// invalid location. 26178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth unsigned ExpansionLocStart, ExpansionLocEnd; 262c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 2639dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner public: 264de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getSpellingLoc() const { 265de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFromRawEncoding(SpellingLoc); 266de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 26778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation getExpansionLocStart() const { 26878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return SourceLocation::getFromRawEncoding(ExpansionLocStart); 269e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 27078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation getExpansionLocEnd() const { 271c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth SourceLocation EndLoc = 27278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation::getFromRawEncoding(ExpansionLocEnd); 27378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return EndLoc.isInvalid() ? getExpansionLocStart() : EndLoc; 274e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 2751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth std::pair<SourceLocation,SourceLocation> getExpansionLocRange() const { 27778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return std::make_pair(getExpansionLocStart(), getExpansionLocEnd()); 278e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner } 2791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 28096d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth bool isMacroArgExpansion() const { 281c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth // Note that this needs to return false for default constructed objects. 28278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return getExpansionLocStart().isValid() && 28378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation::getFromRawEncoding(ExpansionLocEnd).isInvalid(); 284c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth } 285c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 28678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// create - Return a ExpansionInfo for an expansion. Start and End specify 28778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// the expansion range (where the macro is expanded), and SpellingLoc 28878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// specifies the spelling location (where the characters from the token 28978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// come from). All three can refer to normal File SLocs or expansion 29078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// locations. 29178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static ExpansionInfo create(SourceLocation SpellingLoc, 29278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation Start, SourceLocation End) { 29378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth ExpansionInfo X; 29478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.SpellingLoc = SpellingLoc.getRawEncoding(); 29578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.ExpansionLocStart = Start.getRawEncoding(); 29678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth X.ExpansionLocEnd = End.getRawEncoding(); 2979dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return X; 2985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 299c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 30078df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// createForMacroArg - Return a special ExpansionInfo for the expansion of 30178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// a macro argument into a function-like macro's body. ExpansionLoc 30278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// specifies the expansion location (where the macro is expanded). This 30378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// doesn't need to be a range because a macro is always expanded at 30478df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// a macro parameter reference, and macro parameters are always exactly 30578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// one token. SpellingLoc specifies the spelling location (where the 30678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// characters from the token come from). ExpansionLoc and SpellingLoc can 30778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// both refer to normal File SLocs or expansion locations. 308c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// 309c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// Given the code: 310c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// \code 311c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// #define F(x) f(x) 312c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// F(42); 313c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// \endcode 314c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// 31578df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// When expanding '\c F(42)', the '\c x' would call this with an 31678df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// SpellingLoc pointing at '\c 42' anad an ExpansionLoc pointing at its 31778df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// location in the definition of '\c F'. 31878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static ExpansionInfo createForMacroArg(SourceLocation SpellingLoc, 31978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation ExpansionLoc) { 320c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth // We store an intentionally invalid source location for the end of the 32178df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // expansion range to mark that this is a macro argument ion rather than 32278df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth // a normal one. 32378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth return create(SpellingLoc, ExpansionLoc, SourceLocation()); 324c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth } 325de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner }; 3261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 327de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// SLocEntry - This is a discriminated union of FileInfo and 32878df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth /// ExpansionInfo. SourceManager keeps an array of these objects, and 329de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// they are uniquely identified by the FileID datatype. 330de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner class SLocEntry { 3313201f382956ed9beee9fb31229c2835c1208889cChandler Carruth unsigned Offset; // low bit is set for expansion info. 332de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner union { 333de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileInfo File; 3341728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth ExpansionInfo Expansion; 335de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner }; 336de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner public: 337de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned getOffset() const { return Offset >> 1; } 3381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3391728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth bool isExpansion() const { return Offset & 1; } 3401728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth bool isFile() const { return !isExpansion(); } 3411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 342de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const FileInfo &getFile() const { 343de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner assert(isFile() && "Not a file SLocEntry!"); 344de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return File; 345de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 346de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 3471728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth const ExpansionInfo &getExpansion() const { 3481728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth assert(isExpansion() && "Not a macro expansion SLocEntry!"); 3491728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth return Expansion; 350de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 3511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 352de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner static SLocEntry get(unsigned Offset, const FileInfo &FI) { 353de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SLocEntry E; 354de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner E.Offset = Offset << 1; 355de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner E.File = FI; 356de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return E; 357de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 358de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 35978df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth static SLocEntry get(unsigned Offset, const ExpansionInfo &Expansion) { 360de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SLocEntry E; 361de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner E.Offset = (Offset << 1) | 1; 3621728762d5a8cfaf8d64385f47b311e84de1ae7a2Chandler Carruth E.Expansion = Expansion; 363de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return E; 364de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 3655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 3665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end SrcMgr namespace. 3677f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 3687f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor/// \brief External source of source location entries. 3697f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregorclass ExternalSLocEntrySource { 3707f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregorpublic: 3717f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor virtual ~ExternalSLocEntrySource(); 3727f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 373f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Read the source location entry with index ID, which will always be 374f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// less than -1. 375e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// 376e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// \returns true if an error occurred that prevented the source-location 377e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor /// entry from being loaded. 378f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor virtual bool ReadSLocEntry(int ID) = 0; 3797f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor}; 380dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 381dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 382dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner/// IsBeforeInTranslationUnitCache - This class holds the cache used by 383dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner/// isBeforeInTranslationUnit. The cache structure is complex enough to be 384dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner/// worth breaking out of SourceManager. 385dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattnerclass IsBeforeInTranslationUnitCache { 386dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// L/R QueryFID - These are the FID's of the cached query. If these match up 387dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// with a subsequent query, the result can be reused. 388dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner FileID LQueryFID, RQueryFID; 38937e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 39037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis /// \brief True if LQueryFID was created before RQueryFID. This is used 39137e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis /// to compare macro expansion locations. 39237e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis bool IsLQFIDBeforeRQFID; 39337e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 394dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// CommonFID - This is the file found in common between the two #include 395dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// traces. It is the nearest common ancestor of the #include tree. 396dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner FileID CommonFID; 397dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 398dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// L/R CommonOffset - This is the offset of the previous query in CommonFID. 399dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// Usually, this represents the location of the #include for QueryFID, but if 400dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// LQueryFID is a parent of RQueryFID (or vise versa) then these can be a 401dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// random token in the parent. 402dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner unsigned LCommonOffset, RCommonOffset; 403dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattnerpublic: 404dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 405dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// isCacheValid - Return true if the currently cached values match up with 406dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// the specified LHS/RHS query. If not, we can't use the cache. 407dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner bool isCacheValid(FileID LHS, FileID RHS) const { 408dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner return LQueryFID == LHS && RQueryFID == RHS; 409dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 410dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 411dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// getCachedResult - If the cache is valid, compute the result given the 412dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner /// specified offsets in the LHS/RHS FID's. 413dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner bool getCachedResult(unsigned LOffset, unsigned ROffset) const { 414dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // If one of the query files is the common file, use the offset. Otherwise, 415dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // use the #include loc in the common file. 416dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner if (LQueryFID != CommonFID) LOffset = LCommonOffset; 417dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner if (RQueryFID != CommonFID) ROffset = RCommonOffset; 41837e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 41937e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis // It is common for multiple macro expansions to be "included" from the same 42037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis // location (expansion location), in which case use the order of the FileIDs 42137e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis // to determine which came first. 42237e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis if (LOffset == ROffset && LQueryFID != CommonFID && RQueryFID != CommonFID) 42337e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis return IsLQFIDBeforeRQFID; 42437e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 425dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner return LOffset < ROffset; 426dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 427dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 428dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner // Set up a new query. 42937e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis void setQueryFIDs(FileID LHS, FileID RHS, bool isLFIDBeforeRFID) { 43037e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis assert(LHS != RHS); 431dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner LQueryFID = LHS; 432dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner RQueryFID = RHS; 43337e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis IsLQFIDBeforeRQFID = isLFIDBeforeRFID; 43437e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis } 43537e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis 43637e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis void clear() { 43737e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis LQueryFID = RQueryFID = FileID(); 43837e59a10a7a537428e5997fd5896f5b89fd34e6bArgyrios Kyrtzidis IsLQFIDBeforeRQFID = false; 439dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 440dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 441dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner void setCommonLoc(FileID commonFID, unsigned lCommonOffset, 442dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner unsigned rCommonOffset) { 443dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner CommonFID = commonFID; 444dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner LCommonOffset = lCommonOffset; 445dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner RCommonOffset = rCommonOffset; 446dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner } 447dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner 448dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner}; 4497f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 450f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// \brief This class handles loading and caching of source files into memory. 451f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// 452f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor/// This object owns the MemoryBuffer objects for all of the loaded 4535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// files and assigns unique FileID's for each unique #include chain. 4545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 4555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// The SourceManager can be queried for information about SourceLocation 4563201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// objects, turning them into either spelling or expansion locations. Spelling 4573201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// locations represent where the bytes corresponding to a token came from and 4583201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// expansion locations represent where the location is in the user's view. In 4593201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// the case of a macro expansion, for example, the spelling location indicates 4603201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// where the expanded token came from and the expansion location specifies 4613201f382956ed9beee9fb31229c2835c1208889cChandler Carruth/// where it was expanded. 4624f32786ac45210143654390177105eb749b614e9Ted Kremenekclass SourceManager : public llvm::RefCountedBase<SourceManager> { 463f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor /// \brief Diagnostic object. 464f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor Diagnostic &Diag; 465389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 466389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileManager &FileMgr; 467389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 4680d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner mutable llvm::BumpPtrAllocator ContentCacheAlloc; 4691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileInfos - Memoized information about all of the files tracked by this 4710d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// SourceManager. This set allows us to merge ContentCache entries based 4720d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// on their FileEntry*. All ContentCache objects will thus have unique, 4731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// non-null, FileEntry pointers. 4740d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> FileInfos; 4751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 476299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// \brief True if the ContentCache for files that are overriden by other 477299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// files, should report the original file name. Defaults to true. 478299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis bool OverridenFilesKeepOriginalName; 479299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis 480b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \brief Files that have been overriden with the contents from another file. 481b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis llvm::DenseMap<const FileEntry *, const FileEntry *> OverriddenFiles; 482b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 4835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MemBufferInfos - Information about various memory buffers that we have 4840d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// read in. All FileEntry* within the stored ContentCache objects are NULL, 4850d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner /// as they do not refer to a file. 4860d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner std::vector<SrcMgr::ContentCache*> MemBufferInfos; 4871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 488f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The table of SLocEntries that are local to this module. 489f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 490f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Positive FileIDs are indexes into this table. Entry 0 indicates an invalid 4913201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expansion. 492f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor std::vector<SrcMgr::SLocEntry> LocalSLocEntryTable; 493f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 494f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The table of SLocEntries that are loaded from other modules. 495f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 496f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Negative FileIDs are indexes into this table. To get from ID to an index, 497f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// use (-ID - 2). 498f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor std::vector<SrcMgr::SLocEntry> LoadedSLocEntryTable; 4997f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 500f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The starting offset of the next local SLocEntry. 501f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 502f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// This is LocalSLocEntryTable.back().Offset + the size of that entry. 503f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned NextLocalOffset; 504f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 505f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief The starting offset of the latest batch of loaded SLocEntries. 506f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 507f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// This is LoadedSLocEntryTable.back().Offset, except that that entry might 508f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// not have been loaded, so that value would be unknown. 509f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned CurrentLoadedOffset; 510f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 511ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// \brief The highest possible offset is 2^31-1, so CurrentLoadedOffset 512ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// starts at 2^31. 513ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis static const unsigned MaxLoadedOffset = 1U << 31U; 514ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis 515f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief A bitmap that indicates whether the entries of LoadedSLocEntryTable 516f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// have already been loaded from the external source. 517f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 518f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Same indexing as LoadedSLocEntryTable. 5197f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor std::vector<bool> SLocEntryLoaded; 5207f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 5217f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor /// \brief An external source for source location entries. 5227f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor ExternalSLocEntrySource *ExternalSLocEntries; 5237f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 524de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// LastFileIDLookup - This is a one-entry cache to speed up getFileID. 525de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// LastFileIDLookup records the last FileID looked up or created, because it 526de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// is very common to look up many tokens from the same file. 527de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner mutable FileID LastFileIDLookup; 5281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5295b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner /// LineTable - This holds information for #line directives. It is referenced 5305b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner /// by indices from SLocEntryTable. 5315b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner LineTableInfo *LineTable; 5321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5335e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner /// LastLineNo - These ivars serve as a cache used in the getLineNumber 5345e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner /// method which is used to speedup getLineNumber calls to nearby locations. 5352b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner mutable FileID LastLineNoFileIDQuery; 536f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable SrcMgr::ContentCache *LastLineNoContentCache; 537f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable unsigned LastLineNoFilePos; 538f812a45dd93634c9300ed5533bd26b56374714a1Chris Lattner mutable unsigned LastLineNoResult; 5391eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 54076edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek /// MainFileID - The file ID for the main source file of the translation unit. 5412b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID MainFileID; 54249c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff 543de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // Statistics for -print-stats. 544de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner mutable unsigned NumLinearScans, NumBinaryProbes; 5451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5462aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis // Cache results for the isBeforeInTranslationUnit method. 547dcb1d68f6ffa183f3919aee6b554aec3793bf13eChris Lattner mutable IsBeforeInTranslationUnitCache IsBeforeInTUCache; 5481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 549e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor // Cache for the "fake" buffer used for error-recovery purposes. 550e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor mutable llvm::MemoryBuffer *FakeBufferForRecovery; 551e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 55249c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff // SourceManager doesn't support copy construction. 55349c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff explicit SourceManager(const SourceManager&); 5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void operator=(const SourceManager&); 5555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 55639b49bcaaddb1049234fca9500c0ac02c088e23dChris Lattner SourceManager(Diagnostic &Diag, FileManager &FileMgr); 5575b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner ~SourceManager(); 5581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5595b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner void clearIDTables(); 5601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 56178a916ec5ff5b66adec3c499e1b9af7b87668309Argyrios Kyrtzidis Diagnostic &getDiagnostics() const { return Diag; } 56278a916ec5ff5b66adec3c499e1b9af7b87668309Argyrios Kyrtzidis 563389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis FileManager &getFileManager() const { return FileMgr; } 564389db16c63eec6ecfa9b235155252d8da766e94eArgyrios Kyrtzidis 565299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// \brief Set true if the SourceManager should report the original file name 566299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis /// for contents of files that were overriden by other files.Defaults to true. 567299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis void setOverridenFilesKeepOriginalName(bool value) { 568299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis OverridenFilesKeepOriginalName = value; 569299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis } 570299a4a967b02c9f0d0d94ad8560e3ced893f9116Argyrios Kyrtzidis 571f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// createMainFileIDForMembuffer - Create the FileID for a memory buffer 572f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// that will represent the FileID for the main source. One example 573f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// of when this would be used is when the main source is read from STDIN. 574f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID createMainFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer) { 575f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(MainFileID.isInvalid() && "MainFileID already set!"); 576f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor MainFileID = createFileIDForMemBuffer(Buffer); 577f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return MainFileID; 578f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 579f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 58006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 58106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // MainFileID creation and querying methods. 58206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 58306a062dc784c609b75dca15fd97f468d0d846596Chris Lattner 58476edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek /// getMainFileID - Returns the FileID of the main source file. 5852b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID getMainFileID() const { return MainFileID; } 5861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 58706a062dc784c609b75dca15fd97f468d0d846596Chris Lattner /// createMainFileID - Create the FileID for the main source file. 588f155dfa4e284be7dca8f1abf002476b2aaee8546Dan Gohman FileID createMainFileID(const FileEntry *SourceFile) { 58906a062dc784c609b75dca15fd97f468d0d846596Chris Lattner assert(MainFileID.isInvalid() && "MainFileID already set!"); 590f155dfa4e284be7dca8f1abf002476b2aaee8546Dan Gohman MainFileID = createFileID(SourceFile, SourceLocation(), SrcMgr::C_User); 59106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner return MainFileID; 59206a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 5931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 594414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor /// \brief Set the file ID for the precompiled preamble, which is also the 595414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor /// main file. 596414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor void SetPreambleFileID(FileID Preamble) { 597414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor assert(MainFileID.isInvalid() && "MainFileID already set!"); 598414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor MainFileID = Preamble; 599414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor } 600414cb64f09ce48a36377458ce5e5a90c3ad41d00Douglas Gregor 60106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 6023201f382956ed9beee9fb31229c2835c1208889cChandler Carruth // Methods to create new FileID's and macro expansions. 60306a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 6041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// createFileID - Create a new FileID that represents the specified file 606d57b7ff9bebc4c45f325fc1be6f238cfcd4c3732Peter Collingbourne /// being #included from the specified IncludePosition. This translates NULL 607d57b7ff9bebc4c45f325fc1be6f238cfcd4c3732Peter Collingbourne /// into standard input. 6082b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos, 6097f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor SrcMgr::CharacteristicKind FileCharacter, 610f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor int LoadedID = 0, unsigned LoadedOffset = 0) { 611de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::ContentCache *IR = getOrCreateContentCache(SourceFile); 6120d06e998910934e5ef070f53f4c272e7c6b846c6Dan Gohman assert(IR && "getOrCreateContentCache() cannot return NULL"); 613f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return createFileID(IR, IncludePos, FileCharacter, LoadedID, LoadedOffset); 6145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 6151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// createFileIDForMemBuffer - Create a new FileID that represents the 6175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// specified memory buffer. This does no caching of the buffer and takes 6185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ownership of the MemoryBuffer, so only pass a MemoryBuffer to this once. 6197f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor FileID createFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer, 620f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor int LoadedID = 0, unsigned LoadedOffset = 0) { 6217bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber return createFileID(createMemBufferContentCache(Buffer), SourceLocation(), 622f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor SrcMgr::C_User, LoadedID, LoadedOffset); 6231036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek } 62406a062dc784c609b75dca15fd97f468d0d846596Chris Lattner 625bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// createMacroArgExpansionLoc - Return a new SourceLocation that encodes the 626bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// fact that a token from SpellingLoc should actually be referenced from 6273201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// ExpansionLoc, and that it represents the expansion of a macro argument 6283201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// into the function-like macro body. 629bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation createMacroArgExpansionLoc(SourceLocation Loc, 630bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLoc, 631bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength); 632c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 633bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// createExpansionLoc - Return a new SourceLocation that encodes the fact 634c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// that a token from SpellingLoc should actually be referenced from 635bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// ExpansionLoc. 636bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation createExpansionLoc(SourceLocation Loc, 637bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLocStart, 638bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth SourceLocation ExpansionLocEnd, 639bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength, 640bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth int LoadedID = 0, 641bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned LoadedOffset = 0); 6421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6432968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Retrieve the memory buffer associated with the given file. 64450f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 64550f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error 64650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// occurs while retrieving the memory buffer. 64750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor const llvm::MemoryBuffer *getMemoryBufferForFile(const FileEntry *File, 64850f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0); 6492968442603b029949246467253eeac8139a5b6d8Douglas Gregor 6502968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \brief Override the contents of the given source file by providing an 6512968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// already-allocated buffer. 6522968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 653afbf5f810652f04c0bba235c0fa079885fb3caa8Dan Gohman /// \param SourceFile the source file whose contents will be overriden. 6542968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 6552968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// \param Buffer the memory buffer whose contents will be used as the 6562968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// data in the given source file. 6572968442603b029949246467253eeac8139a5b6d8Douglas Gregor /// 658f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// \param DoNotFree If true, then the buffer will not be freed when the 659f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor /// source manager is destroyed. 6600d06e998910934e5ef070f53f4c272e7c6b846c6Dan Gohman void overrideFileContents(const FileEntry *SourceFile, 661f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor const llvm::MemoryBuffer *Buffer, 662f4f6c9db68465b886ec2e596feaa6ecc782395a4Douglas Gregor bool DoNotFree = false); 6632968442603b029949246467253eeac8139a5b6d8Douglas Gregor 664b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \brief Override the the given source file with another one. 665b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// 666b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \param SourceFile the source file which will be overriden. 667b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// 668b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// \param NewFile the file whose contents will be used as the 669b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis /// data instead of the contents of the given source file. 670b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis void overrideFileContents(const FileEntry *SourceFile, 671b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis const FileEntry *NewFile); 672b1c86492f9a9bef01a4567408c22f961bbd604feArgyrios Kyrtzidis 67306a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 67406a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // FileID manipulation methods. 67506a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 6761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6772ffb14f004affc363d86d6c7c63c356190db3679Daniel Dunbar /// getBuffer - Return the buffer for the specified FileID. If there is an 6782ffb14f004affc363d86d6c7c63c356190db3679Daniel Dunbar /// error opening this buffer the first time, this manufactures a temporary 6792ffb14f004affc363d86d6c7c63c356190db3679Daniel Dunbar /// buffer and returns a non-empty error string. 680e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const llvm::MemoryBuffer *getBuffer(FileID FID, SourceLocation Loc, 681e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner bool *Invalid = 0) const { 682e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 683e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 684e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) { 685e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid) 686e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor *Invalid = true; 687e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 688e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return getFakeBufferForRecovery(); 689e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor } 690e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 691e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return Entry.getFile().getContentCache()->getBuffer(Diag, *this, Loc, 692e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor Invalid); 69306a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 6941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 695e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner const llvm::MemoryBuffer *getBuffer(FileID FID, bool *Invalid = 0) const { 696e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 697e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 698e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) { 699e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid) 700e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor *Invalid = true; 701e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 702e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return getFakeBufferForRecovery(); 703e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor } 704e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 705e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return Entry.getFile().getContentCache()->getBuffer(Diag, *this, 706e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor SourceLocation(), 707e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor Invalid); 708e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner } 709e127a0d80155b45dafe77f2b4380e5fa111a3345Chris Lattner 71006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner /// getFileEntryForID - Returns the FileEntry record for the provided FileID. 71106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner const FileEntry *getFileEntryForID(FileID FID) const { 712e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool MyInvalid = false; 713e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &MyInvalid); 714e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (MyInvalid || !Entry.isFile()) 715e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return 0; 716e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 717e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return Entry.getFile().getContentCache()->OrigEntry; 71806a062dc784c609b75dca15fd97f468d0d846596Chris Lattner } 7191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7209d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek /// Returns the FileEntry record for the provided SLocEntry. 7219d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek const FileEntry *getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const 7229d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek { 7239d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek return sloc.getFile().getContentCache()->OrigEntry; 7249d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek } 7259d5a165d301cc9df68631e624322dd2a962f65b3Ted Kremenek 726ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// getBufferData - Return a StringRef to the source buffer data for the 727ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// specified FileID. 728ceafc4b63599d14f0b5b10ff92e22bf242682dceBenjamin Kramer /// 729f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor /// \param FID The file ID whose contents will be returned. 730f715ca12bfc9fddfde75f98a197424434428b821Douglas Gregor /// \param Invalid If non-NULL, will be set true if an error occurred. 731686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getBufferData(FileID FID, bool *Invalid = 0) const; 732f6ac97b101c8840efa92bf29166077ce4049e293Benjamin Kramer 733d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Get the number of FileIDs (files and macros) that were created 734d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// during preprocessing of \arg FID, including it. 735d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis unsigned getNumCreatedFIDsForFileID(FileID FID) const { 736d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 737d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 738d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 739d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return 0; 740d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 741d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return Entry.getFile().NumCreatedFIDs; 742d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 743d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 744d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Set the number of FileIDs (files and macros) that were created 745d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// during preprocessing of \arg FID, including it. 746d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs) const { 747d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 748d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 749d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 750d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return; 751d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 752d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis assert(Entry.getFile().NumCreatedFIDs == 0 && "Already set!"); 753d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const_cast<SrcMgr::FileInfo &>(Entry.getFile()).NumCreatedFIDs = NumFIDs; 754d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 7551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 75606a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 75706a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // SourceLocation manipulation methods. 75806a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 7591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 760668ab1a36d6a5731c71a75a5f388ecafd538a896Chris Lattner /// getFileID - Return the FileID for a SourceLocation. This is a very 761de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// hot method that is used for all SourceManager queries that start with a 762de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// SourceLocation object. It is responsible for finding the entry in 763de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// SLocEntryTable which contains the specified location. 764de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// 765de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID getFileID(SourceLocation SpellingLoc) const { 766de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned SLocOffset = SpellingLoc.getOffset(); 7671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 768de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // If our one-entry cache covers this offset, just return it. 769de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (isOffsetInFileID(LastFileIDLookup, SLocOffset)) 770de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return LastFileIDLookup; 771de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 772de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getFileIDSlow(SLocOffset); 773de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 7741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7752b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// getLocForStartOfFile - Return the source location corresponding to the 7762b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// first byte of the specified file. 7772b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation getLocForStartOfFile(FileID FID) const { 778e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor bool Invalid = false; 779e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 780e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor if (Invalid || !Entry.isFile()) 781e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor return SourceLocation(); 782e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 783e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor unsigned FileOffset = Entry.getOffset(); 784de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return SourceLocation::getFileLoc(FileOffset); 7852b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 7861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 787d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// \brief Returns the include location if \arg FID is a #include'd file 788d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis /// otherwise it returns an invalid location. 789d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis SourceLocation getIncludeLoc(FileID FID) const { 790d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis bool Invalid = false; 791d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid); 792d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis if (Invalid || !Entry.isFile()) 793d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return SourceLocation(); 794d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 795d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis return Entry.getFile().getIncludeLoc(); 796d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis } 797d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis 798402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth /// getExpansionLoc - Given a SourceLocation object, return the expansion 799402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth /// location referenced by the ID. 800402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth SourceLocation getExpansionLoc(SourceLocation Loc) const { 801addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner // Handle the non-mapped case inline, defer to out of line code to handle 802402785357ab053dd53f4fdd858b9630a5e0f8badChandler Carruth // expansions. 803de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) return Loc; 804f84ef95ecec34f27fd05eb4e0392ca6bd3bd0be0Chandler Carruth return getExpansionLocSlowCase(Loc); 805de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 8061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 807999f739404edf2078cf9f9c28b4dc45c19765842Chandler Carruth /// getImmediateExpansionRange - Loc is required to be an expansion location. 808999f739404edf2078cf9f9c28b4dc45c19765842Chandler Carruth /// Return the start/end of the expansion information. 809e7fb48466afcbf2c4ccdfa658824282fdc3c512cChris Lattner std::pair<SourceLocation,SourceLocation> 810999f739404edf2078cf9f9c28b4dc45c19765842Chandler Carruth getImmediateExpansionRange(SourceLocation Loc) const; 8111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 812edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth /// getExpansionRange - Given a SourceLocation object, return the range of 813edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth /// tokens covered by the expansion the ultimate file. 8146678133b8ce642f93e5141f056fa643112041ad0Chris Lattner std::pair<SourceLocation,SourceLocation> 815edc3dccece244a584f8ebdb81da6c962c08e79beChandler Carruth getExpansionRange(SourceLocation Loc) const; 8161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 818de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getSpellingLoc - Given a SourceLocation object, return the spelling 819de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// location referenced by the ID. This is the place where the characters 820de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// that make up the lexed token can be found. 821de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner SourceLocation getSpellingLoc(SourceLocation Loc) const { 822addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner // Handle the non-mapped case inline, defer to out of line code to handle 8233201f382956ed9beee9fb31229c2835c1208889cChandler Carruth // expansions. 824de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) return Loc; 825addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner return getSpellingLocSlowCase(Loc); 826de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 8271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 828387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// getImmediateSpellingLoc - Given a SourceLocation object, return the 829387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// spelling location referenced by the ID. This is the first level down 830387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// towards the place where the characters that make up the lexed token can be 831387616edf98739f4a0dd234c907e2b913e6a535dChris Lattner /// found. This should not generally be used by clients. 8321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const; 833de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 834de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getDecomposedLoc - Decompose the specified location into a raw FileID + 835de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// Offset pair. The first element is the FileID, the second is the 836de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// offset from the start of the buffer of the location. 837de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> getDecomposedLoc(SourceLocation Loc) const { 838de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 839de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return std::make_pair(FID, Loc.getOffset()-getSLocEntry(FID).getOffset()); 840de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 8411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8423201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// getDecomposedExpansionLoc - Decompose the specified location into a raw 8433201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// FileID + Offset pair. If the location is an expansion record, walk 8443201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// through it until we find the final location expanded. 845de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 846e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth getDecomposedExpansionLoc(SourceLocation Loc) const { 847de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 848de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::SLocEntry *E = &getSLocEntry(FID); 8491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 850de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset = Loc.getOffset()-E->getOffset(); 851de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) 852de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return std::make_pair(FID, Offset); 8531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 854e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth return getDecomposedExpansionLocSlowCase(E); 855de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 856de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 857de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// getDecomposedSpellingLoc - Decompose the specified location into a raw 8583201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// FileID + Offset pair. If the location is an expansion record, walk 859de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// through it until we find its spelling record. 860de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 861de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getDecomposedSpellingLoc(SourceLocation Loc) const { 862de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID FID = getFileID(Loc); 863de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::SLocEntry *E = &getSLocEntry(FID); 8641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 865de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset = Loc.getOffset()-E->getOffset(); 866de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (Loc.isFileID()) 867de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return std::make_pair(FID, Offset); 868de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getDecomposedSpellingLocSlowCase(E, Offset); 8691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 8701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 87152c29081281955d3db9e11d10573b2d38f709099Chris Lattner /// getFileOffset - This method returns the offset from the start 87252c29081281955d3db9e11d10573b2d38f709099Chris Lattner /// of the file that the specified SourceLocation represents. This is not very 87352c29081281955d3db9e11d10573b2d38f709099Chris Lattner /// meaningful for a macro ID. 87452c29081281955d3db9e11d10573b2d38f709099Chris Lattner unsigned getFileOffset(SourceLocation SpellingLoc) const { 875de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner return getDecomposedLoc(SpellingLoc).second; 8765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 8771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 87896d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// isMacroArgExpansion - This method tests whether the given source location 87996d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// represents a macro argument's expansion into the function-like macro 88096d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// definition. Such source locations only appear inside of the expansion 88196d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// locations representing where a particular function-like macro was 88296d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth /// expanded. 88396d3589e523a04f4ff2058a7919226ce60696ae8Chandler Carruth bool isMacroArgExpansion(SourceLocation Loc) const; 8841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 885499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// \brief Returns true if \arg Loc is inside the [\arg Start, +\arg Length) 886499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// chunk of the source location address space. 887499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// If it's true and \arg RelativeOffset is non-null, it will be set to the 888499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis /// relative offset of \arg Loc inside the chunk. 889499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis bool isInSLocAddrSpace(SourceLocation Loc, 890499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis SourceLocation Start, unsigned Length, 891499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned *RelativeOffset = 0) const { 892499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis assert(((Start.getOffset() < NextLocalOffset && 893499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis Start.getOffset()+Length <= NextLocalOffset) || 894499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis (Start.getOffset() >= CurrentLoadedOffset && 895499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis Start.getOffset()+Length < MaxLoadedOffset)) && 896499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis "Chunk is not valid SLoc address space"); 897499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned LocOffs = Loc.getOffset(); 898499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned BeginOffs = Start.getOffset(); 899499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis unsigned EndOffs = BeginOffs + Length; 900499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis if (LocOffs >= BeginOffs && LocOffs < EndOffs) { 901499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis if (RelativeOffset) 902499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis *RelativeOffset = LocOffs - BeginOffs; 903499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis return true; 904499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis } 905499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis 906499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis return false; 907499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis } 908499ea5550d6e2fc5cfbd33b47f06d92ce25d7a13Argyrios Kyrtzidis 909de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner //===--------------------------------------------------------------------===// 910de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // Queries about the code at a SourceLocation. 911de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner //===--------------------------------------------------------------------===// 9121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getCharacterData - Return a pointer to the start of the specified location 914de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// in the appropriate spelling MemoryBuffer. 91550f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// 91650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor /// \param Invalid If non-NULL, will be set \c true if an error occurs. 91750f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor const char *getCharacterData(SourceLocation SL, bool *Invalid = 0) const; 9181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getColumnNumber - Return the column # for the specified file position. 9209dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// This is significantly cheaper to compute than the line number. This 9213201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// returns zero if the column number isn't known. This may only be called 9223201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// on a file sloc, so you must choose a spelling or expansion location 923f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner /// before calling this method. 92450f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor unsigned getColumnNumber(FileID FID, unsigned FilePos, 92550f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor bool *Invalid = 0) const; 9265ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getSpellingColumnNumber(SourceLocation Loc, bool *Invalid = 0) const; 927a77c031cb66f75d22672070052cc6e0205289ff8Chandler Carruth unsigned getExpansionColumnNumber(SourceLocation Loc, 928b49dcd249c7f4f034493741f95394987a4ccf244Chandler Carruth bool *Invalid = 0) const; 9295ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getPresumedColumnNumber(SourceLocation Loc, bool *Invalid = 0) const; 9301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 932df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner /// getLineNumber - Given a SourceLocation, return the spelling line number 9335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// for the position indicated. This requires building and caching a table of 9345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// line offsets for the MemoryBuffer, so this is not cheap: use only when 9355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// about to emit a diagnostic. 93650f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid = 0) const; 9375ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 938642116259e8df6286063a17361c20e95b5017a0aChandler Carruth unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 9395ef04ee40c3332d31b6d1439f50d0ddb45812929Chandler Carruth unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid = 0) const; 9401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 941bff5c512af8ca7ac92e974e04c06ff4f820e4ee1Chris Lattner /// Return the filename or buffer identifier of the buffer the location is in. 942bff5c512af8ca7ac92e974e04c06ff4f820e4ee1Chris Lattner /// Note that this name does not respect #line directives. Use getPresumedLoc 943bff5c512af8ca7ac92e974e04c06ff4f820e4ee1Chris Lattner /// for normal clients. 94450f6af7a6d6951a63f3da7d4c5a7d3965bf73b63Douglas Gregor const char *getBufferName(SourceLocation Loc, bool *Invalid = 0) const; 9451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9466b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// getFileCharacteristic - return the file characteristic of the specified 9471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// source location, indicating whether this is a normal file, a system 9486b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// header, or an "implicit extern C" system header. 9496b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// 9506b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// This state can be modified with flags on GNU linemarker directives like: 9516b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// # 4 "foo.h" 3 9526b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// which changes all source locations in the current file after that to be 9536b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner /// considered to be from a system header. 9546b3066780bda02e3117d71a18ca2f430ed1454afChris Lattner SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const; 9551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 956b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// getPresumedLoc - This method returns the "presumed" location of a 957b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// SourceLocation specifies. A "presumed location" can be modified by #line 958b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// or GNU line marker directives. This provides a view on the data that a 959b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// user should see in diagnostics, for example. 960b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner /// 9613201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// Note that a presumed location is always given as the expansion point of 9623201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// an expansion location, not at the spelling location. 963cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// 964cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// \returns The presumed location of the specified SourceLocation. If the 965cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// presumed location cannot be calculate (e.g., because \p Loc is invalid 966cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// or the file containing \p Loc has changed on disk), returns an invalid 967cb7b1e17b63967317ab5cc55682168cf0380519aDouglas Gregor /// presumed location. 968b9c3f966b103f7cfe8e5e60007c4c8b38f7298ebChris Lattner PresumedLoc getPresumedLoc(SourceLocation Loc) const; 9691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9709fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// isFromSameFile - Returns true if both SourceLocations correspond to 9719fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// the same file. 9729fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek bool isFromSameFile(SourceLocation Loc1, SourceLocation Loc2) const { 973a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner return getFileID(Loc1) == getFileID(Loc2); 9749fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek } 9751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9769fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// isFromMainFile - Returns true if the file of provided SourceLocation is 9779fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek /// the main file. 9789fd87b1db485e2f31d0e5687f9168b370d546847Ted Kremenek bool isFromMainFile(SourceLocation Loc) const { 979a11d61793341fea195c29a0dab3fbd74f2b39a8cChris Lattner return getFileID(Loc) == getMainFileID(); 9801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 9811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9827bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber /// isInSystemHeader - Returns if a SourceLocation is in a system header. 9837bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader(SourceLocation Loc) const { 9840b9e736308af5397f558ffc8e780c438c2fdb563Chris Lattner return getFileCharacteristic(Loc) != SrcMgr::C_User; 985721818304ac462d8c6ce05eecd02884033db78f1Chris Lattner } 9861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 9870d456588acac0713a7c33063922d35a8cc8c658eChris Lattner /// isInExternCSystemHeader - Returns if a SourceLocation is in an "extern C" 9880d456588acac0713a7c33063922d35a8cc8c658eChris Lattner /// system header. 9890d456588acac0713a7c33063922d35a8cc8c658eChris Lattner bool isInExternCSystemHeader(SourceLocation Loc) const { 9900d456588acac0713a7c33063922d35a8cc8c658eChris Lattner return getFileCharacteristic(Loc) == SrcMgr::C_ExternCSystem; 9910d456588acac0713a7c33063922d35a8cc8c658eChris Lattner } 9921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 99354232ade44d31e98ea83f43ca066128e315dcbdaArgyrios Kyrtzidis /// \brief The size of the SLocEnty that \arg FID represents. 994984e42ca1ff7775ce39372c314f1cb7d6862c4c7Argyrios Kyrtzidis unsigned getFileIDSize(FileID FID) const; 99554232ade44d31e98ea83f43ca066128e315dcbdaArgyrios Kyrtzidis 996d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis /// \brief Given a specific FileID, returns true if \arg Loc is inside that 997d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis /// FileID chunk and sets relative offset (offset of \arg Loc from beginning 998d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis /// of FileID) to \arg relativeOffset. 999d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis bool isInFileID(SourceLocation Loc, FileID FID, 1000d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis unsigned *RelativeOffset = 0) const { 1001d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis return isInFileID(Loc, FID, 0, getFileIDSize(FID), RelativeOffset); 1002d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis } 1003d60a34a4e514ec0dfddd05ef2744be104e111f45Argyrios Kyrtzidis 1004b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// \brief Given a specific chunk of a FileID (FileID with offset+length), 1005b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// returns true if \arg Loc is inside that chunk and sets relative offset 1006b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// (offset of \arg Loc from beginning of chunk) to \arg relativeOffset. 1007b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis bool isInFileID(SourceLocation Loc, 1008b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis FileID FID, unsigned offset, unsigned length, 1009984e42ca1ff7775ce39372c314f1cb7d6862c4c7Argyrios Kyrtzidis unsigned *relativeOffset = 0) const; 1010469244a322dd5d35cee1d02d70a2edbc12ac5ce7Argyrios Kyrtzidis 101106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 10125b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner // Line Table Manipulation Routines 10135b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner //===--------------------------------------------------------------------===// 10141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10155b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner /// getLineTableFilenameID - Return the uniqued ID for the specified filename. 10161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// 1017686775deca8b8685eb90801495880e3abdd844c2Chris Lattner unsigned getLineTableFilenameID(StringRef Str); 10181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10194c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner /// AddLineNote - Add a line note to the line table for the FileID and offset 10204c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner /// specified by Loc. If FilenameID is -1, it is considered to be 10214c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner /// unspecified. 10224c4ea17d7f991516c37a871dfa4bbe5723fa85f0Chris Lattner void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID); 10239d79ebac47ffde6a1cb312f4c09b66b1b9a397fbChris Lattner void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID, 10241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool IsFileEntry, bool IsFileExit, 10259d79ebac47ffde6a1cb312f4c09b66b1b9a397fbChris Lattner bool IsSystemHeader, bool IsExternCHeader); 1026bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1027bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor /// \brief Determine if the source manager has a line table. 1028bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor bool hasLineTable() const { return LineTable != 0; } 1029bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1030bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor /// \brief Retrieve the stored line table. 1031bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor LineTableInfo &getLineTable(); 1032bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 10335b9a504720fb52594ca3686e10eb6c0cfa2e7d62Chris Lattner //===--------------------------------------------------------------------===// 1034457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek // Queries for performance analysis. 1035457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek //===--------------------------------------------------------------------===// 1036457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek 1037457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek /// Return the total amount of physical memory allocated by the 1038457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek /// ContentCache allocator. 1039457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek size_t getContentCacheSize() const { 1040457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek return ContentCacheAlloc.getTotalMemory(); 1041457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek } 1042f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek 1043f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek struct MemoryBufferSizes { 1044f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek const size_t malloc_bytes; 1045f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek const size_t mmap_bytes; 1046f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek 1047f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes) 1048f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek : malloc_bytes(malloc_bytes), mmap_bytes(mmap_bytes) {} 1049f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek }; 1050f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek 1051f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// Return the amount of memory used by memory buffers, breaking down 1052f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek /// by heap-backed versus mmap'ed memory. 1053f61b831d7f6a15676b07647f507de80324cb7056Ted Kremenek MemoryBufferSizes getMemoryBufferSizes() const; 1054ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek 1055ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek // Return the amount of memory used for various side tables and 1056ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek // data structures in the SourceManager. 1057ca7dc2b755eb81ac95121ce1a1f1aa44a4a0fe12Ted Kremenek size_t getDataStructureSizes() const; 1058457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek 1059457aaf0692dfb2d9638f383334b81027f637f20cTed Kremenek //===--------------------------------------------------------------------===// 106006a062dc784c609b75dca15fd97f468d0d846596Chris Lattner // Other miscellaneous methods. 106106a062dc784c609b75dca15fd97f468d0d846596Chris Lattner //===--------------------------------------------------------------------===// 106210b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis 106310b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 106410b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// 106510b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// If the source file is included multiple times, the source location will 106610b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis /// be based upon the first inclusion. 1067ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// 1068ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// If the location points inside a function macro argument, the returned 1069ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// location will be the macro location in which the argument was expanded. 1070ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// \sa getMacroArgExpandedLocation 107110b46d2f0b976676d10681d73fe061b5ae409b36Argyrios Kyrtzidis SourceLocation getLocation(const FileEntry *SourceFile, 1072ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis unsigned Line, unsigned Col) { 1073ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis SourceLocation Loc = translateFileLineCol(SourceFile, Line, Col); 1074ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis return getMacroArgExpandedLocation(Loc); 1075ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis } 1076ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis 1077ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// \brief Get the source location for the given file:line:col triplet. 1078ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// 1079ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// If the source file is included multiple times, the source location will 1080ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// be based upon the first inclusion. 1081ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis SourceLocation translateFileLineCol(const FileEntry *SourceFile, 1082ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis unsigned Line, unsigned Col); 1083ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis 1084ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// \brief If \arg Loc points inside a function macro argument, the returned 1085ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// location will be the macro location in which the argument was expanded. 1086ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// If a macro argument is used multiple times, the expanded location will 1087ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// be at the first expansion of the argument. 1088ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// e.g. 1089ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// MY_MACRO(foo); 1090ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// ^ 1091ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// Passing a file location pointing at 'foo', will yield a macro location 1092ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis /// where 'foo' was expanded into. 1093ac836e442cbd17f33533bd0b4879258945bc1723Argyrios Kyrtzidis SourceLocation getMacroArgExpandedLocation(SourceLocation Loc); 10941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 10952aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the translation unit. 10962aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// 10972aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis /// \returns true if LHS source location comes before RHS, false otherwise. 10982aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const; 10992aa03d588bd2d3c73deb662880c2244bf2e384b9Argyrios Kyrtzidis 1100b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// \brief Determines the order of 2 source locations in the "source location 1101b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// address space". 11025d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const { 11035d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis return isBeforeInSLocAddrSpace(LHS, RHS.getOffset()); 1104b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis } 1105b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 1106b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// \brief Determines the order of a source location and a source location 1107b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis /// offset in the "source location address space". 1108f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 1109f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// Note that we always consider source locations loaded from 11105d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis bool isBeforeInSLocAddrSpace(SourceLocation LHS, unsigned RHS) const { 1111f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned LHSOffset = LHS.getOffset(); 1112f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool LHSLoaded = LHSOffset >= CurrentLoadedOffset; 1113f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool RHSLoaded = RHS >= CurrentLoadedOffset; 1114f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (LHSLoaded == RHSLoaded) 11155d579e7b0463a2e65328df85e4fed8e07799fd9eArgyrios Kyrtzidis return LHSOffset < RHS; 1116f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1117f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LHSLoaded; 1118b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis } 1119b73377eeb3eff76be134203aebb6068244b177f3Argyrios Kyrtzidis 1120c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner // Iterators over FileInfos. 11210d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner typedef llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> 11220d0bf8cf58b35302312cc155287fde3e81eb25a7Chris Lattner ::const_iterator fileinfo_iterator; 1123c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner fileinfo_iterator fileinfo_begin() const { return FileInfos.begin(); } 1124c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner fileinfo_iterator fileinfo_end() const { return FileInfos.end(); } 1125d93256e55673a17d18543397ec462416acb13792Douglas Gregor bool hasFileInfo(const FileEntry *File) const { 1126d93256e55673a17d18543397ec462416acb13792Douglas Gregor return FileInfos.find(File) != FileInfos.end(); 1127d93256e55673a17d18543397ec462416acb13792Douglas Gregor } 1128c6fe32a91c7372caf09152ee31a24c4b5d24deedChris Lattner 11295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PrintStats - Print statistics to stderr. 11305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 11315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats() const; 113278d85f53b093867bbb0123f016956178eea7343eTed Kremenek 1133f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the number of local SLocEntries we have. 1134f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned local_sloc_entry_size() const { return LocalSLocEntryTable.size(); } 1135f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1136f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get a local SLocEntry. This is exposed for indexing. 1137f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor const SrcMgr::SLocEntry &getLocalSLocEntry(unsigned Index, 1138f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor bool *Invalid = 0) const { 1139f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(Index < LocalSLocEntryTable.size() && "Invalid index"); 1140f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LocalSLocEntryTable[Index]; 1141bdfe48ac80573e026595af91e541474dbf02565fDouglas Gregor } 1142f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1143f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the number of loaded SLocEntries we have. 1144f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned loaded_sloc_entry_size() const { return LoadedSLocEntryTable.size();} 1145f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1146f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get a loaded SLocEntry. This is exposed for indexing. 1147f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor const SrcMgr::SLocEntry &getLoadedSLocEntry(unsigned Index, bool *Invalid=0) const { 1148f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(Index < LoadedSLocEntryTable.size() && "Invalid index"); 1149f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (!SLocEntryLoaded[Index]) 1150f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor ExternalSLocEntries->ReadSLocEntry(-(static_cast<int>(Index) + 2)); 1151f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return LoadedSLocEntryTable[Index]; 1152f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 1153f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1154e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const SrcMgr::SLocEntry &getSLocEntry(FileID FID, bool *Invalid = 0) const { 1155f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getSLocEntryByID(FID.ID); 1156bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor } 1157bd94500d3aa60092fb0f1e90f53fb0d03fa502a8Douglas Gregor 1158f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor unsigned getNextLocalOffset() const { return NextLocalOffset; } 1159f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1160f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor void setExternalSLocEntrySource(ExternalSLocEntrySource *Source) { 1161f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(LoadedSLocEntryTable.empty() && 1162f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor "Invalidating existing loaded entries"); 1163f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor ExternalSLocEntries = Source; 1164f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 1165f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1166f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Allocate a number of loaded SLocEntries, which will be actually 1167f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// loaded on demand from the external source. 1168f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// 1169f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// NumSLocEntries will be allocated, which occupy a total of TotalSize space 1170f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// in the global source view. The lowest ID and the base offset of the 1171f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// entries will be returned. 1172f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor std::pair<int, unsigned> 1173f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor AllocateLoadedSLocEntries(unsigned NumSLocEntries, unsigned TotalSize); 1174f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 11755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 1176e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor const llvm::MemoryBuffer *getFakeBufferForRecovery() const; 1177e23ac65af568ffe611b0990818ac3a57c856a4d8Douglas Gregor 1178f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor /// \brief Get the entry with the given unwrapped FileID. 1179f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor const SrcMgr::SLocEntry &getSLocEntryByID(int ID) const { 1180f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor assert(ID != -1 && "Using FileID sentinel value"); 1181f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (ID < 0) 1182f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getLoadedSLocEntryByID(ID); 1183f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getLocalSLocEntry(static_cast<unsigned>(ID)); 1184f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 1185f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1186f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor const SrcMgr::SLocEntry &getLoadedSLocEntryByID(int ID) const { 1187f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return getLoadedSLocEntry(static_cast<unsigned>(-ID - 2)); 1188f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 1189f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1190bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth /// createExpansionLoc - Implements the common elements of storing an 11913201f382956ed9beee9fb31229c2835c1208889cChandler Carruth /// expansion info struct into the SLocEntry table and producing a source 1192c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth /// location that refers to it. 119378df836808aee22c3157e1bc23bc4ec569b80568Chandler Carruth SourceLocation createExpansionLocImpl(const SrcMgr::ExpansionInfo &Expansion, 1194bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned TokLength, 1195bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth int LoadedID = 0, 1196bf340e452339e374ea6eef78c1f0a2abdd16c5a3Chandler Carruth unsigned LoadedOffset = 0); 1197c8d1ecca1cd3fadbd331d15c420755aa6184554bChandler Carruth 1198de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// isOffsetInFileID - Return true if the specified FileID contains the 1199de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner /// specified SourceLocation offset. This is a very hot method. 1200de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner inline bool isOffsetInFileID(FileID FID, unsigned SLocOffset) const { 1201de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::SLocEntry &Entry = getSLocEntry(FID); 1202de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner // If the entry is after the offset, it can't contain it. 1203de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner if (SLocOffset < Entry.getOffset()) return false; 12041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1205f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // If this is the very last entry then it does. 1206f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (FID.ID == -2) 1207f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return true; 1208f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor 1209f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // If it is the last local entry, then it does if the location is local. 1210f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor if (static_cast<unsigned>(FID.ID+1) == LocalSLocEntryTable.size()) { 1211f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor return SLocOffset < NextLocalOffset; 1212f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor } 12137f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor 1214f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // Otherwise, the entry after it has to not include it. This works for both 1215f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor // local and loaded entries. 12167f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor return SLocOffset < getSLocEntry(FileID::get(FID.ID+1)).getOffset(); 1217de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner } 12181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 121978d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// createFileID - Create a new fileID for the specified ContentCache and 122078d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// include position. This works regardless of whether the ContentCache 122178d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// corresponds to a file or some other input source. 12222b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID createFileID(const SrcMgr::ContentCache* File, 12232b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner SourceLocation IncludePos, 12247f94b0b0c6791013d2f72ced9b4bedd3b23673a6Douglas Gregor SrcMgr::CharacteristicKind DirCharacter, 1225f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor int LoadedID, unsigned LoadedOffset); 12261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1227de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner const SrcMgr::ContentCache * 1228de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getOrCreateContentCache(const FileEntry *SourceFile); 1229c16c208e8519476d838ad11fffc8e0ecea50550dTed Kremenek 123078d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// createMemBufferContentCache - Create a new ContentCache for the specified 123178d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// memory buffer. 12321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const SrcMgr::ContentCache* 12332b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner createMemBufferContentCache(const llvm::MemoryBuffer *Buf); 12341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1235de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner FileID getFileIDSlow(unsigned SLocOffset) const; 1236f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID getFileIDLocal(unsigned SLocOffset) const; 1237f62d43d2afe1960755a1b5813cae1e5983bcac1bDouglas Gregor FileID getFileIDLoaded(unsigned SLocOffset) const; 1238de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner 1239f84ef95ecec34f27fd05eb4e0392ca6bd3bd0be0Chandler Carruth SourceLocation getExpansionLocSlowCase(SourceLocation Loc) const; 1240addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner SourceLocation getSpellingLocSlowCase(SourceLocation Loc) const; 1241addb797ca2b5afc1a1e82fd8d5d6eb2a592e75a9Chris Lattner 1242de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1243e7b2b6e87dbe5b1207f77b6ff9c210a02f95bb39Chandler Carruth getDecomposedExpansionLocSlowCase(const SrcMgr::SLocEntry *E) const; 1244de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner std::pair<FileID, unsigned> 1245de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E, 1246de7aeefc5573d669ed476d7bda7a8940d3bcadb7Chris Lattner unsigned Offset) const; 1247d9d2b679d0728ea7f539f38aaea38e26b8b08043Argyrios Kyrtzidis void computeMacroArgsCache(SrcMgr::ContentCache *Content, FileID FID); 12485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 12495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 12525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 1254