native
native copied to clipboard
Add linking for `native_toolchain_c` and linux
Requires #827 to be merged.
Extend API by providing a CLinker, supporting development only on linux for now. Other platforms to be added in future PRs.
- [x] I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:
- See our contributor guide for general expectations for PRs.
- Larger or significant changes should be discussed in an issue before creating a PR.
- Contributions to our repos should follow the Dart style guide and use
dart format. - Most changes should add an entry to the changelog and may need to rev the pubspec package version.
- Changes to packages require corresponding tests.
Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.
PR Health
Breaking changes :heavy_check_mark:
Details
| Package | Change | Current Version | New Version | Needed Version | Looking good? |
|---|
Changelog Entry :heavy_check_mark:
Details
| Package | Changed Files |
|---|
Changes to files need to be accounted for in their respective changelogs.
License Headers :heavy_check_mark:
Details
// Copyright (c) 2024, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
| Files |
|---|
| no missing headers |
All source files should start with a license header.
Unrelated files missing license headers
| Files |
|---|
| pkgs/ffigen/example/libclang-example/generated_bindings.dart |
| pkgs/ffigen/example/shared_bindings/generate.dart |
| pkgs/ffigen/example/shared_bindings/lib/generated/a_gen.dart |
| pkgs/ffigen/example/shared_bindings/lib/generated/a_shared_b_gen.dart |
| pkgs/ffigen/example/shared_bindings/lib/generated/base_gen.dart |
| pkgs/ffigen/example/simple/generated_bindings.dart |
| pkgs/ffigen/lib/src/header_parser/clang_bindings/clang_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_decl_collision_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_symbol_address_collision_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_decl_type_name_collision_bindings.dart |
| pkgs/ffigen/test/collision_tests/expected_bindings/_expected_reserved_keyword_collision_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_comment_markup_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_dart_handle_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_enum_int_mimic_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_forward_decl_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_functions_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_imported_types_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_native_func_typedef_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_opaque_dependencies_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_packed_structs_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_regress_384_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_struct_fptr_fields_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_typedef_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_unions_bindings.dart |
| pkgs/ffigen/test/header_parser_tests/expected_bindings/_expected_varargs_bindings.dart |
| pkgs/ffigen/test/large_integration_tests/_expected_cjson_bindings.dart |
| pkgs/ffigen/test/large_integration_tests/_expected_libclang_bindings.dart |
| pkgs/ffigen/test/large_integration_tests/_expected_sqlite_bindings.dart |
| pkgs/ffigen/test/native_test/_expected_native_test_bindings.dart |
| pkgs/jni/lib/src/lang/jcharacter.dart |
| pkgs/jni/lib/src/third_party/generated_bindings.dart |
| pkgs/jni/lib/src/third_party/global_env_extensions.dart |
| pkgs/jni/lib/src/third_party/jni_bindings_generated.dart |
| pkgs/jnigen/android_test_runner/lib/main.dart |
| pkgs/jnigen/example/in_app_java/lib/android_utils.dart |
| pkgs/jnigen/example/kotlin_plugin/example/lib/main.dart |
| pkgs/jnigen/example/kotlin_plugin/lib/kotlin_bindings.dart |
| pkgs/jnigen/example/kotlin_plugin/lib/kotlin_plugin.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/pdfbox_plugin.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/_package.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart |
| pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/_package.dart |
| pkgs/jnigen/lib/src/bindings/descriptor.dart |
| pkgs/jnigen/lib/src/elements/elements.g.dart |
| pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/_package.dart |
| pkgs/jnigen/tool/command_runner.dart |
| pkgs/swift2objc/lib/src/config.dart |
| pkgs/swift2objc/lib/src/generate_wrapper.dart |
| pkgs/swift2objc/lib/src/generator/_core/utils.dart |
| pkgs/swift2objc/lib/src/generator/generator.dart |
| pkgs/swift2objc/lib/src/generator/generators/class_generator.dart |
| pkgs/swift2objc/lib/src/transformer/_core/unique_namer.dart |
Package publish validation :heavy_check_mark:
Details
| Package | Version | Status |
|---|---|---|
| package:ffi | 2.1.3-wip | WIP (no publish necessary) |
| package:ffigen | 13.0.0 | already published at pub.dev |
| package:jni | 0.11.0-wip | WIP (no publish necessary) |
| package:jnigen | 0.10.0 | already published at pub.dev |
| package:native_assets_cli | 0.7.3-wip | WIP (no publish necessary) |
| package:objective_c | 1.1.0 | already published at pub.dev |
| package:swift2objc | 0.0.1-wip | WIP (no publish necessary) |
| package:swiftgen | 0.0.1-wip | WIP (no publish necessary) |
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.
@dcharkes if you want to take a first look.
coverage: 91.823% (-0.2%) from 92.067% when pulling cbc364b5f0ee9bbd7d5d9a6786584221dfc6730e on exposeLinkFromCtoolchain into 695c0656dc649e6858ec0a6e09c6102c4b005b7e on main.
coverage: 90.46% (-0.1%) from 90.599% when pulling c72761a643a787dd15b5267e6c07a1eeba85146f on exposeLinkFromCtoolchain into 0dd11f52fbc8705aea2750356416b88e8c699a55 on main.
Given that we won't run the link hooks sometimes, we probably want to have this available for BuildConfigs and LinkConfigs. This would mean for CLinker to implement Builder in addition to Linker, currently not possible as their methods are both called run.
We should rename them to build and link, and make CLinker and CBuilder implement both, after this PR has landed.
Given that we won't run the link hooks sometimes, we probably want to have this available for
BuildConfigs andLinkConfigs. This would mean forCLinkerto implementBuilderin addition toLinker, currently not possible as their methods are both calledrun.We should rename them to
buildandlink, and makeCLinkerandCBuilderimplement both, after this PR has landed.
Alternatively, we could move all the logic into a shared base class and have CBuilder and CLinker only have the run that delegates to the base class.
- Using
CBuilderinhook/link.dartis an anti-pattern, the "heavy lifting" should be done in the build hook. And the link hook should only do the linking, it shouldn't do the building of static libs. - Using
CLinkerinhook/build.dartis unlikely, due to not having a static lib from somewhere yet?
Maybe we should explore some different designs (including https://github.com/dart-lang/native/pull/1131?) to see how verbose the typical build+link hook would be where a user links only their own native code in the link hook if linking is enabled and otherwise does a dylib in the build hook. E.g. what does the code in the two hooks look like with the 3 options.