From f1f7be6910f96a61154d1a2fbb7f6d17f9072543 Mon Sep 17 00:00:00 2001
From: "Steven R. Loomis" <srl295@gmail.com>
Date: Thu, 27 Jun 2024 19:42:19 -0500
Subject: [PATCH] [ldml_test] add experimental/sil/ldml_test

- test out LDML keyboards in repo
- https://github.com/keymanapp/keyman/issues/10505
---
 experimental/sil/ldml_test/.gitignore         |   2 +
 experimental/sil/ldml_test/HISTORY.md         |   6 +
 experimental/sil/ldml_test/LICENSE.md         |  21 +++
 experimental/sil/ldml_test/README.md          |  98 +++++++++++++
 experimental/sil/ldml_test/ldml_test.kpj      |   8 ++
 .../sil/ldml_test/source/ldml_test-test.xml   |  93 +++++++++++++
 .../sil/ldml_test/source/ldml_test.kps        |  71 ++++++++++
 .../sil/ldml_test/source/ldml_test.xml        | 129 ++++++++++++++++++
 experimental/sil/ldml_test/source/readme.htm  |  24 ++++
 experimental/sil/ldml_test/source/welcome.htm |  26 ++++
 10 files changed, 478 insertions(+)
 create mode 100644 experimental/sil/ldml_test/.gitignore
 create mode 100644 experimental/sil/ldml_test/HISTORY.md
 create mode 100644 experimental/sil/ldml_test/LICENSE.md
 create mode 100644 experimental/sil/ldml_test/README.md
 create mode 100644 experimental/sil/ldml_test/ldml_test.kpj
 create mode 100644 experimental/sil/ldml_test/source/ldml_test-test.xml
 create mode 100644 experimental/sil/ldml_test/source/ldml_test.kps
 create mode 100644 experimental/sil/ldml_test/source/ldml_test.xml
 create mode 100644 experimental/sil/ldml_test/source/readme.htm
 create mode 100644 experimental/sil/ldml_test/source/welcome.htm

diff --git a/experimental/sil/ldml_test/.gitignore b/experimental/sil/ldml_test/.gitignore
new file mode 100644
index 0000000000..1c246cea86
--- /dev/null
+++ b/experimental/sil/ldml_test/.gitignore
@@ -0,0 +1,2 @@
+/build
+/*.kpj.user
diff --git a/experimental/sil/ldml_test/HISTORY.md b/experimental/sil/ldml_test/HISTORY.md
new file mode 100644
index 0000000000..19368fb6b1
--- /dev/null
+++ b/experimental/sil/ldml_test/HISTORY.md
@@ -0,0 +1,6 @@
+LDML Test Change History
+====================
+
+1.0.0 (2024-02-14)
+----------------
+* Created by Steven R. Loomis
diff --git a/experimental/sil/ldml_test/LICENSE.md b/experimental/sil/ldml_test/LICENSE.md
new file mode 100644
index 0000000000..e8462b78a1
--- /dev/null
+++ b/experimental/sil/ldml_test/LICENSE.md
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2024 Steven R. Loomis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/experimental/sil/ldml_test/README.md b/experimental/sil/ldml_test/README.md
new file mode 100644
index 0000000000..f05d95dedc
--- /dev/null
+++ b/experimental/sil/ldml_test/README.md
@@ -0,0 +1,98 @@
+LDML Test keyboard
+==============
+
+Description
+-----------
+Test Keyboard for LDML
+
+
+Trying it Out
+-------------
+
+This section describes how to test the keyboard. For example, typing <kbd>1</kbd> will produce `1:basic:OK`. Following these steps in order will make sure the keyboard (and the implementation) is working properly.
+
+Each of the steps produces output ending in `:OK`.  You can press <kbd>enter</kbd> in between steps to put the output on separate lines.
+
+### Direct key output
+
+1. Press: <kbd>1</kbd>
+2. Check: `1:basic:OK`
+
+### A simple transform
+
+1. Press: <kbd>2</kbd>
+2. Check: `2:simple_transform:OK`
+
+### Marker transform
+
+1. Press: <kbd>3</kbd>
+2. Check: `3:simple_marker:OK`
+
+### Simple reorder
+
+1. Press: <kbd>4</kbd>
+2. Check: `4:simple_reorder:OK`
+
+### Variable substitution
+
+1. Press: <kbd>5</kbd>
+2. Check: `5:simple_vars:OK`
+
+### Mapped variable substitution
+
+1. Press: <kbd>6</kbd>
+2. Check: `6:map_var:OK`
+
+### Uset subtitution
+
+1. Press: <kbd>7</kbd>
+2. Check: `7:simple_uset:OK`
+
+### Context
+
+1. Type or paste in: `ABC` and position the cursor after that text
+2. Type: <kbd>8</kbd>
+3. Check: `8:ctxt:OK`
+
+### Non-BMP Context
+
+1. Paste in: `𐓏` and position the cursor after that text
+2. Type: <kbd>8</kbd>
+3. Check: `8:ctxt:OK`
+
+### Two-part Non-BMP Context
+
+1. Paste in: `𐒻` and position the cursor after that text
+2. Type: <kbd>Shift</kbd><kbd>8</kbd>
+3. Type: <kbd>8</kbd>
+4. Check: `8:ctxt:OK`
+
+### Two-part Marker Test
+
+1. Type: <kbd>9</kbd> (you will see FAIL temporarily, but continue to the next step)
+2. Type: <kbd>Shift</kbd><kbd>9</kbd>
+3. Check: `9:split_marker:OK`
+
+
+Links
+-----
+Keyboard Homepage: https://keyman.com/keyboards/ldml_test
+
+Copyright
+---------
+See [LICENSE.md](LICENSE.md)
+
+Supported Platforms
+-------------------
+ * Windows
+ * macOS
+ * Linux
+ * Web
+ * iPhone
+ * iPad
+ * Android phone
+ * Android tablet
+ * Mobile devices
+ * Desktop devices
+ * Tablet devices
+
diff --git a/experimental/sil/ldml_test/ldml_test.kpj b/experimental/sil/ldml_test/ldml_test.kpj
new file mode 100644
index 0000000000..7ed1ac72df
--- /dev/null
+++ b/experimental/sil/ldml_test/ldml_test.kpj
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<KeymanDeveloperProject>
+  <Options>
+    <Version>2.0</Version>
+    <CompilerWarningsAsErrors>True</CompilerWarningsAsErrors>
+    <CheckFilenameConventions>True</CheckFilenameConventions>
+  </Options>
+</KeymanDeveloperProject>
diff --git a/experimental/sil/ldml_test/source/ldml_test-test.xml b/experimental/sil/ldml_test/source/ldml_test-test.xml
new file mode 100644
index 0000000000..2c08741232
--- /dev/null
+++ b/experimental/sil/ldml_test/source/ldml_test-test.xml
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE keyboardTest3 SYSTEM "../../../../../resources/standards-data/ldml-keyboards/45/dtd/ldmlKeyboardTest3.dtd">
+<keyboardTest3 conformsTo="techpreview">
+  <info keyboard="ldml_test.xml" author="srl295" name="test" />
+
+  <tests name="separate">
+    <!-- test direct key output
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#element-key -->
+    <test name="key-1">
+      <keystroke key="1" />
+      <check result="1:basic:OK" />
+    </test>
+    <!-- test a simple transform
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#element-transform -->
+    <test name="key-2">
+      <keystroke key="2" />
+      <check result="2:simple_transform:OK" />
+    </test>
+    <!-- test a transform using a marker
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#markers -->
+    <test name="key-3">
+      <keystroke key="3" />
+      <check result="3:simple_marker:OK" />
+    </test>
+    <!-- test a reorder
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#element-reorder -->
+    <test name="key-4">
+      <keystroke key="4" />
+      <check result="4:simple_reorder:OK" />
+    </test>
+    <!-- test using variable substitution
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#element-string -->
+    <test name="key-5">
+      <keystroke key="5" />
+      <check result="5:simple_vars:OK" />
+    </test>
+    <!-- test a mapped variable substitution
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#replacement-syntax -->
+    <test name="key-6">
+      <keystroke key="6" />
+      <check result="6:map_var:OK" />
+    </test>
+    <!-- test a uset substitution
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#element-unicodeset -->
+    <test name="key-7">
+      <keystroke key="7" />
+      <check result="7:simple_uset:OK" />
+    </test>
+    <!-- test a different uset substitution
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#element-unicodeset -->
+    <test name="key-shift-7">
+      <keystroke key="shift-7" />
+      <check result="7:simple_uset:FAIL" />
+    </test>
+    <!-- test pre-existing input context
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#test-element-startcontext -->
+    <test name="key-8">
+      <startContext to="ABC" />
+      <keystroke key="8" />
+      <check result="8:ctxt:OK" />
+    </test>
+    <!-- test that the input context is required
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#test-element-startcontext -->
+    <test name="key-8-fail">
+      <startContext to="" /> <!-- w/o context -->
+      <keystroke key="8" />
+      <check result="8:ctxt:FAIL"/>
+    </test>
+    <!-- test context with a non-BMP character
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#test-element-startcontext -->
+    <test name="key-8-osage">
+      <startContext to="𐓏" />
+      <keystroke key="8" />
+      <check result="8:ctxt:OK" />
+    </test>
+    <!-- test using two pieces of context together with non-BMP chars
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#test-element-startcontext -->
+    <test name="key-8-osage2">
+      <startContext to="𐒻" />
+      <keystroke key="shift-8" />
+      <keystroke key="8" />
+      <check result="8:ctxt:OK" />
+    </test>
+    <!-- test using two markers across two keystrokes
+    https://www.unicode.org/reports/tr35/tr35-keyboards.html#markers -->
+    <test name="key-9">
+      <startContext to="" />
+      <keystroke key="9" />
+      <keystroke key="shift-9" />
+      <check result="9:split_marker:OK" />
+    </test>
+  </tests>
+</keyboardTest3>
diff --git a/experimental/sil/ldml_test/source/ldml_test.kps b/experimental/sil/ldml_test/source/ldml_test.kps
new file mode 100644
index 0000000000..8ea3cc4bb0
--- /dev/null
+++ b/experimental/sil/ldml_test/source/ldml_test.kps
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Package>
+  <System>
+    <KeymanDeveloperVersion>17.0.267.0</KeymanDeveloperVersion>
+    <FileVersion>7.0</FileVersion>
+  </System>
+  <Options>
+    <ExecuteProgram></ExecuteProgram>
+    <ReadMeFile>readme.htm</ReadMeFile>
+    <LicenseFile>..\LICENSE.md</LicenseFile>
+    <MSIFileName></MSIFileName>
+    <MSIOptions></MSIOptions>
+    <FollowKeyboardVersion/>
+  </Options>
+  <StartMenu>
+    <Folder></Folder>
+    <Items/>
+  </StartMenu>
+  <Info>
+    <Name URL="">LDML Test</Name>
+    <Copyright URL="">Copyright © Steven R. Loomis</Copyright>
+    <Author URL="">Steven R. Loomis</Author>
+    <Description URL="">Test Keyboard</Description>
+    <Version URL=""></Version>
+  </Info>
+  <Files>
+    <File>
+      <Name>..\build\ldml_test.kmx</Name>
+      <Description></Description>
+      <CopyLocation>0</CopyLocation>
+      <FileType>.kmx</FileType>
+    </File>
+    <File>
+      <Name>..\build\ldml_test.kvk</Name>
+      <Description></Description>
+      <CopyLocation>0</CopyLocation>
+      <FileType>.kvk</FileType>
+    </File>
+    <File>
+      <Name>welcome.htm</Name>
+      <Description></Description>
+      <CopyLocation>0</CopyLocation>
+      <FileType>.htm</FileType>
+    </File>
+    <File>
+      <Name>readme.htm</Name>
+      <Description></Description>
+      <CopyLocation>0</CopyLocation>
+      <FileType>.htm</FileType>
+    </File>
+    <File>
+      <Name>..\LICENSE.md</Name>
+      <Description></Description>
+      <CopyLocation>0</CopyLocation>
+      <FileType>.md</FileType>
+    </File>
+  </Files>
+  <Keyboards>
+    <Keyboard>
+      <Name>LDML Test</Name>
+      <ID>ldml_test</ID>
+      <Version>1.0.0</Version>
+      <Languages>
+        <Language ID="en">English</Language>
+      </Languages>
+      <Examples/>
+    </Keyboard>
+  </Keyboards>
+  <RelatedPackages/>
+  <Strings/>
+</Package>
diff --git a/experimental/sil/ldml_test/source/ldml_test.xml b/experimental/sil/ldml_test/source/ldml_test.xml
new file mode 100644
index 0000000000..2e93fe7f99
--- /dev/null
+++ b/experimental/sil/ldml_test/source/ldml_test.xml
@@ -0,0 +1,129 @@
+<?xml version="1.0"?>
+<keyboard3 locale="en" conformsTo="45">
+  <info author="Steven R. Loomis" name="LDML Test"/>
+  <version number="1.0.0"/>
+  <keys>
+    <!-- keep the base items -->
+    <import base="cldr" path="45/keys-Zyyy-punctuation.xml"/>
+    <import base="cldr" path="45/keys-Zyyy-currency.xml"/>
+    <!-- redefine the number keys -->
+    <key id="1" output="1:basic:OK" />
+    <key id="2" output="2:simple_transform:FAIL" />
+    <key id="3" output="3:simple_marker:FAIL\m{marker}" />
+    <key id="4" output="4:simple_reorder:UNTIED" />
+    <key id="5" output="5:simple_vars:${varsok}"/>
+    <key id="6" output="6:map_var:B\m{map1}X\m{map2}"/>
+    <key id="7" output="7:simple_uset:FAIL\m{uset7}" /> <!-- will produce OK-->
+    <key id="shift-7" output="7:simple_uset:OK\m{uset7}" /> <!-- will produce FAIL-->
+    <key id="8" output="\m{8ctxt}8:ctxt:FAIL" />
+    <key id="shift-8" output="𐒷" />
+    <key id="9" output="9:split_marker:FAIL\m{marker1}" />
+    <key id="shift-9" output="\m{marker2}" />
+  </keys>
+
+  <layers formId="us">
+    <layer modifiers="none">
+      <row keys="grave 1 2 3 4 5 6 7 8 9 0 hyphen equal"/>
+      <row keys="q w e r t y u i o p open-square close-square backslash"/>
+      <row keys="a s d f g h j k l semi-colon apos"/>
+      <row keys="z x c v b n m comma period slash"/>
+      <row keys="space"/>
+    </layer>
+    <layer modifiers="shift">
+      <row keys="tilde bang at hash dollar percent caret shift-7 shift-8 shift-9 close-paren underscore plus"/>
+      <row keys="Q W E R T Y U I O P open-curly close-curly pipe"/>
+      <row keys="A S D F G H J K L colon double-quote"/>
+      <row keys="Z X C V B N M open-angle close-angle question"/>
+      <row keys="space"/>
+    </layer>
+    <layer modifiers="caps">
+      <row keys="grave 1 2 3 4 5 6 7 8 9 0 hyphen equal"/>
+      <row keys="Q W E R T Y U I O P open-square close-square backslash"/>
+      <row keys="A S D F G H J K L semi-colon apos"/>
+      <row keys="Z X C V B N M comma period slash"/>
+      <row keys="space"/>
+    </layer>
+    <layer modifiers="shift caps">
+      <row keys="tilde bang at hash dollar percent caret amp asterisk open-paren close-paren underscore plus"/>
+      <row keys="q w e r t y u i o p open-curly close-curly pipe"/>
+      <row keys="a s d f g h j k l colon double-quote"/>
+      <row keys="z x c v b n m open-angle close-angle question"/>
+      <row keys="space"/>
+    </layer>
+  </layers>
+
+  <variables>
+    <string id="varsok" value="OK"/>
+    <!-- 6: first 13 chars and second 13 chars of alphabet -->
+    <set id="alpha1" value="A B C D E F G H I J K L M"/>
+    <set id="alpha2" value="N O P Q R S T U V W X Y Z"/>
+    <!-- 6: regular and rot13 alphabet -->
+    <set id="alpha" value="$[alpha1] $[alpha2]"/>
+    <set id="nycun" value="$[alpha2] $[alpha1]"/> <!-- 'nycun' in rot13 -->
+    <!-- 7: uset -->
+    <uset id="7ok" value="[[A_LIFE]-[E]]" /> <!-- = the chars [FAIL]-->
+    <uset id="7notok" value="[[A-Z]-$[7ok]]"/> <!-- everything not in [FAIL]-->
+  </variables>
+
+  <transforms type="simple">
+    <transformGroup>
+      <!--
+        from to char
+        -    -   -
+        1    1   U
+        2    2   N
+        3    4   T
+        4    3   I
+        5    5   E
+        6    6   D
+      -->
+      <reorder from="U" order="0" />
+      <reorder from="N" order="1" />
+      <reorder from="I" order="2" /> <!-- the 'T' and 'I' will swap places-->
+      <reorder from="T" order="3" />
+      <reorder from="E" order="4" />
+      <reorder from="D" order="5" />
+    </transformGroup>
+    <!-- 6: rot-13 the last char -->
+    <transformGroup>
+        <transform from="($[alpha])\m{map2}" to="$[1:nycun]"/>
+    </transformGroup>
+    <!-- 6: restore the trailing map2 -->
+    <transformGroup>
+        <transform from="\m{map1}($[alpha])" to="\m{map1}$1\m{map2}"/>
+    </transformGroup>
+    <!-- 6: swap chars -->
+    <transformGroup>
+        <transform from="($[alpha])\m{map1}($[alpha])\m{map2}" to="$2\m{map2}$1\m{map1}" />
+    </transformGroup>
+    <!-- 6: rot-13 the last char -->
+    <transformGroup>
+        <transform from="($[alpha])\m{map1}" to="$[1:nycun]"/>
+    </transformGroup>
+    <!-- 6: restore the trailing map1 -->
+    <transformGroup>
+        <transform from="\m{map2}($[alpha])" to="\m{map2}$1\m{map1}"/>
+    </transformGroup>
+    <!-- 6: swap back -->
+    <transformGroup>
+        <transform from="($[alpha])\m{map2}($[alpha])\m{map1}" to="$2\m{map1}$1\m{map2}" />
+        <transform from=":(?:$[7notok]){1,9}\m{uset7}" to=":FAIL" />
+        <transform from=":(?:$[7ok]){1,9}\m{uset7}" to=":OK" />
+    </transformGroup>
+    <transformGroup>
+      <transform from="simple_transform:FAIL" to="simple_transform:OK" />
+      <!-- 3: interpret marker results -->
+      <transform from="FAIL\m{marker}" to="OK" />
+      <transform from="FAIL\m{marker1}\m{marker2}" to="OK" />
+      <!-- 4: interpret reorder results -->
+      <transform from="UNITED" to="OK" />
+      <transform from="UNTIED" to="FAIL" />
+      <!-- 6: if untransformed, BX is a failure. -->
+      <transform from=":B\m{.}X\m{.}" to=":FAIL"/>
+      <transform from="ABC\m{8ctxt}(8:ctxt):FAIL" to="$1:OK" />
+      <transform from="𐓏\m{8ctxt}(8:ctxt):FAIL" to="$1:OK" />
+      <transform from="𐒻𐒷\m{8ctxt}(8:ctxt):FAIL" to="$1:OK" />
+    </transformGroup>
+  </transforms>
+
+</keyboard3>
diff --git a/experimental/sil/ldml_test/source/readme.htm b/experimental/sil/ldml_test/source/readme.htm
new file mode 100644
index 0000000000..193e77c91d
--- /dev/null
+++ b/experimental/sil/ldml_test/source/readme.htm
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>LDML Test</title>
+  <style type="text/css">
+    p { font: 10pt Tahoma; }
+    h1 { font: bold 16pt Tahoma; color: #4444cc; margin-bottom: 2px }
+    h2 { font: bold 12pt Tahoma; color: #4444cc; }
+  </style>
+</head>
+<body>
+
+<h1>LDML Test</h1>
+
+<p>
+  Test Keyboard
+</p>
+
+<p>Copyright © Steven R. Loomis</p>
+
+</body>
+</html>
diff --git a/experimental/sil/ldml_test/source/welcome.htm b/experimental/sil/ldml_test/source/welcome.htm
new file mode 100644
index 0000000000..2e0ad032e8
--- /dev/null
+++ b/experimental/sil/ldml_test/source/welcome.htm
@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Start Using LDML Test</title>
+  <style type="text/css">
+    p { font: 10pt Tahoma; }
+    h1 { font: bold 16pt Tahoma; color: #4444cc; margin-bottom: 2px }
+    h2 { font: bold 12pt Tahoma; color: #4444cc; }
+  </style>
+</head>
+<body>
+
+<h1>Start Using LDML Test</h1>
+
+<p>
+  Test Keyboard
+</p>
+
+<h1>Keyboard Layout</h1>
+
+<!-- Insert Keyboard Layout Images or HTML here -->
+
+</body>
+</html>
\ No newline at end of file