LastComposedWord.java revision a05a0f20776b4c33f41f043f1bff245331937580
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 */ 25267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalardpublic 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; 47c54d558e2e70bdfb2c1078cae7b88440d421dc67satok public final CharSequence mPrevWord; 4857f7de0ba664187e13bcea5adff7f5f65eddd823Tadashi G. Takaoka public final InputPointers mInputPointers = new InputPointers(BinaryDictionary.MAX_WORD_LENGTH); 49267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 50b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard private boolean mActive; 51b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard 522692a8700737d8eed268039aa27b22a31669da08Jean Chalard public static final LastComposedWord NOT_A_COMPOSED_WORD = 5371538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka new LastComposedWord(null, null, "", "", NOT_A_SEPARATOR, null); 542692a8700737d8eed268039aa27b22a31669da08Jean Chalard 55a7f2500001c53dc5a6de9c2525a75229cc7c6645Jean Chalard // Warning: this is using the passed objects as is and fully expects them to be 56a7f2500001c53dc5a6de9c2525a75229cc7c6645Jean Chalard // immutable. Do not fiddle with their contents after you passed them to this constructor. 5771538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka public LastComposedWord(final int[] primaryKeyCodes, final InputPointers inputPointers, 5871538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka final String typedWord, final String committedWord, 59a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard final String separatorString, final CharSequence prevWord) { 6001ab7c8b59a7f12862fbd95fb252e56719f1757fsatok mPrimaryKeyCodes = primaryKeyCodes; 6171538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka if (inputPointers != null) { 6271538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka mInputPointers.copy(inputPointers); 6371538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka } 641f8fc62ccb5018716457dc309ab11ad3e1506ad1Jean Chalard mTypedWord = typedWord; 65cf9d92629cae88273805eaf7984fcfdd8afd11f5Jean Chalard mCommittedWord = committedWord; 66a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard mSeparatorString = separatorString; 67b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard mActive = true; 68c54d558e2e70bdfb2c1078cae7b88440d421dc67satok mPrevWord = prevWord; 69b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard } 70b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard 71b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard public void deactivate() { 72b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard mActive = false; 73267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard } 742692a8700737d8eed268039aa27b22a31669da08Jean Chalard 755935950d4431dd7eef18ebc370f2abeb614465d4Jean Chalard public boolean canRevertCommit() { 760e9e7e337defe97d4ede8c59d0e925f5401f9292Jean Chalard return mActive && !TextUtils.isEmpty(mCommittedWord) && !didCommitTypedWord(); 772692a8700737d8eed268039aa27b22a31669da08Jean Chalard } 78193d23f40e1556074f323b7bd9695759f4798efeJean Chalard 790e9e7e337defe97d4ede8c59d0e925f5401f9292Jean Chalard private boolean didCommitTypedWord() { 80193d23f40e1556074f323b7bd9695759f4798efeJean Chalard return TextUtils.equals(mTypedWord, mCommittedWord); 81193d23f40e1556074f323b7bd9695759f4798efeJean Chalard } 82193d23f40e1556074f323b7bd9695759f4798efeJean Chalard 83a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard public static int getSeparatorLength(final String separatorString) { 84a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard return StringUtils.codePointCount(separatorString); 85193d23f40e1556074f323b7bd9695759f4798efeJean Chalard } 86267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard} 87