kanaria 0.2.0

This library provides functions such as hiragana, katakana, half-width and full-width mutual conversion and discrimination.
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
use std::char;
use std::slice::from_raw_parts;

use string::params::{ConvertParameter, ConvertType};
use string::params::ConvertType::*;
use utils::{AsciiUtils, KanaUtils, WidthUtils, CharExtend};

use crate::UCSChar;
use crate::utils::ConvertTarget;

pub struct UCSStr<T> where T: UCSChar {
    /// 変換対象文字列を保持します。
    pub(crate) target: Vec<T>,
    /// 変換時のパラメータを保持します。
    pub(crate) convert_params: Vec<ConvertParameter>,
}

impl UCSStr<u16> {
    /// 変換対象の文字列からUCSStr構造体を生成します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let result = UCSStr::from_str("こんにちは");
    /// ```
    pub fn from_str_u16<U>(s: &U) -> Self where U: AsRef<str> + ?Sized {
        Self {
            target: s.as_ref().encode_utf16().map(|scalar| u16::from_scalar(scalar )).collect::<Vec<u16>>(),
            convert_params: vec![],
        }
    }
}

impl UCSStr<u32> {
    /// 変換対象の文字列からUCSStr構造体を生成します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let result = UCSStr::from_str("こんにちは");
    /// ```
    pub fn from_str<U>(s: &U) -> Self where U: AsRef<str> + ?Sized {
        Self {
            target: s.as_ref().to_u32_vec(),
            convert_params: vec![],
        }
    }
}

impl<'a, T> UCSStr<T> where T: UCSChar {
    /// 変換対象の文字列からUCSStr構造体を生成します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let result = UCSStr::from_slice(target.as_slice());
    /// ```
    pub fn from_slice(source: &'a [T]) -> Self {
        Self {
            target: source.to_vec(),
            convert_params: vec![],
        }
    }

    /// 変換対象の文字列からUCSStr構造体を生成します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let result = unsafe { UCSStr::from_raw(target.as_ptr(), target.len()) };
    /// ```
    pub unsafe fn from_raw(source: *const T, len: usize) -> Self where T: UCSChar {
        Self::from_slice(from_raw_parts(source, len))
    }

    /// 文字列を大文字に変換するように設定します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['a', 'b', 'c'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .upper_case()
    ///     .to_vec();
    ///
    /// assert_eq!(result, vec!['A', 'B', 'C']);
    /// ```
    pub fn upper_case(&mut self) -> &mut Self {
        self.convert_params.push(ConvertParameter::from(UpperCase, ConvertTarget::ALL));
        return self;
    }

    /// 文字列を小文字に変換するように設定します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['A', 'B', 'C'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .lower_case()
    ///     .to_vec();
    ///
    /// assert_eq!(result, vec!['a', 'b', 'c']);
    /// ```
    pub fn lower_case(&mut self) -> &mut Self {
        self.convert_params.push(ConvertParameter::from(LowerCase, ConvertTarget::ALL));
        return self;
    }

    /// 文字列をひらがなに変換するように設定します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['ア', 'イ', 'ウ', 'エ', 'オ'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .hiragana()
    ///     .to_vec();
    ///
    /// assert_eq!(result, vec!['あ', 'い', 'う', 'え', 'お']);
    /// ```
    pub fn hiragana(&mut self) -> &mut Self {
        self.convert_params.push(ConvertParameter::from(Hiragana, ConvertTarget::ALL));
        return self;
    }

    /// 文字列を全角カタカナに変換するように設定します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .katakana()
    ///     .to_vec();
    ///
    /// assert_eq!(result, vec!['ア', 'イ', 'ウ', 'エ', 'オ']);
    /// ```
    pub fn katakana(&mut self) -> &mut Self {
        self.convert_params.push(ConvertParameter::from(Katakana, ConvertTarget::ALL));
        return self;
    }

    /// 文字列を全角に変換するように設定します。
    /// ConvertTargetフラグを利用することにより、全角に変換する文字種別を
    /// 数値、アルファベット、記号、カタカナのいずれか(複数指定可)に限定することが出来ます。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    /// use kanaria::utils::ConvertTarget;
    ///
    /// let target = vec!['フ', 'シ', '゙', 'サ', 'ン'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .wide(ConvertTarget::ALL)
    ///     .to_vec();
    ///
    /// assert_eq!(result.len(), 4);
    /// assert_eq!(result, vec!['フ','ジ','サ','ン']);
    ///
    /// let target2 = vec!['1', '2', '3', 'a', 'b', 'c'];
    /// let result2 = UCSStr::from_slice(target2.as_slice())
    ///     .wide(ConvertTarget::NUMBER)
    ///     .to_vec();
    ///
    /// assert_eq!(result2, vec!['1', '2', '3', 'a', 'b', 'c']);
    /// ```
    pub fn wide(&mut self, width_convert_target: ConvertTarget) -> &mut Self {
        self.convert_params.push(ConvertParameter::from(Wide, width_convert_target));
        return self;
    }

    /// 文字列を半角に変換するように設定します。
    /// ConvertTargetフラグを利用することにより、全角に変換する文字種別を
    /// 数値、アルファベット、記号、カタカナのいずれか(複数指定可)に限定することが出来ます。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    /// use kanaria::utils::ConvertTarget;
    ///
    /// let target = vec!['ガ', 'ギ', 'グ', 'ゲ', 'ゴ'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .narrow(ConvertTarget::ALL)
    ///     .to_vec();
    ///
    /// assert_eq!(result.len(), 10);
    /// assert_eq!(result, vec!['カ','゙','キ','゙','ク','゙','ケ','゙','コ','゙']);
    ///
    /// let target2 = vec!['1', '2', '3', 'A', 'B', 'C'];
    /// let result2 = UCSStr::from_slice(target2.as_slice())
    ///     .narrow(ConvertTarget::ALPHABET)
    ///     .to_vec();
    /// assert_eq!(result2, vec!['1', '2', '3', 'A', 'B', 'C']);
    /// ```
    pub fn narrow(&mut self, width_convert_target: ConvertTarget) -> &mut Self {
        self.convert_params.push(ConvertParameter::from(Narrow, width_convert_target));
        return self;
    }

    /// 文字列を変換せず、そのままとするように設定します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let result1 = UCSStr::from_slice(target.as_slice())
    ///     .none()
    ///     .to_vec();
    ///
    /// assert_eq!(result1, vec!['あ', 'い', 'う', 'え', 'お']);
    ///
    /// // カタカナに変換後、何もしない設定なのでカタカナに変換された文字が出てくる
    /// let result2 = UCSStr::from_slice(target.as_slice())
    ///     .katakana()
    ///     .none()
    ///     .to_vec();
    ///
    /// assert_eq!(result2, vec!['ア', 'イ', 'ウ', 'エ', 'オ']);
    /// ```
    pub fn none(&mut self) -> &mut Self {
        self.convert_params.push(ConvertParameter::from(None, ConvertTarget::ALL));
        return self;
    }

    /// 文字列を変換し、Stringとして返却します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .katakana()
    ///     .to_string();
    ///
    /// assert_eq!(result.as_str(), "アイウエオ")
    /// ```
    pub fn to_string(&self) -> String {
        let result_vec = self.to_vec();
        let mut result = String::with_capacity(result_vec.len());

        let mut iter = result_vec.iter();
        while let Some(cur_char_ptr) = iter.next() {
            let result_scalar = if cur_char_ptr.is_surrogate() {
                if let Some(next_char_ptr) = iter.next() {
                    Self::concat_surrogate(cur_char_ptr, next_char_ptr)
                } else {
                    u32::NULL
                }
            } else {
                cur_char_ptr.as_scalar()
            };

            if let Some(result_char) = char::from_u32(result_scalar) {
                result.push(result_char);
            }
        }

        return result;
    }

    /// 文字列を変換し、Vecとして返却します。
    ///
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let result = UCSStr::from_slice(target.as_slice())
    ///     .katakana()
    ///     .to_vec();
    ///
    /// assert_eq!(result, vec!['ア', 'イ', 'ウ', 'エ', 'オ'])
    /// ```
    pub fn to_vec(&self) -> Vec<T> {
        let mut buffer = self.target.clone();

        unsafe {
            self.convert_params.iter().for_each(|convert_param| {
                let len = if convert_param.convert_type == ConvertType::Narrow {
                    // 変換先が半角の場合文字数が増える可能性があるので2倍の領域を取る
                    buffer.len() * 2
                } else {
                    buffer.len()
                };

                let mut tmp = Vec::with_capacity(len);
                tmp.set_len(len);

                let dst_len: usize = Self::convert_raw(
                    buffer.as_ptr(),
                    tmp.as_mut_ptr(),
                    buffer.len(),
                    convert_param.convert_type,
                    convert_param.width_convert_target,
                );

                buffer = tmp.clone();
                buffer.set_len(dst_len);
            });
        }

        return buffer;
    }

    /// 文字列を変換し、Vecとして返却します。
    /// convert_typeがWideまたはNarrowの場合、convert_targetフラグを利用することにより、変換する文字種別を
    /// 数値、アルファベット、記号、カタカナのいずれか(複数指定可)に限定することが出来ます。
    /// WideまたはNarrow以外の場合、この設定値は無視されます。
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    /// use kanaria::string::ConvertType::Katakana;
    /// use kanaria::utils::ConvertTarget;
    /// use kanaria::string::ConvertType;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let result = UCSStr::convert(target.as_slice(), ConvertType::Katakana, ConvertTarget::ALL);
    ///
    /// assert_eq!(result, vec!['ア', 'イ', 'ウ', 'エ', 'オ'])
    /// ```
    pub fn convert(src: &[T], convert_type: ConvertType, convert_target: ConvertTarget) -> Vec<T> where T: UCSChar {
        let len = if convert_type == ConvertType::Narrow {
            src.len() * 2
        } else {
            src.len()
        };

        let mut result = Vec::with_capacity(len);
        unsafe {
            result.set_len(len);
            UCSStr::convert_raw(src.as_ptr(), result.as_mut_ptr(), src.len(), convert_type, convert_target);
        }

        return result;
    }

    /// 文字列を変換し、Vecとして返却します。
    /// convert_typeがWideまたはNarrowの場合、convert_targetフラグを利用することにより、変換する文字種別を
    /// 数値、アルファベット、記号、カタカナのいずれか(複数指定可)に限定することが出来ます。
    /// WideまたはNarrow以外の場合、この設定値は無視されます。
    /// # Examples
    ///
    /// ```
    /// use kanaria::string::UCSStr;
    /// use kanaria::string::ConvertType::Katakana;
    /// use kanaria::utils::ConvertTarget;
    ///
    /// let target = vec!['あ', 'い', 'う', 'え', 'お'];
    /// let mut result = Vec::with_capacity(target.len());
    /// unsafe {
    ///     result.set_len(target.len());
    ///     UCSStr::convert_raw(target.as_ptr(), result.as_mut_ptr(), target.len(), Katakana, ConvertTarget::ALL);
    /// }
    ///
    /// assert_eq!(result, vec!['ア', 'イ', 'ウ', 'エ', 'オ'])
    /// ```
    pub unsafe fn convert_raw(src_ptr: *const T, dst_ptr: *mut T, src_len: usize, convert_type: ConvertType, convert_target: ConvertTarget) -> usize where T: UCSChar {
        if convert_type == ConvertType::Narrow {
            Self::convert_internal_to_narrow(src_ptr, dst_ptr, src_len, convert_target)
        } else if convert_type == ConvertType::Wide {
            Self::convert_internal_to_wide(src_ptr, dst_ptr, src_len, convert_target)
        } else {
            match convert_type {
                UpperCase => Self::convert_internal(src_ptr, dst_ptr, src_len, AsciiUtils::convert_to_upper_case),
                LowerCase => Self::convert_internal(src_ptr, dst_ptr, src_len, AsciiUtils::convert_to_lower_case),
                Hiragana => Self::convert_internal(src_ptr, dst_ptr, src_len, KanaUtils::convert_to_hiragana),
                Katakana => Self::convert_internal(src_ptr, dst_ptr, src_len, KanaUtils::convert_to_katakana),
                _ => Self::convert_internal(src_ptr, dst_ptr, src_len, |dummy| {
                    dummy
                }),
            }
        }
    }

    /// コンバータを使用して文字列を変換します。
    unsafe fn convert_internal(src_ptr: *const T, dst_ptr: *mut T, len: usize, converter: fn(T) -> T) -> usize {
        let mut dst_ptr_offset: isize = 0;

        let accessor = from_raw_parts(src_ptr, len);
        accessor.iter()
            .map(|ptr| converter(*ptr))
            .for_each(|item| {
                dst_ptr.offset(dst_ptr_offset).write(item);
                dst_ptr_offset += 1;
            });

        return dst_ptr_offset as usize;
    }

    /// 半角文字列を全角に変換します。
    unsafe fn convert_internal_to_wide(src_ptr: *const T, dst_ptr: *mut T, len: usize, convert_target: ConvertTarget) -> usize {
        let mut dst_ptr_offset: isize = 0;

        let accessor = from_raw_parts(src_ptr, len);
        let mut iter = accessor.iter().enumerate();
        while let Some((index, current_ref)) = iter.next() {
            // 濁音・半濁音の結合処理のため、1つ先の文字も同時に取得する
            let current = *current_ref;
            let next = match accessor.get(index + 1) {
                Some(item_ref) => *item_ref,
                _ => T::NULL,
            };

            if Self::check_target_char(current, convert_target) {
                let (ret, is_pad) = WidthUtils::convert_to_wide(current, next);
                dst_ptr.offset(dst_ptr_offset).write(ret);
                dst_ptr_offset += 1;

                if is_pad {
                    // 結合済みの場合は次を読み飛ばす
                    iter.next();
                }
            } else {
                // 対象外の場合はそのまま書き込む
                dst_ptr.offset(dst_ptr_offset).write(current);
                dst_ptr_offset += 1;
            }
        }

        return dst_ptr_offset as usize;
    }

    /// 全角文字列を全角に変換します。
    unsafe fn convert_internal_to_narrow(src_ptr: *const T, dst_ptr: *mut T, len: usize, convert_target: ConvertTarget) -> usize where T: UCSChar {
        let mut dst_ptr_offset: isize = 0;

        let accessor = from_raw_parts(src_ptr, len);
        accessor.iter().for_each(|target| {
            if Self::check_target_char(*target, convert_target) {
                let (first_char, second_char) = WidthUtils::convert_to_narrow(*target);

                dst_ptr.offset(dst_ptr_offset).write(first_char);
                dst_ptr_offset += 1;

                if !second_char.is_null() {
                    // 2つ目の戻り値が0以外の場合は濁音・半濁音が入っているのでポインタに追記する
                    dst_ptr.offset(dst_ptr_offset).write(second_char);
                    dst_ptr_offset += 1;
                }
            } else {
                // 対象外の場合はそのまま書き込む
                dst_ptr.offset(dst_ptr_offset).write(*target);
                dst_ptr_offset += 1;
            }
        });

        return dst_ptr_offset as usize;
    }

    /// サロゲートペアとして分割されていた文字を結合します。
    fn concat_surrogate(cur_char_ptr: &T, next_char_ptr: &T) -> u32 where T: UCSChar {
        if cur_char_ptr.is_high_surrogate() {
            if next_char_ptr.is_low_surrogate() {
                0x10000 + (cur_char_ptr.as_scalar() - 0xD800) * 0x400 + (next_char_ptr.as_scalar() - 0xDC00)
            } else if next_char_ptr.is_null() {
                cur_char_ptr.as_scalar()
            } else {
                u32::NULL
            }
        } else if cur_char_ptr.is_low_surrogate() {
            if next_char_ptr.is_null() {
                cur_char_ptr.as_scalar()
            } else {
                u32::NULL
            }
        } else {
            u32::NULL
        }
    }

    /// 処理対象の文字かどうかをチェックします。
    fn check_target_char(target_char: T, convert_target: ConvertTarget) -> bool {
        Self::check_target_char_number(target_char, convert_target) || Self::check_target_char_alphabet(target_char, convert_target) ||
            Self::check_target_char_symbol(target_char, convert_target) || Self::check_target_char_katakana(target_char, convert_target)
    }

    /// 処理対象が数字かどうかをチェックします。
    fn check_target_char_number(target_char: T, convert_target: ConvertTarget) -> bool {
        convert_target.contains(ConvertTarget::NUMBER) && AsciiUtils::is_number(target_char)
    }

    /// 処理対象がアルファベットかどうかをチェックします。半角・全角、大文字・小文字は問いません。
    fn check_target_char_alphabet(target_char: T, convert_target: ConvertTarget) -> bool {
        convert_target.contains(ConvertTarget::ALPHABET) && (AsciiUtils::is_lower_case(target_char) || AsciiUtils::is_upper_case(target_char))
    }

    /// 処理対象が記号かどうかをチェックします。JIS記号も含みます。半角・全角は問いません。
    fn check_target_char_symbol(target_char: T, convert_target: ConvertTarget) -> bool {
        convert_target.contains(ConvertTarget::SYMBOL) && (AsciiUtils::is_ascii_symbol(target_char) || KanaUtils::is_jis_symbol(target_char))
    }

    /// 処理対象がカタカナかどうかをチェックします。半角・全角は問いません。
    fn check_target_char_katakana(target_char: T, convert_target: ConvertTarget) -> bool {
        convert_target.contains(ConvertTarget::KATAKANA) && KanaUtils::is_katakana(target_char)
    }
}