12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898 |
- #nullable enable
- using Terminal.Gui.ConsoleDrivers;
- using static Terminal.Gui.ConsoleDrivers.ConsoleKeyMapping;
- namespace Terminal.Gui;
- // QUESTION: Should this class be refactored into separate classes for:
- // QUESTION: CSI definitions
- // QUESTION: Primitives like DecodeEsqReq
- // QUESTION: Screen/Color/Cursor handling
- // QUESTION: Mouse handling
- // QUESTION: Keyboard handling
- /// <summary>
- /// Provides a platform-independent API for managing ANSI escape sequences.
- /// </summary>
- /// <remarks>
- /// Useful resources:
- /// * https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences
- /// * https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
- /// * https://vt100.net/
- /// </remarks>
- public static class EscSeqUtils
- {
- // TODO: One type per file - Move this enum to a separate file.
- /// <summary>
- /// Options for ANSI ESC "[xJ" - Clears part of the screen.
- /// </summary>
- public enum ClearScreenOptions
- {
- /// <summary>
- /// If n is 0 (or missing), clear from cursor to end of screen.
- /// </summary>
- CursorToEndOfScreen = 0,
- /// <summary>
- /// If n is 1, clear from cursor to beginning of the screen.
- /// </summary>
- CursorToBeginningOfScreen = 1,
- /// <summary>
- /// If n is 2, clear entire screen (and moves cursor to upper left on DOS ANSI.SYS).
- /// </summary>
- EntireScreen = 2,
- /// <summary>
- /// If n is 3, clear entire screen and delete all lines saved in the scrollback buffer
- /// </summary>
- EntireScreenAndScrollbackBuffer = 3
- }
- // QUESTION: I wonder if EscSeqUtils.CSI_... should be more strongly typed such that this (and Terminator could be
- // QUESTION: public required CSIRequests Request { get; init; }
- // QUESTION: public required CSITerminators Terminator { get; init; }
- /// <summary>
- /// Escape key code (ASCII 27/0x1B).
- /// </summary>
- public const char KeyEsc = (char)KeyCode.Esc;
- /// <summary>
- /// ESC [ - The CSI (Control Sequence Introducer).
- /// </summary>
- public const string CSI = "\u001B[";
- /// <summary>
- /// ESC [ ? 1047 h - Activate xterm alternative buffer (no backscroll)
- /// </summary>
- /// <remarks>
- /// From
- /// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_
- /// Use Alternate Screen Buffer, xterm.
- /// </remarks>
- public static readonly string CSI_ActivateAltBufferNoBackscroll = CSI + "?1047h";
- /// <summary>
- /// ESC [ ? 1003 l - Disable any mouse event tracking.
- /// </summary>
- public static readonly string CSI_DisableAnyEventMouse = CSI + "?1003l";
- /// <summary>
- /// ESC [ ? 1006 l - Disable SGR (Select Graphic Rendition).
- /// </summary>
- public static readonly string CSI_DisableSgrExtModeMouse = CSI + "?1006l";
- /// <summary>
- /// ESC [ ? 1015 l - Disable URXVT (Unicode Extended Virtual Terminal).
- /// </summary>
- public static readonly string CSI_DisableUrxvtExtModeMouse = CSI + "?1015l";
- /// <summary>
- /// ESC [ ? 1003 h - Enable mouse event tracking.
- /// </summary>
- public static readonly string CSI_EnableAnyEventMouse = CSI + "?1003h";
- /// <summary>
- /// ESC [ ? 1006 h - Enable SGR (Select Graphic Rendition).
- /// </summary>
- public static readonly string CSI_EnableSgrExtModeMouse = CSI + "?1006h";
- /// <summary>
- /// ESC [ ? 1015 h - Enable URXVT (Unicode Extended Virtual Terminal).
- /// </summary>
- public static readonly string CSI_EnableUrxvtExtModeMouse = CSI + "?1015h";
- /// <summary>
- /// ESC [ ? 1047 l - Restore xterm working buffer (with backscroll)
- /// </summary>
- /// <remarks>
- /// From
- /// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_
- /// Use Normal Screen Buffer, xterm. Clear the screen first if in the Alternate Screen Buffer.
- /// </remarks>
- public static readonly string CSI_RestoreAltBufferWithBackscroll = CSI + "?1047l";
- /// <summary>
- /// ESC [ ? 1049 l - Restore cursor position and restore xterm working buffer (with backscroll)
- /// </summary>
- /// <remarks>
- /// From
- /// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_
- /// Use Normal Screen Buffer and restore cursor as in DECRC, xterm.
- /// resource.This combines the effects of the 1047 and 1048 modes.
- /// </remarks>
- public static readonly string CSI_RestoreCursorAndRestoreAltBufferWithBackscroll = CSI + "?1049l";
- /// <summary>
- /// ESC [ ? 1049 h - Save cursor position and activate xterm alternative buffer (no backscroll)
- /// </summary>
- /// <remarks>
- /// From
- /// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_
- /// Save cursor as in DECSC, xterm. After saving the cursor, switch to the Alternate Screen Buffer,
- /// clearing it first.
- /// This control combines the effects of the 1047 and 1048 modes.
- /// Use this with terminfo-based applications rather than the 47 mode.
- /// </remarks>
- public static readonly string CSI_SaveCursorAndActivateAltBufferNoBackscroll = CSI + "?1049h";
- //private static bool isButtonReleased;
- private static bool _isButtonClicked;
- private static bool _isButtonDoubleClicked;
- //private static MouseFlags? lastMouseButtonReleased;
- // QUESTION: What's the difference between isButtonClicked and isButtonPressed?
- // Some clarity or comments would be handy, here.
- // It also seems like some enforcement of valid states might be a good idea.
- private static bool _isButtonPressed;
- private static bool _isButtonTripleClicked;
- private static MouseFlags? _lastMouseButtonPressed;
- private static Point? _point;
- /// <summary>
- /// Control sequence for disabling mouse events.
- /// </summary>
- public static string CSI_DisableMouseEvents { get; set; } =
- CSI_DisableAnyEventMouse + CSI_DisableUrxvtExtModeMouse + CSI_DisableSgrExtModeMouse;
- /// <summary>
- /// Control sequence for enabling mouse events.
- /// </summary>
- public static string CSI_EnableMouseEvents { get; set; } =
- CSI_EnableAnyEventMouse + CSI_EnableUrxvtExtModeMouse + CSI_EnableSgrExtModeMouse;
- /// <summary>
- /// ESC [ x J - Clears part of the screen. See <see cref="ClearScreenOptions"/>.
- /// </summary>
- /// <param name="option"></param>
- /// <returns></returns>
- public static string CSI_ClearScreen (ClearScreenOptions option) { return $"{CSI}{(int)option}J"; }
- /// <summary>
- /// Specify the incomplete <see cref="ConsoleKeyInfo"/> array not yet recognized as valid ANSI escape sequence.
- /// </summary>
- public static ConsoleKeyInfo []? IncompleteCkInfos { get; set; }
- /// <summary>
- /// Decodes an ANSI escape sequence.
- /// </summary>
- /// <param name="newConsoleKeyInfo">The <see cref="ConsoleKeyInfo"/> which may change.</param>
- /// <param name="key">The <see cref="ConsoleKey"/> which may change.</param>
- /// <param name="cki">The <see cref="ConsoleKeyInfo"/> array.</param>
- /// <param name="mod">The <see cref="ConsoleModifiers"/> which may change.</param>
- /// <param name="c1Control">The control returned by the <see cref="GetC1ControlChar"/> method.</param>
- /// <param name="code">The code returned by the <see cref="GetEscapeResult(char[])"/> method.</param>
- /// <param name="values">The values returned by the <see cref="GetEscapeResult(char[])"/> method.</param>
- /// <param name="terminator">The terminator returned by the <see cref="GetEscapeResult(char[])"/> method.</param>
- /// <param name="isMouse">Indicates if the escape sequence is a mouse event.</param>
- /// <param name="buttonState">The <see cref="MouseFlags"/> button state.</param>
- /// <param name="pos">The <see cref="MouseFlags"/> position.</param>
- /// <param name="isResponse">Indicates if the escape sequence is a response to a request.</param>
- /// <param name="continuousButtonPressedHandler">The handler that will process the event.</param>
- public static void DecodeEscSeq (
- ref ConsoleKeyInfo newConsoleKeyInfo,
- ref ConsoleKey key,
- ConsoleKeyInfo [] cki,
- ref ConsoleModifiers mod,
- out string c1Control,
- out string code,
- out string [] values,
- out string terminator,
- out bool isMouse,
- out List<MouseFlags> buttonState,
- out Point pos,
- out bool isResponse,
- Action<MouseFlags, Point>? continuousButtonPressedHandler
- )
- {
- char [] kChars = GetKeyCharArray (cki);
- (c1Control, code, values, terminator) = GetEscapeResult (kChars);
- isMouse = false;
- buttonState = [0];
- pos = default (Point);
- isResponse = false;
- var keyChar = '\0';
- switch (c1Control)
- {
- case "ESC":
- if (values is null && string.IsNullOrEmpty (terminator))
- {
- key = ConsoleKey.Escape;
- newConsoleKeyInfo = new (
- cki [0].KeyChar,
- key,
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- else if ((uint)cki [1].KeyChar >= 1 && (uint)cki [1].KeyChar <= 26 && (uint)cki [1].KeyChar != '\n' && (uint)cki [1].KeyChar != '\r')
- {
- key = (ConsoleKey)(char)(cki [1].KeyChar + (uint)ConsoleKey.A - 1);
- mod = ConsoleModifiers.Alt | ConsoleModifiers.Control;
- newConsoleKeyInfo = new (
- cki [1].KeyChar,
- key,
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- else if (cki [1].KeyChar >= 65 && cki [1].KeyChar <= 90)
- {
- key = (ConsoleKey)cki [1].KeyChar;
- mod = ConsoleModifiers.Shift | ConsoleModifiers.Alt;
- newConsoleKeyInfo = new (
- cki [1].KeyChar,
- (ConsoleKey)Math.Min ((uint)key, 255),
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- else if (cki [1].KeyChar >= 97 && cki [1].KeyChar <= 122)
- {
- key = (ConsoleKey)cki [1].KeyChar.ToString ().ToUpper () [0];
- mod = ConsoleModifiers.Alt;
- newConsoleKeyInfo = new (
- cki [1].KeyChar,
- (ConsoleKey)Math.Min ((uint)key, 255),
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- else if (cki [1].KeyChar is '\0' or ' ')
- {
- key = ConsoleKey.Spacebar;
- if (kChars.Length > 1 && kChars [1] == '\0')
- {
- mod = ConsoleModifiers.Alt | ConsoleModifiers.Control;
- }
- else
- {
- mod = ConsoleModifiers.Shift | ConsoleModifiers.Alt;
- }
- newConsoleKeyInfo = new (
- cki [1].KeyChar,
- (ConsoleKey)Math.Min ((uint)key, 255),
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- else if (cki [1].KeyChar is '\n' or '\r')
- {
- key = ConsoleKey.Enter;
- if (kChars.Length > 1 && kChars [1] == '\n')
- {
- mod = ConsoleModifiers.Alt | ConsoleModifiers.Control;
- }
- else
- {
- mod = ConsoleModifiers.Shift | ConsoleModifiers.Alt;
- }
- newConsoleKeyInfo = new (
- cki [1].KeyChar,
- (ConsoleKey)Math.Min ((uint)key, 255),
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- else
- {
- key = (ConsoleKey)cki [1].KeyChar;
- mod = ConsoleModifiers.Alt;
- newConsoleKeyInfo = new (
- cki [1].KeyChar,
- (ConsoleKey)Math.Min ((uint)key, 255),
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- break;
- case "SS3":
- key = GetConsoleKey (terminator [0], values [0], ref mod, ref keyChar);
- newConsoleKeyInfo = new (
- keyChar,
- key,
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- break;
- case "CSI":
- // Reset always IncompleteCkInfos
- if (IncompleteCkInfos is { })
- {
- IncompleteCkInfos = null;
- }
- if (!string.IsNullOrEmpty (code) && code == "<")
- {
- GetMouse (cki, out buttonState, out pos, continuousButtonPressedHandler);
- isMouse = true;
- return;
- }
- if (EscSeqRequests.HasResponse (terminator))
- {
- isResponse = true;
- EscSeqRequests.Remove (terminator);
- return;
- }
- if (!string.IsNullOrEmpty (terminator))
- {
- System.Diagnostics.Debug.Assert (terminator.Length == 1);
- key = GetConsoleKey (terminator [0], values [0], ref mod, ref keyChar);
- if (key != 0 && values.Length > 1)
- {
- mod |= GetConsoleModifiers (values [1]);
- }
- if (keyChar != 0 || key != 0 || mod != 0)
- {
- newConsoleKeyInfo = new (
- keyChar,
- key,
- (mod & ConsoleModifiers.Shift) != 0,
- (mod & ConsoleModifiers.Alt) != 0,
- (mod & ConsoleModifiers.Control) != 0);
- }
- else
- {
- // It's request response that wasn't handled by a valid request terminator
- System.Diagnostics.Debug.Assert (EscSeqRequests.Statuses.Count > 0);
- isResponse = true;
- EscSeqRequests.Remove (terminator);
- }
- }
- else
- {
- // BUGBUG: See https://github.com/gui-cs/Terminal.Gui/issues/2803
- // This is caused by NetDriver depending on Console.KeyAvailable?
- //throw new InvalidOperationException ("CSI response, but there's no terminator");
- IncompleteCkInfos = cki;
- }
- break;
- default:
- newConsoleKeyInfo = MapConsoleKeyInfo (cki [0]);
- key = newConsoleKeyInfo.Key;
- mod = newConsoleKeyInfo.Modifiers;
- break;
- }
- }
- /// <summary>
- /// Gets the c1Control used in the called escape sequence.
- /// </summary>
- /// <param name="c">The char used.</param>
- /// <returns>The c1Control.</returns>
- [Pure]
- public static string GetC1ControlChar (in char c)
- {
- // These control characters are used in the vtXXX emulation.
- return c switch
- {
- 'D' => "IND", // Index
- 'E' => "NEL", // Next Line
- 'H' => "HTS", // Tab Set
- 'M' => "RI", // Reverse Index
- 'N' => "SS2", // Single Shift Select of G2 Character Set: affects next character only
- 'O' => "SS3", // Single Shift Select of G3 Character Set: affects next character only
- 'P' => "DCS", // Device Control String
- 'V' => "SPA", // Start of Guarded Area
- 'W' => "EPA", // End of Guarded Area
- 'X' => "SOS", // Start of String
- 'Z' => "DECID", // Return Terminal ID Obsolete form of CSI c (DA)
- '[' => "CSI", // Control Sequence Introducer
- '\\' => "ST", // String Terminator
- ']' => "OSC", // Operating System Command
- '^' => "PM", // Privacy Message
- '_' => "APC", // Application Program Command
- _ => string.Empty
- };
- }
- /// <summary>
- /// Gets the <see cref="ConsoleKey"/> depending on terminating and value.
- /// </summary>
- /// <param name="terminator">
- /// The terminator indicating a reply to <see cref="CSI_SendDeviceAttributes"/> or
- /// <see cref="CSI_SendDeviceAttributes2"/>.
- /// </param>
- /// <param name="value">The value.</param>
- /// <param name="mod">The <see cref="ConsoleModifiers"/> which may change.</param>
- /// <param name="keyChar">Normally is '\0' but on some cases may need other value.</param>
- /// <returns>The <see cref="ConsoleKey"/> and probably the <see cref="ConsoleModifiers"/>.</returns>
- public static ConsoleKey GetConsoleKey (char terminator, string? value, ref ConsoleModifiers mod, ref char keyChar)
- {
- if (terminator == 'Z')
- {
- mod |= ConsoleModifiers.Shift;
- }
- if (terminator == 'l')
- {
- keyChar = '+';
- }
- if (terminator == 'm')
- {
- keyChar = '-';
- }
- return (terminator, value) switch
- {
- ('A', _) => ConsoleKey.UpArrow,
- ('B', _) => ConsoleKey.DownArrow,
- ('C', _) => ConsoleKey.RightArrow,
- ('D', _) => ConsoleKey.LeftArrow,
- ('E', _) => ConsoleKey.Clear,
- ('F', _) => ConsoleKey.End,
- ('H', _) => ConsoleKey.Home,
- ('P', _) => ConsoleKey.F1,
- ('Q', _) => ConsoleKey.F2,
- ('R', _) => ConsoleKey.F3,
- ('S', _) => ConsoleKey.F4,
- ('Z', _) => ConsoleKey.Tab,
- ('~', "2") => ConsoleKey.Insert,
- ('~', "3") => ConsoleKey.Delete,
- ('~', "5") => ConsoleKey.PageUp,
- ('~', "6") => ConsoleKey.PageDown,
- ('~', "15") => ConsoleKey.F5,
- ('~', "17") => ConsoleKey.F6,
- ('~', "18") => ConsoleKey.F7,
- ('~', "19") => ConsoleKey.F8,
- ('~', "20") => ConsoleKey.F9,
- ('~', "21") => ConsoleKey.F10,
- ('~', "23") => ConsoleKey.F11,
- ('~', "24") => ConsoleKey.F12,
- // These terminators are used by macOS on a numeric keypad without keys modifiers
- ('l', null) => ConsoleKey.Add,
- ('m', null) => ConsoleKey.Subtract,
- ('p', null) => ConsoleKey.Insert,
- ('q', null) => ConsoleKey.End,
- ('r', null) => ConsoleKey.DownArrow,
- ('s', null) => ConsoleKey.PageDown,
- ('t', null) => ConsoleKey.LeftArrow,
- ('u', null) => ConsoleKey.Clear,
- ('v', null) => ConsoleKey.RightArrow,
- ('w', null) => ConsoleKey.Home,
- ('x', null) => ConsoleKey.UpArrow,
- ('y', null) => ConsoleKey.PageUp,
- (_, _) => 0
- };
- }
- /// <summary>
- /// Gets the <see cref="ConsoleModifiers"/> from the value.
- /// </summary>
- /// <param name="value">The value.</param>
- /// <returns>The <see cref="ConsoleModifiers"/> or zero.</returns>
- public static ConsoleModifiers GetConsoleModifiers (string? value)
- {
- return value switch
- {
- "2" => ConsoleModifiers.Shift,
- "3" => ConsoleModifiers.Alt,
- "4" => ConsoleModifiers.Shift | ConsoleModifiers.Alt,
- "5" => ConsoleModifiers.Control,
- "6" => ConsoleModifiers.Shift | ConsoleModifiers.Control,
- "7" => ConsoleModifiers.Alt | ConsoleModifiers.Control,
- "8" => ConsoleModifiers.Shift | ConsoleModifiers.Alt | ConsoleModifiers.Control,
- _ => 0
- };
- }
- #nullable restore
- /// <summary>
- /// Gets all the needed information about an escape sequence.
- /// </summary>
- /// <param name="kChar">The array with all chars.</param>
- /// <returns>
- /// The c1Control returned by <see cref="GetC1ControlChar"/>, code, values and terminating.
- /// </returns>
- public static (string c1Control, string code, string [] values, string terminating) GetEscapeResult (char [] kChar)
- {
- if (kChar is null || kChar.Length == 0 || (kChar.Length == 1 && kChar [0] != KeyEsc))
- {
- return (null, null, null, null);
- }
- if (kChar [0] != KeyEsc)
- {
- throw new InvalidOperationException ("Invalid escape character!");
- }
- if (kChar.Length == 1)
- {
- return ("ESC", null, null, null);
- }
- if (kChar.Length == 2)
- {
- return ("ESC", null, null, kChar [1].ToString ());
- }
- string c1Control = GetC1ControlChar (kChar [1]);
- string code = null;
- int nSep = kChar.Count (static x => x == ';') + 1;
- var values = new string [nSep];
- var valueIdx = 0;
- var terminating = string.Empty;
- for (var i = 2; i < kChar.Length; i++)
- {
- char c = kChar [i];
- if (char.IsDigit (c))
- {
- // PERF: Ouch
- values [valueIdx] += c.ToString ();
- }
- else if (c == ';')
- {
- valueIdx++;
- }
- else if (valueIdx == nSep - 1 || i == kChar.Length - 1)
- {
- // PERF: Ouch
- terminating += c.ToString ();
- }
- else
- {
- // PERF: Ouch
- code += c.ToString ();
- }
- }
- return (c1Control, code, values, terminating);
- }
- /// <summary>
- /// A helper to get only the <see cref="ConsoleKeyInfo.KeyChar"/> from the <see cref="ConsoleKeyInfo"/> array.
- /// </summary>
- /// <param name="cki"></param>
- /// <returns>The char array of the escape sequence.</returns>
- // PERF: This is expensive
- public static char [] GetKeyCharArray (ConsoleKeyInfo [] cki)
- {
- char [] kChar = [];
- var length = 0;
- foreach (ConsoleKeyInfo kc in cki)
- {
- length++;
- Array.Resize (ref kChar, length);
- kChar [length - 1] = kc.KeyChar;
- }
- return kChar;
- }
- /// <summary>
- /// Gets the <see cref="MouseFlags"/> mouse button flags and the position.
- /// </summary>
- /// <param name="cki">The <see cref="ConsoleKeyInfo"/> array.</param>
- /// <param name="mouseFlags">The mouse button flags.</param>
- /// <param name="pos">The mouse position.</param>
- /// <param name="continuousButtonPressedHandler">The handler that will process the event.</param>
- public static void GetMouse (
- ConsoleKeyInfo [] cki,
- out List<MouseFlags> mouseFlags,
- out Point pos,
- Action<MouseFlags, Point> continuousButtonPressedHandler
- )
- {
- MouseFlags buttonState = 0;
- pos = Point.Empty;
- var buttonCode = 0;
- var foundButtonCode = false;
- var foundPoint = 0;
- string value = string.Empty;
- char [] kChar = GetKeyCharArray (cki);
- // PERF: This loop could benefit from use of Spans and other strategies to avoid copies.
- //System.Diagnostics.Debug.WriteLine ($"kChar: {new string (kChar)}");
- for (var i = 0; i < kChar.Length; i++)
- {
- // PERF: Copy
- char c = kChar [i];
- if (c == '<')
- {
- foundButtonCode = true;
- }
- else if (foundButtonCode && c != ';')
- {
- // PERF: Ouch
- value += c.ToString ();
- }
- else if (c == ';')
- {
- if (foundButtonCode)
- {
- foundButtonCode = false;
- buttonCode = int.Parse (value);
- }
- if (foundPoint == 1)
- {
- pos.X = int.Parse (value) - 1;
- }
- value = string.Empty;
- foundPoint++;
- }
- else if (foundPoint > 0 && c != 'm' && c != 'M')
- {
- value += c.ToString ();
- }
- else if (c == 'm' || c == 'M')
- {
- //pos.Y = int.Parse (value) + Console.WindowTop - 1;
- pos.Y = int.Parse (value) - 1;
- switch (buttonCode)
- {
- case 0:
- case 8:
- case 16:
- case 24:
- case 32:
- case 36:
- case 40:
- case 48:
- case 56:
- buttonState = c == 'M'
- ? MouseFlags.Button1Pressed
- : MouseFlags.Button1Released;
- break;
- case 1:
- case 9:
- case 17:
- case 25:
- case 33:
- case 37:
- case 41:
- case 45:
- case 49:
- case 53:
- case 57:
- case 61:
- buttonState = c == 'M'
- ? MouseFlags.Button2Pressed
- : MouseFlags.Button2Released;
- break;
- case 2:
- case 10:
- case 14:
- case 18:
- case 22:
- case 26:
- case 30:
- case 34:
- case 42:
- case 46:
- case 50:
- case 54:
- case 58:
- case 62:
- buttonState = c == 'M'
- ? MouseFlags.Button3Pressed
- : MouseFlags.Button3Released;
- break;
- case 35:
- //// Needed for Windows OS
- //if (isButtonPressed && c == 'm'
- // && (lastMouseEvent.ButtonState == MouseFlags.Button1Pressed
- // || lastMouseEvent.ButtonState == MouseFlags.Button2Pressed
- // || lastMouseEvent.ButtonState == MouseFlags.Button3Pressed)) {
- // switch (lastMouseEvent.ButtonState) {
- // case MouseFlags.Button1Pressed:
- // buttonState = MouseFlags.Button1Released;
- // break;
- // case MouseFlags.Button2Pressed:
- // buttonState = MouseFlags.Button2Released;
- // break;
- // case MouseFlags.Button3Pressed:
- // buttonState = MouseFlags.Button3Released;
- // break;
- // }
- //} else {
- // buttonState = MouseFlags.ReportMousePosition;
- //}
- //break;
- case 39:
- case 43:
- case 47:
- case 51:
- case 55:
- case 59:
- case 63:
- buttonState = MouseFlags.ReportMousePosition;
- break;
- case 64:
- buttonState = MouseFlags.WheeledUp;
- break;
- case 65:
- buttonState = MouseFlags.WheeledDown;
- break;
- case 68:
- case 72:
- case 80:
- buttonState = MouseFlags.WheeledLeft; // Shift/Ctrl+WheeledUp
- break;
- case 69:
- case 73:
- case 81:
- buttonState = MouseFlags.WheeledRight; // Shift/Ctrl+WheeledDown
- break;
- }
- // Modifiers.
- switch (buttonCode)
- {
- case 8:
- case 9:
- case 10:
- case 43:
- buttonState |= MouseFlags.ButtonAlt;
- break;
- case 14:
- case 47:
- buttonState |= MouseFlags.ButtonAlt | MouseFlags.ButtonShift;
- break;
- case 16:
- case 17:
- case 18:
- case 51:
- buttonState |= MouseFlags.ButtonCtrl;
- break;
- case 22:
- case 55:
- buttonState |= MouseFlags.ButtonCtrl | MouseFlags.ButtonShift;
- break;
- case 24:
- case 25:
- case 26:
- case 59:
- buttonState |= MouseFlags.ButtonCtrl | MouseFlags.ButtonAlt;
- break;
- case 30:
- case 63:
- buttonState |= MouseFlags.ButtonCtrl | MouseFlags.ButtonShift | MouseFlags.ButtonAlt;
- break;
- case 32:
- case 33:
- case 34:
- buttonState |= MouseFlags.ReportMousePosition;
- break;
- case 36:
- case 37:
- buttonState |= MouseFlags.ReportMousePosition | MouseFlags.ButtonShift;
- break;
- case 39:
- case 68:
- case 69:
- buttonState |= MouseFlags.ButtonShift;
- break;
- case 40:
- case 41:
- case 42:
- buttonState |= MouseFlags.ReportMousePosition | MouseFlags.ButtonAlt;
- break;
- case 45:
- case 46:
- buttonState |= MouseFlags.ReportMousePosition | MouseFlags.ButtonAlt | MouseFlags.ButtonShift;
- break;
- case 48:
- case 49:
- case 50:
- buttonState |= MouseFlags.ReportMousePosition | MouseFlags.ButtonCtrl;
- break;
- case 53:
- case 54:
- buttonState |= MouseFlags.ReportMousePosition | MouseFlags.ButtonCtrl | MouseFlags.ButtonShift;
- break;
- case 56:
- case 57:
- case 58:
- buttonState |= MouseFlags.ReportMousePosition | MouseFlags.ButtonCtrl | MouseFlags.ButtonAlt;
- break;
- case 61:
- case 62:
- buttonState |= MouseFlags.ReportMousePosition | MouseFlags.ButtonCtrl | MouseFlags.ButtonShift | MouseFlags.ButtonAlt;
- break;
- }
- }
- }
- mouseFlags = [MouseFlags.AllEvents];
- if (_lastMouseButtonPressed != null
- && !_isButtonPressed
- && !buttonState.HasFlag (MouseFlags.ReportMousePosition)
- && !buttonState.HasFlag (MouseFlags.Button1Released)
- && !buttonState.HasFlag (MouseFlags.Button2Released)
- && !buttonState.HasFlag (MouseFlags.Button3Released)
- && !buttonState.HasFlag (MouseFlags.Button4Released))
- {
- _lastMouseButtonPressed = null;
- _isButtonPressed = false;
- }
- if ((!_isButtonClicked
- && !_isButtonDoubleClicked
- && (buttonState == MouseFlags.Button1Pressed
- || buttonState == MouseFlags.Button2Pressed
- || buttonState == MouseFlags.Button3Pressed
- || buttonState == MouseFlags.Button4Pressed)
- && _lastMouseButtonPressed is null)
- || (_isButtonPressed && _lastMouseButtonPressed is { } && buttonState.HasFlag (MouseFlags.ReportMousePosition)))
- {
- mouseFlags [0] = buttonState;
- _lastMouseButtonPressed = buttonState;
- _isButtonPressed = true;
- _point = pos;
- if ((mouseFlags [0] & MouseFlags.ReportMousePosition) == 0)
- {
- Application.MainLoop?.AddIdle (
- () =>
- {
- // INTENT: What's this trying to do?
- // The task itself is not awaited.
- Task.Run (
- async () => await ProcessContinuousButtonPressedAsync (
- buttonState,
- continuousButtonPressedHandler));
- return false;
- });
- }
- else if (mouseFlags [0].HasFlag (MouseFlags.ReportMousePosition))
- {
- _point = pos;
- // The isButtonPressed must always be true, otherwise we can lose the feature
- // If mouse flags has ReportMousePosition this feature won't run
- // but is always prepared with the new location
- //isButtonPressed = false;
- }
- }
- else if (_isButtonDoubleClicked
- && (buttonState == MouseFlags.Button1Pressed
- || buttonState == MouseFlags.Button2Pressed
- || buttonState == MouseFlags.Button3Pressed
- || buttonState == MouseFlags.Button4Pressed))
- {
- mouseFlags [0] = GetButtonTripleClicked (buttonState);
- _isButtonDoubleClicked = false;
- _isButtonTripleClicked = true;
- }
- else if (_isButtonClicked
- && (buttonState == MouseFlags.Button1Pressed
- || buttonState == MouseFlags.Button2Pressed
- || buttonState == MouseFlags.Button3Pressed
- || buttonState == MouseFlags.Button4Pressed))
- {
- mouseFlags [0] = GetButtonDoubleClicked (buttonState);
- _isButtonClicked = false;
- _isButtonDoubleClicked = true;
- Application.MainLoop?.AddIdle (
- () =>
- {
- Task.Run (async () => await ProcessButtonDoubleClickedAsync ());
- return false;
- });
- }
- //else if (isButtonReleased && !isButtonClicked && buttonState == MouseFlags.ReportMousePosition) {
- // mouseFlag [0] = GetButtonClicked ((MouseFlags)lastMouseButtonReleased);
- // lastMouseButtonReleased = null;
- // isButtonReleased = false;
- // isButtonClicked = true;
- // Application.MainLoop.AddIdle (() => {
- // Task.Run (async () => await ProcessButtonClickedAsync ());
- // return false;
- // });
- //}
- else if (!_isButtonClicked
- && !_isButtonDoubleClicked
- && (buttonState == MouseFlags.Button1Released
- || buttonState == MouseFlags.Button2Released
- || buttonState == MouseFlags.Button3Released
- || buttonState == MouseFlags.Button4Released))
- {
- mouseFlags [0] = buttonState;
- _isButtonPressed = false;
- if (_isButtonTripleClicked)
- {
- _isButtonTripleClicked = false;
- }
- else if (pos.X == _point?.X && pos.Y == _point?.Y)
- {
- mouseFlags.Add (GetButtonClicked (buttonState));
- _isButtonClicked = true;
- Application.MainLoop?.AddIdle (
- () =>
- {
- Task.Run (async () => await ProcessButtonClickedAsync ());
- return false;
- });
- }
- _point = pos;
- //if ((lastMouseButtonPressed & MouseFlags.ReportMousePosition) == 0) {
- // lastMouseButtonReleased = buttonState;
- // isButtonPressed = false;
- // isButtonReleased = true;
- //} else {
- // lastMouseButtonPressed = null;
- // isButtonPressed = false;
- //}
- }
- else if (buttonState == MouseFlags.WheeledUp)
- {
- mouseFlags [0] = MouseFlags.WheeledUp;
- }
- else if (buttonState == MouseFlags.WheeledDown)
- {
- mouseFlags [0] = MouseFlags.WheeledDown;
- }
- else if (buttonState == MouseFlags.WheeledLeft)
- {
- mouseFlags [0] = MouseFlags.WheeledLeft;
- }
- else if (buttonState == MouseFlags.WheeledRight)
- {
- mouseFlags [0] = MouseFlags.WheeledRight;
- }
- else if (buttonState == MouseFlags.ReportMousePosition)
- {
- mouseFlags [0] = MouseFlags.ReportMousePosition;
- }
- else
- {
- mouseFlags [0] = buttonState;
- //foreach (var flag in buttonState.GetUniqueFlags()) {
- // mouseFlag [0] |= flag;
- //}
- }
- mouseFlags [0] = SetControlKeyStates (buttonState, mouseFlags [0]);
- //buttonState = mouseFlags;
- //System.Diagnostics.Debug.WriteLine ($"buttonState: {buttonState} X: {pos.X} Y: {pos.Y}");
- //foreach (var mf in mouseFlags) {
- // System.Diagnostics.Debug.WriteLine ($"mouseFlags: {mf} X: {pos.X} Y: {pos.Y}");
- //}
- }
- /// <summary>
- /// Ensures a console key is mapped to one that works correctly with ANSI escape sequences.
- /// </summary>
- /// <param name="consoleKeyInfo">The <see cref="ConsoleKeyInfo"/>.</param>
- /// <returns>The <see cref="ConsoleKeyInfo"/> modified.</returns>
- public static ConsoleKeyInfo MapConsoleKeyInfo (ConsoleKeyInfo consoleKeyInfo)
- {
- ConsoleKeyInfo newConsoleKeyInfo = consoleKeyInfo;
- ConsoleKey key = ConsoleKey.None;
- char keyChar = consoleKeyInfo.KeyChar;
- switch ((uint)keyChar)
- {
- case 0:
- if (consoleKeyInfo.Key == (ConsoleKey)64)
- { // Ctrl+Space in Windows.
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- ConsoleKey.Spacebar,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
- }
- else if (consoleKeyInfo.Key == ConsoleKey.None)
- {
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- ConsoleKey.Spacebar,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- true);
- }
- break;
- case uint n when n is > 0 and <= KeyEsc:
- if (consoleKeyInfo is { Key: 0, KeyChar: '\u001B' })
- {
- key = ConsoleKey.Escape;
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- key,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
- }
- else if (consoleKeyInfo is { Key: 0, KeyChar: '\t' })
- {
- key = ConsoleKey.Tab;
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- key,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
- }
- else if (consoleKeyInfo is { Key: 0, KeyChar: '\r' })
- {
- key = ConsoleKey.Enter;
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- key,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
- }
- else if (consoleKeyInfo is { Key: 0, KeyChar: '\n' })
- {
- key = ConsoleKey.Enter;
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- key,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- true);
- }
- else if (consoleKeyInfo.Key == 0)
- {
- key = (ConsoleKey)(char)(consoleKeyInfo.KeyChar + (uint)ConsoleKey.A - 1);
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- key,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- true);
- }
- break;
- case 127: // DEL
- key = ConsoleKey.Backspace;
- newConsoleKeyInfo = new (
- consoleKeyInfo.KeyChar,
- key,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
- break;
- default:
- uint ck = MapKeyCodeToConsoleKey ((KeyCode)consoleKeyInfo.KeyChar, out bool isConsoleKey);
- if (isConsoleKey)
- {
- key = (ConsoleKey)ck;
- }
- newConsoleKeyInfo = new (
- keyChar,
- key,
- GetShiftMod (consoleKeyInfo.Modifiers),
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0,
- (consoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0);
- break;
- }
- return newConsoleKeyInfo;
- bool GetShiftMod (ConsoleModifiers modifiers)
- {
- if (consoleKeyInfo.KeyChar is >= (char)ConsoleKey.A and <= (char)ConsoleKey.Z && modifiers == ConsoleModifiers.None)
- {
- return true;
- }
- return (modifiers & ConsoleModifiers.Shift) != 0;
- }
- }
- private static MouseFlags _lastMouseFlags;
- /// <summary>
- /// Provides a handler to be invoked when mouse continuous button pressed is processed.
- /// </summary>
- public static event EventHandler<MouseEventArgs> ContinuousButtonPressed;
- /// <summary>
- /// Provides a default mouse event handler that can be used by any driver.
- /// </summary>
- /// <param name="mouseFlag">The mouse flags event.</param>
- /// <param name="pos">The mouse position.</param>
- public static void ProcessMouseEvent (MouseFlags mouseFlag, Point pos)
- {
- bool WasButtonReleased (MouseFlags flag)
- {
- return flag.HasFlag (MouseFlags.Button1Released)
- || flag.HasFlag (MouseFlags.Button2Released)
- || flag.HasFlag (MouseFlags.Button3Released)
- || flag.HasFlag (MouseFlags.Button4Released);
- }
- bool IsButtonNotPressed (MouseFlags flag)
- {
- return !flag.HasFlag (MouseFlags.Button1Pressed)
- && !flag.HasFlag (MouseFlags.Button2Pressed)
- && !flag.HasFlag (MouseFlags.Button3Pressed)
- && !flag.HasFlag (MouseFlags.Button4Pressed);
- }
- bool IsButtonClickedOrDoubleClicked (MouseFlags flag)
- {
- return flag.HasFlag (MouseFlags.Button1Clicked)
- || flag.HasFlag (MouseFlags.Button2Clicked)
- || flag.HasFlag (MouseFlags.Button3Clicked)
- || flag.HasFlag (MouseFlags.Button4Clicked)
- || flag.HasFlag (MouseFlags.Button1DoubleClicked)
- || flag.HasFlag (MouseFlags.Button2DoubleClicked)
- || flag.HasFlag (MouseFlags.Button3DoubleClicked)
- || flag.HasFlag (MouseFlags.Button4DoubleClicked);
- }
- if ((WasButtonReleased (mouseFlag) && IsButtonNotPressed (_lastMouseFlags)) || (IsButtonClickedOrDoubleClicked (mouseFlag) && _lastMouseFlags == 0))
- {
- return;
- }
- _lastMouseFlags = mouseFlag;
- var me = new MouseEventArgs { Flags = mouseFlag, Position = pos };
- ContinuousButtonPressed?.Invoke ((mouseFlag, pos), me);
- }
- /// <summary>
- /// A helper to resize the <see cref="ConsoleKeyInfo"/> as needed.
- /// </summary>
- /// <param name="consoleKeyInfo">The <see cref="ConsoleKeyInfo"/>.</param>
- /// <param name="cki">The <see cref="ConsoleKeyInfo"/> array to resize.</param>
- /// <returns>The <see cref="ConsoleKeyInfo"/> resized.</returns>
- public static ConsoleKeyInfo [] ResizeArray (ConsoleKeyInfo consoleKeyInfo, ConsoleKeyInfo [] cki)
- {
- Array.Resize (ref cki, cki is null ? 1 : cki.Length + 1);
- cki [^1] = consoleKeyInfo;
- return cki;
- }
- /// <summary>
- /// Insert a <see cref="ConsoleKeyInfo"/> array into the another <see cref="ConsoleKeyInfo"/> array at the specified
- /// index.
- /// </summary>
- /// <param name="toInsert">The array to insert.</param>
- /// <param name="cki">The array where will be added the array.</param>
- /// <param name="index">The start index to insert the array, default is 0.</param>
- /// <returns>The <see cref="ConsoleKeyInfo"/> array with another array inserted.</returns>
- public static ConsoleKeyInfo [] InsertArray ([CanBeNull] ConsoleKeyInfo [] toInsert, ConsoleKeyInfo [] cki, int index = 0)
- {
- if (toInsert is null)
- {
- return cki;
- }
- if (cki is null)
- {
- return toInsert;
- }
- if (index < 0)
- {
- index = 0;
- }
- ConsoleKeyInfo [] backupCki = cki.Clone () as ConsoleKeyInfo [];
- Array.Resize (ref cki, cki.Length + toInsert.Length);
- for (var i = 0; i < cki.Length; i++)
- {
- if (i == index)
- {
- for (var j = 0; j < toInsert.Length; j++)
- {
- cki [i] = toInsert [j];
- i++;
- }
- for (int k = index; k < backupCki!.Length; k++)
- {
- cki [i] = backupCki [k];
- i++;
- }
- }
- else
- {
- cki [i] = backupCki! [i];
- }
- }
- return cki;
- }
- private static MouseFlags GetButtonClicked (MouseFlags mouseFlag)
- {
- MouseFlags mf = default;
- switch (mouseFlag)
- {
- case MouseFlags.Button1Released:
- mf = MouseFlags.Button1Clicked;
- break;
- case MouseFlags.Button2Released:
- mf = MouseFlags.Button2Clicked;
- break;
- case MouseFlags.Button3Released:
- mf = MouseFlags.Button3Clicked;
- break;
- }
- return mf;
- }
- private static MouseFlags GetButtonDoubleClicked (MouseFlags mouseFlag)
- {
- MouseFlags mf = default;
- switch (mouseFlag)
- {
- case MouseFlags.Button1Pressed:
- mf = MouseFlags.Button1DoubleClicked;
- break;
- case MouseFlags.Button2Pressed:
- mf = MouseFlags.Button2DoubleClicked;
- break;
- case MouseFlags.Button3Pressed:
- mf = MouseFlags.Button3DoubleClicked;
- break;
- }
- return mf;
- }
- private static MouseFlags GetButtonTripleClicked (MouseFlags mouseFlag)
- {
- MouseFlags mf = default;
- switch (mouseFlag)
- {
- case MouseFlags.Button1Pressed:
- mf = MouseFlags.Button1TripleClicked;
- break;
- case MouseFlags.Button2Pressed:
- mf = MouseFlags.Button2TripleClicked;
- break;
- case MouseFlags.Button3Pressed:
- mf = MouseFlags.Button3TripleClicked;
- break;
- }
- return mf;
- }
- internal static KeyCode MapKey (ConsoleKeyInfo keyInfo)
- {
- switch (keyInfo.Key)
- {
- case ConsoleKey.OemPeriod:
- case ConsoleKey.OemComma:
- case ConsoleKey.OemPlus:
- case ConsoleKey.OemMinus:
- case ConsoleKey.Packet:
- 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:
- if (keyInfo.KeyChar == 0)
- {
- // If the keyChar is 0, keyInfo.Key value is not a printable character.
- System.Diagnostics.Debug.Assert (keyInfo.Key == 0);
- return KeyCode.Null; // MapToKeyCodeModifiers (keyInfo.Modifiers, KeyCode)keyInfo.Key);
- }
- if (keyInfo.Modifiers != ConsoleModifiers.Shift)
- {
- // If Shift wasn't down we don't need to do anything but return the keyInfo.KeyChar
- return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)keyInfo.KeyChar);
- }
- // Strip off Shift - We got here because they KeyChar from Windows is the shifted char (e.g. "Ç")
- // and passing on Shift would be redundant.
- return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.KeyChar);
- }
- // Handle control keys whose VK codes match the related ASCII value (those below ASCII 33) like ESC
- if (keyInfo.Key != ConsoleKey.None && Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key))
- {
- if (keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control) && keyInfo.Key == ConsoleKey.I)
- {
- return KeyCode.Tab;
- }
- return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)(uint)keyInfo.Key);
- }
- // Handle control keys (e.g. CursorUp)
- if (keyInfo.Key != ConsoleKey.None
- && Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint))
- {
- return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint));
- }
- if ((ConsoleKey)keyInfo.KeyChar is >= ConsoleKey.A and <= ConsoleKey.Z)
- {
- // Shifted
- keyInfo = new (
- keyInfo.KeyChar,
- (ConsoleKey)keyInfo.KeyChar,
- true,
- keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt),
- keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control));
- }
- if ((ConsoleKey)keyInfo.KeyChar - 32 is >= ConsoleKey.A and <= ConsoleKey.Z)
- {
- // Unshifted
- keyInfo = new (
- keyInfo.KeyChar,
- (ConsoleKey)(keyInfo.KeyChar - 32),
- false,
- keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt),
- keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control));
- }
- if (keyInfo.Key is >= ConsoleKey.A and <= ConsoleKey.Z)
- {
- if (keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt)
- || keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control))
- {
- // NetDriver doesn't support Shift-Ctrl/Shift-Alt combos
- return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.Key);
- }
- if (keyInfo.Modifiers == ConsoleModifiers.Shift)
- {
- // If ShiftMask is on add the ShiftMask
- if (char.IsUpper (keyInfo.KeyChar))
- {
- return (KeyCode)keyInfo.Key | KeyCode.ShiftMask;
- }
- }
- return (KeyCode)keyInfo.Key;
- }
- return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)keyInfo.KeyChar);
- }
- private static async Task ProcessButtonClickedAsync ()
- {
- await Task.Delay (300);
- _isButtonClicked = false;
- }
- private static async Task ProcessButtonDoubleClickedAsync ()
- {
- await Task.Delay (300);
- _isButtonDoubleClicked = false;
- }
- private static async Task ProcessContinuousButtonPressedAsync (MouseFlags mouseFlag, Action<MouseFlags, Point> continuousButtonPressedHandler)
- {
- // PERF: Pause and poll in a hot loop.
- // This should be replaced with event dispatch and a synchronization primitive such as AutoResetEvent.
- // Will make a massive difference in responsiveness.
- while (_isButtonPressed)
- {
- await Task.Delay (100);
- View view = Application.WantContinuousButtonPressedView;
- if (view is null)
- {
- break;
- }
- if (_isButtonPressed && _lastMouseButtonPressed is { } && (mouseFlag & MouseFlags.ReportMousePosition) == 0)
- {
- Application.Invoke (() => continuousButtonPressedHandler (mouseFlag, _point ?? Point.Empty));
- }
- }
- }
- private static MouseFlags SetControlKeyStates (MouseFlags buttonState, MouseFlags mouseFlag)
- {
- if ((buttonState & MouseFlags.ButtonCtrl) != 0 && (mouseFlag & MouseFlags.ButtonCtrl) == 0)
- {
- mouseFlag |= MouseFlags.ButtonCtrl;
- }
- if ((buttonState & MouseFlags.ButtonShift) != 0 && (mouseFlag & MouseFlags.ButtonShift) == 0)
- {
- mouseFlag |= MouseFlags.ButtonShift;
- }
- if ((buttonState & MouseFlags.ButtonAlt) != 0 && (mouseFlag & MouseFlags.ButtonAlt) == 0)
- {
- mouseFlag |= MouseFlags.ButtonAlt;
- }
- return mouseFlag;
- }
- /// <summary>
- /// Split a raw string into a list of string with the correct ansi escape sequence.
- /// </summary>
- /// <param name="rawData">The raw string containing one or many ansi escape sequence.</param>
- /// <returns>A list with a valid ansi escape sequence.</returns>
- public static List<string> SplitEscapeRawString (string rawData)
- {
- List<string> splitList = [];
- var isEscSeq = false;
- var split = string.Empty;
- char previousChar = '\0';
- for (var i = 0; i < rawData.Length; i++)
- {
- char c = rawData [i];
- if (c == '\u001B')
- {
- isEscSeq = true;
- split = AddAndClearSplit ();
- split += c.ToString ();
- }
- else if (!isEscSeq && c >= Key.Space)
- {
- split = AddAndClearSplit ();
- splitList.Add (c.ToString ());
- }
- else if ((previousChar != '\u001B' && c <= Key.Space) || (previousChar != '\u001B' && c == 127)
- || (char.IsLetter (previousChar) && char.IsLower (c) && char.IsLetter (c))
- || (!string.IsNullOrEmpty (split) && split.Length > 2 && char.IsLetter (previousChar) && char.IsLetterOrDigit (c))
- || (!string.IsNullOrEmpty (split) && split.Length > 2 && char.IsLetter (previousChar) && char.IsPunctuation (c))
- || (!string.IsNullOrEmpty (split) && split.Length > 2 && char.IsLetter (previousChar) && char.IsSymbol (c)))
- {
- isEscSeq = false;
- split = AddAndClearSplit ();
- splitList.Add (c.ToString ());
- }
- else
- {
- split += c.ToString ();
- }
- if (!string.IsNullOrEmpty (split) && i == rawData.Length - 1)
- {
- splitList.Add (split);
- }
- previousChar = c;
- }
- return splitList;
- string AddAndClearSplit ()
- {
- if (!string.IsNullOrEmpty (split))
- {
- splitList.Add (split);
- split = string.Empty;
- }
- return split;
- }
- }
- /// <summary>
- /// Convert a <see cref="ConsoleKeyInfo"/> array to string.
- /// </summary>
- /// <param name="consoleKeyInfos"></param>
- /// <returns>The string representing the array.</returns>
- public static string ToString (ConsoleKeyInfo [] consoleKeyInfos)
- {
- StringBuilder sb = new ();
- foreach (ConsoleKeyInfo keyChar in consoleKeyInfos)
- {
- sb.Append (keyChar.KeyChar);
- }
- return sb.ToString ();
- }
- /// <summary>
- /// Convert a string to <see cref="ConsoleKeyInfo"/> array.
- /// </summary>
- /// <param name="ansi"></param>
- /// <returns>The <see cref="ConsoleKeyInfo"/>representing the string.</returns>
- public static ConsoleKeyInfo [] ToConsoleKeyInfoArray (string ansi)
- {
- if (ansi is null)
- {
- return null;
- }
- ConsoleKeyInfo [] cki = new ConsoleKeyInfo [ansi.Length];
- for (var i = 0; i < ansi.Length; i++)
- {
- char c = ansi [i];
- cki [i] = new (c, 0, false, false, false);
- }
- return cki;
- }
- #region Cursor
- //ESC [ M - RI Reverse Index – Performs the reverse operation of \n, moves cursor up one line, maintains horizontal position, scrolls buffer if necessary*
- /// <summary>
- /// ESC [ 7 - Save Cursor Position in Memory**
- /// </summary>
- public static readonly string CSI_SaveCursorPosition = CSI + "7";
- /// <summary>
- /// ESC [ 8 - DECSR Restore Cursor Position from Memory**
- /// </summary>
- public static readonly string CSI_RestoreCursorPosition = CSI + "8";
- /// <summary>
- /// ESC [ 8 ; height ; width t - Set Terminal Window Size
- /// https://terminalguide.namepad.de/seq/csi_st-8/
- /// </summary>
- public static string CSI_SetTerminalWindowSize (int height, int width) { return $"{CSI}8;{height};{width}t"; }
- //ESC [ < n > A - CUU - Cursor Up Cursor up by < n >
- //ESC [ < n > B - CUD - Cursor Down Cursor down by < n >
- //ESC [ < n > C - CUF - Cursor Forward Cursor forward (Right) by < n >
- //ESC [ < n > D - CUB - Cursor Backward Cursor backward (Left) by < n >
- //ESC [ < n > E - CNL - Cursor Next Line - Cursor down < n > lines from current position
- //ESC [ < n > F - CPL - Cursor Previous Line Cursor up < n > lines from current position
- //ESC [ < n > G - CHA - Cursor Horizontal Absolute Cursor moves to < n > th position horizontally in the current line
- //ESC [ < n > d - VPA - Vertical Line Position Absolute Cursor moves to the < n > th position vertically in the current column
- /// <summary>
- /// ESC [ y ; x H - CUP Cursor Position - Cursor moves to x ; y coordinate within the viewport, where x is the column
- /// of the y line
- /// </summary>
- /// <param name="row">Origin is (1,1).</param>
- /// <param name="col">Origin is (1,1).</param>
- /// <returns></returns>
- public static string CSI_SetCursorPosition (int row, int col) { return $"{CSI}{row};{col}H"; }
- /// <summary>
- /// ESC [ y ; x H - CUP Cursor Position - Cursor moves to x ; y coordinate within the viewport, where x is the column
- /// of the y line
- /// </summary>
- /// <param name="builder">StringBuilder where to append the cursor position sequence.</param>
- /// <param name="row">Origin is (1,1).</param>
- /// <param name="col">Origin is (1,1).</param>
- public static void CSI_AppendCursorPosition (StringBuilder builder, int row, int col)
- {
- // InterpolatedStringHandler is composed in stack, skipping the string allocation.
- builder.Append ($"{CSI}{row};{col}H");
- }
- //ESC [ <y> ; <x> f - HVP Horizontal Vertical Position* Cursor moves to<x>; <y> coordinate within the viewport, where <x> is the column of the<y> line
- //ESC [ s - ANSISYSSC Save Cursor – Ansi.sys emulation **With no parameters, performs a save cursor operation like DECSC
- //ESC [ u - ANSISYSRC Restore Cursor – Ansi.sys emulation **With no parameters, performs a restore cursor operation like DECRC
- //ESC [ ? 12 h - ATT160 Text Cursor Enable Blinking Start the cursor blinking
- //ESC [ ? 12 l - ATT160 Text Cursor Disable Blinking Stop blinking the cursor
- /// <summary>
- /// ESC [ ? 25 h - DECTCEM Text Cursor Enable Mode Show Show the cursor
- /// </summary>
- public static readonly string CSI_ShowCursor = CSI + "?25h";
- /// <summary>
- /// ESC [ ? 25 l - DECTCEM Text Cursor Enable Mode Hide Hide the cursor
- /// </summary>
- public static readonly string CSI_HideCursor = CSI + "?25l";
- //ESC [ ? 12 h - ATT160 Text Cursor Enable Blinking Start the cursor blinking
- //ESC [ ? 12 l - ATT160 Text Cursor Disable Blinking Stop blinking the cursor
- //ESC [ ? 25 h - DECTCEM Text Cursor Enable Mode Show Show the cursor
- //ESC [ ? 25 l - DECTCEM Text Cursor Enable Mode Hide Hide the cursor
- /// <summary>
- /// Styles for ANSI ESC "[x q" - Set Cursor Style
- /// </summary>
- public enum DECSCUSR_Style
- {
- /// <summary>
- /// DECSCUSR - User Shape - Default cursor shape configured by the user
- /// </summary>
- UserShape = 0,
- /// <summary>
- /// DECSCUSR - Blinking Block - Blinking block cursor shape
- /// </summary>
- BlinkingBlock = 1,
- /// <summary>
- /// DECSCUSR - Steady Block - Steady block cursor shape
- /// </summary>
- SteadyBlock = 2,
- /// <summary>
- /// DECSCUSR - Blinking Underline - Blinking underline cursor shape
- /// </summary>
- BlinkingUnderline = 3,
- /// <summary>
- /// DECSCUSR - Steady Underline - Steady underline cursor shape
- /// </summary>
- SteadyUnderline = 4,
- /// <summary>
- /// DECSCUSR - Blinking Bar - Blinking bar cursor shape
- /// </summary>
- BlinkingBar = 5,
- /// <summary>
- /// DECSCUSR - Steady Bar - Steady bar cursor shape
- /// </summary>
- SteadyBar = 6
- }
- /// <summary>
- /// ESC [ n SP q - Select Cursor Style (DECSCUSR)
- /// https://terminalguide.namepad.de/seq/csi_sq_t_space/
- /// </summary>
- /// <param name="style"></param>
- /// <returns></returns>
- public static string CSI_SetCursorStyle (DECSCUSR_Style style) { return $"{CSI}{(int)style} q"; }
- #endregion
- #region Colors
- /// <summary>
- /// ESC [ (n) m - SGR - Set Graphics Rendition - Set the format of the screen and text as specified by (n)
- /// This command is special in that the (n) position can accept between 0 and 16 parameters separated by semicolons.
- /// When no parameters are specified, it is treated the same as a single 0 parameter.
- /// https://terminalguide.namepad.de/seq/csi_sm/
- /// </summary>
- public static string CSI_SetGraphicsRendition (params int [] parameters) { return $"{CSI}{string.Join (";", parameters)}m"; }
- /// <summary>
- /// ESC [ (n) m - Uses <see cref="CSI_SetGraphicsRendition(int[])"/> to set the foreground color.
- /// </summary>
- /// <param name="code">One of the 16 color codes.</param>
- /// <returns></returns>
- public static string CSI_SetForegroundColor (AnsiColorCode code) { return CSI_SetGraphicsRendition ((int)code); }
- /// <summary>
- /// ESC [ (n) m - Uses <see cref="CSI_SetGraphicsRendition(int[])"/> to set the background color.
- /// </summary>
- /// <param name="code">One of the 16 color codes.</param>
- /// <returns></returns>
- public static string CSI_SetBackgroundColor (AnsiColorCode code) { return CSI_SetGraphicsRendition ((int)code + 10); }
- /// <summary>
- /// ESC[38;5;{id}m - Set foreground color (256 colors)
- /// </summary>
- public static string CSI_SetForegroundColor256 (int color) { return $"{CSI}38;5;{color}m"; }
- /// <summary>
- /// ESC[48;5;{id}m - Set background color (256 colors)
- /// </summary>
- public static string CSI_SetBackgroundColor256 (int color) { return $"{CSI}48;5;{color}m"; }
- /// <summary>
- /// ESC[38;2;{r};{g};{b}m Set foreground color as RGB.
- /// </summary>
- public static string CSI_SetForegroundColorRGB (int r, int g, int b) { return $"{CSI}38;2;{r};{g};{b}m"; }
- /// <summary>
- /// ESC[38;2;{r};{g};{b}m Append foreground color as RGB to StringBuilder.
- /// </summary>
- public static void CSI_AppendForegroundColorRGB (StringBuilder builder, int r, int g, int b)
- {
- // InterpolatedStringHandler is composed in stack, skipping the string allocation.
- builder.Append ($"{CSI}38;2;{r};{g};{b}m");
- }
- /// <summary>
- /// ESC[48;2;{r};{g};{b}m Set background color as RGB.
- /// </summary>
- public static string CSI_SetBackgroundColorRGB (int r, int g, int b) { return $"{CSI}48;2;{r};{g};{b}m"; }
- /// <summary>
- /// ESC[48;2;{r};{g};{b}m Append background color as RGB to StringBuilder.
- /// </summary>
- public static void CSI_AppendBackgroundColorRGB (StringBuilder builder, int r, int g, int b)
- {
- // InterpolatedStringHandler is composed in stack, skipping the string allocation.
- builder.Append ($"{CSI}48;2;{r};{g};{b}m");
- }
- #endregion
- #region Requests
- /// <summary>
- /// ESC [ ? 6 n - Request Cursor Position Report (?) (DECXCPR)
- /// https://terminalguide.namepad.de/seq/csi_sn__p-6/
- /// The terminal reply to <see cref="CSI_RequestCursorPositionReport"/>. ESC [ ? (y) ; (x) ; 1 R
- /// </summary>
- public static readonly AnsiEscapeSequence CSI_RequestCursorPositionReport = new () { Request = CSI + "?6n", Terminator = "R" };
- /// <summary>
- /// The terminal reply to <see cref="CSI_RequestCursorPositionReport"/>. ESC [ ? (y) ; (x) R
- /// </summary>
- public const string CSI_RequestCursorPositionReport_Terminator = "R";
- /// <summary>
- /// ESC [ 0 c - Send Device Attributes (Primary DA)
- /// https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Application-Program-Command-functions
- /// https://www.xfree86.org/current/ctlseqs.html
- /// Windows Terminal v1.17 and below emits “\x1b[?1;0c”, indicating "VT101 with No Options".
- /// Windows Terminal v1.18+ emits: \x1b[?61;6;7;22;23;24;28;32;42c"
- /// See https://github.com/microsoft/terminal/pull/14906
- /// 61 - The device conforms to level 1 of the character cell display architecture
- /// (See https://github.com/microsoft/terminal/issues/15693#issuecomment-1633304497)
- /// 6 = Selective erase
- /// 7 = Soft fonts
- /// 22 = Color text
- /// 23 = Greek character sets
- /// 24 = Turkish character sets
- /// 28 = Rectangular area operations
- /// 32 = Text macros
- /// 42 = ISO Latin-2 character set
- /// The terminator indicating a reply to <see cref="CSI_SendDeviceAttributes"/> or
- /// <see cref="CSI_SendDeviceAttributes2"/>
- /// </summary>
- public static readonly AnsiEscapeSequence CSI_SendDeviceAttributes = new () { Request = CSI + "0c", Terminator = "c" };
- /// <summary>
- /// ESC [ > 0 c - Send Device Attributes (Secondary DA)
- /// Windows Terminal v1.18+ emits: "\x1b[>0;10;1c" (vt100, firmware version 1.0, vt220)
- /// </summary>
- public static readonly AnsiEscapeSequence CSI_SendDeviceAttributes2 = new () { Request = CSI + ">0c", Terminator = "c" };
- /// <summary>
- /// CSI 16 t - Request sixel resolution (width and height in pixels)
- /// </summary>
- public static readonly AnsiEscapeSequence CSI_RequestSixelResolution = new () { Request = CSI + "16t", Terminator = "t" };
- /// <summary>
- /// CSI 14 t - Request window size in pixels (width x height)
- /// </summary>
- public static readonly AnsiEscapeSequence CSI_RequestWindowSizeInPixels = new () { Request = CSI + "14t", Terminator = "t" };
- /// <summary>
- /// CSI 1 8 t | yes | yes | yes | report window size in chars
- /// https://terminalguide.namepad.de/seq/csi_st-18/
- /// The terminator indicating a reply to <see cref="CSI_ReportTerminalSizeInChars"/> : ESC [ 8 ; height ; width t
- /// </summary>
- public static readonly AnsiEscapeSequence CSI_ReportTerminalSizeInChars = new () { Request = CSI + "18t", Terminator = "t", Value = "8" };
- /// <summary>
- /// The terminator indicating a reply to <see cref="CSI_ReportTerminalSizeInChars"/> : ESC [ 8 ; height ; width t
- /// </summary>
- public const string CSI_ReportTerminalSizeInChars_Terminator = "t";
- /// <summary>
- /// The value of the response to <see cref="CSI_ReportTerminalSizeInChars"/> indicating value 1 and 2 are the terminal
- /// size in chars.
- /// </summary>
- public const string CSI_ReportTerminalSizeInChars_ResponseValue = "8";
- #endregion
- }
|