2
0

NetDriver.cs 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839
  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. case EscSeqUtils.CSI_ReportDeviceAttributes_Terminator:
  519. ConsoleDriver.SupportsSixel = values.Any (v => v == "4");
  520. break;
  521. default:
  522. EnqueueRequestResponseEvent (c1Control, code, values, terminating);
  523. break;
  524. }
  525. _inputReady.Set ();
  526. }
  527. private void EnqueueRequestResponseEvent (string c1Control, string code, string [] values, string terminating)
  528. {
  529. var eventType = EventType.RequestResponse;
  530. var requestRespEv = new RequestResponseEvent { ResultTuple = (c1Control, code, values, terminating) };
  531. _inputQueue.Enqueue (
  532. new InputResult { EventType = eventType, RequestResponseEvent = requestRespEv }
  533. );
  534. }
  535. private void HandleMouseEvent (MouseButtonState buttonState, Point pos)
  536. {
  537. var mouseEvent = new MouseEvent { Position = pos, ButtonState = buttonState };
  538. _inputQueue.Enqueue (
  539. new InputResult { EventType = EventType.Mouse, MouseEvent = mouseEvent }
  540. );
  541. _inputReady.Set ();
  542. }
  543. public enum EventType
  544. {
  545. Key = 1,
  546. Mouse = 2,
  547. WindowSize = 3,
  548. WindowPosition = 4,
  549. RequestResponse = 5
  550. }
  551. [Flags]
  552. public enum MouseButtonState
  553. {
  554. Button1Pressed = 0x1,
  555. Button1Released = 0x2,
  556. Button1Clicked = 0x4,
  557. Button1DoubleClicked = 0x8,
  558. Button1TripleClicked = 0x10,
  559. Button2Pressed = 0x20,
  560. Button2Released = 0x40,
  561. Button2Clicked = 0x80,
  562. Button2DoubleClicked = 0x100,
  563. Button2TripleClicked = 0x200,
  564. Button3Pressed = 0x400,
  565. Button3Released = 0x800,
  566. Button3Clicked = 0x1000,
  567. Button3DoubleClicked = 0x2000,
  568. Button3TripleClicked = 0x4000,
  569. ButtonWheeledUp = 0x8000,
  570. ButtonWheeledDown = 0x10000,
  571. ButtonWheeledLeft = 0x20000,
  572. ButtonWheeledRight = 0x40000,
  573. Button4Pressed = 0x80000,
  574. Button4Released = 0x100000,
  575. Button4Clicked = 0x200000,
  576. Button4DoubleClicked = 0x400000,
  577. Button4TripleClicked = 0x800000,
  578. ButtonShift = 0x1000000,
  579. ButtonCtrl = 0x2000000,
  580. ButtonAlt = 0x4000000,
  581. ReportMousePosition = 0x8000000,
  582. AllEvents = -1
  583. }
  584. public struct MouseEvent
  585. {
  586. public Point Position;
  587. public MouseButtonState ButtonState;
  588. }
  589. public struct WindowSizeEvent
  590. {
  591. public Size Size;
  592. }
  593. public struct WindowPositionEvent
  594. {
  595. public int Top;
  596. public int Left;
  597. public Point CursorPosition;
  598. }
  599. public struct RequestResponseEvent
  600. {
  601. public (string c1Control, string code, string [] values, string terminating) ResultTuple;
  602. }
  603. public struct InputResult
  604. {
  605. public EventType EventType;
  606. public ConsoleKeyInfo ConsoleKeyInfo;
  607. public MouseEvent MouseEvent;
  608. public WindowSizeEvent WindowSizeEvent;
  609. public WindowPositionEvent WindowPositionEvent;
  610. public RequestResponseEvent RequestResponseEvent;
  611. public readonly override string ToString ()
  612. {
  613. return EventType switch
  614. {
  615. EventType.Key => ToString (ConsoleKeyInfo),
  616. EventType.Mouse => MouseEvent.ToString (),
  617. //EventType.WindowSize => WindowSize.ToString (),
  618. //EventType.RequestResponse => RequestResponse.ToString (),
  619. _ => "Unknown event type: " + EventType
  620. };
  621. }
  622. /// <summary>Prints a ConsoleKeyInfoEx structure</summary>
  623. /// <param name="cki"></param>
  624. /// <returns></returns>
  625. public readonly string ToString (ConsoleKeyInfo cki)
  626. {
  627. var ke = new Key ((KeyCode)cki.KeyChar);
  628. var sb = new StringBuilder ();
  629. sb.Append ($"Key: {(KeyCode)cki.Key} ({cki.Key})");
  630. sb.Append ((cki.Modifiers & ConsoleModifiers.Shift) != 0 ? " | Shift" : string.Empty);
  631. sb.Append ((cki.Modifiers & ConsoleModifiers.Control) != 0 ? " | Control" : string.Empty);
  632. sb.Append ((cki.Modifiers & ConsoleModifiers.Alt) != 0 ? " | Alt" : string.Empty);
  633. sb.Append ($", KeyChar: {ke.AsRune.MakePrintable ()} ({(uint)cki.KeyChar}) ");
  634. string s = sb.ToString ().TrimEnd (',').TrimEnd (' ');
  635. return $"[ConsoleKeyInfo({s})]";
  636. }
  637. }
  638. private void HandleKeyboardEvent (ConsoleKeyInfo cki)
  639. {
  640. var inputResult = new InputResult { EventType = EventType.Key, ConsoleKeyInfo = cki };
  641. _inputQueue.Enqueue (inputResult);
  642. }
  643. public void Dispose ()
  644. {
  645. _inputReadyCancellationTokenSource?.Cancel ();
  646. _inputReadyCancellationTokenSource?.Dispose ();
  647. _inputReadyCancellationTokenSource = null;
  648. try
  649. {
  650. // throws away any typeahead that has been typed by
  651. // the user and has not yet been read by the program.
  652. while (Console.KeyAvailable)
  653. {
  654. Console.ReadKey (true);
  655. }
  656. }
  657. catch (InvalidOperationException)
  658. {
  659. // Ignore - Console input has already been closed
  660. }
  661. }
  662. }
  663. internal class NetDriver : ConsoleDriver
  664. {
  665. private const int COLOR_BLACK = 30;
  666. private const int COLOR_BLUE = 34;
  667. private const int COLOR_BRIGHT_BLACK = 90;
  668. private const int COLOR_BRIGHT_BLUE = 94;
  669. private const int COLOR_BRIGHT_CYAN = 96;
  670. private const int COLOR_BRIGHT_GREEN = 92;
  671. private const int COLOR_BRIGHT_MAGENTA = 95;
  672. private const int COLOR_BRIGHT_RED = 91;
  673. private const int COLOR_BRIGHT_WHITE = 97;
  674. private const int COLOR_BRIGHT_YELLOW = 93;
  675. private const int COLOR_CYAN = 36;
  676. private const int COLOR_GREEN = 32;
  677. private const int COLOR_MAGENTA = 35;
  678. private const int COLOR_RED = 31;
  679. private const int COLOR_WHITE = 37;
  680. private const int COLOR_YELLOW = 33;
  681. private NetMainLoop _mainLoopDriver;
  682. public bool IsWinPlatform { get; private set; }
  683. public NetWinVTConsole NetWinConsole { get; private set; }
  684. public override bool SupportsTrueColor => Environment.OSVersion.Platform == PlatformID.Unix
  685. || (IsWinPlatform && Environment.OSVersion.Version.Build >= 14931);
  686. public override void Refresh ()
  687. {
  688. UpdateScreen ();
  689. UpdateCursor ();
  690. }
  691. public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
  692. {
  693. var input = new InputResult
  694. {
  695. EventType = EventType.Key, ConsoleKeyInfo = new ConsoleKeyInfo (keyChar, key, shift, alt, control)
  696. };
  697. try
  698. {
  699. ProcessInput (input);
  700. }
  701. catch (OverflowException)
  702. { }
  703. }
  704. public override void Suspend ()
  705. {
  706. if (Environment.OSVersion.Platform != PlatformID.Unix)
  707. {
  708. return;
  709. }
  710. StopReportingMouseMoves ();
  711. if (!RunningUnitTests)
  712. {
  713. Console.ResetColor ();
  714. Console.Clear ();
  715. //Disable alternative screen buffer.
  716. Console.Out.Write (EscSeqUtils.CSI_RestoreCursorAndRestoreAltBufferWithBackscroll);
  717. //Set cursor key to cursor.
  718. Console.Out.Write (EscSeqUtils.CSI_ShowCursor);
  719. Platform.Suspend ();
  720. //Enable alternative screen buffer.
  721. Console.Out.Write (EscSeqUtils.CSI_SaveCursorAndActivateAltBufferNoBackscroll);
  722. SetContentsAsDirty ();
  723. Refresh ();
  724. }
  725. StartReportingMouseMoves ();
  726. }
  727. public override void UpdateScreen ()
  728. {
  729. if (RunningUnitTests
  730. || _winSizeChanging
  731. || Console.WindowHeight < 1
  732. || Contents.Length != Rows * Cols
  733. || Rows != Console.WindowHeight)
  734. {
  735. return;
  736. }
  737. var top = 0;
  738. var left = 0;
  739. int rows = Rows;
  740. int cols = Cols;
  741. var output = new StringBuilder ();
  742. Attribute? redrawAttr = null;
  743. int lastCol = -1;
  744. CursorVisibility? savedVisibility = _cachedCursorVisibility;
  745. SetCursorVisibility (CursorVisibility.Invisible);
  746. for (int row = top; row < rows; row++)
  747. {
  748. if (Console.WindowHeight < 1)
  749. {
  750. return;
  751. }
  752. if (!_dirtyLines [row])
  753. {
  754. continue;
  755. }
  756. if (!SetCursorPosition (0, row))
  757. {
  758. return;
  759. }
  760. _dirtyLines [row] = false;
  761. output.Clear ();
  762. for (int col = left; col < cols; col++)
  763. {
  764. lastCol = -1;
  765. var outputWidth = 0;
  766. for (; col < cols; col++)
  767. {
  768. if (!Contents [row, col].IsDirty)
  769. {
  770. if (output.Length > 0)
  771. {
  772. WriteToConsole (output, ref lastCol, row, ref outputWidth);
  773. }
  774. else if (lastCol == -1)
  775. {
  776. lastCol = col;
  777. }
  778. if (lastCol + 1 < cols)
  779. {
  780. lastCol++;
  781. }
  782. continue;
  783. }
  784. if (lastCol == -1)
  785. {
  786. lastCol = col;
  787. }
  788. Attribute attr = Contents [row, col].Attribute.Value;
  789. // Performance: Only send the escape sequence if the attribute has changed.
  790. if (attr != redrawAttr)
  791. {
  792. redrawAttr = attr;
  793. if (Force16Colors)
  794. {
  795. output.Append (
  796. EscSeqUtils.CSI_SetGraphicsRendition (
  797. MapColors (
  798. (ConsoleColor)attr.Background.GetClosestNamedColor16 (),
  799. false
  800. ),
  801. MapColors ((ConsoleColor)attr.Foreground.GetClosestNamedColor16 ())
  802. )
  803. );
  804. }
  805. else
  806. {
  807. output.Append (
  808. EscSeqUtils.CSI_SetForegroundColorRGB (
  809. attr.Foreground.R,
  810. attr.Foreground.G,
  811. attr.Foreground.B
  812. )
  813. );
  814. output.Append (
  815. EscSeqUtils.CSI_SetBackgroundColorRGB (
  816. attr.Background.R,
  817. attr.Background.G,
  818. attr.Background.B
  819. )
  820. );
  821. }
  822. }
  823. outputWidth++;
  824. Rune rune = Contents [row, col].Rune;
  825. output.Append (rune);
  826. if (Contents [row, col].CombiningMarks.Count > 0)
  827. {
  828. // AtlasEngine does not support NON-NORMALIZED combining marks in a way
  829. // compatible with the driver architecture. Any CMs (except in the first col)
  830. // are correctly combined with the base char, but are ALSO treated as 1 column
  831. // width codepoints E.g. `echo "[e`u{0301}`u{0301}]"` will output `[é ]`.
  832. //
  833. // For now, we just ignore the list of CMs.
  834. //foreach (var combMark in Contents [row, col].CombiningMarks) {
  835. // output.Append (combMark);
  836. //}
  837. // WriteToConsole (output, ref lastCol, row, ref outputWidth);
  838. }
  839. else if (rune.IsSurrogatePair () && rune.GetColumns () < 2)
  840. {
  841. WriteToConsole (output, ref lastCol, row, ref outputWidth);
  842. SetCursorPosition (col - 1, row);
  843. }
  844. Contents [row, col].IsDirty = false;
  845. }
  846. }
  847. if (output.Length > 0)
  848. {
  849. SetCursorPosition (lastCol, row);
  850. Console.Write (output);
  851. }
  852. if (ConsoleDriver.SupportsSixel)
  853. {
  854. foreach (var s in Application.Sixel)
  855. {
  856. if (!string.IsNullOrWhiteSpace (s.SixelData))
  857. {
  858. SetCursorPosition (s.ScreenPosition.X, s.ScreenPosition.Y);
  859. Console.Write (s.SixelData);
  860. }
  861. }
  862. }
  863. }
  864. SetCursorPosition (0, 0);
  865. _cachedCursorVisibility = savedVisibility;
  866. void WriteToConsole (StringBuilder output, ref int lastCol, int row, ref int outputWidth)
  867. {
  868. SetCursorPosition (lastCol, row);
  869. Console.Write (output);
  870. output.Clear ();
  871. lastCol += outputWidth;
  872. outputWidth = 0;
  873. }
  874. }
  875. internal override void End ()
  876. {
  877. if (IsWinPlatform)
  878. {
  879. NetWinConsole?.Cleanup ();
  880. }
  881. StopReportingMouseMoves ();
  882. if (!RunningUnitTests)
  883. {
  884. Console.ResetColor ();
  885. //Disable alternative screen buffer.
  886. Console.Out.Write (EscSeqUtils.CSI_RestoreCursorAndRestoreAltBufferWithBackscroll);
  887. //Set cursor key to cursor.
  888. Console.Out.Write (EscSeqUtils.CSI_ShowCursor);
  889. Console.Out.Close ();
  890. }
  891. }
  892. internal override MainLoop Init ()
  893. {
  894. PlatformID p = Environment.OSVersion.Platform;
  895. if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows)
  896. {
  897. IsWinPlatform = true;
  898. try
  899. {
  900. NetWinConsole = new NetWinVTConsole ();
  901. }
  902. catch (ApplicationException)
  903. {
  904. // Likely running as a unit test, or in a non-interactive session.
  905. }
  906. }
  907. if (IsWinPlatform)
  908. {
  909. Clipboard = new WindowsClipboard ();
  910. }
  911. else if (RuntimeInformation.IsOSPlatform (OSPlatform.OSX))
  912. {
  913. Clipboard = new MacOSXClipboard ();
  914. }
  915. else
  916. {
  917. if (CursesDriver.Is_WSL_Platform ())
  918. {
  919. Clipboard = new WSLClipboard ();
  920. }
  921. else
  922. {
  923. Clipboard = new CursesClipboard ();
  924. }
  925. }
  926. if (!RunningUnitTests)
  927. {
  928. Console.TreatControlCAsInput = true;
  929. Cols = Console.WindowWidth;
  930. Rows = Console.WindowHeight;
  931. //Enable alternative screen buffer.
  932. Console.Out.Write (EscSeqUtils.CSI_SaveCursorAndActivateAltBufferNoBackscroll);
  933. //Set cursor key to application.
  934. Console.Out.Write (EscSeqUtils.CSI_HideCursor);
  935. }
  936. else
  937. {
  938. // We are being run in an environment that does not support a console
  939. // such as a unit test, or a pipe.
  940. Cols = 80;
  941. Rows = 24;
  942. }
  943. ResizeScreen ();
  944. ClearContents ();
  945. CurrentAttribute = new Attribute (Color.White, Color.Black);
  946. StartReportingMouseMoves ();
  947. _mainLoopDriver = new NetMainLoop (this);
  948. _mainLoopDriver.ProcessInput = ProcessInput;
  949. _mainLoopDriver._netEvents.EscSeqRequests.Add ("c");
  950. // Determine if sixel is supported
  951. Console.Out.Write (EscSeqUtils.CSI_SendDeviceAttributes);
  952. return new MainLoop (_mainLoopDriver);
  953. }
  954. private void ProcessInput (InputResult inputEvent)
  955. {
  956. switch (inputEvent.EventType)
  957. {
  958. case EventType.Key:
  959. ConsoleKeyInfo consoleKeyInfo = inputEvent.ConsoleKeyInfo;
  960. //if (consoleKeyInfo.Key == ConsoleKey.Packet) {
  961. // consoleKeyInfo = FromVKPacketToKConsoleKeyInfo (consoleKeyInfo);
  962. //}
  963. //Debug.WriteLine ($"event: {inputEvent}");
  964. KeyCode map = MapKey (consoleKeyInfo);
  965. if (map == KeyCode.Null)
  966. {
  967. break;
  968. }
  969. OnKeyDown (new Key (map));
  970. OnKeyUp (new Key (map));
  971. break;
  972. case EventType.Mouse:
  973. MouseEvent me = ToDriverMouse (inputEvent.MouseEvent);
  974. //Debug.WriteLine ($"NetDriver: ({me.X},{me.Y}) - {me.Flags}");
  975. OnMouseEvent (me);
  976. break;
  977. case EventType.WindowSize:
  978. _winSizeChanging = true;
  979. Top = 0;
  980. Left = 0;
  981. Cols = inputEvent.WindowSizeEvent.Size.Width;
  982. Rows = Math.Max (inputEvent.WindowSizeEvent.Size.Height, 0);
  983. ;
  984. ResizeScreen ();
  985. ClearContents ();
  986. _winSizeChanging = false;
  987. OnSizeChanged (new SizeChangedEventArgs (new (Cols, Rows)));
  988. break;
  989. case EventType.RequestResponse:
  990. break;
  991. case EventType.WindowPosition:
  992. break;
  993. default:
  994. throw new ArgumentOutOfRangeException ();
  995. }
  996. }
  997. #region Size and Position Handling
  998. private volatile bool _winSizeChanging;
  999. private void SetWindowPosition (int col, int row)
  1000. {
  1001. if (!RunningUnitTests)
  1002. {
  1003. Top = Console.WindowTop;
  1004. Left = Console.WindowLeft;
  1005. }
  1006. else
  1007. {
  1008. Top = row;
  1009. Left = col;
  1010. }
  1011. }
  1012. public virtual void ResizeScreen ()
  1013. {
  1014. // Not supported on Unix.
  1015. if (IsWinPlatform)
  1016. {
  1017. // Can raise an exception while is still resizing.
  1018. try
  1019. {
  1020. #pragma warning disable CA1416
  1021. if (Console.WindowHeight > 0)
  1022. {
  1023. Console.CursorTop = 0;
  1024. Console.CursorLeft = 0;
  1025. Console.WindowTop = 0;
  1026. Console.WindowLeft = 0;
  1027. if (Console.WindowHeight > Rows)
  1028. {
  1029. Console.SetWindowSize (Cols, Rows);
  1030. }
  1031. Console.SetBufferSize (Cols, Rows);
  1032. }
  1033. #pragma warning restore CA1416
  1034. }
  1035. // INTENT: Why are these eating the exceptions?
  1036. // Comments would be good here.
  1037. catch (IOException)
  1038. {
  1039. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1040. Clip = new (0, 0, Cols, Rows);
  1041. }
  1042. catch (ArgumentOutOfRangeException)
  1043. {
  1044. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1045. Clip = new (0, 0, Cols, Rows);
  1046. }
  1047. }
  1048. else
  1049. {
  1050. Console.Out.Write (EscSeqUtils.CSI_SetTerminalWindowSize (Rows, Cols));
  1051. }
  1052. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1053. Clip = new (0, 0, Cols, Rows);
  1054. }
  1055. #endregion
  1056. #region Color Handling
  1057. // Cache the list of ConsoleColor values.
  1058. [UnconditionalSuppressMessage ("AOT", "IL3050:Calling members annotated with 'RequiresDynamicCodeAttribute' may break functionality when AOT compiling.", Justification = "<Pending>")]
  1059. private static readonly HashSet<int> ConsoleColorValues = new (
  1060. Enum.GetValues (typeof (ConsoleColor))
  1061. .OfType<ConsoleColor> ()
  1062. .Select (c => (int)c)
  1063. );
  1064. // Dictionary for mapping ConsoleColor values to the values used by System.Net.Console.
  1065. private static readonly Dictionary<ConsoleColor, int> colorMap = new ()
  1066. {
  1067. { ConsoleColor.Black, COLOR_BLACK },
  1068. { ConsoleColor.DarkBlue, COLOR_BLUE },
  1069. { ConsoleColor.DarkGreen, COLOR_GREEN },
  1070. { ConsoleColor.DarkCyan, COLOR_CYAN },
  1071. { ConsoleColor.DarkRed, COLOR_RED },
  1072. { ConsoleColor.DarkMagenta, COLOR_MAGENTA },
  1073. { ConsoleColor.DarkYellow, COLOR_YELLOW },
  1074. { ConsoleColor.Gray, COLOR_WHITE },
  1075. { ConsoleColor.DarkGray, COLOR_BRIGHT_BLACK },
  1076. { ConsoleColor.Blue, COLOR_BRIGHT_BLUE },
  1077. { ConsoleColor.Green, COLOR_BRIGHT_GREEN },
  1078. { ConsoleColor.Cyan, COLOR_BRIGHT_CYAN },
  1079. { ConsoleColor.Red, COLOR_BRIGHT_RED },
  1080. { ConsoleColor.Magenta, COLOR_BRIGHT_MAGENTA },
  1081. { ConsoleColor.Yellow, COLOR_BRIGHT_YELLOW },
  1082. { ConsoleColor.White, COLOR_BRIGHT_WHITE }
  1083. };
  1084. // Map a ConsoleColor to a platform dependent value.
  1085. private int MapColors (ConsoleColor color, bool isForeground = true)
  1086. {
  1087. return colorMap.TryGetValue (color, out int colorValue) ? colorValue + (isForeground ? 0 : 10) : 0;
  1088. }
  1089. ///// <remarks>
  1090. ///// In the NetDriver, colors are encoded as an int.
  1091. ///// However, the foreground color is stored in the most significant 16 bits,
  1092. ///// and the background color is stored in the least significant 16 bits.
  1093. ///// </remarks>
  1094. //public override Attribute MakeColor (Color foreground, Color background)
  1095. //{
  1096. // // Encode the colors into the int value.
  1097. // return new Attribute (
  1098. // platformColor: ((((int)foreground.ColorName) & 0xffff) << 16) | (((int)background.ColorName) & 0xffff),
  1099. // foreground: foreground,
  1100. // background: background
  1101. // );
  1102. //}
  1103. #endregion
  1104. #region Cursor Handling
  1105. private bool SetCursorPosition (int col, int row)
  1106. {
  1107. if (IsWinPlatform)
  1108. {
  1109. // Could happens that the windows is still resizing and the col is bigger than Console.WindowWidth.
  1110. try
  1111. {
  1112. Console.SetCursorPosition (col, row);
  1113. return true;
  1114. }
  1115. catch (Exception)
  1116. {
  1117. return false;
  1118. }
  1119. }
  1120. // + 1 is needed because non-Windows is based on 1 instead of 0 and
  1121. // Console.CursorTop/CursorLeft isn't reliable.
  1122. Console.Out.Write (EscSeqUtils.CSI_SetCursorPosition (row + 1, col + 1));
  1123. return true;
  1124. }
  1125. private CursorVisibility? _cachedCursorVisibility;
  1126. private static bool _supportsSixel;
  1127. public override void UpdateCursor ()
  1128. {
  1129. EnsureCursorVisibility ();
  1130. if (Col >= 0 && Col < Cols && Row >= 0 && Row <= Rows)
  1131. {
  1132. SetCursorPosition (Col, Row);
  1133. SetWindowPosition (0, Row);
  1134. }
  1135. }
  1136. public override bool GetCursorVisibility (out CursorVisibility visibility)
  1137. {
  1138. visibility = _cachedCursorVisibility ?? CursorVisibility.Default;
  1139. return visibility == CursorVisibility.Default;
  1140. }
  1141. public override bool SetCursorVisibility (CursorVisibility visibility)
  1142. {
  1143. _cachedCursorVisibility = visibility;
  1144. Console.Out.Write (visibility == CursorVisibility.Default ? EscSeqUtils.CSI_ShowCursor : EscSeqUtils.CSI_HideCursor);
  1145. return visibility == CursorVisibility.Default;
  1146. }
  1147. public override bool EnsureCursorVisibility ()
  1148. {
  1149. if (!(Col >= 0 && Row >= 0 && Col < Cols && Row < Rows))
  1150. {
  1151. GetCursorVisibility (out CursorVisibility cursorVisibility);
  1152. _cachedCursorVisibility = cursorVisibility;
  1153. SetCursorVisibility (CursorVisibility.Invisible);
  1154. return false;
  1155. }
  1156. SetCursorVisibility (_cachedCursorVisibility ?? CursorVisibility.Default);
  1157. return _cachedCursorVisibility == CursorVisibility.Default;
  1158. }
  1159. #endregion
  1160. #region Mouse Handling
  1161. public void StartReportingMouseMoves ()
  1162. {
  1163. if (!RunningUnitTests)
  1164. {
  1165. Console.Out.Write (EscSeqUtils.CSI_EnableMouseEvents);
  1166. }
  1167. }
  1168. public void StopReportingMouseMoves ()
  1169. {
  1170. if (!RunningUnitTests)
  1171. {
  1172. Console.Out.Write (EscSeqUtils.CSI_DisableMouseEvents);
  1173. }
  1174. }
  1175. private MouseEvent ToDriverMouse (NetEvents.MouseEvent me)
  1176. {
  1177. //System.Diagnostics.Debug.WriteLine ($"X: {me.Position.X}; Y: {me.Position.Y}; ButtonState: {me.ButtonState}");
  1178. MouseFlags mouseFlag = 0;
  1179. if ((me.ButtonState & MouseButtonState.Button1Pressed) != 0)
  1180. {
  1181. mouseFlag |= MouseFlags.Button1Pressed;
  1182. }
  1183. if ((me.ButtonState & MouseButtonState.Button1Released) != 0)
  1184. {
  1185. mouseFlag |= MouseFlags.Button1Released;
  1186. }
  1187. if ((me.ButtonState & MouseButtonState.Button1Clicked) != 0)
  1188. {
  1189. mouseFlag |= MouseFlags.Button1Clicked;
  1190. }
  1191. if ((me.ButtonState & MouseButtonState.Button1DoubleClicked) != 0)
  1192. {
  1193. mouseFlag |= MouseFlags.Button1DoubleClicked;
  1194. }
  1195. if ((me.ButtonState & MouseButtonState.Button1TripleClicked) != 0)
  1196. {
  1197. mouseFlag |= MouseFlags.Button1TripleClicked;
  1198. }
  1199. if ((me.ButtonState & MouseButtonState.Button2Pressed) != 0)
  1200. {
  1201. mouseFlag |= MouseFlags.Button2Pressed;
  1202. }
  1203. if ((me.ButtonState & MouseButtonState.Button2Released) != 0)
  1204. {
  1205. mouseFlag |= MouseFlags.Button2Released;
  1206. }
  1207. if ((me.ButtonState & MouseButtonState.Button2Clicked) != 0)
  1208. {
  1209. mouseFlag |= MouseFlags.Button2Clicked;
  1210. }
  1211. if ((me.ButtonState & MouseButtonState.Button2DoubleClicked) != 0)
  1212. {
  1213. mouseFlag |= MouseFlags.Button2DoubleClicked;
  1214. }
  1215. if ((me.ButtonState & MouseButtonState.Button2TripleClicked) != 0)
  1216. {
  1217. mouseFlag |= MouseFlags.Button2TripleClicked;
  1218. }
  1219. if ((me.ButtonState & MouseButtonState.Button3Pressed) != 0)
  1220. {
  1221. mouseFlag |= MouseFlags.Button3Pressed;
  1222. }
  1223. if ((me.ButtonState & MouseButtonState.Button3Released) != 0)
  1224. {
  1225. mouseFlag |= MouseFlags.Button3Released;
  1226. }
  1227. if ((me.ButtonState & MouseButtonState.Button3Clicked) != 0)
  1228. {
  1229. mouseFlag |= MouseFlags.Button3Clicked;
  1230. }
  1231. if ((me.ButtonState & MouseButtonState.Button3DoubleClicked) != 0)
  1232. {
  1233. mouseFlag |= MouseFlags.Button3DoubleClicked;
  1234. }
  1235. if ((me.ButtonState & MouseButtonState.Button3TripleClicked) != 0)
  1236. {
  1237. mouseFlag |= MouseFlags.Button3TripleClicked;
  1238. }
  1239. if ((me.ButtonState & MouseButtonState.ButtonWheeledUp) != 0)
  1240. {
  1241. mouseFlag |= MouseFlags.WheeledUp;
  1242. }
  1243. if ((me.ButtonState & MouseButtonState.ButtonWheeledDown) != 0)
  1244. {
  1245. mouseFlag |= MouseFlags.WheeledDown;
  1246. }
  1247. if ((me.ButtonState & MouseButtonState.ButtonWheeledLeft) != 0)
  1248. {
  1249. mouseFlag |= MouseFlags.WheeledLeft;
  1250. }
  1251. if ((me.ButtonState & MouseButtonState.ButtonWheeledRight) != 0)
  1252. {
  1253. mouseFlag |= MouseFlags.WheeledRight;
  1254. }
  1255. if ((me.ButtonState & MouseButtonState.Button4Pressed) != 0)
  1256. {
  1257. mouseFlag |= MouseFlags.Button4Pressed;
  1258. }
  1259. if ((me.ButtonState & MouseButtonState.Button4Released) != 0)
  1260. {
  1261. mouseFlag |= MouseFlags.Button4Released;
  1262. }
  1263. if ((me.ButtonState & MouseButtonState.Button4Clicked) != 0)
  1264. {
  1265. mouseFlag |= MouseFlags.Button4Clicked;
  1266. }
  1267. if ((me.ButtonState & MouseButtonState.Button4DoubleClicked) != 0)
  1268. {
  1269. mouseFlag |= MouseFlags.Button4DoubleClicked;
  1270. }
  1271. if ((me.ButtonState & MouseButtonState.Button4TripleClicked) != 0)
  1272. {
  1273. mouseFlag |= MouseFlags.Button4TripleClicked;
  1274. }
  1275. if ((me.ButtonState & MouseButtonState.ReportMousePosition) != 0)
  1276. {
  1277. mouseFlag |= MouseFlags.ReportMousePosition;
  1278. }
  1279. if ((me.ButtonState & MouseButtonState.ButtonShift) != 0)
  1280. {
  1281. mouseFlag |= MouseFlags.ButtonShift;
  1282. }
  1283. if ((me.ButtonState & MouseButtonState.ButtonCtrl) != 0)
  1284. {
  1285. mouseFlag |= MouseFlags.ButtonCtrl;
  1286. }
  1287. if ((me.ButtonState & MouseButtonState.ButtonAlt) != 0)
  1288. {
  1289. mouseFlag |= MouseFlags.ButtonAlt;
  1290. }
  1291. return new MouseEvent { Position = me.Position, Flags = mouseFlag };
  1292. }
  1293. #endregion Mouse Handling
  1294. #region Keyboard Handling
  1295. private ConsoleKeyInfo FromVKPacketToKConsoleKeyInfo (ConsoleKeyInfo consoleKeyInfo)
  1296. {
  1297. if (consoleKeyInfo.Key != ConsoleKey.Packet)
  1298. {
  1299. return consoleKeyInfo;
  1300. }
  1301. ConsoleModifiers mod = consoleKeyInfo.Modifiers;
  1302. bool shift = (mod & ConsoleModifiers.Shift) != 0;
  1303. bool alt = (mod & ConsoleModifiers.Alt) != 0;
  1304. bool control = (mod & ConsoleModifiers.Control) != 0;
  1305. ConsoleKeyInfo cKeyInfo = DecodeVKPacketToKConsoleKeyInfo (consoleKeyInfo);
  1306. return new ConsoleKeyInfo (cKeyInfo.KeyChar, cKeyInfo.Key, shift, alt, control);
  1307. }
  1308. private KeyCode MapKey (ConsoleKeyInfo keyInfo)
  1309. {
  1310. switch (keyInfo.Key)
  1311. {
  1312. case ConsoleKey.OemPeriod:
  1313. case ConsoleKey.OemComma:
  1314. case ConsoleKey.OemPlus:
  1315. case ConsoleKey.OemMinus:
  1316. case ConsoleKey.Packet:
  1317. case ConsoleKey.Oem1:
  1318. case ConsoleKey.Oem2:
  1319. case ConsoleKey.Oem3:
  1320. case ConsoleKey.Oem4:
  1321. case ConsoleKey.Oem5:
  1322. case ConsoleKey.Oem6:
  1323. case ConsoleKey.Oem7:
  1324. case ConsoleKey.Oem8:
  1325. case ConsoleKey.Oem102:
  1326. if (keyInfo.KeyChar == 0)
  1327. {
  1328. // If the keyChar is 0, keyInfo.Key value is not a printable character.
  1329. return KeyCode.Null; // MapToKeyCodeModifiers (keyInfo.Modifiers, KeyCode)keyInfo.Key);
  1330. }
  1331. if (keyInfo.Modifiers != ConsoleModifiers.Shift)
  1332. {
  1333. // If Shift wasn't down we don't need to do anything but return the keyInfo.KeyChar
  1334. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)keyInfo.KeyChar);
  1335. }
  1336. // Strip off Shift - We got here because they KeyChar from Windows is the shifted char (e.g. "Ç")
  1337. // and passing on Shift would be redundant.
  1338. return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.KeyChar);
  1339. }
  1340. // Handle control keys whose VK codes match the related ASCII value (those below ASCII 33) like ESC
  1341. if (keyInfo.Key != ConsoleKey.None && Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key))
  1342. {
  1343. if (keyInfo.Modifiers.HasFlag(ConsoleModifiers.Control) && keyInfo.Key == ConsoleKey.I)
  1344. {
  1345. return KeyCode.Tab;
  1346. }
  1347. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.Key));
  1348. }
  1349. // Handle control keys (e.g. CursorUp)
  1350. if (keyInfo.Key != ConsoleKey.None
  1351. && Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint))
  1352. {
  1353. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint));
  1354. }
  1355. if (((ConsoleKey)keyInfo.KeyChar) is >= ConsoleKey.A and <= ConsoleKey.Z)
  1356. {
  1357. // Shifted
  1358. keyInfo = new ConsoleKeyInfo (
  1359. keyInfo.KeyChar,
  1360. (ConsoleKey)keyInfo.KeyChar,
  1361. true,
  1362. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt),
  1363. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control));
  1364. }
  1365. if ((ConsoleKey)keyInfo.KeyChar - 32 is >= ConsoleKey.A and <= ConsoleKey.Z)
  1366. {
  1367. // Unshifted
  1368. keyInfo = new ConsoleKeyInfo (
  1369. keyInfo.KeyChar,
  1370. (ConsoleKey)(keyInfo.KeyChar - 32),
  1371. false,
  1372. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt),
  1373. keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control));
  1374. }
  1375. if (keyInfo.Key is >= ConsoleKey.A and <= ConsoleKey.Z )
  1376. {
  1377. if (keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt)
  1378. || keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control))
  1379. {
  1380. // NetDriver doesn't support Shift-Ctrl/Shift-Alt combos
  1381. return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.Key);
  1382. }
  1383. if (keyInfo.Modifiers == ConsoleModifiers.Shift)
  1384. {
  1385. // If ShiftMask is on add the ShiftMask
  1386. if (char.IsUpper (keyInfo.KeyChar))
  1387. {
  1388. return (KeyCode)keyInfo.Key | KeyCode.ShiftMask;
  1389. }
  1390. }
  1391. return (KeyCode)keyInfo.Key;
  1392. }
  1393. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.KeyChar));
  1394. }
  1395. #endregion Keyboard Handling
  1396. }
  1397. /// <summary>
  1398. /// Mainloop intended to be used with the .NET System.Console API, and can be used on Windows and Unix, it is
  1399. /// cross-platform but lacks things like file descriptor monitoring.
  1400. /// </summary>
  1401. /// <remarks>This implementation is used for NetDriver.</remarks>
  1402. internal class NetMainLoop : IMainLoopDriver
  1403. {
  1404. internal NetEvents _netEvents;
  1405. /// <summary>Invoked when a Key is pressed.</summary>
  1406. internal Action<InputResult> ProcessInput;
  1407. private readonly ManualResetEventSlim _eventReady = new (false);
  1408. private readonly CancellationTokenSource _inputHandlerTokenSource = new ();
  1409. private readonly Queue<InputResult?> _resultQueue = new ();
  1410. private readonly ManualResetEventSlim _waitForProbe = new (false);
  1411. private readonly CancellationTokenSource _eventReadyTokenSource = new ();
  1412. private MainLoop _mainLoop;
  1413. /// <summary>Initializes the class with the console driver.</summary>
  1414. /// <remarks>Passing a consoleDriver is provided to capture windows resizing.</remarks>
  1415. /// <param name="consoleDriver">The console driver used by this Net main loop.</param>
  1416. /// <exception cref="ArgumentNullException"></exception>
  1417. public NetMainLoop (ConsoleDriver consoleDriver = null)
  1418. {
  1419. if (consoleDriver is null)
  1420. {
  1421. throw new ArgumentNullException (nameof (consoleDriver));
  1422. }
  1423. _netEvents = new NetEvents (consoleDriver);
  1424. }
  1425. void IMainLoopDriver.Setup (MainLoop mainLoop)
  1426. {
  1427. _mainLoop = mainLoop;
  1428. Task.Run (NetInputHandler, _inputHandlerTokenSource.Token);
  1429. }
  1430. void IMainLoopDriver.Wakeup () { _eventReady.Set (); }
  1431. bool IMainLoopDriver.EventsPending ()
  1432. {
  1433. _waitForProbe.Set ();
  1434. if (_mainLoop.CheckTimersAndIdleHandlers (out int waitTimeout))
  1435. {
  1436. return true;
  1437. }
  1438. try
  1439. {
  1440. if (!_eventReadyTokenSource.IsCancellationRequested)
  1441. {
  1442. // Note: ManualResetEventSlim.Wait will wait indefinitely if the timeout is -1. The timeout is -1 when there
  1443. // are no timers, but there IS an idle handler waiting.
  1444. _eventReady.Wait (waitTimeout, _eventReadyTokenSource.Token);
  1445. }
  1446. }
  1447. catch (OperationCanceledException)
  1448. {
  1449. return true;
  1450. }
  1451. finally
  1452. {
  1453. _eventReady.Reset ();
  1454. }
  1455. _eventReadyTokenSource.Token.ThrowIfCancellationRequested ();
  1456. if (!_eventReadyTokenSource.IsCancellationRequested)
  1457. {
  1458. return _resultQueue.Count > 0 || _mainLoop.CheckTimersAndIdleHandlers (out _);
  1459. }
  1460. return true;
  1461. }
  1462. void IMainLoopDriver.Iteration ()
  1463. {
  1464. while (_resultQueue.Count > 0)
  1465. {
  1466. ProcessInput?.Invoke (_resultQueue.Dequeue ().Value);
  1467. }
  1468. }
  1469. void IMainLoopDriver.TearDown ()
  1470. {
  1471. _inputHandlerTokenSource?.Cancel ();
  1472. _inputHandlerTokenSource?.Dispose ();
  1473. _eventReadyTokenSource?.Cancel ();
  1474. _eventReadyTokenSource?.Dispose ();
  1475. _eventReady?.Dispose ();
  1476. _resultQueue?.Clear ();
  1477. _waitForProbe?.Dispose ();
  1478. _netEvents?.Dispose ();
  1479. _netEvents = null;
  1480. _mainLoop = null;
  1481. }
  1482. private void NetInputHandler ()
  1483. {
  1484. while (_mainLoop is { })
  1485. {
  1486. try
  1487. {
  1488. if (!_inputHandlerTokenSource.IsCancellationRequested)
  1489. {
  1490. _waitForProbe.Wait (_inputHandlerTokenSource.Token);
  1491. }
  1492. }
  1493. catch (OperationCanceledException)
  1494. {
  1495. return;
  1496. }
  1497. finally
  1498. {
  1499. if (_waitForProbe.IsSet)
  1500. {
  1501. _waitForProbe.Reset ();
  1502. }
  1503. }
  1504. if (_inputHandlerTokenSource.IsCancellationRequested)
  1505. {
  1506. return;
  1507. }
  1508. _inputHandlerTokenSource.Token.ThrowIfCancellationRequested ();
  1509. if (_resultQueue.Count == 0)
  1510. {
  1511. _resultQueue.Enqueue (_netEvents.DequeueInput ());
  1512. }
  1513. while (_resultQueue.Count > 0 && _resultQueue.Peek () is null)
  1514. {
  1515. _resultQueue.Dequeue ();
  1516. }
  1517. if (_resultQueue.Count > 0)
  1518. {
  1519. _eventReady.Set ();
  1520. }
  1521. }
  1522. }
  1523. }