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
23 template <typename T> struct DenseMapInfo;
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.
35 /// ID - Opaque identifier, 0 is "invalid".
40 bool isInvalid() const { return ID == 0; }
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; }
49 static FileID getSentinel() { return get(~0U); }
50 unsigned getHashValue() const { return ID; }
53 friend class SourceManager;
54 static FileID get(unsigned V) {
59 unsigned getOpaqueValue() const { return ID; }
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.
66 class SourceLocation {
68 friend class SourceManager;
74 SourceLocation() : ID(0) {} // 0 is an invalid FileID.
76 bool isFileID() const { return (ID & MacroIDBit) == 0; }
77 bool isMacroID() const { return (ID & MacroIDBit) != 0; }
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).
83 bool isValid() const { return ID != 0; }
84 bool isInvalid() const { return ID == 0; }
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;
93 static SourceLocation getFileLoc(unsigned ID) {
94 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
100 static SourceLocation getMacroLoc(unsigned ID) {
101 assert((ID & MacroIDBit) == 0 && "Ran out of source locations!");
103 L.ID = MacroIDBit | ID;
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");
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
121 unsigned getRawEncoding() const { return ID; }
124 /// getFromRawEncoding - Turn a raw encoding of a SourceLocation object into
125 /// a real SourceLocation.
126 static SourceLocation getFromRawEncoding(unsigned Encoding) {
132 void print(llvm::raw_ostream &OS, const SourceManager &SM) const;
133 void dump(const SourceManager &SM) const;
136 inline bool operator==(const SourceLocation &LHS, const SourceLocation &RHS) {
137 return LHS.getRawEncoding() == RHS.getRawEncoding();
140 inline bool operator!=(const SourceLocation &LHS, const SourceLocation &RHS) {
141 return !(LHS == RHS);
144 inline bool operator<(const SourceLocation &LHS, const SourceLocation &RHS) {
145 return LHS.getRawEncoding() < RHS.getRawEncoding();
148 /// SourceRange - a trival tuple used to represent a source range.
153 SourceRange(): B(SourceLocation()), E(SourceLocation()) {}
154 SourceRange(SourceLocation loc) : B(loc), E(loc) {}
155 SourceRange(SourceLocation begin, SourceLocation end) : B(begin), E(end) {}
157 SourceLocation getBegin() const { return B; }
158 SourceLocation getEnd() const { return E; }
160 void setBegin(SourceLocation b) { B = b; }
161 void setEnd(SourceLocation e) { E = e; }
163 bool isValid() const { return B.isValid() && E.isValid(); }
165 bool operator==(const SourceRange &X) const {
166 return B == X.B && E == X.E;
169 bool operator!=(const SourceRange &X) const {
170 return B != X.B || E != X.E;
174 /// FullSourceLoc - A SourceLocation and its associated SourceManager. Useful
175 /// for argument passing to functions that expect both objects.
176 class FullSourceLoc : public SourceLocation {
177 SourceManager* SrcMgr;
179 /// Creates a FullSourceLoc where isValid() returns false.
180 explicit FullSourceLoc() : SrcMgr((SourceManager*) 0) {}
182 explicit FullSourceLoc(SourceLocation Loc, SourceManager &SM)
183 : SourceLocation(Loc), SrcMgr(&SM) {}
185 SourceManager &getManager() {
186 assert(SrcMgr && "SourceManager is NULL.");
190 const SourceManager &getManager() const {
191 assert(SrcMgr && "SourceManager is NULL.");
195 FileID getFileID() const;
197 FullSourceLoc getInstantiationLoc() const;
198 FullSourceLoc getSpellingLoc() const;
200 unsigned getInstantiationLineNumber() const;
201 unsigned getInstantiationColumnNumber() const;
203 unsigned getSpellingLineNumber() const;
204 unsigned getSpellingColumnNumber() const;
206 const char *getCharacterData() const;
208 const llvm::MemoryBuffer* getBuffer() const;
210 /// getBufferData - Return a pointer to the start and end of the source buffer
211 /// data for the specified FileID.
212 std::pair<const char*, const char*> getBufferData() const;
214 /// getDecomposedLoc - Decompose the specified location into a raw FileID +
215 /// Offset pair. The first element is the FileID, the second is the
216 /// offset from the start of the buffer of the location.
217 std::pair<FileID, unsigned> getDecomposedLoc() const;
219 bool isInSystemHeader() const;
221 /// Prints information about this FullSourceLoc to stderr. Useful for
223 void dump() const { SourceLocation::dump(*SrcMgr); }
226 operator==(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
227 return LHS.getRawEncoding() == RHS.getRawEncoding() &&
228 LHS.SrcMgr == RHS.SrcMgr;
232 operator!=(const FullSourceLoc &LHS, const FullSourceLoc &RHS) {
233 return !(LHS == RHS);
238 /// PresumedLoc - This class represents an unpacked "presumed" location which
239 /// can be presented to the user. A 'presumed' location can be modified by
240 /// #line and GNU line marker directives and is always the instantiation point
241 /// of a normal location.
243 /// You can get a PresumedLoc from a SourceLocation with SourceManager.
245 const char *Filename;
247 SourceLocation IncludeLoc;
249 PresumedLoc() : Filename(0) {}
250 PresumedLoc(const char *FN, unsigned Ln, unsigned Co, SourceLocation IL)
251 : Filename(FN), Line(Ln), Col(Co), IncludeLoc(IL) {
254 /// isInvalid - Return true if this object is invalid or uninitialized. This
255 /// occurs when created with invalid source locations or when walking off
256 /// the top of a #include stack.
257 bool isInvalid() const { return Filename == 0; }
258 bool isValid() const { return Filename != 0; }
260 /// getFilename - Return the presumed filename of this location. This can be
261 /// affected by #line etc.
262 const char *getFilename() const { return Filename; }
264 /// getLine - Return the presumed line number of this location. This can be
265 /// affected by #line etc.
266 unsigned getLine() const { return Line; }
268 /// getColumn - Return the presumed column number of this location. This can
269 /// not be affected by #line, but is packaged here for convenience.
270 unsigned getColumn() const { return Col; }
272 /// getIncludeLoc - Return the presumed include location of this location.
273 /// This can be affected by GNU linemarker directives.
274 SourceLocation getIncludeLoc() const { return IncludeLoc; }
278 } // end namespace clang
281 /// Define DenseMapInfo so that FileID's can be used as keys in DenseMap and
284 struct DenseMapInfo<clang::FileID> {
285 static inline clang::FileID getEmptyKey() {
286 return clang::FileID();
288 static inline clang::FileID getTombstoneKey() {
289 return clang::FileID::getSentinel();
292 static unsigned getHashValue(clang::FileID S) {
293 return S.getHashValue();
296 static bool isEqual(clang::FileID LHS, clang::FileID RHS) {
300 static bool isPod() { return true; }
303 } // end namespace llvm