SourceLocation.h revision bcc2a67e5180612417727cbdd8afd0f79fdf726d
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 { 212b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner class MemoryBuffer; 222b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <typename T> struct DenseMapInfo; 239c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek} 249c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 26a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 27a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekclass SourceManager; 289c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenekclass FileEntry; 292b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 302b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// FileID - This is an opaque identifier used by SourceManager which refers to 312b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// a source file (MemoryBuffer) along with its #include path and #line data. 322b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner/// 332b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerclass FileID { 342b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// ID - Opaque identifier, 0 is "invalid". 352b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned ID; 362b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerpublic: 372b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID() : ID(0) {} 382b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 392b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool isInvalid() const { return ID == 0; } 402b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 412b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator==(const FileID &RHS) const { return ID == RHS.ID; } 422b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<(const FileID &RHS) const { return ID < RHS.ID; } 432b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; } 442b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator!=(const FileID &RHS) const { return !(*this == RHS); } 452b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>(const FileID &RHS) const { return RHS < *this; } 462b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner bool operator>=(const FileID &RHS) const { return RHS <= *this; } 472b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 482b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static FileID getSentinel() { return Create(~0U); } 492b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getHashValue() const { return ID; } 502b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 512b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnerprivate: 522b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner friend class SourceManager; 532b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static FileID Create(unsigned V) { 542b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner FileID F; 552b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner F.ID = V; 562b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return F; 572b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 582b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner unsigned getOpaqueValue() const { return ID; } 592b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner}; 602b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// a full include stack, line and column number information for a position in 645f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// an input translation unit. 655f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceLocation { 665f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned ID; 67bcc2a67e5180612417727cbdd8afd0f79fdf726dChris Lattner friend class SourceManager; 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 70b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // FileID Layout: 71b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 31: 0 -> FileID, 1 -> MacroID (invalid for FileID) 723b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner // 30...17 -> ChunkID of location, index into SourceManager table. 733b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner ChunkIDBits = 14, 743b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner // 0...16 -> Index into the chunk of the specified ChunkID. 753b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner FilePosBits = 32-1-ChunkIDBits, 769dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 77b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // MacroID Layout: 78b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 31: 1 -> MacroID, 0 -> FileID (invalid for MacroID) 79b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 80f8484542bbd9f3445b22fe8d240a1eac790cd8caChris Lattner // bit 29,30: unused. 81f8484542bbd9f3445b22fe8d240a1eac790cd8caChris Lattner 82b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bits 28...9 -> MacroID number. 83d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner MacroIDBits = 20, 84df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner // bits 8...0 -> Macro spelling offset 85df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner MacroSpellingOffsBits = 9, 862c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner 87b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 88b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Useful constants. 892c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner ChunkSize = (1 << FilePosBits) 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 949dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isFileID() const { return (ID >> 31) == 0; } 959dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isMacroID() const { return (ID >> 31) != 0; } 969dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 97b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// isValid - Return true if this is a valid SourceLocation object. Invalid 98b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// SourceLocations are often used when events have no corresponding location 99b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// in the source (e.g. a diagnostic is required for a command line option). 100b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// 101b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isValid() const { return ID != 0; } 102b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isInvalid() const { return ID == 0; } 103b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 104bcc2a67e5180612417727cbdd8afd0f79fdf726dChris Lattnerprivate: 1053b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner static SourceLocation getFileLoc(unsigned ChunkID, unsigned FilePos) { 1069dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // If a FilePos is larger than (1<<FilePosBits), the SourceManager makes 1083b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner // enough consequtive ChunkIDs that we have one for each chunk. 1092c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner if (FilePos >= ChunkSize) { 1103b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner ChunkID += FilePos >> FilePosBits; 1112c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner FilePos &= ChunkSize-1; 1125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1143b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner // FIXME: Find a way to handle out of ChunkID bits! Maybe MaxFileID is an 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // escape of some sort? 1163b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner assert(ChunkID < (1 << ChunkIDBits) && "Out of ChunkID's"); 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1183b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner L.ID = (ChunkID << FilePosBits) | FilePos; 1199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 121bcc2a67e5180612417727cbdd8afd0f79fdf726dChris Lattnerpublic: 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 123df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner static bool isValidMacroSpellingOffs(int Val) { 124d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner if (Val >= 0) 125df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner return Val < (1 << (MacroSpellingOffsBits-1)); 126df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner return -Val <= (1 << (MacroSpellingOffsBits-1)); 127d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner } 128d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 129df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner static SourceLocation getMacroLoc(unsigned MacroID, int SpellingOffs) { 1309dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(MacroID < (1 << MacroIDBits) && "Too many macros!"); 131df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner assert(isValidMacroSpellingOffs(SpellingOffs) &&"spelling offs too large!"); 1329dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 133b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Mask off sign bits. 134df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner SpellingOffs &= (1 << MacroSpellingOffsBits)-1; 135d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 136d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 137b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner L.ID = (1 << 31) | 138df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner (MacroID << MacroSpellingOffsBits) | 139df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner SpellingOffs; 1409dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1419dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1429dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1439dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1443b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner /// getChunkID - Return the chunk identifier for this SourceLocation. This 1453b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner /// ChunkID can be used with the SourceManager object to obtain an entire 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// include stack for a file position reference. 1473b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner unsigned getChunkID() const { 1489dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1499dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return ID >> FilePosBits; 1509dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawFilePos - Return the byte offset from the start of the file-chunk 1533b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner /// referred to by ChunkID. This method should not be used to get the offset 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// from the start of the file, instead you should use 1559f68fa52543e04736cf6f40d82f3d6d49a3a0989Ted Kremenek /// SourceManager::getDecomposedFileLoc. This method will be 1569f68fa52543e04736cf6f40d82f3d6d49a3a0989Ted Kremenek // incorrect for large files. 1579dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getRawFilePos() const { 1589dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1592c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner return ID & (ChunkSize-1); 1609dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1619dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1629dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getMacroID() const { 1639dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 164df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner return (ID >> MacroSpellingOffsBits) & ((1 << MacroIDBits)-1); 1659dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1669dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 167df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner int getMacroSpellingOffs() const { 1689dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 169df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner int Val = ID & ((1 << MacroSpellingOffsBits)-1); 170d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner // Sign extend it properly. 171df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned ShAmt = sizeof(int)*8 - MacroSpellingOffsBits; 172d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return (Val << ShAmt) >> ShAmt; 1739dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1749dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1759dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1769dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 177d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 1783b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner unsigned ChunkID = getChunkID(); 1792c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += getRawFilePos(); 1802c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner // Handle negative offsets correctly. 1812c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner while (Offset < 0) { 1823b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner --ChunkID; 1832c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += ChunkSize; 1842c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner } 1853b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner return getFileLoc(ChunkID, Offset); 1869dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 194cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner 195cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner bool operator<(const SourceLocation &RHS) const { 196cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner return ID < RHS.ID; 197cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner } 198cff9cc95de367a3aea885a7f8fee304fe2707b92Chris Lattner 1995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 2005f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 2055f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 206beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 207beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceLocation object to Bitcode. 208beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 209beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 210beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceLocation object from Bitcode. 211beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceLocation ReadVal(llvm::Deserializer& D); 2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 2175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 2195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 2205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 2215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 2235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 231311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getBegin() const { return B; } 232311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getEnd() const { return E; } 2335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 234e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 235e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 236e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner 2375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 23819a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 239beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceRange object to Bitcode. 240beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 24119a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 242beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceRange object from Bitcode. 243beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceRange ReadVal(llvm::Deserializer& D); 24419a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek}; 24519a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 246a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// FullSourceLoc - A SourceLocation and its associated SourceManager. Useful 247a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner/// for argument passing to functions that expect both objects. 248a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattnerclass FullSourceLoc : public SourceLocation { 2499c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceManager* SrcMgr; 250a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenekpublic: 2511b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek // Creates a FullSourceLoc where isValid() returns false. 252a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner explicit FullSourceLoc() : SrcMgr((SourceManager*) 0) {} 253a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 254a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner explicit FullSourceLoc(SourceLocation Loc, SourceManager &SM) 255a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner : SourceLocation(Loc), SrcMgr(&SM) {} 2561b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek 2579c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek SourceManager& getManager() { 2589c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek assert (SrcMgr && "SourceManager is NULL."); 2599c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek return *SrcMgr; 2609c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek } 261a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2621b924fd6a9730e7de1b175fb82434de6e7e0f0f8Ted Kremenek const SourceManager& getManager() const { 263a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek assert (SrcMgr && "SourceManager is NULL."); 264a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek return *SrcMgr; 265a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek } 2669c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2673b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner FileID getFileID() const; 2683b4d5e955e819dd3a4bed37ea2e47d6e4cb05274Chris Lattner 269f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner FullSourceLoc getInstantiationLoc() const; 270df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner FullSourceLoc getSpellingLoc() const; 2715c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner FullSourceLoc getIncludeLoc() const; 2729c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2731758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek unsigned getLineNumber() const; 2741758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek unsigned getColumnNumber() const; 2751758b07ef7c554b06c48a43df2edaba85e918031Ted Kremenek 276f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner unsigned getInstantiationLineNumber() const; 277f7cf85b330bedd2877e1371fb0a83e99751ae162Chris Lattner unsigned getInstantiationColumnNumber() const; 2789c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 279df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned getSpellingLineNumber() const; 280df7c17a8d02fe09a3466786bae3e40fc3252687aChris Lattner unsigned getSpellingColumnNumber() const; 2815c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner 2829c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const char *getCharacterData() const; 2839c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2849c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const llvm::MemoryBuffer* getBuffer() const; 2859c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2869c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const char* getSourceName() const; 2879c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek const FileEntry* getFileEntryForLoc() const; 2887bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber 2897bfaaaecb3113f955db31e8d8a51acffd1bc0c27Nico Weber bool isInSystemHeader() const; 2909c728dc4d8da89c73fcae74c9e72d7a83ffd7b6dTed Kremenek 2915c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// Prints information about this FullSourceLoc to stderr. Useful for 2925c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner /// debugging. 2935c38b6388dc44dcb8467a9e0f22d93db7221717eChris Lattner void dump() const; 294a9793ed6a77946c988ee38035baf4cde6ff2e864Ted Kremenek 2950b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor friend inline bool 2960b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 2970b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return LHS.getRawEncoding() == RHS.getRawEncoding() && 2980b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor LHS.SrcMgr == RHS.SrcMgr; 2990b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 300a50bd54164393ca3cd08016e7099bdeb531b5014Chris Lattner 3010b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor friend inline bool 3020b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 3030b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor return !(LHS == RHS); 3040b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor } 3050b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor 3060b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor}; 3070b7a158d120ac8d78c114a823e17eedfec6b6658Douglas Gregor 308beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek} // end namespace clang 30919a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 3102b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattnernamespace llvm { 3112b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and 3122b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner /// DenseSets. 3132b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner template <> 3142b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner struct DenseMapInfo<clang::FileID> { 3152b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getEmptyKey() { 3162b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return clang::FileID(); 3172b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3182b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static inline clang::FileID getTombstoneKey() { 3192b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return clang::FileID::getSentinel(); 3202b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3212b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 3222b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static unsigned getHashValue(clang::FileID S) { 3232b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return S.getHashValue(); 3242b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3252b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 3262b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static bool isEqual(clang::FileID LHS, clang::FileID RHS) { 3272b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner return LHS == RHS; 3282b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner } 3292b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 3302b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner static bool isPod() { return true; } 3312b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner }; 3322b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 3332b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner} // end namespace llvm 3342b2453a7d8fe732561795431f39ceb2b2a832d84Chris Lattner 3355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 336