1 //===- MultiplexConsumer.cpp - AST Consumer for PCH Generation --*- 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 MultiplexConsumer class. It also declares and defines
11 //  MultiplexASTDeserializationListener and  MultiplexASTMutationListener, which
12 //  are implementation details of MultiplexConsumer.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #include "clang/Frontend/MultiplexConsumer.h"
17 #include "clang/AST/ASTMutationListener.h"
18 #include "clang/AST/DeclGroup.h"
19 #include "clang/Serialization/ASTDeserializationListener.h"
20 
21 using namespace clang;
22 
23 namespace clang {
24 
25 // This ASTDeserializationListener forwards its notifications to a set of
26 // child listeners.
27 class MultiplexASTDeserializationListener
28     : public ASTDeserializationListener {
29 public:
30   // Does NOT take ownership of the elements in L.
31   MultiplexASTDeserializationListener(
32       const std::vector<ASTDeserializationListener*>& L);
33   void ReaderInitialized(ASTReader *Reader) override;
34   void IdentifierRead(serialization::IdentID ID,
35                       IdentifierInfo *II) override;
36   void MacroRead(serialization::MacroID ID, MacroInfo *MI) override;
37   void TypeRead(serialization::TypeIdx Idx, QualType T) override;
38   void DeclRead(serialization::DeclID ID, const Decl *D) override;
39   void SelectorRead(serialization::SelectorID iD, Selector Sel) override;
40   void MacroDefinitionRead(serialization::PreprocessedEntityID,
41                            MacroDefinitionRecord *MD) override;
42   void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override;
43 
44 private:
45   std::vector<ASTDeserializationListener *> Listeners;
46 };
47 
48 MultiplexASTDeserializationListener::MultiplexASTDeserializationListener(
49       const std::vector<ASTDeserializationListener*>& L)
50     : Listeners(L) {
51 }
52 
53 void MultiplexASTDeserializationListener::ReaderInitialized(
54     ASTReader *Reader) {
55   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
56     Listeners[i]->ReaderInitialized(Reader);
57 }
58 
59 void MultiplexASTDeserializationListener::IdentifierRead(
60     serialization::IdentID ID, IdentifierInfo *II) {
61   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
62     Listeners[i]->IdentifierRead(ID, II);
63 }
64 
65 void MultiplexASTDeserializationListener::MacroRead(
66     serialization::MacroID ID, MacroInfo *MI) {
67   for (auto &Listener : Listeners)
68     Listener->MacroRead(ID, MI);
69 }
70 
71 void MultiplexASTDeserializationListener::TypeRead(
72     serialization::TypeIdx Idx, QualType T) {
73   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
74     Listeners[i]->TypeRead(Idx, T);
75 }
76 
77 void MultiplexASTDeserializationListener::DeclRead(
78     serialization::DeclID ID, const Decl *D) {
79   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
80     Listeners[i]->DeclRead(ID, D);
81 }
82 
83 void MultiplexASTDeserializationListener::SelectorRead(
84     serialization::SelectorID ID, Selector Sel) {
85   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
86     Listeners[i]->SelectorRead(ID, Sel);
87 }
88 
89 void MultiplexASTDeserializationListener::MacroDefinitionRead(
90     serialization::PreprocessedEntityID ID, MacroDefinitionRecord *MD) {
91   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
92     Listeners[i]->MacroDefinitionRead(ID, MD);
93 }
94 
95 void MultiplexASTDeserializationListener::ModuleRead(
96     serialization::SubmoduleID ID, Module *Mod) {
97   for (auto &Listener : Listeners)
98     Listener->ModuleRead(ID, Mod);
99 }
100 
101 // This ASTMutationListener forwards its notifications to a set of
102 // child listeners.
103 class MultiplexASTMutationListener : public ASTMutationListener {
104 public:
105   // Does NOT take ownership of the elements in L.
106   MultiplexASTMutationListener(ArrayRef<ASTMutationListener*> L);
107   void CompletedTagDefinition(const TagDecl *D) override;
108   void AddedVisibleDecl(const DeclContext *DC, const Decl *D) override;
109   void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) override;
110   void AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
111                             const ClassTemplateSpecializationDecl *D) override;
112   void AddedCXXTemplateSpecialization(const VarTemplateDecl *TD,
113                                const VarTemplateSpecializationDecl *D) override;
114   void AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
115                                       const FunctionDecl *D) override;
116   void ResolvedExceptionSpec(const FunctionDecl *FD) override;
117   void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override;
118   void ResolvedOperatorDelete(const CXXDestructorDecl *DD,
119                               const FunctionDecl *Delete) override;
120   void CompletedImplicitDefinition(const FunctionDecl *D) override;
121   void StaticDataMemberInstantiated(const VarDecl *D) override;
122   void DefaultArgumentInstantiated(const ParmVarDecl *D) override;
123   void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
124                                     const ObjCInterfaceDecl *IFD) override;
125   void FunctionDefinitionInstantiated(const FunctionDecl *D) override;
126   void DeclarationMarkedUsed(const Decl *D) override;
127   void DeclarationMarkedOpenMPThreadPrivate(const Decl *D) override;
128   void DeclarationMarkedOpenMPDeclareTarget(const Decl *D) override;
129   void RedefinedHiddenDefinition(const NamedDecl *D, Module *M) override;
130   void AddedAttributeToRecord(const Attr *Attr,
131                               const RecordDecl *Record) override;
132 
133 private:
134   std::vector<ASTMutationListener*> Listeners;
135 };
136 
137 MultiplexASTMutationListener::MultiplexASTMutationListener(
138     ArrayRef<ASTMutationListener*> L)
139     : Listeners(L.begin(), L.end()) {
140 }
141 
142 void MultiplexASTMutationListener::CompletedTagDefinition(const TagDecl *D) {
143   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
144     Listeners[i]->CompletedTagDefinition(D);
145 }
146 
147 void MultiplexASTMutationListener::AddedVisibleDecl(
148     const DeclContext *DC, const Decl *D) {
149   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
150     Listeners[i]->AddedVisibleDecl(DC, D);
151 }
152 
153 void MultiplexASTMutationListener::AddedCXXImplicitMember(
154     const CXXRecordDecl *RD, const Decl *D) {
155   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
156     Listeners[i]->AddedCXXImplicitMember(RD, D);
157 }
158 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
159     const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
160   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
161     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
162 }
163 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
164     const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
165   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
166     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
167 }
168 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
169     const FunctionTemplateDecl *TD, const FunctionDecl *D) {
170   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
171     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
172 }
173 void MultiplexASTMutationListener::ResolvedExceptionSpec(
174     const FunctionDecl *FD) {
175   for (auto &Listener : Listeners)
176     Listener->ResolvedExceptionSpec(FD);
177 }
178 void MultiplexASTMutationListener::DeducedReturnType(const FunctionDecl *FD,
179                                                      QualType ReturnType) {
180   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
181     Listeners[i]->DeducedReturnType(FD, ReturnType);
182 }
183 void MultiplexASTMutationListener::ResolvedOperatorDelete(
184     const CXXDestructorDecl *DD, const FunctionDecl *Delete) {
185   for (auto *L : Listeners)
186     L->ResolvedOperatorDelete(DD, Delete);
187 }
188 void MultiplexASTMutationListener::CompletedImplicitDefinition(
189                                                         const FunctionDecl *D) {
190   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
191     Listeners[i]->CompletedImplicitDefinition(D);
192 }
193 void MultiplexASTMutationListener::StaticDataMemberInstantiated(
194                                                              const VarDecl *D) {
195   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
196     Listeners[i]->StaticDataMemberInstantiated(D);
197 }
198 void MultiplexASTMutationListener::DefaultArgumentInstantiated(
199                                                          const ParmVarDecl *D) {
200   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
201     Listeners[i]->DefaultArgumentInstantiated(D);
202 }
203 void MultiplexASTMutationListener::AddedObjCCategoryToInterface(
204                                                  const ObjCCategoryDecl *CatD,
205                                                  const ObjCInterfaceDecl *IFD) {
206   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
207     Listeners[i]->AddedObjCCategoryToInterface(CatD, IFD);
208 }
209 void MultiplexASTMutationListener::FunctionDefinitionInstantiated(
210     const FunctionDecl *D) {
211   for (auto &Listener : Listeners)
212     Listener->FunctionDefinitionInstantiated(D);
213 }
214 void MultiplexASTMutationListener::DeclarationMarkedUsed(const Decl *D) {
215   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
216     Listeners[i]->DeclarationMarkedUsed(D);
217 }
218 void MultiplexASTMutationListener::DeclarationMarkedOpenMPThreadPrivate(
219     const Decl *D) {
220   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
221     Listeners[i]->DeclarationMarkedOpenMPThreadPrivate(D);
222 }
223 void MultiplexASTMutationListener::DeclarationMarkedOpenMPDeclareTarget(
224     const Decl *D) {
225   for (auto *L : Listeners)
226     L->DeclarationMarkedOpenMPDeclareTarget(D);
227 }
228 void MultiplexASTMutationListener::RedefinedHiddenDefinition(const NamedDecl *D,
229                                                              Module *M) {
230   for (auto *L : Listeners)
231     L->RedefinedHiddenDefinition(D, M);
232 }
233 
234 void MultiplexASTMutationListener::AddedAttributeToRecord(
235                                                     const Attr *Attr,
236                                                     const RecordDecl *Record) {
237   for (auto *L : Listeners)
238     L->AddedAttributeToRecord(Attr, Record);
239 }
240 
241 }  // end namespace clang
242 
243 MultiplexConsumer::MultiplexConsumer(
244     std::vector<std::unique_ptr<ASTConsumer>> C)
245     : Consumers(std::move(C)), MutationListener(), DeserializationListener() {
246   // Collect the mutation listeners and deserialization listeners of all
247   // children, and create a multiplex listener each if so.
248   std::vector<ASTMutationListener*> mutationListeners;
249   std::vector<ASTDeserializationListener*> serializationListeners;
250   for (auto &Consumer : Consumers) {
251     if (auto *mutationListener = Consumer->GetASTMutationListener())
252       mutationListeners.push_back(mutationListener);
253     if (auto *serializationListener = Consumer->GetASTDeserializationListener())
254       serializationListeners.push_back(serializationListener);
255   }
256   if (!mutationListeners.empty()) {
257     MutationListener =
258         llvm::make_unique<MultiplexASTMutationListener>(mutationListeners);
259   }
260   if (!serializationListeners.empty()) {
261     DeserializationListener =
262         llvm::make_unique<MultiplexASTDeserializationListener>(
263             serializationListeners);
264   }
265 }
266 
267 MultiplexConsumer::~MultiplexConsumer() {}
268 
269 void MultiplexConsumer::Initialize(ASTContext &Context) {
270   for (auto &Consumer : Consumers)
271     Consumer->Initialize(Context);
272 }
273 
274 bool MultiplexConsumer::HandleTopLevelDecl(DeclGroupRef D) {
275   bool Continue = true;
276   for (auto &Consumer : Consumers)
277     Continue = Continue && Consumer->HandleTopLevelDecl(D);
278   return Continue;
279 }
280 
281 void MultiplexConsumer::HandleInlineFunctionDefinition(FunctionDecl *D) {
282   for (auto &Consumer : Consumers)
283     Consumer->HandleInlineFunctionDefinition(D);
284 }
285 
286 void MultiplexConsumer::HandleCXXStaticMemberVarInstantiation(VarDecl *VD) {
287   for (auto &Consumer : Consumers)
288     Consumer->HandleCXXStaticMemberVarInstantiation(VD);
289 }
290 
291 void MultiplexConsumer::HandleInterestingDecl(DeclGroupRef D) {
292   for (auto &Consumer : Consumers)
293     Consumer->HandleInterestingDecl(D);
294 }
295 
296 void MultiplexConsumer::HandleTranslationUnit(ASTContext &Ctx) {
297   for (auto &Consumer : Consumers)
298     Consumer->HandleTranslationUnit(Ctx);
299 }
300 
301 void MultiplexConsumer::HandleTagDeclDefinition(TagDecl *D) {
302   for (auto &Consumer : Consumers)
303     Consumer->HandleTagDeclDefinition(D);
304 }
305 
306 void MultiplexConsumer::HandleTagDeclRequiredDefinition(const TagDecl *D) {
307   for (auto &Consumer : Consumers)
308     Consumer->HandleTagDeclRequiredDefinition(D);
309 }
310 
311 void MultiplexConsumer::HandleCXXImplicitFunctionInstantiation(FunctionDecl *D){
312   for (auto &Consumer : Consumers)
313     Consumer->HandleCXXImplicitFunctionInstantiation(D);
314 }
315 
316 void MultiplexConsumer::HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
317   for (auto &Consumer : Consumers)
318     Consumer->HandleTopLevelDeclInObjCContainer(D);
319 }
320 
321 void MultiplexConsumer::HandleImplicitImportDecl(ImportDecl *D) {
322   for (auto &Consumer : Consumers)
323     Consumer->HandleImplicitImportDecl(D);
324 }
325 
326 void MultiplexConsumer::CompleteTentativeDefinition(VarDecl *D) {
327   for (auto &Consumer : Consumers)
328     Consumer->CompleteTentativeDefinition(D);
329 }
330 
331 void MultiplexConsumer::AssignInheritanceModel(CXXRecordDecl *RD) {
332   for (auto &Consumer : Consumers)
333     Consumer->AssignInheritanceModel(RD);
334 }
335 
336 void MultiplexConsumer::HandleVTable(CXXRecordDecl *RD) {
337   for (auto &Consumer : Consumers)
338     Consumer->HandleVTable(RD);
339 }
340 
341 ASTMutationListener *MultiplexConsumer::GetASTMutationListener() {
342   return MutationListener.get();
343 }
344 
345 ASTDeserializationListener *MultiplexConsumer::GetASTDeserializationListener() {
346   return DeserializationListener.get();
347 }
348 
349 void MultiplexConsumer::PrintStats() {
350   for (auto &Consumer : Consumers)
351     Consumer->PrintStats();
352 }
353 
354 bool MultiplexConsumer::shouldSkipFunctionBody(Decl *D) {
355   bool Skip = true;
356   for (auto &Consumer : Consumers)
357     Skip = Skip && Consumer->shouldSkipFunctionBody(D);
358   return Skip;
359 }
360 
361 void MultiplexConsumer::InitializeSema(Sema &S) {
362   for (auto &Consumer : Consumers)
363     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
364       SC->InitializeSema(S);
365 }
366 
367 void MultiplexConsumer::ForgetSema() {
368   for (auto &Consumer : Consumers)
369     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
370       SC->ForgetSema();
371 }
372