SourceManager.h revision 49c1f4aa2a6c360d25d605004ec3c4affd62db77
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 175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/SourceLocation.h" 1878d85f53b093867bbb0123f016956178eea7343eTed Kremenek#include "llvm/Bitcode/SerializationFwd.h" 195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <vector> 2078d85f53b093867bbb0123f016956178eea7343eTed Kremenek#include <set> 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include <list> 229dc62f044a6ba21f503bd56607d94b32704e7945Chris Lattner#include <cassert> 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace llvm { 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass MemoryBuffer; 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager; 31099b4747042352f69184481a48508b599a8d3f73Ted Kremenekclass FileManager; 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass FileEntry; 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass IdentifierTokenInfo; 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SrcMgr - Private classes that are part of the SourceManager implementation. 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace SrcMgr { 3878d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// ContentCache - Once instance of this struct is kept for every file 3978d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// loaded or used. This object owns the MemoryBuffer object. 4078d85f53b093867bbb0123f016956178eea7343eTed Kremenek struct ContentCache { 4178d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// Reference to the file entry. This reference does not own 4278d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// the FileEntry object. It is possible for this to be NULL if 4378d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// the ContentCache encapsulates an imaginary text buffer. 4478d85f53b093867bbb0123f016956178eea7343eTed Kremenek const FileEntry* Entry; 4578d85f53b093867bbb0123f016956178eea7343eTed Kremenek 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Buffer - The actual buffer containing the characters from the input 47b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// file. This is owned by the ContentCache object. 4878d85f53b093867bbb0123f016956178eea7343eTed Kremenek const llvm::MemoryBuffer* Buffer; 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SourceLineCache - A new[]'d array of offsets for each source line. This 51b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// is lazily computed. This is owned by the ContentCache object. 5278d85f53b093867bbb0123f016956178eea7343eTed Kremenek unsigned* SourceLineCache; 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 54b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// NumLines - The number of lines in this ContentCache. This is only valid 55b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// if SourceLineCache is non-null. 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned NumLines; 5778d85f53b093867bbb0123f016956178eea7343eTed Kremenek 5878d85f53b093867bbb0123f016956178eea7343eTed Kremenek ContentCache(const FileEntry* e = NULL) 5978d85f53b093867bbb0123f016956178eea7343eTed Kremenek : Entry(e), Buffer(NULL), SourceLineCache(NULL), NumLines(0) {} 6078d85f53b093867bbb0123f016956178eea7343eTed Kremenek 6178d85f53b093867bbb0123f016956178eea7343eTed Kremenek ~ContentCache(); 620d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek 630d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// The copy ctor does not allow copies where source object has either 640d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// a non-NULL Buffer or SourceLineCache. Ownership of allocated memory 650d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// is not transfered, so this is a logical error. 660d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek ContentCache(const ContentCache& RHS) : Buffer(NULL),SourceLineCache(NULL) { 670d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek Entry = RHS.Entry; 680d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek 690d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek assert (RHS.Buffer == NULL && RHS.SourceLineCache == NULL 700d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek && "Passed ContentCache object cannot own a buffer."); 710d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek 720d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek NumLines = RHS.NumLines; 730d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek } 740d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek 75e21272fbdbfbf5bf3461d3e9b42279f4d47caa42Ted Kremenek /// Emit - Emit this ContentCache to Bitcode. 76099b4747042352f69184481a48508b599a8d3f73Ted Kremenek void Emit(llvm::Serializer& S) const; 77099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 78099b4747042352f69184481a48508b599a8d3f73Ted Kremenek /// ReadToSourceManager - Reconstitute a ContentCache from Bitcode 79099b4747042352f69184481a48508b599a8d3f73Ted Kremenek // and store it in the specified SourceManager. 80099b4747042352f69184481a48508b599a8d3f73Ted Kremenek static void ReadToSourceManager(llvm::Deserializer& D, SourceManager& SMgr, 81099b4747042352f69184481a48508b599a8d3f73Ted Kremenek FileManager* FMgr, std::vector<char>& Buf); 82e21272fbdbfbf5bf3461d3e9b42279f4d47caa42Ted Kremenek 830d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek private: 840d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek // Disable assignments. 850d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek ContentCache& operator=(const ContentCache& RHS); 8678d85f53b093867bbb0123f016956178eea7343eTed Kremenek }; 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileIDInfo - Information about a FileID, basically just the logical file 8931bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// that it represents and include stack information. A File SourceLocation 9031bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// is a byte offset from the start of this. 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileID's are used to compute the location of a character in memory as well 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// as the logical source location, which can be differ from the physical 945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// location. It is different when #line's are active or when macros have 955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// been expanded. 965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Each FileID has include stack information, indicating where it came from. 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// For the primary translation unit, it comes from SourceLocation() aka 0. 9931bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// This information encodes the #include chain that a token was instantiated 10031bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// from. 1015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1020d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// FileIDInfos contain a "ContentCache *", describing the source file, 1030d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// and a Chunk number, which allows a SourceLocation to index into very 1040d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// large files (those which there are not enough FilePosBits to address). 1055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer struct FileIDInfo { 1079dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner private: 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IncludeLoc - The location of the #include that brought in this file. 1099dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// This SourceLocation object has an invalid SLOC for the main file. 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation IncludeLoc; 1115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1129dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// ChunkNo - Really large buffers are broken up into chunks that are 1139dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// each (1 << SourceLocation::FilePosBits) in size. This specifies the 1149dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// chunk number of this FileID. 1159dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned ChunkNo; 1169dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 11778d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// Content - Information about the source buffer itself. 11878d85f53b093867bbb0123f016956178eea7343eTed Kremenek const ContentCache* Content; 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 12078d85f53b093867bbb0123f016956178eea7343eTed Kremenek public: 1219dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// get - Return a FileIDInfo object. 12278d85f53b093867bbb0123f016956178eea7343eTed Kremenek static FileIDInfo get(SourceLocation IL, unsigned CN, 12378d85f53b093867bbb0123f016956178eea7343eTed Kremenek const ContentCache *Con) { 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileIDInfo X; 1255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.IncludeLoc = IL; 1269dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner X.ChunkNo = CN; 12778d85f53b093867bbb0123f016956178eea7343eTed Kremenek X.Content = Con; 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1319dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation getIncludeLoc() const { return IncludeLoc; } 1329dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getChunkNo() const { return ChunkNo; } 13378d85f53b093867bbb0123f016956178eea7343eTed Kremenek const ContentCache* getContentCache() const { return Content; } 134099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 135099b4747042352f69184481a48508b599a8d3f73Ted Kremenek /// Emit - Emit this FileIDInfo to Bitcode. 136099b4747042352f69184481a48508b599a8d3f73Ted Kremenek void Emit(llvm::Serializer& S) const; 137099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 138099b4747042352f69184481a48508b599a8d3f73Ted Kremenek /// ReadVal - Reconstitute a FileIDInfo from Bitcode. 139099b4747042352f69184481a48508b599a8d3f73Ted Kremenek static FileIDInfo ReadVal(llvm::Deserializer& S); 1409dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner }; 1419dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 14231bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// MacroIDInfo - Macro SourceLocations refer to these records by their ID. 14331bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// Each MacroIDInfo encodes the Instantiation location - where the macro was 14431bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// instantiated, and the PhysicalLoc - where the actual character data for 14531bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// the token came from. An actual macro SourceLocation stores deltas from 14631bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner /// these positions. 1479dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner class MacroIDInfo { 14818807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner SourceLocation VirtualLoc, PhysicalLoc; 1499dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner public: 15018807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner SourceLocation getVirtualLoc() const { return VirtualLoc; } 1519dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation getPhysicalLoc() const { return PhysicalLoc; } 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 15318807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner /// get - Return a MacroID for a macro expansion. VL specifies 15418807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner /// the instantiation location (where the macro is expanded), and PL 15518807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner /// specifies the physical location (where the characters from the token 15618807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner /// come from). Both VL and PL refer to normal File SLocs. 15718807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner static MacroIDInfo get(SourceLocation VL, SourceLocation PL) { 1589dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner MacroIDInfo X; 15918807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner X.VirtualLoc = VL; 1609dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner X.PhysicalLoc = PL; 1619dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return X; 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 163099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 164099b4747042352f69184481a48508b599a8d3f73Ted Kremenek /// Emit - Emit this MacroIDInfo to Bitcode. 165099b4747042352f69184481a48508b599a8d3f73Ted Kremenek void Emit(llvm::Serializer& S) const; 166099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 167099b4747042352f69184481a48508b599a8d3f73Ted Kremenek /// ReadVal - Reconstitute a MacroIDInfo from Bitcode. 168099b4747042352f69184481a48508b599a8d3f73Ted Kremenek static MacroIDInfo ReadVal(llvm::Deserializer& S); 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end SrcMgr namespace. 17178d85f53b093867bbb0123f016956178eea7343eTed Kremenek} // end clang namespace 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 17378d85f53b093867bbb0123f016956178eea7343eTed Kremeneknamespace std { 17478d85f53b093867bbb0123f016956178eea7343eTed Kremenektemplate <> struct less<clang::SrcMgr::ContentCache> { 17578d85f53b093867bbb0123f016956178eea7343eTed Kremenek inline bool operator()(const clang::SrcMgr::ContentCache& L, 17678d85f53b093867bbb0123f016956178eea7343eTed Kremenek const clang::SrcMgr::ContentCache& R) const { 17778d85f53b093867bbb0123f016956178eea7343eTed Kremenek return L.Entry < R.Entry; 17878d85f53b093867bbb0123f016956178eea7343eTed Kremenek } 17978d85f53b093867bbb0123f016956178eea7343eTed Kremenek}; 18078d85f53b093867bbb0123f016956178eea7343eTed Kremenek} // end std namespace 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 18278d85f53b093867bbb0123f016956178eea7343eTed Kremeneknamespace clang { 18378d85f53b093867bbb0123f016956178eea7343eTed Kremenek 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceManager - This file handles loading and caching of source files into 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// memory. This object owns the MemoryBuffer objects for all of the loaded 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// files and assigns unique FileID's for each unique #include chain. 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// The SourceManager can be queried for information about SourceLocation 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// objects, turning them into either physical or logical locations. Physical 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// locations represent where the bytes corresponding to a token came from and 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// logical locations represent where the location is in the user's view. In 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// the case of a macro expansion, for example, the physical location indicates 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// where the expanded token came from and the logical location specifies where 1945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// it was expanded. Logical locations are also influenced by #line directives, 1955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// etc. 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceManager { 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileInfos - Memoized information about all of the files tracked by this 1980d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// SourceManager. This set allows us to merge ContentCache entries based 1990d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// on their FileEntry*. All ContentCache objects will thus have unique, 2000d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// non-null, FileEntry pointers. 20178d85f53b093867bbb0123f016956178eea7343eTed Kremenek std::set<SrcMgr::ContentCache> FileInfos; 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// MemBufferInfos - Information about various memory buffers that we have 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// read in. This is a list, instead of a vector, because we need pointers to 205b6427f821de8cce1566fb6e755143ea0918d5543Ted Kremenek /// the ContentCache objects to be stable. All FileEntry* within the 2060d892d8bfddd4916cc4f3467e1184a623d0716daTed Kremenek /// stored ContentCache objects are NULL, as they do not refer to a file. 20778d85f53b093867bbb0123f016956178eea7343eTed Kremenek std::list<SrcMgr::ContentCache> MemBufferInfos; 2085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileIDs - Information about each FileID. FileID #0 is not valid, so all 2105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// entries are off by one. 2115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer std::vector<SrcMgr::FileIDInfo> FileIDs; 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2139dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// MacroIDs - Information about each MacroID. 2149dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner std::vector<SrcMgr::MacroIDInfo> MacroIDs; 2159dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 2165e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner /// LastLineNo - These ivars serve as a cache used in the getLineNumber 2175e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner /// method which is used to speedup getLineNumber calls to nearby locations. 2185e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner unsigned LastLineNoFileIDQuery; 21978d85f53b093867bbb0123f016956178eea7343eTed Kremenek SrcMgr::ContentCache *LastLineNoContentCache; 2205e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner unsigned LastLineNoFilePos; 2215e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner unsigned LastLineNoResult; 22278d85f53b093867bbb0123f016956178eea7343eTed Kremenek 22376edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek /// MainFileID - The file ID for the main source file of the translation unit. 22476edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek unsigned MainFileID; 22549c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff 22649c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff // SourceManager doesn't support copy construction. 22749c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff explicit SourceManager(const SourceManager&); 22849c1f4aa2a6c360d25d605004ec3c4affd62db77Steve Naroff void operator=(const SourceManager&); 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 23076edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek SourceManager() : LastLineNoFileIDQuery(~0U), MainFileID(0) {} 23178d85f53b093867bbb0123f016956178eea7343eTed Kremenek ~SourceManager() {} 2325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 233bd24776a825a18a59067c68a9d32f2d22e4cbf79Chris Lattner void clearIDTables() { 234bd24776a825a18a59067c68a9d32f2d22e4cbf79Chris Lattner FileIDs.clear(); 235bd24776a825a18a59067c68a9d32f2d22e4cbf79Chris Lattner MacroIDs.clear(); 2365e36a7a89da5d69ece23fc8228624a053f75c645Chris Lattner LastLineNoFileIDQuery = ~0U; 23778d85f53b093867bbb0123f016956178eea7343eTed Kremenek LastLineNoContentCache = 0; 238bd24776a825a18a59067c68a9d32f2d22e4cbf79Chris Lattner } 239bd24776a825a18a59067c68a9d32f2d22e4cbf79Chris Lattner 24076edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek /// getMainFileID - Returns the FileID of the main source file. 24176edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek unsigned getMainFileID() const { return MainFileID; } 24276edd0e4ae0592a7225d50d0bad6732ac64dca2aTed Kremenek 2435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// createFileID - Create a new FileID that represents the specified file 2445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// being #included from the specified IncludePosition. This returns 0 on 2455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// error and translates NULL into standard input. 2465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned createFileID(const FileEntry *SourceFile, SourceLocation IncludePos){ 24778d85f53b093867bbb0123f016956178eea7343eTed Kremenek const SrcMgr::ContentCache *IR = getContentCache(SourceFile); 2485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (IR == 0) return 0; // Error opening file? 2495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return createFileID(IR, IncludePos); 2505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2521036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek /// createMainFileID - Create the FileID for the main source file. 2531036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek unsigned createMainFileID(const FileEntry *SourceFile, 2541036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek SourceLocation IncludePos) { 2551036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek 2561036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek assert (MainFileID == 0 && "MainFileID already set!"); 2571036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek MainFileID = createFileID(SourceFile,IncludePos); 2581036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek return MainFileID; 2591036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek } 2601036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek 2615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// createFileIDForMemBuffer - Create a new FileID that represents the 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// specified memory buffer. This does no caching of the buffer and takes 2635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// ownership of the MemoryBuffer, so only pass a MemoryBuffer to this once. 2645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned createFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer) { 26578d85f53b093867bbb0123f016956178eea7343eTed Kremenek return createFileID(createMemBufferContentCache(Buffer), SourceLocation()); 2665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2681036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek /// createMainFileIDForMembuffer - Create the FileID for a memory buffer 2691036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek /// that will represent the FileID for the main source. One example 2701036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek /// of when this would be used is when the main source is read from STDIN. 2711036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek unsigned createMainFileIDForMemBuffer(const llvm::MemoryBuffer *Buffer) { 2721036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek assert (MainFileID == 0 && "MainFileID already set!"); 2737697b5c5a918729718da9ecd9e374bbd973a69e9Chris Lattner MainFileID = createFileIDForMemBuffer(Buffer); 2741036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek return MainFileID; 2751036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek } 2761036b68525f39cb69ac22c679ed440acd8392a16Ted Kremenek 2775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getInstantiationLoc - Return a new SourceLocation that encodes the fact 278abca2bba54197256f2830f757218cfbea2ed9cd1Chris Lattner /// that a token at Loc should actually be referenced from InstantiationLoc. 279abca2bba54197256f2830f757218cfbea2ed9cd1Chris Lattner SourceLocation getInstantiationLoc(SourceLocation Loc, 2805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation InstantiationLoc); 2815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getBuffer - Return the buffer for the specified FileID. 2835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 2845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const llvm::MemoryBuffer *getBuffer(unsigned FileID) const { 28578d85f53b093867bbb0123f016956178eea7343eTed Kremenek return getContentCache(FileID)->Buffer; 2865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2888a12c2777cccdf629b89745b6ecc89a8c1641e4eChris Lattner /// getBufferData - Return a pointer to the start and end of the character 2898a12c2777cccdf629b89745b6ecc89a8c1641e4eChris Lattner /// data for the specified FileID. 2908a12c2777cccdf629b89745b6ecc89a8c1641e4eChris Lattner std::pair<const char*, const char*> getBufferData(unsigned FileID) const; 2918a12c2777cccdf629b89745b6ecc89a8c1641e4eChris Lattner 2925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getIncludeLoc - Return the location of the #include for the specified 2939dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// SourceLocation. If this is a macro expansion, this transparently figures 2949dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// out which file includes the file being expanded into. 2959dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation getIncludeLoc(SourceLocation ID) const { 2969dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return getFIDInfo(getLogicalLoc(ID).getFileID())->getIncludeLoc(); 2975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 2985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getCharacterData - Return a pointer to the start of the specified location 3005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// in the appropriate MemoryBuffer. 3015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer const char *getCharacterData(SourceLocation SL) const; 3025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3039dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getColumnNumber - Return the column # for the specified file position. 3049dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// This is significantly cheaper to compute than the line number. This 3059dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// returns zero if the column number isn't known. This may only be called on 3069dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// a file sloc, so you must choose a physical or logical location before 3079dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// calling this method. 3085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getColumnNumber(SourceLocation Loc) const; 3095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3109dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getPhysicalColumnNumber(SourceLocation Loc) const { 3119dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return getColumnNumber(getPhysicalLoc(Loc)); 3129dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 3139dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getLogicalColumnNumber(SourceLocation Loc) const { 3149dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return getColumnNumber(getLogicalLoc(Loc)); 3159dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 3169dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 3179dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 3185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getLineNumber - Given a SourceLocation, return the physical line number 3195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// for the position indicated. This requires building and caching a table of 3205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// line offsets for the MemoryBuffer, so this is not cheap: use only when 3215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// about to emit a diagnostic. 3225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getLineNumber(SourceLocation Loc); 3239dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 3249dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getLogicalLineNumber(SourceLocation Loc) { 3259dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return getLineNumber(getLogicalLoc(Loc)); 3269dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 3279dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getPhysicalLineNumber(SourceLocation Loc) { 3289dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return getLineNumber(getPhysicalLoc(Loc)); 3299dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 3305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getSourceName - This method returns the name of the file or buffer that 3325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the SourceLocation specifies. This can be modified with #line directives, 3335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// etc. 3348b6ca8866f09fd8e018a329a0749d2dcf11b146aChris Lattner const char *getSourceName(SourceLocation Loc) const; 3355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Given a SourceLocation object, return the logical location referenced by 3375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// the ID. This logical location is subject to #line directives, etc. 3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation getLogicalLoc(SourceLocation Loc) const { 3399dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner // File locations are both physical and logical. 3409dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner if (Loc.isFileID()) return Loc; 3419dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 34218807d2bfb9282a35b921b4feeda09ffaa110e6bChris Lattner return MacroIDs[Loc.getMacroID()].getVirtualLoc(); 3435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getPhysicalLoc - Given a SourceLocation object, return the physical 3465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// location referenced by the ID. 3475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation getPhysicalLoc(SourceLocation Loc) const { 3489dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner // File locations are both physical and logical. 3499dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner if (Loc.isFileID()) return Loc; 3505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 35131bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner SourceLocation PLoc = MacroIDs[Loc.getMacroID()].getPhysicalLoc(); 35231bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner return PLoc.getFileLocWithOffset(Loc.getMacroPhysOffs()); 3539dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 3549dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 35578d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// getContentCacheForLoc - Return the ContentCache for the physloc of the 3569dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// specified SourceLocation, if one exists. 35778d85f53b093867bbb0123f016956178eea7343eTed Kremenek const SrcMgr::ContentCache* getContentCacheForLoc(SourceLocation Loc) const { 3589dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner Loc = getPhysicalLoc(Loc); 3599dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned FileID = Loc.getFileID(); 3609dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(FileID-1 < FileIDs.size() && "Invalid FileID!"); 36178d85f53b093867bbb0123f016956178eea7343eTed Kremenek return FileIDs[FileID-1].getContentCache(); 36278d85f53b093867bbb0123f016956178eea7343eTed Kremenek } 36378d85f53b093867bbb0123f016956178eea7343eTed Kremenek 36478d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// getFileEntryForLoc - Return the FileEntry record for the physloc of the 36578d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// specified SourceLocation, if one exists. 36678d85f53b093867bbb0123f016956178eea7343eTed Kremenek const FileEntry* getFileEntryForLoc(SourceLocation Loc) const { 36778d85f53b093867bbb0123f016956178eea7343eTed Kremenek return getContentCacheForLoc(Loc)->Entry; 3685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 3695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 37097394f23ca55c35beaa1538e446e5154f311f49cTed Kremenek /// getFileEntryForID - Returns the FileEntry record for the provided FileID. 37197394f23ca55c35beaa1538e446e5154f311f49cTed Kremenek const FileEntry* getFileEntryForID(unsigned id) const { 37297394f23ca55c35beaa1538e446e5154f311f49cTed Kremenek return getContentCache(id)->Entry; 37397394f23ca55c35beaa1538e446e5154f311f49cTed Kremenek } 37497394f23ca55c35beaa1538e446e5154f311f49cTed Kremenek 37597394f23ca55c35beaa1538e446e5154f311f49cTed Kremenek 3763457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner /// getDecomposedFileLoc - Decompose the specified file location into a raw 3773457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner /// FileID + Offset pair. The first element is the FileID, the second is the 3783457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner /// offset from the start of the buffer of the location. 3793457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner std::pair<unsigned, unsigned> getDecomposedFileLoc(SourceLocation Loc) const { 3803457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner assert(Loc.isFileID() && "Isn't a File SourceLocation"); 3813457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner 3823457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner // TODO: Add a flag "is first chunk" to SLOC. 3833457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner const SrcMgr::FileIDInfo *FIDInfo = getFIDInfo(Loc.getFileID()); 3843457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner 3853457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner // If this file has been split up into chunks, factor in the chunk number 3863457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner // that the FileID references. 3873457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner unsigned ChunkNo = FIDInfo->getChunkNo(); 3883457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner unsigned Offset = Loc.getRawFilePos(); 3893457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner Offset += (ChunkNo << SourceLocation::FilePosBits); 3903457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner 3913457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner return std::pair<unsigned,unsigned>(Loc.getFileID()-ChunkNo, Offset); 3923457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner } 3933457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner 3945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PrintStats - Print statistics to stderr. 3955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 3965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats() const; 39778d85f53b093867bbb0123f016956178eea7343eTed Kremenek 398099b4747042352f69184481a48508b599a8d3f73Ted Kremenek /// Emit - Emit this SourceManager to Bitcode. 399099b4747042352f69184481a48508b599a8d3f73Ted Kremenek void Emit(llvm::Serializer& S) const; 400099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 401099b4747042352f69184481a48508b599a8d3f73Ted Kremenek /// Read - Reconstitute a SourceManager from Bitcode. 4021f94100e53a7d45cea706c09ac0f35cf723a8d83Ted Kremenek static SourceManager* CreateAndRegister(llvm::Deserializer& S, 4031f94100e53a7d45cea706c09ac0f35cf723a8d83Ted Kremenek FileManager &FMgr); 404099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 4055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerprivate: 406099b4747042352f69184481a48508b599a8d3f73Ted Kremenek friend class SrcMgr::ContentCache; // Used for deserialization. 407099b4747042352f69184481a48508b599a8d3f73Ted Kremenek 40878d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// createFileID - Create a new fileID for the specified ContentCache and 40978d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// include position. This works regardless of whether the ContentCache 41078d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// corresponds to a file or some other input source. 41178d85f53b093867bbb0123f016956178eea7343eTed Kremenek unsigned createFileID(const SrcMgr::ContentCache* File, 41278d85f53b093867bbb0123f016956178eea7343eTed Kremenek SourceLocation IncludePos); 4135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 41478d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// getContentCache - Create or return a cached ContentCache for the specified 41578d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// file. This returns null on failure. 41678d85f53b093867bbb0123f016956178eea7343eTed Kremenek const SrcMgr::ContentCache* getContentCache(const FileEntry* SourceFile); 4175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 41878d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// createMemBufferContentCache - Create a new ContentCache for the specified 41978d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// memory buffer. 42078d85f53b093867bbb0123f016956178eea7343eTed Kremenek const SrcMgr::ContentCache* 42178d85f53b093867bbb0123f016956178eea7343eTed Kremenek createMemBufferContentCache(const llvm::MemoryBuffer* Buf); 4225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 42378d85f53b093867bbb0123f016956178eea7343eTed Kremenek const SrcMgr::FileIDInfo* getFIDInfo(unsigned FileID) const { 4245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer assert(FileID-1 < FileIDs.size() && "Invalid FileID!"); 4255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return &FileIDs[FileID-1]; 4265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4279dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 42878d85f53b093867bbb0123f016956178eea7343eTed Kremenek const SrcMgr::ContentCache *getContentCache(unsigned FileID) const { 42978d85f53b093867bbb0123f016956178eea7343eTed Kremenek return getContentCache(getFIDInfo(FileID)); 4309dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 4319dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 43278d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// Return the ContentCache structure for the specified FileID. 43378d85f53b093867bbb0123f016956178eea7343eTed Kremenek /// This is always the physical reference for the ID. 43478d85f53b093867bbb0123f016956178eea7343eTed Kremenek const SrcMgr::ContentCache* 43578d85f53b093867bbb0123f016956178eea7343eTed Kremenek getContentCache(const SrcMgr::FileIDInfo* FIDInfo) const { 43678d85f53b093867bbb0123f016956178eea7343eTed Kremenek return FIDInfo->getContentCache(); 43778d85f53b093867bbb0123f016956178eea7343eTed Kremenek } 4389dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 4399dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFullFilePos - This (efficient) method returns the offset from the start 4409dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// of the file that the specified physical SourceLocation represents. This 4419dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// returns the location of the physical character data, not the logical file 4429dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// position. 4439dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getFullFilePos(SourceLocation PhysLoc) const { 4443457e8cbaa8a6fec5d69173450655fe0bc38634bChris Lattner return getDecomposedFileLoc(PhysLoc).second; 4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 4475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 4505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 4515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 452