clang  6.0.0svn
Public Member Functions | Protected Member Functions | List of all members
clang::tooling::RefactoringAction Class Referenceabstract

A refactoring action is a class that defines a set of related refactoring action rules. More...

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

Public Member Functions

virtual ~RefactoringAction ()
 
virtual StringRef getCommand () const =0
 Returns the name of the subcommand that's used by clang-refactor for this action. More...
 
virtual StringRef getDescription () const =0
 
RefactoringActionRules createActiveActionRules ()
 

Protected Member Functions

virtual RefactoringActionRules createActionRules () const =0
 Returns a set of refactoring actions rules that are defined by this action. More...
 

Detailed Description

A refactoring action is a class that defines a set of related refactoring action rules.

These rules get grouped under a common umbrella - a single clang-refactor subcommand.

A subclass of RefactoringAction is responsible for creating the set of grouped refactoring action rules that represent one refactoring operation. Although the rules in one action may have a number of different implementations, they should strive to produce a similar result. It should be easy for users to identify which refactoring action produced the result regardless of which refactoring action rule was used.

The distinction between actions and rules enables the creation of action that uses very different rules, for example:

Definition at line 40 of file RefactoringAction.h.

Constructor & Destructor Documentation

◆ ~RefactoringAction()

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

Member Function Documentation

◆ createActionRules()

virtual RefactoringActionRules clang::tooling::RefactoringAction::createActionRules ( ) const
protectedpure virtual

Returns a set of refactoring actions rules that are defined by this action.

Referenced by ~RefactoringAction().

◆ createActiveActionRules()

RefactoringActionRules clang::tooling::RefactoringAction::createActiveActionRules ( )

Definition at line 108 of file RefactoringActions.cpp.

Referenced by ~RefactoringAction().

◆ getCommand()

virtual StringRef clang::tooling::RefactoringAction::getCommand ( ) const
pure virtual

Returns the name of the subcommand that's used by clang-refactor for this action.

Referenced by ~RefactoringAction().

◆ getDescription()

virtual StringRef clang::tooling::RefactoringAction::getDescription ( ) const
pure virtual

Referenced by ~RefactoringAction().


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