//
// Core.cs: The core engine for gui.cs
//
// Authors:
// Miguel de Icaza (miguel@gnome.org)
//
// 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?
//
// Optimizations
// - Add rendering limitation to the exposed area
using System;
using System.Collections.Generic;
using System.Threading;
using System.Linq;
using System.ComponentModel;
using System.Globalization;
using System.Reflection;
using System.IO;
using Terminal.Gui;
using System.Text.Json.Serialization;
using static Terminal.Gui.ConfigurationManager;
namespace Terminal.Gui {
///
/// A static, singleton class providing the main application driver for Terminal.Gui apps.
///
///
///
/// // A simple Terminal.Gui app that creates a window with a frame and title with
/// // 5 rows/columns of padding.
/// Application.Init();
/// var win = new Window ($"Example App ({Application.QuitKey} to quit)") {
/// X = 5,
/// Y = 5,
/// Width = Dim.Fill (5),
/// Height = Dim.Fill (5)
/// };
/// Application.Top.Add(win);
/// Application.Run();
/// Application.Shutdown();
///
///
///
///
/// Creates a instance of to process input events, handle timers and
/// other sources of data. It is accessible via the property.
///
///
/// You can hook up to the event to have your method
/// invoked on each iteration of the .
///
///
/// When invoked sets the SynchronizationContext to one that is tied
/// to the mainloop, allowing user code to use async/await.
///
///
public static partial class Application {
static readonly Stack toplevels = new Stack ();
///
/// The current in use.
///
public static ConsoleDriver Driver;
///
/// Gets all the Mdi childes which represent all the not modal from the .
///
public static List MdiChildes {
get {
if (MdiTop != null) {
List mdiChildes = new List ();
foreach (var top in toplevels) {
if (top != MdiTop && !top.Modal) {
mdiChildes.Add (top);
}
}
return mdiChildes;
}
return null;
}
}
///
/// The object used for the application on startup which is true.
///
public static Toplevel MdiTop {
get {
if (Top.IsMdiContainer) {
return Top;
}
return null;
}
}
///
/// The object used for the application on startup ()
///
/// The top.
public static Toplevel Top { get; private set; }
///
/// The current object. This is updated when enters and leaves to point to the current .
///
/// The current.
public static Toplevel Current { get; private set; }
///
/// The current object that wants continuous mouse button pressed events.
///
public static View WantContinuousButtonPressedView { get; private set; }
private static bool? _enableConsoleScrolling;
///
/// The current used in the terminal.
///
///
///
/// If (the default) the height of the Terminal.Gui application ()
/// tracks to the height of the visible console view when the console is resized. In this case
/// scrolling in the console will be disabled and all will remain visible.
///
///
/// If then height of the Terminal.Gui application only tracks
/// the height of the visible console view when the console is made larger (the application will only grow in height, never shrink).
/// In this case console scrolling is enabled and the contents ( high) will scroll
/// as the console scrolls.
///
/// This API was previously named 'HeightAsBuffer` but was renamed to make its purpose more clear.
///
[SerializableConfigurationProperty (Scope = typeof (SettingsScope))]
public static bool EnableConsoleScrolling {
get {
if (Driver == null) {
return _enableConsoleScrolling.HasValue && _enableConsoleScrolling.Value;
}
return Driver.EnableConsoleScrolling;
}
set {
_enableConsoleScrolling = value;
if (Driver == null) {
return;
}
Driver.EnableConsoleScrolling = value;
}
}
static Key alternateForwardKey = Key.PageDown | Key.CtrlMask;
///
/// Alternative key to navigate forwards through views. Ctrl+Tab is the primary key.
///
[SerializableConfigurationProperty (Scope = typeof (SettingsScope)), JsonConverter (typeof (KeyJsonConverter))]
public static Key AlternateForwardKey {
get => alternateForwardKey;
set {
if (alternateForwardKey != value) {
var oldKey = alternateForwardKey;
alternateForwardKey = value;
OnAlternateForwardKeyChanged (new KeyChangedEventArgs (oldKey, value));
}
}
}
static void OnAlternateForwardKeyChanged (KeyChangedEventArgs e)
{
foreach (var top in toplevels.ToArray ()) {
top.OnAlternateForwardKeyChanged (e);
}
}
static Key alternateBackwardKey = Key.PageUp | Key.CtrlMask;
///
/// Alternative key to navigate backwards through views. Shift+Ctrl+Tab is the primary key.
///
[SerializableConfigurationProperty (Scope = typeof (SettingsScope)), JsonConverter (typeof (KeyJsonConverter))]
public static Key AlternateBackwardKey {
get => alternateBackwardKey;
set {
if (alternateBackwardKey != value) {
var oldKey = alternateBackwardKey;
alternateBackwardKey = value;
OnAlternateBackwardKeyChanged (new KeyChangedEventArgs (oldKey, value));
}
}
}
static void OnAlternateBackwardKeyChanged (KeyChangedEventArgs oldKey)
{
foreach (var top in toplevels.ToArray ()) {
top.OnAlternateBackwardKeyChanged (oldKey);
}
}
static Key quitKey = Key.Q | Key.CtrlMask;
///
/// Gets or sets the key to quit the application.
///
[SerializableConfigurationProperty (Scope = typeof (SettingsScope)), JsonConverter (typeof (KeyJsonConverter))]
public static Key QuitKey {
get => quitKey;
set {
if (quitKey != value) {
var oldKey = quitKey;
quitKey = value;
OnQuitKeyChanged (new KeyChangedEventArgs (oldKey, value));
}
}
}
private static List supportedCultures;
///
/// Gets all supported cultures by the application without the invariant language.
///
public static List SupportedCultures => supportedCultures;
static void OnQuitKeyChanged (KeyChangedEventArgs e)
{
// Duplicate the list so if it changes during enumeration we're safe
foreach (var top in toplevels.ToArray ()) {
top.OnQuitKeyChanged (e);
}
}
///
/// The driver for the application
///
/// The main loop.
public static MainLoop MainLoop { get; private set; }
///
/// Disable or enable the mouse. The mouse is enabled by default.
///
[SerializableConfigurationProperty (Scope = typeof (SettingsScope))]
public static bool IsMouseDisabled { get; set; }
///
/// Set to true to cause the RunLoop method to exit after the first iterations.
/// Set to false (the default) to cause the RunLoop to continue running until Application.RequestStop() is called.
///
public static bool ExitRunLoopAfterFirstIteration { get; set; } = false;
///
/// Notify that a new was created ( was called). The token is created in
/// and this event will be fired before that function exits.
///
///
/// If is callers to
/// must also subscribe to
/// and manually dispose of the token when the application is done.
///
public static event EventHandler NotifyNewRunState;
///
/// Notify that a existent is stopping ( was called).
///
///
/// If is callers to
/// must also subscribe to
/// and manually dispose of the token when the application is done.
///
public static event EventHandler NotifyStopRunState;
///
/// This event is raised on each iteration of the .
///
///
/// See also
///
public static Action Iteration;
///
/// Returns a rectangle that is centered in the screen for the provided size.
///
/// The centered rect.
/// Size for the rectangle.
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 Terminal.Gui, to let
// users use async/await on their code
//
class MainLoopSyncContext : SynchronizationContext {
readonly MainLoop mainLoop;
public MainLoopSyncContext (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;
});
//mainLoop.Driver.Wakeup ();
}
public override void Send (SendOrPostCallback d, object state)
{
if (Thread.CurrentThread.ManagedThreadId == _mainThreadId) {
d (state);
} else {
var wasExecuted = false;
mainLoop.Invoke (() => {
d (state);
wasExecuted = true;
});
while (!wasExecuted) {
Thread.Sleep (15);
}
}
}
}
///
/// If , forces the use of the System.Console-based (see ) driver. The default is .
///
[SerializableConfigurationProperty (Scope = typeof (SettingsScope))]
public static bool UseSystemConsole { get; set; } = false;
// For Unit testing - ignores UseSystemConsole
internal static bool ForceFakeConsole;
///
/// Initializes a new instance of Application.
///
///
/// Call this method once per instance (or after has been called).
///
///
/// This function loads the right for the platform,
/// Creates a . and assigns it to
///
///
/// must be called when the application is closing (typically after has
/// returned) to ensure resources are cleaned up and terminal settings restored.
///
///
/// The function
/// combines and
/// into a single call. An applciation cam use
/// without explicitly calling .
///
///
/// The to use. If not specified the default driver for the
/// platform will be used (see , , and ).
///
/// Specifies the to use.
/// Must not be if is not .
///
public static void Init (ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) => InternalInit (() => Toplevel.Create (), driver, mainLoopDriver);
internal static bool _initialized = false;
internal static int _mainThreadId = -1;
// INTERNAL function for initializing an app with a Toplevel factory object, driver, and mainloop.
//
// Called from:
//
// Init() - When the user wants to use the default Toplevel. calledViaRunT will be false, causing all state to be reset.
// Run() - When the user wants to use a custom Toplevel. calledViaRunT will be true, enabling Run() to be called without calling Init first.
// Unit Tests - To initialize the app with a custom Toplevel, using the FakeDriver. calledViaRunT will be false, causing all state to be reset.
//
// calledViaRunT: If false (default) all state will be reset. If true the state will not be reset.
internal static void InternalInit (Func topLevelFactory, ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null, bool calledViaRunT = false)
{
if (_initialized && driver == null) return;
if (_initialized) {
throw new InvalidOperationException ("Init has already been called and must be bracketed by Shutdown.");
}
// Note in this case, we don't verify the type of the Toplevel created by new T().
// Used only for start debugging on Unix.
//#if DEBUG
// while (!System.Diagnostics.Debugger.IsAttached) {
// System.Threading.Thread.Sleep (100);
// }
// System.Diagnostics.Debugger.Break ();
//#endif
if (!calledViaRunT) {
// Reset all class variables (Application is a singleton).
ResetState ();
}
// For UnitTests
if (driver != null) {
//if (mainLoopDriver == null) {
// throw new ArgumentNullException ("InternalInit mainLoopDriver cannot be null if driver is provided.");
//}
//if (!(driver is FakeDriver)) {
// throw new InvalidOperationException ("InternalInit can only be called with FakeDriver.");
//}
Driver = driver;
}
// Start the process of configuration management.
// Note that we end up calling LoadConfigurationFromAllSources
// mulitlple times. We need to do this because some settings are only
// valid after a Driver is loaded. In this cases we need just
// `Settings` so we can determine which driver to use.
ConfigurationManager.Load (true);
ConfigurationManager.Apply ();
if (Driver == null) {
var p = Environment.OSVersion.Platform;
if (ForceFakeConsole) {
// For Unit Testing only
Driver = new FakeDriver ();
} else if (UseSystemConsole) {
Driver = new NetDriver ();
} else if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows) {
Driver = new WindowsDriver ();
} else {
Driver = new CursesDriver ();
}
if (Driver == null) {
throw new InvalidOperationException ("Init could not determine the ConsoleDriver to use.");
}
}
if (mainLoopDriver == null) {
// TODO: Move this logic into ConsoleDriver
if (Driver is FakeDriver) {
mainLoopDriver = new FakeMainLoop (Driver);
} else if (Driver is NetDriver) {
mainLoopDriver = new NetMainLoop (Driver);
} else if (Driver is WindowsDriver) {
mainLoopDriver = new WindowsMainLoop (Driver);
} else if (Driver is CursesDriver) {
mainLoopDriver = new UnixMainLoop (Driver);
}
if (mainLoopDriver == null) {
throw new InvalidOperationException ("Init could not determine the MainLoopDriver to use.");
}
}
MainLoop = new MainLoop (mainLoopDriver);
try {
Driver.EnableConsoleScrolling = EnableConsoleScrolling;
Driver.Init (TerminalResized);
} catch (InvalidOperationException ex) {
// This is a case where the driver is unable to initialize the console.
// This can happen if the console is already in use by another process or
// if running in unit tests.
// In this case, we want to throw a more specific exception.
throw new InvalidOperationException ("Unable to initialize the console. This can happen if the console is already in use by another process or in unit tests.", ex);
}
SynchronizationContext.SetSynchronizationContext (new MainLoopSyncContext (MainLoop));
Top = topLevelFactory ();
Current = Top;
supportedCultures = GetSupportedCultures ();
_mainThreadId = Thread.CurrentThread.ManagedThreadId;
_initialized = true;
}
///
/// Captures the execution state for the provided view.
///
public class RunState : IDisposable {
///
/// Initializes a new class.
///
///
public RunState (Toplevel view)
{
Toplevel = view;
}
///
/// The belong to this .
///
public Toplevel Toplevel { get; internal set; }
#if DEBUG_IDISPOSABLE
///
/// For debug purposes to verify objects are being disposed properly
///
public bool WasDisposed = false;
///
/// For debug purposes to verify objects are being disposed properly
///
public int DisposedCount = 0;
///
/// For debug purposes
///
public static List Instances = new List ();
///
/// For debug purposes
///
public RunState ()
{
Instances.Add (this);
}
#endif
///
/// Releases all resource used by the object.
///
///
/// Call when you are finished using the .
///
///
/// method leaves the in an unusable state. After
/// calling , you must release all references to the
/// so the garbage collector can reclaim the memory that the
/// was occupying.
///
public void Dispose ()
{
Dispose (true);
GC.SuppressFinalize (this);
#if DEBUG_IDISPOSABLE
WasDisposed = true;
#endif
}
///
/// Releases all resource used by the object.
///
/// If set to we are disposing and should dispose held objects.
protected virtual void Dispose (bool disposing)
{
if (Toplevel != null && disposing) {
throw new InvalidOperationException ("You must clean up (Dispose) the Toplevel before calling Application.RunState.Dispose");
// BUGBUG: It's insidious that we call EndFirstTopLevel here so I moved it to End.
//EndFirstTopLevel (Toplevel);
//Toplevel.Dispose ();
//Toplevel = null;
}
}
}
static void ProcessKeyEvent (KeyEvent ke)
{
if (RootKeyEvent?.Invoke (ke) ?? false) {
return;
}
var chain = toplevels.ToList ();
foreach (var topLevel in chain) {
if (topLevel.ProcessHotKey (ke))
return;
if (topLevel.Modal)
break;
}
foreach (var topLevel in chain) {
if (topLevel.ProcessKey (ke))
return;
if (topLevel.Modal)
break;
}
foreach (var topLevel in chain) {
// Process the key normally
if (topLevel.ProcessColdKey (ke))
return;
if (topLevel.Modal)
break;
}
}
static void ProcessKeyDownEvent (KeyEvent ke)
{
var chain = toplevels.ToList ();
foreach (var topLevel in chain) {
if (topLevel.OnKeyDown (ke))
return;
if (topLevel.Modal)
break;
}
}
static void ProcessKeyUpEvent (KeyEvent ke)
{
var chain = toplevels.ToList ();
foreach (var topLevel in chain) {
if (topLevel.OnKeyUp (ke))
return;
if (topLevel.Modal)
break;
}
}
static View FindDeepestTop (Toplevel 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 (toplevels != null) {
int count = toplevels.Count;
if (count > 0) {
var rx = x - startFrame.X;
var ry = y - startFrame.Y;
foreach (var t in toplevels) {
if (t != Current) {
if (t != start && t.Visible && t.Frame.Contains (rx, ry)) {
start = t;
break;
}
}
}
}
}
resx = x - startFrame.X;
resy = y - startFrame.Y;
return start;
}
static View FindDeepestMdiView (View start, int x, int y, out int resx, out int resy)
{
if (start.GetType ().BaseType != typeof (Toplevel)
&& !((Toplevel)start).IsMdiContainer) {
resx = 0;
resy = 0;
return null;
}
var startFrame = start.Frame;
if (!startFrame.Contains (x, y)) {
resx = 0;
resy = 0;
return null;
}
int count = toplevels.Count;
for (int i = count - 1; i >= 0; i--) {
foreach (var top in toplevels) {
var rx = x - startFrame.X;
var ry = y - startFrame.Y;
if (top.Visible && top.Frame.Contains (rx, ry)) {
var deep = View.FindDeepestView (top, rx, ry, out resx, out resy);
if (deep == null)
return FindDeepestMdiView (top, rx, ry, out resx, out resy);
if (deep != MdiTop)
return deep;
}
}
}
resx = x - startFrame.X;
resy = y - startFrame.Y;
return start;
}
static View FindTopFromView (View view)
{
View top = view?.SuperView != null && view?.SuperView != Top
? view.SuperView : view;
while (top?.SuperView != null && top?.SuperView != Top) {
top = top.SuperView;
}
return top;
}
static View mouseGrabView;
///
/// The view that grabbed the mouse, to where will be routed all the mouse events.
///
public static View MouseGrabView => mouseGrabView;
///
/// Event to be invoked when a view want grab the mouse which can be canceled.
///
public static event EventHandler GrabbingMouse;
///
/// Event to be invoked when a view want ungrab the mouse which can be canceled.
///
public static event EventHandler UnGrabbingMouse;
///
/// Event to be invoked when a view grab the mouse.
///
public static event EventHandler GrabbedMouse;
///
/// Event to be invoked when a view ungrab the mouse.
///
public static event EventHandler UnGrabbedMouse;
///
/// Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called.
///
/// The grab.
/// View that will receive all mouse events until UngrabMouse is invoked.
public static void GrabMouse (View view)
{
if (view == null)
return;
if (!OnGrabbingMouse (view)) {
OnGrabbedMouse (view);
mouseGrabView = view;
Driver.UncookMouse ();
}
}
///
/// Releases the mouse grab, so mouse events will be routed to the view on which the mouse is.
///
public static void UngrabMouse ()
{
if (mouseGrabView == null)
return;
if (!OnUnGrabbingMouse (mouseGrabView)) {
OnUnGrabbedMouse (mouseGrabView);
mouseGrabView = null;
Driver.CookMouse ();
}
}
static bool OnGrabbingMouse (View view)
{
if (view == null)
return false;
var evArgs = new GrabMouseEventArgs (view);
GrabbingMouse?.Invoke (view, evArgs);
return evArgs.Cancel;
}
static bool OnUnGrabbingMouse (View view)
{
if (view == null)
return false;
var evArgs = new GrabMouseEventArgs (view);
UnGrabbingMouse?.Invoke (view, evArgs);
return evArgs.Cancel;
}
static void OnGrabbedMouse (View view)
{
if (view == null)
return;
GrabbedMouse?.Invoke (view, new ViewEventArgs (view));
}
static void OnUnGrabbedMouse (View view)
{
if (view == null)
return;
UnGrabbedMouse?.Invoke (view, new ViewEventArgs (view));
}
///
/// Merely a debugging aid to see the raw mouse events
///
public static Action RootMouseEvent;
///
///
/// Called for new KeyPress events before any processing is performed or
/// views evaluate. Use for global key handling and/or debugging.
///
/// Return true to suppress the KeyPress event
///
public static Func RootKeyEvent;
static View lastMouseOwnerView;
static void ProcessMouseEvent (MouseEvent me)
{
if (IsMouseDisabled) {
return;
}
var view = View.FindDeepestView (Current, me.X, me.Y, out int rx, out int ry);
if (view != null && view.WantContinuousButtonPressed) {
WantContinuousButtonPressedView = view;
} else {
WantContinuousButtonPressedView = null;
}
if (view != null) {
me.View = view;
}
RootMouseEvent?.Invoke (me);
if (me.Handled) {
return;
}
if (mouseGrabView != null) {
var newxy = mouseGrabView.ScreenToView (me.X, me.Y);
var nme = new MouseEvent () {
X = newxy.X,
Y = newxy.Y,
Flags = me.Flags,
OfX = me.X - newxy.X,
OfY = me.Y - newxy.Y,
View = view
};
if (OutsideFrame (new Point (nme.X, nme.Y), mouseGrabView.Frame)) {
lastMouseOwnerView?.OnMouseLeave (me);
}
//System.Diagnostics.Debug.WriteLine ($"{nme.Flags};{nme.X};{nme.Y};{mouseGrabView}");
if (mouseGrabView?.OnMouseEvent (nme) == true) {
return;
}
}
if ((view == null || view == MdiTop) && !Current.Modal && MdiTop != null
&& me.Flags != MouseFlags.ReportMousePosition && me.Flags != 0) {
var top = FindDeepestTop (Top, me.X, me.Y, out _, out _);
view = View.FindDeepestView (top, me.X, me.Y, out rx, out ry);
if (view != null && view != MdiTop && top != Current) {
MoveCurrent ((Toplevel)top);
}
}
if (view != null) {
var nme = new MouseEvent () {
X = rx,
Y = ry,
Flags = me.Flags,
OfX = 0,
OfY = 0,
View = view
};
if (lastMouseOwnerView == null) {
lastMouseOwnerView = view;
view.OnMouseEnter (nme);
} else if (lastMouseOwnerView != view) {
lastMouseOwnerView.OnMouseLeave (nme);
view.OnMouseEnter (nme);
lastMouseOwnerView = view;
}
if (!view.WantMousePositionReports && me.Flags == MouseFlags.ReportMousePosition)
return;
if (view.WantContinuousButtonPressed)
WantContinuousButtonPressedView = view;
else
WantContinuousButtonPressedView = null;
// Should we bubbled up the event, if it is not handled?
view.OnMouseEvent (nme);
EnsuresTopOnFront ();
}
}
// Only return true if the Current has changed.
static bool MoveCurrent (Toplevel top)
{
// The Current is modal and the top is not modal toplevel then
// the Current must be moved above the first not modal toplevel.
if (MdiTop != null && top != MdiTop && top != Current && Current?.Modal == true && !toplevels.Peek ().Modal) {
lock (toplevels) {
toplevels.MoveTo (Current, 0, new ToplevelEqualityComparer ());
}
var index = 0;
var savedToplevels = toplevels.ToArray ();
foreach (var t in savedToplevels) {
if (!t.Modal && t != Current && t != top && t != savedToplevels [index]) {
lock (toplevels) {
toplevels.MoveTo (top, index, new ToplevelEqualityComparer ());
}
}
index++;
}
return false;
}
// The Current and the top are both not running toplevel then
// the top must be moved above the first not running toplevel.
if (MdiTop != null && top != MdiTop && top != Current && Current?.Running == false && !top.Running) {
lock (toplevels) {
toplevels.MoveTo (Current, 0, new ToplevelEqualityComparer ());
}
var index = 0;
foreach (var t in toplevels.ToArray ()) {
if (!t.Running && t != Current && index > 0) {
lock (toplevels) {
toplevels.MoveTo (top, index - 1, new ToplevelEqualityComparer ());
}
}
index++;
}
return false;
}
if ((MdiTop != null && top?.Modal == true && toplevels.Peek () != top)
|| (MdiTop != null && Current != MdiTop && Current?.Modal == false && top == MdiTop)
|| (MdiTop != null && Current?.Modal == false && top != Current)
|| (MdiTop != null && Current?.Modal == true && top == MdiTop)) {
lock (toplevels) {
toplevels.MoveTo (top, 0, new ToplevelEqualityComparer ());
Current = top;
}
}
return true;
}
static bool OutsideFrame (Point p, Rect r)
{
return p.X < 0 || p.X > r.Width - 1 || p.Y < 0 || p.Y > r.Height - 1;
}
///
/// Building block API: Prepares the provided for execution.
///
/// The handle that needs to be passed to the method upon completion.
/// The to prepare execution for.
///
/// This method prepares the provided toplevel for running with the focus,
/// it adds this to the list of toplevels, sets up the mainloop to process the
/// event, lays out the subviews, focuses the first element, and draws the
/// toplevel in the screen. This is usually followed by executing
/// the method, and then the method upon termination which will
/// undo these changes.
///
public static RunState Begin (Toplevel toplevel)
{
if (toplevel == null) {
throw new ArgumentNullException (nameof (toplevel));
} else if (toplevel.IsMdiContainer && MdiTop != toplevel && MdiTop != null) {
throw new InvalidOperationException ("Only one Mdi Container is allowed.");
}
var rs = new RunState (toplevel);
// View implements ISupportInitializeNotification which is derived from ISupportInitialize
if (!toplevel.IsInitialized) {
toplevel.BeginInit ();
toplevel.EndInit ();
}
lock (toplevels) {
// If Top was already initialized with Init, and Begin has never been called
// Top was not added to the toplevels Stack. It will thus never get disposed.
// Clean it up here:
if (Top != null && toplevel != Top && !toplevels.Contains (Top)) {
Top.Dispose ();
Top = null;
} else if (Top != null && toplevel != Top && toplevels.Contains (Top)) {
Top.OnLeave (toplevel);
}
if (string.IsNullOrEmpty (toplevel.Id.ToString ())) {
var count = 1;
var id = (toplevels.Count + count).ToString ();
while (toplevels.Count > 0 && toplevels.FirstOrDefault (x => x.Id.ToString () == id) != null) {
count++;
id = (toplevels.Count + count).ToString ();
}
toplevel.Id = (toplevels.Count + count).ToString ();
toplevels.Push (toplevel);
} else {
var dup = toplevels.FirstOrDefault (x => x.Id.ToString () == toplevel.Id);
if (dup == null) {
toplevels.Push (toplevel);
}
}
if (toplevels.FindDuplicates (new ToplevelEqualityComparer ()).Count > 0) {
throw new ArgumentException ("There are duplicates toplevels Id's");
}
}
// Fix $520 - Set Top = toplevel if Top == null
if (Top == null || toplevel.IsMdiContainer) {
Top = toplevel;
}
var refreshDriver = true;
if (MdiTop == null || toplevel.IsMdiContainer || (Current?.Modal == false && toplevel.Modal)
|| (Current?.Modal == false && !toplevel.Modal) || (Current?.Modal == true && toplevel.Modal)) {
if (toplevel.Visible) {
Current = toplevel;
SetCurrentAsTop ();
} else {
refreshDriver = false;
}
} else if ((MdiTop != null && toplevel != MdiTop && Current?.Modal == true && !toplevels.Peek ().Modal)
|| (MdiTop != null && toplevel != MdiTop && Current?.Running == false)) {
refreshDriver = false;
MoveCurrent (toplevel);
} else {
refreshDriver = false;
MoveCurrent (Current);
}
Driver.PrepareToRun (MainLoop, ProcessKeyEvent, ProcessKeyDownEvent, ProcessKeyUpEvent, ProcessMouseEvent);
if (toplevel.LayoutStyle == LayoutStyle.Computed) {
toplevel.SetRelativeLayout (new Rect (0, 0, Driver.Cols, Driver.Rows));
}
toplevel.LayoutSubviews ();
toplevel.PositionToplevels ();
toplevel.WillPresent ();
if (refreshDriver) {
MdiTop?.OnChildLoaded (toplevel);
toplevel.OnLoaded ();
Redraw (toplevel);
toplevel.PositionCursor ();
Driver.Refresh ();
}
NotifyNewRunState?.Invoke (toplevel, new RunStateEventArgs (rs));
return rs;
}
///
/// Building block API: completes the execution of a that was started with .
///
/// The returned by the method.
public static void End (RunState runState)
{
if (runState == null)
throw new ArgumentNullException (nameof (runState));
if (MdiTop != null) {
MdiTop.OnChildUnloaded (runState.Toplevel);
} else {
runState.Toplevel.OnUnloaded ();
}
// End the RunState.Toplevel
// First, take it off the toplevel Stack
if (toplevels.Count > 0) {
if (toplevels.Peek () != runState.Toplevel) {
// If there the top of the stack is not the RunState.Toplevel then
// this call to End is not balanced with the call to Begin that started the RunState
throw new ArgumentException ("End must be balanced with calls to Begin");
}
toplevels.Pop ();
}
// Notify that it is closing
runState.Toplevel?.OnClosed (runState.Toplevel);
// If there is a MdiTop that is not the RunState.Toplevel then runstate.TopLevel
// is a child of MidTop and we should notify the MdiTop that it is closing
if (MdiTop != null && !(runState.Toplevel).Modal && runState.Toplevel != MdiTop) {
MdiTop.OnChildClosed (runState.Toplevel);
}
// Set Current and Top to the next TopLevel on the stack
if (toplevels.Count == 0) {
Current = null;
} else {
Current = toplevels.Peek ();
if (toplevels.Count == 1 && Current == MdiTop) {
MdiTop.OnAllChildClosed ();
} else {
SetCurrentAsTop ();
Current.OnEnter (Current);
}
Refresh ();
}
runState.Toplevel?.Dispose ();
runState.Toplevel = null;
runState.Dispose ();
}
///
/// Shutdown an application initialized with .
///
///
/// Shutdown must be called for every call to or
/// to ensure all resources are cleaned up (Disposed) and terminal settings are restored.
///
public static void Shutdown ()
{
ResetState ();
ConfigurationManager.PrintJsonErrors ();
}
// Encapsulate all setting of initial state for Application; Having
// this in a function like this ensures we don't make mistakes in
// guaranteeing that the state of this singleton is deterministic when Init
// starts running and after Shutdown returns.
static void ResetState ()
{
// Shutdown is the bookend for Init. As such it needs to clean up all resources
// Init created. Apps that do any threading will need to code defensively for this.
// e.g. see Issue #537
foreach (var t in toplevels) {
t.Running = false;
t.Dispose ();
}
toplevels.Clear ();
Current = null;
Top?.Dispose ();
Top = null;
// BUGBUG: MdiTop is not cleared here, but it should be?
MainLoop = null;
Driver?.End ();
Driver = null;
Iteration = null;
RootMouseEvent = null;
RootKeyEvent = null;
Resized = null;
_mainThreadId = -1;
NotifyNewRunState = null;
NotifyStopRunState = null;
_initialized = false;
mouseGrabView = null;
_enableConsoleScrolling = false;
lastMouseOwnerView = null;
// Reset synchronization context to allow the user to run async/await,
// as the main loop has been ended, the synchronization context from
// gui.cs does no longer process any callbacks. See #1084 for more details:
// (https://github.com/gui-cs/Terminal.Gui/issues/1084).
SynchronizationContext.SetSynchronizationContext (syncContext: null);
}
static void Redraw (View view)
{
view.Redraw (view.Bounds);
Driver.Refresh ();
}
///
/// Triggers a refresh of the entire display.
///
public static void Refresh ()
{
Driver.UpdateOffScreen ();
View last = null;
foreach (var v in toplevels.Reverse ()) {
if (v.Visible) {
v.SetNeedsDisplay ();
v.Redraw (v.Bounds);
}
last = v;
}
last?.PositionCursor ();
Driver.Refresh ();
}
///
/// Building block API: Runs the for the created .
///
///
/// Use the parameter to control whether this is a blocking or non-blocking call.
///
/// The state returned by the method.
/// By default this is which will execute the runloop waiting for events,
/// if set to , a single iteration will execute.
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");
bool firstIteration = true;
for (state.Toplevel.Running = true; state.Toplevel.Running;) {
if (ExitRunLoopAfterFirstIteration && !firstIteration) {
return;
}
RunMainLoopIteration (ref state, wait, ref firstIteration);
}
}
///
/// Run one iteration of the .
///
/// The state returned by .
/// If will execute the runloop waiting for events. If
/// will return after a single iteration.
/// Set to if this is the first run loop iteration. Upon return,
/// it will be set to if at least one iteration happened.
public static void RunMainLoopIteration (ref RunState state, bool wait, ref bool firstIteration)
{
if (MainLoop.EventsPending (wait)) {
// Notify Toplevel it's ready
if (firstIteration) {
state.Toplevel.OnReady ();
}
MainLoop.MainIteration ();
Iteration?.Invoke ();
EnsureModalOrVisibleAlwaysOnTop (state.Toplevel);
if ((state.Toplevel != Current && Current?.Modal == true)
|| (state.Toplevel != Current && Current?.Modal == false)) {
MdiTop?.OnDeactivate (state.Toplevel);
state.Toplevel = Current;
MdiTop?.OnActivate (state.Toplevel);
Top.SetSubViewNeedsDisplay ();
Refresh ();
}
if (Driver.EnsureCursorVisibility ()) {
state.Toplevel.SetNeedsDisplay ();
}
} else if (!wait) {
return;
}
firstIteration = false;
if (state.Toplevel != Top
&& (!Top._needsDisplay.IsEmpty || Top._childNeedsDisplay || Top.LayoutNeeded)) {
state.Toplevel.SetNeedsDisplay (state.Toplevel.Bounds);
Top.Redraw (Top.Bounds);
foreach (var top in toplevels.Reverse ()) {
if (top != Top && top != state.Toplevel) {
top.SetNeedsDisplay ();
top.Redraw (top.Bounds);
}
}
}
if (toplevels.Count == 1 && state.Toplevel == Top
&& (Driver.Cols != state.Toplevel.Frame.Width || Driver.Rows != state.Toplevel.Frame.Height)
&& (!state.Toplevel._needsDisplay.IsEmpty || state.Toplevel._childNeedsDisplay || state.Toplevel.LayoutNeeded)) {
Driver.SetAttribute (Colors.TopLevel.Normal);
state.Toplevel.Clear (new Rect (0, 0, Driver.Cols, Driver.Rows));
}
if (!state.Toplevel._needsDisplay.IsEmpty || state.Toplevel._childNeedsDisplay || state.Toplevel.LayoutNeeded
|| MdiChildNeedsDisplay ()) {
state.Toplevel.Redraw (state.Toplevel.Bounds);
if (DebugDrawBounds) {
DrawBounds (state.Toplevel);
}
state.Toplevel.PositionCursor ();
Driver.Refresh ();
} else {
Driver.UpdateCursor ();
}
if (state.Toplevel != Top && !state.Toplevel.Modal
&& (!Top._needsDisplay.IsEmpty || Top._childNeedsDisplay || Top.LayoutNeeded)) {
Top.Redraw (Top.Bounds);
}
}
static void EnsureModalOrVisibleAlwaysOnTop (Toplevel toplevel)
{
if (!toplevel.Running || (toplevel == Current && toplevel.Visible) || MdiTop == null || toplevels.Peek ().Modal) {
return;
}
foreach (var top in toplevels.Reverse ()) {
if (top.Modal && top != Current) {
MoveCurrent (top);
return;
}
}
if (!toplevel.Visible && toplevel == Current) {
MoveNext ();
}
}
static bool MdiChildNeedsDisplay ()
{
if (MdiTop == null) {
return false;
}
foreach (var top in toplevels) {
if (top != Current && top.Visible && (!top._needsDisplay.IsEmpty || top._childNeedsDisplay || top.LayoutNeeded)) {
MdiTop.SetSubViewNeedsDisplay ();
return true;
}
}
return false;
}
internal static bool DebugDrawBounds = false;
// Need to look into why this does not work properly.
static void DrawBounds (View v)
{
v.DrawFrame (v.Frame, padding: 0, fill: false);
if (v.InternalSubviews != null && v.InternalSubviews.Count > 0)
foreach (var sub in v.InternalSubviews)
DrawBounds (sub);
}
///
/// Runs the application by calling with the value of .
///
///
/// See for more details.
///
public static void Run (Func errorHandler = null)
{
Run (Top, errorHandler);
}
///
/// Runs the application by calling
/// with a new instance of the specified -derived class.
///
/// Calling first is not needed as this function will initialze the application.
///
///
/// must be called when the application is closing (typically after Run> has
/// returned) to ensure resources are cleaned up and terminal settings restored.
///
///
///
/// See for more details.
///
///
/// The to use. If not specified the default driver for the
/// platform will be used (, , or ).
/// This parameteter must be if has already been called.
///
/// Specifies the to use.
public static void Run (Func errorHandler = null, ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) where T : Toplevel, new()
{
if (_initialized) {
if (Driver != null) {
// Init() has been called and we have a driver, so just run the app.
var top = new T ();
var type = top.GetType ().BaseType;
while (type != typeof (Toplevel) && type != typeof (object)) {
type = type.BaseType;
}
if (type != typeof (Toplevel)) {
throw new ArgumentException ($"{top.GetType ().Name} must be derived from TopLevel");
}
Run (top, errorHandler);
} else {
// This codepath should be impossible because Init(null, null) will select the platform default driver
throw new InvalidOperationException ("Init() completed without a driver being set (this should be impossible); Run() cannot be called.");
}
} else {
// Init() has NOT been called.
InternalInit (() => new T (), driver, mainLoopDriver, calledViaRunT: true);
Run (Top, errorHandler);
}
}
///
/// Runs the main loop on the given container.
///
///
///
/// This method is used to start processing events
/// for the main application, but it is also used to
/// run other modal s such as boxes.
///
///
/// To make a stop execution, call .
///
///
/// Calling is equivalent to calling , followed by ,
/// and then calling .
///
///
/// Alternatively, to have a program control the main loop and
/// process events manually, call to set things up manually and then
/// repeatedly call with the wait parameter set to false. By doing this
/// the method will only process any pending events, timers, idle handlers and
/// then return control immediately.
///
///
/// RELEASE builds only: When is any exeptions will be rethrown.
/// Otheriwse, if will be called. If
/// returns the will resume; otherwise
/// this method will exit.
///
///
/// The to run modally.
/// RELEASE builds only: Handler for any unhandled exceptions (resumes when returns true, rethrows when null).
public static void Run (Toplevel view, Func errorHandler = null)
{
var resume = true;
while (resume) {
#if !DEBUG
try {
#endif
resume = false;
var runToken = Begin (view);
// If ExitRunLoopAfterFirstIteration is true then the user must dispose of the runToken
// by using NotifyStopRunState event.
RunLoop (runToken);
if (!ExitRunLoopAfterFirstIteration) {
End (runToken);
}
#if !DEBUG
}
catch (Exception error)
{
if (errorHandler == null)
{
throw;
}
resume = errorHandler(error);
}
#endif
}
}
///
/// Stops running the most recent or the if provided.
///
/// The toplevel to request stop.
///
///
/// This will cause to return.
///
///
/// Calling is equivalent to setting the property on the currently running to false.
///
///
public static void RequestStop (Toplevel top = null)
{
if (MdiTop == null || top == null || (MdiTop == null && top != null)) {
top = Current;
}
if (MdiTop != null && top.IsMdiContainer && top?.Running == true
&& (Current?.Modal == false || (Current?.Modal == true && Current?.Running == false))) {
MdiTop.RequestStop ();
} else if (MdiTop != null && top != Current && Current?.Running == true && Current?.Modal == true
&& top.Modal && top.Running) {
var ev = new ToplevelClosingEventArgs (Current);
Current.OnClosing (ev);
if (ev.Cancel) {
return;
}
ev = new ToplevelClosingEventArgs (top);
top.OnClosing (ev);
if (ev.Cancel) {
return;
}
Current.Running = false;
OnNotifyStopRunState (Current);
top.Running = false;
OnNotifyStopRunState (top);
} else if ((MdiTop != null && top != MdiTop && top != Current && Current?.Modal == false
&& Current?.Running == true && !top.Running)
|| (MdiTop != null && top != MdiTop && top != Current && Current?.Modal == false
&& Current?.Running == false && !top.Running && toplevels.ToArray () [1].Running)) {
MoveCurrent (top);
} else if (MdiTop != null && Current != top && Current?.Running == true && !top.Running
&& Current?.Modal == true && top.Modal) {
// The Current and the top are both modal so needed to set the Current.Running to false too.
Current.Running = false;
OnNotifyStopRunState (Current);
} else if (MdiTop != null && Current == top && MdiTop?.Running == true && Current?.Running == true && top.Running
&& Current?.Modal == true && top.Modal) {
// The MdiTop was requested to stop inside a modal toplevel which is the Current and top,
// both are the same, so needed to set the Current.Running to false too.
Current.Running = false;
OnNotifyStopRunState (Current);
} else {
Toplevel currentTop;
if (top == Current || (Current?.Modal == true && !top.Modal)) {
currentTop = Current;
} else {
currentTop = top;
}
if (!currentTop.Running) {
return;
}
var ev = new ToplevelClosingEventArgs (currentTop);
currentTop.OnClosing (ev);
if (ev.Cancel) {
return;
}
currentTop.Running = false;
OnNotifyStopRunState (currentTop);
}
}
static void OnNotifyStopRunState (Toplevel top)
{
if (ExitRunLoopAfterFirstIteration) {
NotifyStopRunState?.Invoke (top, new ToplevelEventArgs (top));
}
}
///
/// Invoked when the terminal was resized. The new size of the terminal is provided.
///
public static Action Resized;
static void TerminalResized ()
{
var full = new Rect (0, 0, Driver.Cols, Driver.Rows);
Resized?.Invoke (new ResizedEventArgs () { Cols = full.Width, Rows = full.Height });
Driver.Clip = full;
foreach (var t in toplevels) {
t.SetRelativeLayout (full);
t.LayoutSubviews ();
t.PositionToplevels ();
t.OnResized (new SizeChangedEventArgs (full.Size));
}
Refresh ();
}
static bool SetCurrentAsTop ()
{
if (MdiTop == null && Current != Top && Current?.SuperView == null && Current?.Modal == false) {
if (Current.Frame != new Rect (0, 0, Driver.Cols, Driver.Rows)) {
Current.Frame = new Rect (0, 0, Driver.Cols, Driver.Rows);
}
Top = Current;
return true;
}
return false;
}
///
/// Move to the next Mdi child from the .
///
public static void MoveNext ()
{
if (MdiTop != null && !Current.Modal) {
lock (toplevels) {
toplevels.MoveNext ();
var isMdi = false;
while (toplevels.Peek () == MdiTop || !toplevels.Peek ().Visible) {
if (!isMdi && toplevels.Peek () == MdiTop) {
isMdi = true;
} else if (isMdi && toplevels.Peek () == MdiTop) {
MoveCurrent (Top);
break;
}
toplevels.MoveNext ();
}
Current = toplevels.Peek ();
}
}
}
///
/// Move to the previous Mdi child from the .
///
public static void MovePrevious ()
{
if (MdiTop != null && !Current.Modal) {
lock (toplevels) {
toplevels.MovePrevious ();
var isMdi = false;
while (toplevels.Peek () == MdiTop || !toplevels.Peek ().Visible) {
if (!isMdi && toplevels.Peek () == MdiTop) {
isMdi = true;
} else if (isMdi && toplevels.Peek () == MdiTop) {
MoveCurrent (Top);
break;
}
toplevels.MovePrevious ();
}
Current = toplevels.Peek ();
}
}
}
internal static bool ShowChild (Toplevel top)
{
if (top.Visible && MdiTop != null && Current?.Modal == false) {
lock (toplevels) {
toplevels.MoveTo (top, 0, new ToplevelEqualityComparer ());
Current = top;
}
return true;
}
return false;
}
///
/// Wakes up the mainloop that might be waiting on input, must be thread safe.
///
public static void DoEvents ()
{
MainLoop.Driver.Wakeup ();
}
///
/// Ensures that the superview of the most focused view is on front.
///
public static void EnsuresTopOnFront ()
{
if (MdiTop != null) {
return;
}
var top = FindTopFromView (Top?.MostFocused);
if (top != null && Top.Subviews.Count > 1 && Top.Subviews [Top.Subviews.Count - 1] != top) {
Top.BringSubviewToFront (top);
}
}
internal static List GetSupportedCultures ()
{
CultureInfo [] culture = CultureInfo.GetCultures (CultureTypes.AllCultures);
// Get the assembly
Assembly assembly = Assembly.GetExecutingAssembly ();
//Find the location of the assembly
string assemblyLocation = AppDomain.CurrentDomain.BaseDirectory;
// Find the resource file name of the assembly
string resourceFilename = $"{Path.GetFileNameWithoutExtension (assembly.Location)}.resources.dll";
// Return all culture for which satellite folder found with culture code.
return culture.Where (cultureInfo =>
assemblyLocation != null &&
Directory.Exists (Path.Combine (assemblyLocation, cultureInfo.Name)) &&
File.Exists (Path.Combine (assemblyLocation, cultureInfo.Name, resourceFilename))
).ToList ();
}
}
}