Index: include/clang/Tooling/Refactoring/AtomicChange.h =================================================================== --- include/clang/Tooling/Refactoring/AtomicChange.h +++ include/clang/Tooling/Refactoring/AtomicChange.h @@ -52,6 +52,8 @@ AtomicChange &operator=(AtomicChange &&) = default; AtomicChange &operator=(const AtomicChange &) = default; + bool operator==(const AtomicChange &Other) const; + /// \brief Returns the atomic change as a YAML string. std::string toYAMLString(); Index: include/clang/Tooling/Refactoring/RefactoringAction.h =================================================================== --- /dev/null +++ include/clang/Tooling/Refactoring/RefactoringAction.h @@ -0,0 +1,64 @@ +//===--- RefactoringAction.h - Clang refactoring library ------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLING_REFACTOR_REFACTORING_ACTION_H +#define LLVM_CLANG_TOOLING_REFACTOR_REFACTORING_ACTION_H + +#include "clang/Basic/LLVM.h" +#include "clang/Tooling/Refactoring/RefactoringActionRules.h" +#include + +namespace clang { +namespace tooling { + +/// A refactoring action is a class that defines a set of related refactoring +/// action rules. These rules get grouped under a common umbrella - a single +/// clang-refactor subcommand. +/// +/// A subclass of \c RefactoringAction is responsible for creating the set of +/// grouped refactoring action rules that represent one refactoring operation. +/// Although the rules in one action may have a number of different +/// implementations, they should strive to produce a similar result. It should +/// be easy for users to identify which refactoring action produced the result +/// regardless of which refactoring action rule was used. +/// +/// The distinction between actions and rules enables the creation of action +/// that uses very different rules, for example: +/// - local vs global: a refactoring operation like +/// "add missing switch cases" can be applied to one switch when it's +/// selected in an editor, or to all switches in a project when an enum +/// constant is added to an enum. +/// - tool vs editor: some refactoring operation can be initiated in the +/// editor when a declaration is selected, or in a tool when the name of +/// the declaration is passed using a command-line argument. +class RefactoringAction { +public: + virtual ~RefactoringAction() {} + + /// Returns the name of the subcommand that's used by clang-refactor for this + /// action. + virtual StringRef getCommand() const = 0; + + virtual StringRef getDescription() const = 0; + + RefactoringActionRules createActiveActionRules(); + +protected: + /// Returns a set of refactoring actions rules that are defined by this + /// action. + virtual RefactoringActionRules createActionRules() const = 0; +}; + +/// Returns the list of all the available refactoring actions. +std::vector> createRefactoringActions(); + +} // end namespace tooling +} // end namespace clang + +#endif // LLVM_CLANG_TOOLING_REFACTOR_REFACTORING_ACTION_H Index: include/clang/Tooling/Refactoring/RefactoringActionRegistry.def =================================================================== --- /dev/null +++ include/clang/Tooling/Refactoring/RefactoringActionRegistry.def @@ -0,0 +1,7 @@ +#ifndef REFACTORING_ACTION +#define REFACTORING_ACTION(Name) +#endif + +REFACTORING_ACTION(LocalRename) + +#undef REFACTORING_ACTION Index: include/clang/Tooling/Refactoring/RefactoringActionRule.h =================================================================== --- include/clang/Tooling/Refactoring/RefactoringActionRule.h +++ include/clang/Tooling/Refactoring/RefactoringActionRule.h @@ -30,6 +30,10 @@ /// consumer to propagate the result of the refactoring action. virtual void invoke(RefactoringResultConsumer &Consumer, RefactoringRuleContext &Context) = 0; + + /// Returns true when the rule has a source selection requirement that has + /// to be fullfilled before refactoring can be performed. + virtual bool hasSelectionRequirement() = 0; }; /// A set of refactoring action rules that should have unique initiation Index: include/clang/Tooling/Refactoring/RefactoringActionRuleRequirementsInternal.h =================================================================== --- include/clang/Tooling/Refactoring/RefactoringActionRuleRequirementsInternal.h +++ include/clang/Tooling/Refactoring/RefactoringActionRuleRequirementsInternal.h @@ -58,7 +58,7 @@ Optional Value = InputT::evaluate(Context); if (!Value) return None; - return std::move(Requirement.evaluateSelection(*Value)); + return std::move(Requirement.evaluateSelection(Context, *Value)); } private: @@ -82,6 +82,20 @@ : std::conditional::value, std::true_type, std::false_type>::type {}; +/// A type trait that returns true when the given type has at least one source +/// selection requirement. +template +struct HasSelectionRequirement + : std::conditional::value || + HasSelectionRequirement::value, + std::true_type, std::false_type>::type {}; + +template +struct HasSelectionRequirement> + : std::true_type {}; + +template struct HasSelectionRequirement : std::false_type {}; + } // end namespace traits } // end namespace refactoring_action_rules } // end namespace tooling Index: include/clang/Tooling/Refactoring/RefactoringActionRules.h =================================================================== --- include/clang/Tooling/Refactoring/RefactoringActionRules.h +++ include/clang/Tooling/Refactoring/RefactoringActionRules.h @@ -15,6 +15,9 @@ namespace clang { namespace tooling { + +class RefactoringRuleContext; + namespace refactoring_action_rules { /// Creates a new refactoring action rule that invokes the given function once @@ -40,6 +43,7 @@ template std::unique_ptr createRefactoringRule(Expected (*RefactoringFunction)( + const RefactoringRuleContext &, typename RequirementTypes::OutputType...), const RequirementTypes &... Requirements) { static_assert(tooling::traits::IsValidRefactoringResult::value, @@ -56,13 +60,12 @@ typename Fn = decltype(&Callable::operator()), typename ResultType = typename internal::LambdaDeducer::ReturnType, bool IsNonCapturingLambda = std::is_convertible< - Callable, - ResultType (*)(typename RequirementTypes::OutputType...)>::value, + Callable, typename internal::LambdaDeducer::FunctionType>::value, typename = typename std::enable_if::type> std::unique_ptr createRefactoringRule(const Callable &C, const RequirementTypes &... Requirements) { - ResultType (*Func)(typename RequirementTypes::OutputType...) = C; + typename internal::LambdaDeducer::FunctionType Func = C; return createRefactoringRule(Func, Requirements...); } Index: include/clang/Tooling/Refactoring/RefactoringActionRulesInternal.h =================================================================== --- include/clang/Tooling/Refactoring/RefactoringActionRulesInternal.h +++ include/clang/Tooling/Refactoring/RefactoringActionRulesInternal.h @@ -39,6 +39,10 @@ llvm::index_sequence_for()); } + bool hasSelectionRequirement() override { + return traits::HasSelectionRequirement::value; + } + private: /// Returns \c T when given \c Expected>, or \c T otherwise. template @@ -79,7 +83,7 @@ template void invokeImpl(RefactoringResultConsumer &Consumer, RefactoringRuleContext &Context, - llvm::index_sequence) { + llvm::index_sequence Seq) { // Initiate the operation. auto Values = std::make_tuple(std::get(Requirements).evaluate(Context)...); @@ -96,8 +100,8 @@ return Consumer.handleError(std::move(Error)); } // Perform the operation. - auto Result = - Function(unwrapRequirementResult(std::move(std::get(Values)))...); + auto Result = Function( + Context, unwrapRequirementResult(std::move(std::get(Values)))...); if (!Result) return Consumer.handleError(Result.takeError()); Consumer.handle(std::move(*Result)); @@ -111,8 +115,9 @@ /// createRefactoringRule. template struct LambdaDeducer; template -struct LambdaDeducer { +struct LambdaDeducer { using ReturnType = R; + using FunctionType = R (*)(const RefactoringRuleContext &, Args...); }; } // end namespace internal Index: include/clang/Tooling/Refactoring/RefactoringRuleContext.h =================================================================== --- include/clang/Tooling/Refactoring/RefactoringRuleContext.h +++ include/clang/Tooling/Refactoring/RefactoringRuleContext.h @@ -13,6 +13,9 @@ #include "clang/Basic/SourceManager.h" namespace clang { + +class ASTContext; + namespace tooling { /// The refactoring rule context stores all of the inputs that might be needed @@ -38,6 +41,15 @@ void setSelectionRange(SourceRange R) { SelectionRange = R; } + bool hasASTContext() const { return AST; } + + ASTContext &getASTContext() const { + assert(AST && "no AST!"); + return *AST; + } + + void setASTContext(ASTContext &Context) { AST = &Context; } + private: /// The source manager for the translation unit / file on which a refactoring /// action might operate on. @@ -45,6 +57,9 @@ /// An optional source selection range that's commonly used to represent /// a selection in an editor. SourceRange SelectionRange; + /// An optional AST for the translation unit on which a refactoring action + /// might operate on. + ASTContext *AST = nullptr; }; } // end namespace tooling Index: include/clang/Tooling/Refactoring/Rename/USRFindingAction.h =================================================================== --- include/clang/Tooling/Refactoring/Rename/USRFindingAction.h +++ include/clang/Tooling/Refactoring/Rename/USRFindingAction.h @@ -23,6 +23,7 @@ namespace clang { class ASTConsumer; +class ASTContext; class CompilerInstance; class NamedDecl; @@ -37,6 +38,10 @@ /// - A destructor is canonicalized to its class. const NamedDecl *getCanonicalSymbolDeclaration(const NamedDecl *FoundDecl); +/// Returns the set of USRs that correspond to the given declaration. +std::vector getUSRsForDeclaration(const NamedDecl *ND, + ASTContext &Context); + struct USRFindingAction { USRFindingAction(ArrayRef SymbolOffsets, ArrayRef QualifiedNames, bool Force) Index: include/clang/Tooling/Refactoring/SourceSelectionConstraints.h =================================================================== --- include/clang/Tooling/Refactoring/SourceSelectionConstraints.h +++ include/clang/Tooling/Refactoring/SourceSelectionConstraints.h @@ -12,6 +12,7 @@ #include "clang/Basic/LLVM.h" #include "clang/Basic/SourceLocation.h" +#include "clang/Tooling/Refactoring/RefactoringRuleContext.h" #include namespace clang { @@ -40,9 +41,10 @@ /// A custom selection requirement. class Requirement { - /// Subclasses must implement 'T evaluateSelection(SelectionConstraint) const' - /// member function. \c T is used to determine the return type that is - /// passed to the refactoring rule's function. + /// Subclasses must implement + /// 'T evaluateSelection(const RefactoringRuleContext &, + /// SelectionConstraint) const' member function. \c T is used to determine + /// the return type that is passed to the refactoring rule's function. /// If T is \c DiagnosticOr , then \c S is passed to the rule's function /// using move semantics. /// Otherwise, T is passed to the function directly using move semantics. @@ -64,14 +66,17 @@ template struct EvaluateSelectionChecker : std::false_type {}; template -struct EvaluateSelectionChecker : std::true_type { +struct EvaluateSelectionChecker : std::true_type { using ReturnType = R; using ArgType = A; }; template class Identity : public Requirement { public: - T evaluateSelection(T Value) const { return std::move(Value); } + T evaluateSelection(const RefactoringRuleContext &, T Value) const { + return std::move(Value); + } }; } // end namespace internal Index: include/clang/module.modulemap =================================================================== --- include/clang/module.modulemap +++ include/clang/module.modulemap @@ -138,6 +138,8 @@ // importing the AST matchers library gives a link dependency on the AST // matchers (and thus the AST), which clang-format should not have. exclude header "Tooling/RefactoringCallbacks.h" + + textual header "Tooling/Refactoring/RefactoringActionRegistry.def" } module Clang_ToolingCore { Index: lib/Tooling/Refactoring/AtomicChange.cpp =================================================================== --- lib/Tooling/Refactoring/AtomicChange.cpp +++ lib/Tooling/Refactoring/AtomicChange.cpp @@ -215,6 +215,15 @@ RemovedHeaders(std::move(RemovedHeaders)), Replaces(std::move(Replaces)) { } +bool AtomicChange::operator==(const AtomicChange &Other) const { + if (Key != Other.Key || FilePath != Other.FilePath || Error != Other.Error) + return false; + if (!(Replaces == Other.Replaces)) + return false; + // FXIME: Compare header insertions/removals. + return true; +} + std::string AtomicChange::toYAMLString() { std::string YamlContent; llvm::raw_string_ostream YamlContentStream(YamlContent); Index: lib/Tooling/Refactoring/CMakeLists.txt =================================================================== --- lib/Tooling/Refactoring/CMakeLists.txt +++ lib/Tooling/Refactoring/CMakeLists.txt @@ -3,6 +3,7 @@ add_clang_library(clangToolingRefactor ASTSelection.cpp AtomicChange.cpp + RefactoringActions.cpp Rename/RenamingAction.cpp Rename/SymbolOccurrences.cpp Rename/USRFinder.cpp Index: lib/Tooling/Refactoring/RefactoringActions.cpp =================================================================== --- /dev/null +++ lib/Tooling/Refactoring/RefactoringActions.cpp @@ -0,0 +1,35 @@ +//===--- RefactoringActions.cpp - Constructs refactoring actions ----------===// +// +// 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/RefactoringAction.h" + +namespace clang { +namespace tooling { + +// Forward declare the individual create*Action functions. +#define REFACTORING_ACTION(Name) \ + std::unique_ptr create##Name##Action(); +#include "clang/Tooling/Refactoring/RefactoringActionRegistry.def" + +std::vector> createRefactoringActions() { + std::vector> Actions; + +#define REFACTORING_ACTION(Name) Actions.push_back(create##Name##Action()); +#include "clang/Tooling/Refactoring/RefactoringActionRegistry.def" + + return Actions; +} + +RefactoringActionRules RefactoringAction::createActiveActionRules() { + // FIXME: Filter out rules that are not supported by a particular client. + return createActionRules(); +} + +} // end namespace tooling +} // end namespace clang Index: lib/Tooling/Refactoring/Rename/RenamingAction.cpp =================================================================== --- lib/Tooling/Refactoring/Rename/RenamingAction.cpp +++ lib/Tooling/Refactoring/Rename/RenamingAction.cpp @@ -22,6 +22,10 @@ #include "clang/Lex/Preprocessor.h" #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" #include "clang/Tooling/Tooling.h" #include "llvm/ADT/STLExtras.h" @@ -33,6 +37,63 @@ namespace clang { namespace tooling { +namespace { + +class LocalRename : public RefactoringAction { +public: + StringRef getCommand() const override { return "local-rename"; } + + StringRef getDescription() const override { + return "Finds and renames symbols in code with no indexer support"; + } + + /// 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()))); + return Rules; + } + +private: + static Expected + renameOccurrences(const RefactoringRuleContext &Context, + const NamedDecl *ND) { + std::vector 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> + 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 + +std::unique_ptr createLocalRenameAction() { + return llvm::make_unique(); +} + Expected> createRenameReplacements(const SymbolOccurrences &Occurrences, const SourceManager &SM, Index: lib/Tooling/Refactoring/Rename/USRFindingAction.cpp =================================================================== --- lib/Tooling/Refactoring/Rename/USRFindingAction.cpp +++ lib/Tooling/Refactoring/Rename/USRFindingAction.cpp @@ -154,6 +154,12 @@ }; } // namespace +std::vector getUSRsForDeclaration(const NamedDecl *ND, + ASTContext &Context) { + AdditionalUSRFinder Finder(ND, Context); + return Finder.Find(); +} + class NamedDeclFindingConsumer : public ASTConsumer { public: NamedDeclFindingConsumer(ArrayRef SymbolOffsets, Index: test/CMakeLists.txt =================================================================== --- test/CMakeLists.txt +++ test/CMakeLists.txt @@ -48,6 +48,7 @@ clang-offload-bundler clang-import-test clang-rename + clang-refactor clang-diff ) Index: test/Refactor/LocalRename/Field.cpp =================================================================== --- /dev/null +++ test/Refactor/LocalRename/Field.cpp @@ -0,0 +1,9 @@ +// RUN: clang-refactor local-rename -selection=test:%s -no-dbs %s | FileCheck %s + +class Baz { + int /*range=*/Foo; // CHECK: =*/Bar; +public: + Baz(); +}; + +Baz::Baz() : /*range=*/Foo(0) {} // CHECK: =*/Bar(0) {}; Index: test/Refactor/tool-common-options.c =================================================================== --- /dev/null +++ test/Refactor/tool-common-options.c @@ -0,0 +1,6 @@ +// RUN: not clang-refactor 2>&1 | FileCheck --check-prefix=MISSING_ACTION %s +// MISSING_ACTION: error: no refactoring action given +// MISSING_ACTION-NEXT: note: the following actions are supported: + +// RUN: not clang-refactor local-rename -no-dbs 2>&1 | FileCheck --check-prefix=MISSING_SOURCES %s +// MISSING_SOURCES: error: must provide paths to the source files when '-no-dbs' is used Index: test/Refactor/tool-test-support.c =================================================================== --- /dev/null +++ test/Refactor/tool-test-support.c @@ -0,0 +1,34 @@ +// RUN: clang-refactor local-rename -selection=test:%s -no-dbs -v %s 2>&1 | FileCheck %s + +/*range=*/int test; + +/*range named=*/int test2; + +/*range= +1*/int test3; + +/* range = +100 */int test4; + +/*range named =+0*/int test5; + +// CHECK: Test selection group '': +// CHECK-NEXT: 100-100 +// CHECK-NEXT: 153-153 +// CHECK-NEXT: 192-192 +// CHECK-NEXT: Test selection group 'named': +// CHECK-NEXT: 127-127 +// CHECK-NEXT: 213-213 + +// CHECK: invoking action 'local-rename': +// CHECK-NEXT: -selection={{.*}}tool-test-support.c:3:11 + +// CHECK: invoking action 'local-rename': +// CHECK-NEXT: -selection={{.*}}tool-test-support.c:7:15 + +// CHECK: invoking action 'local-rename': +// CHECK-NEXT: -selection={{.*}}tool-test-support.c:9:29 + +// CHECK: invoking action 'local-rename': +// CHECK-NEXT: -selection={{.*}}tool-test-support.c:5:17 + +// CHECK: invoking action 'local-rename': +// CHECK-NEXT: -selection={{.*}}tool-test-support.c:11:20 Index: test/clang-rename/Field.cpp =================================================================== --- test/clang-rename/Field.cpp +++ /dev/null @@ -1,15 +0,0 @@ -class Baz { - int Foo; /* Test 1 */ // CHECK: int Bar; -public: - Baz(); -}; - -Baz::Baz() : Foo(0) /* Test 2 */ {} // CHECK: Baz::Baz() : Bar(0) - -// Test 1. -// RUN: clang-rename -offset=18 -new-name=Bar %s -- | sed 's,//.*,,' | FileCheck %s -// Test 2. -// RUN: clang-rename -offset=89 -new-name=Bar %s -- | sed 's,//.*,,' | FileCheck %s - -// To find offsets after modifying the file, use: -// grep -Ubo 'Foo.*' Index: tools/CMakeLists.txt =================================================================== --- tools/CMakeLists.txt +++ tools/CMakeLists.txt @@ -12,6 +12,7 @@ add_clang_subdirectory(c-index-test) add_clang_subdirectory(clang-rename) +add_clang_subdirectory(clang-refactor) if(CLANG_ENABLE_ARCMT) add_clang_subdirectory(arcmt-test) Index: tools/clang-refactor/CMakeLists.txt =================================================================== --- /dev/null +++ tools/clang-refactor/CMakeLists.txt @@ -0,0 +1,20 @@ +set(LLVM_LINK_COMPONENTS + Option + Support + ) + +add_clang_executable(clang-refactor + ClangRefactor.cpp + TestSupport.cpp + ) + +target_link_libraries(clang-refactor + clangBasic + clangFrontend + clangRewrite + clangTooling + clangToolingCore + clangToolingRefactor + ) + +install(TARGETS clang-refactor RUNTIME DESTINATION bin) Index: tools/clang-refactor/ClangRefactor.cpp =================================================================== --- /dev/null +++ tools/clang-refactor/ClangRefactor.cpp @@ -0,0 +1,373 @@ +//===--- ClangRefactor.cpp - Clang-based refactoring tool -----------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +/// +/// \file +/// \brief This file implements a clang-refactor tool that performs various +/// source transformations. +/// +//===----------------------------------------------------------------------===// + +#include "TestSupport.h" +#include "clang/Rewrite/Core/Rewriter.h" +#include "clang/Tooling/Refactoring.h" +#include "clang/Tooling/Refactoring/RefactoringAction.h" +#include "clang/Tooling/Refactoring/Rename/RenamingAction.h" +#include "clang/Tooling/Tooling.h" +#include "llvm/Support/CommandLine.h" +#include "llvm/Support/FileSystem.h" +#include "llvm/Support/raw_ostream.h" +#include + +using namespace clang; +using namespace tooling; +using namespace clang_refactor; +namespace cl = llvm::cl; + +namespace opts { + +static cl::OptionCategory CommonRefactorOptions("Common refactoring options"); + +static cl::opt + NoDatabases("no-dbs", + cl::desc("Ignore external databases including Clang's " + "compilation database and indexer stores"), + cl::cat(CommonRefactorOptions), cl::sub(*cl::AllSubCommands)); + +static cl::opt Verbose("v", cl::desc("Use verbose output"), + cl::cat(CommonRefactorOptions), + cl::sub(*cl::AllSubCommands)); +} // end namespace opts + +namespace { + +/// Stores the parsed `-selection` argument. +class SourceSelectionArgument { +public: + virtual ~SourceSelectionArgument() {} + + /// Parse the `-selection` argument. + /// + /// \returns A valid argument when the parse succedeed, null otherwise. + static std::unique_ptr fromString(StringRef Value); + + /// Runs the give refactoring function for each specified selection. + /// + /// \returns true if an error occurred, false otherwise. + virtual bool refactorForEachSelection( + RefactoringRuleContext &Context, + llvm::function_ref(SourceRange R)> Refactor) = 0; +}; + +/// Stores the parsed -selection=test: option. +class TestSourceSelectionArgument final : public SourceSelectionArgument { +public: + TestSourceSelectionArgument(TestSelectionRangesInFile TestSelections) + : TestSelections(std::move(TestSelections)) {} + + /// Testing support: invokes the selection action for each selection range in + /// the test file. + virtual bool refactorForEachSelection( + RefactoringRuleContext &Context, + llvm::function_ref(SourceRange R)> Refactor) + override { + if (opts::Verbose) + TestSelections.dump(llvm::outs()); + return TestSelections.dispatch(Context.getSources(), Refactor); + } + +private: + TestSelectionRangesInFile TestSelections; +}; + +std::unique_ptr +SourceSelectionArgument::fromString(StringRef Value) { + if (Value.startswith("test:")) { + StringRef Filename = Value.drop_front(strlen("test:")); + Optional ParsedTestSelection = + findTestSelectionRanges(Filename); + if (!ParsedTestSelection) + return nullptr; // A parsing error was already reported. + return llvm::make_unique( + std::move(*ParsedTestSelection)); + } + // FIXME: Support true selection ranges. + llvm::errs() << "error: '-selection' option must be specified using " + ":: or " + "::-: format"; + return nullptr; +} + +/// A subcommand that corresponds to individual refactoring action. +class RefactoringActionSubcommand : public cl::SubCommand { +public: + RefactoringActionSubcommand(std::unique_ptr Action, + RefactoringActionRules ActionRules, + cl::OptionCategory &Category) + : SubCommand(Action->getCommand(), Action->getDescription()), + Action(std::move(Action)), ActionRules(std::move(ActionRules)) { + Sources = llvm::make_unique>( + cl::Positional, cl::ZeroOrMore, cl::desc(" [... ]"), + cl::cat(Category), cl::sub(*this)); + + // Check if the selection option is supported. + bool HasSelection = false; + for (const auto &Rule : this->ActionRules) { + if ((HasSelection = Rule->hasSelectionRequirement())) + break; + } + if (HasSelection) { + Selection = llvm::make_unique>( + "selection", + cl::desc("The selected source range in which the refactoring should " + "be initiated (::-: or " + "::)"), + cl::cat(Category), cl::sub(*this)); + } + } + + ~RefactoringActionSubcommand() { unregisterSubCommand(); } + + const RefactoringActionRules &getActionRules() const { return ActionRules; } + + /// Parses the command-line arguments that are specific to this rule. + /// + /// \returns true on error, false otherwise. + bool parseArguments() { + if (Selection) { + ParsedSelection = SourceSelectionArgument::fromString(*Selection); + if (!ParsedSelection) + return true; + } + return false; + } + + SourceSelectionArgument *getSelection() const { + assert(Selection && "selection not supported!"); + return ParsedSelection.get(); + } + + ArrayRef getSources() const { return *Sources; } + +private: + std::unique_ptr Action; + RefactoringActionRules ActionRules; + std::unique_ptr> Sources; + std::unique_ptr> Selection; + std::unique_ptr ParsedSelection; +}; + +/// Consumes all of the AtomicChanges. +class TestRefactoringResultConsumer final : public RefactoringResultConsumer { +public: + virtual void handleError(llvm::Error Err) override { + Result = std::move(Err); + } + + virtual void handle(AtomicChanges Changes) override { + Result = std::move(Changes); + } + + Optional> Result; +}; + +class ClangRefactorTool { +public: + std::vector> SubCommands; + + ClangRefactorTool() { + std::vector> Actions = + createRefactoringActions(); + + // Actions must have unique command names so that we can map them to one + // subcommand. + llvm::StringSet<> CommandNames; + for (const auto &Action : Actions) { + if (!CommandNames.insert(Action->getCommand()).second) { + llvm::errs() << "duplicate refactoring action command '" + << Action->getCommand() << "'!"; + exit(1); + } + } + + // Create subcommands and command-line options. + for (auto &Action : Actions) { + SubCommands.push_back(llvm::make_unique( + std::move(Action), Action->createActiveActionRules(), + opts::CommonRefactorOptions)); + } + } + + using TUCallbackType = llvm::function_ref; + + /// Parses the translation units that were given to the subcommand using + /// the 'sources' option and invokes the callback for each parsed + /// translation unit. + bool foreachTranslationUnit(RefactoringActionSubcommand &Subcommand, + TUCallbackType Callback) { + std::unique_ptr Compilations; + if (opts::NoDatabases) { + // FIXME (Alex L): Support compilation options. + Compilations = + llvm::make_unique( + ".", std::vector()); + } else { + // FIXME (Alex L): Support compilation database. + llvm::errs() << "compilation databases are not supported yet!\n"; + return true; + } + + class ToolASTConsumer : public ASTConsumer { + public: + TUCallbackType Callback; + ToolASTConsumer(TUCallbackType Callback) : Callback(Callback) {} + + void HandleTranslationUnit(ASTContext &Context) override { + Callback(Context); + } + }; + class ActionWrapper { + public: + TUCallbackType Callback; + ActionWrapper(TUCallbackType Callback) : Callback(Callback) {} + + std::unique_ptr newASTConsumer() { + return llvm::make_unique(std::move(Callback)); + } + }; + + ClangTool Tool(*Compilations, Subcommand.getSources()); + ActionWrapper ToolAction(std::move(Callback)); + std::unique_ptr Factory = + tooling::newFrontendActionFactory(&ToolAction); + return Tool.run(Factory.get()); + } + + /// Logs an individual refactoring action invocation to STDOUT. + void logInvocation(RefactoringActionSubcommand &Subcommand, + const RefactoringRuleContext &Context) { + if (!opts::Verbose) + return; + llvm::outs() << "invoking action '" << Subcommand.getName() << "':\n"; + if (Context.getSelectionRange().isValid()) { + SourceRange R = Context.getSelectionRange(); + llvm::outs() << " -selection="; + R.getBegin().print(llvm::outs(), Context.getSources()); + llvm::outs() << " -> "; + R.getEnd().print(llvm::outs(), Context.getSources()); + llvm::outs() << "\n"; + } + } + + bool invokeAction(RefactoringActionSubcommand &Subcommand) { + // Find a set of matching rules. + SmallVector MatchingRules; + llvm::StringSet<> MissingOptions; + + bool HasSelection = false; + for (const auto &Rule : Subcommand.getActionRules()) { + if (Rule->hasSelectionRequirement()) { + HasSelection = true; + if (Subcommand.getSelection()) + MatchingRules.push_back(Rule.get()); + else + MissingOptions.insert("selection"); + } + // FIXME (Alex L): Support custom options. + } + if (MatchingRules.empty()) { + llvm::errs() << "error: '" << Subcommand.getName() + << "' can't be invoked with the given arguments:\n"; + for (const auto &Opt : MissingOptions) + llvm::errs() << " missing '-" << Opt.getKey() << "' option\n"; + return true; + } + + bool HasFailed = false; + if (foreachTranslationUnit(Subcommand, [&](ASTContext &AST) { + RefactoringRuleContext Context(AST.getSourceManager()); + Context.setASTContext(AST); + + auto SelectionBasedRefactoringFunc = + [&](SourceRange R) -> Expected { + Context.setSelectionRange(R); + logInvocation(Subcommand, Context); + for (RefactoringActionRule *Rule : MatchingRules) { + if (!Rule->hasSelectionRequirement()) + continue; + TestRefactoringResultConsumer Consumer; + Rule->invoke(Consumer, Context); + return std::move(*Consumer.Result); + } + llvm_unreachable( + "The action must have at least one selection rule"); + }; + + // FIXME (Alex L): If more than one initiation succeeded, then the + // rules are ambiguous. + if (HasSelection) { + assert(Subcommand.getSelection() && "Missing selection argument?"); + if (Subcommand.getSelection()->refactorForEachSelection( + Context, SelectionBasedRefactoringFunc)) + HasFailed = true; + return; + } + // FIXME (Alex L): Implement non-selection based invocation path. + })) + return true; + return HasFailed; + } +}; + +} // end anonymous namespace + +int main(int argc, const char **argv) { + ClangRefactorTool Tool; + + // FIXME: Use LibTooling's CommonOptions parser when subcommands are supported + // by it. + cl::HideUnrelatedOptions(opts::CommonRefactorOptions); + cl::ParseCommandLineOptions( + argc, argv, "Clang-based refactoring tool for C, C++ and Objective-C"); + cl::PrintOptionValues(); + + // Figure out which action is specified by the user. The user must specify + // the action using a command-line subcommand, e.g. the invocation + // `clang-refactor local-rename` corresponds to the `LocalRename` refactoring + // action. All subcommands must have a unique names. This allows us to figure + // out which refactoring action should be invoked by looking at the first + // subcommand that's enabled by LLVM's command-line parser. + auto It = llvm::find_if( + Tool.SubCommands, + [](const std::unique_ptr &SubCommand) { + return !!(*SubCommand); + }); + if (It == Tool.SubCommands.end()) { + llvm::errs() << "error: no refactoring action given\n"; + llvm::errs() << "note: the following actions are supported:\n"; + for (const auto &Subcommand : Tool.SubCommands) + llvm::errs().indent(2) << Subcommand->getName() << "\n"; + return 1; + } + RefactoringActionSubcommand &ActionCommand = **It; + + ArrayRef Sources = ActionCommand.getSources(); + // When -no-dbs is used, at least one file (TU) must be given to any + // subcommand. + if (opts::NoDatabases && Sources.empty()) { + llvm::errs() << "error: must provide paths to the source files when " + "'-no-dbs' is used\n"; + return 1; + } + if (ActionCommand.parseArguments()) + return 1; + if (Tool.invokeAction(ActionCommand)) + return 1; + + return 0; +} Index: tools/clang-refactor/TestSupport.h =================================================================== --- /dev/null +++ tools/clang-refactor/TestSupport.h @@ -0,0 +1,103 @@ +//===--- TestSupport.h - Clang-based refactoring tool -----------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +/// +/// \file +/// \brief Declares datatypes and routines that are used by test-specific code +/// in clang-refactor. +/// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_CLANG_REFACTOR_TEST_SUPPORT_H +#define LLVM_CLANG_TOOLS_CLANG_REFACTOR_TEST_SUPPORT_H + +#include "clang/Basic/LLVM.h" +#include "clang/Basic/SourceLocation.h" +#include "clang/Tooling/Refactoring/AtomicChange.h" +#include "llvm/ADT/Optional.h" +#include "llvm/ADT/SmallVector.h" +#include "llvm/Support/Error.h" +#include +#include + +namespace clang { + +class SourceManager; + +namespace clang_refactor { + +/// A source selection range that's specified in a test file using an inline +/// command in the comment. These commands can take the following forms: +/// +/// - /*range=*/ will create an empty selection range in the default group +/// right after the comment. +/// - /*range a=*/ will create an empty selection range in the 'a' group right +/// after the comment. +/// - /*range = +1*/ will create an empty selection range at a location that's +/// right after the comment with one offset to the column. +/// - /*range= -> +2:3*/ will create a selection range that starts at the +/// location right after the comment, and ends at column 3 of the 2nd line +/// after the line of the starting location. +/// +/// Clang-refactor will expected all ranges in one test group to produce +/// identical results. +struct TestSelectionRange { + unsigned Begin, End; +}; + +/// A set of test selection ranges specified in one file. +struct TestSelectionRangesInFile { + std::string Filename; + std::map> GroupedRanges; + + TestSelectionRangesInFile(TestSelectionRangesInFile &&) = default; + TestSelectionRangesInFile &operator=(TestSelectionRangesInFile &&) = default; + + bool + dispatch(const SourceManager &SM, + llvm::function_ref(SourceRange)> + Producer) const; + + void dump(llvm::raw_ostream &OS) const; +}; + +/// Extracts the grouped selection ranges from the file that's specified in +/// the -selection=test: option. +/// +/// The grouped ranges are specified in comments using the following syntax: +/// "range" [ group-name ] "=" [ "+" starting-column-offset ] [ "->" +/// "+" ending-line-offset ":" +/// ending-column-position ] +/// +/// The selection range is then computed from this command by taking the ending +/// location of the comment, and adding 'starting-column-offset' to the column +/// for that location. That location in turns becomes the whole selection range, +/// unless 'ending-line-offset' and 'ending-column-position' are specified. If +/// they are specified, then the ending location of the selection range is +/// the starting location's line + 'ending-line-offset' and the +/// 'ending-column-position' column. +/// +/// All selection ranges in one group are expected to produce the same +/// refactoring result. +/// +/// When testing, zero is returned from clang-refactor even when a group +/// produces an initiation error, which is different from normal invocation +/// that returns a non-zero value. This is done on purpose, to ensure that group +/// consistency checks can return non-zero, but still print the output of +/// the group. So even if a test matches the output of group, it will still fail +/// because clang-refactor should return zero on exit when the group results are +/// consistent. +/// +/// \returns None on failure (errors are emitted to stderr), or a set of +/// grouped source ranges in the given file otherwise. +Optional findTestSelectionRanges(StringRef Filename); + +} // end namespace clang_refactor +} // end namespace clang + +#endif // LLVM_CLANG_TOOLS_CLANG_REFACTOR_TEST_SUPPORT_H Index: tools/clang-refactor/TestSupport.cpp =================================================================== --- /dev/null +++ tools/clang-refactor/TestSupport.cpp @@ -0,0 +1,252 @@ +//===--- TestSupport.cpp - Clang-based refactoring tool -------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +/// +/// \file +/// \brief This file implements routines that provide refactoring testing +/// utilities. +/// +//===----------------------------------------------------------------------===// + +#include "TestSupport.h" +#include "clang/Basic/SourceManager.h" +#include "clang/Lex/Lexer.h" +#include "llvm/ADT/STLExtras.h" +#include "llvm/Support/Error.h" +#include "llvm/Support/ErrorOr.h" +#include "llvm/Support/MemoryBuffer.h" +#include "llvm/Support/Regex.h" +#include "llvm/Support/raw_ostream.h" + +using namespace llvm; +using namespace clang; +using namespace clang_refactor; + +void TestSelectionRangesInFile::dump(raw_ostream &OS) const { + for (const auto &Group : GroupedRanges) { + OS << "Test selection group '" << Group.first << "':\n"; + for (const auto &Range : Group.second) { + OS << " " << Range.Begin << "-" << Range.End << "\n"; + } + } +} + +static void dumpChanges(const tooling::AtomicChanges &Changes, + raw_ostream &OS) { + for (const auto &Change : Changes) + OS << const_cast(Change).toYAMLString() << "\n"; +} + +static bool areChangesSame(const tooling::AtomicChanges &LHS, + const tooling::AtomicChanges &RHS) { + if (LHS.size() != RHS.size()) + return false; + for (const auto &I : llvm::zip(LHS, RHS)) { + if (!(std::get<0>(I) == std::get<1>(I))) + return false; + } + return true; +} + +bool printRewrittenSources(const tooling::AtomicChanges &Changes, + raw_ostream &OS) { + std::set Files; + for (const auto &Change : Changes) + Files.insert(Change.getFilePath()); + tooling::ApplyChangesSpec Spec; + Spec.Cleanup = false; + for (const auto &File : Files) { + llvm::ErrorOr> BufferErr = + llvm::MemoryBuffer::getFile(File); + if (!BufferErr) { + llvm::errs() << "failed to open" << File << "\n"; + return true; + } + auto Result = tooling::applyAtomicChanges(File, (*BufferErr)->getBuffer(), + Changes, Spec); + if (!Result) { + llvm::errs() << toString(Result.takeError()); + return true; + } + OS << *Result; + } + return false; +} + +bool TestSelectionRangesInFile::dispatch( + const SourceManager &SM, + llvm::function_ref(SourceRange)> Producer) + const { + const FileEntry *FE = SM.getFileManager().getFile(Filename); + FileID FID = FE ? SM.translateFile(FE) : FileID(); + if (!FE || FID.isInvalid()) { + llvm::errs() << "error: -selection=test:" << Filename + << " : given file is not in the target TU"; + return true; + } + SourceLocation FileLoc = SM.getLocForStartOfFile(FID); + bool Failed = false; + for (const auto &Group : GroupedRanges) { + // All ranges in the group must produce the same result. + Optional CanonicalResult; + Optional CanonicalErrorMessage; + for (const TestSelectionRange &Range : Group.second) { + // Translate the offset pair to a true source range. + SourceLocation Start = + SM.getMacroArgExpandedLocation(FileLoc.getLocWithOffset(Range.Begin)); + SourceLocation End = + SM.getMacroArgExpandedLocation(FileLoc.getLocWithOffset(Range.End)); + assert(Start.isValid() && End.isValid() && "unexpected invalid range"); + + Expected Result = + Producer(SourceRange(Start, End)); + std::string ErrorMessage; + bool HasResult = !!Result; + if (!HasResult) { + // FIXME: Handle diagnostic error as well. + handleAllErrors(Result.takeError(), [&](StringError &Err) { + ErrorMessage = Err.getMessage(); + }); + } + if (!CanonicalResult && !CanonicalErrorMessage) { + if (HasResult) + CanonicalResult = std::move(*Result); + else + CanonicalErrorMessage = std::move(ErrorMessage); + continue; + } + + // Verify that this result corresponds to the canonical result. + if (CanonicalErrorMessage) { + // The error messages must match. + if (!HasResult && ErrorMessage == *CanonicalErrorMessage) + continue; + } else { + assert(CanonicalResult && "missing canonical result"); + // The results must match. + if (HasResult && areChangesSame(*Result, *CanonicalResult)) + continue; + } + Failed = true; + // Report the mismatch. + llvm::errs() + << "error: unexpected refactoring result for range starting at " + << SM.getLineNumber(FID, Range.Begin) << ':' + << SM.getColumnNumber(FID, Range.Begin) << " in group '" + << Group.first << "':\n "; + if (HasResult) + llvm::errs() << "valid result"; + else + llvm::errs() << "error '" << ErrorMessage << "'"; + llvm::errs() << " does not match initial "; + if (CanonicalErrorMessage) + llvm::errs() << "error '" << *CanonicalErrorMessage << "'\n"; + else + llvm::errs() << "valid result\n"; + if (HasResult && !CanonicalErrorMessage) { + llvm::errs() << " Expected to Produce:\n"; + dumpChanges(*CanonicalResult, llvm::errs()); + llvm::errs() << " Produced:\n"; + dumpChanges(*Result, llvm::errs()); + } + } + + // Dump the results: + if (!CanonicalResult) { + llvm::errs() << Group.second.size() << " '" << Group.first + << "' results:\n"; + llvm::errs() << *CanonicalErrorMessage << "\n"; + } else { + llvm::outs() << Group.second.size() << " '" << Group.first + << "' results:\n"; + if (printRewrittenSources(*CanonicalResult, llvm::outs())) + return true; + } + } + return Failed; +} + +/// Adds the \p ColumnOffset to file offset \p Offset, without going past a +/// newline. +static unsigned addColumnOffset(StringRef Source, unsigned Offset, + unsigned ColumnOffset) { + if (!ColumnOffset) + return Offset; + StringRef Substr = Source.drop_front(Offset).take_front(ColumnOffset); + size_t NewlinePos = Substr.find_first_of("\r\n"); + return Offset + + (NewlinePos == StringRef::npos ? ColumnOffset : (unsigned)NewlinePos); +} + +Optional +clang_refactor::findTestSelectionRanges(StringRef Filename) { + ErrorOr> ErrOrFile = + MemoryBuffer::getFile(Filename); + if (!ErrOrFile) { + llvm::errs() << "error: -selection=test:" << Filename + << " : could not open the given file"; + return None; + } + StringRef Source = ErrOrFile.get()->getBuffer(); + + // FIXME (Alex L): 3rd capture groups for +line:column. + // See the doc comment for this function for the explanation of this + // syntax. + static Regex RangeRegex("range[[:blank:]]*([[:alpha:]_]*)?[[:blank:]]*=[[:" + "blank:]]*(\\+[[:digit:]]+)?"); + + TestSelectionRangesInFile TestRanges = {Filename.str(), {}}; + + LangOptions LangOpts; + LangOpts.CPlusPlus = 1; + LangOpts.CPlusPlus11 = 1; + Lexer Lex(SourceLocation::getFromRawEncoding(0), LangOpts, Source.begin(), + Source.begin(), Source.end()); + Lex.SetCommentRetentionState(true); + Token Tok; + for (Lex.LexFromRawLexer(Tok); Tok.isNot(tok::eof); + Lex.LexFromRawLexer(Tok)) { + if (Tok.isNot(tok::comment)) + continue; + StringRef Comment = + Source.substr(Tok.getLocation().getRawEncoding(), Tok.getLength()); + SmallVector Matches; + if (!RangeRegex.match(Comment, &Matches)) { + // Try to detect mistyped 'range:' comments to ensure tests don't miss + // anything. + if (Comment.contains_lower("range") && !Comment.contains_lower("run")) { + llvm::errs() << "error: suspicious comment '" << Comment + << "' that " + "resembles the range command found\n"; + llvm::errs() << "note: please reword if this isn't a range command\n"; + return None; + } + continue; + } + unsigned Offset = Tok.getEndLoc().getRawEncoding(); + unsigned ColumnOffset = 0; + if (!Matches[2].empty()) { + // Don't forget to drop the '+'! + if (Matches[2].drop_front().getAsInteger(10, ColumnOffset)) + assert(false && "regex should have produced a number"); + } + // FIXME (Alex L): Support true ranges. + Offset = addColumnOffset(Source, Offset, ColumnOffset); + TestSelectionRange Range = {Offset, Offset}; + auto It = TestRanges.GroupedRanges.insert(std::make_pair( + Matches[1].str(), SmallVector{Range})); + if (!It.second) + It.first->second.push_back(Range); + } + if (TestRanges.GroupedRanges.empty()) { + llvm::errs() << "error: -selection=test:" << Filename + << ": no 'range' commands"; + return None; + } + return std::move(TestRanges); +} Index: unittests/Tooling/RefactoringActionRulesTest.cpp =================================================================== --- unittests/Tooling/RefactoringActionRulesTest.cpp +++ unittests/Tooling/RefactoringActionRulesTest.cpp @@ -54,7 +54,8 @@ TEST_F(RefactoringActionRulesTest, MyFirstRefactoringRule) { auto ReplaceAWithB = - [](std::pair Selection) + [](const RefactoringRuleContext &, + std::pair Selection) -> Expected { const SourceManager &SM = Selection.first.getSources(); SourceLocation Loc = Selection.first.getRange().getBegin().getLocWithOffset( @@ -68,7 +69,8 @@ class SelectionRequirement : public selection::Requirement { public: std::pair - evaluateSelection(selection::SourceSelectionRange Selection) const { + evaluateSelection(const RefactoringRuleContext &, + selection::SourceSelectionRange Selection) const { return std::make_pair(Selection, 20); } }; @@ -124,8 +126,10 @@ } TEST_F(RefactoringActionRulesTest, ReturnError) { - Expected (*Func)(selection::SourceSelectionRange) = - [](selection::SourceSelectionRange) -> Expected { + Expected (*Func)(const RefactoringRuleContext &, + selection::SourceSelectionRange) = + [](const RefactoringRuleContext &, + selection::SourceSelectionRange) -> Expected { return llvm::make_error( "Error", llvm::make_error_code(llvm::errc::invalid_argument)); }; @@ -152,13 +156,14 @@ class SelectionRequirement : public selection::Requirement { public: Expected> - evaluateSelection(selection::SourceSelectionRange Selection) const { + evaluateSelection(const RefactoringRuleContext &, + selection::SourceSelectionRange Selection) const { return llvm::make_error( "bad selection", llvm::make_error_code(llvm::errc::invalid_argument)); } }; auto Rule = createRefactoringRule( - [](int) -> Expected { + [](const RefactoringRuleContext &, int) -> Expected { llvm::report_fatal_error("Should not run!"); }, requiredSelection(SelectionRequirement())); @@ -195,7 +200,8 @@ TEST_F(RefactoringActionRulesTest, ReturnSymbolOccurrences) { auto Rule = createRefactoringRule( - [](selection::SourceSelectionRange Selection) + [](const RefactoringRuleContext &, + selection::SourceSelectionRange Selection) -> Expected { SymbolOccurrences Occurrences; Occurrences.push_back(SymbolOccurrence(