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

Frontend action adaptor that merges ASTs together. More...

#include "clang/Frontend/FrontendActions.h"

Inheritance diagram for clang::ASTMergeAction:
Inheritance graph
[legend]
Collaboration diagram for clang::ASTMergeAction:
Collaboration graph
[legend]

Public Member Functions

 ASTMergeAction (std::unique_ptr< FrontendAction > AdaptedAction, ArrayRef< std::string > ASTFiles)
 
 ~ASTMergeAction () override
 
bool usesPreprocessorOnly () const override
 Does this action only use the preprocessor? More...
 
TranslationUnitKind getTranslationUnitKind () override
 For AST-based actions, the kind of translation unit we're handling. More...
 
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 hasCodeCompletionSupport () const override
 Does this action support use with code completion? 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 bool hasIRSupport () const
 Does this action support use with IR files? 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 BeginSourceFileAction (CompilerInstance &CI) override
 Callback at the start of processing a single input. More...
 
void ExecuteAction () override
 Callback to run the program action, using the initialized compiler instance. More...
 
void EndSourceFileAction () override
 Callback at the end of processing a single input. More...
 
- Protected Member Functions inherited from clang::FrontendAction
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. 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

Frontend action adaptor that merges ASTs together.

This action takes an existing AST file and "merges" it into the AST context, producing a merged context. This action is an action adaptor, which forwards most of its calls to another action that will consume the merged context.

Definition at line 173 of file FrontendActions.h.

Constructor & Destructor Documentation

◆ ASTMergeAction()

ASTMergeAction::ASTMergeAction ( std::unique_ptr< FrontendAction AdaptedAction,
ArrayRef< std::string >  ASTFiles 
)

Definition at line 85 of file ASTMerge.cpp.

◆ ~ASTMergeAction()

ASTMergeAction::~ASTMergeAction ( )
override

Definition at line 91 of file ASTMerge.cpp.

Member Function Documentation

◆ BeginSourceFileAction()

bool ASTMergeAction::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 24 of file ASTMerge.cpp.

References clang::FrontendAction::getCurrentInput(), and clang::FrontendAction::takeCurrentASTUnit().

◆ CreateASTConsumer()

std::unique_ptr< ASTConsumer > ASTMergeAction::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 20 of file ASTMerge.cpp.

◆ EndSourceFileAction()

void ASTMergeAction::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 81 of file ASTMerge.cpp.

◆ ExecuteAction()

void ASTMergeAction::ExecuteAction ( )
overrideprotectedvirtual

◆ getTranslationUnitKind()

TranslationUnitKind ASTMergeAction::getTranslationUnitKind ( )
overridevirtual

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

Reimplemented from clang::FrontendAction.

Definition at line 98 of file ASTMerge.cpp.

◆ hasASTFileSupport()

bool ASTMergeAction::hasASTFileSupport ( ) const
overridevirtual

Does this action support use with AST files?

Reimplemented from clang::FrontendAction.

Definition at line 106 of file ASTMerge.cpp.

◆ hasCodeCompletionSupport()

bool ASTMergeAction::hasCodeCompletionSupport ( ) const
overridevirtual

Does this action support use with code completion?

Reimplemented from clang::FrontendAction.

Definition at line 110 of file ASTMerge.cpp.

◆ hasPCHSupport()

bool ASTMergeAction::hasPCHSupport ( ) const
overridevirtual

Does this action support use with PCH?

Reimplemented from clang::FrontendAction.

Definition at line 102 of file ASTMerge.cpp.

◆ usesPreprocessorOnly()

bool ASTMergeAction::usesPreprocessorOnly ( ) const
overridevirtual

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 94 of file ASTMerge.cpp.


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