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 TypeRead(serialization::TypeIdx Idx, QualType T) override;
37   void DeclRead(serialization::DeclID ID, const Decl *D) override;
38   void SelectorRead(serialization::SelectorID iD, Selector Sel) override;
39   void MacroDefinitionRead(serialization::PreprocessedEntityID,
40                            MacroDefinition *MD) override;
41 private:
42   std::vector<ASTDeserializationListener*> Listeners;
43 };
44 
45 MultiplexASTDeserializationListener::MultiplexASTDeserializationListener(
46       const std::vector<ASTDeserializationListener*>& L)
47     : Listeners(L) {
48 }
49 
50 void MultiplexASTDeserializationListener::ReaderInitialized(
51     ASTReader *Reader) {
52   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
53     Listeners[i]->ReaderInitialized(Reader);
54 }
55 
56 void MultiplexASTDeserializationListener::IdentifierRead(
57     serialization::IdentID ID, IdentifierInfo *II) {
58   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
59     Listeners[i]->IdentifierRead(ID, II);
60 }
61 
62 void MultiplexASTDeserializationListener::TypeRead(
63     serialization::TypeIdx Idx, QualType T) {
64   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
65     Listeners[i]->TypeRead(Idx, T);
66 }
67 
68 void MultiplexASTDeserializationListener::DeclRead(
69     serialization::DeclID ID, const Decl *D) {
70   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
71     Listeners[i]->DeclRead(ID, D);
72 }
73 
74 void MultiplexASTDeserializationListener::SelectorRead(
75     serialization::SelectorID ID, Selector Sel) {
76   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
77     Listeners[i]->SelectorRead(ID, Sel);
78 }
79 
80 void MultiplexASTDeserializationListener::MacroDefinitionRead(
81     serialization::PreprocessedEntityID ID, MacroDefinition *MD) {
82   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
83     Listeners[i]->MacroDefinitionRead(ID, MD);
84 }
85 
86 // This ASTMutationListener forwards its notifications to a set of
87 // child listeners.
88 class MultiplexASTMutationListener : public ASTMutationListener {
89 public:
90   // Does NOT take ownership of the elements in L.
91   MultiplexASTMutationListener(ArrayRef<ASTMutationListener*> L);
92   void CompletedTagDefinition(const TagDecl *D) override;
93   void AddedVisibleDecl(const DeclContext *DC, const Decl *D) override;
94   void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) override;
95   void AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
96                             const ClassTemplateSpecializationDecl *D) override;
97   void AddedCXXTemplateSpecialization(const VarTemplateDecl *TD,
98                                const VarTemplateSpecializationDecl *D) override;
99   void AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
100                                       const FunctionDecl *D) override;
101   void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override;
102   void CompletedImplicitDefinition(const FunctionDecl *D) override;
103   void StaticDataMemberInstantiated(const VarDecl *D) override;
104   void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
105                                     const ObjCInterfaceDecl *IFD) override;
106   void AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop,
107                                     const ObjCPropertyDecl *OrigProp,
108                                     const ObjCCategoryDecl *ClassExt) override;
109   void DeclarationMarkedUsed(const Decl *D) override;
110 
111 private:
112   std::vector<ASTMutationListener*> Listeners;
113 };
114 
115 MultiplexASTMutationListener::MultiplexASTMutationListener(
116     ArrayRef<ASTMutationListener*> L)
117     : Listeners(L.begin(), L.end()) {
118 }
119 
120 void MultiplexASTMutationListener::CompletedTagDefinition(const TagDecl *D) {
121   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
122     Listeners[i]->CompletedTagDefinition(D);
123 }
124 
125 void MultiplexASTMutationListener::AddedVisibleDecl(
126     const DeclContext *DC, const Decl *D) {
127   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
128     Listeners[i]->AddedVisibleDecl(DC, D);
129 }
130 
131 void MultiplexASTMutationListener::AddedCXXImplicitMember(
132     const CXXRecordDecl *RD, const Decl *D) {
133   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
134     Listeners[i]->AddedCXXImplicitMember(RD, D);
135 }
136 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
137     const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
138   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
139     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
140 }
141 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
142     const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
143   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
144     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
145 }
146 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
147     const FunctionTemplateDecl *TD, const FunctionDecl *D) {
148   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
149     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
150 }
151 void MultiplexASTMutationListener::DeducedReturnType(const FunctionDecl *FD,
152                                                      QualType ReturnType) {
153   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
154     Listeners[i]->DeducedReturnType(FD, ReturnType);
155 }
156 void MultiplexASTMutationListener::CompletedImplicitDefinition(
157                                                         const FunctionDecl *D) {
158   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
159     Listeners[i]->CompletedImplicitDefinition(D);
160 }
161 void MultiplexASTMutationListener::StaticDataMemberInstantiated(
162                                                              const VarDecl *D) {
163   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
164     Listeners[i]->StaticDataMemberInstantiated(D);
165 }
166 void MultiplexASTMutationListener::AddedObjCCategoryToInterface(
167                                                  const ObjCCategoryDecl *CatD,
168                                                  const ObjCInterfaceDecl *IFD) {
169   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
170     Listeners[i]->AddedObjCCategoryToInterface(CatD, IFD);
171 }
172 void MultiplexASTMutationListener::AddedObjCPropertyInClassExtension(
173                                              const ObjCPropertyDecl *Prop,
174                                              const ObjCPropertyDecl *OrigProp,
175                                              const ObjCCategoryDecl *ClassExt) {
176   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
177     Listeners[i]->AddedObjCPropertyInClassExtension(Prop, OrigProp, ClassExt);
178 }
179 void MultiplexASTMutationListener::DeclarationMarkedUsed(const Decl *D) {
180   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
181     Listeners[i]->DeclarationMarkedUsed(D);
182 }
183 
184 }  // end namespace clang
185 
186 MultiplexConsumer::MultiplexConsumer(
187     std::vector<std::unique_ptr<ASTConsumer>> C)
188     : Consumers(std::move(C)), MutationListener(), DeserializationListener() {
189   // Collect the mutation listeners and deserialization listeners of all
190   // children, and create a multiplex listener each if so.
191   std::vector<ASTMutationListener*> mutationListeners;
192   std::vector<ASTDeserializationListener*> serializationListeners;
193   for (auto &Consumer : Consumers) {
194     if (auto *mutationListener = Consumer->GetASTMutationListener())
195       mutationListeners.push_back(mutationListener);
196     if (auto *serializationListener = Consumer->GetASTDeserializationListener())
197       serializationListeners.push_back(serializationListener);
198   }
199   if (!mutationListeners.empty()) {
200     MutationListener =
201         llvm::make_unique<MultiplexASTMutationListener>(mutationListeners);
202   }
203   if (!serializationListeners.empty()) {
204     DeserializationListener =
205         llvm::make_unique<MultiplexASTDeserializationListener>(
206             serializationListeners);
207   }
208 }
209 
210 MultiplexConsumer::~MultiplexConsumer() {}
211 
212 void MultiplexConsumer::Initialize(ASTContext &Context) {
213   for (auto &Consumer : Consumers)
214     Consumer->Initialize(Context);
215 }
216 
217 bool MultiplexConsumer::HandleTopLevelDecl(DeclGroupRef D) {
218   bool Continue = true;
219   for (auto &Consumer : Consumers)
220     Continue = Continue && Consumer->HandleTopLevelDecl(D);
221   return Continue;
222 }
223 
224 void MultiplexConsumer::HandleInlineMethodDefinition(CXXMethodDecl *D) {
225   for (auto &Consumer : Consumers)
226     Consumer->HandleInlineMethodDefinition(D);
227 }
228 
229 void MultiplexConsumer::HandleCXXStaticMemberVarInstantiation(VarDecl *VD) {
230   for (auto &Consumer : Consumers)
231     Consumer->HandleCXXStaticMemberVarInstantiation(VD);
232 }
233 
234 void MultiplexConsumer::HandleInterestingDecl(DeclGroupRef D) {
235   for (auto &Consumer : Consumers)
236     Consumer->HandleInterestingDecl(D);
237 }
238 
239 void MultiplexConsumer::HandleTranslationUnit(ASTContext &Ctx) {
240   for (auto &Consumer : Consumers)
241     Consumer->HandleTranslationUnit(Ctx);
242 }
243 
244 void MultiplexConsumer::HandleTagDeclDefinition(TagDecl *D) {
245   for (auto &Consumer : Consumers)
246     Consumer->HandleTagDeclDefinition(D);
247 }
248 
249 void MultiplexConsumer::HandleTagDeclRequiredDefinition(const TagDecl *D) {
250   for (auto &Consumer : Consumers)
251     Consumer->HandleTagDeclRequiredDefinition(D);
252 }
253 
254 void MultiplexConsumer::HandleCXXImplicitFunctionInstantiation(FunctionDecl *D){
255   for (auto &Consumer : Consumers)
256     Consumer->HandleCXXImplicitFunctionInstantiation(D);
257 }
258 
259 void MultiplexConsumer::HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
260   for (auto &Consumer : Consumers)
261     Consumer->HandleTopLevelDeclInObjCContainer(D);
262 }
263 
264 void MultiplexConsumer::HandleImplicitImportDecl(ImportDecl *D) {
265   for (auto &Consumer : Consumers)
266     Consumer->HandleImplicitImportDecl(D);
267 }
268 
269 void MultiplexConsumer::HandleLinkerOptionPragma(llvm::StringRef Opts) {
270   for (auto &Consumer : Consumers)
271     Consumer->HandleLinkerOptionPragma(Opts);
272 }
273 
274 void MultiplexConsumer::HandleDetectMismatch(llvm::StringRef Name, llvm::StringRef Value) {
275   for (auto &Consumer : Consumers)
276     Consumer->HandleDetectMismatch(Name, Value);
277 }
278 
279 void MultiplexConsumer::HandleDependentLibrary(llvm::StringRef Lib) {
280   for (auto &Consumer : Consumers)
281     Consumer->HandleDependentLibrary(Lib);
282 }
283 
284 void MultiplexConsumer::CompleteTentativeDefinition(VarDecl *D) {
285   for (auto &Consumer : Consumers)
286     Consumer->CompleteTentativeDefinition(D);
287 }
288 
289 void MultiplexConsumer::HandleVTable(
290     CXXRecordDecl *RD, bool DefinitionRequired) {
291   for (auto &Consumer : Consumers)
292     Consumer->HandleVTable(RD, DefinitionRequired);
293 }
294 
295 ASTMutationListener *MultiplexConsumer::GetASTMutationListener() {
296   return MutationListener.get();
297 }
298 
299 ASTDeserializationListener *MultiplexConsumer::GetASTDeserializationListener() {
300   return DeserializationListener.get();
301 }
302 
303 void MultiplexConsumer::PrintStats() {
304   for (auto &Consumer : Consumers)
305     Consumer->PrintStats();
306 }
307 
308 void MultiplexConsumer::InitializeSema(Sema &S) {
309   for (auto &Consumer : Consumers)
310     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
311       SC->InitializeSema(S);
312 }
313 
314 void MultiplexConsumer::ForgetSema() {
315   for (auto &Consumer : Consumers)
316     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
317       SC->ForgetSema();
318 }
319