document.getElementById("txtFeedback");
- txtFeedback.value = counter + " click(s)";
-}
diff --git a/common/predictive-text/testing/one-stage-embedded-webworker/tsconfig.json b/common/predictive-text/testing/one-stage-embedded-webworker/tsconfig.json
deleted file mode 100644
index f1e9be86003..00000000000
--- a/common/predictive-text/testing/one-stage-embedded-webworker/tsconfig.json
+++ /dev/null
@@ -1,13 +0,0 @@
-{
- "compilerOptions": {
- "allowJs": false,
- "module": "none",
- "outDir": "./",
- "inlineSources": true,
- "sourceMap": true,
- "target": "es5"
- },
- "files" : [
- "main.ts"
- ]
-}
diff --git a/common/predictive-text/testing/post-blob-webworker/canaryWorker.js b/common/predictive-text/testing/post-blob-webworker/canaryWorker.js
deleted file mode 100644
index 5c69deace8e..00000000000
--- a/common/predictive-text/testing/post-blob-webworker/canaryWorker.js
+++ /dev/null
@@ -1,5 +0,0 @@
-// receive a message and execute its uri
-onmessage = function (e) {
- let uri = e.data.uri;
- importScripts(uri);
-};
diff --git a/common/predictive-text/testing/post-blob-webworker/index.html b/common/predictive-text/testing/post-blob-webworker/index.html
deleted file mode 100644
index a04b6be377b..00000000000
--- a/common/predictive-text/testing/post-blob-webworker/index.html
+++ /dev/null
@@ -1,72 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Blob URI test
-
-
-
-
-
-
-
-
-
- LM Layer Testing - Sending a function to a WebWorker via a Blob URI test
- This page sends a function over to the Worker via a Blob URI, and
- expects the function to reply back.
-
-
-
-
-
-
-
-
diff --git a/common/predictive-text/testing/simple-webworker/canaryWorker.js b/common/predictive-text/testing/simple-webworker/canaryWorker.js
deleted file mode 100644
index cf8674d3304..00000000000
--- a/common/predictive-text/testing/simple-webworker/canaryWorker.js
+++ /dev/null
@@ -1,9 +0,0 @@
-var counter = 0;
-
-onmessage = function(e) {
- counter++;
-
- console.log("Message received from main page: ", e.data);
-
- postMessage(counter);
-}
\ No newline at end of file
diff --git a/common/predictive-text/testing/simple-webworker/index.html b/common/predictive-text/testing/simple-webworker/index.html
deleted file mode 100644
index adbcd30d3e6..00000000000
--- a/common/predictive-text/testing/simple-webworker/index.html
+++ /dev/null
@@ -1,55 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Basic WebWorker test
-
-
-
-
-
-
-
-
-
- LM Layer Testing - basic WebWorker canary
- This page uses a simple WebWorker useful for ensuring functionality on various platforms.
-
-
-
-
-
-
-
diff --git a/common/predictive-text/testing/two-stage-embedded-webworker/.gitignore b/common/predictive-text/testing/two-stage-embedded-webworker/.gitignore
deleted file mode 100644
index 20efd1ec834..00000000000
--- a/common/predictive-text/testing/two-stage-embedded-webworker/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-**/*.js
-**/*.js.map
\ No newline at end of file
diff --git a/common/predictive-text/testing/two-stage-embedded-webworker/build.sh b/common/predictive-text/testing/two-stage-embedded-webworker/build.sh
deleted file mode 100755
index dd1854ec00b..00000000000
--- a/common/predictive-text/testing/two-stage-embedded-webworker/build.sh
+++ /dev/null
@@ -1,68 +0,0 @@
-#!/usr/bin/env bash
-#
-# Compiles the Language Modeling Layer for common use in predictive text and autocorrective applications.
-# Designed for optimal compatibility with the Keyman Suite.
-#
-
-## START STANDARD BUILD SCRIPT INCLUDE
-# adjust relative paths as necessary
-THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
-. "${THIS_SCRIPT%/*}/../../../../resources/build/build-utils.sh"
-. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
-## END STANDARD BUILD SCRIPT INCLUDE
-
-display_usage ( ) {
- echo "build.sh [-clean]"
- echo
- echo " -clean to erase pre-existing build products before a re-build"
-}
-
-SOURCE="testing/two-stage-embedded-webworker"
-
-COMPILED_WORKER="worker.js"
-EMBEDDED_WORKER="embedded_worker.js"
-
-echo "Node.js + dependencies check"
-npm install --no-optional
-
-if [ $? -ne 0 ]; then
- builder_die "Build environment setup error detected! Please ensure Node.js is installed!"
-fi
-
-# A nice, extensible method for -clean operations. Add to this as necessary.
-clean ( ) {
- rm -rf "./*.js"
- if [ $? -ne 0 ]; then
- builder_die "Failed to erase the prior build."
- fi
-}
-
-# Process command-line arguments
-while [[ $# -gt 0 ]] ; do
- key="$1"
- case $key in
- -clean)
- clean
- ;;
- esac
- shift # past the processed argument
-done
-
-npm run tsc -- -p $SOURCE/worker/tsconfig.json
-if [ $? -ne 0 ]; then
- builder_die "Worker compilation failed."
-fi
-
-rm $EMBEDDED_WORKER &> /dev/null
-
-echo "var LMLayerWorker = function() {" >> $EMBEDDED_WORKER
-cat $COMPILED_WORKER >> $EMBEDDED_WORKER
-echo "" >> $EMBEDDED_WORKER
-echo "}" >> $EMBEDDED_WORKER
-
-npm run tsc -- -p $SOURCE/tsconfig.json
-if [ $? -ne 0 ]; then
- builder_die "Final compilation failed."
-fi
-
-echo "Typescript compilation successful."
\ No newline at end of file
diff --git a/common/predictive-text/testing/two-stage-embedded-webworker/index.html b/common/predictive-text/testing/two-stage-embedded-webworker/index.html
deleted file mode 100644
index 244f4aa2833..00000000000
--- a/common/predictive-text/testing/two-stage-embedded-webworker/index.html
+++ /dev/null
@@ -1,42 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Embedded WebWorker test
-
-
-
-
-
-
-
-
-
- LM Layer Testing - One-Stage Embedded WebWorkers
- This page serves as a prototype for embedding a WebWorker's code within its "master" script
- across the TypeScript transpilation boundary.
-
-
-
-
-
-
-
diff --git a/common/predictive-text/testing/two-stage-embedded-webworker/main.ts b/common/predictive-text/testing/two-stage-embedded-webworker/main.ts
deleted file mode 100644
index 9eb276d3794..00000000000
--- a/common/predictive-text/testing/two-stage-embedded-webworker/main.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-// Provides the final source for our compiled WebWorker within a wrapping function.
-///
-
-function createWorker(fn: Function): Worker {
- var str_fn = fn.toString();
-
- // We now unwrap our WebWorker from its function.
- var str_lines = str_fn.split("\n");
- var blob_lines = []
-
- for(var i=1; i < str_lines.length -1; i++) {
- blob_lines.push(str_lines[i] + "\n");
- }
- // Unwrapping complete.
-
- var blob = new Blob(blob_lines, { type: 'text/javascript' });
- let url = URL.createObjectURL(blob);
-
- return new Worker(url);
-}
-
-var canaryWorker = createWorker(LMLayerWorker);
-
-canaryWorker.onmessage = function(e) {
- var counter = e.data; // Number of times the WebWorker has been messaged.
- console.log("Received message from the WebWorker: " + e.data);
-
- var txtFeedback = document.getElementById("txtFeedback");
- txtFeedback.value = counter + " click(s)";
-}
diff --git a/common/predictive-text/testing/two-stage-embedded-webworker/tsconfig.json b/common/predictive-text/testing/two-stage-embedded-webworker/tsconfig.json
deleted file mode 100644
index a25930a70e6..00000000000
--- a/common/predictive-text/testing/two-stage-embedded-webworker/tsconfig.json
+++ /dev/null
@@ -1,13 +0,0 @@
-{
- "compilerOptions": {
- "allowJs": true,
- "module": "none",
- "outFile": "./main.js",
- "inlineSources": true,
- "inlineSourceMap": true,
- "target": "es5"
- },
- "files" : [
- "main.ts"
- ]
-}
diff --git a/common/predictive-text/testing/two-stage-embedded-webworker/worker/canaryWorker.ts b/common/predictive-text/testing/two-stage-embedded-webworker/worker/canaryWorker.ts
deleted file mode 100644
index cf8674d3304..00000000000
--- a/common/predictive-text/testing/two-stage-embedded-webworker/worker/canaryWorker.ts
+++ /dev/null
@@ -1,9 +0,0 @@
-var counter = 0;
-
-onmessage = function(e) {
- counter++;
-
- console.log("Message received from main page: ", e.data);
-
- postMessage(counter);
-}
\ No newline at end of file
diff --git a/common/predictive-text/testing/two-stage-embedded-webworker/worker/tsconfig.json b/common/predictive-text/testing/two-stage-embedded-webworker/worker/tsconfig.json
deleted file mode 100644
index ca8006ba440..00000000000
--- a/common/predictive-text/testing/two-stage-embedded-webworker/worker/tsconfig.json
+++ /dev/null
@@ -1,11 +0,0 @@
-{
- "compilerOptions": {
- "allowJs": false,
- "module": "none",
- "outFile": "../worker.js",
- "inlineSources": true,
- "sourceMap": true,
- "lib": ["webworker", "es6"],
- "target": "es5"
- }
-}
diff --git a/common/schemas/keyboard_info/README.md b/common/schemas/keyboard_info/README.md
index 3222a465a8c..f41457f93e5 100644
--- a/common/schemas/keyboard_info/README.md
+++ b/common/schemas/keyboard_info/README.md
@@ -1,18 +1,31 @@
# keyboard_info
-* **keyboard_info.source.json**
-* **keyboard_info.distribution.json**
+* **keyboard_info.schema.json**
Documentation at https://help.keyman.com/developer/cloud/keyboard_info
* Primary version:
- * https://github.com/keymanapp/api.keyman.com/tree/master/schemas/keyboard_info.source
- * https://github.com/keymanapp/api.keyman.com/tree/master/schemas/keyboard_info.distribution
+ * https://github.com/keymanapp/api.keyman.com/tree/master/schemas/keyboard_info
* Synchronized copies at:
* https://github.com/keymanapp/keyman/tree/master/common/schemas/keyboard_info
# .keyboard_info version history
+## 2023-08-11 2.0 stable
+* Removed:
+ - `.documentationFilename`
+ - `.documentationFileSize`
+ - `.legacyId`
+ `.links`
+ `.related[].note`
+ `.languages[].example`
+ Added:
+ - `.languages[].examples[]`
+ Modified:
+ - `.languages[].font`, `.languages[].oskFont`: `.source` is `[string]`
+ - Source .keyboard_info files are no longer needed, so source vs distribution
+ keyboard_info distinction is removed
+
## 2019-09-06 1.0.6 stable
* No changes (see api.keyman.com#36 and api.keyman.com#59. Reverted in 2020-06-10.).
diff --git a/common/schemas/keyboard_info/keyboard_info.distribution.json b/common/schemas/keyboard_info/keyboard_info.distribution.json
deleted file mode 100644
index 3d3d4ee0c86..00000000000
--- a/common/schemas/keyboard_info/keyboard_info.distribution.json
+++ /dev/null
@@ -1,8 +0,0 @@
-{
- "$schema": "http://json-schema.org/draft-04/schema#",
- "type": "object",
- "allOf": [
- { "$ref": "/keyboard_info.source.json#/definitions/KeyboardInfo" },
- { "required": [ "id", "name", "license", "languages", "lastModifiedDate", "platformSupport" ] }
- ]
-}
diff --git a/common/schemas/keyboard_info/keyboard_info.schema.json b/common/schemas/keyboard_info/keyboard_info.schema.json
new file mode 100644
index 00000000000..75d8e0329e8
--- /dev/null
+++ b/common/schemas/keyboard_info/keyboard_info.schema.json
@@ -0,0 +1,105 @@
+{
+ "$schema": "http://json-schema.org/schema#",
+ "$ref": "#/definitions/KeyboardInfo",
+
+ "definitions": {
+ "KeyboardInfo": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "name": { "type": "string" },
+ "authorName": { "type": "string" },
+ "authorEmail": { "type": "string", "format": "email" },
+ "description": { "type": "string" },
+ "license": { "type": "string", "enum": ["freeware", "shareware", "commercial", "mit", "other"] },
+ "languages": { "anyOf": [
+ { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
+ { "$ref": "#/definitions/KeyboardLanguageInfo" }
+ ]},
+ "lastModifiedDate": { "type": "string", "format": "date-time" },
+ "packageFilename": { "type": "string", "pattern": "\\.km[xp]$" },
+ "packageFileSize": { "type": "number" },
+ "jsFilename": { "type": "string", "pattern": "\\.js$" },
+ "jsFileSize": { "type": "number" },
+ "isRTL": { "type": "boolean" },
+ "encodings": { "type": "array", "items": { "type": "string", "enum": ["ansi", "unicode"] } },
+ "packageIncludes": { "type": "array", "items": { "type": "string", "enum": ["welcome", "documentation", "fonts", "visualKeyboard"] } },
+ "version": { "type": "string" },
+ "minKeymanVersion": { "type": "string", "pattern": "^\\d+\\.\\d$" },
+ "helpLink": { "type": "string", "pattern": "^https://help\\.keyman\\.com/keyboard/" },
+ "platformSupport": { "$ref": "#/definitions/KeyboardPlatformInfo" },
+ "sourcePath": { "type": "string", "pattern": "^(release|legacy|experimental)/.+/.+$" },
+ "related": { "type": "object", "patternProperties": {
+ ".": { "$ref": "#/definitions/KeyboardRelatedInfo" }
+ },
+ "additionalProperties": false
+ },
+ "deprecated": { "type": "boolean" }
+ },
+ "required": [ "id", "name", "license", "languages", "lastModifiedDate", "platformSupport" ]
+ },
+
+ "KeyboardLanguageInfo": {
+ "type": "object",
+ "patternProperties": {
+ ".": { "$ref": "#/definitions/KeyboardLanguageInfoItem" }
+ },
+ "additionalProperties": false
+ },
+
+ "KeyboardLanguageInfoItem": {
+ "type": "object",
+ "properties": {
+ "font": { "$ref": "#/definitions/KeyboardFontInfo" },
+ "oskFont": { "$ref": "#/definitions/KeyboardFontInfo" },
+ "examples": { "type": "array", "items": { "$ref": "#/definitions/KeyboardExampleInfo" } },
+ "displayName": { "type": "string" },
+ "languageName": { "type": "string" },
+ "scriptName": { "type": "string" },
+ "regionName": { "type": "string" }
+ },
+ "required": [],
+ "additionalProperties": false
+ },
+
+ "KeyboardFontInfo": {
+ "type": "object",
+ "properties": {
+ "family": { "type": "string" },
+ "source": { "type": "array", "items": { "type": "string" } }
+ },
+ "required": ["family", "source"],
+ "additionalProperties": false
+ },
+
+ "KeyboardExampleInfo": {
+ "type": "object",
+ "properties": {
+ "keys": { "type": "string" },
+ "text": { "type": "string" },
+ "note": { "type": "string" }
+ },
+ "required": ["keys", "text"],
+ "additionalProperties": false
+ },
+
+ "KeyboardPlatformInfo": {
+ "type": "object",
+ "patternProperties": {
+ "^(windows|macos|desktopWeb|ios|android|mobileWeb|linux)$": { "type": "string", "enum": ["dictionary", "full", "basic", "none"] }
+ },
+ "required": [],
+ "additionalProperties": false
+ },
+
+ "KeyboardRelatedInfo": {
+ "type": "object",
+ "properties": {
+ "deprecates": { "type": "boolean" },
+ "deprecatedBy": { "type": "boolean" }
+ },
+ "required": [],
+ "additionalProperties": false
+ }
+ }
+}
\ No newline at end of file
diff --git a/common/schemas/keyboard_info/keyboard_info.source.json b/common/schemas/keyboard_info/keyboard_info.source.json
deleted file mode 100644
index ac2687701ff..00000000000
--- a/common/schemas/keyboard_info/keyboard_info.source.json
+++ /dev/null
@@ -1,173 +0,0 @@
-{
- "$schema": "http://json-schema.org/schema#",
- "$ref": "#/definitions/KeyboardInfo",
-
- "definitions": {
- "KeyboardInfo": {
- "type": "object",
- "properties": {
- "id": { "type": "string" },
- "name": { "type": "string" },
- "authorName": { "type": "string" },
- "authorEmail": { "type": "string", "format": "email" },
- "description": { "type": "string" },
- "license": { "type": "string", "enum": ["freeware", "shareware", "commercial", "mit", "other"] },
- "languages": { "anyOf": [
- { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
- { "$ref": "#/definitions/KeyboardLanguageInfo" }
- ]},
- "lastModifiedDate": { "type": "string", "format": "date-time" },
- "links": { "type": "array", "items": { "$ref": "#/definitions/KeyboardLinkInfo" } },
- "packageFilename": { "type": "string", "pattern": "\\.km[xp]$" },
- "packageFileSize": { "type": "number" },
- "jsFilename": { "type": "string", "pattern": "\\.js$" },
- "jsFileSize": { "type": "number" },
- "documentationFilename": { "type": "string", "pattern": "\\.(rtf|html?|pdf|txt)$" },
- "documentationFileSize": { "type": "number" },
- "isRTL": { "type": "boolean" },
- "encodings": { "type": "array", "items": { "type": "string", "enum": ["ansi", "unicode"] }, "additionalItems": false },
- "packageIncludes": { "type": "array", "items": { "type": "string", "enum": ["welcome", "documentation", "fonts", "visualKeyboard"] }, "additionalItems": false },
- "version": { "type": "string" },
- "minKeymanVersion": { "type": "string", "pattern": "^\\d+\\.\\d$" },
- "helpLink": { "type": "string", "pattern": "^https://help\\.keyman\\.com/keyboard/" },
- "platformSupport": { "$ref": "#/definitions/KeyboardPlatformInfo" },
- "legacyId": { "type": "number" },
- "sourcePath": { "type": "string", "pattern": "^(release|legacy|experimental)/.+/.+$" },
- "related": { "type": "object", "patternProperties": {
- ".": { "$ref": "#/definitions/KeyboardRelatedInfo" }
- },
- "additionalProperties": false
- },
- "deprecated": { "type": "boolean" }
- },
- "required": [
- "license", "languages"
- ]
- },
-
- "KeyboardLanguageInfo": {
- "type": "object",
- "patternProperties": {
- ".": { "$ref": "#/definitions/KeyboardLanguageInfoItem" }
- },
- "additionalProperties": false
- },
-
- "KeyboardLanguageInfoItem": {
- "type": "object",
- "properties": {
- "font": { "$ref": "#/definitions/KeyboardFontInfo" },
- "oskFont": { "$ref": "#/definitions/KeyboardFontInfo" },
- "example": { "$ref": "#/definitions/KeyboardExampleInfo" },
- "displayName": { "type": "string" },
- "languageName": { "type": "string" },
- "scriptName": { "type": "string" },
- "regionName": { "type": "string" }
- },
- "required": [],
- "additionalProperties": false
- },
-
- "KeyboardFontInfo": {
- "type": "object",
- "properties": {
- "family": { "type": "string" },
- "source": { "anyOf": [
- { "type": "string" },
- { "type": "array", "items": { "type": "string" } }
- ] },
- "size": { "type": "string" }
- },
- "required": ["family", "source"],
- "additionalProperties": false
- },
-
- "KeyboardExampleInfo": {
- "type": "object",
- "properties": {
- "keys": { "anyOf": [
- { "type": "string" },
- { "type": "array", "items": {
- "anyOf": [
- { "type": "string" },
- { "$ref": "#/definitions/KeyboardExampleKeyInfo" }
- ] }
- }
- ] },
- "text": { "type": "string" },
- "note": { "type": "string" }
- },
- "required": [],
- "additionalProperties": false
- },
-
- "KeyboardExampleKeyInfo": {
- "type": "object",
- "properties": {
- "key": { "type": "string", "enum": [
- "K_SPACE",
- "K_A", "K_B", "K_C", "K_D", "K_E", "K_F", "K_G", "K_H", "K_I", "K_J", "K_K", "K_L", "K_M",
- "K_N", "K_O", "K_P", "K_Q", "K_R", "K_S", "K_T", "K_U", "K_V", "K_W", "K_X", "K_Y", "K_Z",
- "K_1", "K_2", "K_3", "K_4", "K_5", "K_6", "K_7", "K_8", "K_9", "K_0",
- "K_BKQUOTE", "K_HYPHEN", "K_EQUAL", "K_LBRKT", "K_RBRKT", "K_BKSLASH", "K_COLON",
- "K_QUOTE", "K_COMMA", "K_PERIOD", "K_SLASH",
- "K_oE2", "K_BKSP", "K_TAB", "K_ENTER", "K_ESC",
- "K_LEFT", "K_UP", "K_RIGHT", "K_DOWN", "K_PGUP", "K_PGDN", "K_HOME", "K_END", "K_INS", "K_DEL",
- "K_F1", "K_F2", "K_F3", "K_F4", "K_F5", "K_F6", "K_F7", "K_F8", "K_F9", "K_F10", "K_F11", "K_F12",
- "K_KP5", "K_NP0", "K_NP1", "K_NP2", "K_NP3", "K_NP4", "K_NP5", "K_NP6", "K_NP7", "K_NP8", "K_NP9",
- "K_NPSTAR", "K_NPPLUS", "K_NPMINUS", "K_NPDOT", "K_NPSLASH",
- "K_SEL", "K_PRINT", "K_EXEC", "K_HELP", "K_SEPARATOR",
- "K_F13", "K_F14", "K_F15", "K_F16", "K_F17", "K_F18", "K_F19", "K_F20", "K_F21", "K_F22", "K_F23", "K_F24",
- "K_KANJI?15", "K_KANJI?16", "K_KANJI?17", "K_KANJI?18", "K_KANJI?19", "K_KANJI?1C", "K_KANJI?1D", "K_KANJI?1E", "K_KANJI?1F",
- "K_oE0", "K_oE1", "K_oE3", "K_oE4", "K_oE6", "K_oE9", "K_oEA", "K_oEB", "K_oEC", "K_oED", "K_oEE", "K_oEF",
- "K_oF0", "K_oF1", "K_oF2", "K_oF3", "K_oF4", "K_oF5", "K_?00", "K_?05", "K_NPENTER",
- "K_?06", "K_?07", "K_?0A", "K_?0B", "K_?0E", "K_?0F", "K_?1A", "K_?3A", "K_?3B", "K_?3C", "K_?3D", "K_?3E",
- "K_?3F", "K_?40", "K_?5B", "K_?5C", "K_?5D", "K_?5E", "K_?5F", "K_?88", "K_?89", "K_?8A", "K_?8B", "K_?8C",
- "K_?8D", "K_?8E", "K_?8F", "K_?92", "K_?94", "K_?95", "K_?96", "K_?97", "K_?98", "K_?99", "K_?9A", "K_?9B",
- "K_?9C", "K_?9D", "K_?9E", "K_?9F", "K_?A0", "K_?A1", "K_?A2", "K_?A3", "K_?A4", "K_?A5", "K_?A6", "K_?A7",
- "K_?A8", "K_?A9", "K_?AA", "K_?AB", "K_?AC", "K_?AD", "K_?AE", "K_?AF", "K_?B0", "K_?B1", "K_?B2", "K_?B3",
- "K_?B4", "K_?B5", "K_?B6", "K_?B7", "K_?B8", "K_?B9", "K_?C1", "K_?C2", "K_?C3", "K_?C4", "K_?C5", "K_?C6",
- "K_?C7", "K_?C8", "K_?C9", "K_?CA", "K_?CB", "K_?CC", "K_?CD", "K_?CE", "K_?CF", "K_?D0", "K_?D1", "K_?D2",
- "K_?D3", "K_?D4", "K_?D5", "K_?D6", "K_?D7", "K_?D8", "K_?D9", "K_?DA", "K_oDF", "K_?E5", "K_?E7", "K_?E8",
- "K_?F6", "K_?F7", "K_?F8", "K_?F9", "K_?FA", "K_?FB", "K_?FC", "K_?FD", "K_?FE", "K_?FF"
- ] },
- "modifiers": {
- "type": "array",
- "items": { "type": "string", "enum": ["shift", "s", "ctrl", "c", "alt", "a", "left-ctrl", "lc", "right-ctrl", "rc", "left-alt", "la", "right-alt", "ra"] }
- }
- },
- "required": ["key"],
- "additionalProperties": false
- },
-
- "KeyboardLinkInfo": {
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "url": { "type": "string" }
- },
- "required": ["name", "url"],
- "additionalProperties": false
- },
-
- "KeyboardPlatformInfo": {
- "type": "object",
- "patternProperties": {
- "^(windows|macos|desktopWeb|ios|android|mobileWeb|linux)$": { "type": "string", "enum": ["dictionary", "full", "basic", "none"] }
- },
- "required": [],
- "additionalProperties": false
- },
-
- "KeyboardRelatedInfo": {
- "type": "object",
- "properties": {
- "deprecates": { "type": "boolean" },
- "deprecatedBy": { "type": "boolean" },
- "note": { "type": "string" }
- },
- "required": [],
- "additionalProperties": false
- }
- }
-}
\ No newline at end of file
diff --git a/common/schemas/kpj/README.md b/common/schemas/kpj/README.md
index 0f8e55de60d..bfca5c5bdc0 100644
--- a/common/schemas/kpj/README.md
+++ b/common/schemas/kpj/README.md
@@ -6,6 +6,9 @@ always '1.0'. It will be required for version 2.0 and later of the format.
**Note:** An additional schema file, kpj-9.0.schema.json, for supporting legacy
versions of .kpj, from Keyman Developer 9.0 and earlier, is now available.
+## 2023-08-07 2.0.1
+* Add Options/SkipMetadataFiles, defaults to True for 1.0 projects.
+
## 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,
diff --git a/common/schemas/kpj/kpj.schema.json b/common/schemas/kpj/kpj.schema.json
index 77721345f28..8a59fa40c54 100644
--- a/common/schemas/kpj/kpj.schema.json
+++ b/common/schemas/kpj/kpj.schema.json
@@ -45,6 +45,10 @@
"type": "string",
"pattern": "^(True|False)$"
},
+ "SkipMetadataFiles": {
+ "type": "string",
+ "pattern": "^(True|False)$"
+ },
"ProjectType": {
"type": "string",
"pattern": "^(keyboard|lexicalmodel)$"
diff --git a/common/schemas/kps/kps.xsd b/common/schemas/kps/kps.xsd
index e6ee424e28d..292f0c8fc6a 100644
--- a/common/schemas/kps/kps.xsd
+++ b/common/schemas/kps/kps.xsd
@@ -31,6 +31,8 @@
+
+
@@ -74,6 +76,7 @@
+
@@ -96,6 +99,19 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -110,6 +126,9 @@
+
+
+
@@ -135,6 +154,7 @@
+
@@ -149,8 +169,6 @@
-
-
@@ -189,6 +207,12 @@
+
+
+
+
+
+
@@ -209,4 +233,27 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/common/test/keyboards/baseline/k_017___space_mnemonic_kbd.kmn b/common/test/keyboards/baseline/k_017___space_mnemonic_kbd.kmn
index a66fac420a9..07e37ee681b 100644
--- a/common/test/keyboards/baseline/k_017___space_mnemonic_kbd.kmn
+++ b/common/test/keyboards/baseline/k_017___space_mnemonic_kbd.kmn
@@ -4,8 +4,7 @@ c keys: [K_A][K_B][K_SPACE][K_C][K_SPACE][K_D][K_SPACE][K_D][K_E]
c expected: XYZ
store(&VERSION) '9.0'
-NAME "Alt key tests"
-HOTKEY "[CTRL SHIFT K_A]"
+store(&HOTKEY) "[CTRL SHIFT K_A]"
store(&mnemoniclayout) "1"
begin Unicode > use(main)
diff --git a/common/test/keyboards/baseline/k_018___nul_testing.kmn b/common/test/keyboards/baseline/k_018___nul_testing.kmn
index bc6e41206d5..20da4d4af70 100644
--- a/common/test/keyboards/baseline/k_018___nul_testing.kmn
+++ b/common/test/keyboards/baseline/k_018___nul_testing.kmn
@@ -3,11 +3,10 @@ c Description: Tests the processing of nul in LHS of rules
c keys: [K_A][K_A]
c expected: OKa
-VERSION 9.0
-NAME "Nul test"
-HOTKEY "[CTRL SHIFT K_N]"
+store(&VERSION) "9.0"
+store(&HOTKEY) "[CTRL SHIFT K_N]"
-begin unicode > use(main)
+begin unicode > use(main)
group(Main) using keys
nul + 'a' > 'OK'
diff --git a/common/test/keyboards/build.sh b/common/test/keyboards/build.sh
index 43562ffb13a..af6a9702d5f 100755
--- a/common/test/keyboards/build.sh
+++ b/common/test/keyboards/build.sh
@@ -1,225 +1,43 @@
#!/usr/bin/env bash
-
-set -e
-set -u
-
## START STANDARD BUILD SCRIPT INCLUDE
# adjust relative paths as necessary
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
. "${THIS_SCRIPT%/*}/../../../resources/build/build-utils.sh"
-. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
## END STANDARD BUILD SCRIPT INCLUDE
-THIS_DIR="$(dirname "$THIS_SCRIPT")"
-
-display_usage() {
- echo "usage: build.sh [build options] [targets]"
- echo
- echo "Build options:"
- echo " --clean, -c Clean instead of build"
- echo " --debug, -d Debug build"
- echo " --silent, -s Suppress information messages"
- echo " --keyboard, -k Build only keyboards (not packages)"
- echo " --kmcomp path Specify path to kmcomp.exe, defaults"
- echo " to windows/bin/developer/kmcomp.exe"
- echo " --zip-source Create zip file for source of each"
- echo " keyboard for artifact tests"
- echo " --index Build index.html for artifact tests"
- echo
- echo "Targets (all unless specified):"
-
- for d in "$THIS_DIR/"*/; do
- d="$(basename "$d")"
- if [ "$d" != "invalid" ]; then
- echo " $d"
- fi
- done
- echo
- exit 0
-}
+cd "$THIS_SCRIPT_PATH"
-QUIET=false
-DEBUG=false
-CLEAN=false
-KEYBOARDS_ONLY=false
-CUSTOM_KMCOMP=
-INDEX=false
-ZIPSOURCE=false
-KMCOMP="$KEYMAN_ROOT/developer/bin/kmcomp.exe"
-TARGETS=()
-
-# Parse args
-shopt -s nocasematch
-
-while [[ $# -gt 0 ]] ; do
- key="$1"
- case $key in
- --help|-h|-\?)
- display_usage
- ;;
- --clean|-c)
- CLEAN=true
- ;;
- --debug|-d)
- DEBUG=true
- ;;
- --silent|-s)
- QUIET=true
- ;;
- --keyboard|-k)
- KEYBOARDS_ONLY=true
- ;;
- --zip-source)
- ZIPSOURCE=true
- ;;
- --index)
- INDEX=true
- ;;
- --kmcomp)
- shift
- KMCOMP="$1"
- CUSTOM_KMCOMP=true
- ;;
- *)
- TARGETS+=("$key")
- esac
- shift
+targets=()
+# Build list of available targets from subfolders, if none specified
+for d in */; do
+ d="$(basename "$d")"
+ if [ "$d" != "invalid" ] && [ "$d" != "issue" ]; then
+ targets+=(":$d")
+ fi
done
-# TODO: while this is intended to be cross platform, we
-# don't currently have a binary version of kmcomp available
-# during Linux and macOS builds, so that will need to be
-# manually sourced.
-KMCOMP_LAUNCHER=
-
-if ! $CUSTOM_KMCOMP; then
- case "${OSTYPE}" in
- "cygwin")
- ;;
- "msys")
- ;;
- "darwin"*)
- # For Catalina (10.15) onwards, must use wine64
- base_macos_ver=10.15
- macos_ver=$(sw_vers -productVersion)
- if verlt "$macos_ver" "$base_macos_ver"; then
- KMCOMP_LAUNCHER=wine
- else
- # On Catalina, and later versions:
- # wine-4.12.1 works; wine-5.0, wine-5.7 do not.
- # retrieve these from:
- # `brew tap gcenx/wine && brew install --cask --no-quarantine wine-crossover`
- # may also need to `sudo spctl --master-disable`
- KMCOMP_LAUNCHER=wine64
- KMCOMP="$(dirname $KMCOMP)/kmcomp.x64.exe"
- fi
- ;;
- *)
- KMCOMP_LAUNCHER=wine
- ;;
- esac
-fi
+KMC="$KEYMAN_ROOT/developer/src/kmc/build/src/kmc.js"
-# Build list of available targets from subfolders, if none specified
-if [ ${#TARGETS[@]} == 0 ]; then
- for d in "$THIS_DIR/"*/; do
- d="$(basename "$d")"
- if [ "$d" != "invalid" ] && [ "$d" != "issue" ]; then
- TARGETS+=("$d")
- fi
- done
-fi
-
-if ! $QUIET; then
- displayInfo "" \
- "CLEAN: $CLEAN" \
- "DEBUG: $DEBUG" \
- "QUIET: $QUIET" \
- "KEYBOARDS_ONLY: $KEYBOARDS_ONLY" \
- "TARGETS: ${TARGETS[@]}" \
- "ZIPSOURCE: $ZIPSOURCE" \
- "INDEX: $INDEX" \
- ""
-fi
-
-clean() {
- local kpj="$1.kpj" ss= s=
- if $QUIET; then
- ss=-ss
- s=-s
- fi
- pushd "$1" > /dev/null
- if [ -f build.sh ]; then
- ./build.sh -c $s
- else
- $KMCOMP_LAUNCHER "$KMCOMP" -c $ss "$kpj"
- fi
- popd > /dev/null
-}
+builder_describe "Test Keyboards" \
+ clean configure build \
+ ${targets[@]} \
+ "--index Build index.html for artifact tests" \
+ "--zip-source Create zip file for source of each keyboard for artifact tests" \
+ "--kmc=KMC Specify path to kmc, defaults to developer/src/kmc/build/" \
+ "--silent,-s Suppress information messages"
-build() {
- local kpj="$1.kpj" d= t= ss= target= s= k=
- if $KEYBOARDS_ONLY; then
- k=-k
- t=-t
- target="$1.kmn"
- fi
- if $DEBUG; then
- d=-d
- fi
- if $QUIET; then
- s=-s
- ss=-ss
- fi
- # -w - treat warnings as errors, we'll force this
- # -cfc - check filename conventions
- pushd "$1" > /dev/null
- if [ -f build.sh ]; then
- ./build.sh $d $k $s
- else
- $KMCOMP_LAUNCHER "$KMCOMP" $d $ss -w -cfc "$kpj" $t "$target"
- fi
- popd > /dev/null
-}
+builder_parse "$@"
-zipsource() {
+function zipsource() {
local target="$1"
pushd "$1" > /dev/null
7z a -r -x!build -x"!$target.kpj.user" "${target}_source.zip" .
popd > /dev/null
}
-###
-
-for TARGET in "${TARGETS[@]}"; do
- if $CLEAN; then
- if ! $QUIET; then
- echo
- builder_heading "Cleaning target $TARGET"
- echo
- fi
- clean "$TARGET"
- else
- if ! $QUIET; then
- echo
- builder_heading "Building target $TARGET"
- echo
- fi
- build "$TARGET"
-
- if $ZIPSOURCE; then
- zipsource "$TARGET"
- fi
- fi
-done
-
-###
-
-if $INDEX; then
- if $CLEAN; then
- rm -f "$THIS_DIR/index.html"
- else
- cat << EOF > "$THIS_DIR/index.html"
+function build_index() {
+ local active_targets=($*)
+ cat << EOF > index.html
@@ -231,19 +49,47 @@ if $INDEX; then
EOF
- for TARGET in "${TARGETS[@]}"; do
- if $ZIPSOURCE; then
- echo " - $TARGET.kmp (source)
" >> "$THIS_DIR/index.html"
- else
- echo " - $TARGET.kmp
" >> "$THIS_DIR/index.html"
- fi
- done
+ for TARGET in "${active_targets[@]}"; do
+ if builder_has_option --zip-source; then
+ echo " - $TARGET.kmp (source)
" >> index.html
+ else
+ echo " - $TARGET.kmp
" >> index.html
+ fi
+ done
- cat << 'EOF' >> "$THIS_DIR/index.html"
+ cat << EOF >> index.html
EOF
+}
+
+###
+
+function build() {
+ local active_targets=()
+ for TARGET in "${targets[@]}"; do
+ if builder_has_action build$TARGET; then
+ active_targets+=(${TARGET#:})
+ fi
+ done
+
+ local ss=
+ if builder_has_option --silent; then
+ ss="--log-level silent"
fi
-fi
-exit 0
+
+ node "$KMC" build $builder_debug $ss -w "${active_targets[@]}"
+
+ if builder_has_option --zip-source; then
+ for TARGET in "${active_targets[@]}"; do
+ zipsource "$TARGET"
+ done
+ fi
+
+ if builder_has_option --index; then
+ build_index "${active_targets[@]}"
+ fi
+}
+
+builder_run_action build build
\ No newline at end of file
diff --git a/common/test/keyboards/caps_lock_layer_3620/caps_lock_layer_3620.keyboard_info b/common/test/keyboards/caps_lock_layer_3620/caps_lock_layer_3620.keyboard_info
deleted file mode 100644
index 7cabc2dfde2..00000000000
--- a/common/test/keyboards/caps_lock_layer_3620/caps_lock_layer_3620.keyboard_info
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "license": "mit",
- "languages": [
- "en"
- ],
- "description": "Caps Lock Layer 3620 generated from template"
-}
diff --git a/common/test/keyboards/caps_lock_layer_3620/caps_lock_layer_3620.kpj b/common/test/keyboards/caps_lock_layer_3620/caps_lock_layer_3620.kpj
index 57877e2346b..7868db1fad5 100644
--- a/common/test/keyboards/caps_lock_layer_3620/caps_lock_layer_3620.kpj
+++ b/common/test/keyboards/caps_lock_layer_3620/caps_lock_layer_3620.kpj
@@ -51,13 +51,6 @@
.md
-
- id_fff8738ee01fad8282ccd871d1b1d7ec
- caps_lock_layer_3620.keyboard_info
- caps_lock_layer_3620.keyboard_info
-
- .keyboard_info
-
id_6beb4ed096b4f0d03913a0cf0dc1c10b
caps_lock_layer_3620.kmx
diff --git a/common/test/keyboards/full_caps_3620_3621/full_caps_3620_3621.keyboard_info b/common/test/keyboards/full_caps_3620_3621/full_caps_3620_3621.keyboard_info
deleted file mode 100644
index 3bcee188375..00000000000
--- a/common/test/keyboards/full_caps_3620_3621/full_caps_3620_3621.keyboard_info
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "license": "mit",
- "languages": [
- "en"
- ],
- "description": "full_caps_3620_3621 generated from template"
-}
diff --git a/common/test/keyboards/full_caps_3620_3621/full_caps_3620_3621.kpj b/common/test/keyboards/full_caps_3620_3621/full_caps_3620_3621.kpj
index 96cb56925cd..b7aad105733 100644
--- a/common/test/keyboards/full_caps_3620_3621/full_caps_3620_3621.kpj
+++ b/common/test/keyboards/full_caps_3620_3621/full_caps_3620_3621.kpj
@@ -51,13 +51,6 @@
.md
-
- id_da795226173614238dd92754311e5f15
- full_caps_3620_3621.keyboard_info
- full_caps_3620_3621.keyboard_info
-
- .keyboard_info
-
id_3087832d59de33f9903fc21ba620b576
full_caps_3620_3621.kmx
diff --git a/common/test/keyboards/obolo_chwerty_6347/obolo_chwerty_6347.keyboard_info b/common/test/keyboards/obolo_chwerty_6347/obolo_chwerty_6347.keyboard_info
deleted file mode 100644
index 1513b8bb473..00000000000
--- a/common/test/keyboards/obolo_chwerty_6347/obolo_chwerty_6347.keyboard_info
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "license": "mit",
- "languages": [
- "ann-Latn"
- ],
- "description": "Obolo Chwerty Keyboard: A keyboard layout for the Obolo language of Nigeria. It covers the need of every dialect in that language"
-}
diff --git a/common/test/keyboards/obolo_chwerty_6347/obolo_chwerty_6347.kpj b/common/test/keyboards/obolo_chwerty_6347/obolo_chwerty_6347.kpj
index 2205ec839ed..228ef013817 100644
--- a/common/test/keyboards/obolo_chwerty_6347/obolo_chwerty_6347.kpj
+++ b/common/test/keyboards/obolo_chwerty_6347/obolo_chwerty_6347.kpj
@@ -52,13 +52,6 @@
.md
-
- id_fa9ac62e52c7671ac61602e3583305fd
- obolo_chwerty_6347.keyboard_info
- obolo_chwerty_6347.keyboard_info
-
- .keyboard_info
-
id_8ec79e2ed4a2ffef6c8f0645d5ff022f
obolo_chwerty_6347.ico
diff --git a/common/test/keyboards/obolo_chwerty_6347/source/obolo_chwerty_6347.kps b/common/test/keyboards/obolo_chwerty_6347/source/obolo_chwerty_6347.kps
index 9e3f5a437ab..ebf22548312 100644
--- a/common/test/keyboards/obolo_chwerty_6347/source/obolo_chwerty_6347.kps
+++ b/common/test/keyboards/obolo_chwerty_6347/source/obolo_chwerty_6347.kps
@@ -113,7 +113,7 @@
obolo_chwerty_6347
1.2.1
- Obolo (Andoni)
+ Obolo (Andoni)
diff --git a/common/test/keyboards/obolo_chwerty_6351/obolo_chwerty_6351.keyboard_info b/common/test/keyboards/obolo_chwerty_6351/obolo_chwerty_6351.keyboard_info
deleted file mode 100644
index 1513b8bb473..00000000000
--- a/common/test/keyboards/obolo_chwerty_6351/obolo_chwerty_6351.keyboard_info
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "license": "mit",
- "languages": [
- "ann-Latn"
- ],
- "description": "Obolo Chwerty Keyboard: A keyboard layout for the Obolo language of Nigeria. It covers the need of every dialect in that language"
-}
diff --git a/common/test/keyboards/obolo_chwerty_6351/obolo_chwerty_6351.kpj b/common/test/keyboards/obolo_chwerty_6351/obolo_chwerty_6351.kpj
index cffa8ad084e..3e3e5defd93 100644
--- a/common/test/keyboards/obolo_chwerty_6351/obolo_chwerty_6351.kpj
+++ b/common/test/keyboards/obolo_chwerty_6351/obolo_chwerty_6351.kpj
@@ -52,13 +52,6 @@
.md
-
- id_fa9ac62e52c7671ac61602e3583305fd
- obolo_chwerty_6351.keyboard_info
- obolo_chwerty_6351.keyboard_info
-
- .keyboard_info
-
id_425d4d61d84287d1991f48eb0158c78c
obolo_chwerty_6351.ico
diff --git a/common/test/keyboards/obolo_chwerty_6351/source/obolo_chwerty_6351.kps b/common/test/keyboards/obolo_chwerty_6351/source/obolo_chwerty_6351.kps
index 11e8de9c3bf..df9a3b81cc6 100644
--- a/common/test/keyboards/obolo_chwerty_6351/source/obolo_chwerty_6351.kps
+++ b/common/test/keyboards/obolo_chwerty_6351/source/obolo_chwerty_6351.kps
@@ -113,7 +113,7 @@
obolo_chwerty_6351
1.2.1
- Obolo (Andoni)
+ Obolo (Andoni)
diff --git a/common/test/keyboards/start_of_sentence_3621/start_of_sentence_3621.keyboard_info b/common/test/keyboards/start_of_sentence_3621/start_of_sentence_3621.keyboard_info
deleted file mode 100644
index 70b79803fa4..00000000000
--- a/common/test/keyboards/start_of_sentence_3621/start_of_sentence_3621.keyboard_info
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "license": "mit",
- "languages": [
- "en"
- ],
- "description": "start_of_sentence_3621 generated from template"
-}
diff --git a/common/test/keyboards/start_of_sentence_3621/start_of_sentence_3621.kpj b/common/test/keyboards/start_of_sentence_3621/start_of_sentence_3621.kpj
index 064471c9506..af45b2b3716 100644
--- a/common/test/keyboards/start_of_sentence_3621/start_of_sentence_3621.kpj
+++ b/common/test/keyboards/start_of_sentence_3621/start_of_sentence_3621.kpj
@@ -51,13 +51,6 @@
.md
-
- id_31c9e544d5ff29ebb5ee3006e39f5624
- start_of_sentence_3621.keyboard_info
- start_of_sentence_3621.keyboard_info
-
- .keyboard_info
-
id_8b42366ff2333c0b6d85e2d23cf930d7
start_of_sentence_3621.kmx
diff --git a/common/test/keyboards/u_xxxx_yyyy_2858/u_xxxx_yyyy_2858.keyboard_info b/common/test/keyboards/u_xxxx_yyyy_2858/u_xxxx_yyyy_2858.keyboard_info
deleted file mode 100644
index 03c280d3093..00000000000
--- a/common/test/keyboards/u_xxxx_yyyy_2858/u_xxxx_yyyy_2858.keyboard_info
+++ /dev/null
@@ -1,7 +0,0 @@
-{
- "license": "mit",
- "languages": [
-
- ],
- "description": "U_xxxx_yyyy_2858 generated from template"
-}
diff --git a/common/test/keyboards/u_xxxx_yyyy_2858/u_xxxx_yyyy_2858.kpj b/common/test/keyboards/u_xxxx_yyyy_2858/u_xxxx_yyyy_2858.kpj
index f2b44703b1e..1c576713382 100644
--- a/common/test/keyboards/u_xxxx_yyyy_2858/u_xxxx_yyyy_2858.kpj
+++ b/common/test/keyboards/u_xxxx_yyyy_2858/u_xxxx_yyyy_2858.kpj
@@ -51,13 +51,6 @@
.md
-
- id_10a5cd9d0c42cd03b9838916f6f0bd3d
- u_xxxx_yyyy_2858.keyboard_info
- u_xxxx_yyyy_2858.keyboard_info
-
- .keyboard_info
-
id_a1200478ad69b7f058fdce369fb1d960
u_xxxx_yyyy_2858.kmx
diff --git a/common/test/keyboards/web_context_tests/web_context_tests.kpj b/common/test/keyboards/web_context_tests/web_context_tests.kpj
index 05146c1a3f4..1ec5a1c65f6 100644
--- a/common/test/keyboards/web_context_tests/web_context_tests.kpj
+++ b/common/test/keyboards/web_context_tests/web_context_tests.kpj
@@ -51,13 +51,6 @@
.md
-
- id_41e1ad22438964b0b5b84605df1c667d
- web_context_tests.keyboard_info
- web_context_tests.keyboard_info
-
- .keyboard_info
-
id_fa6acb8dd8884fe0c6c6262bb4477d27
web_context_tests.kmx
diff --git a/common/tools/hextobin/build.sh b/common/tools/hextobin/build.sh
index 702e6610f01..8df4f9b83a3 100755
--- a/common/tools/hextobin/build.sh
+++ b/common/tools/hextobin/build.sh
@@ -1,11 +1,4 @@
#!/usr/bin/env bash
-#
-# Builds hextobin.js
-#
-
-# Exit on command failure and when using unset variables:
-set -eu
-
## START STANDARD BUILD SCRIPT INCLUDE
# adjust relative paths as necessary
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
@@ -22,21 +15,10 @@ cd "$THIS_SCRIPT_PATH"
builder_describe "Build hextobin" clean configure build
builder_describe_outputs \
configure /node_modules \
- build build/index.js
-builder_parse "$@"
+ build /common/tools/hextobin/build/index.js
-if builder_start_action clean; then
- npm run clean
- builder_finish_action success clean
-fi
-
-if builder_start_action configure; then
- verify_npm_setup
- builder_finish_action success configure
-fi
-
-if builder_start_action build; then
- npm run build
- builder_finish_action success build
-fi
+builder_parse "$@"
+builder_run_action clean rm -rf build/ node_modules/
+builder_run_action configure verify_npm_setup
+builder_run_action build tsc --build
diff --git a/common/tools/hextobin/hextobin.ts b/common/tools/hextobin/hextobin.ts
index 503b18d4b1a..6bf56c79533 100644
--- a/common/tools/hextobin/hextobin.ts
+++ b/common/tools/hextobin/hextobin.ts
@@ -1,11 +1,11 @@
#!/usr/bin/env node
-import * as fs from 'fs';
-import * as rd from 'readline';
-import * as program from 'commander';
+import { Command } from 'commander';
+import hextobin from './index.js';
let inputFilename: string = "";
let outputFilename: string = "";
+const program = new Command();
program
.description(
`Will convert the input file which is a hex dump to the output file. Hex dump can contain
@@ -43,6 +43,4 @@ function exitDueToUsageError(message: string): never {
return process.exit(64); // SysExits.EX_USAGE
}
-import hextobin from './index';
-
hextobin(inputFilename, outputFilename, {silent: false});
diff --git a/common/tools/hextobin/package.json b/common/tools/hextobin/package.json
index 155f8297597..2ebb0e9f4e1 100644
--- a/common/tools/hextobin/package.json
+++ b/common/tools/hextobin/package.json
@@ -1,6 +1,8 @@
{
"name": "@keymanapp/hextobin",
"description": "hextobin conversion tool",
+ "type": "module",
+ "private": true,
"keywords": [
"keyman",
"hex",
@@ -14,14 +16,6 @@
"bin": {
"hextobin": "build/hextobin.js"
},
- "scripts": {
- "clean": "tsc -b --clean",
- "build": "tsc -b"
- },
- "repository": {
- "type": "git",
- "url": "git+https://github.com/keymanapp/keyman.git"
- },
"devDependencies": {
"@types/node": "^18.7.18"
}
diff --git a/common/tools/hextobin/tsconfig.json b/common/tools/hextobin/tsconfig.json
index e32831fe737..55e3f66308e 100644
--- a/common/tools/hextobin/tsconfig.json
+++ b/common/tools/hextobin/tsconfig.json
@@ -1,19 +1,9 @@
{
- "extends": "../../../tsconfig-base.json",
- "compilerOptions": {
- "composite": true,
- "declaration": true,
- "target": "ES2020",
- "module": "CommonJS",
- "moduleResolution": "node",
- "rootDir": ".",
- "outDir": "build/",
- },
- "exclude": [
- "node_modules"
- ],
- "files": [
- "index.ts",
- "hextobin.ts"
- ]
+ "extends": "../../../tsconfig.base.json",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build/"
+ },
+ "exclude": ["node_modules"],
+ "files": ["index.ts", "hextobin.ts"]
}
diff --git a/common/tools/sourcemap-path-remapper/src/convert-source-map.d.ts b/common/tools/sourcemap-path-remapper/src/convert-source-map.d.ts
new file mode 100644
index 00000000000..15a4da3c643
--- /dev/null
+++ b/common/tools/sourcemap-path-remapper/src/convert-source-map.d.ts
@@ -0,0 +1 @@
+declare module 'convert-source-map';
\ No newline at end of file
diff --git a/common/tools/sourcemap-path-remapper/tsconfig.json b/common/tools/sourcemap-path-remapper/tsconfig.json
index f9b531b311a..e207097f614 100644
--- a/common/tools/sourcemap-path-remapper/tsconfig.json
+++ b/common/tools/sourcemap-path-remapper/tsconfig.json
@@ -1,12 +1,11 @@
{
- "extends": "../../../tsconfig-base.json",
+ "extends": "../../../tsconfig.base.json",
"compilerOptions": {
"allowJs": false,
"allowSyntheticDefaultImports": true,
"declaration": true,
- "module": "es6",
- "moduleResolution": "node",
+ "sourceMap": false,
"inlineSourceMap": true,
"inlineSources": true,
"sourceRoot": "/common/tools/sourcemap-path-remapper/src",
diff --git a/common/web/es-bundling/tsconfig.json b/common/web/es-bundling/tsconfig.json
index d2ab738acfb..a5149b51c6f 100644
--- a/common/web/es-bundling/tsconfig.json
+++ b/common/web/es-bundling/tsconfig.json
@@ -1,5 +1,5 @@
{
- "extends": "../../../tsconfig.esm-base.json",
+ "extends": "../../../tsconfig.base.json",
"compilerOptions": {
"baseUrl": "./",
"outDir": "build/",
diff --git a/common/web/keyboard-processor/src/keyboards/activeLayout.ts b/common/web/keyboard-processor/src/keyboards/activeLayout.ts
index e6d2ab9f157..9050d393a19 100644
--- a/common/web/keyboard-processor/src/keyboards/activeLayout.ts
+++ b/common/web/keyboard-processor/src/keyboards/activeLayout.ts
@@ -48,6 +48,12 @@ export class ActiveKey implements LayoutKey {
_baseKeyEvent: KeyEvent;
isMnemonic: boolean = false;
+ /**
+ * Only available on subkeys, but we don't distinguish between base keys and subkeys
+ * at this level yet in KMW.
+ */
+ default?: boolean;
+
proportionalPad: number;
proportionalX: number;
proportionalWidth: number;
diff --git a/common/web/keyboard-processor/src/keyboards/defaultLayouts.ts b/common/web/keyboard-processor/src/keyboards/defaultLayouts.ts
index 8d187ac8544..7e0153d0a52 100644
--- a/common/web/keyboard-processor/src/keyboards/defaultLayouts.ts
+++ b/common/web/keyboard-processor/src/keyboards/defaultLayouts.ts
@@ -22,6 +22,7 @@ export type LayoutKey = {
"nextlayer"?: string,
"pad"?: string | number,
"sk"?: LayoutKey[]
+ "default"?: boolean
}
export type LayoutRow = {
diff --git a/common/web/keyman-version/build-bundler.js b/common/web/keyman-version/build-bundler.js
deleted file mode 100644
index a5f26a44df9..00000000000
--- a/common/web/keyman-version/build-bundler.js
+++ /dev/null
@@ -1,22 +0,0 @@
-/*
- * Bundles @keymanapp/keyman-version as a single-file CommonJS module for components
- * still in need of it.
- */
-
-import esbuild from 'esbuild';
-
-// Bundles to a compact ESModule
-esbuild.buildSync({
- entryPoints: ['build/version.inc.js'],
- bundle: true,
- sourcemap: true,
- //minify: true, // No need to minify a module.
- //keepNames: true,
- format: "cjs",
- // Sets 'common/web' as a root folder for module resolution;
- // this allows the keyman-version import to resolve.
- nodePaths: ['..'],
- outfile: "build/version.inc.cjs",
- tsconfig: 'tsconfig.json',
- target: "es5"
-});
\ No newline at end of file
diff --git a/common/web/keyman-version/build.sh b/common/web/keyman-version/build.sh
index 939709732c2..d4a07e4c762 100755
--- a/common/web/keyman-version/build.sh
+++ b/common/web/keyman-version/build.sh
@@ -1,11 +1,4 @@
#!/usr/bin/env bash
-#
-# Builds the include script for the current Keyman version.
-#
-
-# Exit on command failure and when using unset variables:
-set -eu
-
## START STANDARD BUILD SCRIPT INCLUDE
# adjust relative paths as necessary
THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
@@ -13,6 +6,7 @@ THIS_SCRIPT="$(readlink -f "${BASH_SOURCE[0]}")"
## END STANDARD BUILD SCRIPT INCLUDE
. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
+. "$KEYMAN_ROOT/resources/build/build-utils-ci.inc.sh"
# This script runs from its own folder
cd "$THIS_SCRIPT_PATH"
@@ -25,8 +19,7 @@ builder_describe "Build the include script for current Keyman version" \
build \
"pack build a local .tgz pack for testing" \
"publish publish to npm" \
- test \
- --dry-run
+ test
builder_describe_outputs \
configure "/node_modules" \
@@ -34,21 +27,7 @@ builder_describe_outputs \
builder_parse "$@"
-
-if builder_start_action configure; then
- verify_npm_setup
- builder_finish_action success configure
-fi
-
-if builder_start_action clean; then
- npm run clean
- rm -f ./version.inc.ts
- rm -f ./keyman-version.mts
- rm -rf build
- builder_finish_action success clean
-fi
-
-if builder_start_action build; then
+function do_build() {
# Generate version.inc.ts
echo "
// Generated by common/web/keyman-version/build.sh
@@ -72,22 +51,11 @@ export class KEYMAN_VERSION {
export default KEYMAN_VERSION;
" > ./version.inc.ts
- tsc -b $builder_verbose
- # kmlmc (the lexical model compiler) relies on a Node-based import, but after some of the earlier
- # ES-modularization work, our main output's an ES module. Fortunately, esbuild can provide an easy stopgap.
-
- # Generates a CommonJS variant (in case other modules still need it).
- node ./build-bundler.js
-
- builder_finish_action success build
-fi
+ tsc --build $builder_verbose
+}
-if builder_start_action publish; then
- . "$KEYMAN_ROOT/resources/build/build-utils-ci.inc.sh"
- builder_publish_to_npm
- builder_finish_action success publish
-elif builder_start_action pack; then
- . "$KEYMAN_ROOT/resources/build/build-utils-ci.inc.sh"
- builder_publish_to_pack
- builder_finish_action success pack
-fi
+builder_run_action clean rm -rf version.inc.ts keyman-version.mts build/
+builder_run_action configure verify_npm_setup
+builder_run_action build do_build
+builder_run_action publish builder_publish_to_npm
+builder_run_action pack builder_publish_to_pack
diff --git a/common/web/keyman-version/package.json b/common/web/keyman-version/package.json
index 0ec9c1322be..ded749528c4 100644
--- a/common/web/keyman-version/package.json
+++ b/common/web/keyman-version/package.json
@@ -1,26 +1,15 @@
{
"name": "@keymanapp/keyman-version",
"description": "Keyman global version data",
- "main": "./build/version.inc.cjs",
"exports": {
- ".": {
- "import": "./build/version.inc.js",
- "require": "./build/version.inc.cjs"
- },
- "./build/version.inc.cjs": "./build/version.inc.cjs"
+ ".": "./build/version.inc.js"
},
"files": [
"/build/"
],
- "scripts": {
- "build": "echo 'Building @keymanapp/keyman-version' && tsc -b",
- "clean": "tsc -b --clean",
- "tsc": "tsc"
- },
"license": "MIT",
"type": "module",
"devDependencies": {
- "@types/node": "^20.4.1",
"typescript": "^4.9.5"
}
}
diff --git a/common/web/keyman-version/tsconfig.json b/common/web/keyman-version/tsconfig.json
index 8618c6dd922..a5808c432ee 100644
--- a/common/web/keyman-version/tsconfig.json
+++ b/common/web/keyman-version/tsconfig.json
@@ -1,17 +1,12 @@
{
- "extends": "../../../tsconfig-base.json",
+ "extends": "../../../tsconfig.base.json",
"compilerOptions": {
- "allowJs": false,
- "declaration": true,
- "module": "es6",
- "sourceMap": true,
"outDir": "./build",
- "lib": ["es6"],
"target": "es5",
- "downlevelIteration": true,
"rootDir": "."
},
+
"include": [
"version.inc.ts"
]
diff --git a/common/web/lm-message-types/tsconfig.json b/common/web/lm-message-types/tsconfig.json
index 124def350d2..f9d427f0bfc 100644
--- a/common/web/lm-message-types/tsconfig.json
+++ b/common/web/lm-message-types/tsconfig.json
@@ -1,5 +1,5 @@
{
- "extends": "../../../tsconfig-base.json",
+ "extends": "../../../tsconfig.base.json",
"compilerOptions": {
"declaration": true,
"module": "none",
diff --git a/common/web/sentry-manager/src/tsconfig.json b/common/web/sentry-manager/src/tsconfig.json
index 490c315dc90..1b438c93c4b 100644
--- a/common/web/sentry-manager/src/tsconfig.json
+++ b/common/web/sentry-manager/src/tsconfig.json
@@ -1,13 +1,22 @@
{
- "extends": "../../../../tsconfig-base.json",
+ "extends": "../../../../tsconfig.base.json",
"compilerOptions": {
+
+ // TODO: These override /tsconfig.base.json settings, and so should be removed if possible,
+ // but existing code in web/ breaks some of these settinsg
+ "noImplicitThis": false,
+ "noImplicitReturns": false,
+ "noImplicitAny": false,
+ "strictFunctionTypes": false,
+ "noUnusedLocals": false,
+
+
"allowJs": true,
"allowSyntheticDefaultImports": true,
"baseUrl": "./",
"inlineSources": true,
"lib": ["es6", "dom"],
"module": "es6",
- "moduleResolution": "Node16",
"outDir": "../build/obj",
"rootDir": "./",
"sourceMap": true,
diff --git a/common/web/types/.eslintrc.cjs b/common/web/types/.eslintrc.cjs
index 21618ea66ff..98db7f812e5 100644
--- a/common/web/types/.eslintrc.cjs
+++ b/common/web/types/.eslintrc.cjs
@@ -8,6 +8,8 @@ module.exports = {
"coverage/*",
"node_modules/*",
"test/fixtures/*",
+ "tools/*",
+ "src/schemas/*"
],
overrides: [
{
diff --git a/common/web/types/.gitignore b/common/web/types/.gitignore
index 35512aa7852..2f943a2f4e9 100644
--- a/common/web/types/.gitignore
+++ b/common/web/types/.gitignore
@@ -1 +1,2 @@
-src/schemas/
\ No newline at end of file
+src/schemas/
+obj/
\ No newline at end of file
diff --git a/common/web/types/build.sh b/common/web/types/build.sh
index f0c73b0e077..85c448024ed 100755
--- a/common/web/types/build.sh
+++ b/common/web/types/build.sh
@@ -37,18 +37,38 @@ function compile_schemas() {
"$KEYMAN_ROOT/common/schemas/displaymap/displaymap.schema.json"
"$KEYMAN_ROOT/common/schemas/keyman-touch-layout/keyman-touch-layout.spec.json"
"$KEYMAN_ROOT/common/schemas/keyman-touch-layout/keyman-touch-layout.clean.spec.json"
+ "$KEYMAN_ROOT/common/schemas/keyboard_info/keyboard_info.schema.json"
)
+ rm -rf "$THIS_SCRIPT_PATH/obj/schemas"
+ mkdir -p "$THIS_SCRIPT_PATH/obj/schemas"
rm -rf "$THIS_SCRIPT_PATH/src/schemas"
mkdir -p "$THIS_SCRIPT_PATH/src/schemas"
cp "${schemas[@]}" "$THIS_SCRIPT_PATH/src/schemas/"
# TODO: use https://github.com/tc39/proposal-json-modules instead of this once it stablises
for schema in "${schemas[@]}"; do
- local fn="$THIS_SCRIPT_PATH/src/schemas/$(basename "$schema" .json)"
+ local schema_base="$(basename "$schema" .json)"
+ local fn="$THIS_SCRIPT_PATH/src/schemas/$schema_base"
+ local out="$THIS_SCRIPT_PATH/obj/schemas/$schema_base.validator.cjs"
+
+ # emit a .ts wrapper for the schema file
+
+ builder_echo "Compiling schema $schema_base.json"
echo 'export default ' > "$fn.ts"
cat "$fn.json" >> "$fn.ts"
+
+ # emit a compiled validator for the schema file
+
+ # While would seem obvious to just run 'ajv' directly here, somewhere node
+ # is picking up the wrong path for the build and breaking the formats
+ # imports. So it is essential to use `npm run` at this point, even though it
+ # is painfully slower, at least until we figure out the path discrepancy.
+ npm run build:schema -- -c ./tools/formats.cjs -s "$fn.json" --strict-types false -o "$out"
done
+
+ # the validators now need to be compiled to esm
+ node tools/schema-bundler.js
}
function copy_cldr_imports() {
diff --git a/common/web/types/package.json b/common/web/types/package.json
index 83a403aeedc..fd59cffa97d 100644
--- a/common/web/types/package.json
+++ b/common/web/types/package.json
@@ -16,6 +16,7 @@
],
"scripts": {
"build": "tsc -b",
+ "build:schema": "ajv compile",
"lint": "eslint .",
"test": "npm run lint && cd test && tsc -b && cd .. && c8 --skip-full --reporter=lcov --reporter=text mocha",
"prepublishOnly": "npm run build"
@@ -27,7 +28,6 @@
},
"dependencies": {
"@keymanapp/keyman-version": "*",
- "ajv": "^8.11.0",
"restructure": "git+https://github.com/keymanapp/dependency-restructure.git#7a188a1e26f8f36a175d95b67ffece8702363dfc",
"semver": "^7.5.2",
"xml2js": "git+https://github.com/keymanapp/dependency-node-xml2js#535fe732dc408d697e0f847c944cc45f0baf0829"
@@ -39,6 +39,9 @@
"@types/node": "^20.4.1",
"@types/semver": "^7.3.12",
"@types/xml2js": "^0.4.5",
+ "ajv": "^8.12.0",
+ "ajv-cli": "^5.0.0",
+ "ajv-formats": "^2.1.1",
"c8": "^7.12.0",
"chai": "^4.3.4",
"chalk": "^2.4.2",
@@ -74,6 +77,7 @@
"src/ldml-keyboard/unicodeset-parser-api.ts",
"src/keyman-touch-layout/keyman-touch-layout-file-writer.ts",
"src/osk/osk.ts",
+ "src/schemas/*",
"test/"
]
}
diff --git a/common/web/types/src/consts/virtual-key-constants.ts b/common/web/types/src/consts/virtual-key-constants.ts
index f93155f1ff5..3347660f015 100644
--- a/common/web/types/src/consts/virtual-key-constants.ts
+++ b/common/web/types/src/consts/virtual-key-constants.ts
@@ -122,8 +122,8 @@ export const USVirtualKeyCodes = {
*/
K_oE2:226,
K_OE2:226,
- k_oC1:193, // ISO B11, ABNT-2 key to left of right shift, not on US keyboard
- k_OC1:193,
+ K_oC1:193, // ISO B11, ABNT-2 key to left of right shift, not on US keyboard
+ K_OC1:193,
'K_?C1':193,
'k_?C1':193,
K_oDF:0xDF,
@@ -144,125 +144,90 @@ export const USVirtualKeyCodes = {
const k = USVirtualKeyCodes;
-export type KeyMap = number[][];
+/** Map a CLDR scancode to a US VKey ala USVirtualKeyCodes */
+export const CLDRScanToUSVirtualKeyCodes = {
+ 0x02: k.K_1,
+ 0x03: k.K_2,
+ 0x04: k.K_3,
+ 0x05: k.K_4,
+ 0x06: k.K_5,
+ 0x07: k.K_6,
+ 0x08: k.K_7,
+ 0x09: k.K_8,
+ 0x0A: k.K_9,
+ 0x0B: k.K_0,
+ 0x0C: k.K_HYPHEN,
+ 0x0D: k.K_EQUAL,
-export const USVirtualKeyMap: KeyMap = [
- // ` 1 2 3 4 5 6 7 8 9 0 - = [bksp]
- [ k.K_BKQUOTE, k.K_1, k.K_2, k.K_3, k.K_4, k.K_5, k.K_6, k.K_7, k.K_8, k.K_9, k.K_0, k.K_HYPHEN, k.K_EQUAL ],
- // [tab] Q W E R T Y U I O P [ ] \
- [ k.K_Q, k.K_W, k.K_E, k.K_R, k.K_T, k.K_Y, k.K_U, k.K_I, k.K_O, k.K_P, k.K_LBRKT, k.K_RBRKT, k.K_BKSLASH ],
- // [caps] A S D F G H J K L ; ' [enter]
- [ k.K_A, k.K_S, k.K_D, k.K_F, k.K_G, k.K_H, k.K_J, k.K_K, k.K_L, k.K_COLON, k.K_QUOTE ],
- // [shift] Z X C V B N M , . / [shift] *=oE2
- [ k.K_Z, k.K_X, k.K_C, k.K_V, k.K_B, k.K_N, k.K_M, k.K_COMMA, k.K_PERIOD, k.K_SLASH ],
- // space
- [ k.K_SPACE ],
-];
+ 0x10: k.K_Q,
+ 0x11: k.K_W,
+ 0x12: k.K_E,
+ 0x13: k.K_R,
+ 0x14: k.K_T,
+ 0x15: k.K_Y,
+ 0x16: k.K_U,
+ 0x17: k.K_I,
+ 0x18: k.K_O,
+ 0x19: k.K_P,
+ 0x1A: k.K_LBRKT,
+ 0x1B: k.K_RBRKT,
-export const ISOVirtualKeyMap: KeyMap = [
- // ` 1 2 3 4 5 6 7 8 9 0 - = [bksp]
- [ k.K_BKQUOTE, k.K_1, k.K_2, k.K_3, k.K_4, k.K_5, k.K_6, k.K_7, k.K_8, k.K_9, k.K_0, k.K_HYPHEN, k.K_EQUAL ],
- // [tab] Q W E R T Y U I O P [ ]
- [ k.K_Q, k.K_W, k.K_E, k.K_R, k.K_T, k.K_Y, k.K_U, k.K_I, k.K_O, k.K_P, k.K_LBRKT, k.K_RBRKT ],
- // [caps] A S D F G H J K L ; ' \ [enter]
- [ k.K_A, k.K_S, k.K_D, k.K_F, k.K_G, k.K_H, k.K_J, k.K_K, k.K_L, k.K_COLON, k.K_QUOTE, k.K_BKSLASH ],
- // [shift] * Z X C V B N M , . / [shift] *=oE2
- [ k.K_oE2, k.K_Z, k.K_X, k.K_C, k.K_V, k.K_B, k.K_N, k.K_M, k.K_COMMA, k.K_PERIOD, k.K_SLASH ],
- // space
- [ k.K_SPACE ],
-];
+ 0x1E: k.K_A,
+ 0x1F: k.K_S,
+ 0x20: k.K_D,
+ 0x21: k.K_F,
+ 0x22: k.K_G,
+ 0x23: k.K_H,
+ 0x24: k.K_J,
+ 0x25: k.K_K,
+ 0x26: k.K_L,
+ 0x27: k.K_COLON,
+ 0x28: k.K_QUOTE,
+ 0x29: k.K_BKQUOTE,
-export const JISVirtualKeyMap: KeyMap = [
- // [Hankaku/Zenkaku] 1 2 3 4 5 6 7 8 9 0 - ^ ¥ [bksp]
- [ k.K_1, k.K_2, k.K_3, k.K_4, k.K_5, k.K_6, k.K_7, k.K_8, k.K_9, k.K_0, k.K_HYPHEN, k.K_EQUAL, k.K_BKSLASH /* YEN */ ],
- // [tab] Q W E R T Y U I O P @«`» [ [enter]
- [ k.K_Q, k.K_W, k.K_E, k.K_R, k.K_T, k.K_Y, k.K_U, k.K_I, k.K_O, k.K_P, k.K_BKQUOTE, k.K_LBRKT ],
- // [caps] A S D F G H J K L ; : ] [enter]
- [ k.K_A, k.K_S, k.K_D, k.K_F, k.K_G, k.K_H, k.K_J, k.K_K, k.K_L, k.K_COLON, k.K_QUOTE, k.K_RBRKT ],
- // [shift] Z X C V B N M , . / _ [shift]
- [ k.K_Z, k.K_X, k.K_C, k.K_V, k.K_B, k.K_N, k.K_M, k.K_COMMA, k.K_PERIOD, k.K_SLASH, k.K_oE2 /* ろ */ ],
- // space
- [ k.K_SPACE ],
-];
+ 0x2B: k.K_BKSLASH,
+ 0x2C: k.K_Z,
+ 0x2D: k.K_X,
+ 0x2E: k.K_C,
+ 0x2F: k.K_V,
+ 0x30: k.K_B,
+ 0x31: k.K_N,
+ 0x32: k.K_M,
+ 0x33: k.K_COMMA,
+ 0x34: k.K_PERIOD,
+ 0x35: k.K_SLASH,
-export const ABNT2VirtualKeyMap: KeyMap = [
- // ' 1 2 3 4 5 6 7 8 9 0 - = [bksp]
- [ k.K_BKQUOTE, k.K_1, k.K_2, k.K_3, k.K_4, k.K_5, k.K_6, k.K_7, k.K_8, k.K_9, k.K_0, k.K_HYPHEN, k.K_EQUAL ],
- // [tab] Q W E R T Y U I O P ´ [
- [ k.K_Q, k.K_W, k.K_E, k.K_R, k.K_T, k.K_Y, k.K_U, k.K_I, k.K_O, k.K_P, k.K_LBRKT, k.K_RBRKT ],
- // [caps] A S D F G H J K L ç ~ ] [enter]
- [ k.K_A, k.K_S, k.K_D, k.K_F, k.K_G, k.K_H, k.K_J, k.K_K, k.K_L, k.K_COLON, k.K_QUOTE, k.K_BKSLASH ],
- // [shift] \ Z X C V B N M , . ; / [shift]
- [ k.K_oE2, k.K_Z, k.K_X, k.K_C, k.K_V, k.K_B, k.K_N, k.K_M, k.K_COMMA, k.K_PERIOD, k.K_SLASH, k.k_oC1 /* ABNT2 */ ],
- // space
- [ k.K_SPACE ],
-];
+ 0x39: k.K_SPACE,
-/**
- * Map from a hardware constant to a keymap
- * For the 'key' see constants.layr_list_hardware_map
- */
-export const HardwareToKeymap: Map = new Map(
- [
- ["us", USVirtualKeyMap],
- ["iso", ISOVirtualKeyMap],
- ["jis", JISVirtualKeyMap],
- ["abnt2", ABNT2VirtualKeyMap],
- ]
-);
+ 0x56: k.K_oE2, // << Same as 0x7D; found on iso, abnt2
+ 0x73: k.K_oC1,
+ 0x7D: k.K_oE2, // << Same as 0x56; found on jis
+
+};
+
+export type KeyMap = number[][];
/**
- * Maps LDML VKey Names from CLDR VKey Enum in TR35 to Keyman virtual key codes
+ * Convert a scan code numerical KeyMap to VKeys
+ * @param scans keymap to convert
+ * @param badScans output: set of not-found scancodes
+ * @returns
*/
-export const LdmlVkeyNames: Record = {
- 'SPACE': k.K_SPACE, // 0x20, // A03
- '0': k.K_0, // 0x30, // E10
- '1': k.K_1, // 0x31, // E01
- '2': k.K_2, // 0x32, // E02
- '3': k.K_3, // 0x33, // E03
- '4': k.K_4, // 0x34, // E04
- '5': k.K_5, // 0x35, // E05
- '6': k.K_6, // 0x36, // E06
- '7': k.K_7, // 0x37, // E07
- '8': k.K_8, // 0x38, // E08
- '9': k.K_9, // 0x39, // E09
- 'A': k.K_A, // 0x41, // C01
- 'B': k.K_B, // 0x42, // B05
- 'C': k.K_C, // 0x43, // B03
- 'D': k.K_D, // 0x44, // C03
- 'E': k.K_E, // 0x45, // D03
- 'F': k.K_F, // 0x46, // C04
- 'G': k.K_G, // 0x47, // C05
- 'H': k.K_H, // 0x48, // C06
- 'I': k.K_I, // 0x49, // D08
- 'J': k.K_J, // 0x4A, // C07
- 'K': k.K_K, // 0x4B, // C08
- 'L': k.K_L, // 0x4C, // C09
- 'M': k.K_M, // 0x4D, // B07
- 'N': k.K_N, // 0x4E, // B06
- 'O': k.K_O, // 0x4F, // D09
- 'P': k.K_P, // 0x50, // D10
- 'Q': k.K_Q, // 0x51, // D01
- 'R': k.K_R, // 0x52, // D04
- 'S': k.K_S, // 0x53, // C02
- 'T': k.K_T, // 0x54, // D05
- 'U': k.K_U, // 0x55, // D07
- 'V': k.K_V, // 0x56, // B05
- 'W': k.K_W, // 0x57, // D02
- 'X': k.K_X, // 0x58, // B02
- 'Y': k.K_Y, // 0x59, // D06
- 'Z': k.K_Z, // 0x5A, // B01
- 'SEMICOLON': k.K_COLON, // 0xBA, // C10
- 'EQUAL': k.K_EQUAL, // 0xBB, // E12
- 'COMMA': k.K_COMMA, // 0xBC, // B08
- 'HYPHEN': k.K_HYPHEN, // 0xBD, // E11
- 'PERIOD': k.K_PERIOD, // 0xBE, // B09
- 'SLASH': k.K_SLASH, // 0xBF, // B10
- 'GRAVE': k.K_BKQUOTE, // 0xC0, // E00
- 'LBRACKET': k.K_LBRKT, // 0xDB, // D11
- 'BACKSLASH': k.K_BKSLASH, // 0xDC, // D13
- 'RBRACKET': k.K_RBRKT, // 0xDD, // D12
- 'QUOTE': k.K_QUOTE, // 0xDE, // C11
- 'LESS-THAN': k.K_oE2, // 0xE2, // B00 102nd key on European layouts, right of left shift.
- 'ABNT2': k.k_oC1, // 0xC1, // B11 Extra key, left of right-shift, ABNT2
-};
+export function CLDRScanToKeyMap(scans: KeyMap, badScans?: Set): KeyMap {
+ return scans.map((row) => row.map((scan) => CLDRScanToVkey(scan, badScans)));
+}
+
+/** Convert one scan code to vkey, or undefined */
+export function CLDRScanToVkey(scan: number, badScans?: Set): number {
+ /** typescript fun to index the scan table */
+ function hasScanCode(key: PropertyKey): key is keyof typeof CLDRScanToUSVirtualKeyCodes {
+ return key in CLDRScanToUSVirtualKeyCodes;
+ }
+ if (hasScanCode(scan)) {
+ return CLDRScanToUSVirtualKeyCodes[scan];
+ } else {
+ badScans?.add(scan);
+ return undefined;
+ }
+}
+
diff --git a/common/web/types/src/keyman-touch-layout/keyman-touch-layout-file-reader.ts b/common/web/types/src/keyman-touch-layout/keyman-touch-layout-file-reader.ts
index f2dc0a5c7d9..bb5d8c2df17 100644
--- a/common/web/types/src/keyman-touch-layout/keyman-touch-layout-file-reader.ts
+++ b/common/web/types/src/keyman-touch-layout/keyman-touch-layout-file-reader.ts
@@ -1,7 +1,5 @@
-import { default as AjvModule } from 'ajv';
-const Ajv = AjvModule.default; // The actual expected Ajv type.
import { TouchLayoutFile } from "./keyman-touch-layout-file.js";
-import Schemas from '../../src/schemas.js';
+import SchemaValidators from '../schema-validators.js';
export class TouchLayoutFileReader {
public read(source: Uint8Array): TouchLayoutFile {
@@ -69,11 +67,10 @@ export class TouchLayoutFileReader {
}
public validate(source: TouchLayoutFile): void {
- const ajv = new Ajv();
- if(!ajv.validate(Schemas.touchLayoutClean, source))
+ if(!SchemaValidators.touchLayoutClean(source))
/* c8 ignore next 3 */
{
- throw new Error(ajv.errorsText());
+ throw new Error((SchemaValidators.touchLayoutClean).errors);
}
}
diff --git a/common/web/types/src/kmx/element-string.ts b/common/web/types/src/kmx/element-string.ts
index ed64a498ff8..ebf4d398e55 100644
--- a/common/web/types/src/kmx/element-string.ts
+++ b/common/web/types/src/kmx/element-string.ts
@@ -31,11 +31,11 @@ export class ElementString extends Array {
* @param source if a string array, does not get reinterpreted as UnicodeSet. This is used with vars, etc. Or pass `["str"]` for an explicit 1-element elem.
* If it is a string, will be interpreted per reorder element rules.
*/
- constructor(sections: DependencySections, source: string | string[], order?: string, tertiary?: string, tertiary_base?: string, prebase?: string) {
- super();
- //TODO-LDML: full UnicodeSet and parsing
+ static fromStrings(sections: DependencySections, source: string | string[], order?: string, tertiary?: string, tertiary_base?: string, prebase?: string) : ElementString {
+ // the returned array
+ const array = new ElementString();
if(!source) {
- return;
+ return array;
}
let items : ElementSegment[];
@@ -80,16 +80,16 @@ export class ElementString extends Array {
throw Error(`Could not parse uset ${item.segment}`);
}
elem.uset = sections.uset.allocUset(uset, sections);
- elem.value = sections.strs.allocString('', true); // no string
+ elem.value = sections.strs.allocString('', {singleOk: true}); // no string
} else if (item.type === ElementType.codepoint || item.type === ElementType.escaped || item.type === ElementType.string) {
// some kind of a string
let str = item.segment;
if (item.type === ElementType.escaped && !MATCH_HEX_ESCAPE.test(str)) {
str = unescapeOneQuadString(str);
// TODO-LDML: any other escape forms here?
- elem.value = sections.strs.allocString(str, true);
+ elem.value = sections.strs.allocString(str, { singleOk: true });
} else {
- elem.value = sections.strs.allocAndUnescapeString(str, true);
+ elem.value = sections.strs.allocString(str, { unescape: true, singleOk: true });
}
// Now did we end up with one char or no?
if (elem.value.isOneChar) {
@@ -104,8 +104,9 @@ export class ElementString extends Array {
(ElemElementFlags.type & typeFlag) |
(tertiary_bases?.[i] == '1' /* TODO-LDML: or 'true'? */ ? ElemElementFlags.tertiary_base : 0) |
(prebases?.[i] == '1' /* TODO-LDML: or 'true'? */ ? ElemElementFlags.prebase : 0);
- this.push(elem);
+ array.push(elem);
};
+ return array;
}
isEqual(a: ElementString): boolean {
if (a.length != this.length) {
diff --git a/common/web/types/src/kmx/kmx-plus-builder/build-layr.ts b/common/web/types/src/kmx/kmx-plus-builder/build-layr.ts
index 057158f1865..c0038246e27 100644
--- a/common/web/types/src/kmx/kmx-plus-builder/build-layr.ts
+++ b/common/web/types/src/kmx/kmx-plus-builder/build-layr.ts
@@ -13,7 +13,7 @@ import { BUILDER_SECTION } from "./builder-section.js";
* List of layers, the element
*/
interface BUILDER_LAYR_LIST {
- hardware: number; // hardware indicator
+ hardware: BUILDER_STR_REF; // hardware or 'touch'
layer: number; // index of first layer in the list, in the
count: number; // number of layer entries in the list
minDeviceWidth: number; // width in millimeters
@@ -82,7 +82,7 @@ export function build_layr(kmxplus: KMXPlusData, sect_strs: BUILDER_STRS, sect_l
layr.lists = kmxplus.layr.lists.map((list) => {
const blist: BUILDER_LAYR_LIST = {
- hardware: list.hardware,
+ hardware: build_strs_index(sect_strs, list.hardware),
layer: null, // to be set below
_layers: list.layers,
count: list.layers.length,
@@ -92,6 +92,7 @@ export function build_layr(kmxplus: KMXPlusData, sect_strs: BUILDER_STRS, sect_l
});
// now sort the lists
layr.lists.sort((a, b) => {
+ // sort by string #
if (a.hardware < b.hardware) {
return -1;
} else if (a.hardware > b.hardware) {
diff --git a/common/web/types/src/kmx/kmx-plus-builder/build-vkey.ts b/common/web/types/src/kmx/kmx-plus-builder/build-vkey.ts
deleted file mode 100644
index 0a4863beabd..00000000000
--- a/common/web/types/src/kmx/kmx-plus-builder/build-vkey.ts
+++ /dev/null
@@ -1,43 +0,0 @@
-import { constants } from '@keymanapp/ldml-keyboard-constants';
-import { KMXPlusData } from "../kmx-plus.js";
-import { BUILDER_SECTION } from './builder-section.js';
-
-/* ------------------------------------------------------------------
- * vkey section
- ------------------------------------------------------------------ */
-
-/**
- * Builder for the 'vkey' section
- */
-interface BUILDER_VKEY_ITEM {
- vkey: number;
- target: number;
-};
-
-export interface BUILDER_VKEY extends BUILDER_SECTION {
- count: number;
- items: BUILDER_VKEY_ITEM[];
-};
-
-export function build_vkey(kmxplus: KMXPlusData): BUILDER_VKEY {
- if(!kmxplus.vkey.vkeys.length) {
- return null;
- }
-
- let vkey: BUILDER_VKEY = {
- ident: constants.hex_section_id(constants.section.vkey),
- size: constants.length_vkey + constants.length_vkey_item * kmxplus.vkey.vkeys.length,
- _offset: 0,
- count: kmxplus.vkey.vkeys.length,
- items: []
- };
-
- for(let item of kmxplus.vkey.vkeys) {
- vkey.items.push({
- vkey: item.vkey,
- target: item.target
- });
- }
-
- return vkey;
-}
diff --git a/common/web/types/src/kmx/kmx-plus-builder/kmx-plus-builder.ts b/common/web/types/src/kmx/kmx-plus-builder/kmx-plus-builder.ts
index 3cc58c9fe75..e77c60fbe7e 100644
--- a/common/web/types/src/kmx/kmx-plus-builder/kmx-plus-builder.ts
+++ b/common/web/types/src/kmx/kmx-plus-builder/kmx-plus-builder.ts
@@ -15,7 +15,6 @@ import { BUILDER_STRS, build_strs } from './build-strs.js';
import { BUILDER_TRAN, build_tran } from './build-tran.js';
import { BUILDER_USET, build_uset } from './build-uset.js';
import { BUILDER_VARS, build_vars } from './build-vars.js';
-import { BUILDER_VKEY, build_vkey } from './build-vkey.js';
type BUILDER_BKSP = BUILDER_TRAN;
// type BUILDER_FINL = BUILDER_TRAN;
@@ -36,7 +35,6 @@ type SectionBuilders = {
tran?: BUILDER_TRAN;
uset?: BUILDER_USET;
vars?: BUILDER_VARS;
- vkey?: BUILDER_VKEY;
};
export default class KMXPlusBuilder {
@@ -73,7 +71,6 @@ export default class KMXPlusBuilder {
this.emitSection(file, this.file.COMP_PLUS_TRAN, this.sect.tran);
this.emitSection(file, this.file.COMP_PLUS_USET, this.sect.uset);
this.emitSection(file, this.file.COMP_PLUS_VARS, this.sect.vars);
- this.emitSection(file, this.file.COMP_PLUS_VKEY, this.sect.vkey);
return file;
}
@@ -100,7 +97,6 @@ export default class KMXPlusBuilder {
this.sect.tran = build_tran(this.file.kmxplus.tran, this.sect.strs, this.sect.elem);
this.sect.uset = build_uset(this.file.kmxplus, this.sect.strs);
this.sect.vars = build_vars(this.file.kmxplus, this.sect.strs, this.sect.elem, this.sect.list);
- this.sect.vkey = build_vkey(this.file.kmxplus);
// Finalize the sect (index) section
@@ -138,7 +134,6 @@ export default class KMXPlusBuilder {
offset = this.finalize_sect_item(this.sect.tran, offset);
offset = this.finalize_sect_item(this.sect.uset, offset);
offset = this.finalize_sect_item(this.sect.vars, offset);
- offset = this.finalize_sect_item(this.sect.vkey, offset);
this.sect.sect.total = offset;
}
diff --git a/common/web/types/src/kmx/kmx-plus.ts b/common/web/types/src/kmx/kmx-plus.ts
index eba1324b857..1060e50fba8 100644
--- a/common/web/types/src/kmx/kmx-plus.ts
+++ b/common/web/types/src/kmx/kmx-plus.ts
@@ -35,14 +35,14 @@ export class Elem extends Section {
strings: ElementString[] = [];
constructor(sections: DependencySections) {
super();
- this.strings.push(new ElementString(sections, '')); // C7043: null element string
+ this.strings.push(ElementString.fromStrings(sections, '')); // C7043: null element string
}
/**
* @param source if a string array, does not get reinterpreted as UnicodeSet. This is used with vars, etc. Or pass `["str"]` for an explicit 1-element elem.
* If it is a string, will be interpreted per reorder element ruls.
*/
allocElementString(sections: DependencySections, source: string | string[], order?: string, tertiary?: string, tertiary_base?: string, prebase?: string): ElementString {
- let s = new ElementString(sections, source, order, tertiary, tertiary_base, prebase);
+ let s = ElementString.fromStrings(sections, source, order, tertiary, tertiary_base, prebase);
let result = this.strings.find(item => item.isEqual(s));
if(result === undefined) {
result = s;
@@ -143,45 +143,67 @@ export class CharStrsItem extends StrsItem {
}
};
+/** class for string manipulation options. These are in order of the pipeline. */
+export interface StrsOptions {
+ /** apply string variables (requires sections) */
+ stringVariables?: boolean;
+ /** apply markers (requires sections) */
+ markers?: boolean;
+ /** unescape with unescapeString */
+ unescape?: boolean;
+ /** string can be stored as a single CharStrsItem, not in strs table. */
+ singleOk?: boolean;
+};
+
export class Strs extends Section {
strings: StrsItem[] = [ new StrsItem('') ]; // C7043: The null string is always requierd
/**
* Allocate a StrsItem given the string, unescaping if necessary.
* @param s escaped string
- * @param singleOk if true, allocate a CharStrsItem (not in strs table) if single-char capable.
- * @returns
- */
- allocAndUnescapeString(s?: string, singleOk?: boolean): StrsItem {
- return this.allocString(unescapeString(s), singleOk);
- }
- /**
- * Allocate a StrsItem given the string.
- * @param s string
- * @param singleOk if true, allocate a CharStrsItem (not in strs table) if single-char capable.
- * @returns
+ * @param opts options for allocation
+ * @param sections other sections, if needed
+ * @returns StrsItem
*/
- allocString(s?: string, singleOk?: boolean): StrsItem {
- if(s === undefined || s === null) {
- // undefined or null are always equivalent to empty string, see C7043
- s = '';
- }
-
- if(typeof s !== 'string') {
- throw new Error('alloc_string: s must be a string, undefined, or null.');
- }
+ allocString(s?: string, opts?: StrsOptions, sections?: DependencySections): StrsItem {
+ // Run the string processing pipeline
+ s = Strs.processString(s, opts, sections);
- // if it's a single char, don't push it into the list
- if (singleOk && isOneChar(s)) {
+ // if it's a single char, don't push it into the strs table
+ if (opts?.singleOk && isOneChar(s)) {
return new CharStrsItem(s);
}
+ // default: look to see if the string is already present
let result = this.strings.find(item => item.value === s);
if(result === undefined) {
+ // only add if not already present
result = new StrsItem(s);
this.strings.push(result);
}
return result;
}
+
+ /** process everything according to opts */
+ static processString(s: string, opts: StrsOptions, sections: DependencySections) {
+ s = s ?? '';
+ // type check everything else
+ if (typeof s !== 'string') {
+ throw new Error('alloc_string: s must be a string, undefined, or null.');
+ }
+ // substitute variables
+ if (opts?.stringVariables) {
+ s = sections.vars.substituteStrings(s, sections);
+ }
+ // substitute markers
+ if (opts?.markers) {
+ s = sections.vars.substituteMarkerString(s);
+ }
+ // unescape \u{…}
+ if (opts?.unescape) {
+ s = unescapeString(s);
+ }
+ return s;
+ }
};
/**
@@ -234,6 +256,7 @@ export class Vars extends Section {
});
}
substituteStrings(str: string, sections: DependencySections): string {
+ if (!str) return str;
return str.replaceAll(VariableParser.STRING_REFERENCE, (_entire, id) => {
const val = this.findStringVariableValue(id);
if (val === null) {
@@ -293,8 +316,8 @@ export class Vars extends Section {
return v[0];
}
}
- substituteMarkerString(s : string) : string {
- return MarkerParser.toSentinelString(s, this.markers);
+ substituteMarkerString(s : string, forMatch? : boolean) : string {
+ return MarkerParser.toSentinelString(s, this.markers, forMatch);
}
};
@@ -309,7 +332,7 @@ export class VarsItem extends Section {
constructor(id: string, value: string, sections: DependencySections) {
super();
this.id = sections.strs.allocString(id);
- this.value = sections.strs.allocAndUnescapeString(value);
+ this.value = sections.strs.allocString(value, {unescape: true});
}
valid() : boolean {
@@ -404,17 +427,6 @@ export class Bksp extends Tran {
}
};
-// 'vkey'
-
-export class VkeyItem {
- vkey: number;
- target: number;
-}
-
-export class Vkey extends Section {
- vkeys: VkeyItem[] = [];
-};
-
// 'disp'
export class DispItem {
to: StrsItem;
@@ -433,7 +445,7 @@ export class Disp extends Section {
* In-memory ``
*/
export class LayrList {
- hardware: number;
+ hardware: StrsItem;
layers: LayrEntry[] = [];
minDeviceWidth: number; // millimeters
};
@@ -510,19 +522,14 @@ export class List extends Section {
* Allocate a list from a space-separated list of items.
* Note that passing undefined or null or `''` will
* end up being the same as the empty list `[]`
- * @param strs Strs section for allocation
* @param s space-separated list of items
+ * @param opts string options
+ * @param sections sections
* @returns a List object
*/
- allocListFromSpaces(strs: Strs, s?: string): ListItem {
+ allocListFromSpaces(s: string, opts: StrsOptions, sections: DependencySections): ListItem {
s = s ?? '';
- return this.allocList(strs, s.split(' '));
- }
- allocListFromEscapedSpaces(strs: Strs, s?: string): ListItem {
- if(s === undefined || s === null) {
- s = '';
- }
- return this.allocList(strs, s.split(' ').map(unescapeString));
+ return this.allocList(s.split(' '), opts, sections);
}
/**
* Return a List object referring to the string list.
@@ -532,7 +539,7 @@ export class List extends Section {
* @param s string list to allocate
* @returns
*/
- allocList(strs: Strs, s?: string[]): ListItem {
+ allocList(s: string[], opts: StrsOptions, sections: DependencySections): ListItem {
// Special case the 'null' list for [] or ['']
if (!s || (s.length === 1 && s[0] === '')) {
return this.lists[0];
@@ -540,14 +547,14 @@ export class List extends Section {
let result = this.lists.find(item => item.isEqual(s));
if(result === undefined) {
// allocate a new ListItem
- result = new ListItem(strs, s);
+ result = ListItem.fromStrings(s, opts, sections);
this.lists.push(result);
}
return result;
}
constructor(strs: Strs) {
super();
- this.lists.push(new ListItem(strs, [])); // C7043: null element string
+ this.lists.push(ListItem.fromStrings([], {}, { strs })); // C7043: null element string
}
lists: ListItem[] = [];
};
@@ -569,7 +576,6 @@ export interface KMXPlusData {
tran?: Tran;
uset?: Uset; // uset is ignored in-memory
vars?: Vars;
- vkey?: Vkey;
};
export class KMXPlusFile extends KMXFile {
@@ -720,7 +726,7 @@ export class KMXPlusFile extends KMXFile {
});
this.COMP_PLUS_LAYR_LIST = new r.Struct({
- hardware: r.uint32le, //enum
+ hardware: STR_REF, // str: hardware name
layer: r.uint32le, // index into layers
count: r.uint32le,
minDeviceWidth: r.uint32le, // integer: millimeters
diff --git a/common/web/types/src/kmx/kmx.ts b/common/web/types/src/kmx/kmx.ts
index 8a2c3e47aaa..6102a69cf55 100644
--- a/common/web/types/src/kmx/kmx.ts
+++ b/common/web/types/src/kmx/kmx.ts
@@ -144,9 +144,10 @@ export class KMXFile {
public static readonly VERSION_150 = 0x00000F00;
public static readonly VERSION_160 = 0x00001000;
+ public static readonly VERSION_170 = 0x00001100;
public static readonly VERSION_MIN = this.VERSION_50;
- public static readonly VERSION_MAX = this.VERSION_160;
+ public static readonly VERSION_MAX = this.VERSION_170;
//
// Backspace types
diff --git a/common/web/types/src/kmx/string-list.ts b/common/web/types/src/kmx/string-list.ts
index f9f4b46e912..411c940acf1 100644
--- a/common/web/types/src/kmx/string-list.ts
+++ b/common/web/types/src/kmx/string-list.ts
@@ -1,5 +1,5 @@
import { OrderedStringList } from 'src/ldml-keyboard/pattern-parser.js';
-import { Strs, StrsItem } from './kmx-plus.js';
+import { DependencySections, StrsItem, StrsOptions } from './kmx-plus.js';
/**
* A single entry in a ListItem.
@@ -27,20 +27,22 @@ export class ListItem extends Array implements OrderedStringList {
/**
* Construct a new list from an array of strings.
* Use List. This is meant to be called by the List.allocString*() functions.
- * @param strs the Strs section is needed to construct this object.
* @param source array of strings
+ * @param opts string handling options
+ * @param sections the Strs section is needed to construct this object, and other sections may
+ * be needed depending on the options
* @returns
*/
- constructor(strs: Strs, source: Array) {
- super();
- if(!source) {
- return;
+ static fromStrings(source: Array, opts: StrsOptions, sections: DependencySections) : ListItem {
+ const a = new ListItem();
+ if (!source) {
+ return a;
}
-
for (const str of source) {
- let index = new ListIndex(strs.allocString(str));
- this.push(index);
+ let index = new ListIndex(sections.strs.allocString(str, opts, sections));
+ a.push(index);
}
+ return a;
}
getItemOrder(item: string): number {
return this.findIndex(({value}) => value.value === item);
@@ -72,12 +74,13 @@ export class ListItem extends Array implements OrderedStringList {
return 0;
}
}
- /** for debugging, print as single string */
+ /** for debugging and tests, print as single string */
toString(): string {
return this.toStringArray().join(' ');
}
- /** for debugging, map to string array */
+ /** for debugging and tests, map to string array */
toStringArray(): string[] {
- return this.map(v => v.value.value);
+ // TODO-LDML: this crashes: return this.map(v => v.toString());
+ return Array.from(this.values()).map(v => v.toString());
}
};
diff --git a/common/web/types/src/kpj/keyman-developer-project.ts b/common/web/types/src/kpj/keyman-developer-project.ts
index ce9f78cf591..a6814a5302f 100644
--- a/common/web/types/src/kpj/keyman-developer-project.ts
+++ b/common/web/types/src/kpj/keyman-developer-project.ts
@@ -1,5 +1,5 @@
//
-// Version 1.0 of Keyman Developer Project .kpj file
+// Version 1.0 and 2.0 of Keyman Developer Project .kpj file
//
import { KeymanFileTypes } from '../main.js';
@@ -9,11 +9,17 @@ export class KeymanDeveloperProject {
options: KeymanDeveloperProjectOptions;
files: KeymanDeveloperProjectFile[];
projectPath: string = '';
+ readonly projectFile: KeymanDeveloperProjectFile;
- constructor(private projectFilename: string, version: KeymanDeveloperProjectVersion, private callbacks: CompilerCallbacks) {
- this.projectPath = this.callbacks.path.dirname(this.projectFilename);
+ get projectFilename() {
+ return this._projectFilename;
+ }
+
+ constructor(private _projectFilename: string, version: KeymanDeveloperProjectVersion, private callbacks: CompilerCallbacks) {
+ this.projectPath = this.callbacks.path.dirname(this._projectFilename);
this.options = new KeymanDeveloperProjectOptions(version);
this.files = [];
+ this.projectFile = new KeymanDeveloperProjectFile20(_projectFilename, callbacks);
}
/**
* Adds .kmn, .xml, .kps to project based on options.sourcePath
@@ -38,8 +44,6 @@ export class KeymanDeveloperProject {
this.files.push(file);
}
}
-
- this.addMetadataFile();
}
public isKeyboardProject() {
@@ -50,26 +54,32 @@ export class KeymanDeveloperProject {
return !!this.files.find(file => file.fileType == KeymanFileTypes.Source.Model);
}
- public addMetadataFile() {
- const ext = this.isLexicalModelProject() ? KeymanFileTypes.Source.ModelInfo : KeymanFileTypes.Source.KeyboardInfo;
+ private resolveProjectPath(p: string): string {
+ // Replace placeholders in the target path
+ return p.replace('$PROJECTPATH', this.projectPath);
+ }
+
+ getOutputFilePath(type: KeymanFileTypes.Binary) {
+ // Roughly corresponds to Delphi TProject.GetTargetFileName
+ let p = this.options.version == '1.0' ?
+ this.options.buildPath || '$SOURCEPATH' :
+ this.options.buildPath;
- if(this.files.find(file => KeymanFileTypes.filenameIs(file.filename, ext))) {
- return;
+ // Replace placeholders in the target path
+ if(this.options.version == '1.0') {
+ // TODO: do we need to support $VERSION?
+ // $SOURCEPATH only supported in 1.0 projects
+ p = p.replace('$SOURCEPATH', this.callbacks.path.dirname(this._projectFilename));
}
- const infoFile =
- this.callbacks.path.join(this.projectPath,
- this.callbacks.path.basename(this.projectFilename, KeymanFileTypes.Source.Project) + ext);
- this.files.push(new KeymanDeveloperProjectFile20(infoFile, this.callbacks));
- }
+ p = this.resolveProjectPath(p);
- private resolveProjectPath(p: string): string {
- // Replace placeholders in the target path
- return p.replace('$PROJECTPATH', this.projectPath);
+ const f = this.callbacks.path.basename(this._projectFilename, KeymanFileTypes.Source.Project) + type;
+ return this.callbacks.path.normalize(this.callbacks.path.join(p, f));
}
resolveInputFilePath(file: KeymanDeveloperProjectFile): string {
- return this.callbacks.resolveFilename(this.projectFilename, file.filePath);
+ return this.callbacks.resolveFilename(this._projectFilename, file.filePath);
}
resolveOutputFilePath(file: KeymanDeveloperProjectFile, sourceExt: string, targetExt: string): string {
@@ -108,6 +118,11 @@ export class KeymanDeveloperProjectOptions {
compilerWarningsAsErrors: boolean = false;
warnDeprecatedCode: boolean = true;
checkFilenameConventions: boolean = false; // missing option defaults to False
+ /**
+ * Skip building .keyboard_info and .model_info files, for example in
+ * unit tests or for legacy keyboards
+ */
+ skipMetadataFiles: boolean;
projectType: KeymanDeveloperProjectType = KeymanDeveloperProjectType.Keyboard;
readonly version: KeymanDeveloperProjectVersion;
constructor(version: KeymanDeveloperProjectVersion) {
@@ -116,10 +131,12 @@ export class KeymanDeveloperProjectOptions {
case "1.0":
this.buildPath = '';
this.sourcePath = '';
+ this.skipMetadataFiles = true;
break;
case "2.0":
this.buildPath = '$PROJECTPATH/build';
this.sourcePath = '$PROJECTPATH/source';
+ this.skipMetadataFiles = false;
break;
default:
throw new Error('Invalid version');
diff --git a/common/web/types/src/kpj/kpj-file-reader.ts b/common/web/types/src/kpj/kpj-file-reader.ts
index 2c8589b5c14..cffa2069c64 100644
--- a/common/web/types/src/kpj/kpj-file-reader.ts
+++ b/common/web/types/src/kpj/kpj-file-reader.ts
@@ -1,11 +1,9 @@
import * as xml2js from 'xml2js';
import { KPJFile, KPJFileProject } from './kpj-file.js';
-import { default as AjvModule } from 'ajv';
-const Ajv = AjvModule.default; // The actual expected Ajv type.
import { boxXmlArray } from '../util/util.js';
import { KeymanDeveloperProject, KeymanDeveloperProjectFile10, KeymanDeveloperProjectType } from './keyman-developer-project.js';
import { CompilerCallbacks } from '../util/compiler-interfaces.js';
-import Schemas from '../schemas.js';
+import SchemaValidators from '../schema-validators.js';
export class KPJFileReader {
constructor(private callbacks: CompilerCallbacks) {
@@ -35,13 +33,11 @@ export class KPJFileReader {
}
public validate(source: KPJFile): void {
- const ajv = new Ajv();
- if(!ajv.validate(Schemas.kpj, source)) {
- const ajvLegacy = new Ajv();
- if(!ajvLegacy.validate(Schemas.kpj90, source)) {
+ if(!SchemaValidators.kpj(source)) {
+ if(!SchemaValidators.kpj90(source)) {
// If the legacy schema also does not validate, then we will only report
// the errors against the modern schema
- throw new Error(ajv.errorsText());
+ throw new Error((SchemaValidators.kpj).errors);
}
}
}
@@ -62,8 +58,10 @@ export class KPJFileReader {
if(result.options.version == '2.0') {
result.options.buildPath = (project.Options?.BuildPath || result.options.buildPath).replace(/\\/g, '/');
result.options.sourcePath = (project.Options?.SourcePath || result.options.sourcePath).replace(/\\/g, '/');
+ result.options.skipMetadataFiles = this.boolFromString(project.Options?.SkipMetadataFiles, false);
} else {
result.options.buildPath = (project.Options?.BuildPath || '').replace(/\\/g, '/');
+ result.options.skipMetadataFiles = this.boolFromString(project.Options?.SkipMetadataFiles, true);
}
result.options.checkFilenameConventions = this.boolFromString(project.Options?.CheckFilenameConventions, false);
result.options.compilerWarningsAsErrors = this.boolFromString(project.Options?.CompilerWarningsAsErrors, false);
@@ -75,7 +73,6 @@ export class KPJFileReader {
if(result.options.version == '1.0') {
this.transformFilesVersion10(project, result);
- result.addMetadataFile();
} else {
result.populateFiles();
}
diff --git a/common/web/types/src/kpj/kpj-file.ts b/common/web/types/src/kpj/kpj-file.ts
index 317f24d013c..1c7da704378 100644
--- a/common/web/types/src/kpj/kpj-file.ts
+++ b/common/web/types/src/kpj/kpj-file.ts
@@ -20,6 +20,7 @@ export interface KPJFileOptions {
SourcePath?: string; // default '' in 1.0, '$PROJECTPATH/source' in 2.0
CompilerWarningsAsErrors?: string; // default False
WarnDeprecatedCode?: string; // default True
+ SkipMetadataFiles?: string; // default True for 1.0, False for 2.0
CheckFilenameConventions?: string; // default False
ProjectType?: 'keyboard' | 'lexicalmodel'; // default 'keyboard'
Version?: '1.0' | '2.0'; // default 1.0
diff --git a/common/web/types/src/kvk/kvk-file.ts b/common/web/types/src/kvk/kvk-file.ts
index ca3f522e72d..ff99adca5df 100644
--- a/common/web/types/src/kvk/kvk-file.ts
+++ b/common/web/types/src/kvk/kvk-file.ts
@@ -49,6 +49,7 @@ export interface BUILDER_KVK_KEY {
export const BUILDER_KVK_KEY_Size = 9; // size of fixed elements of BUILDER_KVK_KEY
export const enum BUILDER_KVK_HEADER_FLAGS {
+ kvkhNone = 0x00, // no flags
kvkh102 = 0x01,
kvkhDisplayUnderlying = 0x02,
kvkhUseUnderlying = 0x04,
@@ -122,4 +123,4 @@ export default class KVKFile {
});
}
-};
\ No newline at end of file
+};
diff --git a/common/web/types/src/kvk/kvks-file-reader.ts b/common/web/types/src/kvk/kvks-file-reader.ts
index c9808d0b934..70967df0538 100644
--- a/common/web/types/src/kvk/kvks-file-reader.ts
+++ b/common/web/types/src/kvk/kvks-file-reader.ts
@@ -1,12 +1,10 @@
import * as xml2js from 'xml2js';
import KVKSourceFile from './kvks-file.js';
-import { default as AjvModule } from 'ajv';
-const Ajv = AjvModule.default; // The actual expected Ajv type.
import { boxXmlArray } from '../util/util.js';
import { DEFAULT_KVK_FONT, VisualKeyboard, VisualKeyboardHeaderFlags, VisualKeyboardKey, VisualKeyboardKeyFlags, VisualKeyboardLegalShiftStates, VisualKeyboardShiftState } from './visual-keyboard.js';
import { USVirtualKeyCodes } from '../consts/virtual-key-constants.js';
import { BUILDER_KVK_HEADER_VERSION, KVK_HEADER_IDENTIFIER_BYTES } from './kvk-file.js';
-import Schemas from '../schemas.js';
+import SchemaValidators from '../schema-validators.js';
export default class KVKSFileReader {
@@ -85,9 +83,8 @@ export default class KVKSFileReader {
}
public validate(source: KVKSourceFile): void {
- const ajv = new Ajv();
- if(!ajv.validate(Schemas.kvks, source)) {
- throw new Error(ajv.errorsText());
+ if(!SchemaValidators.kvks(source)) {
+ throw new Error((SchemaValidators.kvks).errorsText());
}
}
diff --git a/common/web/types/src/ldml-keyboard/ldml-keyboard-xml-reader.ts b/common/web/types/src/ldml-keyboard/ldml-keyboard-xml-reader.ts
index 3fdd9a74025..5e7c1ab2d30 100644
--- a/common/web/types/src/ldml-keyboard/ldml-keyboard-xml-reader.ts
+++ b/common/web/types/src/ldml-keyboard/ldml-keyboard-xml-reader.ts
@@ -1,13 +1,11 @@
import * as xml2js from 'xml2js';
-import { LDMLKeyboardXMLSourceFile, LKImport } from './ldml-keyboard-xml.js';
-import { default as AjvModule } from 'ajv';
-const Ajv = AjvModule.default; // The actual expected Ajv type.
+import { LDMLKeyboardXMLSourceFile, LKImport, ImportStatus } from './ldml-keyboard-xml.js';
import { boxXmlArray } from '../util/util.js';
import { CompilerCallbacks } from '../util/compiler-interfaces.js';
import { constants } from '@keymanapp/ldml-keyboard-constants';
import { CommonTypesMessages } from '../util/common-events.js';
import { LDMLKeyboardTestDataXMLSourceFile, LKTTest, LKTTests } from './ldml-keyboard-testdata-xml.js';
-import Schemas from '../schemas.js';
+import SchemaValidators from '../schema-validators.js';
interface NameAndProps {
'$'?: any; // content
@@ -49,11 +47,18 @@ export class LDMLKeyboardXMLSourceFileReader {
if (!source.keyboard3.keys.import) {
source.keyboard3.keys.import = [];
}
+ if (!source.keyboard3.forms) {
+ source.keyboard3.forms = {
+ form: [],
+ };
+ }
+ if (!source.keyboard3.forms.import) {
+ source.keyboard3.forms.import = [];
+ }
}
boxXmlArray(source?.keyboard3, 'layers');
boxXmlArray(source?.keyboard3?.displays, 'display');
boxXmlArray(source?.keyboard3?.names, 'name');
- boxXmlArray(source?.keyboard3?.vkeys, 'vkey');
boxXmlArray(source?.keyboard3?.keys, 'key');
boxXmlArray(source?.keyboard3?.keys, 'flicks');
boxXmlArray(source?.keyboard3?.locales, 'locale');
@@ -68,6 +73,12 @@ export class LDMLKeyboardXMLSourceFileReader {
}
}
}
+ if(source?.keyboard3?.forms?.form) {
+ boxXmlArray(source?.keyboard3?.forms, 'form');
+ for(let form of source?.keyboard3?.forms?.form) {
+ boxXmlArray(form, 'scanCodes');
+ }
+ }
if(source?.keyboard3?.keys?.flicks) {
for(let flicks of source?.keyboard3?.keys?.flicks) {
boxXmlArray(flicks, 'flick');
@@ -149,7 +160,15 @@ export class LDMLKeyboardXMLSourceFileReader {
if (!this.resolveOneImport(obj, subtag, {
base: constants.cldr_import_base,
path: constants.cldr_implied_keys_import
- })) {
+ }, true)) {
+ return false;
+ }
+ } else if (subtag === 'forms') {
+ //
+ if (!this.resolveOneImport(obj, subtag, {
+ base: constants.cldr_import_base,
+ path: constants.cldr_implied_forms_import
+ }, true)) {
return false;
}
}
@@ -160,9 +179,10 @@ export class LDMLKeyboardXMLSourceFileReader {
* @param obj the object being imported into
* @param subtag obj's element tag, e.g. `keys`
* @param asImport the import structure
+ * @param implied true if it is an implied import
* @returns true on success, false on failure
*/
- private resolveOneImport(obj: any, subtag: string, asImport: LKImport) : boolean {
+ private resolveOneImport(obj: any, subtag: string, asImport: LKImport, implied? : boolean) : boolean {
const { base, path } = asImport;
if (base !== constants.cldr_import_base) {
this.callbacks.reportMessage(CommonTypesMessages.Error_ImportInvalidBase({base, path, subtag}));
@@ -189,12 +209,20 @@ export class LDMLKeyboardXMLSourceFileReader {
// pull all children of importXml[subtag] into obj
for (const subsubtag of Object.keys(importRootNode).reverse()) { // e.g.
const subsubval = importRootNode[subsubtag];
+ const basePath = `${base}/${path}`;
if (!Array.isArray(subsubval)) {
// This is somewhat of an internal error, indicating that a non-mergeable XML file was imported
// Not exercisable with the standard LDML imports.
this.callbacks.reportMessage(CommonTypesMessages.Error_ImportMergeFail({base, path, subtag, subsubtag}));
return false;
}
+ // Mark all children as an import
+ subsubval.forEach(o => o[ImportStatus.import] = basePath);
+ if (implied) {
+ // mark all children as an implied import
+ subsubval.forEach(o => o[ImportStatus.impliedImport] = basePath);
+ }
+
if (!obj[subsubtag]) {
obj[subsubtag] = []; // start with empty array
}
@@ -207,9 +235,8 @@ export class LDMLKeyboardXMLSourceFileReader {
* @returns true if valid, false if invalid
*/
public validate(source: LDMLKeyboardXMLSourceFile | LDMLKeyboardTestDataXMLSourceFile): boolean {
- const ajv = new Ajv();
- if(!ajv.validate(Schemas.ldmlKeyboard3, source)) {
- for (let err of ajv.errors) {
+ if(!SchemaValidators.ldmlKeyboard3(source)) {
+ for (let err of (SchemaValidators.ldmlKeyboard3).errors) {
this.callbacks.reportMessage(CommonTypesMessages.Error_SchemaValidationError({
instancePath: err.instancePath,
keyword: err.keyword,
diff --git a/common/web/types/src/ldml-keyboard/ldml-keyboard-xml.ts b/common/web/types/src/ldml-keyboard/ldml-keyboard-xml.ts
index 629b8e8aa24..83720312dd8 100644
--- a/common/web/types/src/ldml-keyboard/ldml-keyboard-xml.ts
+++ b/common/web/types/src/ldml-keyboard/ldml-keyboard-xml.ts
@@ -12,7 +12,7 @@ export interface LDMLKeyboardXMLSourceFile {
* -- the root element.
*/
keyboard3: LKKeyboard;
-}
+};
export interface LKKeyboard {
locale?: string;
@@ -24,9 +24,9 @@ export interface LKKeyboard {
names?: LKNames;
settings?: LKSettings;
keys?: LKKeys;
+ forms?: LKForms;
displays?: LKDisplays;
layers?: LKLayers[];
- vkeys?: LKVkeys;
variables?: LKVariables;
transforms?: LKTransforms[];
};
@@ -128,15 +128,6 @@ export interface LKRow {
keys?: string;
};
-export interface LKVkeys {
- vkey?: LKVkey[];
-};
-
-export interface LKVkey {
- from?: string;
- to?: string;
-};
-
export interface LKVariables {
string?: LKString[];
set?: LKSet[];
@@ -193,3 +184,36 @@ export interface LKDisplays {
display?: LKDisplay[];
displayOptions?: LKDisplayOptions;
};
+
+export interface LKForms {
+ form?: LKForm[];
+};
+
+export interface LKForm {
+ id?: string;
+ scanCodes?: LKScanCodes[];
+};
+
+export interface LKScanCodes {
+ codes?: string;
+};
+
+/**
+ * Utilities for determining the import status of items
+ */
+export class ImportStatus {
+ /** item came in via implied (spec based) import, such as keys-Latn-implied.xml */
+ static impliedImport = Symbol('LDML implied import');
+ /** item came in via import */
+ static import = Symbol('LDML import');
+
+ /** @returns true if the object was loaded through an implied import */
+ static isImpliedImport(o : any) : boolean {
+ return o && !!o[ImportStatus.impliedImport];
+ }
+ /** @returns true if the object was loaded through an explicit import */
+ static isImport(o : any) : boolean {
+ return o && !!o[ImportStatus.import];
+ }
+};
+
diff --git a/common/web/types/src/ldml-keyboard/pattern-parser.ts b/common/web/types/src/ldml-keyboard/pattern-parser.ts
index f6013248d26..b0d6fb07962 100644
--- a/common/web/types/src/ldml-keyboard/pattern-parser.ts
+++ b/common/web/types/src/ldml-keyboard/pattern-parser.ts
@@ -65,6 +65,15 @@ export class MarkerParser {
/** Max count of markers */
public static readonly MAX_MARKER_COUNT = constants.marker_max_count;
+ private static anyMarkerMatch() : string {
+ const start = (`0000` + (this.MIN_MARKER_INDEX).toString(16)).slice(-4);
+ const end = (`0000` + (this.MAX_MARKER_INDEX).toString(16)).slice(-4);
+ return `${this.SENTINEL}${this.MARKER_CODE}[\\u${start}-\\u${end}]`;
+ }
+
+ /** Expression that matches any marker */
+ public static readonly ANY_MARKER_MATCH = MarkerParser.anyMarkerMatch();
+
/**
* Pattern for matching a marker reference, OR the special marker \m{.}
*/
@@ -91,10 +100,13 @@ export class MarkerParser {
}
/** @returns all marker strings as sentinel values */
- public static toSentinelString(s: string, markers?: OrderedStringList) : string {
+ public static toSentinelString(s: string, markers?: OrderedStringList, forMatch?: boolean) : string {
if (!s) return s;
return s.replaceAll(this.REFERENCE, (sub, arg) => {
if (arg === MarkerParser.ANY_MARKER_ID) {
+ if (forMatch) {
+ return this.ANY_MARKER_MATCH;
+ }
return MarkerParser.markerOutput(MarkerParser.ANY_MARKER_INDEX);
}
if (!markers) {
@@ -103,10 +115,10 @@ export class MarkerParser {
const order = markers.getItemOrder(arg);
if (order === -1) {
throw RangeError(`Internal Error: Could not find marker \\m{${arg}}`);
- } else if(order >= MarkerParser.MAX_MARKER_INDEX) {
+ } else if(order > MarkerParser.MAX_MARKER_INDEX) {
throw RangeError(`Internal Error: marker \\m{${arg}} has out of range index ${order}`);
} else {
- return MarkerParser.markerOutput(order+1);
+ return MarkerParser.markerOutput(order + 1);
}
});
}
diff --git a/common/web/types/src/main.ts b/common/web/types/src/main.ts
index 430b88cdc3d..108a2d57c29 100644
--- a/common/web/types/src/main.ts
+++ b/common/web/types/src/main.ts
@@ -25,7 +25,9 @@ export { defaultCompilerOptions, CompilerBaseOptions, CompilerCallbacks, Compile
CompilerErrorSeverity, CompilerPathCallbacks, CompilerFileSystemCallbacks, CompilerCallbackOptions,
CompilerError, CompilerMessageSpec, compilerErrorSeverity, CompilerErrorMask, CompilerFileCallbacks, compilerErrorSeverityName,
compilerExceptionToString, compilerErrorFormatCode,
- compilerLogLevelToSeverity, CompilerLogLevel, compilerEventFormat, ALL_COMPILER_LOG_LEVELS } from './util/compiler-interfaces.js';
+ compilerLogLevelToSeverity, CompilerLogLevel, compilerEventFormat, ALL_COMPILER_LOG_LEVELS,
+ ALL_COMPILER_LOG_FORMATS, CompilerLogFormat,
+ } from './util/compiler-interfaces.js';
export { CommonTypesMessages } from './util/common-events.js';
export * as TouchLayout from './keyman-touch-layout/keyman-touch-layout-file.js';
@@ -45,4 +47,5 @@ export * as KeymanFileTypes from './util/file-types.js';
export * as Osk from './osk/osk.js';
-export * as Schemas from './schemas.js';
\ No newline at end of file
+export * as Schemas from './schemas.js';
+export * as SchemaValidators from './schema-validators.js';
\ No newline at end of file
diff --git a/common/web/types/src/osk/osk.ts b/common/web/types/src/osk/osk.ts
index 620712baeb2..9c7d1bf04c4 100644
--- a/common/web/types/src/osk/osk.ts
+++ b/common/web/types/src/osk/osk.ts
@@ -1,8 +1,6 @@
import { TouchLayoutFile, TouchLayoutFlick, TouchLayoutKey, TouchLayoutPlatform, TouchLayoutSubKey } from "src/keyman-touch-layout/keyman-touch-layout-file.js";
import { VisualKeyboard } from "../kvk/visual-keyboard.js";
-import { default as AjvModule } from 'ajv';
-import Schemas from "../schemas.js";
-const Ajv = AjvModule.default; // The actual expected Ajv type.
+import SchemaValidators from "../schema-validators.js";
export interface StringRefUsage {
filename: string;
@@ -24,11 +22,10 @@ export interface StringResult {
export type PuaMap = {[index:string]: string};
export function parseMapping(mapping: any) {
- const ajv = new Ajv();
- if(!ajv.validate(Schemas.displayMap, mapping))
+ if(!SchemaValidators.displayMap(mapping))
/* c8 ignore next 3 */
{
- throw new Error(ajv.errorsText());
+ throw new Error((SchemaValidators.displayMap).errorsText());
}
let map: PuaMap = {};
diff --git a/common/web/types/src/package/kmp-json-file.ts b/common/web/types/src/package/kmp-json-file.ts
index 913bc98f06e..ae88b5ba3e9 100644
--- a/common/web/types/src/package/kmp-json-file.ts
+++ b/common/web/types/src/package/kmp-json-file.ts
@@ -6,6 +6,7 @@ export interface KmpJsonFile {
lexicalModels?: KmpJsonFileLexicalModel[];
startMenu?: KmpJsonFileStartMenu;
keyboards?: KmpJsonFileKeyboard[];
+ relatedPackages?: KmpJsonRelatedPackage[];
}
export interface KmpJsonFileSystem {
@@ -16,6 +17,8 @@ export interface KmpJsonFileSystem {
export interface KmpJsonFileOptions {
readmeFile?: string;
graphicFile?: string;
+ licenseFile?: string;
+ welcomeFile?: string;
executeProgram?: string;
msiFilename?: string;
msiOptions?: string;
@@ -27,6 +30,11 @@ export interface KmpJsonFileInfo {
name?: KmpJsonFileInfoItem;
copyright?: KmpJsonFileInfoItem;
author?: KmpJsonFileInfoItem;
+ /**
+ * A Markdown description of the keyboard, intended for use in websites
+ * referencing the keyboard
+ */
+ description?: KmpJsonFileInfoItem;
}
export interface KmpJsonFileInfoItem {
@@ -59,6 +67,15 @@ export interface KmpJsonFileKeyboard {
displayFont?: string;
rtl?: boolean;
languages?: KmpJsonFileLanguage[];
+ examples?: KmpJsonFileExample[];
+ /**
+ * array of web font alternatives for OSK. should be same font data as oskFont
+ */
+ webOskFonts?: string[];
+ /**
+ * array of web font alternatives for display. should be same font data as displayFont
+ */
+ webDisplayFonts?: string[];
}
export interface KmpJsonFileStartMenu {
@@ -74,3 +91,37 @@ export interface KmpJsonFileStartMenuItem {
icon?: string;
location?: string;
}
+
+export interface KmpJsonFileExample {
+ /**
+ * BCP 47 identifier for the example
+ */
+ id: string;
+ /**
+ * A space-separated list of keys.
+ * - modifiers indicated with "+"
+ * - spacebar is "space"
+ * - plus key is "shift+=" or "plus" on US English (all other punctuation as per key cap).
+ * - Hardware modifiers are: "shift", "ctrl", "alt", "left-ctrl",
+ * "right-ctrl", "left-alt", "right-alt"
+ * - Key caps should generally be their character for desktop (Latin script
+ * case insensitive), or the actual key cap for touch
+ * - Caps Lock should be indicated with "caps-on", "caps-off"
+ *
+ * e.g. "shift+a b right-alt+c space plus z z z" represents something like: "Ab{AltGr+C} +zzz"
+ */
+ keys: string;
+ /**
+ * The text that would be generated by typing those keys
+ */
+ text?: string;
+ /**
+ * A short description of what the text means or represents
+ */
+ note?: string;
+}
+
+export interface KmpJsonRelatedPackage {
+ id: string;
+ relationship: "deprecates" | "related";
+}
diff --git a/common/web/types/src/package/kps-file.ts b/common/web/types/src/package/kps-file.ts
index 7ff77d09846..7c7ba12c879 100644
--- a/common/web/types/src/package/kps-file.ts
+++ b/common/web/types/src/package/kps-file.ts
@@ -17,40 +17,44 @@ export interface KpsPackage {
/**
* -- the root element.
*/
- package: KpsFile;
+ Package: KpsFile;
}
export interface KpsFile {
- system: KpsFileSystem;
- options: KpsFileOptions;
- info?: KpsFileInfo;
- files?: KpsFileContentFiles;
- keyboards?: KpsFileKeyboards;
- lexicalModels?: KpsFileLexicalModels;
- startMenu?: KpsFileStartMenu;
- strings?: KpsFileStrings;
+ System: KpsFileSystem;
+ Options: KpsFileOptions;
+ Info?: KpsFileInfo;
+ Files?: KpsFileContentFiles;
+ Keyboards?: KpsFileKeyboards;
+ LexicalModels?: KpsFileLexicalModels;
+ StartMenu?: KpsFileStartMenu;
+ Strings?: KpsFileStrings;
+ RelatedPackages?: KpsFileRelatedPackages;
}
export interface KpsFileSystem {
- keymanDeveloperVersion: string;
- fileVersion: string;
+ KeymanDeveloperVersion: string;
+ FileVersion: string;
}
export interface KpsFileOptions {
- followKeyboardVersion?: string;
- readMeFile?: string;
- graphicFile?: string;
- executeProgram?: string;
- msiFileName?: string;
- msiOptions?: string;
+ FollowKeyboardVersion?: string;
+ ReadMeFile?: string;
+ GraphicFile?: string;
+ LicenseFile?: string;
+ WelcomeFile?: string;
+ ExecuteProgram?: string;
+ MsiFileName?: string;
+ MsiOptions?: string;
}
export interface KpsFileInfo {
- name?: KpsFileInfoItem;
- copyright?: KpsFileInfoItem;
- author?: KpsFileInfoItem;
- webSite?: KpsFileInfoItem;
- version?: KpsFileInfoItem;
+ Name?: KpsFileInfoItem;
+ Copyright?: KpsFileInfoItem;
+ Author?: KpsFileInfoItem;
+ WebSite?: KpsFileInfoItem;
+ Version?: KpsFileInfoItem;
+ Description?: KpsFileInfoItem;
}
export interface KpsFileInfoItem {
@@ -59,28 +63,31 @@ export interface KpsFileInfoItem {
}
export interface KpsFileContentFiles {
- file: KpsFileContentFile[] | KpsFileContentFile;
+ File: KpsFileContentFile[] | KpsFileContentFile;
}
export interface KpsFileContentFile {
- name: string;
- description: string;
- copyLocation: string;
- fileType: string;
+ Name: string;
+ /** @deprecated */
+ Description: string;
+ /** @deprecated */
+ CopyLocation: string;
+ /** @deprecated */
+ FileType: string;
}
export interface KpsFileLexicalModel {
- name: string;
- iD: string;
- languages: KpsFileLanguages;
+ Name: string;
+ ID: string;
+ Languages: KpsFileLanguages;
}
export interface KpsFileLexicalModels {
- lexicalModel: KpsFileLexicalModel[] | KpsFileLexicalModel;
+ LexicalModel: KpsFileLexicalModel[] | KpsFileLexicalModel;
}
export interface KpsFileLanguages {
- language: KpsFileLanguage[] | KpsFileLanguage;
+ Language: KpsFileLanguage[] | KpsFileLanguage;
}
export interface KpsFileLanguage {
@@ -88,39 +95,116 @@ export interface KpsFileLanguage {
$: { ID: string }
}
+export interface KpsFileRelatedPackages {
+ RelatedPackage: KpsFileRelatedPackage | KpsFileRelatedPackage[];
+}
+
+export interface KpsFileRelatedPackage {
+ $: {
+ ID: string;
+ /**
+ * relationship between this package and the related package, "related" is default if not specified
+ */
+ Relationship?: "deprecates";
+ }
+}
+
export interface KpsFileKeyboard {
- name: string; /// the descriptive name of the keyboard
- iD: string; /// the keyboard identifier, equal to the basename of the keyboard file sans extension
- version: string;
- oSKFont?: string;
- displayFont?: string;
- rTL?: string;
- languages?: KpsFileLanguages;
+ Name: string; /// the descriptive name of the keyboard
+ ID: string; /// the keyboard identifier, equal to the basename of the keyboard file sans extension
+ Version: string;
+ OSKFont?: string;
+ DisplayFont?: string;
+ RTL?: string;
+ Languages?: KpsFileLanguages;
+ Examples?: KpsFileLanguageExamples;
+ /**
+ * array of web font alternatives for OSK. should be same font data as oskFont
+ */
+ WebOSKFonts?: KpsFileFonts;
+ /**
+ * array of web font alternatives for display. should be same font data as displayFont
+ */
+ WebDisplayFonts?: KpsFileFonts;
+}
+
+export interface KpsFileFonts {
+ Font: KpsFileFont[] | KpsFileFont;
+}
+
+export interface KpsFileFont {
+ $: {
+ Filename: string;
+ }
}
export interface KpsFileKeyboards {
- keyboard: KpsFileKeyboard[] | KpsFileKeyboard;
+ Keyboard: KpsFileKeyboard[] | KpsFileKeyboard;
}
export interface KpsFileStartMenu {
- folder?: string;
- addUninstallEntry?: string;
- items?: KpsFileStartMenuItems;
+ Folder?: string;
+ AddUninstallEntry?: string;
+ Items?: KpsFileStartMenuItems;
}
export interface KpsFileStartMenuItem {
- name: string;
- fileName: string;
- arguments?: string;
- icon?: string;
- location?: string;
+ Name: string;
+ FileName: string;
+ Arguments?: string;
+ Icon?: string;
+ Location?: string;
}
export interface KpsFileStartMenuItems {
- item: KpsFileStartMenuItem[] | KpsFileStartMenuItem;
+ Item: KpsFileStartMenuItem[] | KpsFileStartMenuItem;
}
export interface KpsFileStrings {
- //TODO: validate this structure
- string: string[] | string;
+ String: KpsFileString[] | KpsFileString;
+}
+
+export interface KpsFileString {
+ $: {
+ Name: string;
+ Value: string;
+ }
+}
+
+export interface KpsFileLanguageExamples {
+ Example: KpsFileLanguageExample | KpsFileLanguageExample[];
+}
+
+/**
+ * An example key sequence intended to demonstrate how the keyboard works
+ */
+export interface KpsFileLanguageExample {
+ $: {
+ /**
+ * BCP 47 identifier for the example
+ */
+ ID: string;
+ /**
+ * A space-separated list of keys.
+ * - modifiers indicated with "+"
+ * - spacebar is "space"
+ * - plus key is "shift+=" or "plus" on US English (all other punctuation as per key cap).
+ * - Hardware modifiers are: "shift", "ctrl", "alt", "left-ctrl",
+ * "right-ctrl", "left-alt", "right-alt"
+ * - Key caps should generally be their character for desktop (Latin script
+ * case insensitive), or the actual key cap for touch
+ * - Caps Lock should be indicated with "caps-on", "caps-off"
+ *
+ * e.g. "shift+a b right-alt+c space plus z z z" represents something like: "Ab{AltGr+C} +zzz"
+ */
+ Keys: string;
+ /**
+ * The text that would be generated by typing those keys
+ */
+ Text?: string;
+ /**
+ * A short description of what the text means or represents
+ */
+ Note?: string;
+ }
}
diff --git a/common/web/types/src/schema-validators.ts b/common/web/types/src/schema-validators.ts
new file mode 100644
index 00000000000..07bcc032f16
--- /dev/null
+++ b/common/web/types/src/schema-validators.ts
@@ -0,0 +1,25 @@
+import kpj from './schemas/kpj.schema.validator.mjs';
+import kpj90 from './schemas/kpj-9.0.schema.validator.mjs';
+import kvks from './schemas/kvks.schema.validator.mjs';
+import ldmlKeyboard3 from './schemas/ldml-keyboard3.schema.validator.mjs';
+import ldmlKeyboardTest3 from './schemas/ldml-keyboardtest3.schema.validator.mjs';
+import displayMap from './schemas/displaymap.schema.validator.mjs';
+import touchLayoutClean from './schemas/keyman-touch-layout.clean.spec.validator.mjs';
+import touchLayout from './schemas/keyman-touch-layout.spec.validator.mjs';
+import keyboard_info from './schemas/keyboard_info.schema.validator.mjs';
+
+// How to use: https://ajv.js.org/standalone.html#using-the-validation-function-s
+// See also existing uses (search for `SchemaValidators`) for examples.
+const SchemaValidators = {
+ kpj,
+ kpj90,
+ kvks,
+ ldmlKeyboard3,
+ ldmlKeyboardTest3,
+ displayMap,
+ touchLayoutClean,
+ touchLayout,
+ keyboard_info,
+};
+
+export default SchemaValidators;
diff --git a/common/web/types/src/schemas.ts b/common/web/types/src/schemas.ts
index 3d1ce0cbf12..8140f3c0702 100644
--- a/common/web/types/src/schemas.ts
+++ b/common/web/types/src/schemas.ts
@@ -7,6 +7,7 @@ import ldmlKeyboardTest3 from './schemas/ldml-keyboardtest3.schema.js';
import displayMap from './schemas/displaymap.schema.js';
import touchLayoutClean from './schemas/keyman-touch-layout.clean.spec.js';
import touchLayout from './schemas/keyman-touch-layout.spec.js';
+import keyboard_info from './schemas/keyboard_info.schema.js';
const Schemas = {
kpj,
@@ -17,6 +18,7 @@ const Schemas = {
displayMap,
touchLayoutClean,
touchLayout,
+ keyboard_info,
};
export default Schemas;
diff --git a/common/web/types/src/util/compiler-interfaces.ts b/common/web/types/src/util/compiler-interfaces.ts
index 3283fb25981..b27a170ab34 100644
--- a/common/web/types/src/util/compiler-interfaces.ts
+++ b/common/web/types/src/util/compiler-interfaces.ts
@@ -74,11 +74,20 @@ export class CompilerError {
* @param filename
* @returns
*/
- static formatFilename(filename: string): string {
+ static formatFilename(filename: string, options?: {
+ fullPath?: boolean,
+ forwardSlashes?: boolean
+ }): string {
if(!filename) {
return '';
}
+ if(options?.fullPath) {
+ return options?.forwardSlashes ?
+ filename.replaceAll(/\\/g, '/') :
+ filename.replaceAll(/\//g, '\\');
+ }
+
let x = filename.lastIndexOf('/');
if(x < 0) {
x = filename.lastIndexOf('\\');
@@ -239,6 +248,7 @@ export interface CompilerFileSystemCallbacks {
export interface CompilerCallbackOptions {
logLevel?: CompilerLogLevel;
+ logFormat?: CompilerLogFormat;
color?: boolean; // null or undefined == use console default
compilerWarningsAsErrors?: boolean;
};
@@ -355,6 +365,10 @@ export interface CompilerBaseOptions {
* all messages are still reported to the internal log)
*/
logLevel?: CompilerLogLevel;
+ /**
+ * Format of output for log to console
+ */
+ logFormat?: CompilerLogFormat;
/**
* Optional output file for activities that generate output
*/
@@ -390,6 +404,7 @@ export interface CompilerOptions extends CompilerBaseOptions {
export const defaultCompilerOptions: CompilerOptions = {
logLevel: 'info',
+ logFormat: 'formatted',
// outFile: (undefined)
saveDebug: false,
shouldAddCompilerVersion: true,
@@ -443,3 +458,11 @@ export const compilerLogLevelToSeverity: {[index in CompilerLogLevel]: number} =
'info': CompilerErrorSeverity.Info,
'debug': CompilerErrorSeverity.Info
};
+
+export const ALL_COMPILER_LOG_FORMATS = [
+ 'tsv',
+ 'formatted'
+] as const;
+
+type CompilerLogFormatTuple = typeof ALL_COMPILER_LOG_FORMATS;
+export type CompilerLogFormat = CompilerLogFormatTuple[number];
diff --git a/common/web/types/src/util/file-types.ts b/common/web/types/src/util/file-types.ts
index ebad759638a..e3d3bd54523 100644
--- a/common/web/types/src/util/file-types.ts
+++ b/common/web/types/src/util/file-types.ts
@@ -10,9 +10,7 @@ export const enum Source {
LdmlKeyboard = '.xml', // Warning, also other possible uses
Package = '.kps',
VisualKeyboard = '.kvks',
- TouchLayout = '.keyman-touch-layout',
- KeyboardInfo = '.keyboard_info',
- ModelInfo = '.model_info',
+ TouchLayout = '.keyman-touch-layout'
};
/**
@@ -26,9 +24,7 @@ export const ALL_SOURCE: ReadonlyArray = [
Source.LdmlKeyboard,
Source.Package,
Source.VisualKeyboard,
- Source.TouchLayout,
- Source.KeyboardInfo,
- Source.ModelInfo,
+ Source.TouchLayout
] as const;
/**
diff --git a/common/web/types/test/helpers/index.ts b/common/web/types/test/helpers/index.ts
index e92b9656bfa..9b2be1d6056 100644
--- a/common/web/types/test/helpers/index.ts
+++ b/common/web/types/test/helpers/index.ts
@@ -1,5 +1,5 @@
-import path from "path";
-import fs from "fs";
+import * as path from "path";
+import * as fs from "fs";
import { fileURLToPath } from "url";
/**
diff --git a/common/web/types/test/kpj/test-kpj-file-reader.ts b/common/web/types/test/kpj/test-kpj-file-reader.ts
index 2c3a5c383b9..12c1e7a134e 100644
--- a/common/web/types/test/kpj/test-kpj-file-reader.ts
+++ b/common/web/types/test/kpj/test-kpj-file-reader.ts
@@ -23,6 +23,7 @@ describe('kpj-file-reader', function () {
assert.equal(kpj.KeymanDeveloperProject.Options.CompilerWarningsAsErrors, 'True');
assert.equal(kpj.KeymanDeveloperProject.Options.ProjectType, 'keyboard');
assert.equal(kpj.KeymanDeveloperProject.Options.WarnDeprecatedCode, 'True');
+ assert.isUndefined(kpj.KeymanDeveloperProject.Options.SkipMetadataFiles); // because this is a 1.0 version file
assert.isUndefined(kpj.KeymanDeveloperProject.Options.Version);
assert.lengthOf(kpj.KeymanDeveloperProject.Files.File, 21);
@@ -73,9 +74,10 @@ describe('kpj-file-reader', function () {
assert.isTrue(project.options.compilerWarningsAsErrors);
assert.equal(project.options.projectType, KeymanDeveloperProjectType.Keyboard);
assert.isTrue(project.options.warnDeprecatedCode);
+ assert.isTrue(project.options.skipMetadataFiles);
assert.equal(project.options.version, '1.0');
- assert.lengthOf(project.files, 3);
+ assert.lengthOf(project.files, 2);
let f: KeymanDeveloperProjectFile10 = project.files[0];
assert.equal(f.id, 'id_f347675c33d2e6b1c705c787fad4941a');
diff --git a/common/web/types/test/ldml-keyboard/test-ldml-keyboard-xml-reader.ts b/common/web/types/test/ldml-keyboard/test-ldml-keyboard-xml-reader.ts
index 4da7a006636..43429676a0a 100644
--- a/common/web/types/test/ldml-keyboard/test-ldml-keyboard-xml-reader.ts
+++ b/common/web/types/test/ldml-keyboard/test-ldml-keyboard-xml-reader.ts
@@ -1,8 +1,9 @@
-import { LKKey } from './../../src/ldml-keyboard/ldml-keyboard-xml.js';
+import { LKKey, ImportStatus } from './../../src/ldml-keyboard/ldml-keyboard-xml.js';
import 'mocha';
import {assert} from 'chai';
import { CommonTypesMessages } from '../../src/util/common-events.js';
import { testReaderCases } from '../helpers/reader-callback-test.js';
+import { CLDRScanToVkey, CLDRScanToKeyMap, USVirtualKeyCodes } from '../../src/consts/virtual-key-constants.js';
function pluckKeysFromKeybag(keys: LKKey[], ids: string[]) {
return keys.filter(({id}) => ids.indexOf(id) !== -1);
@@ -40,6 +41,9 @@ describe('ldml keyboard xml reader tests', function () {
{id: 'b', to: 'b'},
{id: 'c', to: 'c'},
]);
+ // all of the keys are implied imports here
+ assert.isTrue(ImportStatus.isImpliedImport(source?.keyboard3?.keys.key.find(({id}) => id === 'a')));
+ assert.isTrue(ImportStatus.isImport(source?.keyboard3?.keys.key.find(({id}) => id === 'a')));
},
},
{
@@ -81,6 +85,15 @@ describe('ldml keyboard xml reader tests', function () {
{id: 'zz', to: 'zz'}, // new key
{id: 'hash', to: '##'}, // override
]);
+ // 'a' is an implied import
+ assert.isTrue(ImportStatus.isImpliedImport(k.find(({id}) => id === 'a')));
+ assert.isTrue(ImportStatus.isImport(k.find(({id}) => id === 'a')));
+ // 'hash' is an import but not implied
+ assert.isFalse(ImportStatus.isImpliedImport(k.find(({id}) => id === 'hash')));
+ assert.isTrue(ImportStatus.isImport(k.find(({id}) => id === 'hash')));
+ // 'zz' is not imported
+ assert.isFalse(ImportStatus.isImpliedImport(k.find(({id}) => id === 'zz')));
+ assert.isFalse(ImportStatus.isImport(k.find(({id}) => id === 'zz')));
},
},
{
@@ -129,3 +142,41 @@ describe('ldml keyboard xml reader tests', function () {
},
]);
});
+
+describe('check scan code routines', () => {
+ it('should be able to detect bad single scancodes', () => {
+ const badScans = new Set();
+ const ckey = CLDRScanToVkey(0xFF, badScans);
+ assert.isUndefined(ckey, `expected undefined 0xFF`);
+ assert.equal(badScans.size, 1);
+ assert.sameDeepMembers(Array.from(badScans.values()), [0xFF]);
+ });
+ it('should be able to detect bad list scancodes', () => {
+ const badScans = new Set();
+ const ckeys = CLDRScanToKeyMap([[0x02, 0xFF]], badScans);
+ assert.sameDeepMembers(ckeys, [[49, undefined]]);
+ assert.equal(badScans.size, 1);
+ assert.sameDeepMembers(Array.from(badScans.values()), [0xFF]);
+ });
+ it('CLDRScanToUSVirtualKeyCodes should be 1:1', () => {
+ const vkeyToScan = new Map();
+ // check all scancodes
+ for (let scan = 0; scan <= 0xFF; scan++) {
+ const vkey = CLDRScanToVkey(scan);
+ if (vkey === undefined) {
+ // not mapped, which is OK
+ continue;
+ }
+ if (scan === 0x56 || scan === 0x7D) {
+ // These both can map to this scancode
+ assert.equal(vkey, USVirtualKeyCodes.K_oE2);
+ } else {
+ // don't check those exceptions
+ assert.isFalse(vkeyToScan.has(vkey),
+ `vkey ${vkey} mapped from more than one scancode: ${Number(vkeyToScan.get(vkey)).toString(16)} and ${Number(scan).toString(16)}`);
+ }
+ // do make sure nothing else maps to that vkey
+ vkeyToScan.set(vkey, scan);
+ }
+ });
+});
diff --git a/common/web/types/test/ldml-keyboard/test-pattern-parser.ts b/common/web/types/test/ldml-keyboard/test-pattern-parser.ts
index e7f06a1c557..0274f2a5c27 100644
--- a/common/web/types/test/ldml-keyboard/test-pattern-parser.ts
+++ b/common/web/types/test/ldml-keyboard/test-pattern-parser.ts
@@ -75,6 +75,7 @@ describe('Test of Pattern Parsers', () => {
'a': 0,
'b': 1,
'c': 2,
+ 'zz': MarkerParser.MAX_MARKER_INDEX - 1, // this is an ordering, so needs to be -1
'zzz': 0x2FFFFF,
};
const o = m[item];
@@ -103,6 +104,21 @@ describe('Test of Pattern Parsers', () => {
markers
)
);
+ // verify the matching behavior of these
+ assert.isTrue(new RegExp(MarkerParser.toSentinelString(`^Q\\m{a}$`, markers, true), 'u')
+ .test(MarkerParser.toSentinelString(`Q\\m{a}`, markers, false)), `Q\\m{a} did not match`);
+ assert.isFalse(new RegExp(MarkerParser.toSentinelString(`^Q\\m{a}$`, markers, true), 'u')
+ .test(MarkerParser.toSentinelString(`Q\\m{b}`, markers, false)), `Q\\m{a} should not match Q\\m{b}`);
+ assert.isTrue(new RegExp(MarkerParser.toSentinelString(`^Q\\m{.}$`, markers, true), 'u')
+ .test(MarkerParser.toSentinelString(`Q\\m{a}`, markers, false)), `Q\\m{.} did not match Q\\m{a}`);
+ assert.isTrue(new RegExp(MarkerParser.toSentinelString(`^Q\\m{.}$`, markers, true), 'u')
+ .test(MarkerParser.toSentinelString(`Q\\m{zz}`, markers, false)), `Q\\m{.} did not match Q\\m{zz} (max marker)`);
+ assert.isFalse(new RegExp(MarkerParser.toSentinelString(`^Q\\m{.}$`, markers, true), 'u')
+ .test(MarkerParser.toSentinelString(`\\m{a}`, markers, false)), `Q\\m{.} did not match \\m{a}`);
+ assert.isTrue(new RegExp(MarkerParser.toSentinelString(`^\\m{.}$`, markers, true), 'u')
+ .test(MarkerParser.toSentinelString(`\\m{a}`, markers, false)), `\\m{.} did not match \\m{a}`);
+ assert.isFalse(new RegExp(MarkerParser.toSentinelString(`^\\m{.}$`, markers, true), 'u')
+ .test(MarkerParser.toSentinelString(`\\m{a}\\m{b}`, markers, false)), `\\m{.} did not match \\m{a}\\m{b}`);
});
it('should match some marker constants', () => {
assert.equal(constants.uc_sentinel, KMXFile.UC_SENTINEL);
diff --git a/common/web/types/test/tsconfig.json b/common/web/types/test/tsconfig.json
index c522129c99a..b034236bd75 100644
--- a/common/web/types/test/tsconfig.json
+++ b/common/web/types/test/tsconfig.json
@@ -1,5 +1,5 @@
{
- "extends": "../../../../tsconfig.esm-base.json",
+ "extends": "../../../../tsconfig.base.json",
"compilerOptions": {
"rootDir": ".",
@@ -7,7 +7,7 @@
"outDir": "../build/test",
"baseUrl": ".",
"strictNullChecks": false, // TODO: get rid of this as some point
- "allowSyntheticDefaultImports": true // for ajv
+ "allowSyntheticDefaultImports": true
},
"include": [
"**/test-*.ts",
diff --git a/common/web/types/tools/formats.cjs b/common/web/types/tools/formats.cjs
new file mode 100644
index 00000000000..82eca97ab2f
--- /dev/null
+++ b/common/web/types/tools/formats.cjs
@@ -0,0 +1,10 @@
+/*
+ * This somewhat peculiar function is used in `build.sh configure` when
+ * precompiling the validators and makes it possible to use the extended formats
+ * in ajv-formats.
+ */
+function formats(ajv) {
+ require("ajv-formats")(ajv);
+}
+
+module.exports = formats;
diff --git a/common/web/types/tools/schema-bundler.js b/common/web/types/tools/schema-bundler.js
new file mode 100644
index 00000000000..995befaec1f
--- /dev/null
+++ b/common/web/types/tools/schema-bundler.js
@@ -0,0 +1,27 @@
+/*
+ * Bundle schema validation files (from .cjs) and make them available as ES modules
+ */
+
+import esbuild from 'esbuild';
+
+await esbuild.build({
+ entryPoints: [
+ 'obj/schemas/kpj.schema.validator.cjs',
+ 'obj/schemas/kpj-9.0.schema.validator.cjs',
+ 'obj/schemas/kvks.schema.validator.cjs',
+ 'obj/schemas/ldml-keyboard3.schema.validator.cjs',
+ 'obj/schemas/ldml-keyboardtest3.schema.validator.cjs',
+ 'obj/schemas/displaymap.schema.validator.cjs',
+ 'obj/schemas/keyman-touch-layout.clean.spec.validator.cjs',
+ 'obj/schemas/keyman-touch-layout.spec.validator.cjs',
+ 'obj/schemas/keyboard_info.schema.validator.cjs',
+ ],
+ bundle: true,
+ format: 'esm',
+ target: 'es2022',
+ outdir: 'src/schemas/',
+ sourcemap: false,
+
+ // We want a .mjs extension to force node into ESM module mode
+ outExtension: { '.js': '.mjs' },
+});
diff --git a/common/web/types/tsconfig.json b/common/web/types/tsconfig.json
index 5059030c0f8..be41a26729e 100644
--- a/common/web/types/tsconfig.json
+++ b/common/web/types/tsconfig.json
@@ -1,15 +1,15 @@
{
- "extends": "../../../tsconfig.esm-base.json",
+ "extends": "../../../tsconfig.base.json",
"compilerOptions": {
"outDir": "build/src/",
"rootDir": "src/",
"baseUrl": ".",
- "allowSyntheticDefaultImports": true, // for ajv
- "resolveJsonModule": true,
+ "allowSyntheticDefaultImports": true,
},
"include": [
- "src/**/*.ts"
+ "src/**/*.ts",
+ "src/schemas/*.mjs", // Import the validators
],
"references": [
{ "path": "../keyman-version" },
diff --git a/common/web/utils/package.json b/common/web/utils/package.json
index 210ac4b6be5..3f5729ec6a8 100644
--- a/common/web/utils/package.json
+++ b/common/web/utils/package.json
@@ -23,13 +23,13 @@
},
"homepage": "https://github.com/keymanapp/keyman#readme",
"devDependencies": {
- "@keymanapp/resources-gosh": "*",
"@keymanapp/keyman-version": "*",
+ "@keymanapp/resources-gosh": "*",
+ "@types/node": "^14.0.5",
"c8": "^7.12.0",
"chai": "^4.3.4",
"mocha": "^10.0.0",
"mocha-teamcity-reporter": "^4.0.0",
- "@types/node": "^14.0.5",
"typescript": "^4.9.5"
},
"type": "module",
diff --git a/common/windows/cpp/include/legacy_kmx_file.h b/common/windows/cpp/include/legacy_kmx_file.h
index 6be4b3b9861..9b8f6a59fb1 100644
--- a/common/windows/cpp/include/legacy_kmx_file.h
+++ b/common/windows/cpp/include/legacy_kmx_file.h
@@ -74,8 +74,9 @@
#define VERSION_140 0x00000E00
#define VERSION_150 0x00000F00
#define VERSION_160 0x00001000
+#define VERSION_170 0x00001100
#define VERSION_MIN VERSION_50
-#define VERSION_MAX VERSION_160
+#define VERSION_MAX VERSION_170
/*
Special flag for WM_CHAR/WM_KEY???/WM_SYSKEY???: says that key has been
diff --git a/common/windows/delphi/ext/sentry/test/Makefile b/common/windows/delphi/ext/sentry/test/Makefile
index 63fc664b011..b2e92bb8964 100644
--- a/common/windows/delphi/ext/sentry/test/Makefile
+++ b/common/windows/delphi/ext/sentry/test/Makefile
@@ -4,7 +4,8 @@
!include ..\..\..\Defines.mak
-build: dirs # version.res manifest.res
+build: dirs
+# version.res manifest.res
$(DELPHI_MSBUILD) SentryClientTest.dproj "/p:Platform=Win32"
$(DELPHI_MSBUILD) SentryClientVclTest.dproj "/p:Platform=Win32"
diff --git a/common/windows/delphi/general/utilfiletypes.pas b/common/windows/delphi/general/utilfiletypes.pas
index bf1f09fbf40..56a718bcd06 100644
--- a/common/windows/delphi/general/utilfiletypes.pas
+++ b/common/windows/delphi/general/utilfiletypes.pas
@@ -62,14 +62,15 @@ TKMFileTypeInfo = record
Ext_LexicalModelPackageSource = '.model.kps';
Ext_LexicalModelProject = '.model.kpj';
-const ExtFileTypes: array[0..13] of TKMFileTypeInfo = (
+const ExtFileTypes: array[0..14] of TKMFileTypeInfo = (
(Ext: Ext_KeymanSource; FileType: ftKeymanSource),
(Ext: Ext_PackageSource; FileType: ftPackageSource),
(Ext: Ext_KeymanFile; FileType: ftKeymanFile),
(Ext: Ext_PackageFile; FileType: ftPackageFile),
(Ext: '.ttf'; FileType: ftFont),
(Ext: '.otf'; FileType: ftFont),
- (Ext: '.fon'; FileType: ftFont),
+ (Ext: '.woff'; FileType: ftFont),
+ (Ext: '.woff2'; FileType: ftFont),
(Ext: '.ttc'; FileType: ftFont),
(Ext: Ext_VisualKeyboard; FileType: ftVisualKeyboard),
(Ext: Ext_VisualKeyboardSource; FileType: ftVisualKeyboardSource),
diff --git a/common/windows/delphi/keyboards/kmxfileconsts.pas b/common/windows/delphi/keyboards/kmxfileconsts.pas
index e08feb65641..966dada8827 100644
--- a/common/windows/delphi/keyboards/kmxfileconsts.pas
+++ b/common/windows/delphi/keyboards/kmxfileconsts.pas
@@ -99,9 +99,10 @@ interface
VERSION_140 = $00000E00;
VERSION_150 = $00000F00;
VERSION_160 = $00001000;
+ VERSION_170 = $00001100;
VERSION_MIN = VERSION_50;
- VERSION_MAX = VERSION_160;
+ VERSION_MAX = VERSION_170;
VERSION_MASK_MINOR = $00FF;
VERSION_MASK_MAJOR = $FF00;
diff --git a/common/windows/delphi/packages/PackageInfo.pas b/common/windows/delphi/packages/PackageInfo.pas
index e468a9ceb74..202fa9b4e7f 100644
--- a/common/windows/delphi/packages/PackageInfo.pas
+++ b/common/windows/delphi/packages/PackageInfo.pas
@@ -41,6 +41,7 @@ interface
System.Generics.Collections,
System.IniFiles,
System.JSON,
+ System.StrUtils,
System.Sysutils,
Winapi.Windows,
Xml.XMLDoc,
@@ -55,7 +56,15 @@ function GetJsonValueString(o: TJSONObject; const n: string): string;
function GetJsonValueBool(o: TJSONObject; const n: string): Boolean;
type
- TPackageInfoEntryType = (pietName, pietVersion, pietCopyright, pietAuthor, pietWebsite, pietOther);
+ TPackageInfoEntryType = (
+ pietName,
+ pietVersion,
+ pietCopyright,
+ pietAuthor,
+ pietWebsite,
+ pietDescription,
+ pietOther
+ );
const
PackageInfo_Name = 'Name';
@@ -63,9 +72,17 @@ function GetJsonValueBool(o: TJSONObject; const n: string): Boolean;
PackageInfo_Copyright = 'Copyright';
PackageInfo_Author = 'Author';
PackageInfo_Website = 'Website';
-
- PackageInfoEntryTypeNames: array[TPackageInfoEntryType] of WideString =
- (PackageInfo_Name, PackageInfo_Version, PackageInfo_Copyright, PackageInfo_Author, PackageInfo_Website, '');
+ PackageInfo_Description = 'Description';
+
+ PackageInfoEntryTypeNames: array[TPackageInfoEntryType] of string = (
+ PackageInfo_Name,
+ PackageInfo_Version,
+ PackageInfo_Copyright,
+ PackageInfo_Author,
+ PackageInfo_Website,
+ PackageInfo_Description,
+ ''
+ );
type
EPackageInfo = class(Exception);
@@ -122,6 +139,7 @@ TPackageObjectList = class(TObjectList)
TPackageContentFile = class;
TPackageContentFileList = class;
+ TPackageContentFileReferenceList = class;
{ Package Options }
@@ -131,6 +149,8 @@ TPackageOptions = class(TPackageBaseObject)
FExecuteProgram: WideString;
FReadmeFile: TPackageContentFile;
FGraphicFile: TPackageContentFile;
+ FLicenseFile: TPackageContentFile;
+ FWelcomeFile: TPackageContentFile;
FLoadLegacy: Boolean;
procedure SetReadmeFile(const Value: TPackageContentFile);
procedure SetExecuteProgram(Value: WideString);
@@ -140,6 +160,12 @@ TPackageOptions = class(TPackageBaseObject)
EventType: TPackageNotifyEventType; var FAllow: Boolean);
procedure ReadmeRemoved(Sender: TObject;
EventType: TPackageNotifyEventType; var FAllow: Boolean);
+ procedure SetLicenseFile(const Value: TPackageContentFile);
+ procedure LicenseRemoved(Sender: TObject;
+ EventType: TPackageNotifyEventType; var FAllow: Boolean);
+ procedure SetWelcomeFile(const Value: TPackageContentFile);
+ procedure WelcomeRemoved(Sender: TObject;
+ EventType: TPackageNotifyEventType; var FAllow: Boolean);
public
constructor Create(APackage: TPackage); override;
destructor Destroy; override;
@@ -155,6 +181,8 @@ TPackageOptions = class(TPackageBaseObject)
property ExecuteProgram: WideString read FExecuteProgram write SetExecuteProgram;
property ReadmeFile: TPackageContentFile read FReadmeFile write SetReadmeFile;
property GraphicFile: TPackageContentFile read FGraphicFile write SetGraphicFile;
+ property LicenseFile: TPackageContentFile read FLicenseFile write SetLicenseFile;
+ property WelcomeFile: TPackageContentFile read FWelcomeFile write SetWelcomeFile;
end;
{ Package Information }
@@ -282,6 +310,8 @@ TPackageKeyboard = class;
TPackageKeyboardList = class;
TPackageKeyboardLanguage = class;
TPackageKeyboardLanguageList = class;
+ TPackageKeyboardExample = class;
+ TPackageKeyboardExampleList = class;
TPackageKeyboard = class(TPackageBaseObject)
private
@@ -291,14 +321,17 @@ TPackageKeyboard = class(TPackageBaseObject)
FRTL: Boolean;
FDisplayFont: TPackageContentFile;
FLanguages: TPackageKeyboardLanguageList;
+ FExamples: TPackageKeyboardExampleList;
FVersion: string;
FMinKeymanVersion: string;
+ FWebOSKFonts: TPackageContentFileReferenceList;
+ FWebDisplayFonts: TPackageContentFileReferenceList;
procedure SetDisplayFont(const Value: TPackageContentFile);
procedure SetOSKFont(const Value: TPackageContentFile);
- procedure DisplayFontRemoved(Sender: TObject;
- EventType: TPackageNotifyEventType; var FAllow: Boolean);
- procedure OSKFontRemoved(Sender: TObject;
+ procedure FontRemoved(Sender: TObject;
EventType: TPackageNotifyEventType; var FAllow: Boolean);
+ procedure FontListNotify(Sender: TObject; const Item: TPackageContentFile;
+ Action: TCollectionNotification);
public
constructor Create(APackage: TPackage); override;
destructor Destroy; override;
@@ -308,12 +341,26 @@ TPackageKeyboard = class(TPackageBaseObject)
property RTL: Boolean read FRTL write FRTL;
property Version: string read FVersion write FVersion;
property Languages: TPackageKeyboardLanguageList read FLanguages;
+ property Examples: TPackageKeyboardExampleList read FExamples;
property OSKFont: TPackageContentFile read FOSKFont write SetOSKFont;
property DisplayFont: TPackageContentFile read FDisplayFont write SetDisplayFont;
+ property WebOSKFonts: TPackageContentFileReferenceList read FWebOSKFonts;
+ property WebDisplayFonts: TPackageContentFileReferenceList read FWebDisplayFonts;
// The following properties are used only in memory and never streamed in or out
property MinKeymanVersion: string read FMinKeymanVersion write FMinKeymanVersion;
end;
+ TPackageContentFileReferenceList = class(TPackageObjectList)
+ public
+ constructor Create(APackage: TPackage);
+ procedure Assign(Source: TPackageContentFileReferenceList); virtual;
+ procedure LoadXML(ARoot: IXMLNode); virtual;
+ procedure SaveXML(ARoot: IXMLNode); virtual;
+ procedure LoadJSON(ARoot: TJSONArray); virtual;
+ procedure SaveJSON(ARoot: TJSONArray); virtual;
+ function GetAsString: string;
+ end;
+
TPackageKeyboardList = class(TPackageObjectList)
public
procedure Assign(Source: TPackageKeyboardList); virtual;
@@ -341,6 +388,23 @@ TPackageKeyboardLanguageList = class(TPackageObjectList)
+ public
+ procedure LoadJSON(ARoot: TJSONObject); virtual;
+ procedure SaveJSON(ARoot: TJSONObject); virtual;
+ procedure LoadXML(ARoot: IXMLNode); virtual;
+ procedure SaveXML(ARoot: IXMLNode); virtual;
+ function ContainsID(const id: string): Boolean;
+ function IndexOfID(const id: string; from: Integer = 0): Integer;
+ end;
+
TPackageLexicalModel = class(TPackageBaseObject)
private
FName: string;
@@ -366,6 +430,24 @@ TPackageLexicalModelList = class(TPackageObjectList)
function ItemByID(id: string): TPackageLexicalModel;
end;
+ TPackageRelatedPackage = class(TPackageBaseObject)
+ private
+ FID: string;
+ FRelationship: string;
+ public
+ procedure Assign(Source: TPackageRelatedPackage); virtual;
+ property ID: string read FID write FID;
+ property Relationship: string read FRelationship write FRelationship;
+ end;
+
+ TPackageRelatedPackageList = class(TPackageObjectList)
+ procedure Assign(Source: TPackageRelatedPackageList); virtual;
+ procedure LoadXML(ARoot: IXMLNode); virtual;
+ procedure SaveXML(ARoot: IXMLNode); virtual;
+ procedure LoadJSON(ARoot: TJSONObject); virtual;
+ procedure SaveJSON(ARoot: TJSONObject); virtual;
+ end;
+
{ TPackage }
TPackage = class
@@ -390,6 +472,7 @@ TPackage = class
Info: TPackageInfoEntryList;
Keyboards: TPackageKeyboardList;
LexicalModels: TPackageLexicalModelList;
+ RelatedPackages: TPackageRelatedPackageList;
property FileName: WideString read FFileName write FFileName;
procedure Assign(Source: TPackage); virtual;
@@ -417,6 +500,9 @@ TPackage = class
const
PackageStartMenuEntryLocationName: array[TPackageStartMenuEntryLocation] of WideString = ('Start Menu', 'Desktop'); //, 'Quick Launch Toolbar');
+const
+ S_RelatedPackage_Deprecates = 'deprecates';
+
implementation
uses
@@ -433,13 +519,12 @@ implementation
SPackageInfoTooNew = 'The package file is version %s. This version can only read version '+SKeymanVersion+' and older files.';
SReadmeNotOwnedCorrectly = 'The readme file ''%s'' referred to is not part of the package.';
SGraphicNotOwnedCorrectly = 'The graphic file ''%s'' referred to is not part of the package.';
+ SLicenseNotOwnedCorrectly = 'The license file ''%s'' referred to is not part of the package.';
+ SWelcomeNotOwnedCorrectly = 'The welcome file ''%s'' referred to is not part of the package.';
SFileNotOwnedCorrectly = 'The file ''%s'' referred to is not part of the package.';
SDisplayFontNotOwnedCorrectly = 'The display font file ''%s'' referred to is not part of the package.';
SOSKFontNotOwnedCorrectly = 'The OSK font file ''%s'' referred to is not part of the package.';
-
-
-
const
SXML_PackageKeyboards = 'Keyboards';
SXML_PackageKeyboard = 'Keyboard';
@@ -450,11 +535,23 @@ implementation
SXML_PackageKeyboard_OSKFont = 'OSKFont';
SXML_PackageKeyboard_DisplayFont = 'DisplayFont';
SXML_PackageKeyboard_Languages = 'Languages';
+ SXML_PackageKeyboard_Examples = 'Examples';
SXML_PackageKeyboard_Language = 'Language';
SXML_PackageKeyboard_Language_ID = 'ID';
SXML_PackageKeyboard_Language_Name = 'Name';
+ SXML_PackageKeyboard_Example = 'Example';
+ SXML_PackageKeyboard_Example_ID = 'ID';
+ SXML_PackageKeyboard_Example_Keys = 'Keys';
+ SXML_PackageKeyboard_Example_Text = 'Text';
+ SXML_PackageKeyboard_Example_Note = 'Note';
+
+ SXML_PackageKeyboard_WebOskFonts = 'WebOSKFonts';
+ SXML_PackageKeyboard_WebDisplayFonts = 'WebDisplayFonts';
+ SXML_PackageKeyboardFont = 'Font';
+ SXML_PackageKeyboardFont_Filename = 'Filename';
+
SXML_PackageLexicalModels = 'LexicalModels';
SXML_PackageLexicalModel = 'LexicalModel';
SXML_PackageLexicalModel_Name = 'Name';
@@ -462,6 +559,11 @@ implementation
SXML_PackageLexicalModel_RTL = 'RTL';
SXML_PackageLexicalModel_Languages = 'Languages';
+ SXML_PackageRelatedPackages = 'RelatedPackages';
+ SXML_PackageRelatedPackage = 'RelatedPackage';
+ SXML_PackageRelatedPackage_ID = 'ID';
+ SXML_PackageRelatedPackage_Relationship = 'Relationship';
+
const
SJSON_System = 'system';
SJSON_System_KeymanDeveloperVersion = 'keymanDeveloperVersion';
@@ -471,6 +573,8 @@ implementation
SJSON_Options_ExecuteProgram = 'executeProgram';
SJSON_Options_ReadMeFile = 'readmeFile';
SJSON_Options_GraphicFile = 'graphicFile';
+ SJSON_Options_LicenseFile = 'licenseFile';
+ SJSON_Options_WelcomeFile = 'welcomeFile';
SJSON_Registry = 'registry';
SJSON_Registry_Root = 'root';
@@ -493,14 +597,22 @@ implementation
SJSON_Info__Description = 'description';
SJSON_Info__URL = 'url';
- SJSON_Info_Website = 'website';
- SJSON_Info_Version = 'version';
SJSON_Info_Name = 'name';
+ SJSON_Info_Version = 'version';
SJSON_Info_Copyright = 'copyright';
SJSON_Info_Author = 'author';
-
- SJSON_PackageInfoEntryTypeNames: array[TPackageInfoEntryType] of string =
- (SJSON_Info_Name, SJSON_Info_Version, SJSON_Info_Copyright, SJSON_Info_Author, SJSON_Info_Website, '');
+ SJSON_Info_Website = 'website';
+ SJSON_Info_Description = 'description';
+
+ SJSON_PackageInfoEntryTypeNames: array[TPackageInfoEntryType] of string = (
+ SJSON_Info_Name,
+ SJSON_Info_Version,
+ SJSON_Info_Copyright,
+ SJSON_Info_Author,
+ SJSON_Info_Website,
+ SJSON_Info_Description,
+ ''
+ );
SJSON_Files = 'files';
SJSON_Files_Name = 'name';
@@ -519,15 +631,28 @@ implementation
SJSON_Keyboard_Language_ID = 'id';
SJSON_Keyboard_Language_Name = 'name';
+ SJSON_Keyboard_Examples = 'examples';
+ SJSON_Keyboard_Example_ID = 'id';
+ SJSON_Keyboard_Example_Keys = 'keys';
+ SJSON_Keyboard_Example_Text = 'text';
+ SJSON_Keyboard_Example_Note = 'note';
+
+ SJSON_Keyboard_WebOSKFonts = 'webOskFonts';
+ SJSON_Keyboard_WebDisplayFonts = 'webDisplayFonts';
+
SJSON_LexicalModels = 'lexicalModels';
SJSON_LexicalModel_Name = 'name';
SJSON_LexicalModel_ID = 'id';
SJSON_LexicalModel_RTL = 'rtl';
SJSON_LexicalModel_Languages = 'languages';
+ SJSON_RelatedPackages = 'relatedPackages';
+ SJSON_RelatedPackage_ID = 'id';
+ SJSON_RelatedPackage_Relationship = 'relationship';
+
function XmlVarToStr(v: OleVariant): string;
begin
- Result := Trim(VarToStr(v));
+ Result := ReplaceStr(ReplaceStr(Trim(VarToStr(v)), #$D#$A, #$A), #$A, #$D#$A);
end;
{-------------------------------------------------------------------------------
@@ -544,6 +669,12 @@ procedure TPackageOptions.Assign(Source: TPackageOptions);
if Assigned(Source.GraphicFile)
then GraphicFile := Package.Files.FromFileName(Source.GraphicFile.FileName)
else GraphicFile := nil;
+ if Assigned(Source.LicenseFile)
+ then LicenseFile := Package.Files.FromFileName(Source.LicenseFile.FileName)
+ else LicenseFile := nil;
+ if Assigned(Source.WelcomeFile)
+ then WelcomeFile := Package.Files.FromFileName(Source.WelcomeFile.FileName)
+ else WelcomeFile := nil;
end;
constructor TPackageOptions.Create(APackage: TPackage);
@@ -557,6 +688,8 @@ destructor TPackageOptions.Destroy;
begin
ReadmeFile := nil;
GraphicFile := nil;
+ LicenseFile := nil;
+ WelcomeFile := nil;
inherited Destroy;
end;
@@ -570,14 +703,28 @@ procedure TPackageOptions.GraphicRemoved(Sender: TObject; EventType: TPackageNot
FGraphicFile := nil;
end;
+procedure TPackageOptions.LicenseRemoved(Sender: TObject; EventType: TPackageNotifyEventType; var FAllow: Boolean);
+begin
+ FLicenseFile := nil;
+end;
+
+procedure TPackageOptions.WelcomeRemoved(Sender: TObject; EventType: TPackageNotifyEventType; var FAllow: Boolean);
+begin
+ FWelcomeFile := nil;
+end;
+
procedure TPackageOptions.LoadXML(ARoot: IXMLNode);
begin
FileVersion := XmlVarToStr(ARoot.ChildNodes['System'].ChildNodes['FileVersion'].NodeValue);
ExecuteProgram := XmlVarToStr(ARoot.ChildNodes['Options'].ChildNodes['ExecuteProgram'].NodeValue);
ReadmeFile := Package.Files.FromFileName(XmlVarToStr(ARoot.ChildNodes['Options'].ChildNodes['ReadMeFile'].NodeValue));
GraphicFile := Package.Files.FromFileName(XmlVarToStr(ARoot.ChildNodes['Options'].ChildNodes['GraphicFile'].NodeValue));
+ LicenseFile := Package.Files.FromFileName(XmlVarToStr(ARoot.ChildNodes['Options'].ChildNodes['LicenseFile'].NodeValue));
+ WelcomeFile := Package.Files.FromFileName(XmlVarToStr(ARoot.ChildNodes['Options'].ChildNodes['WelcomeFile'].NodeValue));
if Assigned(ReadmeFile) then ReadmeFile.AddNotifyObject(ReadmeRemoved);
if Assigned(GraphicFile) then GraphicFile.AddNotifyObject(GraphicRemoved);
+ if Assigned(LicenseFile) then LicenseFile.AddNotifyObject(LicenseRemoved);
+ if Assigned(WelcomeFile) then WelcomeFile.AddNotifyObject(WelcomeRemoved);
end;
procedure TPackageOptions.SaveXML(ARoot: IXMLNode);
@@ -588,6 +735,10 @@ procedure TPackageOptions.SaveXML(ARoot: IXMLNode);
ARoot.ChildNodes['Options'].ChildNodes['ReadMeFile'].NodeValue := ReadmeFile.RelativeFileName;
if Assigned(GraphicFile) then
ARoot.ChildNodes['Options'].ChildNodes['GraphicFile'].NodeValue := GraphicFile.RelativeFileName;
+ if Assigned(LicenseFile) then
+ ARoot.ChildNodes['Options'].ChildNodes['LicenseFile'].NodeValue := LicenseFile.RelativeFileName;
+ if Assigned(WelcomeFile) then
+ ARoot.ChildNodes['Options'].ChildNodes['WelcomeFile'].NodeValue := WelcomeFile.RelativeFileName;
end;
procedure TPackageOptions.LoadIni(AIni: TIniFile);
@@ -598,6 +749,8 @@ procedure TPackageOptions.LoadIni(AIni: TIniFile);
GraphicFile := Package.Files.FromFileName(AIni.ReadString('Package', 'GraphicFile', ''));
if Assigned(ReadmeFile) then ReadmeFile.AddNotifyObject(ReadmeRemoved);
if Assigned(GraphicFile) then GraphicFile.AddNotifyObject(GraphicRemoved);
+ // LicenseFile not supported in ini
+ // WelcomeFile not supported in ini
end;
procedure TPackageOptions.LoadJSON(ARoot: TJSONObject);
@@ -611,8 +764,12 @@ procedure TPackageOptions.LoadJSON(ARoot: TJSONObject);
ExecuteProgram := GetJsonValueString(FOptions, SJSON_Options_ExecuteProgram);
ReadmeFile := Package.Files.FromFileName(GetJsonValueString(FOptions, SJSON_Options_ReadMeFile));
GraphicFile := Package.Files.FromFileName(GetJsonValueString(FOptions, SJSON_Options_GraphicFile));
+ LicenseFile := Package.Files.FromFileName(GetJsonValueString(FOptions, SJSON_Options_LicenseFile));
+ WelcomeFile := Package.Files.FromFileName(GetJsonValueString(FOptions, SJSON_Options_WelcomeFile));
if Assigned(ReadmeFile) then ReadmeFile.AddNotifyObject(ReadmeRemoved);
if Assigned(GraphicFile) then GraphicFile.AddNotifyObject(GraphicRemoved);
+ if Assigned(LicenseFile) then LicenseFile.AddNotifyObject(LicenseRemoved);
+ if Assigned(WelcomeFile) then WelcomeFile.AddNotifyObject(WelcomeRemoved);
end;
procedure TPackageOptions.SaveIni(AIni: TIniFile);
@@ -623,6 +780,8 @@ procedure TPackageOptions.SaveIni(AIni: TIniFile);
AIni.WriteString('Package', 'ReadMeFile', ReadmeFile.RelativeFileName);
if Assigned(GraphicFile) then
AIni.WriteString('Package', 'GraphicFile', GraphicFile.RelativeFileName);
+ // licenseFile not supported in ini
+ // welcomeFile not supported in ini
end;
procedure TPackageOptions.SaveJSON(ARoot: TJSONObject);
@@ -642,6 +801,10 @@ procedure TPackageOptions.SaveJSON(ARoot: TJSONObject);
FOptions.AddPair(SJSON_Options_ReadMeFile, ReadmeFile.RelativeFileName);
if Assigned(GraphicFile) then
FOptions.AddPair(SJSON_Options_GraphicFile, GraphicFile.RelativeFileName);
+ if Assigned(LicenseFile) then
+ FOptions.AddPair(SJSON_Options_LicenseFile, LicenseFile.RelativeFileName);
+ if Assigned(WelcomeFile) then
+ FOptions.AddPair(SJSON_Options_WelcomeFile, WelcomeFile.RelativeFileName);
end;
procedure TPackageOptions.SetExecuteProgram(Value: WideString);
@@ -669,6 +832,32 @@ procedure TPackageOptions.SetGraphicFile(const Value: TPackageContentFile);
end;
end;
+procedure TPackageOptions.SetLicenseFile(const Value: TPackageContentFile);
+begin
+ if Assigned(FLicenseFile) then FLicenseFile.RemoveNotifyObject(LicenseRemoved);
+ if not Assigned(Value) then
+ FLicenseFile := nil
+ else
+ begin
+ if Value.Package <> Package then raise EPackageInfo.CreateFmt(SLicenseNotOwnedCorrectly, [Value]);
+ FLicenseFile := Value;
+ FLicenseFile.AddNotifyObject(LicenseRemoved);
+ end;
+end;
+
+procedure TPackageOptions.SetWelcomeFile(const Value: TPackageContentFile);
+begin
+ if Assigned(FWelcomeFile) then FWelcomeFile.RemoveNotifyObject(WelcomeRemoved);
+ if not Assigned(Value) then
+ FWelcomeFile := nil
+ else
+ begin
+ if Value.Package <> Package then raise EPackageInfo.CreateFmt(SWelcomeNotOwnedCorrectly, [Value]);
+ FWelcomeFile := Value;
+ FWelcomeFile.AddNotifyObject(WelcomeRemoved);
+ end;
+end;
+
procedure TPackageOptions.SetReadmeFile(const Value: TPackageContentFile);
begin
if Assigned(FReadmeFile) then FReadmeFile.RemoveNotifyObject(ReadmeRemoved);
@@ -1420,6 +1609,7 @@ procedure TPackage.Assign(Source: TPackage);
Info.Assign(Source.Info);
Keyboards.Assign(Source.Keyboards);
LexicalModels.Assign(Source.LexicalModels);
+ RelatedPackages.Assign(Source.RelatedPackages);
end;
constructor TPackage.Create;
@@ -1432,6 +1622,7 @@ constructor TPackage.Create;
if not Assigned(Info) then Info := TPackageInfoEntryList.Create(Self);
if not Assigned(Keyboards) then Keyboards := TPackageKeyboardList.Create(Self);
if not Assigned(LexicalModels) then LexicalModels := TPackageLexicalModelList.Create(Self);
+ if not Assigned(RelatedPackages) then RelatedPackages := TPackageRelatedPackageList.Create(Self);
end;
destructor TPackage.Destroy;
@@ -1442,6 +1633,7 @@ destructor TPackage.Destroy;
Info.Free;
Keyboards.Free;
LexicalModels.Free;
+ RelatedPackages.Free;
inherited Destroy;
end;
@@ -1475,6 +1667,7 @@ procedure TPackage.DoLoadIni(ini: TIniFile);
Options.LoadIni(ini);
Keyboards.LoadIni(ini);
//LexicalModels not supported in ini
+ //RelatedPackages not supported in ini
end;
procedure TPackage.LoadJSON;
@@ -1593,8 +1786,9 @@ procedure TPackage.DoLoadJSON(ARoot: TJSONObject);
Files.LoadJSON(ARoot);
Options.LoadJSON(ARoot);
Keyboards.LoadJSON(ARoot);
- if Options.FileVersion = SKeymanVersion120 then
+ if CompareVersions(Options.FileVersion, SKeymanVersion120) >= 0 then
LexicalModels.LoadJSON(ARoot);
+ RelatedPackages.LoadJSON(ARoot);
end;
procedure TPackage.DoLoadXML(ARoot: IXMLNode);
@@ -1613,8 +1807,9 @@ procedure TPackage.DoLoadXML(ARoot: IXMLNode);
Files.LoadXML(ARoot);
Options.LoadXML(ARoot);
Keyboards.LoadXML(ARoot);
- if FVersion = SKeymanVersion120 then
+ if CompareVersions(FVersion, SKeymanVersion120) >= 0 then
LexicalModels.LoadXML(ARoot);
+ RelatedPackages.LoadXML(ARoot);
end;
procedure TPackage.DoSaveIni(ini: TIniFile);
@@ -1626,6 +1821,7 @@ procedure TPackage.DoSaveIni(ini: TIniFile);
Files.SaveIni(ini);
Keyboards.SaveIni(ini);
// Lexical models not supported in ini
+ // RelatedPackages not supported in ini
end;
procedure TPackage.FixupFileVersion;
@@ -1647,6 +1843,7 @@ procedure TPackage.DoSaveJSON(ARoot: TJSONObject);
Keyboards.SaveJSON(ARoot);
if LexicalModels.Count > 0 then
LexicalModels.SaveJSON(ARoot);
+ RelatedPackages.SaveJSON(ARoot);
end;
procedure TPackage.DoSaveXML(ARoot: IXMLNode);
@@ -1660,6 +1857,7 @@ procedure TPackage.DoSaveXML(ARoot: IXMLNode);
Keyboards.SaveXML(ARoot);
if LexicalModels.Count > 0 then
LexicalModels.SaveXML(ARoot);
+ RelatedPackages.SaveXML(ARoot);
end;
procedure TPackage.SaveIni;
@@ -1822,6 +2020,7 @@ procedure TPackageKeyboard.Assign(Source: TPackageKeyboard);
var
i: Integer;
FLanguage: TPackageKeyboardLanguage;
+ FExample: TPackageKeyboardExample;
begin
FName := Source.Name;
FID := Source.ID;
@@ -1842,18 +2041,35 @@ procedure TPackageKeyboard.Assign(Source: TPackageKeyboard);
FLanguage.Name := Source.Languages[i].Name;
FLanguages.Add(FLanguage);
end;
+ FExamples.Clear;
+ for i := 0 to Source.Examples.Count - 1 do
+ begin
+ FExample := TPackageKeyboardExample.Create(Package);
+ FExample.ID := Source.Examples[i].ID;
+ FExample.Keys := Source.Examples[i].Keys;
+ FExample.Text := Source.Examples[i].Text;
+ FExample.Note := Source.Examples[i].Note;
+ FExamples.Add(FExample);
+ end;
+
+ FWebOSKFonts.Clear;
+ FWebOSKFonts.Assign(Source.WebOSKFonts);
+
+ FWebDisplayFonts.Clear;
+ FWebDisplayFonts.Assign(Source.WebDisplayFonts);
end;
procedure TPackageKeyboard.SetDisplayFont(const Value: TPackageContentFile);
begin
- if Assigned(FDisplayFont) then FDisplayFont.RemoveNotifyObject(DisplayFontRemoved);
+ if Assigned(FDisplayFont) then
+ FDisplayFont.RemoveNotifyObject(FontRemoved);
if not Assigned(Value) then
FDisplayFont := nil
else
begin
if Value.Package <> Package then raise EPackageInfo.CreateFmt(SDisplayFontNotOwnedCorrectly, [Value]);
FDisplayFont := Value;
- FDisplayFont.AddNotifyObject(DisplayFontRemoved);
+ FDisplayFont.AddNotifyObject(FontRemoved);
end;
end;
@@ -1861,39 +2077,68 @@ constructor TPackageKeyboard.Create(APackage: TPackage);
begin
inherited Create(APackage);
FLanguages := TPackageKeyboardLanguageList.Create(APackage);
+ FExamples := TPackageKeyboardExampleList.Create(APackage);
+ FWebOSKFonts := TPackageContentFileReferenceList.Create(APackage);
+ FWebOSKFonts.OnNotify := FontListNotify;
+ FWebDisplayFonts := TPackageContentFileReferenceList.Create(APackage);
+ FWebDisplayFonts.OnNotify := FontListNotify;
end;
destructor TPackageKeyboard.Destroy;
begin
+ if Assigned(FDisplayFont) then
+ FDisplayFont.RemoveNotifyObject(FontRemoved);
+ FDisplayFont := nil;
+
+ if Assigned(FOSKFont) then
+ FOSKFont.RemoveNotifyObject(FontRemoved);
+ FOSKFont := nil;
+
FreeAndNil(FLanguages);
+ FreeAndNil(FExamples);
+ FreeAndNil(FWebOSKFonts);
+ FreeAndNil(FWebDisplayFonts);
inherited Destroy;
end;
-procedure TPackageKeyboard.DisplayFontRemoved(Sender: TObject;
+procedure TPackageKeyboard.FontListNotify(Sender: TObject;
+ const Item: TPackageContentFile; Action: TCollectionNotification);
+begin
+ if Action = cnRemoved then
+ Item.RemoveNotifyObject(FontRemoved)
+ else if Action = cnAdded then
+ begin
+ Assert(Item.Package = Self.Package);
+ Item.AddNotifyObject(FontRemoved);
+ end;
+end;
+
+procedure TPackageKeyboard.FontRemoved(Sender: TObject;
EventType: TPackageNotifyEventType; var FAllow: Boolean);
begin
- FDisplayFont := nil;
+ // For all EventTypes
+ if Sender = FDisplayFont then
+ FDisplayFont := nil;
+ if Sender = FOSKFont then
+ FOSKFont := nil;
+ FWebDisplayFonts.Remove(Sender as TPackageContentFile);
+ FWebOSKFonts.Remove(Sender as TPackageContentFile);
end;
procedure TPackageKeyboard.SetOSKFont(const Value: TPackageContentFile);
begin
- if Assigned(FOSKFont) then FOSKFont.RemoveNotifyObject(OSKFontRemoved);
+ if Assigned(FOSKFont) then
+ FOSKFont.RemoveNotifyObject(FontRemoved);
if not Assigned(Value) then
FOSKFont := nil
else
begin
if Value.Package <> Package then raise EPackageInfo.CreateFmt(SOSKFontNotOwnedCorrectly, [Value]);
FOSKFont := Value;
- FOSKFont.AddNotifyObject(OSKFontRemoved);
+ FOSKFont.AddNotifyObject(FontRemoved);
end;
end;
-procedure TPackageKeyboard.OSKFontRemoved(Sender: TObject;
- EventType: TPackageNotifyEventType; var FAllow: Boolean);
-begin
- FOSKFont := nil;
-end;
-
{ TPackageKeyboardList }
procedure TPackageKeyboardList.Assign(Source: TPackageKeyboardList);
@@ -1958,6 +2203,8 @@ procedure TPackageKeyboardList.LoadIni(AIni: TIniFile);
keyboard.Languages.Add(FLanguage);
end;
+ // web fonts not supported in ini
+
Add(keyboard);
end;
finally
@@ -1969,7 +2216,7 @@ procedure TPackageKeyboardList.LoadJSON(ARoot: TJSONObject);
var
keyboard: TPackageKeyboard;
i: Integer;
- ANode: TJSONArray;
+ ASubNode, ANode: TJSONArray;
AKeyboard: TJSONObject;
begin
Clear;
@@ -1990,6 +2237,16 @@ procedure TPackageKeyboardList.LoadJSON(ARoot: TJSONObject);
keyboard.OSKFont := Package.Files.FromFileNameEx(GetJsonValueString(AKeyboard, SJSON_Keyboard_OSKFont));
keyboard.DisplayFont := Package.Files.FromFileNameEx(GetJsonValueString(AKeyboard, SJSON_Keyboard_DisplayFont));
keyboard.Languages.LoadJSON(AKeyboard);
+ keyboard.Examples.LoadJSON(AKeyboard);
+
+ ASubNode := AKeyboard.GetValue(SJSON_Keyboard_WebOSKFonts) as TJSONArray;
+ if Assigned(ASubNode) then
+ keyboard.WebOSKFonts.LoadJSON(ASubNode);
+
+ ASubNode := AKeyboard.GetValue(SJSON_Keyboard_WebDisplayFonts) as TJSONArray;
+ if Assigned(ASubNode) then
+ keyboard.WebDisplayFonts.LoadJSON(ASubNode);
+
Add(keyboard);
end;
end;
@@ -1998,7 +2255,7 @@ procedure TPackageKeyboardList.LoadXML(ARoot: IXMLNode);
var
keyboard: TPackageKeyboard;
i: Integer;
- AKeyboard, ANode: IXMLNode;
+ AKeyboard, ANode, ASubNode: IXMLNode;
begin
Clear;
@@ -2016,6 +2273,20 @@ procedure TPackageKeyboardList.LoadXML(ARoot: IXMLNode);
keyboard.DisplayFont := Package.Files.FromFileNameEx(XmlVarToStr(AKeyboard.ChildValues[SXML_PackageKeyboard_DisplayFont]));
keyboard.Languages.LoadXML(AKeyboard);
+ keyboard.Examples.LoadXML(AKeyboard);
+
+ ASubNode := AKeyboard.ChildNodes[SXML_PackageKeyboard_WebOSKFonts];
+ if Assigned(ASubNode) then
+ begin
+ keyboard.WebOSKFonts.LoadXML(ASubNode);
+ end;
+
+ ASubNode := AKeyboard.ChildNodes[SXML_PackageKeyboard_WebDisplayFonts];
+ if Assigned(ASubNode) then
+ begin
+ keyboard.WebDisplayFonts.LoadXML(ASubNode);
+ end;
+
Add(keyboard);
end;
end;
@@ -2041,6 +2312,8 @@ procedure TPackageKeyboardList.SaveIni(AIni: TIniFile);
begin
AIni.WriteString(FSectionName, SXML_PackageKeyboard_Language+IntToStr(j), Items[i].Languages[j].ID+','+Items[i].Languages[j].Name);
end;
+
+ // web fonts not supported in ini
end;
end;
@@ -2048,7 +2321,7 @@ procedure TPackageKeyboardList.SaveJSON(ARoot: TJSONObject);
var
i: Integer;
AKeyboard: TJSONObject;
- AKeyboards: TJSONArray;
+ AFonts, AKeyboards: TJSONArray;
begin
if Count = 0 then
Exit;
@@ -2071,13 +2344,27 @@ procedure TPackageKeyboardList.SaveJSON(ARoot: TJSONObject);
AKeyboard.AddPair(SJSON_Keyboard_DisplayFont, Items[i].DisplayFont.RelativeFileName);
Items[i].Languages.SaveJSON(AKeyboard);
+ Items[i].Examples.SaveJSON(AKeyboard);
+ if Items[i].WebOSKFonts.Count > 0 then
+ begin
+ AFonts := TJSONArray.Create;
+ Items[i].WebOSKFonts.SaveJSON(AFonts);
+ AKeyboard.AddPair(SJSON_Keyboard_WebOSKFonts, AFonts);
+ end;
+
+ if Items[i].WebDisplayFonts.Count > 0 then
+ begin
+ AFonts := TJSONArray.Create;
+ Items[i].WebDisplayFonts.SaveJSON(AFonts);
+ AKeyboard.AddPair(SJSON_Keyboard_WebDisplayFonts, AFonts);
+ end;
end;
end;
procedure TPackageKeyboardList.SaveXML(ARoot: IXMLNode);
var
i: Integer;
- AKeyboard, ANode: IXMLNode;
+ AFonts, AKeyboard, ANode: IXMLNode;
begin
ANode := ARoot.AddChild(SXML_PackageKeyboards);
for i := 0 to Count - 1 do
@@ -2095,6 +2382,18 @@ procedure TPackageKeyboardList.SaveXML(ARoot: IXMLNode);
AKeyboard.ChildNodes[SXML_PackageKeyboard_DisplayFont].NodeValue := Items[i].DisplayFont.RelativeFileName;
Items[i].Languages.SaveXML(AKeyboard);
+ Items[i].Examples.SaveXML(AKeyboard);
+ if Items[i].WebOSKFonts.Count > 0 then
+ begin
+ AFonts := AKeyboard.AddChild(SXML_PackageKeyboard_WebOskFonts);
+ Items[i].WebOSKFonts.SaveXML(AFonts);
+ end;
+
+ if Items[i].WebDisplayFonts.Count > 0 then
+ begin
+ AFonts := AKeyboard.AddChild(SXML_PackageKeyboard_WebDisplayFonts);
+ Items[i].WebDisplayFonts.SaveXML(AFonts);
+ end;
end;
end;
@@ -2353,5 +2652,307 @@ procedure TPackageKeyboardLanguageList.SaveXML(ARoot: IXMLNode);
end;
end;
+{ TPackageKeyboardExampleList }
+
+function TPackageKeyboardExampleList.ContainsID(const id: string): Boolean;
+begin
+ Result := IndexOfID(id) >= 0;
+end;
+
+function TPackageKeyboardExampleList.IndexOfID(const id: string;
+ from: Integer): Integer;
+var
+ i: Integer;
+begin
+ for i := from to Count - 1 do
+ if SameText(Items[i].ID, id) then
+ Exit(i);
+ Result := -1;
+end;
+
+procedure TPackageKeyboardExampleList.LoadJSON(ARoot: TJSONObject);
+var
+ j: Integer;
+ AExample: TJSONObject;
+ FExample: TPackageKeyboardExample;
+ AExamples: TJSONArray;
+begin
+ AExamples := ARoot.Values[SJSON_Keyboard_Examples] as TJSONArray;
+ if not Assigned(AExamples) then
+ Exit;
+
+ for j := 0 to AExamples.Count - 1 do
+ begin
+ AExample := AExamples.Items[j] as TJSONObject;
+
+ FExample := TPackageKeyboardExample.Create(Package);
+ FExample.ID := GetJsonValueString(AExample, SJSON_Keyboard_Example_ID);
+ FExample.Keys := GetJsonValueString(AExample, SJSON_Keyboard_Example_Keys);
+ FExample.Text := GetJsonValueString(AExample, SJSON_Keyboard_Example_Text);
+ FExample.Note := GetJsonValueString(AExample, SJSON_Keyboard_Example_Note);
+ Self.Add(FExample);
+ end;
+end;
+
+procedure TPackageKeyboardExampleList.LoadXML(ARoot: IXMLNode);
+var
+ j: Integer;
+ AExamples, AExample: IXMLNode;
+ FExample: TPackageKeyboardExample;
+begin
+ AExamples := ARoot.ChildNodes[SXML_PackageKeyboard_Examples];
+ if not Assigned(AExamples) then
+ Exit;
+
+ for j := 0 to AExamples.ChildNodes.Count - 1 do
+ begin
+ AExample := AExamples.ChildNodes[j];
+
+ FExample := TPackageKeyboardExample.Create(Package);
+ FExample.ID := VarToStr(AExample.Attributes[SXML_PackageKeyboard_Example_ID]);
+ FExample.Keys := VarToStr(AExample.Attributes[SXML_PackageKeyboard_Example_Keys]);
+ FExample.Text := VarToStr(AExample.Attributes[SXML_PackageKeyboard_Example_Text]);
+ FExample.Note := VarToStr(AExample.Attributes[SXML_PackageKeyboard_Example_Note]);
+ Self.Add(FExample);
+ end;
+end;
+
+procedure TPackageKeyboardExampleList.SaveJSON(ARoot: TJSONObject);
+var
+ AExamples: TJSONArray;
+ j: Integer;
+ AExample: TJSONObject;
+begin
+ AExamples := TJSONArray.Create;
+ ARoot.AddPair(SJSON_Keyboard_Examples, AExamples);
+ for j := 0 to Count - 1 do
+ begin
+ AExample := TJSONObject.Create;
+ AExamples.Add(AExample);
+ AExample.AddPair(SJSON_Keyboard_Example_ID, Items[j].ID);
+ AExample.AddPair(SJSON_Keyboard_Example_Keys, Items[j].Keys);
+ AExample.AddPair(SJSON_Keyboard_Example_Text, Items[j].Text);
+ AExample.AddPair(SJSON_Keyboard_Example_Note, Items[j].Note);
+ end;
+end;
+
+procedure TPackageKeyboardExampleList.SaveXML(ARoot: IXMLNode);
+var
+ AExamples: IXMLNode;
+ j: Integer;
+ AExample: IXMLNode;
+begin
+ AExamples := ARoot.AddChild(SXML_PackageKeyboard_Examples);
+ for j := 0 to Count - 1 do
+ begin
+ AExample := AExamples.AddChild(SXML_PackageKeyboard_Example);
+ AExample.Attributes[SXML_PackageKeyboard_Example_ID] := Items[j].ID;
+ AExample.Attributes[SXML_PackageKeyboard_Example_Keys] := Items[j].Keys;
+ AExample.Attributes[SXML_PackageKeyboard_Example_Text] := Items[j].Text;
+ AExample.Attributes[SXML_PackageKeyboard_Example_Note] := Items[j].Note;
+ end;
+end;
+
+{ TPackageRelatedPackage }
+
+procedure TPackageRelatedPackage.Assign(Source: TPackageRelatedPackage);
+begin
+ FID := Source.ID;
+ FRelationship := Source.Relationship;
+end;
+
+{ TPackageRelatedPackageList }
+
+procedure TPackageRelatedPackageList.Assign(Source: TPackageRelatedPackageList);
+var
+ i: Integer;
+ rp: TPackageRelatedPackage;
+begin
+ Clear;
+ for i := 0 to Source.Count - 1 do
+ begin
+ rp := TPackageRelatedPackage.Create(Package);
+ rp.Assign(Source[i]);
+ Add(rp);
+ end;
+end;
+
+procedure TPackageRelatedPackageList.LoadJSON(ARoot: TJSONObject);
+var
+ rp: TPackageRelatedPackage;
+ i: Integer;
+ ANode: TJSONArray;
+ ARelatedPackage: TJSONObject;
+begin
+ Clear;
+
+ ANode := ARoot.Values[SJSON_RelatedPackages] as TJSONArray;
+ if not Assigned(ANode) then
+ Exit;
+
+ for i := 0 to ANode.Count - 1 do
+ begin
+ ARelatedPackage := ANode.Items[i] as TJSONObject;
+
+ rp := TPackageRelatedPackage.Create(Package);
+ rp.ID := GetJsonValueString(ARelatedPackage,SJSON_RelatedPackage_ID);
+ rp.Relationship := GetJsonValueString(ARelatedPackage, SJSON_RelatedPackage_Relationship);
+ if rp.Relationship <> 'deprecates' then
+ rp.Relationship := '';
+
+ Add(rp);
+ end;
+end;
+
+procedure TPackageRelatedPackageList.LoadXML(ARoot: IXMLNode);
+var
+ rp: TPackageRelatedPackage;
+ i: Integer;
+ ARelatedPackage, ANode: IXMLNode;
+begin
+ Clear;
+
+ ANode := ARoot.ChildNodes[SXML_PackageRelatedPackages];
+ for i := 0 to ANode.ChildNodes.Count - 1 do
+ begin
+ ARelatedPackage := ANode.ChildNodes[i];
+
+ rp := TPackageRelatedPackage.Create(Package);
+ rp.ID := XmlVarToStr(ARelatedPackage.Attributes[SXML_PackageRelatedPackage_ID]);
+ rp.Relationship := XmlVarToStr(ARelatedPackage.Attributes[SXML_PackageRelatedPackage_Relationship]);
+ if rp.Relationship <> 'deprecates' then
+ rp.Relationship := '';
+
+ Add(rp);
+ end;
+end;
+
+procedure TPackageRelatedPackageList.SaveJSON(ARoot: TJSONObject);
+var
+ i: Integer;
+ ARelatedPackage: TJSONObject;
+ ARelatedPackages: TJSONArray;
+begin
+ if Count = 0 then
+ Exit;
+
+ ARelatedPackages := TJSONArray.Create;
+ ARoot.AddPair(SJSON_RelatedPackages, ARelatedPackages);
+
+ for i := 0 to Count - 1 do
+ begin
+ ARelatedPackage := TJSONObject.Create;
+ ARelatedPackages.Add(ARelatedPackage);
+
+ ARelatedPackage.AddPair(SJSON_RelatedPackage_ID, Items[i].ID);
+ // Relationship field required for kmp.json
+ if Items[i].Relationship = ''
+ then ARelatedPackage.AddPair(SJSON_RelatedPackage_Relationship, 'related')
+ else ARelatedPackage.AddPair(SJSON_RelatedPackage_Relationship, Items[i].Relationship);
+ end;
+end;
+
+procedure TPackageRelatedPackageList.SaveXML(ARoot: IXMLNode);
+var
+ i: Integer;
+ ARelatedPackage, ANode: IXMLNode;
+begin
+ ANode := ARoot.AddChild(SXML_PackageRelatedPackages);
+ for i := 0 to Count - 1 do
+ begin
+ ARelatedPackage := ANode.AddChild(SXML_PackageRelatedPackage);
+
+ ARelatedPackage.Attributes[SXML_PackageRelatedPackage_ID] := Items[i].ID;
+ // Relationship field optional for .kps
+ if Items[i].Relationship <> '' then
+ ARelatedPackage.Attributes[SXML_PackageRelatedPackage_Relationship] := Items[i].Relationship;
+ end;
+end;
+
+{ TPackageContentFileReferenceList }
+
+procedure TPackageContentFileReferenceList.Assign(Source: TPackageContentFileReferenceList);
+var
+ i: Integer;
+ f: TPackageContentFile;
+begin
+ Clear;
+ for i := 0 to Source.Count - 1 do
+ begin
+ f := Package.Files.FromFileNameEx(Source[i].FileName);
+ if Assigned(f) then
+ Add(f);
+ end;
+end;
+
+constructor TPackageContentFileReferenceList.Create(APackage: TPackage);
+begin
+ inherited Create(APackage);
+ OwnsObjects := False;
+end;
+
+function TPackageContentFileReferenceList.GetAsString: string;
+var
+ f: TPackageContentFile;
+begin
+ Result := '';
+ for f in Self do
+ begin
+ Result := Result + ', ' + ExtractFileName(f.FileName);
+ end;
+ System.Delete(Result, 1, 2);
+end;
+
+procedure TPackageContentFileReferenceList.LoadJSON(ARoot: TJSONArray);
+var
+ i: Integer;
+ f: TPackageContentFile;
+begin
+ for i := 0 to ARoot.Count - 1 do
+ begin
+ f := Package.Files.FromFileNameEx(ARoot.Items[i].Value);
+ if Assigned(f) then
+ Add(f);
+ end;
+end;
+
+procedure TPackageContentFileReferenceList.LoadXML(ARoot: IXMLNode);
+var
+ i: Integer;
+ ANode: IXMLNode;
+ f: TPackageContentFile;
+begin
+ Clear;
+ for i := 0 to ARoot.ChildNodes.Count - 1 do
+ begin
+ ANode := ARoot.ChildNodes[i];
+ f := Package.Files.FromFileNameEx(ANode.Attributes[SXML_PackageKeyboardFont_Filename]);
+ if Assigned(f) then
+ Add(f);
+ end;
+end;
+
+procedure TPackageContentFileReferenceList.SaveJSON(ARoot: TJSONArray);
+var
+ i: Integer;
+begin
+ for i := 0 to Count - 1 do
+ begin
+ ARoot.Add(Items[i].FileName);
+ end;
+end;
+
+procedure TPackageContentFileReferenceList.SaveXML(ARoot: IXMLNode);
+var
+ i: Integer;
+ ANode: IXMLNode;
+begin
+ for i := 0 to Count - 1 do
+ begin
+ ANode := ARoot.AddChild(SXML_PackageKeyboardFont);
+ ANode.Attributes[SXML_PackageKeyboardFont_Filename] := Items[i].FileName;
+ end;
+end;
+
end.
diff --git a/common/windows/delphi/tools/Makefile b/common/windows/delphi/tools/Makefile
index a9c1151473a..2ea11ab2372 100644
--- a/common/windows/delphi/tools/Makefile
+++ b/common/windows/delphi/tools/Makefile
@@ -7,7 +7,7 @@ NOTARGET_SIGNCODE=yes
!ifdef NODELPHI
TARGETS=.virtual
!else
-TARGETS=build_standards_data buildunidata devtools sentrytool test-klog
+TARGETS=build_standards_data buildunidata devtools sentrytool test-klog verify_signatures
!endif
CLEANS=clean-tools
@@ -28,6 +28,10 @@ buildunidata: .virtual
cd $(COMMON_ROOT)\tools\buildunidata
$(MAKE) $(TARGET)
+verify_signatures: .virtual
+ cd $(COMMON_ROOT)\tools\verify_signatures
+ $(MAKE) $(TARGET)
+
devtools: .virtual
!ifdef NODELPHI
echo Skipping devtools
diff --git a/common/windows/delphi/tools/verify_signatures/Makefile b/common/windows/delphi/tools/verify_signatures/Makefile
new file mode 100644
index 00000000000..0f67747665e
--- /dev/null
+++ b/common/windows/delphi/tools/verify_signatures/Makefile
@@ -0,0 +1,13 @@
+#
+# test for signatures and version information being correct in ?install directory or ?bin directory
+#
+
+!include ..\..\Defines.mak
+
+build:
+ $(DELPHI_MSBUILD) verify_signatures.dproj
+ copy sigcheck.bin $(WIN32_TARGET_PATH)\sigcheck.exe
+
+clean: def-clean
+
+!include ..\..\Target.mak
diff --git a/windows/src/test/test_i3633/sigcheck.bin b/common/windows/delphi/tools/verify_signatures/sigcheck.bin
similarity index 100%
rename from windows/src/test/test_i3633/sigcheck.bin
rename to common/windows/delphi/tools/verify_signatures/sigcheck.bin
diff --git a/windows/src/test/test_i3633/verify.dpr b/common/windows/delphi/tools/verify_signatures/verify_signatures.dpr
similarity index 86%
rename from windows/src/test/test_i3633/verify.dpr
rename to common/windows/delphi/tools/verify_signatures/verify_signatures.dpr
index b3707d84617..49478ac3edf 100644
--- a/windows/src/test/test_i3633/verify.dpr
+++ b/common/windows/delphi/tools/verify_signatures/verify_signatures.dpr
@@ -1,4 +1,4 @@
-program verify;
+program verify_signatures;
{$APPTYPE CONSOLE}
@@ -36,6 +36,7 @@ begin
Delete(s,1,1);
end;
+ // TODO: sign these files and move the check down to the EndsWith node test
if str[0].ToLower.Contains('sentry.') or str[0].ToLower.Contains('crashpad_handler') or str[0].ToLower.Contains('keymanmc') then
// We don't verify sentry.dll or sentry.x64.dll or crashpad_handler.exe because they're not our files
// We don't verify keymanmc.dll because it has no version resources, as it is mc-generated
@@ -62,6 +63,14 @@ begin
end;
end;
+ if str[0].ToLower.EndsWith('node') then
+ begin
+ // It's one of the node addons -- in developer server at time of writing
+ // we don't have a version resource but we have signed it, so treat it
+ // as valid
+ Exit('');
+ end;
+
if str[3] <> 'SIL International' then
begin
Exit('File has wrong company name');
@@ -90,7 +99,7 @@ begin
if (ParamStr(1) = '-?') or (ParamCount < 1) then
begin
- writeln('verify [-d] VERSION.md: Verify the output of sigcheck to ensure all executables are signed and have proper version.');
+ writeln('verify_signatures [-d] VERSION.md: Verify the output of sigcheck to ensure all executables are signed and have proper version.');
writeln(' -d: Check the timestamp on the signature is less than 2 days old.');
writeln(' VERSION.md: path to the version to verify against');
Halt(2);
diff --git a/windows/src/test/test_i3633/verify.dproj b/common/windows/delphi/tools/verify_signatures/verify_signatures.dproj
similarity index 99%
rename from windows/src/test/test_i3633/verify.dproj
rename to common/windows/delphi/tools/verify_signatures/verify_signatures.dproj
index e23aeb3a4d8..323353c79b9 100644
--- a/windows/src/test/test_i3633/verify.dproj
+++ b/common/windows/delphi/tools/verify_signatures/verify_signatures.dproj
@@ -3,7 +3,7 @@
{A6DCA558-8DD0-4FFF-8DAE-F305AB8D2AF4}
18.8
None
- verify.dpr
+ verify_signatures.dpr
True
Debug
Win32
@@ -45,7 +45,7 @@
true
- verify
+ verify_signatures
$(BDS)\bin\delphi_PROJECTICNS.icns
$(BDS)\bin\delphi_PROJECTICON.ico
bindcompfmx;fmx;rtl;dbrtl;DbxClientDriver;bindcomp;inetdb;DBXInterBaseDriver;xmlrtl;DbxCommonDriver;DBXMySQLDriver;dbxcds;soaprtl;bindengine;CustomIPTransport;dsnap;fmxase;inet;fmxobj;inetdbxpress;fmxdae;dbexpress;$(DCC_UsePackage)
@@ -161,7 +161,7 @@
- verify.dpr
+ verify_signatures.dpr
Microsoft Office 2000 Sample Automation Server Wrapper Components
diff --git a/developer/src/test/auto/keyboard-package-versions/KeyboardPackageVersionsTestSuite.res b/common/windows/delphi/tools/verify_signatures/verify_signatures.res
similarity index 100%
rename from developer/src/test/auto/keyboard-package-versions/KeyboardPackageVersionsTestSuite.res
rename to common/windows/delphi/tools/verify_signatures/verify_signatures.res
diff --git a/core/commands.inc.sh b/core/commands.inc.sh
index 6916b61a9d9..2d3bccc4c08 100644
--- a/core/commands.inc.sh
+++ b/core/commands.inc.sh
@@ -11,7 +11,18 @@ do_clean() {
# clean: note build/ will be left, but build// should be gone
local target=$1
builder_start_action clean:$target || return 0
+
rm -rf "$MESON_PATH"
+
+ # Removes ICU cached components so it will be re-downloaded and built. Note:
+ # we could use `git clean`, but this clarifies exactly what is deleted, and
+ # but we try not to use git commands in build scripts, to maintain clear
+ # responsibility
+ rm -rf \
+ "$THIS_SCRIPT_PATH/subprojects/icu" \
+ "$THIS_SCRIPT_PATH/subprojects/*.tgz" \
+ "$THIS_SCRIPT_PATH/subprojects/*.zip"
+
builder_finish_action success clean:$target
}
diff --git a/core/doc/BUILDING.md b/core/doc/BUILDING.md
index ae066550465..5dfd46f9d61 100644
--- a/core/doc/BUILDING.md
+++ b/core/doc/BUILDING.md
@@ -8,10 +8,3 @@ See [build configuration](../../docs/build/index.md) for details on how to confi
On all platforms, use `build.sh`.
* See `./build.sh --help` for more details
-
-## Note on kmcomp
-
-kmcomp is the command-line compiler from Keyman Developer, available from
- or in this repo in
-`/windows/src/developer/kmcomp`. The compiler is currently available as a
-Windows PE executable only, but it does run under WINE.
diff --git a/core/doc/hotdoc.json b/core/doc/hotdoc.json
index 4ece50d0f52..946c62beac0 100644
--- a/core/doc/hotdoc.json
+++ b/core/doc/hotdoc.json
@@ -4,7 +4,7 @@
"sitemap": "@doc_dir@/sitemap.txt",
"index": "@doc_dir@/markdown_files/index.md",
"c_sources": [
- "@include_dir@/keyman/keyboardprocessor.h"
+ "@include_dir@/keyman/keyman_core_api.h"
],
"c_include_directories": [
"@include_dir@",
diff --git a/core/doc/introspection.schema b/core/doc/introspection.schema
index ff10c7c9695..3b7684e0e9d 100644
--- a/core/doc/introspection.schema
+++ b/core/doc/introspection.schema
@@ -47,7 +47,7 @@
}
},
"properties": {
- "$schema": { "const": "keyman/keyboardprocessor/doc/introspection.schema" },
+ "$schema": { "const": "keyman/core/doc/introspection.schema" },
"keyboard": { "$ref": "#/definitions/keyboard" },
"options": {
"type": "object",
diff --git a/core/doc/markdown_files/index.md b/core/doc/markdown_files/index.md
index 98870c356dc..d389857c5f6 100644
--- a/core/doc/markdown_files/index.md
+++ b/core/doc/markdown_files/index.md
@@ -46,7 +46,7 @@ A virtual key board event and modifier map recevied from the Platform layer to b
processed with the state object for this Client application.
- __Virtual Key:__
A code based on the US English layout, with values matching the Windows
-virtual key codes. See `keyboardprocessor_vkeys.h` for definitions.
+virtual key codes. See `keyman_core_api_vkeys.h` for definitions.
- __Modifier Key:__
The set of Control, Shift, Alt, Caps Lock keys. On some platforms these may
have other names (e.g. Alt is called Option on macOS); other platform-specific
@@ -58,4 +58,4 @@ Caps Lock.
### Namespace
-All calls, types and enums are prefixed with the namespace identifier `km_kbp_`
+All calls, types and enums are prefixed with the namespace identifier `km_core_`
diff --git a/core/doc/meson.build b/core/doc/meson.build
index 01fcb5c98ad..6039e2e2dda 100644
--- a/core/doc/meson.build
+++ b/core/doc/meson.build
@@ -18,7 +18,7 @@ if hotdoc.found()
output: 'hotdoc.json',
configuration: cfg)
deps = files(
- '../include/keyman/keyboardprocessor.h',
+ '../include/keyman/keyman_core_api.h',
'../src/jsonpp.hpp',
'../src/utfcodec.hpp'
)
diff --git a/core/include/keyman/keyboardprocessor_consts.h b/core/include/keyman/keyboardprocessor_consts.h
deleted file mode 100644
index 1d0936610b3..00000000000
--- a/core/include/keyman/keyboardprocessor_consts.h
+++ /dev/null
@@ -1,9 +0,0 @@
-#pragma once
-
-// Defined environment options for KMX processor
-#define KM_KBP_KMX_ENV_PLATFORM u"platform"
-#define KM_KBP_KMX_ENV_BASELAYOUT u"baseLayout"
-#define KM_KBP_KMX_ENV_BASELAYOUTALT u"baseLayoutAlt"
-#define KM_KBP_KMX_ENV_SIMULATEALTGR u"simulateAltgr"
-#define KM_KBP_KMX_ENV_CAPSLOCK u"capsLock"
-#define KM_KBP_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT u"baseLayoutGivesCtrlRAltForRAlt"
diff --git a/core/include/keyman/keyboardprocessor_version.h.in b/core/include/keyman/keyboardprocessor_version.h.in
deleted file mode 100644
index d434ae4e485..00000000000
--- a/core/include/keyman/keyboardprocessor_version.h.in
+++ /dev/null
@@ -1,15 +0,0 @@
-#define km_kbp_version_stringify(x) km_kbp_version_to_string(x)
-#define km_kbp_version_to_string(x) #x
-
-// Product versioning
-
-#define KM_KBP_VERSION_MAJOR @majorver@
-#define KM_KBP_VERSION_MINOR @minorver@
-#define KM_KBP_VERSION_PATCH @patchver@
-#define KM_KBP_VERSION_STRING km_kbp_version_stringify(@majorver@ ## . ## @minorver@ ## . ## @patchver@ ## .0)
-
-// API versioning
-
-#define KM_KBP_LIB_CURRENT @lib_curr@
-#define KM_KBP_LIB_AGE @lib_age@
-#define KM_KBP_LIB_REVISION @lib_rev@
diff --git a/core/include/keyman/keyboardprocessor_vkeys.h b/core/include/keyman/keyboardprocessor_vkeys.h
deleted file mode 100644
index e8d8122bda2..00000000000
--- a/core/include/keyman/keyboardprocessor_vkeys.h
+++ /dev/null
@@ -1,312 +0,0 @@
-/*
- Copyright: © 2018 SIL International.
- Description: API declarations for modifier keys, handy access masks and
- Keyman VKEY names. These follow the same keytop->code
- associations as the Windows API. This is a separate header to
- maintain readability of the primary API header.
- Create Date: 17 Oct 2018
- Authors: Tim Eves (TSE)
- History: 17 Oct 2018 - TSE - Moved & refactored km_kbp_modifier_state
- from keyboardprocessor.h.
- - Added VKey and mask definitions.
- 6 Oct 2018 - TSE - Move into keyman folder.
-
-*/
-
-#pragma once
-
-enum km_kbp_modifier_state {
- KM_KBP_MODIFIER_LCTRL = 1 << 0,
- KM_KBP_MODIFIER_RCTRL = 1 << 1,
- KM_KBP_MODIFIER_LALT = 1 << 2,
- KM_KBP_MODIFIER_RALT = 1 << 3,
- KM_KBP_MODIFIER_SHIFT = 1 << 4,
- KM_KBP_MODIFIER_CTRL = 1 << 5,
- KM_KBP_MODIFIER_ALT = 1 << 6,
- /*
- KM_KBP_MODIFIER_META = 1 << 7, // Either Meta-key flag (tentative). Not usable by keyboards currently
- // Used internally (currently, only by KMW) to ensure Meta-key
- // shortcuts safely bypass rules
- // Meta key = Command key on macOS, Windows key on Windows
- */
- KM_KBP_MODIFIER_CAPS = 1 << 8,
- KM_KBP_MODIFIER_NOCAPS = 1 << 9,
- /*
- KM_KBP_MODIFIER_NUMLOCK = 1 << 10,
- KM_KBP_MODIFIER_NONUMLOCK = 1 << 11,
- KM_KBP_MODIFIER_SCROLLOCK = 1 << 12,
- KM_KBP_MODIFIER_NOSCROLLOCK = 1 << 13,
- KM_KBP_MODIFIER_VIRTUALKEY = 1 << 14,
- */
-};
-
-enum km_kbp_modifier_mask {
- KM_KBP_MODIFIER_MASK_ALL = 0x7f,
- KM_KBP_MODIFIER_MASK_ALT_GR_SIM = KM_KBP_MODIFIER_LCTRL|KM_KBP_MODIFIER_LALT,
- KM_KBP_MODIFIER_MASK_CHIRAL = 0x1f,
- KM_KBP_MODIFIER_MASK_IS_CHIRAL = 0x0f,
- KM_KBP_MODIFIER_MASK_NON_CHIRAL = 0x7f,
- KM_KBP_MODIFIER_MASK_CAPS = 0x0300,
-/*KM_KBP_MODIFIER_MASK_NUMLOCK = 0x0C00,
- KM_KBP_MODIFIER_MASK_SCROLLLOCK = 0x3000,*/
-};
-
-// These are Windows API VKEYs, using Keyman VKEY names.
-enum km_kpb_virtual_key {
- KM_KBP_VKEY__00,
- KM_KBP_VKEY_LBUTTON,
- KM_KBP_VKEY_RBUTTON,
- KM_KBP_VKEY_CANCEL,
- KM_KBP_VKEY_MBUTTON,
- KM_KBP_VKEY__05,
- KM_KBP_VKEY__06,
- KM_KBP_VKEY__07,
- KM_KBP_VKEY_BKSP,
- KM_KBP_VKEY_TAB,
- KM_KBP_VKEY__0A,
- KM_KBP_VKEY__0B,
- KM_KBP_VKEY_KP5,
- KM_KBP_VKEY_ENTER,
- KM_KBP_VKEY__0E,
- KM_KBP_VKEY__0F,
- KM_KBP_VKEY_SHIFT,
- KM_KBP_VKEY_CONTROL,
- KM_KBP_VKEY_ALT,
- KM_KBP_VKEY_PAUSE,
- KM_KBP_VKEY_CAPS,
- KM_KBP_VKEY__15,
- KM_KBP_VKEY__16,
- KM_KBP_VKEY__17,
- KM_KBP_VKEY__18,
- KM_KBP_VKEY__19,
- KM_KBP_VKEY__1A,
- KM_KBP_VKEY_ESC,
- KM_KBP_VKEY__1C,
- KM_KBP_VKEY__1D,
- KM_KBP_VKEY__1E,
- KM_KBP_VKEY__1F,
- KM_KBP_VKEY_SPACE,
- KM_KBP_VKEY_PGUP,
- KM_KBP_VKEY_PGDN,
- KM_KBP_VKEY_END,
- KM_KBP_VKEY_HOME,
- KM_KBP_VKEY_LEFT,
- KM_KBP_VKEY_UP,
- KM_KBP_VKEY_RIGHT,
- KM_KBP_VKEY_DOWN,
- KM_KBP_VKEY_SEL,
- KM_KBP_VKEY_PRINT,
- KM_KBP_VKEY_EXEC,
- KM_KBP_VKEY_PRTSCN,
- KM_KBP_VKEY_INS,
- KM_KBP_VKEY_DEL,
- KM_KBP_VKEY_HELP,
- KM_KBP_VKEY_0,
- KM_KBP_VKEY_1,
- KM_KBP_VKEY_2,
- KM_KBP_VKEY_3,
- KM_KBP_VKEY_4,
- KM_KBP_VKEY_5,
- KM_KBP_VKEY_6,
- KM_KBP_VKEY_7,
- KM_KBP_VKEY_8,
- KM_KBP_VKEY_9,
- KM_KBP_VKEY__3A,
- KM_KBP_VKEY__3B,
- KM_KBP_VKEY__3C,
- KM_KBP_VKEY__3D,
- KM_KBP_VKEY__3E,
- KM_KBP_VKEY__3F,
- KM_KBP_VKEY__40,
- KM_KBP_VKEY_A,
- KM_KBP_VKEY_B,
- KM_KBP_VKEY_C,
- KM_KBP_VKEY_D,
- KM_KBP_VKEY_E,
- KM_KBP_VKEY_F,
- KM_KBP_VKEY_G,
- KM_KBP_VKEY_H,
- KM_KBP_VKEY_I,
- KM_KBP_VKEY_J,
- KM_KBP_VKEY_K,
- KM_KBP_VKEY_L,
- KM_KBP_VKEY_M,
- KM_KBP_VKEY_N,
- KM_KBP_VKEY_O,
- KM_KBP_VKEY_P,
- KM_KBP_VKEY_Q,
- KM_KBP_VKEY_R,
- KM_KBP_VKEY_S,
- KM_KBP_VKEY_T,
- KM_KBP_VKEY_U,
- KM_KBP_VKEY_V,
- KM_KBP_VKEY_W,
- KM_KBP_VKEY_X,
- KM_KBP_VKEY_Y,
- KM_KBP_VKEY_Z,
- KM_KBP_VKEY__5B,
- KM_KBP_VKEY__5C,
- KM_KBP_VKEY__5D,
- KM_KBP_VKEY__5E,
- KM_KBP_VKEY__5F,
- KM_KBP_VKEY_NP0,
- KM_KBP_VKEY_NP1,
- KM_KBP_VKEY_NP2,
- KM_KBP_VKEY_NP3,
- KM_KBP_VKEY_NP4,
- KM_KBP_VKEY_NP5,
- KM_KBP_VKEY_NP6,
- KM_KBP_VKEY_NP7,
- KM_KBP_VKEY_NP8,
- KM_KBP_VKEY_NP9,
- KM_KBP_VKEY_NPSTAR,
- KM_KBP_VKEY_NPPLUS,
- KM_KBP_VKEY_SEPARATOR,
- KM_KBP_VKEY_NPMINUS,
- KM_KBP_VKEY_NPDOT,
- KM_KBP_VKEY_NPSLASH,
- KM_KBP_VKEY_F1,
- KM_KBP_VKEY_F2,
- KM_KBP_VKEY_F3,
- KM_KBP_VKEY_F4,
- KM_KBP_VKEY_F5,
- KM_KBP_VKEY_F6,
- KM_KBP_VKEY_F7,
- KM_KBP_VKEY_F8,
- KM_KBP_VKEY_F9,
- KM_KBP_VKEY_F10,
- KM_KBP_VKEY_F11,
- KM_KBP_VKEY_F12,
- KM_KBP_VKEY_F13,
- KM_KBP_VKEY_F14,
- KM_KBP_VKEY_F15,
- KM_KBP_VKEY_F16,
- KM_KBP_VKEY_F17,
- KM_KBP_VKEY_F18,
- KM_KBP_VKEY_F19,
- KM_KBP_VKEY_F20,
- KM_KBP_VKEY_F21,
- KM_KBP_VKEY_F22,
- KM_KBP_VKEY_F23,
- KM_KBP_VKEY_F24,
- KM_KBP_VKEY__88,
- KM_KBP_VKEY__89,
- KM_KBP_VKEY__8A,
- KM_KBP_VKEY__8B,
- KM_KBP_VKEY__8C,
- KM_KBP_VKEY__8D,
- KM_KBP_VKEY__8E,
- KM_KBP_VKEY__8F,
- KM_KBP_VKEY_NUMLOCK,
- KM_KBP_VKEY_SCROLL,
- KM_KBP_VKEY__92,
- KM_KBP_VKEY__93,
- KM_KBP_VKEY__94,
- KM_KBP_VKEY__95,
- KM_KBP_VKEY__96,
- KM_KBP_VKEY__97,
- KM_KBP_VKEY__98,
- KM_KBP_VKEY__99,
- KM_KBP_VKEY__9A,
- KM_KBP_VKEY__9B,
- KM_KBP_VKEY__9C,
- KM_KBP_VKEY__9D,
- KM_KBP_VKEY__9E,
- KM_KBP_VKEY__9F,
- KM_KBP_VKEY__A0,
- KM_KBP_VKEY__A1,
- KM_KBP_VKEY__A2,
- KM_KBP_VKEY__A3,
- KM_KBP_VKEY__A4,
- KM_KBP_VKEY__A5,
- KM_KBP_VKEY__A6,
- KM_KBP_VKEY__A7,
- KM_KBP_VKEY__A8,
- KM_KBP_VKEY__A9,
- KM_KBP_VKEY__AA,
- KM_KBP_VKEY__AB,
- KM_KBP_VKEY__AC,
- KM_KBP_VKEY__AD,
- KM_KBP_VKEY__AE,
- KM_KBP_VKEY__AF,
- KM_KBP_VKEY__B0,
- KM_KBP_VKEY__B1,
- KM_KBP_VKEY__B2,
- KM_KBP_VKEY__B3,
- KM_KBP_VKEY__B4,
- KM_KBP_VKEY__B5,
- KM_KBP_VKEY__B6,
- KM_KBP_VKEY__B7,
- KM_KBP_VKEY__B8,
- KM_KBP_VKEY__B9,
- KM_KBP_VKEY_COLON,
- KM_KBP_VKEY_EQUAL,
- KM_KBP_VKEY_COMMA,
- KM_KBP_VKEY_HYPHEN,
- KM_KBP_VKEY_PERIOD,
- KM_KBP_VKEY_SLASH,
- KM_KBP_VKEY_BKQUOTE,
- KM_KBP_VKEY__C1,
- KM_KBP_VKEY__C2,
- KM_KBP_VKEY__C3,
- KM_KBP_VKEY__C4,
- KM_KBP_VKEY__C5,
- KM_KBP_VKEY__C6,
- KM_KBP_VKEY__C7,
- KM_KBP_VKEY__C8,
- KM_KBP_VKEY__C9,
- KM_KBP_VKEY__CA,
- KM_KBP_VKEY__CB,
- KM_KBP_VKEY__CC,
- KM_KBP_VKEY__CD,
- KM_KBP_VKEY__CE,
- KM_KBP_VKEY__CF,
- KM_KBP_VKEY__D0,
- KM_KBP_VKEY__D1,
- KM_KBP_VKEY__D2,
- KM_KBP_VKEY__D3,
- KM_KBP_VKEY__D4,
- KM_KBP_VKEY__D5,
- KM_KBP_VKEY__D6,
- KM_KBP_VKEY__D7,
- KM_KBP_VKEY__D8,
- KM_KBP_VKEY__D9,
- KM_KBP_VKEY__DA,
- KM_KBP_VKEY_LBRKT,
- KM_KBP_VKEY_BKSLASH,
- KM_KBP_VKEY_RBRKT,
- KM_KBP_VKEY_QUOTE,
- KM_KBP_VKEY_oDF,
- KM_KBP_VKEY_oE0,
- KM_KBP_VKEY_oE1,
- KM_KBP_VKEY_oE2, // 102nd key on European layouts
- KM_KBP_VKEY_oE3,
- KM_KBP_VKEY_oE4,
- KM_KBP_VKEY__E5,
- KM_KBP_VKEY_oE6,
- KM_KBP_VKEY__E7,
- KM_KBP_VKEY__E8,
- KM_KBP_VKEY_oE9,
- KM_KBP_VKEY_oEA,
- KM_KBP_VKEY_oEB,
- KM_KBP_VKEY_oEC,
- KM_KBP_VKEY_oED,
- KM_KBP_VKEY_oEE,
- KM_KBP_VKEY_oEF,
- KM_KBP_VKEY_oF0,
- KM_KBP_VKEY_oF1,
- KM_KBP_VKEY_oF2,
- KM_KBP_VKEY_oF3,
- KM_KBP_VKEY_oF4,
- KM_KBP_VKEY_oF5,
- KM_KBP_VKEY__F6,
- KM_KBP_VKEY__F7,
- KM_KBP_VKEY__F8,
- KM_KBP_VKEY__F9,
- KM_KBP_VKEY__FA,
- KM_KBP_VKEY__FB,
- KM_KBP_VKEY__FC,
- KM_KBP_VKEY__FD,
- KM_KBP_VKEY__FE,
- KM_KBP_VKEY__FF,
-};
diff --git a/core/include/keyman/keyboardprocessor.h b/core/include/keyman/keyman_core_api.h
similarity index 58%
rename from core/include/keyman/keyboardprocessor.h
rename to core/include/keyman/keyman_core_api.h
index 429a8ae6cbf..86358edeebd 100644
--- a/core/include/keyman/keyboardprocessor.h
+++ b/core/include/keyman/keyman_core_api.h
@@ -57,7 +57,7 @@ A virtual key event and modifier map received from the Platform layer to be
processed with the state object for this Client application.
- __Virtual Key:__
A code based on the US English layout, with values matching the Windows
-virtual key codes. See `keyboardprocessor_vkeys.h` for definitions.
+virtual key codes. See `keyman_core_api_vkeys.h` for definitions.
- __Modifier Key:__
The set of Control, Shift, Alt, Caps Lock keys. On some platforms these may
have other names (e.g. Alt is called Option on macOS); other platform-specific
@@ -67,25 +67,25 @@ Caps Lock.
## API
### Namespace
-All calls, types and enums are prefixed with the namespace identifier `km_kbp_`
+All calls, types and enums are prefixed with the namespace identifier `km_core_`
### API idioms
Almost all calls marshalling variable length aggregate data in or out of an API
object take the form:
-> km_kbp_status *fn_name*(object_ref, buffer_ptr, size_ptr)
+> km_core_status *fn_name*(object_ref, buffer_ptr, size_ptr)
where the buffer is nullable and all other arguments are required (will result
-in an `KM_KBP_STATUS_INVALID_ARGUMENT` status being returned if nulled). When
+in an `KM_CORE_STATUS_INVALID_ARGUMENT` status being returned if nulled). When
`buffer` is `nullptr` or `0` the function will place the size of the required
buffer in the variable pointed to by `size_ptr`.
Calls which result in the allocation of resources, regardless of resulting
ownership, are of the form:
-> km_kbp_status *fn_name*(object_ref, out_ptr)
+> km_core_status *fn_name*(object_ref, out_ptr)
where `out_ptr` is a valid pointer to a caller allocated variable to hold the
resulting ouput. This is often a reference to a created object. All arguments
-are required (will result in an `KM_KBP_STATUS_INVALID_ARGUMENT` status being
+are required (will result in an `KM_CORE_STATUS_INVALID_ARGUMENT` status being
returned if nulled).
For accessors to fixed size attributes of an object these will take the form:
@@ -100,9 +100,9 @@ nothing in that event.
*/
#include
#include
-#include
-#include
-#include
+#include
+#include
+#include
#if defined(__cplusplus)
extern "C"
@@ -110,24 +110,24 @@ extern "C"
#endif
// Basic types
//
-typedef uint16_t km_kbp_virtual_key; // A virtual key code.
-typedef uint32_t km_kbp_status; // Status return code.
+typedef uint16_t km_core_virtual_key; // A virtual key code.
+typedef uint32_t km_core_status; // Status return code.
// Opaque object types.
//
-typedef struct km_kbp_context km_kbp_context;
-typedef struct km_kbp_keyboard km_kbp_keyboard;
-typedef struct km_kbp_state km_kbp_state;
-typedef struct km_kbp_options km_kbp_options;
+typedef struct km_core_context km_core_context;
+typedef struct km_core_keyboard km_core_keyboard;
+typedef struct km_core_state km_core_state;
+typedef struct km_core_options km_core_options;
// Forward declarations
//
-typedef struct km_kbp_option_item km_kbp_option_item;
+typedef struct km_core_option_item km_core_option_item;
// Callback function used to to access Input Method eXtension library functions
// from Keyman Core
//
-typedef uint8_t (*km_kbp_keyboard_imx_platform)(km_kbp_state*, uint32_t, void*);
+typedef uint8_t (*km_core_keyboard_imx_platform)(km_core_state*, uint32_t, void*);
/*```
### Error Handling
@@ -137,21 +137,21 @@ value is an error). Any functions that can fail will always return a status
value and all results are returned via outparams passed to the function.
```c
*/
-enum km_kbp_status_codes {
- KM_KBP_STATUS_OK = 0,
- KM_KBP_STATUS_NO_MEM = 1,
- KM_KBP_STATUS_IO_ERROR = 2,
- KM_KBP_STATUS_INVALID_ARGUMENT = 3,
- KM_KBP_STATUS_KEY_ERROR = 4,
- KM_KBP_STATUS_INSUFFICENT_BUFFER = 5,
- KM_KBP_STATUS_INVALID_UTF = 6,
- KM_KBP_STATUS_INVALID_KEYBOARD = 7,
- KM_KBP_STATUS_OS_ERROR = 0x80000000
+enum km_core_status_codes {
+ KM_CORE_STATUS_OK = 0,
+ KM_CORE_STATUS_NO_MEM = 1,
+ KM_CORE_STATUS_IO_ERROR = 2,
+ KM_CORE_STATUS_INVALID_ARGUMENT = 3,
+ KM_CORE_STATUS_KEY_ERROR = 4,
+ KM_CORE_STATUS_INSUFFICENT_BUFFER = 5,
+ KM_CORE_STATUS_INVALID_UTF = 6,
+ KM_CORE_STATUS_INVALID_KEYBOARD = 7,
+ KM_CORE_STATUS_OS_ERROR = 0x80000000
};
/*
```
-The final status code KM_KBP_STATUS_OS_ERROR is intended to allow encapsulating
+The final status code KM_CORE_STATUS_OS_ERROR is intended to allow encapsulating
a platform error code; the remaining 31 low bits are the error code returned by
the OS for cases where the failure mode is platform specific. For HRESULT codes
this only permits failure codes to be passed.
@@ -176,79 +176,79 @@ Contexts are always owned by their state. They may be set to a list of
context_items or interrogated for their current list of context items.
```c
*/
-enum km_kbp_context_type {
- KM_KBP_CT_END,
- KM_KBP_CT_CHAR,
- KM_KBP_CT_MARKER
+enum km_core_context_type {
+ KM_CORE_CT_END,
+ KM_CORE_CT_CHAR,
+ KM_CORE_CT_MARKER
};
typedef struct {
uint8_t type;
uint8_t _reserved[3];
union {
- km_kbp_usv character;
+ km_core_usv character;
uint32_t marker;
};
-} km_kbp_context_item;
+} km_core_context_item;
-#define KM_KBP_CONTEXT_ITEM_END {KM_KBP_CT_END, {0,}, {0,}}
+#define KM_CORE_CONTEXT_ITEM_END {KM_CORE_CT_END, {0,}, {0,}}
/*
```
-### `km_kbp_context_items_from_utf16`
+### `km_core_context_items_from_utf16`
##### Description:
-Convert a UTF16 encoded Unicode string into an array of `km_kbp_context_item`
+Convert a UTF16 encoded Unicode string into an array of `km_core_context_item`
structures. Allocates memory as needed.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: In the event not enough memory can be allocated for the
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: In the event not enough memory can be allocated for the
output buffer.
-- `KM_KBP_STATUS_INVALID_UTF`: In the event the UTF16 string cannot be decoded
+- `KM_CORE_STATUS_INVALID_UTF`: In the event the UTF16 string cannot be decoded
because it contains unpaired surrogate codeunits.
##### Parameters:
- __text__: a pointer to a null terminated array of utf16 encoded data.
- __out_ptr__: a pointer to the result variable:
- A pointer to the start of the `km_kbp_context_item` array containing the
+ A pointer to the start of the `km_core_context_item` array containing the
representation of the input string.
- Terminated with a type of `KM_KBP_CT_END`. Must be disposed of with
- `km_kbp_context_items_dispose`.
+ Terminated with a type of `KM_CORE_CT_END`. Must be disposed of with
+ `km_core_context_items_dispose`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_items_from_utf16(km_kbp_cp const *text,
- km_kbp_context_item **out_ptr);
+km_core_status
+km_core_context_items_from_utf16(km_core_cp const *text,
+ km_core_context_item **out_ptr);
/*
```
-### `km_kbp_context_items_from_utf8`
+### `km_core_context_items_from_utf8`
##### Description:
-Convert an UTF8 encoded Unicode string into an array of `km_kbp_context_item`
+Convert an UTF8 encoded Unicode string into an array of `km_core_context_item`
structures. Allocates memory as needed.
##### Status:
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: In the event it cannot allocate enough memory for the
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: In the event it cannot allocate enough memory for the
output buffer.
-- `KM_KBP_STATUS_INVALID_UTF`: In the event the UTF8 string cannot be
+- `KM_CORE_STATUS_INVALID_UTF`: In the event the UTF8 string cannot be
decoded.
##### Parameters:
- __text__: a pointer to a null terminated array of utf8 encoded data.
- __out_ptr__: a pointer to the result variable:
- A pointer to the start of the `km_kbp_context_item` array containing the
+ A pointer to the start of the `km_core_context_item` array containing the
representation of the input string.
- Terminated with a type of `KM_KBP_CT_END`.
+ Terminated with a type of `KM_CORE_CT_END`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_items_from_utf8(char const *text,
- km_kbp_context_item **out_ptr);
+km_core_status
+km_core_context_items_from_utf8(char const *text,
+ km_core_context_item **out_ptr);
/*
```
-### `km_kbp_context_items_to_utf16`
+### `km_core_context_items_to_utf16`
##### Description:
Convert a context item array into a UTF-16 encoded string placing it into
the supplied buffer of specified size, and return the number of code units
@@ -256,14 +256,14 @@ actually used in the conversion. If null is passed as the buffer the
number codeunits required is returned. This will strip markers from the
context during the conversion.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_INSUFFICENT_BUFFER`: If the buffer is not large enough.
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_INSUFFICENT_BUFFER`: If the buffer is not large enough.
`buf_size` will contain the space required. The contents of the buffer are
undefined.
##### Parameters:
-- __context_items__: A pointer to the start of an array `km_kbp_context_item`.
- Must be terminated with a type of `KM_KBP_CT_END`.
+- __context_items__: A pointer to the start of an array `km_core_context_item`.
+ Must be terminated with a type of `KM_CORE_CT_END`.
- __buf__: A pointer to the buffer to place the UTF-16 string into.
May be null to request size calculation.
- __buf_size__: a pointer to the result variable:
@@ -273,14 +273,14 @@ context during the conversion.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_items_to_utf16(km_kbp_context_item const *item,
- km_kbp_cp *buf,
+km_core_status
+km_core_context_items_to_utf16(km_core_context_item const *item,
+ km_core_cp *buf,
size_t *buf_size);
/*
```
-### `km_kbp_context_items_to_utf8`
+### `km_core_context_items_to_utf8`
##### Description:
Convert a context item array into a UTF-8 encoded string placing it into
the supplied buffer of specified size, and return the number of code units
@@ -288,14 +288,14 @@ actually used in the conversion. If null is passed as the buffer the
number codeunits required is returned. This will strip markers from the
context during the conversion.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_INSUFFICENT_BUFFER`: If the buffer is not large enough.
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_INSUFFICENT_BUFFER`: If the buffer is not large enough.
`buf_size` will contain the space required. The contents of the buffer are
undefined.
##### Parameters:
-- __context_items__: A pointer to the start of an array `km_kbp_context_item`.
- Must be terminated with a type of `KM_KBP_CT_END`.
+- __context_items__: A pointer to the start of an array `km_core_context_item`.
+ Must be terminated with a type of `KM_CORE_CT_END`.
- __buf__: A pointer to the buffer to place the UTF-8 string into.
May be null to request size calculation.
- __buf_size__: a pointer to the result variable:
@@ -305,79 +305,79 @@ context during the conversion.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_items_to_utf8(km_kbp_context_item const *item,
+km_core_status
+km_core_context_items_to_utf8(km_core_context_item const *item,
char *buf,
size_t *buf_size);
/*
```
-### `km_kbp_context_items_dispose`
+### `km_core_context_items_dispose`
##### Description:
-Free the allocated memory belonging to a `km_kbp_context_item` array previously
-returned by `km_kbp_context_items_from_utf16` or `km_kbp_context_get`
+Free the allocated memory belonging to a `km_core_context_item` array previously
+returned by `km_core_context_items_from_utf16` or `km_core_context_get`
##### Parameters:
-- __context_items__: A pointer to the start of the `km_kbp_context_item` array
+- __context_items__: A pointer to the start of the `km_core_context_item` array
to be disposed of.
```c
*/
KMN_API
void
-km_kbp_context_items_dispose(km_kbp_context_item *context_items);
+km_core_context_items_dispose(km_core_context_item *context_items);
/*
```
-### `km_kbp_context_set`
+### `km_core_context_set`
##### Description:
Replace the contents of the current context with a new sequence of
-`km_kbp_context_item` entries.
+`km_core_context_item` entries.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: In the event not enough memory can be allocated to
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: In the event not enough memory can be allocated to
grow the context buffer internally.
##### Parameters:
- __context__: A pointer to an opaque context object
-- __context_items__: A pointer to the start of the `km_kbp_context_item`
+- __context_items__: A pointer to the start of the `km_core_context_item`
array containing the new context. It must be terminated with an item
- of type `KM_KBP_CT_END`.
+ of type `KM_CORE_CT_END`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_set(km_kbp_context *context,
- km_kbp_context_item const *context_items);
+km_core_status
+km_core_context_set(km_core_context *context,
+ km_core_context_item const *context_items);
/*
```
-### `km_kbp_context_get`
+### `km_core_context_get`
##### Description:
Copies all items in the context into a new array and returns the new array.
-This must be disposed of by caller using `km_kbp_context_items_dispose`.
+This must be disposed of by caller using `km_core_context_items_dispose`.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: In the event not enough memory can be allocated for the
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: In the event not enough memory can be allocated for the
output buffer.
##### Parameters:
-- __context_items__: A pointer to the start of an array `km_kbp_context_item`.
+- __context_items__: A pointer to the start of an array `km_core_context_item`.
- __out__: a pointer to the result variable:
- A pointer to the start of the `km_kbp_context_item` array containing a
- copy of the context. Terminated with a type of `KM_KBP_CT_END`. Must be
- disposed of with `km_kbp_context_items_dispose`.
+ A pointer to the start of the `km_core_context_item` array containing a
+ copy of the context. Terminated with a type of `KM_CORE_CT_END`. Must be
+ disposed of with `km_core_context_items_dispose`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_get(km_kbp_context const *context_items,
- km_kbp_context_item **out);
+km_core_status
+km_core_context_get(km_core_context const *context_items,
+ km_core_context_item **out);
/*
```
-### `km_kbp_context_clear`
+### `km_core_context_clear`
##### Description:
Removes all context_items from the internal array. If `context` is
null, has no effect.
@@ -388,11 +388,11 @@ null, has no effect.
*/
KMN_API
void
-km_kbp_context_clear(km_kbp_context *);
+km_core_context_clear(km_core_context *);
/*
```
-### `km_kbp_context_length`
+### `km_core_context_length`
##### Description:
Return the number of items in the context.
##### Return:
@@ -405,75 +405,75 @@ pointer.
*/
KMN_API
size_t
-km_kbp_context_length(km_kbp_context *);
+km_core_context_length(km_core_context *);
/*
```
-### `km_kbp_context_append`
+### `km_core_context_append`
##### Description:
Add more items to the end (insertion point) of the context. If these exceed the
maximum context length the same number of items will be dropped from the
beginning of the context.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: In the event not enough memory can be allocated to
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: In the event not enough memory can be allocated to
grow the context buffer internally.
##### Parameters:
- __context__: A pointer to an opaque context object.
-- __context_items__: A pointer to the start of the `KM_KBP_CT_END` terminated
- array of `km_kbp_context_item` to append.
+- __context_items__: A pointer to the start of the `KM_CORE_CT_END` terminated
+ array of `km_core_context_item` to append.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_append(km_kbp_context *context,
- km_kbp_context_item const *context_items);
+km_core_status
+km_core_context_append(km_core_context *context,
+ km_core_context_item const *context_items);
/*
```
-### `km_kbp_context_shrink`
+### `km_core_context_shrink`
##### Description:
Remove a specified number of items from the end of the context, optionally
add up to the same number of the supplied items to the front of the context.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: in the event it cannot allocated enough memory to grow
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: in the event it cannot allocated enough memory to grow
the context internally.
##### Parameters:
- __context__: A pointer to an opaque context object.
- __num__: The number of items to remove from the end of context.
-- __context_items__: Pointer to the start of the `KM_KBP_CT_END` terminated
- array of `km_kbp_context_item` to add to the front. Up to `num` items will
+- __context_items__: Pointer to the start of the `KM_CORE_CT_END` terminated
+ array of `km_core_context_item` to add to the front. Up to `num` items will
be prepended. This may be null if not required.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_context_shrink(km_kbp_context *context,
+km_core_status
+km_core_context_shrink(km_core_context *context,
size_t num,
- km_kbp_context_item const *prefix);
+ km_core_context_item const *prefix);
/*
```
-### `km_kbp_context_item_list_size`
+### `km_core_context_item_list_size`
##### Description:
-Return the length of a terminated `km_kbp_context_item` array.
+Return the length of a terminated `km_core_context_item` array.
##### Return:
The number of items in the list, not including terminating item,
or 0 if `context_items` is null.
##### Parameters:
-- __context_items__: A pointer to a `KM_KBP_CT_END` terminated array of
- `km_kbp_context_item` values.
+- __context_items__: A pointer to a `KM_CORE_CT_END` terminated array of
+ `km_core_context_item` values.
```c
*/
KMN_API
size_t
-km_kbp_context_item_list_size(km_kbp_context_item const *context_items);
+km_core_context_item_list_size(km_core_context_item const *context_items);
/*
```
@@ -486,15 +486,15 @@ other actions.
*/
typedef struct {
- uint8_t expected_type; // km_kbp_backspace_type
+ uint8_t expected_type; // km_core_backspace_type
uintptr_t expected_value; // used mainly in unit tests
-} km_kbp_backspace_item;
+} km_core_backspace_item;
-enum km_kbp_backspace_type {
- KM_KBP_BT_UNKNOWN = 0, // Used at beginning of context; user-initiated backspace
- KM_KBP_BT_CHAR = 1, // Deleting a character prior to insertion point
- KM_KBP_BT_MARKER = 2, // Deleting a marker prior to insertion point
- KM_KBP_BT_MAX_TYPE_ID
+enum km_core_backspace_type {
+ KM_CORE_BT_UNKNOWN = 0, // Used at beginning of context; user-initiated backspace
+ KM_CORE_BT_CHAR = 1, // Deleting a character prior to insertion point
+ KM_CORE_BT_MARKER = 2, // Deleting a marker prior to insertion point
+ KM_CORE_BT_MAX_TYPE_ID
};
typedef struct {
@@ -502,28 +502,28 @@ typedef struct {
uint8_t _reserved[sizeof(void*)-sizeof(uint8_t)];
union {
uintptr_t marker; // MARKER type
- km_kbp_option_item const * option; // OPT types
- km_kbp_usv character; // CHAR type
+ km_core_option_item const * option; // OPT types
+ km_core_usv character; // CHAR type
uint8_t capsLock; // CAPSLOCK type, 1 to turn on, 0 to turn off
- km_kbp_backspace_item backspace; // BACKSPACE type
+ km_core_backspace_item backspace; // BACKSPACE type
};
-} km_kbp_action_item;
-
-enum km_kbp_action_type {
- KM_KBP_IT_END = 0, // Marks end of action items list.
- KM_KBP_IT_CHAR = 1, // A Unicode character has been generated.
- KM_KBP_IT_MARKER = 2, // Correlates to kmn's "deadkey" markers.
- KM_KBP_IT_ALERT = 3, // The keyboard has triggered a alert/beep/bell.
- KM_KBP_IT_BACK = 4, // Delete the codepoint preceding the insertion point.
- KM_KBP_IT_PERSIST_OPT = 5, // The indicated option needs to be stored.
- KM_KBP_IT_EMIT_KEYSTROKE = 6, // Emit the current keystroke to the application
- KM_KBP_IT_INVALIDATE_CONTEXT = 7,
+} km_core_action_item;
+
+enum km_core_action_type {
+ KM_CORE_IT_END = 0, // Marks end of action items list.
+ KM_CORE_IT_CHAR = 1, // A Unicode character has been generated.
+ KM_CORE_IT_MARKER = 2, // Correlates to kmn's "deadkey" markers.
+ KM_CORE_IT_ALERT = 3, // The keyboard has triggered a alert/beep/bell.
+ KM_CORE_IT_BACK = 4, // Delete the codepoint preceding the insertion point.
+ KM_CORE_IT_PERSIST_OPT = 5, // The indicated option needs to be stored.
+ KM_CORE_IT_EMIT_KEYSTROKE = 6, // Emit the current keystroke to the application
+ KM_CORE_IT_INVALIDATE_CONTEXT = 7,
// The processor requests that the context buffer be cleared;
// for applications where context is cached, this clears the context;
// for applications where context is read from the focused text store,
// the context is just re-read and markers flushed.
- KM_KBP_IT_CAPSLOCK = 8, // Enable or disable capsLock
- KM_KBP_IT_MAX_TYPE_ID
+ KM_CORE_IT_CAPSLOCK = 8, // Enable or disable capsLock
+ KM_CORE_IT_MAX_TYPE_ID
};
@@ -533,9 +533,9 @@ enum km_kbp_action_type {
A state’s default options are set from the keyboard at creation time and the
environment. The Platform layer is then is expected to apply any persisted
options it is maintaining. Options are passed into and out of API functions as
-simple C arrays of `km_kbp_option_item` terminated with a `KM_KBP_OPTIONS_END`
+simple C arrays of `km_core_option_item` terminated with a `KM_CORE_OPTIONS_END`
sentinel value. A state's options are exposed and manipulatable via the
-`km_kbp_options` API. All option values are of type C string.
+`km_core_options` API. All option values are of type C string.
During processing when the Platform layer finds a PERSIST action type it should
store the updated option in the appropriate place, based on its scope.
@@ -545,55 +545,55 @@ value.
```c
*/
-enum km_kbp_option_scope {
- KM_KBP_OPT_UNKNOWN = 0,
- KM_KBP_OPT_KEYBOARD = 1,
- KM_KBP_OPT_ENVIRONMENT = 2,
- KM_KBP_OPT_MAX_SCOPES
+enum km_core_option_scope {
+ KM_CORE_OPT_UNKNOWN = 0,
+ KM_CORE_OPT_KEYBOARD = 1,
+ KM_CORE_OPT_ENVIRONMENT = 2,
+ KM_CORE_OPT_MAX_SCOPES
};
-struct km_kbp_option_item {
- km_kbp_cp const * key;
- km_kbp_cp const * value;
+struct km_core_option_item {
+ km_core_cp const * key;
+ km_core_cp const * value;
uint8_t scope; // Scope which an option belongs to.
};
-#define KM_KBP_OPTIONS_END { 0, 0, 0 }
+#define KM_CORE_OPTIONS_END { 0, 0, 0 }
/*
```
-### `km_kbp_options_list_size`
+### `km_core_options_list_size`
##### Description:
-Return the length of a terminated `km_kbp_option_item` array (options
+Return the length of a terminated `km_core_option_item` array (options
list).
##### Return:
The number of items in the list, not including terminating item,
or 0 if `opts` is null.
##### Parameters:
-- __opts__: A pointer to a `KM_KBP_OPTIONS_END` terminated array of
- `km_kbp_option_item` values.
+- __opts__: A pointer to a `KM_CORE_OPTIONS_END` terminated array of
+ `km_core_option_item` values.
```c
*/
KMN_API
size_t
-km_kbp_options_list_size(km_kbp_option_item const *opts);
+km_core_options_list_size(km_core_option_item const *opts);
/*
```
-### `km_kbp_state_option_lookup`
+### `km_core_state_option_lookup`
##### Description:
Lookup an option based on its key, in an options list.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null, or
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null, or
if the scope is invalid.
-- `KM_KBP_STATUS_KEY_ERROR`: The key cannot be found.
+- `KM_CORE_STATUS_KEY_ERROR`: The key cannot be found.
##### Parameters:
- __state__: An opaque pointer to a state object.
- __scope__: Which key-value store to interrogate.
-- __key__: A UTF-16 string that matches the key in the target `km_kbp_option_item`.
+- __key__: A UTF-16 string that matches the key in the target `km_core_option_item`.
- __value__: A pointer to the result variable:
A pointer to a UTF-16 string value owned by the state or keyboard object at
the time of the call. This pointer is only valid *until* the next call to any
@@ -601,47 +601,47 @@ Lookup an option based on its key, in an options list.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_state_option_lookup(km_kbp_state const *state,
+km_core_status
+km_core_state_option_lookup(km_core_state const *state,
uint8_t scope,
- km_kbp_cp const *key,
- km_kbp_cp const **value);
+ km_core_cp const *key,
+ km_core_cp const **value);
/*
```
-### `km_kbp_state_options_update`
+### `km_core_state_options_update`
##### Description:
-Adds or updates one or more options from a list of `km_kbp_option_item`s.
+Adds or updates one or more options from a list of `km_core_option_item`s.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: In the event an internal memory allocation fails.
-- `KM_KBP_STATUS_KEY_ERROR`: The key cannot be found.
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: In the event an internal memory allocation fails.
+- `KM_CORE_STATUS_KEY_ERROR`: The key cannot be found.
##### Parameters:
- __state__: An opaque pointer to a state object.
-- __new_opts__: An array of `km_kbp_option_item` objects to update or add. Must be
- terminated with `KM_KBP_OPTIONS_END`.
+- __new_opts__: An array of `km_core_option_item` objects to update or add. Must be
+ terminated with `KM_CORE_OPTIONS_END`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_state_options_update(km_kbp_state *state,
- km_kbp_option_item const *new_opts);
+km_core_status
+km_core_state_options_update(km_core_state *state,
+ km_core_option_item const *new_opts);
/*
```
-### `km_kbp_state_options_to_json`
+### `km_core_state_options_to_json`
##### Description:
-Export the contents of a `km_kbp_options` array to a JSON formatted document and
+Export the contents of a `km_core_options` array to a JSON formatted document and
place it in the supplied buffer, reporting how much space was used. If null is
passed as the buffer the number of bytes required is returned in `space`. If
there is insufficent space to hold the document the contents of the buffer is
undefined. The returned buffer uses UTF-8 encoding.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
-- `KM_KBP_STATUS_NO_MEM`: In the event an internal memory allocation fails.
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_NO_MEM`: In the event an internal memory allocation fails.
##### Parameters:
- __state__: An opaque pointer to a state object.
- __buf__: A pointer to the buffer to place the C string containing the JSON
@@ -653,8 +653,8 @@ null. On return it will hold how many bytes were used.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_state_options_to_json(km_kbp_state const *state,
+km_core_status
+km_core_state_options_to_json(km_core_state const *state,
char *buf,
size_t *space);
@@ -669,63 +669,63 @@ of state objects.
```c
*/
typedef struct {
- km_kbp_cp const * version_string; // Processor specific version string.
- km_kbp_cp const * id; // Keyman keyboard ID string.
- km_kbp_path_name folder_path; // Path to the unpacked folder containing
+ km_core_cp const * version_string; // Processor specific version string.
+ km_core_cp const * id; // Keyman keyboard ID string.
+ km_core_path_name folder_path; // Path to the unpacked folder containing
// the keyboard and associated resources.
- km_kbp_option_item const * default_options;
-} km_kbp_keyboard_attrs;
+ km_core_option_item const * default_options;
+} km_core_keyboard_attrs;
typedef struct {
- km_kbp_virtual_key key;
+ km_core_virtual_key key;
uint32_t modifier_flag;
-} km_kbp_keyboard_key;
+} km_core_keyboard_key;
-#define KM_KBP_KEYBOARD_KEY_LIST_END { 0, 0 }
+#define KM_CORE_KEYBOARD_KEY_LIST_END { 0, 0 }
typedef struct {
- km_kbp_cp const * library_name;
- km_kbp_cp const * function_name;
+ km_core_cp const * library_name;
+ km_core_cp const * function_name;
uint32_t imx_id; // unique identifier used to call this function
-} km_kbp_keyboard_imx;
+} km_core_keyboard_imx;
-#define KM_KBP_KEYBOARD_IMX_END { 0, 0, 0 }
+#define KM_CORE_KEYBOARD_IMX_END { 0, 0, 0 }
/*
```
-### `km_kbp_keyboard_load`
+### `km_core_keyboard_load`
##### Description:
Parse and load keyboard from the supplied path and a pointer to the loaded keyboard
into the out paramter.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_NO_MEM`: In the event an internal memory allocation fails.
-- `KM_KBP_STATUS_IO_ERROR`:
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_NO_MEM`: In the event an internal memory allocation fails.
+- `KM_CORE_STATUS_IO_ERROR`:
In the event the keyboard file is unparseable for any reason
-- `KM_KBP_STATUS_INVALID_ARGUMENT`:
+- `KM_CORE_STATUS_INVALID_ARGUMENT`:
In the event the file doesn't exist or is inaccesible or `keyboard` is null.
-- `KM_KBP_STATUS_OS_ERROR`: Bit 31 (high bit) set, bits 0-30 are an OS-specific
+- `KM_CORE_STATUS_OS_ERROR`: Bit 31 (high bit) set, bits 0-30 are an OS-specific
error code.
##### Parameters:
- __kb_path__: On Windows, a UTF-16 string; on other platforms, a C string:
contains a valid path to the keyboard file.
- __keyboard__: A pointer to result variable:
A pointer to the opaque keyboard object returned by the Processor. This
- memory must be freed with a call to `km_kbp_keyboard_dispose`.
+ memory must be freed with a call to `km_core_keyboard_dispose`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_keyboard_load(km_kbp_path_name kb_path,
- km_kbp_keyboard **keyboard);
+km_core_status
+km_core_keyboard_load(km_core_path_name kb_path,
+ km_core_keyboard **keyboard);
/*
```
-### `km_kbp_keyboard_dispose`
+### `km_core_keyboard_dispose`
##### Description:
Free the allocated memory belonging to an opaque keyboard object previously
-returned by `km_kbp_keyboard_load`.
+returned by `km_core_keyboard_load`.
##### Parameters:
- __keyboard__: A pointer to the opaque keyboard object to be
disposed of.
@@ -734,57 +734,57 @@ returned by `km_kbp_keyboard_load`.
*/
KMN_API
void
-km_kbp_keyboard_dispose(km_kbp_keyboard *keyboard);
+km_core_keyboard_dispose(km_core_keyboard *keyboard);
/*
```
-### `km_kbp_keyboard_get_attrs`
+### `km_core_keyboard_get_attrs`
##### Description:
Returns the const internal attributes of the keyboard. This structure is valid
for the lifetime of the opaque keyboard object. Do not modify the returned data.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
##### Parameters:
- __keyboard__: A pointer to the opaque keyboard object to be queried.
- __out__: A pointer to the result:
- A pointer to a `km_kbp_keyboard_attrs` structure.
+ A pointer to a `km_core_keyboard_attrs` structure.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_keyboard_get_attrs(km_kbp_keyboard const *keyboard,
- km_kbp_keyboard_attrs const **out);
+km_core_status
+km_core_keyboard_get_attrs(km_core_keyboard const *keyboard,
+ km_core_keyboard_attrs const **out);
/*
```
-### `km_kbp_keyboard_get_key_list`
+### `km_core_keyboard_get_key_list`
##### Description:
Returns the unordered full set of modifier+virtual keys that are handled by the
keyboard. The matching dispose call needs to be called to free the memory.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`: If non-optional parameters are null.
##### Parameters:
- __keyboard__: A pointer to the opaque keyboard object to be queried.
-- __out__: A pointer to an array of `km_kbp_keyboard_key` structures,
- terminated by `KM_KBP_KEYBOARD_KEY_LIST_END`.
+- __out__: A pointer to an array of `km_core_keyboard_key` structures,
+ terminated by `KM_CORE_KEYBOARD_KEY_LIST_END`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_keyboard_get_key_list(km_kbp_keyboard const *keyboard,
- km_kbp_keyboard_key **out);
+km_core_status
+km_core_keyboard_get_key_list(km_core_keyboard const *keyboard,
+ km_core_keyboard_key **out);
/**
```
-### `km_kbp_keyboard_key_list_dispose`
+### `km_core_keyboard_key_list_dispose`
##### Description:
Free the allocated memory belonging to a keyboard key list previously
-returned by `km_kbp_keyboard_get_key_list`.
+returned by `km_core_keyboard_get_key_list`.
##### Parameters:
- __key_list__: A pointer to the keyboard key list to be
disposed of.
@@ -792,46 +792,46 @@ returned by `km_kbp_keyboard_get_key_list`.
```c
*/
KMN_API
-void km_kbp_keyboard_key_list_dispose(km_kbp_keyboard_key *key_list);
+void km_core_keyboard_key_list_dispose(km_core_keyboard_key *key_list);
/**
- * km_kbp_keyboard_get_imx_list:
+ * km_core_keyboard_get_imx_list:
*
* Returns: the list of IMX libraries and function names that are referenced by
* the keyboard.The matching dispose call needs to be called to free the memory.
*/
KMN_API
-km_kbp_status km_kbp_keyboard_get_imx_list(km_kbp_keyboard const *keyboard, km_kbp_keyboard_imx **imx_list);
+km_core_status km_core_keyboard_get_imx_list(km_core_keyboard const *keyboard, km_core_keyboard_imx **imx_list);
/**
- * km_kbp_keyboard_imx_list_dispose:
+ * km_core_keyboard_imx_list_dispose:
*
* Disposes of the IMX list
*
* Returns: --
*/
KMN_API
-void km_kbp_keyboard_imx_list_dispose(km_kbp_keyboard_imx *imx_list);
+void km_core_keyboard_imx_list_dispose(km_core_keyboard_imx *imx_list);
/**
- * km_kbp_state_imx_register_callback:
+ * km_core_state_imx_register_callback:
*
* Register the IMX callback endpoint for the client.
*
* Returns: --
*/
KMN_API
-void km_kbp_state_imx_register_callback(km_kbp_state *state, km_kbp_keyboard_imx_platform imx_callback, void *callback_object);
+void km_core_state_imx_register_callback(km_core_state *state, km_core_keyboard_imx_platform imx_callback, void *callback_object);
/**
- * km_kbp_state_imx_deregister_callback:
+ * km_core_state_imx_deregister_callback:
*
* De-register IMX callback endpoint for the client.
*
* Returns: --
*/
KMN_API
-void km_kbp_state_imx_deregister_callback(km_kbp_state *state);
+void km_core_state_imx_deregister_callback(km_core_state *state);
/*
```
@@ -844,45 +844,45 @@ and dynamic options ("option stores" in kmn format).
/*
```
-### `km_kbp_state_create`
+### `km_core_state_create`
##### Description:
Create a keyboard processor state object, maintaining state for the keyboard in
the environment passed.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_NO_MEM`:
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_NO_MEM`:
In the event memory is unavailable to allocate a state object.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`:
+- `KM_CORE_STATUS_INVALID_ARGUMENT`:
In the event the `keyboard` or `out` pointer are null.
##### Parameters:
- __keyboard__:
A pointer to the opaque keyboard object this object will hold state for.
- __env__:
-The array of `km_kbp_option_item` key/value pairs used to initialise the
-environment, terminated by `KM_KBP_OPTIONS_END`.
+The array of `km_core_option_item` key/value pairs used to initialise the
+environment, terminated by `KM_CORE_OPTIONS_END`.
- __out__:
A pointer to result variable: A pointer to the opaque state object
returned by the Processor, initalised to maintain state for `keyboard`.
-This must be disposed of by a call to `km_kbp_state_dispose`.
+This must be disposed of by a call to `km_core_state_dispose`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_state_create(km_kbp_keyboard *keyboard,
- km_kbp_option_item const *env,
- km_kbp_state **out);
+km_core_status
+km_core_state_create(km_core_keyboard *keyboard,
+ km_core_option_item const *env,
+ km_core_state **out);
/*
```
-### `km_kbp_state_clone`
+### `km_core_state_clone`
##### Description:
Clone an existing opaque state object.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_NO_MEM`:
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_NO_MEM`:
In the event memory is unavailable to allocate a state object.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`:
+- `KM_CORE_STATUS_INVALID_ARGUMENT`:
In the event the `state` or `out` pointer are null.
##### Parameters:
- __state__:
@@ -890,22 +890,22 @@ A pointer to the opaque statea object to be cloned.
- __out__:
A pointer to result variable: A pointer to the opaque state object
returned by the Processor, cloned from the existing object `state`. This
-must be disposed of by a call to `km_kbp_state_dispose`.
+must be disposed of by a call to `km_core_state_dispose`.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_state_clone(km_kbp_state const *state,
- km_kbp_state **out);
+km_core_status
+km_core_state_clone(km_core_state const *state,
+ km_core_state **out);
/*
```
-### `km_kbp_state_dispose`
+### `km_core_state_dispose`
##### Description:
-Free the allocated resources belonging to a `km_kbp_state` object previously
-returned by `km_kbp_state_create` or `km_kbp_state_clone`. After this all
-pointers previously returned by any km_kbp_state family of calls will become
+Free the allocated resources belonging to a `km_core_state` object previously
+returned by `km_core_state_create` or `km_core_state_clone`. After this all
+pointers previously returned by any km_core_state family of calls will become
invalid.
##### Parameters:
- __state__: A pointer to the opaque state object to be disposed.
@@ -914,11 +914,11 @@ invalid.
*/
KMN_API
void
-km_kbp_state_dispose(km_kbp_state *state);
+km_core_state_dispose(km_core_state *state);
/*
```
-### `km_kbp_state_context`
+### `km_core_state_context`
##### Description:
Get access to the state object's context.
##### Return:
@@ -930,8 +930,8 @@ of the state object. If null is passed in, then null is returned.
```c
*/
KMN_API
-km_kbp_context *
-km_kbp_state_context(km_kbp_state *state);
+km_core_context *
+km_core_state_context(km_core_state *state);
/*
@@ -942,68 +942,68 @@ Get access to the state object's keyboard processor's intermediate context. This
is used during an IMX callback, part way through processing a keystroke.
##### Return:
A pointer to an context item array. Must be disposed of by a call
-to `km_kbp_context_items_dispose`.
+to `km_core_context_items_dispose`.
##### Parameters:
- __state__: A pointer to the opaque state object to be queried.
```c
*/
KMN_API
-km_kbp_status
-kbp_state_get_intermediate_context(km_kbp_state *state, km_kbp_context_item ** context_items);
+km_core_status
+kbp_state_get_intermediate_context(km_core_state *state, km_core_context_item ** context_items);
/*
```
-### `km_kbp_state_action_items`
+### `km_core_state_action_items`
##### Description:
Get the list of action items generated by the last call to
-`km_kbp_process_event`.
+`km_core_process_event`.
##### Return:
-A pointer to a `km_kbp_action_item` list, of `*num_items` in length. This data
+A pointer to a `km_core_action_item` list, of `*num_items` in length. This data
becomes invalid when the state object is destroyed, or after a call to
-`km_kbp_process_event`. Do not modify the contents of this data. The returned
-array is terminated with a `KM_KBP_IT_END` entry.
+`km_core_process_event`. Do not modify the contents of this data. The returned
+array is terminated with a `KM_CORE_IT_END` entry.
##### Parameters:
-- __state__: A pointer to the opaque `km_kbp_state` object to be queried.
+- __state__: A pointer to the opaque `km_core_state` object to be queried.
- __num_items__:
A pointer to a result variable: The number of items in the action item list
-including the `KM_KBP_IT_END` terminator. May be null if not that
+including the `KM_CORE_IT_END` terminator. May be null if not that
information is required.
```c
*/
KMN_API
-km_kbp_action_item const *
-km_kbp_state_action_items(km_kbp_state const *state,
+km_core_action_item const *
+km_core_state_action_items(km_core_state const *state,
size_t *num_items);
/*
```
-### `km_kbp_state_queue_action_items`
+### `km_core_state_queue_action_items`
##### Description:
Queue actions for the current keyboard processor state; normally
-used in IMX callbacks called during `km_kbp_process_event`.
+used in IMX callbacks called during `km_core_process_event`.
##### Return:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`:
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_INVALID_ARGUMENT`:
In the event the `state` or `action_items` pointer are null.
##### Parameters:
-- __state__: A pointer to the opaque `km_kbp_state` object to be queried.
-- __action_items__: The action items to be added to the keyboardprocessor
- queue. Must be terminated with a `KM_KBP_IT_END` entry.
+- __state__: A pointer to the opaque `km_core_state` object to be queried.
+- __action_items__: The action items to be added to the core
+ queue. Must be terminated with a `KM_CORE_IT_END` entry.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_state_queue_action_items(km_kbp_state *state,
- km_kbp_action_item const *action_items);
+km_core_status
+km_core_state_queue_action_items(km_core_state *state,
+ km_core_action_item const *action_items);
/*
```
### `km_kpb_state_to_json`
##### Description:
-Export the internal state of a `km_kbp_state` object to a JSON format document
+Export the internal state of a `km_core_state` object to a JSON format document
and place it in the supplied buffer, reporting how much space was used. If null
is passed as the buffer the number of bytes required is returned. If there is
insufficent space to hold the document, the contents of the buffer is undefined.
@@ -1014,8 +1014,8 @@ versioned is not part of this API and is intended solely for use in diagnostics
or by development and debugging tools which are aware of processor
implementation details.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_NO_MEM`: In the event an internal memory allocation fails.
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_NO_MEM`: In the event an internal memory allocation fails.
##### Parameters:
- __state__: An pointer to an opaque state object.
- __buf__: A pointer to the buffer to place the C string containing the JSON
@@ -1027,8 +1027,8 @@ null. On return it will hold how many bytes were used.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_state_to_json(km_kbp_state const *state,
+km_core_status
+km_core_state_to_json(km_core_state const *state,
char *buf,
size_t *space);
@@ -1045,44 +1045,44 @@ typedef struct {
uint16_t technology; // A bit field specifiying which Keyboard
// technologies the engine supports.
char const *vendor; // Implementor of the processor.
-} km_kbp_attr;
+} km_core_attr;
-enum km_kbp_tech_value {
- KM_KBP_TECH_UNSPECIFIED = 0,
- KM_KBP_TECH_MOCK = 1 << 0,
- KM_KBP_TECH_KMX = 1 << 1,
- KM_KBP_TECH_LDML = 1 << 2
+enum km_core_tech_value {
+ KM_CORE_TECH_UNSPECIFIED = 0,
+ KM_CORE_TECH_MOCK = 1 << 0,
+ KM_CORE_TECH_KMX = 1 << 1,
+ KM_CORE_TECH_LDML = 1 << 2
};
/**
- * km_kbp_event_flags:
+ * km_core_event_flags:
*
- * Bit flags to be used with the event_flags parameter of km_kbp_process_event
+ * Bit flags to be used with the event_flags parameter of km_core_process_event
*/
-enum km_kbp_event_flags {
- KM_KBP_EVENT_FLAG_DEFAULT = 0, // default value: hardware
- KM_KBP_EVENT_FLAG_TOUCH = 1, // set if the event is touch, otherwise hardware
+enum km_core_event_flags {
+ KM_CORE_EVENT_FLAG_DEFAULT = 0, // default value: hardware
+ KM_CORE_EVENT_FLAG_TOUCH = 1, // set if the event is touch, otherwise hardware
};
/*
```
-### `km_kbp_get_engine_attrs`
+### `km_core_get_engine_attrs`
##### Description:
Get access processors attributes describing version and technology implemented.
##### Return:
-A pointer to a `km_kbp_attr` structure. Do not modify the contents of this
+A pointer to a `km_core_attr` structure. Do not modify the contents of this
structure.
##### Parameters:
-- __state__: An opaque pointer to an `km_kbp_state`.
+- __state__: An opaque pointer to an `km_core_state`.
```c
*/
KMN_API
-km_kbp_attr const *
-km_kbp_get_engine_attrs(km_kbp_state const *state);
+km_core_attr const *
+km_core_get_engine_attrs(km_core_state const *state);
/*
```
-### `km_kbp_process_event`
+### `km_core_process_event`
##### Description:
Run the keyboard on an opaque state object with the provided virtual key and modifer
key state. Updates the state object as appropriate and fills out its action list.
@@ -1090,10 +1090,10 @@ key state. Updates the state object as appropriate and fills out its action list
The action list will be cleared at the start of this call; options and context in
the state may also be modified.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_NO_MEM`:
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_NO_MEM`:
In the event memory is unavailable to allocate internal buffers.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`:
+- `KM_CORE_STATUS_INVALID_ARGUMENT`:
In the event the `state` pointer is null or an invalid virtual key or modifier
state is passed.
@@ -1102,35 +1102,35 @@ state is passed.
- __vk__: A virtual key to be processed.
- __modifier_state__:
The combinations of modifier keys set at the time key `vk` was pressed, bitmask
-from the `km_kbp_modifier_state` enum.
-- __event_flags__: Event level flags, see km_kbp_event_flags
+from the `km_core_modifier_state` enum.
+- __event_flags__: Event level flags, see km_core_event_flags
```c
*/
KMN_API
-km_kbp_status
-km_kbp_process_event(km_kbp_state *state,
- km_kbp_virtual_key vk,
+km_core_status
+km_core_process_event(km_core_state *state,
+ km_core_virtual_key vk,
uint16_t modifier_state,
uint8_t is_key_down,
uint16_t event_flags);
/*
```
-### `km_kbp_process_queued_actions`
+### `km_core_process_queued_actions`
##### Description:
Process the keyboard processors queued actions for the opaque state object.
Updates the state object as appropriate and fills out its action list.
-The client can add actions externally via the `km_kbp_state_queue_action_items` and
+The client can add actions externally via the `km_core_state_queue_action_items` and
then request the processing of the actions with this method.
The state action list will be cleared at the start of this call; options and context in
the state may also be modified.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_NO_MEM`:
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_NO_MEM`:
In the event memory is unavailable to allocate internal buffers.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`:
+- `KM_CORE_STATUS_INVALID_ARGUMENT`:
In the event the `state` pointer is null
##### Parameters:
@@ -1139,20 +1139,20 @@ In the event the `state` pointer is null
```c
*/
KMN_API
-km_kbp_status
-km_kbp_process_queued_actions(km_kbp_state *state);
+km_core_status
+km_core_process_queued_actions(km_core_state *state);
/*
```
-### `km_kbp_event`
+### `km_core_event`
##### Description:
Tell the keyboard processor that an external event has occurred, such as a keyboard
being activated through the language switching UI.
##### Return status:
-- `KM_KBP_STATUS_OK`: On success.
-- `KM_KBP_STATUS_NO_MEM`:
+- `KM_CORE_STATUS_OK`: On success.
+- `KM_CORE_STATUS_NO_MEM`:
In the event memory is unavailable to allocate internal buffers.
-- `KM_KBP_STATUS_INVALID_ARGUMENT`:
+- `KM_CORE_STATUS_INVALID_ARGUMENT`:
In the event the `state` pointer is null or an invalid event or data is passed.
The keyboard processor may generate actions which should be processed by the
@@ -1163,24 +1163,24 @@ the state may also be modified.
##### Parameters:
- __state__: A pointer to the opaque state object.
-- __event__: The event to be processed, from km_kbp_event_code enumeration
+- __event__: The event to be processed, from km_core_event_code enumeration
- __data__: Additional event-specific data. Currently unused, must be nullptr.
```c
*/
KMN_API
-km_kbp_status
-km_kbp_event(
- km_kbp_state *state,
+km_core_status
+km_core_event(
+ km_core_state *state,
uint32_t event,
void* data
);
-enum km_kbp_event_code {
+enum km_core_event_code {
// A keyboard has been activated by the user. The processor may use this
// event, for example, to switch caps lock state or provide other UX.
- KM_KBP_EVENT_KEYBOARD_ACTIVATED = 1,
- //future: KM_KBP_EVENT_KEYBOARD_DEACTIVATED = 2,
+ KM_CORE_EVENT_KEYBOARD_ACTIVATED = 1,
+ //future: KM_CORE_EVENT_KEYBOARD_DEACTIVATED = 2,
};
#if defined(__cplusplus)
diff --git a/core/include/keyman/keyboardprocessor_bits.h b/core/include/keyman/keyman_core_api_bits.h
similarity index 96%
rename from core/include/keyman/keyboardprocessor_bits.h
rename to core/include/keyman/keyman_core_api_bits.h
index 03892a62afb..be2886d0583 100644
--- a/core/include/keyman/keyboardprocessor_bits.h
+++ b/core/include/keyman/keyman_core_api_bits.h
@@ -27,7 +27,7 @@
#endif
#if defined _WIN32 || defined __CYGWIN__
- typedef wchar_t const * km_kbp_path_name;
+ typedef wchar_t const * km_core_path_name;
#define _KM_KBP_PATH_SEPARATOR (L'\\')
#define _KM_KBP_EXT_SEPARATOR (L'.')
#if defined __GNUC__ // These three will be redefined for Windows
@@ -43,7 +43,7 @@
#define _kmn_import_flag dllimport
#define _kmn_static_flag
#else
- typedef char const * km_kbp_path_name;
+ typedef char const * km_core_path_name;
#define _KM_KBP_PATH_SEPARATOR ('/')
#define _KM_KBP_EXT_SEPARATOR ('.')
#endif
diff --git a/core/include/keyman/keyman_core_api_consts.h b/core/include/keyman/keyman_core_api_consts.h
new file mode 100644
index 00000000000..67d72edb3d1
--- /dev/null
+++ b/core/include/keyman/keyman_core_api_consts.h
@@ -0,0 +1,9 @@
+#pragma once
+
+// Defined environment options for KMX processor
+#define KM_CORE_KMX_ENV_PLATFORM u"platform"
+#define KM_CORE_KMX_ENV_BASELAYOUT u"baseLayout"
+#define KM_CORE_KMX_ENV_BASELAYOUTALT u"baseLayoutAlt"
+#define KM_CORE_KMX_ENV_SIMULATEALTGR u"simulateAltgr"
+#define KM_CORE_KMX_ENV_CAPSLOCK u"capsLock"
+#define KM_CORE_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT u"baseLayoutGivesCtrlRAltForRAlt"
diff --git a/core/include/keyman/keyboardprocessor_debug.h b/core/include/keyman/keyman_core_api_debug.h
similarity index 60%
rename from core/include/keyman/keyboardprocessor_debug.h
rename to core/include/keyman/keyman_core_api_debug.h
index 380b8ee3012..8f80481d2c5 100644
--- a/core/include/keyman/keyboardprocessor_debug.h
+++ b/core/include/keyman/keyman_core_api_debug.h
@@ -15,8 +15,8 @@
#include
#include
-#include
-#include
+#include
+#include
#if defined(__cplusplus)
extern "C"
@@ -24,7 +24,7 @@ extern "C"
#endif
/**
- * The maximum size of context in km_kbp_cp units for a single debug
+ * The maximum size of context in km_core_cp units for a single debug
* event. This is taken from MAXCONTEXT in keyman32 (Windows) and is purely
* a convenience value. We can increase it if there is a demonstrated need.
*/
@@ -42,31 +42,31 @@ extern "C"
* These modifier flags are used internally in the kmx engine, so will be
* exposed only in debugging modifier states.
*/
-#define KM_KBP_MODIFIER_VIRTUALKEY 0x4000
-#define KM_KBP_MODIFIER_VIRTUALCHARKEY 0x8000
+#define KM_CORE_MODIFIER_VIRTUALKEY 0x4000
+#define KM_CORE_MODIFIER_VIRTUALCHARKEY 0x8000
/**
* Input key event data. The `character` member is derived from
* a US English key event for vk + modifier_state, and is 0 if
* the vk + modifier_state do not generate a character.
*
- * Used only in event type KM_KBP_DEBUG_BEGIN.
+ * Used only in event type KM_CORE_DEBUG_BEGIN.
*/
typedef struct {
uint16_t vk;
uint16_t modifier_state;
char16_t character;
-} km_kbp_state_debug_key_info;
+} km_core_state_debug_key_info;
/**
* Option event data.
*
- * Used only in event type KM_KBP_DEBUG_SET_OPTION.
+ * Used only in event type KM_CORE_DEBUG_SET_OPTION.
*/
typedef struct {
void *store; // LPSTORE
- km_kbp_cp value[DEBUG_MAX_CONTEXT]; // value to be saved into the store
-} km_kbp_state_debug_kmx_option_info;
+ km_core_cp value[DEBUG_MAX_CONTEXT]; // value to be saved into the store
+} km_core_state_debug_kmx_option_info;
/**
* KMX processor data for each event. kmx_base.h defines the types that are
@@ -76,11 +76,11 @@ typedef struct {
* The context value here will be an intermediate value, and may differ
* from event to event as the context can be rewritten for each rule match.
*
- * Used in all event types except KM_KBP_DEBUG_BEGIN, KM_KBP_DEBUG_END.
+ * Used in all event types except KM_CORE_DEBUG_BEGIN, KM_CORE_DEBUG_END.
*/
typedef struct {
- km_kbp_cp context[DEBUG_MAX_CONTEXT]; // The context matched by the rule (? may not need this?) // TODO: rename to context_matched
+ km_core_cp context[DEBUG_MAX_CONTEXT]; // The context matched by the rule (? may not need this?) // TODO: rename to context_matched
void *group; // LPGROUP
void *rule; // LPKEY
uint16_t store_offsets[DEBUG_STORE_OFFSETS_SIZE]; // pairs--store, char position, terminated by 0xFFFF // TODO use a better structure here
@@ -89,8 +89,8 @@ typedef struct {
/// the debugger; the debugger uses this to determine when to
/// execute the actions when single-stepping.
uint16_t first_action;
- km_kbp_state_debug_kmx_option_info option;
-} km_kbp_state_debug_kmx_info;
+ km_core_state_debug_kmx_option_info option;
+} km_core_state_debug_kmx_info;
/**
* A single debug event.
@@ -98,38 +98,38 @@ typedef struct {
typedef struct {
uint32_t type; // 32 bits is better optimized than 8 bits
uint32_t flags;
- km_kbp_state_debug_key_info key_info;
- km_kbp_state_debug_kmx_info kmx_info;
-} km_kbp_state_debug_item;
+ km_core_state_debug_key_info key_info;
+ km_core_state_debug_kmx_info kmx_info;
+} km_core_state_debug_item;
/**
* A single debug event.
*/
-enum km_kbp_debug_type {
- KM_KBP_DEBUG_BEGIN = 0,
- //KM_KBP_DEBUG_BEGIN_ANSI = 1, // not supported; instead rewrite ansi keyboards to Unicode with mcompile
- KM_KBP_DEBUG_GROUP_ENTER = 2,
- KM_KBP_DEBUG_GROUP_EXIT = 3,
- KM_KBP_DEBUG_RULE_ENTER = 4,
- KM_KBP_DEBUG_RULE_EXIT = 5,
- KM_KBP_DEBUG_MATCH_ENTER = 6,
- KM_KBP_DEBUG_MATCH_EXIT = 7,
- KM_KBP_DEBUG_NOMATCH_ENTER = 8,
- KM_KBP_DEBUG_NOMATCH_EXIT = 9,
- KM_KBP_DEBUG_END = 10,
- KM_KBP_DEBUG_SET_OPTION = 11,
+enum km_core_debug_type {
+ KM_CORE_DEBUG_BEGIN = 0,
+ //KM_CORE_DEBUG_BEGIN_ANSI = 1, // not supported; instead rewrite ansi keyboards to Unicode with mcompile
+ KM_CORE_DEBUG_GROUP_ENTER = 2,
+ KM_CORE_DEBUG_GROUP_EXIT = 3,
+ KM_CORE_DEBUG_RULE_ENTER = 4,
+ KM_CORE_DEBUG_RULE_EXIT = 5,
+ KM_CORE_DEBUG_MATCH_ENTER = 6,
+ KM_CORE_DEBUG_MATCH_EXIT = 7,
+ KM_CORE_DEBUG_NOMATCH_ENTER = 8,
+ KM_CORE_DEBUG_NOMATCH_EXIT = 9,
+ KM_CORE_DEBUG_END = 10,
+ KM_CORE_DEBUG_SET_OPTION = 11,
};
-// Flags for KM_KBP_DEBUG_GROUP_EXIT
-#define KM_KBP_DEBUG_FLAG_RECURSIVE_OVERFLOW 0x0001
-#define KM_KBP_DEBUG_FLAG_NOMATCH 0x0002
+// Flags for KM_CORE_DEBUG_GROUP_EXIT
+#define KM_CORE_DEBUG_FLAG_RECURSIVE_OVERFLOW 0x0001
+#define KM_CORE_DEBUG_FLAG_NOMATCH 0x0002
-// Flags for KM_KBP_DEBUG_BEGIN
+// Flags for KM_CORE_DEBUG_BEGIN
// TODO: do we need this at all?
-#define KM_KBP_DEBUG_FLAG_UNICODE 0x0001 // Always set
+#define KM_CORE_DEBUG_FLAG_UNICODE 0x0001 // Always set
-// Flags for KM_KBP_DEBUG_END
-#define KM_KBP_DEBUG_FLAG_OUTPUTKEYSTROKE 0x0001
+// Flags for KM_CORE_DEBUG_END
+#define KM_CORE_DEBUG_FLAG_OUTPUTKEYSTROKE 0x0001
/**
* Enable or disable debug tracing
@@ -137,11 +137,11 @@ enum km_kbp_debug_type {
* @param state Pointer to initialized state
* @param value Set to 1 to enable debugging, 0 to disable
*
- * @returns KM_KBP_STATUS_OK on success
+ * @returns KM_CORE_STATUS_OK on success
*/
KMN_API
-km_kbp_status
-km_kbp_state_debug_set(km_kbp_state *state, int value);
+km_core_status
+km_core_state_debug_set(km_core_state *state, int value);
/**
* Get current debug tracing status
@@ -152,7 +152,7 @@ km_kbp_state_debug_set(km_kbp_state *state, int value);
*/
KMN_API
uint8_t
-km_kbp_state_debug_get(km_kbp_state const *state);
+km_core_state_debug_get(km_core_state const *state);
/**
* Read current debug trace log
@@ -162,11 +162,11 @@ km_kbp_state_debug_get(km_kbp_state const *state);
* nullptr if not required.
*
* @returns pointer to read only array of debug item events,
- * with last entry guaranteed to be KM_KBP_DEBUG_END.
+ * with last entry guaranteed to be KM_CORE_DEBUG_END.
*/
KMN_API
-km_kbp_state_debug_item const *
-km_kbp_state_debug_items(km_kbp_state const *state, size_t *num_items);
+km_core_state_debug_item const *
+km_core_state_debug_items(km_core_state const *state, size_t *num_items);
#if defined(__cplusplus)
} // extern "C"
diff --git a/core/include/keyman/keyman_core_api_version.h.in b/core/include/keyman/keyman_core_api_version.h.in
new file mode 100644
index 00000000000..064a1391547
--- /dev/null
+++ b/core/include/keyman/keyman_core_api_version.h.in
@@ -0,0 +1,15 @@
+#define km_core_version_stringify(x) km_core_version_to_string(x)
+#define km_core_version_to_string(x) #x
+
+// Product versioning
+
+#define KM_CORE_VERSION_MAJOR @majorver@
+#define KM_CORE_VERSION_MINOR @minorver@
+#define KM_CORE_VERSION_PATCH @patchver@
+#define KM_CORE_VERSION_STRING km_core_version_stringify(@majorver@ ## . ## @minorver@ ## . ## @patchver@ ## .0)
+
+// API versioning
+
+#define KM_CORE_LIB_CURRENT @lib_curr@
+#define KM_CORE_LIB_AGE @lib_age@
+#define KM_CORE_LIB_REVISION @lib_rev@
diff --git a/core/include/keyman/keyman_core_api_vkeys.h b/core/include/keyman/keyman_core_api_vkeys.h
new file mode 100644
index 00000000000..7e4a6d181aa
--- /dev/null
+++ b/core/include/keyman/keyman_core_api_vkeys.h
@@ -0,0 +1,312 @@
+/*
+ Copyright: © 2018 SIL International.
+ Description: API declarations for modifier keys, handy access masks and
+ Keyman VKEY names. These follow the same keytop->code
+ associations as the Windows API. This is a separate header to
+ maintain readability of the primary API header.
+ Create Date: 17 Oct 2018
+ Authors: Tim Eves (TSE)
+ History: 17 Oct 2018 - TSE - Moved & refactored km_core_modifier_state
+ from keyman_core_api.h.
+ - Added VKey and mask definitions.
+ 6 Oct 2018 - TSE - Move into keyman folder.
+
+*/
+
+#pragma once
+
+enum km_core_modifier_state {
+ KM_CORE_MODIFIER_LCTRL = 1 << 0,
+ KM_CORE_MODIFIER_RCTRL = 1 << 1,
+ KM_CORE_MODIFIER_LALT = 1 << 2,
+ KM_CORE_MODIFIER_RALT = 1 << 3,
+ KM_CORE_MODIFIER_SHIFT = 1 << 4,
+ KM_CORE_MODIFIER_CTRL = 1 << 5,
+ KM_CORE_MODIFIER_ALT = 1 << 6,
+ /*
+ KM_CORE_MODIFIER_META = 1 << 7, // Either Meta-key flag (tentative). Not usable by keyboards currently
+ // Used internally (currently, only by KMW) to ensure Meta-key
+ // shortcuts safely bypass rules
+ // Meta key = Command key on macOS, Windows key on Windows
+ */
+ KM_CORE_MODIFIER_CAPS = 1 << 8,
+ KM_CORE_MODIFIER_NOCAPS = 1 << 9,
+ /*
+ KM_CORE_MODIFIER_NUMLOCK = 1 << 10,
+ KM_CORE_MODIFIER_NONUMLOCK = 1 << 11,
+ KM_CORE_MODIFIER_SCROLLOCK = 1 << 12,
+ KM_CORE_MODIFIER_NOSCROLLOCK = 1 << 13,
+ KM_CORE_MODIFIER_VIRTUALKEY = 1 << 14,
+ */
+};
+
+enum km_core_modifier_mask {
+ KM_CORE_MODIFIER_MASK_ALL = 0x7f,
+ KM_CORE_MODIFIER_MASK_ALT_GR_SIM = KM_CORE_MODIFIER_LCTRL|KM_CORE_MODIFIER_LALT,
+ KM_CORE_MODIFIER_MASK_CHIRAL = 0x1f,
+ KM_CORE_MODIFIER_MASK_IS_CHIRAL = 0x0f,
+ KM_CORE_MODIFIER_MASK_NON_CHIRAL = 0x7f,
+ KM_CORE_MODIFIER_MASK_CAPS = 0x0300,
+/*KM_CORE_MODIFIER_MASK_NUMLOCK = 0x0C00,
+ KM_CORE_MODIFIER_MASK_SCROLLLOCK = 0x3000,*/
+};
+
+// These are Windows API VKEYs, using Keyman VKEY names.
+enum km_kpb_virtual_key {
+ KM_CORE_VKEY__00,
+ KM_CORE_VKEY_LBUTTON,
+ KM_CORE_VKEY_RBUTTON,
+ KM_CORE_VKEY_CANCEL,
+ KM_CORE_VKEY_MBUTTON,
+ KM_CORE_VKEY__05,
+ KM_CORE_VKEY__06,
+ KM_CORE_VKEY__07,
+ KM_CORE_VKEY_BKSP,
+ KM_CORE_VKEY_TAB,
+ KM_CORE_VKEY__0A,
+ KM_CORE_VKEY__0B,
+ KM_CORE_VKEY_KP5,
+ KM_CORE_VKEY_ENTER,
+ KM_CORE_VKEY__0E,
+ KM_CORE_VKEY__0F,
+ KM_CORE_VKEY_SHIFT,
+ KM_CORE_VKEY_CONTROL,
+ KM_CORE_VKEY_ALT,
+ KM_CORE_VKEY_PAUSE,
+ KM_CORE_VKEY_CAPS,
+ KM_CORE_VKEY__15,
+ KM_CORE_VKEY__16,
+ KM_CORE_VKEY__17,
+ KM_CORE_VKEY__18,
+ KM_CORE_VKEY__19,
+ KM_CORE_VKEY__1A,
+ KM_CORE_VKEY_ESC,
+ KM_CORE_VKEY__1C,
+ KM_CORE_VKEY__1D,
+ KM_CORE_VKEY__1E,
+ KM_CORE_VKEY__1F,
+ KM_CORE_VKEY_SPACE,
+ KM_CORE_VKEY_PGUP,
+ KM_CORE_VKEY_PGDN,
+ KM_CORE_VKEY_END,
+ KM_CORE_VKEY_HOME,
+ KM_CORE_VKEY_LEFT,
+ KM_CORE_VKEY_UP,
+ KM_CORE_VKEY_RIGHT,
+ KM_CORE_VKEY_DOWN,
+ KM_CORE_VKEY_SEL,
+ KM_CORE_VKEY_PRINT,
+ KM_CORE_VKEY_EXEC,
+ KM_CORE_VKEY_PRTSCN,
+ KM_CORE_VKEY_INS,
+ KM_CORE_VKEY_DEL,
+ KM_CORE_VKEY_HELP,
+ KM_CORE_VKEY_0,
+ KM_CORE_VKEY_1,
+ KM_CORE_VKEY_2,
+ KM_CORE_VKEY_3,
+ KM_CORE_VKEY_4,
+ KM_CORE_VKEY_5,
+ KM_CORE_VKEY_6,
+ KM_CORE_VKEY_7,
+ KM_CORE_VKEY_8,
+ KM_CORE_VKEY_9,
+ KM_CORE_VKEY__3A,
+ KM_CORE_VKEY__3B,
+ KM_CORE_VKEY__3C,
+ KM_CORE_VKEY__3D,
+ KM_CORE_VKEY__3E,
+ KM_CORE_VKEY__3F,
+ KM_CORE_VKEY__40,
+ KM_CORE_VKEY_A,
+ KM_CORE_VKEY_B,
+ KM_CORE_VKEY_C,
+ KM_CORE_VKEY_D,
+ KM_CORE_VKEY_E,
+ KM_CORE_VKEY_F,
+ KM_CORE_VKEY_G,
+ KM_CORE_VKEY_H,
+ KM_CORE_VKEY_I,
+ KM_CORE_VKEY_J,
+ KM_CORE_VKEY_K,
+ KM_CORE_VKEY_L,
+ KM_CORE_VKEY_M,
+ KM_CORE_VKEY_N,
+ KM_CORE_VKEY_O,
+ KM_CORE_VKEY_P,
+ KM_CORE_VKEY_Q,
+ KM_CORE_VKEY_R,
+ KM_CORE_VKEY_S,
+ KM_CORE_VKEY_T,
+ KM_CORE_VKEY_U,
+ KM_CORE_VKEY_V,
+ KM_CORE_VKEY_W,
+ KM_CORE_VKEY_X,
+ KM_CORE_VKEY_Y,
+ KM_CORE_VKEY_Z,
+ KM_CORE_VKEY__5B,
+ KM_CORE_VKEY__5C,
+ KM_CORE_VKEY__5D,
+ KM_CORE_VKEY__5E,
+ KM_CORE_VKEY__5F,
+ KM_CORE_VKEY_NP0,
+ KM_CORE_VKEY_NP1,
+ KM_CORE_VKEY_NP2,
+ KM_CORE_VKEY_NP3,
+ KM_CORE_VKEY_NP4,
+ KM_CORE_VKEY_NP5,
+ KM_CORE_VKEY_NP6,
+ KM_CORE_VKEY_NP7,
+ KM_CORE_VKEY_NP8,
+ KM_CORE_VKEY_NP9,
+ KM_CORE_VKEY_NPSTAR,
+ KM_CORE_VKEY_NPPLUS,
+ KM_CORE_VKEY_SEPARATOR,
+ KM_CORE_VKEY_NPMINUS,
+ KM_CORE_VKEY_NPDOT,
+ KM_CORE_VKEY_NPSLASH,
+ KM_CORE_VKEY_F1,
+ KM_CORE_VKEY_F2,
+ KM_CORE_VKEY_F3,
+ KM_CORE_VKEY_F4,
+ KM_CORE_VKEY_F5,
+ KM_CORE_VKEY_F6,
+ KM_CORE_VKEY_F7,
+ KM_CORE_VKEY_F8,
+ KM_CORE_VKEY_F9,
+ KM_CORE_VKEY_F10,
+ KM_CORE_VKEY_F11,
+ KM_CORE_VKEY_F12,
+ KM_CORE_VKEY_F13,
+ KM_CORE_VKEY_F14,
+ KM_CORE_VKEY_F15,
+ KM_CORE_VKEY_F16,
+ KM_CORE_VKEY_F17,
+ KM_CORE_VKEY_F18,
+ KM_CORE_VKEY_F19,
+ KM_CORE_VKEY_F20,
+ KM_CORE_VKEY_F21,
+ KM_CORE_VKEY_F22,
+ KM_CORE_VKEY_F23,
+ KM_CORE_VKEY_F24,
+ KM_CORE_VKEY__88,
+ KM_CORE_VKEY__89,
+ KM_CORE_VKEY__8A,
+ KM_CORE_VKEY__8B,
+ KM_CORE_VKEY__8C,
+ KM_CORE_VKEY__8D,
+ KM_CORE_VKEY__8E,
+ KM_CORE_VKEY__8F,
+ KM_CORE_VKEY_NUMLOCK,
+ KM_CORE_VKEY_SCROLL,
+ KM_CORE_VKEY__92,
+ KM_CORE_VKEY__93,
+ KM_CORE_VKEY__94,
+ KM_CORE_VKEY__95,
+ KM_CORE_VKEY__96,
+ KM_CORE_VKEY__97,
+ KM_CORE_VKEY__98,
+ KM_CORE_VKEY__99,
+ KM_CORE_VKEY__9A,
+ KM_CORE_VKEY__9B,
+ KM_CORE_VKEY__9C,
+ KM_CORE_VKEY__9D,
+ KM_CORE_VKEY__9E,
+ KM_CORE_VKEY__9F,
+ KM_CORE_VKEY__A0,
+ KM_CORE_VKEY__A1,
+ KM_CORE_VKEY__A2,
+ KM_CORE_VKEY__A3,
+ KM_CORE_VKEY__A4,
+ KM_CORE_VKEY__A5,
+ KM_CORE_VKEY__A6,
+ KM_CORE_VKEY__A7,
+ KM_CORE_VKEY__A8,
+ KM_CORE_VKEY__A9,
+ KM_CORE_VKEY__AA,
+ KM_CORE_VKEY__AB,
+ KM_CORE_VKEY__AC,
+ KM_CORE_VKEY__AD,
+ KM_CORE_VKEY__AE,
+ KM_CORE_VKEY__AF,
+ KM_CORE_VKEY__B0,
+ KM_CORE_VKEY__B1,
+ KM_CORE_VKEY__B2,
+ KM_CORE_VKEY__B3,
+ KM_CORE_VKEY__B4,
+ KM_CORE_VKEY__B5,
+ KM_CORE_VKEY__B6,
+ KM_CORE_VKEY__B7,
+ KM_CORE_VKEY__B8,
+ KM_CORE_VKEY__B9,
+ KM_CORE_VKEY_COLON,
+ KM_CORE_VKEY_EQUAL,
+ KM_CORE_VKEY_COMMA,
+ KM_CORE_VKEY_HYPHEN,
+ KM_CORE_VKEY_PERIOD,
+ KM_CORE_VKEY_SLASH,
+ KM_CORE_VKEY_BKQUOTE,
+ KM_CORE_VKEY__C1,
+ KM_CORE_VKEY__C2,
+ KM_CORE_VKEY__C3,
+ KM_CORE_VKEY__C4,
+ KM_CORE_VKEY__C5,
+ KM_CORE_VKEY__C6,
+ KM_CORE_VKEY__C7,
+ KM_CORE_VKEY__C8,
+ KM_CORE_VKEY__C9,
+ KM_CORE_VKEY__CA,
+ KM_CORE_VKEY__CB,
+ KM_CORE_VKEY__CC,
+ KM_CORE_VKEY__CD,
+ KM_CORE_VKEY__CE,
+ KM_CORE_VKEY__CF,
+ KM_CORE_VKEY__D0,
+ KM_CORE_VKEY__D1,
+ KM_CORE_VKEY__D2,
+ KM_CORE_VKEY__D3,
+ KM_CORE_VKEY__D4,
+ KM_CORE_VKEY__D5,
+ KM_CORE_VKEY__D6,
+ KM_CORE_VKEY__D7,
+ KM_CORE_VKEY__D8,
+ KM_CORE_VKEY__D9,
+ KM_CORE_VKEY__DA,
+ KM_CORE_VKEY_LBRKT,
+ KM_CORE_VKEY_BKSLASH,
+ KM_CORE_VKEY_RBRKT,
+ KM_CORE_VKEY_QUOTE,
+ KM_CORE_VKEY_oDF,
+ KM_CORE_VKEY_oE0,
+ KM_CORE_VKEY_oE1,
+ KM_CORE_VKEY_oE2, // 102nd key on European layouts
+ KM_CORE_VKEY_oE3,
+ KM_CORE_VKEY_oE4,
+ KM_CORE_VKEY__E5,
+ KM_CORE_VKEY_oE6,
+ KM_CORE_VKEY__E7,
+ KM_CORE_VKEY__E8,
+ KM_CORE_VKEY_oE9,
+ KM_CORE_VKEY_oEA,
+ KM_CORE_VKEY_oEB,
+ KM_CORE_VKEY_oEC,
+ KM_CORE_VKEY_oED,
+ KM_CORE_VKEY_oEE,
+ KM_CORE_VKEY_oEF,
+ KM_CORE_VKEY_oF0,
+ KM_CORE_VKEY_oF1,
+ KM_CORE_VKEY_oF2,
+ KM_CORE_VKEY_oF3,
+ KM_CORE_VKEY_oF4,
+ KM_CORE_VKEY_oF5,
+ KM_CORE_VKEY__F6,
+ KM_CORE_VKEY__F7,
+ KM_CORE_VKEY__F8,
+ KM_CORE_VKEY__F9,
+ KM_CORE_VKEY__FA,
+ KM_CORE_VKEY__FB,
+ KM_CORE_VKEY__FC,
+ KM_CORE_VKEY__FD,
+ KM_CORE_VKEY__FE,
+ KM_CORE_VKEY__FF,
+};
diff --git a/core/include/keyman/meson.build b/core/include/keyman/meson.build
index 7da255502de..8ef7d1a9f26 100644
--- a/core/include/keyman/meson.build
+++ b/core/include/keyman/meson.build
@@ -19,16 +19,16 @@ cfg.set('patchver', project_ver[2])
configure_file(
configuration: cfg,
- input: 'keyboardprocessor_version.h.in',
- output: 'keyboardprocessor_version.h',
+ input: 'keyman_core_api_version.h.in',
+ output: 'keyman_core_api_version.h',
)
-install_headers('keyboardprocessor.h',
- 'keyboardprocessor_bits.h',
- 'keyboardprocessor_consts.h',
- 'keyboardprocessor_debug.h',
- 'keyboardprocessor_vkeys.h',
- join_paths(meson.current_build_dir(), 'keyboardprocessor_version.h'),
+install_headers('keyman_core_api.h',
+ 'keyman_core_api_bits.h',
+ 'keyman_core_api_consts.h',
+ 'keyman_core_api_debug.h',
+ 'keyman_core_api_vkeys.h',
+ join_paths(meson.current_build_dir(), 'keyman_core_api_version.h'),
'../../../common/include/km_types.h',
'../../../common/include/kmx_file.h',
subdir: 'keyman')
diff --git a/core/include/ldml/keyboardprocessor_ldml.h b/core/include/ldml/keyboardprocessor_ldml.h
index ae244ffbe75..45837b63855 100644
--- a/core/include/ldml/keyboardprocessor_ldml.h
+++ b/core/include/ldml/keyboardprocessor_ldml.h
@@ -16,6 +16,7 @@
#pragma once
#define LDML_BKSP_FLAGS_ERROR 0x1
+#define LDML_CLDR_IMPLIED_FORMS_IMPORT "techpreview/scanCodes-implied.xml"
#define LDML_CLDR_IMPLIED_KEYS_IMPORT "techpreview/keys-Latn-implied.xml"
#define LDML_CLDR_IMPORT_BASE "cldr"
#define LDML_CLDR_VERSION_LATEST "techpreview"
@@ -45,11 +46,7 @@
#define LDML_KEYS_MOD_CTRLR 0x2
#define LDML_KEYS_MOD_NONE 0x0
#define LDML_KEYS_MOD_SHIFT 0x10
-#define LDML_LAYR_LIST_HARDWARE_ABNT2 0x1
-#define LDML_LAYR_LIST_HARDWARE_ISO 0x2
-#define LDML_LAYR_LIST_HARDWARE_JIS 0x3
-#define LDML_LAYR_LIST_HARDWARE_TOUCH 0x0
-#define LDML_LAYR_LIST_HARDWARE_US 0x4
+#define LDML_LAYR_LIST_HARDWARE_TOUCH "touch"
#define LDML_LENGTH_BKSP 0xC
#define LDML_LENGTH_BKSP_ITEM 0x10
#define LDML_LENGTH_DISP 0x10
@@ -91,8 +88,6 @@
#define LDML_LENGTH_USET_USET 0xC
#define LDML_LENGTH_VARS 0x10
#define LDML_LENGTH_VARS_ITEM 0x10
-#define LDML_LENGTH_VKEY 0xC
-#define LDML_LENGTH_VKEY_ITEM 0x8
#define LDML_MARKER_ANY_INDEX 0xD7FF
#define LDML_MARKER_CODE 0x8
#define LDML_MARKER_MAX_COUNT 0xD7FE
@@ -129,8 +124,6 @@
#define LDML_SECTIONNAME_USET "uset"
#define LDML_SECTIONID_VARS 0x73726176 /* "vars" */
#define LDML_SECTIONNAME_VARS "vars"
-#define LDML_SECTIONID_VKEY 0x79656B76 /* "vkey" */
-#define LDML_SECTIONNAME_VKEY "vkey"
#define LDML_TRAN_FLAGS_ERROR 0x1
#define LDML_TRAN_GROUP_TYPE_REORDER 0x1
#define LDML_TRAN_GROUP_TYPE_TRANSFORM 0x0
diff --git a/core/include/ldml/keyboardprocessor_ldml.ts b/core/include/ldml/keyboardprocessor_ldml.ts
index ed9ad899ed3..4e9aaedbb13 100644
--- a/core/include/ldml/keyboardprocessor_ldml.ts
+++ b/core/include/ldml/keyboardprocessor_ldml.ts
@@ -37,8 +37,7 @@ export type SectionIdent =
'strs' |
'tran' |
'uset' |
- 'vars' |
- 'vkey';
+ 'vars';
type SectionMap = {
@@ -74,6 +73,10 @@ class Constants {
* implied keys file
*/
readonly cldr_implied_keys_import = `${this.cldr_version_techpreview}/keys-Latn-implied.xml`;
+ /**
+ * implied scancodes file
+ */
+ readonly cldr_implied_forms_import = `${this.cldr_version_techpreview}/scanCodes-implied.xml`;
/**
* Length of a raw section header, in bytes
*/
@@ -350,35 +353,7 @@ class Constants {
/**
* for the 'hardware' field indicating a touch keyboard, non-hardware
*/
- readonly layr_list_hardware_touch = 0;
- /**
- * for the 'hardware' field indicating an abnt2 layout
- */
- readonly layr_list_hardware_abnt2 = 1;
- /**
- * for the 'hardware' field indicating an iso layout
- */
- readonly layr_list_hardware_iso = 2;
- /**
- * for the 'hardware' field indicating a jis layout
- */
- readonly layr_list_hardware_jis = 3;
- /**
- * for the 'hardware' field indicating a us layout
- */
- readonly layr_list_hardware_us = 4;
- /**
- * Convenience map of layr_list_hardware field values
- */
- readonly layr_list_hardware_map: Map = new Map(
- [
- ["touch", this.layr_list_hardware_touch],
- ["abnt2", this.layr_list_hardware_abnt2],
- ["iso", this.layr_list_hardware_iso],
- ["jis", this.layr_list_hardware_jis],
- ["us", this.layr_list_hardware_us],
- ]
- );
+ readonly layr_list_hardware_touch = 'touch';
/**
* Length of each layer entry in the 'layr' section variable part
*/
@@ -504,19 +479,6 @@ class Constants {
*/
readonly tran_group_type_reorder = 1;
- /* ------------------------------------------------------------------
- * vkey section
- ------------------------------------------------------------------ */
-
- /**
- * Minimum length of the 'vkey' section not including variable parts
- */
- readonly length_vkey = 12;
- /**
- * Length of each item in the 'vkey' section variable part
- */
- readonly length_vkey_item = 8;
-
/* ------------------------------------------------------------------
* vars section
* ------------------------------------------------------------------ */
@@ -581,7 +543,6 @@ class Constants {
tran: 'tran',
uset: 'uset',
vars: 'vars',
- vkey: 'vkey',
};
/**
diff --git a/core/include/ldml/tsconfig.build.json b/core/include/ldml/tsconfig.build.json
index 17c809a857a..fd0f003272c 100644
--- a/core/include/ldml/tsconfig.build.json
+++ b/core/include/ldml/tsconfig.build.json
@@ -1,5 +1,5 @@
{
- "extends": "../../../tsconfig.esm-base.json",
+ "extends": "../../../tsconfig.base.json",
"compilerOptions": {
"composite": true,
"declaration": true,
diff --git a/core/include/ldml/tsconfig.json b/core/include/ldml/tsconfig.json
index b89c96a0181..fa4135b0212 100644
--- a/core/include/ldml/tsconfig.json
+++ b/core/include/ldml/tsconfig.json
@@ -1,10 +1,8 @@
{
- "extends": "../../../tsconfig-base.json",
+ "extends": "../../../tsconfig.base.json",
"compilerOptions": {
"composite": true,
"declaration": true,
- "module": "es2020",
- "moduleResolution": "node",
"rootDir": ".",
"outDir": "build/",
},
diff --git a/core/src/context.hpp b/core/src/context.hpp
index b344e0657cd..08edc861634 100644
--- a/core/src/context.hpp
+++ b/core/src/context.hpp
@@ -3,13 +3,13 @@
Description: Internal context class and adaptor class for the API.
Create Date: 2 Oct 2018
Authors: Tim Eves (TSE)
- History: 2 Oct 2018 - TSE - Refactored out of km_kbp_context_api.cpp
+ History: 2 Oct 2018 - TSE - Refactored out of km_core_context_api.cpp
*/
#pragma once
#include
#include
-#include
+#include
// Forward declarations
class json;
@@ -20,32 +20,32 @@ namespace kbp
// This will likely be replaced with a class implementing a more space
// efficient data structure such as a ring buffer or bounded queue.
-class context: public std::list
+class context: public std::list
{
public:
- void push_character(km_kbp_usv);
+ void push_character(km_core_usv);
void push_marker(uint32_t);
};
inline
-void context::push_character(km_kbp_usv usv) {
- emplace_back(km_kbp_context_item { KM_KBP_CT_CHAR, {0,}, {usv} });
+void context::push_character(km_core_usv usv) {
+ emplace_back(km_core_context_item { KM_CORE_CT_CHAR, {0,}, {usv} });
}
inline
void context::push_marker(uint32_t marker) {
- emplace_back(km_kbp_context_item { KM_KBP_CT_MARKER, {0,}, {marker} });
+ emplace_back(km_core_context_item { KM_CORE_CT_MARKER, {0,}, {marker} });
}
} // namespace kbp
} // namespace km
json & operator << (json &, km::kbp::context const &);
-json & operator << (json &, km_kbp_context_item const &);
+json & operator << (json &, km_core_context_item const &);
-struct km_kbp_context : public km::kbp::context
+struct km_core_context : public km::kbp::context
{
};
diff --git a/core/src/debug.hpp b/core/src/debug.hpp
index 8069cfbc532..935fad155ca 100644
--- a/core/src/debug.hpp
+++ b/core/src/debug.hpp
@@ -9,20 +9,20 @@
#include
#include
-#include
-#include
+#include
+#include
namespace km {
namespace kbp
{
-class debug_items : public std::vector
+class debug_items : public std::vector
{
private:
bool _is_enabled;
public:
template debug_items(Args&&... args);
- void push_begin(km_kbp_state_debug_key_info *key_info, uint32_t flags);
+ void push_begin(km_core_state_debug_key_info *key_info, uint32_t flags);
void push_end(uint16_t first_action, uint32_t flags);
void assert_push_entry();
bool is_enabled() const noexcept;
@@ -31,29 +31,29 @@ class debug_items : public std::vector
template
debug_items::debug_items(Args&&... args)
-: std::vector(std::forward(args)...)
+: std::vector(std::forward(args)...)
{
// Ensure the debug_items list is terminated in case the client calls
- // km_kbp_state_debug_items before they call process_event.
+ // km_core_state_debug_items before they call process_event.
_is_enabled = false;
push_end(0, 0);
}
inline
void debug_items::assert_push_entry() {
- assert(empty() || (!empty() && back().type != KM_KBP_DEBUG_END));
+ assert(empty() || (!empty() && back().type != KM_CORE_DEBUG_END));
}
inline
-void debug_items::push_begin(km_kbp_state_debug_key_info *key_info, uint32_t flags) {
+void debug_items::push_begin(km_core_state_debug_key_info *key_info, uint32_t flags) {
assert_push_entry();
- emplace_back(km_kbp_state_debug_item{ KM_KBP_DEBUG_BEGIN, flags, {*key_info, }, { }});
+ emplace_back(km_core_state_debug_item{ KM_CORE_DEBUG_BEGIN, flags, {*key_info, }, { }});
}
inline
void debug_items::push_end(uint16_t first_action, uint32_t flags) {
assert_push_entry();
- emplace_back(km_kbp_state_debug_item{ KM_KBP_DEBUG_END, flags, { }, { u"", nullptr, nullptr, { }, first_action, {} } });
+ emplace_back(km_core_state_debug_item{ KM_CORE_DEBUG_END, flags, { }, { u"", nullptr, nullptr, { }, first_action, {} } });
}
inline
diff --git a/core/src/debuglog.h b/core/src/debuglog.h
index 16fba464285..1ecbaca6124 100644
--- a/core/src/debuglog.h
+++ b/core/src/debuglog.h
@@ -1,6 +1,6 @@
/* Debugging */
-#include
+#include
namespace km {
namespace kbp {
diff --git a/core/src/keyboard.cpp b/core/src/keyboard.cpp
index 977da597d31..47693b9b664 100644
--- a/core/src/keyboard.cpp
+++ b/core/src/keyboard.cpp
@@ -3,7 +3,7 @@
Description: Internal keyboard class and adaptor class for the API.
Create Date: 2 Oct 2018
Authors: Tim Eves (TSE)
- History: 7 Oct 2018 - TSE - Refactored out of km_kbp_keyboard_api.cpp
+ History: 7 Oct 2018 - TSE - Refactored out of km_core_keyboard_api.cpp
*/
#include "keyboard.hpp"
#include "jsonpp.hpp"
diff --git a/core/src/keyboard.hpp b/core/src/keyboard.hpp
index 57f8128c781..97329b7e761 100644
--- a/core/src/keyboard.hpp
+++ b/core/src/keyboard.hpp
@@ -3,7 +3,7 @@
Description: Internal keyboard class and adaptor class for the API.
Create Date: 2 Oct 2018
Authors: Tim Eves (TSE)
- History: 2 Oct 2018 - TSE - Refactored out of km_kbp_keyboard_api.cpp
+ History: 2 Oct 2018 - TSE - Refactored out of km_core_keyboard_api.cpp
*/
#pragma once
@@ -11,7 +11,7 @@
#include
#include
-#include
+#include
#include "option.hpp"
#include "path.hpp"
@@ -22,7 +22,7 @@ class json;
namespace km {
namespace kbp
{
- class keyboard_attributes : public km_kbp_keyboard_attrs
+ class keyboard_attributes : public km_core_keyboard_attrs
{
std::u16string _keyboard_id;
std::u16string _version_string;
@@ -36,7 +36,7 @@ namespace kbp
using path_type = decltype(_folder_path);
keyboard_attributes()
- : km_kbp_keyboard_attrs {nullptr, nullptr, nullptr, nullptr} {}
+ : km_core_keyboard_attrs {nullptr, nullptr, nullptr, nullptr} {}
keyboard_attributes(keyboard_attributes const &) = delete;
keyboard_attributes(keyboard_attributes &&);
diff --git a/core/src/km_kbp_context_api.cpp b/core/src/km_core_context_api.cpp
similarity index 54%
rename from core/src/km_kbp_context_api.cpp
rename to core/src/km_core_context_api.cpp
index a9111f66c45..3655af4e964 100644
--- a/core/src/km_kbp_context_api.cpp
+++ b/core/src/km_core_context_api.cpp
@@ -12,7 +12,7 @@
#include
#include
-#include
+#include
#include "context.hpp"
#include "jsonpp.hpp"
@@ -20,44 +20,44 @@
namespace {
template
- km_kbp_status
+ km_core_status
_context_items_from(typename U::codeunit_t const *text,
- km_kbp_context_item **out_ptr)
+ km_core_context_item **out_ptr)
{
assert(text); assert(out_ptr);
- if (!text || !out_ptr) return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (!text || !out_ptr) return KM_CORE_STATUS_INVALID_ARGUMENT;
*out_ptr = nullptr;
try
{
- std::vector res;
+ std::vector res;
for (auto i = typename U::const_iterator(text); *i; ++i)
{
- if(i.error()) return KM_KBP_STATUS_INVALID_UTF;
- res.emplace_back(km_kbp_context_item {KM_KBP_CT_CHAR, {0,}, {*i}});
+ if(i.error()) return KM_CORE_STATUS_INVALID_UTF;
+ res.emplace_back(km_core_context_item {KM_CORE_CT_CHAR, {0,}, {*i}});
}
// Terminate the context_items array.
- res.emplace_back(km_kbp_context_item KM_KBP_CONTEXT_ITEM_END);
+ res.emplace_back(km_core_context_item KM_CORE_CONTEXT_ITEM_END);
- *out_ptr = new km_kbp_context_item[res.size()];
+ *out_ptr = new km_core_context_item[res.size()];
std::move(res.begin(), res.end(), *out_ptr);
}
catch (std::bad_alloc &)
{
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
template
- km_kbp_status _context_items_to(km_kbp_context_item const *ci,
+ km_core_status _context_items_to(km_core_context_item const *ci,
typename U::codeunit_t *buf,
size_t * sz_ptr)
{
assert(ci); assert(sz_ptr);
- if (!ci || !sz_ptr) return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (!ci || !sz_ptr) return KM_CORE_STATUS_INVALID_ARGUMENT;
auto const buf_size = *sz_ptr;
if (buf && buf_size > 0)
@@ -65,9 +65,9 @@ namespace {
auto i = typename U::iterator(buf);
auto const e = decltype(i)(buf + buf_size - 1);
- for (;i != e && ci->type != KM_KBP_CT_END && !i.error(); ++ci)
+ for (;i != e && ci->type != KM_CORE_CT_END && !i.error(); ++ci)
{
- if (ci->type == KM_KBP_CT_CHAR)
+ if (ci->type == KM_CORE_CT_CHAR)
{
*i = ci->character; ++i;
}
@@ -77,13 +77,13 @@ namespace {
*sz_ptr = buf_size - (e - i);
// Skip over any final markers - they are execluded from context
- while(ci->type == KM_KBP_CT_MARKER) {
+ while(ci->type == KM_CORE_CT_MARKER) {
ci++;
}
- return ci->type == KM_KBP_CT_END
- ? KM_KBP_STATUS_OK
- : KM_KBP_STATUS_INSUFFICENT_BUFFER;
+ return ci->type == KM_CORE_CT_END
+ ? KM_CORE_STATUS_OK
+ : KM_CORE_STATUS_INSUFFICENT_BUFFER;
}
else
{
@@ -92,38 +92,38 @@ namespace {
do
{
- if (ci->type == KM_KBP_CT_CHAR)
+ if (ci->type == KM_CORE_CT_CHAR)
{
int8_t l = 4;
U::codec::put(cps, ci->character, l);
n += l;
}
}
- while(ci++->type != KM_KBP_CT_END);
+ while(ci++->type != KM_CORE_CT_END);
*sz_ptr = n+1;
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
}
}
-km_kbp_status
-km_kbp_context_items_from_utf16(km_kbp_cp const *text,
- km_kbp_context_item **out_ptr)
+km_core_status
+km_core_context_items_from_utf16(km_core_cp const *text,
+ km_core_context_item **out_ptr)
{
return _context_items_from(reinterpret_cast(text), out_ptr);
}
-km_kbp_status
-km_kbp_context_items_from_utf8(char const *text,
- km_kbp_context_item **out_ptr)
+km_core_status
+km_core_context_items_from_utf8(char const *text,
+ km_core_context_item **out_ptr)
{
return _context_items_from(reinterpret_cast(text), out_ptr);
}
-km_kbp_status km_kbp_context_items_to_utf8(km_kbp_context_item const *ci,
+km_core_status km_core_context_items_to_utf8(km_core_context_item const *ci,
char *buf, size_t * sz_ptr)
{
return _context_items_to(ci,
@@ -132,8 +132,8 @@ km_kbp_status km_kbp_context_items_to_utf8(km_kbp_context_item const *ci,
}
-km_kbp_status km_kbp_context_items_to_utf16(km_kbp_context_item const *ci,
- km_kbp_cp *buf, size_t * sz_ptr)
+km_core_status km_core_context_items_to_utf16(km_core_context_item const *ci,
+ km_core_cp *buf, size_t * sz_ptr)
{
return _context_items_to(ci,
reinterpret_cast(buf),
@@ -141,41 +141,41 @@ km_kbp_status km_kbp_context_items_to_utf16(km_kbp_context_item const *ci,
}
-void km_kbp_context_items_dispose(km_kbp_context_item *ci)
+void km_core_context_items_dispose(km_core_context_item *ci)
{
delete [] ci;
}
-km_kbp_status km_kbp_context_set(km_kbp_context *ctxt, km_kbp_context_item const *ci)
+km_core_status km_core_context_set(km_core_context *ctxt, km_core_context_item const *ci)
{
- km_kbp_context_clear(ctxt);
- return km_kbp_context_append(ctxt, ci);
+ km_core_context_clear(ctxt);
+ return km_core_context_append(ctxt, ci);
}
-km_kbp_status km_kbp_context_get(km_kbp_context const *ctxt,
- km_kbp_context_item **out_ptr)
+km_core_status km_core_context_get(km_core_context const *ctxt,
+ km_core_context_item **out_ptr)
{
assert(ctxt); assert(out_ptr);
- if (!ctxt || !out_ptr) return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (!ctxt || !out_ptr) return KM_CORE_STATUS_INVALID_ARGUMENT;
try
{
- *out_ptr = new km_kbp_context_item[ctxt->size() + 1];
+ *out_ptr = new km_core_context_item[ctxt->size() + 1];
}
catch (std::bad_alloc &)
{
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
std::copy(ctxt->begin(), ctxt->end(), *out_ptr);
- (*out_ptr)[ctxt->size()].type = KM_KBP_CT_END;
+ (*out_ptr)[ctxt->size()].type = KM_CORE_CT_END;
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-void km_kbp_context_clear(km_kbp_context *ctxt)
+void km_core_context_clear(km_core_context *ctxt)
{
assert(ctxt);
if (ctxt)
@@ -185,38 +185,38 @@ void km_kbp_context_clear(km_kbp_context *ctxt)
}
-size_t km_kbp_context_length(km_kbp_context *ctxt)
+size_t km_core_context_length(km_core_context *ctxt)
{
assert(ctxt);
return ctxt ? ctxt->size() : 0;
}
-km_kbp_status km_kbp_context_append(km_kbp_context *ctxt,
- km_kbp_context_item const *ci)
+km_core_status km_core_context_append(km_core_context *ctxt,
+ km_core_context_item const *ci)
{
assert(ctxt); assert(ci);
- if (!ctxt || !ci) return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (!ctxt || !ci) return KM_CORE_STATUS_INVALID_ARGUMENT;
try
{
- for (;ci->type != KM_KBP_CT_END; ++ci)
+ for (;ci->type != KM_CORE_CT_END; ++ci)
{
ctxt->emplace_back(*ci);
}
} catch (std::bad_alloc &) {
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-km_kbp_status km_kbp_context_shrink(km_kbp_context *ctxt, size_t num,
- km_kbp_context_item const * ci)
+km_core_status km_core_context_shrink(km_core_context *ctxt, size_t num,
+ km_core_context_item const * ci)
{
assert(ctxt);
- if (!ctxt) return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (!ctxt) return KM_CORE_STATUS_INVALID_ARGUMENT;
try
{
@@ -225,21 +225,21 @@ km_kbp_status km_kbp_context_shrink(km_kbp_context *ctxt, size_t num,
if (ci)
{
auto const ip = ctxt->begin();
- while(num-- && ci->type != KM_KBP_CT_END)
+ while(num-- && ci->type != KM_CORE_CT_END)
{
ctxt->emplace(ip, *ci);
ci++;
}
}
} catch (std::bad_alloc &) {
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
size_t
-km_kbp_context_item_list_size(km_kbp_context_item const *context_items)
+km_core_context_item_list_size(km_core_context_item const *context_items)
{
assert(context_items);
if (!context_items) return 0;
@@ -258,18 +258,18 @@ json & operator << (json & j, km::kbp::context const & ctxt) {
return j << json::close;
}
-json & operator << (json & j, km_kbp_context_item const & i)
+json & operator << (json & j, km_core_context_item const & i)
{
utf8::codeunit_t cps[7] = {0,}; // 6 bytes for maximal UTF-8 char (e.g. U+10FFFF) + nul terminator
int8_t l = 4;
switch (i.type)
{
- case KM_KBP_CT_CHAR:
+ case KM_CORE_CT_CHAR:
utf8::codec::put(cps, i.character, l);
j << json::string(&cps[0]);
break;
- case KM_KBP_CT_MARKER:
+ case KM_CORE_CT_MARKER:
j << json::integer_u(i.marker);
break;
default:
diff --git a/core/src/km_kbp_debug_api.cpp b/core/src/km_core_debug_api.cpp
similarity index 69%
rename from core/src/km_kbp_debug_api.cpp
rename to core/src/km_core_debug_api.cpp
index 0871df17ae5..df324c222e6 100644
--- a/core/src/km_kbp_debug_api.cpp
+++ b/core/src/km_core_debug_api.cpp
@@ -8,29 +8,29 @@
#include
#include
-#include
+#include
#include "processor.hpp"
#include "state.hpp"
using namespace km::kbp;
-km_kbp_status
-km_kbp_state_debug_set(
- km_kbp_state *state,
+km_core_status
+km_core_state_debug_set(
+ km_core_state *state,
int value
) {
assert(state);
if(!state) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
state->debug_items().set_enabled(value ? true : false);
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
uint8_t
-km_kbp_state_debug_get(
- km_kbp_state const *state
+km_core_state_debug_get(
+ km_core_state const *state
) {
assert(state);
if(!state) {
@@ -39,9 +39,9 @@ km_kbp_state_debug_get(
return state->debug_items().is_enabled() ? 1 : 0;
}
-km_kbp_state_debug_item const *
-km_kbp_state_debug_items(
- km_kbp_state const *state,
+km_core_state_debug_item const *
+km_core_state_debug_items(
+ km_core_state const *state,
size_t *num_items
) {
assert(state && state->debug_items().size() > 0);
@@ -58,6 +58,6 @@ km_kbp_state_debug_items(
// Process events will ensure that the debug vector is always well
// terminated
- assert(state->debug_items().back().type == KM_KBP_DEBUG_END);
+ assert(state->debug_items().back().type == KM_CORE_DEBUG_END);
return state->debug_items().data();
}
diff --git a/core/src/km_kbp_keyboard_api.cpp b/core/src/km_core_keyboard_api.cpp
similarity index 63%
rename from core/src/km_kbp_keyboard_api.cpp
rename to core/src/km_core_keyboard_api.cpp
index 13f3cafc45c..632a2beb28d 100644
--- a/core/src/km_kbp_keyboard_api.cpp
+++ b/core/src/km_core_keyboard_api.cpp
@@ -11,7 +11,7 @@
#include
#include
-#include
+#include
#include "keyboard.hpp"
#include "processor.hpp"
#include "kmx/kmx_processor.hpp"
@@ -43,85 +43,85 @@ namespace
}
-km_kbp_status
-km_kbp_keyboard_load(km_kbp_path_name kb_path, km_kbp_keyboard **keyboard)
+km_core_status
+km_core_keyboard_load(km_core_path_name kb_path, km_core_keyboard **keyboard)
{
assert(keyboard);
if (!keyboard)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
try
{
abstract_processor *kp = processor_factory(kb_path);
- km_kbp_status status = kp->validate();
- if (status != KM_KBP_STATUS_OK) {
+ km_core_status status = kp->validate();
+ if (status != KM_CORE_STATUS_OK) {
delete kp;
return status;
}
- *keyboard = static_cast(kp);
+ *keyboard = static_cast(kp);
}
catch (std::bad_alloc &)
{
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
void
-km_kbp_keyboard_dispose(km_kbp_keyboard *keyboard)
+km_core_keyboard_dispose(km_core_keyboard *keyboard)
{
delete keyboard;
}
-km_kbp_status
-km_kbp_keyboard_get_attrs(km_kbp_keyboard const *keyboard,
- km_kbp_keyboard_attrs const **out)
+km_core_status
+km_core_keyboard_get_attrs(km_core_keyboard const *keyboard,
+ km_core_keyboard_attrs const **out)
{
assert(keyboard); assert(out);
if (!keyboard || !out)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
*out = &keyboard->keyboard();
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-km_kbp_status
-km_kbp_keyboard_get_key_list(km_kbp_keyboard const *keyboard,
- km_kbp_keyboard_key **out)
+km_core_status
+km_core_keyboard_get_key_list(km_core_keyboard const *keyboard,
+ km_core_keyboard_key **out)
{
assert(keyboard); assert(out);
if (!keyboard || !out)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
*out = keyboard->get_key_list();
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-void km_kbp_keyboard_key_list_dispose(km_kbp_keyboard_key *key_list)
+void km_core_keyboard_key_list_dispose(km_core_keyboard_key *key_list)
{
delete[] key_list;
}
-km_kbp_status km_kbp_keyboard_get_imx_list(
- km_kbp_keyboard const *keyboard,
- km_kbp_keyboard_imx** imx_list
+km_core_status km_core_keyboard_get_imx_list(
+ km_core_keyboard const *keyboard,
+ km_core_keyboard_imx** imx_list
) {
assert(keyboard); assert(imx_list);
if (!keyboard || !imx_list) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
*imx_list = keyboard->get_imx_list();
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-void km_kbp_keyboard_imx_list_dispose(km_kbp_keyboard_imx *imx_list)
+void km_core_keyboard_imx_list_dispose(km_core_keyboard_imx *imx_list)
{
if(!imx_list) {
return;
}
- km_kbp_keyboard_imx *imx_rule_it = imx_list;
+ km_core_keyboard_imx *imx_rule_it = imx_list;
for (; imx_rule_it->library_name; ++imx_rule_it) {
delete [] imx_rule_it->library_name; // from u16dup
delete [] imx_rule_it->function_name; // from u16dup
diff --git a/core/src/km_kbp_options_api.cpp b/core/src/km_core_options_api.cpp
similarity index 56%
rename from core/src/km_kbp_options_api.cpp
rename to core/src/km_core_options_api.cpp
index 7dc48790987..3cb0745fa90 100644
--- a/core/src/km_kbp_options_api.cpp
+++ b/core/src/km_core_options_api.cpp
@@ -11,7 +11,7 @@
#include
#include
-#include
+#include
#include "processor.hpp"
#include "jsonpp.hpp"
@@ -19,7 +19,7 @@
size_t
-km_kbp_options_list_size(km_kbp_option_item const *opts)
+km_core_options_list_size(km_core_option_item const *opts)
{
assert(opts);
if (!opts) return 0;
@@ -33,31 +33,31 @@ km_kbp_options_list_size(km_kbp_option_item const *opts)
}
-km_kbp_status
-km_kbp_state_option_lookup(km_kbp_state const *state,
- uint8_t scope, km_kbp_cp const *key,
- km_kbp_cp const **value_out)
+km_core_status
+km_core_state_option_lookup(km_core_state const *state,
+ uint8_t scope, km_core_cp const *key,
+ km_core_cp const **value_out)
{
assert(state); assert(key); assert(value_out);
- if (!state || !key || !value_out) return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (!state || !key || !value_out) return KM_CORE_STATUS_INVALID_ARGUMENT;
- if (scope == KM_KBP_OPT_UNKNOWN || scope > KM_KBP_OPT_MAX_SCOPES)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (scope == KM_CORE_OPT_UNKNOWN || scope > KM_CORE_OPT_MAX_SCOPES)
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
auto & processor = state->processor();
- *value_out = processor.lookup_option(km_kbp_option_scope(scope), key);
- if (!*value_out) return KM_KBP_STATUS_KEY_ERROR;
+ *value_out = processor.lookup_option(km_core_option_scope(scope), key);
+ if (!*value_out) return KM_CORE_STATUS_KEY_ERROR;
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-km_kbp_status
-km_kbp_state_options_update(km_kbp_state *state, km_kbp_option_item const *opt)
+km_core_status
+km_core_state_options_update(km_core_state *state, km_core_option_item const *opt)
{
assert(state); assert(opt);
- if (!state|| !opt) return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (!state|| !opt) return KM_CORE_STATUS_INVALID_ARGUMENT;
auto & processor = state->processor();
@@ -65,32 +65,32 @@ km_kbp_state_options_update(km_kbp_state *state, km_kbp_option_item const *opt)
{
for (;opt->key; ++opt)
{
- if (opt->scope == KM_KBP_OPT_UNKNOWN || opt->scope > KM_KBP_OPT_MAX_SCOPES)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ if (opt->scope == KM_CORE_OPT_UNKNOWN || opt->scope > KM_CORE_OPT_MAX_SCOPES)
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
if (processor.update_option(
- km_kbp_option_scope(opt->scope),
+ km_core_option_scope(opt->scope),
opt->key,
opt->value).empty())
- return KM_KBP_STATUS_KEY_ERROR;
+ return KM_CORE_STATUS_KEY_ERROR;
}
}
catch (std::bad_alloc &)
{
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
// This function doesn't need to use the json pretty printer for such a simple
// list of key:value pairs but it's a good introduction to it.
-km_kbp_status
-km_kbp_state_options_to_json(km_kbp_state const *state, char *buf, size_t *space)
+km_core_status
+km_core_state_options_to_json(km_core_state const *state, char *buf, size_t *space)
{
assert(state); assert(space);
if (!state || !space)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
std::stringstream _buf;
json jo(_buf);
@@ -103,7 +103,7 @@ km_kbp_state_options_to_json(km_kbp_state const *state, char *buf, size_t *space
catch (std::bad_alloc &)
{
*space = 0;
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
// Fetch the finished doc and copy it to the buffer if there enough space.
@@ -116,5 +116,5 @@ km_kbp_state_options_to_json(km_kbp_state const *state, char *buf, size_t *space
// Return space needed/used.
*space = doc.size()+1;
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
diff --git a/core/src/km_kbp_processevent_api.cpp b/core/src/km_core_processevent_api.cpp
similarity index 62%
rename from core/src/km_kbp_processevent_api.cpp
rename to core/src/km_core_processevent_api.cpp
index 69eba06a41c..5295d39af7b 100644
--- a/core/src/km_kbp_processevent_api.cpp
+++ b/core/src/km_core_processevent_api.cpp
@@ -8,63 +8,63 @@
History: 17 Oct 2018 - TSE - Initial implementation.
*/
-#include
+#include
#include "processor.hpp"
#include "state.hpp"
-km_kbp_status
-km_kbp_event(
- km_kbp_state *state,
+km_core_status
+km_core_event(
+ km_core_state *state,
uint32_t event,
void* data
) {
assert(state != nullptr);
if(state == nullptr) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
- // event: KM_KBP_EVENT_KEYBOARD_ACTIVATED; data should be nullptr
- // future event: KM_KBP_EVENT_KEYBOARD_DEACTIVATED
+ // event: KM_CORE_EVENT_KEYBOARD_ACTIVATED; data should be nullptr
+ // future event: KM_CORE_EVENT_KEYBOARD_DEACTIVATED
switch(event) {
- case KM_KBP_EVENT_KEYBOARD_ACTIVATED:
+ case KM_CORE_EVENT_KEYBOARD_ACTIVATED:
assert(data == nullptr);
if(data != nullptr) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
break;
default:
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
return state->processor().external_event(state, event, data);
}
-km_kbp_status
-km_kbp_process_event(km_kbp_state *state,
- km_kbp_virtual_key vk,
+km_core_status
+km_core_process_event(km_core_state *state,
+ km_core_virtual_key vk,
uint16_t modifier_state,
uint8_t is_key_down,
uint16_t event_flags) {
assert(state != nullptr);
if(state == nullptr) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
return state->processor().process_event(state, vk, modifier_state, is_key_down, event_flags);
}
-km_kbp_status
-km_kbp_process_queued_actions(
- km_kbp_state *state
+km_core_status
+km_core_process_queued_actions(
+ km_core_state *state
) {
assert(state != nullptr);
if(state == nullptr) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
return state->processor().process_queued_actions(state);
}
-km_kbp_attr const *
-km_kbp_get_engine_attrs(km_kbp_state const *state)
+km_core_attr const *
+km_core_get_engine_attrs(km_core_state const *state)
{
assert(state != nullptr);
if(state == nullptr) {
diff --git a/core/src/km_kbp_state_api.cpp b/core/src/km_core_state_api.cpp
similarity index 59%
rename from core/src/km_kbp_state_api.cpp
rename to core/src/km_core_state_api.cpp
index b966688950f..fdafd9a5b72 100644
--- a/core/src/km_kbp_state_api.cpp
+++ b/core/src/km_core_state_api.cpp
@@ -12,7 +12,7 @@
#include
#include
-#include
+#include
#include "jsonpp.hpp"
#include "processor.hpp"
@@ -23,68 +23,68 @@ using namespace km::kbp;
// Forward declarations
class context;
-km_kbp_status km_kbp_state_create(km_kbp_keyboard * keyboard,
- km_kbp_option_item const *env,
- km_kbp_state ** out)
+km_core_status km_core_state_create(km_core_keyboard * keyboard,
+ km_core_option_item const *env,
+ km_core_state ** out)
{
assert(keyboard); assert(env); assert(out);
if (!keyboard || !env || !out)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
try
{
- *out = new km_kbp_state(static_cast(*keyboard), env);
+ *out = new km_core_state(static_cast(*keyboard), env);
}
catch (std::bad_alloc &)
{
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-km_kbp_status km_kbp_state_clone(km_kbp_state const *state,
- km_kbp_state ** out)
+km_core_status km_core_state_clone(km_core_state const *state,
+ km_core_state ** out)
{
assert(state); assert(out);
if (!state || !out)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
- *out = new km_kbp_state(*state);
- return KM_KBP_STATUS_OK;
+ *out = new km_core_state(*state);
+ return KM_CORE_STATUS_OK;
}
-void km_kbp_state_dispose(km_kbp_state *state)
+void km_core_state_dispose(km_core_state *state)
{
delete state;
}
-km_kbp_context *km_kbp_state_context(km_kbp_state *state)
+km_core_context *km_core_state_context(km_core_state *state)
{
assert(state);
if (!state) return nullptr;
- return static_cast(&state->context());
+ return static_cast(&state->context());
}
-km_kbp_status kbp_state_get_intermediate_context(
- km_kbp_state *state,
- km_kbp_context_item ** context_items
+km_core_status kbp_state_get_intermediate_context(
+ km_core_state *state,
+ km_core_context_item ** context_items
) {
assert(state);
assert(context_items);
if (!state || !context_items) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
auto & processor = state->processor();
*context_items = processor.get_intermediate_context();
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-km_kbp_action_item const * km_kbp_state_action_items(km_kbp_state const *state,
+km_core_action_item const * km_core_state_action_items(km_core_state const *state,
size_t *num_items)
{
assert(state && state->actions().size() > 0);
@@ -95,33 +95,33 @@ km_kbp_action_item const * km_kbp_state_action_items(km_kbp_state const *state,
// Process events will ensure that the actions vector is always well
// teminated
- assert(state->actions().back().type == KM_KBP_IT_END);
+ assert(state->actions().back().type == KM_CORE_IT_END);
return state->actions().data();
}
-km_kbp_status km_kbp_state_queue_action_items(
- km_kbp_state *state,
- km_kbp_action_item const *action_items
+km_core_status km_core_state_queue_action_items(
+ km_core_state *state,
+ km_core_action_item const *action_items
) {
assert(state);
assert(action_items);
if (!state|| !action_items) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
auto & processor = state->processor();
- for (; action_items->type != KM_KBP_IT_END; ++action_items) {
- if (action_items->type >= KM_KBP_IT_MAX_TYPE_ID) {
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ for (; action_items->type != KM_CORE_IT_END; ++action_items) {
+ if (action_items->type >= KM_CORE_IT_MAX_TYPE_ID) {
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
}
if (!processor.queue_action(state, action_items)) {
- return KM_KBP_STATUS_KEY_ERROR;
+ return KM_CORE_STATUS_KEY_ERROR;
}
}
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
namespace {
char const * action_item_name_lut[] = {
@@ -146,10 +146,10 @@ namespace {
}
-json & operator << (json & j, km_kbp_action_item const &act)
+json & operator << (json & j, km_core_action_item const &act)
{
j << json::flat << json::object;
- if (act.type >= KM_KBP_IT_MAX_TYPE_ID)
+ if (act.type >= KM_CORE_IT_MAX_TYPE_ID)
{
j << "invalid" << json::null << json::close;
return j;
@@ -158,16 +158,16 @@ json & operator << (json & j, km_kbp_action_item const &act)
j << action_item_name_lut[act.type];
switch (act.type)
{
- case KM_KBP_IT_END:
- case KM_KBP_IT_ALERT:
- case KM_KBP_IT_BACK:
+ case KM_CORE_IT_END:
+ case KM_CORE_IT_ALERT:
+ case KM_CORE_IT_BACK:
j << json::null;
break;
- case KM_KBP_IT_CHAR:
- case KM_KBP_IT_MARKER:
- j << km_kbp_context_item {act.type, {0,}, {act.character}}; // TODO: is act.type correct here? it may map okay but this is bad practice to mix constants across types. Similarly using act.character instead of act.type
+ case KM_CORE_IT_CHAR:
+ case KM_CORE_IT_MARKER:
+ j << km_core_context_item {act.type, {0,}, {act.character}}; // TODO: is act.type correct here? it may map okay but this is bad practice to mix constants across types. Similarly using act.character instead of act.type
break;
- case KM_KBP_IT_PERSIST_OPT:
+ case KM_CORE_IT_PERSIST_OPT:
j << json::object
<< scope_names_lut[act.option->scope]
<< json::flat << json::object
@@ -187,7 +187,7 @@ json & operator << (json & j, actions const & acts)
j << json::array;
for (auto & act: acts)
{
- if (act.type != KM_KBP_IT_END)
+ if (act.type != KM_CORE_IT_END)
{
j << act;
}
@@ -197,13 +197,13 @@ json & operator << (json & j, actions const & acts)
}
-km_kbp_status km_kbp_state_to_json(km_kbp_state const *state,
+km_core_status km_core_state_to_json(km_core_state const *state,
char *buf,
size_t *space)
{
assert(state);
if (!state)
- return KM_KBP_STATUS_INVALID_ARGUMENT;
+ return KM_CORE_STATUS_INVALID_ARGUMENT;
std::stringstream _buf;
json jo(_buf);
@@ -212,7 +212,7 @@ km_kbp_status km_kbp_state_to_json(km_kbp_state const *state,
{
// Pretty print the document.
jo << json::object
- << "$schema" << "keyman/keyboardprocessor/doc/introspection.schema"
+ << "$schema" << "keyman/core/doc/introspection.schema"
<< "keyboard" << state->processor().keyboard()
// << "options" << state->options() TODO: Fix
<< "context" << state->context()
@@ -222,7 +222,7 @@ km_kbp_status km_kbp_state_to_json(km_kbp_state const *state,
catch (std::bad_alloc &)
{
*space = 0;
- return KM_KBP_STATUS_NO_MEM;
+ return KM_CORE_STATUS_NO_MEM;
}
// Fetch the finished doc and copy it to the buffer if there enough space.
@@ -235,13 +235,13 @@ km_kbp_status km_kbp_state_to_json(km_kbp_state const *state,
// Return space needed/used.
*space = doc.size()+1;
- return KM_KBP_STATUS_OK;
+ return KM_CORE_STATUS_OK;
}
-void km_kbp_state_imx_register_callback(
- km_kbp_state *state,
- km_kbp_keyboard_imx_platform imx_callback,
+void km_core_state_imx_register_callback(
+ km_core_state *state,
+ km_core_keyboard_imx_platform imx_callback,
void *callback_object
) {
assert(state);
@@ -251,7 +251,7 @@ void km_kbp_state_imx_register_callback(
state->imx_register_callback(imx_callback, callback_object);
}
-void km_kbp_state_imx_deregister_callback(km_kbp_state *state)
+void km_core_state_imx_deregister_callback(km_core_state *state)
{
assert(state);
if (!state) {
diff --git a/core/src/kmx/kmx_base.h b/core/src/kmx/kmx_base.h
index 7fc335cfc46..77cf53c209b 100644
--- a/core/src/kmx/kmx_base.h
+++ b/core/src/kmx/kmx_base.h
@@ -1,7 +1,7 @@
#pragma once
-#include
-#include
+#include
+#include
#if defined(_WIN32) || defined(_WIN64)
#define snprintf _snprintf
diff --git a/core/src/kmx/kmx_capslock.cpp b/core/src/kmx/kmx_capslock.cpp
index e125ccd4cf1..f14745bf326 100644
--- a/core/src/kmx/kmx_capslock.cpp
+++ b/core/src/kmx/kmx_capslock.cpp
@@ -2,7 +2,7 @@
Copyright: Copyright (C) 2003-2018 SIL International.
Authors: mcdurdin
*/
-#include
+#include
#include
using namespace km::kbp;
diff --git a/core/src/kmx/kmx_consts.cpp b/core/src/kmx/kmx_consts.cpp
index 26457469498..a0e1ff660ab 100644
--- a/core/src/kmx/kmx_consts.cpp
+++ b/core/src/kmx/kmx_consts.cpp
@@ -6,22 +6,22 @@ namespace kbp {
namespace kmx {
const struct char_to_vkey s_char_to_vkey[] = {
- {KM_KBP_VKEY_SPACE, 0, 0}, //
+ {KM_CORE_VKEY_SPACE, 0, 0}, //
{'1', 1, 0}, // !
- {KM_KBP_VKEY_QUOTE, 1, 0}, // "
+ {KM_CORE_VKEY_QUOTE, 1, 0}, // "
{'3', 1, 0}, // #
{'4', 1, 0}, // $
{'5', 1, 0}, // %
{'7', 1, 0}, // &
- {KM_KBP_VKEY_QUOTE, 0, 0}, // '
+ {KM_CORE_VKEY_QUOTE, 0, 0}, // '
{'9', 1, 0}, // (
{'0', 1, 0}, // )
{'8', 1, 0}, // *
- {KM_KBP_VKEY_EQUAL, 1, 0}, // +
- {KM_KBP_VKEY_COMMA, 0, 0}, // ,
- {KM_KBP_VKEY_HYPHEN, 0, 0}, // -
- {KM_KBP_VKEY_PERIOD, 0, 0}, // .
- {KM_KBP_VKEY_SLASH, 0, 0}, // /
+ {KM_CORE_VKEY_EQUAL, 1, 0}, // +
+ {KM_CORE_VKEY_COMMA, 0, 0}, // ,
+ {KM_CORE_VKEY_HYPHEN, 0, 0}, // -
+ {KM_CORE_VKEY_PERIOD, 0, 0}, // .
+ {KM_CORE_VKEY_SLASH, 0, 0}, // /
{'0', 0, 0},
{'1', 0, 0},
{'2', 0, 0},
@@ -32,12 +32,12 @@ const struct char_to_vkey s_char_to_vkey[] = {
{'7', 0, 0},
{'8', 0, 0},
{'9', 0, 0},
- {KM_KBP_VKEY_COLON, 1, 0}, // :
- {KM_KBP_VKEY_COLON, 0, 0}, // ;
- {KM_KBP_VKEY_COMMA, 1, 0}, // <
- {KM_KBP_VKEY_EQUAL, 0, 0}, // =
- {KM_KBP_VKEY_PERIOD, 1, 0}, // >
- {KM_KBP_VKEY_SLASH, 1, 0}, // ?
+ {KM_CORE_VKEY_COLON, 1, 0}, // :
+ {KM_CORE_VKEY_COLON, 0, 0}, // ;
+ {KM_CORE_VKEY_COMMA, 1, 0}, // <
+ {KM_CORE_VKEY_EQUAL, 0, 0}, // =
+ {KM_CORE_VKEY_PERIOD, 1, 0}, // >
+ {KM_CORE_VKEY_SLASH, 1, 0}, // ?
{'2', 1, 0}, // @
{'A', 1, 1},
{'B', 1, 1},
@@ -65,12 +65,12 @@ const struct char_to_vkey s_char_to_vkey[] = {
{'X', 1, 1},
{'Y', 1, 1},
{'Z', 1, 1},
- {KM_KBP_VKEY_LBRKT, 0, 0},
- {KM_KBP_VKEY_BKSLASH, 0, 0},
- {KM_KBP_VKEY_RBRKT, 0, 0},
+ {KM_CORE_VKEY_LBRKT, 0, 0},
+ {KM_CORE_VKEY_BKSLASH, 0, 0},
+ {KM_CORE_VKEY_RBRKT, 0, 0},
{'6', 1, 0},
- {KM_KBP_VKEY_HYPHEN, 1, 0},
- {KM_KBP_VKEY_BKQUOTE, 0, 0},
+ {KM_CORE_VKEY_HYPHEN, 1, 0},
+ {KM_CORE_VKEY_BKQUOTE, 0, 0},
{'A', 0, 1},
{'B', 0, 1},
{'C', 0, 1},
@@ -97,10 +97,10 @@ const struct char_to_vkey s_char_to_vkey[] = {
{'X', 0, 1},
{'Y', 0, 1},
{'Z', 0, 1},
- {KM_KBP_VKEY_LBRKT, 1, 0},
- {KM_KBP_VKEY_BKSLASH, 1, 0},
- {KM_KBP_VKEY_RBRKT, 1, 0},
- {KM_KBP_VKEY_BKQUOTE, 1, 0},
+ {KM_CORE_VKEY_LBRKT, 1, 0},
+ {KM_CORE_VKEY_BKSLASH, 1, 0},
+ {KM_CORE_VKEY_RBRKT, 1, 0},
+ {KM_CORE_VKEY_BKQUOTE, 1, 0},
{0, 0, 0}
};
diff --git a/core/src/kmx/kmx_debugger.cpp b/core/src/kmx/kmx_debugger.cpp
index c217086acdb..84280280deb 100644
--- a/core/src/kmx/kmx_debugger.cpp
+++ b/core/src/kmx/kmx_debugger.cpp
@@ -21,7 +21,7 @@ void KMX_DebugItems::push_item(
PKMX_WORD index_stack
) {
_items->assert_push_entry();
- km_kbp_state_debug_item item = {type, flags, {}, {}};
+ km_core_state_debug_item item = {type, flags, {}, {}};
item.kmx_info.rule = key;
if(item.kmx_info.rule && index_stack) {
this->fill_store_offsets(&item.kmx_info, index_stack);
@@ -43,7 +43,7 @@ void KMX_DebugItems::push_set_option(
KMX_WCHAR const * value
) {
_items->assert_push_entry();
- km_kbp_state_debug_item item = {KM_KBP_DEBUG_SET_OPTION, 0, {}, {}};
+ km_core_state_debug_item item = {KM_CORE_DEBUG_SET_OPTION, 0, {}, {}};
item.kmx_info.first_action = first_action;
item.kmx_info.rule = nullptr;
item.kmx_info.group = nullptr;
@@ -57,11 +57,11 @@ void KMX_DebugItems::push_set_option(
_items->emplace_back(item);
}
-void KMX_DebugItems::fill_store_offsets(km_kbp_state_debug_kmx_info *info, PKMX_WORD index_stack) {
+void KMX_DebugItems::fill_store_offsets(km_core_state_debug_kmx_info *info, PKMX_WORD index_stack) {
int i, n;
- km_kbp_cp *p;
+ km_core_cp *p;
// TODO turn this into a struct rather than interwoven values
for(i = n = 0, p = static_cast(info->rule)->dpContext; p && *p; p = incxstr(p), i++) {
diff --git a/core/src/kmx/kmx_debugger.h b/core/src/kmx/kmx_debugger.h
index 20006e291c7..45b9b8d3110 100644
--- a/core/src/kmx/kmx_debugger.h
+++ b/core/src/kmx/kmx_debugger.h
@@ -31,12 +31,12 @@ class KMX_DebugItems
PKMX_WORD index_stack = nullptr
);
void fill_store_offsets(
- km_kbp_state_debug_kmx_info *info,
+ km_core_state_debug_kmx_info *info,
PKMX_WORD index_stack
);
public:
KMX_DebugItems(debug_items *items);
- void push_begin(km_kbp_state_debug_key_info *key_info, uint32_t flags);
+ void push_begin(km_core_state_debug_key_info *key_info, uint32_t flags);
void push_end(uint16_t first_action, uint32_t flags);
void push_group_enter(uint16_t first_action, LPGROUP group);
void push_group_exit(uint16_t first_action, uint32_t flags, LPGROUP group);
@@ -73,10 +73,10 @@ KMX_DebugItems::KMX_DebugItems(debug_items *items) {
inline void
KMX_DebugItems::push_begin(
- km_kbp_state_debug_key_info *key_info,
+ km_core_state_debug_key_info *key_info,
uint32_t flags
) {
- // As the vector always starts with a single KM_KBP_DEBUG_END entry,
+ // As the vector always starts with a single KM_CORE_DEBUG_END entry,
// we clear that and any other potential events first before starting a new event sequence
_items->clear();
_items->push_begin(key_info, flags);
@@ -92,32 +92,32 @@ KMX_DebugItems::push_end(
inline void
KMX_DebugItems::push_group_enter(uint16_t first_action, LPGROUP group) {
- push_item(KM_KBP_DEBUG_GROUP_ENTER, first_action, 0, group);
+ push_item(KM_CORE_DEBUG_GROUP_ENTER, first_action, 0, group);
}
inline void
KMX_DebugItems::push_group_exit(uint16_t first_action, uint32_t flags, LPGROUP group) {
- push_item(KM_KBP_DEBUG_GROUP_EXIT, first_action, flags, group);
+ push_item(KM_CORE_DEBUG_GROUP_EXIT, first_action, flags, group);
}
inline void
KMX_DebugItems::push_nomatch_enter(uint16_t first_action, LPGROUP group) {
- push_item(KM_KBP_DEBUG_NOMATCH_ENTER, first_action, 0, group);
+ push_item(KM_CORE_DEBUG_NOMATCH_ENTER, first_action, 0, group);
}
inline void
KMX_DebugItems::push_nomatch_exit(uint16_t first_action, LPGROUP group) {
- push_item(KM_KBP_DEBUG_NOMATCH_EXIT, first_action, 0, group);
+ push_item(KM_CORE_DEBUG_NOMATCH_EXIT, first_action, 0, group);
}
inline void
KMX_DebugItems::push_match_enter(uint16_t first_action, LPGROUP group) {
- push_item(KM_KBP_DEBUG_MATCH_ENTER, first_action, 0, group);
+ push_item(KM_CORE_DEBUG_MATCH_ENTER, first_action, 0, group);
}
inline void
KMX_DebugItems::push_match_exit(uint16_t first_action, LPGROUP group) {
- push_item(KM_KBP_DEBUG_MATCH_EXIT, first_action, 0, group);
+ push_item(KM_CORE_DEBUG_MATCH_EXIT, first_action, 0, group);
}
inline void
@@ -128,7 +128,7 @@ KMX_DebugItems::push_rule_enter(
PKMX_WCHAR context,
PKMX_WORD index_stack
) {
- push_item(KM_KBP_DEBUG_RULE_ENTER, first_action, 0, group, key, context, index_stack);
+ push_item(KM_CORE_DEBUG_RULE_ENTER, first_action, 0, group, key, context, index_stack);
}
inline void
@@ -139,7 +139,7 @@ KMX_DebugItems::push_rule_exit(
PKMX_WCHAR context,
PKMX_WORD index_stack
) {
- push_item(KM_KBP_DEBUG_RULE_EXIT, first_action, 0, group, key, context, index_stack);
+ push_item(KM_CORE_DEBUG_RULE_EXIT, first_action, 0, group, key, context, index_stack);
}
} // namespace kmx
diff --git a/core/src/kmx/kmx_environment.cpp b/core/src/kmx/kmx_environment.cpp
index 4d3d3c54903..5d6e367e141 100644
--- a/core/src/kmx/kmx_environment.cpp
+++ b/core/src/kmx/kmx_environment.cpp
@@ -3,7 +3,7 @@
Authors: mcdurdin
*/
#include
-#include
+#include
#include
#include
@@ -11,7 +11,7 @@ using namespace km::kbp;
using namespace kmx;
namespace {
- km_kbp_cp const
+ km_core_cp const
*DEFAULT_PLATFORM = u"windows hardware desktop native",
*DEFAULT_BASELAYOUT = u"kbdus.dll",
*DEFAULT_BASELAYOUTALT = u"en-US",
@@ -20,11 +20,11 @@ namespace {
}
KMX_Environment::KMX_Environment() {
- Set(KM_KBP_KMX_ENV_PLATFORM, DEFAULT_PLATFORM);
- Set(KM_KBP_KMX_ENV_BASELAYOUT, DEFAULT_BASELAYOUT);
- Set(KM_KBP_KMX_ENV_BASELAYOUTALT, DEFAULT_BASELAYOUTALT);
- Set(KM_KBP_KMX_ENV_SIMULATEALTGR, DEFAULT_SIMULATEALTGR);
- Set(KM_KBP_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT, DEFAULT_BASELAYOUTGIVESCTRLRALTFORRALT);
+ Set(KM_CORE_KMX_ENV_PLATFORM, DEFAULT_PLATFORM);
+ Set(KM_CORE_KMX_ENV_BASELAYOUT, DEFAULT_BASELAYOUT);
+ Set(KM_CORE_KMX_ENV_BASELAYOUTALT, DEFAULT_BASELAYOUTALT);
+ Set(KM_CORE_KMX_ENV_SIMULATEALTGR, DEFAULT_SIMULATEALTGR);
+ Set(KM_CORE_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT, DEFAULT_BASELAYOUTGIVESCTRLRALTFORRALT);
}
@@ -32,19 +32,19 @@ char16_t const * KMX_Environment::LookUp(std::u16string const & key) const {
assert(!key.empty());
if (!key.empty()) return nullptr;
- if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_PLATFORM)) {
+ if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_PLATFORM)) {
return _platform.c_str();
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_BASELAYOUT)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_BASELAYOUT)) {
return _baseLayout.c_str();
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_BASELAYOUTALT)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_BASELAYOUTALT)) {
return _baseLayoutAlt.c_str();
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_SIMULATEALTGR)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_SIMULATEALTGR)) {
return _simulateAltGr ? u"1" : u"0";
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT)) {
return _baseLayoutGivesCtrlRAltForRAlt ? u"1" : u"0";
}
else {
@@ -57,19 +57,19 @@ char16_t const * KMX_Environment::LookUp(std::u16string const & key) const {
void KMX_Environment::Set(std::u16string const & key, std::u16string const & value) {
assert(!key.empty());
- if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_PLATFORM)) {
+ if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_PLATFORM)) {
_platform = value;
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_BASELAYOUT)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_BASELAYOUT)) {
_baseLayout = value;
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_BASELAYOUTALT)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_BASELAYOUTALT)) {
_baseLayoutAlt = value;
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_SIMULATEALTGR)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_SIMULATEALTGR)) {
_simulateAltGr = value == u"1";
}
- else if (!u16icmp(key.c_str(), KM_KBP_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT)) {
+ else if (!u16icmp(key.c_str(), KM_CORE_KMX_ENV_BASELAYOUTGIVESCTRLRALTFORRALT)) {
_baseLayoutGivesCtrlRAltForRAlt = value == u"1";
}
else {
diff --git a/core/src/kmx/kmx_environment.h b/core/src/kmx/kmx_environment.h
index 4d934e0d104..d15b3c587bc 100644
--- a/core/src/kmx/kmx_environment.h
+++ b/core/src/kmx/kmx_environment.h
@@ -15,8 +15,8 @@ class KMX_Environment {
std::u16string _platform;
void InitOption(
std::vector