65bd4e327c
## Summary of the Pull Request Despite being specified as `noexcept`, `FillConsoleOutputCharacterA` emits an exception when a call to `ConvetToW` is made with an argument character which can't be converted. This PR fixes this throw, by wrapping `ConvertToW` in a try-catch_return. ## PR Checklist * [x] Closes #4258 * [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA * [x] Tests added/passed: thanks @miniksa ## Detailed Description of the Pull Request / Additional comments Following the semantics of other `FillConsoleOutputCharacter*` the output param `cellsModified` is set to `0`. The try-catch_return is also what other functions of this family perform in case of errors. ## Validation Steps Performed Original repro no longer crashes.
216 lines
10 KiB
C++
216 lines
10 KiB
C++
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "precomp.h"
|
|
|
|
#define CP_USA 437
|
|
|
|
class FillOutputTests
|
|
{
|
|
BEGIN_TEST_CLASS(FillOutputTests)
|
|
END_TEST_CLASS()
|
|
|
|
// Adapted from repro in GH#4258
|
|
TEST_METHOD(FillWithInvalidCharacterA)
|
|
{
|
|
BEGIN_TEST_METHOD_PROPERTIES()
|
|
TEST_METHOD_PROPERTY(L"IsolationLevel", L"Method") // Don't pollute other tests by isolating our codepage change to this test.
|
|
END_TEST_METHOD_PROPERTIES()
|
|
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleOutputCP(50220));
|
|
auto handle = GetStdOutputHandle();
|
|
const COORD pos{ 0, 0 };
|
|
DWORD written = 0;
|
|
const char originalCh = 14;
|
|
|
|
WEX::Logging::Log::Comment(L"This test diverges between V1 and V2 consoles.");
|
|
if (Common::_isV2)
|
|
{
|
|
VERIFY_WIN32_BOOL_FAILED(FillConsoleOutputCharacterA(handle, originalCh, 1, pos, &written));
|
|
VERIFY_ARE_EQUAL(gsl::narrow_cast<DWORD>(HRESULT_CODE(E_UNEXPECTED)), ::GetLastError());
|
|
}
|
|
else
|
|
{
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(FillConsoleOutputCharacterA(handle, originalCh, 1, pos, &written));
|
|
VERIFY_ARE_EQUAL(1u, written);
|
|
|
|
char readCh = 42; // don't use null (the expected) or 14 (the actual) to ensure that it is read out.
|
|
DWORD read = 0;
|
|
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(ReadConsoleOutputCharacterA(handle, &readCh, 1, pos, &read));
|
|
VERIFY_ARE_EQUAL(1u, read);
|
|
VERIFY_ARE_EQUAL(0, readCh, L"Null should be read back as the conversion from the invalid original character.");
|
|
}
|
|
}
|
|
|
|
TEST_METHOD(WriteNarrowGlyphAscii)
|
|
{
|
|
HANDLE hConsole = GetStdOutputHandle();
|
|
DWORD charsWritten = 0;
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(FillConsoleOutputCharacterA(hConsole,
|
|
'a',
|
|
1,
|
|
{ 0, 0 },
|
|
&charsWritten));
|
|
VERIFY_ARE_EQUAL(1u, charsWritten);
|
|
|
|
// test a box drawing character
|
|
const UINT previousCodepage = GetConsoleOutputCP();
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleOutputCP(CP_USA));
|
|
|
|
charsWritten = 0;
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(FillConsoleOutputCharacterA(hConsole,
|
|
'\xCE', // U+256C box drawing double vertical and horizontal
|
|
1,
|
|
{ 0, 0 },
|
|
&charsWritten));
|
|
VERIFY_ARE_EQUAL(1u, charsWritten);
|
|
VERIFY_SUCCEEDED(SetConsoleOutputCP(previousCodepage));
|
|
}
|
|
|
|
TEST_METHOD(WriteNarrowGlyphUnicode)
|
|
{
|
|
HANDLE hConsole = GetStdOutputHandle();
|
|
DWORD charsWritten = 0;
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(FillConsoleOutputCharacterW(hConsole,
|
|
L'a',
|
|
1,
|
|
{ 0, 0 },
|
|
&charsWritten));
|
|
VERIFY_ARE_EQUAL(1u, charsWritten);
|
|
}
|
|
|
|
TEST_METHOD(WriteWideGlyphUnicode)
|
|
{
|
|
HANDLE hConsole = GetStdOutputHandle();
|
|
DWORD charsWritten = 0;
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(FillConsoleOutputCharacterW(hConsole,
|
|
L'\x304F',
|
|
1,
|
|
{ 0, 0 },
|
|
&charsWritten));
|
|
VERIFY_ARE_EQUAL(1u, charsWritten);
|
|
}
|
|
|
|
TEST_METHOD(UnsetWrap)
|
|
{
|
|
// WARNING: If this test suddenly decides to start failing,
|
|
// this is because the wrap registry key is not set.
|
|
// TODO GH #2859: Get/Set Registry Key for Wrap
|
|
|
|
HANDLE hConsole = GetStdOutputHandle();
|
|
DWORD charsWritten = 0;
|
|
|
|
CONSOLE_SCREEN_BUFFER_INFOEX sbiex = { 0 };
|
|
sbiex.cbSize = sizeof(sbiex);
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(GetConsoleScreenBufferInfoEx(hConsole, &sbiex));
|
|
|
|
const auto consoleWidth = sbiex.dwSize.X;
|
|
|
|
std::wstring input(consoleWidth + 2, L'a');
|
|
std::wstring filled(consoleWidth, L'b');
|
|
|
|
// Write until a wrap occurs
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(WriteConsoleW(hConsole,
|
|
input.data(),
|
|
gsl::narrow_cast<DWORD>(input.size()),
|
|
&charsWritten,
|
|
nullptr));
|
|
|
|
// Verify wrap occurred
|
|
std::unique_ptr<wchar_t[]> bufferText = std::make_unique<wchar_t[]>(consoleWidth);
|
|
DWORD readSize = 0;
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(ReadConsoleOutputCharacterW(hConsole,
|
|
bufferText.get(),
|
|
consoleWidth,
|
|
{ 0, 0 },
|
|
&readSize));
|
|
|
|
WEX::Common::String expected(input.c_str(), readSize);
|
|
WEX::Common::String actual(bufferText.get(), readSize);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
|
|
bufferText = std::make_unique<wchar_t[]>(2);
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(ReadConsoleOutputCharacterW(hConsole,
|
|
bufferText.get(),
|
|
2,
|
|
{ 0, 1 },
|
|
&readSize));
|
|
|
|
VERIFY_ARE_EQUAL(2u, readSize);
|
|
expected = WEX::Common::String(input.c_str(), readSize);
|
|
actual = WEX::Common::String(bufferText.get(), readSize);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
|
|
// Fill Console Line with 'b's
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(FillConsoleOutputCharacterW(hConsole,
|
|
L'b',
|
|
consoleWidth,
|
|
{ 2, 0 },
|
|
&charsWritten));
|
|
|
|
// Verify first line is full of 'a's then 'b's
|
|
bufferText = std::make_unique<wchar_t[]>(consoleWidth);
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(ReadConsoleOutputCharacterW(hConsole,
|
|
bufferText.get(),
|
|
consoleWidth,
|
|
{ 0, 0 },
|
|
&readSize));
|
|
|
|
expected = WEX::Common::String(input.c_str(), 2);
|
|
actual = WEX::Common::String(bufferText.get(), 2);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
|
|
expected = WEX::Common::String(filled.c_str(), consoleWidth - 2);
|
|
actual = WEX::Common::String(&bufferText[2], readSize - 2);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
|
|
// Verify second line is still has 'a's that wrapped over
|
|
bufferText = std::make_unique<wchar_t[]>(2);
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(ReadConsoleOutputCharacterW(hConsole,
|
|
bufferText.get(),
|
|
static_cast<SHORT>(2),
|
|
{ 0, 0 },
|
|
&readSize));
|
|
|
|
VERIFY_ARE_EQUAL(2u, readSize);
|
|
expected = WEX::Common::String(input.c_str(), 2);
|
|
actual = WEX::Common::String(bufferText.get(), readSize);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
|
|
// Resize to be smaller by 2
|
|
sbiex.srWindow.Right -= 2;
|
|
sbiex.dwSize.X -= 2;
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(SetConsoleScreenBufferInfoEx(hConsole, &sbiex));
|
|
|
|
// Verify first line is full of 'a's then 'b's
|
|
bufferText = std::make_unique<wchar_t[]>(consoleWidth - 2);
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(ReadConsoleOutputCharacterW(hConsole,
|
|
bufferText.get(),
|
|
consoleWidth - static_cast<SHORT>(2),
|
|
{ 0, 0 },
|
|
&readSize));
|
|
|
|
expected = WEX::Common::String(input.c_str(), 2);
|
|
actual = WEX::Common::String(bufferText.get(), 2);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
|
|
expected = WEX::Common::String(filled.c_str(), consoleWidth - 4);
|
|
actual = WEX::Common::String(&bufferText[2], readSize - 2);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
|
|
// Verify second line is still has 'a's ('b's didn't wrap over)
|
|
bufferText = std::make_unique<wchar_t[]>(static_cast<SHORT>(2));
|
|
VERIFY_WIN32_BOOL_SUCCEEDED(ReadConsoleOutputCharacterW(hConsole,
|
|
bufferText.get(),
|
|
static_cast<SHORT>(2),
|
|
{ 0, 0 },
|
|
&readSize));
|
|
|
|
VERIFY_ARE_EQUAL(2u, readSize);
|
|
expected = WEX::Common::String(input.c_str(), 2);
|
|
actual = WEX::Common::String(bufferText.get(), readSize);
|
|
VERIFY_ARE_EQUAL(expected, actual);
|
|
}
|
|
};
|