//
// ConsoleDriver.cs: Base class for Terminal.Gui ConsoleDriver implementations.
//
using NStack;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text.Json.Serialization;
using System.Threading.Tasks;
using Terminal.Gui;
using static Terminal.Gui.ConfigurationManager;
namespace Terminal.Gui {
///
/// Colors that can be used to set the foreground and background colors in console applications.
///
///
/// The value indicates either no-color has been set or the color is invalid.
///
[JsonConverter (typeof (ColorJsonConverter))]
public enum Color {
///
/// The black color.
///
Black,
///
/// The blue color.
///
Blue,
///
/// The green color.
///
Green,
///
/// The cyan color.
///
Cyan,
///
/// The red color.
///
Red,
///
/// The magenta color.
///
Magenta,
///
/// The brown color.
///
Brown,
///
/// The gray color.
///
Gray,
///
/// The dark gray color.
///
DarkGray,
///
/// The bright bBlue color.
///
BrightBlue,
///
/// The bright green color.
///
BrightGreen,
///
/// The bright cyan color.
///
BrightCyan,
///
/// The bright red color.
///
BrightRed,
///
/// The bright magenta color.
///
BrightMagenta,
///
/// The bright yellow color.
///
BrightYellow,
///
/// The White color.
///
White
}
///
/// Indicates the RGB for true colors.
///
public class TrueColor {
///
/// Red color component.
///
public int Red { get; }
///
/// Green color component.
///
public int Green { get; }
///
/// Blue color component.
///
public int Blue { get; }
///
/// Initializes a new instance of the struct.
///
///
///
///
public TrueColor (int red, int green, int blue)
{
Red = red;
Green = green;
Blue = blue;
}
///
/// Converts true color to console color.
///
///
public Color ToConsoleColor ()
{
var trueColorMap = new Dictionary () {
{ new TrueColor (0,0,0),Color.Black},
{ new TrueColor (0, 0, 0x80),Color.Blue},
{ new TrueColor (0, 0x80, 0),Color.Green},
{ new TrueColor (0, 0x80, 0x80),Color.Cyan},
{ new TrueColor (0x80, 0, 0),Color.Red},
{ new TrueColor (0x80, 0, 0x80),Color.Magenta},
{ new TrueColor (0xC1, 0x9C, 0x00),Color.Brown}, // TODO confirm this
{ new TrueColor (0xC0, 0xC0, 0xC0),Color.Gray},
{ new TrueColor (0x80, 0x80, 0x80),Color.DarkGray},
{ new TrueColor (0, 0, 0xFF),Color.BrightBlue},
{ new TrueColor (0, 0xFF, 0),Color.BrightGreen},
{ new TrueColor (0, 0xFF, 0xFF),Color.BrightCyan},
{ new TrueColor (0xFF, 0, 0),Color.BrightRed},
{ new TrueColor (0xFF, 0, 0xFF),Color.BrightMagenta },
{ new TrueColor (0xFF, 0xFF, 0),Color.BrightYellow},
{ new TrueColor (0xFF, 0xFF, 0xFF),Color.White},
};
// Iterate over all colors in the map
var distances = trueColorMap.Select (
k => Tuple.Create (
// the candidate we are considering matching against (RGB)
k.Key,
CalculateDistance (k.Key, this)
));
// get the closest
var match = distances.OrderBy (t => t.Item2).First ();
return trueColorMap [match.Item1];
}
private float CalculateDistance (TrueColor color1, TrueColor color2)
{
// use RGB distance
return
Math.Abs (color1.Red - color2.Red) +
Math.Abs (color1.Green - color2.Green) +
Math.Abs (color1.Blue - color2.Blue);
}
}
///
/// Attributes are used as elements that contain both a foreground and a background or platform specific features.
///
///
/// s are needed to map colors to terminal capabilities that might lack colors.
/// They encode both the foreground and the background color and are used in the
/// class to define color schemes that can be used in an application.
///
[JsonConverter (typeof (AttributeJsonConverter))]
public struct Attribute {
///
/// The -specific color attribute value. If is
/// the value of this property is invalid (typically because the Attribute was created before a driver was loaded)
/// and the attribute should be re-made (see ) before it is used.
///
[JsonIgnore (Condition = JsonIgnoreCondition.Always)]
public int Value { get; }
///
/// The foreground color.
///
[JsonConverter (typeof (ColorJsonConverter))]
public Color Foreground { get; }
///
/// The background color.
///
[JsonConverter (typeof (ColorJsonConverter))]
public Color Background { get; }
///
/// Initializes a new instance of the struct with only the value passed to
/// and trying to get the colors if defined.
///
/// Value.
public Attribute (int value)
{
Color foreground = default;
Color background = default;
Initialized = false;
if (Application.Driver != null) {
Application.Driver.GetColors (value, out foreground, out background);
Initialized = true;
}
Value = value;
Foreground = foreground;
Background = background;
}
///
/// Initializes a new instance of the struct.
///
/// Value.
/// Foreground
/// Background
public Attribute (int value, Color foreground, Color background)
{
Value = value;
Foreground = foreground;
Background = background;
Initialized = true;
}
///
/// Initializes a new instance of the struct.
///
/// Foreground
/// Background
public Attribute (Color foreground = new Color (), Color background = new Color ())
{
var make = Make (foreground, background);
Initialized = make.Initialized;
Value = make.Value;
Foreground = foreground;
Background = background;
}
///
/// Initializes a new instance of the struct
/// with the same colors for the foreground and background.
///
/// The color.
public Attribute (Color color) : this (color, color) { }
///
/// Implicit conversion from an to the underlying, driver-specific, Int32 representation
/// of the color.
///
/// The driver-specific color value stored in the attribute.
/// The attribute to convert
public static implicit operator int (Attribute c)
{
if (!c.Initialized) throw new InvalidOperationException ("Attribute: Attributes must be initialized by a driver before use.");
return c.Value;
}
///
/// Implicitly convert an driver-specific color value into an
///
/// An attribute with the specified driver-specific color value.
/// value
public static implicit operator Attribute (int v) => new Attribute (v);
///
/// Creates an from the specified foreground and background colors.
///
///
/// If a has not been loaded (Application.Driver == null) this
/// method will return an attribute with set to .
///
/// The new attribute.
/// Foreground color to use.
/// Background color to use.
public static Attribute Make (Color foreground, Color background)
{
if (Application.Driver == null) {
// Create the attribute, but show it's not been initialized
return new Attribute (-1, foreground, background) {
Initialized = false
};
}
return Application.Driver.MakeAttribute (foreground, background);
}
///
/// Gets the current from the driver.
///
/// The current attribute.
public static Attribute Get ()
{
if (Application.Driver == null)
throw new InvalidOperationException ("The Application has not been initialized");
return Application.Driver.GetAttribute ();
}
///
/// If the attribute has been initialized by a and
/// thus has that is valid for that driver. If the
/// and colors may have been set '-1' but
/// the attribute has not been mapped to a specific color value.
///
///
/// Attributes that have not been initialized must eventually be initialized before being passed to a driver.
///
[JsonIgnore]
public bool Initialized { get; internal set; }
///
/// Returns if the Attribute is valid (both foreground and background have valid color values).
///
///
[JsonIgnore]
public bool HasValidColors { get => (int)Foreground > -1 && (int)Background > -1; }
}
///
/// Defines the color s for common visible elements in a .
/// Containers such as and use to determine
/// the colors used by sub-views.
///
///
/// See also: .
///
[JsonConverter (typeof (ColorSchemeJsonConverter))]
public class ColorScheme : IEquatable {
Attribute _normal = new Attribute (Color.White, Color.Black);
Attribute _focus = new Attribute (Color.White, Color.Black);
Attribute _hotNormal = new Attribute (Color.White, Color.Black);
Attribute _hotFocus = new Attribute (Color.White, Color.Black);
Attribute _disabled = new Attribute (Color.White, Color.Black);
///
/// Used by and to track which ColorScheme
/// is being accessed.
///
internal string schemeBeingSet = "";
///
/// The foreground and background color for text when the view is not focused, hot, or disabled.
///
public Attribute Normal {
get { return _normal; }
set {
if (!value.HasValidColors) {
return;
}
_normal = value;
}
}
///
/// The foreground and background color for text when the view has the focus.
///
public Attribute Focus {
get { return _focus; }
set {
if (!value.HasValidColors) {
return;
}
_focus = value;
}
}
///
/// The foreground and background color for text when the view is highlighted (hot).
///
public Attribute HotNormal {
get { return _hotNormal; }
set {
if (!value.HasValidColors) {
return;
}
_hotNormal = value;
}
}
///
/// The foreground and background color for text when the view is highlighted (hot) and has focus.
///
public Attribute HotFocus {
get { return _hotFocus; }
set {
if (!value.HasValidColors) {
return;
}
_hotFocus = value;
}
}
///
/// The default foreground and background color for text, when the view is disabled.
///
public Attribute Disabled {
get { return _disabled; }
set {
if (!value.HasValidColors) {
return;
}
_disabled = value;
}
}
///
/// Compares two objects for equality.
///
///
/// true if the two objects are equal
public override bool Equals (object obj)
{
return Equals (obj as ColorScheme);
}
///
/// Compares two objects for equality.
///
///
/// true if the two objects are equal
public bool Equals (ColorScheme other)
{
return other != null &&
EqualityComparer.Default.Equals (_normal, other._normal) &&
EqualityComparer.Default.Equals (_focus, other._focus) &&
EqualityComparer.Default.Equals (_hotNormal, other._hotNormal) &&
EqualityComparer.Default.Equals (_hotFocus, other._hotFocus) &&
EqualityComparer.Default.Equals (_disabled, other._disabled);
}
///
/// Returns a hashcode for this instance.
///
/// hashcode for this instance
public override int GetHashCode ()
{
int hashCode = -1242460230;
hashCode = hashCode * -1521134295 + _normal.GetHashCode ();
hashCode = hashCode * -1521134295 + _focus.GetHashCode ();
hashCode = hashCode * -1521134295 + _hotNormal.GetHashCode ();
hashCode = hashCode * -1521134295 + _hotFocus.GetHashCode ();
hashCode = hashCode * -1521134295 + _disabled.GetHashCode ();
return hashCode;
}
///
/// Compares two objects for equality.
///
///
///
/// true if the two objects are equivalent
public static bool operator == (ColorScheme left, ColorScheme right)
{
return EqualityComparer.Default.Equals (left, right);
}
///
/// Compares two objects for inequality.
///
///
///
/// true if the two objects are not equivalent
public static bool operator != (ColorScheme left, ColorScheme right)
{
return !(left == right);
}
internal void Initialize ()
{
// If the new scheme was created before a driver was loaded, we need to re-make
// the attributes
if (!_normal.Initialized) {
_normal = new Attribute (_normal.Foreground, _normal.Background);
}
if (!_focus.Initialized) {
_focus = new Attribute (_focus.Foreground, _focus.Background);
}
if (!_hotNormal.Initialized) {
_hotNormal = new Attribute (_hotNormal.Foreground, _hotNormal.Background);
}
if (!_hotFocus.Initialized) {
_hotFocus = new Attribute (_hotFocus.Foreground, _hotFocus.Background);
}
if (!_disabled.Initialized) {
_disabled = new Attribute (_disabled.Foreground, _disabled.Background);
}
}
}
///
/// The default s for the application.
///
///
/// This property can be set in a Theme to change the default for the application.
///
public static class Colors {
private class SchemeNameComparerIgnoreCase : IEqualityComparer {
public bool Equals (string x, string y)
{
if (x != null && y != null) {
return string.Equals (x, y, StringComparison.InvariantCultureIgnoreCase);
}
return false;
}
public int GetHashCode (string obj)
{
return obj.ToLowerInvariant ().GetHashCode ();
}
}
static Colors ()
{
ColorSchemes = Create ();
}
///
/// Creates a new dictionary of new objects.
///
public static Dictionary Create ()
{
// Use reflection to dynamically create the default set of ColorSchemes from the list defined
// by the class.
return typeof (Colors).GetProperties ()
.Where (p => p.PropertyType == typeof (ColorScheme))
.Select (p => new KeyValuePair (p.Name, new ColorScheme ()))
.ToDictionary (t => t.Key, t => t.Value, comparer: new SchemeNameComparerIgnoreCase ());
}
///
/// The application toplevel color scheme, for the default toplevel views.
///
///
///
/// This API will be deprecated in the future. Use instead (e.g. edit.ColorScheme = Colors.ColorSchemes["TopLevel"];
///
///
public static ColorScheme TopLevel { get => GetColorScheme (); set => SetColorScheme (value); }
///
/// The base color scheme, for the default toplevel views.
///
///
///
/// This API will be deprecated in the future. Use instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Base"];
///
///
public static ColorScheme Base { get => GetColorScheme (); set => SetColorScheme (value); }
///
/// The dialog color scheme, for standard popup dialog boxes
///
///
///
/// This API will be deprecated in the future. Use instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Dialog"];
///
///
public static ColorScheme Dialog { get => GetColorScheme (); set => SetColorScheme (value); }
///
/// The menu bar color
///
///
///
/// This API will be deprecated in the future. Use instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Menu"];
///
///
public static ColorScheme Menu { get => GetColorScheme (); set => SetColorScheme (value); }
///
/// The color scheme for showing errors.
///
///
///
/// This API will be deprecated in the future. Use instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Error"];
///
///
public static ColorScheme Error { get => GetColorScheme (); set => SetColorScheme (value); }
static ColorScheme GetColorScheme ([CallerMemberName] string schemeBeingSet = null)
{
return ColorSchemes [schemeBeingSet];
}
static void SetColorScheme (ColorScheme colorScheme, [CallerMemberName] string schemeBeingSet = null)
{
ColorSchemes [schemeBeingSet] = colorScheme;
colorScheme.schemeBeingSet = schemeBeingSet;
}
///
/// Provides the defined s.
///
[SerializableConfigurationProperty (Scope = typeof(ThemeScope), OmitClassName = true)]
[JsonConverter(typeof(DictionaryJsonConverter))]
public static Dictionary ColorSchemes { get; private set; }
}
///
/// Cursors Visibility that are displayed
///
//
// Hexa value are set as 0xAABBCCDD where :
//
// AA stand for the TERMINFO DECSUSR parameter value to be used under Linux & MacOS
// BB stand for the NCurses curs_set parameter value to be used under Linux & MacOS
// CC stand for the CONSOLE_CURSOR_INFO.bVisible parameter value to be used under Windows
// DD stand for the CONSOLE_CURSOR_INFO.dwSize parameter value to be used under Windows
//
public enum CursorVisibility {
///
/// Cursor caret has default
///
/// Works under Xterm-like terminal otherwise this is equivalent to . This default directly depends of the XTerm user configuration settings so it could be Block, I-Beam, Underline with possible blinking.
Default = 0x00010119,
///
/// Cursor caret is hidden
///
Invisible = 0x03000019,
///
/// Cursor caret is normally shown as a blinking underline bar _
///
Underline = 0x03010119,
///
/// Cursor caret is normally shown as a underline bar _
///
/// Under Windows, this is equivalent to
UnderlineFix = 0x04010119,
///
/// Cursor caret is displayed a blinking vertical bar |
///
/// Works under Xterm-like terminal otherwise this is equivalent to
Vertical = 0x05010119,
///
/// Cursor caret is displayed a blinking vertical bar |
///
/// Works under Xterm-like terminal otherwise this is equivalent to
VerticalFix = 0x06010119,
///
/// Cursor caret is displayed as a blinking block ▉
///
Box = 0x01020164,
///
/// Cursor caret is displayed a block ▉
///
/// Works under Xterm-like terminal otherwise this is equivalent to
BoxFix = 0x02020164,
}
///
/// ConsoleDriver is an abstract class that defines the requirements for a console driver.
/// There are currently three implementations: (for Unix and Mac), , and that uses the .NET Console API.
///
public abstract class ConsoleDriver {
///
/// The handler fired when the terminal is resized.
///
protected Action TerminalResized;
///
/// The current number of columns in the terminal.
///
public abstract int Cols { get; }
///
/// The current number of rows in the terminal.
///
public abstract int Rows { get; }
///
/// The current left in the terminal.
///
public abstract int Left { get; }
///
/// The current top in the terminal.
///
public abstract int Top { get; }
///
/// Get the operation system clipboard.
///
public abstract IClipboard Clipboard { get; }
///
///
/// If (the default) the height of the Terminal.Gui application ()
/// tracks to the height of the visible console view when the console is resized. In this case
/// scrolling in the console will be disabled and all will remain visible.
///
///
/// If then height of the Terminal.Gui application only tracks
/// the height of the visible console view when the console is made larger (the application will only grow in height, never shrink).
/// In this case console scrolling is enabled and the contents ( high) will scroll
/// as the console scrolls.
///
///
///
/// NOTE: This functionaliy is currently broken on Windows Terminal.
///
public abstract bool EnableConsoleScrolling { get; set; }
///
/// The format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag
///
public virtual int [,,] Contents { get; }
///
/// Initializes the driver
///
/// Method to invoke when the terminal is resized.
public abstract void Init (Action terminalResized);
///
/// Moves the cursor to the specified column and row.
///
/// Column to move the cursor to.
/// Row to move the cursor to.
public abstract void Move (int col, int row);
///
/// Adds the specified rune to the display at the current cursor position.
///
/// Rune to add.
public abstract void AddRune (Rune rune);
///
/// Ensures a Rune is not a control character and can be displayed by translating characters below 0x20
/// to equivalent, printable, Unicode chars.
///
/// Rune to translate
///
public static Rune MakePrintable (Rune c)
{
if (c <= 0x1F || (c >= 0X7F && c <= 0x9F)) {
// ASCII (C0) control characters.
// C1 control characters (https://www.aivosto.com/articles/control-characters.html#c1)
return new Rune (c + 0x2400);
}
return c;
}
///
/// Ensures that the column and line are in a valid range from the size of the driver.
///
/// The column.
/// The row.
/// The clip.
/// trueif it's a valid range,falseotherwise.
public bool IsValidContent (int col, int row, Rect clip) =>
col >= 0 && row >= 0 && col < Cols && row < Rows && clip.Contains (col, row);
///
/// Adds the to the display at the cursor position.
///
/// String.
public abstract void AddStr (ustring str);
///
/// Prepare the driver and set the key and mouse events handlers.
///
/// The main loop.
/// The handler for ProcessKey
/// The handler for key down events
/// The handler for key up events
/// The handler for mouse events
public abstract void PrepareToRun (MainLoop mainLoop, Action keyHandler, Action keyDownHandler, Action keyUpHandler, Action mouseHandler);
///
/// Updates the screen to reflect all the changes that have been done to the display buffer
///
public abstract void Refresh ();
///
/// Updates the location of the cursor position
///
public abstract void UpdateCursor ();
///
/// Retreive the cursor caret visibility
///
/// The current
/// true upon success
public abstract bool GetCursorVisibility (out CursorVisibility visibility);
///
/// Change the cursor caret visibility
///
/// The wished
/// true upon success
public abstract bool SetCursorVisibility (CursorVisibility visibility);
///
/// Ensure the cursor visibility
///
/// true upon success
public abstract bool EnsureCursorVisibility ();
///
/// Ends the execution of the console driver.
///
public abstract void End ();
///
/// Resizes the clip area when the screen is resized.
///
public abstract void ResizeScreen ();
///
/// Reset and recreate the contents and the driver buffer.
///
public abstract void UpdateOffScreen ();
///
/// Redraws the physical screen with the contents that have been queued up via any of the printing commands.
///
public abstract void UpdateScreen ();
///
/// The current attribute the driver is using.
///
public virtual Attribute CurrentAttribute {
get => currentAttribute;
set {
if (!value.Initialized && value.HasValidColors && Application.Driver != null) {
CurrentAttribute = Application.Driver.MakeAttribute (value.Foreground, value.Background);
return;
}
if (!value.Initialized) Debug.WriteLine ("ConsoleDriver.CurrentAttribute: Attributes must be initialized before use.");
currentAttribute = value;
}
}
///
/// Selects the specified attribute as the attribute to use for future calls to AddRune and AddString.
///
///
/// Implementations should call base.SetAttribute(c).
///
/// C.
public virtual void SetAttribute (Attribute c)
{
CurrentAttribute = c;
}
///
/// Set Colors from limit sets of colors. Not implemented by any driver: See Issue #2300.
///
/// Foreground.
/// Background.
public abstract void SetColors (ConsoleColor foreground, ConsoleColor background);
// Advanced uses - set colors to any pre-set pairs, you would need to init_color
// that independently with the R, G, B values.
///
/// Advanced uses - set colors to any pre-set pairs, you would need to init_color
/// that independently with the R, G, B values. Not implemented by any driver: See Issue #2300.
///
/// Foreground color identifier.
/// Background color identifier.
public abstract void SetColors (short foregroundColorId, short backgroundColorId);
///
/// Gets the foreground and background colors based on the value.
///
/// The value.
/// The foreground.
/// The background.
///
public abstract bool GetColors (int value, out Color foreground, out Color background);
///
/// Allows sending keys without typing on a keyboard.
///
/// The character key.
/// The key.
/// If shift key is sending.
/// If alt key is sending.
/// If control key is sending.
public abstract void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control);
///
/// Set the handler when the terminal is resized.
///
///
public void SetTerminalResized (Action terminalResized)
{
TerminalResized = terminalResized;
}
///
/// Fills the specified rectangle with the specified rune.
///
///
///
public virtual void FillRect (Rect rect, System.Rune rune = default)
{
for (var r = rect.Y; r < rect.Y + rect.Height; r++) {
for (var c = rect.X; c < rect.X + rect.Width; c++) {
Application.Driver.Move (c, r);
Application.Driver.AddRune (rune == default ? ' ' : rune);
}
}
}
///
/// Draws the title for a Window-style view incorporating padding.
///
/// Screen relative region where the frame will be drawn.
/// The title for the window. The title will only be drawn if title is not null or empty and paddingTop is greater than 0.
/// Number of columns to pad on the left (if 0 the border will not appear on the left).
/// Number of rows to pad on the top (if 0 the border and title will not appear on the top).
/// Number of columns to pad on the right (if 0 the border will not appear on the right).
/// Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).
/// Not yet implemented.
///
public virtual void DrawWindowTitle (Rect region, ustring title, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom, TextAlignment textAlignment = TextAlignment.Left)
{
var width = region.Width - (paddingLeft + 1) * 2;
if (!ustring.IsNullOrEmpty (title) && width > 2 && region.Y + paddingTop <= region.Y + paddingBottom) {
Move (region.X + 2 + paddingLeft, region.Y + paddingTop);
//AddRune (' ');
var str = title.Sum (r => Math.Max (Rune.ColumnWidth (r), 1)) >= width
? TextFormatter.Format (title, width - 2, false, false) [0] : title;
AddStr (str);
//AddRune (' ');
}
}
///
/// Enables diagnostic functions
///
[Flags]
public enum DiagnosticFlags : uint {
///
/// All diagnostics off
///
Off = 0b_0000_0000,
///
/// When enabled, will draw a
/// ruler in the frame for any side with a padding value greater than 0.
///
FrameRuler = 0b_0000_0001,
///
/// When Enabled, will use
/// 'L', 'R', 'T', and 'B' for padding instead of ' '.
///
FramePadding = 0b_0000_0010,
}
///
/// Set flags to enable/disable diagnostics.
///
public static DiagnosticFlags Diagnostics { get; set; }
///
/// Draws a frame for a window with padding and an optional visible border inside the padding.
///
/// Screen relative region where the frame will be drawn.
/// Number of columns to pad on the left (if 0 the border will not appear on the left).
/// Number of rows to pad on the top (if 0 the border and title will not appear on the top).
/// Number of columns to pad on the right (if 0 the border will not appear on the right).
/// Number of rows to pad on the bottom (if 0 the border will not appear on the bottom).
/// If set to true and any padding dimension is > 0 the border will be drawn.
/// If set to true it will clear the content area (the area inside the padding) with the current color, otherwise the content area will be left untouched.
/// The to be used if defined.
public virtual void DrawWindowFrame (Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0,
int paddingBottom = 0, bool border = true, bool fill = false, Border borderContent = null)
{
char clearChar = ' ';
char leftChar = clearChar;
char rightChar = clearChar;
char topChar = clearChar;
char bottomChar = clearChar;
if ((Diagnostics & DiagnosticFlags.FramePadding) == DiagnosticFlags.FramePadding) {
leftChar = 'L';
rightChar = 'R';
topChar = 'T';
bottomChar = 'B';
clearChar = 'C';
}
void AddRuneAt (int col, int row, Rune ch)
{
Move (col, row);
AddRune (ch);
}
// fwidth is count of hLine chars
int fwidth = (int)(region.Width - (paddingRight + paddingLeft));
// fheight is count of vLine chars
int fheight = (int)(region.Height - (paddingBottom + paddingTop));
// fleft is location of left frame line
int fleft = region.X + paddingLeft - 1;
// fright is location of right frame line
int fright = fleft + fwidth + 1;
// ftop is location of top frame line
int ftop = region.Y + paddingTop - 1;
// fbottom is location of bottom frame line
int fbottom = ftop + fheight + 1;
var borderStyle = borderContent == null ? BorderStyle.Single : borderContent.BorderStyle;
Rune hLine = default, vLine = default,
uRCorner = default, uLCorner = default, lLCorner = default, lRCorner = default;
if (border) {
switch (borderStyle) {
case BorderStyle.None:
break;
case BorderStyle.Single:
hLine = HLine;
vLine = VLine;
uRCorner = URCorner;
uLCorner = ULCorner;
lLCorner = LLCorner;
lRCorner = LRCorner;
break;
case BorderStyle.Double:
hLine = HDLine;
vLine = VDLine;
uRCorner = URDCorner;
uLCorner = ULDCorner;
lLCorner = LLDCorner;
lRCorner = LRDCorner;
break;
case BorderStyle.Rounded:
hLine = HRLine;
vLine = VRLine;
uRCorner = URRCorner;
uLCorner = ULRCorner;
lLCorner = LLRCorner;
lRCorner = LRRCorner;
break;
}
} else {
hLine = vLine = uRCorner = uLCorner = lLCorner = lRCorner = clearChar;
}
// Outside top
if (paddingTop > 1) {
for (int r = region.Y; r < ftop; r++) {
for (int c = region.X; c < region.X + region.Width; c++) {
AddRuneAt (c, r, topChar);
}
}
}
// Outside top-left
for (int c = region.X; c < fleft; c++) {
AddRuneAt (c, ftop, leftChar);
}
// Frame top-left corner
AddRuneAt (fleft, ftop, paddingTop >= 0 ? (paddingLeft >= 0 ? uLCorner : hLine) : leftChar);
// Frame top
for (int c = fleft + 1; c < fleft + 1 + fwidth; c++) {
AddRuneAt (c, ftop, paddingTop > 0 ? hLine : topChar);
}
// Frame top-right corner
if (fright > fleft) {
AddRuneAt (fright, ftop, paddingTop >= 0 ? (paddingRight >= 0 ? uRCorner : hLine) : rightChar);
}
// Outside top-right corner
for (int c = fright + 1; c < fright + paddingRight; c++) {
AddRuneAt (c, ftop, rightChar);
}
// Left, Fill, Right
if (fbottom > ftop) {
for (int r = ftop + 1; r < fbottom; r++) {
// Outside left
for (int c = region.X; c < fleft; c++) {
AddRuneAt (c, r, leftChar);
}
// Frame left
AddRuneAt (fleft, r, paddingLeft > 0 ? vLine : leftChar);
// Fill
if (fill) {
for (int x = fleft + 1; x < fright; x++) {
AddRuneAt (x, r, clearChar);
}
}
// Frame right
if (fright > fleft) {
var v = vLine;
if ((Diagnostics & DiagnosticFlags.FrameRuler) == DiagnosticFlags.FrameRuler) {
v = (char)(((int)'0') + ((r - ftop) % 10)); // vLine;
}
AddRuneAt (fright, r, paddingRight > 0 ? v : rightChar);
}
// Outside right
for (int c = fright + 1; c < fright + paddingRight; c++) {
AddRuneAt (c, r, rightChar);
}
}
// Outside Bottom
for (int c = region.X; c < region.X + region.Width; c++) {
AddRuneAt (c, fbottom, leftChar);
}
// Frame bottom-left
AddRuneAt (fleft, fbottom, paddingLeft > 0 ? lLCorner : leftChar);
if (fright > fleft) {
// Frame bottom
for (int c = fleft + 1; c < fright; c++) {
var h = hLine;
if ((Diagnostics & DiagnosticFlags.FrameRuler) == DiagnosticFlags.FrameRuler) {
h = (char)(((int)'0') + ((c - fleft) % 10)); // hLine;
}
AddRuneAt (c, fbottom, paddingBottom > 0 ? h : bottomChar);
}
// Frame bottom-right
AddRuneAt (fright, fbottom, paddingRight > 0 ? (paddingBottom > 0 ? lRCorner : hLine) : rightChar);
}
// Outside right
for (int c = fright + 1; c < fright + paddingRight; c++) {
AddRuneAt (c, fbottom, rightChar);
}
}
// Out bottom - ensure top is always drawn if we overlap
if (paddingBottom > 0) {
for (int r = fbottom + 1; r < fbottom + paddingBottom; r++) {
for (int c = region.X; c < region.X + region.Width; c++) {
AddRuneAt (c, r, bottomChar);
}
}
}
}
///
/// Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver.
///
public abstract void Suspend ();
Rect clip;
///
/// Controls the current clipping region that AddRune/AddStr is subject to.
///
/// The clip.
public Rect Clip {
get => clip;
set => this.clip = value;
}
///
/// Start of mouse moves.
///
public abstract void StartReportingMouseMoves ();
///
/// Stop reporting mouses moves.
///
public abstract void StopReportingMouseMoves ();
///
/// Disables the cooked event processing from the mouse driver.
/// At startup, it is assumed mouse events are cooked. Not implemented by any driver: See Issue #2300.
///
public abstract void UncookMouse ();
///
/// Enables the cooked event processing from the mouse driver. Not implemented by any driver: See Issue #2300.
///
public abstract void CookMouse ();
///
/// Horizontal line character.
///
public Rune HLine = '\u2500';
///
/// Vertical line character.
///
public Rune VLine = '\u2502';
///
/// Stipple pattern
///
public Rune Stipple = '\u2591';
///
/// Diamond character
///
public Rune Diamond = '\u25ca';
///
/// Upper left corner
///
public Rune ULCorner = '\u250C';
///
/// Lower left corner
///
public Rune LLCorner = '\u2514';
///
/// Upper right corner
///
public Rune URCorner = '\u2510';
///
/// Lower right corner
///
public Rune LRCorner = '\u2518';
///
/// Left tee
///
public Rune LeftTee = '\u251c';
///
/// Right tee
///
public Rune RightTee = '\u2524';
///
/// Top tee
///
public Rune TopTee = '\u252c';
///
/// The bottom tee.
///
public Rune BottomTee = '\u2534';
///
/// Checkmark.
///
public Rune Checked = '\u221a';
///
/// Un-checked checkmark.
///
public Rune UnChecked = '\u2574';
///
/// Null-checked checkmark.
///
public Rune NullChecked = '\u2370';
///
/// Selected mark.
///
public Rune Selected = '\u25cf';
///
/// Un-selected selected mark.
///
public Rune UnSelected = '\u25cc';
///
/// Right Arrow.
///
public Rune RightArrow = '\u25ba';
///
/// Left Arrow.
///
public Rune LeftArrow = '\u25c4';
///
/// Down Arrow.
///
public Rune DownArrow = '\u25bc';
///
/// Up Arrow.
///
public Rune UpArrow = '\u25b2';
///
/// Left indicator for default action (e.g. for ).
///
public Rune LeftDefaultIndicator = '\u25e6';
///
/// Right indicator for default action (e.g. for ).
///
public Rune RightDefaultIndicator = '\u25e6';
///
/// Left frame/bracket (e.g. '[' for ).
///
public Rune LeftBracket = '[';
///
/// Right frame/bracket (e.g. ']' for ).
///
public Rune RightBracket = ']';
///
/// Blocks Segment indicator for meter views (e.g. .
///
public Rune BlocksMeterSegment = '\u258c';
///
/// Continuous Segment indicator for meter views (e.g. .
///
public Rune ContinuousMeterSegment = '\u2588';
///
/// Horizontal double line character.
///
public Rune HDLine = '\u2550';
///
/// Vertical double line character.
///
public Rune VDLine = '\u2551';
///
/// Upper left double corner
///
public Rune ULDCorner = '\u2554';
///
/// Lower left double corner
///
public Rune LLDCorner = '\u255a';
///
/// Upper right double corner
///
public Rune URDCorner = '\u2557';
///
/// Lower right double corner
///
public Rune LRDCorner = '\u255d';
///
/// Horizontal line character for rounded corners.
///
public Rune HRLine = '\u2500';
///
/// Vertical line character for rounded corners.
///
public Rune VRLine = '\u2502';
///
/// Upper left rounded corner
///
public Rune ULRCorner = '\u256d';
///
/// Lower left rounded corner
///
public Rune LLRCorner = '\u2570';
///
/// Upper right rounded corner
///
public Rune URRCorner = '\u256e';
///
/// Lower right rounded corner
///
public Rune LRRCorner = '\u256f';
private Attribute currentAttribute;
///
/// Make the attribute for the foreground and background colors.
///
/// Foreground.
/// Background.
///
public abstract Attribute MakeAttribute (Color fore, Color back);
///
/// Gets the current .
///
/// The current attribute.
public Attribute GetAttribute () => CurrentAttribute;
///
/// Make the for the .
///
/// The foreground color.
/// The background color.
/// The attribute for the foreground and background colors.
public abstract Attribute MakeColor (Color foreground, Color background);
///
/// Ensures all s in are correctly
/// initialized by the driver.
///
///
/// This method was previsouly named CreateColors. It was reanmed to InitalizeColorSchemes when
/// was enabled.
///
/// Flag indicating if colors are supported (not used).
public void InitalizeColorSchemes (bool supportsColors = true)
{
// Ensure all Attributes are initialized by the driver
foreach (var s in Colors.ColorSchemes) {
s.Value.Initialize ();
}
if (!supportsColors) {
return;
}
}
}
///
/// Helper class for console drivers to invoke shell commands to interact with the clipboard.
/// Used primarily by CursesDriver, but also used in Unit tests which is why it is in
/// ConsoleDriver.cs.
///
internal static class ClipboardProcessRunner {
public static (int exitCode, string result) Bash (string commandLine, string inputText = "", bool waitForOutput = false)
{
var arguments = $"-c \"{commandLine}\"";
var (exitCode, result) = Process ("bash", arguments, inputText, waitForOutput);
return (exitCode, result.TrimEnd ());
}
public static (int exitCode, string result) Process (string cmd, string arguments, string input = null, bool waitForOutput = true)
{
var output = string.Empty;
using (Process process = new Process {
StartInfo = new ProcessStartInfo {
FileName = cmd,
Arguments = arguments,
RedirectStandardOutput = true,
RedirectStandardError = true,
RedirectStandardInput = true,
UseShellExecute = false,
CreateNoWindow = true,
}
}) {
var eventHandled = new TaskCompletionSource ();
process.Start ();
if (!string.IsNullOrEmpty (input)) {
process.StandardInput.Write (input);
process.StandardInput.Close ();
}
if (!process.WaitForExit (5000)) {
var timeoutError = $@"Process timed out. Command line: {process.StartInfo.FileName} {process.StartInfo.Arguments}.";
throw new TimeoutException (timeoutError);
}
if (waitForOutput && process.StandardOutput.Peek () != -1) {
output = process.StandardOutput.ReadToEnd ();
}
if (process.ExitCode > 0) {
output = $@"Process failed to run. Command line: {cmd} {arguments}.
Output: {output}
Error: {process.StandardError.ReadToEnd ()}";
}
return (process.ExitCode, output);
}
}
public static bool DoubleWaitForExit (this System.Diagnostics.Process process)
{
var result = process.WaitForExit (500);
if (result) {
process.WaitForExit ();
}
return result;
}
public static bool FileExists (this string value)
{
return !string.IsNullOrEmpty (value) && !value.Contains ("not found");
}
}
}