read_fonts/generated/
generated_vorg.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 Vorg<'a> {
9    fn min_byte_range(&self) -> Range<usize> {
10        0..self.vert_origin_y_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 Vorg<'_> {
19    /// `VORG`
20    const TAG: Tag = Tag::new(b"VORG");
21}
22
23impl<'a> FontRead<'a> for Vorg<'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 [VORG (Vertical Origin)](https://docs.microsoft.com/en-us/typography/opentype/spec/vorg) table.
34#[derive(Clone)]
35pub struct Vorg<'a> {
36    data: FontData<'a>,
37}
38
39#[allow(clippy::needless_lifetimes)]
40impl<'a> Vorg<'a> {
41    pub const MIN_SIZE: usize = (MajorMinor::RAW_BYTE_LEN + i16::RAW_BYTE_LEN + u16::RAW_BYTE_LEN);
42    basic_table_impls!(impl_the_methods);
43
44    /// Major/minor version number. Set to 1.0.
45    pub fn version(&self) -> MajorMinor {
46        let range = self.version_byte_range();
47        self.data.read_at(range.start).ok().unwrap()
48    }
49
50    /// The y coordinate of a glyph’s vertical origin, in the font’s design
51    /// coordinate system, to be used if no entry is present for the glyph
52    /// in the vertOriginYMetrics array.
53    pub fn default_vert_origin_y(&self) -> i16 {
54        let range = self.default_vert_origin_y_byte_range();
55        self.data.read_at(range.start).ok().unwrap()
56    }
57
58    /// Number of elements in the vertOriginYMetrics array.
59    pub fn num_vert_origin_y_metrics(&self) -> u16 {
60        let range = self.num_vert_origin_y_metrics_byte_range();
61        self.data.read_at(range.start).ok().unwrap()
62    }
63
64    /// Array of VertOriginYMetrics records, sorted by glyph ID.
65    pub fn vert_origin_y_metrics(&self) -> &'a [VertOriginYMetrics] {
66        let range = self.vert_origin_y_metrics_byte_range();
67        self.data.read_array(range).ok().unwrap_or_default()
68    }
69
70    pub fn version_byte_range(&self) -> Range<usize> {
71        let start = 0;
72        let end = start + MajorMinor::RAW_BYTE_LEN;
73        start..end
74    }
75
76    pub fn default_vert_origin_y_byte_range(&self) -> Range<usize> {
77        let start = self.version_byte_range().end;
78        let end = start + i16::RAW_BYTE_LEN;
79        start..end
80    }
81
82    pub fn num_vert_origin_y_metrics_byte_range(&self) -> Range<usize> {
83        let start = self.default_vert_origin_y_byte_range().end;
84        let end = start + u16::RAW_BYTE_LEN;
85        start..end
86    }
87
88    pub fn vert_origin_y_metrics_byte_range(&self) -> Range<usize> {
89        let num_vert_origin_y_metrics = self.num_vert_origin_y_metrics();
90        let start = self.num_vert_origin_y_metrics_byte_range().end;
91        let end = start
92            + (transforms::to_usize(num_vert_origin_y_metrics))
93                .saturating_mul(VertOriginYMetrics::RAW_BYTE_LEN);
94        start..end
95    }
96}
97
98const _: () = assert!(FontData::default_data_long_enough(Vorg::MIN_SIZE));
99
100impl Default for Vorg<'_> {
101    fn default() -> Self {
102        Self {
103            data: FontData::default_table_data(),
104        }
105    }
106}
107
108#[cfg(feature = "experimental_traverse")]
109impl<'a> SomeTable<'a> for Vorg<'a> {
110    fn type_name(&self) -> &str {
111        "Vorg"
112    }
113    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
114        match idx {
115            0usize => Some(Field::new("version", self.version())),
116            1usize => Some(Field::new(
117                "default_vert_origin_y",
118                self.default_vert_origin_y(),
119            )),
120            2usize => Some(Field::new(
121                "num_vert_origin_y_metrics",
122                self.num_vert_origin_y_metrics(),
123            )),
124            3usize => Some(Field::new(
125                "vert_origin_y_metrics",
126                traversal::FieldType::array_of_records(
127                    stringify!(VertOriginYMetrics),
128                    self.vert_origin_y_metrics(),
129                    self.offset_data(),
130                ),
131            )),
132            _ => None,
133        }
134    }
135}
136
137#[cfg(feature = "experimental_traverse")]
138#[allow(clippy::needless_lifetimes)]
139impl<'a> std::fmt::Debug for Vorg<'a> {
140    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
141        (self as &dyn SomeTable<'a>).fmt(f)
142    }
143}
144
145/// Vertical origin Y metrics record.
146#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, bytemuck :: AnyBitPattern)]
147#[repr(C)]
148#[repr(packed)]
149pub struct VertOriginYMetrics {
150    /// Glyph index.
151    pub glyph_index: BigEndian<GlyphId16>,
152    /// Y coordinate, in the font’s design coordinate system, of the glyph’s vertical origin.
153    pub vert_origin_y: BigEndian<i16>,
154}
155
156impl VertOriginYMetrics {
157    /// Glyph index.
158    pub fn glyph_index(&self) -> GlyphId16 {
159        self.glyph_index.get()
160    }
161
162    /// Y coordinate, in the font’s design coordinate system, of the glyph’s vertical origin.
163    pub fn vert_origin_y(&self) -> i16 {
164        self.vert_origin_y.get()
165    }
166}
167
168impl FixedSize for VertOriginYMetrics {
169    const RAW_BYTE_LEN: usize = GlyphId16::RAW_BYTE_LEN + i16::RAW_BYTE_LEN;
170}
171
172#[cfg(feature = "experimental_traverse")]
173impl<'a> SomeRecord<'a> for VertOriginYMetrics {
174    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
175        RecordResolver {
176            name: "VertOriginYMetrics",
177            get_field: Box::new(move |idx, _data| match idx {
178                0usize => Some(Field::new("glyph_index", self.glyph_index())),
179                1usize => Some(Field::new("vert_origin_y", self.vert_origin_y())),
180                _ => None,
181            }),
182            data,
183        }
184    }
185}
read_fonts/generated/generated_vorg.rs

read_fonts/generated/
generated_vorg.rs
