ABIChecker: include import decls in the intermediate JSON file

nkcsgexi · nkcsgexi · commit 3d8fcf20f321 · 2021-08-18T15:55:00.000-07:00
Removing an import statement can be potentially source-breaking. We should
prepare for diagnosing such case.
diff --git a/include/swift/APIDigester/ModuleAnalyzerNodes.h b/include/swift/APIDigester/ModuleAnalyzerNodes.h
@@ -717,6 +717,12 @@ class SDKNodeDeclAccessor: public SDKNodeDeclAbstractFunc {
   void jsonize(json::Output &Out) override;
 };
 
+class SDKNodeDeclImport: public SDKNodeDecl {
+public:
+  SDKNodeDeclImport(SDKNodeInitInfo Info);
+  static bool classof(const SDKNode *N);
+};
+
 // The additional information we need for a type node in the digest.
 // We use type node to represent entities more than types, e.g. parameters, so
 // this struct is necessary to pass down to create a type node.
diff --git a/include/swift/IDE/DigesterEnums.def b/include/swift/IDE/DigesterEnums.def
@@ -72,6 +72,7 @@ NODE_KIND(DeclOperator, OperatorDecl)
 NODE_KIND(DeclType, TypeDecl)
 NODE_KIND(DeclVar, Var)
 NODE_KIND(DeclTypeAlias, TypeAlias)
+NODE_KIND(DeclImport, Import)
 NODE_KIND(DeclAssociatedType, AssociatedType)
 NODE_KIND_RANGE(Decl, DeclFunction, DeclAssociatedType)
 
diff --git a/lib/APIDigester/ModuleAnalyzerNodes.cpp b/lib/APIDigester/ModuleAnalyzerNodes.cpp
@@ -46,6 +46,7 @@ struct swift::ide::api::SDKNodeInitInfo {
   SDKNodeInitInfo(SDKContext &Ctx, Decl *D);
   SDKNodeInitInfo(SDKContext &Ctx, ValueDecl *VD);
   SDKNodeInitInfo(SDKContext &Ctx, OperatorDecl *D);
+  SDKNodeInitInfo(SDKContext &Ctx, ImportDecl *ID);
   SDKNodeInitInfo(SDKContext &Ctx, ProtocolConformance *Conform);
   SDKNodeInitInfo(SDKContext &Ctx, Type Ty, TypeInitInfo Info = TypeInitInfo());
   SDKNode* createSDKNode(SDKNodeKind Kind);
@@ -80,6 +81,9 @@ void SDKNodeRoot::registerDescendant(SDKNode *D) {
   // Operator doesn't have usr
   if (isa<SDKNodeDeclOperator>(D))
     return;
+  // Import doesn't have usr
+  if (isa<SDKNodeDeclImport>(D))
+    return;
   if (auto DD = dyn_cast<SDKNodeDecl>(D)) {
     assert(!DD->getUsr().empty());
     DescendantDeclTable[DD->getUsr()].insert(DD);
@@ -166,6 +170,9 @@ SDKNodeDeclAccessor::SDKNodeDeclAccessor(SDKNodeInitInfo Info):
   SDKNodeDeclAbstractFunc(Info, SDKNodeKind::DeclAccessor),
   AccKind(Info.AccKind) {}
 
+SDKNodeDeclImport::SDKNodeDeclImport(SDKNodeInitInfo Info):
+  SDKNodeDecl(Info, SDKNodeKind::DeclImport) {}
+
 SDKNodeDeclAssociatedType::SDKNodeDeclAssociatedType(SDKNodeInitInfo Info):
   SDKNodeDecl(Info, SDKNodeKind::DeclAssociatedType) {};
 
@@ -375,6 +382,7 @@ StringRef SDKNodeType::getTypeRoleDescription() const {
   case SDKNodeKind::DeclType:
   case SDKNodeKind::DeclOperator:
   case SDKNodeKind::Conformance:
+  case SDKNodeKind::DeclImport:
     llvm_unreachable("Type Parent is wrong");
   case SDKNodeKind::DeclFunction:
   case SDKNodeKind::DeclConstructor:
@@ -940,6 +948,7 @@ static bool isSDKNodeEqual(SDKContext &Ctx, const SDKNode &L, const SDKNode &R)
     }
     case SDKNodeKind::Conformance:
     case SDKNodeKind::TypeWitness:
+    case SDKNodeKind::DeclImport:
     case SDKNodeKind::Root: {
       return L.getPrintedName() == R.getPrintedName() &&
         L.hasSameChildren(R);
@@ -1358,6 +1367,13 @@ SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, OperatorDecl *OD):
   PrintedName = OD->getName().str();
 }
 
+SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, ImportDecl *ID):
+    SDKNodeInitInfo(Ctx, cast<Decl>(ID)) {
+  std::string content;
+  llvm::raw_string_ostream OS(content);
+  ID->getModulePath().print(OS);
+  Name = PrintedName = Ctx.buffer(content);
+}
 
 SDKNodeInitInfo::SDKNodeInitInfo(SDKContext &Ctx, ProtocolConformance *Conform):
     SDKNodeInitInfo(Ctx, Conform->getProtocol()) {
@@ -1888,6 +1904,10 @@ void SwiftDeclCollector::processDecl(Decl *D) {
   if (auto *OD = dyn_cast<OperatorDecl>(D)) {
     RootNode->addChild(constructOperatorDeclNode(OD));
   }
+  if (auto *IM = dyn_cast<ImportDecl>(D)) {
+    RootNode->addChild(SDKNodeInitInfo(Ctx, IM)
+      .createSDKNode(SDKNodeKind::DeclImport));
+  }
 }
 
 void SwiftDeclCollector::processValueDecl(ValueDecl *VD) {
diff --git a/lib/DriverTool/swift_api_digester_main.cpp b/lib/DriverTool/swift_api_digester_main.cpp
@@ -1105,6 +1105,7 @@ class PrunePass : public MatchedNodeListener, public SDKTreeDiffPass {
     case SDKNodeKind::DeclAccessor:
     case SDKNodeKind::DeclConstructor:
     case SDKNodeKind::DeclTypeAlias:
+    case SDKNodeKind::DeclImport:
     case SDKNodeKind::TypeFunc:
     case SDKNodeKind::TypeNominal:
     case SDKNodeKind::TypeAlias: {
diff --git a/test/api-digester/Outputs/apinotes-diags.txt b/test/api-digester/Outputs/apinotes-diags.txt
@@ -15,6 +15,7 @@ APINotesTest(APINotesTest.h): TypeAlias CatAttributeName has been removed
 APINotesTest(APINotesTest.h): Protocol SwiftTypeWithMethodLeft has been renamed to Protocol SwiftTypeWithMethodRight
 APINotesTest(APINotesTest.h): Var OldType.oldMember has been renamed to Var NewType.newMember
 APINotesTest(APINotesTest.h): Var globalAttributeName has been renamed to Var AnimalAttributeName.globalAttributeName
+APINotesTest: Import Foundation has been renamed to Import objc_generics
 
 /* Type Changes */
 APINotesTest(APINotesTest.h): Constructor Cat.init(name:) has return type change from APINotesTest.Cat to APINotesTest.Cat?
diff --git a/test/api-digester/Outputs/apinotes-migrator-gen-revert.json b/test/api-digester/Outputs/apinotes-migrator-gen-revert.json
@@ -1,4 +1,15 @@
 [
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "Import",
+    "NodeAnnotation": "Rename",
+    "ChildIndex": "0",
+    "LeftUsr": "",
+    "LeftComment": "objc_generics",
+    "RightUsr": "",
+    "RightComment": "Foundation",
+    "ModuleName": "APINotesTest"
+  },
   {
     "DiffItemKind": "CommonDiffItem",
     "NodeKind": "Var",
diff --git a/test/api-digester/Outputs/apinotes-migrator-gen.json b/test/api-digester/Outputs/apinotes-migrator-gen.json
@@ -1,4 +1,15 @@
 [
+  {
+    "DiffItemKind": "CommonDiffItem",
+    "NodeKind": "Import",
+    "NodeAnnotation": "Rename",
+    "ChildIndex": "0",
+    "LeftUsr": "",
+    "LeftComment": "Foundation",
+    "RightUsr": "",
+    "RightComment": "objc_generics",
+    "ModuleName": "APINotesTest"
+  },
   {
     "DiffItemKind": "CommonDiffItem",
     "NodeKind": "Var",
diff --git a/test/api-digester/Outputs/cake-abi.json b/test/api-digester/Outputs/cake-abi.json
@@ -3,6 +3,30 @@
   "name": "TopLevel",
   "printedName": "TopLevel",
   "children": [
+    {
+      "kind": "Import",
+      "name": "SwiftOnoneSupport",
+      "printedName": "SwiftOnoneSupport",
+      "declKind": "Import",
+      "moduleName": "cake"
+    },
+    {
+      "kind": "Import",
+      "name": "_Concurrency",
+      "printedName": "_Concurrency",
+      "declKind": "Import",
+      "moduleName": "cake"
+    },
+    {
+      "kind": "Import",
+      "name": "cake",
+      "printedName": "cake",
+      "declKind": "Import",
+      "moduleName": "cake",
+      "declAttributes": [
+        "Exported"
+      ]
+    },
     {
       "kind": "TypeDecl",
       "name": "P1",
diff --git a/test/api-digester/Outputs/cake.json b/test/api-digester/Outputs/cake.json
@@ -3,6 +3,30 @@
   "name": "TopLevel",
   "printedName": "TopLevel",
   "children": [
+    {
+      "kind": "Import",
+      "name": "SwiftOnoneSupport",
+      "printedName": "SwiftOnoneSupport",
+      "declKind": "Import",
+      "moduleName": "cake"
+    },
+    {
+      "kind": "Import",
+      "name": "_Concurrency",
+      "printedName": "_Concurrency",
+      "declKind": "Import",
+      "moduleName": "cake"
+    },
+    {
+      "kind": "Import",
+      "name": "cake",
+      "printedName": "cake",
+      "declKind": "Import",
+      "moduleName": "cake",
+      "declAttributes": [
+        "Exported"
+      ]
+    },
     {
       "kind": "TypeDecl",
       "name": "P1",
diff --git a/test/api-digester/Outputs/clang-module-dump.txt b/test/api-digester/Outputs/clang-module-dump.txt
@@ -3,6 +3,16 @@
   "name": "TopLevel",
   "printedName": "TopLevel",
   "children": [
+    {
+      "kind": "Import",
+      "name": "ObjectiveC",
+      "printedName": "ObjectiveC",
+      "declKind": "Import",
+      "moduleName": "Foo",
+      "declAttributes": [
+        "Exported"
+      ]
+    },
     {
       "kind": "TypeDecl",
       "name": "AnotherObjcProt",
