nyancrimew/LatinIME
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[IL123] Put the settings values inside the transaction

Browse source 
A transaction should always operate with a consistent set
of settings. It's better to have it reference them than to
always pass them along.

Bug: 8636060
Change-Id: I3c642dfea6be30712fc6cbb279c64f3185895791
This commit is contained in:
Jean Chalard 2014-03-04 16:46:42 +09:00
parent 5054530934
commit db38d5cf63
2 changed files with 58 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
java/src/com/android/inputmethod/event/InputTransaction.java
View file

@ -16,6 +16,8 @@
package com.android.inputmethod.event; package com.android.inputmethod.event;
import com.android.inputmethod.latin.settings.SettingsValues;
/** /**
* An object encapsulating a single transaction for input. * An object encapsulating a single transaction for input.
*/ */
@ -30,6 +32,7 @@ public class InputTransaction {
public static final int SHIFT_UPDATE_LATER = 2; public static final int SHIFT_UPDATE_LATER = 2;
// Initial conditions // Initial conditions
public final SettingsValues mSettingsValues;
// If the key inserts a code point, mKeyCode is always equal to the code points. Otherwise, // If the key inserts a code point, mKeyCode is always equal to the code points. Otherwise,
// it's always a code that may not be a code point, typically a negative number. // it's always a code that may not be a code point, typically a negative number.
public final int mKeyCode; public final int mKeyCode;
@ -42,8 +45,10 @@ public class InputTransaction {
// Outputs // Outputs
private int mRequiredShiftUpdate = SHIFT_NO_UPDATE; private int mRequiredShiftUpdate = SHIFT_NO_UPDATE;
public InputTransaction(final int keyCode, final int x, final int y, final long timestamp, public InputTransaction(final SettingsValues settingsValues, final int keyCode,
final int spaceState, final int shiftState) { final int x, final int y, final long timestamp, final int spaceState,
final int shiftState) {
mSettingsValues = settingsValues;
mKeyCode = keyCode; mKeyCode = keyCode;
mX = x; mX = x;
mY = y; mY = y;

104
java/src/com/android/inputmethod/latin/inputlogic/InputLogic.java
View file

@ -361,7 +361,7 @@ public final class InputLogic {
final SettingsValues settingsValues, final SettingsValues settingsValues,
// TODO: remove these two arguments // TODO: remove these two arguments
final LatinIME.UIHandler handler, final KeyboardSwitcher keyboardSwitcher) { final LatinIME.UIHandler handler, final KeyboardSwitcher keyboardSwitcher) {
final InputTransaction inputTransaction = new InputTransaction(code, x, y, final InputTransaction inputTransaction = new InputTransaction(settingsValues, code, x, y,
SystemClock.uptimeMillis(), mSpaceState, SystemClock.uptimeMillis(), mSpaceState,
getActualCapsMode(settingsValues, keyboardSwitcher.getKeyboardShiftMode())); getActualCapsMode(settingsValues, keyboardSwitcher.getKeyboardShiftMode()));
if (ProductionFlag.USES_DEVELOPMENT_ONLY_DIAGNOSTICS) { if (ProductionFlag.USES_DEVELOPMENT_ONLY_DIAGNOSTICS) {
@ -386,11 +386,11 @@ public final class InputLogic {
boolean didAutoCorrect = false; boolean didAutoCorrect = false;
switch (inputTransaction.mKeyCode) { switch (inputTransaction.mKeyCode) {
case Constants.CODE_DELETE: case Constants.CODE_DELETE:
handleBackspace(settingsValues, inputTransaction, handler); handleBackspace(inputTransaction, handler);
LatinImeLogger.logOnDelete(inputTransaction.mX, inputTransaction.mY); LatinImeLogger.logOnDelete(inputTransaction.mX, inputTransaction.mY);
break; break;
case Constants.CODE_SHIFT: case Constants.CODE_SHIFT:
performRecapitalization(settingsValues); performRecapitalization(inputTransaction.mSettingsValues);
inputTransaction.requireShiftUpdate(InputTransaction.SHIFT_UPDATE_NOW); inputTransaction.requireShiftUpdate(InputTransaction.SHIFT_UPDATE_NOW);
break; break;
case Constants.CODE_CAPSLOCK: case Constants.CODE_CAPSLOCK:
@ -445,23 +445,23 @@ public final class InputLogic {
} else { } else {
// No action label, and the action from imeOptions is NONE: this is a regular // No action label, and the action from imeOptions is NONE: this is a regular
// enter key that should input a carriage return. // enter key that should input a carriage return.
didAutoCorrect = handleNonSpecialCharacter(settingsValues, inputTransaction, didAutoCorrect = handleNonSpecialCharacter(inputTransaction, handler);
handler);
} }
break; break;
case Constants.CODE_SHIFT_ENTER: case Constants.CODE_SHIFT_ENTER:
// TODO: remove this object // TODO: remove this object
final InputTransaction tmpTransaction = new InputTransaction(inputTransaction.mKeyCode, final InputTransaction tmpTransaction = new InputTransaction(
inputTransaction.mSettingsValues, inputTransaction.mKeyCode,
inputTransaction.mX, inputTransaction.mY, inputTransaction.mTimestamp, inputTransaction.mX, inputTransaction.mY, inputTransaction.mTimestamp,
inputTransaction.mSpaceState, inputTransaction.mShiftState); inputTransaction.mSpaceState, inputTransaction.mShiftState);
didAutoCorrect = handleNonSpecialCharacter(settingsValues, tmpTransaction, handler); didAutoCorrect = handleNonSpecialCharacter(tmpTransaction, handler);
break; break;
case Constants.CODE_ALPHA_FROM_EMOJI: case Constants.CODE_ALPHA_FROM_EMOJI:
// Note: Switching back from Emoji keyboard to the main keyboard is being handled in // Note: Switching back from Emoji keyboard to the main keyboard is being handled in
// {@link KeyboardState#onCodeInput(int,int)}. // {@link KeyboardState#onCodeInput(int,int)}.
break; break;
default: default:
didAutoCorrect = handleNonSpecialCharacter(settingsValues, inputTransaction, handler); didAutoCorrect = handleNonSpecialCharacter(inputTransaction, handler);
break; break;
} }
// Reset after any single keystroke, except shift, capslock, and symbol-shift // Reset after any single keystroke, except shift, capslock, and symbol-shift
@ -625,29 +625,26 @@ public final class InputLogic {
* manage keyboard-related stuff like shift, language switch, settings, layout switch, or * manage keyboard-related stuff like shift, language switch, settings, layout switch, or
* any key that results in multiple code points like the ".com" key. * any key that results in multiple code points like the ".com" key.
* *
* @param settingsValues The current settings values.
* @param inputTransaction The transaction in progress. * @param inputTransaction The transaction in progress.
* @return whether this caused an auto-correction to happen. * @return whether this caused an auto-correction to happen.
*/ */
private boolean handleNonSpecialCharacter(final SettingsValues settingsValues, private boolean handleNonSpecialCharacter(final InputTransaction inputTransaction,
final InputTransaction inputTransaction,
// TODO: remove this argument // TODO: remove this argument
final LatinIME.UIHandler handler) { final LatinIME.UIHandler handler) {
mSpaceState = SpaceState.NONE; mSpaceState = SpaceState.NONE;
final boolean didAutoCorrect; final boolean didAutoCorrect;
if (settingsValues.isWordSeparator(inputTransaction.mKeyCode) if (inputTransaction.mSettingsValues.isWordSeparator(inputTransaction.mKeyCode)
|| Character.getType(inputTransaction.mKeyCode) == Character.OTHER_SYMBOL) { || Character.getType(inputTransaction.mKeyCode) == Character.OTHER_SYMBOL) {
didAutoCorrect = handleSeparator(settingsValues, didAutoCorrect = handleSeparator(inputTransaction,
Constants.SUGGESTION_STRIP_COORDINATE == inputTransaction.mX, inputTransaction, Constants.SUGGESTION_STRIP_COORDINATE == inputTransaction.mX, handler);
handler); if (inputTransaction.mSettingsValues.mIsInternal) {
if (settingsValues.mIsInternal) {
LatinImeLoggerUtils.onSeparator((char)inputTransaction.mKeyCode, LatinImeLoggerUtils.onSeparator((char)inputTransaction.mKeyCode,
inputTransaction.mX, inputTransaction.mY); inputTransaction.mX, inputTransaction.mY);
} }
} else { } else {
didAutoCorrect = false; didAutoCorrect = false;
if (SpaceState.PHANTOM == inputTransaction.mSpaceState) { if (SpaceState.PHANTOM == inputTransaction.mSpaceState) {
if (settingsValues.mIsInternal) { if (inputTransaction.mSettingsValues.mIsInternal) {
if (mWordComposer.isComposingWord() && mWordComposer.isBatchMode()) { if (mWordComposer.isComposingWord() && mWordComposer.isBatchMode()) {
LatinImeLoggerUtils.onAutoCorrection("", mWordComposer.getTypedWord(), " ", LatinImeLoggerUtils.onAutoCorrection("", mWordComposer.getTypedWord(), " ",
mWordComposer); mWordComposer);
@ -659,10 +656,10 @@ public final class InputLogic {
resetEntireInputState(mConnection.getExpectedSelectionStart(), resetEntireInputState(mConnection.getExpectedSelectionStart(),
mConnection.getExpectedSelectionEnd(), true /* clearSuggestionStrip */); mConnection.getExpectedSelectionEnd(), true /* clearSuggestionStrip */);
} else { } else {
commitTyped(settingsValues, LastComposedWord.NOT_A_SEPARATOR); commitTyped(inputTransaction.mSettingsValues, LastComposedWord.NOT_A_SEPARATOR);
} }
} }
handleNonSeparator(settingsValues, inputTransaction, handler); handleNonSeparator(inputTransaction.mSettingsValues, inputTransaction, handler);
} }
return didAutoCorrect; return didAutoCorrect;
} }
@ -738,7 +735,7 @@ public final class InputLogic {
mConnection.setComposingText(getTextWithUnderline( mConnection.setComposingText(getTextWithUnderline(
mWordComposer.getTypedWord()), 1); mWordComposer.getTypedWord()), 1);
} else { } else {
final boolean swapWeakSpace = maybeStripSpace(settingsValues, inputTransaction, final boolean swapWeakSpace = maybeStripSpace(inputTransaction,
Constants.SUGGESTION_STRIP_COORDINATE == inputTransaction.mX); Constants.SUGGESTION_STRIP_COORDINATE == inputTransaction.mX);
sendKeyCodePoint(settingsValues, inputTransaction.mKeyCode); sendKeyCodePoint(settingsValues, inputTransaction.mKeyCode);
@ -759,19 +756,19 @@ public final class InputLogic {
/** /**
* Handle input of a separator code point. * Handle input of a separator code point.
* @param settingsValues The current settings values.
* @param isFromSuggestionStrip whether this code point comes from the suggestion strip.
* @param inputTransaction The transaction in progress. * @param inputTransaction The transaction in progress.
* @param isFromSuggestionStrip whether this code point comes from the suggestion strip.
* @return whether this caused an auto-correction to happen. * @return whether this caused an auto-correction to happen.
*/ */
private boolean handleSeparator(final SettingsValues settingsValues, private boolean handleSeparator(final InputTransaction inputTransaction,
final boolean isFromSuggestionStrip, final InputTransaction inputTransaction, final boolean isFromSuggestionStrip,
// TODO: remove this argument // TODO: remove this argument
final LatinIME.UIHandler handler) { final LatinIME.UIHandler handler) {
boolean didAutoCorrect = false; boolean didAutoCorrect = false;
// We avoid sending spaces in languages without spaces if we were composing. // We avoid sending spaces in languages without spaces if we were composing.
final boolean shouldAvoidSendingCode = Constants.CODE_SPACE == inputTransaction.mKeyCode final boolean shouldAvoidSendingCode = Constants.CODE_SPACE == inputTransaction.mKeyCode
&& !settingsValues.mSpacingAndPunctuations.mCurrentLanguageHasSpaces && !inputTransaction.mSettingsValues.mSpacingAndPunctuations
.mCurrentLanguageHasSpaces
&& mWordComposer.isComposingWord(); && mWordComposer.isComposingWord();
if (mWordComposer.isCursorFrontOrMiddleOfComposingWord()) { if (mWordComposer.isCursorFrontOrMiddleOfComposingWord()) {
// If we are in the middle of a recorrection, we need to commit the recorrection // If we are in the middle of a recorrection, we need to commit the recorrection
@ -781,19 +778,18 @@ public final class InputLogic {
} }
// isComposingWord() may have changed since we stored wasComposing // isComposingWord() may have changed since we stored wasComposing
if (mWordComposer.isComposingWord()) { if (mWordComposer.isComposingWord()) {
if (settingsValues.mCorrectionEnabled) { if (inputTransaction.mSettingsValues.mCorrectionEnabled) {
final String separator = shouldAvoidSendingCode ? LastComposedWord.NOT_A_SEPARATOR final String separator = shouldAvoidSendingCode ? LastComposedWord.NOT_A_SEPARATOR
: StringUtils.newSingleCodePointString(inputTransaction.mKeyCode); : StringUtils.newSingleCodePointString(inputTransaction.mKeyCode);
commitCurrentAutoCorrection(settingsValues, separator, handler); commitCurrentAutoCorrection(inputTransaction.mSettingsValues, separator, handler);
didAutoCorrect = true; didAutoCorrect = true;
} else { } else {
commitTyped(settingsValues, commitTyped(inputTransaction.mSettingsValues,
StringUtils.newSingleCodePointString(inputTransaction.mKeyCode)); StringUtils.newSingleCodePointString(inputTransaction.mKeyCode));
} }
} }
final boolean swapWeakSpace = maybeStripSpace(settingsValues, inputTransaction, final boolean swapWeakSpace = maybeStripSpace(inputTransaction, isFromSuggestionStrip);
isFromSuggestionStrip);
final boolean isInsideDoubleQuoteOrAfterDigit = final boolean isInsideDoubleQuoteOrAfterDigit =
Constants.CODE_DOUBLE_QUOTE == inputTransaction.mKeyCode Constants.CODE_DOUBLE_QUOTE == inputTransaction.mKeyCode
@ -807,12 +803,12 @@ public final class InputLogic {
// not inside a double quote or after a digit. // not inside a double quote or after a digit.
needsPrecedingSpace = !isInsideDoubleQuoteOrAfterDigit; needsPrecedingSpace = !isInsideDoubleQuoteOrAfterDigit;
} else { } else {
needsPrecedingSpace = needsPrecedingSpace = inputTransaction.mSettingsValues.isUsuallyPrecededBySpace(
settingsValues.isUsuallyPrecededBySpace(inputTransaction.mKeyCode); inputTransaction.mKeyCode);
} }
if (needsPrecedingSpace) { if (needsPrecedingSpace) {
promotePhantomSpace(settingsValues); promotePhantomSpace(inputTransaction.mSettingsValues);
} }
if (ProductionFlag.USES_DEVELOPMENT_ONLY_DIAGNOSTICS) { if (ProductionFlag.USES_DEVELOPMENT_ONLY_DIAGNOSTICS) {
ResearchLogger.latinIME_handleSeparator(inputTransaction.mKeyCode, ResearchLogger.latinIME_handleSeparator(inputTransaction.mKeyCode,
@ -820,12 +816,12 @@ public final class InputLogic {
} }
if (!shouldAvoidSendingCode) { if (!shouldAvoidSendingCode) {
sendKeyCodePoint(settingsValues, inputTransaction.mKeyCode); sendKeyCodePoint(inputTransaction.mSettingsValues, inputTransaction.mKeyCode);
} }
if (Constants.CODE_SPACE == inputTransaction.mKeyCode) { if (Constants.CODE_SPACE == inputTransaction.mKeyCode) {
if (settingsValues.isSuggestionsRequested()) { if (inputTransaction.mSettingsValues.isSuggestionsRequested()) {
if (maybeDoubleSpacePeriod(settingsValues, handler)) { if (maybeDoubleSpacePeriod(inputTransaction.mSettingsValues, handler)) {
inputTransaction.requireShiftUpdate(InputTransaction.SHIFT_UPDATE_NOW); inputTransaction.requireShiftUpdate(InputTransaction.SHIFT_UPDATE_NOW);
mSpaceState = SpaceState.DOUBLE; mSpaceState = SpaceState.DOUBLE;
} else if (!mSuggestedWords.isPunctuationSuggestions()) { } else if (!mSuggestedWords.isPunctuationSuggestions()) {
@ -840,7 +836,8 @@ public final class InputLogic {
swapSwapperAndSpace(inputTransaction); swapSwapperAndSpace(inputTransaction);
mSpaceState = SpaceState.SWAP_PUNCTUATION; mSpaceState = SpaceState.SWAP_PUNCTUATION;
} else if ((SpaceState.PHANTOM == inputTransaction.mSpaceState } else if ((SpaceState.PHANTOM == inputTransaction.mSpaceState
&& settingsValues.isUsuallyFollowedBySpace(inputTransaction.mKeyCode)) && inputTransaction.mSettingsValues.isUsuallyFollowedBySpace(
inputTransaction.mKeyCode))
|| (Constants.CODE_DOUBLE_QUOTE == inputTransaction.mKeyCode || (Constants.CODE_DOUBLE_QUOTE == inputTransaction.mKeyCode
&& isInsideDoubleQuoteOrAfterDigit)) { && isInsideDoubleQuoteOrAfterDigit)) {
// If we are in phantom space state, and the user presses a separator, we want to // If we are in phantom space state, and the user presses a separator, we want to
@ -868,11 +865,9 @@ public final class InputLogic {
/** /**
* Handle a press on the backspace key. * Handle a press on the backspace key.
* @param settingsValues The current settings values.
* @param inputTransaction The transaction in progress. * @param inputTransaction The transaction in progress.
*/ */
private void handleBackspace(final SettingsValues settingsValues, private void handleBackspace(final InputTransaction inputTransaction,
final InputTransaction inputTransaction,
// TODO: remove this argument // TODO: remove this argument
final LatinIME.UIHandler handler) { final LatinIME.UIHandler handler) {
mSpaceState = SpaceState.NONE; mSpaceState = SpaceState.NONE;
@ -911,10 +906,10 @@ public final class InputLogic {
} }
} else { } else {
if (mLastComposedWord.canRevertCommit()) { if (mLastComposedWord.canRevertCommit()) {
if (settingsValues.mIsInternal) { if (inputTransaction.mSettingsValues.mIsInternal) {
LatinImeLoggerUtils.onAutoCorrectionCancellation(); LatinImeLoggerUtils.onAutoCorrectionCancellation();
} }
revertCommit(settingsValues, handler); revertCommit(inputTransaction.mSettingsValues, handler);
return; return;
} }
if (mEnteredText != null && mConnection.sameAsTextBeforeCursor(mEnteredText)) { if (mEnteredText != null && mConnection.sameAsTextBeforeCursor(mEnteredText)) {
@ -964,8 +959,8 @@ public final class InputLogic {
// This should never happen. // This should never happen.
Log.e(TAG, "Backspace when we don't know the selection position"); Log.e(TAG, "Backspace when we don't know the selection position");
} }
if (settingsValues.isBeforeJellyBean() || if (inputTransaction.mSettingsValues.isBeforeJellyBean() ||
settingsValues.mInputAttributes.isTypeNull()) { inputTransaction.mSettingsValues.mInputAttributes.isTypeNull()) {
// There are two possible reasons to send a key event: either the field has // There are two possible reasons to send a key event: either the field has
// type TYPE_NULL, in which case the keyboard should send events, or we are // type TYPE_NULL, in which case the keyboard should send events, or we are
// running in backward compatibility mode. Before Jelly bean, the keyboard // running in backward compatibility mode. Before Jelly bean, the keyboard
@ -1011,11 +1006,12 @@ public final class InputLogic {
} }
} }
} }
if (settingsValues.isSuggestionStripVisible() if (inputTransaction.mSettingsValues.isSuggestionStripVisible()
&& settingsValues.mSpacingAndPunctuations.mCurrentLanguageHasSpaces && inputTransaction.mSettingsValues.mSpacingAndPunctuations
.mCurrentLanguageHasSpaces
&& !mConnection.isCursorFollowedByWordCharacter( && !mConnection.isCursorFollowedByWordCharacter(
settingsValues.mSpacingAndPunctuations)) { inputTransaction.mSettingsValues.mSpacingAndPunctuations)) {
restartSuggestionsOnWordTouchedByCursor(settingsValues, restartSuggestionsOnWordTouchedByCursor(inputTransaction.mSettingsValues,
true /* includeResumedWordInSuggestions */); true /* includeResumedWordInSuggestions */);
} }
// We just removed at least one character. We need to update the auto-caps state. // We just removed at least one character. We need to update the auto-caps state.
@ -1053,13 +1049,12 @@ public final class InputLogic {
/* /*
* Strip a trailing space if necessary and returns whether it's a swap weak space situation. * Strip a trailing space if necessary and returns whether it's a swap weak space situation.
* @param settingsValues The current settings values.
* @param inputTransaction The transaction in progress. * @param inputTransaction The transaction in progress.
* @param isFromSuggestionStrip Whether this code point is coming from the suggestion strip. * @param isFromSuggestionStrip Whether this code point is coming from the suggestion strip.
* @return whether we should swap the space instead of removing it. * @return whether we should swap the space instead of removing it.
*/ */
private boolean maybeStripSpace(final SettingsValues settingsValues, private boolean maybeStripSpace(final InputTransaction inputTransaction,
final InputTransaction inputTransaction, final boolean isFromSuggestionStrip) { final boolean isFromSuggestionStrip) {
if (Constants.CODE_ENTER == inputTransaction.mKeyCode && if (Constants.CODE_ENTER == inputTransaction.mKeyCode &&
SpaceState.SWAP_PUNCTUATION == inputTransaction.mSpaceState) { SpaceState.SWAP_PUNCTUATION == inputTransaction.mSpaceState) {
mConnection.removeTrailingSpace(); mConnection.removeTrailingSpace();
@ -1068,10 +1063,12 @@ public final class InputLogic {
if ((SpaceState.WEAK == inputTransaction.mSpaceState if ((SpaceState.WEAK == inputTransaction.mSpaceState
|| SpaceState.SWAP_PUNCTUATION == inputTransaction.mSpaceState) || SpaceState.SWAP_PUNCTUATION == inputTransaction.mSpaceState)
&& isFromSuggestionStrip) { && isFromSuggestionStrip) {
if (settingsValues.isUsuallyPrecededBySpace(inputTransaction.mKeyCode)) { if (inputTransaction.mSettingsValues.isUsuallyPrecededBySpace(
inputTransaction.mKeyCode)) {
return false; return false;
} }
if (settingsValues.isUsuallyFollowedBySpace(inputTransaction.mKeyCode)) { if (inputTransaction.mSettingsValues.isUsuallyFollowedBySpace(
inputTransaction.mKeyCode)) {
return true; return true;
} }
mConnection.removeTrailingSpace(); mConnection.removeTrailingSpace();
@ -1732,6 +1729,7 @@ public final class InputLogic {
* @param settingsValues the current values of the settings. * @param settingsValues the current values of the settings.
* @param codePoint the code point to send. * @param codePoint the code point to send.
*/ */
// TODO: replace these two parameters with an InputTransaction
private void sendKeyCodePoint(final SettingsValues settingsValues, final int codePoint) { private void sendKeyCodePoint(final SettingsValues settingsValues, final int codePoint) {
if (ProductionFlag.USES_DEVELOPMENT_ONLY_DIAGNOSTICS) { if (ProductionFlag.USES_DEVELOPMENT_ONLY_DIAGNOSTICS) {
ResearchLogger.latinIME_sendKeyCodePoint(codePoint); ResearchLogger.latinIME_sendKeyCodePoint(codePoint);