[swift2objc] Support the async annotation (#1779)

liamappelbe · web-flow · commit 3210a7944880 · 2024-12-03T14:56:33.000-08:00
diff --git a/pkgs/swift2objc/lib/src/ast/_core/interfaces/can_async.dart b/pkgs/swift2objc/lib/src/ast/_core/interfaces/can_async.dart
@@ -0,0 +1,9 @@
+// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+/// An interface to describe a Swift entity's ability to be annotated
+/// with `async`.
+abstract interface class CanAsync {
+  abstract final bool async;
+}
diff --git a/pkgs/swift2objc/lib/src/ast/_core/interfaces/function_declaration.dart b/pkgs/swift2objc/lib/src/ast/_core/interfaces/function_declaration.dart
@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import '../shared/referred_type.dart';
+import 'can_async.dart';
 import 'can_throw.dart';
 import 'declaration.dart';
 import 'executable.dart';
@@ -16,6 +17,7 @@ abstract interface class FunctionDeclaration
         Parameterizable,
         Executable,
         TypeParameterizable,
-        CanThrow {
+        CanThrow,
+        CanAsync {
   abstract final ReferredType returnType;
 }
diff --git a/pkgs/swift2objc/lib/src/ast/_core/interfaces/variable_declaration.dart b/pkgs/swift2objc/lib/src/ast/_core/interfaces/variable_declaration.dart
@@ -3,15 +3,17 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import '../shared/referred_type.dart';
+import 'can_async.dart';
 import 'can_throw.dart';
 import 'declaration.dart';
 
 /// Describes a variable-like entity.
 ///
-/// This declaration [CanThrow] because Swift variables can have explicit
-/// getters, which can be marked with `throws`. Such variables may not have a
-/// setter.
-abstract interface class VariableDeclaration implements Declaration, CanThrow {
+/// This declaration implements [CanThrow] and [CanAsync] because Swift
+/// variables can have explicit getters, which can be marked with `throws` and
+/// `async`. Such variables may not have a setter.
+abstract interface class VariableDeclaration
+    implements Declaration, CanThrow, CanAsync {
   abstract final bool isConstant;
   abstract final ReferredType type;
 }
diff --git a/pkgs/swift2objc/lib/src/ast/declarations/compounds/members/initializer_declaration.dart b/pkgs/swift2objc/lib/src/ast/declarations/compounds/members/initializer_declaration.dart
@@ -2,6 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import '../../../_core/interfaces/can_async.dart';
 import '../../../_core/interfaces/can_throw.dart';
 import '../../../_core/interfaces/declaration.dart';
 import '../../../_core/interfaces/executable.dart';
@@ -18,7 +19,8 @@ class InitializerDeclaration
         Parameterizable,
         ObjCAnnotatable,
         Overridable,
-        CanThrow {
+        CanThrow,
+        CanAsync {
   @override
   String id;
 
@@ -34,6 +36,9 @@ class InitializerDeclaration
   @override
   bool throws;
 
+  @override
+  bool async;
+
   bool isFailable;
 
   @override
@@ -54,6 +59,7 @@ class InitializerDeclaration
     required this.hasObjCAnnotation,
     required this.isOverriding,
     required this.throws,
+    required this.async,
     required this.isFailable,
   });
 }
diff --git a/pkgs/swift2objc/lib/src/ast/declarations/compounds/members/method_declaration.dart b/pkgs/swift2objc/lib/src/ast/declarations/compounds/members/method_declaration.dart
@@ -33,6 +33,9 @@ class MethodDeclaration
   @override
   bool throws;
 
+  @override
+  bool async;
+
   @override
   List<String> statements;
 
@@ -57,5 +60,6 @@ class MethodDeclaration
     this.isStatic = false,
     this.isOverriding = false,
     this.throws = false,
+    this.async = false,
   }) : assert(!isStatic || !isOverriding);
 }
diff --git a/pkgs/swift2objc/lib/src/ast/declarations/compounds/members/property_declaration.dart b/pkgs/swift2objc/lib/src/ast/declarations/compounds/members/property_declaration.dart
@@ -28,6 +28,9 @@ class PropertyDeclaration implements VariableDeclaration, ObjCAnnotatable {
   @override
   bool throws;
 
+  @override
+  bool async;
+
   bool hasSetter;
 
   PropertyStatements? getter;
@@ -46,6 +49,7 @@ class PropertyDeclaration implements VariableDeclaration, ObjCAnnotatable {
     this.setter,
     this.isStatic = false,
     this.throws = false,
+    this.async = false,
   })  : assert(!(isConstant && hasSetter)),
         assert(!(hasSetter && throws));
 }
diff --git a/pkgs/swift2objc/lib/src/ast/declarations/globals/globals.dart b/pkgs/swift2objc/lib/src/ast/declarations/globals/globals.dart
@@ -36,6 +36,9 @@ class GlobalFunctionDeclaration implements FunctionDeclaration {
   @override
   bool throws;
 
+  @override
+  bool async;
+
   @override
   ReferredType returnType;
 
@@ -50,6 +53,7 @@ class GlobalFunctionDeclaration implements FunctionDeclaration {
     this.typeParams = const [],
     this.statements = const [],
     this.throws = false,
+    this.async = false,
   });
 }
 
@@ -70,11 +74,15 @@ class GlobalVariableDeclaration implements VariableDeclaration {
   @override
   bool throws;
 
+  @override
+  bool async;
+
   GlobalVariableDeclaration({
     required this.id,
     required this.name,
     required this.type,
     required this.isConstant,
     required this.throws,
+    required this.async,
   }) : assert(!(throws && !isConstant));
 }
diff --git a/pkgs/swift2objc/lib/src/generator/_core/utils.dart b/pkgs/swift2objc/lib/src/generator/_core/utils.dart
@@ -1,5 +1,8 @@
 import 'dart:io';
 import 'package:path/path.dart' as path;
+import '../../ast/_core/interfaces/can_async.dart';
+import '../../ast/_core/interfaces/can_throw.dart';
+import '../../ast/_core/interfaces/declaration.dart';
 import '../../ast/_core/shared/parameter.dart';
 
 String generateParameters(List<Parameter> params) {
@@ -34,3 +37,14 @@ void outputNextToFile({
 
   File(outputPath).writeAsStringSync(content);
 }
+
+String generateAnnotations(Declaration decl) {
+  final annotations = StringBuffer();
+  if (decl is CanAsync && (decl as CanAsync).async) {
+    annotations.write('async ');
+  }
+  if (decl is CanThrow && (decl as CanThrow).throws) {
+    annotations.write('throws ');
+  }
+  return annotations.toString();
+}
diff --git a/pkgs/swift2objc/lib/src/generator/generators/class_generator.dart b/pkgs/swift2objc/lib/src/generator/generators/class_generator.dart
@@ -87,12 +87,8 @@ List<String> _generateInitializer(InitializerDeclaration initializer) {
 
   header.write('(${generateParameters(initializer.params)})');
 
-  if (initializer.throws) {
-    header.write(' throws');
-  }
-
   return [
-    '$header {',
+    '$header ${generateAnnotations(initializer)}{',
     ...initializer.statements.indent(),
     '}\n',
   ];
@@ -117,19 +113,17 @@ List<String> _generateClassMethod(MethodDeclaration method) {
   }
 
   header.write(
-    'public func ${method.name}(${generateParameters(method.params)})',
+    'public func ${method.name}(${generateParameters(method.params)}) ',
   );
 
-  if (method.throws) {
-    header.write(' throws');
-  }
+  header.write(generateAnnotations(method));
 
   if (!method.returnType.sameAs(voidType)) {
-    header.write(' -> ${method.returnType.swiftType}');
+    header.write('-> ${method.returnType.swiftType} ');
   }
 
   return [
-    '$header {',
+    '$header{',
     ...method.statements.indent(),
     '}\n',
   ];
@@ -154,7 +148,7 @@ List<String> _generateClassProperty(PropertyDeclaration property) {
   header.write('public var ${property.name}: ${property.type.swiftType} {');
 
   final getterLines = [
-    'get {',
+    'get ${generateAnnotations(property)}{',
     ...(property.getter?.statements.indent() ?? <String>[]),
     '}'
   ];
diff --git a/pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_function_declaration.dart b/pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_function_declaration.dart
@@ -24,6 +24,7 @@ GlobalFunctionDeclaration parseGlobalFunctionDeclaration(
     returnType: _parseFunctionReturnType(globalFunctionSymbolJson, symbolgraph),
     params: info.params,
     throws: info.throws,
+    async: info.async,
   );
 }
 
@@ -42,12 +43,14 @@ MethodDeclaration parseMethodDeclaration(
     hasObjCAnnotation: parseSymbolHasObjcAnnotation(methodSymbolJson),
     isStatic: isStatic,
     throws: info.throws,
+    async: info.async,
   );
 }
 
 typedef ParsedFunctionInfo = ({
   List<Parameter> params,
   bool throws,
+  bool async,
 });
 
 ParsedFunctionInfo parseFunctionInfo(
@@ -120,17 +123,22 @@ ParsedFunctionInfo parseFunctionInfo(
     }
   }
 
-  // Parse annotations until we run out.
+  // Parse annotations until we run out. The annotations are keywords separated
+  // by whitespace tokens.
   final annotations = <String>{};
   while (true) {
     final keyword = maybeConsume('keyword');
-    if (keyword == null) break;
-    annotations.add(keyword);
+    if (keyword == null) {
+      if (maybeConsume('text') != '') break;
+    } else {
+      annotations.add(keyword);
+    }
   }
 
   return (
     params: parameters,
     throws: annotations.contains('throws'),
+    async: annotations.contains('async'),
   );
 }
 
diff --git a/pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_initializer_declaration.dart b/pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_initializer_declaration.dart
@@ -20,13 +20,22 @@ InitializerDeclaration parseInitializerDeclaration(
   }
 
   final info = parseFunctionInfo(declarationFragments, symbolgraph);
+
+  if (info.async) {
+    // TODO(https://github.com/dart-lang/native/issues/1778): Support async
+    // initializerse.
+    throw Exception("Async initializers aren't supported yet, at "
+        '${initializerSymbolJson.path}');
+  }
+
   return InitializerDeclaration(
     id: id,
     params: info.params,
     hasObjCAnnotation: parseSymbolHasObjcAnnotation(initializerSymbolJson),
     isOverriding: parseIsOverriding(initializerSymbolJson),
     isFailable: parseIsFailableInit(id, declarationFragments),
     throws: info.throws,
+    async: info.async,
   );
 }
 
diff --git a/pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_variable_declaration.dart b/pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_variable_declaration.dart
@@ -25,6 +25,7 @@ PropertyDeclaration parsePropertyDeclaration(
     hasSetter: isConstant ? false : _parsePropertyHasSetter(propertySymbolJson),
     isStatic: isStatic,
     throws: _parseVariableThrows(propertySymbolJson),
+    async: _parseVariableAsync(propertySymbolJson),
   );
 }
 
@@ -41,6 +42,7 @@ GlobalVariableDeclaration parseGlobalVariableDeclaration(
     type: _parseVariableType(variableSymbolJson, symbolgraph),
     isConstant: isConstant || !hasSetter,
     throws: _parseVariableThrows(variableSymbolJson),
+    async: _parseVariableAsync(variableSymbolJson),
   );
 }
 
@@ -78,6 +80,17 @@ bool _parseVariableThrows(Json json) {
   return throws;
 }
 
+bool _parseVariableAsync(Json json) {
+  final async = json['declarationFragments']
+      .any((frag) => matchFragment(frag, 'keyword', 'async'));
+  if (async) {
+    // TODO(https://github.com/dart-lang/native/issues/1778): Support async
+    // getters.
+    throw Exception("Async getters aren't supported yet, at ${json.path}");
+  }
+  return async;
+}
+
 bool _parsePropertyHasSetter(Json propertySymbolJson) {
   final fragmentsJson = propertySymbolJson['declarationFragments'];
 
diff --git a/pkgs/swift2objc/lib/src/transformer/transformers/transform_compound.dart b/pkgs/swift2objc/lib/src/transformer/transformers/transform_compound.dart
@@ -101,6 +101,7 @@ InitializerDeclaration _buildWrapperInitializer(
     isOverriding: false,
     isFailable: false,
     throws: false,
+    async: false,
     statements: ['self.${wrappedClassInstance.name} = wrappedInstance'],
     hasObjCAnnotation: wrappedClassInstance.hasObjCAnnotation,
   );
diff --git a/pkgs/swift2objc/lib/src/transformer/transformers/transform_function.dart b/pkgs/swift2objc/lib/src/transformer/transformers/transform_function.dart
@@ -100,6 +100,7 @@ MethodDeclaration _transformFunction(
         ? originalFunction.isStatic
         : true,
     throws: originalFunction.throws,
+    async: originalFunction.async,
   );
 
   transformedMethod.statements = _generateStatements(
@@ -150,6 +151,9 @@ List<String> _generateStatements(
   final arguments = generateInvocationParams(
       localNamer, originalFunction.params, transformedMethod.params);
   var originalMethodCall = originalCallGenerator(arguments);
+  if (transformedMethod.async) {
+    originalMethodCall = 'await $originalMethodCall';
+  }
   if (transformedMethod.throws) {
     originalMethodCall = 'try $originalMethodCall';
   }
diff --git a/pkgs/swift2objc/lib/src/transformer/transformers/transform_initializer.dart b/pkgs/swift2objc/lib/src/transformer/transformers/transform_initializer.dart
@@ -36,6 +36,7 @@ InitializerDeclaration transformInitializer(
       hasObjCAnnotation: true,
       isFailable: originalInitializer.isFailable,
       throws: originalInitializer.throws,
+      async: originalInitializer.async,
       // Because the wrapper class extends NSObject that has an initializer with
       // no parameters. If we make a similar parameterless initializer we need
       // to add `override` keyword.
@@ -60,6 +61,9 @@ List<String> _generateInitializerStatements(
       localNamer, originalInitializer.params, transformedInitializer.params);
   var instanceConstruction =
       '${wrappedClassInstance.type.swiftType}($arguments)';
+  if (transformedInitializer.async) {
+    instanceConstruction = 'await $instanceConstruction';
+  }
   if (transformedInitializer.throws) {
     instanceConstruction = 'try $instanceConstruction';
   }
diff --git a/pkgs/swift2objc/lib/src/transformer/transformers/transform_variable.dart b/pkgs/swift2objc/lib/src/transformer/transformers/transform_variable.dart
@@ -82,6 +82,7 @@ PropertyDeclaration _transformVariable(
         : true,
     isConstant: originalVariable.isConstant,
     throws: originalVariable.throws,
+    async: originalVariable.async,
   );
 
   final getterStatements = _generateGetterStatements(
diff --git a/pkgs/swift2objc/test/integration/async_input.swift b/pkgs/swift2objc/test/integration/async_input.swift
@@ -0,0 +1,12 @@
+import Foundation
+
+public class MyClass {
+  public func voidMethod() async {}
+  public func intMethod(y: Int) async -> MyClass { return MyClass() }
+  public func asyncThrowsMethod(y: Int) async throws -> MyClass {
+    return MyClass()
+  }
+}
+
+public func voidFunc(x: Int, y: Int) async {}
+public func intFunc() async -> MyClass { return MyClass() }
diff --git a/pkgs/swift2objc/test/integration/async_output.swift b/pkgs/swift2objc/test/integration/async_output.swift
diff --git a/pkgs/swift2objc/test/unit/parse_function_info_test.dart b/pkgs/swift2objc/test/unit/parse_function_info_test.dart
