2019-05-03 00:29:04 +02:00
|
|
|
// Copyright (c) Microsoft Corporation.
|
|
|
|
|
// Licensed under the MIT license.
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
|
|
#include <conattrs.hpp>
|
|
|
|
|
|
|
|
|
|
#include "../../buffer/out/textBuffer.hpp"
|
Add support for the "blink" graphic rendition attribute (#7490)
This PR adds support for the _blink_ graphic rendition attribute. When a
character is output with this attribute set, it "blinks" at a regular
interval, by cycling its color between the normal rendition and a dimmer
shade of that color.
The majority of the blinking mechanism is encapsulated in a new
`BlinkingState` class, which is shared between the Terminal and Conhost
implementations. This class keeps track of the position in the blinking
cycle, which determines whether characters are rendered as normal or
faint.
In Windows Terminal, the state is stored in the `Terminal` class, and in
Conhost it's stored in the `CONSOLE_INFORMATION` class. In both cases,
the `IsBlinkingFaint` method is used to determine the current blinking
rendition, and that is passed on as a parameter to the
`TextAttribute::CalculateRgbColors` method when these classes are
looking up attribute colors.
Prior to calculating the colors, the current attribute is also passed to
the `RecordBlinkingUsage` method, which keeps track of whether there are
actually any blink attributes in use. This is used to determine whether
the screen needs to be refreshed when the blinking cycle toggles between
the normal and faint renditions.
The refresh itself is handled by the `ToggleBlinkingRendition` method,
which is triggered by a timer. In Conhost this is just piggybacking on
the existing cursor blink timer, but in Windows Terminal it needs to
have its own separate timer, since the cursor timer is reset whenever a
key is pressed, which is not something we want for attribute blinking.
Although the `ToggleBlinkingRendition` is called at the same rate as the
cursor blinking, we actually only want the cells to blink at half that
frequency. We thus have a counter that cycles through four phases, and
blinking is rendered as faint for two of those four. Then every two
cycles - when the state changes - a redraw is triggered, but only if
there are actually blinking attributes in use (as previously recorded).
As mentioned earlier, the blinking frequency is based on the cursor
blink rate, so that means it'll automatically be disabled if a user has
set their cursor blink rate to none. It can also be disabled by turning
off the _Show animations in Windows_ option. In Conhost these settings
take effect immediately, but in Windows Terminal they only apply when a
new tab is opened.
This PR also adds partial support for the `SGR 6` _rapid blink_
attribute. This is not used by DEC terminals, but was defined in the
ECMA/ANSI standards. It's not widely supported, but many terminals just
it implement it as an alias for the regular `SGR 5` blink attribute, so
that's what I've done here too.
## Validation Steps Performed
I've checked the _Graphic rendition test pattern_ in Vttest, and
compared our representation of the blink attribute to that of an actual
DEC VT220 terminal as seen on [YouTube]. With the right color scheme
it's a reasonably close match.
[YouTube]: https://www.youtube.com/watch?v=03Pz5AmxbE4&t=1m55s
Closes #7388
2020-09-22 01:21:33 +02:00
|
|
|
#include "../../renderer/inc/BlinkingState.hpp"
|
2019-05-03 00:29:04 +02:00
|
|
|
#include "../../terminal/parser/StateMachine.hpp"
|
|
|
|
|
#include "../../terminal/input/terminalInput.hpp"
|
|
|
|
|
|
|
|
|
|
#include "../../types/inc/Viewport.hpp"
|
Show a double width cursor for double width characters (#5319)
# Summary of the Pull Request
This PR will allow the cursor to be double width when on top of a double width character. This required changing `IsCursorDoubleWidth` to check whether the glyph the cursor's on top of is double width. This code is exactly the same as the original PR that addressed this issue in #2932. That one got reverted at some point due to the crashes related to it, but due to a combination of Terminal having come further since that PR and other changes to address use-after-frees, some of the crashes may/may not be relevant now. The ones that seemed to be relevant/repro-able, I attempt to address in this PR.
The `IsCursorDoubleWidth` check would fail during the `TextBuffer::Reflow` call inside of `Terminal::UserResize` occasionally, particularly when `newCursor.EndDeferDrawing()` is called. This is because when we tell the newCursor to `EndDefer`, the renderer will attempt to redraw the cursor. As part of this redraw, it'll ask if `IsCursorDoubleWidth`, and if the renderer managed to ask this before `UserResize` swapped out the old buffer with the new one from `Reflow`, the renderer will be asking the old buffer if its out-of-bounds cursor is double width. This was pretty easily repro'd using `cmatrix -u0` and resizing the window like a madman.
As a solution, I've moved the Start/End DeferDrawing calls out of `Reflow` and into `UserResize`. This way, I can "clamp" the portion of the code where the newBuffer is getting created and reflowed and swapped into the Terminal buffer, and only allow the renderer to draw once the swap is done. This also means that ConHost's `ResizeWithReflow` needed to change slightly.
In addition, I've added a WriteLock to `SetCursorOn`. It was mentioned as a fix for a crash in #2965 (although I can't repro), and I also figured it would be good to try to emulate where ConHost locks with regards to Cursor operations, and this seemed to be one that we were missing.
## PR Checklist
* [x] Closes #2713
* [x] CLA signed
* [x] Tests added/passed
## Validation Steps Performed
Manual validation that the cursor is indeed chonky, added a test case to check that we are correctly saying that the cursor is double width (not too sure if I put it in the right place). Also open to other test case ideas and thoughts on what else I should be careful for since I am quite nervous about what other crashes might occur.
2020-04-15 21:23:06 +02:00
|
|
|
#include "../../types/inc/GlyphWidth.hpp"
|
2019-08-19 20:03:45 +02:00
|
|
|
#include "../../types/IUiaData.h"
|
2019-05-03 00:29:04 +02:00
|
|
|
#include "../../cascadia/terminalcore/ITerminalApi.hpp"
|
|
|
|
|
#include "../../cascadia/terminalcore/ITerminalInput.hpp"
|
|
|
|
|
|
|
|
|
|
// You have to forward decl the ICoreSettings here, instead of including the header.
|
|
|
|
|
// If you include the header, there will be compilation errors with other
|
|
|
|
|
// headers that include Terminal.hpp
|
2020-08-07 16:46:52 +02:00
|
|
|
namespace winrt::Microsoft::Terminal::TerminalControl
|
2019-05-03 00:29:04 +02:00
|
|
|
{
|
|
|
|
|
struct ICoreSettings;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
namespace Microsoft::Terminal::Core
|
|
|
|
|
{
|
|
|
|
|
class Terminal;
|
|
|
|
|
}
|
|
|
|
|
|
Create tests that roundtrip output through a conpty to a Terminal (#4213)
## Summary of the Pull Request
This PR adds two tests:
* First, I started by writing a test where I could write output to the console host and inspect what output came out of conpty. This is the `ConptyOutputTests` in the host unit tests.
* Then I got crazy and thought _"what if I could take that output and dump it straight into the `Terminal`"_? Hence, the `ConptyRoundtripTests` were born, into the TerminalCore unit tests.
## References
Done in pursuit of #4200, but I felt this warranted it's own atomic PR
## PR Checklist
* [x] Doesn't close anything on it's own.
* [x] I work here
* [x] you better believe this adds tests
* [n/a] Requires documentation to be updated
## Detailed Description of the Pull Request / Additional comments
From the comment in `ConptyRoundtripTests`:
> This test class creates an in-proc conpty host as well as a Terminal, to
> validate that strings written to the conpty create the same resopnse on the
> terminal end. Tests can be written that validate both the contents of the
> host buffer as well as the terminal buffer. Everytime that
> `renderer.PaintFrame()` is called, the tests will validate the expected
> output, and then flush the output of the VtEngine straight to th
Also, some other bits had to be updated:
* The renderer needed to be able to survive without a thread, so I hadded a simple check that it actually had a thread before calling `pThread->NotifyPaint`
* Bits in `CommonState` used `NTSTATUS_FROM_HRESULT` which did _not_ work outside the host project. Since the `NTSTATUS` didn't seem that important, I replaced that with a `HRESULT`
* `CommonState` likes to initialize the console to some _weird_ defaults. I added an optional param to let us just use the defaults.
2020-01-17 17:40:12 +01:00
|
|
|
// fwdecl unittest classes
|
|
|
|
|
#ifdef UNIT_TESTING
|
2020-01-29 17:33:06 +01:00
|
|
|
namespace TerminalCoreUnitTests
|
|
|
|
|
{
|
|
|
|
|
class TerminalBufferTests;
|
2020-03-13 18:39:42 +01:00
|
|
|
class TerminalApiTest;
|
2020-01-29 17:33:06 +01:00
|
|
|
class ConptyRoundtripTests;
|
2020-06-12 21:51:37 +02:00
|
|
|
class ScrollTest;
|
2020-01-29 17:33:06 +01:00
|
|
|
};
|
Create tests that roundtrip output through a conpty to a Terminal (#4213)
## Summary of the Pull Request
This PR adds two tests:
* First, I started by writing a test where I could write output to the console host and inspect what output came out of conpty. This is the `ConptyOutputTests` in the host unit tests.
* Then I got crazy and thought _"what if I could take that output and dump it straight into the `Terminal`"_? Hence, the `ConptyRoundtripTests` were born, into the TerminalCore unit tests.
## References
Done in pursuit of #4200, but I felt this warranted it's own atomic PR
## PR Checklist
* [x] Doesn't close anything on it's own.
* [x] I work here
* [x] you better believe this adds tests
* [n/a] Requires documentation to be updated
## Detailed Description of the Pull Request / Additional comments
From the comment in `ConptyRoundtripTests`:
> This test class creates an in-proc conpty host as well as a Terminal, to
> validate that strings written to the conpty create the same resopnse on the
> terminal end. Tests can be written that validate both the contents of the
> host buffer as well as the terminal buffer. Everytime that
> `renderer.PaintFrame()` is called, the tests will validate the expected
> output, and then flush the output of the VtEngine straight to th
Also, some other bits had to be updated:
* The renderer needed to be able to survive without a thread, so I hadded a simple check that it actually had a thread before calling `pThread->NotifyPaint`
* Bits in `CommonState` used `NTSTATUS_FROM_HRESULT` which did _not_ work outside the host project. Since the `NTSTATUS` didn't seem that important, I replaced that with a `HRESULT`
* `CommonState` likes to initialize the console to some _weird_ defaults. I added an optional param to let us just use the defaults.
2020-01-17 17:40:12 +01:00
|
|
|
#endif
|
|
|
|
|
|
2019-05-03 00:29:04 +02:00
|
|
|
class Microsoft::Terminal::Core::Terminal final :
|
|
|
|
|
public Microsoft::Terminal::Core::ITerminalApi,
|
|
|
|
|
public Microsoft::Terminal::Core::ITerminalInput,
|
2019-08-19 20:03:45 +02:00
|
|
|
public Microsoft::Console::Render::IRenderData,
|
|
|
|
|
public Microsoft::Console::Types::IUiaData
|
2019-05-03 00:29:04 +02:00
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
Terminal();
|
2019-10-11 23:02:09 +02:00
|
|
|
~Terminal(){};
|
|
|
|
|
Terminal(const Terminal&) = default;
|
|
|
|
|
Terminal(Terminal&&) = default;
|
|
|
|
|
Terminal& operator=(const Terminal&) = default;
|
|
|
|
|
Terminal& operator=(Terminal&&) = default;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
void Create(COORD viewportSize,
|
|
|
|
|
SHORT scrollbackLines,
|
|
|
|
|
Microsoft::Console::Render::IRenderTarget& renderTarget);
|
|
|
|
|
|
2020-08-07 16:46:52 +02:00
|
|
|
void CreateFromSettings(winrt::Microsoft::Terminal::TerminalControl::ICoreSettings settings,
|
2019-06-11 22:27:09 +02:00
|
|
|
Microsoft::Console::Render::IRenderTarget& renderTarget);
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2020-08-07 16:46:52 +02:00
|
|
|
void UpdateSettings(winrt::Microsoft::Terminal::TerminalControl::ICoreSettings settings);
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
// Write goes through the parser
|
|
|
|
|
void Write(std::wstring_view stringView);
|
|
|
|
|
|
2019-06-11 22:27:09 +02:00
|
|
|
[[nodiscard]] std::shared_lock<std::shared_mutex> LockForReading();
|
|
|
|
|
[[nodiscard]] std::unique_lock<std::shared_mutex> LockForWriting();
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
short GetBufferHeight() const noexcept;
|
|
|
|
|
|
Search - add search box control and implement search experience (#3590)
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
This is the PR for feature Search: #605
This PR includes the newly introduced SearchBoxControl in TermControl dir, which is the search bar for the search experience. And the codes that enable Search in Windows Terminal.
<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? -->
The PR that migrates the Conhost search module: https://github.com/microsoft/terminal/pull/3279
Spec (still actively updating): https://github.com/microsoft/terminal/pull/3299
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
* [x] Closes #605
* [ ] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Requires documentation to be updated
* [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx
<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
These functionalities are included in the search experience.
1. Search in Terminal text buffer.
2. Automatic wrap-around.
3. Search up or down switch by clicking different buttons.
4. Search case sensitively/insensitively by clicking a button. S. Move the search box to the top/bottom by clicking a button.
6. Close by clicking 'X'.
7. Open search by ctrl + F.
When the searchbox is open, the user could still interact with the terminal by clicking the terminal input area.
While I already have the search functionalities, currently there are still some known to-do works and I will keep updating my PR:
1. Optimize the search box UI, this includes:
1) Theme adaptation. The search box background and font color
should change according to the theme,
2) Add background. Currently the elements in search box are all
transparent. However, we need a background.
3) Move button should be highlighted once clicked.
2. Accessibility: search process should be able to performed without mouse. Once the search box is focused, the user should be able to navigate between all interactive elements on the searchbox using keyboard.
<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
To test:
1. checkout this branch.
2. Build the project.
3. Start Windows Terminal and press Ctrl+F
4. The search box should appear on the top right corner.
2019-12-17 16:52:37 +01:00
|
|
|
int ViewStartIndex() const noexcept;
|
|
|
|
|
int ViewEndIndex() const noexcept;
|
|
|
|
|
|
2019-06-11 22:27:09 +02:00
|
|
|
#pragma region ITerminalApi
|
2019-05-03 00:29:04 +02:00
|
|
|
// These methods are defined in TerminalApi.cpp
|
2020-01-03 19:44:27 +01:00
|
|
|
bool PrintString(std::wstring_view stringView) noexcept override;
|
|
|
|
|
bool ExecuteChar(wchar_t wch) noexcept override;
|
Refactor TerminalDispatch (graphics) to match AdaptDispatch (#6728)
This is essentially a rewrite of the
`TerminalDispatch::SetGraphicsRendition` method, bringing it into closer
alignment with the `AdaptDispatch` implementation, simplifying the
`ITerminalApi` interface, and making the code easier to extend. It adds
support for a number of attributes which weren't previously implemented.
REFERENCES
* This is a mirror of the `AdaptDispatch` refactoring in PR #5758.
* The closer alignment with `AdaptDispatch` is a small step towards
solving issue #3849.
* The newly supported attributes should help a little with issues #5461
(italics) and #6205 (strike-through).
DETAILS
I've literally copied and pasted the `SetGraphicsRendition`
implementation from `AdaptDispatch` into `TerminalDispatch`, with only
few minor changes:
* The `SetTextAttribute` and `GetTextAttribute` calls are slightly
different in the `TerminalDispatch` version, since they don't return a
pointless `success` value, and in the case of the getter, the
`TextAttribute` is returned directly instead of by reference.
Ultimately I'd like to move the `AdaptDispatch` code towards that way
of doing things too, but I'd like to deal with that later as part of a
wider refactoring of the `ConGetSet` interface.
* The `SetIndexedForeground256` and `SetIndexedBackground256` calls
required the color indices to be remapped in the `AdaptDispatch`
implementation, because the conhost color table is in a different
order to the XTerm standard. `TerminalDispatch` doesn't have that
problem, so doesn't require the mapping.
* The index color constants used in the 16-color `SetIndexedForeground`
and `SetIndexedBackground` calls are also slightly different for the
same reason.
VALIDATION
I cherry-picked this code on top of the #6506 and #6698 PRs, since
that's only way to really get the different color formats passed-through
to the terminal. I then ran a bunch of manual tests with various color
coverage scripts that I have, and confirmed that all the different color
formats were being rendered as expected.
Closes #6725
2020-07-01 20:13:42 +02:00
|
|
|
TextAttribute GetTextAttributes() const noexcept override;
|
|
|
|
|
void SetTextAttributes(const TextAttribute& attrs) noexcept override;
|
2020-01-03 19:44:27 +01:00
|
|
|
bool SetCursorPosition(short x, short y) noexcept override;
|
|
|
|
|
COORD GetCursorPosition() noexcept override;
|
2020-03-13 18:39:42 +01:00
|
|
|
bool SetCursorVisibility(const bool visible) noexcept override;
|
|
|
|
|
bool EnableCursorBlinking(const bool enable) noexcept override;
|
Remove unneeded VT-specific control character handling (#4289)
## Summary of the Pull Request
This PR removes all of the VT-specific functionality from the `WriteCharsLegacy` function that dealt with control characters, since those controls are now handled in the state machine when in VT mode. It also removes most of the control character handling from the `Terminal::_WriteBuffer` method for the same reason.
## References
This is a followup to PR #4171
## PR Checklist
* [x] Closes #3971
* [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Requires documentation to be updated
* [x] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: https://github.com/microsoft/terminal/issues/780#issuecomment-570287435
## Detailed Description of the Pull Request / Additional comments
There are four changes to the `WriteCharsLegacy` implementation:
1. The `TAB` character had special case handling in VT mode which is now no longer required. This fixes a bug in the Python REPL editor (when run from a cmd shell in Windows Terminal), which would prevent you tabbing past the end of the line. It also fixes #3971.
2. Following on from point 1, the `WC_NONDESTRUCTIVE_TAB` flag could also now be removed. It only ever applied in VT mode, in which case the `TAB` character isn't handled in `WriteCharsLegacy`, so there isn't a need for a non-destructive version.
3. There used to be special case handling for a `BS` character at the beginning of the line when in VT mode, and that is also no longer required. This fixes an edge-case bug which would prevent a glyph being output for code point 8 when `ENABLE_PROCESSED_OUTPUT` was disabled.
4. There was quite a lot of special case handling for control characters in the "end-of-line wrap" implementation, which is no longer required. This fixes a bug which would prevent "low ASCII" characters from wrapping when output at the end of a line.
Then in the `Terminal::_WriteBuffer` implementation, I've simply removed all control character handling, except for `LF`. The Terminal is always in VT mode, so the control characters are always handled by the state machine. The exception for the `LF` character is simply because it doesn't have a proper implementation yet, so it still passes the character through to `_WriteBuffer`. That will get cleaned up eventually, but I thought that could wait for a later PR.
Finally, with the removal of the VT mode handling in `WriteCharsLegacy`, there was no longer a need for the `SCREEN_INFORMATION::InVTMode` method to be publicly accessible. That has now been made private.
## Validation Steps Performed
I've only tested manually, making sure the conhost and Windows Terminal still basically work, and confirming that the above-mentioned bugs are fixed by these changes.
2020-01-29 20:18:46 +01:00
|
|
|
bool CursorLineFeed(const bool withReturn) noexcept override;
|
2020-01-03 19:44:27 +01:00
|
|
|
bool DeleteCharacter(const size_t count) noexcept override;
|
|
|
|
|
bool InsertCharacter(const size_t count) noexcept override;
|
|
|
|
|
bool EraseCharacters(const size_t numChars) noexcept override;
|
|
|
|
|
bool EraseInLine(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::EraseType eraseType) noexcept override;
|
|
|
|
|
bool EraseInDisplay(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::EraseType eraseType) noexcept override;
|
2020-10-01 03:00:06 +02:00
|
|
|
bool WarningBell() noexcept override;
|
2020-01-03 19:44:27 +01:00
|
|
|
bool SetWindowTitle(std::wstring_view title) noexcept override;
|
|
|
|
|
bool SetColorTableEntry(const size_t tableIndex, const COLORREF color) noexcept override;
|
|
|
|
|
bool SetCursorStyle(const ::Microsoft::Console::VirtualTerminal::DispatchTypes::CursorStyle cursorStyle) noexcept override;
|
2020-07-31 00:24:59 +02:00
|
|
|
bool SetCursorColor(const COLORREF color) noexcept override;
|
2020-01-03 19:44:27 +01:00
|
|
|
bool SetDefaultForeground(const COLORREF color) noexcept override;
|
|
|
|
|
bool SetDefaultBackground(const COLORREF color) noexcept override;
|
2020-03-13 01:44:28 +01:00
|
|
|
|
2020-06-09 00:31:28 +02:00
|
|
|
bool EnableWin32InputMode(const bool win32InputMode) noexcept override;
|
2020-03-13 01:44:28 +01:00
|
|
|
bool SetCursorKeysMode(const bool applicationMode) noexcept override;
|
|
|
|
|
bool SetKeypadMode(const bool applicationMode) noexcept override;
|
2020-07-09 13:25:30 +02:00
|
|
|
bool SetScreenMode(const bool reverseMode) noexcept override;
|
2020-03-13 01:44:28 +01:00
|
|
|
bool EnableVT200MouseMode(const bool enabled) noexcept override;
|
|
|
|
|
bool EnableUTF8ExtendedMouseMode(const bool enabled) noexcept override;
|
|
|
|
|
bool EnableSGRExtendedMouseMode(const bool enabled) noexcept override;
|
|
|
|
|
bool EnableButtonEventMouseMode(const bool enabled) noexcept override;
|
|
|
|
|
bool EnableAnyEventMouseMode(const bool enabled) noexcept override;
|
|
|
|
|
bool EnableAlternateScrollMode(const bool enabled) noexcept override;
|
|
|
|
|
|
|
|
|
|
bool IsVtInputEnabled() const noexcept override;
|
2020-06-30 03:55:40 +02:00
|
|
|
|
|
|
|
|
bool CopyToClipboard(std::wstring_view content) noexcept override;
|
2020-09-03 19:52:39 +02:00
|
|
|
|
|
|
|
|
bool AddHyperlink(std::wstring_view uri, std::wstring_view params) noexcept override;
|
|
|
|
|
bool EndHyperlink() noexcept override;
|
2019-06-11 22:27:09 +02:00
|
|
|
#pragma endregion
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2019-06-11 22:27:09 +02:00
|
|
|
#pragma region ITerminalInput
|
2019-05-03 00:29:04 +02:00
|
|
|
// These methods are defined in Terminal.cpp
|
2020-06-09 00:31:28 +02:00
|
|
|
bool SendKeyEvent(const WORD vkey, const WORD scanCode, const Microsoft::Terminal::Core::ControlKeyStates states, const bool keyDown) override;
|
2020-08-08 01:21:09 +02:00
|
|
|
bool SendMouseEvent(const COORD viewportPos, const unsigned int uiButton, const ControlKeyStates states, const short wheelDelta, const Microsoft::Console::VirtualTerminal::TerminalInput::MouseButtonState state) override;
|
2020-04-07 21:09:28 +02:00
|
|
|
bool SendCharEvent(const wchar_t ch, const WORD scanCode, const ControlKeyStates states) override;
|
2019-10-11 23:02:09 +02:00
|
|
|
|
2019-06-11 22:27:09 +02:00
|
|
|
[[nodiscard]] HRESULT UserResize(const COORD viewportSize) noexcept override;
|
2019-05-03 00:29:04 +02:00
|
|
|
void UserScrollViewport(const int viewTop) override;
|
2020-01-03 19:44:27 +01:00
|
|
|
int GetScrollOffset() noexcept override;
|
2019-11-13 03:12:43 +01:00
|
|
|
|
|
|
|
|
void TrySnapOnInput() override;
|
2020-03-13 01:44:28 +01:00
|
|
|
bool IsTrackingMouseInput() const noexcept;
|
2020-09-03 19:52:39 +02:00
|
|
|
|
|
|
|
|
std::wstring GetHyperlinkAtPosition(const COORD position);
|
2020-09-10 23:59:56 +02:00
|
|
|
uint16_t GetHyperlinkIdAtPosition(const COORD position);
|
2020-10-28 21:24:43 +01:00
|
|
|
std::optional<interval_tree::IntervalTree<til::point, size_t>::interval> GetHyperlinkIntervalFromPosition(const COORD position);
|
2019-06-11 22:27:09 +02:00
|
|
|
#pragma endregion
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2019-08-19 20:03:45 +02:00
|
|
|
#pragma region IBaseData(base to IRenderData and IUiaData)
|
2019-05-03 00:29:04 +02:00
|
|
|
Microsoft::Console::Types::Viewport GetViewport() noexcept override;
|
Search - add search box control and implement search experience (#3590)
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
This is the PR for feature Search: #605
This PR includes the newly introduced SearchBoxControl in TermControl dir, which is the search bar for the search experience. And the codes that enable Search in Windows Terminal.
<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? -->
The PR that migrates the Conhost search module: https://github.com/microsoft/terminal/pull/3279
Spec (still actively updating): https://github.com/microsoft/terminal/pull/3299
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
* [x] Closes #605
* [ ] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Requires documentation to be updated
* [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx
<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
These functionalities are included in the search experience.
1. Search in Terminal text buffer.
2. Automatic wrap-around.
3. Search up or down switch by clicking different buttons.
4. Search case sensitively/insensitively by clicking a button. S. Move the search box to the top/bottom by clicking a button.
6. Close by clicking 'X'.
7. Open search by ctrl + F.
When the searchbox is open, the user could still interact with the terminal by clicking the terminal input area.
While I already have the search functionalities, currently there are still some known to-do works and I will keep updating my PR:
1. Optimize the search box UI, this includes:
1) Theme adaptation. The search box background and font color
should change according to the theme,
2) Add background. Currently the elements in search box are all
transparent. However, we need a background.
3) Move button should be highlighted once clicked.
2. Accessibility: search process should be able to performed without mouse. Once the search box is focused, the user should be able to navigate between all interactive elements on the searchbox using keyboard.
<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
To test:
1. checkout this branch.
2. Build the project.
3. Start Windows Terminal and press Ctrl+F
4. The search box should appear on the top right corner.
2019-12-17 16:52:37 +01:00
|
|
|
COORD GetTextBufferEndPosition() const noexcept override;
|
2019-05-03 00:29:04 +02:00
|
|
|
const TextBuffer& GetTextBuffer() noexcept override;
|
|
|
|
|
const FontInfo& GetFontInfo() noexcept override;
|
2019-08-19 20:03:45 +02:00
|
|
|
|
|
|
|
|
void LockConsole() noexcept override;
|
|
|
|
|
void UnlockConsole() noexcept override;
|
|
|
|
|
#pragma endregion
|
|
|
|
|
|
|
|
|
|
#pragma region IRenderData
|
|
|
|
|
// These methods are defined in TerminalRenderData.cpp
|
2019-05-03 00:29:04 +02:00
|
|
|
const TextAttribute GetDefaultBrushColors() noexcept override;
|
Refactor the renderer color calculations (#6853)
This is a refactoring of the renderer color calculations to simplify the
implementation, and to make it easier to support additional
color-altering rendition attributes in the future (e.g. _faint_ and
_conceal_).
## References
* This is a followup to PRs #3817 and #6809, which introduced additional
complexity in the color calculations, and which suggested the need for
refactoring.
## Detailed Description of the Pull Request / Additional comments
When we added support for `DECSCNM`, that required the foreground and
background color lookup methods to be able to return the opposite of
what was requested when the reversed mode was set. That made those
methods unnecessarily complicated, and I thought we could simplify them
considerably just by combining the calculations into a single method
that derived both colors at the same time.
And since both conhost and Windows Terminal needed to perform the same
calculations, it also made sense to move that functionality into the
`TextAttribute` class, where it could easily be shared.
In general this way of doing things is a bit more efficient. However, it
does result in some unnecessary work when only one of the colors is
required, as is the case for the gridline painter. So to make that less
of an issue, I've reordered the gridline code a bit so it at least
avoids looking up the colors when no gridlines are needed.
## Validation Steps Performed
Because of the API changes, quite a lot of the unit tests had to be
updated. For example instead of verifying colors with two separate calls
to `LookupForegroundColor` and `LookupBackgroundColor`, that's now
achieved with a single `LookupAttributeColors` call, comparing against a
pair of values. The specifics of the tests haven't changed though, and
they're all still working as expected.
I've also manually confirmed that the various color sequences and
rendition attributes are rendering correctly with the new refactoring.
2020-07-11 00:26:34 +02:00
|
|
|
std::pair<COLORREF, COLORREF> GetAttributeColors(const TextAttribute& attr) const noexcept override;
|
2019-05-03 00:29:04 +02:00
|
|
|
COORD GetCursorPosition() const noexcept override;
|
|
|
|
|
bool IsCursorVisible() const noexcept override;
|
|
|
|
|
bool IsCursorOn() const noexcept override;
|
|
|
|
|
ULONG GetCursorHeight() const noexcept override;
|
|
|
|
|
ULONG GetCursorPixelWidth() const noexcept override;
|
|
|
|
|
CursorType GetCursorStyle() const noexcept override;
|
|
|
|
|
COLORREF GetCursorColor() const noexcept override;
|
Show a double width cursor for double width characters (#5319)
# Summary of the Pull Request
This PR will allow the cursor to be double width when on top of a double width character. This required changing `IsCursorDoubleWidth` to check whether the glyph the cursor's on top of is double width. This code is exactly the same as the original PR that addressed this issue in #2932. That one got reverted at some point due to the crashes related to it, but due to a combination of Terminal having come further since that PR and other changes to address use-after-frees, some of the crashes may/may not be relevant now. The ones that seemed to be relevant/repro-able, I attempt to address in this PR.
The `IsCursorDoubleWidth` check would fail during the `TextBuffer::Reflow` call inside of `Terminal::UserResize` occasionally, particularly when `newCursor.EndDeferDrawing()` is called. This is because when we tell the newCursor to `EndDefer`, the renderer will attempt to redraw the cursor. As part of this redraw, it'll ask if `IsCursorDoubleWidth`, and if the renderer managed to ask this before `UserResize` swapped out the old buffer with the new one from `Reflow`, the renderer will be asking the old buffer if its out-of-bounds cursor is double width. This was pretty easily repro'd using `cmatrix -u0` and resizing the window like a madman.
As a solution, I've moved the Start/End DeferDrawing calls out of `Reflow` and into `UserResize`. This way, I can "clamp" the portion of the code where the newBuffer is getting created and reflowed and swapped into the Terminal buffer, and only allow the renderer to draw once the swap is done. This also means that ConHost's `ResizeWithReflow` needed to change slightly.
In addition, I've added a WriteLock to `SetCursorOn`. It was mentioned as a fix for a crash in #2965 (although I can't repro), and I also figured it would be good to try to emulate where ConHost locks with regards to Cursor operations, and this seemed to be one that we were missing.
## PR Checklist
* [x] Closes #2713
* [x] CLA signed
* [x] Tests added/passed
## Validation Steps Performed
Manual validation that the cursor is indeed chonky, added a test case to check that we are correctly saying that the cursor is double width (not too sure if I put it in the right place). Also open to other test case ideas and thoughts on what else I should be careful for since I am quite nervous about what other crashes might occur.
2020-04-15 21:23:06 +02:00
|
|
|
bool IsCursorDoubleWidth() const override;
|
2020-03-13 01:54:43 +01:00
|
|
|
bool IsScreenReversed() const noexcept override;
|
2019-05-03 00:29:04 +02:00
|
|
|
const std::vector<Microsoft::Console::Render::RenderOverlay> GetOverlays() const noexcept override;
|
|
|
|
|
const bool IsGridLineDrawingAllowed() noexcept override;
|
2020-09-03 19:52:39 +02:00
|
|
|
const std::wstring GetHyperlinkUri(uint16_t id) const noexcept override;
|
|
|
|
|
const std::wstring GetHyperlinkCustomId(uint16_t id) const noexcept override;
|
2020-10-28 21:24:43 +01:00
|
|
|
const std::vector<size_t> GetPatternId(const COORD location) const noexcept override;
|
2019-08-19 20:03:45 +02:00
|
|
|
#pragma endregion
|
|
|
|
|
|
|
|
|
|
#pragma region IUiaData
|
2019-05-03 00:29:04 +02:00
|
|
|
std::vector<Microsoft::Console::Types::Viewport> GetSelectionRects() noexcept override;
|
2020-01-03 19:44:27 +01:00
|
|
|
const bool IsSelectionActive() const noexcept override;
|
2020-03-18 22:03:51 +01:00
|
|
|
const bool IsBlockSelection() const noexcept override;
|
Accessibility: Set-up UIA Tree (#1691)
**The Basics of Accessibility**
- [What is a User Interaction Automation (UIA) Tree?](https://docs.microsoft.com/en-us/dotnet/framework/ui-automation/ui-automation-tree-overview)
- Other projects (i.e.: Narrator) can take advantage of this UIA tree and are used to present information within it.
- Some things like XAML already have a UIA Tree. So some UIA tree navigation and features are already there. It's just a matter of getting them hooked up and looking right.
**Accessibility in our Project**
There's a few important classes...
regarding Accessibility...
- **WindowUiaProvider**: This sets up the UIA tree for a window. So this is the top-level for the UIA tree.
- **ScreenInfoUiaProvider**: This sets up the UIA tree for a terminal buffer.
- **UiaTextRange**: This is essential to interacting with the UIA tree for the terminal buffer. Actually gets portions of the buffer and presents them.
regarding the Windows Terminal window...
- **BaseWindow**: The foundation to a window. Deals with HWNDs and that kind of stuff.
- **IslandWindow**: This extends `BaseWindow` and is actually what holds our Windows Terminal
- **NonClientIslandWindow**: An extension of the `IslandWindow`
regarding ConHost...
- **IConsoleWindow**: This is an interface for the console window.
- **Window**: This is the actual window for ConHost. Extends `IConsoleWindow`
- `IConsoleWindow` changes:
- move into `Microsoft::Console::Types` (a shared space)
- Have `IslandWindow` extend it
- `WindowUiaProvider` changes:
- move into `Microsoft::Console::Types` (a shared space)
- Hook up `WindowUiaProvider` to IslandWindow (yay! we now have a tree)
### Changes to the WindowUiaProvider
As mentioned earlier, the WindowUiaProvider is the top-level UIA provider for our projects. To reuse as much code as possible, I created `Microsoft::Console::Types::WindowUiaProviderBase`. Any existing functions that reference a `ScreenInfoUiaProvider` were virtual-ized.
In each project, a `WindowUiaProvider : WindowUiaProviderBase` was created to define those virtual functions. Note that that will be the main difference between ConHost and Windows Terminal moving forward: how many TextBuffers are on the screen.
So, ConHost should be the same as before, with only one `ScreenInfoUiaProvider`, whereas Windows Terminal needs to (1) update which one is on the screen and (2) may have multiple on the screen.
🚨 Windows Terminal doesn't have the `ScreenInfoUiaProvider` hooked up yet. We'll have all the XAML elements in the UIA tree. But, since `TermControl` is a custom XAML Control, I need to hook up the `ScreenInfoUiaProvider` to it. This work will be done in a new PR and resolve GitHub Issue #1352.
### Moved to `Microsoft::Console::Types`
These files got moved to a shared area so that they can be used by both ConHost and Windows Terminal.
This means that any references to the `ServiceLocator` had to be removed.
- `IConsoleWindow`
- Windows Terminal: `IslandWindow : IConsoleWindow`
- `ScreenInfoUiaProvider`
- all references to `ServiceLocator` and `SCREEN_INFORMATION` were removed. `IRenderData` was used to accomplish this. Refer to next section for more details.
- `UiaTextRange`
- all references to `ServiceLocator` and `SCREEN_INFORMATION` were removed. `IRenderData` was used to accomplish this. Refer to next section for more details.
- since most of the functions were `static`, that means that an `IRenderData` had to be added into most of them.
### Changes to IRenderData
Since `IRenderData` is now being used to abstract out `ServiceLocator` and `SCREEN_INFORMATION`, I had to add a few functions here:
- `bool IsAreaSelected()`
- `void ClearSelection()`
- `void SelectNewRegion(...)`
- `HRESULT SearchForText(...)`
`SearchForText()` is a problem here. The overall new design is great! But Windows Terminal doesn't have a way to search for text in the buffer yet, whereas ConHost does. So I'm punting on this issue for now. It looks nasty, but just look at all the other pretty things here. :)
2019-07-30 00:21:15 +02:00
|
|
|
void ClearSelection() override;
|
|
|
|
|
void SelectNewRegion(const COORD coordStart, const COORD coordEnd) override;
|
2020-02-21 00:03:50 +01:00
|
|
|
const COORD GetSelectionAnchor() const noexcept override;
|
2020-02-28 01:42:26 +01:00
|
|
|
const COORD GetSelectionEnd() const noexcept override;
|
2019-05-03 00:29:04 +02:00
|
|
|
const std::wstring GetConsoleTitle() const noexcept override;
|
2019-11-14 23:36:41 +01:00
|
|
|
void ColorSelection(const COORD coordSelectionStart, const COORD coordSelectionEnd, const TextAttribute) override;
|
2019-06-11 22:27:09 +02:00
|
|
|
#pragma endregion
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
void SetWriteInputCallback(std::function<void(std::wstring&)> pfn) noexcept;
|
2020-10-01 03:00:06 +02:00
|
|
|
void SetWarningBellCallback(std::function<void()> pfn) noexcept;
|
2019-05-03 00:29:04 +02:00
|
|
|
void SetTitleChangedCallback(std::function<void(const std::wstring_view&)> pfn) noexcept;
|
2020-08-08 01:07:42 +02:00
|
|
|
void SetTabColorChangedCallback(std::function<void(const std::optional<til::color>)> pfn) noexcept;
|
2020-06-30 03:55:40 +02:00
|
|
|
void SetCopyToClipboardCallback(std::function<void(const std::wstring_view&)> pfn) noexcept;
|
2019-05-03 00:29:04 +02:00
|
|
|
void SetScrollPositionChangedCallback(std::function<void(const int, const int, const int)> pfn) noexcept;
|
2020-03-31 01:21:47 +02:00
|
|
|
void SetCursorPositionChangedCallback(std::function<void()> pfn) noexcept;
|
2020-05-16 00:43:00 +02:00
|
|
|
void SetBackgroundCallback(std::function<void(const COLORREF)> pfn) noexcept;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
Show a double width cursor for double width characters (#5319)
# Summary of the Pull Request
This PR will allow the cursor to be double width when on top of a double width character. This required changing `IsCursorDoubleWidth` to check whether the glyph the cursor's on top of is double width. This code is exactly the same as the original PR that addressed this issue in #2932. That one got reverted at some point due to the crashes related to it, but due to a combination of Terminal having come further since that PR and other changes to address use-after-frees, some of the crashes may/may not be relevant now. The ones that seemed to be relevant/repro-able, I attempt to address in this PR.
The `IsCursorDoubleWidth` check would fail during the `TextBuffer::Reflow` call inside of `Terminal::UserResize` occasionally, particularly when `newCursor.EndDeferDrawing()` is called. This is because when we tell the newCursor to `EndDefer`, the renderer will attempt to redraw the cursor. As part of this redraw, it'll ask if `IsCursorDoubleWidth`, and if the renderer managed to ask this before `UserResize` swapped out the old buffer with the new one from `Reflow`, the renderer will be asking the old buffer if its out-of-bounds cursor is double width. This was pretty easily repro'd using `cmatrix -u0` and resizing the window like a madman.
As a solution, I've moved the Start/End DeferDrawing calls out of `Reflow` and into `UserResize`. This way, I can "clamp" the portion of the code where the newBuffer is getting created and reflowed and swapped into the Terminal buffer, and only allow the renderer to draw once the swap is done. This also means that ConHost's `ResizeWithReflow` needed to change slightly.
In addition, I've added a WriteLock to `SetCursorOn`. It was mentioned as a fix for a crash in #2965 (although I can't repro), and I also figured it would be good to try to emulate where ConHost locks with regards to Cursor operations, and this seemed to be one that we were missing.
## PR Checklist
* [x] Closes #2713
* [x] CLA signed
* [x] Tests added/passed
## Validation Steps Performed
Manual validation that the cursor is indeed chonky, added a test case to check that we are correctly saying that the cursor is double width (not too sure if I put it in the right place). Also open to other test case ideas and thoughts on what else I should be careful for since I am quite nervous about what other crashes might occur.
2020-04-15 21:23:06 +02:00
|
|
|
void SetCursorOn(const bool isOn);
|
2019-05-23 19:44:27 +02:00
|
|
|
bool IsCursorBlinkingAllowed() const noexcept;
|
2019-05-14 03:25:54 +02:00
|
|
|
|
2020-10-28 21:24:43 +01:00
|
|
|
void UpdatePatterns() noexcept;
|
|
|
|
|
void ClearPatternTree() noexcept;
|
|
|
|
|
|
2020-08-08 01:07:42 +02:00
|
|
|
const std::optional<til::color> GetTabColor() const noexcept;
|
|
|
|
|
|
Add support for the "blink" graphic rendition attribute (#7490)
This PR adds support for the _blink_ graphic rendition attribute. When a
character is output with this attribute set, it "blinks" at a regular
interval, by cycling its color between the normal rendition and a dimmer
shade of that color.
The majority of the blinking mechanism is encapsulated in a new
`BlinkingState` class, which is shared between the Terminal and Conhost
implementations. This class keeps track of the position in the blinking
cycle, which determines whether characters are rendered as normal or
faint.
In Windows Terminal, the state is stored in the `Terminal` class, and in
Conhost it's stored in the `CONSOLE_INFORMATION` class. In both cases,
the `IsBlinkingFaint` method is used to determine the current blinking
rendition, and that is passed on as a parameter to the
`TextAttribute::CalculateRgbColors` method when these classes are
looking up attribute colors.
Prior to calculating the colors, the current attribute is also passed to
the `RecordBlinkingUsage` method, which keeps track of whether there are
actually any blink attributes in use. This is used to determine whether
the screen needs to be refreshed when the blinking cycle toggles between
the normal and faint renditions.
The refresh itself is handled by the `ToggleBlinkingRendition` method,
which is triggered by a timer. In Conhost this is just piggybacking on
the existing cursor blink timer, but in Windows Terminal it needs to
have its own separate timer, since the cursor timer is reset whenever a
key is pressed, which is not something we want for attribute blinking.
Although the `ToggleBlinkingRendition` is called at the same rate as the
cursor blinking, we actually only want the cells to blink at half that
frequency. We thus have a counter that cycles through four phases, and
blinking is rendered as faint for two of those four. Then every two
cycles - when the state changes - a redraw is triggered, but only if
there are actually blinking attributes in use (as previously recorded).
As mentioned earlier, the blinking frequency is based on the cursor
blink rate, so that means it'll automatically be disabled if a user has
set their cursor blink rate to none. It can also be disabled by turning
off the _Show animations in Windows_ option. In Conhost these settings
take effect immediately, but in Windows Terminal they only apply when a
new tab is opened.
This PR also adds partial support for the `SGR 6` _rapid blink_
attribute. This is not used by DEC terminals, but was defined in the
ECMA/ANSI standards. It's not widely supported, but many terminals just
it implement it as an alias for the regular `SGR 5` blink attribute, so
that's what I've done here too.
## Validation Steps Performed
I've checked the _Graphic rendition test pattern_ in Vttest, and
compared our representation of the blink attribute to that of an actual
DEC VT220 terminal as seen on [YouTube]. With the right color scheme
it's a reasonably close match.
[YouTube]: https://www.youtube.com/watch?v=03Pz5AmxbE4&t=1m55s
Closes #7388
2020-09-22 01:21:33 +02:00
|
|
|
Microsoft::Console::Render::BlinkingState& GetBlinkingState() const noexcept;
|
|
|
|
|
|
2019-06-11 22:27:09 +02:00
|
|
|
#pragma region TextSelection
|
2019-06-19 00:53:29 +02:00
|
|
|
// These methods are defined in TerminalSelection.cpp
|
2020-02-28 01:42:26 +01:00
|
|
|
enum class SelectionExpansionMode
|
|
|
|
|
{
|
|
|
|
|
Cell,
|
|
|
|
|
Word,
|
|
|
|
|
Line
|
|
|
|
|
};
|
|
|
|
|
void MultiClickSelection(const COORD viewportPos, SelectionExpansionMode expansionMode);
|
2019-05-03 00:29:04 +02:00
|
|
|
void SetSelectionAnchor(const COORD position);
|
2020-02-28 01:42:26 +01:00
|
|
|
void SetSelectionEnd(const COORD position, std::optional<SelectionExpansionMode> newExpansionMode = std::nullopt);
|
|
|
|
|
void SetBlockSelection(const bool isEnabled) noexcept;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2019-08-20 00:59:01 +02:00
|
|
|
const TextBuffer::TextAndColor RetrieveSelectedTextFromBuffer(bool trimTrailingWhitespace) const;
|
2019-06-11 22:27:09 +02:00
|
|
|
#pragma endregion
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2019-06-11 22:27:09 +02:00
|
|
|
private:
|
2019-05-03 00:29:04 +02:00
|
|
|
std::function<void(std::wstring&)> _pfnWriteInput;
|
2020-10-01 03:00:06 +02:00
|
|
|
std::function<void()> _pfnWarningBell;
|
2019-05-03 00:29:04 +02:00
|
|
|
std::function<void(const std::wstring_view&)> _pfnTitleChanged;
|
2020-06-30 03:55:40 +02:00
|
|
|
std::function<void(const std::wstring_view&)> _pfnCopyToClipboard;
|
2019-05-03 00:29:04 +02:00
|
|
|
std::function<void(const int, const int, const int)> _pfnScrollPositionChanged;
|
2020-05-16 00:43:00 +02:00
|
|
|
std::function<void(const COLORREF)> _pfnBackgroundColorChanged;
|
2020-03-31 01:21:47 +02:00
|
|
|
std::function<void()> _pfnCursorPositionChanged;
|
2020-08-08 01:07:42 +02:00
|
|
|
std::function<void(const std::optional<til::color>)> _pfnTabColorChanged;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
std::unique_ptr<::Microsoft::Console::VirtualTerminal::StateMachine> _stateMachine;
|
|
|
|
|
std::unique_ptr<::Microsoft::Console::VirtualTerminal::TerminalInput> _terminalInput;
|
|
|
|
|
|
2020-06-09 23:47:13 +02:00
|
|
|
std::optional<std::wstring> _title;
|
2019-11-22 01:18:24 +01:00
|
|
|
std::wstring _startingTitle;
|
2020-08-08 01:07:42 +02:00
|
|
|
std::optional<til::color> _tabColor;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
std::array<COLORREF, XTERM_COLOR_TABLE_SIZE> _colorTable;
|
|
|
|
|
COLORREF _defaultFg;
|
|
|
|
|
COLORREF _defaultBg;
|
2020-09-04 22:36:09 +02:00
|
|
|
CursorType _defaultCursorShape;
|
2020-07-09 13:25:30 +02:00
|
|
|
bool _screenReversed;
|
Add support for the "blink" graphic rendition attribute (#7490)
This PR adds support for the _blink_ graphic rendition attribute. When a
character is output with this attribute set, it "blinks" at a regular
interval, by cycling its color between the normal rendition and a dimmer
shade of that color.
The majority of the blinking mechanism is encapsulated in a new
`BlinkingState` class, which is shared between the Terminal and Conhost
implementations. This class keeps track of the position in the blinking
cycle, which determines whether characters are rendered as normal or
faint.
In Windows Terminal, the state is stored in the `Terminal` class, and in
Conhost it's stored in the `CONSOLE_INFORMATION` class. In both cases,
the `IsBlinkingFaint` method is used to determine the current blinking
rendition, and that is passed on as a parameter to the
`TextAttribute::CalculateRgbColors` method when these classes are
looking up attribute colors.
Prior to calculating the colors, the current attribute is also passed to
the `RecordBlinkingUsage` method, which keeps track of whether there are
actually any blink attributes in use. This is used to determine whether
the screen needs to be refreshed when the blinking cycle toggles between
the normal and faint renditions.
The refresh itself is handled by the `ToggleBlinkingRendition` method,
which is triggered by a timer. In Conhost this is just piggybacking on
the existing cursor blink timer, but in Windows Terminal it needs to
have its own separate timer, since the cursor timer is reset whenever a
key is pressed, which is not something we want for attribute blinking.
Although the `ToggleBlinkingRendition` is called at the same rate as the
cursor blinking, we actually only want the cells to blink at half that
frequency. We thus have a counter that cycles through four phases, and
blinking is rendered as faint for two of those four. Then every two
cycles - when the state changes - a redraw is triggered, but only if
there are actually blinking attributes in use (as previously recorded).
As mentioned earlier, the blinking frequency is based on the cursor
blink rate, so that means it'll automatically be disabled if a user has
set their cursor blink rate to none. It can also be disabled by turning
off the _Show animations in Windows_ option. In Conhost these settings
take effect immediately, but in Windows Terminal they only apply when a
new tab is opened.
This PR also adds partial support for the `SGR 6` _rapid blink_
attribute. This is not used by DEC terminals, but was defined in the
ECMA/ANSI standards. It's not widely supported, but many terminals just
it implement it as an alias for the regular `SGR 5` blink attribute, so
that's what I've done here too.
## Validation Steps Performed
I've checked the _Graphic rendition test pattern_ in Vttest, and
compared our representation of the blink attribute to that of an actual
DEC VT220 terminal as seen on [YouTube]. With the right color scheme
it's a reasonably close match.
[YouTube]: https://www.youtube.com/watch?v=03Pz5AmxbE4&t=1m55s
Closes #7388
2020-09-22 01:21:33 +02:00
|
|
|
mutable Microsoft::Console::Render::BlinkingState _blinkingState;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
bool _snapOnInput;
|
2020-06-05 18:11:41 +02:00
|
|
|
bool _altGrAliasing;
|
2019-11-22 01:18:24 +01:00
|
|
|
bool _suppressApplicationTitle;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2020-10-28 21:24:43 +01:00
|
|
|
size_t _hyperlinkPatternId;
|
|
|
|
|
|
2019-08-15 01:41:43 +02:00
|
|
|
#pragma region Text Selection
|
2020-02-28 01:42:26 +01:00
|
|
|
// a selection is represented as a range between two COORDs (start and end)
|
|
|
|
|
// the pivot is the COORD that remains selected when you extend a selection in any direction
|
|
|
|
|
// this is particularly useful when a word selection is extended over its starting point
|
|
|
|
|
// see TerminalSelection.cpp for more information
|
|
|
|
|
struct SelectionAnchors
|
2019-08-15 01:41:43 +02:00
|
|
|
{
|
2020-02-28 01:42:26 +01:00
|
|
|
COORD start;
|
|
|
|
|
COORD end;
|
|
|
|
|
COORD pivot;
|
2019-08-15 01:41:43 +02:00
|
|
|
};
|
2020-02-28 01:42:26 +01:00
|
|
|
std::optional<SelectionAnchors> _selection;
|
|
|
|
|
bool _blockSelection;
|
2019-07-12 01:06:18 +02:00
|
|
|
std::wstring _wordDelimiters;
|
2019-08-15 01:41:43 +02:00
|
|
|
SelectionExpansionMode _multiClickSelectionMode;
|
|
|
|
|
#pragma endregion
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
std::shared_mutex _readWriteLock;
|
|
|
|
|
|
|
|
|
|
// TODO: These members are not shared by an alt-buffer. They should be
|
|
|
|
|
// encapsulated, such that a Terminal can have both a main and alt buffer.
|
|
|
|
|
std::unique_ptr<TextBuffer> _buffer;
|
|
|
|
|
Microsoft::Console::Types::Viewport _mutableViewport;
|
|
|
|
|
SHORT _scrollbackLines;
|
|
|
|
|
|
|
|
|
|
// _scrollOffset is the number of lines above the viewport that are currently visible
|
|
|
|
|
// If _scrollOffset is 0, then the visible region of the buffer is the viewport.
|
|
|
|
|
int _scrollOffset;
|
|
|
|
|
// TODO this might not be the value we want to store.
|
ci: run spell check in CI, fix remaining issues (#4799)
This commit introduces a github action to check our spelling and fixes
the following misspelled words so that we come up green.
It also renames TfEditSes to TfEditSession, because Ses is not a word.
currently, excerpt, fallthrough, identified, occurred, propagate,
provided, rendered, resetting, separate, succeeded, successfully,
terminal, transferred, adheres, breaks, combining, preceded,
architecture, populated, previous, setter, visible, window, within,
appxmanifest, hyphen, control, offset, powerpoint, suppress, parsing,
prioritized, aforementioned, check in, build, filling, indices, layout,
mapping, trying, scroll, terabyte, vetoes, viewport, whose
2020-03-25 19:02:53 +01:00
|
|
|
// We might want to store the height in the scrollback that's currently visible.
|
2019-05-03 00:29:04 +02:00
|
|
|
// Think on this some more.
|
|
|
|
|
// For example: While looking at the scrollback, we probably want the visible region to "stick"
|
|
|
|
|
// to the region they scrolled to. If that were the case, then every time we move _mutableViewport,
|
|
|
|
|
// we'd also need to update _offset.
|
|
|
|
|
// However, if we just stored it as a _visibleTop, then that point would remain fixed -
|
|
|
|
|
// Though if _visibleTop == _mutableViewport.Top, then we'd need to make sure to update
|
|
|
|
|
// _visibleTop as well.
|
|
|
|
|
// Additionally, maybe some people want to scroll into the history, then have that scroll out from
|
|
|
|
|
// underneath them, while others would prefer to anchor it in place.
|
2020-02-10 21:40:01 +01:00
|
|
|
// Either way, we should make this behavior controlled by a setting.
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2020-10-28 21:24:43 +01:00
|
|
|
interval_tree::IntervalTree<til::point, size_t> _patternIntervalTree;
|
|
|
|
|
void _InvalidatePatternTree(interval_tree::IntervalTree<til::point, size_t>& tree);
|
|
|
|
|
void _InvalidateFromCoords(const COORD start, const COORD end);
|
|
|
|
|
|
2020-04-07 21:09:28 +02:00
|
|
|
// Since virtual keys are non-zero, you assume that this field is empty/invalid if it is.
|
|
|
|
|
struct KeyEventCodes
|
|
|
|
|
{
|
|
|
|
|
WORD VirtualKey;
|
|
|
|
|
WORD ScanCode;
|
|
|
|
|
};
|
|
|
|
|
std::optional<KeyEventCodes> _lastKeyEventCodes;
|
|
|
|
|
|
2019-10-01 18:15:30 +02:00
|
|
|
static WORD _ScanCodeFromVirtualKey(const WORD vkey) noexcept;
|
2020-04-07 21:09:28 +02:00
|
|
|
static WORD _VirtualKeyFromScanCode(const WORD scanCode) noexcept;
|
|
|
|
|
static WORD _VirtualKeyFromCharacter(const wchar_t ch) noexcept;
|
2019-10-01 18:15:30 +02:00
|
|
|
static wchar_t _CharacterFromKeyEvent(const WORD vkey, const WORD scanCode, const ControlKeyStates states) noexcept;
|
|
|
|
|
|
2020-04-07 21:09:28 +02:00
|
|
|
void _StoreKeyEvent(const WORD vkey, const WORD scanCode);
|
|
|
|
|
WORD _TakeVirtualKeyFromLastKeyEvent(const WORD scanCode) noexcept;
|
|
|
|
|
|
2019-05-03 00:29:04 +02:00
|
|
|
int _VisibleStartIndex() const noexcept;
|
Search - add search box control and implement search experience (#3590)
<!-- Enter a brief description/summary of your PR here. What does it fix/what does it change/how was it tested (even manually, if necessary)? -->
This is the PR for feature Search: #605
This PR includes the newly introduced SearchBoxControl in TermControl dir, which is the search bar for the search experience. And the codes that enable Search in Windows Terminal.
<!-- Other than the issue solved, is this relevant to any other issues/existing PRs? -->
The PR that migrates the Conhost search module: https://github.com/microsoft/terminal/pull/3279
Spec (still actively updating): https://github.com/microsoft/terminal/pull/3299
<!-- Please review the items on the PR checklist before submitting-->
## PR Checklist
* [x] Closes #605
* [ ] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Requires documentation to be updated
* [ ] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #xxx
<!-- Provide a more detailed description of the PR, other things fixed or any additional comments/features here -->
These functionalities are included in the search experience.
1. Search in Terminal text buffer.
2. Automatic wrap-around.
3. Search up or down switch by clicking different buttons.
4. Search case sensitively/insensitively by clicking a button. S. Move the search box to the top/bottom by clicking a button.
6. Close by clicking 'X'.
7. Open search by ctrl + F.
When the searchbox is open, the user could still interact with the terminal by clicking the terminal input area.
While I already have the search functionalities, currently there are still some known to-do works and I will keep updating my PR:
1. Optimize the search box UI, this includes:
1) Theme adaptation. The search box background and font color
should change according to the theme,
2) Add background. Currently the elements in search box are all
transparent. However, we need a background.
3) Move button should be highlighted once clicked.
2. Accessibility: search process should be able to performed without mouse. Once the search box is focused, the user should be able to navigate between all interactive elements on the searchbox using keyboard.
<!-- Describe how you validated the behavior. Add automated tests wherever possible, but list manual validation steps taken as well -->
To test:
1. checkout this branch.
2. Build the project.
3. Start Windows Terminal and press Ctrl+F
4. The search box should appear on the top right corner.
2019-12-17 16:52:37 +01:00
|
|
|
int _VisibleEndIndex() const noexcept;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
|
|
|
|
Microsoft::Console::Types::Viewport _GetMutableViewport() const noexcept;
|
|
|
|
|
Microsoft::Console::Types::Viewport _GetVisibleViewport() const noexcept;
|
|
|
|
|
|
|
|
|
|
void _InitializeColorTable();
|
|
|
|
|
|
|
|
|
|
void _WriteBuffer(const std::wstring_view& stringView);
|
|
|
|
|
|
Remove unneeded VT-specific control character handling (#4289)
## Summary of the Pull Request
This PR removes all of the VT-specific functionality from the `WriteCharsLegacy` function that dealt with control characters, since those controls are now handled in the state machine when in VT mode. It also removes most of the control character handling from the `Terminal::_WriteBuffer` method for the same reason.
## References
This is a followup to PR #4171
## PR Checklist
* [x] Closes #3971
* [x] CLA signed. If not, go over [here](https://cla.opensource.microsoft.com/microsoft/Terminal) and sign the CLA
* [ ] Tests added/passed
* [ ] Requires documentation to be updated
* [x] I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: https://github.com/microsoft/terminal/issues/780#issuecomment-570287435
## Detailed Description of the Pull Request / Additional comments
There are four changes to the `WriteCharsLegacy` implementation:
1. The `TAB` character had special case handling in VT mode which is now no longer required. This fixes a bug in the Python REPL editor (when run from a cmd shell in Windows Terminal), which would prevent you tabbing past the end of the line. It also fixes #3971.
2. Following on from point 1, the `WC_NONDESTRUCTIVE_TAB` flag could also now be removed. It only ever applied in VT mode, in which case the `TAB` character isn't handled in `WriteCharsLegacy`, so there isn't a need for a non-destructive version.
3. There used to be special case handling for a `BS` character at the beginning of the line when in VT mode, and that is also no longer required. This fixes an edge-case bug which would prevent a glyph being output for code point 8 when `ENABLE_PROCESSED_OUTPUT` was disabled.
4. There was quite a lot of special case handling for control characters in the "end-of-line wrap" implementation, which is no longer required. This fixes a bug which would prevent "low ASCII" characters from wrapping when output at the end of a line.
Then in the `Terminal::_WriteBuffer` implementation, I've simply removed all control character handling, except for `LF`. The Terminal is always in VT mode, so the control characters are always handled by the state machine. The exception for the `LF` character is simply because it doesn't have a proper implementation yet, so it still passes the character through to `_WriteBuffer`. That will get cleaned up eventually, but I thought that could wait for a later PR.
Finally, with the removal of the VT mode handling in `WriteCharsLegacy`, there was no longer a need for the `SCREEN_INFORMATION::InVTMode` method to be publicly accessible. That has now been made private.
## Validation Steps Performed
I've only tested manually, making sure the conhost and Windows Terminal still basically work, and confirming that the above-mentioned bugs are fixed by these changes.
2020-01-29 20:18:46 +01:00
|
|
|
void _AdjustCursorPosition(const COORD proposedPosition);
|
|
|
|
|
|
2020-01-03 19:44:27 +01:00
|
|
|
void _NotifyScrollEvent() noexcept;
|
2019-05-03 00:29:04 +02:00
|
|
|
|
2020-03-31 01:21:47 +02:00
|
|
|
void _NotifyTerminalCursorPositionChanged() noexcept;
|
|
|
|
|
|
2019-06-19 00:53:29 +02:00
|
|
|
#pragma region TextSelection
|
|
|
|
|
// These methods are defined in TerminalSelection.cpp
|
2019-09-17 19:39:39 +02:00
|
|
|
std::vector<SMALL_RECT> _GetSelectionRects() const noexcept;
|
2020-06-25 02:47:13 +02:00
|
|
|
std::pair<COORD, COORD> _PivotSelection(const COORD targetPos, bool& targetStart) const;
|
2020-02-28 01:42:26 +01:00
|
|
|
std::pair<COORD, COORD> _ExpandSelectionAnchors(std::pair<COORD, COORD> anchors) const;
|
2019-09-17 19:39:39 +02:00
|
|
|
COORD _ConvertToBufferCell(const COORD viewportPos) const;
|
2019-06-19 00:53:29 +02:00
|
|
|
#pragma endregion
|
Create tests that roundtrip output through a conpty to a Terminal (#4213)
## Summary of the Pull Request
This PR adds two tests:
* First, I started by writing a test where I could write output to the console host and inspect what output came out of conpty. This is the `ConptyOutputTests` in the host unit tests.
* Then I got crazy and thought _"what if I could take that output and dump it straight into the `Terminal`"_? Hence, the `ConptyRoundtripTests` were born, into the TerminalCore unit tests.
## References
Done in pursuit of #4200, but I felt this warranted it's own atomic PR
## PR Checklist
* [x] Doesn't close anything on it's own.
* [x] I work here
* [x] you better believe this adds tests
* [n/a] Requires documentation to be updated
## Detailed Description of the Pull Request / Additional comments
From the comment in `ConptyRoundtripTests`:
> This test class creates an in-proc conpty host as well as a Terminal, to
> validate that strings written to the conpty create the same resopnse on the
> terminal end. Tests can be written that validate both the contents of the
> host buffer as well as the terminal buffer. Everytime that
> `renderer.PaintFrame()` is called, the tests will validate the expected
> output, and then flush the output of the VtEngine straight to th
Also, some other bits had to be updated:
* The renderer needed to be able to survive without a thread, so I hadded a simple check that it actually had a thread before calling `pThread->NotifyPaint`
* Bits in `CommonState` used `NTSTATUS_FROM_HRESULT` which did _not_ work outside the host project. Since the `NTSTATUS` didn't seem that important, I replaced that with a `HRESULT`
* `CommonState` likes to initialize the console to some _weird_ defaults. I added an optional param to let us just use the defaults.
2020-01-17 17:40:12 +01:00
|
|
|
|
|
|
|
|
#ifdef UNIT_TESTING
|
2020-01-29 17:33:06 +01:00
|
|
|
friend class TerminalCoreUnitTests::TerminalBufferTests;
|
2020-03-13 18:39:42 +01:00
|
|
|
friend class TerminalCoreUnitTests::TerminalApiTest;
|
2020-01-29 17:33:06 +01:00
|
|
|
friend class TerminalCoreUnitTests::ConptyRoundtripTests;
|
2020-06-12 21:51:37 +02:00
|
|
|
friend class TerminalCoreUnitTests::ScrollTest;
|
Create tests that roundtrip output through a conpty to a Terminal (#4213)
## Summary of the Pull Request
This PR adds two tests:
* First, I started by writing a test where I could write output to the console host and inspect what output came out of conpty. This is the `ConptyOutputTests` in the host unit tests.
* Then I got crazy and thought _"what if I could take that output and dump it straight into the `Terminal`"_? Hence, the `ConptyRoundtripTests` were born, into the TerminalCore unit tests.
## References
Done in pursuit of #4200, but I felt this warranted it's own atomic PR
## PR Checklist
* [x] Doesn't close anything on it's own.
* [x] I work here
* [x] you better believe this adds tests
* [n/a] Requires documentation to be updated
## Detailed Description of the Pull Request / Additional comments
From the comment in `ConptyRoundtripTests`:
> This test class creates an in-proc conpty host as well as a Terminal, to
> validate that strings written to the conpty create the same resopnse on the
> terminal end. Tests can be written that validate both the contents of the
> host buffer as well as the terminal buffer. Everytime that
> `renderer.PaintFrame()` is called, the tests will validate the expected
> output, and then flush the output of the VtEngine straight to th
Also, some other bits had to be updated:
* The renderer needed to be able to survive without a thread, so I hadded a simple check that it actually had a thread before calling `pThread->NotifyPaint`
* Bits in `CommonState` used `NTSTATUS_FROM_HRESULT` which did _not_ work outside the host project. Since the `NTSTATUS` didn't seem that important, I replaced that with a `HRESULT`
* `CommonState` likes to initialize the console to some _weird_ defaults. I added an optional param to let us just use the defaults.
2020-01-17 17:40:12 +01:00
|
|
|
#endif
|
2019-05-03 00:29:04 +02:00
|
|
|
};
|
