WindowsDriver.cs 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537
  1. //
  2. // WindowsDriver.cs: Windows specific driver
  3. //
  4. // HACK:
  5. // WindowsConsole/Terminal has two issues:
  6. // 1) Tearing can occur when the console is resized.
  7. // 2) The values provided during Init (and the first WindowsConsole.EventType.WindowBufferSize) are not correct.
  8. //
  9. // If HACK_CHECK_WINCHANGED is defined then we ignore WindowsConsole.EventType.WindowBufferSize events
  10. // and instead check the console size every every 500ms in a thread in WidowsMainLoop.
  11. // As of Windows 11 23H2 25947.1000 and/or WT 1.19.2682 tearing no longer occurs when using
  12. // the WindowsConsole.EventType.WindowBufferSize event. However, on Init the window size is
  13. // still incorrect so we still need this hack.
  14. #define HACK_CHECK_WINCHANGED
  15. using System.ComponentModel;
  16. using System.Diagnostics;
  17. using System.Runtime.InteropServices;
  18. using System.Text;
  19. using static Terminal.Gui.ConsoleDrivers.ConsoleKeyMapping;
  20. using static Terminal.Gui.SpinnerStyle;
  21. namespace Terminal.Gui;
  22. internal class WindowsConsole
  23. {
  24. public const int STD_OUTPUT_HANDLE = -11;
  25. public const int STD_INPUT_HANDLE = -10;
  26. private readonly nint _inputHandle;
  27. private readonly nint _outputHandle;
  28. private nint _screenBuffer;
  29. private readonly uint _originalConsoleMode;
  30. private CursorVisibility? _initialCursorVisibility;
  31. private CursorVisibility? _currentCursorVisibility;
  32. private CursorVisibility? _pendingCursorVisibility;
  33. private readonly StringBuilder _stringBuilder = new (256 * 1024);
  34. public WindowsConsole ()
  35. {
  36. _inputHandle = GetStdHandle (STD_INPUT_HANDLE);
  37. _outputHandle = GetStdHandle (STD_OUTPUT_HANDLE);
  38. _originalConsoleMode = ConsoleMode;
  39. uint newConsoleMode = _originalConsoleMode;
  40. newConsoleMode |= (uint)(ConsoleModes.EnableMouseInput | ConsoleModes.EnableExtendedFlags);
  41. newConsoleMode &= ~(uint)ConsoleModes.EnableQuickEditMode;
  42. newConsoleMode &= ~(uint)ConsoleModes.EnableProcessedInput;
  43. ConsoleMode = newConsoleMode;
  44. }
  45. private CharInfo [] _originalStdOutChars;
  46. public bool WriteToConsole (Size size, ExtendedCharInfo [] charInfoBuffer, Coord bufferSize, SmallRect window, bool force16Colors)
  47. {
  48. //Debug.WriteLine ("WriteToConsole");
  49. if (_screenBuffer == nint.Zero)
  50. {
  51. ReadFromConsoleOutput (size, bufferSize, ref window);
  52. }
  53. var result = false;
  54. if (force16Colors)
  55. {
  56. var i = 0;
  57. CharInfo [] ci = new CharInfo [charInfoBuffer.Length];
  58. foreach (ExtendedCharInfo info in charInfoBuffer)
  59. {
  60. ci [i++] = new CharInfo
  61. {
  62. Char = new CharUnion { UnicodeChar = info.Char },
  63. Attributes =
  64. (ushort)((int)info.Attribute.Foreground.GetClosestNamedColor16 () | ((int)info.Attribute.Background.GetClosestNamedColor16 () << 4))
  65. };
  66. }
  67. result = WriteConsoleOutput (_screenBuffer, ci, bufferSize, new Coord { X = window.Left, Y = window.Top }, ref window);
  68. }
  69. else
  70. {
  71. _stringBuilder.Clear ();
  72. _stringBuilder.Append (EscSeqUtils.CSI_SaveCursorPosition);
  73. _stringBuilder.Append (EscSeqUtils.CSI_SetCursorPosition (0, 0));
  74. Attribute? prev = null;
  75. foreach (ExtendedCharInfo info in charInfoBuffer)
  76. {
  77. Attribute attr = info.Attribute;
  78. if (attr != prev)
  79. {
  80. prev = attr;
  81. _stringBuilder.Append (EscSeqUtils.CSI_SetForegroundColorRGB (attr.Foreground.R, attr.Foreground.G, attr.Foreground.B));
  82. _stringBuilder.Append (EscSeqUtils.CSI_SetBackgroundColorRGB (attr.Background.R, attr.Background.G, attr.Background.B));
  83. }
  84. if (info.Char != '\x1b')
  85. {
  86. if (!info.Empty)
  87. {
  88. _stringBuilder.Append (info.Char);
  89. }
  90. }
  91. else
  92. {
  93. _stringBuilder.Append (' ');
  94. }
  95. }
  96. _stringBuilder.Append (EscSeqUtils.CSI_RestoreCursorPosition);
  97. _stringBuilder.Append (EscSeqUtils.CSI_HideCursor);
  98. var s = _stringBuilder.ToString ();
  99. result = WriteConsole (_screenBuffer, s, (uint)s.Length, out uint _, nint.Zero);
  100. }
  101. if (!result)
  102. {
  103. int err = Marshal.GetLastWin32Error ();
  104. if (err != 0)
  105. {
  106. throw new Win32Exception (err);
  107. }
  108. }
  109. return result;
  110. }
  111. public bool WriteANSI (string ansi)
  112. {
  113. return WriteConsole (_screenBuffer, ansi, (uint)ansi.Length, out uint _, nint.Zero);
  114. }
  115. public void ReadFromConsoleOutput (Size size, Coord coords, ref SmallRect window)
  116. {
  117. _screenBuffer = CreateConsoleScreenBuffer (
  118. DesiredAccess.GenericRead | DesiredAccess.GenericWrite,
  119. ShareMode.FileShareRead | ShareMode.FileShareWrite,
  120. nint.Zero,
  121. 1,
  122. nint.Zero
  123. );
  124. if (_screenBuffer == INVALID_HANDLE_VALUE)
  125. {
  126. int err = Marshal.GetLastWin32Error ();
  127. if (err != 0)
  128. {
  129. throw new Win32Exception (err);
  130. }
  131. }
  132. SetInitialCursorVisibility ();
  133. if (!SetConsoleActiveScreenBuffer (_screenBuffer))
  134. {
  135. throw new Win32Exception (Marshal.GetLastWin32Error ());
  136. }
  137. _originalStdOutChars = new CharInfo [size.Height * size.Width];
  138. if (!ReadConsoleOutput (_screenBuffer, _originalStdOutChars, coords, new Coord { X = 0, Y = 0 }, ref window))
  139. {
  140. throw new Win32Exception (Marshal.GetLastWin32Error ());
  141. }
  142. }
  143. public bool SetCursorPosition (Coord position)
  144. {
  145. return SetConsoleCursorPosition (_screenBuffer, position);
  146. }
  147. public void SetInitialCursorVisibility ()
  148. {
  149. if (_initialCursorVisibility.HasValue == false && GetCursorVisibility (out CursorVisibility visibility))
  150. {
  151. _initialCursorVisibility = visibility;
  152. }
  153. }
  154. public bool GetCursorVisibility (out CursorVisibility visibility)
  155. {
  156. if (_screenBuffer == nint.Zero)
  157. {
  158. visibility = CursorVisibility.Invisible;
  159. return false;
  160. }
  161. if (!GetConsoleCursorInfo (_screenBuffer, out ConsoleCursorInfo info))
  162. {
  163. int err = Marshal.GetLastWin32Error ();
  164. if (err != 0)
  165. {
  166. throw new Win32Exception (err);
  167. }
  168. visibility = CursorVisibility.Default;
  169. return false;
  170. }
  171. if (!info.bVisible)
  172. {
  173. visibility = CursorVisibility.Invisible;
  174. }
  175. else if (info.dwSize > 50)
  176. {
  177. visibility = CursorVisibility.Default;
  178. }
  179. else
  180. {
  181. visibility = CursorVisibility.Default;
  182. }
  183. return true;
  184. }
  185. public bool EnsureCursorVisibility ()
  186. {
  187. if (_initialCursorVisibility.HasValue && _pendingCursorVisibility.HasValue && SetCursorVisibility (_pendingCursorVisibility.Value))
  188. {
  189. _pendingCursorVisibility = null;
  190. return true;
  191. }
  192. return false;
  193. }
  194. public void ForceRefreshCursorVisibility ()
  195. {
  196. if (_currentCursorVisibility.HasValue)
  197. {
  198. _pendingCursorVisibility = _currentCursorVisibility;
  199. _currentCursorVisibility = null;
  200. }
  201. }
  202. public bool SetCursorVisibility (CursorVisibility visibility)
  203. {
  204. if (_initialCursorVisibility.HasValue == false)
  205. {
  206. _pendingCursorVisibility = visibility;
  207. return false;
  208. }
  209. if (_currentCursorVisibility.HasValue == false || _currentCursorVisibility.Value != visibility)
  210. {
  211. var info = new ConsoleCursorInfo
  212. {
  213. dwSize = (uint)visibility & 0x00FF,
  214. bVisible = ((uint)visibility & 0xFF00) != 0
  215. };
  216. if (!SetConsoleCursorInfo (_screenBuffer, ref info))
  217. {
  218. return false;
  219. }
  220. _currentCursorVisibility = visibility;
  221. }
  222. return true;
  223. }
  224. public void Cleanup ()
  225. {
  226. if (_initialCursorVisibility.HasValue)
  227. {
  228. SetCursorVisibility (_initialCursorVisibility.Value);
  229. }
  230. SetConsoleOutputWindow (out _);
  231. ConsoleMode = _originalConsoleMode;
  232. if (!SetConsoleActiveScreenBuffer (_outputHandle))
  233. {
  234. int err = Marshal.GetLastWin32Error ();
  235. Console.WriteLine ("Error: {0}", err);
  236. }
  237. if (_screenBuffer != nint.Zero)
  238. {
  239. CloseHandle (_screenBuffer);
  240. }
  241. _screenBuffer = nint.Zero;
  242. }
  243. internal Size GetConsoleBufferWindow (out Point position)
  244. {
  245. if (_screenBuffer == nint.Zero)
  246. {
  247. position = Point.Empty;
  248. return Size.Empty;
  249. }
  250. var csbi = new CONSOLE_SCREEN_BUFFER_INFOEX ();
  251. csbi.cbSize = (uint)Marshal.SizeOf (csbi);
  252. if (!GetConsoleScreenBufferInfoEx (_screenBuffer, ref csbi))
  253. {
  254. //throw new System.ComponentModel.Win32Exception (Marshal.GetLastWin32Error ());
  255. position = Point.Empty;
  256. return Size.Empty;
  257. }
  258. Size sz = new (
  259. csbi.srWindow.Right - csbi.srWindow.Left + 1,
  260. csbi.srWindow.Bottom - csbi.srWindow.Top + 1);
  261. position = new (csbi.srWindow.Left, csbi.srWindow.Top);
  262. return sz;
  263. }
  264. internal Size GetConsoleOutputWindow (out Point position)
  265. {
  266. var csbi = new CONSOLE_SCREEN_BUFFER_INFOEX ();
  267. csbi.cbSize = (uint)Marshal.SizeOf (csbi);
  268. if (!GetConsoleScreenBufferInfoEx (_outputHandle, ref csbi))
  269. {
  270. throw new Win32Exception (Marshal.GetLastWin32Error ());
  271. }
  272. Size sz = new (
  273. csbi.srWindow.Right - csbi.srWindow.Left + 1,
  274. csbi.srWindow.Bottom - csbi.srWindow.Top + 1);
  275. position = new (csbi.srWindow.Left, csbi.srWindow.Top);
  276. return sz;
  277. }
  278. internal Size SetConsoleWindow (short cols, short rows)
  279. {
  280. var csbi = new CONSOLE_SCREEN_BUFFER_INFOEX ();
  281. csbi.cbSize = (uint)Marshal.SizeOf (csbi);
  282. if (!GetConsoleScreenBufferInfoEx (_screenBuffer, ref csbi))
  283. {
  284. throw new Win32Exception (Marshal.GetLastWin32Error ());
  285. }
  286. Coord maxWinSize = GetLargestConsoleWindowSize (_screenBuffer);
  287. short newCols = Math.Min (cols, maxWinSize.X);
  288. short newRows = Math.Min (rows, maxWinSize.Y);
  289. csbi.dwSize = new Coord (newCols, Math.Max (newRows, (short)1));
  290. csbi.srWindow = new SmallRect (0, 0, newCols, newRows);
  291. csbi.dwMaximumWindowSize = new Coord (newCols, newRows);
  292. if (!SetConsoleScreenBufferInfoEx (_screenBuffer, ref csbi))
  293. {
  294. throw new Win32Exception (Marshal.GetLastWin32Error ());
  295. }
  296. var winRect = new SmallRect (0, 0, (short)(newCols - 1), (short)Math.Max (newRows - 1, 0));
  297. if (!SetConsoleWindowInfo (_outputHandle, true, ref winRect))
  298. {
  299. //throw new System.ComponentModel.Win32Exception (Marshal.GetLastWin32Error ());
  300. return new (cols, rows);
  301. }
  302. SetConsoleOutputWindow (csbi);
  303. return new (winRect.Right + 1, newRows - 1 < 0 ? 0 : winRect.Bottom + 1);
  304. }
  305. private void SetConsoleOutputWindow (CONSOLE_SCREEN_BUFFER_INFOEX csbi)
  306. {
  307. if (_screenBuffer != nint.Zero && !SetConsoleScreenBufferInfoEx (_screenBuffer, ref csbi))
  308. {
  309. throw new Win32Exception (Marshal.GetLastWin32Error ());
  310. }
  311. }
  312. internal Size SetConsoleOutputWindow (out Point position)
  313. {
  314. if (_screenBuffer == nint.Zero)
  315. {
  316. position = Point.Empty;
  317. return Size.Empty;
  318. }
  319. var csbi = new CONSOLE_SCREEN_BUFFER_INFOEX ();
  320. csbi.cbSize = (uint)Marshal.SizeOf (csbi);
  321. if (!GetConsoleScreenBufferInfoEx (_screenBuffer, ref csbi))
  322. {
  323. throw new Win32Exception (Marshal.GetLastWin32Error ());
  324. }
  325. Size sz = new (
  326. csbi.srWindow.Right - csbi.srWindow.Left + 1,
  327. Math.Max (csbi.srWindow.Bottom - csbi.srWindow.Top + 1, 0));
  328. position = new (csbi.srWindow.Left, csbi.srWindow.Top);
  329. SetConsoleOutputWindow (csbi);
  330. var winRect = new SmallRect (0, 0, (short)(sz.Width - 1), (short)Math.Max (sz.Height - 1, 0));
  331. if (!SetConsoleScreenBufferInfoEx (_outputHandle, ref csbi))
  332. {
  333. throw new Win32Exception (Marshal.GetLastWin32Error ());
  334. }
  335. if (!SetConsoleWindowInfo (_outputHandle, true, ref winRect))
  336. {
  337. throw new Win32Exception (Marshal.GetLastWin32Error ());
  338. }
  339. return sz;
  340. }
  341. private uint ConsoleMode
  342. {
  343. get
  344. {
  345. GetConsoleMode (_inputHandle, out uint v);
  346. return v;
  347. }
  348. set => SetConsoleMode (_inputHandle, value);
  349. }
  350. [Flags]
  351. public enum ConsoleModes : uint
  352. {
  353. EnableProcessedInput = 1,
  354. EnableMouseInput = 16,
  355. EnableQuickEditMode = 64,
  356. EnableExtendedFlags = 128
  357. }
  358. [StructLayout (LayoutKind.Explicit, CharSet = CharSet.Unicode)]
  359. public struct KeyEventRecord
  360. {
  361. [FieldOffset (0)]
  362. [MarshalAs (UnmanagedType.Bool)]
  363. public bool bKeyDown;
  364. [FieldOffset (4)]
  365. [MarshalAs (UnmanagedType.U2)]
  366. public ushort wRepeatCount;
  367. [FieldOffset (6)]
  368. [MarshalAs (UnmanagedType.U2)]
  369. public VK wVirtualKeyCode;
  370. [FieldOffset (8)]
  371. [MarshalAs (UnmanagedType.U2)]
  372. public ushort wVirtualScanCode;
  373. [FieldOffset (10)]
  374. public char UnicodeChar;
  375. [FieldOffset (12)]
  376. [MarshalAs (UnmanagedType.U4)]
  377. public ControlKeyState dwControlKeyState;
  378. public readonly override string ToString ()
  379. {
  380. return
  381. $"[KeyEventRecord({(bKeyDown ? "down" : "up")},{wRepeatCount},{wVirtualKeyCode},{wVirtualScanCode},{new Rune (UnicodeChar).MakePrintable ()},{dwControlKeyState})]";
  382. }
  383. }
  384. [Flags]
  385. public enum ButtonState
  386. {
  387. NoButtonPressed = 0,
  388. Button1Pressed = 1,
  389. Button2Pressed = 4,
  390. Button3Pressed = 8,
  391. Button4Pressed = 16,
  392. RightmostButtonPressed = 2
  393. }
  394. [Flags]
  395. public enum ControlKeyState
  396. {
  397. NoControlKeyPressed = 0,
  398. RightAltPressed = 1,
  399. LeftAltPressed = 2,
  400. RightControlPressed = 4,
  401. LeftControlPressed = 8,
  402. ShiftPressed = 16,
  403. NumlockOn = 32,
  404. ScrolllockOn = 64,
  405. CapslockOn = 128,
  406. EnhancedKey = 256
  407. }
  408. [Flags]
  409. public enum EventFlags
  410. {
  411. NoEvent = 0,
  412. MouseMoved = 1,
  413. DoubleClick = 2,
  414. MouseWheeled = 4,
  415. MouseHorizontalWheeled = 8
  416. }
  417. [StructLayout (LayoutKind.Explicit)]
  418. public struct MouseEventRecord
  419. {
  420. [FieldOffset (0)]
  421. public Coord MousePosition;
  422. [FieldOffset (4)]
  423. public ButtonState ButtonState;
  424. [FieldOffset (8)]
  425. public ControlKeyState ControlKeyState;
  426. [FieldOffset (12)]
  427. public EventFlags EventFlags;
  428. public readonly override string ToString () { return $"[Mouse{MousePosition},{ButtonState},{ControlKeyState},{EventFlags}]"; }
  429. }
  430. public struct WindowBufferSizeRecord
  431. {
  432. public Coord _size;
  433. public WindowBufferSizeRecord (short x, short y) { _size = new Coord (x, y); }
  434. public readonly override string ToString () { return $"[WindowBufferSize{_size}"; }
  435. }
  436. [StructLayout (LayoutKind.Sequential)]
  437. public struct MenuEventRecord
  438. {
  439. public uint dwCommandId;
  440. }
  441. [StructLayout (LayoutKind.Sequential)]
  442. public struct FocusEventRecord
  443. {
  444. public uint bSetFocus;
  445. }
  446. public enum EventType : ushort
  447. {
  448. Focus = 0x10,
  449. Key = 0x1,
  450. Menu = 0x8,
  451. Mouse = 2,
  452. WindowBufferSize = 4
  453. }
  454. [StructLayout (LayoutKind.Explicit)]
  455. public struct InputRecord
  456. {
  457. [FieldOffset (0)]
  458. public EventType EventType;
  459. [FieldOffset (4)]
  460. public KeyEventRecord KeyEvent;
  461. [FieldOffset (4)]
  462. public MouseEventRecord MouseEvent;
  463. [FieldOffset (4)]
  464. public WindowBufferSizeRecord WindowBufferSizeEvent;
  465. [FieldOffset (4)]
  466. public MenuEventRecord MenuEvent;
  467. [FieldOffset (4)]
  468. public FocusEventRecord FocusEvent;
  469. public readonly override string ToString ()
  470. {
  471. return EventType switch
  472. {
  473. EventType.Focus => FocusEvent.ToString (),
  474. EventType.Key => KeyEvent.ToString (),
  475. EventType.Menu => MenuEvent.ToString (),
  476. EventType.Mouse => MouseEvent.ToString (),
  477. EventType.WindowBufferSize => WindowBufferSizeEvent.ToString (),
  478. _ => "Unknown event type: " + EventType
  479. };
  480. }
  481. }
  482. [Flags]
  483. private enum ShareMode : uint
  484. {
  485. FileShareRead = 1,
  486. FileShareWrite = 2
  487. }
  488. [Flags]
  489. private enum DesiredAccess : uint
  490. {
  491. GenericRead = 2147483648,
  492. GenericWrite = 1073741824
  493. }
  494. [StructLayout (LayoutKind.Sequential)]
  495. public struct ConsoleScreenBufferInfo
  496. {
  497. public Coord dwSize;
  498. public Coord dwCursorPosition;
  499. public ushort wAttributes;
  500. public SmallRect srWindow;
  501. public Coord dwMaximumWindowSize;
  502. }
  503. [StructLayout (LayoutKind.Sequential)]
  504. public struct Coord
  505. {
  506. public short X;
  507. public short Y;
  508. public Coord (short x, short y)
  509. {
  510. X = x;
  511. Y = y;
  512. }
  513. public readonly override string ToString () { return $"({X},{Y})"; }
  514. }
  515. [StructLayout (LayoutKind.Explicit, CharSet = CharSet.Unicode)]
  516. public struct CharUnion
  517. {
  518. [FieldOffset (0)]
  519. public char UnicodeChar;
  520. [FieldOffset (0)]
  521. public byte AsciiChar;
  522. }
  523. [StructLayout (LayoutKind.Explicit, CharSet = CharSet.Unicode)]
  524. public struct CharInfo
  525. {
  526. [FieldOffset (0)]
  527. public CharUnion Char;
  528. [FieldOffset (2)]
  529. public ushort Attributes;
  530. }
  531. public struct ExtendedCharInfo
  532. {
  533. public char Char { get; set; }
  534. public Attribute Attribute { get; set; }
  535. public bool Empty { get; set; } // TODO: Temp hack until virtual terminal sequences
  536. public ExtendedCharInfo (char character, Attribute attribute)
  537. {
  538. Char = character;
  539. Attribute = attribute;
  540. Empty = false;
  541. }
  542. }
  543. [StructLayout (LayoutKind.Sequential)]
  544. public struct SmallRect
  545. {
  546. public short Left;
  547. public short Top;
  548. public short Right;
  549. public short Bottom;
  550. public SmallRect (short left, short top, short right, short bottom)
  551. {
  552. Left = left;
  553. Top = top;
  554. Right = right;
  555. Bottom = bottom;
  556. }
  557. public static void MakeEmpty (ref SmallRect rect) { rect.Left = -1; }
  558. public static void Update (ref SmallRect rect, short col, short row)
  559. {
  560. if (rect.Left == -1)
  561. {
  562. rect.Left = rect.Right = col;
  563. rect.Bottom = rect.Top = row;
  564. return;
  565. }
  566. if (col >= rect.Left && col <= rect.Right && row >= rect.Top && row <= rect.Bottom)
  567. {
  568. return;
  569. }
  570. if (col < rect.Left)
  571. {
  572. rect.Left = col;
  573. }
  574. if (col > rect.Right)
  575. {
  576. rect.Right = col;
  577. }
  578. if (row < rect.Top)
  579. {
  580. rect.Top = row;
  581. }
  582. if (row > rect.Bottom)
  583. {
  584. rect.Bottom = row;
  585. }
  586. }
  587. public readonly override string ToString () { return $"Left={Left},Top={Top},Right={Right},Bottom={Bottom}"; }
  588. }
  589. [StructLayout (LayoutKind.Sequential)]
  590. public struct ConsoleKeyInfoEx
  591. {
  592. public ConsoleKeyInfo ConsoleKeyInfo;
  593. public bool CapsLock;
  594. public bool NumLock;
  595. public bool ScrollLock;
  596. public ConsoleKeyInfoEx (ConsoleKeyInfo consoleKeyInfo, bool capslock, bool numlock, bool scrolllock)
  597. {
  598. ConsoleKeyInfo = consoleKeyInfo;
  599. CapsLock = capslock;
  600. NumLock = numlock;
  601. ScrollLock = scrolllock;
  602. }
  603. /// <summary>
  604. /// Prints a ConsoleKeyInfoEx structure
  605. /// </summary>
  606. /// <param name="ex"></param>
  607. /// <returns></returns>
  608. public readonly string ToString (ConsoleKeyInfoEx ex)
  609. {
  610. var ke = new Key ((KeyCode)ex.ConsoleKeyInfo.KeyChar);
  611. var sb = new StringBuilder ();
  612. sb.Append ($"Key: {(KeyCode)ex.ConsoleKeyInfo.Key} ({ex.ConsoleKeyInfo.Key})");
  613. sb.Append ((ex.ConsoleKeyInfo.Modifiers & ConsoleModifiers.Shift) != 0 ? " | Shift" : string.Empty);
  614. sb.Append ((ex.ConsoleKeyInfo.Modifiers & ConsoleModifiers.Control) != 0 ? " | Control" : string.Empty);
  615. sb.Append ((ex.ConsoleKeyInfo.Modifiers & ConsoleModifiers.Alt) != 0 ? " | Alt" : string.Empty);
  616. sb.Append ($", KeyChar: {ke.AsRune.MakePrintable ()} ({(uint)ex.ConsoleKeyInfo.KeyChar}) ");
  617. sb.Append (ex.CapsLock ? "caps," : string.Empty);
  618. sb.Append (ex.NumLock ? "num," : string.Empty);
  619. sb.Append (ex.ScrollLock ? "scroll," : string.Empty);
  620. string s = sb.ToString ().TrimEnd (',').TrimEnd (' ');
  621. return $"[ConsoleKeyInfoEx({s})]";
  622. }
  623. }
  624. [DllImport ("kernel32.dll", SetLastError = true)]
  625. private static extern nint GetStdHandle (int nStdHandle);
  626. [DllImport ("kernel32.dll", SetLastError = true)]
  627. private static extern bool CloseHandle (nint handle);
  628. [DllImport ("kernel32.dll", EntryPoint = "ReadConsoleInputW", CharSet = CharSet.Unicode)]
  629. public static extern bool ReadConsoleInput (
  630. nint hConsoleInput,
  631. nint lpBuffer,
  632. uint nLength,
  633. out uint lpNumberOfEventsRead
  634. );
  635. [DllImport ("kernel32.dll", SetLastError = true, CharSet = CharSet.Unicode)]
  636. private static extern bool ReadConsoleOutput (
  637. nint hConsoleOutput,
  638. [Out] CharInfo [] lpBuffer,
  639. Coord dwBufferSize,
  640. Coord dwBufferCoord,
  641. ref SmallRect lpReadRegion
  642. );
  643. // TODO: This API is obsolete. See https://learn.microsoft.com/en-us/windows/console/writeconsoleoutput
  644. [DllImport ("kernel32.dll", EntryPoint = "WriteConsoleOutputW", SetLastError = true, CharSet = CharSet.Unicode)]
  645. private static extern bool WriteConsoleOutput (
  646. nint hConsoleOutput,
  647. CharInfo [] lpBuffer,
  648. Coord dwBufferSize,
  649. Coord dwBufferCoord,
  650. ref SmallRect lpWriteRegion
  651. );
  652. [DllImport ("kernel32.dll", EntryPoint = "WriteConsole", SetLastError = true, CharSet = CharSet.Unicode)]
  653. private static extern bool WriteConsole (
  654. nint hConsoleOutput,
  655. string lpbufer,
  656. uint NumberOfCharsToWriten,
  657. out uint lpNumberOfCharsWritten,
  658. nint lpReserved
  659. );
  660. [DllImport ("kernel32.dll")]
  661. private static extern bool SetConsoleCursorPosition (nint hConsoleOutput, Coord dwCursorPosition);
  662. [StructLayout (LayoutKind.Sequential)]
  663. public struct ConsoleCursorInfo
  664. {
  665. /// <summary>
  666. /// The percentage of the character cell that is filled by the cursor.This value is between 1 and 100.
  667. /// The cursor appearance varies, ranging from completely filling the cell to showing up as a horizontal
  668. /// line at the bottom of the cell.
  669. /// </summary>
  670. public uint dwSize;
  671. public bool bVisible;
  672. }
  673. [DllImport ("kernel32.dll", SetLastError = true)]
  674. private static extern bool SetConsoleCursorInfo (nint hConsoleOutput, [In] ref ConsoleCursorInfo lpConsoleCursorInfo);
  675. [DllImport ("kernel32.dll", SetLastError = true)]
  676. private static extern bool GetConsoleCursorInfo (nint hConsoleOutput, out ConsoleCursorInfo lpConsoleCursorInfo);
  677. [DllImport ("kernel32.dll")]
  678. private static extern bool GetConsoleMode (nint hConsoleHandle, out uint lpMode);
  679. [DllImport ("kernel32.dll")]
  680. private static extern bool SetConsoleMode (nint hConsoleHandle, uint dwMode);
  681. [DllImport ("kernel32.dll", SetLastError = true)]
  682. private static extern nint CreateConsoleScreenBuffer (
  683. DesiredAccess dwDesiredAccess,
  684. ShareMode dwShareMode,
  685. nint secutiryAttributes,
  686. uint flags,
  687. nint screenBufferData
  688. );
  689. internal static nint INVALID_HANDLE_VALUE = new (-1);
  690. [DllImport ("kernel32.dll", SetLastError = true)]
  691. private static extern bool SetConsoleActiveScreenBuffer (nint Handle);
  692. [DllImport ("kernel32.dll", SetLastError = true)]
  693. private static extern bool GetNumberOfConsoleInputEvents (nint handle, out uint lpcNumberOfEvents);
  694. internal uint GetNumberOfConsoleInputEvents ()
  695. {
  696. if (!GetNumberOfConsoleInputEvents (_inputHandle, out uint numOfEvents))
  697. {
  698. Console.WriteLine ($"Error: {Marshal.GetLastWin32Error ()}");
  699. return 0;
  700. }
  701. return numOfEvents;
  702. }
  703. [DllImport ("kernel32.dll", SetLastError = true)]
  704. private static extern bool FlushConsoleInputBuffer (nint handle);
  705. internal void FlushConsoleInputBuffer ()
  706. {
  707. if (!FlushConsoleInputBuffer (_inputHandle))
  708. {
  709. Console.WriteLine ($"Error: {Marshal.GetLastWin32Error ()}");
  710. }
  711. }
  712. public InputRecord [] ReadConsoleInput ()
  713. {
  714. const int bufferSize = 1;
  715. nint pRecord = Marshal.AllocHGlobal (Marshal.SizeOf<InputRecord> () * bufferSize);
  716. try
  717. {
  718. ReadConsoleInput (
  719. _inputHandle,
  720. pRecord,
  721. bufferSize,
  722. out uint numberEventsRead);
  723. return numberEventsRead == 0
  724. ? null
  725. : new [] { Marshal.PtrToStructure<InputRecord> (pRecord) };
  726. }
  727. catch (Exception)
  728. {
  729. return null;
  730. }
  731. finally
  732. {
  733. Marshal.FreeHGlobal (pRecord);
  734. }
  735. }
  736. #if false // Not needed on the constructor. Perhaps could be used on resizing. To study.
  737. [DllImport ("kernel32.dll", ExactSpelling = true)]
  738. static extern IntPtr GetConsoleWindow ();
  739. [DllImport ("user32.dll", CharSet = CharSet.Auto, SetLastError = true)]
  740. static extern bool ShowWindow (IntPtr hWnd, int nCmdShow);
  741. public const int HIDE = 0;
  742. public const int MAXIMIZE = 3;
  743. public const int MINIMIZE = 6;
  744. public const int RESTORE = 9;
  745. internal void ShowWindow (int state)
  746. {
  747. IntPtr thisConsole = GetConsoleWindow ();
  748. ShowWindow (thisConsole, state);
  749. }
  750. #endif
  751. // See: https://github.com/gui-cs/Terminal.Gui/issues/357
  752. [StructLayout (LayoutKind.Sequential)]
  753. public struct CONSOLE_SCREEN_BUFFER_INFOEX
  754. {
  755. public uint cbSize;
  756. public Coord dwSize;
  757. public Coord dwCursorPosition;
  758. public ushort wAttributes;
  759. public SmallRect srWindow;
  760. public Coord dwMaximumWindowSize;
  761. public ushort wPopupAttributes;
  762. public bool bFullscreenSupported;
  763. [MarshalAs (UnmanagedType.ByValArray, SizeConst = 16)]
  764. public COLORREF [] ColorTable;
  765. }
  766. [StructLayout (LayoutKind.Explicit, Size = 4)]
  767. public struct COLORREF
  768. {
  769. public COLORREF (byte r, byte g, byte b)
  770. {
  771. Value = 0;
  772. R = r;
  773. G = g;
  774. B = b;
  775. }
  776. public COLORREF (uint value)
  777. {
  778. R = 0;
  779. G = 0;
  780. B = 0;
  781. Value = value & 0x00FFFFFF;
  782. }
  783. [FieldOffset (0)]
  784. public byte R;
  785. [FieldOffset (1)]
  786. public byte G;
  787. [FieldOffset (2)]
  788. public byte B;
  789. [FieldOffset (0)]
  790. public uint Value;
  791. }
  792. [DllImport ("kernel32.dll", SetLastError = true)]
  793. private static extern bool GetConsoleScreenBufferInfoEx (nint hConsoleOutput, ref CONSOLE_SCREEN_BUFFER_INFOEX csbi);
  794. [DllImport ("kernel32.dll", SetLastError = true)]
  795. private static extern bool SetConsoleScreenBufferInfoEx (nint hConsoleOutput, ref CONSOLE_SCREEN_BUFFER_INFOEX ConsoleScreenBufferInfo);
  796. [DllImport ("kernel32.dll", SetLastError = true)]
  797. private static extern bool SetConsoleWindowInfo (
  798. nint hConsoleOutput,
  799. bool bAbsolute,
  800. [In] ref SmallRect lpConsoleWindow
  801. );
  802. [DllImport ("kernel32.dll", SetLastError = true)]
  803. private static extern Coord GetLargestConsoleWindowSize (
  804. nint hConsoleOutput
  805. );
  806. }
  807. internal class WindowsDriver : ConsoleDriver
  808. {
  809. private readonly bool _isWindowsTerminal;
  810. private WindowsConsole.SmallRect _damageRegion;
  811. private bool _isButtonDoubleClicked;
  812. private bool _isButtonPressed;
  813. private bool _isButtonReleased;
  814. private bool _isOneFingerDoubleClicked;
  815. private WindowsConsole.ButtonState? _lastMouseButtonPressed;
  816. private WindowsMainLoop _mainLoopDriver;
  817. private WindowsConsole.ExtendedCharInfo [] _outputBuffer;
  818. private Point? _point;
  819. private Point _pointMove;
  820. private bool _processButtonClick;
  821. public WindowsDriver ()
  822. {
  823. if (Environment.OSVersion.Platform == PlatformID.Win32NT)
  824. {
  825. WinConsole = new WindowsConsole ();
  826. // otherwise we're probably running in unit tests
  827. Clipboard = new WindowsClipboard ();
  828. }
  829. else
  830. {
  831. Clipboard = new FakeDriver.FakeClipboard ();
  832. }
  833. // TODO: if some other Windows-based terminal supports true color, update this logic to not
  834. // force 16color mode (.e.g ConEmu which really doesn't work well at all).
  835. _isWindowsTerminal = _isWindowsTerminal =
  836. Environment.GetEnvironmentVariable ("WT_SESSION") is { } || Environment.GetEnvironmentVariable ("VSAPPIDNAME") != null;
  837. if (!_isWindowsTerminal)
  838. {
  839. Force16Colors = true;
  840. }
  841. }
  842. public override bool SupportsTrueColor => RunningUnitTests || (Environment.OSVersion.Version.Build >= 14931 && _isWindowsTerminal);
  843. /// <inheritdoc />
  844. public override bool IsReportingMouseMoves
  845. {
  846. get => _isReportingMouseMoves;
  847. internal set => _isReportingMouseMoves = value;
  848. }
  849. /// <inheritdoc />
  850. public override bool IsSuspendRead
  851. {
  852. get => _isSuspendRead;
  853. internal set => _isSuspendRead = value;
  854. }
  855. public WindowsConsole WinConsole { get; private set; }
  856. public WindowsConsole.KeyEventRecord FromVKPacketToKeyEventRecord (WindowsConsole.KeyEventRecord keyEvent)
  857. {
  858. if (keyEvent.wVirtualKeyCode != (VK)ConsoleKey.Packet)
  859. {
  860. return keyEvent;
  861. }
  862. var mod = new ConsoleModifiers ();
  863. if (keyEvent.dwControlKeyState.HasFlag (WindowsConsole.ControlKeyState.ShiftPressed))
  864. {
  865. mod |= ConsoleModifiers.Shift;
  866. }
  867. if (keyEvent.dwControlKeyState.HasFlag (WindowsConsole.ControlKeyState.RightAltPressed)
  868. || keyEvent.dwControlKeyState.HasFlag (WindowsConsole.ControlKeyState.LeftAltPressed))
  869. {
  870. mod |= ConsoleModifiers.Alt;
  871. }
  872. if (keyEvent.dwControlKeyState.HasFlag (WindowsConsole.ControlKeyState.LeftControlPressed)
  873. || keyEvent.dwControlKeyState.HasFlag (WindowsConsole.ControlKeyState.RightControlPressed))
  874. {
  875. mod |= ConsoleModifiers.Control;
  876. }
  877. var cKeyInfo = new ConsoleKeyInfo (
  878. keyEvent.UnicodeChar,
  879. (ConsoleKey)keyEvent.wVirtualKeyCode,
  880. mod.HasFlag (ConsoleModifiers.Shift),
  881. mod.HasFlag (ConsoleModifiers.Alt),
  882. mod.HasFlag (ConsoleModifiers.Control));
  883. cKeyInfo = DecodeVKPacketToKConsoleKeyInfo (cKeyInfo);
  884. uint scanCode = GetScanCodeFromConsoleKeyInfo (cKeyInfo);
  885. return new WindowsConsole.KeyEventRecord
  886. {
  887. UnicodeChar = cKeyInfo.KeyChar,
  888. bKeyDown = keyEvent.bKeyDown,
  889. dwControlKeyState = keyEvent.dwControlKeyState,
  890. wRepeatCount = keyEvent.wRepeatCount,
  891. wVirtualKeyCode = (VK)cKeyInfo.Key,
  892. wVirtualScanCode = (ushort)scanCode
  893. };
  894. }
  895. public override bool IsRuneSupported (Rune rune) { return base.IsRuneSupported (rune) && rune.IsBmp; }
  896. public override void Refresh ()
  897. {
  898. UpdateScreen ();
  899. //WinConsole?.SetInitialCursorVisibility ();
  900. UpdateCursor ();
  901. }
  902. public override void SendKeys (char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
  903. {
  904. var input = new WindowsConsole.InputRecord
  905. {
  906. EventType = WindowsConsole.EventType.Key
  907. };
  908. var keyEvent = new WindowsConsole.KeyEventRecord
  909. {
  910. bKeyDown = true
  911. };
  912. var controlKey = new WindowsConsole.ControlKeyState ();
  913. if (shift)
  914. {
  915. controlKey |= WindowsConsole.ControlKeyState.ShiftPressed;
  916. keyEvent.UnicodeChar = '\0';
  917. keyEvent.wVirtualKeyCode = VK.SHIFT;
  918. }
  919. if (alt)
  920. {
  921. controlKey |= WindowsConsole.ControlKeyState.LeftAltPressed;
  922. controlKey |= WindowsConsole.ControlKeyState.RightAltPressed;
  923. keyEvent.UnicodeChar = '\0';
  924. keyEvent.wVirtualKeyCode = VK.MENU;
  925. }
  926. if (control)
  927. {
  928. controlKey |= WindowsConsole.ControlKeyState.LeftControlPressed;
  929. controlKey |= WindowsConsole.ControlKeyState.RightControlPressed;
  930. keyEvent.UnicodeChar = '\0';
  931. keyEvent.wVirtualKeyCode = VK.CONTROL;
  932. }
  933. keyEvent.dwControlKeyState = controlKey;
  934. input.KeyEvent = keyEvent;
  935. if (shift || alt || control)
  936. {
  937. ProcessInput (input);
  938. }
  939. keyEvent.UnicodeChar = keyChar;
  940. //if ((uint)key < 255) {
  941. // keyEvent.wVirtualKeyCode = (ushort)key;
  942. //} else {
  943. // keyEvent.wVirtualKeyCode = '\0';
  944. //}
  945. keyEvent.wVirtualKeyCode = (VK)key;
  946. input.KeyEvent = keyEvent;
  947. try
  948. {
  949. ProcessInput (input);
  950. }
  951. catch (OverflowException)
  952. { }
  953. finally
  954. {
  955. keyEvent.bKeyDown = false;
  956. input.KeyEvent = keyEvent;
  957. ProcessInput (input);
  958. }
  959. }
  960. /// <inheritdoc />
  961. public override void StartReportingMouseMoves () { throw new NotImplementedException (); }
  962. /// <inheritdoc />
  963. public override void StopReportingMouseMoves () { throw new NotImplementedException (); }
  964. #region Not Implemented
  965. public override void Suspend () { throw new NotImplementedException (); }
  966. #endregion
  967. public WindowsConsole.ConsoleKeyInfoEx ToConsoleKeyInfoEx (WindowsConsole.KeyEventRecord keyEvent)
  968. {
  969. WindowsConsole.ControlKeyState state = keyEvent.dwControlKeyState;
  970. bool shift = (state & WindowsConsole.ControlKeyState.ShiftPressed) != 0;
  971. bool alt = (state & (WindowsConsole.ControlKeyState.LeftAltPressed | WindowsConsole.ControlKeyState.RightAltPressed)) != 0;
  972. bool control = (state & (WindowsConsole.ControlKeyState.LeftControlPressed | WindowsConsole.ControlKeyState.RightControlPressed)) != 0;
  973. bool capslock = (state & WindowsConsole.ControlKeyState.CapslockOn) != 0;
  974. bool numlock = (state & WindowsConsole.ControlKeyState.NumlockOn) != 0;
  975. bool scrolllock = (state & WindowsConsole.ControlKeyState.ScrolllockOn) != 0;
  976. var cki = new ConsoleKeyInfo (keyEvent.UnicodeChar, (ConsoleKey)keyEvent.wVirtualKeyCode, shift, alt, control);
  977. return new WindowsConsole.ConsoleKeyInfoEx (cki, capslock, numlock, scrolllock);
  978. }
  979. #region Cursor Handling
  980. private CursorVisibility? _cachedCursorVisibility;
  981. private bool _isReportingMouseMoves;
  982. private bool _isSuspendRead;
  983. public override void UpdateCursor ()
  984. {
  985. if (Col < 0 || Row < 0 || Col >= Cols || Row >= Rows)
  986. {
  987. GetCursorVisibility (out CursorVisibility cursorVisibility);
  988. _cachedCursorVisibility = cursorVisibility;
  989. SetCursorVisibility (CursorVisibility.Invisible);
  990. return;
  991. }
  992. var position = new WindowsConsole.Coord
  993. {
  994. X = (short)Col,
  995. Y = (short)Row
  996. };
  997. if (Force16Colors)
  998. {
  999. WinConsole?.SetCursorPosition (position);
  1000. }
  1001. else
  1002. {
  1003. var sb = new StringBuilder ();
  1004. sb.Append (EscSeqUtils.CSI_SetCursorPosition (position.Y + 1, position.X + 1));
  1005. WinConsole?.WriteANSI (sb.ToString ());
  1006. }
  1007. if (_cachedCursorVisibility is { })
  1008. {
  1009. SetCursorVisibility (_cachedCursorVisibility.Value);
  1010. }
  1011. //EnsureCursorVisibility ();
  1012. }
  1013. /// <inheritdoc/>
  1014. public override bool GetCursorVisibility (out CursorVisibility visibility)
  1015. {
  1016. if (WinConsole is { })
  1017. {
  1018. return WinConsole.GetCursorVisibility (out visibility);
  1019. }
  1020. visibility = _cachedCursorVisibility ?? CursorVisibility.Default;
  1021. return true;
  1022. }
  1023. /// <inheritdoc/>
  1024. public override bool SetCursorVisibility (CursorVisibility visibility)
  1025. {
  1026. _cachedCursorVisibility = visibility;
  1027. if (Force16Colors)
  1028. {
  1029. return WinConsole is null || WinConsole.SetCursorVisibility (visibility);
  1030. }
  1031. else
  1032. {
  1033. var sb = new StringBuilder ();
  1034. sb.Append (visibility != CursorVisibility.Invisible ? EscSeqUtils.CSI_ShowCursor : EscSeqUtils.CSI_HideCursor);
  1035. return WinConsole?.WriteANSI (sb.ToString ()) ?? false;
  1036. }
  1037. }
  1038. /// <inheritdoc/>
  1039. public override bool EnsureCursorVisibility ()
  1040. {
  1041. if (Force16Colors)
  1042. {
  1043. return WinConsole is null || WinConsole.EnsureCursorVisibility ();
  1044. }
  1045. else
  1046. {
  1047. var sb = new StringBuilder ();
  1048. sb.Append (_cachedCursorVisibility != CursorVisibility.Invisible ? EscSeqUtils.CSI_ShowCursor : EscSeqUtils.CSI_HideCursor);
  1049. return WinConsole?.WriteANSI (sb.ToString ()) ?? false;
  1050. }
  1051. //if (!(Col >= 0 && Row >= 0 && Col < Cols && Row < Rows))
  1052. //{
  1053. // GetCursorVisibility (out CursorVisibility cursorVisibility);
  1054. // _cachedCursorVisibility = cursorVisibility;
  1055. // SetCursorVisibility (CursorVisibility.Invisible);
  1056. // return false;
  1057. //}
  1058. //SetCursorVisibility (_cachedCursorVisibility ?? CursorVisibility.Default);
  1059. //return _cachedCursorVisibility == CursorVisibility.Default;
  1060. }
  1061. #endregion Cursor Handling
  1062. public override void UpdateScreen ()
  1063. {
  1064. Size windowSize = WinConsole?.GetConsoleBufferWindow (out Point _) ?? new Size (Cols, Rows);
  1065. if (!windowSize.IsEmpty && (windowSize.Width != Cols || windowSize.Height != Rows))
  1066. {
  1067. return;
  1068. }
  1069. var bufferCoords = new WindowsConsole.Coord
  1070. {
  1071. X = (short)Cols, //Clip.Width,
  1072. Y = (short)Rows, //Clip.Height
  1073. };
  1074. for (var row = 0; row < Rows; row++)
  1075. {
  1076. if (!_dirtyLines [row])
  1077. {
  1078. continue;
  1079. }
  1080. _dirtyLines [row] = false;
  1081. for (var col = 0; col < Cols; col++)
  1082. {
  1083. int position = row * Cols + col;
  1084. _outputBuffer [position].Attribute = Contents [row, col].Attribute.GetValueOrDefault ();
  1085. if (Contents [row, col].IsDirty == false)
  1086. {
  1087. _outputBuffer [position].Empty = true;
  1088. _outputBuffer [position].Char = (char)Rune.ReplacementChar.Value;
  1089. continue;
  1090. }
  1091. _outputBuffer [position].Empty = false;
  1092. if (Contents [row, col].Rune.IsBmp)
  1093. {
  1094. _outputBuffer [position].Char = (char)Contents [row, col].Rune.Value;
  1095. }
  1096. else
  1097. {
  1098. //_outputBuffer [position].Empty = true;
  1099. _outputBuffer [position].Char = (char)Rune.ReplacementChar.Value;
  1100. if (Contents [row, col].Rune.GetColumns () > 1 && col + 1 < Cols)
  1101. {
  1102. // TODO: This is a hack to deal with non-BMP and wide characters.
  1103. col++;
  1104. position = row * Cols + col;
  1105. _outputBuffer [position].Empty = false;
  1106. _outputBuffer [position].Char = ' ';
  1107. }
  1108. }
  1109. }
  1110. }
  1111. _damageRegion = new WindowsConsole.SmallRect
  1112. {
  1113. Top = 0,
  1114. Left = 0,
  1115. Bottom = (short)Rows,
  1116. Right = (short)Cols
  1117. };
  1118. if (!RunningUnitTests
  1119. && WinConsole != null
  1120. && !WinConsole.WriteToConsole (new (Cols, Rows), _outputBuffer, bufferCoords, _damageRegion, Force16Colors))
  1121. {
  1122. int err = Marshal.GetLastWin32Error ();
  1123. if (err != 0)
  1124. {
  1125. throw new Win32Exception (err);
  1126. }
  1127. }
  1128. WindowsConsole.SmallRect.MakeEmpty (ref _damageRegion);
  1129. }
  1130. internal override void End ()
  1131. {
  1132. if (_mainLoopDriver is { })
  1133. {
  1134. #if HACK_CHECK_WINCHANGED
  1135. _mainLoopDriver.WinChanged -= ChangeWin;
  1136. #endif
  1137. }
  1138. _mainLoopDriver = null;
  1139. WinConsole?.Cleanup ();
  1140. WinConsole = null;
  1141. if (!RunningUnitTests && _isWindowsTerminal)
  1142. {
  1143. // Disable alternative screen buffer.
  1144. Console.Out.Write (EscSeqUtils.CSI_RestoreCursorAndRestoreAltBufferWithBackscroll);
  1145. }
  1146. }
  1147. internal override MainLoop Init ()
  1148. {
  1149. _mainLoopDriver = new WindowsMainLoop (this);
  1150. if (!RunningUnitTests)
  1151. {
  1152. try
  1153. {
  1154. if (WinConsole is { })
  1155. {
  1156. // BUGBUG: The results from GetConsoleOutputWindow are incorrect when called from Init.
  1157. // Our thread in WindowsMainLoop.CheckWin will get the correct results. See #if HACK_CHECK_WINCHANGED
  1158. Size winSize = WinConsole.GetConsoleOutputWindow (out Point pos);
  1159. Cols = winSize.Width;
  1160. Rows = winSize.Height;
  1161. }
  1162. WindowsConsole.SmallRect.MakeEmpty (ref _damageRegion);
  1163. if (_isWindowsTerminal)
  1164. {
  1165. Console.Out.Write (EscSeqUtils.CSI_SaveCursorAndActivateAltBufferNoBackscroll);
  1166. }
  1167. }
  1168. catch (Win32Exception e)
  1169. {
  1170. // We are being run in an environment that does not support a console
  1171. // such as a unit test, or a pipe.
  1172. Debug.WriteLine ($"Likely running unit tests. Setting WinConsole to null so we can test it elsewhere. Exception: {e}");
  1173. WinConsole = null;
  1174. }
  1175. }
  1176. CurrentAttribute = new Attribute (Color.White, Color.Black);
  1177. _outputBuffer = new WindowsConsole.ExtendedCharInfo [Rows * Cols];
  1178. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1179. Clip = new (0, 0, Cols, Rows);
  1180. _damageRegion = new WindowsConsole.SmallRect
  1181. {
  1182. Top = 0,
  1183. Left = 0,
  1184. Bottom = (short)Rows,
  1185. Right = (short)Cols
  1186. };
  1187. ClearContents ();
  1188. #if HACK_CHECK_WINCHANGED
  1189. _mainLoopDriver.WinChanged = ChangeWin;
  1190. #endif
  1191. WinConsole?.SetInitialCursorVisibility ();
  1192. return new MainLoop (_mainLoopDriver);
  1193. }
  1194. internal void ProcessInput (WindowsConsole.InputRecord inputEvent)
  1195. {
  1196. switch (inputEvent.EventType)
  1197. {
  1198. case WindowsConsole.EventType.Key:
  1199. if (inputEvent.KeyEvent.wVirtualKeyCode == (VK)ConsoleKey.Packet)
  1200. {
  1201. // Used to pass Unicode characters as if they were keystrokes.
  1202. // The VK_PACKET key is the low word of a 32-bit
  1203. // Virtual Key value used for non-keyboard input methods.
  1204. inputEvent.KeyEvent = FromVKPacketToKeyEventRecord (inputEvent.KeyEvent);
  1205. }
  1206. WindowsConsole.ConsoleKeyInfoEx keyInfo = ToConsoleKeyInfoEx (inputEvent.KeyEvent);
  1207. //Debug.WriteLine ($"event: KBD: {GetKeyboardLayoutName()} {inputEvent.ToString ()} {keyInfo.ToString (keyInfo)}");
  1208. KeyCode map = MapKey (keyInfo);
  1209. if (map == KeyCode.Null)
  1210. {
  1211. break;
  1212. }
  1213. if (inputEvent.KeyEvent.bKeyDown)
  1214. {
  1215. // Avoid sending repeat key down events
  1216. OnKeyDown (new Key (map));
  1217. }
  1218. else
  1219. {
  1220. OnKeyUp (new Key (map));
  1221. }
  1222. break;
  1223. case WindowsConsole.EventType.Mouse:
  1224. MouseEventArgs me = ToDriverMouse (inputEvent.MouseEvent);
  1225. if (me is null || me.Flags == MouseFlags.None)
  1226. {
  1227. break;
  1228. }
  1229. OnMouseEvent (me);
  1230. if (_processButtonClick)
  1231. {
  1232. OnMouseEvent (new ()
  1233. {
  1234. Position = me.Position,
  1235. Flags = ProcessButtonClick (inputEvent.MouseEvent)
  1236. });
  1237. }
  1238. break;
  1239. case WindowsConsole.EventType.Focus:
  1240. break;
  1241. #if !HACK_CHECK_WINCHANGED
  1242. case WindowsConsole.EventType.WindowBufferSize:
  1243. Cols = inputEvent.WindowBufferSizeEvent._size.X;
  1244. Rows = inputEvent.WindowBufferSizeEvent._size.Y;
  1245. ResizeScreen ();
  1246. ClearContents ();
  1247. TerminalResized.Invoke ();
  1248. break;
  1249. #endif
  1250. }
  1251. }
  1252. #if HACK_CHECK_WINCHANGED
  1253. private void ChangeWin (object s, SizeChangedEventArgs e)
  1254. {
  1255. if (e.Size is null)
  1256. {
  1257. return;
  1258. }
  1259. int w = e.Size.Value.Width;
  1260. if (w == Cols - 3 && e.Size.Value.Height < Rows)
  1261. {
  1262. w += 3;
  1263. }
  1264. Left = 0;
  1265. Top = 0;
  1266. Cols = e.Size.Value.Width;
  1267. Rows = e.Size.Value.Height;
  1268. if (!RunningUnitTests)
  1269. {
  1270. Size newSize = WinConsole.SetConsoleWindow (
  1271. (short)Math.Max (w, 16),
  1272. (short)Math.Max (e.Size.Value.Height, 0));
  1273. Cols = newSize.Width;
  1274. Rows = newSize.Height;
  1275. }
  1276. ResizeScreen ();
  1277. ClearContents ();
  1278. OnSizeChanged (new SizeChangedEventArgs (new (Cols, Rows)));
  1279. }
  1280. #endif
  1281. private KeyCode MapKey (WindowsConsole.ConsoleKeyInfoEx keyInfoEx)
  1282. {
  1283. ConsoleKeyInfo keyInfo = keyInfoEx.ConsoleKeyInfo;
  1284. switch (keyInfo.Key)
  1285. {
  1286. case ConsoleKey.D0:
  1287. case ConsoleKey.D1:
  1288. case ConsoleKey.D2:
  1289. case ConsoleKey.D3:
  1290. case ConsoleKey.D4:
  1291. case ConsoleKey.D5:
  1292. case ConsoleKey.D6:
  1293. case ConsoleKey.D7:
  1294. case ConsoleKey.D8:
  1295. case ConsoleKey.D9:
  1296. case ConsoleKey.NumPad0:
  1297. case ConsoleKey.NumPad1:
  1298. case ConsoleKey.NumPad2:
  1299. case ConsoleKey.NumPad3:
  1300. case ConsoleKey.NumPad4:
  1301. case ConsoleKey.NumPad5:
  1302. case ConsoleKey.NumPad6:
  1303. case ConsoleKey.NumPad7:
  1304. case ConsoleKey.NumPad8:
  1305. case ConsoleKey.NumPad9:
  1306. case ConsoleKey.Oem1:
  1307. case ConsoleKey.Oem2:
  1308. case ConsoleKey.Oem3:
  1309. case ConsoleKey.Oem4:
  1310. case ConsoleKey.Oem5:
  1311. case ConsoleKey.Oem6:
  1312. case ConsoleKey.Oem7:
  1313. case ConsoleKey.Oem8:
  1314. case ConsoleKey.Oem102:
  1315. case ConsoleKey.Multiply:
  1316. case ConsoleKey.Add:
  1317. case ConsoleKey.Separator:
  1318. case ConsoleKey.Subtract:
  1319. case ConsoleKey.Decimal:
  1320. case ConsoleKey.Divide:
  1321. case ConsoleKey.OemPeriod:
  1322. case ConsoleKey.OemComma:
  1323. case ConsoleKey.OemPlus:
  1324. case ConsoleKey.OemMinus:
  1325. // These virtual key codes are mapped differently depending on the keyboard layout in use.
  1326. // We use the Win32 API to map them to the correct character.
  1327. uint mapResult = MapVKtoChar ((VK)keyInfo.Key);
  1328. if (mapResult == 0)
  1329. {
  1330. // There is no mapping - this should not happen
  1331. Debug.Assert (mapResult != 0, $@"Unable to map the virtual key code {keyInfo.Key}.");
  1332. return KeyCode.Null;
  1333. }
  1334. // An un-shifted character value is in the low order word of the return value.
  1335. var mappedChar = (char)(mapResult & 0x0000FFFF);
  1336. if (keyInfo.KeyChar == 0)
  1337. {
  1338. // If the keyChar is 0, keyInfo.Key value is not a printable character.
  1339. // Dead keys (diacritics) are indicated by setting the top bit of the return value.
  1340. if ((mapResult & 0x80000000) != 0)
  1341. {
  1342. // Dead key (e.g. Oem2 '~'/'^' on POR keyboard)
  1343. // Option 1: Throw it out.
  1344. // - Apps will never see the dead keys
  1345. // - If user presses a key that can be combined with the dead key ('a'), the right thing happens (app will see '�').
  1346. // - NOTE: With Dead Keys, KeyDown != KeyUp. The KeyUp event will have just the base char ('a').
  1347. // - If user presses dead key again, the right thing happens (app will see `~~`)
  1348. // - This is what Notepad etc... appear to do
  1349. // Option 2: Expand the API to indicate the KeyCode is a dead key
  1350. // - Enables apps to do their own dead key processing
  1351. // - Adds complexity; no dev has asked for this (yet).
  1352. // We choose Option 1 for now.
  1353. return KeyCode.Null;
  1354. // Note: Ctrl-Deadkey (like Oem3 '`'/'~` on ENG) can't be supported.
  1355. // Sadly, the charVal is just the deadkey and subsequent key events do not contain
  1356. // any info that the previous event was a deadkey.
  1357. // Note WT does not support Ctrl-Deadkey either.
  1358. }
  1359. if (keyInfo.Modifiers != 0)
  1360. {
  1361. // These Oem keys have well-defined chars. We ensure the representative char is used.
  1362. // If we don't do this, then on some keyboard layouts the wrong char is
  1363. // returned (e.g. on ENG OemPlus un-shifted is =, not +). This is important
  1364. // for key persistence ("Ctrl++" vs. "Ctrl+=").
  1365. mappedChar = keyInfo.Key switch
  1366. {
  1367. ConsoleKey.OemPeriod => '.',
  1368. ConsoleKey.OemComma => ',',
  1369. ConsoleKey.OemPlus => '+',
  1370. ConsoleKey.OemMinus => '-',
  1371. _ => mappedChar
  1372. };
  1373. }
  1374. // Return the mappedChar with modifiers. Because mappedChar is un-shifted, if Shift was down
  1375. // we should keep it
  1376. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)mappedChar);
  1377. }
  1378. // KeyChar is printable
  1379. if (keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt) && keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control))
  1380. {
  1381. // AltGr support - AltGr is equivalent to Ctrl+Alt - the correct char is in KeyChar
  1382. return (KeyCode)keyInfo.KeyChar;
  1383. }
  1384. if (keyInfo.Modifiers != ConsoleModifiers.Shift)
  1385. {
  1386. // If Shift wasn't down we don't need to do anything but return the mappedChar
  1387. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)mappedChar);
  1388. }
  1389. // Strip off Shift - We got here because they KeyChar from Windows is the shifted char (e.g. "�")
  1390. // and passing on Shift would be redundant.
  1391. return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.KeyChar);
  1392. }
  1393. // A..Z are special cased:
  1394. // - Alone, they represent lowercase a...z
  1395. // - With ShiftMask they are A..Z
  1396. // - If CapsLock is on the above is reversed.
  1397. // - If Alt and/or Ctrl are present, treat as upper case
  1398. if (keyInfo.Key is >= ConsoleKey.A and <= ConsoleKey.Z)
  1399. {
  1400. if (keyInfo.KeyChar == 0)
  1401. {
  1402. // KeyChar is not printable - possibly an AltGr key?
  1403. // AltGr support - AltGr is equivalent to Ctrl+Alt
  1404. if (keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt) && keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control))
  1405. {
  1406. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)(uint)keyInfo.Key);
  1407. }
  1408. }
  1409. if (keyInfo.Modifiers.HasFlag (ConsoleModifiers.Alt) || keyInfo.Modifiers.HasFlag (ConsoleModifiers.Control))
  1410. {
  1411. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)(uint)keyInfo.Key);
  1412. }
  1413. if ((keyInfo.Modifiers == ConsoleModifiers.Shift) ^ keyInfoEx.CapsLock)
  1414. {
  1415. // If (ShiftMask is on and CapsLock is off) or (ShiftMask is off and CapsLock is on) add the ShiftMask
  1416. if (char.IsUpper (keyInfo.KeyChar))
  1417. {
  1418. return (KeyCode)(uint)keyInfo.Key | KeyCode.ShiftMask;
  1419. }
  1420. }
  1421. // Return the Key (not KeyChar!)
  1422. return (KeyCode)keyInfo.Key;
  1423. }
  1424. // Handle control keys whose VK codes match the related ASCII value (those below ASCII 33) like ESC
  1425. if (Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key))
  1426. {
  1427. // If the key is JUST a modifier, return it as just that key
  1428. if (keyInfo.Key == (ConsoleKey)VK.SHIFT)
  1429. { // Shift 16
  1430. return KeyCode.ShiftMask;
  1431. }
  1432. if (keyInfo.Key == (ConsoleKey)VK.CONTROL)
  1433. { // Ctrl 17
  1434. return KeyCode.CtrlMask;
  1435. }
  1436. if (keyInfo.Key == (ConsoleKey)VK.MENU)
  1437. { // Alt 18
  1438. return KeyCode.AltMask;
  1439. }
  1440. if (keyInfo.KeyChar == 0)
  1441. {
  1442. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)keyInfo.KeyChar);
  1443. }
  1444. if (keyInfo.Key != ConsoleKey.None)
  1445. {
  1446. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)keyInfo.KeyChar);
  1447. }
  1448. return MapToKeyCodeModifiers (keyInfo.Modifiers & ~ConsoleModifiers.Shift, (KeyCode)keyInfo.KeyChar);
  1449. }
  1450. // Handle control keys (e.g. CursorUp)
  1451. if (Enum.IsDefined (typeof (KeyCode), (uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint))
  1452. {
  1453. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)((uint)keyInfo.Key + (uint)KeyCode.MaxCodePoint));
  1454. }
  1455. return MapToKeyCodeModifiers (keyInfo.Modifiers, (KeyCode)keyInfo.KeyChar);
  1456. }
  1457. private MouseFlags ProcessButtonClick (WindowsConsole.MouseEventRecord mouseEvent)
  1458. {
  1459. MouseFlags mouseFlag = 0;
  1460. switch (_lastMouseButtonPressed)
  1461. {
  1462. case WindowsConsole.ButtonState.Button1Pressed:
  1463. mouseFlag = MouseFlags.Button1Clicked;
  1464. break;
  1465. case WindowsConsole.ButtonState.Button2Pressed:
  1466. mouseFlag = MouseFlags.Button2Clicked;
  1467. break;
  1468. case WindowsConsole.ButtonState.RightmostButtonPressed:
  1469. mouseFlag = MouseFlags.Button3Clicked;
  1470. break;
  1471. }
  1472. _point = new Point
  1473. {
  1474. X = mouseEvent.MousePosition.X,
  1475. Y = mouseEvent.MousePosition.Y
  1476. };
  1477. _lastMouseButtonPressed = null;
  1478. _isButtonReleased = false;
  1479. _processButtonClick = false;
  1480. _point = null;
  1481. return mouseFlag;
  1482. }
  1483. private async Task ProcessButtonDoubleClickedAsync ()
  1484. {
  1485. await Task.Delay (200);
  1486. _isButtonDoubleClicked = false;
  1487. _isOneFingerDoubleClicked = false;
  1488. //buttonPressedCount = 0;
  1489. }
  1490. private async Task ProcessContinuousButtonPressedAsync (MouseFlags mouseFlag)
  1491. {
  1492. // When a user presses-and-holds, start generating pressed events every `startDelay`
  1493. // After `iterationsUntilFast` iterations, speed them up to `fastDelay` ms
  1494. const int startDelay = 500;
  1495. const int iterationsUntilFast = 4;
  1496. const int fastDelay = 50;
  1497. int iterations = 0;
  1498. int delay = startDelay;
  1499. while (_isButtonPressed)
  1500. {
  1501. // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
  1502. View view = Application.WantContinuousButtonPressedView;
  1503. if (view is null)
  1504. {
  1505. break;
  1506. }
  1507. if (iterations++ >= iterationsUntilFast)
  1508. {
  1509. delay = fastDelay;
  1510. }
  1511. await Task.Delay (delay);
  1512. var me = new MouseEventArgs
  1513. {
  1514. ScreenPosition = _pointMove,
  1515. Flags = mouseFlag
  1516. };
  1517. //Debug.WriteLine($"ProcessContinuousButtonPressedAsync: {view}");
  1518. if (_isButtonPressed && (mouseFlag & MouseFlags.ReportMousePosition) == 0)
  1519. {
  1520. // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
  1521. Application.Invoke (() => OnMouseEvent (me));
  1522. }
  1523. }
  1524. }
  1525. private void ResizeScreen ()
  1526. {
  1527. _outputBuffer = new WindowsConsole.ExtendedCharInfo [Rows * Cols];
  1528. // CONCURRENCY: Unsynchronized access to Clip is not safe.
  1529. Clip = new (0, 0, Cols, Rows);
  1530. _damageRegion = new WindowsConsole.SmallRect
  1531. {
  1532. Top = 0,
  1533. Left = 0,
  1534. Bottom = (short)Rows,
  1535. Right = (short)Cols
  1536. };
  1537. _dirtyLines = new bool [Rows];
  1538. WinConsole?.ForceRefreshCursorVisibility ();
  1539. }
  1540. private static MouseFlags SetControlKeyStates (WindowsConsole.MouseEventRecord mouseEvent, MouseFlags mouseFlag)
  1541. {
  1542. if (mouseEvent.ControlKeyState.HasFlag (WindowsConsole.ControlKeyState.RightControlPressed)
  1543. || mouseEvent.ControlKeyState.HasFlag (WindowsConsole.ControlKeyState.LeftControlPressed))
  1544. {
  1545. mouseFlag |= MouseFlags.ButtonCtrl;
  1546. }
  1547. if (mouseEvent.ControlKeyState.HasFlag (WindowsConsole.ControlKeyState.ShiftPressed))
  1548. {
  1549. mouseFlag |= MouseFlags.ButtonShift;
  1550. }
  1551. if (mouseEvent.ControlKeyState.HasFlag (WindowsConsole.ControlKeyState.RightAltPressed)
  1552. || mouseEvent.ControlKeyState.HasFlag (WindowsConsole.ControlKeyState.LeftAltPressed))
  1553. {
  1554. mouseFlag |= MouseFlags.ButtonAlt;
  1555. }
  1556. return mouseFlag;
  1557. }
  1558. [CanBeNull]
  1559. private MouseEventArgs ToDriverMouse (WindowsConsole.MouseEventRecord mouseEvent)
  1560. {
  1561. var mouseFlag = MouseFlags.AllEvents;
  1562. //Debug.WriteLine ($"ToDriverMouse: {mouseEvent}");
  1563. if (_isButtonDoubleClicked || _isOneFingerDoubleClicked)
  1564. {
  1565. // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
  1566. Application.MainLoop.AddIdle (
  1567. () =>
  1568. {
  1569. Task.Run (async () => await ProcessButtonDoubleClickedAsync ());
  1570. return false;
  1571. });
  1572. }
  1573. // The ButtonState member of the MouseEvent structure has bit corresponding to each mouse button.
  1574. // This will tell when a mouse button is pressed. When the button is released this event will
  1575. // be fired with its bit set to 0. So when the button is up ButtonState will be 0.
  1576. // To map to the correct driver events we save the last pressed mouse button, so we can
  1577. // map to the correct clicked event.
  1578. if ((_lastMouseButtonPressed is { } || _isButtonReleased) && mouseEvent.ButtonState != 0)
  1579. {
  1580. _lastMouseButtonPressed = null;
  1581. //isButtonPressed = false;
  1582. _isButtonReleased = false;
  1583. }
  1584. var p = new Point
  1585. {
  1586. X = mouseEvent.MousePosition.X,
  1587. Y = mouseEvent.MousePosition.Y
  1588. };
  1589. if ((mouseEvent.ButtonState != 0 && mouseEvent.EventFlags == 0 && _lastMouseButtonPressed is null && !_isButtonDoubleClicked)
  1590. || (_lastMouseButtonPressed == null
  1591. && mouseEvent.EventFlags.HasFlag (WindowsConsole.EventFlags.MouseMoved)
  1592. && mouseEvent.ButtonState != 0
  1593. && !_isButtonReleased
  1594. && !_isButtonDoubleClicked))
  1595. {
  1596. switch (mouseEvent.ButtonState)
  1597. {
  1598. case WindowsConsole.ButtonState.Button1Pressed:
  1599. mouseFlag = MouseFlags.Button1Pressed;
  1600. break;
  1601. case WindowsConsole.ButtonState.Button2Pressed:
  1602. mouseFlag = MouseFlags.Button2Pressed;
  1603. break;
  1604. case WindowsConsole.ButtonState.RightmostButtonPressed:
  1605. mouseFlag = MouseFlags.Button3Pressed;
  1606. break;
  1607. }
  1608. if (_point is null)
  1609. {
  1610. _point = p;
  1611. }
  1612. if (mouseEvent.EventFlags.HasFlag (WindowsConsole.EventFlags.MouseMoved))
  1613. {
  1614. _pointMove = p;
  1615. mouseFlag |= MouseFlags.ReportMousePosition;
  1616. _isButtonReleased = false;
  1617. _processButtonClick = false;
  1618. }
  1619. _lastMouseButtonPressed = mouseEvent.ButtonState;
  1620. _isButtonPressed = true;
  1621. if ((mouseFlag & MouseFlags.ReportMousePosition) == 0)
  1622. {
  1623. // TODO: This makes ConsoleDriver dependent on Application, which is not ideal. This should be moved to Application.
  1624. Application.MainLoop.AddIdle (
  1625. () =>
  1626. {
  1627. Task.Run (async () => await ProcessContinuousButtonPressedAsync (mouseFlag));
  1628. return false;
  1629. });
  1630. }
  1631. }
  1632. else if (_lastMouseButtonPressed != null
  1633. && mouseEvent.EventFlags == 0
  1634. && !_isButtonReleased
  1635. && !_isButtonDoubleClicked
  1636. && !_isOneFingerDoubleClicked)
  1637. {
  1638. switch (_lastMouseButtonPressed)
  1639. {
  1640. case WindowsConsole.ButtonState.Button1Pressed:
  1641. mouseFlag = MouseFlags.Button1Released;
  1642. break;
  1643. case WindowsConsole.ButtonState.Button2Pressed:
  1644. mouseFlag = MouseFlags.Button2Released;
  1645. break;
  1646. case WindowsConsole.ButtonState.RightmostButtonPressed:
  1647. mouseFlag = MouseFlags.Button3Released;
  1648. break;
  1649. }
  1650. _isButtonPressed = false;
  1651. _isButtonReleased = true;
  1652. if (_point is { } && ((Point)_point).X == mouseEvent.MousePosition.X && ((Point)_point).Y == mouseEvent.MousePosition.Y)
  1653. {
  1654. _processButtonClick = true;
  1655. }
  1656. else
  1657. {
  1658. _point = null;
  1659. }
  1660. _processButtonClick = true;
  1661. }
  1662. else if (mouseEvent.EventFlags == WindowsConsole.EventFlags.MouseMoved
  1663. && !_isOneFingerDoubleClicked
  1664. && _isButtonReleased
  1665. && p == _point)
  1666. {
  1667. mouseFlag = ProcessButtonClick (mouseEvent);
  1668. }
  1669. else if (mouseEvent.EventFlags.HasFlag (WindowsConsole.EventFlags.DoubleClick))
  1670. {
  1671. switch (mouseEvent.ButtonState)
  1672. {
  1673. case WindowsConsole.ButtonState.Button1Pressed:
  1674. mouseFlag = MouseFlags.Button1DoubleClicked;
  1675. break;
  1676. case WindowsConsole.ButtonState.Button2Pressed:
  1677. mouseFlag = MouseFlags.Button2DoubleClicked;
  1678. break;
  1679. case WindowsConsole.ButtonState.RightmostButtonPressed:
  1680. mouseFlag = MouseFlags.Button3DoubleClicked;
  1681. break;
  1682. }
  1683. _isButtonDoubleClicked = true;
  1684. }
  1685. else if (mouseEvent.EventFlags == 0 && mouseEvent.ButtonState != 0 && _isButtonDoubleClicked)
  1686. {
  1687. switch (mouseEvent.ButtonState)
  1688. {
  1689. case WindowsConsole.ButtonState.Button1Pressed:
  1690. mouseFlag = MouseFlags.Button1TripleClicked;
  1691. break;
  1692. case WindowsConsole.ButtonState.Button2Pressed:
  1693. mouseFlag = MouseFlags.Button2TripleClicked;
  1694. break;
  1695. case WindowsConsole.ButtonState.RightmostButtonPressed:
  1696. mouseFlag = MouseFlags.Button3TripleClicked;
  1697. break;
  1698. }
  1699. _isButtonDoubleClicked = false;
  1700. }
  1701. else if (mouseEvent.EventFlags == WindowsConsole.EventFlags.MouseWheeled)
  1702. {
  1703. switch ((int)mouseEvent.ButtonState)
  1704. {
  1705. case int v when v > 0:
  1706. mouseFlag = MouseFlags.WheeledUp;
  1707. break;
  1708. case int v when v < 0:
  1709. mouseFlag = MouseFlags.WheeledDown;
  1710. break;
  1711. }
  1712. }
  1713. else if (mouseEvent.EventFlags == WindowsConsole.EventFlags.MouseWheeled && mouseEvent.ControlKeyState == WindowsConsole.ControlKeyState.ShiftPressed)
  1714. {
  1715. switch ((int)mouseEvent.ButtonState)
  1716. {
  1717. case int v when v > 0:
  1718. mouseFlag = MouseFlags.WheeledLeft;
  1719. break;
  1720. case int v when v < 0:
  1721. mouseFlag = MouseFlags.WheeledRight;
  1722. break;
  1723. }
  1724. }
  1725. else if (mouseEvent.EventFlags == WindowsConsole.EventFlags.MouseHorizontalWheeled)
  1726. {
  1727. switch ((int)mouseEvent.ButtonState)
  1728. {
  1729. case int v when v < 0:
  1730. mouseFlag = MouseFlags.WheeledLeft;
  1731. break;
  1732. case int v when v > 0:
  1733. mouseFlag = MouseFlags.WheeledRight;
  1734. break;
  1735. }
  1736. }
  1737. else if (mouseEvent.EventFlags == WindowsConsole.EventFlags.MouseMoved)
  1738. {
  1739. mouseFlag = MouseFlags.ReportMousePosition;
  1740. if (mouseEvent.MousePosition.X != _pointMove.X || mouseEvent.MousePosition.Y != _pointMove.Y)
  1741. {
  1742. _pointMove = new Point (mouseEvent.MousePosition.X, mouseEvent.MousePosition.Y);
  1743. }
  1744. }
  1745. else if (mouseEvent is { ButtonState: 0, EventFlags: 0 })
  1746. {
  1747. // This happens on a double or triple click event.
  1748. mouseFlag = MouseFlags.None;
  1749. }
  1750. mouseFlag = SetControlKeyStates (mouseEvent, mouseFlag);
  1751. //System.Diagnostics.Debug.WriteLine (
  1752. // $"point.X:{(point is { } ? ((Point)point).X : -1)};point.Y:{(point is { } ? ((Point)point).Y : -1)}");
  1753. return new MouseEventArgs
  1754. {
  1755. Position = new (mouseEvent.MousePosition.X, mouseEvent.MousePosition.Y),
  1756. Flags = mouseFlag
  1757. };
  1758. }
  1759. }
  1760. /// <summary>
  1761. /// Mainloop intended to be used with the <see cref="WindowsDriver"/>, and can
  1762. /// only be used on Windows.
  1763. /// </summary>
  1764. /// <remarks>
  1765. /// This implementation is used for WindowsDriver.
  1766. /// </remarks>
  1767. internal class WindowsMainLoop : IMainLoopDriver
  1768. {
  1769. /// <summary>
  1770. /// Invoked when the window is changed.
  1771. /// </summary>
  1772. public EventHandler<SizeChangedEventArgs> WinChanged;
  1773. private readonly ConsoleDriver _consoleDriver;
  1774. private readonly ManualResetEventSlim _eventReady = new (false);
  1775. // The records that we keep fetching
  1776. private readonly Queue<WindowsConsole.InputRecord []> _resultQueue = new ();
  1777. private readonly ManualResetEventSlim _waitForProbe = new (false);
  1778. private readonly WindowsConsole _winConsole;
  1779. private CancellationTokenSource _eventReadyTokenSource = new ();
  1780. private readonly CancellationTokenSource _inputHandlerTokenSource = new ();
  1781. private MainLoop _mainLoop;
  1782. public WindowsMainLoop (ConsoleDriver consoleDriver = null)
  1783. {
  1784. _consoleDriver = consoleDriver ?? throw new ArgumentNullException (nameof (consoleDriver));
  1785. _winConsole = ((WindowsDriver)consoleDriver).WinConsole;
  1786. }
  1787. void IMainLoopDriver.Setup (MainLoop mainLoop)
  1788. {
  1789. _mainLoop = mainLoop;
  1790. Task.Run (WindowsInputHandler, _inputHandlerTokenSource.Token);
  1791. #if HACK_CHECK_WINCHANGED
  1792. Task.Run (CheckWinChange);
  1793. #endif
  1794. }
  1795. void IMainLoopDriver.Wakeup () { _eventReady.Set (); }
  1796. bool IMainLoopDriver.EventsPending ()
  1797. {
  1798. _waitForProbe.Set ();
  1799. #if HACK_CHECK_WINCHANGED
  1800. _winChange.Set ();
  1801. #endif
  1802. if (_mainLoop.CheckTimersAndIdleHandlers (out int waitTimeout))
  1803. {
  1804. return true;
  1805. }
  1806. try
  1807. {
  1808. if (!_eventReadyTokenSource.IsCancellationRequested)
  1809. {
  1810. // Note: ManualResetEventSlim.Wait will wait indefinitely if the timeout is -1. The timeout is -1 when there
  1811. // are no timers, but there IS an idle handler waiting.
  1812. _eventReady.Wait (waitTimeout, _eventReadyTokenSource.Token);
  1813. }
  1814. }
  1815. catch (OperationCanceledException)
  1816. {
  1817. return true;
  1818. }
  1819. finally
  1820. {
  1821. _eventReady.Reset ();
  1822. }
  1823. if (!_eventReadyTokenSource.IsCancellationRequested)
  1824. {
  1825. #if HACK_CHECK_WINCHANGED
  1826. return _resultQueue.Count > 0 || _mainLoop.CheckTimersAndIdleHandlers (out _) || _winChanged;
  1827. #else
  1828. return _resultQueue.Count > 0 || _mainLoop.CheckTimersAndIdleHandlers (out _);
  1829. #endif
  1830. }
  1831. _eventReadyTokenSource.Dispose ();
  1832. _eventReadyTokenSource = new CancellationTokenSource ();
  1833. return true;
  1834. }
  1835. void IMainLoopDriver.Iteration ()
  1836. {
  1837. while (_resultQueue.Count > 0)
  1838. {
  1839. WindowsConsole.InputRecord [] inputRecords = _resultQueue.Dequeue ();
  1840. if (inputRecords is { Length: > 0 })
  1841. {
  1842. ((WindowsDriver)_consoleDriver).ProcessInput (inputRecords [0]);
  1843. }
  1844. }
  1845. #if HACK_CHECK_WINCHANGED
  1846. if (_winChanged)
  1847. {
  1848. _winChanged = false;
  1849. WinChanged?.Invoke (this, new SizeChangedEventArgs (_windowSize));
  1850. }
  1851. #endif
  1852. }
  1853. void IMainLoopDriver.TearDown ()
  1854. {
  1855. _inputHandlerTokenSource?.Cancel ();
  1856. _inputHandlerTokenSource?.Dispose ();
  1857. if (_winConsole is { })
  1858. {
  1859. var numOfEvents = _winConsole.GetNumberOfConsoleInputEvents ();
  1860. if (numOfEvents > 0)
  1861. {
  1862. _winConsole.FlushConsoleInputBuffer ();
  1863. //Debug.WriteLine ($"Flushed {numOfEvents} events.");
  1864. }
  1865. }
  1866. _waitForProbe?.Dispose ();
  1867. _resultQueue?.Clear ();
  1868. _eventReadyTokenSource?.Cancel ();
  1869. _eventReadyTokenSource?.Dispose ();
  1870. _eventReady?.Dispose ();
  1871. #if HACK_CHECK_WINCHANGED
  1872. _winChange?.Dispose ();
  1873. #endif
  1874. _mainLoop = null;
  1875. }
  1876. private void WindowsInputHandler ()
  1877. {
  1878. while (_mainLoop is { })
  1879. {
  1880. try
  1881. {
  1882. if (!_inputHandlerTokenSource.IsCancellationRequested)
  1883. {
  1884. _waitForProbe.Wait (_inputHandlerTokenSource.Token);
  1885. }
  1886. }
  1887. catch (OperationCanceledException)
  1888. {
  1889. // Wakes the _waitForProbe if it's waiting
  1890. _waitForProbe.Set ();
  1891. return;
  1892. }
  1893. finally
  1894. {
  1895. // If IsCancellationRequested is true the code after
  1896. // the `finally` block will not be executed.
  1897. if (!_inputHandlerTokenSource.IsCancellationRequested)
  1898. {
  1899. _waitForProbe.Reset ();
  1900. }
  1901. }
  1902. if (_resultQueue?.Count == 0)
  1903. {
  1904. _resultQueue.Enqueue (_winConsole.ReadConsoleInput ());
  1905. }
  1906. _eventReady.Set ();
  1907. }
  1908. }
  1909. #if HACK_CHECK_WINCHANGED
  1910. private readonly ManualResetEventSlim _winChange = new (false);
  1911. private bool _winChanged;
  1912. private Size _windowSize;
  1913. private void CheckWinChange ()
  1914. {
  1915. while (_mainLoop is { })
  1916. {
  1917. _winChange.Wait ();
  1918. _winChange.Reset ();
  1919. // Check if the window size changed every half second.
  1920. // We do this to minimize the weird tearing seen on Windows when resizing the console
  1921. while (_mainLoop is { })
  1922. {
  1923. Task.Delay (500).Wait ();
  1924. _windowSize = _winConsole.GetConsoleBufferWindow (out _);
  1925. if (_windowSize != Size.Empty
  1926. && (_windowSize.Width != _consoleDriver.Cols
  1927. || _windowSize.Height != _consoleDriver.Rows))
  1928. {
  1929. break;
  1930. }
  1931. }
  1932. _winChanged = true;
  1933. _eventReady.Set ();
  1934. }
  1935. }
  1936. #endif
  1937. }
  1938. internal class WindowsClipboard : ClipboardBase
  1939. {
  1940. private const uint CF_UNICODE_TEXT = 13;
  1941. public override bool IsSupported { get; } = CheckClipboardIsAvailable ();
  1942. private static bool CheckClipboardIsAvailable ()
  1943. {
  1944. // Attempt to open the clipboard
  1945. if (OpenClipboard (nint.Zero))
  1946. {
  1947. // Clipboard is available
  1948. // Close the clipboard after use
  1949. CloseClipboard ();
  1950. return true;
  1951. }
  1952. // Clipboard is not available
  1953. return false;
  1954. }
  1955. protected override string GetClipboardDataImpl ()
  1956. {
  1957. try
  1958. {
  1959. if (!OpenClipboard (nint.Zero))
  1960. {
  1961. return string.Empty;
  1962. }
  1963. nint handle = GetClipboardData (CF_UNICODE_TEXT);
  1964. if (handle == nint.Zero)
  1965. {
  1966. return string.Empty;
  1967. }
  1968. nint pointer = nint.Zero;
  1969. try
  1970. {
  1971. pointer = GlobalLock (handle);
  1972. if (pointer == nint.Zero)
  1973. {
  1974. return string.Empty;
  1975. }
  1976. int size = GlobalSize (handle);
  1977. var buff = new byte [size];
  1978. Marshal.Copy (pointer, buff, 0, size);
  1979. return Encoding.Unicode.GetString (buff).TrimEnd ('\0');
  1980. }
  1981. finally
  1982. {
  1983. if (pointer != nint.Zero)
  1984. {
  1985. GlobalUnlock (handle);
  1986. }
  1987. }
  1988. }
  1989. finally
  1990. {
  1991. CloseClipboard ();
  1992. }
  1993. }
  1994. protected override void SetClipboardDataImpl (string text)
  1995. {
  1996. OpenClipboard ();
  1997. EmptyClipboard ();
  1998. nint hGlobal = default;
  1999. try
  2000. {
  2001. int bytes = (text.Length + 1) * 2;
  2002. hGlobal = Marshal.AllocHGlobal (bytes);
  2003. if (hGlobal == default (nint))
  2004. {
  2005. ThrowWin32 ();
  2006. }
  2007. nint target = GlobalLock (hGlobal);
  2008. if (target == default (nint))
  2009. {
  2010. ThrowWin32 ();
  2011. }
  2012. try
  2013. {
  2014. Marshal.Copy (text.ToCharArray (), 0, target, text.Length);
  2015. }
  2016. finally
  2017. {
  2018. GlobalUnlock (target);
  2019. }
  2020. if (SetClipboardData (CF_UNICODE_TEXT, hGlobal) == default (nint))
  2021. {
  2022. ThrowWin32 ();
  2023. }
  2024. hGlobal = default (nint);
  2025. }
  2026. finally
  2027. {
  2028. if (hGlobal != default (nint))
  2029. {
  2030. Marshal.FreeHGlobal (hGlobal);
  2031. }
  2032. CloseClipboard ();
  2033. }
  2034. }
  2035. [DllImport ("user32.dll", SetLastError = true)]
  2036. [return: MarshalAs (UnmanagedType.Bool)]
  2037. private static extern bool CloseClipboard ();
  2038. [DllImport ("user32.dll")]
  2039. private static extern bool EmptyClipboard ();
  2040. [DllImport ("user32.dll", SetLastError = true)]
  2041. private static extern nint GetClipboardData (uint uFormat);
  2042. [DllImport ("kernel32.dll", SetLastError = true)]
  2043. private static extern nint GlobalLock (nint hMem);
  2044. [DllImport ("kernel32.dll", SetLastError = true)]
  2045. private static extern int GlobalSize (nint handle);
  2046. [DllImport ("kernel32.dll", SetLastError = true)]
  2047. [return: MarshalAs (UnmanagedType.Bool)]
  2048. private static extern bool GlobalUnlock (nint hMem);
  2049. [DllImport ("User32.dll", SetLastError = true)]
  2050. [return: MarshalAs (UnmanagedType.Bool)]
  2051. private static extern bool IsClipboardFormatAvailable (uint format);
  2052. private void OpenClipboard ()
  2053. {
  2054. var num = 10;
  2055. while (true)
  2056. {
  2057. if (OpenClipboard (default (nint)))
  2058. {
  2059. break;
  2060. }
  2061. if (--num == 0)
  2062. {
  2063. ThrowWin32 ();
  2064. }
  2065. Thread.Sleep (100);
  2066. }
  2067. }
  2068. [DllImport ("user32.dll", SetLastError = true)]
  2069. [return: MarshalAs (UnmanagedType.Bool)]
  2070. private static extern bool OpenClipboard (nint hWndNewOwner);
  2071. [DllImport ("user32.dll", SetLastError = true)]
  2072. private static extern nint SetClipboardData (uint uFormat, nint data);
  2073. private void ThrowWin32 () { throw new Win32Exception (Marshal.GetLastWin32Error ()); }
  2074. }