clang  6.0.0svn
ASTConsumer.h
Go to the documentation of this file.
1 //===--- ASTConsumer.h - Abstract interface for reading ASTs ----*- 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 ASTConsumer class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_AST_ASTCONSUMER_H
15 #define LLVM_CLANG_AST_ASTCONSUMER_H
16 
17 namespace clang {
18  class ASTContext;
19  class CXXMethodDecl;
20  class CXXRecordDecl;
21  class Decl;
22  class DeclGroupRef;
23  class ASTMutationListener;
24  class ASTDeserializationListener; // layering violation because void* is ugly
25  class SemaConsumer; // layering violation required for safe SemaConsumer
26  class TagDecl;
27  class VarDecl;
28  class FunctionDecl;
29  class ImportDecl;
30 
31 /// ASTConsumer - This is an abstract interface that should be implemented by
32 /// clients that read ASTs. This abstraction layer allows the client to be
33 /// independent of the AST producer (e.g. parser vs AST dump file reader, etc).
34 class ASTConsumer {
35  /// \brief Whether this AST consumer also requires information about
36  /// semantic analysis.
37  bool SemaConsumer;
38 
39  friend class SemaConsumer;
40 
41 public:
42  ASTConsumer() : SemaConsumer(false) { }
43 
44  virtual ~ASTConsumer() {}
45 
46  /// Initialize - This is called to initialize the consumer, providing the
47  /// ASTContext.
48  virtual void Initialize(ASTContext &Context) {}
49 
50  /// HandleTopLevelDecl - Handle the specified top-level declaration. This is
51  /// called by the parser to process every top-level Decl*.
52  ///
53  /// \returns true to continue parsing, or false to abort parsing.
54  virtual bool HandleTopLevelDecl(DeclGroupRef D);
55 
56  /// \brief This callback is invoked each time an inline (method or friend)
57  /// function definition in a class is completed.
59 
60  /// HandleInterestingDecl - Handle the specified interesting declaration. This
61  /// is called by the AST reader when deserializing things that might interest
62  /// the consumer. The default implementation forwards to HandleTopLevelDecl.
63  virtual void HandleInterestingDecl(DeclGroupRef D);
64 
65  /// HandleTranslationUnit - This method is called when the ASTs for entire
66  /// translation unit have been parsed.
67  virtual void HandleTranslationUnit(ASTContext &Ctx) {}
68 
69  /// HandleTagDeclDefinition - This callback is invoked each time a TagDecl
70  /// (e.g. struct, union, enum, class) is completed. This allows the client to
71  /// hack on the type, which can occur at any point in the file (because these
72  /// can be defined in declspecs).
73  virtual void HandleTagDeclDefinition(TagDecl *D) {}
74 
75  /// \brief This callback is invoked the first time each TagDecl is required to
76  /// be complete.
77  virtual void HandleTagDeclRequiredDefinition(const TagDecl *D) {}
78 
79  /// \brief Invoked when a function is implicitly instantiated.
80  /// Note that at this point point it does not have a body, its body is
81  /// instantiated at the end of the translation unit and passed to
82  /// HandleTopLevelDecl.
84 
85  /// \brief Handle the specified top-level declaration that occurred inside
86  /// and ObjC container.
87  /// The default implementation ignored them.
89 
90  /// \brief Handle an ImportDecl that was implicitly created due to an
91  /// inclusion directive.
92  /// The default implementation passes it to HandleTopLevelDecl.
93  virtual void HandleImplicitImportDecl(ImportDecl *D);
94 
95  /// CompleteTentativeDefinition - Callback invoked at the end of a translation
96  /// unit to notify the consumer that the given tentative definition should be
97  /// completed.
98  ///
99  /// The variable declaration itself will be a tentative
100  /// definition. If it had an incomplete array type, its type will
101  /// have already been changed to an array of size 1. However, the
102  /// declaration remains a tentative definition and has not been
103  /// modified by the introduction of an implicit zero initializer.
105 
106  /// \brief Callback invoked when an MSInheritanceAttr has been attached to a
107  /// CXXRecordDecl.
109 
110  /// HandleCXXStaticMemberVarInstantiation - Tell the consumer that this
111  // variable has been instantiated.
113 
114  /// \brief Callback involved at the end of a translation unit to
115  /// notify the consumer that a vtable for the given C++ class is
116  /// required.
117  ///
118  /// \param RD The class whose vtable was used.
119  virtual void HandleVTable(CXXRecordDecl *RD) {}
120 
121  /// \brief If the consumer is interested in entities getting modified after
122  /// their initial creation, it should return a pointer to
123  /// an ASTMutationListener here.
124  virtual ASTMutationListener *GetASTMutationListener() { return nullptr; }
125 
126  /// \brief If the consumer is interested in entities being deserialized from
127  /// AST files, it should return a pointer to a ASTDeserializationListener here
129  return nullptr;
130  }
131 
132  /// PrintStats - If desired, print any statistics.
133  virtual void PrintStats() {}
134 
135  /// \brief This callback is called for each function if the Parser was
136  /// initialized with \c SkipFunctionBodies set to \c true.
137  ///
138  /// \return \c true if the function's body should be skipped. The function
139  /// body may be parsed anyway if it is needed (for instance, if it contains
140  /// the code completion point or is constexpr).
141  virtual bool shouldSkipFunctionBody(Decl *D) { return true; }
142 };
143 
144 } // end namespace clang.
145 
146 #endif
FunctionDecl - An instance of this class is created to represent a function declaration or definition...
Definition: Decl.h:1698
virtual void HandleCXXStaticMemberVarInstantiation(VarDecl *D)
HandleCXXStaticMemberVarInstantiation - Tell the consumer that this.
Definition: ASTConsumer.h:112
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs...
Definition: ASTConsumer.h:34
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:86
The l-value was an access to a declared entity or something equivalently strong, like the address of ...
virtual void PrintStats()
PrintStats - If desired, print any statistics.
Definition: ASTConsumer.h:133
VarDecl - An instance of this class is created to represent a variable declaration or definition...
Definition: Decl.h:807
virtual void HandleInlineFunctionDefinition(FunctionDecl *D)
This callback is invoked each time an inline (method or friend) function definition in a class is com...
Definition: ASTConsumer.h:58
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:149
virtual void HandleTagDeclRequiredDefinition(const TagDecl *D)
This callback is invoked the first time each TagDecl is required to be complete.
Definition: ASTConsumer.h:77
An abstract interface that should be implemented by clients that read ASTs and then require further s...
Definition: SemaConsumer.h:26
virtual void HandleInterestingDecl(DeclGroupRef D)
HandleInterestingDecl - Handle the specified interesting declaration.
Definition: ASTConsumer.cpp:23
virtual void HandleVTable(CXXRecordDecl *RD)
Callback involved at the end of a translation unit to notify the consumer that a vtable for the given...
Definition: ASTConsumer.h:119
virtual ASTMutationListener * GetASTMutationListener()
If the consumer is interested in entities getting modified after their initial creation, it should return a pointer to an ASTMutationListener here.
Definition: ASTConsumer.h:124
virtual ~ASTConsumer()
Definition: ASTConsumer.h:44
An abstract interface that should be implemented by listeners that want to be notified when an AST en...
virtual void AssignInheritanceModel(CXXRecordDecl *RD)
Callback invoked when an MSInheritanceAttr has been attached to a CXXRecordDecl.
Definition: ASTConsumer.h:108
virtual void HandleTranslationUnit(ASTContext &Ctx)
HandleTranslationUnit - This method is called when the ASTs for entire translation unit have been par...
Definition: ASTConsumer.h:67
#define false
Definition: stdbool.h:33
TagDecl - Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:2938
virtual ASTDeserializationListener * GetASTDeserializationListener()
If the consumer is interested in entities being deserialized from AST files, it should return a point...
Definition: ASTConsumer.h:128
Describes a module import declaration, which makes the contents of the named module visible in the cu...
Definition: Decl.h:3965
Dataflow Directional Tag Classes.
virtual void HandleImplicitImportDecl(ImportDecl *D)
Handle an ImportDecl that was implicitly created due to an inclusion directive.
Definition: ASTConsumer.cpp:29
virtual void HandleCXXImplicitFunctionInstantiation(FunctionDecl *D)
Invoked when a function is implicitly instantiated.
Definition: ASTConsumer.h:83
virtual void HandleTopLevelDeclInObjCContainer(DeclGroupRef D)
Handle the specified top-level declaration that occurred inside and ObjC container.
Definition: ASTConsumer.cpp:27
virtual void Initialize(ASTContext &Context)
Initialize - This is called to initialize the consumer, providing the ASTContext. ...
Definition: ASTConsumer.h:48
Represents a C++ struct/union/class.
Definition: DeclCXX.h:299
virtual bool shouldSkipFunctionBody(Decl *D)
This callback is called for each function if the Parser was initialized with SkipFunctionBodies set t...
Definition: ASTConsumer.h:141
virtual bool HandleTopLevelDecl(DeclGroupRef D)
HandleTopLevelDecl - Handle the specified top-level declaration.
Definition: ASTConsumer.cpp:19
virtual void CompleteTentativeDefinition(VarDecl *D)
CompleteTentativeDefinition - Callback invoked at the end of a translation unit to notify the consume...
Definition: ASTConsumer.h:104
virtual void HandleTagDeclDefinition(TagDecl *D)
HandleTagDeclDefinition - This callback is invoked each time a TagDecl (e.g.
Definition: ASTConsumer.h:73