migrator: ignore migration scripts with underscored new names. rdar://39877447

Updating something to underscored names is hardly correct. This patch
disallows picking up such migration scripts.

Author: nkcsgexi

include/swift/IDE/APIDigesterData.h

@@ -147,6 +147,15 @@ struct CommonDiffItem: public APIDiffItem {
   APIDiffItemKind getKind() const override {
     return APIDiffItemKind::ADK_CommonDiffItem;
   }
+
+  bool rightCommentUnderscored() const {
+    DeclNameViewer Viewer(RightComment);
+    auto HasUnderScore =
+      [](StringRef S) { return S.find('_') != StringRef::npos; };
+    auto Args = Viewer.args();
+    return HasUnderScore(Viewer.base()) ||
+        std::any_of(Args.begin(), Args.end(), HasUnderScore);
+  }
 };
 
 

lib/IDE/APIDigesterData.cpp

@@ -482,6 +482,15 @@ struct swift::ide::api::APIDiffItemStore::Implementation {
 private:
   llvm::SmallVector<std::unique_ptr<llvm::MemoryBuffer>, 2> AllBuffer;
   llvm::BumpPtrAllocator Allocator;
+
+  static bool shouldInclude(APIDiffItem *Item) {
+    if (auto *CI = dyn_cast<CommonDiffItem>(Item)) {
+      if (CI->rightCommentUnderscored())
+        return false;
+    }
+    return true;
+  }
+
 public:
   llvm::StringMap<std::vector<APIDiffItem*>> Data;
   bool PrintUsr;
@@ -507,14 +516,13 @@ struct swift::ide::api::APIDiffItemStore::Implementation {
         APIDiffItem *Item = serializeDiffItem(Allocator,
           cast<llvm::yaml::MappingNode>(&*It));
         auto &Bag = Data[Item->getKey()];
-        if (std::find_if(Bag.begin(), Bag.end(),
+        if (shouldInclude(Item) && std::find_if(Bag.begin(), Bag.end(),
             [&](APIDiffItem* I) { return *Item == *I; }) == Bag.end()) {
           Bag.push_back(Item);
           AllItems.push_back(Item);
         }
       }
     }
-
   }
 };
 

test/Migrator/Inputs/API.json

@@ -17,6 +17,17 @@
     "RightComment": "theSimpleNewName",
     "ModuleName": "SomeModule"
   },
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "Var",
+    "NodeAnnotation": "Rename",
+    "ChildIndex": "0",
+    "LeftUsr": "c:@SA@SomeItemSet@FI@theSimpleOldNameNotToRename",
+    "LeftComment": "theSimpleOldNameNotToRename",
+    "RightUsr": "",
+    "RightComment": "__theSimpleNewName",
+    "ModuleName": "SomeModule"
+  },
   {
     "DiffItemKind": "CommonDiffItem",
     "NodeKind": "Function",

test/Migrator/member.swift

@@ -6,5 +6,6 @@ import Bar
 
 func foo(_ b: BarForwardDeclaredClass, _ s: SomeItemSet) -> Int32 {
   let _ = s.theSimpleOldName
+  let _ = s.theSimpleOldNameNotToRename
   return barGlobalVariable
 }

test/Migrator/member.swift.expected

@@ -6,5 +6,6 @@ import Bar
 
 func foo(_ b: BarForwardDeclaredClass, _ s: SomeItemSet) -> Int32 {
   let _ = s.theSimpleNewName
+  let _ = s.theSimpleOldNameNotToRename
   return bar.memberVariable
 }

test/Migrator/mock-sdk/Bar.framework/Headers/Bar.h

@@ -36,6 +36,7 @@ enum BarForwardDeclaredEnum {
 typedef struct {
   int count;
   int theSimpleOldName;
+  int theSimpleOldNameNotToRename;
 } SomeItemSet;
 
 typedef SomeItemSet SomeEnvironment;

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

@@ -3979,12 +3979,7 @@ static int deserializeNameCorrection(APIDiffItemStore &Store,
       if (CI->DiffKind == NodeAnnotation::Rename) {
         auto NewName = CI->getNewName();
         auto Module = CI->ModuleName;
-        DeclNameViewer Viewer(NewName);
-        auto HasUnderScore =
-          [](StringRef S) { return S.find('_') != StringRef::npos; };
-        auto Args = Viewer.args();
-        if (HasUnderScore(Viewer.base()) ||
-            std::any_of(Args.begin(), Args.end(), HasUnderScore)) {
+        if (CI->rightCommentUnderscored()) {
           Result.insert(NameCorrectionInfo(NewName, NewName, Module));
         }
       }