clang  8.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | List of all members
clang::ASTImporter Class Reference

Imports selected nodes from one AST context into another context, merging AST nodes where appropriate. More...

#include "clang/AST/ASTImporter.h"

Public Types

using NonEquivalentDeclSet = llvm::DenseSet< std::pair< Decl *, Decl * > >
 
using ImportedCXXBaseSpecifierMap = llvm::DenseMap< const CXXBaseSpecifier *, CXXBaseSpecifier * >
 

Public Member Functions

 ASTImporter (ASTContext &ToContext, FileManager &ToFileManager, ASTContext &FromContext, FileManager &FromFileManager, bool MinimalImport)
 Create a new AST importer. More...
 
virtual ~ASTImporter ()
 
bool isMinimalImport () const
 Whether the importer will perform a minimal import, creating to-be-completed forward declarations when possible. More...
 
template<typename ImportT >
LLVM_NODISCARD llvm::Error importInto (ImportT &To, const ImportT &From)
 Import the given object, returns the result. More...
 
QualType Import (QualType FromT)
 Import the given type from the "from" context into the "to" context. More...
 
TypeSourceInfoImport (TypeSourceInfo *FromTSI)
 Import the given type source information from the "from" context into the "to" context. More...
 
AttrImport (const Attr *FromAttr)
 Import the given attribute from the "from" context into the "to" context. More...
 
DeclImport (Decl *FromD)
 Import the given declaration from the "from" context into the "to" context. More...
 
DeclImport (const Decl *FromD)
 
DeclGetAlreadyImportedOrNull (Decl *FromD)
 Return the copy of the given declaration in the "to" context if it has already been imported from the "from" context. More...
 
llvm::Expected< DeclContext * > ImportContext (DeclContext *FromDC)
 Import the given declaration context from the "from" AST context into the "to" AST context. More...
 
ExprImport (Expr *FromE)
 Import the given expression from the "from" context into the "to" context. More...
 
StmtImport (Stmt *FromS)
 Import the given statement from the "from" context into the "to" context. More...
 
NestedNameSpecifierImport (NestedNameSpecifier *FromNNS)
 Import the given nested-name-specifier from the "from" context into the "to" context. More...
 
NestedNameSpecifierLoc Import (NestedNameSpecifierLoc FromNNS)
 Import the given nested-name-specifier from the "from" context into the "to" context. More...
 
TemplateName Import (TemplateName From)
 Import the goven template name from the "from" context into the "to" context. More...
 
SourceLocation Import (SourceLocation FromLoc)
 Import the given source location from the "from" context into the "to" context. More...
 
SourceRange Import (SourceRange FromRange)
 Import the given source range from the "from" context into the "to" context. More...
 
DeclarationName Import (DeclarationName FromName)
 Import the given declaration name from the "from" context into the "to" context. More...
 
IdentifierInfoImport (const IdentifierInfo *FromId)
 Import the given identifier from the "from" context into the "to" context. More...
 
Selector Import (Selector FromSel)
 Import the given Objective-C selector from the "from" context into the "to" context. More...
 
FileID Import (FileID)
 Import the given file ID from the "from" context into the "to" context. More...
 
CXXCtorInitializerImport (CXXCtorInitializer *FromInit)
 Import the given C++ constructor initializer from the "from" context into the "to" context. More...
 
CXXBaseSpecifierImport (const CXXBaseSpecifier *FromSpec)
 Import the given CXXBaseSpecifier from the "from" context into the "to" context. More...
 
LLVM_NODISCARD llvm::Error ImportDefinition_New (Decl *From)
 Import the definition of the given declaration, including all of the declarations it contains. More...
 
void ImportDefinition (Decl *From)
 
virtual DeclarationName HandleNameConflict (DeclarationName Name, DeclContext *DC, unsigned IDNS, NamedDecl **Decls, unsigned NumDecls)
 Cope with a name conflict when importing a declaration into the given context. More...
 
ASTContextgetToContext () const
 Retrieve the context that AST nodes are being imported into. More...
 
ASTContextgetFromContext () const
 Retrieve the context that AST nodes are being imported from. More...
 
FileManagergetToFileManager () const
 Retrieve the file manager that AST nodes are being imported into. More...
 
FileManagergetFromFileManager () const
 Retrieve the file manager that AST nodes are being imported from. More...
 
DiagnosticBuilder ToDiag (SourceLocation Loc, unsigned DiagID)
 Report a diagnostic in the "to" context. More...
 
DiagnosticBuilder FromDiag (SourceLocation Loc, unsigned DiagID)
 Report a diagnostic in the "from" context. More...
 
NonEquivalentDeclSetgetNonEquivalentDecls ()
 Return the set of declarations that we know are not equivalent. More...
 
virtual void CompleteDecl (Decl *D)
 Called for ObjCInterfaceDecl, ObjCProtocolDecl, and TagDecl. More...
 
virtual DeclImported (Decl *From, Decl *To)
 Subclasses can override this function to observe all of the From -> To declaration mappings as they are imported. More...
 
DeclMapImported (Decl *From, Decl *To)
 Store and assign the imported declaration to its counterpart. More...
 
virtual DeclGetOriginalDecl (Decl *To)
 Called by StructuralEquivalenceContext. More...
 
bool IsStructurallyEquivalent (QualType From, QualType To, bool Complain=true)
 Determine whether the given types are structurally equivalent. More...
 
template<>
LLVM_NODISCARD Error importInto (SourceLocation &To, const SourceLocation &From)
 
template<>
LLVM_NODISCARD Error importInto (QualType &To, const QualType &From)
 

Static Public Member Functions

static llvm::Optional< unsigned > getFieldIndex (Decl *F)
 Determine the index of a field in its parent record. More...
 

Detailed Description

Imports selected nodes from one AST context into another context, merging AST nodes where appropriate.

Definition at line 82 of file ASTImporter.h.

Member Typedef Documentation

◆ ImportedCXXBaseSpecifierMap

Definition at line 86 of file ASTImporter.h.

◆ NonEquivalentDeclSet

Definition at line 84 of file ASTImporter.h.

Constructor & Destructor Documentation

◆ ASTImporter()

ASTImporter::ASTImporter ( ASTContext ToContext,
FileManager ToFileManager,
ASTContext FromContext,
FileManager FromFileManager,
bool  MinimalImport 
)

Create a new AST importer.

Parameters
ToContextThe context we'll be importing into.
ToFileManagerThe file manager we'll be importing into.
FromContextThe context we'll be importing from.
FromFileManagerThe file manager we'll be importing into.
MinimalImportIf true, the importer will attempt to import as little as it can, e.g., by importing declarations as forward declarations that can be completed at a later point.

Definition at line 7647 of file ASTImporter.cpp.

References clang::ASTContext::getTranslationUnitDecl(), and ~ASTImporter().

◆ ~ASTImporter()

ASTImporter::~ASTImporter ( )
virtualdefault

Referenced by ASTImporter().

Member Function Documentation

◆ CompleteDecl()

void ASTImporter::CompleteDecl ( Decl D)
virtual

Called for ObjCInterfaceDecl, ObjCProtocolDecl, and TagDecl.

Mark the Decl as complete, filling it in as much as possible.

Parameters
DA declaration in the "to" context.

Definition at line 8358 of file ASTImporter.cpp.

Referenced by ImportContext().

◆ FromDiag()

DiagnosticBuilder ASTImporter::FromDiag ( SourceLocation  Loc,
unsigned  DiagID 
)

Report a diagnostic in the "from" context.

Definition at line 8350 of file ASTImporter.cpp.

References clang::ASTContext::getDiagnostics(), clang::DiagnosticsEngine::notePriorDiagnosticFrom(), and clang::DiagnosticsEngine::Report().

◆ GetAlreadyImportedOrNull()

Decl * ASTImporter::GetAlreadyImportedOrNull ( Decl FromD)

Return the copy of the given declaration in the "to" context if it has already been imported from the "from" context.

Otherwise return NULL.

Definition at line 7705 of file ASTImporter.cpp.

References clang::Error, and clang::ASTNodeImporter::ImportDefinitionIfNeeded().

Referenced by Import().

◆ getFieldIndex()

Optional< unsigned > clang::ASTImporter::getFieldIndex ( Decl F)
static

Determine the index of a field in its parent record.

F should be a field (or indirect field) declaration.

Returns
The index of the field in its parent context (starting from 0). On error None is returned (parent context is non-record).

Definition at line 135 of file ASTImporter.cpp.

References clang::Decl::getDeclContext(), and clang::None.

◆ getFromContext()

ASTContext& clang::ASTImporter::getFromContext ( ) const
inline

Retrieve the context that AST nodes are being imported from.

Definition at line 340 of file ASTImporter.h.

◆ getFromFileManager()

FileManager& clang::ASTImporter::getFromFileManager ( ) const
inline

Retrieve the file manager that AST nodes are being imported from.

Definition at line 346 of file ASTImporter.h.

◆ getNonEquivalentDecls()

NonEquivalentDeclSet& clang::ASTImporter::getNonEquivalentDecls ( )
inline

Return the set of declarations that we know are not equivalent.

Definition at line 355 of file ASTImporter.h.

◆ GetOriginalDecl()

virtual Decl* clang::ASTImporter::GetOriginalDecl ( Decl To)
inlinevirtual

Called by StructuralEquivalenceContext.

If a RecordDecl is being compared to another RecordDecl as part of import, completing the other RecordDecl may trigger importation of the first RecordDecl. This happens especially for anonymous structs. If the original of the second RecordDecl can be found, we can complete it without the need for importation, eliminating this loop.

Definition at line 376 of file ASTImporter.h.

References IsStructurallyEquivalent().

◆ getToContext()

ASTContext& clang::ASTImporter::getToContext ( ) const
inline

Retrieve the context that AST nodes are being imported into.

Definition at line 337 of file ASTImporter.h.

◆ getToFileManager()

FileManager& clang::ASTImporter::getToFileManager ( ) const
inline

Retrieve the file manager that AST nodes are being imported into.

Definition at line 343 of file ASTImporter.h.

◆ HandleNameConflict()

DeclarationName ASTImporter::HandleNameConflict ( DeclarationName  Name,
DeclContext DC,
unsigned  IDNS,
NamedDecl **  Decls,
unsigned  NumDecls 
)
virtual

Cope with a name conflict when importing a declaration into the given context.

This routine is invoked whenever there is a name conflict while importing a declaration. The returned name will become the name of the imported declaration. By default, the returned name is the same as the original name, leaving the conflict unresolve such that name lookup for this name is likely to find an ambiguity later.

Subclasses may override this routine to resolve the conflict, e.g., by renaming the declaration being imported.

Parameters
Namethe name of the declaration being imported, which conflicts with other declarations.
DCthe declaration context (in the "to" AST context) in which the name is being imported.
IDNSthe identifier namespace in which the name will be found.
Declsthe set of declarations with the same name as the declaration being imported.
NumDeclsthe number of conflicting declarations in Decls.
Returns
the name that the newly-imported declaration should have.

Definition at line 8334 of file ASTImporter.cpp.

◆ Import() [1/18]

QualType ASTImporter::Import ( QualType  FromT)

◆ Import() [2/18]

TypeSourceInfo * ASTImporter::Import ( TypeSourceInfo FromTSI)

Import the given type source information from the "from" context into the "to" context.

Returns
the equivalent type source information in the "to" context, or NULL if an error occurred.

Definition at line 7685 of file ASTImporter.cpp.

References clang::TypeLoc::getBeginLoc(), clang::ASTContext::getTrivialTypeSourceInfo(), clang::TypeSourceInfo::getType(), clang::TypeSourceInfo::getTypeLoc(), Import(), and clang::QualType::isNull().

◆ Import() [3/18]

Attr * ASTImporter::Import ( const Attr FromAttr)

Import the given attribute from the "from" context into the "to" context.

Returns
the equivalent attribute in the "to" context.

Definition at line 7699 of file ASTImporter.cpp.

References clang::Attr::clone(), clang::Attr::getRange(), Import(), and clang::Attr::setRange().

◆ Import() [4/18]

Decl * ASTImporter::Import ( Decl FromD)

Import the given declaration from the "from" context into the "to" context.

Returns
the equivalent declaration in the "to" context, or a NULL type if an error occurred.

Definition at line 7718 of file ASTImporter.cpp.

References GetAlreadyImportedOrNull(), Imported(), clang::updateFlags(), and clang::TypeVisitor< ImplClass, RetTy >::Visit().

◆ Import() [5/18]

Decl* clang::ASTImporter::Import ( const Decl FromD)
inline

Definition at line 194 of file ASTImporter.h.

References clang::Error.

◆ Import() [6/18]

Expr * ASTImporter::Import ( Expr FromE)

Import the given expression from the "from" context into the "to" context.

Returns
the equivalent expression in the "to" context, or NULL if an error occurred.

Definition at line 7806 of file ASTImporter.cpp.

References Import().

◆ Import() [7/18]

Stmt * ASTImporter::Import ( Stmt FromS)

Import the given statement from the "from" context into the "to" context.

Returns
the equivalent statement in the "to" context, or NULL if an error occurred.

Definition at line 7813 of file ASTImporter.cpp.

◆ Import() [8/18]

NestedNameSpecifier * ASTImporter::Import ( NestedNameSpecifier FromNNS)

◆ Import() [9/18]

NestedNameSpecifierLoc ASTImporter::Import ( NestedNameSpecifierLoc  FromNNS)

Import the given nested-name-specifier from the "from" context into the "to" context.

Returns
the equivalent nested-name-specifier in the "to" context.

Definition at line 7901 of file ASTImporter.cpp.

References clang::NestedNameSpecifierLoc::getPrefix().

◆ Import() [10/18]

TemplateName ASTImporter::Import ( TemplateName  From)

Import the goven template name from the "from" context into the "to" context.

Definition at line 7972 of file ASTImporter.cpp.

References clang::UnresolvedSetImpl::addDecl(), clang::UnresolvedSetImpl::begin(), clang::TemplateName::DependentTemplate, clang::UnresolvedSetImpl::end(), clang::SubstTemplateTemplateParmPackStorage::getArgumentPack(), clang::TemplateName::getAsDependentTemplateName(), clang::TemplateName::getAsOverloadedTemplate(), clang::TemplateName::getAsQualifiedTemplateName(), clang::TemplateName::getAsSubstTemplateTemplateParm(), clang::TemplateName::getAsSubstTemplateTemplateParmPack(), clang::TemplateName::getAsTemplateDecl(), clang::ASTContext::getDependentTemplateName(), clang::DependentTemplateName::getIdentifier(), clang::TemplateName::getKind(), clang::DependentTemplateName::getOperator(), clang::ASTContext::getOverloadedTemplateName(), clang::SubstTemplateTemplateParmStorage::getParameter(), clang::SubstTemplateTemplateParmPackStorage::getParameterPack(), clang::ASTContext::getQualifiedTemplateName(), clang::QualifiedTemplateName::getQualifier(), clang::DependentTemplateName::getQualifier(), clang::SubstTemplateTemplateParmStorage::getReplacement(), clang::ASTContext::getSubstTemplateTemplateParm(), clang::ASTContext::getSubstTemplateTemplateParmPack(), clang::QualifiedTemplateName::hasTemplateKeyword(), Import(), clang::ASTNodeImporter::ImportTemplateArgument(), clang::DependentTemplateName::isIdentifier(), clang::TemplateName::isNull(), clang::TemplateName::OverloadedTemplate, clang::TemplateName::QualifiedTemplate, clang::TemplateName::SubstTemplateTemplateParm, clang::TemplateName::SubstTemplateTemplateParmPack, and clang::TemplateName::Template.

◆ Import() [11/18]

SourceLocation ASTImporter::Import ( SourceLocation  FromLoc)

Import the given source location from the "from" context into the "to" context.

Returns
the equivalent source location in the "to" context, or an invalid source location if an error occurred.

Definition at line 8062 of file ASTImporter.cpp.

References clang::SourceManager::getComposedLoc(), clang::SourceManager::getDecomposedLoc(), clang::ASTContext::getSourceManager(), Import(), clang::FileID::isInvalid(), and clang::SourceLocation::isInvalid().

◆ Import() [12/18]

SourceRange ASTImporter::Import ( SourceRange  FromRange)

Import the given source range from the "from" context into the "to" context.

Returns
the equivalent source range in the "to" context, or an invalid source location if an error occurred.

Definition at line 8076 of file ASTImporter.cpp.

References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), and Import().

◆ Import() [13/18]

DeclarationName ASTImporter::Import ( DeclarationName  FromName)

Import the given declaration name from the "from" context into the "to" context.

Returns
the equivalent declaration name in the "to" context, or an empty declaration name if an error occurred.

Definition at line 8247 of file ASTImporter.cpp.

References clang::DeclarationName::CXXConstructorName, clang::DeclarationName::CXXConversionFunctionName, clang::DeclarationName::CXXDeductionGuideName, clang::DeclarationName::CXXDestructorName, clang::DeclarationName::CXXLiteralOperatorName, clang::DeclarationName::CXXOperatorName, clang::DeclarationName::CXXUsingDirective, clang::ASTContext::DeclarationNames, clang::DeclarationName::getAsIdentifierInfo(), clang::ASTContext::getCanonicalType(), clang::DeclarationNameTable::getCXXConstructorName(), clang::DeclarationNameTable::getCXXConversionFunctionName(), clang::DeclarationNameTable::getCXXDeductionGuideName(), clang::DeclarationName::getCXXDeductionGuideTemplate(), clang::DeclarationNameTable::getCXXDestructorName(), clang::DeclarationName::getCXXLiteralIdentifier(), clang::DeclarationNameTable::getCXXLiteralOperatorName(), clang::DeclarationName::getCXXNameType(), clang::DeclarationNameTable::getCXXOperatorName(), clang::DeclarationName::getCXXOverloadedOperator(), clang::DeclarationName::getNameKind(), clang::DeclarationName::getObjCSelector(), clang::DeclarationName::getUsingDirectiveName(), clang::DeclarationName::Identifier, Import(), clang::QualType::isNull(), clang::DeclarationName::ObjCMultiArgSelector, clang::DeclarationName::ObjCOneArgSelector, and clang::DeclarationName::ObjCZeroArgSelector.

◆ Import() [14/18]

IdentifierInfo * ASTImporter::Import ( const IdentifierInfo FromId)

Import the given identifier from the "from" context into the "to" context.

Returns
the equivalent identifier in the "to" context. Note: It returns nullptr only if the FromId was nullptr.

Definition at line 8311 of file ASTImporter.cpp.

References clang::IdentifierTable::get(), clang::IdentifierInfo::getBuiltinID(), clang::IdentifierInfo::getName(), clang::ASTContext::Idents, and clang::IdentifierInfo::setBuiltinID().

◆ Import() [15/18]

Selector ASTImporter::Import ( Selector  FromSel)

Import the given Objective-C selector from the "from" context into the "to" context.

Returns
the equivalent selector in the "to" context.

Definition at line 8323 of file ASTImporter.cpp.

References clang::Selector::getIdentifierInfoForSlot(), clang::Selector::getNumArgs(), clang::SelectorTable::getSelector(), Import(), clang::Selector::isNull(), and clang::ASTContext::Selectors.

◆ Import() [16/18]

FileID ASTImporter::Import ( FileID  FromID)

◆ Import() [17/18]

CXXCtorInitializer * ASTImporter::Import ( CXXCtorInitializer FromInit)

◆ Import() [18/18]

CXXBaseSpecifier * ASTImporter::Import ( const CXXBaseSpecifier FromSpec)

◆ ImportContext()

Expected< DeclContext * > ASTImporter::ImportContext ( DeclContext FromDC)

Import the given declaration context from the "from" AST context into the "to" AST context.

Returns
the equivalent declaration context in the "to" context, or error value.

Definition at line 7747 of file ASTImporter.cpp.

References CompleteDecl(), clang::Error, clang::ObjCInterfaceDecl::getDefinition(), clang::ObjCProtocolDecl::getDefinition(), clang::ASTNodeImporter::IDK_Basic, Import(), and clang::ASTNodeImporter::ImportDefinition().

◆ ImportDefinition()

void ASTImporter::ImportDefinition ( Decl From)

Definition at line 8242 of file ASTImporter.cpp.

References clang::Error, and ImportDefinition_New().

◆ ImportDefinition_New()

Error ASTImporter::ImportDefinition_New ( Decl From)

Import the definition of the given declaration, including all of the declarations it contains.

Definition at line 8197 of file ASTImporter.cpp.

References clang::ASTNodeImporter::IDK_Everything, Import(), clang::ASTNodeImporter::ImportDeclContext(), and clang::ASTNodeImporter::ImportDefinition().

Referenced by clang::ExternalASTMerger::CompleteType(), and ImportDefinition().

◆ Imported()

virtual Decl* clang::ASTImporter::Imported ( Decl From,
Decl To 
)
inlinevirtual

Subclasses can override this function to observe all of the From -> To declaration mappings as they are imported.

Definition at line 365 of file ASTImporter.h.

Referenced by Import().

◆ importInto() [1/3]

template<typename ImportT >
LLVM_NODISCARD llvm::Error clang::ASTImporter::importInto ( ImportT &  To,
const ImportT &  From 
)
inline

Import the given object, returns the result.

Parameters
ToImport the object into this variable.
FromObject to import.
Returns
Error information (success or error).

Definition at line 156 of file ASTImporter.h.

◆ importInto() [2/3]

template<>
LLVM_NODISCARD Error clang::ASTImporter::importInto ( SourceLocation To,
const SourceLocation From 
)

◆ importInto() [3/3]

template<>
LLVM_NODISCARD Error clang::ASTImporter::importInto ( QualType To,
const QualType From 
)

Definition at line 169 of file ASTImporter.cpp.

References clang::QualType::isNull().

◆ isMinimalImport()

bool clang::ASTImporter::isMinimalImport ( ) const
inline

Whether the importer will perform a minimal import, creating to-be-completed forward declarations when possible.

Definition at line 148 of file ASTImporter.h.

References clang::Minimal.

Referenced by getStructuralEquivalenceKind(), and clang::ASTNodeImporter::shouldForceImportDeclContext().

◆ IsStructurallyEquivalent()

bool ASTImporter::IsStructurallyEquivalent ( QualType  From,
QualType  To,
bool  Complain = true 
)

Determine whether the given types are structurally equivalent.

Definition at line 8388 of file ASTImporter.cpp.

References getStructuralEquivalenceKind(), clang::QualType::getTypePtr(), clang::ASTContext::hasSameType(), Import(), and clang::StructuralEquivalenceContext::IsEquivalent().

◆ MapImported()

Decl * ASTImporter::MapImported ( Decl From,
Decl To 
)

Store and assign the imported declaration to its counterpart.

Definition at line 8378 of file ASTImporter.cpp.

Referenced by clang::ExternalASTMerger::CompleteType().

◆ ToDiag()

DiagnosticBuilder ASTImporter::ToDiag ( SourceLocation  Loc,
unsigned  DiagID 
)

Report a diagnostic in the "to" context.

Definition at line 8342 of file ASTImporter.cpp.

References clang::ASTContext::getDiagnostics(), clang::DiagnosticsEngine::notePriorDiagnosticFrom(), and clang::DiagnosticsEngine::Report().


The documentation for this class was generated from the following files: