clang  14.0.0git
Classes | Public Member Functions | Static Public Member Functions | List of all members
clang::cross_tu::CrossTranslationUnitContext Class Reference

This class is used for tools that requires cross translation unit capability. More...

#include "clang/CrossTU/CrossTranslationUnit.h"

Public Member Functions

 CrossTranslationUnitContext (CompilerInstance &CI)
 
 ~CrossTranslationUnitContext ()
 
llvm::Expected< const FunctionDecl * > getCrossTUDefinition (const FunctionDecl *FD, StringRef CrossTUDir, StringRef IndexName, bool DisplayCTUProgress=false)
 This function loads a function or variable definition from an external AST file and merges it into the original AST. More...
 
llvm::Expected< const VarDecl * > getCrossTUDefinition (const VarDecl *VD, StringRef CrossTUDir, StringRef IndexName, bool DisplayCTUProgress=false)
 
llvm::Expected< ASTUnit * > loadExternalAST (StringRef LookupName, StringRef CrossTUDir, StringRef IndexName, bool DisplayCTUProgress=false)
 This function loads a definition from an external AST file. More...
 
llvm::Expected< const FunctionDecl * > importDefinition (const FunctionDecl *FD, ASTUnit *Unit)
 This function merges a definition from a separate AST Unit into the current one which was created by the compiler instance that was passed to the constructor. More...
 
llvm::Expected< const VarDecl * > importDefinition (const VarDecl *VD, ASTUnit *Unit)
 
void emitCrossTUDiagnostics (const IndexError &IE)
 Emit diagnostics for the user for potential configuration errors. More...
 
llvm::Optional< clang::MacroExpansionContextgetMacroExpansionContextForSourceLocation (const clang::SourceLocation &ToLoc) const
 Returns the MacroExpansionContext for the imported TU to which the given source-location corresponds. More...
 

Static Public Member Functions

static llvm::Optional< std::stringgetLookupName (const NamedDecl *ND)
 Get a name to identify a named decl. More...
 

Detailed Description

This class is used for tools that requires cross translation unit capability.

This class can load definitions from external AST sources. The loaded definition will be merged back to the original AST using the AST Importer. In order to use this class, an index file is required that describes the locations of the AST files for each definition.

Note that this class also implements caching.

Definition at line 125 of file CrossTranslationUnit.h.

Constructor & Destructor Documentation

◆ CrossTranslationUnitContext()

clang::cross_tu::CrossTranslationUnitContext::CrossTranslationUnitContext ( CompilerInstance CI)

Definition at line 215 of file CrossTranslationUnit.cpp.

◆ ~CrossTranslationUnitContext()

clang::cross_tu::CrossTranslationUnitContext::~CrossTranslationUnitContext ( )

Definition at line 218 of file CrossTranslationUnit.cpp.

Member Function Documentation

◆ emitCrossTUDiagnostics()

void clang::cross_tu::CrossTranslationUnitContext::emitCrossTUDiagnostics ( const IndexError IE)

◆ getCrossTUDefinition() [1/2]

llvm::Expected< const FunctionDecl * > clang::cross_tu::CrossTranslationUnitContext::getCrossTUDefinition ( const FunctionDecl FD,
StringRef  CrossTUDir,
StringRef  IndexName,
bool  DisplayCTUProgress = false 
)

This function loads a function or variable definition from an external AST file and merges it into the original AST.

This method should only be used on functions that have no definitions or variables that have no initializer in the current translation unit. A function definition with the same declaration will be looked up in the index file which should be in the CrossTUDir directory, called IndexName. In case the declaration is found in the index the corresponding AST will be loaded and the definition will be merged into the original AST using the AST Importer.

Returns
The declaration with the definition will be returned. If no suitable definition is found in the index file or multiple definitions found error will be returned.

Note that the AST files should also be in the CrossTUDir.

Definition at line 329 of file CrossTranslationUnit.cpp.

Referenced by clang::ento::AnyFunctionCall::getRuntimeDefinition().

◆ getCrossTUDefinition() [2/2]

llvm::Expected< const VarDecl * > clang::cross_tu::CrossTranslationUnitContext::getCrossTUDefinition ( const VarDecl VD,
StringRef  CrossTUDir,
StringRef  IndexName,
bool  DisplayCTUProgress = false 
)

Definition at line 338 of file CrossTranslationUnit.cpp.

◆ getLookupName()

llvm::Optional< std::string > clang::cross_tu::CrossTranslationUnitContext::getLookupName ( const NamedDecl ND)
static

Get a name to identify a named decl.

Definition at line 221 of file CrossTranslationUnit.cpp.

References clang::index::generateUSRForDecl(), Ret(), and string().

◆ getMacroExpansionContextForSourceLocation()

llvm::Optional< clang::MacroExpansionContext > clang::cross_tu::CrossTranslationUnitContext::getMacroExpansionContextForSourceLocation ( const clang::SourceLocation ToLoc) const

Returns the MacroExpansionContext for the imported TU to which the given source-location corresponds.

ToLoc Source location in the imported-to AST.

Note
If any error happens such as ToLoc is a non-imported source-location, empty is returned.
Macro expansion tracking for imported TUs is not implemented yet. It returns empty unconditionally.

Definition at line 774 of file CrossTranslationUnit.cpp.

Referenced by getExpandedMacro().

◆ importDefinition() [1/2]

llvm::Expected< const FunctionDecl * > clang::cross_tu::CrossTranslationUnitContext::importDefinition ( const FunctionDecl FD,
ASTUnit Unit 
)

This function merges a definition from a separate AST Unit into the current one which was created by the compiler instance that was passed to the constructor.

Returns
Returns the resulting definition or an error.

Definition at line 741 of file CrossTranslationUnit.cpp.

◆ importDefinition() [2/2]

llvm::Expected< const VarDecl * > clang::cross_tu::CrossTranslationUnitContext::importDefinition ( const VarDecl VD,
ASTUnit Unit 
)

Definition at line 747 of file CrossTranslationUnit.cpp.

◆ loadExternalAST()

llvm::Expected< ASTUnit * > clang::cross_tu::CrossTranslationUnitContext::loadExternalAST ( StringRef  LookupName,
StringRef  CrossTUDir,
StringRef  IndexName,
bool  DisplayCTUProgress = false 
)

This function loads a definition from an external AST file.

A definition with the same declaration will be looked up in the index file which should be in the CrossTUDir directory, called IndexName. In case the declaration is found in the index the corresponding AST will be loaded. If the number of TUs imported reaches CTULoadTreshold, no loading is performed.

Returns
Returns a pointer to the ASTUnit that contains the definition of the looked up name or an Error. The returned pointer is never a nullptr.

Note that the AST files should also be in the CrossTUDir.

Definition at line 486 of file CrossTranslationUnit.cpp.

References clang::cross_tu::failed_to_get_external_ast.


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