swift-api-digester: add a new action to dump name correction template.

Rename detection in the tool may not reflect overlay additions; thus we
mistakes a new name to be an underscored one. This new action searches
migration scripts for suspicious ones and generates a template for us to
specify the correct names.

Author: nkcsgexi

include/swift/IDE/APIDigesterData.h

@@ -334,6 +334,21 @@ struct OverloadedFuncInfo: public APIDiffItem {
   }
 };
 
+struct NameCorrectionInfo {
+  StringRef OriginalName;
+  StringRef CorrectedName;
+  StringRef ModuleName;
+  NameCorrectionInfo(StringRef OriginalName, StringRef CorrectedName,
+    StringRef ModuleName): OriginalName(OriginalName),
+    CorrectedName(CorrectedName), ModuleName(ModuleName) {}
+  bool operator<(NameCorrectionInfo Other) const {
+    if (ModuleName != Other.ModuleName)
+      return ModuleName.compare(Other.ModuleName) < 0;
+    else
+      return OriginalName.compare(Other.OriginalName) < 0;
+  }
+};
+
 /// APIDiffItem store is the interface that migrator should communicates with;
 /// Given a key, usually the usr of the system entity under migration, the store
 /// should return a slice of related changes in the same format of
@@ -343,6 +358,7 @@ struct APIDiffItemStore {
   struct Implementation;
   Implementation &Impl;
   static void serialize(llvm::raw_ostream &os, ArrayRef<APIDiffItem*> Items);
+  static void serialize(llvm::raw_ostream &os, ArrayRef<NameCorrectionInfo> Items);
   APIDiffItemStore(const APIDiffItemStore& that) = delete;
   APIDiffItemStore();
   ~APIDiffItemStore();

lib/IDE/APIDigesterData.cpp

@@ -444,6 +444,25 @@ struct ArrayTraits<ArrayRef<APIDiffItem*>> {
     return const_cast<APIDiffItem *&>(seq[index]);
   }
 };
+
+template<>
+struct ObjectTraits<NameCorrectionInfo> {
+  static void mapping(Output &out, NameCorrectionInfo &value) {
+    out.mapRequired(getKeyContent(DiffItemKeyKind::KK_OldPrintedName),value.OriginalName);
+    out.mapRequired(getKeyContent(DiffItemKeyKind::KK_NewPrintedName), value.CorrectedName);
+    out.mapRequired(getKeyContent(DiffItemKeyKind::KK_ModuleName), value.ModuleName);
+  }
+};
+template<>
+struct ArrayTraits<ArrayRef<NameCorrectionInfo>> {
+  static size_t size(Output &out, ArrayRef<NameCorrectionInfo> &seq) {
+    return seq.size();
+  }
+  static NameCorrectionInfo &element(Output &, ArrayRef<NameCorrectionInfo> &seq,
+                                     size_t index) {
+    return const_cast<NameCorrectionInfo&>(seq[index]);
+  }
+};
 } // namespace json
 } // namespace swift
 
@@ -453,6 +472,12 @@ serialize(llvm::raw_ostream &os, ArrayRef<APIDiffItem*> Items) {
   yout << Items;
 }
 
+void swift::ide::api::APIDiffItemStore::
+serialize(llvm::raw_ostream &os, ArrayRef<NameCorrectionInfo> Items) {
+  json::Output yout(os);
+  yout << Items;
+}
+
 struct swift::ide::api::APIDiffItemStore::Implementation {
 private:
   llvm::SmallVector<std::unique_ptr<llvm::MemoryBuffer>, 2> AllBuffer;

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

@@ -70,6 +70,7 @@ namespace  {
     // The following two are for testing purposes
     DeserializeDiffItems,
     DeserializeSDK,
+    GenerateNameCorrectionTemplate,
   };
 } // end anonymous namespace
 
@@ -141,7 +142,10 @@ Action(llvm::cl::desc("Mode:"), llvm::cl::init(ActionType::None),
                      "Deserialize diff items in a JSON file"),
           clEnumValN(ActionType::DeserializeSDK,
                      "deserialize-sdk",
-                     "Deserialize sdk digester in a JSON file")));
+                     "Deserialize sdk digester in a JSON file"),
+          clEnumValN(ActionType::GenerateNameCorrectionTemplate,
+                     "generate-name-correction",
+                     "Generate name correction template")));
 
 static llvm::cl::list<std::string>
 SDKJsonPaths("input-paths",
@@ -3965,6 +3969,33 @@ static int deserializeDiffItems(StringRef DiffPath, StringRef OutputPath) {
   return 0;
 }
 
+static int deserializeNameCorrection(APIDiffItemStore &Store,
+                                     StringRef OutputPath) {
+  std::error_code EC;
+  llvm::raw_fd_ostream FS(OutputPath, EC, llvm::sys::fs::F_None);
+  std::set<NameCorrectionInfo> Result;
+  for (auto *Item: Store.getAllDiffItems()) {
+    if (auto *CI = dyn_cast<CommonDiffItem>(Item)) {
+      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)) {
+          Result.insert(NameCorrectionInfo(NewName, NewName, Module));
+        }
+      }
+    }
+  }
+  std::vector<NameCorrectionInfo> Vec;
+  Vec.insert(Vec.end(), Result.begin(), Result.end());
+  APIDiffItemStore::serialize(FS, Vec);
+  return EC.value();
+}
+
 /// Mostly for testing purposes, this function de-serializes the SDK dump in
 /// dumpPath and re-serialize them to OutputPath. If the tool performs correctly,
 /// the contents in dumpPath and OutputPath should be identical.
@@ -4029,6 +4060,13 @@ int main(int argc, char *argv[]) {
     else
       return deserializeSDKDump(options::SDKJsonPaths[0], options::OutputFile);
   }
+  case ActionType::GenerateNameCorrectionTemplate: {
+    APIDiffItemStore Store;
+    auto &Paths = options::SDKJsonPaths;
+    for (unsigned I = 0; I < Paths.size(); I ++)
+      Store.addStorePath(Paths[I]);
+    return deserializeNameCorrection(Store, options::OutputFile);
+  }
   case ActionType::None:
     llvm::errs() << "Action required\n";
     llvm::cl::PrintHelpMessage();