Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactored internal Init() (now called InternnalInit()) to be more clear; updated docs and unit tests

Browse Source
This commit is contained in:
Charlie Kindel
2022-11-05 14:36:41 -06:00
parent b6dceb3048
commit de3c02e9bf
5 changed files with 132 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Terminal.Gui/ConsoleDrivers/WindowsDriver.cs
View File

@@ -1451,16 +1451,20 @@ namespace Terminal.Gui {
{
TerminalResized = terminalResized;
var winSize = WinConsole.GetConsoleOutputWindow (out Point pos);
cols = winSize.Width;
rows = winSize.Height;
try {
var winSize = WinConsole.GetConsoleOutputWindow (out Point pos);
cols = winSize.Width;
rows = winSize.Height;
WindowsConsole.SmallRect.MakeEmpty (ref damageRegion);
WindowsConsole.SmallRect.MakeEmpty (ref damageRegion);
ResizeScreen ();
UpdateOffScreen ();
ResizeScreen ();
UpdateOffScreen ();
CreateColors ();
CreateColors ();
} catch (Win32Exception e) {
throw new InvalidOperationException ("The Windows Console output window is not available.", e);
}
}
public override void ResizeScreen ()

100
Terminal.Gui/Core/Application.cs
View File

@@ -329,29 +329,28 @@ namespace Terminal.Gui {
/// into a single call. An applciation cam use <see cref="Run{T}(Func{Exception, bool}, ConsoleDriver, IMainLoopDriver)"/>
/// without explicitly calling <see cref="Init(ConsoleDriver, IMainLoopDriver)"/>.
/// </para>
/// <param name="driver">The <see cref="ConsoleDriver"/> to use. If not specified the default driver for the
/// <param name="driver">
/// The <see cref="ConsoleDriver"/> to use. If not specified the default driver for the
/// platform will be used (see <see cref="WindowsDriver"/>, <see cref="CursesDriver"/>, and <see cref="NetDriver"/>).</param>
/// <param name="mainLoopDriver">Specifies the <see cref="MainLoop"/> to use.</param>
public static void Init (ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) => Init (() => Toplevel.Create (), driver, mainLoopDriver, resetState: true);
/// <param name="mainLoopDriver">
/// Specifies the <see cref="MainLoop"/> to use.
/// Must not be <see langword="null"/> if <paramref name="driver"/> is not <see langword="null"/>.
/// </param>
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;
/// <summary>
/// Internal function for initializing a Terminal.Gui application with a <see cref="Toplevel"/> factory object,
/// a <see cref="ConsoleDriver"/>, and <see cref="MainLoop"/>.
/// <para>
/// This is a low-level function; most applications will use <see cref="Init(ConsoleDriver, IMainLoopDriver)"/> as it is simpler.</para>
/// </summary>
/// <param name="topLevelFactory">Specifies the <see cref="Toplevel"> factory funtion.</see>/></param>
/// <param name="driver">The <see cref="ConsoleDriver"/> to use. If not specified the default driver for the
/// platform will be used (see <see cref="WindowsDriver"/>, <see cref="CursesDriver"/>, and <see cref="NetDriver"/>).</param>
/// <param name="mainLoopDriver">Specifies the <see cref="MainLoop"/> to use.</param>
/// <param name="resetState">If <see langword="true"/> (default) all <see cref="Application"/> state will be reset.
/// Set to <see langword="false"/> to not reset the state (for when this function is called via
/// <see cref="Run{T}(Func{Exception, bool}, ConsoleDriver, IMainLoopDriver)"/> when <see cref="Init(ConsoleDriver, IMainLoopDriver)"/>
/// has not already been called. f</param>
internal static void Init (Func<Toplevel> topLevelFactory, ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null, bool resetState = true)
// 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<T>() - When the user wants to use a custom Toplevel. calledViaRunT will be true, enabling Run<T>() 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<Toplevel> topLevelFactory, ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null, bool calledViaRunT = false)
{
if (_initialized && driver == null) return;
@@ -359,6 +358,7 @@ namespace Terminal.Gui {
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) {
@@ -367,15 +367,18 @@ namespace Terminal.Gui {
// System.Diagnostics.Debugger.Break ();
//#endif
// Reset all class variables (Application is a singleton).
if (resetState) {
if (!calledViaRunT) {
// Reset all class variables (Application is a singleton).
ResetState ();
}
// This supports Unit Tests and the passing of a mock driver/loopdriver
// FakeDriver (for UnitTests)
if (driver != null) {
if (mainLoopDriver == null) {
throw new ArgumentNullException ("mainLoopDriver cannot be null if driver is provided.");
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;
}
@@ -395,7 +398,16 @@ namespace Terminal.Gui {
}
MainLoop = new MainLoop (mainLoopDriver);
Driver.Init (TerminalResized);
try {
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 ();
@@ -1250,8 +1262,7 @@ namespace Terminal.Gui {
/// Runs the application by calling <see cref="Run(Toplevel, Func{Exception, bool})"/>
/// with a new instance of the specified <see cref="Toplevel"/>-derived class.
/// <para>
/// If <see cref="Init(ConsoleDriver, IMainLoopDriver)"/> has not arleady been called, this function will
/// call <see cref="Init(Func{Toplevel}, ConsoleDriver, IMainLoopDriver, bool)"/>.
/// Calling <see cref="Init(ConsoleDriver, IMainLoopDriver)"/> first is not needed as this function will initialze the
/// </para>
/// <para>
/// <see cref="Shutdown"/> must be called when the application is closing (typically after Run> has
@@ -1263,27 +1274,36 @@ namespace Terminal.Gui {
/// </remarks>
/// <param name="errorHandler"></param>
/// <param name="driver">The <see cref="ConsoleDriver"/> to use. If not specified the default driver for the
/// platform will be used (see <see cref="WindowsDriver"/>, <see cref="CursesDriver"/>, and <see cref="NetDriver"/>).</param>
/// platform will be used (<see cref="WindowsDriver"/>, <see cref="CursesDriver"/>, or <see cref="NetDriver"/>).
/// This parameteter must be <see langword="null"/> if <see cref="Init(ConsoleDriver, IMainLoopDriver)"/> has already been called.
/// </param>
/// <param name="mainLoopDriver">Specifies the <see cref="MainLoop"/> to use.</param>
public static void Run<T> (Func<Exception, bool> errorHandler = null, ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) where T : Toplevel, new()
{
if (_initialized && Driver != null) {
var top = new T ();
var type = top.GetType ().BaseType;
while (type != typeof (Toplevel) && type != typeof (object)) {
type = type.BaseType;
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<T>() cannot be called.");
}
if (type != typeof (Toplevel)) {
throw new ArgumentException ($"{top.GetType ().Name} must be derived from TopLevel");
}
// Run() will eventually cause Application.Top to be set, via Begin() and SetCurrentAsTop()
Run (top, errorHandler);
} else {
if (!_initialized && driver == null) {
throw new ArgumentException ("Init has not been called; a valid driver and mainloop must be provided");
// Init() has NOT been called.
if (driver != null) {
// Caller has provided a driver so call Init with it (but set calledViaRunT to true so we don't reset Application state).
InternalInit (() => new T (), driver, mainLoopDriver, calledViaRunT: true);
} else {
throw new ArgumentException ("A Driver must be specified when calling Run<T>() when Init() has not been called.");
}
// Note in this case, we don't verify the type of the Toplevel created by new T().
Init (() => new T (), Driver == null ? driver : Driver, Driver == null ? mainLoopDriver : null, resetState: false);
Run (Top, errorHandler);
}
}

4
UICatalog/Scenarios/BackgroundWorkerCollection.cs
View File

@@ -12,10 +12,6 @@ namespace UICatalog.Scenarios {
[ScenarioCategory ("Dialogs")]
[ScenarioCategory ("Controls")]
public class BackgroundWorkerCollection : Scenario {
public override void Init (ColorScheme colorScheme)
{
// Do not call Init as Application.Run<T> will do it
}
public override void Run ()
{

1
UICatalog/UICatalog.cs
View File

@@ -117,6 +117,7 @@ namespace UICatalog {
// Run UI Catalog UI. When it exits, if _selectedScenario is != null then
// a Scenario was selected. Otherwise, the user wants to exit UI Catalog.
Application.Init ();
Application.Run<UICatalogTopLevel> ();
Application.Shutdown ();

69
UnitTests/ApplicationTests.cs
View File

@@ -1,6 +1,7 @@
using System;
using System.Diagnostics;
using System.Linq;
using System.Runtime.InteropServices;
using System.Threading;
using System.Threading.Tasks;
using Xunit;
@@ -100,7 +101,7 @@ namespace Terminal.Gui.Core {
Application.Init (new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true)));
Toplevel topLevel = null;
Assert.Throws<InvalidOperationException> (() => Application.Init (() => topLevel = new TestToplevel (), new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true))));
Assert.Throws<InvalidOperationException> (() => Application.InternalInit (() => topLevel = new TestToplevel (), new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true))));
Shutdown ();
Assert.Null (Application.Top);
@@ -109,7 +110,7 @@ namespace Terminal.Gui.Core {
// Now try the other way
topLevel = null;
Application.Init (() => topLevel = new TestToplevel (), new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true)));
Application.InternalInit (() => topLevel = new TestToplevel (), new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true)));
Assert.Throws<InvalidOperationException> (() => Application.Init (new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true))));
Shutdown ();
@@ -118,7 +119,7 @@ namespace Terminal.Gui.Core {
Assert.Null (Application.MainLoop);
Assert.Null (Application.Driver);
}
class TestToplevel : Toplevel {
public TestToplevel ()
@@ -131,7 +132,7 @@ namespace Terminal.Gui.Core {
public void Init_Begin_End_Cleans_Up ()
{
Init ();
// Begin will cause Run() to be called, which will call Begin(). Thus will block the tests
// if we don't stop
Application.Iteration = () => {
@@ -145,7 +146,7 @@ namespace Terminal.Gui.Core {
};
Application.NotifyNewRunState += NewRunStateFn;
Toplevel topLevel = new Toplevel();
Toplevel topLevel = new Toplevel ();
var rs = Application.Begin (topLevel);
Assert.NotNull (rs);
Assert.NotNull (runstate);
@@ -181,7 +182,7 @@ namespace Terminal.Gui.Core {
// NOTE: Run<T>, when called after Init has been called behaves differently than
// when called if Init has not been called.
Toplevel topLevel = null;
Application.Init (() => topLevel = new TestToplevel (), new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true)));
Application.InternalInit (() => topLevel = new TestToplevel (), new FakeDriver (), new FakeMainLoop (() => FakeConsole.ReadKey (true)));
Application.RunState runstate = null;
Action<Application.RunState> NewRunStateFn = (rs) => {
@@ -272,9 +273,56 @@ namespace Terminal.Gui.Core {
Application.Iteration = () => {
Application.RequestStop ();
};
// Init has been called and we're passing no driver to Run<TestTopLevel>. This is ok.
Application.Run<TestToplevel> (errorHandler: null);
Application.Run<TestToplevel> ();
Shutdown ();
Assert.Null (Application.Top);
Assert.Null (Application.MainLoop);
Assert.Null (Application.Driver);
}
[Fact]
public void Run_T_After_InitNullDriver_with_TestTopLevel_Throws ()
{
var p = Environment.OSVersion.Platform;
if (p == PlatformID.Win32NT || p == PlatformID.Win32S || p == PlatformID.Win32Windows) {
Assert.Throws<InvalidOperationException> (() => Application.Init (null, null));
} else {
Application.Init (null, null);
Assert.Equal (typeof (CursesDriver), Application.Driver.GetType ());
Application.Shutdown ();
}
Application.Iteration = () => {
Application.RequestStop ();
};
// Init has been called without selecting a driver and we're passing no driver to Run<TestTopLevel>. Bad
Assert.Throws<ArgumentException> (() => Application.Run<TestToplevel> ());
Shutdown ();
Assert.Null (Application.Top);
Assert.Null (Application.MainLoop);
Assert.Null (Application.Driver);
}
[Fact]
public void Run_T_Init_Driver_Cleared_with_TestTopLevel_Throws ()
{
Init ();
Application.Driver = null;
Application.Iteration = () => {
Application.RequestStop ();
};
// Init has been called, but Driver has been set to null. Bad.
Assert.Throws<InvalidOperationException> (() => Application.Run<TestToplevel> ());
Shutdown ();
@@ -379,6 +427,9 @@ namespace Terminal.Gui.Core {
Application.Shutdown ();
Assert.Equal (3, count);
}
// TODO: Add tests for Run that test errorHandler
#endregion
#region ShutdownTests
@@ -407,7 +458,7 @@ namespace Terminal.Gui.Core {
Assert.Null (SynchronizationContext.Current);
}
#endregion
[Fact]
[AutoInitShutdown]
public void SetCurrentAsTop_Run_A_Not_Modal_Toplevel_Make_It_The_Current_Application_Top ()