Skip to main content

elemental_driver/inspect/
identity.rs

1use elemental_core::minecraft::MinecraftVersionId;
2use elemental_schema::mojang::piston::PistonMetaData;
3
4use crate::driver::{DriverDescriptor, InstalledDriver};
5
6use super::{LibraryPrefixSet, ProfileIdPattern};
7
8/// Identity of a driver whose installed loader version can be recovered from
9/// version JSON metadata.
10///
11/// To support a new driver:
12/// - Set `descriptor` to the driver's `DriverDescriptor`.
13/// - Put Maven coordinates that only appear when the loader is installed in
14///   `markers`. If the loader leaves no such library behind, matching falls back
15///   to the profile id shape.
16/// - Put the coordinates that carry the installed loader version in
17///   `version_libraries`. Coordinates that merely prove the loader is present
18///   must stay in `markers`, not here.
19/// - Describe the profile id with `ProfileIdPattern`: use `ProfileIdPattern::new`
20///   for `<game><separator><loader>` ids and `ProfileIdPattern::loader_prefixed`
21///   for `<prefix><loader>` ids.
22/// - Add `with_stale_markers` when a legacy coordinate must force a metadata
23///   refresh.
24///
25/// Version lookup prefers `version_libraries` and falls back to the profile id.
26/// The shared installer/version-json inspection path consumes this identity
27/// directly, so a driver does not need to override `inspect_installed`.
28#[derive(Debug, Clone, Copy, PartialEq, Eq)]
29pub struct ProfiledDriverIdentity {
30    descriptor: DriverDescriptor,
31    markers: LibraryPrefixSet,
32    version_libraries: LibraryPrefixSet,
33    profile_id: ProfileIdPattern,
34    stale_markers: Option<LibraryPrefixSet>,
35}
36
37impl ProfiledDriverIdentity {
38    pub const fn new(
39        descriptor: DriverDescriptor,
40        markers: LibraryPrefixSet,
41        version_libraries: LibraryPrefixSet,
42        profile_id: ProfileIdPattern,
43    ) -> Self {
44        Self {
45            descriptor,
46            markers,
47            version_libraries,
48            profile_id,
49            stale_markers: None,
50        }
51    }
52
53    pub const fn with_stale_markers(self, stale_markers: LibraryPrefixSet) -> Self {
54        Self {
55            stale_markers: Some(stale_markers),
56            ..self
57        }
58    }
59
60    pub fn descriptor(self) -> DriverDescriptor {
61        self.descriptor
62    }
63
64    pub fn build_profile_id(self, game_version: &str, loader_version: &str) -> String {
65        self.profile_id.build(game_version, loader_version)
66    }
67
68    pub fn inspect_driver_version(self, metadata: &PistonMetaData) -> Option<String> {
69        self.version_libraries
70            .version(metadata)
71            .or_else(|| self.profile_id.loader_version(metadata.id.as_str()))
72    }
73
74    pub fn matches_metadata(self, metadata: &PistonMetaData) -> bool {
75        self.markers.matches(metadata)
76            || self
77                .profile_id
78                .loader_version(metadata.id.as_str())
79                .is_some()
80    }
81
82    pub fn local_metadata_needs_refresh(
83        self,
84        metadata: &PistonMetaData,
85        game_version: &MinecraftVersionId,
86        loader_version: &str,
87    ) -> bool {
88        metadata.id != self.build_profile_id(game_version.as_str(), loader_version)
89            || metadata.inherits_from.as_deref() != Some(game_version.as_str())
90            || self
91                .stale_markers
92                .is_some_and(|stale_markers| stale_markers.matches(metadata))
93            || self
94                .inspect_driver_version(metadata)
95                .is_none_or(|installed| installed != loader_version)
96    }
97
98    pub fn inspect_installed(self, metadata: &PistonMetaData) -> Option<InstalledDriver> {
99        if !self.matches_metadata(metadata) {
100            return None;
101        }
102
103        Some(InstalledDriver::version_json(
104            self.descriptor,
105            metadata,
106            self.inspect_driver_version(metadata),
107        ))
108    }
109}