Handle dynamic member lookup in annotation and cursor info

Ensure the various entity walkers handle the implicit subscript
reference correctly (usually by ignoring it) and fall through to the
underlying declarations.

rdar://49028895

Author: benlangmuir

lib/IDE/SwiftSourceDocInfo.cpp

@@ -190,6 +190,8 @@ bool CursorInfoResolver::visitDeclReference(ValueDecl *D,
                                             ReferenceMetaData Data) {
   if (isDone())
     return false;
+  if (Data.isImplicit)
+    return true;
   return !tryResolve(D, CtorTyRef, ExtTyRef, Range.getStart(), /*IsRef=*/true, T);
 }
 
@@ -1423,7 +1425,7 @@ struct RangeResolver::Implementation {
     if (Data.Kind != SemaReferenceKind::DeclRef)
       return;
 
-    if (!isContainedInSelection(CharSourceRange(Start, 0)))
+    if (Data.isImplicit || !isContainedInSelection(CharSourceRange(Start, 0)))
       return;
 
     // If the VD is declared outside of current file, exclude such decl.

lib/Migrator/APIDiffMigratorPass.cpp

@@ -484,6 +484,9 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
   bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
                           TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
                           Type T, ReferenceMetaData Data) override {
+    if (Data.isImplicit)
+      return true;
+
     for (auto *Item: getRelatedDiffItems(CtorTyRef ? CtorTyRef: D)) {
       std::string RepText;
       if (isSimpleReplacement(Item, isDotMember(Range), RepText)) {
@@ -501,7 +504,7 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
     bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
                             TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
                             Type T, ReferenceMetaData Data) override {
-      if (D == Target) {
+      if (D == Target && !Data.isImplicit) {
         Result = Range;
         return false;
       }

test/IDE/annotation.swift

@@ -339,3 +339,30 @@ test_arg_tuple2(p1:0,0)
 test_arg_tuple3(0,p2:0)
 // CHECK: <Func@[[@LINE-7]]:6>test_arg_tuple4</Func>(<Func@[[@LINE-7]]:6#p1>p1</Func>:0,<Func@[[@LINE-7]]:6#p2>p2</Func>:0)
 test_arg_tuple4(p1:0,p2:0)
+
+
+@dynamicMemberLookup
+struct Lens<T> {
+  var obj: T
+  init(_ obj: T) {
+    self.obj = obj
+  }
+  subscript<U>(dynamicMember member: WritableKeyPath<T, U>) -> Lens<U> {
+    get { return Lens<U>(obj[keyPath: member]) }
+    set { obj[keyPath: member] = newValue.obj }
+  }
+}
+struct Point {
+  var x: Int
+  var y: Int
+}
+struct Rectangle {
+  var topLeft: Point
+  var bottomRight: Point
+}
+func testDynamicMemberLookup(r: Lens<Rectangle>) {
+  _ = r.topLeft
+  // CHECK: _ = <Param@[[@LINE-2]]:30>r</Param>.<Var@[[@LINE-5]]:7>topLeft</Var>
+  _ = r.bottomRight.y
+  // CHECK: _ = <Param@[[@LINE-4]]:30>r</Param>.<Var@[[@LINE-6]]:7>bottomRight</Var>.<Var@[[@LINE-10]]:7>y</Var>
+}

test/SourceKit/CursorInfo/cursor_info_keypath_member_lookup.swift

@@ -0,0 +1,63 @@
+struct Point {
+  var x: Int
+  var y: Int
+}
+
+struct Rectangle {
+  var topLeft: Point
+  var bottomRight: Point
+}
+
+@dynamicMemberLookup
+struct Lens<T> {
+  var obj: T
+  init(_ obj: T) {
+    self.obj = obj
+  }
+
+  subscript<U>(dynamicMember member: WritableKeyPath<T, U>) -> Lens<U> {
+    get { return Lens<U>(obj[keyPath: member]) }
+    set { obj[keyPath: member] = newValue.obj }
+  }
+}
+
+func test(r: Lens<Rectangle>) {
+  _ = r.topLeft
+  _ = r.bottomRight.y
+}
+
+// RUN: %sourcekitd-test -req=cursor -pos=18:3 -cursor-action %s -- %s | %FileCheck -check-prefix=SUBSCRIPT %s
+// SUBSCRIPT: source.lang.swift.decl.function.subscript (18:3-18:12)
+// SUBSCRIPT: subscript(dynamicMember:)
+// SUBSCRIPT: <T, U> (dynamicMember: WritableKeyPath<T, U>) -> Lens<U>
+// SUBSCRIPT: <decl.function.subscript><syntaxtype.keyword>subscript</syntaxtype.keyword>&lt;<decl.generic_type_param usr="s:33cursor_info_keypath_member_lookup4LensV1UL_qd__mfp"><decl.generic_type_param.name>U</decl.generic_type_param.name></decl.generic_type_param>&gt;(<decl.var.parameter><decl.var.parameter.argument_label>dynamicMember</decl.var.parameter.argument_label> <decl.var.parameter.name>member</decl.var.parameter.name>: <decl.var.parameter.type><ref.class usr="s:s15WritableKeyPathC">WritableKeyPath</ref.class>&lt;<ref.generic_type_param usr="s:33cursor_info_keypath_member_lookup4LensV1Txmfp">T</ref.generic_type_param>, <ref.generic_type_param usr="s:33cursor_info_keypath_member_lookup4LensV1UL_qd__mfp">U</ref.generic_type_param>&gt;</decl.var.parameter.type></decl.var.parameter>) -&gt; <decl.function.returntype><ref.struct usr="s:33cursor_info_keypath_member_lookup4LensV">Lens</ref.struct>&lt;<ref.generic_type_param usr="s:33cursor_info_keypath_member_lookup4LensV1UL_qd__mfp">U</ref.generic_type_param>&gt;</decl.function.returntype> { <syntaxtype.keyword>get</syntaxtype.keyword> <syntaxtype.keyword>set</syntaxtype.keyword> }</decl.function.subscript>
+// SUBSCRIPT: ACTIONS BEGIN
+// FIXME: should not allow rename since that would break the contract.
+// SUBSCRIPT: source.refactoring.kind.rename.global
+// SUBSCRIPT: ACTIONS END
+
+// RUN: %sourcekitd-test -req=cursor -pos=25:9 -cursor-action %s -- %s | %FileCheck -check-prefix=TOP_LEFT %s
+// TOP_LEFT: source.lang.swift.ref.var.instance
+// TOP_LEFT: topLeft
+// TOP_LEFT: Point
+// TOP_LEFT: <decl.var.instance><syntaxtype.keyword>var</syntaxtype.keyword> <decl.name>topLeft</decl.name>: <decl.var.type><ref.struct usr="{{s:.*}}">Point</ref.struct></decl.var.type></decl.var.instance>
+// TOP_LEVEL: ACTIONS BEGIN
+// TOP_LEVEL: source.refactoring.kind.rename.global
+// TOP_LEVEL: ACTIONS END
+
+// RUN: %sourcekitd-test -req=cursor -pos=26:9 -cursor-action %s -- %s | %FileCheck -check-prefix=BOTTOM_RIGHT %s
+// BOTTOM_RIGHT: source.lang.swift.ref.var.instance
+// BOTTOM_RIGHT: bottomRight
+// BOTTOM_RIGHT: Point
+// BOTTOM_RIGHT: ACTIONS BEGIN
+// BOTTOM_RIGHT: source.refactoring.kind.rename.global
+// BOTTOM_RIGHT: ACTIONS END
+
+/// RUN: %sourcekitd-test -req=cursor -pos=26:21 -cursor-action %s -- %s | %FileCheck -check-prefix=YREF %s
+// YREF: source.lang.swift.ref.var.instance
+// YREF: y
+// YREF: Int
+// YREF: <decl.var.instance><syntaxtype.keyword>var</syntaxtype.keyword> <decl.name>y</decl.name>: <decl.var.type><ref.struct usr="s:Si">Int</ref.struct></decl.var.type></decl.var.instance>
+// YREF: ACTIONS BEGIN
+// YREF: source.refactoring.kind.rename.global
+// YREF: ACTIONS END

tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp

@@ -1032,6 +1032,8 @@ class SourceDocASTWalker : public SourceEntityWalker {
   bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
                           TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type Ty,
                           ReferenceMetaData Data) override {
+    if (Data.isImplicit)
+      return true;
     unsigned StartOffset = getOffset(Range.getStart());
     References.emplace_back(D, StartOffset, Range.getByteLength(), Ty);
     return true;

tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp

@@ -905,8 +905,11 @@ class SemanticAnnotator : public SourceEntityWalker {
   bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
                           TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
                           ReferenceMetaData Data) override {
-      if (isa<VarDecl>(D) && D->hasName() &&
-          D->getFullName() == D->getASTContext().Id_self)
+    if (Data.isImplicit)
+      return true;
+
+    if (isa<VarDecl>(D) && D->hasName() &&
+        D->getFullName() == D->getASTContext().Id_self)
       return true;
 
     // Do not annotate references to unavailable decls.

tools/swift-ide-test/swift-ide-test.cpp

@@ -1434,7 +1434,8 @@ class AnnotationPrinter : public SourceEntityWalker {
   bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
                           TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type Ty,
                           ReferenceMetaData Data) override {
-    annotateSourceEntity({ Range, D, CtorTyRef, /*IsRef=*/true });
+    if (!Data.isImplicit)
+      annotateSourceEntity({ Range, D, CtorTyRef, /*IsRef=*/true });
     return true;
   }