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 DefaultMemberInitializerInstantiated(const FieldDecl *D) override;
124   void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
125                                     const ObjCInterfaceDecl *IFD) override;
126   void FunctionDefinitionInstantiated(const FunctionDecl *D) override;
127   void DeclarationMarkedUsed(const Decl *D) override;
128   void DeclarationMarkedOpenMPThreadPrivate(const Decl *D) override;
129   void DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
130                                             const Attr *Attr) override;
131   void RedefinedHiddenDefinition(const NamedDecl *D, Module *M) override;
132   void AddedAttributeToRecord(const Attr *Attr,
133                               const RecordDecl *Record) override;
134 
135 private:
136   std::vector<ASTMutationListener*> Listeners;
137 };
138 
139 MultiplexASTMutationListener::MultiplexASTMutationListener(
140     ArrayRef<ASTMutationListener*> L)
141     : Listeners(L.begin(), L.end()) {
142 }
143 
144 void MultiplexASTMutationListener::CompletedTagDefinition(const TagDecl *D) {
145   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
146     Listeners[i]->CompletedTagDefinition(D);
147 }
148 
149 void MultiplexASTMutationListener::AddedVisibleDecl(
150     const DeclContext *DC, const Decl *D) {
151   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
152     Listeners[i]->AddedVisibleDecl(DC, D);
153 }
154 
155 void MultiplexASTMutationListener::AddedCXXImplicitMember(
156     const CXXRecordDecl *RD, const Decl *D) {
157   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
158     Listeners[i]->AddedCXXImplicitMember(RD, D);
159 }
160 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
161     const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
162   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
163     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
164 }
165 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
166     const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
167   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
168     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
169 }
170 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
171     const FunctionTemplateDecl *TD, const FunctionDecl *D) {
172   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
173     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
174 }
175 void MultiplexASTMutationListener::ResolvedExceptionSpec(
176     const FunctionDecl *FD) {
177   for (auto &Listener : Listeners)
178     Listener->ResolvedExceptionSpec(FD);
179 }
180 void MultiplexASTMutationListener::DeducedReturnType(const FunctionDecl *FD,
181                                                      QualType ReturnType) {
182   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
183     Listeners[i]->DeducedReturnType(FD, ReturnType);
184 }
185 void MultiplexASTMutationListener::ResolvedOperatorDelete(
186     const CXXDestructorDecl *DD, const FunctionDecl *Delete) {
187   for (auto *L : Listeners)
188     L->ResolvedOperatorDelete(DD, Delete);
189 }
190 void MultiplexASTMutationListener::CompletedImplicitDefinition(
191                                                         const FunctionDecl *D) {
192   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
193     Listeners[i]->CompletedImplicitDefinition(D);
194 }
195 void MultiplexASTMutationListener::StaticDataMemberInstantiated(
196                                                              const VarDecl *D) {
197   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
198     Listeners[i]->StaticDataMemberInstantiated(D);
199 }
200 void MultiplexASTMutationListener::DefaultArgumentInstantiated(
201                                                          const ParmVarDecl *D) {
202   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
203     Listeners[i]->DefaultArgumentInstantiated(D);
204 }
205 void MultiplexASTMutationListener::DefaultMemberInitializerInstantiated(
206                                                            const FieldDecl *D) {
207   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
208     Listeners[i]->DefaultMemberInitializerInstantiated(D);
209 }
210 void MultiplexASTMutationListener::AddedObjCCategoryToInterface(
211                                                  const ObjCCategoryDecl *CatD,
212                                                  const ObjCInterfaceDecl *IFD) {
213   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
214     Listeners[i]->AddedObjCCategoryToInterface(CatD, IFD);
215 }
216 void MultiplexASTMutationListener::FunctionDefinitionInstantiated(
217     const FunctionDecl *D) {
218   for (auto &Listener : Listeners)
219     Listener->FunctionDefinitionInstantiated(D);
220 }
221 void MultiplexASTMutationListener::DeclarationMarkedUsed(const Decl *D) {
222   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
223     Listeners[i]->DeclarationMarkedUsed(D);
224 }
225 void MultiplexASTMutationListener::DeclarationMarkedOpenMPThreadPrivate(
226     const Decl *D) {
227   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
228     Listeners[i]->DeclarationMarkedOpenMPThreadPrivate(D);
229 }
230 void MultiplexASTMutationListener::DeclarationMarkedOpenMPDeclareTarget(
231     const Decl *D, const Attr *Attr) {
232   for (auto *L : Listeners)
233     L->DeclarationMarkedOpenMPDeclareTarget(D, Attr);
234 }
235 void MultiplexASTMutationListener::RedefinedHiddenDefinition(const NamedDecl *D,
236                                                              Module *M) {
237   for (auto *L : Listeners)
238     L->RedefinedHiddenDefinition(D, M);
239 }
240 
241 void MultiplexASTMutationListener::AddedAttributeToRecord(
242                                                     const Attr *Attr,
243                                                     const RecordDecl *Record) {
244   for (auto *L : Listeners)
245     L->AddedAttributeToRecord(Attr, Record);
246 }
247 
248 }  // end namespace clang
249 
250 MultiplexConsumer::MultiplexConsumer(
251     std::vector<std::unique_ptr<ASTConsumer>> C)
252     : Consumers(std::move(C)), MutationListener(), DeserializationListener() {
253   // Collect the mutation listeners and deserialization listeners of all
254   // children, and create a multiplex listener each if so.
255   std::vector<ASTMutationListener*> mutationListeners;
256   std::vector<ASTDeserializationListener*> serializationListeners;
257   for (auto &Consumer : Consumers) {
258     if (auto *mutationListener = Consumer->GetASTMutationListener())
259       mutationListeners.push_back(mutationListener);
260     if (auto *serializationListener = Consumer->GetASTDeserializationListener())
261       serializationListeners.push_back(serializationListener);
262   }
263   if (!mutationListeners.empty()) {
264     MutationListener =
265         llvm::make_unique<MultiplexASTMutationListener>(mutationListeners);
266   }
267   if (!serializationListeners.empty()) {
268     DeserializationListener =
269         llvm::make_unique<MultiplexASTDeserializationListener>(
270             serializationListeners);
271   }
272 }
273 
274 MultiplexConsumer::~MultiplexConsumer() {}
275 
276 void MultiplexConsumer::Initialize(ASTContext &Context) {
277   for (auto &Consumer : Consumers)
278     Consumer->Initialize(Context);
279 }
280 
281 bool MultiplexConsumer::HandleTopLevelDecl(DeclGroupRef D) {
282   bool Continue = true;
283   for (auto &Consumer : Consumers)
284     Continue = Continue && Consumer->HandleTopLevelDecl(D);
285   return Continue;
286 }
287 
288 void MultiplexConsumer::HandleInlineFunctionDefinition(FunctionDecl *D) {
289   for (auto &Consumer : Consumers)
290     Consumer->HandleInlineFunctionDefinition(D);
291 }
292 
293 void MultiplexConsumer::HandleCXXStaticMemberVarInstantiation(VarDecl *VD) {
294   for (auto &Consumer : Consumers)
295     Consumer->HandleCXXStaticMemberVarInstantiation(VD);
296 }
297 
298 void MultiplexConsumer::HandleInterestingDecl(DeclGroupRef D) {
299   for (auto &Consumer : Consumers)
300     Consumer->HandleInterestingDecl(D);
301 }
302 
303 void MultiplexConsumer::HandleTranslationUnit(ASTContext &Ctx) {
304   for (auto &Consumer : Consumers)
305     Consumer->HandleTranslationUnit(Ctx);
306 }
307 
308 void MultiplexConsumer::HandleTagDeclDefinition(TagDecl *D) {
309   for (auto &Consumer : Consumers)
310     Consumer->HandleTagDeclDefinition(D);
311 }
312 
313 void MultiplexConsumer::HandleTagDeclRequiredDefinition(const TagDecl *D) {
314   for (auto &Consumer : Consumers)
315     Consumer->HandleTagDeclRequiredDefinition(D);
316 }
317 
318 void MultiplexConsumer::HandleCXXImplicitFunctionInstantiation(FunctionDecl *D){
319   for (auto &Consumer : Consumers)
320     Consumer->HandleCXXImplicitFunctionInstantiation(D);
321 }
322 
323 void MultiplexConsumer::HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
324   for (auto &Consumer : Consumers)
325     Consumer->HandleTopLevelDeclInObjCContainer(D);
326 }
327 
328 void MultiplexConsumer::HandleImplicitImportDecl(ImportDecl *D) {
329   for (auto &Consumer : Consumers)
330     Consumer->HandleImplicitImportDecl(D);
331 }
332 
333 void MultiplexConsumer::CompleteTentativeDefinition(VarDecl *D) {
334   for (auto &Consumer : Consumers)
335     Consumer->CompleteTentativeDefinition(D);
336 }
337 
338 void MultiplexConsumer::AssignInheritanceModel(CXXRecordDecl *RD) {
339   for (auto &Consumer : Consumers)
340     Consumer->AssignInheritanceModel(RD);
341 }
342 
343 void MultiplexConsumer::HandleVTable(CXXRecordDecl *RD) {
344   for (auto &Consumer : Consumers)
345     Consumer->HandleVTable(RD);
346 }
347 
348 ASTMutationListener *MultiplexConsumer::GetASTMutationListener() {
349   return MutationListener.get();
350 }
351 
352 ASTDeserializationListener *MultiplexConsumer::GetASTDeserializationListener() {
353   return DeserializationListener.get();
354 }
355 
356 void MultiplexConsumer::PrintStats() {
357   for (auto &Consumer : Consumers)
358     Consumer->PrintStats();
359 }
360 
361 bool MultiplexConsumer::shouldSkipFunctionBody(Decl *D) {
362   bool Skip = true;
363   for (auto &Consumer : Consumers)
364     Skip = Skip && Consumer->shouldSkipFunctionBody(D);
365   return Skip;
366 }
367 
368 void MultiplexConsumer::InitializeSema(Sema &S) {
369   for (auto &Consumer : Consumers)
370     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
371       SC->InitializeSema(S);
372 }
373 
374 void MultiplexConsumer::ForgetSema() {
375   for (auto &Consumer : Consumers)
376     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
377       SC->ForgetSema();
378 }
379