texlang-stdlib 0.1.0

The Texlang standard library of TeX primitives
Documentation 
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

//! The Texcraft primitive, which returns the word Texcraft as eight separate letter tokens
//!
//! This primitive is essentially equivalent to `\def\Texcraft{Texcraft}`.
//! It was implemented to be a simple example of a custom expansion primitive.

use texlang::*;

/// Get the `\texcraft` expansion primitive.
pub fn get_texcraft<S>() -> command::BuiltIn<S> {
    command::BuiltIn::new_expansion(texcraft_primitive_fn)
}

pub fn texcraft_primitive_fn<S>(
    token: token::Token,
    _: &mut vm::ExpansionInput<S>,
) -> command::Result<Vec<token::Token>> {
    Ok(vec![
        token::Token::new_letter('T', token.trace_key()),
        token::Token::new_letter('e', token.trace_key()),
        token::Token::new_letter('x', token.trace_key()),
        token::Token::new_letter('c', token.trace_key()),
        token::Token::new_letter('r', token.trace_key()),
        token::Token::new_letter('a', token.trace_key()),
        token::Token::new_letter('f', token.trace_key()),
        token::Token::new_letter('t', token.trace_key()),
    ])
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use super::*;
    use crate::testing::*;

    fn initial_commands() -> HashMap<&'static str, command::BuiltIn<State>> {
        HashMap::from([("texcraft", get_texcraft())])
    }

    test_suite![expansion_equality_tests((
        texcraft,
        r"\texcraft",
        r"Texcraft"
    ),),];
}