clang: clang::WrapperFrontendAction Class Reference (original) (raw)

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

#include "[clang/Frontend/FrontendAction.h](FrontendAction%5F8h%5Fsource.html)"

Public Member Functions
WrapperFrontendAction (std::unique_ptr< FrontendAction > WrappedAction)
Construct a WrapperFrontendAction from an existing action, taking ownership of it.
bool usesPreprocessorOnly () const override
Does this action only use the preprocessor?
TranslationUnitKind getTranslationUnitKind () override
For AST-based actions, the kind of translation unit we're handling.
bool hasPCHSupport () const override
Does this action support use with PCH?
bool hasASTFileSupport () const override
Does this action support use with AST files?
bool hasIRSupport () const override
Does this action support use with IR files?
bool hasCodeCompletionSupport () const override
Does this action support use with code completion?
- Public Member Functions inherited from clang::FrontendAction
FrontendAction ()
virtual ~FrontendAction ()
CompilerInstance & getCompilerInstance () const
void setCompilerInstance (CompilerInstance *Value)
bool isCurrentFileAST () const
const FrontendInputFile & getCurrentInput () const
StringRef getCurrentFile () const
StringRef getCurrentFileOrBufferName () 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)
virtual bool isModelParsingAction () const
Is this action invoked on a model file?
bool PrepareToExecute (CompilerInstance &CI)
Prepare the action to execute on the given compiler instance.
bool BeginSourceFile (CompilerInstance &CI, const FrontendInputFile &Input)
Prepare the action for processing the input file Input.
llvm::Error Execute ()
Set the source manager's main input file, and run the action.
Protected Member Functions
bool PrepareToExecuteAction (CompilerInstance &CI) override
Prepare to execute the action on the given CompilerInstance.
std::unique_ptr< ASTConsumer > CreateASTConsumer (CompilerInstance &CI, StringRef InFile) override
Create the AST consumer object for this action, if supported.
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.
bool BeginSourceFileAction (CompilerInstance &CI) override
Callback at the start of processing a single input.
void ExecuteAction () override
Callback to run the program action, using the initialized compiler instance.
void EndSourceFile () override
Perform any per-file post processing, deallocate per-file objects, and run statistics and output file cleanup code.
void EndSourceFileAction () override
Callback at the end of processing a single input.
bool shouldEraseOutputFiles () override
Callback at the end of processing a single input, to determine if the output files should be erased or not.
Implementation Action Interface

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 311 of file FrontendAction.h.

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

◆ BeginInvocation()

◆ BeginSourceFileAction()

◆ CreateASTConsumer()

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

◆ EndSourceFile()

void WrapperFrontendAction::EndSourceFile ( ) overrideprotectedvirtual

◆ 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 1221 of file FrontendAction.cpp.

References WrappedAction.

◆ ExecuteAction()

void WrapperFrontendAction::ExecuteAction ( ) overrideprotectedvirtual

◆ getTranslationUnitKind()

◆ hasASTFileSupport()

bool WrapperFrontendAction::hasASTFileSupport ( ) const overridevirtual

◆ hasCodeCompletionSupport()

bool WrapperFrontendAction::hasCodeCompletionSupport ( ) const overridevirtual

◆ hasIRSupport()

bool WrapperFrontendAction::hasIRSupport ( ) const overridevirtual

◆ hasPCHSupport()

bool WrapperFrontendAction::hasPCHSupport ( ) const overridevirtual

◆ PrepareToExecuteAction()

bool WrapperFrontendAction::PrepareToExecuteAction ( CompilerInstance & CI) overrideprotectedvirtual

◆ 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 1224 of file FrontendAction.cpp.

References WrappedAction.

◆ usesPreprocessorOnly()

bool WrapperFrontendAction::usesPreprocessorOnly ( ) const overridevirtual

◆ WrappedAction

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

Definition at line 313 of file FrontendAction.h.

Referenced by BeginInvocation(), BeginSourceFileAction(), CreateASTConsumer(), EndSourceFile(), EndSourceFileAction(), ExecuteAction(), getTranslationUnitKind(), clang::IncrementalAction::getWrapped(), hasASTFileSupport(), hasCodeCompletionSupport(), hasIRSupport(), hasPCHSupport(), PrepareToExecuteAction(), shouldEraseOutputFiles(), and usesPreprocessorOnly().

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