-
-
Notifications
You must be signed in to change notification settings - Fork 1
Decide the console state instead of catching the throw #259
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // __ _ __ __ ___ __ ___ ___ | ||
| // | \| |/__\ /' _/ / _//__\| _ \ __| | ||
| // | | ' | \/ |`._`.| \_| \/ | v / _| | ||
| // |_|\__|\__/ |___/ \__/\__/|_|_\___| | ||
| // ----------------------------------- | ||
|
|
||
| using System; | ||
| using System.Runtime.InteropServices; | ||
|
|
||
| namespace NosCore.Shared.Helpers | ||
| { | ||
| public static class ConsoleHelper | ||
| { | ||
| // Console.WindowWidth reads the screen buffer through stdout, then stderr. Its third | ||
| // try, stdin, cannot answer: a console input handle has no screen buffer, so a process | ||
| // whose output is piped while stdin is still on the console has no width to read. | ||
| public static bool HasWindowSize => !Console.IsOutputRedirected || !Console.IsErrorRedirected; | ||
|
|
||
| public static void SetTitle(string title) | ||
| { | ||
| if (OperatingSystem.IsWindows() && CanCarryTitle) | ||
| { | ||
| Console.Title = title; | ||
| } | ||
| } | ||
|
|
||
| public static void AppendTitle(string suffix) | ||
| { | ||
| if (OperatingSystem.IsWindows() && CanCarryTitle) | ||
| { | ||
| Console.Title += suffix; | ||
| } | ||
| } | ||
|
|
||
| public static bool CanCarryTitle => !Console.IsOutputRedirected && GetConsoleWindow() != IntPtr.Zero; | ||
|
|
||
| [DllImport("kernel32.dll")] | ||
| private static extern IntPtr GetConsoleWindow(); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| // __ _ __ __ ___ __ ___ ___ | ||
| // | \| |/__\ /' _/ / _//__\| _ \ __| | ||
| // | | ' | \/ |`._`.| \_| \/ | v / _| | ||
| // |_|\__|\__/ |___/ \__/\__/|_|_\___| | ||
| // ----------------------------------- | ||
|
|
||
| using System; | ||
| using System.IO; | ||
| using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
| using NosCore.Shared.Helpers; | ||
| using NosCore.Shared.I18N; | ||
|
|
||
| namespace NosCore.Shared.Tests | ||
| { | ||
| // A test process cannot choose whether it owns a console, so each case asserts the | ||
| // half of the contract its own state can prove and stands aside for the other. | ||
| [TestClass] | ||
| public class ConsoleHelperTests | ||
| { | ||
| private const int HeadlessSeparatorWidth = 20; | ||
|
|
||
| [TestMethod] | ||
| public void TitleIsLeftAloneWhenNothingCanCarryIt() | ||
| { | ||
| if (ConsoleHelper.CanCarryTitle) | ||
| { | ||
| Assert.Inconclusive("This process owns a console, so the title is expected to change."); | ||
| } | ||
|
|
||
| var before = ReadTitle(); | ||
|
|
||
| ConsoleHelper.SetTitle("NosCore"); | ||
| ConsoleHelper.AppendTitle(" - Port : 4000"); | ||
|
|
||
| Assert.AreEqual(before, ReadTitle()); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void TitleIsSetWhenAConsoleCanCarryIt() | ||
| { | ||
| if (!ConsoleHelper.CanCarryTitle) | ||
| { | ||
| Assert.Inconclusive("This process owns no console to carry a title."); | ||
| } | ||
|
|
||
| ConsoleHelper.SetTitle("NosCore"); | ||
| ConsoleHelper.AppendTitle(" - Port : 4000"); | ||
|
|
||
| Assert.AreEqual("NosCore - Port : 4000", ReadTitle()); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void HeaderFallsBackToAFixedWidthWhenTheSizeIsUnreadable() | ||
| { | ||
| if (ConsoleHelper.HasWindowSize) | ||
| { | ||
| Assert.Inconclusive("This process can read a console width, so the fallback does not apply."); | ||
| } | ||
|
|
||
| Assert.AreEqual(new string('=', HeadlessSeparatorWidth), PrintHeaderAndReadSeparator()); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void HeaderUsesTheConsoleWidthWhenThereIsOne() | ||
| { | ||
| if (!ConsoleHelper.HasWindowSize || Console.WindowHeight <= 0) | ||
| { | ||
| Assert.Inconclusive("This process cannot read a console width."); | ||
| } | ||
|
|
||
| Assert.AreEqual(new string('=', Console.WindowWidth - 1), PrintHeaderAndReadSeparator()); | ||
| } | ||
|
|
||
| private static string PrintHeaderAndReadSeparator() | ||
| { | ||
| var captured = new StringWriter(); | ||
| var original = Console.Out; | ||
| try | ||
| { | ||
| Console.SetOut(captured); | ||
| Logger.PrintHeader("NosCore"); | ||
| } | ||
| finally | ||
| { | ||
| Console.SetOut(original); | ||
| } | ||
|
|
||
| return captured.ToString().Split('\n')[0].TrimEnd('\r'); | ||
| } | ||
|
|
||
| private static string? ReadTitle() | ||
| { | ||
| if (!OperatingSystem.IsWindows()) | ||
| { | ||
| return null; | ||
| } | ||
|
|
||
| try | ||
| { | ||
| return Console.Title; | ||
| } | ||
| catch (IOException) | ||
| { | ||
| return null; | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.