erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-09-30 11:37:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge pull request #4508 from keymanapp/fix/common/core/web/3695-processKeyEvent-returns

Browse source 
fix(common/core/web): core key-processing now always returns RuleBehavior type.
This commit is contained in:
Joshua Horton 2021-02-24 09:35:48 +07:00 • committed by GitHub
commit 732f87f39a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
common/core/web/input-processor/src/text/inputProcessor.ts
View file

@ -55,8 +55,10 @@ namespace com.keyman.text {
* Handles default output and keyboard processing for both OSK and physical keystrokes.
*
* @param {Object} e The abstracted KeyEvent to use for keystroke processing
* @returns {Object} A RuleBehavior object describing the cumulative effects of
* all matched keyboard rules.
*/
processKeyEvent(keyEvent: KeyEvent) {
processKeyEvent(keyEvent: KeyEvent): RuleBehavior {
let formFactor = keyEvent.device.formFactor;
// Determine the current target for text output and create a "mock" backup
@ -70,14 +72,14 @@ namespace com.keyman.text {
// If it's a desktop OSK style and this triggers a layer change,
// a modifier key was clicked. No output expected, so it's safe to instantly exit.
if(this.keyboardProcessor.selectLayer(keyEvent)) {
return true;
return new RuleBehavior();
}
}
// Will handle keystroke-based non-layer change modifier & state keys, mapping them through the physical keyboard's version
// of state management.
if(!fromOSK && this.keyboardProcessor.doModifierPress(keyEvent, !fromOSK)) {
return true;
return new RuleBehavior();
}
// If suggestions exist AND space is pressed, accept the suggestion and do not process the keystroke.
@ -88,10 +90,10 @@ namespace com.keyman.text {
// Can the suggestion UI revert a recent suggestion? If so, do that and swallow the backspace.
if((keyEvent.kName == "K_BKSP" || keyEvent.Lcode == Codes.keyCodes["K_BKSP"]) && this.languageProcessor.tryRevertSuggestion()) {
return;
return new RuleBehavior();
// Can the suggestion UI accept an existing suggestion? If so, do that and swallow the space character.
} else if((keyEvent.kName == "K_SPACE" || keyEvent.Lcode == Codes.keyCodes["K_SPACE"]) && this.languageProcessor.tryAcceptSuggestion('space')) {
return;
return new RuleBehavior();
}
}
@ -171,15 +173,6 @@ namespace com.keyman.text {
}
}
/* I732 END - 13/03/2007 MCD: End Positional Layout support in OSK */
// TODO: rework the return value to be `ruleBehavior` instead. Functions that call this one are
// the ones that should worry about event handler returns, etc. Not this one.
//
// They should also be the ones to handle the TODOs seen earlier in this function -
// once THOSE are properly relocated. (They're too DOM-heavy to remain in web-core.)
// Only return true (for the eventual event handler's return value) if we didn't match a rule.
return ruleBehavior;
}

11
common/core/web/keyboard-processor/src/text/ruleBehavior.ts
View file

@ -4,9 +4,10 @@ namespace com.keyman.text {
*/
export class RuleBehavior {
/**
* The before-and-after Transform from matching a keyboard rule.
* The before-and-after Transform from matching a keyboard rule. May be `null`
* if no keyboard rules were matched for the keystroke.
*/
transcription: Transcription;
transcription: Transcription = null;
/**
* Indicates whether or not a BEEP command was issued by the matched keyboard rule.
@ -26,7 +27,7 @@ namespace com.keyman.text {
/**
* Denotes a non-output default behavior; this should be evaluated later, against the true keystroke.
*/
triggersDefaultCommand?: boolean;
triggersDefaultCommand: boolean = false;
/**
* Denotes error log messages generated when attempting to generate this behavior.
@ -44,6 +45,10 @@ namespace com.keyman.text {
predictionPromise?: Promise<Suggestion[]>;
finalize(processor: KeyboardProcessor) {
if(!this.transcription) {
throw "Cannot finalize a RuleBehavior with no transcription.";
}
let outputTarget = this.transcription.keystroke.Ltarg;
if(processor.beepHandler && this.beep) {