read_fonts/generated/
generated_hmtx.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 [hmtx (Horizontal Metrics)](https://docs.microsoft.com/en-us/typography/opentype/spec/hmtx) table
9#[derive(Debug, Clone, Copy)]
10#[doc(hidden)]
11pub struct HmtxMarker {
12    h_metrics_byte_len: usize,
13    left_side_bearings_byte_len: usize,
14}
15
16impl HmtxMarker {
17    pub fn h_metrics_byte_range(&self) -> Range<usize> {
18        let start = 0;
19        start..start + self.h_metrics_byte_len
20    }
21
22    pub fn left_side_bearings_byte_range(&self) -> Range<usize> {
23        let start = self.h_metrics_byte_range().end;
24        start..start + self.left_side_bearings_byte_len
25    }
26}
27
28impl MinByteRange for HmtxMarker {
29    fn min_byte_range(&self) -> Range<usize> {
30        0..self.left_side_bearings_byte_range().end
31    }
32}
33
34impl TopLevelTable for Hmtx<'_> {
35    /// `hmtx`
36    const TAG: Tag = Tag::new(b"hmtx");
37}
38
39impl ReadArgs for Hmtx<'_> {
40    type Args = (u16, u16);
41}
42
43impl<'a> FontReadWithArgs<'a> for Hmtx<'a> {
44    fn read_with_args(data: FontData<'a>, args: &(u16, u16)) -> Result<Self, ReadError> {
45        let (number_of_h_metrics, num_glyphs) = *args;
46        let mut cursor = data.cursor();
47        let h_metrics_byte_len = (number_of_h_metrics as usize)
48            .checked_mul(LongMetric::RAW_BYTE_LEN)
49            .ok_or(ReadError::OutOfBounds)?;
50        cursor.advance_by(h_metrics_byte_len);
51        let left_side_bearings_byte_len = (transforms::subtract(num_glyphs, number_of_h_metrics))
52            .checked_mul(i16::RAW_BYTE_LEN)
53            .ok_or(ReadError::OutOfBounds)?;
54        cursor.advance_by(left_side_bearings_byte_len);
55        cursor.finish(HmtxMarker {
56            h_metrics_byte_len,
57            left_side_bearings_byte_len,
58        })
59    }
60}
61
62impl<'a> Hmtx<'a> {
63    /// A constructor that requires additional arguments.
64    ///
65    /// This type requires some external state in order to be
66    /// parsed.
67    pub fn read(
68        data: FontData<'a>,
69        number_of_h_metrics: u16,
70        num_glyphs: u16,
71    ) -> Result<Self, ReadError> {
72        let args = (number_of_h_metrics, num_glyphs);
73        Self::read_with_args(data, &args)
74    }
75}
76
77/// The [hmtx (Horizontal Metrics)](https://docs.microsoft.com/en-us/typography/opentype/spec/hmtx) table
78pub type Hmtx<'a> = TableRef<'a, HmtxMarker>;
79
80#[allow(clippy::needless_lifetimes)]
81impl<'a> Hmtx<'a> {
82    /// Paired advance width/height and left/top side bearing values for each
83    /// glyph. Records are indexed by glyph ID.
84    pub fn h_metrics(&self) -> &'a [LongMetric] {
85        let range = self.shape.h_metrics_byte_range();
86        self.data.read_array(range).unwrap()
87    }
88
89    /// Leading (left/top) side bearings for glyph IDs greater than or equal to
90    /// numberOfLongMetrics.
91    pub fn left_side_bearings(&self) -> &'a [BigEndian<i16>] {
92        let range = self.shape.left_side_bearings_byte_range();
93        self.data.read_array(range).unwrap()
94    }
95}
96
97#[cfg(feature = "experimental_traverse")]
98impl<'a> SomeTable<'a> for Hmtx<'a> {
99    fn type_name(&self) -> &str {
100        "Hmtx"
101    }
102    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
103        match idx {
104            0usize => Some(Field::new(
105                "h_metrics",
106                traversal::FieldType::array_of_records(
107                    stringify!(LongMetric),
108                    self.h_metrics(),
109                    self.offset_data(),
110                ),
111            )),
112            1usize => Some(Field::new("left_side_bearings", self.left_side_bearings())),
113            _ => None,
114        }
115    }
116}
117
118#[cfg(feature = "experimental_traverse")]
119#[allow(clippy::needless_lifetimes)]
120impl<'a> std::fmt::Debug for Hmtx<'a> {
121    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
122        (self as &dyn SomeTable<'a>).fmt(f)
123    }
124}
125
126#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, bytemuck :: AnyBitPattern)]
127#[repr(C)]
128#[repr(packed)]
129pub struct LongMetric {
130    /// Advance width/height, in font design units.
131    pub advance: BigEndian<u16>,
132    /// Glyph leading (left/top) side bearing, in font design units.
133    pub side_bearing: BigEndian<i16>,
134}
135
136impl LongMetric {
137    /// Advance width/height, in font design units.
138    pub fn advance(&self) -> u16 {
139        self.advance.get()
140    }
141
142    /// Glyph leading (left/top) side bearing, in font design units.
143    pub fn side_bearing(&self) -> i16 {
144        self.side_bearing.get()
145    }
146}
147
148impl FixedSize for LongMetric {
149    const RAW_BYTE_LEN: usize = u16::RAW_BYTE_LEN + i16::RAW_BYTE_LEN;
150}
151
152#[cfg(feature = "experimental_traverse")]
153impl<'a> SomeRecord<'a> for LongMetric {
154    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
155        RecordResolver {
156            name: "LongMetric",
157            get_field: Box::new(move |idx, _data| match idx {
158                0usize => Some(Field::new("advance", self.advance())),
159                1usize => Some(Field::new("side_bearing", self.side_bearing())),
160                _ => None,
161            }),
162            data,
163        }
164    }
165}
read_fonts/generated/generated_hmtx.rs

read_fonts/generated/
generated_hmtx.rs
