yosina 0.2.0

Japanese text transliteration library
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
use serde::{Deserialize, Serialize};
use std::borrow::Cow;
use std::collections::HashMap;
use std::sync::OnceLock;

use crate::char::{Char, CharPool};
use crate::transliterator::{Transliterator, TransliteratorFactory};
use crate::{TransliterationError, TransliteratorFactoryError};

use super::hira_kata_table::{HIRAGANA_KATAKANA_SMALL_TABLE, HIRAGANA_KATAKANA_TABLE};

/// Conversion mode for the transliterator
#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
#[derive(Default)]
pub enum Mode {
    /// Convert Hiragana to Katakana
    #[default]
    HiraToKata,
    /// Convert Katakana to Hiragana
    KataToHira,
}

/// Options for the hiragana katakana transliterator
#[derive(Debug, Default, Clone, PartialEq, Deserialize, Serialize)]
pub struct HiraKataTransliteratorOptions {
    /// Conversion mode
    #[serde(default)]
    pub mode: Mode,
}

impl TransliteratorFactory for HiraKataTransliteratorOptions {
    fn new_transliterator(&self) -> Result<Box<dyn Transliterator>, TransliteratorFactoryError> {
        Ok(Box::new(HiraKataTransliterator::new(self.clone())))
    }
}

#[derive(Debug, Clone)]
pub struct HiraKataTransliterator {
    mapping_table: &'static HashMap<&'static str, &'static str>,
}

// Static cache for mapping tables
static HIRA_TO_KATA_CACHE: OnceLock<HashMap<&'static str, &'static str>> = OnceLock::new();
static KATA_TO_HIRA_CACHE: OnceLock<HashMap<&'static str, &'static str>> = OnceLock::new();

impl HiraKataTransliterator {
    pub fn new(options: HiraKataTransliteratorOptions) -> Self {
        let mapping_table = match options.mode {
            Mode::HiraToKata => HIRA_TO_KATA_CACHE.get_or_init(Self::build_hira_to_kata_table),
            Mode::KataToHira => KATA_TO_HIRA_CACHE.get_or_init(Self::build_kata_to_hira_table),
        };
        Self { mapping_table }
    }

    fn build_hira_to_kata_table() -> HashMap<&'static str, &'static str> {
        let mut mapping = HashMap::new();

        // Main table mappings
        for entry in HIRAGANA_KATAKANA_TABLE {
            // Base character
            mapping.insert(entry.hiragana.base, entry.katakana.base);

            // Voiced character
            if let (Some(hira_voiced), Some(kata_voiced)) =
                (entry.hiragana.voiced, entry.katakana.voiced)
            {
                mapping.insert(hira_voiced, kata_voiced);
            }

            // Semi-voiced character
            if let (Some(hira_semivoiced), Some(kata_semivoiced)) =
                (entry.hiragana.semivoiced, entry.katakana.semivoiced)
            {
                mapping.insert(hira_semivoiced, kata_semivoiced);
            }
        }

        // Small character mappings
        for entry in HIRAGANA_KATAKANA_SMALL_TABLE {
            mapping.insert(entry.hiragana, entry.katakana);
        }

        mapping
    }

    fn build_kata_to_hira_table() -> HashMap<&'static str, &'static str> {
        let mut mapping = HashMap::new();

        // Main table mappings
        for entry in HIRAGANA_KATAKANA_TABLE {
            // Base character
            mapping.insert(entry.katakana.base, entry.hiragana.base);

            // Voiced character
            if let (Some(kata_voiced), Some(hira_voiced)) =
                (entry.katakana.voiced, entry.hiragana.voiced)
            {
                mapping.insert(kata_voiced, hira_voiced);
            }

            // Semi-voiced character
            if let (Some(kata_semivoiced), Some(hira_semivoiced)) =
                (entry.katakana.semivoiced, entry.hiragana.semivoiced)
            {
                mapping.insert(kata_semivoiced, hira_semivoiced);
            }
        }

        // Small character mappings
        for entry in HIRAGANA_KATAKANA_SMALL_TABLE {
            mapping.insert(entry.katakana, entry.hiragana);
        }

        mapping
    }
}

impl Transliterator for HiraKataTransliterator {
    fn transliterate<'a, 'b>(
        &self,
        pool: &mut CharPool<'a, 'b>,
        chars: &[&'a Char<'a, 'b>],
    ) -> Result<Vec<&'a Char<'a, 'b>>, TransliterationError> {
        let mut result = Vec::new();
        let mut offset = 0;

        for &ch in chars {
            if let Some(&mapped) = self.mapping_table.get(ch.c.as_ref()) {
                // Character needs to be converted
                let nc = pool.new_char_from(Cow::Borrowed(mapped), offset, ch);
                offset += nc.c.len();
                result.push(nc);
            } else {
                // Character passes through unchanged
                let nc = pool.new_with_offset(ch, offset);
                offset += nc.c.len();
                result.push(nc);
            }
        }

        Ok(result)
    }
}

pub struct HiraKataTransliteratorFactory(pub HiraKataTransliteratorOptions);

impl TransliteratorFactory for HiraKataTransliteratorFactory {
    fn new_transliterator(&self) -> Result<Box<dyn Transliterator>, TransliteratorFactoryError> {
        Ok(Box::new(HiraKataTransliterator::new(self.0.clone())))
    }
}

#[cfg(test)]
mod tests {
    use crate::char::from_chars;

    use super::*;

    #[test]
    fn test_hira_to_kata_basic() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("あいうえお");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "アイウエオ");
    }

    #[test]
    fn test_hira_to_kata_voiced() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("がぎぐげご");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ガギグゲゴ");
    }

    #[test]
    fn test_hira_to_kata_semi_voiced() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("ぱぴぷぺぽ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "パピプペポ");
    }

    #[test]
    fn test_hira_to_kata_small() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("ぁぃぅぇぉっゃゅょ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ァィゥェォッャュョ");
    }

    #[test]
    fn test_hira_to_kata_mixed() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("あいうえお123ABCアイウエオ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(
            from_chars(result.iter().cloned()),
            "アイウエオ123ABCアイウエオ"
        );
    }

    #[test]
    fn test_hira_to_kata_phrase() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("こんにちは、世界!");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "コンニチハ、世界!");
    }

    #[test]
    fn test_hira_to_kata_all_characters() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをんがぎぐげござじずぜぞだぢづでどばびぶべぼぱぴぷぺぽゔ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "アイウエオカキクケコサシスセソタチツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワヲンガギグゲゴザジズゼゾダヂヅデドバビブベボパピプペポヴ");
    }

    #[test]
    fn test_hira_to_kata_wi_we() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::HiraToKata,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("ゐゑ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ヰヱ");
    }

    #[test]
    fn test_kata_to_hira_basic() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("アイウエオ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "あいうえお");
    }

    #[test]
    fn test_kata_to_hira_voiced() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("ガギグゲゴ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "がぎぐげご");
    }

    #[test]
    fn test_kata_to_hira_semi_voiced() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("パピプペポ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ぱぴぷぺぽ");
    }

    #[test]
    fn test_kata_to_hira_small() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("ァィゥェォッャュョ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ぁぃぅぇぉっゃゅょ");
    }

    #[test]
    fn test_kata_to_hira_mixed() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("アイウエオ123ABCあいうえお");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(
            from_chars(result.iter().cloned()),
            "あいうえお123ABCあいうえお"
        );
    }

    #[test]
    fn test_kata_to_hira_phrase() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("コンニチハ、世界!");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "こんにちは、世界!");
    }

    #[test]
    fn test_kata_to_hira_vu() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "");
    }

    #[test]
    fn test_kata_to_hira_special_katakana() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        // Special katakana without hiragana equivalents should remain unchanged
        let input_chars = pool.build_char_array("ヷヸヹヺ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ヷヸヹヺ");
    }

    #[test]
    fn test_kata_to_hira_all_characters() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("アイウエオカキクケコサシスセソタチツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワヲンガギグゲゴザジズゼゾダヂヅデドバビブベボパピプペポヴ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわをんがぎぐげござじずぜぞだぢづでどばびぶべぼぱぴぷぺぽゔ");
    }

    #[test]
    fn test_kata_to_hira_wi_we() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("ヰヱ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ゐゑ");
    }

    #[test]
    fn test_kata_to_hira_small_wa_ka_ke() {
        let options = HiraKataTransliteratorOptions {
            mode: Mode::KataToHira,
        };
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("ヮヵヶ");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "ゎゕゖ");
    }

    #[test]
    fn test_default_mode() {
        // Test that default mode is HiraToKata
        let options = HiraKataTransliteratorOptions::default();
        let transliterator = HiraKataTransliterator::new(options);
        let mut pool = CharPool::new();

        let input_chars = pool.build_char_array("あいうえお");
        let result = transliterator
            .transliterate(&mut pool, &input_chars)
            .unwrap();
        assert_eq!(from_chars(result.iter().cloned()), "アイウエオ");
    }
}