class OptionalRefactoringOption

Declaration

template <typename T,
          typename =
              std::enable_if_t<traits::IsValidOptionType<T>::value>>
class OptionalRefactoringOption : public RefactoringOption { /* full declaration omitted */ };

Description

A refactoring option that stores a value of type \c T.

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOptions.h:25

Inherits from: RefactoringOption

Templates

T

= std::enable_if_t<traits::IsValidOptionType<T>::value>

Member Variables

protected Optional<T> Value

Method Overview

• public const clang::tooling::OptionalRefactoringOption::ValueType & getValue() const
• public bool isRequired() const
• public void passToVisitor(clang::tooling::RefactoringOptionVisitor & Visitor)

Inherited from RefactoringOption:

• public getDescription
• public getName
• public isRequired
• public passToVisitor

Methods

¶const clang::tooling::OptionalRefactoringOption::
    ValueType&
    getValue() const

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

¶bool isRequired() const

Description

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

Declared at: clang/include/clang/Tooling/Refactoring/RefactoringOptions.h:31

¶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/RefactoringOptions.h:27

Parameters

clang::tooling::RefactoringOptionVisitor& Visitor