Fix lints in package:ffigen (#1328)

Author: liamappelbe

pkgs/ffigen/analysis_options.yaml

@@ -19,7 +19,6 @@ analyzer:
   language:
     strict-casts: true
     strict-inference: true
-    strict-raw-types: false #TODO(https://github.com/dart-lang/native/issues/1281): Fix.
 
 linter:
   rules:
@@ -28,18 +27,3 @@ linter:
     prefer_final_locals: true
     prefer_final_in_for_each: true
     use_super_parameters: true
-    always_declare_return_types: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    avoid_dynamic_calls: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    comment_references: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    constant_identifier_names: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    library_annotations: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    lines_longer_than_80_chars: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    omit_local_variable_types: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix.
-    only_throw_errors: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    prefer_asserts_in_initializer_lists: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    prefer_const_constructors: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix.
-    prefer_relative_imports: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    prefer_single_quotes: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix.
-    type_annotate_public_apis: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    unnecessary_parenthesis: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix
-    unreachable_from_main: false # TODO(https://github.com/dart-lang/native/issues/1281): Fix

pkgs/ffigen/example/libclang-example/custom_import.dart

@@ -6,8 +6,8 @@ import 'dart:ffi';
 
 /// Represents a native unsigned pointer-sized integer in C.
 ///
-/// [UintPtr] is not constructible in the Dart code and serves purely as marker in
-/// type signatures.
+/// [UintPtr] is not constructible in the Dart code and serves purely as marker
+/// in type signatures.
 @AbiSpecificIntegerMapping({
   Abi.androidArm: Uint32(),
   Abi.androidArm64: Uint64(),
@@ -34,8 +34,8 @@ final class UintPtr extends AbiSpecificInteger {
 
 /// `unsigned long` in C.
 ///
-/// [UnsignedLong] is not constructible in the Dart code and serves purely as marker in
-/// type signatures.
+/// [UnsignedLong] is not constructible in the Dart code and serves purely as
+/// marker in type signatures.
 @AbiSpecificIntegerMapping({
   Abi.androidArm: Uint32(),
   Abi.androidArm64: Uint64(),

pkgs/ffigen/example/shared_bindings/generate.dart

@@ -26,7 +26,7 @@ void main() {
     final res = runFfigenForConfig(sdkPath, configPath);
     print(res.stdout.toString());
     if (res.exitCode != 0) {
-      throw Exception("Some error occurred: ${res.stderr.toString()}");
+      throw Exception('Some error occurred: ${res.stderr.toString()}');
     }
   }
 }

pkgs/ffigen/lib/src/code_generator.dart

@@ -2,7 +2,7 @@
 // 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.
 
-/// Generates FFI bindings for a given [Library].
+/// Generates FFI bindings for a given Library.
 library code_generator;
 
 export 'code_generator/binding.dart';

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

@@ -35,7 +35,7 @@ abstract class Binding {
   /// Converts a Binding to its actual string representation.
   ///
   /// Note: This does not print the typedef dependencies.
-  /// Must call [getTypedefDependencies] first.
+  /// Must call getTypedefDependencies first.
   BindingString toBindingString(Writer w);
 
   /// Returns the Objective C bindings, if any.

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

@@ -2,7 +2,7 @@
 // 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:ffigen/src/code_generator.dart';
+import '../code_generator.dart';
 
 import 'binding_string.dart';
 import 'utils.dart';

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

@@ -82,7 +82,8 @@ class EnumClass extends BindingType {
   /// See [scanForDuplicates] and [writeUniqueMembers].
   final Set<EnumConstant> uniqueMembers = {};
 
-  /// Returns a string to declare the enum member and any documentation it may have had.
+  /// Returns a string to declare the enum member and any documentation it may
+  /// have had.
   String formatValue(EnumConstant ec) {
     final buffer = StringBuffer();
     final enumValueName = namer.makeUnique(ec.name);
@@ -100,8 +101,9 @@ class EnumClass extends BindingType {
   ///
   /// Since all enum values in Dart are distinct, these duplicates do not
   /// get their own values in Dart. Rather, they are aliases of the original
-  /// value. For example, if a native enum has 2 constants with a value of 10, only
-  /// one enum value will be generated in Dart, and the other will be set equal to it.
+  /// value. For example, if a native enum has 2 constants with a value of 10,
+  /// only one enum value will be generated in Dart, and the other will be set
+  /// equal to it.
   void scanForDuplicates() {
     uniqueMembers.clear();
     uniqueToDuplicates.clear();
@@ -126,13 +128,14 @@ class EnumClass extends BindingType {
   ///
   /// Eg, C: `apple = 1`, Dart: `apple(1)`
   void writeUniqueMembers(StringBuffer s) {
-    s.writeAll(uniqueMembers.map(formatValue), ",\n");
+    s.writeAll(uniqueMembers.map(formatValue), ',\n');
     if (uniqueMembers.isNotEmpty) s.write(';\n');
   }
 
   /// Writes alias declarations for all members with duplicate values.
   ///
-  /// Eg, C: `banana = 10, yellow_fruit = 10`. Dart: `static const yellow_fruit = banana`.
+  /// Eg, C: `banana = 10, yellow_fruit = 10`.
+  /// Dart: `static const yellow_fruit = banana`.
   void writeDuplicateMembers(StringBuffer s) {
     if (duplicateToOriginal.isEmpty) return;
     for (final entry in duplicateToOriginal.entries) {
@@ -143,48 +146,49 @@ class EnumClass extends BindingType {
       final originalName = enumNames[original]!;
       enumNames[duplicate] = duplicateName;
       if (duplicate.dartDoc != null) {
-        s.write("$depth/// ");
-        s.writeAll(duplicate.dartDoc!.split("\n"), "\n$depth/// ");
-        s.write("\n");
+        s.write('$depth/// ');
+        s.writeAll(duplicate.dartDoc!.split('\n'), '\n$depth/// ');
+        s.write('\n');
       }
-      s.write("${depth}static const $duplicateName = $originalName;\n");
+      s.write('${depth}static const $duplicateName = $originalName;\n');
     }
   }
 
   /// Writes the constructor for the enum.
   ///
   /// Always accepts an integer value to match the native value.
   void writeConstructor(StringBuffer s) {
-    s.write("${depth}final int value;\n");
-    s.write("${depth}const $name(this.value);\n");
+    s.write('${depth}final int value;\n');
+    s.write('${depth}const $name(this.value);\n');
   }
 
   /// Overrides [Enum.toString] so all aliases are included, if any.
   ///
-  /// If a native enum has two members with the same value, they are functionally
-  /// identical, and should be represented as such. This method overrides [toString]
-  /// to include all duplicate members in the same message.
+  /// If a native enum has two members with the same value, they are
+  /// functionally identical, and should be represented as such. This method
+  /// overrides [toString] to include all duplicate members in the same message.
   void writeToStringOverride(StringBuffer s) {
     if (duplicateToOriginal.isEmpty) return;
-    s.write("$depth@override\n");
-    s.write("${depth}String toString() {\n");
+    s.write('$depth@override\n');
+    s.write('${depth}String toString() {\n');
     for (final entry in uniqueToDuplicates.entries) {
-      // [!] All enum values were given a name when their declarations were generated
+      // [!] All enum values were given a name when their declarations were
+      // generated.
       final unique = entry.key;
       final originalName = enumNames[unique]!;
       final duplicates = entry.value;
       if (duplicates.isEmpty) continue;
       final allDuplicates = [
         for (final duplicate in [unique] + duplicates)
-          "$name.${enumNames[duplicate]!}",
-      ].join(", ");
+          '$name.${enumNames[duplicate]!}',
+      ].join(', ');
       s.write(
         '$depth$depth'
         'if (this == $originalName) return "$allDuplicates";\n',
       );
     }
-    s.write("${depth * 2}return super.toString();\n");
-    s.write("$depth}");
+    s.write('${depth * 2}return super.toString();\n');
+    s.write('$depth}');
   }
 
   /// Writes the DartDoc string for this enum.
@@ -194,23 +198,24 @@ class EnumClass extends BindingType {
     }
   }
 
-  /// Writes a sealed class when no members exist, because Dart enums cannot be empty.
+  /// Writes a sealed class when no members exist, because Dart enums cannot be
+  /// empty.
   void writeEmptyEnum(StringBuffer s) {
-    s.write("sealed class $name { }\n");
+    s.write('sealed class $name { }\n');
   }
 
   /// Writes a static function that maps integers to enum values.
   void writeFromValue(StringBuffer s) {
-    s.write("${depth}static $name fromValue(int value) => switch (value) {\n");
+    s.write('${depth}static $name fromValue(int value) => switch (value) {\n');
     for (final member in uniqueMembers) {
       final memberName = enumNames[member]!;
-      s.write("$depth$depth${member.value} => $memberName,\n");
+      s.write('$depth$depth${member.value} => $memberName,\n');
     }
     s.write(
       '$depth${depth}_ => '
       'throw ArgumentError("Unknown value for $name: \$value"),\n',
     );
-    s.write("$depth};\n");
+    s.write('$depth};\n');
   }
 
   bool get _isBuiltIn =>
@@ -220,7 +225,7 @@ class EnumClass extends BindingType {
   BindingString toBindingString(Writer w) {
     final s = StringBuffer();
     if (_isBuiltIn) {
-      return BindingString(type: BindingStringType.enum_, string: '');
+      return const BindingString(type: BindingStringType.enum_, string: '');
     }
     scanForDuplicates();
 
@@ -230,13 +235,13 @@ class EnumClass extends BindingType {
     } else {
       s.write('enum $name {\n');
       writeUniqueMembers(s);
-      s.write("\n");
+      s.write('\n');
       writeDuplicateMembers(s);
-      s.write("\n");
+      s.write('\n');
       writeConstructor(s);
-      s.write("\n");
+      s.write('\n');
       writeFromValue(s);
-      s.write("\n");
+      s.write('\n');
       writeToStringOverride(s);
       s.write('}\n\n');
     }
@@ -284,7 +289,7 @@ class EnumClass extends BindingType {
     String value, {
     required bool objCRetain,
   }) =>
-      "$value.value";
+      '$value.value';
 
   @override
   String convertFfiDartTypeToDartType(
@@ -293,7 +298,7 @@ class EnumClass extends BindingType {
     required bool objCRetain,
     String? objCEnclosingClass,
   }) =>
-      "${getDartType(w)}.fromValue($value)";
+      '${getDartType(w)}.fromValue($value)';
 }
 
 /// Represents a single value in an enum.

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

@@ -2,8 +2,8 @@
 // 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:ffigen/src/code_generator.dart';
-import 'package:ffigen/src/config_provider/config_types.dart';
+import '../code_generator.dart';
+import '../config_provider/config_types.dart';
 
 import 'binding_string.dart';
 import 'utils.dart';
@@ -17,7 +17,8 @@ import 'writer.dart';
 /// int sum(int a, int b);
 /// ```
 ///
-/// The generated Dart code for this function (without `FfiNative`) is as follows.
+/// The generated Dart code for this function (without `FfiNative`) is as
+/// follows.
 ///
 /// ```dart
 /// int sum(int a, int b) {
@@ -126,10 +127,11 @@ class Func extends LookUpBinding {
           .map((p) => '${p.type.getDartType(w)} ${p.name},\n')
           .join('');
 
-      final argString = functionType.dartTypeParameters
-          .map((p) =>
-              '${p.type.convertDartTypeToFfiDartType(w, p.name, objCRetain: false)},\n')
-          .join('');
+      final argString = functionType.dartTypeParameters.map((p) {
+        final type =
+            p.type.convertDartTypeToFfiDartType(w, p.name, objCRetain: false);
+        return '$type,\n';
+      }).join('');
       funcImplCall = functionType.returnType.convertFfiDartTypeToDartType(
         w,
         '$funcVarName($argString)',
@@ -166,8 +168,8 @@ $dartReturnType $enclosingFuncName($dartArgDeclString) => $funcImplCall;
       if (exposeSymbolAddress) {
         // Add to SymbolAddress in writer.
         w.symbolAddressWriter.addNativeSymbol(
-          type:
-              '${w.ffiLibraryPrefix}.Pointer<${w.ffiLibraryPrefix}.NativeFunction<$cType>>',
+          type: '${w.ffiLibraryPrefix}.Pointer<'
+              '${w.ffiLibraryPrefix}.NativeFunction<$cType>>',
           name: name,
         );
       }
@@ -186,8 +188,8 @@ $dartReturnType $enclosingFuncName($dartArgDeclString) {
       if (exposeSymbolAddress) {
         // Add to SymbolAddress in writer.
         w.symbolAddressWriter.addSymbol(
-          type:
-              '${w.ffiLibraryPrefix}.Pointer<${w.ffiLibraryPrefix}.NativeFunction<$cType>>',
+          type: '${w.ffiLibraryPrefix}.Pointer<'
+              '${w.ffiLibraryPrefix}.NativeFunction<$cType>>',
           name: name,
           ptrName: funcPointerName,
         );

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

@@ -2,8 +2,8 @@
 // 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:ffigen/src/code_generator.dart';
-import 'package:ffigen/src/code_generator/utils.dart';
+import '../code_generator.dart';
+import 'utils.dart';
 
 import 'writer.dart';
 
@@ -30,11 +30,11 @@ class FunctionType extends Type {
     String? varArgPack;
     if (varArgWrapper != null && varArgParameters.isNotEmpty) {
       final varArgPackBuf = StringBuffer();
-      varArgPackBuf.write("$varArgWrapper<(");
-      varArgPackBuf.write((varArgParameters).map<String>((p) {
+      varArgPackBuf.write('$varArgWrapper<(');
+      varArgPackBuf.write(varArgParameters.map<String>((p) {
         return '${typeToString(p.type)} ${writeArgumentNames ? p.name : ""}';
       }).join(', '));
-      varArgPackBuf.write(",)>");
+      varArgPackBuf.write(',)>');
       varArgPack = varArgPackBuf.toString();
     }
 
@@ -108,7 +108,7 @@ class FunctionType extends Type {
       return;
     }
     final paramNamer = UniqueNamer({});
-    for (int i = 0; i < parameters.length; i++) {
+    for (var i = 0; i < parameters.length; i++) {
       final finalName = paramNamer.makeUnique(names[i]);
       parameters[i] = Parameter(
         type: parameters[i].type,
@@ -124,9 +124,7 @@ class NativeFunc extends Type {
   // Either a FunctionType or a Typealias of a FunctionType.
   final Type _type;
 
-  NativeFunc(this._type) {
-    assert(_type is FunctionType || _type is Typealias);
-  }
+  NativeFunc(this._type) : assert(_type is FunctionType || _type is Typealias);
 
   FunctionType get type {
     if (_type is Typealias) {

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

@@ -76,21 +76,21 @@ class Global extends LookUpBinding {
       final pointerName =
           w.wrapperLevelUniqueNamer.makeUnique('_$globalVarName');
 
-      s.write(
-          "late final ${w.ffiLibraryPrefix}.Pointer<$cType> $pointerName = ${w.lookupFuncIdentifier}<$cType>('$originalName');\n\n");
+      s.write('late final ${w.ffiLibraryPrefix}.Pointer<$cType> $pointerName = '
+          "${w.lookupFuncIdentifier}<$cType>('$originalName');\n\n");
       final baseTypealiasType = type.typealiasType;
       if (baseTypealiasType is Compound) {
         if (baseTypealiasType.isOpaque) {
-          s.write(
-              '${w.ffiLibraryPrefix}.Pointer<$cType> get $globalVarName => $pointerName;\n\n');
+          s.write('${w.ffiLibraryPrefix}.Pointer<$cType> get $globalVarName =>'
+              ' $pointerName;\n\n');
         } else {
           s.write('$dartType get $globalVarName => $pointerName.ref;\n\n');
         }
       } else {
         s.write('$dartType get $globalVarName => $pointerName.value;\n\n');
         if (!constant) {
-          s.write(
-              'set $globalVarName($dartType value) => $pointerName.value = value;\n\n');
+          s.write('set $globalVarName($dartType value) =>'
+              '$pointerName.value = value;\n\n');
         }
       }