[migrator] Add pass for API type changes

This handles optionality changes and type rewrites in function param and return types and constructor param and failability types.
Resolves rdar://problem/31766010

Author: Nathan Hawes

include/swift/IDE/APIDigesterData.h

@@ -95,6 +95,20 @@ struct CommonDiffItem: public APIDiffItem {
     return DiffKind == NodeAnnotation::Rename ||
       DiffKind == NodeAnnotation::ModernizeEnum;
   }
+
+  bool isTypeChange() const {
+    switch (DiffKind) {
+    case NodeAnnotation::WrapOptional:
+    case NodeAnnotation::UnwrapOptional:
+    case NodeAnnotation::ImplicitOptionalToOptional:
+    case NodeAnnotation::OptionalToImplicitOptional:
+    case NodeAnnotation::WrapImplicitOptional:
+    case NodeAnnotation::TypeRewritten:
+      return true;
+    default:
+      return false;
+    }
+  }
   StringRef getNewName() const { assert(isRename()); return RightComment; }
   APIDiffItemKind getKind() const override {
     return APIDiffItemKind::ADK_CommonDiffItem;

include/swift/Index/Index.h

@@ -20,6 +20,14 @@ class ModuleDecl;
 class SourceFile;
 class DeclContext;
 
+// Get decls that the given decl overrides, protocol requirements that it
+// serves as a default implementation of, and optionally (as it is more
+// expensive) protocol requirements it satisfies in a conforming class
+std::vector<ValueDecl*>
+getOverriddenDecls(ValueDecl *VD, bool IncludeProtocolRequirements = true,
+                   bool Transitive = false);
+
+
 namespace index {
 
 void indexDeclContext(DeclContext *DC, IndexDataConsumer &consumer);

include/swift/Migrator/EditorAdapter.h

@@ -105,6 +105,7 @@ class EditorAdapter {
                        bool AfterToken = false,
                        bool BeforePreviousInsertions = false);
   bool insertWrap(StringRef before, SourceRange TokenRange, StringRef after);
+  bool remove(SourceLoc TokenLoc);
   bool remove(SourceRange TokenRange);
   bool replace(SourceRange TokenRange, StringRef Text);
   bool replaceWithInner(SourceRange TokenRange, SourceRange TokenInnerRange);

lib/Index/Index.cpp

@@ -663,30 +663,11 @@ bool IndexSwiftASTWalker::startEntityDecl(ValueDecl *D) {
       return false;
   }
 
-  if (auto Overridden = D->getOverriddenDecl()) {
-    if (addRelation(Info, (SymbolRoleSet) SymbolRole::RelationOverrideOf, Overridden))
+  for (auto Overriden: getOverriddenDecls(D, /*IncludeProtocolReqs=*/!isSystemModule)) {
+    if (addRelation(Info, (SymbolRoleSet) SymbolRole::RelationOverrideOf, Overriden))
       return false;
   }
 
-  {
-    // Collect the protocol requirements this decl can provide default
-    // implementations to, and record them as overriding.
-    llvm::SmallVector<ValueDecl*, 2> Buffer;
-    for (auto Req : canDeclProvideDefaultImplementationFor(D, Buffer)) {
-      if (addRelation(Info, (SymbolRoleSet) SymbolRole::RelationOverrideOf, Req))
-        return false;
-    }
-  }
-
-  // FIXME: This is quite expensive and not worth the cost for indexing purposes
-  // of system modules. Revisit if this becomes more efficient.
-  if (!isSystemModule) {
-    for (auto Conf : D->getSatisfiedProtocolRequirements()) {
-      if (addRelation(Info, (SymbolRoleSet) SymbolRole::RelationOverrideOf, Conf))
-        return false;
-    }
-  }
-
   if (auto Parent = getParentDecl()) {
     if (auto ParentVD = dyn_cast<ValueDecl>(Parent)) {
       SymbolRoleSet RelationsToParent = (SymbolRoleSet)SymbolRole::RelationChildOf;
@@ -1398,6 +1379,33 @@ void IndexSwiftASTWalker::getModuleHash(SourceFileOrModule Mod,
   OS << llvm::APInt(64, code).toString(36, /*Signed=*/false);
 }
 
+std::vector<ValueDecl*> swift::
+getOverriddenDecls(ValueDecl *VD, bool IncludeProtocolRequirements,
+                   bool Transitive) {
+  std::vector<ValueDecl*> results;
+
+  if (auto Overridden = VD->getOverriddenDecl()) {
+    results.push_back(Overridden);
+    while (Transitive && (Overridden = Overridden->getOverriddenDecl()))
+      results.push_back(Overridden);
+  }
+
+  // Collect the protocol requirements this decl is a default impl for
+  llvm::SmallVector<ValueDecl*, 2> Buffer;
+  for (auto Req : canDeclProvideDefaultImplementationFor(VD, Buffer)) {
+    results.push_back(Req);
+  }
+
+  if (IncludeProtocolRequirements) {
+    for (auto Satisfied : VD->getSatisfiedProtocolRequirements()) {
+      results.push_back(Satisfied);
+    }
+  }
+
+  return results;
+}
+
+
 //===----------------------------------------------------------------------===//
 // Indexing entry points
 //===----------------------------------------------------------------------===//

lib/Migrator/EditorAdapter.cpp

@@ -13,6 +13,7 @@
 #include "swift/Basic/SourceLoc.h"
 #include "swift/Basic/SourceManager.h"
 #include "swift/Migrator/EditorAdapter.h"
+#include "swift/Parse/Lexer.h"
 #include "clang/Basic/SourceManager.h"
 
 using namespace swift;
@@ -60,12 +61,27 @@ translateCharSourceRange(CharSourceRange SwiftSourceSourceRange) const {
   return clang::CharSourceRange::getCharRange(ClangStartLoc, ClangEndLoc);
 }
 
+bool EditorAdapter::insert(SourceLoc Loc, StringRef Text, bool AfterToken,
+                           bool BeforePreviousInsertions) {
+  // We don't have tokens on the clang side, so handle AfterToken in Swift
+  if (AfterToken)
+    Loc = Lexer::getLocForEndOfToken(SwiftSrcMgr, Loc);
+
+  auto ClangLoc = translateSourceLoc(Loc);
+  return Edits.insert(ClangLoc, Text, /*AfterToken=*/false, BeforePreviousInsertions);
+}
+
 bool EditorAdapter::insertFromRange(SourceLoc Loc, CharSourceRange Range,
                                     bool AfterToken,
                                     bool BeforePreviousInsertions) {
+  // We don't have tokens on the clang side, so handle AfterToken in Swift
+  if (AfterToken)
+    Loc = Lexer::getLocForEndOfToken(SwiftSrcMgr, Loc);
+
   auto ClangLoc = translateSourceLoc(Loc);
   auto ClangCharRange = translateCharSourceRange(Range);
-  return Edits.insertFromRange(ClangLoc, ClangCharRange, AfterToken,
+
+  return Edits.insertFromRange(ClangLoc, ClangCharRange, /*AfterToken=*/false,
                                BeforePreviousInsertions);
 }
 
@@ -100,32 +116,35 @@ bool EditorAdapter::replaceText(SourceLoc Loc, StringRef Text,
 bool EditorAdapter::insertFromRange(SourceLoc Loc, SourceRange TokenRange,
                      bool AfterToken,
                      bool BeforePreviousInsertions) {
-  CharSourceRange CharRange { SwiftSrcMgr, TokenRange.Start, TokenRange.End };
+  auto CharRange = Lexer::getCharSourceRangeFromSourceRange(SwiftSrcMgr, TokenRange);
   return insertFromRange(Loc, CharRange,
                          AfterToken, BeforePreviousInsertions);
 }
 
 bool EditorAdapter::insertWrap(StringRef Before, SourceRange TokenRange,
                                StringRef After) {
-  CharSourceRange CharRange { SwiftSrcMgr, TokenRange.Start, TokenRange.End };
+  auto CharRange = Lexer::getCharSourceRangeFromSourceRange(SwiftSrcMgr, TokenRange);
   return insertWrap(Before, CharRange, After);
 }
 
+bool EditorAdapter::remove(SourceLoc TokenLoc) {
+  return remove(Lexer::getCharSourceRangeFromSourceRange(SwiftSrcMgr,
+                                                         TokenLoc));
+}
+
 bool EditorAdapter::remove(SourceRange TokenRange) {
-  CharSourceRange CharRange { SwiftSrcMgr, TokenRange.Start, TokenRange.End };
+  auto CharRange = Lexer::getCharSourceRangeFromSourceRange(SwiftSrcMgr, TokenRange);
   return remove(CharRange);
 }
 
 bool EditorAdapter::replace(SourceRange TokenRange, StringRef Text) {
-  CharSourceRange CharRange { SwiftSrcMgr, TokenRange.Start, TokenRange.End };
+  auto CharRange = Lexer::getCharSourceRangeFromSourceRange(SwiftSrcMgr,TokenRange);
   return replace(CharRange, Text);
 }
 
 bool EditorAdapter::replaceWithInner(SourceRange TokenRange,
                                      SourceRange TokenInnerRange) {
-  CharSourceRange CharRange { SwiftSrcMgr, TokenRange.Start, TokenRange.End };
-  CharSourceRange CharInnerRange {
-    SwiftSrcMgr, TokenInnerRange.Start, TokenInnerRange.End
-  };
+  auto CharRange = Lexer::getCharSourceRangeFromSourceRange(SwiftSrcMgr, TokenRange);
+  auto CharInnerRange = Lexer::getCharSourceRangeFromSourceRange(SwiftSrcMgr, TokenInnerRange);
   return replaceWithInner(CharRange, CharInnerRange);
 }

lib/Migrator/Migrator.cpp

@@ -125,15 +125,15 @@ Migrator::performAFixItMigration() {
   }
 
   FixitApplyDiagnosticConsumer FixitApplyConsumer {
-    InputState->getInputText(),
+    InputState->getOutputText(),
     getInputFilename(),
   };
   Instance.addDiagnosticConsumer(&FixitApplyConsumer);
 
   Instance.performSema();
 
-  StringRef ResultText = InputState->getInputText();
-  unsigned ResultBufferID = InputState->getInputBufferID();
+  StringRef ResultText = InputState->getOutputText();
+  unsigned ResultBufferID = InputState->getOutputBufferID();
 
   if (FixitApplyConsumer.getNumFixitsApplied() > 0) {
     SmallString<4096> Scratch;
@@ -145,7 +145,7 @@ Migrator::performAFixItMigration() {
   }
 
   return MigrationState::make(MigrationKind::CompilerFixits,
-                              SrcMgr, InputState->getInputBufferID(),
+                              SrcMgr, InputState->getOutputBufferID(),
                               ResultBufferID);
 }