Rename INameTrimmer to INameProcessor and update rest of codebase

Author: Exanite

sources/SilkTouch/SilkTouch/Mods/PrettifyNames.cs

@@ -126,14 +126,14 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
 
         // Trim and prettify the trimmable names
 
-        // Define trimmers
-        var trimmers = new INameTrimmer[]
+        // Define name processors
+        var nameProcessors = new INameProcessor[]
         {
-            new NameAffixerEarlyTrimmer(nameAffixer),
+            new NameAffixerEarlyNameProcessor(nameAffixer),
             new NameTrimmer(),
-            new PrettifyNamesTrimmer(namePrettifier),
-            new NameAffixerLateTrimmer(nameAffixer),
-            new PrefixIfStartsWithNumberTrimmer(),
+            new PrettifyNameProcessor(namePrettifier),
+            new NameAffixerLateNameProcessor(nameAffixer),
+            new PrefixIfStartsWithNumberNameProcessor(),
         };
 
         // Create a type name dictionary to trim the type names.
@@ -146,16 +146,16 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
         // trim.
         if (typeNames.Count > 1 || cfg.GlobalPrefixHints is not null)
         {
-            Trim(
-                new NameTrimmerContext
+            ProcessNames(
+                new NameProcessorContext
                 {
                     Container = null,
                     Names = typeNames,
                     Configuration = cfg,
                     JobKey = ctx.JobKey,
                     NonDeterminant = visitor.NonDeterminant,
                 },
-                trimmers
+                nameProcessors
             );
         }
 
@@ -169,16 +169,16 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
             var constNames = consts.ToDictionary(x => x, x => new CandidateNames(x, []));
 
             // Trim the constants.
-            Trim(
-                new NameTrimmerContext
+            ProcessNames(
+                new NameProcessorContext
                 {
                     Container = typeName,
                     Names = constNames,
                     Configuration = cfg,
                     JobKey = ctx.JobKey,
                     NonDeterminant = visitor.NonDeterminant,
                 },
-                trimmers
+                nameProcessors
             );
 
             // Rename the functions. More often that not functions have different nomenclature to constants, so we
@@ -194,16 +194,16 @@ public async Task ExecuteAsync(IModContext ctx, CancellationToken ct = default)
             );
 
             // Trim the functions.
-            Trim(
-                new NameTrimmerContext
+            ProcessNames(
+                new NameProcessorContext
                 {
                     Container = typeName,
                     Names = functionNames,
                     Configuration = cfg,
                     JobKey = ctx.JobKey,
                     NonDeterminant = visitor.NonDeterminant,
                 },
-                trimmers,
+                nameProcessors,
                 functionSyntax
             );
 
@@ -461,15 +461,15 @@ NamePrettifier namePrettifier
         return result;
     }
 
-    private void Trim(
-        NameTrimmerContext context,
-        IEnumerable<INameTrimmer> trimmers,
+    private void ProcessNames(
+        NameProcessorContext context,
+        IEnumerable<INameProcessor> nameProcessors,
         Dictionary<string, IEnumerable<MethodDeclarationSyntax>>? functionSyntax = null
     )
     {
         // Ensure the trimmers don't see names that have been manually overridden, as we don't want them to influence
         // automatic prefix determination for example
-        var namesToTrim = context.Names;
+        var namesToProcess = context.Names;
         foreach (var (nativeName, overriddenName) in context.Configuration.NameOverrides)
         {
             var nameToAdd = nativeName;
@@ -497,21 +497,21 @@ private void Trim(
                 }
             }
 
-            if (!namesToTrim.TryGetValue(nameToAdd, out var v))
+            if (!namesToProcess.TryGetValue(nameToAdd, out var v))
             {
                 continue;
             }
 
             // If we haven't created the differentiated dictionary yet, then do so now. We do want to keep the original
             // dictionary so we can actually apply the renames; if we have created two different branching dictionaries
-            // they are recombined following trimming.
-            if (namesToTrim == context.Names)
+            // they are recombined following name processing.
+            if (namesToProcess == context.Names)
             {
-                namesToTrim = namesToTrim.ToDictionary();
+                namesToProcess = namesToProcess.ToDictionary();
             }
 
-            // Don't let the trimmers see the overridden native name.
-            namesToTrim.Remove(nameToAdd);
+            // Don't let the name processors see the overridden native name.
+            namesToProcess.Remove(nameToAdd);
 
             // Apply the name override to the dictionary we actually use.
             context.Names[nameToAdd] = new CandidateNames(
@@ -520,16 +520,16 @@ private void Trim(
             );
         }
 
-        // Run each trimmer
-        foreach (var trimmer in trimmers)
+        // Run each name processor
+        foreach (var nameProcessor in nameProcessors)
         {
-            trimmer.Trim(context with { Names = namesToTrim });
+            nameProcessor.ProcessNames(context with { Names = namesToProcess });
         }
 
         // Apply changes
-        if (namesToTrim != context.Names)
+        if (namesToProcess != context.Names)
         {
-            foreach (var (evalName, result) in namesToTrim)
+            foreach (var (evalName, result) in namesToProcess)
             {
                 context.Names[evalName] = result;
             }
@@ -1201,7 +1201,7 @@ Dictionary<string, NameAffixConfiguration> config
         /// Removes affixes from the specified primary name and adds the original specified primary to the secondary list if provided.
         /// </summary>
         /// <remarks>
-        /// Designed to be used by either <see cref="ApplyPrettifyOnlyPipeline"/> or <see cref="NameAffixerEarlyTrimmer"/>.
+        /// Designed to be used by either <see cref="ApplyPrettifyOnlyPipeline"/> or <see cref="NameAffixerEarlyNameProcessor"/>.
         /// </remarks>
         /// <param name="primary">The current primary name.</param>
         /// <param name="container">The container name. Either null or the containing type.</param>
@@ -1234,7 +1234,7 @@ public string RemoveAffixes(
         /// Applies affixes to the specified primary name and adds fallbacks to the secondary list if provided.
         /// </summary>
         /// <remarks>
-        /// Designed to be used by either <see cref="ApplyPrettifyOnlyPipeline"/> or <see cref="NameAffixerLateTrimmer"/>.
+        /// Designed to be used by either <see cref="ApplyPrettifyOnlyPipeline"/> or <see cref="NameAffixerLateNameProcessor"/>.
         /// </remarks>
         /// <param name="primary">The current primary name.</param>
         /// <param name="container">The container name. Either null or the containing type.</param>
@@ -1397,12 +1397,12 @@ private NameAffixConfiguration GetConfiguration(string category) =>
     }
 
     /// <summary>
-    /// Removes identified affixes so that other trimmers can process the base name separately.
-    /// These affixes should be reapplied by <see cref="NameAffixerLateTrimmer"/>.
+    /// Removes identified affixes so that other name processors can process the base name separately.
+    /// These affixes should be reapplied by <see cref="NameAffixerLateNameProcessor"/>.
     /// </summary>
-    private class NameAffixerEarlyTrimmer(PrettifyNamesAffixer affixer) : INameTrimmer
+    private class NameAffixerEarlyNameProcessor(PrettifyNamesAffixer affixer) : INameProcessor
     {
-        public void Trim(NameTrimmerContext context)
+        public void ProcessNames(NameProcessorContext context)
         {
             if (context.Container == null)
             {
@@ -1430,9 +1430,9 @@ public void Trim(NameTrimmerContext context)
         }
     }
 
-    private class PrettifyNamesTrimmer(NamePrettifier namePrettifier) : INameTrimmer
+    private class PrettifyNameProcessor(NamePrettifier namePrettifier) : INameProcessor
     {
-        public void Trim(NameTrimmerContext context)
+        public void ProcessNames(NameProcessorContext context)
         {
             foreach (var (original, (primary, secondary)) in context.Names)
             {
@@ -1455,9 +1455,9 @@ public void Trim(NameTrimmerContext context)
     /// <summary>
     /// Reapplies and transforms identified affixes based on <see cref="NameAffixConfiguration"/>.
     /// </summary>
-    private class NameAffixerLateTrimmer(PrettifyNamesAffixer affixer) : INameTrimmer
+    private class NameAffixerLateNameProcessor(PrettifyNamesAffixer affixer) : INameProcessor
     {
-        public void Trim(NameTrimmerContext context)
+        public void ProcessNames(NameProcessorContext context)
         {
             if (context.Container == null)
             {
@@ -1485,9 +1485,9 @@ public void Trim(NameTrimmerContext context)
         }
     }
 
-    private class PrefixIfStartsWithNumberTrimmer : INameTrimmer
+    private class PrefixIfStartsWithNumberNameProcessor : INameProcessor
     {
-        public void Trim(NameTrimmerContext context)
+        public void ProcessNames(NameProcessorContext context)
         {
             foreach (var (original, (primary, secondary)) in context.Names)
             {

sources/SilkTouch/SilkTouch/Naming/INameProcessor.cs

@@ -0,0 +1,12 @@
+namespace Silk.NET.SilkTouch.Naming;
+
+/// <summary>
+/// Represents a name processor.
+/// </summary>
+public interface INameProcessor
+{
+    /// <summary>
+    /// Process and transform the names within the given container.
+    /// </summary>
+    public void ProcessNames(NameProcessorContext context);
+}

sources/SilkTouch/SilkTouch/Naming/INameTrimmer.cs

@@ -6,9 +6,9 @@
 namespace Silk.NET.SilkTouch.Naming;
 
 /// <summary>
-/// State made available to <see cref="INameTrimmer"/> implementations when determining a trimmed name.
+/// State made available to <see cref="INameProcessor"/> implementations when determining a trimmed name.
 /// </summary>
-public readonly struct NameTrimmerContext
+public readonly struct NameProcessorContext
 {
     /// <summary>
     /// Gets the name of the "container" (e.g. a type name) of the APIs in <see cref="Names"/>.

…h/SilkTouch/Naming/NameTrimmerContext.cs …SilkTouch/Naming/NameProcessorContext.cssources/SilkTouch/SilkTouch/Naming/NameTrimmerContext.cs renamed to sources/SilkTouch/SilkTouch/Naming/NameProcessorContext.cs sources/SilkTouch/SilkTouch/Naming/NameTrimmerContext.cs renamed to sources/SilkTouch/SilkTouch/Naming/NameProcessorContext.cs

@@ -3,7 +3,7 @@
 /// <summary>
 /// The default name trimmer ported from Silk.NET 2.18 with modifications for 3.0.
 /// </summary>
-public class NameTrimmer : INameTrimmer
+public class NameTrimmer : INameProcessor
 {
     /// <summary>
     /// Determines whether a second pass without using <see cref="GetTrimmingName"/> is warranted.
@@ -20,7 +20,7 @@ public class NameTrimmer : INameTrimmer
     private static readonly HashSet<string> s_forbiddenTrimmings = new() { "unsigned", "per" };
 
     /// <inheritdoc />
-    public void Trim(NameTrimmerContext context)
+    public void ProcessNames(NameProcessorContext context)
     {
         string? identifiedPrefix = null;
         List<AugmentedCandidateNames> localNames = null!;

sources/SilkTouch/SilkTouch/Naming/NameTrimmer.cs

@@ -55,7 +55,7 @@ static ServiceCollectionExtensions()
     /// <item><description><see cref="ResponseFileHandler"/></description></item>
     /// <item><description><see cref="SilkTouchGenerator"/></description></item>
     /// <item><description><see cref="NameTrimmer"/></description></item>
-    /// <item><description>One or more <see cref="INameTrimmer"/>s</description></item>
+    /// <item><description>One or more <see cref="INameProcessor"/>s</description></item>
     /// <item><description>An appropriate implementation of <see cref="IStdIncludeResolver"/></description></item>
     /// <item><description>Mod implementations referenced in the configurations</description></item>
     /// <item>

sources/SilkTouch/SilkTouch/ServiceCollectionExtensions.cs

@@ -27,8 +27,8 @@ public void SimpleGlfwTestDetermination(string? hint)
             GetPrefix(null, hint, test, null, null, false, true)?.Prefix,
             Is.EqualTo("GLFW")
         );
-        Trim(
-            new NameTrimmerContext
+        ProcessNames(
+            new NameProcessorContext
             {
                 Configuration = new PrettifyNames.Configuration
                 {
@@ -66,8 +66,8 @@ public void RegressionFragmentShaderColorModMaskATI()
             { "GL_NEGATE_BIT_ATI", new CandidateNames("GL_NEGATE_BIT_ATI", []) },
             { "GL_BIAS_BIT_ATI", new CandidateNames("GL_BIAS_BIT_ATI", []) },
         };
-        Trim(
-            new NameTrimmerContext
+        ProcessNames(
+            new NameProcessorContext
             {
                 Container = "FragmentShaderColorModMaskATI",
                 Configuration = new PrettifyNames.Configuration { GlobalPrefixHints = ["gl"] },
@@ -96,8 +96,8 @@ public void RegressionEvalTargetNV()
             { "GL_EVAL_2D_NV", new CandidateNames("GL_EVAL_2D_NV", []) },
             { "GL_EVAL_TRIANGULAR_2D_NV", new CandidateNames("GL_EVAL_TRIANGULAR_2D_NV", []) },
         };
-        Trim(
-            new NameTrimmerContext
+        ProcessNames(
+            new NameProcessorContext
             {
                 Container = "EvalTargetNV",
                 Configuration = new PrettifyNames.Configuration { GlobalPrefixHints = ["gl"] },
@@ -123,15 +123,15 @@ public void RegressionSingleMemberEnumUsesGlobalPrefixHint()
         {
             { "GL_FILL_NV", new CandidateNames("GL_FILL_NV", []) },
         };
-        var ctx = new NameTrimmerContext
+        var ctx = new NameProcessorContext
         {
             Configuration = new PrettifyNames.Configuration { GlobalPrefixHints = ["gl"] },
             Container = "EvalMapsModeNV",
             JobKey = "OpenGL",
             Names = names,
         };
         var uut = new NameTrimmer();
-        uut.Trim(ctx);
+        uut.ProcessNames(ctx);
         Assert.That(names["GL_FILL_NV"].Primary, Is.EqualTo("FILL_NV"));
     }
 
@@ -142,15 +142,15 @@ public void MultipleGlobalPrefixHints()
         {
             { "ALC_CONTEXT_DEBUG_BIT_EXT", new CandidateNames("ALC_CONTEXT_DEBUG_BIT_EXT", []) },
         };
-        var ctx = new NameTrimmerContext
+        var ctx = new NameProcessorContext
         {
             Configuration = new PrettifyNames.Configuration { GlobalPrefixHints = ["alc", "al"] },
             Container = "ContextFlagsEXT",
             JobKey = "OpenAL",
             Names = names,
         };
         var uut = new NameTrimmer();
-        uut.Trim(ctx);
+        uut.ProcessNames(ctx);
         Assert.That(
             names["ALC_CONTEXT_DEBUG_BIT_EXT"].Primary,
             Is.EqualTo("CONTEXT_DEBUG_BIT_EXT")