6024e5c395
clang 20.0.0 (based on r547379) from build 12806354. Bug: http://b/379133546 Test: N/A Change-Id: I2eb8938af55d809de674be63cb30cf27e801862b Upstream-Commit: ad834e67b1105d15ef907f6255d4c96e8e733f57
72 lines
2.6 KiB
C++
72 lines
2.6 KiB
C++
//===--- RefactoringActionRule.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_REFACTORINGACTIONRULE_H
|
|
#define LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGACTIONRULE_H
|
|
|
|
#include "clang/Basic/LLVM.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 {
|
|
public:
|
|
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 {
|
|
public:
|
|
/// 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
|
|
|
|
#endif // LLVM_CLANG_TOOLING_REFACTORING_REFACTORINGACTIONRULE_H
|