Add support for alternate scroll mode in Terminal #12569

zadjii-msft · 2022-02-24T17:17:38Z

"Alternate scroll mode" is a neat little mode where the app wants mouse wheel events to come through as arrow keypresses instead, when in the alternate buffer. Now that we've got support for the alt buffer in the Terminal, we can support this as well.

Closes Scrolling in the Alternate Screen Buffer should send up/down keystrokes? #3321
I work here
Tests would be nice

Tested manually with

printf "\e[?1007h" ; man ps

Resizing is surely boned but this is 1000% percent better than nothing at all.

_⚠️ targets #12561 ⚠️_ "Alternate scroll mode" is a neat little mode where the app wants mouse wheel events to come through as arrow keypresses instead, when in the alternate buffer. Now that we've got support for the alt buffer in the Terminal, we can support this as well. * [x] Closes #3321 * [x] I work here * [ ] Tests would be nice Tested manually with ```bash printf "\e[?1007h" ; man ps ```

github-actions · 2022-02-24T17:20:41Z

@check-spelling-bot Report

Unrecognized words, please review:

deduplicating
seperately

Previously acknowledged words that are now absent

azurewebsites cxcy debolden deconstructed devicefamily guardxfg LLVM MSDL ned NOWAIT pgorepro pgort PGU Timeline timelines unintense WResult xfg

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the [email protected]:microsoft/terminal.git repository
on the dev/migrie/b/3321-altscroll-in-terminal branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spelling/expect/alphabet.txt
.github/actions/spelling/expect/expect.txt
.github/actions/spelling/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect/bf24cdd4b05091e151b2474f73390438c8f0c96c.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/terminal/issues/comments/1050080814" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. You can copy the contents of each perl command excluding the outer ' marks and dropping any '"/"' quotation mark pairs into a file and then run perl file.pl from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:

... misspelled, then please correct them instead of using the command.
... names, please add them to .github/actions/spelling/allow/names.txt.
... APIs, you can add them to a file in .github/actions/spelling/allow/.
... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

🗜️ If you see a bunch of garbage

If it relates to a ...

well-formed pattern

See if there's a pattern that would match it.

If not, try writing one and adding it to a patterns/{file}.txt.

Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.

binary-ish string

Please add a file path to the excludes.txt file instead of just accepting the garbage.

File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

…f that we're supposed to do when entering/exiting the alt buffer

…t worked" because conpty magic.

…er-terminal

…1-altscroll-in-terminal

github-actions · 2022-03-08T23:03:26Z

@check-spelling-bot Report

Unrecognized words, please review:

oneliner

Previously acknowledged words that are now absent

azurewebsites cxcy debolden deconstructed devicefamily guardxfg LLVM MSDL ned NOWAIT pgorepro pgort PGU redistributable Timeline timelines unintense WResult xfg

To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands

... in a clone of the [email protected]:microsoft/terminal.git repository
on the dev/migrie/b/3321-altscroll-in-terminal branch:

update_files() {
perl -e '
my @expect_files=qw('".github/actions/spelling/expect/alphabet.txt
.github/actions/spelling/expect/expect.txt
.github/actions/spelling/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"$patch_remove"');
my $re=join "|", @stale;
my $suffix=".".time();
my $previous="";
sub maybe_unlink { unlink($_[0]) if $_[0]; }
while (<>) {
if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; }
next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spelling/expect/e658431c11dfe0856e1e090a38a00b6b40382549.txt";
use File::Path qw(make_path);
use File::Basename qw(dirname);
make_path (dirname($new_expect_file));
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"$patch_add"');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;
system("git", "add", $new_expect_file);
'
}

comment_json=$(mktemp)
curl -L -s -S \
  --header "Content-Type: application/json" \
  "https://api.github.com/repos/microsoft/terminal/issues/comments/1062332438" > "$comment_json"
comment_body=$(mktemp)
jq -r .body < "$comment_json" > $comment_body
rm $comment_json

patch_remove=$(perl -ne 'next unless s{^</summary>(.*)</details>$}{$1}; print' < "$comment_body")
  

patch_add=$(perl -e '$/=undef;
$_=<>;
s{<details>.*}{}s;
s{^#.*}{};
s{\n##.*}{};
s{(?:^|\n)\s*\*}{}g;
s{\s+}{ }g;
print' < "$comment_body")
  
update_files
rm $comment_body
git add -u

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. You can copy the contents of each perl command excluding the outer ' marks and dropping any '"/"' quotation mark pairs into a file and then run perl file.pl from the root of the repository to run the code. Alternatively, you can manually insert the items...

If the listed items are:

... misspelled, then please correct them instead of using the command.
... names, please add them to .github/actions/spelling/allow/names.txt.
... APIs, you can add them to a file in .github/actions/spelling/allow/.
... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

🗜️ If you see a bunch of garbage

If it relates to a ...

well-formed pattern

See if there's a pattern that would match it.

If not, try writing one and adding it to a patterns/{file}.txt.

Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.

binary-ish string

Please add a file path to the excludes.txt file instead of just accepting the garbage.

File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

miniksa

Sounds good.

…er-terminal

DHowett · 2022-03-16T15:47:31Z

src/cascadia/TerminalCore/TerminalApi.cpp

@@ -615,6 +615,10 @@ void Terminal::UseAlternateScreenBuffer()
    // update all the hyperlinks on the screen
    UpdatePatternsUnderLock();

+    // GH#3321: Make sure we let the TerminalInput know that we switched
+    // buffers. This might affect how we interpret certain mouse events.
+    _terminalInput->UseAlternateScreenBuffer();


IMHO this part belongs in the original alt buffer PR -- since UseAlternateScreenBuffer isn't new.

DHowett · 2022-03-16T16:06:57Z

github gave me a 500 error a few times, but apparently it meant "I failed to tell you that you submitted a review" and "now you're gonna look like a weirdo"

…er-terminal

…ie/b/3321-altscroll-in-terminal

…scroll-in-terminal

ghost · 2022-04-12T22:41:05Z

Hello @DHowett!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

ghost · 2022-05-24T17:08:32Z

🎉Windows Terminal Preview v1.14.143 has been released which incorporates this pull request.:tada:

Handy links:

zadjii-msft added 6 commits February 23, 2022 11:20

I think this is the conhost half of the changes

83466a4

This quite nearly implements everything for the Terminal half

e94e08c

Resizing is surely boned but this is 1000% percent better than nothing at all.

Most of the remaining todos, comments

dd702c7

one last comment

1209fa4

more comments are always good

bf24cdd

zadjii-msft added 10 commits February 24, 2022 11:45

spel

dff1b94

fix tests

60d2c2e

Stashing this for now. I think this does the save/restore cursor stuf…

54dc304

…f that we're supposed to do when entering/exiting the alt buffer

start writing tests

57094b7

make this test way more elaborate

69d0973

I thought this was a test for #12561 (comment), but I think that "jus…

0a1ed70

…t worked" because conpty magic.

More test cleanup. Make sure viewport doesnt move

9453aa5

Merge remote-tracking branch 'origin/main' into dev/migrie/b/alt-buff…

e658431

…er-terminal

Merge branch 'dev/migrie/b/alt-buffer-terminal' into dev/migrie/b/332…

1e5a41e

…1-altscroll-in-terminal

spel

0e5d022

miniksa approved these changes Mar 11, 2022

View reviewed changes

zadjii-msft added 2 commits March 16, 2022 10:25

Merge remote-tracking branch 'origin/main' into dev/migrie/b/alt-buff…

0cfb463

…er-terminal

fine that's not a word

bf3d79e

DHowett reviewed Mar 16, 2022

View reviewed changes

DHowett approved these changes Mar 16, 2022

View reviewed changes

zadjii-msft added 3 commits March 17, 2022 14:23

thats not a word either

7237fce

notes from j4james

65b4571

Merge remote-tracking branch 'origin/main' into dev/migrie/b/alt-buff…

7c3e808

…er-terminal

raghavthind2005 approved these changes Apr 3, 2022

View reviewed changes

zadjii-msft mentioned this pull request Apr 12, 2022

Enable using the alt buffer in the Terminal #12561

Merged

4 tasks

zadjii-msft added 2 commits April 12, 2022 15:40

Merge remote-tracking branch 'origin/main' into dev/migrie/b/alt-buff…

002fbbc

…er-terminal

fix the urls in the alt buffer

f209d98

Base automatically changed from dev/migrie/b/alt-buffer-terminal to main April 12, 2022 22:19

DHowett added 2 commits April 12, 2022 17:22

Merge commit 'f209d98e4310d8df57ca5b0d4e36700a140ba0bd' into dev/migr…

e988182

…ie/b/3321-altscroll-in-terminal

Merge remote-tracking branch 'origin/main' into dev/migrie/b/3321-alt…

913f1d4

…scroll-in-terminal

DHowett approved these changes Apr 12, 2022

View reviewed changes

DHowett added the AutoMerge Marked for automatic merge by the bot when requirements are met label Apr 12, 2022

ghost merged commit 9905192 into main Apr 12, 2022

ghost deleted the dev/migrie/b/3321-altscroll-in-terminal branch April 12, 2022 23:00

ghost mentioned this pull request May 24, 2022

Scrolling in the Alternate Screen Buffer should send up/down keystrokes? #3321

Closed

jaminthorns mentioned this pull request May 27, 2022

Enable alternate scroll mode by default #13187

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for alternate scroll mode in Terminal #12569

Add support for alternate scroll mode in Terminal #12569

zadjii-msft commented Feb 24, 2022 •

edited

Loading

github-actions bot commented Feb 24, 2022 •

edited

Loading

github-actions bot commented Mar 8, 2022 •

edited

Loading

miniksa left a comment

DHowett Mar 16, 2022

DHowett commented Mar 16, 2022

ghost commented Apr 12, 2022

ghost commented May 24, 2022

Add support for alternate scroll mode in Terminal #12569

Add support for alternate scroll mode in Terminal #12569

Conversation

zadjii-msft commented Feb 24, 2022 • edited Loading

github-actions bot commented Feb 24, 2022 • edited Loading

@check-spelling-bot Report

Unrecognized words, please review:

github-actions bot commented Mar 8, 2022 • edited Loading

@check-spelling-bot Report

Unrecognized words, please review:

miniksa left a comment

Choose a reason for hiding this comment

DHowett Mar 16, 2022

Choose a reason for hiding this comment

DHowett commented Mar 16, 2022

ghost commented Apr 12, 2022

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented May 24, 2022

zadjii-msft commented Feb 24, 2022 •

edited

Loading

github-actions bot commented Feb 24, 2022 •

edited

Loading

github-actions bot commented Mar 8, 2022 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.