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   virtual void ReaderInitialized(ASTReader *Reader);
34   virtual void IdentifierRead(serialization::IdentID ID,
35                               IdentifierInfo *II);
36   virtual void TypeRead(serialization::TypeIdx Idx, QualType T);
37   virtual void DeclRead(serialization::DeclID ID, const Decl *D);
38   virtual void SelectorRead(serialization::SelectorID iD, Selector Sel);
39   virtual void MacroDefinitionRead(serialization::PreprocessedEntityID,
40                                    MacroDefinition *MD);
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   virtual void CompletedTagDefinition(const TagDecl *D);
93   virtual void AddedVisibleDecl(const DeclContext *DC, const Decl *D);
94   virtual void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D);
95   virtual void AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
96                                     const ClassTemplateSpecializationDecl *D);
97   virtual void AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
98                                               const FunctionDecl *D);
99   virtual void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType);
100   virtual void CompletedImplicitDefinition(const FunctionDecl *D);
101   virtual void StaticDataMemberInstantiated(const VarDecl *D);
102   virtual void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
103                                             const ObjCInterfaceDecl *IFD);
104   virtual void AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop,
105                                             const ObjCPropertyDecl *OrigProp,
106                                             const ObjCCategoryDecl *ClassExt);
107 private:
108   std::vector<ASTMutationListener*> Listeners;
109 };
110 
111 MultiplexASTMutationListener::MultiplexASTMutationListener(
112     ArrayRef<ASTMutationListener*> L)
113     : Listeners(L.begin(), L.end()) {
114 }
115 
116 void MultiplexASTMutationListener::CompletedTagDefinition(const TagDecl *D) {
117   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
118     Listeners[i]->CompletedTagDefinition(D);
119 }
120 
121 void MultiplexASTMutationListener::AddedVisibleDecl(
122     const DeclContext *DC, const Decl *D) {
123   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
124     Listeners[i]->AddedVisibleDecl(DC, D);
125 }
126 
127 void MultiplexASTMutationListener::AddedCXXImplicitMember(
128     const CXXRecordDecl *RD, const Decl *D) {
129   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
130     Listeners[i]->AddedCXXImplicitMember(RD, D);
131 }
132 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
133     const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
134   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
135     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
136 }
137 void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
138     const FunctionTemplateDecl *TD, const FunctionDecl *D) {
139   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
140     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
141 }
142 void MultiplexASTMutationListener::DeducedReturnType(const FunctionDecl *FD,
143                                                      QualType ReturnType) {
144   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
145     Listeners[i]->DeducedReturnType(FD, ReturnType);
146 }
147 void MultiplexASTMutationListener::CompletedImplicitDefinition(
148                                                         const FunctionDecl *D) {
149   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
150     Listeners[i]->CompletedImplicitDefinition(D);
151 }
152 void MultiplexASTMutationListener::StaticDataMemberInstantiated(
153                                                              const VarDecl *D) {
154   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
155     Listeners[i]->StaticDataMemberInstantiated(D);
156 }
157 void MultiplexASTMutationListener::AddedObjCCategoryToInterface(
158                                                  const ObjCCategoryDecl *CatD,
159                                                  const ObjCInterfaceDecl *IFD) {
160   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
161     Listeners[i]->AddedObjCCategoryToInterface(CatD, IFD);
162 }
163 void MultiplexASTMutationListener::AddedObjCPropertyInClassExtension(
164                                              const ObjCPropertyDecl *Prop,
165                                              const ObjCPropertyDecl *OrigProp,
166                                              const ObjCCategoryDecl *ClassExt) {
167   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
168     Listeners[i]->AddedObjCPropertyInClassExtension(Prop, OrigProp, ClassExt);
169 }
170 
171 }  // end namespace clang
172 
173 
174 MultiplexConsumer::MultiplexConsumer(ArrayRef<ASTConsumer*> C)
175     : Consumers(C.begin(), C.end()),
176       MutationListener(0), DeserializationListener(0) {
177   // Collect the mutation listeners and deserialization listeners of all
178   // children, and create a multiplex listener each if so.
179   std::vector<ASTMutationListener*> mutationListeners;
180   std::vector<ASTDeserializationListener*> serializationListeners;
181   for (size_t i = 0, e = Consumers.size(); i != e; ++i) {
182     ASTMutationListener* mutationListener =
183         Consumers[i]->GetASTMutationListener();
184     if (mutationListener)
185       mutationListeners.push_back(mutationListener);
186     ASTDeserializationListener* serializationListener =
187         Consumers[i]->GetASTDeserializationListener();
188     if (serializationListener)
189       serializationListeners.push_back(serializationListener);
190   }
191   if (mutationListeners.size()) {
192     MutationListener.reset(new MultiplexASTMutationListener(mutationListeners));
193   }
194   if (serializationListeners.size()) {
195     DeserializationListener.reset(
196         new MultiplexASTDeserializationListener(serializationListeners));
197   }
198 }
199 
200 MultiplexConsumer::~MultiplexConsumer() {
201   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
202     delete Consumers[i];
203 }
204 
205 void MultiplexConsumer::Initialize(ASTContext &Context) {
206   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
207     Consumers[i]->Initialize(Context);
208 }
209 
210 bool MultiplexConsumer::HandleTopLevelDecl(DeclGroupRef D) {
211   bool Continue = true;
212   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
213     Continue = Continue && Consumers[i]->HandleTopLevelDecl(D);
214   return Continue;
215 }
216 
217 void  MultiplexConsumer::HandleCXXStaticMemberVarInstantiation(VarDecl *VD) {
218   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
219     Consumers[i]->HandleCXXStaticMemberVarInstantiation(VD);
220 }
221 
222 void MultiplexConsumer::HandleInterestingDecl(DeclGroupRef D) {
223   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
224     Consumers[i]->HandleInterestingDecl(D);
225 }
226 
227 void MultiplexConsumer::HandleTranslationUnit(ASTContext &Ctx) {
228   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
229     Consumers[i]->HandleTranslationUnit(Ctx);
230 }
231 
232 void MultiplexConsumer::HandleTagDeclDefinition(TagDecl *D) {
233   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
234     Consumers[i]->HandleTagDeclDefinition(D);
235 }
236 
237 void MultiplexConsumer::HandleCXXImplicitFunctionInstantiation(FunctionDecl *D){
238   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
239     Consumers[i]->HandleCXXImplicitFunctionInstantiation(D);
240 }
241 
242 void MultiplexConsumer::HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
243   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
244     Consumers[i]->HandleTopLevelDeclInObjCContainer(D);
245 }
246 
247 void MultiplexConsumer::CompleteTentativeDefinition(VarDecl *D) {
248   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
249     Consumers[i]->CompleteTentativeDefinition(D);
250 }
251 
252 void MultiplexConsumer::HandleVTable(
253     CXXRecordDecl *RD, bool DefinitionRequired) {
254   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
255     Consumers[i]->HandleVTable(RD, DefinitionRequired);
256 }
257 
258 ASTMutationListener *MultiplexConsumer::GetASTMutationListener() {
259   return MutationListener.get();
260 }
261 
262 ASTDeserializationListener *MultiplexConsumer::GetASTDeserializationListener() {
263   return DeserializationListener.get();
264 }
265 
266 void MultiplexConsumer::PrintStats() {
267   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
268     Consumers[i]->PrintStats();
269 }
270 
271 void MultiplexConsumer::InitializeSema(Sema &S) {
272   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
273     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumers[i]))
274       SC->InitializeSema(S);
275 }
276 
277 void MultiplexConsumer::ForgetSema() {
278   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
279     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumers[i]))
280       SC->ForgetSema();
281 }
282