[refactoring] Upstreaming the implementation for Swift local refactoring (#11568)

[refactoring] Upstreaming the implementation for Swift local refactoring

Author: akyrtzi

Diff for: docs/Refactoring.md

@@ -0,0 +1,2 @@
+This is placeholder for documentation related to Swift local refactoring.
+It will be expanded soon..

Diff for: include/swift/AST/ASTPrinter.h

@@ -319,6 +319,11 @@ uint8_t getKeywordLen(tok keyword);
 /// Get <#code#>;
 StringRef getCodePlaceholder();
 
+/// Given an array of enum element decls, print them as case statements with
+/// placeholders as contents.
+void printEnumElementsAsCases(
+    llvm::DenseSet<EnumElementDecl *> &UnhandledElements,
+    llvm::raw_ostream &OS);
 } // namespace swift
 
 #endif // LLVM_SWIFT_AST_ASTPRINTER_H

Diff for: include/swift/AST/DiagnosticsAll.def

@@ -43,6 +43,7 @@
 #include "DiagnosticsIRGen.def"
 #include "DiagnosticsFrontend.def"
 #include "DiagnosticsDriver.def"
+#include "DiagnosticsRefactoring.def"
 
 #undef DIAG_NO_UNDEF
 

Diff for: include/swift/AST/DiagnosticsRefactoring.def

@@ -0,0 +1,73 @@
+//===--- DiagnosticsRefactoring.def - Diagnostics Text ----------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+//  This file defines diagnostics emitted during refactoring.
+//  Each diagnostic is described using one of three kinds (error, warning, or
+//  note) along with a unique identifier, category, options, and text, and is
+//  followed by a signature describing the diagnostic argument kinds.
+//
+//===----------------------------------------------------------------------===//
+
+#if !(defined(DIAG) || (defined(ERROR) && defined(WARNING) && defined(NOTE)))
+#  error Must define either DIAG or the set {ERROR,WARNING,NOTE}
+#endif
+
+#ifndef ERROR
+#  define ERROR(ID,Options,Text,Signature)   \
+  DIAG(ERROR,ID,Options,Text,Signature)
+#endif
+
+#ifndef WARNING
+#  define WARNING(ID,Options,Text,Signature) \
+  DIAG(WARNING,ID,Options,Text,Signature)
+#endif
+
+#ifndef NOTE
+#  define NOTE(ID,Options,Text,Signature) \
+  DIAG(NOTE,ID,Options,Text,Signature)
+#endif
+
+//==============================================================================
+// Refactoring diagnostics
+//==============================================================================
+
+ERROR(invalid_name, none, "'%0' is not a valid name", (StringRef))
+
+ERROR(invalid_location, none, "given location is not valid", ())
+
+ERROR(arity_mismatch, none, "the given new name '%0' does not match the arity of the old name '%1'", (StringRef, StringRef))
+
+ERROR(name_not_functionlike, none, "the 'call' name usage cannot be used with a non-function-like name '%0'", (StringRef))
+
+ERROR(unresolved_location, none, "cannot resolve location as name", ())
+
+ERROR(location_module_mismatch, none, "given location does not belong to module '%0'", (StringRef))
+
+ERROR(value_decl_no_loc, none, "value decl '%0' has no declaration location", (DeclName))
+
+ERROR(value_decl_referenced_out_of_range, none, "value decl '%0' is referenced out of range", (DeclName))
+
+ERROR(multi_entry_range, none, "selected range has more than one entry point", ())
+
+ERROR(orphan_loop_keyword, none, "selected range contains %0 but not its target loop", (StringRef))
+
+ERROR(invalid_default_location, none, "given location is not on a default statement", ())
+
+ERROR(no_parent_switch, none, "cannot find enclosing switch statement", ())
+
+ERROR(no_subject_enum, none, "cannot find subject enum in the enclosing switch statement", ())
+
+ERROR(no_remaining_cases, none, "no remaining cases to expand", ())
+
+WARNING(mismatched_rename, none, "the name at the given location cannot be renamed to '%0'", (StringRef))
+
+ERROR(no_insert_position, none, "cannot find inserting position", ())

Diff for: include/swift/AST/DiagnosticsRefactoring.h

@@ -0,0 +1,32 @@
+//===--- DiagnosticsRefactoring.h - Diagnostic Definitions -----*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+/// \file
+/// \brief This file defines diagnostics for refactoring.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_DIAGNOSTICSREFACTORING_H
+#define SWIFT_DIAGNOSTICSREFACTORING_H
+
+#include "swift/AST/DiagnosticsCommon.h"
+
+namespace swift {
+  namespace diag {
+  // Declare common diagnostics objects with their appropriate types.
+#define DIAG(KIND,ID,Options,Text,Signature) \
+  extern detail::DiagWithArguments<void Signature>::type ID;
+#include "DiagnosticsRefactoring.def"
+  }
+}
+
+#endif

Diff for: include/swift/AST/ProtocolConformance.h

@@ -93,7 +93,7 @@ class alignas(1 << DeclAlignInBits) ProtocolConformance {
   /// \brief The type that conforms to the protocol, in the context of the
   /// conformance definition.
   Type ConformingType;
-  
+
 protected:
   ProtocolConformance(ProtocolConformanceKind kind, Type conformingType)
     : Kind(kind), ConformingType(conformingType) { }
@@ -199,6 +199,36 @@ class alignas(1 << DeclAlignInBits) ProtocolConformance {
   bool hasWitness(ValueDecl *requirement) const;
 
 public:
+  /// Apply the given function object to each requirement, either type or value,
+  /// that is not witnessed.
+  ///
+  /// The function object should accept a \c ValueDecl* for the requirement.
+  template<typename F>
+  void forEachNonWitnessedRequirement(LazyResolver *Resolver, F f) const {
+    const ProtocolDecl *protocol = getProtocol();
+    for (auto req : protocol->getMembers()) {
+      auto valueReq = dyn_cast<ValueDecl>(req);
+      if (!valueReq || valueReq->isInvalid())
+        continue;
+
+      if (auto assocTypeReq = dyn_cast<AssociatedTypeDecl>(req)) {
+        // If we don't have witness for the associated type, apply the function.
+        if (getTypeWitness(assocTypeReq, Resolver)->hasError()) {
+          f(valueReq);
+        }
+        continue;
+      }
+
+      if (!valueReq->isProtocolRequirement())
+        continue;
+
+      // If we don't have witness for the value, apply the function.
+      if (!hasWitness(valueReq)) {
+        f(valueReq);
+      }
+    }
+  }
+
   /// Retrieve the protocol conformance for the inherited protocol.
   ProtocolConformance *getInheritedConformance(ProtocolDecl *protocol) const;
 
@@ -213,7 +243,7 @@ class alignas(1 << DeclAlignInBits) ProtocolConformance {
   ProtocolConformanceRef
   getAssociatedConformance(Type assocType, ProtocolDecl *protocol,
                            LazyResolver *resolver = nullptr) const;
- 
+
   /// Get the generic parameters open on the conforming type.
   GenericEnvironment *getGenericEnvironment() const;
 
@@ -252,15 +282,15 @@ class alignas(1 << DeclAlignInBits) ProtocolConformance {
     assert(mem);
     return mem;
   }
-  
+
   /// Print a parseable and human-readable description of the identifying
   /// information of the protocol conformance.
   void printName(raw_ostream &os,
                  const PrintOptions &PO = PrintOptions()) const;
-  
+
   /// True if the conformance is for a property behavior instantiation.
   bool isBehaviorConformance() const;
-  
+
   /// Get the property declaration for a behavior conformance, if this is one.
   AbstractStorageDecl *getBehaviorDecl() const;
 
@@ -269,7 +299,7 @@ class alignas(1 << DeclAlignInBits) ProtocolConformance {
   ProtocolConformance *subst(Type substType,
                              TypeSubstitutionFn subs,
                              LookupConformanceFn conformances) const;
-  
+
   void dump() const;
   void dump(llvm::raw_ostream &out, unsigned indent = 0) const;
 };
@@ -348,7 +378,7 @@ class NormalProtocolConformance : public ProtocolConformance,
   /// Get the protocol being conformed to.
   ProtocolDecl *getProtocol() const { return ProtocolAndState.getPointer(); }
 
-  /// Retrieve the location of this 
+  /// Retrieve the location of this
   SourceLoc getLoc() const { return Loc; }
 
   /// Get the declaration context that contains the conforming extension or
@@ -376,7 +406,7 @@ class NormalProtocolConformance : public ProtocolConformance,
   bool isInvalid() const {
     return ContextAndInvalid.getInt();
   }
-  
+
   /// Mark this conformance as invalid.
   void setInvalid() {
     ContextAndInvalid.setInt(true);
@@ -391,7 +421,7 @@ class NormalProtocolConformance : public ProtocolConformance,
   bool isBehaviorConformance() const {
     return ContextAndInvalid.getPointer().is<AbstractStorageDecl *>();
   }
-  
+
   /// Return the declaration using the behavior for this conformance, or null
   /// if this isn't a behavior conformance.
   AbstractStorageDecl *getBehaviorDecl() const {

Diff for: include/swift/IDE/Refactoring.h

@@ -0,0 +1,151 @@
+//===--- Refactoring.h - APIs for refactoring --------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_IDE_REFACTORING_H
+#define SWIFT_IDE_REFACTORING_H
+
+#include "llvm/ADT/StringRef.h"
+#include "swift/Basic/LLVM.h"
+#include "swift/AST/DiagnosticConsumer.h"
+#include "swift/IDE/Utils.h"
+
+namespace swift {
+  class ModuleDecl;
+  class SourceLoc;
+  class SourceManager;
+
+namespace ide {
+  struct SemaToken;
+
+enum class RefactoringKind : int8_t {
+  None,
+#define REFACTORING(KIND, NAME, ID) KIND,
+#include "RefactoringKinds.def"
+};
+
+struct RangeConfig {
+  unsigned BufferId;
+  unsigned Line;
+  unsigned Column;
+  unsigned Length;
+  SourceLoc getStart(SourceManager &SM);
+  SourceLoc getEnd(SourceManager &SM);
+};
+
+enum class NameUsage {
+  Unknown,
+  Reference,
+  Definition,
+  Call
+};
+
+struct RenameLoc {
+  unsigned Line;
+  unsigned Column;
+  NameUsage Usage;
+  StringRef OldName;
+  StringRef NewName; // May be empty.
+  const bool IsFunctionLike;
+  const bool IsNonProtocolType;
+};
+
+struct RefactoringOptions {
+  RefactoringKind Kind;
+  RangeConfig Range;
+  std::string PreferredName;
+  RefactoringOptions(RefactoringKind Kind) : Kind(Kind) {}
+};
+
+// TODO: Merge with NoteRegion – range needs to change to start/end line/column
+struct RenameRangeDetail {
+  CharSourceRange Range;
+  RefactoringRangeKind RangeKind;
+  Optional<unsigned> Index;
+};
+
+enum class RenameAvailableKind {
+  Available,
+  Unavailable_system_symbol,
+  Unavailable_has_no_location,
+  Unavailable_has_no_name,
+  Unavailable_has_no_accessibility,
+  Unavailable_decl_from_clang,
+};
+
+struct RenameAvailabiliyInfo {
+  RefactoringKind Kind;
+  RenameAvailableKind AvailableKind;
+  RenameAvailabiliyInfo(RefactoringKind Kind, RenameAvailableKind AvailableKind) :
+    Kind(Kind), AvailableKind(AvailableKind) {}
+  RenameAvailabiliyInfo(RefactoringKind Kind) :
+    RenameAvailabiliyInfo(Kind, RenameAvailableKind::Available) {}
+};
+
+class FindRenameRangesConsumer {
+public:
+  virtual void accept(SourceManager &SM, RegionType RegionType,
+                      ArrayRef<RenameRangeDetail> Ranges) = 0;
+  virtual ~FindRenameRangesConsumer() = default;
+};
+
+class FindRenameRangesAnnotatingConsumer : public FindRenameRangesConsumer {
+  struct Implementation;
+  Implementation &Impl;
+
+public:
+  FindRenameRangesAnnotatingConsumer(SourceManager &SM, unsigned BufferId,
+                                     llvm::raw_ostream &OS);
+  ~FindRenameRangesAnnotatingConsumer();
+  void accept(SourceManager &SM, RegionType RegionType,
+              ArrayRef<RenameRangeDetail> Ranges) override;
+};
+
+StringRef getDescriptiveRefactoringKindName(RefactoringKind Kind);
+
+StringRef getDescriptiveRenameUnavailableReason(RenameAvailableKind Kind);
+
+bool refactorSwiftModule(ModuleDecl *M, RefactoringOptions Opts,
+                         SourceEditConsumer &EditConsumer,
+                         DiagnosticConsumer &DiagConsumer);
+
+int syntacticRename(SourceFile *SF, llvm::ArrayRef<RenameLoc> RenameLocs,
+                    SourceEditConsumer &EditConsumer,
+                    DiagnosticConsumer &DiagConsumer);
+
+int findSyntacticRenameRanges(SourceFile *SF,
+                              llvm::ArrayRef<RenameLoc> RenameLocs,
+                              FindRenameRangesConsumer &RenameConsumer,
+                              DiagnosticConsumer &DiagConsumer);
+
+int findLocalRenameRanges(SourceFile *SF, RangeConfig Range,
+                          FindRenameRangesConsumer &RenameConsumer,
+                          DiagnosticConsumer &DiagConsumer);
+
+ArrayRef<RefactoringKind>
+collectAvailableRefactorings(SourceFile *SF, RangeConfig Range,
+                             bool &RangeStartMayNeedRename,
+                             std::vector<RefactoringKind> &Scratch,
+                             llvm::ArrayRef<DiagnosticConsumer*> DiagConsumers);
+
+ArrayRef<RefactoringKind>
+collectAvailableRefactorings(SourceFile *SF, SemaToken Tok,
+                             std::vector<RefactoringKind> &Scratch,
+                             bool ExcludeRename);
+
+ArrayRef<RenameAvailabiliyInfo>
+collectRenameAvailabilityInfo(const ValueDecl *VD,
+                              std::vector<RenameAvailabiliyInfo> &Scratch);
+
+} // namespace ide
+} // namespace swift
+
+#endif // SWIFT_IDE_REFACTORING_H