12992efa4SNico Weber //===- MultiplexConsumer.cpp - AST Consumer for PCH Generation --*- C++ -*-===//
22992efa4SNico Weber //
32992efa4SNico Weber //                     The LLVM Compiler Infrastructure
42992efa4SNico Weber //
52992efa4SNico Weber // This file is distributed under the University of Illinois Open Source
62992efa4SNico Weber // License. See LICENSE.TXT for details.
72992efa4SNico Weber //
82992efa4SNico Weber //===----------------------------------------------------------------------===//
92992efa4SNico Weber //
102992efa4SNico Weber //  This file defines the MultiplexConsumer class. It also declares and defines
112992efa4SNico Weber //  MultiplexASTDeserializationListener and  MultiplexASTMutationListener, which
122992efa4SNico Weber //  are implementation details of MultiplexConsumer.
132992efa4SNico Weber //
142992efa4SNico Weber //===----------------------------------------------------------------------===//
152992efa4SNico Weber 
162992efa4SNico Weber #include "clang/Frontend/MultiplexConsumer.h"
172992efa4SNico Weber #include "clang/AST/ASTMutationListener.h"
182992efa4SNico Weber #include "clang/AST/DeclGroup.h"
192992efa4SNico Weber #include "clang/Serialization/ASTDeserializationListener.h"
202992efa4SNico Weber 
212992efa4SNico Weber using namespace clang;
222992efa4SNico Weber 
232992efa4SNico Weber namespace clang {
242992efa4SNico Weber 
252992efa4SNico Weber // This ASTDeserializationListener forwards its notifications to a set of
262992efa4SNico Weber // child listeners.
272992efa4SNico Weber class MultiplexASTDeserializationListener
282992efa4SNico Weber     : public ASTDeserializationListener {
292992efa4SNico Weber public:
302992efa4SNico Weber   // Does NOT take ownership of the elements in L.
312992efa4SNico Weber   MultiplexASTDeserializationListener(
322992efa4SNico Weber       const std::vector<ASTDeserializationListener*>& L);
33afa7cb3aSCraig Topper   void ReaderInitialized(ASTReader *Reader) override;
34afa7cb3aSCraig Topper   void IdentifierRead(serialization::IdentID ID,
35afa7cb3aSCraig Topper                       IdentifierInfo *II) override;
36afa7cb3aSCraig Topper   void TypeRead(serialization::TypeIdx Idx, QualType T) override;
37afa7cb3aSCraig Topper   void DeclRead(serialization::DeclID ID, const Decl *D) override;
38afa7cb3aSCraig Topper   void SelectorRead(serialization::SelectorID iD, Selector Sel) override;
39afa7cb3aSCraig Topper   void MacroDefinitionRead(serialization::PreprocessedEntityID,
40afa7cb3aSCraig Topper                            MacroDefinition *MD) override;
412992efa4SNico Weber private:
422992efa4SNico Weber   std::vector<ASTDeserializationListener*> Listeners;
432992efa4SNico Weber };
442992efa4SNico Weber 
452992efa4SNico Weber MultiplexASTDeserializationListener::MultiplexASTDeserializationListener(
462992efa4SNico Weber       const std::vector<ASTDeserializationListener*>& L)
472992efa4SNico Weber     : Listeners(L) {
482992efa4SNico Weber }
492992efa4SNico Weber 
502992efa4SNico Weber void MultiplexASTDeserializationListener::ReaderInitialized(
512992efa4SNico Weber     ASTReader *Reader) {
522992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
532992efa4SNico Weber     Listeners[i]->ReaderInitialized(Reader);
542992efa4SNico Weber }
552992efa4SNico Weber 
562992efa4SNico Weber void MultiplexASTDeserializationListener::IdentifierRead(
572992efa4SNico Weber     serialization::IdentID ID, IdentifierInfo *II) {
582992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
592992efa4SNico Weber     Listeners[i]->IdentifierRead(ID, II);
602992efa4SNico Weber }
612992efa4SNico Weber 
622992efa4SNico Weber void MultiplexASTDeserializationListener::TypeRead(
632992efa4SNico Weber     serialization::TypeIdx Idx, QualType T) {
642992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
652992efa4SNico Weber     Listeners[i]->TypeRead(Idx, T);
662992efa4SNico Weber }
672992efa4SNico Weber 
682992efa4SNico Weber void MultiplexASTDeserializationListener::DeclRead(
692992efa4SNico Weber     serialization::DeclID ID, const Decl *D) {
702992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
712992efa4SNico Weber     Listeners[i]->DeclRead(ID, D);
722992efa4SNico Weber }
732992efa4SNico Weber 
742992efa4SNico Weber void MultiplexASTDeserializationListener::SelectorRead(
752992efa4SNico Weber     serialization::SelectorID ID, Selector Sel) {
762992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
772992efa4SNico Weber     Listeners[i]->SelectorRead(ID, Sel);
782992efa4SNico Weber }
792992efa4SNico Weber 
802992efa4SNico Weber void MultiplexASTDeserializationListener::MacroDefinitionRead(
8103c40c51SArgyrios Kyrtzidis     serialization::PreprocessedEntityID ID, MacroDefinition *MD) {
822992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
832992efa4SNico Weber     Listeners[i]->MacroDefinitionRead(ID, MD);
842992efa4SNico Weber }
852992efa4SNico Weber 
862992efa4SNico Weber // This ASTMutationListener forwards its notifications to a set of
872992efa4SNico Weber // child listeners.
882992efa4SNico Weber class MultiplexASTMutationListener : public ASTMutationListener {
892992efa4SNico Weber public:
902992efa4SNico Weber   // Does NOT take ownership of the elements in L.
919e0cd46dSArgyrios Kyrtzidis   MultiplexASTMutationListener(ArrayRef<ASTMutationListener*> L);
92afa7cb3aSCraig Topper   void CompletedTagDefinition(const TagDecl *D) override;
93afa7cb3aSCraig Topper   void AddedVisibleDecl(const DeclContext *DC, const Decl *D) override;
94afa7cb3aSCraig Topper   void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) override;
95afa7cb3aSCraig Topper   void AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
96afa7cb3aSCraig Topper                             const ClassTemplateSpecializationDecl *D) override;
97afa7cb3aSCraig Topper   void AddedCXXTemplateSpecialization(const VarTemplateDecl *TD,
98afa7cb3aSCraig Topper                                const VarTemplateSpecializationDecl *D) override;
99afa7cb3aSCraig Topper   void AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
100afa7cb3aSCraig Topper                                       const FunctionDecl *D) override;
101afa7cb3aSCraig Topper   void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override;
102afa7cb3aSCraig Topper   void CompletedImplicitDefinition(const FunctionDecl *D) override;
103afa7cb3aSCraig Topper   void StaticDataMemberInstantiated(const VarDecl *D) override;
104afa7cb3aSCraig Topper   void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
105afa7cb3aSCraig Topper                                     const ObjCInterfaceDecl *IFD) override;
106afa7cb3aSCraig Topper   void AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop,
10792622781SArgyrios Kyrtzidis                                     const ObjCPropertyDecl *OrigProp,
108afa7cb3aSCraig Topper                                     const ObjCCategoryDecl *ClassExt) override;
109a798a9dbSCraig Topper   void DeclarationMarkedUsed(const Decl *D) override;
110276dd188SEli Friedman 
1112992efa4SNico Weber private:
1122992efa4SNico Weber   std::vector<ASTMutationListener*> Listeners;
1132992efa4SNico Weber };
1142992efa4SNico Weber 
1152992efa4SNico Weber MultiplexASTMutationListener::MultiplexASTMutationListener(
1169e0cd46dSArgyrios Kyrtzidis     ArrayRef<ASTMutationListener*> L)
1179e0cd46dSArgyrios Kyrtzidis     : Listeners(L.begin(), L.end()) {
1182992efa4SNico Weber }
1192992efa4SNico Weber 
1202992efa4SNico Weber void MultiplexASTMutationListener::CompletedTagDefinition(const TagDecl *D) {
1212992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
1222992efa4SNico Weber     Listeners[i]->CompletedTagDefinition(D);
1232992efa4SNico Weber }
1242992efa4SNico Weber 
1252992efa4SNico Weber void MultiplexASTMutationListener::AddedVisibleDecl(
1262992efa4SNico Weber     const DeclContext *DC, const Decl *D) {
1272992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
1282992efa4SNico Weber     Listeners[i]->AddedVisibleDecl(DC, D);
1292992efa4SNico Weber }
1302992efa4SNico Weber 
1312992efa4SNico Weber void MultiplexASTMutationListener::AddedCXXImplicitMember(
1322992efa4SNico Weber     const CXXRecordDecl *RD, const Decl *D) {
1332992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
1342992efa4SNico Weber     Listeners[i]->AddedCXXImplicitMember(RD, D);
1352992efa4SNico Weber }
1362992efa4SNico Weber void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
1372992efa4SNico Weber     const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
1382992efa4SNico Weber   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
1392992efa4SNico Weber     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
1402992efa4SNico Weber }
1419ab988feSSebastian Redl void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
14239a1e507SLarisse Voufo     const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
14339a1e507SLarisse Voufo   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
14439a1e507SLarisse Voufo     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
14539a1e507SLarisse Voufo }
14639a1e507SLarisse Voufo void MultiplexASTMutationListener::AddedCXXTemplateSpecialization(
1479ab988feSSebastian Redl     const FunctionTemplateDecl *TD, const FunctionDecl *D) {
1489ab988feSSebastian Redl   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
1499ab988feSSebastian Redl     Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
1509ab988feSSebastian Redl }
1511fa5d64bSRichard Smith void MultiplexASTMutationListener::DeducedReturnType(const FunctionDecl *FD,
1521fa5d64bSRichard Smith                                                      QualType ReturnType) {
1531fa5d64bSRichard Smith   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
1541fa5d64bSRichard Smith     Listeners[i]->DeducedReturnType(FD, ReturnType);
1551fa5d64bSRichard Smith }
156ab238a7dSSebastian Redl void MultiplexASTMutationListener::CompletedImplicitDefinition(
157ab238a7dSSebastian Redl                                                         const FunctionDecl *D) {
158ab238a7dSSebastian Redl   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
159ab238a7dSSebastian Redl     Listeners[i]->CompletedImplicitDefinition(D);
160ab238a7dSSebastian Redl }
1612ac2c725SSebastian Redl void MultiplexASTMutationListener::StaticDataMemberInstantiated(
1622ac2c725SSebastian Redl                                                              const VarDecl *D) {
1632ac2c725SSebastian Redl   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
1642ac2c725SSebastian Redl     Listeners[i]->StaticDataMemberInstantiated(D);
1652ac2c725SSebastian Redl }
16692622781SArgyrios Kyrtzidis void MultiplexASTMutationListener::AddedObjCCategoryToInterface(
16792622781SArgyrios Kyrtzidis                                                  const ObjCCategoryDecl *CatD,
16892622781SArgyrios Kyrtzidis                                                  const ObjCInterfaceDecl *IFD) {
16992622781SArgyrios Kyrtzidis   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
17092622781SArgyrios Kyrtzidis     Listeners[i]->AddedObjCCategoryToInterface(CatD, IFD);
17192622781SArgyrios Kyrtzidis }
17292622781SArgyrios Kyrtzidis void MultiplexASTMutationListener::AddedObjCPropertyInClassExtension(
17392622781SArgyrios Kyrtzidis                                              const ObjCPropertyDecl *Prop,
17492622781SArgyrios Kyrtzidis                                              const ObjCPropertyDecl *OrigProp,
17592622781SArgyrios Kyrtzidis                                              const ObjCCategoryDecl *ClassExt) {
17692622781SArgyrios Kyrtzidis   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
17792622781SArgyrios Kyrtzidis     Listeners[i]->AddedObjCPropertyInClassExtension(Prop, OrigProp, ClassExt);
17892622781SArgyrios Kyrtzidis }
179276dd188SEli Friedman void MultiplexASTMutationListener::DeclarationMarkedUsed(const Decl *D) {
180276dd188SEli Friedman   for (size_t i = 0, e = Listeners.size(); i != e; ++i)
181276dd188SEli Friedman     Listeners[i]->DeclarationMarkedUsed(D);
182276dd188SEli Friedman }
1832992efa4SNico Weber 
1842992efa4SNico Weber }  // end namespace clang
1852992efa4SNico Weber 
186275a671bSArgyrios Kyrtzidis MultiplexConsumer::MultiplexConsumer(ArrayRef<ASTConsumer *> C)
187b8984329SAhmed Charles     : Consumers(C.begin(), C.end()), MutationListener(),
188b8984329SAhmed Charles       DeserializationListener() {
1892992efa4SNico Weber   // Collect the mutation listeners and deserialization listeners of all
1902992efa4SNico Weber   // children, and create a multiplex listener each if so.
1912992efa4SNico Weber   std::vector<ASTMutationListener*> mutationListeners;
1922992efa4SNico Weber   std::vector<ASTDeserializationListener*> serializationListeners;
1932992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i) {
1942992efa4SNico Weber     ASTMutationListener* mutationListener =
1952992efa4SNico Weber         Consumers[i]->GetASTMutationListener();
1962992efa4SNico Weber     if (mutationListener)
1972992efa4SNico Weber       mutationListeners.push_back(mutationListener);
1982992efa4SNico Weber     ASTDeserializationListener* serializationListener =
1992992efa4SNico Weber         Consumers[i]->GetASTDeserializationListener();
2002992efa4SNico Weber     if (serializationListener)
2012992efa4SNico Weber       serializationListeners.push_back(serializationListener);
2022992efa4SNico Weber   }
2032992efa4SNico Weber   if (mutationListeners.size()) {
2042992efa4SNico Weber     MutationListener.reset(new MultiplexASTMutationListener(mutationListeners));
2052992efa4SNico Weber   }
2062992efa4SNico Weber   if (serializationListeners.size()) {
2072992efa4SNico Weber     DeserializationListener.reset(
2082992efa4SNico Weber         new MultiplexASTDeserializationListener(serializationListeners));
2092992efa4SNico Weber   }
2102992efa4SNico Weber }
2112992efa4SNico Weber 
2122992efa4SNico Weber MultiplexConsumer::~MultiplexConsumer() {
2132992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2142992efa4SNico Weber     delete Consumers[i];
2152992efa4SNico Weber }
2162992efa4SNico Weber 
2172992efa4SNico Weber void MultiplexConsumer::Initialize(ASTContext &Context) {
2182992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2192992efa4SNico Weber     Consumers[i]->Initialize(Context);
2202992efa4SNico Weber }
2212992efa4SNico Weber 
222841dd886SArgyrios Kyrtzidis bool MultiplexConsumer::HandleTopLevelDecl(DeclGroupRef D) {
223b11f5a4cSArgyrios Kyrtzidis   bool Continue = true;
2242992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
225b11f5a4cSArgyrios Kyrtzidis     Continue = Continue && Consumers[i]->HandleTopLevelDecl(D);
226b11f5a4cSArgyrios Kyrtzidis   return Continue;
2272992efa4SNico Weber }
2282992efa4SNico Weber 
229*a926d84cSHans Wennborg void MultiplexConsumer::HandleInlineMethodDefinition(CXXMethodDecl *D) {
230*a926d84cSHans Wennborg   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
231*a926d84cSHans Wennborg     Consumers[i]->HandleInlineMethodDefinition(D);
232*a926d84cSHans Wennborg }
233*a926d84cSHans Wennborg 
234df88f6feSRafael Espindola void  MultiplexConsumer::HandleCXXStaticMemberVarInstantiation(VarDecl *VD) {
235189fa748SRafael Espindola   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
236df88f6feSRafael Espindola     Consumers[i]->HandleCXXStaticMemberVarInstantiation(VD);
237189fa748SRafael Espindola }
238189fa748SRafael Espindola 
2392992efa4SNico Weber void MultiplexConsumer::HandleInterestingDecl(DeclGroupRef D) {
2402992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2412992efa4SNico Weber     Consumers[i]->HandleInterestingDecl(D);
2422992efa4SNico Weber }
2432992efa4SNico Weber 
2442992efa4SNico Weber void MultiplexConsumer::HandleTranslationUnit(ASTContext &Ctx) {
2452992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2462992efa4SNico Weber     Consumers[i]->HandleTranslationUnit(Ctx);
2472992efa4SNico Weber }
2482992efa4SNico Weber 
2492992efa4SNico Weber void MultiplexConsumer::HandleTagDeclDefinition(TagDecl *D) {
2502992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2512992efa4SNico Weber     Consumers[i]->HandleTagDeclDefinition(D);
2522992efa4SNico Weber }
2532992efa4SNico Weber 
254e5dc5b31SArgyrios Kyrtzidis void MultiplexConsumer::HandleCXXImplicitFunctionInstantiation(FunctionDecl *D){
255e5dc5b31SArgyrios Kyrtzidis   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
256e5dc5b31SArgyrios Kyrtzidis     Consumers[i]->HandleCXXImplicitFunctionInstantiation(D);
257e5dc5b31SArgyrios Kyrtzidis }
258e5dc5b31SArgyrios Kyrtzidis 
259b11f5a4cSArgyrios Kyrtzidis void MultiplexConsumer::HandleTopLevelDeclInObjCContainer(DeclGroupRef D) {
260b11f5a4cSArgyrios Kyrtzidis   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
261b11f5a4cSArgyrios Kyrtzidis     Consumers[i]->HandleTopLevelDeclInObjCContainer(D);
262b11f5a4cSArgyrios Kyrtzidis }
263b11f5a4cSArgyrios Kyrtzidis 
2642992efa4SNico Weber void MultiplexConsumer::CompleteTentativeDefinition(VarDecl *D) {
2652992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2662992efa4SNico Weber     Consumers[i]->CompleteTentativeDefinition(D);
2672992efa4SNico Weber }
2682992efa4SNico Weber 
2692992efa4SNico Weber void MultiplexConsumer::HandleVTable(
2702992efa4SNico Weber     CXXRecordDecl *RD, bool DefinitionRequired) {
2712992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2722992efa4SNico Weber     Consumers[i]->HandleVTable(RD, DefinitionRequired);
2732992efa4SNico Weber }
2742992efa4SNico Weber 
2752992efa4SNico Weber ASTMutationListener *MultiplexConsumer::GetASTMutationListener() {
2762992efa4SNico Weber   return MutationListener.get();
2772992efa4SNico Weber }
2782992efa4SNico Weber 
2792992efa4SNico Weber ASTDeserializationListener *MultiplexConsumer::GetASTDeserializationListener() {
2802992efa4SNico Weber   return DeserializationListener.get();
2812992efa4SNico Weber }
2822992efa4SNico Weber 
2832992efa4SNico Weber void MultiplexConsumer::PrintStats() {
2842992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2852992efa4SNico Weber     Consumers[i]->PrintStats();
2862992efa4SNico Weber }
2872992efa4SNico Weber 
2882992efa4SNico Weber void MultiplexConsumer::InitializeSema(Sema &S) {
2892992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2902992efa4SNico Weber     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumers[i]))
2912992efa4SNico Weber       SC->InitializeSema(S);
2922992efa4SNico Weber }
2932992efa4SNico Weber 
2942992efa4SNico Weber void MultiplexConsumer::ForgetSema() {
2952992efa4SNico Weber   for (size_t i = 0, e = Consumers.size(); i != e; ++i)
2962992efa4SNico Weber     if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumers[i]))
2972992efa4SNico Weber       SC->ForgetSema();
2982992efa4SNico Weber }
299