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