romm-tui 1.5.0

Terminal UI for the RomM API
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
use ratatui::layout::{Constraint, Layout, Rect};
use ratatui::widgets::{Cell, Paragraph, Row, Table};
use ratatui::Frame;

use crate::tui::footer_hint::{render_footer_panel, FooterHintEntry};
use crate::tui::theme::RommStyles;
use romm_api::core::utils::{self, RomGroup};
use romm_api::types::{Rom, RomList};

/// Full-text search screen over ROMs, with grouped results.
pub struct SearchScreen {
    pub query: String,
    pub cursor_pos: usize,
    pub results: Option<RomList>,
    /// One row per game name (base + updates/DLC grouped).
    pub result_groups: Option<Vec<RomGroup>>,
    /// Query string used for the API call that produced [`Self::result_groups`], if any.
    pub last_searched_query: Option<String>,
    pub selected: usize,
    pub scroll_offset: usize,
    visible_rows: usize,
    pub loading: bool,
}

impl Default for SearchScreen {
    fn default() -> Self {
        Self::new()
    }
}

impl SearchScreen {
    pub fn new() -> Self {
        Self {
            query: String::new(),
            cursor_pos: 0,
            results: None,
            result_groups: None,
            last_searched_query: None,
            selected: 0,
            scroll_offset: 0,
            visible_rows: 15,
            loading: false,
        }
    }

    pub fn add_char(&mut self, c: char) {
        let pos = clamp_to_char_boundary(&self.query, self.cursor_pos);
        self.query.insert(pos, c);
        self.cursor_pos = pos + c.len_utf8();
    }

    pub fn delete_char(&mut self) {
        let pos = clamp_to_char_boundary(&self.query, self.cursor_pos);
        if pos > 0 {
            let prev = previous_char_boundary(&self.query, pos);
            self.query.remove(prev);
            self.cursor_pos = prev;
        }
    }

    pub fn cursor_left(&mut self) {
        self.cursor_pos = previous_char_boundary(&self.query, self.cursor_pos);
    }

    pub fn cursor_right(&mut self) {
        self.cursor_pos = next_char_boundary(&self.query, self.cursor_pos);
    }

    pub fn set_results(&mut self, results: RomList) {
        self.set_results_for_query(self.query.clone(), results);
    }

    pub fn set_results_for_query(&mut self, query: String, results: RomList) {
        let query_changed = self.last_searched_query.as_ref() != Some(&query);
        let selected_key = if query_changed {
            None
        } else {
            self.result_groups
                .as_ref()
                .and_then(|groups| groups.get(self.selected))
                .map(|group| (group.name.clone(), group.primary.platform_id))
        };
        self.results = Some(results.clone());
        self.result_groups = Some(utils::group_roms_by_name(&results.items));
        self.last_searched_query = Some(query);
        if query_changed {
            self.selected = 0;
            self.scroll_offset = 0;
        } else if let Some(groups) = self.result_groups.as_ref() {
            if let Some((name, platform_id)) = selected_key {
                if let Some(index) = groups
                    .iter()
                    .position(|g| g.name == name && g.primary.platform_id == platform_id)
                {
                    self.selected = index;
                } else if self.selected >= groups.len() {
                    self.selected = 0;
                    self.scroll_offset = 0;
                }
            } else if self.selected >= groups.len() {
                self.selected = 0;
                self.scroll_offset = 0;
            }
            self.update_scroll(self.visible_rows);
        }
    }

    pub fn clear_results(&mut self) {
        self.results = None;
        self.result_groups = None;
        self.last_searched_query = None;
        self.selected = 0;
        self.scroll_offset = 0;
    }

    /// True when the on-screen results were fetched for the current `query` string.
    pub fn results_match_current_query(&self) -> bool {
        self.last_searched_query.as_deref() == Some(self.query.as_str())
    }

    pub fn next(&mut self) {
        if let Some(ref g) = self.result_groups {
            if !g.is_empty() {
                self.selected = (self.selected + 1) % g.len();
                self.update_scroll(self.visible_rows);
            }
        }
    }

    pub fn previous(&mut self) {
        if let Some(ref g) = self.result_groups {
            if !g.is_empty() {
                self.selected = if self.selected == 0 {
                    g.len() - 1
                } else {
                    self.selected - 1
                };
                self.update_scroll(self.visible_rows);
            }
        }
    }

    fn update_scroll(&mut self, visible: usize) {
        if let Some(ref g) = self.result_groups {
            let visible = visible.max(1);
            let max_scroll = g.len().saturating_sub(visible);
            if self.selected >= self.scroll_offset + visible {
                self.scroll_offset = (self.selected + 1).saturating_sub(visible);
            } else if self.selected < self.scroll_offset {
                self.scroll_offset = self.selected;
            }
            self.scroll_offset = self.scroll_offset.min(max_scroll);
        }
    }

    /// Primary ROM and other files (updates/DLC) for the selected game.
    pub fn get_selected_group(&self) -> Option<(Rom, Vec<Rom>)> {
        self.result_groups
            .as_ref()
            .and_then(|g| g.get(self.selected))
            .map(|g| (g.primary.clone(), g.others.clone()))
    }

    pub fn render(&mut self, f: &mut Frame, area: Rect, styles: &RommStyles) {
        let chunks = Layout::default()
            .constraints([
                Constraint::Length(3),
                Constraint::Min(5),
                Constraint::Length(3),
            ])
            .direction(ratatui::layout::Direction::Vertical)
            .split(area);

        let input_line = format!("Search: {}", self.query);
        let input = Paragraph::new(input_line)
            .style(styles.text())
            .block(styles.panel_block("Search games"));
        f.render_widget(input, chunks[0]);

        if self.result_groups.is_some() {
            let visible = (chunks[1].height as usize).saturating_sub(3).max(1);
            // Keep selection and viewport aligned with the current terminal size.
            self.visible_rows = visible;
            self.update_scroll(visible);
            let Some(groups) = self.result_groups.as_ref() else {
                return;
            };
            let start = self.scroll_offset.min(groups.len().saturating_sub(visible));
            let end = (start + visible).min(groups.len());
            let visible_groups = &groups[start..end];

            let header = Row::new(vec![
                Cell::from("Name").style(styles.label()),
                Cell::from("Platform").style(styles.label()),
            ]);
            let rows: Vec<Row> = visible_groups
                .iter()
                .enumerate()
                .map(|(i, g)| {
                    let global_idx = start + i;
                    let platform = g
                        .primary
                        .platform_display_name
                        .as_deref()
                        .or(g.primary.platform_custom_name.as_deref())
                        .unwrap_or("—");
                    let style = styles.row(i, global_idx == self.selected);
                    Row::new(vec![
                        Cell::from(g.name.as_str()).style(style),
                        Cell::from(platform).style(style),
                    ])
                    .height(1)
                })
                .collect();

            let total_files = self.results.as_ref().map(|r| r.items.len()).unwrap_or(0);
            let widths = [Constraint::Percentage(60), Constraint::Percentage(40)];
            let title = if self.loading {
                format!(
                    "Results ({}) — {} files [Loading...]",
                    groups.len(),
                    total_files
                )
            } else {
                format!("Results ({}) — {} files", groups.len(), total_files)
            };
            let table = Table::new(rows, widths)
                .header(header)
                .block(styles.panel_block(title));
            f.render_widget(table, chunks[1]);
        } else {
            let msg = if self.loading {
                "Searching..."
            } else {
                "Type a search term and press Enter to search"
            };
            let p = Paragraph::new(msg)
                .style(styles.text())
                .block(styles.panel_block("Results"));
            f.render_widget(p, chunks[1]);
        }

        render_footer_panel(
            f,
            chunks[2],
            styles,
            &[
                FooterHintEntry {
                    key: "Enter",
                    label: "Search/open",
                },
                FooterHintEntry {
                    key: "Esc",
                    label: "Back",
                },
            ],
            None,
        );
    }

    pub fn cursor_position(&self, area: Rect) -> Option<(u16, u16)> {
        let chunks = Layout::default()
            .constraints([
                Constraint::Length(3),
                Constraint::Min(5),
                Constraint::Length(3),
            ])
            .direction(ratatui::layout::Direction::Vertical)
            .split(area);
        let pos = clamp_to_char_boundary(&self.query, self.cursor_pos);
        let offset = 9 + self.query[..pos].chars().count() as u16;
        let x = chunks[0].x + offset.min(chunks[0].width.saturating_sub(1));
        let y = chunks[0].y + 1;
        Some((x, y))
    }
}

fn clamp_to_char_boundary(s: &str, pos: usize) -> usize {
    let mut pos = pos.min(s.len());
    while pos > 0 && !s.is_char_boundary(pos) {
        pos -= 1;
    }
    pos
}

fn previous_char_boundary(s: &str, pos: usize) -> usize {
    let pos = clamp_to_char_boundary(s, pos);
    if pos == 0 {
        return 0;
    }
    s[..pos]
        .char_indices()
        .last()
        .map(|(idx, _)| idx)
        .unwrap_or(0)
}

fn next_char_boundary(s: &str, pos: usize) -> usize {
    let pos = clamp_to_char_boundary(s, pos);
    if pos >= s.len() {
        return s.len();
    }
    let next = pos + s[pos..].chars().next().map(char::len_utf8).unwrap_or(0);
    next.min(s.len())
}

#[cfg(test)]
mod tests {
    use super::SearchScreen;
    use romm_api::types::{Rom, RomList};

    fn rom(id: u64, name: &str, fs_name: &str) -> Rom {
        Rom {
            id,
            platform_id: 1,
            platform_slug: None,
            platform_fs_slug: None,
            platform_custom_name: None,
            platform_display_name: Some("NES".to_string()),
            fs_name: fs_name.to_string(),
            fs_name_no_tags: name.to_string(),
            fs_name_no_ext: name.to_string(),
            fs_extension: "zip".to_string(),
            fs_path: format!("/{id}.zip"),
            fs_size_bytes: 1,
            name: name.to_string(),
            slug: None,
            summary: None,
            path_cover_small: None,
            path_cover_large: None,
            url_cover: None,
            has_manual: false,
            path_manual: None,
            url_manual: None,
            is_unidentified: false,
            is_identified: true,
            files: Vec::new(),
            ra_id: None,
            merged_ra_metadata: None,
        }
    }

    fn empty_list() -> RomList {
        RomList {
            items: vec![],
            total: 0,
            limit: 50,
            offset: 0,
        }
    }

    #[test]
    fn set_results_records_last_searched_query() {
        let mut s = SearchScreen::new();
        s.query = "mario".to_string();
        s.set_results(empty_list());
        assert_eq!(s.last_searched_query.as_deref(), Some("mario"));
        assert!(s.results_match_current_query());
    }

    #[test]
    fn editing_query_after_search_marks_stale() {
        let mut s = SearchScreen::new();
        s.query = "mario".to_string();
        s.cursor_pos = s.query.len();
        s.set_results(empty_list());
        assert!(s.results_match_current_query());
        s.delete_char();
        assert_eq!(s.query, "mari");
        assert!(!s.results_match_current_query());
    }

    #[test]
    fn query_input_cursor_moves_across_utf8_characters() {
        let mut s = SearchScreen::new();
        s.query = "Pokémon".to_string();
        s.cursor_pos = s.query.len();

        for _ in 0..4 {
            s.cursor_left();
        }
        s.add_char('X');

        assert_eq!(s.query, "PokXémon");
    }

    #[test]
    fn clear_results_clears_last_searched_query() {
        let mut s = SearchScreen::new();
        s.query = "a".to_string();
        s.set_results(empty_list());
        s.clear_results();
        assert!(s.last_searched_query.is_none());
    }

    #[test]
    fn set_results_for_query_tracks_origin_query_not_live_input() {
        let mut s = SearchScreen::new();
        s.query = "mario".to_string();
        s.set_results_for_query("zelda".to_string(), empty_list());
        assert_eq!(s.last_searched_query.as_deref(), Some("zelda"));
        assert!(!s.results_match_current_query());
    }

    #[test]
    fn set_results_for_same_query_preserves_selected_group_when_new_page_sorts_before_it() {
        let mut s = SearchScreen::new();
        s.set_results_for_query(
            "a".to_string(),
            RomList {
                items: vec![rom(1, "Bravo", "bravo.zip"), rom(2, "Delta", "delta.zip")],
                total: 3,
                limit: 2,
                offset: 0,
            },
        );
        s.selected = 1;
        assert_eq!(s.get_selected_group().unwrap().0.id, 2);

        s.set_results_for_query(
            "a".to_string(),
            RomList {
                items: vec![
                    rom(1, "Bravo", "bravo.zip"),
                    rom(2, "Delta", "delta.zip"),
                    rom(3, "Alpha", "alpha.zip"),
                ],
                total: 3,
                limit: 3,
                offset: 0,
            },
        );

        assert_eq!(
            s.get_selected_group().unwrap().0.id,
            2,
            "the highlighted result should remain Delta after regrouping"
        );
    }
}