migrator: handle the special migration cases of NSOpenGLSetOption/NSOpenGLGetOption. rdar://32178753 (#9591)

Author: nkcsgexi

include/swift/IDE/APIDigesterData.h

@@ -40,6 +40,13 @@ enum class NodeAnnotation: uint8_t{
 
 NodeAnnotation parseSDKNodeAnnotation(StringRef Content);
 
+enum class SpecialCaseId: uint8_t{
+#define SPECIAL_CASE_ID(NAME) NAME,
+#include "DigesterEnums.def"
+};
+
+SpecialCaseId parseSpecialCaseId(StringRef Content);
+
 enum class APIDiffItemKind: uint8_t{
 #define DIFF_ITEM_KIND(NAME) ADK_##NAME,
 #include "DigesterEnums.def"
@@ -252,10 +259,10 @@ struct TypeMemberDiffItem: public APIDiffItem {
 /// transformation on an entity.
 struct SpecialCaseDiffItem: public APIDiffItem {
   StringRef usr;
-  StringRef caseId;
+  SpecialCaseId caseId;
 public:
   SpecialCaseDiffItem(StringRef usr, StringRef caseId): usr(usr),
-    caseId(caseId) {}
+    caseId(parseSpecialCaseId(caseId)) {}
   StringRef getKey() const override { return usr; }
   void streamDef(llvm::raw_ostream &S) const override {};
   static bool classof(const APIDiffItem *D);

include/swift/IDE/DigesterEnums.def

@@ -26,6 +26,10 @@
 #define DIFF_ITEM_KEY_KIND(NAME)
 #endif
 
+#ifndef SPECIAL_CASE_ID
+#define SPECIAL_CASE_ID(NAME)
+#endif
+
 NODE_KIND(Root)
 NODE_KIND(TypeDecl)
 NODE_KIND(TypeNominal)
@@ -123,6 +127,10 @@ DIFF_ITEM_KEY_KIND_INT(SelfIndex)
 DIFF_ITEM_KEY_KIND_INT(RemovedIndex)
 DIFF_ITEM_KEY_KIND_INT(Index)
 
+SPECIAL_CASE_ID(NSOpenGLSetOption)
+SPECIAL_CASE_ID(NSOpenGLGetOption)
+
+#undef SPECIAL_CASE_ID
 #undef DIFF_ITEM_KEY_KIND_INT
 #undef DIFF_ITEM_KEY_KIND_STRING
 

lib/IDE/APIDigesterData.cpp

@@ -51,6 +51,13 @@ NodeAnnotation swift::ide::api::parseSDKNodeAnnotation(StringRef Content) {
   ;
 }
 
+SpecialCaseId swift::ide::api::parseSpecialCaseId(StringRef Content) {
+  return llvm::StringSwitch<SpecialCaseId>(Content)
+#define SPECIAL_CASE_ID(NAME) .Case(#NAME, SpecialCaseId::NAME)
+#include "swift/IDE/DigesterEnums.def"
+  ;
+}
+
 swift::ide::api::CommonDiffItem::
 CommonDiffItem(SDKNodeKind NodeKind, NodeAnnotation DiffKind,
                StringRef ChildIndex, StringRef LeftUsr, StringRef RightUsr,

lib/Migrator/APIDiffMigratorPass.cpp

@@ -356,6 +356,56 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
     }
   }
 
+  bool handleSpecialCases(ValueDecl *FD, CallExpr* Call, Expr *Arg) {
+    SpecialCaseDiffItem *Item = nullptr;
+    for (auto *I: getRelatedDiffItems(FD)) {
+      Item = dyn_cast<SpecialCaseDiffItem>(I);
+      if (Item)
+        break;
+    }
+    if (!Item)
+      return false;
+    std::vector<CallArgInfo> AllArgs =
+      getCallArgInfo(SM, Arg, LabelRangeEndAt::LabelNameOnly);
+    switch(Item->caseId) {
+    case SpecialCaseId::NSOpenGLSetOption: {
+      // swift 3.2:
+      // NSOpenGLSetOption(NSOpenGLGOFormatCacheSize, 5)
+      // swift 4:
+      // NSOpenGLGOFormatCacheSize.globalValue = 5
+      CallArgInfo &FirstArg = AllArgs[0];
+      CallArgInfo &SecondArg = AllArgs[1];
+      Editor.remove(CharSourceRange(SM, Call->getStartLoc(),
+                                    FirstArg.ArgExp->getStartLoc()));
+      Editor.replace(CharSourceRange(SM, Lexer::getLocForEndOfToken(SM,
+        FirstArg.ArgExp->getEndLoc()), SecondArg.LabelRange.getStart()),
+                     ".globalValue = ");
+      Editor.remove(Call->getEndLoc());
+      return true;
+    }
+    case SpecialCaseId::NSOpenGLGetOption: {
+      // swift 3.2:
+      // NSOpenGLGetOption(NSOpenGLGOFormatCacheSize, &cacheSize)
+      // swift 4:
+      // cacheSize = NSOpenGLGOFormatCacheSize.globalValue
+      CallArgInfo &FirstArg = AllArgs[0];
+      CallArgInfo &SecondArg = AllArgs[1];
+
+      StringRef SecondArgContent = SecondArg.getEntireCharRange(SM).str();
+      if (SecondArgContent[0] == '&')
+        SecondArgContent = SecondArgContent.substr(1);
+
+      Editor.replace(CharSourceRange(SM, Call->getStartLoc(),
+                                     FirstArg.ArgExp->getStartLoc()),
+                     (llvm::Twine(SecondArgContent) + " = ").str());
+      Editor.replace(CharSourceRange(SM, FirstArg.getEntireCharRange(SM).getEnd(),
+                                     Lexer::getLocForEndOfToken(SM, Call->getEndLoc())),
+                     ".globalValue");
+      return true;
+    }
+    }
+  }
+
   bool handleTypeHoist(ValueDecl *FD, CallExpr* Call, Expr *Arg) {
     TypeMemberDiffItem *Item = nullptr;
     for (auto *I: getRelatedDiffItems(FD)) {
@@ -475,6 +525,7 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
         if (auto FD = Fn->getReferencedDecl().getDecl()) {
           handleFuncRename(FD, Fn, Args);
           handleTypeHoist(FD, CE, Args);
+          handleSpecialCases(FD, CE, Args);
         }
         break;
       }

test/Migrator/API.json

@@ -421,10 +421,5 @@
     "NewTypeName": "example",
     "SelfIndex": 0,
     "RemovedIndex": 1
-  },
-  {
-    "DiffItemKind": "SpecialCaseDiffItem",
-    "Usr": "c:@shouldnotexistspecial",
-    "SpecialCaseId": "rdar://1234567"
   }
 ]

test/Migrator/Inputs/MyAppKit.swift

@@ -0,0 +1,4 @@
+
+public class NSOpenGLOption {}
+public func NSOpenGLGetOption(_ c : NSOpenGLOption, _ p :UnsafePointer<Int>) {}
+public func NSOpenGLSetOption(_ c : NSOpenGLOption, _ p : Int) {}

test/Migrator/SpecialCaseAPI.json

@@ -0,0 +1,12 @@
+[
+  {
+    "DiffItemKind": "SpecialCaseDiffItem",
+    "Usr": "s:8MyAppKit17NSOpenGLSetOptionyAA0D8GLOptionC_SitF",
+    "SpecialCaseId": "NSOpenGLSetOption"
+  },
+  {
+    "DiffItemKind": "SpecialCaseDiffItem",
+    "Usr": "s:8MyAppKit17NSOpenGLGetOptionyAA0D8GLOptionC_SPySiGtF",
+    "SpecialCaseId": "NSOpenGLGetOption"
+  }
+]

test/Migrator/api-special-cases.swift

@@ -0,0 +1,13 @@
+// REQUIRES: objc_interop
+// RUN: rm -rf %t.mod && mkdir -p %t.mod
+// RUN: %target-swift-frontend -emit-module -o %t.mod/MyAppKit.swiftmodule %S/Inputs/MyAppKit.swift -module-name MyAppKit -parse-as-library
+// RUN: rm -rf %t && mkdir -p %t && %target-swift-frontend -c -update-code -primary-file %s -I %t.mod -emit-migrated-file-path %t/api-special-cases.swift.result -emit-remap-file-path %t/api-special-cases.swift.remap -o /dev/null -api-diff-data-file %S/SpecialCaseAPI.json
+// RUN: diff -u %S/api-special-cases.swift.expected %t/api-special-cases.swift.result
+
+import MyAppKit
+
+func foo(_ Opt: NSOpenGLOption) {
+  var Value = 1
+  NSOpenGLSetOption(Opt, 1)
+  NSOpenGLGetOption(Opt, &Value)
+}

test/Migrator/api-special-cases.swift.expected

@@ -0,0 +1,13 @@
+// REQUIRES: objc_interop
+// RUN: rm -rf %t.mod && mkdir -p %t.mod
+// RUN: %target-swift-frontend -emit-module -o %t.mod/MyAppKit.swiftmodule %S/Inputs/MyAppKit.swift -module-name MyAppKit -parse-as-library
+// RUN: rm -rf %t && mkdir -p %t && %target-swift-frontend -c -update-code -primary-file %s -I %t.mod -emit-migrated-file-path %t/api-special-cases.swift.result -emit-remap-file-path %t/api-special-cases.swift.remap -o /dev/null -api-diff-data-file %S/SpecialCaseAPI.json
+// RUN: diff -u %S/api-special-cases.swift.expected %t/api-special-cases.swift.result
+
+import MyAppKit
+
+func foo(_ Opt: NSOpenGLOption) {
+  var Value = 1
+  Opt.globalValue = 1
+  Value = Opt.globalValue
+}