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
use std::sync::{Arc, Mutex};
use std::time::Instant;

use ratatui_image::picker::{Picker, ProtocolType};

use crate::tui::footer_hint::FooterHintEntry;
use crate::tui::path_picker::{PathPicker, PathPickerMode};
use crate::tui::utils::open_in_browser;
use romm_api::core::download::{DownloadJob, DownloadStatus};
use romm_api::types::{Rom, SaveMetadata};

use super::cover::detect_cover_protocol;
use super::types::{
    AchievementListState, CoverRenderMode, CoverState, DetailTab, GameDetailPrevious,
    GameDetailScreen, SaveListState, COVER_PANEL_WIDTH_MAX, COVER_PANEL_WIDTH_MIN,
};

impl GameDetailScreen {
    pub fn new(
        rom: Rom,
        other_files: Vec<Rom>,
        previous: GameDetailPrevious,
        downloads: Arc<Mutex<Vec<DownloadJob>>>,
        cover_panel_width: u16,
    ) -> Self {
        let cover_last_url = rom.url_cover.clone();
        let cover_protocol = detect_cover_protocol();
        let cover_state = if cover_last_url.is_none() {
            CoverState::Idle
        } else {
            CoverState::Loading
        };
        let extras_items = GameDetailScreen::build_extras_items(&rom, &other_files);
        Self {
            rom,
            other_files,
            previous,
            message: None,
            message_clear_at: None,
            downloads,
            has_started_download: false,
            download_completion_acknowledged: false,
            cover_render_mode: CoverRenderMode::Auto,
            cover_state,
            cover_last_url,
            cover_protocol,
            cover_image: None,
            active_tab: DetailTab::Info,
            saves_state: SaveListState::Idle,
            selected_save_index: 0,
            achievements_state: AchievementListState::Idle,
            selected_achievement_index: 0,
            save_upload_picker: None,
            save_screenshot_state: CoverState::Idle,
            save_screenshot_image: None,
            extras_items,
            selected_extras_index: 0,
            metadata_unmatch_confirm: false,
            cover_panel_width: cover_panel_width
                .clamp(COVER_PANEL_WIDTH_MIN, COVER_PANEL_WIDTH_MAX),
        }
    }

    pub fn select_tab(&mut self, tab: DetailTab) {
        self.active_tab = tab;
    }

    pub fn adjust_cover_panel_width(&mut self, delta: i16) {
        let next = (self.cover_panel_width as i16 + delta)
            .clamp(COVER_PANEL_WIDTH_MIN as i16, COVER_PANEL_WIDTH_MAX as i16);
        self.cover_panel_width = next as u16;
    }

    /// Replace ROM fields after metadata edit; reload cover when URL changes.
    pub fn apply_refreshed_rom(&mut self, rom: Rom) {
        let cover_changed = self.rom.url_cover != rom.url_cover;
        self.rom = rom;
        if cover_changed {
            self.cover_last_url = self.rom.url_cover.clone();
            self.cover_image = None;
            self.cover_state = if self.cover_last_url.is_some() {
                CoverState::Loading
            } else {
                CoverState::Idle
            };
        }
    }

    pub fn open_cover(&mut self) {
        self.message = None;
        self.message_clear_at = None;
        let url = self.rom.url_cover.as_deref().filter(|s| !s.is_empty());
        match url {
            Some(u) => match open_in_browser(u) {
                Ok(_) => {
                    self.message = Some("Opened in browser".to_string());
                    self.message_clear_at =
                        Some(Instant::now() + std::time::Duration::from_secs(3));
                }
                Err(e) => {
                    self.message = Some(format!("Failed: {}", e));
                    self.message_clear_at =
                        Some(Instant::now() + std::time::Duration::from_secs(5));
                }
            },
            None => {
                self.message = Some("No cover URL".to_string());
                self.message_clear_at = Some(Instant::now() + std::time::Duration::from_secs(3));
            }
        }
    }

    pub fn clear_message(&mut self) {
        self.message = None;
        self.message_clear_at = None;
    }

    pub fn tick_message(&mut self) {
        if let Some(clear_at) = self.message_clear_at {
            if Instant::now() >= clear_at {
                self.message = None;
                self.message_clear_at = None;
            }
        }
    }

    pub fn should_request_cover_load(&self) -> bool {
        self.cover_last_url.is_some()
    }

    pub fn set_cover_loading(&mut self) {
        if self.should_request_cover_load() {
            self.cover_state = CoverState::Loading;
        }
    }

    pub fn apply_cover_image(&mut self, image: image::DynamicImage) {
        let picker = match self.cover_protocol {
            None => Picker::halfblocks(),
            Some(env_protocol) => match Picker::from_query_stdio() {
                Ok(mut p) => {
                    // ratatui-image ties pixel budget to protocol + font_size together. After
                    // `from_query_stdio`, protocol and cell size both come from the terminal when
                    // the query succeeds. Replacing the queried protocol with a different env-only
                    // guess (e.g. host vs PTY layer disagree) mis-maps pixels to cells and clips or
                    // gaps the image even when `Resize::Fit` is correct.
                    if matches!(env_protocol, ProtocolType::Kitty) {
                        p.set_protocol_type(ProtocolType::Kitty);
                    } else if p.protocol_type() == ProtocolType::Halfblocks {
                        p.set_protocol_type(env_protocol);
                    }
                    p
                }
                Err(_) => {
                    let mut p = Picker::halfblocks();
                    p.set_protocol_type(env_protocol);
                    p
                }
            },
        };
        self.cover_image = Some(picker.new_resize_protocol(image));
        self.cover_state = CoverState::Ready;
    }

    pub fn apply_cover_error(&mut self, message: String) {
        self.cover_image = None;
        self.cover_state = CoverState::Failed(message);
    }

    pub(crate) fn footer_help_entries(&self) -> Vec<FooterHintEntry> {
        let match_label = if self.rom.is_identified {
            "Unmatch"
        } else {
            "Match"
        };
        let tabs_hint = FooterHintEntry {
            key: "1-5",
            label: "Tabs",
        };
        match self.active_tab {
            DetailTab::Info => vec![
                FooterHintEntry {
                    key: "m",
                    label: match_label,
                },
                FooterHintEntry {
                    key: "Ctrl+←/→",
                    label: "Resize cover",
                },
                tabs_hint,
            ],
            DetailTab::Extras => vec![
                FooterHintEntry {
                    key: "Space",
                    label: "Toggle",
                },
                FooterHintEntry {
                    key: "a",
                    label: "Toggle all",
                },
                FooterHintEntry {
                    key: "Enter",
                    label: "Download",
                },
                FooterHintEntry {
                    key: "j/k",
                    label: "Navigate",
                },
                tabs_hint,
            ],
            DetailTab::Saves => vec![
                FooterHintEntry {
                    key: "u",
                    label: "Upload save",
                },
                FooterHintEntry {
                    key: "D",
                    label: "Download save",
                },
                FooterHintEntry {
                    key: "j/k",
                    label: "Navigate",
                },
                tabs_hint,
            ],
            DetailTab::Achievements => vec![
                FooterHintEntry {
                    key: "j/k",
                    label: "Navigate",
                },
                tabs_hint,
            ],
            DetailTab::Technical => vec![
                FooterHintEntry {
                    key: "m",
                    label: match_label,
                },
                tabs_hint,
            ],
        }
    }

    pub fn set_saves_loading(&mut self) {
        self.saves_state = SaveListState::Loading;
    }

    pub fn apply_saves(&mut self, saves: Vec<SaveMetadata>) {
        self.selected_save_index = self.selected_save_index.min(saves.len().saturating_sub(1));
        self.saves_state = SaveListState::Loaded(saves);
    }

    pub fn apply_saves_error(&mut self, error: String) {
        self.saves_state = SaveListState::Failed(error);
    }

    pub fn set_achievements_loading(&mut self) {
        self.achievements_state = AchievementListState::Loading;
    }

    pub fn apply_achievements_loaded(
        &mut self,
        rows: Vec<romm_api::types::AchievementRow>,
        summary: (usize, usize),
    ) {
        self.achievements_state = AchievementListState::Loaded { rows, summary };
    }

    pub fn apply_achievements_empty(&mut self, message: String) {
        self.achievements_state = AchievementListState::Empty(message);
    }

    pub fn apply_achievements_error(&mut self, error: String) {
        self.achievements_state = AchievementListState::Failed(error);
    }

    pub fn apply_achievements_unsupported(&mut self, message: String) {
        self.achievements_state = AchievementListState::Unsupported(message);
    }

    pub fn selected_save(&self) -> Option<&SaveMetadata> {
        match &self.saves_state {
            SaveListState::Loaded(rows) => rows.get(self.selected_save_index),
            _ => None,
        }
    }

    pub fn achievement_selection_next(&mut self) {
        if let AchievementListState::Loaded { rows, .. } = &self.achievements_state {
            if !rows.is_empty() {
                self.selected_achievement_index =
                    (self.selected_achievement_index + 1).min(rows.len() - 1);
            }
        }
    }

    pub fn achievement_selection_previous(&mut self) {
        self.selected_achievement_index = self.selected_achievement_index.saturating_sub(1);
    }

    pub fn selected_achievement(&self) -> Option<&romm_api::types::AchievementRow> {
        match &self.achievements_state {
            AchievementListState::Loaded { rows, .. } => rows.get(self.selected_achievement_index),
            _ => None,
        }
    }

    pub fn apply_save_screenshot_image(&mut self, image: image::DynamicImage) {
        let picker = match self.cover_protocol {
            None => ratatui_image::picker::Picker::halfblocks(),
            Some(env_protocol) => match ratatui_image::picker::Picker::from_query_stdio() {
                Ok(mut p) => {
                    if matches!(env_protocol, ratatui_image::picker::ProtocolType::Kitty) {
                        p.set_protocol_type(ratatui_image::picker::ProtocolType::Kitty);
                    } else if p.protocol_type() == ratatui_image::picker::ProtocolType::Halfblocks {
                        p.set_protocol_type(env_protocol);
                    }
                    p
                }
                Err(_) => {
                    let mut p = ratatui_image::picker::Picker::halfblocks();
                    p.set_protocol_type(env_protocol);
                    p
                }
            },
        };
        self.save_screenshot_image = Some(picker.new_resize_protocol(image));
        self.save_screenshot_state = CoverState::Ready;
    }

    pub fn apply_save_screenshot_error(&mut self, message: String) {
        self.save_screenshot_image = None;
        self.save_screenshot_state = CoverState::Failed(message);
    }

    pub fn save_selection_next(&mut self) {
        if let SaveListState::Loaded(rows) = &self.saves_state {
            if !rows.is_empty() {
                self.selected_save_index = (self.selected_save_index + 1).min(rows.len() - 1);
            }
        }
    }

    pub fn save_selection_previous(&mut self) {
        self.selected_save_index = self.selected_save_index.saturating_sub(1);
    }

    pub fn open_save_upload_picker(&mut self) {
        self.save_upload_picker = Some(PathPicker::new(PathPickerMode::File, ""));
        self.message = Some("Choose a save file to upload".to_string());
        self.message_clear_at = None;
    }

    pub fn has_any_extras(&self) -> bool {
        !self.extras_items.is_empty()
    }

    pub fn extras_selection_next(&mut self) {
        if !self.extras_items.is_empty() {
            self.selected_extras_index =
                (self.selected_extras_index + 1).min(self.extras_items.len() - 1);
        }
    }

    pub fn extras_selection_previous(&mut self) {
        self.selected_extras_index = self.selected_extras_index.saturating_sub(1);
    }

    pub fn extras_toggle_current(&mut self) {
        if let Some(item) = self.extras_items.get_mut(self.selected_extras_index) {
            item.checked = !item.checked;
        }
    }

    pub fn extras_toggle_all(&mut self) {
        let all_checked = self.extras_items.iter().all(|i| i.checked);
        for item in &mut self.extras_items {
            item.checked = !all_checked;
        }
    }

    pub fn extras_selected_count(&self) -> usize {
        self.extras_items.iter().filter(|i| i.checked).count()
    }

    pub(crate) fn cover_pipeline_label(&self) -> &'static str {
        if self.cover_protocol.is_some() {
            "Advanced terminal protocol"
        } else {
            "Halfblocks fallback mode"
        }
    }

    /// Find the most recent download job for this ROM (if any).
    /// Returns downloading jobs always, or completed/errored jobs if not yet acknowledged.
    pub(crate) fn active_download(&self) -> Option<DownloadJob> {
        self.downloads.lock().ok().and_then(|list| {
            list.iter()
                .rev()
                .find(|j| {
                    j.rom_id == self.rom.id
                        && (matches!(j.status, DownloadStatus::Downloading)
                            || (!self.download_completion_acknowledged
                                && matches!(
                                    j.status,
                                    DownloadStatus::Done
                                        | DownloadStatus::SkippedAlreadyExists
                                        | DownloadStatus::Cancelled
                                        | DownloadStatus::FinalizeFailed(_)
                                        | DownloadStatus::Error(_)
                                )))
                })
                .cloned()
        })
    }
}