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 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
use super::Rgb;
use crate::{util::get_split, Scalar};
use std::fmt;
/// The ID of current Lexeme
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct LexemeId(pub u16);
impl LexemeId {
/// A binary '{' (open bracket)
pub const OPEN: LexemeId = LexemeId::new(0x0003);
/// A binary '}' (close bracket)
pub const CLOSE: LexemeId = LexemeId::new(0x0004);
/// A binary '='
pub const EQUAL: LexemeId = LexemeId::new(0x0001);
/// A binary 32 bit unsigned integer
pub const U32: LexemeId = LexemeId::new(0x0014);
/// A binary 64 bit unsigned integer
pub const U64: LexemeId = LexemeId::new(0x029c);
/// A binary 32 bit signed integer
pub const I32: LexemeId = LexemeId::new(0x000c);
/// A binary boolean
pub const BOOL: LexemeId = LexemeId::new(0x000e);
/// A binary string that is typically quoted
pub const QUOTED: LexemeId = LexemeId::new(0x000f);
/// A binary string that is typically without quotes
pub const UNQUOTED: LexemeId = LexemeId::new(0x0017);
/// A binary 32 bit floating point
pub const F32: LexemeId = LexemeId::new(0x000d);
/// A binary 64 bit floating point
pub const F64: LexemeId = LexemeId::new(0x0167);
/// A binary RGB value
pub const RGB: LexemeId = LexemeId::new(0x0243);
/// A binary 64 bit signed integer
pub const I64: LexemeId = LexemeId::new(0x0317);
/// Construct a new [LexemeId] from a 16bit value
#[inline]
pub const fn new(x: u16) -> Self {
LexemeId(x)
}
/// Identifies if the given ID does not match of the predefined [LexemeId]
/// constants, and thus can be considered an ID token.
///
/// ```rust
/// use jomini::binary::LexemeId;
/// let lid = LexemeId::new(0x1000);
/// assert!(lid.is_id());
/// ```
#[inline]
pub const fn is_id(&self) -> bool {
!matches!(
*self,
LexemeId::OPEN
| LexemeId::CLOSE
| LexemeId::EQUAL
| LexemeId::U32
| LexemeId::U64
| LexemeId::I32
| LexemeId::BOOL
| LexemeId::QUOTED
| LexemeId::UNQUOTED
| LexemeId::F32
| LexemeId::F64
| LexemeId::RGB
| LexemeId::I64
)
}
}
#[inline]
pub(crate) fn read_id(data: &[u8]) -> Result<(LexemeId, &[u8]), LexError> {
let (head, rest) = get_split::<2>(data).ok_or(LexError::Eof)?;
Ok((LexemeId::new(u16::from_le_bytes(head)), rest))
}
#[inline]
pub(crate) fn read_string(data: &[u8]) -> Result<(Scalar, &[u8]), LexError> {
let (head, rest) = get_split::<2>(data).ok_or(LexError::Eof)?;
let text_len = usize::from(u16::from_le_bytes(head));
if text_len <= rest.len() {
let (text, rest) = rest.split_at(text_len);
Ok((Scalar::new(text), rest))
} else {
Err(LexError::Eof)
}
}
#[inline]
pub(crate) fn read_bool(data: &[u8]) -> Result<(bool, &[u8]), LexError> {
let (&first, rest) = data.split_first().ok_or(LexError::Eof)?;
Ok((first != 0, rest))
}
#[inline]
pub(crate) fn read_u32(data: &[u8]) -> Result<(u32, &[u8]), LexError> {
let (head, rest) = get_split::<4>(data).ok_or(LexError::Eof)?;
Ok((u32::from_le_bytes(head), rest))
}
#[inline]
pub(crate) fn read_u64(data: &[u8]) -> Result<(u64, &[u8]), LexError> {
let (head, rest) = get_split::<8>(data).ok_or(LexError::Eof)?;
Ok((u64::from_le_bytes(head), rest))
}
#[inline]
pub(crate) fn read_i64(data: &[u8]) -> Result<(i64, &[u8]), LexError> {
let (head, rest) = get_split::<8>(data).ok_or(LexError::Eof)?;
Ok((i64::from_le_bytes(head), rest))
}
#[inline]
pub(crate) fn read_i32(data: &[u8]) -> Result<(i32, &[u8]), LexError> {
let (head, rest) = get_split::<4>(data).ok_or(LexError::Eof)?;
Ok((i32::from_le_bytes(head), rest))
}
#[inline]
pub(crate) fn read_f32(data: &[u8]) -> Result<([u8; 4], &[u8]), LexError> {
get_split::<4>(data).ok_or(LexError::Eof)
}
#[inline]
pub(crate) fn read_f64(data: &[u8]) -> Result<([u8; 8], &[u8]), LexError> {
get_split::<8>(data).ok_or(LexError::Eof)
}
#[inline]
pub(crate) fn read_rgb(data: &[u8]) -> Result<(Rgb, &[u8]), LexError> {
let (start, data) = read_id(data)?;
let (rtoken, data) = read_id(data)?;
let (r, data) = read_u32(data)?;
let (gtoken, data) = read_id(data)?;
let (g, data) = read_u32(data)?;
let (btoken, data) = read_id(data)?;
let (b, data) = read_u32(data)?;
let (next_tok, data) = read_id(data)?;
match (start, rtoken, gtoken, btoken, next_tok) {
(LexemeId::OPEN, LexemeId::U32, LexemeId::U32, LexemeId::U32, LexemeId::CLOSE) => {
Ok((Rgb { r, g, b, a: None }, data))
}
(LexemeId::OPEN, LexemeId::U32, LexemeId::U32, LexemeId::U32, LexemeId::U32) => {
let (a, data) = read_u32(data)?;
let (end, data) = read_id(data)?;
if end == LexemeId::CLOSE {
let a = Some(a);
Ok((Rgb { r, g, b, a }, data))
} else {
Err(LexError::InvalidRgb)
}
}
_ => Err(LexError::InvalidRgb),
}
}
/// Binary token, the raw form of [BinaryToken](crate::binary::BinaryToken)
///
/// This binary token contains the yielded raw tokens, and won't match open and
/// close tokens together, nor does it make a determination if open and close
/// represents an array, object, or both.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub enum Token<'a> {
/// '{'
Open,
/// '}'
Close,
/// '='
Equal,
/// 32bit unsigned integer
U32(u32),
/// 64bit unsigned integer
U64(u64),
/// 32bit signed integer
I32(i32),
/// boolean
Bool(bool),
/// quoted text
Quoted(Scalar<'a>),
/// text that is not quoted
Unquoted(Scalar<'a>),
/// 32bits of floating point data
F32([u8; 4]),
/// 64bits of floating point data
F64([u8; 8]),
/// Rgb data
Rgb(Rgb),
/// 64bit signed integer
I64(i64),
/// token id that can be resolved to a string via a
/// [TokenResolver](crate::binary::TokenResolver)
Id(u16),
}
impl<'a> Token<'a> {
fn write_u32(mut wtr: impl std::io::Write, num: u32) -> Result<(), std::io::Error> {
wtr.write_all(&LexemeId::U32.0.to_le_bytes())?;
wtr.write_all(&num.to_le_bytes())
}
/// Write the binary representation of a token to a writer
///
/// ```rust
/// use jomini::binary::Token;
/// let out = Vec::new();
/// let mut cursor = std::io::Cursor::new(out);
/// for token in &[Token::Id(0x00e1), Token::Equal, Token::U32(10)] {
/// token.write(&mut cursor)?;
/// }
///
/// assert_eq!(&cursor.into_inner(), &[0xe1, 0x00, 0x01, 0x00, 0x14, 0x00, 0x0a, 0x00, 0x00, 0x00]);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn write(&self, mut wtr: impl std::io::Write) -> Result<(), std::io::Error> {
match self {
Token::Open => wtr.write_all(&LexemeId::OPEN.0.to_le_bytes()),
Token::Close => wtr.write_all(&LexemeId::CLOSE.0.to_le_bytes()),
Token::Equal => wtr.write_all(&LexemeId::EQUAL.0.to_le_bytes()),
Token::U32(x) => Token::write_u32(wtr, *x),
Token::U64(x) => {
wtr.write_all(&LexemeId::U64.0.to_le_bytes())?;
wtr.write_all(&x.to_le_bytes())
}
Token::I32(x) => {
wtr.write_all(&LexemeId::I32.0.to_le_bytes())?;
wtr.write_all(&x.to_le_bytes())
}
Token::Bool(x) => {
wtr.write_all(&LexemeId::BOOL.0.to_le_bytes())?;
wtr.write_all(&[if *x { 1u8 } else { 0 }])
}
Token::Quoted(x) => {
wtr.write_all(&LexemeId::QUOTED.0.to_le_bytes())?;
wtr.write_all(&(x.as_bytes().len() as u16).to_le_bytes())?;
wtr.write_all(x.as_bytes())
}
Token::Unquoted(x) => {
wtr.write_all(&LexemeId::UNQUOTED.0.to_le_bytes())?;
wtr.write_all(&(x.as_bytes().len() as u16).to_le_bytes())?;
wtr.write_all(x.as_bytes())
}
Token::F32(x) => {
wtr.write_all(&LexemeId::F32.0.to_le_bytes())?;
wtr.write_all(x)
}
Token::F64(x) => {
wtr.write_all(&LexemeId::F64.0.to_le_bytes())?;
wtr.write_all(x)
}
Token::Rgb(x) => {
wtr.write_all(&LexemeId::RGB.0.to_le_bytes())?;
wtr.write_all(&LexemeId::OPEN.0.to_le_bytes())?;
Token::write_u32(&mut wtr, x.r)?;
Token::write_u32(&mut wtr, x.g)?;
Token::write_u32(&mut wtr, x.b)?;
if let Some(a) = x.a.as_ref() {
Token::write_u32(&mut wtr, *a)?;
}
wtr.write_all(&LexemeId::CLOSE.0.to_le_bytes())
}
Token::I64(x) => {
wtr.write_all(&LexemeId::I64.0.to_le_bytes())?;
wtr.write_all(&x.to_le_bytes())
}
Token::Id(x) => wtr.write_all(&x.to_le_bytes()),
}
}
}
#[inline]
pub(crate) fn read_token(data: &[u8]) -> Result<(Token, &[u8]), LexError> {
let (id, data) = read_id(data)?;
match id {
LexemeId::OPEN => Ok((Token::Open, data)),
LexemeId::CLOSE => Ok((Token::Close, data)),
LexemeId::EQUAL => Ok((Token::Equal, data)),
LexemeId::U32 => read_u32(data).map(|(x, d)| (Token::U32(x), d)),
LexemeId::U64 => read_u64(data).map(|(x, d)| (Token::U64(x), d)),
LexemeId::I32 => read_i32(data).map(|(x, d)| (Token::I32(x), d)),
LexemeId::BOOL => read_bool(data).map(|(x, d)| (Token::Bool(x), d)),
LexemeId::QUOTED => read_string(data).map(|(x, d)| (Token::Quoted(x), d)),
LexemeId::UNQUOTED => read_string(data).map(|(x, d)| (Token::Unquoted(x), d)),
LexemeId::F32 => read_f32(data).map(|(x, d)| (Token::F32(x), d)),
LexemeId::F64 => read_f64(data).map(|(x, d)| (Token::F64(x), d)),
LexemeId::RGB => read_rgb(data).map(|(x, d)| (Token::Rgb(x), d)),
LexemeId::I64 => read_i64(data).map(|(x, d)| (Token::I64(x), d)),
LexemeId(id) => Ok((Token::Id(id), data)),
}
}
/// Lexical error type without positional information
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LexError {
/// Data ended too soon
Eof,
/// An invalid RGB block encountered
InvalidRgb,
}
impl std::error::Error for LexError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
None
}
}
impl std::fmt::Display for LexError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match *self {
LexError::Eof => write!(f, "unexpected end of file"),
LexError::InvalidRgb => write!(f, "invalid rgb data encountered",),
}
}
}
impl LexError {
#[inline]
#[must_use]
pub(crate) fn at(self, position: usize) -> LexerError {
LexerError {
position,
kind: self,
}
}
}
/// Lexical error type with positional information
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct LexerError {
position: usize,
kind: LexError,
}
impl LexerError {
/// Return the byte position where the error occurred
pub fn position(&self) -> usize {
self.position
}
/// Return a reference the error kind
pub fn kind(&self) -> &LexError {
&self.kind
}
/// Consume self and return the error kind
#[must_use]
pub fn into_kind(self) -> LexError {
self.kind
}
}
impl std::error::Error for LexerError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
None
}
}
impl std::fmt::Display for LexerError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self.kind {
LexError::Eof => write!(f, "not enough data to read at {}", self.position),
LexError::InvalidRgb => write!(f, "invalid rgb data encountered at {}", self.position),
}
}
}
/// Zero cost binary data scanner.
///
/// There are two main ways to drive the lexer. To see them in action, imagine
/// we want to count the max amount of nesting.
///
/// ```rust
/// use jomini::binary::{Lexer, Token};
/// let mut lexer = Lexer::new(&[0x2d, 0x28, 0x01, 0x00, 0x03, 0x00, 0x03, 0x00, 0x04, 0x00, 0x04, 0x00]);
/// let mut max_depth = 0;
/// let mut current_depth = 0;
/// while let Some(token) = lexer.next_token()? {
/// match token {
/// Token::Open => {
/// current_depth += 1;
/// max_depth = max_depth.max(current_depth);
/// }
/// Token::Close => current_depth -= 1,
/// _ => {}
/// }
/// }
/// assert_eq!(max_depth, 2);
/// # Ok::<(), jomini::binary::LexerError>(())
/// ```
///
/// The [Lexer::next_token] is an ergonomic way to scan through binary tokens.
/// The functions prefixed with `read_`denote more data is expected, while
/// `next_` allows for the data to finish.
///
/// If it is desired scan through the binary data with zero overhead, one needs
/// to drive the lexer more thoroughly.
///
/// ```rust
/// use jomini::binary::{Lexer, LexemeId};
/// let mut lexer = Lexer::new(&[0x2d, 0x28, 0x01, 0x00, 0x03, 0x00, 0x03, 0x00, 0x04, 0x00, 0x04, 0x00]);
/// let mut max_depth = 0;
/// let mut current_depth = 0;
/// while let Some(id) = lexer.next_id()? {
/// match id {
/// LexemeId::OPEN => {
/// current_depth += 1;
/// max_depth = max_depth.max(current_depth);
/// }
/// LexemeId::CLOSE => current_depth -= 1,
/// LexemeId::U32 => { lexer.read_u32()?; }
/// LexemeId::I32 => { lexer.read_i32()?; }
/// LexemeId::BOOL => { lexer.read_bool()?; }
/// LexemeId::QUOTED | LexemeId::UNQUOTED => { lexer.read_string()?; }
/// LexemeId::F32 => { lexer.read_f32()?; }
/// LexemeId::F64 => { lexer.read_f64()?; }
/// LexemeId::I64 => { lexer.read_i64()?; }
/// _ => {}
/// }
/// }
/// assert_eq!(max_depth, 2);
/// # Ok::<(), jomini::binary::LexerError>(())
/// ```
///
/// Only at token boundaries can `token` functions be intertwined with the
/// individual lexeme functions.
///
/// Errors reported will contain positional information.
pub struct Lexer<'a> {
data: &'a [u8],
original_length: usize,
}
impl<'a> Lexer<'a> {
/// Creates a new lexer over the given data
#[inline]
pub fn new(data: &'a [u8]) -> Self {
Self {
data,
original_length: data.len(),
}
}
/// Returns the remaining data that has not yet been processed.
///
/// ```rust
/// use jomini::binary::{Lexer, LexemeId};
/// let mut lexer = Lexer::new(&[0xd2, 0x28, 0xff]);
/// assert_eq!(lexer.read_id().unwrap(), LexemeId::new(0x28d2));
/// assert_eq!(lexer.remainder(), &[0xff]);
/// ```
#[inline]
pub fn remainder(&self) -> &'a [u8] {
self.data
}
/// Returns how many bytes have been processed by the lexer
///
/// ```rust
/// use jomini::binary::{Lexer, LexemeId};
/// let mut lexer = Lexer::new(&[0xd2, 0x28, 0xff]);
/// assert_eq!(lexer.read_id().unwrap(), LexemeId::new(0x28d2));
/// assert_eq!(lexer.position(), 2);
/// ```
#[inline]
pub fn position(&self) -> usize {
self.original_length - self.data.len()
}
#[inline]
fn err_position(&self, err: LexError) -> LexerError {
err.at(self.position())
}
/// Advance the lexer through the next lexeme id, and return it
///
/// ```rust
/// use jomini::binary::{Lexer, LexemeId, LexError};
/// let mut lexer = Lexer::new(&[0x2d, 0x28]);
/// assert_eq!(lexer.read_id(), Ok(LexemeId::new(0x282d)));
/// assert_eq!(lexer.read_id().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_id(&mut self) -> Result<LexemeId, LexerError> {
let (result, rest) = read_id(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Attempt to advance through the [LexemeId]
///
/// An EOF error can still be thrown if data is present but not enough
/// exists to decode the next [LexemeId]
///
/// ```rust
/// use jomini::binary::{Lexer, LexemeId, LexError};
/// let mut lexer = Lexer::new(&[0x2d, 0x28]);
/// assert_eq!(lexer.next_id(), Ok(Some(LexemeId::new(0x282d))));
/// assert_eq!(lexer.next_id(), Ok(None));
///
/// let mut lexer = Lexer::new(&[0x2d]);
/// assert_eq!(lexer.next_id().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn next_id(&mut self) -> Result<Option<LexemeId>, LexerError> {
match read_id(self.data) {
Ok((result, rest)) => {
self.data = rest;
Ok(Some(result))
}
Err(LexError::Eof) if self.remainder().is_empty() => Ok(None),
Err(e) => Err(self.err_position(e)),
}
}
/// Assume more tokens exist in the data and read the next one.
///
/// ```rust
/// use jomini::binary::{Lexer, LexError, Token};
/// let mut lexer = Lexer::new(&[0x2d, 0x28]);
/// assert_eq!(lexer.read_token(), Ok(Token::Id(0x282d)));
/// assert_eq!(lexer.read_token().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_token(&mut self) -> Result<Token<'a>, LexerError> {
let (result, rest) = read_token(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Attempt to advance through the next token or return `None` if no data remains
///
/// An EOF error can still be thrown if data is present but not enough
/// exists to decode the next token.
///
/// ```rust
/// use jomini::binary::{Lexer, Token, LexError};
/// let mut lexer = Lexer::new(&[0x2d, 0x28]);
/// assert_eq!(lexer.next_token(), Ok(Some(Token::Id(0x282d))));
/// assert_eq!(lexer.next_token(), Ok(None));
///
/// let mut lexer = Lexer::new(&[0x2d]);
/// assert_eq!(lexer.next_token().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn next_token(&mut self) -> Result<Option<Token<'a>>, LexerError> {
match read_token(self.data) {
Ok((result, rest)) => {
self.data = rest;
Ok(Some(result))
}
Err(LexError::Eof) if self.remainder().is_empty() => Ok(None),
Err(e) => Err(self.err_position(e)),
}
}
/// Peek at the next [LexemeId] without advancing the lexer
///
/// ```rust
/// use jomini::binary::{Lexer, LexError, LexemeId};
/// let mut lexer = Lexer::new(&[0x01, 0x00][..]);
/// assert_eq!(lexer.peek_id(), Some(LexemeId::EQUAL));
/// assert_eq!(lexer.read_id(), Ok(LexemeId::EQUAL));
/// assert_eq!(lexer.peek_id(), None);
/// ```
#[inline]
pub fn peek_id(&mut self) -> Option<LexemeId> {
self.data
.get(..2)
.map(|head| LexemeId::new(u16::from_le_bytes([head[0], head[1]])))
}
/// Peek at the next [Token] without advancing the lexer
///
/// ```rust
/// use jomini::binary::{Lexer, LexError, Token};
/// let mut lexer = Lexer::new(&[0x01, 0x00][..]);
/// assert_eq!(lexer.peek_token(), Some(Token::Equal));
/// assert_eq!(lexer.read_token(), Ok(Token::Equal));
/// assert_eq!(lexer.peek_token(), None);
/// ```
#[inline]
pub fn peek_token(&mut self) -> Option<Token<'a>> {
read_token(self.data).ok().map(|(t, _)| t)
}
/// Advance the lexer through a length prefixed string
///
/// ```rust
/// use jomini::{Scalar, binary::{Lexer, LexError}};
/// let mut lexer = Lexer::new(&[0x03, 0x00, 0x45, 0x4e, 0x47][..]);
/// assert_eq!(lexer.read_string(), Ok(Scalar::new(b"ENG")));
/// assert_eq!(lexer.read_string().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_string(&mut self) -> Result<Scalar<'a>, LexerError> {
let (result, rest) = read_string(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through a boolean
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let mut lexer = Lexer::new(&[0x01, 0x00][..]);
/// assert_eq!(lexer.read_bool(), Ok(true));
/// assert_eq!(lexer.read_bool(), Ok(false));
/// assert_eq!(lexer.read_bool().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_bool(&mut self) -> Result<bool, LexerError> {
let (result, rest) = read_bool(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through unsigned little endian 32 bit integer
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let mut lexer = Lexer::new(&[0x59, 0x00, 0x00, 0x00][..]);
/// assert_eq!(lexer.read_u32(), Ok(89));
/// assert_eq!(lexer.read_u32().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_u32(&mut self) -> Result<u32, LexerError> {
let (result, rest) = read_u32(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through unsigned little endian 64 bit integer
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let mut lexer = Lexer::new(&[0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]);
/// assert_eq!(lexer.read_u64(), Ok(128));
/// assert_eq!(lexer.read_u64().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_u64(&mut self) -> Result<u64, LexerError> {
let (result, rest) = read_u64(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through signed little endian 64 bit integer
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let mut lexer = Lexer::new(&[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff][..]);
/// assert_eq!(lexer.read_i64(), Ok(-1));
/// assert_eq!(lexer.read_i64().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_i64(&mut self) -> Result<i64, LexerError> {
let (result, rest) = read_i64(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through signed little endian 32 bit integer
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let mut lexer = Lexer::new(&[0x59, 0x00, 0x00, 0x00][..]);
/// assert_eq!(lexer.read_i32(), Ok(89));
/// assert_eq!(lexer.read_i32().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_i32(&mut self) -> Result<i32, LexerError> {
let (result, rest) = read_i32(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through 32 bits of floating point data and return the bytes
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let data = [0x17, 0x00, 0x00, 0x00];
/// let mut lexer = Lexer::new(&data[..]);
/// assert_eq!(lexer.read_f32(), Ok(data));
/// assert_eq!(lexer.read_f32().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_f32(&mut self) -> Result<[u8; 4], LexerError> {
let (result, rest) = read_f32(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through 64 bits of floating point data and return the bytes
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let data = [0xc7, 0xe4, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00];
/// let mut lexer = Lexer::new(&data[..]);
/// assert_eq!(lexer.read_f64(), Ok(data));
/// assert_eq!(lexer.read_f64().unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_f64(&mut self) -> Result<[u8; 8], LexerError> {
let (result, rest) = read_f64(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance the lexer through an rgb value (with optional alpha channel)
///
/// ```rust
/// use jomini::binary::{Lexer, LexError, Rgb};
/// let data = [0x03, 0x00, 0x14, 0x00, 0x6e, 0x00, 0x00, 0x00,
/// 0x14, 0x00, 0x1b, 0x00, 0x00, 0x00, 0x14, 0x00,
/// 0x1b, 0x00, 0x00, 0x00, 0x04, 0x00];
/// let mut lexer = Lexer::new(&data[..]);
/// assert_eq!(lexer.read_rgb(), Ok(Rgb { r: 110, g: 27, b: 27, a: None }));
/// assert_eq!(lexer.read_rgb().unwrap_err().kind(), &LexError::Eof);
/// ```
pub fn read_rgb(&mut self) -> Result<Rgb, LexerError> {
let (result, rest) = read_rgb(self.data).map_err(|e| self.err_position(e))?;
self.data = rest;
Ok(result)
}
/// Advance a given number of bytes and return them
///
/// ```rust
/// use jomini::binary::{Lexer, LexError};
/// let mut lexer = Lexer::new(b"EU4bin");
/// assert_eq!(lexer.read_bytes(6), Ok(&b"EU4bin"[..]));
/// assert_eq!(lexer.read_bytes(1).unwrap_err().kind(), &LexError::Eof);
/// ```
#[inline]
pub fn read_bytes(&mut self, bytes: usize) -> Result<&'a [u8], LexerError> {
if self.data.len() >= bytes {
let (head, rest) = self.data.split_at(bytes);
self.data = rest;
Ok(head)
} else {
Err(self.err_position(LexError::Eof))
}
}
/// Skip the value denoted by the [LexemeId]. Will skip entire containers.
#[inline]
pub fn skip_value(&mut self, id: LexemeId) -> Result<(), LexerError> {
match id {
LexemeId::QUOTED | LexemeId::UNQUOTED => {
self.read_string()?;
Ok(())
}
LexemeId::U32 => {
self.read_u32()?;
Ok(())
}
LexemeId::I32 => {
self.read_i32()?;
Ok(())
}
LexemeId::U64 => {
self.read_u64()?;
Ok(())
}
LexemeId::I64 => {
self.read_i64()?;
Ok(())
}
LexemeId::BOOL => {
self.read_bool()?;
Ok(())
}
LexemeId::F32 => {
self.read_f32()?;
Ok(())
}
LexemeId::F64 => {
self.read_f64()?;
Ok(())
}
LexemeId::OPEN => self.skip_container(),
LexemeId::RGB => {
self.read_rgb()?;
Ok(())
}
_ => Ok(()),
}
}
#[inline]
fn skip_container(&mut self) -> Result<(), LexerError> {
let mut depth = 1;
loop {
match self.read_id()? {
LexemeId::QUOTED | LexemeId::UNQUOTED => {
self.read_string()?;
}
LexemeId::U32 => {
self.read_u32()?;
}
LexemeId::I32 => {
self.read_i32()?;
}
LexemeId::U64 => {
self.read_u64()?;
}
LexemeId::I64 => {
self.read_i64()?;
}
LexemeId::BOOL => {
self.read_bool()?;
}
LexemeId::F32 => {
self.read_f32()?;
}
LexemeId::F64 => {
self.read_f64()?;
}
LexemeId::CLOSE => {
depth -= 1;
if depth == 0 {
return Ok(());
}
}
LexemeId::OPEN => depth += 1,
_ => {}
}
}
}
}