contrib/llvm/tools/clang/lib/Frontend/MultiplexConsumer.cpp

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