flutter

History

[native assets] Roll dependencies (#160672 )

This PR rolls in a number of breaking changes from dart-lang/native:

* `BuildMode` is no longer part of the protocol, so Flutter no longer
passes it in.
* This means all code dealing with the name conflict between
`native_assets_cli.BuildMode` and `flutter_tools.BuildMode` has been
cleaned up.
  * Also, the logs no longer mention the build mode.
* The tests still exercise both modes, because linking only happens in
release mode.
* `OS` is no longer part of the main protocol, but of the "code"
"protocol extension".
* The code now aligns more with `OS?` being nullable in a bunch of
places, since it is nullable if there's no code assets.
* The OS-specific config is nested in an object per OS.
* `CCompilerConfig`s fields are non-nullable now.
* So instead of passing an object with nullable fields around, a null
instead of the object is returned in various places.
* `FileSystem` is now passed in to the native assets builder.

This PR contains no feature changes.

This PR will need to be followed up by restricting what environment
variables are passed in (similar to
https://github.com/dart-lang/native/pull/1764), I will do this in a
follow up PR.

Tests:

* All existing features should be covered by existing tests.

2025-01-02 19:26:02 +00:00

hook

[native assets] Roll dependencies (#155432 )

2024-09-24 07:19:09 +00:00

lib

Fixed a lot of typos (#141431 )

2024-01-12 22:10:25 +00:00

src.tmpl

…

test

[native assets] Roll dependencies (#160672 )

2025-01-02 19:26:02 +00:00

.gitignore.tmpl

[tool] Update .gitignore templates to include .flutter-plugins files (#152950 )

2024-09-04 20:54:24 +00:00

.metadata.tmpl

…

analysis_options.yaml.tmpl

…

CHANGELOG.md.tmpl

…

ffigen.yaml.tmpl

Modify plugin_ffi and package_ffi template (#143376 )

2024-02-15 10:37:30 +00:00

LICENSE.tmpl

…

pubspec.yaml.tmpl

[native assets] Roll dependencies (#160672 )

2025-01-02 19:26:02 +00:00

README.md.tmpl

Switch to more reliable flutter.dev link destinations in the tool (#150587 )

2024-06-26 23:30:39 +00:00

README.md.tmpl

# {{projectName}}

{{description}}

## Getting Started

This project is a starting point for a Flutter
[FFI package](https://flutter.dev/to/ffi-package),
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://docs.flutter.dev), which offers tutorials,
samples, guidance on mobile development, and a full API reference.