Merge lp:~davidmhewitt/wingpanel-indicator-keyboard/fix-1650986-xml-config into lp:~wingpanel-devs/wingpanel-indicator-keyboard/trunk

[David Hewitt]

Load XKB config names from evdev.xml instead of evdev.lst

The list of XKB keyboard configurations was being read from evdev.lst. All documentation online about how to create keyboard maps refers to creating them in evdev.xml.

I checked and both files contain the exact same base configurations for every language and keymap. But, it's likely that any custom or new keyboard maps will be added to the XML files.

This branch should have no functionality impact whatsoever for the average user. But for the case in the attached bug, where custom layouts are not displayed, this branch resolves that.

To be able to add a custom keyboard map, you must be running a version of the keyboard plug that supports loading configs from XML too. See the following branch:
https://code.launchpad.net/~davidmhewitt/switchboard-plug-keyboard/fix-1650986-load-xml-config/+merge/317412

[lp:~davidmhewitt/wingpanel-indicator-keyboard/fix-1650986-xml-config]

67. By David Hewitt on 2017-02-25

Improved code based on Santiago's comments

[Santiago (santileortiz)]

review: Approve (code)

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2016-04-20 21:02:50 +0000
+++ src/CMakeLists.txt	2017-02-25 10:48:25 +0000
@@ -1,7 +1,7 @@
 find_package (PkgConfig)
 
 # Add all your dependencies to the list below
-pkg_check_modules (DEPS REQUIRED wingpanel-2.0 granite)
+pkg_check_modules (DEPS REQUIRED wingpanel-2.0 granite libxml-2.0)
 
 add_definitions (${DEPS_CFLAGS})
 link_directories (${DEPS_LIBRARY_DIRS})
@@ -21,6 +21,7 @@
 PACKAGES
   wingpanel-2.0
   granite
+  libxml-2.0
 OPTIONS
   --thread
 )

=== modified file 'src/LayoutsManager.vala'
--- src/LayoutsManager.vala	2016-04-20 21:02:50 +0000
+++ src/LayoutsManager.vala	2017-02-25 10:48:25 +0000
@@ -94,67 +94,46 @@
     }
 
     public string? get_name_for_xkb_layout (string language, string? variant) {
-        var file = File.new_for_path ("/usr/share/X11/xkb/rules/evdev.lst");
-
-        if (!file.query_exists ()) {
-            critical ("File '%s' doesn't exist.", file.get_path ());
+        debug (@"get_name_for_xkb_layout ($language $variant)");
+        Xml.Doc* doc = Xml.Parser.parse_file ("/usr/share/X11/xkb/rules/evdev.xml");
+        if (doc == null) {
+            critical ("'evdev.xml' not found or permissions incorrect\n");
             return null;
         }
 
+        Xml.XPath.Context cntx = new Xml.XPath.Context (doc);
+        string xpath = "";
+
         if (variant == null) {
-            try {
-                var dis = new DataInputStream (file.read ());
-                string line;
-                bool layout_found = false;
-                while ((line = dis.read_line (null)) != null) {
-                    if (layout_found) {
-                        if ("!" in line || line == "") {
-                            break;
-                        }
-
-                        var parts = line.chug ().split (" ", 2);
-                        if (parts[0] == language) {
-                            return dgettext ("xkeyboard-config", parts[1].chug ());
-                        }
-                    } else {
-                        if ("!" in line && "layout" in line) {
-                            layout_found = true;
-                        }
-                    }
-                }
-            } catch (Error e) {
-                error ("%s", e.message);
-            }
-
-            return null;
+            xpath = @"/xkbConfigRegistry/layoutList/layout/configItem/name[text()='$language']/../description";
         } else {
-            try {
-                var dis = new DataInputStream (file.read ());
-                string line;
-                bool variant_found = false;
-                while ((line = dis.read_line (null)) != null) {
-                    if (variant_found) {
-                        if ("!" in line || line == "") {
-                            break;
-                        }
-
-                        var parts = line.chug ().split (" ", 2);
-                        var subparts = parts[1].chug ().split (":", 2);
-                        if (subparts[0] == language && parts[0] == variant) {
-                            return dgettext ("xkeyboard-config", subparts[1].chug ());
-                        }
-                    } else {
-                        if ("!" in line && "variant" in line) {
-                            variant_found = true;
-                        }
-                    }
-                }
-            } catch (Error e) {
-                error ("%s", e.message);
-            }
-
+            xpath = @"/xkbConfigRegistry/layoutList/layout/configItem/name[text()='$language']/../../variantList/variant/configItem/name[text()='$variant']/../description";
+        }
+
+        Xml.XPath.Object* res = cntx.eval_expression (xpath);
+
+        if (res == null) {
+            delete doc;
+            critical ("Unable to parse 'evdev.xml'");
+            return null;     
+        }
+
+        if (res->type != Xml.XPath.ObjectType.NODESET || res->nodesetval == null) {
+            delete res;
+            delete doc;
+            warning (@"No name for $language:$variant found in 'evdev.xml'");
             return null;
         }
+
+        string? name = null;
+        Xml.Node* node = res->nodesetval->item (0);
+        if (node != null) {
+            name = dgettext ("xkeyboard-config", node->get_content ());
+        }
+
+        delete res;
+        delete doc;
+        return name;
     }
 
     public string get_current (bool shorten = false) {