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        let end = start + u16::RAW_BYTE_LEN;
87        start..end
88    }
89
90    pub fn count_byte_range(&self) -> Range<usize> {
91        let start = self.version_byte_range().end;
92        let end = start + u16::RAW_BYTE_LEN;
93        start..end
94    }
95
96    pub fn storage_offset_byte_range(&self) -> Range<usize> {
97        let start = self.count_byte_range().end;
98        let end = start + u16::RAW_BYTE_LEN;
99        start..end
100    }
101
102    pub fn name_record_byte_range(&self) -> Range<usize> {
103        let count = self.count();
104        let start = self.storage_offset_byte_range().end;
105        let end = start + (transforms::to_usize(count)).saturating_mul(NameRecord::RAW_BYTE_LEN);
106        start..end
107    }
108
109    pub fn lang_tag_count_byte_range(&self) -> Range<usize> {
110        let start = self.name_record_byte_range().end;
111        let end = if self.version().compatible(1u16) {
112            start + u16::RAW_BYTE_LEN
113        } else {
114            start
115        };
116        start..end
117    }
118
119    pub fn lang_tag_record_byte_range(&self) -> Range<usize> {
120        let lang_tag_count = self.lang_tag_count().unwrap_or_default();
121        let start = self.lang_tag_count_byte_range().end;
122        let end = if self.version().compatible(1u16) {
123            start
124                + (transforms::to_usize(lang_tag_count)).saturating_mul(LangTagRecord::RAW_BYTE_LEN)
125        } else {
126            start
127        };
128        start..end
129    }
130}
131
132const _: () = assert!(FontData::default_data_long_enough(Name::MIN_SIZE));
133
134impl Default for Name<'_> {
135    fn default() -> Self {
136        Self {
137            data: FontData::default_table_data(),
138        }
139    }
140}
141
142#[cfg(feature = "experimental_traverse")]
143impl<'a> SomeTable<'a> for Name<'a> {
144    fn type_name(&self) -> &str {
145        "Name"
146    }
147    fn get_field(&self, idx: usize) -> Option<Field<'a>> {
148        match idx {
149            0usize => Some(Field::new("version", self.version())),
150            1usize => Some(Field::new("count", self.count())),
151            2usize => Some(Field::new("storage_offset", self.storage_offset())),
152            3usize => Some(Field::new(
153                "name_record",
154                traversal::FieldType::array_of_records(
155                    stringify!(NameRecord),
156                    self.name_record(),
157                    self.string_data(),
158                ),
159            )),
160            4usize if self.version().compatible(1u16) => {
161                Some(Field::new("lang_tag_count", self.lang_tag_count().unwrap()))
162            }
163            5usize if self.version().compatible(1u16) => Some(Field::new(
164                "lang_tag_record",
165                traversal::FieldType::array_of_records(
166                    stringify!(LangTagRecord),
167                    self.lang_tag_record().unwrap(),
168                    self.string_data(),
169                ),
170            )),
171            _ => None,
172        }
173    }
174}
175
176#[cfg(feature = "experimental_traverse")]
177#[allow(clippy::needless_lifetimes)]
178impl<'a> std::fmt::Debug for Name<'a> {
179    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
180        (self as &dyn SomeTable<'a>).fmt(f)
181    }
182}
183
184/// Part of [Name]
185#[derive(Clone, Debug, Copy, bytemuck :: AnyBitPattern)]
186#[repr(C)]
187#[repr(packed)]
188pub struct LangTagRecord {
189    /// Language-tag string length (in bytes)
190    pub length: BigEndian<u16>,
191    /// Language-tag string offset from start of storage area (in
192    /// bytes).
193    pub lang_tag_offset: BigEndian<Offset16>,
194}
195
196impl LangTagRecord {
197    /// Language-tag string length (in bytes)
198    pub fn length(&self) -> u16 {
199        self.length.get()
200    }
201
202    /// Language-tag string offset from start of storage area (in
203    /// bytes).
204    pub fn lang_tag_offset(&self) -> Offset16 {
205        self.lang_tag_offset.get()
206    }
207}
208
209impl FixedSize for LangTagRecord {
210    const RAW_BYTE_LEN: usize = u16::RAW_BYTE_LEN + Offset16::RAW_BYTE_LEN;
211}
212
213#[cfg(feature = "experimental_traverse")]
214impl<'a> SomeRecord<'a> for LangTagRecord {
215    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
216        RecordResolver {
217            name: "LangTagRecord",
218            get_field: Box::new(move |idx, _data| match idx {
219                0usize => Some(Field::new("length", self.length())),
220                1usize => Some(Field::new("lang_tag_offset", self.traverse_lang_tag(_data))),
221                _ => None,
222            }),
223            data,
224        }
225    }
226}
227
228///[Name Records](https://docs.microsoft.com/en-us/typography/opentype/spec/name#name-records)
229#[derive(Clone, Debug, Copy, bytemuck :: AnyBitPattern)]
230#[repr(C)]
231#[repr(packed)]
232pub struct NameRecord {
233    /// Platform ID.
234    pub platform_id: BigEndian<u16>,
235    /// Platform-specific encoding ID.
236    pub encoding_id: BigEndian<u16>,
237    /// Language ID.
238    pub language_id: BigEndian<u16>,
239    /// Name ID.
240    pub name_id: BigEndian<NameId>,
241    /// String length (in bytes).
242    pub length: BigEndian<u16>,
243    /// String offset from start of storage area (in bytes).
244    pub string_offset: BigEndian<Offset16>,
245}
246
247impl NameRecord {
248    /// Platform ID.
249    pub fn platform_id(&self) -> u16 {
250        self.platform_id.get()
251    }
252
253    /// Platform-specific encoding ID.
254    pub fn encoding_id(&self) -> u16 {
255        self.encoding_id.get()
256    }
257
258    /// Language ID.
259    pub fn language_id(&self) -> u16 {
260        self.language_id.get()
261    }
262
263    /// Name ID.
264    pub fn name_id(&self) -> NameId {
265        self.name_id.get()
266    }
267
268    /// String length (in bytes).
269    pub fn length(&self) -> u16 {
270        self.length.get()
271    }
272
273    /// String offset from start of storage area (in bytes).
274    pub fn string_offset(&self) -> Offset16 {
275        self.string_offset.get()
276    }
277}
278
279impl FixedSize for NameRecord {
280    const RAW_BYTE_LEN: usize = u16::RAW_BYTE_LEN
281        + u16::RAW_BYTE_LEN
282        + u16::RAW_BYTE_LEN
283        + NameId::RAW_BYTE_LEN
284        + u16::RAW_BYTE_LEN
285        + Offset16::RAW_BYTE_LEN;
286}
287
288#[cfg(feature = "experimental_traverse")]
289impl<'a> SomeRecord<'a> for NameRecord {
290    fn traverse(self, data: FontData<'a>) -> RecordResolver<'a> {
291        RecordResolver {
292            name: "NameRecord",
293            get_field: Box::new(move |idx, _data| match idx {
294                0usize => Some(Field::new("platform_id", self.platform_id())),
295                1usize => Some(Field::new("encoding_id", self.encoding_id())),
296                2usize => Some(Field::new("language_id", self.language_id())),
297                3usize => Some(Field::new("name_id", self.name_id())),
298                4usize => Some(Field::new("length", self.length())),
299                5usize => Some(Field::new("string_offset", self.traverse_string(_data))),
300                _ => None,
301            }),
302            data,
303        }
304    }
305}
read_fonts/generated/generated_name.rs

read_fonts/generated/
generated_name.rs
