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

#include "/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/Interpreter/IncrementalAction.h"

Inheritance diagram for clang::IncrementalAction:

Public Member Functions
	IncrementalAction (CompilerInstance &Instance, llvm::LLVMContext &LLVMCtx, llvm::Error &Err, Interpreter &I, std::unique_ptr< ASTConsumer > Consumer=nullptr)

FrontendAction *	getWrapped () const

TranslationUnitKind	getTranslationUnitKind () override
	For AST-based actions, the kind of translation unit we're handling.

std::unique_ptr< ASTConsumer >	CreateASTConsumer (CompilerInstance &CI, StringRef InFile) override
	Create the AST consumer object for this action, if supported.

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	FinalizeAction ()

void	CacheCodeGenModule ()
	Cache the current CodeGen module to preserve internal references.

llvm::Module *	getCachedCodeGenModule () const
	Access the cached CodeGen module.

CodeGenerator *	getCodeGen () const
	Access the current code generator.

std::unique_ptr< llvm::Module >	GenModule ()
	Generate an LLVM module for the most recent parsed input.

Public Member Functions inherited from clang::WrapperFrontendAction
	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.

Additional Inherited Members
Protected Member Functions inherited from clang::WrapperFrontendAction
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
Protected Attributes inherited from clang::WrapperFrontendAction
std::unique_ptr< FrontendAction >	WrappedAction

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 33 of file IncrementalAction.h.

Constructor & Destructor Documentation

◆ IncrementalAction()

clang::IncrementalAction::IncrementalAction	(	CompilerInstance &	Instance,
		llvm::LLVMContext &	LLVMCtx,
		llvm::Error &	Err,
		Interpreter &	I,
		std::unique_ptr< ASTConsumer >	Consumer = `nullptr`
	)

Definition at line 25 of file IncrementalAction.cpp.

References clang::frontend::ASTDump, clang::frontend::ASTPrint, clang::CreateFrontendAction(), clang::frontend::EmitAssembly, clang::frontend::EmitBC, clang::frontend::EmitLLVMOnly, clang::frontend::EmitObj, clang::frontend::ParseSyntaxOnly, clang::frontend::PluginAction, and clang::frontend::PrintPreprocessedInput.

Member Function Documentation

◆ CacheCodeGenModule()

void clang::IncrementalAction::CacheCodeGenModule ( )

Cache the current CodeGen module to preserve internal references.

Definition at line 90 of file IncrementalAction.cpp.

References GenModule().

◆ CreateASTConsumer()

std::unique_ptr< ASTConsumer > clang::IncrementalAction::CreateASTConsumer	(	CompilerInstance &	CI,
		StringRef	InFile
	)

overridevirtual

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