LastComposedWord.java revision bb0eca57054758ef17b032d2654c1fc5f6b32101
1267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard/* 2267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * Copyright (C) 2012 The Android Open Source Project 3267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * 48aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * Licensed under the Apache License, Version 2.0 (the "License"); 58aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * you may not use this file except in compliance with the License. 68aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * You may obtain a copy of the License at 7267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * 88aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * http://www.apache.org/licenses/LICENSE-2.0 9267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * 10267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * Unless required by applicable law or agreed to in writing, software 118aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * distributed under the License is distributed on an "AS IS" BASIS, 128aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 138aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * See the License for the specific language governing permissions and 148aa9963a895f9dd5bb1bc92ab2e4f461e058f87aTadashi G. Takaoka * limitations under the License. 15267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard */ 16267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 17267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalardpackage com.android.inputmethod.latin; 18267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 192692a8700737d8eed268039aa27b22a31669da08Jean Chalardimport android.text.TextUtils; 202692a8700737d8eed268039aa27b22a31669da08Jean Chalard 21f8accd8839d291f10b218e64aa6b8eb154c92c4cJean Chalardimport com.android.inputmethod.event.Event; 22f8accd8839d291f10b218e64aa6b8eb154c92c4cJean Chalard 23f8accd8839d291f10b218e64aa6b8eb154c92c4cJean Chalardimport java.util.ArrayList; 24f8accd8839d291f10b218e64aa6b8eb154c92c4cJean Chalard 25267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard/** 26267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * This class encapsulates data about a word previously composed, but that has been 27267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard * committed already. This is used for resuming suggestion, and cancel auto-correction. 28267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard */ 29a28a05e971cc242b338331a3b78276fa95188d19Tadashi G. Takaokapublic final class LastComposedWord { 30267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_USER_TYPED_WORD is used when the word committed is the exact typed word, with 31267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // no hinting from the IME. It happens when some external event happens (rotating the device, 32267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // for example) or when auto-correction is off by settings or editor attributes. 33267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_USER_TYPED_WORD = 0; 34267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_MANUAL_PICK is used when the user pressed a field in the suggestion strip. 35267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_MANUAL_PICK = 1; 36267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_DECIDED_WORD is used when the IME commits the word it decided was best 37267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // for the current user input. It may be different from what the user typed (true auto-correct) 38267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // or it may be exactly what the user typed if it's in the dictionary or the IME does not have 39267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // enough confidence in any suggestion to auto-correct (auto-correct to typed word). 40267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_DECIDED_WORD = 2; 41267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // COMMIT_TYPE_CANCEL_AUTO_CORRECT is used upon committing back the old word upon cancelling 42267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard // an auto-correction. 43267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard public static final int COMMIT_TYPE_CANCEL_AUTO_CORRECT = 3; 44267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 45a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard public static final String NOT_A_SEPARATOR = ""; 4666bb563535dbe3672f99f75bd71763a551444867Jean Chalard 47f8accd8839d291f10b218e64aa6b8eb154c92c4cJean Chalard public final ArrayList<Event> mEvents; 481f8fc62ccb5018716457dc309ab11ad3e1506ad1Jean Chalard public final String mTypedWord; 494752b68f5a62ede099677bdea0514ba1d5082606Jean Chalard public final CharSequence mCommittedWord; 50a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard public final String mSeparatorString; 51bb0eca57054758ef17b032d2654c1fc5f6b32101Keisuke Kuroyanagi public final NgramContext mNgramContext; 52b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard public final int mCapitalizedMode; 5396b22200beb98fd1a6288f4cf53e38611a09cdd0Ken Wakasa public final InputPointers mInputPointers = 54ffcbbaf12788a9fc9398607a548e552d7d2bf05eSatoshi Kataoka new InputPointers(Constants.DICTIONARY_MAX_WORD_LENGTH); 55267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard 56b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard private boolean mActive; 57b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard 582692a8700737d8eed268039aa27b22a31669da08Jean Chalard public static final LastComposedWord NOT_A_COMPOSED_WORD = 591ef9d5938e671ce7a9d5c29d95c1364d6d6249eaJean Chalard new LastComposedWord(new ArrayList<Event>(), null, "", "", 6075715f7d9fb0b19c2ddaf73bf62148c7d19f0a99Jean Chalard NOT_A_SEPARATOR, null, WordComposer.CAPS_MODE_OFF); 612692a8700737d8eed268039aa27b22a31669da08Jean Chalard 62a7f2500001c53dc5a6de9c2525a75229cc7c6645Jean Chalard // Warning: this is using the passed objects as is and fully expects them to be 63a7f2500001c53dc5a6de9c2525a75229cc7c6645Jean Chalard // immutable. Do not fiddle with their contents after you passed them to this constructor. 641ef9d5938e671ce7a9d5c29d95c1364d6d6249eaJean Chalard public LastComposedWord(final ArrayList<Event> events, 65f8accd8839d291f10b218e64aa6b8eb154c92c4cJean Chalard final InputPointers inputPointers, final String typedWord, 66f8accd8839d291f10b218e64aa6b8eb154c92c4cJean Chalard final CharSequence committedWord, final String separatorString, 67bb0eca57054758ef17b032d2654c1fc5f6b32101Keisuke Kuroyanagi final NgramContext ngramContext, final int capitalizedMode) { 6871538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka if (inputPointers != null) { 6971538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka mInputPointers.copy(inputPointers); 7071538b08e4e08d556f700ad344562ca2c7b74d82Satoshi Kataoka } 711f8fc62ccb5018716457dc309ab11ad3e1506ad1Jean Chalard mTypedWord = typedWord; 72a91561aa58db1c43092c1caecc051a11fa5391c7Tadashi G. Takaoka mEvents = new ArrayList<>(events); 73cf9d92629cae88273805eaf7984fcfdd8afd11f5Jean Chalard mCommittedWord = committedWord; 74a05a0f20776b4c33f41f043f1bff245331937580Jean Chalard mSeparatorString = separatorString; 75b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard mActive = true; 76bb0eca57054758ef17b032d2654c1fc5f6b32101Keisuke Kuroyanagi mNgramContext = ngramContext; 77b6b7f5e39e9ea1bf9a05203c536327a6be7e7214Jean Chalard mCapitalizedMode = capitalizedMode; 78b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard } 79b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard 80b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard public void deactivate() { 81b6b8729374dc68b153f00730c79828532acf1ee5Jean Chalard mActive = false; 82267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard } 832692a8700737d8eed268039aa27b22a31669da08Jean Chalard 845935950d4431dd7eef18ebc370f2abeb614465d4Jean Chalard public boolean canRevertCommit() { 850e9e7e337defe97d4ede8c59d0e925f5401f9292Jean Chalard return mActive && !TextUtils.isEmpty(mCommittedWord) && !didCommitTypedWord(); 862692a8700737d8eed268039aa27b22a31669da08Jean Chalard } 87193d23f40e1556074f323b7bd9695759f4798efeJean Chalard 880e9e7e337defe97d4ede8c59d0e925f5401f9292Jean Chalard private boolean didCommitTypedWord() { 89193d23f40e1556074f323b7bd9695759f4798efeJean Chalard return TextUtils.equals(mTypedWord, mCommittedWord); 90193d23f40e1556074f323b7bd9695759f4798efeJean Chalard } 91267563d1bb4d8091293fbd8774f0f95ef59f03c4Jean Chalard} 92