saorsa-tui 0.4.0

Retained-mode, CSS-styled terminal UI framework
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
//! Line composition — combines cuts, z-order, and chopping into final segment lists.

use crate::compositor::Layer;
use crate::compositor::chop::chop_segments;
use crate::compositor::cuts::find_cuts;
use crate::compositor::zorder::select_topmost;
use crate::segment::Segment;

/// Compose a single screen row by combining cut-finding, z-order selection, and segment chopping.
///
/// Returns a list of segments representing the final composed output for the given row.
///
/// # Algorithm
///
/// 1. Find cut points (x-offsets where layer edges create boundaries)
/// 2. For each interval between cuts:
///    - Select the topmost visible layer (if any)
///    - Extract and chop the relevant segments from that layer
///    - Append to the result
/// 3. Fill gaps with blank segments where no layer is visible
///
/// # Example
///
/// ```
/// use saorsa_tui::compositor::layer::Layer;
/// use saorsa_tui::compositor::compose::compose_line;
/// use saorsa_tui::geometry::Rect;
/// use saorsa_tui::segment::Segment;
///
/// let layer1 = Layer::new(1, Rect::new(0, 0, 40, 10), 0, vec![
///     vec![Segment::new("Hello")],
/// ]);
/// let layer2 = Layer::new(2, Rect::new(50, 0, 30, 10), 1, vec![
///     vec![Segment::new("World")],
/// ]);
///
/// let layers = vec![layer1, layer2];
/// let segments = compose_line(&layers, 0, 80);
///
/// // Result contains segments from both layers, with blank gap in between
/// assert!(segments.len() >= 3); // layer1, blank, layer2
/// ```
pub fn compose_line(layers: &[Layer], row: u16, screen_width: u16) -> Vec<Segment> {
    let mut result = Vec::new();

    // Find all cut points for this row
    let cuts = find_cuts(layers, row, screen_width);

    // If no cuts or only screen boundaries, return blank line
    if cuts.len() <= 1 {
        if screen_width > 0 {
            result.push(Segment::new(" ".repeat(screen_width as usize)));
        }
        return result;
    }

    // Process each interval between consecutive cuts
    for i in 0..cuts.len() - 1 {
        let x_start = cuts[i];
        let x_end = cuts[i + 1];
        let width = x_end - x_start;

        if width == 0 {
            continue;
        }

        // Find the topmost layer that covers this interval
        match select_topmost(layers, row, x_start, x_end) {
            Some(layer_idx) => {
                // Get the layer and its line for this row
                let layer = &layers[layer_idx];

                match layer.line_for_row(row) {
                    Some(line_segments) => {
                        // Chop the segments to extract just the interval we need
                        let chopped =
                            chop_segments(line_segments, layer.region.position.x, x_start, width);
                        result.extend(chopped);
                    }
                    None => {
                        // Layer claims to contain this row but has no line data
                        result.push(Segment::new(" ".repeat(width as usize)));
                    }
                }
            }
            None => {
                // No layer covers this interval — fill with blank
                result.push(Segment::new(" ".repeat(width as usize)));
            }
        }
    }

    result
}

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

    #[test]
    fn single_layer_full_width() {
        let layer = Layer::new(
            1,
            Rect::new(0, 0, 80, 10),
            0,
            vec![vec![Segment::new("Hello, world!")]],
        );
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 80);

        // Should contain the text from the layer
        let found_text = segments.iter().any(|s| s.text.contains("Hello, world!"));
        assert!(found_text);
    }

    #[test]
    fn two_layers_side_by_side() {
        let layer1 = Layer::new(
            1,
            Rect::new(0, 0, 40, 10),
            0,
            vec![vec![Segment::new("Left")]],
        );
        let layer2 = Layer::new(
            2,
            Rect::new(40, 0, 40, 10),
            0,
            vec![vec![Segment::new("Right")]],
        );
        let layers = vec![layer1, layer2];

        let segments = compose_line(&layers, 0, 80);

        // Should have at least 2 segments (one from each layer)
        assert!(segments.len() >= 2);

        // First segment should be from layer1
        let found_left = segments.iter().any(|s| s.text.contains("Left"));
        assert!(found_left);

        // Second segment should be from layer2
        let found_right = segments.iter().any(|s| s.text.contains("Right"));
        assert!(found_right);
    }

    #[test]
    fn overlapping_layers_topmost_wins() {
        let layer1 = Layer::new(
            1,
            Rect::new(0, 0, 80, 10),
            0,
            vec![vec![Segment::new("Background")]],
        );
        let layer2 = Layer::new(
            2,
            Rect::new(10, 0, 20, 10),
            10,
            vec![vec![Segment::new("Overlay")]],
        );
        let layers = vec![layer1, layer2];

        let segments = compose_line(&layers, 0, 80);

        // Should contain "Overlay" from the higher z-index layer
        let found_overlay = segments.iter().any(|s| s.text.contains("Overlay"));
        assert!(found_overlay);
    }

    #[test]
    fn gap_between_layers_filled_with_blank() {
        let layer1 = Layer::new(1, Rect::new(0, 0, 10, 10), 0, vec![vec![Segment::new("A")]]);
        let layer2 = Layer::new(
            2,
            Rect::new(30, 0, 10, 10),
            0,
            vec![vec![Segment::new("B")]],
        );
        let layers = vec![layer1, layer2];

        let segments = compose_line(&layers, 0, 80);

        // Should have segments: layer1, blank gap, layer2, blank to screen end
        assert!(segments.len() >= 3);

        // Check for blank segment (either empty or all spaces)
        let has_blank = segments.iter().any(|s| s.text.trim().is_empty());
        assert!(has_blank);
    }

    #[test]
    fn layer_extends_beyond_screen_clipped() {
        let layer = Layer::new(
            1,
            Rect::new(70, 0, 20, 10),
            0,
            vec![vec![Segment::new("Very long text that exceeds screen")]],
        );
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 80);

        // Should clip at screen edge (x=80)
        let total_width: usize = segments.iter().map(|s| s.width()).sum();
        assert!(total_width <= 80);
    }

    #[test]
    fn empty_row_no_layers() {
        let layers: Vec<Layer> = vec![];

        let segments = compose_line(&layers, 0, 80);

        // Should return single blank segment
        assert!(segments.len() == 1);
        assert!(segments[0].text.trim().is_empty());
        assert!(segments[0].width() == 80);
    }

    #[test]
    fn layer_on_different_row_ignored() {
        let layer = Layer::new(
            1,
            Rect::new(0, 10, 80, 5),
            0,
            vec![vec![Segment::new("Not on row 0")]],
        );
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 80);

        // Layer doesn't intersect row 0, should get blank line
        assert!(segments.len() == 1);
        assert!(segments[0].text.trim().is_empty());
    }

    #[test]
    fn zero_width_screen() {
        let layer = Layer::new(1, Rect::new(0, 0, 10, 10), 0, vec![vec![Segment::new("X")]]);
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 0);

        // Zero width screen returns empty result
        assert!(segments.is_empty());
    }

    #[test]
    fn styled_segment_preserved() {
        use crate::color::{Color, NamedColor};
        use crate::style::Style;

        let style = Style {
            fg: Some(Color::Named(NamedColor::Red)),
            ..Default::default()
        };

        let mut seg = Segment::new("Styled");
        seg.style = style.clone();

        let layer = Layer::new(1, Rect::new(0, 0, 20, 10), 0, vec![vec![seg.clone()]]);
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 80);

        // Find the styled segment
        let found_styled = segments.iter().any(|s| {
            s.text.contains("Styled")
                && s.style.fg.is_some()
                && matches!(s.style.fg, Some(Color::Named(NamedColor::Red)))
        });
        assert!(found_styled);
    }

    #[test]
    fn multiple_segments_in_layer() {
        let layer = Layer::new(
            1,
            Rect::new(0, 0, 80, 10),
            0,
            vec![vec![
                Segment::new("Hello "),
                Segment::new("world"),
                Segment::new("!"),
            ]],
        );
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 80);

        // Should contain all parts
        let combined: String = segments.iter().map(|s| s.text.as_str()).collect();
        assert!(combined.contains("Hello"));
        assert!(combined.contains("world"));
    }

    #[test]
    fn three_overlapping_layers_z_order() {
        let layer1 = Layer::new(
            1,
            Rect::new(0, 0, 80, 10),
            0,
            vec![vec![Segment::new("Bottom")]],
        );
        let layer2 = Layer::new(
            2,
            Rect::new(10, 0, 60, 10),
            5,
            vec![vec![Segment::new("Middle")]],
        );
        let layer3 = Layer::new(
            3,
            Rect::new(20, 0, 40, 10),
            10,
            vec![vec![Segment::new("Top")]],
        );
        let layers = vec![layer1, layer2, layer3];

        let segments = compose_line(&layers, 0, 80);

        // Should contain "Top" from highest z-index layer in the center
        let found_top = segments.iter().any(|s| s.text.contains("Top"));
        assert!(found_top);
    }

    // --- Unicode edge case tests ---

    #[test]
    fn compose_cjk_text_at_overlap_boundary() {
        // Bottom layer: "世界人" (width 6) starting at x=0
        let layer1 = Layer::new(
            1,
            Rect::new(0, 0, 20, 1),
            0,
            vec![vec![Segment::new("\u{4e16}\u{754c}\u{4eba}")]],
        );
        // Top layer overlaps starting at x=3 (mid-wide-char boundary of 界)
        let layer2 = Layer::new(
            2,
            Rect::new(3, 0, 5, 1),
            10,
            vec![vec![Segment::new("XXXXX")]],
        );
        let layers = vec![layer1, layer2];

        let segments = compose_line(&layers, 0, 20);

        // The result should have proper width = 20 total
        let total_width: usize = segments.iter().map(|s| s.width()).sum();
        assert_eq!(total_width, 20);

        // The overlay "XXXXX" should appear in the output
        let combined: String = segments.iter().map(|s| s.text.as_str()).collect();
        assert!(combined.contains("XXXXX"));
    }

    #[test]
    fn compose_combining_marks_at_layer_boundary() {
        // Layer with text containing combining marks
        let layer1 = Layer::new(
            1,
            Rect::new(0, 0, 20, 1),
            0,
            vec![vec![Segment::new("ae\u{0301}bc")]],
        );
        let layers = vec![layer1];

        let segments = compose_line(&layers, 0, 20);

        // The combined text should contain the combining mark attached to 'e'
        let combined: String = segments.iter().map(|s| s.text.as_str()).collect();
        assert!(combined.contains("e\u{0301}") || combined.contains('a'));
        let total_width: usize = segments.iter().map(|s| s.width()).sum();
        assert_eq!(total_width, 20);
    }

    #[test]
    fn compose_empty_segments_in_layers() {
        // Layer has some empty segments mixed in
        let layer = Layer::new(
            1,
            Rect::new(0, 0, 20, 1),
            0,
            vec![vec![
                Segment::new(""),
                Segment::new("Hello"),
                Segment::new(""),
                Segment::new(" World"),
            ]],
        );
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 20);

        let combined: String = segments.iter().map(|s| s.text.as_str()).collect();
        assert!(combined.contains("Hello"));
        assert!(combined.contains("World"));
        let total_width: usize = segments.iter().map(|s| s.width()).sum();
        assert_eq!(total_width, 20);
    }

    #[test]
    fn compose_very_long_grapheme_clusters() {
        // Use a ZWJ family emoji (multi-codepoint, width 2)
        let emoji = "\u{1F468}\u{200D}\u{1F469}\u{200D}\u{1F467}";
        let text = format!("A{}B", emoji);
        let layer = Layer::new(1, Rect::new(0, 0, 20, 1), 0, vec![vec![Segment::new(text)]]);
        let layers = vec![layer];

        let segments = compose_line(&layers, 0, 20);

        // Output should have total width 20
        let total_width: usize = segments.iter().map(|s| s.width()).sum();
        assert_eq!(total_width, 20);

        // Should contain the emoji in some form
        let combined: String = segments.iter().map(|s| s.text.as_str()).collect();
        assert!(combined.contains('A'));
        assert!(combined.contains('B'));
    }
}