NetDriver.cs 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820
  1. //
  2. // NetDriver.cs: The System.Console-based .NET driver, works on Windows and Unix, but is not particularly efficient.
  3. //
  4. using System.Diagnostics;
  5. using System.Runtime.InteropServices;
  6. using static Terminal.Gui.ConsoleDrivers.ConsoleKeyMapping;
  7. using static Terminal.Gui.NetEvents;
  8. namespace Terminal.Gui;
  9. internal class NetWinVTConsole
  10. {
  11. private const uint DISABLE_NEWLINE_AUTO_RETURN = 8;
  12. private const uint ENABLE_ECHO_INPUT = 4;
  13. private const uint ENABLE_EXTENDED_FLAGS = 128;
  14. private const uint ENABLE_INSERT_MODE = 32;
  15. private const uint ENABLE_LINE_INPUT = 2;
  16. private const uint ENABLE_LVB_GRID_WORLDWIDE = 10;
  17. private const uint ENABLE_MOUSE_INPUT = 16;
  18. // Input modes.
  19. private const uint ENABLE_PROCESSED_INPUT = 1;
  20. // Output modes.
  21. private const uint ENABLE_PROCESSED_OUTPUT = 1;
  22. private const uint ENABLE_QUICK_EDIT_MODE = 64;
  23. private const uint ENABLE_VIRTUAL_TERMINAL_INPUT = 512;
  24. private const uint ENABLE_VIRTUAL_TERMINAL_PROCESSING = 4;
  25. private const uint ENABLE_WINDOW_INPUT = 8;
  26. private const uint ENABLE_WRAP_AT_EOL_OUTPUT = 2;
  27. private const int STD_ERROR_HANDLE = -12;
  28. private const int STD_INPUT_HANDLE = -10;
  29. private const int STD_OUTPUT_HANDLE = -11;
  30. private readonly nint _errorHandle;
  31. private readonly nint _inputHandle;
  32. private readonly uint _originalErrorConsoleMode;
  33. private readonly uint _originalInputConsoleMode;
  34. private readonly uint _originalOutputConsoleMode;
  35. private readonly nint _outputHandle;
  36. public NetWinVTConsole ()
  37. {
  38. _inputHandle = GetStdHandle (STD_INPUT_HANDLE);
  39. if (!GetConsoleMode (_inputHandle, out uint mode))
  40. {
  41. throw new ApplicationException ($"Failed to get input console mode, error code: {GetLastError ()}.");
  42. }
  43. _originalInputConsoleMode = mode;
  44. if ((mode & ENABLE_VIRTUAL_TERMINAL_INPUT) < ENABLE_VIRTUAL_TERMINAL_INPUT)
  45. {
  46. mode |= ENABLE_VIRTUAL_TERMINAL_INPUT;
  47. if (!SetConsoleMode (_inputHandle, mode))
  48. {
  49. throw new ApplicationException ($"Failed to set input console mode, error code: {GetLastError ()}.");
  50. }
  51. }
  52. _outputHandle = GetStdHandle (STD_OUTPUT_HANDLE);
  53. if (!GetConsoleMode (_outputHandle, out mode))
  54. {
  55. throw new ApplicationException ($"Failed to get output console mode, error code: {GetLastError ()}.");
  56. }
  57. _originalOutputConsoleMode = mode;
  58. if ((mode & (ENABLE_VIRTUAL_TERMINAL_PROCESSING | DISABLE_NEWLINE_AUTO_RETURN)) < DISABLE_NEWLINE_AUTO_RETURN)
  59. {
  60. mode |= ENABLE_VIRTUAL_TERMINAL_PROCESSING | DISABLE_NEWLINE_AUTO_RETURN;
  61. if (!SetConsoleMode (_outputHandle, mode))
  62. {
  63. throw new ApplicationException ($"Failed to set output console mode, error code: {GetLastError ()}.");
  64. }
  65. }
  66. _errorHandle = GetStdHandle (STD_ERROR_HANDLE);
  67. if (!GetConsoleMode (_errorHandle, out mode))
  68. {
  69. throw new ApplicationException ($"Failed to get error console mode, error code: {GetLastError ()}.");
  70. }
  71. _originalErrorConsoleMode = mode;
  72. if ((mode & DISABLE_NEWLINE_AUTO_RETURN) < DISABLE_NEWLINE_AUTO_RETURN)
  73. {
  74. mode |= DISABLE_NEWLINE_AUTO_RETURN;
  75. if (!SetConsoleMode (_errorHandle, mode))
  76. {
  77. throw new ApplicationException ($"Failed to set error console mode, error code: {GetLastError ()}.");
  78. }
  79. }
  80. }
  81. public void Cleanup ()
  82. {
  83. if (!SetConsoleMode (_inputHandle, _originalInputConsoleMode))
  84. {
  85. throw new ApplicationException ($"Failed to restore input console mode, error code: {GetLastError ()}.");
  86. }
  87. if (!SetConsoleMode (_outputHandle, _originalOutputConsoleMode))
  88. {
  89. throw new ApplicationException ($"Failed to restore output console mode, error code: {GetLastError ()}.");
  90. }
  91. if (!SetConsoleMode (_errorHandle, _originalErrorConsoleMode))
  92. {
  93. throw new ApplicationException ($"Failed to restore error console mode, error code: {GetLastError ()}.");
  94. }
  95. }
  96. [DllImport ("kernel32.dll")]
  97. private static extern bool GetConsoleMode (nint hConsoleHandle, out uint lpMode);
  98. [DllImport ("kernel32.dll")]
  99. private static extern uint GetLastError ();
  100. [DllImport ("kernel32.dll", SetLastError = true)]
  101. private static extern nint GetStdHandle (int nStdHandle);
  102. [DllImport ("kernel32.dll")]
  103. private static extern bool SetConsoleMode (nint hConsoleHandle, uint dwMode);
  104. }
  105. internal class NetEvents : IDisposable
  106. {
  107. private readonly ManualResetEventSlim _inputReady = new (false);
  108. private CancellationTokenSource _inputReadyCancellationTokenSource;
  109. private readonly ManualResetEventSlim _waitForStart = new (false);
  110. //CancellationTokenSource _waitForStartCancellationTokenSource;
  111. private readonly ManualResetEventSlim _winChange = new (false);
  112. private readonly Queue<InputResult?> _inputQueue = new ();
  113. private readonly ConsoleDriver _consoleDriver;
  114. private ConsoleKeyInfo [] _cki;
  115. private bool _isEscSeq;
  116. #if PROCESS_REQUEST
  117. bool _neededProcessRequest;
  118. #endif
  119. public EscSeqRequests EscSeqRequests { get; } = new ();
  120. public NetEvents (ConsoleDriver consoleDriver)
  121. {
  122. _consoleDriver = consoleDriver ?? throw new ArgumentNullException (nameof (consoleDriver));
  123. _inputReadyCancellationTokenSource = new CancellationTokenSource ();
  124. Task.Run (ProcessInputQueue, _inputReadyCancellationTokenSource.Token);
  125. Task.Run (CheckWindowSizeChange, _inputReadyCancellationTokenSource.Token);
  126. }
  127. public InputResult? DequeueInput ()
  128. {
  129. while (_inputReadyCancellationTokenSource is { Token.IsCancellationRequested: false })
  130. {
  131. _waitForStart.Set ();
  132. _winChange.Set ();
  133. try
  134. {
  135. if (!_inputReadyCancellationTokenSource.Token.IsCancellationRequested)
  136. {
  137. if (_inputQueue.Count == 0)
  138. {
  139. _inputReady.Wait (_inputReadyCancellationTokenSource.Token);
  140. }
  141. }
  142. }
  143. catch (OperationCanceledException)
  144. {
  145. return null;
  146. }
  147. finally
  148. {
  149. _inputReady.Reset ();
  150. }
  151. #if PROCESS_REQUEST
  152. _neededProcessRequest = false;
  153. #endif
  154. if (_inputQueue.Count > 0)
  155. {
  156. return _inputQueue.Dequeue ();
  157. }
  158. }
  159. return null;
  160. }
  161. private static ConsoleKeyInfo ReadConsoleKeyInfo (CancellationToken cancellationToken, bool intercept = true)
  162. {
  163. // The Console.KeyAvailable must only be used if
  164. // the console is reading an Ansi escape sequence
  165. // Task.Delay must only be used on limited situations
  166. // and not for the entire application execution, which
  167. // case need to use async Task to really awaiting,
  168. // like the CheckWindowSizeChange is using
  169. try
  170. {
  171. return Console.ReadKey (intercept);
  172. }
  173. catch (InvalidOperationException) { }
  174. cancellationToken.ThrowIfCancellationRequested ();
  175. return default (ConsoleKeyInfo);
  176. }
  177. private void ProcessInputQueue ()
  178. {
  179. while (!_inputReadyCancellationTokenSource.Token.IsCancellationRequested)
  180. {
  181. try
  182. {
  183. _waitForStart.Wait (_inputReadyCancellationTokenSource.Token);
  184. }
  185. catch (OperationCanceledException)
  186. {
  187. return;
  188. }
  189. _waitForStart.Reset ();
  190. if (_inputQueue.Count == 0)
  191. {
  192. ConsoleKey key = 0;
  193. ConsoleModifiers mod = 0;
  194. ConsoleKeyInfo newConsoleKeyInfo = default;
  195. while (true)
  196. {
  197. if (_inputReadyCancellationTokenSource.Token.IsCancellationRequested)
  198. {
  199. return;
  200. }
  201. ConsoleKeyInfo consoleKeyInfo;
  202. try
  203. {
  204. consoleKeyInfo = ReadConsoleKeyInfo (_inputReadyCancellationTokenSource.Token);
  205. }
  206. catch (OperationCanceledException)
  207. {
  208. return;
  209. }
  210. if ((consoleKeyInfo.KeyChar == (char)KeyCode.Esc && !_isEscSeq)
  211. || (consoleKeyInfo.KeyChar != (char)KeyCode.Esc && _isEscSeq))
  212. {
  213. if (_cki is null && consoleKeyInfo.KeyChar != (char)KeyCode.Esc && _isEscSeq)
  214. {
  215. _cki = EscSeqUtils.ResizeArray (
  216. new ConsoleKeyInfo (
  217. (char)KeyCode.Esc,
  218. 0,
  219. false,
  220. false,
  221. false
  222. ),
  223. _cki
  224. );
  225. }
  226. _isEscSeq = true;
  227. newConsoleKeyInfo = consoleKeyInfo;
  228. _cki = EscSeqUtils.ResizeArray (consoleKeyInfo, _cki);
  229. if (Console.KeyAvailable)
  230. {
  231. continue;
  232. }
  233. ProcessRequestResponse (ref newConsoleKeyInfo, ref key, _cki, ref mod);
  234. _cki = null;
  235. _isEscSeq = false;
  236. break;
  237. }
  238. if (consoleKeyInfo.KeyChar == (char)KeyCode.Esc && _isEscSeq && _cki is { })
  239. {
  240. ProcessRequestResponse (ref newConsoleKeyInfo, ref key, _cki, ref mod);
  241. _cki = null;
  242. if (Console.KeyAvailable)
  243. {
  244. _cki = EscSeqUtils.ResizeArray (consoleKeyInfo, _cki);
  245. }
  246. else
  247. {
  248. ProcessMapConsoleKeyInfo (consoleKeyInfo);
  249. }
  250. break;
  251. }
  252. if (consoleKeyInfo != default (ConsoleKeyInfo))
  253. {
  254. ProcessMapConsoleKeyInfo (consoleKeyInfo);
  255. }
  256. break;
  257. }
  258. }
  259. _inputReady.Set ();
  260. }
  261. void ProcessMapConsoleKeyInfo (ConsoleKeyInfo consoleKeyInfo)
  262. {
  263. _inputQueue.Enqueue (
  264. new InputResult
  265. {
  266. EventType = EventType.Key, ConsoleKeyInfo = EscSeqUtils.MapConsoleKeyInfo (consoleKeyInfo)
  267. }
  268. );
  269. _isEscSeq = false;
  270. }
  271. }
  272. private async Task CheckWindowSizeChange ()
  273. {
  274. while (true)
  275. {
  276. if (_inputReadyCancellationTokenSource.IsCancellationRequested)
  277. {
  278. return;
  279. }
  280. try
  281. {
  282. _winChange.Wait (_inputReadyCancellationTokenSource.Token);
  283. _winChange.Reset ();
  284. await RequestWindowSize (_inputReadyCancellationTokenSource.Token);
  285. }
  286. catch (OperationCanceledException)
  287. {
  288. return;
  289. }
  290. _inputReady.Set ();
  291. }
  292. async Task RequestWindowSize (CancellationToken cancellationToken)
  293. {
  294. while (!cancellationToken.IsCancellationRequested)
  295. {
  296. // Wait for a while then check if screen has changed sizes
  297. await Task.Delay (500, cancellationToken);
  298. int buffHeight, buffWidth;
  299. if (((NetDriver)_consoleDriver).IsWinPlatform)
  300. {
  301. buffHeight = Math.Max (Console.BufferHeight, 0);
  302. buffWidth = Math.Max (Console.BufferWidth, 0);
  303. }
  304. else
  305. {
  306. buffHeight = _consoleDriver.Rows;
  307. buffWidth = _consoleDriver.Cols;
  308. }
  309. if (EnqueueWindowSizeEvent (
  310. Math.Max (Console.WindowHeight, 0),
  311. Math.Max (Console.WindowWidth, 0),
  312. buffHeight,
  313. buffWidth
  314. ))
  315. {
  316. return;
  317. }
  318. }
  319. cancellationToken.ThrowIfCancellationRequested ();
  320. }
  321. }
  322. /// <summary>Enqueue a window size event if the window size has changed.</summary>
  323. /// <param name="winHeight"></param>
  324. /// <param name="winWidth"></param>
  325. /// <param name="buffHeight"></param>
  326. /// <param name="buffWidth"></param>
  327. /// <returns></returns>
  328. private bool EnqueueWindowSizeEvent (int winHeight, int winWidth, int buffHeight, int buffWidth)
  329. {
  330. if (winWidth == _consoleDriver.Cols && winHeight == _consoleDriver.Rows)
  331. {
  332. return false;
  333. }
  334. int w = Math.Max (winWidth, 0);
  335. int h = Math.Max (winHeight, 0);
  336. _inputQueue.Enqueue (
  337. new InputResult
  338. {
  339. EventType = EventType.WindowSize, WindowSizeEvent = new WindowSizeEvent { Size = new (w, h) }
  340. }
  341. );
  342. return true;
  343. }
  344. // Process a CSI sequence received by the driver (key pressed, mouse event, or request/response event)
  345. private void ProcessRequestResponse (
  346. ref ConsoleKeyInfo newConsoleKeyInfo,
  347. ref ConsoleKey key,
  348. ConsoleKeyInfo [] cki,
  349. ref ConsoleModifiers mod
  350. )
  351. {
  352. // isMouse is true if it's CSI<, false otherwise
  353. EscSeqUtils.DecodeEscSeq (
  354. EscSeqRequests,
  355. ref newConsoleKeyInfo,
  356. ref key,
  357. cki,
  358. ref mod,
  359. out string c1Control,
  360. out string code,
  361. out string [] values,
  362. out string terminating,
  363. out bool isMouse,
  364. out List<MouseFlags> mouseFlags,
  365. out Point pos,
  366. out bool isReq,
  367. (f, p) => HandleMouseEvent (MapMouseFlags (f), p)
  368. );
  369. if (isMouse)
  370. {
  371. foreach (MouseFlags mf in mouseFlags)
  372. {
  373. HandleMouseEvent (MapMouseFlags (mf), pos);
  374. }
  375. return;
  376. }
  377. if (isReq)
  378. {
  379. HandleRequestResponseEvent (c1Control, code, values, terminating);
  380. return;
  381. }
  382. HandleKeyboardEvent (newConsoleKeyInfo);
  383. }
  384. private MouseButtonState MapMouseFlags (MouseFlags mouseFlags)
  385. {
  386. MouseButtonState mbs = default;
  387. foreach (object flag in Enum.GetValues (mouseFlags.GetType ()))
  388. {
  389. if (mouseFlags.HasFlag ((MouseFlags)flag))
  390. {
  391. switch (flag)
  392. {
  393. case MouseFlags.Button1Pressed:
  394. mbs |= MouseButtonState.Button1Pressed;
  395. break;
  396. case MouseFlags.Button1Released:
  397. mbs |= MouseButtonState.Button1Released;
  398. break;
  399. case MouseFlags.Button1Clicked:
  400. mbs |= MouseButtonState.Button1Clicked;
  401. break;
  402. case MouseFlags.Button1DoubleClicked:
  403. mbs |= MouseButtonState.Button1DoubleClicked;
  404. break;
  405. case MouseFlags.Button1TripleClicked:
  406. mbs |= MouseButtonState.Button1TripleClicked;
  407. break;
  408. case MouseFlags.Button2Pressed:
  409. mbs |= MouseButtonState.Button2Pressed;
  410. break;
  411. case MouseFlags.Button2Released:
  412. mbs |= MouseButtonState.Button2Released;
  413. break;
  414. case MouseFlags.Button2Clicked:
  415. mbs |= MouseButtonState.Button2Clicked;
  416. break;
  417. case MouseFlags.Button2DoubleClicked:
  418. mbs |= MouseButtonState.Button2DoubleClicked;
  419. break;
  420. case MouseFlags.Button2TripleClicked:
  421. mbs |= MouseButtonState.Button2TripleClicked;
  422. break;
  423. case MouseFlags.Button3Pressed:
  424. mbs |= MouseButtonState.Button3Pressed;
  425. break;
  426. case MouseFlags.Button3Released:
  427. mbs |= MouseButtonState.Button3Released;
  428. break;
  429. case MouseFlags.Button3Clicked:
  430. mbs |= MouseButtonState.Button3Clicked;
  431. break;
  432. case MouseFlags.Button3DoubleClicked:
  433. mbs |= MouseButtonState.Button3DoubleClicked;
  434. break;
  435. case MouseFlags.Button3TripleClicked:
  436. mbs |= MouseButtonState.Button3TripleClicked;
  437. break;
  438. case MouseFlags.WheeledUp:
  439. mbs |= MouseButtonState.ButtonWheeledUp;
  440. break;
  441. case MouseFlags.WheeledDown:
  442. mbs |= MouseButtonState.ButtonWheeledDown;
  443. break;
  444. case MouseFlags.WheeledLeft:
  445. mbs |= MouseButtonState.ButtonWheeledLeft;
  446. break;
  447. case MouseFlags.WheeledRight:
  448. mbs |= MouseButtonState.ButtonWheeledRight;
  449. break;
  450. case MouseFlags.Button4Pressed:
  451. mbs |= MouseButtonState.Button4Pressed;
  452. break;
  453. case MouseFlags.Button4Released:
  454. mbs |= MouseButtonState.Button4Released;
  455. break;
  456. case MouseFlags.Button4Clicked:
  457. mbs |= MouseButtonState.Button4Clicked;
  458. break;
  459. case MouseFlags.Button4DoubleClicked:
  460. mbs |= MouseButtonState.Button4DoubleClicked;
  461. break;
  462. case MouseFlags.Button4TripleClicked:
  463. mbs |= MouseButtonState.Button4TripleClicked;
  464. break;
  465. case MouseFlags.ButtonShift:
  466. mbs |= MouseButtonState.ButtonShift;
  467. break;
  468. case MouseFlags.ButtonCtrl:
  469. mbs |= MouseButtonState.ButtonCtrl;
  470. break;
  471. case MouseFlags.ButtonAlt:
  472. mbs |= MouseButtonState.ButtonAlt;
  473. break;
  474. case MouseFlags.ReportMousePosition:
  475. mbs |= MouseButtonState.ReportMousePosition;
  476. break;
  477. case MouseFlags.AllEvents:
  478. mbs |= MouseButtonState.AllEvents;
  479. break;
  480. }
  481. }
  482. }
  483. return mbs;
  484. }
  485. private Point _lastCursorPosition;
  486. private void HandleRequestResponseEvent (string c1Control, string code, string [] values, string terminating)
  487. {
  488. switch (terminating)
  489. {
  490. // BUGBUG: I can't find where we send a request for cursor position (ESC[?6n), so I'm not sure if this is needed.
  491. case EscSeqUtils.CSI_RequestCursorPositionReport_Terminator:
  492. var point = new Point { X = int.Parse (values [1]) - 1, Y = int.Parse (values [0]) - 1 };
  493. if (_lastCursorPosition.Y != point.Y)
  494. {
  495. _lastCursorPosition = point;
  496. var eventType = EventType.WindowPosition;
  497. var winPositionEv = new WindowPositionEvent { CursorPosition = point };
  498. _inputQueue.Enqueue (
  499. new InputResult { EventType = eventType, WindowPositionEvent = winPositionEv }
  500. );
  501. }
  502. else
  503. {
  504. return;
  505. }
  506. break;
  507. case EscSeqUtils.CSI_ReportTerminalSizeInChars_Terminator:
  508. switch (values [0])
  509. {
  510. case EscSeqUtils.CSI_ReportTerminalSizeInChars_ResponseValue:
  511. EnqueueWindowSizeEvent (
  512. Math.Max (int.Parse (values [1]), 0),
  513. Math.Max (int.Parse (values [2]), 0),
  514. Math.Max (int.Parse (values [1]), 0),
  515. Math.Max (int.Parse (values [2]), 0)
  516. );
  517. break;
  518. default:
  519. EnqueueRequestResponseEvent (c1Control, code, values, terminating);
  520. break;
  521. }
  522. break;
  523. default:
  524. EnqueueRequestResponseEvent (c1Control, code, values, terminating);
  525. break;
  526. }
  527. _inputReady.Set ();
  528. }
  529. private void EnqueueRequestResponseEvent (string c1Control, string code, string [] values, string terminating)
  530. {
  531. var eventType = EventType.RequestResponse;
  532. var requestRespEv = new RequestResponseEvent { ResultTuple = (c1Control, code, values, terminating) };
  533. _inputQueue.Enqueue (
  534. new InputResult { EventType = eventType, RequestResponseEvent = requestRespEv }
  535. );
  536. }
  537. private void HandleMouseEvent (MouseButtonState buttonState, Point pos)
  538. {
  539. var mouseEvent = new MouseEvent { Position = pos, ButtonState = buttonState };
  540. _inputQueue.Enqueue (
  541. new InputResult { EventType = EventType.Mouse, MouseEvent = mouseEvent }
  542. );
  543. _inputReady.Set ();
  544. }
  545. public enum EventType
  546. {
  547. Key = 1,
  548. Mouse = 2,
  549. WindowSize = 3,
  550. WindowPosition = 4,
  551. RequestResponse = 5
  552. }
  553. [Flags]
  554. public enum MouseButtonState
  555. {
  556. Button1Pressed = 0x1,
  557. Button1Released = 0x2,
  558. Button1Clicked = 0x4,
  559. Button1DoubleClicked = 0x8,
  560. Button1TripleClicked = 0x10,
  561. Button2Pressed = 0x20,
  562. Button2Released = 0x40,
  563. Button2Clicked = 0x80,
  564. Button2DoubleClicked = 0x100,
  565. Button2TripleClicked = 0x200,
  566. Button3Pressed = 0x400,
  567. Button3Released = 0x800,
  568. Button3Clicked = 0x1000,
  569. Button3DoubleClicked = 0x2000,
  570. Button3TripleClicked = 0x4000,
  571. ButtonWheeledUp = 0x8000,
  572. ButtonWheeledDown = 0x10000,
  573. ButtonWheeledLeft = 0x20000,
  574. ButtonWheeledRight = 0x40000,
  575. Button4Pressed = 0x80000,
  576. Button4Released = 0x100000,
  577. Button4Clicked = 0x200000,
  578. Button4DoubleClicked = 0x400000,
  579. Button4TripleClicked = 0x800000,
  580. ButtonShift = 0x1000000,
  581. ButtonCtrl = 0x2000000,
  582. ButtonAlt = 0x4000000,
  583. ReportMousePosition = 0x8000000,
  584. AllEvents = -1
  585. }
  586. public struct MouseEvent
  587. {
  588. public Point Position;
  589. public MouseButtonState ButtonState;
  590. }
  591. public struct WindowSizeEvent
  592. {
  593. public Size Size;
  594. }
  595. public struct WindowPositionEvent
  596. {
  597. public int Top;
  598. public int Left;
  599. public Point CursorPosition;
  600. }
  601. public struct RequestResponseEvent
  602. {
  603. public (string c1Control, string code, string [] values, string terminating) ResultTuple;
  604. }
  605. public struct InputResult
  606. {
  607. public EventType EventType;
  608. public ConsoleKeyInfo ConsoleKeyInfo;
  609. public MouseEvent MouseEvent;
  610. public WindowSizeEvent WindowSizeEvent;
  611. public WindowPositionEvent WindowPositionEvent;
  612. public RequestResponseEvent RequestResponseEvent;
  613. public readonly override string ToString ()
  614. {
  615. return EventType switch
  616. {
  617. EventType.Key => ToString (ConsoleKeyInfo),
  618. EventType.Mouse => MouseEvent.ToString (),
  619. //EventType.WindowSize => WindowSize.ToString (),
  620. //EventType.RequestResponse => RequestResponse.ToString (),
  621. _ => "Unknown event type: " + EventType
  622. };
  623. }
  624. /// <summary>Prints a ConsoleKeyInfoEx structure</summary>
  625. /// <param name="cki"></param>
  626. /// <returns></returns>
  627. public readonly string ToString (ConsoleKeyInfo cki)
  628. {
  629. var ke = new Key ((KeyCode)cki.KeyChar);
  630. var sb = new StringBuilder ();
  631. sb.Append ($"Key: {(KeyCode)cki.Key} ({cki.Key})");
  632. sb.Append ((cki.Modifiers & ConsoleModifiers.Shift) != 0 ? " | Shift" : string.Empty);
  633. sb.Append ((cki.Modifiers & ConsoleModifiers.Control) != 0 ? " | Control" : string.Empty);
  634. sb.Append ((cki.Modifiers & ConsoleModifiers.Alt) != 0 ? " | Alt" : string.Empty);
  635. sb.Append ($", KeyChar: {ke.AsRune.MakePrintable ()} ({(uint)cki.KeyChar}) ");
  636. string s = sb.ToString ().TrimEnd (',').TrimEnd (' ');
  637. return $"[ConsoleKeyInfo({s})]";
  638. }
  639. }
  640. private void HandleKeyboardEvent (ConsoleKeyInfo cki)
  641. {
  642. var inputResult = new InputResult { EventType = EventType.Key, ConsoleKeyInfo = cki };
  643. _inputQueue.Enqueue (inputResult);
  644. }
  645. public void Dispose ()
  646. {
  647. _inputReadyCancellationTokenSource?.Cancel ();
  648. _inputReadyCancellationTokenSource?.Dispose ();
  649. _inputReadyCancellationTokenSource = null;
  650. try
  651. {
  652. // throws away any typeahead that has been typed by
  653. // the user and has not yet been read by the program.
  654. while (Console.KeyAvailable)
  655. {
  656. Console.ReadKey (true);
  657. }
  658. }
  659. catch (InvalidOperationException)
  660. {
  661. // Ignore - Console input has already been closed
  662. }
  663. }
  664. }
  665. internal class NetDriver : ConsoleDriver
  666. {
  667. private const int COLOR_BLACK = 30;
  668. private const int COLOR_BLUE = 34;
  669. private const int COLOR_BRIGHT_BLACK = 90;
  670. private const int COLOR_BRIGHT_BLUE = 94;
  671. private const int COLOR_BRIGHT_CYAN = 96;
  672. private const int COLOR_BRIGHT_GREEN = 92;
  673. private const int COLOR_BRIGHT_MAGENTA = 95;
  674. private const int COLOR_BRIGHT_RED = 91;
  675. private const int COLOR_BRIGHT_WHITE = 97;
  676. private const int COLOR_BRIGHT_YELLOW = 93;
  677. private const int COLOR_CYAN = 36;
  678. private const int COLOR_GREEN = 32;
  679. private const int COLOR_MAGENTA = 35;
  680. private const int COLOR_RED = 31;
  681. private const int COLOR_WHITE = 37;
  682. private const int COLOR_YELLOW = 33;
  683. private NetMainLoop _mainLoopDriver;
  684. public bool IsWinPlatform { get; private set; }
  685. public NetWinVTConsole NetWinConsole { get; private set; }
  686. public override bool SupportsTrueColor => Environment.OSVersion.Platform == PlatformID.Unix
  687. || (IsWinPlatform && Environment.OSVersion.Version.Build >= 14931);
  688. public override void Refresh ()
  689. {
  690. UpdateScreen ();
  691. UpdateCursor ();
  692. }
  693. public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
  694. {
  695. var input = new InputResult
  696. {
  697. EventType = EventType.Key, ConsoleKeyInfo = new ConsoleKeyInfo (keyChar, key, shift, alt, control)
  698. };
  699. try
  700. {
  701. ProcessInput (input);
  702. }
  703. catch (OverflowException)
  704. { }
  705. }
  706. public override void Suspend ()
  707. {
  708. if (Environment.OSVersion.Platform != PlatformID.Unix)
  709. {
  710. return;
  711. }
  712. StopReportingMouseMoves ();
  713. if (!RunningUnitTests)
  714. {
  715. Console.ResetColor ();
  716. Console.Clear ();
  717. Platform.Suspend ();
  718. Application.Refresh ();
  719. }
  720. StartReportingMouseMoves ();
  721. }
  722. public override void UpdateScreen ()
  723. {
  724. if (RunningUnitTests
  725. || _winSizeChanging
  726. || Console.WindowHeight < 1
  727. || Contents.Length != Rows * Cols
  728. || Rows != Console.WindowHeight)
  729. {
  730. return;
  731. }
  732. var top = 0;
  733. var left = 0;
  734. int rows = Rows;
  735. int cols = Cols;
  736. var output = new StringBuilder ();
  737. Attribute? redrawAttr = null;
  738. int lastCol = -1;
  739. CursorVisibility? savedVisibitity = _cachedCursorVisibility;
  740. SetCursorVisibility (CursorVisibility.Invisible);
  741. for (int row = top; row < rows; row++)
  742. {
  743. if (Console.WindowHeight < 1)
  744. {
  745. return;
  746. }
  747. if (!_dirtyLines [row])
  748. {
  749. continue;
  750. }
  751. if (!SetCursorPosition (0, row))
  752. {
  753. return;
  754. }
  755. _dirtyLines [row] = false;
  756. output.Clear ();
  757. for (int col = left; col < cols; col++)
  758. {
  759. lastCol = -1;
  760. var outputWidth = 0;
  761. for (; col < cols; col++)
  762. {
  763. if (!Contents [row, col].IsDirty)
  764. {
  765. if (output.Length > 0)
  766. {
  767. WriteToConsole (output, ref lastCol, row, ref outputWidth);
  768. }
  769. else if (lastCol == -1)
  770. {
  771. lastCol = col;
  772. }
  773. if (lastCol + 1 < cols)
  774. {
  775. lastCol++;
  776. }
  777. continue;
  778. }
  779. if (lastCol == -1)
  780. {
  781. lastCol = col;
  782. }
  783. Attribute attr = Contents [row, col].Attribute.Value;
  784. // Performance: Only send the escape sequence if the attribute has changed.
  785. if (attr != redrawAttr)
  786. {
  787. redrawAttr = attr;
  788. if (Force16Colors)
  789. {
  790. output.Append (
  791. EscSeqUtils.CSI_SetGraphicsRendition (
  792. MapColors (
  793. (ConsoleColor)attr.Background.GetClosestNamedColor (),
  794. false
  795. ),
  796. MapColors ((ConsoleColor)attr.Foreground.GetClosestNamedColor ())
  797. )
  798. );
  799. }
  800. else
  801. {
  802. output.Append (
  803. EscSeqUtils.CSI_SetForegroundColorRGB (
  804. attr.Foreground.R,
  805. attr.Foreground.G,
  806. attr.Foreground.B
  807. )
  808. );
  809. output.Append (
  810. EscSeqUtils.CSI_SetBackgroundColorRGB (
  811. attr.Background.R,
  812. attr.Background.G,
  813. attr.Background.B
  814. )
  815. );
  816. }
  817. }
  818. outputWidth++;
  819. Rune rune = Contents [row, col].Rune;
  820. output.Append (rune);
  821. if (Contents [row, col].CombiningMarks.Count > 0)
  822. {
  823. // AtlasEngine does not support NON-NORMALIZED combining marks in a way
  824. // compatible with the driver architecture. Any CMs (except in the first col)
  825. // are correctly combined with the base char, but are ALSO treated as 1 column
  826. // width codepoints E.g. `echo "[e`u{0301}`u{0301}]"` will output `[é ]`.
  827. //
  828. // For now, we just ignore the list of CMs.
  829. //foreach (var combMark in Contents [row, col].CombiningMarks) {
  830. // output.Append (combMark);
  831. //}
  832. // WriteToConsole (output, ref lastCol, row, ref outputWidth);
  833. }
  834. else if (rune.IsSurrogatePair () && rune.GetColumns () < 2)
  835. {
  836. WriteToConsole (output, ref lastCol, row, ref outputWidth);
  837. SetCursorPosition (col - 1, row);
  838. }
  839. Contents [row, col].IsDirty = false;
  840. }
  841. }
  842. if (output.Length > 0)
  843. {
  844. SetCursorPosition (lastCol, row);
  845. Console.Write (output);
  846. }
  847. }
  848. SetCursorPosition (0, 0);
  849. _cachedCursorVisibility = savedVisibitity;
  850. void WriteToConsole (StringBuilder output, ref int lastCol, int row, ref int outputWidth)
  851. {
  852. SetCursorPosition (lastCol, row);
  853. Console.Write (output);
  854. output.Clear ();
  855. lastCol += outputWidth;
  856. outputWidth = 0;
  857. }
  858. }
  859. internal override void End ()
  860. {
  861. if (IsWinPlatform)
  862. {
  863. NetWinConsole?.Cleanup ();
  864. }
  865. StopReportingMouseMoves ();
  866. if (!RunningUnitTests)
  867. {
  868. Console.ResetColor ();
  869. //Disable alternative screen buffer.
  870. Console.Out.Write (EscSeqUtils.CSI_RestoreCursorAndRestoreAltBufferWithBackscroll);
  871. //Set cursor key to cursor.
  872. Console.Out.Write (EscSeqUtils.CSI_ShowCursor);
  873. Console.Out.Close ();
  874. }
  875. }
  876. internal override MainLoop Init ()
  877. {
  878. PlatformID p = Environment.OSVersion.Platform;
  879. if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows)
  880. {
  881. IsWinPlatform = true;
  882. try
  883. {
  884. NetWinConsole = new NetWinVTConsole ();
  885. }
  886. catch (ApplicationException)
  887. {
  888. // Likely running as a unit test, or in a non-interactive session.
  889. }
  890. }
  891. if (IsWinPlatform)
  892. {
  893. Clipboard = new WindowsClipboard ();
  894. }
  895. else if (RuntimeInformation.IsOSPlatform (OSPlatform.OSX))
  896. {
  897. Clipboard = new MacOSXClipboard ();
  898. }
  899. else
  900. {
  901. if (CursesDriver.Is_WSL_Platform ())
  902. {
  903. Clipboard = new WSLClipboard ();
  904. }
  905. else
  906. {
  907. Clipboard = new CursesClipboard ();
  908. }
  909. }
  910. if (!RunningUnitTests)
  911. {
  912. Console.TreatControlCAsInput = true;
  913. Cols = Console.WindowWidth;
  914. Rows = Console.WindowHeight;
  915. //Enable alternative screen buffer.
  916. Console.Out.Write (EscSeqUtils.CSI_SaveCursorAndActivateAltBufferNoBackscroll);
  917. //Set cursor key to application.
  918. Console.Out.Write (EscSeqUtils.CSI_HideCursor);
  919. }
  920. else
  921. {
  922. // We are being run in an environment that does not support a console
  923. // such as a unit test, or a pipe.
  924. Cols = 80;
  925. Rows = 24;
  926. }
  927. ResizeScreen ();
  928. ClearContents ();
  929. CurrentAttribute = new Attribute (Color.White, Color.Black);
  930. StartReportingMouseMoves ();
  931. _mainLoopDriver = new NetMainLoop (this);
  932. _mainLoopDriver.ProcessInput = ProcessInput;
  933. return new MainLoop (_mainLoopDriver);
  934. }
  935. private void ProcessInput (InputResult inputEvent)
  936. {
  937. switch (inputEvent.EventType)
  938. {
  939. case EventType.Key:
  940. ConsoleKeyInfo consoleKeyInfo = inputEvent.ConsoleKeyInfo;
  941. //if (consoleKeyInfo.Key == ConsoleKey.Packet) {
  942. // consoleKeyInfo = FromVKPacketToKConsoleKeyInfo (consoleKeyInfo);
  943. //}
  944. //Debug.WriteLine ($"event: {inputEvent}");
  945. KeyCode map = MapKey (consoleKeyInfo);
  946. if (map == KeyCode.Null)
  947. {
  948. break;
  949. }
  950. OnKeyDown (new Key (map));
  951. OnKeyUp (new Key (map));
  952. break;
  953. case EventType.Mouse:
  954. MouseEvent me = ToDriverMouse (inputEvent.MouseEvent);
  955. //Debug.WriteLine ($"NetDriver: ({me.X},{me.Y}) - {me.Flags}");
  956. OnMouseEvent (me);
  957. break;
  958. case EventType.WindowSize:
  959. _winSizeChanging = true;
  960. Top = 0;
  961. Left = 0;
  962. Cols = inputEvent.WindowSizeEvent.Size.Width;
  963. Rows = Math.Max (inputEvent.WindowSizeEvent.Size.Height, 0);
  964. ;
  965. ResizeScreen ();
  966. ClearContents ();
  967. _winSizeChanging = false;
  968. OnSizeChanged (new SizeChangedEventArgs (new (Cols, Rows)));
  969. break;
  970. case EventType.RequestResponse:
  971. break;
  972. case EventType.WindowPosition:
  973. break;
  974. default:
  975. throw new ArgumentOutOfRangeException ();
  976. }
  977. }
  978. #region Size and Position Handling
  979. private volatile bool _winSizeChanging;
  980. private void SetWindowPosition (int col, int row)
  981. {
  982. if (!RunningUnitTests)
  983. {
  984. Top = Console.WindowTop;
  985. Left = Console.WindowLeft;
  986. }
  987. else
  988. {
  989. Top = row;
  990. Left = col;
  991. }
  992. }
  993. public virtual void ResizeScreen ()
  994. {
  995. // Not supported on Unix.
  996. if (IsWinPlatform)
  997. {
  998. // Can raise an exception while is still resizing.
  999. try
  1000. {
  1001. #pragma warning disable CA1416
  1002. if (Console.WindowHeight > 0)
  1003. {
  1004. Console.CursorTop = 0;
  1005. Console.CursorLeft = 0;
  1006. Console.WindowTop = 0;
  1007. Console.WindowLeft = 0;
  1008. if (Console.WindowHeight > Rows)
  1009. {
  1010. Console.SetWindowSize (Cols, Rows);
  1011. }
  1012. Console.SetBufferSize (Cols, Rows);
  1013. }
  1014. #pragma warning restore CA1416
  1015. }
  1016. // INTENT: Why are these eating the exceptions?
  1017. // Comments would be good here.
  1018. catch (IOException)
  1019. {
  1020. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1021. Clip = new (0, 0, Cols, Rows);
  1022. }
  1023. catch (ArgumentOutOfRangeException)
  1024. {
  1025. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1026. Clip = new (0, 0, Cols, Rows);
  1027. }
  1028. }
  1029. else
  1030. {
  1031. Console.Out.Write (EscSeqUtils.CSI_SetTerminalWindowSize (Rows, Cols));
  1032. }
  1033. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1034. Clip = new (0, 0, Cols, Rows);
  1035. }
  1036. #endregion
  1037. #region Color Handling
  1038. // Cache the list of ConsoleColor values.
  1039. private static readonly HashSet<int> ConsoleColorValues = new (
  1040. Enum.GetValues (typeof (ConsoleColor))
  1041. .OfType<ConsoleColor> ()
  1042. .Select (c => (int)c)
  1043. );
  1044. // Dictionary for mapping ConsoleColor values to the values used by System.Net.Console.
  1045. private static readonly Dictionary<ConsoleColor, int> colorMap = new ()
  1046. {
  1047. { ConsoleColor.Black, COLOR_BLACK },
  1048. { ConsoleColor.DarkBlue, COLOR_BLUE },
  1049. { ConsoleColor.DarkGreen, COLOR_GREEN },
  1050. { ConsoleColor.DarkCyan, COLOR_CYAN },
  1051. { ConsoleColor.DarkRed, COLOR_RED },
  1052. { ConsoleColor.DarkMagenta, COLOR_MAGENTA },
  1053. { ConsoleColor.DarkYellow, COLOR_YELLOW },
  1054. { ConsoleColor.Gray, COLOR_WHITE },
  1055. { ConsoleColor.DarkGray, COLOR_BRIGHT_BLACK },
  1056. { ConsoleColor.Blue, COLOR_BRIGHT_BLUE },
  1057. { ConsoleColor.Green, COLOR_BRIGHT_GREEN },
  1058. { ConsoleColor.Cyan, COLOR_BRIGHT_CYAN },
  1059. { ConsoleColor.Red, COLOR_BRIGHT_RED },
  1060. { ConsoleColor.Magenta, COLOR_BRIGHT_MAGENTA },
  1061. { ConsoleColor.Yellow, COLOR_BRIGHT_YELLOW },
  1062. { ConsoleColor.White, COLOR_BRIGHT_WHITE }
  1063. };
  1064. // Map a ConsoleColor to a platform dependent value.
  1065. private int MapColors (ConsoleColor color, bool isForeground = true)
  1066. {
  1067. return colorMap.TryGetValue (color, out int colorValue) ? colorValue + (isForeground ? 0 : 10) : 0;
  1068. }
  1069. ///// <remarks>
  1070. ///// In the NetDriver, colors are encoded as an int.
  1071. ///// However, the foreground color is stored in the most significant 16 bits,
  1072. ///// and the background color is stored in the least significant 16 bits.
  1073. ///// </remarks>
  1074. //public override Attribute MakeColor (Color foreground, Color background)
  1075. //{
  1076. // // Encode the colors into the int value.
  1077. // return new Attribute (
  1078. // platformColor: ((((int)foreground.ColorName) & 0xffff) << 16) | (((int)background.ColorName) & 0xffff),
  1079. // foreground: foreground,
  1080. // background: background
  1081. // );
  1082. //}
  1083. #endregion
  1084. #region Cursor Handling
  1085. private bool SetCursorPosition (int col, int row)
  1086. {
  1087. if (IsWinPlatform)
  1088. {
  1089. // Could happens that the windows is still resizing and the col is bigger than Console.WindowWidth.
  1090. try
  1091. {
  1092. Console.SetCursorPosition (col, row);
  1093. return true;
  1094. }
  1095. catch (Exception)
  1096. {
  1097. return false;
  1098. }
  1099. }
  1100. // + 1 is needed because non-Windows is based on 1 instead of 0 and
  1101. // Console.CursorTop/CursorLeft isn't reliable.
  1102. Console.Out.Write (EscSeqUtils.CSI_SetCursorPosition (row + 1, col + 1));
  1103. return true;
  1104. }
  1105. private CursorVisibility? _cachedCursorVisibility;
  1106. public override void UpdateCursor ()
  1107. {
  1108. EnsureCursorVisibility ();
  1109. if (Col >= 0 && Col < Cols && Row >= 0 && Row <= Rows)
  1110. {
  1111. SetCursorPosition (Col, Row);
  1112. SetWindowPosition (0, Row);
  1113. }
  1114. }
  1115. public override bool GetCursorVisibility (out CursorVisibility visibility)
  1116. {
  1117. visibility = _cachedCursorVisibility ?? CursorVisibility.Default;
  1118. return visibility == CursorVisibility.Default;
  1119. }
  1120. public override bool SetCursorVisibility (CursorVisibility visibility)
  1121. {
  1122. _cachedCursorVisibility = visibility;
  1123. bool isVisible = RunningUnitTests
  1124. ? visibility == CursorVisibility.Default
  1125. : Console.CursorVisible = visibility == CursorVisibility.Default;
  1126. Console.Out.Write (isVisible ? EscSeqUtils.CSI_ShowCursor : EscSeqUtils.CSI_HideCursor);
  1127. return isVisible;
  1128. }
  1129. public override bool EnsureCursorVisibility ()
  1130. {
  1131. if (!(Col >= 0 && Row >= 0 && Col < Cols && Row < Rows))
  1132. {
  1133. GetCursorVisibility (out CursorVisibility cursorVisibility);
  1134. _cachedCursorVisibility = cursorVisibility;
  1135. SetCursorVisibility (CursorVisibility.Invisible);
  1136. return false;
  1137. }
  1138. SetCursorVisibility (_cachedCursorVisibility ?? CursorVisibility.Default);
  1139. return _cachedCursorVisibility == CursorVisibility.Default;
  1140. }
  1141. #endregion
  1142. #region Mouse Handling
  1143. public void StartReportingMouseMoves ()
  1144. {
  1145. if (!RunningUnitTests)
  1146. {
  1147. Console.Out.Write (EscSeqUtils.CSI_EnableMouseEvents);
  1148. }
  1149. }
  1150. public void StopReportingMouseMoves ()
  1151. {
  1152. if (!RunningUnitTests)
  1153. {
  1154. Console.Out.Write (EscSeqUtils.CSI_DisableMouseEvents);
  1155. }
  1156. }
  1157. private MouseEvent ToDriverMouse (NetEvents.MouseEvent me)
  1158. {
  1159. //System.Diagnostics.Debug.WriteLine ($"X: {me.Position.X}; Y: {me.Position.Y}; ButtonState: {me.ButtonState}");
  1160. MouseFlags mouseFlag = 0;
  1161. if ((me.ButtonState & MouseButtonState.Button1Pressed) != 0)
  1162. {
  1163. mouseFlag |= MouseFlags.Button1Pressed;
  1164. }
  1165. if ((me.ButtonState & MouseButtonState.Button1Released) != 0)
  1166. {
  1167. mouseFlag |= MouseFlags.Button1Released;
  1168. }
  1169. if ((me.ButtonState & MouseButtonState.Button1Clicked) != 0)
  1170. {
  1171. mouseFlag |= MouseFlags.Button1Clicked;
  1172. }
  1173. if ((me.ButtonState & MouseButtonState.Button1DoubleClicked) != 0)
  1174. {
  1175. mouseFlag |= MouseFlags.Button1DoubleClicked;
  1176. }
  1177. if ((me.ButtonState & MouseButtonState.Button1TripleClicked) != 0)
  1178. {
  1179. mouseFlag |= MouseFlags.Button1TripleClicked;
  1180. }
  1181. if ((me.ButtonState & MouseButtonState.Button2Pressed) != 0)
  1182. {
  1183. mouseFlag |= MouseFlags.Button2Pressed;
  1184. }
  1185. if ((me.ButtonState & MouseButtonState.Button2Released) != 0)
  1186. {
  1187. mouseFlag |= MouseFlags.Button2Released;
  1188. }
  1189. if ((me.ButtonState & MouseButtonState.Button2Clicked) != 0)
  1190. {
  1191. mouseFlag |= MouseFlags.Button2Clicked;
  1192. }
  1193. if ((me.ButtonState & MouseButtonState.Button2DoubleClicked) != 0)
  1194. {
  1195. mouseFlag |= MouseFlags.Button2DoubleClicked;
  1196. }
  1197. if ((me.ButtonState & MouseButtonState.Button2TripleClicked) != 0)
  1198. {
  1199. mouseFlag |= MouseFlags.Button2TripleClicked;
  1200. }
  1201. if ((me.ButtonState & MouseButtonState.Button3Pressed) != 0)
  1202. {
  1203. mouseFlag |= MouseFlags.Button3Pressed;
  1204. }
  1205. if ((me.ButtonState & MouseButtonState.Button3Released) != 0)
  1206. {
  1207. mouseFlag |= MouseFlags.Button3Released;
  1208. }
  1209. if ((me.ButtonState & MouseButtonState.Button3Clicked) != 0)
  1210. {
  1211. mouseFlag |= MouseFlags.Button3Clicked;
  1212. }
  1213. if ((me.ButtonState & MouseButtonState.Button3DoubleClicked) != 0)
  1214. {
  1215. mouseFlag |= MouseFlags.Button3DoubleClicked;
  1216. }
  1217. if ((me.ButtonState & MouseButtonState.Button3TripleClicked) != 0)
  1218. {
  1219. mouseFlag |= MouseFlags.Button3TripleClicked;
  1220. }
  1221. if ((me.ButtonState & MouseButtonState.ButtonWheeledUp) != 0)
  1222. {
  1223. mouseFlag |= MouseFlags.WheeledUp;
  1224. }
  1225. if ((me.ButtonState & MouseButtonState.ButtonWheeledDown) != 0)
  1226. {
  1227. mouseFlag |= MouseFlags.WheeledDown;
  1228. }
  1229. if ((me.ButtonState & MouseButtonState.ButtonWheeledLeft) != 0)
  1230. {
  1231. mouseFlag |= MouseFlags.WheeledLeft;
  1232. }
  1233. if ((me.ButtonState & MouseButtonState.ButtonWheeledRight) != 0)
  1234. {
  1235. mouseFlag |= MouseFlags.WheeledRight;
  1236. }
  1237. if ((me.ButtonState & MouseButtonState.Button4Pressed) != 0)
  1238. {
  1239. mouseFlag |= MouseFlags.Button4Pressed;
  1240. }
  1241. if ((me.ButtonState & MouseButtonState.Button4Released) != 0)
  1242. {
  1243. mouseFlag |= MouseFlags.Button4Released;
  1244. }
  1245. if ((me.ButtonState & MouseButtonState.Button4Clicked) != 0)
  1246. {
  1247. mouseFlag |= MouseFlags.Button4Clicked;
  1248. }
  1249. if ((me.ButtonState & MouseButtonState.Button4DoubleClicked) != 0)
  1250. {
  1251. mouseFlag |= MouseFlags.Button4DoubleClicked;
  1252. }
  1253. if ((me.ButtonState & MouseButtonState.Button4TripleClicked) != 0)
  1254. {
  1255. mouseFlag |= MouseFlags.Button4TripleClicked;
  1256. }
  1257. if ((me.ButtonState & MouseButtonState.ReportMousePosition) != 0)
  1258. {
  1259. mouseFlag |= MouseFlags.ReportMousePosition;
  1260. }
  1261. if ((me.ButtonState & MouseButtonState.ButtonShift) != 0)
  1262. {
  1263. mouseFlag |= MouseFlags.ButtonShift;
  1264. }
  1265. if ((me.ButtonState & MouseButtonState.ButtonCtrl) != 0)
  1266. {
  1267. mouseFlag |= MouseFlags.ButtonCtrl;
  1268. }
  1269. if ((me.ButtonState & MouseButtonState.ButtonAlt) != 0)
  1270. {
  1271. mouseFlag |= MouseFlags.ButtonAlt;
  1272. }
  1273. return new MouseEvent { Position = me.Position, Flags = mouseFlag };
  1274. }
  1275. #endregion Mouse Handling
  1276. #region Keyboard Handling
  1277. private ConsoleKeyInfo FromVKPacketToKConsoleKeyInfo (ConsoleKeyInfo consoleKeyInfo)
  1278. {
  1279. if (consoleKeyInfo.Key != ConsoleKey.Packet)
  1280. {
  1281. return consoleKeyInfo;
  1282. }
  1283. ConsoleModifiers mod = consoleKeyInfo.Modifiers;
  1284. bool shift = (mod & ConsoleModifiers.Shift) != 0;
  1285. bool alt = (mod & ConsoleModifiers.Alt) != 0;
  1286. bool control = (mod & ConsoleModifiers.Control) != 0;
  1287. ConsoleKeyInfo cKeyInfo = DecodeVKPacketToKConsoleKeyInfo (consoleKeyInfo);
  1288. return new ConsoleKeyInfo (cKeyInfo.KeyChar, cKeyInfo.Key, shift, alt, control);
  1289. }
  1290. private KeyCode MapKey (ConsoleKeyInfo keyInfo)
  1291. {
  1292. switch (keyInfo.Key)
  1293. {
  1294. case ConsoleKey.OemPeriod:
  1295. case ConsoleKey.OemComma:
  1296. case ConsoleKey.OemPlus:
  1297. case ConsoleKey.OemMinus:
  1298. case ConsoleKey.Packet:
  1299. case ConsoleKey.Oem1:
  1300. case ConsoleKey.Oem2:
  1301. case ConsoleKey.Oem3:
  1302. case ConsoleKey.Oem4:
  1303. case ConsoleKey.Oem5:
  1304. case ConsoleKey.Oem6:
  1305. case ConsoleKey.Oem7:
  1306. case ConsoleKey.Oem8:
  1307. case ConsoleKey.Oem102:
  1308. if (keyInfo.KeyChar == 0)
  1309. {
  1310. // If the keyChar is 0, keyInfo.Key value is not a printable character.
  1311. return KeyCode.Null; // MapToKeyCodeModifiers (keyInfo.Modifiers, KeyCode)keyInfo.Key);
  1312. }
  1313. if (keyInfo.Modifiers != ConsoleModifiers.Shift)
  1314. {
  1315. // If Shift wasn't down we don't need to do anything but return the keyInfo.KeyChar
  1316. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)keyInfo.KeyChar);
  1317. }
  1318. // Strip off Shift - We got here because they KeyChar from Windows is the shifted char (e.g. "Ç")
  1319. // and passing on Shift would be redundant.
  1320. return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.KeyChar);
  1321. }
  1322. // Handle control keys whose VK codes match the related ASCII value (those below ASCII 33) like ESC
  1323. if (keyInfo.Key != ConsoleKey.None && Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key))
  1324. {
  1325. if (keyInfo.Modifiers.HasFlag(ConsoleModifiers.Control) && keyInfo.Key == ConsoleKey.I)
  1326. {
  1327. return KeyCode.Tab;
  1328. }
  1329. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.Key));
  1330. }
  1331. // Handle control keys (e.g. CursorUp)
  1332. if (keyInfo.Key != ConsoleKey.None
  1333. && Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint))
  1334. {
  1335. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint));
  1336. }
  1337. if (((ConsoleKey)keyInfo.KeyChar) is >= ConsoleKey.A and <= ConsoleKey.Z)
  1338. {
  1339. // Shifted
  1340. keyInfo = new ConsoleKeyInfo (
  1341. keyInfo.KeyChar,
  1342. (ConsoleKey)keyInfo.KeyChar,
  1343. true,
  1344. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt),
  1345. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control));
  1346. }
  1347. if ((ConsoleKey)keyInfo.KeyChar - 32 is >= ConsoleKey.A and <= ConsoleKey.Z)
  1348. {
  1349. // Unshifted
  1350. keyInfo = new ConsoleKeyInfo (
  1351. keyInfo.KeyChar,
  1352. (ConsoleKey)(keyInfo.KeyChar - 32),
  1353. false,
  1354. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt),
  1355. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control));
  1356. }
  1357. if (keyInfo.Key is >= ConsoleKey.A and <= ConsoleKey.Z )
  1358. {
  1359. if (keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt)
  1360. || keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control))
  1361. {
  1362. // NetDriver doesn't support Shift-Ctrl/Shift-Alt combos
  1363. return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.Key);
  1364. }
  1365. if (keyInfo.Modifiers == ConsoleModifiers.Shift)
  1366. {
  1367. // If ShiftMask is on add the ShiftMask
  1368. if (char.IsUpper (keyInfo.KeyChar))
  1369. {
  1370. return (KeyCode)keyInfo.Key | KeyCode.ShiftMask;
  1371. }
  1372. }
  1373. return (KeyCode)keyInfo.Key;
  1374. }
  1375. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.KeyChar));
  1376. }
  1377. #endregion Keyboard Handling
  1378. }
  1379. /// <summary>
  1380. /// Mainloop intended to be used with the .NET System.Console API, and can be used on Windows and Unix, it is
  1381. /// cross platform but lacks things like file descriptor monitoring.
  1382. /// </summary>
  1383. /// <remarks>This implementation is used for NetDriver.</remarks>
  1384. internal class NetMainLoop : IMainLoopDriver
  1385. {
  1386. internal NetEvents _netEvents;
  1387. /// <summary>Invoked when a Key is pressed.</summary>
  1388. internal Action<InputResult> ProcessInput;
  1389. private readonly ManualResetEventSlim _eventReady = new (false);
  1390. private readonly CancellationTokenSource _inputHandlerTokenSource = new ();
  1391. private readonly Queue<InputResult?> _resultQueue = new ();
  1392. private readonly ManualResetEventSlim _waitForProbe = new (false);
  1393. private CancellationTokenSource _eventReadyTokenSource = new ();
  1394. private MainLoop _mainLoop;
  1395. /// <summary>Initializes the class with the console driver.</summary>
  1396. /// <remarks>Passing a consoleDriver is provided to capture windows resizing.</remarks>
  1397. /// <param name="consoleDriver">The console driver used by this Net main loop.</param>
  1398. /// <exception cref="ArgumentNullException"></exception>
  1399. public NetMainLoop (ConsoleDriver consoleDriver = null)
  1400. {
  1401. if (consoleDriver is null)
  1402. {
  1403. throw new ArgumentNullException (nameof (consoleDriver));
  1404. }
  1405. _netEvents = new NetEvents (consoleDriver);
  1406. }
  1407. void IMainLoopDriver.Setup (MainLoop mainLoop)
  1408. {
  1409. _mainLoop = mainLoop;
  1410. Task.Run (NetInputHandler, _inputHandlerTokenSource.Token);
  1411. }
  1412. void IMainLoopDriver.Wakeup () { _eventReady.Set (); }
  1413. bool IMainLoopDriver.EventsPending ()
  1414. {
  1415. _waitForProbe.Set ();
  1416. if (_mainLoop.CheckTimersAndIdleHandlers (out int waitTimeout))
  1417. {
  1418. return true;
  1419. }
  1420. try
  1421. {
  1422. if (!_eventReadyTokenSource.IsCancellationRequested)
  1423. {
  1424. // Note: ManualResetEventSlim.Wait will wait indefinitely if the timeout is -1. The timeout is -1 when there
  1425. // are no timers, but there IS an idle handler waiting.
  1426. _eventReady.Wait (waitTimeout, _eventReadyTokenSource.Token);
  1427. }
  1428. }
  1429. catch (OperationCanceledException)
  1430. {
  1431. return true;
  1432. }
  1433. finally
  1434. {
  1435. _eventReady.Reset ();
  1436. }
  1437. if (!_eventReadyTokenSource.IsCancellationRequested)
  1438. {
  1439. return _resultQueue.Count > 0 || _mainLoop.CheckTimersAndIdleHandlers (out _);
  1440. }
  1441. _eventReadyTokenSource.Dispose ();
  1442. _eventReadyTokenSource = new CancellationTokenSource ();
  1443. return true;
  1444. }
  1445. void IMainLoopDriver.Iteration ()
  1446. {
  1447. while (_resultQueue.Count > 0)
  1448. {
  1449. ProcessInput?.Invoke (_resultQueue.Dequeue ().Value);
  1450. }
  1451. }
  1452. void IMainLoopDriver.TearDown ()
  1453. {
  1454. _inputHandlerTokenSource?.Cancel ();
  1455. _inputHandlerTokenSource?.Dispose ();
  1456. _eventReadyTokenSource?.Cancel ();
  1457. _eventReadyTokenSource?.Dispose ();
  1458. _eventReady?.Dispose ();
  1459. _resultQueue?.Clear ();
  1460. _waitForProbe?.Dispose ();
  1461. _netEvents?.Dispose ();
  1462. _netEvents = null;
  1463. _mainLoop = null;
  1464. }
  1465. private void NetInputHandler ()
  1466. {
  1467. while (_mainLoop is { })
  1468. {
  1469. try
  1470. {
  1471. if (!_inputHandlerTokenSource.IsCancellationRequested)
  1472. {
  1473. _waitForProbe.Wait (_inputHandlerTokenSource.Token);
  1474. }
  1475. }
  1476. catch (OperationCanceledException)
  1477. {
  1478. return;
  1479. }
  1480. finally
  1481. {
  1482. if (_waitForProbe.IsSet)
  1483. {
  1484. _waitForProbe.Reset ();
  1485. }
  1486. }
  1487. if (_inputHandlerTokenSource.IsCancellationRequested)
  1488. {
  1489. return;
  1490. }
  1491. if (_resultQueue.Count == 0)
  1492. {
  1493. _resultQueue.Enqueue (_netEvents.DequeueInput ());
  1494. }
  1495. try
  1496. {
  1497. while (_resultQueue.Peek () is null)
  1498. {
  1499. _resultQueue.Dequeue ();
  1500. }
  1501. if (_resultQueue.Count > 0)
  1502. {
  1503. _eventReady.Set ();
  1504. }
  1505. }
  1506. catch (InvalidOperationException)
  1507. {
  1508. // Ignore
  1509. }
  1510. }
  1511. }
  1512. }