Trait Font 

pub trait Font: Clone + Debug {
    type Char: Character;
    type Dim: TeXDimen;
    type Int: TeXInt;
    type CS: CSName<Self::Char>;

    // Required methods
    fn get_at(&self) -> Self::Dim;
    fn has_at_set(&self) -> bool;
    fn set_at(&mut self, d: Self::Dim);
    fn name(&self) -> &Self::CS;
    fn filename(&self) -> &str;
    fn get_dim(&self, idx: u16) -> Self::Dim;
    fn set_dim(&mut self, idx: u16, d: Self::Dim);
    fn get_hyphenchar(&self) -> Self::Int;
    fn set_hyphenchar(&mut self, c: Self::Int);
    fn get_skewchar(&self) -> Self::Int;
    fn set_skewchar(&mut self, c: Self::Int);
    fn has_char(&self, c: Self::Char) -> bool;
    fn display<W: Write>(
        &self,
        i: &<Self::CS as CSName<Self::Char>>::Handler,
        w: W,
    ) -> Result;
    fn get_wd(&self, c: Self::Char) -> Self::Dim;
    fn get_ht(&self, c: Self::Char) -> Self::Dim;
    fn get_dp(&self, c: Self::Char) -> Self::Dim;
    fn get_ic(&self, c: Self::Char) -> Self::Dim;
    fn set_ic(&mut self, c: Self::Char, d: Self::Dim);
    fn ligature(&self, c1: Self::Char, c2: Self::Char) -> Option<Self::Char>;
}

A font provides various information about Characters (or, rather, glyphs) in that font. Since in the Stomach every glyph in the output is directly associated with a Font, we clone them a lot, so they should be cheap to clone; e.g. using Rc or Arc is a good idea.

Required Associated Types

type Char: Character

The type of Characters used by this font.

type Dim: TeXDimen

The type of TeXDimens used by this font, for e.g. \fontdimen, \fontcharwd etc.

type Int: TeXInt

The type of TeXInts used by this font, for e.g. \skewchar, \hyphenchar etc. - these numbers may escape the actual character range of the font, so we use TeXInts instead of Characters.

type CS: CSName<Self::Char>

The type of control sequences used to give a name to a font; returned by e.g. \the when followed by a font.

Required Methods

fn get_at(&self) -> Self::Dim

The size of the font; initially provided by the font itself, but can be set via e.g. \font\foo=cmr10 at 12pt.

fn has_at_set(&self) -> bool

Returns whether the size of the font has been set via e.g. at ....

fn set_at(&mut self, d: Self::Dim)

Sets the size of the font.

fn name(&self) -> &Self::CS

Returns the name of the font as a CSName; used by e.g. \the\font.

fn filename(&self) -> &str

Returns the filename of the font.

fn get_dim(&self, idx: u16) -> Self::Dim

Returns the \fontdimen at the given index (-1); i.e. \fontdimen5 returns get_dim(4).

fn set_dim(&mut self, idx: u16, d: Self::Dim)

Sets the \fontdimen at the given index (-1); i.e. \fontdimen5=... calls set_dim(4).

fn get_hyphenchar(&self) -> Self::Int

Returns the \hyphenchar of this font.

fn set_hyphenchar(&mut self, c: Self::Int)

Sets the \hyphenchar of this font.

fn get_skewchar(&self) -> Self::Int

Returns the \skewchar of this font.

fn set_skewchar(&mut self, c: Self::Int)

Sets the \skewchar of this font.

fn has_char(&self, c: Self::Char) -> bool

Returns whether this font has a glyph for the given Character.

fn display<W: Write>( &self, i: &<Self::CS as CSName<Self::Char>>::Handler, w: W, ) -> Result

Writes a human-readable representation of this font to the given std::fmt::Writer

• i.e. <name()>[ at <get_at()>]

fn get_wd(&self, c: Self::Char) -> Self::Dim

Returns the width the given Character in this font.

fn get_ht(&self, c: Self::Char) -> Self::Dim

Returns the height the given Character in this font.

fn get_dp(&self, c: Self::Char) -> Self::Dim

Returns the depth the given Character in this font.

fn get_ic(&self, c: Self::Char) -> Self::Dim

Returns the litalic correction of the given Character in this font.

fn set_ic(&mut self, c: Self::Char, d: Self::Dim)

Sets the litalic correction of the given Character in this font.

fn ligature(&self, c1: Self::Char, c2: Self::Char) -> Option<Self::Char>

Returns the ligature of the given Characters in this font, if any; e.g. most fonts combine - and - into an endash.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<I: TeXInt, D: TeXDimen + Numeric<I>, CS: CSName<u8>> Font for TfmFont<I, D, CS>

type Char = u8

type CS = CS

type Int = I

type Dim = D