Support engine specific hotkey.

bus/ibusimpl.c

 /* vim:set et sts=4: */
 /* ibus - The Input Bus
  * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
  * Copyright (C) 2008-2010 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
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
@@ skipping 70 matching lines @@
 static void     bus_ibus_impl_set_global_engine (BusIBusImpl        *ibus,
                                                  BusEngineProxy     *engine);
 
 static void     bus_ibus_impl_registry_changed  (BusIBusImpl        *ibus);
 static void     bus_ibus_impl_global_engine_changed
                                                 (BusIBusImpl        *ibus);
 
 static void     _factory_destroy_cb             (BusFactoryProxy    *factory,
                                                  BusIBusImpl        *ibus);
 
+static void     bus_ibus_impl_set_context_engine_from_desc
+                                                (BusIBusImpl        *ibus,
+                                                 BusInputContext    *context,
+                                                 IBusEngineDesc     *engine_desc);
 static void     bus_ibus_impl_set_context_engine(BusIBusImpl        *ibus,
                                                  BusInputContext    *context,
                                                  BusEngineProxy     *engine);
 
 static gchar   *bus_ibus_impl_load_global_engine_name_from_config
                                                 (BusIBusImpl        *ibus);
 static void     bus_ibus_impl_save_global_engine_name_to_config
                                                 (BusIBusImpl        *ibus);
 
 static gchar   *bus_ibus_impl_load_global_previous_engine_name_from_config
                                                 (BusIBusImpl        *ibus);
 static void     bus_ibus_impl_save_global_previous_engine_name_to_config
                                                 (BusIBusImpl        *ibus);
+static void     bus_ibus_impl_update_engines_hotkey_profile
+                                                (BusIBusImpl        *ibus);
 
 G_DEFINE_TYPE(BusIBusImpl, bus_ibus_impl, IBUS_TYPE_SERVICE)
 
 BusIBusImpl *
 bus_ibus_impl_get_default (void)
 {
     static BusIBusImpl *ibus = NULL;
 
     if (ibus == NULL) {
         ibus = (BusIBusImpl *) g_object_new (BUS_TYPE_IBUS_IMPL,
@@ skipping 127 matching lines @@
     ibus->engine_list = engine_list;
 
     if (ibus->engine_list) {
         IBusComponent *component;
 
         component = ibus_component_get_from_engine ((IBusEngineDesc *) ibus->engine_list->data);
         if (component && !ibus_component_is_running (component)) {
             ibus_component_start (component, g_verbose);
         }
     }
+
+    bus_ibus_impl_update_engines_hotkey_profile (ibus);
 }
 
 static void
 bus_ibus_impl_set_use_sys_layout (BusIBusImpl *ibus,
                                   GValue      *value)
 {
     if (value != NULL && G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
         ibus->use_sys_layout = g_value_get_boolean (value);
     }
 }
@@ skipping 338 matching lines @@
     ibus->hotkey_profile = ibus_hotkey_profile_new ();
     ibus->keymap = ibus_keymap_get ("us");
 
     ibus->use_sys_layout = FALSE;
     ibus->embed_preedit_text = TRUE;
     ibus->enable_by_default = FALSE;
     ibus->use_global_engine = FALSE;
     ibus->global_engine = NULL;
     ibus->global_previous_engine_name = NULL;
 
+    ibus->engines_hotkey_profile = NULL;
+    ibus->hotkey_to_engines_map = NULL;
+
     bus_ibus_impl_reload_config (ibus);
 
     g_signal_connect (BUS_DEFAULT_DBUS,
                       "name-owner-changed",
                       G_CALLBACK (_dbus_name_owner_changed_cb),
                       ibus);
 }
 
 static void
 bus_ibus_impl_destroy (BusIBusImpl *ibus)
@@ skipping 56 matching lines @@
         ibus->keymap = NULL;
     }
 
     if (ibus->global_engine) {
         g_object_unref (ibus->global_engine);
         ibus->global_engine = NULL;
     }
 
     g_free (ibus->global_previous_engine_name);
 
+    if (ibus->engines_hotkey_profile != NULL) {
+        g_object_unref (ibus->engines_hotkey_profile);
+        ibus->engines_hotkey_profile = NULL;
+    }
+
+    if (ibus->hotkey_to_engines_map) {
+        g_hash_table_unref (ibus->hotkey_to_engines_map);
+        ibus->hotkey_to_engines_map = NULL;
+    }
+
     bus_server_quit (BUS_DEFAULT_SERVER);
     ibus_object_destroy ((IBusObject *) BUS_DEFAULT_SERVER);
     IBUS_OBJECT_CLASS(bus_ibus_impl_parent_class)->destroy (IBUS_OBJECT (ibus));
 }
 
 /* introspectable interface */
 static IBusMessage *
 _ibus_introspect (BusIBusImpl     *ibus,
                   IBusMessage     *message,
                   BusConnection   *connection)
@@ skipping 189 matching lines @@
             else if (ibus->engine_list) {
                 engine_desc = (IBusEngineDesc *)ibus->engine_list->data;
             }
          }
     }
     else {
         /* request engine by name */
         engine_desc = _find_engine_desc_by_name (ibus, engine_name);
     }
 
-    if (engine_desc != NULL) {
-        engine = bus_ibus_impl_create_engine (engine_desc);
-        if (engine != NULL) {
-            bus_ibus_impl_set_context_engine (ibus, context, engine);
-        }
-    }
+    bus_ibus_impl_set_context_engine_from_desc (ibus, context, engine_desc);
 }
 
 static void
 bus_ibus_impl_context_request_next_engine_in_menu (BusIBusImpl     *ibus,
                                                    BusInputContext *context)
 {
     BusEngineProxy *engine;
     IBusEngineDesc *desc;
     IBusEngineDesc *next_desc = NULL;
     GList *p;
@@ skipping 22 matching lines @@
     }
     else {
         if (ibus->register_engine_list) {
             next_desc = (IBusEngineDesc *)ibus->register_engine_list->data;
         }
         else if (ibus->engine_list) {
             next_desc = (IBusEngineDesc *)ibus->engine_list->data;
         }
     }
 
-    if (next_desc != NULL) {
-        engine = bus_ibus_impl_create_engine (next_desc);
-        if (engine != NULL) {
-            bus_ibus_impl_set_context_engine (ibus, context, engine);
-        }
-    }
+    bus_ibus_impl_set_context_engine_from_desc (ibus, context, next_desc);
 }
 
 static void
 bus_ibus_impl_context_request_previous_engine (BusIBusImpl     *ibus,
                                                BusInputContext *context)
 {
     gchar *engine_name = NULL;
     if (!ibus->use_global_engine) {
         engine_name = (gchar *) g_object_get_data (G_OBJECT (context), "previous-engine-name");
     }
@@ skipping 48 matching lines @@
         g_signal_connect (ibus->global_engine, "destroy",
                 G_CALLBACK (_global_engine_destroy_cb), ibus);
     }
 
     bus_ibus_impl_save_global_engine_name_to_config (ibus);
     bus_ibus_impl_save_global_previous_engine_name_to_config (ibus);
     bus_ibus_impl_global_engine_changed (ibus);
 }
 
 static void
+bus_ibus_impl_set_context_engine_from_desc (BusIBusImpl     *ibus,
+                                            BusInputContext *context,
+                                            IBusEngineDesc  *engine_desc)
+{
+    if (engine_desc != NULL) {
+        BusEngineProxy *engine = bus_ibus_impl_create_engine (engine_desc);
+        if (engine != NULL) {
+            bus_ibus_impl_set_context_engine (ibus, context, engine);
+        }
+    }
+}
+
+static void
 bus_ibus_impl_set_context_engine (BusIBusImpl     *ibus,
                                   BusInputContext *context,
                                   BusEngineProxy  *engine) {
   g_object_set_data (G_OBJECT (context), "previous-engine-name", NULL);
 
   /* If use_global_engine is disabled, then we need to save the previous engine
    * of each input context. */
   if (!ibus->use_global_engine) {
       BusEngineProxy *previous_engine = bus_input_context_get_engine (context);
       if (previous_engine) {
@@ skipping 252 matching lines @@
         for (; p != NULL; p = p->next) {
             if (g_list_find (ibus->register_engine_list, p->data)) {
                 ibus->register_engine_list = g_list_remove (ibus->register_engine_list, p->data);
                 g_object_unref (p->data);
             }
         }
         g_list_free (engines);
     }
 
     g_object_unref (factory);
+
+    bus_ibus_impl_update_engines_hotkey_profile (ibus);
 }
 
 static void
 bus_ibus_impl_add_factory (BusIBusImpl     *ibus,
                            BusFactoryProxy *factory)
 {
     g_assert (BUS_IS_IBUS_IMPL (ibus));
     g_assert (BUS_IS_FACTORY_PROXY (factory));
 
     g_object_ref_sink (factory);
@@ skipping 39 matching lines @@
     }
 
     bus_ibus_impl_add_factory (ibus, factory);
 
     engines = ibus_component_get_engines (component);
 
     g_list_foreach (engines, (GFunc) g_object_ref, NULL);
     ibus->register_engine_list = g_list_concat (ibus->register_engine_list, engines);
     g_object_unref (component);
 
+    bus_ibus_impl_update_engines_hotkey_profile (ibus);
+
     reply = ibus_message_new_method_return (message);
     return reply;
 }
 
 static IBusMessage *
 _ibus_list_engines (BusIBusImpl   *ibus,
                     IBusMessage   *message,
                     BusConnection *connection)
 {
     IBusMessage *reply;
@@ skipping 417 matching lines @@
                                          BusInputContext *context,
                                          guint           keyval,
                                          guint           modifiers,
                                          guint           prev_keyval,
                                          guint           prev_modifiers)
 {
     static GQuark trigger = 0;
     static GQuark next = 0;
     static GQuark previous = 0;
 
+    GQuark event;
+    GList *engine_list;
+
     if (trigger == 0) {
         trigger = g_quark_from_static_string ("trigger");
         next = g_quark_from_static_string ("next-engine-in-menu");
         previous = g_quark_from_static_string ("previous-engine");
     }
 
-    GQuark event = ibus_hotkey_profile_filter_key_event (ibus->hotkey_profile,
-                                                         keyval,
-                                                         modifiers,
-                                                         prev_keyval,
-                                                         prev_modifiers,
-                                                         0);
+    /* Try global hotkeys first. */
+    event = ibus_hotkey_profile_filter_key_event (ibus->hotkey_profile,
+                                                  keyval,
+                                                  modifiers,
+                                                  prev_keyval,
+                                                  prev_modifiers,
+                                                  0);
 
     if (event == trigger) {
         gboolean enabled = bus_input_context_is_enabled (context);
         if (enabled) {
             bus_input_context_disable (context);
         }
         else {
             bus_input_context_enable (context);
         }
         return (enabled != bus_input_context_is_enabled (context));
     }
     if (event == next) {
         if (bus_input_context_is_enabled(context)) {
             bus_ibus_impl_context_request_next_engine_in_menu (ibus, context);
         }
         else {
             bus_input_context_enable (context);
         }
         return TRUE;
     }
     if (event == previous) {
         if (bus_input_context_is_enabled(context)) {
             bus_ibus_impl_context_request_previous_engine (ibus, context);
         }
         else {
             bus_input_context_enable (context);
         }
         return TRUE;
     }
+
+    if (!ibus->engines_hotkey_profile || !ibus->hotkey_to_engines_map) {
+        return FALSE;
+    }
+
+    /* Then try engines hotkeys. */
+    event = ibus_hotkey_profile_filter_key_event (ibus->engines_hotkey_profile,
+                                                  keyval,
+                                                  modifiers,
+                                                  prev_keyval,
+                                                  prev_modifiers,
+                                                  0);
+    if (event == 0) {
+        return FALSE;
+    }
+
+    engine_list = g_hash_table_lookup (ibus->hotkey_to_engines_map,
+                                       GUINT_TO_POINTER (event));
+    if (engine_list) {
+        BusEngineProxy *current_engine = bus_input_context_get_engine (context);
+        IBusEngineDesc *current_engine_desc =
+            (current_engine ? bus_engine_proxy_get_desc (current_engine) : NULL);
+        IBusEngineDesc *new_engine_desc = (IBusEngineDesc *) engine_list->data;
+
+        g_assert (new_engine_desc);
+
+        /* Find out what engine we should switch to. If the current engine has
+         * the same hotkey, then we should switch to the next engine with the
+         * same hotkey in the list. Otherwise, we just switch to the first
+         * engine in the list. */
+        GList *p = engine_list;
+        for (; p->next != NULL; p = p->next) {
+            if (current_engine_desc == (IBusEngineDesc *) p->data) {
+                new_engine_desc = (IBusEngineDesc *) p->next->data;
+                break;
+            }
+        }
+
+        if (current_engine_desc != new_engine_desc) {
+            bus_ibus_impl_set_context_engine_from_desc (ibus, context, new_engine_desc);
+            return TRUE;
+        }
+    }
+
     return FALSE;
 }
 
 static gchar*
 bus_ibus_impl_load_global_engine_name_from_config (BusIBusImpl *ibus)
 {
     GValue value = { 0 };
     gchar *global_engine_name = NULL;
 
     g_assert (IBUS_IS_CONFIG (ibus->config));
@@ skipping 46 matching lines @@
 
     if (ibus->use_global_engine && ibus->global_previous_engine_name) {
         GValue value = { 0 };
         g_value_init (&value, G_TYPE_STRING);
         g_value_set_static_string (&value, ibus->global_previous_engine_name);
 
         ibus_config_set_value (ibus->config, "general", "global_previous_engine", &value);
         g_value_unset (&value);
     }
 }
+
+static void
+_add_engine_hotkey (IBusEngineDesc *engine, BusIBusImpl *ibus)
+{
+    gchar **hotkey_list;
+    gchar **p;
+    gchar *hotkey;
+    GList *engine_list;
+
+    GQuark event;
+    guint keyval;
+    guint modifiers;
+
+    if (!engine || !engine->hotkeys || !*engine->hotkeys) {
+        return;
+    }
+
+    hotkey_list = g_strsplit_set (engine->hotkeys, ";,", 0);
+
+    for (p = hotkey_list; p && *p; ++p) {
+        hotkey = g_strstrip (*p);
+        if (!*hotkey || !ibus_key_event_from_string (hotkey, &keyval, &modifiers)) {
+            continue;
+        }
+
+        /* If the hotkey already exists, we won't need to add it again. */
+        event = ibus_hotkey_profile_lookup_hotkey (ibus->engines_hotkey_profile,
+                                                   keyval, modifiers);
+        if (event == 0) {
+            event = g_quark_from_string (hotkey);
+            ibus_hotkey_profile_add_hotkey (ibus->engines_hotkey_profile,
+                                            keyval, modifiers, event);
+        }
+
+        engine_list = g_hash_table_lookup (ibus->hotkey_to_engines_map,
+                                           GUINT_TO_POINTER (event));
+
+        /* As we will rebuild the engines hotkey map whenever an engine was
+         * added or removed, we don't need to hold a reference of the engine
+         * here. */
+        engine_list = g_list_append (engine_list, engine);
+
+        /* We need to steal the value before adding it back, otherwise it will
+         * be destroyed. */
+        g_hash_table_steal (ibus->hotkey_to_engines_map, GUINT_TO_POINTER (event));
+
+        g_hash_table_insert (ibus->hotkey_to_engines_map,
+                             GUINT_TO_POINTER (event), engine_list);
+    }
+
+    g_strfreev (hotkey_list);
+}
+
+static void
+bus_ibus_impl_update_engines_hotkey_profile (BusIBusImpl *ibus)
+{
+    if (ibus->engines_hotkey_profile) {
+        g_object_unref (ibus->engines_hotkey_profile);
+    }
+
+    if (ibus->hotkey_to_engines_map) {
+        g_hash_table_unref (ibus->hotkey_to_engines_map);
+    }
+
+    ibus->engines_hotkey_profile = ibus_hotkey_profile_new();
+    ibus->hotkey_to_engines_map =
+        g_hash_table_new_full (NULL, NULL, NULL, (GDestroyNotify) g_list_free);
+
+    g_list_foreach (ibus->register_engine_list, (GFunc) _add_engine_hotkey, ibus);
+    g_list_foreach (ibus->engine_list, (GFunc) _add_engine_hotkey, ibus);
+}