mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00
aa36db1d29
Support for FFI calls with `@Native external` functions through Native assets on MacOS and iOS. This enables bundling native code without any build-system boilerplate code. For more info see: * https://github.com/flutter/flutter/issues/129757 ### Implementation details for MacOS and iOS. Dylibs are bundled by (1) making them fat binaries if multiple architectures are targeted, (2) code signing these, and (3) copying them to the frameworks folder. These steps are done manual rather than via CocoaPods. CocoaPods would have done the same steps, but (a) needs the dylibs to be there before the `xcodebuild` invocation (we could trick it, by having a minimal dylib in the place and replace it during the build process, that works), and (b) can't deal with having no dylibs to be bundled (we'd have to bundle a dummy dylib or include some dummy C code in the build file). The dylibs are build as a new target inside flutter assemble, as that is the moment we know what build-mode and architecture to target. The mapping from asset id to dylib-path is passed in to every kernel compilation path. The interesting case is hot-restart where the initial kernel file is compiled by the "inner" flutter assemble, while after hot restart the "outer" flutter run compiled kernel file is pushed to the device. Both kernel files need to contain the mapping. The "inner" flutter assemble gets its mapping from the NativeAssets target which builds the native assets. The "outer" flutter run get its mapping from a dry-run invocation. Since this hot restart can be used for multiple target devices (`flutter run -d all`) it contains the mapping for all known targets. ### Example vs template The PR includes a new template that uses the new native assets in a package and has an app importing that. Separate discussion in: https://github.com/flutter/flutter/issues/131209. ### Tests This PR adds new tests to cover the various use cases. * dev/devicelab/bin/tasks/native_assets_ios.dart * Runs an example app with native assets in all build modes, doing hot reload and hot restart in debug mode. * dev/devicelab/bin/tasks/native_assets_ios_simulator.dart * Runs an example app with native assets, doing hot reload and hot restart. * packages/flutter_tools/test/integration.shard/native_assets_test.dart * Runs (incl hot reload/hot restart), builds, builds frameworks for iOS, MacOS and flutter-tester. * packages/flutter_tools/test/general.shard/build_system/targets/native_assets_test.dart * Unit tests the new Target in the backend. * packages/flutter_tools/test/general.shard/ios/native_assets_test.dart * packages/flutter_tools/test/general.shard/macos/native_assets_test.dart * Unit tests the native assets being packaged on a iOS/MacOS build. It also extends various existing tests: * dev/devicelab/bin/tasks/module_test_ios.dart * Exercises the add2app scenario. * packages/flutter_tools/test/general.shard/features_test.dart * Unit test the new feature flag.
150 lines
4.2 KiB
Cheetah
150 lines
4.2 KiB
Cheetah
name: {{projectName}}
|
|
description: {{description}}
|
|
version: 0.0.1
|
|
homepage:
|
|
|
|
environment:
|
|
sdk: {{dartSdkVersionBounds}}
|
|
flutter: '>=3.3.0'
|
|
|
|
dependencies:
|
|
flutter:
|
|
sdk: flutter
|
|
{{#web}}
|
|
flutter_web_plugins:
|
|
sdk: flutter
|
|
{{/web}}
|
|
plugin_platform_interface: ^2.0.2
|
|
|
|
dev_dependencies:
|
|
{{#withFfi}}
|
|
ffi: ^2.0.2
|
|
ffigen: ^9.0.0
|
|
{{/withFfi}}
|
|
flutter_test:
|
|
sdk: flutter
|
|
flutter_lints: ^2.0.0
|
|
|
|
# For information on the generic Dart part of this file, see the
|
|
# following page: https://dart.dev/tools/pub/pubspec
|
|
|
|
# The following section is specific to Flutter packages.
|
|
flutter:
|
|
# This section identifies this Flutter project as a plugin project.
|
|
# The 'pluginClass' specifies the class (in Java, Kotlin, Swift, Objective-C, etc.)
|
|
# which should be registered in the plugin registry. This is required for
|
|
# using method channels.
|
|
# The Android 'package' specifies package in which the registered class is.
|
|
# This is required for using method channels on Android.
|
|
# The 'ffiPlugin' specifies that native code should be built and bundled.
|
|
# This is required for using `dart:ffi`.
|
|
# All these are used by the tooling to maintain consistency when
|
|
# adding or updating assets for this project.
|
|
{{#withFfiPluginHook}}
|
|
#
|
|
# Please refer to README.md for a detailed explanation.
|
|
plugin:
|
|
platforms:
|
|
{{#no_platforms}}
|
|
# This FFI plugin project was generated without specifying any
|
|
# platforms with the `--platform` argument. If you see the `some_platform` map below, remove it and
|
|
# then add platforms following the instruction here:
|
|
# https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin-platforms
|
|
# -------------------
|
|
some_platform:
|
|
ffiPlugin: true
|
|
# -------------------
|
|
{{/no_platforms}}
|
|
{{#android}}
|
|
android:
|
|
ffiPlugin: true
|
|
{{/android}}
|
|
{{#ios}}
|
|
ios:
|
|
ffiPlugin: true
|
|
{{/ios}}
|
|
{{#linux}}
|
|
linux:
|
|
ffiPlugin: true
|
|
{{/linux}}
|
|
{{#macos}}
|
|
macos:
|
|
ffiPlugin: true
|
|
{{/macos}}
|
|
{{#windows}}
|
|
windows:
|
|
ffiPlugin: true
|
|
{{/windows}}
|
|
{{/withFfiPluginHook}}
|
|
{{#withPlatformChannelPluginHook}}
|
|
plugin:
|
|
platforms:
|
|
{{#no_platforms}}
|
|
# This plugin project was generated without specifying any
|
|
# platforms with the `--platform` argument. If you see the `some_platform` map below, remove it and
|
|
# then add platforms following the instruction here:
|
|
# https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin-platforms
|
|
# -------------------
|
|
some_platform:
|
|
pluginClass: somePluginClass
|
|
# -------------------
|
|
{{/no_platforms}}
|
|
{{#android}}
|
|
android:
|
|
package: {{androidIdentifier}}
|
|
pluginClass: {{pluginClass}}
|
|
{{/android}}
|
|
{{#ios}}
|
|
ios:
|
|
pluginClass: {{pluginClass}}
|
|
{{/ios}}
|
|
{{#linux}}
|
|
linux:
|
|
pluginClass: {{pluginClass}}
|
|
{{/linux}}
|
|
{{#macos}}
|
|
macos:
|
|
pluginClass: {{pluginClass}}
|
|
{{/macos}}
|
|
{{#windows}}
|
|
windows:
|
|
pluginClass: {{pluginClass}}CApi
|
|
{{/windows}}
|
|
{{#web}}
|
|
web:
|
|
pluginClass: {{pluginDartClass}}Web
|
|
fileName: {{projectName}}_web.dart
|
|
{{/web}}
|
|
{{/withPlatformChannelPluginHook}}
|
|
|
|
# To add assets to your plugin package, add an assets section, like this:
|
|
# assets:
|
|
# - images/a_dot_burr.jpeg
|
|
# - images/a_dot_ham.jpeg
|
|
#
|
|
# For details regarding assets in packages, see
|
|
# https://flutter.dev/assets-and-images/#from-packages
|
|
#
|
|
# An image asset can refer to one or more resolution-specific "variants", see
|
|
# https://flutter.dev/assets-and-images/#resolution-aware
|
|
|
|
# To add custom fonts to your plugin package, add a fonts section here,
|
|
# in this "flutter" section. Each entry in this list should have a
|
|
# "family" key with the font family name, and a "fonts" key with a
|
|
# list giving the asset and other descriptors for the font. For
|
|
# example:
|
|
# fonts:
|
|
# - family: Schyler
|
|
# fonts:
|
|
# - asset: fonts/Schyler-Regular.ttf
|
|
# - asset: fonts/Schyler-Italic.ttf
|
|
# style: italic
|
|
# - family: Trajan Pro
|
|
# fonts:
|
|
# - asset: fonts/TrajanPro.ttf
|
|
# - asset: fonts/TrajanPro_Bold.ttf
|
|
# weight: 700
|
|
#
|
|
# For details regarding fonts in packages, see
|
|
# https://flutter.dev/custom-fonts/#from-packages
|