Struct Macro

pub struct Macro<T>
where
    T: Token,
{
    pub protected: bool,
    pub long: bool,
    pub outer: bool,
    pub expansion: TokenList<T>,
    pub signature: MacroSignature<T>,
}

A macro, e.g. the result of \def\foo#1#2{...}.

Fields

protected: bool

Whether the macro is protected, e.g. the result of \protected\def.

long: bool

Whether the macro is long, e.g. the result of \long\def.

outer: bool

Whether the macro is outer, e.g. the result of \outer\def.

expansion: TokenList<T>

The expansion of the macro, e.g. ... in \def\foo#1#2{...}.

signature: MacroSignature<T>

The signatureof the macro, e.g. #1#2 in \def\foo#1#2{...}.

Implementations

impl<T> Macro<T>

where T: Token,

pub fn new<Sig, Exp, ET>( int: &mut <<T as Token>::CS as CSName<<T as Token>::Char>>::Handler, cc: &<<T as Token>::Char as Character>::CharMap<CategoryCode>, sig: Sig, exp: Exp, ) -> Result<Macro<T>, TeXError<ET>>

where Sig: AsRef<str>, Exp: AsRef<str>, ET: EngineTypes<Token = T, Char = <T as Token>::Char>,

Convenience method for creating a new macro from a signature and expansion as strings; given the provided CategoryCodeScheme. Allows for e.g. as_point = Macro::new(int,&DEFAULT_SCHEME_U8,"#1#2","(#1,#2)").

Errors

on invalid tex strings

pub fn meaning<'a>( &'a self, int: &'a <<T as Token>::CS as CSName<<T as Token>::Char>>::Handler, cc: &'a <<T as Token>::Char as Character>::CharMap<CategoryCode>, escapechar: Option<<T as Token>::Char>, ) -> impl Display + 'a

returns a helper struct for displaying the \meaning of this command; implements Display.

pub fn meaning_char<F>( &self, int: &<<T as Token>::CS as CSName<<T as Token>::Char>>::Handler, cc: &<<T as Token>::Char as Character>::CharMap<CategoryCode>, escapechar: Option<<T as Token>::Char>, f: &mut F, ) -> Result<(), Error>

where F: CharWrite<<T as Token>::Char, <T as Token>::CS>,

Write the meaning directly to a CharWrite.

Errors

Formatting error (should never happen)

Trait Implementations

impl<T> Clone for Macro<T>

where T: Clone + Token,

fn clone(&self) -> Macro<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Macro<T>

where T: Debug + Token,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.