[ffigen] Fix unnamed enum multi-def bug (#2789)

Author: liamappelbe

pkgs/ffigen/CHANGELOG.md

@@ -9,6 +9,8 @@
   `Declarations.includeMemberSet`, `Declarations.useOriginalName`,
   `Declarations.renameWithMap`, `Declarations.useMemberOriginalName`, and
   `Declarations.renameMemberWithMap`.
+- Fix [a bug](https://github.com/dart-lang/native/issues/2782) where unnamed
+  enum constants were being multiply defined.
 - Fix [a bug](https://github.com/dart-lang/native/issues/2761) in imported
   NS_OPTIONS enums.
 - Fix [a bug](https://github.com/dart-lang/native/issues/2760) in the internal

pkgs/ffigen/lib/src/header_parser/sub_parsers/macro_parser.dart

@@ -19,7 +19,11 @@ import '../utils.dart';
 
 /// Adds a macro definition to be parsed later.
 void saveMacroDefinition(Context context, clang_types.CXCursor cursor) {
+  final bindingsIndex = context.bindingsIndex;
   final macroUsr = cursor.usr();
+  if (bindingsIndex.isSeenMacro(macroUsr)) {
+    return;
+  }
   final originalMacroName = cursor.spelling();
   final decl = Declaration(usr: macroUsr, originalName: originalMacroName);
   if (clang.clang_Cursor_isMacroBuiltin(cursor) == 0 &&
@@ -30,7 +34,7 @@ void saveMacroDefinition(Context context, clang_types.CXCursor cursor) {
       '${cursor.completeStringRepr()}',
     );
     final prefixedName = context.config.macros.rename(decl);
-    context.bindingsIndex.addMacroToSeen(macroUsr, prefixedName);
+    bindingsIndex.addMacroToSeen(macroUsr, prefixedName);
     _saveMacro(prefixedName, macroUsr, originalMacroName, context);
   }
 }

pkgs/ffigen/lib/src/header_parser/sub_parsers/unnamed_enumdecl_parser.dart

@@ -48,6 +48,13 @@ Constant? _addUnNamedEnumConstant(
   final logger = context.logger;
   final config = context.config;
   final bindingsIndex = context.bindingsIndex;
+
+  final usr = cursor.usr();
+  final oldConstant = bindingsIndex.getSeenUnnamedEnumConstant(usr);
+  if (oldConstant != null) {
+    return oldConstant;
+  }
+
   final unnamedEnumConstants = context.unnamedEnumConstants;
   final apiAvailability = ApiAvailability.fromCursor(cursor, context);
   if (apiAvailability.availability == Availability.none) {
@@ -59,7 +66,7 @@ Constant? _addUnNamedEnumConstant(
     '++++ Adding Constant from unnamed enum: ${cursor.completeStringRepr()}',
   );
   final constant = UnnamedEnumConstant(
-    usr: cursor.usr(),
+    usr: usr,
     originalName: cursor.spelling(),
     name: config.unnamedEnums.rename(
       Declaration(usr: cursor.usr(), originalName: cursor.spelling()),

pkgs/ffigen/lib/src/header_parser/utils.dart

@@ -510,8 +510,6 @@ class BindingsIndex {
   bool isSeenFunc(String usr) => _functions.containsKey(usr);
   void addFuncToSeen(String usr, Func func) => _functions[usr] = func;
   Func? getSeenFunc(String usr) => _functions[usr];
-  bool isSeenUnnamedEnumConstant(String usr) =>
-      _unnamedEnumConstants.containsKey(usr);
   void addUnnamedEnumConstantToSeen(String usr, Constant enumConstant) =>
       _unnamedEnumConstants[usr] = enumConstant;
   Constant? getSeenUnnamedEnumConstant(String usr) =>
@@ -521,7 +519,6 @@ class BindingsIndex {
   Global? getSeenGlobalVar(String usr) => _globals[usr];
   bool isSeenMacro(String usr) => _macros.containsKey(usr);
   void addMacroToSeen(String usr, String macro) => _macros[usr] = macro;
-  String? getSeenMacro(String usr) => _macros[usr];
   bool isSeenUnsupportedTypealias(String usr) =>
       _unsupportedTypealiases.contains(usr);
   void addUnsupportedTypealiasToSeen(String usr) =>

pkgs/ffigen/test/native_objc_test/enum_config.yaml

@@ -7,9 +7,18 @@ enums:
   include:
     - Fruit
     - CoffeeOptions
+unnamed-enums:
+  include:
+    - UnnamedEnumValue
+macros:
+  include:
+    - SOME_MACRO
 objc-interfaces:
   include:
     - EnumTestInterface
 headers:
   entry-points:
+    # Multiple includes to repro https://github.com/dart-lang/native/issues/2782
+    - 'enum_test.m'
+    - 'enum_test.m'
     - 'enum_test.m'

pkgs/ffigen/test/native_objc_test/enum_test.dart

@@ -54,6 +54,21 @@ void main() {
       );
     });
 
+    test('Multi def regression test', () {
+      // Regression test for https://github.com/dart-lang/native/issues/2782
+      final bindings = File(
+        path.join(
+          packagePathForTests,
+          'test',
+          'native_objc_test',
+          'enum_bindings.dart',
+        ),
+      ).readAsStringSync();
+
+      expect(bindings, isNot(contains('UnnamedEnumValue\$1')));
+      expect(bindings, isNot(contains('SOME_MACRO\$1')));
+    });
+
     test('Imported enum', () {
       // Regression test for https://github.com/dart-lang/native/issues/2761
       expect(

pkgs/ffigen/test/native_objc_test/enum_test.m

@@ -19,6 +19,12 @@ typedef NS_OPTIONS(NSUInteger, CoffeeOptions) {
     CoffeeOptionsIced  = 1 << 2,
 };
 
+enum {
+  UnnamedEnumValue,
+};
+
+#define SOME_MACRO 123
+
 @interface EnumTestInterface : NSObject {}
 
 +(int32_t)useImportedNSEnum:(NSQualityOfService)x;