Fix generated asset/assetId property for ffi-native

CHANGELOG.md

@@ -10,6 +10,7 @@
   generate a typedef for the `Function`.
 - Use Dart wrapper types in args and returns of ObjCBlocks.
 - Bump min SDK version to 3.2.0-114.0.dev.
+- Renamed `asset` to `assetId` for `ffi-native`  
 
 # 9.0.1
 

README.md

@@ -543,7 +543,7 @@ type-map:
 
 ```yaml
 ffi-native:
-  asset: 'myasset' # Optional.
+  assetId: 'myasset' # Optional.
 ```
   </td>
   </tr>

example/ffinative/config.yaml

@@ -2,7 +2,7 @@
 
 name: NativeLibrary
 ffi-native:
-  # asset: 'assetname' # (optional)
+  assetId: 'assetname' # (optional)
 description: Bindings to `headers/example.h`.
 output: 'generated_bindings.dart'
 headers:

example/ffinative/generated_bindings.dart

@@ -7,36 +7,40 @@
 import 'dart:ffi' as ffi;
 
 /// Adds 2 integers.
-@ffi.Native<ffi.Int Function(ffi.Int, ffi.Int)>(symbol: 'sum')
+@ffi.Native<ffi.Int Function(ffi.Int, ffi.Int)>(
+    symbol: 'sum', assetId: 'assetname')
 external int sum(
   int a,
   int b,
 );
 
 /// Subtracts 2 integers.
-@ffi.Native<ffi.Int Function(ffi.Int, ffi.Int)>(symbol: 'subtract')
+@ffi.Native<ffi.Int Function(ffi.Int, ffi.Int)>(
+    symbol: 'subtract', assetId: 'assetname')
 external int subtract(
   int a,
   int b,
 );
 
 /// Multiplies 2 integers, returns pointer to an integer,.
-@ffi.Native<ffi.Pointer<ffi.Int> Function(ffi.Int, ffi.Int)>(symbol: 'multiply')
+@ffi.Native<ffi.Pointer<ffi.Int> Function(ffi.Int, ffi.Int)>(
+    symbol: 'multiply', assetId: 'assetname')
 external ffi.Pointer<ffi.Int> multiply(
   int a,
   int b,
 );
 
 /// Divides 2 integers, returns pointer to a float.
-@ffi.Native<ffi.Pointer<ffi.Float> Function(ffi.Int, ffi.Int)>(symbol: 'divide')
+@ffi.Native<ffi.Pointer<ffi.Float> Function(ffi.Int, ffi.Int)>(
+    symbol: 'divide', assetId: 'assetname')
 external ffi.Pointer<ffi.Float> divide(
   int a,
   int b,
 );
 
 /// Divides 2 floats, returns a pointer to double.
 @ffi.Native<ffi.Pointer<ffi.Double> Function(ffi.Float, ffi.Float)>(
-    symbol: 'dividePrecision')
+    symbol: 'dividePrecision', assetId: 'assetname')
 external ffi.Pointer<ffi.Double> dividePrecision(
   double a,
   double b,

ffigen.schema.json

@@ -418,12 +418,12 @@
           "type": "object",
           "additionalProperties": false,
           "properties": {
-            "asset": {
+            "assetId": {
               "type": "string"
             }
           },
           "required": [
-            "asset"
+            "assetId"
           ]
         }
       ]

lib/src/code_generator/func.dart

@@ -111,8 +111,8 @@ class Func extends LookUpBinding {
         functionType.getFfiDartType(w, writeArgumentNames: false);
 
     if (ffiNativeConfig.enabled) {
-      final assetString = ffiNativeConfig.asset != null
-          ? ", asset: '${ffiNativeConfig.asset}'"
+      final assetString = ffiNativeConfig.assetId != null
+          ? ", assetId: '${ffiNativeConfig.assetId}'"
           : '';
       final isLeafString = isLeaf ? ', isLeaf: true' : '';
       s.write(

lib/src/config_provider/config_types.dart

@@ -384,9 +384,9 @@ class ObjCModulePrefixer {
 
 class FfiNativeConfig {
   final bool enabled;
-  final String? asset;
+  final String? assetId;
 
-  const FfiNativeConfig({required this.enabled, this.asset});
+  const FfiNativeConfig({required this.enabled, this.assetId});
 }
 
 class SymbolFile {

lib/src/config_provider/spec_utils.dart

@@ -602,6 +602,6 @@ FfiNativeConfig ffiNativeExtractor(dynamic yamlConfig) {
   final yamlMap = yamlConfig as Map?;
   return FfiNativeConfig(
     enabled: true,
-    asset: yamlMap?[strings.ffiNativeAsset] as String?,
+    assetId: yamlMap?[strings.ffiNativeAsset] as String?,
   );
 }

lib/src/strings.dart

@@ -263,7 +263,7 @@ const doubleNaN = 'double.nan';
 const dartHandleUsr = 'c:@S@_Dart_Handle';
 
 const ffiNative = 'ffi-native';
-const ffiNativeAsset = 'asset';
+const ffiNativeAsset = 'assetId';
 
 Directory? _tmpDir;
 

test/ffi_native_test/.gitignore

@@ -0,0 +1,3 @@
+# Ignore files generated by clang on windows.
+native_test.exp
+native_test.lib

test/ffi_native_test/_expected_ffi_native_test_bindings.dart

@@ -0,0 +1,122 @@
+// ignore_for_file: camel_case_types, non_constant_identifier_names
+
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
+// ignore_for_file: type=lint
+import 'dart:ffi' as ffi;
+
+@ffi.Native<ffi.Bool Function(ffi.Bool)>(
+    symbol: 'Function1Bool', assetId: 'native_test')
+external bool Function1Bool(
+  bool x,
+);
+
+@ffi.Native<ffi.Uint8 Function(ffi.Uint8)>(
+    symbol: 'Function1Uint8', assetId: 'native_test')
+external int Function1Uint8(
+  int x,
+);
+
+@ffi.Native<ffi.Uint16 Function(ffi.Uint16)>(
+    symbol: 'Function1Uint16', assetId: 'native_test')
+external int Function1Uint16(
+  int x,
+);
+
+@ffi.Native<ffi.Uint32 Function(ffi.Uint32)>(
+    symbol: 'Function1Uint32', assetId: 'native_test')
+external int Function1Uint32(
+  int x,
+);
+
+@ffi.Native<ffi.Uint64 Function(ffi.Uint64)>(
+    symbol: 'Function1Uint64', assetId: 'native_test')
+external int Function1Uint64(
+  int x,
+);
+
+@ffi.Native<ffi.Int8 Function(ffi.Int8)>(
+    symbol: 'Function1Int8', assetId: 'native_test')
+external int Function1Int8(
+  int x,
+);
+
+@ffi.Native<ffi.Int16 Function(ffi.Int16)>(
+    symbol: 'Function1Int16', assetId: 'native_test')
+external int Function1Int16(
+  int x,
+);
+
+@ffi.Native<ffi.Int32 Function(ffi.Int32)>(
+    symbol: 'Function1Int32', assetId: 'native_test')
+external int Function1Int32(
+  int x,
+);
+
+@ffi.Native<ffi.Int64 Function(ffi.Int64)>(
+    symbol: 'Function1Int64', assetId: 'native_test')
+external int Function1Int64(
+  int x,
+);
+
+@ffi.Native<ffi.IntPtr Function(ffi.IntPtr)>(
+    symbol: 'Function1IntPtr', assetId: 'native_test')
+external int Function1IntPtr(
+  int x,
+);
+
+@ffi.Native<ffi.UintPtr Function(ffi.UintPtr)>(
+    symbol: 'Function1UintPtr', assetId: 'native_test')
+external int Function1UintPtr(
+  int x,
+);
+
+@ffi.Native<ffi.Float Function(ffi.Float)>(
+    symbol: 'Function1Float', assetId: 'native_test')
+external double Function1Float(
+  double x,
+);
+
+@ffi.Native<ffi.Double Function(ffi.Double)>(
+    symbol: 'Function1Double', assetId: 'native_test')
+external double Function1Double(
+  double x,
+);
+
+@ffi.Native<ffi.Pointer<Struct1> Function()>(
+    symbol: 'getStruct1', assetId: 'native_test')
+external ffi.Pointer<Struct1> getStruct1();
+
+@ffi.Native<Struct3 Function(ffi.Int, ffi.Int, ffi.Int)>(
+    symbol: 'Function1StructReturnByValue', assetId: 'native_test')
+external Struct3 Function1StructReturnByValue(
+  int a,
+  int b,
+  int c,
+);
+
+@ffi.Native<ffi.Int Function(Struct3)>(
+    symbol: 'Function1StructPassByValue', assetId: 'native_test')
+external int Function1StructPassByValue(
+  Struct3 sum_a_b_c,
+);
+
+final class Struct1 extends ffi.Struct {
+  @ffi.Int8()
+  external int a;
+
+  @ffi.Array.multi([3, 1, 2])
+  external ffi.Array<ffi.Array<ffi.Array<ffi.Int32>>> data;
+}
+
+final class Struct3 extends ffi.Struct {
+  @ffi.Int()
+  external int a;
+
+  @ffi.Int()
+  external int b;
+
+  @ffi.Int()
+  external int c;
+}

test/ffi_native_test/build_test_dylib.dart

@@ -0,0 +1,129 @@
+// Copyright (c) 2020, 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.
+
+/// =======================================================================
+/// ==== Script to generate dynamic library for native_function_tests =====
+/// =======================================================================
+/// This Script effectively calls the following (but user can provide
+/// command line args which will replace the defaults shown below)-
+///
+/// Linux:
+/// ```
+/// clang -shared -fpic native_test.c -o native_test.so
+/// ```
+/// MacOS:
+/// ```
+/// clang -shared -fpic native_test.c -o native_test.dylib
+/// ```
+/// Windows:
+/// ```
+/// call clang -shared native_test.c -o native_test.dll -Wl,"/DEF:native_test.def"
+/// del native_test.exp
+/// del native_test.lib
+/// ```
+/// =======================================================================
+/// =======================================================================
+/// =======================================================================
+
+import 'dart:io';
+
+const macOS = 'macos';
+const windows = 'windows';
+const linux = 'linux';
+
+Map<String, Options> platformOptions = {
+  linux: Options(
+    outputfilename: 'native_test.so',
+    sharedFlag: '-shared',
+    inputHeader: 'native_test.c',
+    fPIC: '-fpic',
+  ),
+  windows: Options(
+    outputfilename: 'native_test.dll',
+    sharedFlag: '-shared',
+    inputHeader: 'native_test.c',
+    moduleDefPath: '-Wl,/DEF:native_test.def',
+  ),
+  macOS: Options(
+    outputfilename: 'native_test.dylib',
+    sharedFlag: '-shared',
+    inputHeader: 'native_test.c',
+    fPIC: '-fpic',
+  ),
+};
+
+void main(List<String> arguments) {
+  print('Building Dynamic Library for Native Tests... ');
+  final options = getPlatformOptions()!;
+
+  // Run clang compiler to generate the dynamic library.
+  final processResult = runClangProcess(options);
+  printSuccess(processResult, options);
+}
+
+/// Calls the clang compiler.
+ProcessResult runClangProcess(Options options) {
+  final result = Process.runSync(
+    'clang',
+    [
+      options.sharedFlag,
+      options.fPIC,
+      options.inputHeader,
+      '-o',
+      options.outputfilename,
+      options.moduleDefPath,
+      '-Wno-nullability-completeness',
+    ],
+  );
+  return result;
+}
+
+/// Prints success message (or process error if any).
+void printSuccess(ProcessResult result, Options options) {
+  print(result.stdout);
+  if ((result.stderr as String).isEmpty) {
+    print('Generated file: ${options.outputfilename}');
+  } else {
+    print(result.stderr);
+  }
+}
+
+/// Get options based on current platform.
+Options? getPlatformOptions() {
+  if (Platform.isMacOS) {
+    return platformOptions[macOS];
+  } else if (Platform.isWindows) {
+    return platformOptions[windows];
+  } else if (Platform.isLinux) {
+    return platformOptions[linux];
+  } else {
+    throw Exception('Unknown Platform.');
+  }
+}
+
+/// Hold options which would be passed to clang.
+class Options {
+  /// Name of dynamic library to generate.
+  final String outputfilename;
+
+  /// Tells compiler to generate a shared library.
+  final String sharedFlag;
+
+  /// Flag for generating Position Independant Code (Not used on windows).
+  final String fPIC;
+
+  /// Input file.
+  final String inputHeader;
+
+  /// Path to `.def` file containing symbols to export, windows use only.
+  final String moduleDefPath;
+
+  Options({
+    required this.outputfilename,
+    required this.sharedFlag,
+    required this.inputHeader,
+    this.fPIC = '',
+    this.moduleDefPath = '',
+  });
+}