Struct Tree 

pub struct Tree { /* private fields */ }

The editable math tree.

Implementations

impl Tree

pub fn to_doc(&self) -> Document

Serialize the live tree to the id free document form.

pub fn from_doc(doc: &Document) -> Self

Rebuild a tree from the document form with fresh ids.

pub fn insert_fragment(&mut self, at: Cursor, frag: &DocFragment) -> Cursor

Splice a clipboard fragment into at.seq starting at at.index.

impl Tree

pub fn export_latex(&self) -> (String, SpanMap)

Exports the whole document to rendering LaTeX and records spans for placeholder matching.

pub fn export_display(&self) -> String

Exports the whole document to clean display and copy LaTeX.

pub fn selection_latex(&self, sel: Selection) -> String

Exports a selection’s content to clean LaTeX for the host clipboard.

impl Tree

pub fn new() -> Self

A new tree with an empty root sequence.

pub fn root(&self) -> SeqId

Return the root sequence id.

pub fn node(&self, id: NodeId) -> Option<&Node>

Return a node by id.

pub fn seq(&self, id: SeqId) -> Option<&Seq>

Return a sequence by id.

pub fn kind(&self, id: NodeId) -> Option<&Kind>

Return a node payload by id.

pub fn items(&self, id: SeqId) -> &[NodeId]

Return the node ids stored in a sequence.

pub fn len(&self, id: SeqId) -> usize

Return the number of nodes in a sequence.

pub fn is_empty(&self, id: SeqId) -> bool

An empty sequence is a structural placeholder.

pub fn seq_parent(&self, id: SeqId) -> Option<NodeId>

The node that owns this sequence as a slot, or None for the root.

pub fn index_in_parent(&self, node: NodeId) -> Option<(SeqId, usize)>

The sequence and index where this node currently lives.

pub fn child_seqs(&self, node: NodeId) -> Vec<SeqId>

All present slot sequences of a node in canonical navigation and ownership order.

impl Tree

pub fn insert_atom(&mut self, at: Cursor, sym: Symbol) -> Cursor

Inserts an atom and returns the cursor after it.

pub fn insert_fraction( &mut self, at: Cursor, style: FracStyle, sel: Option<Selection>, ) -> Cursor

Inserts a fraction and returns a cursor in the numerator or denominator.

pub fn insert_sqrt(&mut self, at: Cursor, sel: Option<Selection>) -> Cursor

Inserts a radical and returns a cursor in the radicand.

pub fn insert_delimiters( &mut self, at: Cursor, open: char, close: char, sel: Option<Selection>, ) -> Cursor

Inserts delimiters and returns a cursor in their body.

pub fn insert_accent( &mut self, at: Cursor, mark: Mark, sel: Option<Selection>, ) -> Cursor

Inserts an accent and returns a cursor in its base.

pub fn insert_styled( &mut self, at: Cursor, variant: Variant, sel: Option<Selection>, ) -> Cursor

Inserts a styled wrapper and returns a cursor in its content.

pub fn insert_under_over( &mut self, at: Cursor, spec: UnderOverSpec, sel: Option<Selection>, ) -> Cursor

Inserts an under or over structure and returns a cursor in its base.

pub fn insert_matrix( &mut self, at: Cursor, env: MatrixEnv, rows: usize, cols: usize, ) -> Cursor

Inserts a matrix and returns a cursor in the first cell.

pub fn insert_big_op(&mut self, at: Cursor, op: Symbol) -> Cursor

Inserts a big operator with empty limits and returns a cursor after it.

pub fn bigop_limit_target( &self, at: Cursor, which: ScriptSlot, ) -> Option<Cursor>

Returns the BigOp limit targeted by _ or ^ when the cursor is after the operator.

pub fn attach_script(&mut self, at: Cursor, which: ScriptSlot) -> Cursor

Attaches or moves into a subscript or superscript on the node before the cursor.

pub fn delete_backward(&mut self, at: Cursor) -> Cursor

Deletes backward, escalating empty placeholders and otherwise moving left when no leaf is removed.

pub fn delete_forward(&mut self, at: Cursor) -> Cursor

Deletes forward as the mirror of Tree::delete_backward.

pub fn delete_selection(&mut self, sel: Selection) -> Cursor

Deletes a contiguous selection run within one seq.

pub fn matrix_shape_at(&self, at: Cursor) -> Option<(usize, usize)>

Returns the shape of the matrix containing the cursor.

pub fn matrix_insert_row(&mut self, at: Cursor, side: Side) -> Cursor

Inserts a matrix row before or after the current row.

pub fn matrix_delete_row(&mut self, at: Cursor) -> Cursor

Deletes the current matrix row when more than one row remains.

pub fn matrix_insert_col(&mut self, at: Cursor, side: Side) -> Cursor

Inserts a matrix column before or after the current column.

pub fn matrix_delete_col(&mut self, at: Cursor) -> Cursor

Deletes the current matrix column when more than one column remains.

pub fn swap_variants(&self, node: NodeId) -> Option<Vec<SwapVariant>>

Returns swap menu alternatives for node, excluding its current value.

pub fn apply_swap(&mut self, node: NodeId, variant: &SwapVariant)

Applies a chosen alternative by changing only the named tag fields.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl Default for Tree

fn default() -> Self

Returns the “default value” for a type.