Add INameTrimmer.Order property and sort trimmers by that instead of version

Author: Exanite

sources/SilkTouch/SilkTouch/Mods/MixKhronosData.cs

@@ -216,8 +216,10 @@ public record Configuration
     }
 
     /// <inheritdoc />
-    // non-versioned trimmer (and needs to be a big number to come after the default trimmers)
-    public Version Version { get; } = new(42, 42, 42, 42);
+    Version INameTrimmer.Version { get; } = new(0, 0, 0);
+
+    /// <inheritdoc/>
+    int INameTrimmer.Order => (int)TrimmerOrder.MixKhronosData;
 
     /// <inheritdoc />
     public async Task InitializeAsync(IModContext ctx, CancellationToken ct = default)

sources/SilkTouch/SilkTouch/Mods/PrettifyNames.cs

@@ -100,7 +100,7 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
                 .Append(new NameAffixerEarlyTrimmer(visitor.AffixTypes))
                 .Append(new NameAffixerLateTrimmer(visitor.AffixTypes))
                 .Append(new PrettifyNamesTrimmer())
-                .OrderBy(x => x.Version)
+                .OrderBy(x => x.Order)
                 .ToArray();
 
             // Create a type name dictionary to trim the type names.
@@ -1347,11 +1347,11 @@ public override SyntaxNode VisitMethodDeclaration(MethodDeclarationSyntax node)
 
     private class NameAffixerEarlyTrimmer(Dictionary<string, TypeAffixData> affixTypes) : INameTrimmer
     {
-        // TODO: This setup has become insane. Think of a better one.
-        /// <summary>
-        /// Use high-ish version to ensure this trimmer runs after the global prefix trimmer and before MixKhronosData.
-        /// </summary>
-        public Version Version => new(21, 21, 21);
+        /// <inheritdoc/>
+        public Version Version => new(0, 0, 0);
+
+        /// <inheritdoc/>
+        public int Order => (int)TrimmerOrder.NameAffixerEarlyTrimmer;
 
         public void Trim(NameTrimmerContext context)
         {
@@ -1378,10 +1378,11 @@ public void Trim(NameTrimmerContext context)
 
     private class NameAffixerLateTrimmer(Dictionary<string, TypeAffixData> affixTypes) : INameTrimmer
     {
-        /// <summary>
-        /// Use high version to ensure this trimmer runs second to last.
-        /// </summary>
-        public Version Version => new(999, 999, 999);
+        /// <inheritdoc/>
+        public Version Version => new(0, 0, 0);
+
+        /// <inheritdoc/>
+        public int Order => (int)TrimmerOrder.NameAffixerLateTrimmer;
 
         public void Trim(NameTrimmerContext context)
         {
@@ -1408,10 +1409,11 @@ public void Trim(NameTrimmerContext context)
 
     private class PrettifyNamesTrimmer : INameTrimmer
     {
-        /// <summary>
-        /// Use really high version to ensure this trimmer runs last.
-        /// </summary>
-        public Version Version => new(9999, 9999, 9999);
+        /// <inheritdoc/>
+        public Version Version => new(0, 0, 0);
+
+        /// <inheritdoc/>
+        public int Order => (int)TrimmerOrder.PrettifyNamesTrimmer;
 
         public void Trim(NameTrimmerContext context)
         {

sources/SilkTouch/SilkTouch/Naming/INameTrimmer.cs

@@ -15,6 +15,12 @@ public interface INameTrimmer
     /// </summary>
     Version Version { get; }
 
+    /// <summary>
+    /// Used to define the order that the trimmers will run in.
+    /// Higher values indicate that the trimmer should run later.
+    /// </summary>
+    int Order { get; }
+
     /// <summary>
     /// Trims prefixes from the given constituent names within the given container.
     /// </summary>

sources/SilkTouch/SilkTouch/Naming/NameTrimmer.cs

@@ -14,6 +14,9 @@ public class NameTrimmer : INameTrimmer
     /// <inheritdoc />
     public virtual Version Version => new(3, 0);
 
+    /// <inheritdoc/>
+    public virtual int Order => (int)TrimmerOrder.NameTrimmer;
+
     /// <summary>
     /// Determines whether a second pass without using <see cref="GetTrimmingName"/> is warranted.
     /// </summary>

sources/SilkTouch/SilkTouch/Naming/NameTrimmer217.cs

@@ -13,6 +13,9 @@ public class NameTrimmer217 : NameTrimmer
     /// <inheritdoc />
     public override Version Version => new(2, 17);
 
+    /// <inheritdoc/>
+    public override int Order => (int)TrimmerOrder.NameTrimmer217;
+
     /// <inheritdoc />
     protected override bool HasRawPass => false;
 

sources/SilkTouch/SilkTouch/Naming/NameTrimmer218.cs

@@ -11,6 +11,9 @@ public class NameTrimmer218 : NameTrimmer
     /// <inheritdoc />
     public override Version Version => new(2, 18);
 
+    /// <inheritdoc/>
+    public override int Order => (int)TrimmerOrder.NameTrimmer218;
+
     /// <inheritdoc />
     protected override bool HasRawPass => false;
 

sources/SilkTouch/SilkTouch/Naming/TrimmerOrder.cs

@@ -0,0 +1,22 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Silk.NET.SilkTouch.Naming;
+
+/// <summary>
+/// Defines the order for SilkTouch's <see cref="INameTrimmer"/> implementations.
+/// </summary>
+internal enum TrimmerOrder
+{
+    NameTrimmer = 100,
+    NameTrimmer217 = 110,
+    NameTrimmer218 = 120,
+
+    NameAffixerEarlyTrimmer = 200,
+
+    MixKhronosData = 300,
+
+    NameAffixerLateTrimmer = 400,
+
+    PrettifyNamesTrimmer = 500,
+}