refactor: extract KeyboardLayoutHandler from GeneralKeyboardIME (Part 15) - #426 #692
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| // SPDX-License-Identifier: GPL-3.0-or-later | ||
|
|
||
| package be.scri.helpers | ||
|
|
||
| import android.text.InputType.TYPE_CLASS_DATETIME | ||
| import android.text.InputType.TYPE_CLASS_NUMBER | ||
| import android.text.InputType.TYPE_CLASS_PHONE | ||
| import android.text.InputType.TYPE_MASK_CLASS | ||
| import be.scri.R | ||
| import be.scri.models.ScribeState | ||
| import be.scri.services.GeneralKeyboardIME | ||
|
|
||
| private const val DATA_SIZE_2 = 2 | ||
| private const val DATA_SIZE_3 = 3 | ||
|
|
||
| /** | ||
| * Encapsulates keyboard XML layout resolution, symbol layout mapping, | ||
| * keyboard width calculations, state-based layout XML selection, and view re-creation. | ||
| */ | ||
| class KeyboardLayoutHandler( | ||
| private val ime: GeneralKeyboardIME, | ||
| ) { | ||
| /** | ||
| * Resolves the XML resource ID for the active keyboard layout. | ||
| * | ||
| * @return The XML layout resource ID. | ||
| */ | ||
| fun getCurrentKeyboardLayoutXML(): Int = | ||
| when (ime.keyboardMode) { | ||
| ime.keyboardSymbols -> getPrimarySymbolKeyboardLayoutXML() | ||
| ime.keyboardSymbolShift -> R.xml.keys_symbols_shift | ||
| else -> ime.getKeyboardLayoutXML() | ||
| } | ||
|
|
||
| /** | ||
| * Resolves the primary symbol or numeric layout XML resource ID. | ||
| * | ||
| * @return The XML layout resource ID. | ||
| */ | ||
| fun getPrimarySymbolKeyboardLayoutXML(): Int = | ||
| if (ime.isNumericKeyboardActive) { | ||
| R.xml.keys_numeric | ||
| } else { | ||
| R.xml.keys_symbols | ||
| } | ||
|
|
||
| /** | ||
| * Determines which keyboard layout XML to use based on the current [ScribeState]. | ||
| * | ||
| * @param state The current state of the Scribe keyboard. | ||
| * @param isSubsequentArea true if this is for a secondary conjugation view. | ||
| * @param dataSize The number of items to display, used to select an appropriate layout. | ||
| * @return The resource ID of the keyboard layout XML. | ||
| */ | ||
| fun getKeyboardLayoutForState( | ||
| state: ScribeState, | ||
| isSubsequentArea: Boolean = false, | ||
| dataSize: Int = 0, | ||
| ): Int = | ||
| when (state) { | ||
| ScribeState.SELECT_VERB_CONJUNCTION -> { | ||
| ime.saveConjugateModeType(ime.language) | ||
| if (!isSubsequentArea && dataSize == 0) { | ||
| ime.defaultConjugateLayoutXML | ||
| } else { | ||
| when (dataSize) { | ||
| DATA_SIZE_2 -> R.xml.conjugate_view_2x1 | ||
| DATA_SIZE_3 -> R.xml.conjugate_view_1x3 | ||
| else -> R.xml.conjugate_view_2x2 | ||
| } | ||
| } | ||
| } | ||
|
|
||
| else -> { | ||
| ime.getKeyboardLayoutXML() | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Calculates the width of the keyboard container. | ||
| * | ||
| * @return The keyboard width in pixels. | ||
| */ | ||
| fun getKeyboardWidth(): Int = | ||
| if (ime.isFloatingMode) { | ||
| val density = ime.resources.displayMetrics.density | ||
| val screenWidth = ime.resources.displayMetrics.widthPixels | ||
| val floatWidth = (320f * density).toInt() | ||
| Math.min(floatWidth, (screenWidth * 0.85f).toInt()) | ||
| } else { | ||
| ime.resources.displayMetrics.widthPixels | ||
| } | ||
|
|
||
| /** | ||
| * Re-instantiates the [KeyboardBase] and applies the updated shift state and layout. | ||
| */ | ||
| fun recreateKeyboard() { | ||
| if (!ime.isUiManagerInitialized) return | ||
|
|
||
| val xmlId = getCurrentKeyboardLayoutXML() | ||
| val currentShiftState = ime.keyboard?.mShiftState ?: SHIFT_OFF | ||
| ime.keyboard = KeyboardBase(ime, xmlId, ime.enterKeyType, getKeyboardWidth()) | ||
| ime.keyboard?.setShifted(currentShiftState) | ||
| ime.keyboardView?.setKeyboard(ime.keyboard!!) | ||
|
|
||
| if (xmlId == R.xml.keys_symbols) { | ||
| ime.uiManager.setupCurrencySymbol(ime.language) | ||
| } | ||
| ime.keyboardView?.invalidateAllKeys() | ||
| } | ||
|
|
||
| companion object { | ||
| internal fun shouldUseNumericKeyboard(inputType: Int): Boolean = | ||
| when (inputType and TYPE_MASK_CLASS) { | ||
| TYPE_CLASS_NUMBER, TYPE_CLASS_DATETIME, TYPE_CLASS_PHONE -> true | ||
| else -> false | ||
| } | ||
|
|
||
| internal fun getKeyboardLayoutXMLForInputType( | ||
| inputType: Int, | ||
| letterKeyboardLayoutXML: Int, | ||
| ): Int = | ||
| if (shouldUseNumericKeyboard(inputType)) { | ||
| R.xml.keys_numeric | ||
| } else { | ||
| letterKeyboardLayoutXML | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Circular import: KeyboardLayoutHandler (helpers) and GeneralKeyboardIME (services) import each other, the handler isn't truly decoupled, it just holds a full ime reference.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. In this PR (Part 15),
KeyboardLayoutHandlerfollowed the same structure as previous helper extractions. In the dedicated follow-up #693 (Part 16), we introduce theKeyboardIMEContextinterface contract across all handlers, removing theGeneralKeyboardIMEreference fromKeyboardLayoutHandlerand breaking the circular import across the codebase.