clang  14.0.0git
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
clang::WrapperFrontendAction Class Reference

A frontend action which simply wraps some other runtime-specified frontend action. More...

#include "clang/Frontend/FrontendAction.h"

Inheritance diagram for clang::WrapperFrontendAction:
Inheritance graph
[legend]
Collaboration diagram for clang::WrapperFrontendAction:
Collaboration graph
[legend]

Public Member Functions

 WrapperFrontendAction (std::unique_ptr< FrontendAction > WrappedAction)
 Construct a WrapperFrontendAction from an existing action, taking ownership of it. More...
 
bool usesPreprocessorOnly () const override
 Does this action only use the preprocessor? More...
 
TranslationUnitKind getTranslationUnitKind () override
 For AST-based actions, the kind of translation unit we're handling. More...
 
bool hasPCHSupport () const override
 Does this action support use with PCH? More...
 
bool hasASTFileSupport () const override
 Does this action support use with AST files? More...
 
bool hasIRSupport () const override
 Does this action support use with IR files? More...
 
bool hasCodeCompletionSupport () const override
 Does this action support use with code completion? More...
 
- Public Member Functions inherited from clang::FrontendAction
 FrontendAction ()
 
virtual ~FrontendAction ()
 
CompilerInstancegetCompilerInstance () const
 
void setCompilerInstance (CompilerInstance *Value)
 
bool isCurrentFileAST () const
 
const FrontendInputFilegetCurrentInput () const
 
StringRef getCurrentFile () const
 
StringRef getCurrentFileOrBufferName () const
 
InputKind getCurrentFileKind () const
 
ASTUnitgetCurrentASTUnit () const
 
ModulegetCurrentModule () const
 
std::unique_ptr< ASTUnittakeCurrentASTUnit ()
 
void setCurrentInput (const FrontendInputFile &CurrentInput, std::unique_ptr< ASTUnit > AST=nullptr)
 
virtual bool isModelParsingAction () const
 Is this action invoked on a model file? More...
 
bool PrepareToExecute (CompilerInstance &CI)
 Prepare the action to execute on the given compiler instance. More...
 
bool BeginSourceFile (CompilerInstance &CI, const FrontendInputFile &Input)
 Prepare the action for processing the input file Input. More...
 
llvm::Error Execute ()
 Set the source manager's main input file, and run the action. More...
 

Protected Member Functions

bool PrepareToExecuteAction (CompilerInstance &CI) override
 Prepare to execute the action on the given CompilerInstance. More...
 
std::unique_ptr< ASTConsumerCreateASTConsumer (CompilerInstance &CI, StringRef InFile) override
 Create the AST consumer object for this action, if supported. More...
 
bool BeginInvocation (CompilerInstance &CI) override
 Callback before starting processing a single input, giving the opportunity to modify the CompilerInvocation or do some other action before BeginSourceFileAction is called. More...
 
bool BeginSourceFileAction (CompilerInstance &CI) override
 Callback at the start of processing a single input. More...
 
void ExecuteAction () override
 Callback to run the program action, using the initialized compiler instance. More...
 
void EndSourceFile () override
 Perform any per-file post processing, deallocate per-file objects, and run statistics and output file cleanup code. More...
 
void EndSourceFileAction () override
 Callback at the end of processing a single input. More...
 
bool shouldEraseOutputFiles () override
 Callback at the end of processing a single input, to determine if the output files should be erased or not. More...
 
Implementation Action Interface

Protected Attributes

std::unique_ptr< FrontendActionWrappedAction
 

Detailed Description

A frontend action which simply wraps some other runtime-specified frontend action.

Deriving from this class allows an action to inject custom logic around some existing action's behavior. It implements every virtual method in the FrontendAction interface by forwarding to the wrapped action.

Definition at line 305 of file FrontendAction.h.

Constructor & Destructor Documentation

◆ WrapperFrontendAction()

WrapperFrontendAction::WrapperFrontendAction ( std::unique_ptr< FrontendAction WrappedAction)

Construct a WrapperFrontendAction from an existing action, taking ownership of it.

Definition at line 1135 of file FrontendAction.cpp.

Member Function Documentation

◆ BeginInvocation()

bool WrapperFrontendAction::BeginInvocation ( CompilerInstance CI)
overrideprotectedvirtual

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 from clang::FrontendAction.

Reimplemented in clang::FixItRecompile.

Definition at line 1094 of file FrontendAction.cpp.

References WrappedAction.

◆ BeginSourceFileAction()

bool WrapperFrontendAction::BeginSourceFileAction ( CompilerInstance CI)
overrideprotectedvirtual

Callback at the start of processing a single input.

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

Reimplemented from clang::FrontendAction.

Definition at line 1097 of file FrontendAction.cpp.

References clang::FrontendAction::getCurrentInput(), Ret(), clang::FrontendAction::setCurrentInput(), and WrappedAction.

◆ CreateASTConsumer()

std::unique_ptr< ASTConsumer > WrapperFrontendAction::CreateASTConsumer ( CompilerInstance CI,
StringRef  InFile 
)
overrideprotectedvirtual

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.

Implements clang::FrontendAction.

Definition at line 1090 of file FrontendAction.cpp.

References WrappedAction.

Referenced by clang::arcmt::ObjCMigrateAction::CreateASTConsumer().

◆ EndSourceFile()

void WrapperFrontendAction::EndSourceFile ( )
overrideprotectedvirtual

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

Reimplemented from clang::FrontendAction.

Reimplemented in clang::IncrementalAction.

Definition at line 1108 of file FrontendAction.cpp.

References WrappedAction.

Referenced by clang::IncrementalAction::EndSourceFile().

◆ EndSourceFileAction()

void WrapperFrontendAction::EndSourceFileAction ( )
overrideprotectedvirtual

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 from clang::FrontendAction.

Definition at line 1109 of file FrontendAction.cpp.

References WrappedAction.

◆ ExecuteAction()

void WrapperFrontendAction::ExecuteAction ( )
overrideprotectedvirtual

Callback to run the program action, using the initialized compiler instance.

This is guaranteed to only be called between BeginSourceFileAction() and EndSourceFileAction().

Implements clang::FrontendAction.

Reimplemented in clang::IncrementalAction.

Definition at line 1105 of file FrontendAction.cpp.

References WrappedAction.

◆ getTranslationUnitKind()

TranslationUnitKind WrapperFrontendAction::getTranslationUnitKind ( )
overridevirtual

For AST-based actions, the kind of translation unit we're handling.

Reimplemented from clang::FrontendAction.

Reimplemented in clang::IncrementalAction.

Definition at line 1119 of file FrontendAction.cpp.

References WrappedAction.

◆ hasASTFileSupport()

bool WrapperFrontendAction::hasASTFileSupport ( ) const
overridevirtual

Does this action support use with AST files?

Reimplemented from clang::FrontendAction.

Definition at line 1125 of file FrontendAction.cpp.

References WrappedAction.

◆ hasCodeCompletionSupport()

bool WrapperFrontendAction::hasCodeCompletionSupport ( ) const
overridevirtual

Does this action support use with code completion?

Reimplemented from clang::FrontendAction.

Definition at line 1131 of file FrontendAction.cpp.

References WrappedAction.

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

◆ hasIRSupport()

bool WrapperFrontendAction::hasIRSupport ( ) const
overridevirtual

Does this action support use with IR files?

Reimplemented from clang::FrontendAction.

Definition at line 1128 of file FrontendAction.cpp.

References WrappedAction.

◆ hasPCHSupport()

bool WrapperFrontendAction::hasPCHSupport ( ) const
overridevirtual

Does this action support use with PCH?

Reimplemented from clang::FrontendAction.

Definition at line 1122 of file FrontendAction.cpp.

References WrappedAction.

◆ PrepareToExecuteAction()

bool WrapperFrontendAction::PrepareToExecuteAction ( CompilerInstance CI)
overrideprotectedvirtual

Prepare to execute the action on the given CompilerInstance.

This is called before executing the action on any inputs, and can modify the configuration as needed (including adjusting the input list).

Reimplemented from clang::FrontendAction.

Definition at line 1086 of file FrontendAction.cpp.

References WrappedAction.

◆ shouldEraseOutputFiles()

bool WrapperFrontendAction::shouldEraseOutputFiles ( )
overrideprotectedvirtual

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 from clang::FrontendAction.

Definition at line 1112 of file FrontendAction.cpp.

References WrappedAction.

◆ usesPreprocessorOnly()

bool WrapperFrontendAction::usesPreprocessorOnly ( ) const
overridevirtual

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.

Implements clang::FrontendAction.

Definition at line 1116 of file FrontendAction.cpp.

References WrappedAction.

Member Data Documentation

◆ WrappedAction

std::unique_ptr<FrontendAction> clang::WrapperFrontendAction::WrappedAction
protected

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