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

read_fonts/generated/
generated_hmtx.rs
