Private Mode for Terminal Visibility Reports

[rockorager]

This is a draft specification for terminal visibility reports. Based on the proven design of the color scheme reports, this spec introduces both a new private mode and new DSR query / response formats.

• Mode 2033 to enable automatic visibility reporting
• DSR 998 for one-shot query
• DSR 999 response. Value 1 means terminal may be visible, value 2 means terminal definitely is not visible

Terminals should use all information available to them when reporting this state.

https://rockorager.dev/misc/visibility-reports/

Please let me know any potential issues you see with this!

[jcollie]

Implemented by #13494

[j4james]

@christianparpart I believe this conflicts with your clipboard protocol. So if you haven't shipped it yet, you may want to consider changing the mode number.

The DSR report also technically conflicts with the color palette protocol, but that shouldn't be a problem as long it's never extended.

[christianparpart]

Thanks for the ping, @j4james , it is not even merged yet. Because maybe kitty's binary paste is sufficient. Didn't have time to investigate just yet. All good. :)

[rockorager]

how does it conflict with the color palette report? that one is 996/997?

[rockorager]

Also sorry for the collision @christianparpart ... I did a review of what was out there and even went one over what I thought was available just in case!

[rockorager]

If it does truly conflict with the color protocol I can update the spec and a fresh PR to ghostty - I'd hate to create a conflict!

[j4james]

DSR numbers take the form n*10+m where n is the protocol family, and m is an operation or status report within that family. For example, the DSR keyboard reports are all grouped in the family n=2, with queries 25 and 26, and responses 20, 21, 22, and 27. As another example, the Locator reports use n=5, with the queries 55 and 56, and responses 50, 53, 57, and 58.

So in the case of the color reporting protocol, the family is n=99, which means the numbers 990 to 999 are all technically reserved for that protocol. So ideally you should be using a different value for n. It's also worth noting that for this kind of status, the query typically has an m of 6, an the response an m of 7 or more (which is why the color report uses the combination 996/997).

It's unlikely that the color protocol will ever be extended with additional response numbers, so this shouldn't be a problem in practice - it's just technically incorrect, and somewhat misleading for anyone that knows the standard.