use crate::error::{Error, Result};
pub fn decompress(data: &[u8]) -> Result<Vec<u8>> {
let Some(&first) = data.first() else {
return Err(Error::InvalidLzssMagic { magic: 0 });
};
if first != 0x10 && first != 0x11 {
return Err(Error::InvalidLzssMagic { magic: first });
}
std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
nintendo_lz::decompress_arr(data)
}))
.map_err(|_| Error::Decompression {
message: "nintendo_lz panicked on malformed data".to_owned(),
})?
.map_err(|source| Error::Decompression {
message: source.to_string(),
})
}
#[must_use]
pub const fn is_lzss(data: &[u8]) -> bool {
matches!(data.first(), Some(0x10) | Some(0x11))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn empty_input_is_invalid_magic() {
let err = decompress(&[]).unwrap_err();
assert!(matches!(err, Error::InvalidLzssMagic { magic: 0 }));
}
#[test]
fn bad_magic_returns_error() {
let err = decompress(&[0xFF, 0, 0, 0]).unwrap_err();
assert!(matches!(err, Error::InvalidLzssMagic { magic: 0xFF }));
}
#[test]
fn is_lzss_recognizes_magic_bytes() {
assert!(is_lzss(&[0x10]));
assert!(is_lzss(&[0x11]));
assert!(!is_lzss(&[0x12]));
assert!(!is_lzss(&[]));
}
#[test]
fn decompress_lz10_roundtrip() {
let mut data = vec![0x10, 0x01, 0x00, 0x00];
data.push(0x00);
data.push(0xAA);
let out = decompress(&data).unwrap();
assert_eq!(out, vec![0xAA]);
}
#[test]
fn malformed_lzss_does_not_panic() {
let data = vec![0x10, 0x20, 0x00, 0x00, 0xFF, 0x10, 0x00];
assert!(decompress(&data).is_err());
let data = vec![
0x10, 0x20, 0x00, 0x00, 0x00, 0xAA, 0x80, 0x20, 0x00, ];
assert!(decompress(&data).is_err());
let data = vec![0x11, 0x20, 0x00, 0x00, 0xFF, 0x10, 0x00];
assert!(decompress(&data).is_err());
}
}