Struct tfm::File

pub struct File {

    pub header: Header,
    pub smallest_char: Char,
    pub char_dimens: BTreeMap<Char, CharDimensions>,
    pub char_tags: BTreeMap<Char, CharTag>,
    pub unset_char_tags: BTreeMap<Char, u8>,
    pub widths: Vec<FixWord>,
    pub heights: Vec<FixWord>,
    pub depths: Vec<FixWord>,
    pub italic_corrections: Vec<FixWord>,
    pub lig_kern_program: Program,
    pub kerns: Vec<FixWord>,
    pub extensible_chars: Vec<ExtensibleRecipe>,
    pub params: Vec<FixWord>,
}

Complete contents of a TeX font metric (.tfm) file.

The struct contain multiple vectors. In TeX and TFtoPL there is an optimization in which all of data in the vectors is stored in one large vector of 32-bit integers. The conversion from u32 to the specific types like FixWord are then done when the data is needed. This makes the memory footprint of this type much more compact, and such a change may be considered in the future.

In fact in TeX the font data for all fonts is stored in one contiguous piece of memory (font_info, defined in TeX82.2021.549). This is a little too unsafe to pull off though.

Fields

header: Header

Header.

smallest_char: Char

Smallest character in the .tfm.

char_dimens: BTreeMap<Char, CharDimensions>

Character dimensions.

char_tags: BTreeMap<Char, CharTag>

Character tags.

Note there is no correlation between a character having a tag and a character having a dimension. All four combinations of (has or hasn’t dimensions) and (has or hasn’t a tag) are possible.

unset_char_tags: BTreeMap<Char, u8>

Tags that have been unset, but whose discriminant is still written to a .tfm file by PLtoTF.

widths: Vec<FixWord>

Character widths

heights: Vec<FixWord>

Character heights

depths: Vec<FixWord>

Character depths

italic_corrections: Vec<FixWord>

Character italic corrections

lig_kern_program: Program

Lig kern program.

kerns: Vec<FixWord>

Kerns. These are referenced from inside the lig kern commands.

extensible_chars: Vec<ExtensibleRecipe>

Extensible characters.

params: Vec<FixWord>

Font parameters.

Implementations

impl File

pub fn from_raw_file(raw_file: &RawFile<'_>) -> Self

pub fn validate_and_fix(&mut self) -> Vec<ValidationWarning>

pub fn deserialize( b: &[u8], ) -> (Result<File, DeserializationError>, Vec<DeserializationWarning>)

pub fn serialize(&self) -> Vec<u8>

pub fn lig_kern_entrypoints(&self) -> HashMap<Char, u8>

Return a map from characters to the lig/kern entrypoint for that character. TODO: can probably return impl Iterator<Item=(Char, u8)>

pub fn checksum(&self) -> u32

Calculate the checksum of this .tfm file.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Default for File

fn default() -> Self

Returns the “default value” for a type.

impl FontFormat for File

const DEFAULT_FILE_EXTENSION: &'static str = "tfm"

type Error = DeserializationError

fn parse(b: &[u8]) -> Result<Self, Self::Error>

Parse binary data into a font.

impl From<File> for File

fn from(tfm_file: File) -> Self

Converts to this type from the input type.

impl From<File> for File

fn from(pl_file: File) -> Self

Converts to this type from the input type.

impl PartialEq for File

fn eq(&self, other: &File) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for File

impl StructuralPartialEq for File