Merge lp:~davidmhewitt/switchboard-plug-keyboard/fix-1650986-load-xml-config into lp:~elementary-pantheon/switchboard-plug-keyboard/trunk

[David Hewitt]

Load XKB keymaps from evdev.xml instead of evdev.lst

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

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.

[lp:~davidmhewitt/switchboard-plug-keyboard/fix-1650986-load-xml-config]

517. By David Hewitt on 2017-02-23

Fixed double-free crash?

518. By David Hewitt on 2017-02-25

Improved code based on Santiago's suggestions

519. By David Hewitt on 2017-02-25

Ooops, missed some improvements from last commit

[Santiago (santileortiz)]

This and the branch on the keyboard indicator should allow users to more easily use custom keyboard layouts, I've been running them both for several days and they seem fine. Code looks good to me too.

review: Approve (code)

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2017-02-12 02:46:10 +0000
+++ src/CMakeLists.txt	2017-02-25 18:17:51 +0000
@@ -1,7 +1,7 @@
 find_package (PkgConfig)
 
 # Add all your dependencies to the list below
-pkg_check_modules (DEPS REQUIRED gthread-2.0 gtk+-3.0>=3.10 switchboard-2.0 granite)
+pkg_check_modules (DEPS REQUIRED gthread-2.0 gtk+-3.0>=3.10 switchboard-2.0 granite libxml-2.0)
 
 add_definitions (${DEPS_CFLAGS})
 link_directories (${DEPS_LIBRARY_DIRS})
@@ -47,6 +47,7 @@
     gtk+-3.0
     switchboard-2.0
     granite
+    libxml-2.0
 OPTIONS
     --thread
 )

=== modified file 'src/Layout/Handler.vala'
--- src/Layout/Handler.vala	2017-02-12 02:46:10 +0000
+++ src/Layout/Handler.vala	2017-02-25 18:17:51 +0000
@@ -8,73 +8,100 @@
     construct {
         languages = new HashTable<string, string> (str_hash, str_equal);
     }
-
+    
     private void parse_layouts () {
-        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 ());
-            return;
-        }
-
-        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);
-                    languages.set (parts[0], dgettext ("xkeyboard-config", parts[1].chug ()));
-                } else {
-                    if ("!" in line && "layout" in line) {
-                        layout_found = true;
+        Xml.Doc* doc = Xml.Parser.parse_file ("/usr/share/X11/xkb/rules/evdev.xml");
+        if (doc == null) {
+            critical ("'evdev.xml' not found or permissions missing\n");
+            return;
+        }
+
+        Xml.XPath.Context cntx = new Xml.XPath.Context (doc);
+        Xml.XPath.Object* res = cntx.eval_expression ("/xkbConfigRegistry/layoutList/layout/configItem");
+
+        if (res == null) {
+            delete doc;
+            critical ("Unable to parse 'evdev.xml'");   
+            return;     
+        }
+
+        if (res->type != Xml.XPath.ObjectType.NODESET || res->nodesetval == null) {
+            delete res;
+            delete doc;
+            critical ("No layouts found in 'evdev.xml'");
+            return;
+        }
+
+        for (int i = 0; i < res->nodesetval->length (); i++) {
+            Xml.Node* node = res->nodesetval->item (i);
+            string? name = null;
+            string? description = null;
+            for (Xml.Node* iter = node->children; iter != null; iter = iter->next) {
+                if (iter->type == Xml.ElementType.ELEMENT_NODE) {
+                    if (iter->name == "name") {
+                        name = iter->get_content ();
+                    } else if (iter->name == "description") {
+                        description = dgettext ("xkeyboard-config", iter->get_content ());
                     }
                 }
             }
-        } catch (Error e) {
-            error (e.message);
+            if (name != null && description != null) {                
+                languages.set (name, description);
+            }
         }
+
+        delete res;
+        delete doc;
     }
 
     public HashTable<string, string> get_variants_for_language (string language) {
         var returned_table = new HashTable<string, string> (str_hash, str_equal);
         returned_table.set ("", _("Default"));
-        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 ());
-            return returned_table;
-        }
-
-        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) {
-                        returned_table.set (parts[0], dgettext ("xkeyboard-config", subparts[1].chug ()));
-                    }
-                } else {
-                    if ("!" in line && "variant" in line) {
-                        variant_found = true;
+        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 returned_table;
+        }
+
+        Xml.XPath.Context cntx = new Xml.XPath.Context (doc);
+        var xpath = @"/xkbConfigRegistry/layoutList/layout/configItem/name[text()='$language']/../../variantList/variant/configItem";
+        Xml.XPath.Object* res = cntx.eval_expression (xpath);
+
+        if (res == null) {
+            delete doc;
+            critical ("Unable to parse 'evdev.xml'");
+            return returned_table;      
+        }
+
+        if (res->type != Xml.XPath.ObjectType.NODESET || res->nodesetval == null) {
+            delete res;
+            delete doc;
+            warning (@"No variants for $language found in 'evdev.xml'");
+            return returned_table;
+        }
+
+        for (int i = 0; i < res->nodesetval->length (); i++) {
+            Xml.Node* node = res->nodesetval->item (i);
+            
+            string? name = null;
+            string? description = null;
+            for (Xml.Node* iter = node->children; iter != null; iter = iter->next) {
+                if (iter->type == Xml.ElementType.ELEMENT_NODE) {
+                    if (iter->name == "name") {
+                        name = iter->get_content ();
+                    } else if (iter->name == "description") {
+                        description = dgettext ("xkeyboard-config", iter->get_content ());
                     }
                 }
             }
-        } catch (Error e) {
-            error (e.message);
+            if (name != null && description != null) {
+                returned_table.set (name, description);
+            }
         }
 
+        delete res;
+        delete doc;
+
         return returned_table;
     }