CERBERUS/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty.git synced 2026-05-13 08:26:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

More docs for extra cursors

Browse source
This commit is contained in:
Kovid Goyal 2025-08-24 21:11:25 +05:30
parent bacd13d3a7
commit 0772a01779
No known key found for this signature in database
GPG key ID: 06BC317B515ACE7C
2 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/multiple-cursors-protocol.rst
View file

@ -147,4 +147,24 @@ Interaction with other terminal controls and state
only by this protocol.
**Clearing the screen**
The escape codes used to clear the screen (`ED <https://vt100.net/docs/vt510-rm/ED.html>`__)
with parameters 2, 3 and 22 must remove all extra cursors,
this is so that the clear command can be used by users to clear the screen of extra cursors.
**Reset***
This must remove all extra cursors.
**Alternate screen***
Switching between the main and alternate screens must remove all extra
cursors.
**Scrolling**
The index (IND) and reverse index (RI) escape codes that cause screen
contents to scroll into scrollback or off screen must not affect
the extra cursors in any way. They remain at exactly the same position.
It is upto applications to manage extra cursor positions when using these
escape codes if needed. There are not a lot of use cases for scrolling
extra cursors with screne content, since extra cursors are meant to be
ephemeral and on screen only, not in scrollback. This allows terminals
to avoid the extra overhead of adjusting positions of the extra cursors
on every scroll.

1
kitty/screen.c
View file

@ -174,6 +174,7 @@ static Line* range_line_(Screen *self, int y);
void
screen_reset(Screen *self) {
screen_pause_rendering(self, false, 0);
self->extra_cursors.count = 0;
self->main_pointer_shape_stack.count = 0; self->alternate_pointer_shape_stack.count = 0;
if (self->linebuf == self->alt_linebuf) screen_toggle_screen_buffer(self, true, true);
if (screen_is_overlay_active(self)) {