read_fonts/generated/
generated_name.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 Name<'a> {
9    fn min_byte_range(&self) -> Range<usize> {
10        0..self.name_record_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 Name<'_> {
19    /// `name`
20    const TAG: Tag = Tag::new(b"name");
21}
22
23impl<'a> FontRead<'a> for Name<'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/// [Naming table version 1](https://docs.microsoft.com/en-us/typography/opentype/spec/name#naming-table-version-1)
34#[derive(Clone)]
35pub struct Name<'a> {
36    data: FontData<'a>,
37}
38
39#[allow(clippy::needless_lifetimes)]
40impl<'a> Name<'a> {
41    pub const MIN_SIZE: usize = (u16::RAW_BYTE_LEN + u16::RAW_BYTE_LEN + u16::RAW_BYTE_LEN);
42    basic_table_impls!(impl_the_methods);
43
44    /// Table version number (0 or 1)
45    pub fn version(&self) -> u16 {
46        let range = self.version_byte_range();
47        self.data.read_at(range.start).ok().unwrap()
48    }
49
50    /// Number of name records.
51    pub fn count(&self) -> u16 {
52        let range = self.count_byte_range();
53        self.data.read_at(range.start).ok().unwrap()
54    }
55
56    /// Offset to start of string storage (from start of table).
57    pub fn storage_offset(&self) -> u16 {
58        let range = self.storage_offset_byte_range();
59        self.data.read_at(range.start).ok().unwrap()
60    }
61
62    /// The name records where count is the number of records.
63    pub fn name_record(&self) -> &'a [NameRecord] {
64        let range = self.name_record_byte_range();
65        self.data.read_array(range).ok().unwrap_or_default()
66    }
67
68    /// Number of language-tag records.
69    pub fn lang_tag_count(&self) -> Option<u16> {
70        let range = self.lang_tag_count_byte_range();
71        (!range.is_empty())
72            .then(|| self.data.read_at(range.start).ok())
73            .flatten()
74    }
75
76    /// The language-tag records where langTagCount is the number of records.
77    pub fn lang_tag_record(&self) -> Option<&'a [LangTagRecord]> {
78        let range = self.lang_tag_record_byte_range();
79        (!range.is_empty())
80            .then(|| self.data.read_array(range).ok())
81            .flatten()
82    }
83
84    pub fn version_byte_range(&self) -> Range<usize> {
85        let start = 0;
86        start..start + u16::RAW_BYTE_LEN
87    }
88
89    pub fn count_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 storage_offset_byte_range(&self) -> Range<usize> {
95        let start = self.count_byte_range().end;
96        start..start + u16::RAW_BYTE_LEN
97    }
98
99    pub fn name_record_byte_range(&self) -> Range<usize> {
100        let count = self.count();
101        let start = self.storage_offset_byte_range().end;
102        start..start + (count as usize).saturating_mul(NameRecord::RAW_BYTE_LEN)
103    }
104
105    pub fn lang_tag_count_byte_range(&self) -> Range<usize> {
106        let start = self.name_record_byte_range().end;
107        start
108            ..(self.version().compatible(1u16))
109                .then(|| start + u16::RAW_BYTE_LEN)
110                .unwrap_or(start)
111    }
112
113    pub fn lang_tag_record_byte_range(&self) -> Range<usize> {
114        let lang_tag_count = self.lang_tag_count().unwrap_or_default();
115        let start = self.lang_tag_count_byte_range().end;
116        start
117            ..(self.version().compatible(1u16))
118                .then(|| {
119                    start + (lang_tag_count as usize).saturating_mul(LangTagRecord::RAW_BYTE_LEN)
120                })
121                .unwrap_or(start)
122    }
123}
124
125const _: () = assert!(FontData::default_data_long_enough(Name::MIN_SIZE));
126
127impl Default for Name<'_> {
128    fn default() -> Self {
129        Self {
130            data: FontData::default_table_data(),
131        }
132    }
133}
134
135#[cfg(feature = "experimental_traverse")]
136impl<'a> SomeTable<'a> for Name<'a> {
137    fn type_name(&self) -> &str {
138        "Name"
139    }
140    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
141        match idx {
142            0usize => Some(Field::new("version", self.version())),
143            1usize => Some(Field::new("count", self.count())),
144            2usize => Some(Field::new("storage_offset", self.storage_offset())),
145            3usize => Some(Field::new(
146                "name_record",
147                traversal::FieldType::array_of_records(
148                    stringify!(NameRecord),
149                    self.name_record(),
150                    self.string_data(),
151                ),
152            )),
153            4usize if self.version().compatible(1u16) => {
154                Some(Field::new("lang_tag_count", self.lang_tag_count().unwrap()))
155            }
156            5usize if self.version().compatible(1u16) => Some(Field::new(
157                "lang_tag_record",
158                traversal::FieldType::array_of_records(
159                    stringify!(LangTagRecord),
160                    self.lang_tag_record().unwrap(),
161                    self.string_data(),
162                ),
163            )),
164            _ => None,
165        }
166    }
167}
168
169#[cfg(feature = "experimental_traverse")]
170#[allow(clippy::needless_lifetimes)]
171impl<'a> std::fmt::Debug for Name<'a> {
172    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
173        (self as &dyn SomeTable<'a>).fmt(f)
174    }
175}
176
177/// Part of [Name]
178#[derive(Clone, Debug, Copy, bytemuck :: AnyBitPattern)]
179#[repr(C)]
180#[repr(packed)]
181pub struct LangTagRecord {
182    /// Language-tag string length (in bytes)
183    pub length: BigEndian<u16>,
184    /// Language-tag string offset from start of storage area (in
185    /// bytes).
186    pub lang_tag_offset: BigEndian<Offset16>,
187}
188
189impl LangTagRecord {
190    /// Language-tag string length (in bytes)
191    pub fn length(&self) -> u16 {
192        self.length.get()
193    }
194
195    /// Language-tag string offset from start of storage area (in
196    /// bytes).
197    pub fn lang_tag_offset(&self) -> Offset16 {
198        self.lang_tag_offset.get()
199    }
200}
201
202impl FixedSize for LangTagRecord {
203    const RAW_BYTE_LEN: usize = u16::RAW_BYTE_LEN + Offset16::RAW_BYTE_LEN;
204}
205
206#[cfg(feature = "experimental_traverse")]
207impl<'a> SomeRecord<'a> for LangTagRecord {
208    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
209        RecordResolver {
210            name: "LangTagRecord",
211            get_field: Box::new(move |idx, _data| match idx {
212                0usize => Some(Field::new("length", self.length())),
213                1usize => Some(Field::new("lang_tag_offset", self.traverse_lang_tag(_data))),
214                _ => None,
215            }),
216            data,
217        }
218    }
219}
220
221///[Name Records](https://docs.microsoft.com/en-us/typography/opentype/spec/name#name-records)
222#[derive(Clone, Debug, Copy, bytemuck :: AnyBitPattern)]
223#[repr(C)]
224#[repr(packed)]
225pub struct NameRecord {
226    /// Platform ID.
227    pub platform_id: BigEndian<u16>,
228    /// Platform-specific encoding ID.
229    pub encoding_id: BigEndian<u16>,
230    /// Language ID.
231    pub language_id: BigEndian<u16>,
232    /// Name ID.
233    pub name_id: BigEndian<NameId>,
234    /// String length (in bytes).
235    pub length: BigEndian<u16>,
236    /// String offset from start of storage area (in bytes).
237    pub string_offset: BigEndian<Offset16>,
238}
239
240impl NameRecord {
241    /// Platform ID.
242    pub fn platform_id(&self) -> u16 {
243        self.platform_id.get()
244    }
245
246    /// Platform-specific encoding ID.
247    pub fn encoding_id(&self) -> u16 {
248        self.encoding_id.get()
249    }
250
251    /// Language ID.
252    pub fn language_id(&self) -> u16 {
253        self.language_id.get()
254    }
255
256    /// Name ID.
257    pub fn name_id(&self) -> NameId {
258        self.name_id.get()
259    }
260
261    /// String length (in bytes).
262    pub fn length(&self) -> u16 {
263        self.length.get()
264    }
265
266    /// String offset from start of storage area (in bytes).
267    pub fn string_offset(&self) -> Offset16 {
268        self.string_offset.get()
269    }
270}
271
272impl FixedSize for NameRecord {
273    const RAW_BYTE_LEN: usize = u16::RAW_BYTE_LEN
274        + u16::RAW_BYTE_LEN
275        + u16::RAW_BYTE_LEN
276        + NameId::RAW_BYTE_LEN
277        + u16::RAW_BYTE_LEN
278        + Offset16::RAW_BYTE_LEN;
279}
280
281#[cfg(feature = "experimental_traverse")]
282impl<'a> SomeRecord<'a> for NameRecord {
283    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
284        RecordResolver {
285            name: "NameRecord",
286            get_field: Box::new(move |idx, _data| match idx {
287                0usize => Some(Field::new("platform_id", self.platform_id())),
288                1usize => Some(Field::new("encoding_id", self.encoding_id())),
289                2usize => Some(Field::new("language_id", self.language_id())),
290                3usize => Some(Field::new("name_id", self.name_id())),
291                4usize => Some(Field::new("length", self.length())),
292                5usize => Some(Field::new("string_offset", self.traverse_string(_data))),
293                _ => None,
294            }),
295            data,
296        }
297    }
298}
read_fonts/generated/generated_name.rs

read_fonts/generated/
generated_name.rs
