Refactor C interop #5881
Merged
Refactor C interop #5881
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Visit the preview URL for this PR (updated for commit 5697550): |
dcharkes
approved these changes
May 30, 2024
src/content/interop/c-interop.md
Outdated
|
|
||
| The [`hello.dart` file]({{hw}}/hello.dart) | ||
| illustrates the steps for using `dart:ffi` to call a C function: | ||
| To learn how to call a C function using the `dart:ffi` package, |
There was a problem hiding this comment.
dart: is not a package, package: is a package. Did you mean to say library?
| Once you understand the `hello_world` example, | ||
| consult the [other `dart:ffi` examples](#download-example-files). | ||
|
|
||
| ## Bundle and load C libraries |
There was a problem hiding this comment.
I suppose we mostly want to reference what is non-experimental here.
The work on native assets (which is currently an experiment in Dart and Flutter), will make bundling / distributing native code platform agnostic.
Edit: Ah we already have a section for native assets, maybe link it here.
There was a problem hiding this comment.
Already done on line 264
src/content/interop/c-interop.md
Outdated
| * It makes the native assets available at runtime through | ||
| * Build the native code or obtains the binaries | ||
| using a package's `build.dart` script. | ||
| * Bundle the native [`Asset`][] that the `build.dart` script reports. |
There was a problem hiding this comment.
The new terminology is build hook, build.dart hook, or hook/build.dart. The hook was moved inside the hook/ directory, and we don't use "script" anymore.
src/content/interop/c-interop.md
Outdated
| ### Experiment opt-in | ||
| * To learn about native assets in Dart FFI, | ||
| consult the `dart:ffi` API reference for [`Native`][] and [`DefaultAsset`][]. | ||
| * To learn about the `build.dart` script, |
src/content/interop/c-interop.md
Outdated
| When a Dart or Flutter project depends on `package:native_add_library`, | ||
| the `build.dart` script will automatically be | ||
| invoked on `run`, `build`, and `test` commands. | ||
| it invokes the `build.dart` script on `run`, `build`, and `test` commands. |
There was a problem hiding this comment.
build.dart -> hook/build.dart
src/content/interop/c-interop.md
Outdated
| | [`src/native_add_library.c`][] | The C file containing the code for `add`. | | ||
| | [`lib/native_add_library.dart`][] | The Dart file that invokes the C function `add` in asset `package:native_add_library/native_add_library.dart` through FFI. (Note that _asset id_ defaults to the library uri.) | | ||
| | [`test/native_add_library_test.dart`][] | A Dart test using the native code. | | ||
| | [`hook/build.dart`][] | A script for compiling `src/native_add_library.c` and declaring the compiled asset with id `package:native_add_library/native_add_library.dart`. | |
MaryaBelanger
added
review.await-update
parlough
added
review.copy
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3894
Expands on this issue by updating links to code examples, updating style