[SourceKit] In CursorInfo response, include the mangle name of the type of the underlying decl.

The mangled name of the type is identical to those for debugger. These
mangled names allow us to reconstruct the type from AST and generate interface
specifically for that type.

Related rdar://27306890

Author: nkcsgexi

include/swift/AST/USRGeneration.h

@@ -23,6 +23,10 @@ enum class AccessorKind;
 
 namespace ide {
 
+/// Prints out the USR for the Type of the given decl.
+/// \returns true if it failed, false on success.
+bool printDeclTypeUSR(const ValueDecl *D, raw_ostream &OS);
+
 /// Prints out the USR for the given Decl.
 /// \returns true if it failed, false on success.
 bool printDeclUSR(const ValueDecl *D, raw_ostream &OS);

lib/AST/USRGeneration.cpp

@@ -29,6 +29,14 @@ static inline StringRef getUSRSpacePrefix() {
   return "s:";
 }
 
+bool ide::printDeclTypeUSR(const ValueDecl *D, raw_ostream &OS) {
+  using namespace Mangle;
+  Mangler Mangler(true);
+  Mangler.mangleDeclTypeForDebugger(D);
+  Mangler.finalize(OS);
+  return false;
+}
+
 bool ide::printDeclUSR(const ValueDecl *D, raw_ostream &OS) {
   using namespace Mangle;
 

test/SourceKit/CursorInfo/cursor_info.swift

@@ -26,6 +26,7 @@ func foo3(a: Float, b: Bool) {}
 // CHECK-OVERLAY-NEXT: NSUTF8StringEncoding
 // CHECK-OVERLAY-NEXT: s:v10Foundation20NSUTF8StringEncodingSu
 // CHECK-OVERLAY-NEXT: UInt
+// CHECK-OVERLAY-NEXT: _TtSu
 // CHECK-OVERLAY-NEXT: <Declaration>public let NSUTF8StringEncoding: <Type usr="s:Su">UInt</Type></Declaration>
 
 // RUN: %sourcekitd-test -req=cursor -pos=5:13 %s -- %s %mcp_opt %clang-importer-sdk | FileCheck -check-prefix=CHECK-ITERATOR %s

test/SourceKit/CursorInfo/cursor_stdlib.swift

@@ -22,6 +22,7 @@ func foo(x: FooStruct1) -> S1 {}
 // CHECK_SANITY1-NEXT: global
 // CHECK_SANITY1-NEXT: s:v10cursor_usr6globalSi
 // CHECK_SANITY1-NEXT: Int
+// CHECK_SANITY1-NEXT: _TtSi
 // CHECK_SANITY1-NEXT: <Declaration>var global: <Type usr="s:Si">Int</Type></Declaration>
 // CHECK_SANITY1-NEXT: <decl.var.global><syntaxtype.keyword>var</syntaxtype.keyword> <decl.name>global</decl.name>: <decl.var.type><ref.struct usr="s:Si">Int</ref.struct></decl.var.type></decl.var.global>
 

test/SourceKit/CursorInfo/cursor_usr.swift

@@ -33,6 +33,7 @@ var x: Int
 // CHECK1-NEXT: Int
 // CHECK1-NEXT: s:Si
 // CHECK1-NEXT: Int.Type
+// CHECK1-NEXT: _Tt
 // CHECK1-NEXT: Swift{{$}}
 // CHECK1-NEXT: <Group>Math/Integers</Group>
 // CHECK1-NEXT: /<interface-gen>{{$}}

test/SourceKit/InterfaceGen/gen_stdlib.swift

@@ -253,6 +253,7 @@ struct CursorInfo {
   StringRef Name;
   StringRef USR;
   StringRef TypeName;
+  StringRef TypeUSR;
   StringRef DocComment;
   StringRef TypeInterface;
   StringRef GroupName;

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

@@ -697,6 +697,10 @@ bool SwiftLangSupport::printUSR(const ValueDecl *D, llvm::raw_ostream &OS) {
   return ide::printDeclUSR(D, OS);
 }
 
+bool SwiftLangSupport::printDeclTypeUSR(const ValueDecl *D, llvm::raw_ostream &OS) {
+  return ide::printDeclTypeUSR(D, OS);
+}
+
 bool SwiftLangSupport::printAccessorUSR(const AbstractStorageDecl *D,
                                         AccessorKind AccKind,
                                         llvm::raw_ostream &OS) {

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp

@@ -261,6 +261,10 @@ class SwiftLangSupport : public LangSupport {
   /// \returns true if the results should be ignored, false otherwise.
   static bool printUSR(const swift::ValueDecl *D, llvm::raw_ostream &OS);
 
+  /// Generate a USR for the Type of a given decl.
+  /// \returns true if the results should be ignored, false otherwise.
+  static bool printDeclTypeUSR(const swift::ValueDecl *D, llvm::raw_ostream &OS);
+
   /// Generate a USR for an accessor, including the prefix.
   /// \returns true if the results should be ignored, false otherwise.
   static bool printAccessorUSR(const swift::AbstractStorageDecl *D,

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h

@@ -657,6 +657,13 @@ static bool passCursorInfoForDecl(const ValueDecl *VD,
   }
   unsigned TypenameEnd = SS.size();
 
+  unsigned MangledTypeStart = SS.size();
+  {
+    llvm::raw_svector_ostream OS(SS);
+    SwiftLangSupport::printDeclTypeUSR(VD, OS);
+  }
+  unsigned MangledTypeEnd = SS.size();
+
   unsigned DocCommentBegin = SS.size();
   {
     llvm::raw_svector_ostream OS(SS);
@@ -772,6 +779,8 @@ static bool passCursorInfoForDecl(const ValueDecl *VD,
   StringRef USR = StringRef(SS.begin()+USRBegin, USREnd-USRBegin);
   StringRef TypeName = StringRef(SS.begin()+TypenameBegin,
                                  TypenameEnd-TypenameBegin);
+  StringRef TypeUsr = StringRef(SS.begin()+MangledTypeStart,
+                                MangledTypeEnd - MangledTypeStart);
   StringRef DocComment = StringRef(SS.begin()+DocCommentBegin,
                                    DocCommentEnd-DocCommentBegin);
   StringRef AnnotatedDecl = StringRef(SS.begin()+DeclBegin,
@@ -812,6 +821,7 @@ static bool passCursorInfoForDecl(const ValueDecl *VD,
   Info.Name = Name;
   Info.USR = USR;
   Info.TypeName = TypeName;
+  Info.TypeUSR = TypeUsr;
   Info.DocComment = DocComment;
   Info.AnnotatedDeclaration = AnnotatedDecl;
   Info.FullyAnnotatedDeclaration = FullyAnnotatedDecl;

tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp

@@ -118,6 +118,7 @@ static sourcekitd_uid_t KeyNotification;
 static sourcekitd_uid_t KeyPopular;
 static sourcekitd_uid_t KeyUnpopular;
 static sourcekitd_uid_t KeyTypeInterface;
+static sourcekitd_uid_t KeyTypeUsr;
 static sourcekitd_uid_t KeyModuleGroups;
 static sourcekitd_uid_t KeySimplified;
 
@@ -216,6 +217,7 @@ static int skt_main(int argc, const char **argv) {
   KeyPopular = sourcekitd_uid_get_from_cstr("key.popular");
   KeyUnpopular = sourcekitd_uid_get_from_cstr("key.unpopular");
   KeyTypeInterface = sourcekitd_uid_get_from_cstr("key.typeinterface");
+  KeyTypeUsr = sourcekitd_uid_get_from_cstr("key.typeusr");
   KeyModuleGroups = sourcekitd_uid_get_from_cstr("key.modulegroups");
   KeySimplified = sourcekitd_uid_get_from_cstr("key.simplified");
 
@@ -935,6 +937,8 @@ static void printCursorInfo(sourcekitd_variant_t Info, StringRef FilenameIn,
   const char *Name = sourcekitd_variant_dictionary_get_string(Info, KeyName);
   const char *Typename = sourcekitd_variant_dictionary_get_string(Info,
                                                                   KeyTypename);
+  const char *TypeUsr = sourcekitd_variant_dictionary_get_string(Info,
+                                                                 KeyTypeUsr);
   const char *ModuleName = sourcekitd_variant_dictionary_get_string(Info,
                                                               KeyModuleName);
   const char *GroupName = sourcekitd_variant_dictionary_get_string(Info,
@@ -1006,6 +1010,8 @@ static void printCursorInfo(sourcekitd_variant_t Info, StringRef FilenameIn,
     OS << USR << '\n';
   if (Typename)
     OS << Typename << '\n';
+  if (TypeUsr)
+    OS << TypeUsr << '\n';
   if (ModuleName)
     OS << ModuleName << '\n';
   if (GroupName)

tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp

@@ -117,6 +117,7 @@ extern SourceKit::UIdent KeyDeprecated;
 extern SourceKit::UIdent KeyObsoleted;
 extern SourceKit::UIdent KeyRemoveCache;
 extern SourceKit::UIdent KeyTypeInterface;
+extern SourceKit::UIdent KeyTypeUsr;
 extern SourceKit::UIdent KeyModuleGroups;
 
 /// \brief Used for determining the printing order of dictionary keys.

tools/SourceKit/tools/sourcekitd/lib/API/DictionaryKeys.h

@@ -1328,6 +1328,8 @@ static void reportCursorInfo(const CursorInfo &Info, ResponseReceiver Rec) {
     Elem.setBool(KeyIsSystem, true);
   if (!Info.TypeInterface.empty())
     Elem.set(KeyTypeInterface, Info.TypeInterface);
+  if (!Info.TypeUSR.empty())
+    Elem.set(KeyTypeUsr, Info.TypeUSR);
 
   return Rec(RespBuilder.createResponse());
 }

tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp

@@ -131,6 +131,7 @@ UIdent sourcekitd::KeyDeprecated("key.deprecated");
 UIdent sourcekitd::KeyObsoleted("key.obsoleted");
 UIdent sourcekitd::KeyRemoveCache("key.removecache");
 UIdent sourcekitd::KeyTypeInterface("key.typeinterface");
+UIdent sourcekitd::KeyTypeUsr("key.typeusr");
 UIdent sourcekitd::KeyModuleGroups("key.modulegroups");
 
 /// \brief Order for the keys to use when emitting the debug description of