#include "clang/Frontend/FrontendActions.h"

Inheritance diagram for clang::GeneratePCHAction:

Public Member Functions
bool	BeginSourceFileAction (CompilerInstance &CI) override
	Callback at the start of processing a single input.

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 bool	hasPCHSupport () const
	Does this action support use with PCH?

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.

Static Public Member Functions
static bool	ComputeASTConsumerArguments (CompilerInstance &CI, std::string &Sysroot)
	Compute the AST consumer arguments that will be used to create the PCHGenerator instance returned by CreateASTConsumer.

static std::unique_ptr< llvm::raw_pwrite_stream >	CreateOutputFile (CompilerInstance &CI, StringRef InFile, std::string &OutputFile)
	Creates file to write the PCH into and returns a stream to write it into.

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

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

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

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

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 void	EndSourceFileAction ()
	Callback at the end of processing a single input.

Detailed Description

Definition at line 86 of file FrontendActions.h.

Member Function Documentation

◆ BeginSourceFileAction()

bool GeneratePCHAction::BeginSourceFileAction ( CompilerInstance & CI )

overridevirtual

Callback at the start of processing a single input.

Returns: True on success; on failure ExecutionAction() and EndSourceFileAction() will not be called.

Reimplemented from clang::FrontendAction.

Definition at line 183 of file FrontendActions.cpp.

References clang::CompilerInstance::getLangOpts().

◆ ComputeASTConsumerArguments()

bool GeneratePCHAction::ComputeASTConsumerArguments	(	CompilerInstance &	CI,
		std::string &	Sysroot
	)

static

Compute the AST consumer arguments that will be used to create the PCHGenerator instance returned by CreateASTConsumer.

Returns: false if an error occurred, true otherwise.

Definition at line 153 of file FrontendActions.cpp.

References clang::CompilerInstance::getDiagnostics(), clang::CompilerInstance::getFrontendOpts(), clang::CompilerInstance::getHeaderSearchOpts(), clang::FrontendOptions::RelocatablePCH, clang::DiagnosticsEngine::Report(), and clang::HeaderSearchOptions::Sysroot.

Referenced by CreateASTConsumer().

◆ CreateASTConsumer()

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

overrideprotectedvirtual

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 124 of file FrontendActions.cpp.

References clang::PreprocessorOptions::AllowPCHWithCompilerErrors, ComputeASTConsumerArguments(), CreateOutputFile(), clang::PCHContainerWriter::CreatePCHContainerGenerator(), clang::CompilerInstance::getFrontendOpts(), clang::CompilerInstance::getLangOpts(), clang::CompilerInstance::getModuleCache(), clang::CompilerInstance::getPCHContainerWriter(), clang::CompilerInstance::getPreprocessor(), clang::CompilerInstance::getPreprocessorOpts(), and clang::FrontendOptions::RelocatablePCH.

◆ CreateOutputFile()

std::unique_ptr< llvm::raw_pwrite_stream > GeneratePCHAction::CreateOutputFile	(	CompilerInstance &	CI,
		StringRef	InFile,
		std::string &	OutputFile
	)

static

Creates file to write the PCH into and returns a stream to write it into.

On error, returns null.

Definition at line 165 of file FrontendActions.cpp.

References clang::CompilerInstance::createDefaultOutputFile(), clang::CompilerInstance::getFrontendOpts(), and clang::FrontendOptions::OutputFile.

Referenced by CreateASTConsumer().

◆ getTranslationUnitKind()

TranslationUnitKind clang::GeneratePCHAction::getTranslationUnitKind ( )

inlineoverrideprotectedvirtual

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

Reimplemented from clang::FrontendAction.

Definition at line 91 of file FrontendActions.h.

References clang::TU_Prefix.

◆ hasASTFileSupport()

bool clang::GeneratePCHAction::hasASTFileSupport ( ) const

inlineoverrideprotectedvirtual

Does this action support use with AST files?

Reimplemented from clang::FrontendAction.

Definition at line 95 of file FrontendActions.h.

◆ shouldEraseOutputFiles()

bool GeneratePCHAction::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 177 of file FrontendActions.cpp.

References clang::FrontendAction::getCompilerInstance(), and clang::FrontendAction::shouldEraseOutputFiles().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ BeginSourceFileAction()

◆ ComputeASTConsumerArguments()

◆ CreateASTConsumer()

◆ CreateOutputFile()

◆ getTranslationUnitKind()

◆ hasASTFileSupport()

◆ shouldEraseOutputFiles()