#include "clang/Frontend/FrontendActions.h"

Inheritance diagram for clang::PrintPreambleAction:

Protected Member Functions
void	ExecuteAction () override
	Callback to run the program action, using the initialized compiler instance.

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

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

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.

Additional Inherited Members
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.

Detailed Description

Definition at line 274 of file FrontendActions.h.

Member Function Documentation

◆ CreateASTConsumer()

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

inlineoverrideprotectedvirtual

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 277 of file FrontendActions.h.

◆ ExecuteAction()

void PrintPreambleAction::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.

Definition at line 1094 of file FrontendActions.cpp.

References clang::Asm, clang::C, clang::CIR, clang::Lexer::ComputePreamble(), clang::CUDA, clang::CXX, clang::FileManager::getBufferForFile(), clang::FrontendAction::getCompilerInstance(), clang::FrontendAction::getCurrentFile(), clang::FrontendAction::getCurrentFileKind(), clang::CompilerInstance::getFileManager(), clang::CompilerInstance::getLangOpts(), clang::HIP, clang::HLSL, clang::LLVM_IR, clang::ObjC, clang::ObjCXX, clang::OpenCL, clang::OpenCLCXX, clang::Preamble, clang::PreambleBounds::Size, and clang::Unknown.

◆ usesPreprocessorOnly()

bool clang::PrintPreambleAction::usesPreprocessorOnly ( ) const

inlineoverrideprotectedvirtual

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 282 of file FrontendActions.h.

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

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

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateASTConsumer()

◆ ExecuteAction()

◆ usesPreprocessorOnly()