#include "clang/Frontend/FrontendAction.h"

Inheritance diagram for clang::PluginASTAction:

Public Types
enum	ActionType { CmdlineBeforeMainAction , CmdlineAfterMainAction , ReplaceAction , AddBeforeMainAction , AddAfterMainAction }

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

virtual bool	ParseArgs (const CompilerInstance &CI, const std::vector< std::string > &arg)=0
	Parse the given plugin command line arguments.

virtual ActionType	getActionType ()
	Get the action type for this plugin.

Public Member Functions inherited from clang::ASTFrontendAction
	ASTFrontendAction ()

bool	usesPreprocessorOnly () const override
	Does this action only use the preprocessor?

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?

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

virtual bool	hasPCHSupport () const
	Does this action support use with PCH?

virtual bool	hasASTFileSupport () const
	Does this action support use with AST files?

virtual bool	hasIRSupport () const
	Does this action support use with IR files?

virtual bool	hasCodeCompletionSupport () const
	Does this action support use with code completion?

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.

virtual void	EndSourceFile ()
	Perform any per-file post processing, deallocate per-file objects, and run statistics and output file cleanup code.

Additional Inherited Members
Protected Member Functions inherited from clang::ASTFrontendAction
void	ExecuteAction () override
	Implement the ExecuteAction interface by running Sema on the already-initialized AST consumer.

Protected Member Functions inherited from clang::FrontendAction
virtual bool	PrepareToExecuteAction (CompilerInstance &CI)
	Prepare to execute the action on the given CompilerInstance.

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.

virtual bool	BeginSourceFileAction (CompilerInstance &CI)
	Callback at the start of processing a single input.

virtual void	EndSourceFileAction ()
	Callback at the end of processing a single input.

virtual bool	shouldEraseOutputFiles ()
	Callback at the end of processing a single input, to determine if the output files should be erased or not.

Detailed Description

Definition at line 257 of file FrontendAction.h.

Member Enumeration Documentation

◆ ActionType

enum clang::PluginASTAction::ActionType

Enumerator
CmdlineBeforeMainAction	Execute the action before the main action if on the command line.
CmdlineAfterMainAction	Execute the action after the main action if on the command line.
ReplaceAction	Replace the main action.
AddBeforeMainAction	Execute the action before the main action.
AddAfterMainAction	Execute the action after the main action.

Definition at line 272 of file FrontendAction.h.

Member Function Documentation

◆ CreateASTConsumer()

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

overridepure 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.

Implements clang::FrontendAction.

◆ getActionType()

virtual ActionType clang::PluginASTAction::getActionType ( )

inlinevirtual

Get the action type for this plugin.

Returns: The action type. By default we use CmdlineAfterMainAction.

Definition at line 284 of file FrontendAction.h.

References CmdlineAfterMainAction.

◆ ParseArgs()

virtual bool clang::PluginASTAction::ParseArgs	(	const CompilerInstance &	CI,
		const std::vector< std::string > &	arg
	)

pure virtual

Parse the given plugin command line arguments.

Parameters

CI	- The compiler instance, for use in reporting diagnostics.

Returns: True if the parsing succeeded; otherwise the plugin will be destroyed and no action run. The plugin is responsible for using the CompilerInstance's Diagnostic object to report errors.

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

include/clang/Frontend/FrontendAction.h
lib/Frontend/FrontendAction.cpp

Public Types

Public Member Functions