Skip to content

handle Unicode encoding in Console.Beep #105094

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.

Sign up for GitHub

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 3 commits into from
Jul 22, 2024
+12 −1
Merged

handle Unicode encoding in Console.Beep #105094

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ff10a1
handle Unicode encoding in Console.Beep
adamsitnik Jul 18, 2024
6a372c6
address code review feedback: handle any encoding and endianness
adamsitnik Jul 19, 2024
577f641
address code review feedback: call GetBytes when 10 bytes is not enou…
adamsitnik Jul 22, 2024
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
9 changes: 7 additions & 2 deletions src/libraries/System.Console/src/System/ConsolePal.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,8 +679,13 @@ public static void Beep()
{
if (!Console.IsOutputRedirected)
{
ReadOnlySpan<byte> bell = "\u0007"u8; // Windows doesn't use terminfo, so the codepoint is hardcoded.
int errorCode = WindowsConsoleStream.WriteFileNative(OutputHandle, bell, useFileAPIs: Console.OutputEncoding.CodePage != UnicodeCodePage);
bool isUnicode = Console.OutputEncoding.CodePage == UnicodeCodePage;
Copy link
Member

@jkotas jkotas Jul 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there other encodings that are not UnicodeCodePage and that may end up the bell characters into more than one byte? Would it make more sense to just encode the bell character using the OutputEncoding instead of trying to guess what the encoding may do here?

Copy link
Member Author

@adamsitnik adamsitnik Jul 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. Moreover, this method should never be on a hot path so we don't really gain anything by hardcoding the encoded bytes. I've changed the implementation, PTAL


// Windows doesn't use terminfo, so the codepoint is hardcoded.
ReadOnlySpan<byte> bell = isUnicode ? stackalloc byte[2] { 7, 0 } : stackalloc byte[1] { 7 };
Copy link
Member

@stephentoub stephentoub Jul 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume we don't need to worry about endianness here?

Debug.Assert(!isUnicode || bell.SequenceEqual(Encoding.Unicode.GetBytes("\u0007")));

int errorCode = WindowsConsoleStream.WriteFileNative(OutputHandle, bell, useFileAPIs: !isUnicode);
if (errorCode == Interop.Errors.ERROR_SUCCESS)
{
return;
Expand Down