swift-api-digester: detect simple parameter/return type update from String to StringRepresentableStruct.

nkcsgexi · nkcsgexi · commit e15c19782369 · 2018-04-08T13:24:12.000-07:00
diff --git a/include/swift/IDE/DigesterEnums.def b/include/swift/IDE/DigesterEnums.def
@@ -78,6 +78,8 @@ NODE_ANNOTATION(DictionaryKeyUpdate)
 NODE_ANNOTATION(OptionalDictionaryKeyUpdate)
 NODE_ANNOTATION(ArrayMemberUpdate)
 NODE_ANNOTATION(OptionalArrayMemberUpdate)
+NODE_ANNOTATION(SimpleStringRepresentableUpdate)
+NODE_ANNOTATION(SimpleOptionalStringRepresentableUpdate)
 
 DECL_ATTR(deprecated)
 DECL_ATTR(fixedLayout)
diff --git a/test/api-digester/Inputs/APINotesLeft/APINotesTest.h b/test/api-digester/Inputs/APINotesLeft/APINotesTest.h
@@ -23,4 +23,6 @@ extern int ANTGlobalValue;
 - (nonnull AnimalStatusDescriptor *)animalStatusDescriptorByAddingOptionalAttributes:(nullable NSDictionary<NSString*, id> *)attributes;
 - (nonnull AnimalStatusDescriptor *)animalStatusDescriptorByAddingAttributesArray:(nonnull NSArray<NSString*> *)attributes;
 - (nonnull AnimalStatusDescriptor *)animalStatusDescriptorByAddingOptionalAttributesArray:(nullable NSArray<NSString*> *)attributes;
++ (nonnull AnimalStatusDescriptor *)animalStatusSingleOptionalAttribute:(nullable NSString *)attributes;
++ (nonnull AnimalStatusDescriptor *)animalStatusSingleAttribute:(nonnull NSString *)attributes;
 @end
diff --git a/test/api-digester/Inputs/APINotesRight/APINotesTest.h b/test/api-digester/Inputs/APINotesRight/APINotesTest.h
@@ -23,5 +23,6 @@ typedef NSString * AnimalAttributeName NS_STRING_ENUM;
 - (nonnull AnimalStatusDescriptor *)animalStatusDescriptorByAddingOptionalAttributes:(nullable NSDictionary<AnimalAttributeName, id> *)attributes;
 - (nonnull AnimalStatusDescriptor *)animalStatusDescriptorByAddingAttributesArray:(nonnull NSArray<AnimalAttributeName> *)attributes;
 - (nonnull AnimalStatusDescriptor *)animalStatusDescriptorByAddingOptionalAttributesArray:(nullable NSArray<AnimalAttributeName> *)attributes;
-
++ (nonnull AnimalStatusDescriptor *)animalStatusSingleOptionalAttribute:(nullable AnimalAttributeName)attributes;
++ (nonnull AnimalStatusDescriptor *)animalStatusSingleAttribute:(nonnull AnimalAttributeName)attributes;
 @end
diff --git a/test/api-digester/Outputs/apinotes-diags-3-4.txt b/test/api-digester/Outputs/apinotes-diags-3-4.txt
@@ -13,5 +13,7 @@ APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributes(_:) h
 APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributesArray(_:) has parameter 0 type change from [String] to [AnimalAttributeName]
 APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributes(_:) has parameter 0 type change from [String : Any]? to [AnimalAttributeName : Any]?
 APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributesArray(_:) has parameter 0 type change from [String]? to [AnimalAttributeName]?
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleAttribute(_:) has parameter 0 type change from String to AnimalAttributeName
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleOptionalAttribute(_:) has parameter 0 type change from String? to AnimalAttributeName?
 
 /* Decl Attribute changes */
diff --git a/test/api-digester/Outputs/apinotes-diags.txt b/test/api-digester/Outputs/apinotes-diags.txt
@@ -17,5 +17,7 @@ APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributes(_:) h
 APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingAttributesArray(_:) has parameter 0 type change from [String] to [AnimalAttributeName]
 APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributes(_:) has parameter 0 type change from [String : Any]? to [AnimalAttributeName : Any]?
 APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.addingOptionalAttributesArray(_:) has parameter 0 type change from [String]? to [AnimalAttributeName]?
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleAttribute(_:) has parameter 0 type change from String to AnimalAttributeName
+APINotesTest(APINotesTest.h): Func AnimalStatusDescriptor.animalStatusSingleOptionalAttribute(_:) has parameter 0 type change from String? to AnimalAttributeName?
 
 /* Decl Attribute changes */
diff --git a/test/api-digester/Outputs/apinotes-migrator-gen.json b/test/api-digester/Outputs/apinotes-migrator-gen.json
@@ -175,6 +175,39 @@
     "RightComment": "AnimalAttributeName",
     "ModuleName": "APINotesTest"
   },
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "Function",
+    "NodeAnnotation": "TypeRewritten",
+    "ChildIndex": "1:0",
+    "LeftUsr": "c:objc(cs)AnimalStatusDescriptor(cm)animalStatusSingleOptionalAttribute:",
+    "LeftComment": "String",
+    "RightUsr": "",
+    "RightComment": "AnimalAttributeName",
+    "ModuleName": "APINotesTest"
+  },
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "Function",
+    "NodeAnnotation": "SimpleOptionalStringRepresentableUpdate",
+    "ChildIndex": "1",
+    "LeftUsr": "c:objc(cs)AnimalStatusDescriptor(cm)animalStatusSingleOptionalAttribute:",
+    "LeftComment": "",
+    "RightUsr": "",
+    "RightComment": "AnimalAttributeName",
+    "ModuleName": "APINotesTest"
+  },
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "Function",
+    "NodeAnnotation": "SimpleStringRepresentableUpdate",
+    "ChildIndex": "1",
+    "LeftUsr": "c:objc(cs)AnimalStatusDescriptor(cm)animalStatusSingleAttribute:",
+    "LeftComment": "",
+    "RightUsr": "",
+    "RightComment": "AnimalAttributeName",
+    "ModuleName": "APINotesTest"
+  },
   {
     "DiffItemKind": "CommonDiffItem",
     "NodeKind": "Function",
diff --git a/tools/swift-api-digester/swift-api-digester.cpp b/tools/swift-api-digester/swift-api-digester.cpp
@@ -516,6 +516,7 @@ class SDKNodeType : public SDKNode {
   // When the type node represents a function parameter, this function returns
   // whether the parameter has a default value.
   bool hasDefaultArgument() const { return HasDefaultArg; }
+  bool isTopLevelType() const { return !isa<SDKNodeType>(getParent()); }
   static bool classof(const SDKNode *N);
 };
 
@@ -2730,7 +2731,7 @@ class ChangeRefinementPass : public SDKTreeDiffPass, public SDKNodeVisitor {
       return false;
 
     // We only care if this the top-level type node.
-    if (!isa<SDKNodeDecl>(L->getParent()) || !isa<SDKNodeDecl>(R->getParent()))
+    if (!L->isTopLevelType() || !R->isTopLevelType())
       return false;
     StringRef KeyChangedTo;
     if (L->getTypeKind() == KnownTypeKind::Optional &&
@@ -2771,7 +2772,7 @@ class ChangeRefinementPass : public SDKTreeDiffPass, public SDKNodeVisitor {
     if (!IsVisitingLeft)
       return false;
     // We only care if this the top-level type node.
-    if (!isa<SDKNodeDecl>(L->getParent()) || !isa<SDKNodeDecl>(R->getParent()))
+    if (!L->isTopLevelType() || !R->isTopLevelType())
       return false;
     StringRef KeyChangedTo;
     if (L->getTypeKind() == KnownTypeKind::Optional &&
@@ -2794,6 +2795,35 @@ class ChangeRefinementPass : public SDKTreeDiffPass, public SDKNodeVisitor {
     return false;
   }
 
+  bool detectSimpleStringRepresentableUpdate(SDKNodeType *L, SDKNodeType *R) {
+    if (!IsVisitingLeft)
+      return false;
+    if (!L->isTopLevelType() || !R->isTopLevelType())
+      return false;
+    StringRef KeyChangedTo;
+    bool HasOptional = L->getTypeKind() == KnownTypeKind::Optional &&
+        R->getTypeKind() == KnownTypeKind::Optional;
+    if (HasOptional) {
+      // Detect String? changes to StringRepresentableStruct? change.
+      KeyChangedTo =
+        getStringRepresentableChange(L->getOnlyChild()->getAs<SDKNodeType>(),
+                                     R->getOnlyChild()->getAs<SDKNodeType>());
+    } else {
+      // Detect String changes to StringRepresentableStruct change.
+      KeyChangedTo = getStringRepresentableChange(L, R);
+    }
+    if (!KeyChangedTo.empty()) {
+      L->annotate(NodeAnnotation::TypeRewrittenRight, KeyChangedTo);
+      if (HasOptional) {
+        L->annotate(NodeAnnotation::SimpleOptionalStringRepresentableUpdate);
+      } else {
+        L->annotate(NodeAnnotation::SimpleStringRepresentableUpdate);
+      }
+      return true;
+    }
+    return false;
+  }
+
   bool isUnhandledCase(SDKNodeType *Node) {
     auto Counter = UpdateMap.findUpdateCounterpart(Node)->getAs<SDKNodeType>();
     return Node->getTypeKind() == KnownTypeKind::Void ||
@@ -2826,6 +2856,7 @@ class ChangeRefinementPass : public SDKTreeDiffPass, public SDKNodeVisitor {
                   detectUnmanagedUpdate(Node, Counter)||
                   detectDictionaryKeyChange(Node, Counter) ||
                   detectArrayMemberChange(Node, Counter) ||
+                  detectSimpleStringRepresentableUpdate(Node, Counter) ||
                   detectTypeRewritten(Node, Counter);
     (void) Result;
     return;
@@ -2938,6 +2969,8 @@ class DiffItemEmitter : public SDKNodeVisitor {
       case NodeAnnotation::OptionalArrayMemberUpdate:
       case NodeAnnotation::DictionaryKeyUpdate:
       case NodeAnnotation::OptionalDictionaryKeyUpdate:
+      case NodeAnnotation::SimpleStringRepresentableUpdate:
+      case NodeAnnotation::SimpleOptionalStringRepresentableUpdate:
       case NodeAnnotation::TypeRewritten:
         return Node->getAnnotateComment(NodeAnnotation::TypeRewrittenRight);
       case NodeAnnotation::ModernizeEnum:
@@ -2999,6 +3032,8 @@ class DiffItemEmitter : public SDKNodeVisitor {
                         NodeAnnotation::OptionalDictionaryKeyUpdate,
                         NodeAnnotation::ArrayMemberUpdate,
                         NodeAnnotation::OptionalArrayMemberUpdate,
+                        NodeAnnotation::SimpleStringRepresentableUpdate,
+                        NodeAnnotation::SimpleOptionalStringRepresentableUpdate,
                       });
   }
 
