fromsoftware-shared 0.14.0

Helpers for dealing with pointers and other common stuff across games
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

use pelite::pe64::{Pe, PeView};
use thiserror::Error;

pub const LANG_ID_EN: u16 = 0x0009;
pub const LANG_ID_JP: u16 = 0x0011;

#[derive(Debug, Error)]
pub enum DetectError {
    #[error("Executable doesn't contain version metadata")]
    MissingVersionMetadata,
    #[error("Executable doesn't contain language metadata")]
    MissingLanguageMetadata,
    #[error("Executable doesn't contain product name metadata")]
    MissingProductName,
    #[error("Expected executable name to be \"{expected}\", was \"{actual}\"")]
    WrongProduct {
        expected: &'static str,
        actual: String,
    },
    #[error(
        "Expected executable language ID to be {LANG_ID_EN:#04x} or {LANG_ID_JP:#04x}, was {0:#04x}"
    )]
    UnsupportedLanguage(u16),
    #[error("Unsupported game version {0}")]
    UnsupportedVersion(String),
}

pub trait GameVersion: Sized {
    const NAME: &'static str;

    fn from_lang_version(lang_id: u16, version: &str) -> Option<Self>;

    fn detect(module: &PeView) -> Result<Self, DetectError> {
        let resources = module.resources().unwrap();
        let info = resources.version_info().unwrap();

        let product_version = info
            .fixed()
            .ok_or(DetectError::MissingVersionMetadata)?
            .dwProductVersion;
        let version = format!(
            "{}.{}.{}.{}",
            product_version.Major,
            product_version.Minor,
            product_version.Patch,
            product_version.Build,
        );

        let language = *info
            .translation()
            .first()
            .ok_or(DetectError::MissingLanguageMetadata)?;
        let mut product_name: Option<String> = None;
        info.strings(language, |k, v| {
            if k == "ProductName" {
                product_name = Some(v.to_string());
            }
        });

        let product = product_name.ok_or(DetectError::MissingProductName)?;
        if normalize(&product) != Self::NAME {
            return Err(DetectError::WrongProduct {
                expected: Self::NAME,
                actual: product,
            });
        }

        let lang_id = language.lang_id & 0x03FF;
        if lang_id != LANG_ID_EN && lang_id != LANG_ID_JP {
            return Err(DetectError::UnsupportedLanguage(lang_id));
        }

        Self::from_lang_version(lang_id, &version).ok_or(DetectError::UnsupportedVersion(version))
    }
}

fn normalize(product: &str) -> String {
    product
        .chars()
        .filter(|c| c.is_alphanumeric() || c.is_whitespace())
        .collect::<String>()
        .to_lowercase()
}