Files
Terminal.Gui/UnitTests/Views/HexViewTests.cs
2024-05-30 07:38:15 -06:00

451 lines
15 KiB
C#

using System.Text;
namespace Terminal.Gui.ViewsTests;
public class HexViewTests
{
[Fact]
public void AllowEdits_Edits_ApplyEdits ()
{
var hv = new HexView (LoadStream (true)) { Width = 20, Height = 20 };
// Needed because HexView relies on LayoutComplete to calc sizes
hv.LayoutSubviews ();
Assert.Empty (hv.Edits);
hv.AllowEdits = false;
Assert.True (hv.NewKeyDownEvent (Key.Home));
Assert.False (hv.NewKeyDownEvent (Key.A));
Assert.Empty (hv.Edits);
Assert.Equal (126, hv.Source.Length);
hv.AllowEdits = true;
Assert.True (hv.NewKeyDownEvent (Key.D4));
Assert.True (hv.NewKeyDownEvent (Key.D1));
Assert.Single (hv.Edits);
Assert.Equal (65, hv.Edits.ToList () [0].Value);
Assert.Equal ('A', (char)hv.Edits.ToList () [0].Value);
Assert.Equal (126, hv.Source.Length);
// Appends byte
Assert.True (hv.NewKeyDownEvent (Key.End));
Assert.True (hv.NewKeyDownEvent (Key.D4));
Assert.True (hv.NewKeyDownEvent (Key.D2));
Assert.Equal (2, hv.Edits.Count);
Assert.Equal (66, hv.Edits.ToList () [1].Value);
Assert.Equal ('B', (char)hv.Edits.ToList () [1].Value);
Assert.Equal (126, hv.Source.Length);
hv.ApplyEdits ();
Assert.Empty (hv.Edits);
Assert.Equal (127, hv.Source.Length);
}
[Fact]
public void ApplyEdits_With_Argument ()
{
byte [] buffer = Encoding.Default.GetBytes ("Fest");
var original = new MemoryStream ();
original.Write (buffer, 0, buffer.Length);
original.Flush ();
var copy = new MemoryStream ();
original.Position = 0;
original.CopyTo (copy);
copy.Flush ();
var hv = new HexView (copy) { Width = Dim.Fill (), Height = Dim.Fill () };
// Needed because HexView relies on LayoutComplete to calc sizes
hv.LayoutSubviews ();
var readBuffer = new byte [hv.Source.Length];
hv.Source.Position = 0;
hv.Source.Read (readBuffer);
Assert.Equal ("Fest", Encoding.Default.GetString (readBuffer));
Assert.True (hv.NewKeyDownEvent (Key.D5));
Assert.True (hv.NewKeyDownEvent (Key.D4));
readBuffer [hv.Edits.ToList () [0].Key] = hv.Edits.ToList () [0].Value;
Assert.Equal ("Test", Encoding.Default.GetString (readBuffer));
hv.ApplyEdits (original);
original.Position = 0;
original.Read (buffer);
copy.Position = 0;
copy.Read (readBuffer);
Assert.Equal ("Test", Encoding.Default.GetString (buffer));
Assert.Equal ("Test", Encoding.Default.GetString (readBuffer));
Assert.Equal (Encoding.Default.GetString (buffer), Encoding.Default.GetString (readBuffer));
}
[Fact]
public void Constructors_Defaults ()
{
var hv = new HexView ();
Assert.NotNull (hv.Source);
Assert.IsAssignableFrom<MemoryStream> (hv.Source);
Assert.True (hv.CanFocus);
Assert.True (hv.AllowEdits);
hv = new (new MemoryStream ());
Assert.NotNull (hv.Source);
Assert.IsAssignableFrom<Stream> (hv.Source);
Assert.True (hv.CanFocus);
Assert.True (hv.AllowEdits);
}
[Fact]
[AutoInitShutdown]
public void CursorPosition_Encoding_Default ()
{
var hv = new HexView (LoadStream ()) { Width = Dim.Fill (), Height = Dim.Fill () };
var top = new Toplevel ();
top.Add (hv);
Application.Begin (top);
Assert.Equal (new (1, 1), hv.CursorPosition);
Assert.True (hv.NewKeyDownEvent (Key.Enter));
Assert.True (hv.NewKeyDownEvent (Key.CursorRight.WithCtrl));
Assert.Equal (hv.CursorPosition.X, hv.BytesPerLine);
Assert.True (hv.NewKeyDownEvent (Key.Home));
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.Equal (new (2, 1), hv.CursorPosition);
Assert.True (hv.NewKeyDownEvent (Key.CursorDown));
Assert.Equal (new (2, 2), hv.CursorPosition);
Assert.True (hv.NewKeyDownEvent (Key.End));
int col = hv.CursorPosition.X;
int line = hv.CursorPosition.Y;
int offset = (line - 1) * (hv.BytesPerLine - col);
Assert.Equal (hv.Position, col * line + offset);
top.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void CursorPosition_Encoding_Unicode ()
{
var hv = new HexView (LoadStream (true)) { Width = Dim.Fill (), Height = Dim.Fill () };
var top = new Toplevel ();
top.Add (hv);
Application.Begin (top);
Assert.Equal (new (1, 1), hv.CursorPosition);
Assert.True (hv.NewKeyDownEvent (Key.Enter));
Assert.True (hv.NewKeyDownEvent (Key.CursorRight.WithCtrl));
Assert.Equal (hv.CursorPosition.X, hv.BytesPerLine);
Assert.True (hv.NewKeyDownEvent (Key.Home));
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.Equal (new (2, 1), hv.CursorPosition);
Assert.True (hv.NewKeyDownEvent (Key.CursorDown));
Assert.Equal (new (2, 2), hv.CursorPosition);
Assert.True (hv.NewKeyDownEvent (Key.End));
int col = hv.CursorPosition.X;
int line = hv.CursorPosition.Y;
int offset = (line - 1) * (hv.BytesPerLine - col);
Assert.Equal (hv.Position, col * line + offset);
top.Dispose ();
}
[Fact]
public void DiscardEdits_Method ()
{
var hv = new HexView (LoadStream (true)) { Width = 20, Height = 20 };
// Needed because HexView relies on LayoutComplete to calc sizes
hv.LayoutSubviews ();
Assert.True (hv.NewKeyDownEvent (Key.D4));
Assert.True (hv.NewKeyDownEvent (Key.D1));
Assert.Single (hv.Edits);
Assert.Equal (65, hv.Edits.ToList () [0].Value);
Assert.Equal ('A', (char)hv.Edits.ToList () [0].Value);
Assert.Equal (126, hv.Source.Length);
hv.DiscardEdits ();
Assert.Empty (hv.Edits);
}
[Fact]
public void DisplayStart_Source ()
{
var hv = new HexView (LoadStream (true)) { Width = 20, Height = 20 };
// Needed because HexView relies on LayoutComplete to calc sizes
hv.LayoutSubviews ();
Assert.Equal (0, hv.DisplayStart);
Assert.True (hv.NewKeyDownEvent (Key.PageDown));
Assert.Equal (4 * hv.Frame.Height, hv.DisplayStart);
Assert.Equal (hv.Source.Length, hv.Source.Position);
Assert.True (hv.NewKeyDownEvent (Key.End));
// already on last page and so the DisplayStart is the same as before
Assert.Equal (4 * hv.Frame.Height, hv.DisplayStart);
Assert.Equal (hv.Source.Length, hv.Source.Position);
}
[Fact]
public void Edited_Event ()
{
var hv = new HexView (LoadStream (true)) { Width = 20, Height = 20 };
// Needed because HexView relies on LayoutComplete to calc sizes
hv.LayoutSubviews ();
KeyValuePair<long, byte> keyValuePair = default;
hv.Edited += (s, e) => keyValuePair = new (e.Position, e.NewValue);
Assert.True (hv.NewKeyDownEvent (Key.D4));
Assert.True (hv.NewKeyDownEvent (Key.D6));
Assert.Equal (0, (int)keyValuePair.Key);
Assert.Equal (70, keyValuePair.Value);
Assert.Equal ('F', (char)keyValuePair.Value);
}
[Fact]
public void Exceptions_Tests ()
{
Assert.Throws<ArgumentNullException> (() => new HexView (null));
Assert.Throws<ArgumentException> (() => new HexView (new NonSeekableStream (new MemoryStream ())));
}
[Fact]
[AutoInitShutdown]
public void KeyBindings_Command ()
{
var hv = new HexView (LoadStream ()) { Width = 20, Height = 10 };
var top = new Toplevel ();
top.Add (hv);
Application.Begin (top);
Assert.Equal (63, hv.Source.Length);
Assert.Equal (1, hv.Position);
Assert.Equal (4, hv.BytesPerLine);
// right side only needed to press one time
Assert.True (hv.NewKeyDownEvent (Key.Enter));
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.Equal (2, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorLeft));
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorDown));
Assert.Equal (5, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorUp));
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.V.WithCtrl));
Assert.Equal (41, hv.Position);
Assert.True (hv.NewKeyDownEvent (new (Key.V.WithAlt)));
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.PageDown));
Assert.Equal (41, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.PageUp));
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.End));
Assert.Equal (64, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.Home));
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorRight.WithCtrl));
Assert.Equal (4, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorLeft.WithCtrl));
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorDown.WithCtrl));
Assert.Equal (37, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorUp.WithCtrl));
Assert.Equal (1, hv.Position);
top.Dispose ();
}
[Fact]
public void Position_Using_Encoding_Default ()
{
var hv = new HexView (LoadStream ()) { Width = 20, Height = 20 };
// Needed because HexView relies on LayoutComplete to calc sizes
hv.LayoutSubviews ();
Assert.Equal (63, hv.Source.Length);
Assert.Equal (63, hv.Source.Position);
Assert.Equal (1, hv.Position);
// left side needed to press twice
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (2, hv.Position);
// right side only needed to press one time
Assert.True (hv.NewKeyDownEvent (Key.Enter));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (2, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorLeft));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (1, hv.Position);
// last position is equal to the source length
Assert.True (hv.NewKeyDownEvent (Key.End));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (64, hv.Position);
Assert.Equal (hv.Position - 1, hv.Source.Length);
}
[Fact]
public void Position_Using_Encoding_Unicode ()
{
var hv = new HexView (LoadStream (true)) { Width = 20, Height = 20 };
// Needed because HexView relies on LayoutComplete to calc sizes
hv.LayoutSubviews ();
Assert.Equal (126, hv.Source.Length);
Assert.Equal (126, hv.Source.Position);
Assert.Equal (1, hv.Position);
// left side needed to press twice
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (1, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (2, hv.Position);
// right side only needed to press one time
Assert.True (hv.NewKeyDownEvent (Key.Enter));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (2, hv.Position);
Assert.True (hv.NewKeyDownEvent (Key.CursorLeft));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (1, hv.Position);
// last position is equal to the source length
Assert.True (hv.NewKeyDownEvent (Key.End));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (127, hv.Position);
Assert.Equal (hv.Position - 1, hv.Source.Length);
}
[Fact]
[AutoInitShutdown]
public void PositionChanged_Event ()
{
var hv = new HexView (LoadStream ()) { Width = Dim.Fill (), Height = Dim.Fill () };
HexViewEventArgs hexViewEventArgs = null;
hv.PositionChanged += (s, e) => hexViewEventArgs = e;
var top = new Toplevel ();
top.Add (hv);
Application.Begin (top);
Assert.True (hv.NewKeyDownEvent (Key.CursorRight)); // left side must press twice
Assert.True (hv.NewKeyDownEvent (Key.CursorRight));
Assert.True (hv.NewKeyDownEvent (Key.CursorDown));
Assert.Equal (12, hexViewEventArgs.BytesPerLine);
Assert.Equal (new (2, 2), hexViewEventArgs.CursorPosition);
Assert.Equal (14, hexViewEventArgs.Position);
top.Dispose ();
}
[Fact]
[AutoInitShutdown]
public void Source_Sets_DisplayStart_And_Position_To_Zero_If_Greater_Than_Source_Length ()
{
var hv = new HexView (LoadStream ()) { Width = 10, Height = 5 };
var top = new Toplevel ();
top.Add (hv);
Application.Begin (top);
Assert.True (hv.NewKeyDownEvent (Key.End));
Assert.Equal (62, hv.DisplayStart);
Assert.Equal (64, hv.Position);
hv.Source = new MemoryStream ();
Assert.Equal (0, hv.DisplayStart);
Assert.Equal (0, hv.Position - 1);
hv.Source = LoadStream ();
hv.Width = Dim.Fill ();
hv.Height = Dim.Fill ();
top.LayoutSubviews ();
Assert.Equal (0, hv.DisplayStart);
Assert.Equal (0, hv.Position - 1);
Assert.True (hv.NewKeyDownEvent (Key.End));
Assert.Equal (0, hv.DisplayStart);
Assert.Equal (64, hv.Position);
hv.Source = new MemoryStream ();
Assert.Equal (0, hv.DisplayStart);
Assert.Equal (0, hv.Position - 1);
top.Dispose ();
}
private Stream LoadStream (bool unicode = false)
{
var stream = new MemoryStream ();
byte [] bArray;
var memString = "Hello world.\nThis is a test of the Emergency Broadcast System.\n";
Assert.Equal (63, memString.Length);
if (unicode)
{
bArray = Encoding.Unicode.GetBytes (memString);
Assert.Equal (126, bArray.Length);
}
else
{
bArray = Encoding.Default.GetBytes (memString);
Assert.Equal (63, bArray.Length);
}
stream.Write (bArray);
return stream;
}
private class NonSeekableStream : Stream
{
private readonly Stream m_stream;
public NonSeekableStream (Stream baseStream) { m_stream = baseStream; }
public override bool CanRead => m_stream.CanRead;
public override bool CanSeek => false;
public override bool CanWrite => m_stream.CanWrite;
public override long Length => throw new NotSupportedException ();
public override long Position
{
get => m_stream.Position;
set => throw new NotSupportedException ();
}
public override void Flush () { m_stream.Flush (); }
public override int Read (byte [] buffer, int offset, int count) { return m_stream.Read (buffer, offset, count); }
public override long Seek (long offset, SeekOrigin origin) { throw new NotImplementedException (); }
public override void SetLength (long value) { throw new NotSupportedException (); }
public override void Write (byte [] buffer, int offset, int count) { m_stream.Write (buffer, offset, count); }
}
}