SourceLocation.h revision b7489d8129136437953d412e2a6cf0ef87f4a461
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- SourceLocation.h - Compact identifier for Source Files -*- C++ -*-===// 25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// The LLVM Compiler Infrastructure 45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// 55f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// This file was developed by Chris Lattner and is distributed under 65f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer// the University of Illinois Open Source 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 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// a full include stack, line and column number information for a position in 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// an input translation unit. 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceLocation { 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned ID; 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 29b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // FileID Layout: 30b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 31: 0 -> FileID, 1 -> MacroID (invalid for FileID) 31b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // 30...17 -> FileID of source location, index into SourceManager table. 325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileIDBits = 14, 33b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // 0...16 -> Index into the chunk of the specified FileID. 349dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner FilePosBits = 32-1-FileIDBits, 359dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 36b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // MacroID Layout: 37b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 31: 1 -> MacroID, 0 -> FileID (invalid for MacroID) 38b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 39b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 30: 1 -> Start of macro expansion marker. 40b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner MacroStartOfExpansionBit = 30, 41b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bit 29: 1 -> End of macro expansion marker. 42b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner MacroEndOfExpansionBit = 29, 43b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bits 28...9 -> MacroID number. 44d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner MacroIDBits = 20, 45b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // bits 8...0 -> Macro Physical offset 4631bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner MacroPhysOffsBits = 9, 472c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner 48b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 49b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Useful constants. 502c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner ChunkSize = (1 << FilePosBits) 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 559dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isFileID() const { return (ID >> 31) == 0; } 569dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isMacroID() const { return (ID >> 31) != 0; } 579dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 58b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// isValid - Return true if this is a valid SourceLocation object. Invalid 59b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// SourceLocations are often used when events have no corresponding location 60b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// in the source (e.g. a diagnostic is required for a command line option). 61b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner /// 62b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isValid() const { return ID != 0; } 63b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isInvalid() const { return ID == 0; } 64b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner 659dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner static SourceLocation getFileLoc(unsigned FileID, unsigned FilePos) { 669dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // If a FilePos is larger than (1<<FilePosBits), the SourceManager makes 685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // enough consequtive FileIDs that we have one for each chunk. 692c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner if (FilePos >= ChunkSize) { 705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileID += FilePos >> FilePosBits; 712c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner FilePos &= ChunkSize-1; 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // FIXME: Find a way to handle out of FileID bits! Maybe MaxFileID is an 755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // escape of some sort? 764cabcfea26bc3465d8723fe7997ab4a1a657aea8Chris Lattner assert(FileID < (1 << FileIDBits) && "Out of fileid's"); 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 789dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner L.ID = (FileID << FilePosBits) | FilePos; 799dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 82d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner static bool isValidMacroPhysOffs(int Val) { 83d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner if (Val >= 0) 84d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return Val < (1 << (MacroPhysOffsBits-1)); 85d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return -Val < (1 << (MacroPhysOffsBits-1)); 86d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner } 87d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 88d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner static SourceLocation getMacroLoc(unsigned MacroID, int PhysOffs, 89b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner bool isExpansionStart, bool isExpansionEnd){ 909dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(MacroID < (1 << MacroIDBits) && "Too many macros!"); 91d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner assert(isValidMacroPhysOffs(PhysOffs) && "Physoffs too large!"); 929dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 93b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner // Mask off sign bits. 94d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner PhysOffs &= (1 << MacroPhysOffsBits)-1; 95d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 96d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 97b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner L.ID = (1 << 31) | 98b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner (isExpansionStart << MacroStartOfExpansionBit) | 99b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner (isExpansionEnd << MacroEndOfExpansionBit) | 100b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner (MacroID << MacroPhysOffsBits) | 101b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner PhysOffs; 1029dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 1039dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1049dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1059dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1065f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFileID - Return the file identifier for this SourceLocation. This 1075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileID can be used with the SourceManager object to obtain an entire 1085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// include stack for a file position reference. 1099dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getFileID() const { 1109dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1119dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return ID >> FilePosBits; 1129dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawFilePos - Return the byte offset from the start of the file-chunk 1155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// referred to by FileID. This method should not be used to get the offset 1165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// from the start of the file, instead you should use 1175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SourceManager::getFilePos. This method will be incorrect for large files. 1189dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getRawFilePos() const { 1199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1202c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner return ID & (ChunkSize-1); 1219dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1229dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1239dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getMacroID() const { 1249dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 125b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner return (ID >> MacroPhysOffsBits) & ((1 << MacroIDBits)-1); 1269dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1279dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 128d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner int getMacroPhysOffs() const { 1299dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 130b7489d8129136437953d412e2a6cf0ef87f4a461Chris Lattner int Val = ID & ((1 << MacroPhysOffsBits)-1); 131d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner // Sign extend it properly. 132d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner unsigned ShAmt = sizeof(int)*8 - MacroPhysOffsBits; 133d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return (Val << ShAmt) >> ShAmt; 1349dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1359dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1369dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1379dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 138d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 1392c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner unsigned FileID = getFileID(); 1402c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += getRawFilePos(); 1412c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner // Handle negative offsets correctly. 1422c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner while (Offset < 0) { 1432c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner --FileID; 1442c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner Offset += ChunkSize; 1452c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner } 1462c64b7b9381be4ff62fbdc404ed3f14c8086898dChris Lattner return getFileLoc(FileID, Offset); 1479dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 162beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 163beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceLocation object to Bitcode. 164beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 165beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek 166beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceLocation object from Bitcode. 167beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceLocation ReadVal(llvm::Deserializer& D); 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 1755f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 1765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 1795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 1825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 1865f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 187311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getBegin() const { return B; } 188311ff02fae0392bee6abe7723cdf5a69b2899a47Chris Lattner SourceLocation getEnd() const { return E; } 1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 190e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 191e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 192e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 19419a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 195beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// Emit - Emit this SourceRange object to Bitcode. 196beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek void Emit(llvm::Serializer& S) const; 19719a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 198beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek /// ReadVal - Read a SourceRange object from Bitcode. 199beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek static SourceRange ReadVal(llvm::Deserializer& D); 20019a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek}; 20119a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 202beb7713c6102687f7e49e27b8228e84a69d8f6c6Ted Kremenek} // end namespace clang 20319a95bcf3561ed977c48d5f2a2793b60a8c8e573Ted Kremenek 2045f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 205