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;
41}
42
43impl<'a> FontReadWithArgs<'a> for Vmtx<'a> {
44    fn read_with_args(data: FontData<'a>, args: &u16) -> Result<Self, ReadError> {
45        let number_of_long_ver_metrics = *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            cursor.remaining_bytes() / i16::RAW_BYTE_LEN * i16::RAW_BYTE_LEN;
53        cursor.advance_by(top_side_bearings_byte_len);
54        cursor.finish(VmtxMarker {
55            v_metrics_byte_len,
56            top_side_bearings_byte_len,
57        })
58    }
59}
60
61impl<'a> Vmtx<'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_long_ver_metrics: u16) -> Result<Self, ReadError> {
67        let args = number_of_long_ver_metrics;
68        Self::read_with_args(data, &args)
69    }
70}
71
72/// The [vmtx (Vertical Metrics)](https://docs.microsoft.com/en-us/typography/opentype/spec/vmtx) table
73pub type Vmtx<'a> = TableRef<'a, VmtxMarker>;
74
75#[allow(clippy::needless_lifetimes)]
76impl<'a> Vmtx<'a> {
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.shape.v_metrics_byte_range();
81        self.data.read_array(range).unwrap()
82    }
83
84    /// Top side bearings for glyph IDs greater than or equal to numberOfLongMetrics.
85    pub fn top_side_bearings(&self) -> &'a [BigEndian<i16>] {
86        let range = self.shape.top_side_bearings_byte_range();
87        self.data.read_array(range).unwrap()
88    }
89}
90
91#[cfg(feature = "experimental_traverse")]
92impl<'a> SomeTable<'a> for Vmtx<'a> {
93    fn type_name(&self) -> &str {
94        "Vmtx"
95    }
96    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
97        match idx {
98            0usize => Some(Field::new(
99                "v_metrics",
100                traversal::FieldType::array_of_records(
101                    stringify!(LongMetric),
102                    self.v_metrics(),
103                    self.offset_data(),
104                ),
105            )),
106            1usize => Some(Field::new("top_side_bearings", self.top_side_bearings())),
107            _ => None,
108        }
109    }
110}
111
112#[cfg(feature = "experimental_traverse")]
113#[allow(clippy::needless_lifetimes)]
114impl<'a> std::fmt::Debug for Vmtx<'a> {
115    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
116        (self as &dyn SomeTable<'a>).fmt(f)
117    }
118}
read_fonts/generated/generated_vmtx.rs

read_fonts/generated/
generated_vmtx.rs
