swift-api-digester: Various improvements for migrator script generation. (#8745)

* swift-api-digester: Add a test for generating migrator script.

* swift-api-digester: Add #ifndef guard before each macro category.

* swift-api-digester: Avoid printing macro categories with empty content.

* swift-api-digester: Add test for multiple type changes in a single decl.

* swift-api-digester: simplify some code. NFC

Author: nkcsgexi

test/api-digester/Inputs/macro-gen-left.swift

@@ -0,0 +1,16 @@
+public struct S1 {
+  public init(_ : Int) {}
+  public func foo1() {}
+  mutating public func foo2() {}
+  public func foo3() {}
+  public func foo4() -> Void {}
+  public func foo5(x : Int, y: Int) {}
+}
+
+public class C1 {
+  public class func foo1() {}
+  public func foo2(_ : Int, _ b: Int) -> String { return ""}
+  public weak var CIIns1 : C1?
+  public var CIIns2 : C1?
+  public func foo3(a : Void?) {}
+}

test/api-digester/Inputs/macro-gen-right.swift

@@ -0,0 +1,16 @@
+public struct S1 {
+  public init(_ : Double) {}
+  mutating public func foo1() {}
+  mutating public func foo2() {}
+  public static func foo3() {}
+  public func foo4() {}
+  public func foo5(x : Int, y: Int, z: Int) {}
+}
+
+public class C1 {
+  public func foo1() {}
+  public func foo2(_ : ()->(), _ b : String) -> Int { return 0 }
+  public var CIIns1 : C1?
+  public weak var CIIns2 : C1?
+  public func foo3(a : ()?) {}
+}

test/api-digester/Outputs/macro-gen.def

@@ -0,0 +1,11 @@
+
+#ifndef SDK_CHANGE
+#define SDK_CHANGE(NODE_KIND, DIFF_KIND, CHILD_INDEX, LEFT_USR, RIGHT_USR, LEFT_COMMENT, RIGHT_COMMENT, MODULENAME)
+#endif
+SDK_CHANGE(Function, TypeRewritten, "0", "s:12macrogenleft2C1C4foo2SSSi_SitF", "", "String", "Int", "macrogenleft")
+SDK_CHANGE(Function, TypeRewritten, "1", "s:12macrogenleft2C1C4foo2SSSi_SitF", "", "Int", "() -> ()", "macrogenleft")
+SDK_CHANGE(Function, TypeRewritten, "2", "s:12macrogenleft2C1C4foo2SSSi_SitF", "", "Int", "String", "macrogenleft")
+SDK_CHANGE(Function, Rename, "0", "s:12macrogenleft2S1V4foo5ySi1x_Si1ytF", "", "foo5(x:y:)", "foo5(x:y:z:)", "macrogenleft")
+SDK_CHANGE(Constructor, TypeRewritten, "1", "s:12macrogenleft2S1VACSicfc", "", "Int", "Double", "macrogenleft")
+#undef SDK_CHANGE
+

test/api-digester/macro-gen.swift

@@ -0,0 +1,9 @@
+// RUN: rm -rf %t.mod && mkdir -p %t.mod
+// RUN: rm -rf %t.sdk && mkdir -p %t.sdk
+// RUN: rm -rf %t.module-cache && mkdir -p %t.module-cache
+// RUN: %swift -emit-module -o %t.mod/macrogenleft.swiftmodule %S/Inputs/macro-gen-left.swift -parse-as-library
+// RUN: %swift -emit-module -o %t.mod/macrogenright.swiftmodule %S/Inputs/macro-gen-right.swift -parse-as-library
+// RUN: %api-digester -dump-sdk -module macrogenleft -o %t.dump1.json -module-cache-path %t.module-cache -sdk %t.sdk -swift-version 3 -I %t.mod
+// RUN: %api-digester -dump-sdk -module macrogenright -o %t.dump2.json -module-cache-path %t.module-cache -sdk %t.sdk -swift-version 4 -I %t.mod
+// RUN: %api-digester -compare-sdk --input-paths %t.dump1.json -input-paths %t.dump2.json -o %t.result
+// RUN: diff -u %S/Outputs/macro-gen.def %t.result

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

@@ -2361,8 +2361,7 @@ class ChangeRefinementPass : public SDKTreeDiffPass, public SDKNodeVisitor {
 // Similarly, the second JSON element describes a type parameter down cast in the
 // second parameter of function "c:objc(cs)NSXMLDocument(im)insertChildren:atIndex:".
 // We keep both usrs because in the future this may support auto-rename.
-class DiffItem {
-public:
+struct DiffItem {
   SDKNodeKind NodeKind;
   NodeAnnotation DiffKind;
   StringRef ChildIndex;
@@ -2381,6 +2380,10 @@ class DiffItem {
     assert(!ChildIndex.empty() && "Child index is empty.");
   }
 
+  static StringRef head() {
+    return "SDK_CHANGE";
+  }
+
   bool operator<(DiffItem Other) const {
     if (auto UsrCompare = LeftUsr.compare(Other.LeftUsr))
       return UsrCompare < 0;
@@ -2394,16 +2397,19 @@ class DiffItem {
   }
 
   static void describe(llvm::raw_ostream &os) {
-    os << "// SDK_CHANGE(node kind, diff kind, child index, left USR, "
-          "right USR, left comment, right comment)\n";
+    os << "#ifndef " << head() << "\n";
+    os << "#define " << head() << "(NODE_KIND, DIFF_KIND, CHILD_INDEX, LEFT_USR, "
+                                  "RIGHT_USR, LEFT_COMMENT, RIGHT_COMMENT, "
+                                  "MODULENAME)\n";
+    os << "#endif\n";
   }
 
   static void undef(llvm::raw_ostream &os) {
-    os << "#undef SDK_CHANGE\n";
+    os << "#undef " << head() << "\n";
   }
 
   void streamDef(llvm::raw_ostream &S) const {
-    S << "SDK_CHANGE(" << NodeKind << ", " << DiffKind << ", \"" << ChildIndex
+    S << head() << "(" << NodeKind << ", " << DiffKind << ", \"" << ChildIndex
       << "\", \"" << LeftUsr << "\", \"" << RightUsr << "\", \""
       << LeftComment << "\", \"" << RightComment
       << "\", \"" << ModuleName << "\")";
@@ -2500,20 +2506,26 @@ struct TypeMemberDiffItem {
   Optional<uint8_t> selfIndex;
   StringRef oldPrintedName;
 
+  static StringRef head() {
+    return "SDK_CHANGE_TYPE_MEMBER";
+  }
+
   static void describe(llvm::raw_ostream &os) {
-    os << "// SDK_CHANGE_TYPE_MEMBER(USR, new typename, new printed name, "
-          "self index, old printed name)\n";
+    os << "#ifndef " << head() << "\n";
+    os << "#define " << head() << "(USR, NEW_TYPE_NAME, NEW_PRINTED_NAME, "
+                                  "SELF_INDEX, OLD_PRINTED_NAME)\n";
+    os << "#endif\n";
   }
 
   static void undef(llvm::raw_ostream &os) {
-    os << "#undef SDK_CHANGE_TYPE_MEMBER\n";
+    os << "#undef " << head() << "\n";
   }
 
   void streamDef(llvm::raw_ostream &os) const {
     std::string IndexContent = selfIndex.hasValue() ?
       std::to_string(selfIndex.getValue()) : "";
 
-    os << "SDK_CHANGE_TYPE_MEMBER("
+    os << head() << "("
        << "\"" << usr << "\"" << ", "
        << "\"" << newTypeName << "\"" << ", "
        << "\"" << newPrintedName << "\"" << ", "
@@ -2583,6 +2595,8 @@ void removeRedundantAndSort(std::vector<T> &Diffs) {
 template<typename T>
 void serializeDiffs(llvm::raw_ostream &Fs, std::vector<T> &Diffs) {
   removeRedundantAndSort(Diffs);
+  if (Diffs.empty())
+    return;
   Fs << "\n";
   T::describe(Fs);
   for (auto &Diff : Diffs) {
@@ -2603,61 +2617,68 @@ static bool isTypeChangeInterestedFuncNode(NodePtr Decl) {
   }
 }
 
-static bool isInterested(SDKNodeDecl* Decl, NodeAnnotation Anno) {
-  switch (Anno) {
-    case NodeAnnotation::WrapOptional:
-    case NodeAnnotation::UnwrapOptional:
-    case NodeAnnotation::ImplicitOptionalToOptional:
-    case NodeAnnotation::OptionalToImplicitOptional:
-    case NodeAnnotation::UnwrapUnmanaged:
-    case NodeAnnotation::TypeRewritten:
-      return isTypeChangeInterestedFuncNode(Decl) &&
-        Decl->getParent()->getKind() == SDKNodeKind::TypeDecl;
-    default:
-      return true;
-  }
-}
-
 class DiffItemEmitter : public SDKNodeVisitor {
   DiffVector &AllItems;
 
+  static bool isInterested(SDKNodeDecl* Decl, NodeAnnotation Anno) {
+    switch (Anno) {
+      case NodeAnnotation::WrapOptional:
+      case NodeAnnotation::UnwrapOptional:
+      case NodeAnnotation::ImplicitOptionalToOptional:
+      case NodeAnnotation::OptionalToImplicitOptional:
+      case NodeAnnotation::UnwrapUnmanaged:
+      case NodeAnnotation::TypeRewritten:
+        return isTypeChangeInterestedFuncNode(Decl) &&
+        Decl->getParent()->getKind() == SDKNodeKind::TypeDecl;
+      default:
+        return true;
+    }
+  }
+
   bool doesAncestorHaveTypeRewritten() {
     return std::find_if(Ancestors.begin(), Ancestors.end(),[](NodePtr N) {
       return N->isAnnotatedAs(NodeAnnotation::TypeRewritten);
     }) != Ancestors.end();
   }
 
-  StringRef getLeftComment(NodePtr Node, NodeAnnotation Anno) {
-    if (Anno == NodeAnnotation::TypeRewritten)
-      return Node->getAnnotateComment(NodeAnnotation::TypeRewrittenLeft);
-    else if (Anno == NodeAnnotation::Rename)
-      return Node->getAnnotateComment(NodeAnnotation::RenameOldName);
-    return StringRef();
-  }
-
-  StringRef getRightComment(NodePtr Node, NodeAnnotation Anno) {
-    if (Anno == NodeAnnotation::TypeRewritten)
-      return Node->getAnnotateComment(NodeAnnotation::TypeRewrittenRight);
-    else if (Anno == NodeAnnotation::ModernizeEnum)
-      return Node->getAnnotateComment(NodeAnnotation::ModernizeEnum);
-    else if (Anno == NodeAnnotation::Rename)
-      return Node->getAnnotateComment(NodeAnnotation::RenameNewName);
-    return StringRef();
-  }
-
-  bool handleAnnotation(NodePtr Node, SDKNodeDecl *NonTypeParent,
-                        StringRef Index, NodeAnnotation Annotation) {
-    if (isInterested(NonTypeParent, Annotation) &&
-        Node->isAnnotatedAs(Annotation)) {
-      auto Kind = NonTypeParent->getKind();
-      StringRef LC = getLeftComment(Node, Annotation);
-      StringRef RC = getRightComment(Node, Annotation);
-      AllItems.emplace_back(Kind, Annotation, Index,
-                            NonTypeParent->getUsr(), StringRef(), LC, RC,
-                            NonTypeParent->getModuleName());
-      return true;
+  static StringRef getLeftComment(NodePtr Node, NodeAnnotation Anno) {
+    switch(Anno) {
+      case NodeAnnotation::TypeRewritten:
+        return Node->getAnnotateComment(NodeAnnotation::TypeRewrittenLeft);
+      case NodeAnnotation::Rename:
+        return Node->getAnnotateComment(NodeAnnotation::RenameOldName);
+      default:
+        return StringRef();
+    }
+  }
+
+  static StringRef getRightComment(NodePtr Node, NodeAnnotation Anno) {
+    switch (Anno) {
+      case NodeAnnotation::TypeRewritten:
+        return Node->getAnnotateComment(NodeAnnotation::TypeRewrittenRight);
+      case NodeAnnotation::ModernizeEnum:
+        return Node->getAnnotateComment(NodeAnnotation::ModernizeEnum);
+      case NodeAnnotation::Rename:
+        return Node->getAnnotateComment(NodeAnnotation::RenameNewName);
+      default:
+        return StringRef();
+    }
+  }
+
+  void handleAnnotations(NodePtr Node, SDKNodeDecl *NonTypeParent,
+                         StringRef Index, ArrayRef<NodeAnnotation> Annotations) {
+    for (auto Annotation: Annotations) {
+      if (isInterested(NonTypeParent, Annotation) &&
+          Node->isAnnotatedAs(Annotation)) {
+        auto Kind = NonTypeParent->getKind();
+        StringRef LC = getLeftComment(Node, Annotation);
+        StringRef RC = getRightComment(Node, Annotation);
+        AllItems.emplace_back(Kind, Annotation, Index,
+                              NonTypeParent->getUsr(), StringRef(), LC, RC,
+                              NonTypeParent->getModuleName());
+        return;
+      }
     }
-    return false;
   }
 
   void visit(NodePtr Node) override {
@@ -2670,22 +2691,24 @@ class DiffItemEmitter : public SDKNodeVisitor {
 
     if (!Parent)
       return;
-    auto Index = isa<SDKNodeType>(Node) ? getIndexString(Node) : "0";
-
-    bool Result =
-      doesAncestorHaveTypeRewritten() ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::WrapOptional) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::UnwrapOptional) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::ImplicitOptionalToOptional) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::OptionalToImplicitOptional) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::UnwrapUnmanaged) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::TypeRewritten) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::SetterToProperty) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::GetterToProperty) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::ModernizeEnum) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::Rename) ||
-      handleAnnotation(Node, Parent, Index, NodeAnnotation::NowThrowing);
-    (void) Result;
+    if (doesAncestorHaveTypeRewritten())
+      return;
+
+    handleAnnotations(Node, Parent,
+                      isa<SDKNodeType>(Node) ? getIndexString(Node) : "0",
+                      {
+                        NodeAnnotation::WrapOptional,
+                        NodeAnnotation::UnwrapOptional,
+                        NodeAnnotation::ImplicitOptionalToOptional,
+                        NodeAnnotation::OptionalToImplicitOptional,
+                        NodeAnnotation::UnwrapUnmanaged,
+                        NodeAnnotation::TypeRewritten,
+                        NodeAnnotation::SetterToProperty,
+                        NodeAnnotation::GetterToProperty,
+                        NodeAnnotation::ModernizeEnum,
+                        NodeAnnotation::Rename,
+                        NodeAnnotation::NowThrowing
+                      });
   }
 
   StringRef getIndexString(NodePtr Node) {
@@ -3053,17 +3076,22 @@ struct NoEscapeFuncParam {
 
   NoEscapeFuncParam(StringRef Usr, unsigned Index) : Usr(Usr), Index(Index) {}
 
+  static StringRef head() {
+    return "NOESCAPE_FUNC_PARAM";
+  }
+
   static void describe(llvm::raw_ostream &os) {
-    os << "// NOESCAPE_FUNC_PARAM(USR, Index)\n";
+    os << "#ifndef " << head() << "\n";
+    os << "#define " << head() << "(USR, Index)\n";
+    os << "#endif\n";
   }
 
   static void undef(llvm::raw_ostream &os) {
-    os << "#undef NOESCAPE_FUNC_PARAM\n";
+    os << "#undef " << head() << "\n";
   }
 
   void streamDef(llvm::raw_ostream &os) const {
-    os << "NOESCAPE_FUNC_PARAM("
-    << "\"" << Usr << "\"" << ", "
+    os << head() << "(" << "\"" << Usr << "\"" << ", "
     << "\"" << Index << "\"" << ")";
   }
 
@@ -3108,17 +3136,22 @@ struct OverloadedFuncInfo {
   StringRef Usr;
   OverloadedFuncInfo(StringRef Usr) : Usr(Usr) {}
 
+  static StringRef head() {
+    return "OVERLOAD_FUNC_TRAILING_CLOSURE";
+  }
+
   static void describe(llvm::raw_ostream &os) {
-    os << "// OVERLOAD_FUNC_TRAILING_CLOSURE(USR)\n";
+    os << "#ifndef " << head() << "\n";
+    os << "#define " << head() << "(USR)\n";
+    os << "#endif\n";
   }
 
   static void undef(llvm::raw_ostream &os) {
-    os << "#undef OVERLOAD_FUNC_TRAILING_CLOSURE\n";
+    os << "#undef " << head() << "\n";
   }
 
   void streamDef(llvm::raw_ostream &os) const {
-    os << "OVERLOAD_FUNC_TRAILING_CLOSURE("
-       << "\"" << Usr << "\"" << ")";
+    os << head() << "(" << "\"" << Usr << "\"" << ")";
   }
 
   bool operator<(OverloadedFuncInfo Other) const {