Skip to main content

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
8impl<'a> MinByteRange<'a> for Vmtx<'a> {
9    fn min_byte_range(&self) -> Range<usize> {
10        0..self.top_side_bearings_byte_range().end
11    }
12    fn min_table_bytes(&self) -> &'a [u8] {
13        let range = self.min_byte_range();
14        self.offset_data().as_bytes().get(range).unwrap_or_default()
15    }
16}
17
18impl TopLevelTable for Vmtx<'_> {
19    /// `vmtx`
20    const TAG: Tag = Tag::new(b"vmtx");
21}
22
23impl ReadArgs for Vmtx<'_> {
24    type Args = u16;
25}
26
27impl<'a> FontRead<'a> for Vmtx<'a> {
28    fn read_with_args(data: FontData<'a>, args: u16) -> Result<Self, ReadError> {
29        let number_of_long_ver_metrics = args;
30
31        #[allow(clippy::absurd_extreme_comparisons)]
32        if data.len() < Self::MIN_SIZE {
33            return Err(ReadError::OutOfBounds);
34        }
35        let Some(data) = TableDataRef::new(data.as_bytes()) else {
36            return Err(ReadError::OutOfBounds);
37        };
38        Ok(Self {
39            data,
40            number_of_long_ver_metrics,
41        })
42    }
43}
44
45impl<'a> Vmtx<'a> {
46    /// A constructor that requires additional arguments.
47    ///
48    /// This type requires some external state in order to be
49    /// parsed.
50    pub fn read(data: FontData<'a>, number_of_long_ver_metrics: u16) -> Result<Self, ReadError> {
51        let args = number_of_long_ver_metrics;
52        Self::read_with_args(data, args)
53    }
54}
55
56/// The fields at the start of the table, which are read directly.
57#[derive(Clone, Copy, bytemuck :: AnyBitPattern)]
58#[repr(C, packed)]
59#[doc(hidden)]
60pub struct VmtxFixedHeader {}
61
62#[allow(clippy::absurd_extreme_comparisons)]
63const _: () = assert!(std::mem::size_of::<VmtxFixedHeader>() <= Vmtx::MIN_SIZE);
64
65/// The [vmtx (Vertical Metrics)](https://docs.microsoft.com/en-us/typography/opentype/spec/vmtx) table
66#[derive(Clone)]
67pub struct Vmtx<'a> {
68    data: TableDataRef<'a, VmtxFixedHeader>,
69    number_of_long_ver_metrics: u16,
70}
71
72#[allow(clippy::needless_lifetimes)]
73impl<'a> Vmtx<'a> {
74    pub const MIN_SIZE: usize = 0;
75    basic_table_impls!(impl_the_methods);
76
77    /// Paired advance height and top side bearing values for each
78    /// glyph. Records are indexed by glyph ID.
79    pub fn v_metrics(&self) -> &'a [LongMetric] {
80        let range = self.v_metrics_byte_range();
81        self.offset_data()
82            .read_array(range)
83            .ok()
84            .unwrap_or_default()
85    }
86
87    /// Top side bearings for glyph IDs greater than or equal to numberOfLongMetrics.
88    pub fn top_side_bearings(&self) -> &'a [BigEndian<i16>] {
89        let range = self.top_side_bearings_byte_range();
90        self.offset_data()
91            .read_array(range)
92            .ok()
93            .unwrap_or_default()
94    }
95
96    pub(crate) fn number_of_long_ver_metrics(&self) -> u16 {
97        self.number_of_long_ver_metrics
98    }
99
100    pub fn v_metrics_byte_range(&self) -> Range<usize> {
101        let number_of_long_ver_metrics = self.number_of_long_ver_metrics();
102        let start = 0;
103        let end = start
104            + (transforms::to_usize(number_of_long_ver_metrics))
105                .saturating_mul(LongMetric::RAW_BYTE_LEN);
106        start..end
107    }
108
109    pub fn top_side_bearings_byte_range(&self) -> Range<usize> {
110        let start = self.v_metrics_byte_range().end;
111        let end = start
112            + self.offset_data().len().saturating_sub(start) / i16::RAW_BYTE_LEN
113                * i16::RAW_BYTE_LEN;
114        start..end
115    }
116}
117
118#[allow(clippy::absurd_extreme_comparisons)]
119const _: () = assert!(FontData::default_data_long_enough(Vmtx::MIN_SIZE));
120
121impl Default for Vmtx<'_> {
122    fn default() -> Self {
123        Self {
124            data: TableDataRef::new(FontData::default_table_data().as_bytes())
125                .unwrap_or_else(|| unreachable!("the default data covers MIN_SIZE")),
126            number_of_long_ver_metrics: Default::default(),
127        }
128    }
129}
130
131impl<'a> MinByteRange<'a> for VmtxExtended<'a> {
132    fn min_byte_range(&self) -> Range<usize> {
133        0..self.top_side_bearings_byte_range().end
134    }
135    fn min_table_bytes(&self) -> &'a [u8] {
136        let range = self.min_byte_range();
137        self.offset_data().as_bytes().get(range).unwrap_or_default()
138    }
139}
140
141impl TopLevelTable for VmtxExtended<'_> {
142    /// `VMTX`
143    const TAG: Tag = Tag::new(b"VMTX");
144}
145
146impl ReadArgs for VmtxExtended<'_> {
147    type Args = u32;
148}
149
150impl<'a> FontRead<'a> for VmtxExtended<'a> {
151    fn read_with_args(data: FontData<'a>, args: u32) -> Result<Self, ReadError> {
152        let number_of_long_ver_metrics = args;
153
154        #[allow(clippy::absurd_extreme_comparisons)]
155        if data.len() < Self::MIN_SIZE {
156            return Err(ReadError::OutOfBounds);
157        }
158        let Some(data) = TableDataRef::new(data.as_bytes()) else {
159            return Err(ReadError::OutOfBounds);
160        };
161        Ok(Self {
162            data,
163            number_of_long_ver_metrics,
164        })
165    }
166}
167
168impl<'a> VmtxExtended<'a> {
169    /// A constructor that requires additional arguments.
170    ///
171    /// This type requires some external state in order to be
172    /// parsed.
173    pub fn read(data: FontData<'a>, number_of_long_ver_metrics: u32) -> Result<Self, ReadError> {
174        let args = number_of_long_ver_metrics;
175        Self::read_with_args(data, args)
176    }
177}
178
179/// The fields at the start of the table, which are read directly.
180#[derive(Clone, Copy, bytemuck :: AnyBitPattern)]
181#[repr(C, packed)]
182#[doc(hidden)]
183pub struct VmtxExtendedFixedHeader {}
184
185#[allow(clippy::absurd_extreme_comparisons)]
186const _: () = assert!(std::mem::size_of::<VmtxExtendedFixedHeader>() <= VmtxExtended::MIN_SIZE);
187
188/// VMTX vertical metrics (ISO/IEC 14496-22:2026, 5.6.14).
189#[derive(Clone)]
190pub struct VmtxExtended<'a> {
191    data: TableDataRef<'a, VmtxExtendedFixedHeader>,
192    number_of_long_ver_metrics: u32,
193}
194
195#[allow(clippy::needless_lifetimes)]
196impl<'a> VmtxExtended<'a> {
197    pub const MIN_SIZE: usize = 0;
198    basic_table_impls!(impl_the_methods);
199
200    pub fn v_metrics(&self) -> &'a [LongMetric] {
201        let range = self.v_metrics_byte_range();
202        self.offset_data()
203            .read_array(range)
204            .ok()
205            .unwrap_or_default()
206    }
207
208    pub fn top_side_bearings(&self) -> &'a [BigEndian<i16>] {
209        let range = self.top_side_bearings_byte_range();
210        self.offset_data()
211            .read_array(range)
212            .ok()
213            .unwrap_or_default()
214    }
215
216    pub(crate) fn number_of_long_ver_metrics(&self) -> u32 {
217        self.number_of_long_ver_metrics
218    }
219
220    pub fn v_metrics_byte_range(&self) -> Range<usize> {
221        let number_of_long_ver_metrics = self.number_of_long_ver_metrics();
222        let start = 0;
223        let end = start
224            + (transforms::to_usize(number_of_long_ver_metrics))
225                .saturating_mul(LongMetric::RAW_BYTE_LEN);
226        start..end
227    }
228
229    pub fn top_side_bearings_byte_range(&self) -> Range<usize> {
230        let start = self.v_metrics_byte_range().end;
231        let end = start
232            + self.offset_data().len().saturating_sub(start) / i16::RAW_BYTE_LEN
233                * i16::RAW_BYTE_LEN;
234        start..end
235    }
236}
237
238#[allow(clippy::absurd_extreme_comparisons)]
239const _: () = assert!(FontData::default_data_long_enough(VmtxExtended::MIN_SIZE));
240
241impl Default for VmtxExtended<'_> {
242    fn default() -> Self {
243        Self {
244            data: TableDataRef::new(FontData::default_table_data().as_bytes())
245                .unwrap_or_else(|| unreachable!("the default data covers MIN_SIZE")),
246            number_of_long_ver_metrics: Default::default(),
247        }
248    }
249}