clang
9.0.0
|
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) |
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) |
void | emitCrossTUDiagnostics (const IndexError &IE) |
Emit diagnostics for the user for potential configuration errors. More... | |
Static Public Member Functions | |
static std::string | getLookupName (const NamedDecl *ND) |
Get a name to identify a named decl. More... | |
This class is used for tools that requires cross translation unit capability.
This class can load definitions from external AST files. 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 105 of file CrossTranslationUnit.h.
clang::cross_tu::CrossTranslationUnitContext::CrossTranslationUnitContext | ( | CompilerInstance & | CI | ) |
Definition at line 190 of file CrossTranslationUnit.cpp.
clang::cross_tu::CrossTranslationUnitContext::~CrossTranslationUnitContext | ( | ) |
Definition at line 194 of file CrossTranslationUnit.cpp.
void clang::cross_tu::CrossTranslationUnitContext::emitCrossTUDiagnostics | ( | const IndexError & | IE | ) |
Emit diagnostics for the user for potential configuration errors.
Definition at line 320 of file CrossTranslationUnit.cpp.
References clang::cross_tu::IndexError::getCode(), clang::ASTContext::getDiagnostics(), clang::cross_tu::IndexError::getFileName(), clang::cross_tu::IndexError::getLineNum(), clang::cross_tu::IndexError::getTripleFromName(), clang::cross_tu::IndexError::getTripleToName(), clang::cross_tu::invalid_index_format, clang::cross_tu::missing_index_file, clang::cross_tu::multiple_definitions, clang::DiagnosticsEngine::Report(), and clang::cross_tu::triple_mismatch.
Referenced by clang::ento::AnyFunctionCall::getRuntimeDefinition().
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 file will be loaded and the definition will be merged into the original AST using the AST Importer.
Note that the AST files should also be in the CrossTUDir
.
Definition at line 303 of file CrossTranslationUnit.cpp.
Referenced by clang::ento::AnyFunctionCall::getRuntimeDefinition().
llvm::Expected< const VarDecl * > clang::cross_tu::CrossTranslationUnitContext::getCrossTUDefinition | ( | const VarDecl * | VD, |
StringRef | CrossTUDir, | ||
StringRef | IndexName, | ||
bool | DisplayCTUProgress = false |
||
) |
Definition at line 312 of file CrossTranslationUnit.cpp.
|
static |
Get a name to identify a named decl.
Definition at line 196 of file CrossTranslationUnit.cpp.
References clang::DeclContext::decls(), clang::cross_tu::failed_import, clang::cross_tu::failed_to_generate_usr, clang::index::generateUSRForDecl(), clang::ASTUnit::getASTContext(), clang::ASTUnit::getFileManager(), clang::SourceManager::getFileManager(), clang::ASTContext::getLangOpts(), clang::ASTUnit::getMainFileName(), clang::ASTContext::getSourceManager(), clang::ASTContext::getTargetInfo(), clang::ASTContext::getTranslationUnitDecl(), clang::TargetInfo::getTriple(), clang::cross_tu::hasBodyOrInit(), importDefinition(), clang::cross_tu::lang_dialect_mismatch, clang::cross_tu::lang_mismatch, loadExternalAST(), and clang::cross_tu::triple_mismatch.
llvm::Expected< const FunctionDecl * > clang::cross_tu::CrossTranslationUnitContext::importDefinition | ( | const FunctionDecl * | FD | ) |
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.
Definition at line 444 of file CrossTranslationUnit.cpp.
Referenced by getLookupName().
llvm::Expected< const VarDecl * > clang::cross_tu::CrossTranslationUnitContext::importDefinition | ( | const VarDecl * | VD | ) |
Definition at line 449 of file CrossTranslationUnit.cpp.
References clang::SourceManager::getFileManager(), clang::ASTContext::getSourceManager(), and clang::ASTContext::getTranslationUnitDecl().
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 file will be loaded. If the number of TUs imported reaches CTULoadTreshold
, no loading is performed.
Note that the AST files should also be in the CrossTUDir
.
Definition at line 343 of file CrossTranslationUnit.cpp.
References clang::cross_tu::failed_import, clang::cross_tu::failed_to_get_external_ast, clang::CompilerInstance::getFileSystemOpts(), clang::CompilerInstance::getPCHContainerOperations(), clang::cross_tu::hasBodyOrInit(), clang::ASTImporter::Import(), clang::cross_tu::load_threshold_reached, clang::ASTUnit::LoadEverything, clang::ASTUnit::LoadFromASTFile(), clang::cross_tu::missing_definition, clang::ImportError::NameConflict, clang::cross_tu::parseCrossTUIndex(), clang::ImportError::Unknown, and clang::ImportError::UnsupportedConstruct.
Referenced by getLookupName().