clang  10.0.0git
SourceLocation.h
Go to the documentation of this file.
1 //===- SourceLocation.h - Compact identifier for Source Files ---*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 /// \file
10 /// Defines the clang::SourceLocation class and associated facilities.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_BASIC_SOURCELOCATION_H
15 #define LLVM_CLANG_BASIC_SOURCELOCATION_H
16 
17 #include "clang/Basic/LLVM.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/PointerLikeTypeTraits.h"
20 #include <cassert>
21 #include <cstdint>
22 #include <string>
23 #include <utility>
24 
25 namespace llvm {
26 
27 template <typename T> struct DenseMapInfo;
28 
29 } // namespace llvm
30 
31 namespace clang {
32 
33 class SourceManager;
34 
35 /// An opaque identifier used by SourceManager which refers to a
36 /// source file (MemoryBuffer) along with its \#include path and \#line data.
37 ///
38 class FileID {
39  /// A mostly-opaque identifier, where 0 is "invalid", >0 is
40  /// this module, and <-1 is something loaded from another module.
41  int ID = 0;
42 
43 public:
44  bool isValid() const { return ID != 0; }
45  bool isInvalid() const { return ID == 0; }
46 
47  bool operator==(const FileID &RHS) const { return ID == RHS.ID; }
48  bool operator<(const FileID &RHS) const { return ID < RHS.ID; }
49  bool operator<=(const FileID &RHS) const { return ID <= RHS.ID; }
50  bool operator!=(const FileID &RHS) const { return !(*this == RHS); }
51  bool operator>(const FileID &RHS) const { return RHS < *this; }
52  bool operator>=(const FileID &RHS) const { return RHS <= *this; }
53 
54  static FileID getSentinel() { return get(-1); }
55  unsigned getHashValue() const { return static_cast<unsigned>(ID); }
56 
57 private:
58  friend class ASTWriter;
59  friend class ASTReader;
60  friend class SourceManager;
61 
62  static FileID get(int V) {
63  FileID F;
64  F.ID = V;
65  return F;
66  }
67 
68  int getOpaqueValue() const { return ID; }
69 };
70 
71 /// Encodes a location in the source. The SourceManager can decode this
72 /// to get at the full include stack, line and column information.
73 ///
74 /// Technically, a source location is simply an offset into the manager's view
75 /// of the input source, which is all input buffers (including macro
76 /// expansions) concatenated in an effectively arbitrary order. The manager
77 /// actually maintains two blocks of input buffers. One, starting at offset
78 /// 0 and growing upwards, contains all buffers from this module. The other,
79 /// starting at the highest possible offset and growing downwards, contains
80 /// buffers of loaded modules.
81 ///
82 /// In addition, one bit of SourceLocation is used for quick access to the
83 /// information whether the location is in a file or a macro expansion.
84 ///
85 /// It is important that this type remains small. It is currently 32 bits wide.
87  friend class ASTReader;
88  friend class ASTWriter;
89  friend class SourceManager;
90 
91  unsigned ID = 0;
92 
93  enum : unsigned {
94  MacroIDBit = 1U << 31
95  };
96 
97 public:
98  bool isFileID() const { return (ID & MacroIDBit) == 0; }
99  bool isMacroID() const { return (ID & MacroIDBit) != 0; }
100 
101  /// Return true if this is a valid SourceLocation object.
102  ///
103  /// Invalid SourceLocations are often used when events have no corresponding
104  /// location in the source (e.g. a diagnostic is required for a command line
105  /// option).
106  bool isValid() const { return ID != 0; }
107  bool isInvalid() const { return ID == 0; }
108 
109 private:
110  /// Return the offset into the manager's global input view.
111  unsigned getOffset() const {
112  return ID & ~MacroIDBit;
113  }
114 
115  static SourceLocation getFileLoc(unsigned ID) {
116  assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
117  SourceLocation L;
118  L.ID = ID;
119  return L;
120  }
121 
122  static SourceLocation getMacroLoc(unsigned ID) {
123  assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
124  SourceLocation L;
125  L.ID = MacroIDBit | ID;
126  return L;
127  }
128 
129 public:
130  /// Return a source location with the specified offset from this
131  /// SourceLocation.
133  assert(((getOffset()+Offset) & MacroIDBit) == 0 && "offset overflow");
134  SourceLocation L;
135  L.ID = ID+Offset;
136  return L;
137  }
138 
139  /// When a SourceLocation itself cannot be used, this returns
140  /// an (opaque) 32-bit integer encoding for it.
141  ///
142  /// This should only be passed to SourceLocation::getFromRawEncoding, it
143  /// should not be inspected directly.
144  unsigned getRawEncoding() const { return ID; }
145 
146  /// Turn a raw encoding of a SourceLocation object into
147  /// a real SourceLocation.
148  ///
149  /// \see getRawEncoding.
152  X.ID = Encoding;
153  return X;
154  }
155 
156  /// When a SourceLocation itself cannot be used, this returns
157  /// an (opaque) pointer encoding for it.
158  ///
159  /// This should only be passed to SourceLocation::getFromPtrEncoding, it
160  /// should not be inspected directly.
161  void* getPtrEncoding() const {
162  // Double cast to avoid a warning "cast to pointer from integer of different
163  // size".
164  return (void*)(uintptr_t)getRawEncoding();
165  }
166 
167  /// Turn a pointer encoding of a SourceLocation object back
168  /// into a real SourceLocation.
170  return getFromRawEncoding((unsigned)(uintptr_t)Encoding);
171  }
172 
174  return Start.isValid() && Start.isFileID() && End.isValid() &&
175  End.isFileID();
176  }
177 
178  void print(raw_ostream &OS, const SourceManager &SM) const;
179  std::string printToString(const SourceManager &SM) const;
180  void dump(const SourceManager &SM) const;
181 };
182 
183 inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) {
184  return LHS.getRawEncoding() == RHS.getRawEncoding();
185 }
186 
187 inline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) {
188  return !(LHS == RHS);
189 }
190 
191 // Ordering is meaningful only if LHS and RHS have the same FileID!
192 // Otherwise use SourceManager::isBeforeInTranslationUnit().
193 inline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) {
194  return LHS.getRawEncoding() < RHS.getRawEncoding();
195 }
196 inline bool operator>(const SourceLocation &LHS, const SourceLocation &RHS) {
197  return LHS.getRawEncoding() > RHS.getRawEncoding();
198 }
199 inline bool operator<=(const SourceLocation &LHS, const SourceLocation &RHS) {
200  return LHS.getRawEncoding() <= RHS.getRawEncoding();
201 }
202 inline bool operator>=(const SourceLocation &LHS, const SourceLocation &RHS) {
203  return LHS.getRawEncoding() >= RHS.getRawEncoding();
204 }
205 
206 /// A trivial tuple used to represent a source range.
207 class SourceRange {
208  SourceLocation B;
209  SourceLocation E;
210 
211 public:
212  SourceRange() = default;
213  SourceRange(SourceLocation loc) : B(loc), E(loc) {}
214  SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {}
215 
216  SourceLocation getBegin() const { return B; }
217  SourceLocation getEnd() const { return E; }
218 
219  void setBegin(SourceLocation b) { B = b; }
220  void setEnd(SourceLocation e) { E = e; }
221 
222  bool isValid() const { return B.isValid() && E.isValid(); }
223  bool isInvalid() const { return !isValid(); }
224 
225  bool operator==(const SourceRange &X) const {
226  return B == X.B && E == X.E;
227  }
228 
229  bool operator!=(const SourceRange &X) const {
230  return B != X.B || E != X.E;
231  }
232 
233  // Returns true iff other is wholly contained within this range.
234  bool fullyContains(const SourceRange &other) const {
235  return B <= other.B && E >= other.E;
236  }
237 
238  void print(raw_ostream &OS, const SourceManager &SM) const;
239  std::string printToString(const SourceManager &SM) const;
240  void dump(const SourceManager &SM) const;
241 };
242 
243 /// Represents a character-granular source range.
244 ///
245 /// The underlying SourceRange can either specify the starting/ending character
246 /// of the range, or it can specify the start of the range and the start of the
247 /// last token of the range (a "token range"). In the token range case, the
248 /// size of the last token must be measured to determine the actual end of the
249 /// range.
251  SourceRange Range;
252  bool IsTokenRange = false;
253 
254 public:
255  CharSourceRange() = default;
256  CharSourceRange(SourceRange R, bool ITR) : Range(R), IsTokenRange(ITR) {}
257 
259  return CharSourceRange(R, true);
260  }
261 
263  return CharSourceRange(R, false);
264  }
265 
267  return getTokenRange(SourceRange(B, E));
268  }
269 
271  return getCharRange(SourceRange(B, E));
272  }
273 
274  /// Return true if the end of this range specifies the start of
275  /// the last token. Return false if the end of this range specifies the last
276  /// character in the range.
277  bool isTokenRange() const { return IsTokenRange; }
278  bool isCharRange() const { return !IsTokenRange; }
279 
280  SourceLocation getBegin() const { return Range.getBegin(); }
281  SourceLocation getEnd() const { return Range.getEnd(); }
282  SourceRange getAsRange() const { return Range; }
283 
284  void setBegin(SourceLocation b) { Range.setBegin(b); }
285  void setEnd(SourceLocation e) { Range.setEnd(e); }
286  void setTokenRange(bool TR) { IsTokenRange = TR; }
287 
288  bool isValid() const { return Range.isValid(); }
289  bool isInvalid() const { return !isValid(); }
290 };
291 
292 /// Represents an unpacked "presumed" location which can be presented
293 /// to the user.
294 ///
295 /// A 'presumed' location can be modified by \#line and GNU line marker
296 /// directives and is always the expansion point of a normal location.
297 ///
298 /// You can get a PresumedLoc from a SourceLocation with SourceManager.
299 class PresumedLoc {
300  const char *Filename = nullptr;
301  FileID ID;
302  unsigned Line, Col;
303  SourceLocation IncludeLoc;
304 
305 public:
306  PresumedLoc() = default;
307  PresumedLoc(const char *FN, FileID FID, unsigned Ln, unsigned Co,
308  SourceLocation IL)
309  : Filename(FN), ID(FID), Line(Ln), Col(Co), IncludeLoc(IL) {}
310 
311  /// Return true if this object is invalid or uninitialized.
312  ///
313  /// This occurs when created with invalid source locations or when walking
314  /// off the top of a \#include stack.
315  bool isInvalid() const { return Filename == nullptr; }
316  bool isValid() const { return Filename != nullptr; }
317 
318  /// Return the presumed filename of this location.
319  ///
320  /// This can be affected by \#line etc.
321  const char *getFilename() const {
322  assert(isValid());
323  return Filename;
324  }
325 
326  FileID getFileID() const {
327  assert(isValid());
328  return ID;
329  }
330 
331  /// Return the presumed line number of this location.
332  ///
333  /// This can be affected by \#line etc.
334  unsigned getLine() const {
335  assert(isValid());
336  return Line;
337  }
338 
339  /// Return the presumed column number of this location.
340  ///
341  /// This cannot be affected by \#line, but is packaged here for convenience.
342  unsigned getColumn() const {
343  assert(isValid());
344  return Col;
345  }
346 
347  /// Return the presumed include location of this location.
348  ///
349  /// This can be affected by GNU linemarker directives.
351  assert(isValid());
352  return IncludeLoc;
353  }
354 };
355 
356 class FileEntry;
357 
358 /// A SourceLocation and its associated SourceManager.
359 ///
360 /// This is useful for argument passing to functions that expect both objects.
362  const SourceManager *SrcMgr = nullptr;
363 
364 public:
365  /// Creates a FullSourceLoc where isValid() returns \c false.
366  FullSourceLoc() = default;
367 
369  : SourceLocation(Loc), SrcMgr(&SM) {}
370 
371  bool hasManager() const {
372  bool hasSrcMgr = SrcMgr != nullptr;
373  assert(hasSrcMgr == isValid() && "FullSourceLoc has location but no manager");
374  return hasSrcMgr;
375  }
376 
377  /// \pre This FullSourceLoc has an associated SourceManager.
378  const SourceManager &getManager() const {
379  assert(SrcMgr && "SourceManager is NULL.");
380  return *SrcMgr;
381  }
382 
383  FileID getFileID() const;
384 
385  FullSourceLoc getExpansionLoc() const;
386  FullSourceLoc getSpellingLoc() const;
387  FullSourceLoc getFileLoc() const;
388  PresumedLoc getPresumedLoc(bool UseLineDirectives = true) const;
389  bool isMacroArgExpansion(FullSourceLoc *StartLoc = nullptr) const;
390  FullSourceLoc getImmediateMacroCallerLoc() const;
391  std::pair<FullSourceLoc, StringRef> getModuleImportLoc() const;
392  unsigned getFileOffset() const;
393 
394  unsigned getExpansionLineNumber(bool *Invalid = nullptr) const;
395  unsigned getExpansionColumnNumber(bool *Invalid = nullptr) const;
396 
397  unsigned getSpellingLineNumber(bool *Invalid = nullptr) const;
398  unsigned getSpellingColumnNumber(bool *Invalid = nullptr) const;
399 
400  const char *getCharacterData(bool *Invalid = nullptr) const;
401 
402  unsigned getLineNumber(bool *Invalid = nullptr) const;
403  unsigned getColumnNumber(bool *Invalid = nullptr) const;
404 
405  const FileEntry *getFileEntry() const;
406 
407  /// Return a StringRef to the source buffer data for the
408  /// specified FileID.
409  StringRef getBufferData(bool *Invalid = nullptr) const;
410 
411  /// Decompose the specified location into a raw FileID + Offset pair.
412  ///
413  /// The first element is the FileID, the second is the offset from the
414  /// start of the buffer of the location.
415  std::pair<FileID, unsigned> getDecomposedLoc() const;
416 
417  bool isInSystemHeader() const;
418 
419  /// Determines the order of 2 source locations in the translation unit.
420  ///
421  /// \returns true if this source location comes before 'Loc', false otherwise.
422  bool isBeforeInTranslationUnitThan(SourceLocation Loc) const;
423 
424  /// Determines the order of 2 source locations in the translation unit.
425  ///
426  /// \returns true if this source location comes before 'Loc', false otherwise.
428  assert(Loc.isValid());
429  assert(SrcMgr == Loc.SrcMgr && "Loc comes from another SourceManager!");
430  return isBeforeInTranslationUnitThan((SourceLocation)Loc);
431  }
432 
433  /// Comparison function class, useful for sorting FullSourceLocs.
435  bool operator()(const FullSourceLoc& lhs, const FullSourceLoc& rhs) const {
436  return lhs.isBeforeInTranslationUnitThan(rhs);
437  }
438  };
439 
440  /// Prints information about this FullSourceLoc to stderr.
441  ///
442  /// This is useful for debugging.
443  void dump() const;
444 
445  friend bool
446  operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
447  return LHS.getRawEncoding() == RHS.getRawEncoding() &&
448  LHS.SrcMgr == RHS.SrcMgr;
449  }
450 
451  friend bool
452  operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
453  return !(LHS == RHS);
454  }
455 };
456 
457 } // namespace clang
458 
459 namespace llvm {
460 
461  /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and
462  /// DenseSets.
463  template <>
464  struct DenseMapInfo<clang::FileID> {
466  return {};
467  }
468 
471  }
472 
473  static unsigned getHashValue(clang::FileID S) {
474  return S.getHashValue();
475  }
476 
477  static bool isEqual(clang::FileID LHS, clang::FileID RHS) {
478  return LHS == RHS;
479  }
480  };
481 
482  // Teach SmallPtrSet how to handle SourceLocation.
483  template<>
484  struct PointerLikeTypeTraits<clang::SourceLocation> {
485  enum { NumLowBitsAvailable = 0 };
486 
488  return L.getPtrEncoding();
489  }
490 
493  }
494  };
495 
496 } // namespace llvm
497 
498 #endif // LLVM_CLANG_BASIC_SOURCELOCATION_H
bool operator>=(const FileID &RHS) const
bool operator==(const SourceLocation &LHS, const SourceLocation &RHS)
SourceLocation getLocWithOffset(int Offset) const
Return a source location with the specified offset from this SourceLocation.
unsigned getRawEncoding() const
When a SourceLocation itself cannot be used, this returns an (opaque) 32-bit integer encoding for it...
friend bool operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS)
bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS)
void setBegin(SourceLocation b)
bool operator<(const SourceLocation &LHS, const SourceLocation &RHS)
Specialize PointerLikeTypeTraits to allow LazyGenerationalUpdatePtr to be placed into a PointerUnion...
Definition: Dominators.h:30
FileID getFileID() const
bool operator>(const SourceLocation &LHS, const SourceLocation &RHS)
static CharSourceRange getTokenRange(SourceRange R)
bool operator>(const FileID &RHS) const
StringRef P
static FileID getSentinel()
bool fullyContains(const SourceRange &other) const
void setBegin(SourceLocation b)
void print(llvm::raw_ostream &OS, const Pointer &P, ASTContext &Ctx, QualType Ty)
Definition: InterpFrame.cpp:62
SourceLocation getBegin() const
static SourceLocation getFromRawEncoding(unsigned Encoding)
Turn a raw encoding of a SourceLocation object into a real SourceLocation.
unsigned getHashValue() const
bool isInvalid() const
friend bool operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS)
static void dump(llvm::raw_ostream &OS, StringRef FunctionName, ArrayRef< CounterExpression > Expressions, ArrayRef< CounterMappingRegion > Regions)
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
SourceRange(SourceLocation loc)
static CharSourceRange getCharRange(SourceLocation B, SourceLocation E)
void setTokenRange(bool TR)
static void * getAsVoidPointer(clang::SourceLocation L)
static unsigned getHashValue(clang::FileID S)
bool operator==(const FileID &RHS) const
StringRef Filename
Definition: Format.cpp:1825
bool isValid() const
unsigned Offset
Definition: Format.cpp:1827
bool isValid() const
bool hasManager() const
SourceLocation End
Represents a character-granular source range.
bool isInvalid() const
Return true if this object is invalid or uninitialized.
const AnnotatedLine * Line
bool operator<(const FileID &RHS) const
unsigned getLine() const
Return the presumed line number of this location.
#define V(N, I)
Definition: ASTContext.h:2941
__UINTPTR_TYPE__ uintptr_t
An unsigned integer type with the property that any valid pointer to void can be converted to this ty...
Definition: opencl-c-base.h:62
bool operator!=(const SourceRange &X) const
const SourceManager & getManager() const
void setEnd(SourceLocation e)
SourceRange(SourceLocation begin, SourceLocation end)
bool isInvalid() const
Represents an unpacked "presumed" location which can be presented to the user.
SourceLocation getEnd() const
bool operator<=(const FileID &RHS) const
bool operator==(const SourceRange &X) const
const SourceManager & SM
Definition: Format.cpp:1685
static CharSourceRange getCharRange(SourceRange R)
const char * getFilename() const
Return the presumed filename of this location.
unsigned getColumn() const
Return the presumed column number of this location.
bool isBeforeInTranslationUnitThan(SourceLocation Loc) const
Determines the order of 2 source locations in the translation unit.
Encodes a location in the source.
bool isBeforeInTranslationUnitThan(FullSourceLoc Loc) const
Determines the order of 2 source locations in the translation unit.
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:78
static bool isEqual(clang::FileID LHS, clang::FileID RHS)
static CharSourceRange getTokenRange(SourceLocation B, SourceLocation E)
PresumedLoc(const char *FN, FileID FID, unsigned Ln, unsigned Co, SourceLocation IL)
bool operator!=(const FileID &RHS) const
bool isTokenRange() const
Return true if the end of this range specifies the start of the last token.
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
SourceRange getAsRange() const
Dataflow Directional Tag Classes.
static bool isPairOfFileLocations(SourceLocation Start, SourceLocation End)
bool isValid() const
Return true if this is a valid SourceLocation object.
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:340
static clang::FileID getEmptyKey()
bool isMacroID() const
FullSourceLoc(SourceLocation Loc, const SourceManager &SM)
bool operator()(const FullSourceLoc &lhs, const FullSourceLoc &rhs) const
Comparison function class, useful for sorting FullSourceLocs.
SourceLocation getEnd() const
CharSourceRange(SourceRange R, bool ITR)
bool operator>=(const SourceLocation &LHS, const SourceLocation &RHS)
X
Add a minimal nested name specifier fixit hint to allow lookup of a tag name from an outer enclosing ...
Definition: SemaDecl.cpp:14781
void setEnd(SourceLocation e)
bool isValid() const
static clang::FileID getTombstoneKey()
Writes an AST file containing the contents of a translation unit.
Definition: ASTWriter.h:96
A SourceLocation and its associated SourceManager.
static clang::SourceLocation getFromVoidPointer(void *P)
bool operator<=(const SourceLocation &LHS, const SourceLocation &RHS)
A trivial tuple used to represent a source range.
static SourceLocation getFromPtrEncoding(const void *Encoding)
Turn a pointer encoding of a SourceLocation object back into a real SourceLocation.
SourceLocation getIncludeLoc() const
Return the presumed include location of this location.
SourceLocation getBegin() const
This class handles loading and caching of source files into memory.
void * getPtrEncoding() const
When a SourceLocation itself cannot be used, this returns an (opaque) pointer encoding for it...