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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
//! Allows streaming of NBT data without prior knowledge of the structure.
use super::Tag;
use byteorder::{BigEndian, ReadBytesExt};
use std::{convert::TryFrom, io::Read, str};
/// An optional `String`.
pub type Name = Option<String>;
/// A shallow NBT value.
///
/// For every value except compounds and lists, this contains the value of the tag. For example, a `Value::Byte` will
/// contain the name and the byte of that NBT tag.
///
/// The name part of each variant is optional, since elements in an NBT list do not have names. The end of lists do not
/// have a name in the binary format, so it isn't included here either.
///
/// See `Parser` for more information.
#[derive(Debug, PartialEq)]
pub enum Value {
CompoundEnd,
Byte(Name, i8),
Short(Name, i16),
Int(Name, i32),
Long(Name, i64),
Float(Name, f32),
Double(Name, f64),
ByteArray(Name, Vec<i8>),
String(Name, String),
List(Name, Tag, i32),
ListEnd,
Compound(Name),
IntArray(Name, Vec<i32>),
LongArray(Name, Vec<i64>),
}
#[derive(Debug, Clone)]
pub struct Error {
msg: String,
kind: ErrorKind,
}
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum ErrorKind {
/// Any other errors. Users should not match on this variant and should
/// instead use a wildcard `_`. Errors in this category may be moved to new variants.
Other,
/// End of file. This occurs when EOF happens at the end of a tag and value,
/// so it may not be an error, it could be the natural end of the NBT. The
/// parser does not have enough context to tell the difference as it does
/// not track the overall structure of the NBT.
Eof,
/// EOF that occurred part way through some NBT value.
UnexpectedEof,
InvalidTag,
/// Expected unicode data but was not valid. Parser remains valid if just
/// this value was not unicode. Contained bytes are the invalid unicode data.
Nonunicode(Vec<u8>),
}
impl Error {
/// Get the kind of error.
pub fn kind(&self) -> &ErrorKind {
&self.kind
}
pub fn is_eof(&self) -> bool {
matches!(self.kind, ErrorKind::Eof)
}
fn bespoke(msg: impl Into<String>) -> Self {
Self {
msg: msg.into(),
kind: ErrorKind::Other,
}
}
fn invalid_tag(t: u8) -> Self {
Self {
msg: format!("invalid tag: {}", t),
kind: ErrorKind::InvalidTag,
}
}
fn nonunicode(d: Vec<u8>) -> Self {
Self {
msg: format!(
"invalid string, non-unicode: {}",
String::from_utf8_lossy(&d),
),
kind: ErrorKind::Nonunicode(d),
}
}
fn eof() -> Self {
Self {
msg: "EOF".into(),
kind: ErrorKind::Eof,
}
}
}
impl std::error::Error for Error {}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
write!(f, "{}", self.msg)
}
}
impl From<std::io::Error> for Error {
fn from(e: std::io::Error) -> Self {
match e.kind() {
std::io::ErrorKind::UnexpectedEof => Self {
msg: e.to_string(),
kind: ErrorKind::UnexpectedEof,
},
// Probably want to include the IO error in future.
_ => Self {
msg: e.to_string(),
kind: ErrorKind::Other,
},
}
}
}
/// Convenience type for Result.
pub type Result<T> = std::result::Result<T, Error>;
/// Parser can take any reader and parse it as NBT data. Does not do decompression.
///
/// # Examples
///
/// ## Dump NBT
/// The following takes a stream of GZip compressed data from stdin and dumps it out in Rust's `Debug` format, with
/// some indentation to help see the structure.
///
/// ```
/// use fastnbt::stream::{Parser, Value};
/// use flate2::read::GzDecoder;
///
/// let stdin = std::io::stdin();
/// let decoder = GzDecoder::new(stdin);
///
/// let mut parser = Parser::new(decoder);
/// let mut indent = 0;
///
/// loop {
/// match parser.next() {
/// Err(e) => {
/// println!("{:?}", e);
/// break;
/// }
/// Ok(value) => {
/// match value {
/// Value::CompoundEnd => indent -= 4,
/// Value::ListEnd => indent -= 4,
/// _ => {}
/// }
///
/// println!("{:indent$}{:?}", "", value, indent = indent);
///
/// match value {
/// Value::Compound(_) => indent += 4,
/// Value::List(_, _, _) => indent += 4,
/// _ => {}
/// }
/// }
/// }
/// }
/// ```
/// ## Finding a heightmap
/// Here we assume we've parsed up until we have entered the `Heightmaps` compound of the
/// [Minecraft Anvil chunk format](https://minecraft.wiki/w/Chunk_format). We keep parsing until we find the
/// `WORLD_SURFACE` long array. We avoid entering nested compounds by skipping them if we enter one. We know we have
/// finished with the current compound when we see the `CompoundEnd` value.
///
/// ```ignore
/// use fastnbt::stream::{Parser, Value, skip_compound};
/// use fastanvil::expand_heightmap;
///
/// # use fastnbt::Result;
/// # fn f() -> Result<Option<Vec<u16>>> {
/// let mut parser = /* ... */
/// # Parser::new(&[1u8,2,3][..]);
///
/// loop {
/// match parser.next()? {
/// Value::LongArray(Some(ref name), data) if name == "WORLD_SURFACE" => {
/// skip_compound(&mut parser)?;
/// return Ok(Some(expand_heightmap(data.as_slice())));
/// }
/// Value::Compound(_) => {
/// // don't enter another compound.
/// skip_compound(&mut parser)?;
/// }
/// Value::CompoundEnd => {
/// // No heightmap found, it happens.
/// return Ok(None);
/// }
/// // also need to not enter lists
/// _ => {}
/// }
/// }
/// # }
/// ```
pub struct Parser<R: Read> {
reader: R,
layers: Vec<Layer>,
}
impl<R: Read> Parser<R> {
/// Create new parser for the given reader.
pub fn new(reader: R) -> Self {
Self {
reader,
layers: Vec::new(),
}
}
/// Parse the next value from the input.
#[allow(clippy::should_implement_trait)]
pub fn next(&mut self) -> Result<Value> {
self.next_inner()
}
/// Gets a reference to the underlying value in this parser.
pub fn get_ref(&self) -> &R {
&self.reader
}
/// Gets a mutable reference to the underlying value in this parser.
pub fn get_mut(&mut self) -> &mut R {
&mut self.reader
}
/// Consumes this parser, returning the underlying value.
pub fn into_inner(self) -> R {
self.reader
}
/// Get the next value from the reader. Returns EOF if the stream ended sucessfully, and
/// IO(err) for any other IO error.
fn next_inner(&mut self) -> Result<Value> {
let last_layer = self.layers.last().map(|l| (*l).clone());
match last_layer {
Some(Layer::List(_, 0)) => {
self.layers.pop();
return Ok(Value::ListEnd);
}
Some(_) => {}
None => {}
}
if let Some(layer) = self.layers.last_mut() {
match layer {
Layer::List(_, remainder) => {
*remainder -= 1;
}
Layer::Compound => {}
};
}
let last_layer = self.layers.last().map(|l| (*l).clone());
if let Some(layer) = last_layer {
match layer {
Layer::List(tag, _) => return self.read_payload(tag, None),
Layer::Compound => {}
};
}
// If we get EOF reading a tag, it means we completed a tag to get here, so this is a
// natural end of stream.
let tag = match self.reader.read_u8() {
Ok(t) => t,
Err(e) if e.kind() == std::io::ErrorKind::UnexpectedEof => return Err(Error::eof()),
e => e?,
};
let tag = u8_to_tag(tag)?;
if tag == Tag::End {
// End tags have no name or value.
let last_layer = self.layers.last().map(|l| (*l).clone());
return match last_layer {
Some(Layer::Compound) => {
self.layers.pop();
Ok(Value::CompoundEnd)
}
Some(_) => Err(Error::bespoke("expected to be in compound")),
None => Err(Error::bespoke("expected to be in compound")),
};
}
let name = Some(self.read_size_prefixed_string()?);
self.read_payload(tag, name)
}
fn read_size_prefixed_string(&mut self) -> Result<String> {
let name_len = self.reader.read_u16::<BigEndian>()? as usize;
let mut buf = vec![0; name_len];
self.reader.read_exact(&mut buf[..])?;
Ok(cesu8::from_java_cesu8(&buf[..])
.map_err(|_| Error::nonunicode(Vec::from(&buf[..])))?
.into_owned())
}
fn read_payload(&mut self, tag: Tag, name: Name) -> Result<Value> {
match tag {
Tag::Byte => Ok(Value::Byte(name, self.reader.read_i8()?)),
Tag::Short => Ok(Value::Short(name, self.reader.read_i16::<BigEndian>()?)),
Tag::Int => Ok(Value::Int(name, self.reader.read_i32::<BigEndian>()?)),
Tag::Long => Ok(Value::Long(name, self.reader.read_i64::<BigEndian>()?)),
Tag::Float => Ok(Value::Float(name, self.reader.read_f32::<BigEndian>()?)),
Tag::Double => Ok(Value::Double(name, self.reader.read_f64::<BigEndian>()?)),
Tag::Compound => {
self.layers.push(Layer::Compound);
Ok(Value::Compound(name))
}
Tag::End => panic!("end tag should have returned early"),
Tag::List => {
let element_tag = self.reader.read_u8()?;
let element_tag = u8_to_tag(element_tag)?;
let size = self.reader.read_i32::<BigEndian>()?;
self.layers.push(Layer::List(element_tag, size));
Ok(Value::List(name, element_tag, size))
}
Tag::String => Ok(Value::String(name, self.read_size_prefixed_string()?)),
Tag::ByteArray => {
let size = self.reader.read_i32::<BigEndian>()?;
let mut buf = vec![0u8; size as usize];
self.reader.read_exact(&mut buf[..])?;
Ok(Value::ByteArray(name, vec_u8_into_i8(buf)))
}
Tag::IntArray => {
let size = self.reader.read_i32::<BigEndian>()?;
let mut buf = vec![0i32; size as usize];
for i in 0..size {
buf[i as usize] = self.reader.read_i32::<BigEndian>()?;
}
Ok(Value::IntArray(name, buf))
}
Tag::LongArray => {
let size = self.reader.read_i32::<BigEndian>()?;
let mut buf = vec![0i64; size as usize];
for i in 0..size {
buf[i as usize] = self.reader.read_i64::<BigEndian>()?;
}
Ok(Value::LongArray(name, buf))
}
}
}
}
/// Parse the input until the compound we are currently inside is complete.
/// Handles inner compounds by skipping those as well.
pub fn skip_compound<R: Read>(parser: &mut Parser<R>) -> Result<()> {
let mut depth = 1;
while depth != 0 {
let value = parser.next()?;
match value {
Value::CompoundEnd => depth -= 1,
Value::Compound(_) => depth += 1,
_ => {}
}
}
Ok(())
}
/// Parse until the compound with the given name is found. This will enter other
/// compounds and lists, rather than find a compound at the current level.
pub fn find_compound<R: Read>(parser: &mut Parser<R>, name: Option<&str>) -> Result<()> {
loop {
match parser.next()? {
//Value::Compound(n) if n == name.map(|s| s.to_owned()) => break,
Value::Compound(n) if n.as_deref() == name => break,
_ => {}
}
}
Ok(())
}
/// Parse until the list with the given name is found. This will enter other
/// compounds and lists, rather than find a list at the current level.
pub fn find_list<R: Read>(parser: &mut Parser<R>, name: Option<&str>) -> Result<usize> {
loop {
match parser.next()? {
Value::List(n, _, size) if n.as_deref() == name => return Ok(size as usize),
_ => {}
}
}
}
// Thanks to https://stackoverflow.com/a/59707887
fn vec_u8_into_i8(v: Vec<u8>) -> Vec<i8> {
// ideally we'd use Vec::into_raw_parts, but it's unstable,
// so we have to do it manually:
// first, make sure v's destructor doesn't free the data
// it thinks it owns when it goes out of scope
let mut v = std::mem::ManuallyDrop::new(v);
// then, pick apart the existing Vec
let p = v.as_mut_ptr();
let len = v.len();
let cap = v.capacity();
// finally, adopt the data into a new Vec
unsafe { Vec::from_raw_parts(p as *mut i8, len, cap) }
}
fn u8_to_tag(tag: u8) -> Result<Tag> {
Tag::try_from(tag).map_err(|_| Error::invalid_tag(tag))
}
#[derive(Clone)]
enum Layer {
List(Tag, i32),
Compound,
}