clang
10.0.0svn
|
Abstract interface for external sources of AST nodes. More...
#include "clang/AST/ExternalASTSource.h"
Classes | |
class | ASTSourceDescriptor |
Abstracts clang modules and precompiled header files and holds everything needed to generate debug info for an imported module or PCH. More... | |
class | Deserializing |
RAII class for safely pairing a StartedDeserializing call with FinishedDeserializing. More... | |
struct | MemoryBufferSizes |
Public Types | |
enum | ExtKind { EK_Always, EK_Never, EK_ReplyHazy } |
Public Member Functions | |
ExternalASTSource ()=default | |
virtual | ~ExternalASTSource () |
uint32_t | getGeneration () const |
Get the current generation of this AST source. More... | |
virtual Decl * | GetExternalDecl (uint32_t ID) |
Resolve a declaration ID into a declaration, potentially building a new declaration. More... | |
virtual Selector | GetExternalSelector (uint32_t ID) |
Resolve a selector ID into a selector. More... | |
virtual uint32_t | GetNumExternalSelectors () |
Returns the number of selectors known to the external AST source. More... | |
virtual Stmt * | GetExternalDeclStmt (uint64_t Offset) |
Resolve the offset of a statement in the decl stream into a statement. More... | |
virtual CXXCtorInitializer ** | GetExternalCXXCtorInitializers (uint64_t Offset) |
Resolve the offset of a set of C++ constructor initializers in the decl stream into an array of initializers. More... | |
virtual CXXBaseSpecifier * | GetExternalCXXBaseSpecifiers (uint64_t Offset) |
Resolve the offset of a set of C++ base specifiers in the decl stream into an array of specifiers. More... | |
virtual void | updateOutOfDateIdentifier (IdentifierInfo &II) |
Update an out-of-date identifier. More... | |
virtual bool | FindExternalVisibleDeclsByName (const DeclContext *DC, DeclarationName Name) |
Find all declarations with the given name in the given context, and add them to the context by calling SetExternalVisibleDeclsForName or SetNoExternalVisibleDeclsForName. More... | |
virtual void | completeVisibleDeclsMap (const DeclContext *DC) |
Ensures that the table of all visible declarations inside this context is up to date. More... | |
virtual Module * | getModule (unsigned ID) |
Retrieve the module that corresponds to the given module ID. More... | |
virtual bool | DeclIsFromPCHWithObjectFile (const Decl *D) |
Determine whether D comes from a PCH which was built with a corresponding object file. More... | |
virtual llvm::Optional< ASTSourceDescriptor > | getSourceDescriptor (unsigned ID) |
Return a descriptor for the corresponding module, if one exists. More... | |
virtual ExtKind | hasExternalDefinitions (const Decl *D) |
virtual void | FindExternalLexicalDecls (const DeclContext *DC, llvm::function_ref< bool(Decl::Kind)> IsKindWeWant, SmallVectorImpl< Decl *> &Result) |
Finds all declarations lexically contained within the given DeclContext, after applying an optional filter predicate. More... | |
void | FindExternalLexicalDecls (const DeclContext *DC, SmallVectorImpl< Decl *> &Result) |
Finds all declarations lexically contained within the given DeclContext. More... | |
virtual void | FindFileRegionDecls (FileID File, unsigned Offset, unsigned Length, SmallVectorImpl< Decl *> &Decls) |
Get the decls that are contained in a file in the Offset/Length range. More... | |
virtual void | CompleteRedeclChain (const Decl *D) |
Gives the external AST source an opportunity to complete the redeclaration chain for a declaration. More... | |
virtual void | CompleteType (TagDecl *Tag) |
Gives the external AST source an opportunity to complete an incomplete type. More... | |
virtual void | CompleteType (ObjCInterfaceDecl *Class) |
Gives the external AST source an opportunity to complete an incomplete Objective-C class. More... | |
virtual void | ReadComments () |
Loads comment ranges. More... | |
virtual void | StartedDeserializing () |
Notify ExternalASTSource that we started deserialization of a decl or type so until FinishedDeserializing is called there may be decls that are initializing. More... | |
virtual void | FinishedDeserializing () |
Notify ExternalASTSource that we finished the deserialization of a decl or type. More... | |
virtual void | StartTranslationUnit (ASTConsumer *Consumer) |
Function that will be invoked when we begin parsing a new translation unit involving this external AST source. More... | |
virtual void | PrintStats () |
Print any statistics that have been gathered regarding the external AST source. More... | |
virtual bool | layoutRecordType (const RecordDecl *Record, uint64_t &Size, uint64_t &Alignment, llvm::DenseMap< const FieldDecl *, uint64_t > &FieldOffsets, llvm::DenseMap< const CXXRecordDecl *, CharUnits > &BaseOffsets, llvm::DenseMap< const CXXRecordDecl *, CharUnits > &VirtualBaseOffsets) |
Perform layout on the given record. More... | |
MemoryBufferSizes | getMemoryBufferSizes () const |
Return the amount of memory used by memory buffers, breaking down by heap-backed versus mmap'ed memory. More... | |
virtual void | getMemoryBufferSizes (MemoryBufferSizes &sizes) const |
Protected Member Functions | |
uint32_t | incrementGeneration (ASTContext &C) |
Increment the current generation. More... | |
Static Protected Member Functions | |
static DeclContextLookupResult | SetExternalVisibleDeclsForName (const DeclContext *DC, DeclarationName Name, ArrayRef< NamedDecl *> Decls) |
static DeclContextLookupResult | SetNoExternalVisibleDeclsForName (const DeclContext *DC, DeclarationName Name) |
Friends | |
class | ExternalSemaSource |
Abstract interface for external sources of AST nodes.
External AST sources provide AST nodes constructed from some external source, such as a precompiled header. External AST sources can resolve types and declarations from abstract IDs into actual type and declaration nodes, and read parts of declaration contexts.
Definition at line 62 of file ExternalASTSource.h.
Enumerator | |
---|---|
EK_Always | |
EK_Never | |
EK_ReplyHazy |
Definition at line 197 of file ExternalASTSource.h.
|
default |
|
virtualdefault |
|
virtual |
Gives the external AST source an opportunity to complete the redeclaration chain for a declaration.
Called each time we need the most recent declaration of a declaration after the generation count is incremented.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 58 of file ExternalASTSource.cpp.
Referenced by FindExternalLexicalDecls(), and clang::ASTContext::getLangASForBuiltinAddressSpace().
|
virtual |
Gives the external AST source an opportunity to complete an incomplete type.
Reimplemented in clang::ExternalASTMerger, and clang::MultiplexExternalSemaSource.
Definition at line 60 of file ExternalASTSource.cpp.
Referenced by clang::ExternalASTMerger::CompleteType(), clang::ObjCInterfaceDecl::CreateDeserialized(), and FindExternalLexicalDecls().
|
virtual |
Gives the external AST source an opportunity to complete an incomplete Objective-C class.
This routine will only be invoked if the "externally completed" bit is set on the ObjCInterfaceDecl via the function ObjCInterfaceDecl::setExternallyCompleted()
.
Reimplemented in clang::ExternalASTMerger, and clang::MultiplexExternalSemaSource.
Definition at line 62 of file ExternalASTSource.cpp.
|
virtual |
Ensures that the table of all visible declarations inside this context is up to date.
The default implementation of this function is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 114 of file ExternalASTSource.cpp.
Referenced by clang::DeclContext::lookups().
Determine whether D comes from a PCH which was built with a corresponding object file.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 167 of file ExternalASTSource.h.
|
virtual |
Finds all declarations lexically contained within the given DeclContext, after applying an optional filter predicate.
IsKindWeWant | a predicate function that returns true if the passed declaration kind is one we are looking for. |
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, clang::ExternalASTMerger, and clang::MultiplexExternalSemaSource.
Definition at line 116 of file ExternalASTSource.cpp.
Referenced by clang::DeclContext::BuildDeclChain(), FindExternalLexicalDecls(), and clang::RecordDecl::isMsStruct().
|
inline |
Finds all declarations lexically contained within the given DeclContext.
Definition at line 215 of file ExternalASTSource.h.
References CompleteRedeclChain(), CompleteType(), FindExternalLexicalDecls(), FindFileRegionDecls(), FinishedDeserializing(), layoutRecordType(), PrintStats(), ReadComments(), clang::Result, StartedDeserializing(), and StartTranslationUnit().
|
virtual |
Find all declarations with the given name in the given context, and add them to the context by calling SetExternalVisibleDeclsForName or SetNoExternalVisibleDeclsForName.
true
if any declarations might have been found, false
if we definitely have no declarations with tbis name.The default implementation of this method is a no-op returning false
.
Reimplemented in clang::ASTReader, clang::ExternalASTMerger, and clang::MultiplexExternalSemaSource.
Definition at line 109 of file ExternalASTSource.cpp.
Referenced by updateOutOfDateIdentifier().
|
virtual |
Get the decls that are contained in a file in the Offset/Length range.
Length
can be 0 to indicate a point at Offset
instead of a range.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 54 of file ExternalASTSource.cpp.
Referenced by FindExternalLexicalDecls().
|
virtual |
Notify ExternalASTSource that we finished the deserialization of a decl or type.
Must be paired with StartedDeserializing.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 68 of file ExternalASTSource.cpp.
Referenced by FindExternalLexicalDecls(), and clang::ExternalASTSource::Deserializing::~Deserializing().
|
virtual |
Resolve the offset of a set of C++ base specifiers in the decl stream into an array of specifiers.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 104 of file ExternalASTSource.cpp.
Referenced by getGeneration().
|
virtual |
Resolve the offset of a set of C++ constructor initializers in the decl stream into an array of initializers.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 99 of file ExternalASTSource.cpp.
Referenced by getGeneration().
|
virtual |
Resolve a declaration ID into a declaration, potentially building a new declaration.
This method only needs to be implemented if the AST source ever passes back decl sets as VisibleDeclaration objects.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 82 of file ExternalASTSource.cpp.
Referenced by clang::AccessSpecDecl::CreateDeserialized(), getGeneration(), and makeStandaloneDiagnostic().
|
virtual |
Resolve the offset of a statement in the decl stream into a statement.
This operation is meant to be used via a LazyOffsetPtr. It only needs to be implemented if the AST source uses methods like FunctionDecl::setLazyBody when building decls.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 94 of file ExternalASTSource.cpp.
Referenced by getGeneration().
|
virtual |
Resolve a selector ID into a selector.
This operation only needs to be implemented if the AST source returns non-zero for GetNumKnownSelectors().
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 86 of file ExternalASTSource.cpp.
Referenced by AddClassMessageCompletions(), and getGeneration().
|
inline |
Get the current generation of this AST source.
This number is incremented each time the AST source lazily extends an existing entity.
Definition at line 96 of file ExternalASTSource.h.
References GetExternalCXXBaseSpecifiers(), GetExternalCXXCtorInitializers(), GetExternalDecl(), GetExternalDeclStmt(), GetExternalSelector(), GetNumExternalSelectors(), and Offset.
|
inline |
Return the amount of memory used by memory buffers, breaking down by heap-backed versus mmap'ed memory.
Definition at line 320 of file ExternalASTSource.h.
References clang::C, incrementGeneration(), SetExternalVisibleDeclsForName(), and SetNoExternalVisibleDeclsForName().
Referenced by clang::MultiplexExternalSemaSource::getMemoryBufferSizes(), and clang::MultiplexExternalSemaSource::layoutRecordType().
|
virtual |
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 120 of file ExternalASTSource.cpp.
|
inlinevirtual |
Retrieve the module that corresponds to the given module ID.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 163 of file ExternalASTSource.h.
Referenced by clang::Decl::operator new().
|
virtual |
Returns the number of selectors known to the external AST source.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 90 of file ExternalASTSource.cpp.
Referenced by AddClassMessageCompletions(), and getGeneration().
|
virtual |
Return a descriptor for the corresponding module, if one exists.
Reimplemented in clang::ASTReader.
Definition at line 30 of file ExternalASTSource.cpp.
References clang::None.
Referenced by clang::ExternalASTSource::ASTSourceDescriptor::getModuleOrNull().
|
virtual |
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 35 of file ExternalASTSource.cpp.
References EK_ReplyHazy.
Referenced by adjustGVALinkageForExternalDefinitionKind().
|
protected |
Increment the current generation.
Definition at line 122 of file ExternalASTSource.cpp.
References clang::ASTContext::getExternalSource(), and P.
Referenced by getMemoryBufferSizes().
|
virtual |
Perform layout on the given record.
This routine allows the external AST source to provide an specific layout for a record, overriding the layout that would normally be constructed. It is intended for clients who receive specific layout details rather than source code (such as LLDB). The client is expected to fill in the field offsets, base offsets, virtual base offsets, and complete object size.
Record | The record whose layout is being requested. |
Size | The final size of the record, in bits. |
Alignment | The final alignment of the record, in bits. |
FieldOffsets | The offset of each of the fields within the record, expressed in bits. All of the fields must be provided with offsets. |
BaseOffsets | The offset of each of the direct, non-virtual base classes. If any bases are not given offsets, the bases will be laid out according to the ABI. |
VirtualBaseOffsets | The offset of each of the virtual base classes (either direct or not). If any bases are not given offsets, the bases will be laid out according to the ABI. |
Reimplemented in clang::MultiplexExternalSemaSource, and clang::LayoutOverrideSource.
Definition at line 74 of file ExternalASTSource.cpp.
Referenced by FindExternalLexicalDecls().
|
virtual |
Print any statistics that have been gathered regarding the external AST source.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 72 of file ExternalASTSource.cpp.
Referenced by FindExternalLexicalDecls().
|
virtual |
Loads comment ranges.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 64 of file ExternalASTSource.cpp.
Referenced by FindExternalLexicalDecls().
|
staticprotected |
Definition at line 1338 of file DeclBase.cpp.
Referenced by clang::ExternalASTMerger::FindExternalVisibleDeclsByName(), and getMemoryBufferSizes().
|
staticprotected |
Definition at line 1323 of file DeclBase.cpp.
Referenced by getMemoryBufferSizes().
|
virtual |
Notify ExternalASTSource that we started deserialization of a decl or type so until FinishedDeserializing is called there may be decls that are initializing.
Must be paired with FinishedDeserializing.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 66 of file ExternalASTSource.cpp.
Referenced by clang::ExternalASTSource::Deserializing::Deserializing(), and FindExternalLexicalDecls().
|
virtual |
Function that will be invoked when we begin parsing a new translation unit involving this external AST source.
The default implementation of this method is a no-op.
Reimplemented in clang::ASTReader, and clang::MultiplexExternalSemaSource.
Definition at line 70 of file ExternalASTSource.cpp.
Referenced by FindExternalLexicalDecls().
|
inlinevirtual |
Update an out-of-date identifier.
Reimplemented in clang::ASTReader.
Definition at line 144 of file ExternalASTSource.h.
References FindExternalVisibleDeclsByName().
Referenced by clang::Decl::updateOutOfDate().
|
friend |
Definition at line 63 of file ExternalASTSource.h.