clang  16.0.0git
Public Member Functions | List of all members
clang::IncrementalAction Class Reference

A custom action enabling the incremental processing functionality. More...

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

Public Member Functions

 IncrementalAction (CompilerInstance &CI, llvm::LLVMContext &LLVMCtx, llvm::Error &Err)
 
FrontendActiongetWrapped () const
 
TranslationUnitKind getTranslationUnitKind () override
 For AST-based actions, the kind of translation unit we're handling. 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 FinalizeAction ()
 
- Public Member Functions inherited from clang::WrapperFrontendAction
 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...
 
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...
 

Additional Inherited Members

- Protected Member Functions inherited from clang::WrapperFrontendAction
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 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 inherited from clang::WrapperFrontendAction
std::unique_ptr< FrontendActionWrappedAction
 

Detailed Description

A custom action enabling the incremental processing functionality.

The usual FrontendAction expects one call to ExecuteAction and once it sees a call to EndSourceFile it deletes some of the important objects such as Preprocessor and Sema assuming no further input will come.

IncrementalAction ensures it keep its underlying action's objects alive as long as the IncrementalParser needs them.

Definition at line 43 of file IncrementalParser.cpp.

Constructor & Destructor Documentation

◆ IncrementalAction()

clang::IncrementalAction::IncrementalAction ( CompilerInstance CI,
llvm::LLVMContext &  LLVMCtx,
llvm::Error &  Err 
)
inline

Member Function Documentation

◆ EndSourceFile()

void clang::IncrementalAction::EndSourceFile ( )
inlineoverridevirtual

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

Reimplemented from clang::WrapperFrontendAction.

Definition at line 113 of file IncrementalParser.cpp.

References clang::WrapperFrontendAction::EndSourceFile(), and getWrapped().

Referenced by FinalizeAction().

◆ ExecuteAction()

void clang::IncrementalAction::ExecuteAction ( )
inlineoverridevirtual

◆ FinalizeAction()

void clang::IncrementalAction::FinalizeAction ( )
inline

Definition at line 119 of file IncrementalParser.cpp.

References EndSourceFile().

◆ getTranslationUnitKind()

TranslationUnitKind clang::IncrementalAction::getTranslationUnitKind ( )
inlineoverridevirtual

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

Reimplemented from clang::WrapperFrontendAction.

Definition at line 85 of file IncrementalParser.cpp.

References clang::TU_Incremental.

Referenced by ExecuteAction().

◆ getWrapped()

FrontendAction* clang::IncrementalAction::getWrapped ( ) const
inline

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