pigeon

Adds support for modern async method styles in swift and kotlin. This is now the default. Also adds a new annotation AsyncCallback that reverts to the old style.

precursor to #11352

• Breaking Change Updates Kotlin and Swift generators to generate suspend functions and async throws signatures for @FlutterApi methods by default, and for @HostApi methods annotated with @async.
  • Use @asyncCallback if callback-style signatures are required.

Part of fixing flutter/flutter#183945.

Regenerating pigeon files will fix issue.

Pre-Review Checklist

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

• [dart] Fixes lint warning from unused codec variable in Dart proxy classes.

• Updates analyzer dependency to support versions 13 and 14.
• Updates minimum Dart SDK constraint to 3.11.0.

• Adds support for sharing constants across platforms.

• Adds support for empty data classes.

• Reports a clear error when an input file uses an enhanced enum (one with a constructor, fields, methods, or arguments on its values), instead of silently generating incorrect output.

• [dart] Adds usage documentation to generated event channel methods, and emits the user's documentation comments on them.

• [swift] Adds CaseIterable conformance to generated enums.

• Breaking Change Overrides toString (or equivalent) methods on generated data classes
  • This can conflict with custom description implementations in Swift.
• [swift] Updates isNullish to handle double nested Any? values.
• Updates minimum supported SDK version to Flutter 3.38/Dart 3.10.

• [kotlin] Updates generated error class to inherit from RuntimeException instead of Throwable, for better Java interoperability.

• Updates analyzer dependency to support versions 10 through 12.

• Updates analyzer dependency to support version 10.

• Fixes dartdoc comments that accidentally used HTML.

• Optimizes and improves data class equality and hashing.
• Changes hashing and equality methods to behave consistently across platforms.
• Adds equality methods to previously unsupported languages.

• Produces a helpful error message when a method return type is missing or an unsupported type, such as a function type or record type.

• [dart] Improves nullability-handling in generated code.

• [kotlin] Adds option to add javax.annotation.Generated annotation.

• Dramatically reduces the number of File write operations sent to the operating system during code-generation. This improves performance of IDEs and the Dart analysis server.

• [dart] Reduces much duplication in reply-handling code.

• Makes some internal class constructors constant.

• [objc] Updates to use module imports.

• [kotlin] Fixes a "bridge method" warning when implementing an event stream handler.

• [swift][kotlin] Fixes crash that occurs when an object that is removed from the instance manager calls to Dart.

• [dart] Fixes error from constructor parameter sharing name with attached field for a ProxyApi.
• Updates minimum supported SDK version to Flutter 3.35/Dart 3.9.

• [kotlin] Fixes compilation error with unbounded type parameter for InstanceManager.

• Updates supported analyzer versions to 8.x or 9.x.
• Updates minimum supported SDK version to Flutter 3.32/Dart 3.8.

• Deprecates dartHostTestHandler and dartTestOut.
  • If you have a use case where this cannot easily be replaced with a mock or fake of the generated Dart API, please provide details in https://github.com/flutter/flutter/issues/178322.

• [kotlin] Serialize custom enums as Long instead of Int to avoid ClassCastException on decoding.

• Adds compatibility with analyzer 8.x.

• [kotlin] Removes all containsKey and replaces with contains.

• [kotlin] Fixes support for classes that override equals and hashCode for ProxyApis.
• [kotlin] Adds error message log when a new Dart proxy instance fails to be created.
• Updates minimum supported SDK version to Flutter 3.29/Dart 3.7.

• Improves documentation of ProxyApi annotation and internal Dart ProxyAPI helper functions.
• Moves helper functions for generating Dart portion of ProxyAPIs.

• Breaking Change [dart] Changes name of constructors used to create subclasses of ProxyApis to pigeon_**original_name**.
• [dart] Adds ProxyApi overrides classes to be used in Flutter unit tests.

• [dart] Changes the default InstanceManager and its initialization to no longer make a message call when used in a Flutter unit test.

• [gobject] Adds type id constants in header files so that they can be used by the user.
• Updates minimum supported SDK version to Flutter 3.27/Dart 3.6.

• [dart] Fixes null pointer crashes/exceptions caused by premature finalization of Dart instances for ProxyApis.

• [kotlin] Fixes Kotlin InstanceManager not properly removing callbacks from handler.
• [kotlin] Fixes SyntheticAccessor lint caused by private utility methods.

• [swift] Adds equality methods to generated data classes.
• [dart, kotlin] Shortens equality methods.

• [kotlin] Adds equality methods to generated data classes.

• [dart] Adds equality methods to generated data classes.

• Breaking Change Removes oneLanguage field from PigeonOptions.
• Separates internal options classes from user facing options.
• Adds mergeDefinitionFileOptions parameter to runWithOptions method.
• Relocates injectOverflowTypes to non-public facing method.

• Updates compileSdk 34 to flutter.compileSdkVersion.

• [dart] Fixes potential race condition caused by a ProxyApi constructor message call being made in an async method.

• Adjusts task queues to use a shared task queue for all methods in a single API instance, to give the same ordering guarantees as non-task-queue usage.
• [swift] Adds task queue support to the Swift generator.

• [swift, kotlin] Adds an error message when a ProxyAPI callback method that returns a non-null value is nullable.
• [swift, kotlin] Adds an error message in the ProxyApiBaseCodec when an instance could not be retrieved when reading a value.
• [swift, kotlin] Fixes ProxyAPI platform APIs not calling completion when creating a new instance.

• [kotlin, swift] Adds annotation options to omit shared classes used in Event Channels.

• Breaking Change Relocates some files in lib that were not intended for direct client use to lib/src.

• Breaking Change [swift] Fixes a compile error about PigeonError's sendability conformance in Swift 6.
  • PigeonError's init now requires the "details" argument to be Sendable.

• [dart] Fixes bug with multi-instance event channel support.

• Adds compatibility with analyzer 7.x.*.

• Updates README to discuss best practices for using Pigeon-generated code.

• [swift] Adds support for platform checks of imports of ProxyApis.
• Updates minimum supported SDK version to Flutter 3.22/Dart 3.4.

• [swift, kotlin] Adds event channel support.
• [swift, kotlin] Adds sealed class inheritance support.
• [swift] Updates codec class names to be upper camel case.

• [swift] Fixes the channel names of the named constructors of ProxyApis.

• Replaces deprecated collection method usage.

• Removes the @protected annotation from the InstanceManager field of the PigeonInternalProxyApiBaseClass.

• [gobject] Moves class declarations to the header to work around a bug in some versions of glib.

• [swift] Adds includeErrorClass to SwiftOptions.

• [swift] Adds implementation for @ProxyApi.

• Updates README.md to replace the deprecated flutter pub run pigeon command with dart run pigeon.