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

read_fonts/generated/
generated_vorg.rs
