Improve OSC 9;9 parsing logic & add tests

[skyline75489]

This PR fixes the parsing of OSC 9;9 sequences with path surrounded by
quotation marks.

Original OSC 9;9 PR: #8330

Unit test added. Manually tested with oh-my-posh.

Closes #8930

[skyline75489]

I'll admit. I have no idea the "cwd" in ESC ] 9 ; 9 ; “cwd” ST means the path is surrounded by literal " according to ConEmu doc.

I purpose including this in servicing release because the bug will frustrate oh-my-posh users since oh-my-posh by default will trigger the failure described in #8930 .

[skyline75489]

This is why I thought I was doing it right. ConEmu won't blame users for forgetting “. I think we should follow,

[skyline75489]

Note that this is actually making OSC 9;9 even more Win32-specific. Since " is an invalid dir name on WIndows, but is a valid dir name on Linux.

[skyline75489]

To be specific, when we see a path provided by OSC 9;9 , for example, "D:" on Windows, the actual path is guaranteed to be D: because neither " nor : is valid character in dir names on Windows. But on Linux, you can create a dir that's literally named "D:" by mkdir "\"D:\"".

I can't blame ConEmu for designing the sequence this way since it's a Win32 native application at the very beginning. Just to point it out.

Also CC @Maximus5 for awareness.

Update: on second thought, maybe I'm a bit paranoid about this. The CWD should always be an absolute path, right? There's almost no chance an absolute path would both start and end with " to cause the confusion. I sincerely hope the confusion I described only exist in my imagination.

[github-actions]

New misspellings found, please review:

• surrouding

To accept these changes, run the following commands

perl -e '
my @expect_files=qw('".github/actions/spell-check/expect/5757ec679b03a4240130c3c53766c91bbc5cd6a7.txt
.github/actions/spell-check/expect/655f007265b351e140d20b3976792523ad689241.txt
.github/actions/spell-check/expect/a129ff14ec985d6b7bf09e296a831c955d41040b.txt
.github/actions/spell-check/expect/alphabet.txt
.github/actions/spell-check/expect/expect.txt
.github/actions/spell-check/expect/web.txt"');
@ARGV=@expect_files;
my @stale=qw('"AAAAA consecteturadipiscingelit dnceng Loremipsumdolorsitamet Namquiseratal Nullametrutrummetus Remoting rgdx Textbox yzx "');
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)(?:$| .*)/; print;
}; maybe_unlink($previous);'
perl -e '
my $new_expect_file=".github/actions/spell-check/expect/c60dfbd8a4327ca53aebfe05753fa18ffff16700.txt";
open FILE, q{<}, $new_expect_file; chomp(my @words = <FILE>); close FILE;
my @add=qw('"remoting surrouding textbox "');
my %items; @items{@words} = @words x (1); @items{@add} = @add x (1);
@words = sort {lc($a) cmp lc($b)} keys %items;
open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; };
close FILE;'
git add .github/actions/spell-check/expect || echo '... you want to ensure .github/actions/spell-check/expect/c60dfbd8a4327ca53aebfe05753fa18ffff16700.txt is added to your repository...'

✏️ 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/spell-check/dictionary/names.txt.
• ... APIs, you can add them to a file in .github/actions/spell-check/dictionary/.
• ... just things you're using, please add them to an appropriate file in .github/actions/spell-check/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/spell-check/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. 😉

⚠️ Reviewers

At present, the action that triggered this message will not show its ❌ in this PR unless the branch is within this repository.
Thus, you should make sure that this comment has been addressed before encouraging the merge bot to merge this PR.

[skyline75489]

In the future I think we should consider this an invalid sequence, especially after we figure out the way to identify WSL profiles and make OSC 7 work. Right now I'm not sure how to do with it.

[zadjii-msft]

Yea I think there are enough test cases for this now 😋

[carlos-zamora]

Thanks!

[DHowett]

Thanks! This is excellent as always.

[ghost]

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]

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

Handy links:

• Release Notes
• Store Download

[JanDeDobbeleer]

the bug will frustrate oh-my-posh users

@skyline75489 I'm implementing this for oh-my-posh V3, if I get this correctly omitting the "'s is the best way forward, right?

[skyline75489]

@JanDeDobbeleer Yeah that is correct. Just keep doing what v2 does is OK. Thanks for the great work by the way :)