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
//! 這個crate可以協助用戶在Rust專案中更方便的進行中文排序。
//!
//! 在Rust中,如果直接使用`sort()`系列function進行Vec的排序,非ASCII部分的文字會因為Unicode Hex Code的排序而混亂。
//!
//! 本crate提供了`sort_zh()` function 進行正確的排序(預設透過筆畫順序),用戶也可以利用`SortZhOptions`中的設定進行自定義排序。

use crate::UpperCaseOrder::*;
use crate::ZhNumberOption::*;
use chinese_number::{
    parse_chinese_number_to_i64, ChineseNumberCountMethod, ChineseNumberParseError, ChineseVariant,
    ChineseVariant::*,
};
use rust_icu_ucol::UCollator;
use std::str::Chars;

/// 排序選項
pub struct SortZhOptions {
    /// 繁體中文/簡體中文(預設為繁體中文)
    ///
    /// - 繁體中文使用ICU提供的中文台灣(zh_TW)Collate
    ///
    /// - 簡體中文使用ICU提供的中文中國(zh_CN)Collate
    pub variant: ChineseVariant,
    /// 中文數字選項(預設為透過筆畫排序)
    pub zh_number_option: ZhNumberOption,
}

/// 中文數字選項
#[derive(PartialEq)]
pub enum ZhNumberOption {
    /// 透過ICU預設方式排序
    ICUDefault,
    /// 透過中文含義排序(不排序大寫數字,不保證數字部分的排序相同)
    Definition,
    /// 透過中文含義排序(排序大寫數字,需指定大寫數字排序)
    DefinitionWithUpperCase(UpperCaseOrder),
}

/// 大寫數字排序選項
#[derive(PartialEq)]
pub enum UpperCaseOrder {
    /// 大寫數字排於小寫數字之前(例:`["壹", "貳", "一", "二"]`)
    Before,
    /// 大寫數字排於小寫數字之後(例:`["一", "二", "壹", "貳"]`)
    After,
}

impl Default for SortZhOptions {
    fn default() -> Self {
        SortZhOptions {
            variant: Traditional,
            zh_number_option: ZhNumberOption::default(),
        }
    }
}

impl Default for ZhNumberOption {
    fn default() -> Self {
        ICUDefault
    }
}

impl Default for UpperCaseOrder {
    fn default() -> Self {
        After
    }
}

static LOWERCASE_NUM: [char; 50] = [
    '零', '一', '二', '三', '四', '五', '六', '七', '八', '九', '十', '百', '千', '萬', '億', '兆',
    '京', '垓', '秭', '穰', '溝', '澗', '正', '載', '極', '零', '一', '二', '三', '四', '五', '六',
    '七', '八', '九', '十', '百', '千', '万', '亿', '兆', '京', '垓', '秭', '穰', '沟', '涧', '正',
    '载', '极',
];

static UPPERCASE_NUM: [char; 50] = [
    '零', '壹', '貳', '參', '肆', '伍', '陸', '柒', '捌', '玖', '拾', '佰', '仟', '萬', '億', '兆',
    '京', '垓', '秭', '穰', '溝', '澗', '正', '載', '極', '零', '壹', '贰', '参', '肆', '伍', '陆',
    '柒', '捌', '玖', '拾', '佰', '仟', '万', '亿', '兆', '京', '垓', '秭', '穰', '沟', '涧', '正',
    '载', '极',
];

pub trait SortZh {
    /// 中文排序
    /// ```
    /// use chinese_number::ChineseVariant::Traditional;
    /// use sort_zh::{SortZh, SortZhOptions, UpperCaseOrder::*, ZhNumberOption::*};
    /// let test = vec!["肆", "1", "一", "2", "二", "參", "正", "十二測試", "拾貳測試", "貳拾測試", "拾測試二", "十測試二"];
    /// // 僅透過ICU規範的Collate進行排序
    ///  assert_eq!(test.sort_zh(SortZhOptions::default()), vec!["1", "2", "一", "二", "十二測試", "十測試二", "正", "拾測試二", "拾貳測試", "參", "貳拾測試", "肆"]);
    /// // 中文數字部分使用中文代表的含義進行排序(不分大小寫),其他中文字透過ICU規範的Collate進行排序
    ///  assert_eq!(test.sort_zh(SortZhOptions { variant: Traditional, zh_number_option: Definition }), vec!["1", "2", "一", "二", "參", "肆", "拾測試二", "十測試二", "十二測試", "拾貳測試", "貳拾測試", "正"]);
    /// // 中文數字部分使用中文代表的含義進行排序(區分大小寫,將大寫數字排於小寫之前),其他中文字透過ICU規範的Collate進行排序
    ///  assert_eq!(test.sort_zh(SortZhOptions { variant: Traditional, zh_number_option: DefinitionWithUpperCase(Before) }), vec!["1", "2", "參", "肆", "拾測試二", "拾貳測試", "貳拾測試", "一", "二", "十測試二", "十二測試", "正"]);
    /// // 中文數字部分使用中文代表的含義進行排序(區分大小寫,將小寫數字排於大寫之前),其他中文字透過ICU規範的Collate進行排序
    ///  assert_eq!(test.sort_zh(SortZhOptions { variant: Traditional, zh_number_option: DefinitionWithUpperCase(After) }), vec!["1", "2", "一", "二", "十測試二", "十二測試", "參", "肆", "拾測試二", "拾貳測試", "貳拾測試", "正"]);
    /// ```
    fn sort_zh(&self, options: SortZhOptions) -> Vec<&str>;
}

impl SortZh for Vec<&str> {
    fn sort_zh(&self, options: SortZhOptions) -> Vec<&str> {
        let collator = match options.variant {
            Traditional => UCollator::try_from("zh-TW"),
            Simple => UCollator::try_from("zh-CN"),
        }
        .expect("Could not make collator.");

        let orig_vec = self.clone();
        let mut ascii_word_vec: Vec<(usize, &str)> = Vec::new();
        let mut zh_upper_number_vec: Vec<(usize, i64)> = Vec::new();
        let mut zh_lower_number_vec: Vec<(usize, i64)> = Vec::new();
        let mut zh_word_vec: Vec<(usize, &str)> = Vec::new();

        self.iter().enumerate().for_each(|(i, element)| {
            let chars = element.chars();
            if chars.clone().peekable().peek().unwrap().is_ascii() {
                ascii_word_vec.push((i, element))
            } else {
                let zh_number_option = &options.zh_number_option;
                match zh_number_option {
                    ICUDefault => zh_word_vec.push((i, element)),
                    Definition | DefinitionWithUpperCase(_) => match parse_zh_number(chars.clone())
                    {
                        (upper_case, Ok(parsed)) => {
                            if zh_number_option == &DefinitionWithUpperCase(Before)
                                || zh_number_option == &DefinitionWithUpperCase(After)
                            {
                                if !upper_case {
                                    zh_lower_number_vec.push((i, parsed))
                                } else if upper_case {
                                    zh_upper_number_vec.push((i, parsed))
                                } else {
                                    zh_word_vec.push((i, element))
                                }
                            } else {
                                zh_lower_number_vec.push((i, parsed))
                            }
                        }
                        (_, Err(_)) => zh_word_vec.push((i, element)),
                    },
                }
            }
        });

        let mut final_vec = sort_ascii_word(ascii_word_vec);
        final_vec.append(&mut sort_zh_number(
            zh_upper_number_vec,
            zh_lower_number_vec,
            options.zh_number_option,
        ));
        final_vec.append(&mut sort_zh_word(zh_word_vec, collator));

        final_vec
            .into_iter()
            .map(|i| orig_vec[i])
            .collect::<Vec<&str>>()
    }
}

fn parse_zh_number(chars: Chars) -> (bool, Result<i64, ChineseNumberParseError>) {
    let mut upper_case = false;
    let mut zh_number_size = 1_usize;
    chars.clone().enumerate().for_each(|(i, char)| {
        if i == 0_usize && UPPERCASE_NUM.contains(&char) {
            upper_case = true
        }
        if !UPPERCASE_NUM.contains(&char) && !LOWERCASE_NUM.contains(&char) {
            zh_number_size = (i as u32 - 1) as usize;
        }
    });
    (
        upper_case,
        parse_chinese_number_to_i64(
            ChineseNumberCountMethod::TenThousand,
            String::from_iter(chars.collect::<Vec<char>>()[0..zh_number_size].iter()),
        ),
    )
}

fn sort_ascii_word(mut ascii_word_vec: Vec<(usize, &str)>) -> Vec<usize> {
    ascii_word_vec.sort_unstable_by(|(_, a), (_, b)| a.cmp(b));
    let (processed_ascii_word, _): (Vec<usize>, Vec<_>) = ascii_word_vec.into_iter().unzip();
    processed_ascii_word
}

fn sort_zh_number(
    mut zh_upper_number_vec: Vec<(usize, i64)>,
    mut zh_lower_number_vec: Vec<(usize, i64)>,
    zh_number_option: ZhNumberOption,
) -> Vec<usize> {
    zh_upper_number_vec.sort_unstable_by(|(_, a_value), (_, b_value)| a_value.cmp(b_value));
    zh_lower_number_vec.sort_unstable_by(|(_, a_value), (_, b_value)| a_value.cmp(b_value));
    let (mut zh_upper_number_vec, _): (Vec<usize>, Vec<_>) =
        zh_upper_number_vec.into_iter().unzip();
    let (mut zh_lower_number_vec, _): (Vec<usize>, Vec<_>) =
        zh_lower_number_vec.into_iter().unzip();
    match zh_number_option {
        DefinitionWithUpperCase(upper_case_order) => match upper_case_order {
            Before => {
                zh_upper_number_vec.append(&mut zh_lower_number_vec);
                zh_upper_number_vec
            }
            After => {
                zh_lower_number_vec.append(&mut zh_upper_number_vec);
                zh_lower_number_vec
            }
        },
        _ => zh_lower_number_vec,
    }
}

fn sort_zh_word(mut zh_word_vec: Vec<(usize, &str)>, collator: UCollator) -> Vec<usize> {
    zh_word_vec.sort_unstable_by(|(_, a_value), (_, b_value)| {
        collator
            .strcoll_utf8(a_value, b_value)
            .expect("Failed to collate with collator.")
    });
    let (index_vec, _): (Vec<usize>, Vec<_>) = zh_word_vec.into_iter().unzip();
    index_vec
}

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

    const TEST_VALUE: [&str; 12] = [
        "肆",
        "1",
        "一",
        "2",
        "二",
        "參",
        "正",
        "十二測試",
        "拾貳測試",
        "貳拾測試",
        "拾測試二",
        "十測試二",
    ];

    #[test]
    fn icu_default() {
        let test = TEST_VALUE.to_vec();
        let result = test.sort_zh(SortZhOptions::default());
        assert_eq!(
            result,
            vec![
                "1",
                "2",
                "一",
                "二",
                "十二測試",
                "十測試二",
                "正",
                "拾測試二",
                "拾貳測試",
                "參",
                "貳拾測試",
                "肆"
            ]
        );
    }

    #[test]
    fn definition() {
        let test = TEST_VALUE.to_vec();
        let result = test.sort_zh(SortZhOptions {
            variant: Traditional,
            zh_number_option: Definition,
        });
        assert_eq!(
            result,
            vec![
                "1",
                "2",
                "一",
                "二",
                "參",
                "肆",
                "拾測試二",
                "十測試二",
                "十二測試",
                "拾貳測試",
                "貳拾測試",
                "正"
            ]
        );
    }

    #[test]
    fn definition_with_upper_case_before() {
        let test = TEST_VALUE.to_vec();
        let result = test.sort_zh(SortZhOptions {
            variant: Traditional,
            zh_number_option: DefinitionWithUpperCase(Before),
        });
        assert_eq!(
            result,
            vec![
                "1",
                "2",
                "參",
                "肆",
                "拾測試二",
                "拾貳測試",
                "貳拾測試",
                "一",
                "二",
                "十測試二",
                "十二測試",
                "正"
            ]
        );
    }

    #[test]
    fn definition_with_upper_case_after() {
        let test = TEST_VALUE.to_vec();
        let result = test.sort_zh(SortZhOptions {
            variant: Traditional,
            zh_number_option: DefinitionWithUpperCase(After),
        });
        assert_eq!(
            result,
            vec![
                "1",
                "2",
                "一",
                "二",
                "十測試二",
                "十二測試",
                "參",
                "肆",
                "拾測試二",
                "拾貳測試",
                "貳拾測試",
                "正"
            ]
        );
    }
}