erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-22 16:27:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

fix(developer): tighten touch layout file structural validity checks
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
Details

Browse source 
Fixes: #16214
Fixes: KEYMAN-DEVELOPER-39Q
Test-bot: skip
This commit is contained in:
Marc Durdin 2026-08-11 17:41:53 +02:00
parent 176d031f1b
commit cd674fd7a0
2 changed files with 171 additions and 71 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

190
developer/src/kmc-kmn/src/kmw-compiler/validate-layout-file.ts
View file

@ -1,3 +1,6 @@
/*
* Keyman is copyright (C) SIL Global. MIT License.
*/
import { KMX, TouchLayout } from "@keymanapp/common-types";
import { TouchLayoutFileReader, TouchLayoutFileWriter } from "@keymanapp/developer-utils";
import { callbacks, minimumKeymanVersion, verifyAndSetMinimumRequiredKeymanVersion15,
@ -263,77 +266,10 @@ export function ValidateLayoutFile(fk: KMX.KEYBOARD, FDebug: boolean, sLayoutFil
return null;
}
let hasWarnedOfGestureUseDownlevel = false;
const warnGesturesIfNeeded = function(keyId: string) {
if(!hasWarnedOfGestureUseDownlevel && !verifyAndSetMinimumRequiredKeymanVersion17()) {
hasWarnedOfGestureUseDownlevel = true;
callbacks.reportMessage(KmwCompilerMessages.Hint_TouchLayoutUsesUnsupportedGesturesDownlevel({keyId}));
}
}
let result: boolean = true;
let FTouchLayoutFont = ''; // I4872
let pid: keyof TouchLayout.TouchLayoutFile;
for(pid in data) {
const platform = data[pid];
// Test that the font matches on all platforms // I4872
if(FTouchLayoutFont == '') {
FTouchLayoutFont = platform.font?.toLowerCase() ?? '';
}
else if((platform.font?.toLowerCase() ?? '') != FTouchLayoutFont) {
callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutFontShouldBeSameForAllPlatforms());
// TODO: why support multiple font values if it has to be the same across all platforms?!
}
// Test that all required keys are present
for(const layer of platform.layer) {
const FRequiredKeys: TRequiredKey[] = [];
let rowIndex = 0;
for(const row of layer.row) {
rowIndex++;
let keyIndex = 0;
for(const key of row.key) {
keyIndex++;
result = CheckKey(pid, platform, layer, key.id, key.text, key.nextlayer, key.sp, FRequiredKeys, FDictionary, {rowIndex, keyIndex}) && result; // I4119
if(key.sk) {
let subKeyIndex = 0;
for(const subkey of key.sk) {
subKeyIndex++;
result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary,
{rowIndex, keyIndex, subKeyIndex}) && result;
}
}
let direction: keyof TouchLayout.TouchLayoutFlick;
if(key.flick) {
for(direction in key.flick) {
warnGesturesIfNeeded(key.id);
result = CheckKey(pid, platform, layer, key.flick[direction].id, key.flick[direction].text,
key.flick[direction].nextlayer, key.flick[direction].sp, FRequiredKeys, FDictionary, {rowIndex, keyIndex, direction}) && result;
}
}
if(key.multitap) {
let multitapIndex = 0;
for(const subkey of key.multitap) {
multitapIndex++;
warnGesturesIfNeeded(key.id);
result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary,
{rowIndex, keyIndex, multitapIndex}) && result;
}
}
}
}
if(FRequiredKeys.length != CRequiredKeys.length) {
callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutMissingRequiredKeys({
layerId: layer.id,
platformName: pid,
missingKeys: CRequiredKeys.filter(x => !FRequiredKeys.includes(x)).join(', ')
}));
}
}
const result = validateLayoutFileContent(data, FDictionary);
if(result === null) {
// A structural error was encountered
return null;
}
// Transform the layout keys with displayMap
@ -356,3 +292,115 @@ export function ValidateLayoutFile(fk: KMX.KEYBOARD, FDebug: boolean, sLayoutFil
result
}
}
/**
* Validate the structure and content of a touch layout file
* @param data
* @param FDictionary
* @returns null if the file is structurally invalid; false if the file contains content errors, true otherwise
*/
function validateLayoutFileContent(data: TouchLayout.TouchLayoutFile, FDictionary: string[]): boolean | null {
let hasWarnedOfGestureUseDownlevel = false;
const warnGesturesIfNeeded = function(keyId: string) {
if(!hasWarnedOfGestureUseDownlevel && !verifyAndSetMinimumRequiredKeymanVersion17()) {
hasWarnedOfGestureUseDownlevel = true;
callbacks.reportMessage(KmwCompilerMessages.Hint_TouchLayoutUsesUnsupportedGesturesDownlevel({keyId}));
}
}
let result: boolean = true;
let FTouchLayoutFont = ''; // I4872
let pid: keyof TouchLayout.TouchLayoutFile;
for(pid in data) {
const platform = data[pid];
// Test that the font matches on all platforms // I4872
if(FTouchLayoutFont == '') {
FTouchLayoutFont = platform.font?.toLowerCase() ?? '';
}
else if((platform.font?.toLowerCase() ?? '') != FTouchLayoutFont) {
callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutFontShouldBeSameForAllPlatforms());
// TODO: why support multiple font values if it has to be the same across all platforms?!
}
// Test that all required keys are present
if(!Array.isArray(platform.layer)) {
callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({msg: 'platform.layer must be an array'}));
return null;
}
for(const layer of platform.layer) {
const FRequiredKeys: TRequiredKey[] = [];
let rowIndex = 0;
if(!Array.isArray(layer.row)) {
callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({msg: 'layer.row must be an array'}));
return null;
}
for(const row of layer.row) {
rowIndex++;
let keyIndex = 0;
if(!Array.isArray(row.key)) {
callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({msg: 'row.key must be an array'}));
return null;
}
for(const key of row.key) {
keyIndex++;
result = CheckKey(pid, platform, layer, key.id, key.text, key.nextlayer, key.sp, FRequiredKeys, FDictionary, {rowIndex, keyIndex}) && result; // I4119
if(key.sk) {
let subKeyIndex = 0;
if(!Array.isArray(key.sk)) {
callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({msg: 'key.sk must be an array'}));
return null;
}
for(const subkey of key.sk) {
subKeyIndex++;
result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary,
{rowIndex, keyIndex, subKeyIndex}) && result;
}
}
let direction: keyof TouchLayout.TouchLayoutFlick;
if(key.flick) {
if(typeof(key.flick) != "object") {
callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({msg: 'platform.layer must be an array'}));
return null;
}
for(direction in key.flick) {
warnGesturesIfNeeded(key.id);
result = CheckKey(pid, platform, layer, key.flick[direction].id, key.flick[direction].text,
key.flick[direction].nextlayer, key.flick[direction].sp, FRequiredKeys, FDictionary, {rowIndex, keyIndex, direction}) && result;
}
}
if(key.multitap) {
let multitapIndex = 0;
if(!Array.isArray(key.multitap)) {
callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({msg: 'key.multitap must be an array'}));
return null;
}
for(const subkey of key.multitap) {
multitapIndex++;
warnGesturesIfNeeded(key.id);
result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary,
{rowIndex, keyIndex, multitapIndex}) && result;
}
}
}
}
if(FRequiredKeys.length != CRequiredKeys.length) {
callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutMissingRequiredKeys({
layerId: layer.id,
platformName: pid,
missingKeys: CRequiredKeys.filter(x => !FRequiredKeys.includes(x)).join(', ')
}));
}
}
}
return result;
}
export const unitTestEndpoints = {
validateLayoutFileContent,
};

52
developer/src/kmc-kmn/test/kmw/validate-layout-file.tests.ts Normal file
View file

@ -0,0 +1,52 @@
/*
* Keyman is copyright (C) SIL Global. MIT License.
*
* Created by mcdurdin on 2026-08-11
*/
import 'mocha';
import { assert } from 'chai';
import { TestCompilerCallbacks } from '@keymanapp/developer-test-helpers';
// import { KmnCompiler } from '../../src/compiler/compiler.js';
import { KMX, TouchLayout } from '@keymanapp/common-types';
import { KmwCompilerMessages } from '../../src/kmw-compiler/kmw-compiler-messages.js';
import { unitTestEndpoints } from '../../src/kmw-compiler/validate-layout-file.js';
import { setupGlobals } from '../../src/kmw-compiler/compiler-globals.js';
describe('validate-layout-file', function() {
const callbacks = new TestCompilerCallbacks(this);
const options = {
shouldAddCompilerVersion: false,
saveDebug: true,
};
// const kmnCompiler: KmnCompiler = new KmnCompiler();
this.beforeAll(async function() {
// assert.isTrue(await kmnCompiler.init(callbacks, options));
setupGlobals(callbacks, options, '', '', null, { groups: [], isMnemonic: false, startGroup: { ansi: 0, newContext: 0, postKeystroke: 0, unicode: 0 }, stores: [], targets: '', fileVersion: KMX.KMXFile.VERSION_100}, '');
});
this.afterEach(function() {
if (this.currentTest.state !== 'passed') {
callbacks.printMessages();
}
})
const fixtures: {name: string, data: TouchLayout.TouchLayoutFile}[] = [
{ name: 'a null platform.layer property', data: { desktop: { layer: null, defaultHint: null } } },
{ name: 'an invalid platform.layer property', data: { desktop: { layer: {} as any, defaultHint: null } } },
{ name: 'a null platform.layer.row property', data: { desktop: { layer: [{id:'', row: null}], defaultHint: null } } },
{ name: 'an invalid platform.layer.row property', data: { desktop: { layer: [{id:'', row: "" as any}], defaultHint: null } } },
{ name: 'a null platform.layer.row.key property', data: { desktop: { layer: [{id:'', row: [{id:'', key: null}]}], defaultHint: null } } },
{ name: 'an invalid platform.layer.row.key property', data: { desktop: { layer: [{id:'', row: [{id:'', key: 100}]}], defaultHint: null } } },
{ name: 'an invalid platform.layer.row.key.sk property', data: { desktop: { layer: [{id:'', row: [{id:'', key: [{sk: "x" as any}]}]}], defaultHint: null } } },
{ name: 'an invalid platform.layer.row.key.multitap property', data: { desktop: { layer: [{id:'', row: [{id:'', key: [{multitap: "x" as any}]}]}], defaultHint: null } } },
{ name: 'an invalid platform.layer.row.key.flick property', data: { desktop: { layer: [{id:'', row: [{id:'', key: [{flick: "x" as any}]}]}], defaultHint: null } } },
]
fixtures.forEach(fixture => {
it(`should raise an error if a file has ${fixture.name}`, function() {
assert.isNull(unitTestEndpoints.validateLayoutFileContent(fixture.data, []));
assert.isTrue(callbacks.hasMessage(KmwCompilerMessages.ERROR_InvalidTouchLayoutFileFormat));
});
});
});