6742965bb8
There are some code pages with "unmapped" code points in the C1 range, which results in them being translated into Unicode C1 control codes, even though that is not their intended use. To avoid having these characters triggering unintentional escape sequences, this PR now disables C1 controls by default. Switching to ISO-2022 encoding will re-enable them, though, since that is the most likely scenario in which they would be required. They can also be explicitly enabled, even in UTF-8 mode, with the `DECAC1` escape sequence. What I've done is add a new mode to the `StateMachine` class that controls whether C1 code points are interpreted as control characters or not. When disabled, these code points are simply dropped from the output, similar to the way a `NUL` is interpreted. This isn't exactly the way they were handled in the v1 console (which I think replaces them with the font _notdef_ glyph), but it matches the XTerm behavior, which seems more appropriate considering this is in VT mode. And it's worth noting that Windows Explorer seems to work the same way. As mentioned above, the mode can be enabled by designating the ISO-2022 coding system with a `DOCS` sequence, and it will be disabled again when UTF-8 is designated. You can also enable it explicitly with a `DECAC1` sequence (originally this was actually a DEC printer sequence, but it doesn't seem unreasonable to use it in a terminal). I've also extended the operations that save and restore "cursor state" (e.g. `DECSC` and `DECRC`) to include the state of the C1 parser mode, since it's closely tied to the code page and character sets which are also saved there. Similarly, when a `DECSTR` sequence resets the code page and character sets, I've now made it reset the C1 mode as well. I should note that the new `StateMachine` mode is controlled via a generic `SetParserMode` method (with a matching API in the `ConGetSet` interface) to allow for easier addition of other modes in the future. And I've reimplemented the existing ANSI/VT52 mode in terms of these generic methods instead of it having to have its own separate APIs. ## Validation Steps Performed Some of the unit tests for OSC sequences were using a C1 `0x9C` for the string terminator, which doesn't work by default anymore. Since that's not a good practice anyway, I thought it best to change those to a standard 7-bit terminator. However, in tests that were explicitly validating the C1 controls, I've just enabled the C1 parser mode at the start of the tests in order to get them working again. There were also some ANSI mode adapter tests that had to be updated to account for the fact that it has now been reimplemented in terms of the `SetParserMode` API. I've added a new state machine test to validate the changes in behavior when the C1 parser mode is enabled or disabled. And I've added an adapter test to verify that the `DesignateCodingSystems` and `AcceptC1Controls` methods toggle the C1 parser mode as expected. I've manually verified the test cases in #10069 and #10310 to confirm that they're no longer triggering control sequences by default. Although, as I explained above, the C1 code points are completely dropped from the output rather than displayed as _notdef_ glyphs. I think this is a reasonable compromise though. Closes #10069 Closes #10310
113 lines
5.1 KiB
C++
113 lines
5.1 KiB
C++
/*++
|
|
Copyright (c) Microsoft Corporation
|
|
Licensed under the MIT license.
|
|
|
|
Module Name:
|
|
- conGetSet.hpp
|
|
|
|
Abstract:
|
|
- This serves as an abstraction layer for the adapters to connect to the console API functions.
|
|
- The abstraction allows for the substitution of the functions for internal/external to Conhost.exe use as well as easy testing.
|
|
|
|
Author(s):
|
|
- Michael Niksa (MiNiksa) 30-July-2015
|
|
--*/
|
|
|
|
#pragma once
|
|
|
|
#include "../input/terminalInput.hpp"
|
|
#include "../parser/stateMachine.hpp"
|
|
#include "../../types/inc/IInputEvent.hpp"
|
|
#include "../../buffer/out/LineRendition.hpp"
|
|
#include "../../buffer/out/TextAttribute.hpp"
|
|
#include "../../inc/conattrs.hpp"
|
|
|
|
#include <deque>
|
|
#include <memory>
|
|
|
|
namespace Microsoft::Console::VirtualTerminal
|
|
{
|
|
class ConGetSet
|
|
{
|
|
public:
|
|
virtual ~ConGetSet() = default;
|
|
virtual bool GetConsoleScreenBufferInfoEx(CONSOLE_SCREEN_BUFFER_INFOEX& screenBufferInfo) const = 0;
|
|
virtual bool SetConsoleScreenBufferInfoEx(const CONSOLE_SCREEN_BUFFER_INFOEX& screenBufferInfo) = 0;
|
|
virtual bool SetConsoleCursorPosition(const COORD position) = 0;
|
|
|
|
virtual bool PrivateIsVtInputEnabled() const = 0;
|
|
|
|
virtual bool PrivateGetTextAttributes(TextAttribute& attrs) const = 0;
|
|
virtual bool PrivateSetTextAttributes(const TextAttribute& attrs) = 0;
|
|
|
|
virtual bool PrivateSetCurrentLineRendition(const LineRendition lineRendition) = 0;
|
|
virtual bool PrivateResetLineRenditionRange(const size_t startRow, const size_t endRow) = 0;
|
|
virtual SHORT PrivateGetLineWidth(const size_t row) const = 0;
|
|
|
|
virtual bool PrivateWriteConsoleInputW(std::deque<std::unique_ptr<IInputEvent>>& events,
|
|
size_t& eventsWritten) = 0;
|
|
virtual bool SetConsoleWindowInfo(const bool absolute,
|
|
const SMALL_RECT& window) = 0;
|
|
|
|
virtual bool SetInputMode(const TerminalInput::Mode mode, const bool enabled) = 0;
|
|
virtual bool SetParserMode(const StateMachine::Mode mode, const bool enabled) = 0;
|
|
virtual bool GetParserMode(const StateMachine::Mode mode) const = 0;
|
|
|
|
virtual bool PrivateSetScreenMode(const bool reverseMode) = 0;
|
|
virtual bool PrivateSetAutoWrapMode(const bool wrapAtEOL) = 0;
|
|
|
|
virtual bool PrivateShowCursor(const bool show) = 0;
|
|
virtual bool PrivateAllowCursorBlinking(const bool enable) = 0;
|
|
|
|
virtual bool PrivateSetScrollingRegion(const SMALL_RECT& scrollMargins) = 0;
|
|
virtual bool PrivateWarningBell() = 0;
|
|
virtual bool PrivateGetLineFeedMode() const = 0;
|
|
virtual bool PrivateLineFeed(const bool withReturn) = 0;
|
|
virtual bool PrivateReverseLineFeed() = 0;
|
|
virtual bool SetConsoleTitleW(const std::wstring_view title) = 0;
|
|
virtual bool PrivateUseAlternateScreenBuffer() = 0;
|
|
virtual bool PrivateUseMainScreenBuffer() = 0;
|
|
|
|
virtual bool PrivateEraseAll() = 0;
|
|
virtual bool PrivateClearBuffer() = 0;
|
|
virtual bool GetUserDefaultCursorStyle(CursorType& style) = 0;
|
|
virtual bool SetCursorStyle(const CursorType style) = 0;
|
|
virtual bool SetCursorColor(const COLORREF color) = 0;
|
|
virtual bool PrivateWriteConsoleControlInput(const KeyEvent key) = 0;
|
|
virtual bool PrivateRefreshWindow() = 0;
|
|
|
|
virtual bool SetConsoleOutputCP(const unsigned int codepage) = 0;
|
|
virtual bool GetConsoleOutputCP(unsigned int& codepage) = 0;
|
|
|
|
virtual bool PrivateSuppressResizeRepaint() = 0;
|
|
virtual bool IsConsolePty() const = 0;
|
|
|
|
virtual bool DeleteLines(const size_t count) = 0;
|
|
virtual bool InsertLines(const size_t count) = 0;
|
|
|
|
virtual bool MoveToBottom() const = 0;
|
|
|
|
virtual bool PrivateGetColorTableEntry(const size_t index, COLORREF& value) const = 0;
|
|
virtual bool PrivateSetColorTableEntry(const size_t index, const COLORREF value) const = 0;
|
|
virtual bool PrivateSetDefaultForeground(const COLORREF value) const = 0;
|
|
virtual bool PrivateSetDefaultBackground(const COLORREF value) const = 0;
|
|
|
|
virtual bool PrivateFillRegion(const COORD startPosition,
|
|
const size_t fillLength,
|
|
const wchar_t fillChar,
|
|
const bool standardFillAttrs) = 0;
|
|
|
|
virtual bool PrivateScrollRegion(const SMALL_RECT scrollRect,
|
|
const std::optional<SMALL_RECT> clipRect,
|
|
const COORD destinationOrigin,
|
|
const bool standardFillAttrs) = 0;
|
|
|
|
virtual bool PrivateAddHyperlink(const std::wstring_view uri, const std::wstring_view params) const = 0;
|
|
virtual bool PrivateEndHyperlink() const = 0;
|
|
|
|
virtual bool PrivateUpdateSoftFont(const gsl::span<const uint16_t> bitPattern,
|
|
const SIZE cellSize,
|
|
const size_t centeringHint) = 0;
|
|
};
|
|
}
|