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
use std::path::PathBuf;
use super::TexlangState;
use crate::token::trace;
use crate::token::Token;
use crate::*;
/// A stream of tokens generated on demand.
///
/// This trait describes a general stream of tokens where the front of the stream may
/// retrieved using [TokenStream::next] or peeked at using [TokenStream::peek].
/// In practice, all [TokenStreams](TokenStream) in Texlang
/// are either [ExecutionInput], [ExpansionInput] or [UnexpandedStream].
/// This trait exists to allow a generic function to accept any of these types.
///
/// # Note on lazy loading
///
/// The simplest example of a stream is a vector of tokens. However, streams are more general
/// than this and can encompass situations in which the full contents cannot be determined in
/// advance. This can be thought of as "lazy loading" for the tokens.
/// The classic example of this kind of stream comes from the following LaTeX
/// snippet:
/// ```tex
/// \makeatletter \do@
/// ```
/// Assuming the default TeX catcode map, if we were to parse this input all at once we would
/// get three tokens: the control sequence `makeatletter`, the control sequence `do`, and a
/// single character token with value `@` and catcode "other". This is not the correct result,
/// though: the first control sequence changes the tokenization rules such that `@` is now
/// an admissible character in the name of a control sequence. The correct input is thus
/// the control sequence `makeatletter` followed by the control sequence `do@`.
pub trait TokenStream {
/// The type of the custom state in the VM.
type S;
/// Gets the next token in the stream.
///
/// This method is almost the same
/// as the `next` method in Rust's iterator trait, except a stream can return an error.
///
/// As with iterators, a result of `Ok(None)` indicates that the stream is exhausted.
fn next(&mut self) -> Result<Option<Token>, Box<error::Error>>;
/// Peeks at the next token in the stream without removing it.
///
/// In many situations it is necessary to examine the next token without consuming it.
/// For example when reading an integer from a stream, one needs to peek at the next token
/// to see if it is a digit and thus extends the currently parsed integer.
/// Consuming the token with [TokenStream::next] is not
/// correct in this situation if the token is not a digit.
///
/// For consumers, it is important to note that the peek method requires a mutable reference
/// to the stream. This is because some mutable processing may be needed in order to determine
/// what the next token is. For example:
///
/// 1. When reading tokens from a file, peeking at the next token may involve reading more bytes
/// from the file and thus mutating the file pointer. sThis mutations is easy to undo in
/// general.
///
/// 1. When performing expansion on a stream, the next token in the stream may need to be expanded
/// rather than returned. The next token will be the first token in the expansion in this case,
/// or the following token in the remaining stream if the expansion returns no tokens.
/// This mutation is generally irreversible.
fn peek(&mut self) -> Result<Option<&Token>, Box<error::Error>>;
/// Consumes the next token in the stream without returning it.
///
/// This method is mostly to make code self-documenting. It is typically used in
/// situations where a peek has already occurred, and the token itself is not needed.
fn consume(&mut self) -> Result<(), Box<error::Error>> {
self.next().map(|_| ())
}
/// Returns a reference to the VM.
fn vm(&self) -> &vm::VM<Self::S>;
/// Returns a reference to the commands map.
#[inline]
fn commands_map(&self) -> &command::Map<Self::S> {
&self.vm().commands_map
}
/// Returns a reference to the custom state.
#[inline]
fn state(&self) -> &Self::S {
&self.vm().state
}
fn trace(&self, token: Token) -> trace::SourceCodeTrace {
self.vm().trace(token)
}
fn trace_end_of_input(&self) -> trace::SourceCodeTrace {
self.vm().internal.tracer.trace_end_of_input()
}
}
/// A [TokenStream] that performs expansion.
///
/// The unexpanded tokens are retrieved from the unexpanded stream returned by the
/// [unexpanded](ExpandedStream::unexpanded) method.
#[repr(transparent)]
pub struct ExpandedStream<S>(UnexpandedStream<S>);
impl<S> std::convert::AsMut<ExpandedStream<S>> for ExpandedStream<S> {
fn as_mut(&mut self) -> &mut ExpandedStream<S> {
self
}
}
impl<S: TexlangState> ExpandedStream<S> {
/// Returns the underlying unexpanded stream.
pub fn unexpanded(&mut self) -> &mut UnexpandedStream<S> {
&mut self.0
}
/// Expand the next token in the input.
///
/// This method only expands a single token. If, after the expansion, the next token
/// is expandable it will not be expanded.
pub fn expand_once(&mut self) -> Result<bool, Box<error::Error>> {
stream::expand_once(&mut self.unexpanded().0)
}
pub fn checkout_token_buffer(&mut self) -> Vec<Token> {
self.0 .0.internal.token_buffers.pop().unwrap_or_default().0
}
/// Return a token buffer, allowing it to be reused.
pub fn return_token_buffer(&mut self, mut token_buffer: Vec<Token>) {
token_buffer.clear();
self.0
.0
.internal
.token_buffers
.push(super::TokenBuffer(token_buffer))
}
}
impl<S: TexlangState> TokenStream for ExpandedStream<S> {
type S = S;
#[inline]
fn next(&mut self) -> Result<Option<Token>, Box<error::Error>> {
stream::next_expanded(&mut self.unexpanded().0)
}
#[inline]
fn peek(&mut self) -> Result<Option<&Token>, Box<error::Error>> {
stream::peek_expanded(&mut self.unexpanded().0)
}
#[inline]
fn vm(&self) -> &vm::VM<Self::S> {
&self.0 .0
}
}
/// Stream that returns input tokens without performing expansion.
///
/// The unexpanded stream is used when reading tokens without performing expansion;
/// e.g., when reading the replacement text for a macro defined using `\def`.
///
/// It be obtained from either the [ExecutionInput] or the [ExpansionInput]
/// using the [ExpandedStream] trait methods.
#[repr(transparent)]
pub struct UnexpandedStream<S>(vm::VM<S>);
impl<S: TexlangState> TokenStream for UnexpandedStream<S> {
type S = S;
#[inline]
fn next(&mut self) -> Result<Option<Token>, Box<error::Error>> {
stream::next_unexpanded(&mut self.0)
}
#[inline]
fn peek(&mut self) -> Result<Option<&Token>, Box<error::Error>> {
stream::peek_unexpanded(&mut self.0)
}
#[inline]
fn vm(&self) -> &vm::VM<S> {
&self.0
}
}
/// Input type for expansion primitives.
///
/// This type provides:
///
/// - Access to the input stream (with or without expansion). Its implementation of the [TokenStream]
/// trait returns expanded tokens.
/// To read the input stream without performing expansion, use the
/// [unexpanded](ExpandedStream::unexpanded) method.
///
/// - Read only access to the VM.
///
/// - The ability to push source code or token expansions to the front of the input stream.
/// For source code use [ExpansionInput::push_source];
/// for tokens use [ExpansionInput::push_expansion] or [ExpansionInput::expansions_mut].
///
/// - Access to token buffers using the [ExpansionInput::checkout_token_buffer] and
/// [ExpansionInput::return_token_buffer] methods.
///
/// This type is also used in the parsing code for situations where both an
/// [ExpansionInput] or [ExecutionInput] is accepted. We use this type because
/// it has only read access to the VM, and so casting does not escalate privileges.
#[repr(transparent)]
// TODO: should this be in the command module, not in the vm module?
pub struct ExpansionInput<S>(ExpandedStream<S>);
impl<S> std::convert::AsMut<ExpandedStream<S>> for ExpansionInput<S> {
fn as_mut(&mut self) -> &mut ExpandedStream<S> {
&mut self.0
}
}
impl<S: TexlangState> TokenStream for ExpansionInput<S> {
type S = S;
fn next(&mut self) -> Result<Option<Token>, Box<error::Error>> {
self.0.next()
}
fn peek(&mut self) -> Result<Option<&Token>, Box<error::Error>> {
self.0.peek()
}
fn vm(&self) -> &vm::VM<Self::S> {
self.0.vm()
}
}
impl<S> ExpansionInput<S> {
/// Creates a mutable reference to this type from the [VM](vm::VM) type.
#[inline]
pub fn new(vm: &mut vm::VM<S>) -> &mut ExpansionInput<S> {
unsafe { &mut *(vm as *mut vm::VM<S> as *mut ExpansionInput<S>) }
}
}
impl<S: TexlangState> ExpansionInput<S> {
/// Push source code to the front of the input stream.
#[inline]
pub fn push_source(
&mut self,
token: Token,
file_name: PathBuf,
source_code: String,
) -> Result<(), Box<error::Error>> {
self.0
.0
.0
.internal
.push_source(Some(token), file_name, source_code)
}
/// End the current file.
///
/// This method is used by `\endinput` primitive.
pub fn end_current_file(&mut self) {
self.0 .0 .0.internal.end_current_file()
}
pub fn push_string_tokens(&mut self, token: Token, s: &str) {
let trace_key = token.trace_key();
for c in s.chars().rev() {
let token = match c {
' ' => token::Token::new_space(' ', trace_key),
_ => token::Token::new_letter(c, trace_key),
};
self.expansions_mut().push(token);
}
}
}
impl<S> ExpansionInput<S> {
#[inline]
pub fn unexpanded(&mut self) -> &mut UnexpandedStream<S> {
&mut self.0 .0
}
#[inline]
pub fn expanded(&mut self) -> &mut ExpandedStream<S> {
&mut self.0
}
/// Push tokens to the front of the input stream.
///
/// The first token in the provided slice will be the next token read.
// TODO: destroy
#[inline]
pub fn push_expansion(&mut self, expansion: &[Token]) {
self.0 .0 .0.internal.push_expansion(expansion)
}
/// Returns a reference to the expanded tokens stack for the current input source.
///
/// The tokens are a stack, so the next token is the last token in the vector.
///
/// Adding tokens to the front of the input using this method can be more efficient
/// than using [ExpansionInput::push_expansion] because an allocation is avoided.
#[inline]
pub fn expansions(&self) -> &Vec<Token> {
self.0 .0 .0.internal.expansions()
}
/// Returns a mutable reference to the expanded tokens stack for the current input source.
///
/// The tokens are a stack, so the next token is the last token in the vector.
///
/// Adding tokens to the front of the input using this method can be more efficient
/// than using [ExpansionInput::push_expansion] because an allocation is avoided.
#[inline]
pub fn expansions_mut(&mut self) -> &mut Vec<Token> {
self.0 .0 .0.internal.expansions_mut()
}
#[inline]
pub fn state_and_expansions_mut(&mut self) -> (&S, &mut Vec<Token>) {
(&self.0 .0 .0.state, self.0 .0 .0.internal.expansions_mut())
}
/// Returns a vector than can be used as a token buffer, potentially without allocating memory.
///
/// The returned vector is empty, but will generally have non-zero capacity from previous uses of the buffer.
/// Reusing the allocated memory results in fewer allocations overall.
/// This buffer mechanism was first introduced in a successful attempt to improve the performance of the
/// TeX macros implementation.
///
/// When finished with the buffer, please return it using [return_token_buffer](ExpansionInput::return_token_buffer).
///
/// This API may feel a bit awkward - it would seem nicer to return a mutable reference to a buffer instead.
/// Doing this while keeping the borrow checker happy is very difficult and (as is often the case) for good reason.
/// Token buffers are often used in macro expansion, and at any point in time multiple macros may be in
/// the process of expansion.
/// This getting "the" token buffer to use for expansion would be incorrect, as the multiple expansions
/// would step on each other.
pub fn checkout_token_buffer(&mut self) -> Vec<Token> {
self.0
.0
.0
.internal
.token_buffers
.pop()
.unwrap_or_default()
.0
}
/// Return a token buffer, allowing it to be reused.
pub fn return_token_buffer(&mut self, mut token_buffer: Vec<Token>) {
token_buffer.clear();
self.0
.0
.0
.internal
.token_buffers
.push(super::TokenBuffer(token_buffer))
}
}
/// Input type for execution primitives.
///
/// This type provides:
///
/// - Access to the input stream (with or without expansion). Its implementation of the [TokenStream]
/// trait returns expanded tokens.
/// To read the input stream without performing expansion, use the
/// [unexpanded](ExpandedStream::unexpanded) method.
///
/// - Mutable access to the state and the commands map
/// the [ExecutionInput::state_mut]
/// and [ExecutionInput::commands_map_mut] methods.
#[repr(transparent)]
pub struct ExecutionInput<S>(ExpandedStream<S>);
impl<S> std::convert::AsMut<ExpandedStream<S>> for ExecutionInput<S> {
fn as_mut(&mut self) -> &mut ExpandedStream<S> {
&mut self.0
}
}
impl<S: TexlangState> TokenStream for ExecutionInput<S> {
type S = S;
fn next(&mut self) -> Result<Option<Token>, Box<error::Error>> {
self.0.next()
}
fn peek(&mut self) -> Result<Option<&Token>, Box<error::Error>> {
self.0.peek()
}
fn vm(&self) -> &vm::VM<Self::S> {
self.0.vm()
}
}
impl<S> ExecutionInput<S> {
/// Creates a mutable reference to this type from the [VM](vm::VM) type.
#[inline]
pub fn new(vm: &mut vm::VM<S>) -> &mut ExecutionInput<S> {
unsafe { &mut *(vm as *mut vm::VM<S> as *mut ExecutionInput<S>) }
}
#[inline]
pub fn unexpanded(&mut self) -> &mut UnexpandedStream<S> {
&mut self.0 .0
}
#[inline]
pub fn commands_map_mut(&mut self) -> &mut command::Map<S> {
&mut self.0 .0 .0.commands_map
}
/// Returns a mutable reference to the state.
#[inline]
pub fn state_mut(&mut self) -> &mut S {
&mut self.0 .0 .0.state
}
/// Returns a mutable reference to the tracer.
pub fn tracer_mut(&mut self) -> &mut trace::Tracer {
&mut self.0 .0 .0.internal.tracer
}
/// Returns a [vm::Parts] struct contains mutable references to different parts of the VM.
#[inline]
pub fn vm_parts(&mut self) -> vm::Parts<'_, S> {
let vm = &mut self.0 .0 .0;
vm::Parts {
state: &mut vm.state,
cs_name_interner: &mut vm.internal.cs_name_interner,
tracer: &mut vm.internal.tracer,
}
}
// TODO: pass in the token and keep it as a reference
pub fn begin_group(&mut self) {
self.0 .0 .0.begin_group()
}
pub fn end_group(&mut self, token: Token) -> Result<(), Box<error::Error>> {
self.0 .0 .0.end_group(token)
}
#[inline]
pub(crate) fn groups(&mut self) -> &mut [variable::SaveStackElement<S>] {
&mut self.0 .0 .0.internal.save_stack
}
pub(crate) fn current_group_mut(&mut self) -> Option<(&mut variable::SaveStackElement<S>, &S)> {
match self.0 .0 .0.internal.save_stack.last_mut() {
None => None,
Some(g) => Some((g, &self.0 .0 .0.state)),
}
}
/// Push tokens to the front of the input stream.
///
/// The first token in the provided slice will be the next token read.
// TODO: destroy
#[inline]
pub(crate) fn push_token(&mut self, token: Token) {
self.0 .0 .0.internal.expansions_mut().push(token);
}
/// Return a token buffer, allowing it to be reused.
pub fn return_token_buffer(&mut self, mut token_buffer: Vec<Token>) {
token_buffer.clear();
self.0
.0
.0
.internal
.token_buffers
.push(super::TokenBuffer(token_buffer))
}
}
/// Strips the lifetime from the token.
///
/// This function is intended to get around limitations of the borrow checker only. It
/// should only be used when the code is actually fine but the borrow checker is being
/// too conservative. Don't do anything fancy.
///
/// See this question for the type of code this function is designed for:
/// https://stackoverflow.com/questions/69680201/is-this-use-of-unsafe-trivially-safe
#[inline]
unsafe fn launder<'a>(token: &Token) -> &'a Token {
&*(token as *const Token)
}
mod stream {
use super::*;
use crate::token::lexer;
use crate::token::lexer::Config;
impl<T: TexlangState> Config for T {
#[inline]
fn cat_code(&self, c: char) -> crate::types::CatCode {
self.cat_code(c)
}
// TODO: implement \endlinechar
#[inline]
fn end_line_char(&self) -> Option<char> {
self.end_line_char()
}
}
#[inline]
pub fn next_unexpanded<S: TexlangState>(
vm: &mut vm::VM<S>,
) -> Result<Option<Token>, Box<error::Error>> {
if let Some(token) = vm.internal.current_source.expansions.pop() {
return Ok(Some(token));
}
match vm.internal.current_source.root.next(
&vm.state,
&mut vm.internal.cs_name_interner,
false,
) {
lexer::Result::Token(token) => {
return Ok(Some(token));
}
lexer::Result::InvalidCharacter(c, trace_key) => {
return Err(build_invalid_character_error(vm, c, trace_key));
}
// The EndOfLine case is never returned from the lexer but we silently handle it.
lexer::Result::EndOfLine | lexer::Result::EndOfInput => {}
}
next_unexpanded_recurse(vm)
}
fn next_unexpanded_recurse<S: TexlangState>(
vm: &mut vm::VM<S>,
) -> Result<Option<Token>, Box<error::Error>> {
if vm.internal.pop_source() {
next_unexpanded(vm)
} else {
Ok(None)
}
}
#[inline]
pub fn peek_unexpanded<S: TexlangState>(
vm: &mut vm::VM<S>,
) -> Result<Option<&Token>, Box<error::Error>> {
if let Some(token) = vm.internal.current_source.expansions.last() {
return Ok(Some(unsafe { launder(token) }));
}
match vm.internal.current_source.root.next(
&vm.state,
&mut vm.internal.cs_name_interner,
false,
) {
lexer::Result::Token(token) => {
vm.internal.current_source.expansions.push(token);
return Ok(vm.internal.current_source.expansions.last());
}
lexer::Result::InvalidCharacter(c, trace_key) => {
return Err(build_invalid_character_error(vm, c, trace_key));
}
// The EndOfLine case is never returned from the lexer but we silently handle it.
lexer::Result::EndOfLine | lexer::Result::EndOfInput => {}
}
peek_unexpanded_recurse(vm)
}
fn peek_unexpanded_recurse<S: TexlangState>(
vm: &mut vm::VM<S>,
) -> Result<Option<&Token>, Box<error::Error>> {
if vm.internal.pop_source() {
peek_unexpanded(vm)
} else {
Ok(None)
}
}
fn build_invalid_character_error<S: TexlangState>(
vm: &mut vm::VM<S>,
c: char,
trace_key: trace::Key,
) -> Box<error::Error> {
lexer::InvalidCharacterError::new(vm, c, trace_key).into()
}
pub fn next_expanded<S: TexlangState>(
vm: &mut vm::VM<S>,
) -> Result<Option<Token>, Box<error::Error>> {
let (token, command) = match next_unexpanded(vm)? {
None => return Ok(None),
Some(token) => match token.value() {
token::Value::CommandRef(command_ref) => {
(token, vm.commands_map.get_command(&command_ref))
}
_ => return Ok(Some(token)),
},
};
match command {
Some(command::Command::Expansion(command, tag)) => {
let command = *command;
let tag = *tag;
match S::expansion_override_hook(token, ExpansionInput::new(vm), tag) {
Ok(None) => (),
Ok(Some(override_expansion)) => {
return Ok(Some(override_expansion));
}
Err(err) => return Err(convert_command_error(vm, token, err)),
};
if let Err(err) = command(token, ExpansionInput::new(vm)) {
return Err(convert_command_error(vm, token, err));
};
next_expanded(vm)
}
Some(command::Command::Macro(command)) => {
let command = command.clone();
if let Err(err) = command.call(token, ExpansionInput::new(vm)) {
return Err(convert_command_error(vm, token, err));
}
next_expanded(vm)
}
_ => Ok(Some(token)),
}
}
pub fn peek_expanded<S: TexlangState>(
vm: &mut vm::VM<S>,
) -> Result<Option<&Token>, Box<error::Error>> {
let (token, command) = match peek_unexpanded(vm)? {
None => return Ok(None),
Some(token) => match token.value() {
token::Value::CommandRef(command_ref) => (
unsafe { launder(token) },
vm.commands_map.get_command(&command_ref),
),
_ => return Ok(Some(unsafe { launder(token) })),
},
};
match command {
Some(command::Command::Expansion(command, tag)) => {
let command = *command;
let token = *token;
let tag = *tag;
consume_peek(vm);
match S::expansion_override_hook(token, ExpansionInput::new(vm), tag) {
Ok(None) => (),
Ok(Some(override_expansion)) => {
vm.internal.expansions_mut().push(override_expansion);
return Ok(vm.internal.expansions().last());
}
Err(err) => return Err(convert_command_error(vm, token, err)),
};
if let Err(err) = command(token, ExpansionInput::new(vm)) {
return Err(convert_command_error(vm, token, err));
};
peek_expanded(vm)
}
Some(command::Command::Macro(command)) => {
let command = command.clone();
let token = *token;
consume_peek(vm);
if let Err(err) = command.call(token, ExpansionInput::new(vm)) {
return Err(convert_command_error(vm, token, err));
}
peek_expanded(vm)
}
_ => Ok(Some(unsafe { launder(token) })),
}
}
pub fn expand_once<S: TexlangState>(vm: &mut vm::VM<S>) -> Result<bool, Box<error::Error>> {
let (token, command) = match peek_unexpanded(vm)? {
None => return Ok(false),
Some(token) => match token.value() {
token::Value::CommandRef(command_ref) => (
unsafe { launder(token) },
vm.commands_map.get_command(&command_ref),
),
_ => return Ok(false),
},
};
match command {
Some(command::Command::Expansion(command, tag)) => {
let command = *command;
let token = *token;
let tag = *tag;
consume_peek(vm);
match S::expansion_override_hook(token, ExpansionInput::new(vm), tag) {
Ok(None) => (),
Ok(Some(override_expansion)) => {
vm.internal.expansions_mut().push(override_expansion);
return Ok(true);
}
Err(err) => return Err(convert_command_error(vm, token, err)),
};
if let Err(err) = command(token, ExpansionInput::new(vm)) {
return Err(convert_command_error(vm, token, err));
};
Ok(true)
}
Some(command::Command::Macro(command)) => {
let command = command.clone();
let token = *token;
consume_peek(vm);
if let Err(err) = command.call(token, ExpansionInput::new(vm)) {
return Err(convert_command_error(vm, token, err));
}
Ok(true)
}
_ => Ok(false),
}
}
#[inline]
pub fn consume_peek<S>(vm: &mut vm::VM<S>) {
// When we peek at a token, it is placed on top of the expansions stack.
// So to consume the token, we just need to remove it from the stack.
vm.internal.current_source.expansions.pop();
}
use crate::error::Error;
fn convert_command_error<S: TexlangState>(
vm: &mut vm::VM<S>,
token: Token,
err: Box<error::Error>,
) -> Box<Error> {
Error::new_propagated(vm, error::PropagationContext::Expansion, token, err)
}
}