pinready 0.23.2

Cross-platform configurator and launcher supporting the adoption of Visual Pinball 10.8.1 — for testers and early adopters, not a replacement for a stable production setup
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

//! The value VPX reads from a `*Display=` key.
//!
//! Up to VPX 10.8.1 rev 5514 it is the SDL display name (`DP-1 42"`). From rev
//! 5515 (vpinball/vpinball 2ba461a98, the fix for two identical screens) it is
//! a display id: the same name followed by the display's position in the
//! desktop layout, `DP-1 42" [3840, 0]`. A bare name no longer matches any
//! display there, so VPX falls back to the playfield screen for every window:
//! the backglass, the DMD and the topper all open on top of the playfield.

use crate::config::VpxConfig;
use crate::db::Database;

/// The first VPX revision that takes a display id rather than a name.
pub const FIRST_REVISION_WITH_IDS: u32 = 5515;

/// The git revision count in a `[Version] VPinball` stamp (`10816501` → 6501):
/// the stamp is major, minor and patch, one digit each, then the revision.
pub fn revision_from_stamp(stamp: &str) -> Option<u32> {
    let stamp = stamp.trim();
    if stamp.len() <= 4 || !stamp.bytes().all(|b| b.is_ascii_digit()) {
        return None;
    }
    stamp[4..].parse().ok()
}

/// The revision in a PinReady VPX tag (`v10.8.1-6501-3d9540861` → 6501).
pub fn revision_from_tag(tag: &str) -> Option<u32> {
    tag.trim().split('-').nth(1)?.parse().ok()
}

/// The revision of the VPX that will read the ini. The installed build's tag
/// says it best (the ini stamp lags until that build has run), then the stamp.
pub fn revision(config: &VpxConfig, db: &Database) -> Option<u32> {
    db.get_config("vpx_installed_tag")
        .and_then(|t| revision_from_tag(&t))
        .or_else(|| {
            config
                .get("Version", "VPinball")
                .and_then(|s| revision_from_stamp(&s))
        })
}

/// Whether that VPX takes display ids; unknown means the builds PinReady
/// installs today, which do.
pub fn uses_ids(config: &VpxConfig, db: &Database) -> bool {
    revision(config, db).is_none_or(|r| r >= FIRST_REVISION_WITH_IDS)
}

/// The first VPX revision without the B2SLegacy plugin (c88057303): its DMD
/// overlay keys and the `Priority.B2SLegacyDMD` renderer are gone. The B2S
/// plugin that replaces it shows the DMD on the score view by itself.
pub const FIRST_REVISION_WITHOUT_B2S_LEGACY: u32 = 6293;

/// The `*Display=` value for the display `name` at `(x, y)`.
pub fn value(name: &str, x: i32, y: i32, ids: bool) -> String {
    if ids {
        format!("{name} [{x}, {y}]")
    } else {
        name.to_string()
    }
}

/// The display name in a `*Display=` value, whichever form it has.
pub fn name_of(value: &str) -> &str {
    let v = value.trim_end();
    if let Some(open) = v.rfind(" [")
        && v.ends_with(']')
    {
        let inner = &v[open + 2..v.len() - 1];
        let mut parts = inner.split(',').map(str::trim);
        let is_int = |s: Option<&str>| s.is_some_and(|s| s.parse::<i32>().is_ok());
        if is_int(parts.next()) && is_int(parts.next()) && parts.next().is_none() {
            return &v[..open];
        }
    }
    v
}

/// Whether a `*Display=` value designates the display `name` at `(x, y)`:
/// the name must match, and the position too when the value carries one.
pub fn matches(value: &str, name: &str, x: i32, y: i32) -> bool {
    let v = value.trim_end();
    if name_of(v) != name {
        return false;
    }
    v == name || v == self::value(name, x, y, true)
}

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

    #[test]
    fn revision_comes_from_the_stamp_and_the_tag() {
        assert_eq!(revision_from_stamp("10815430"), Some(5430));
        assert_eq!(revision_from_stamp(" 10816501 "), Some(6501));
        assert_eq!(revision_from_stamp("1081"), None);
        assert_eq!(revision_from_stamp("10.8.1"), None);
        assert_eq!(revision_from_tag("v10.8.1-6501-3d9540861"), Some(6501));
        assert_eq!(revision_from_tag("v10.8.1"), None);
    }

    #[test]
    fn ids_carry_the_position() {
        assert_eq!(value("DP-1 42\"", 3840, 0, true), "DP-1 42\" [3840, 0]");
        assert_eq!(value("DP-1 42\"", 3840, 0, false), "DP-1 42\"");
        assert_eq!(value("HDMI-1", -1920, 0, true), "HDMI-1 [-1920, 0]");
    }

    #[test]
    fn the_name_reads_back_from_both_forms() {
        assert_eq!(name_of("DP-1 42\" [3840, 0]"), "DP-1 42\"");
        assert_eq!(name_of("HDMI-1 [-1920, 0]"), "HDMI-1");
        assert_eq!(name_of("DP-1 42\""), "DP-1 42\"");
        // A name that merely ends in brackets is left alone
        assert_eq!(name_of("Panel [rev B]"), "Panel [rev B]");
    }

    #[test]
    fn two_identical_screens_are_told_apart_by_position() {
        let v = "MetaVendor [3840, 0]";
        assert!(matches(v, "MetaVendor", 3840, 0));
        assert!(!matches(v, "MetaVendor", 0, 0));
        assert!(matches("MetaVendor", "MetaVendor", 0, 0));
        assert!(!matches(v, "Other", 3840, 0));
    }
}