NetDriver.cs 60 KB

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