LastComposedWord.java revision b6b7f5e39e9ea1bf9a05203c536327a6be7e7214
1267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard/* 2267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * Copyright (C) 2012 The Android Open Source Project 3267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * 4267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * use this file except in compliance with the License. You may obtain a copy of 6267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * the License at 7267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * 8267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * http://www.apache.org/licenses/LICENSE-2.0 9267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * 10267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * Unless required by applicable law or agreed to in writing, software 11267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * License for the specific language governing permissions and limitations under 14267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * the License. 15267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard */ 16267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 17267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalardpackage com.android.inputmethod.latin; 18267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 192692a8700737d8eed268039aa27b22a31669da08Jean Chalardimport android.text.TextUtils; 202692a8700737d8eed268039aa27b22a31669da08Jean Chalard 21267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard/** 22267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * This class encapsulates data about a word previously composed, but that has been 23267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * committed already. This is used for resuming suggestion, and cancel auto-correction. 24267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard */ 25a28a05e971cc242b338331a3b78276fa95188d19Tadashi G. Takaokapublic final class LastComposedWord { 26267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_USER_TYPED_WORD is used when the word committed is the exact typed word, with 27267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // no hinting from the IME. It happens when some external event happens (rotating the device, 28267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // for example) or when auto-correction is off by settings or editor attributes. 29267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_USER_TYPED_WORD = 0; 30267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_MANUAL_PICK is used when the user pressed a field in the suggestion strip. 31267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_MANUAL_PICK = 1; 32267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_DECIDED_WORD is used when the IME commits the word it decided was best 33267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // for the current user input. It may be different from what the user typed (true auto-correct) 34267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // or it may be exactly what the user typed if it's in the dictionary or the IME does not have 35267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // enough confidence in any suggestion to auto-correct (auto-correct to typed word). 36267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_DECIDED_WORD = 2; 37267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_CANCEL_AUTO_CORRECT is used upon committing back the old word upon cancelling 38267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // an auto-correction. 39267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_CANCEL_AUTO_CORRECT = 3; 40267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 41a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard public static final String NOT_A_SEPARATOR = ""; 4266bb563535dbe3672f99f75bd71763a551444867Jean Chalard 4301ab7c8b59a7f12862fbd95fb252e56719f1757fsatok public final int[] mPrimaryKeyCodes; 441f8fc62ccb5018716457dc309ab11ad3e1506ad1Jean Chalard public final String mTypedWord; 45cf9d92629cae88273805eaf7984fcfdd8afd11f5Jean Chalard public final String mCommittedWord; 46a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard public final String mSeparatorString; 47bc464e2952e102219f0b977fc1e9140ad5bd03e4Tadashi G. Takaoka public final String mPrevWord; 48b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard public final int mCapitalizedMode; 4996b22200beb98fd1a6288f4cf53e38611a09cdd0Ken Wakasa public final InputPointers mInputPointers = 5096b22200beb98fd1a6288f4cf53e38611a09cdd0Ken Wakasa new InputPointers(Constants.Dictionary.MAX_WORD_LENGTH); 51267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 52b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard private boolean mActive; 53b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard 542692a8700737d8eed268039aa27b22a31669da08Jean Chalard public static final LastComposedWord NOT_A_COMPOSED_WORD = 55b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard new LastComposedWord(null, null, "", "", NOT_A_SEPARATOR, null, 56b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard WordComposer.CAPS_MODE_OFF); 572692a8700737d8eed268039aa27b22a31669da08Jean Chalard 58a7f2500001c53dc5a6de9c2525a75229cc7c6645Jean Chalard // Warning: this is using the passed objects as is and fully expects them to be 59a7f2500001c53dc5a6de9c2525a75229cc7c6645Jean Chalard // immutable. Do not fiddle with their contents after you passed them to this constructor. 6071538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka public LastComposedWord(final int[] primaryKeyCodes, final InputPointers inputPointers, 61b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard final String typedWord, final String committedWord, final String separatorString, 62b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard final String prevWord, final int capitalizedMode) { 6301ab7c8b59a7f12862fbd95fb252e56719f1757fsatok mPrimaryKeyCodes = primaryKeyCodes; 6471538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka if (inputPointers != null) { 6571538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka mInputPointers.copy(inputPointers); 6671538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka } 671f8fc62ccb5018716457dc309ab11ad3e1506ad1Jean Chalard mTypedWord = typedWord; 68cf9d92629cae88273805eaf7984fcfdd8afd11f5Jean Chalard mCommittedWord = committedWord; 69a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard mSeparatorString = separatorString; 70b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard mActive = true; 71c54d558e2e70bdfb2c1078cae7b88440d421dc67satok mPrevWord = prevWord; 72b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard mCapitalizedMode = capitalizedMode; 73b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard } 74b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard 75b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard public void deactivate() { 76b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard mActive = false; 77267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard } 782692a8700737d8eed268039aa27b22a31669da08Jean Chalard 795935950d4431dd7eef18ebc370f2abeb614465d4Jean Chalard public boolean canRevertCommit() { 800e9e7e337defe97d4ede8c59d0e925f5401f9292Jean Chalard return mActive && !TextUtils.isEmpty(mCommittedWord) && !didCommitTypedWord(); 812692a8700737d8eed268039aa27b22a31669da08Jean Chalard } 82193d23f40e1556074f323b7bd9695759f4798efeJean Chalard 830e9e7e337defe97d4ede8c59d0e925f5401f9292Jean Chalard private boolean didCommitTypedWord() { 84193d23f40e1556074f323b7bd9695759f4798efeJean Chalard return TextUtils.equals(mTypedWord, mCommittedWord); 85193d23f40e1556074f323b7bd9695759f4798efeJean Chalard } 86193d23f40e1556074f323b7bd9695759f4798efeJean Chalard 87a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard public static int getSeparatorLength(final String separatorString) { 88a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard return StringUtils.codePointCount(separatorString); 89193d23f40e1556074f323b7bd9695759f4798efeJean Chalard } 90267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard} 91