src/ibusengine: Add focus_in_id()/focus_out_id() class methods

IBusEngine constructor now has a 'has-focus-id' property and if it's %TRUE,
IBusEngine::focus_in_id()/focus_out_id() are called instaed of
IBusEngine::focus_in()/focus_out() and the class method has an object_path
argument for the unique input context ID and a client argument for
the client application type likes ibus-gtk, ibus-gtk4, xim.

Author: fujiwarat

bus/engineproxy.c

@@ -2,7 +2,7 @@
 /* vim:set et sts=4: */
 /* ibus - The Input Bus
  * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2018 Takao Fujiwara <takao.fujiwara@gmail.com>
+ * Copyright (C) 2018-2022 Takao Fujiwara <takao.fujiwara@gmail.com>
  * Copyright (C) 2008-2018 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
@@ -126,20 +126,26 @@ void            bus_engine_proxy_set_cursor_location
 /**
  * bus_engine_proxy_focus_in:
  * @engine: A #BusEngineProxy.
+ * @object_path: An object path.
+ * @client: A client name.
  *
  * Call "FocusIn" method of an engine asynchronously. Do nothing if
  * the engine already has a focus.
  */
-void            bus_engine_proxy_focus_in    (BusEngineProxy     *engine);
+void            bus_engine_proxy_focus_in    (BusEngineProxy     *engine,
+                                              const gchar        *object_path,
+                                              const gchar        *client);
 
 /**
  * bus_engine_proxy_focus_out:
  * @engine: A #BusEngineProxy.
+ * @object_path: An object path.
  *
  * Call "FocusOut" method of an engine asynchronously. Do nothing if
  * the engine does not have a focus.
  */
-void            bus_engine_proxy_focus_out   (BusEngineProxy     *engine);
+void            bus_engine_proxy_focus_out   (BusEngineProxy     *engine,
+                                              const gchar        *object_path);
 
 /**
  * bus_engine_proxy_reset:

bus/engineproxy.h

@@ -72,6 +72,8 @@ struct _BusIBusImpl {
      * IBusEngineDesc object. */
     GHashTable *engine_table;
 
+    GHashTable *engine_focus_id_table;
+
     BusInputContext *focused_context;
     BusPanelProxy   *panel;
     BusPanelProxy   *emoji_extension;
@@ -596,6 +598,7 @@ bus_ibus_impl_init (BusIBusImpl *ibus)
     ibus->use_global_engine = TRUE;
     ibus->global_engine_name = NULL;
     ibus->global_previous_engine_name = NULL;
+    ibus->engine_focus_id_table = g_hash_table_new (g_str_hash, g_str_equal);
 
     /* focus the fake_context, if use_global_engine is enabled. */
     if (ibus->use_global_engine)
@@ -2384,3 +2387,13 @@ bus_ibus_impl_get_focused_input_context (BusIBusImpl *ibus)
 
     return ibus->focused_context;
 }
+
+GHashTable *
+bus_ibus_impl_get_engine_focus_id_table (BusIBusImpl *ibus)
+{
+
+    g_assert (BUS_IS_IBUS_IMPL (ibus));
+
+    return ibus->engine_focus_id_table;
+}
+

bus/ibusimpl.c

@@ -2,7 +2,8 @@
 /* vim:set et sts=4: */
 /* bus - The Input Bus
  * Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
- * Copyright (C) 2008-2013 Red Hat, Inc.
+ * Copyright (C) 2022 Takao Fujiwara <takao.fujiwara1@gmail.com>
+ * Copyright (C) 2008-2022 Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -58,6 +59,13 @@ G_BEGIN_DECLS
 typedef struct _BusIBusImpl BusIBusImpl;
 typedef struct _BusIBusImplClass BusIBusImplClass;
 
+typedef enum
+{
+    ENGINE_FOCUS_CATEGORY_NONE = 0,
+    ENGINE_FOCUS_CATEGORY_NO_ID,
+    ENGINE_FOCUS_CATEGORY_HAS_ID
+} EngineFocusCategory;
+
 GType            bus_ibus_impl_get_type             (void);
 
 /**
@@ -81,6 +89,7 @@ gboolean         bus_ibus_impl_is_embed_preedit_text
                                                     (BusIBusImpl        *ibus);
 BusInputContext *bus_ibus_impl_get_focused_input_context
                                                     (BusIBusImpl        *ibus);
-
+GHashTable      *bus_ibus_impl_get_engine_focus_id_table
+                                                    (BusIBusImpl        *ibus);
 G_END_DECLS
 #endif

bus/ibusimpl.h

@@ -846,7 +846,8 @@ _ic_process_key_event_reply_cb (GObject               *source,
 /**
  * _ic_process_key_event:
  *
- * Implement the "ProcessKeyEvent" method call of the org.freedesktop.IBus.InputContext interface.
+ * Implement the "ProcessKeyEvent" method call of the
+ * org.freedesktop.IBus.InputContext interface.
  */
 static void
 _ic_process_key_event  (BusInputContext       *context,
@@ -860,11 +861,13 @@ _ic_process_key_event  (BusInputContext       *context,
     g_variant_get (parameters, "(uuu)", &keyval, &keycode, &modifiers);
     if (G_UNLIKELY (!context->has_focus)) {
         /* workaround: set focus if context does not have focus */
-        BusInputContext *focused_context = bus_ibus_impl_get_focused_input_context (BUS_DEFAULT_IBUS);
+        BusInputContext *focused_context =
+                bus_ibus_impl_get_focused_input_context (BUS_DEFAULT_IBUS);
         if (focused_context == NULL ||
             focused_context->fake == TRUE ||
             context->fake == FALSE) {
-            /* grab focus, if context is a real IC or current focused IC is fake */
+            /* grab focus, if context is a real IC or current focused IC is
+             * fake */
             bus_input_context_focus_in (context);
         }
     }
@@ -914,7 +917,8 @@ _ic_process_key_event  (BusInputContext       *context,
                                             data);
     }
     else {
-        g_dbus_method_invocation_return_value (invocation, g_variant_new ("(b)", FALSE));
+        g_dbus_method_invocation_return_value (invocation,
+                                               g_variant_new ("(b)", FALSE));
     }
 }
 
@@ -1438,7 +1442,9 @@ bus_input_context_focus_in (BusInputContext *context)
     context->prev_modifiers = 0;
 
     if (context->engine) {
-        bus_engine_proxy_focus_in (context->engine);
+        const gchar *path =
+                ibus_service_get_object_path ((IBusService *)context);
+        bus_engine_proxy_focus_in (context->engine, path, context->client);
         bus_engine_proxy_enable (context->engine);
         bus_engine_proxy_set_capabilities (context->engine, context->capabilities);
         bus_engine_proxy_set_cursor_location (context->engine, context->x, context->y, context->w, context->h);
@@ -1538,7 +1544,9 @@ bus_input_context_focus_out (BusInputContext *context)
     bus_input_context_register_properties (context, props_empty);
 
     if (context->engine) {
-        bus_engine_proxy_focus_out (context->engine);
+        const gchar *path =
+            ibus_service_get_object_path ((IBusService *)context);
+        bus_engine_proxy_focus_out (context->engine, path);
     }
 
     context->has_focus = FALSE;
@@ -2376,11 +2384,19 @@ bus_input_context_enable (BusInputContext *context)
     if (context->engine == NULL)
         return;
 
-    bus_engine_proxy_focus_in (context->engine);
-    bus_engine_proxy_enable (context->engine);
-    bus_engine_proxy_set_capabilities (context->engine, context->capabilities);
-    bus_engine_proxy_set_cursor_location (context->engine, context->x, context->y, context->w, context->h);
-    bus_engine_proxy_set_content_type (context->engine, context->purpose, context->hints);
+    {
+        const gchar *path =
+                ibus_service_get_object_path ((IBusService *)context);
+        bus_engine_proxy_focus_in (context->engine, path, context->client);
+        bus_engine_proxy_enable (context->engine);
+        bus_engine_proxy_set_capabilities (context->engine,
+                                           context->capabilities);
+        bus_engine_proxy_set_cursor_location (context->engine,
+                                              context->x, context->y,
+                                              context->w, context->h);
+        bus_engine_proxy_set_content_type (context->engine,
+                                           context->purpose, context->hints);
+    }
 }
 
 void
@@ -2397,7 +2413,9 @@ bus_input_context_disable (BusInputContext *context)
     bus_input_context_register_properties (context, props_empty);
 
     if (context->engine) {
-        bus_engine_proxy_focus_out (context->engine);
+        const gchar *path =
+            ibus_service_get_object_path ((IBusService *)context);
+        bus_engine_proxy_focus_out (context->engine, path);
         bus_engine_proxy_disable (context->engine);
     }
 }
@@ -2445,6 +2463,8 @@ bus_input_context_unset_engine (BusInputContext *context)
 
     if (context->engine) {
         gint i;
+        const gchar *path =
+            ibus_service_get_object_path ((IBusService *)context);
         /* uninstall signal handlers for the engine. */
         for (i = 0; i < G_N_ELEMENTS(engine_signals); i++) {
             g_signal_handlers_disconnect_by_func (context->engine,
@@ -2453,7 +2473,7 @@ bus_input_context_unset_engine (BusInputContext *context)
         /* focus out engine so that the next call of
            bus_engine_proxy_focus_in() will take effect and trigger
            RegisterProperties. */
-        bus_engine_proxy_focus_out (context->engine);
+        bus_engine_proxy_focus_out (context->engine, path);
         g_object_unref (context->engine);
         context->engine = NULL;
     }
@@ -2488,7 +2508,9 @@ bus_input_context_set_engine (BusInputContext *context,
                               context);
         }
         if (context->has_focus) {
-            bus_engine_proxy_focus_in (context->engine);
+            const gchar *path =
+                    ibus_service_get_object_path ((IBusService *)context);
+            bus_engine_proxy_focus_in (context->engine, path, context->client);
             bus_engine_proxy_enable (context->engine);
             bus_engine_proxy_set_capabilities (context->engine, context->capabilities);
             bus_engine_proxy_set_cursor_location (context->engine, context->x, context->y, context->w, context->h);