clang
6.0.0
|
Abstract base class for actions which can be performed by the frontend. More...
#include "clang/Frontend/FrontendAction.h"
Public Member Functions | |
FrontendAction () | |
virtual | ~FrontendAction () |
Compiler Instance Access | |
CompilerInstance & | getCompilerInstance () const |
void | setCompilerInstance (CompilerInstance *Value) |
Current File Information | |
bool | isCurrentFileAST () const |
const FrontendInputFile & | getCurrentInput () const |
const StringRef | getCurrentFile () const |
InputKind | getCurrentFileKind () const |
ASTUnit & | getCurrentASTUnit () const |
Module * | getCurrentModule () const |
std::unique_ptr< ASTUnit > | takeCurrentASTUnit () |
void | setCurrentInput (const FrontendInputFile &CurrentInput, std::unique_ptr< ASTUnit > AST=nullptr) |
Supported Modes | |
virtual bool | isModelParsingAction () const |
Is this action invoked on a model file? More... | |
virtual bool | usesPreprocessorOnly () const =0 |
Does this action only use the preprocessor? More... | |
virtual TranslationUnitKind | getTranslationUnitKind () |
For AST-based actions, the kind of translation unit we're handling. More... | |
virtual bool | hasPCHSupport () const |
Does this action support use with PCH? More... | |
virtual bool | hasASTFileSupport () const |
Does this action support use with AST files? More... | |
virtual bool | hasIRSupport () const |
Does this action support use with IR files? More... | |
virtual bool | hasCodeCompletionSupport () const |
Does this action support use with code completion? More... | |
Public Action Interface | |
bool | BeginSourceFile (CompilerInstance &CI, const FrontendInputFile &Input) |
Prepare the action for processing the input file Input . More... | |
bool | Execute () |
Set the source manager's main input file, and run the action. More... | |
void | EndSourceFile () |
Perform any per-file post processing, deallocate per-file objects, and run statistics and output file cleanup code. More... | |
Protected Member Functions | |
Implementation Action Interface | |
virtual std::unique_ptr< ASTConsumer > | CreateASTConsumer (CompilerInstance &CI, StringRef InFile)=0 |
Create the AST consumer object for this action, if supported. More... | |
virtual bool | BeginInvocation (CompilerInstance &CI) |
Callback before starting processing a single input, giving the opportunity to modify the CompilerInvocation or do some other action before BeginSourceFileAction is called. More... | |
virtual bool | BeginSourceFileAction (CompilerInstance &CI) |
Callback at the start of processing a single input. More... | |
virtual void | ExecuteAction ()=0 |
Callback to run the program action, using the initialized compiler instance. More... | |
virtual void | EndSourceFileAction () |
Callback at the end of processing a single input. More... | |
virtual bool | shouldEraseOutputFiles () |
Callback at the end of processing a single input, to determine if the output files should be erased or not. More... | |
Friends | |
class | ASTMergeAction |
class | WrapperFrontendAction |
Abstract base class for actions which can be performed by the frontend.
Definition at line 36 of file FrontendAction.h.
FrontendAction::FrontendAction | ( | ) |
Definition at line 129 of file FrontendAction.cpp.
Referenced by EndSourceFileAction().
|
virtual |
Definition at line 131 of file FrontendAction.cpp.
Referenced by EndSourceFileAction().
|
inlineprotectedvirtual |
Callback before starting processing a single input, giving the opportunity to modify the CompilerInvocation or do some other action before BeginSourceFileAction is called.
Reimplemented in clang::WrapperFrontendAction, clang::DumpModuleInfoAction, clang::arcmt::ObjCMigrateAction, clang::FixItRecompile, clang::arcmt::MigrateAction, clang::arcmt::MigrateSourceAction, clang::arcmt::ModifyAction, and clang::arcmt::CheckAction.
Definition at line 73 of file FrontendAction.h.
Referenced by clang::FixItRecompile::FixItRecompile().
bool FrontendAction::BeginSourceFile | ( | CompilerInstance & | CI, |
const FrontendInputFile & | Input | ||
) |
Prepare the action for processing the input file Input
.
This is run after the options and frontend have been initialized, but prior to executing any per-file processing.
CI | - The compiler instance this action is being run from. The action may store and use this object up until the matching EndSourceFile action. |
Input | - The input filename and kind. Some input kinds are handled specially, for example AST inputs, since the AST file itself contains several objects which would normally be owned by the CompilerInstance. When processing AST input files, these objects should generally not be initialized in the CompilerInstance – they will automatically be shared with the AST file in between BeginSourceFile() and EndSourceFile(). |
Definition at line 512 of file FrontendAction.cpp.
Referenced by hasCodeCompletionSupport().
|
inlineprotectedvirtual |
Callback at the start of processing a single input.
Reimplemented in clang::WrapperFrontendAction, clang::ASTMergeAction, clang::GeneratePCHAction, clang::RewriteIncludesAction, and clang::FixItAction.
Definition at line 79 of file FrontendAction.h.
References ExecuteAction().
Referenced by clang::GeneratePCHAction::hasASTFileSupport(), and clang::tooling::newFrontendActionFactory().
|
protectedpure virtual |
Create the AST consumer object for this action, if supported.
This routine is called as part of BeginSourceFile(), which will fail if the AST consumer cannot be created. This will not be called if the action has indicated that it only uses the preprocessor.
CI | - The current compiler instance, provided as a convenience, see getCompilerInstance(). |
InFile | - The current input file, provided as a convenience, see getCurrentFile(). |
Implemented in clang::WrapperFrontendAction, clang::PreprocessorFrontendAction, clang::PluginASTAction, clang::PrintPreambleAction, clang::ASTMergeAction, clang::VerifyPCHAction, clang::DumpModuleInfoAction, clang::SyntaxOnlyAction, clang::GenerateModuleAction, clang::GeneratePCHAction, clang::arcmt::ObjCMigrateAction, clang::DeclContextPrintAction, clang::CodeGenAction, clang::ASTViewAction, clang::RewriteObjCAction, clang::ASTDeclListAction, clang::ASTDumpAction, clang::ento::ParseModelFileAction, clang::ASTPrintAction, clang::arcmt::MigrateSourceAction, clang::FixItAction, clang::ento::AnalysisAction, and clang::HTMLPrintAction.
Referenced by getCurrentModule().
void FrontendAction::EndSourceFile | ( | ) |
Perform any per-file post processing, deallocate per-file objects, and run statistics and output file cleanup code.
Definition at line 913 of file FrontendAction.cpp.
References clang::BuryPointer(), clang::CompilerInstance::clearOutputFiles(), clang::LangOptions::CMK_None, clang::FrontendOptions::DisableFree, clang::Preprocessor::EndSourceFile(), clang::DiagnosticConsumer::EndSourceFile(), EndSourceFileAction(), getCompilerInstance(), getCurrentFile(), clang::CompilerInstance::getDiagnosticClient(), clang::CompilerInstance::getFrontendOpts(), clang::Preprocessor::getHeaderSearchInfo(), clang::Preprocessor::getIdentifierTable(), clang::CompilerInstance::getLangOpts(), clang::CompilerInstance::getPreprocessor(), clang::CompilerInstance::getSourceManager(), clang::CompilerInstance::hasPreprocessor(), isCurrentFileAST(), clang::IdentifierTable::PrintStats(), clang::HeaderSearch::PrintStats(), clang::SourceManager::PrintStats(), clang::Preprocessor::PrintStats(), clang::CompilerInstance::resetAndLeakASTContext(), clang::CompilerInstance::resetAndLeakFileManager(), clang::CompilerInstance::resetAndLeakPreprocessor(), clang::CompilerInstance::resetAndLeakSema(), clang::CompilerInstance::resetAndLeakSourceManager(), clang::CompilerInstance::setASTConsumer(), clang::CompilerInstance::setASTContext(), setCompilerInstance(), setCurrentInput(), clang::CompilerInstance::setFileManager(), clang::CompilerInstance::setPreprocessor(), clang::CompilerInstance::setSema(), clang::CompilerInstance::setSourceManager(), shouldEraseOutputFiles(), clang::FrontendOptions::ShowStats, and clang::CompilerInstance::takeASTConsumer().
|
inlineprotectedvirtual |
Callback at the end of processing a single input.
This is guaranteed to only be called following a successful call to BeginSourceFileAction (and BeginSourceFile).
Reimplemented in clang::WrapperFrontendAction, clang::ASTMergeAction, clang::CodeGenAction, and clang::FixItAction.
Definition at line 94 of file FrontendAction.h.
References FrontendAction(), shouldEraseOutputFiles(), and ~FrontendAction().
Referenced by EndSourceFile(), and clang::tooling::newFrontendActionFactory().
bool FrontendAction::Execute | ( | ) |
Set the source manager's main input file, and run the action.
Definition at line 890 of file FrontendAction.cpp.
References ExecuteAction(), getCompilerInstance(), clang::CompilerInstance::getFileManager(), clang::CompilerInstance::getFrontendTimer(), clang::Preprocessor::getHeaderSearchInfo(), clang::HeaderSearch::getModuleCachePath(), clang::CompilerInstance::getPCHContainerReader(), clang::CompilerInstance::getPreprocessor(), clang::CompilerInstance::hasFileManager(), clang::CompilerInstance::hasFrontendTimer(), clang::CompilerInstance::hasPreprocessor(), clang::CompilerInstance::shouldBuildGlobalModuleIndex(), and clang::GlobalModuleIndex::writeIndex().
|
protectedpure virtual |
Callback to run the program action, using the initialized compiler instance.
This is guaranteed to only be called between BeginSourceFileAction() and EndSourceFileAction().
Implemented in clang::WrapperFrontendAction, clang::PrintPreprocessedAction, clang::PreprocessOnlyAction, clang::GeneratePTHAction, clang::ASTFrontendAction, clang::DumpTokensAction, clang::DumpRawTokensAction, clang::PrintPreambleAction, clang::ASTMergeAction, clang::VerifyPCHAction, clang::DumpModuleInfoAction, clang::RewriteIncludesAction, clang::RewriteTestAction, clang::RewriteMacrosAction, and clang::CodeGenAction.
Referenced by BeginSourceFileAction(), and Execute().
|
inline |
Definition at line 113 of file FrontendAction.h.
Referenced by clang::FixItAction::BeginSourceFileAction(), EndSourceFile(), clang::CodeGenAction::EndSourceFileAction(), Execute(), clang::CodeGenAction::ExecuteAction(), clang::RewriteMacrosAction::ExecuteAction(), clang::RewriteTestAction::ExecuteAction(), clang::RewriteIncludesAction::ExecuteAction(), clang::DumpModuleInfoAction::ExecuteAction(), clang::VerifyPCHAction::ExecuteAction(), clang::ASTMergeAction::ExecuteAction(), clang::PrintPreambleAction::ExecuteAction(), clang::DumpRawTokensAction::ExecuteAction(), clang::DumpTokensAction::ExecuteAction(), clang::ASTFrontendAction::ExecuteAction(), clang::GeneratePTHAction::ExecuteAction(), clang::PreprocessOnlyAction::ExecuteAction(), clang::PrintPreprocessedAction::ExecuteAction(), getCurrentModule(), clang::GeneratePCHAction::shouldEraseOutputFiles(), and shouldEraseOutputFiles().
|
inline |
Definition at line 143 of file FrontendAction.h.
References getCurrentModule().
|
inline |
Definition at line 133 of file FrontendAction.h.
References clang::FrontendInputFile::getFile(), and clang::FrontendInputFile::isEmpty().
Referenced by clang::RewriteIncludesAction::BeginSourceFileAction(), EndSourceFile(), clang::CodeGenAction::ExecuteAction(), clang::RewriteMacrosAction::ExecuteAction(), clang::RewriteTestAction::ExecuteAction(), clang::DumpModuleInfoAction::ExecuteAction(), clang::VerifyPCHAction::ExecuteAction(), and clang::GeneratePTHAction::ExecuteAction().
|
inline |
Definition at line 138 of file FrontendAction.h.
References clang::FrontendInputFile::getKind(), and clang::FrontendInputFile::isEmpty().
Referenced by clang::CodeGenAction::ExecuteAction(), and clang::PrintPreambleAction::ExecuteAction().
|
inline |
Definition at line 129 of file FrontendAction.h.
Referenced by clang::arcmt::CheckAction::BeginInvocation(), clang::arcmt::ModifyAction::BeginInvocation(), clang::arcmt::MigrateAction::BeginInvocation(), clang::ASTMergeAction::BeginSourceFileAction(), and clang::WrapperFrontendAction::BeginSourceFileAction().
Module * FrontendAction::getCurrentModule | ( | ) | const |
Definition at line 139 of file FrontendAction.cpp.
References clang::PluginASTAction::AddAfterMainAction, clang::PluginASTAction::AddBeforeMainAction, clang::FrontendOptions::AddPluginActions, clang::C, clang::PluginASTAction::Cmdline, CreateASTConsumer(), clang::LangOptions::CurrentModule, getCompilerInstance(), clang::CompilerInstance::getFrontendOpts(), clang::Preprocessor::getHeaderSearchInfo(), clang::CompilerInstance::getLangOpts(), clang::CompilerInstance::getPreprocessor(), clang::HeaderSearch::lookupModule(), P, and clang::FrontendOptions::PluginArgs.
Referenced by getCurrentASTUnit().
|
inlinevirtual |
For AST-based actions, the kind of translation unit we're handling.
Reimplemented in clang::WrapperFrontendAction, clang::ASTMergeAction, clang::GenerateModuleAction, and clang::GeneratePCHAction.
Definition at line 175 of file FrontendAction.h.
References clang::TU_Complete.
Referenced by clang::ASTFrontendAction::ExecuteAction().
|
inlinevirtual |
Does this action support use with AST files?
Reimplemented in clang::WrapperFrontendAction, clang::ASTMergeAction, clang::DumpModuleInfoAction, clang::GenerateModuleAction, clang::GeneratePCHAction, and clang::FixItAction.
Definition at line 181 of file FrontendAction.h.
|
inlinevirtual |
Does this action support use with code completion?
Reimplemented in clang::WrapperFrontendAction, clang::ASTMergeAction, clang::VerifyPCHAction, clang::DumpModuleInfoAction, and clang::SyntaxOnlyAction.
Definition at line 187 of file FrontendAction.h.
References BeginSourceFile().
Referenced by clang::ASTFrontendAction::ExecuteAction().
|
inlinevirtual |
Does this action support use with IR files?
Reimplemented in clang::WrapperFrontendAction, clang::DumpModuleInfoAction, and clang::CodeGenAction.
Definition at line 184 of file FrontendAction.h.
|
inlinevirtual |
Does this action support use with PCH?
Reimplemented in clang::WrapperFrontendAction, clang::PrintPreprocessedAction, clang::ASTMergeAction, and clang::DumpModuleInfoAction.
Definition at line 178 of file FrontendAction.h.
|
inline |
Definition at line 124 of file FrontendAction.h.
References clang::FrontendInputFile::isEmpty().
Referenced by EndSourceFile().
|
inlinevirtual |
Is this action invoked on a model file?
Model files are incomplete translation units that relies on type information from another translation unit. Check ParseModelFileAction for details.
Reimplemented in clang::ento::ParseModelFileAction.
Definition at line 166 of file FrontendAction.h.
References usesPreprocessorOnly().
|
inline |
Definition at line 118 of file FrontendAction.h.
Referenced by EndSourceFile().
void FrontendAction::setCurrentInput | ( | const FrontendInputFile & | CurrentInput, |
std::unique_ptr< ASTUnit > | AST = nullptr |
||
) |
Definition at line 133 of file FrontendAction.cpp.
Referenced by clang::WrapperFrontendAction::BeginSourceFileAction(), EndSourceFile(), and takeCurrentASTUnit().
|
protectedvirtual |
Callback at the end of processing a single input, to determine if the output files should be erased or not.
By default it returns true if a compiler error occurred. This is guaranteed to only be called following a successful call to BeginSourceFileAction (and BeginSourceFile).
Reimplemented in clang::GeneratePCHAction.
Definition at line 971 of file FrontendAction.cpp.
References getCompilerInstance(), clang::CompilerInstance::getDiagnostics(), and clang::DiagnosticsEngine::hasErrorOccurred().
Referenced by EndSourceFile(), EndSourceFileAction(), clang::GeneratePCHAction::hasASTFileSupport(), and clang::GeneratePCHAction::shouldEraseOutputFiles().
|
inline |
Definition at line 150 of file FrontendAction.h.
References setCurrentInput().
Referenced by clang::ASTMergeAction::BeginSourceFileAction().
|
pure virtual |
Does this action only use the preprocessor?
If so no AST context will be created and this action will be invalid with AST file inputs.
Implemented in clang::WrapperFrontendAction, clang::PreprocessorFrontendAction, clang::ASTFrontendAction, clang::PrintPreambleAction, clang::ASTMergeAction, and clang::InitOnlyAction.
Referenced by isModelParsingAction().
|
friend |
Definition at line 40 of file FrontendAction.h.
|
friend |
Definition at line 41 of file FrontendAction.h.