defines.h revision 20d9fdae3ac12a7efa6daf6f582a3d5a4311a375
1e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok/* 2e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** 3e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** Copyright 2010, The Android Open Source Project 4e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** 5e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** Licensed under the Apache License, Version 2.0 (the "License"); 6e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** you may not use this file except in compliance with the License. 7e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** You may obtain a copy of the License at 8e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** 9e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** http://www.apache.org/licenses/LICENSE-2.0 10e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** 11e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** Unless required by applicable law or agreed to in writing, software 12e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** distributed under the License is distributed on an "AS IS" BASIS, 13e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** See the License for the specific language governing permissions and 15e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok** limitations under the License. 16e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok*/ 17e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 18e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#ifndef LATINIME_DEFINES_H 19e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define LATINIME_DEFINES_H 20e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 2120d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#ifdef FLAG_DO_PROFILE 2261e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok// Profiler 2361e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#include <time.h> 2461e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_BUF_SIZE 100 2561e2f85e3fe6c0cc266996bc9a3692ed5795fad3satokstatic double profile_buf[PROF_BUF_SIZE]; 2661e2f85e3fe6c0cc266996bc9a3692ed5795fad3satokstatic double profile_old[PROF_BUF_SIZE]; 2761e2f85e3fe6c0cc266996bc9a3692ed5795fad3satokstatic unsigned int profile_counter[PROF_BUF_SIZE]; 2861e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok 29e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_RESET prof_reset() 30e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_COUNT(prof_buf_id) ++profile_counter[prof_buf_id] 31e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_OPEN do { PROF_RESET; PROF_START(PROF_BUF_SIZE - 1); } while(0) 32e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_START(prof_buf_id) do { \ 33e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa PROF_COUNT(prof_buf_id); profile_old[prof_buf_id] = (clock()); } while(0) 34e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_CLOSE do { PROF_END(PROF_BUF_SIZE - 1); PROF_OUTALL; } while(0) 35e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_END(prof_buf_id) profile_buf[prof_buf_id] += ((clock()) - profile_old[prof_buf_id]) 36e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_CLOCKOUT(prof_buf_id) \ 37e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa LOGI("%s : clock is %f", __FUNCTION__, (clock() - profile_old[prof_buf_id])) 38e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define PROF_OUTALL do { LOGI("--- %s ---", __FUNCTION__); prof_out(); } while(0) 39e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa 40e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasastatic void prof_reset(void) { 41e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa for (int i = 0; i < PROF_BUF_SIZE; ++i) { 4261e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok profile_buf[i] = 0; 4361e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok profile_old[i] = 0; 4461e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok profile_counter[i] = 0; 4561e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok } 4661e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok} 4761e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok 48e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasastatic void prof_out(void) { 4961e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok if (profile_counter[PROF_BUF_SIZE - 1] != 1) { 5061e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok LOGI("Error: You must call PROF_OPEN before PROF_CLOSE."); 5161e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok } 5261e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok LOGI("Total time is %6.3f ms.", 53e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa profile_buf[PROF_BUF_SIZE - 1] * 1000 / (double)CLOCKS_PER_SEC); 5461e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok double all = 0; 55e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa for (int i = 0; i < PROF_BUF_SIZE - 1; ++i) { 5661e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok all += profile_buf[i]; 5761e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok } 58e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa if (all == 0) all = 1; 59e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa for (int i = 0; i < PROF_BUF_SIZE - 1; ++i) { 60e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa if (profile_buf[i] != 0) { 6161e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok LOGI("(%d): Used %4.2f%%, %8.4f ms. Called %d times.", 62e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa i, (profile_buf[i] * 100 / all), 63e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa profile_buf[i] * 1000 / (double)CLOCKS_PER_SEC, profile_counter[i]); 64e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa } 6561e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok } 6661e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok} 6761e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok 6820d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#else // FLAG_DO_PROFILE 6961e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_BUF_SIZE 0 7061e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_RESET 7161e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_COUNT(prof_buf_id) 7261e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_OPEN 7361e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_START(prof_buf_id) 7461e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_CLOSE 7561e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_END(prof_buf_id) 7661e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_CLOCK_OUT(prof_buf_id) 7761e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_CLOCKOUT(prof_buf_id) 7861e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok#define PROF_OUTALL 7961e2f85e3fe6c0cc266996bc9a3692ed5795fad3satok 8020d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#endif // FLAG_DO_PROFILE 8120d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok 8220d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#ifdef FLAG_DBG 8320d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#include <cutils/log.h> 8420d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#ifndef LOG_TAG 8520d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define LOG_TAG "LatinIME: " 8620d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#endif 8720d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_DICT true 8820d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_DICT_FULL false 8920d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_SHOW_FOUND_WORD DEBUG_DICT_FULL 9020d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_NODE DEBUG_DICT_FULL 9120d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_TRACE DEBUG_DICT_FULL 9220d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_PROXIMITY_INFO true 9320d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok 9420d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#else // FLAG_DBG 9520d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define LOGE(fmt, ...) 9620d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define LOGI(fmt, ...) 9720d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_DICT false 9820d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_DICT_FULL false 9920d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_SHOW_FOUND_WORD false 10020d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_NODE false 10120d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_TRACE false 10220d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok#define DEBUG_PROXIMITY_INFO false 10320d9fdae3ac12a7efa6daf6f582a3d5a4311a375satok 104e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#endif // FLAG_DBG 105e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 106662fe69ba2b8513a1a6640adde917db9a13e98afsatok#ifndef U_SHORT_MAX 107662fe69ba2b8513a1a6640adde917db9a13e98afsatok#define U_SHORT_MAX 1 << 16 108662fe69ba2b8513a1a6640adde917db9a13e98afsatok#endif 109a5d58497018f465080f08fbbfed35de883bc8be3Jean Chalard#ifndef S_INT_MAX 1103c4bb7747d1a16d6b9d2d34992bad250069632a7satok#define S_INT_MAX 2147483647 // ((1 << 31) - 1) 111a5d58497018f465080f08fbbfed35de883bc8be3Jean Chalard#endif 112662fe69ba2b8513a1a6640adde917db9a13e98afsatok 113e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa// Define this to use mmap() for dictionary loading. Undefine to use malloc() instead of mmap(). 114e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa// We measured and compared performance of both, and found mmap() is fairly good in terms of 115e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa// loading time, and acceptable even for several initial lookups which involve page faults. 116e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa#define USE_MMAP_FOR_DICTIONARY 117e90b333017c68e888a5e3d351f07ea29036457d0Ken Wakasa 118e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok// 22-bit address = ~4MB dictionary size limit, which on average would be about 200k-300k words 119e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define ADDRESS_MASK 0x3FFFFF 120e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 121e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok// The bit that decides if an address follows in the next 22 bits 122e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define FLAG_ADDRESS_MASK 0x40 123e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok// The bit that decides if this is a terminal node for a word. The node could still have children, 124e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok// if the word has other endings. 125e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define FLAG_TERMINAL_MASK 0x80 126e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 127e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define FLAG_BIGRAM_READ 0x80 128e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define FLAG_BIGRAM_CHILDEXIST 0x40 129e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define FLAG_BIGRAM_CONTINUED 0x80 130e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define FLAG_BIGRAM_FREQ 0x7F 131e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 132e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define DICTIONARY_VERSION_MIN 200 133e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define DICTIONARY_HEADER_SIZE 2 134e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#define NOT_VALID_WORD -99 135e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 136817e517e463cb32726ff5a62196ac8744848e29bsatok#define KEYCODE_SPACE ' ' 137817e517e463cb32726ff5a62196ac8744848e29bsatok 138662fe69ba2b8513a1a6640adde917db9a13e98afsatok#define SUGGEST_WORDS_WITH_MISSING_CHARACTER true 139662fe69ba2b8513a1a6640adde917db9a13e98afsatok#define SUGGEST_WORDS_WITH_MISSING_SPACE_CHARACTER true 140662fe69ba2b8513a1a6640adde917db9a13e98afsatok#define SUGGEST_WORDS_WITH_EXCESSIVE_CHARACTER true 141a3d78f606e8e764c22637299a58c27e195b4e1d3satok#define SUGGEST_WORDS_WITH_TRANSPOSED_CHARACTERS true 142817e517e463cb32726ff5a62196ac8744848e29bsatok#define SUGGEST_WORDS_WITH_SPACE_PROXIMITY true 143a3d78f606e8e764c22637299a58c27e195b4e1d3satok 1448dc754a41129cad5371b7c39b6d5826758de550aJean Chalard// The following "rate"s are used as a multiplier before dividing by 100, so they are in percent. 14572bc17ec9ff200a2fe6f737f3bc5a8fff15c426fsatok#define WORDS_WITH_MISSING_CHARACTER_DEMOTION_RATE 80 146dc5301e5902826b0e9a44fc3d45695526eaf66b3satok#define WORDS_WITH_MISSING_CHARACTER_DEMOTION_START_POS_10X 12 14799c908a5958446e1f887bcfbeb4f2772e7ea5b85satok#define WORDS_WITH_MISSING_SPACE_CHARACTER_DEMOTION_RATE 67 148a3d78f606e8e764c22637299a58c27e195b4e1d3satok#define WORDS_WITH_EXCESSIVE_CHARACTER_DEMOTION_RATE 75 14954fe9e0e20896f8d9813aeac7953ead9369bd4adsatok#define WORDS_WITH_EXCESSIVE_CHARACTER_OUT_OF_PROXIMITY_DEMOTION_RATE 75 150a3d78f606e8e764c22637299a58c27e195b4e1d3satok#define WORDS_WITH_TRANSPOSED_CHARACTERS_DEMOTION_RATE 60 15158c49b91322847dc453742cb34c2899da9b44479satok#define FULL_MATCHED_WORDS_PROMOTION_RATE 120 1529d2a3020ba369a9d187a7d8dcba634c8a6eb1f81satok#define WORDS_WITH_PROXIMITY_CHARACTER_DEMOTION_RATE 90 153e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok 154f5cded1c6cf0f39df13750d4f9f5ba66c1b32964satok// This should be greater than or equal to MAX_WORD_LENGTH defined in BinaryDictionary.java 155f5cded1c6cf0f39df13750d4f9f5ba66c1b32964satok// This is only used for the size of array. Not to be used in c functions. 156f5cded1c6cf0f39df13750d4f9f5ba66c1b32964satok#define MAX_WORD_LENGTH_INTERNAL 48 157715514d7dd5716c77781b97d4f6ac8eace75e8b3satok 158683192684c18d068573e5ae0c14da3839fbdbf74satok#define MAX_DEPTH_MULTIPLIER 3 159683192684c18d068573e5ae0c14da3839fbdbf74satok 160a787dba83b9c3ac8732a958e0d935c3b4e181628Jean Chalard// TODO: Reduce this constant if possible; check the maximum number of umlauts in the same German 161a787dba83b9c3ac8732a958e0d935c3b4e181628Jean Chalard// word in the dictionary 162a787dba83b9c3ac8732a958e0d935c3b4e181628Jean Chalard#define DEFAULT_MAX_UMLAUT_SEARCH_DEPTH 5 163a787dba83b9c3ac8732a958e0d935c3b4e181628Jean Chalard 16454fe9e0e20896f8d9813aeac7953ead9369bd4adsatok// Minimum suggest depth for one word for all cases except for missing space suggestions. 16554fe9e0e20896f8d9813aeac7953ead9369bd4adsatok#define MIN_SUGGEST_DEPTH 1 16654fe9e0e20896f8d9813aeac7953ead9369bd4adsatok#define MIN_USER_TYPED_LENGTH_FOR_MISSING_SPACE_SUGGESTION 3 16754fe9e0e20896f8d9813aeac7953ead9369bd4adsatok#define MIN_USER_TYPED_LENGTH_FOR_EXCESSIVE_CHARACTER_SUGGESTION 3 168662fe69ba2b8513a1a6640adde917db9a13e98afsatok 169887f11ee43ad621aa6ad93d535ab7f48dec73fc7Tadashi G. Takaoka// The size of next letters frequency array. Zero will disable the feature. 170887f11ee43ad621aa6ad93d535ab7f48dec73fc7Tadashi G. Takaoka#define NEXT_LETTERS_SIZE 0 171887f11ee43ad621aa6ad93d535ab7f48dec73fc7Tadashi G. Takaoka 172f5cded1c6cf0f39df13750d4f9f5ba66c1b32964satok#define min(a,b) ((a)<(b)?(a):(b)) 173f5cded1c6cf0f39df13750d4f9f5ba66c1b32964satok 174e808e436cbd6f1aeadb5d61f354d03c3c50872a7satok#endif // LATINIME_DEFINES_H 175