kmxime_api.h
19.4 KB
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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
/***************************************************************************
* *
* Input method library database API *
* *
* Copyright (C) 2000-2007 Beijing Komoxo Inc. *
* All rights reserved. *
* *
***************************************************************************/
#ifndef KMXIME_H
#define KMXIME_H
#ifdef __cplusplus
extern "C"{
#endif
/*-------------------------------------------------------------------------*/
/* */
/* Language database list */
/* */
/*-------------------------------------------------------------------------*/
extern const void* kmx_ldb_pinyin_chs;
extern const void* kmx_ldb_pinyin_cht;
extern const void* kmx_ldb_pinyin_gb2312;
extern const void* kmx_ldb_pinyin_gbk;
extern const void* kmx_ldb_pinyin_gb18030;
extern const void* kmx_ldb_pinyin_big5;
extern const void* kmx_ldb_pinyin_chs_suretype;
extern const void* kmx_ldb_pinyin_cht_suretype;
extern const void* kmx_ldb_pinyin_gb2312_suretype;
extern const void* kmx_ldb_pinyin_gb18030_suretype;
extern const void* kmx_ldb_pinyin_big5_suretype;
extern const void* kmx_ldb_zhuyin_chs;
extern const void* kmx_ldb_zhuyin_cht;
extern const void* kmx_ldb_zhuyin_gb2312;
extern const void* kmx_ldb_zhuyin_gb18030;
extern const void* kmx_ldb_zhuyin_big5;
extern const void* kmx_ldb_zhuyin_big5normal;
extern const void* kmx_ldb_zhuyin_big5hkscs;
extern const void* kmx_ldb_pinyin_danzi;
extern const void* kmx_ldb_zhuyin_danzi;
extern const void* kmx_ldb_stroke_chs;
extern const void* kmx_ldb_stroke_gb2312;
extern const void* kmx_ldb_stroke_gbk;
extern const void* kmx_ldb_stroke_gb18030;
extern const void* kmx_ldb_stroke_big5;
extern const void* kmx_ldb_stroke_big5hkscs;
extern const void* kmx_ldb_armenian;
extern const void* kmx_ldb_arabic;
extern const void* kmx_ldb_bengali;
extern const void* kmx_ldb_bulgarian;
extern const void* kmx_ldb_czech;
extern const void* kmx_ldb_danish;
extern const void* kmx_ldb_dutch;
extern const void* kmx_ldb_english;
extern const void* kmx_ldb_finnish;
extern const void* kmx_ldb_french;
extern const void* kmx_ldb_german;
extern const void* kmx_ldb_greek;
extern const void* kmx_ldb_hebrew;
extern const void* kmx_ldb_hindi;
extern const void* kmx_ldb_hinglish;
extern const void* kmx_ldb_hungarian;
extern const void* kmx_ldb_indonesian;
extern const void* kmx_ldb_italian;
extern const void* kmx_ldb_lithuanian;
extern const void* kmx_ldb_malay;
extern const void* kmx_ldb_norwegian;
extern const void* kmx_ldb_persian;
extern const void* kmx_ldb_polish;
extern const void* kmx_ldb_portuguese;
extern const void* kmx_ldb_romanian;
extern const void* kmx_ldb_russian;
extern const void* kmx_ldb_slovak;
extern const void* kmx_ldb_slovenian;
extern const void* kmx_ldb_spanish;
extern const void* kmx_ldb_swahili;
extern const void* kmx_ldb_swedish;
extern const void* kmx_ldb_thai;
extern const void* kmx_ldb_turkish;
extern const void* kmx_ldb_ukrainian;
extern const void* kmx_ldb_vietnamese;
extern const void* kmx_ldb_english_suretype;
extern const void* kmx_ldb_uyghur;
extern const void* kmx_ldb_urdu;
/*-------------------------------------------------------------------------*/
/* */
/* General input method interface */
/* */
/*-------------------------------------------------------------------------*/
#define KMX_IME_ENGINE_SIZE (22 * 1024)
typedef struct
{
int *engine;
} KMX_IME_ENGINE;
typedef struct
{
const void* database;
void* user_data;
unsigned int user_data_size;
int flags;
const unsigned short* letter_group;
} KMX_IME_ENGINE_INIT;
#define KMX_MAX_WORD_MATCH 9
typedef struct
{
const unsigned short* text_before;
const unsigned short* text_after;
unsigned short text_before_length;
unsigned short text_after_length;
} KMX_INPUT_CONTEXT;
/*-------------------------------------------------------------------------*/
/* */
/* Chinese pinyin input method interface */
/* */
/*-------------------------------------------------------------------------*/
#define KMX_PINYIN_FUZZY_Z_ZH 0x0001
#define KMX_PINYIN_FUZZY_C_CH 0x0002
#define KMX_PINYIN_FUZZY_S_SH 0x0004
#define KMX_PINYIN_FUZZY_H_F 0x0008
#define KMX_PINYIN_FUZZY_N_L 0x0010
#define KMX_PINYIN_FUZZY_IN_ING 0x0100
#define KMX_PINYIN_FUZZY_EN_ENG 0x0200
#define KMX_PINYIN_FUZZY_AN_ANG 0x0400
#define KMX_PINYIN_FUZZY_IAN_IANG 0x0800
#define KMX_PINYIN_FUZZY_UAN_UANG 0x1000
#define KMX_PINYIN_SEPARATOR 0x20
#define KMX_MAX_CHAR_PINYIN 6
#define KMX_MAX_PINYIN_WORD_LENGTH 8
#define KMX_MAX_PINYIN_INPUT ((KMX_MAX_CHAR_PINYIN + 2) * KMX_MAX_PINYIN_WORD_LENGTH)
#define KMX_MAX_PINYIN_COMPOSITION KMX_MAX_PINYIN_INPUT
#define KMX_MAX_DIGIT_PINYIN_MATCH 20
#define KMX_PINYIN_MATCH_INDEX_NONE 0xFFFF
typedef struct
{
char string[KMX_MAX_CHAR_PINYIN];
unsigned short length;
} KMX_CHAR_PINYIN;
typedef struct
{
char string[KMX_MAX_PINYIN_COMPOSITION];
unsigned short length;
} KMX_PINYIN_COMPOSITION;
typedef struct
{
KMX_CHAR_PINYIN table[KMX_MAX_DIGIT_PINYIN_MATCH];
unsigned short count;
} KMX_PINYIN_MATCH_RESULT;
typedef struct
{
unsigned short string[KMX_MAX_PINYIN_WORD_LENGTH];
unsigned short length;
unsigned short match_length;
} KMX_PINYIN_CANDIDATE;
typedef struct
{
KMX_PINYIN_CANDIDATE table[KMX_MAX_WORD_MATCH];
unsigned short count;
unsigned short more_available;
} KMX_PINYIN_WORD_MATCH_RESULT;
int kmx_pinyin_initialize(
KMX_IME_ENGINE* engine,
const KMX_IME_ENGINE_INIT* init_info);
int kmx_digit_pinyin_match(
KMX_IME_ENGINE* engine,
const char* digit_string,
unsigned short digit_string_length,
unsigned short pinyin_match_index,
unsigned short word_match_index,
KMX_PINYIN_COMPOSITION* pinyin_composition,
KMX_PINYIN_MATCH_RESULT* pinyin_match_result,
KMX_PINYIN_WORD_MATCH_RESULT* word_match_result);
int kmx_digit_pinyin_match_length(
KMX_IME_ENGINE* engine,
const char* digit_string,
unsigned short digit_string_length,
unsigned short pinyin_match_index,
unsigned short word_match_index,
unsigned short max_match_word_length,
KMX_PINYIN_COMPOSITION* pinyin_composition,
KMX_PINYIN_MATCH_RESULT* pinyin_match_result,
KMX_PINYIN_WORD_MATCH_RESULT* word_match_result);
int kmx_pinyin_match(
KMX_IME_ENGINE* engine,
const char* pinyin_string,
unsigned short pinyin_string_length,
unsigned short word_match_index,
KMX_PINYIN_WORD_MATCH_RESULT* word_match_result);
int kmx_pinyin_match_length(
KMX_IME_ENGINE* engine,
const char* pinyin_string,
unsigned short pinyin_string_length,
unsigned short word_match_index,
unsigned short max_match_word_length,
KMX_PINYIN_WORD_MATCH_RESULT* word_match_result);
/* this interface is for huawei only */
int kmx_pinyin_match_1(
KMX_IME_ENGINE* engine,
const char* pinyin_string,
unsigned short pinyin_string_length,
unsigned short word_match_index,
KMX_PINYIN_WORD_MATCH_RESULT* word_match_result);
int kmx_pinyin_update_cache(
KMX_IME_ENGINE* engine,
const unsigned short* string,
unsigned short length);
int kmx_pinyin_check_association(
KMX_IME_ENGINE* engine,
unsigned short char_code,
unsigned short* buffer,
int number);
typedef int (*CALLBACK_READ_UPDATE_DATA)(unsigned char *buffer, int pos, int length);
int kmx_pinyin_set_update_callback(
KMX_IME_ENGINE* engine,
CALLBACK_READ_UPDATE_DATA pfnReadUpdateData);
/*-------------------------------------------------------------------------*/
/* */
/* Chinese zhuyin input method interface */
/* */
/*-------------------------------------------------------------------------*/
#define KMX_MAX_CHAR_ZHUYIN 4
#define KMX_MAX_ZHUYIN_WORD_LENGTH 8
#define KMX_MAX_ZHUYIN_INPUT (KMX_MAX_CHAR_ZHUYIN * KMX_MAX_ZHUYIN_WORD_LENGTH)
typedef struct
{
unsigned short string[KMX_MAX_CHAR_ZHUYIN];
unsigned short length;
} KMX_CHAR_ZHUYIN;
typedef struct
{
unsigned short string[KMX_MAX_ZHUYIN_WORD_LENGTH];
unsigned short length;
unsigned short match_length;
} KMX_ZHUYIN_CANDIDATE;
typedef struct
{
KMX_ZHUYIN_CANDIDATE table[KMX_MAX_WORD_MATCH];
unsigned short count;
unsigned short more_available;
} KMX_ZHUYIN_WORD_MATCH_RESULT;
int kmx_zhuyin_initialize(
KMX_IME_ENGINE* engine,
const KMX_IME_ENGINE_INIT* init_info);
int kmx_zhuyin_match(
KMX_IME_ENGINE* engine,
const unsigned short* zhuyin_string,
unsigned short zhuyin_string_length,
unsigned short word_match_index,
KMX_ZHUYIN_WORD_MATCH_RESULT* word_match_result);
int kmx_zhuyin_match_length(
KMX_IME_ENGINE* engine,
const unsigned short* zhuyin_string,
unsigned short zhuyin_string_length,
unsigned short word_match_index,
unsigned short max_match_word_length,
KMX_ZHUYIN_WORD_MATCH_RESULT* word_match_result);
int kmx_digit_to_zhuyin(
KMX_IME_ENGINE* engine,
const char* digit_string,
unsigned short digit_length,
unsigned short* zhuyin_string,
unsigned short* p_zhuyin_number);
int kmx_zhuyin_update_cache(
KMX_IME_ENGINE* engine,
const unsigned short* string,
unsigned short length);
int kmx_zhuyin_check_association(
KMX_IME_ENGINE* engine,
unsigned short char_code,
unsigned short* buffer,
int number);
/*-------------------------------------------------------------------------*/
/* */
/* Chinese stroke input method interface */
/* */
/*-------------------------------------------------------------------------*/
#define KMX_STROKE_SPACE 0x20
#define KMX_STROKE_HENG 0x31
#define KMX_STROKE_SHU 0x32
#define KMX_STROKE_PIE 0x33
#define KMX_STROKE_DIAN 0x34
#define KMX_STROKE_ZHE 0x35
#define KMX_STROKE_WILDCARD 0x36
#define KMX_MAX_STROKE_INPUT_LENGTH 64
#define KMX_MAX_STROKE_WORD_LENGTH 8
#define KMX_STROKE_FLAG_WORD 0x0001
typedef struct
{
unsigned short length;
unsigned short string[KMX_MAX_STROKE_WORD_LENGTH + 1];
} KMX_STROKE_CANDIDATE;
typedef struct
{
unsigned short count;
unsigned short more_available;
KMX_STROKE_CANDIDATE table[KMX_MAX_WORD_MATCH];
} KMX_STROKE_MATCH_RESULT;
typedef struct
{
int flags;
} KMX_STROKE_ENGINE_PROPERTIES;
int kmx_stroke_initialize(
KMX_IME_ENGINE* engine,
const KMX_IME_ENGINE_INIT* init_info);
int kmx_stroke_query_engine_properties(
KMX_IME_ENGINE* engine,
KMX_STROKE_ENGINE_PROPERTIES* properties);
int kmx_stroke_match(
KMX_IME_ENGINE* engine,
const char* stroke_string,
unsigned short stroke_string_length,
unsigned short match_index,
KMX_STROKE_MATCH_RESULT* match_result);
int kmx_stroke_update_cache(
KMX_IME_ENGINE* engine,
const unsigned short* string,
unsigned short length);
typedef int (*CALLBACK_CHECK_VALID_HANZI)(unsigned short unichr);
int kmx_stroke_set_callback(
KMX_IME_ENGINE* engine,
CALLBACK_CHECK_VALID_HANZI callback);
/*-------------------------------------------------------------------------*/
/* */
/* Additional input method interface for Chinese */
/* */
/*-------------------------------------------------------------------------*/
#define KMX_MAX_ASSOCIATION_QUERY_BUFFER 32
int kmx_chinese_query_association(
const void* database,
unsigned short char_code,
unsigned short* buffer,
int number);
int kmx_chinese_query_pinyin(
const void* database,
unsigned short char_code,
KMX_CHAR_PINYIN* pinyin);
int kmx_chinese_query_pinyin_dyz(
const void* database,
unsigned short char_code,
KMX_CHAR_PINYIN* pinyin,
int maxDyz);
int kmx_chinese_query_zhuyin(
const void* database,
unsigned short char_code,
KMX_CHAR_ZHUYIN* zhuyin);
int kmx_chinese_query_stroke(
const void* database,
unsigned short char_code,
char* buffer,
unsigned short buffer_length);
int kmx_chinese_mars_translate(
const void* database,
unsigned short* buffer,
unsigned short buffer_length);
/*-------------------------------------------------------------------------*/
/* */
/* Input method interface for latin-based languages */
/* */
/*-------------------------------------------------------------------------*/
#define KMX_MAX_LATIN_WORD_LENGTH 32
#define KMX_LATIN_LOWER_CASE 0x0001
#define KMX_LATIN_UPPER_CASE 0x0002
#define KMX_LATIN_INITIAL_CASE 0x0004
#define KMX_LATIN_NUMBER_FIRST 0x0008
typedef struct
{
unsigned short string[KMX_MAX_LATIN_WORD_LENGTH];
unsigned short length;
} KMX_LATIN_CANDIDATE;
typedef struct
{
KMX_LATIN_CANDIDATE table[KMX_MAX_WORD_MATCH];
unsigned short count;
unsigned short more_available;
} KMX_LATIN_MATCH_RESULT;
int kmx_latin_initialize(
KMX_IME_ENGINE* engine,
const KMX_IME_ENGINE_INIT* init_info);
int kmx_latin_match(
KMX_IME_ENGINE* engine,
const KMX_INPUT_CONTEXT* context,
const char* input_string,
unsigned short input_string_length,
unsigned short match_flags,
unsigned short match_index,
KMX_LATIN_MATCH_RESULT* match_result);
int kmx_latin_query_association(
KMX_IME_ENGINE* engine,
const unsigned short* input_string,
unsigned short input_string_length,
unsigned short match_flags,
unsigned short match_index,
KMX_LATIN_MATCH_RESULT* match_result);
int kmx_latin_query_association_ex(
KMX_IME_ENGINE* engine,
const unsigned short* input_string,
unsigned short input_string_length,
unsigned short match_flags,
unsigned short match_index,
KMX_LATIN_MATCH_RESULT* match_result);
int kmx_latin_update_cache(
KMX_IME_ENGINE* engine,
const unsigned short* string,
unsigned short length);
int kmx_latin_query_key_map(
const void* database,
unsigned short char_code,
unsigned short* key_code);
int kmx_latin_query_multitap(
const void* database,
unsigned short key,
unsigned short flags,
const unsigned short** string,
unsigned short* length);
int kmx_is_valid_thai_follow_char(
unsigned short c1,
unsigned short c2);
int kmx_is_valid_hindi_word_start_char(
unsigned short c);
int kmx_is_valid_hindi_follow_char(
unsigned short c1,
unsigned short c2);
int kmx_is_valid_bengali_word_start_char(
unsigned short c);
int kmx_is_valid_bengali_follow_char(
unsigned short c1,
unsigned short c2);
int kmx_is_valid_telugu_word_start_char(
unsigned short c);
int kmx_is_valid_telugu_follow_char(
unsigned short c1,
unsigned short c2);
int kmx_is_valid_marathi_word_start_char(
unsigned short c);
int kmx_is_valid_marathi_follow_char(
unsigned short c1,
unsigned short c2);
int kmx_is_valid_tamil_word_start_char(
unsigned short c);
int kmx_is_valid_tamil_follow_char(
unsigned short c1,
unsigned short c2);
int kmx_is_sou_delimiter(
KMX_IME_ENGINE* engine,
unsigned short c);
int kmx_latin_to_lower_case(
const void* database,
unsigned short* str,
unsigned short len);
int kmx_latin_to_upper_case(
const void* database,
unsigned short* str,
unsigned short len);
int kmx_latin_to_initial_case(
const void* database,
unsigned short* str,
unsigned short len);
#ifdef __cplusplus
}
#endif
#endif /* KMXIME_H */