clang  9.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | 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, ASTImporterLookupTable *LookupTable=nullptr)
 
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...
 
llvm::Expected< QualTypeImport (QualType FromT)
 Import the given type from the "from" context into the "to" context. More...
 
llvm::Expected< TypeSourceInfo * > Import (TypeSourceInfo *FromTSI)
 Import the given type source information from the "from" context into the "to" context. More...
 
llvm::Expected< Attr * > Import (const Attr *FromAttr)
 Import the given attribute from the "from" context into the "to" context. More...
 
llvm::Expected< Decl * > Import (Decl *FromD)
 Import the given declaration from the "from" context into the "to" context. More...
 
llvm::Expected< const Decl * > Import (const Decl *FromD)
 
DeclGetAlreadyImportedOrNull (const Decl *FromD) const
 Return the copy of the given declaration in the "to" context if it has already been imported from the "from" context. More...
 
TranslationUnitDeclGetFromTU (Decl *ToD)
 Return the translation unit from where the declaration was imported. More...
 
llvm::Expected< DeclContext * > ImportContext (DeclContext *FromDC)
 Import the given declaration context from the "from" AST context into the "to" AST context. More...
 
llvm::Expected< Expr * > Import (Expr *FromE)
 Import the given expression from the "from" context into the "to" context. More...
 
llvm::Expected< Stmt * > Import (Stmt *FromS)
 Import the given statement from the "from" context into the "to" context. More...
 
llvm::Expected< NestedNameSpecifier * > Import (NestedNameSpecifier *FromNNS)
 Import the given nested-name-specifier from the "from" context into the "to" context. More...
 
llvm::Expected< NestedNameSpecifierLocImport (NestedNameSpecifierLoc FromNNS)
 Import the given nested-name-specifier-loc from the "from" context into the "to" context. More...
 
llvm::Expected< TemplateNameImport (TemplateName From)
 Import the given template name from the "from" context into the "to" context, or the import error. More...
 
llvm::Expected< SourceLocationImport (SourceLocation FromLoc)
 Import the given source location from the "from" context into the "to" context. More...
 
llvm::Expected< SourceRangeImport (SourceRange FromRange)
 Import the given source range from the "from" context into the "to" context. More...
 
llvm::Expected< DeclarationNameImport (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...
 
llvm::Expected< SelectorImport (Selector FromSel)
 Import the given Objective-C selector from the "from" context into the "to" context. More...
 
llvm::Expected< FileIDImport (FileID, bool IsBuiltin=false)
 Import the given file ID from the "from" context into the "to" context. More...
 
llvm::Expected< CXXCtorInitializer * > Import (CXXCtorInitializer *FromInit)
 Import the given C++ constructor initializer from the "from" context into the "to" context. More...
 
llvm::Expected< CXXBaseSpecifier * > Import (const CXXBaseSpecifier *FromSpec)
 Import the given CXXBaseSpecifier from the "from" context into the "to" context. More...
 
LLVM_NODISCARD llvm::Error ImportDefinition (Decl *From)
 Import the definition of the given declaration, including all of the declarations it contains. More...
 
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 void Imported (Decl *From, Decl *To)
 Subclasses can override this function to observe all of the From -> To declaration mappings as they are imported. More...
 
void RegisterImportedDecl (Decl *FromD, Decl *ToD)
 
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...
 

Static Public Member Functions

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

Protected Member Functions

virtual Expected< Decl * > ImportImpl (Decl *From)
 Can be overwritten by subclasses to implement their own import logic. More...
 

Friends

class ASTNodeImporter
 

Detailed Description

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

Definition at line 83 of file ASTImporter.h.

Member Typedef Documentation

◆ ImportedCXXBaseSpecifierMap

Definition at line 88 of file ASTImporter.h.

◆ NonEquivalentDeclSet

Definition at line 86 of file ASTImporter.h.

Constructor & Destructor Documentation

◆ ASTImporter()

ASTImporter::ASTImporter ( ASTContext ToContext,
FileManager ToFileManager,
ASTContext FromContext,
FileManager FromFileManager,
bool  MinimalImport,
ASTImporterLookupTable LookupTable = nullptr 
)
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.
LookupTableThe importer specific lookup table which may be shared amongst several ASTImporter objects. If not set then the original C/C++ lookup is used.

Definition at line 7660 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 8514 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 8506 of file ASTImporter.cpp.

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

◆ GetAlreadyImportedOrNull()

Decl * ASTImporter::GetAlreadyImportedOrNull ( const Decl FromD) const

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

Otherwise return nullptr.

Definition at line 7786 of file ASTImporter.cpp.

Referenced by Import().

◆ getFieldIndex()

Optional< unsigned > 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 7674 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 367 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 373 of file ASTImporter.h.

◆ GetFromTU()

TranslationUnitDecl * ASTImporter::GetFromTU ( Decl ToD)

Return the translation unit from where the declaration was imported.

If it does not exist nullptr is returned.

Definition at line 7794 of file ASTImporter.cpp.

◆ getNonEquivalentDecls()

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

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

Definition at line 382 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 405 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 364 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 370 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 8490 of file ASTImporter.cpp.

◆ Import() [1/18]

Expected< QualType > ASTImporter::Import ( QualType  FromT)

◆ Import() [2/18]

Expected< 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 the import error.

Definition at line 7760 of file ASTImporter.cpp.

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

◆ Import() [3/18]

Expected< 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, or the import error.

Definition at line 7776 of file ASTImporter.cpp.

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

◆ Import() [4/18]

Expected< 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 the import error.

Definition at line 7801 of file ASTImporter.cpp.

References GetAlreadyImportedOrNull(), Imported(), ImportImpl(), and clang::updateFlags().

◆ Import() [5/18]

llvm::Expected<const Decl *> clang::ASTImporter::Import ( const Decl FromD)
inline

Definition at line 218 of file ASTImporter.h.

References clang::Error.

◆ Import() [6/18]

Expected< 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 the import error.

Definition at line 7901 of file ASTImporter.cpp.

References Import().

◆ Import() [7/18]

Expected< 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 the import error.

Definition at line 7908 of file ASTImporter.cpp.

◆ Import() [8/18]

Expected< NestedNameSpecifier * > ASTImporter::Import ( NestedNameSpecifier FromNNS)

◆ Import() [9/18]

Expected< NestedNameSpecifierLoc > ASTImporter::Import ( NestedNameSpecifierLoc  FromNNS)

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

Returns
The equivalent nested-name-specifier-loc in the "to" context, or the import error.

Definition at line 7997 of file ASTImporter.cpp.

References clang::NestedNameSpecifierLoc::getPrefix().

◆ Import() [10/18]

Expected< TemplateName > ASTImporter::Import ( TemplateName  From)

Import the given template name from the "from" context into the "to" context, or the import error.

Definition at line 8076 of file ASTImporter.cpp.

References clang::UnresolvedSetImpl::addDecl(), clang::TemplateName::AssumedTemplate, clang::UnresolvedSetImpl::begin(), clang::TemplateName::DependentTemplate, clang::UnresolvedSetImpl::end(), clang::SubstTemplateTemplateParmPackStorage::getArgumentPack(), clang::TemplateName::getAsAssumedTemplateName(), clang::TemplateName::getAsDependentTemplateName(), clang::TemplateName::getAsOverloadedTemplate(), clang::TemplateName::getAsQualifiedTemplateName(), clang::TemplateName::getAsSubstTemplateTemplateParm(), clang::TemplateName::getAsSubstTemplateTemplateParmPack(), clang::ASTContext::getAssumedTemplateName(), clang::TemplateName::getAsTemplateDecl(), clang::AssumedTemplateStorage::getDeclName(), 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::OverloadedTemplate, clang::TemplateName::QualifiedTemplate, clang::TemplateName::SubstTemplateTemplateParm, clang::TemplateName::SubstTemplateTemplateParmPack, and clang::TemplateName::Template.

◆ Import() [11/18]

Expected< 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 the import error.

Definition at line 8170 of file ASTImporter.cpp.

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

◆ Import() [12/18]

Expected< 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 the import error.

Definition at line 8185 of file ASTImporter.cpp.

References clang::Error, clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), and importInto().

◆ Import() [13/18]

Expected< 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 the import error.

Definition at line 8403 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::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 8467 of file ASTImporter.cpp.

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

◆ Import() [15/18]

Expected< 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, or the import error.

Definition at line 8479 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]

Expected< FileID > ASTImporter::Import ( FileID  FromID,
bool  IsBuiltin = false 
)

◆ Import() [17/18]

Expected< CXXCtorInitializer * > ASTImporter::Import ( CXXCtorInitializer FromInit)

◆ Import() [18/18]

Expected< 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 7841 of file ASTImporter.cpp.

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

◆ ImportDefinition()

Error ASTImporter::ImportDefinition ( Decl From)

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

Definition at line 8360 of file ASTImporter.cpp.

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

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

◆ Imported()

virtual void 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 392 of file ASTImporter.h.

Referenced by Import().

◆ ImportImpl()

Expected< Decl * > ASTImporter::ImportImpl ( Decl From)
protectedvirtual

Can be overwritten by subclasses to implement their own import logic.

The overwritten method should call this method if it didn't import the decl on its own.

Definition at line 7725 of file ASTImporter.cpp.

References clang::TypeVisitor< ImplClass, RetTy >::Visit().

Referenced by Import().

◆ importInto()

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 185 of file ASTImporter.h.

Referenced by Import().

◆ 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 177 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 8547 of file ASTImporter.cpp.

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

◆ MapImported()

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

Store and assign the imported declaration to its counterpart.

Definition at line 8534 of file ASTImporter.cpp.

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

◆ RegisterImportedDecl()

void ASTImporter::RegisterImportedDecl ( Decl FromD,
Decl ToD 
)

Definition at line 7731 of file ASTImporter.cpp.

References MapImported().

◆ ToDiag()

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

Report a diagnostic in the "to" context.

Definition at line 8498 of file ASTImporter.cpp.

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

Friends And Related Function Documentation

◆ ASTNodeImporter

friend class ASTNodeImporter
friend

Definition at line 84 of file ASTImporter.h.

Referenced by ImportContext().


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