am 5a0b4881: Merge "Group special spaces and double/swapped spaces in undo mode"

* commit '5a0b4881f892bf9dd714d1741817095daffae695':
  Group special spaces and double/swapped spaces in undo mode
main
Jean Chalard 2011-10-26 04:47:59 -07:00 committed by Android Git Automerger
commit c47743e7db
1 changed files with 129 additions and 87 deletions

View File

@ -157,9 +157,21 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
SUGGESTION_VISIBILILTY_HIDE_VALUE SUGGESTION_VISIBILILTY_HIDE_VALUE
}; };
private static final int SPACE_STRENGTH_NORMAL = 0; // Magic space: a space that should disappear on space/apostrophe insertion, move after the
private static final int SPACE_STRENGTH_MAGIC = 1; // punctuation on punctuation insertion, and become a real space on alpha char insertion.
private static final int SPACE_STRENGTH_STRONG = 2; // Weak space: a space that be swapped only by suggestion strip punctuation.
// Double space: the state where the user pressed space twice quickly, which LatinIME
// resolved as period-space. Undoing this converts the period to a space.
// Swap punctuation: the state where a (weak or magic) space and a punctuation from the
// suggestion strip have just been swapped. Undoing this swaps them back.
private static final int SPACE_STATE_NONE = 0;
private static final int SPACE_STATE_DOUBLE = 1;
private static final int SPACE_STATE_SWAP_PUNCTUATION = 2;
private static final int SPACE_STATE_MAGIC = 3;
private static final int SPACE_STATE_WEAK = 4;
// Current space state of the input method. This can be any of the above constants.
private int mSpaceState;
private Settings.Values mSettingsValues; private Settings.Values mSettingsValues;
@ -194,12 +206,6 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
private WordComposer mWordComposer = new WordComposer(); private WordComposer mWordComposer = new WordComposer();
private CharSequence mBestWord; private CharSequence mBestWord;
private boolean mHasUncommittedTypedChars; private boolean mHasUncommittedTypedChars;
// Magic space: a space that should disappear on space/apostrophe insertion, move after the
// punctuation on punctuation insertion, and become a real space on alpha char insertion.
private int mLastSpaceStrength; // This indicates whether the last space is normal/magic/strong.
// This indicates whether the last keypress resulted in processing of double space replacement
// with period-space.
private boolean mJustReplacedDoubleSpace;
private int mCorrectionMode; private int mCorrectionMode;
private int mCommittedLength; private int mCommittedLength;
@ -731,8 +737,7 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
mComposingStringBuilder.setLength(0); mComposingStringBuilder.setLength(0);
mHasUncommittedTypedChars = false; mHasUncommittedTypedChars = false;
mDeleteCount = 0; mDeleteCount = 0;
mLastSpaceStrength = SPACE_STRENGTH_NORMAL; mSpaceState = SPACE_STATE_NONE;
mJustReplacedDoubleSpace = false;
loadSettings(); loadSettings();
updateCorrectionMode(); updateCorrectionMode();
@ -893,10 +898,12 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
|| newSelEnd != candidatesEnd) && mLastSelectionStart != newSelStart; || newSelEnd != candidatesEnd) && mLastSelectionStart != newSelStart;
final boolean candidatesCleared = candidatesStart == -1 && candidatesEnd == -1; final boolean candidatesCleared = candidatesStart == -1 && candidatesEnd == -1;
if (!mExpectingUpdateSelection) { if (!mExpectingUpdateSelection) {
if (isShowingPunctuationList()) { if (SPACE_STATE_WEAK == mSpaceState) {
// Test for the punctuation list because there is a race condition that // Test for no WEAK_SPACE action because there is a race condition that may end up
// may end up in coming here on a normal key press // in coming here on a normal key press. We set this to NONE because after
mLastSpaceStrength = SPACE_STRENGTH_STRONG; // a cursor move, we don't want the suggestion strip to swap the space with the
// newly inserted punctuation.
mSpaceState = SPACE_STATE_NONE;
} }
if (((mComposingStringBuilder.length() > 0 && mHasUncommittedTypedChars) if (((mComposingStringBuilder.length() > 0 && mHasUncommittedTypedChars)
|| mVoiceProxy.isVoiceInputHighlighted()) || mVoiceProxy.isVoiceInputHighlighted())
@ -915,7 +922,6 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
TextEntryState.reset(); TextEntryState.reset();
updateSuggestions(); updateSuggestions();
} }
mJustReplacedDoubleSpace = false;
} }
mExpectingUpdateSelection = false; mExpectingUpdateSelection = false;
mHandler.postUpdateShiftKeyState(); mHandler.postUpdateShiftKeyState();
@ -1153,10 +1159,9 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
} }
} }
private void maybeDoubleSpace() { private boolean maybeDoubleSpaceWhileInBatchEdit(final InputConnection ic) {
if (mCorrectionMode == Suggest.CORRECTION_NONE) return; if (mCorrectionMode == Suggest.CORRECTION_NONE) return false;
final InputConnection ic = getCurrentInputConnection(); if (ic == null) return false;
if (ic == null) return;
final CharSequence lastThree = ic.getTextBeforeCursor(3, 0); final CharSequence lastThree = ic.getTextBeforeCursor(3, 0);
if (lastThree != null && lastThree.length() == 3 if (lastThree != null && lastThree.length() == 3
&& Utils.canBeFollowedByPeriod(lastThree.charAt(0)) && Utils.canBeFollowedByPeriod(lastThree.charAt(0))
@ -1164,15 +1169,12 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
&& lastThree.charAt(2) == Keyboard.CODE_SPACE && lastThree.charAt(2) == Keyboard.CODE_SPACE
&& mHandler.isAcceptingDoubleSpaces()) { && mHandler.isAcceptingDoubleSpaces()) {
mHandler.cancelDoubleSpacesTimer(); mHandler.cancelDoubleSpacesTimer();
ic.beginBatchEdit();
ic.deleteSurroundingText(2, 0); ic.deleteSurroundingText(2, 0);
ic.commitText(". ", 1); ic.commitText(". ", 1);
ic.endBatchEdit();
mKeyboardSwitcher.updateShiftState(); mKeyboardSwitcher.updateShiftState();
mJustReplacedDoubleSpace = true; return true;
} else {
mHandler.startDoubleSpacesTimer();
} }
return false;
} }
// "ic" must not be null // "ic" must not be null
@ -1246,12 +1248,26 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
return mOptionsDialog != null && mOptionsDialog.isShowing(); return mOptionsDialog != null && mOptionsDialog.isShowing();
} }
private void onCodeInputWithSpaceStrength(final int primaryCode, final int[] keyCodes, private void insertPunctuationFromSuggestionStrip(final InputConnection ic, final int code) {
final int x, final int y, final int spaceStrength) { final CharSequence beforeText = ic != null ? ic.getTextBeforeCursor(1, 0) : null;
final int lastStateOfSpaceStrength = mLastSpaceStrength; final int toLeft = TextUtils.isEmpty(beforeText) ? 0 : beforeText.charAt(0);
mLastSpaceStrength = spaceStrength; final boolean shouldRegisterSwapPunctuation;
onCodeInput(primaryCode, keyCodes, x, y); // If we have a space left of the cursor and it's a weak or a magic space, then we should
mLastSpaceStrength = lastStateOfSpaceStrength; // swap it, and override the space state with SPACESTATE_SWAP_PUNCTUATION.
// To swap it, we fool handleSeparator to think the previous space state was a
// magic space.
if (Keyboard.CODE_SPACE == toLeft && mSpaceState == SPACE_STATE_WEAK) {
mSpaceState = SPACE_STATE_MAGIC;
shouldRegisterSwapPunctuation = true;
} else {
shouldRegisterSwapPunctuation = false;
}
onCodeInput(code, new int[] { code },
KeyboardActionListener.NOT_A_TOUCH_COORDINATE,
KeyboardActionListener.NOT_A_TOUCH_COORDINATE);
if (shouldRegisterSwapPunctuation) {
mSpaceState = SPACE_STATE_SWAP_PUNCTUATION;
}
} }
// Implementation of {@link KeyboardActionListener}. // Implementation of {@link KeyboardActionListener}.
@ -1264,11 +1280,16 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
mLastKeyTime = when; mLastKeyTime = when;
KeyboardSwitcher switcher = mKeyboardSwitcher; KeyboardSwitcher switcher = mKeyboardSwitcher;
final boolean distinctMultiTouch = switcher.hasDistinctMultitouch(); final boolean distinctMultiTouch = switcher.hasDistinctMultitouch();
final boolean lastStateOfJustReplacedDoubleSpace = mJustReplacedDoubleSpace; // The space state depends only on the last character pressed and its own previous
mJustReplacedDoubleSpace = false; // state. Here, we revert the space state to neutral if the key is actually modifying
// the input contents (any non-shift key), which is what we should do for
// all inputs that do not result in a special state. Each character handling is then
// free to override the state as they see fit.
final int spaceState = mSpaceState;
switch (primaryCode) { switch (primaryCode) {
case Keyboard.CODE_DELETE: case Keyboard.CODE_DELETE:
handleBackspace(lastStateOfJustReplacedDoubleSpace); mSpaceState = SPACE_STATE_NONE;
handleBackspace(spaceState);
mDeleteCount++; mDeleteCount++;
mExpectingUpdateSelection = true; mExpectingUpdateSelection = true;
LatinImeLogger.logOnDelete(); LatinImeLogger.logOnDelete();
@ -1314,10 +1335,11 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
// To sum it up: do not update mExpectingUpdateSelection here. // To sum it up: do not update mExpectingUpdateSelection here.
break; break;
default: default:
mSpaceState = SPACE_STATE_NONE;
if (mSettingsValues.isWordSeparator(primaryCode)) { if (mSettingsValues.isWordSeparator(primaryCode)) {
handleSeparator(primaryCode, x, y); handleSeparator(primaryCode, x, y, spaceState);
} else { } else {
handleCharacter(primaryCode, keyCodes, x, y); handleCharacter(primaryCode, keyCodes, x, y, spaceState);
} }
mExpectingUpdateSelection = true; mExpectingUpdateSelection = true;
break; break;
@ -1339,7 +1361,7 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
ic.endBatchEdit(); ic.endBatchEdit();
mKeyboardSwitcher.updateShiftState(); mKeyboardSwitcher.updateShiftState();
mKeyboardSwitcher.onKey(Keyboard.CODE_DUMMY); mKeyboardSwitcher.onKey(Keyboard.CODE_DUMMY);
mLastSpaceStrength = SPACE_STRENGTH_NORMAL; mSpaceState = SPACE_STATE_NONE;
mEnteredText = text; mEnteredText = text;
} }
@ -1349,7 +1371,7 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
mKeyboardSwitcher.onCancelInput(); mKeyboardSwitcher.onCancelInput();
} }
private void handleBackspace(boolean justReplacedDoubleSpace) { private void handleBackspace(final int spaceState) {
if (mVoiceProxy.logAndRevertVoiceInput()) return; if (mVoiceProxy.logAndRevertVoiceInput()) return;
final InputConnection ic = getCurrentInputConnection(); final InputConnection ic = getCurrentInputConnection();
@ -1387,18 +1409,24 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
} }
mHandler.postUpdateShiftKeyState(); mHandler.postUpdateShiftKeyState();
// After backspace we want to reset the space to strong to prevent an undue swap with // TODO: Merge space state with TextEntryState
// a subsequent press of a punctuation sign in the suggestion strip.
mLastSpaceStrength = SPACE_STRENGTH_STRONG;
TextEntryState.backspace(); TextEntryState.backspace();
if (TextEntryState.isUndoCommit()) { if (TextEntryState.isUndoCommit()) {
revertLastWord(ic); revertLastWord(ic);
ic.endBatchEdit(); ic.endBatchEdit();
return; return;
} }
if (justReplacedDoubleSpace) { if (SPACE_STATE_DOUBLE == spaceState) {
if (revertDoubleSpace(ic)) { if (revertDoubleSpace(ic)) {
ic.endBatchEdit(); ic.endBatchEdit();
// No need to reset mSpaceState, it has already be done (that's why we
// receive it as a parameter)
return;
}
} else if (SPACE_STATE_SWAP_PUNCTUATION == spaceState) {
if (revertSwapPunctuation(ic)) {
ic.endBatchEdit();
// Likewise
return; return;
} }
} }
@ -1448,12 +1476,13 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
} }
} }
private void handleCharacter(int primaryCode, int[] keyCodes, int x, int y) { private void handleCharacter(final int primaryCode, final int[] keyCodes, final int x,
final int y, final int spaceState) {
mVoiceProxy.handleCharacter(); mVoiceProxy.handleCharacter();
final InputConnection ic = getCurrentInputConnection(); final InputConnection ic = getCurrentInputConnection();
if (ic != null) ic.beginBatchEdit(); if (ic != null) ic.beginBatchEdit();
if (SPACE_STRENGTH_MAGIC == mLastSpaceStrength if (SPACE_STATE_MAGIC == spaceState
&& mSettingsValues.isMagicSpaceStripper(primaryCode)) { && mSettingsValues.isMagicSpaceStripper(primaryCode)) {
removeTrailingSpaceWhileInBatchEdit(ic); removeTrailingSpaceWhileInBatchEdit(ic);
} }
@ -1512,11 +1541,9 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
} else { } else {
sendKeyChar((char)code); sendKeyChar((char)code);
} }
if (SPACE_STRENGTH_MAGIC == mLastSpaceStrength if (SPACE_STATE_MAGIC == spaceState
&& mSettingsValues.isMagicSpaceSwapper(primaryCode)) { && mSettingsValues.isMagicSpaceSwapper(primaryCode)) {
if (null != ic) swapSwapperAndSpaceWhileInBatchEdit(ic); if (null != ic) swapSwapperAndSpaceWhileInBatchEdit(ic);
} else {
mLastSpaceStrength = SPACE_STRENGTH_NORMAL;
} }
switcher.updateShiftState(); switcher.updateShiftState();
@ -1525,7 +1552,8 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
if (null != ic) ic.endBatchEdit(); if (null != ic) ic.endBatchEdit();
} }
private void handleSeparator(int primaryCode, int x, int y) { private void handleSeparator(final int primaryCode, final int x, final int y,
final int spaceState) {
mVoiceProxy.handleSeparator(); mVoiceProxy.handleSeparator();
mComposingStateManager.onFinishComposingText(); mComposingStateManager.onFinishComposingText();
@ -1555,23 +1583,45 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
} }
} }
if (SPACE_STRENGTH_MAGIC == mLastSpaceStrength) { final boolean swapMagicSpace;
if (SPACE_STATE_MAGIC == spaceState) {
if (mSettingsValues.isMagicSpaceSwapper(primaryCode)) { if (mSettingsValues.isMagicSpaceSwapper(primaryCode)) {
sendKeyChar((char)primaryCode); swapMagicSpace = true;
swapSwapperAndSpaceWhileInBatchEdit(ic);
} else { } else {
swapMagicSpace = false;
if (mSettingsValues.isMagicSpaceStripper(primaryCode)) { if (mSettingsValues.isMagicSpaceStripper(primaryCode)) {
removeTrailingSpaceWhileInBatchEdit(ic); removeTrailingSpaceWhileInBatchEdit(ic);
} }
sendKeyChar((char)primaryCode);
mLastSpaceStrength = SPACE_STRENGTH_NORMAL;
} }
} else { } else {
sendKeyChar((char)primaryCode); swapMagicSpace = false;
} }
if (isSuggestionsRequested() && primaryCode == Keyboard.CODE_SPACE) { sendKeyChar((char)primaryCode);
maybeDoubleSpace();
if (Keyboard.CODE_SPACE == primaryCode) {
if (isSuggestionsRequested()) {
if (maybeDoubleSpaceWhileInBatchEdit(ic)) {
mSpaceState = SPACE_STATE_DOUBLE;
} else if (!isShowingPunctuationList()) {
mSpaceState = SPACE_STATE_WEAK;
}
}
mHandler.startDoubleSpacesTimer();
if (!isCursorTouchingWord()) {
mHandler.cancelUpdateSuggestions();
mHandler.postUpdateBigramPredictions();
}
} else {
if (swapMagicSpace) {
swapSwapperAndSpaceWhileInBatchEdit(ic);
mSpaceState = SPACE_STATE_MAGIC;
}
// Set punctuation right away. onUpdateSelection will fire but tests whether it is
// already displayed or not, so it's okay.
setPunctuationSuggestions();
} }
TextEntryState.typedCharacter((char) primaryCode, true, x, y); TextEntryState.typedCharacter((char) primaryCode, true, x, y);
@ -1584,19 +1634,6 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
ic, mLastSelectionEnd - typedWord.length(), typedWord, mBestWord); ic, mLastSelectionEnd - typedWord.length(), typedWord, mBestWord);
} }
} }
if (Keyboard.CODE_SPACE == primaryCode) {
if (isShowingPunctuationList()) {
mLastSpaceStrength = SPACE_STRENGTH_STRONG;
}
if (!isCursorTouchingWord()) {
mHandler.cancelUpdateSuggestions();
mHandler.postUpdateBigramPredictions();
}
} else {
// Set punctuation right away. onUpdateSelection will fire but tests whether it is
// already displayed or not, so it's okay.
setPunctuationSuggestions();
}
mKeyboardSwitcher.updateShiftState(); mKeyboardSwitcher.updateShiftState();
if (ic != null) { if (ic != null) {
ic.endBatchEdit(); ic.endBatchEdit();
@ -1836,8 +1873,8 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
LatinImeLogger.logOnManualSuggestion( LatinImeLogger.logOnManualSuggestion(
"", suggestion.toString(), index, suggestions.mWords); "", suggestion.toString(), index, suggestions.mWords);
// Find out whether the previous character is a space. If it is, as a special case // Find out whether the previous character is a space. If it is, as a special case
// for punctuation entered through the suggestion strip, it should be considered // for punctuation entered through the suggestion strip, it should be swapped
// a magic space even if it was a normal space. This is meant to help in case the user // if it was a magic or a weak space. This is meant to help in case the user
// pressed space on purpose of displaying the suggestion strip punctuation. // pressed space on purpose of displaying the suggestion strip punctuation.
final int rawPrimaryCode = suggestion.charAt(0); final int rawPrimaryCode = suggestion.charAt(0);
// Maybe apply the "bidi mirrored" conversions for parentheses // Maybe apply the "bidi mirrored" conversions for parentheses
@ -1845,18 +1882,8 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
final boolean isRtl = keyboard != null && keyboard.mIsRtlKeyboard; final boolean isRtl = keyboard != null && keyboard.mIsRtlKeyboard;
final int primaryCode = Key.getRtlParenthesisCode(rawPrimaryCode, isRtl); final int primaryCode = Key.getRtlParenthesisCode(rawPrimaryCode, isRtl);
final CharSequence beforeText = ic != null ? ic.getTextBeforeCursor(1, 0) : ""; insertPunctuationFromSuggestionStrip(ic, primaryCode);
final int toLeft = (ic == null || TextUtils.isEmpty(beforeText)) // TODO: the following endBatchEdit seems useless, check
? 0 : beforeText.charAt(0);
final int spaceStrength;
if (Keyboard.CODE_SPACE == toLeft && mLastSpaceStrength != SPACE_STRENGTH_STRONG) {
spaceStrength = SPACE_STRENGTH_MAGIC;
} else {
spaceStrength = mLastSpaceStrength;
}
onCodeInputWithSpaceStrength(primaryCode, new int[] { primaryCode },
KeyboardActionListener.NOT_A_TOUCH_COORDINATE,
KeyboardActionListener.NOT_A_TOUCH_COORDINATE, spaceStrength);
if (ic != null) { if (ic != null) {
ic.endBatchEdit(); ic.endBatchEdit();
} }
@ -2046,13 +2073,13 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
return false; return false;
} }
// "ic" must not null // "ic" must not be null
private boolean sameAsTextBeforeCursor(final InputConnection ic, CharSequence text) { private boolean sameAsTextBeforeCursor(final InputConnection ic, CharSequence text) {
CharSequence beforeText = ic.getTextBeforeCursor(text.length(), 0); CharSequence beforeText = ic.getTextBeforeCursor(text.length(), 0);
return TextUtils.equals(text, beforeText); return TextUtils.equals(text, beforeText);
} }
// "ic" must not null // "ic" must not be null
private void revertLastWord(final InputConnection ic) { private void revertLastWord(final InputConnection ic) {
if (mHasUncommittedTypedChars || mComposingStringBuilder.length() <= 0) { if (mHasUncommittedTypedChars || mComposingStringBuilder.length() <= 0) {
sendDownUpKeyEvents(KeyEvent.KEYCODE_DEL); sendDownUpKeyEvents(KeyEvent.KEYCODE_DEL);
@ -2086,7 +2113,7 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
mHandler.postUpdateSuggestions(); mHandler.postUpdateSuggestions();
} }
// "ic" must not null // "ic" must not be null
private boolean revertDoubleSpace(final InputConnection ic) { private boolean revertDoubleSpace(final InputConnection ic) {
mHandler.cancelDoubleSpacesTimer(); mHandler.cancelDoubleSpacesTimer();
// Here we test whether we indeed have a period and a space before us. This should not // Here we test whether we indeed have a period and a space before us. This should not
@ -2101,13 +2128,28 @@ public class LatinIME extends InputMethodServiceCompatWrapper implements Keyboar
return true; return true;
} }
private boolean revertSwapPunctuation(final InputConnection ic) {
// Here we test whether we indeed have a space and something else before us. This should not
// be needed, but it's there just in case something went wrong.
final CharSequence textBeforeCursor = ic.getTextBeforeCursor(2, 0);
// NOTE: This does not work with surrogate pairs. Hopefully when the keyboard is able to
// enter surrogate pairs this code will have been removed.
if (Keyboard.CODE_SPACE != textBeforeCursor.charAt(1))
return false;
ic.beginBatchEdit();
ic.deleteSurroundingText(2, 0);
ic.commitText(" " + textBeforeCursor.subSequence(0, 1), 1);
ic.endBatchEdit();
return true;
}
public boolean isWordSeparator(int code) { public boolean isWordSeparator(int code) {
return mSettingsValues.isWordSeparator(code); return mSettingsValues.isWordSeparator(code);
} }
private void sendMagicSpace() { private void sendMagicSpace() {
sendKeyChar((char)Keyboard.CODE_SPACE); sendKeyChar((char)Keyboard.CODE_SPACE);
mLastSpaceStrength = SPACE_STRENGTH_MAGIC; mSpaceState = SPACE_STATE_MAGIC;
mKeyboardSwitcher.updateShiftState(); mKeyboardSwitcher.updateShiftState();
} }