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
// SPDX-FileCopyrightText: 2023 Joshua Goins <josh@redstrate.com>
// SPDX-License-Identifier: GPL-3.0-or-later
use crate::{ByteBuffer, ByteSpan};
use std::io::{BufRead, BufReader, BufWriter, Cursor, Write};
/// Excel list file, usually with the `.exl` file extension.
///
/// Contains a list of every Excel sheet available in-game.
pub struct EXL {
/// The version of the list.
pub version: i32,
/// The entries of the list.
pub entries: Vec<(String, i32)>,
}
impl EXL {
/// Initializes `EXL` from an existing list.
pub fn from_existing(buffer: ByteSpan) -> Option<EXL> {
let mut exl = Self {
version: 0,
entries: Vec::new(),
};
let cursor = Cursor::new(buffer);
let reader = BufReader::new(cursor);
for line in reader.lines().map_while(Result::ok) {
if let Some((name, value)) = line.split_once(',')
&& let Ok(parsed_value) = value.parse()
{
if name == "EXLT" {
exl.version = parsed_value;
} else if !name.starts_with('#') {
// Ignore rows with comments
exl.entries.push((name.to_string(), parsed_value));
}
}
}
Some(exl)
}
/// Writes data back to a buffer.
pub fn write_to_buffer(&self) -> Option<ByteBuffer> {
let mut buffer = ByteBuffer::new();
{
let cursor = Cursor::new(&mut buffer);
let mut writer = BufWriter::new(cursor);
writer
.write_all(format!("EXLT,{}", self.version).as_ref())
.ok()?;
for (key, value) in &self.entries {
writer.write_all(format!("\n{key},{value}").as_ref()).ok()?;
}
}
Some(buffer)
}
/// Checks whether or not the list contains `key`.
///
/// # Example
///
/// ```
/// # use std::fs::read;
/// # use std::path::PathBuf;
/// # use physis::exl::EXL;
/// # let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
/// # d.push("resources/tests");
/// # d.push("test.exl");
/// # let exl_file = read(d).unwrap();
/// let exl = EXL::from_existing(&exl_file).unwrap();
/// exl.contains("Foo");
/// ```
pub fn contains(&self, key: &str) -> bool {
self.entries.iter().any(|t| t.0 == key)
}
}
#[cfg(test)]
mod tests {
use std::fs::read;
use std::path::PathBuf;
use super::*;
fn common_setup() -> EXL {
let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
d.push("resources/tests");
d.push("test.exl");
EXL::from_existing(&read(d).unwrap()).unwrap()
}
#[test]
fn version_parsing() {
let exl = common_setup();
assert_eq!(exl.version, 2);
}
#[test]
fn contains() {
let exl = common_setup();
assert!(exl.contains("Foo"));
// should be case-sensitive
assert!(!exl.contains("foo"));
}
#[test]
fn test_write() {
let existing_exl = common_setup();
let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
d.push("resources/tests");
d.push("test.exl");
let exl = read(d).unwrap();
let mut out = std::io::stdout();
out.write_all(&existing_exl.write_to_buffer().unwrap())
.unwrap();
out.flush().unwrap();
assert_eq!(existing_exl.write_to_buffer().unwrap(), exl);
}
#[test]
fn test_invalid() {
let mut d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
d.push("resources/tests");
d.push("random");
// Feeding it invalid data should not panic
EXL::from_existing(&read(d).unwrap());
}
}