[SourceKit] Report type decl info instead of hidden inits

Author: Simon Barinka

test/SourceKit/CursorInfo/cursor_info.swift

@@ -814,38 +814,40 @@ var a: A = 42
 // CHECK93-NEXT: <decl.enumelement><syntaxtype.keyword>case</syntaxtype.keyword> <decl.name>b</decl.name> = <syntaxtype.string>&quot;f&quot;</syntaxtype.string></decl.enumelement>
 
 // RUN: %sourcekitd-test -req=cursor -pos=227:14 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %s | %FileCheck -check-prefix=CHECK94 %s
-// CHECK94: source.lang.swift.ref.function.constructor
-// CHECK94-NEXT: init(_builtinStringLiteral:utf8CodeUnitCount:isASCII:)
-// CHECK94-NEXT: s:SS21_builtinStringLiteral17utf8CodeUnitCount7isASCIISSBp_BwBi1_tcfc
+// CHECK94: source.lang.swift.ref.struct
+// CHECK94-NEXT: String
+// CHECK94-NEXT: s:SS
 // CHECK94-NEXT: source.lang.swift
-// CHECK94-NEXT: (String.Type) -> (Builtin.RawPointer, Builtin.Word, Builtin.Int1) -> String
-// CHECK94-NEXT: $s21_builtinStringLiteral17utf8CodeUnitCount7isASCIISSBp_BwBi1_tcD
+// CHECK94-NEXT: String.Type
+// CHECK94-NEXT: $sSSmD
 // CHECK94-NEXT: Swift
 // CHECK94-NEXT: <Group>String</Group>
 // CHECK94-NEXT: SYSTEM
+// CHECK94-NEXT: <Declaration>@frozen @_eagerMove struct String</Declaration>
 
 // RUN:  %sourcekitd-test -req=cursor -pos=231:6 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %s | %FileCheck -check-prefix=CHECK95 %s
 // CHECK95: <Declaration>func checkAnyIsAKeyword(x: Any)</Declaration>
 // CHECK95-NEXT: <decl.function.free><syntaxtype.keyword>func</syntaxtype.keyword> <decl.name>checkAnyIsAKeyword</decl.name>(<decl.var.parameter><decl.var.parameter.argument_label>x</decl.var.parameter.argument_label>: <decl.var.parameter.type><syntaxtype.keyword>Any</syntaxtype.keyword></decl.var.parameter.type></decl.var.parameter>)</decl.function.free>
 
 // RUN: %sourcekitd-test -req=cursor -pos=23:23 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %s | %FileCheck -check-prefix=CHECK96 %s
-// CHECK96: source.lang.swift.ref.function.constructor
-// CHECK96-NEXT: init(_builtinStringLiteral:utf8CodeUnitCount:isASCII:)
-// CHECK96-NEXT: s:SS21_builtinStringLiteral17utf8CodeUnitCount7isASCIISSBp_BwBi1_tcfc
+// CHECK96: source.lang.swift.ref.struct
+// CHECK96-NEXT: String
+// CHECK96-NEXT: s:SS
 // CHECK96-NEXT: source.lang.swift
-// CHECK96-NEXT: (String.Type) -> (Builtin.RawPointer, Builtin.Word, Builtin.Int1) -> String
-// CHECK96-NEXT: $s21_builtinStringLiteral17utf8CodeUnitCount7isASCIISSBp_BwBi1_tcD
+// CHECK96-NEXT: String.Type
+// CHECK96-NEXT: $sSSmD
 // CHECK96-NEXT: Swift
 // CHECK96-NEXT: <Group>String</Group>
 // CHECK96-NEXT: SYSTEM
+// CHECK96-NEXT: <Declaration>@frozen @_eagerMove struct String</Declaration>
 
 // RUN: %sourcekitd-test -req=cursor -pos=233:19 %s -- -F %S/../Inputs/libIDE-mock-sdk -I %t.tmp %s | %FileCheck -check-prefix=CHECK97 %s
-// CHECK97: source.lang.swift.ref.function.constructor
-// CHECK97-NEXT: init(_builtinIntegerLiteral:)
-// CHECK97-NEXT: s:Si22_builtinIntegerLiteralSiBI_tcfc
+// CHECK97: source.lang.swift.ref.struct
+// CHECK97-NEXT: Int
+// CHECK97-NEXT: s:Si
 // CHECK97-NEXT: source.lang.swift
-// CHECK97-NEXT: (Int.Type) -> (Builtin.IntLiteral) -> Int
-// CHECK97-NEXT: $s22_builtinIntegerLiteralSiBI_tcD
+// CHECK97-NEXT: Int.Type
+// CHECK97-NEXT: $sSimD
 // CHECK97-NEXT: Swift
 // CHECK97-NEXT: <Group>Math/Integers</Group>
 // CHECK97-NEXT: SYSTEM

test/SourceKit/CursorInfo/cursor_stdlib.swift

@@ -237,13 +237,15 @@ let dictNonCost = [1:2, 3:d]
 // CHECK-BOOL1: s:Sb
 
 // RUN: %sourcekitd-test -req=cursor -pos=29:29 %s -- %s -target %target-triple %clang-importer-sdk-nosource -I %t | %FileCheck -check-prefix=CHECK-OBJ-LITERAL %s
-// CHECK-OBJ-LITERAL: source.lang.swift.ref.function.constructor
-// CHECK-OBJ-LITERAL-NEXT: init(_colorLiteralRed:green:blue:alpha:)
-// CHECK-OBJ-LITERAL-NEXT: s:13cursor_stdlib7MyColorV16_colorLiteralRed5green4blue5alphaACSf_S3ftcfc
+// CHECK-OBJ-LITERAL: source.lang.swift.ref.struct (24:8-24:15)
+// CHECK-OBJ-LITERAL-NEXT: MyColor
+// CHECK-OBJ-LITERAL-NEXT: s:13cursor_stdlib7MyColorV
 // CHECK-OBJ-LITERAL-NEXT: source.lang.swift
-// CHECK-OBJ-LITERAL-NEXT: (MyColor.Type) -> (Float, Float, Float, Float) -> MyColor
-// CHECK-OBJ-LITERAL-NEXT: $s16_colorLiteralRed5green4blue5alpha13cursor_stdlib7MyColorVSf_S3ftcD
+// CHECK-OBJ-LITERAL-NEXT: MyColor.Type
+// CHECK-OBJ-LITERAL-NEXT: $s13cursor_stdlib7MyColorVmD
 // CHECK-OBJ-LITERAL-NEXT: cursor_stdlib
+// CHECK-OBJ-LITERAL-NEXT: <Declaration>struct MyColor : <Type usr="s:s26_ExpressibleByColorLiteralP">_ExpressibleByColorLiteral</Type></Declaration>
+// CHECK-OBJ-LITERAL-NEXT: <decl.struct><syntaxtype.keyword>struct</syntaxtype.keyword> <decl.name>MyColor</decl.name> : <ref.protocol usr="s:s26_ExpressibleByColorLiteralP">_ExpressibleByColorLiteral</ref.protocol></decl.struct>
 
 // RUN: %sourcekitd-test -req=cursor -pos=31:18 %s -- %s -target %target-triple %clang-importer-sdk-nosource -I %t | %FileCheck -check-prefix=CHECK-ARRAY1 %s
 // CHECK-ARRAY1: source.lang.swift.ref.function.constructor

tools/SourceKit/include/SourceKit/Core/LangSupport.h

@@ -685,6 +685,11 @@ struct CursorInfoData {
   /// \c CursorInfoData.
   llvm::BumpPtrAllocator Allocator;
 
+  bool isEmpty() const {
+    return InternalDiagnostic.empty() && Symbols.empty() &&
+           AvailableActions.empty();
+  }
+
   void print(llvm::raw_ostream &OS, std::string Indentation) const {
     OS << Indentation << "CursorInfoData" << '\n';
     OS << Indentation << "  Symbols:" << '\n';

tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp

@@ -1151,6 +1151,39 @@ fillSymbolInfo(CursorSymbolInfo &Symbol, const DeclInfo &DInfo,
   return llvm::Error::success();
 }
 
+// If E is a literal, returns the declaration that should be reported by
+// cursor info for that initializer.
+static ValueDecl *getCursorInfoDeclForLiteral(Expr *E) {
+  if (auto *CollectionLit = dyn_cast<CollectionExpr>(E)) {
+    return CollectionLit->getInitializer().getDecl();
+  }
+
+  LiteralExpr* LitExpr = dyn_cast<LiteralExpr>(E);
+  if (!LitExpr) {
+    return nullptr;
+  }
+
+  bool IsObjectLiteral = dyn_cast<ObjectLiteralExpr>(E);
+  if (!IsObjectLiteral && LitExpr->getInitializer().getDecl()) {
+    return LitExpr->getInitializer().getDecl();
+  }
+
+  // We shouldn’t report the builtin initializer to the user because it’s
+  // underscored and not visible. Instead, return the type of the literal.
+  if (IsObjectLiteral || dyn_cast<BuiltinLiteralExpr>(E)) {
+    Type Ty = E->getType();
+    if (!Ty) {
+      return nullptr;
+    }
+    auto NominalTy = Ty->getAs<NominalOrBoundGenericNominalType>();
+    if (!NominalTy) {
+      return nullptr;
+    }
+    return NominalTy->getDecl();
+  }
+  return nullptr;
+}
+
 static bool addCursorInfoForLiteral(
     CursorInfoData &Data, Expr *LitExpr, SwiftLangSupport &Lang,
     const CompilerInvocation &CompInvoc, SourceLoc CursorLoc,
@@ -1159,22 +1192,7 @@ static bool addCursorInfoForLiteral(
     return false;
   }
 
-  // Tries to retrieve the referenced initializer.
-  auto getInitializer = [](auto *Expr) -> ValueDecl * {
-    if (auto *LitExpr = dyn_cast<LiteralExpr>(Expr)) {
-      if (LitExpr->getInitializer().getDecl()) {
-        return LitExpr->getInitializer().getDecl();
-      }
-      if (auto *BuiltinLit = dyn_cast<BuiltinLiteralExpr>(LitExpr)) {
-        return BuiltinLit->getBuiltinInitializer().getDecl();
-      }
-    } else if (auto *CollectionLit = dyn_cast<CollectionExpr>(Expr)) {
-      return CollectionLit->getInitializer().getDecl();
-    }
-    return nullptr;
-  };
-
-  ValueDecl *InitDecl = getInitializer(LitExpr);
+  ValueDecl *InitDecl = getCursorInfoDeclForLiteral(LitExpr);
   if (!InitDecl) {
     return false;
   }
@@ -1183,9 +1201,11 @@ static bool addCursorInfoForLiteral(
   DeclInfo Info(InitDecl, nullptr, true, false, {}, CompInvoc);
   auto Err = fillSymbolInfo(Symbol, Info, CursorLoc, false, Lang, CompInvoc,
                             PreviousSnaps, Data.Allocator);
+
   bool Success = true;
   llvm::handleAllErrors(std::move(Err), [&](const llvm::StringError &E) {
     Data.InternalDiagnostic = copyCString(E.getMessage(), Data.Allocator);
+    Data.Symbols.pop_back();
     Success = false;
   });
   return Success;
@@ -1678,18 +1698,10 @@ static void resolveCursor(
             return nullptr;
           }
           Expr *E = ExprInfo->getTrailingExpr();
-          if (dyn_cast<LiteralExpr>(E)) {
-            return E;
-          }
-          switch (E->getKind()) {
-          case ExprKind::Array:
-          case ExprKind::Dictionary:
-          case ExprKind::KeyPath: {
+          if (dyn_cast<LiteralExpr>(E) || dyn_cast<CollectionExpr>(E)) {
             return E;
           }
-          default:
-            return nullptr;
-          }
+          return nullptr;
         };
 
         CursorInfoData Data;
@@ -1702,17 +1714,11 @@ static void resolveCursor(
 
         // Handle literal expression.
         if (auto *LitExpr = tryGetLiteralExpr(CursorInfo)) {
-          bool Success = addCursorInfoForLiteral(Data, LitExpr, Lang, CompInvok,
-                                                 CursorInfo->getLoc(),
-                                                 getPreviousASTSnaps());
-          if (!Success) {
-            Data.Symbols.clear();
-            Data.AvailableActions.clear();
-          }
+          addCursorInfoForLiteral(Data, LitExpr, Lang, CompInvok,
+                                  CursorInfo->getLoc(), getPreviousASTSnaps());
         }
 
-        if (Data.InternalDiagnostic.empty() && Data.AvailableActions.empty() &&
-            Data.Symbols.empty()) {
+        if (Data.isEmpty()) {
           Data.InternalDiagnostic =
               "Resolved to incomplete expression or statement.";
         }