class RefactoringOption

Declaration

class RefactoringOption { /* full declaration omitted */ };

Description

A refactoring option is an interface that describes a value that has an impact on the outcome of a refactoring. Refactoring options can be specified using command-line arguments when the clang-refactor tool is used.

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOption.h:26

Method Overview

• public virtual llvm::StringRef getDescription() const
• public virtual llvm::StringRef getName() const
• public virtual bool isRequired() const
• public virtual void passToVisitor(clang::tooling::RefactoringOptionVisitor & Visitor)
• public virtual ~RefactoringOption()

Methods

¶virtual llvm::StringRef getDescription() const

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOption.h:35

¶virtual llvm::StringRef getName() const

Description

Returns the name of the refactoring option. Each refactoring option must have a unique name.

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOption.h:33

¶virtual bool isRequired() const

Description

True when this option must be specified before invoking the refactoring action.

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOption.h:39

¶virtual void passToVisitor(
    clang::tooling::RefactoringOptionVisitor&
        Visitor)

Description

Invokes the \c visit method in the option consumer that's appropriate for the option's value type. For example, if the option stores a string value, this method will invoke the \c visit method with a reference to an std::string value.

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOption.h:46

Parameters

clang::tooling::RefactoringOptionVisitor& Visitor

¶virtual ~RefactoringOption()

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOption.h:28