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
mod file_utils;
mod game_file;
mod game_file_summary;
mod game_header;
mod read_write_impl;
use crate::GameFileError::{FileFormatInvalid, InvalidFileVersion};
use maikor_language::mem::sizes;
use std::fmt::Debug;
use std::io;
use thiserror::Error;
const ID_HEADER: [u8; 2] = [0xFD, 0xA1];
const FILE_HEADER_LENGTH: usize = 3;
const MAIKOR_HEADER_LENGTH: usize = 16;
const FILE_FORMAT_VER: u8 = 1;
const MIN_FILE_SIZE: u64 = MAIKOR_HEADER_LENGTH as u64 + sizes::CODE_BANK as u64 + 3;
const MAX_FILE_SIZE: u64 = 6000000;
#[derive(Error, Debug)]
pub enum GameFileError {
#[error("Maikor file not found")]
FileNotFound(),
#[error("Maikor file read error, not a file/can't access")]
NotAFile(),
#[error("Maikor file access error: {0}")]
FileAccessError(#[from] io::Error),
#[error("Maikor file too large. File was {0}, max is {MAX_FILE_SIZE}")]
FileTooLarge(u64),
#[error("Maikor file too small. This may be not be a valid Maikor file.")]
FileTooSmall(),
#[error("Not a Maikor game file")]
FileFormatInvalid(),
#[error("Unsupported Maikor game file version, was {0} and must be {FILE_FORMAT_VER}")]
InvalidFileVersion(u8),
#[error("Invalid/corrupt Maikor file")]
InvalidMaikorFile(),
#[error("Invalid atlas banks")]
InvalidAtlasBanks(),
#[error("Header validation failed:\n{0}")]
InvalidHeader(String),
}
#[derive(Debug, Eq, PartialEq)]
struct GameFileHeader {
id: [u8; 4],
build: [u8; 2],
compiled_for_maikor_version: [u8; 2],
min_maikor_version: [u8; 2],
code_bank_count: u8,
ram_bank_count: u8,
atlas_bank_count: u8,
name_length: u8,
version_length: u8,
author_length: u8,
}
#[derive(Debug, Eq, PartialEq)]
pub struct GameFileSummary {
header: GameFileHeader,
pub version: String,
pub name: String,
pub author: String,
}
#[derive(Eq)]
pub struct GameFile {
pub id: u32,
pub build: u16,
pub compiled_for_maikor_version: u16,
pub min_maikor_version: u16,
pub version: String,
pub name: String,
pub author: String,
pub ram_bank_count: usize,
pub main_code: Vec<u8>,
pub code_banks: Vec<[u8; sizes::CODE_BANK as usize]>,
pub atlas_banks: Vec<Vec<u8>>,
}
#[cfg(test)]
mod tests {
use super::*;
use maikor_language::mem::sizes;
use std::io::BufReader;
fn rand_u8() -> u8 {
fastrand::u8(0..=255)
}
fn maikor_from_bytes(bytes: Vec<u8>) -> GameFile {
GameFile::from_reader(BufReader::new(&*bytes)).unwrap()
}
fn summary_from_bytes(bytes: Vec<u8>) -> GameFileSummary {
assert!(bytes.len() > FILE_HEADER_LENGTH + MAIKOR_HEADER_LENGTH);
GameFileSummary::from_reader(&mut BufReader::new(&*bytes)).unwrap()
}
#[test]
fn basic_write() {
let maikor_game = GameFile {
id: 1,
build: 10,
compiled_for_maikor_version: 3,
min_maikor_version: 1,
version: "1".to_string(),
name: "Test".to_string(),
author: "Tester".to_string(),
ram_bank_count: 0,
main_code: vec![0; sizes::CODE_BANK as usize],
code_banks: vec![],
atlas_banks: vec![],
};
let bytes = maikor_game.as_bytes().unwrap();
assert_eq!(bytes.len(), 3 + 16 + 1 + 4 + 6 + 8192);
#[rustfmt::skip]
assert_eq!(
&bytes[0..=18],
&[
ID_HEADER[0],
ID_HEADER[1],
FILE_FORMAT_VER,
0, 1, 0, 3,
0, 0, 0, 1,
0, 10,
1, 4, 6,
0, 0, 0,
]
);
assert_eq!(&bytes[19..=22], "Test".as_bytes());
assert_eq!(&bytes[23..=28], "Tester".as_bytes());
assert_eq!(&bytes[29..=29], "1".as_bytes());
assert_eq!(&bytes[30..], [0; 8192]);
}
#[test]
fn basic_read() {
#[rustfmt::skip]
let mut bytes = vec![
ID_HEADER[0],
ID_HEADER[1],
FILE_FORMAT_VER,
0, 56, 1, 0,
0, 2, 45, 10,
0, 32,
2, 3, 1,
0, 1, 0,
];
bytes.extend_from_slice("btr".as_bytes());
bytes.extend_from_slice("t".as_bytes());
bytes.extend_from_slice("01".as_bytes());
let summary = summary_from_bytes(bytes.clone());
assert_eq!(summary.header.id, [0, 2, 45, 10]);
assert_eq!(summary.header.id(), 142602);
assert_eq!(summary.header.build, [0, 32]);
assert_eq!(summary.header.build(), 32);
assert_eq!(summary.header.version_length, 2);
assert_eq!(summary.header.name_length, 3);
assert_eq!(summary.header.author_length, 1);
assert_eq!(summary.header.code_bank_count, 0);
assert_eq!(summary.header.ram_bank_count, 1);
assert_eq!(summary.header.atlas_bank_count, 0);
assert_eq!(summary.header.min_maikor_version, [0, 56]);
assert_eq!(summary.header.min_version(), 56);
assert_eq!(summary.header.compiled_for_maikor_version, [1, 0]);
assert_eq!(summary.header.compile_version(), 256);
assert_eq!(summary.name, String::from("btr"));
assert_eq!(summary.author, String::from("t"));
assert_eq!(summary.version, String::from("01"));
bytes.extend_from_slice(&[0; sizes::CODE_BANK as usize]);
let game = maikor_from_bytes(bytes);
assert_eq!(game.id, 142602);
assert_eq!(game.min_maikor_version, 56);
assert_eq!(game.compiled_for_maikor_version, 256);
assert_eq!(game.build, 32);
assert_eq!(game.ram_bank_count, 1);
assert!(game.code_banks.is_empty());
assert!(game.atlas_banks.is_empty());
assert_eq!(game.version, String::from("01"));
assert_eq!(game.name, String::from("btr"));
assert_eq!(game.author, String::from("t"));
assert_eq!(game.main_code, &[0; sizes::CODE_BANK as usize]);
}
#[test]
fn write_and_read() {
let maikor_game = GameFile {
id: 125563563,
build: 1842,
compiled_for_maikor_version: 288,
min_maikor_version: 1,
version: "3".to_string(),
name: "WaR Test".to_string(),
author: "WaR Tester".to_string(),
ram_bank_count: 2,
main_code: vec![rand_u8(); sizes::CODE_BANK as usize],
code_banks: vec![],
atlas_banks: vec![vec![rand_u8(); sizes::ATLAS as usize], vec![rand_u8(); 500]],
};
let bytes = maikor_game.as_bytes().unwrap();
#[rustfmt::skip]
assert_eq!(
bytes.len(),
FILE_HEADER_LENGTH
+ MAIKOR_HEADER_LENGTH
+ 1 + 8 + 10 + 4
+ sizes::CODE_BANK as usize
+ sizes::ATLAS as usize
+ 500
);
let game = maikor_from_bytes(bytes);
assert!(PartialEq::eq(&maikor_game, &game));
assert_eq!(maikor_game, game);
}
}