[ffigen] API cleanup (#2409)

* API cleanup

* changelog

* objc pubspec

Author: liamappelbe

pkgs/ffigen/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 20.0.0-wip
+
+- __Breaking change__: Refactor the Dart API a bit, to merge the `FfiGen` and
+  `Config` classes. Rename `FfiGen.run` to `.generate`, and make it an extension
+  method on the `Config` class. So `FfiGen().run(config)` becomes
+  `config.generate(logger)`.
+
 ## 19.1.0
 
 - Bump minimum Dart version to 3.8.0.

pkgs/ffigen/lib/ffigen.dart

@@ -13,10 +13,10 @@ export 'src/config_provider.dart'
     show
         CommentType,
         CompoundDependencies,
-        Config,
         Declaration,
         DeclarationFilters,
         ExternalVersions,
+        FfiGen,
         FfiNativeConfig,
         Language,
         PackingValue,
@@ -25,4 +25,4 @@ export 'src/config_provider.dart'
         Versions,
         YamlConfig,
         defaultCompilerOpts;
-export 'src/ffigen.dart' show FfiGen;
+export 'src/ffigen.dart' show FfiGenGenerator;

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

@@ -9,7 +9,7 @@ import 'package:yaml_edit/yaml_edit.dart';
 
 import '../code_generator.dart';
 import '../code_generator/utils.dart';
-import '../config_provider/config.dart' show Config;
+import '../config_provider/config.dart' show FfiGen;
 import '../config_provider/config_types.dart';
 
 import 'writer.dart';
@@ -26,7 +26,7 @@ class Library {
   Library._(this.bindings, this.writer);
 
   static Library fromConfig({
-    required Config config,
+    required FfiGen config,
     required List<Binding> bindings,
   }) => Library(
     name: config.wrapperName,

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

@@ -10,7 +10,7 @@ import 'config_types.dart';
 import 'spec_utils.dart';
 
 /// Provides configurations to other modules.
-abstract interface class Config {
+abstract interface class FfiGen {
   /// Input config filename, if any.
   Uri? get filename;
 
@@ -192,7 +192,7 @@ abstract interface class Config {
   /// before this version will not be generated.
   ExternalVersions get externalVersions;
 
-  factory Config({
+  factory FfiGen({
     Uri? filename,
     PackageConfig? packageConfig,
     Uri? libclangDylib,

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

@@ -8,7 +8,7 @@ import '../code_generator.dart';
 import 'config.dart';
 import 'config_types.dart';
 
-class ConfigImpl implements Config {
+class ConfigImpl implements FfiGen {
   @override
   final Uri? filename;
 

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

@@ -23,7 +23,7 @@ final _logger = Logger('ffigen.config_provider.config');
 /// Provides configurations to other modules.
 ///
 /// Handles validation, extraction of configurations from a yaml file.
-class YamlConfig implements Config {
+class YamlConfig implements FfiGen {
   /// Input config filename, if any.
   @override
   final Uri? filename;

pkgs/ffigen/lib/src/executables/ffigen.dart

@@ -6,13 +6,27 @@
 import 'dart:io';
 
 import 'package:args/args.dart';
+import 'package:cli_util/cli_logging.dart' show Ansi;
 import 'package:logging/logging.dart';
 import 'package:package_config/package_config.dart';
 import 'package:yaml/yaml.dart' as yaml;
 
 import '../../ffigen.dart';
 
-final _logger = Logger('ffigen.ffigen');
+final _ansi = Ansi(Ansi.terminalSupportsAnsi);
+final _logger = () {
+  final logger = Logger('ffigen.ffigen');
+  logger.onRecord.listen((record) {
+    final levelStr = '[${record.level.name}]'.padRight(9);
+    final log = '$levelStr: ${record.message}';
+    if (record.level < Level.SEVERE) {
+      print(log);
+    } else {
+      print('${_ansi.red}$log${_ansi.none}');
+    }
+  });
+  return logger;
+}();
 
 const compilerOpts = 'compiler-opts';
 const ignoreSourceErrors = 'ignore-source-errors';
@@ -32,21 +46,21 @@ Future<void> main(List<String> args) async {
   // Parses the cmd args. This will print usage and exit if --help was passed.
   final argResult = getArgResults(args);
 
-  final ffigen = FfiGen(logLevel: _parseLogLevel(argResult));
+  Logger.root.level = _parseLogLevel(argResult);
 
   // Create a config object.
-  Config config;
+  FfiGen config;
   try {
     config = getConfig(argResult, await findPackageConfig(Directory.current));
   } on FormatException {
     _logger.severe('Please fix configuration errors and re-run the tool.');
     exit(1);
   }
 
-  ffigen.run(config);
+  config.generate(_logger);
 }
 
-Config getConfig(ArgResults result, PackageConfig? packageConfig) {
+FfiGen getConfig(ArgResults result, PackageConfig? packageConfig) {
   _logger.info('Running in ${Directory.current}');
   YamlConfig config;
 

pkgs/ffigen/lib/src/ffigen.dart

@@ -7,50 +7,41 @@ import 'dart:io';
 import 'package:cli_util/cli_logging.dart' show Ansi;
 import 'package:logging/logging.dart';
 
-import 'config_provider.dart' show Config;
+import 'config_provider.dart' show FfiGen;
 import 'header_parser.dart' show parse;
 
-final _logger = Logger('ffigen.ffigen');
 final _ansi = Ansi(Ansi.terminalSupportsAnsi);
 
-class FfiGen {
-  FfiGen({Level logLevel = Level.INFO}) {
-    Logger.root.level = logLevel;
-    Logger.root.onRecord.listen((record) {
-      final levelStr = '[${record.level.name}]'.padRight(9);
-      _printLog('$levelStr: ${record.message}', record.level);
-    });
-  }
-
+extension FfiGenGenerator on FfiGen {
   /// Runs the entire generation pipeline for the given config.
-  void run(Config config) {
+  void generate(Logger logger) {
     // Parse the bindings according to config object provided.
-    final library = parse(config);
+    final library = parse(this);
 
     // Generate files for the parsed bindings.
-    final gen = File(config.output.toFilePath());
-    library.generateFile(gen, format: config.formatOutput);
-    _logger.info(
+    final gen = File(output.toFilePath());
+    library.generateFile(gen, format: formatOutput);
+    logger.info(
       _successPen('Finished, Bindings generated in ${gen.absolute.path}'),
     );
 
-    final objCGen = File(config.outputObjC.toFilePath());
+    final objCGen = File(outputObjC.toFilePath());
     if (library.generateObjCFile(objCGen)) {
-      _logger.info(
+      logger.info(
         _successPen(
           'Finished, Objective C bindings generated '
           'in ${objCGen.absolute.path}',
         ),
       );
     }
 
-    if (config.symbolFile != null) {
-      final symbolFileGen = File(config.symbolFile!.output.toFilePath());
+    if (symbolFile != null) {
+      final symbolFileGen = File(symbolFile!.output.toFilePath());
       library.generateSymbolOutputFile(
         symbolFileGen,
-        config.symbolFile!.importPath.toString(),
+        symbolFile!.importPath.toString(),
       );
-      _logger.info(
+      logger.info(
         _successPen(
           'Finished, Symbol Output generated in '
           '${symbolFileGen.absolute.path}',
@@ -59,15 +50,5 @@ class FfiGen {
     }
   }
 
-  static void _printLog(String log, Level level) {
-    // Prints text in red for Severe logs only.
-    if (level < Level.SEVERE) {
-      print(log);
-    } else {
-      print(_errorPen(log));
-    }
-  }
-
   static String _successPen(String str) => '${_ansi.green}$str${_ansi.none}';
-  static String _errorPen(String str) => '${_ansi.red}$str${_ansi.none}';
 }

pkgs/ffigen/lib/src/header_parser/data.dart

@@ -5,16 +5,16 @@
 import 'dart:ffi';
 
 import '../code_generator.dart' show Constant, ObjCBuiltInFunctions;
-import '../config_provider.dart' show Config;
+import '../config_provider.dart' show FfiGen;
 import 'clang_bindings/clang_bindings.dart' show Clang;
 
 import 'utils.dart';
 
 /// Holds all Global shared variables.
 
 /// Holds configurations.
-Config get config => _config;
-late Config _config;
+FfiGen get config => _config;
+late FfiGen _config;
 
 /// Holds clang functions.
 Clang get clang => _clang;
@@ -48,7 +48,7 @@ late ObjCBuiltInFunctions _objCBuiltInFunctions;
 /// invalid generated bindings.
 bool hasSourceErrors = false;
 
-void initializeGlobals({required Config config}) {
+void initializeGlobals({required FfiGen config}) {
   _config = config;
   _clang = Clang(DynamicLibrary.open(config.libclangDylib.toFilePath()));
   _incrementalNamer = IncrementalNamer();

pkgs/ffigen/lib/src/header_parser/parser.dart

@@ -30,7 +30,7 @@ import 'translation_unit_parser.dart';
 import 'utils.dart';
 
 /// Main entrypoint for header_parser.
-Library parse(Config config) {
+Library parse(FfiGen config) {
   initParser(config);
 
   return Library.fromConfig(
@@ -46,13 +46,13 @@ Library parse(Config config) {
 final _logger = Logger('ffigen.header_parser.parser');
 
 /// Initializes parser, clears any previous values.
-void initParser(Config c) {
+void initParser(FfiGen c) {
   // Initialize global variables.
   initializeGlobals(config: c);
 }
 
 /// Parses source files and returns the bindings.
-List<Binding> parseToBindings(Config c) {
+List<Binding> parseToBindings(FfiGen c) {
   final index = clang.clang_createIndex(0, 0);
 
   Pointer<Pointer<Utf8>> clangCmdArgs = nullptr;
@@ -170,7 +170,7 @@ List<String> _findObjectiveCSysroot() => [
 ];
 
 @visibleForTesting
-List<Binding> transformBindings(Config config, List<Binding> bindings) {
+List<Binding> transformBindings(FfiGen config, List<Binding> bindings) {
   visit(CopyMethodsFromSuperTypesVisitation(), bindings);
   visit(FixOverriddenMethodsVisitation(), bindings);
   visit(FillMethodDependenciesVisitation(), bindings);