read-fonts 0.46.0

Reading OpenType font files.
Documentation
// THIS FILE IS AUTOGENERATED.
// Any changes to this file will be overwritten.
// For more information about how codegen works, see font-codegen/README.md

#[allow(unused_imports)]
use crate::codegen_prelude::*;

impl<'a> MinByteRange<'a> for Vmtx<'a> {
    fn min_byte_range(&self) -> Range<usize> {
        0..self.top_side_bearings_byte_range().end
    }
    fn min_table_bytes(&self) -> &'a [u8] {
        let range = self.min_byte_range();
        self.offset_data().as_bytes().get(range).unwrap_or_default()
    }
}

impl TopLevelTable for Vmtx<'_> {
    /// `vmtx`
    const TAG: Tag = Tag::new(b"vmtx");
}

impl ReadArgs for Vmtx<'_> {
    type Args = u16;
}

impl<'a> FontRead<'a> for Vmtx<'a> {
    fn read_with_args(data: FontData<'a>, args: u16) -> Result<Self, ReadError> {
        let number_of_long_ver_metrics = args;

        #[allow(clippy::absurd_extreme_comparisons)]
        if data.len() < Self::MIN_SIZE {
            return Err(ReadError::OutOfBounds);
        }
        let Some(data) = TableDataRef::new(data.as_bytes()) else {
            return Err(ReadError::OutOfBounds);
        };
        Ok(Self {
            data,
            number_of_long_ver_metrics,
        })
    }
}

impl<'a> Vmtx<'a> {
    /// A constructor that requires additional arguments.
    ///
    /// This type requires some external state in order to be
    /// parsed.
    pub fn read(data: FontData<'a>, number_of_long_ver_metrics: u16) -> Result<Self, ReadError> {
        let args = number_of_long_ver_metrics;
        Self::read_with_args(data, args)
    }
}

/// The fields at the start of the table, which are read directly.
#[derive(Clone, Copy, bytemuck :: AnyBitPattern)]
#[repr(C, packed)]
#[doc(hidden)]
pub struct VmtxFixedHeader {}

#[allow(clippy::absurd_extreme_comparisons)]
const _: () = assert!(std::mem::size_of::<VmtxFixedHeader>() <= Vmtx::MIN_SIZE);

/// The [vmtx (Vertical Metrics)](https://docs.microsoft.com/en-us/typography/opentype/spec/vmtx) table
#[derive(Clone)]
pub struct Vmtx<'a> {
    data: TableDataRef<'a, VmtxFixedHeader>,
    number_of_long_ver_metrics: u16,
}

#[allow(clippy::needless_lifetimes)]
impl<'a> Vmtx<'a> {
    pub const MIN_SIZE: usize = 0;
    basic_table_impls!(impl_the_methods);

    /// Paired advance height and top side bearing values for each
    /// glyph. Records are indexed by glyph ID.
    pub fn v_metrics(&self) -> &'a [LongMetric] {
        let range = self.v_metrics_byte_range();
        self.offset_data()
            .read_array(range)
            .ok()
            .unwrap_or_default()
    }

    /// Top side bearings for glyph IDs greater than or equal to numberOfLongMetrics.
    pub fn top_side_bearings(&self) -> &'a [BigEndian<i16>] {
        let range = self.top_side_bearings_byte_range();
        self.offset_data()
            .read_array(range)
            .ok()
            .unwrap_or_default()
    }

    pub(crate) fn number_of_long_ver_metrics(&self) -> u16 {
        self.number_of_long_ver_metrics
    }

    pub fn v_metrics_byte_range(&self) -> Range<usize> {
        let number_of_long_ver_metrics = self.number_of_long_ver_metrics();
        let start = 0;
        let end = start
            + (transforms::to_usize(number_of_long_ver_metrics))
                .saturating_mul(LongMetric::RAW_BYTE_LEN);
        start..end
    }

    pub fn top_side_bearings_byte_range(&self) -> Range<usize> {
        let start = self.v_metrics_byte_range().end;
        let end = start
            + self.offset_data().len().saturating_sub(start) / i16::RAW_BYTE_LEN
                * i16::RAW_BYTE_LEN;
        start..end
    }
}

#[allow(clippy::absurd_extreme_comparisons)]
const _: () = assert!(FontData::default_data_long_enough(Vmtx::MIN_SIZE));

impl Default for Vmtx<'_> {
    fn default() -> Self {
        Self {
            data: TableDataRef::new(FontData::default_table_data().as_bytes())
                .unwrap_or_else(|| unreachable!("the default data covers MIN_SIZE")),
            number_of_long_ver_metrics: Default::default(),
        }
    }
}

impl<'a> MinByteRange<'a> for VmtxExtended<'a> {
    fn min_byte_range(&self) -> Range<usize> {
        0..self.top_side_bearings_byte_range().end
    }
    fn min_table_bytes(&self) -> &'a [u8] {
        let range = self.min_byte_range();
        self.offset_data().as_bytes().get(range).unwrap_or_default()
    }
}

impl TopLevelTable for VmtxExtended<'_> {
    /// `VMTX`
    const TAG: Tag = Tag::new(b"VMTX");
}

impl ReadArgs for VmtxExtended<'_> {
    type Args = u32;
}

impl<'a> FontRead<'a> for VmtxExtended<'a> {
    fn read_with_args(data: FontData<'a>, args: u32) -> Result<Self, ReadError> {
        let number_of_long_ver_metrics = args;

        #[allow(clippy::absurd_extreme_comparisons)]
        if data.len() < Self::MIN_SIZE {
            return Err(ReadError::OutOfBounds);
        }
        let Some(data) = TableDataRef::new(data.as_bytes()) else {
            return Err(ReadError::OutOfBounds);
        };
        Ok(Self {
            data,
            number_of_long_ver_metrics,
        })
    }
}

impl<'a> VmtxExtended<'a> {
    /// A constructor that requires additional arguments.
    ///
    /// This type requires some external state in order to be
    /// parsed.
    pub fn read(data: FontData<'a>, number_of_long_ver_metrics: u32) -> Result<Self, ReadError> {
        let args = number_of_long_ver_metrics;
        Self::read_with_args(data, args)
    }
}

/// The fields at the start of the table, which are read directly.
#[derive(Clone, Copy, bytemuck :: AnyBitPattern)]
#[repr(C, packed)]
#[doc(hidden)]
pub struct VmtxExtendedFixedHeader {}

#[allow(clippy::absurd_extreme_comparisons)]
const _: () = assert!(std::mem::size_of::<VmtxExtendedFixedHeader>() <= VmtxExtended::MIN_SIZE);

/// VMTX vertical metrics (ISO/IEC 14496-22:2026, 5.6.14).
#[derive(Clone)]
pub struct VmtxExtended<'a> {
    data: TableDataRef<'a, VmtxExtendedFixedHeader>,
    number_of_long_ver_metrics: u32,
}

#[allow(clippy::needless_lifetimes)]
impl<'a> VmtxExtended<'a> {
    pub const MIN_SIZE: usize = 0;
    basic_table_impls!(impl_the_methods);

    pub fn v_metrics(&self) -> &'a [LongMetric] {
        let range = self.v_metrics_byte_range();
        self.offset_data()
            .read_array(range)
            .ok()
            .unwrap_or_default()
    }

    pub fn top_side_bearings(&self) -> &'a [BigEndian<i16>] {
        let range = self.top_side_bearings_byte_range();
        self.offset_data()
            .read_array(range)
            .ok()
            .unwrap_or_default()
    }

    pub(crate) fn number_of_long_ver_metrics(&self) -> u32 {
        self.number_of_long_ver_metrics
    }

    pub fn v_metrics_byte_range(&self) -> Range<usize> {
        let number_of_long_ver_metrics = self.number_of_long_ver_metrics();
        let start = 0;
        let end = start
            + (transforms::to_usize(number_of_long_ver_metrics))
                .saturating_mul(LongMetric::RAW_BYTE_LEN);
        start..end
    }

    pub fn top_side_bearings_byte_range(&self) -> Range<usize> {
        let start = self.v_metrics_byte_range().end;
        let end = start
            + self.offset_data().len().saturating_sub(start) / i16::RAW_BYTE_LEN
                * i16::RAW_BYTE_LEN;
        start..end
    }
}

#[allow(clippy::absurd_extreme_comparisons)]
const _: () = assert!(FontData::default_data_long_enough(VmtxExtended::MIN_SIZE));

impl Default for VmtxExtended<'_> {
    fn default() -> Self {
        Self {
            data: TableDataRef::new(FontData::default_table_data().as_bytes())
                .unwrap_or_else(|| unreachable!("the default data covers MIN_SIZE")),
            number_of_long_ver_metrics: Default::default(),
        }
    }
}