Add support for broadcasting to all panes in a tab #14393

zadjii-msft · 2022-11-15T15:53:17Z

Resurrection of #9222.
Spec draft in #9365.

Consensus from community feedback is that the whole of that spec is nice to have, but what REALLY matters is just broadcasting to all the panes in a tab. So, in the interest of best serving our community, I'm pushing this out as the initial implementation, before we figure out the rest of design. Regardless of how we choose to implement the rest of the features detailed in the spec, the UX for this part of the feature remains the same.

This PR adds a new action: toggleBroadcastInput. Performing this action starts broadcasting to all panes in this tab. Keystrokes in one pane will be sent to all panes in the tab.

An icon in the tab is used to indicate when this mode is active. Furthermore, the borders of all panes will be highlighted with SystemAccentColorDark2/SystemAccentColorLight2 (depending on the theme), to indicate they're also active.

Closes Support broadcast input? #2634.
- (we should lick a reserved thread for follow-ups)

Co-authored-by: Don-Vito [email protected]

…t-resurrections

src/cascadia/TerminalControl/ControlCore.cpp

src/cascadia/TerminalControl/TermControl.cpp

DHowett · 2022-11-15T20:21:56Z

src/cascadia/TerminalControl/TermControl.cpp

@@ -1190,6 +1203,21 @@ namespace winrt::Microsoft::Terminal::Control::implementation
        }
    }

+    bool TermControl::BroadcastKeyEvent(const WORD vkey,


Additionally, is there a way to converge this with IDirectKeyListener's manual key handler?

src/cascadia/TerminalControl/ControlCore.cpp

DHowett

Ideology discussion

src/cascadia/TerminalControl/ControlCore.cpp

…t-resurrections

src/cascadia/TerminalApp/AppActionHandlers.cpp

DHowett

Okay, now that I've nitted more naming concerns (with apologies; I just think that while we're doing this we might as well get it right...) I've got some deeper worries!

Does anything that inputs a whole string at once work? This includes...

IME
Clipboard
Drag/drop a filename

If I had to guess, the one most likely to cause folks trouble is the clipboard. Rarely am I going to key in a long command that I wanted to send to four servers. I'm almost certainly gonna paste it.

Also, what does mouse input do? Should it do something? I imagine clicking on things that are different sizes and locations will just suck... but what about using the scroll wheel?

I guess this is where the layering discussion comes up again. Bah.

src/cascadia/TerminalApp/App.xaml

src/cascadia/TerminalApp/Pane.cpp

src/cascadia/TerminalControl/ControlCore.cpp

src/cascadia/TerminalControl/TermControl.cpp

src/cascadia/TerminalControl/ControlCore.h

zadjii-msft · 2022-11-16T22:46:23Z

WIP, it's the EOD here

IME
- TermControl::_CompositionCompleted. That should be easy.
Clipboard
- TerminalPage::_PasteText this should be easy enough to check if broadcast is available and paste to all the controls.
Drag/drop a filename
- TermControl::_DragDropHandler calls to ControlCore::PasteText in a bunch of places. All these could just CharSent the whole string, which would broadcast it.
sendInput

zadjii-msft · 2023-07-05T17:55:59Z

Notes from Teams, abridged

so, the thing that it hinges on for me is
If you have two panes selected, and one is in DECKPAM and the other is in DECCKM or whatever... does one arrow key send two different things properly, or does it send the same thing to both panes?
so, the thing is
if we choose to send the same content on either side, I think that makes our lives easier... and talking with Leonard I am much more comfortable with the "TerminalControl raises an event when it sends text" solution
with one caveat
that event must not ever be raised from any layer unless someone is listening
the cool thing is, events can be checked for truthiness - we don't need to add a separate boolean to plumb down to ControlCore
Leonard talked me into this if i recall
if the answer is 1 ("they send different things") we need to bifurcate all event generation
which.. ugh

okay so
tldr: make sure we don't raise events unless there's a listener

yea... and we can kill the bifurcated "paste" and everything else handlers
and boil it down to the simple "all terminal input sent via Write gets reflected"
like your OG work IIRC

I have been working on reviving the wpf m.t.c.dll
and looking at the public API of TerminalControl
and it's sorta all over the place admittedly but
this feels less intrusive for the API than having to poke through all the different types of user input as event callers
you know?

as usual, you come up with the right solution to begin with and I say something dumb like "can it be totally different" before coming all the way back to a modified version of your original idea

…t-resurrections

src/cascadia/TerminalApp/TerminalTab.cpp

DHowett · 2023-07-13T20:37:48Z

src/cascadia/TerminalApp/TerminalTab.cpp

+
+                        control.KeySent(events.keySentToken);
+                        control.CharSent(events.charSentToken);
+                        control.StringSent(events.stringSentToken);


dumb question: do we properly revoke when you move pane to tab (!) or move tab to window (?)

Sure seem to

src/cascadia/TerminalApp/TerminalTab.cpp

DHowett · 2023-07-13T20:40:29Z

src/cascadia/TerminalApp/TerminalTab.cpp

@@ -620,7 +622,7 @@ namespace winrt::TerminalApp::implementation
                _nextPaneId++;
            }
        });
-
+        pane->EnableBroadcast(_tabStatus.IsInputBroadcastActive());


this is the scary for me - will a pane moved into a different tab continue broadcasting to the old tab? we don't do any event hookups or unhooks here.

Nope, works like a charm

Huh! Can you walk me through why it works?
As a reviewer I couldn't see the machinery that kept it safe. I'd rather know that we know the code is safe than that we tested and found the behavior safe 😄

Okay, I know this is gonna cause you physical pain to read:

TerminalPage::_HandleMovePane

TerminalPage::_MovePane

TerminalTab::DetachPane

Pane::DetachPane

this._DetachedHandlers -> handled in a lambda in TerminalTab::_AttachEventHandlersToPane

revokes all our per-pane event handlers

TerminalTab::_DetachEventHandlersFromControl

revokes per-control handlers (including these)

TerminalTab::AttachPane

reattaches them to the new tab.

src/cascadia/TerminalControl/TermControl.cpp

DHowett · 2023-07-13T20:43:07Z

src/cascadia/TerminalControl/TermControl.cpp

            }
        }
    }

+    void TermControl::_pasteTextWithBroadcast(const winrt::hstring& text)


This name really confused me - it actually ISN'T used in paste(!) but it made me double-take because we are manually broadcasting the paste event and the incoming text doesn't come back through here. Does it? Or, does it...

(Since I was re-requested for review) Does this have anything to do with pasting? It looks like it doesn't.

lhecker

I really don't like how the control flow goes from UI to TermControl, then back up into UI, then back down into TermControl. That seems kind of unnecessary tbh. 😅 Why can't it distribute the input across all TermControls from the get-go?
But since I'm wholly unqualified to say how I'd actually do it differently (maybe this is the only way to do it?), I can't see it as an actual fault in the PR either. ✅

src/cascadia/TerminalApp/Pane.cpp

src/cascadia/TerminalApp/TerminalPage.cpp

lhecker · 2023-07-17T12:18:53Z

src/cascadia/TerminalControl/TermControl.cpp

            }
        }
    }

+    void TermControl::_pasteTextWithBroadcast(const winrt::hstring& text)


FYI technically you can use winrt::param::hstring here for 0 copy string passing, but I've heard it's considered an internal API so we can't use it. 😟 (Or can we? Technically we are in control over our code... Oh well...)

DHowett · 2023-07-17T17:18:52Z

Why can't it distribute the input across all TermControls from the get-go?

Four words: XAML

DHowett

I trust you that it works for moving panes around, but I would love to know why. Approved with comments -- that "paste" thing still confuses me :)

…t-resurrections

zadjii-msft · 2023-08-07T15:32:08Z

leaving here for future me

## Summary of the Pull Request Resolves the following in #15812 > - [x] `toggleBroadcastInput` isn't in the default settings > - [x] The cursors forget to keep blinking if you focus each pane and then unfocus them > - [x] They don't stop blinking when you unbroadcast > - [x] Broadcast border doesn't appear when you make new panes, but they ARE broadcasted-to! ## References and Relevant Issues x-ref: * #2634 * #14393 ## Detailed Description of the Pull Request / Additional comments There was literally no logic in the original PR for starting the cursor blinking. It's entirely unknowable how that ever worked. This makes it all much more explicit. We're taking the hacky `DisplayCursorWhileBlurred` from #15363, and promoting that to the less-hacky `CursorVisibility`. Broadcast input mode can use that to force the cursor to be visible always. The last checkbox in that issue is harder, and I didn't want to further pollute this delta with the paste plumbing.

zadjii-msft added 4 commits November 7, 2022 16:28

This is a resurrection of #9222. This needs a lot of love, but it works

c1fb748

Merge remote-tracking branch 'origin/main' into dev/migrie/f/broadcas…

1651994

…t-resurrections

better borders

8862ed8

cleanup some bad names

d685c12

that's not the right font

e21b6bb

DHowett reviewed Nov 15, 2022

View reviewed changes

src/cascadia/TerminalControl/ControlCore.cpp Outdated Show resolved Hide resolved

DHowett reviewed Nov 15, 2022

View reviewed changes

src/cascadia/TerminalControl/TermControl.cpp Outdated Show resolved Hide resolved

DHowett reviewed Nov 15, 2022

View reviewed changes

src/cascadia/TerminalControl/ControlCore.cpp Outdated Show resolved Hide resolved

DHowett requested changes Nov 15, 2022

View reviewed changes

src/cascadia/TerminalControl/ControlCore.cpp Outdated Show resolved Hide resolved

ghost added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Nov 15, 2022

zadjii-msft added 4 commits November 16, 2022 07:25

Merge remote-tracking branch 'origin/main' into dev/migrie/f/broadcas…

8abe995

…t-resurrections

proof of concept, this is gonna be way easier

c1c002a

yea this is gonna work

e29dc40

this is far easier

0136994

DHowett reviewed Nov 16, 2022

View reviewed changes

src/cascadia/TerminalApp/AppActionHandlers.cpp Show resolved Hide resolved

better names

8d7c1ea

DHowett requested changes Nov 16, 2022

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Nov 16, 2022

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Nov 16, 2022

zadjii-msft added 3 commits November 17, 2022 11:42

other kinds of input

8a89d81

paste too

1813a42

this is why I don't use vs

521fdea

zadjii-msft assigned DHowett Nov 17, 2022

zadjii-msft added 2 commits July 5, 2023 14:55

I guess I half-assed that merge before I left for leave

7d2e6ad

as requested, only raise the event if broadcast is actually enabled

2fb183a

This comment has been minimized.

Sign in to view

zadjii-msft added 2 commits July 12, 2023 10:40

Merge remote-tracking branch 'origin/main' into dev/migrie/f/broadcas…

bea849a

…t-resurrections

spel

1a5852d

DHowett requested changes Jul 13, 2023

View reviewed changes

microsoft-github-policy-service bot added Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Jul 13, 2023

fix an edge case of adding a new pane to a broadcasting tab

3cdb3db

lhecker approved these changes Jul 17, 2023

View reviewed changes

switch to revokers for fun and profit

aad2b68

zadjii-msft requested a review from DHowett July 17, 2023 13:41

zadjii-msft assigned DHowett and unassigned DHowett Jul 17, 2023

DHowett approved these changes Jul 19, 2023

View reviewed changes

zadjii-msft added 2 commits July 19, 2023 09:59

Merge remote-tracking branch 'origin/main' into dev/migrie/f/broadcas…

5a78021

…t-resurrections

add a comment to clarify

2dce177

zadjii-msft unassigned DHowett Jul 19, 2023

zadjii-msft enabled auto-merge (squash) July 19, 2023 15:11

zadjii-msft merged commit 6a10ea5 into main Jul 19, 2023

zadjii-msft deleted the dev/migrie/f/broadcast-resurrections branch July 19, 2023 15:45

zadjii-msft mentioned this pull request Aug 9, 2023

Broadcast Input ship list #15812

Closed

zadjii-msft mentioned this pull request Sep 18, 2023

Fix some smaller broadcast bugs #15993

Merged

zadjii-msft mentioned this pull request Jan 24, 2024

[Megathread] Broadcast input follow-ups #16600

Open

gorghino mentioned this pull request Feb 14, 2024

Add broadcast commands throughout terminals microsoft/vscode#205180

Open

zadjii-msft mentioned this pull request Apr 3, 2024

Manually select multiple panes to broadcast into #17011

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for broadcasting to all panes in a tab #14393

Add support for broadcasting to all panes in a tab #14393

zadjii-msft commented Nov 15, 2022

DHowett Nov 15, 2022

DHowett left a comment

DHowett left a comment

zadjii-msft commented Nov 16, 2022 •

edited

Loading

zadjii-msft commented Jul 5, 2023

This comment has been minimized.

DHowett Jul 13, 2023

zadjii-msft Jul 17, 2023

DHowett Jul 13, 2023

zadjii-msft Jul 17, 2023

DHowett Jul 17, 2023

zadjii-msft Jul 19, 2023

DHowett Jul 13, 2023

DHowett Jul 17, 2023

lhecker left a comment

lhecker Jul 17, 2023

DHowett commented Jul 17, 2023

DHowett left a comment

zadjii-msft commented Aug 7, 2023

Add support for broadcasting to all panes in a tab #14393

Add support for broadcasting to all panes in a tab #14393

Conversation

zadjii-msft commented Nov 15, 2022

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

DHowett left a comment

Choose a reason for hiding this comment

zadjii-msft commented Nov 16, 2022 • edited Loading

zadjii-msft commented Jul 5, 2023

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lhecker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DHowett commented Jul 17, 2023

DHowett left a comment

Choose a reason for hiding this comment

zadjii-msft commented Aug 7, 2023

zadjii-msft commented Nov 16, 2022 •

edited

Loading