blob: 659e02b48e5c2a33b226092cee45b61585f7347b [file] [log] [blame]
//===--- RefactoringOption.h - Clang refactoring library ------------------===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "clang/Basic/LLVM.h"
#include <memory>
#include <type_traits>
namespace clang {
namespace tooling {
class RefactoringOptionVisitor;
/// 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.
class RefactoringOption {
virtual ~RefactoringOption() {}
/// Returns the name of the refactoring option.
/// Each refactoring option must have a unique name.
virtual StringRef getName() const = 0;
virtual StringRef getDescription() const = 0;
/// True when this option must be specified before invoking the refactoring
/// action.
virtual bool isRequired() const = 0;
/// 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.
virtual void passToVisitor(RefactoringOptionVisitor &Visitor) = 0;
/// Constructs a refactoring option of the given type.
/// The ownership of options is shared among requirements that use it because
/// one option can be used by multiple rules in a refactoring action.
template <typename OptionType>
std::shared_ptr<OptionType> createRefactoringOption() {
static_assert(std::is_base_of<RefactoringOption, OptionType>::value,
"invalid option type");
return std::make_shared<OptionType>();
} // end namespace tooling
} // end namespace clang