keymap: add xkb_keymap_keyname_get_keycode()

this function allows finding a keycode from a given keyname and is useful for generating keyboard events to use in regression tests during CI Signed-off-by: Mike Blumenkrantz <[email protected]>
xkbcommon · Jan 20, 2016 · 76d1c50 · 76d1c50
1 parent 7f3bb16
commit 76d1c50
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/src/keymap.c b/src/keymap.c
@@ -470,6 +470,33 @@ xkb_keymap_key_for_each(struct xkb_keymap *keymap, xkb_keymap_key_iter_t iter,
         iter(keymap, key->keycode, data);
 }
 
+XKB_EXPORT xkb_keycode_t
+xkb_keymap_keyname_get_keycode(struct xkb_keymap *keymap, const char *keyname)
+{
+    struct xkb_key *key;
+    xkb_atom_t name;
+
+    name = xkb_atom_lookup(keymap->ctx, keyname);
+    if (!name)
+        return XKB_KEYCODE_INVALID;
+
+    xkb_keys_foreach(key, keymap) {
+        if (key->name == name)
+            return key->keycode;
+    }
+
+    name = XkbResolveKeyAlias(keymap, name);
+    if (!name)
+        return XKB_KEYCODE_INVALID;
+
+    xkb_keys_foreach(key, keymap) {
+        if (key->name == name)
+            return key->keycode;
+    }
+
+    return XKB_KEYCODE_INVALID;
+}
+
 /**
  * Simple boolean specifying whether or not the key should repeat.
  */

diff --git a/xkbcommon/xkbcommon.h b/xkbcommon/xkbcommon.h
@@ -940,6 +940,18 @@ void
 xkb_keymap_key_for_each(struct xkb_keymap *keymap, xkb_keymap_key_iter_t iter,
                         void *data);
 
+/**
+ * Find the keycode for a given keyname in a keymap.
+ *
+ * If no corresponding key is found in the keymap, returns 0.
+ *
+ * @sa xkb_keycode_t
+ * @memberof xkb_keymap
+ * @since 0.6.0
+ */
+xkb_keycode_t
+xkb_keymap_keyname_get_keycode(struct xkb_keymap *keymap, const char *keyname);
+
 /**
  * Get the number of modifiers in the keymap.
  *