clang  9.0.0svn
MultiplexConsumer.h
Go to the documentation of this file.
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"
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.
30 public:
31  // Does NOT take ownership of the elements in L.
33  const std::vector<ASTDeserializationListener *> &L);
34  void ReaderInitialized(ASTReader *Reader) 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;
41  MacroDefinitionRecord *MD) override;
42  void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override;
43 
44 private:
45  std::vector<ASTDeserializationListener *> Listeners;
46 };
47 
48 // Has a list of ASTConsumers and calls each of them. Owns its children.
50 public:
51  // Takes ownership of the pointers in C.
52  MultiplexConsumer(std::vector<std::unique_ptr<ASTConsumer>> C);
53  ~MultiplexConsumer() override;
54 
55  // ASTConsumer
56  void Initialize(ASTContext &Context) override;
57  void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override;
58  bool HandleTopLevelDecl(DeclGroupRef D) override;
59  void HandleInlineFunctionDefinition(FunctionDecl *D) override;
60  void HandleInterestingDecl(DeclGroupRef D) override;
61  void HandleTranslationUnit(ASTContext &Ctx) override;
62  void HandleTagDeclDefinition(TagDecl *D) override;
63  void HandleTagDeclRequiredDefinition(const TagDecl *D) override;
64  void HandleCXXImplicitFunctionInstantiation(FunctionDecl *D) override;
65  void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override;
66  void HandleImplicitImportDecl(ImportDecl *D) override;
67  void CompleteTentativeDefinition(VarDecl *D) override;
68  void AssignInheritanceModel(CXXRecordDecl *RD) override;
69  void HandleVTable(CXXRecordDecl *RD) override;
70  ASTMutationListener *GetASTMutationListener() override;
71  ASTDeserializationListener *GetASTDeserializationListener() override;
72  void PrintStats() override;
73  bool shouldSkipFunctionBody(Decl *D) override;
74 
75  // SemaConsumer
76  void InitializeSema(Sema &S) override;
77  void ForgetSema() override;
78 
79 private:
80  std::vector<std::unique_ptr<ASTConsumer>> Consumers; // Owns these.
81  std::unique_ptr<MultiplexASTMutationListener> MutationListener;
82  std::unique_ptr<MultiplexASTDeserializationListener> DeserializationListener;
83 };
84 
85 } // end namespace clang
86 
87 #endif
Represents a function declaration or definition.
Definition: Decl.h:1748
Smart pointer class that efficiently represents Objective-C method names.
void SelectorRead(serialization::SelectorID iD, Selector Sel) override
A selector was read from the AST file.
A (possibly-)qualified type.
Definition: Type.h:643
void TypeRead(serialization::TypeIdx Idx, QualType T) override
A type was deserialized from the AST file.
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:88
void DeclRead(serialization::DeclID ID, const Decl *D) override
A decl was deserialized from the AST file.
Represents a variable declaration or definition.
Definition: Decl.h:812
void MacroDefinitionRead(serialization::PreprocessedEntityID, MacroDefinitionRecord *MD) override
A macro definition was read from the AST file.
One of these records is kept for each identifier that is lexed.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:154
Record the location of a macro definition.
uint32_t MacroID
An ID number that refers to a macro in an AST file.
Definition: ASTBitCodes.h:140
Describes a module or submodule.
Definition: Module.h:64
An abstract interface that should be implemented by clients that read ASTs and then require further s...
Definition: SemaConsumer.h:25
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
void ReaderInitialized(ASTReader *Reader) override
The ASTReader was initialized.
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:328
An abstract interface that should be implemented by listeners that want to be notified when an AST en...
void IdentifierRead(serialization::IdentID ID, IdentifierInfo *II) override
An identifier was deserialized from the AST file.
uint32_t SubmoduleID
An ID number that refers to a submodule in a module file.
Definition: ASTBitCodes.h:171
void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override
A module definition was read from the AST file.
Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:3090
uint32_t PreprocessedEntityID
An ID number that refers to an entity in the detailed preprocessing record.
Definition: ASTBitCodes.h:168
Describes a module import declaration, which makes the contents of the named module visible in the cu...
Definition: Decl.h:4182
uint32_t SelectorID
An ID number that refers to an ObjC selector in an AST file.
Definition: ASTBitCodes.h:153
Dataflow Directional Tag Classes.
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:354
uint32_t DeclID
An ID number that refers to a declaration in an AST file.
Definition: ASTBitCodes.h:68
Encapsulates the data about a macro definition (e.g.
Definition: MacroInfo.h:39
uint32_t IdentID
An ID number that refers to an identifier in an AST file.
Definition: ASTBitCodes.h:134
MultiplexASTDeserializationListener(const std::vector< ASTDeserializationListener *> &L)
Represents a C++ struct/union/class.
Definition: DeclCXX.h:300
void MacroRead(serialization::MacroID ID, MacroInfo *MI) override
A macro was read from the AST file.
A type index; the type ID with the qualifier bits removed.
Definition: ASTBitCodes.h:88