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