blob: 388535a69b8b93e5349e928dcedf6973a7e81f2a [file] [log] [blame]
//===--- RefactoringActionRule.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 "llvm/ADT/Optional.h"
#include "llvm/ADT/StringRef.h"
namespace clang {
namespace tooling {
class RefactoringOptionVisitor;
class RefactoringResultConsumer;
class RefactoringRuleContext;
struct RefactoringDescriptor {
/// A unique identifier for the specific refactoring.
StringRef Name;
/// A human readable title for the refactoring.
StringRef Title;
/// A human readable description of what the refactoring does.
StringRef Description;
/// A common refactoring action rule interface that defines the 'invoke'
/// function that performs the refactoring operation (either fully or
/// partially).
class RefactoringActionRuleBase {
virtual ~RefactoringActionRuleBase() {}
/// Initiates and performs a specific refactoring action.
/// The specific rule will invoke an appropriate \c handle method on a
/// consumer to propagate the result of the refactoring action.
virtual void invoke(RefactoringResultConsumer &Consumer,
RefactoringRuleContext &Context) = 0;
/// Returns the structure that describes the refactoring.
// static const RefactoringDescriptor &describe() = 0;
/// A refactoring action rule is a wrapper class around a specific refactoring
/// action rule (SourceChangeRefactoringRule, etc) that, in addition to invoking
/// the action, describes the requirements that determine when the action can be
/// initiated.
class RefactoringActionRule : public RefactoringActionRuleBase {
/// Returns true when the rule has a source selection requirement that has
/// to be fulfilled before refactoring can be performed.
virtual bool hasSelectionRequirement() = 0;
/// Traverses each refactoring option used by the rule and invokes the
/// \c visit callback in the consumer for each option.
/// Options are visited in the order of use, e.g. if a rule has two
/// requirements that use options, the options from the first requirement
/// are visited before the options in the second requirement.
virtual void visitRefactoringOptions(RefactoringOptionVisitor &Visitor) = 0;
} // end namespace tooling
} // end namespace clang