[ffigen] Change ffigen's renaming logic to match jnigen (#2035)

Author: liamappelbe

pkgs/ffigen/CHANGELOG.md

@@ -13,6 +13,10 @@
 - Change how protocols are implemented to fix
   [a bug](https://github.com/dart-lang/http/issues/1702), by removing all uses
   of `NSProxy`.
+- __Breaking change__: Change how duplicate identifiers are renamed to match
+  jnigen. The main change is that `$` is used as a delimiter now, to avoid
+  renamed identifiers from colliding with other identifiers. For example, `foo`
+  is renamed to `foo$1` if there's already a `foo` in the namespace.
 
 ## 17.0.0
 

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

@@ -58,10 +58,10 @@ class LibClang {
 
   /// Free the given string set.
   void clang_disposeStringSet(
-    ffi.Pointer<CXStringSet> set1,
+    ffi.Pointer<CXStringSet> set$,
   ) {
     return _clang_disposeStringSet(
-      set1,
+      set$,
     );
   }
 
@@ -7668,9 +7668,9 @@ typedef DartClang_getCString = ffi.Pointer<ffi.Char> Function(CXString string);
 typedef NativeClang_disposeString = ffi.Void Function(CXString string);
 typedef DartClang_disposeString = void Function(CXString string);
 typedef NativeClang_disposeStringSet = ffi.Void Function(
-    ffi.Pointer<CXStringSet> set1);
+    ffi.Pointer<CXStringSet> set$);
 typedef DartClang_disposeStringSet = void Function(
-    ffi.Pointer<CXStringSet> set1);
+    ffi.Pointer<CXStringSet> set$);
 
 /// An "index" that consists of a set of translation units that would
 /// typically be linked together into an executable or library.
@@ -7737,7 +7737,7 @@ enum CXAvailabilityKind {
         2 => CXAvailability_NotAvailable,
         3 => CXAvailability_NotAccessible,
         _ =>
-          throw ArgumentError("Unknown value for CXAvailabilityKind: $value"),
+          throw ArgumentError('Unknown value for CXAvailabilityKind: $value'),
       };
 }
 
@@ -7798,7 +7798,7 @@ enum CXGlobalOptFlags {
         1 => CXGlobalOpt_ThreadBackgroundPriorityForIndexing,
         2 => CXGlobalOpt_ThreadBackgroundPriorityForEditing,
         3 => CXGlobalOpt_ThreadBackgroundPriorityForAll,
-        _ => throw ArgumentError("Unknown value for CXGlobalOptFlags: $value"),
+        _ => throw ArgumentError('Unknown value for CXGlobalOptFlags: $value'),
       };
 }
 
@@ -8035,7 +8035,7 @@ enum CXDiagnosticSeverity {
         3 => CXDiagnostic_Error,
         4 => CXDiagnostic_Fatal,
         _ =>
-          throw ArgumentError("Unknown value for CXDiagnosticSeverity: $value"),
+          throw ArgumentError('Unknown value for CXDiagnosticSeverity: $value'),
       };
 }
 
@@ -8079,7 +8079,7 @@ enum CXLoadDiag_Error {
         1 => CXLoadDiag_Unknown,
         2 => CXLoadDiag_CannotLoad,
         3 => CXLoadDiag_InvalidFile,
-        _ => throw ArgumentError("Unknown value for CXLoadDiag_Error: $value"),
+        _ => throw ArgumentError('Unknown value for CXLoadDiag_Error: $value'),
       };
 }
 
@@ -8220,7 +8220,7 @@ enum CXErrorCode {
         2 => CXError_Crashed,
         3 => CXError_InvalidArguments,
         4 => CXError_ASTReadError,
-        _ => throw ArgumentError("Unknown value for CXErrorCode: $value"),
+        _ => throw ArgumentError('Unknown value for CXErrorCode: $value'),
       };
 }
 
@@ -8356,7 +8356,7 @@ enum CXTUResourceUsageKind {
         13 => CXTUResourceUsage_SourceManager_DataStructures,
         14 => CXTUResourceUsage_Preprocessor_HeaderSearch,
         _ => throw ArgumentError(
-            "Unknown value for CXTUResourceUsageKind: $value"),
+            'Unknown value for CXTUResourceUsageKind: $value'),
       };
 
   @override
@@ -9445,7 +9445,7 @@ enum CXCursorKind {
         602 => CXCursor_StaticAssert,
         603 => CXCursor_FriendDecl,
         700 => CXCursor_OverloadCandidate,
-        _ => throw ArgumentError("Unknown value for CXCursorKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXCursorKind: $value'),
       };
 
   @override
@@ -9595,7 +9595,7 @@ enum CXLinkageKind {
         2 => CXLinkage_Internal,
         3 => CXLinkage_UniqueExternal,
         4 => CXLinkage_External,
-        _ => throw ArgumentError("Unknown value for CXLinkageKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXLinkageKind: $value'),
       };
 }
 
@@ -9625,7 +9625,7 @@ enum CXVisibilityKind {
         1 => CXVisibility_Hidden,
         2 => CXVisibility_Protected,
         3 => CXVisibility_Default,
-        _ => throw ArgumentError("Unknown value for CXVisibilityKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXVisibilityKind: $value'),
       };
 }
 
@@ -9701,7 +9701,7 @@ enum CXLanguageKind {
         1 => CXLanguage_C,
         2 => CXLanguage_ObjC,
         3 => CXLanguage_CPlusPlus,
-        _ => throw ArgumentError("Unknown value for CXLanguageKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXLanguageKind: $value'),
       };
 }
 
@@ -9723,7 +9723,7 @@ enum CXTLSKind {
         0 => CXTLS_None,
         1 => CXTLS_Dynamic,
         2 => CXTLS_Static,
-        _ => throw ArgumentError("Unknown value for CXTLSKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXTLSKind: $value'),
       };
 }
 
@@ -10028,7 +10028,7 @@ enum CXTypeKind {
         174 => CXType_OCLIntelSubgroupAVCImeSingleRefStreamin,
         175 => CXType_OCLIntelSubgroupAVCImeDualRefStreamin,
         176 => CXType_ExtVector,
-        _ => throw ArgumentError("Unknown value for CXTypeKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXTypeKind: $value'),
       };
 
   @override
@@ -10088,7 +10088,7 @@ enum CXCallingConv {
         16 => CXCallingConv_AArch64VectorCall,
         100 => CXCallingConv_Invalid,
         200 => CXCallingConv_Unexposed,
-        _ => throw ArgumentError("Unknown value for CXCallingConv: $value"),
+        _ => throw ArgumentError('Unknown value for CXCallingConv: $value'),
       };
 
   @override
@@ -10163,7 +10163,7 @@ enum CXTemplateArgumentKind {
         8 => CXTemplateArgumentKind_Pack,
         9 => CXTemplateArgumentKind_Invalid,
         _ => throw ArgumentError(
-            "Unknown value for CXTemplateArgumentKind: $value"),
+            'Unknown value for CXTemplateArgumentKind: $value'),
       };
 }
 
@@ -10295,7 +10295,7 @@ enum CXTypeNullabilityKind {
         2 => CXTypeNullability_Unspecified,
         3 => CXTypeNullability_Invalid,
         _ => throw ArgumentError(
-            "Unknown value for CXTypeNullabilityKind: $value"),
+            'Unknown value for CXTypeNullabilityKind: $value'),
       };
 }
 
@@ -10342,7 +10342,7 @@ enum CXRefQualifierKind {
         1 => CXRefQualifier_LValue,
         2 => CXRefQualifier_RValue,
         _ =>
-          throw ArgumentError("Unknown value for CXRefQualifierKind: $value"),
+          throw ArgumentError('Unknown value for CXRefQualifierKind: $value'),
       };
 }
 
@@ -10377,7 +10377,7 @@ enum CX_CXXAccessSpecifier {
         2 => CX_CXXProtected,
         3 => CX_CXXPrivate,
         _ => throw ArgumentError(
-            "Unknown value for CX_CXXAccessSpecifier: $value"),
+            'Unknown value for CX_CXXAccessSpecifier: $value'),
       };
 }
 
@@ -10409,7 +10409,7 @@ enum CX_StorageClass {
         5 => CX_SC_OpenCLWorkGroupLocal,
         6 => CX_SC_Auto,
         7 => CX_SC_Register,
-        _ => throw ArgumentError("Unknown value for CX_StorageClass: $value"),
+        _ => throw ArgumentError('Unknown value for CX_StorageClass: $value'),
       };
 }
 
@@ -10451,7 +10451,7 @@ enum CXChildVisitResult {
         1 => CXChildVisit_Continue,
         2 => CXChildVisit_Recurse,
         _ =>
-          throw ArgumentError("Unknown value for CXChildVisitResult: $value"),
+          throw ArgumentError('Unknown value for CXChildVisitResult: $value'),
       };
 }
 
@@ -10580,7 +10580,7 @@ enum CXPrintingPolicyProperty {
         24 => CXPrintingPolicy_SuppressImplicitBase,
         25 => CXPrintingPolicy_FullyQualifiedName,
         _ => throw ArgumentError(
-            "Unknown value for CXPrintingPolicyProperty: $value"),
+            'Unknown value for CXPrintingPolicyProperty: $value'),
       };
 
   @override
@@ -10775,7 +10775,7 @@ enum CXTokenKind {
         2 => CXToken_Identifier,
         3 => CXToken_Literal,
         4 => CXToken_Comment,
-        _ => throw ArgumentError("Unknown value for CXTokenKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXTokenKind: $value'),
       };
 }
 
@@ -11063,7 +11063,7 @@ enum CXCompletionChunkKind {
         19 => CXCompletionChunk_HorizontalSpace,
         20 => CXCompletionChunk_VerticalSpace,
         _ => throw ArgumentError(
-            "Unknown value for CXCompletionChunkKind: $value"),
+            'Unknown value for CXCompletionChunkKind: $value'),
       };
 }
 
@@ -11248,7 +11248,7 @@ enum CXEvalResultKind {
         5 => CXEval_CFStr,
         6 => CXEval_Other,
         0 => CXEval_UnExposed,
-        _ => throw ArgumentError("Unknown value for CXEvalResultKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXEvalResultKind: $value'),
       };
 }
 
@@ -11319,7 +11319,7 @@ enum CXVisitorResult {
   static CXVisitorResult fromValue(int value) => switch (value) {
         0 => CXVisit_Break,
         1 => CXVisit_Continue,
-        _ => throw ArgumentError("Unknown value for CXVisitorResult: $value"),
+        _ => throw ArgumentError('Unknown value for CXVisitorResult: $value'),
       };
 }
 
@@ -11350,7 +11350,7 @@ enum CXResult {
         0 => CXResult_Success,
         1 => CXResult_Invalid,
         2 => CXResult_VisitBreak,
-        _ => throw ArgumentError("Unknown value for CXResult: $value"),
+        _ => throw ArgumentError('Unknown value for CXResult: $value'),
       };
 }
 
@@ -11486,7 +11486,7 @@ enum CXIdxEntityKind {
         24 => CXIdxEntity_CXXConversionFunction,
         25 => CXIdxEntity_CXXTypeAlias,
         26 => CXIdxEntity_CXXInterface,
-        _ => throw ArgumentError("Unknown value for CXIdxEntityKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXIdxEntityKind: $value'),
       };
 }
 
@@ -11507,7 +11507,7 @@ enum CXIdxEntityLanguage {
         3 => CXIdxEntityLang_CXX,
         4 => CXIdxEntityLang_Swift,
         _ =>
-          throw ArgumentError("Unknown value for CXIdxEntityLanguage: $value"),
+          throw ArgumentError('Unknown value for CXIdxEntityLanguage: $value'),
       };
 }
 
@@ -11534,7 +11534,7 @@ enum CXIdxEntityCXXTemplateKind {
         2 => CXIdxEntity_TemplatePartialSpecialization,
         3 => CXIdxEntity_TemplateSpecialization,
         _ => throw ArgumentError(
-            "Unknown value for CXIdxEntityCXXTemplateKind: $value"),
+            'Unknown value for CXIdxEntityCXXTemplateKind: $value'),
       };
 }
 
@@ -11552,7 +11552,7 @@ enum CXIdxAttrKind {
         1 => CXIdxAttr_IBAction,
         2 => CXIdxAttr_IBOutlet,
         3 => CXIdxAttr_IBOutletCollection,
-        _ => throw ArgumentError("Unknown value for CXIdxAttrKind: $value"),
+        _ => throw ArgumentError('Unknown value for CXIdxAttrKind: $value'),
       };
 }
 
@@ -11661,7 +11661,7 @@ enum CXIdxObjCContainerKind {
         1 => CXIdxObjCContainer_Interface,
         2 => CXIdxObjCContainer_Implementation,
         _ => throw ArgumentError(
-            "Unknown value for CXIdxObjCContainerKind: $value"),
+            'Unknown value for CXIdxObjCContainerKind: $value'),
       };
 }
 
@@ -11754,7 +11754,7 @@ enum CXIdxEntityRefKind {
         1 => CXIdxEntityRef_Direct,
         2 => CXIdxEntityRef_Implicit,
         _ =>
-          throw ArgumentError("Unknown value for CXIdxEntityRefKind: $value"),
+          throw ArgumentError('Unknown value for CXIdxEntityRefKind: $value'),
       };
 }
 
@@ -11788,7 +11788,7 @@ enum CXSymbolRole {
         64 => CXSymbolRole_Dynamic,
         128 => CXSymbolRole_AddressOf,
         256 => CXSymbolRole_Implicit,
-        _ => throw ArgumentError("Unknown value for CXSymbolRole: $value"),
+        _ => throw ArgumentError('Unknown value for CXSymbolRole: $value'),
       };
 }