Implement ConEmu's OSC 9;4 to set the taskbar progress indicator #8055

PankajBhojwani · 2020-10-27T14:58:42Z

This commit implements the OSC 9;4 sequence per the ConEmu style.

sequence	description
`ESC ] 9 ; 4 ; st ; pr ST`	Set progress state on taskbar and tab.
	When `st` is:

	`0`: remove progress.
	`1`: set progress value to `pr` (number, 0-100).
	`2`: set the taskbar to the "Error" state
	`3`: set the taskbar to the "Indeterminate" state
	`4`: set the taskbar to the "Warning" state

We've also extended this with:

st 3: set indeterminate state
st 4: set paused state

We handle multiple tabs sending the sequence by using the the last focused
control's taskbar state/progress.

Upon receiving the sequence in TerminalApi, we send an event that gets caught
by TerminalPage. TerminalPage then fires another event that gets caught by
AppHost and that's where we set the taskbar progress.

Closes #3004

zadjii-msft · 2020-10-27T15:09:27Z

Oh no, this looks like it's branched off the hyperlink branch, so the commit history is a mess. Just a heads up.
re

TODO: We need to figure out how to handle multiple tabs sending the sequence and overriding each other

I'm imagining that this state is stored per-control, kinda like the application title. When we switch between panes/tabs, then we'll need to ask the control what its current progress state is, and bubble that state up.

zadjii-msft

I'm blocking mostly over the 3 thing, but there's still a bunch to do on this PR so I guess this block is mostly for show

src/terminal/parser/OutputStateMachineEngine.cpp

src/cascadia/WindowsTerminal/IslandWindow.cpp

…/pabhoj/taskbar_progress

src/terminal/parser/OutputStateMachineEngine.cpp

skyline75489 · 2020-10-28T02:42:12Z

src/cascadia/WindowsTerminal/pch.h

@@ -29,6 +29,7 @@ Module Name:
 #include <cstring>
 #include <shellscalingapi.h>
 #include <windowsx.h>
+#include <ShObjIdl.h>


Do we really want to add this to pch.h? Personally I try to avoid adding things into PCH because the damage it does to compiling speed.

meh, this one's not so bad. We'll probably end up using it in other places across the project, and I'd rather eat the compile time once in the pch phase rather than many times across rebuilds.

It's the winrt headers that really chew up pch time 😑

src/cascadia/WindowsTerminal/IslandWindow.cpp

src/terminal/parser/OutputStateMachineEngine.cpp

zadjii-msft

Wow these are such nits for something that works so well and I'm so excited about

src/cascadia/TerminalControl/TermControl.h

src/cascadia/TerminalApp/AppLogic.idl

src/cascadia/WindowsTerminal/IslandWindow.h

zadjii-msft · 2020-10-28T16:23:02Z

src/cascadia/WindowsTerminal/pch.h

@@ -29,6 +29,7 @@ Module Name:
 #include <cstring>
 #include <shellscalingapi.h>
 #include <windowsx.h>
+#include <ShObjIdl.h>


meh, this one's not so bad. We'll probably end up using it in other places across the project, and I'd rather eat the compile time once in the pch phase rather than many times across rebuilds.

It's the winrt headers that really chew up pch time 😑

src/terminal/parser/OutputStateMachineEngine.cpp

zadjii-msft

I REALLY want to sign off on this. I think it's ready to go, save for two things:

make sure the pfn isn't nullptr in TerminalApi.cpp
Maybe add tests to UnitTests_TerminalCore? We've got tests in ScreenBufferTests.cpp that write VT sequences to the buffer and make sure that the state of the SCREEN_INFORMATION in conhost is updated as we'd expect, maybe we should add something similar here?

src/cascadia/TerminalCore/TerminalApi.cpp

…state and progress params

DHowett · 2020-11-18T21:39:29Z

ohh noo there's another size_t <- uint64 conversion issue in AppHost.

Might be easiest to try to build the x86 version locally.

## Summary of the Pull Request Does what the title says. Now while you're building terminal projects, the taskbar will show indeterminate progress. If the build fails, it'll blink the error state for 500ms before returning to normal. ## References * Made possible by #8055 _and viewers like you_ ## PR Checklist * [x] scratches an itch I've had since at least 2018 * [x] I work here * [x] this is a build script ## Validation Steps Performed tested manually

…8335) ## Summary of the Pull Request Does what the title says. Now while you're building terminal projects, the taskbar will show indeterminate progress. If the build fails, it'll blink the error state for 500ms before returning to normal. ## References * Made possible by microsoft#8055 _and viewers like you_ ## PR Checklist * [x] scratches an itch I've had since at least 2018 * [x] I work here * [x] this is a build script ## Validation Steps Performed tested manually

sba923 · 2021-01-26T15:24:43Z

I must be missing something. I'm running Windows Terminal 1.4.3243.0, and this (PowerShell 7.1.1, FWIW) doesn't do anything:

Write-Host -NoNewline "`e]9;4;1;50`e\"

RTFM answers kindly accepted 😋

KalleOlaviNiemitalo · 2021-01-26T15:36:26Z

@sba923, this feature is on the release-1.6 branch, but not on the release-1.4 and release-1.5 branches.

sba923 · 2021-01-26T16:09:50Z

@sba923, this feature is on the release-1.6 branch, but not on the release-1.4 and release-1.5 branches.

Phew. I haven't gone mad after all. I just need to be patient 😉 or build myself a 1.6 binary.

sba923 · 2021-01-28T18:28:50Z

@sba923, this feature is on the release-1.6 branch, but not on the release-1.4 and release-1.5 branches.

I don't have to wait anymore thanks to v1.6.10272.0 Preview

The terminal will show a "Indeterminate" state progress while the server is starting See microsoft/terminal#8055 for more info

@weihanglo

### What does this PR try to resolve? A few terminal emulators support progress output to Windows taskbar. `winget` uses this to show install progress. Notably, Windows Terminal [recently (2020) added support](microsoft/terminal#8055) for ANSI codes [specified](https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC) in ConEmu (another terminal emulator for Windows) documentation. Also, in "[Learn Windows](https://learn.microsoft.com/en-us/windows/terminal/tutorials/progress-bar-sequences)". I've found the previous attempt to add this feature: #11436 As per @weihanglo's request, I've added the config option to enable/disable this feature. **It's enabled on supported terminal emulators.** Fixes #11432 FCP: #14615 (comment) ### How should we test and review this PR? Run `cargo build` in Windows Terminal with configuration option `term.progress.taskbar` set to `true`. ### Not sure - [x] Should all the code be `#[cfg(windows)]`? Probably no, because the feature is also usable in WSL. > Solved by introducing heuristic based on environment variable set by terminal - [ ] If Ctrl+C is pressed, a progressbar will stay in a last state forever (shown in the ConEmu video). `winget` is also behaves like alike. I've experimented with `ctrl_c handler` and it's totally fixable. - [x] `Enabled` is a sensible default for WSL because it works on linux builds in Windows Terminal too > Solved by introducing heuristic based on environment variable set by terminal - [x] Downloading stage may produce unpleasant blinking due to a rapid 0-100 changes > Solved by not displaying bar when downloading and using indeterminate state in other cases so amination don't reset ### TLDR * An `term.progress.taskbar` option with bool type is added * On Windows Terminal and ConEmu is enabled by default * If enabled reports build progress to taskbar icon and/or tab header ### Videos https://github.com/user-attachments/assets/48bb648a-e819-490e-b3ac-3502bc5f2f3a https://github.com/user-attachments/assets/1d7ddf7a-34dd-4db1-b654-e64d7170798e

zadjii-msft requested changes Oct 27, 2020

View reviewed changes

src/terminal/parser/OutputStateMachineEngine.cpp Outdated Show resolved Hide resolved

src/cascadia/WindowsTerminal/IslandWindow.cpp Show resolved Hide resolved

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Oct 27, 2020

PankajBhojwani added 2 commits October 27, 2020 13:03

osc 9;4 implementation

af9e4d5

spelling

606490f

PankajBhojwani force-pushed the dev/pabhoj/taskbar_progress branch from bc11ad9 to 606490f Compare October 27, 2020 17:04

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Oct 27, 2020

PankajBhojwani added 4 commits October 27, 2020 13:20

Merge branch 'main' of https://github.com/microsoft/terminal into dev…

0decbea

…/pabhoj/taskbar_progress

address comments

4e6f6fe

add paused state

da83748

use last focused tab's progress and state

3d0ed84

skyline75489 reviewed Oct 28, 2020

View reviewed changes

src/terminal/parser/OutputStateMachineEngine.cpp Outdated Show resolved Hide resolved

skyline75489 reviewed Oct 28, 2020

View reviewed changes

src/terminal/parser/OutputStateMachineEngine.cpp Outdated Show resolved Hide resolved

skyline75489 reviewed Oct 28, 2020

View reviewed changes

src/cascadia/WindowsTerminal/IslandWindow.cpp Outdated Show resolved Hide resolved

zadjii-msft self-assigned this Oct 28, 2020

use split string

f08c962

PankajBhojwani commented Oct 28, 2020

View reviewed changes

src/terminal/parser/OutputStateMachineEngine.cpp Outdated Show resolved Hide resolved

zadjii-msft requested changes Oct 28, 2020

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 Oct 28, 2020

zadjii-msft assigned PankajBhojwani and unassigned zadjii-msft Oct 28, 2020

use sender instead of args, some name changes

5f83dfd

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Oct 28, 2020

zadjii-msft requested changes Oct 29, 2020

View reviewed changes

src/cascadia/TerminalCore/TerminalApi.cpp Outdated Show resolved Hide resolved

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Oct 29, 2020

remove all references to SetTaskbarProgressEventArgs, validation for …

ab99ed5

…state and progress params

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Oct 29, 2020

PankajBhojwani added 2 commits October 29, 2020 12:27

tests

4125052

conflict with main

a900678

narrow cast

bf2051b

narrow 2

378dd7f

DHowett merged commit 16e8a84 into main Nov 18, 2020

DHowett deleted the dev/pabhoj/taskbar_progress branch November 18, 2020 22:24

zadjii-msft mentioned this pull request Nov 19, 2020

tools: update bcz.cmd to use the progress bar VT sequence #8335

Merged

3 tasks

Sidneys1 mentioned this pull request Nov 20, 2020

Supporting the OSC 9;4 codes PowerShell/PowerShell#14208

Closed

lnu mentioned this pull request Feb 14, 2021

Support for OSC 9;9 JanDeDobbeleer/oh-my-posh#409

Closed

denelon mentioned this pull request Apr 15, 2021

Provide Taskbar progress indicator in Terminal microsoft/winget-cli#869

Closed

chausner mentioned this pull request Apr 26, 2021

Incomplete support of ConEmu's OSC 9;4 sequences #9960

Closed

This was referenced Jun 1, 2021

Add support for OSC 9;4 for progress reporting kovidgoyal/kitty#3679

Closed

Support for OSC 9;4 for progress reporting alacritty/alacritty#5201

Closed

alexrp mentioned this pull request Jun 6, 2021

Support OSC 9 ; 4 (progress reporting) vezel-dev/cathode#19

Closed

1 task

albertlarsan68 mentioned this pull request Dec 21, 2022

Emit progress state escape codes rust-lang/cargo#11436

Closed

davidanthoff mentioned this pull request Jun 16, 2023

Support Windows Terminal progress UI JuliaLogging/TerminalLoggers.jl#47

Open

oldnapalm pushed a commit to oldnapalm/GTACoop that referenced this pull request Nov 5, 2023

Use new Windows Terminal OSC 9;4 to show progress

0560ffa

The terminal will show a "Indeterminate" state progress while the server is starting See microsoft/terminal#8055 for more info

rafaelsc mentioned this pull request Dec 5, 2023

Add Support to Terminal progress indicator to the the spectre console progress widget spectreconsole/spectre.console#1402

Open

Gordon01 mentioned this pull request Sep 29, 2024

Add terminal integration via ANSI OSC 9;4 sequences rust-lang/cargo#14615

Merged

4 tasks

mbeniamino mentioned this pull request Nov 1, 2024

OSC 9;4 for progress reporting conflicts with OSC 9 notifications kovidgoyal/kitty#8011

Closed

joshtriplett mentioned this pull request Dec 4, 2024

Support for progress-bar terminal escape sequences console-rs/indicatif#676

Closed

philiptaron mentioned this pull request Dec 12, 2024

Systemd 257 NixOS/nixpkgs#356818

Merged

13 tasks

jerch mentioned this pull request Dec 14, 2024

ConEmu OSC progressbar support xtermjs/xterm.js#5250

Closed

tanriol mentioned this pull request Dec 17, 2024

Progress in the ANSI title of the terminal tqdm/tqdm#1635

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Implement ConEmu's OSC 9;4 to set the taskbar progress indicator #8055

Implement ConEmu's OSC 9;4 to set the taskbar progress indicator #8055

Uh oh!

PankajBhojwani commented Oct 27, 2020 •

edited by DHowett

Loading

zadjii-msft commented Oct 27, 2020

zadjii-msft left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

skyline75489 Oct 28, 2020

zadjii-msft Oct 28, 2020

Uh oh!

Uh oh!

zadjii-msft left a comment

Uh oh!

Uh oh!

Uh oh!

zadjii-msft Oct 28, 2020

Uh oh!

Uh oh!

zadjii-msft left a comment

Uh oh!

DHowett commented Nov 18, 2020

sba923 commented Jan 26, 2021

KalleOlaviNiemitalo commented Jan 26, 2021

sba923 commented Jan 26, 2021

sba923 commented Jan 28, 2021

Implement ConEmu's OSC 9;4 to set the taskbar progress indicator #8055

Implement ConEmu's OSC 9;4 to set the taskbar progress indicator #8055

Uh oh!

Conversation

PankajBhojwani commented Oct 27, 2020 • edited by DHowett Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

zadjii-msft commented Oct 27, 2020

zadjii-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

skyline75489 Oct 28, 2020

Choose a reason for hiding this comment

zadjii-msft Oct 28, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zadjii-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zadjii-msft Oct 28, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zadjii-msft left a comment

Choose a reason for hiding this comment

Uh oh!

DHowett commented Nov 18, 2020

sba923 commented Jan 26, 2021

KalleOlaviNiemitalo commented Jan 26, 2021

sba923 commented Jan 26, 2021

sba923 commented Jan 28, 2021

PankajBhojwani commented Oct 27, 2020 •

edited by DHowett

Loading