clang  3.8.0
MultiplexConsumer.cpp
Go to the documentation of this file.
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 
18 #include "clang/AST/DeclGroup.h"
20 
21 using namespace clang;
22 
23 namespace clang {
24 
25 // This ASTDeserializationListener forwards its notifications to a set of
26 // child listeners.
29 public:
30  // Does NOT take ownership of the elements in L.
32  const std::vector<ASTDeserializationListener*>& L);
33  void ReaderInitialized(ASTReader *Reader) override;
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;
41  MacroDefinitionRecord *MD) override;
42  void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override;
43 
44 private:
45  std::vector<ASTDeserializationListener *> Listeners;
46 };
47 
49  const std::vector<ASTDeserializationListener*>& L)
50  : Listeners(L) {
51 }
52 
54  ASTReader *Reader) {
55  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
56  Listeners[i]->ReaderInitialized(Reader);
57 }
58 
61  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
62  Listeners[i]->IdentifierRead(ID, II);
63 }
64 
67  for (auto &Listener : Listeners)
68  Listener->MacroRead(ID, MI);
69 }
70 
73  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
74  Listeners[i]->TypeRead(Idx, T);
75 }
76 
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 
85  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
86  Listeners[i]->SelectorRead(ID, Sel);
87 }
88 
91  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
92  Listeners[i]->MacroDefinitionRead(ID, MD);
93 }
94 
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.
104 public:
105  // Does NOT take ownership of the elements in 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;
111  const ClassTemplateSpecializationDecl *D) override;
113  const VarTemplateSpecializationDecl *D) override;
115  const FunctionDecl *D) override;
116  void ResolvedExceptionSpec(const FunctionDecl *FD) override;
117  void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override;
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;
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 
138  : Listeners(L.begin(), L.end()) {
139 }
140 
142  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
143  Listeners[i]->CompletedTagDefinition(D);
144 }
145 
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 
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 }
159  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
160  Listeners[i]->AddedCXXTemplateSpecialization(TD, D);
161 }
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 }
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 }
173  const FunctionDecl *FD) {
174  for (auto &Listener : Listeners)
175  Listener->ResolvedExceptionSpec(FD);
176 }
178  QualType ReturnType) {
179  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
180  Listeners[i]->DeducedReturnType(FD, ReturnType);
181 }
183  const CXXDestructorDecl *DD, const FunctionDecl *Delete) {
184  for (auto *L : Listeners)
185  L->ResolvedOperatorDelete(DD, Delete);
186 }
188  const FunctionDecl *D) {
189  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
190  Listeners[i]->CompletedImplicitDefinition(D);
191 }
193  const VarDecl *D) {
194  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
195  Listeners[i]->StaticDataMemberInstantiated(D);
196 }
198  const ParmVarDecl *D) {
199  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
200  Listeners[i]->DefaultArgumentInstantiated(D);
201 }
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 }
209  const FunctionDecl *D) {
210  for (auto &Listener : Listeners)
211  Listener->FunctionDefinitionInstantiated(D);
212 }
214  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
215  Listeners[i]->DeclarationMarkedUsed(D);
216 }
218  const Decl *D) {
219  for (size_t i = 0, e = Listeners.size(); i != e; ++i)
220  Listeners[i]->DeclarationMarkedOpenMPThreadPrivate(D);
221 }
223  Module *M) {
224  for (auto *L : Listeners)
225  L->RedefinedHiddenDefinition(D, M);
226 }
227 
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 
262 
264  for (auto &Consumer : Consumers)
265  Consumer->Initialize(Context);
266 }
267 
269  bool Continue = true;
270  for (auto &Consumer : Consumers)
271  Continue = Continue && Consumer->HandleTopLevelDecl(D);
272  return Continue;
273 }
274 
276  for (auto &Consumer : Consumers)
277  Consumer->HandleInlineMethodDefinition(D);
278 }
279 
281  for (auto &Consumer : Consumers)
282  Consumer->HandleCXXStaticMemberVarInstantiation(VD);
283 }
284 
286  for (auto &Consumer : Consumers)
287  Consumer->HandleInterestingDecl(D);
288 }
289 
291  for (auto &Consumer : Consumers)
292  Consumer->HandleTranslationUnit(Ctx);
293 }
294 
296  for (auto &Consumer : Consumers)
297  Consumer->HandleTagDeclDefinition(D);
298 }
299 
301  for (auto &Consumer : Consumers)
302  Consumer->HandleTagDeclRequiredDefinition(D);
303 }
304 
306  for (auto &Consumer : Consumers)
307  Consumer->HandleCXXImplicitFunctionInstantiation(D);
308 }
309 
311  for (auto &Consumer : Consumers)
312  Consumer->HandleTopLevelDeclInObjCContainer(D);
313 }
314 
316  for (auto &Consumer : Consumers)
317  Consumer->HandleImplicitImportDecl(D);
318 }
319 
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 
336  for (auto &Consumer : Consumers)
337  Consumer->CompleteTentativeDefinition(D);
338 }
339 
341  for (auto &Consumer : Consumers)
342  Consumer->HandleVTable(RD);
343 }
344 
346  return MutationListener.get();
347 }
348 
350  return DeserializationListener.get();
351 }
352 
354  for (auto &Consumer : Consumers)
355  Consumer->PrintStats();
356 }
357 
359  for (auto &Consumer : Consumers)
360  if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
361  SC->InitializeSema(S);
362 }
363 
365  for (auto &Consumer : Consumers)
366  if (SemaConsumer *SC = dyn_cast<SemaConsumer>(Consumer.get()))
367  SC->ForgetSema();
368 }
void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) override
An implicit member was added after the definition was completed.
FunctionDecl - An instance of this class is created to represent a function declaration or definition...
Definition: Decl.h:1483
void DeclarationMarkedUsed(const Decl *D) override
A declaration is marked used which was not previously marked used.
ASTMutationListener * GetASTMutationListener() override
If the consumer is interested in entities getting modified after their initial creation, it should return a pointer to an ASTMutationListener here.
void CompletedImplicitDefinition(const FunctionDecl *D) override
An implicit member got a definition.
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.
void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override
Handle the specified top-level declaration that occurred inside and ObjC container.
A (possibly-)qualified type.
Definition: Type.h:575
void TypeRead(serialization::TypeIdx Idx, QualType T) override
A type was deserialized from the AST file.
void ResolvedOperatorDelete(const CXXDestructorDecl *DD, const FunctionDecl *Delete) override
A virtual destructor's operator delete has been resolved.
uint32_t IdentID
An ID number that refers to an identifier in an AST file.
Definition: ASTBitCodes.h:123
void ResolvedExceptionSpec(const FunctionDecl *FD) override
A function's exception specification has been evaluated or instantiated.
void HandleDependentLibrary(llvm::StringRef Lib) override
Handle a dependent library created by a pragma in the source.
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:77
void HandleVTable(CXXRecordDecl *RD) override
Callback involved at the end of a translation unit to notify the consumer that a vtable for the given...
uint32_t DeclID
An ID number that refers to a declaration in an AST file.
Definition: ASTBitCodes.h:63
Declaration of a variable template.
MultiplexASTDeserializationListener(const std::vector< ASTDeserializationListener * > &L)
void DeclRead(serialization::DeclID ID, const Decl *D) override
A decl was deserialized from the AST file.
VarDecl - An instance of this class is created to represent a variable declaration or definition...
Definition: Decl.h:699
Represents a variable template specialization, which refers to a variable template with a given set o...
MultiplexASTMutationListener(ArrayRef< ASTMutationListener * > L)
void MacroDefinitionRead(serialization::PreprocessedEntityID, MacroDefinitionRecord *MD) override
A macro definition was read from the AST file.
void CompleteTentativeDefinition(VarDecl *D) override
CompleteTentativeDefinition - Callback invoked at the end of a translation unit to notify the consume...
iterator begin() const
Definition: Type.h:4072
ParmVarDecl - Represents a parameter to a function.
Definition: Decl.h:1299
RecordDecl - Represents a struct/union/class.
Definition: Decl.h:3166
Represents a class template specialization, which refers to a class template with a given set of temp...
One of these records is kept for each identifier that is lexed.
class LLVM_ALIGNAS(8) DependentTemplateSpecializationType const IdentifierInfo * Name
Represents a template specialization type whose template cannot be resolved, e.g. ...
Definition: Type.h:4381
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:91
Record the location of a macro definition.
void StaticDataMemberInstantiated(const VarDecl *D) override
A static data member was implicitly instantiated.
void PrintStats() override
PrintStats - If desired, print any statistics.
void DeclarationMarkedOpenMPThreadPrivate(const Decl *D) override
A declaration is marked as OpenMP threadprivate which was not previously marked as threadprivate...
Describes a module or submodule.
Definition: Basic/Module.h:47
An abstract interface that should be implemented by clients that read ASTs and then require further s...
Definition: SemaConsumer.h:26
bool HandleTopLevelDecl(DeclGroupRef D) override
HandleTopLevelDecl - Handle the specified top-level declaration.
uint32_t SubmoduleID
An ID number that refers to a submodule in a module file.
Definition: ASTBitCodes.h:160
void AddedAttributeToRecord(const Attr *Attr, const RecordDecl *Record) override
An attribute was added to a RecordDecl.
void DefaultArgumentInstantiated(const ParmVarDecl *D) override
A default argument was instantiated.
iterator end() const
void HandleTagDeclRequiredDefinition(const TagDecl *D) override
This callback is invoked the first time each TagDecl is required to be complete.
Represents an ObjC class declaration.
Definition: DeclObjC.h:853
void ReaderInitialized(ASTReader *Reader) override
The ASTReader was initialized.
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:259
ASTContext * Context
ID
Defines the set of possible language-specific address spaces.
Definition: AddressSpaces.h:27
void Initialize(ASTContext &Context) override
Initialize - This is called to initialize the consumer, providing the ASTContext. ...
void AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) override
A template specialization (or partial one) was added to the template declaration. ...
void FunctionDefinitionInstantiated(const FunctionDecl *D) override
A function template's definition was instantiated.
Represents a C++ destructor within a class.
Definition: DeclCXX.h:2345
void HandleTagDeclDefinition(TagDecl *D) override
HandleTagDeclDefinition - This callback is invoked each time a TagDecl (e.g.
void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override
A function's return type has been deduced.
An abstract interface that should be implemented by listeners that want to be notified when an AST en...
void HandleInterestingDecl(DeclGroupRef D) override
HandleInterestingDecl - Handle the specified interesting declaration.
void HandleLinkerOptionPragma(llvm::StringRef Opts) override
Handle a pragma that appends to Linker Options.
void IdentifierRead(serialization::IdentID ID, IdentifierInfo *II) override
An identifier was deserialized from the AST file.
void CompletedTagDefinition(const TagDecl *D) override
A new TagDecl definition was completed.
void HandleCXXImplicitFunctionInstantiation(FunctionDecl *D) override
Invoked when a function is implicitly instantiated.
void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override
A module definition was read from the AST file.
void HandleDetectMismatch(llvm::StringRef Name, llvm::StringRef Value) override
Handle a pragma that emits a mismatch identifier and value to the object file for the linker to work ...
TagDecl - Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:2644
Represents a static or instance method of a struct/union/class.
Definition: DeclCXX.h:1701
ObjCCategoryDecl - Represents a category declaration.
Definition: DeclObjC.h:1931
void AddedVisibleDecl(const DeclContext *DC, const Decl *D) override
A new declaration with name has been added to a DeclContext.
uint32_t MacroID
An ID number that refers to a macro in an AST file.
Definition: ASTBitCodes.h:129
void HandleImplicitImportDecl(ImportDecl *D) override
Handle an ImportDecl that was implicitly created due to an inclusion directive.
void ForgetSema() override
Inform the semantic consumer that Sema is no longer available.
Describes a module import declaration, which makes the contents of the named module visible in the cu...
Definition: Decl.h:3658
void InitializeSema(Sema &S) override
Initialize the semantic consumer with the Sema instance being used to perform semantic analysis on th...
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1121
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:311
void HandleInlineMethodDefinition(CXXMethodDecl *D) override
This callback is invoked each time an inline method definition is completed.
Encapsulates the data about a macro definition (e.g.
Definition: MacroInfo.h:34
uint32_t PreprocessedEntityID
An ID number that refers to an entity in the detailed preprocessing record.
Definition: ASTBitCodes.h:157
Represents a C++ struct/union/class.
Definition: DeclCXX.h:285
uint32_t SelectorID
An ID number that refers to an ObjC selector in an AST file.
Definition: ASTBitCodes.h:142
void MacroRead(serialization::MacroID ID, MacroInfo *MI) override
A macro was read from the AST file.
Declaration of a class template.
void HandleTranslationUnit(ASTContext &Ctx) override
HandleTranslationUnit - This method is called when the ASTs for entire translation unit have been par...
ASTDeserializationListener * GetASTDeserializationListener() override
If the consumer is interested in entities being deserialized from AST files, it should return a point...
void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD, const ObjCInterfaceDecl *IFD) override
A new objc category class was added for an interface.
NamedDecl - This represents a decl with a name.
Definition: Decl.h:145
Declaration of a template function.
Definition: DeclTemplate.h:830
A type index; the type ID with the qualifier bits removed.
Definition: ASTBitCodes.h:83
Attr - This represents one attribute.
Definition: Attr.h:44
void HandleCXXStaticMemberVarInstantiation(VarDecl *VD) override
HandleCXXStaticMemberVarInstantiation - Tell the consumer that this.
void RedefinedHiddenDefinition(const NamedDecl *D, Module *M) override
A definition has been made visible by being redefined locally.