SourceLocation.h revision 0bc735ffcfb223c0186419547abaa5c84482663e
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- SourceLocation.h - Compact identifier for 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 SourceLocation class. 115f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===// 135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#ifndef LLVM_CLANG_SOURCELOCATION_H 155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#define LLVM_CLANG_SOURCELOCATION_H 165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 179dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner#include <cassert> 180a449eed1dd2439b4b9c0a6291084816eab390c1Ted Kremenek#include "llvm/Bitcode/SerializationFwd.h" 199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 209c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremeneknamespace llvm { 219c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenekclass MemoryBuffer; 229c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek} 239c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 25a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 26a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekclass SourceManager; 279c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenekclass FileEntry; 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// a full include stack, line and column number information for a position in 315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// an input translation unit. 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceLocation { 335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned ID; 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 36b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // FileID Layout: 37b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 31: 0 -> FileID, 1 -> MacroID (invalid for FileID) 38b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // 30...17 -> FileID of source location, index into SourceManager table. 395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileIDBits = 14, 40b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // 0...16 -> Index into the chunk of the specified FileID. 419dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner FilePosBits = 32-1-FileIDBits, 429dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 43b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // MacroID Layout: 44b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 31: 1 -> MacroID, 0 -> FileID (invalid for MacroID) 45b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 46b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 30: 1 -> Start of macro expansion marker. 47b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner MacroStartOfExpansionBit = 30, 48b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 29: 1 -> End of macro expansion marker. 49b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner MacroEndOfExpansionBit = 29, 50b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bits 28...9 -> MacroID number. 51d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner MacroIDBits = 20, 52b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bits 8...0 -> Macro Physical offset 5331bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner MacroPhysOffsBits = 9, 542c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner 55b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 56b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Useful constants. 572c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner ChunkSize = (1 << FilePosBits) 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 629dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isFileID() const { return (ID >> 31) == 0; } 639dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isMacroID() const { return (ID >> 31) != 0; } 649dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 65b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// isValid - Return true if this is a valid SourceLocation object. Invalid 66b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// SourceLocations are often used when events have no corresponding location 67b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// in the source (e.g. a diagnostic is required for a command line option). 68b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// 69b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isValid() const { return ID != 0; } 70b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isInvalid() const { return ID == 0; } 71b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 729dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner static SourceLocation getFileLoc(unsigned FileID, unsigned FilePos) { 739dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // If a FilePos is larger than (1<<FilePosBits), the SourceManager makes 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // enough consequtive FileIDs that we have one for each chunk. 762c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner if (FilePos >= ChunkSize) { 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileID += FilePos >> FilePosBits; 782c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner FilePos &= ChunkSize-1; 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // FIXME: Find a way to handle out of FileID bits! Maybe MaxFileID is an 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // escape of some sort? 834cabcfea26bc3465d8723fe7997ab4a1a657aea8Chris Lattner assert(FileID < (1 << FileIDBits) && "Out of fileid's"); 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 859dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner L.ID = (FileID << FilePosBits) | FilePos; 869dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 89d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner static bool isValidMacroPhysOffs(int Val) { 90d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner if (Val >= 0) 91d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return Val < (1 << (MacroPhysOffsBits-1)); 92d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return -Val < (1 << (MacroPhysOffsBits-1)); 93d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner } 94d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 95d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner static SourceLocation getMacroLoc(unsigned MacroID, int PhysOffs, 96b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isExpansionStart, bool isExpansionEnd){ 979dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(MacroID < (1 << MacroIDBits) && "Too many macros!"); 98d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner assert(isValidMacroPhysOffs(PhysOffs) && "Physoffs too large!"); 999dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 100b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Mask off sign bits. 101d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner PhysOffs &= (1 << MacroPhysOffsBits)-1; 102d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 103d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 104b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner L.ID = (1 << 31) | 105b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner (isExpansionStart << MacroStartOfExpansionBit) | 106b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner (isExpansionEnd << MacroEndOfExpansionBit) | 107b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner (MacroID << MacroPhysOffsBits) | 108b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner PhysOffs; 1099dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1109dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1119dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1129dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFileID - Return the file identifier for this SourceLocation. This 1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileID can be used with the SourceManager object to obtain an entire 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// include stack for a file position reference. 1169dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getFileID() const { 1179dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1189dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return ID >> FilePosBits; 1199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawFilePos - Return the byte offset from the start of the file-chunk 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// referred to by FileID. This method should not be used to get the offset 1235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// from the start of the file, instead you should use 1245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SourceManager::getFilePos. This method will be incorrect for large files. 1259dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getRawFilePos() const { 1269dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1272c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner return ID & (ChunkSize-1); 1289dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1299dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1309dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getMacroID() const { 1319dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 132b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner return (ID >> MacroPhysOffsBits) & ((1 << MacroIDBits)-1); 1339dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1349dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 135d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner int getMacroPhysOffs() const { 1369dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 137b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner int Val = ID & ((1 << MacroPhysOffsBits)-1); 138d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner // Sign extend it properly. 139d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner unsigned ShAmt = sizeof(int)*8 - MacroPhysOffsBits; 140d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return (Val << ShAmt) >> ShAmt; 1419dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1429dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1439dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1449dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 145d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 1462c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner unsigned FileID = getFileID(); 1472c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += getRawFilePos(); 1482c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner // Handle negative offsets correctly. 1492c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner while (Offset < 0) { 1502c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner --FileID; 1512c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += ChunkSize; 1522c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner } 1532c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner return getFileLoc(FileID, Offset); 1549dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 1655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 1665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 169beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 170beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceLocation object to Bitcode. 171beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 172beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 173beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceLocation object from Bitcode. 174beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceLocation ReadVal(llvm::Deserializer& D); 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 194311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getBegin() const { return B; } 195311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getEnd() const { return E; } 1965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 197e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 198e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 199e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 20119a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 202beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceRange object to Bitcode. 203beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 20419a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 205beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceRange object from Bitcode. 206beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceRange ReadVal(llvm::Deserializer& D); 20719a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek}; 20819a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 209e03a2f39accad260c021b7f24f082363578e7a93Ted Kremenek/// FullSourceLoc - A tuple containing both a SourceLocation 210a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek/// and its associated SourceManager. Useful for argument passing to functions 211a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek/// that expect both objects. 212e03a2f39accad260c021b7f24f082363578e7a93Ted Kremenekclass FullSourceLoc { 213a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek SourceLocation Loc; 2149c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceManager* SrcMgr; 215a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekpublic: 2161b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek // Creates a FullSourceLoc where isValid() returns false. 21721584fe015705ca1ea2d852b7ad188c4baf9ffcfTed Kremenek explicit FullSourceLoc() 21821584fe015705ca1ea2d852b7ad188c4baf9ffcfTed Kremenek : Loc(SourceLocation()), SrcMgr((SourceManager*) 0) {} 219a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2209c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek explicit FullSourceLoc(SourceLocation loc, SourceManager& smgr) 2219c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek : Loc(loc), SrcMgr(&smgr) {} 2221b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek 22325bb23aa20b69b107bbb4526b2d156599c2434caTed Kremenek bool isValid() const { return Loc.isValid(); } 2249c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek bool isInvalid() const { return Loc.isInvalid(); } 2259c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2269c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceLocation getLocation() const { return Loc; } 227a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2289c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceManager& getManager() { 2299c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek assert (SrcMgr && "SourceManager is NULL."); 2309c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek return *SrcMgr; 2319c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek } 232a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2331b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek const SourceManager& getManager() const { 234a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek assert (SrcMgr && "SourceManager is NULL."); 235a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek return *SrcMgr; 236a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek } 2379c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2389c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek FullSourceLoc getLogicalLoc(); 2399c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek FullSourceLoc getIncludeLoc(); 2409c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2419c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek unsigned getLineNumber(); 2429c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek unsigned getColumnNumber(); 2439c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2449c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const char *getCharacterData() const; 2459c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2469c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const llvm::MemoryBuffer* getBuffer() const; 2479c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2489c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const char* getSourceName() const; 2499c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const FileEntry* getFileEntryForLoc() const; 2509c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2519c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek bool operator==(const FullSourceLoc& RHS) const { 2529c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek return SrcMgr == RHS.SrcMgr && Loc == RHS.Loc; 2539c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek } 2549c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2559c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek bool operator!=(const FullSourceLoc& RHS) const { 2569c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek return SrcMgr != RHS.SrcMgr || Loc != RHS.Loc; 2579c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek } 258a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek}; 259a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 260beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek} // end namespace clang 26119a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 2625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 263