ibus/ibus-530711-preload-sys.patch

From dfe858f7ba476aa878c5d60a7480a03def558463 Mon Sep 17 00:00:00 2001
From: fujiwarat <takao.fujiwara1@gmail.com>
Date: Tue, 27 Nov 2012 15:53:27 +0900
Subject: [PATCH] Reload preload engines until users customize the list.

The idea is, if users don't customize the preload_engines with ibus-setup,
users would prefer to load the system default engines again by login.
The gconf value 'preload_engine_mode' is
IBUS_PRELOAD_ENGINE_MODE_USER by default but set
IBUS_PRELOAD_ENGINE_MODE_LANG_RELATIVE for the initial login.
If preload_engine_mode is IBUS_PRELOAD_ENGINE_MODE_LANG_RELATIVE,
ibus-daemon loads the system preload engines by langs.
If preload_engine_mode is IBUS_PRELOAD_ENGINE_MODE_USER,
ibus-daemon do not update the gconf value preload_engines.
On the other hand, if users enable the customized engine checkbutton
on ibus-setup, ibus-setup sets 'preload_engine_mode' as
IBUS_PRELOAD_ENGINE_MODE_USER and users can customize the value
'preload_engines'.
---
 data/ibus.schemas.in |  24 +++++++++
 setup/main.py        |  61 +++++++++++++++++++++--
 setup/setup.ui       |  22 +++++++--
 src/ibustypes.h      |  10 ++++
 ui/gtk3/panel.vala   | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 246 insertions(+), 7 deletions(-)

diff --git a/data/ibus.schemas.in b/data/ibus.schemas.in
index 1a0e2d2..64f6f33 100644
--- a/data/ibus.schemas.in
+++ b/data/ibus.schemas.in
@@ -2,6 +2,30 @@
 <gconfschemafile>
   <schemalist>
     <schema>
+      <key>/schemas/desktop/ibus/general/preload_engine_mode</key>
+      <applyto>/desktop/ibus/general/preload_engine_mode</applyto>
+      <owner>ibus</owner>
+      <type>int</type>
+      <default>0</default>
+      <locale name="C">
+        <short>Preload engine mode</short>
+            <long>Preload engines are loaded with this mode.
+                  0 = user customized engines.
+                  1 = language related engines.</long>
+      </locale>
+    </schema>
+    <schema>
+      <key>/schemas/desktop/ibus/general/preload_engines_inited</key>
+      <applyto>/desktop/ibus/general/preload_engines_inited</applyto>
+      <owner>ibus</owner>
+      <type>bool</type>
+      <default>false</default>
+      <locale name="C">
+        <short>The key preload_engines is initialized</short>
+            <long>The key preload_engines is initialized</long>
+      </locale>
+    </schema>
+    <schema>
       <key>/schemas/desktop/ibus/general/preload_engines</key>
       <applyto>/desktop/ibus/general/preload_engines</applyto>
       <owner>ibus</owner>
diff --git a/setup/main.py b/setup/main.py
index c02229b..5da6340 100644
--- a/setup/main.py
+++ b/setup/main.py
@@ -196,6 +196,20 @@ class Setup(object):
         self.__checkbutton_use_global_engine.connect("toggled",
                 self.__checkbutton_use_global_engine_toggled_cb)
 
+        # set preload mode
+        preload_engine_mode = IBus.PreloadEngineMode.USER
+        variant = self.__config.get_value("general", "preload_engine_mode")
+        if variant != None:
+            preload_engine_mode = variant.get_int32()
+        button = self.__builder.get_object("checkbutton_preload_engine_mode")
+        if preload_engine_mode == IBus.PreloadEngineMode.USER:
+            button.set_active(True)
+            self.__builder.get_object("hbox_customize_active_input_methods").set_sensitive(True)
+        else:
+            button.set_active(False)
+            self.__builder.get_object("hbox_customize_active_input_methods").set_sensitive(False)
+        button.connect("toggled", self.__checkbutton_preload_engine_mode_toggled_cb)
+
         # init engine page
         self.__engines = self.__bus.list_engines()
         value = self.__config.get_value("general", "load_xkb_layouts")
@@ -257,6 +271,7 @@ class Setup(object):
                 self.__checkbutton_auto_start_toggled_cb)
 
         self.__config = self.__bus.get_config()
+        self.__config.connect("value-changed", self.__config_value_changed_cb)
 
         self.__init_hotkey()
         self.__init_panel()
@@ -271,8 +286,8 @@ class Setup(object):
     def __combobox_notify_active_engine_cb(self, combobox, property):
         engine = self.__combobox.get_active_engine()
         button = self.__builder.get_object("button_engine_add")
-        button.set_sensitive(
-                engine != None and engine not in self.__treeview.get_engines())
+        button.set_sensitive(engine != None and \
+                engine.get_name() not in map(lambda e: e.get_name(), self.__treeview.get_engines()))
 
     def __get_engine_setup_exec_args(self, engine):
         args = []
@@ -351,6 +366,34 @@ class Setup(object):
             del self.__engine_setup_exec_list[name]
         self.__engine_setup_exec_list[name] = os.spawnl(os.P_NOWAIT, *args)
 
+    def __checkbutton_preload_engine_mode_toggled_cb(self, button):
+        if button.get_active():
+            variant = GLib.Variant.new_int32(IBus.PreloadEngineMode.USER)
+            self.__config.set_value("general",
+                                    "preload_engine_mode",
+                                    variant)
+            self.__builder.get_object("hbox_customize_active_input_methods").set_sensitive(True)
+            self.__treeview.notify("engines")
+        else:
+            message = _("The list of your saved input methods will be " \
+                        "cleared immediately and the list will be " \
+                        "configured by the login language every time. " \
+                        "Do you agree with this?")
+            dlg = Gtk.MessageDialog(type = Gtk.MessageType.QUESTION,
+                    buttons = Gtk.ButtonsType.YES_NO,
+                    message_format = message)
+            id = dlg.run()
+            dlg.destroy()
+            self.__flush_gtk_events()
+            if id != Gtk.ResponseType.YES:
+                button.set_active(True)
+                return
+            variant = GLib.Variant.new_int32(IBus.PreloadEngineMode.LANG_RELATIVE)
+            self.__config.set_value("general",
+                                    "preload_engine_mode",
+                                    variant)
+            self.__builder.get_object("hbox_customize_active_input_methods").set_sensitive(False)
+
     def __init_bus(self):
         self.__bus = IBus.Bus()
         if self.__bus.is_connected():
@@ -562,8 +605,18 @@ class Setup(object):
         value = GLib.Variant.new_boolean(value)
         self.__config.set_value("general", "use_global_engine", value)
 
-    def __config_value_changed_cb(self, bus, section, name, value):
-        pass
+    def __config_value_changed_cb(self, bus, section, name, variant):
+        if section == 'general' and name == 'preload_engines':
+            value = []
+            if variant != None:
+                value = self.__variant_dup_strv(variant)
+            engines = self.__get_engine_descs_from_names(value)
+            current_engines = self.__treeview.get_engines()
+            engines_csv = str.join(',', map(lambda e: e.get_name(), engines))
+            current_engines_csv = \
+                    str.join(',', map(lambda e: e.get_name(), current_engines))
+            if engines_csv != current_engines_csv:
+                self.__treeview.set_engines(engines)
 
     def __config_reloaded_cb(self, bus):
         pass
diff --git a/setup/setup.ui b/setup/setup.ui
index 8121d62..2026172 100644
--- a/setup/setup.ui
+++ b/setup/setup.ui
@@ -653,7 +653,23 @@
                     <property name="visible">True</property>
                     <property name="can_focus">False</property>
                     <child>
-                      <object class="GtkHBox" id="hbox1">
+                      <object class="GtkCheckButton" id="checkbutton_preload_engine_mode">
+                        <property name="visible">True</property>
+                        <property name="label" translatable="yes">Customize active input _methods</property>
+                        <property name="use_underline">True</property>
+                        <property name="can_focus">True</property>
+                        <property name="receives_default">False</property>
+                        <property name="tooltip_text" translatable="yes">Customize active input methods</property>
+                        <property name="draw_indicator">True</property>
+                      </object>
+                      <packing>
+                        <property name="expand">False</property>
+                        <property name="fill">True</property>
+                        <property name="position">0</property>
+                      </packing>
+                    </child>
+                    <child>
+                      <object class="GtkHBox" id="hbox_customize_active_input_methods">
                         <property name="visible">True</property>
                         <property name="can_focus">False</property>
                         <child>
@@ -842,7 +858,7 @@
                       <packing>
                         <property name="expand">True</property>
                         <property name="fill">True</property>
-                        <property name="position">0</property>
+                        <property name="position">1</property>
                       </packing>
                     </child>
                     <child>
@@ -889,7 +905,7 @@ You may use up/down buttons to change it.&lt;/i&gt;&lt;/small&gt;</property>
                       <packing>
                         <property name="expand">False</property>
                         <property name="fill">True</property>
-                        <property name="position">1</property>
+                        <property name="position">2</property>
                       </packing>
                     </child>
                   </object>
diff --git a/src/ibustypes.h b/src/ibustypes.h
index 737b3e2..8ce5a16 100644
--- a/src/ibustypes.h
+++ b/src/ibustypes.h
@@ -204,6 +204,16 @@ typedef enum {
 } IBusError;
 
 /**
+ * IBusPreloadEngineMode:
+ * @IBUS_PRELOAD_ENGINE_MODE_USER: user custimized engines
+ * @IBUS_PRELOAD_ENGINE_MODE_LANG_RELATIVE: language related engines.
+ */
+typedef enum {
+    IBUS_PRELOAD_ENGINE_MODE_USER          = 0,
+    IBUS_PRELOAD_ENGINE_MODE_LANG_RELATIVE = 1,
+} IBusPreloadEngineMode;
+
+/**
  * IBusRectangle:
  * @x: x coordinate.
  * @y: y coordinate.
diff --git a/ui/gtk3/panel.vala b/ui/gtk3/panel.vala
index 63b0cde..c4c8f2c 100644
--- a/ui/gtk3/panel.vala
+++ b/ui/gtk3/panel.vala
@@ -313,6 +313,8 @@ class Panel : IBus.PanelService {
         if (m_config != null) {
             m_config.value_changed.connect(config_value_changed_cb);
             m_config.watch("general", "preload_engines");
+            m_config.watch("general", "preload_engines_inited");
+            m_config.watch("general", "preload_engine_mode");
             m_config.watch("general", "engines_order");
             m_config.watch("general", "switcher_delay_time");
             m_config.watch("general/hotkey", "trigger_accel");
@@ -425,7 +427,136 @@ class Panel : IBus.PanelService {
             init_gkbd();
         }
 
+        GLib.Variant var_engines = 
+                m_config.get_value("general", "preload_engines");
+        string[] preload_engines = {};
+
+        if (var_engines != null) {
+            preload_engines = var_engines.dup_strv();
+        }
+
+        bool preload_engines_inited = false;
+        GLib.Variant var_preload_engines_inited =
+                m_config.get_value("general", "preload_engines_inited");
+
+        if (var_preload_engines_inited != null) {
+            preload_engines_inited = var_preload_engines_inited.get_boolean();
+        }
+
+        // Set preload_engines_inited = true for back compatibility
+        if (preload_engines.length != 0 && !preload_engines_inited) {
+                preload_engines_inited = true;
+                m_config.set_value("general",
+                                   "preload_engines_inited",
+                                   new GLib.Variant.boolean(true));
+        }
+
         update_xkb_engines();
+
+        // Before update preload_engine_mode, update_xkb_engines() is called
+        // because config_value_changed_cb() calls update_im_engines().
+        if (!preload_engines_inited) {
+            GLib.Variant variant = new GLib.Variant.int32(
+                    IBus.PreloadEngineMode.LANG_RELATIVE);
+            m_config.set_value("general",
+                               "preload_engine_mode",
+                               variant);
+        }
+
+        update_im_engines();
+
+        if (!preload_engines_inited) {
+            m_config.set_value("general",
+                               "preload_engines_inited",
+                               new GLib.Variant.boolean(true));
+        }
+    }
+
+    private bool set_lang_relative_preload_engines() {
+        string locale = Intl.setlocale(LocaleCategory.CTYPE, null);
+
+        if (locale == null) {
+            locale = "C";
+        }
+
+        string lang = locale.split(".")[0];
+        GLib.List<IBus.EngineDesc> engines = m_bus.list_engines();
+        string[] im_engines = {};
+
+        for (unowned GLib.List<IBus.EngineDesc> p = engines;
+             p != null;
+             p = p.next) {
+            unowned IBus.EngineDesc engine = p.data;
+            if (engine.get_language() == lang &&
+                engine.get_rank() > 0) {
+                im_engines += engine.get_name();
+            }
+        }
+
+        lang = lang.split("_")[0];
+        if (im_engines.length == 0) {
+            for (unowned GLib.List<IBus.EngineDesc> p = engines;
+                 p != null;
+                 p = p.next) {
+                unowned IBus.EngineDesc engine = p.data;
+                if (engine.get_language() == lang &&
+                    engine.get_rank() > 0) {
+                    im_engines += engine.get_name();
+                }
+            }
+        }
+
+        if (im_engines.length == 0) {
+            return false;
+        }
+
+        GLib.Variant var_engines = 
+                m_config.get_value("general", "preload_engines");
+        string[] orig_preload_engines = {};
+        string[] preload_engines = {};
+
+        if (var_engines != null) {
+            orig_preload_engines = var_engines.dup_strv();
+        }
+
+        // clear input method engines
+        foreach (string name in orig_preload_engines) {
+            if (name.ascii_ncasecmp("xkb:", 4) != 0) {
+                continue;
+            }
+            preload_engines += name;
+        }
+
+        foreach (string name in im_engines) {
+            if (!(name in preload_engines)) {
+                preload_engines += name;
+            }
+        }
+
+        if ("".joinv(",", orig_preload_engines) !=
+            "".joinv(",", preload_engines)) {
+            m_config.set_value("general",
+                               "preload_engines",
+                               new GLib.Variant.strv(preload_engines));
+        }
+
+        return true;
+    }
+
+    private void update_im_engines() {
+        int preload_engine_mode = IBus.PreloadEngineMode.USER;
+        GLib.Variant var_preload_engine_mode =
+                m_config.get_value("general", "preload_engine_mode");
+
+        if (var_preload_engine_mode != null) {
+            preload_engine_mode = var_preload_engine_mode.get_int32();
+        }
+
+        if (preload_engine_mode == IBus.PreloadEngineMode.USER) {
+            return;
+        }
+
+        set_lang_relative_preload_engines();
     }
 
     private void update_xkb_engines() {
@@ -591,6 +722,11 @@ class Panel : IBus.PanelService {
                                          string section,
                                          string name,
                                          Variant variant) {
+        if (section == "general" && name == "preload_engine_mode") {
+            update_im_engines();
+            return;
+        }
+
         if (section == "general" && name == "preload_engines") {
             update_engines(variant, null);
             return;
-- 
1.8.0