astrelis-assets 0.2.4

Asset management module for Astrelis game engine
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
//! Asset loader traits and infrastructure.

use std::any::{Any, TypeId};
use std::collections::HashMap;
use std::sync::Arc;

use crate::error::{AssetError, AssetResult};
use crate::source::AssetSource;

/// Context provided to asset loaders during loading.
pub struct LoadContext<'a> {
    /// The source of the asset being loaded.
    pub source: &'a AssetSource,
    /// The raw bytes of the asset.
    pub bytes: &'a [u8],
    /// File extension (without the dot), if available.
    pub extension: Option<&'a str>,
}

impl<'a> LoadContext<'a> {
    /// Create a new load context.
    pub fn new(source: &'a AssetSource, bytes: &'a [u8], extension: Option<&'a str>) -> Self {
        Self {
            source,
            bytes,
            extension,
        }
    }
}

/// Default priority for loaders.
pub const DEFAULT_LOADER_PRIORITY: i32 = 0;

/// Trait for loading assets from bytes.
///
/// Implement this trait to add support for loading a specific asset type.
///
/// # Example
///
/// ```ignore
/// struct PngLoader;
///
/// impl AssetLoader for PngLoader {
///     type Asset = Texture;
///
///     fn extensions(&self) -> &[&str] {
///         &["png"]
///     }
///
///     fn load(&self, ctx: LoadContext<'_>) -> AssetResult<Self::Asset> {
///         // Decode PNG bytes into Texture...
///     }
/// }
/// ```
pub trait AssetLoader: Send + Sync + 'static {
    /// The asset type this loader produces.
    type Asset: Send + Sync + 'static;

    /// The file extensions this loader handles (without dots).
    ///
    /// Example: `&["png", "jpg", "jpeg"]`
    fn extensions(&self) -> &[&str];

    /// Load an asset from the provided context.
    fn load(&self, ctx: LoadContext<'_>) -> AssetResult<Self::Asset>;

    /// Priority for this loader. Higher priority loaders are tried first
    /// when multiple loaders handle the same extension for the same type.
    ///
    /// Default is 0. Use positive values to override default loaders.
    fn priority(&self) -> i32 {
        DEFAULT_LOADER_PRIORITY
    }
}

/// Type-erased asset loader for dynamic dispatch.
pub trait ErasedAssetLoader: Send + Sync {
    /// Get the type ID of the asset this loader produces.
    fn asset_type_id(&self) -> TypeId;

    /// Get a human-readable name for the asset type.
    fn asset_type_name(&self) -> &'static str;

    /// Get the file extensions this loader handles.
    fn extensions(&self) -> &[&str];

    /// Get the priority of this loader.
    fn priority(&self) -> i32;

    /// Load an asset and return it as a boxed Any.
    fn load_erased(&self, ctx: LoadContext<'_>) -> AssetResult<Box<dyn Any + Send + Sync>>;
}

impl<L: AssetLoader> ErasedAssetLoader for L
where
    L::Asset: crate::Asset,
{
    fn asset_type_id(&self) -> TypeId {
        TypeId::of::<L::Asset>()
    }

    fn asset_type_name(&self) -> &'static str {
        <L::Asset as crate::Asset>::type_name()
    }

    fn extensions(&self) -> &[&str] {
        AssetLoader::extensions(self)
    }

    fn priority(&self) -> i32 {
        AssetLoader::priority(self)
    }

    fn load_erased(&self, ctx: LoadContext<'_>) -> AssetResult<Box<dyn Any + Send + Sync>> {
        let asset = self.load(ctx)?;
        Ok(Box::new(asset))
    }
}

/// Key for indexing loaders by type and extension.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
struct LoaderKey {
    type_id: TypeId,
    extension: String,
}

/// Entry in the loader registry with priority.
struct LoaderEntry {
    loader: Arc<dyn ErasedAssetLoader>,
    priority: i32,
}

/// Registry of asset loaders, indexed by asset type and extension.
///
/// When loading an asset of type `T` with extension `.ext`, the registry
/// finds all loaders that:
/// 1. Produce type `T` (matching `TypeId`)
/// 2. Handle extension `ext`
///
/// If multiple loaders match, the one with highest priority is used.
#[derive(Default)]
pub struct LoaderRegistry {
    /// Loaders indexed by (TypeId, extension) -> sorted by priority (highest first).
    by_type_and_ext: HashMap<LoaderKey, Vec<LoaderEntry>>,
    /// All loaders for a given type (for listing).
    by_type: HashMap<TypeId, Vec<Arc<dyn ErasedAssetLoader>>>,
    /// All loaders for a given extension (for fallback/listing).
    by_extension: HashMap<String, Vec<LoaderEntry>>,
}

impl LoaderRegistry {
    /// Create a new empty loader registry.
    pub fn new() -> Self {
        Self::default()
    }

    /// Register a loader for its declared extensions.
    ///
    /// The loader will be used when loading assets of type `L::Asset`
    /// with any of the extensions returned by `extensions()`.
    pub fn register<L: AssetLoader>(&mut self, loader: L)
    where
        L::Asset: crate::Asset,
    {
        let loader = Arc::new(loader);
        let type_id = loader.asset_type_id();
        let priority = loader.priority();

        // Register for each extension
        for ext in loader.extensions() {
            let ext_lower = ext.to_lowercase();

            // Index by (type, extension)
            let key = LoaderKey {
                type_id,
                extension: ext_lower.clone(),
            };

            let entries = self.by_type_and_ext.entry(key).or_default();
            entries.push(LoaderEntry {
                loader: loader.clone(),
                priority,
            });
            // Sort by priority (highest first)
            entries.sort_by(|a, b| b.priority.cmp(&a.priority));

            // Index by extension only (for fallback)
            let ext_entries = self.by_extension.entry(ext_lower).or_default();
            ext_entries.push(LoaderEntry {
                loader: loader.clone(),
                priority,
            });
            ext_entries.sort_by(|a, b| b.priority.cmp(&a.priority));
        }

        // Index by type
        self.by_type.entry(type_id).or_default().push(loader);
    }

    /// Get the best loader for a specific type and extension.
    ///
    /// Returns the highest-priority loader that produces type `T` and handles `extension`.
    pub fn get_for_type_and_extension<T: 'static>(
        &self,
        extension: &str,
    ) -> Option<&Arc<dyn ErasedAssetLoader>> {
        let key = LoaderKey {
            type_id: TypeId::of::<T>(),
            extension: extension.to_lowercase(),
        };

        self.by_type_and_ext
            .get(&key)
            .and_then(|entries| entries.first())
            .map(|entry| &entry.loader)
    }

    /// Get all loaders for a specific asset type.
    pub fn get_by_type<T: 'static>(&self) -> Option<&[Arc<dyn ErasedAssetLoader>]> {
        self.by_type.get(&TypeId::of::<T>()).map(|v| v.as_slice())
    }

    /// Get all loaders for an extension (any type), sorted by priority.
    pub fn get_by_extension(&self, extension: &str) -> Option<&Arc<dyn ErasedAssetLoader>> {
        let ext_lower = extension.to_lowercase();
        self.by_extension
            .get(&ext_lower)
            .and_then(|entries| entries.first())
            .map(|entry| &entry.loader)
    }

    /// Check if a loader is registered for an extension and type.
    pub fn has_loader_for<T: 'static>(&self, extension: &str) -> bool {
        let key = LoaderKey {
            type_id: TypeId::of::<T>(),
            extension: extension.to_lowercase(),
        };
        self.by_type_and_ext.contains_key(&key)
    }

    /// Check if a loader is registered for a type.
    pub fn has_loader_for_type<T: 'static>(&self) -> bool {
        self.by_type.contains_key(&TypeId::of::<T>())
    }

    /// Check if any loader is registered for an extension.
    pub fn has_loader_for_extension(&self, extension: &str) -> bool {
        let ext_lower = extension.to_lowercase();
        self.by_extension.contains_key(&ext_lower)
    }

    /// Load an asset of type `T` using the appropriate loader.
    ///
    /// Finds a loader that:
    /// 1. Produces type `T`
    /// 2. Handles the given extension
    ///
    /// Returns an error if no such loader exists.
    pub fn load_typed<T: crate::Asset>(
        &self,
        source: &AssetSource,
        bytes: &[u8],
        extension: Option<&str>,
    ) -> AssetResult<T> {
        let ext = extension.ok_or_else(|| AssetError::NoLoaderForExtension {
            extension: "<none>".to_string(),
        })?;

        let loader =
            self.get_for_type_and_extension::<T>(ext)
                .ok_or_else(|| AssetError::NoLoader {
                    type_id: TypeId::of::<T>(),
                    type_name: Some(T::type_name()),
                })?;

        let ctx = LoadContext::new(source, bytes, Some(ext));
        let boxed = loader.load_erased(ctx)?;

        // This should always succeed since we looked up by TypeId
        boxed
            .downcast::<T>()
            .map(|b| *b)
            .map_err(|_| AssetError::TypeMismatch {
                expected: T::type_name(),
                actual: TypeId::of::<T>(),
            })
    }

    /// Load an asset using extension-based lookup (type-erased).
    ///
    /// Uses the highest-priority loader for the extension regardless of type.
    /// Primarily for backwards compatibility or when type is not known at compile time.
    pub fn load(
        &self,
        source: &AssetSource,
        bytes: &[u8],
        extension: Option<&str>,
    ) -> AssetResult<Box<dyn Any + Send + Sync>> {
        let ext = extension.ok_or_else(|| AssetError::NoLoaderForExtension {
            extension: "<none>".to_string(),
        })?;

        let loader =
            self.get_by_extension(ext)
                .ok_or_else(|| AssetError::NoLoaderForExtension {
                    extension: ext.to_string(),
                })?;

        let ctx = LoadContext::new(source, bytes, Some(ext));
        loader.load_erased(ctx)
    }

    /// List all registered extensions for a type.
    pub fn extensions_for_type<T: 'static>(&self) -> Vec<&str> {
        self.by_type
            .get(&TypeId::of::<T>())
            .map(|loaders| {
                loaders
                    .iter()
                    .flat_map(|l| l.extensions().iter().copied())
                    .collect()
            })
            .unwrap_or_default()
    }
}

/// A simple text loader that loads UTF-8 strings.
pub struct TextLoader;

impl AssetLoader for TextLoader {
    type Asset = String;

    fn extensions(&self) -> &[&str] {
        &["txt", "text", "md", "markdown"]
    }

    fn load(&self, ctx: LoadContext<'_>) -> AssetResult<Self::Asset> {
        String::from_utf8(ctx.bytes.to_vec()).map_err(|e| AssetError::LoaderError {
            path: ctx.source.display_path(),
            message: format!("Invalid UTF-8: {}", e),
        })
    }
}

/// A simple binary loader that loads raw bytes.
pub struct BytesLoader;

impl AssetLoader for BytesLoader {
    type Asset = Vec<u8>;

    fn extensions(&self) -> &[&str] {
        &["bin", "bytes", "dat"]
    }

    fn load(&self, ctx: LoadContext<'_>) -> AssetResult<Self::Asset> {
        Ok(ctx.bytes.to_vec())
    }
}

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

    // Test asset type
    #[derive(Debug, PartialEq)]
    struct TestData {
        value: i32,
    }

    impl Asset for TestData {
        fn type_name() -> &'static str {
            "TestData"
        }
    }

    // Low priority loader
    struct LowPriorityLoader;

    impl AssetLoader for LowPriorityLoader {
        type Asset = TestData;

        fn extensions(&self) -> &[&str] {
            &["dat"]
        }

        fn priority(&self) -> i32 {
            -10
        }

        fn load(&self, _ctx: LoadContext<'_>) -> AssetResult<Self::Asset> {
            Ok(TestData { value: 1 })
        }
    }

    // High priority loader
    struct HighPriorityLoader;

    impl AssetLoader for HighPriorityLoader {
        type Asset = TestData;

        fn extensions(&self) -> &[&str] {
            &["dat"]
        }

        fn priority(&self) -> i32 {
            10
        }

        fn load(&self, _ctx: LoadContext<'_>) -> AssetResult<Self::Asset> {
            Ok(TestData { value: 100 })
        }
    }

    #[test]
    fn test_text_loader() {
        let loader = TextLoader;
        let source = AssetSource::memory("test.txt");
        let bytes = b"Hello, World!";
        let ctx = LoadContext::new(&source, bytes, Some("txt"));

        let result = loader.load(ctx).unwrap();
        assert_eq!(result, "Hello, World!");
    }

    #[test]
    fn test_bytes_loader() {
        let loader = BytesLoader;
        let source = AssetSource::memory("test.bin");
        let bytes = &[0u8, 1, 2, 3, 4];
        let ctx = LoadContext::new(&source, bytes, Some("bin"));

        let result = loader.load(ctx).unwrap();
        assert_eq!(result, vec![0, 1, 2, 3, 4]);
    }

    #[test]
    fn test_loader_registry_by_type() {
        let mut registry = LoaderRegistry::new();
        registry.register(TextLoader);
        registry.register(BytesLoader);

        // Should find loader for String + txt
        assert!(registry.has_loader_for::<String>("txt"));
        assert!(registry.has_loader_for::<String>("TXT")); // Case insensitive

        // Should find loader for Vec<u8> + bin
        assert!(registry.has_loader_for::<Vec<u8>>("bin"));

        // Should NOT find String loader for bin (wrong type)
        assert!(!registry.has_loader_for::<String>("bin"));

        // Should NOT find Vec<u8> loader for txt (wrong type)
        assert!(!registry.has_loader_for::<Vec<u8>>("txt"));

        assert!(registry.has_loader_for_type::<String>());
        assert!(registry.has_loader_for_type::<Vec<u8>>());
    }

    #[test]
    fn test_loader_priority() {
        let mut registry = LoaderRegistry::new();

        // Register low priority first, then high priority
        registry.register(LowPriorityLoader);
        registry.register(HighPriorityLoader);

        // Should use high priority loader
        let source = AssetSource::memory("test.dat");
        let result: TestData = registry.load_typed(&source, b"", Some("dat")).unwrap();
        assert_eq!(result.value, 100);
    }

    #[test]
    fn test_loader_priority_reverse_order() {
        let mut registry = LoaderRegistry::new();

        // Register high priority first, then low priority
        registry.register(HighPriorityLoader);
        registry.register(LowPriorityLoader);

        // Should still use high priority loader
        let source = AssetSource::memory("test.dat");
        let result: TestData = registry.load_typed(&source, b"", Some("dat")).unwrap();
        assert_eq!(result.value, 100);
    }

    #[test]
    fn test_typed_load() {
        let mut registry = LoaderRegistry::new();
        registry.register(TextLoader);

        let source = AssetSource::memory("test.txt");
        let result: String = registry
            .load_typed(&source, b"Hello!", Some("txt"))
            .unwrap();
        assert_eq!(result, "Hello!");
    }

    #[test]
    fn test_no_loader_for_type_extension_combo() {
        let mut registry = LoaderRegistry::new();
        registry.register(TextLoader); // Only handles String

        // Try to load TestData from .txt - should fail
        let source = AssetSource::memory("test.txt");
        let result: AssetResult<TestData> = registry.load_typed(&source, b"data", Some("txt"));
        assert!(result.is_err());
    }
}