1 //===- SourceLocation.cpp - Compact identifier for Source Files -----------===//
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 accessor methods for the FullSourceLoc class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Basic/SourceLocation.h"
15 #include "clang/Basic/LLVM.h"
16 #include "clang/Basic/PrettyStackTrace.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/Compiler.h"
20 #include "llvm/Support/MemoryBuffer.h"
21 #include "llvm/Support/raw_ostream.h"
22 #include <cassert>
23 #include <string>
24 #include <utility>
25 
26 using namespace clang;
27 
28 //===----------------------------------------------------------------------===//
29 // PrettyStackTraceLoc
30 //===----------------------------------------------------------------------===//
31 
32 void PrettyStackTraceLoc::print(raw_ostream &OS) const {
33   if (Loc.isValid()) {
34     Loc.print(OS, SM);
35     OS << ": ";
36   }
37   OS << Message << '\n';
38 }
39 
40 //===----------------------------------------------------------------------===//
41 // SourceLocation
42 //===----------------------------------------------------------------------===//
43 
44 void SourceLocation::print(raw_ostream &OS, const SourceManager &SM)const{
45   if (!isValid()) {
46     OS << "<invalid loc>";
47     return;
48   }
49 
50   if (isFileID()) {
51     PresumedLoc PLoc = SM.getPresumedLoc(*this);
52 
53     if (PLoc.isInvalid()) {
54       OS << "<invalid>";
55       return;
56     }
57     // The macro expansion and spelling pos is identical for file locs.
58     OS << PLoc.getFilename() << ':' << PLoc.getLine()
59        << ':' << PLoc.getColumn();
60     return;
61   }
62 
63   SM.getExpansionLoc(*this).print(OS, SM);
64 
65   OS << " <Spelling=";
66   SM.getSpellingLoc(*this).print(OS, SM);
67   OS << '>';
68 }
69 
70 LLVM_DUMP_METHOD std::string
71 SourceLocation::printToString(const SourceManager &SM) const {
72   std::string S;
73   llvm::raw_string_ostream OS(S);
74   print(OS, SM);
75   return OS.str();
76 }
77 
78 LLVM_DUMP_METHOD void SourceLocation::dump(const SourceManager &SM) const {
79   print(llvm::errs(), SM);
80   llvm::errs() << '\n';
81 }
82 
83 //===----------------------------------------------------------------------===//
84 // FullSourceLoc
85 //===----------------------------------------------------------------------===//
86 
87 FileID FullSourceLoc::getFileID() const {
88   assert(isValid());
89   return SrcMgr->getFileID(*this);
90 }
91 
92 FullSourceLoc FullSourceLoc::getExpansionLoc() const {
93   assert(isValid());
94   return FullSourceLoc(SrcMgr->getExpansionLoc(*this), *SrcMgr);
95 }
96 
97 FullSourceLoc FullSourceLoc::getSpellingLoc() const {
98   assert(isValid());
99   return FullSourceLoc(SrcMgr->getSpellingLoc(*this), *SrcMgr);
100 }
101 
102 FullSourceLoc FullSourceLoc::getFileLoc() const {
103   assert(isValid());
104   return FullSourceLoc(SrcMgr->getFileLoc(*this), *SrcMgr);
105 }
106 
107 PresumedLoc FullSourceLoc::getPresumedLoc(bool UseLineDirectives) const {
108   if (!isValid())
109     return PresumedLoc();
110 
111   return SrcMgr->getPresumedLoc(*this, UseLineDirectives);
112 }
113 
114 bool FullSourceLoc::isMacroArgExpansion(FullSourceLoc *StartLoc) const {
115   assert(isValid());
116   return SrcMgr->isMacroArgExpansion(*this, StartLoc);
117 }
118 
119 FullSourceLoc FullSourceLoc::getImmediateMacroCallerLoc() const {
120   assert(isValid());
121   return FullSourceLoc(SrcMgr->getImmediateMacroCallerLoc(*this), *SrcMgr);
122 }
123 
124 std::pair<FullSourceLoc, StringRef> FullSourceLoc::getModuleImportLoc() const {
125   if (!isValid())
126     return std::make_pair(FullSourceLoc(), StringRef());
127 
128   std::pair<SourceLocation, StringRef> ImportLoc =
129       SrcMgr->getModuleImportLoc(*this);
130   return std::make_pair(FullSourceLoc(ImportLoc.first, *SrcMgr),
131                         ImportLoc.second);
132 }
133 
134 unsigned FullSourceLoc::getFileOffset() const {
135   assert(isValid());
136   return SrcMgr->getFileOffset(*this);
137 }
138 
139 unsigned FullSourceLoc::getLineNumber(bool *Invalid) const {
140   assert(isValid());
141   return SrcMgr->getLineNumber(getFileID(), getFileOffset(), Invalid);
142 }
143 
144 unsigned FullSourceLoc::getColumnNumber(bool *Invalid) const {
145   assert(isValid());
146   return SrcMgr->getColumnNumber(getFileID(), getFileOffset(), Invalid);
147 }
148 
149 const FileEntry *FullSourceLoc::getFileEntry() const {
150   assert(isValid());
151   return SrcMgr->getFileEntryForID(getFileID());
152 }
153 
154 unsigned FullSourceLoc::getExpansionLineNumber(bool *Invalid) const {
155   assert(isValid());
156   return SrcMgr->getExpansionLineNumber(*this, Invalid);
157 }
158 
159 unsigned FullSourceLoc::getExpansionColumnNumber(bool *Invalid) const {
160   assert(isValid());
161   return SrcMgr->getExpansionColumnNumber(*this, Invalid);
162 }
163 
164 unsigned FullSourceLoc::getSpellingLineNumber(bool *Invalid) const {
165   assert(isValid());
166   return SrcMgr->getSpellingLineNumber(*this, Invalid);
167 }
168 
169 unsigned FullSourceLoc::getSpellingColumnNumber(bool *Invalid) const {
170   assert(isValid());
171   return SrcMgr->getSpellingColumnNumber(*this, Invalid);
172 }
173 
174 bool FullSourceLoc::isInSystemHeader() const {
175   assert(isValid());
176   return SrcMgr->isInSystemHeader(*this);
177 }
178 
179 bool FullSourceLoc::isBeforeInTranslationUnitThan(SourceLocation Loc) const {
180   assert(isValid());
181   return SrcMgr->isBeforeInTranslationUnit(*this, Loc);
182 }
183 
184 LLVM_DUMP_METHOD void FullSourceLoc::dump() const {
185   SourceLocation::dump(*SrcMgr);
186 }
187 
188 const char *FullSourceLoc::getCharacterData(bool *Invalid) const {
189   assert(isValid());
190   return SrcMgr->getCharacterData(*this, Invalid);
191 }
192 
193 StringRef FullSourceLoc::getBufferData(bool *Invalid) const {
194   assert(isValid());
195   return SrcMgr->getBuffer(SrcMgr->getFileID(*this), Invalid)->getBuffer();
196 }
197 
198 std::pair<FileID, unsigned> FullSourceLoc::getDecomposedLoc() const {
199   return SrcMgr->getDecomposedLoc(*this);
200 }
201