1 /* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 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 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 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 */ 16 17 package com.android.inputmethod.latin; 18 19 import android.text.TextUtils; 20 21 /** 22 * This class encapsulates data about a word previously composed, but that has been 23 * committed already. This is used for resuming suggestion, and cancel auto-correction. 24 */ 25 public final class LastComposedWord { 26 // COMMIT_TYPE_USER_TYPED_WORD is used when the word committed is the exact typed word, with 27 // no hinting from the IME. It happens when some external event happens (rotating the device, 28 // for example) or when auto-correction is off by settings or editor attributes. 29 public static final int COMMIT_TYPE_USER_TYPED_WORD = 0; 30 // COMMIT_TYPE_MANUAL_PICK is used when the user pressed a field in the suggestion strip. 31 public static final int COMMIT_TYPE_MANUAL_PICK = 1; 32 // COMMIT_TYPE_DECIDED_WORD is used when the IME commits the word it decided was best 33 // for the current user input. It may be different from what the user typed (true auto-correct) 34 // or it may be exactly what the user typed if it's in the dictionary or the IME does not have 35 // enough confidence in any suggestion to auto-correct (auto-correct to typed word). 36 public static final int COMMIT_TYPE_DECIDED_WORD = 2; 37 // COMMIT_TYPE_CANCEL_AUTO_CORRECT is used upon committing back the old word upon cancelling 38 // an auto-correction. 39 public static final int COMMIT_TYPE_CANCEL_AUTO_CORRECT = 3; 40 41 public static final String NOT_A_SEPARATOR = ""; 42 43 public final int[] mPrimaryKeyCodes; 44 public final String mTypedWord; 45 public final String mCommittedWord; 46 public final String mSeparatorString; 47 public final String mPrevWord; 48 public final int mCapitalizedMode; 49 public final InputPointers mInputPointers = 50 new InputPointers(Constants.Dictionary.MAX_WORD_LENGTH); 51 52 private boolean mActive; 53 54 public static final LastComposedWord NOT_A_COMPOSED_WORD = 55 new LastComposedWord(null, null, "", "", NOT_A_SEPARATOR, null, 56 WordComposer.CAPS_MODE_OFF); 57 58 // Warning: this is using the passed objects as is and fully expects them to be 59 // immutable. Do not fiddle with their contents after you passed them to this constructor. LastComposedWord(final int[] primaryKeyCodes, final InputPointers inputPointers, final String typedWord, final String committedWord, final String separatorString, final String prevWord, final int capitalizedMode)60 public LastComposedWord(final int[] primaryKeyCodes, final InputPointers inputPointers, 61 final String typedWord, final String committedWord, final String separatorString, 62 final String prevWord, final int capitalizedMode) { 63 mPrimaryKeyCodes = primaryKeyCodes; 64 if (inputPointers != null) { 65 mInputPointers.copy(inputPointers); 66 } 67 mTypedWord = typedWord; 68 mCommittedWord = committedWord; 69 mSeparatorString = separatorString; 70 mActive = true; 71 mPrevWord = prevWord; 72 mCapitalizedMode = capitalizedMode; 73 } 74 deactivate()75 public void deactivate() { 76 mActive = false; 77 } 78 canRevertCommit()79 public boolean canRevertCommit() { 80 return mActive && !TextUtils.isEmpty(mCommittedWord) && !didCommitTypedWord(); 81 } 82 didCommitTypedWord()83 private boolean didCommitTypedWord() { 84 return TextUtils.equals(mTypedWord, mCommittedWord); 85 } 86 getSeparatorLength(final String separatorString)87 public static int getSeparatorLength(final String separatorString) { 88 return StringUtils.codePointCount(separatorString); 89 } 90 } 91