Ordered evaluation in FileSystemGlobbing Matcher (dotnet#115940)

Co-authored-by: kasperk81 <[email protected]>

Author: PranavSenthilnathan

src/libraries/Microsoft.Extensions.FileSystemGlobbing/ref/Microsoft.Extensions.FileSystemGlobbing.cs

@@ -31,6 +31,7 @@ public partial class Matcher
     {
         public Matcher() { }
         public Matcher(System.StringComparison comparisonType) { }
+        public Matcher(System.StringComparison comparisonType = System.StringComparison.OrdinalIgnoreCase, bool preserveFilterOrder = false) { }
         public virtual Microsoft.Extensions.FileSystemGlobbing.Matcher AddExclude(string pattern) { throw null; }
         public virtual Microsoft.Extensions.FileSystemGlobbing.Matcher AddInclude(string pattern) { throw null; }
         public virtual Microsoft.Extensions.FileSystemGlobbing.PatternMatchingResult Execute(Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase directoryInfo) { throw null; }

src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/Internal/IncludeOrExcludeValue.cs

@@ -0,0 +1,11 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.Extensions.FileSystemGlobbing.Internal
+{
+    internal struct IncludeOrExcludeValue<TValue>
+    {
+        internal TValue Value;
+        internal bool IsInclude;
+    }
+}

src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/Internal/MatcherContext.cs

@@ -6,6 +6,7 @@
 using System.Linq;
 using Microsoft.Extensions.FileSystemGlobbing.Abstractions;
 using Microsoft.Extensions.FileSystemGlobbing.Internal.PathSegments;
+using Microsoft.Extensions.FileSystemGlobbing.Internal.PatternContexts;
 using Microsoft.Extensions.FileSystemGlobbing.Util;
 
 namespace Microsoft.Extensions.FileSystemGlobbing.Internal
@@ -17,8 +18,7 @@ namespace Microsoft.Extensions.FileSystemGlobbing.Internal
     public class MatcherContext
     {
         private readonly DirectoryInfoBase _root;
-        private readonly IPatternContext[] _includePatternContexts;
-        private readonly IPatternContext[] _excludePatternContexts;
+        private readonly IPatternContext _patternContext;
         private readonly List<FilePatternMatch> _files;
 
         private readonly HashSet<string> _declaredLiteralFolderSegmentInString;
@@ -27,22 +27,33 @@ public class MatcherContext
         private bool _declaredParentPathSegment;
         private bool _declaredWildcardPathSegment;
 
-        private readonly StringComparison _comparisonType;
-
-        public MatcherContext(
-            IEnumerable<IPattern> includePatterns,
-            IEnumerable<IPattern> excludePatterns,
-            DirectoryInfoBase directoryInfo,
-            StringComparison comparison)
+        public MatcherContext(IEnumerable<IPattern> includePatterns, IEnumerable<IPattern> excludePatterns, DirectoryInfoBase directoryInfo, StringComparison comparison)
         {
             _root = directoryInfo;
-            _files = new List<FilePatternMatch>();
-            _comparisonType = comparison;
+            _files = [];
+            _declaredLiteralFolderSegmentInString = new HashSet<string>(StringComparisonHelper.GetStringComparer(comparison));
 
-            _includePatternContexts = includePatterns.Select(pattern => pattern.CreatePatternContextForInclude()).ToArray();
-            _excludePatternContexts = excludePatterns.Select(pattern => pattern.CreatePatternContextForExclude()).ToArray();
+            IPatternContext[] includePatternContexts = includePatterns.Select(pattern => pattern.CreatePatternContextForInclude()).ToArray();
+            IPatternContext[] excludePatternContexts = excludePatterns.Select(pattern => pattern.CreatePatternContextForExclude()).ToArray();
+
+            _patternContext = new IncludesFirstCompositePatternContext(includePatternContexts, excludePatternContexts);
+        }
 
+        internal MatcherContext(List<IncludeOrExcludeValue<IPattern>> orderedPatterns, DirectoryInfoBase directoryInfo, StringComparison comparison)
+        {
+            _root = directoryInfo;
+            _files = [];
             _declaredLiteralFolderSegmentInString = new HashSet<string>(StringComparisonHelper.GetStringComparer(comparison));
+
+            IncludeOrExcludeValue<IPatternContext>[] includeOrExcludePatternContexts = orderedPatterns
+                .Select(item => new IncludeOrExcludeValue<IPatternContext>
+                {
+                    Value = item.IsInclude ? item.Value.CreatePatternContextForInclude() : item.Value.CreatePatternContextForExclude(),
+                    IsInclude = item.IsInclude
+                })
+                .ToArray();
+
+            _patternContext = new PreserveOrderCompositePatternContext(includeOrExcludePatternContexts);
         }
 
         public PatternMatchingResult Execute()
@@ -57,7 +68,7 @@ public PatternMatchingResult Execute()
         private void Match(DirectoryInfoBase directory, string? parentRelativePath)
         {
             // Request all the including and excluding patterns to push current directory onto their status stack.
-            PushDirectory(directory);
+            _patternContext.PushDirectory(directory);
             Declare();
 
             var entities = new List<FileSystemInfoBase?>();
@@ -89,7 +100,7 @@ private void Match(DirectoryInfoBase directory, string? parentRelativePath)
             {
                 if (entity is FileInfoBase fileInfo)
                 {
-                    PatternTestResult result = MatchPatternContexts(fileInfo, (pattern, file) => pattern.Test(file));
+                    PatternTestResult result = _patternContext.Test(fileInfo);
                     if (result.IsSuccessful)
                     {
                         _files.Add(new FilePatternMatch(
@@ -102,7 +113,7 @@ private void Match(DirectoryInfoBase directory, string? parentRelativePath)
 
                 if (entity is DirectoryInfoBase directoryInfo)
                 {
-                    if (MatchPatternContexts(directoryInfo, (pattern, dir) => pattern.Test(dir)))
+                    if (_patternContext.Test(directoryInfo))
                     {
                         subDirectories.Add(directoryInfo);
                     }
@@ -120,7 +131,7 @@ private void Match(DirectoryInfoBase directory, string? parentRelativePath)
             }
 
             // Request all the including and excluding patterns to pop their status stack.
-            PopDirectory();
+            _patternContext.PopDirectory();
         }
 
         private void Declare()
@@ -129,10 +140,7 @@ private void Declare()
             _declaredParentPathSegment = false;
             _declaredWildcardPathSegment = false;
 
-            foreach (IPatternContext include in _includePatternContexts)
-            {
-                include.Declare(DeclareInclude);
-            }
+            _patternContext.Declare(DeclareInclude);
         }
 
         private void DeclareInclude(IPathSegment patternSegment, bool isLastSegment)
@@ -169,82 +177,5 @@ internal static string CombinePath(string? left, string right)
                 return $"{left}/{right}";
             }
         }
-
-        // Used to adapt Test(DirectoryInfoBase) for the below overload
-        private bool MatchPatternContexts<TFileInfoBase>(TFileInfoBase fileinfo, Func<IPatternContext, TFileInfoBase, bool> test)
-        {
-            return MatchPatternContexts(
-                fileinfo,
-                (ctx, file) =>
-                {
-                    if (test(ctx, file))
-                    {
-                        return PatternTestResult.Success(stem: string.Empty);
-                    }
-                    else
-                    {
-                        return PatternTestResult.Failed;
-                    }
-                }).IsSuccessful;
-        }
-
-        private PatternTestResult MatchPatternContexts<TFileInfoBase>(TFileInfoBase fileinfo, Func<IPatternContext, TFileInfoBase, PatternTestResult> test)
-        {
-            PatternTestResult result = PatternTestResult.Failed;
-
-            // If the given file/directory matches any including pattern, continues to next step.
-            foreach (IPatternContext context in _includePatternContexts)
-            {
-                PatternTestResult localResult = test(context, fileinfo);
-                if (localResult.IsSuccessful)
-                {
-                    result = localResult;
-                    break;
-                }
-            }
-
-            // If the given file/directory doesn't match any of the including pattern, returns false.
-            if (!result.IsSuccessful)
-            {
-                return PatternTestResult.Failed;
-            }
-
-            // If the given file/directory matches any excluding pattern, returns false.
-            foreach (IPatternContext context in _excludePatternContexts)
-            {
-                if (test(context, fileinfo).IsSuccessful)
-                {
-                    return PatternTestResult.Failed;
-                }
-            }
-
-            return result;
-        }
-
-        private void PopDirectory()
-        {
-            foreach (IPatternContext context in _excludePatternContexts)
-            {
-                context.PopDirectory();
-            }
-
-            foreach (IPatternContext context in _includePatternContexts)
-            {
-                context.PopDirectory();
-            }
-        }
-
-        private void PushDirectory(DirectoryInfoBase directory)
-        {
-            foreach (IPatternContext context in _includePatternContexts)
-            {
-                context.PushDirectory(directory);
-            }
-
-            foreach (IPatternContext context in _excludePatternContexts)
-            {
-                context.PushDirectory(directory);
-            }
-        }
     }
 }

src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/Internal/PatternContexts/CompositePatternContext.cs

@@ -0,0 +1,27 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using Microsoft.Extensions.FileSystemGlobbing.Abstractions;
+
+namespace Microsoft.Extensions.FileSystemGlobbing.Internal.PatternContexts
+{
+    internal abstract class CompositePatternContext : IPatternContext
+    {
+        public abstract void Declare(Action<IPathSegment, bool> onDeclare);
+        public abstract void PopDirectory();
+        public abstract void PushDirectory(DirectoryInfoBase directory);
+
+        protected internal abstract PatternTestResult MatchPatternContexts<TFileInfoBase>(
+            TFileInfoBase fileInfo,
+            Func<IPatternContext, TFileInfoBase, PatternTestResult> test);
+
+        public bool Test(DirectoryInfoBase directory) =>
+            MatchPatternContexts(directory,
+                static (context, dir) =>
+                    context.Test(dir) ? PatternTestResult.Success(stem: string.Empty) : PatternTestResult.Failed).IsSuccessful;
+
+        public PatternTestResult Test(FileInfoBase file) =>
+            MatchPatternContexts(file, static (context, fileInfo) => context.Test(fileInfo));
+    }
+}

src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/Internal/PatternContexts/IncludesFirstCompositePatternContext.cs

@@ -0,0 +1,87 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using Microsoft.Extensions.FileSystemGlobbing.Abstractions;
+
+namespace Microsoft.Extensions.FileSystemGlobbing.Internal.PatternContexts
+{
+    internal sealed class IncludesFirstCompositePatternContext : CompositePatternContext
+    {
+        private readonly IPatternContext[] _includePatternContexts;
+        private readonly IPatternContext[] _excludePatternContexts;
+
+        internal IncludesFirstCompositePatternContext(IPatternContext[] includePatternContexts, IPatternContext[] excludePatternContexts)
+        {
+            _includePatternContexts = includePatternContexts;
+            _excludePatternContexts = excludePatternContexts;
+        }
+
+        public override void Declare(Action<IPathSegment, bool> onDeclare)
+        {
+            foreach (IPatternContext include in _includePatternContexts)
+            {
+                include.Declare(onDeclare);
+            }
+        }
+
+        protected internal override PatternTestResult MatchPatternContexts<TFileInfoBase>(TFileInfoBase fileInfo, Func<IPatternContext, TFileInfoBase, PatternTestResult> test)
+        {
+            PatternTestResult result = PatternTestResult.Failed;
+
+            // If the given file/directory matches any including pattern, continues to next step.
+            foreach (IPatternContext context in _includePatternContexts)
+            {
+                PatternTestResult localResult = test(context, fileInfo);
+                if (localResult.IsSuccessful)
+                {
+                    result = localResult;
+                    break;
+                }
+            }
+
+            // If the given file/directory doesn't match any of the including pattern, returns false.
+            if (!result.IsSuccessful)
+            {
+                return PatternTestResult.Failed;
+            }
+
+            // If the given file/directory matches any excluding pattern, returns false.
+            foreach (IPatternContext context in _excludePatternContexts)
+            {
+                if (test(context, fileInfo).IsSuccessful)
+                {
+                    return PatternTestResult.Failed;
+                }
+            }
+
+            return result;
+        }
+
+        public override void PopDirectory()
+        {
+            foreach (IPatternContext context in _excludePatternContexts)
+            {
+                context.PopDirectory();
+            }
+
+            foreach (IPatternContext context in _includePatternContexts)
+            {
+                context.PopDirectory();
+            }
+        }
+
+        public override void PushDirectory(DirectoryInfoBase directory)
+        {
+            foreach (IPatternContext context in _includePatternContexts)
+            {
+                context.PushDirectory(directory);
+            }
+
+            foreach (IPatternContext context in _excludePatternContexts)
+            {
+                context.PushDirectory(directory);
+            }
+        }
+    }
+}

src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/Internal/PatternContexts/PreserveOrderCompositePatternContext.cs

@@ -0,0 +1,65 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System;
+using Microsoft.Extensions.FileSystemGlobbing.Abstractions;
+
+namespace Microsoft.Extensions.FileSystemGlobbing.Internal.PatternContexts
+{
+    internal sealed class PreserveOrderCompositePatternContext : CompositePatternContext
+    {
+        private readonly IncludeOrExcludeValue<IPatternContext>[] _includeOrExcludePatternContexts;
+
+        internal PreserveOrderCompositePatternContext(IncludeOrExcludeValue<IPatternContext>[] includeOrExcludePatternContexts) =>
+            _includeOrExcludePatternContexts = includeOrExcludePatternContexts;
+
+        public override void Declare(Action<IPathSegment, bool> onDeclare)
+        {
+            foreach (IncludeOrExcludeValue<IPatternContext> context in _includeOrExcludePatternContexts)
+            {
+                if (context.IsInclude)
+                {
+                    context.Value.Declare(onDeclare);
+                }
+            }
+        }
+
+        protected internal override PatternTestResult MatchPatternContexts<TFileInfoBase>(TFileInfoBase fileInfo, Func<IPatternContext, TFileInfoBase, PatternTestResult> test)
+        {
+            PatternTestResult result = PatternTestResult.Failed;
+
+            foreach (IncludeOrExcludeValue<IPatternContext> context in _includeOrExcludePatternContexts)
+            {
+                // If the file is currently a match and the pattern is exclude, then test it to determine
+                // if we should unmatch. And if the file is currently not a match and the pattern is include,
+                // then test it to determine if we should match.
+                if (result.IsSuccessful != context.IsInclude)
+                {
+                    PatternTestResult localResult = test(context.Value, fileInfo);
+                    if (localResult.IsSuccessful)
+                    {
+                        result = context.IsInclude ? localResult : PatternTestResult.Failed;
+                    }
+                }
+            }
+
+            return result;
+        }
+
+        public override void PopDirectory()
+        {
+            foreach (IncludeOrExcludeValue<IPatternContext> context in _includeOrExcludePatternContexts)
+            {
+                context.Value.PopDirectory();
+            }
+        }
+
+        public override void PushDirectory(DirectoryInfoBase directory)
+        {
+            foreach (IncludeOrExcludeValue<IPatternContext> context in _includeOrExcludePatternContexts)
+            {
+                context.Value.PushDirectory(directory);
+            }
+        }
+    }
+}