parlance 0.1.0

Fundamental text property types
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
// Copyright 2025 the Parley Authors
// SPDX-License-Identifier: Apache-2.0 OR MIT

use core::fmt;
use core::str::FromStr;

/// A compact, zero-allocation language tag.
///
/// Parses the `language [-script] [-region]` prefix of a BCP 47 language tag.
///
/// This type captures only the `language` + optional `script` + optional `region` subtags from a
/// BCP 47 language tag. Parsing is case-insensitive; output is normalized to:
/// - language: 2–3 lowercase letters (e.g. `EN` → `en`)
/// - script: 4 titlecase letters (e.g. `LATN` → `Latn`)
/// - region: 2 uppercase letters or 3 digits (e.g. `us` → `US`, `419` → `419`)
///
/// Trailing subtags (variants, extensions, private use) are validated for basic structural
/// conformance but discarded. Extended language subtags (`extlang`) are not supported and will
/// error.
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
pub struct Language {
    bytes: [u8; 12],
    len: u8,
    language_len: u8,
    script_len: u8,
    region_len: u8,
}

impl Language {
    /// The maximum length of the canonical `language[-Script][-REGION]` form.
    pub const MAX_LEN: usize = 12;

    /// The “undefined” language (`und`).
    pub const UND: Self = Self::from_language_bytes(*b"und", 3);

    /// Parses a language tag, keeping only language/script/region.
    #[inline(always)]
    pub fn parse(s: &str) -> Result<Self, ParseLanguageError> {
        s.parse()
    }

    /// Parses the `language[-Script][-REGION]` prefix of a tag, returning the remainder.
    ///
    /// The remainder starts at the first unconsumed subtag (without a leading `-`/`_`). This can
    /// be used to inspect or process variants, extensions, or private-use subtags without forcing
    /// this type to model them.
    ///
    /// ```
    /// use parlance::Language;
    ///
    /// let (lang, rest) = Language::parse_prefix("tr-Latin-TR").unwrap();
    /// assert_eq!(lang.as_str(), "tr");
    /// assert_eq!(rest, "Latin-TR");
    /// ```
    pub fn parse_prefix(s: &str) -> Result<(Self, &str), ParseLanguageError> {
        let (lang, rest) = parse_language_prefix(s)?;
        // Normalize the remainder by dropping any leading separators.
        let rest = rest.trim_start_matches(['-', '_']);
        Ok((lang, rest))
    }

    /// Returns the canonical string form (`language[-Script][-REGION]`).
    #[must_use]
    #[inline(always)]
    pub fn as_str(&self) -> &str {
        core::str::from_utf8(&self.bytes[..self.len as usize]).expect("only ASCII")
    }

    /// Returns the primary language subtag (lowercase).
    #[must_use]
    #[inline(always)]
    pub fn language(&self) -> &str {
        core::str::from_utf8(&self.bytes[..self.language_len as usize]).expect("only ASCII")
    }

    /// Returns the script subtag (titlecase), if present.
    #[must_use]
    pub fn script(&self) -> Option<&str> {
        if self.script_len == 0 {
            return None;
        }
        let start = self.language_len as usize + 1;
        let end = start + self.script_len as usize;
        Some(core::str::from_utf8(&self.bytes[start..end]).expect("only ASCII"))
    }

    /// Returns the region subtag (uppercase or digits), if present.
    #[must_use]
    pub fn region(&self) -> Option<&str> {
        if self.region_len == 0 {
            return None;
        }
        let mut start = self.language_len as usize;
        if self.script_len != 0 {
            start += 1 + self.script_len as usize;
        }
        start += 1;
        let end = start + self.region_len as usize;
        Some(core::str::from_utf8(&self.bytes[start..end]).expect("only ASCII"))
    }

    const fn from_language_bytes(bytes: [u8; 3], len: u8) -> Self {
        let mut out = Self {
            bytes: [0; 12],
            len: 0,
            language_len: len,
            script_len: 0,
            region_len: 0,
        };
        out.bytes[0] = bytes[0];
        out.bytes[1] = bytes[1];
        out.bytes[2] = bytes[2];
        out.len = len;
        out
    }
}

fn parse_language_prefix(s: &str) -> Result<(Language, &str), ParseLanguageError> {
    let bytes = s.as_bytes();
    let mut pos = 0_usize;

    let (language_start, language_end) =
        next_part_bounds(s, &mut pos).ok_or(ParseLanguageError::InvalidLanguage)?;
    let language = &s[language_start..language_end];
    let language_bytes = language.as_bytes();
    if !(2..=3).contains(&language_bytes.len())
        || !language_bytes.iter().all(|b| b.is_ascii_alphabetic())
    {
        return Err(ParseLanguageError::InvalidLanguage);
    }

    let mut out = Language {
        bytes: [0; 12],
        len: 0,
        #[allow(
            clippy::cast_possible_truncation,
            reason = "language subtag length is 2 or 3"
        )]
        language_len: language_bytes.len() as u8,
        script_len: 0,
        region_len: 0,
    };

    // language: lower
    for (i, b) in language_bytes.iter().enumerate() {
        out.bytes[i] = b.to_ascii_lowercase();
    }
    out.len = out.language_len;

    // optional script or region
    let Some((start, end)) = next_part_bounds(s, &mut pos) else {
        return Ok((out, ""));
    };

    let b = &bytes[start..end];
    if b.len() == 4 {
        if !b.iter().all(|c| c.is_ascii_alphabetic()) {
            // BCP 47 variant: 4 alphanum starting with a digit.
            if is_variant(b) {
                return Ok((out, &s[start..]));
            }
            return Err(ParseLanguageError::InvalidScript);
        }
        out.bytes[out.len as usize] = b'-';
        out.len += 1;
        out.script_len = 4;
        // titlecase script
        out.bytes[out.len as usize] = b[0].to_ascii_uppercase();
        out.bytes[out.len as usize + 1] = b[1].to_ascii_lowercase();
        out.bytes[out.len as usize + 2] = b[2].to_ascii_lowercase();
        out.bytes[out.len as usize + 3] = b[3].to_ascii_lowercase();
        out.len += 4;
    } else if b.len() == 2 || b.len() == 3 {
        let is_alpha2 = b.len() == 2 && b.iter().all(|c| c.is_ascii_alphabetic());
        let is_digit3 = b.len() == 3 && b.iter().all(|c| c.is_ascii_digit());
        if !(is_alpha2 || is_digit3) {
            return Err(ParseLanguageError::InvalidRegion);
        }
        out.bytes[out.len as usize] = b'-';
        out.len += 1;
        #[allow(
            clippy::cast_possible_truncation,
            reason = "region subtag length is 2 or 3"
        )]
        {
            out.region_len = b.len() as u8;
        }
        if is_alpha2 {
            out.bytes[out.len as usize] = b[0].to_ascii_uppercase();
            out.bytes[out.len as usize + 1] = b[1].to_ascii_uppercase();
        } else {
            out.bytes[out.len as usize] = b[0];
            out.bytes[out.len as usize + 1] = b[1];
            out.bytes[out.len as usize + 2] = b[2];
        }
        out.len += out.region_len;
    } else {
        return Ok((out, &s[start..]));
    }

    // optional region (if not already set)
    if out.region_len != 0 {
        return Ok((out, &s[pos..]));
    }
    let Some((start, end)) = next_part_bounds(s, &mut pos) else {
        return Ok((out, ""));
    };
    let b = &bytes[start..end];
    if b.len() == 2 || b.len() == 3 {
        let is_alpha2 = b.len() == 2 && b.iter().all(|c| c.is_ascii_alphabetic());
        let is_digit3 = b.len() == 3 && b.iter().all(|c| c.is_ascii_digit());
        if !(is_alpha2 || is_digit3) {
            return Err(ParseLanguageError::InvalidRegion);
        }
        out.bytes[out.len as usize] = b'-';
        out.len += 1;
        #[allow(
            clippy::cast_possible_truncation,
            reason = "region subtag length is 2 or 3"
        )]
        {
            out.region_len = b.len() as u8;
        }
        if is_alpha2 {
            out.bytes[out.len as usize] = b[0].to_ascii_uppercase();
            out.bytes[out.len as usize + 1] = b[1].to_ascii_uppercase();
        } else {
            out.bytes[out.len as usize] = b[0];
            out.bytes[out.len as usize + 1] = b[1];
            out.bytes[out.len as usize + 2] = b[2];
        }
        out.len += out.region_len;
        Ok((out, &s[pos..]))
    } else {
        Ok((out, &s[start..]))
    }
}

fn next_part_bounds(s: &str, pos: &mut usize) -> Option<(usize, usize)> {
    let bytes = s.as_bytes();
    while *pos < bytes.len() && matches!(bytes[*pos], b'-' | b'_') {
        *pos += 1;
    }
    if *pos >= bytes.len() {
        return None;
    }
    let start = *pos;
    while *pos < bytes.len() && !matches!(bytes[*pos], b'-' | b'_') {
        *pos += 1;
    }
    let end = *pos;
    Some((start, end))
}

impl fmt::Debug for Language {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("Language").field(&self.as_str()).finish()
    }
}

impl fmt::Display for Language {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

/// An error returned when parsing a [`Language`] fails.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ParseLanguageError {
    /// The input did not contain a valid primary language subtag.
    InvalidLanguage,
    /// The script subtag was malformed or appeared in an invalid position.
    InvalidScript,
    /// The region subtag was malformed or appeared in an invalid position.
    InvalidRegion,
    /// The tag contained an invalid or unsupported subtag sequence.
    InvalidSubtag,
}

impl fmt::Display for ParseLanguageError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidLanguage => f.write_str("invalid primary language subtag"),
            Self::InvalidScript => f.write_str("invalid script subtag"),
            Self::InvalidRegion => f.write_str("invalid region subtag"),
            Self::InvalidSubtag => f.write_str("invalid language subtag sequence"),
        }
    }
}

impl core::error::Error for ParseLanguageError {}

impl FromStr for Language {
    type Err = ParseLanguageError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let (lang, rest) = parse_language_prefix(s)?;
        validate_remainder(rest)?;
        Ok(lang)
    }
}

fn validate_remainder(rest: &str) -> Result<(), ParseLanguageError> {
    #[derive(Clone, Copy)]
    enum State {
        Base,
        Extension,
        Private,
    }

    let mut state = State::Base;
    let mut needs_payload = false;

    for part in rest.split(['-', '_']).filter(|p| !p.is_empty()) {
        let bytes = part.as_bytes();

        match state {
            State::Base => {
                if is_variant(bytes) {
                    continue;
                }

                if bytes.len() == 1 && bytes[0].is_ascii_alphanumeric() {
                    state = if bytes[0].eq_ignore_ascii_case(&b'x') {
                        State::Private
                    } else {
                        State::Extension
                    };
                    needs_payload = true;
                    continue;
                }

                if bytes.len() == 4 && bytes.iter().all(|c| c.is_ascii_alphabetic()) {
                    return Err(ParseLanguageError::InvalidScript);
                }

                if bytes.len() == 2 && bytes.iter().all(|c| c.is_ascii_alphabetic()) {
                    return Err(ParseLanguageError::InvalidRegion);
                }

                if bytes.len() == 3 && bytes.iter().all(|c| c.is_ascii_digit()) {
                    return Err(ParseLanguageError::InvalidRegion);
                }

                return Err(ParseLanguageError::InvalidSubtag);
            }
            State::Extension => {
                if bytes.len() == 1 && bytes[0].is_ascii_alphanumeric() {
                    if needs_payload {
                        return Err(ParseLanguageError::InvalidSubtag);
                    }
                    state = if bytes[0].eq_ignore_ascii_case(&b'x') {
                        State::Private
                    } else {
                        State::Extension
                    };
                    needs_payload = true;
                    continue;
                }

                if (2..=8).contains(&bytes.len()) && bytes.iter().all(|b| b.is_ascii_alphanumeric())
                {
                    needs_payload = false;
                    continue;
                }

                return Err(ParseLanguageError::InvalidSubtag);
            }
            State::Private => {
                if (1..=8).contains(&bytes.len()) && bytes.iter().all(|b| b.is_ascii_alphanumeric())
                {
                    needs_payload = false;
                    continue;
                }
                return Err(ParseLanguageError::InvalidSubtag);
            }
        }
    }

    if needs_payload {
        return Err(ParseLanguageError::InvalidSubtag);
    }

    Ok(())
}

fn is_variant(bytes: &[u8]) -> bool {
    // BCP 47 variant: 5-8 alphanum or 4 alphanum starting with a digit.
    if bytes.len() == 4 {
        bytes[0].is_ascii_digit() && bytes.iter().all(|b| b.is_ascii_alphanumeric())
    } else if (5..=8).contains(&bytes.len()) {
        bytes.iter().all(|b| b.is_ascii_alphanumeric())
    } else {
        false
    }
}

#[cfg(test)]
mod tests {
    use super::{Language, ParseLanguageError};

    #[test]
    fn parse_language_only() {
        let lang = Language::parse("EN").unwrap();
        assert_eq!(lang.as_str(), "en");
        assert_eq!(lang.language(), "en");
        assert_eq!(lang.script(), None);
        assert_eq!(lang.region(), None);
    }

    #[test]
    fn parse_with_script_and_region() {
        let lang = Language::parse("zh-Hans-CN").unwrap();
        assert_eq!(lang.as_str(), "zh-Hans-CN");
        assert_eq!(lang.language(), "zh");
        assert_eq!(lang.script(), Some("Hans"));
        assert_eq!(lang.region(), Some("CN"));
    }

    #[test]
    fn parse_with_region_only() {
        let lang = Language::parse("es_419").unwrap();
        assert_eq!(lang.as_str(), "es-419");
        assert_eq!(lang.region(), Some("419"));
    }

    #[test]
    fn parse_ignores_variants_after_region() {
        let lang = Language::parse("en-Latn-US-posix").unwrap();
        assert_eq!(lang.as_str(), "en-Latn-US");
    }

    #[test]
    fn invalid_language_errors() {
        assert_eq!(
            Language::parse("").unwrap_err(),
            ParseLanguageError::InvalidLanguage
        );
        assert_eq!(
            Language::parse("e").unwrap_err(),
            ParseLanguageError::InvalidLanguage
        );
        assert_eq!(
            Language::parse("en1").unwrap_err(),
            ParseLanguageError::InvalidLanguage
        );
    }

    #[test]
    fn invalid_script_errors() {
        assert_eq!(
            Language::parse("en-La1n").unwrap_err(),
            ParseLanguageError::InvalidScript
        );
        assert_eq!(
            Language::parse("en-Latn-US-Latn").unwrap_err(),
            ParseLanguageError::InvalidScript
        );
    }

    #[test]
    fn invalid_region_errors() {
        assert_eq!(
            Language::parse("en-U1").unwrap_err(),
            ParseLanguageError::InvalidRegion
        );
        assert_eq!(
            Language::parse("en-Latn-US-CA").unwrap_err(),
            ParseLanguageError::InvalidRegion
        );
        assert_eq!(
            Language::parse("en-Latin-US").unwrap_err(),
            ParseLanguageError::InvalidRegion
        );
    }

    #[test]
    fn invalid_subtag_errors() {
        assert_eq!(
            Language::parse("en-abc$e").unwrap_err(),
            ParseLanguageError::InvalidSubtag
        );
    }

    #[test]
    fn parse_prefix_stops_at_unrecognized_subtag() {
        let (lang, rest) = Language::parse_prefix("tr-Latin-TR").unwrap();
        assert_eq!(lang.as_str(), "tr");
        assert_eq!(rest, "Latin-TR");
    }

    #[test]
    fn parse_prefix_returns_variants_and_extensions() {
        let (lang, rest) = Language::parse_prefix("en-Latn-US-posix-u-ca-gregory").unwrap();
        assert_eq!(lang.as_str(), "en-Latn-US");
        assert_eq!(rest, "posix-u-ca-gregory");
    }

    #[test]
    fn parse_4_char_digit_variant() {
        // BCP 47 variants can be 4 alphanumeric chars if they start with a digit.
        // These should be treated as variants (in remainder), not rejected as invalid scripts.
        let lang = Language::parse("de-1996").unwrap();
        assert_eq!(lang.as_str(), "de");
        assert_eq!(lang.script(), None);
        assert_eq!(lang.region(), None);

        // With script before the variant
        let lang = Language::parse("de-Latn-1996").unwrap();
        assert_eq!(lang.as_str(), "de-Latn");
        assert_eq!(lang.script(), Some("Latn"));

        // With region before the variant
        let lang = Language::parse("de-DE-1996").unwrap();
        assert_eq!(lang.as_str(), "de-DE");
        assert_eq!(lang.region(), Some("DE"));

        // parse_prefix should return the variant in the remainder
        let (lang, rest) = Language::parse_prefix("de-1996").unwrap();
        assert_eq!(lang.as_str(), "de");
        assert_eq!(rest, "1996");
    }
}