//
// FakeDriver.cs: A fake ConsoleDriver for unit tests.
//
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Runtime.InteropServices;
using System.Threading;
using NStack;
// Alias Console to MockConsole so we don't accidentally use Console
using Console = Terminal.Gui.FakeConsole;
namespace Terminal.Gui {
///
/// Implements a mock ConsoleDriver for unit testing
///
public class FakeDriver : ConsoleDriver {
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
public class Behaviors {
public bool UseFakeClipboard { get; internal set; }
public bool FakeClipboardAlwaysThrowsNotSupportedException { get; internal set; }
public bool FakeClipboardIsSupportedAlwaysFalse { get; internal set; }
public Behaviors (bool useFakeClipboard = false, bool fakeClipboardAlwaysThrowsNotSupportedException = false, bool fakeClipboardIsSupportedAlwaysTrue = false)
{
UseFakeClipboard = useFakeClipboard;
FakeClipboardAlwaysThrowsNotSupportedException = fakeClipboardAlwaysThrowsNotSupportedException;
FakeClipboardIsSupportedAlwaysFalse = fakeClipboardIsSupportedAlwaysTrue;
// double check usage is correct
Debug.Assert (useFakeClipboard == false && fakeClipboardAlwaysThrowsNotSupportedException == false);
Debug.Assert (useFakeClipboard == false && fakeClipboardIsSupportedAlwaysTrue == false);
}
}
public static FakeDriver.Behaviors FakeBehaviors = new Behaviors ();
int cols, rows, left, top;
public override int Cols => cols;
public override int Rows => rows;
// Only handling left here because not all terminals has a horizontal scroll bar.
public override int Left => 0;
public override int Top => 0;
[Obsolete ("This API is deprecated", false)]
public override bool EnableConsoleScrolling { get; set; }
[Obsolete ("This API is deprecated", false)]
public override bool HeightAsBuffer { get; set; }
private IClipboard clipboard = null;
public override IClipboard Clipboard => clipboard;
// The format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag
int [,,] contents;
bool [] dirtyLine;
///
/// Assists with testing, the format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag
///
public override int [,,] Contents => contents;
//void UpdateOffscreen ()
//{
// int cols = Cols;
// int rows = Rows;
// contents = new int [rows, cols, 3];
// for (int r = 0; r < rows; r++) {
// for (int c = 0; c < cols; c++) {
// contents [r, c, 0] = ' ';
// contents [r, c, 1] = MakeColor (ConsoleColor.Gray, ConsoleColor.Black);
// contents [r, c, 2] = 0;
// }
// }
// dirtyLine = new bool [rows];
// for (int row = 0; row < rows; row++)
// dirtyLine [row] = true;
//}
static bool sync = false;
public FakeDriver ()
{
if (FakeBehaviors.UseFakeClipboard) {
clipboard = new FakeClipboard (FakeBehaviors.FakeClipboardAlwaysThrowsNotSupportedException, FakeBehaviors.FakeClipboardIsSupportedAlwaysFalse);
} else {
if (RuntimeInformation.IsOSPlatform (OSPlatform.Windows)) {
clipboard = new WindowsClipboard ();
} else if (RuntimeInformation.IsOSPlatform (OSPlatform.OSX)) {
clipboard = new MacOSXClipboard ();
} else {
if (CursesDriver.Is_WSL_Platform ()) {
clipboard = new WSLClipboard ();
} else {
clipboard = new CursesClipboard ();
}
}
}
}
bool needMove;
// Current row, and current col, tracked by Move/AddCh only
int ccol, crow;
public override void Move (int col, int row)
{
ccol = col;
crow = row;
if (Clip.Contains (col, row)) {
FakeConsole.CursorTop = row;
FakeConsole.CursorLeft = col;
needMove = false;
} else {
FakeConsole.CursorTop = Clip.Y;
FakeConsole.CursorLeft = Clip.X;
needMove = true;
}
}
public override void AddRune (Rune rune)
{
rune = MakePrintable (rune);
var runeWidth = Rune.ColumnWidth (rune);
var validClip = IsValidContent (ccol, crow, Clip);
if (validClip) {
if (needMove) {
//MockConsole.CursorLeft = ccol;
//MockConsole.CursorTop = crow;
needMove = false;
}
if (runeWidth == 0 && ccol > 0) {
var r = contents [crow, ccol - 1, 0];
var s = new string (new char [] { (char)r, (char)rune });
string sn;
if (!s.IsNormalized ()) {
sn = s.Normalize ();
} else {
sn = s;
}
var c = sn [0];
contents [crow, ccol - 1, 0] = c;
contents [crow, ccol - 1, 1] = CurrentAttribute;
contents [crow, ccol - 1, 2] = 1;
} else {
if (runeWidth < 2 && ccol > 0
&& Rune.ColumnWidth ((Rune)contents [crow, ccol - 1, 0]) > 1) {
contents [crow, ccol - 1, 0] = (int)(uint)' ';
} else if (runeWidth < 2 && ccol <= Clip.Right - 1
&& Rune.ColumnWidth ((Rune)contents [crow, ccol, 0]) > 1) {
contents [crow, ccol + 1, 0] = (int)(uint)' ';
contents [crow, ccol + 1, 2] = 1;
}
if (runeWidth > 1 && ccol == Clip.Right - 1) {
contents [crow, ccol, 0] = (int)(uint)' ';
} else {
contents [crow, ccol, 0] = (int)(uint)rune;
}
contents [crow, ccol, 1] = CurrentAttribute;
contents [crow, ccol, 2] = 1;
dirtyLine [crow] = true;
}
} else {
needMove = true;
}
if (runeWidth < 0 || runeWidth > 0) {
ccol++;
}
if (runeWidth > 1) {
if (validClip && ccol < Clip.Right) {
contents [crow, ccol, 1] = CurrentAttribute;
contents [crow, ccol, 2] = 0;
}
ccol++;
}
//if (ccol == Cols) {
// ccol = 0;
// if (crow + 1 < Rows)
// crow++;
//}
if (sync) {
UpdateScreen ();
}
}
public override void AddStr (ustring str)
{
foreach (var rune in str)
AddRune (rune);
}
public override void End ()
{
FakeConsole.ResetColor ();
FakeConsole.Clear ();
}
public override Attribute MakeColor (Color foreground, Color background)
{
return MakeColor ((ConsoleColor)foreground, (ConsoleColor)background);
}
static Attribute MakeColor (ConsoleColor f, ConsoleColor b)
{
// Encode the colors into the int value.
return new Attribute (
value: ((((int)f) & 0xffff) << 16) | (((int)b) & 0xffff),
foreground: (Color)f,
background: (Color)b
);
}
public override void Init (Action terminalResized)
{
TerminalResized = terminalResized;
cols = FakeConsole.WindowWidth = FakeConsole.BufferWidth = FakeConsole.WIDTH;
rows = FakeConsole.WindowHeight = FakeConsole.BufferHeight = FakeConsole.HEIGHT;
FakeConsole.Clear ();
ResizeScreen ();
// Call InitalizeColorSchemes before UpdateOffScreen as it references Colors
CurrentAttribute = MakeColor (Color.White, Color.Black);
InitalizeColorSchemes ();
UpdateOffScreen ();
}
public override Attribute MakeAttribute (Color fore, Color back)
{
return MakeColor ((ConsoleColor)fore, (ConsoleColor)back);
}
int redrawColor = -1;
void SetColor (int color)
{
redrawColor = color;
IEnumerable values = Enum.GetValues (typeof (ConsoleColor))
.OfType ()
.Select (s => (int)s);
if (values.Contains (color & 0xffff)) {
FakeConsole.BackgroundColor = (ConsoleColor)(color & 0xffff);
}
if (values.Contains ((color >> 16) & 0xffff)) {
FakeConsole.ForegroundColor = (ConsoleColor)((color >> 16) & 0xffff);
}
}
public override void UpdateScreen ()
{
int top = Top;
int left = Left;
int rows = Math.Min (FakeConsole.WindowHeight + top, Rows);
int cols = Cols;
var savedRow = FakeConsole.CursorTop;
var savedCol = FakeConsole.CursorLeft;
var savedCursorVisible = FakeConsole.CursorVisible;
for (int row = top; row < rows; row++) {
if (!dirtyLine [row])
continue;
dirtyLine [row] = false;
for (int col = left; col < cols; col++) {
FakeConsole.CursorTop = row;
FakeConsole.CursorLeft = col;
for (; col < cols; col++) {
if (contents [row, col, 2] == 0) {
FakeConsole.CursorLeft++;
continue;
}
var color = contents [row, col, 1];
if (color != redrawColor)
SetColor (color);
Rune rune = contents [row, col, 0];
if (Rune.DecodeSurrogatePair (rune, out char [] spair)) {
FakeConsole.Write (spair);
} else {
FakeConsole.Write ((char)rune);
}
contents [row, col, 2] = 0;
}
}
}
FakeConsole.CursorTop = savedRow;
FakeConsole.CursorLeft = savedCol;
FakeConsole.CursorVisible = savedCursorVisible;
}
public override void Refresh ()
{
UpdateScreen ();
UpdateCursor ();
}
public override void SetAttribute (Attribute c)
{
base.SetAttribute (c);
}
public ConsoleKeyInfo FromVKPacketToKConsoleKeyInfo (ConsoleKeyInfo consoleKeyInfo)
{
if (consoleKeyInfo.Key != ConsoleKey.Packet) {
return consoleKeyInfo;
}
var mod = consoleKeyInfo.Modifiers;
var shift = (mod & ConsoleModifiers.Shift) != 0;
var alt = (mod & ConsoleModifiers.Alt) != 0;
var control = (mod & ConsoleModifiers.Control) != 0;
var keyChar = ConsoleKeyMapping.GetKeyCharFromConsoleKey (consoleKeyInfo.KeyChar, consoleKeyInfo.Modifiers, out uint virtualKey, out _);
return new ConsoleKeyInfo ((char)keyChar, (ConsoleKey)virtualKey, shift, alt, control);
}
Key MapKey (ConsoleKeyInfo keyInfo)
{
switch (keyInfo.Key) {
case ConsoleKey.Escape:
return MapKeyModifiers (keyInfo, Key.Esc);
case ConsoleKey.Tab:
return keyInfo.Modifiers == ConsoleModifiers.Shift ? Key.BackTab : Key.Tab;
case ConsoleKey.Clear:
return MapKeyModifiers (keyInfo, Key.Clear);
case ConsoleKey.Home:
return MapKeyModifiers (keyInfo, Key.Home);
case ConsoleKey.End:
return MapKeyModifiers (keyInfo, Key.End);
case ConsoleKey.LeftArrow:
return MapKeyModifiers (keyInfo, Key.CursorLeft);
case ConsoleKey.RightArrow:
return MapKeyModifiers (keyInfo, Key.CursorRight);
case ConsoleKey.UpArrow:
return MapKeyModifiers (keyInfo, Key.CursorUp);
case ConsoleKey.DownArrow:
return MapKeyModifiers (keyInfo, Key.CursorDown);
case ConsoleKey.PageUp:
return MapKeyModifiers (keyInfo, Key.PageUp);
case ConsoleKey.PageDown:
return MapKeyModifiers (keyInfo, Key.PageDown);
case ConsoleKey.Enter:
return MapKeyModifiers (keyInfo, Key.Enter);
case ConsoleKey.Spacebar:
return MapKeyModifiers (keyInfo, keyInfo.KeyChar == 0 ? Key.Space : (Key)keyInfo.KeyChar);
case ConsoleKey.Backspace:
return MapKeyModifiers (keyInfo, Key.Backspace);
case ConsoleKey.Delete:
return MapKeyModifiers (keyInfo, Key.DeleteChar);
case ConsoleKey.Insert:
return MapKeyModifiers (keyInfo, Key.InsertChar);
case ConsoleKey.PrintScreen:
return MapKeyModifiers (keyInfo, Key.PrintScreen);
case ConsoleKey.Oem1:
case ConsoleKey.Oem2:
case ConsoleKey.Oem3:
case ConsoleKey.Oem4:
case ConsoleKey.Oem5:
case ConsoleKey.Oem6:
case ConsoleKey.Oem7:
case ConsoleKey.Oem8:
case ConsoleKey.Oem102:
case ConsoleKey.OemPeriod:
case ConsoleKey.OemComma:
case ConsoleKey.OemPlus:
case ConsoleKey.OemMinus:
if (keyInfo.KeyChar == 0)
return Key.Unknown;
return (Key)((uint)keyInfo.KeyChar);
}
var key = keyInfo.Key;
if (key >= ConsoleKey.A && key <= ConsoleKey.Z) {
var delta = key - ConsoleKey.A;
if (keyInfo.Modifiers == ConsoleModifiers.Control) {
return (Key)(((uint)Key.CtrlMask) | ((uint)Key.A + delta));
}
if (keyInfo.Modifiers == ConsoleModifiers.Alt) {
return (Key)(((uint)Key.AltMask) | ((uint)Key.A + delta));
}
if (keyInfo.Modifiers == (ConsoleModifiers.Shift | ConsoleModifiers.Alt)) {
return MapKeyModifiers (keyInfo, (Key)((uint)Key.A + delta));
}
if ((keyInfo.Modifiers & (ConsoleModifiers.Alt | ConsoleModifiers.Control)) != 0) {
if (keyInfo.KeyChar == 0) {
return (Key)(((uint)Key.AltMask | (uint)Key.CtrlMask) | ((uint)Key.A + delta));
} else {
return (Key)((uint)keyInfo.KeyChar);
}
}
return (Key)((uint)keyInfo.KeyChar);
}
if (key >= ConsoleKey.D0 && key <= ConsoleKey.D9) {
var delta = key - ConsoleKey.D0;
if (keyInfo.Modifiers == ConsoleModifiers.Alt) {
return (Key)(((uint)Key.AltMask) | ((uint)Key.D0 + delta));
}
if (keyInfo.Modifiers == ConsoleModifiers.Control) {
return (Key)(((uint)Key.CtrlMask) | ((uint)Key.D0 + delta));
}
if (keyInfo.Modifiers == (ConsoleModifiers.Shift | ConsoleModifiers.Alt)) {
return MapKeyModifiers (keyInfo, (Key)((uint)Key.D0 + delta));
}
if ((keyInfo.Modifiers & (ConsoleModifiers.Alt | ConsoleModifiers.Control)) != 0) {
if (keyInfo.KeyChar == 0 || keyInfo.KeyChar == 30) {
return MapKeyModifiers (keyInfo, (Key)((uint)Key.D0 + delta));
}
}
return (Key)((uint)keyInfo.KeyChar);
}
if (key >= ConsoleKey.F1 && key <= ConsoleKey.F12) {
var delta = key - ConsoleKey.F1;
if ((keyInfo.Modifiers & (ConsoleModifiers.Shift | ConsoleModifiers.Alt | ConsoleModifiers.Control)) != 0) {
return MapKeyModifiers (keyInfo, (Key)((uint)Key.F1 + delta));
}
return (Key)((uint)Key.F1 + delta);
}
if (keyInfo.KeyChar != 0) {
return MapKeyModifiers (keyInfo, (Key)((uint)keyInfo.KeyChar));
}
return (Key)(0xffffffff);
}
KeyModifiers keyModifiers;
private Key MapKeyModifiers (ConsoleKeyInfo keyInfo, Key key)
{
Key keyMod = new Key ();
if ((keyInfo.Modifiers & ConsoleModifiers.Shift) != 0)
keyMod = Key.ShiftMask;
if ((keyInfo.Modifiers & ConsoleModifiers.Control) != 0)
keyMod |= Key.CtrlMask;
if ((keyInfo.Modifiers & ConsoleModifiers.Alt) != 0)
keyMod |= Key.AltMask;
return keyMod != Key.Null ? keyMod | key : key;
}
Action keyDownHandler;
Action keyHandler;
Action keyUpHandler;
private CursorVisibility savedCursorVisibility;
public override void PrepareToRun (MainLoop mainLoop, Action keyHandler, Action keyDownHandler, Action keyUpHandler, Action mouseHandler)
{
this.keyDownHandler = keyDownHandler;
this.keyHandler = keyHandler;
this.keyUpHandler = keyUpHandler;
// Note: Net doesn't support keydown/up events and thus any passed keyDown/UpHandlers will never be called
(mainLoop.Driver as FakeMainLoop).KeyPressed += (consoleKey) => ProcessInput (consoleKey);
}
void ProcessInput (ConsoleKeyInfo consoleKey)
{
if (consoleKey.Key == ConsoleKey.Packet) {
consoleKey = FromVKPacketToKConsoleKeyInfo (consoleKey);
}
keyModifiers = new KeyModifiers ();
if (consoleKey.Modifiers.HasFlag (ConsoleModifiers.Shift)) {
keyModifiers.Shift = true;
}
if (consoleKey.Modifiers.HasFlag (ConsoleModifiers.Alt)) {
keyModifiers.Alt = true;
}
if (consoleKey.Modifiers.HasFlag (ConsoleModifiers.Control)) {
keyModifiers.Ctrl = true;
}
var map = MapKey (consoleKey);
if (map == (Key)0xffffffff) {
if ((consoleKey.Modifiers & (ConsoleModifiers.Shift | ConsoleModifiers.Alt | ConsoleModifiers.Control)) != 0) {
keyDownHandler (new KeyEvent (map, keyModifiers));
keyUpHandler (new KeyEvent (map, keyModifiers));
}
return;
}
keyDownHandler (new KeyEvent (map, keyModifiers));
keyHandler (new KeyEvent (map, keyModifiers));
keyUpHandler (new KeyEvent (map, keyModifiers));
}
///
public override bool GetCursorVisibility (out CursorVisibility visibility)
{
visibility = FakeConsole.CursorVisible
? CursorVisibility.Default
: CursorVisibility.Invisible;
return FakeConsole.CursorVisible;
}
///
public override bool SetCursorVisibility (CursorVisibility visibility)
{
savedCursorVisibility = visibility;
return FakeConsole.CursorVisible = visibility == CursorVisibility.Default;
}
///
public override bool EnsureCursorVisibility ()
{
if (!(ccol >= 0 && crow >= 0 && ccol < Cols && crow < Rows)) {
GetCursorVisibility (out CursorVisibility cursorVisibility);
savedCursorVisibility = cursorVisibility;
SetCursorVisibility (CursorVisibility.Invisible);
return false;
}
SetCursorVisibility (savedCursorVisibility);
return FakeConsole.CursorVisible;
}
public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
{
ProcessInput (new ConsoleKeyInfo (keyChar, key, shift, alt, control));
}
public void SetBufferSize (int width, int height)
{
FakeConsole.SetBufferSize (width, height);
cols = width;
rows = height;
SetWindowSize (width, height);
ProcessResize ();
}
public void SetWindowSize (int width, int height)
{
FakeConsole.SetWindowSize (width, height);
if (width != cols || height != rows) {
SetBufferSize (width, height);
cols = width;
rows = height;
}
ProcessResize ();
}
public void SetWindowPosition (int left, int top)
{
if (this.left > 0 || this.top > 0) {
this.left = 0;
this.top = 0;
}
FakeConsole.SetWindowPosition (this.left, this.top);
}
void ProcessResize ()
{
ResizeScreen ();
UpdateOffScreen ();
TerminalResized?.Invoke ();
}
public override void ResizeScreen ()
{
if (FakeConsole.WindowHeight > 0) {
// Can raise an exception while is still resizing.
try {
#pragma warning disable CA1416
FakeConsole.CursorTop = 0;
FakeConsole.CursorLeft = 0;
FakeConsole.WindowTop = 0;
FakeConsole.WindowLeft = 0;
#pragma warning restore CA1416
} catch (System.IO.IOException) {
return;
} catch (ArgumentOutOfRangeException) {
return;
}
}
Clip = new Rect (0, 0, Cols, Rows);
}
public override void UpdateOffScreen ()
{
contents = new int [Rows, Cols, 3];
dirtyLine = new bool [Rows];
// Can raise an exception while is still resizing.
try {
for (int row = 0; row < rows; row++) {
for (int c = 0; c < cols; c++) {
contents [row, c, 0] = ' ';
contents [row, c, 1] = (ushort)Colors.TopLevel.Normal;
contents [row, c, 2] = 0;
dirtyLine [row] = true;
}
}
} catch (IndexOutOfRangeException) { }
}
public override bool GetColors (int value, out Color foreground, out Color background)
{
bool hasColor = false;
foreground = default;
background = default;
IEnumerable values = Enum.GetValues (typeof (ConsoleColor))
.OfType ()
.Select (s => (int)s);
if (values.Contains (value & 0xffff)) {
hasColor = true;
background = (Color)(ConsoleColor)(value & 0xffff);
}
if (values.Contains ((value >> 16) & 0xffff)) {
hasColor = true;
foreground = (Color)(ConsoleColor)((value >> 16) & 0xffff);
}
return hasColor;
}
#region Unused
public override void UpdateCursor ()
{
if (!EnsureCursorVisibility ())
return;
// Prevents the exception of size changing during resizing.
try {
if (ccol >= 0 && ccol < FakeConsole.BufferWidth && crow >= 0 && crow < FakeConsole.BufferHeight) {
FakeConsole.SetCursorPosition (ccol, crow);
}
} catch (System.IO.IOException) {
} catch (ArgumentOutOfRangeException) {
}
}
public override void StartReportingMouseMoves ()
{
}
public override void StopReportingMouseMoves ()
{
}
public override void Suspend ()
{
}
public override void SetColors (ConsoleColor foreground, ConsoleColor background)
{
}
public override void SetColors (short foregroundColorId, short backgroundColorId)
{
throw new NotImplementedException ();
}
public override void CookMouse ()
{
}
public override void UncookMouse ()
{
}
#endregion
public class FakeClipboard : ClipboardBase {
public Exception FakeException = null;
string contents = string.Empty;
bool isSupportedAlwaysFalse = false;
public override bool IsSupported => !isSupportedAlwaysFalse;
public FakeClipboard (bool fakeClipboardThrowsNotSupportedException = false, bool isSupportedAlwaysFalse = false)
{
this.isSupportedAlwaysFalse = isSupportedAlwaysFalse;
if (fakeClipboardThrowsNotSupportedException) {
FakeException = new NotSupportedException ("Fake clipboard exception");
}
}
protected override string GetClipboardDataImpl ()
{
if (FakeException != null) {
throw FakeException;
}
return contents;
}
protected override void SetClipboardDataImpl (string text)
{
if (FakeException != null) {
throw FakeException;
}
contents = text;
}
}
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
}
}