gpui-rhai 0.1.1

A Rhai-authored declarative UI runtime for GPUI
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
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
use std::cell::RefCell;
use std::collections::BTreeMap;
use std::fs;
use std::path::{Path, PathBuf};
use std::rc::Rc;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc::{Receiver, Sender, channel};

use gpui::{Image, ImageFormat, ImageSource};
use rhai::{CustomType, TypeBuilder};
use thiserror::Error;

use crate::{
    AsyncDelivery, AsyncScope, ComponentInstancePath, OpaqueHandle, Rgba8, ScriptCallback,
    ScriptGeneration, UiValue,
};

#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct AssetId(String);

impl AssetId {
    /// Parse a namespaced logical asset ID such as `core/check`.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::InvalidId`] for URLs, absolute/traversal paths, or
    /// unsupported characters.
    pub fn parse(value: impl Into<String>) -> Result<Self, AssetError> {
        let value = value.into();
        let segments = value.split('/').collect::<Vec<_>>();
        let valid = segments.len() >= 2
            && segments.iter().all(|segment| {
                !segment.is_empty()
                    && *segment != "."
                    && *segment != ".."
                    && segment.chars().all(|character| {
                        character.is_ascii_alphanumeric() || matches!(character, '_' | '-')
                    })
            });
        if valid && !value.contains(':') && !value.contains('\\') {
            Ok(Self(value))
        } else {
            Err(AssetError::InvalidId(value))
        }
    }

    #[must_use]
    pub fn as_str(&self) -> &str {
        &self.0
    }

    fn split(&self) -> (&str, &str) {
        self.0.split_once('/').expect("validated asset ID")
    }
}

impl CustomType for AssetId {
    fn build(mut builder: TypeBuilder<Self>) {
        builder
            .with_name("AssetId")
            .with_fn("to_string", |asset: &mut Self| asset.0.clone());
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct AssetData {
    pub mime_type: String,
    pub bytes: Vec<u8>,
}

pub trait AssetProvider {
    /// Load a provider-relative logical asset name.
    ///
    /// # Errors
    ///
    /// Returns a provider error without exposing arbitrary filesystem access to
    /// Rhai.
    fn load(&self, name: &str) -> Result<AssetData, String>;
}

#[derive(Clone, Debug, Default)]
pub struct InMemoryAssetProvider {
    assets: BTreeMap<String, AssetData>,
}

impl InMemoryAssetProvider {
    #[must_use]
    pub fn new(assets: BTreeMap<String, AssetData>) -> Self {
        Self { assets }
    }
}

impl AssetProvider for InMemoryAssetProvider {
    fn load(&self, name: &str) -> Result<AssetData, String> {
        self.assets
            .get(name)
            .cloned()
            .ok_or_else(|| format!("asset `{name}` does not exist"))
    }
}

#[derive(Clone, Debug)]
pub struct DirectoryAssetProvider {
    root: PathBuf,
}

impl DirectoryAssetProvider {
    /// Restrict a provider to an existing canonical directory.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::Io`] when the root cannot be canonicalized.
    pub fn new(root: impl AsRef<Path>) -> Result<Self, AssetError> {
        let path = root.as_ref();
        Ok(Self {
            root: path.canonicalize().map_err(|source| AssetError::Io {
                path: path.to_path_buf(),
                source,
            })?,
        })
    }
}

impl AssetProvider for DirectoryAssetProvider {
    fn load(&self, name: &str) -> Result<AssetData, String> {
        let direct = self.root.join(name);
        let path = if direct.exists() {
            direct
        } else {
            [
                "svg", "png", "jpg", "jpeg", "webp", "gif", "bmp", "tif", "tiff",
            ]
            .into_iter()
            .map(|extension| self.root.join(name).with_extension(extension))
            .find(|candidate| candidate.exists())
            .ok_or_else(|| format!("asset `{name}` does not exist"))?
        };
        let canonical = path.canonicalize().map_err(|error| error.to_string())?;
        if !canonical.starts_with(&self.root) {
            return Err("asset escaped provider root".to_owned());
        }
        let mime_type = mime_for_path(&canonical)
            .ok_or_else(|| "asset has an unsupported image extension".to_owned())?;
        let bytes = fs::read(&canonical).map_err(|error| error.to_string())?;
        Ok(AssetData {
            mime_type: mime_type.to_owned(),
            bytes,
        })
    }
}

fn mime_for_path(path: &Path) -> Option<&'static str> {
    match path.extension()?.to_str()?.to_ascii_lowercase().as_str() {
        "png" => Some("image/png"),
        "jpg" | "jpeg" => Some("image/jpeg"),
        "webp" => Some("image/webp"),
        "gif" => Some("image/gif"),
        "svg" => Some("image/svg+xml"),
        "bmp" => Some("image/bmp"),
        "tif" | "tiff" => Some("image/tiff"),
        _ => None,
    }
}

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ImageHandle {
    opaque: OpaqueHandle,
    asset: AssetId,
}

impl ImageHandle {
    #[must_use]
    pub fn opaque(&self) -> &OpaqueHandle {
        &self.opaque
    }

    #[must_use]
    pub fn asset(&self) -> &AssetId {
        &self.asset
    }
}

#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ImageDecodeHandle(u64);

impl CustomType for ImageDecodeHandle {
    fn build(mut builder: TypeBuilder<Self>) {
        builder
            .with_name("ImageDecodeHandle")
            .with_fn("to_string", |handle: &mut Self| {
                format!("image-decode#{}", handle.0)
            });
    }
}

#[derive(Clone, Debug)]
struct PendingImageDecode {
    asset: AssetId,
    scope: AsyncScope,
    generation: ScriptGeneration,
    success: ScriptCallback,
    error: ScriptCallback,
    canceled: Arc<AtomicBool>,
}

struct ImageDecodeMessage {
    id: u64,
    result: Result<(ImageFormat, AssetData), String>,
}

#[derive(Clone, Debug)]
pub(crate) struct ImageDecodeSnapshot {
    pending: BTreeMap<u64, PendingImageDecode>,
    deferred: BTreeMap<u64, PendingImageDecode>,
    transaction_depth: usize,
}

fn defer_or_cancel_decode(inner: &mut AssetRegistryInner, id: u64, pending: PendingImageDecode) {
    if inner.transaction_depth > 0 {
        inner.deferred_decode_cancellations.insert(id, pending);
    } else {
        pending.canceled.store(true, Ordering::Release);
    }
}

fn cancel_decode_ids(inner: &mut AssetRegistryInner, ids: impl IntoIterator<Item = u64>) {
    for id in ids {
        if let Some(pending) = inner.pending_decodes.remove(&id) {
            defer_or_cancel_decode(inner, id, pending);
        }
    }
}

struct AssetRegistryInner {
    providers: BTreeMap<String, Box<dyn AssetProvider>>,
    by_asset: BTreeMap<AssetId, ImageHandle>,
    images: BTreeMap<u64, Arc<Image>>,
    image_data: BTreeMap<u64, AssetData>,
    tinted_images: BTreeMap<(u64, u32), Arc<Image>>,
    next_id: u64,
    next_decode_id: u64,
    pending_decodes: BTreeMap<u64, PendingImageDecode>,
    deferred_decode_cancellations: BTreeMap<u64, PendingImageDecode>,
    transaction_depth: usize,
    decode_sender: Sender<ImageDecodeMessage>,
    decode_receiver: Receiver<ImageDecodeMessage>,
}

impl Default for AssetRegistryInner {
    fn default() -> Self {
        let (decode_sender, decode_receiver) = channel();
        Self {
            providers: BTreeMap::new(),
            by_asset: BTreeMap::new(),
            images: BTreeMap::new(),
            image_data: BTreeMap::new(),
            tinted_images: BTreeMap::new(),
            next_id: 0,
            next_decode_id: 1,
            pending_decodes: BTreeMap::new(),
            deferred_decode_cancellations: BTreeMap::new(),
            transaction_depth: 0,
            decode_sender,
            decode_receiver,
        }
    }
}

#[derive(Clone, Default)]
pub struct AssetRegistry {
    inner: Rc<RefCell<AssetRegistryInner>>,
}

impl std::fmt::Debug for AssetRegistry {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self.inner.try_borrow() {
            Ok(inner) => formatter
                .debug_struct("AssetRegistry")
                .field("providers", &inner.providers.keys().collect::<Vec<_>>())
                .field("cached", &inner.by_asset.keys().collect::<Vec<_>>())
                .finish_non_exhaustive(),
            Err(_) => formatter.write_str("AssetRegistry(<borrowed>)"),
        }
    }
}

impl AssetRegistry {
    pub(crate) fn begin_transaction(&self) -> Result<ImageDecodeSnapshot, AssetError> {
        let snapshot = self.decode_snapshot()?;
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        inner.transaction_depth = inner.transaction_depth.saturating_add(1);
        Ok(snapshot)
    }

    pub(crate) fn commit_transaction(&self) -> Result<(), AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        inner.transaction_depth = inner.transaction_depth.saturating_sub(1);
        if inner.transaction_depth == 0 {
            for pending in std::mem::take(&mut inner.deferred_decode_cancellations).into_values() {
                pending.canceled.store(true, Ordering::Release);
            }
        }
        Ok(())
    }

    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Register one logical asset namespace.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError`] for invalid or duplicate namespaces.
    pub fn register(
        &self,
        namespace: impl Into<String>,
        provider: impl AssetProvider + 'static,
    ) -> Result<(), AssetError> {
        let namespace = namespace.into();
        if !valid_segment(&namespace) {
            return Err(AssetError::InvalidNamespace(namespace));
        }
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        if inner.providers.contains_key(&namespace) {
            return Err(AssetError::DuplicateNamespace(namespace));
        }
        inner.providers.insert(namespace, Box::new(provider));
        Ok(())
    }

    /// Reload every cached image in a provider namespace while preserving
    /// existing opaque handle identities.
    ///
    /// # Errors
    ///
    /// Returns provider, MIME, empty-data, or borrow errors. Validation is
    /// transactional: existing cached bytes remain active on failure.
    pub fn refresh_namespace(&self, namespace: &str) -> Result<usize, AssetError> {
        let refreshed = {
            let inner = self.inner.try_borrow().map_err(|_| AssetError::Borrowed)?;
            let provider = inner
                .providers
                .get(namespace)
                .ok_or_else(|| AssetError::UnknownNamespace(namespace.to_owned()))?;
            inner
                .by_asset
                .iter()
                .filter(|(asset, _)| asset.split().0 == namespace)
                .map(|(asset, handle)| {
                    let (_, name) = asset.split();
                    let data = provider
                        .load(name)
                        .map_err(|message| AssetError::Provider {
                            asset: asset.clone(),
                            message,
                        })?;
                    let format = ImageFormat::from_mime_type(&data.mime_type)
                        .ok_or_else(|| AssetError::UnsupportedMime(data.mime_type.clone()))?;
                    if data.bytes.is_empty() {
                        return Err(AssetError::Empty(asset.clone()));
                    }
                    Ok((
                        handle.opaque.id(),
                        data.clone(),
                        Arc::new(Image::from_bytes(format, data.bytes)),
                    ))
                })
                .collect::<Result<Vec<_>, AssetError>>()?
        };
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        for (id, data, image) in &refreshed {
            inner.images.insert(*id, Arc::clone(image));
            inner.image_data.insert(*id, data.clone());
            inner
                .tinted_images
                .retain(|(image_id, _), _| image_id != id);
        }
        Ok(refreshed.len())
    }

    /// Load, validate, decode, and cache an image by logical ID.
    ///
    /// # Errors
    ///
    /// Returns provider, MIME, decode-boundary, or borrow errors.
    pub fn load_image(&self, id: &AssetId) -> Result<ImageHandle, AssetError> {
        if let Some(handle) = self
            .inner
            .try_borrow()
            .map_err(|_| AssetError::Borrowed)?
            .by_asset
            .get(id)
            .cloned()
        {
            return Ok(handle);
        }
        let (namespace, name) = id.split();
        let data = {
            let inner = self.inner.try_borrow().map_err(|_| AssetError::Borrowed)?;
            inner
                .providers
                .get(namespace)
                .ok_or_else(|| AssetError::UnknownNamespace(namespace.to_owned()))?
                .load(name)
                .map_err(|message| AssetError::Provider {
                    asset: id.clone(),
                    message,
                })?
        };
        let format = ImageFormat::from_mime_type(&data.mime_type)
            .ok_or_else(|| AssetError::UnsupportedMime(data.mime_type.clone()))?;
        if data.bytes.is_empty() {
            return Err(AssetError::Empty(id.clone()));
        }
        let image = Arc::new(Image::from_bytes(format, data.bytes.clone()));
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        inner.next_id = inner.next_id.saturating_add(1);
        let image_id = inner.next_id;
        let handle = ImageHandle {
            opaque: OpaqueHandle::new("image", image_id),
            asset: id.clone(),
        };
        inner.images.insert(image_id, image);
        inner.image_data.insert(image_id, data);
        inner.by_asset.insert(id.clone(), handle.clone());
        Ok(handle)
    }

    /// Preload a deterministic set of declared image assets.
    ///
    /// # Errors
    ///
    /// Returns the first provider/MIME/data error without hiding which asset
    /// failed. Successfully loaded earlier entries remain cached and reusable.
    pub fn preload_images(
        &self,
        ids: impl IntoIterator<Item = AssetId>,
    ) -> Result<usize, AssetError> {
        let mut loaded = 0;
        for id in ids {
            self.load_image(&id)?;
            loaded += 1;
        }
        Ok(loaded)
    }

    /// Resolve a declarative asset only if preparation already cached it.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::NotPreloaded`] instead of performing provider I/O.
    pub fn cached_image(&self, id: &AssetId) -> Result<ImageHandle, AssetError> {
        self.inner
            .try_borrow()
            .map_err(|_| AssetError::Borrowed)?
            .by_asset
            .get(id)
            .cloned()
            .ok_or_else(|| AssetError::NotPreloaded(id.clone()))
    }

    /// Start background validation/decoding for a logical image while keeping
    /// callbacks and runtime ownership on the foreground thread.
    ///
    /// # Errors
    ///
    /// Returns provider, borrow, or worker-spawn errors.
    pub fn start_image_decode(
        &self,
        id: &AssetId,
        scope: AsyncScope,
        generation: ScriptGeneration,
        success: ScriptCallback,
        error: ScriptCallback,
    ) -> Result<ImageDecodeHandle, AssetError> {
        let (namespace, name) = id.split();
        let data = {
            let inner = self.inner.try_borrow().map_err(|_| AssetError::Borrowed)?;
            inner
                .providers
                .get(namespace)
                .ok_or_else(|| AssetError::UnknownNamespace(namespace.to_owned()))?
                .load(name)
                .map_err(|message| AssetError::Provider {
                    asset: id.clone(),
                    message,
                })?
        };
        let (decode_id, sender, canceled) = {
            let mut inner = self
                .inner
                .try_borrow_mut()
                .map_err(|_| AssetError::Borrowed)?;
            let decode_id = inner.next_decode_id;
            inner.next_decode_id = inner.next_decode_id.saturating_add(1);
            let canceled = Arc::new(AtomicBool::new(false));
            inner.pending_decodes.insert(
                decode_id,
                PendingImageDecode {
                    asset: id.clone(),
                    scope,
                    generation,
                    success,
                    error,
                    canceled: canceled.clone(),
                },
            );
            (decode_id, inner.decode_sender.clone(), canceled)
        };
        let worker_cancel = canceled.clone();
        if let Err(source) = std::thread::Builder::new()
            .name("gpui-rhai-image-decode".to_owned())
            .spawn(move || {
                if worker_cancel.load(Ordering::Acquire) {
                    return;
                }
                let result = decode_asset_data(data);
                if !worker_cancel.load(Ordering::Acquire) {
                    let _ = sender.send(ImageDecodeMessage {
                        id: decode_id,
                        result,
                    });
                }
            })
        {
            canceled.store(true, Ordering::Release);
            self.inner
                .try_borrow_mut()
                .map_err(|_| AssetError::Borrowed)?
                .pending_decodes
                .remove(&decode_id);
            return Err(AssetError::DecodeSpawn(source));
        }
        Ok(ImageDecodeHandle(decode_id))
    }

    /// Cancel one pending decode. Completed or unknown handles return `false`.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::Borrowed`] during conflicting registry access.
    pub fn cancel_image_decode(&self, handle: ImageDecodeHandle) -> Result<bool, AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        let Some(pending) = inner.pending_decodes.remove(&handle.0) else {
            return Ok(false);
        };
        defer_or_cancel_decode(&mut inner, handle.0, pending);
        Ok(true)
    }

    /// Cancel pending image work owned by a closing window and its components.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::Borrowed`] during conflicting registry access.
    pub fn cancel_window_scope(
        &self,
        window: &str,
        component: &ComponentInstancePath,
    ) -> Result<(), AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        let remove = inner
            .pending_decodes
            .iter()
            .filter_map(|(id, pending)| {
                let remove = match &pending.scope {
                    AsyncScope::Window(id) => id == window,
                    AsyncScope::Component(_) | AsyncScope::Effect { .. } => {
                        pending.scope.is_within_component(component)
                    }
                    AsyncScope::App => false,
                };
                remove.then_some(*id)
            })
            .collect::<Vec<_>>();
        cancel_decode_ids(&mut inner, remove);
        Ok(())
    }

    /// Cancel pending image work owned by a removed component subtree.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::Borrowed`] during conflicting registry access.
    pub fn cancel_component_scope(
        &self,
        component: &ComponentInstancePath,
    ) -> Result<(), AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        let remove = inner
            .pending_decodes
            .iter()
            .filter_map(|(id, pending)| pending.scope.is_within_component(component).then_some(*id))
            .collect::<Vec<_>>();
        cancel_decode_ids(&mut inner, remove);
        Ok(())
    }

    /// Cancel pending image work owned by one exact asynchronous scope.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::Borrowed`] during conflicting registry access.
    pub fn cancel_scope(&self, scope: &AsyncScope) -> Result<(), AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        let remove = inner
            .pending_decodes
            .iter()
            .filter_map(|(id, pending)| (&pending.scope == scope).then_some(*id))
            .collect::<Vec<_>>();
        cancel_decode_ids(&mut inner, remove);
        Ok(())
    }

    /// Cancel pending decode work from obsolete script generations.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError::Borrowed`] during conflicting registry access.
    pub fn retain_decode_generation(&self, generation: ScriptGeneration) -> Result<(), AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        inner.pending_decodes.retain(|_, pending| {
            let retain = pending.generation == generation;
            if !retain {
                pending.canceled.store(true, Ordering::Release);
            }
            retain
        });
        Ok(())
    }

    /// Install completed images and return generation-safe callback deliveries.
    ///
    /// # Errors
    ///
    /// Returns a borrow error if called during another asset registry access.
    pub fn drain_image_decodes(
        &self,
        generation: ScriptGeneration,
    ) -> Result<Vec<AsyncDelivery>, AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        let mut messages = Vec::new();
        while let Ok(message) = inner.decode_receiver.try_recv() {
            messages.push(message);
        }
        let mut deliveries = Vec::new();
        for message in messages {
            let Some(pending) = inner.pending_decodes.remove(&message.id) else {
                continue;
            };
            if pending.canceled.load(Ordering::Acquire) || pending.generation != generation {
                continue;
            }
            let (callback, payload) = match message.result {
                Ok((format, data)) => {
                    let handle = install_decoded_image(&mut inner, pending.asset, format, data);
                    (pending.success, UiValue::Handle(handle.opaque().clone()))
                }
                Err(message) => (pending.error, UiValue::String(message)),
            };
            deliveries.push(AsyncDelivery {
                callback,
                payload,
                scope: pending.scope,
            });
        }
        Ok(deliveries)
    }

    #[must_use]
    pub fn pending_decode_count(&self) -> usize {
        self.inner
            .try_borrow()
            .map_or(0, |inner| inner.pending_decodes.len())
    }

    pub(crate) fn decode_snapshot(&self) -> Result<ImageDecodeSnapshot, AssetError> {
        let inner = self.inner.try_borrow().map_err(|_| AssetError::Borrowed)?;
        Ok(ImageDecodeSnapshot {
            pending: inner.pending_decodes.clone(),
            deferred: inner.deferred_decode_cancellations.clone(),
            transaction_depth: inner.transaction_depth,
        })
    }

    pub(crate) fn restore_decode_snapshot(
        &self,
        snapshot: ImageDecodeSnapshot,
    ) -> Result<(), AssetError> {
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        for (id, pending) in inner
            .pending_decodes
            .iter()
            .chain(inner.deferred_decode_cancellations.iter())
        {
            if !snapshot.pending.contains_key(id) && !snapshot.deferred.contains_key(id) {
                pending.canceled.store(true, Ordering::Release);
            }
        }
        inner.pending_decodes = snapshot.pending;
        inner.deferred_decode_cancellations = snapshot.deferred;
        inner.transaction_depth = snapshot.transaction_depth;
        Ok(())
    }

    /// Resolve an opaque image handle into a GPUI image source.
    ///
    /// # Errors
    ///
    /// Returns [`AssetError`] for wrong-kind, unknown, or borrow errors.
    pub fn image_source(&self, handle: &OpaqueHandle) -> Result<ImageSource, AssetError> {
        self.image_source_tinted(handle, None)
    }

    /// Resolve an image and apply semantic `currentColor` inheritance to SVG
    /// bytes. Raster images reuse their original cache entry.
    ///
    /// # Errors
    ///
    /// Returns wrong-kind, unknown, malformed-SVG, or borrow errors.
    pub fn image_source_tinted(
        &self,
        handle: &OpaqueHandle,
        color: Option<Rgba8>,
    ) -> Result<ImageSource, AssetError> {
        if handle.kind() != "image" {
            return Err(AssetError::WrongHandleKind(handle.kind().to_owned()));
        }
        let mut inner = self
            .inner
            .try_borrow_mut()
            .map_err(|_| AssetError::Borrowed)?;
        let Some(data) = inner.image_data.get(&handle.id()).cloned() else {
            return Err(AssetError::UnknownHandle(handle.id()));
        };
        let image = if data.mime_type == "image/svg+xml"
            && let Some(color) = color
        {
            let key = (handle.id(), color.as_rgba_hex());
            if let Some(image) = inner.tinted_images.get(&key) {
                image.clone()
            } else {
                let bytes = tint_svg(&data.bytes, color)?;
                let image = Arc::new(Image::from_bytes(ImageFormat::Svg, bytes));
                inner.tinted_images.insert(key, image.clone());
                image
            }
        } else {
            inner
                .images
                .get(&handle.id())
                .cloned()
                .ok_or(AssetError::UnknownHandle(handle.id()))?
        };
        Ok(ImageSource::Image(image))
    }
}

fn install_decoded_image(
    inner: &mut AssetRegistryInner,
    asset: AssetId,
    format: ImageFormat,
    data: AssetData,
) -> ImageHandle {
    if let Some(handle) = inner.by_asset.get(&asset) {
        return handle.clone();
    }
    inner.next_id = inner.next_id.saturating_add(1);
    let image_id = inner.next_id;
    let handle = ImageHandle {
        opaque: OpaqueHandle::new("image", image_id),
        asset: asset.clone(),
    };
    inner.images.insert(
        image_id,
        Arc::new(Image::from_bytes(format, data.bytes.clone())),
    );
    inner.image_data.insert(image_id, data);
    inner.by_asset.insert(asset, handle.clone());
    handle
}

fn decode_asset_data(data: AssetData) -> Result<(ImageFormat, AssetData), String> {
    if data.bytes.is_empty() {
        return Err("image data is empty".to_owned());
    }
    let format = ImageFormat::from_mime_type(&data.mime_type)
        .ok_or_else(|| format!("unsupported image MIME type `{}`", data.mime_type))?;
    if format == ImageFormat::Svg {
        let source = std::str::from_utf8(&data.bytes)
            .map_err(|_| "SVG image is not valid UTF-8".to_owned())?;
        if !source.contains("<svg") {
            return Err("SVG image has no root element".to_owned());
        }
    } else {
        let raster_format = raster_image_format(format)
            .ok_or_else(|| "unsupported raster image format".to_owned())?;
        image::load_from_memory_with_format(&data.bytes, raster_format)
            .map_err(|error| format!("raster image decode failed: {error}"))?;
    }
    Ok((format, data))
}

fn raster_image_format(format: ImageFormat) -> Option<image::ImageFormat> {
    match format {
        ImageFormat::Png => Some(image::ImageFormat::Png),
        ImageFormat::Jpeg => Some(image::ImageFormat::Jpeg),
        ImageFormat::Webp => Some(image::ImageFormat::WebP),
        ImageFormat::Gif => Some(image::ImageFormat::Gif),
        ImageFormat::Bmp => Some(image::ImageFormat::Bmp),
        ImageFormat::Tiff => Some(image::ImageFormat::Tiff),
        ImageFormat::Svg => None,
    }
}

fn tint_svg(bytes: &[u8], color: Rgba8) -> Result<Vec<u8>, AssetError> {
    let source = std::str::from_utf8(bytes).map_err(|_| AssetError::InvalidSvg)?;
    if !source.contains("<svg") {
        return Err(AssetError::InvalidSvg);
    }
    let rgb = color.as_rgba_hex() >> 8;
    Ok(source
        .replace("currentColor", &format!("#{rgb:06x}"))
        .replace("currentcolor", &format!("#{rgb:06x}"))
        .into_bytes())
}

fn valid_segment(value: &str) -> bool {
    !value.is_empty()
        && value
            .chars()
            .all(|character| character.is_ascii_alphanumeric() || matches!(character, '_' | '-'))
}

pub(crate) fn asset_id_from_script(value: &str) -> Result<AssetId, Box<rhai::EvalAltResult>> {
    AssetId::parse(value).map_err(|error| error.to_string().into())
}

#[derive(Debug, Error)]
pub enum AssetError {
    #[error("asset ID `{0}` must be a namespaced logical path")]
    InvalidId(String),
    #[error("asset namespace `{0}` is invalid")]
    InvalidNamespace(String),
    #[error("asset namespace `{0}` is already registered")]
    DuplicateNamespace(String),
    #[error("asset namespace `{0}` is not registered")]
    UnknownNamespace(String),
    #[error("asset registry is already borrowed")]
    Borrowed,
    #[error("asset provider failed for `{asset:?}`: {message}")]
    Provider { asset: AssetId, message: String },
    #[error("image MIME type `{0}` is unsupported")]
    UnsupportedMime(String),
    #[error("image asset `{0:?}` is empty")]
    Empty(AssetId),
    #[error("SVG asset is not valid UTF-8 SVG data")]
    InvalidSvg,
    #[error("failed to spawn image decode worker: {0}")]
    DecodeSpawn(std::io::Error),
    #[error("opaque handle kind `{0}` is not an image")]
    WrongHandleKind(String),
    #[error("image handle `{0}` is unknown")]
    UnknownHandle(u64),
    #[error("declarative image asset `{0:?}` was not preloaded during preparation")]
    NotPreloaded(AssetId),
    #[error("asset I/O failed for `{path}`: {source}")]
    Io {
        path: PathBuf,
        #[source]
        source: std::io::Error,
    },
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;
    use std::time::Duration;

    use rhai::FnPtr;

    #[derive(Clone)]
    struct MutableProvider(Rc<RefCell<AssetData>>);

    impl AssetProvider for MutableProvider {
        fn load(&self, _: &str) -> Result<AssetData, String> {
            Ok(self.0.borrow().clone())
        }
    }

    fn one_pixel_png() -> Vec<u8> {
        let mut output = Cursor::new(Vec::new());
        image::DynamicImage::new_rgba8(1, 1)
            .write_to(&mut output, image::ImageFormat::Png)
            .unwrap();
        output.into_inner()
    }

    #[test]
    fn logical_ids_reject_urls_and_traversal() {
        for invalid in ["https://example.com/a.png", "/tmp/a.png", "core/../secret"] {
            assert!(AssetId::parse(invalid).is_err());
        }
        assert_eq!(AssetId::parse("core/check").unwrap().as_str(), "core/check");
    }

    #[test]
    fn provider_images_are_cached_behind_opaque_handles() {
        let registry = AssetRegistry::new();
        registry
            .register(
                "core",
                InMemoryAssetProvider::new(BTreeMap::from([(
                    "check".to_owned(),
                    AssetData {
                        mime_type: "image/svg+xml".to_owned(),
                        bytes: b"<svg xmlns=\"http://www.w3.org/2000/svg\"/>".to_vec(),
                    },
                )])),
            )
            .unwrap();
        let id = AssetId::parse("core/check").unwrap();
        let first = registry.load_image(&id).unwrap();
        let second = registry.load_image(&id).unwrap();
        assert_eq!(first, second);
        registry.image_source(first.opaque()).unwrap();
        assert!(matches!(
            registry.image_source(&OpaqueHandle::new("task", 1)),
            Err(AssetError::WrongHandleKind(_))
        ));
    }

    #[test]
    fn rejected_duplicate_provider_keeps_uncached_assets_from_the_original() {
        let registry = AssetRegistry::new();
        let data = AssetData {
            mime_type: "image/svg+xml".to_owned(),
            bytes: b"<svg xmlns='http://www.w3.org/2000/svg'/>".to_vec(),
        };
        registry
            .register(
                "app",
                InMemoryAssetProvider::new(BTreeMap::from([
                    ("first".to_owned(), data.clone()),
                    ("second".to_owned(), data),
                ])),
            )
            .unwrap();
        registry
            .load_image(&AssetId::parse("app/first").unwrap())
            .unwrap();
        assert!(matches!(
            registry.register("app", InMemoryAssetProvider::default()),
            Err(AssetError::DuplicateNamespace(_))
        ));
        registry
            .load_image(&AssetId::parse("app/second").unwrap())
            .unwrap();
    }

    #[test]
    fn namespace_refresh_preserves_handle_and_replaces_cached_bytes() {
        let data = Rc::new(RefCell::new(AssetData {
            mime_type: "image/svg+xml".to_owned(),
            bytes: b"<svg data-version=\"one\"/>".to_vec(),
        }));
        let registry = AssetRegistry::new();
        registry
            .register("app", MutableProvider(Rc::clone(&data)))
            .unwrap();
        let id = AssetId::parse("app/icon").unwrap();
        let handle = registry.load_image(&id).unwrap();
        data.borrow_mut().bytes = b"<svg data-version=\"two\"/>".to_vec();
        assert_eq!(registry.refresh_namespace("app").unwrap(), 1);
        assert_eq!(registry.load_image(&id).unwrap(), handle);
        assert_eq!(
            registry.inner.borrow().image_data[&handle.opaque.id()].bytes,
            b"<svg data-version=\"two\"/>"
        );
    }

    #[test]
    fn svg_current_color_is_semantically_tinted_and_cached() {
        let registry = AssetRegistry::new();
        registry
            .register(
                "core",
                InMemoryAssetProvider::new(BTreeMap::from([(
                    "check".to_owned(),
                    AssetData {
                        mime_type: "image/svg+xml".to_owned(),
                        bytes: b"<svg stroke=\"currentColor\"/>".to_vec(),
                    },
                )])),
            )
            .unwrap();
        let handle = registry
            .load_image(&AssetId::parse("core/check").unwrap())
            .unwrap();
        let color = Rgba8::from_rgb_hex(0x0012_34ab);
        let first = registry
            .image_source_tinted(handle.opaque(), Some(color))
            .unwrap();
        let second = registry
            .image_source_tinted(handle.opaque(), Some(color))
            .unwrap();
        let (ImageSource::Image(first), ImageSource::Image(second)) = (first, second) else {
            panic!("asset registry must return in-memory images");
        };
        assert!(Arc::ptr_eq(&first, &second));
        assert!(String::from_utf8_lossy(&first.bytes).contains("#1234ab"));
    }

    #[test]
    fn raster_decode_delivers_handle_on_foreground_drain() {
        let registry = AssetRegistry::new();
        registry
            .register(
                "app",
                InMemoryAssetProvider::new(BTreeMap::from([(
                    "pixel".to_owned(),
                    AssetData {
                        mime_type: "image/png".to_owned(),
                        bytes: one_pixel_png(),
                    },
                )])),
            )
            .unwrap();
        let generation = ScriptGeneration::initial();
        registry
            .start_image_decode(
                &AssetId::parse("app/pixel").unwrap(),
                AsyncScope::Component(crate::ComponentInstancePath::root("App", "root")),
                generation,
                ScriptCallback::try_from_fn_ptr(FnPtr::new("loaded").unwrap(), generation).unwrap(),
                ScriptCallback::try_from_fn_ptr(FnPtr::new("failed").unwrap(), generation).unwrap(),
            )
            .unwrap();
        let mut deliveries = Vec::new();
        for _ in 0..1_000 {
            deliveries = registry.drain_image_decodes(generation).unwrap();
            if !deliveries.is_empty() {
                break;
            }
            std::thread::sleep(Duration::from_millis(1));
        }
        assert_eq!(deliveries.len(), 1);
        assert_eq!(deliveries[0].callback.name(), "loaded");
        let UiValue::Handle(handle) = &deliveries[0].payload else {
            panic!("successful decode must deliver an image handle");
        };
        registry.image_source(handle).unwrap();
        assert_eq!(registry.pending_decode_count(), 0);
    }

    #[test]
    fn canceled_and_stale_image_decodes_do_not_deliver() {
        let registry = AssetRegistry::new();
        registry
            .register(
                "app",
                InMemoryAssetProvider::new(BTreeMap::from([(
                    "pixel".to_owned(),
                    AssetData {
                        mime_type: "image/png".to_owned(),
                        bytes: one_pixel_png(),
                    },
                )])),
            )
            .unwrap();
        let generation = ScriptGeneration::initial();
        let handle = registry
            .start_image_decode(
                &AssetId::parse("app/pixel").unwrap(),
                AsyncScope::App,
                generation,
                ScriptCallback::try_from_fn_ptr(FnPtr::new("loaded").unwrap(), generation).unwrap(),
                ScriptCallback::try_from_fn_ptr(FnPtr::new("failed").unwrap(), generation).unwrap(),
            )
            .unwrap();
        assert!(registry.cancel_image_decode(handle).unwrap());
        let effect_scope = AsyncScope::Effect {
            component: crate::ComponentInstancePath::root("App", "root"),
            key: "image".to_owned(),
            activation: 1,
        };
        registry
            .start_image_decode(
                &AssetId::parse("app/pixel").unwrap(),
                effect_scope.clone(),
                generation,
                ScriptCallback::try_from_fn_ptr(FnPtr::new("loaded").unwrap(), generation).unwrap(),
                ScriptCallback::try_from_fn_ptr(FnPtr::new("failed").unwrap(), generation).unwrap(),
            )
            .unwrap();
        registry.cancel_scope(&effect_scope).unwrap();
        registry
            .retain_decode_generation(generation.next())
            .unwrap();
        std::thread::sleep(Duration::from_millis(10));
        assert!(
            registry
                .drain_image_decodes(generation.next())
                .unwrap()
                .is_empty()
        );
        assert_eq!(registry.pending_decode_count(), 0);
    }

    #[test]
    fn transaction_rollback_restores_a_cancelled_decode_registration() {
        let registry = AssetRegistry::new();
        registry
            .register(
                "app",
                InMemoryAssetProvider::new(BTreeMap::from([(
                    "pixel".to_owned(),
                    AssetData {
                        mime_type: "image/png".to_owned(),
                        bytes: one_pixel_png(),
                    },
                )])),
            )
            .unwrap();
        let generation = ScriptGeneration::initial();
        let handle = registry
            .start_image_decode(
                &AssetId::parse("app/pixel").unwrap(),
                AsyncScope::App,
                generation,
                ScriptCallback::try_from_fn_ptr(FnPtr::new("loaded").unwrap(), generation).unwrap(),
                ScriptCallback::try_from_fn_ptr(FnPtr::new("failed").unwrap(), generation).unwrap(),
            )
            .unwrap();
        let snapshot = registry.begin_transaction().unwrap();
        assert!(registry.cancel_image_decode(handle).unwrap());
        assert_eq!(registry.pending_decode_count(), 0);
        registry.restore_decode_snapshot(snapshot).unwrap();
        assert_eq!(registry.pending_decode_count(), 1);
    }
}