1 //===--- SourceLocation.h - Compact identifier for Source Files -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the SourceLocation class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_SOURCELOCATION_H
15 #define LLVM_CLANG_SOURCELOCATION_H
17 #include "clang/Basic/LLVM.h"
18 #include "llvm/Support/PointerLikeTypeTraits.h"
25 template <typename T> struct DenseMapInfo;
26 template <typename T> struct isPodLike;
33 /// FileID - This is an opaque identifier used by SourceManager which refers to
34 /// a source file (MemoryBuffer) along with its #include path and #line data.
37 /// ID - Opaque identifier, 0 is "invalid". >0 is this module, <-1 is
38 /// something loaded from another module.
43 bool isInvalid() const { return ID == 0; }
45 bool operator==(const FileID &RHS) const { return ID == RHS.ID; }
46 bool operator<(const FileID &RHS) const { return ID < RHS.ID; }
47 bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; }
48 bool operator!=(const FileID &RHS) const { return !(*this == RHS); }
49 bool operator>(const FileID &RHS) const { return RHS < *this; }
50 bool operator>=(const FileID &RHS) const { return RHS <= *this; }
52 static FileID getSentinel() { return get(-1); }
53 unsigned getHashValue() const { return static_cast<unsigned>(ID); }
56 friend class SourceManager;
57 friend class ASTWriter;
58 friend class ASTReader;
60 static FileID get(int V) {
65 int getOpaqueValue() const { return ID; }
69 /// \brief Encodes a location in the source. The SourceManager can decode this
70 /// to get at the full include stack, line and column information.
72 /// Technically, a source location is simply an offset into the manager's view
73 /// of the input source, which is all input buffers (including macro
74 /// expansions) concatenated in an effectively arbitrary order. The manager
75 /// actually maintains two blocks of input buffers. One, starting at offset
76 /// 0 and growing upwards, contains all buffers from this module. The other,
77 /// starting at the highest possible offset and growing downwards, contains
78 /// buffers of loaded modules.
80 /// In addition, one bit of SourceLocation is used for quick access to the
81 /// information whether the location is in a file or a macro expansion.
83 /// It is important that this type remains small. It is currently 32 bits wide.
84 class SourceLocation {
86 friend class SourceManager;
87 friend class ASTReader;
88 friend class ASTWriter;
94 SourceLocation() : ID(0) {}
96 bool isFileID() const { return (ID & MacroIDBit) == 0; }
97 bool isMacroID() const { return (ID & MacroIDBit) != 0; }
99 /// \brief Return true if this is a valid SourceLocation object.
101 /// Invalid SourceLocations are often used when events have no corresponding
102 /// location in the source (e.g. a diagnostic is required for a command line
104 bool isValid() const { return ID != 0; }
105 bool isInvalid() const { return ID == 0; }
108 /// \brief Return the offset into the manager's global input view.
109 unsigned getOffset() const {
110 return ID & ~MacroIDBit;
113 static SourceLocation getFileLoc(unsigned ID) {
114 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
120 static SourceLocation getMacroLoc(unsigned ID) {
121 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
123 L.ID = MacroIDBit | ID;
128 /// \brief Return a source location with the specified offset from this
130 SourceLocation getLocWithOffset(int Offset) const {
131 assert(((getOffset()+Offset) & MacroIDBit) == 0 && "offset overflow");
137 /// getRawEncoding - When a SourceLocation itself cannot be used, this returns
138 /// an (opaque) 32-bit integer encoding for it. This should only be passed
139 /// to SourceLocation::getFromRawEncoding, it should not be inspected
141 unsigned getRawEncoding() const { return ID; }
143 /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into
144 /// a real SourceLocation.
145 static SourceLocation getFromRawEncoding(unsigned Encoding) {
151 /// getPtrEncoding - When a SourceLocation itself cannot be used, this returns
152 /// an (opaque) pointer encoding for it. This should only be passed
153 /// to SourceLocation::getFromPtrEncoding, it should not be inspected
155 void* getPtrEncoding() const {
156 // Double cast to avoid a warning "cast to pointer from integer of different
158 return (void*)(uintptr_t)getRawEncoding();
161 /// getFromPtrEncoding - Turn a pointer encoding of a SourceLocation object
162 /// into a real SourceLocation.
163 static SourceLocation getFromPtrEncoding(void *Encoding) {
164 return getFromRawEncoding((unsigned)(uintptr_t)Encoding);
167 void print(raw_ostream &OS, const SourceManager &SM) const;
168 void dump(const SourceManager &SM) const;
171 inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) {
172 return LHS.getRawEncoding() == RHS.getRawEncoding();
175 inline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) {
176 return !(LHS == RHS);
179 inline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) {
180 return LHS.getRawEncoding() < RHS.getRawEncoding();
183 /// SourceRange - a trival tuple used to represent a source range.
188 SourceRange(): B(SourceLocation()), E(SourceLocation()) {}
189 SourceRange(SourceLocation loc) : B(loc), E(loc) {}
190 SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {}
192 SourceLocation getBegin() const { return B; }
193 SourceLocation getEnd() const { return E; }
195 void setBegin(SourceLocation b) { B = b; }
196 void setEnd(SourceLocation e) { E = e; }
198 bool isValid() const { return B.isValid() && E.isValid(); }
199 bool isInvalid() const { return !isValid(); }
201 bool operator==(const SourceRange &X) const {
202 return B == X.B && E == X.E;
205 bool operator!=(const SourceRange &X) const {
206 return B != X.B || E != X.E;
210 /// CharSourceRange - This class represents a character granular source range.
211 /// The underlying SourceRange can either specify the starting/ending character
212 /// of the range, or it can specify the start or the range and the start of the
213 /// last token of the range (a "token range"). In the token range case, the
214 /// size of the last token must be measured to determine the actual end of the
216 class CharSourceRange {
220 CharSourceRange() : IsTokenRange(false) {}
221 CharSourceRange(SourceRange R, bool ITR) : Range(R),IsTokenRange(ITR){}
223 static CharSourceRange getTokenRange(SourceRange R) {
224 CharSourceRange Result;
226 Result.IsTokenRange = true;
230 static CharSourceRange getCharRange(SourceRange R) {
231 CharSourceRange Result;
233 Result.IsTokenRange = false;
237 static CharSourceRange getTokenRange(SourceLocation B, SourceLocation E) {
238 return getTokenRange(SourceRange(B, E));
240 static CharSourceRange getCharRange(SourceLocation B, SourceLocation E) {
241 return getCharRange(SourceRange(B, E));
244 /// isTokenRange - Return true if the end of this range specifies the start of
245 /// the last token. Return false if the end of this range specifies the last
246 /// character in the range.
247 bool isTokenRange() const { return IsTokenRange; }
249 SourceLocation getBegin() const { return Range.getBegin(); }
250 SourceLocation getEnd() const { return Range.getEnd(); }
251 const SourceRange &getAsRange() const { return Range; }
253 void setBegin(SourceLocation b) { Range.setBegin(b); }
254 void setEnd(SourceLocation e) { Range.setEnd(e); }
256 bool isValid() const { return Range.isValid(); }
257 bool isInvalid() const { return !isValid(); }
260 /// FullSourceLoc - A SourceLocation and its associated SourceManager. Useful
261 /// for argument passing to functions that expect both objects.
262 class FullSourceLoc : public SourceLocation {
263 const SourceManager *SrcMgr;
265 /// Creates a FullSourceLoc where isValid() returns false.
266 explicit FullSourceLoc() : SrcMgr(0) {}
268 explicit FullSourceLoc(SourceLocation Loc, const SourceManager &SM)
269 : SourceLocation(Loc), SrcMgr(&SM) {}
271 const SourceManager &getManager() const {
272 assert(SrcMgr && "SourceManager is NULL.");
276 FileID getFileID() const;
278 FullSourceLoc getExpansionLoc() const;
279 FullSourceLoc getSpellingLoc() const;
281 unsigned getExpansionLineNumber(bool *Invalid = 0) const;
282 unsigned getExpansionColumnNumber(bool *Invalid = 0) const;
284 unsigned getSpellingLineNumber(bool *Invalid = 0) const;
285 unsigned getSpellingColumnNumber(bool *Invalid = 0) const;
287 const char *getCharacterData(bool *Invalid = 0) const;
289 const llvm::MemoryBuffer* getBuffer(bool *Invalid = 0) const;
291 /// getBufferData - Return a StringRef to the source buffer data for the
292 /// specified FileID.
293 StringRef getBufferData(bool *Invalid = 0) const;
295 /// getDecomposedLoc - Decompose the specified location into a raw FileID +
296 /// Offset pair. The first element is the FileID, the second is the
297 /// offset from the start of the buffer of the location.
298 std::pair<FileID, unsigned> getDecomposedLoc() const;
300 bool isInSystemHeader() const;
302 /// \brief Determines the order of 2 source locations in the translation unit.
304 /// \returns true if this source location comes before 'Loc', false otherwise.
305 bool isBeforeInTranslationUnitThan(SourceLocation Loc) const;
307 /// \brief Determines the order of 2 source locations in the translation unit.
309 /// \returns true if this source location comes before 'Loc', false otherwise.
310 bool isBeforeInTranslationUnitThan(FullSourceLoc Loc) const {
311 assert(Loc.isValid());
312 assert(SrcMgr == Loc.SrcMgr && "Loc comes from another SourceManager!");
313 return isBeforeInTranslationUnitThan((SourceLocation)Loc);
316 /// \brief Comparison function class, useful for sorting FullSourceLocs.
317 struct BeforeThanCompare : public std::binary_function<FullSourceLoc,
318 FullSourceLoc, bool> {
319 bool operator()(const FullSourceLoc& lhs, const FullSourceLoc& rhs) const {
320 return lhs.isBeforeInTranslationUnitThan(rhs);
324 /// Prints information about this FullSourceLoc to stderr. Useful for
326 void dump() const { SourceLocation::dump(*SrcMgr); }
329 operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
330 return LHS.getRawEncoding() == RHS.getRawEncoding() &&
331 LHS.SrcMgr == RHS.SrcMgr;
335 operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
336 return !(LHS == RHS);
341 /// PresumedLoc - This class represents an unpacked "presumed" location which
342 /// can be presented to the user. A 'presumed' location can be modified by
343 /// #line and GNU line marker directives and is always the expansion point of
344 /// a normal location.
346 /// You can get a PresumedLoc from a SourceLocation with SourceManager.
348 const char *Filename;
350 SourceLocation IncludeLoc;
352 PresumedLoc() : Filename(0) {}
353 PresumedLoc(const char *FN, unsigned Ln, unsigned Co, SourceLocation IL)
354 : Filename(FN), Line(Ln), Col(Co), IncludeLoc(IL) {
357 /// isInvalid - Return true if this object is invalid or uninitialized. This
358 /// occurs when created with invalid source locations or when walking off
359 /// the top of a #include stack.
360 bool isInvalid() const { return Filename == 0; }
361 bool isValid() const { return Filename != 0; }
363 /// getFilename - Return the presumed filename of this location. This can be
364 /// affected by #line etc.
365 const char *getFilename() const { return Filename; }
367 /// getLine - Return the presumed line number of this location. This can be
368 /// affected by #line etc.
369 unsigned getLine() const { return Line; }
371 /// getColumn - Return the presumed column number of this location. This can
372 /// not be affected by #line, but is packaged here for convenience.
373 unsigned getColumn() const { return Col; }
375 /// getIncludeLoc - Return the presumed include location of this location.
376 /// This can be affected by GNU linemarker directives.
377 SourceLocation getIncludeLoc() const { return IncludeLoc; }
381 } // end namespace clang
384 /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and
387 struct DenseMapInfo<clang::FileID> {
388 static inline clang::FileID getEmptyKey() {
389 return clang::FileID();
391 static inline clang::FileID getTombstoneKey() {
392 return clang::FileID::getSentinel();
395 static unsigned getHashValue(clang::FileID S) {
396 return S.getHashValue();
399 static bool isEqual(clang::FileID LHS, clang::FileID RHS) {
405 struct isPodLike<clang::SourceLocation> { static const bool value = true; };
407 struct isPodLike<clang::FileID> { static const bool value = true; };
409 // Teach SmallPtrSet how to handle SourceLocation.
411 class PointerLikeTypeTraits<clang::SourceLocation> {
413 static inline void *getAsVoidPointer(clang::SourceLocation L) {
414 return L.getPtrEncoding();
416 static inline clang::SourceLocation getFromVoidPointer(void *P) {
417 return clang::SourceLocation::getFromRawEncoding((unsigned)(uintptr_t)P);
419 enum { NumLowBitsAvailable = 0 };
422 } // end namespace llvm