read_fonts/generated/
font.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 OpenType [Table Directory](https://docs.microsoft.com/en-us/typography/opentype/spec/otff#table-directory)
9#[derive(Debug, Clone, Copy)]
10#[doc(hidden)]
11pub struct TableDirectoryMarker {
12    table_records_byte_len: usize,
13}
14
15impl TableDirectoryMarker {
16    pub fn sfnt_version_byte_range(&self) -> Range<usize> {
17        let start = 0;
18        start..start + u32::RAW_BYTE_LEN
19    }
20
21    pub fn num_tables_byte_range(&self) -> Range<usize> {
22        let start = self.sfnt_version_byte_range().end;
23        start..start + u16::RAW_BYTE_LEN
24    }
25
26    pub fn search_range_byte_range(&self) -> Range<usize> {
27        let start = self.num_tables_byte_range().end;
28        start..start + u16::RAW_BYTE_LEN
29    }
30
31    pub fn entry_selector_byte_range(&self) -> Range<usize> {
32        let start = self.search_range_byte_range().end;
33        start..start + u16::RAW_BYTE_LEN
34    }
35
36    pub fn range_shift_byte_range(&self) -> Range<usize> {
37        let start = self.entry_selector_byte_range().end;
38        start..start + u16::RAW_BYTE_LEN
39    }
40
41    pub fn table_records_byte_range(&self) -> Range<usize> {
42        let start = self.range_shift_byte_range().end;
43        start..start + self.table_records_byte_len
44    }
45}
46
47impl MinByteRange for TableDirectoryMarker {
48    fn min_byte_range(&self) -> Range<usize> {
49        0..self.table_records_byte_range().end
50    }
51}
52
53impl<'a> FontRead<'a> for TableDirectory<'a> {
54    fn read(data: FontData<'a>) -> Result<Self, ReadError> {
55        let mut cursor = data.cursor();
56        cursor.advance::<u32>();
57        let num_tables: u16 = cursor.read()?;
58        cursor.advance::<u16>();
59        cursor.advance::<u16>();
60        cursor.advance::<u16>();
61        let table_records_byte_len = (num_tables as usize)
62            .checked_mul(TableRecord::RAW_BYTE_LEN)
63            .ok_or(ReadError::OutOfBounds)?;
64        cursor.advance_by(table_records_byte_len);
65        cursor.finish(TableDirectoryMarker {
66            table_records_byte_len,
67        })
68    }
69}
70
71/// The OpenType [Table Directory](https://docs.microsoft.com/en-us/typography/opentype/spec/otff#table-directory)
72pub type TableDirectory<'a> = TableRef<'a, TableDirectoryMarker>;
73
74#[allow(clippy::needless_lifetimes)]
75impl<'a> TableDirectory<'a> {
76    /// 0x00010000 or 0x4F54544F
77    pub fn sfnt_version(&self) -> u32 {
78        let range = self.shape.sfnt_version_byte_range();
79        self.data.read_at(range.start).unwrap()
80    }
81
82    /// Number of tables.
83    pub fn num_tables(&self) -> u16 {
84        let range = self.shape.num_tables_byte_range();
85        self.data.read_at(range.start).unwrap()
86    }
87
88    pub fn search_range(&self) -> u16 {
89        let range = self.shape.search_range_byte_range();
90        self.data.read_at(range.start).unwrap()
91    }
92
93    pub fn entry_selector(&self) -> u16 {
94        let range = self.shape.entry_selector_byte_range();
95        self.data.read_at(range.start).unwrap()
96    }
97
98    pub fn range_shift(&self) -> u16 {
99        let range = self.shape.range_shift_byte_range();
100        self.data.read_at(range.start).unwrap()
101    }
102
103    /// Table records array—one for each top-level table in the font
104    pub fn table_records(&self) -> &'a [TableRecord] {
105        let range = self.shape.table_records_byte_range();
106        self.data.read_array(range).unwrap()
107    }
108}
109
110#[cfg(feature = "experimental_traverse")]
111impl<'a> SomeTable<'a> for TableDirectory<'a> {
112    fn type_name(&self) -> &str {
113        "TableDirectory"
114    }
115    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
116        match idx {
117            0usize => Some(Field::new("sfnt_version", self.sfnt_version())),
118            1usize => Some(Field::new("num_tables", self.num_tables())),
119            2usize => Some(Field::new("search_range", self.search_range())),
120            3usize => Some(Field::new("entry_selector", self.entry_selector())),
121            4usize => Some(Field::new("range_shift", self.range_shift())),
122            5usize => Some(Field::new(
123                "table_records",
124                traversal::FieldType::array_of_records(
125                    stringify!(TableRecord),
126                    self.table_records(),
127                    self.offset_data(),
128                ),
129            )),
130            _ => None,
131        }
132    }
133}
134
135#[cfg(feature = "experimental_traverse")]
136#[allow(clippy::needless_lifetimes)]
137impl<'a> std::fmt::Debug for TableDirectory<'a> {
138    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
139        (self as &dyn SomeTable<'a>).fmt(f)
140    }
141}
142
143/// Record for a table in a font.
144#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, bytemuck :: AnyBitPattern)]
145#[repr(C)]
146#[repr(packed)]
147pub struct TableRecord {
148    /// Table identifier.
149    pub tag: BigEndian<Tag>,
150    /// Checksum for the table.
151    pub checksum: BigEndian<u32>,
152    /// Offset from the beginning of the font data.
153    pub offset: BigEndian<u32>,
154    /// Length of the table.
155    pub length: BigEndian<u32>,
156}
157
158impl TableRecord {
159    /// Table identifier.
160    pub fn tag(&self) -> Tag {
161        self.tag.get()
162    }
163
164    /// Checksum for the table.
165    pub fn checksum(&self) -> u32 {
166        self.checksum.get()
167    }
168
169    /// Offset from the beginning of the font data.
170    pub fn offset(&self) -> u32 {
171        self.offset.get()
172    }
173
174    /// Length of the table.
175    pub fn length(&self) -> u32 {
176        self.length.get()
177    }
178}
179
180impl FixedSize for TableRecord {
181    const RAW_BYTE_LEN: usize =
182        Tag::RAW_BYTE_LEN + u32::RAW_BYTE_LEN + u32::RAW_BYTE_LEN + u32::RAW_BYTE_LEN;
183}
184
185#[cfg(feature = "experimental_traverse")]
186impl<'a> SomeRecord<'a> for TableRecord {
187    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
188        RecordResolver {
189            name: "TableRecord",
190            get_field: Box::new(move |idx, _data| match idx {
191                0usize => Some(Field::new("tag", self.tag())),
192                1usize => Some(Field::new("checksum", self.checksum())),
193                2usize => Some(Field::new("offset", self.offset())),
194                3usize => Some(Field::new("length", self.length())),
195                _ => None,
196            }),
197            data,
198        }
199    }
200}
201
202/// [TTC Header](https://learn.microsoft.com/en-us/typography/opentype/spec/otff#ttc-header)
203#[derive(Debug, Clone, Copy)]
204#[doc(hidden)]
205pub struct TTCHeaderMarker {
206    table_directory_offsets_byte_len: usize,
207    dsig_tag_byte_start: Option<usize>,
208    dsig_length_byte_start: Option<usize>,
209    dsig_offset_byte_start: Option<usize>,
210}
211
212impl TTCHeaderMarker {
213    pub fn ttc_tag_byte_range(&self) -> Range<usize> {
214        let start = 0;
215        start..start + Tag::RAW_BYTE_LEN
216    }
217
218    pub fn version_byte_range(&self) -> Range<usize> {
219        let start = self.ttc_tag_byte_range().end;
220        start..start + MajorMinor::RAW_BYTE_LEN
221    }
222
223    pub fn num_fonts_byte_range(&self) -> Range<usize> {
224        let start = self.version_byte_range().end;
225        start..start + u32::RAW_BYTE_LEN
226    }
227
228    pub fn table_directory_offsets_byte_range(&self) -> Range<usize> {
229        let start = self.num_fonts_byte_range().end;
230        start..start + self.table_directory_offsets_byte_len
231    }
232
233    pub fn dsig_tag_byte_range(&self) -> Option<Range<usize>> {
234        let start = self.dsig_tag_byte_start?;
235        Some(start..start + u32::RAW_BYTE_LEN)
236    }
237
238    pub fn dsig_length_byte_range(&self) -> Option<Range<usize>> {
239        let start = self.dsig_length_byte_start?;
240        Some(start..start + u32::RAW_BYTE_LEN)
241    }
242
243    pub fn dsig_offset_byte_range(&self) -> Option<Range<usize>> {
244        let start = self.dsig_offset_byte_start?;
245        Some(start..start + u32::RAW_BYTE_LEN)
246    }
247}
248
249impl MinByteRange for TTCHeaderMarker {
250    fn min_byte_range(&self) -> Range<usize> {
251        0..self.table_directory_offsets_byte_range().end
252    }
253}
254
255impl<'a> FontRead<'a> for TTCHeader<'a> {
256    fn read(data: FontData<'a>) -> Result<Self, ReadError> {
257        let mut cursor = data.cursor();
258        cursor.advance::<Tag>();
259        let version: MajorMinor = cursor.read()?;
260        let num_fonts: u32 = cursor.read()?;
261        let table_directory_offsets_byte_len = (num_fonts as usize)
262            .checked_mul(u32::RAW_BYTE_LEN)
263            .ok_or(ReadError::OutOfBounds)?;
264        cursor.advance_by(table_directory_offsets_byte_len);
265        let dsig_tag_byte_start = version
266            .compatible((2u16, 0u16))
267            .then(|| cursor.position())
268            .transpose()?;
269        version
270            .compatible((2u16, 0u16))
271            .then(|| cursor.advance::<u32>());
272        let dsig_length_byte_start = version
273            .compatible((2u16, 0u16))
274            .then(|| cursor.position())
275            .transpose()?;
276        version
277            .compatible((2u16, 0u16))
278            .then(|| cursor.advance::<u32>());
279        let dsig_offset_byte_start = version
280            .compatible((2u16, 0u16))
281            .then(|| cursor.position())
282            .transpose()?;
283        version
284            .compatible((2u16, 0u16))
285            .then(|| cursor.advance::<u32>());
286        cursor.finish(TTCHeaderMarker {
287            table_directory_offsets_byte_len,
288            dsig_tag_byte_start,
289            dsig_length_byte_start,
290            dsig_offset_byte_start,
291        })
292    }
293}
294
295/// [TTC Header](https://learn.microsoft.com/en-us/typography/opentype/spec/otff#ttc-header)
296pub type TTCHeader<'a> = TableRef<'a, TTCHeaderMarker>;
297
298#[allow(clippy::needless_lifetimes)]
299impl<'a> TTCHeader<'a> {
300    /// Font Collection ID string: \"ttcf\"
301    pub fn ttc_tag(&self) -> Tag {
302        let range = self.shape.ttc_tag_byte_range();
303        self.data.read_at(range.start).unwrap()
304    }
305
306    /// Major/minor version of the TTC Header
307    pub fn version(&self) -> MajorMinor {
308        let range = self.shape.version_byte_range();
309        self.data.read_at(range.start).unwrap()
310    }
311
312    /// Number of fonts in TTC
313    pub fn num_fonts(&self) -> u32 {
314        let range = self.shape.num_fonts_byte_range();
315        self.data.read_at(range.start).unwrap()
316    }
317
318    /// Array of offsets to the TableDirectory for each font from the beginning of the file
319    pub fn table_directory_offsets(&self) -> &'a [BigEndian<u32>] {
320        let range = self.shape.table_directory_offsets_byte_range();
321        self.data.read_array(range).unwrap()
322    }
323
324    /// Tag indicating that a DSIG table exists, 0x44534947 ('DSIG') (null if no signature)
325    pub fn dsig_tag(&self) -> Option<u32> {
326        let range = self.shape.dsig_tag_byte_range()?;
327        Some(self.data.read_at(range.start).unwrap())
328    }
329
330    /// The length (in bytes) of the DSIG table (null if no signature)
331    pub fn dsig_length(&self) -> Option<u32> {
332        let range = self.shape.dsig_length_byte_range()?;
333        Some(self.data.read_at(range.start).unwrap())
334    }
335
336    /// The offset (in bytes) of the DSIG table from the beginning of the TTC file (null if no signature)
337    pub fn dsig_offset(&self) -> Option<u32> {
338        let range = self.shape.dsig_offset_byte_range()?;
339        Some(self.data.read_at(range.start).unwrap())
340    }
341}
342
343#[cfg(feature = "experimental_traverse")]
344impl<'a> SomeTable<'a> for TTCHeader<'a> {
345    fn type_name(&self) -> &str {
346        "TTCHeader"
347    }
348    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
349        let version = self.version();
350        match idx {
351            0usize => Some(Field::new("ttc_tag", self.ttc_tag())),
352            1usize => Some(Field::new("version", self.version())),
353            2usize => Some(Field::new("num_fonts", self.num_fonts())),
354            3usize => Some(Field::new(
355                "table_directory_offsets",
356                self.table_directory_offsets(),
357            )),
358            4usize if version.compatible((2u16, 0u16)) => {
359                Some(Field::new("dsig_tag", self.dsig_tag().unwrap()))
360            }
361            5usize if version.compatible((2u16, 0u16)) => {
362                Some(Field::new("dsig_length", self.dsig_length().unwrap()))
363            }
364            6usize if version.compatible((2u16, 0u16)) => {
365                Some(Field::new("dsig_offset", self.dsig_offset().unwrap()))
366            }
367            _ => None,
368        }
369    }
370}
371
372#[cfg(feature = "experimental_traverse")]
373#[allow(clippy::needless_lifetimes)]
374impl<'a> std::fmt::Debug for TTCHeader<'a> {
375    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
376        (self as &dyn SomeTable<'a>).fmt(f)
377    }
378}
read_fonts/generated/font.rs

read_fonts/generated/
font.rs
