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
//! The Texlang virtual machine (VM).
//!
//! This module contains the definition of the runtime VM,
//! various input streams that wrap the VM
//! and the main function that is used to run Texlang.
//! See the VM documentation in the Texlang book for full documentation.
use super::token::CsName;
use crate::command;
use crate::command::BuiltIn;
use crate::command::Command;
use crate::error;
use crate::texmacro;
use crate::token;
use crate::token::lexer;
use crate::token::trace;
use crate::token::CsNameInterner;
use crate::token::Token;
use crate::token::Value;
use crate::types;
use crate::variable;
use std::collections::HashMap;
use std::path::PathBuf;
use texcraft_stdext::collections::groupingmap;
#[cfg(feature = "serde")]
pub mod serde;
mod streams;
pub use streams::*;
/// Implementations of this trait determine how the VM handles non-execution-command tokens.
///
/// The main loop of the VM reads the next expanded token and performs
/// some action based on the token.
/// Many cases are handled automatically based on the semantics of the TeX language:
///
/// | token type | example | action |
/// | -- | -- | -- |
/// | execution command | `\def` | run the command |
/// | variable command | `\count` | assign a value to the corresponding variable |
/// | token alias | `\a` after `\let\a=a` | run the main VM loop for the token that is aliased |
/// | begin group character | `{` | begin a group
/// | end group character | `}` | end the current group
///
/// Note that the first three rows can arise from both control sequences and active character tokens.
///
/// The remaining cases are not specified by the TeX language but instead by
/// the business logic of the TeX engine being built.
/// The behavior in these cases is specified by implementing the associated handler.
/// These cases and handlers are:
///
/// | token type | example | handler | default |
/// | --- | --- | --- | --- |
/// | character token | `b` | [character_handler](Handlers::character_handler) | do nothing
/// | undefined command | `\b` where `\b` was never defined | [undefined_command_handler](Handlers::undefined_command_handler) | return an undefined control sequence error
/// | unexpanded expansion command | `\the` in `\noexpand\the` | [unexpanded_expansion_command](Handlers::unexpanded_expansion_command) | do nothing
///
/// Each of the handlers has the same function signature as an execution command.
pub trait Handlers<S: TexlangState> {
/// Handler to invoke for character tokens.
///
/// This token is _not_ invoked for tokens whose category code is begin group (1), end group (2) or active character (13).
/// These cases are handled automatically by the VM based on the semantics of the TeX language.
///
/// The default implementation is a no-op.
fn character_handler(
input: &mut ExecutionInput<S>,
token: token::Token,
character: char,
) -> Result<(), Box<error::Error>> {
_ = (input, token, character);
Ok(())
}
/// Handler to invoke for math character tokens.
///
/// The default implementation throws an error because math character tokens are
/// only valid in math mode which is implemented outside of the main VM loop.
fn math_character_handler(
input: &mut ExecutionInput<S>,
token: token::Token,
math_character: types::MathCode,
) -> Result<(), Box<error::Error>> {
_ = math_character;
Err(error::SimpleTokenError::new(
input.vm(),
token,
"math characters can only appear in math mode",
)
.into())
}
/// Handler to invoke for a control sequence or active character for which no command is defined.
///
/// The default implementation throws an undefined command error.
fn undefined_command_handler(
input: &mut ExecutionInput<S>,
token: token::Token,
) -> Result<(), Box<error::Error>> {
Err(error::UndefinedCommandError::new(input.vm(), token).into())
}
/// Handler to invoke for expansion commands that were not expanded.
///
/// For example, in the TeX snippet `\noexpand\the`, this handler handles
/// the unexpanded `\the` token.
///
/// The default implementation is a no-op.
fn unexpanded_expansion_command(
input: &mut ExecutionInput<S>,
token: token::Token,
) -> Result<(), Box<error::Error>> {
_ = (token, input);
Ok(())
}
}
#[derive(Default)]
pub struct DefaultHandlers;
impl<S: TexlangState> Handlers<S> for DefaultHandlers {}
impl<S: TexlangState> VM<S> {
/// Run the VM.
///
/// It is assumed that the VM has been preloaded with TeX source code using the
/// [VM::push_source] method.
pub fn run<H: Handlers<S>>(&mut self) -> Result<(), Box<error::Error>> {
let input = ExecutionInput::new(self);
loop {
let token = match input.next()? {
None => break,
Some(token) => token,
};
// TODO: propagate the error return value from all of these
match token.value() {
Value::CommandRef(command_ref) => {
match input.commands_map().get_command(&command_ref) {
Some(Command::Execution(cmd, _)) => {
if let Err(err) = cmd(token, input) {
return Err(error::Error::new_propagated(
input.vm(),
error::PropagationContext::Execution,
token,
err,
));
}
}
Some(Command::Variable(cmd)) => {
let cmd = cmd.clone();
let scope = S::variable_assignment_scope_hook(input.state_mut());
cmd.set_value_using_input(token, input, scope)?;
}
Some(Command::CharacterTokenAlias(token_value)) => {
// TODO: should add tests for when this is begin group and end group.
input
.push_token(Token::new_from_value(*token_value, token.trace_key()));
}
Some(Command::Expansion(_, _)) | Some(Command::Macro(_)) => {
H::unexpanded_expansion_command(input, token)?
}
Some(Command::Character(c)) => {
let token = Token::new_other(*c, token.trace_key()); // Remove
H::character_handler(input, token, *c)?
}
Some(Command::MathCharacter(c)) => {
H::math_character_handler(input, token, *c)?
}
None => H::undefined_command_handler(input, token)?,
}
}
Value::BeginGroup(_) => {
input.begin_group();
}
Value::EndGroup(_) => {
input.end_group(token)?;
}
Value::MathShift(c)
| Value::AlignmentTab(c)
| Value::Parameter(c)
| Value::Superscript(c)
| Value::Subscript(c)
| Value::Space(c)
| Value::Letter(c)
| Value::Other(c) => H::character_handler(input, token, c)?,
};
}
Ok(())
}
}
#[derive(Debug)]
struct EndOfGroupError {
trace: trace::SourceCodeTrace,
}
impl error::TexError for EndOfGroupError {
fn kind(&self) -> error::Kind {
error::Kind::Token(&self.trace)
}
fn title(&self) -> String {
"there is no group to end".into()
}
}
/// The Texlang virtual machine.
pub struct VM<S> {
/// The state
pub state: S,
/// The commands map
pub commands_map: command::Map<S>,
/// The working directory which is used as the root for relative file paths
///
/// This is [None] if the working directory could not be determined.
pub working_directory: Option<std::path::PathBuf>,
internal: Internal<S>,
}
/// Mutable references to different parts of the VM.
pub struct Parts<'a, S> {
pub state: &'a mut S,
pub cs_name_interner: &'a mut token::CsNameInterner,
pub tracer: &'a mut trace::Tracer,
}
/// Implementations of this trait may be used as the state in a Texlang VM.
///
/// The most important thing to know about this trait is that it has no required methods.
/// For any type it can be implemented trivially:
/// ```
/// # use texlang::traits::TexlangState;
/// struct SomeNewType;
///
/// impl TexlangState for SomeNewType {}
/// ```
///
/// Methods of the trait are invoked at certain points when the VM is running,
/// and in general offer a way of customizing the behavior of the VM.
/// The trait methods are all dispatched statically, which is important for performance.
pub trait TexlangState: Sized {
/// Get the cat code for the provided character.
///
/// The default implementation returns the cat code used in plain TeX.
fn cat_code(&self, c: char) -> types::CatCode {
types::CatCode::PLAIN_TEX_DEFAULTS
.get(c as usize)
.copied()
.unwrap_or_default()
}
/// Get current end line char, or [None] if it's undefined.
///
/// The default implementation returns `Some(\r)`.
fn end_line_char(&self) -> Option<char> {
Some('\r')
}
/// Hook that is invoked after a TeX macro is expanded.
///
/// This hook is designed to support the `\tracingmacros` primitive.
fn post_macro_expansion_hook(
token: Token,
input: &ExpansionInput<Self>,
tex_macro: &texmacro::Macro,
arguments: &[&[Token]],
reversed_expansion: &[Token],
) {
_ = (token, input, tex_macro, arguments, reversed_expansion);
}
/// Hook that potentially overrides the expansion of a command.
///
/// This hook is invoked before an expandable token is expanded.
/// If the result of the hook is a non-empty, that result is considered the expansion of
/// the token
/// The result of the hook is not expanded before being returned.
///
/// This hook is designed to support the `\noexpand` primitive.
fn expansion_override_hook(
token: token::Token,
input: &mut ExpansionInput<Self>,
tag: Option<command::Tag>,
) -> Result<Option<Token>, Box<command::Error>> {
_ = (token, input, tag);
Ok(None)
}
/// Hook that determines the scope of a variable assignment.
///
/// This hook is designed to support the \global and \globaldefs commands.
fn variable_assignment_scope_hook(state: &mut Self) -> groupingmap::Scope {
_ = state;
groupingmap::Scope::Local
}
/// Hook that determines what to do when a recoverable error occurs.
///
/// If the hook returns `Ok(())` then the recovery process should run.
/// If the hook returns an error, then that error should be returned from the enclosing
/// function and propagated through the VM.
///
/// Note that there is no requirement that an error returned from this hook
/// is the same as the error provided to the hook.
/// For example, when Knuth's TeX is running in batch mode errors are
/// logged but otherwise ignored.
/// However if 100 such errors occur, the interpreter fails.
/// To implement this in Texlang, the result of this function would be `Ok(())`
/// for the first 99 errors,
/// but after the 100th error a "too many errors" error would be returned from the hook.
/// Note that the returned error in this case is not the 100th error itself.
fn recoverable_error_hook(
vm: &VM<Self>,
recoverable_error: Box<error::Error>,
) -> Result<(), Box<error::Error>> {
_ = vm;
Err(recoverable_error)
}
}
impl TexlangState for () {}
impl<S: Default> VM<S> {
/// Create a new VM with the provided built-in commands.
///
/// If the state type satisfies the [`HasDefaultBuiltInCommands`] trait,
/// and you are using the default built-ins,
/// use the [`VM::new`] method instead.
pub fn new_with_built_in_commands(built_in_commands: HashMap<&str, BuiltIn<S>>) -> VM<S> {
let mut internal = Internal::new(Default::default());
let built_in_commands = built_in_commands
.into_iter()
.map(|(key, value)| (internal.cs_name_interner.get_or_intern(key), value))
.collect();
VM {
state: Default::default(),
commands_map: command::Map::new(built_in_commands),
internal,
working_directory: match std::env::current_dir() {
Ok(path_buf) => Some(path_buf),
Err(err) => {
println!("failed to determine the working directory: {err}");
None
}
},
}
}
}
impl<S: Default + HasDefaultBuiltInCommands> VM<S> {
/// Create a new VM.
pub fn new() -> VM<S> {
VM::<S>::new_with_built_in_commands(S::default_built_in_commands())
}
}
impl<S: Default + HasDefaultBuiltInCommands> Default for VM<S> {
fn default() -> Self {
Self::new()
}
}
/// Deserialize a Texlang VM using the provided built-in commands.
///
/// If the state type satisfies the [`HasDefaultBuiltInCommands`] trait,
/// and you are deserializing using the default built-ins,
/// you don't need to use this function.
/// You can use the serde deserialize trait directly.
/// See the [`serde` submodule](serde) for more information on deserialization.
#[cfg(feature = "serde")]
impl<'de, S: ::serde::Deserialize<'de>> VM<S> {
pub fn deserialize_with_built_in_commands<D: ::serde::Deserializer<'de>>(
deserializer: D,
built_in_commands: HashMap<&str, BuiltIn<S>>,
) -> Result<Self, D::Error> {
serde::deserialize(deserializer, built_in_commands)
}
}
/// States that implement this trait have a default set of built-in commands associated to them.
///
/// In general in Texlang, the same state type can be used with different sets of built-in
/// commands.
/// However in many situations the state type has a specific set of built-ins
/// associated to it.
/// For example, the state type corresponding to pdfTeX is associated with the set of built-ins
/// provided by pdfTeX.
///
/// This trait is used to specify this association.
/// The benefit is that creating new VMs and deserializing VMs is a bit easier
/// because the built-in commands don't need to be provided explicitly.
/// Moreover, if a state implements this trait the associated VM implements serde's deserialize trait.
pub trait HasDefaultBuiltInCommands: TexlangState {
fn default_built_in_commands() -> HashMap<&'static str, BuiltIn<Self>>;
}
#[cfg(feature = "serde")]
impl<'de, S: ::serde::Deserialize<'de> + HasDefaultBuiltInCommands> ::serde::Deserialize<'de>
for VM<S>
{
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
let built_ins = S::default_built_in_commands();
serde::deserialize(deserializer, built_ins)
}
}
impl<S: TexlangState> VM<S> {
/// Add new source code to the VM.
///
/// TeX input source code is organized as a stack.
/// Pushing source code onto the stack will mean it is executed first.
pub fn push_source<T1: Into<PathBuf>, T2: Into<String>>(
&mut self,
file_name: T1,
source_code: T2,
) -> Result<(), Box<error::Error>> {
self.internal
.push_source(None, file_name.into(), source_code.into())
}
}
impl<S> VM<S> {
/// Clear all source code from the VM.
pub fn clear_sources(&mut self) {
self.internal.clear_sources()
}
/// Return a regular hash map with all the commands as they are currently defined.
///
/// This function is extremely slow and is only intended to be invoked on error paths.
pub fn get_commands_as_map_slow(&self) -> HashMap<String, BuiltIn<S>> {
let map_1: HashMap<CsName, BuiltIn<S>> = self.commands_map.to_hash_map_slow();
let mut map = HashMap::new();
for (cs_name, cmd) in map_1 {
let cs_name_str = match self.internal.cs_name_interner.resolve(cs_name) {
None => continue,
Some(cs_name_str) => cs_name_str,
};
map.insert(cs_name_str.to_string(), cmd);
}
map
}
/// Return a reference to the control sequence name string interner.
///
/// This interner can be used to resolve [CsName] types into regular strings.
#[inline]
pub fn cs_name_interner(&self) -> &CsNameInterner {
&self.internal.cs_name_interner
}
fn begin_group(&mut self) {
self.commands_map.begin_group();
self.internal.save_stack.push(Default::default());
}
fn end_group(&mut self, token: token::Token) -> Result<(), Box<error::Error>> {
match self.commands_map.end_group() {
Ok(()) => (),
Err(_) => {
return Err(EndOfGroupError {
trace: self.trace(token),
}
.into())
}
}
let group = self.internal.save_stack.pop().unwrap();
group.restore(ExecutionInput::new(self));
Ok(())
}
pub fn trace(&self, token: Token) -> trace::SourceCodeTrace {
self.internal
.tracer
.trace(token, &self.internal.cs_name_interner)
}
pub fn trace_end_of_input(&self) -> trace::SourceCodeTrace {
self.internal.tracer.trace_end_of_input()
}
/// Returns the number of current sources on the source stack
pub fn num_current_sources(&self) -> usize {
self.internal.sources.len() + 1
}
}
/// Parts of the VM that are private.
// We have serde(bound="") because otherwise serde tries to put a `Default` bound on S.
#[cfg_attr(
feature = "serde",
derive(::serde::Serialize, ::serde::Deserialize),
serde(bound = "")
)]
struct Internal<S> {
// The sources form a stack. We store the top element directly on the VM
// for performance reasons.
current_source: Source,
sources: Vec<Source>,
cs_name_interner: CsNameInterner,
tracer: trace::Tracer,
#[cfg_attr(feature = "serde", serde(skip))]
token_buffers: std::collections::BinaryHeap<TokenBuffer>,
// The save stack is handled manually in (de)serialization.
// We need to use special logic in combination with the command map in order to serialize the
// variable pointers that are in the stack.
#[cfg_attr(feature = "serde", serde(skip))]
save_stack: Vec<variable::SaveStackElement<S>>,
}
impl<S> Internal<S> {
fn new(cs_name_interner: CsNameInterner) -> Self {
Internal {
current_source: Default::default(),
sources: Default::default(),
cs_name_interner,
tracer: Default::default(),
token_buffers: Default::default(),
save_stack: Default::default(),
}
}
}
impl<S: TexlangState> Internal<S> {
fn push_source(
&mut self,
token: Option<Token>,
file_name: PathBuf,
source_code: String,
) -> Result<(), Box<error::Error>> {
let trace_key_range =
self.tracer
.register_source_code(token, trace::Origin::File(file_name), &source_code);
let mut new_source = Source::new(source_code, trace_key_range);
std::mem::swap(&mut new_source, &mut self.current_source);
// TODO: if the current top source is empty, we should skip this.
// Check this is working by looking at the JSON serialization.
self.sources.push(new_source);
Ok(())
}
fn end_current_file(&mut self) {
self.current_source.root.end()
}
}
impl<S> Internal<S> {
fn clear_sources(&mut self) {
self.current_source = Default::default();
self.sources.clear();
}
#[inline]
fn push_expansion(&mut self, expansion: &[Token]) {
self.current_source
.expansions
.extend(expansion.iter().rev());
}
#[inline]
fn expansions(&self) -> &Vec<Token> {
&self.current_source.expansions
}
#[inline]
fn expansions_mut(&mut self) -> &mut Vec<Token> {
&mut self.current_source.expansions
}
fn pop_source(&mut self) -> bool {
// We should set the current_source to be Default::default() if there is no additional source.
// Check this is working by looking at the JSON serialization.
match self.sources.pop() {
None => false,
Some(source) => {
self.current_source = source;
true
}
}
}
}
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
struct Source {
expansions: Vec<Token>,
root: lexer::Lexer,
}
impl Source {
pub fn new(source_code: String, trace_key_range: trace::KeyRange) -> Source {
Source {
expansions: Vec::with_capacity(32),
root: lexer::Lexer::new(source_code, trace_key_range),
}
}
}
impl Default for Source {
fn default() -> Self {
Source::new("".into(), trace::KeyRange::empty())
}
}
#[derive(Default)]
struct TokenBuffer(Vec<Token>);
impl PartialEq for TokenBuffer {
fn eq(&self, other: &Self) -> bool {
self.0.capacity() == other.0.capacity()
}
}
impl Eq for TokenBuffer {}
impl PartialOrd for TokenBuffer {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for TokenBuffer {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
self.0.capacity().cmp(&other.0.capacity())
}
}
/// Helper trait for implementing the component pattern in Texlang.
///
/// The component pattern is a ubiquitous design pattern in Texlang.
/// It is used when implementing TeX commands that require state.
/// An example of a stateful TeX command is `\year`, which needs to store the current year somewhere.
///
/// When the component pattern is used, a stateful TeX command
/// can have a single implementation that
/// is used by multiple TeX engines built with Texlang.
/// Additionally, a specific TeX engine can compose many different
/// stateful TeX commands together without worrying about conflicts between their state.
/// The component pattern is Texlang's main solution to the problem of
/// global mutable state that is pervasive in the original implementation of TeX.
///
/// In the component pattern, the state
/// needed by a specific command like `\year` is isolated in a _component_, which is a concrete
/// Rust type like a struct.
/// This Rust type is the generic type `C` in the trait.
/// The stateful command (e.g. `\year`) is defined in the same Rust module as the component.
/// The internals of the component are made private to the module it is defined in.
/// This means the state can only be mutated by the command (or commands) implemented in the module.
///
/// In order to function, the command needs to have access to an instance of the component in which
/// the command will maintain its state.
/// The `HasComponent` trait enforces this.
/// Any VM state type that contains the component can implement the trait.
/// The Rust code defining the
/// command specifies the trait in its trait bounds, and uses the trait to access the component.
///
/// The pattern enables Texlang code to be composed as follows.
/// Different VM states can include the same component and thus reuse the same commands.
/// Combining multiple commands into one state just involves having the
/// VM state include all of the relevant components.
///
/// Notes:
///
/// - In general state is shared by multiple commands. Such commands must be defined in the
/// same Rust module to support this.
/// For example, `\countdef` shares state with `\count`,
/// and they are implemented together.
///
/// - Commands don't necessarily have state: for example, `\def`, `\advance` and `\the`.
/// These commands
/// are defined without trait bounds on the state, and work automatically with any TeX
/// software built with Texlang.
///
/// - The easiest way to include a component in the state is to make it a direct field
/// of the state.
/// In this case the [implement_has_component] macro can be used to easily implement the
/// trait.
/// The Texlang standard library uses this approach.
///
/// ## The [TexlangState] requirement
///
/// This trait requires that the type also implements [TexlangState].
/// This is only to reduce the number of trait bounds that need to be explicitly
/// specified when implementing TeX commands.
/// In general every command needs to have a bound of the form `S: TexlangState`.
/// Commands that have a `HasComponent` bound don't need to include this other bound explicitly.
pub trait HasComponent<C>: TexlangState {
/// Return a immutable reference to the component.
fn component(&self) -> &C;
/// Return a mutable reference to the component.
fn component_mut(&mut self) -> &mut C;
}
/// This macro is for implementing the [HasComponent] trait in the special (but common)
/// case when the state is a struct and the component is a direct field of the struct.
///
/// ## Examples
///
/// Implementing a single component:
///
/// ```
/// # mod library_1{
/// # pub struct Component;
/// # }
/// # use texlang::vm::implement_has_component;
/// # use texlang::traits::*;
/// #
/// struct MyState {
/// component: library_1::Component,
/// }
///
/// impl TexlangState for MyState {}
///
/// implement_has_component![MyState{
/// component: library_1::Component,
/// }];
/// ```
///
/// Implementing multiple components:
///
/// ```
/// # mod library_1{
/// # pub struct Component;
/// # }
/// # mod library_2{
/// # pub struct Component;
/// # }
/// # use texlang::vm::implement_has_component;
/// # use texlang::traits::*;
/// #
/// struct MyState {
/// component_1: library_1::Component,
/// component_2: library_2::Component,
/// }
///
/// impl TexlangState for MyState {}
///
/// implement_has_component![MyState{
/// component_1: library_1::Component,
/// component_2: library_2::Component,
/// }];
/// ```
#[macro_export]
macro_rules! implement_has_component {
($type: path {
$( $field: ident: $component: path ),+ $(,)?
}) => {
$(
impl ::texlang::vm::HasComponent<$component> for $type {
#[inline]
fn component(&self) -> &$component {
&self.$field
}
#[inline]
fn component_mut(&mut self) -> &mut $component {
&mut self.$field
}
}
)*
};
}
pub use implement_has_component;