Merge branch 'master' into feat/core/9119-marker-core-epic-ldml

Author: srl295

common/schemas/keyman-touch-layout/README.md

@@ -399,6 +399,17 @@ and `width`.
 : Number. Defines the width of the key. Not currently supported for longpress
   keys. See `key` object for details.
 
+* `default`
+
+: Boolean. Defaults to `false`. If true, this will be the default key when the
+  user longpresses the base key without moving their finger. Only one subkey
+  should be default; if multiple subkeys have the default field set, then
+  behaviour is undefined.  Given that cancel is not the preferred default
+  action for a longpress, the user can cancel the longpress default by 
+  sliding outside the 'acceptance' area -- e.g. south of the key cap, 
+  which would then unhighlight the default and indicate visually that 
+  no output would occur when they release their finger.
+
 ## `flick` object
 
 A object with a set of properties that define flick keys for given directions.
@@ -445,6 +456,9 @@ string") into the appropriate spec format.
 
 # .keyman-touch-layout version history
 
+## 2023-08-08 2.1 stable
+* Add support for default on longpress (sk) keys. Aligns with Keyman 17.0.
+
 ## 2022-06-30 2.0 stable
 * Add support for flick, multitap, hint, defaultHint. Aligns with Keyman 16.0.
 

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

@@ -131,7 +131,8 @@
         "width": { "$ref" : "#/definitions/numeric" },
         "fontsize": { "$ref": "#/definitions/fontsize-spec" },
         "font": { "$ref": "#/definitions/font-spec" },
-        "dk": { "type": "string" }
+        "dk": { "type": "string" },
+        "default": { "type": "boolean" }
       },
       "required": ["id"],
       "additionalProperties": false

common/web/types/src/keyman-touch-layout/keyman-touch-layout-file-writer.ts

@@ -77,6 +77,7 @@ export class TouchLayoutFileWriter {
       if(Object.hasOwn(key, 'text') && key.text === '') delete key.text;
       if(Object.hasOwn(key, 'id') && <string>key.id === '') delete key.id;
       if(Object.hasOwn(key, 'hint') && (<any>key).hint === '') delete (<any>key).hint;
+      if(Object.hasOwn(key, 'default') && (<any>key).default === false) delete (<any>key).default;
     };
 
     const fixupPlatform = (platform: TouchLayoutPlatform) => {

common/web/types/src/keyman-touch-layout/keyman-touch-layout-file.ts

@@ -73,6 +73,7 @@ export interface TouchLayoutSubKey {
   sp?: TouchLayoutKeySp;
   pad?: TouchLayoutKeyPad;
   width?: TouchLayoutKeyWidth;
+  default?: boolean;  // Only used for longpress currently
 };
 
 export interface TouchLayoutFlick {

common/web/types/src/util/compiler-interfaces.ts

@@ -6,6 +6,11 @@ export interface CompilerEvent {
   line?: number;
   code: number;
   message: string;
+  /**
+   * an internal error occurred that should be captured with a stack trace
+   * e.g. to the Keyman sentry instance by kmc
+   */
+  exceptionVar?: any;
 };
 
 export enum CompilerErrorSeverity {
@@ -399,7 +404,13 @@ export const defaultCompilerOptions: CompilerOptions = {
  * @param message
  * @returns
  */
-export const CompilerMessageSpec = (code: number, message: string) : CompilerEvent => { return { code, message } };
+export const CompilerMessageSpec = (code: number, message: string, exceptionVar?: any) : CompilerEvent => ({
+  code,
+  message: exceptionVar
+    ? (message ?? `Unexpected exception`) + `: ${exceptionVar.toString()}\n\nCall stack:\n${(exceptionVar instanceof Error ? exceptionVar.stack : (new Error()).stack)}` :
+    message,
+  exceptionVar
+});
 
 /**
  * @deprecated use `CompilerError.exceptionToString` instead

core/src/km_kbp_processevent_api.cpp

@@ -28,7 +28,7 @@ km_kbp_event(
   switch(event) {
     case KM_KBP_EVENT_KEYBOARD_ACTIVATED:
       assert(data == nullptr);
-      if(data == nullptr) {
+      if(data != nullptr) {
         return KM_KBP_STATUS_INVALID_ARGUMENT;
       }
       break;

core/src/kmx/kmx_processevent.h

@@ -86,7 +86,6 @@ class KMX_ProcessEvent {
   /* Caps Lock and modifier management */
 
   KMX_BOOL IsCapsLockOn(KMX_DWORD modifiers);
-  void SetCapsLock(KMX_DWORD &modifiers, KMX_BOOL capsLockOn, KMX_BOOL force = FALSE);
   void ResetCapsLock(KMX_DWORD &modifiers, KMX_BOOL isKeyDown);
   KMX_BOOL KeyCapsLockPress(KMX_DWORD &modifiers, KMX_BOOL isKeyDown);
   void KeyShiftPress(KMX_DWORD &modifiers, KMX_BOOL isKeyDown);
@@ -107,6 +106,7 @@ class KMX_ProcessEvent {
   KMX_Environment *GetEnvironment();
   KMX_Environment const *GetEnvironment() const;
   INTKEYBOARDINFO const *GetKeyboard() const;
+  void SetCapsLock(KMX_DWORD &modifiers, KMX_BOOL capsLockOn, KMX_BOOL force = FALSE);
 
   // Utility function
 public:

core/src/kmx/kmx_processor.cpp

@@ -103,6 +103,30 @@ kmx_processor::update_option(
   return option(scope, key, value);
 }
 
+km_kbp_status
+kmx_processor::external_event(
+  km_kbp_state* state,
+  uint32_t event,
+  void* _kmn_unused(data)
+) {
+
+  switch (event) {
+    case KM_KBP_EVENT_KEYBOARD_ACTIVATED:
+      // reset any current actions in the queue as a new keyboard
+      // has been activated
+      _kmx.GetActions()->ResetQueue();
+      state->actions().clear();
+      if (_kmx.GetKeyboard()->Keyboard->dwFlags & KF_CAPSALWAYSOFF) {
+        KMX_DWORD dummy_modifiers = 0;
+        _kmx.SetCapsLock(dummy_modifiers, FALSE, TRUE);
+      }
+      break;
+    default:
+      return KM_KBP_STATUS_INVALID_ARGUMENT;
+  }
+  return internal_process_queued_actions(state);
+}
+
 bool
 kmx_processor::queue_action(
   km_kbp_state * state,

core/src/kmx/kmx_processor.hpp

@@ -59,7 +59,14 @@ namespace kbp
     km_kbp_status
     process_queued_actions(
       km_kbp_state *state
-      ) override;
+    ) override;
+
+    km_kbp_status
+    external_event(
+      km_kbp_state* state,
+      uint32_t event,
+      void* data
+    ) override;
 
     bool
     queue_action(

core/tests/unit/kmnkbd/action_items.hpp

@@ -23,6 +23,7 @@ const char *action_item_types[] = {
   "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_KBP_IT_CAPSLOCK",//     = 8, Enable or disable capsLock
 };
 
 void print_action_item(const char *title, km_kbp_action_item const & item) {
@@ -50,6 +51,13 @@ void print_action_item(const char *title, km_kbp_action_item const & item) {
       << "           value: " << item.option->value << std::endl
       << "           scope: " << item.option->scope << std::endl;
     break;
+  case KM_KBP_IT_CAPSLOCK:
+    std::cout << "  caps lock:  " <<
+      (item.capsLock == 0 ? "off" :
+      item.capsLock == 1 ? "on" :
+      "invalid value") << " (" <<
+      item.capsLock << ")" << std::endl;
+    break;
   }
 }
 
@@ -68,6 +76,7 @@ bool operator==(
                                                   lhs.backspace.expected_value == rhs.backspace.expected_value; break;
       case KM_KBP_IT_PERSIST_OPT:        result = *lhs.option == *rhs.option; break;
       case KM_KBP_IT_EMIT_KEYSTROKE:     break;
+      case KM_KBP_IT_CAPSLOCK:           result = lhs.capsLock == rhs.capsLock; break;
       case KM_KBP_IT_INVALIDATE_CONTEXT: break;
       default: std::cout << "unexpected type" << std::endl; return false; //
     }