mirror of
https://github.com/flutter/flutter
synced 2024-09-12 21:01:59 +00:00
baa54fdd76
Roll of a bunch of breaking changes from the native_assets_builder and native_assets_cli upstream. Most notably: * https://github.com/dart-lang/native/pull/946 * https://github.com/dart-lang/native/pull/1018 * https://github.com/dart-lang/native/pull/1019 This PR also updates the template in `flutter create --template=package_ffi` to use the rewritten API. This PR does not change any functionality in Flutter. For reference, the same roll in the Dart SDK: * https://dart-review.googlesource.com/c/sdk/+/357605 * https://dart-review.googlesource.com/c/sdk/+/357623 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] All existing and new tests are passing. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests [Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo [Features we expect every widget to implement]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat |
||
---|---|---|
.. | ||
hook | ||
lib | ||
src.tmpl | ||
test | ||
.gitignore.tmpl | ||
.metadata.tmpl | ||
analysis_options.yaml.tmpl | ||
CHANGELOG.md.tmpl | ||
ffigen.yaml.tmpl | ||
LICENSE.tmpl | ||
pubspec.yaml.tmpl | ||
README.md.tmpl |
# {{projectName}} {{description}} ## Getting Started This project is a starting point for a Flutter [FFI package](https://docs.flutter.dev/development/platform-integration/c-interop), a specialized package that includes native code directly invoked with Dart FFI. ## Project structure This template uses the following structure: * `src`: Contains the native source code, and a CmakeFile.txt file for building that source code into a dynamic library. * `lib`: Contains the Dart code that defines the API of the plugin, and which calls into the native code using `dart:ffi`. * `bin`: Contains the `build.dart` that performs the external native builds. ## Building and bundling native code `build.dart` does the building of native components. Bundling is done by Flutter based on the output from `build.dart`. ## Binding to native code To use the native code, bindings in Dart are needed. To avoid writing these by hand, they are generated from the header file (`src/{{projectName}}.h`) by `package:ffigen`. Regenerate the bindings by running `dart run ffigen --config ffigen.yaml`. ## Invoking native code Very short-running native functions can be directly invoked from any isolate. For example, see `sum` in `lib/{{projectName}}.dart`. Longer-running functions should be invoked on a helper isolate to avoid dropping frames in Flutter applications. For example, see `sumAsync` in `lib/{{projectName}}.dart`. ## Flutter help For help getting started with Flutter, view our [online documentation](https://flutter.dev/docs), which offers tutorials, samples, guidance on mobile development, and a full API reference.