Struct Nodes 

pub struct Nodes {
    pub in_use: usize,
    pub props: Properties,
    pub sync: Option<Box<SyncFields>>,
    pub double_free: Option<(u8, u32)>,
    pub par_temp: NodeRef,
    pub lua_refs: LuaRefs,
    /* private fields */
}

The node arena.

Fields

in_use: usize

Number of nodes in use.

props: Properties

Lua node properties.

sync: Option<Box<SyncFields>>

SyncTeX fields of the nodes, while SyncTeX is on (see SyncFields).

double_free: Option<(u8, u32)>

The first node freed twice, with its type before the first free: a fatal error in LuaTeX, reported by the engine (see Engine::check_double_free).

par_temp: NodeRef

The temporary head of a paragraph during its node processing callbacks: LuaTeX’s is not a node that can be freed.

lua_refs: LuaRefs

The numbers of the Lua values nodes keep by reference.

Implementations

impl Nodes

pub fn new() -> Self

An arena with only the null node.

pub fn enable_sync(&mut self)

Starts keeping SyncTeX fields (for nodes made from now on).

pub fn sync_fields(&self, p: NodeRef) -> (u32, i32)

The SyncTeX tag and line of p, (0, 0) if it has none.

pub fn set_sync_fields(&mut self, p: NodeRef, f: (u32, i32))

Sets the SyncTeX tag and line of p (when SyncTeX is on).

pub fn sync_as_copied(&mut self, p: NodeRef)

Sets the SyncTeX fields of p, a node just made by font processing that LuaTeX’s Lua code makes by copying (kerns from OpenType positioning): the current tag and line.

pub fn capacity(&self) -> usize

The number of node slots in the arena.

pub fn alloc(&mut self, id: u8, subtype: u16, data: NodeData) -> NodeRef

Allocates a node.

pub fn free(&mut self, p: NodeRef)

Frees a single node (not its sublists).

pub fn lua_ref_of(&mut self, p: NodeRef) -> Option<i32>

The reference number of the Lua value node p keeps, if any.

pub fn is_free(&self, p: NodeRef) -> bool

Whether p was freed (and not allocated again).

pub fn get(&self, p: NodeRef) -> &Node

The node at p.

pub fn get_mut(&mut self, p: NodeRef) -> &mut Node

The node at p, mutably.

pub fn id(&self, p: NodeRef) -> u8

The type id of p.

pub fn next(&self, p: NodeRef) -> NodeRef

The next link of p.

pub fn link(&mut self, p: NodeRef, q: NodeRef)

Links q after p (sets p.next and q.prev).

pub fn box_data(&self, p: NodeRef) -> Option<&BoxData>

The box data of an hlist/vlist node.

pub fn box_data_mut(&mut self, p: NodeRef) -> Option<&mut BoxData>

The box data of an hlist/vlist node, mutably.

pub fn tail_of(&self, p: NodeRef) -> NodeRef

The last node of the list starting at p.

pub fn bounded_tail(&self, p: NodeRef) -> Option<NodeRef>

The last node of the list starting at p, or None if the list is circular (Lua code can link nodes into a loop).

pub fn flush_list(&mut self, p: NodeRef)

Frees a whole node list, including sublists (flush_node_list).

pub fn copy_list(&mut self, p: NodeRef) -> NodeRef

Copies a whole node list, including sublists (copy_node_list).

pub fn copy_node(&mut self, p: NodeRef) -> NodeRef

Copies one node with its sublists; the copy’s links are null.

pub fn new_null_box(&mut self, hlist: bool) -> NodeRef

A new empty box of the given type (new_null_box).

pub fn new_glue(&mut self, spec: Glue, subtype: u16) -> NodeRef

A new glue node.

pub fn new_kern(&mut self, w: i32, subtype: u16) -> NodeRef

A new kern node.

pub fn new_penalty(&mut self, m: i32, subtype: u16) -> NodeRef

A new penalty node.

pub fn new_temp(&mut self) -> NodeRef

A new temporary list head.

pub fn new_glyph(&mut self, font: u32, chr: u32) -> NodeRef

A new glyph node.

pub fn new_rule(&mut self, width: i32, height: i32, depth: i32) -> NodeRef

A new rule node with the given dimensions.

pub fn new_disc(&mut self, subtype: u16, penalty: i32) -> NodeRef

A new empty discretionary node.

pub fn new_math(&mut self, surround: i32, subtype: u16) -> NodeRef

A new math node.

pub fn data(&self, p: NodeRef) -> &NodeData

The type-specific data of p.

pub fn data_mut(&mut self, p: NodeRef) -> &mut NodeData

The type-specific data of p, mutably.

pub fn subtype(&self, p: NodeRef) -> u16

The subtype of p.

pub fn set_subtype(&mut self, p: NodeRef, s: u16)

Sets the subtype of p.

pub fn prev(&self, p: NodeRef) -> NodeRef

The prev link of p.

pub fn set_next(&mut self, p: NodeRef, q: NodeRef)

Sets only the next link of p.

pub fn set_prev(&mut self, p: NodeRef, q: NodeRef)

Sets only the prev link of p.

pub fn is_glyph(&self, p: NodeRef) -> bool

Whether p is a glyph node.

pub fn glyph(&self, p: NodeRef) -> Option<&GlyphData>

The glyph data of a glyph node.

pub fn glyph_mut(&mut self, p: NodeRef) -> Option<&mut GlyphData>

The glyph data of a glyph node, mutably.

pub fn glue_spec(&self, p: NodeRef) -> Glue

The glue specification of a glue node.

pub fn width(&self, p: NodeRef) -> i32

The width of a node that has one (boxes, rules, glue, kerns, math, margin kerns, unset nodes); zero otherwise. Glyph widths need the font and are not handled here.

pub fn penalty(&self, p: NodeRef) -> i32

The penalty of a penalty node (0 for other nodes).

pub fn disc_lists(&self, p: NodeRef) -> (NodeRef, NodeRef, NodeRef)

The (pre, post, replace) lists of a discretionary.

pub fn set_disc_lists(&mut self, p: NodeRef, l: (NodeRef, NodeRef, NodeRef))

Sets the lists of a discretionary.

pub fn list_ptr(&self, p: NodeRef) -> NodeRef

The list of a box, unset node, insertion or adjust node.

pub fn set_list_ptr(&mut self, p: NodeRef, l: NodeRef)

Sets the list of a box, unset node, insertion or adjust node.

pub fn attr(&self, p: NodeRef) -> Option<&AttrList>

The attribute list of p.

pub fn set_attr(&mut self, p: NodeRef, a: Option<AttrList>)

Sets the attribute list of p.

pub fn noad(&self, p: NodeRef) -> Option<&NoadData>

The noad fields of a noad, radical or accent node.

pub fn noad_mut(&mut self, p: NodeRef) -> Option<&mut NoadData>

The noad fields of a noad, radical or accent node, mutably.

pub fn list_ptr_kernel(&self, p: NodeRef) -> NodeRef

The list of a sub_box or sub_mlist kernel (null otherwise).

pub fn set_kernel_list(&mut self, p: NodeRef, l: NodeRef)

Sets the list of a sub_box or sub_mlist kernel.

pub fn scripts_allowed(&self, p: NodeRef) -> bool

Whether p is a noad that can carry scripts (scripts_allowed).

pub fn list_len(&self, p: NodeRef) -> usize

The number of nodes in the list starting at p.

Trait Implementations

impl Clone for Nodes

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Nodes

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

Formats the value using the given formatter.

impl Default for Nodes

fn default() -> Self

Returns the “default value” for a type.