Dump information about the given module file, to be used for basic debugging and discovery. More...

#include "clang/Frontend/FrontendActions.h"

Inheritance diagram for clang::DumpModuleInfoAction:

Public Member Functions
	DumpModuleInfoAction ()=default

	DumpModuleInfoAction (std::shared_ptr< llvm::raw_ostream > Out)

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

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.

Protected Member Functions
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.

void	ExecuteAction () override
	Implement the ExecuteAction interface by running Sema on the already-initialized AST consumer.

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

Dump information about the given module file, to be used for basic debugging and discovery.

Definition at line 199 of file FrontendActions.h.

Constructor & Destructor Documentation

◆ DumpModuleInfoAction() [1/2]

clang::DumpModuleInfoAction::DumpModuleInfoAction ( )

default

◆ DumpModuleInfoAction() [2/2]

clang::DumpModuleInfoAction::DumpModuleInfoAction ( std::shared_ptr< llvm::raw_ostream > Out )

inlineexplicit

Definition at line 211 of file FrontendActions.h.

Member Function Documentation

◆ BeginInvocation()

bool DumpModuleInfoAction::BeginInvocation ( CompilerInstance & CI )

overrideprotectedvirtual

Callback before starting processing a single input, giving the opportunity to modify the CompilerInvocation or do some other action before BeginSourceFileAction is called.

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

Reimplemented from clang::FrontendAction.

Definition at line 817 of file FrontendActions.cpp.

References clang::CompilerInstance::getHeaderSearchOpts(), and clang::HeaderSearchOptions::ModuleFormat.

◆ CreateASTConsumer()

std::unique_ptr< ASTConsumer > DumpModuleInfoAction::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 329 of file FrontendActions.cpp.

◆ ExecuteAction()

void DumpModuleInfoAction::ExecuteAction ( )

overrideprotectedvirtual

Implement the ExecuteAction interface by running Sema on the already-initialized AST consumer.

This will also take care of instantiating a code completion consumer if the user requested it and the action supports it.

Reimplemented from clang::ASTFrontendAction.

Definition at line 848 of file FrontendActions.cpp.

References clang::LangOptions::CurrentModule, clang::Module::Exports, clang::ASTUnit::getASTReader(), clang::FileManager::getBufferForFile(), clang::FrontendAction::getCompilerInstance(), clang::FrontendAction::getCurrentASTUnit(), clang::FrontendAction::getCurrentFile(), clang::CompilerInstance::getDiagnostics(), clang::CompilerInstance::getFileManager(), clang::CompilerInstance::getFrontendOpts(), clang::ASTUnit::getLangOpts(), clang::ASTReader::getModule(), clang::CompilerInstance::getModuleCache(), clang::ASTReader::getModuleManager(), clang::CompilerInstance::getPCHContainerReader(), clang::CompilerInstance::getPreprocessor(), clang::ASTReader::getPreprocessor(), clang::serialization::ModuleManager::getPrimaryModule(), clang::ASTReader::getTotalNumSubmodules(), clang::Module::Imports, clang::FrontendAction::isCurrentFileAST(), clang::Module::Kind, Kind, clang::Preprocessor::macros(), ModuleKindName(), clang::serialization::ModuleFile::ModuleName, clang::HeaderSearchOptions::ModulesValidateDiagnosticOptions, clang::Module::Name, clang::FrontendOptions::OutputFile, clang::ASTReader::readASTFileControlBlock(), clang::DiagnosticsEngine::Report(), SM, and clang::Module::submodules().

◆ hasASTFileSupport()

bool clang::DumpModuleInfoAction::hasASTFileSupport ( ) const

inlineoverridevirtual

Does this action support use with AST files?

Reimplemented from clang::FrontendAction.

Definition at line 214 of file FrontendActions.h.

◆ hasCodeCompletionSupport()

bool clang::DumpModuleInfoAction::hasCodeCompletionSupport ( ) const

inlineoverridevirtual

Does this action support use with code completion?

Reimplemented from clang::FrontendAction.

Definition at line 216 of file FrontendActions.h.

◆ hasIRSupport()

bool clang::DumpModuleInfoAction::hasIRSupport ( ) const

inlineoverridevirtual

Does this action support use with IR files?

Reimplemented from clang::FrontendAction.

Definition at line 215 of file FrontendActions.h.

◆ hasPCHSupport()

bool clang::DumpModuleInfoAction::hasPCHSupport ( ) const

inlineoverridevirtual

Does this action support use with PCH?

Reimplemented from clang::FrontendAction.

Definition at line 213 of file FrontendActions.h.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DumpModuleInfoAction() [1/2]

◆ DumpModuleInfoAction() [2/2]

Member Function Documentation

◆ BeginInvocation()

◆ CreateASTConsumer()

◆ ExecuteAction()

◆ hasASTFileSupport()

◆ hasCodeCompletionSupport()

◆ hasIRSupport()

◆ hasPCHSupport()