Merge pull request swiftlang#32425 from bitjammer/acgarland/rdar-64425199-extension-where-constraints

[SymbolGraph] Only include where clause constraints in `swiftExtension`

Author: bitjammer

lib/SymbolGraphGen/JSON.cpp

@@ -69,9 +69,7 @@ void swift::symbolgraphgen::serialize(const ExtensionDecl *Extension,
 
     SmallVector<Requirement, 4> FilteredRequirements;
 
-    filterGenericRequirements(Extension->getGenericRequirements(),
-        Extension->getExtendedNominal()
-            ->getDeclContext()->getSelfNominalTypeDecl(),
+    filterGenericRequirements(Extension,
                               FilteredRequirements);
 
     if (!FilteredRequirements.empty()) {
@@ -122,24 +120,36 @@ void swift::symbolgraphgen::filterGenericRequirements(
     const NominalTypeDecl *Self,
     SmallVectorImpl<Requirement> &FilteredRequirements) {
   for (const auto &Req : Requirements) {
-      if (Req.getKind() == RequirementKind::Layout) {
-        continue;
-      }
-    /*
-     Don't serialize constraints that aren't applicable for display.
+    if (Req.getKind() == RequirementKind::Layout) {
+      continue;
+    }
+    // extension /* protocol */ Q {
+    // func foo() {}
+    // }
+    // ignore Self : Q, obvious
+    if (Req.getSecondType()->getAnyNominal() == Self) {
+      continue;
+    }
+    FilteredRequirements.push_back(Req);
+  }
+}
 
-     For example:
+void
+swift::symbolgraphgen::filterGenericRequirements(const ExtensionDecl *Extension,
+    SmallVectorImpl<Requirement> &FilteredRequirements) {
+  for (const auto &Req : Extension->getGenericRequirements()) {
+    if (Req.getKind() == RequirementKind::Layout) {
+      continue;
+    }
 
-     extension Equatable {
-       func foo(_ thing: Self) {}
-     }
+    if (!isa<ProtocolDecl>(Extension->getExtendedNominal()) &&
+        Req.getFirstType()->isEqual(Extension->getExtendedType())) {
+      continue;
+    }
 
-     `foo` includes a constraint `Self: Equatable` for the compiler's purposes,
-     but that's redundant for the purposes of documentation.
-     This is extending Equatable, after all!
-    */
-    if (Req.getFirstType()->getString() == "Self" &&
-        Req.getSecondType()->getAnyNominal() == Self) {
+    // extension /* protocol */ Q
+    // ignore Self : Q, obvious
+    if (Req.getSecondType()->isEqual(Extension->getExtendedType())) {
       continue;
     }
     FilteredRequirements.push_back(Req);

lib/SymbolGraphGen/JSON.h

@@ -45,11 +45,19 @@ void serialize(const swift::GenericTypeParamType *Param,
                llvm::json::OStream &OS);
 
 
-/// Filter generic requirements that aren't relevant for documentation.
+/// Filter generic requirements on an extension that aren't relevant
+/// for documentation.
 void
 filterGenericRequirements(ArrayRef<Requirement> Requirements,
                           const NominalTypeDecl *Self,
                           SmallVectorImpl<Requirement> &FilteredRequirements);
+
+/// Filter generic requirements on an extension that aren't relevant
+/// for documentation.
+void
+filterGenericRequirements(const ExtensionDecl *Extension,
+                          SmallVectorImpl<Requirement> &FilteredRequirements);
+
 } // end namespace symbolgraphgen
 } // end namespace swift
 

lib/SymbolGraphGen/Symbol.cpp

@@ -280,8 +280,8 @@ void Symbol::serializeSwiftGenericMixin(llvm::json::OStream &OS) const {
       }
 
       filterGenericRequirements(Generics->getRequirements(),
-                         Self,
-                         FilteredRequirements);
+                                Self,
+                                FilteredRequirements);
 
       if (FilteredParams.empty() && FilteredRequirements.empty()) {
         return;

test/SymbolGraph/Symbols/Mixins/Extension.swift renamed to test/SymbolGraph/Symbols/Mixins/Extension/GetFromExtension.swift

@@ -1,7 +1,7 @@
 // RUN: %empty-directory(%t)
-// RUN: %target-build-swift %s -module-name Extension -emit-module-path %t/Extension.swiftmodule
-// RUN: %target-swift-symbolgraph-extract -module-name Extension -I %t -pretty-print -output-dir %t
-// RUN: %FileCheck %s --input-file %t/Extension.symbols.json
+// RUN: %target-build-swift %s -module-name GetFromExtension -emit-module-path %t/GetFromExtension.swiftmodule
+// RUN: %target-swift-symbolgraph-extract -module-name GetFromExtension -I %t -pretty-print -output-dir %t
+// RUN: %FileCheck %s --input-file %t/GetFromExtension.symbols.json
 
 public struct Outer<T> {
   public var x: T

test/SymbolGraph/Symbols/Mixins/Extension/IgnoreInherited.swift

@@ -0,0 +1,32 @@
+// RUN: %empty-directory(%t)
+// RUN: %target-build-swift %s -module-name IgnoreInherited -emit-module-path %t/IgnoreInherited.swiftmodule
+// RUN: %target-swift-symbolgraph-extract -module-name IgnoreInherited -I %t -pretty-print -output-dir %t
+// RUN: %FileCheck %s --input-file %t/IgnoreInherited.symbols.json
+
+public protocol P {
+  associatedtype T
+  static func foo() -> T
+}
+
+public struct S<T> {}
+
+extension S: P where T: Sequence, T.Element == Int {
+  public static func foo() -> AnySequence<Int> {
+    return AnySequence([0])
+  }
+}
+
+// CHECK-LABEL: "precise": "s:15IgnoreInherited1SVAASTRzSi7ElementRtzlE3foos11AnySequenceVySiGyFZ"
+// CHECK: swiftExtension
+// CHECK: "constraints": [
+// CHECK-NEXT:   {
+// CHECK-NEXT:     "kind": "conformance",
+// CHECK-NEXT:     "lhs": "T",
+// CHECK-NEXT:     "rhs": "Sequence"
+// CHECK-NEXT:   },
+// CHECK-NEXT:   {
+// CHECK-NEXT:     "kind": "sameType",
+// CHECK-NEXT:     "lhs": "T.Element",
+// CHECK-NEXT:     "rhs": "Int"
+// CHECK-NEXT:   }
+// CHECK-NEXT: ]