Erratic output when OSC8 sequences are present

[rockorager]

Hello -

When bat displays something that already includes an OSC8 sequence, it has erratic output, dependent on the terminal-width. Seemingly, OSC8 ids and urls are included in line-wrapping which leads to strange output depending on where the line is cut.

What steps will reproduce the bug?

Works as expected:

echo '\e]8;;http://example.com\e\\This is a link\e]8;;\e\\\n' | bat --terminal-width=64

Includes escape characters in output:

echo '\e]8;;http://example.com\e\\This is a link\e]8;;\e\\\n' | bat --terminal-width=48

No escape characters, but incorrect wrapping:

echo '\e]8;;http://example.com\e\\This is a link\e]8;;\e\\\n' | bat --terminal-width=40

What happens?

If you keep changing the terminal width, strange things keep happening.

What did you expect to happen instead?

The output should be the same in all above scenarios, as long as terminal-width is greater than the length of the printable section of an OSC8 sequence ("This is a link") in this case.

How did you install bat?

sudo pacman -S bat

bat version and environment

Software version

bat 0.23.0 (871abd2)

Operating system

Linux 6.2.10-arch1-1

Command-line

bat --terminal-width=24 --diagnostic 

Environment variables

SHELL=/usr/bin/zsh
PAGER=<not set>
LESS=<not set>
LANG=en_US.UTF-8
LC_ALL=<not set>
BAT_PAGER=<not set>
BAT_CACHE_PATH=<not set>
BAT_CONFIG_PATH=<not set>
BAT_OPTS=<not set>
BAT_STYLE=<not set>
BAT_TABS=<not set>
BAT_THEME=<not set>
XDG_CONFIG_HOME=<not set>
XDG_CACHE_HOME=<not set>
COLORTERM=truecolor
NO_COLOR=<not set>
MANPAGER=<not set>

System Config file

Could not read contents of '/etc/bat/config': No such file or directory (os error 2).

Config file

Could not read contents of '/home/tim/.config/bat/config': No such file or directory (os error 2).

Custom assets metadata

Could not read contents of '/home/tim/.cache/bat/metadata.yaml': No such file or directory (os error 2).

Custom assets

'/home/tim/.cache/bat' not found

Compile time information

• Profile: release
• Target triple: x86_64-unknown-linux-gnu
• Family: unix
• OS: linux
• Architecture: x86_64
• Pointer width: 64
• Endian: little
• CPU features: fxsr,sse,sse2
• Host: x86_64-unknown-linux-gnu

Less version

> less --version 
less 608 (PCRE2 regular expressions)
Copyright (C) 1984-2022  Mark Nudelman

less comes with NO WARRANTY, to the extent permitted by law.
For information about the terms of redistribution,
see the file named README in the less distribution.
Home page: https://greenwoodsoftware.com/less

[keith-hall]

related: #2158

[eth-p]

Whoops. Sorry for the spam! Rebasing and force pushing will do that, I guess. 😅

Anyways... this is more along the lines of what you expected, right? New behaviour from my branch is on the left, old behaviour is on the right.

Unfortunately this comes with the drawback where the link is treated as two separate hyperlinks, rather than as a single one. I don't think we're able to fix that, though, since it's the job of the terminal emulator to render the link decorations.

[rockorager]

Wow I was typing in my phone and accidentally closed!

[rockorager]

Anyways... this is more along the lines of what you expected, right? New behaviour from my branch is on the left, old behaviour is on the right.

Yep that looks right!

Unfortunately this comes with the drawback where the link is treated as two separate hyperlinks, rather than as a single one. I don't think we're able to fix that, though, since it's the job of the terminal emulator to render the link decorations.

You can put an id as part of the osc8 string to link two separate lines as the same link.

echo '\e]8;bat-1;http://example.com\e\\This is a link\e]8;;\e\\\n'

Thanks!

[eth-p]

You can put an id as part of the osc8 string to link two separate lines as the same link.

Neat! Mind if I fix that in a future PR? This one [edit: meaning #2544] is getting pretty long as-is, and I have some finals to study for :)

[rockorager]

Neat! Mind if I fix that in a future PR? This one is getting pretty long as-is, and I have some finals to study for :)

Don't mind at all!

[eth-p]

With #2544 merged, this should be fixed in the next release. 🎉