[TypeInterface] When printing type-specific interfaces, replace parameter and return types with instantiated types.

nkcsgexi · nkcsgexi · commit 9beeb56a90e8 · 2015-11-17T19:12:30.000-08:00
diff --git a/include/swift/AST/ASTPrinter.h b/include/swift/AST/ASTPrinter.h
@@ -20,6 +20,7 @@
 
 namespace swift {
   class Decl;
+  class DeclContext;
   class ModuleEntity;
   class TypeDecl;
   class Type;
@@ -103,8 +104,8 @@ class ASTPrinter {
 
   /// To sanitize a malformatted utf8 string to a well-formatted one.
   static std::string sanitizeUtf8(StringRef Text);
-  static bool printTypeInterface(Type Ty, std::string &Result);
-  static bool printTypeInterface(Type Ty, llvm::raw_ostream &Out);
+  static bool printTypeInterface(Type Ty, DeclContext *DC, std::string &Result);
+  static bool printTypeInterface(Type Ty, DeclContext *DC, llvm::raw_ostream &Out);
 
 private:
   virtual void anchor();
diff --git a/include/swift/AST/PrintOptions.h b/include/swift/AST/PrintOptions.h
@@ -21,7 +21,10 @@ class GenericParamList;
 class CanType;
 class ExtensionDecl;
 class TypeBase;
+class DeclContext;
+class Type;
 enum DeclAttrKind : unsigned;
+class PrinterArchetypeTransformer;
 
 /// Options for printing AST nodes.
 ///
@@ -191,8 +194,7 @@ struct PrintOptions {
   /// \brief When printing a type interface, register the type to print.
   TypeBase *TypeToPrint = nullptr;
 
-  /// \brief When printing a type interface, whether we instantiate archetypes.
-  bool InstantiateArchetype = false;
+  std::shared_ptr<PrinterArchetypeTransformer> pTransformer;
 
   /// Retrieve the set of options for verbose printing to users.
   static PrintOptions printVerbose() {
@@ -234,12 +236,7 @@ struct PrintOptions {
     return result;
   }
 
-  static PrintOptions printTypeInterface(TypeBase *T) {
-    PrintOptions result = printInterface();
-    result.TypeToPrint = T;
-    result.InstantiateArchetype = true;
-    return result;
-  }
+  static PrintOptions printTypeInterface(Type T, DeclContext *DC);
 
   /// Retrive the print options that are suitable to print the testable interface.
   static PrintOptions printTestableInterface() {
diff --git a/include/swift/IDE/Utils.h b/include/swift/IDE/Utils.h
@@ -138,11 +138,12 @@ struct SemaToken {
   bool IsRef = true;
   bool IsKeywordArgument = false;
   Type Ty;
+  DeclContext *DC = nullptr;
 
   SemaToken() = default;
   SemaToken(ValueDecl *ValueD, TypeDecl *CtorTyRef, SourceLoc Loc, bool IsRef,
             Type Ty) : ValueD(ValueD), CtorTyRef(CtorTyRef), Loc(Loc),
-            IsRef(IsRef), Ty(Ty) { }
+            IsRef(IsRef), Ty(Ty), DC(ValueD->getDeclContext()) {}
   SemaToken(ModuleEntity Mod, SourceLoc Loc) : Mod(Mod), Loc(Loc) { }
 
   bool isValid() const { return ValueD != nullptr || Mod; }
@@ -179,17 +180,18 @@ class SemaLocResolver : public SourceEntityWalker {
                                bool IsOpenBracket) override;
 };
 
+} // namespace ide
+
 class ArchetypeTransformer {
+  std::function<Type(Type)> TheFunc = nullptr;
   DeclContext *DC;
   Type BaseTy;
   llvm::DenseMap<TypeBase *, Type> Cache;
   TypeSubstitutionMap Map;
-  std::function<Type(Type)> TheFunc = nullptr;
 public:
   ArchetypeTransformer(DeclContext *DC, Type Ty);
   llvm::function_ref<Type(Type)> getTransformerFunc();
 };
-} // namespace ide
 } // namespace swift
 
 #endif // SWIFT_IDE_UTILS_H
diff --git a/lib/AST/ASTPrinter.cpp b/lib/AST/ASTPrinter.cpp
@@ -32,7 +32,6 @@
 #include "swift/Basic/PrimitiveParsing.h"
 #include "swift/Basic/STLExtras.h"
 #include "swift/Config.h"
-#include "swift/IDE/Utils.h"
 #include "swift/Sema/CodeCompletionTypeChecking.h"
 #include "swift/Strings.h"
 #include "clang/AST/ASTContext.h"
@@ -45,6 +44,63 @@
 #include <algorithm>
 
 using namespace swift;
+namespace swift {
+class PrinterArchetypeTransformer {
+  Type BaseTy;
+  DeclContext *DC;
+  llvm::DenseMap<TypeBase *, Type> Cache;
+  llvm::DenseMap<StringRef, Type> IdMap;
+
+public:
+  PrinterArchetypeTransformer(Type Ty, DeclContext *DC) :
+    BaseTy(Ty->getRValueType()), DC(DC){
+    (void) this->DC;
+    auto D = BaseTy->getNominalOrBoundGenericNominal();
+    if (!D || !D->getGenericParams())
+      return;
+    SmallVector<Type, 3> Scrach;
+    auto Args = BaseTy->getAllGenericArgs(Scrach);
+    const auto ParamDecls = D->getGenericParams()->getParams();
+    assert(ParamDecls.size() == Args.size());
+
+    // Map type parameter names with their instantiating arguments.
+    for(unsigned I = 0, N = ParamDecls.size(); I < N; I ++) {
+      IdMap[ParamDecls[I]->getName().str()] = Args[I];
+    }
+  }
+
+  Type transformByName(Type Ty) {
+    if (Ty->getKind() != TypeKind::Archetype)
+      return Ty;
+
+    // First, we try to find the map from cache.
+    if (Cache.count(Ty.getPointer()) > 0) {
+      return Cache[Ty.getPointer()];
+    }
+    auto Id = cast<ArchetypeType>(Ty.getPointer())->getName().str();
+    auto Result = Ty;
+
+    // Iterate the IdMap to find the argument type of the given param name.
+    for (auto It = IdMap.begin(); It != IdMap.end(); ++ It) {
+      if (Id == It->getFirst()) {
+        Result = It->getSecond();
+        break;
+      }
+    }
+
+    // Put the result into cache.
+    Cache[Ty.getPointer()] = Result;
+    return Result;
+  }
+};
+}
+
+PrintOptions PrintOptions::printTypeInterface(Type T, DeclContext *DC) {
+  PrintOptions result = printInterface();
+  result.pTransformer = std::make_shared<PrinterArchetypeTransformer>(T, DC);
+  result.TypeToPrint = T.getPointer();
+  return result;
+}
 
 std::string ASTPrinter::sanitizeUtf8(StringRef Text) {
   llvm::SmallString<256> Builder;
@@ -71,11 +127,12 @@ std::string ASTPrinter::sanitizeUtf8(StringRef Text) {
   return Builder.str();
 }
 
-bool ASTPrinter::printTypeInterface(Type Ty, llvm::raw_ostream &OS) {
+bool ASTPrinter::printTypeInterface(Type Ty, DeclContext *DC,
+                                    llvm::raw_ostream &OS) {
   if (!Ty)
     return false;
   Ty = Ty->getRValueType();
-  PrintOptions Options = PrintOptions::printTypeInterface(Ty.getPointer());
+  PrintOptions Options = PrintOptions::printTypeInterface(Ty.getPointer(), DC);
    if (auto ND = Ty->getNominalOrBoundGenericNominal()) {
      Options.printExtensionContentAsMembers = [&](const ExtensionDecl *ED) {
        return isExtensionApplied(*ND->getDeclContext(), Ty, ED);
@@ -86,9 +143,9 @@ bool ASTPrinter::printTypeInterface(Type Ty, llvm::raw_ostream &OS) {
   return false;
 }
 
-bool ASTPrinter::printTypeInterface(Type Ty, std::string &Buffer) {
+bool ASTPrinter::printTypeInterface(Type Ty, DeclContext *DC, std::string &Buffer) {
   llvm::raw_string_ostream OS(Buffer);
-  auto Result = printTypeInterface(Ty, OS);
+  auto Result = printTypeInterface(Ty, DC, OS);
   OS.str();
   return Result;
 }
@@ -351,6 +408,13 @@ class PrintAST : public ASTVisitor<PrintAST> {
   }
 
   void printTypeLoc(const TypeLoc &TL) {
+    if (Options.pTransformer && TL.getType()) {
+      if (auto RT = Options.pTransformer->transformByName(TL.getType())) {
+        PrintOptions FreshOptions;
+        RT.print(Printer, FreshOptions);
+        return;
+      }
+    }
     // Print a TypeRepr if instructed to do so by options, or if the type
     // is null.
     if ((Options.PreferTypeRepr && TL.hasLocation()) ||
@@ -596,7 +660,7 @@ void PrintAST::printGenericParams(GenericParamList *Params) {
   Printer << "<";
   bool IsFirst = true;
   SmallVector<Type, 4> Scrach;
-  if (Options.InstantiateArchetype) {
+  if (Options.pTransformer) {
     auto ArgArr = Options.TypeToPrint->getAllGenericArgs(Scrach);
     for (auto Arg : ArgArr) {
       if (IsFirst) {
@@ -1749,7 +1813,12 @@ void PrintAST::visitFuncDecl(FuncDecl *decl) {
     Type ResultTy = decl->getResultType();
     if (ResultTy && !ResultTy->isEqual(TupleType::getEmpty(Context))) {
       Printer << " -> ";
-      ResultTy->print(Printer, Options);
+      if (Options.pTransformer) {
+        ResultTy = Options.pTransformer->transformByName(ResultTy);
+        PrintOptions FreshOptions;
+        ResultTy->print(Printer, FreshOptions);
+      } else
+        ResultTy->print(Printer, Options);
     }
 
     if (!Options.FunctionDefinitions || !decl->getBody()) {
diff --git a/test/IDE/print_type_interface.swift b/test/IDE/print_type_interface.swift
@@ -27,14 +27,6 @@ public protocol P1 { }
 public class T1 : P1 { }
 public class D<T> { public func foo() {}}
 
-extension D where T : P1 {
-  public func conditionalFunc1() {}
-}
-
-extension D {
-  public func unconditionalFunc1(){}
-}
-
 class C2 {
   func f() {
     let D1 = D<T1>()
@@ -44,17 +36,29 @@ class C2 {
   }
 }
 
-// RUN: %target-swift-ide-test -print-type-interface -pos=42:6 -source-filename %s | FileCheck %s -check-prefix=TYPE2
-// RUN: %target-swift-ide-test -print-type-interface -pos=43:6 -source-filename %s | FileCheck %s -check-prefix=TYPE3
+// RUN: %target-swift-ide-test -print-type-interface -pos=34:6 -source-filename %s | FileCheck %s -check-prefix=TYPE2
+// RUN: %target-swift-ide-test -print-type-interface -pos=35:6 -source-filename %s | FileCheck %s -check-prefix=TYPE3
 
+extension D where T : P1 {
+  public func conditionalFunc1() {}
+  public func conditionalFunc2(t : T) -> T {return t}
+}
+
+extension D {
+  public func unconditionalFunc1(){}
+  public func unconditionalFunc2(t : T) -> T {return t}
+}
 
-// TYPE2:      public class D<T1> {
-// TYPE2-NEXT:   public func foo()
-// TYPE2-NEXT:   public func conditionalFunc1()
-// TYPE2-NEXT:   public func unconditionalFunc1()
+// TYPE2:       public class D<T1> {
+// TYPE2-NEXT:    public func foo()
+// TYPE2-NEXT:    public func conditionalFunc1()
+// TYPE2-NEXT:    public func conditionalFunc2(t: T1) -> T1
+// TYPE2-NEXT:    public func unconditionalFunc1()
+// TYPE2-NEXT:    public func unconditionalFunc2(t: T1) -> T1
 // TYPE2-NEXT: }
 
 // TYPE3:      public class D<Int> {
 // TYPE3-NEXT:   public func foo()
 // TYPE3-NEXT:   public func unconditionalFunc1()
+// TYPE3-NEXT:   public func unconditionalFunc2(t: Int) -> Int
 // TYPE3-NEXT: }
diff --git a/tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp b/tools/SourceKit/lib/SwiftLang/SwiftSourceDocInfo.cpp
@@ -391,7 +391,8 @@ static bool passCursorInfoForDecl(const ValueDecl *VD,
   Info.OverrideUSRs = OverUSRs;
   Info.AnnotatedRelatedDeclarations = AnnotatedRelatedDecls;
   Info.IsSystem = IsSystem;
-  Info.TypeInteface = ASTPrinter::printTypeInterface(Ty, TypeInterface) ?
+  Info.TypeInteface = ASTPrinter::printTypeInterface(Ty, VD->getDeclContext(),
+                                                     TypeInterface) ?
     StringRef(TypeInterface) : StringRef();
   Receiver(Info);
   return false;
diff --git a/tools/swift-ide-test/swift-ide-test.cpp b/tools/swift-ide-test/swift-ide-test.cpp
@@ -2263,7 +2263,7 @@ static int doPrintTypeInterface(const CompilerInvocation &InitInvok,
     llvm::errs() << "Cannot get type of the sema token.\n";
     return 1;
   }
-  ASTPrinter::printTypeInterface(SemaT.Ty, llvm::outs());
+  ASTPrinter::printTypeInterface(SemaT.Ty, SemaT.DC, llvm::outs());
   return 0;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -2263,7 +2263,7 @@ static int doPrintTypeInterface(const CompilerInvocation &InitInvok,`
`2263`	`2263`	`llvm::errs() << "Cannot get type of the sema token.\n";`
`2264`	`2264`	`return 1;`
`2265`	`2265`	`}`
`2266`		`- ASTPrinter::printTypeInterface(SemaT.Ty, llvm::outs());`
	`2266`	`+ ASTPrinter::printTypeInterface(SemaT.Ty, SemaT.DC, llvm::outs());`
`2267`	`2267`	`return 0;`
`2268`	`2268`	`}`
`2269`	`2269`