如何通过Dart FFI从C返回并正确识别重复值枚举

问题根源 #

C语言允许枚举的不同成员共享同一整数值，这里UndefinedGravity默认值为0，ForgetGravity也显式设为0；但Dart的firstWhere方法在匹配枚举值时，只会返回第一个符合条件的成员，导致从C返回的0无法区分对应Dart中的UndefinedGravity还是ForgetGravity。

可行解决方案 #

1. 修改C端枚举值（最优方案，若允许修改C代码）

直接给两个冲突的枚举成员分配唯一整数值，从根源消除歧义：

typedef enum
{
  UndefinedGravity = 10, // 改为唯一值
  ForgetGravity = 0,
  NorthWestGravity = 1,
  NorthGravity = 2,
  NorthEastGravity = 3,
  WestGravity = 4,
  CenterGravity = 5,
  EastGravity = 6,
  SouthWestGravity = 7,
  SouthGravity = 8,
  SouthEastGravity = 9
} GravityType;

同步更新Dart枚举对应的值：

enum GravityType {
  UndefinedGravity(10),
  ForgetGravity(0),
  NorthWestGravity(1),
  NorthGravity(2),
  NorthEastGravity(3),
  WestGravity(4),
  CenterGravity(5),
  EastGravity(6),
  SouthWestGravity(7),
  SouthGravity(8),
  SouthEastGravity(9);

  final int value;

  const GravityType(this.value);

  static GravityType fromValue(int value) => GravityType.values.firstWhere((e) => e.value == value);
}

2. 调整Dart端映射逻辑，处理多匹配场景

如果无法修改C代码，需要在Dart中处理值为0时的歧义情况：

方案2.1 返回所有匹配的枚举成员

修改fromValue方法返回匹配的枚举列表，让调用方根据业务场景选择：

enum GravityType {
  UndefinedGravity(0),
  ForgetGravity(0),
  NorthWestGravity(1),
  NorthGravity(2),
  NorthEastGravity(3),
  WestGravity(4),
  CenterGravity(5),
  EastGravity(6),
  SouthWestGravity(7),
  SouthGravity(8),
  SouthEastGravity(9);

  final int value;

  const GravityType(this.value);

  static List<GravityType> fromValue(int value) => 
      GravityType.values.where((e) => e.value == value).toList();
}

调用示例：

final result = myFunc(); // 假设返回0
final matches = GravityType.fromValue(result);
if (matches.length > 1) {
  // 根据业务逻辑选择，比如确定是ForgetGravity则取第二个
  final target = matches[1];
} else {
  final target = matches.first;
}

方案2.2 增加默认参数指定优先匹配项

给fromValue添加可选参数，允许调用方指定值冲突时的默认返回：

enum GravityType {
  UndefinedGravity(0),
  ForgetGravity(0),
  NorthWestGravity(1),
  NorthGravity(2),
  NorthEastGravity(3),
  WestGravity(4),
  CenterGravity(5),
  EastGravity(6),
  SouthWestGravity(7),
  SouthGravity(8),
  SouthEastGravity(9);

  final int value;

  const GravityType(this.value);

  static GravityType fromValue(int value, {GravityType? defaultValue}) {
    final matches = GravityType.values.where((e) => e.value == value).toList();
    if (matches.isEmpty) {
      throw ArgumentError('无效的Gravity值: $value');
    }
    return defaultValue ?? matches.first;
  }
}

调用示例：

// 已知C函数返回的是ForgetGravity，指定默认值
final gt = GravityType.fromValue(result, defaultValue: GravityType.ForgetGravity);

3. 扩展枚举属性（需额外上下文支持）

如果调用C函数时能获取额外上下文信息，可以给Dart枚举添加标识字段辅助区分：

enum GravityType {
  UndefinedGravity(0, isForget: false),
  ForgetGravity(0, isForget: true),
  NorthWestGravity(1, isForget: false),
  NorthGravity(2, isForget: false),
  NorthEastGravity(3, isForget: false),
  WestGravity(4, isForget: false),
  CenterGravity(5, isForget: false),
  EastGravity(6, isForget: false),
  SouthWestGravity(7, isForget: false),
  SouthGravity(8, isForget: false),
  SouthEastGravity(9, isForget: false);

  final int value;
  final bool isForget;

  const GravityType(this.value, {required this.isForget});

  // 结合上下文的isForget筛选
  static GravityType fromValue(int value, bool isForget) => 
      GravityType.values.firstWhere((e) => e.value == value && e.isForget == isForget);
}

但这种方案需要C端除了返回整数值外，还能提供额外的标识信息，否则无法生效。

内容的提问来源于stack exchange，提问作者Haidar