epic: LDML keyboard support 🙀

.gitignore

@@ -166,6 +166,7 @@ resources/environment.sh
 /core/VERSION.md
 
 **/node_modules/
+tsconfig.tsbuildinfo
 
 # Windows system files
 Thumbs.db
@@ -174,6 +175,13 @@ Thumbs.db
 # details
 /xcodebuild-scripts.log
 
+#
+# Code coverage tools for JS/TS - nyc and c8
+#
+.nyc_output/
+lcov-report/
+lcov.info
+
 # Linux packaging related
 /debian/
 /results/

.nycrc.json

@@ -0,0 +1,6 @@
+{
+  "check-coverage": true,
+  "temp-directory": ".nyc_output",
+  "lines": 90,
+  "reporter": "text"
+}

common/include/km_types.h

@@ -1,5 +1,7 @@
 #pragma once
 
+#include <stdint.h>
+
 /*
 #if defined(_WIN32) || defined(_WIN64)
 #define snprintf _snprintf

common/include/kmx_file.h

@@ -14,6 +14,7 @@ namespace kbp {
 namespace kmx {
 #endif
 
+#define KMX_MAX_ALLOWED_FILE_SIZE (128 * 1024 * 1024)  /* 128MB */
 /* */
 
 #define KEYMAN_LAYOUT_DEFAULT 0x000005FE
@@ -48,8 +49,10 @@ namespace kmx {
 #define VERSION_140 0x00000E00
 #define VERSION_150 0x00000F00
 
+#define VERSION_160 0x00001000
+
 #define VERSION_MIN VERSION_50
-#define VERSION_MAX VERSION_150
+#define VERSION_MAX VERSION_160
 
 //
 // Backspace types
@@ -261,6 +264,9 @@ namespace kmx {
 #define KF_LOGICALLAYOUT  0x0008
 #define KF_AUTOMATICVERSION 0x0010
 
+// 16.0: Support for LDML Keyboards in KMXPlus file format
+#define KF_KMXPLUS  0x0020
+
 #define HK_ALT      0x00010000
 #define HK_CTRL     0x00020000
 #define HK_SHIFT    0x00040000
@@ -316,7 +322,7 @@ struct COMP_KEYBOARD {
 
   KMX_DWORD dwFileVersion;  // 0004 Version of the file - Keyman 4.0 is 0x0400
 
-  KMX_DWORD dwCheckSum;     // 0008 As stored in keyboard
+  KMX_DWORD dwCheckSum;     // 0008 As stored in keyboard. DEPRECATED as of 16.0
   KMX_DWORD KeyboardID;     // 000C as stored in HKEY_LOCAL_MACHINE//system//currentcontrolset//control//keyboard layouts
   KMX_DWORD IsRegistered;   // 0010
   KMX_DWORD version;        // 0014 keyboard version
@@ -335,7 +341,20 @@ struct COMP_KEYBOARD {
 
   KMX_DWORD dpBitmapOffset; // 0038 offset of the bitmaps in the file
   KMX_DWORD dwBitmapSize;   // 003C size in bytes of the bitmaps
-  };
+};
+
+struct COMP_KEYBOARD_KMXPLUSINFO {
+  KMX_DWORD dpKMXPlus;      // 0040 offset of KMXPlus data, <sect> header is first
+  KMX_DWORD dwKMXPlusSize;  // 0044 size in bytes of entire KMXPlus data
+};
+
+/**
+ * Only valid if comp_keyboard.dwFlags&KF_KMXPLUS
+ */
+struct COMP_KEYBOARD_EX {
+  COMP_KEYBOARD             header;    // 0000 see COMP_KEYBOARD
+  COMP_KEYBOARD_KMXPLUSINFO kmxplus;   // 0040 see COMP_KEYBOARD_EXTRA
+};
 
 typedef COMP_KEYBOARD *PCOMP_KEYBOARD;
 typedef COMP_STORE *PCOMP_STORE;
@@ -359,4 +378,4 @@ static_assert(sizeof(COMP_KEYBOARD) == KEYBOARDFILEHEADER_SIZE, "COMP_KEYBOARD m
 } // namespace kmx
 } // namespace kbp
 } // namespace km
-#endif
+#endif

common/schemas/keyman-touch-layout/keyman-touch-layout.clean.spec.json

@@ -86,7 +86,7 @@
         "layer": { "$ref": "#/definitions/layer-id" },
         "nextlayer": { "$ref": "#/definitions/layer-id" },
         "font": { "$ref": "#/definitions/font-spec" },
-        "fontsize": { "type": "string" },
+        "fontsize": { "$ref": "#/definitions/fontsize-spec" },
         "sp": { "$ref": "#/definitions/key-sp" },
         "pad": { "$ref" : "#/definitions/key-pad" },
         "width": { "$ref" : "#/definitions/key-width" },
@@ -141,7 +141,7 @@
         "layer": { "$ref": "#/definitions/layer-id" },
         "nextlayer": { "$ref": "#/definitions/layer-id" },
         "font": { "$ref": "#/definitions/font-spec" },
-        "fontsize": { "type": "string" },
+        "fontsize": { "$ref": "#/definitions/fontsize-spec" },
         "sp": { "$ref": "#/definitions/key-sp" },
         "pad": { "$ref" : "#/definitions/key-pad" },
         "width": { "$ref" : "#/definitions/key-width" }

common/schemas/keyman-touch-layout/keyman-touch-layout.spec.json

@@ -88,7 +88,7 @@
         "text": { "type": "string" },
         "layer": { "$ref": "#/definitions/layer-id" },
         "nextlayer": { "$ref": "#/definitions/layer-id" },
-        "fontsize": { "type": "string" },
+        "fontsize": { "$ref": "#/definitions/fontsize-spec" },
         "font": { "$ref": "#/definitions/font-spec" },
         "dk": { "type": "string" },
         "sp": { "$ref" : "#/definitions/numeric" },
@@ -129,7 +129,7 @@
         "sp": { "$ref" : "#/definitions/numeric" },
         "pad": { "$ref" : "#/definitions/numeric" },
         "width": { "$ref" : "#/definitions/numeric" },
-        "fontsize": { "type": "string" },
+        "fontsize": { "$ref": "#/definitions/fontsize-spec" },
         "font": { "$ref": "#/definitions/font-spec" },
         "dk": { "type": "string" }
       },

common/schemas/kpj/README.md

@@ -0,0 +1,13 @@
+# kpj.xsd
+
+**Note:** `KeymanDeveloperProject.Options.Version` is currently implicitly
+always '1.0'. It will be required for version 2.0 and later of the format.
+
+## 2023-02-27 2.0
+* Version 2.0 makes 'Files' optional (internally, Files/File will be ignored,
+  deleted on load and populated from folder structure). Adds Options/SourcePath,
+  which defaults to '$PROJECTPATH/source', and Options/BuildPath now defaults to
+  '$PROJECTPATH/build'.
+
+## 2023-02-25 1.0
+* Initial version 1.0, based on Delphi classes Keyman.Developer.System.Project.*

common/schemas/kpj/kpj.schema.json

@@ -0,0 +1,127 @@
+{
+  "title": "kpj.xsd",
+  "$schema": "http://json-schema.org/schema#",
+  "type": "object",
+  "properties": {
+    "KeymanDeveloperProject": {
+      "properties": {
+        "Options": {
+          "$ref": "#/definitions/Options"
+        },
+        "Files": {
+          "$ref": "#/definitions/Files"
+        }
+      },
+      "required": [
+        "Options"
+      ],
+      "additionalProperties": false,
+      "type": "object"
+    }
+  },
+  "required": [
+    "KeymanDeveloperProject"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "Options": {
+      "type": "object",
+      "properties": {
+        "BuildPath": {
+          "type": "string"
+        },
+        "SourcePath": {
+          "type": "string"
+        },
+        "CompilerWarningsAsErrors": {
+          "type": "string",
+          "pattern": "^(True|False)$"
+        },
+        "WarnDeprecatedCode": {
+          "type": "string",
+          "pattern": "^(True|False)$"
+        },
+        "CheckFilenameConventions": {
+          "type": "string",
+          "pattern": "^(True|False)$"
+        },
+        "ProjectType": {
+          "type": "string",
+          "pattern": "^(keyboard|lexicalmodel)$"
+        },
+        "Version": {
+          "type": "string",
+          "pattern": "^(1\\.0|2\\.0)$"
+        }
+      },
+      "required": [
+      ],
+      "additionalProperties": false
+    },
+    "Files": {
+      "type": "object",
+      "properties": {
+        "File": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/File"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "File"
+      ]
+    },
+    "File": {
+      "type": "object",
+      "properties": {
+        "ID": {
+          "type": "string"
+        },
+        "Filename": {
+          "type": "string"
+        },
+        "Filepath": {
+          "type": "string"
+        },
+        "FileVersion": {
+          "type": "string"
+        },
+        "FileType": {
+          "type": "string"
+        },
+        "Details": {
+          "$ref": "#/definitions/FileDetails"
+        },
+        "ParentFileID": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "Filename"
+      ],
+      "additionalProperties": false
+    },
+    "FileDetails": {
+      "type": "object",
+      "properties": {
+        "Name": {
+          "type": "string"
+        },
+        "Copyright": {
+          "type": "string"
+        },
+        "Message": {
+          "type": "string"
+        },
+        "Version": {
+          "type": "string"
+        }
+      },
+      "required": [
+      ],
+      "additionalProperties": false
+    }
+  }
+}