clang  5.0.0svn
Public Member Functions | Friends | List of all members
clang::FrontendAction Class Referenceabstract

Abstract base class for actions which can be performed by the frontend. More...

#include <FrontendAction.h>

Inheritance diagram for clang::FrontendAction:
Inheritance graph
[legend]

Public Member Functions

 FrontendAction ()
 
virtual ~FrontendAction ()
 
Compiler Instance Access
CompilerInstancegetCompilerInstance () const
 
void setCompilerInstance (CompilerInstance *Value)
 
Current File Information
bool isCurrentFileAST () const
 
const FrontendInputFilegetCurrentInput () const
 
const StringRef getCurrentFile () const
 
InputKind getCurrentFileKind () const
 
ASTUnitgetCurrentASTUnit () const
 
std::unique_ptr< ASTUnittakeCurrentASTUnit ()
 
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< ASTConsumerCreateASTConsumer (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, StringRef Filename)
 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
 

Detailed Description

Abstract base class for actions which can be performed by the frontend.

Definition at line 36 of file FrontendAction.h.

Constructor & Destructor Documentation

◆ FrontendAction()

FrontendAction::FrontendAction ( )

Definition at line 129 of file FrontendAction.cpp.

Referenced by EndSourceFileAction().

◆ ~FrontendAction()

FrontendAction::~FrontendAction ( )
virtual

Definition at line 131 of file FrontendAction.cpp.

Referenced by EndSourceFileAction().

Member Function Documentation

◆ BeginInvocation()

virtual bool clang::FrontendAction::BeginInvocation ( CompilerInstance CI)
inlineprotectedvirtual

Callback before starting processing a single input, giving the opportunity to modify the CompilerInvocation or do some other action before BeginSourceFileAction is called.

Returns
True on success; on failure BeginSourceFileAction(), ExecuteAction() and EndSourceFileAction() will not be 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().

◆ BeginSourceFile()

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.

Parameters
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().
Returns
True on success; on failure the compilation of this file should be aborted and neither Execute() nor EndSourceFile() should be called.

Definition at line 227 of file FrontendAction.cpp.

Referenced by hasCodeCompletionSupport().

◆ BeginSourceFileAction()

virtual bool clang::FrontendAction::BeginSourceFileAction ( CompilerInstance CI,
StringRef  Filename 
)
inlineprotectedvirtual

Callback at the start of processing a single input.

Returns
True on success; on failure ExecutionAction() and EndSourceFileAction() will not be called.

Reimplemented in clang::WrapperFrontendAction, clang::ASTMergeAction, clang::GenerateModuleAction, clang::GeneratePCHAction, and clang::FixItAction.

Definition at line 79 of file FrontendAction.h.

References ExecuteAction().

Referenced by clang::GeneratePCHAction::hasASTFileSupport(), and clang::tooling::newFrontendActionFactory().

◆ CreateASTConsumer()

virtual std::unique_ptr<ASTConsumer> clang::FrontendAction::CreateASTConsumer ( CompilerInstance CI,
StringRef  InFile 
)
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.

Parameters
CI- The current compiler instance, provided as a convenience, see getCompilerInstance().
InFile- The current input file, provided as a convenience, see getCurrentFile().
Returns
The new AST consumer, or null on failure.

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 setCurrentInput().

◆ EndSourceFile()

void FrontendAction::EndSourceFile ( )

Perform any per-file post processing, deallocate per-file objects, and run statistics and output file cleanup code.

Definition at line 528 of file FrontendAction.cpp.

References clang::BuryPointer(), clang::CompilerInstance::clearOutputFiles(), 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::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().

◆ EndSourceFileAction()

virtual void clang::FrontendAction::EndSourceFileAction ( )
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 95 of file FrontendAction.h.

References FrontendAction(), shouldEraseOutputFiles(), and ~FrontendAction().

Referenced by EndSourceFile(), and clang::tooling::newFrontendActionFactory().

◆ Execute()

bool FrontendAction::Execute ( )

◆ ExecuteAction()

virtual void clang::FrontendAction::ExecuteAction ( )
protectedpure virtual

◆ getCompilerInstance()

CompilerInstance& clang::FrontendAction::getCompilerInstance ( ) const
inline

◆ getCurrentASTUnit()

ASTUnit& clang::FrontendAction::getCurrentASTUnit ( ) const
inline

Definition at line 144 of file FrontendAction.h.

◆ getCurrentFile()

const StringRef clang::FrontendAction::getCurrentFile ( ) const
inline

◆ getCurrentFileKind()

InputKind clang::FrontendAction::getCurrentFileKind ( ) const
inline

◆ getCurrentInput()

const FrontendInputFile& clang::FrontendAction::getCurrentInput ( ) const
inline

◆ getTranslationUnitKind()

virtual TranslationUnitKind clang::FrontendAction::getTranslationUnitKind ( )
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 174 of file FrontendAction.h.

References clang::TU_Complete.

Referenced by clang::ASTFrontendAction::ExecuteAction().

◆ hasASTFileSupport()

virtual bool clang::FrontendAction::hasASTFileSupport ( ) const
inlinevirtual

◆ hasCodeCompletionSupport()

virtual bool clang::FrontendAction::hasCodeCompletionSupport ( ) const
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 186 of file FrontendAction.h.

References BeginSourceFile().

Referenced by clang::ASTFrontendAction::ExecuteAction().

◆ hasIRSupport()

virtual bool clang::FrontendAction::hasIRSupport ( ) const
inlinevirtual

Does this action support use with IR files?

Reimplemented in clang::WrapperFrontendAction, clang::DumpModuleInfoAction, and clang::CodeGenAction.

Definition at line 183 of file FrontendAction.h.

◆ hasPCHSupport()

virtual bool clang::FrontendAction::hasPCHSupport ( ) const
inlinevirtual

Does this action support use with PCH?

Reimplemented in clang::WrapperFrontendAction, clang::PrintPreprocessedAction, clang::ASTMergeAction, and clang::DumpModuleInfoAction.

Definition at line 177 of file FrontendAction.h.

References usesPreprocessorOnly().

◆ isCurrentFileAST()

bool clang::FrontendAction::isCurrentFileAST ( ) const
inline

Definition at line 125 of file FrontendAction.h.

References clang::FrontendInputFile::isEmpty().

Referenced by EndSourceFile().

◆ isModelParsingAction()

virtual bool clang::FrontendAction::isModelParsingAction ( ) const
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 165 of file FrontendAction.h.

References usesPreprocessorOnly().

◆ setCompilerInstance()

void clang::FrontendAction::setCompilerInstance ( CompilerInstance Value)
inline

Definition at line 119 of file FrontendAction.h.

Referenced by EndSourceFile().

◆ setCurrentInput()

void FrontendAction::setCurrentInput ( const FrontendInputFile CurrentInput,
std::unique_ptr< ASTUnit AST = nullptr 
)

◆ shouldEraseOutputFiles()

bool FrontendAction::shouldEraseOutputFiles ( )
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 584 of file FrontendAction.cpp.

References getCompilerInstance(), clang::CompilerInstance::getDiagnostics(), and clang::DiagnosticsEngine::hasErrorOccurred().

Referenced by EndSourceFile(), EndSourceFileAction(), clang::GeneratePCHAction::hasASTFileSupport(), and clang::GeneratePCHAction::shouldEraseOutputFiles().

◆ takeCurrentASTUnit()

std::unique_ptr<ASTUnit> clang::FrontendAction::takeCurrentASTUnit ( )
inline

Definition at line 149 of file FrontendAction.h.

References setCurrentInput().

Referenced by clang::ASTMergeAction::BeginSourceFileAction().

◆ usesPreprocessorOnly()

virtual bool clang::FrontendAction::usesPreprocessorOnly ( ) const
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 hasASTFileSupport(), hasPCHSupport(), and isModelParsingAction().

Friends And Related Function Documentation

◆ ASTMergeAction

friend class ASTMergeAction
friend

Definition at line 40 of file FrontendAction.h.

◆ WrapperFrontendAction

friend class WrapperFrontendAction
friend

Definition at line 41 of file FrontendAction.h.


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