clang  6.0.0svn
Public Member Functions | Protected Member Functions | List of all members
clang::DumpModuleInfoAction Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for clang::DumpModuleInfoAction:
Collaboration graph
[legend]

Public Member Functions

bool hasPCHSupport () const override
 Does this action support use with PCH? More...
 
bool hasASTFileSupport () const override
 Does this action support use with AST files? More...
 
bool hasIRSupport () const override
 Does this action support use with IR files? More...
 
bool hasCodeCompletionSupport () const override
 Does this action support use with code completion? More...
 
- Public Member Functions inherited from clang::ASTFrontendAction
 ASTFrontendAction ()
 
bool usesPreprocessorOnly () const override
 Does this action only use the preprocessor? More...
 
- Public Member Functions inherited from clang::FrontendAction
 FrontendAction ()
 
virtual ~FrontendAction ()
 
CompilerInstancegetCompilerInstance () const
 
void setCompilerInstance (CompilerInstance *Value)
 
bool isCurrentFileAST () const
 
const FrontendInputFilegetCurrentInput () const
 
const StringRef getCurrentFile () const
 
InputKind getCurrentFileKind () const
 
ASTUnitgetCurrentASTUnit () const
 
ModulegetCurrentModule () const
 
std::unique_ptr< ASTUnittakeCurrentASTUnit ()
 
void setCurrentInput (const FrontendInputFile &CurrentInput, std::unique_ptr< ASTUnit > AST=nullptr)
 
virtual bool isModelParsingAction () const
 Is this action invoked on a model file? More...
 
virtual TranslationUnitKind getTranslationUnitKind ()
 For AST-based actions, the kind of translation unit we're handling. More...
 
bool BeginSourceFile (CompilerInstance &CI, const FrontendInputFile &Input)
 Prepare the action for processing the input file Input. More...
 
bool Execute ()
 Set the source manager's main input file, and run the action. More...
 
void EndSourceFile ()
 Perform any per-file post processing, deallocate per-file objects, and run statistics and output file cleanup code. More...
 

Protected Member Functions

std::unique_ptr< ASTConsumerCreateASTConsumer (CompilerInstance &CI, StringRef InFile) override
 Create the AST consumer object for this action, if supported. More...
 
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. More...
 
void ExecuteAction () override
 Implement the ExecuteAction interface by running Sema on the already-initialized AST consumer. More...
 
- Protected Member Functions inherited from clang::FrontendAction
virtual bool BeginSourceFileAction (CompilerInstance &CI)
 Callback at the start of processing a single input. More...
 
virtual void EndSourceFileAction ()
 Callback at the end of processing a single input. More...
 
virtual bool shouldEraseOutputFiles ()
 Callback at the end of processing a single input, to determine if the output files should be erased or not. More...
 

Detailed Description

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

Definition at line 145 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 413 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 234 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 420 of file FrontendActions.cpp.

References clang::FrontendAction::getCompilerInstance(), clang::FrontendAction::getCurrentFile(), clang::CompilerInstance::getFileManager(), clang::CompilerInstance::getFrontendOpts(), and clang::FrontendOptions::OutputFile.

◆ hasASTFileSupport()

bool clang::DumpModuleInfoAction::hasASTFileSupport ( ) const
inlineoverridevirtual

Does this action support use with AST files?

Reimplemented from clang::FrontendAction.

Definition at line 154 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 156 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 155 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 153 of file FrontendActions.h.


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