xref: /freebsd/contrib/llvm-project/clang/include/clang/Frontend/MultiplexConsumer.h (revision 55dfaeae8e9aa95f0b724d90ad2423ca1b623142)
1 //===-- MultiplexConsumer.h - AST Consumer for PCH Generation ---*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 //  This file declares the MultiplexConsumer class, which can be used to
10 //  multiplex ASTConsumer and SemaConsumer messages to many consumers.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_FRONTEND_MULTIPLEXCONSUMER_H
15 #define LLVM_CLANG_FRONTEND_MULTIPLEXCONSUMER_H
16 
17 #include "clang/Basic/LLVM.h"
18 #include "clang/Sema/SemaConsumer.h"
19 #include "clang/Serialization/ASTDeserializationListener.h"
20 #include <memory>
21 #include <vector>
22 
23 namespace clang {
24 
25 class MultiplexASTMutationListener;
26 
27 // This ASTDeserializationListener forwards its notifications to a set of
28 // child listeners.
29 class MultiplexASTDeserializationListener : public ASTDeserializationListener {
30 public:
31   // Does NOT take ownership of the elements in L.
32   MultiplexASTDeserializationListener(
33       const std::vector<ASTDeserializationListener *> &L);
34   void ReaderInitialized(ASTReader *Reader) override;
35   void IdentifierRead(serialization::IdentifierID ID, IdentifierInfo *II) override;
36   void MacroRead(serialization::MacroID ID, MacroInfo *MI) override;
37   void TypeRead(serialization::TypeIdx Idx, QualType T) override;
38   void DeclRead(GlobalDeclID ID, const Decl *D) override;
39   void PredefinedDeclBuilt(PredefinedDeclIDs ID, const Decl *D) override;
40   void SelectorRead(serialization::SelectorID iD, Selector Sel) override;
41   void MacroDefinitionRead(serialization::PreprocessedEntityID,
42                            MacroDefinitionRecord *MD) override;
43   void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override;
44   void ModuleImportRead(serialization::SubmoduleID ID,
45                         SourceLocation ImportLoc) override;
46 
47 private:
48   std::vector<ASTDeserializationListener *> Listeners;
49 };
50 
51 // Has a list of ASTConsumers and calls each of them. Owns its children.
52 class MultiplexConsumer : public SemaConsumer {
53 public:
54   // Takes ownership of the pointers in C.
55   MultiplexConsumer(std::vector<std::unique_ptr<ASTConsumer>> C);
56   ~MultiplexConsumer() override;
57 
58   // ASTConsumer
59   void Initialize(ASTContext &Context) override;
60   void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override;
61   bool HandleTopLevelDecl(DeclGroupRef D) override;
62   void HandleInlineFunctionDefinition(FunctionDecl *D) override;
63   void HandleInterestingDecl(DeclGroupRef D) override;
64   void HandleTranslationUnit(ASTContext &Ctx) override;
65   void HandleTagDeclDefinition(TagDecl *D) override;
66   void HandleTagDeclRequiredDefinition(const TagDecl *D) override;
67   void HandleCXXImplicitFunctionInstantiation(FunctionDecl *D) override;
68   void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override;
69   void HandleImplicitImportDecl(ImportDecl *D) override;
70   void CompleteTentativeDefinition(VarDecl *D) override;
71   void CompleteExternalDeclaration(DeclaratorDecl *D) override;
72   void AssignInheritanceModel(CXXRecordDecl *RD) override;
73   void HandleVTable(CXXRecordDecl *RD) override;
74   ASTMutationListener *GetASTMutationListener() override;
75   ASTDeserializationListener *GetASTDeserializationListener() override;
76   void PrintStats() override;
77   bool shouldSkipFunctionBody(Decl *D) override;
78 
79   // SemaConsumer
80   void InitializeSema(Sema &S) override;
81   void ForgetSema() override;
82 
83 private:
84   std::vector<std::unique_ptr<ASTConsumer>> Consumers; // Owns these.
85   std::unique_ptr<MultiplexASTMutationListener> MutationListener;
86   std::unique_ptr<MultiplexASTDeserializationListener> DeserializationListener;
87 };
88 
89 }  // end namespace clang
90 
91 #endif
92