[ffigen] Changes to support downstream clone (#2197)

Author: liamappelbe

pkgs/ffigen/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 18.1.1-wip
+
+- Make it easier for a downstream clone to change behavior of certain utils.
+
 ## 18.1.0
 
 - Fix a clang warning in ObjC protocol generated bindings.

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

@@ -0,0 +1,48 @@
+// Copyright (c) 2025, 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.
+
+// This file contains utils that are intended to be overridden by downstream
+// clones. They're gathered into one file to make it easy to swap them out.
+
+// This file is exclusively imported by utils.dart, so that there's only one
+// line we have to patch in the downstream clones.
+@Deprecated('Import config_provider/utils.dart instead')
+library;
+
+import 'dart:io';
+
+import 'package:path/path.dart' as p;
+
+// Replaces the path separators according to current platform.
+String _replaceSeparators(String path) {
+  if (Platform.isWindows) {
+    return path.replaceAll(p.posix.separator, p.windows.separator);
+  } else {
+    return path.replaceAll(p.windows.separator, p.posix.separator);
+  }
+}
+
+/// Replaces the path separators according to current platform, and normalizes .
+/// and .. in the path. If a relative path is passed in, it is resolved relative
+/// to the config path, and the absolute path is returned.
+String normalizePath(String path, String? configFilename) {
+  final resolveInConfigDir =
+      (configFilename == null) || p.isAbsolute(path) || path.startsWith('**');
+  return _replaceSeparators(p.normalize(resolveInConfigDir
+      ? path
+      : p.absolute(p.join(p.dirname(configFilename), path))));
+}
+
+/// These locations are searched for clang dylibs before any others. Downstream
+/// clones can use a non-null value for this path to search here first.
+final libclangOverridePaths = const <String>[];
+
+/// Returns the root path of the package, for use during tests.
+///
+/// Note that `dart test` sets the current directory to the package root.
+final packagePathForTests = p.current;
+
+/// Returns a path to a config yaml in a unit test.
+String configPathForTest(String directory, String file) =>
+    p.join(directory, file);

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

@@ -308,13 +308,19 @@ String? _findLibInConda() {
 /// Returns location of dynamic library by searching default locations. Logs
 /// error and throws an Exception if not found.
 String findDylibAtDefaultLocations() {
+  for (final libclangPath in libclangOverridePaths) {
+    final overridableLib = findLibclangDylib(libclangPath);
+    if (overridableLib != null) return overridableLib;
+  }
+
   // Assume clang in conda has a higher priority.
-  var k = _findLibInConda();
-  if (k != null) return k;
+  final condaLib = _findLibInConda();
+  if (condaLib != null) return condaLib;
+
   if (Platform.isLinux) {
     for (final l in strings.linuxDylibLocations) {
-      k = findLibclangDylib(l);
-      if (k != null) return k;
+      final linuxLib = findLibclangDylib(l);
+      if (linuxLib != null) return linuxLib;
     }
     Process.runSync('ldconfig', ['-p']);
     final ldConfigResult = Process.runSync('ldconfig', ['-p']);
@@ -338,13 +344,13 @@ String findDylibAtDefaultLocations() {
           .add(p.join(userHome, 'scoop', 'apps', 'llvm', 'current', 'bin'));
     }
     for (final l in dylibLocations) {
-      k = findLibclangDylib(l);
-      if (k != null) return k;
+      final winLib = findLibclangDylib(l);
+      if (winLib != null) return winLib;
     }
   } else if (Platform.isMacOS) {
     for (final l in strings.macOsDylibLocations) {
-      k = findLibclangDylib(l);
-      if (k != null) return k;
+      final macLib = findLibclangDylib(l);
+      if (macLib != null) return macLib;
     }
     final findLibraryResult =
         Process.runSync('xcodebuild', ['-find-library', 'libclang.dylib']);

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

@@ -4,27 +4,8 @@
 
 import 'dart:io';
 
-import 'package:path/path.dart' as p;
-
-// Replaces the path separators according to current platform.
-String _replaceSeparators(String path) {
-  if (Platform.isWindows) {
-    return path.replaceAll(p.posix.separator, p.windows.separator);
-  } else {
-    return path.replaceAll(p.windows.separator, p.posix.separator);
-  }
-}
-
-/// Replaces the path separators according to current platform, and normalizes .
-/// and .. in the path. If a relative path is passed in, it is resolved relative
-/// to the config path, and the absolute path is returned.
-String normalizePath(String path, String? configFilename) {
-  final resolveInConfigDir =
-      (configFilename == null) || p.isAbsolute(path) || path.startsWith('**');
-  return _replaceSeparators(p.normalize(resolveInConfigDir
-      ? path
-      : p.absolute(p.join(p.dirname(configFilename), path))));
-}
+// ignore: deprecated_member_use_from_same_package
+export 'overrideable_utils.dart';
 
 /// Replaces any variable names in the path with the corresponding value.
 String substituteVars(String path) {

pkgs/ffigen/pubspec.yaml

@@ -3,7 +3,7 @@
 # BSD-style license that can be found in the LICENSE file.
 
 name: ffigen
-version: 18.1.0
+version: 18.1.1-wip
 description: >
   Generator for FFI bindings, using LibClang to parse C, Objective-C, and Swift
   files.

pkgs/ffigen/test/collision_tests/decl_type_name_collision_test.dart

@@ -22,7 +22,7 @@ ${strings.description}: 'Decl type name collision test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/collision_tests/decl_type_name_collision.h'
+    - '${absPath('test/collision_tests/decl_type_name_collision.h')}'
 ${strings.preamble}: |
     // ignore_for_file: non_constant_identifier_names, 
         '''),

pkgs/ffigen/test/config_tests/compiler_opts_test.dart

@@ -34,7 +34,7 @@ ${strings.description}: 'Compiler Opts Test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/comment_markup.h'
+    - '${absPath('test/header_parser_tests/comment_markup.h')}'
 ${strings.compilerOptsAuto}:
   ${strings.macos}:
     ${strings.includeCStdLib}: false

pkgs/ffigen/test/config_tests/deprecate_assetid_test.dart

@@ -21,7 +21,7 @@ ${strings.ffiNative}:
     assetId: 'myasset'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/comment_markup.h'
+    - '${absPath('test/header_parser_tests/comment_markup.h')}'
 ''');
     parse(config);
 

pkgs/ffigen/test/config_tests/exclude_all_by_default_test.dart

@@ -19,7 +19,7 @@ ${strings.output}: 'unused'
 ${strings.excludeAllByDefault}: false
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/config_tests/exclude_all_by_default.h'
+    - '${absPath('test/config_tests/exclude_all_by_default.h')}'
 ''');
 
       final library = parse(config);
@@ -40,7 +40,7 @@ ${strings.output}: 'unused'
 ${strings.excludeAllByDefault}: true
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/config_tests/exclude_all_by_default.h'
+    - '${absPath('test/config_tests/exclude_all_by_default.h')}'
 ''');
 
       final library = parse(config);

pkgs/ffigen/test/config_tests/include_exclude_test.dart

@@ -49,7 +49,7 @@ ${strings.description}: 'include_exclude test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/config_tests/include_exclude.h'
+    - '${absPath('test/config_tests/include_exclude.h')}'
 ''';
   if (include != null || exclude != null) {
     templateString += '''

pkgs/ffigen/test/config_tests/no_cursor_definition_warn_test.dart

@@ -21,7 +21,7 @@ ${strings.description}: 'Warn for no cursor definition.'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/opaque_dependencies.h'
+    - '${absPath('test/header_parser_tests/opaque_dependencies.h')}'
 ${strings.structs}:
   ${strings.dependencyOnly}: ${strings.opaqueCompoundDependencies}
   ${strings.include}:

pkgs/ffigen/test/config_tests/packed_struct_override_test.dart

@@ -12,12 +12,12 @@ import '../test_utils.dart';
 void main() {
   group('packed_struct_override_test', () {
     test('Invalid Packed Config values', () {
-      const baseYaml = '''${strings.name}: 'NativeLibrary'
+      final baseYaml = '''${strings.name}: 'NativeLibrary'
 ${strings.description}: 'Packed Struct Override Test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/packed_structs.h'
+    - '${absPath('test/header_parser_tests/packed_structs.h')}'
 ${strings.structs}:
   ${strings.structPack}:
     ''';
@@ -35,7 +35,7 @@ ${strings.description}: 'Packed Struct Override Test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/packed_structs.h'
+    - '${absPath('test/header_parser_tests/packed_structs.h')}'
 ${strings.structs}:
   ${strings.structPack}:
     'Normal.*': 1

pkgs/ffigen/test/config_tests/unknown_keys_warn_test.dart

@@ -20,7 +20,7 @@ ${strings.description}: 'Warn for unknown keys.'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/packed_structs.h'
+    - '${absPath('test/header_parser_tests/packed_structs.h')}'
 'warn-1': 'warn'
 ${strings.typeMap}:
   'warn-2': 'warn'

pkgs/ffigen/test/header_parser_tests/comment_markup_test.dart

@@ -22,7 +22,7 @@ ${strings.description}: 'Comment Markup Test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/comment_markup.h'
+    - '${absPath('test/header_parser_tests/comment_markup.h')}'
 ${strings.comments}:
   ${strings.style}: ${strings.any}
   ${strings.length}: ${strings.full}

pkgs/ffigen/test/header_parser_tests/dart_handle_test.dart

@@ -26,7 +26,7 @@ ${strings.compilerOpts}: '-I${path.join(sdkPath, "include")}'
 
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/dart_handle.h'
+    - '${absPath('test/header_parser_tests/dart_handle.h')}'
   ${strings.includeDirectives}:
     - '**dart_handle.h'
         '''),

pkgs/ffigen/test/header_parser_tests/enum_int_mimic_test.dart

@@ -22,7 +22,7 @@ ${strings.description}: 'Enum int mimic test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/enum_int_mimic.h'
+    - '${absPath('test/header_parser_tests/enum_int_mimic.h')}'
   ${strings.includeDirectives}:
     - '**enum_int_mimic.h'
 ${strings.ignoreSourceErrors}: true

pkgs/ffigen/test/header_parser_tests/forward_decl_test.dart

@@ -22,7 +22,7 @@ ${strings.description}: 'Forward Declaration Test'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/forward_decl.h'
+    - '${absPath('test/header_parser_tests/forward_decl.h')}'
 ${strings.ignoreSourceErrors}: true
         '''),
       );

pkgs/ffigen/test/header_parser_tests/function_n_struct_test.dart

@@ -25,7 +25,7 @@ ${strings.output}: 'unused'
 
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/function_n_struct.h'
+    - '${absPath('test/header_parser_tests/function_n_struct.h')}'
         '''),
       );
     });

pkgs/ffigen/test/header_parser_tests/functions_test.dart

@@ -23,7 +23,7 @@ ${strings.output}: 'unused'
 
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/functions.h'
+    - '${absPath('test/header_parser_tests/functions.h')}'
   ${strings.includeDirectives}:
     - '**functions.h'
 

pkgs/ffigen/test/header_parser_tests/globals_config.yaml

@@ -0,0 +1,18 @@
+name: 'NativeLibrary'
+description: 'Globals Test'
+output: 'unused'
+headers:
+  entry-points:
+    - globals.h
+  include-directives:
+    - '**globals.h'
+globals:
+  exclude:
+    - GlobalIgnore
+  symbol-address:
+    include:
+      - myInt
+      - pointerToLongDouble
+      - globalStruct
+compiler-opts: '-Wno-nullability-completeness'
+ignore-source-errors: true

pkgs/ffigen/test/header_parser_tests/globals_test.dart

@@ -4,7 +4,7 @@
 
 import 'package:ffigen/src/code_generator.dart';
 import 'package:ffigen/src/header_parser.dart' as parser;
-import 'package:ffigen/src/strings.dart' as strings;
+import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
 import '../test_utils.dart';
@@ -17,26 +17,8 @@ void main() {
       logWarnings();
       expected = expectedLibrary();
       actual = parser.parse(
-        testConfig('''
-${strings.name}: 'NativeLibrary'
-${strings.description}: 'Globals Test'
-${strings.output}: 'unused'
-${strings.headers}:
-  ${strings.entryPoints}:
-    - 'test/header_parser_tests/globals.h'
-  ${strings.includeDirectives}:
-    - '**globals.h'
-${strings.globals}:
-  ${strings.exclude}:
-    - GlobalIgnore
-  ${strings.symbolAddress}:
-    ${strings.include}:
-      - myInt
-      - pointerToLongDouble
-      - globalStruct
-${strings.compilerOpts}: '-Wno-nullability-completeness'
-${strings.ignoreSourceErrors}: true
-        '''),
+        testConfigFromPath(configPath(
+            path.join('test', 'header_parser_tests'), 'globals_config.yaml')),
       );
     });
 

pkgs/ffigen/test/header_parser_tests/imported_types_test.dart

@@ -23,7 +23,7 @@ ${strings.output}: 'unused'
 
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/imported_types.h'
+    - '${absPath('test/header_parser_tests/imported_types.h')}'
   ${strings.includeDirectives}:
     - '**imported_types.h'
 

pkgs/ffigen/test/header_parser_tests/macros_config.yaml

@@ -0,0 +1,8 @@
+name: 'NativeLibrary'
+description: 'Macros Test'
+output: 'unused'
+headers:
+  entry-points:
+    - macros.h
+  include-directives:
+    - '**macros.h'

pkgs/ffigen/test/header_parser_tests/macros_test.dart

@@ -6,6 +6,7 @@ import 'package:ffigen/src/code_generator.dart';
 import 'package:ffigen/src/header_parser.dart' as parser;
 import 'package:ffigen/src/strings.dart' as strings;
 import 'package:logging/logging.dart';
+import 'package:path/path.dart' as path;
 import 'package:test/test.dart';
 
 import '../test_utils.dart';
@@ -18,16 +19,8 @@ void main() {
       logWarnings(Level.WARNING);
       expected = expectedLibrary();
       actual = parser.parse(
-        testConfig('''
-${strings.name}: 'NativeLibrary'
-${strings.description}: 'Macros Test'
-${strings.output}: 'unused'
-${strings.headers}:
-  ${strings.entryPoints}:
-    - 'test/header_parser_tests/macros.h'
-  ${strings.includeDirectives}:
-    - '**macros.h'
-        '''),
+        testConfigFromPath(configPath(
+            path.join('test', 'header_parser_tests'), 'macros_config.yaml')),
       );
     });
     test('Total bindings count', () {

pkgs/ffigen/test/header_parser_tests/native_func_typedef_test.dart

@@ -22,7 +22,7 @@ ${strings.description}: 'Native Func Typedef Test.'
 ${strings.output}: 'unused'
 ${strings.headers}:
   ${strings.entryPoints}:
-    - 'test/header_parser_tests/native_func_typedef.h'
+    - '${absPath('test/header_parser_tests/native_func_typedef.h')}'
         '''),
       );
     });