erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

refactor(web): rename variables and parameter names in KeymanEngine 🧼

Browse source 
Build-bot: skip build:web
Test-bot: skip
This commit is contained in:
Eberhard Beilharz 2026-04-24 15:48:30 +02:00 • committed by Marc Durdin
parent b5be1d45f0
commit 689f664ea0
1 changed files with 17 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
web/src/app/browser/src/keymanEngine.ts
View file

@ -6,7 +6,7 @@ import {
TwoStateActivator,
VisualKeyboard
} from 'keyman/engine/osk';
import { ErrorStub, KeyboardStub, CloudQueryResult, toPrefixedKeyboardId as prefixed } from 'keyman/engine/keyboard-storage';
import { ErrorStub, KeyboardStub, CloudQueryResult, toPrefixedKeyboardId } from 'keyman/engine/keyboard-storage';
import { DeviceSpec } from 'keyman/common/web-utils';
import { JSKeyboard, Keyboard, KMXKeyboard } from "keyman/engine/keyboard";
import KeyboardObject = KeymanWebKeyboard.KeyboardObject;
@ -451,14 +451,14 @@ export class KeymanEngine extends KeymanEngineBase<BrowserConfiguration, Context
/**
* Get keyboard meta data for the selected keyboard and language
*
* @param {string} PInternalName Internal name of keyboard
* @param {string=} PlgCode language code
* @return {Object} Details of named keyboard
* @param {string} id Internal name of keyboard
* @param {string?} langCode language code
* @return {KeyboardDetails} Details of named keyboard
*
* See https://help.keyman.com/developer/engine/web/current-version/reference/core/getKeyboard
**/
public getKeyboard(PInternalName: string, PlgCode?: string): KeyboardDetails {
const stub = this.keyboardRequisitioner.cache.getStub(PInternalName, PlgCode);
public getKeyboard(id: string, langCode?: string): KeyboardDetails {
const stub = this.keyboardRequisitioner.cache.getStub(id, langCode);
const keyboard = this.keyboardRequisitioner.cache.getKeyboardForStub(stub);
if (keyboard instanceof JSKeyboard) {
@ -470,35 +470,28 @@ export class KeymanEngine extends KeymanEngineBase<BrowserConfiguration, Context
}
/**
* Get API-friendly array of available keyboard stubs
* Get API-friendly array of available keyboard metadata
*
* Refer to https://help.keyman.com/developer/engine/web/current-version/reference/core/getKeyboards.
*
* The type of each entry of the array corresponds to that of `getKeyboard`.
*
* @return {Array} Array of available keyboards
* @return {KeyboardDetails[]} Array of available keyboards
*
* See https://help.keyman.com/developer/engine/web/current-version/reference/core/getKeyboards
*/
public getKeyboards(): KeyboardDetails[] {
const Lr: KeyboardDetails[] = [];
const detailsForAllKeyboards: KeyboardDetails[] = [];
const cache = this.keyboardRequisitioner.cache;
const keyboardStubs = cache.getStubList()
for(let Ln=0; Ln < keyboardStubs.length; Ln++) { // I1511 - array prototype extended
const Lstub = keyboardStubs[Ln];
// In Chrome, (including on Android), Array.prototype.find() requires Chrome 45.
// This is a later version than the default on our oldest-supported Android devices.
const Lkbd = cache.getKeyboardForStub(Lstub);
if (Lkbd instanceof JSKeyboard) {
const Lrn = this._GetKeyboardDetail(Lstub, Lkbd); // I2078 - Full keyboard detail
Lr.push(Lrn);
for(let i=0; i < keyboardStubs.length; i++) {
const stub = keyboardStubs[i];
const keyboard = cache.getKeyboardForStub(stub);
if (keyboard instanceof JSKeyboard) {
const keyboardDetails = this._GetKeyboardDetail(stub, keyboard);
detailsForAllKeyboards.push(keyboardDetails);
} else {
// TODO-web-core: do this work in _GetKeyboardDetail (implement for KMX keyboards if needed)
}
}
return Lr;
return detailsForAllKeyboards;
}
/**
@ -514,7 +507,7 @@ export class KeymanEngine extends KeymanEngineBase<BrowserConfiguration, Context
// `true` is responsible for this & is required to pass a variable-store unit test.
this.keyboardRequisitioner.cache.forgetKeyboard(x[i], true);
if(this.contextManager.activeKeyboard?.metadata.id == prefixed(x[i])) {
if(this.contextManager.activeKeyboard?.metadata.id == toPrefixedKeyboardId(x[i])) {
this.contextManager.activateKeyboard('', '');
}
}