Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: maintain cursor visibility across altscreen state switch #537

Merged
merged 1 commit into from
Oct 23, 2022
Merged

fix: maintain cursor visibility across altscreen state switch #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions screen_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ func TestClearMsg(t *testing.T) {
{
name: "altscreen",
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",
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",
Expand Down
23 changes: 23 additions & 0 deletions standard_renderer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ type standardRenderer struct {
useANSICompressor bool
once sync.Once

// cursor visibility state
cursorHidden bool

// essentially whether or not we're using the full size of the terminal
altScreenActive bool

Expand Down Expand Up @@ -290,6 +293,15 @@ func (r *standardRenderer) enterAltScreen() {
r.out.ClearScreen()
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()
}

Expand All @@ -304,20 +316,31 @@ func (r *standardRenderer) exitAltScreen() {
r.altScreenActive = false
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()
}

func (r *standardRenderer) showCursor() {
r.mtx.Lock()
defer r.mtx.Unlock()

r.cursorHidden = false
r.out.ShowCursor()
}

func (r *standardRenderer) hideCursor() {
r.mtx.Lock()
defer r.mtx.Unlock()

r.cursorHidden = true
r.out.HideCursor()
}

Expand Down