clang 20.0.0git
Public Member Functions | Protected Member Functions | List of all members
clang::PreprocessorFrontendAction Class Reference

Abstract base class to use for preprocessor-based frontend actions. More...

#include "clang/Frontend/FrontendAction.h"

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

Public Member Functions

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

Protected Member Functions

std::unique_ptr< ASTConsumerCreateASTConsumer (CompilerInstance &CI, StringRef InFile) override
 Provide a default implementation which returns aborts; this method should never be called by FrontendAction clients.
 
- 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 ExecuteAction ()=0
 Callback to run the program action, using the initialized compiler instance.
 
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

Abstract base class to use for preprocessor-based frontend actions.

Definition at line 288 of file FrontendAction.h.

Member Function Documentation

◆ CreateASTConsumer()

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

Provide a default implementation which returns aborts; this method should never be called by FrontendAction clients.

Implements clang::FrontendAction.

Definition at line 1199 of file FrontendAction.cpp.

◆ usesPreprocessorOnly()

bool clang::PreprocessorFrontendAction::usesPreprocessorOnly ( ) const
inlineoverridevirtual

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 296 of file FrontendAction.h.


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