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