Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
bf99d724db5fcc7816bf88ca3ddf55ba3f58ff64
Terminal.Gui/UnitTests/HexViewTests.cs
Thomas Nind ea7981dc59 Adds Key Binding support. Also refactors Autocomplete and Undo/Redo. (#1556) 
* Refactored ProcessKey to use public methods for case logic

* Added KeyBinding class

* Refactored key binding to split key->command from command->implementation

This reduces duplication and simplifies the API

* Finishing key bindings implementation in ListView.

* Adding more unit tests to the ListView.

* Added key bindings to the Button and more features.

* Replaces Action for Func<KeyEvent, bool> on CommandImplementations.

* Allowing commands to have any number of arguments.

* Implementing key bindings on Checkbox view.

* Added test for changing HotKey in Button and made ReplaceKeyBinding protected

* Changed `CommandImplementations` to `Func<KeyEvent, bool>` to better understand current command implementations

* Implementing key bindings in ComboBox.

* Renamed Command keys and fixed ComboBox issues:

- Fixed pressing Esc in ListAndCombos scenario without selecting cause an array out of bounds error
- Changed the Esc key in ComboBox to also collapse the list selection
- Added bool return to public virtual method Expand and Collapse (this is a breaking change)

* Implementing key bindings in DateField.

* Organizing some things.

* Implementing key bindings on TimeField.

* No key bindings on FrameView.

* Added keybinding support to TreeView

* Added mouse support and more features.

* Updating NuGet packages.

* Putting text on the same line.

* Changing function command to Func<bool>.

* Added a read only Position, CursorPosition properties and events.

* Keybindings for GraphView

* Added a stream argument to ApplyEdits to only save the edits.

* Implementing key bindings on the HexView.

* Added MenuOpened event and others bug fixes.

* Fixing typo.

* Unifying constructors initializations.

* Implementing keybindings in the Menu.

* Removing unnecessary variable.

* Implementing keybindings in RadioGroup view.

* Changing Home to TopHome and End to BottomEnd.

* Implementing keybindings in the ScrollView.

* Changing the PageLeft and PageRight keybindings.

* Fixing PageLeft and RightPage.

* Removing CleanUp command.

* Key bindings for TabView

* Keybindings for TableView

* Fixed unit tests for PageDown to correctly assign input focus to the TableView

* Fixes the CalculateLeftColumn method avoiding jump two columns on forward moving.

* Fixes #1525. Gives the same backspace behavior as TextView.

* Changes kill-to-start key to work on Linux too.

* Fixes SelectedStart, SelectedText and some cleaning.

* Implementing keybindings in TextField.

* Updated command names and merged as discussed with @BDisp

- Merged LeftItem and LeftChar to Left (same for Right).
- Also renamed Kill to Cut
- Added ScrollLeft / ScrollRight (and renamed ScrollLineUp to just ScrollUp

* Renamed Command.InsertChar to ToggleOverwriteMode and added Enable/Disable

* Removed 'Mode' suffix from toggle overwrite

* Allows navigation to outside a TextView if IsMdiContainer is true.

* Implementing keybindings in Toplevel.

* Fixing null reference exception.

* Changing to keys instances events instead static.

* Transferring the events to the Toplevel.

* Implementing keybindings in TextView.

* Removing static from the QuitKeyChanged and adding unit test.

* Replacing Added with the Initialized event.

* Ignore control characters and other special keys.

* Changing InvokeKeybindings to return Nullable bool and added two more keys to the Toplevel.

* Implementing keybindings in Autocomplete. I had to derive from View.

* Added keybindings menu item to UICatalog

* Added ClearBinding

* Implementing IAutocomplete, abstract Autocomplete and derived TextViewAutocomplete.

* Implementing keybindings in the TextValidateProvider

* Add keybinding to CellActivationKey.

* Fixing some formats.

* Add ObjectActivationKey to the keybindings.

* Made it much easier to implement abstract base `Autocomplete` in other views by moving methods up out of `TextViewAutocomplete` implementation

* Allowing Autocomplete to popup inside or outside the container.

* Fixes the cursor not being showing if the text length is equal to the view width.

* A unit test to prove the 4df5897.

* Removed unused method `GetCursorPosition` from Autocomplete

* Trimmed down implementation specific methods from IAutocomplete

* Fixed xmldoc comment tag

* Format Autocomplete on multiline and fixes wrap settings.

* Adding keys from a to z to avoid the Key.Space on ToString.

* Fixes the vertical position outside the container.

* Adding more key unit tests.

* Changing comment to upper case and proving that doesn't will breaking nothing.

* Replaces Pos.Bottom to Pos.AnchorEnd.

* Fixes popup on resizing.

* Should only using the Pos.Bottom to position outside the view.

* Fixes #1584

* Fixes https://github.com/migueldeicaza/gui.cs/issues/1584#issuecomment-1027987475

* Fixes some bugs with SelectedItem.

* Command must also return a nullable bool.

* Ensures updating the ComboBox text on leaving the control.

* Only with the nullable bool was possible to make the MoveUp and the MoveDown working.

* Added logging of which scenario failed in test

Co-authored-by: BDisp <bd.bdisp@gmail.com>
2022-02-08 10:40:40 -08:00

458 lines
15 KiB
C#
Raw Blame History

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Xunit;
namespace Terminal.Gui.Views {
public class HexViewTests {
[Fact]
public void Constructors_Defaults ()
{
var hv = new HexView ();
Assert.NotNull (hv.Source);
Assert.IsAssignableFrom<System.IO.MemoryStream> (hv.Source);
Assert.True (hv.CanFocus);
Assert.True (hv.AllowEdits);
hv = new HexView (new System.IO.MemoryStream ());
Assert.NotNull (hv.Source);
Assert.IsAssignableFrom<System.IO.Stream> (hv.Source);
Assert.True (hv.CanFocus);
Assert.True (hv.AllowEdits);
}
private Stream LoadStream (bool unicode = false)
{
MemoryStream stream = new MemoryStream ();
byte [] bArray;
string 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;
}
[Fact]
public void AllowEdits_Edits_ApplyEdits ()
{
var hv = new HexView (LoadStream (true)) {
Width = 20,
Height = 20
};
Assert.Empty (hv.Edits);
hv.AllowEdits = false;
Assert.True (hv.ProcessKey (new KeyEvent (Key.Home, new KeyModifiers ())));
Assert.False (hv.ProcessKey (new KeyEvent (Key.A, new KeyModifiers ())));
Assert.Empty (hv.Edits);
Assert.Equal (126, hv.Source.Length);
hv.AllowEdits = true;
Assert.True (hv.ProcessKey (new KeyEvent (Key.D4, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.D1, new KeyModifiers ())));
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.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.D4, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.D2, new KeyModifiers ())));
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 DisplayStart_Source ()
{
var hv = new HexView (LoadStream (true)) {
Width = 20,
Height = 20
};
Assert.Equal (0, hv.DisplayStart);
Assert.True (hv.ProcessKey (new KeyEvent (Key.PageDown, new KeyModifiers ())));
Assert.Equal (4 * hv.Frame.Height, hv.DisplayStart);
Assert.Equal (hv.Source.Length, hv.Source.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
// 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 };
KeyValuePair<long, byte> keyValuePair = default;
hv.Edited += (e) => keyValuePair = e;
Assert.True (hv.ProcessKey (new KeyEvent (Key.D4, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.D6, new KeyModifiers ())));
Assert.Equal (0, (int)keyValuePair.Key);
Assert.Equal (70, (int)keyValuePair.Value);
Assert.Equal ('F', (char)keyValuePair.Value);
}
[Fact]
public void DiscardEdits_Method ()
{
var hv = new HexView (LoadStream (true)) { Width = 20, Height = 20 };
Assert.True (hv.ProcessKey (new KeyEvent (Key.D4, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.D1, new KeyModifiers ())));
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 Position_Using_Encoding_Unicode ()
{
var hv = new HexView (LoadStream (true)) { Width = 20, Height = 20 };
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.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (2, hv.Position);
// right side only needed to press one time
Assert.True (hv.ProcessKey (new KeyEvent (Key.Enter, new KeyModifiers ())));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (2, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorLeft, new KeyModifiers ())));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (1, hv.Position);
// last position is equal to the source length
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
Assert.Equal (126, hv.Source.Position);
Assert.Equal (127, hv.Position);
Assert.Equal (hv.Position - 1, hv.Source.Length);
}
[Fact]
public void Position_Using_Encoding_Default ()
{
var hv = new HexView (LoadStream ()) { Width = 20, Height = 20 };
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.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (2, hv.Position);
// right side only needed to press one time
Assert.True (hv.ProcessKey (new KeyEvent (Key.Enter, new KeyModifiers ())));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (2, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorLeft, new KeyModifiers ())));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (1, hv.Position);
// last position is equal to the source length
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
Assert.Equal (63, hv.Source.Position);
Assert.Equal (64, hv.Position);
Assert.Equal (hv.Position - 1, hv.Source.Length);
}
[Fact]
[AutoInitShutdown]
public void CursorPosition_Encoding_Unicode ()
{
var hv = new HexView (LoadStream (true)) { Width = Dim.Fill (), Height = Dim.Fill () };
Application.Top.Add (hv);
Application.Begin (Application.Top);
Assert.Equal (new Point (1, 1), hv.CursorPosition);
Assert.True (hv.ProcessKey (new KeyEvent (Key.Enter, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight | Key.CtrlMask, new KeyModifiers ())));
Assert.Equal (hv.CursorPosition.X, hv.BytesPerLine);
Assert.True (hv.ProcessKey (new KeyEvent (Key.Home, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.Equal (new Point (2, 1), hv.CursorPosition);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorDown, new KeyModifiers ())));
Assert.Equal (new Point (2, 2), hv.CursorPosition);
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
var col = hv.CursorPosition.X;
var line = hv.CursorPosition.Y;
var offset = (line - 1) * (hv.BytesPerLine - col);
Assert.Equal (hv.Position, col * line + offset);
}
[Fact]
[AutoInitShutdown]
public void CursorPosition_Encoding_Default ()
{
var hv = new HexView (LoadStream ()) { Width = Dim.Fill (), Height = Dim.Fill () };
Application.Top.Add (hv);
Application.Begin (Application.Top);
Assert.Equal (new Point (1, 1), hv.CursorPosition);
Assert.True (hv.ProcessKey (new KeyEvent (Key.Enter, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight | Key.CtrlMask, new KeyModifiers ())));
Assert.Equal (hv.CursorPosition.X, hv.BytesPerLine);
Assert.True (hv.ProcessKey (new KeyEvent (Key.Home, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.Equal (new Point (2, 1), hv.CursorPosition);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorDown, new KeyModifiers ())));
Assert.Equal (new Point (2, 2), hv.CursorPosition);
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
var col = hv.CursorPosition.X;
var line = hv.CursorPosition.Y;
var offset = (line - 1) * (hv.BytesPerLine - col);
Assert.Equal (hv.Position, col * line + offset);
}
[Fact]
[AutoInitShutdown]
public void PositionChanged_Event ()
{
var hv = new HexView (LoadStream ()) { Width = Dim.Fill (), Height = Dim.Fill () };
HexView.HexViewEventArgs hexViewEventArgs = null;
hv.PositionChanged += (e) => hexViewEventArgs = e;
Application.Top.Add (hv);
Application.Begin (Application.Top);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ()))); // left side must press twice
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorDown, new KeyModifiers ())));
Assert.Equal (12, hexViewEventArgs.BytesPerLine);
Assert.Equal (new Point (2, 2), hexViewEventArgs.CursorPosition);
Assert.Equal (14, hexViewEventArgs.Position);
}
private class NonSeekableStream : Stream {
Stream m_stream;
public NonSeekableStream (Stream baseStream)
{
m_stream = baseStream;
}
public override bool CanRead {
get { return m_stream.CanRead; }
}
public override bool CanSeek {
get { return false; }
}
public override bool CanWrite {
get { return m_stream.CanWrite; }
}
public override void Flush ()
{
m_stream.Flush ();
}
public override long Length {
get { throw new NotSupportedException (); }
}
public override long Position {
get {
return m_stream.Position;
}
set {
throw new NotSupportedException ();
}
}
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);
}
}
[Fact]
public void Exceptions_Tests ()
{
Assert.Throws<ArgumentNullException> (() => new HexView (null));
Assert.Throws<ArgumentException> (() => new HexView (new NonSeekableStream (new MemoryStream ())));
}
[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 };
Application.Top.Add (hv);
Application.Begin (Application.Top);
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
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 ();
Application.Top.LayoutSubviews ();
Assert.Equal (0, hv.DisplayStart);
Assert.Equal (0, hv.Position - 1);
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
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);
}
[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 () };
byte [] readBuffer = new byte [hv.Source.Length];
hv.Source.Position = 0;
hv.Source.Read (readBuffer);
Assert.Equal ("Fest", Encoding.Default.GetString (readBuffer));
Assert.True (hv.ProcessKey (new KeyEvent (Key.D5, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.D4, new KeyModifiers ())));
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]
[AutoInitShutdown]
public void KeyBindings_Command ()
{
var hv = new HexView (LoadStream ()) { Width = 20, Height = 10 };
Application.Top.Add (hv);
Application.Begin (Application.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.ProcessKey (new KeyEvent (Key.Enter, new KeyModifiers ())));
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight, new KeyModifiers ())));
Assert.Equal (2, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorLeft, new KeyModifiers ())));
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorDown, new KeyModifiers ())));
Assert.Equal (5, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorUp, new KeyModifiers ())));
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.V | Key.CtrlMask, new KeyModifiers ())));
Assert.Equal (41, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent ('v' + Key.AltMask, new KeyModifiers ())));
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.PageDown, new KeyModifiers ())));
Assert.Equal (41, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.PageUp, new KeyModifiers ())));
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.End, new KeyModifiers ())));
Assert.Equal (64, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.Home, new KeyModifiers ())));
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorRight | Key.CtrlMask, new KeyModifiers ())));
Assert.Equal (4, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorLeft | Key.CtrlMask, new KeyModifiers ())));
Assert.Equal (1, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorDown | Key.CtrlMask, new KeyModifiers ())));
Assert.Equal (37, hv.Position);
Assert.True (hv.ProcessKey (new KeyEvent (Key.CursorUp | Key.CtrlMask, new KeyModifiers ())));
Assert.Equal (1, hv.Position);
}
}
}
Reference in New Issue View Git Blame Copy Permalink