Skip to content

Add DebuggerDisplay for SearchValues #86559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2023
Merged

Add DebuggerDisplay for SearchValues #86559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion src/libraries/System.Private.CoreLib/src/System/SearchValues/SearchValues.T.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ namespace System.Buffers
/// <remarks>
/// <see cref="SearchValues{T}"/> are optimized for situations where the same set of values is frequently used for searching at runtime.
/// </remarks>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
[DebuggerTypeProxy(typeof(SearchValuesDebugView<>))]
public class SearchValues<T> where T : IEquatable<T>?
{
// Only CoreLib can create derived types
private protected SearchValues() { }

/// <summary>Used by <see cref="SearchValuesDebugView{T}"/>.</summary>
/// <summary>Used by <see cref="DebuggerDisplay"/>s and <see cref="DebuggerTypeProxyAttribute"/>s for <see cref="SearchValues{T}"/>.</summary>
internal virtual T[] GetValues() => throw new UnreachableException();

/// <summary>
Expand Down Expand Up @@ -80,5 +81,24 @@ internal static int LastIndexOfAnyExcept(ReadOnlySpan<T> span, SearchValues<T> v

return values.LastIndexOfAnyExcept(span);
}

private string DebuggerDisplay
{
get
{
T[] values = GetValues();

string display = $"{GetType().Name}, Count={values.Length}";
Copy link
Member

@MihaZupan MihaZupan May 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using this in my testing, helps a ton when there are multiple generic variants.

Type implType = searchValuesInstance.GetType();
string impl = $"{implType.Name} [{string.Join(", ", implType.GenericTypeArguments.Select(t => t.Name))}]";

E.g.
SingleStringSearchValuesThreeChars`2 [ValueLength8OrLonger, CaseSensitive]

if (values.Length > 0)
{
display += ", Values=";
display += typeof(T) == typeof(char) ?
"\"" + new string(Unsafe.As<T[], char[]>(ref values)) + "\"" :
string.Join(",", values);
}

return display;
}
}
}
}
3 changes: 3 additions & 0 deletions src/libraries/System.Private.CoreLib/src/System/SearchValues/SearchValuesDebugView.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics;

namespace System.Buffers
{
internal sealed class SearchValuesDebugView<T> where T : IEquatable<T>?
Expand All @@ -13,6 +15,7 @@ public SearchValuesDebugView(SearchValues<T> values)
_values = values;
}

[DebuggerBrowsable(DebuggerBrowsableState.RootHidden)]
public T[] Values => _values.GetValues();
}
}