fix: don't lose the last line of a view
Signed-off-by: drew <me@andrinoff.com>
This commit is contained in:
parent
4e99467d8b
commit
5617f4d705
14 changed files with 129 additions and 29 deletions
|
|
@ -200,6 +200,16 @@ func (s *cursedRenderer) close() (err error) {
|
|||
if lv.AltScreen {
|
||||
enableAltScreen(s, false, true)
|
||||
} else {
|
||||
// A view without a trailing newline has content on its last row,
|
||||
// unlike a view ending in a newline whose last row is the
|
||||
// intentional blank line below the frame. Move the cursor one row
|
||||
// further down (scrolling the screen if the frame fills it, just
|
||||
// like printing a trailing newline would) so the closing erase and
|
||||
// the shell prompt that follows start below the frame instead of
|
||||
// overwriting its last line.
|
||||
if lv.Content != "" && !strings.HasSuffix(lv.Content, "\n") {
|
||||
_, _ = s.scr.WriteString("\r\n")
|
||||
}
|
||||
_, _ = s.scr.WriteString(ansi.EraseScreenBelow)
|
||||
}
|
||||
if lv.Cursor == nil {
|
||||
|
|
@ -299,6 +309,7 @@ func (s *cursedRenderer) flush(closing bool) error {
|
|||
}
|
||||
|
||||
content := uv.NewStyledString(view.Content)
|
||||
contentHeight := content.Height()
|
||||
if !view.AltScreen {
|
||||
// We need to resizes the screen based on the frame height and
|
||||
// terminal width. This is because the frame height can change based on
|
||||
|
|
@ -306,7 +317,13 @@ func (s *cursedRenderer) flush(closing bool) error {
|
|||
// of items, the height of the frame will be the number of items in the
|
||||
// list. This is different from the alt screen buffer, which has a
|
||||
// fixed height and width.
|
||||
frameHeight := content.Height()
|
||||
//
|
||||
// Frames taller than the screen can only show their bottom rows, so
|
||||
// the frame area is capped at the screen height. Keeping the frame
|
||||
// area equal to what's actually on screen also keeps it equal to the
|
||||
// screen buffer's bounds across flushes, which lets unchanged frames
|
||||
// render as no-ops instead of forcing a full redraw every flush.
|
||||
frameHeight := min(contentHeight, s.height)
|
||||
if frameHeight != frameArea.Dy() {
|
||||
frameArea.Max.Y = frameHeight
|
||||
}
|
||||
|
|
@ -342,13 +359,16 @@ func (s *cursedRenderer) flush(closing bool) error {
|
|||
// Clear our screen buffer before copying the new frame into it to ensure
|
||||
// we erase any old content.
|
||||
s.cellbuf.Clear()
|
||||
content.Draw(s.cellbuf, s.cellbuf.Bounds())
|
||||
|
||||
// If the frame height is greater than the screen height, we drop the
|
||||
// lines from the top of the buffer.
|
||||
if frameHeight := frameArea.Dy(); frameHeight > s.height {
|
||||
s.cellbuf.Lines = s.cellbuf.Lines[frameHeight-s.height:]
|
||||
// Frames taller than the screen are drawn with their top rows shifted
|
||||
// above the buffer so they get clipped away, and the buffer keeps only
|
||||
// the bottom, visible rows. Drawing the frame this way, instead of
|
||||
// resizing the buffer to the full frame height and slicing its lines,
|
||||
// keeps the buffer's bounds stable across flushes.
|
||||
drawArea := s.cellbuf.Bounds()
|
||||
if !view.AltScreen && contentHeight > drawArea.Dy() {
|
||||
drawArea.Min.Y -= contentHeight - drawArea.Dy()
|
||||
}
|
||||
content.Draw(s.cellbuf, drawArea)
|
||||
|
||||
// Alt screen mode.
|
||||
shouldUpdateAltScreen := (s.lastView == nil && view.AltScreen) || (s.lastView != nil && s.lastView.AltScreen != view.AltScreen)
|
||||
|
|
@ -525,16 +545,10 @@ func (s *cursedRenderer) flush(closing bool) error {
|
|||
// parking here also commits the renderer to them: a frame ending
|
||||
// in intentional blank lines keeps its bottom margin, and output
|
||||
// printed after the program exits starts below the frame rather
|
||||
// than on its last visible line. Frames taller than the screen
|
||||
// have their top rows dropped, so their last visible row is the
|
||||
// screen's.
|
||||
y := frameArea.Dy() - 1
|
||||
if y >= s.height {
|
||||
y = s.height - 1
|
||||
}
|
||||
if y < 0 {
|
||||
y = 0
|
||||
}
|
||||
// than on its last visible line. The frame area is capped at the
|
||||
// screen height, so frames taller than the screen park on the
|
||||
// screen's last row, which is their last visible row.
|
||||
y := max(frameArea.Dy()-1, 0)
|
||||
s.scr.MoveTo(0, y)
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -163,11 +163,85 @@ func TestCursedRenderer_trailingBlankLinesTallFrame(t *testing.T) {
|
|||
if x, y := r.scr.Position(); x != 0 || y != 23 {
|
||||
t.Fatalf("cursor parked at (%d, %d), want (0, 23)", x, y)
|
||||
}
|
||||
|
||||
// An unchanged flush must be a no-op. The frame area is capped at the
|
||||
// screen height, so it stays equal to the screen buffer's bounds across
|
||||
// flushes. Otherwise every flush redraws the whole frame, which scrolls
|
||||
// the screen each time in terminals where the frame exceeds the visible
|
||||
// area, flooding the scrollback (notably in tmux).
|
||||
out.Reset()
|
||||
r.render(NewView(content))
|
||||
if err := r.flush(false); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if got := out.String(); got != "" {
|
||||
t.Fatalf("expected no output for unchanged tall frame, got %q", got)
|
||||
}
|
||||
|
||||
// A changed flush of a tall frame must redraw only the changed lines,
|
||||
// not the whole frame.
|
||||
out.Reset()
|
||||
changed := strings.Repeat("line\n", 29) + "CHANGED\n"
|
||||
r.render(NewView(changed))
|
||||
if err := r.flush(false); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
got := out.String()
|
||||
if !strings.Contains(got, "CHANGED") {
|
||||
t.Fatalf("expected changed line to be rendered, got %q", got)
|
||||
}
|
||||
if strings.Contains(got, ansi.EraseScreenBelow) || strings.Contains(got, "line\r\nline") {
|
||||
t.Fatalf("expected partial redraw for tall frame, got %q", got)
|
||||
}
|
||||
if err := r.close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
||||
// A view without a trailing newline has content on its last row. On exit
|
||||
// the cursor must move below that row so the closing erase and the shell
|
||||
// prompt that follows don't overwrite the frame's last line.
|
||||
func TestCursedRenderer_closeBelowFrameWithoutTrailingNewline(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var out bytes.Buffer
|
||||
r := newCursedRenderer(&out, []string{"TERM=xterm-256color"}, 80, 24)
|
||||
r.start()
|
||||
|
||||
r.render(NewView("hello"))
|
||||
if err := r.flush(false); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
out.Reset()
|
||||
if err := r.close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
got := out.String()
|
||||
// The cursor must go one row below the frame's last row before the
|
||||
// closing erase-below, so the erase (and the shell prompt) start below
|
||||
// the frame rather than on its last line.
|
||||
assertInOrder(t, got, "\r\n", ansi.EraseScreenBelow)
|
||||
if x, y := r.scr.Position(); x != 0 || y != 0 {
|
||||
t.Fatalf("cursor parked at (%d, %d), want (0, 0)", x, y)
|
||||
}
|
||||
|
||||
// A view ending in a newline already parks the cursor on the blank row
|
||||
// below the frame, so no extra newline is needed.
|
||||
out.Reset()
|
||||
r.start()
|
||||
r.render(NewView("hello\n"))
|
||||
if err := r.flush(false); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
out.Reset()
|
||||
if err := r.close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if got := out.String(); strings.Contains(got, "\r\n"+ansi.EraseScreenBelow) {
|
||||
t.Fatalf("expected no extra newline before closing erase, got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCursedRenderer_restoresKittyKeyboardStack(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
|
|
|
|||
3
testdata/TestClearMsg/bg_fg_cur_color.golden
vendored
3
testdata/TestClearMsg/bg_fg_cur_color.golden
vendored
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p]10;?]11;?]12;?
|
||||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p]10;?]11;?]12;?
|
||||
3
testdata/TestClearMsg/clear_screen.golden
vendored
3
testdata/TestClearMsg/clear_screen.golden
vendored
|
|
@ -1 +1,2 @@
|
|||
[?25l
[?2004h[>4;2m[>1u[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p
|
||||
[?25l
[?2004h[>4;2m[>1u[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p
|
||||
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p]52;c;?]52;c;c3VjY2Vzcw==
|
||||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p]52;c;?]52;c;c3VjY2Vzcw==
|
||||
3
testdata/TestViewModel/altscreen.golden
vendored
3
testdata/TestViewModel/altscreen.golden
vendored
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p
|
||||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p
|
||||
3
testdata/TestViewModel/bg_set_color.golden
vendored
3
testdata/TestViewModel/bg_set_color.golden
vendored
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>1u]11;#ffffff
[Jsuccess
[>4m[<1u[J[?25h[?2004l]111[?2026$p[?2027$p
|
||||
[?25l[?2004h[>4;2m[>1u]11;#ffffff
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l]111[?2026$p[?2027$p
|
||||
3
testdata/TestViewModel/bp_stop_start.golden
vendored
3
testdata/TestViewModel/bp_stop_start.golden
vendored
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p
|
||||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p
|
||||
3
testdata/TestViewModel/cursor_hide.golden
vendored
3
testdata/TestViewModel/cursor_hide.golden
vendored
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p
|
||||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p
|
||||
|
|
@ -1 +1,2 @@
|
|||
[?2004h[>4;2m[>1u[1 q
[Jsuccess
[?25h[>4m[<1u[J[?2004l[?2026$p[?2027$p
|
||||
[?2004h[>4;2m[>1u[1 q
[Jsuccess
[?25h[>4m[<1u
|
||||
[J[?2004l[?2026$p[?2027$p
|
||||
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>3u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p
|
||||
[?25l[?2004h[>4;2m[>3u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p
|
||||
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[?1003h[?1006h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?1002l[?1003l[?1006l[?2026$p[?2027$p
|
||||
[?25l[?2004h[?1003h[?1006h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?1002l[?1003l[?1006l[?2026$p[?2027$p
|
||||
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[?1002h[?1006h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?1002l[?1003l[?1006l[?2026$p[?2027$p
|
||||
[?25l[?2004h[?1002h[?1006h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?1002l[?1003l[?1006l[?2026$p[?2027$p
|
||||
3
testdata/TestViewModel/mouse_disable.golden
vendored
3
testdata/TestViewModel/mouse_disable.golden
vendored
|
|
@ -1 +1,2 @@
|
|||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u[J[?25h[?2004l[?2026$p[?2027$p
|
||||
[?25l[?2004h[>4;2m[>1u
[Jsuccess
[>4m[<1u
|
||||
[J[?25h[?2004l[?2026$p[?2027$p
|
||||
Loading…
Reference in a new issue