@keymanapp/kmc-kmn 18.0.17-alpha → 18.0.19-alpha

package/build/src/kmw-compiler/validate-layout-file.js

@@ -1,278 +1,279 @@
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="55766aad-9de8-587f-9fb1-1978f7fa4c8a")}catch(e){}}();
-import { TouchLayoutFileReader, TouchLayoutFileWriter } from "@keymanapp/common-types";
-import { callbacks, fk, IsKeyboardVersion14OrLater, IsKeyboardVersion15OrLater, IsKeyboardVersion17OrLater } from "./compiler-globals.js";
-import { JavaScript_Key } from "./javascript-strings.js";
-import { TRequiredKey, CRequiredKeys, CSpecialText, CSpecialText14Map, CSpecialText17Map, CSpecialTextMinVer, CSpecialTextMaxVer } from "./constants.js";
-import { KeymanWebTouchStandardKeyNames, KMWAdditionalKeyNames, VKeyNames } from "./keymanweb-key-codes.js";
-import { KmwCompilerMessages } from "./kmw-compiler-messages.js";
-import * as Osk from '../compiler/osk.js';
-;
-function IsValidUnicodeValue(ch) {
-    return ((ch >= 0x0020) && (ch <= 0x007F)) ||
-        ((ch >= 0x00A0) && (ch <= 0x10FFFF));
-}
-var TKeyIdType;
-(function (TKeyIdType) {
-    TKeyIdType[TKeyIdType["Key_Invalid"] = 0] = "Key_Invalid";
-    TKeyIdType[TKeyIdType["Key_Constant"] = 1] = "Key_Constant";
-    TKeyIdType[TKeyIdType["Key_Touch"] = 2] = "Key_Touch";
-    TKeyIdType[TKeyIdType["Key_Unicode"] = 3] = "Key_Unicode";
-    TKeyIdType[TKeyIdType["Key_Unicode_Multi"] = 4] = "Key_Unicode_Multi";
-})(TKeyIdType || (TKeyIdType = {}));
-; // I4142
-function GetKeyIdUnicodeType(value) {
-    let values = value.split('_');
-    for (let v of values) {
-        if (!IsValidUnicodeValue(parseInt(v, 16))) {
-            return TKeyIdType.Key_Invalid;
-        }
-    }
-    if (values.length > 1) {
-        return TKeyIdType.Key_Unicode_Multi;
-    }
-    return TKeyIdType.Key_Unicode;
-}
-function KeyIdType(FId) {
-    FId = FId.toUpperCase();
-    switch (FId.charAt(0)) {
-        case 'T':
-            return TKeyIdType.Key_Touch;
-        case 'U':
-            if (FId.startsWith('U_')) {
-                return GetKeyIdUnicodeType(FId.substring(2));
-            }
-        default:
-            // Note: can't use indexOf because some VKeyNames are mixed case, e.g. K_oE2
-            if (VKeyNames.find(key => key.toUpperCase() == FId)) {
-                return TKeyIdType.Key_Constant;
-            }
-            if (KeymanWebTouchStandardKeyNames.indexOf(FId) >= 0) {
-                return TKeyIdType.Key_Constant;
-            }
-            if (KMWAdditionalKeyNames.indexOf(FId) >= 0) {
-                return TKeyIdType.Key_Constant;
-            }
-    }
-    return TKeyIdType.Key_Invalid;
-}
-function CheckKey(platformId, FPlatform, layer, FId, FText, FNextLayer, FKeyType, FRequiredKeys, FDictionary) {
-    //
-    // Coerce missing ID and Text to empty strings for additional tests
-    //
-    FId = FId ?? '';
-    FText = FText ?? '';
-    //
-    // Check that each touch layer has K_LOPT, [K_ROPT,] K_BKSP, K_ENTER
-    //
-    for (let key of CRequiredKeys) {
-        if (TRequiredKey[key].toLowerCase() == FId.toLowerCase()) {
-            if (FRequiredKeys.indexOf(key) < 0) {
-                FRequiredKeys.push(key);
-            }
-            break;
-        }
-    }
-    //
-    // Check that each layer referenced exists
-    //
-    if (typeof FNextLayer == 'string' && FNextLayer.length > 0) {
-        if (FPlatform.layer.find(l => l.id.toLowerCase() == FNextLayer.toLowerCase()) == undefined) {
-            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutMissingLayer({
-                keyId: FId,
-                layerId: layer.id,
-                nextLayer: FNextLayer,
-                platformName: platformId
-            }));
-        }
-    }
-    //
-    // Check that the key has a valid id   // I4142
-    //
-    if (FId.trim() == '') {
-        if (!([9 /* TouchLayout.TouchLayoutKeySp.blank */, 10 /* TouchLayout.TouchLayoutKeySp.spacer */].includes(FKeyType))) {
-            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutUnidentifiedKey({ layerId: layer.id }));
-        }
-        return true;
-    }
-    let FValid = KeyIdType(FId);
-    if (FValid == TKeyIdType.Key_Invalid) {
-        callbacks.reportMessage(KmwCompilerMessages.Error_TouchLayoutInvalidIdentifier({ keyId: FId, platformName: platformId, layerId: layer.id }));
-        return false;
-    }
-    else if (FValid == TKeyIdType.Key_Unicode_Multi && !IsKeyboardVersion15OrLater()) {
-        callbacks.reportMessage(KmwCompilerMessages.Error_TouchLayoutIdentifierRequires15({ keyId: FId, platformName: platformId, layerId: layer.id }));
-        return false;
-    }
-    //
-    // Check that each custom key code has at least *a* rule associated with it
-    //
-    if (FValid == TKeyIdType.Key_Touch && FNextLayer == '' && [0 /* TouchLayout.TouchLayoutKeySp.normal */, 8 /* TouchLayout.TouchLayoutKeySp.deadkey */].includes(FKeyType)) {
-        // Search for the key in the key dictionary - ignore K_LOPT, K_ROPT...
-        if (FDictionary.indexOf(FId) < 0) {
-            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutCustomKeyNotDefined({ keyId: FId, platformName: platformId, layerId: layer.id }));
-        }
-    }
-    //
-    // Check that if the key has a *special* label, it is available in the target version
-    //
-    if (FText.startsWith('*') && FText.endsWith('*') && FText.length > 2) {
-        // Keyman versions before 14 do not support '*special*' labels on non-special keys.
-        // ZWNJ use, however, is safe because it will be transformed in function
-        // TransformSpecialKeys14 to '<|>',  which does not require the custom OSK font.
-        const mapVersion = Math.max(Math.min(fk.fileVersion, CSpecialTextMaxVer), CSpecialTextMinVer);
-        const specialText = CSpecialText.get(mapVersion);
-        if (specialText.includes(FText) &&
-            !IsKeyboardVersion14OrLater() &&
-            !([1 /* TouchLayout.TouchLayoutKeySp.special */, 2 /* TouchLayout.TouchLayoutKeySp.specialActive */].includes(FKeyType))) {
-            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutSpecialLabelOnNormalKey({
-                keyId: FId,
-                platformName: platformId,
-                layerId: layer.id,
-                label: FText
-            }));
-        }
-    }
-    return true;
-}
-function CheckDictionaryKeyValidity(fk, FDictionary) {
-    // TODO: O(eeek) performance here
-    for (let i = 0; i < FDictionary.length; i++) {
-        if (FDictionary[i] == '') {
-            continue;
-        }
-        if ([TKeyIdType.Key_Invalid, TKeyIdType.Key_Constant].includes(KeyIdType(FDictionary[i]))) {
-            for (let fgp of fk.groups) {
-                if (fgp.fUsingKeys) {
-                    for (let fkp of fgp.keys) {
-                        if (JavaScript_Key(fkp, fk.isMnemonic) == i + 256) {
-                            callbacks.reportMessage(KmwCompilerMessages.Error_InvalidKeyCode({ keyId: FDictionary[i] }));
-                        }
-                    }
-                }
-            }
-        }
-    }
-}
-function TransformSpecialKeys14(FDebug, sLayoutFile) {
-    // Rewrite Special key labels that are only supported in Keyman 14+
-    // This code is a little ugly but effective.
-    if (!IsKeyboardVersion14OrLater()) {
-        for (let i = 0; i < CSpecialText14Map.length; i++) {
-            // Assumes the JSON output format will not change
-            if (FDebug) {
-                sLayoutFile = sLayoutFile.replaceAll('"text": "' + CSpecialText14Map[i][0] + '"', '"text": this._v>13 ? "' + CSpecialText14Map[i][0] + '" : "' + CSpecialText14Map[i][1] + '"');
-            }
-            else {
-                sLayoutFile = sLayoutFile.replaceAll('"text":"' + CSpecialText14Map[i][0] + '"', '"text":this._v>13?"' + CSpecialText14Map[i][0] + '":"' + CSpecialText14Map[i][1] + '"');
-            }
-        }
-    }
-    return sLayoutFile;
-}
-function TransformSpecialKeys17(FDebug, sLayoutFile) {
-    // Rewrite Special key labels that are only supported in Keyman 17+
-    // This code is a little ugly but effective.
-    if (!IsKeyboardVersion17OrLater()) {
-        for (let i = 0; i < CSpecialText17Map.length; i++) {
-            // Assumes the JSON output format will not change
-            if (FDebug) {
-                sLayoutFile = sLayoutFile.replaceAll('"text": "' + CSpecialText17Map[i][0] + '"', '"text": this._v>16 ? "' + CSpecialText17Map[i][0] + '" : "' + CSpecialText17Map[i][1] + '"');
-            }
-            else {
-                sLayoutFile = sLayoutFile.replaceAll('"text":"' + CSpecialText17Map[i][0] + '"', '"text":this._v>16?"' + CSpecialText17Map[i][0] + '":"' + CSpecialText17Map[i][1] + '"');
-            }
-        }
-    }
-    return sLayoutFile;
-}
-export function ValidateLayoutFile(fk, FDebug, sLayoutFile, sVKDictionary, displayMap) {
-    let FDictionary = sVKDictionary.split(/\s+/);
-    CheckDictionaryKeyValidity(fk, FDictionary); // I4142
-    let reader = new TouchLayoutFileReader();
-    let data;
-    try {
-        if (!callbacks.fs.existsSync(sLayoutFile)) {
-            callbacks.reportMessage(KmwCompilerMessages.Error_TouchLayoutFileDoesNotExist({ filename: sLayoutFile }));
-            return null;
-        }
-        data = reader.read(callbacks.loadFile(sLayoutFile));
-        if (!data) {
-            throw new Error('Unknown error reading touch layout file');
-        }
-    }
-    catch (e) {
-        callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({ msg: (e ?? 'Unspecified error').toString() }));
-        return null;
-    }
-    let hasWarnedOfGestureUseDownlevel = false;
-    const warnGesturesIfNeeded = function (keyId) {
-        if (!hasWarnedOfGestureUseDownlevel && !IsKeyboardVersion17OrLater()) {
-            hasWarnedOfGestureUseDownlevel = true;
-            callbacks.reportMessage(KmwCompilerMessages.Hint_TouchLayoutUsesUnsupportedGesturesDownlevel({ keyId }));
-        }
-    };
-    let result = true;
-    let FTouchLayoutFont = ''; // I4872
-    let pid;
-    for (pid in data) {
-        let 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 (let layer of platform.layer) {
-            let FRequiredKeys = [];
-            for (let row of layer.row) {
-                for (let key of row.key) {
-                    result = CheckKey(pid, platform, layer, key.id, key.text, key.nextlayer, key.sp, FRequiredKeys, FDictionary) && result; // I4119
-                    if (key.sk) {
-                        for (let subkey of key.sk) {
-                            result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary) && result;
-                        }
-                    }
-                    let direction;
-                    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) && result;
-                        }
-                    }
-                    if (key.multitap) {
-                        for (let subkey of key.multitap) {
-                            warnGesturesIfNeeded(key.id);
-                            result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary) && result;
-                        }
-                    }
-                }
-            }
-            if (FRequiredKeys.length != CRequiredKeys.length) {
-                callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutMissingRequiredKeys({
-                    layerId: layer.id,
-                    platformName: pid,
-                    missingKeys: CRequiredKeys.filter(x => !FRequiredKeys.includes(x)).join(', ')
-                }));
-            }
-        }
-    }
-    // Transform the layout keys with displayMap
-    if (displayMap) {
-        Osk.remapTouchLayout(data, displayMap);
-    }
-    // If not debugging, then this strips out formatting for a big saving in file size
-    // This also normalises any values such as Pad or Width which should be strings
-    let writer = new TouchLayoutFileWriter({ formatted: FDebug });
-    sLayoutFile = writer.compile(data);
-    sLayoutFile = TransformSpecialKeys14(FDebug, sLayoutFile);
-    sLayoutFile = TransformSpecialKeys17(FDebug, sLayoutFile);
-    return {
-        output: sLayoutFile,
-        result
-    };
-}
-//# debugId=55766aad-9de8-587f-9fb1-1978f7fa4c8a
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="8528f1d8-5ec7-5e50-bde3-a3c955ca5a2b")}catch(e){}}();
+import { TouchLayoutFileReader, TouchLayoutFileWriter } from "@keymanapp/common-types";
+import { callbacks, fk, IsKeyboardVersion14OrLater, IsKeyboardVersion15OrLater, IsKeyboardVersion17OrLater } from "./compiler-globals.js";
+import { JavaScript_Key } from "./javascript-strings.js";
+import { TRequiredKey, CRequiredKeys, CSpecialText, CSpecialText14Map, CSpecialText17Map, CSpecialTextMinVer, CSpecialTextMaxVer } from "./constants.js";
+import { KeymanWebTouchStandardKeyNames, KMWAdditionalKeyNames, VKeyNames } from "./keymanweb-key-codes.js";
+import { KmwCompilerMessages } from "./kmw-compiler-messages.js";
+import * as Osk from '../compiler/osk.js';
+;
+function IsValidUnicodeValue(ch) {
+    return ((ch >= 0x0020) && (ch <= 0x007F)) ||
+        ((ch >= 0x00A0) && (ch <= 0x10FFFF));
+}
+var TKeyIdType;
+(function (TKeyIdType) {
+    TKeyIdType[TKeyIdType["Key_Invalid"] = 0] = "Key_Invalid";
+    TKeyIdType[TKeyIdType["Key_Constant"] = 1] = "Key_Constant";
+    TKeyIdType[TKeyIdType["Key_Touch"] = 2] = "Key_Touch";
+    TKeyIdType[TKeyIdType["Key_Unicode"] = 3] = "Key_Unicode";
+    TKeyIdType[TKeyIdType["Key_Unicode_Multi"] = 4] = "Key_Unicode_Multi";
+})(TKeyIdType || (TKeyIdType = {}));
+; // I4142
+function GetKeyIdUnicodeType(value) {
+    let values = value.split('_');
+    for (let v of values) {
+        if (!IsValidUnicodeValue(parseInt(v, 16))) {
+            return TKeyIdType.Key_Invalid;
+        }
+    }
+    if (values.length > 1) {
+        return TKeyIdType.Key_Unicode_Multi;
+    }
+    return TKeyIdType.Key_Unicode;
+}
+function KeyIdType(FId) {
+    FId = FId.toUpperCase();
+    switch (FId.charAt(0)) {
+        case 'T':
+            return TKeyIdType.Key_Touch;
+        case 'U':
+            if (FId.startsWith('U_')) {
+                return GetKeyIdUnicodeType(FId.substring(2));
+            }
+        default:
+            // Note: can't use indexOf because some VKeyNames are mixed case, e.g. K_oE2
+            if (VKeyNames.find(key => key.toUpperCase() == FId)) {
+                return TKeyIdType.Key_Constant;
+            }
+            if (KeymanWebTouchStandardKeyNames.indexOf(FId) >= 0) {
+                return TKeyIdType.Key_Constant;
+            }
+            if (KMWAdditionalKeyNames.indexOf(FId) >= 0) {
+                return TKeyIdType.Key_Constant;
+            }
+    }
+    return TKeyIdType.Key_Invalid;
+}
+function CheckKey(platformId, FPlatform, layer, FId, FText, FNextLayer, FKeyType, FRequiredKeys, FDictionary) {
+    //
+    // Coerce missing ID and Text to empty strings for additional tests
+    //
+    FId = FId ?? '';
+    FText = FText ?? '';
+    //
+    // Check that each touch layer has K_LOPT, [K_ROPT,] K_BKSP, K_ENTER
+    //
+    for (let key of CRequiredKeys) {
+        if (TRequiredKey[key].toLowerCase() == FId.toLowerCase()) {
+            if (FRequiredKeys.indexOf(key) < 0) {
+                FRequiredKeys.push(key);
+            }
+            break;
+        }
+    }
+    //
+    // Check that each layer referenced exists
+    //
+    if (typeof FNextLayer == 'string' && FNextLayer.length > 0) {
+        if (FPlatform.layer.find(l => l.id.toLowerCase() == FNextLayer.toLowerCase()) == undefined) {
+            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutMissingLayer({
+                keyId: FId,
+                layerId: layer.id,
+                nextLayer: FNextLayer,
+                platformName: platformId
+            }));
+        }
+    }
+    //
+    // Check that the key has a valid id   // I4142
+    //
+    if (FId.trim() == '') {
+        if (!([9 /* TouchLayout.TouchLayoutKeySp.blank */, 10 /* TouchLayout.TouchLayoutKeySp.spacer */].includes(FKeyType))) {
+            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutUnidentifiedKey({ layerId: layer.id }));
+        }
+        return true;
+    }
+    let FValid = KeyIdType(FId);
+    if (FValid == TKeyIdType.Key_Invalid) {
+        callbacks.reportMessage(KmwCompilerMessages.Error_TouchLayoutInvalidIdentifier({ keyId: FId, platformName: platformId, layerId: layer.id }));
+        return false;
+    }
+    else if (FValid == TKeyIdType.Key_Unicode_Multi && !IsKeyboardVersion15OrLater()) {
+        callbacks.reportMessage(KmwCompilerMessages.Error_TouchLayoutIdentifierRequires15({ keyId: FId, platformName: platformId, layerId: layer.id }));
+        return false;
+    }
+    //
+    // Check that each custom key code has at least *a* rule associated with it
+    //
+    if (FValid == TKeyIdType.Key_Touch && FNextLayer == '' && [0 /* TouchLayout.TouchLayoutKeySp.normal */, 8 /* TouchLayout.TouchLayoutKeySp.deadkey */].includes(FKeyType)) {
+        // Search for the key in the key dictionary - ignore K_LOPT, K_ROPT...
+        if (FDictionary.indexOf(FId) < 0) {
+            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutCustomKeyNotDefined({ keyId: FId, platformName: platformId, layerId: layer.id }));
+        }
+    }
+    //
+    // Check that if the key has a *special* label, it is available in the target version
+    //
+    if (FText.startsWith('*') && FText.endsWith('*') && FText.length > 2) {
+        // Keyman versions before 14 do not support '*special*' labels on non-special keys.
+        // ZWNJ use, however, is safe because it will be transformed in function
+        // TransformSpecialKeys14 to '<|>',  which does not require the custom OSK font.
+        const mapVersion = Math.max(Math.min(fk.fileVersion, CSpecialTextMaxVer), CSpecialTextMinVer);
+        const specialText = CSpecialText.get(mapVersion);
+        if (specialText.includes(FText) &&
+            !IsKeyboardVersion14OrLater() &&
+            !([1 /* TouchLayout.TouchLayoutKeySp.special */, 2 /* TouchLayout.TouchLayoutKeySp.specialActive */].includes(FKeyType))) {
+            callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutSpecialLabelOnNormalKey({
+                keyId: FId,
+                platformName: platformId,
+                layerId: layer.id,
+                label: FText
+            }));
+        }
+    }
+    return true;
+}
+function CheckDictionaryKeyValidity(fk, FDictionary) {
+    // TODO: O(eeek) performance here
+    for (let i = 0; i < FDictionary.length; i++) {
+        if (FDictionary[i] == '') {
+            continue;
+        }
+        if ([TKeyIdType.Key_Invalid, TKeyIdType.Key_Constant].includes(KeyIdType(FDictionary[i]))) {
+            for (let fgp of fk.groups) {
+                if (fgp.fUsingKeys) {
+                    for (let fkp of fgp.keys) {
+                        if (JavaScript_Key(fkp, fk.isMnemonic) == i + 256) {
+                            callbacks.reportMessage(KmwCompilerMessages.Error_InvalidKeyCode({ keyId: FDictionary[i] }));
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
+function TransformSpecialKeys14(FDebug, sLayoutFile) {
+    // Rewrite Special key labels that are only supported in Keyman 14+
+    // This code is a little ugly but effective.
+    if (!IsKeyboardVersion14OrLater()) {
+        for (let i = 0; i < CSpecialText14Map.length; i++) {
+            // Assumes the JSON output format will not change
+            if (FDebug) {
+                sLayoutFile = sLayoutFile.replaceAll('"text": "' + CSpecialText14Map[i][0] + '"', '"text": this._v>13 ? "' + CSpecialText14Map[i][0] + '" : "' + CSpecialText14Map[i][1] + '"');
+            }
+            else {
+                sLayoutFile = sLayoutFile.replaceAll('"text":"' + CSpecialText14Map[i][0] + '"', '"text":this._v>13?"' + CSpecialText14Map[i][0] + '":"' + CSpecialText14Map[i][1] + '"');
+            }
+        }
+    }
+    return sLayoutFile;
+}
+function TransformSpecialKeys17(FDebug, sLayoutFile) {
+    // Rewrite Special key labels that are only supported in Keyman 17+
+    // This code is a little ugly but effective.
+    if (!IsKeyboardVersion17OrLater()) {
+        for (let i = 0; i < CSpecialText17Map.length; i++) {
+            // Assumes the JSON output format will not change
+            if (FDebug) {
+                sLayoutFile = sLayoutFile.replaceAll('"text": "' + CSpecialText17Map[i][0] + '"', '"text": this._v>16 ? "' + CSpecialText17Map[i][0] + '" : "' + CSpecialText17Map[i][1] + '"');
+            }
+            else {
+                sLayoutFile = sLayoutFile.replaceAll('"text":"' + CSpecialText17Map[i][0] + '"', '"text":this._v>16?"' + CSpecialText17Map[i][0] + '":"' + CSpecialText17Map[i][1] + '"');
+            }
+        }
+    }
+    return sLayoutFile;
+}
+export function ValidateLayoutFile(fk, FDebug, sLayoutFile, sVKDictionary, displayMap) {
+    let FDictionary = sVKDictionary.split(/\s+/);
+    CheckDictionaryKeyValidity(fk, FDictionary); // I4142
+    let reader = new TouchLayoutFileReader();
+    let data;
+    try {
+        if (!callbacks.fs.existsSync(sLayoutFile)) {
+            callbacks.reportMessage(KmwCompilerMessages.Error_TouchLayoutFileDoesNotExist({ filename: sLayoutFile }));
+            return null;
+        }
+        data = reader.read(callbacks.loadFile(sLayoutFile));
+        if (!data) {
+            throw new Error('Unknown error reading touch layout file');
+        }
+    }
+    catch (e) {
+        callbacks.reportMessage(KmwCompilerMessages.Error_InvalidTouchLayoutFileFormat({ msg: (e ?? 'Unspecified error').toString() }));
+        return null;
+    }
+    let hasWarnedOfGestureUseDownlevel = false;
+    const warnGesturesIfNeeded = function (keyId) {
+        if (!hasWarnedOfGestureUseDownlevel && !IsKeyboardVersion17OrLater()) {
+            hasWarnedOfGestureUseDownlevel = true;
+            callbacks.reportMessage(KmwCompilerMessages.Hint_TouchLayoutUsesUnsupportedGesturesDownlevel({ keyId }));
+        }
+    };
+    let result = true;
+    let FTouchLayoutFont = ''; // I4872
+    let pid;
+    for (pid in data) {
+        let 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 (let layer of platform.layer) {
+            let FRequiredKeys = [];
+            for (let row of layer.row) {
+                for (let key of row.key) {
+                    result = CheckKey(pid, platform, layer, key.id, key.text, key.nextlayer, key.sp, FRequiredKeys, FDictionary) && result; // I4119
+                    if (key.sk) {
+                        for (let subkey of key.sk) {
+                            result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary) && result;
+                        }
+                    }
+                    let direction;
+                    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) && result;
+                        }
+                    }
+                    if (key.multitap) {
+                        for (let subkey of key.multitap) {
+                            warnGesturesIfNeeded(key.id);
+                            result = CheckKey(pid, platform, layer, subkey.id, subkey.text, subkey.nextlayer, subkey.sp, FRequiredKeys, FDictionary) && result;
+                        }
+                    }
+                }
+            }
+            if (FRequiredKeys.length != CRequiredKeys.length) {
+                callbacks.reportMessage(KmwCompilerMessages.Warn_TouchLayoutMissingRequiredKeys({
+                    layerId: layer.id,
+                    platformName: pid,
+                    missingKeys: CRequiredKeys.filter(x => !FRequiredKeys.includes(x)).join(', ')
+                }));
+            }
+        }
+    }
+    // Transform the layout keys with displayMap
+    if (displayMap) {
+        Osk.remapTouchLayout(data, displayMap);
+    }
+    // If not debugging, then this strips out formatting for a big saving in file size
+    // This also normalises any values such as Pad or Width which should be strings
+    let writer = new TouchLayoutFileWriter({ formatted: FDebug });
+    sLayoutFile = writer.compile(data);
+    sLayoutFile = TransformSpecialKeys14(FDebug, sLayoutFile);
+    sLayoutFile = TransformSpecialKeys17(FDebug, sLayoutFile);
+    return {
+        output: sLayoutFile,
+        result
+    };
+}
 //# sourceMappingURL=validate-layout-file.js.map
+//# debugId=8528f1d8-5ec7-5e50-bde3-a3c955ca5a2b