read_fonts/generated/
generated_vhea.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 Vhea<'a> {
9    fn min_byte_range(&self) -> Range<usize> {
10        0..self.number_of_long_ver_metrics_byte_range().end
11    }
12    fn min_table_bytes(&self) -> &'a [u8] {
13        let range = self.min_byte_range();
14        self.data.as_bytes().get(range).unwrap_or_default()
15    }
16}
17
18impl TopLevelTable for Vhea<'_> {
19    /// `vhea`
20    const TAG: Tag = Tag::new(b"vhea");
21}
22
23impl<'a> FontRead<'a> for Vhea<'a> {
24    fn read(data: FontData<'a>) -> Result<Self, ReadError> {
25        #[allow(clippy::absurd_extreme_comparisons)]
26        if data.len() < Self::MIN_SIZE {
27            return Err(ReadError::OutOfBounds);
28        }
29        Ok(Self { data })
30    }
31}
32
33/// The [vhea](https://docs.microsoft.com/en-us/typography/opentype/spec/vhea) Vertical Header Table
34#[derive(Clone)]
35pub struct Vhea<'a> {
36    data: FontData<'a>,
37}
38
39#[allow(clippy::needless_lifetimes)]
40impl<'a> Vhea<'a> {
41    pub const MIN_SIZE: usize = (Version16Dot16::RAW_BYTE_LEN
42        + FWord::RAW_BYTE_LEN
43        + FWord::RAW_BYTE_LEN
44        + FWord::RAW_BYTE_LEN
45        + UfWord::RAW_BYTE_LEN
46        + FWord::RAW_BYTE_LEN
47        + FWord::RAW_BYTE_LEN
48        + FWord::RAW_BYTE_LEN
49        + i16::RAW_BYTE_LEN
50        + i16::RAW_BYTE_LEN
51        + i16::RAW_BYTE_LEN
52        + i16::RAW_BYTE_LEN
53        + i16::RAW_BYTE_LEN
54        + i16::RAW_BYTE_LEN
55        + i16::RAW_BYTE_LEN
56        + i16::RAW_BYTE_LEN
57        + u16::RAW_BYTE_LEN);
58    basic_table_impls!(impl_the_methods);
59
60    /// The major/minor version (1, 1)
61    pub fn version(&self) -> Version16Dot16 {
62        let range = self.version_byte_range();
63        self.data.read_at(range.start).ok().unwrap()
64    }
65
66    /// Typographic ascent.
67    pub fn ascender(&self) -> FWord {
68        let range = self.ascender_byte_range();
69        self.data.read_at(range.start).ok().unwrap()
70    }
71
72    /// Typographic descent.
73    pub fn descender(&self) -> FWord {
74        let range = self.descender_byte_range();
75        self.data.read_at(range.start).ok().unwrap()
76    }
77
78    /// Typographic line gap. Negative LineGap values are treated as
79    /// zero in some legacy platform implementations.
80    pub fn line_gap(&self) -> FWord {
81        let range = self.line_gap_byte_range();
82        self.data.read_at(range.start).ok().unwrap()
83    }
84
85    /// Maximum advance height value in 'vmtx' table.
86    pub fn advance_height_max(&self) -> UfWord {
87        let range = self.advance_height_max_byte_range();
88        self.data.read_at(range.start).ok().unwrap()
89    }
90
91    /// Minimum top sidebearing value in 'vmtx' table for glyphs with
92    /// contours (empty glyphs should be ignored).
93    pub fn min_top_side_bearing(&self) -> FWord {
94        let range = self.min_top_side_bearing_byte_range();
95        self.data.read_at(range.start).ok().unwrap()
96    }
97
98    /// Minimum bottom sidebearing value
99    pub fn min_bottom_side_bearing(&self) -> FWord {
100        let range = self.min_bottom_side_bearing_byte_range();
101        self.data.read_at(range.start).ok().unwrap()
102    }
103
104    /// Defined as max( tsb + (yMax-yMin)).
105    pub fn y_max_extent(&self) -> FWord {
106        let range = self.y_max_extent_byte_range();
107        self.data.read_at(range.start).ok().unwrap()
108    }
109
110    /// Used to calculate the slope of the cursor (rise/run); 1 for
111    /// vertical caret, 0 for horizontal.
112    pub fn caret_slope_rise(&self) -> i16 {
113        let range = self.caret_slope_rise_byte_range();
114        self.data.read_at(range.start).ok().unwrap()
115    }
116
117    /// 0 for vertical caret, 1 for horizontal.
118    pub fn caret_slope_run(&self) -> i16 {
119        let range = self.caret_slope_run_byte_range();
120        self.data.read_at(range.start).ok().unwrap()
121    }
122
123    /// The amount by which a slanted highlight on a glyph needs to be
124    /// shifted to produce the best appearance. Set to 0 for
125    /// non-slanted fonts
126    pub fn caret_offset(&self) -> i16 {
127        let range = self.caret_offset_byte_range();
128        self.data.read_at(range.start).ok().unwrap()
129    }
130
131    /// 0 for current format.
132    pub fn metric_data_format(&self) -> i16 {
133        let range = self.metric_data_format_byte_range();
134        self.data.read_at(range.start).ok().unwrap()
135    }
136
137    /// Number of advance heights in the vertical metrics (`vmtx`) table.
138    pub fn number_of_long_ver_metrics(&self) -> u16 {
139        let range = self.number_of_long_ver_metrics_byte_range();
140        self.data.read_at(range.start).ok().unwrap()
141    }
142
143    pub fn version_byte_range(&self) -> Range<usize> {
144        let start = 0;
145        let end = start + Version16Dot16::RAW_BYTE_LEN;
146        start..end
147    }
148
149    pub fn ascender_byte_range(&self) -> Range<usize> {
150        let start = self.version_byte_range().end;
151        let end = start + FWord::RAW_BYTE_LEN;
152        start..end
153    }
154
155    pub fn descender_byte_range(&self) -> Range<usize> {
156        let start = self.ascender_byte_range().end;
157        let end = start + FWord::RAW_BYTE_LEN;
158        start..end
159    }
160
161    pub fn line_gap_byte_range(&self) -> Range<usize> {
162        let start = self.descender_byte_range().end;
163        let end = start + FWord::RAW_BYTE_LEN;
164        start..end
165    }
166
167    pub fn advance_height_max_byte_range(&self) -> Range<usize> {
168        let start = self.line_gap_byte_range().end;
169        let end = start + UfWord::RAW_BYTE_LEN;
170        start..end
171    }
172
173    pub fn min_top_side_bearing_byte_range(&self) -> Range<usize> {
174        let start = self.advance_height_max_byte_range().end;
175        let end = start + FWord::RAW_BYTE_LEN;
176        start..end
177    }
178
179    pub fn min_bottom_side_bearing_byte_range(&self) -> Range<usize> {
180        let start = self.min_top_side_bearing_byte_range().end;
181        let end = start + FWord::RAW_BYTE_LEN;
182        start..end
183    }
184
185    pub fn y_max_extent_byte_range(&self) -> Range<usize> {
186        let start = self.min_bottom_side_bearing_byte_range().end;
187        let end = start + FWord::RAW_BYTE_LEN;
188        start..end
189    }
190
191    pub fn caret_slope_rise_byte_range(&self) -> Range<usize> {
192        let start = self.y_max_extent_byte_range().end;
193        let end = start + i16::RAW_BYTE_LEN;
194        start..end
195    }
196
197    pub fn caret_slope_run_byte_range(&self) -> Range<usize> {
198        let start = self.caret_slope_rise_byte_range().end;
199        let end = start + i16::RAW_BYTE_LEN;
200        start..end
201    }
202
203    pub fn caret_offset_byte_range(&self) -> Range<usize> {
204        let start = self.caret_slope_run_byte_range().end;
205        let end = start + i16::RAW_BYTE_LEN;
206        start..end
207    }
208
209    pub fn reserved1_byte_range(&self) -> Range<usize> {
210        let start = self.caret_offset_byte_range().end;
211        let end = start + i16::RAW_BYTE_LEN;
212        start..end
213    }
214
215    pub fn reserved2_byte_range(&self) -> Range<usize> {
216        let start = self.reserved1_byte_range().end;
217        let end = start + i16::RAW_BYTE_LEN;
218        start..end
219    }
220
221    pub fn reserved3_byte_range(&self) -> Range<usize> {
222        let start = self.reserved2_byte_range().end;
223        let end = start + i16::RAW_BYTE_LEN;
224        start..end
225    }
226
227    pub fn reserved4_byte_range(&self) -> Range<usize> {
228        let start = self.reserved3_byte_range().end;
229        let end = start + i16::RAW_BYTE_LEN;
230        start..end
231    }
232
233    pub fn metric_data_format_byte_range(&self) -> Range<usize> {
234        let start = self.reserved4_byte_range().end;
235        let end = start + i16::RAW_BYTE_LEN;
236        start..end
237    }
238
239    pub fn number_of_long_ver_metrics_byte_range(&self) -> Range<usize> {
240        let start = self.metric_data_format_byte_range().end;
241        let end = start + u16::RAW_BYTE_LEN;
242        start..end
243    }
244}
245
246const _: () = assert!(FontData::default_data_long_enough(Vhea::MIN_SIZE));
247
248impl Default for Vhea<'_> {
249    fn default() -> Self {
250        Self {
251            data: FontData::default_table_data(),
252        }
253    }
254}
255
256#[cfg(feature = "experimental_traverse")]
257impl<'a> SomeTable<'a> for Vhea<'a> {
258    fn type_name(&self) -> &str {
259        "Vhea"
260    }
261    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
262        match idx {
263            0usize => Some(Field::new("version", self.version())),
264            1usize => Some(Field::new("ascender", self.ascender())),
265            2usize => Some(Field::new("descender", self.descender())),
266            3usize => Some(Field::new("line_gap", self.line_gap())),
267            4usize => Some(Field::new("advance_height_max", self.advance_height_max())),
268            5usize => Some(Field::new(
269                "min_top_side_bearing",
270                self.min_top_side_bearing(),
271            )),
272            6usize => Some(Field::new(
273                "min_bottom_side_bearing",
274                self.min_bottom_side_bearing(),
275            )),
276            7usize => Some(Field::new("y_max_extent", self.y_max_extent())),
277            8usize => Some(Field::new("caret_slope_rise", self.caret_slope_rise())),
278            9usize => Some(Field::new("caret_slope_run", self.caret_slope_run())),
279            10usize => Some(Field::new("caret_offset", self.caret_offset())),
280            11usize => Some(Field::new("metric_data_format", self.metric_data_format())),
281            12usize => Some(Field::new(
282                "number_of_long_ver_metrics",
283                self.number_of_long_ver_metrics(),
284            )),
285            _ => None,
286        }
287    }
288}
289
290#[cfg(feature = "experimental_traverse")]
291#[allow(clippy::needless_lifetimes)]
292impl<'a> std::fmt::Debug for Vhea<'a> {
293    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
294        (self as &dyn SomeTable<'a>).fmt(f)
295    }
296}
read_fonts/generated/generated_vhea.rs

read_fonts/generated/
generated_vhea.rs
