mach-tui 0.3.1

A terminal-first task manager for people who live in the shell and work with agents
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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
//! Images referenced from a task's description.
//!
//! A description line may carry a markdown-style reference —
//! `![alt](~/shot.png)` — and mach draws the picture itself. Terminals
//! that speak kitty, iTerm2 or sixel graphics show the real image;
//! everywhere else it falls back to unicode half blocks.
//!
//! Animated GIFs play in the full-size preview (double-click / Enter).

use std::collections::{HashMap, VecDeque};
use std::path::{Path, PathBuf};
use std::sync::mpsc::{self, Receiver, Sender, SyncSender, TryRecvError, TrySendError};
use std::sync::{Arc, OnceLock};
use std::time::{Duration, Instant};

use image::codecs::gif::GifDecoder;
use image::imageops::FilterType;
use image::{AnimationDecoder, DynamicImage, ImageDecoder, Limits};
use ratatui_image::FontSize;
use ratatui_image::picker::{Picker, ProtocolType};
use ratatui_image::protocol::StatefulProtocol;

const IMAGE_EXTENSIONS: [&str; 5] = ["png", "jpg", "jpeg", "gif", "webp"];

/// Max long edge for stills in body / preview.
const MAX_STILL_EDGE: u32 = 1920;
/// Max long edge for GIF frames (encoded once per index).
const MAX_GIF_EDGE: u32 = 720;
/// Max frames decoded from one GIF.
const MAX_GIF_FRAMES: usize = 48;
/// Max successful or failed decode outcomes kept in the LRU cache.
const MAX_CACHE_ENTRIES: usize = 48;
/// Aggregate decoded-pixel budget for still images. Protocol encodings are
/// released with the form; decoded pixels are the persistent cache cost.
const MAX_CACHE_BYTES: usize = 128 * 1024 * 1024;
/// Reject implausibly large canvases before a decoder allocates them.
const MAX_DECODE_DIMENSION: u32 = 8192;
const MAX_DECODE_ALLOC: u64 = 128 * 1024 * 1024;
/// Decode work is CPU and memory heavy; keep the UI responsive under a body
/// containing many images instead of spawning one thread per path.
const MAX_DECODE_WORKERS: usize = 2;

#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub(crate) struct AttachmentCatalog {
    files: HashMap<String, String>,
}

impl AttachmentCatalog {
    pub fn set(&mut self, attachments: &[crate::store::Attachment]) {
        self.files = attachments
            .iter()
            .map(|attachment| (attachment.id.clone(), attachment.storage_name.clone()))
            .collect();
    }

    pub fn resolve(&self, reference: &str, images_root: &Path) -> PathBuf {
        self.files
            .get(reference)
            .map(|storage_name| images_root.join(storage_name))
            .unwrap_or_else(|| expand_in(reference, images_root))
    }
}

fn decode_limits() -> Limits {
    let mut limits = Limits::default();
    limits.max_image_width = Some(MAX_DECODE_DIMENSION);
    limits.max_image_height = Some(MAX_DECODE_DIMENSION);
    limits.max_alloc = Some(MAX_DECODE_ALLOC);
    limits
}

/// Shrink so the longer side is at most `max_edge` (no-op when already smaller).
fn fit(img: DynamicImage, max_edge: u32) -> DynamicImage {
    let (w, h) = (img.width(), img.height());
    let edge = w.max(h);
    if edge <= max_edge {
        return img;
    }
    let scale = max_edge as f64 / edge as f64;
    let nw = ((w as f64) * scale).round().max(1.0) as u32;
    let nh = ((h as f64) * scale).round().max(1.0) as u32;
    img.resize(nw, nh, FilterType::Triangle)
}

/// Whether a string looks like an image path (extension check; no FS).
pub fn looks_like_image(text: &str) -> bool {
    let Some(t) = reference_path(text) else {
        return false;
    };
    if let Some((_, ext)) = t.rsplit_once('.') {
        let ext = ext.split(['/', '\\', '?', '#']).next().unwrap_or(ext);
        if IMAGE_EXTENSIONS.iter().any(|e| ext.eq_ignore_ascii_case(e)) {
            return true;
        }
    }
    false
}

/// An existing image file named by `text`, if that is what it is.
pub fn path_if_image(text: &str) -> Option<PathBuf> {
    path_if_image_in(text, &default_images_root())
}

/// Resolve a raw or Markdown image reference against an explicit images root.
/// Relative paths never depend on the process working directory.
pub fn path_if_image_in(text: &str, images_root: &Path) -> Option<PathBuf> {
    let reference = reference_path(text)?;
    if !looks_like_image(reference) {
        return None;
    }
    let path = expand_in(reference, images_root);
    path.is_file().then_some(path)
}

/// Resolves `~`, `file://` URLs and escaped spaces; the rest is left to
/// the filesystem.
pub fn expand(path: &str) -> PathBuf {
    expand_in(path, &default_images_root())
}

pub fn expand_in(path: &str, images_root: &Path) -> PathBuf {
    let path = reference_path(path).unwrap_or(path).trim();
    let path = path.strip_prefix("file://").unwrap_or(path);
    let path = path.replace("%20", " ");
    if let Some(rest) = path.strip_prefix("~/")
        && let Some(home) = dirs::home_dir()
    {
        return home.join(rest);
    }
    let path = PathBuf::from(path);
    if path.is_absolute() {
        path
    } else {
        images_root.join(path)
    }
}

/// Extract the path from either `path.png` or `![alt](path.png)`.
fn reference_path(text: &str) -> Option<&str> {
    let text = text.trim();
    if !text.starts_with("![") {
        return (!text.is_empty()).then_some(text);
    }
    let close = text.find("](")?;
    if !text.ends_with(')') || close + 2 >= text.len() - 1 {
        return None;
    }
    Some(text[close + 2..text.len() - 1].trim())
}

/// What the terminal says a cell is worth in pixels, when it will say.
///
/// Every size here is counted in cells and encoded as `cells × cell_size`
/// pixels, so this number has to be right or the terminal draws a picture
/// that does not fit the cells it was given and clips the overflow.
fn terminal_cell_size() -> Option<FontSize> {
    let ws = ratatui::crossterm::terminal::window_size().ok()?;
    // The pixel fields are optional in the ioctl; zero means "not told".
    if ws.width == 0 || ws.height == 0 || ws.columns == 0 || ws.rows == 0 {
        return None;
    }
    Some(FontSize::new(ws.width / ws.columns, ws.height / ws.rows))
}

fn tmux_without_passthrough() -> bool {
    if std::env::var_os("TMUX").is_none() {
        return false;
    }
    match std::process::Command::new("tmux")
        .args(["show", "-gv", "allow-passthrough"])
        .output()
    {
        Ok(out) => String::from_utf8_lossy(&out.stdout).trim() != "on",
        Err(_) => true,
    }
}

/// Uppercase type label for a path (`GIF`, `PNG`, …).
pub fn type_label(path: &Path) -> String {
    path.extension()
        .and_then(|e| e.to_str())
        .map(|e| e.to_ascii_uppercase())
        .filter(|e| !e.is_empty())
        .unwrap_or_else(|| "IMG".to_string())
}

pub fn is_gif(path: &Path) -> bool {
    if path
        .extension()
        .and_then(|e| e.to_str())
        .is_some_and(|e| e.eq_ignore_ascii_case("gif"))
    {
        return true;
    }
    // Sniff magic bytes — some temp clipboard paths omit a reliable suffix.
    let Ok(mut f) = std::fs::File::open(path) else {
        return false;
    };
    use std::io::Read;
    let mut magic = [0u8; 6];
    matches!(f.read(&mut magic), Ok(6) if &magic == b"GIF87a" || &magic == b"GIF89a")
}

/// One decoded GIF ready to play in the full-size preview.
pub struct GifPlayback {
    frames: Vec<Arc<DynamicImage>>,
    delays: Vec<Duration>,
    index: usize,
    next_at: Instant,
    paused: bool,
}

impl GifPlayback {
    pub fn load(path: &Path) -> Result<Self, String> {
        let file = std::fs::File::open(path).map_err(|e| format!("{}: {e}", path.display()))?;
        let reader = std::io::BufReader::new(file);
        let mut decoder =
            GifDecoder::new(reader).map_err(|e| format!("{}: {e}", path.display()))?;
        decoder
            .set_limits(decode_limits())
            .map_err(|e| format!("{}: {e}", path.display()))?;
        let mut frames = Vec::new();
        let mut delays = Vec::new();
        // Stream frames so a 500-frame meme does not decode entirely first.
        for (i, frame) in decoder.into_frames().enumerate() {
            if i >= MAX_GIF_FRAMES {
                break;
            }
            let frame = frame.map_err(|e| format!("{}: {e}", path.display()))?;
            // Delay is already a ratio of milliseconds — convert via Duration.
            let mut delay = Duration::from(frame.delay());
            // GIF delay of 0 is commonly treated as ~100ms.
            if delay.is_zero() {
                delay = Duration::from_millis(100);
            }
            // Floor so slow terminals can keep up; cap wild values.
            if delay < Duration::from_millis(40) {
                delay = Duration::from_millis(40);
            }
            if delay > Duration::from_secs(10) {
                delay = Duration::from_secs(10);
            }
            delays.push(delay);
            let rgba = DynamicImage::ImageRgba8(frame.into_buffer());
            frames.push(Arc::new(fit(rgba, MAX_GIF_EDGE)));
        }
        if frames.is_empty() {
            return Err(format!("{}: empty GIF", path.display()));
        }
        let delay0 = delays[0];
        Ok(Self {
            frames,
            delays,
            index: 0,
            next_at: Instant::now() + delay0,
            paused: false,
        })
    }

    pub fn frame_count(&self) -> usize {
        self.frames.len()
    }

    /// 1-based index for the UI (`1/12`).
    pub fn frame_number(&self) -> usize {
        self.index + 1
    }

    pub fn is_animated(&self) -> bool {
        self.frames.len() > 1
    }

    pub fn is_paused(&self) -> bool {
        self.paused
    }

    /// Toggle pause/resume. When resuming, the next frame is scheduled
    /// from now so playback does not jump.
    pub fn toggle_pause(&mut self) {
        if self.frames.len() <= 1 {
            return;
        }
        self.paused = !self.paused;
        if !self.paused {
            self.next_at = Instant::now() + self.delays[self.index];
        }
    }

    /// Advance when the current frame's delay has elapsed.
    pub fn tick(&mut self) -> bool {
        if self.paused || self.frames.len() <= 1 {
            return false;
        }
        let now = Instant::now();
        if now < self.next_at {
            return false;
        }
        self.index = (self.index + 1) % self.frames.len();
        // Schedule from *now* so a slow redraw does not skip many frames.
        self.next_at = now + self.delays[self.index];
        true
    }

    pub fn current(&self) -> &DynamicImage {
        &self.frames[self.index]
    }

    fn frame_arc(&self, idx: usize) -> Arc<DynamicImage> {
        Arc::clone(&self.frames[idx])
    }
}

struct GifJob {
    path: PathBuf,
    result: Sender<Result<GifPlayback, String>>,
}

fn gif_worker() -> &'static SyncSender<GifJob> {
    static WORKER: OnceLock<SyncSender<GifJob>> = OnceLock::new();
    WORKER.get_or_init(|| {
        // One active decode and at most one queued request. Forms can be
        // opened/closed faster than a large GIF decodes; an unbounded queue
        // would otherwise keep obsolete work alive long after the UI moved on.
        let (jobs, receiver) = mpsc::sync_channel::<GifJob>(1);
        let _ = std::thread::Builder::new()
            .name("mach-gif-decode".into())
            .spawn(move || {
                while let Ok(job) = receiver.recv() {
                    let _ = job.result.send(GifPlayback::load(&job.path));
                }
            });
        jobs
    })
}

/// One asynchronous GIF decode owned by the open form. Jobs share one process
/// worker, so rapidly changing previews cannot create unbounded decode threads.
pub struct GifLoad {
    path: PathBuf,
    receiver: Receiver<Result<GifPlayback, String>>,
}

impl GifLoad {
    pub fn start(path: PathBuf) -> Self {
        let (sender, receiver) = mpsc::channel();
        let job = GifJob {
            path: path.clone(),
            result: sender,
        };
        match gif_worker().try_send(job) {
            Ok(()) => {}
            Err(TrySendError::Full(job)) => {
                let _ = job.result.send(Err(
                    "GIF decoder is busy; try opening the image again".into()
                ));
            }
            Err(TrySendError::Disconnected(job)) => {
                let _ = job
                    .result
                    .send(Err("GIF decode worker stopped".to_string()));
            }
        }
        Self { path, receiver }
    }

    pub fn path(&self) -> &Path {
        &self.path
    }

    pub fn poll(&self) -> Option<Result<GifPlayback, String>> {
        match self.receiver.try_recv() {
            Ok(result) => Some(result),
            Err(TryRecvError::Empty) => None,
            Err(TryRecvError::Disconnected) => Some(Err("GIF load failed".to_string())),
        }
    }
}

/// One file: decoded pixels stay in RAM. Body and full-screen preview keep
/// separate protocols so closing the preview does not force a slow
/// re-encode the next time it opens (body is ~10 rows; preview is large).
struct CachedImage {
    image: Arc<DynamicImage>,
    protocol: Option<StatefulProtocol>,
    preview_protocol: Option<StatefulProtocol>,
}

/// Result of asking the store for a drawable protocol.
pub enum ImageReady<'a> {
    Ready(&'a mut StatefulProtocol),
    /// Decode still running on a worker thread.
    Loading,
    Failed(String),
}

/// Decoded images, kept so a redraw does not re-read the file.
pub struct ImageStore {
    images_root: PathBuf,
    attachments: AttachmentCatalog,
    picker: Option<Picker>,
    cache: HashMap<PathBuf, Result<CachedImage, String>>,
    cache_bytes: usize,
    cache_budget: usize,
    /// LRU order of cache keys (front = oldest).
    lru: VecDeque<PathBuf>,
    /// In-flight background decodes.
    pending: HashMap<PathBuf, Receiver<Result<Arc<DynamicImage>, String>>>,
    /// FIFO work waiting for one of the bounded decode slots.
    queued: VecDeque<PathBuf>,
    /// Encoded GIF frames for the open preview (one encode per frame index).
    gif_protocols: Vec<Option<StatefulProtocol>>,
}

impl Default for ImageStore {
    fn default() -> Self {
        Self {
            images_root: default_images_root(),
            attachments: AttachmentCatalog::default(),
            picker: None,
            cache: HashMap::new(),
            cache_bytes: 0,
            cache_budget: MAX_CACHE_BYTES,
            lru: VecDeque::new(),
            pending: HashMap::new(),
            queued: VecDeque::new(),
            gif_protocols: Vec::new(),
        }
    }
}

/// [`FontSize`] carries no `PartialEq`.
fn same_cell(a: FontSize, b: FontSize) -> bool {
    a.width == b.width && a.height == b.height
}

impl ImageStore {
    pub fn with_root(images_root: PathBuf) -> Self {
        Self {
            images_root,
            ..Self::default()
        }
    }

    pub fn set_root(&mut self, images_root: PathBuf) {
        if self.images_root != images_root {
            self.images_root = images_root;
            self.cache.clear();
            self.cache_bytes = 0;
            self.lru.clear();
            self.pending.clear();
            self.queued.clear();
            self.release(true);
        }
    }

    pub fn root(&self) -> &Path {
        &self.images_root
    }

    pub fn set_attachments(&mut self, attachments: &[crate::store::Attachment]) {
        self.attachments.set(attachments);
    }

    pub fn resolve(&self, reference: &str) -> PathBuf {
        self.attachments.resolve(reference, &self.images_root)
    }

    /// Probe the terminal graphics protocol. Call before the alternate screen.
    /// Falls back to halfblocks if unsupported or under tmux without passthrough.
    pub fn detect() -> Self {
        let picker = if tmux_without_passthrough() {
            // Without `allow-passthrough on`, graphics escapes corrupt the screen.
            Picker::halfblocks()
        } else {
            Picker::from_query_stdio().unwrap_or_else(|_| Picker::halfblocks())
        };
        Self {
            picker: Some(picker),
            ..Self::default()
        }
    }

    fn decode(path: &Path) -> Result<Arc<DynamicImage>, String> {
        Ok(Arc::new(fit(load_dynamic(path)?, MAX_STILL_EDGE)))
    }

    fn touch_lru(&mut self, path: &Path) {
        self.lru.retain(|p| p != path);
        self.lru.push_back(path.to_path_buf());
    }

    fn evict_if_needed(&mut self) {
        while self.lru.len() > MAX_CACHE_ENTRIES || self.cache_bytes > self.cache_budget {
            let Some(old) = self.lru.pop_front() else {
                break;
            };
            if let Some(cached) = self.cache.remove(&old)
                && let Ok(cached) = cached
            {
                self.cache_bytes = self
                    .cache_bytes
                    .saturating_sub(cached.image.as_bytes().len());
            }
        }
    }

    fn insert_decoded(&mut self, path: PathBuf, result: Result<Arc<DynamicImage>, String>) {
        self.lru.retain(|cached| cached != &path);
        if let Some(Ok(cached)) = self.cache.remove(&path) {
            self.cache_bytes = self
                .cache_bytes
                .saturating_sub(cached.image.as_bytes().len());
        }
        match result {
            Ok(image) => {
                let bytes = image.as_bytes().len();
                if bytes > self.cache_budget {
                    self.cache.insert(
                        path.clone(),
                        Err(format!(
                            "decoded image is {bytes} bytes; cache limit is {} bytes",
                            self.cache_budget
                        )),
                    );
                    self.touch_lru(&path);
                    self.evict_if_needed();
                    return;
                }
                self.cache_bytes = self.cache_bytes.saturating_add(bytes);
                self.cache.insert(
                    path.clone(),
                    Ok(CachedImage {
                        image,
                        protocol: None,
                        preview_protocol: None,
                    }),
                );
                self.touch_lru(&path);
                self.evict_if_needed();
            }
            Err(err) => {
                self.cache.insert(path.clone(), Err(err));
                self.touch_lru(&path);
                self.evict_if_needed();
            }
        }
    }

    /// Start decoding `paths` on worker threads. Safe to call repeatedly;
    /// already-cached or in-flight paths are skipped. The form can open
    /// immediately while this runs.
    pub fn prefetch(&mut self, paths: impl IntoIterator<Item = PathBuf>) {
        for path in paths {
            if self.cache.contains_key(&path)
                || self.pending.contains_key(&path)
                || self.queued.contains(&path)
            {
                continue;
            }
            self.queued.push_back(path);
        }
        self.start_queued();
    }

    fn start_queued(&mut self) {
        while self.pending.len() < MAX_DECODE_WORKERS {
            let Some(path) = self.queued.pop_front() else {
                break;
            };
            let (tx, rx) = mpsc::channel();
            let path_bg = path.clone();
            match std::thread::Builder::new()
                .name("mach-image-decode".into())
                .spawn(move || {
                    let _ = tx.send(Self::decode(&path_bg));
                }) {
                Ok(_) => {
                    self.pending.insert(path, rx);
                }
                Err(error) => self
                    .insert_decoded(path, Err(format!("could not start image decoder: {error}"))),
            }
        }
    }

    /// Pull finished background decodes into the cache.
    /// Returns true when at least one image became ready (caller should redraw).
    pub fn poll_pending(&mut self) -> bool {
        let keys: Vec<PathBuf> = self.pending.keys().cloned().collect();
        let mut any = false;
        for key in keys {
            let Some(rx) = self.pending.get(&key) else {
                continue;
            };
            match rx.try_recv() {
                Ok(result) => {
                    self.pending.remove(&key);
                    self.insert_decoded(key, result);
                    any = true;
                }
                Err(TryRecvError::Empty) => {}
                Err(TryRecvError::Disconnected) => {
                    self.pending.remove(&key);
                    self.insert_decoded(key, Err("image load failed".into()));
                    any = true;
                }
            }
        }
        self.start_queued();
        any
    }

    pub fn has_pending(&self) -> bool {
        !self.pending.is_empty() || !self.queued.is_empty()
    }

    /// If the terminal cell size changed, drop encodings and rebuild.
    ///
    /// Needed when moving between displays of different DPI: the grid size
    /// is unchanged so there is no resize event, but pixel-per-cell is.
    /// Decoded bitmaps stay cached; only protocols are invalidated.
    pub fn recheck_cell_size(&mut self) -> bool {
        if self.cache.is_empty() && self.gif_protocols.is_empty() {
            return false;
        }
        // Halfblocks are cell glyphs, not pixel protocols.
        if self
            .picker
            .as_ref()
            .is_none_or(|p| p.protocol_type() == ProtocolType::Halfblocks)
        {
            return false;
        }
        let Some(cell) = terminal_cell_size() else {
            return false;
        };
        self.adopt_cell_size(cell)
    }

    /// Apply a new cell size if it differs; keep the startup protocol type.
    fn adopt_cell_size(&mut self, cell: FontSize) -> bool {
        let Some(picker) = self.picker.as_ref() else {
            return false;
        };
        if same_cell(picker.font_size(), cell) {
            return false;
        }
        let protocol = picker.protocol_type();
        #[allow(deprecated, reason = "the only way to set a Picker's font size")]
        let mut picker = Picker::from_fontsize(cell);
        picker.set_protocol_type(protocol);
        self.picker = Some(picker);
        self.release(true);
        true
    }

    /// The protocol for `path`, without blocking on disk I/O.
    ///
    /// Missing files are fetched in the background; the first call returns
    /// [`ImageReady::Loading`] until a later [`Self::poll_pending`] lands them.
    pub fn get(&mut self, path: &Path) -> ImageReady<'_> {
        self.protocol_for(path, false)
    }

    /// Full-screen preview protocol — kept separate from the body thumb so
    /// open → close → open does not thrash encode size every time.
    pub fn get_preview(&mut self, path: &Path) -> ImageReady<'_> {
        self.protocol_for(path, true)
    }

    fn protocol_for(&mut self, path: &Path, preview: bool) -> ImageReady<'_> {
        // `poll_pending` is the event loop's job once per tick.
        if !self.cache.contains_key(path) {
            if !self.pending.contains_key(path) {
                self.prefetch(std::iter::once(path.to_path_buf()));
            }
            return ImageReady::Loading;
        }
        if let Some(Err(error)) = self.cache.get(path) {
            return ImageReady::Failed(error.clone());
        }
        self.touch_lru(path);

        let Self { cache, picker, .. } = self;
        let Some(Ok(CachedImage {
            image,
            protocol,
            preview_protocol,
        })) = cache.get_mut(path)
        else {
            return ImageReady::Loading;
        };

        // Body and preview hold separate protocols so switching between them
        // does not re-encode the decoded image.
        let slot = if preview { preview_protocol } else { protocol };
        let protocol = match slot {
            Some(protocol) => protocol,
            empty @ None => {
                let Some(picker) = picker.as_mut() else {
                    return ImageReady::Failed("no image support".into());
                };
                empty.insert(picker.new_resize_protocol((**image).clone()))
            }
        };
        ImageReady::Ready(protocol)
    }

    /// Protocol for the current GIF frame (encode once per frame index).
    pub fn preview_frame(&mut self, gif: &GifPlayback) -> Result<&mut StatefulProtocol, String> {
        let idx = gif.index;
        let n = gif.frame_count();
        if self.gif_protocols.len() != n {
            self.gif_protocols = (0..n).map(|_| None).collect();
        }
        if self.gif_protocols[idx].is_none() {
            let picker = self.picker.as_mut().ok_or("no image support")?;
            let image = gif.frame_arc(idx);
            self.gif_protocols[idx] = Some(picker.new_resize_protocol((*image).clone()));
        }
        self.gif_protocols[idx]
            .as_mut()
            .ok_or_else(|| "no preview".into())
    }

    pub fn clear_preview(&mut self) {
        self.gif_protocols.clear();
    }

    /// Drop the body protocols (the terminal deletes those pictures) but
    /// keep the decoded pixels. The next `get` rebuilds from RAM — no disk.
    ///
    /// Needed after a Clear over a graphics-protocol image, e.g. when the
    /// `/` menu closes.
    pub fn clear_cache(&mut self) {
        self.release(false);
    }

    /// Drop every placed protocol when leaving the task form.
    pub fn release_form_graphics(&mut self) {
        self.release(true);
    }

    fn release(&mut self, including_preview_protocols: bool) {
        for cached in self.cache.values_mut().flatten() {
            cached.protocol = None;
            if including_preview_protocols {
                cached.preview_protocol = None;
            }
        }
        self.clear_preview();
    }
}

/// Open and decode an image file with path-labeled errors.
pub fn load_dynamic(path: &Path) -> Result<DynamicImage, String> {
    let mut reader = image::ImageReader::open(path)
        .map_err(|e| format!("{}: {e}", path.display()))?
        .with_guessed_format()
        .map_err(|e| format!("{}: {e}", path.display()))?;
    reader.limits(decode_limits());
    reader
        .decode()
        .map_err(|e| format!("{}: {e}", path.display()))
}

/// The `~`-relative form of a path, so bodies stay readable.
pub fn short(path: &Path) -> String {
    short_in(path, &default_images_root())
}

/// Stable fallback used by standalone editor tests. Production injects the
/// active store's images directory into [`ImageStore`] and
/// [`crate::body::BodyEditor`].
pub fn default_images_root() -> PathBuf {
    dirs::home_dir()
        .map(|home| home.join(".mach"))
        .unwrap_or_else(|| std::env::temp_dir().join("mach"))
        .join("images")
}

pub fn short_in(path: &Path, images_root: &Path) -> String {
    if let Ok(relative) = path.strip_prefix(images_root)
        && !relative.as_os_str().is_empty()
    {
        return relative.display().to_string();
    }
    if let Some(home) = dirs::home_dir()
        && let Ok(rest) = path.strip_prefix(&home)
    {
        return format!("~/{}", rest.display());
    }
    path.display().to_string()
}

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

    #[test]
    fn recognises_picture_extensions() {
        assert!(looks_like_image("/tmp/a.png"));
        assert!(
            looks_like_image("shot.JPEG"),
            "extension is case-insensitive"
        );
        assert!(!looks_like_image("notes.txt"));
        assert!(!looks_like_image("remember to send the png to Dana"));
        assert!(looks_like_image("![diagram](architecture.png)"));
        assert!(
            !looks_like_image("legacy.bmp"),
            "BMP is not compiled into the decoder"
        );
    }

    #[test]
    fn resolves_relative_references_against_an_injected_images_root() {
        let root = std::env::temp_dir().join(format!("mach-image-root-{}", std::process::id()));
        let _ = std::fs::create_dir_all(&root);
        let path = root.join("diagram.png");
        std::fs::write(&path, b"not decoded in this test").unwrap();

        assert_eq!(
            path_if_image_in("![diagram](diagram.png)", &root),
            Some(path)
        );
    }

    #[test]
    fn resolves_attachment_ids_through_the_managed_catalog() {
        let root = PathBuf::from("/tmp/mach-managed-images");
        let id = "a".repeat(64);
        let attachment = crate::store::Attachment {
            id: id.clone(),
            sha256: id.clone(),
            media_type: "image/png".into(),
            byte_len: 12,
            storage_name: format!("{id}.png"),
        };
        let mut store = ImageStore::with_root(root.clone());
        store.set_attachments(&[attachment]);

        assert_eq!(store.resolve(&id), root.join(format!("{id}.png")));
        assert_eq!(store.resolve("draft.png"), root.join("draft.png"));
    }

    #[test]
    fn expands_a_file_url_with_escaped_spaces() {
        assert_eq!(
            expand("file:///tmp/my%20shot.PNG"),
            PathBuf::from("/tmp/my shot.PNG")
        );
    }

    #[test]
    fn expands_a_home_relative_path() {
        let path = expand("~/pic.png");
        assert!(path.is_absolute() || dirs::home_dir().is_none());
        assert!(path.ends_with("pic.png"));
    }

    #[test]
    fn only_an_existing_file_counts_as_a_picture() {
        let real = concat!(env!("CARGO_MANIFEST_DIR"), "/assets/screenshot.png");
        assert!(path_if_image(real).is_some());
        assert!(path_if_image("/tmp/definitely-not-here.png").is_none());
        assert!(path_if_image(real.trim_end_matches(".png")).is_none());
    }

    /// A store holding one decoded image, so there is an encoding to lose.
    fn store_with_an_image() -> ImageStore {
        let mut store = ImageStore {
            picker: Some(Picker::halfblocks()),
            ..Default::default()
        };
        store.cache.insert(
            PathBuf::from("/tmp/x.png"),
            Ok(CachedImage {
                image: Arc::new(DynamicImage::new_rgba8(4, 4)),
                protocol: None,
                preview_protocol: None,
            }),
        );
        store
    }

    #[test]
    fn the_first_changed_reading_rebuilds_the_picker() {
        // The window is already showing a clipped picture by now, so this
        // must not wait to be sure.
        let mut store = store_with_an_image();
        let was = store.picker.as_ref().unwrap().font_size();
        let moved = FontSize::new(was.width * 2, was.height * 2);

        assert!(store.adopt_cell_size(moved));
        let now = store.picker.as_ref().unwrap().font_size();
        assert!(same_cell(now, moved), "the picker measures in the new size");
    }

    #[test]
    fn a_steady_cell_size_is_left_alone() {
        let mut store = store_with_an_image();
        let same = store.picker.as_ref().unwrap().font_size();
        for _ in 0..5 {
            assert!(
                !store.adopt_cell_size(same),
                "nothing moved, so nothing to re-encode"
            );
        }
    }

    #[test]
    fn one_move_costs_one_rebuild_however_often_it_is_polled() {
        let mut store = store_with_an_image();
        let was = store.picker.as_ref().unwrap().font_size();
        let moved = FontSize::new(was.width * 2, was.height * 2);

        let rebuilds = (0..20).filter(|_| store.adopt_cell_size(moved)).count();
        assert_eq!(rebuilds, 1);
    }

    #[test]
    fn nothing_cached_means_nothing_to_check() {
        let mut store = ImageStore {
            picker: Some(Picker::halfblocks()),
            ..Default::default()
        };
        let was = store.picker.as_ref().unwrap().font_size();
        assert!(!store.recheck_cell_size());
        assert!(
            same_cell(store.picker.as_ref().unwrap().font_size(), was),
            "the picker was never touched"
        );
    }

    #[test]
    fn prefetch_uses_a_bounded_number_of_decode_workers() {
        let mut store = ImageStore::default();
        let paths = (0..8).map(|index| PathBuf::from(format!("/missing/{index}.png")));
        store.prefetch(paths);
        assert!(store.pending.len() <= MAX_DECODE_WORKERS);
        assert_eq!(store.pending.len() + store.queued.len(), 8);
    }

    #[test]
    fn decoded_cache_evicts_by_bytes_before_entry_count() {
        let mut store = ImageStore {
            cache_budget: 32,
            ..ImageStore::default()
        };
        let image = || Arc::new(DynamicImage::ImageRgba8(image::RgbaImage::new(2, 2)));
        let paths: Vec<_> = (0..3)
            .map(|index| PathBuf::from(format!("small-{index}.png")))
            .collect();

        for path in &paths {
            store.insert_decoded(path.clone(), Ok(image()));
        }

        assert_eq!(store.cache_bytes, 32);
        assert!(!store.cache.contains_key(&paths[0]));
        assert!(store.cache.contains_key(&paths[1]));
        assert!(store.cache.contains_key(&paths[2]));
    }

    #[test]
    fn one_image_larger_than_the_cache_budget_is_reported_not_cached() {
        let mut store = ImageStore {
            cache_budget: 15,
            ..ImageStore::default()
        };
        let path = PathBuf::from("too-large.png");
        let image = Arc::new(DynamicImage::ImageRgba8(image::RgbaImage::new(2, 2)));

        store.insert_decoded(path.clone(), Ok(image));

        assert_eq!(store.cache_bytes, 0);
        assert!(matches!(
            store.cache.get(&path),
            Some(Err(error)) if error.contains("cache limit")
        ));
    }

    #[test]
    fn failed_decodes_share_the_cache_entry_limit() {
        let mut store = ImageStore::default();
        for index in 0..(MAX_CACHE_ENTRIES + 12) {
            store.insert_decoded(
                PathBuf::from(format!("missing-{index}.png")),
                Err("missing".into()),
            );
        }

        assert_eq!(store.cache.len(), MAX_CACHE_ENTRIES);
        assert_eq!(store.lru.len(), MAX_CACHE_ENTRIES);
    }

    #[test]
    fn oversized_canvas_is_rejected_from_still_and_gif_decoders() {
        let path =
            std::env::temp_dir().join(format!("mach-oversized-{}.gif", uuid::Uuid::new_v4()));
        // Valid one-frame GIF with its logical canvas patched to 8193×1. The
        // strict dimension check runs before a canvas buffer can be allocated.
        std::fs::write(
            &path,
            [
                b'G', b'I', b'F', b'8', b'9', b'a', 0x01, 0x20, 0x01, 0x00, 0x80, 0x00, 0x00, 0x00,
                0x00, 0x00, 0xff, 0xff, 0xff, 0x21, 0xf9, 0x04, 0x01, 0x00, 0x00, 0x00, 0x00, 0x2c,
                0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01, 0x00, 0x00, 0x02, 0x02, 0x44, 0x01, 0x00,
                0x3b,
            ],
        )
        .unwrap();

        let still = load_dynamic(&path).expect_err("still decoder must enforce dimensions");
        let gif = match GifPlayback::load(&path) {
            Err(error) => error,
            Ok(_) => panic!("GIF decoder must enforce dimensions"),
        };
        assert!(
            still.to_lowercase().contains("limit") || still.to_lowercase().contains("dimension"),
            "{still}"
        );
        assert!(
            gif.to_lowercase().contains("limit") || gif.to_lowercase().contains("dimension"),
            "{gif}"
        );
    }

    #[test]
    fn half_blocks_are_never_re_measured() {
        // Their font size is a stand-in, not a measurement, so acting on a
        // real one would drop every encoding and change nothing on screen.
        let mut store = store_with_an_image();
        assert_eq!(
            store.picker.as_ref().unwrap().protocol_type(),
            ProtocolType::Halfblocks
        );
        let was = store.picker.as_ref().unwrap().font_size();
        assert!(!store.recheck_cell_size());
        assert!(same_cell(store.picker.as_ref().unwrap().font_size(), was));
    }
}

#[cfg(test)]
mod gif_tests {
    use super::*;
    use image::codecs::gif::GifEncoder;
    use image::{Delay, Frame, Rgba, RgbaImage};
    use std::fs::File;

    fn write_test_gif(path: &Path, n: u32) {
        let file = File::create(path).unwrap();
        let mut enc = GifEncoder::new(file);
        enc.set_repeat(image::codecs::gif::Repeat::Infinite)
            .unwrap();
        for i in 0..n {
            let mut img = RgbaImage::new(8, 8);
            for p in img.pixels_mut() {
                *p = Rgba([((i * 80) % 255) as u8, 0, 255, 255]);
            }
            let delay = Delay::from_numer_denom_ms(50, 1);
            let frame = Frame::from_parts(img, 0, 0, delay);
            enc.encode_frame(frame).unwrap();
        }
    }

    #[test]
    fn loads_and_advances_multiple_gif_frames() {
        let dir = std::env::temp_dir().join("mach-gif-test");
        let _ = std::fs::create_dir_all(&dir);
        let path = dir.join("anim.gif");
        write_test_gif(&path, 4);
        assert!(is_gif(&path));
        let mut gif = GifPlayback::load(&path).expect("load gif");
        assert!(gif.frame_count() >= 2, "got {} frames", gif.frame_count());
        assert!(gif.is_animated());
        let first = gif.index;
        std::thread::sleep(Duration::from_millis(120));
        assert!(gif.tick(), "should advance after delay");
        assert_ne!(gif.index, first);
    }
}