Keep case-sensitive globs off DotNet.Glob's global default [patch]

TextFilter.Test/GlobDefaultOptionsTests.cs

@@ -0,0 +1,42 @@
+// Copyright (c) 2023-2026 ktsu-dev contributors
+
+namespace TextFilter.Test;
+
+using DotNet.Globbing;
+using ktsu.TextFilter;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+/// <summary>
+/// TextFilter's case-sensitive globs stay case-sensitive when the host flips DotNet.Glob's
+/// process-wide <see cref="GlobOptions.Default"/> (ktsu-dev/TextFilter#188).
+/// </summary>
+[TestClass]
+public class GlobDefaultOptionsTests
+{
+	// Patterns no other test uses, so none of them is already in TextFilter's glob cache when the
+	// default is flipped and each is parsed for the first time under it.
+	[TestMethod]
+	[DoNotParallelize]
+	public void CaseSensitiveGlobIgnoresCaseInsensitiveGlobalDefault()
+	{
+		bool original = GlobOptions.Default.Evaluation.CaseInsensitive;
+		GlobOptions.Default.Evaluation.CaseInsensitive = true;
+		try
+		{
+			Assert.IsFalse(TextFilter.IsMatch("IMG.JPG188", "*.jpg188"),
+				"the default sensitivity should still be case-sensitive");
+			Assert.IsFalse(TextFilter.IsMatch("IMG.PNG188", "*.png188", TextFilterType.Glob,
+				TextFilterMatchOptions.ByWordAny, TextFilterCaseSensitivity.CaseSensitive),
+				"an explicit CaseSensitive should still be case-sensitive");
+			Assert.IsTrue(TextFilter.IsMatch("IMG.GIF188", "-*.gif188"),
+				"an exclusion should not hide an item that differs only in case");
+			Assert.IsTrue(TextFilter.IsMatch("IMG.BMP188", "*.bmp188", TextFilterType.Glob,
+				TextFilterMatchOptions.ByWordAny, TextFilterCaseSensitivity.CaseInsensitive),
+				"CaseInsensitive should still ignore case");
+		}
+		finally
+		{
+			GlobOptions.Default.Evaluation.CaseInsensitive = original;
+		}
+	}
+}

TextFilter.Test/ReadmeTests.cs

@@ -4,6 +4,7 @@ namespace TextFilter.Test;
 
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.IO;
 using System.Linq;
 using System.Reflection;
@@ -89,7 +90,10 @@ public void EveryMethodInTheReadmeApiReferenceExistsWithItsDocumentedDefaults()
 		foreach (Match row in rows)
 		{
 			string methodName = row.Groups["method"].Value;
-			MethodInfo[] overloads = [.. methods.Where(m => m.Name == methodName)];
+			// The binary-compatibility overloads are hidden from IntelliSense and deliberately carry no
+			// defaults, since defaults on both sets would make calls ambiguous. The README documents the
+			// visible overloads, so only those are held to its defaults.
+			MethodInfo[] overloads = [.. methods.Where(m => m.Name == methodName && !IsHiddenFromCallers(m))];
 			if (overloads.Length == 0)
 			{
 				problems.Add($"{methodName} does not exist");
@@ -115,6 +119,9 @@ public void EveryMethodInTheReadmeApiReferenceExistsWithItsDocumentedDefaults()
 		Assert.IsEmpty(problems, string.Join("; ", problems));
 	}
 
+	private static bool IsHiddenFromCallers(MethodInfo method) =>
+		method.GetCustomAttribute<EditorBrowsableAttribute>()?.State == EditorBrowsableState.Never;
+
 	[TestMethod]
 	public void ReadmeMatchOptionsSampleGivesTheDocumentedResults()
 	{

TextFilter/TextFilter.cs

@@ -117,6 +117,10 @@
 	private static string CacheKey(string pattern, TextFilterCaseSensitivity caseSensitivity) =>
 		caseSensitivity is TextFilterCaseSensitivity.CaseInsensitive ? "i:" + pattern : "s:" + pattern;
 
+	// Both sensitivities pass their own options. Glob.Parse without options reads DotNet.Glob's static,
+	// mutable GlobOptions.Default, so a host that sets GlobOptions.Default.Evaluation.CaseInsensitive
+	// would otherwise turn TextFilter's case-sensitive globs case-insensitive.
+	private static readonly GlobOptions CaseSensitiveGlobOptions = new() { Evaluation = { CaseInsensitive = false } };
 	private static readonly GlobOptions CaseInsensitiveGlobOptions = new() { Evaluation = { CaseInsensitive = true } };
 
 	// Filter patterns are caller-supplied text, so a pattern with catastrophic backtracking would
@@ -303,7 +307,7 @@
 
 			return ExcludedTokenPrefixes.Contains(prefix)
 				? TextFilterTokenType.Excluded
 				: RequiredTokenPrefixes.Contains(prefix)
 				? TextFilterTokenType.Required
 				: TextFilterTokenType.Optional;
 		})
@@ -334,7 +338,7 @@
 	/// matches nor rejects anything; as a required token it matches everything; and as an excluded
 	/// token it excludes nothing.
 	/// </remarks>
 	public static bool DoesMatchGlob(string text, string filter, TextFilterMatchOptions textFilterMatchOptions, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(text);
 		Ensure.NotNull(filter);
@@ -408,7 +412,7 @@
 	/// <param name="textTokens">The set of text tokens to match against.</param>
 	/// <param name="caseSensitivity">Whether the match distinguishes uppercase from lowercase.</param>
 	/// <returns><c>true</c> if any token matches the glob filter token; otherwise, <c>false</c>.</returns>
 	public static bool AnyTokenMatchesGlobFilter(string filterToken, HashSet<string> textTokens, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(filterToken);
 		Ensure.NotNull(textTokens);
@@ -425,7 +429,7 @@
 	/// <param name="textTokens">The set of text tokens to match against.</param>
 	/// <param name="caseSensitivity">Whether the match distinguishes uppercase from lowercase.</param>
 	/// <returns><c>true</c> if all tokens match the glob filter token; otherwise, <c>false</c>.</returns>
 	public static bool AllTokensMatchGlobFilter(string filterToken, HashSet<string> textTokens, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(filterToken);
 		Ensure.NotNull(textTokens);
@@ -509,7 +513,7 @@
 	// MaxGlobClassMembers characters, or that has no members at all because every range is reversed.
 	private const int MaxGlobClassMembers = 4096;
 
 	internal static string? ExpandGlobClasses(string token)
 	{
 		if (!token.Contains(']'))
 		{
@@ -672,7 +676,7 @@
 					.Where(pattern => pattern.Length != 0)
 					.Select(pattern => caseSensitivity is TextFilterCaseSensitivity.CaseInsensitive
 						? Glob.Parse(pattern, CaseInsensitiveGlobOptions)
-						: Glob.Parse(pattern))];
+						: Glob.Parse(pattern, CaseSensitiveGlobOptions))];
 				globs = parsed is { Length: > 0 } ? parsed : null;
 			}
 			catch (Exception ex) when (ex is not OutOfMemoryException)
@@ -712,7 +716,7 @@
 	/// <see cref="TextFilterMatchOptions.ByWholeString"/> for those.
 	/// </para>
 	/// </remarks>
 	public static bool DoesMatchRegex(string text, string filter, TextFilterMatchOptions textFilterMatchOptions, TextFilterCaseSensitivity caseSensitivity = TextFilterCaseSensitivity.CaseSensitive)
 	{
 		Ensure.NotNull(text);
 		Ensure.NotNull(filter);