Fix edge case where Flags types were being output as uint instead of the actual enum type

Author: Exanite

.silktouch/d48a9fc4a502f7c6.stout

@@ -11,6 +11,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using System.Xml.Linq;
+using ClangSharp;
 using Humanizer;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
@@ -23,6 +24,7 @@
 using Silk.NET.SilkTouch.Mods.Transformation;
 using Silk.NET.SilkTouch.Naming;
 using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
+using Type = System.Type;
 
 namespace Silk.NET.SilkTouch.Mods;
 
@@ -37,6 +39,7 @@ public partial class MixKhronosData(
     IOptionsSnapshot<MixKhronosData.Configuration> cfg
 )
     : IMod,
+        IResponseFileMod,
         INameTrimmer,
         IFunctionTransformer,
         IApiMetadataProvider<SymbolConstraints>,
@@ -133,6 +136,14 @@ public Dictionary<
         /// these are easily solvable breakages.
         /// </remarks>
         public HashSet<string> DeprecatedAliases = [];
+
+        /// <summary>
+        /// Additional type remappings to pass to ClangSharp.
+        /// </summary>
+        /// <remarks>
+        /// This was added for Vulkan Flags/FlagBits remappings.
+        /// </remarks>
+        public Dictionary<string, string> AdditionalTypeRemappings = [];
     }
 
     /// <summary>
@@ -311,6 +322,28 @@ .. xml.Element("registry")
 
             job.TypeMap.TryAdd(type, baseType);
         }
+
+        // Add mappings from Flags storage types to FlagBits enums types
+        // We want Flags as the output, but in order to generate everything correctly,
+        // we need to first map Flags to FlagBits, then rename FlagBits back to Flags (this is done in the rewriters).
+        // Without this, ClangSharp will output the Flags types as the integral storage type instead of the enum
+        foreach (var typeElement in xml.Elements("registry").Elements("types").Elements("type"))
+        {
+            var typedef = typeElement.Element("type")?.Value;
+            if (typedef != "VkFlags" && typedef != "VkFlags64")
+            {
+                continue;
+            }
+
+            var mapFrom = typeElement.Element("name")?.Value;
+            var mapTo = typeElement.Attribute("requires")?.Value;
+            if (mapFrom == null || mapTo == null)
+            {
+                continue;
+            }
+
+            job.AdditionalTypeRemappings[mapFrom] = mapTo;
+        }
     }
 
     /// <inheritdoc />
@@ -356,6 +389,57 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
         ctx.SourceProject = proj;
     }
 
+    /// <inheritdoc />
+    public Task<List<ResponseFile>> BeforeScrapeAsync(string key, List<ResponseFile> rsps)
+    {
+        var job = Jobs[key];
+
+        var tmp = Path.GetTempFileName();
+        rsps = rsps.Select(rsp =>
+        {
+            File.WriteAllText(tmp, rsp.GeneratorConfiguration.HeaderText);
+            return rsp with
+            {
+                GeneratorConfiguration = new PInvokeGeneratorConfiguration(
+                    rsp.GeneratorConfiguration.Language,
+                    rsp.GeneratorConfiguration.LanguageStandard,
+                    rsp.GeneratorConfiguration.DefaultNamespace,
+                    rsp.GeneratorConfiguration.OutputLocation,
+                    tmp,
+                    rsp.GeneratorConfiguration.OutputMode,
+                    rsp.GeneratorConfiguration.ReconstructOptions()
+                )
+                {
+                    DefaultClass = rsp.GeneratorConfiguration.DefaultClass,
+                    ExcludedNames = rsp.GeneratorConfiguration.ExcludedNames,
+                    IncludedNames = rsp.GeneratorConfiguration.IncludedNames,
+                    LibraryPath = rsp.GeneratorConfiguration.LibraryPath,
+                    MethodPrefixToStrip = rsp.GeneratorConfiguration.MethodPrefixToStrip,
+                    NativeTypeNamesToStrip = rsp.GeneratorConfiguration.NativeTypeNamesToStrip,
+                    RemappedNames = rsp.GeneratorConfiguration.RemappedNames.Concat(job.AdditionalTypeRemappings).ToDictionary(),
+                    TraversalNames = rsp.GeneratorConfiguration.TraversalNames,
+                    TestOutputLocation = rsp.GeneratorConfiguration.TestOutputLocation,
+                    WithAccessSpecifiers = rsp.GeneratorConfiguration.WithAccessSpecifiers,
+                    WithAttributes = rsp.GeneratorConfiguration.WithAttributes,
+                    WithCallConvs = rsp.GeneratorConfiguration.WithCallConvs,
+                    WithClasses = rsp.GeneratorConfiguration.WithClasses,
+                    WithGuids = rsp.GeneratorConfiguration.WithGuids,
+                    WithLibraryPaths = rsp.GeneratorConfiguration.WithLibraryPaths,
+                    WithManualImports = rsp.GeneratorConfiguration.WithManualImports,
+                    WithNamespaces = rsp.GeneratorConfiguration.WithNamespaces,
+                    WithSetLastErrors = rsp.GeneratorConfiguration.WithSetLastErrors,
+                    WithSuppressGCTransitions = rsp.GeneratorConfiguration.WithSuppressGCTransitions,
+                    WithTransparentStructs = rsp.GeneratorConfiguration.WithTransparentStructs,
+                    WithTypes = rsp.GeneratorConfiguration.WithTypes,
+                    WithUsings = rsp.GeneratorConfiguration.WithUsings,
+                    WithPackings = rsp.GeneratorConfiguration.WithPackings,
+                }
+            };
+        }).ToList();
+
+        return Task.FromResult(rsps);
+    }
+
     internal record EnumGroup(
         string Name,
         string? Type,
@@ -1286,10 +1370,10 @@ vendorSuffix is null
                     !names.ContainsKey(newOriginal)
                     && (
                         job.Configuration.UseExtensionVendorTrimmings
-                            == ExtensionVendorTrimmingMode.All
+                            == MixKhronosData.ExtensionVendorTrimmingMode.All
                         || (
                             job.Configuration.UseExtensionVendorTrimmings
-                                == ExtensionVendorTrimmingMode.KhronosOnly
+                                == MixKhronosData.ExtensionVendorTrimmingMode.KhronosOnly
                             && vendor is "KHR" or "ARB"
                         )
                         || (
@@ -1571,7 +1655,7 @@ PointerTypeSyntax ptr
         TypeSyntax? GetTypeTransformation(
             string symbolName,
             string paramName,
-            JobData job,
+            MixKhronosData.JobData job,
             TypeSyntax type,
             int pass,
             ref bool anyNonTrivialParams
@@ -1720,7 +1804,7 @@ jobKey is null
     /// This rewriter is split into two phases because NamespaceFromSyntaxNode breaks due to
     /// the FieldDeclarationSyntax being modified.
     /// </remarks>
-    private class RewriterPhase1(JobData job, ILogger logger) : CSharpSyntaxRewriter
+    private class RewriterPhase1(MixKhronosData.JobData job, ILogger logger) : CSharpSyntaxRewriter
     {
         /// <summary>
         /// Tracks enum groups that already exist in the project, prior to the generation of missing enums.
@@ -1729,7 +1813,7 @@ private class RewriterPhase1(JobData job, ILogger logger) : CSharpSyntaxRewriter
 
         /// <summary>
         /// Tracks enums that exist in the project.
-        /// Note that this includes any enum, including enums not present in <see cref="JobData.Groups"/>.
+        /// Note that this includes any enum, including enums not present in <see cref="MixKhronosData.JobData.Groups"/>.
         /// </summary>
         public HashSet<string> AllKnownEnums { get; } = [];
 
@@ -1998,7 +2082,6 @@ private class RewriterPhase2(JobData job, RewriterPhase1 phase1) : CSharpSyntaxR
             }
 
             return base.VisitFieldDeclaration(node);
-
         }
 
         public override SyntaxNode? VisitPropertyDeclaration(PropertyDeclarationSyntax node)
@@ -2019,7 +2102,6 @@ private class RewriterPhase2(JobData job, RewriterPhase1 phase1) : CSharpSyntaxR
             }
 
             return base.VisitParameter(node);
-
         }
 
         /// <summary>
@@ -2053,7 +2135,7 @@ private bool TryGetManagedEnumType(SyntaxList<AttributeListSyntax> attributes, [
     }
 
     [SuppressMessage("ReSharper", "MoveLocalFunctionAfterJumpStatement")]
-    internal void ReadGroups(XDocument doc, JobData data, HashSet<string> vendors)
+    internal void ReadGroups(XDocument doc, MixKhronosData.JobData data, HashSet<string> vendors)
     {
         // Designed to be compatible with OpenGL, EGL, WGL, GLX, and OpenCL.
         // This will work for Vulkan as well, but for Vulkan the enums are actually "typedef enum"s in the headers and

sources/SilkTouch/SilkTouch/Mods/MixKhronosData.cs

@@ -53,7 +53,7 @@ public unsafe partial struct AccelerationStructureInfoNV
             "VK_VERSION_1_1",
         ]
     )]
-    public uint Flags;
+    public BuildAccelerationStructureFlagsKHR Flags;
 
     [NativeTypeName("uint32_t")]
     [SupportedApiProfile(

sources/Vulkan/Vulkan/Vulkan/AccelerationStructureInfoNV.gen.cs

@@ -102,7 +102,7 @@ public uint instanceShaderBindingTableRecordOffset
             "VK_KHR_deferred_host_operations+VK_VERSION_1_2",
         ]
     )]
-    public uint flags
+    public GeometryInstanceFlagsKHR flags
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         readonly get { return (Bitfield2 >> 24) & 0xFFu; }

sources/Vulkan/Vulkan/Vulkan/AccelerationStructureInstanceKHR.gen.cs

@@ -88,7 +88,7 @@ public uint instanceShaderBindingTableRecordOffset
         ["VK_NV_ray_tracing_motion_blur"],
         ImpliesSets = ["VK_KHR_ray_tracing_pipeline"]
     )]
-    public uint flags
+    public GeometryInstanceFlagsKHR flags
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         readonly get { return (Bitfield2 >> 24) & 0xFFu; }

sources/Vulkan/Vulkan/Vulkan/AccelerationStructureMatrixMotionInstanceNV.gen.cs

@@ -88,7 +88,7 @@ public uint instanceShaderBindingTableRecordOffset
         ["VK_NV_ray_tracing_motion_blur"],
         ImpliesSets = ["VK_KHR_ray_tracing_pipeline"]
     )]
-    public uint flags
+    public GeometryInstanceFlagsKHR flags
     {
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         readonly get { return (Bitfield2 >> 24) & 0xFFu; }

sources/Vulkan/Vulkan/Vulkan/AccelerationStructureSRTMotionInstanceNV.gen.cs

@@ -13,7 +13,7 @@ namespace Silk.NET.Vulkan;
 {
     private readonly void* Pointer;
     public delegate* unmanaged<
-        uint,
+        DebugReportFlagsEXT,
         DebugReportObjectTypeEXT,
         ulong,
         nuint,
@@ -23,7 +23,7 @@ public delegate* unmanaged<
         void*,
         MaybeBool<uint>> Handle =>
         (delegate* unmanaged<
-            uint,
+            DebugReportFlagsEXT,
             DebugReportObjectTypeEXT,
             ulong,
             nuint,
@@ -35,7 +35,7 @@ public delegate* unmanaged<
 
     public PFNVkDebugReportCallbackEXT(
         delegate* unmanaged<
-            uint,
+            DebugReportFlagsEXT,
             DebugReportObjectTypeEXT,
             ulong,
             nuint,
@@ -53,7 +53,7 @@ public PFNVkDebugReportCallbackEXT(PFNVkDebugReportCallbackEXTDelegate proc) =>
 
     public static implicit operator PFNVkDebugReportCallbackEXT(
         delegate* unmanaged<
-            uint,
+            DebugReportFlagsEXT,
             DebugReportObjectTypeEXT,
             ulong,
             nuint,
@@ -65,7 +65,7 @@ MaybeBool<uint>> pfn
     ) => new(pfn);
 
     public static implicit operator delegate* unmanaged<
-        uint,
+        DebugReportFlagsEXT,
         DebugReportObjectTypeEXT,
         ulong,
         nuint,
@@ -75,7 +75,7 @@ public static implicit operator delegate* unmanaged<
         void*,
         MaybeBool<uint>>(PFNVkDebugReportCallbackEXT pfn) =>
         (delegate* unmanaged<
-            uint,
+            DebugReportFlagsEXT,
             DebugReportObjectTypeEXT,
             ulong,
             nuint,

sources/Vulkan/Vulkan/Vulkan/PFNVkDebugReportCallbackEXT.gen.cs

@@ -10,7 +10,7 @@
 namespace Silk.NET.Vulkan;
 
 public unsafe delegate MaybeBool<uint> PFNVkDebugReportCallbackEXTDelegate(
-    uint arg0,
+    DebugReportFlagsEXT arg0,
     DebugReportObjectTypeEXT arg1,
     ulong arg2,
     nuint arg3,

sources/Vulkan/Vulkan/Vulkan/PFNVkDebugReportCallbackEXTDelegate.gen.cs

@@ -14,21 +14,21 @@ namespace Silk.NET.Vulkan;
     private readonly void* Pointer;
     public delegate* unmanaged<
         DebugUtilsMessageSeverityFlagsEXT,
-        uint,
+        DebugUtilsMessageTypeFlagsEXT,
         DebugUtilsMessengerCallbackDataEXT*,
         void*,
         MaybeBool<uint>> Handle =>
         (delegate* unmanaged<
             DebugUtilsMessageSeverityFlagsEXT,
-            uint,
+            DebugUtilsMessageTypeFlagsEXT,
             DebugUtilsMessengerCallbackDataEXT*,
             void*,
             MaybeBool<uint>>)Pointer;
 
     public PFNVkDebugUtilsMessengerCallbackEXT(
         delegate* unmanaged<
             DebugUtilsMessageSeverityFlagsEXT,
-            uint,
+            DebugUtilsMessageTypeFlagsEXT,
             DebugUtilsMessengerCallbackDataEXT*,
             void*,
             MaybeBool<uint>> ptr
@@ -42,21 +42,21 @@ public PFNVkDebugUtilsMessengerCallbackEXT(PFNVkDebugUtilsMessengerCallbackEXTDe
     public static implicit operator PFNVkDebugUtilsMessengerCallbackEXT(
         delegate* unmanaged<
             DebugUtilsMessageSeverityFlagsEXT,
-            uint,
+            DebugUtilsMessageTypeFlagsEXT,
             DebugUtilsMessengerCallbackDataEXT*,
             void*,
             MaybeBool<uint>> pfn
     ) => new(pfn);
 
     public static implicit operator delegate* unmanaged<
         DebugUtilsMessageSeverityFlagsEXT,
-        uint,
+        DebugUtilsMessageTypeFlagsEXT,
         DebugUtilsMessengerCallbackDataEXT*,
         void*,
         MaybeBool<uint>>(PFNVkDebugUtilsMessengerCallbackEXT pfn) =>
         (delegate* unmanaged<
             DebugUtilsMessageSeverityFlagsEXT,
-            uint,
+            DebugUtilsMessageTypeFlagsEXT,
             DebugUtilsMessengerCallbackDataEXT*,
             void*,
             MaybeBool<uint>>)

sources/Vulkan/Vulkan/Vulkan/PFNVkDebugUtilsMessengerCallbackEXT.gen.cs

@@ -11,7 +11,7 @@ namespace Silk.NET.Vulkan;
 
 public unsafe delegate MaybeBool<uint> PFNVkDebugUtilsMessengerCallbackEXTDelegate(
     DebugUtilsMessageSeverityFlagsEXT arg0,
-    uint arg1,
+    DebugUtilsMessageTypeFlagsEXT arg1,
     DebugUtilsMessengerCallbackDataEXT* arg2,
     void* arg3
 );