Merge pull request swiftlang#35722 from bnbarham/doc-async-attribute

[SourceKit/DocSupport] Add a field to mark functions that are async

Author: bnbarham

test/SourceKit/DocSupport/doc_async.swift

@@ -0,0 +1,56 @@
+// RUN: %empty-directory(%t.mod)
+// RUN: %swift -enable-experimental-concurrency -emit-module -o %t.mod/async.swiftmodule %s -parse-as-library -emit-module-doc-path %t.mod/async.swiftdoc
+// RUN: %sourcekitd-test -req=doc-info -module async -- -I %t.mod | %FileCheck %s
+
+// REQUIRES: concurrency
+
+public protocol AsyncProto {
+  func protoAsyncFunc() async
+  // CHECK: key.usr: "s:5async10AsyncProtoP05protoB4FuncyyYF"
+  // CHECK-NOT: }
+  // CHECK: key.is_async: 1
+  // CHECK: }
+  func protoNonAsyncFunc()
+  // CHECK: key.usr: "s:5async10AsyncProtoP08protoNonB4FuncyyF"
+  // CHECK-NOT: key.is_async: 1
+  // CHECK: }
+}
+
+public struct AsyncStruct: AsyncProto {
+  public func structAsyncFunc() async { }
+  // CHECK: key.usr: "s:5async11AsyncStructV06structB4FuncyyYF"
+  // CHECK-NOT: }
+  // CHECK: key.is_async: 1
+  // CHECK: }
+  public func structNonAsyncFunc() { }
+  // CHECK: key.usr: "s:5async11AsyncStructV09structNonB4FuncyyF"
+  // CHECK-NOT: key.is_async: 1
+  // CHECK: }
+
+  public func protoAsyncFunc() async { }
+  // CHECK: key.usr: "s:5async11AsyncStructV05protoB4FuncyyYF"
+  // CHECK-NOT: }
+  // CHECK: key.conforms
+  // CHECK: {
+  // CHECK: key.usr: "s:5async10AsyncProtoP05protoB4FuncyyYF"
+  // CHECK-NOT: }
+  // CHECK: key.is_async: 1
+  // CHECK: }
+  // CHECK: key.is_async: 1
+  // CHECK: }
+  public func protoNonAsyncFunc() { }
+  // CHECK: key.usr: "s:5async11AsyncStructV08protoNonB4FuncyyF"
+  // CHECK-NOT: key.is_async: 1
+  // CHECK: }
+}
+
+public func topLevelAsyncFunc() async { }
+// CHECK: key.usr: "s:5async17topLevelAsyncFuncyyYF"
+// CHECK-NOT: }
+// CHECK: key.is_async: 1
+// CHECK: }
+public func topLevelNonAsyncFunc() { }
+// CHECK: key.usr: "s:5async20topLevelNonAsyncFuncyyF"
+// CHECK-NOT: key.is_async: 1
+// CHECK: }
+

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

@@ -495,6 +495,7 @@ struct DocEntityInfo {
   bool IsUnavailable = false;
   bool IsDeprecated = false;
   bool IsOptional = false;
+  bool IsAsync = false;
   swift::Type Ty;
 };
 

tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp

@@ -426,6 +426,9 @@ static bool initDocEntityInfo(const Decl *D,
   Info.IsUnavailable = AvailableAttr::isUnavailable(D);
   Info.IsDeprecated = D->getAttrs().getDeprecated(D->getASTContext()) != nullptr;
   Info.IsOptional = D->getAttrs().hasAttribute<OptionalAttr>();
+  if (auto *AFD = dyn_cast<AbstractFunctionDecl>(D)) {
+    Info.IsAsync = AFD->hasAsync();
+  }
 
   if (!IsRef) {
     llvm::raw_svector_ostream OS(Info.DocComment);

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

@@ -1591,6 +1591,8 @@ void SKDocConsumer::addDocEntityInfoToDict(const DocEntityInfo &Info,
     Elem.set(KeyIsDeprecated, Info.IsDeprecated);
   if (Info.IsOptional)
     Elem.set(KeyIsOptional, Info.IsOptional);
+  if (Info.IsAsync)
+    Elem.set(KeyIsAsync, Info.IsAsync);
   if (!Info.DocComment.empty())
     Elem.set(KeyDocFullAsXML, Info.DocComment);
   if (!Info.FullyAnnotatedDecl.empty())

utils/gyb_sourcekit_support/UIDs.py

@@ -106,6 +106,7 @@ def __init__(self, internal_name, external_name):
     KEY('IsDeprecated', 'key.is_deprecated'),
     KEY('IsUnavailable', 'key.is_unavailable'),
     KEY('IsOptional', 'key.is_optional'),
+    KEY('IsAsync', 'key.is_async'),
     KEY('Message', 'key.message'),
     KEY('Introduced', 'key.introduced'),
     KEY('Deprecated', 'key.deprecated'),