mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
e24bd67658
* Add benchmarks for potentially optimizable RuneExtensions * Add new RuneExtensions.DecodeSurrogatePair benchmark implementation Avoids intermediate heap array allocations which is especially nice when the rune is not surrogate pair because then array heap allocations are completely avoided. * Enable nullable reference types in RuneExtensions * Make RuneExtensions.MaxUnicodeCodePoint readonly Makes sure no one can accidentally change the value. Ideally would be const value. * Optimize RuneExtensions.DecodeSurrogatePair * Remove duplicate Rune.GetUnicodeCategory call * Add new RuneExtensions.IsSurrogatePair benchmark implementation Avoids intermediate heap allocations by using stack allocated buffer. * Optimize RuneExtensions.IsSurrogatePair * Add RuneExtensions.GetEncodingLength tests * Optimize RuneExtensions.GetEncodingLength * Optimize RuneExtensions.Encode * Print encoding name in benchmark results * Rename variable to better match return description * Add RuneExtensions.EncodeSurrogatePair benchmark --------- Co-authored-by: Tig <tig@users.noreply.github.com>
67 lines
2.2 KiB
C#
67 lines
2.2 KiB
C#
using System.Text;
|
||
using BenchmarkDotNet.Attributes;
|
||
using Tui = Terminal.Gui;
|
||
|
||
namespace Terminal.Gui.Benchmarks.Text.RuneExtensions;
|
||
|
||
/// <summary>
|
||
/// Benchmarks for <see cref="Tui.RuneExtensions.DecodeSurrogatePair"/> performance fine-tuning.
|
||
/// </summary>
|
||
[MemoryDiagnoser]
|
||
[BenchmarkCategory (nameof (Tui.RuneExtensions))]
|
||
public class DecodeSurrogatePair
|
||
{
|
||
/// <summary>
|
||
/// Benchmark for previous implementation.
|
||
/// </summary>
|
||
/// <param name="rune"></param>
|
||
/// <returns></returns>
|
||
[Benchmark]
|
||
[ArgumentsSource (nameof (DataSource))]
|
||
public char []? Previous (Rune rune)
|
||
{
|
||
_ = RuneToStringToCharArray (rune, out char []? chars);
|
||
return chars;
|
||
}
|
||
|
||
/// <summary>
|
||
/// Benchmark for current implementation.
|
||
///
|
||
/// Utilizes Rune methods that take Span argument avoiding intermediate heap array allocation when combined with stack allocated intermediate buffer.
|
||
/// When rune is not surrogate pair there will be no heap allocation.
|
||
///
|
||
/// Final surrogate pair array allocation cannot be avoided due to the current method signature design.
|
||
/// Changing the method signature, or providing an alternative method, to take a destination Span would allow further optimizations by allowing caller to reuse buffer for consecutive calls.
|
||
/// </summary>
|
||
[Benchmark (Baseline = true)]
|
||
[ArgumentsSource (nameof (DataSource))]
|
||
public char []? Current (Rune rune)
|
||
{
|
||
_ = Tui.RuneExtensions.DecodeSurrogatePair (rune, out char []? chars);
|
||
return chars;
|
||
}
|
||
|
||
/// <summary>
|
||
/// Previous implementation with intermediate string allocation.
|
||
///
|
||
/// The IsSurrogatePair implementation at the time had hidden extra string allocation so there were intermediate heap allocations even if rune is not surrogate pair.
|
||
/// </summary>
|
||
private static bool RuneToStringToCharArray (Rune rune, out char []? chars)
|
||
{
|
||
if (rune.IsSurrogatePair ())
|
||
{
|
||
chars = rune.ToString ().ToCharArray ();
|
||
return true;
|
||
}
|
||
|
||
chars = null;
|
||
return false;
|
||
}
|
||
|
||
public static IEnumerable<object> DataSource ()
|
||
{
|
||
yield return new Rune ('a');
|
||
yield return "𝔹".EnumerateRunes ().Single ();
|
||
}
|
||
}
|