clang 20.0.0git
Public Member Functions | List of all members
clang::tooling::RefactoringResultConsumer Class Referenceabstract

An abstract interface that consumes the various refactoring results that can be produced by refactoring actions. More...

#include "clang/Tooling/Refactoring/RefactoringResultConsumer.h"

Public Member Functions

virtual ~RefactoringResultConsumer ()
 
virtual void handleError (llvm::Error Err)=0
 Handles an initiation or an invication error.
 
virtual void handle (AtomicChanges SourceReplacements)
 Handles the source replacements that are produced by a refactoring action.
 
virtual void handle (SymbolOccurrences Occurrences)
 Handles the symbol occurrences that are found by an interactive refactoring action.
 

Detailed Description

An abstract interface that consumes the various refactoring results that can be produced by refactoring actions.

A valid refactoring result must be handled by a handle method.

Definition at line 24 of file RefactoringResultConsumer.h.

Constructor & Destructor Documentation

◆ ~RefactoringResultConsumer()

virtual clang::tooling::RefactoringResultConsumer::~RefactoringResultConsumer ( )
inlinevirtual

Definition at line 26 of file RefactoringResultConsumer.h.

Member Function Documentation

◆ handle() [1/2]

virtual void clang::tooling::RefactoringResultConsumer::handle ( AtomicChanges  SourceReplacements)
inlinevirtual

Handles the source replacements that are produced by a refactoring action.

Definition at line 33 of file RefactoringResultConsumer.h.

◆ handle() [2/2]

virtual void clang::tooling::RefactoringResultConsumer::handle ( SymbolOccurrences  Occurrences)
inlinevirtual

Handles the symbol occurrences that are found by an interactive refactoring action.

Definition at line 39 of file RefactoringResultConsumer.h.

◆ handleError()

virtual void clang::tooling::RefactoringResultConsumer::handleError ( llvm::Error  Err)
pure virtual

Handles an initiation or an invication error.

An initiation error typically has a DiagnosticError payload that describes why initiation failed.

Referenced by clang::tooling::internal::invokeRuleAfterValidatingRequirements().


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