Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions src/NosCore.Shared/Helpers/ConsoleHelper.cs
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();
}
}
13 changes: 4 additions & 9 deletions src/NosCore.Shared/I18N/Logger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

using System;
using System.Globalization;
using System.IO;
using Microsoft.Extensions.Configuration;
using NosCore.Shared.Helpers;
using Serilog;

namespace NosCore.Shared.I18N
Expand Down Expand Up @@ -57,14 +57,9 @@ public static void PrintHeader(string text)

private static int GetWindowWidth()
{
try
{
return Console.WindowHeight > 0 ? Console.WindowWidth : HeadlessWindowWidth;
}
catch (IOException)
{
return HeadlessWindowWidth;
}
return ConsoleHelper.HasWindowSize && Console.WindowHeight > 0
? Console.WindowWidth
: HeadlessWindowWidth;
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
}
}
2 changes: 1 addition & 1 deletion src/NosCore.Shared/NosCore.Shared.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<RepositoryUrl>https://github.com/NosCoreIO/NosCore.Dao.git</RepositoryUrl>
<PackageIconUrl></PackageIconUrl>
<PackageTags>nostale, noscore, nostale private server source, nostale emulator</PackageTags>
<Version>6.0.1</Version>
<Version>6.0.2</Version>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<Description>NosCore's Shared Components</Description>
<PackageLicenseExpression></PackageLicenseExpression>
Expand Down
108 changes: 108 additions & 0 deletions test/NosCore.Shared.Tests/ConsoleHelperTests.cs
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;
}
}
}
}
Loading