From: Dana Jansens <danakj@orodu.net>
Date: Wed, 2 May 2007 03:10:25 +0000 (+0000)
Subject: better menu keyboard handling.
X-Git-Url: https://git.brokenzipper.com/gitweb?a=commitdiff_plain;h=a6f52b90551621316a36f7cd7b20ef1d5dca0782;p=chaz%2Fopenbox

better menu keyboard handling.
also, when you hit a keybinding while menus are open, it will close the menus and run the binding.
---

diff --git a/openbox/event.c b/openbox/event.c
index 6b7f4c53..a36e9223 100644
--- a/openbox/event.c
+++ b/openbox/event.c
@@ -76,8 +76,8 @@ typedef struct
 
 static void event_process(const XEvent *e, gpointer data);
 static void event_handle_root(XEvent *e);
-static void event_handle_menu_shortcut(XEvent *e);
-static void event_handle_menu(XEvent *e);
+static gboolean event_handle_menu_keyboard(XEvent *e);
+static gboolean event_handle_menu(XEvent *e);
 static void event_handle_dock(ObDock *s, XEvent *e);
 static void event_handle_dockapp(ObDockApp *app, XEvent *e);
 static void event_handle_client(ObClient *c, XEvent *e);
@@ -571,9 +571,17 @@ static void event_process(const XEvent *ec, gpointer data)
         e->type == MotionNotify || e->type == KeyPress ||
         e->type == KeyRelease)
     {
-        if (menu_frame_visible)
-            event_handle_menu(e);
-        else {
+        gboolean useevent = TRUE;
+
+        if (menu_frame_visible) {
+            if (event_handle_menu(e))
+                /* don't use the event if the menu used it, but if the menu
+                   didn't use it and it's a keypress that is bound, it will
+                   close the menu and be used */
+                useevent = FALSE;
+        }
+
+        if (useevent) {
             if (!keyboard_process_interactive_grab(e, &client)) {
                 if (moveresize_in_progress) {
                     moveresize_event(e);
@@ -1236,89 +1244,128 @@ static ObMenuFrame* find_active_or_last_menu()
     return ret;
 }
 
-static void event_handle_menu_shortcut(XEvent *ev)
+static gboolean event_handle_menu_keyboard(XEvent *ev)
 {
-    gunichar unikey = 0;
+    guint keycode, state;
+    gunichar unikey;
     ObMenuFrame *frame;
-    GList *start;
-    GList *it;
-    ObMenuEntryFrame *found = NULL;
-    guint num_found = 0;
+    gboolean ret = TRUE;
+
+    keycode = ev->xkey.keycode;
+    state = ev->xkey.state;
+    unikey = translate_unichar(keycode);
 
+    frame = find_active_or_last_menu();
+    if (frame == NULL)
+        ret = FALSE;
+
+    else if (keycode == ob_keycode(OB_KEY_ESCAPE) && state == 0) {
+        /* Escape closes the active menu */
+        menu_frame_hide(frame);
+    }
+
+    else if (keycode == ob_keycode(OB_KEY_RETURN) && (state == 0 ||
+                                                      state == ControlMask))
     {
-        const char *key;
-        if ((key = translate_keycode(ev->xkey.keycode)) == NULL)
-            return;
-        /* don't accept keys that aren't a single letter, like "space" */
-        if (key[1] != '\0')
-            return;
-        unikey = g_utf8_get_char_validated(key, -1);
-        if (unikey == (gunichar)-1 || unikey == (gunichar)-2 || unikey == 0)
-            return;
+        /* Enter runs the active item or goes into the submenu.
+           Control-Enter runs it without closing the menu. */
+        if (frame->child)
+            menu_frame_select_next(frame->child);
+        else
+            menu_entry_frame_execute(frame->selected, state, ev->xkey.time);
     }
 
-    if ((frame = find_active_or_last_menu()) == NULL)
-        return;
+    else if (keycode == ob_keycode(OB_KEY_LEFT) && ev->xkey.state == 0) {
+        /* Left goes to the parent menu */
+        menu_frame_select(frame, NULL, TRUE);
+    }
 
+    else if (keycode == ob_keycode(OB_KEY_RIGHT) && ev->xkey.state == 0) {
+        /* Right goes to the selected submenu */
+        if (frame->child) menu_frame_select_next(frame->child);
+    }
 
-    if (!frame->entries)
-        return; /* nothing in the menu anyways */
+    else if (keycode == ob_keycode(OB_KEY_UP) && state == 0) {
+        menu_frame_select_previous(frame);
+    }
 
-    /* start after the selected one */
-    start = frame->entries;
-    if (frame->selected) {
-        for (it = start; frame->selected != it->data; it = g_list_next(it))
-            g_assert(it != NULL); /* nothing was selected? */
-        /* next with wraparound */
-        start = g_list_next(it);
-        if (start == NULL) start = frame->entries;
+    else if (keycode == ob_keycode(OB_KEY_DOWN) && state == 0) {
+        menu_frame_select_next(frame);
     }
 
-    it = start;
-    do {
-        ObMenuEntryFrame *e = it->data;
-        gunichar entrykey = 0;
+    /* keyboard accelerator shortcuts. */
+    else if (ev->xkey.state == 0 &&
+             /* was it a valid key? */
+             unikey != 0 &&
+             /* don't bother if the menu is empty. */
+             frame->entries)
+    {
+        GList *start;
+        GList *it;
+        ObMenuEntryFrame *found = NULL;
+        guint num_found = 0;
+
+        /* start after the selected one */
+        start = frame->entries;
+        if (frame->selected) {
+            for (it = start; frame->selected != it->data; it = g_list_next(it))
+                g_assert(it != NULL); /* nothing was selected? */
+            /* next with wraparound */
+            start = g_list_next(it);
+            if (start == NULL) start = frame->entries;
+        }
 
-        if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL &&
-            e->entry->data.normal.enabled)
-            entrykey = e->entry->data.normal.shortcut;
-        else if (e->entry->type == OB_MENU_ENTRY_TYPE_SUBMENU)
-            entrykey = e->entry->data.submenu.submenu->shortcut;
+        it = start;
+        do {
+            ObMenuEntryFrame *e = it->data;
+            gunichar entrykey = 0;
 
-        if (unikey == entrykey) {
-            if (found == NULL) found = e;
-            ++num_found;
-        }
+            if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL &&
+                e->entry->data.normal.enabled)
+                entrykey = e->entry->data.normal.shortcut;
+            else if (e->entry->type == OB_MENU_ENTRY_TYPE_SUBMENU)
+                entrykey = e->entry->data.submenu.submenu->shortcut;
 
-        /* next with wraparound */
-        it = g_list_next(it);
-        if (it == NULL) it = frame->entries;
-    } while (it != start);
+            if (unikey == entrykey) {
+                if (found == NULL) found = e;
+                ++num_found;
+            }
 
-    if (found) {
-        if (found->entry->type == OB_MENU_ENTRY_TYPE_NORMAL &&
-            num_found == 1)
-        {
-            menu_frame_select(frame, found, TRUE);
-            usleep(50000);
-            menu_entry_frame_execute(found, ev->xkey.state,
-                                     ev->xkey.time);
-        } else {
-            menu_frame_select(frame, found, TRUE);
-            if (num_found == 1)
-                menu_frame_select_next(frame->child);
-        }
+            /* next with wraparound */
+            it = g_list_next(it);
+            if (it == NULL) it = frame->entries;
+        } while (it != start);
+
+        if (found) {
+            if (found->entry->type == OB_MENU_ENTRY_TYPE_NORMAL &&
+                num_found == 1)
+            {
+                menu_frame_select(frame, found, TRUE);
+                usleep(50000);
+                menu_entry_frame_execute(found, state, ev->xkey.time);
+            } else {
+                menu_frame_select(frame, found, TRUE);
+                if (num_found == 1)
+                    menu_frame_select_next(frame->child);
+            }
+        } else
+            ret = FALSE;
     }
+    else
+        ret = FALSE;
+
+    return ret;
 }
 
-static void event_handle_menu(XEvent *ev)
+static gboolean event_handle_menu(XEvent *ev)
 {
     ObMenuFrame *f;
     ObMenuEntryFrame *e;
+    gboolean ret = TRUE;
 
     switch (ev->type) {
     case ButtonRelease:
-        if (menu_can_hide) {
+        if (ev->xbutton.button <= 3 && menu_can_hide) {
             if ((e = menu_entry_frame_under(ev->xbutton.x_root,
                                             ev->xbutton.y_root)))
                 menu_entry_frame_execute(e, ev->xbutton.state,
@@ -1348,40 +1395,10 @@ static void event_handle_menu(XEvent *ev)
             menu_frame_select(e->frame, e, FALSE);
         break;
     case KeyPress:
-        if (ev->xkey.keycode == ob_keycode(OB_KEY_ESCAPE))
-            if ((f = find_active_or_last_menu()) && f->parent)
-                menu_frame_select(f, NULL, TRUE);
-            else
-                menu_frame_hide_all();
-        else if (ev->xkey.keycode == ob_keycode(OB_KEY_RETURN)) {
-            ObMenuFrame *f;
-            if ((f = find_active_menu())) {
-                if (f->child)
-                    menu_frame_select_next(f->child);
-                else
-                    menu_entry_frame_execute(f->selected, ev->xkey.state,
-                                             ev->xkey.time);
-            }
-        } else if (ev->xkey.keycode == ob_keycode(OB_KEY_LEFT)) {
-            ObMenuFrame *f;
-            if ((f = find_active_or_last_menu()))
-                menu_frame_select(f, NULL, TRUE);
-        } else if (ev->xkey.keycode == ob_keycode(OB_KEY_RIGHT)) {
-            ObMenuFrame *f;
-            if ((f = find_active_menu()) && f->child)
-                menu_frame_select_next(f->child);
-        } else if (ev->xkey.keycode == ob_keycode(OB_KEY_UP)) {
-            ObMenuFrame *f;
-            if ((f = find_active_or_last_menu()))
-                menu_frame_select_previous(f);
-        } else if (ev->xkey.keycode == ob_keycode(OB_KEY_DOWN)) {
-            ObMenuFrame *f;
-            if ((f = find_active_or_last_menu()))
-                menu_frame_select_next(f);
-        } else
-            event_handle_menu_shortcut(ev);
+        ret = event_handle_menu_keyboard(ev);
         break;
     }
+    return ret;
 }
 
 static gboolean menu_hide_delay_func(gpointer data)
diff --git a/openbox/keyboard.c b/openbox/keyboard.c
index 1509f69f..ccfe0497 100644
--- a/openbox/keyboard.c
+++ b/openbox/keyboard.c
@@ -27,6 +27,7 @@
 #include "client.h"
 #include "action.h"
 #include "prop.h"
+#include "menuframe.h"
 #include "config.h"
 #include "keytree.h"
 #include "keyboard.h"
@@ -297,6 +298,10 @@ void keyboard_event(ObClient *client, const XEvent *e)
         if (p->key == e->xkey.keycode &&
             p->state == e->xkey.state)
         {
+            /* if we hit a key binding, then close any open menus and run it */
+            if (menu_frame_visible)
+                menu_frame_hide_all();
+
             if (p->first_child != NULL) { /* part of a chain */
                 ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
                 /* 3 second timeout for chains */
diff --git a/openbox/translate.c b/openbox/translate.c
index 97066519..a7cac557 100644
--- a/openbox/translate.c
+++ b/openbox/translate.c
@@ -149,3 +149,19 @@ const gchar *translate_keycode(guint keycode)
         ret = XKeysymToString(sym);
     return g_locale_to_utf8(ret, -1, NULL, NULL, NULL);
 }
+
+gunichar translate_unichar(guint keycode)
+{
+    gunichar unikey = 0;
+
+    const char *key;
+    if ((key = translate_keycode(keycode)) != NULL &&
+        /* don't accept keys that aren't a single letter, like "space" */
+        key[1] == '\0')
+    {
+        unikey = g_utf8_get_char_validated(key, -1);
+        if (unikey == (gunichar)-1 || unikey == (gunichar)-2 || unikey == 0)
+            unikey = 0;
+    }
+    return unikey;
+}
diff --git a/openbox/translate.h b/openbox/translate.h
index 14efe73d..21cd6498 100644
--- a/openbox/translate.h
+++ b/openbox/translate.h
@@ -26,4 +26,8 @@ gboolean translate_key(const gchar *str, guint *state, guint *keycode);
 
 /*! Give the string form of a keycode */
 const gchar *translate_keycode(guint keycode);
+
+/*! Translate a keycode to the unicode character it represents */
+gunichar translate_unichar(guint keycode);
+
 #endif