123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140 |
- //
- // Core.cs: The core engine for gui.cs
- //
- // Authors:
- // Miguel de Icaza ([email protected])
- //
- // Pending:
- // - Check for NeedDisplay on the hierarchy and repaint
- // - Layout support
- // - "Colors" type or "Attributes" type?
- // - What to surface as "BackgroundCOlor" when clearing a window, an attribute or colors?
- //
- // Optimziations
- // - Add rendering limitation to the exposed area
- using System;
- using System.Collections;
- using System.Collections.Generic;
- using System.Threading;
- using System.Linq;
- namespace Terminal {
- public class Responder {
- public virtual bool CanFocus { get; set; }
- public virtual bool HasFocus { get; internal set; }
- // Key handling
- /// <summary>
- /// This method can be overwritten by view that
- /// want to provide accelerator functionality
- /// (Alt-key for example).
- /// </summary>
- /// <remarks>
- /// <para>
- /// Before keys are sent to the subview on the
- /// current view, all the views are
- /// processed and the key is passed to the widgets
- /// to allow some of them to process the keystroke
- /// as a hot-key. </para>
- /// <para>
- /// For example, if you implement a button that
- /// has a hotkey ok "o", you would catch the
- /// combination Alt-o here. If the event is
- /// caught, you must return true to stop the
- /// keystroke from being dispatched to other
- /// views.
- /// </para>
- /// </remarks>
- public virtual bool ProcessHotKey (KeyEvent kb)
- {
- return false;
- }
- /// <summary>
- /// If the view is focused, gives the view a
- /// chance to process the keystroke.
- /// </summary>
- /// <remarks>
- /// <para>
- /// Views can override this method if they are
- /// interested in processing the given keystroke.
- /// If they consume the keystroke, they must
- /// return true to stop the keystroke from being
- /// processed by other widgets or consumed by the
- /// widget engine. If they return false, the
- /// keystroke will be passed using the ProcessColdKey
- /// method to other views to process.
- /// </para>
- /// <para>
- /// The View implementation does nothing but return false,
- /// so it is not necessary to call base.ProcessKey if you
- /// derive directly from View, but you should if you derive
- /// other View subclasses.
- /// </para>
- /// </remarks>
- public virtual bool ProcessKey (KeyEvent kb)
- {
- return false;
- }
- /// <summary>
- /// This method can be overwritten by views that
- /// want to provide accelerator functionality
- /// (Alt-key for example), but without
- /// interefering with normal ProcessKey behavior.
- /// </summary>
- /// <remarks>
- /// <para>
- /// After keys are sent to the subviews on the
- /// current view, all the view are
- /// processed and the key is passed to the views
- /// to allow some of them to process the keystroke
- /// as a cold-key. </para>
- /// <para>
- /// This functionality is used, for example, by
- /// default buttons to act on the enter key.
- /// Processing this as a hot-key would prevent
- /// non-default buttons from consuming the enter
- /// keypress when they have the focus.
- /// </para>
- /// </remarks>
- public virtual bool ProcessColdKey (KeyEvent kb)
- {
- return false;
- }
- // Mouse events
- public virtual bool MouseEvent (MouseEvent me)
- {
- return false;
- }
- }
- public class View : Responder, IEnumerable {
- string id = "";
- View container = null;
- View focused = null;
- public static ConsoleDriver Driver = Application.Driver;
- public static IList<View> empty = new List<View> (0).AsReadOnly ();
- List<View> subviews;
- public IList<View> Subviews => subviews == null ? empty : subviews.AsReadOnly ();
- internal Rect NeedDisplay { get; private set; } = Rect.Empty;
- // The frame for the object
- Rect frame;
- public string Id {
- get => id;
- set {
- id = value;
- }
- }
- // The frame for this view
- public Rect Frame {
- get => frame;
- set {
- if (SuperView != null) {
- SuperView.SetNeedsDisplay (frame);
- SuperView.SetNeedsDisplay (value);
- }
- frame = value;
- SetNeedsDisplay (frame);
- }
- }
- public IEnumerator GetEnumerator ()
- {
- foreach (var v in subviews)
- yield return v;
- }
- public Rect Bounds {
- get => new Rect (Point.Empty, Frame.Size);
- set {
- Frame = new Rect (frame.Location, value.Size);
- }
- }
- public View SuperView => container;
- public View (Rect frame)
- {
- this.Frame = frame;
- CanFocus = false;
- }
- /// <summary>
- /// Invoke to flag that this view needs to be redisplayed, by any code
- /// that alters the state of the view.
- /// </summary>
- public void SetNeedsDisplay ()
- {
- SetNeedsDisplay (Frame);
- }
- public void SetNeedsDisplay (Rect region)
- {
- if (NeedDisplay.IsEmpty)
- NeedDisplay = region;
- else {
- var x = Math.Min (NeedDisplay.X, region.X);
- var y = Math.Min (NeedDisplay.Y, region.Y);
- var w = Math.Max (NeedDisplay.Width, region.Width);
- var h = Math.Max (NeedDisplay.Height, region.Height);
- NeedDisplay = new Rect (x, y, w, h);
- }
- if (container != null)
- container.ChildNeedsDisplay ();
- if (subviews == null)
- return;
- foreach (var view in subviews)
- if (view.Frame.IntersectsWith (region)) {
- view.SetNeedsDisplay (Rect.Intersect (view.Frame, region));
- }
- }
- internal bool childNeedsDisplay;
- public void ChildNeedsDisplay ()
- {
- childNeedsDisplay = true;
- if (container != null)
- container.ChildNeedsDisplay ();
- }
- /// <summary>
- /// Adds a subview to this view.
- /// </summary>
- /// <remarks>
- /// </remarks>
- public virtual void Add (View view)
- {
- if (view == null)
- return;
- if (subviews == null)
- subviews = new List<View> ();
- subviews.Add (view);
- view.container = this;
- if (view.CanFocus)
- CanFocus = true;
- SetNeedsDisplay ();
- }
- public void Add (params View [] views)
- {
- if (views == null)
- return;
- foreach (var view in views)
- Add (view);
- }
- /// <summary>
- /// Removes all the widgets from this container.
- /// </summary>
- /// <remarks>
- /// </remarks>
- public virtual void RemoveAll ()
- {
- if (subviews == null)
- return;
- while (subviews.Count > 0) {
- var view = subviews [0];
- Remove (view);
- subviews.RemoveAt (0);
- }
- }
- /// <summary>
- /// Removes a widget from this container.
- /// </summary>
- /// <remarks>
- /// </remarks>
- public virtual void Remove (View view)
- {
- if (view == null)
- return;
- SetNeedsDisplay ();
- var touched = view.Frame;
- subviews.Remove (view);
- view.container = null;
- if (subviews.Count < 1)
- this.CanFocus = false;
- foreach (var v in subviews) {
- if (v.Frame.IntersectsWith (touched))
- view.SetNeedsDisplay ();
- }
- }
- /// <summary>
- /// Clears the view region with the current color.
- /// </summary>
- /// <remarks>
- /// <para>
- /// This clears the entire region used by this view.
- /// </para>
- /// </remarks>
- public void Clear ()
- {
- var h = Frame.Height;
- var w = Frame.Width;
- for (int line = 0; line < h; line++) {
- Move (0, line);
- for (int col = 0; col < w; col++)
- Driver.AddCh (' ');
- }
- }
- /// <summary>
- /// Converts the (col,row) position from the view into a screen (col,row). The values are clamped to (0..ScreenDim-1)
- /// </summary>
- /// <param name="col">View-based column.</param>
- /// <param name="row">View-based row.</param>
- /// <param name="rcol">Absolute column, display relative.</param>
- /// <param name="rrow">Absolute row, display relative.</param>
- internal void ViewToScreen (int col, int row, out int rcol, out int rrow, bool clipped = true)
- {
- // Computes the real row, col relative to the screen.
- rrow = row + frame.Y;
- rcol = col + frame.X;
- var ccontainer = container;
- while (ccontainer != null) {
- rrow += ccontainer.frame.Y;
- rcol += ccontainer.frame.X;
- ccontainer = ccontainer.container;
- }
- // The following ensures that the cursor is always in the screen boundaries.
- if (clipped) {
- rrow = Math.Max (0, Math.Min (rrow, Driver.Rows - 1));
- rcol = Math.Max (0, Math.Min (rcol, Driver.Cols - 1));
- }
- }
- // Converts a rectangle in view coordinates to screen coordinates.
- Rect RectToScreen (Rect rect)
- {
- ViewToScreen (rect.X, rect.Y, out var x, out var y, clipped: false);
- return new Rect (x, y, rect.Width, rect.Height);
- }
- // Clips a rectangle in screen coordinates to the dimensions currently available on the screen
- Rect ScreenClip (Rect rect)
- {
- var x = rect.X < 0 ? 0 : rect.X;
- var y = rect.Y < 0 ? 0 : rect.Y;
- var w = rect.X + rect.Width >= Driver.Cols ? Driver.Cols - rect.X : rect.Width;
- var h = rect.Y + rect.Height >= Driver.Rows ? Driver.Rows - rect.Y : rect.Height;
- return new Rect (x, y, w, h);
- }
- /// <summary>
- /// Draws a frame in the current view, clipped by the boundary of this view
- /// </summary>
- /// <param name="rect">Rectangular region for the frame to be drawn.</param>
- /// <param name="fill">If set to <c>true</c> it fill will the contents.</param>
- public void DrawFrame (Rect rect, bool fill = false)
- {
- var scrRect = RectToScreen (rect);
- var savedClip = Driver.Clip;
- Driver.Clip = ScreenClip (RectToScreen (Bounds));
- Driver.DrawFrame (scrRect, fill);
- Driver.Clip = savedClip;
- }
- /// <summary>
- /// Utility function to draw strings that contain a hotkey
- /// </summary>
- /// <param name="text">String to display, the underscoore before a letter flags the next letter as the hotkey.</param>
- /// <param name="hotColor">Hot color.</param>
- /// <param name="normalColor">Normal color.</param>
- public void DrawHotString (string text, Attribute hotColor, Attribute normalColor)
- {
- Driver.SetAttribute (normalColor);
- foreach (var c in text) {
- if (c == '_') {
- Driver.SetAttribute (hotColor);
- continue;
- }
- Driver.AddCh (c);
- Driver.SetAttribute (normalColor);
- }
- }
- /// <summary>
- /// Utility function to draw strings that contains a hotkey using a colorscheme and the "focused" state.
- /// </summary>
- /// <param name="text">String to display, the underscoore before a letter flags the next letter as the hotkey.</param>
- /// <param name="focused">If set to <c>true</c> this uses the focused colors from the color scheme, otherwise the regular ones.</param>
- /// <param name="scheme">The color scheme to use.</param>
- public void DrawHotString (string text, bool focused, ColorScheme scheme)
- {
- if (focused)
- DrawHotString (text, scheme.HotFocus, scheme.Focus);
- else
- DrawHotString (text, scheme.HotNormal, scheme.Normal);
- }
- /// <summary>
- /// This moves the cursor to the specified column and row in the view.
- /// </summary>
- /// <returns>The move.</returns>
- /// <param name="col">Col.</param>
- /// <param name="row">Row.</param>
- public void Move (int col, int row)
- {
- ViewToScreen (col, row, out var rcol, out var rrow);
- Driver.Move (rcol, rrow);
- }
- /// <summary>
- /// Positions the cursor in the right position based on the currently focused view in the chain.
- /// </summary>
- public virtual void PositionCursor ()
- {
- if (focused != null)
- focused.PositionCursor ();
- else
- Move (frame.X, frame.Y);
- }
- public override bool HasFocus {
- get {
- return base.HasFocus;
- }
- internal set {
- if (base.HasFocus != value)
- SetNeedsDisplay ();
- base.HasFocus = value;
- }
- }
- /// <summary>
- /// Returns the currently focused view inside this view, or null if nothing is focused.
- /// </summary>
- /// <value>The focused.</value>
- public View Focused => focused;
- public View MostFocused {
- get {
- if (Focused == null)
- return null;
- var most = Focused.MostFocused;
- if (most != null)
- return most;
- return Focused;
- }
- }
- /// <summary>
- /// Displays the specified character in the specified column and row.
- /// </summary>
- /// <param name="col">Col.</param>
- /// <param name="row">Row.</param>
- /// <param name="ch">Ch.</param>
- public void AddCh (int col, int row, int ch)
- {
- if (row < 0 || col < 0)
- return;
- if (row > frame.Height - 1 || col > frame.Width - 1)
- return;
- Move (col, row);
- Driver.AddCh (ch);
- }
- protected void ClearNeedsDisplay ()
- {
- NeedDisplay = Rect.Empty;
- childNeedsDisplay = false;
- }
- /// <summary>
- /// Performs a redraw of this view and its subviews, only redraws the views that have been flagged for a re-display.
- /// </summary>
- /// <remarks>
- /// The region argument is relative to the view itself.
- /// </remarks>
- public virtual void Redraw (Rect region)
- {
- var clipRect = new Rect (Point.Empty, frame.Size);
- if (subviews != null) {
- foreach (var view in subviews) {
- if (!view.NeedDisplay.IsEmpty || view.childNeedsDisplay) {
- if (view.Frame.IntersectsWith (clipRect) && view.Frame.IntersectsWith (region)) {
- // TODO: optimize this by computing the intersection of region and view.Bounds
- view.Redraw (view.Bounds);
- }
- view.NeedDisplay = Rect.Empty;
- view.childNeedsDisplay = false;
- }
- }
- }
- ClearNeedsDisplay ();
- }
- /// <summary>
- /// Focuses the specified sub-view.
- /// </summary>
- /// <param name="view">View.</param>
- public void SetFocus (View view)
- {
- if (view == null)
- return;
- //Console.WriteLine ($"Request to focus {view}");
- if (!view.CanFocus)
- return;
- if (focused == view)
- return;
- // Make sure that this view is a subview
- View c;
- for (c = view.container; c != null; c = c.container)
- if (c == this)
- break;
- if (c == null)
- throw new ArgumentException ("the specified view is not part of the hierarchy of this view");
- if (focused != null)
- focused.HasFocus = false;
- focused = view;
- focused.HasFocus = true;
- focused.EnsureFocus ();
- }
- public override bool ProcessKey (KeyEvent kb)
- {
- if (Focused?.ProcessKey (kb) == true)
- return true;
- return false;
- }
- public override bool ProcessHotKey (KeyEvent kb)
- {
- if (subviews == null || subviews.Count == 0)
- return false;
- foreach (var view in subviews)
- if (view.ProcessHotKey (kb))
- return true;
- return false;
- }
- public override bool ProcessColdKey (KeyEvent kb)
- {
- if (subviews == null || subviews.Count == 0)
- return false;
- foreach (var view in subviews)
- if (view.ProcessHotKey (kb))
- return true;
- return false;
- }
- /// <summary>
- /// Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing.
- /// </summary>
- public void EnsureFocus ()
- {
- if (focused == null)
- FocusFirst ();
- }
- /// <summary>
- /// Focuses the first focusable subview if one exists.
- /// </summary>
- public void FocusFirst ()
- {
- if (subviews == null) {
- SuperView.SetFocus (this);
- return;
- }
- foreach (var view in subviews) {
- if (view.CanFocus) {
- SetFocus (view);
- return;
- }
- }
- }
- /// <summary>
- /// Focuses the last focusable subview if one exists.
- /// </summary>
- public void FocusLast ()
- {
- if (subviews == null)
- return;
- for (int i = subviews.Count; i > 0;) {
- i--;
- View v = subviews [i];
- if (v.CanFocus) {
- SetFocus (v);
- return;
- }
- }
- }
- /// <summary>
- /// Focuses the previous view.
- /// </summary>
- /// <returns><c>true</c>, if previous was focused, <c>false</c> otherwise.</returns>
- public bool FocusPrev ()
- {
- if (subviews == null || subviews.Count == 0)
- return false;
- if (focused == null) {
- FocusLast ();
- return true;
- }
- int focused_idx = -1;
- for (int i = subviews.Count; i > 0;) {
- i--;
- View w = subviews [i];
- if (w.HasFocus) {
- if (w.FocusPrev ())
- return true;
- focused_idx = i;
- continue;
- }
- if (w.CanFocus && focused_idx != -1) {
- focused.HasFocus = false;
- if (w.CanFocus)
- w.FocusLast ();
- SetFocus (w);
- return true;
- }
- }
- if (focused_idx != -1) {
- FocusLast ();
- return true;
- }
- if (focused != null) {
- focused.HasFocus = false;
- focused = null;
- }
- return false;
- }
- /// <summary>
- /// Focuses the next view.
- /// </summary>
- /// <returns><c>true</c>, if next was focused, <c>false</c> otherwise.</returns>
- public bool FocusNext ()
- {
- if (subviews == null || subviews.Count == 0)
- return false;
- if (focused == null) {
- FocusFirst ();
- return focused != null;
- }
- int n = subviews.Count;
- int focused_idx = -1;
- for (int i = 0; i < n; i++) {
- View w = subviews [i];
- if (w.HasFocus) {
- if (w.FocusNext ())
- return true;
- focused_idx = i;
- continue;
- }
- if (w.CanFocus && focused_idx != -1) {
- focused.HasFocus = false;
- if (w != null && w.CanFocus)
- w.FocusFirst ();
- SetFocus (w);
- return true;
- }
- }
- if (focused != null) {
- focused.HasFocus = false;
- focused = null;
- }
- return false;
- }
- public virtual void LayoutSubviews ()
- {
- }
- public override string ToString ()
- {
- return $"{GetType ().Name}({id})({Frame})";
- }
- }
- /// <summary>
- /// Toplevel views can be modally executed.
- /// </summary>
- /// <remarks>
- /// <para>
- /// Toplevels can be modally executing views, and they return control
- /// to the caller when the "Running" property is set to false.
- /// </para>
- /// </remarks>
- public class Toplevel : View {
- public bool Running;
- public Toplevel (Rect frame) : base (frame)
- {
- }
- public static Toplevel Create ()
- {
- return new Toplevel (new Rect (0, 0, Driver.Cols, Driver.Rows));
- }
- public override bool CanFocus {
- get => true;
- }
- public override bool ProcessKey (KeyEvent kb)
- {
- if (base.ProcessKey (kb))
- return true;
- switch (kb.Key) {
- case Key.ControlC:
- // TODO: stop current execution of this container
- break;
- case Key.ControlZ:
- // TODO: should suspend
- // console_csharp_send_sigtstp ();
- break;
- case Key.Tab:
- var old = Focused;
- if (!FocusNext ())
- FocusNext ();
- if (old != Focused) {
- old?.SetNeedsDisplay ();
- Focused?.SetNeedsDisplay ();
- }
- return true;
- case Key.BackTab:
- old = Focused;
- if (!FocusPrev ())
- FocusPrev ();
- if (old != Focused) {
- old?.SetNeedsDisplay ();
- Focused?.SetNeedsDisplay ();
- }
- return true;
- case Key.ControlL:
- Application.Refresh ();
- return true;
- }
- return false;
- }
- }
- /// <summary>
- /// A toplevel view that draws a frame around its region and has a "ContentView" subview where the contents are added.
- /// </summary>
- public class Window : Toplevel, IEnumerable {
- View contentView;
- string title;
- public string Title {
- get => title;
- set {
- title = value;
- SetNeedsDisplay ();
- }
- }
- class ContentView : View {
- public ContentView (Rect frame) : base (frame) { }
- }
- /// <summary>
- /// Initializes a new instance of the <see cref="T:Terminal.Window"/> class with an optioanl title
- /// </summary>
- /// <param name="frame">Frame.</param>
- /// <param name="title">Title.</param>
- public Window (Rect frame, string title = null) : base (frame)
- {
- this.Title = title;
- frame.Inflate (-1, -1);
- contentView = new ContentView (frame);
- base.Add (contentView);
- }
- /// <summary>
- /// Enumerates the various views in the ContentView.
- /// </summary>
- /// <returns>The enumerator.</returns>
- public new IEnumerator GetEnumerator ()
- {
- return contentView.GetEnumerator ();
- }
- void DrawFrame ()
- {
- DrawFrame (new Rect (0, 0, Frame.Width, Frame.Height), true);
- }
- /// <summary>
- /// Add the specified view to the ContentView.
- /// </summary>
- /// <param name="view">View to add to the window.</param>
- public override void Add (View view)
- {
- contentView.Add (view);
- }
- public override void Redraw (Rect bounds)
- {
- if (!NeedDisplay.IsEmpty) {
- Driver.SetAttribute (Colors.Base.Normal);
- DrawFrame ();
- if (HasFocus)
- Driver.SetAttribute (Colors.Dialog.Normal);
- var width = Frame.Width;
- if (Title != null && width > 4) {
- Move (1, 0);
- Driver.AddCh (' ');
- var str = Title.Length > width ? Title.Substring (0, width - 4) : Title;
- Driver.AddStr (str);
- Driver.AddCh (' ');
- }
- Driver.SetAttribute (Colors.Dialog.Normal);
- }
- contentView.Redraw (contentView.Bounds);
- ClearNeedsDisplay ();
- }
- }
- /// <summary>
- /// The application driver for gui.cs
- /// </summary>
- /// <remarks>
- /// <para>
- /// You can hook up to the Iteration event to have your method
- /// invoked on each iteration of the mainloop.
- /// </para>
- /// <para>
- /// Creates a mainloop to process input events, handle timers and
- /// other sources of data. It is accessible via the MainLoop property.
- /// </para>
- /// <para>
- /// When invoked sets the SynchronizationContext to one that is tied
- /// to the mainloop, allowing user code to use async/await.
- /// </para>
- /// </remarks>
- public class Application {
- public static ConsoleDriver Driver = new CursesDriver ();
- public static Toplevel Top { get; private set; }
- public static View Current { get; private set; }
- public static Mono.Terminal.MainLoop MainLoop { get; private set; }
- static Stack<View> toplevels = new Stack<View> ();
- /// <summary>
- /// This event is raised on each iteration of the
- /// main loop.
- /// </summary>
- /// <remarks>
- /// See also <see cref="Timeout"/>
- /// </remarks>
- static public event EventHandler Iteration;
- /// <summary>
- /// Returns a rectangle that is centered in the screen for the provided size.
- /// </summary>
- /// <returns>The centered rect.</returns>
- /// <param name="size">Size for the rectangle.</param>
- public static Rect MakeCenteredRect (Size size)
- {
- return new Rect (new Point ((Driver.Cols - size.Width) / 2, (Driver.Rows - size.Height) / 2), size);
- }
- //
- // provides the sync context set while executing code in gui.cs, to let
- // users use async/await on their code
- //
- class MainLoopSyncContext : SynchronizationContext {
- Mono.Terminal.MainLoop mainLoop;
- public MainLoopSyncContext (Mono.Terminal.MainLoop mainLoop)
- {
- this.mainLoop = mainLoop;
- }
- public override SynchronizationContext CreateCopy ()
- {
- return new MainLoopSyncContext (MainLoop);
- }
- public override void Post (SendOrPostCallback d, object state)
- {
- mainLoop.AddIdle (() => {
- d (state);
- return false;
- });
- }
- public override void Send (SendOrPostCallback d, object state)
- {
- mainLoop.Invoke (() => {
- d (state);
- });
- }
- }
- /// <summary>
- /// Initializes the Application
- /// </summary>
- public static void Init ()
- {
- if (Top != null)
- return;
- Driver.Init (TerminalResized);
- MainLoop = new Mono.Terminal.MainLoop ();
- SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext (MainLoop));
- Top = Toplevel.Create ();
- Current = Top;
- }
- public class RunState : IDisposable {
- internal RunState (Toplevel view)
- {
- Toplevel = view;
- }
- internal Toplevel Toplevel;
- public void Dispose ()
- {
- Dispose (true);
- GC.SuppressFinalize (this);
- }
- public virtual void Dispose (bool disposing)
- {
- if (Toplevel != null) {
- Application.End (Toplevel);
- Toplevel = null;
- }
- }
- }
- static void ProcessKeyEvent (KeyEvent ke)
- {
- if (Current.ProcessHotKey (ke))
- return;
- if (Current.ProcessKey (ke))
- return;
-
- // Process the key normally
- if (Current.ProcessColdKey (ke))
- return;
- }
- static View FindDeepestView (View start, int x, int y, out int resx, out int resy)
- {
- var startFrame = start.Frame;
- if (!startFrame.Contains (x, y)) {
- resx = 0;
- resy = 0;
- return null;
- }
- if (start.Subviews != null){
- int count = start.Subviews.Count;
- if (count > 0) {
- var rx = x - startFrame.X;
- var ry = y - startFrame.Y;
- for (int i = count - 1; i >= 0; i--) {
- View v = start.Subviews [i];
- if (v.Frame.Contains (rx, ry)) {
- var deep = FindDeepestView (v, rx, ry, out resx, out resy);
- if (deep == null)
- return v;
- return deep;
- }
- }
- }
- }
- resx = x-startFrame.X;
- resy = y-startFrame.Y;
- return start;
- }
- /// <summary>
- /// Merely a debugging aid to see the raw mouse events
- /// </summary>
- static public Action<MouseEvent> RootMouseEvent;
- static void ProcessMouseEvent (MouseEvent me)
- {
- RootMouseEvent?.Invoke (me);
- int rx, ry;
- var view = FindDeepestView (Current, me.X, me.Y, out rx, out ry);
- if (view != null) {
- var nme = new MouseEvent () {
- X = rx,
- Y = ry,
- Flags = me.Flags
- };
-
- // Should we bubbled up the event, if it is not handled?
- view.MouseEvent (nme);
- }
- }
- static public RunState Begin (Toplevel toplevel)
- {
- if (toplevel == null)
- throw new ArgumentNullException (nameof (toplevel));
- var rs = new RunState (toplevel);
- Init ();
- toplevels.Push (toplevel);
- Current = toplevel;
- Driver.PrepareToRun (MainLoop, ProcessKeyEvent, ProcessMouseEvent);
- toplevel.LayoutSubviews ();
- toplevel.FocusFirst ();
- Redraw (toplevel);
- toplevel.PositionCursor ();
- Driver.Refresh ();
- return rs;
- }
- static public void End (RunState rs)
- {
- if (rs == null)
- throw new ArgumentNullException (nameof (rs));
- rs.Dispose ();
- }
- static void Shutdown ()
- {
- Driver.End ();
- }
- static void Redraw (View view)
- {
- view.Redraw (view.Bounds);
- Driver.Refresh ();
- }
- static void Refresh (View view)
- {
- view.Redraw (view.Bounds);
- Driver.Refresh ();
- }
- /// <summary>
- /// Triggers a refresh of the entire display.
- /// </summary>
- public static void Refresh ()
- {
- Driver.RedrawTop ();
- View last = null;
- foreach (var v in toplevels.Reverse ()) {
- v.SetNeedsDisplay ();
- v.Redraw (v.Bounds);
- last = v;
- }
- last?.PositionCursor ();
- Driver.Refresh ();
- }
- internal static void End (View view)
- {
- if (toplevels.Peek () != view)
- throw new ArgumentException ("The view that you end with must be balanced");
- toplevels.Pop ();
- if (toplevels.Count == 0)
- Shutdown ();
- else {
- Current = toplevels.Peek ();
- Refresh ();
- }
- }
- /// <summary>
- /// Runs the main loop for the created dialog
- /// </summary>
- /// <remarks>
- /// Use the wait parameter to control whether this is a
- /// blocking or non-blocking call.
- /// </remarks>
- public static void RunLoop (RunState state, bool wait = true)
- {
- if (state == null)
- throw new ArgumentNullException (nameof (state));
- if (state.Toplevel == null)
- throw new ObjectDisposedException ("state");
- for (state.Toplevel.Running = true; state.Toplevel.Running;) {
- if (MainLoop.EventsPending (wait)) {
- MainLoop.MainIteration ();
- if (Iteration != null)
- Iteration (null, EventArgs.Empty);
- } else if (wait == false)
- return;
- if (!state.Toplevel.NeedDisplay.IsEmpty || state.Toplevel.childNeedsDisplay) {
- state.Toplevel.Redraw (state.Toplevel.Bounds);
- state.Toplevel.PositionCursor ();
- Driver.Refresh ();
- }
- }
- }
- public static void Run ()
- {
- Run (Top);
- }
- /// <summary>
- /// Runs the main loop on the given container.
- /// </summary>
- /// <remarks>
- /// <para>
- /// This method is used to start processing events
- /// for the main application, but it is also used to
- /// run modal dialog boxes.
- /// </para>
- /// <para>
- /// To make a toplevel stop execution, set the "Running"
- /// property to false.
- /// </para>
- /// </remarks>
- public static void Run (Toplevel view)
- {
- var runToken = Begin (view);
- RunLoop (runToken);
- End (runToken);
- }
- static void TerminalResized ()
- {
- foreach (var t in toplevels) {
- t.Frame = new Rect (0, 0, Driver.Cols, Driver.Rows);
- }
- }
- }
- }
|