refactor: implement window manager to manage all kinds of keyboard window

Expose keyboardHeight from Keyboard to set the keyboard view area height in InputView

Author: WhiredPlanck

app/src/main/java/com/osfans/trime/ime/core/InputView.kt

@@ -87,6 +87,7 @@ class InputView(
 
     private val themedContext = context.withTheme(android.R.style.Theme_DeviceDefault_Settings)
     private val inputComponent = InputComponent::class.create(themedContext, theme, service)
+    private val windowManager = inputComponent.windowManager
     val quickBar: QuickBar = inputComponent.quickBar
     val keyboardWindow: KeyboardWindow = inputComponent.keyboardWindow
     val liquidKeyboard: LiquidKeyboard = inputComponent.liquidKeyboard
@@ -126,6 +127,9 @@ class InputView(
                 }
             }
 
+        windowManager.cacheResidentWindow(keyboardWindow, createView = true)
+        windowManager.cacheResidentWindow(liquidKeyboard)
+
         service.window.window!!.also { it ->
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
                 shouldUpdateNavbarForeground = true
@@ -154,8 +158,6 @@ class InputView(
             }
         }
 
-        liquidKeyboard.setKeyboardView(keyboardWindow.oldSymbolInputView.liquidKeyboardView)
-
         keyboardBackground.imageDrawable = ColorManager.getDrawable("keyboard_background")
             ?: ColorManager.getDrawable("keyboard_back_color")
 
@@ -192,7 +194,7 @@ class InputView(
                     },
                 )
                 add(
-                    keyboardWindow.view,
+                    windowManager.view,
                     lParams(matchParent, wrapContent) {
                         below(quickBar.view)
                         above(bottomPaddingSpace)
@@ -229,7 +231,7 @@ class InputView(
             // hide side padding space views when unnecessary
             leftPaddingSpace.visibility = View.GONE
             rightPaddingSpace.visibility = View.GONE
-            keyboardWindow.view.updateLayoutParams<LayoutParams> {
+            windowManager.view.updateLayoutParams<LayoutParams> {
                 startToEnd = unset
                 endToStart = unset
                 startOfParent()
@@ -244,7 +246,7 @@ class InputView(
             rightPaddingSpace.updateLayoutParams {
                 width = sidePadding
             }
-            keyboardWindow.view.updateLayoutParams<LayoutParams> {
+            windowManager.view.updateLayoutParams<LayoutParams> {
                 startToStart = unset
                 endToEnd = unset
                 startToEndOf(leftPaddingSpace)
@@ -273,6 +275,9 @@ class InputView(
             }
         }
         keyboardWindow.oldMainInputView.mainKeyboardView.updateEnterLabelOnEditorInfo(info)
+        if (!restarting) {
+            windowManager.attachWindow(KeyboardWindow)
+        }
     }
 
     private fun handleRimeNotification(it: RimeNotification) {
@@ -297,9 +302,18 @@ class InputView(
         }
     }
 
-    fun switchUiByState(state: KeyboardWindow.State) {
-        keyboardWindow.switchUiByState(state)
-        quickBar.switchUiByState(QuickBar.State.entries[state.ordinal])
+    enum class Board {
+        Main,
+        Symbol,
+    }
+
+    fun switchBoard(board: Board) {
+        when (board) {
+            Board.Main -> windowManager.attachWindow(keyboardWindow)
+            Board.Symbol -> windowManager.attachWindow(liquidKeyboard)
+        }
+        quickBar.switchUiByState(QuickBar.State.entries[board.ordinal])
+        updateKeyboardSize()
     }
 
     private var showingDialog: Dialog? = null

app/src/main/java/com/osfans/trime/ime/core/TrimeInputMethodService.kt

@@ -62,7 +62,6 @@ import com.osfans.trime.ime.keyboard.InputFeedbackManager
 import com.osfans.trime.ime.keyboard.Key
 import com.osfans.trime.ime.keyboard.KeyboardSwitcher
 import com.osfans.trime.ime.keyboard.KeyboardView
-import com.osfans.trime.ime.keyboard.KeyboardWindow
 import com.osfans.trime.ime.symbol.TabManager
 import com.osfans.trime.ime.symbol.TabView
 import com.osfans.trime.ime.text.Candidate
@@ -230,7 +229,6 @@ open class TrimeInputMethodService : LifecycleInputMethodService() {
             // could crash
             //  and lead to a crash loop
             Timber.d("onCreate")
-            val context: InputMethodService = this
             ColorManager.addOnChangedListener(onColorChangeListener)
             RimeWrapper.startup {
                 Timber.d("Running Trime.onCreate")
@@ -267,7 +265,7 @@ open class TrimeInputMethodService : LifecycleInputMethodService() {
     fun selectLiquidKeyboard(tabIndex: Int) {
         if (inputView == null) return
         if (tabIndex >= 0) {
-            inputView!!.switchUiByState(KeyboardWindow.State.Symbol)
+            inputView!!.switchBoard(InputView.Board.Symbol)
             symbolKeyboardType = inputView!!.liquidKeyboard.select(tabIndex)
             tabView!!.updateTabWidth()
             mTabRoot!!.move(tabView!!.highlightLeft, tabView!!.highlightRight)
@@ -277,7 +275,7 @@ open class TrimeInputMethodService : LifecycleInputMethodService() {
             symbolKeyboardType = SymbolKeyboardType.NO_KEY
             // 设置液体键盘处于隐藏状态
             TabManager.setTabExited()
-            inputView!!.switchUiByState(KeyboardWindow.State.Main)
+            inputView!!.switchBoard(InputView.Board.Main)
             updateComposing()
         }
     }

app/src/main/java/com/osfans/trime/ime/dependency/InputComponent.kt

@@ -6,17 +6,19 @@ import com.osfans.trime.ime.bar.QuickBar
 import com.osfans.trime.ime.core.TrimeInputMethodService
 import com.osfans.trime.ime.keyboard.KeyboardWindow
 import com.osfans.trime.ime.symbol.LiquidKeyboard
+import com.osfans.trime.ime.window.BoardWindowManager
 import me.tatarka.inject.annotations.Component
 import me.tatarka.inject.annotations.Provides
 
 @InputScope
 @Component
 abstract class InputComponent(
-    @get:InputScope @get:Provides protected val themedContext: Context,
-    @get:InputScope @get:Provides protected val theme: Theme,
-    @get:InputScope @get:Provides protected val service: TrimeInputMethodService,
+    @get:InputScope @get:Provides val themedContext: Context,
+    @get:InputScope @get:Provides val theme: Theme,
+    @get:InputScope @get:Provides val service: TrimeInputMethodService,
 ) {
     abstract val quickBar: QuickBar
+    abstract val windowManager: BoardWindowManager
     abstract val keyboardWindow: KeyboardWindow
     abstract val liquidKeyboard: LiquidKeyboard
 }

app/src/main/java/com/osfans/trime/ime/keyboard/Keyboard.kt

@@ -105,7 +105,10 @@ class Keyboard() {
         private set
     var asciiKeyboard: String? = null // 英文鍵盤
         private set
+
     // todo 把按下按键弹出的内容改为单独设计的view，而不是keyboard
+    var keyboardHeight: Int = 0
+        private set
 
     /**
      * Creates a blank keyboard from the given resource file and populates it with the specified
@@ -222,7 +225,7 @@ class Keyboard() {
             )
         val horizontalGap = horizontalGap
         val verticalGap = verticalGap
-        val keyboardHeight = getKeyboardHeight(theme, keyboardConfig)
+        keyboardHeight = getKeyboardHeight(theme, keyboardConfig)
         val keyboardKeyWidth = obtainFloat(keyboardConfig, "width", 0f)
         val maxColumns = if (columns == -1) Int.MAX_VALUE else columns
         var x = this.horizontalGap / 2

app/src/main/java/com/osfans/trime/ime/keyboard/KeyboardWindow.kt

@@ -2,43 +2,35 @@ package com.osfans.trime.ime.keyboard
 
 import android.content.Context
 import android.view.LayoutInflater
-import android.widget.ViewAnimator
+import android.view.View
 import com.osfans.trime.databinding.MainInputLayoutBinding
-import com.osfans.trime.databinding.SymbolInputLayoutBinding
 import com.osfans.trime.ime.core.TrimeInputMethodService
 import com.osfans.trime.ime.dependency.InputScope
+import com.osfans.trime.ime.window.BoardWindow
+import com.osfans.trime.ime.window.ResidentWindow
 import me.tatarka.inject.annotations.Inject
-import splitties.views.dsl.core.add
-import splitties.views.dsl.core.lParams
-import splitties.views.dsl.core.matchParent
 
 @InputScope
 @Inject
-class KeyboardWindow(context: Context, service: TrimeInputMethodService) {
+class KeyboardWindow(context: Context, private val service: TrimeInputMethodService) : BoardWindow.NoBarBoardWindow(), ResidentWindow {
     val oldMainInputView by lazy {
-        MainInputLayoutBinding.inflate(LayoutInflater.from(context)).apply {
-            mainKeyboardView.onKeyboardActionListener = service.textInputManager
-        }
+        MainInputLayoutBinding.inflate(LayoutInflater.from(context))
     }
 
-    val oldSymbolInputView by lazy {
-        SymbolInputLayoutBinding.inflate(LayoutInflater.from(context))
-    }
+    companion object : ResidentWindow.Key
+
+    override val key: ResidentWindow.Key
+        get() = KeyboardWindow
 
-    enum class State {
-        Main,
-        Symbol,
+    override fun onCreateView(): View {
+        return oldMainInputView.root
     }
 
-    fun switchUiByState(state: State) {
-        if (view.displayedChild == state.ordinal) return
-        view.displayedChild = state.ordinal
+    override fun onAttached() {
+        oldMainInputView.mainKeyboardView.onKeyboardActionListener = service.textInputManager
     }
 
-    val view by lazy {
-        ViewAnimator(context).apply {
-            add(oldMainInputView.root, lParams(matchParent, matchParent))
-            add(oldSymbolInputView.root, lParams(matchParent, matchParent))
-        }
+    override fun onDetached() {
+        oldMainInputView.mainKeyboardView.onKeyboardActionListener = null
     }
 }

app/src/main/java/com/osfans/trime/ime/symbol/LiquidKeyboard.kt

@@ -2,10 +2,10 @@ package com.osfans.trime.ime.symbol
 
 import android.app.AlertDialog
 import android.content.Context
+import android.view.View
 import androidx.core.view.setPadding
 import androidx.lifecycle.lifecycleScope
 import androidx.recyclerview.widget.LinearLayoutManager
-import androidx.recyclerview.widget.RecyclerView
 import androidx.recyclerview.widget.StaggeredGridLayoutManager
 import com.google.android.flexbox.FlexDirection
 import com.google.android.flexbox.FlexWrap
@@ -24,11 +24,20 @@ import com.osfans.trime.ime.core.TrimeInputMethodService
 import com.osfans.trime.ime.dependency.InputScope
 import com.osfans.trime.ime.enums.KeyCommandType
 import com.osfans.trime.ime.enums.SymbolKeyboardType
+import com.osfans.trime.ime.keyboard.KeyboardSwitcher
 import com.osfans.trime.ime.text.TextInputManager
+import com.osfans.trime.ime.window.BoardWindow
+import com.osfans.trime.ime.window.ResidentWindow
 import com.osfans.trime.util.ShortcutUtils
 import kotlinx.coroutines.launch
 import me.tatarka.inject.annotations.Inject
 import splitties.dimensions.dp
+import splitties.views.dsl.constraintlayout.centerInParent
+import splitties.views.dsl.constraintlayout.constraintLayout
+import splitties.views.dsl.constraintlayout.lParams
+import splitties.views.dsl.core.add
+import splitties.views.dsl.core.matchParent
+import splitties.views.dsl.recyclerview.recyclerView
 import timber.log.Timber
 
 @InputScope
@@ -37,8 +46,7 @@ class LiquidKeyboard(
     private val context: Context,
     private val service: TrimeInputMethodService,
     private val theme: Theme,
-) : ClipboardHelper.OnClipboardUpdateListener {
-    private lateinit var keyboardView: RecyclerView
+) : BoardWindow.NoBarBoardWindow(), ResidentWindow, ClipboardHelper.OnClipboardUpdateListener {
     private val symbolHistory = SymbolHistory(180)
     private var adapterType: AdapterType = AdapterType.INIT
     private val simpleAdapter by lazy {
@@ -68,15 +76,33 @@ class LiquidKeyboard(
         CandidateAdapter(theme)
     }
 
-    fun setKeyboardView(view: RecyclerView) {
-        keyboardView =
-            view.apply {
-                val space = view.dp(3)
-                addItemDecoration(SpacesItemDecoration(space))
-                setPadding(space)
-            }
+    companion object : ResidentWindow.Key
+
+    override val key: ResidentWindow.Key
+        get() = LiquidKeyboard
+
+    private val keyboardView =
+        context.recyclerView {
+            val space = dp(3)
+            addItemDecoration(SpacesItemDecoration(space))
+            setPadding(space)
+        }
+
+    override fun onCreateView(): View {
+        return context.constraintLayout {
+            add(
+                keyboardView,
+                lParams(matchParent, KeyboardSwitcher.currentKeyboard.keyboardHeight) {
+                    centerInParent()
+                },
+            )
+        }
     }
 
+    override fun onAttached() {}
+
+    override fun onDetached() {}
+
 // 及时更新layoutManager, 以防在旋转屏幕后打开液体键盘crash
 
     /**

app/src/main/java/com/osfans/trime/ime/window/BoardWindow.kt

@@ -0,0 +1,24 @@
+package com.osfans.trime.ime.window
+
+import android.view.View
+
+sealed class BoardWindow {
+    /**
+     * After the window was set up in InputComponent
+     */
+    abstract fun onCreateView(): View
+
+    /**
+     * After the view was added to window manager's layout
+     */
+    abstract fun onAttached()
+
+    /**
+     * Before the view is removed from window manager's layout
+     */
+    abstract fun onDetached()
+
+    abstract class NoBarBoardWindow : BoardWindow() {
+        override fun toString(): String = javaClass.name
+    }
+}