Application.cs 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  1. //
  2. // Core.cs: The core engine for gui.cs
  3. //
  4. // Authors:
  5. // Miguel de Icaza ([email protected])
  6. //
  7. // Pending:
  8. // - Check for NeedDisplay on the hierarchy and repaint
  9. // - Layout support
  10. // - "Colors" type or "Attributes" type?
  11. // - What to surface as "BackgroundCOlor" when clearing a window, an attribute or colors?
  12. //
  13. // Optimziations
  14. // - Add rendering limitation to the exposed area
  15. using System;
  16. using System.Collections;
  17. using System.Collections.Generic;
  18. using System.Threading;
  19. using System.Linq;
  20. using NStack;
  21. using System.ComponentModel;
  22. namespace Terminal.Gui {
  23. /// <summary>
  24. /// A static, singelton class provding the main application driver for Terminal.Gui apps.
  25. /// </summary>
  26. /// <example>
  27. /// <code>
  28. /// // A simple Terminal.Gui app that creates a window with a frame and title with
  29. /// // 5 rows/columns of padding.
  30. /// Application.Init();
  31. /// var win = new Window ("Hello World - CTRL-Q to quit") {
  32. /// X = 5,
  33. /// Y = 5,
  34. /// Width = Dim.Fill (5),
  35. /// Height = Dim.Fill (5)
  36. /// };
  37. /// Application.Top.Add(win);
  38. /// Application.Run();
  39. /// </code>
  40. /// </example>
  41. /// <remarks>
  42. /// <para>
  43. /// Creates a instance of <see cref="Terminal.Gui.MainLoop"/> to process input events, handle timers and
  44. /// other sources of data. It is accessible via the <see cref="MainLoop"/> property.
  45. /// </para>
  46. /// <para>
  47. /// You can hook up to the <see cref="Iteration"/> event to have your method
  48. /// invoked on each iteration of the <see cref="Terminal.Gui.MainLoop"/>.
  49. /// </para>
  50. /// <para>
  51. /// When invoked sets the SynchronizationContext to one that is tied
  52. /// to the mainloop, allowing user code to use async/await.
  53. /// </para>
  54. /// </remarks>
  55. public static class Application {
  56. /// <summary>
  57. /// The current <see cref="ConsoleDriver"/> in use.
  58. /// </summary>
  59. public static ConsoleDriver Driver;
  60. /// <summary>
  61. /// The <see cref="Toplevel"/> object used for the application on startup (<seealso cref="Application.Top"/>)
  62. /// </summary>
  63. /// <value>The top.</value>
  64. public static Toplevel Top { get; private set; }
  65. /// <summary>
  66. /// The current <see cref="Toplevel"/> object. This is updated when <see cref="Application.Run(Func{Exception, bool})"/> enters and leaves to point to the current <see cref="Toplevel"/> .
  67. /// </summary>
  68. /// <value>The current.</value>
  69. public static Toplevel Current { get; private set; }
  70. /// <summary>
  71. /// The current <see cref="ConsoleDriver.HeightAsBuffer"/> used in the terminal.
  72. /// </summary>
  73. public static bool HeightAsBuffer {
  74. get {
  75. if (Driver == null) {
  76. throw new ArgumentNullException ("The driver must be initialized first.");
  77. }
  78. return Driver.HeightAsBuffer;
  79. }
  80. set {
  81. if (Driver == null) {
  82. throw new ArgumentNullException ("The driver must be initialized first.");
  83. }
  84. if (Driver.HeightAsBuffer != value) {
  85. Driver.HeightAsBuffer = value;
  86. }
  87. }
  88. }
  89. /// <summary>
  90. /// Used only by <see cref="NetDriver"/> to forcing always moving the cursor position when writing to the screen.
  91. /// </summary>
  92. public static bool AlwaysSetPosition {
  93. get {
  94. if (Driver is NetDriver) {
  95. return (Driver as NetDriver).AlwaysSetPosition;
  96. }
  97. return false;
  98. }
  99. set {
  100. if (Driver is NetDriver) {
  101. (Driver as NetDriver).AlwaysSetPosition = value;
  102. Driver.Refresh ();
  103. }
  104. }
  105. }
  106. /// <summary>
  107. /// Alternative key to navigate forwards through all views. Ctrl+Tab is always used.
  108. /// </summary>
  109. public static Key AlternateForwardKey { get; set; } = Key.PageDown | Key.CtrlMask;
  110. /// <summary>
  111. /// Alternative key to navigate backwards through all views. Shift+Ctrl+Tab is always used.
  112. /// </summary>
  113. public static Key AlternateBackwardKey { get; set; } = Key.PageUp | Key.CtrlMask;
  114. /// <summary>
  115. /// The <see cref="MainLoop"/> driver for the application
  116. /// </summary>
  117. /// <value>The main loop.</value>
  118. public static MainLoop MainLoop { get; private set; }
  119. static Stack<Toplevel> toplevels = new Stack<Toplevel> ();
  120. /// <summary>
  121. /// This event is raised on each iteration of the <see cref="MainLoop"/>
  122. /// </summary>
  123. /// <remarks>
  124. /// See also <see cref="Timeout"/>
  125. /// </remarks>
  126. public static Action Iteration;
  127. /// <summary>
  128. /// Returns a rectangle that is centered in the screen for the provided size.
  129. /// </summary>
  130. /// <returns>The centered rect.</returns>
  131. /// <param name="size">Size for the rectangle.</param>
  132. public static Rect MakeCenteredRect (Size size)
  133. {
  134. return new Rect (new Point ((Driver.Cols - size.Width) / 2, (Driver.Rows - size.Height) / 2), size);
  135. }
  136. //
  137. // provides the sync context set while executing code in Terminal.Gui, to let
  138. // users use async/await on their code
  139. //
  140. class MainLoopSyncContext : SynchronizationContext {
  141. MainLoop mainLoop;
  142. public MainLoopSyncContext (MainLoop mainLoop)
  143. {
  144. this.mainLoop = mainLoop;
  145. }
  146. public override SynchronizationContext CreateCopy ()
  147. {
  148. return new MainLoopSyncContext (MainLoop);
  149. }
  150. public override void Post (SendOrPostCallback d, object state)
  151. {
  152. mainLoop.AddIdle (() => {
  153. d (state);
  154. return false;
  155. });
  156. //mainLoop.Driver.Wakeup ();
  157. }
  158. public override void Send (SendOrPostCallback d, object state)
  159. {
  160. mainLoop.Invoke (() => {
  161. d (state);
  162. });
  163. }
  164. }
  165. /// <summary>
  166. /// If set, it forces the use of the System.Console-based driver.
  167. /// </summary>
  168. public static bool UseSystemConsole;
  169. /// <summary>
  170. /// Initializes a new instance of <see cref="Terminal.Gui"/> Application.
  171. /// </summary>
  172. /// <remarks>
  173. /// <para>
  174. /// Call this method once per instance (or after <see cref="Shutdown"/> has been called).
  175. /// </para>
  176. /// <para>
  177. /// Loads the right <see cref="ConsoleDriver"/> for the platform.
  178. /// </para>
  179. /// <para>
  180. /// Creates a <see cref="Toplevel"/> and assigns it to <see cref="Top"/>
  181. /// </para>
  182. /// </remarks>
  183. public static void Init (ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) => Init (() => Toplevel.Create (), driver, mainLoopDriver);
  184. internal static bool _initialized = false;
  185. /// <summary>
  186. /// Initializes the Terminal.Gui application
  187. /// </summary>
  188. static void Init (Func<Toplevel> topLevelFactory, ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null)
  189. {
  190. if (_initialized && driver == null) return;
  191. if (_initialized) {
  192. throw new InvalidOperationException ("Init must be bracketed by Shutdown");
  193. }
  194. // Used only for start debugging on Unix.
  195. //#if DEBUG
  196. // while (!System.Diagnostics.Debugger.IsAttached) {
  197. // System.Threading.Thread.Sleep (100);
  198. // }
  199. // System.Diagnostics.Debugger.Break ();
  200. //#endif
  201. // Reset all class variables (Application is a singleton).
  202. ResetState ();
  203. // This supports Unit Tests and the passing of a mock driver/loopdriver
  204. if (driver != null) {
  205. if (mainLoopDriver == null) {
  206. throw new ArgumentNullException ("mainLoopDriver cannot be null if driver is provided.");
  207. }
  208. Driver = driver;
  209. Driver.Init (TerminalResized);
  210. MainLoop = new MainLoop (mainLoopDriver);
  211. SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext (MainLoop));
  212. }
  213. if (Driver == null) {
  214. var p = Environment.OSVersion.Platform;
  215. if (UseSystemConsole) {
  216. Driver = new NetDriver ();
  217. mainLoopDriver = new NetMainLoop (Driver);
  218. } else if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows) {
  219. Driver = new WindowsDriver ();
  220. mainLoopDriver = new WindowsMainLoop (Driver);
  221. } else {
  222. mainLoopDriver = new UnixMainLoop ();
  223. Driver = new CursesDriver ();
  224. }
  225. Driver.Init (TerminalResized);
  226. MainLoop = new MainLoop (mainLoopDriver);
  227. SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext (MainLoop));
  228. }
  229. Top = topLevelFactory ();
  230. Current = Top;
  231. _initialized = true;
  232. }
  233. /// <summary>
  234. /// Captures the execution state for the provided <see cref="Toplevel"/> view.
  235. /// </summary>
  236. public class RunState : IDisposable {
  237. /// <summary>
  238. /// Initializes a new <see cref="RunState"/> class.
  239. /// </summary>
  240. /// <param name="view"></param>
  241. public RunState (Toplevel view)
  242. {
  243. Toplevel = view;
  244. }
  245. internal Toplevel Toplevel;
  246. /// <summary>
  247. /// Releases alTop = l resource used by the <see cref="Application.RunState"/> object.
  248. /// </summary>
  249. /// <remarks>Call <see cref="Dispose()"/> when you are finished using the <see cref="Application.RunState"/>. The
  250. /// <see cref="Dispose()"/> method leaves the <see cref="Application.RunState"/> in an unusable state. After
  251. /// calling <see cref="Dispose()"/>, you must release all references to the
  252. /// <see cref="Application.RunState"/> so the garbage collector can reclaim the memory that the
  253. /// <see cref="Application.RunState"/> was occupying.</remarks>
  254. public void Dispose ()
  255. {
  256. Dispose (true);
  257. GC.SuppressFinalize (this);
  258. }
  259. /// <summary>
  260. /// Dispose the specified disposing.
  261. /// </summary>
  262. /// <returns>The dispose.</returns>
  263. /// <param name="disposing">If set to <c>true</c> disposing.</param>
  264. protected virtual void Dispose (bool disposing)
  265. {
  266. if (Toplevel != null && disposing) {
  267. End (Toplevel);
  268. Toplevel.Dispose ();
  269. Toplevel = null;
  270. }
  271. }
  272. }
  273. static void ProcessKeyEvent (KeyEvent ke)
  274. {
  275. var chain = toplevels.ToList ();
  276. foreach (var topLevel in chain) {
  277. if (topLevel.ProcessHotKey (ke))
  278. return;
  279. if (topLevel.Modal)
  280. break;
  281. }
  282. foreach (var topLevel in chain) {
  283. if (topLevel.ProcessKey (ke))
  284. return;
  285. if (topLevel.Modal)
  286. break;
  287. }
  288. foreach (var topLevel in chain) {
  289. // Process the key normally
  290. if (topLevel.ProcessColdKey (ke))
  291. return;
  292. if (topLevel.Modal)
  293. break;
  294. }
  295. }
  296. static void ProcessKeyDownEvent (KeyEvent ke)
  297. {
  298. var chain = toplevels.ToList ();
  299. foreach (var topLevel in chain) {
  300. if (topLevel.OnKeyDown (ke))
  301. return;
  302. if (topLevel.Modal)
  303. break;
  304. }
  305. }
  306. static void ProcessKeyUpEvent (KeyEvent ke)
  307. {
  308. var chain = toplevels.ToList ();
  309. foreach (var topLevel in chain) {
  310. if (topLevel.OnKeyUp (ke))
  311. return;
  312. if (topLevel.Modal)
  313. break;
  314. }
  315. }
  316. static View FindDeepestView (View start, int x, int y, out int resx, out int resy)
  317. {
  318. var startFrame = start.Frame;
  319. if (!startFrame.Contains (x, y)) {
  320. resx = 0;
  321. resy = 0;
  322. return null;
  323. }
  324. if (start.InternalSubviews != null) {
  325. int count = start.InternalSubviews.Count;
  326. if (count > 0) {
  327. var rx = x - startFrame.X;
  328. var ry = y - startFrame.Y;
  329. for (int i = count - 1; i >= 0; i--) {
  330. View v = start.InternalSubviews [i];
  331. if (v.Visible && v.Frame.Contains (rx, ry)) {
  332. var deep = FindDeepestView (v, rx, ry, out resx, out resy);
  333. if (deep == null)
  334. return v;
  335. return deep;
  336. }
  337. }
  338. }
  339. }
  340. resx = x - startFrame.X;
  341. resy = y - startFrame.Y;
  342. return start;
  343. }
  344. internal static View mouseGrabView;
  345. /// <summary>
  346. /// Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called.
  347. /// </summary>
  348. /// <returns>The grab.</returns>
  349. /// <param name="view">View that will receive all mouse events until UngrabMouse is invoked.</param>
  350. public static void GrabMouse (View view)
  351. {
  352. if (view == null)
  353. return;
  354. mouseGrabView = view;
  355. Driver.UncookMouse ();
  356. }
  357. /// <summary>
  358. /// Releases the mouse grab, so mouse events will be routed to the view on which the mouse is.
  359. /// </summary>
  360. public static void UngrabMouse ()
  361. {
  362. mouseGrabView = null;
  363. Driver.CookMouse ();
  364. }
  365. /// <summary>
  366. /// Merely a debugging aid to see the raw mouse events
  367. /// </summary>
  368. public static Action<MouseEvent> RootMouseEvent;
  369. internal static View wantContinuousButtonPressedView;
  370. static View lastMouseOwnerView;
  371. static void ProcessMouseEvent (MouseEvent me)
  372. {
  373. var view = FindDeepestView (Current, me.X, me.Y, out int rx, out int ry);
  374. if (view != null && view.WantContinuousButtonPressed)
  375. wantContinuousButtonPressedView = view;
  376. else
  377. wantContinuousButtonPressedView = null;
  378. RootMouseEvent?.Invoke (me);
  379. if (mouseGrabView != null) {
  380. var newxy = mouseGrabView.ScreenToView (me.X, me.Y);
  381. var nme = new MouseEvent () {
  382. X = newxy.X,
  383. Y = newxy.Y,
  384. Flags = me.Flags,
  385. OfX = me.X - newxy.X,
  386. OfY = me.Y - newxy.Y,
  387. View = view
  388. };
  389. if (OutsideFrame (new Point (nme.X, nme.Y), mouseGrabView.Frame)) {
  390. lastMouseOwnerView?.OnMouseLeave (me);
  391. }
  392. if (mouseGrabView != null) {
  393. mouseGrabView.OnMouseEvent (nme);
  394. return;
  395. }
  396. }
  397. if (view != null) {
  398. var nme = new MouseEvent () {
  399. X = rx,
  400. Y = ry,
  401. Flags = me.Flags,
  402. OfX = 0,
  403. OfY = 0,
  404. View = view
  405. };
  406. if (lastMouseOwnerView == null) {
  407. lastMouseOwnerView = view;
  408. view.OnMouseEnter (nme);
  409. } else if (lastMouseOwnerView != view) {
  410. lastMouseOwnerView.OnMouseLeave (nme);
  411. view.OnMouseEnter (nme);
  412. lastMouseOwnerView = view;
  413. }
  414. if (!view.WantMousePositionReports && me.Flags == MouseFlags.ReportMousePosition)
  415. return;
  416. if (view.WantContinuousButtonPressed)
  417. wantContinuousButtonPressedView = view;
  418. else
  419. wantContinuousButtonPressedView = null;
  420. // Should we bubbled up the event, if it is not handled?
  421. view.OnMouseEvent (nme);
  422. }
  423. }
  424. static bool OutsideFrame (Point p, Rect r)
  425. {
  426. return p.X < 0 || p.X > r.Width - 1 || p.Y < 0 || p.Y > r.Height - 1;
  427. }
  428. /// <summary>
  429. /// Building block API: Prepares the provided <see cref="Toplevel"/> for execution.
  430. /// </summary>
  431. /// <returns>The runstate handle that needs to be passed to the <see cref="End(RunState)"/> method upon completion.</returns>
  432. /// <param name="toplevel">Toplevel to prepare execution for.</param>
  433. /// <remarks>
  434. /// This method prepares the provided toplevel for running with the focus,
  435. /// it adds this to the list of toplevels, sets up the mainloop to process the
  436. /// event, lays out the subviews, focuses the first element, and draws the
  437. /// toplevel in the screen. This is usually followed by executing
  438. /// the <see cref="RunLoop"/> method, and then the <see cref="End(RunState)"/> method upon termination which will
  439. /// undo these changes.
  440. /// </remarks>
  441. public static RunState Begin (Toplevel toplevel)
  442. {
  443. if (toplevel == null)
  444. throw new ArgumentNullException (nameof (toplevel));
  445. var rs = new RunState (toplevel);
  446. Init ();
  447. if (toplevel is ISupportInitializeNotification initializableNotification &&
  448. !initializableNotification.IsInitialized) {
  449. initializableNotification.BeginInit ();
  450. initializableNotification.EndInit ();
  451. } else if (toplevel is ISupportInitialize initializable) {
  452. initializable.BeginInit ();
  453. initializable.EndInit ();
  454. }
  455. toplevels.Push (toplevel);
  456. Current = toplevel;
  457. Driver.PrepareToRun (MainLoop, ProcessKeyEvent, ProcessKeyDownEvent, ProcessKeyUpEvent, ProcessMouseEvent);
  458. if (toplevel.LayoutStyle == LayoutStyle.Computed)
  459. toplevel.SetRelativeLayout (new Rect (0, 0, Driver.Cols, Driver.Rows));
  460. toplevel.LayoutSubviews ();
  461. toplevel.WillPresent ();
  462. toplevel.OnLoaded ();
  463. Redraw (toplevel);
  464. toplevel.PositionCursor ();
  465. Driver.Refresh ();
  466. return rs;
  467. }
  468. /// <summary>
  469. /// Building block API: completes the execution of a <see cref="Toplevel"/> that was started with <see cref="Begin(Toplevel)"/> .
  470. /// </summary>
  471. /// <param name="runState">The runstate returned by the <see cref="Begin(Toplevel)"/> method.</param>
  472. public static void End (RunState runState)
  473. {
  474. if (runState == null)
  475. throw new ArgumentNullException (nameof (runState));
  476. runState.Toplevel.OnUnloaded ();
  477. runState.Dispose ();
  478. }
  479. /// <summary>
  480. /// Shutdown an application initialized with <see cref="Init(ConsoleDriver, IMainLoopDriver)"/>
  481. /// </summary>
  482. public static void Shutdown ()
  483. {
  484. ResetState ();
  485. }
  486. // Encapsulate all setting of initial state for Application; Having
  487. // this in a function like this ensures we don't make mistakes in
  488. // guranteeing that the state of this singleton is deterministic when Init
  489. // starts running and after Shutdown returns.
  490. static void ResetState () {
  491. // Shutdown is the bookend for Init. As such it needs to clean up all resources
  492. // Init created. Apps that do any threading will need to code defensively for this.
  493. // e.g. see Issue #537
  494. // TODO: Some of this state is actually related to Begin/End (not Init/Shutdown) and should be moved to `RunState` (#520)
  495. foreach (var t in toplevels) {
  496. t.Running = false;
  497. t.Dispose ();
  498. }
  499. toplevels.Clear ();
  500. Current = null;
  501. Top = null;
  502. MainLoop = null;
  503. Driver?.End ();
  504. Driver = null;
  505. Iteration = null;
  506. RootMouseEvent = null;
  507. Resized = null;
  508. _initialized = false;
  509. // Reset synchronization context to allow the user to run async/await,
  510. // as the main loop has been ended, the synchronization context from
  511. // gui.cs does no longer process any callbacks. See #1084 for more details:
  512. // (https://github.com/migueldeicaza/gui.cs/issues/1084).
  513. SynchronizationContext.SetSynchronizationContext (syncContext: null);
  514. }
  515. static void Redraw (View view)
  516. {
  517. view.Redraw (view.Bounds);
  518. Driver.Refresh ();
  519. }
  520. static void Refresh (View view)
  521. {
  522. view.Redraw (view.Bounds);
  523. Driver.Refresh ();
  524. }
  525. /// <summary>
  526. /// Triggers a refresh of the entire display.
  527. /// </summary>
  528. public static void Refresh ()
  529. {
  530. Driver.UpdateScreen ();
  531. View last = null;
  532. foreach (var v in toplevels.Reverse ()) {
  533. v.SetNeedsDisplay ();
  534. v.Redraw (v.Bounds);
  535. last = v;
  536. }
  537. last?.PositionCursor ();
  538. Driver.Refresh ();
  539. }
  540. internal static void End (View view)
  541. {
  542. if (toplevels.Peek () != view)
  543. throw new ArgumentException ("The view that you end with must be balanced");
  544. toplevels.Pop ();
  545. if (toplevels.Count == 0) {
  546. Current = null;
  547. } else {
  548. Current = toplevels.Peek ();
  549. Refresh ();
  550. }
  551. }
  552. /// <summary>
  553. /// Building block API: Runs the main loop for the created dialog
  554. /// </summary>
  555. /// <remarks>
  556. /// Use the wait parameter to control whether this is a
  557. /// blocking or non-blocking call.
  558. /// </remarks>
  559. /// <param name="state">The state returned by the Begin method.</param>
  560. /// <param name="wait">By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.</param>
  561. public static void RunLoop (RunState state, bool wait = true)
  562. {
  563. if (state == null)
  564. throw new ArgumentNullException (nameof (state));
  565. if (state.Toplevel == null)
  566. throw new ObjectDisposedException ("state");
  567. bool firstIteration = true;
  568. for (state.Toplevel.Running = true; state.Toplevel.Running;) {
  569. if (MainLoop.EventsPending (wait)) {
  570. // Notify Toplevel it's ready
  571. if (firstIteration) {
  572. state.Toplevel.OnReady ();
  573. }
  574. firstIteration = false;
  575. MainLoop.MainIteration ();
  576. Iteration?.Invoke ();
  577. if (Driver.EnsureCursorVisibility ()) {
  578. state.Toplevel.SetNeedsDisplay ();
  579. }
  580. } else if (!wait) {
  581. return;
  582. }
  583. if (state.Toplevel != Top && (!Top.NeedDisplay.IsEmpty || Top.ChildNeedsDisplay || Top.LayoutNeeded)) {
  584. Top.Redraw (Top.Bounds);
  585. state.Toplevel.SetNeedsDisplay (state.Toplevel.Bounds);
  586. }
  587. if (!state.Toplevel.NeedDisplay.IsEmpty || state.Toplevel.ChildNeedsDisplay || state.Toplevel.LayoutNeeded) {
  588. state.Toplevel.Redraw (state.Toplevel.Bounds);
  589. if (DebugDrawBounds) {
  590. DrawBounds (state.Toplevel);
  591. }
  592. state.Toplevel.PositionCursor ();
  593. Driver.Refresh ();
  594. } else {
  595. Driver.UpdateCursor ();
  596. }
  597. }
  598. }
  599. internal static bool DebugDrawBounds = false;
  600. // Need to look into why this does not work properly.
  601. static void DrawBounds (View v)
  602. {
  603. v.DrawFrame (v.Frame, padding: 0, fill: false);
  604. if (v.InternalSubviews != null && v.InternalSubviews.Count > 0)
  605. foreach (var sub in v.InternalSubviews)
  606. DrawBounds (sub);
  607. }
  608. /// <summary>
  609. /// Runs the application by calling <see cref="Run(Toplevel, Func{Exception, bool})"/> with the value of <see cref="Top"/>
  610. /// </summary>
  611. public static void Run (Func<Exception, bool> errorHandler = null)
  612. {
  613. Run (Top, errorHandler);
  614. }
  615. /// <summary>
  616. /// Runs the application by calling <see cref="Run(Toplevel, Func{Exception, bool})"/> with a new instance of the specified <see cref="Toplevel"/>-derived class
  617. /// </summary>
  618. public static void Run<T> (Func<Exception, bool> errorHandler = null) where T : Toplevel, new()
  619. {
  620. Init (() => new T ());
  621. Run (Top, errorHandler);
  622. }
  623. /// <summary>
  624. /// Runs the main loop on the given <see cref="Toplevel"/> container.
  625. /// </summary>
  626. /// <remarks>
  627. /// <para>
  628. /// This method is used to start processing events
  629. /// for the main application, but it is also used to
  630. /// run other modal <see cref="View"/>s such as <see cref="Dialog"/> boxes.
  631. /// </para>
  632. /// <para>
  633. /// To make a <see cref="Run(Toplevel, Func{Exception, bool})"/> stop execution, call <see cref="Application.RequestStop"/>.
  634. /// </para>
  635. /// <para>
  636. /// Calling <see cref="Run(Toplevel, Func{Exception, bool})"/> is equivalent to calling <see cref="Begin(Toplevel)"/>, followed by <see cref="RunLoop(RunState, bool)"/>,
  637. /// and then calling <see cref="End(RunState)"/>.
  638. /// </para>
  639. /// <para>
  640. /// Alternatively, to have a program control the main loop and
  641. /// process events manually, call <see cref="Begin(Toplevel)"/> to set things up manually and then
  642. /// repeatedly call <see cref="RunLoop(RunState, bool)"/> with the wait parameter set to false. By doing this
  643. /// the <see cref="RunLoop(RunState, bool)"/> method will only process any pending events, timers, idle handlers and
  644. /// then return control immediately.
  645. /// </para>
  646. /// <para>
  647. /// When <paramref name="errorHandler"/> is null the exception is rethrown, when it returns true the application is resumed and when false method exits gracefully.
  648. /// </para>
  649. /// </remarks>
  650. /// <param name="view">The <see cref="Toplevel"/> tu run modally.</param>
  651. /// <param name="errorHandler">Handler for any unhandled exceptions (resumes when returns true, rethrows when null).</param>
  652. public static void Run (Toplevel view, Func<Exception, bool> errorHandler = null)
  653. {
  654. var resume = true;
  655. while (resume) {
  656. #if !DEBUG
  657. try {
  658. #endif
  659. resume = false;
  660. var runToken = Begin (view);
  661. RunLoop (runToken);
  662. End (runToken);
  663. #if !DEBUG
  664. }
  665. catch (Exception error)
  666. {
  667. if (errorHandler == null)
  668. {
  669. throw;
  670. }
  671. resume = errorHandler(error);
  672. }
  673. #endif
  674. }
  675. }
  676. /// <summary>
  677. /// Stops running the most recent <see cref="Toplevel"/>.
  678. /// </summary>
  679. /// <remarks>
  680. /// <para>
  681. /// This will cause <see cref="Application.Run(Func{Exception, bool})"/> to return.
  682. /// </para>
  683. /// <para>
  684. /// Calling <see cref="Application.RequestStop"/> is equivalent to setting the <see cref="Toplevel.Running"/> property on the curently running <see cref="Toplevel"/> to false.
  685. /// </para>
  686. /// </remarks>
  687. public static void RequestStop ()
  688. {
  689. Current.Running = false;
  690. }
  691. /// <summary>
  692. /// Event arguments for the <see cref="Application.Resized"/> event.
  693. /// </summary>
  694. public class ResizedEventArgs : EventArgs {
  695. /// <summary>
  696. /// The number of rows in the resized terminal.
  697. /// </summary>
  698. public int Rows { get; set; }
  699. /// <summary>
  700. /// The number of columns in the resized terminal.
  701. /// </summary>
  702. public int Cols { get; set; }
  703. }
  704. /// <summary>
  705. /// Invoked when the terminal was resized. The new size of the terminal is provided.
  706. /// </summary>
  707. public static Action<ResizedEventArgs> Resized;
  708. static void TerminalResized ()
  709. {
  710. var full = new Rect (0, 0, Driver.Cols, Driver.Rows);
  711. Top.Frame = full;
  712. Top.Width = full.Width;
  713. Top.Height = full.Height;
  714. Resized?.Invoke (new ResizedEventArgs () { Cols = full.Width, Rows = full.Height });
  715. Driver.Clip = full;
  716. foreach (var t in toplevels) {
  717. t.PositionToplevels ();
  718. t.SetRelativeLayout (full);
  719. t.LayoutSubviews ();
  720. }
  721. Refresh ();
  722. }
  723. }
  724. }