read_fonts/generated/
generated_trak.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 Trak<'a> {
9    fn min_byte_range(&self) -> Range<usize> {
10        0..self.reserved_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 Trak<'_> {
19    /// `trak`
20    const TAG: Tag = Tag::new(b"trak");
21}
22
23impl<'a> FontRead<'a> for Trak<'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 [tracking (trak)](https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6trak.html) table.
34#[derive(Clone)]
35pub struct Trak<'a> {
36    data: FontData<'a>,
37}
38
39#[allow(clippy::needless_lifetimes)]
40impl<'a> Trak<'a> {
41    pub const MIN_SIZE: usize = (MajorMinor::RAW_BYTE_LEN
42        + u16::RAW_BYTE_LEN
43        + Offset16::RAW_BYTE_LEN
44        + Offset16::RAW_BYTE_LEN
45        + u16::RAW_BYTE_LEN);
46    basic_table_impls!(impl_the_methods);
47
48    /// Version number of the tracking table (0x00010000 for the current version).
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    /// Format of the tracking table (set to 0).
55    pub fn format(&self) -> u16 {
56        let range = self.format_byte_range();
57        self.data.read_at(range.start).ok().unwrap()
58    }
59
60    /// Offset from start of tracking table to TrackData for horizontal text (or 0 if none).
61    pub fn horiz_offset(&self) -> Nullable<Offset16> {
62        let range = self.horiz_offset_byte_range();
63        self.data.read_at(range.start).ok().unwrap()
64    }
65
66    /// Attempt to resolve [`horiz_offset`][Self::horiz_offset].
67    pub fn horiz(&self) -> Option<Result<TrackData<'a>, ReadError>> {
68        let data = self.data;
69        self.horiz_offset().resolve(data)
70    }
71
72    /// Offset from start of tracking table to TrackData for vertical text (or 0 if none).
73    pub fn vert_offset(&self) -> Nullable<Offset16> {
74        let range = self.vert_offset_byte_range();
75        self.data.read_at(range.start).ok().unwrap()
76    }
77
78    /// Attempt to resolve [`vert_offset`][Self::vert_offset].
79    pub fn vert(&self) -> Option<Result<TrackData<'a>, ReadError>> {
80        let data = self.data;
81        self.vert_offset().resolve(data)
82    }
83
84    pub fn version_byte_range(&self) -> Range<usize> {
85        let start = 0;
86        start..start + MajorMinor::RAW_BYTE_LEN
87    }
88
89    pub fn format_byte_range(&self) -> Range<usize> {
90        let start = self.version_byte_range().end;
91        start..start + u16::RAW_BYTE_LEN
92    }
93
94    pub fn horiz_offset_byte_range(&self) -> Range<usize> {
95        let start = self.format_byte_range().end;
96        start..start + Offset16::RAW_BYTE_LEN
97    }
98
99    pub fn vert_offset_byte_range(&self) -> Range<usize> {
100        let start = self.horiz_offset_byte_range().end;
101        start..start + Offset16::RAW_BYTE_LEN
102    }
103
104    pub fn reserved_byte_range(&self) -> Range<usize> {
105        let start = self.vert_offset_byte_range().end;
106        start..start + u16::RAW_BYTE_LEN
107    }
108}
109
110const _: () = assert!(FontData::default_data_long_enough(Trak::MIN_SIZE));
111
112impl Default for Trak<'_> {
113    fn default() -> Self {
114        Self {
115            data: FontData::default_table_data(),
116        }
117    }
118}
119
120#[cfg(feature = "experimental_traverse")]
121impl<'a> SomeTable<'a> for Trak<'a> {
122    fn type_name(&self) -> &str {
123        "Trak"
124    }
125    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
126        match idx {
127            0usize => Some(Field::new("version", self.version())),
128            1usize => Some(Field::new("format", self.format())),
129            2usize => Some(Field::new(
130                "horiz_offset",
131                FieldType::offset(self.horiz_offset(), self.horiz()),
132            )),
133            3usize => Some(Field::new(
134                "vert_offset",
135                FieldType::offset(self.vert_offset(), self.vert()),
136            )),
137            _ => None,
138        }
139    }
140}
141
142#[cfg(feature = "experimental_traverse")]
143#[allow(clippy::needless_lifetimes)]
144impl<'a> std::fmt::Debug for Trak<'a> {
145    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
146        (self as &dyn SomeTable<'a>).fmt(f)
147    }
148}
149
150impl<'a> MinByteRange<'a> for TrackData<'a> {
151    fn min_byte_range(&self) -> Range<usize> {
152        0..self.track_table_byte_range().end
153    }
154    fn min_table_bytes(&self) -> &'a [u8] {
155        let range = self.min_byte_range();
156        self.data.as_bytes().get(range).unwrap_or_default()
157    }
158}
159
160impl<'a> FontRead<'a> for TrackData<'a> {
161    fn read(data: FontData<'a>) -> Result<Self, ReadError> {
162        #[allow(clippy::absurd_extreme_comparisons)]
163        if data.len() < Self::MIN_SIZE {
164            return Err(ReadError::OutOfBounds);
165        }
166        Ok(Self { data })
167    }
168}
169
170/// The tracking data table.
171#[derive(Clone)]
172pub struct TrackData<'a> {
173    data: FontData<'a>,
174}
175
176#[allow(clippy::needless_lifetimes)]
177impl<'a> TrackData<'a> {
178    pub const MIN_SIZE: usize = (u16::RAW_BYTE_LEN + u16::RAW_BYTE_LEN + u32::RAW_BYTE_LEN);
179    basic_table_impls!(impl_the_methods);
180
181    /// Number of separate tracks included in this table.
182    pub fn n_tracks(&self) -> u16 {
183        let range = self.n_tracks_byte_range();
184        self.data.read_at(range.start).ok().unwrap()
185    }
186
187    /// Number of point sizes included in this table.
188    pub fn n_sizes(&self) -> u16 {
189        let range = self.n_sizes_byte_range();
190        self.data.read_at(range.start).ok().unwrap()
191    }
192
193    /// Offset from the start of the tracking table to the start of the size subtable.
194    pub fn size_table_offset(&self) -> u32 {
195        let range = self.size_table_offset_byte_range();
196        self.data.read_at(range.start).ok().unwrap()
197    }
198
199    /// Array of TrackTableEntry records.
200    pub fn track_table(&self) -> &'a [TrackTableEntry] {
201        let range = self.track_table_byte_range();
202        self.data.read_array(range).ok().unwrap_or_default()
203    }
204
205    pub fn n_tracks_byte_range(&self) -> Range<usize> {
206        let start = 0;
207        start..start + u16::RAW_BYTE_LEN
208    }
209
210    pub fn n_sizes_byte_range(&self) -> Range<usize> {
211        let start = self.n_tracks_byte_range().end;
212        start..start + u16::RAW_BYTE_LEN
213    }
214
215    pub fn size_table_offset_byte_range(&self) -> Range<usize> {
216        let start = self.n_sizes_byte_range().end;
217        start..start + u32::RAW_BYTE_LEN
218    }
219
220    pub fn track_table_byte_range(&self) -> Range<usize> {
221        let n_tracks = self.n_tracks();
222        let start = self.size_table_offset_byte_range().end;
223        start
224            ..start + (transforms::to_usize(n_tracks)).saturating_mul(TrackTableEntry::RAW_BYTE_LEN)
225    }
226}
227
228const _: () = assert!(FontData::default_data_long_enough(TrackData::MIN_SIZE));
229
230impl Default for TrackData<'_> {
231    fn default() -> Self {
232        Self {
233            data: FontData::default_table_data(),
234        }
235    }
236}
237
238#[cfg(feature = "experimental_traverse")]
239impl<'a> SomeTable<'a> for TrackData<'a> {
240    fn type_name(&self) -> &str {
241        "TrackData"
242    }
243    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
244        match idx {
245            0usize => Some(Field::new("n_tracks", self.n_tracks())),
246            1usize => Some(Field::new("n_sizes", self.n_sizes())),
247            2usize => Some(Field::new("size_table_offset", self.size_table_offset())),
248            3usize => Some(Field::new(
249                "track_table",
250                traversal::FieldType::array_of_records(
251                    stringify!(TrackTableEntry),
252                    self.track_table(),
253                    self.offset_data(),
254                ),
255            )),
256            _ => None,
257        }
258    }
259}
260
261#[cfg(feature = "experimental_traverse")]
262#[allow(clippy::needless_lifetimes)]
263impl<'a> std::fmt::Debug for TrackData<'a> {
264    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
265        (self as &dyn SomeTable<'a>).fmt(f)
266    }
267}
268
269/// Single entry in a tracking table.
270#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, bytemuck :: AnyBitPattern)]
271#[repr(C)]
272#[repr(packed)]
273pub struct TrackTableEntry {
274    /// Track value for this record.
275    pub track: BigEndian<Fixed>,
276    /// The 'name' table index for this track (a short word or phrase like \"loose\" or \"very tight\"). NameIndex has a value greater than 255 and less than 32768.
277    pub name_index: BigEndian<NameId>,
278    /// Offset from the start of the tracking table to per-size tracking values for this track.
279    pub offset: BigEndian<u16>,
280}
281
282impl TrackTableEntry {
283    /// Track value for this record.
284    pub fn track(&self) -> Fixed {
285        self.track.get()
286    }
287
288    /// The 'name' table index for this track (a short word or phrase like \"loose\" or \"very tight\"). NameIndex has a value greater than 255 and less than 32768.
289    pub fn name_index(&self) -> NameId {
290        self.name_index.get()
291    }
292
293    /// Offset from the start of the tracking table to per-size tracking values for this track.
294    pub fn offset(&self) -> u16 {
295        self.offset.get()
296    }
297}
298
299impl FixedSize for TrackTableEntry {
300    const RAW_BYTE_LEN: usize = Fixed::RAW_BYTE_LEN + NameId::RAW_BYTE_LEN + u16::RAW_BYTE_LEN;
301}
302
303#[cfg(feature = "experimental_traverse")]
304impl<'a> SomeRecord<'a> for TrackTableEntry {
305    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
306        RecordResolver {
307            name: "TrackTableEntry",
308            get_field: Box::new(move |idx, _data| match idx {
309                0usize => Some(Field::new("track", self.track())),
310                1usize => Some(Field::new("name_index", self.name_index())),
311                2usize => Some(Field::new("offset", self.offset())),
312                _ => None,
313            }),
314            data,
315        }
316    }
317}
read_fonts/generated/generated_trak.rs

read_fonts/generated/
generated_trak.rs
