Is `type-map` supported by the ffigen API?

[Levi-Lesches]

Couldn't find any options for it in the docs or API reference, and searching for it in the API reference only brought results from YamlConfig.

Or is there a different way to handle this, with all the rename fields? I'm trying to do the basic char -> utf8 remapping, but not sure which rename field to use since I'd want it to happen everywhere.

[liamappelbe]

I think you want FfiGenerator.libraryImports.

[Levi-Lesches]

Seems more like importedTypesByUsr, but it's deprecated and I couldn't get this work:

    importedTypesByUsr: {
      "char": ImportedType(
        LibraryImport("pkg_ffi", "package:ffi/ffi.dart"),
        "Char",  // cType
        "Utf8",  // dartType
        "char",  // nativeType
      ),
    },

Adapted from the YAML example:

type-map:
  'native-types': # Targets native types.
    'char':
      'lib': 'pkg_ffi' # predefined import.
      'c-type': 'Char'
      # For native-types dart-type can be be int, double or float
      # but same otherwise.
      'dart-type': 'int'

[dcharkes]

Yes, my idea would be to change imported to a callback:

• [ffigen] Dart API: Remove FfiGenerator.importedTypesByUsr #2596

The Declaration has a usr, so you can use that to define the mapping.

Before that's implemented, importedTypesByUsr should work. The Yaml config uses the importedTypesByUsr in its implementation, so it should work. We don't have any tests using that in the Dart config though. You could try using the yaml config and setting a breakpoint on

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

Lines 744 to 745 in 5501355

	resultOrDefault: (node) =>
	_usrTypeMappings = node.value as Map<String, ImportedType>,

to see what value it is populated with.

Also, feel free to address #2596! 😄