spiegel-keyman/linux/ibus-keyman/src/engine.c

/* vim:set et sts=4: */

/*
 * Keyman Input Method for IBUS (The Input Bus)
 *
 * Copyright (C) 2009-2023 SIL Global
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 *
 */

#include <errno.h>
#include <ibus.h>
#include <string.h>
#include <stdio.h>

#include <gdk/gdk.h>
#include <gio/gio.h>

#include <keyman/keyman_core_api.h>
#include <keyman/keyman_core_api_consts.h>

#include "config.h"
#include "keymanutil.h"
#include "keyman-service.h"
#include "KeymanSystemServiceClient.h"
#include "engine.h"
#include "keycodes.h"

#define MAXCONTEXT_ITEMS 128

// Values from /usr/include/linux/input-event-codes.h
#define KEYMAN_BACKSPACE 14
#define KEYMAN_BACKSPACE_KEYSYM  IBUS_KEY_BackSpace
#define KEYMAN_LCTRL  29 // 0x1D
#define KEYMAN_LSHIFT 42 // 0x2A
#define KEYMAN_RSHIFT 54 // 0x36
#define KEYMAN_LALT   56 // 0x38
#define KEYMAN_RCTRL  97 // 0x61
#define KEYMAN_RALT  100 // 0x64

// TODO: Move to a common header file. Also defined in tests/testfixture.h
// and keyman-system-service/src/OrderedOutputDevice.cpp
#define KEYMAN_F24_KEYCODE_OUTPUT_SENTINEL 194  // 0xC2

typedef struct _IBusKeymanEngine IBusKeymanEngine;
typedef struct _IBusKeymanEngineClass IBusKeymanEngineClass;

#define MAX_QUEUE_SIZE 100

typedef struct _commit_queue_item {
  // char_buffer, emitting_keystroke and code_points_to_delete as well as
  // more than one queue item are only used if the client doesn't
  // support surrounding text (non-compliant app)
  gchar *char_buffer;
  gboolean emitting_keystroke;
  guint code_points_to_delete;

  guint keyval;
  guint keycode;
  guint state;
} commit_queue_item;

struct _IBusKeymanEngine {
  IBusEngine parent;

  /* members */
  km_core_keyboard *keyboard;
  km_core_state    *state;
  gchar           *ldmlfile;
  gchar           *kb_name;
  gboolean         lctrl_pressed;
  gboolean         rctrl_pressed;
  gboolean         lalt_pressed;
  gboolean         ralt_pressed;
  IBusLookupTable *table;
  IBusProperty    *status_prop;
  IBusPropList    *prop_list;
  void            *settings;

  commit_queue_item commit_queue[MAX_QUEUE_SIZE];
  commit_queue_item *commit_item;
};

struct _IBusKeymanEngineClass {
  IBusEngineClass parent;
};

/* functions prototype */
static void ibus_keyman_engine_class_init (IBusKeymanEngineClass  *klass);
static void ibus_keyman_engine_init       (IBusKeymanEngine       *keyman);
static GObject* ibus_keyman_engine_constructor
                                          (GType                   type,
                                           guint                   n_construct_params,
                                           GObjectConstructParam  *construct_params);
static void ibus_keyman_engine_destroy    (IBusKeymanEngine       *keyman);
static gboolean ibus_keyman_engine_process_key_event
                                          (IBusEngine             *engine,
                                           guint                   keyval,
                                           guint                   keycode,
                                           guint                   state);
static void ibus_keyman_engine_focus_in   (IBusEngine             *engine);
static void ibus_keyman_engine_focus_out  (IBusEngine             *engine);
static void ibus_keyman_engine_reset      (IBusEngine             *engine);
static void ibus_keyman_engine_enable     (IBusEngine             *engine);
static void ibus_keyman_engine_disable    (IBusEngine             *engine);
static void ibus_keyman_engine_set_surrounding_text
                                          (IBusEngine             *engine,
                                           IBusText               *text,
                                           guint                   cursor_pos,
                                           guint                   anchor_pos);
// static void ibus_keyman_engine_set_cursor_location
//                                           (IBusEngine             *engine,
//                                            guint                   x,
//                                            guint                   y,
//                                            guint                   w,
//                                            guint                   h);
// static void ibus_keyman_engine_set_capabilities
//                                           (IBusEngine             *engine,
//                                            guint                   caps);
// static void ibus_keyman_engine_page_up    (IBusEngine             *engine);
// static void ibus_keyman_engine_page_down  (IBusEngine             *engine);
// static void ibus_keyman_engine_cursor_up  (IBusEngine             *engine);
// static void ibus_keyman_engine_cursor_down(IBusEngine             *engine);
// static void ibus_keyman_engine_property_activate
//                                           (IBusEngine             *engine,
//                                            const gchar            *prop_name,
//                                            guint                   prop_state);
// static void ibus_keyman_engine_property_show
//                                           (IBusEngine             *engine,
//                                            const gchar            *prop_name);
// static void ibus_keyman_engine_property_hide
//                                           (IBusEngine             *engine,
//                                            const gchar            *prop_name);

static void commit_string(IBusKeymanEngine *keyman, const gchar *string);

static IBusEngineClass *parent_class = NULL;

GType
ibus_keyman_engine_get_type (void)
{
  static GType type = 0;

  static const GTypeInfo type_info = {
    sizeof (IBusKeymanEngineClass),
    (GBaseInitFunc)  NULL,
    (GBaseFinalizeFunc) NULL,
    (GClassInitFunc) ibus_keyman_engine_class_init,
    NULL,
    NULL,
    sizeof (IBusKeymanEngine),
    0,
    (GInstanceInitFunc) ibus_keyman_engine_init,
  };

  if (type == 0) {
    type = g_type_register_static (IBUS_TYPE_ENGINE,
                     "IBusKeymanEngine",
                     &type_info,
                     (GTypeFlags) 0);
  }

  return type;
}

static void
ibus_keyman_engine_class_init (IBusKeymanEngineClass *klass)
{
    GObjectClass *object_class = G_OBJECT_CLASS (klass);
    IBusObjectClass *ibus_object_class = IBUS_OBJECT_CLASS (klass);
    IBusEngineClass *engine_class = IBUS_ENGINE_CLASS (klass);

    parent_class = (IBusEngineClass *) g_type_class_peek_parent (klass);

    object_class->constructor = ibus_keyman_engine_constructor;
    ibus_object_class->destroy = (IBusObjectDestroyFunc) ibus_keyman_engine_destroy;

    engine_class->process_key_event = ibus_keyman_engine_process_key_event;

    engine_class->reset = ibus_keyman_engine_reset;
    engine_class->enable = ibus_keyman_engine_enable;
    engine_class->disable = ibus_keyman_engine_disable;

    engine_class->set_surrounding_text = ibus_keyman_engine_set_surrounding_text;
    // engine_class->set_cursor_location = ibus_keyman_engine_set_cursor_location;


    engine_class->focus_in = ibus_keyman_engine_focus_in;
    engine_class->focus_out = ibus_keyman_engine_focus_out;

    // engine_class->page_up = ibus_keyman_engine_page_up;
    // engine_class->page_down = ibus_keyman_engine_page_down;

    // engine_class->cursor_up = ibus_keyman_engine_cursor_up;
    // engine_class->cursor_down = ibus_keyman_engine_cursor_down;

    // engine_class->property_activate = ibus_keyman_engine_property_activate;
}

static gchar *
get_context_debug(IBusEngine *engine) {
  IBusKeymanEngine *keyman       = (IBusKeymanEngine *)engine;

  km_core_cu *buf = km_core_state_context_debug(keyman->state, KM_CORE_DEBUG_CONTEXT_CACHED);
  gchar *result = g_utf16_to_utf8((gunichar2 *)buf, -1, NULL, NULL, NULL);
  km_core_cu_dispose(buf);
  if(result) {
    return result;
  }

  GString *output = g_string_new("Error converting debug context");
#if GLIB_CHECK_VERSION(2, 76, 0)
  return g_string_free_and_steal(output);
#else
  return g_string_free(output, FALSE);
#endif
}

static gchar *
debug_utf8_with_codepoints(const gchar *utf8) {
  GString *output = g_string_new("");
  g_string_append_printf(output, "|%s| (len:%ld) [", utf8, g_utf8_strlen(utf8, -1));
  gunichar2 *utf16 = g_utf8_to_utf16(utf8, -1, NULL, NULL, NULL);
  for (int i = 0; utf16[i] != '\0'; i++) {
    g_string_append_printf(output, "U+%04x ", utf16[i]);
  }
  g_string_append(output, "]");
  g_free(utf16);
#if GLIB_CHECK_VERSION(2, 76, 0)
  return g_string_free_and_steal(output);
#else
  return g_string_free(output, FALSE);
#endif
}

static gboolean
client_supports_surrounding_text(IBusEngine *engine) {
  g_assert(engine != NULL);
  return (engine->client_capabilities & IBUS_CAP_SURROUNDING_TEXT) != 0;
}

static void
set_context_if_needed(IBusEngine *engine) {
  IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;

  if (!client_supports_surrounding_text(engine)) {
    g_message("%s: not a compliant client app", __FUNCTION__);
    return;
  }

  IBusText *text;
  g_autofree gchar *application_context_utf8 = NULL;
  guint cursor_pos, anchor_pos, context_start, context_end;

  g_autofree gchar *debug_context = NULL;
  g_message("%s: current core context   : %s", __FUNCTION__, debug_context = get_context_debug(engine));

  ibus_engine_get_surrounding_text(engine, &text, &cursor_pos, &anchor_pos);

  context_end         = anchor_pos < cursor_pos ? anchor_pos : cursor_pos;
  context_start       = context_end > MAXCONTEXT_ITEMS ? context_end - MAXCONTEXT_ITEMS : 0;
  application_context_utf8 = g_utf8_substring(ibus_text_get_text(text), context_start, context_end);
  g_message("%s: new application context: |%s| (len:%u) cursor:%d anchor:%d", __FUNCTION__,
    application_context_utf8, context_end - context_start, cursor_pos, anchor_pos);

  km_core_cu *application_context_utf16 = g_utf8_to_utf16(application_context_utf8, -1, NULL, NULL, NULL);
  km_core_context_status result;
  result = km_core_state_context_set_if_needed(keyman->state, application_context_utf16);
  g_free(application_context_utf16);

  g_message("%s: context %s", __FUNCTION__,
    result == KM_CORE_CONTEXT_STATUS_UNCHANGED ? "unchanged"
    : result == KM_CORE_CONTEXT_STATUS_UPDATED ? "updated"
    : result == KM_CORE_CONTEXT_STATUS_CLEARED ? "cleared"
    : result == KM_CORE_CONTEXT_STATUS_ERROR   ? "error"
                                               : "invalid argument");
}

static void
initialize_queue_items(IBusKeymanEngine *keyman, int index, int count) {
  g_assert(keyman != NULL);
  g_assert(index >= 0 && index < MAX_QUEUE_SIZE);
  g_assert(count > 0 && count <= MAX_QUEUE_SIZE);
  g_assert(index + count <= MAX_QUEUE_SIZE);
  memset(&keyman->commit_queue[index], 0, sizeof(commit_queue_item) * count);
}

static void
ibus_keyman_engine_init(IBusKeymanEngine *keyman) {
  gdk_init(NULL, NULL);
  keyman->status_prop = ibus_property_new("status", PROP_TYPE_NORMAL, NULL, NULL, NULL, TRUE, FALSE, 0, NULL);
  g_object_ref_sink(keyman->status_prop);
  keyman->prop_list = ibus_prop_list_new();
  g_object_ref_sink(keyman->prop_list);
  ibus_prop_list_append(keyman->prop_list, keyman->status_prop);

  keyman->state = NULL;
  initialize_keyman_system_service_client();
}

static km_core_cu* get_base_layout()
{
  return u"en-US";

#if 0  // in the future when mnemonic layouts are to be supported
  const gchar *lang_env = g_getenv("LANG");
  gchar *lang;
  if (lang_env != NULL) {
    g_message("LANG=%s", lang_env);
    gchar **splitlang = g_strsplit(lang_env, ".", 2);
    g_message("before . is %s", splitlang[0]);
    if (g_strrstr(splitlang[0], "_")) {
      g_message("splitting %s", splitlang[0]);
      gchar **taglang = g_strsplit(splitlang[0], "_", 2);
      g_message("lang of tag is %s", taglang[0]);
      g_message("country of tag is %s", taglang[1]);
      lang = g_strjoin("-", taglang[0], taglang[1], NULL);
      g_strfreev(taglang);
    }
    else {
      lang = g_strdup(splitlang[0]);
    }
    g_strfreev(splitlang);
  }
  else {
    lang = strdup("en-US");
  }
  g_message("lang is %s", lang);
  km_core_cu *cp = g_utf8_to_utf16(lang, -1, NULL, NULL, NULL);
  return cp;
  // g_free(lang);
#endif
}

static km_core_status
setup_environment(IBusKeymanEngine *keyman)
{
  g_assert(keyman);
  g_message("%s: setting up environment", __FUNCTION__);

  // Allocate enough options for: 4 environments plus 1 pad struct of 0's
  km_core_option_item environment_opts[5] = {0};

  environment_opts[0].scope = KM_CORE_OPT_ENVIRONMENT;
  environment_opts[0].key   = KM_CORE_KMX_ENV_PLATFORM;
  environment_opts[0].value = u"linux desktop hardware native";

  environment_opts[1].scope = KM_CORE_OPT_ENVIRONMENT;
  environment_opts[1].key   = KM_CORE_KMX_ENV_BASELAYOUT;
  environment_opts[1].value = u"kbdus.dll";

  environment_opts[2].scope = KM_CORE_OPT_ENVIRONMENT;
  environment_opts[2].key   = KM_CORE_KMX_ENV_BASELAYOUTALT;
  environment_opts[2].value = get_base_layout();  // TODO: free when mnemonic layouts are to be supported

  environment_opts[3].scope = KM_CORE_OPT_ENVIRONMENT;
  environment_opts[3].key   = KM_CORE_KMX_ENV_SIMULATEALTGR;
  environment_opts[3].value = keyman_get_option_fromdconf(KEYMAN_DCONF_OPTIONS_SIMULATEALTGR) ? u"1" : u"0";

  km_core_status status = km_core_state_create(keyman->keyboard, environment_opts, &(keyman->state));
  if (status != KM_CORE_STATUS_OK) {
    g_warning("%s: problem creating km_core_state. Status is %u.", __FUNCTION__, status);
  }
  return status;
}

static void
on_dconf_settings_change(GSettings *settings, gchar *key, gpointer user_data) {
  if (!user_data || g_strcmp0(key, KEYMAN_DCONF_OPTIONS_SIMULATEALTGR) != 0) {
    // not the SimulateAltGr option...
    return;
  }
  IBusKeymanEngine *keyman = (IBusKeymanEngine *)user_data;
  km_core_state_dispose(keyman->state);
  setup_environment(keyman);
}

void
free_km_core_option_item(gpointer data) {
  if (!data)
    return;

  km_core_option_item *opt = (km_core_option_item *)data;
  g_free((km_core_cu *)opt->key);
  g_free((km_core_cu *)opt->value);
  g_free(opt);
}

static km_core_status
load_keyboard_options(IBusKeymanEngine *keyman) {
  g_assert(keyman);

  // Retrieve keyboard options from DConf
  // TODO: May need unique packageID and keyboard ID
  g_message("%s: Loading options for kb_name: %s", __FUNCTION__, keyman->kb_name);
  GQueue *queue_options = keyman_get_keyboard_options_queue_fromdconf(keyman->kb_name, keyman->kb_name);
  int num_options       = g_queue_get_length(queue_options);
  if (num_options < 1) {
    g_queue_free_full(queue_options, free_km_core_option_item);
    return KM_CORE_STATUS_OK;
  }

  // Allocate enough options for: num_options plus 1 pad struct of 0's
  km_core_option_item *keyboard_opts = g_new0(km_core_option_item, num_options + 1);

  for (int i = 0; i < num_options; i++) {
    km_core_option_item *item = g_queue_pop_head(queue_options);
    keyboard_opts[i].scope = item->scope;
    keyboard_opts[i].key   = item->key;
    keyboard_opts[i].value = item->value;
  }

  // once we have the option list we can then update the options using the public api call
  km_core_status status = km_core_state_options_update(keyman->state, keyboard_opts);

  if (status != KM_CORE_STATUS_OK) {
    g_warning("%s: problem creating km_core_state. Status is %u.", __FUNCTION__, status);
  }
  g_queue_free_full(queue_options, free_km_core_option_item);
  g_free(keyboard_opts);
  return status;
}

static GObject*
ibus_keyman_engine_constructor(
  GType type,
  guint n_construct_params,
  GObjectConstructParam *construct_params
) {
    IBusKeymanEngine *keyman;
    IBusEngine *engine;
    const gchar *engine_name;
    gchar *p;
    g_autofree gchar *abs_kmx_path = NULL;

    g_debug("DAR: %s", __FUNCTION__);

    keyman = (IBusKeymanEngine *) G_OBJECT_CLASS (parent_class)->constructor (type,
                                                       n_construct_params,
                                                       construct_params);

    engine = (IBusEngine *) keyman;
    engine_name = ibus_engine_get_name (engine);
    g_assert (engine_name);
    g_message("DAR: %s %s", __FUNCTION__, engine_name);

    keyman->kb_name = NULL;
    keyman->ldmlfile = NULL;
    keyman->lalt_pressed = FALSE;
    keyman->lctrl_pressed = FALSE;
    keyman->ralt_pressed = FALSE;
    keyman->rctrl_pressed = FALSE;
    initialize_queue_items(keyman, 0, MAX_QUEUE_SIZE);
    keyman->commit_item    = &keyman->commit_queue[0];
    gchar **split_name     = g_strsplit(engine_name, ":", 2);
    if (split_name[0] == NULL)
    {
        IBUS_OBJECT_CLASS (parent_class)->destroy ((IBusObject *)keyman);
        return NULL;
    }
    else if (split_name[1] == NULL)
    {
        abs_kmx_path = g_strdup(split_name[0]);
    }
    else
    {
        abs_kmx_path = g_strdup(split_name[1]);
    }

    g_strfreev(split_name);

    g_autofree gchar *kmx_filename = g_path_get_basename(abs_kmx_path);
    p = rindex(kmx_filename, '.'); // get id to use as dbus service name
    if (p) {
        keyman->kb_name = g_strndup(kmx_filename, p-kmx_filename);
        p = rindex(abs_kmx_path, '.');
        if (p)
        {
            g_autofree gchar *dir = g_path_get_dirname(abs_kmx_path);
            g_autofree gchar *ldmlfile = g_strdup_printf("%s/%s.ldml", dir, keyman->kb_name);
            if (g_file_test(ldmlfile, G_FILE_TEST_EXISTS))
            {
                keyman->ldmlfile = g_strdup(ldmlfile);
            }
        }
    }

    km_core_status status;

    FILE* kmx_file = fopen(abs_kmx_path, "rb");
    if (!kmx_file) {
      g_warning("%s: problem opening kmx_file %s. (error: %s).", __FUNCTION__, abs_kmx_path, strerror(errno));
      return NULL;
    }

    if (fseek(kmx_file, 0, SEEK_END) < 0) {
      g_warning("%s: problem seeking to end of kmx_file %s (error: %s).", __FUNCTION__, abs_kmx_path, strerror(errno));
      fclose(kmx_file);
      return NULL;
    }
    long length = ftell(kmx_file);
    if (length < 0) {
      g_warning("%s: problem determining length of kmx_file %s (error: %s).", __FUNCTION__, abs_kmx_path, strerror(errno));
      fclose(kmx_file);
      return NULL;
    }
    rewind(kmx_file);
    void* buffer = malloc(length);
    if (!buffer) {
      g_warning("%s: problem allocating buffer for reading kmx_file %s (error: %s).", __FUNCTION__, abs_kmx_path, strerror(errno));
      fclose(kmx_file);
      return NULL;
    }
    if (fread(buffer, 1, length, kmx_file) != length) {
      g_warning("%s: problem reading entire kmx_file %s (error: %s).", __FUNCTION__, abs_kmx_path, strerror(errno));
      fclose(kmx_file);
      free(buffer);
      return NULL;
    }
    fclose(kmx_file);

    status = km_core_keyboard_load_from_blob(abs_kmx_path, buffer, length,
      &(keyman->keyboard));

    free(buffer);

    if (status != KM_CORE_STATUS_OK) {
      g_warning("%s: problem loading km_core_keyboard %s. Status is %u.", __FUNCTION__, abs_kmx_path, status);
      ibus_keyman_engine_destroy(keyman);
      return NULL;
    }

    status = setup_environment(keyman);
    if (status != KM_CORE_STATUS_OK) {
      ibus_keyman_engine_destroy(keyman);
      return NULL;
    }

    keyman->settings = keyman_subscribe_option_changes(on_dconf_settings_change, keyman);

    status = load_keyboard_options(keyman);
    if (status != KM_CORE_STATUS_OK) {
      ibus_keyman_engine_destroy(keyman);
      return NULL;
    }

    ping_keyman_system_service();

    set_context_if_needed(engine);

    return (GObject *) keyman;
}


static void
ibus_keyman_engine_destroy (IBusKeymanEngine *keyman)
{
    const gchar *engine_name;

    g_debug("DAR: %s", __FUNCTION__);
    engine_name = ibus_engine_get_name ((IBusEngine *) keyman);
    g_assert (engine_name);
    g_message("DAR: %s %s", __FUNCTION__, engine_name);

    if (keyman->settings) {
      keyman_unsubscribe_option_changes(keyman->settings, on_dconf_settings_change, keyman);
      keyman->settings = NULL;
    }

    if (keyman->prop_list) {
        g_debug("DAR: %s: unref keyman->prop_list", __FUNCTION__);
        g_object_unref (keyman->prop_list);
        keyman->prop_list = NULL;
    }

    if (keyman->status_prop) {
        g_debug("DAR: %s: unref keyman->status_prop", __FUNCTION__);
        g_object_unref (keyman->status_prop);
        keyman->status_prop = NULL;
    }

    if (keyman->state) {
        km_core_state_dispose(keyman->state);
        keyman->state = NULL;
    }

    if (keyman->keyboard) {
        km_core_keyboard_dispose(keyman->keyboard);
        keyman->keyboard = NULL;
    }

    g_free(keyman->kb_name);
    g_free(keyman->ldmlfile);

    IBUS_OBJECT_CLASS (parent_class)->destroy ((IBusObject *)keyman);
}

/**
 * Set text on the client
 *
 * Called by the Keyman service from the handler of the `SendText` method.
 *
 * @param engine  A pointer to the IBusEngine instance
 * @param text    The text to be set on the client
 */
void ibus_keyman_set_text(IBusEngine *engine, const gchar *text)
{
    IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;
    if (!keyman) {
        g_error("%s: parameter `engine` is not an `IBusKeymanEngine` (%p)", __FUNCTION__, engine);
        return;
    }
    commit_string(keyman, text);
}

static void commit_string(IBusKeymanEngine *keyman, const gchar *string)
{
    IBusText *text;
    g_autofree gchar *debug = NULL;
    g_message("DAR: %s - %s", __FUNCTION__, debug = debug_utf8_with_codepoints(string));
    text = ibus_text_new_from_static_string (string);
    g_object_ref_sink(text);
    ibus_engine_commit_text ((IBusEngine *)keyman, text);
    g_object_unref (text);
}

//
static gboolean
is_core_options_end(km_core_option_item *option) {
  g_assert(option);
  return option->key == NULL && option->value == NULL && option->scope == 0;
}

static void
process_output_action(IBusEngine *engine, const km_core_usv* output_utf32) {
  if (output_utf32 == NULL || output_utf32[0] == '\0') {
    return;
  }

  IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;
  gchar *output_utf8 = g_ucs4_to_utf8(output_utf32, -1, NULL, NULL, NULL);
  g_autofree gchar *debug  = NULL;

  if (client_supports_surrounding_text(engine)) {
    // compliant app
    g_message("%s: compliant app: Outputing %s", __FUNCTION__, debug = debug_utf8_with_codepoints(output_utf8));
    commit_string(keyman, output_utf8);
    g_free(output_utf8);
  } else {
    // non-compliant app
    g_message("%s: non-compliant app: Adding to commit queue: %s", __FUNCTION__, debug = debug_utf8_with_codepoints(output_utf8));
    g_assert(keyman->commit_item->char_buffer == NULL);
    keyman->commit_item->char_buffer = output_utf8;
    // don't free output_utf8 - assigned to char_buffer!
  }
}

static void process_alert_action(km_core_bool alert) {
  if (!alert) {
    return;
  }
  GdkDisplay *display = gdk_display_open(NULL);
  if (display != NULL) {
    gdk_display_beep(display);
    gdk_display_close(display);
  }
}

static void
process_backspace_action(IBusEngine *engine, unsigned int code_points_to_delete) {
  if (code_points_to_delete < 1) {
    return;
  }

  if (client_supports_surrounding_text(engine)) {
    g_message("%s: compliant app: deleting surrounding text %d codepoints", __FUNCTION__, code_points_to_delete);
    ibus_engine_delete_surrounding_text(engine, -code_points_to_delete, code_points_to_delete);
  } else {
    g_message("%s: non-compliant app: queueing %d backspaces", __FUNCTION__, code_points_to_delete);
    IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;
    keyman->commit_item->code_points_to_delete = code_points_to_delete;
  }
}

static void
process_persist_action(IBusEngine *engine, km_core_option_item *persist_options) {
  g_assert(persist_options != NULL);

  IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;
  for (km_core_option_item *option = persist_options; !is_core_options_end(option); option++) {
    // Put the keyboard option into DConf
    g_assert(option->key != NULL && option->value != NULL);
    g_message("%s: Saving keyboard option to DConf", __FUNCTION__);
    // Load the current keyboard options from DConf
    keyman_put_keyboard_options_todconf(keyman->kb_name, keyman->kb_name, (gchar *)option->key, (gchar *)option->value);
  }
}

/**
 * Process the emit_keystroke action
 *
 * @param engine          A pointer to the IBusEngine instance.
 * @param emit_keystroke  A boolean indicating whether to emit a keystroke.
 *
 * @returns TRUE if Keyman handled the event, FALSE otherwise.
 */
static gboolean
process_emit_keystroke_action(IBusEngine *engine, km_core_bool emit_keystroke) {
  IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;
  if (client_supports_surrounding_text(engine)) {
    // compliant app
    return !emit_keystroke;
  }

  // non-compliant app
  keyman->commit_item->emitting_keystroke = emit_keystroke;
  return TRUE;
}

static void
process_capslock_action(km_core_caps_state caps_state) {
  if (caps_state == KM_CORE_CAPS_UNCHANGED) {
    return;
  }
  g_message("%s: %s caps-lock", __FUNCTION__, caps_state == KM_CORE_CAPS_ON ? "Enable" : "Disable");

  set_capslock_indicator(caps_state);
}

static void
commit_current_queue_item(IBusKeymanEngine *keyman) {
  // only called for non-compliant apps
  g_assert(keyman != NULL);
  IBusEngine* engine = (IBusEngine *)keyman;
  g_assert(!client_supports_surrounding_text(engine));

  if (keyman->commit_item <= keyman->commit_queue){
    g_message("%s: queue is empty", __FUNCTION__);
    return;
  }

  commit_queue_item *current_item = &keyman->commit_queue[0];
  if (current_item->code_points_to_delete > 0) {
    g_message("%s: Forwarding %d backspaces from commit queue", __FUNCTION__, current_item->code_points_to_delete);
    while (current_item->code_points_to_delete > 0) {
      ibus_engine_forward_key_event(engine, KEYMAN_BACKSPACE_KEYSYM, KEYMAN_BACKSPACE, 0);
      current_item->code_points_to_delete--;
    }
    // don't remove the item from the queue yet - we need to process it
    // again for the output and keystrokes. Instead emit the sentinel key
    // again.
    g_message("%s: Forcing ordered output", __FUNCTION__);
    call_ordered_output_sentinel();
    return;
  }
  if (current_item->char_buffer != NULL) {
    g_autofree gchar *debug = NULL;
    g_message("%s: Committing from commit queue: %s", __FUNCTION__,
      debug = debug_utf8_with_codepoints(current_item->char_buffer));
    commit_string(keyman, current_item->char_buffer);
    g_free(current_item->char_buffer);
    current_item->char_buffer = NULL;
  }
  if (current_item->emitting_keystroke) {
    g_message("%s: Forwarding key from commit queue: keyval=0x%02x, keycode=0x%02x, state=0x%02x",
      __FUNCTION__, current_item->keyval, current_item->keycode, current_item->state);
    ibus_engine_forward_key_event(engine, current_item->keyval, current_item->keycode, current_item->state);
  }
  keyman->commit_item--;
  memmove(keyman->commit_queue, &keyman->commit_queue[1], sizeof(commit_queue_item) * MAX_QUEUE_SIZE - 1);
  initialize_queue_items(keyman, MAX_QUEUE_SIZE - 1, 1);
}

static void
finish_process_actions(IBusEngine *engine) {
  g_assert(engine != NULL);
  IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;
  if (client_supports_surrounding_text(engine)) {
    // compliant app
    return;
  }

  // non-compliant app
  guint keycode = keyman->commit_item->keycode;

  switch (keycode) {
    case KEYMAN_LSHIFT:
    case KEYMAN_RSHIFT:
    case KEYMAN_LCTRL:
    case KEYMAN_RCTRL:
    case KEYMAN_LALT:
    case KEYMAN_RALT:
      // we don't forward modifier keys that the user holds while pressing another
      // key.
      g_message("%s: Ignoring modifier key", __FUNCTION__);
      break;
    default:
      keyman->commit_item++;
      if (keyman->commit_item > &keyman->commit_queue[MAX_QUEUE_SIZE - 1]) {
        g_error("Overflow of keyman commit_queue!");
        // TODO: log to Sentry
        keyman->commit_item--;
      }

      // Forward a fake key event to get the correct order of events so that any backspace key we
      // generated will be processed before the character we're adding. We need to send a
      // valid keycode so that it doesn't get swallowed by GTK but which isn't very likely used
      // in real keyboards. F24 seems to work for that.
      g_message("%s: Forcing ordered output", __FUNCTION__);
      call_ordered_output_sentinel();
      break;
  }
}

/**
 * Process the actions from Keyman Core
 *
 * @param engine   A pointer to the IBusEngine instance.
 * @param actions  A pointer to the km_core_actions structure containing the actions to process.
 *
 * @returns TRUE if Keyman handled the event, FALSE otherwise.
 */
static gboolean
process_actions(
  IBusEngine *engine,
  km_core_actions const *actions
) {
  process_backspace_action(engine, actions->code_points_to_delete);
  process_output_action(engine, actions->output);
  process_persist_action(engine, actions->persist_options);
  process_alert_action(actions->do_alert);
  gboolean result = process_emit_keystroke_action(engine, actions->emit_keystroke);
  process_capslock_action(actions->new_caps_lock_state);
  finish_process_actions(engine);
  return result;
}

/**
 * Handler for the IBus `process-key-event` signal
 *
 * Called by IBus when the user presses a key. Called twice for each
 * keypress: once when the key is pressed down and once when it is
 * released.
 *
 * @param engine   A pointer to the IBusEngine instance
 * @param keyval   The key value of the keypress
 * @param keycode  The key code of the keypress
 * @param state    Modifier flags
 *
 * @return TRUE if we processed the key event, i.e. if there were
 * matching rules in the keyboard. No further processing of this key event
 * will be done. Otherwise FALSE, allowing other interested parties to
 * respond to the key event.
 */
static gboolean
ibus_keyman_engine_process_key_event(
  IBusEngine *engine,
  guint keyval,
  guint keycode,
  guint state
) {
  IBusKeymanEngine *keyman = (IBusKeymanEngine *)engine;
  keyman->commit_item->keyval     = keyval;
  keyman->commit_item->keycode    = keycode;
  keyman->commit_item->state      = state;

  gboolean isKeyDown = !(state & IBUS_RELEASE_MASK);

  g_message("-----------------------------------------------------------------------------------------------------------------");
  g_message(
      "DAR: %s - keyval=0x%02x keycode=0x%02x, state=0x%02x, isKeyDown=%d, compliant=%d", __FUNCTION__, keyval, keycode,
      state, isKeyDown, client_supports_surrounding_text(engine));

  // This keycode is a fake keycode that we send when it's time to commit the text, ensuring the
  // correct output order of backspace and text.
  if (!client_supports_surrounding_text(engine) && keycode == KEYMAN_F24_KEYCODE_OUTPUT_SENTINEL) {
    // non-compliant app
    if (!isKeyDown) {
      g_message("%s: got F24 Sentinel, ignore keyup", __FUNCTION__);
      return TRUE;
    }
    g_message("%s: got F24 Sentinel, queue content:", __FUNCTION__);
    for (int i = 0; i < MAX_QUEUE_SIZE && &keyman->commit_queue[i] != keyman->commit_item; i++) {
      commit_queue_item *item = &keyman->commit_queue[i];
      g_message(
          "    queue item %d:  keyval=0x%02x keycode=0x%02x, state=0x%02x, char_buffer=%s, "
          "emitting_keystroke=%d, code_points_to_delete=%d",
          i, item->keyval, item->keycode, item->state, item->char_buffer,
          item->emitting_keystroke, item->code_points_to_delete);
    }
    commit_current_queue_item(keyman);
    return TRUE;
  }

  // Depending on the OS/base keyboard layout we might get the same modifier
  // key whether the user pressed right or left Alt or Ctrl key. We work
  // around that by setting the `l/r*_pressed` flag when the actual modifier
  // key is pressed so that when we get the actual key with the modifier
  // flag set we know which Ctrl/Alt key is still pressed.
  switch (keycode) {
  case KEYMAN_LCTRL:
    keyman->lctrl_pressed = isKeyDown;
    break;
  case KEYMAN_RCTRL:
    keyman->rctrl_pressed = isKeyDown;
    break;
  case KEYMAN_LALT:
    keyman->lalt_pressed = isKeyDown;
    break;
  case KEYMAN_RALT:
    keyman->ralt_pressed = isKeyDown;
    break;
  }

  if (keycode < 0 || keycode > 255) {
    g_warning("%s: keycode %d out of range", __FUNCTION__, keycode);
    return FALSE;
  }

  if (keycode_to_vk[keycode] == 0) {  // key we don't handle
    return FALSE;
  }

  // #10476: Core currently doesn't handle IBUS_MOD{2-4}_MASK modifiers.
  // On Ubuntu 23.10/24.04 we get IBUS_MOD4_MASK set on keycode 0x39 (space) when
  // the user tries to switch keyboards. Since this is not a regular keypress
  // and Core doesn't handle it, we need to just return and let GTK deal
  // with it. We could consider to add it to Core and let Core ignore it.
  // As for IBUS_MOD3_MASK it's unclear when/how that gets set, so we
  // just not deal with that for now until we notice problems.
  if (state & IBUS_MOD4_MASK) {  // Super/Meta/Windows key depressed
    g_message("%s: Not handling keys with IBUS_MOD4_MASK (Super) modifier", __FUNCTION__);
    return FALSE;
  }

  // REVIEW: Do we need to do something about IBUS_MOD2_MASK (NumLock)? I guess
  // if a keyboard would have rules for the numeric keypad we might need
  // it. At the moment however we let Core process the keypress and since
  // it doesn't have rules for the numeric keypad keys we eventually
  // forward the key to ibus (in process_emit_keystroke_action) and let
  // GTK deal with it.

  // keyman modifiers are different from X11/ibus
  uint16_t km_mod_state = 0;
  if (state & IBUS_SHIFT_MASK) {  // Shift key depressed
    km_mod_state |= KM_CORE_MODIFIER_SHIFT;
  }
  if (state & IBUS_MOD5_MASK) {  // Right Alt key depressed
    km_mod_state |= KM_CORE_MODIFIER_RALT;
    g_message("%s: modstate KM_CORE_MODIFIER_RALT from IBUS_MOD5_MASK", __FUNCTION__);
  }
  if (state & IBUS_MOD1_MASK) {  // Alt key depressed
    if (keyman->ralt_pressed) {
      km_mod_state |= KM_CORE_MODIFIER_RALT;
      g_message("%s: modstate KM_CORE_MODIFIER_RALT from ralt_pressed", __FUNCTION__);
    }
    if (keyman->lalt_pressed) {
      km_mod_state |= KM_CORE_MODIFIER_LALT;
      g_message("%s: modstate KM_CORE_MODIFIER_LALT from lalt_pressed", __FUNCTION__);
    }
  }
  if (state & IBUS_CONTROL_MASK) {  // Ctrl key depressed
    if (keyman->rctrl_pressed) {
      km_mod_state |= KM_CORE_MODIFIER_RCTRL;
      g_message("%s: modstate KM_CORE_MODIFIER_RCTRL from rctrl_pressed", __FUNCTION__);
    }
    if (keyman->lctrl_pressed) {
      km_mod_state |= KM_CORE_MODIFIER_LCTRL;
      g_message("%s: modstate KM_CORE_MODIFIER_LCTRL from lctrl_pressed", __FUNCTION__);
    }
  }
  if (state & IBUS_LOCK_MASK) {  // Caps lock active
    km_mod_state |= KM_CORE_MODIFIER_CAPS;
  }
  g_message("DAR: %s - km_mod_state=0x%x", __FUNCTION__, km_mod_state);
  g_autofree gchar *debug_context0 = NULL, *debug_context1 = NULL, *debug_context2 = NULL;
  g_message("%s: before process key event: %s", __FUNCTION__, debug_context0 = get_context_debug(engine));
  km_core_process_event(keyman->state, keycode_to_vk[keycode], km_mod_state, isKeyDown, KM_CORE_EVENT_FLAG_DEFAULT);
  g_message("%s: after process key event : %s", __FUNCTION__, debug_context1 = get_context_debug(engine));

  g_free(keyman->commit_item->char_buffer);
  keyman->commit_item->char_buffer = NULL;
  const km_core_actions *core_actions = km_core_state_get_actions(keyman->state);

  gboolean result = process_actions(engine, core_actions);

  // If we have a non-compliant client, i.e. a client that doesn't support
  // surrounding text (e.g. Chromium as of v104) we sent the key event
  // to the system service and now stop further processing by returning TRUE.
  //
  // With a compliant client (i.e. supports surrounding text), it
  // depends whether or not we handled the event. We return TRUE if we
  // completely processed the event and no further processing should happen,
  // or FALSE if someone else should handle the event (e.g. for a left-arrow
  // key event).
  g_message("%s: after processing all actions: %s, returning %s", __FUNCTION__,
    debug_context2 = get_context_debug(engine), result ? "TRUE" : "FALSE");

  return result;
}

/**
 * Handler for the IBus `set-surrounding-text` signal
 *
 * Called by IBus to let us know the surrounding text and the cursor position
 * (and selection) in the text. This is used by Keyman as context.
 *
 * @param engine      A pointer to the IBusEngine instance
 * @param text        The surrounding text
 * @param cursor_pos  The position of the cursor in the text
 * @param anchor_pos  The position of the anchor in the text
 */
static void
ibus_keyman_engine_set_surrounding_text(
  IBusEngine *engine,
  IBusText    *text,
  guint       cursor_pos,
  guint       anchor_pos
){
    parent_class->set_surrounding_text(engine, text, cursor_pos, anchor_pos);
    set_context_if_needed(engine);
}

// static void ibus_keyman_engine_set_cursor_location (IBusEngine             *engine,
//                                              guint                    x,
//                                              guint                    y,
//                                              guint                    w,
//                                              guint                    h)
// {
//     g_message("ibus_keyman_engine_set_cursor_location");
//     //ibus_keyman_engine_reset(engine);
//     parent_class->set_cursor_location (engine, x, y, w, h);
// }

/**
 * Handler for the IBus `focus-in` signal
 *
 * Called by ibus when the client application receives focus
 *
 * @param engine  A pointer to the IBusEngine instance
 */
static void
ibus_keyman_engine_focus_in (IBusEngine *engine)
{
    IBusKeymanEngine *keyman = (IBusKeymanEngine *) engine;

    g_message("%s", __FUNCTION__);
    ibus_engine_register_properties (engine, keyman->prop_list);

    set_context_if_needed(engine);
    parent_class->focus_in (engine);
}

/**
 * Handler for the IBus `focus-out` signal
 *
 * Called by ibus when the client application loses focus
 *
 * @param engine  A pointer to the IBusEngine instance
 */
static void
ibus_keyman_engine_focus_out (IBusEngine *engine)
{
    IBusKeymanEngine *keyman = (IBusKeymanEngine *) engine;

    g_message("%s", __FUNCTION__);
    km_core_state_context_clear(keyman->state);
    parent_class->focus_out (engine);
}

/**
 * Handler for the IBus `reset` signal
 *
 * Called by ibus when the IME is reset.
 *
 * @param engine  A pointer to the IBusEngine instance
 */
static void
ibus_keyman_engine_reset (IBusEngine *engine)
{
    g_message("%s", __FUNCTION__);
    parent_class->reset (engine);
    set_context_if_needed(engine);
}

/**
 * Handler for the IBus `enable` signal
 *
 * Called by ibus when the IME is enabled.
 *
 * @param engine  A pointer to the IBusEngine instance
 */
static void
ibus_keyman_engine_enable (IBusEngine *engine)
{
    const gchar *engine_name;
    IBusKeymanEngine *keyman = (IBusKeymanEngine *) engine;

    engine_name = ibus_engine_get_name (engine);
    g_assert (engine_name);
    g_message("WDG: %s %s: enabling surrounding context", __FUNCTION__, engine_name);
    ibus_engine_get_surrounding_text(engine, NULL, NULL, NULL);
    if (keyman->ldmlfile)
    {
        // own dbus name com.Keyman
        // expose properties LDMLFile and Name
        KeymanService *service = km_service_get_default(engine);
        km_service_set_ldmlfile (service, keyman->ldmlfile);
        km_service_set_name (service, keyman->kb_name);
    }
    parent_class->enable (engine);
}

/**
 * Handler for the IBus `disable` signal
 *
 * Called by ibus when the IME is disabled.
 *
 * @param engine  A pointer to the IBusEngine instance
 */
static void
ibus_keyman_engine_disable (IBusEngine *engine)
{
    const gchar *engine_name;

    engine_name = ibus_engine_get_name (engine);
    g_assert (engine_name);
    g_message("WDG: %s %s", __FUNCTION__, engine_name);
    ibus_keyman_engine_focus_out (engine);
    // stop owning dbus name com.Keyman
    KeymanService *service = km_service_get_default(engine);
    km_service_set_ldmlfile (service, "");
    km_service_set_name (service, "None");
    // g_clear_object(&service);

    parent_class->disable (engine);
}

// static void
// ibus_keyman_engine_page_up (IBusEngine *engine)
// {
//     g_message("ibus_keyman_engine_page_up");
//     parent_class->page_up (engine);
//     set_context_if_needed(engine);
// }

// static void
// ibus_keyman_engine_page_down (IBusEngine *engine)
// {
//     g_message("ibus_keyman_engine_page_down");
//     parent_class->page_down (engine);
//     set_context_if_needed(engine);
// }

// static void
// ibus_keyman_engine_cursor_up (IBusEngine *engine)
// {
//     g_message("ibus_keyman_engine_cursor_up");
//     parent_class->cursor_up (engine);
//     set_context_if_needed(engine);
// }

// static void
// ibus_keyman_engine_cursor_down (IBusEngine *engine)
// {
//     g_message("ibus_keyman_engine_cursor_down");
//     parent_class->cursor_down (engine);
//     set_context_if_needed(engine);
// }

// static void
// ibus_keyman_engine_property_activate (IBusEngine  *engine,
//                                     const gchar *prop_name,
//                                     guint        prop_state)
// {
//     g_message("ibus_keyman_engine_property_activate");
//     parent_class->property_activate (engine, prop_name, prop_state);
// }