SourceLocation.h revision 5c5db4e94bd1243ba92563acba51ba66afa94917
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 <utility> 18#include <cassert> 19 20namespace llvm { 21 class MemoryBuffer; 22 class raw_ostream; 23 class StringRef; 24 template <typename T> struct DenseMapInfo; 25 template <typename T> struct isPodLike; 26} 27 28namespace clang { 29 30class SourceManager; 31 32/// FileID - This is an opaque identifier used by SourceManager which refers to 33/// a source file (MemoryBuffer) along with its #include path and #line data. 34/// 35class FileID { 36 /// ID - Opaque identifier, 0 is "invalid". 37 unsigned ID; 38public: 39 FileID() : ID(0) {} 40 41 bool isInvalid() const { return ID == 0; } 42 43 bool operator==(const FileID &RHS) const { return ID == RHS.ID; } 44 bool operator<(const FileID &RHS) const { return ID < RHS.ID; } 45 bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; } 46 bool operator!=(const FileID &RHS) const { return !(*this == RHS); } 47 bool operator>(const FileID &RHS) const { return RHS < *this; } 48 bool operator>=(const FileID &RHS) const { return RHS <= *this; } 49 50 static FileID getSentinel() { return get(~0U); } 51 unsigned getHashValue() const { return ID; } 52 53private: 54 friend class SourceManager; 55 static FileID get(unsigned V) { 56 FileID F; 57 F.ID = V; 58 return F; 59 } 60 unsigned getOpaqueValue() const { return ID; } 61}; 62 63 64/// SourceLocation - This is a carefully crafted 32-bit identifier that encodes 65/// a full include stack, line and column number information for a position in 66/// an input translation unit. 67class SourceLocation { 68 unsigned ID; 69 friend class SourceManager; 70 enum { 71 MacroIDBit = 1U << 31 72 }; 73public: 74 75 SourceLocation() : ID(0) {} // 0 is an invalid FileID. 76 77 bool isFileID() const { return (ID & MacroIDBit) == 0; } 78 bool isMacroID() const { return (ID & MacroIDBit) != 0; } 79 80 /// isValid - Return true if this is a valid SourceLocation object. Invalid 81 /// SourceLocations are often used when events have no corresponding location 82 /// in the source (e.g. a diagnostic is required for a command line option). 83 /// 84 bool isValid() const { return ID != 0; } 85 bool isInvalid() const { return ID == 0; } 86 87private: 88 /// getOffset - Return the index for SourceManager's SLocEntryTable table, 89 /// note that this is not an index *into* it though. 90 unsigned getOffset() const { 91 return ID & ~MacroIDBit; 92 } 93 94 static SourceLocation getFileLoc(unsigned ID) { 95 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 96 SourceLocation L; 97 L.ID = ID; 98 return L; 99 } 100 101 static SourceLocation getMacroLoc(unsigned ID) { 102 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!"); 103 SourceLocation L; 104 L.ID = MacroIDBit | ID; 105 return L; 106 } 107public: 108 109 /// getFileLocWithOffset - Return a source location with the specified offset 110 /// from this file SourceLocation. 111 SourceLocation getFileLocWithOffset(int Offset) const { 112 assert(((getOffset()+Offset) & MacroIDBit) == 0 && "invalid location"); 113 SourceLocation L; 114 L.ID = ID+Offset; 115 return L; 116 } 117 118 /// getRawEncoding - When a SourceLocation itself cannot be used, this returns 119 /// an (opaque) 32-bit integer encoding for it. This should only be passed 120 /// to SourceLocation::getFromRawEncoding, it should not be inspected 121 /// directly. 122 unsigned getRawEncoding() const { return ID; } 123 124 125 /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into 126 /// a real SourceLocation. 127 static SourceLocation getFromRawEncoding(unsigned Encoding) { 128 SourceLocation X; 129 X.ID = Encoding; 130 return X; 131 } 132 133 void print(llvm::raw_ostream &OS, const SourceManager &SM) const; 134 void dump(const SourceManager &SM) const; 135}; 136 137inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) { 138 return LHS.getRawEncoding() == RHS.getRawEncoding(); 139} 140 141inline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) { 142 return !(LHS == RHS); 143} 144 145inline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) { 146 return LHS.getRawEncoding() < RHS.getRawEncoding(); 147} 148 149/// SourceRange - a trival tuple used to represent a source range. 150class SourceRange { 151 SourceLocation B; 152 SourceLocation E; 153public: 154 SourceRange(): B(SourceLocation()), E(SourceLocation()) {} 155 SourceRange(SourceLocation loc) : B(loc), E(loc) {} 156 SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {} 157 158 SourceLocation getBegin() const { return B; } 159 SourceLocation getEnd() const { return E; } 160 161 void setBegin(SourceLocation b) { B = b; } 162 void setEnd(SourceLocation e) { E = e; } 163 164 bool isValid() const { return B.isValid() && E.isValid(); } 165 bool isInvalid() const { return !isValid(); } 166 167 bool operator==(const SourceRange &X) const { 168 return B == X.B && E == X.E; 169 } 170 171 bool operator!=(const SourceRange &X) const { 172 return B != X.B || E != X.E; 173 } 174}; 175 176/// FullSourceLoc - A SourceLocation and its associated SourceManager. Useful 177/// for argument passing to functions that expect both objects. 178class FullSourceLoc : public SourceLocation { 179 const SourceManager *SrcMgr; 180public: 181 /// Creates a FullSourceLoc where isValid() returns false. 182 explicit FullSourceLoc() : SrcMgr(0) {} 183 184 explicit FullSourceLoc(SourceLocation Loc, const SourceManager &SM) 185 : SourceLocation(Loc), SrcMgr(&SM) {} 186 187 const SourceManager &getManager() const { 188 assert(SrcMgr && "SourceManager is NULL."); 189 return *SrcMgr; 190 } 191 192 FileID getFileID() const; 193 194 FullSourceLoc getInstantiationLoc() const; 195 FullSourceLoc getSpellingLoc() const; 196 197 unsigned getInstantiationLineNumber(bool *Invalid = 0) const; 198 unsigned getInstantiationColumnNumber(bool *Invalid = 0) const; 199 200 unsigned getSpellingLineNumber(bool *Invalid = 0) const; 201 unsigned getSpellingColumnNumber(bool *Invalid = 0) const; 202 203 const char *getCharacterData(bool *Invalid = 0) const; 204 205 const llvm::MemoryBuffer* getBuffer(bool *Invalid = 0) const; 206 207 /// getBufferData - Return a StringRef to the source buffer data for the 208 /// specified FileID. 209 llvm::StringRef getBufferData(bool *Invalid = 0) const; 210 211 /// getDecomposedLoc - Decompose the specified location into a raw FileID + 212 /// Offset pair. The first element is the FileID, the second is the 213 /// offset from the start of the buffer of the location. 214 std::pair<FileID, unsigned> getDecomposedLoc() const; 215 216 bool isInSystemHeader() const; 217 218 /// Prints information about this FullSourceLoc to stderr. Useful for 219 /// debugging. 220 void dump() const { SourceLocation::dump(*SrcMgr); } 221 222 friend inline bool 223 operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 224 return LHS.getRawEncoding() == RHS.getRawEncoding() && 225 LHS.SrcMgr == RHS.SrcMgr; 226 } 227 228 friend inline bool 229 operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) { 230 return !(LHS == RHS); 231 } 232 233}; 234 235/// PresumedLoc - This class represents an unpacked "presumed" location which 236/// can be presented to the user. A 'presumed' location can be modified by 237/// #line and GNU line marker directives and is always the instantiation point 238/// of a normal location. 239/// 240/// You can get a PresumedLoc from a SourceLocation with SourceManager. 241class PresumedLoc { 242 const char *Filename; 243 unsigned Line, Col; 244 SourceLocation IncludeLoc; 245public: 246 PresumedLoc() : Filename(0) {} 247 PresumedLoc(const char *FN, unsigned Ln, unsigned Co, SourceLocation IL) 248 : Filename(FN), Line(Ln), Col(Co), IncludeLoc(IL) { 249 } 250 251 /// isInvalid - Return true if this object is invalid or uninitialized. This 252 /// occurs when created with invalid source locations or when walking off 253 /// the top of a #include stack. 254 bool isInvalid() const { return Filename == 0; } 255 bool isValid() const { return Filename != 0; } 256 257 /// getFilename - Return the presumed filename of this location. This can be 258 /// affected by #line etc. 259 const char *getFilename() const { return Filename; } 260 261 /// getLine - Return the presumed line number of this location. This can be 262 /// affected by #line etc. 263 unsigned getLine() const { return Line; } 264 265 /// getColumn - Return the presumed column number of this location. This can 266 /// not be affected by #line, but is packaged here for convenience. 267 unsigned getColumn() const { return Col; } 268 269 /// getIncludeLoc - Return the presumed include location of this location. 270 /// This can be affected by GNU linemarker directives. 271 SourceLocation getIncludeLoc() const { return IncludeLoc; } 272}; 273 274 275} // end namespace clang 276 277namespace llvm { 278 /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and 279 /// DenseSets. 280 template <> 281 struct DenseMapInfo<clang::FileID> { 282 static inline clang::FileID getEmptyKey() { 283 return clang::FileID(); 284 } 285 static inline clang::FileID getTombstoneKey() { 286 return clang::FileID::getSentinel(); 287 } 288 289 static unsigned getHashValue(clang::FileID S) { 290 return S.getHashValue(); 291 } 292 293 static bool isEqual(clang::FileID LHS, clang::FileID RHS) { 294 return LHS == RHS; 295 } 296 }; 297 298 template <> 299 struct isPodLike<clang::SourceLocation> { static const bool value = true; }; 300 template <> 301 struct isPodLike<clang::FileID> { static const bool value = true; }; 302 303} // end namespace llvm 304 305#endif 306