read_fonts/generated/
generated_vmtx.rs

1// THIS FILE IS AUTOGENERATED.
2// Any changes to this file will be overwritten.
3// For more information about how codegen works, see font-codegen/README.md
4
5#[allow(unused_imports)]
6use crate::codegen_prelude::*;
7
8/// The [vmtx (Vertical Metrics)](https://docs.microsoft.com/en-us/typography/opentype/spec/vmtx) table
9#[derive(Debug, Clone, Copy)]
10#[doc(hidden)]
11pub struct VmtxMarker {
12    v_metrics_byte_len: usize,
13    top_side_bearings_byte_len: usize,
14}
15
16impl VmtxMarker {
17    pub fn v_metrics_byte_range(&self) -> Range<usize> {
18        let start = 0;
19        start..start + self.v_metrics_byte_len
20    }
21
22    pub fn top_side_bearings_byte_range(&self) -> Range<usize> {
23        let start = self.v_metrics_byte_range().end;
24        start..start + self.top_side_bearings_byte_len
25    }
26}
27
28impl MinByteRange for VmtxMarker {
29    fn min_byte_range(&self) -> Range<usize> {
30        0..self.top_side_bearings_byte_range().end
31    }
32}
33
34impl TopLevelTable for Vmtx<'_> {
35    /// `vmtx`
36    const TAG: Tag = Tag::new(b"vmtx");
37}
38
39impl ReadArgs for Vmtx<'_> {
40    type Args = (u16, u16);
41}
42
43impl<'a> FontReadWithArgs<'a> for Vmtx<'a> {
44    fn read_with_args(data: FontData<'a>, args: &(u16, u16)) -> Result<Self, ReadError> {
45        let (number_of_long_ver_metrics, num_glyphs) = *args;
46        let mut cursor = data.cursor();
47        let v_metrics_byte_len = (number_of_long_ver_metrics as usize)
48            .checked_mul(LongMetric::RAW_BYTE_LEN)
49            .ok_or(ReadError::OutOfBounds)?;
50        cursor.advance_by(v_metrics_byte_len);
51        let top_side_bearings_byte_len =
52            (transforms::subtract(num_glyphs, number_of_long_ver_metrics))
53                .checked_mul(i16::RAW_BYTE_LEN)
54                .ok_or(ReadError::OutOfBounds)?;
55        cursor.advance_by(top_side_bearings_byte_len);
56        cursor.finish(VmtxMarker {
57            v_metrics_byte_len,
58            top_side_bearings_byte_len,
59        })
60    }
61}
62
63impl<'a> Vmtx<'a> {
64    /// A constructor that requires additional arguments.
65    ///
66    /// This type requires some external state in order to be
67    /// parsed.
68    pub fn read(
69        data: FontData<'a>,
70        number_of_long_ver_metrics: u16,
71        num_glyphs: u16,
72    ) -> Result<Self, ReadError> {
73        let args = (number_of_long_ver_metrics, num_glyphs);
74        Self::read_with_args(data, &args)
75    }
76}
77
78/// The [vmtx (Vertical Metrics)](https://docs.microsoft.com/en-us/typography/opentype/spec/vmtx) table
79pub type Vmtx<'a> = TableRef<'a, VmtxMarker>;
80
81#[allow(clippy::needless_lifetimes)]
82impl<'a> Vmtx<'a> {
83    /// Paired advance height and top side bearing values for each
84    /// glyph. Records are indexed by glyph ID.
85    pub fn v_metrics(&self) -> &'a [LongMetric] {
86        let range = self.shape.v_metrics_byte_range();
87        self.data.read_array(range).unwrap()
88    }
89
90    /// Top side bearings for glyph IDs greater than or equal to numberOfLongMetrics.
91    pub fn top_side_bearings(&self) -> &'a [BigEndian<i16>] {
92        let range = self.shape.top_side_bearings_byte_range();
93        self.data.read_array(range).unwrap()
94    }
95}
96
97#[cfg(feature = "experimental_traverse")]
98impl<'a> SomeTable<'a> for Vmtx<'a> {
99    fn type_name(&self) -> &str {
100        "Vmtx"
101    }
102    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
103        match idx {
104            0usize => Some(Field::new(
105                "v_metrics",
106                traversal::FieldType::array_of_records(
107                    stringify!(LongMetric),
108                    self.v_metrics(),
109                    self.offset_data(),
110                ),
111            )),
112            1usize => Some(Field::new("top_side_bearings", self.top_side_bearings())),
113            _ => None,
114        }
115    }
116}
117
118#[cfg(feature = "experimental_traverse")]
119#[allow(clippy::needless_lifetimes)]
120impl<'a> std::fmt::Debug for Vmtx<'a> {
121    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
122        (self as &dyn SomeTable<'a>).fmt(f)
123    }
124}
read_fonts/generated/generated_vmtx.rs

read_fonts/generated/
generated_vmtx.rs
