Merge pull request #30767 from rintaro/sourcekit-completion-annotateddesc-rdar60801189

[SourceKit/CodeCompletion] Add an option to emit annotated description

Author: rintaro

include/swift/AST/ASTPrinter.h

@@ -206,6 +206,7 @@ class ASTPrinter {
   void printKeyword(StringRef name, PrintOptions Opts, StringRef Suffix = "") {
     if (Opts.SkipUnderscoredKeywords && name.startswith("_"))
       return;
+    assert(!name.empty() && "Tried to print empty keyword");
     callPrintNamePre(PrintNameContext::Keyword);
     *this << name;
     printNamePost(PrintNameContext::Keyword);

include/swift/IDE/CodeCompletion.h

@@ -84,9 +84,18 @@ class CodeCompletionStringChunk {
     /// The keyword part of a declaration before the name, like "func".
     DeclIntroducer,
 
+    /// Other generic keyword.
+    Keyword,
+
+    /// Other generic attributes.
+    Attribute,
+
     /// Normal text chunk.
     Text,
 
+    /// Base name of the result.
+    BaseName,
+
     /// The first chunk of an optional substring that continues until
     /// \c NestingLevel decreases.
     OptionalBegin,
@@ -133,6 +142,16 @@ class CodeCompletionStringChunk {
 
     /// Required parameter type.
     CallParameterType,
+
+    /// Parameter type tag for annotated results.
+    CallParameterTypeBegin,
+
+    /// System type name.
+    TypeIdSystem,
+
+    /// Non-system type name.
+    TypeIdUser,
+
     /// Desugared closure parameter type. This can be used to get the
     /// closure type if CallParameterType is a TypeAliasType.
     CallParameterClosureType,
@@ -169,7 +188,8 @@ class CodeCompletionStringChunk {
   static bool chunkStartsNestedGroup(ChunkKind Kind) {
     return Kind == ChunkKind::CallParameterBegin ||
            Kind == ChunkKind::GenericParameterBegin ||
-           Kind == ChunkKind::OptionalBegin;
+           Kind == ChunkKind::OptionalBegin ||
+           Kind == ChunkKind::CallParameterTypeBegin;
   }
 
   static bool chunkHasText(ChunkKind Kind) {
@@ -179,6 +199,9 @@ class CodeCompletionStringChunk {
            Kind == ChunkKind::RethrowsKeyword ||
            Kind == ChunkKind::DeclAttrKeyword ||
            Kind == ChunkKind::DeclIntroducer ||
+           Kind == ChunkKind::Keyword ||
+           Kind == ChunkKind::Attribute ||
+           Kind == ChunkKind::BaseName ||
            Kind == ChunkKind::Text ||
            Kind == ChunkKind::LeftParen ||
            Kind == ChunkKind::RightParen ||
@@ -205,7 +228,9 @@ class CodeCompletionStringChunk {
            Kind == ChunkKind::DynamicLookupMethodCallTail ||
            Kind == ChunkKind::OptionalMethodCallTail ||
            Kind == ChunkKind::TypeAnnotation ||
-           Kind == ChunkKind::BraceStmtWithCursor;
+           Kind == ChunkKind::BraceStmtWithCursor ||
+           Kind == ChunkKind::TypeIdSystem ||
+           Kind == ChunkKind::TypeIdUser;
   }
 
 private:
@@ -768,7 +793,7 @@ class CodeCompletionResult {
   }
 
   /// Print a debug representation of the code completion result to \p OS.
-  void print(raw_ostream &OS) const;
+  void printPrefix(raw_ostream &OS) const;
   SWIFT_DEBUG_DUMP;
 
   static CodeCompletionDeclKind getCodeCompletionDeclKind(const Decl *D);
@@ -788,6 +813,9 @@ struct CodeCompletionResultSink {
   /// other sinks.
   std::vector<AllocatorPtr> ForeignAllocators;
 
+  /// Whether to annotate the results with XML.
+  bool annotateResult = false;
+
   std::vector<CodeCompletionResult *> Results;
 
   /// A single-element cache for module names stored in Allocator, keyed by a
@@ -831,6 +859,9 @@ class CodeCompletionContext {
   CodeCompletionContext(CodeCompletionCache &Cache)
       : Cache(Cache) {}
 
+  void setAnnotateResult(bool flag) { CurrentResults.annotateResult = flag; }
+  bool getAnnnoateResult() { return CurrentResults.annotateResult; }
+
   /// Allocate a string owned by the code completion context.
   StringRef copyString(StringRef Str);
 
@@ -880,14 +911,17 @@ class PrintingCodeCompletionConsumer
   llvm::raw_ostream &OS;
   bool IncludeKeywords;
   bool IncludeComments;
+  bool PrintAnnotatedDescription;
 
 public:
  PrintingCodeCompletionConsumer(llvm::raw_ostream &OS,
                                 bool IncludeKeywords = true,
-                                bool IncludeComments = true)
+                                bool IncludeComments = true,
+                                bool PrintAnnotatedDescription = false)
      : OS(OS),
        IncludeKeywords(IncludeKeywords),
-       IncludeComments(IncludeComments) {}
+       IncludeComments(IncludeComments),
+       PrintAnnotatedDescription(PrintAnnotatedDescription) {}
 
  void handleResults(MutableArrayRef<CodeCompletionResult *> Results) override;
 };

include/swift/IDE/CodeCompletionCache.h

@@ -43,6 +43,7 @@ class CodeCompletionCache {
     bool ForTestableLookup;
     bool ForPrivateImportLookup;
     bool CodeCompleteInitsInPostfixExpr;
+    bool Annotated;
 
     friend bool operator==(const Key &LHS, const Key &RHS) {
       return LHS.ModuleFilename == RHS.ModuleFilename &&
@@ -108,10 +109,10 @@ template<>
 struct DenseMapInfo<swift::ide::CodeCompletionCache::Key> {
   using KeyTy = swift::ide::CodeCompletionCache::Key;
   static inline KeyTy getEmptyKey() {
-    return KeyTy{"", "", {}, false, false, false, false};
+    return KeyTy{"", "", {}, false, false, false, false, false};
   }
   static inline KeyTy getTombstoneKey() {
-    return KeyTy{"", "", {}, true, false, false, false};
+    return KeyTy{"", "", {}, true, false, false, false, false};
   }
   static unsigned getHashValue(const KeyTy &Val) {
     size_t H = 0;
@@ -122,6 +123,7 @@ struct DenseMapInfo<swift::ide::CodeCompletionCache::Key> {
     H ^= std::hash<bool>()(Val.ResultsHaveLeadingDot);
     H ^= std::hash<bool>()(Val.ForTestableLookup);
     H ^= std::hash<bool>()(Val.ForPrivateImportLookup);
+    H ^= std::hash<bool>()(Val.Annotated);
     return static_cast<unsigned>(H);
   }
   static bool isEqual(const KeyTy &LHS, const KeyTy &RHS) {

include/swift/IDE/CodeCompletionResultPrinter.h

@@ -0,0 +1,33 @@
+//===--- CodeCompletionResultPrinter.h --------------------------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2020 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_IDE_CODECOMPLETIONRESULTPRINTER_H
+#define SWIFT_IDE_CODECOMPLETIONRESULTPRINTER_H
+
+#include "llvm/Support/raw_ostream.h"
+
+namespace swift {
+namespace ide {
+
+class CodeCompletionResult;
+
+void printCodeCompletionResultDescription(const CodeCompletionResult &Result,
+                                          llvm::raw_ostream &OS,
+                                          bool leadingPunctuation);
+
+void printCodeCompletionResultDescriptionAnnotated(
+    const CodeCompletionResult &Result, llvm::raw_ostream &OS,
+    bool leadingPunctuation);
+} // namespace ide
+} // namespace swift
+
+#endif

lib/AST/ASTPrinter.cpp

@@ -2566,9 +2566,9 @@ static bool isEscaping(Type type) {
 static void printParameterFlags(ASTPrinter &printer, PrintOptions options,
                                 ParameterTypeFlags flags, bool escaping) {
   if (!options.excludeAttrKind(TAK_autoclosure) && flags.isAutoClosure())
-    printer << "@autoclosure ";
+    printer.printAttrName("@autoclosure ");
   if (!options.excludeAttrKind(TAK_noDerivative) && flags.isNoDerivative())
-    printer << "@noDerivative ";
+    printer.printAttrName("@noDerivative ");
 
   switch (flags.getValueOwnership()) {
   case ValueOwnership::Default:

lib/IDE/CMakeLists.txt

@@ -1,6 +1,7 @@
 add_swift_host_library(swiftIDE STATIC
   CodeCompletion.cpp
   CodeCompletionCache.cpp
+  CodeCompletionResultPrinter.cpp
   CommentConversion.cpp
   CompletionInstance.cpp
   ConformingMethodList.cpp