bamboo-core 0.3.1

Vietnamese input method engine written in Rust
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
use phf::{Map, phf_map};

use crate::input_method_def::InputMethodDef;
use crate::utils::{add_mark_to_toneless_char, add_tone_to_char, is_vowel};

/// Represents a Vietnamese tone mark.
#[repr(u8)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Tone {
    /// No tone (Ngang).
    None = 0,
    /// Grave accent (Huyền).
    Grave = 1,
    /// Acute accent (Sắc).
    Acute = 2,
    /// Hook above (Hỏi).
    Hook = 3,
    /// Tilde (Ngã).
    Tilde = 4,
    /// Dot below (Nặng).
    Dot = 5,
}

/// Represents a Vietnamese diacritic mark (marks that change the vowel/consonant).
#[repr(u8)]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Mark {
    /// No diacritic.
    None = 0,
    /// Circumflex (Â, Ê, Ô).
    Hat = 1,
    /// Breve (Ă).
    Breve = 2,
    /// Horn (Ư, Ơ).
    Horn = 3,
    /// Dash (Đ).
    Dash = 4,
    /// Special mark for raw character restoration.
    Raw = 5,
}

/// The type of transformation a rule applies.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum EffectType {
    /// Appends a character (standard typing).
    #[default]
    Appending = 0,
    /// Adds/changes a diacritic mark (e.g., a -> ă).
    MarkTransformation = 1,
    /// Adds/changes a tone mark (e.g., a -> á).
    ToneTransformation = 2,
    /// Replaces a character with another.
    Replacing = 3,
}

static TONES: Map<&'static str, Tone> = phf_map! {
    "XoaDauThanh" => Tone::None,
    "DauSac" => Tone::Acute,
    "DauHuyen" => Tone::Grave,
    "DauNga" => Tone::Tilde,
    "DauNang" => Tone::Dot,
    "DauHoi" => Tone::Hook,
};

/// A transformation rule that defines how a key press affects the composition.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct Rule {
    /// The key that triggers this rule.
    pub key: char,
    /// Effect value:
    /// - if `effect_type == ToneTransformation`: this is a [`Tone`] as `u8`
    /// - if `effect_type == MarkTransformation`: this is a [`Mark`] as `u8`
    pub effect: u8,
    /// The type of transformation to apply.
    pub effect_type: EffectType,
    /// The character that this rule targets (to be replaced or marked).
    pub effect_on: char,
    /// The resulting character after applying the transformation.
    pub result: char,
    /// Additional characters to append immediately after this one (used for multi-character shortcuts).
    pub appended: [char; 2],
    /// Number of characters in `appended`.
    pub appended_len: u8,
}

impl Rule {
    /// Sets the effect value from a [`Tone`].
    pub fn set_tone(&mut self, tone: Tone) {
        self.effect = tone as u8;
    }

    /// Sets the effect value from a [`Mark`].
    pub fn set_mark(&mut self, mark: Mark) {
        self.effect = mark as u8;
    }

    /// Retrieves the effect value as a [`Tone`].
    pub fn get_tone(&self) -> Tone {
        // Safety: effect is created by parser or engine.
        match self.effect {
            1 => Tone::Grave,
            2 => Tone::Acute,
            3 => Tone::Hook,
            4 => Tone::Tilde,
            5 => Tone::Dot,
            _ => Tone::None,
        }
    }

    /// Retrieves the effect value as a [`Mark`].
    pub fn get_mark(&self) -> Mark {
        match self.effect {
            1 => Mark::Hat,
            2 => Mark::Breve,
            3 => Mark::Horn,
            4 => Mark::Dash,
            5 => Mark::Raw,
            _ => Mark::None,
        }
    }
}

/// A collection of rules defining how keys transform text.
///
/// Use the provided static methods (e.g., [`InputMethod::telex()`]) to get
/// standard Vietnamese input methods.
#[derive(Clone, Debug, Default)]
pub struct InputMethod {
    /// The name of the input method.
    pub name: String,
    /// The complete list of transformation rules.
    pub rules: Vec<Rule>,
    /// Keys that can affect multiple vowels at once (e.g., 'w' in Telex).
    pub super_keys: Vec<char>,
    /// Keys that apply tone marks.
    pub tone_keys: Vec<char>,
    /// Keys that primarily append characters.
    pub appending_keys: Vec<char>,
    /// All keys that have at least one rule associated with them.
    pub keys: Vec<char>,
}

impl InputMethod {
    /// Standard Telex input method.
    pub fn telex() -> Self {
        parse_input_method("Telex")
    }

    /// Standard VNI input method (using number keys).
    pub fn vni() -> Self {
        parse_input_method("VNI")
    }

    /// Standard VIQR input method.
    pub fn viqr() -> Self {
        parse_input_method("VIQR")
    }

    /// Microsoft Standard Vietnamese keyboard layout.
    pub fn microsoft_layout() -> Self {
        parse_input_method("Microsoft layout")
    }

    /// Telex variant that also supports `[` and `]` keys.
    pub fn telex_2() -> Self {
        parse_input_method("Telex 2")
    }

    /// Combined Telex and VNI.
    pub fn telex_vni() -> Self {
        parse_input_method("Telex + VNI")
    }

    /// Combined Telex, VNI, and VIQR.
    pub fn telex_vni_viqr() -> Self {
        parse_input_method("Telex + VNI + VIQR")
    }

    /// VNI for French keyboard layouts.
    pub fn vni_french_layout() -> Self {
        parse_input_method("VNI Bàn phím tiếng Pháp")
    }

    /// Telex variant using `w` for marks and `z` for tone removal.
    pub fn telex_w() -> Self {
        parse_input_method("Telex W")
    }
}

/// Parse a known input method by name from the built-in definitions.
pub(crate) fn parse_input_method(im_name: &str) -> InputMethod {
    let defs = crate::input_method_def::get_input_method_definitions();
    defs.get(im_name).copied().map(|def| parse_input_method_def(im_name, def)).unwrap_or_default()
}

/// Parses an input method definition from its structured format.
pub(crate) fn parse_input_method_def(im_name: &str, im_def: &InputMethodDef) -> InputMethod {
    let mut im = InputMethod { name: im_name.to_string(), ..Default::default() };

    for (key_str, line) in im_def.entries() {
        let key = match key_str.chars().next() {
            Some(c) => c,
            None => continue,
        };

        im.rules.extend(parse_rules(key, line));

        if contains_uo_case_insensitive(line) {
            im.super_keys.push(key);
        }
        im.keys.push(key);
    }

    for rule in &im.rules {
        if rule.effect_type == EffectType::Appending {
            im.appending_keys.push(rule.key);
        }
        if rule.effect_type == EffectType::ToneTransformation {
            im.tone_keys.push(rule.key);
        }
    }

    im
}

#[inline]
fn contains_uo_case_insensitive(s: &str) -> bool {
    let mut prev_u = false;
    for c in s.chars() {
        let lc = c.to_ascii_lowercase();
        if prev_u && lc == 'o' {
            return true;
        }
        prev_u = lc == 'u';
    }
    false
}

/// Parses rules for a given key based on its definition line.
pub(crate) fn parse_rules(key: char, line: &str) -> Vec<Rule> {
    if let Some(tone) = TONES.get(line).copied() {
        return vec![Rule {
            key,
            effect_type: EffectType::ToneTransformation,
            effect: tone as u8,
            effect_on: '\0',
            result: '\0',
            appended: ['\0'; 2],
            appended_len: 0,
        }];
    }

    parse_toneless_rules(key, line)
}

/// Parses rules that don't involve tone transformations.
pub(crate) fn parse_toneless_rules(key: char, line: &str) -> Vec<Rule> {
    let lower = line.to_lowercase();

    if let Some((effective_ons, results, rest)) = parse_dsl(&lower) {
        let mut rules = Vec::new();
        for (effective_on, result) in effective_ons.into_iter().zip(results.into_iter()) {
            let Some(effect) = find_mark_from_char(result) else {
                continue;
            };
            rules.extend(parse_toneless_rule(key, effective_on, result, effect));
        }

        if let Some(rule) = get_appending_rule(key, rest) {
            rules.push(rule);
        }

        return rules;
    }

    if let Some(rule) = get_appending_rule(key, line) {
        return vec![rule];
    }

    Vec::new()
}

fn parse_toneless_rule(key: char, effective_on: char, result: char, effect: Mark) -> Vec<Rule> {
    let mut rules = Vec::new();

    for chr in get_mark_family(effective_on) {
        if chr == result {
            rules.push(Rule {
                key,
                effect_type: EffectType::MarkTransformation,
                effect: 0,
                effect_on: result,
                result: effective_on,
                appended: ['\0'; 2],
                appended_len: 0,
            });
            continue;
        }

        if is_vowel(chr) {
            for tone in 0u8..=5 {
                rules.push(Rule {
                    key,
                    effect_type: EffectType::MarkTransformation,
                    effect_on: add_tone_to_char(chr, tone),
                    effect: effect as u8,
                    result: add_tone_to_char(result, tone),
                    appended: ['\0'; 2],
                    appended_len: 0,
                });
            }
        } else {
            rules.push(Rule {
                key,
                effect_type: EffectType::MarkTransformation,
                effect_on: chr,
                effect: effect as u8,
                result,
                appended: ['\0'; 2],
                appended_len: 0,
            });
        }
    }

    rules
}

/// Parse: `([a-zA-Z]+)_(\p{L}+)([_\p{L}]*)`.
fn parse_dsl(s: &str) -> Option<(Vec<char>, Vec<char>, &str)> {
    let (left, right) = s.split_once('_')?;
    if left.is_empty() || !left.chars().all(|c| c.is_ascii_alphabetic()) {
        return None;
    }

    let mut results = Vec::new();
    let mut rest_start_byte = right.len();

    for (byte_idx, ch) in right.char_indices() {
        if ch.is_alphabetic() {
            results.push(ch);
            continue;
        }
        rest_start_byte = byte_idx;
        break;
    }

    if results.is_empty() {
        return None;
    }

    let rest = &right[rest_start_byte..];
    Some((left.chars().collect(), results, rest))
}

/// Parse: `(_?)_(\p{L}+)`.
fn get_appending_rule(key: char, value: &str) -> Option<Rule> {
    if !value.starts_with('_') {
        return None;
    }

    // "_x" or "__x" forms.
    let start = if value.starts_with("__") { 2 } else { 1 };
    let tail = value.get(start..)?;

    let mut letters = Vec::new();
    for ch in tail.chars() {
        if ch.is_alphabetic() {
            letters.push(ch);
        } else {
            break;
        }
    }

    let first = *letters.first()?;

    let mut appended = ['\0'; 2];
    let mut appended_len = 0u8;
    for &ch in letters.iter().skip(1) {
        if (appended_len as usize) < appended.len() {
            appended[appended_len as usize] = ch;
            appended_len += 1;
        }
    }

    Some(Rule {
        key,
        effect_type: EffectType::Appending,
        effect: 0,
        effect_on: first,
        result: first,
        appended,
        appended_len,
    })
}

fn get_mark_family(c: char) -> Vec<char> {
    let base = add_tone_to_char(c, 0);
    let canonical = add_mark_to_toneless_char(base, 0);

    // Marks are 0..=4 in utils' internal mark table.
    let mut family: Vec<char> =
        (0u8..=4).map(|m| add_mark_to_toneless_char(canonical, m)).collect();

    family.sort_unstable();
    family.dedup();
    family
}

fn find_mark_from_char(c: char) -> Option<Mark> {
    let c = c.to_lowercase().next().unwrap_or(c);
    let toneless = add_tone_to_char(c, 0);
    let base = add_mark_to_toneless_char(toneless, 0);

    for m in 0u8..=4 {
        if add_mark_to_toneless_char(base, m) == toneless {
            return Some(match m {
                1 => Mark::Hat,
                2 => Mark::Breve,
                3 => Mark::Horn,
                4 => Mark::Dash,
                _ => Mark::None,
            });
        }
    }

    None
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_tone_rules() {
        let rules = parse_rules('z', "XoaDauThanh");
        assert_eq!(rules.len(), 1);
        assert_eq!(rules[0].effect_type, EffectType::ToneTransformation);
        assert_eq!(rules[0].effect, Tone::None as u8);

        let rules = parse_rules('x', "DauNga");
        assert_eq!(rules.len(), 1);
        assert_eq!(rules[0].effect_type, EffectType::ToneTransformation);
        assert_eq!(rules[0].get_tone(), Tone::Tilde);
    }

    #[test]
    fn parse_toneless_rules_cases() {
        let rules = parse_toneless_rules('d', "D_Đ");
        assert_eq!(rules.len(), 2);
        assert_eq!(rules[0].effect_type, EffectType::MarkTransformation);
        assert_eq!(rules[0].effect, Mark::Dash as u8);
        assert_eq!(rules[0].effect_on, 'd');

        let rules = parse_toneless_rules('{', "");
        assert_eq!(rules.len(), 1);
        assert_eq!(rules[0].effect_type, EffectType::Appending);
        assert_eq!(rules[0].effect_on, 'Ư');

        let rules = parse_toneless_rules('w', "UOA_ƯƠĂ");
        assert_eq!(rules.len(), 33);
        assert_eq!(rules[0].effect_type, EffectType::MarkTransformation);
        assert_eq!(rules[0].get_mark(), Mark::Horn);
        assert_eq!(rules[0].effect_on, 'u');
        assert_eq!(rules[7].effect_type, EffectType::MarkTransformation);
        assert_eq!(rules[7].get_mark(), Mark::Horn);
        assert_eq!(rules[7].effect_on, 'o');
        assert_eq!(rules[20].effect_type, EffectType::MarkTransformation);
        assert_eq!(rules[20].get_mark(), Mark::Breve);
        assert_eq!(rules[20].effect_on, 'a');

        let rules = parse_toneless_rules('w', "UOA_ƯƠĂ__Ư");
        assert_eq!(rules.len(), 34);
        assert_eq!(rules[20].effect_type, EffectType::MarkTransformation);
        assert_eq!(rules[20].get_mark(), Mark::Breve);
        assert_eq!(rules[20].effect_on, 'a');
        assert_eq!(rules[33].effect_type, EffectType::Appending);
        assert_eq!(rules[33].effect_on, 'ư');
    }

    #[test]
    fn parse_append_rule() {
        let rules = parse_toneless_rules('[', "__ươ");
        assert_eq!(rules.len(), 1);
        let appended_len = rules[0].appended_len;
        assert_eq!(appended_len, 1);
        assert_eq!(rules[0].appended[0], 'ơ');

        let rules = parse_toneless_rules('{', "__ƯƠ");
        assert_eq!(rules.len(), 1);
        let appended_len = rules[0].appended_len;
        assert_eq!(appended_len, 1);
        assert_eq!(rules[0].appended[0], 'Ơ');
    }

    #[test]
    fn parse_input_method_super_key_detection() {
        let im = parse_input_method("Telex");
        assert!(im.super_keys.contains(&'w'));
    }

    #[test]
    fn parse_telex_o_hat_rule_exists() {
        // In Telex, typing 'o' after an existing 'o' should be able to mark it as 'ô'.
        let rules = parse_toneless_rules('o', "O_Ô");
        assert!(rules.iter().any(|r| {
            r.effect_type == EffectType::MarkTransformation
                && r.get_mark() == Mark::Hat
                && r.effect_on == 'o'
                && r.result == 'ô'
        }));
        assert!(!rules.iter().any(|r| r.effect_type == EffectType::Appending));
    }

    #[test]
    fn telex2_has_no_appending_rule_for_o() {
        let im = parse_input_method("Telex 2");
        let o_rules: Vec<_> = im.rules.iter().filter(|r| r.key == 'o').collect();
        assert!(!o_rules.is_empty());
        assert!(!o_rules.iter().any(|r| r.effect_type == EffectType::Appending));
    }
}