SourceLocation.h revision 7bfaaaecb3113f955db31e8d8a51acffd1bc0c27
1//===--- SourceLocation.h - Compact identifier for Source Files -*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines the SourceLocation class. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef LLVM_CLANG_SOURCELOCATION_H 15#define LLVM_CLANG_SOURCELOCATION_H 16 17#include <cassert> 18#include "llvm/Bitcode/SerializationFwd.h" 19 20namespace llvm { 21class MemoryBuffer; 22} 23 24namespace clang { 25 26class SourceManager; 27class FileEntry; 28 29/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 30/// a full include stack, line and column number information for a position in 31/// an input translation unit. 32class SourceLocation { 33 unsigned ID; 34public: 35 enum { 36 // FileID Layout: 37 // bit 31: 0 -> FileID, 1 -> MacroID (invalid for FileID) 38 // 30...17 -> FileID of source location, index into SourceManager table. 39 FileIDBits = 14, 40 // 0...16 -> Index into the chunk of the specified FileID. 41 FilePosBits = 32-1-FileIDBits, 42 43 // MacroID Layout: 44 // bit 31: 1 -> MacroID, 0 -> FileID (invalid for MacroID) 45 46 // bit 29,30: unused. 47 48 // bits 28...9 -> MacroID number. 49 MacroIDBits = 20, 50 // bits 8...0 -> Macro Physical offset 51 MacroPhysOffsBits = 9, 52 53 54 // Useful constants. 55 ChunkSize = (1 << FilePosBits) 56 }; 57 58 SourceLocation() : ID(0) {} // 0 is an invalid FileID. 59 60 bool isFileID() const { return (ID >> 31) == 0; } 61 bool isMacroID() const { return (ID >> 31) != 0; } 62 63 /// isValid - Return true if this is a valid SourceLocation object. Invalid 64 /// SourceLocations are often used when events have no corresponding location 65 /// in the source (e.g. a diagnostic is required for a command line option). 66 /// 67 bool isValid() const { return ID != 0; } 68 bool isInvalid() const { return ID == 0; } 69 70 static SourceLocation getFileLoc(unsigned FileID, unsigned FilePos) { 71 SourceLocation L; 72 // If a FilePos is larger than (1<<FilePosBits), the SourceManager makes 73 // enough consequtive FileIDs that we have one for each chunk. 74 if (FilePos >= ChunkSize) { 75 FileID += FilePos >> FilePosBits; 76 FilePos &= ChunkSize-1; 77 } 78 79 // FIXME: Find a way to handle out of FileID bits! Maybe MaxFileID is an 80 // escape of some sort? 81 assert(FileID < (1 << FileIDBits) && "Out of fileid's"); 82 83 L.ID = (FileID << FilePosBits) | FilePos; 84 return L; 85 } 86 87 static bool isValidMacroPhysOffs(int Val) { 88 if (Val >= 0) 89 return Val < (1 << (MacroPhysOffsBits-1)); 90 return -Val < (1 << (MacroPhysOffsBits-1)); 91 } 92 93 static SourceLocation getMacroLoc(unsigned MacroID, int PhysOffs){ 94 assert(MacroID < (1 << MacroIDBits) && "Too many macros!"); 95 assert(isValidMacroPhysOffs(PhysOffs) && "Physoffs too large!"); 96 97 // Mask off sign bits. 98 PhysOffs &= (1 << MacroPhysOffsBits)-1; 99 100 SourceLocation L; 101 L.ID = (1 << 31) | 102 (MacroID << MacroPhysOffsBits) | 103 PhysOffs; 104 return L; 105 } 106 107 108 /// getFileID - Return the file identifier for this SourceLocation. This 109 /// FileID can be used with the SourceManager object to obtain an entire 110 /// include stack for a file position reference. 111 unsigned getFileID() const { 112 assert(isFileID() && "can't get the file id of a non-file sloc!"); 113 return ID >> FilePosBits; 114 } 115 116 /// getRawFilePos - Return the byte offset from the start of the file-chunk 117 /// referred to by FileID. This method should not be used to get the offset 118 /// from the start of the file, instead you should use 119 /// SourceManager::getDecomposedFileLoc. This method will be 120 // incorrect for large files. 121 unsigned getRawFilePos() const { 122 assert(isFileID() && "can't get the file id of a non-file sloc!"); 123 return ID & (ChunkSize-1); 124 } 125 126 unsigned getMacroID() const { 127 assert(isMacroID() && "Is not a macro id!"); 128 return (ID >> MacroPhysOffsBits) & ((1 << MacroIDBits)-1); 129 } 130 131 int getMacroPhysOffs() const { 132 assert(isMacroID() && "Is not a macro id!"); 133 int Val = ID & ((1 << MacroPhysOffsBits)-1); 134 // Sign extend it properly. 135 unsigned ShAmt = sizeof(int)*8 - MacroPhysOffsBits; 136 return (Val << ShAmt) >> ShAmt; 137 } 138 139 /// getFileLocWithOffset - Return a source location with the specified offset 140 /// from this file SourceLocation. 141 SourceLocation getFileLocWithOffset(int Offset) const { 142 unsigned FileID = getFileID(); 143 Offset += getRawFilePos(); 144 // Handle negative offsets correctly. 145 while (Offset < 0) { 146 --FileID; 147 Offset += ChunkSize; 148 } 149 return getFileLoc(FileID, Offset); 150 } 151 152 /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 153 /// an (opaque) 32-bit integer encoding for it. This should only be passed 154 /// to SourceLocation::getFromRawEncoding, it should not be inspected 155 /// directly. 156 unsigned getRawEncoding() const { return ID; } 157 158 /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 159 /// a real SourceLocation. 160 static SourceLocation getFromRawEncoding(unsigned Encoding) { 161 SourceLocation X; 162 X.ID = Encoding; 163 return X; 164 } 165 166 /// Emit - Emit this SourceLocation object to Bitcode. 167 void Emit(llvm::Serializer& S) const; 168 169 /// ReadVal - Read a SourceLocation object from Bitcode. 170 static SourceLocation ReadVal(llvm::Deserializer& D); 171}; 172 173inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 174 return LHS.getRawEncoding() == RHS.getRawEncoding(); 175} 176 177inline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 178 return !(LHS == RHS); 179} 180 181/// SourceRange - a trival tuple used to represent a source range. 182class SourceRange { 183 SourceLocation B; 184 SourceLocation E; 185public: 186 SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 187 SourceRange(SourceLocation loc) : B(loc), E(loc) {} 188 SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 189 190 SourceLocation getBegin() const { return B; } 191 SourceLocation getEnd() const { return E; } 192 193 void setBegin(SourceLocation b) { B = b; } 194 void setEnd(SourceLocation e) { E = e; } 195 196 bool isValid() const { return B.isValid() && E.isValid(); } 197 198 /// Emit - Emit this SourceRange object to Bitcode. 199 void Emit(llvm::Serializer& S) const; 200 201 /// ReadVal - Read a SourceRange object from Bitcode. 202 static SourceRange ReadVal(llvm::Deserializer& D); 203}; 204 205/// FullSourceLoc - A tuple containing both a SourceLocation 206/// and its associated SourceManager. Useful for argument passing to functions 207/// that expect both objects. 208class FullSourceLoc { 209 SourceLocation Loc; 210 SourceManager* SrcMgr; 211public: 212 // Creates a FullSourceLoc where isValid() returns false. 213 explicit FullSourceLoc() 214 : Loc(SourceLocation()), SrcMgr((SourceManager*) 0) {} 215 216 explicit FullSourceLoc(SourceLocation loc, SourceManager& smgr) 217 : Loc(loc), SrcMgr(&smgr) {} 218 219 bool isValid() const { return Loc.isValid(); } 220 bool isInvalid() const { return Loc.isInvalid(); } 221 222 SourceLocation getLocation() const { return Loc; } 223 224 SourceManager& getManager() { 225 assert (SrcMgr && "SourceManager is NULL."); 226 return *SrcMgr; 227 } 228 229 const SourceManager& getManager() const { 230 assert (SrcMgr && "SourceManager is NULL."); 231 return *SrcMgr; 232 } 233 234 FullSourceLoc getLogicalLoc(); 235 FullSourceLoc getIncludeLoc(); 236 237 unsigned getLineNumber() const; 238 unsigned getColumnNumber() const; 239 240 unsigned getLogicalLineNumber() const; 241 unsigned getLogicalColumnNumber() const; 242 243 const char *getCharacterData() const; 244 245 const llvm::MemoryBuffer* getBuffer() const; 246 247 const char* getSourceName() const; 248 const FileEntry* getFileEntryForLoc() const; 249 250 bool isInSystemHeader() const; 251 252 bool isFileID() const { return Loc.isFileID(); } 253 254 unsigned getCanonicalFileID() const; 255 256 bool operator==(const FullSourceLoc& RHS) const { 257 return SrcMgr == RHS.SrcMgr && Loc == RHS.Loc; 258 } 259 260 bool operator!=(const FullSourceLoc& RHS) const { 261 return SrcMgr != RHS.SrcMgr || Loc != RHS.Loc; 262 } 263}; 264 265} // end namespace clang 266 267#endif 268