From c5df73b1da99df4e5a0a42df4c5a6b541f7cb129 Mon Sep 17 00:00:00 2001
From: Tim Culverhouse <tim@timculverhouse.com>
Date: Fri, 22 Sep 2023 21:10:19 -0500
Subject: [PATCH] terminal: erase pen, except bg, in eraseDisplay

When erasing the display, all attributes of the pen must be cleared
_except_ for the background. Add unit tests for erasing the display in
all scenarios.

Fixes: alacritty/clear_underline
---
 src/terminal/Terminal.zig | 124 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 123 insertions(+), 1 deletion(-)

diff --git a/src/terminal/Terminal.zig b/src/terminal/Terminal.zig
index f826f911a..e103a972e 100644
--- a/src/terminal/Terminal.zig
+++ b/src/terminal/Terminal.zig
@@ -1019,7 +1019,6 @@ pub fn setCursorColAbsolute(self: *Terminal, col_req: usize) void {
 }
 
 /// Erase the display.
-/// TODO: test
 pub fn eraseDisplay(
     self: *Terminal,
     alloc: Allocator,
@@ -1028,6 +1027,10 @@ pub fn eraseDisplay(
     const tracy = trace(@src());
     defer tracy.end();
 
+    // Erasing clears all attributes / colors _except_ the background
+    const bg = self.screen.cursor.pen.bg;
+    self.screen.cursor.pen = .{ .bg = bg };
+
     switch (mode) {
         .complete => {
             var it = self.screen.rowIterator(.active);
@@ -1106,6 +1109,125 @@ pub fn eraseDisplay(
     }
 }
 
+test "Terminal: eraseDisplay above" {
+    var t = try init(testing.allocator, 80, 80);
+    defer t.deinit(testing.allocator);
+
+    const pink = color.RGB{ .r = 0xFF, .g = 0x00, .b = 0x7F };
+    t.screen.cursor.pen = Screen.Cell{
+        .char = 'a',
+        .bg = pink,
+        .fg = pink,
+        .attrs = .{
+            .bold = true,
+        },
+    };
+    const cell_ptr = t.screen.getCellPtr(.active, 0, 0);
+    cell_ptr.* = t.screen.cursor.pen;
+    // verify the cell was set
+    var cell = t.screen.getCell(.active, 0, 0);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(pink));
+    try testing.expect(cell.char == 'a');
+    try testing.expect(cell.attrs.bold);
+    // move the cursor below it
+    t.screen.cursor.y = 40;
+    t.screen.cursor.x = 40;
+    // erase above the cursor
+    t.eraseDisplay(testing.allocator, .above);
+    // check it was erased
+    cell = t.screen.getCell(.active, 0, 0);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(.{}));
+    try testing.expect(cell.char == 0);
+    try testing.expect(!cell.attrs.bold);
+
+    // check that another cell got the correct bg
+    cell = t.screen.getCell(.active, 0, 1);
+    try testing.expect(cell.bg.eql(pink));
+}
+
+test "Terminal: eraseDisplay below" {
+    var t = try init(testing.allocator, 80, 80);
+    defer t.deinit(testing.allocator);
+
+    const pink = color.RGB{ .r = 0xFF, .g = 0x00, .b = 0x7F };
+    t.screen.cursor.pen = Screen.Cell{
+        .char = 'a',
+        .bg = pink,
+        .fg = pink,
+        .attrs = .{
+            .bold = true,
+        },
+    };
+    const cell_ptr = t.screen.getCellPtr(.active, 60, 60);
+    cell_ptr.* = t.screen.cursor.pen;
+    // verify the cell was set
+    var cell = t.screen.getCell(.active, 60, 60);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(pink));
+    try testing.expect(cell.char == 'a');
+    try testing.expect(cell.attrs.bold);
+    // erase below the cursor
+    t.eraseDisplay(testing.allocator, .below);
+    // check it was erased
+    cell = t.screen.getCell(.active, 60, 60);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(.{}));
+    try testing.expect(cell.char == 0);
+    try testing.expect(!cell.attrs.bold);
+
+    // check that another cell got the correct bg
+    cell = t.screen.getCell(.active, 0, 1);
+    try testing.expect(cell.bg.eql(pink));
+}
+
+test "Terminal: eraseDisplay complete" {
+    var t = try init(testing.allocator, 80, 80);
+    defer t.deinit(testing.allocator);
+
+    const pink = color.RGB{ .r = 0xFF, .g = 0x00, .b = 0x7F };
+    t.screen.cursor.pen = Screen.Cell{
+        .char = 'a',
+        .bg = pink,
+        .fg = pink,
+        .attrs = .{
+            .bold = true,
+        },
+    };
+    var cell_ptr = t.screen.getCellPtr(.active, 60, 60);
+    cell_ptr.* = t.screen.cursor.pen;
+    cell_ptr = t.screen.getCellPtr(.active, 0, 0);
+    cell_ptr.* = t.screen.cursor.pen;
+    // verify the cell was set
+    var cell = t.screen.getCell(.active, 60, 60);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(pink));
+    try testing.expect(cell.char == 'a');
+    try testing.expect(cell.attrs.bold);
+    // verify the cell was set
+    cell = t.screen.getCell(.active, 0, 0);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(pink));
+    try testing.expect(cell.char == 'a');
+    try testing.expect(cell.attrs.bold);
+    // position our cursor between the cells
+    t.screen.cursor.y = 30;
+    // erase everything
+    t.eraseDisplay(testing.allocator, .complete);
+    // check they were erased
+    cell = t.screen.getCell(.active, 60, 60);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(.{}));
+    try testing.expect(cell.char == 0);
+    try testing.expect(!cell.attrs.bold);
+    cell = t.screen.getCell(.active, 0, 0);
+    try testing.expect(cell.bg.eql(pink));
+    try testing.expect(cell.fg.eql(.{}));
+    try testing.expect(cell.char == 0);
+    try testing.expect(!cell.attrs.bold);
+}
+
 /// Erase the line.
 /// TODO: test
 pub fn eraseLine(