Merge pull request #3472 from nkcsgexi/type-interface

nkcsgexi · web-flow · commit b665de844c1b · 2016-07-12T17:49:16.000-07:00
[SourceKit] In CursorInfo response, include the mangle name of type.
diff --git a/include/swift/AST/USRGeneration.h b/include/swift/AST/USRGeneration.h
@@ -23,6 +23,14 @@ enum class AccessorKind;
 
 namespace ide {
 
+/// Prints out the USR for the Type.
+/// \returns true if it failed, false on success.
+bool printTypeUSR(Type Ty, raw_ostream &OS);
+
+/// 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);
diff --git a/include/swift/IDE/Utils.h b/include/swift/IDE/Utils.h
@@ -151,11 +151,13 @@ struct SemaToken {
   bool IsKeywordArgument = false;
   Type Ty;
   DeclContext *DC = nullptr;
+  Type ContainerType;
 
   SemaToken() = default;
   SemaToken(ValueDecl *ValueD, TypeDecl *CtorTyRef, SourceLoc Loc, bool IsRef,
-            Type Ty) : ValueD(ValueD), CtorTyRef(CtorTyRef), Loc(Loc),
-            IsRef(IsRef), Ty(Ty), DC(ValueD->getDeclContext()) {}
+            Type Ty, Type ContainerType) : ValueD(ValueD), CtorTyRef(CtorTyRef), Loc(Loc),
+            IsRef(IsRef), Ty(Ty), DC(ValueD->getDeclContext()),
+            ContainerType(ContainerType) {}
   SemaToken(ModuleEntity Mod, SourceLoc Loc) : Mod(Mod), Loc(Loc) { }
 
   bool isValid() const { return ValueD != nullptr || Mod; }
@@ -166,12 +168,14 @@ class SemaLocResolver : public SourceEntityWalker {
   SourceFile &SrcFile;
   SourceLoc LocToResolve;
   SemaToken SemaTok;
+  Type ContainerType;
 
 public:
   explicit SemaLocResolver(SourceFile &SrcFile) : SrcFile(SrcFile) { }
   SemaToken resolve(SourceLoc Loc);
   SourceManager &getSourceMgr() const;
 private:
+  bool walkToExprPre(Expr *E) override;
   bool walkToDeclPre(Decl *D, CharSourceRange Range) override;
   bool walkToDeclPost(Decl *D) override;
   bool walkToStmtPre(Stmt *S) override;
diff --git a/lib/AST/USRGeneration.cpp b/lib/AST/USRGeneration.cpp
@@ -29,6 +29,22 @@ static inline StringRef getUSRSpacePrefix() {
   return "s:";
 }
 
+bool ide::printTypeUSR(Type Ty, raw_ostream &OS) {
+  using namespace Mangle;
+  Mangler Mangler(true);
+  Mangler.mangleType(Ty->getRValueType(), 0);
+  Mangler.finalize(OS);
+  return false;
+}
+
+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;
 
diff --git a/lib/IDE/SwiftSourceDocInfo.cpp b/lib/IDE/SwiftSourceDocInfo.cpp
@@ -57,12 +57,12 @@ SourceManager &SemaLocResolver::getSourceMgr() const
 }
 
 bool SemaLocResolver::tryResolve(ValueDecl *D, TypeDecl *CtorTyRef,
-                SourceLoc Loc, bool IsRef, Type Ty) {
+                                 SourceLoc Loc, bool IsRef, Type Ty) {
   if (!D->hasName())
     return false;
 
   if (Loc == LocToResolve) {
-    SemaTok = { D, CtorTyRef, Loc, IsRef, Ty };
+    SemaTok = { D, CtorTyRef, Loc, IsRef, Ty, ContainerType };
     return true;
   }
   return false;
@@ -138,6 +138,22 @@ bool SemaLocResolver::visitDeclReference(ValueDecl *D, CharSourceRange Range,
   return !tryResolve(D, CtorTyRef, Range.getStart(), /*IsRef=*/true, T);
 }
 
+bool SemaLocResolver::walkToExprPre(Expr *E) {
+  if (!isDone()) {
+    if (auto SAE = dyn_cast<SelfApplyExpr>(E)) {
+      if (SAE->getFn()->getStartLoc() == LocToResolve) {
+        ContainerType = SAE->getBase()->getType();
+      }
+    } else if (auto ME = dyn_cast<MemberRefExpr>(E)) {
+      SourceLoc DotLoc = ME->getDotLoc();
+      if (DotLoc.isValid() && DotLoc.getAdvancedLoc(1) == LocToResolve) {
+        ContainerType = ME->getBase()->getType();
+      }
+    }
+  }
+  return true;
+}
+
 bool SemaLocResolver::visitCallArgName(Identifier Name, CharSourceRange Range,
                                        ValueDecl *D) {
   if (isDone())
diff --git a/test/SourceKit/CursorInfo/cursor_info.swift b/test/SourceKit/CursorInfo/cursor_info.swift
diff --git a/test/SourceKit/CursorInfo/cursor_info_container.swift b/test/SourceKit/CursorInfo/cursor_info_container.swift
@@ -0,0 +1,68 @@
+struct S {
+  func getArray() -> [S] { return [] }
+  func getInstance() -> S { return self }
+  static var Instance : S = S()
+}
+
+class C {
+  func getArray() -> [C] { return [] }
+  func getInstance() -> C { return self }
+  static var Instance : C = C()
+}
+
+enum E {
+  case CASE1
+  func getArray() -> [E] { return [] }
+  func getInstance() -> E { return self }
+  static var Instance : E = E.CASE1
+}
+func SGen() -> S { return S() }
+func CGen() -> C { return C() }
+func EGen() -> E { return .CASE1}
+
+func foo(s : S, c : C, e: E) {
+  _ = s.getArray()
+  _ = s.getInstance()
+  _ = S.Instance
+  _ = c.getArray()
+  _ = c.getInstance()
+  _ = C.Instance
+  _ = e.getInstance()
+  _ = e.getArray()
+  _ = E.CASE1
+  _ = E.Instance
+  _ = SGen().getArray()
+  _ = CGen().getInstance()
+  _ = EGen().getArray()
+  _ = SArrayGen().count
+}
+
+func SArrayGen() -> [S] { return [] }
+
+// RUN: %sourcekitd-test -req=cursor -pos=24:12 %s -- %s | FileCheck -check-prefix=CHECK1 %s
+// RUN: %sourcekitd-test -req=cursor -pos=25:12 %s -- %s | FileCheck -check-prefix=CHECK1 %s
+// RUN: %sourcekitd-test -req=cursor -pos=34:19 %s -- %s | FileCheck -check-prefix=CHECK1 %s
+// CHECK1: <Container>V21cursor_info_container1S</Container>
+
+// RUN: %sourcekitd-test -req=cursor -pos=26:12 %s -- %s | FileCheck -check-prefix=CHECK2 %s
+// CHECK2: <Container>MV21cursor_info_container1S</Container>
+
+// RUN: %sourcekitd-test -req=cursor -pos=27:12 %s -- %s | FileCheck -check-prefix=CHECK3 %s
+// RUN: %sourcekitd-test -req=cursor -pos=28:12 %s -- %s | FileCheck -check-prefix=CHECK3 %s
+// RUN: %sourcekitd-test -req=cursor -pos=35:19 %s -- %s | FileCheck -check-prefix=CHECK3 %s
+// CHECK3: <Container>C21cursor_info_container1C</Container>
+
+// RUN: %sourcekitd-test -req=cursor -pos=29:12 %s -- %s | FileCheck -check-prefix=CHECK4 %s
+// CHECK4: <Container>MC21cursor_info_container1C</Container>
+
+// RUN: %sourcekitd-test -req=cursor -pos=30:12 %s -- %s | FileCheck -check-prefix=CHECK5 %s
+// RUN: %sourcekitd-test -req=cursor -pos=31:12 %s -- %s | FileCheck -check-prefix=CHECK5 %s
+// RUN: %sourcekitd-test -req=cursor -pos=36:19 %s -- %s | FileCheck -check-prefix=CHECK5 %s
+// CHECK5: <Container>O21cursor_info_container1E</Container>
+
+// RUN: %sourcekitd-test -req=cursor -pos=32:12 %s -- %s | FileCheck -check-prefix=CHECK6 %s
+// RUN: %sourcekitd-test -req=cursor -pos=33:12 %s -- %s | FileCheck -check-prefix=CHECK6 %s
+// CHECK6: <Container>MO21cursor_info_container1E</Container>
+
+// RUN: %sourcekitd-test -req=cursor -pos=37:22 %s -- %s | FileCheck -check-prefix=CHECK7 %s
+// CHECK7: <Container>GSaV21cursor_info_container1S_</Container>
diff --git a/test/SourceKit/CursorInfo/cursor_stdlib.swift b/test/SourceKit/CursorInfo/cursor_stdlib.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
diff --git a/test/SourceKit/CursorInfo/cursor_usr.swift b/test/SourceKit/CursorInfo/cursor_usr.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>
 
diff --git a/test/SourceKit/InterfaceGen/gen_stdlib.swift b/test/SourceKit/InterfaceGen/gen_stdlib.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>{{$}}
diff --git a/tools/SourceKit/include/SourceKit/Core/LangSupport.h b/tools/SourceKit/include/SourceKit/Core/LangSupport.h
@@ -253,6 +253,8 @@ struct CursorInfo {
   StringRef Name;
   StringRef USR;
   StringRef TypeName;
+  StringRef TypeUSR;
+  StringRef ContainerTypeUSR;
   StringRef DocComment;
   StringRef TypeInterface;
   StringRef GroupName;
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp b/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp
@@ -697,6 +697,14 @@ 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::printTypeUSR(Type Ty, llvm::raw_ostream &OS) {
+  return ide::printTypeUSR(Ty, OS);
+}
+
 bool SwiftLangSupport::printAccessorUSR(const AbstractStorageDecl *D,
                                         AccessorKind AccKind,
                                         llvm::raw_ostream &OS) {
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h b/tools/SourceKit/lib/SwiftLang/SwiftLangSupport.h
@@ -34,6 +34,7 @@ namespace swift {
   class CompilerInstance;
   class CompilerInvocation;
   class Decl;
+  class Type;
   class AbstractStorageDecl;
   class SourceFile;
   class ValueDecl;
@@ -261,6 +262,14 @@ 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 of a given type.
+  /// \returns true if the results should be ignored, false otherwise.
+  static bool printTypeUSR(swift::Type Ty, 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,
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp b/tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp
@@ -612,6 +612,7 @@ static bool passCursorInfoForModule(ModuleEntity Mod,
 static bool passCursorInfoForDecl(const ValueDecl *VD,
                                   const Module *MainModule,
                                   const Type Ty,
+                                  const Type ContainerTy,
                                   bool IsRef,
                                   Optional<unsigned> OrigBufferID,
                                   SwiftLangSupport &Lang,
@@ -657,6 +658,20 @@ 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 MangledContainerTypeStart = SS.size();
+  if (ContainerTy) {
+    llvm::raw_svector_ostream OS(SS);
+    SwiftLangSupport::printTypeUSR(ContainerTy, OS);
+  }
+  unsigned MangedContainerTypeEnd = SS.size();
+
   unsigned DocCommentBegin = SS.size();
   {
     llvm::raw_svector_ostream OS(SS);
@@ -772,6 +787,11 @@ 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 ContainerTypeUsr = StringRef(SS.begin()+MangledContainerTypeStart,
+                            MangedContainerTypeEnd - MangledContainerTypeStart);
   StringRef DocComment = StringRef(SS.begin()+DocCommentBegin,
                                    DocCommentEnd-DocCommentBegin);
   StringRef AnnotatedDecl = StringRef(SS.begin()+DeclBegin,
@@ -812,6 +832,8 @@ static bool passCursorInfoForDecl(const ValueDecl *VD,
   Info.Name = Name;
   Info.USR = USR;
   Info.TypeName = TypeName;
+  Info.TypeUSR = TypeUsr;
+  Info.ContainerTypeUSR = ContainerTypeUsr;
   Info.DocComment = DocComment;
   Info.AnnotatedDeclaration = AnnotatedDecl;
   Info.FullyAnnotatedDeclaration = FullyAnnotatedDecl;
@@ -947,6 +969,7 @@ static void resolveCursor(SwiftLangSupport &Lang,
       } else {
         ValueDecl *VD = SemaTok.CtorTyRef ? SemaTok.CtorTyRef : SemaTok.ValueD;
         bool Failed = passCursorInfoForDecl(VD, MainModule, SemaTok.Ty,
+                                            SemaTok.ContainerType,
                                             SemaTok.IsRef, BufferID, Lang,
                                             CompInvok, PreviousASTSnaps,
                                             Receiver);
@@ -1011,7 +1034,7 @@ void SwiftLangSupport::getCursorInfo(
       } else {
         // FIXME: Should pass the main module for the interface but currently
         // it's not necessary.
-        passCursorInfoForDecl(Entity.Dcl, /*MainModule*/nullptr, Type(),
+        passCursorInfoForDecl(Entity.Dcl, /*MainModule*/nullptr, Type(), Type(),
                               Entity.IsRef,
                               /*OrigBufferID=*/None, *this, Invok,
                               {}, Receiver);
@@ -1115,7 +1138,7 @@ resolveCursorFromUSR(SwiftLangSupport &Lang, StringRef InputFile, StringRef USR,
                                 Receiver);
       } else if (auto *VD = dyn_cast<ValueDecl>(D)) {
         bool Failed =
-            passCursorInfoForDecl(VD, MainModule, VD->getType(),
+            passCursorInfoForDecl(VD, MainModule, VD->getType(), Type(),
                                   /*isRef=*/false, BufferID, Lang, CompInvok,
                                   PreviousASTSnaps, Receiver);
         if (Failed) {
diff --git a/tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp b/tools/SourceKit/tools/sourcekitd-test/sourcekitd-test.cpp
@@ -118,6 +118,8 @@ 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 KeyContainerTypeUsr;
 static sourcekitd_uid_t KeyModuleGroups;
 static sourcekitd_uid_t KeySimplified;
 
@@ -216,6 +218,8 @@ 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");
+  KeyContainerTypeUsr = sourcekitd_uid_get_from_cstr("key.containertypeusr");
   KeyModuleGroups = sourcekitd_uid_get_from_cstr("key.modulegroups");
   KeySimplified = sourcekitd_uid_get_from_cstr("key.simplified");
 
@@ -935,6 +939,10 @@ 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 *ContainerTypeUsr = sourcekitd_variant_dictionary_get_string(Info,
+                                                          KeyContainerTypeUsr);
   const char *ModuleName = sourcekitd_variant_dictionary_get_string(Info,
                                                               KeyModuleName);
   const char *GroupName = sourcekitd_variant_dictionary_get_string(Info,
@@ -1006,6 +1014,10 @@ static void printCursorInfo(sourcekitd_variant_t Info, StringRef FilenameIn,
     OS << USR << '\n';
   if (Typename)
     OS << Typename << '\n';
+  if (TypeUsr)
+    OS << TypeUsr << '\n';
+  if (ContainerTypeUsr)
+    OS << "<Container>" << ContainerTypeUsr << "</Container>" << '\n';
   if (ModuleName)
     OS << ModuleName << '\n';
   if (GroupName)
diff --git a/tools/SourceKit/tools/sourcekitd/lib/API/DictionaryKeys.h b/tools/SourceKit/tools/sourcekitd/lib/API/DictionaryKeys.h
@@ -117,6 +117,8 @@ extern SourceKit::UIdent KeyDeprecated;
 extern SourceKit::UIdent KeyObsoleted;
 extern SourceKit::UIdent KeyRemoveCache;
 extern SourceKit::UIdent KeyTypeInterface;
+extern SourceKit::UIdent KeyTypeUsr;
+extern SourceKit::UIdent KeyContainerTypeUsr;
 extern SourceKit::UIdent KeyModuleGroups;
 
 /// \brief Used for determining the printing order of dictionary keys.
diff --git a/tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp b/tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp
@@ -1328,6 +1328,10 @@ 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);
+  if (!Info.ContainerTypeUSR.empty())
+    Elem.set(KeyContainerTypeUsr, Info.ContainerTypeUSR);
 
   return Rec(RespBuilder.createResponse());
 }
diff --git a/tools/SourceKit/tools/sourcekitd/lib/API/sourcekitdAPI-Common.cpp b/tools/SourceKit/tools/sourcekitd/lib/API/sourcekitdAPI-Common.cpp
@@ -131,6 +131,8 @@ 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::KeyContainerTypeUsr("key.containertypeusr");
 UIdent sourcekitd::KeyModuleGroups("key.modulegroups");
 
 /// \brief Order for the keys to use when emitting the debug description of
