vpin 0.23.5

Rust library for working with Visual Pinball VPX files
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

use super::biff::{self, BiffReader, BiffWriter};
use log::warn;
use serde::{Deserialize, Serialize};
use std::fmt;

// TODO comment here a vpx file that contains font data

#[derive(PartialEq)]
pub struct FontData {
    pub name: String,
    pub path: String, // patho of original file for easy re-importing
    pub data: Vec<u8>,
}

#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub(crate) struct FontDataJson {
    name: String,
    path: String,
}

impl FontDataJson {
    pub fn from_font_data(font_data: &FontData) -> Self {
        Self {
            name: font_data.name.clone(),
            path: font_data.path.clone(),
        }
    }
    pub fn to_font_data(&self) -> FontData {
        FontData {
            name: self.name.clone(),
            path: self.path.clone(),
            data: vec![],
        }
    }
}

impl fmt::Debug for FontData {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        // avoid writing the data to the debug output
        f.debug_struct("FontData")
            .field("name", &self.name)
            .field("path", &self.path)
            .field("data", &format!("<{} bytes>", self.data.len()))
            .finish()
    }
}

impl FontData {
    pub(crate) fn ext(&self) -> String {
        // TODO we might want to also check the jpeg fsPath
        match self.path.split('.').next_back() {
            Some(ext) => ext.to_string(),
            None => "bin".to_string(),
        }
    }
}

pub fn read(input: &[u8]) -> FontData {
    let mut reader = BiffReader::new(input);
    let mut name: String = "".to_string();
    let mut path: String = "".to_string();
    let mut size_opt: Option<u32> = None;
    let mut data: Vec<u8> = vec![];
    loop {
        reader.next(biff::WARN);
        if reader.is_eof() {
            break;
        }
        let tag = reader.tag();
        let tag_str = tag.as_str();
        match tag_str {
            "NAME" => {
                name = reader.get_string();
            }
            "PATH" => {
                path = reader.get_string();
            }
            "SIZE" => {
                size_opt = Some((reader.get_u32()).to_owned());
            }
            "DATA" => match size_opt {
                Some(size) => {
                    let d = reader.get_data(size.try_into().unwrap());
                    d.clone_into(&mut data);
                }
                None => {
                    panic!("DATA tag without SIZE tag");
                }
            },
            _ => {
                warn!("Skipping font tag: {tag_str}");
                reader.skip_tag();
            }
        }
    }
    FontData { name, path, data }
}

pub fn write(font_data: &FontData) -> Vec<u8> {
    let mut writer = BiffWriter::new();
    writer.write_tagged_string("NAME", &font_data.name);
    writer.write_tagged_string("PATH", &font_data.path);
    writer.write_tagged_u32("SIZE", font_data.data.len().try_into().unwrap());
    writer.write_tagged_data("DATA", &font_data.data);
    writer.close(true);
    writer.get_data().to_owned()
}

#[test]
fn read_write() {
    use pretty_assertions::assert_eq;

    let font = FontData {
        name: "test_name".to_string(),
        path: "/tmp/test".to_string(),
        data: vec![1, 2, 3, 4],
    };
    let bytes = write(&font);
    let font_read = read(&bytes);

    assert_eq!(font, font_read);
}