WindowsDriver.cs 81 KB

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