zhconv 0.4.1

Traditional, Simplified and regional Chinese variants converter powered by MediaWiki & OpenCC rulesets and the Aho-Corasick algorithm 中文简繁及地區詞轉換
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

//! Built-in conversion tables sourced from [zhConversion.php](https://phabricator.wikimedia.org/source/mediawiki/browse/master/includes/languages/Data/ZhConversion.php)
//! (maintained by MediaWiki and Chinese Wikipedia) and [OpenCC](https://github.com/BYVoid/OpenCC/tree/master/data/dictionary).
//!
// // ! # Note
// // ! Region specific conversion tables exclude basic rulesets such as `zh-Hant` or `zh-Hans`. They
// // ! should not be used on their own. For example, to convert text to `zh-TW` (i.e. `zh-Hant-TW`),
// // ! both [`ZH_HANT_TABLE`] and [`ZH_TW_TABLE`] should specified together, in order, when building
// // ! the converter.
use std::iter;

use crate::converter::{ZhConverter, ZhConverterBuilder};
use crate::Variant;

pub type Table<'s> = (&'s str, &'s str);
// pub(crate) const EMPTY_DAAC: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/empty.daac"));

/// Empty table
pub const ZH_TABLE: Table<'static> = ("", "");
pub(crate) const ZH_TABLES: [Table; 0] = [];
/// Simplified Chinese to Traditional Chinese conversion table, including no region-specific phrases
#[cfg(any(
    feature = "mediawiki-hant",
    feature = "opencc-hant",
    feature = "mediawiki-tw",
    feature = "opencc-tw",
    feature = "mediawiki-hk",
    feature = "opencc-hk",
))]
pub const ZH_HANT_TABLE: Table<'static> = (
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_HANT.from.conv")),
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_HANT.to.conv")),
);
#[cfg(any(feature = "mediawiki-hant", feature = "opencc-hant"))]
pub(crate) const ZH_HANT_TABLES: [Table; 1] = [ZH_HANT_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-hant", feature = "opencc-hant"))]
pub(crate) const ZH_HANT_DAAC: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/ZH_TO_HANT.daac"));

/// Traditional Chinese to Simplified Chinese conversion table, including no region-specific phrases
#[cfg(any(
    feature = "mediawiki-hans",
    feature = "opencc-hans",
    feature = "mediawiki-cn",
    feature = "opencc-cn",
))]
pub const ZH_HANS_TABLE: Table<'static> = (
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_HANS.from.conv")),
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_HANS.to.conv")),
);
#[cfg(any(feature = "mediawiki-hans", feature = "opencc-hans"))]
pub(crate) const ZH_HANS_TABLES: [Table; 1] = [ZH_HANS_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-hans", feature = "opencc-hans"))]
pub(crate) const ZH_HANS_DAAC: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/ZH_TO_HANS.daac"));
/// Taiwan-specific phrases conversion table, excluding `ZH_HANT_TABLE`
#[cfg(any(feature = "mediawiki-tw", feature = "opencc-tw"))]
pub const ZH_TW_TABLE: Table<'static> = (
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_TW.from.conv")),
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_TW.to.conv")),
);
#[cfg(any(feature = "mediawiki-tw", feature = "opencc-tw"))]
pub(crate) const ZH_HANT_TW_TABLES: [Table; 2] = [ZH_HANT_TABLE, ZH_TW_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-tw", feature = "opencc-tw"))]
pub(crate) const ZH_HANT_TW_DAAC: &[u8] =
    include_bytes!(concat!(env!("OUT_DIR"), "/ZH_TO_HANT_TW.daac"));
/// Hong Kong-specific phrases conversion table, excluding `ZH_HANT_TABLE`
#[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
pub const ZH_HK_TABLE: Table<'static> = (
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_HK.from.conv")),
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_HK.to.conv")),
);
#[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
pub(crate) const ZH_HANT_HK_TABLES: [Table; 2] = [ZH_HANT_TABLE, ZH_HK_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
pub(crate) const ZH_HANT_HK_DAAC: &[u8] =
    include_bytes!(concat!(env!("OUT_DIR"), "/ZH_TO_HANT_HK.daac"));
/// Macao-specific phrases conversion table, excluding `ZH_HANT_TABLE`
#[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
pub const ZH_MO_TABLE: Table<'static> = ZH_HK_TABLE;
#[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
pub(crate) const ZH_HANT_MO_TABLES: [Table; 2] = [ZH_HANT_TABLE, ZH_MO_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
pub(crate) const ZH_HANT_MO_DAAC: &[u8] = ZH_HANT_HK_DAAC;
/// Mainland China-specific phrases conversion table, excluding `ZH_HANS_TABLE`
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub const ZH_CN_TABLE: Table<'static> = (
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_CN.from.conv")),
    include_str!(concat!(env!("OUT_DIR"), "/ZH_TO_CN.to.conv")),
);
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub(crate) const ZH_HANS_CN_TABLES: [Table; 2] = [ZH_HANS_TABLE, ZH_CN_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub(crate) const ZH_HANS_CN_DAAC: &[u8] =
    include_bytes!(concat!(env!("OUT_DIR"), "/ZH_TO_HANS_CN.daac"));
/// Singapore-specific phrases conversion table, excluding `ZH_HANS_TABLE`
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub const ZH_SG_TABLE: Table<'static> = ZH_CN_TABLE;
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub(crate) const ZH_HANS_SG_TABLES: [Table; 2] = [ZH_HANS_TABLE, ZH_SG_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub(crate) const ZH_HANS_SG_DAAC: &[u8] = ZH_HANS_CN_DAAC;
/// Malaysia-specific phrases conversion table, excluding `ZH_HANS_TABLE`
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub const ZH_MY_TABLE: Table<'static> = ZH_SG_TABLE;
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub(crate) const ZH_HANS_MY_TABLES: [Table; 2] = [ZH_HANS_TABLE, ZH_MY_TABLE];
#[doc(hidden)]
#[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
pub(crate) const ZH_HANS_MY_DAAC: &[u8] = ZH_HANS_SG_DAAC;

/// Expand a built-in conversion table.
///
/// Tables are compressed for space efficiency. This behavior is independent of the `compress`
/// feature, which only controls the compression of serialized
/// [automata](https://docs.rs/daachorse).
pub fn expand_table((froms, tos): Table<'_>) -> impl Iterator<Item = (String, String)> + '_ {
    std::iter::zip(froms.trim().split('|'), tos.trim().split('|')).scan(
        String::from(""),
        move |last_from, (from, to)| {
            let from: String = pair_expand(from.chars(), last_from.chars()).collect();
            let to: String = pair_expand(to.chars(), from.chars()).collect();
            last_from.clear();
            last_from.push_str(&from);
            Some((from, to))
        },
    )
}

const SURROGATE_START: u32 = 0x00;
const SURROGATE_END: u32 = 0x20;

#[doc(hidden)]
pub fn pair_expand<'s>(
    mut s: impl Iterator<Item = char> + 's,
    mut base: impl Iterator<Item = char> + 's,
) -> impl Iterator<Item = char> + 's {
    let mut expanding = 0;
    iter::from_fn(move || {
        let b = base.next();
        if expanding == 0 {
            match s.next() {
                Some(a) if (a as u32) < SURROGATE_END => expanding = a as u32 - SURROGATE_START,
                Some(a) => return Some(a),
                None => return None,
            }
        }
        expanding -= 1;
        Some(b.expect("shrunken rulesets should be well-formed"))
    })
}

/// Helper function to build a `ZhConverter` from a conversion table.
///
/// It is just a simple wrapper around [`ZhConverterBuilder`](crate::ZhConverterBuilder).
#[doc(hidden)]
pub fn build_converter(variant: Variant, table: Table<'_>) -> ZhConverter {
    ZhConverterBuilder::new()
        .target(variant)
        .table(table)
        .build()
}

/// Get the builtin conversion tables for a target Chinese variant.
///
/// Accessing raw tables are only useful when building a custom converter.
/// Otherwise, there is [`get_builtin_converter`](crate::get_builtin_converter).
#[inline(always)]
pub fn get_builtin_tables(target: Variant) -> &'static [Table<'static>] {
    use Variant::*;

    match target {
        Zh => &ZH_TABLES,
        #[cfg(any(feature = "mediawiki-hant", feature = "opencc-hant"))]
        ZhHant => &ZH_HANT_TABLES,
        #[cfg(any(feature = "mediawiki-hans", feature = "opencc-hans"))]
        ZhHans => &ZH_HANS_TABLES,
        #[cfg(any(feature = "mediawiki-tw", feature = "opencc-tw"))]
        ZhTW => &ZH_HANT_TW_TABLES,
        #[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
        ZhHK => &ZH_HANT_HK_TABLES,
        #[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
        ZhMO => &ZH_HANT_MO_TABLES,
        #[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
        ZhCN => &ZH_HANS_CN_TABLES,
        #[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
        ZhMY => &ZH_HANS_MY_TABLES,
        #[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
        ZhSG => &ZH_HANS_SG_TABLES,
        #[allow(unreachable_patterns)]
        _ => panic!("No tables for {} enabled.", target),
    }
}

#[doc(hidden)]
#[inline(always)]
pub fn get_builtin_serialized_daac(target: Variant) -> &'static [u8] {
    use Variant::*;

    match target {
        Zh => unreachable!(),
        #[cfg(any(feature = "mediawiki-hant", feature = "opencc-hant"))]
        ZhHant => ZH_HANT_DAAC,
        #[cfg(any(feature = "mediawiki-hans", feature = "opencc-hans"))]
        ZhHans => ZH_HANS_DAAC,
        #[cfg(any(feature = "mediawiki-tw", feature = "opencc-tw"))]
        ZhTW => ZH_HANT_TW_DAAC,
        #[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
        ZhHK => ZH_HANT_HK_DAAC,
        #[cfg(any(feature = "mediawiki-hk", feature = "opencc-hk"))]
        ZhMO => ZH_HANT_MO_DAAC,
        #[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
        ZhCN => ZH_HANS_CN_DAAC,
        #[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
        ZhMY => ZH_HANS_MY_DAAC,
        #[cfg(any(feature = "mediawiki-cn", feature = "opencc-cn"))]
        ZhSG => ZH_HANS_SG_DAAC,
        #[allow(unreachable_patterns)]
        _ => panic!("No daac for {} enabled.", target),
    }
}

// https://github.com/wikimedia/mediawiki/blob/6eda8891a0595e72e350998b6bada19d102a42d9/includes/language/converters/ZhConverter.php#L144