Merge pull request #17305 from nkcsgexi/cherry-pick-06-18

[4.2-06-11] Cherry-pick migrator changes

Author: nkcsgexi

include/swift/IDE/DigesterEnums.def

@@ -80,6 +80,7 @@ NODE_ANNOTATION_CHANGE_KIND(OptionalArrayMemberUpdate)
 NODE_ANNOTATION_CHANGE_KIND(SimpleStringRepresentableUpdate)
 NODE_ANNOTATION_CHANGE_KIND(SimpleOptionalStringRepresentableUpdate)
 NODE_ANNOTATION_CHANGE_KIND(TypeAliasDeclToRawRepresentable)
+NODE_ANNOTATION_CHANGE_KIND(RevertTypeAliasDeclToRawRepresentable)
 
 NODE_ANNOTATION_CHANGE_KIND(RevertDictionaryKeyUpdate)
 NODE_ANNOTATION_CHANGE_KIND(RevertOptionalDictionaryKeyUpdate)

lib/Migrator/APIDiffMigratorPass.cpp

@@ -275,6 +275,8 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
 
   std::vector<APIDiffItem*> getRelatedDiffItems(ValueDecl *VD) {
     std::vector<APIDiffItem*> results;
+    if (!VD)
+      return results;
     auto addDiffItems = [&](ValueDecl *VD) {
       llvm::SmallString<64> Buffer;
       llvm::raw_svector_ostream OS(Buffer);
@@ -921,9 +923,66 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
     insertHelperFunction(Kind, RawType, NewAttributeType, FromString, WrapTarget);
   }
 
+  bool hasRevertRawRepresentableChange(ValueDecl *VD) {
+    for (auto Item: getRelatedDiffItems(VD)) {
+      if (auto *CI = dyn_cast<CommonDiffItem>(Item)) {
+        if (CI->DiffKind ==
+              NodeAnnotation::RevertTypeAliasDeclToRawRepresentable)
+          return true;
+      }
+    }
+    return false;
+  }
+
+  bool handleRevertRawRepresentable(Expr *E) {
+    // Change attribute.rawValue to attribute
+    if (auto *MRE = dyn_cast<MemberRefExpr>(E)) {
+      auto Found = false;
+      if (auto *Base = MRE->getBase()) {
+        if (hasRevertRawRepresentableChange(Base->getType()->getAnyNominal())) {
+          Found = true;
+        }
+      }
+      if (!Found)
+        return false;
+      auto NL = MRE->getNameLoc().getStartLoc();
+      auto DL = MRE->getDotLoc();
+      if (NL.isInvalid() || DL.isInvalid())
+        return false;
+      CharSourceRange Range = Lexer::getCharSourceRangeFromSourceRange(SM, {DL, NL});
+      if (Range.str() == ".rawValue") {
+        Editor.remove(Range);
+        return true;
+      }
+    }
+
+    // Change attribute(rawValue: "value") to "value"
+    if (auto *CE = dyn_cast<CallExpr>(E)) {
+      auto Found = false;
+      if (auto *CRC = dyn_cast<ConstructorRefCallExpr>(CE->getFn())) {
+        if (auto *TE = dyn_cast<TypeExpr>(CRC->getBase())) {
+          if (hasRevertRawRepresentableChange(TE->getInstanceType()->getAnyNominal()))
+            Found = true;
+        }
+      }
+      if (!Found)
+        return false;
+      std::vector<CallArgInfo> AllArgs =
+        getCallArgInfo(SM, CE->getArg(), LabelRangeEndAt::LabelNameOnly);
+      if (AllArgs.size() == 1 && AllArgs.front().LabelRange.str() == "rawValue") {
+        Editor.replace(CE->getSourceRange(), Lexer::getCharSourceRangeFromSourceRange(SM,
+          AllArgs.front().ArgExp->getSourceRange()).str());
+        return true;
+      }
+    }
+    return false;
+  }
+
   bool walkToExprPre(Expr *E) override {
     if (E->getSourceRange().isInvalid())
       return false;
+    if (handleRevertRawRepresentable(E))
+      return false;
     if (handleQualifiedReplacement(E))
       return false;
     if (handleAssignDestMigration(E))

test/Migrator/Inputs/Cities.swift

@@ -74,3 +74,17 @@ public enum FontWeight: Int {
   case Regular
   case Bold
 }
+
+public struct AwesomeCityAttribute: RawRepresentable {
+  public init?(rawValue: String) { self.rawValue = rawValue }
+  public var rawValue: String
+  public typealias RawValue = String
+}
+
+public class Wrapper {
+  public struct Attribute: RawRepresentable {
+    public init?(rawValue: String) { self.rawValue = rawValue }
+    public var rawValue: String
+    public typealias RawValue = String
+  }
+}

test/Migrator/Inputs/string-representable.json

@@ -227,4 +227,26 @@
     "RightComment": "AwesomeIntWrapper",
     "ModuleName": "bar"
   },
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "TypeDecl",
+    "NodeAnnotation": "RevertTypeAliasDeclToRawRepresentable",
+    "ChildIndex": "0",
+    "LeftUsr": "s:6Cities20AwesomeCityAttributeV",
+    "LeftComment": "String",
+    "RightUsr": "",
+    "RightComment": "String",
+    "ModuleName": "Cities"
+  },
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "TypeDecl",
+    "NodeAnnotation": "RevertTypeAliasDeclToRawRepresentable",
+    "ChildIndex": "0",
+    "LeftUsr": "s:6Cities7WrapperC9AttributeV",
+    "LeftComment": "String",
+    "RightUsr": "",
+    "RightComment": "String",
+    "ModuleName": "Cities"
+  },
 ]

test/Migrator/string-representable.swift

@@ -45,3 +45,12 @@ func foo(_ c: Container) -> String {
 }
 
 class C: BarForwardDeclaredClass {}
+
+func revert(_ a: AwesomeCityAttribute, b: Wrapper.Attribute) {
+  _ = AwesomeCityAttribute(rawValue: "somevalue")
+  _ = AwesomeCityAttribute.init(rawValue: "somevalue")
+  _ = a.rawValue
+  _ = Wrapper.Attribute(rawValue: "somevalue")
+  _ = Wrapper.Attribute.init(rawValue: "somevalue")
+  _ = b.rawValue
+}

test/Migrator/string-representable.swift.expected

@@ -46,6 +46,15 @@ func foo(_ c: Container) -> String {
 
 class C: BarForwardDeclaredClass {}
 
+func revert(_ a: AwesomeCityAttribute, b: Wrapper.Attribute) {
+  _ = "somevalue"
+  _ = "somevalue"
+  _ = a
+  _ = "somevalue"
+  _ = "somevalue"
+  _ = b
+}
+
 // Helper function inserted by Swift 4.2 migrator.
 fileprivate func convertToNewAttribute(_ input: String) -> NewAttribute {
 	return NewAttribute(rawValue: input)

test/api-digester/Outputs/apinotes-migrator-gen-revert.json

@@ -1,4 +1,15 @@
 [
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "TypeDecl",
+    "NodeAnnotation": "RevertTypeAliasDeclToRawRepresentable",
+    "ChildIndex": "0",
+    "LeftUsr": "c:APINotesTest.h@T@CatAttributeName",
+    "LeftComment": "String",
+    "RightUsr": "",
+    "RightComment": "NSString",
+    "ModuleName": "APINotesTest"
+  },
   {
     "DiffItemKind": "CommonDiffItem",
     "NodeKind": "Function",

tools/swift-api-digester/swift-api-digester.cpp

@@ -252,6 +252,7 @@ class SDKContext {
   llvm::BumpPtrAllocator Allocator;
   UpdatedNodesMap UpdateMap;
   NodeMap TypeAliasUpdateMap;
+  NodeMap RevertTypeAliasUpdateMap;
   TypeMemberDiffVector TypeMemberDiffs;
 public:
   llvm::BumpPtrAllocator &allocator() {
@@ -266,6 +267,9 @@ class SDKContext {
   NodeMap &getTypeAliasUpdateMap() {
     return TypeAliasUpdateMap;
   }
+  NodeMap &getRevertTypeAliasUpdateMap() {
+    return RevertTypeAliasUpdateMap;
+  }
   TypeMemberDiffVector &getTypeMemberDiffs() {
     return TypeMemberDiffs;
   }
@@ -3793,6 +3797,27 @@ static int diagnoseModuleChange(StringRef LeftPath, StringRef RightPath) {
   return 0;
 }
 
+static void populateAliasChanges(NodeMap &AliasMap, DiffVector &AllItems,
+    const bool isRevert) {
+  for (auto Pair: AliasMap) {
+    auto UnderlyingType = Pair.first->getAs<SDKNodeDeclTypeAlias>()->
+      getUnderlyingType()->getPrintedName();
+    auto RawType = AliasMap[(SDKNode*)Pair.first]->getAs<SDKNodeDeclType>()->
+      getRawValueType()->getPrintedName();
+    if (isRevert) {
+      auto *D = Pair.second->getAs<SDKNodeDecl>();
+      AllItems.emplace_back(SDKNodeKind::DeclType,
+        NodeAnnotation::RevertTypeAliasDeclToRawRepresentable, "0",
+        D->getUsr(), "", RawType, UnderlyingType, D->getModuleName());
+    } else {
+      auto *D = Pair.first->getAs<SDKNodeDecl>();
+      AllItems.emplace_back(SDKNodeKind::DeclTypeAlias,
+        NodeAnnotation::TypeAliasDeclToRawRepresentable, "0",
+        D->getUsr(), "", UnderlyingType, RawType, D->getModuleName());
+    }
+  }
+}
+
 static int compareSDKs(StringRef LeftPath, StringRef RightPath,
                        StringRef DiffPath,
                        llvm::StringSet<> &IgnoredRemoveUsrs) {
@@ -3827,20 +3852,15 @@ static int compareSDKs(StringRef LeftPath, StringRef RightPath,
   DiffVector AllItems;
   DiffItemEmitter::collectDiffItems(LeftModule, AllItems);
 
-  auto &AliasMap = Ctx.getTypeAliasUpdateMap();
   // Find type alias change first.
+  auto &AliasMap = Ctx.getTypeAliasUpdateMap();
   TypeAliasDiffFinder(LeftModule, RightModule, AliasMap).search();
+  populateAliasChanges(AliasMap, AllItems, /*IsRevert*/false);
 
-  for (auto Pair: AliasMap) {
-    auto Left = Pair.first->getAs<SDKNodeDeclTypeAlias>()->getUnderlyingType()->
-      getPrintedName();
-    auto Right = AliasMap[(SDKNode*)Pair.first]->getAs<SDKNodeDeclType>()->
-      getRawValueType()->getPrintedName();
-    auto *D = Pair.first->getAs<SDKNodeDecl>();
-    AllItems.emplace_back(SDKNodeKind::DeclTypeAlias,
-      NodeAnnotation::TypeAliasDeclToRawRepresentable, "0",
-      D->getUsr(), "", Left, Right, D->getModuleName());
-  }
+  // Find type alias revert change.
+  auto &RevertAliasMap = Ctx.getRevertTypeAliasUpdateMap();
+  TypeAliasDiffFinder(RightModule, LeftModule, RevertAliasMap).search();
+  populateAliasChanges(RevertAliasMap, AllItems, /*IsRevert*/true);
 
   AllItems.erase(std::remove_if(AllItems.begin(), AllItems.end(),
                                 [&](CommonDiffItem &Item) {