[refactor] Simplify the refactoring interface
This commit simplifies the interface for the refactoring action rules and the
refactoring requirements. It merges the selection constraints and the selection
requirements into one class. The refactoring actions rules must now be
implemented using subclassing instead of raw function / lambda pointers. This
change also removes a bunch of template-based traits and other
template definitions that are now redundant.
Differential Revision: https://reviews.llvm.org/D37681
llvm-svn: 314704
diff --git a/clang/lib/Tooling/Refactoring/CMakeLists.txt b/clang/lib/Tooling/Refactoring/CMakeLists.txt
index ff9cd1f..43ea1d9 100644
--- a/clang/lib/Tooling/Refactoring/CMakeLists.txt
+++ b/clang/lib/Tooling/Refactoring/CMakeLists.txt
@@ -9,7 +9,6 @@
Rename/USRFinder.cpp
Rename/USRFindingAction.cpp
Rename/USRLocFinder.cpp
- SourceSelectionConstraints.cpp
LINK_LIBS
clangAST
diff --git a/clang/lib/Tooling/Refactoring/Rename/RenamingAction.cpp b/clang/lib/Tooling/Refactoring/Rename/RenamingAction.cpp
index 384e466..fe3067f 100644
--- a/clang/lib/Tooling/Refactoring/Rename/RenamingAction.cpp
+++ b/clang/lib/Tooling/Refactoring/Rename/RenamingAction.cpp
@@ -23,7 +23,6 @@
#include "clang/Tooling/CommonOptionsParser.h"
#include "clang/Tooling/Refactoring.h"
#include "clang/Tooling/Refactoring/RefactoringAction.h"
-#include "clang/Tooling/Refactoring/RefactoringActionRules.h"
#include "clang/Tooling/Refactoring/Rename/USRFinder.h"
#include "clang/Tooling/Refactoring/Rename/USRFindingAction.h"
#include "clang/Tooling/Refactoring/Rename/USRLocFinder.h"
@@ -39,7 +38,63 @@
namespace {
-class LocalRename : public RefactoringAction {
+class SymbolSelectionRequirement : public SourceRangeSelectionRequirement {
+public:
+ Expected<const NamedDecl *> evaluate(RefactoringRuleContext &Context) const {
+ Expected<SourceRange> Selection =
+ SourceRangeSelectionRequirement::evaluate(Context);
+ if (!Selection)
+ return Selection.takeError();
+ const NamedDecl *ND =
+ getNamedDeclAt(Context.getASTContext(), Selection->getBegin());
+ if (!ND) {
+ // FIXME: Use a diagnostic.
+ return llvm::make_error<StringError>("no symbol selected",
+ llvm::inconvertibleErrorCode());
+ }
+ return getCanonicalSymbolDeclaration(ND);
+ }
+};
+
+class OccurrenceFinder final : public FindSymbolOccurrencesRefactoringRule {
+public:
+ OccurrenceFinder(const NamedDecl *ND) : ND(ND) {}
+
+ Expected<SymbolOccurrences>
+ findSymbolOccurrences(RefactoringRuleContext &Context) override {
+ std::vector<std::string> USRs =
+ getUSRsForDeclaration(ND, Context.getASTContext());
+ std::string PrevName = ND->getNameAsString();
+ return getOccurrencesOfUSRs(
+ USRs, PrevName, Context.getASTContext().getTranslationUnitDecl());
+ }
+
+private:
+ const NamedDecl *ND;
+};
+
+class RenameOccurrences final : public SourceChangeRefactoringRule {
+public:
+ RenameOccurrences(const NamedDecl *ND) : Finder(ND) {}
+
+ Expected<AtomicChanges>
+ createSourceReplacements(RefactoringRuleContext &Context) {
+ Expected<SymbolOccurrences> Occurrences =
+ Finder.findSymbolOccurrences(Context);
+ if (!Occurrences)
+ return Occurrences.takeError();
+ // FIXME: This is a temporary workaround that's needed until the refactoring
+ // options are implemented.
+ StringRef NewName = "Bar";
+ return createRenameReplacements(
+ *Occurrences, Context.getASTContext().getSourceManager(), NewName);
+ }
+
+private:
+ OccurrenceFinder Finder;
+};
+
+class LocalRename final : public RefactoringAction {
public:
StringRef getCommand() const override { return "local-rename"; }
@@ -50,42 +105,11 @@
/// Returns a set of refactoring actions rules that are defined by this
/// action.
RefactoringActionRules createActionRules() const override {
- using namespace refactoring_action_rules;
RefactoringActionRules Rules;
- Rules.push_back(createRefactoringRule(
- renameOccurrences, requiredSelection(SymbolSelectionRequirement())));
+ Rules.push_back(createRefactoringActionRule<RenameOccurrences>(
+ SymbolSelectionRequirement()));
return Rules;
}
-
-private:
- static Expected<AtomicChanges>
- renameOccurrences(const RefactoringRuleContext &Context,
- const NamedDecl *ND) {
- std::vector<std::string> USRs =
- getUSRsForDeclaration(ND, Context.getASTContext());
- std::string PrevName = ND->getNameAsString();
- auto Occurrences = getOccurrencesOfUSRs(
- USRs, PrevName, Context.getASTContext().getTranslationUnitDecl());
-
- // FIXME: This is a temporary workaround that's needed until the refactoring
- // options are implemented.
- StringRef NewName = "Bar";
- return createRenameReplacements(
- Occurrences, Context.getASTContext().getSourceManager(), NewName);
- }
-
- class SymbolSelectionRequirement : public selection::Requirement {
- public:
- Expected<Optional<const NamedDecl *>>
- evaluateSelection(const RefactoringRuleContext &Context,
- selection::SourceSelectionRange Selection) const {
- const NamedDecl *ND = getNamedDeclAt(Context.getASTContext(),
- Selection.getRange().getBegin());
- if (!ND)
- return None;
- return getCanonicalSymbolDeclaration(ND);
- }
- };
};
} // end anonymous namespace
diff --git a/clang/lib/Tooling/Refactoring/SourceSelectionConstraints.cpp b/clang/lib/Tooling/Refactoring/SourceSelectionConstraints.cpp
deleted file mode 100644
index 5fbe294..0000000
--- a/clang/lib/Tooling/Refactoring/SourceSelectionConstraints.cpp
+++ /dev/null
@@ -1,23 +0,0 @@
-//===--- SourceSelectionConstraints.cpp - Evaluate selection constraints --===//
-//
-// The LLVM Compiler Infrastructure
-//
-// This file is distributed under the University of Illinois Open Source
-// License. See LICENSE.TXT for details.
-//
-//===----------------------------------------------------------------------===//
-
-#include "clang/Tooling/Refactoring/SourceSelectionConstraints.h"
-#include "clang/Tooling/Refactoring/RefactoringRuleContext.h"
-
-using namespace clang;
-using namespace tooling;
-using namespace selection;
-
-Optional<SourceSelectionRange>
-SourceSelectionRange::evaluate(RefactoringRuleContext &Context) {
- SourceRange R = Context.getSelectionRange();
- if (R.isInvalid())
- return None;
- return SourceSelectionRange(Context.getSources(), R);
-}