3 * Library to deal with pinyin.
5 * Copyright (C) 2011 Peng Wu <alexepico@gmail.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include "pinyin_parser2.h"
28 #include "pinyin_phrase2.h"
29 #include "pinyin_custom2.h"
30 #include "chewing_key.h"
31 #include "pinyin_parser_table.h"
32 #include "double_pinyin_table.h"
33 #include "chewing_table.h"
36 using namespace pinyin;
38 static bool check_pinyin_options(guint32 options, const pinyin_index_item_t * item) {
39 guint32 flags = item->m_flags;
40 assert (flags & IS_PINYIN);
42 /* handle incomplete pinyin. */
43 if (flags & PINYIN_INCOMPLETE) {
44 if (!(options & PINYIN_INCOMPLETE))
48 /* handle correct pinyin, currently only one flag per item. */
49 flags &= PINYIN_CORRECT_ALL;
50 options &= PINYIN_CORRECT_ALL;
53 if ((flags & options) != flags)
60 static bool check_chewing_options(guint32 options, const chewing_index_item_t * item) {
61 guint32 flags = item->m_flags;
62 assert (flags & IS_CHEWING);
64 /* handle incomplete chewing. */
65 if (flags & CHEWING_INCOMPLETE) {
66 if (!(options & CHEWING_INCOMPLETE))
74 /* methods for Chewing Keys to access pinyin parser table. */
75 const char * ChewingKeyRest::get_pinyin_string(){
76 if (m_table_index == 0)
79 /* check end boundary. */
80 assert(m_table_index < G_N_ELEMENTS(content_table));
81 return content_table[m_table_index].m_pinyin_str;
84 const char * ChewingKeyRest::get_chewing_string(){
85 if (m_table_index == 0)
88 /* check end boundary. */
89 assert(m_table_index < G_N_ELEMENTS(content_table));
90 return content_table[m_table_index].m_chewing_str;
96 /* internal information for pinyin parsers. */
99 ChewingKeyRest m_key_rest;
113 const guint16 max_full_pinyin_length = 7; /* include tone. */
115 const guint16 max_double_pinyin_length = 3; /* include tone. */
117 const guint16 max_chewing_length = 4; /* include tone. */
119 static bool compare_pinyin_less_than(const pinyin_index_item_t & lhs,
120 const pinyin_index_item_t & rhs){
121 return 0 > strcmp(lhs.m_pinyin_input, rhs.m_pinyin_input);
124 static inline bool search_pinyin_index(guint32 options, const char * pinyin,
126 ChewingKeyRest & key_rest){
127 pinyin_index_item_t item;
128 memset(&item, 0, sizeof(item));
129 item.m_pinyin_input = pinyin;
131 std_lite::pair<const pinyin_index_item_t *,
132 const pinyin_index_item_t *> range;
133 range = std_lite::equal_range
134 (pinyin_index, pinyin_index + G_N_ELEMENTS(pinyin_index),
135 item, compare_pinyin_less_than);
137 guint16 range_len = range.second - range.first;
138 assert(range_len <= 1);
139 if (range_len == 1) {
140 const pinyin_index_item_t * index = range.first;
142 if (!check_pinyin_options(options, index))
145 key_rest.m_table_index = index->m_table_index;
146 key = content_table[key_rest.m_table_index].m_chewing_key;
153 static bool compare_chewing_less_than(const chewing_index_item_t & lhs,
154 const chewing_index_item_t & rhs){
155 return 0 > strcmp(lhs.m_chewing_input, rhs.m_chewing_input);
158 static inline bool search_chewing_index(guint32 options, const char * chewing,
160 ChewingKeyRest & key_rest){
161 chewing_index_item_t item;
162 memset(&item, 0, sizeof(item));
163 item.m_chewing_input = chewing;
165 std_lite::pair<const chewing_index_item_t *,
166 const chewing_index_item_t *> range;
167 range = std_lite::equal_range
168 (chewing_index, chewing_index + G_N_ELEMENTS(chewing_index),
169 item, compare_chewing_less_than);
171 guint16 range_len = range.second - range.first;
172 assert (range_len <= 1);
174 if (range_len == 1) {
175 const chewing_index_item_t * index = range.first;
177 if (!check_chewing_options(options, index))
180 key_rest.m_table_index = index->m_table_index;
181 key = content_table[key_rest.m_table_index].m_chewing_key;
188 /* Full Pinyin Parser */
189 FullPinyinParser2::FullPinyinParser2 (){
190 m_parse_steps = g_array_new(TRUE, FALSE, sizeof(parse_value_t));
194 bool FullPinyinParser2::parse_one_key (guint32 options, ChewingKey & key,
195 ChewingKeyRest & key_rest,
196 const char * pinyin, int len) const {
197 /* "'" are not accepted in parse_one_key. */
198 assert(NULL == strchr(pinyin, '\''));
199 gchar * input = g_strndup(pinyin, len);
201 guint16 tone = CHEWING_ZERO_TONE; guint16 tone_pos = 0;
202 guint16 parsed_len = len;
203 key = ChewingKey(); key_rest = ChewingKeyRest();
205 if (options & USE_TONE) {
206 /* find the tone in the last character. */
207 char chr = input[parsed_len - 1];
208 if ( '0' < chr && chr <= '5' ) {
211 tone_pos = parsed_len;
215 /* parse pinyin core staff here. */
217 /* Note: optimize here? */
218 input[parsed_len] = '\0';
219 if (!search_pinyin_index(options, input, key, key_rest))
222 if (options & USE_TONE) {
223 /* post processing tone. */
224 if ( parsed_len == tone_pos ) {
225 if (tone != CHEWING_ZERO_TONE) {
232 key_rest.m_raw_begin = 0; key_rest.m_raw_end = parsed_len;
234 return parsed_len == len;
238 int FullPinyinParser2::parse (guint32 options, ChewingKeyVector & keys,
239 ChewingKeyRestVector & key_rests,
240 const char *str, int len) const {
243 g_array_set_size(keys, 0);
244 g_array_set_size(key_rests, 0);
246 /* init m_parse_steps, and prepare dynamic programming. */
247 int step_len = len + 1;
248 g_array_set_size(m_parse_steps, 0);
250 for (i = 0; i < step_len; ++i) {
251 g_array_append_val(m_parse_steps, value);
255 gchar * input = g_strndup(str, len);
256 parse_value_t * curstep = NULL, * nextstep = NULL;
258 for (i = 0; i < len; ) {
259 if (input[i] == '\'') {
260 curstep = &g_array_index(m_parse_steps, parse_value_t, i);
261 nextstep = &g_array_index(m_parse_steps, parse_value_t, i + 1);
263 /* propagate current step into next step. */
264 nextstep->m_key = ChewingKey();
265 nextstep->m_key_rest = ChewingKeyRest();
266 nextstep->m_num_keys = curstep->m_num_keys;
267 nextstep->m_parsed_len = curstep->m_parsed_len + 1;
268 nextstep->m_last_step = i;
273 /* forward to next "'" */
274 if ( 0 == next_sep ) {
276 for (k = i; k < len; ++k) {
277 if (input[k] == '\'')
284 /* dynamic programming here. */
285 for (size_t m = i; m < next_sep; ++m) {
286 curstep = &g_array_index(m_parse_steps, parse_value_t, m);
287 size_t try_len = std_lite::min
288 (m + max_full_pinyin_length, next_sep);
289 for (size_t n = m + 1; n < try_len + 1; ++n) {
290 nextstep = &g_array_index(m_parse_steps, parse_value_t, n);
293 const char * onepinyin = input + m;
294 gint16 onepinyinlen = n - m;
295 value = parse_value_t();
297 ChewingKey key; ChewingKeyRest rest;
298 bool parsed = parse_one_key
299 (options, key, rest, onepinyin, onepinyinlen);
300 rest.m_raw_begin = m; rest.m_raw_end = n;
303 value.m_key = key; value.m_key_rest = rest;
304 value.m_num_keys = curstep->m_num_keys + 1;
305 value.m_parsed_len = curstep->m_parsed_len + onepinyinlen;
306 value.m_last_step = m;
309 if (-1 == nextstep->m_last_step)
311 if (value.m_parsed_len > nextstep->m_parsed_len)
313 if (value.m_parsed_len == nextstep->m_parsed_len &&
314 value.m_num_keys < nextstep->m_num_keys)
320 /* final step for back tracing. */
321 gint16 parsed_len = final_step(step_len, keys, key_rests);
323 /* post processing for re-split table. */
324 if (options & USE_RESPLIT_TABLE) {
325 post_process(options, keys, key_rests);
332 int FullPinyinParser2::final_step(size_t step_len, ChewingKeyVector & keys,
333 ChewingKeyRestVector & key_rests) const{
335 gint16 parsed_len = 0;
336 parse_value_t * curstep = NULL;
338 /* find longest match, which starts from the beginning of input. */
339 for (i = step_len - 1; i >= 0; --i) {
340 curstep = &g_array_index(m_parse_steps, parse_value_t, i);
341 if (i == curstep->m_parsed_len)
344 /* prepare saving. */
345 parsed_len = curstep->m_parsed_len;
346 gint16 num_keys = curstep->m_num_keys;
347 g_array_set_size(keys, num_keys);
348 g_array_set_size(key_rests, num_keys);
350 /* save the match. */
351 while (curstep->m_last_step != -1) {
352 gint16 pos = curstep->m_num_keys - 1;
355 if (0 != curstep->m_key_rest.m_table_index) {
356 ChewingKey * key = &g_array_index(keys, ChewingKey, pos);
357 ChewingKeyRest * rest = &g_array_index
358 (key_rests, ChewingKeyRest, pos);
359 *key = curstep->m_key; *rest = curstep->m_key_rest;
363 curstep = &g_array_index(m_parse_steps, parse_value_t,
364 curstep->m_last_step);
370 bool FullPinyinParser2::post_process(guint32 options,
371 ChewingKeyVector & keys,
372 ChewingKeyRestVector & key_rests) const {
374 assert(keys->len == key_rests->len);
375 gint16 num_keys = keys->len;
377 ChewingKey * cur_key = NULL, * next_key = NULL;
378 ChewingKeyRest * cur_rest = NULL, * next_rest = NULL;
379 guint16 cur_tone = CHEWING_ZERO_TONE, next_tone = CHEWING_ZERO_TONE;
381 for (i = 0; i < num_keys - 1; ++i) {
382 cur_rest = &g_array_index(key_rests, ChewingKeyRest, i);
383 next_rest = &g_array_index(key_rests, ChewingKeyRest, i + 1);
386 if (cur_rest->m_raw_end != next_rest->m_raw_begin)
389 cur_key = &g_array_index(keys, ChewingKey, i);
390 next_key = &g_array_index(keys, ChewingKey, i + 1);
392 if (options & USE_TONE) {
393 cur_tone = cur_key->m_tone;
394 next_tone = next_key->m_tone;
395 cur_key->m_tone = next_key->m_tone = CHEWING_ZERO_TONE;
398 /* lookup re-split table */
400 const resplit_table_item_t * item = NULL;
401 for (k = 0; k < G_N_ELEMENTS(resplit_table); ++k) {
402 item = resplit_table + k;
404 if (item->m_orig_freq >= item->m_new_freq)
407 /* use pinyin_exact_compare2 here. */
408 if (0 == pinyin_exact_compare2(item->m_orig_keys,
415 if (k < G_N_ELEMENTS(resplit_table)) {
417 item = resplit_table + k;
418 *cur_key = item->m_new_keys[0];
419 *next_key = item->m_new_keys[1];
420 /* assumes only moved one char in gen_all_resplit script. */
421 cur_rest->m_raw_end --;
422 next_rest->m_raw_begin --;
425 /* save back tones */
426 if (options & USE_TONE) {
427 cur_key->m_tone = cur_tone;
428 next_key->m_tone = next_tone;
435 #define IS_KEY(x) (('a' <= x && x <= 'z') || x == ';')
437 bool DoublePinyinParser2::parse_one_key (guint32 options, ChewingKey & key,
438 ChewingKeyRest & key_rest,
439 const char *str, int len) const{
442 if (!(options & PINYIN_INCOMPLETE))
449 int charid = ch == ';' ? 26 : ch - 'a';
450 const char * sheng = m_shengmu_table[charid].m_shengmu;
451 if (NULL == sheng || strcmp(sheng, "'") == 0)
454 if (search_pinyin_index(options, sheng, key, key_rest)) {
455 key_rest.m_raw_begin = 0; key_rest.m_raw_end = len;
462 ChewingTone tone = CHEWING_ZERO_TONE;
463 options &= ~(PINYIN_CORRECT_ALL|PINYIN_AMB_ALL);
467 if (!(options & USE_TONE))
470 if (!('0' < ch && ch <= '5'))
472 tone = (ChewingTone) (ch - '0');
475 if (2 == len || 3 == len) {
476 /* parse shengmu here. */
481 int charid = ch == ';' ? 26 : ch - 'a';
482 const char * sheng = m_shengmu_table[charid].m_shengmu;
485 if (strcmp(sheng, "'") == 0)
488 /* parse yunmu here. */
493 charid = ch == ';' ? 26 : ch - 'a';
495 const char * yun = m_yunmu_table[charid].m_yunmus[0];
496 gchar * pinyin = g_strdup_printf("%s%s", sheng, yun);
497 if (search_pinyin_index(options, pinyin, key, key_rest)) {
498 key_rest.m_raw_begin = 0; key_rest.m_raw_end = len;
506 yun = m_yunmu_table[charid].m_yunmus[1];
507 pinyin = g_strdup_printf("%s%s", sheng, yun);
508 if (search_pinyin_index(options, pinyin, key, key_rest)) {
509 key_rest.m_raw_begin = 0; key_rest.m_raw_end = len;
522 /* only 'a'-'z' and ';' are accepted here. */
523 int DoublePinyinParser2::parse (guint32 options, ChewingKeyVector & keys,
524 ChewingKeyRestVector & key_rests,
525 const char *str, int len) const{
526 g_array_set_size(keys, 0);
527 g_array_set_size(key_rests, 0);
529 int maximum_len = 0; int i;
530 /* probe the longest possible double pinyin string. */
531 for (i = 0; i < len; ++i) {
537 /* maximum forward match for double pinyin. */
539 while (parsed_len < maximum_len) {
540 const char * cur_str = str + parsed_len;
541 i = std_lite::min(maximum_len - parsed_len,
542 (int)max_double_pinyin_length);
544 ChewingKey key; ChewingKeyRest key_rest;
546 bool success = parse_one_key(options, key, key_rest, cur_str, i);
551 if (0 == i) /* no more possible double pinyins. */
554 key_rest.m_raw_begin = parsed_len; key_rest.m_raw_end = parsed_len + i;
557 /* save the pinyin */
558 g_array_append_val(keys, key);
559 g_array_append_val(key_rests, key_rest);
567 bool DoublePinyinParser2::set_scheme(DoublePinyinScheme scheme) {
570 case DOUBLE_PINYIN_ZRM:
571 m_shengmu_table = double_pinyin_zrm_sheng;
572 m_yunmu_table = double_pinyin_zrm_yun;
574 case DOUBLE_PINYIN_MS:
575 m_shengmu_table = double_pinyin_mspy_sheng;
576 m_yunmu_table = double_pinyin_mspy_yun;
578 case DOUBLE_PINYIN_ZIGUANG:
579 m_shengmu_table = double_pinyin_zgpy_sheng;
580 m_yunmu_table = double_pinyin_zgpy_yun;
582 case DOUBLE_PINYIN_ABC:
583 m_shengmu_table = double_pinyin_abc_sheng;
584 m_yunmu_table = double_pinyin_abc_yun;
586 case DOUBLE_PINYIN_PYJJ:
587 m_shengmu_table = double_pinyin_pyjj_sheng;
588 m_yunmu_table = double_pinyin_pyjj_yun;
590 case DOUBLE_PINYIN_XHE:
591 m_shengmu_table = double_pinyin_xhe_sheng;
592 m_yunmu_table = double_pinyin_xhe_yun;
594 case DOUBLE_PINYIN_CUSTOMIZED:
598 return false; /* no such scheme. */
601 /* the chewing string must be freed with g_free. */
602 static bool search_chewing_symbols(const chewing_symbol_item_t * symbol_table,
603 const char key, char ** chewing) {
604 /* just iterate the table, as we only have < 50 items. */
605 while (symbol_table->m_input != '\0') {
606 if (symbol_table->m_input == key) {
607 *chewing = g_strdup(symbol_table->m_chewing);
615 static bool search_chewing_tones(const chewing_tone_item_t * tone_table,
616 const char key, char * tone) {
617 /* just iterate the table, as we only have < 10 items. */
618 while (tone_table->m_input != '\0') {
619 if (tone_table->m_input == key) {
620 *tone = tone_table->m_tone;
629 bool ChewingParser2::parse_one_key(guint32 options, ChewingKey & key, ChewingKeyRest & key_rest, const char *str, int len) const {
630 char tone = CHEWING_ZERO_TONE;
632 int symbols_len = len;
633 /* probe whether the last key is tone key in str. */
634 if (options & USE_TONE) {
635 char ch = str[len - 1];
636 /* remove tone from input */
637 if (search_chewing_tones(m_tone_table, ch, &tone))
642 gchar * chewing = NULL, * onechar = NULL;
644 /* probe the possible chewing map in the rest of str. */
645 for (i = 0; i < symbols_len; ++i) {
646 if (!search_chewing_symbols(m_symbol_table, str[i], &onechar)) {
653 chewing = g_strdup(onechar);
655 gchar * tmp = chewing;
656 chewing = g_strconcat(chewing, onechar, NULL);
662 /* search the chewing in the chewing index table. */
663 if (search_chewing_index(options, chewing, key, key_rest)) {
664 key_rest.m_raw_begin = 0; key_rest.m_raw_end = len;
665 /* save back tone if available. */
676 /* only characters in chewing keyboard scheme are accepted here. */
677 int ChewingParser2::parse(guint32 options, ChewingKeyVector & keys, ChewingKeyRestVector & key_rests, const char *str, int len) const {
678 /* probe the longest possible chewing string. */
679 /* maximum forward match for chewing. */
684 bool ChewingParser2::set_scheme(ChewingScheme scheme) {
686 case CHEWING_STANDARD:
687 m_symbol_table = chewing_standard_symbols;
688 m_tone_table = chewing_standard_tones;
691 m_symbol_table = chewing_ibm_symbols;
692 m_tone_table = chewing_ibm_tones;
694 case CHEWING_GINYIEH:
695 m_symbol_table = chewing_ginyieh_symbols;
696 m_tone_table = chewing_ginyieh_tones;
699 m_symbol_table = chewing_eten_symbols;
700 m_tone_table = chewing_eten_tones;
708 bool ChewingParser2::in_chewing_scheme(const char key){
709 gchar * chewing = NULL;
710 char tone = CHEWING_ZERO_TONE;
712 bool retval = search_chewing_symbols(m_symbol_table, key, &chewing) ||
713 search_chewing_tones(m_tone_table, key, &tone);