blob: 2368b389810ca1bd0290751392cf8a763f292a62 [file] [log] [blame]
Douglas Gregor065f8d12010-03-18 17:52:52 +00001//===--- PreprocessingRecord.cpp - Record of Preprocessing ------*- 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 implements the PreprocessingRecord class, which maintains a record
11// of what occurred during preprocessing, and its helpers.
12//
13//===----------------------------------------------------------------------===//
14#include "clang/Lex/PreprocessingRecord.h"
15#include "clang/Lex/MacroInfo.h"
16#include "clang/Lex/Token.h"
Douglas Gregor796d76a2010-10-20 22:00:55 +000017#include "llvm/Support/ErrorHandling.h"
Ted Kremenekf1c38812011-07-27 18:41:20 +000018#include "llvm/Support/Capacity.h"
Douglas Gregor065f8d12010-03-18 17:52:52 +000019
20using namespace clang;
21
Douglas Gregoraae92242010-03-19 21:51:54 +000022ExternalPreprocessingRecordSource::~ExternalPreprocessingRecordSource() { }
23
Douglas Gregorf09b6c92010-11-01 15:03:47 +000024
25InclusionDirective::InclusionDirective(PreprocessingRecord &PPRec,
26 InclusionKind Kind,
Chris Lattner0e62c1c2011-07-23 10:55:15 +000027 StringRef FileName,
Douglas Gregorf09b6c92010-11-01 15:03:47 +000028 bool InQuotes, const FileEntry *File,
29 SourceRange Range)
30 : PreprocessingDirective(InclusionDirectiveKind, Range),
31 InQuotes(InQuotes), Kind(Kind), File(File)
32{
33 char *Memory
34 = (char*)PPRec.Allocate(FileName.size() + 1, llvm::alignOf<char>());
35 memcpy(Memory, FileName.data(), FileName.size());
36 Memory[FileName.size()] = 0;
Chris Lattner0e62c1c2011-07-23 10:55:15 +000037 this->FileName = StringRef(Memory, FileName.size());
Douglas Gregorf09b6c92010-11-01 15:03:47 +000038}
39
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +000040PreprocessingRecord::PreprocessingRecord(SourceManager &SM,
41 bool IncludeNestedMacroExpansions)
42 : SourceMgr(SM), IncludeNestedMacroExpansions(IncludeNestedMacroExpansions),
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +000043 ExternalSource(0)
Douglas Gregoraae92242010-03-19 21:51:54 +000044{
45}
46
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +000047/// \brief Returns a pair of [Begin, End) iterators of preprocessed entities
48/// that source range \arg R encompasses.
49std::pair<PreprocessingRecord::iterator, PreprocessingRecord::iterator>
50PreprocessingRecord::getPreprocessedEntitiesInRange(SourceRange Range) {
51 if (Range.isInvalid())
52 return std::make_pair(iterator(this, 0), iterator(this, 0));
53 assert(!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(),Range.getBegin()));
54
55 std::pair<unsigned, unsigned>
56 Local = findLocalPreprocessedEntitiesInRange(Range);
57
58 // Check if range spans local entities.
59 if (!ExternalSource || SourceMgr.isLocalSourceLocation(Range.getBegin()))
60 return std::make_pair(iterator(this, Local.first),
61 iterator(this, Local.second));
62
63 std::pair<unsigned, unsigned>
64 Loaded = ExternalSource->findPreprocessedEntitiesInRange(Range);
65
66 // Check if range spans local entities.
67 if (Loaded.first == Loaded.second)
68 return std::make_pair(iterator(this, Local.first),
69 iterator(this, Local.second));
70
71 unsigned TotalLoaded = LoadedPreprocessedEntities.size();
72
73 // Check if range spans loaded entities.
74 if (Local.first == Local.second)
75 return std::make_pair(iterator(this, int(Loaded.first)-TotalLoaded),
76 iterator(this, int(Loaded.second)-TotalLoaded));
77
78 // Range spands loaded and local entities.
79 return std::make_pair(iterator(this, int(Loaded.first)-TotalLoaded),
80 iterator(this, Local.second));
81}
82
83std::pair<unsigned, unsigned>
84PreprocessingRecord::findLocalPreprocessedEntitiesInRange(
85 SourceRange Range) const {
86 if (Range.isInvalid())
87 return std::make_pair(0,0);
88 assert(!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(),Range.getBegin()));
89
90 unsigned Begin = findBeginLocalPreprocessedEntity(Range.getBegin());
91 unsigned End = findEndLocalPreprocessedEntity(Range.getEnd());
92 return std::make_pair(Begin, End);
93}
94
95namespace {
96
97template <SourceLocation (SourceRange::*getRangeLoc)() const>
98struct PPEntityComp {
99 const SourceManager &SM;
100
101 explicit PPEntityComp(const SourceManager &SM) : SM(SM) { }
102
103 bool operator()(PreprocessedEntity *L, SourceLocation RHS) {
104 SourceLocation LHS = getLoc(L);
105 return SM.isBeforeInTranslationUnit(LHS, RHS);
106 }
107
108 bool operator()(SourceLocation LHS, PreprocessedEntity *R) {
109 SourceLocation RHS = getLoc(R);
110 return SM.isBeforeInTranslationUnit(LHS, RHS);
111 }
112
113 SourceLocation getLoc(PreprocessedEntity *PPE) const {
Argyrios Kyrtzidisa35c4442011-09-19 22:02:08 +0000114 SourceRange Range = PPE->getSourceRange();
115 return (Range.*getRangeLoc)();
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +0000116 }
117};
118
119}
120
121unsigned PreprocessingRecord::findBeginLocalPreprocessedEntity(
122 SourceLocation Loc) const {
123 if (SourceMgr.isLoadedSourceLocation(Loc))
124 return 0;
125
126 std::vector<PreprocessedEntity *>::const_iterator
127 I = std::lower_bound(PreprocessedEntities.begin(),
128 PreprocessedEntities.end(),
129 Loc,
130 PPEntityComp<&SourceRange::getEnd>(SourceMgr));
131 return I - PreprocessedEntities.begin();
132}
133
134unsigned PreprocessingRecord::findEndLocalPreprocessedEntity(
135 SourceLocation Loc) const {
136 if (SourceMgr.isLoadedSourceLocation(Loc))
137 return 0;
138
139 std::vector<PreprocessedEntity *>::const_iterator
140 I = std::upper_bound(PreprocessedEntities.begin(),
141 PreprocessedEntities.end(),
142 Loc,
143 PPEntityComp<&SourceRange::getBegin>(SourceMgr));
144 return I - PreprocessedEntities.begin();
145}
146
Douglas Gregor065f8d12010-03-18 17:52:52 +0000147void PreprocessingRecord::addPreprocessedEntity(PreprocessedEntity *Entity) {
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +0000148 SourceLocation Loc = Entity->getSourceRange().getBegin();
149 assert((PreprocessedEntities.empty() ||
150 !SourceMgr.isBeforeInTranslationUnit(Loc,
151 PreprocessedEntities.back()->getSourceRange().getEnd())) &&
152 "Adding a preprocessed entity that is before the previous one in TU");
Douglas Gregor065f8d12010-03-18 17:52:52 +0000153 PreprocessedEntities.push_back(Entity);
154}
155
Douglas Gregoraae92242010-03-19 21:51:54 +0000156void PreprocessingRecord::SetExternalSource(
Douglas Gregor4a9c39a2011-07-21 00:47:40 +0000157 ExternalPreprocessingRecordSource &Source) {
Douglas Gregoraae92242010-03-19 21:51:54 +0000158 assert(!ExternalSource &&
159 "Preprocessing record already has an external source");
160 ExternalSource = &Source;
Douglas Gregoraae92242010-03-19 21:51:54 +0000161}
162
Douglas Gregor4a9c39a2011-07-21 00:47:40 +0000163unsigned PreprocessingRecord::allocateLoadedEntities(unsigned NumEntities) {
164 unsigned Result = LoadedPreprocessedEntities.size();
165 LoadedPreprocessedEntities.resize(LoadedPreprocessedEntities.size()
166 + NumEntities);
167 return Result;
168}
169
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000170void PreprocessingRecord::RegisterMacroDefinition(MacroInfo *Macro,
171 PPEntityID PPID) {
172 MacroDefinitions[Macro] = PPID;
Douglas Gregoraae92242010-03-19 21:51:54 +0000173}
174
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000175/// \brief Retrieve the preprocessed entity at the given ID.
176PreprocessedEntity *PreprocessingRecord::getPreprocessedEntity(PPEntityID PPID){
177 if (PPID < 0) {
178 assert(unsigned(-PPID-1) < LoadedPreprocessedEntities.size() &&
179 "Out-of bounds loaded preprocessed entity");
180 return getLoadedPreprocessedEntity(LoadedPreprocessedEntities.size()+PPID);
181 }
182 assert(unsigned(PPID) < PreprocessedEntities.size() &&
183 "Out-of bounds local preprocessed entity");
184 return PreprocessedEntities[PPID];
185}
186
187/// \brief Retrieve the loaded preprocessed entity at the given index.
188PreprocessedEntity *
189PreprocessingRecord::getLoadedPreprocessedEntity(unsigned Index) {
190 assert(Index < LoadedPreprocessedEntities.size() &&
191 "Out-of bounds loaded preprocessed entity");
192 assert(ExternalSource && "No external source to load from");
193 PreprocessedEntity *&Entity = LoadedPreprocessedEntities[Index];
194 if (!Entity) {
195 Entity = ExternalSource->ReadPreprocessedEntity(Index);
196 if (!Entity) // Failed to load.
197 Entity = new (*this)
198 PreprocessedEntity(PreprocessedEntity::InvalidKind, SourceRange());
199 }
200 return Entity;
Douglas Gregoraae92242010-03-19 21:51:54 +0000201}
202
Douglas Gregor8aaca672010-03-19 21:58:23 +0000203MacroDefinition *PreprocessingRecord::findMacroDefinition(const MacroInfo *MI) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000204 llvm::DenseMap<const MacroInfo *, PPEntityID>::iterator Pos
Douglas Gregor7dc87222010-03-19 17:12:43 +0000205 = MacroDefinitions.find(MI);
206 if (Pos == MacroDefinitions.end())
207 return 0;
208
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000209 PreprocessedEntity *Entity = getPreprocessedEntity(Pos->second);
210 if (Entity->isInvalid())
211 return 0;
212 return cast<MacroDefinition>(Entity);
Douglas Gregor7dc87222010-03-19 17:12:43 +0000213}
214
Argyrios Kyrtzidis85a14bb2011-08-18 01:05:45 +0000215void PreprocessingRecord::MacroExpands(const Token &Id, const MacroInfo* MI,
216 SourceRange Range) {
Chandler Carrutha88a22182011-07-14 08:20:46 +0000217 if (!IncludeNestedMacroExpansions && Id.getLocation().isMacroID())
Douglas Gregor998caea2011-05-06 16:33:08 +0000218 return;
219
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +0000220 if (MI->isBuiltinMacro())
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +0000221 addPreprocessedEntity(
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +0000222 new (*this) MacroExpansion(Id.getIdentifierInfo(),Range));
223 else if (MacroDefinition *Def = findMacroDefinition(MI))
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +0000224 addPreprocessedEntity(
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +0000225 new (*this) MacroExpansion(Def, Range));
Douglas Gregor7dc87222010-03-19 17:12:43 +0000226}
227
Craig Silverstein1a9ca212010-11-19 21:33:15 +0000228void PreprocessingRecord::MacroDefined(const Token &Id,
Douglas Gregor7dc87222010-03-19 17:12:43 +0000229 const MacroInfo *MI) {
230 SourceRange R(MI->getDefinitionLoc(), MI->getDefinitionEndLoc());
231 MacroDefinition *Def
Argyrios Kyrtzidis0d48fb82011-09-20 22:14:48 +0000232 = new (*this) MacroDefinition(Id.getIdentifierInfo(), R);
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +0000233 addPreprocessedEntity(Def);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000234 MacroDefinitions[MI] = getPPEntityID(PreprocessedEntities.size()-1,
235 /*isLoaded=*/false);
Douglas Gregor7dc87222010-03-19 17:12:43 +0000236}
Douglas Gregoraae92242010-03-19 21:51:54 +0000237
Craig Silverstein1a9ca212010-11-19 21:33:15 +0000238void PreprocessingRecord::MacroUndefined(const Token &Id,
Douglas Gregor8aaca672010-03-19 21:58:23 +0000239 const MacroInfo *MI) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000240 llvm::DenseMap<const MacroInfo *, PPEntityID>::iterator Pos
Douglas Gregor8aaca672010-03-19 21:58:23 +0000241 = MacroDefinitions.find(MI);
242 if (Pos != MacroDefinitions.end())
243 MacroDefinitions.erase(Pos);
244}
245
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000246void PreprocessingRecord::InclusionDirective(
247 SourceLocation HashLoc,
248 const clang::Token &IncludeTok,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000249 StringRef FileName,
Chandler Carruth3cc331a2011-03-16 18:34:36 +0000250 bool IsAngled,
251 const FileEntry *File,
252 clang::SourceLocation EndLoc,
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000253 StringRef SearchPath,
254 StringRef RelativePath) {
Douglas Gregor796d76a2010-10-20 22:00:55 +0000255 InclusionDirective::InclusionKind Kind = InclusionDirective::Include;
256
257 switch (IncludeTok.getIdentifierInfo()->getPPKeywordID()) {
258 case tok::pp_include:
259 Kind = InclusionDirective::Include;
260 break;
261
262 case tok::pp_import:
263 Kind = InclusionDirective::Import;
264 break;
265
266 case tok::pp_include_next:
267 Kind = InclusionDirective::IncludeNext;
268 break;
269
270 case tok::pp___include_macros:
271 Kind = InclusionDirective::IncludeMacros;
272 break;
273
274 default:
275 llvm_unreachable("Unknown include directive kind");
276 return;
277 }
278
279 clang::InclusionDirective *ID
Douglas Gregorf09b6c92010-11-01 15:03:47 +0000280 = new (*this) clang::InclusionDirective(*this, Kind, FileName, !IsAngled,
281 File, SourceRange(HashLoc, EndLoc));
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +0000282 addPreprocessedEntity(ID);
Douglas Gregor796d76a2010-10-20 22:00:55 +0000283}
Ted Kremenek182543a2011-07-26 21:17:24 +0000284
285size_t PreprocessingRecord::getTotalMemory() const {
286 return BumpAlloc.getTotalMemory()
Ted Kremenekf1c38812011-07-27 18:41:20 +0000287 + llvm::capacity_in_bytes(MacroDefinitions)
288 + llvm::capacity_in_bytes(PreprocessedEntities)
289 + llvm::capacity_in_bytes(LoadedPreprocessedEntities);
Ted Kremenek182543a2011-07-26 21:17:24 +0000290}