Merge branch 'main' into ffiworkspace

Author: goderbauer

pkgs/ffigen/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 21.0.0
+
+- __Breaking change__: Remove deprecated `useDartHandle` field from
+  `FfiGenerator`.
+- __Breaking change__: Remove unused `includeSymbolAddress` field from
+  `Categories`, `Interfaces`, and `Protocols`.
+- __Breaking change__: Remove deprecated `wrapperName` field from
+  `NativeExternalBindings`.
+
 ## 20.1.1
 
 - Update tests and examples now that package:objective_c is using native assets.

pkgs/ffigen/ffigen.schema.json

@@ -479,9 +479,6 @@
     "preamble": {
       "type": "string"
     },
-    "use-dart-handle": {
-      "type": "boolean"
-    },
     "ffi-native": {
       "$oneOf": [
         {

pkgs/ffigen/lib/src/code_generator/library.dart

@@ -27,7 +27,6 @@ class Library {
     required List<Binding> bindings,
     required Context context,
   }) => Library(
-    name: context.config.wrapperName,
     description: context.config.wrapperDocComment,
     bindings: bindings,
     header: context.config.preamble,
@@ -43,7 +42,6 @@ class Library {
   );
 
   factory Library({
-    required String name,
     String? description,
     required List<Binding> bindings,
     String? header,

pkgs/ffigen/lib/src/code_generator/objc_built_in_functions.dart

@@ -2,7 +2,10 @@
 // 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.
 
+import 'package:path/path.dart' as path;
+
 import '../code_generator.dart';
+import '../config_provider.dart';
 import '../context.dart';
 import '../visitor/ast.dart';
 
@@ -14,15 +17,12 @@ import 'writer.dart';
 
 /// Built in functions used by the Objective C bindings.
 class ObjCBuiltInFunctions {
-  ObjCBuiltInFunctions(
-    this.context,
-    this.wrapperName,
-    this.generateForPackageObjectiveC,
-  );
+  ObjCBuiltInFunctions(this.context, this.generateForPackageObjectiveC)
+    : libraryId = _libraryIdFromConfigHash(context.config);
 
   final Context context;
-  final String wrapperName;
   final bool generateForPackageObjectiveC;
+  final String libraryId;
 
   static const registerName = ObjCImport('registerName');
   static const getClass = ObjCImport('getClass');
@@ -149,9 +149,9 @@ class ObjCBuiltInFunctions {
   ObjCBlockWrapperFuncs? getBlockTrampolines(ObjCBlock block) {
     final (id, idHash) = _methodSigId(block.returnType, block.params);
     return _blockTrampolines[id] ??= ObjCBlockWrapperFuncs(
-      _blockTrampolineFunc('_${wrapperName}_wrapListenerBlock_$idHash'),
+      _blockTrampolineFunc('_${libraryId}_wrapListenerBlock_$idHash'),
       _blockTrampolineFunc(
-        '_${wrapperName}_wrapBlockingBlock_$idHash',
+        '_${libraryId}_wrapBlockingBlock_$idHash',
         blocking: true,
       ),
     );
@@ -191,7 +191,7 @@ class ObjCBuiltInFunctions {
     final (id, idHash) = _methodSigId(block.returnType, block.params);
     return _protocolTrampolines[id] ??= ObjCProtocolMethodTrampoline(
       Func(
-        name: '_${wrapperName}_protocolTrampoline_$idHash',
+        name: '_${libraryId}_protocolTrampoline_$idHash',
         returnType: block.returnType,
         parameters: [
           Parameter(
@@ -215,6 +215,16 @@ class ObjCBuiltInFunctions {
     final baseType = type.typealiasType;
     return baseType is ObjCNullable && baseType.child is ObjCInstanceType;
   }
+
+  // A unique (but not human readable) ID for the generated library based on
+  // a hash of parts of the config.
+  static String _libraryIdFromConfigHash(Config config) => fnvHash32(
+    [
+      ...config.entryPoints,
+      config.output,
+      config.outputObjC,
+    ].map((uri) => path.basename(uri.toFilePath())).join('\n'),
+  ).toRadixString(36);
 }
 
 /// A native trampoline function for a listener block.

pkgs/ffigen/lib/src/code_generator/objc_protocol.dart

@@ -329,11 +329,11 @@ ${generateInstanceMethodBindings(w, this)}
   BindingString? toObjCBindingString(Writer w) {
     if (generateAsStub) return null;
 
-    final wrapName = context.objCBuiltInFunctions.wrapperName;
+    final libraryId = context.objCBuiltInFunctions.libraryId;
     final mainString =
         '''
 
-Protocol* _${wrapName}_$originalName(void) { return @protocol($originalName); }
+Protocol* _${libraryId}_$originalName(void) { return @protocol($originalName); }
 ''';
 
     return BindingString(

pkgs/ffigen/lib/src/config_provider/config.dart

@@ -72,14 +72,6 @@ final class FfiGenerator {
   )
   final List<LibraryImport> libraryImports;
 
-  /// Whether `Dart_Handle` should be mapped with Handle/Object.
-  // TODO(https://github.com/dart-lang/native/issues/2594): Remove this.
-  @Deprecated(
-    'Will be removed in a future version. Please reply in '
-    'https://github.com/dart-lang/native/issues/2594 if you rely on this.',
-  )
-  final bool useDartHandle;
-
   /// Path to the clang library.
   ///
   /// Only visible for YamlConfig plumbing.
@@ -109,11 +101,6 @@ final class FfiGenerator {
       'https://github.com/dart-lang/native/issues/2597.',
     )
     this.libraryImports = const <LibraryImport>[],
-    @Deprecated(
-      'Will be removed in a future version. Please reply in '
-      'https://github.com/dart-lang/native/issues/2594 if you rely on this.',
-    )
-    this.useDartHandle = true,
     @Deprecated('Only visible for YamlConfig plumbing.') this.libclangDylib,
   });
 
@@ -579,7 +566,6 @@ final class Categories extends Declarations {
   const Categories({
     super.include,
     super.includeMember,
-    super.includeSymbolAddress,
     super.rename,
     super.renameMember,
     this.includeTransitive = true,
@@ -607,7 +593,6 @@ final class Interfaces extends Declarations {
   const Interfaces({
     super.include,
     super.includeMember,
-    super.includeSymbolAddress,
     super.rename,
     super.renameMember,
     this.includeTransitive = false,
@@ -638,7 +623,6 @@ final class Protocols extends Declarations {
   const Protocols({
     super.include,
     super.includeMember,
-    super.includeSymbolAddress,
     super.rename,
     super.renameMember,
     this.includeTransitive = false,
@@ -709,16 +693,7 @@ final class NativeExternalBindings implements BindingStyle {
   /// If omitted, it will not be generated.
   final String? assetId;
 
-  /// The prefix for the generated Objective-C functions.
-  // TODO(https://github.com/dart-lang/native/issues/2580): Remove this.
-  @Deprecated('Will be replaced by a hash.')
-  final String wrapperName;
-
-  const NativeExternalBindings({
-    this.assetId,
-    @Deprecated('Will be replaced by a hash.')
-    this.wrapperName = 'NativeLibrary',
-  });
+  const NativeExternalBindings({this.assetId});
 }
 
 /// Generate bindings which take a [DynamicLibrary] or [DynamicLibrary.lookup]
@@ -761,14 +736,9 @@ extension type Config(FfiGenerator ffiGen) implements FfiGenerator {
   Protocols get objcProtocols => _objectiveC.protocols;
   ExternalVersions get externalVersions => _objectiveC.externalVersions;
   // ignore: deprecated_member_use_from_same_package
-  bool get useDartHandle => ffiGen.useDartHandle;
-  // ignore: deprecated_member_use_from_same_package
   Map<String, ImportedType> get importedTypesByUsr => ffiGen.importedTypesByUsr;
-  String get wrapperName => switch (ffiGen.output.style) {
-    final DynamicLibraryBindings e => e.wrapperName,
-    // ignore: deprecated_member_use_from_same_package
-    final NativeExternalBindings e => e.wrapperName,
-  };
+  String get wrapperName =>
+      (ffiGen.output.style as DynamicLibraryBindings).wrapperName;
 
   String? get wrapperDocComment => switch (ffiGen.output.style) {
     final DynamicLibraryBindings e => e.wrapperDocComment,

pkgs/ffigen/lib/src/config_provider/yaml_config.dart

@@ -219,10 +219,6 @@ final class YamlConfig {
   String? get preamble => _preamble;
   String? _preamble;
 
-  /// If `Dart_Handle` should be mapped with Handle/Object.
-  bool get useDartHandle => _useDartHandle;
-  late bool _useDartHandle;
-
   /// Where to silence warning for enum integer type mimicking.
   bool get silenceEnumWarning => _silenceEnumWarning;
   late bool _silenceEnumWarning;
@@ -877,12 +873,6 @@ final class YamlConfig {
             result: (node) => _preamble = node.value as String?,
           ),
         ),
-        HeterogeneousMapEntry(
-          key: strings.useDartHandle,
-          valueConfigSpec: BoolConfigSpec(),
-          defaultValue: (node) => true,
-          resultOrDefault: (node) => _useDartHandle = node.value as bool,
-        ),
         HeterogeneousMapEntry(
           key: strings.ffiNative,
           valueConfigSpec: OneOfConfigSpec(
@@ -1252,11 +1242,7 @@ final class YamlConfig {
       preamble: preamble,
       format: formatOutput,
       style: ffiNativeConfig.enabled
-          ? NativeExternalBindings(
-              assetId: ffiNativeConfig.assetId,
-              // ignore: deprecated_member_use_from_same_package
-              wrapperName: wrapperName,
-            )
+          ? NativeExternalBindings(assetId: ffiNativeConfig.assetId)
           : DynamicLibraryBindings(
               wrapperName: wrapperName,
               wrapperDocComment: wrapperDocComment,
@@ -1324,7 +1310,6 @@ final class YamlConfig {
         ? ObjectiveC(
             interfaces: Interfaces(
               include: objcInterfaces.shouldInclude,
-              includeSymbolAddress: objcInterfaces.shouldIncludeSymbolAddress,
               includeMember: objcInterfaces.shouldIncludeMember,
               rename: objcInterfaces.rename,
               renameMember: objcInterfaces.renameMember,
@@ -1333,7 +1318,6 @@ final class YamlConfig {
             ),
             protocols: Protocols(
               include: objcProtocols.shouldInclude,
-              includeSymbolAddress: objcProtocols.shouldIncludeSymbolAddress,
               includeMember: objcProtocols.shouldIncludeMember,
               rename: objcProtocols.rename,
               renameMember: objcProtocols.renameMember,
@@ -1342,7 +1326,6 @@ final class YamlConfig {
             ),
             categories: Categories(
               include: objcCategories.shouldInclude,
-              includeSymbolAddress: objcCategories.shouldIncludeSymbolAddress,
               includeMember: objcCategories.shouldIncludeMember,
               rename: objcCategories.rename,
               renameMember: objcCategories.renameMember,
@@ -1360,8 +1343,6 @@ final class YamlConfig {
     // ignore: deprecated_member_use_from_same_package
     integers: Integers(imported: nativeTypeMappings.values.toList()),
     // ignore: deprecated_member_use_from_same_package
-    useDartHandle: useDartHandle,
-    // ignore: deprecated_member_use_from_same_package
     libclangDylib: libclangDylib,
   );
 }

pkgs/ffigen/lib/src/context.dart

@@ -36,7 +36,6 @@ class Context {
       cursorIndex = CursorIndex(logger) {
     objCBuiltInFunctions = ObjCBuiltInFunctions(
       this,
-      config.wrapperName,
       // ignore: deprecated_member_use_from_same_package
       generator.objectiveC?.generateForPackageObjectiveC ?? false,
     );

pkgs/ffigen/lib/src/header_parser/sub_parsers/compounddecl_parser.dart

@@ -59,7 +59,7 @@ class _ParsedCompound {
       unimplementedMemberType ||
       flexibleArrayMember ||
       bitFieldMember ||
-      (dartHandleMember && context.config.useDartHandle) ||
+      dartHandleMember ||
       incompleteCompoundMember ||
       alignment == clang_types.CXTypeLayoutError.CXTypeLayoutError_Incomplete;
 
@@ -237,7 +237,7 @@ void fillCompoundMembersIfNeeded(
       'Removed All $className Members from ${compound.originalName}'
       '(${compound.originalName}), Bit Field members not supported.',
     );
-  } else if (parsed.dartHandleMember && context.config.useDartHandle) {
+  } else if (parsed.dartHandleMember) {
     logger.fine(
       '---- Removed $className members, reason: Dart_Handle member. '
       '${cursor.completeStringRepr()}',

pkgs/ffigen/lib/src/header_parser/type_extractor/extractor.dart

@@ -123,9 +123,7 @@ Type getCodeGenType(
       );
 
       // Replace Pointer<_Dart_Handle> with Handle.
-      if (context.config.useDartHandle &&
-          s is Struct &&
-          s.usr == strings.dartHandleUsr) {
+      if (s is Struct && s.usr == strings.dartHandleUsr) {
         return HandleType();
       }
       return PointerType(s);