SourceLocation.h revision 0b7a158d120ac8d78c114a823e17eedfec6b6658
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 46f8484542bbd9f3445b22fe8d240a1eac790cd8caChris Lattner // bit 29,30: unused. 47f8484542bbd9f3445b22fe8d240a1eac790cd8caChris Lattner 48b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bits 28...9 -> MacroID number. 49d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner MacroIDBits = 20, 50df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner // bits 8...0 -> Macro spelling offset 51df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner MacroSpellingOffsBits = 9, 522c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner 53b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 54b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Useful constants. 552c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner ChunkSize = (1 << FilePosBits) 565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 609dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isFileID() const { return (ID >> 31) == 0; } 619dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isMacroID() const { return (ID >> 31) != 0; } 629dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 63b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// isValid - Return true if this is a valid SourceLocation object. Invalid 64b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// SourceLocations are often used when events have no corresponding location 65b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// in the source (e.g. a diagnostic is required for a command line option). 66b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// 67b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isValid() const { return ID != 0; } 68b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isInvalid() const { return ID == 0; } 69b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 709dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner static SourceLocation getFileLoc(unsigned FileID, unsigned FilePos) { 719dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // If a FilePos is larger than (1<<FilePosBits), the SourceManager makes 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // enough consequtive FileIDs that we have one for each chunk. 742c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner if (FilePos >= ChunkSize) { 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileID += FilePos >> FilePosBits; 762c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner FilePos &= ChunkSize-1; 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // FIXME: Find a way to handle out of FileID bits! Maybe MaxFileID is an 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // escape of some sort? 814cabcfea26bc3465d8723fe7997ab4a1a657aea8Chris Lattner assert(FileID < (1 << FileIDBits) && "Out of fileid's"); 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 839dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner L.ID = (FileID << FilePosBits) | FilePos; 849dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 87df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner static bool isValidMacroSpellingOffs(int Val) { 88d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner if (Val >= 0) 89df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner return Val < (1 << (MacroSpellingOffsBits-1)); 90df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner return -Val <= (1 << (MacroSpellingOffsBits-1)); 91d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner } 92d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 93df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner static SourceLocation getMacroLoc(unsigned MacroID, int SpellingOffs) { 949dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(MacroID < (1 << MacroIDBits) && "Too many macros!"); 95df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner assert(isValidMacroSpellingOffs(SpellingOffs) &&"spelling offs too large!"); 969dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 97b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Mask off sign bits. 98df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner SpellingOffs &= (1 << MacroSpellingOffsBits)-1; 99d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 100d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 101b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner L.ID = (1 << 31) | 102df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner (MacroID << MacroSpellingOffsBits) | 103df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner SpellingOffs; 1049dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1059dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1069dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1079dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFileID - Return the file identifier for this SourceLocation. This 1095f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileID can be used with the SourceManager object to obtain an entire 1105f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// include stack for a file position reference. 1119dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getFileID() const { 1129dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1139dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return ID >> FilePosBits; 1149dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawFilePos - Return the byte offset from the start of the file-chunk 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// referred to by FileID. This method should not be used to get the offset 1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// from the start of the file, instead you should use 1199f68fa52543e04736cf6f40d82f3d6d49a3a0989Ted Kremenek /// SourceManager::getDecomposedFileLoc. This method will be 1209f68fa52543e04736cf6f40d82f3d6d49a3a0989Ted Kremenek // incorrect for large files. 1219dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getRawFilePos() const { 1229dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1232c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner return ID & (ChunkSize-1); 1249dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1259dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1269dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getMacroID() const { 1279dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 128df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner return (ID >> MacroSpellingOffsBits) & ((1 << MacroIDBits)-1); 1299dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1309dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 131df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner int getMacroSpellingOffs() const { 1329dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 133df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner int Val = ID & ((1 << MacroSpellingOffsBits)-1); 134d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner // Sign extend it properly. 135df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned ShAmt = sizeof(int)*8 - MacroSpellingOffsBits; 136d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return (Val << ShAmt) >> ShAmt; 1379dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1389dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1399dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1409dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 141d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 1422c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner unsigned FileID = getFileID(); 1432c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += getRawFilePos(); 1442c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner // Handle negative offsets correctly. 1452c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner while (Offset < 0) { 1462c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner --FileID; 1472c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += ChunkSize; 1482c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner } 1492c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner return getFileLoc(FileID, Offset); 1509dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 158cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner 159cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner bool operator<(const SourceLocation &RHS) const { 160cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner return ID < RHS.ID; 161cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner } 162cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 1645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 1655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 1665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 170beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 171beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceLocation object to Bitcode. 172beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 173beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 174beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceLocation object from Bitcode. 175beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceLocation ReadVal(llvm::Deserializer& D); 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 1945f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 195311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getBegin() const { return B; } 196311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getEnd() const { return E; } 1975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 198e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 199e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 200e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 20219a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 203beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceRange object to Bitcode. 204beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 20519a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 206beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceRange object from Bitcode. 207beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceRange ReadVal(llvm::Deserializer& D); 20819a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek}; 20919a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 210a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// FullSourceLoc - A SourceLocation and its associated SourceManager. Useful 211a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// for argument passing to functions that expect both objects. 212a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattnerclass FullSourceLoc : public SourceLocation { 2139c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceManager* SrcMgr; 214a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekpublic: 2151b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek // Creates a FullSourceLoc where isValid() returns false. 216a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner explicit FullSourceLoc() : SrcMgr((SourceManager*) 0) {} 217a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 218a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner explicit FullSourceLoc(SourceLocation Loc, SourceManager &SM) 219a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner : SourceLocation(Loc), SrcMgr(&SM) {} 2201b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek 2219c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceManager& getManager() { 2229c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek assert (SrcMgr && "SourceManager is NULL."); 2239c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek return *SrcMgr; 2249c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek } 225a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2261b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek const SourceManager& getManager() const { 227a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek assert (SrcMgr && "SourceManager is NULL."); 228a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek return *SrcMgr; 229a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek } 2309c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 231f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner FullSourceLoc getInstantiationLoc() const; 232df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner FullSourceLoc getSpellingLoc() const; 2335c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner FullSourceLoc getIncludeLoc() const; 2349c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2351758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek unsigned getLineNumber() const; 2361758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek unsigned getColumnNumber() const; 2371758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek 238f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner unsigned getInstantiationLineNumber() const; 239f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner unsigned getInstantiationColumnNumber() const; 2409c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 241df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned getSpellingLineNumber() const; 242df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned getSpellingColumnNumber() const; 2435c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner 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; 2507bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 2517bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader() const; 2529c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2535c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// Prints information about this FullSourceLoc to stderr. Useful for 2545c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// debugging. 2555c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner void dump() const; 256a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2570b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor friend inline bool 2580b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 2590b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return LHS.getRawEncoding() == RHS.getRawEncoding() && 2600b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor LHS.SrcMgr == RHS.SrcMgr; 2610b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 262a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner 2630b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor friend inline bool 2640b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 2650b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return !(LHS == RHS); 2660b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 2670b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor 2680b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor}; 2690b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor 270beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek} // end namespace clang 27119a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 2725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 273