#nullable enable
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
namespace Terminal.Gui;
public static partial class Application // Initialization (Init/Shutdown)
{
/// Initializes a new instance of a Terminal.Gui Application. must be called when the application is closing.
/// 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 application cam use without explicitly calling
/// .
///
///
/// The to use. If neither or
/// are specified the default driver for the platform will be used.
///
///
/// The short name (e.g. "net", "windows", "ansi", "fake", or "curses") of the
/// to use. If neither or are
/// specified the default driver for the platform will be used.
///
[RequiresUnreferencedCode ("AOT")]
[RequiresDynamicCode ("AOT")]
public static void Init (IConsoleDriver? driver = null, string? driverName = null)
{
if (driverName?.StartsWith ("v2") ?? false)
{
ApplicationImpl.ChangeInstance (new ApplicationV2 ());
}
ApplicationImpl.Instance.Init (driver, driverName);
}
internal static int MainThreadId { get; set; } = -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.
[RequiresUnreferencedCode ("AOT")]
[RequiresDynamicCode ("AOT")]
internal static void InternalInit (
IConsoleDriver? driver = null,
string? driverName = null,
bool calledViaRunT = false
)
{
if (Initialized && driver is null)
{
return;
}
if (Initialized)
{
throw new InvalidOperationException ("Init has already been called and must be bracketed by Shutdown.");
}
if (!calledViaRunT)
{
// Reset all class variables (Application is a singleton).
ResetState (ignoreDisposed: true);
}
Navigation = new ();
// For UnitTests
if (driver is { })
{
Driver = driver;
if (driver is FakeDriver)
{
// We're running unit tests. Disable loading config files other than default
if (Locations == ConfigLocations.All)
{
Locations = ConfigLocations.Default;
Reset ();
}
}
}
AddKeyBindings ();
InitializeConfigurationManagement ();
// Ignore Configuration for ForceDriver if driverName is specified
if (!string.IsNullOrEmpty (driverName))
{
ForceDriver = driverName;
}
if (Driver is null)
{
PlatformID p = Environment.OSVersion.Platform;
if (string.IsNullOrEmpty (ForceDriver))
{
if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows)
{
Driver = new WindowsDriver ();
}
else
{
Driver = new CursesDriver ();
}
}
else
{
List drivers = GetDriverTypes ();
Type? driverType = drivers.FirstOrDefault (t => t!.Name.Equals (ForceDriver, StringComparison.InvariantCultureIgnoreCase));
if (driverType is { })
{
Driver = (IConsoleDriver)Activator.CreateInstance (driverType)!;
}
else
{
throw new ArgumentException (
$"Invalid driver name: {ForceDriver}. Valid names are {string.Join (", ", drivers.Select (t => t!.Name))}"
);
}
}
}
try
{
MainLoop = Driver!.Init ();
SubscribeDriverEvents ();
}
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 ());
MainThreadId = Thread.CurrentThread.ManagedThreadId;
bool init = Initialized = true;
InitializedChanged?.Invoke (null, new (init));
}
[RequiresUnreferencedCode ("AOT")]
[RequiresDynamicCode ("AOT")]
internal static void InitializeConfigurationManagement ()
{
// Start the process of configuration management.
// Note that we end up calling LoadConfigurationFromAllSources
// multiple times. We need to do this because some settings are only
// valid after a Driver is loaded. In this case we need just
// `Settings` so we can determine which driver to use.
// Don't reset, so we can inherit the theme from the previous run.
string previousTheme = Themes?.Theme ?? string.Empty;
Load ();
if (Themes is { } && !string.IsNullOrEmpty (previousTheme) && previousTheme != "Default")
{
ThemeManager.SelectedTheme = previousTheme;
}
Apply ();
}
internal static void SubscribeDriverEvents ()
{
ArgumentNullException.ThrowIfNull (Driver);
Driver.SizeChanged += Driver_SizeChanged;
Driver.KeyDown += Driver_KeyDown;
Driver.KeyUp += Driver_KeyUp;
Driver.MouseEvent += Driver_MouseEvent;
}
internal static void UnsubscribeDriverEvents ()
{
ArgumentNullException.ThrowIfNull (Driver);
Driver.SizeChanged -= Driver_SizeChanged;
Driver.KeyDown -= Driver_KeyDown;
Driver.KeyUp -= Driver_KeyUp;
Driver.MouseEvent -= Driver_MouseEvent;
}
private static void Driver_SizeChanged (object? sender, SizeChangedEventArgs e) { OnSizeChanging (e); }
private static void Driver_KeyDown (object? sender, Key e) { RaiseKeyDownEvent (e); }
private static void Driver_KeyUp (object? sender, Key e) { RaiseKeyUpEvent (e); }
private static void Driver_MouseEvent (object? sender, MouseEventArgs e) { RaiseMouseEvent (e); }
/// Gets of list of types that are available.
///
[RequiresUnreferencedCode ("AOT")]
public static List GetDriverTypes ()
{
// use reflection to get the list of drivers
List driverTypes = new ();
foreach (Assembly asm in AppDomain.CurrentDomain.GetAssemblies ())
{
foreach (Type? type in asm.GetTypes ())
{
if (typeof (IConsoleDriver).IsAssignableFrom (type) && !type.IsAbstract && type.IsClass)
{
driverTypes.Add (type);
}
}
}
return driverTypes;
}
/// 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 () => ApplicationImpl.Instance.Shutdown ();
///
/// Gets whether the application has been initialized with and not yet shutdown with .
///
///
///
/// The event is raised after the and methods have been called.
///
///
public static bool Initialized { get; internal set; }
///
/// This event is raised after the and methods have been called.
///
///
/// Intended to support unit tests that need to know when the application has been initialized.
///
public static event EventHandler>? InitializedChanged;
///
/// Raises the event.
///
internal static void OnInitializedChanged (object sender, EventArgs e)
{
Application.InitializedChanged?.Invoke (sender,e);
}
}