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 //===----------------------------------------------------------------------===//
11 /// \brief Defines the clang::SourceLocation class and associated facilities.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_BASIC_SOURCELOCATION_H
16 #define LLVM_CLANG_BASIC_SOURCELOCATION_H
18 #include "clang/Basic/LLVM.h"
19 #include "llvm/Support/Compiler.h"
20 #include "llvm/Support/PointerLikeTypeTraits.h"
28 template <typename T> struct DenseMapInfo;
29 template <typename T> struct isPodLike;
36 /// \brief An opaque identifier used by SourceManager which refers to a
37 /// source file (MemoryBuffer) along with its \#include path and \#line data.
40 /// \brief A mostly-opaque identifier, where 0 is "invalid", >0 is
41 /// this module, and <-1 is something loaded from another module.
46 bool isValid() const { return ID != 0; }
47 bool isInvalid() const { return ID == 0; }
49 bool operator==(const FileID &RHS) const { return ID == RHS.ID; }
50 bool operator<(const FileID &RHS) const { return ID < RHS.ID; }
51 bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; }
52 bool operator!=(const FileID &RHS) const { return !(*this == RHS); }
53 bool operator>(const FileID &RHS) const { return RHS < *this; }
54 bool operator>=(const FileID &RHS) const { return RHS <= *this; }
56 static FileID getSentinel() { return get(-1); }
57 unsigned getHashValue() const { return static_cast<unsigned>(ID); }
60 friend class SourceManager;
61 friend class ASTWriter;
62 friend class ASTReader;
64 static FileID get(int V) {
69 int getOpaqueValue() const { return ID; }
73 /// \brief Encodes a location in the source. The SourceManager can decode this
74 /// to get at the full include stack, line and column information.
76 /// Technically, a source location is simply an offset into the manager's view
77 /// of the input source, which is all input buffers (including macro
78 /// expansions) concatenated in an effectively arbitrary order. The manager
79 /// actually maintains two blocks of input buffers. One, starting at offset
80 /// 0 and growing upwards, contains all buffers from this module. The other,
81 /// starting at the highest possible offset and growing downwards, contains
82 /// buffers of loaded modules.
84 /// In addition, one bit of SourceLocation is used for quick access to the
85 /// information whether the location is in a file or a macro expansion.
87 /// It is important that this type remains small. It is currently 32 bits wide.
88 class SourceLocation {
90 friend class SourceManager;
91 friend class ASTReader;
92 friend class ASTWriter;
98 SourceLocation() : ID(0) {}
100 bool isFileID() const { return (ID & MacroIDBit) == 0; }
101 bool isMacroID() const { return (ID & MacroIDBit) != 0; }
103 /// \brief Return true if this is a valid SourceLocation object.
105 /// Invalid SourceLocations are often used when events have no corresponding
106 /// location in the source (e.g. a diagnostic is required for a command line
108 bool isValid() const { return ID != 0; }
109 bool isInvalid() const { return ID == 0; }
112 /// \brief Return the offset into the manager's global input view.
113 unsigned getOffset() const {
114 return ID & ~MacroIDBit;
117 static SourceLocation getFileLoc(unsigned ID) {
118 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
124 static SourceLocation getMacroLoc(unsigned ID) {
125 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
127 L.ID = MacroIDBit | ID;
132 /// \brief Return a source location with the specified offset from this
134 SourceLocation getLocWithOffset(int Offset) const {
135 assert(((getOffset()+Offset) & MacroIDBit) == 0 && "offset overflow");
141 /// \brief When a SourceLocation itself cannot be used, this returns
142 /// an (opaque) 32-bit integer encoding for it.
144 /// This should only be passed to SourceLocation::getFromRawEncoding, it
145 /// should not be inspected directly.
146 unsigned getRawEncoding() const { return ID; }
148 /// \brief Turn a raw encoding of a SourceLocation object into
149 /// a real SourceLocation.
151 /// \see getRawEncoding.
152 static SourceLocation getFromRawEncoding(unsigned Encoding) {
158 /// \brief When a SourceLocation itself cannot be used, this returns
159 /// an (opaque) pointer encoding for it.
161 /// This should only be passed to SourceLocation::getFromPtrEncoding, it
162 /// should not be inspected directly.
163 void* getPtrEncoding() const {
164 // Double cast to avoid a warning "cast to pointer from integer of different
166 return (void*)(uintptr_t)getRawEncoding();
169 /// \brief Turn a pointer encoding of a SourceLocation object back
170 /// into a real SourceLocation.
171 static SourceLocation getFromPtrEncoding(const void *Encoding) {
172 return getFromRawEncoding((unsigned)(uintptr_t)Encoding);
175 void print(raw_ostream &OS, const SourceManager &SM) const;
176 std::string printToString(const SourceManager &SM) const;
177 void dump(const SourceManager &SM) const;
180 inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) {
181 return LHS.getRawEncoding() == RHS.getRawEncoding();
184 inline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) {
185 return !(LHS == RHS);
188 inline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) {
189 return LHS.getRawEncoding() < RHS.getRawEncoding();
192 /// \brief A trivial tuple used to represent a source range.
197 SourceRange(): B(SourceLocation()), E(SourceLocation()) {}
198 SourceRange(SourceLocation loc) : B(loc), E(loc) {}
199 SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {}
201 SourceLocation getBegin() const { return B; }
202 SourceLocation getEnd() const { return E; }
204 void setBegin(SourceLocation b) { B = b; }
205 void setEnd(SourceLocation e) { E = e; }
207 bool isValid() const { return B.isValid() && E.isValid(); }
208 bool isInvalid() const { return !isValid(); }
210 bool operator==(const SourceRange &X) const {
211 return B == X.B && E == X.E;
214 bool operator!=(const SourceRange &X) const {
215 return B != X.B || E != X.E;
219 /// \brief Represents a character-granular source range.
221 /// The underlying SourceRange can either specify the starting/ending character
222 /// of the range, or it can specify the start of the range and the start of the
223 /// last token of the range (a "token range"). In the token range case, the
224 /// size of the last token must be measured to determine the actual end of the
226 class CharSourceRange {
230 CharSourceRange() : IsTokenRange(false) {}
231 CharSourceRange(SourceRange R, bool ITR) : Range(R), IsTokenRange(ITR) {}
233 static CharSourceRange getTokenRange(SourceRange R) {
234 return CharSourceRange(R, true);
237 static CharSourceRange getCharRange(SourceRange R) {
238 return CharSourceRange(R, false);
241 static CharSourceRange getTokenRange(SourceLocation B, SourceLocation E) {
242 return getTokenRange(SourceRange(B, E));
244 static CharSourceRange getCharRange(SourceLocation B, SourceLocation E) {
245 return getCharRange(SourceRange(B, E));
248 /// \brief Return true if the end of this range specifies the start of
249 /// the last token. Return false if the end of this range specifies the last
250 /// character in the range.
251 bool isTokenRange() const { return IsTokenRange; }
252 bool isCharRange() const { return !IsTokenRange; }
254 SourceLocation getBegin() const { return Range.getBegin(); }
255 SourceLocation getEnd() const { return Range.getEnd(); }
256 SourceRange getAsRange() const { return Range; }
258 void setBegin(SourceLocation b) { Range.setBegin(b); }
259 void setEnd(SourceLocation e) { Range.setEnd(e); }
261 bool isValid() const { return Range.isValid(); }
262 bool isInvalid() const { return !isValid(); }
265 /// \brief Represents an unpacked "presumed" location which can be presented
268 /// A 'presumed' location can be modified by \#line and GNU line marker
269 /// directives and is always the expansion point of a normal location.
271 /// You can get a PresumedLoc from a SourceLocation with SourceManager.
273 const char *Filename;
275 SourceLocation IncludeLoc;
278 PresumedLoc() : Filename(nullptr) {}
279 PresumedLoc(const char *FN, unsigned Ln, unsigned Co, SourceLocation IL)
280 : Filename(FN), Line(Ln), Col(Co), IncludeLoc(IL) {}
282 /// \brief Return true if this object is invalid or uninitialized.
284 /// This occurs when created with invalid source locations or when walking
285 /// off the top of a \#include stack.
286 bool isInvalid() const { return Filename == nullptr; }
287 bool isValid() const { return Filename != nullptr; }
289 /// \brief Return the presumed filename of this location.
291 /// This can be affected by \#line etc.
292 const char *getFilename() const {
297 /// \brief Return the presumed line number of this location.
299 /// This can be affected by \#line etc.
300 unsigned getLine() const {
305 /// \brief Return the presumed column number of this location.
307 /// This cannot be affected by \#line, but is packaged here for convenience.
308 unsigned getColumn() const {
313 /// \brief Return the presumed include location of this location.
315 /// This can be affected by GNU linemarker directives.
316 SourceLocation getIncludeLoc() const {
324 /// \brief A SourceLocation and its associated SourceManager.
326 /// This is useful for argument passing to functions that expect both objects.
327 class FullSourceLoc : public SourceLocation {
328 const SourceManager *SrcMgr;
330 /// \brief Creates a FullSourceLoc where isValid() returns \c false.
331 explicit FullSourceLoc() : SrcMgr(nullptr) {}
333 explicit FullSourceLoc(SourceLocation Loc, const SourceManager &SM)
334 : SourceLocation(Loc), SrcMgr(&SM) {}
336 bool hasManager() const {
337 bool hasSrcMgr = SrcMgr != nullptr;
338 assert(hasSrcMgr == isValid() && "FullSourceLoc has location but no manager");
342 /// \pre This FullSourceLoc has an associated SourceManager.
343 const SourceManager &getManager() const {
344 assert(SrcMgr && "SourceManager is NULL.");
348 FileID getFileID() const;
350 FullSourceLoc getExpansionLoc() const;
351 FullSourceLoc getSpellingLoc() const;
352 FullSourceLoc getFileLoc() const;
353 std::pair<FullSourceLoc, FullSourceLoc> getImmediateExpansionRange() const;
354 PresumedLoc getPresumedLoc(bool UseLineDirectives = true) const;
355 bool isMacroArgExpansion(FullSourceLoc *StartLoc = nullptr) const;
356 FullSourceLoc getImmediateMacroCallerLoc() const;
357 std::pair<FullSourceLoc, StringRef> getModuleImportLoc() const;
358 unsigned getFileOffset() const;
360 unsigned getExpansionLineNumber(bool *Invalid = nullptr) const;
361 unsigned getExpansionColumnNumber(bool *Invalid = nullptr) const;
363 unsigned getSpellingLineNumber(bool *Invalid = nullptr) const;
364 unsigned getSpellingColumnNumber(bool *Invalid = nullptr) const;
366 const char *getCharacterData(bool *Invalid = nullptr) const;
368 unsigned getLineNumber(bool *Invalid = nullptr) const;
369 unsigned getColumnNumber(bool *Invalid = nullptr) const;
371 std::pair<FullSourceLoc, FullSourceLoc> getExpansionRange() const;
373 const FileEntry *getFileEntry() const;
375 /// \brief Return a StringRef to the source buffer data for the
376 /// specified FileID.
377 StringRef getBufferData(bool *Invalid = nullptr) const;
379 /// \brief Decompose the specified location into a raw FileID + Offset pair.
381 /// The first element is the FileID, the second is the offset from the
382 /// start of the buffer of the location.
383 std::pair<FileID, unsigned> getDecomposedLoc() const;
385 bool isInSystemHeader() const;
387 /// \brief Determines the order of 2 source locations in the translation unit.
389 /// \returns true if this source location comes before 'Loc', false otherwise.
390 bool isBeforeInTranslationUnitThan(SourceLocation Loc) const;
392 /// \brief Determines the order of 2 source locations in the translation unit.
394 /// \returns true if this source location comes before 'Loc', false otherwise.
395 bool isBeforeInTranslationUnitThan(FullSourceLoc Loc) const {
396 assert(Loc.isValid());
397 assert(SrcMgr == Loc.SrcMgr && "Loc comes from another SourceManager!");
398 return isBeforeInTranslationUnitThan((SourceLocation)Loc);
401 /// \brief Comparison function class, useful for sorting FullSourceLocs.
402 struct BeforeThanCompare {
403 bool operator()(const FullSourceLoc& lhs, const FullSourceLoc& rhs) const {
404 return lhs.isBeforeInTranslationUnitThan(rhs);
408 /// \brief Prints information about this FullSourceLoc to stderr.
410 /// This is useful for debugging.
414 operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
415 return LHS.getRawEncoding() == RHS.getRawEncoding() &&
416 LHS.SrcMgr == RHS.SrcMgr;
420 operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
421 return !(LHS == RHS);
428 } // end namespace clang
431 /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and
434 struct DenseMapInfo<clang::FileID> {
435 static inline clang::FileID getEmptyKey() {
436 return clang::FileID();
438 static inline clang::FileID getTombstoneKey() {
439 return clang::FileID::getSentinel();
442 static unsigned getHashValue(clang::FileID S) {
443 return S.getHashValue();
446 static bool isEqual(clang::FileID LHS, clang::FileID RHS) {
452 struct isPodLike<clang::SourceLocation> { static const bool value = true; };
454 struct isPodLike<clang::FileID> { static const bool value = true; };
456 // Teach SmallPtrSet how to handle SourceLocation.
458 class PointerLikeTypeTraits<clang::SourceLocation> {
460 static inline void *getAsVoidPointer(clang::SourceLocation L) {
461 return L.getPtrEncoding();
463 static inline clang::SourceLocation getFromVoidPointer(void *P) {
464 return clang::SourceLocation::getFromRawEncoding((unsigned)(uintptr_t)P);
466 enum { NumLowBitsAvailable = 0 };
469 } // end namespace llvm