Add FFI and JNI support to Swift and Kotlin

analysis_options.yaml

@@ -20,6 +20,8 @@ analyzer:
     # Ignore generated files
     - '**/*.pb.dart'
     - '**/*.g.dart'
+    - '**/*.gen.jni.dart'
+    - '**/*.gen.ffi.dart'
     - '**/*.mocks.dart' # Mockito @GenerateMocks
 
 linter:

packages/pigeon/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 26.4.0
+
+* [swift] [kotlin] Adds support for FFI and JNI.
+* Exposes missing PigeonOptions and language-specific configurations as command-line arguments.
+
 ## 26.3.4
 
 * [kotlin] Updates generated error class to inherit from `RuntimeException`

packages/pigeon/README.md

@@ -82,6 +82,12 @@ the threading model for handling HostApi methods can be selected with the
 Host and Flutter APIs now support the ability to provide a unique message channel suffix string
 to the api to allow for multiple instances to be created and operate in parallel.
 
+### Native Interop (FFI & JNI)
+
+Pigeon supports generating Native Interop bindings using FFI (for Swift) and JNI (for Kotlin) as an alternative to standard MethodChannels. This allows for direct communication with lower overhead.
+
+For detailed information on setup, prerequisites, and instructions on how to use Native Interop, see the [Native Interop Guide](./native_interop_guide.md).
+
 ## Usage
 
 1) Add pigeon as a `dev_dependency`.

packages/pigeon/example/app/android/app/src/main/kotlin/dev/flutter/pigeon_example_app/NativeInteropExample.kt

@@ -0,0 +1,11 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package dev.flutter.pigeon_example_app
+
+// #docregion concurrency-style
+suspend fun echoAsync(value: String): String {
+  return value
+}
+// #enddocregion concurrency-style

packages/pigeon/example/app/ios/Runner/EventChannelMessages.g.swift

@@ -15,7 +15,15 @@ import Foundation
 #endif
 
 private func isNullish(_ value: Any?) -> Bool {
-  return value is NSNull || value == nil
+  guard let innerValue = value else {
+    return true
+  }
+
+  if case Optional<Any>.some(Optional<Any>.none) = value {
+    return true
+  }
+
+  return innerValue is NSNull
 }
 
 private func nilOrValue<T>(_ value: Any?) -> T? {

packages/pigeon/example/app/ios/Runner/Messages.g.swift

@@ -65,7 +65,15 @@ private func createConnectionError(withChannelName channelName: String) -> Pigeo
 }
 
 private func isNullish(_ value: Any?) -> Bool {
-  return value is NSNull || value == nil
+  guard let innerValue = value else {
+    return true
+  }
+
+  if case Optional<Any>.some(Optional<Any>.none) = value {
+    return true
+  }
+
+  return innerValue is NSNull
 }
 
 private func nilOrValue<T>(_ value: Any?) -> T? {
@@ -349,6 +357,7 @@ class ExampleHostApiSetup {
     }
   }
 }
+
 /// Generated protocol from Pigeon that represents Flutter messages that can be called from Swift.
 protocol MessageFlutterApiProtocol {
   func flutterMethod(

packages/pigeon/example/app/ios/Runner/NativeInteropExample.swift

@@ -0,0 +1,17 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import Foundation
+
+// #docregion callback-style
+func echoAsync(_ value: String, completion: @escaping (Result<String, Error>) -> Void) {
+  completion(.success(value))
+}
+// #enddocregion callback-style
+
+// #docregion concurrency-style
+func echoAsync(_ value: String) async throws -> String {
+  return value
+}
+// #enddocregion concurrency-style

packages/pigeon/example/app/lib/src/event_channel_messages.g.dart

@@ -110,6 +110,11 @@ class IntEvent extends PlatformEvent {
   @override
   // ignore: avoid_equals_and_hash_code_on_mutable_classes
   int get hashCode => _deepHash(<Object?>[runtimeType, ..._toList()]);
+
+  @override
+  String toString() {
+    return _toList().toString();
+  }
 }
 
 class StringEvent extends PlatformEvent {
@@ -145,6 +150,11 @@ class StringEvent extends PlatformEvent {
   @override
   // ignore: avoid_equals_and_hash_code_on_mutable_classes
   int get hashCode => _deepHash(<Object?>[runtimeType, ..._toList()]);
+
+  @override
+  String toString() {
+    return _toList().toString();
+  }
 }
 
 class _PigeonCodec extends StandardMessageCodec {

packages/pigeon/example/app/lib/src/messages.g.dart

@@ -168,6 +168,11 @@ class MessageData {
   @override
   // ignore: avoid_equals_and_hash_code_on_mutable_classes
   int get hashCode => _deepHash(<Object?>[runtimeType, ..._toList()]);
+
+  @override
+  String toString() {
+    return _toList().toString();
+  }
 }
 
 class _PigeonCodec extends StandardMessageCodec {
@@ -203,8 +208,8 @@ class _PigeonCodec extends StandardMessageCodec {
 }
 
 class ExampleHostApi {
-  /// Constructor for [ExampleHostApi].  The [binaryMessenger] named argument is
-  /// available for dependency injection.  If it is left null, the default
+  /// Constructor for [ExampleHostApi]. The [binaryMessenger] named argument is
+  /// available for dependency injection. If it is left null, the default
   /// BinaryMessenger will be used which routes to the host platform.
   ExampleHostApi({
     BinaryMessenger? binaryMessenger,
@@ -213,8 +218,8 @@ class ExampleHostApi {
        pigeonVar_messageChannelSuffix = messageChannelSuffix.isNotEmpty
            ? '.$messageChannelSuffix'
            : '';
-  final BinaryMessenger? pigeonVar_binaryMessenger;
 
+  final BinaryMessenger? pigeonVar_binaryMessenger;
   static const MessageCodec<Object?> pigeonChannelCodec = _PigeonCodec();
 
   final String pigeonVar_messageChannelSuffix;

packages/pigeon/example/app/pigeons/native_interop_example.dart

@@ -0,0 +1,19 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:pigeon/pigeon.dart';
+
+// #docregion config
+@ConfigurePigeon(
+  PigeonOptions(
+    dartOptions: DartOptions(),
+    kotlinOptions: KotlinOptions(useJni: true),
+    swiftOptions: SwiftOptions(useFfi: true, ffiModuleName: 'my_plugin'),
+  ),
+)
+// #enddocregion config
+@HostApi()
+abstract class NativeInteropExampleApi {
+  void doSomething();
+}

packages/pigeon/lib/src/ast.dart

@@ -526,6 +526,27 @@ class TypeDeclaration {
   /// Associated [AstProxyApi], if any.
   final AstProxyApi? associatedProxyApi;
 
+  /// Returns the full annotated name of the type.
+  String getFullName({bool withNullable = true}) {
+    return '$baseName$typeArgumentsString${isNullable && withNullable ? '?' : ''}';
+  }
+
+  /// Returns the Type Arguments in annotation form.
+  String get typeArgumentsString {
+    var typeArgumentString = '<';
+    if (baseName == 'List') {
+      typeArgumentString +=
+          typeArguments.firstOrNull?.getFullName() ?? 'Object?';
+    } else if (baseName == 'Map') {
+      typeArgumentString +=
+          '${typeArguments.firstOrNull?.getFullName() ?? 'Object?'}, ${typeArguments.lastOrNull?.getFullName() ?? 'Object?'}';
+    } else {
+      return '';
+    }
+    typeArgumentString += '>';
+    return typeArgumentString;
+  }
+
   @override
   int get hashCode {
     // This has to be implemented because TypeDeclaration is used as a Key to a
@@ -834,6 +855,8 @@ class Root extends Node {
     required this.classes,
     required this.apis,
     required this.enums,
+    this.lists = const <String, TypeDeclaration>{},
+    this.maps = const <String, TypeDeclaration>{},
     this.containsHostApi = false,
     this.containsFlutterApi = false,
     this.containsProxyApi = false,
@@ -842,7 +865,13 @@ class Root extends Node {
 
   /// Factory function for generating an empty root, usually used when early errors are encountered.
   factory Root.makeEmpty() {
-    return Root(apis: <Api>[], classes: <Class>[], enums: <Enum>[]);
+    return Root(
+      apis: <Api>[],
+      classes: <Class>[],
+      enums: <Enum>[],
+      lists: <String, TypeDeclaration>{},
+      maps: <String, TypeDeclaration>{},
+    );
   }
 
   /// All the classes contained in the AST.
@@ -854,6 +883,12 @@ class Root extends Node {
   /// All of the enums contained in the AST.
   List<Enum> enums;
 
+  /// All of the lists contained in the AST.
+  Map<String, TypeDeclaration> lists;
+
+  /// All of the maps contained in the AST.
+  Map<String, TypeDeclaration> maps;
+
   /// Whether the root has any Host API definitions.
   bool containsHostApi;
 
@@ -876,6 +911,6 @@ class Root extends Node {
 
   @override
   String toString() {
-    return '(Root classes:$classes apis:$apis enums:$enums)';
+    return '(Root classes:$classes apis:$apis enums:$enums lists:$lists maps:$maps containsHostApi:$containsHostApi containsFlutterApi:$containsFlutterApi containsProxyApi:$containsProxyApi)';
   }
 }

packages/pigeon/lib/src/cpp/cpp_generator.dart

@@ -98,7 +98,7 @@ class CppOptions {
   /// Overrides any non-null parameters from [options] into this to make a new
   /// [CppOptions].
   CppOptions merge(CppOptions options) {
-    return CppOptions.fromMap(mergeMaps(toMap(), options.toMap()));
+    return CppOptions.fromMap(mergePigeonMaps(toMap(), options.toMap()));
   }
 }