blob: e349aedb1d73b0bfbdff76af70f505f60ae135c6 [file] [log] [blame]
satoke808e432010-12-02 14:53:24 +09001/*
Ken Wakasaa10b1a82013-01-08 17:23:43 +09002 * Copyright (C) 2010 The Android Open Source Project
Ken Wakasa0bbb9172012-07-25 17:51:43 +09003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
Ken Wakasaa10b1a82013-01-08 17:23:43 +09008 * http://www.apache.org/licenses/LICENSE-2.0
Ken Wakasa0bbb9172012-07-25 17:51:43 +09009 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
satoke808e432010-12-02 14:53:24 +090016
17#ifndef LATINIME_DEFINES_H
18#define LATINIME_DEFINES_H
19
Ken Wakasa1ce96fe2012-11-15 19:09:11 +090020#ifdef __GNUC__
21#define AK_FORCE_INLINE __attribute__((always_inline)) __inline__
22#else // __GNUC__
23#define AK_FORCE_INLINE inline
24#endif // __GNUC__
25
Ken Wakasa6cee61d2013-01-15 16:15:48 +090026#if defined(FLAG_DO_PROFILE) || defined(FLAG_DBG)
27#undef AK_FORCE_INLINE
28#define AK_FORCE_INLINE inline
29#endif // defined(FLAG_DO_PROFILE) || defined(FLAG_DBG)
30
Ken Wakasa6c224392013-01-22 13:14:53 +090031// Must be equal to Constants.Dictionary.MAX_WORD_LENGTH in Java
Ken Wakasa5db594a2013-01-12 01:18:00 +090032#define MAX_WORD_LENGTH 48
Ken Wakasa6c224392013-01-22 13:14:53 +090033// Must be equal to BinaryDictionary.MAX_RESULTS in Java
Ken Wakasa5db594a2013-01-12 01:18:00 +090034#define MAX_RESULTS 18
Ken Wakasa6c224392013-01-22 13:14:53 +090035// Must be equal to ProximityInfo.MAX_PROXIMITY_CHARS_SIZE in Java
36#define MAX_PROXIMITY_CHARS_SIZE 16
37#define ADDITIONAL_PROXIMITY_CHAR_DELIMITER_CODE 2
Satoshi Kataoka42217382012-12-17 23:28:17 +090038
satok827ced82011-07-14 09:01:09 +090039#if defined(FLAG_DO_PROFILE) || defined(FLAG_DBG)
Ken Wakasae3f26dd2012-07-27 18:06:06 +090040#include <android/log.h>
41#ifndef LOG_TAG
42#define LOG_TAG "LatinIME: "
Ken Wakasa6cee61d2013-01-15 16:15:48 +090043#endif // LOG_TAG
Ken Wakasae3f26dd2012-07-27 18:06:06 +090044#define AKLOGE(fmt, ...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, fmt, ##__VA_ARGS__)
45#define AKLOGI(fmt, ...) __android_log_print(ANDROID_LOG_INFO, LOG_TAG, fmt, ##__VA_ARGS__)
satok6ad15fc2012-01-16 16:21:21 +090046
Ken Wakasa5db594a2013-01-12 01:18:00 +090047#define DUMP_RESULT(words, frequencies) do { dumpResult(words, frequencies); } while (0)
Ken Wakasaf2789812012-09-04 12:49:46 +090048#define DUMP_WORD(word, length) do { dumpWord(word, length); } while (0)
Ken Wakasa1e614932012-10-29 18:06:22 +090049#define INTS_TO_CHARS(input, length, output) do { \
50 intArrayToCharArray(input, length, output); } while (0)
satok6ad15fc2012-01-16 16:21:21 +090051
Satoshi Kataoka42217382012-12-17 23:28:17 +090052// TODO: Support full UTF-8 conversion
53AK_FORCE_INLINE static int intArrayToCharArray(const int *source, const int sourceSize,
54 char *dest) {
55 int si = 0;
56 int di = 0;
Ken Wakasa5db594a2013-01-12 01:18:00 +090057 while (si < sourceSize && di < MAX_WORD_LENGTH - 1 && 0 != source[si]) {
Satoshi Kataoka42217382012-12-17 23:28:17 +090058 const int codePoint = source[si++];
59 if (codePoint < 0x7F) {
60 dest[di++] = codePoint;
61 } else if (codePoint < 0x7FF) {
62 dest[di++] = 0xC0 + (codePoint >> 6);
63 dest[di++] = 0x80 + (codePoint & 0x3F);
64 } else if (codePoint < 0xFFFF) {
65 dest[di++] = 0xE0 + (codePoint >> 12);
66 dest[di++] = 0x80 + ((codePoint & 0xFC0) >> 6);
67 dest[di++] = 0x80 + (codePoint & 0x3F);
68 }
69 }
70 dest[di] = 0;
71 return di;
72}
73
Ken Wakasa1e614932012-10-29 18:06:22 +090074static inline void dumpWordInfo(const int *word, const int length, const int rank,
Satoshi Kataokae0e67372013-03-18 13:08:31 +090075 const int probability) {
Satoshi Kataoka586b0ca2012-08-06 11:20:54 +090076 static char charBuf[50];
Satoshi Kataoka42217382012-12-17 23:28:17 +090077 const int N = intArrayToCharArray(word, length, charBuf);
78 if (N > 1) {
Satoshi Kataokae0e67372013-03-18 13:08:31 +090079 AKLOGI("%2d [ %s ] (%d)", rank, charBuf, probability);
Satoshi Kataoka586b0ca2012-08-06 11:20:54 +090080 }
81}
82
Ken Wakasa5db594a2013-01-12 01:18:00 +090083static inline void dumpResult(const int *outWords, const int *frequencies) {
Satoshi Kataoka586b0ca2012-08-06 11:20:54 +090084 AKLOGI("--- DUMP RESULT ---------");
Ken Wakasa5db594a2013-01-12 01:18:00 +090085 for (int i = 0; i < MAX_RESULTS; ++i) {
86 dumpWordInfo(&outWords[i * MAX_WORD_LENGTH], MAX_WORD_LENGTH, i, frequencies[i]);
Satoshi Kataoka586b0ca2012-08-06 11:20:54 +090087 }
88 AKLOGI("-------------------------");
89}
90
Ken Wakasa1ce96fe2012-11-15 19:09:11 +090091static AK_FORCE_INLINE void dumpWord(const int *word, const int length) {
Tadashi G. Takaokad1dbdb62012-03-06 15:35:46 +090092 static char charBuf[50];
Satoshi Kataoka42217382012-12-17 23:28:17 +090093 const int N = intArrayToCharArray(word, length, charBuf);
94 if (N > 1) {
Satoshi Kataoka586b0ca2012-08-06 11:20:54 +090095 AKLOGI("[ %s ]", charBuf);
96 }
satok6ad15fc2012-01-16 16:21:21 +090097}
98
Satoshi Kataoka5540acb2012-09-03 18:35:32 +090099#ifndef __ANDROID__
Satoshi Kataoka1c8fc832012-09-06 21:31:54 +0900100#include <cassert>
Satoshi Kataoka5540acb2012-09-03 18:35:32 +0900101#include <execinfo.h>
102#include <stdlib.h>
Satoshi Kataoka1c8fc832012-09-06 21:31:54 +0900103
Satoshi Kataokadd4d9382013-01-09 12:54:39 +0900104#define DO_ASSERT_TEST
Satoshi Kataoka1c8fc832012-09-06 21:31:54 +0900105#define ASSERT(success) do { if (!(success)) { showStackTrace(); assert(success);} } while (0)
106#define SHOW_STACK_TRACE do { showStackTrace(); } while (0)
107
Satoshi Kataoka5540acb2012-09-03 18:35:32 +0900108static inline void showStackTrace() {
109 void *callstack[128];
110 int i, frames = backtrace(callstack, 128);
111 char **strs = backtrace_symbols(callstack, frames);
112 for (i = 0; i < frames; ++i) {
113 if (i == 0) {
114 AKLOGI("=== Trace ===");
115 continue;
116 }
117 AKLOGI("%s", strs[i]);
118 }
119 free(strs);
120}
Ken Wakasa6cee61d2013-01-15 16:15:48 +0900121#else // __ANDROID__
Satoshi Kataoka1c8fc832012-09-06 21:31:54 +0900122#include <cassert>
Satoshi Kataokadd4d9382013-01-09 12:54:39 +0900123#define DO_ASSERT_TEST
Satoshi Kataoka1c8fc832012-09-06 21:31:54 +0900124#define ASSERT(success) assert(success)
Satoshi Kataoka5540acb2012-09-03 18:35:32 +0900125#define SHOW_STACK_TRACE
Ken Wakasa6cee61d2013-01-15 16:15:48 +0900126#endif // __ANDROID__
Satoshi Kataoka5540acb2012-09-03 18:35:32 +0900127
Ken Wakasa6cee61d2013-01-15 16:15:48 +0900128#else // defined(FLAG_DO_PROFILE) || defined(FLAG_DBG)
satok9fb6f472012-01-13 18:01:22 +0900129#define AKLOGE(fmt, ...)
130#define AKLOGI(fmt, ...)
Ken Wakasa5db594a2013-01-12 01:18:00 +0900131#define DUMP_RESULT(words, frequencies)
satok6ad15fc2012-01-16 16:21:21 +0900132#define DUMP_WORD(word, length)
Satoshi Kataokadd4d9382013-01-09 12:54:39 +0900133#undef DO_ASSERT_TEST
Satoshi Kataoka5540acb2012-09-03 18:35:32 +0900134#define ASSERT(success)
135#define SHOW_STACK_TRACE
Ken Wakasa1e614932012-10-29 18:06:22 +0900136#define INTS_TO_CHARS(input, length, output)
Ken Wakasa6cee61d2013-01-15 16:15:48 +0900137#endif // defined(FLAG_DO_PROFILE) || defined(FLAG_DBG)
satok827ced82011-07-14 09:01:09 +0900138
satok20d9fda2011-07-13 14:40:30 +0900139#ifdef FLAG_DO_PROFILE
satok61e2f852011-01-05 14:13:07 +0900140// Profiler
141#include <time.h>
satok9fb6f472012-01-13 18:01:22 +0900142
satok61e2f852011-01-05 14:13:07 +0900143#define PROF_BUF_SIZE 100
satok0028ed32012-05-16 20:42:12 +0900144static float profile_buf[PROF_BUF_SIZE];
145static float profile_old[PROF_BUF_SIZE];
satok61e2f852011-01-05 14:13:07 +0900146static unsigned int profile_counter[PROF_BUF_SIZE];
147
Ken Wakasae90b3332011-01-07 15:01:51 +0900148#define PROF_RESET prof_reset()
149#define PROF_COUNT(prof_buf_id) ++profile_counter[prof_buf_id]
Ken Wakasaf2789812012-09-04 12:49:46 +0900150#define PROF_OPEN do { PROF_RESET; PROF_START(PROF_BUF_SIZE - 1); } while (0)
Ken Wakasae90b3332011-01-07 15:01:51 +0900151#define PROF_START(prof_buf_id) do { \
Ken Wakasaf2789812012-09-04 12:49:46 +0900152 PROF_COUNT(prof_buf_id); profile_old[prof_buf_id] = (clock()); } while (0)
153#define PROF_CLOSE do { PROF_END(PROF_BUF_SIZE - 1); PROF_OUTALL; } while (0)
Ken Wakasae90b3332011-01-07 15:01:51 +0900154#define PROF_END(prof_buf_id) profile_buf[prof_buf_id] += ((clock()) - profile_old[prof_buf_id])
155#define PROF_CLOCKOUT(prof_buf_id) \
satok9fb6f472012-01-13 18:01:22 +0900156 AKLOGI("%s : clock is %f", __FUNCTION__, (clock() - profile_old[prof_buf_id]))
Ken Wakasaf2789812012-09-04 12:49:46 +0900157#define PROF_OUTALL do { AKLOGI("--- %s ---", __FUNCTION__); prof_out(); } while (0)
satok61e2f852011-01-05 14:13:07 +0900158
Tadashi G. Takaokad1dbdb62012-03-06 15:35:46 +0900159static inline void prof_reset(void) {
Ken Wakasae90b3332011-01-07 15:01:51 +0900160 for (int i = 0; i < PROF_BUF_SIZE; ++i) {
satok61e2f852011-01-05 14:13:07 +0900161 profile_buf[i] = 0;
162 profile_old[i] = 0;
163 profile_counter[i] = 0;
164 }
165}
166
Tadashi G. Takaokad1dbdb62012-03-06 15:35:46 +0900167static inline void prof_out(void) {
satok61e2f852011-01-05 14:13:07 +0900168 if (profile_counter[PROF_BUF_SIZE - 1] != 1) {
satok9fb6f472012-01-13 18:01:22 +0900169 AKLOGI("Error: You must call PROF_OPEN before PROF_CLOSE.");
satok61e2f852011-01-05 14:13:07 +0900170 }
satok9fb6f472012-01-13 18:01:22 +0900171 AKLOGI("Total time is %6.3f ms.",
Ken Wakasa77e8e812012-08-02 19:48:08 +0900172 profile_buf[PROF_BUF_SIZE - 1] * 1000.0f / static_cast<float>(CLOCKS_PER_SEC));
Ken Wakasa2a6f58d2012-11-27 19:40:38 +0900173 float all = 0.0f;
Ken Wakasae90b3332011-01-07 15:01:51 +0900174 for (int i = 0; i < PROF_BUF_SIZE - 1; ++i) {
satok61e2f852011-01-05 14:13:07 +0900175 all += profile_buf[i];
176 }
Ken Wakasa2a6f58d2012-11-27 19:40:38 +0900177 if (all < 1.0f) all = 1.0f;
Ken Wakasae90b3332011-01-07 15:01:51 +0900178 for (int i = 0; i < PROF_BUF_SIZE - 1; ++i) {
Ken Wakasa2a6f58d2012-11-27 19:40:38 +0900179 if (profile_buf[i] > 0.0f) {
satok9fb6f472012-01-13 18:01:22 +0900180 AKLOGI("(%d): Used %4.2f%%, %8.4f ms. Called %d times.",
Ken Wakasa2a6f58d2012-11-27 19:40:38 +0900181 i, (profile_buf[i] * 100.0f / all),
Ken Wakasa77e8e812012-08-02 19:48:08 +0900182 profile_buf[i] * 1000.0f / static_cast<float>(CLOCKS_PER_SEC),
183 profile_counter[i]);
Ken Wakasae90b3332011-01-07 15:01:51 +0900184 }
satok61e2f852011-01-05 14:13:07 +0900185 }
186}
187
satok20d9fda2011-07-13 14:40:30 +0900188#else // FLAG_DO_PROFILE
satok61e2f852011-01-05 14:13:07 +0900189#define PROF_BUF_SIZE 0
190#define PROF_RESET
191#define PROF_COUNT(prof_buf_id)
192#define PROF_OPEN
193#define PROF_START(prof_buf_id)
194#define PROF_CLOSE
195#define PROF_END(prof_buf_id)
196#define PROF_CLOCK_OUT(prof_buf_id)
197#define PROF_CLOCKOUT(prof_buf_id)
198#define PROF_OUTALL
199
satok20d9fda2011-07-13 14:40:30 +0900200#endif // FLAG_DO_PROFILE
201
202#ifdef FLAG_DBG
satok20d9fda2011-07-13 14:40:30 +0900203#define DEBUG_DICT true
204#define DEBUG_DICT_FULL false
satok0cedd2b2011-08-12 01:05:27 +0900205#define DEBUG_EDIT_DISTANCE false
satok20d9fda2011-07-13 14:40:30 +0900206#define DEBUG_NODE DEBUG_DICT_FULL
207#define DEBUG_TRACE DEBUG_DICT_FULL
satok1a6da632011-12-16 23:15:06 +0900208#define DEBUG_PROXIMITY_INFO false
satok0cb20972012-03-13 22:07:56 +0900209#define DEBUG_PROXIMITY_CHARS false
satok10266c02011-08-19 22:05:59 +0900210#define DEBUG_CORRECTION false
satok29dc8062012-01-17 15:59:15 +0900211#define DEBUG_CORRECTION_FREQ false
Satoshi Kataoka0ed8c6e2012-12-04 16:28:06 +0900212#define DEBUG_SAMPLING_POINTS false
213#define DEBUG_POINTS_PROBABILITY false
214#define DEBUG_DOUBLE_LETTER false
Satoshi Kataokabc25b802013-02-21 21:54:21 +0900215#define DEBUG_CACHE false
216#define DEBUG_DUMP_ERROR false
Satoshi Kataoka8b3009e2013-04-10 11:45:12 +0900217#define DEBUG_EVALUATE_MOST_PROBABLE_STRING false
satok20d9fda2011-07-13 14:40:30 +0900218
Satoshi Kataoka952ec492012-09-11 15:51:38 +0900219#ifdef FLAG_FULL_DBG
220#define DEBUG_GEO_FULL true
221#else
Satoshi Kataoka23a57ea2012-09-10 17:59:17 +0900222#define DEBUG_GEO_FULL false
Satoshi Kataoka952ec492012-09-11 15:51:38 +0900223#endif
Satoshi Kataoka23a57ea2012-09-10 17:59:17 +0900224
satok20d9fda2011-07-13 14:40:30 +0900225#else // FLAG_DBG
satok827ced82011-07-14 09:01:09 +0900226
satok20d9fda2011-07-13 14:40:30 +0900227#define DEBUG_DICT false
228#define DEBUG_DICT_FULL false
satok0cedd2b2011-08-12 01:05:27 +0900229#define DEBUG_EDIT_DISTANCE false
satok20d9fda2011-07-13 14:40:30 +0900230#define DEBUG_NODE false
231#define DEBUG_TRACE false
232#define DEBUG_PROXIMITY_INFO false
satok0cb20972012-03-13 22:07:56 +0900233#define DEBUG_PROXIMITY_CHARS false
satok10266c02011-08-19 22:05:59 +0900234#define DEBUG_CORRECTION false
235#define DEBUG_CORRECTION_FREQ false
Keisuke Kuroyanagi806eba42012-10-09 19:57:08 +0900236#define DEBUG_SAMPLING_POINTS false
237#define DEBUG_POINTS_PROBABILITY false
Satoshi Kataoka9af53352012-11-16 23:06:41 +0900238#define DEBUG_DOUBLE_LETTER false
Satoshi Kataokabc25b802013-02-21 21:54:21 +0900239#define DEBUG_CACHE false
240#define DEBUG_DUMP_ERROR false
Satoshi Kataoka8b3009e2013-04-10 11:45:12 +0900241#define DEBUG_EVALUATE_MOST_PROBABLE_STRING false
satok20d9fda2011-07-13 14:40:30 +0900242
Satoshi Kataoka23a57ea2012-09-10 17:59:17 +0900243#define DEBUG_GEO_FULL false
244
satoke808e432010-12-02 14:53:24 +0900245#endif // FLAG_DBG
246
Jean Chalarda5d58492011-02-18 17:50:58 +0900247#ifndef S_INT_MAX
satok3c4bb772011-03-04 22:50:19 -0800248#define S_INT_MAX 2147483647 // ((1 << 31) - 1)
Jean Chalarda5d58492011-02-18 17:50:58 +0900249#endif
Jean Chalard592f2b32012-11-20 21:19:26 +0900250#ifndef S_INT_MIN
251// The literal constant -2147483648 does not work in C prior C90, because
252// the compiler tries to fit the positive number into an int and then negate it.
253// GCC warns about this.
254#define S_INT_MIN (-2147483647 - 1) // -(1 << 31)
255#endif
Satoshi Kataokaee62b782013-01-21 18:29:27 +0900256
Ken Wakasa6c224392013-01-22 13:14:53 +0900257#define M_PI_F 3.14159265f
Satoshi Kataokaee62b782013-01-21 18:29:27 +0900258#define MAX_PERCENTILE 100
259
Jean Chalard22025c62012-11-29 17:33:53 +0900260// Number of base-10 digits in the largest integer + 1 to leave room for a zero terminator.
261// As such, this is the maximum number of characters will be needed to represent an int as a
262// string, including the terminator; this is used as the size of a string buffer large enough to
263// hold any value that is intended to fit in an integer, e.g. in the code that reads the header
264// of the binary dictionary where a {key,value} string pair scheme is used.
265#define LARGEST_INT_DIGIT_COUNT 11
satok662fe692010-12-08 17:05:39 +0900266
Ken Wakasaf2789812012-09-04 12:49:46 +0900267#define NOT_VALID_WORD (-99)
268#define NOT_A_CODE_POINT (-1)
269#define NOT_A_DISTANCE (-1)
270#define NOT_A_COORDINATE (-1)
Ken Wakasaf2789812012-09-04 12:49:46 +0900271#define NOT_AN_INDEX (-1)
272#define NOT_A_PROBABILITY (-1)
satoke808e432010-12-02 14:53:24 +0900273
satok817e5172011-03-04 06:06:45 -0800274#define KEYCODE_SPACE ' '
Ken Wakasa1e614932012-10-29 18:06:22 +0900275#define KEYCODE_SINGLE_QUOTE '\''
276#define KEYCODE_HYPHEN_MINUS '-'
satok817e5172011-03-04 06:06:45 -0800277
Tom Ouyang31f7ece2013-02-21 15:42:05 -0800278#define SUGGEST_INTERFACE_OUTPUT_SCALE 1000000.0f
Satoshi Kataokae0e67372013-03-18 13:08:31 +0900279#define MAX_PROBABILITY 255
280#define MAX_BIGRAM_ENCODED_PROBABILITY 15
satoke808e432010-12-02 14:53:24 +0900281
Ken Wakasa9e0c7112012-08-09 22:26:58 +0900282// Assuming locale strings such as en_US, sr-Latn etc.
283#define MAX_LOCALE_STRING_LENGTH 10
284
Satoshi Kataoka830ba672013-03-05 14:12:06 +0900285// Max value for length, distance and probability which are used in weighting
286// TODO: Remove
287#define MAX_VALUE_FOR_WEIGHTING 10000000
Satoshi Kataoka687a2442012-08-23 15:46:43 +0900288
Keisuke Kuroyanagi95a49a52012-09-04 17:00:24 +0900289// The max number of the keys in one keyboard layout
290#define MAX_KEY_COUNT_IN_A_KEYBOARD 64
291
Ken Wakasa5150e152012-09-27 19:21:25 +0900292// TODO: Remove
Satoshi Kataokafe4f1ce2012-12-10 17:17:52 +0900293#define MAX_POINTER_COUNT 1
Satoshi Kataoka99eae8e2013-01-30 20:55:31 +0900294#define MAX_POINTER_COUNT_G 2
Ken Wakasa5150e152012-09-27 19:21:25 +0900295
Ken Wakasa11dc3a32013-06-04 15:40:30 +0900296// Queue IDs and size for DicNodesCache
297#define DIC_NODES_CACHE_INITIAL_QUEUE_ID_ACTIVE 0
298#define DIC_NODES_CACHE_INITIAL_QUEUE_ID_NEXT_ACTIVE 1
299#define DIC_NODES_CACHE_INITIAL_QUEUE_ID_TERMINAL 2
300#define DIC_NODES_CACHE_INITIAL_QUEUE_ID_CACHE_FOR_CONTINUOUS_SUGGESTION 3
301#define DIC_NODES_CACHE_PRIORITY_QUEUES_SIZE 4
302
Ken Wakasa871b8c92013-01-31 18:05:26 +0900303template<typename T> AK_FORCE_INLINE const T &min(const T &a, const T &b) { return a < b ? a : b; }
304template<typename T> AK_FORCE_INLINE const T &max(const T &a, const T &b) { return a > b ? a : b; }
satokf5cded12010-12-06 21:28:24 +0900305
Ken Wakasab02ee3d2012-10-08 11:46:14 +0900306#define NELEMS(x) (sizeof(x) / sizeof((x)[0]))
307
satoke05b3f42012-01-31 17:15:43 +0900308// DEBUG
Ken Wakasaf2789812012-09-04 12:49:46 +0900309#define INPUTLENGTH_FOR_DEBUG (-1)
310#define MIN_OUTPUT_INDEX_FOR_DEBUG (-1)
satoke05b3f42012-01-31 17:15:43 +0900311
satok1bc038c2012-06-14 11:25:50 -0700312#define DISALLOW_COPY_AND_ASSIGN(TypeName) \
313 TypeName(const TypeName&); \
314 void operator=(const TypeName&)
315
316#define DISALLOW_IMPLICIT_CONSTRUCTORS(TypeName) \
317 TypeName(); \
318 DISALLOW_COPY_AND_ASSIGN(TypeName)
319
Satoshi Kataoka3e8c58f2012-06-05 17:55:52 +0900320// Used as a return value for character comparison
321typedef enum {
322 // Same char, possibly with different case or accent
Satoshi Kataokaf4425aa2013-03-07 13:06:32 +0900323 MATCH_CHAR,
Satoshi Kataoka3e8c58f2012-06-05 17:55:52 +0900324 // It is a char located nearby on the keyboard
Satoshi Kataokaf4425aa2013-03-07 13:06:32 +0900325 PROXIMITY_CHAR,
Satoshi Kataoka3e8c58f2012-06-05 17:55:52 +0900326 // Additional proximity char which can differ by language.
Satoshi Kataokaf4425aa2013-03-07 13:06:32 +0900327 ADDITIONAL_PROXIMITY_CHAR,
328 // It is a substitution char
329 SUBSTITUTION_CHAR,
330 // It is an unrelated char
331 UNRELATED_CHAR,
Satoshi Kataoka3e8c58f2012-06-05 17:55:52 +0900332} ProximityType;
Satoshi Kataoka6ae8dd42012-11-22 20:15:40 +0900333
334typedef enum {
335 NOT_A_DOUBLE_LETTER,
336 A_DOUBLE_LETTER,
337 A_STRONG_DOUBLE_LETTER
338} DoubleLetterLevel;
Satoshi Kataokad8708912013-03-04 17:05:28 +0900339
340typedef enum {
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900341 // Correction for MATCH_CHAR
Satoshi Kataokad8708912013-03-04 17:05:28 +0900342 CT_MATCH,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900343 // Correction for PROXIMITY_CHAR
Satoshi Kataokaf4425aa2013-03-07 13:06:32 +0900344 CT_PROXIMITY,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900345 // Correction for ADDITIONAL_PROXIMITY_CHAR
Satoshi Kataokaf4425aa2013-03-07 13:06:32 +0900346 CT_ADDITIONAL_PROXIMITY,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900347 // Correction for SUBSTITUTION_CHAR
Satoshi Kataokaf4425aa2013-03-07 13:06:32 +0900348 CT_SUBSTITUTION,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900349 // Skip one omitted letter
Satoshi Kataokad8708912013-03-04 17:05:28 +0900350 CT_OMISSION,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900351 // Delete an unnecessarily inserted letter
Satoshi Kataokad8708912013-03-04 17:05:28 +0900352 CT_INSERTION,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900353 // Swap the order of next two touch points
Satoshi Kataokad8708912013-03-04 17:05:28 +0900354 CT_TRANSPOSITION,
Satoshi Kataokad8708912013-03-04 17:05:28 +0900355 CT_COMPLETION,
356 CT_TERMINAL,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900357 // Create new word with space omission
Satoshi Kataoka252412d2013-04-16 14:39:30 +0900358 CT_NEW_WORD_SPACE_OMITTION,
Keisuke Kuroynagi911f3262013-04-24 20:21:18 +0900359 // Create new word with space substitution
Satoshi Kataoka252412d2013-04-16 14:39:30 +0900360 CT_NEW_WORD_SPACE_SUBSTITUTION,
Satoshi Kataokad8708912013-03-04 17:05:28 +0900361} CorrectionType;
Keisuke Kuroynagi60a169f2013-04-25 16:47:38 +0900362
363// ErrorType is mainly decided by CorrectionType but it is also depending on if
364// the correction has really been performed or not.
365typedef enum {
366 // Substitution, omission and transposition
367 ET_EDIT_CORRECTION,
368 // Proximity error
369 ET_PROXIMITY_CORRECTION,
370 // Completion
371 ET_COMPLETION,
372 // New word
373 // TODO: Remove.
374 // A new word error should be an edit correction error or a proximity correction error.
375 ET_NEW_WORD,
376 // Treat error as an intentional omission when the CorrectionType is omission and the node can
377 // be intentional omission.
378 ET_INTENTIONAL_OMISSION,
379 // Not treated as an error. Tracked for checking exact match
380 ET_NOT_AN_ERROR
381} ErrorType;
satoke808e432010-12-02 14:53:24 +0900382#endif // LATINIME_DEFINES_H