Backport new ibus-bamboo changes that handles word break better

Close #14
Close #15
Close #16

Author: wengxt

bamboo/bamboo-core

@@ -55,16 +55,25 @@ func isValidState(state uint32) bool {
 	return true
 }
 
+func (e *FcitxBambooEngine) isPrintableKey(state, keyVal uint32) bool {
+	return isValidState(state) && e.isValidKeyVal(keyVal)
+}
+
 func (e *FcitxBambooEngine) getCommitText(keyVal, state uint32) (string, bool) {
 	var keyRune = rune(keyVal)
+	isPrintableKey := e.isPrintableKey(state, keyVal)
 	oldText := e.getPreeditString()
 	// restore key strokes by pressing Shift + Space
 	if e.shouldRestoreKeyStrokes {
 		e.shouldRestoreKeyStrokes = false
 		e.preeditor.RestoreLastWord(!bamboo.HasAnyVietnameseRune(oldText))
 		return e.getPreeditString(), false
 	}
-	if e.preeditor.CanProcessKey(keyRune) {
+	var keyS string
+	if isPrintableKey {
+		keyS = string(keyRune)
+	}
+	if isPrintableKey && e.preeditor.CanProcessKey(keyRune) {
 		if state&FcitxLockMask != 0 {
 			keyRune = e.toUpper(keyRune)
 		}
@@ -81,7 +90,7 @@ func (e *FcitxBambooEngine) getCommitText(keyVal, state uint32) (string, bool) {
 				var ret = e.getPreeditString()
 				var lastRune = rune(ret[len(ret)-1])
 				var isWordBreakRune = bamboo.IsWordBreakSymbol(lastRune)
-				// TODO: THIS IS HACKING
+				// TODO: THIS IS A HACK
 				if isWordBreakRune {
 					e.preeditor.RemoveLastChar(false)
 					e.preeditor.ProcessKey(' ', bamboo.EnglishMode)
@@ -104,28 +113,46 @@ func (e *FcitxBambooEngine) getCommitText(keyVal, state uint32) (string, bool) {
 		} else {
 			return e.getPreeditString(), false
 		}
-	} else if bamboo.IsWordBreakSymbol(keyRune) {
+	} else if e.macroEnabled {
 		// macro processing
-		if e.macroEnabled {
-			var keyS = string(keyRune)
-			if keyVal == FcitxSpace && e.macroTable.HasKey(oldText) {
-				e.preeditor.Reset()
-				return e.expandMacro(oldText) + keyS, keyVal == FcitxSpace
-			} else {
-				e.preeditor.ProcessKey(keyRune, e.getBambooInputMode())
-				return oldText + keyS, keyVal == FcitxSpace
+		if isPrintableKey && e.macroTable.HasPrefix(oldText+keyS) {
+			e.preeditor.ProcessKey(keyRune, bamboo.EnglishMode)
+			return oldText + keyS, false
+		}
+		if e.macroTable.HasKey(oldText) {
+			if isPrintableKey {
+				return e.expandMacro(oldText) + keyS, true
 			}
+			return e.expandMacro(oldText), true
 		}
-		if bamboo.HasAnyVietnameseRune(oldText) && e.mustFallbackToEnglish() {
-			e.preeditor.RestoreLastWord(false)
-			newText := e.preeditor.GetProcessedString(bamboo.EnglishMode) + string(keyRune)
+	}
+	return e.handleNonVnWord(keyVal, state), true
+}
+
+func (e *FcitxBambooEngine) handleNonVnWord(keyVal, state uint32) string {
+	var (
+		keyS           string
+		keyRune        = rune(keyVal)
+		isPrintableKey = e.isPrintableKey(state, keyVal)
+		oldText        = e.getPreeditString()
+	)
+	if isPrintableKey {
+		keyS = string(keyRune)
+	}
+	if bamboo.HasAnyVietnameseRune(oldText) && e.mustFallbackToEnglish() {
+		e.preeditor.RestoreLastWord(false)
+		newText := e.preeditor.GetProcessedString(bamboo.PunctuationMode|bamboo.EnglishMode) + keyS
+		if isPrintableKey {
 			e.preeditor.ProcessKey(keyRune, bamboo.EnglishMode)
-			return newText, true
 		}
+		return newText
+	}
+	if isPrintableKey {
 		e.preeditor.ProcessKey(keyRune, bamboo.EnglishMode)
-		return oldText + string(keyRune), true
+		return oldText + keyS
 	}
-	return "", true
+	// Ctrl + A is treasted as a WBS
+	return oldText + keyS
 }
 
 func (e *FcitxBambooEngine) getMacroText() (bool, string) {
@@ -138,3 +165,14 @@ func (e *FcitxBambooEngine) getMacroText() (bool, string) {
 	}
 	return false, ""
 }
+
+func (e *FcitxBambooEngine) isValidKeyVal(keyVal uint32) bool {
+	var keyRune = rune(keyVal)
+	if keyVal == FcitxBackSpace || bamboo.IsWordBreakSymbol(keyRune) {
+		return true
+	}
+	if ok, _ := e.getMacroText(); ok && keyVal == FcitxTab {
+		return true
+	}
+	return e.preeditor.CanProcessKey(keyRune)
+}

bamboo/engine_utils.go

@@ -57,13 +57,10 @@ func (e *FcitxBambooEngine) preeditProcessKeyEvent(keyVal uint32, state uint32)
 	var oldText = e.getPreeditString()
 	defer e.updateLastKeyWithShift(keyVal, state)
 
-	// workaround for chrome's address bar and Google SpreadSheets
 	if !e.shouldRestoreKeyStrokes {
-		if !isValidState(state) || !e.canProcessKey(keyVal) ||
-			(!e.macroEnabled && rawKeyLen == 0 && !e.preeditor.CanProcessKey(keyRune)) {
-			if rawKeyLen > 0 {
-				e.commitPreeditAndReset(e.getPreeditString())
-			}
+		if !e.preeditor.CanProcessKey(keyRune) && rawKeyLen == 0 && !e.macroEnabled {
+			// don't process special characters if rawKeyLen == 0,
+			// workaround for Chrome's address bar and Google SpreadSheets
 			return false
 		}
 	}
@@ -92,12 +89,13 @@ func (e *FcitxBambooEngine) preeditProcessKeyEvent(keyVal uint32, state uint32)
 	}
 
 	newText, isWordBreakRune := e.getCommitText(keyVal, state)
+	isPrintableKey := e.isPrintableKey(state, keyVal)
 	if isWordBreakRune {
 		e.commitPreeditAndReset(newText)
-		return true
+		return isPrintableKey
 	}
 	e.updatePreedit(newText)
-	return true
+	return isPrintableKey
 }
 
 func (e *FcitxBambooEngine) expandMacro(str string) string {
@@ -204,14 +202,3 @@ func (e *FcitxBambooEngine) commitPreeditAndReset(s string) {
 	e.preeditText = ""
 	e.preeditor.Reset()
 }
-
-func (e *FcitxBambooEngine) canProcessKey(keyVal uint32) bool {
-	var keyRune = rune(keyVal)
-	if keyVal == FcitxSpace || keyVal == FcitxBackSpace || bamboo.IsWordBreakSymbol(keyRune) {
-		return true
-	}
-	if ok, _ := e.getMacroText(); ok && keyVal == FcitxTab {
-		return true
-	}
-	return e.preeditor.CanProcessKey(keyRune)
-}

bamboo/fcitxbambooengine.go

@@ -10,6 +10,7 @@ package main
 
 import (
 	"bamboo-core"
+	"strings"
 	"unicode"
 )
 
@@ -44,3 +45,16 @@ func inKeyList(list []rune, key rune) bool {
 	}
 	return false
 }
+
+// Backport missing function in bamboo-core
+func (e *MacroTable) HasPrefix(key string) bool {
+	if e.mTable[key] != "" {
+		return true
+	}
+	for k := range e.mTable {
+		if strings.HasPrefix(k, key) {
+			return true
+		}
+	}
+	return false
+}