6024e5c395
clang 20.0.0 (based on r547379) from build 12806354. Bug: http://b/379133546 Test: N/A Change-Id: I2eb8938af55d809de674be63cb30cf27e801862b Upstream-Commit: ad834e67b1105d15ef907f6255d4c96e8e733f57
64 lines
2.1 KiB
C++
64 lines
2.1 KiB
C++
//===--- RefactoringOption.h - Clang refactoring library ------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGOPTION_H
|
|
#define LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGOPTION_H
|
|
|
|
#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 {
|
|
public:
|
|
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
|
|
|
|
#endif // LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGOPTION_H
|