opentui_rust 0.2.1

High-performance terminal UI rendering engine with alpha blending and diffed buffers
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
//! Hit testing grid for mouse events.

/// A hit testing grid that maps screen positions to widget IDs.
#[derive(Clone, Debug)]
pub struct HitGrid {
    width: u32,
    height: u32,
    cells: Vec<Option<u32>>,
}

impl HitGrid {
    /// Create a new hit grid with the given dimensions.
    ///
    /// Uses saturating multiplication to prevent overflow for extremely large dimensions.
    #[must_use]
    pub fn new(width: u32, height: u32) -> Self {
        let size = (width as usize).saturating_mul(height as usize);
        Self {
            width,
            height,
            cells: vec![None; size],
        }
    }

    /// Compute cell index with overflow protection.
    #[inline]
    fn cell_index(&self, x: u32, y: u32) -> Option<usize> {
        if x >= self.width || y >= self.height {
            return None;
        }
        let row_offset = (y as usize).checked_mul(self.width as usize)?;
        let idx = row_offset.checked_add(x as usize)?;
        if idx < self.cells.len() {
            Some(idx)
        } else {
            None
        }
    }

    /// Clear all hit areas.
    pub fn clear(&mut self) {
        self.cells.fill(None);
    }

    /// Register a hit area.
    pub fn register(&mut self, x: u32, y: u32, width: u32, height: u32, id: u32) {
        for row in y..y.saturating_add(height).min(self.height) {
            for col in x..x.saturating_add(width).min(self.width) {
                if let Some(idx) = self.cell_index(col, row) {
                    self.cells[idx] = Some(id);
                }
            }
        }
    }

    /// Overlay another hit grid onto this grid.
    ///
    /// For each cell, if `overlay` contains an ID, it overwrites this grid's cell.
    ///
    /// This is useful for layer compositing where higher layers should override hit
    /// IDs, but empty cells should allow "click-through" to lower layers.
    pub fn overlay(&mut self, overlay: &Self) {
        if self.width != overlay.width || self.height != overlay.height {
            return;
        }
        for (dst, src) in self.cells.iter_mut().zip(&overlay.cells) {
            if src.is_some() {
                *dst = *src;
            }
        }
    }

    /// Test which ID is at a position.
    #[must_use]
    pub fn test(&self, x: u32, y: u32) -> Option<u32> {
        self.cell_index(x, y).and_then(|idx| self.cells[idx])
    }

    /// Resize the grid, clearing all hit areas.
    ///
    /// Uses saturating multiplication to prevent overflow for extremely large dimensions.
    pub fn resize(&mut self, width: u32, height: u32) {
        self.width = width;
        self.height = height;
        let size = (width as usize).saturating_mul(height as usize);
        self.cells = vec![None; size];
    }

    /// Get dimensions.
    #[must_use]
    pub fn size(&self) -> (u32, u32) {
        (self.width, self.height)
    }

    /// Estimated byte size of the hit grid storage.
    #[must_use]
    pub fn byte_size(&self) -> usize {
        self.cells.len() * std::mem::size_of::<Option<u32>>()
    }
}

impl Default for HitGrid {
    fn default() -> Self {
        Self::new(80, 24)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    // ============================================
    // Basic Hit Grid Tests
    // ============================================

    #[test]
    fn test_hit_grid_new() {
        let grid = HitGrid::new(80, 24);
        assert_eq!(grid.size(), (80, 24));
    }

    #[test]
    fn test_hit_grid_default() {
        let grid = HitGrid::default();
        assert_eq!(grid.size(), (80, 24));
    }

    #[test]
    fn test_hit_grid_basic() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(10, 10, 20, 10, 42);

        assert_eq!(grid.test(15, 15), Some(42));
        assert_eq!(grid.test(29, 19), Some(42));
        assert_eq!(grid.test(30, 20), None);
        assert_eq!(grid.test(5, 5), None);
    }

    #[test]
    fn test_hit_grid_single_cell() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(50, 25, 1, 1, 100);

        assert_eq!(grid.test(50, 25), Some(100));
        assert_eq!(grid.test(49, 25), None);
        assert_eq!(grid.test(51, 25), None);
        assert_eq!(grid.test(50, 24), None);
        assert_eq!(grid.test(50, 26), None);
    }

    // ============================================
    // Overlap Tests
    // ============================================

    #[test]
    fn test_hit_grid_overlap() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 20, 20, 1);
        grid.register(10, 10, 20, 20, 2);

        // Later registration wins in overlap area
        assert_eq!(grid.test(5, 5), Some(1));
        assert_eq!(grid.test(15, 15), Some(2));
    }

    #[test]
    fn test_hit_grid_complete_overlap() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 50, 50, 1);
        grid.register(0, 0, 50, 50, 2);

        // Second registration completely overwrites
        assert_eq!(grid.test(0, 0), Some(2));
        assert_eq!(grid.test(25, 25), Some(2));
        assert_eq!(grid.test(49, 49), Some(2));
    }

    #[test]
    fn test_hit_grid_nested_regions() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 30, 30, 1); // Outer
        grid.register(10, 10, 10, 10, 2); // Inner

        assert_eq!(grid.test(5, 5), Some(1)); // Outer only
        assert_eq!(grid.test(15, 15), Some(2)); // Inner overwrites
        assert_eq!(grid.test(25, 25), Some(1)); // Outer only
    }

    #[test]
    fn test_hit_grid_multiple_non_overlapping() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 10, 10, 1);
        grid.register(20, 0, 10, 10, 2);
        grid.register(40, 0, 10, 10, 3);

        assert_eq!(grid.test(5, 5), Some(1));
        assert_eq!(grid.test(25, 5), Some(2));
        assert_eq!(grid.test(45, 5), Some(3));
        assert_eq!(grid.test(15, 5), None); // Gap
    }

    // ============================================
    // Clear Tests
    // ============================================

    #[test]
    fn test_hit_grid_clear() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 50, 50, 1);
        assert_eq!(grid.test(25, 25), Some(1));

        grid.clear();
        assert_eq!(grid.test(25, 25), None);
    }

    #[test]
    fn test_hit_grid_clear_then_register() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 50, 50, 1);
        grid.clear();
        grid.register(0, 0, 50, 50, 2);

        assert_eq!(grid.test(25, 25), Some(2));
    }

    // ============================================
    // Bounds Tests
    // ============================================

    #[test]
    fn test_hit_grid_bounds() {
        let grid = HitGrid::new(100, 50);
        assert_eq!(grid.test(100, 50), None);
        assert_eq!(grid.test(1000, 1000), None);
    }

    #[test]
    fn test_hit_grid_register_at_edge() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(99, 49, 1, 1, 1);

        assert_eq!(grid.test(99, 49), Some(1));
        assert_eq!(grid.test(100, 49), None); // Out of bounds
        assert_eq!(grid.test(99, 50), None); // Out of bounds
    }

    #[test]
    fn test_hit_grid_register_extends_beyond() {
        let mut grid = HitGrid::new(100, 50);
        // Register area that extends beyond grid
        grid.register(90, 40, 20, 20, 1);

        // Should only be registered within bounds
        assert_eq!(grid.test(95, 45), Some(1));
        assert_eq!(grid.test(99, 49), Some(1));
        assert_eq!(grid.test(100, 50), None);
    }

    #[test]
    fn test_hit_grid_register_completely_out_of_bounds() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(200, 200, 10, 10, 1);

        // Nothing should be registered
        assert_eq!(grid.test(200, 200), None);
        assert_eq!(grid.test(0, 0), None);
    }

    // ============================================
    // Resize Tests
    // ============================================

    #[test]
    fn test_hit_grid_resize_clears() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 50, 50, 1);
        assert_eq!(grid.test(25, 25), Some(1));

        grid.resize(80, 24);
        assert_eq!(grid.size(), (80, 24));
        assert_eq!(grid.test(25, 25), None); // Cleared
    }

    #[test]
    fn test_hit_grid_resize_larger() {
        let mut grid = HitGrid::new(10, 10);
        grid.resize(100, 100);

        assert_eq!(grid.size(), (100, 100));
        assert_eq!(grid.test(50, 50), None);

        grid.register(50, 50, 10, 10, 1);
        assert_eq!(grid.test(55, 55), Some(1));
    }

    #[test]
    fn test_hit_grid_resize_smaller() {
        let mut grid = HitGrid::new(100, 100);
        grid.resize(10, 10);

        assert_eq!(grid.size(), (10, 10));
        // Out of bounds after resize
        assert_eq!(grid.test(50, 50), None);
    }

    // ============================================
    // Edge Case Tests
    // ============================================

    #[test]
    fn test_hit_grid_zero_size_region() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(50, 25, 0, 0, 1);

        // Zero-size region should register nothing
        assert_eq!(grid.test(50, 25), None);
    }

    #[test]
    fn test_hit_grid_origin() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(0, 0, 5, 5, 1);

        assert_eq!(grid.test(0, 0), Some(1));
    }

    #[test]
    fn test_hit_grid_byte_size() {
        let grid = HitGrid::new(100, 50);
        let expected = 100 * 50 * std::mem::size_of::<Option<u32>>();
        assert_eq!(grid.byte_size(), expected);
    }

    #[test]
    fn test_hit_grid_many_widgets() {
        let mut grid = HitGrid::new(100, 100);

        // Register 100 small widgets
        for i in 0..10 {
            for j in 0..10 {
                let id = i * 10 + j;
                grid.register(i * 10, j * 10, 8, 8, id);
            }
        }

        // Test a few
        assert_eq!(grid.test(5, 5), Some(0));
        assert_eq!(grid.test(15, 15), Some(11));
        assert_eq!(grid.test(95, 95), Some(99));
    }

    #[test]
    fn test_hit_grid_border_cells() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(10, 10, 20, 10, 1);

        // Test exact border cells
        assert_eq!(grid.test(10, 10), Some(1)); // Top-left
        assert_eq!(grid.test(29, 10), Some(1)); // Top-right
        assert_eq!(grid.test(10, 19), Some(1)); // Bottom-left
        assert_eq!(grid.test(29, 19), Some(1)); // Bottom-right

        // Just outside
        assert_eq!(grid.test(9, 10), None);
        assert_eq!(grid.test(30, 10), None);
        assert_eq!(grid.test(10, 9), None);
        assert_eq!(grid.test(10, 20), None);
    }

    // ============================================
    // Performance/Stress Tests
    // ============================================

    #[test]
    fn test_hit_grid_large_dimensions() {
        let grid = HitGrid::new(1000, 500);
        assert_eq!(grid.size(), (1000, 500));
        assert_eq!(grid.test(999, 499), None);
    }

    #[test]
    fn test_hit_grid_full_coverage() {
        let mut grid = HitGrid::new(10, 10);
        grid.register(0, 0, 10, 10, 42);

        // Every cell should have the ID
        for y in 0..10 {
            for x in 0..10 {
                assert_eq!(grid.test(x, y), Some(42), "Failed at ({x}, {y})");
            }
        }
    }

    // ============================================
    // Additional Tests per bd-1rxc Requirements
    // ============================================

    #[test]
    fn test_hit_grid_adjacent_regions() {
        // Test regions that touch but don't overlap
        let mut grid = HitGrid::new(100, 50);

        // Two adjacent regions horizontally
        grid.register(0, 0, 10, 10, 1);
        grid.register(10, 0, 10, 10, 2); // Starts where first ends

        // Both should be registered correctly
        assert_eq!(grid.test(9, 5), Some(1)); // Last cell of first region
        assert_eq!(grid.test(10, 5), Some(2)); // First cell of second region

        // Gap between them should not exist (they're adjacent)
        assert_eq!(grid.test(5, 5), Some(1));
        assert_eq!(grid.test(15, 5), Some(2));
    }

    #[test]
    fn test_hit_grid_adjacent_vertical() {
        let mut grid = HitGrid::new(100, 50);

        // Two adjacent regions vertically
        grid.register(0, 0, 10, 10, 1);
        grid.register(0, 10, 10, 10, 2); // Starts where first ends

        assert_eq!(grid.test(5, 9), Some(1)); // Last row of first
        assert_eq!(grid.test(5, 10), Some(2)); // First row of second
    }

    #[test]
    fn test_hit_grid_widget_ids_are_preserved() {
        // Test that arbitrary widget IDs are preserved correctly
        let mut grid = HitGrid::new(100, 50);

        // Use various ID values including edge cases
        grid.register(0, 0, 5, 5, 0); // ID 0
        grid.register(10, 0, 5, 5, 1); // ID 1
        grid.register(20, 0, 5, 5, u32::MAX); // Max ID
        grid.register(30, 0, 5, 5, 12345); // Arbitrary ID

        assert_eq!(grid.test(2, 2), Some(0));
        assert_eq!(grid.test(12, 2), Some(1));
        assert_eq!(grid.test(22, 2), Some(u32::MAX));
        assert_eq!(grid.test(32, 2), Some(12345));
    }

    #[test]
    fn test_hit_grid_max_coordinate_values() {
        // Test with maximum valid coordinates
        let grid = HitGrid::new(u32::MAX / 2, 2);
        assert_eq!(grid.size(), (u32::MAX / 2, 2));

        // Should not panic on large coordinate queries
        let result = grid.test(u32::MAX, u32::MAX);
        assert_eq!(result, None);
    }

    #[test]
    fn test_hit_grid_diagonal_layout() {
        // Test diagonal arrangement of widgets
        let mut grid = HitGrid::new(50, 50);

        for i in 0..5 {
            grid.register(i * 10, i * 10, 5, 5, i);
        }

        // Test each diagonal region
        assert_eq!(grid.test(2, 2), Some(0));
        assert_eq!(grid.test(12, 12), Some(1));
        assert_eq!(grid.test(22, 22), Some(2));
        assert_eq!(grid.test(32, 32), Some(3));
        assert_eq!(grid.test(42, 42), Some(4));

        // Test gaps between diagonal regions
        assert_eq!(grid.test(7, 7), None);
        assert_eq!(grid.test(17, 17), None);
    }

    #[test]
    fn test_hit_grid_row_of_widgets() {
        // Test a horizontal row of widgets with gaps
        let mut grid = HitGrid::new(100, 20);

        for i in 0..5 {
            grid.register(i * 20, 5, 15, 10, i);
        }

        // Test each widget
        for i in 0..5 {
            let x = i * 20 + 7;
            assert_eq!(grid.test(x, 10), Some(i));
        }

        // Test gaps
        for i in 0..5 {
            let gap_x = i * 20 + 17; // In the gap
            if gap_x < 100 {
                assert_eq!(
                    grid.test(gap_x, 10),
                    None,
                    "Gap at x={gap_x} should be empty"
                );
            }
        }
    }

    #[test]
    fn test_hit_grid_column_of_widgets() {
        // Test a vertical column of widgets with gaps
        let mut grid = HitGrid::new(20, 100);

        for i in 0..5 {
            grid.register(5, i * 20, 10, 15, i);
        }

        // Test each widget
        for i in 0..5 {
            let y = i * 20 + 7;
            assert_eq!(grid.test(10, y), Some(i));
        }

        // Test gaps
        for i in 0..5 {
            let gap_y = i * 20 + 17; // In the gap
            if gap_y < 100 {
                assert_eq!(
                    grid.test(10, gap_y),
                    None,
                    "Gap at y={gap_y} should be empty"
                );
            }
        }
    }

    #[test]
    fn test_hit_grid_registration_order_matters() {
        // Verify that later registrations overwrite earlier ones
        let mut grid = HitGrid::new(100, 50);

        // Register same area multiple times with different IDs
        grid.register(10, 10, 20, 20, 100);
        grid.register(10, 10, 20, 20, 200);
        grid.register(10, 10, 20, 20, 300);

        // Final registration should win
        assert_eq!(grid.test(20, 20), Some(300));
    }

    #[test]
    fn test_hit_grid_partial_overlap_chain() {
        // Test chain of partially overlapping regions
        let mut grid = HitGrid::new(100, 50);

        // Each region overlaps with the previous one by half
        grid.register(0, 0, 20, 20, 1);
        grid.register(10, 0, 20, 20, 2);
        grid.register(20, 0, 20, 20, 3);

        // Unique areas
        assert_eq!(grid.test(5, 10), Some(1)); // Only in region 1
        assert_eq!(grid.test(35, 10), Some(3)); // Only in region 3

        // Overlap areas (later wins)
        assert_eq!(grid.test(15, 10), Some(2)); // Overlap 1&2, 2 wins
        assert_eq!(grid.test(25, 10), Some(3)); // Overlap 2&3, 3 wins
    }

    #[test]
    fn test_hit_grid_clone() {
        let mut grid = HitGrid::new(100, 50);
        grid.register(10, 10, 20, 20, 42);

        let cloned = grid.clone();

        // Cloned grid should have same content
        assert_eq!(cloned.size(), grid.size());
        assert_eq!(cloned.test(15, 15), Some(42));

        // Modifications to original shouldn't affect clone
        grid.clear();
        assert_eq!(cloned.test(15, 15), Some(42));
        assert_eq!(grid.test(15, 15), None);
    }

    #[test]
    fn test_hit_grid_1x1_dimensions() {
        // Smallest possible grid
        let mut grid = HitGrid::new(1, 1);
        assert_eq!(grid.size(), (1, 1));

        grid.register(0, 0, 1, 1, 99);
        assert_eq!(grid.test(0, 0), Some(99));
        assert_eq!(grid.test(1, 0), None); // Out of bounds
        assert_eq!(grid.test(0, 1), None); // Out of bounds
    }

    #[test]
    fn test_hit_grid_only_width() {
        // Very wide but short grid (1 row)
        let mut grid = HitGrid::new(1000, 1);
        grid.register(500, 0, 100, 1, 1);

        assert_eq!(grid.test(550, 0), Some(1));
        assert_eq!(grid.test(400, 0), None);
        assert_eq!(grid.test(700, 0), None);
    }

    #[test]
    fn test_hit_grid_only_height() {
        // Very tall but narrow grid (1 column)
        let mut grid = HitGrid::new(1, 1000);
        grid.register(0, 500, 1, 100, 1);

        assert_eq!(grid.test(0, 550), Some(1));
        assert_eq!(grid.test(0, 400), None);
        assert_eq!(grid.test(0, 700), None);
    }
}