Merge pull request #15796 from nkcsgexi/digester-ignore-objc-protocol

swift-api-digester: ignore synthesized type members from conformed clang protocols.

Author: nkcsgexi

test/api-digester/Inputs/Foo/foo.h

@@ -0,0 +1,9 @@
+#import <Foundation.h>
+
+@protocol ObjcProt
+  -(void) someFunctionFromProt;
+@end
+
+@interface ClangInterface: NSObject <ObjcProt>
+- (void)someFunction;
+@end

test/api-digester/Inputs/Foo/module.modulemap

@@ -0,0 +1,3 @@
+module Foo {
+  header "foo.h"
+}

test/api-digester/Outputs/clang-module-dump.txt

@@ -0,0 +1,97 @@
+{
+  "kind": "Root",
+  "name": "TopLevel",
+  "printedName": "TopLevel",
+  "children": [
+    {
+      "kind": "TypeDecl",
+      "name": "ClangInterface",
+      "printedName": "ClangInterface",
+      "declKind": "Class",
+      "usr": "c:objc(cs)ClangInterface",
+      "location": "",
+      "moduleName": "Foo",
+      "superclassUsr": "c:objc(cs)NSObject",
+      "conformingProtocols": [
+        "ObjcProt",
+        "NSObjectProtocol"
+      ],
+      "children": [
+        {
+          "kind": "Function",
+          "name": "someFunction",
+          "printedName": "someFunction()",
+          "declKind": "Func",
+          "usr": "c:objc(cs)ClangInterface(im)someFunction",
+          "location": "",
+          "moduleName": "Foo",
+          "children": [
+            {
+              "kind": "TypeNameAlias",
+              "name": "Void",
+              "printedName": "Void",
+              "children": [
+                {
+                  "kind": "TypeNominal",
+                  "name": "Void",
+                  "printedName": "()"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "kind": "Constructor",
+          "name": "init",
+          "printedName": "init()",
+          "declKind": "Constructor",
+          "usr": "c:objc(cs)NSObject(im)init",
+          "location": "",
+          "moduleName": "Foo",
+          "children": [
+            {
+              "kind": "TypeNominal",
+              "name": "ClangInterface",
+              "printedName": "ClangInterface",
+              "usr": "c:objc(cs)ClangInterface"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "kind": "TypeDecl",
+      "name": "ObjcProt",
+      "printedName": "ObjcProt",
+      "declKind": "Protocol",
+      "usr": "c:objc(pl)ObjcProt",
+      "location": "",
+      "moduleName": "Foo",
+      "children": [
+        {
+          "kind": "Function",
+          "name": "someFunctionFromProt",
+          "printedName": "someFunctionFromProt()",
+          "declKind": "Func",
+          "usr": "c:objc(pl)ObjcProt(im)someFunctionFromProt",
+          "location": "",
+          "moduleName": "Foo",
+          "children": [
+            {
+              "kind": "TypeNameAlias",
+              "name": "Void",
+              "printedName": "Void",
+              "children": [
+                {
+                  "kind": "TypeNominal",
+                  "name": "Void",
+                  "printedName": "()"
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

test/api-digester/clang-module-dump.swift

@@ -0,0 +1,6 @@
+// REQUIRES: OS=macosx
+// RUN: %empty-directory(%t.mod)
+// RUN: %empty-directory(%t.sdk)
+// RUN: %empty-directory(%t.module-cache)
+// RUN: %api-digester -dump-sdk -module Foo -o %t.result -module-cache-path %t.module-cache %clang-importer-sdk-nosource -swift-version 4 -I %S/Inputs/Foo -avoid-location
+// RUN: diff -u %S/Outputs/clang-module-dump.txt %t.result

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

@@ -163,6 +163,10 @@ SwiftVersion("swift-version",
 
 static llvm::cl::opt<bool>
 OutputInJson("json", llvm::cl::desc("Print output in JSON format."));
+
+static llvm::cl::opt<bool>
+AvoidLocation("avoid-location",
+              llvm::cl::desc("Avoid serializing the file paths of SDK nodes."));
 } // namespace options
 
 namespace {
@@ -1225,6 +1229,9 @@ static StringRef calculateUsr(SDKContext &Ctx, ValueDecl *VD) {
 }
 
 static StringRef calculateLocation(SDKContext &SDKCtx, ValueDecl *VD) {
+  if (options::AvoidLocation) {
+    return StringRef();
+  }
   auto &Ctx = VD->getASTContext();
   auto &Importer = static_cast<ClangImporter &>(*Ctx.getClangModuleLoader());
 
@@ -1483,7 +1490,7 @@ static SDKNode* constructInitNode(SDKContext &Ctx, ConstructorDecl *CD) {
   return Func;
 }
 
-static bool shouldIgnore(Decl *D) {
+static bool shouldIgnore(Decl *D, const Decl* Parent) {
   if (D->isPrivateStdlibDecl(false))
     return true;
   if (AvailableAttr::isUnavailable(D))
@@ -1518,6 +1525,13 @@ static bool shouldIgnore(Decl *D) {
       return true;
     if (ClangD->hasAttr<clang::SwiftPrivateAttr>())
       return true;
+
+    // If this decl is a synthesized member from a conformed clang protocol, we
+    // should ignore this member to reduce redundancy.
+    if (Parent &&
+        !isa<swift::ProtocolDecl>(Parent) &&
+        isa<clang::ObjCProtocolDecl>(ClangD->getDeclContext()))
+      return true;
   }
   return false;
 }
@@ -1558,7 +1572,7 @@ static SDKNode *constructTypeAliasNode(SDKContext &Ctx,TypeAliasDecl *TAD) {
 static void addMembersToRoot(SDKContext &Ctx, SDKNode *Root,
                              IterableDeclContext *Context) {
   for (auto *Member : Context->getMembers()) {
-    if (shouldIgnore(Member))
+    if (shouldIgnore(Member, Context->getDecl()))
       continue;
     if (auto Func = dyn_cast<FuncDecl>(Member)) {
       Root->addChild(constructFunctionNode(Ctx, Func, SDKNodeKind::DeclFunction));
@@ -1648,7 +1662,7 @@ class SwiftDeclCollector : public VisibleDeclConsumer {
   }
 
   void processDecl(ValueDecl *VD) {
-    if (shouldIgnore(VD))
+    if (shouldIgnore(VD, nullptr))
       return;
 
     if (auto FD = dyn_cast<FuncDecl>(VD)) {