[objective_c] Verify generated code is up to date

[liamappelbe]

• Add a step to package:objective_c's github CI to verify that the generated code is up to date. The step essentially just checks if git status shows any changed files, and prints the git diff if so.
• Update the bindings. We now get ObjC bindings, so add them to the build.
• For this test to work, we have to make the codegen consistent enough to produce the same result on the bots as it does on my local machine, so there were a ton of tiny bugs to fix:
  • On my machine, va_list resolves to __va_list_tag*, but it seems on the CI bot it resolves to char*? This broke the special casing for methods with variadic args. I've tightened it up and moved the check earlier in the pipeline to look at the clang AST directly.
  • Use a consistent hash when naming trampolines (String.hash seems to be consistent enough in practice, but it's probably better not to rely on that as it's not guaranteed). Using FNV as it's tiny and fast.
  • The version of flutter running on CI doesn't like having the listener block trampoline as an inline lambda (due to NativeCallable.listener constructor should accept functions returning Null. sdk#53659), so change it back to being a top level function. Could also just bump the SDK version, but that's not necessary yet. This should also fix the failures on the arm bot.
  • Add some extra ignore_for_file rules to package:objective_c
  • When copying methods from a superclass, we skip certain methods to avoid polluting the bindings with useless (and conflicting) methods. Do the same when copying methods from protocols.
  • If the sort: config option is enabled, also sort interface/protocol methods (methods were showing up in an inconsistent order on CI).
  • sort: doesn't fix the fact that msgSends are numbered in the order they're seen. So switch them to a hash based name (like the trampoline functions).
  • Protocols may be included in the AST without being codegenned. There was a bug where such protocols would still participate in name deduping (eg there is an interface and a protocol named NSObject, so one of them was being renamed to NSObject1). Make non-generating bindings a first-class concept in the AST, and don't rename them, and don't pass them to the writer.
  • Remove argument names from msgSend declarations. msgSends are deduped, so it doesn't make much sense to show their arg names. You'll end up seeing the names of whichever method uses that signature first (which is another source of inconsistency).

[github-actions]

PR Health

Coverage ⚠️

File	Coverage
pkgs/ffigen/lib/src/code_generator/binding.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/func.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/func_type.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/imports.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/library.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/objc_block.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/objc_built_in_functions.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/objc_interface.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/objc_methods.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/objc_protocol.dart	💔 Not covered
pkgs/ffigen/lib/src/code_generator/utils.dart	💔 Not covered
pkgs/ffigen/lib/src/header_parser/sub_parsers/objcinterfacedecl_parser.dart	💔 Not covered
pkgs/objective_c/lib/src/c_bindings_generated.dart	💔 Not covered
pkgs/objective_c/lib/src/objective_c_bindings_generated.dart	💔 Not covered

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

License Headers ✔️

// 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/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/native_assets_builder/test_data/native_dynamic_linking/bin/native_dynamic_linking.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/parser/parsers/declaration_parsers/parse_initializer_declaration.dart
pkgs/swift2objc/lib/src/parser/parsers/declaration_parsers/parse_property_declaration.dart
pkgs/swift2objc/lib/src/transformer/_core/unique_namer.dart
pkgs/swift2objc/lib/src/transformer/_core/utils.dart
pkgs/swift2objc/lib/src/transformer/transformers/transform_property.dart
pkgs/swift2objc/test/unit/parse_initializer_param_test.dart

Package publish validation ✔️

Package	Version	Status
package:ffi	2.1.3	already published at pub.dev
package:ffigen	15.0.0-wip	WIP (no publish necessary)
package:jni	0.12.0-wip	WIP (no publish necessary)
package:jnigen	0.12.0-wip	WIP (no publish necessary)
package:native_assets_cli	0.9.0-wip	WIP (no publish necessary)
package:objective_c	2.1.0-wip	WIP (no publish necessary)
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.

[coveralls]

coverage: 91.22% (+0.3%) from 90.886%
when pulling d4feef5 on regentest
into 117cc75 on main.

[HosseinYousefi]

LGTM!