Module progress 

Progress-bar OSC sequences.

Category

OSC 9;4 communicates taskbar or tab progress state: reset, indeterminate, normal percentage, error percentage, and warning percentage.

OSC framing

All sequences use ESC ] 9 ; 4 ; state [; percentage] BEL. Percentages passed to writers are clamped into 0..=100 before emission.

Mode interaction

These notifications are not controlled by terminal modes. Unsupported terminals ignore the OSC string.

Constants

RESET_PROGRESS_BAR

Reset or hide progress: exact bytes ESC ] 9 ; 4 ; 0 BEL (b"\x1b]9;4;0\x07").

SET_INDETERMINATE_PROGRESS_BAR

Set indeterminate progress: exact bytes ESC ] 9 ; 4 ; 3 BEL (b"\x1b]9;4;3\x07").

Functions

write_set_error_progress_bar

Set error progress with ESC ] 9 ; 4 ; 2 ; <percentage> BEL.

write_set_progress_bar

Set normal progress with ESC ] 9 ; 4 ; 1 ; <percentage> BEL.

write_set_warning_progress_bar

Set warning progress with ESC ] 9 ; 4 ; 4 ; <percentage> BEL.