From 9d826d8837f1d8d4bfec048158e106cac4cb4ad0 Mon Sep 17 00:00:00 2001
From: Mitchell Hashimoto <mitchell.hashimoto@gmail.com>
Date: Wed, 20 Mar 2024 16:18:29 -0700
Subject: [PATCH] terminal: add assertion for trackPin as commented

---
 src/terminal/PageList.zig | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/src/terminal/PageList.zig b/src/terminal/PageList.zig
index 7fe25bdc1..fc4683f79 100644
--- a/src/terminal/PageList.zig
+++ b/src/terminal/PageList.zig
@@ -1986,7 +1986,7 @@ pub fn pin(self: *const PageList, pt: point.Point) ?Pin {
 /// pin points to is removed completely, the tracked pin will be updated
 /// to the top-left of the screen.
 pub fn trackPin(self: *PageList, p: Pin) !*Pin {
-    // TODO: assert pin is valid
+    if (comptime std.debug.runtime_safety) assert(self.pinIsValid(p));
 
     // Create our tracked pin
     const tracked = try self.pool.pins.create();
@@ -2012,6 +2012,20 @@ pub fn countTrackedPins(self: *const PageList) usize {
     return self.tracked_pins.count();
 }
 
+/// Checks if a pin is valid for this pagelist. This is a very slow and
+/// expensive operation since we traverse the entire linked list in the
+/// worst case. Only for runtime safety/debug.
+fn pinIsValid(self: *const PageList, p: Pin) bool {
+    var it = self.pages.first;
+    while (it) |page| : (it = page.next) {
+        if (page != p.page) continue;
+        return p.y < page.data.size.rows and
+            p.x < page.data.size.cols;
+    }
+
+    return false;
+}
+
 /// Returns the viewport for the given pin, prefering to pin to
 /// "active" if the pin is within the active area.
 fn pinIsActive(self: *const PageList, p: Pin) bool {