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        start..start + MajorMinor::RAW_BYTE_LEN
73    }
74
75    pub fn default_vert_origin_y_byte_range(&self) -> Range<usize> {
76        let start = self.version_byte_range().end;
77        start..start + i16::RAW_BYTE_LEN
78    }
79
80    pub fn num_vert_origin_y_metrics_byte_range(&self) -> Range<usize> {
81        let start = self.default_vert_origin_y_byte_range().end;
82        start..start + u16::RAW_BYTE_LEN
83    }
84
85    pub fn vert_origin_y_metrics_byte_range(&self) -> Range<usize> {
86        let num_vert_origin_y_metrics = self.num_vert_origin_y_metrics();
87        let start = self.num_vert_origin_y_metrics_byte_range().end;
88        start
89            ..start
90                + (num_vert_origin_y_metrics as usize)
91                    .saturating_mul(VertOriginYMetrics::RAW_BYTE_LEN)
92    }
93}
94
95const _: () = assert!(FontData::default_data_long_enough(Vorg::MIN_SIZE));
96
97impl Default for Vorg<'_> {
98    fn default() -> Self {
99        Self {
100            data: FontData::default_table_data(),
101        }
102    }
103}
104
105#[cfg(feature = "experimental_traverse")]
106impl<'a> SomeTable<'a> for Vorg<'a> {
107    fn type_name(&self) -> &str {
108        "Vorg"
109    }
110    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
111        match idx {
112            0usize => Some(Field::new("version", self.version())),
113            1usize => Some(Field::new(
114                "default_vert_origin_y",
115                self.default_vert_origin_y(),
116            )),
117            2usize => Some(Field::new(
118                "num_vert_origin_y_metrics",
119                self.num_vert_origin_y_metrics(),
120            )),
121            3usize => Some(Field::new(
122                "vert_origin_y_metrics",
123                traversal::FieldType::array_of_records(
124                    stringify!(VertOriginYMetrics),
125                    self.vert_origin_y_metrics(),
126                    self.offset_data(),
127                ),
128            )),
129            _ => None,
130        }
131    }
132}
133
134#[cfg(feature = "experimental_traverse")]
135#[allow(clippy::needless_lifetimes)]
136impl<'a> std::fmt::Debug for Vorg<'a> {
137    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
138        (self as &dyn SomeTable<'a>).fmt(f)
139    }
140}
141
142/// Vertical origin Y metrics record.
143#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, bytemuck :: AnyBitPattern)]
144#[repr(C)]
145#[repr(packed)]
146pub struct VertOriginYMetrics {
147    /// Glyph index.
148    pub glyph_index: BigEndian<GlyphId16>,
149    /// Y coordinate, in the font’s design coordinate system, of the glyph’s vertical origin.
150    pub vert_origin_y: BigEndian<i16>,
151}
152
153impl VertOriginYMetrics {
154    /// Glyph index.
155    pub fn glyph_index(&self) -> GlyphId16 {
156        self.glyph_index.get()
157    }
158
159    /// Y coordinate, in the font’s design coordinate system, of the glyph’s vertical origin.
160    pub fn vert_origin_y(&self) -> i16 {
161        self.vert_origin_y.get()
162    }
163}
164
165impl FixedSize for VertOriginYMetrics {
166    const RAW_BYTE_LEN: usize = GlyphId16::RAW_BYTE_LEN + i16::RAW_BYTE_LEN;
167}
168
169#[cfg(feature = "experimental_traverse")]
170impl<'a> SomeRecord<'a> for VertOriginYMetrics {
171    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
172        RecordResolver {
173            name: "VertOriginYMetrics",
174            get_field: Box::new(move |idx, _data| match idx {
175                0usize => Some(Field::new("glyph_index", self.glyph_index())),
176                1usize => Some(Field::new("vert_origin_y", self.vert_origin_y())),
177                _ => None,
178            }),
179            data,
180        }
181    }
182}
read_fonts/generated/generated_vorg.rs

read_fonts/generated/
generated_vorg.rs
