Enum MathNode 

pub enum MathNode<ET: EngineTypes, S: MathFontStyleT<ET>> {
    Atom(MathAtom<ET, S>),
    Penalty(i32),
    Mark(usize, TokenList<ET::Token>),
    Whatsit(WhatsitNode<ET>),
    HSkip(Skip<ET::Dim>),
    MSkip {
        skip: MuSkip<ET::MuDim>,
        style: S,
    },
    HFil,
    HFill,
    HFilneg,
    Hss,
    Space,
    HKern(ET::Dim),
    MKern {
        kern: ET::MuDim,
        style: S,
    },
    Leaders(Leaders<ET>),
    VRule {
        width: Option<ET::Dim>,
        height: Option<ET::Dim>,
        depth: Option<ET::Dim>,
        start: SourceRef<ET>,
        end: SourceRef<ET>,
    },
    Over {
        start: SourceRef<ET>,
        end: SourceRef<ET>,
        top: Box<[MathNode<ET, S>]>,
        sep: Option<ET::Dim>,
        bottom: Box<[MathNode<ET, S>]>,
        left: Option<(ET::Char, S)>,
        right: Option<(ET::Char, S)>,
    },
    Choice(S::Choice),
    Marker(S::Markers),
    Custom(ET::CustomNode),
}

A math list node. Comes in two forms: an unresolved form, while the list is being constructed and the various font styles are not fixed yet (e.g. because an \atop comes later that shifts the font style), and a resolved form, where the fonts have been determined and are fixed. The parameter S:MathFontStyleT makes the distinction between the two forms. For S=MathFontStyle (the resolved form), this implements NodeTrait.

Variants

Atom(MathAtom<ET, S>)

A math atom node (see MathAtom)

Penalty(i32)

A penalty node, as produced by \penalty.

Mark(usize, TokenList<ET::Token>)

A mark node, as produced by \mark.

Whatsit(WhatsitNode<ET>)

A whatsit node, as produced by \special, \write, etc.

HSkip(Skip<ET::Dim>)

A glue node, as produced by \hskip.

MSkip

A glue node, as produced by \mskip. If resolved, S provides the adequate em value.

Fields

skip: MuSkip<ET::MuDim>

style: S

HFil

A glue node, as produced by \hfil.

HFill

A glue node, as produced by \hfill.

HFilneg

A glue node, as produced by \hfilneg.

Hss

A glue node, as produced by \hss.

Space

A glue node, as produced by \

HKern(ET::Dim)

A kern node, as produced by \kern.

MKern

A kern node, as produced by \mkern.

Fields

kern: ET::MuDim

style: S

Leaders(Leaders<ET>)

A leaders node, as produced by \leaders or \cleaders or \xleaders.

VRule

A rule node, as produced by \vrule.

Fields

width: Option<ET::Dim>

The provided width of the rule.

height: Option<ET::Dim>

The provided height of the rule.

depth: Option<ET::Dim>

The provided depth of the rule.

start: SourceRef<ET>

The source reference for the start of the rule.

end: SourceRef<ET>

The source reference for the end of the rule.

Over

A “generalized fraction”, as produced by \over, \atop, \above, \abovewithdelims, \overwithdelims, \atopwithdelims.

Fields

start: SourceRef<ET>

The source reference for the start of the node.

end: SourceRef<ET>

The source reference for the end of the node.

top: Box<[MathNode<ET, S>]>

The numerator.

sep: Option<ET::Dim>

The optional separator height.

bottom: Box<[MathNode<ET, S>]>

The denominator.

left: Option<(ET::Char, S)>

The optional left delimiter.

right: Option<(ET::Char, S)>

The optional right delimiter.

Choice(S::Choice)

A \mathchoice node; if resolved, this is just a wrapper around more math nodes.

Marker(S::Markers)

Markers for the various font styles, e.g. \displaystyle, \textstyle, etc.

Custom(ET::CustomNode)

A custom node.

Implementations

impl<ET: EngineTypes> MathNode<ET, UnresolvedMathFontStyle<ET>>

pub fn nodetype(&self) -> NodeType

The node type of this node (as in \lastnodetype).

pub fn opaque(&self) -> bool

See NodeTrait::opaque.

Trait Implementations

impl<ET: Clone + EngineTypes, S: Clone + MathFontStyleT<ET>> Clone for MathNode<ET, S>

where ET::Token: Clone, ET::Dim: Clone, ET::MuDim: Clone, ET::Char: Clone, S::Choice: Clone, S::Markers: Clone, ET::CustomNode: Clone,

fn clone(&self) -> MathNode<ET, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ET: Debug + EngineTypes, S: Debug + MathFontStyleT<ET>> Debug for MathNode<ET, S>

where ET::Token: Debug, ET::Dim: Debug, ET::MuDim: Debug, ET::Char: Debug, S::Choice: Debug, S::Markers: Debug, ET::CustomNode: Debug,

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

Formats the value using the given formatter.

impl<ET: EngineTypes> NodeTrait<ET> for MathNode<ET, MathFontStyle<ET>>

fn display_fmt(&self, indent: usize, f: &mut Formatter<'_>) -> Result

Produces a human-readable string; since nodes are deeply nested, takes an additional indent value to indent the string

fn height(&self) -> ET::Dim

Returns the height of the node.

fn width(&self) -> ET::Dim

Returns the width of the node.

fn depth(&self) -> ET::Dim

Returns the depth of the node.

fn nodetype(&self) -> NodeType

Returns the type of the node, as returned by \lastnodetype.

fn opaque(&self) -> bool

Whether this node is “opaque”; meaning: When considering a list of nodes (e.g. in \unskip or \lastbox, this node should not be considered. Useful for annotation/marker nodes some engine wants to insert, without impacting algorithms that inspect e.g. the last node of the current list.

fn display(&self) -> DisplayNode<'_, ET, Self>

Returns a helper struct that implements Display and uses Self::display_fmt to yield a human-readable string.

fn sourceref(&self) -> Option<(&SourceRef<ET>, &SourceRef<ET>)>