Skip to content

Strip OSC and DCS sequences to support e.g. OSC 8 hyperlinks over tmux.#280

Open
khoek wants to merge 2 commits intoconsole-rs:mainfrom
khoek:main
Open

Strip OSC and DCS sequences to support e.g. OSC 8 hyperlinks over tmux.#280
khoek wants to merge 2 commits intoconsole-rs:mainfrom
khoek:main

Conversation

@khoek
Copy link
Copy Markdown

@khoek khoek commented Feb 7, 2026

I noticed that using indicatif (and friends) to embed a hyperlink in a console progress bar caused the wheels to fall off my app (with many newlines being spammed to the console and the auto-updating line-rewriting broken). I tracked the problem down to the OSC sequences incorrectly being interpreted as printable, and the following patch fixes the problem for me.

@djc
Copy link
Copy Markdown
Member

djc commented Feb 7, 2026

Appreciate the clean commit history, but it looks like there's a fair bit of code duplication. Could that be deduplicated? (If not, why not?)

@khoek
Copy link
Copy Markdown
Author

khoek commented Feb 8, 2026

Appreciate the clean commit history, but it looks like there's a fair bit of code duplication. Could that be deduplicated? (If not, why not?)

@djc Just my editorial choice to keep things simple. Did you have something more like the following (see latest commit) in mind? It's more complex but clarifies intent. (Happy to squash if you like it, honestly I kind of do.)

Either way, I think the new commit at least clearly shows why there is some subtlety due to the differences in OSC and DCS semantics/idiosyncrasies---two examples:

  • \x07 (BEL) is allowed to close an OSC sequence without needing ESC \
  • ESC \ ends both OSC and DSC, and for recovery we allow ESC EOF to terminated, but in DSC there are also escaped ESC ESCs so one needs to be sure this doesn't break ESC EOF handling.

Let me know what you like!

@khoek khoek force-pushed the main branch 2 times, most recently from 3d2f8f2 to 07d3b28 Compare February 8, 2026 02:11
@khoek
Copy link
Copy Markdown
Author

khoek commented Feb 8, 2026

(Sorry about the noise I was bikeshedding a function name.)

Copy link
Copy Markdown
Member

@djc djc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I definitely like it better too -- please squash.

Is there existing stuff which could leverage the same trait?

Treat OSC and DCS (including tmux passthrough wrappers) as non-printing when iterating/stripping ANSI codes.

Adds regression tests for OSC 8 hyperlinks (ST/BEL) and tmux-wrapped OSC 8 hyperlinks.
Ensure the complex_data test fixture is present in packaged sources.
@khoek
Copy link
Copy Markdown
Author

khoek commented Feb 13, 2026

If there's a natural other place the same trait fits, I can't seem to find it. I would say the DFA core is structurally a bit different.

(Above are my subjective feelings about your comments and they are made with relatively little conviction, so please feel free to override if you feel more strongly.)

@khoek
Copy link
Copy Markdown
Author

khoek commented Feb 24, 2026

@djc (The politest possible) ping, just in case this fell off your desk (as opposed to being placed in the filing cabinet 😄). Obviously no pressure.

@djc
Copy link
Copy Markdown
Member

djc commented Feb 24, 2026

I'll have you know my GitHub notifications are neatly stacked in a filing cabinet 😄, but due to various factors (including vacation) the cabinet is rather full at the moment -- ping me again if I haven't gotten to it in a month, okay?

@khoek
Copy link
Copy Markdown
Author

khoek commented Mar 24, 2026

@djc polite ping! :)

Copy link
Copy Markdown
Member

@djc djc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience! This needs a rebase and a few more tweaks.

Comment on lines +114 to +116
if S::on_char(c).end {
return end;
}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be part of the match? Would be nice to reduce rightward drift for the \u{1b} case by handling it outside of the match.

const START: char = ']';

fn on_escape(next: Option<char>) -> EscAction {
if matches!(next, Some('\\')) {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest simplifying this to be more like:

let end = matches!(next, Some('\\'));
EscAction { consume_next: end, end }

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants