Application.cs 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800
  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. // Used only for start debugging on Unix.
  192. //#if DEBUG
  193. // while (!System.Diagnostics.Debugger.IsAttached) {
  194. // System.Threading.Thread.Sleep (100);
  195. // }
  196. // System.Diagnostics.Debugger.Break ();
  197. //#endif
  198. // Reset all class variables (Application is a singleton).
  199. ResetState ();
  200. // This supports Unit Tests and the passing of a mock driver/loopdriver
  201. if (driver != null) {
  202. if (mainLoopDriver == null) {
  203. throw new ArgumentNullException ("mainLoopDriver cannot be null if driver is provided.");
  204. }
  205. Driver = driver;
  206. Driver.Init (TerminalResized);
  207. MainLoop = new MainLoop (mainLoopDriver);
  208. SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext (MainLoop));
  209. }
  210. if (Driver == null) {
  211. var p = Environment.OSVersion.Platform;
  212. if (UseSystemConsole) {
  213. Driver = new NetDriver ();
  214. mainLoopDriver = new NetMainLoop (Driver);
  215. } else if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows) {
  216. Driver = new WindowsDriver ();
  217. mainLoopDriver = new WindowsMainLoop (Driver);
  218. } else {
  219. mainLoopDriver = new UnixMainLoop ();
  220. Driver = new CursesDriver ();
  221. }
  222. Driver.Init (TerminalResized);
  223. MainLoop = new MainLoop (mainLoopDriver);
  224. SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext (MainLoop));
  225. }
  226. Top = topLevelFactory ();
  227. Current = Top;
  228. _initialized = true;
  229. }
  230. /// <summary>
  231. /// Captures the execution state for the provided <see cref="Toplevel"/> view.
  232. /// </summary>
  233. public class RunState : IDisposable {
  234. /// <summary>
  235. /// Initializes a new <see cref="RunState"/> class.
  236. /// </summary>
  237. /// <param name="view"></param>
  238. public RunState (Toplevel view)
  239. {
  240. Toplevel = view;
  241. }
  242. internal Toplevel Toplevel;
  243. /// <summary>
  244. /// Releases alTop = l resource used by the <see cref="Application.RunState"/> object.
  245. /// </summary>
  246. /// <remarks>Call <see cref="Dispose()"/> when you are finished using the <see cref="Application.RunState"/>. The
  247. /// <see cref="Dispose()"/> method leaves the <see cref="Application.RunState"/> in an unusable state. After
  248. /// calling <see cref="Dispose()"/>, you must release all references to the
  249. /// <see cref="Application.RunState"/> so the garbage collector can reclaim the memory that the
  250. /// <see cref="Application.RunState"/> was occupying.</remarks>
  251. public void Dispose ()
  252. {
  253. Dispose (true);
  254. GC.SuppressFinalize (this);
  255. }
  256. /// <summary>
  257. /// Dispose the specified disposing.
  258. /// </summary>
  259. /// <returns>The dispose.</returns>
  260. /// <param name="disposing">If set to <c>true</c> disposing.</param>
  261. protected virtual void Dispose (bool disposing)
  262. {
  263. if (Toplevel != null && disposing) {
  264. End (Toplevel);
  265. Toplevel.Dispose ();
  266. Toplevel = null;
  267. }
  268. }
  269. }
  270. static void ProcessKeyEvent (KeyEvent ke)
  271. {
  272. var chain = toplevels.ToList ();
  273. foreach (var topLevel in chain) {
  274. if (topLevel.ProcessHotKey (ke))
  275. return;
  276. if (topLevel.Modal)
  277. break;
  278. }
  279. foreach (var topLevel in chain) {
  280. if (topLevel.ProcessKey (ke))
  281. return;
  282. if (topLevel.Modal)
  283. break;
  284. }
  285. foreach (var topLevel in chain) {
  286. // Process the key normally
  287. if (topLevel.ProcessColdKey (ke))
  288. return;
  289. if (topLevel.Modal)
  290. break;
  291. }
  292. }
  293. static void ProcessKeyDownEvent (KeyEvent ke)
  294. {
  295. var chain = toplevels.ToList ();
  296. foreach (var topLevel in chain) {
  297. if (topLevel.OnKeyDown (ke))
  298. return;
  299. if (topLevel.Modal)
  300. break;
  301. }
  302. }
  303. static void ProcessKeyUpEvent (KeyEvent ke)
  304. {
  305. var chain = toplevels.ToList ();
  306. foreach (var topLevel in chain) {
  307. if (topLevel.OnKeyUp (ke))
  308. return;
  309. if (topLevel.Modal)
  310. break;
  311. }
  312. }
  313. static View FindDeepestView (View start, int x, int y, out int resx, out int resy)
  314. {
  315. var startFrame = start.Frame;
  316. if (!startFrame.Contains (x, y)) {
  317. resx = 0;
  318. resy = 0;
  319. return null;
  320. }
  321. if (start.InternalSubviews != null) {
  322. int count = start.InternalSubviews.Count;
  323. if (count > 0) {
  324. var rx = x - startFrame.X;
  325. var ry = y - startFrame.Y;
  326. for (int i = count - 1; i >= 0; i--) {
  327. View v = start.InternalSubviews [i];
  328. if (v.Visible && v.Frame.Contains (rx, ry)) {
  329. var deep = FindDeepestView (v, rx, ry, out resx, out resy);
  330. if (deep == null)
  331. return v;
  332. return deep;
  333. }
  334. }
  335. }
  336. }
  337. resx = x - startFrame.X;
  338. resy = y - startFrame.Y;
  339. return start;
  340. }
  341. internal static View mouseGrabView;
  342. /// <summary>
  343. /// Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called.
  344. /// </summary>
  345. /// <returns>The grab.</returns>
  346. /// <param name="view">View that will receive all mouse events until UngrabMouse is invoked.</param>
  347. public static void GrabMouse (View view)
  348. {
  349. if (view == null)
  350. return;
  351. mouseGrabView = view;
  352. Driver.UncookMouse ();
  353. }
  354. /// <summary>
  355. /// Releases the mouse grab, so mouse events will be routed to the view on which the mouse is.
  356. /// </summary>
  357. public static void UngrabMouse ()
  358. {
  359. mouseGrabView = null;
  360. Driver.CookMouse ();
  361. }
  362. /// <summary>
  363. /// Merely a debugging aid to see the raw mouse events
  364. /// </summary>
  365. public static Action<MouseEvent> RootMouseEvent;
  366. internal static View wantContinuousButtonPressedView;
  367. static View lastMouseOwnerView;
  368. static void ProcessMouseEvent (MouseEvent me)
  369. {
  370. var view = FindDeepestView (Current, me.X, me.Y, out int rx, out int ry);
  371. if (view != null && view.WantContinuousButtonPressed)
  372. wantContinuousButtonPressedView = view;
  373. else
  374. wantContinuousButtonPressedView = null;
  375. RootMouseEvent?.Invoke (me);
  376. if (mouseGrabView != null) {
  377. var newxy = mouseGrabView.ScreenToView (me.X, me.Y);
  378. var nme = new MouseEvent () {
  379. X = newxy.X,
  380. Y = newxy.Y,
  381. Flags = me.Flags,
  382. OfX = me.X - newxy.X,
  383. OfY = me.Y - newxy.Y,
  384. View = view
  385. };
  386. if (OutsideFrame (new Point (nme.X, nme.Y), mouseGrabView.Frame)) {
  387. lastMouseOwnerView?.OnMouseLeave (me);
  388. }
  389. if (mouseGrabView != null) {
  390. mouseGrabView.OnMouseEvent (nme);
  391. return;
  392. }
  393. }
  394. if (view != null) {
  395. var nme = new MouseEvent () {
  396. X = rx,
  397. Y = ry,
  398. Flags = me.Flags,
  399. OfX = 0,
  400. OfY = 0,
  401. View = view
  402. };
  403. if (lastMouseOwnerView == null) {
  404. lastMouseOwnerView = view;
  405. view.OnMouseEnter (nme);
  406. } else if (lastMouseOwnerView != view) {
  407. lastMouseOwnerView.OnMouseLeave (nme);
  408. view.OnMouseEnter (nme);
  409. lastMouseOwnerView = view;
  410. }
  411. if (!view.WantMousePositionReports && me.Flags == MouseFlags.ReportMousePosition)
  412. return;
  413. if (view.WantContinuousButtonPressed)
  414. wantContinuousButtonPressedView = view;
  415. else
  416. wantContinuousButtonPressedView = null;
  417. // Should we bubbled up the event, if it is not handled?
  418. view.OnMouseEvent (nme);
  419. }
  420. }
  421. static bool OutsideFrame (Point p, Rect r)
  422. {
  423. return p.X < 0 || p.X > r.Width - 1 || p.Y < 0 || p.Y > r.Height - 1;
  424. }
  425. /// <summary>
  426. /// Building block API: Prepares the provided <see cref="Toplevel"/> for execution.
  427. /// </summary>
  428. /// <returns>The runstate handle that needs to be passed to the <see cref="End(RunState)"/> method upon completion.</returns>
  429. /// <param name="toplevel">Toplevel to prepare execution for.</param>
  430. /// <remarks>
  431. /// This method prepares the provided toplevel for running with the focus,
  432. /// it adds this to the list of toplevels, sets up the mainloop to process the
  433. /// event, lays out the subviews, focuses the first element, and draws the
  434. /// toplevel in the screen. This is usually followed by executing
  435. /// the <see cref="RunLoop"/> method, and then the <see cref="End(RunState)"/> method upon termination which will
  436. /// undo these changes.
  437. /// </remarks>
  438. public static RunState Begin (Toplevel toplevel)
  439. {
  440. if (toplevel == null)
  441. throw new ArgumentNullException (nameof (toplevel));
  442. var rs = new RunState (toplevel);
  443. Init ();
  444. if (toplevel is ISupportInitializeNotification initializableNotification &&
  445. !initializableNotification.IsInitialized) {
  446. initializableNotification.BeginInit ();
  447. initializableNotification.EndInit ();
  448. } else if (toplevel is ISupportInitialize initializable) {
  449. initializable.BeginInit ();
  450. initializable.EndInit ();
  451. }
  452. toplevels.Push (toplevel);
  453. Current = toplevel;
  454. Driver.PrepareToRun (MainLoop, ProcessKeyEvent, ProcessKeyDownEvent, ProcessKeyUpEvent, ProcessMouseEvent);
  455. if (toplevel.LayoutStyle == LayoutStyle.Computed)
  456. toplevel.SetRelativeLayout (new Rect (0, 0, Driver.Cols, Driver.Rows));
  457. toplevel.LayoutSubviews ();
  458. toplevel.WillPresent ();
  459. toplevel.OnLoaded ();
  460. Redraw (toplevel);
  461. toplevel.PositionCursor ();
  462. Driver.Refresh ();
  463. return rs;
  464. }
  465. /// <summary>
  466. /// Building block API: completes the execution of a <see cref="Toplevel"/> that was started with <see cref="Begin(Toplevel)"/> .
  467. /// </summary>
  468. /// <param name="runState">The runstate returned by the <see cref="Begin(Toplevel)"/> method.</param>
  469. public static void End (RunState runState)
  470. {
  471. if (runState == null)
  472. throw new ArgumentNullException (nameof (runState));
  473. runState.Toplevel.OnUnloaded ();
  474. runState.Dispose ();
  475. }
  476. /// <summary>
  477. /// Shutdown an application initialized with <see cref="Init(ConsoleDriver, IMainLoopDriver)"/>
  478. /// </summary>
  479. public static void Shutdown ()
  480. {
  481. ResetState ();
  482. }
  483. // Encapsulate all setting of initial state for Application; Having
  484. // this in a function like this ensures we don't make mistakes in
  485. // guranteeing that the state of this singleton is deterministic when Init
  486. // starts running and after Shutdown returns.
  487. static void ResetState () {
  488. // Shutdown is the bookend for Init. As such it needs to clean up all resources
  489. // Init created. Apps that do any threading will need to code defensively for this.
  490. // e.g. see Issue #537
  491. // TODO: Some of this state is actually related to Begin/End (not Init/Shutdown) and should be moved to `RunState` (#520)
  492. foreach (var t in toplevels) {
  493. t.Running = false;
  494. t.Dispose ();
  495. }
  496. toplevels.Clear ();
  497. Current = null;
  498. Top = null;
  499. MainLoop = null;
  500. Driver?.End ();
  501. Driver = null;
  502. Iteration = null;
  503. RootMouseEvent = null;
  504. Resized = null;
  505. _initialized = false;
  506. // Reset synchronization context to allow the user to run async/await,
  507. // as the main loop has been ended, the synchronization context from
  508. // gui.cs does no longer process any callbacks. See #1084 for more details:
  509. // (https://github.com/migueldeicaza/gui.cs/issues/1084).
  510. SynchronizationContext.SetSynchronizationContext (syncContext: null);
  511. }
  512. static void Redraw (View view)
  513. {
  514. view.Redraw (view.Bounds);
  515. Driver.Refresh ();
  516. }
  517. static void Refresh (View view)
  518. {
  519. view.Redraw (view.Bounds);
  520. Driver.Refresh ();
  521. }
  522. /// <summary>
  523. /// Triggers a refresh of the entire display.
  524. /// </summary>
  525. public static void Refresh ()
  526. {
  527. Driver.UpdateScreen ();
  528. View last = null;
  529. foreach (var v in toplevels.Reverse ()) {
  530. v.SetNeedsDisplay ();
  531. v.Redraw (v.Bounds);
  532. last = v;
  533. }
  534. last?.PositionCursor ();
  535. Driver.Refresh ();
  536. }
  537. internal static void End (View view)
  538. {
  539. if (toplevels.Peek () != view)
  540. throw new ArgumentException ("The view that you end with must be balanced");
  541. toplevels.Pop ();
  542. if (toplevels.Count == 0) {
  543. Current = null;
  544. } else {
  545. Current = toplevels.Peek ();
  546. Refresh ();
  547. }
  548. }
  549. /// <summary>
  550. /// Building block API: Runs the main loop for the created dialog
  551. /// </summary>
  552. /// <remarks>
  553. /// Use the wait parameter to control whether this is a
  554. /// blocking or non-blocking call.
  555. /// </remarks>
  556. /// <param name="state">The state returned by the Begin method.</param>
  557. /// <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>
  558. public static void RunLoop (RunState state, bool wait = true)
  559. {
  560. if (state == null)
  561. throw new ArgumentNullException (nameof (state));
  562. if (state.Toplevel == null)
  563. throw new ObjectDisposedException ("state");
  564. bool firstIteration = true;
  565. for (state.Toplevel.Running = true; state.Toplevel.Running;) {
  566. if (MainLoop.EventsPending (wait)) {
  567. // Notify Toplevel it's ready
  568. if (firstIteration) {
  569. state.Toplevel.OnReady ();
  570. }
  571. firstIteration = false;
  572. MainLoop.MainIteration ();
  573. Iteration?.Invoke ();
  574. if (Driver.EnsureCursorVisibility ()) {
  575. state.Toplevel.SetNeedsDisplay ();
  576. }
  577. } else if (!wait) {
  578. return;
  579. }
  580. if (state.Toplevel != Top && (!Top.NeedDisplay.IsEmpty || Top.ChildNeedsDisplay || Top.LayoutNeeded)) {
  581. Top.Redraw (Top.Bounds);
  582. state.Toplevel.SetNeedsDisplay (state.Toplevel.Bounds);
  583. }
  584. if (!state.Toplevel.NeedDisplay.IsEmpty || state.Toplevel.ChildNeedsDisplay || state.Toplevel.LayoutNeeded) {
  585. state.Toplevel.Redraw (state.Toplevel.Bounds);
  586. if (DebugDrawBounds) {
  587. DrawBounds (state.Toplevel);
  588. }
  589. state.Toplevel.PositionCursor ();
  590. Driver.Refresh ();
  591. } else {
  592. Driver.UpdateCursor ();
  593. }
  594. }
  595. }
  596. internal static bool DebugDrawBounds = false;
  597. // Need to look into why this does not work properly.
  598. static void DrawBounds (View v)
  599. {
  600. v.DrawFrame (v.Frame, padding: 0, fill: false);
  601. if (v.InternalSubviews != null && v.InternalSubviews.Count > 0)
  602. foreach (var sub in v.InternalSubviews)
  603. DrawBounds (sub);
  604. }
  605. /// <summary>
  606. /// Runs the application by calling <see cref="Run(Toplevel, Func{Exception, bool})"/> with the value of <see cref="Top"/>
  607. /// </summary>
  608. public static void Run (Func<Exception, bool> errorHandler = null)
  609. {
  610. Run (Top, errorHandler);
  611. }
  612. /// <summary>
  613. /// Runs the application by calling <see cref="Run(Toplevel, Func{Exception, bool})"/> with a new instance of the specified <see cref="Toplevel"/>-derived class
  614. /// </summary>
  615. public static void Run<T> (Func<Exception, bool> errorHandler = null) where T : Toplevel, new()
  616. {
  617. Init (() => new T ());
  618. Run (Top, errorHandler);
  619. }
  620. /// <summary>
  621. /// Runs the main loop on the given <see cref="Toplevel"/> container.
  622. /// </summary>
  623. /// <remarks>
  624. /// <para>
  625. /// This method is used to start processing events
  626. /// for the main application, but it is also used to
  627. /// run other modal <see cref="View"/>s such as <see cref="Dialog"/> boxes.
  628. /// </para>
  629. /// <para>
  630. /// To make a <see cref="Run(Toplevel, Func{Exception, bool})"/> stop execution, call <see cref="Application.RequestStop"/>.
  631. /// </para>
  632. /// <para>
  633. /// Calling <see cref="Run(Toplevel, Func{Exception, bool})"/> is equivalent to calling <see cref="Begin(Toplevel)"/>, followed by <see cref="RunLoop(RunState, bool)"/>,
  634. /// and then calling <see cref="End(RunState)"/>.
  635. /// </para>
  636. /// <para>
  637. /// Alternatively, to have a program control the main loop and
  638. /// process events manually, call <see cref="Begin(Toplevel)"/> to set things up manually and then
  639. /// repeatedly call <see cref="RunLoop(RunState, bool)"/> with the wait parameter set to false. By doing this
  640. /// the <see cref="RunLoop(RunState, bool)"/> method will only process any pending events, timers, idle handlers and
  641. /// then return control immediately.
  642. /// </para>
  643. /// <para>
  644. /// When <paramref name="errorHandler"/> is null the exception is rethrown, when it returns true the application is resumed and when false method exits gracefully.
  645. /// </para>
  646. /// </remarks>
  647. /// <param name="view">The <see cref="Toplevel"/> tu run modally.</param>
  648. /// <param name="errorHandler">Handler for any unhandled exceptions (resumes when returns true, rethrows when null).</param>
  649. public static void Run (Toplevel view, Func<Exception, bool> errorHandler = null)
  650. {
  651. var resume = true;
  652. while (resume) {
  653. #if !DEBUG
  654. try {
  655. #endif
  656. resume = false;
  657. var runToken = Begin (view);
  658. RunLoop (runToken);
  659. End (runToken);
  660. #if !DEBUG
  661. }
  662. catch (Exception error)
  663. {
  664. if (errorHandler == null)
  665. {
  666. throw;
  667. }
  668. resume = errorHandler(error);
  669. }
  670. #endif
  671. }
  672. }
  673. /// <summary>
  674. /// Stops running the most recent <see cref="Toplevel"/>.
  675. /// </summary>
  676. /// <remarks>
  677. /// <para>
  678. /// This will cause <see cref="Application.Run(Func{Exception, bool})"/> to return.
  679. /// </para>
  680. /// <para>
  681. /// Calling <see cref="Application.RequestStop"/> is equivalent to setting the <see cref="Toplevel.Running"/> property on the curently running <see cref="Toplevel"/> to false.
  682. /// </para>
  683. /// </remarks>
  684. public static void RequestStop ()
  685. {
  686. Current.Running = false;
  687. }
  688. /// <summary>
  689. /// Event arguments for the <see cref="Application.Resized"/> event.
  690. /// </summary>
  691. public class ResizedEventArgs : EventArgs {
  692. /// <summary>
  693. /// The number of rows in the resized terminal.
  694. /// </summary>
  695. public int Rows { get; set; }
  696. /// <summary>
  697. /// The number of columns in the resized terminal.
  698. /// </summary>
  699. public int Cols { get; set; }
  700. }
  701. /// <summary>
  702. /// Invoked when the terminal was resized. The new size of the terminal is provided.
  703. /// </summary>
  704. public static Action<ResizedEventArgs> Resized;
  705. static void TerminalResized ()
  706. {
  707. var full = new Rect (0, 0, Driver.Cols, Driver.Rows);
  708. Top.Frame = full;
  709. Top.Width = full.Width;
  710. Top.Height = full.Height;
  711. Resized?.Invoke (new ResizedEventArgs () { Cols = full.Width, Rows = full.Height });
  712. Driver.Clip = full;
  713. foreach (var t in toplevels) {
  714. t.PositionToplevels ();
  715. t.SetRelativeLayout (full);
  716. t.LayoutSubviews ();
  717. }
  718. Refresh ();
  719. }
  720. }
  721. }