Merge pull request #139 from FRACerqueira/v5.0.0

FRACerqueira · web-flow · commit 9ceedf82f2b1 · 2025-11-07T18:43:05.000-03:00
Refinement of Ctrl+C / Ctrl+Break key monitoring. Documentation update.
diff --git a/README.md b/README.md
@@ -178,6 +178,10 @@ Whenever a **critical error occurs, a log file is generated** before completion
 
 ### About console Ctrl+C / Ctrl+Break
 
+The Prompt Plus library monitors the Ctrl+C / Ctrl+Break keys. 
+
+When it is not handled by the 'CancelKeyPress' command, every time the application is closed it restores the initial state of colors, cursor, Culture and returns to the primary console buffer.
+
 The Prompt Plus library provides the ability to manipulate the behavior of Ctrl+C/Ctrl+Break using the command:
 - CancelKeyPress(AfterCancelKeyPress behaviorcontrols, Action\<object?, ConsoleCancelEventArgs\> actionhandle)
 
@@ -278,7 +282,7 @@ PromptPlus adopts the keyboard **left/right arrows, Home, End** keys for navigat
 
 ### For list/colletion
 
-PromptPlus adopts the keyboard **arrows, Ctrl+Home, Ctrl+End, PageUp and PageDown** keys items navigation.
+PromptPlus adopts the keyboard **Up/Down arrows, Ctrl+Home, Ctrl+End, PageUp and PageDown** keys items navigation.
 
 For multiple-selection lists, a **space** is used to indicate a check mark. The **Shift+space** combination is used in text input to differentiate it from a check mark, when applicable.
 
diff --git a/docs/api/assemblies/PromptPlus.md b/docs/api/assemblies/PromptPlus.md
@@ -86,6 +86,7 @@
 | enum [ProgressBarStyles](./PromptPlusLibrary/ProgressBarStyles.md) | Represents The Styles ProgressBar control This enum defines various regions or components of the ProgressBar. |
 | enum [ProgressBarType](./PromptPlusLibrary/ProgressBarType.md) | Represents the Graphical-based of Progress Bar. |
 | static class [PromptPlus](./PromptPlusLibrary/PromptPlus.md) | Provides extension methods for ConsoleKeyInfo to evaluate specific key combinations, including standard keys and Emacs-style shortcuts. |
+| class [PromptPlusException](./PromptPlusLibrary/PromptPlusException.md) | Represents an exception thrown by PromptPlus for Press Ctrl+C or Ctrl+Break |
 | struct [ResultPrompt&lt;T&gt;](./PromptPlusLibrary/ResultPrompt-1.md) | Represents The Result *T* to Controls |
 | enum [SelectStyles](./PromptPlusLibrary/SelectStyles.md) | Represents the styles for the Select Control. This enum defines various regions or components of the Select Control. |
 | enum [SeparatorLine](./PromptPlusLibrary/SeparatorLine.md) | Represents Type Separation line |
diff --git a/docs/api/assemblies/PromptPlusLibrary/PromptPlusException.md b/docs/api/assemblies/PromptPlusLibrary/PromptPlusException.md
@@ -0,0 +1,24 @@
+![PromptPlus Logo](https://raw.githubusercontent.com/FRACerqueira/PromptPlus/refs/heads/main/icon.png)
+
+### PromptPlusException class
+</br>
+
+
+#### Represents an exception thrown by PromptPlus for Press Ctrl+C or Ctrl+Break
+
+```csharp
+public class PromptPlusException : Exception
+```
+
+### Public Members
+
+| name | description |
+| --- | --- |
+| [PromptPlusException](PromptPlusException/PromptPlusException.md)() | Initializes a new instance of the PromptPlusException class. |
+| [PromptPlusException](PromptPlusException/PromptPlusException.md)(…) | Initializes a new instance of the PromptPlusException class with message. |
+
+### See Also
+
+* namespace [PromptPlusLibrary](../PromptPlus.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for PromptPlus.dll -->
diff --git a/docs/api/assemblies/PromptPlusLibrary/PromptPlusException/PromptPlusException.md b/docs/api/assemblies/PromptPlusLibrary/PromptPlusException/PromptPlusException.md
@@ -0,0 +1,37 @@
+![PromptPlus Logo](https://raw.githubusercontent.com/FRACerqueira/PromptPlus/refs/heads/main/icon.png)
+
+### PromptPlusException constructor (1 of 2)
+</br>
+
+
+#### Initializes a new instance of the PromptPlusException class.
+
+```csharp
+public PromptPlusException()
+```
+
+### See Also
+
+* class [PromptPlusException](../PromptPlusException.md)
+* namespace [PromptPlusLibrary](../../PromptPlus.md)
+
+---
+
+### PromptPlusException constructor (2 of 2)
+
+#### Initializes a new instance of the PromptPlusException class with message.
+
+```csharp
+public PromptPlusException(string message)
+```
+
+| parameter | description |
+| --- | --- |
+| message |  |
+
+### See Also
+
+* class [PromptPlusException](../PromptPlusException.md)
+* namespace [PromptPlusLibrary](../../PromptPlus.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for PromptPlus.dll -->
diff --git a/src/Controls/BaseControlPrompt.cs b/src/Controls/BaseControlPrompt.cs
@@ -13,7 +13,6 @@
 
 namespace PromptPlusLibrary.Controls
 {
-
     internal abstract class BaseControlPrompt<T>(bool isWidget, IConsoleExtend console, PromptConfig promptConfig, BaseControlOptions baseControlOptions, [CallerFilePath] string? filemecontrol = null)
     {
         private readonly BufferScreen _bufferScreen = new();
@@ -42,12 +41,16 @@ public void Show()
 
         public ResultPrompt<T> Run(CancellationToken stoptoken = default)
         {
-            using CancellationTokenSource cts = CancellationTokenSource.CreateLinkedTokenSource(stoptoken, console.TokenCancelPress);
+            if (ConsolePlus.IsExitDefaultCancel && ConsolePlus.AbortedByCtrlC)
+            {
+                throw new PromptPlusException();
+            }
+
+            using CancellationTokenSource cts = CancellationTokenSource.CreateLinkedTokenSource(stoptoken, ConsolePlus.TokenCancelPress);
 
             if (isWidget)
             {
-
-                using (((IConsole)console).InternalExclusiveContext())
+                using (ConsolePlus.InternalExclusiveContext())
                 {
 
                     promptConfig.TraceBaseControlOptions = GeneralOptions;
@@ -80,6 +83,10 @@ public ResultPrompt<T> Run(CancellationToken stoptoken = default)
                     catch
                     {
                         error = true;
+                        if (ConsolePlus.IsExitDefaultCancel && ConsolePlus.AbortedByCtrlC)
+                        {
+                            throw new PromptPlusException();
+                        }
                         throw;
                     }
                     finally
@@ -103,7 +110,7 @@ public ResultPrompt<T> Run(CancellationToken stoptoken = default)
 #pragma warning restore CS8604 // Possible null reference argument.
                 }
             }
-            using (console.InternalExclusiveContext())
+            using (ConsolePlus.InternalExclusiveContext())
             {
                 promptConfig.TraceBaseControlOptions = GeneralOptions;
                 promptConfig.TraceCurrentFileNameControl = filemecontrol;
@@ -160,6 +167,10 @@ public ResultPrompt<T> Run(CancellationToken stoptoken = default)
                 catch
                 {
                     error = true;
+                    if (ConsolePlus.IsExitDefaultCancel && ConsolePlus.AbortedByCtrlC)
+                    {
+                        throw new PromptPlusException();
+                    }
                     throw;
                 }
                 finally
@@ -221,11 +232,11 @@ public bool TryValidate(object input, IList<Func<object, ValidationResult>> vali
 
         public ConsoleKeyInfo WaitKeypress(bool intercept, CancellationToken token)
         {
-            while (!console.KeyAvailable && !token.IsCancellationRequested)
+            while (!ConsolePlus.KeyAvailable && !token.IsCancellationRequested)
             {
                 token.WaitHandle.WaitOne(2);
             }
-            return console.KeyAvailable && !token.IsCancellationRequested ? console.ReadKey(intercept) : new ConsoleKeyInfo();
+            return ConsolePlus.KeyAvailable && !token.IsCancellationRequested ? ConsolePlus.ReadKey(intercept) : new ConsoleKeyInfo();
         }
 
         public bool IsTooltipToggerKeyPress(ConsoleKeyInfo keyInfo)
diff --git a/src/Core/Colors/ColorPalette.cs b/src/Core/Colors/ColorPalette.cs
@@ -7,7 +7,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Collections.Immutable;
 using System.Linq;
 
 namespace PromptPlusLibrary.Core.Colors
diff --git a/src/Drivers/ConsoleDriveWindows.cs b/src/Drivers/ConsoleDriveWindows.cs
@@ -16,18 +16,18 @@ namespace PromptPlusLibrary.Drivers
 {
     internal class ConsoleDriveWindows : IConsole, IConsoleExtend
     {
-        internal const int IdleReadKey = 2;
+        private readonly SemaphoreSlim _exclusiveCAbortCtrlC = new(0, 1);
+        private readonly SemaphoreSlim _exclusiveContext = new(1, 1);
+        private readonly Task _CheckBackGroundCtrlC;
         private TargetScreen _currentBuffer = TargetScreen.Primary;
         private Color _consoleForegroundColor;
         private Color _consoleBackgroundColor;
-        private readonly SemaphoreSlim _exclusiveContext = new(1, 1);
         private bool _disposed;
         private Action<object?, ConsoleCancelEventArgs>? _cancelKeyPressEvent;
         private AfterCancelKeyPress _behaviorAfterCancelKeyPress;
         private CancellationTokenSource _tokenCancelPress;
         private bool _isExistDefaultCancel;
-        private static bool _isAbortCtrlC;
-        private static Task? _CheckBackGroundCtrlC;
+        private bool _isAbortCtrlC;
 
         public ConsoleDriveWindows(IProfileDrive profile)
         {
@@ -39,29 +39,13 @@ public ConsoleDriveWindows(IProfileDrive profile)
             _isExistDefaultCancel = false;
             _CheckBackGroundCtrlC = Task.Run(() =>
             {
-                bool found = false;
-                while (!_disposed)
-                {
-                    try
-                    {
-                        _tokenCancelPress.Token.WaitHandle.WaitOne(2);
-                    }
-                    catch (ObjectDisposedException)
-                    {
-                        break;
-                    }
-                    if (AbortedByCtrlC)
-                    {
-                        found = true;
-                        break;
-                    }
-                }
-                if (found)
+                _exclusiveCAbortCtrlC.Wait();
+                if (!_disposed)
                 {
-                    throw new AppDomainUnloadedException();
+                    throw new PromptPlusException();
                 }
-
             });
+            RemoveCancelKeyPress();
         }
 
         public CancellationToken TokenCancelPress => _tokenCancelPress.Token;
@@ -100,7 +84,11 @@ private void ExitDefaultCancel(object? sender, ConsoleCancelEventArgs args)
             Console.CancelKeyPress -= ExitDefaultCancel;
             SetUserPressKeyAborted();
             _isAbortCtrlC = true;
-            throw new AppDomainUnloadedException();
+            if (!_disposed)
+            {
+                _exclusiveCAbortCtrlC.Release();
+            }
+            throw new PromptPlusException();
         }
 
         public void CancelKeyPress(AfterCancelKeyPress behaviorcontrols, Action<object?, ConsoleCancelEventArgs> actionhandle)
@@ -142,6 +130,10 @@ public void SetUserPressKeyAborted()
 
         public void UniqueContext(Action action)
         {
+            if (IsExitDefaultCancel && AbortedByCtrlC)
+            {
+                throw new PromptPlusException();
+            }
             bool exclusive = false;
             if (_exclusiveContext.CurrentCount == 1)
             {
@@ -851,23 +843,23 @@ public void Dispose()
         {
             if (!_disposed)
             {
-                if (_cancelKeyPressEvent != null)
+                _disposed = true;
+                if (_isExistDefaultCancel)
                 {
-                    Console.CancelKeyPress -= ConsoleCancelKeyPress;
+                    Console.CancelKeyPress -= ExitDefaultCancel;
                 }
-                _disposed = true;
-                if (_CheckBackGroundCtrlC != null)
+                if (_cancelKeyPressEvent != null)
                 {
-                    while (!_CheckBackGroundCtrlC.IsCompleted)
-                    {
-                        Thread.Sleep(2);
-                    }
-                    _CheckBackGroundCtrlC.Dispose();
+                    Console.CancelKeyPress -= ConsoleCancelKeyPress;
                 }
+                _behaviorAfterCancelKeyPress = AfterCancelKeyPress.Default;
+                _exclusiveCAbortCtrlC.Release();
+                _CheckBackGroundCtrlC.Wait();
+                _CheckBackGroundCtrlC.Dispose();
                 _cancelKeyPressEvent = null;
                 _tokenCancelPress?.Dispose();
                 _exclusiveContext?.Dispose();
-                _disposed = true;
+                _exclusiveCAbortCtrlC?.Dispose();
                 GC.SuppressFinalize(this);
             }
         }
diff --git a/src/PromptPlus.ExclusiveContextExtensions.cs b/src/PromptPlus.ExclusiveContextExtensions.cs
@@ -18,16 +18,28 @@ public static partial class PromptPlus
         /// <returns><see cref="IDisposable"/></returns>
         public static IDisposable ExclusiveContext(this IConsole console)
         {
+            if (((IConsoleExtend)console).IsExitDefaultCancel && ((IConsoleExtend)console).AbortedByCtrlC)
+            {
+                throw new PromptPlusException();
+            }
             return new ExclusiveContextOutput((IConsoleExtend)console, false);
         }
 
         internal static IDisposable InternalExclusiveContext(this IConsole console)
         {
+            if (((IConsoleExtend)console).IsExitDefaultCancel && ((IConsoleExtend)console).AbortedByCtrlC)
+            {
+                throw new PromptPlusException();
+            }
             return new ExclusiveContextOutput((IConsoleExtend)console, true);
         }
 
         internal static IDisposable InternalExclusiveContext(this IConsoleExtend console)
         {
+            if (console.IsExitDefaultCancel && console.AbortedByCtrlC)
+            {
+                throw new PromptPlusException();
+            }
             return new ExclusiveContextOutput(console, true);
         }
     }
diff --git a/src/PromptPlus.cs b/src/PromptPlus.cs
@@ -13,7 +13,6 @@
 using System.Globalization;
 using System.IO;
 using System.Reflection;
-using System.Runtime.ExceptionServices;
 using System.Runtime.InteropServices;
 using System.Text;
 using System.Text.Json;
@@ -111,9 +110,13 @@ static PromptPlus()
 
             AppDomain.CurrentDomain.ProcessExit += (s, e) =>
             {
+                if (_promptConfig.ResetBasicStateAfterExist)
+                {
+                    ResetState();
+                }
                 if (((IConsoleExtend)Console).AbortedByCtrlC)
                 {
-                    AppDomainUnloadedException error = new("Press Ctrl+C or Ctrl+Break");
+                    PromptPlusException error = new("Press Ctrl+C or Ctrl+Break");
                     try
                     {
                         WriteCrashLog(typeof(PromptPlus), error);
@@ -125,31 +128,28 @@ static PromptPlus()
                         //none
                     }
                 }
-                if (_promptConfig.ResetBasicStateAfterExist)
-                {
-                    ResetState();
-                }
             };
 
-            AppDomain.CurrentDomain.FirstChanceException += ((object? o, FirstChanceExceptionEventArgs e) =>
+            AppDomain.CurrentDomain.FirstChanceException += ((o, e) =>
             {
-                if (e.Exception.GetType() == typeof(AppDomainUnloadedException))
+                if (e.Exception.GetType() == typeof(PromptPlusException))
                 {
-                    if (_consoledrive.UserPressKeyAborted && ((IConsoleExtend)_consoledrive).IsExitDefaultCancel)
-                    {
-                        ((IConsoleExtend)_consoledrive).ResetTokenCancelPress();
-                        Environment.Exit(1);
-                    }
+                    ((IConsoleExtend)_consoledrive).ResetTokenCancelPress();
+                    Environment.Exit(1);
                 }
             });
 
             AppDomain.CurrentDomain.UnhandledException += (s, e) =>
             {
+                if (_promptConfig.ResetBasicStateAfterExist)
+                {
+                    ResetState();
+                }
                 try
                 {
                     if (((IConsoleExtend)Console).AbortedByCtrlC)
                     {
-                        AppDomainUnloadedException error = new("Press Ctrl+C or Ctrl+Break");
+                        PromptPlusException error = new("Press Ctrl+C or Ctrl+Break");
                         WriteCrashLog(typeof(PromptPlus), error);
                         _promptConfig.AfterError?.Invoke(error);
                         System.Console.WriteLine($"{error}");
@@ -164,14 +164,9 @@ static PromptPlus()
                 {
                     //none
                 }
-                if (_promptConfig.ResetBasicStateAfterExist)
-                {
-                    ResetState();
-                }
             };
             _consoledrive.ResetColor();
             _consoledrive.Clear();
-            _consoledrive.RemoveCancelKeyPress();
         }
 
         /// <summary>
diff --git a/src/PublicLibrary/PromptPlusException.cs b/src/PublicLibrary/PromptPlusException.cs

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,6 @@`
`13`	`13`
`14`	`14`	`namespace PromptPlusLibrary.Controls`
`15`	`15`	`{`
`16`		`-`
`17`	`16`	`internal abstract class BaseControlPrompt<T>(bool isWidget, IConsoleExtend console, PromptConfig promptConfig, BaseControlOptions baseControlOptions, [CallerFilePath] string? filemecontrol = null)`
`18`	`17`	`{`
`19`	`18`	`private readonly BufferScreen _bufferScreen = new();`
`@@ -42,12 +41,16 @@ public void Show()`
`42`	`41`
`43`	`42`	`public ResultPrompt<T> Run(CancellationToken stoptoken = default)`
`44`	`43`	`{`
`45`		`- using CancellationTokenSource cts = CancellationTokenSource.CreateLinkedTokenSource(stoptoken, console.TokenCancelPress);`
	`44`	`+ if (ConsolePlus.IsExitDefaultCancel && ConsolePlus.AbortedByCtrlC)`
	`45`	`+ {`
	`46`	`+ throw new PromptPlusException();`
	`47`	`+ }`
	`48`	`+`
	`49`	`+ using CancellationTokenSource cts = CancellationTokenSource.CreateLinkedTokenSource(stoptoken, ConsolePlus.TokenCancelPress);`
`46`	`50`
`47`	`51`	`if (isWidget)`
`48`	`52`	`{`
`49`		`-`
`50`		`- using (((IConsole)console).InternalExclusiveContext())`
	`53`	`+ using (ConsolePlus.InternalExclusiveContext())`
`51`	`54`	`{`
`52`	`55`
`53`	`56`	`promptConfig.TraceBaseControlOptions = GeneralOptions;`
`@@ -80,6 +83,10 @@ public ResultPrompt<T> Run(CancellationToken stoptoken = default)`
`80`	`83`	`catch`
`81`	`84`	`{`
`82`	`85`	`error = true;`
	`86`	`+ if (ConsolePlus.IsExitDefaultCancel && ConsolePlus.AbortedByCtrlC)`
	`87`	`+ {`
	`88`	`+ throw new PromptPlusException();`
	`89`	`+ }`
`83`	`90`	`throw;`
`84`	`91`	`}`
`85`	`92`	`finally`
`@@ -103,7 +110,7 @@ public ResultPrompt<T> Run(CancellationToken stoptoken = default)`
`103`	`110`	`#pragma warning restore CS8604 // Possible null reference argument.`
`104`	`111`	`}`
`105`	`112`	`}`
`106`		`- using (console.InternalExclusiveContext())`
	`113`	`+ using (ConsolePlus.InternalExclusiveContext())`
`107`	`114`	`{`
`108`	`115`	`promptConfig.TraceBaseControlOptions = GeneralOptions;`
`109`	`116`	`promptConfig.TraceCurrentFileNameControl = filemecontrol;`
`@@ -160,6 +167,10 @@ public ResultPrompt<T> Run(CancellationToken stoptoken = default)`
`160`	`167`	`catch`
`161`	`168`	`{`
`162`	`169`	`error = true;`
	`170`	`+ if (ConsolePlus.IsExitDefaultCancel && ConsolePlus.AbortedByCtrlC)`
	`171`	`+ {`
	`172`	`+ throw new PromptPlusException();`
	`173`	`+ }`
`163`	`174`	`throw;`
`164`	`175`	`}`
`165`	`176`	`finally`
`@@ -221,11 +232,11 @@ public bool TryValidate(object input, IList<Func<object, ValidationResult>> vali`
`221`	`232`
`222`	`233`	`public ConsoleKeyInfo WaitKeypress(bool intercept, CancellationToken token)`
`223`	`234`	`{`
`224`		`- while (!console.KeyAvailable && !token.IsCancellationRequested)`
	`235`	`+ while (!ConsolePlus.KeyAvailable && !token.IsCancellationRequested)`
`225`	`236`	`{`
`226`	`237`	`token.WaitHandle.WaitOne(2);`
`227`	`238`	`}`
`228`		`- return console.KeyAvailable && !token.IsCancellationRequested ? console.ReadKey(intercept) : new ConsoleKeyInfo();`
	`239`	`+ return ConsolePlus.KeyAvailable && !token.IsCancellationRequested ? ConsolePlus.ReadKey(intercept) : new ConsoleKeyInfo();`
`229`	`240`	`}`
`230`	`241`
`231`	`242`	`public bool IsTooltipToggerKeyPress(ConsoleKeyInfo keyInfo)`
Original file line number	Diff line number	Diff line change
`@@ -18,16 +18,28 @@ public static partial class PromptPlus`
`18`	`18`	`/// <returns><see cref="IDisposable"/></returns>`
`19`	`19`	`public static IDisposable ExclusiveContext(this IConsole console)`
`20`	`20`	`{`
	`21`	`+ if (((IConsoleExtend)console).IsExitDefaultCancel && ((IConsoleExtend)console).AbortedByCtrlC)`
	`22`	`+ {`
	`23`	`+ throw new PromptPlusException();`
	`24`	`+ }`
`21`	`25`	`return new ExclusiveContextOutput((IConsoleExtend)console, false);`
`22`	`26`	`}`
`23`	`27`
`24`	`28`	`internal static IDisposable InternalExclusiveContext(this IConsole console)`
`25`	`29`	`{`
	`30`	`+ if (((IConsoleExtend)console).IsExitDefaultCancel && ((IConsoleExtend)console).AbortedByCtrlC)`
	`31`	`+ {`
	`32`	`+ throw new PromptPlusException();`
	`33`	`+ }`
`26`	`34`	`return new ExclusiveContextOutput((IConsoleExtend)console, true);`
`27`	`35`	`}`
`28`	`36`
`29`	`37`	`internal static IDisposable InternalExclusiveContext(this IConsoleExtend console)`
`30`	`38`	`{`
	`39`	`+ if (console.IsExitDefaultCancel && console.AbortedByCtrlC)`
	`40`	`+ {`
	`41`	`+ throw new PromptPlusException();`
	`42`	`+ }`
`31`	`43`	`return new ExclusiveContextOutput(console, true);`
`32`	`44`	`}`
`33`	`45`	`}`