Struct DefaultGullet 

pub struct DefaultGullet<ET: EngineTypes> { /* private fields */ }

Default implementation of a Gullet.

Trait Implementations

impl<ET: EngineTypes> Gullet<ET> for DefaultGullet<ET>

fn new( _aux: &mut EngineAux<ET>, _state: &mut ET::State, _mouth: &mut ET::Mouth, ) -> Self

Instantiate a new Gullet

fn csnames(&mut self) -> &mut usize

Get a mutable reference to the counter for the number of \csnames we are currently in

fn push_align(&mut self, ad: AlignData<ET::Token, ET::Dim>)

Push a new AlignData onto the stack, i.e. on \halign or \valign

fn pop_align(&mut self) -> Option<AlignData<ET::Token, ET::Dim>>

Pop the last AlignData from the stack, i.e. at the end of \halign or \valign

fn do_macro( engine: &mut EngineReferences<'_, ET>, m: Macro<ET::Token>, token: ET::Token, ) -> TeXResult<(), ET>

Expand the given Macro with its given expansion function.

fn get_align_data(&mut self) -> Option<&mut AlignData<ET::Token, ET::Dim>>

Inspect the current AlignData, if any (i.e. if we are in an \halign or \valign)

fn get_conditional(&self) -> Option<ActiveConditional<ET::Int>>

Inspect the current ActiveConditional, if any (i.e. if we are in an \if or similar)

fn get_conditionals(&mut self) -> &mut Vec<ActiveConditional<ET::Int>>

Get a mutable reference to the stack of ActiveConditionals

fn iterate<R, E, F: FnMut(&mut EngineAux<ET>, &ET::State, ET::Token) -> TeXResult<Option<R>, ET>>( &mut self, mouth: &mut ET::Mouth, aux: &mut EngineAux<ET>, state: &ET::State, cont: F, eof: E, ) -> TeXResult<R, ET>

where E: Fn(&EngineAux<ET>, &ET::State, &mut ET::Mouth) -> TeXResult<(), ET>,

Wrapper around Mouth::iterate that, in case we are in an \halign or \valign, make sure to replace &, \cr etc. with the appropriate tokens. See also EngineReferences::iterate.

fn get_next( &mut self, mouth: &mut ET::Mouth, aux: &mut EngineAux<ET>, state: &ET::State, noexpand: bool, ) -> Result<Option<ET::Token>, GulletError<ET::Char>>

Wrapper around Mouth::get_next that, in case we are in an \halign or \valign, make sure to replace &, \cr etc. with the appropriate tokens. If noexpand is true, \cr, \crcr and & are not expanded. See also EngineReferences::get_next.

fn read_until_endgroup<E, F: FnMut(&mut EngineAux<ET>, &ET::State, ET::Token) -> TeXResult<(), ET>>( &mut self, mouth: &mut ET::Mouth, aux: &mut EngineAux<ET>, state: &ET::State, cont: F, eof: E, ) -> TeXResult<ET::Token, ET>

where E: Fn(&EngineAux<ET>, &ET::State, &mut ET::Mouth) -> TeXResult<(), ET>,

Wrapper around Mouth::read_until_endgroup that, in case we are in an \halign or \valign, make sure to replace &, \cr etc. with the appropriate tokens. See also EngineReferences::read_until_endgroup.

fn requeue( &mut self, aux: &EngineAux<ET>, state: &ET::State, mouth: &mut ET::Mouth, t: ET::Token, ) -> TeXResult<(), ET>

Wrapper around Mouth::requeue that makes sure to update the AlignData if we are in an \halign or \valign. See also EngineReferences::requeue.

fn read_int( engine: &mut EngineReferences<'_, ET>, skip_eq: bool, in_token: &ET::Token, ) -> TeXResult<ET::Int, ET>

Read an integer from the input stream. See also EngineReferences::read_int.

fn read_dim( engine: &mut EngineReferences<'_, ET>, skip_eq: bool, in_token: &ET::Token, ) -> TeXResult<ET::Dim, ET>

Read a dimension value from the input stream. See also EngineReferences::read_dim.

fn read_skip( engine: &mut EngineReferences<'_, ET>, skip_eq: bool, in_token: &ET::Token, ) -> TeXResult<Skip<ET::Dim>, ET>

Read a skip value from the input stream. See also EngineReferences::read_skip.

fn read_muskip( engine: &mut EngineReferences<'_, ET>, skip_eq: bool, in_token: &ET::Token, ) -> TeXResult<MuSkip<ET::MuDim>, ET>

Read a muskip value from the input stream. See also EngineReferences::read_muskip.

fn read_mudim( engine: &mut EngineReferences<'_, ET>, skip_eq: bool, in_token: &ET::Token, ) -> TeXResult<ET::MuDim, ET>

Read a mudim value from the input stream (for \mkern). See also EngineReferences::read_mudim.

fn read_string( engine: &mut EngineReferences<'_, ET>, skip_eq: bool, target: &mut String, in_token: &ET::Token, ) -> TeXResult<(), ET>

Read a string from the input stream. See also EngineReferences::read_string.

fn read_maybe_braced_string( engine: &mut EngineReferences<'_, ET>, skip_eq: bool, target: &mut String, in_token: &ET::Token, ) -> TeXResult<(), ET>

fn read_keyword( engine: &mut EngineReferences<'_, ET>, kw: &[u8], ) -> TeXResult<bool, ET>

Check whether the input stream starts with the given keyword. See also EngineReferences::read_keyword.

fn read_keywords<'a>( engine: &mut EngineReferences<'_, ET>, kw: &'a [&'a [u8]], ) -> TeXResult<Option<&'a [u8]>, ET>

Check whether the input stream starts with one of the given keywords. See also EngineReferences::read_keywords.

fn read_chars( engine: &mut EngineReferences<'_, ET>, kws: &[u8], ) -> TeXResult<Either<u8, Option<ET::Token>>, ET>

Check whether the next character is one of the provided ones. See also EngineReferences::read_chars.

fn resolve<'a>(state: &'a ET::State, token: &ET::Token) -> ResolvedToken<'a, ET>

Inspect the given Token and return its current definition, if any. See also EngineReferences::resolve.

fn char_or_primitive( state: &ET::State, token: &ET::Token, ) -> Option<CharOrPrimitive<ET>>

Inspects the Token and returns either the PrimitiveIdentifier or the Character and CommandCode or None if the token is neither a primitive nor a character. Useful for e.g. quick checks in an \halign whether the token is a specific primitive (\cr,\crcr,\span) or a character (&, space).

fn do_expandable( engine: &mut EngineReferences<'_, ET>, name: PrimitiveIdentifier, token: ET::Token, f: fn(&mut EngineReferences<'_, ET>, &mut Vec<ET::Token>, ET::Token) -> TeXResult<(), ET>, ) -> TeXResult<(), ET>

Expand the given expandable Token with its given expansion function. See also Expandable.

fn do_simple_expandable( engine: &mut EngineReferences<'_, ET>, name: PrimitiveIdentifier, token: ET::Token, f: fn(&mut EngineReferences<'_, ET>, ET::Token) -> TeXResult<(), ET>, ) -> TeXResult<(), ET>

Expand the given expandable Token with its given simple expansion function. See also SimpleExpandable.

fn do_conditional( engine: &mut EngineReferences<'_, ET>, name: PrimitiveIdentifier, token: ET::Token, f: fn(&mut EngineReferences<'_, ET>, ET::Token) -> TeXResult<bool, ET>, unless: bool, ) -> TeXResult<(), ET>

Expand the given conditional. See also Conditional

fn expand_until_endgroup<Fn: FnMut(&mut EngineAux<ET>, &ET::State, ET::Token) -> TeXResult<(), ET>>( engine: &mut EngineReferences<'_, ET>, expand_protected: bool, edef_like: bool, token: &ET::Token, cont: Fn, ) -> TeXResult<(), ET>

Expand Tokens until encountering an EndGroup-token. See also EngineReferences::expand_until_endgroup.