SourceLocation.h revision e80a59cc41d42a970466cb020b6f44c5b8831d70
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> 189dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// a full include stack, line and column number information for a position in 235f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// an input translation unit. 245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceLocation { 255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned ID; 265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer enum { 285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileIDBits = 14, 299dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner FilePosBits = 32-1-FileIDBits, 309dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 31d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner MacroIDBits = 20, 3231bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner MacroPhysOffsBits = 9, 33d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner MacroLogOffBits = 2 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer }; 355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation() : ID(0) {} // 0 is an invalid FileID. 375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 389dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isFileID() const { return (ID >> 31) == 0; } 399dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isMacroID() const { return (ID >> 31) != 0; } 409dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 419dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner static SourceLocation getFileLoc(unsigned FileID, unsigned FilePos) { 429dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner SourceLocation L; 435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // If a FilePos is larger than (1<<FilePosBits), the SourceManager makes 445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // enough consequtive FileIDs that we have one for each chunk. 455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (FilePos >= (1 << FilePosBits)) { 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileID += FilePos >> FilePosBits; 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FilePos &= (1 << FilePosBits)-1; 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // FIXME: Find a way to handle out of FileID bits! Maybe MaxFileID is an 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // escape of some sort? 525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer if (FileID >= (1 << FileIDBits)) 535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer FileID = (1 << FileIDBits)-1; 545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 559dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner L.ID = (FileID << FilePosBits) | FilePos; 569dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 59d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner static bool isValidMacroPhysOffs(int Val) { 60d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner if (Val >= 0) 61d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return Val < (1 << (MacroPhysOffsBits-1)); 62d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return -Val < (1 << (MacroPhysOffsBits-1)); 63d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner } 64d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 65d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner static SourceLocation getMacroLoc(unsigned MacroID, int PhysOffs, 669dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned LogOffs) { 679dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(MacroID < (1 << MacroIDBits) && "Too many macros!"); 68d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner assert(isValidMacroPhysOffs(PhysOffs) && "Physoffs too large!"); 699dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(LogOffs < (1 << MacroLogOffBits) && "Logical offs too large!"); 709dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 71d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner PhysOffs &= (1 << MacroPhysOffsBits)-1; 72d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner 73d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation L; 749dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner L.ID = (1 << 31) | (MacroID << (MacroPhysOffsBits+MacroLogOffBits)) | 75d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner (PhysOffs << MacroLogOffBits) | 76d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner LogOffs; 779dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return L; 789dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 799dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 809dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isValid - Return true if this is a valid SourceLocation object. Invalid 825f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SourceLocations are often used when events have no corresponding location 835f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// in the source (e.g. a diagnostic is required for a command line option). 845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return ID != 0; } 869dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner bool isInvalid() const { return ID == 0; } 875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 885f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFileID - Return the file identifier for this SourceLocation. This 895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// FileID can be used with the SourceManager object to obtain an entire 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// include stack for a file position reference. 919dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getFileID() const { 929dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 939dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return ID >> FilePosBits; 949dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 955f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 965f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawFilePos - Return the byte offset from the start of the file-chunk 975f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// referred to by FileID. This method should not be used to get the offset 985f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// from the start of the file, instead you should use 995f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// SourceManager::getFilePos. This method will be incorrect for large files. 1009dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getRawFilePos() const { 1019dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isFileID() && "can't get the file id of a non-file sloc!"); 1029dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return ID & ((1 << FilePosBits)-1); 1039dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1049dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1059dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getMacroID() const { 1069dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 1079dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return (ID >> (MacroPhysOffsBits+MacroLogOffBits)) & ((1 << MacroIDBits)-1); 1089dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1099dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 110d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner int getMacroPhysOffs() const { 1119dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 112d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner int Val = (ID >> MacroLogOffBits) & ((1 << MacroPhysOffsBits)-1); 113d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner // Sign extend it properly. 114d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner unsigned ShAmt = sizeof(int)*8 - MacroPhysOffsBits; 115d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner return (Val << ShAmt) >> ShAmt; 1169dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1179dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner 1189dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner unsigned getMacroLogOffs() const { 1199dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner assert(isMacroID() && "Is not a macro id!"); 12031bb8be680ee2facf7fbb3c6c87b9bbd20248328Chris Lattner return ID & ((1 << MacroLogOffBits)-1); 1219dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1225f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1239dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// getFileLocWithOffset - Return a source location with the specified offset 1249dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner /// from this file SourceLocation. 125d1623a81992a24abbfcd5520b32a0dd90857b8a8Chris Lattner SourceLocation getFileLocWithOffset(int Offset) const { 1269dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner return getFileLoc(getFileID(), getRawFilePos()+Offset); 1279dc1f530c086d2c16f8cba758b0f59a5bf41323aChris Lattner } 1285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 1305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// an (opaque) 32-bit integer encoding for it. This should only be passed 1315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// to SourceLocation::getFromRawEncoding, it should not be inspected 1325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// directly. 1335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer unsigned getRawEncoding() const { return ID; } 1345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 1365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// a real SourceLocation. 1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer static SourceLocation getFromRawEncoding(unsigned Encoding) { 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation X; 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer X.ID = Encoding; 1405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return X; 1415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 1455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return LHS.getRawEncoding() == RHS.getRawEncoding(); 1465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerinline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 1495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer return !(LHS == RHS); 1505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} 1515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// SourceRange - a trival tuple used to represent a source range. 1535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass SourceRange { 1545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation B; 1555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation E; 1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 1585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation loc) : B(loc), E(loc) {} 1595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation Begin() const { return B; } 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer SourceLocation End() const { return E; } 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 164e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setBegin(SourceLocation b) { B = b; } 165e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner void setEnd(SourceLocation e) { E = e; } 166e80a59cc41d42a970466cb020b6f44c5b8831d70Chris Lattner 1675f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isValid() const { return B.isValid() && E.isValid(); } 1685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 1695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1705f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer} // end namespace clang 1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 173