[ffigen] Move mutable globals to Context (#2452)

Author: liamappelbe

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

@@ -4,30 +4,30 @@
 
 import 'dart:io';
 
-import 'package:logging/logging.dart';
 import 'package:yaml_edit/yaml_edit.dart';
 
 import '../code_generator.dart';
 import '../code_generator/utils.dart';
 import '../config_provider/config.dart' show FfiGen;
 import '../config_provider/config_types.dart';
+import '../context.dart';
 
 import 'writer.dart';
 
-final _logger = Logger('ffigen.library');
-
 /// Container for all Bindings.
 class Library {
   /// List of bindings in this library.
   final List<Binding> bindings;
 
   final Writer writer;
+  final Context context;
 
-  Library._(this.bindings, this.writer);
+  Library._(this.bindings, this.writer, this.context);
 
   static Library fromConfig({
     required FfiGen config,
     required List<Binding> bindings,
+    required Context context,
   }) => Library(
     name: config.wrapperName,
     description: config.wrapperDocComment,
@@ -39,6 +39,7 @@ class Library {
     nativeEntryPoints: config.entryPoints
         .map((uri) => uri.toFilePath())
         .toList(),
+    context: context,
   );
 
   factory Library({
@@ -50,6 +51,7 @@ class Library {
     List<LibraryImport> libraryImports = const <LibraryImport>[],
     bool silenceEnumWarning = false,
     List<String> nativeEntryPoints = const <String>[],
+    required Context context,
   }) {
     // Seperate bindings which require lookup.
     final lookupBindings = <LookUpBinding>[];
@@ -84,9 +86,10 @@ class Library {
       generateForPackageObjectiveC: generateForPackageObjectiveC,
       silenceEnumWarning: silenceEnumWarning,
       nativeEntryPoints: nativeEntryPoints,
+      context: context,
     );
 
-    return Library._(bindings, writer);
+    return Library._(bindings, writer, context);
   }
 
   /// Generates [file] by generating C bindings.
@@ -102,7 +105,9 @@ class Library {
         file.absolute.path,
       ], workingDirectory: file.parent.absolute.path);
       if (result.exitCode != 0) {
-        _logger.severe('Formatting failed\n${result.stdout}\n${result.stderr}');
+        context.logger.severe(
+          'Formatting failed\n${result.stdout}\n${result.stderr}',
+        );
       }
     }
   }

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

@@ -3,26 +3,27 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import '../code_generator.dart';
-import '../header_parser/data.dart' show bindingsIndex;
+
+import '../context.dart';
 import '../visitor/ast.dart';
 
 import 'binding_string.dart';
 import 'unique_namer.dart';
 import 'writer.dart';
 
 class ObjCBlock extends BindingType {
-  final ObjCBuiltInFunctions builtInFunctions;
+  final Context context;
   final Type returnType;
   final List<Parameter> params;
   final bool returnsRetained;
   ObjCBlockWrapperFuncs? _blockWrappers;
   ObjCProtocolMethodTrampoline? protocolTrampoline;
 
-  factory ObjCBlock({
+  factory ObjCBlock(
+    Context context, {
     required Type returnType,
     required List<Parameter> params,
     required bool returnsRetained,
-    required ObjCBuiltInFunctions builtInFunctions,
   }) {
     final renamedParams = [
       for (var i = 0; i < params.length; ++i)
@@ -35,39 +36,40 @@ class ObjCBlock extends BindingType {
 
     final usr = _getBlockUsr(returnType, renamedParams, returnsRetained);
 
-    final oldBlock = bindingsIndex.getSeenObjCBlock(usr);
+    final oldBlock = context.bindingsIndex.getSeenObjCBlock(usr);
     if (oldBlock != null) {
       return oldBlock;
     }
 
     final block = ObjCBlock._(
+      context,
       usr: usr,
       name: _getBlockName(returnType, renamedParams.map((a) => a.type)),
       returnType: returnType,
       params: renamedParams,
       returnsRetained: returnsRetained,
-      builtInFunctions: builtInFunctions,
     );
-    bindingsIndex.addObjCBlockToSeen(usr, block);
+    context.bindingsIndex.addObjCBlockToSeen(usr, block);
 
     return block;
   }
 
-  ObjCBlock._({
+  ObjCBlock._(
+    this.context, {
     required String super.usr,
     required super.name,
     required this.returnType,
     required this.params,
     required this.returnsRetained,
-    required this.builtInFunctions,
   }) : super(originalName: name) {
     if (hasListener) {
-      _blockWrappers = builtInFunctions.getBlockTrampolines(this);
+      _blockWrappers = context.objCBuiltInFunctions.getBlockTrampolines(this);
     }
   }
 
   void fillProtocolTrampoline() {
-    protocolTrampoline ??= builtInFunctions.getProtocolMethodTrampoline(this);
+    protocolTrampoline ??= context.objCBuiltInFunctions
+        .getProtocolMethodTrampoline(this);
   }
 
   // Generates a human readable name for the block based on the args and return

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

@@ -3,13 +3,16 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import '../code_generator.dart';
+import '../context.dart';
 import '../visitor/ast.dart';
 
 import 'binding_string.dart';
 import 'utils.dart';
 import 'writer.dart';
 
 class ObjCCategory extends NoLookUpBinding with ObjCMethods {
+  @override
+  final Context context;
   final ObjCInterface parent;
   final ObjCInternalGlobal classObject;
 
@@ -21,7 +24,7 @@ class ObjCCategory extends NoLookUpBinding with ObjCMethods {
     String? name,
     required this.parent,
     super.dartDoc,
-    required this.builtInFunctions,
+    required this.context,
   }) : classObject = parent.classObject,
        super(name: name ?? originalName);
 
@@ -35,10 +38,8 @@ class ObjCCategory extends NoLookUpBinding with ObjCMethods {
   }
 
   @override
-  bool get isObjCImport => builtInFunctions.isBuiltInCategory(originalName);
-
-  @override
-  final ObjCBuiltInFunctions builtInFunctions;
+  bool get isObjCImport =>
+      context.objCBuiltInFunctions.isBuiltInCategory(originalName);
 
   @override
   void sort() => sortMethods();

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

@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import '../code_generator.dart';
+import '../context.dart';
 import '../header_parser/sub_parsers/api_availability.dart';
 import '../visitor/ast.dart';
 
@@ -11,6 +12,8 @@ import 'utils.dart';
 import 'writer.dart';
 
 class ObjCInterface extends BindingType with ObjCMethods {
+  @override
+  final Context context;
   ObjCInterface? superType;
   bool filled = false;
 
@@ -23,9 +26,6 @@ class ObjCInterface extends BindingType with ObjCMethods {
   final subtypes = <ObjCInterface>[];
   final ApiAvailability apiAvailability;
 
-  @override
-  final ObjCBuiltInFunctions builtInFunctions;
-
   // Filled by ListBindingsVisitation.
   bool generateAsStub = false;
 
@@ -35,27 +35,34 @@ class ObjCInterface extends BindingType with ObjCMethods {
     String? name,
     String? lookupName,
     super.dartDoc,
-    required this.builtInFunctions,
     required this.apiAvailability,
+    required this.context,
   }) : lookupName = lookupName ?? originalName,
        super(
          name:
-             builtInFunctions.getBuiltInInterfaceName(originalName) ??
+             context.objCBuiltInFunctions.getBuiltInInterfaceName(
+               originalName,
+             ) ??
              name ??
              originalName,
        ) {
     classObject = ObjCInternalGlobal(
       '_class_$originalName',
       (Writer w) => '${ObjCBuiltInFunctions.getClass.gen(w)}("$lookupName")',
     );
-    _isKindOfClass = builtInFunctions.getSelObject('isKindOfClass:');
-    _isKindOfClassMsgSend = builtInFunctions.getMsgSendFunc(BooleanType(), [
-      Parameter(
-        name: 'clazz',
-        type: PointerType(objCObjectType),
-        objCConsumed: false,
-      ),
-    ]);
+    _isKindOfClass = context.objCBuiltInFunctions.getSelObject(
+      'isKindOfClass:',
+    );
+    _isKindOfClassMsgSend = context.objCBuiltInFunctions.getMsgSendFunc(
+      BooleanType(),
+      [
+        Parameter(
+          name: 'clazz',
+          type: PointerType(objCObjectType),
+          objCConsumed: false,
+        ),
+      ],
+    );
   }
 
   void addProtocol(ObjCProtocol? proto) {
@@ -64,7 +71,8 @@ class ObjCInterface extends BindingType with ObjCMethods {
 
   @override
   bool get isObjCImport =>
-      builtInFunctions.getBuiltInInterfaceName(originalName) != null;
+      context.objCBuiltInFunctions.getBuiltInInterfaceName(originalName) !=
+      null;
 
   @override
   void sort() => sortMethods();

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

@@ -4,18 +4,23 @@
 
 import 'dart:collection';
 
-import 'package:logging/logging.dart';
-
-import '../code_generator.dart';
+import '../context.dart';
 import '../header_parser/sub_parsers/api_availability.dart';
 import '../visitor/ast.dart';
-
+import 'func.dart';
+import 'imports.dart';
+import 'native_type.dart';
+import 'objc_block.dart';
+import 'objc_built_in_functions.dart';
+import 'objc_interface.dart';
+import 'objc_nullable.dart';
+import 'pointer.dart';
+import 'type.dart';
+import 'typealias.dart';
 import 'unique_namer.dart';
 import 'utils.dart';
 import 'writer.dart';
 
-final _logger = Logger('ffigen.code_generator.objc_methods');
-
 mixin ObjCMethods {
   Map<String, ObjCMethod> _methods = <String, ObjCMethod>{};
   List<String> _order = <String>[];
@@ -26,7 +31,7 @@ mixin ObjCMethods {
 
   String get originalName;
   String get name;
-  ObjCBuiltInFunctions get builtInFunctions;
+  Context get context;
 
   void addMethod(ObjCMethod? method) {
     if (method == null) return;
@@ -67,7 +72,7 @@ mixin ObjCMethods {
 
     // Check the duplicate is the same method.
     if (!newMethod.sameAs(oldMethod)) {
-      _logger.severe(
+      context.logger.severe(
         'Duplicate methods with different signatures: '
         '$originalName.${newMethod.originalName}',
       );
@@ -189,7 +194,7 @@ class ObjCProperty extends AstNode {
 }
 
 class ObjCMethod extends AstNode {
-  final ObjCBuiltInFunctions builtInFunctions;
+  final Context context;
   final String? dartDoc;
   final String originalName;
   String name;
@@ -221,7 +226,7 @@ class ObjCMethod extends AstNode {
   }
 
   ObjCMethod({
-    required this.builtInFunctions,
+    required this.context,
     required this.originalName,
     required this.name,
     this.property,
@@ -234,7 +239,7 @@ class ObjCMethod extends AstNode {
     required this.apiAvailability,
     List<Parameter>? params_,
   }) : params = params_ ?? [],
-       selObject = builtInFunctions.getSelObject(originalName);
+       selObject = context.objCBuiltInFunctions.getSelObject(originalName);
 
   // Must be called after all params are added to the method.
   void finalizeParams() {
@@ -280,19 +285,19 @@ class ObjCMethod extends AstNode {
   bool get isInstanceMethod => !isClassMethod;
 
   void fillMsgSend() {
-    msgSend ??= builtInFunctions.getMsgSendFunc(returnType, params);
+    msgSend ??= context.objCBuiltInFunctions.getMsgSendFunc(returnType, params);
   }
 
   void fillProtocolBlock() {
     protocolBlock ??= ObjCBlock(
+      context,
       returnType: returnType,
       params: [
         // First arg of the protocol block is a void pointer that we ignore.
         Parameter(name: '_', type: PointerType(voidType), objCConsumed: false),
         ...params,
       ],
       returnsRetained: returnsRetained,
-      builtInFunctions: builtInFunctions,
     )..fillProtocolTrampoline();
   }