[CodeCompletion] Annotate 'async' functions/initializers in results

rintaro · rintaro · commit be7466eb3f22 · 2020-12-14T11:03:24.000-08:00
Similar to how it shows "throws" today.

Introduced CodeCompletionStringChunk::ChunkKind::AsyncKeyword

rdar://problem/72198530
diff --git a/include/swift/IDE/CodeCompletion.h b/include/swift/IDE/CodeCompletion.h
@@ -95,6 +95,9 @@ class CodeCompletionStringChunk {
     /// The "rethrows" keyword.
     RethrowsKeyword,
 
+    /// The "async" keyword.
+    AsyncKeyword,
+
     /// The keyword part of a declaration before the name, like "func".
     DeclIntroducer,
 
@@ -222,6 +225,7 @@ class CodeCompletionStringChunk {
            Kind == ChunkKind::OverrideKeyword ||
            Kind == ChunkKind::ThrowsKeyword ||
            Kind == ChunkKind::RethrowsKeyword ||
+           Kind == ChunkKind::AsyncKeyword ||
            Kind == ChunkKind::DeclAttrKeyword ||
            Kind == ChunkKind::DeclIntroducer ||
            Kind == ChunkKind::Keyword ||
diff --git a/lib/IDE/CodeCompletion.cpp b/lib/IDE/CodeCompletion.cpp
@@ -387,6 +387,7 @@ void CodeCompletionString::print(raw_ostream &OS) const {
     case ChunkKind::OverrideKeyword:
     case ChunkKind::ThrowsKeyword:
     case ChunkKind::RethrowsKeyword:
+    case ChunkKind::AsyncKeyword:
     case ChunkKind::DeclIntroducer:
     case ChunkKind::Text:
     case ChunkKind::LeftParen:
@@ -1378,6 +1379,7 @@ Optional<unsigned> CodeCompletionString::getFirstTextChunkIndex(
     case ChunkKind::OverrideKeyword:
     case ChunkKind::ThrowsKeyword:
     case ChunkKind::RethrowsKeyword:
+    case ChunkKind::AsyncKeyword:
     case ChunkKind::DeclIntroducer:
     case ChunkKind::CallParameterColon:
     case ChunkKind::CallParameterTypeBegin:
@@ -1433,6 +1435,7 @@ void CodeCompletionString::getName(raw_ostream &OS) const {
       }
       case ChunkKind::ThrowsKeyword:
       case ChunkKind::RethrowsKeyword:
+      case ChunkKind::AsyncKeyword:
         shouldPrint = true; // Even when they're annotations.
         break;
       default:
@@ -2639,9 +2642,16 @@ class CompletionLookup final : public swift::VisibleDeclConsumer {
                                    genericSig, includeDefaultArgs);
   }
 
-  static void addThrows(CodeCompletionResultBuilder &Builder,
-                        const AnyFunctionType *AFT,
-                        const AbstractFunctionDecl *AFD) {
+  static void addAsyncThrows(CodeCompletionResultBuilder &Builder,
+                             const AnyFunctionType *AFT,
+                             const AbstractFunctionDecl *AFD) {
+    assert(AFT != nullptr);
+
+    // 'async'.
+    if ((AFD && AFD->hasAsync()) || AFT->isAsync())
+      Builder.addAnnotatedAsync();
+
+    // 'throws' or 'rethrows'.
     if (AFD && AFD->getAttrs().hasAttribute<RethrowsAttr>())
       Builder.addAnnotatedRethrows();
     else if (AFT->isThrowing())
@@ -2799,7 +2809,7 @@ class CompletionLookup final : public swift::VisibleDeclConsumer {
       else
         Builder.addAnnotatedRightParen();
 
-      addThrows(Builder, AFT, AFD);
+      addAsyncThrows(Builder, AFT, AFD);
 
       if (AFD &&
           AFD->isImplicitlyUnwrappedOptional())
@@ -2946,14 +2956,14 @@ class CompletionLookup final : public swift::VisibleDeclConsumer {
         Builder.addRightParen();
       } else if (trivialTrailingClosure) {
         Builder.addBraceStmtWithCursor(" { code }");
-        addThrows(Builder, AFT, FD);
+        addAsyncThrows(Builder, AFT, FD);
       } else {
         Builder.addLeftParen();
         addCallArgumentPatterns(Builder, AFT, FD->getParameters(),
                                 FD->getGenericSignatureOfContext(),
                                 includeDefaultArgs);
         Builder.addRightParen();
-        addThrows(Builder, AFT, FD);
+        addAsyncThrows(Builder, AFT, FD);
       }
 
       // Build type annotation.
@@ -3094,7 +3104,7 @@ class CompletionLookup final : public swift::VisibleDeclConsumer {
       else
         Builder.addAnnotatedRightParen();
 
-      addThrows(Builder, ConstructorType, CD);
+      addAsyncThrows(Builder, ConstructorType, CD);
 
       if (!Result.hasValue())
         Result = ConstructorType->getResult();
diff --git a/lib/IDE/CodeCompletionResultBuilder.h b/lib/IDE/CodeCompletionResultBuilder.h
@@ -230,6 +230,17 @@ class CodeCompletionResultBuilder {
        " throws");
   }
 
+  void addAnnotatedAsync() {
+    addAsync();
+    getLastChunk().setIsAnnotation();
+  }
+
+  void addAsync() {
+    addChunkWithTextNoCopy(
+       CodeCompletionString::Chunk::ChunkKind::AsyncKeyword,
+       " async");
+  }
+
   void addDeclDocCommentWords(ArrayRef<std::pair<StringRef, StringRef>> Pairs) {
     assert(Kind == CodeCompletionResult::ResultKind::Declaration);
     CommentWords = Pairs;
diff --git a/lib/IDE/CodeCompletionResultPrinter.cpp b/lib/IDE/CodeCompletionResultPrinter.cpp
@@ -102,6 +102,7 @@ class AnnotatingResultPrinter {
     case ChunkKind::AccessControlKeyword:
     case ChunkKind::ThrowsKeyword:
     case ChunkKind::RethrowsKeyword:
+    case ChunkKind::AsyncKeyword:
     case ChunkKind::DeclIntroducer:
       printWithTag("keyword", C.getText());
       break;
diff --git a/lib/IDE/REPLCodeCompletion.cpp b/lib/IDE/REPLCodeCompletion.cpp
@@ -40,6 +40,7 @@ static std::string toInsertableString(CodeCompletionResult *Result) {
     case CodeCompletionString::Chunk::ChunkKind::OverrideKeyword:
     case CodeCompletionString::Chunk::ChunkKind::ThrowsKeyword:
     case CodeCompletionString::Chunk::ChunkKind::RethrowsKeyword:
+    case CodeCompletionString::Chunk::ChunkKind::AsyncKeyword:
     case CodeCompletionString::Chunk::ChunkKind::DeclAttrKeyword:
     case CodeCompletionString::Chunk::ChunkKind::DeclIntroducer:
     case CodeCompletionString::Chunk::ChunkKind::Keyword:
diff --git a/test/IDE/complete_asyncannotation.swift b/test/IDE/complete_asyncannotation.swift
@@ -0,0 +1,71 @@
+// RUN: %target-swift-ide-test -batch-code-completion -source-filename %s -filecheck %raw-FileCheck -completion-output-dir %t -enable-experimental-concurrency
+
+func globalFuncAsync() async {}
+func globalFuncAsyncThrows() async throws {}
+func globalFuncAsyncRethrows(_ x: () async throws -> ()) async rethrows {}
+struct HasAsyncMembers {
+  func memberAsync() async {}
+  func memberAsyncThrows() async throws {}
+  func memberAsyncRethrows(_ x: () async throws -> ()) async rethrows {}
+
+  init() async {}
+  init(withAsync: Int) async {}
+  init(withAsyncThrows: Int) async throws {}
+  init(withAsyncRethrows: () async throws -> Void) async rethrows {}
+}
+
+func testGlobalFuncAsync() {
+  globalFuncAsync#^CHECK_globalFuncAsync^#
+// CHECK_globalFuncAsync: Begin completions
+// CHECK_globalFuncAsync-DAG: Decl[FreeFunction]/CurrModule: ()[' async'][#Void#]; name=() async
+// CHECK_globalFuncAsync: End completions
+}
+func testGlobalFuncAsyncThrows() {
+  globalFuncAsyncThrows#^CHECK_globalFuncAsyncThrows^#
+// CHECK_globalFuncAsyncThrows: Begin completions
+// CHECK_globalFuncAsyncThrows-DAG: Decl[FreeFunction]/CurrModule: ()[' async'][' throws'][#Void#]; name=() async throws
+// CHECK_globalFuncAsyncThrows: End completions
+}
+func testGlobalFuncAsyncRethrows() {
+  globalFuncAsyncRethrows#^CHECK_globalFuncAsyncRethrows^#
+// CHECK_globalFuncAsyncRethrows: Begin completions
+// CHECK_globalFuncAsyncRethrows-DAG: Decl[FreeFunction]/CurrModule: ({#(x): () async throws -> ()##() async throws -> ()#})[' async'][' rethrows'][#Void#]; name=(x: () async throws -> ()) async rethrows
+// CHECK_globalFuncAsyncRethrows: End completions
+}
+func testAsyncMembers(_ x: HasAsyncMembers) {
+  x.#^CHECK_members^#
+// CHECK_members: Begin completions
+// CHECK_members-DAG: Decl[InstanceMethod]/CurrNominal:   memberAsync()[' async'][#Void#]; name=memberAsync() async
+// CHECK_members-DAG: Decl[InstanceMethod]/CurrNominal:   memberAsyncThrows()[' async'][' throws'][#Void#]; name=memberAsyncThrows() async throws
+// CHECK_members-DAG: Decl[InstanceMethod]/CurrNominal:   memberAsyncRethrows {|}[' async'][' rethrows'][#Void#]; name=memberAsyncRethrows { code } async rethrows
+// CHECK_members-DAG: Decl[InstanceMethod]/CurrNominal:   memberAsyncRethrows({#(x): () async throws -> ()##() async throws -> ()#})[' async'][' rethrows'][#Void#]; name=memberAsyncRethrows(x: () async throws -> ()) async rethrows
+// CHECK_members: End completions
+}
+func testMemberAsync(_ x: HasAsyncMembers) {
+  x.memberAsync#^CHECK_memberAsync^#
+// CHECK_memberAsync: Begin completions
+// CHECK_memberAsync-DAG: Decl[InstanceMethod]/CurrNominal: ()[' async'][#Void#]; name=() async
+// CHECK_memberAsync: End completions
+}
+func testMemberAsyncThrows(_ x: HasAsyncMembers) {
+  x.memberAsyncThrows#^CHECK_memberAsyncThrows^#
+// CHECK_memberAsyncThrows: Begin completions
+// CHECK_memberAsyncThrows-DAG: Decl[InstanceMethod]/CurrNominal: ()[' async'][' throws'][#Void#]; name=() async throws
+// CHECK_memberAsyncThrows: End completions
+}
+func testMemberAsyncRethrows(_ x: HasAsyncMembers) {
+  x.memberAsyncRethrows#^CHECK_memberAsyncRethrows^#
+// CHECK_memberAsyncRethrows: Begin completions
+// CHECK_memberAsyncRethrows-DAG: Decl[InstanceMethod]/CurrNominal: ({#(x): () async throws -> ()##() async throws -> ()#})[' async'][' rethrows'][#Void#]; name=(x: () async throws -> ()) async rethrows
+// CHECK_memberAsyncRethrows: End completions
+}
+
+func testAsyncIntiializers() {
+  HasAsyncMembers(#^CHECK_initializers^#
+// CHECK_initializers: Begin completions
+// CHECK_initializers-DAG: Decl[Constructor]/CurrNominal: ['('][')'][#HasAsyncMembers#]; name=
+// CHECK_initializers-DAG: Decl[Constructor]/CurrNominal: ['(']{#withAsync: Int#}[')'][#HasAsyncMembers#]; name=withAsync: Int
+// CHECK_initializers-DAG: Decl[Constructor]/CurrNominal: ['(']{#withAsyncThrows: Int#}[')'][' throws'][#HasAsyncMembers#]; name=withAsyncThrows: Int throws
+// CHECK_initializers-DAG: Decl[Constructor]/CurrNominal: ['(']{#withAsyncRethrows: () async throws -> Void##() async throws -> Void#}[')'][' rethrows'][#HasAsyncMembers#]; name=withAsyncRethrows: () async throws -> Void rethrows
+// CHECK_initializers: End completions
+}
