fix: maintain cursor visibility across altscreen state switch

Based on #462 and #452 by @londek, but fixes maintaining the
current visibility state across altscreen state changes.

This makes the behavior consistent across terminals, some of which
keep separate state for altscreen and regular buffer.

Fixes #190.
This commit is contained in:
Christian Muehlhaeuser 2022-10-13 08:16:29 +02:00
parent 918d35746b
commit 0f1ce7f2d9
2 changed files with 25 additions and 2 deletions

View File

@ -19,12 +19,12 @@ func TestClearMsg(t *testing.T) {
{ {
name: "altscreen", name: "altscreen",
cmds: []Cmd{EnterAltScreen, ExitAltScreen}, cmds: []Cmd{EnterAltScreen, ExitAltScreen},
expected: "\x1b[?25l\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[1;1H\x1b[?1049lsuccess\r\n\x1b[0D\x1b[2K\x1b[?25h\x1b[?1002l\x1b[?1003l", expected: "\x1b[?25l\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[1;1H\x1b[?25l\x1b[?1049l\x1b[?25lsuccess\r\n\x1b[0D\x1b[2K\x1b[?25h\x1b[?1002l\x1b[?1003l",
}, },
{ {
name: "altscreen_autoexit", name: "altscreen_autoexit",
cmds: []Cmd{EnterAltScreen}, cmds: []Cmd{EnterAltScreen},
expected: "\x1b[?25l\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[1;1Hsuccess\r\n\x1b[2;0H\x1b[2K\x1b[?25h\x1b[?1002l\x1b[?1003l\x1b[?1049l", expected: "\x1b[?25l\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[1;1H\x1b[?25lsuccess\r\n\x1b[2;0H\x1b[2K\x1b[?25h\x1b[?1002l\x1b[?1003l\x1b[?1049l\x1b[?25h",
}, },
{ {
name: "mouse_cellmotion", name: "mouse_cellmotion",

View File

@ -38,6 +38,9 @@ type standardRenderer struct {
useANSICompressor bool useANSICompressor bool
once sync.Once once sync.Once
// cursor visibility state
cursorHidden bool
// essentially whether or not we're using the full size of the terminal // essentially whether or not we're using the full size of the terminal
altScreenActive bool altScreenActive bool
@ -299,6 +302,15 @@ func (r *standardRenderer) enterAltScreen() {
r.out.ClearScreen() r.out.ClearScreen()
r.out.MoveCursor(1, 1) r.out.MoveCursor(1, 1)
// cmd.exe and other terminals keep separate cursor states for the AltScreen
// and the main buffer. We have to explicitly reset the cursor visibility
// whenever we enter AltScreen.
if r.cursorHidden {
r.out.HideCursor()
} else {
r.out.ShowCursor()
}
r.repaint() r.repaint()
} }
@ -313,6 +325,15 @@ func (r *standardRenderer) exitAltScreen() {
r.altScreenActive = false r.altScreenActive = false
r.out.ExitAltScreen() r.out.ExitAltScreen()
// cmd.exe and other terminals keep separate cursor states for the AltScreen
// and the main buffer. We have to explicitly reset the cursor visibility
// whenever we exit AltScreen.
if r.cursorHidden {
r.out.HideCursor()
} else {
r.out.ShowCursor()
}
r.repaint() r.repaint()
} }
@ -320,6 +341,7 @@ func (r *standardRenderer) showCursor() {
r.mtx.Lock() r.mtx.Lock()
defer r.mtx.Unlock() defer r.mtx.Unlock()
r.cursorHidden = false
r.out.ShowCursor() r.out.ShowCursor()
} }
@ -327,6 +349,7 @@ func (r *standardRenderer) hideCursor() {
r.mtx.Lock() r.mtx.Lock()
defer r.mtx.Unlock() defer r.mtx.Unlock()
r.cursorHidden = true
r.out.HideCursor() r.out.HideCursor()
} }