Merge pull request swiftlang#7166 from akyrtzi/index-system-module-enhancements

[index] Add testing for indexing a system overlay module, along with fine-grained control on the relations we want to index.

Author: akyrtzi

lib/Index/Index.cpp

@@ -302,12 +302,13 @@ class IndexSwiftASTWalker : public SourceEntityWalker {
   }
 
   void repressRefAtLoc(SourceLoc Loc) {
+    if (Loc.isInvalid()) return;
     assert(!EntitiesStack.empty());
     EntitiesStack.back().RefsToSuppress.push_back(Loc);
   }
 
   bool isRepressed(SourceLoc Loc) {
-    if (EntitiesStack.empty())
+    if (EntitiesStack.empty() || Loc.isInvalid())
       return false;
     auto &Suppressed = EntitiesStack.back().RefsToSuppress;
     return std::find(Suppressed.begin(), Suppressed.end(), Loc) != Suppressed.end();
@@ -786,7 +787,17 @@ bool IndexSwiftASTWalker::report(ValueDecl *D) {
   return !Cancelled;
 }
 
-//
+static bool hasUsefulRoleInSystemModule(SymbolRoleSet roles) {
+  return roles | (SymbolRoleSet)SymbolRole::Definition |
+  (SymbolRoleSet)SymbolRole::Declaration |
+  (SymbolRoleSet)SymbolRole::RelationChildOf |
+  (SymbolRoleSet)SymbolRole::RelationBaseOf |
+  (SymbolRoleSet)SymbolRole::RelationOverrideOf |
+  (SymbolRoleSet)SymbolRole::RelationExtendedBy |
+  (SymbolRoleSet)SymbolRole::RelationAccessorOf |
+  (SymbolRoleSet)SymbolRole::RelationIBTypeOf;
+}
+
 bool IndexSwiftASTWalker::reportRef(ValueDecl *D, SourceLoc Loc,
                                     IndexSymbol &Info) {
   if (!shouldIndex(D))
@@ -803,10 +814,11 @@ bool IndexSwiftASTWalker::reportRef(ValueDecl *D, SourceLoc Loc,
       return true;
   }
 
+  if (isSystemModule && !hasUsefulRoleInSystemModule(Info.roles))
+    return true;
 
-  if (!startEntity(D, Info)) {
+  if (!startEntity(D, Info))
     return true;
-  }
 
   // Report the accessors that were utilized.
   if (AbstractStorageDecl *ASD = dyn_cast<AbstractStorageDecl>(D)) {

test/Index/Inputs/my_system_overlay/module.modulemap

@@ -0,0 +1,3 @@
+module my_system_overlay [system] {
+  header "my_system_overlay_header.h"
+}

test/Index/Inputs/my_system_overlay/my_system_overlay.swift

@@ -0,0 +1,11 @@
+@_exported import my_system_overlay
+
+public func some_func() {}
+
+public class BaseCls {
+  func theMeth() {}
+}
+
+public class SubCls : BaseCls {
+  override func theMeth() {}
+}

test/Index/Inputs/my_system_overlay/my_system_overlay_header.h

@@ -0,0 +1 @@
+void some_c_func(void);

test/Index/index_system_module.swift

@@ -0,0 +1,17 @@
+// RUN: rm -rf %t
+// RUN: mkdir -p %t
+//
+// RUN: %target-swift-frontend -emit-module -o %t %S/Inputs/my_system_overlay/my_system_overlay.swift -Xcc -I -Xcc %S/Inputs/my_system_overlay
+// RUN: %target-swift-ide-test -print-indexed-symbols -module-to-print my_system_overlay -source-filename %s -I %t -Xcc -I -Xcc %S/Inputs/my_system_overlay > %t.out
+// RUN: %FileCheck %s -input-file=%t.out
+
+// CHECK: class/Swift | SubCls | [[SUBCLS_USR:.*]] | Def | rel: 0
+// CHECK: class/Swift | BaseCls | [[BASECLS_USR:.*]] | Ref,RelBase | rel: 1
+// CHECK-NEXT: RelBase | SubCls | [[SUBCLS_USR]]
+// CHECK: instance-method/Swift | theMeth() | [[SUBCLSMETH_USR:.*]] | Def,RelChild,RelOver | rel: 2
+// CHECK-NEXT: RelOver | theMeth() | [[BASECLSMETH_USR:.*]]
+// CHECK-NEXT: RelChild | SubCls | [[SUBCLS_USR]]
+// CHECK: class/Swift | BaseCls | [[BASECLS_USR]] | Def | rel: 0
+// CHECK: instance-method/Swift | theMeth() | [[BASECLSMETH_USR]] | Def,RelChild | rel: 1
+// CHECK-NEXT: RelChild | BaseCls | [[BASECLS_USR]]
+// CHECK: function/Swift | some_func() | [[SOMEFUNC_USR:.*]] | Def | rel: 0