clang 19.0.0git
MultiplexConsumer.cpp
Go to the documentation of this file.
1//===- MultiplexConsumer.cpp - 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 defines the MultiplexConsumer class. It also declares and defines
10// MultiplexASTDeserializationListener and MultiplexASTMutationListener, which
11// are implementation details of MultiplexConsumer.
12//
13//===----------------------------------------------------------------------===//
14
17#include "clang/AST/DeclGroup.h"
18
19using namespace clang;
20
21namespace clang {
22
24 const std::vector<ASTDeserializationListener*>& L)
25 : Listeners(L) {
26}
27
29 ASTReader *Reader) {
30 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
31 Listeners[i]->ReaderInitialized(Reader);
32}
33
36 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
37 Listeners[i]->IdentifierRead(ID, II);
38}
39
42 for (auto &Listener : Listeners)
43 Listener->MacroRead(ID, MI);
44}
45
48 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
49 Listeners[i]->TypeRead(Idx, T);
50}
51
53 serialization::DeclID ID, const Decl *D) {
54 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
55 Listeners[i]->DeclRead(ID, D);
56}
57
60 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
61 Listeners[i]->SelectorRead(ID, Sel);
62}
63
66 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
67 Listeners[i]->MacroDefinitionRead(ID, MD);
68}
69
72 for (auto &Listener : Listeners)
73 Listener->ModuleRead(ID, Mod);
74}
75
78 for (auto &Listener : Listeners)
79 Listener->ModuleImportRead(ID, ImportLoc);
80}
81
82// This ASTMutationListener forwards its notifications to a set of
83// child listeners.
85public:
86 // Does NOT take ownership of the elements in L.
88 void CompletedTagDefinition(const TagDecl *D) override;
89 void AddedVisibleDecl(const DeclContext *DC, const Decl *D) override;
90 void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) override;
92 const ClassTemplateSpecializationDecl *D) override;
94 const VarTemplateSpecializationDecl *D) override;
96 const FunctionDecl *D) override;
97 void ResolvedExceptionSpec(const FunctionDecl *FD) override;
98 void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override;
100 const FunctionDecl *Delete,
101 Expr *ThisArg) override;
102 void CompletedImplicitDefinition(const FunctionDecl *D) override;
103 void InstantiationRequested(const ValueDecl *D) override;
104 void VariableDefinitionInstantiated(const VarDecl *D) override;
105 void FunctionDefinitionInstantiated(const FunctionDecl *D) override;
106 void DefaultArgumentInstantiated(const ParmVarDecl *D) override;
107 void DefaultMemberInitializerInstantiated(const FieldDecl *D) override;
109 const ObjCInterfaceDecl *IFD) override;
110 void DeclarationMarkedUsed(const Decl *D) override;
111 void DeclarationMarkedOpenMPThreadPrivate(const Decl *D) override;
112 void DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) override;
114 const Attr *Attr) override;
115 void RedefinedHiddenDefinition(const NamedDecl *D, Module *M) override;
116 void AddedAttributeToRecord(const Attr *Attr,
117 const RecordDecl *Record) override;
118
119private:
120 std::vector<ASTMutationListener*> Listeners;
121};
122
125 : Listeners(L.begin(), L.end()) {
126}
127
129 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
130 Listeners[i]->CompletedTagDefinition(D);
131}
132
134 const DeclContext *DC, const Decl *D) {
135 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
136 Listeners[i]->AddedVisibleDecl(DC, D);
137}
138
140 const CXXRecordDecl *RD, const Decl *D) {
141 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
142 Listeners[i]->AddedCXXImplicitMember(RD, D);
143}
146 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
147 Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
148}
151 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
152 Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
153}
155 const FunctionTemplateDecl *TD, const FunctionDecl *D) {
156 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
157 Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
158}
160 const FunctionDecl *FD) {
161 for (auto &Listener : Listeners)
162 Listener->ResolvedExceptionSpec(FD);
163}
165 QualType ReturnType) {
166 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
167 Listeners[i]->DeducedReturnType(FD, ReturnType);
168}
170 const CXXDestructorDecl *DD, const FunctionDecl *Delete, Expr *ThisArg) {
171 for (auto *L : Listeners)
172 L->ResolvedOperatorDelete(DD, Delete, ThisArg);
173}
175 const FunctionDecl *D) {
176 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
177 Listeners[i]->CompletedImplicitDefinition(D);
178}
180 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
181 Listeners[i]->InstantiationRequested(D);
182}
184 const VarDecl *D) {
185 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
186 Listeners[i]->VariableDefinitionInstantiated(D);
187}
189 const FunctionDecl *D) {
190 for (auto &Listener : Listeners)
191 Listener->FunctionDefinitionInstantiated(D);
192}
194 const ParmVarDecl *D) {
195 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
196 Listeners[i]->DefaultArgumentInstantiated(D);
197}
199 const FieldDecl *D) {
200 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
201 Listeners[i]->DefaultMemberInitializerInstantiated(D);
202}
204 const ObjCCategoryDecl *CatD,
205 const ObjCInterfaceDecl *IFD) {
206 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
207 Listeners[i]->AddedObjCCategoryToInterface(CatD, IFD);
208}
210 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
211 Listeners[i]->DeclarationMarkedUsed(D);
212}
214 const Decl *D) {
215 for (size_t i = 0, e = Listeners.size(); i != e; ++i)
216 Listeners[i]->DeclarationMarkedOpenMPThreadPrivate(D);
217}
219 const Decl *D, const Attr *A) {
220 for (ASTMutationListener *L : Listeners)
221 L->DeclarationMarkedOpenMPAllocate(D, A);
222}
224 const Decl *D, const Attr *Attr) {
225 for (auto *L : Listeners)
226 L->DeclarationMarkedOpenMPDeclareTarget(D, Attr);
227}
229 Module *M) {
230 for (auto *L : Listeners)
231 L->RedefinedHiddenDefinition(D, M);
232}
233
235 const Attr *Attr,
236 const RecordDecl *Record) {
237 for (auto *L : Listeners)
238 L->AddedAttributeToRecord(Attr, Record);
239}
240
241} // end namespace clang
242
244 std::vector<std::unique_ptr<ASTConsumer>> C)
245 : Consumers(std::move(C)) {
246 // Collect the mutation listeners and deserialization listeners of all
247 // children, and create a multiplex listener each if so.
248 std::vector<ASTMutationListener *> mutationListeners;
249 std::vector<ASTDeserializationListener*> serializationListeners;
250 for (auto &Consumer : Consumers) {
251 if (auto *mutationListener = Consumer->GetASTMutationListener())
252 mutationListeners.push_back(mutationListener);
253 if (auto *serializationListener = Consumer->GetASTDeserializationListener())
254 serializationListeners.push_back(serializationListener);
255 }
256 if (!mutationListeners.empty()) {
257 MutationListener =
258 std::make_unique<MultiplexASTMutationListener>(mutationListeners);
259 }
260 if (!serializationListeners.empty()) {
261 DeserializationListener =
262 std::make_unique<MultiplexASTDeserializationListener>(
263 serializationListeners);
264 }
265}
266
268
270 for (auto &Consumer : Consumers)
271 Consumer->Initialize(Context);
272}
273
275 bool Continue = true;
276 for (auto &Consumer : Consumers)
277 Continue = Continue && Consumer->HandleTopLevelDecl(D);
278 return Continue;
279}
280
282 for (auto &Consumer : Consumers)
283 Consumer->HandleInlineFunctionDefinition(D);
284}
285
287 for (auto &Consumer : Consumers)
288 Consumer->HandleCXXStaticMemberVarInstantiation(VD);
289}
290
292 for (auto &Consumer : Consumers)
293 Consumer->HandleInterestingDecl(D);
294}
295
297 for (auto &Consumer : Consumers)
298 Consumer->HandleTranslationUnit(Ctx);
299}
300
302 for (auto &Consumer : Consumers)
303 Consumer->HandleTagDeclDefinition(D);
304}
305
307 for (auto &Consumer : Consumers)
308 Consumer->HandleTagDeclRequiredDefinition(D);
309}
310
312 for (auto &Consumer : Consumers)
313 Consumer->HandleCXXImplicitFunctionInstantiation(D);
314}
315
317 for (auto &Consumer : Consumers)
318 Consumer->HandleTopLevelDeclInObjCContainer(D);
319}
320
322 for (auto &Consumer : Consumers)
323 Consumer->HandleImplicitImportDecl(D);
324}
325
327 for (auto &Consumer : Consumers)
328 Consumer->CompleteTentativeDefinition(D);
329}
330
332 for (auto &Consumer : Consumers)
333 Consumer->CompleteExternalDeclaration(D);
334}
335
337 for (auto &Consumer : Consumers)
338 Consumer->AssignInheritanceModel(RD);
339}
340
342 for (auto &Consumer : Consumers)
343 Consumer->HandleVTable(RD);
344}
345
347 return MutationListener.get();
348}
349
351 return DeserializationListener.get();
352}
353
355 for (auto &Consumer : Consumers)
356 Consumer->PrintStats();
357}
358
360 bool Skip = true;
361 for (auto &Consumer : Consumers)
362 Skip = Skip && Consumer->shouldSkipFunctionBody(D);
363 return Skip;
364}
365
367 for (auto &Consumer : Consumers)
368 if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
369 SC->InitializeSema(S);
370}
371
373 for (auto &Consumer : Consumers)
374 if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
375 SC->ForgetSema();
376}
llvm::MachO::Record Record
Definition: MachO.h:30
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:182
An abstract interface that should be implemented by listeners that want to be notified when an AST en...
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:366
Attr - This represents one attribute.
Definition: Attr.h:42
Represents a C++ destructor within a class.
Definition: DeclCXX.h:2796
Represents a C++ struct/union/class.
Definition: DeclCXX.h:258
Declaration of a class template.
Represents a class template specialization, which refers to a class template with a given set of temp...
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1435
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:85
This represents one expression.
Definition: Expr.h:110
Represents a member of a struct/union/class.
Definition: Decl.h:3058
Represents a function declaration or definition.
Definition: Decl.h:1971
Declaration of a template function.
Definition: DeclTemplate.h:958
One of these records is kept for each identifier that is lexed.
Describes a module import declaration, which makes the contents of the named module visible in the cu...
Definition: Decl.h:4800
Record the location of a macro definition.
Encapsulates the data about a macro definition (e.g.
Definition: MacroInfo.h:39
Describes a module or submodule.
Definition: Module.h:105
void MacroDefinitionRead(serialization::PreprocessedEntityID, MacroDefinitionRecord *MD) override
A macro definition was read from the AST file.
void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override
A module definition was read from the AST file.
void TypeRead(serialization::TypeIdx Idx, QualType T) override
A type was deserialized from the AST file.
void DeclRead(serialization::DeclID ID, const Decl *D) override
A decl was deserialized from the AST file.
void IdentifierRead(serialization::IdentID ID, IdentifierInfo *II) override
An identifier was deserialized from the AST file.
void SelectorRead(serialization::SelectorID iD, Selector Sel) override
A selector was read from the AST file.
void MacroRead(serialization::MacroID ID, MacroInfo *MI) override
A macro was read from the AST file.
void ReaderInitialized(ASTReader *Reader) override
The ASTReader was initialized.
void ModuleImportRead(serialization::SubmoduleID ID, SourceLocation ImportLoc) override
A module import was read from the AST file.
MultiplexASTDeserializationListener(const std::vector< ASTDeserializationListener * > &L)
void DeclarationMarkedUsed(const Decl *D) override
A declaration is marked used which was not previously marked used.
void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD, const ObjCInterfaceDecl *IFD) override
A new objc category class was added for an interface.
void RedefinedHiddenDefinition(const NamedDecl *D, Module *M) override
A definition has been made visible by being redefined locally.
void ResolvedExceptionSpec(const FunctionDecl *FD) override
A function's exception specification has been evaluated or instantiated.
void DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) override
A declaration is marked as a variable with OpenMP allocator.
void CompletedImplicitDefinition(const FunctionDecl *D) override
An implicit member got a definition.
void DefaultArgumentInstantiated(const ParmVarDecl *D) override
A default argument was instantiated.
void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override
A function's return type has been deduced.
void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) override
An implicit member was added after the definition was completed.
void VariableDefinitionInstantiated(const VarDecl *D) override
A templated variable's definition was implicitly instantiated.
void DeclarationMarkedOpenMPThreadPrivate(const Decl *D) override
A declaration is marked as OpenMP threadprivate which was not previously marked as threadprivate.
MultiplexASTMutationListener(ArrayRef< ASTMutationListener * > L)
void ResolvedOperatorDelete(const CXXDestructorDecl *DD, const FunctionDecl *Delete, Expr *ThisArg) override
A virtual destructor's operator delete has been resolved.
void InstantiationRequested(const ValueDecl *D) override
The instantiation of a templated function or variable was requested.
void DeclarationMarkedOpenMPDeclareTarget(const Decl *D, const Attr *Attr) override
A declaration is marked as OpenMP declaretarget which was not previously marked as declaretarget.
void AddedVisibleDecl(const DeclContext *DC, const Decl *D) override
A new declaration with name has been added to a DeclContext.
void FunctionDefinitionInstantiated(const FunctionDecl *D) override
A function template's definition was instantiated.
void AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) override
A template specialization (or partial one) was added to the template declaration.
void DefaultMemberInitializerInstantiated(const FieldDecl *D) override
A default member initializer was instantiated.
void CompletedTagDefinition(const TagDecl *D) override
A new TagDecl definition was completed.
void AddedAttributeToRecord(const Attr *Attr, const RecordDecl *Record) override
An attribute was added to a RecordDecl.
void HandleImplicitImportDecl(ImportDecl *D) override
Handle an ImportDecl that was implicitly created due to an inclusion directive.
ASTDeserializationListener * GetASTDeserializationListener() override
If the consumer is interested in entities being deserialized from AST files, it should return a point...
void HandleCXXImplicitFunctionInstantiation(FunctionDecl *D) override
Invoked when a function is implicitly instantiated.
bool HandleTopLevelDecl(DeclGroupRef D) override
HandleTopLevelDecl - Handle the specified top-level declaration.
void HandleTagDeclRequiredDefinition(const TagDecl *D) override
This callback is invoked the first time each TagDecl is required to be complete.
void AssignInheritanceModel(CXXRecordDecl *RD) override
Callback invoked when an MSInheritanceAttr has been attached to a CXXRecordDecl.
void HandleTagDeclDefinition(TagDecl *D) override
HandleTagDeclDefinition - This callback is invoked each time a TagDecl (e.g.
void InitializeSema(Sema &S) override
Initialize the semantic consumer with the Sema instance being used to perform semantic analysis on th...
void HandleTranslationUnit(ASTContext &Ctx) override
HandleTranslationUnit - This method is called when the ASTs for entire translation unit have been par...
void CompleteTentativeDefinition(VarDecl *D) override
CompleteTentativeDefinition - Callback invoked at the end of a translation unit to notify the consume...
void HandleInterestingDecl(DeclGroupRef D) override
HandleInterestingDecl - Handle the specified interesting declaration.
void CompleteExternalDeclaration(VarDecl *D) override
CompleteExternalDeclaration - Callback invoked at the end of a translation unit to notify the consume...
void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override
HandleCXXStaticMemberVarInstantiation - Tell the consumer that this.
void HandleVTable(CXXRecordDecl *RD) override
Callback involved at the end of a translation unit to notify the consumer that a vtable for the given...
bool shouldSkipFunctionBody(Decl *D) override
This callback is called for each function if the Parser was initialized with SkipFunctionBodies set t...
ASTMutationListener * GetASTMutationListener() override
If the consumer is interested in entities getting modified after their initial creation,...
void PrintStats() override
PrintStats - If desired, print any statistics.
void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override
Handle the specified top-level declaration that occurred inside and ObjC container.
void ForgetSema() override
Inform the semantic consumer that Sema is no longer available.
MultiplexConsumer(std::vector< std::unique_ptr< ASTConsumer > > C)
void HandleInlineFunctionDefinition(FunctionDecl *D) override
This callback is invoked each time an inline (method or friend) function definition in a class is com...
void Initialize(ASTContext &Context) override
Initialize - This is called to initialize the consumer, providing the ASTContext.
This represents a decl that may have a name.
Definition: Decl.h:249
ObjCCategoryDecl - Represents a category declaration.
Definition: DeclObjC.h:2323
Represents an ObjC class declaration.
Definition: DeclObjC.h:1152
Represents a parameter to a function.
Definition: Decl.h:1761
A (possibly-)qualified type.
Definition: Type.h:738
Represents a struct/union/class.
Definition: Decl.h:4169
Smart pointer class that efficiently represents Objective-C method names.
An abstract interface that should be implemented by clients that read ASTs and then require further s...
Definition: SemaConsumer.h:25
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:434
Encodes a location in the source.
Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:3585
Represent the declaration of a variable (in which case it is an lvalue) a function (in which case it ...
Definition: Decl.h:706
Represents a variable declaration or definition.
Definition: Decl.h:918
Declaration of a variable template.
Represents a variable template specialization, which refers to a variable template with a given set o...
A type index; the type ID with the qualifier bits removed.
Definition: ASTBitCodes.h:88
uint32_t SubmoduleID
An ID number that refers to a submodule in a module file.
Definition: ASTBitCodes.h:171
uint32_t SelectorID
An ID number that refers to an ObjC selector in an AST file.
Definition: ASTBitCodes.h:153
uint32_t PreprocessedEntityID
An ID number that refers to an entity in the detailed preprocessing record.
Definition: ASTBitCodes.h:168
uint32_t IdentID
An ID number that refers to an identifier in an AST file.
Definition: ASTBitCodes.h:134
uint32_t DeclID
An ID number that refers to a declaration in an AST file.
Definition: ASTBitCodes.h:68
uint32_t MacroID
An ID number that refers to a macro in an AST file.
Definition: ASTBitCodes.h:140
The JSON file list parser is used to communicate input to InstallAPI.
@ Delete
'delete' clause, allowed on the 'exit data' construct.
const FunctionProtoType * T
Definition: Format.h:5394