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
use miniz_oxide::{deflate::compress_to_vec, inflate::decompress_to_vec};
use crate::{
io::Source,
parse::{Encode, Token, TokenBuilder},
prebuilt::{ver1_46, ver1_47},
proxy::TriggersProxy,
};
use std::{
fs::{self, File, OpenOptions},
io::{Read, Write},
};
pub struct Scenario {
pub versio: Token,
version: String,
}
impl Scenario {
/// Read scenario data from the given file.
/// Please check the github homepage for the version support status.
/// Generally, ver.1.46 and above are well supported.
/// # Examples
///
/// ```
/// use aoe2_probe::Scenario;
/// let scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario");
/// ```
pub fn from_file(filename: &str) -> Result<Self, String> {
let mut file = File::open(&filename).expect("File not found");
let metadata = fs::metadata(&filename).expect("Unable to read metadata");
let mut buffer = vec![0; metadata.len() as usize];
file.read_exact(&mut buffer).expect("buffer overflow");
Self::from_le_vec(buffer)
}
/// Read scenario data from the given little endian buffer.
/// # Examples
///
/// ```
/// use aoe2_probe::Scenario;
/// //Encode a scenario to a little endian vector of uint8
/// let source_scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario").unwrap();
/// let buffer = source_scenario.to_le_export_vec();
///
/// //Decode a scenario from a little endian vector of uint8
/// let scenario = Scenario::from_le_vec(buffer);
/// ```
pub fn from_le_vec(buffer: Vec<u8>) -> Result<Self, String> {
let version = Self::get_scenario_version(&buffer);
let mut source = Source::new(buffer);
match version.as_str() {
"1.46" => {
let header = TokenBuilder::create_from_template(
&ver1_46::FileHeader::template(),
&mut source,
);
let mut uncompressed = header.to_le_vec();
let content = decompress_to_vec(&source.get_rest_vec()).unwrap();
uncompressed.extend(content);
let mut source = Source::new(uncompressed);
Ok(Scenario {
versio: TokenBuilder::create_from_template(
&ver1_46::Versio::template(),
&mut source,
),
version,
})
}
"1.47" => {
let header = TokenBuilder::create_from_template(
&ver1_46::FileHeader::template(),
&mut source,
);
let mut uncompressed = header.to_le_vec();
let content = decompress_to_vec(&source.get_rest_vec()).unwrap();
uncompressed.extend(content);
let mut source = Source::new(uncompressed);
Ok(Scenario {
versio: TokenBuilder::create_from_template(
&ver1_47::Versio::template(),
&mut source,
),
version,
})
}
_ => Err("Unsupported version!".to_string()),
}
}
/// Encode a scenario struct to little endian vector of uint8
/// If you want to generate an .aoe2scenario file, then this function are not recommended.
/// The whole .aoe2scenario except file header part are compressed.
/// The bytes generated by this function are raw uncompressed.
/// See function to_export_le_vec for compressed bytes.
/// # Examples
///
/// ```
/// use aoe2_probe::Scenario;
/// //Encode a scenario to a little endian vector of uint8
/// let source_scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario").unwrap();
/// let buffer = source_scenario.to_le_vec();
/// ```
pub fn to_le_vec(self) -> Vec<u8> {
self.versio.to_le_vec()
}
/// Encode a scenario struct to little endian vector of uint8 that can be read by AoE2 DE
/// # Examples
///
/// ```
/// use aoe2_probe::Scenario;
/// //Encode a scenario to a little endian vector of uint8
/// let source_scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario").unwrap();
/// let buffer = source_scenario.to_le_export_vec();
/// ```
pub fn to_le_export_vec(self) -> Vec<u8> {
let file_header = &self.versio.try_map()["file_header"];
let mut content = file_header.to_le_vec();
let header_size = content.len();
let uncompressed = &self.versio.to_le_vec()[header_size..];
let mut compressed = compress_to_vec(uncompressed, 6);
content.append(&mut compressed);
content
}
/// Save the given scenario to the given path.
/// The path will be created if not existed.
/// # Examples
///
/// ```
/// use aoe2_probe::Scenario;
/// let source_scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario").unwrap();
/// let buffer = source_scenario.to_file("./resources/temp.aoe2scenario");
/// ```
pub fn to_file(self, file_path: &str) {
let buffer = self.to_le_export_vec();
let path = std::path::Path::new(file_path);
let prefix = path.parent().unwrap();
std::fs::create_dir_all(prefix).unwrap();
let mut file = OpenOptions::new()
.create(true)
.write(true)
.open(file_path)
.unwrap();
file.write_all(&buffer).unwrap();
}
/// Return a TriggerProxy struct that contains several helper functions for manipulating triggers.
/// This struct is version compatible.
/// You can expect a constant effect across different supported version.
/// # Examples
///
/// ```
/// use aoe2_probe::Scenario;
/// //Encode a scenario to a little endian vector of uint8
/// let mut source_scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario").unwrap();
/// let triggers_proxy = source_scenario.triggers_proxy();
/// ```
pub fn triggers_proxy(&mut self) -> TriggersProxy {
TriggersProxy::new(&self.version, &mut self.versio)
}
fn get_scenario_version(buffer: &[u8]) -> String {
std::str::from_utf8(&buffer[0..4]).unwrap().to_string()
}
}