class FindSymbolOccurrencesRefactoringRule

Declaration

class FindSymbolOccurrencesRefactoringRule
    : public RefactoringActionRuleBase { /* full declaration omitted */ };

Description

A type of refactoring action rule that finds a set of symbol occurrences that reference a particular symbol. This action rule is typically used for an interactive rename that allows users to specify the new name and the set of selected occurrences during the refactoring.

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringActionRules.h:74

Inherits from: RefactoringActionRuleBase

Method Overview

• private virtual Expected<clang::tooling::SymbolOccurrences> findSymbolOccurrences(clang::tooling::RefactoringRuleContext & Context)
• public void invoke(clang::tooling::RefactoringResultConsumer & Consumer, clang::tooling::RefactoringRuleContext & Context)

Inherited from RefactoringActionRuleBase:

• public invoke

Methods

¶virtual Expected<
    clang::tooling::SymbolOccurrences>
findSymbolOccurrences(
    clang::tooling::RefactoringRuleContext&
        Context)

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringActionRules.h:87

Parameters

clang::tooling::RefactoringRuleContext& Context

¶void invoke(
    clang::tooling::RefactoringResultConsumer&
        Consumer,
    clang::tooling::RefactoringRuleContext&
        Context)

Description

Initiates and performs a specific refactoring action. The specific rule will invoke an appropriate \c handle method on a consumer to propagate the result of the refactoring action.

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringActionRules.h:76

Parameters

clang::tooling::RefactoringResultConsumer& Consumer

clang::tooling::RefactoringRuleContext& Context