[SourceKit] Introduce "source.lang.swift.expr.closure" in structure (SR-6116) (#13617)

Author: marcelofabri

include/swift/IDE/SyntaxModel.h

@@ -111,7 +111,8 @@ enum class SyntaxStructureKind : uint8_t {
   ArrayExpression,
   DictionaryExpression,
   ObjectLiteralExpression,
-  TupleExpression
+  TupleExpression,
+  ClosureExpression
 };
 
 enum class SyntaxStructureElementKind : uint8_t {

lib/IDE/SyntaxModel.cpp

@@ -526,6 +526,16 @@ std::pair<bool, Expr *> ModelASTWalker::walkToExprPre(Expr *E) {
 
       pushStructureNode(SN, Tup);
     }
+  } else if (auto *Closure = dyn_cast<ClosureExpr>(E)) {
+    SyntaxStructureNode SN;
+    SN.Kind = SyntaxStructureKind::ClosureExpression;
+    SN.Range = charSourceRangeFromSourceRange(SM, E->getSourceRange());
+    SN.BodyRange = innerCharSourceRangeFromSourceRange(SM, E->getSourceRange());
+    if (Closure->hasExplicitResultType())
+      SN.TypeRange = charSourceRangeFromSourceRange(SM,
+                          Closure->getExplicitResultTypeLoc().getSourceRange());
+
+    pushStructureNode(SN, Closure);
   }
 
   return { true, E };

test/IDE/structure.swift

@@ -119,8 +119,8 @@ func <#test1#> () {
 let myArray = [<#item1#>, <#item2#>]
 
 // CHECK: <ffunc>func <name>test1()</name> {
-// CHECK:   <call><name>dispatch_async</name>(<arg><call><name>dispatch_get_main_queue</name>()</call></arg>, <arg><brace>{}</brace></arg>)</call>
-// CHECK:   <call><name>dispatch_async</name>(<arg><call><name>dispatch_get_main_queue</name>()</call></arg>) <arg><brace>{}</brace></arg></call>
+// CHECK:   <call><name>dispatch_async</name>(<arg><call><name>dispatch_get_main_queue</name>()</call></arg>, <arg><closure><brace>{}</brace></closure></arg>)</call>
+// CHECK:   <call><name>dispatch_async</name>(<arg><call><name>dispatch_get_main_queue</name>()</call></arg>) <arg><closure><brace>{}</brace></closure></arg></call>
 // CHECK: }</ffunc>
 func test1() {
   dispatch_async(dispatch_get_main_queue(), {})
@@ -149,8 +149,8 @@ enum Rawness : Int {
   case Two = 2, Three = 3
 }
 
-// CHECK: <ffunc>func <name>rethrowFunc(<param>_ f: <type>() throws -> ()</type></param>)</name> rethrows {}</ffunc>
-func rethrowFunc(_ f: () throws -> ()) rethrows {}
+// CHECK: <ffunc>func <name>rethrowFunc(<param>_ f: <type>() throws -> ()</type> = <closure><brace>{}</brace></closure></param>)</name> rethrows {}</ffunc>
+func rethrowFunc(_ f: () throws -> () = {}) rethrows {}
 
 class NestedPoundIf{
     func foo1() {
@@ -179,7 +179,7 @@ class NestedPoundIf{
 class A {
   func foo(_ i : Int, animations: () -> ()) {}
   func perform() {foo(5, animations: {})}
-// CHECK:  <ifunc>func <name>perform()</name> {<call><name>foo</name>(<arg>5</arg>, <arg><name>animations</name>: <brace>{}</brace></arg>)</call>}</ifunc>
+// CHECK:  <ifunc>func <name>perform()</name> {<call><name>foo</name>(<arg>5</arg>, <arg><name>animations</name>: <closure><brace>{}</brace></closure></arg>)</call>}</ifunc>
 }
 
 // CHECK: <typealias>typealias <name>OtherA</name> = A</typealias>
@@ -250,3 +250,9 @@ struct Tuples {
   }
 }
 
+completion(a: 1) { (x: Int, y: Int) -> Int in
+  return x + y
+}
+// CHECK: <call><name>completion</name>(<arg><name>a</name>: 1</arg>) <arg><closure>{ (<param>x: <type>Int</type></param>, <param>y: <type>Int</type></param>) -> <type>Int</type> in
+// CHECK:    return x + y
+// CHECK: }</closure></arg></call>

test/SourceKit/DocumentStructure/structure.swift.invalid.response

@@ -38,7 +38,7 @@
       ]
     },
     {
-      key.kind: source.lang.swift.stmt.brace,
+      key.kind: source.lang.swift.expr.closure,
       key.offset: 57,
       key.length: 24,
       key.nameoffset: 0,
@@ -47,15 +47,26 @@
       key.bodylength: 22,
       key.substructure: [
         {
-          key.kind: source.lang.swift.decl.class,
-          key.accessibility: source.lang.swift.accessibility.private,
-          key.name: "MyCoolClass",
-          key.offset: 59,
-          key.length: 22,
-          key.nameoffset: 65,
-          key.namelength: 11,
-          key.bodyoffset: 78,
-          key.bodylength: 2
+          key.kind: source.lang.swift.stmt.brace,
+          key.offset: 57,
+          key.length: 24,
+          key.nameoffset: 0,
+          key.namelength: 0,
+          key.bodyoffset: 58,
+          key.bodylength: 22,
+          key.substructure: [
+            {
+              key.kind: source.lang.swift.decl.class,
+              key.accessibility: source.lang.swift.accessibility.private,
+              key.name: "MyCoolClass",
+              key.offset: 59,
+              key.length: 22,
+              key.nameoffset: 65,
+              key.namelength: 11,
+              key.bodyoffset: 78,
+              key.bodylength: 2
+            }
+          ]
         }
       ]
     }

tools/SourceKit/include/SourceKit/Core/ProtocolUIDs.def

@@ -273,6 +273,7 @@ KIND(ExprArray, "source.lang.swift.expr.array")
 KIND(ExprDictionary, "source.lang.swift.expr.dictionary")
 KIND(ExprObjectLiteral, "source.lang.swift.expr.object_literal")
 KIND(ExprTuple, "source.lang.swift.expr.tuple")
+KIND(ExprClosure, "source.lang.swift.expr.closure")
 KIND(StructureElemId, "source.lang.swift.structure.elem.id")
 KIND(StructureElemExpr, "source.lang.swift.structure.elem.expr")
 KIND(StructureElemInitExpr, "source.lang.swift.structure.elem.init_expr")

tools/SourceKit/lib/SwiftLang/SwiftLangSupport.cpp

@@ -423,6 +423,8 @@ UIdent SwiftLangSupport::getUIDForSyntaxStructureKind(
       return KindExprObjectLiteral;
     case SyntaxStructureKind::TupleExpression:
       return KindExprTuple;
+    case SyntaxStructureKind::ClosureExpression:
+      return KindExprClosure;
     case SyntaxStructureKind::Argument:
       return KindExprArg;
   }

tools/swift-ide-test/swift-ide-test.cpp

@@ -1106,6 +1106,7 @@ class StructureAnnotator : public ide::SyntaxModelWalker {
       case SyntaxStructureKind::ObjectLiteralExpression:
         return "object-literal-expression";
       case SyntaxStructureKind::TupleExpression: return "tuple";
+      case SyntaxStructureKind::ClosureExpression: return "closure";
     }
     llvm_unreachable("unhandled tag?");
   }