clang 20.0.0git
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
clang::CodeGenAction Class Reference

#include "clang/CodeGen/CodeGenAction.h"

Inheritance diagram for clang::CodeGenAction:
Inheritance graph
[legend]

Public Member Functions

 ~CodeGenAction () override
 
std::unique_ptr< llvm::Module > takeModule ()
 Take the generated LLVM module, for use after the action has been run.
 
llvm::LLVMContext * takeLLVMContext ()
 Take the LLVM context used by this action.
 
CodeGeneratorgetCodeGenerator () const
 
- 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 ()
 
CompilerInstancegetCompilerInstance () const
 
void setCompilerInstance (CompilerInstance *Value)
 
bool isCurrentFileAST () const
 
const FrontendInputFilegetCurrentInput () const
 
StringRef getCurrentFile () const
 
StringRef getCurrentFileOrBufferName () 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?
 
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 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.
 

Public Attributes

BackendConsumerBEConsumer = nullptr
 

Protected Member Functions

bool BeginSourceFileAction (CompilerInstance &CI) override
 Callback at the start of processing a single input.
 
 CodeGenAction (unsigned _Act, llvm::LLVMContext *_VMContext=nullptr)
 Create a new code generation action.
 
bool hasIRSupport () const override
 Does this action support use with IR files?
 
std::unique_ptr< ASTConsumerCreateASTConsumer (CompilerInstance &CI, StringRef InFile) override
 Create the AST consumer object for this action, if supported.
 
void ExecuteAction () override
 Callback to run the program action, using the initialized compiler instance.
 
void EndSourceFileAction () override
 Callback at the end of processing a single input.
 
- 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 shouldEraseOutputFiles ()
 Callback at the end of processing a single input, to determine if the output files should be erased or not.
 

Friends

class BackendConsumer
 

Detailed Description

Definition at line 24 of file CodeGenAction.h.

Constructor & Destructor Documentation

◆ CodeGenAction()

CodeGenAction::CodeGenAction ( unsigned  _Act,
llvm::LLVMContext *  _VMContext = nullptr 
)
protected

Create a new code generation action.

If the optional _VMContext parameter is supplied, the action uses it without taking ownership, otherwise it creates a fresh LLVM context and takes ownership.

Definition at line 908 of file CodeGenAction.cpp.

◆ ~CodeGenAction()

CodeGenAction::~CodeGenAction ( )
override

Definition at line 912 of file CodeGenAction.cpp.

Member Function Documentation

◆ BeginSourceFileAction()

bool CodeGenAction::BeginSourceFileAction ( CompilerInstance CI)
overrideprotectedvirtual

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 972 of file CodeGenAction.cpp.

References clang::LangOptionsBase::CMK_ModuleInterface, clang::FrontendOptions::GenReducedBMI, clang::CompilerInstance::getFrontendOpts(), and clang::CompilerInstance::getLangOpts().

◆ CreateASTConsumer()

std::unique_ptr< ASTConsumer > CodeGenAction::CreateASTConsumer ( CompilerInstance CI,
StringRef  InFile 
)
overrideprotectedvirtual

◆ EndSourceFileAction()

void CodeGenAction::EndSourceFileAction ( )
overrideprotectedvirtual

Callback at the end of processing a single input.

This is guaranteed to only be called following a successful call to BeginSourceFileAction (and BeginSourceFile).

Reimplemented from clang::FrontendAction.

Definition at line 950 of file CodeGenAction.cpp.

References BEConsumer, clang::FrontendAction::getCompilerInstance(), and clang::BackendConsumer::takeModule().

◆ ExecuteAction()

void CodeGenAction::ExecuteAction ( )
overrideprotectedvirtual

◆ getCodeGenerator()

CodeGenerator * CodeGenAction::getCodeGenerator ( ) const

Definition at line 968 of file CodeGenAction.cpp.

References BEConsumer, and clang::BackendConsumer::getCodeGenerator().

◆ hasIRSupport()

bool CodeGenAction::hasIRSupport ( ) const
overrideprotectedvirtual

Does this action support use with IR files?

Reimplemented from clang::FrontendAction.

Definition at line 948 of file CodeGenAction.cpp.

◆ takeLLVMContext()

llvm::LLVMContext * CodeGenAction::takeLLVMContext ( )

Take the LLVM context used by this action.

Definition at line 963 of file CodeGenAction.cpp.

◆ takeModule()

std::unique_ptr< llvm::Module > CodeGenAction::takeModule ( )

Take the generated LLVM module, for use after the action has been run.

The result may be null on failure.

Definition at line 959 of file CodeGenAction.cpp.

Friends And Related Function Documentation

◆ BackendConsumer

friend class BackendConsumer
friend

Definition at line 27 of file CodeGenAction.h.

Referenced by CreateASTConsumer().

Member Data Documentation

◆ BEConsumer

BackendConsumer* clang::CodeGenAction::BEConsumer = nullptr

Definition at line 88 of file CodeGenAction.h.

Referenced by CreateASTConsumer(), EndSourceFileAction(), and getCodeGenerator().


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