]> Dogcows Code - chaz/openbox/blobdiff - openbox/menu.c
changes to the client menu, which entries are there, and reorganizing, and renaming.
[chaz/openbox] / openbox / menu.c
index d954102762dc1d1309d8749208ccb4e70c7d79db..741e27c12be7a5fc79375d96c8aa64ee5d9f2a25 100644 (file)
@@ -1,23 +1,45 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+   menu.c for the Openbox window manager
+   Copyright (c) 2006        Mikael Magnusson
+   Copyright (c) 2003-2007   Dana Jansens
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   See the COPYING file for a copy of the GNU General Public License.
+*/
+
 #include "debug.h"
 #include "menu.h"
 #include "openbox.h"
 #include "stacking.h"
 #include "client.h"
-#include "grab.h"
 #include "config.h"
 #include "screen.h"
 #include "menuframe.h"
+#include "keyboard.h"
 #include "geom.h"
 #include "misc.h"
 #include "client_menu.h"
 #include "client_list_menu.h"
+#include "client_list_combined_menu.h"
+#include "gettext.h"
 #include "parser/parse.h"
 
 typedef struct _ObMenuParseState ObMenuParseState;
 
 struct _ObMenuParseState
 {
-    GSList *menus;
+    ObMenu *parent;
+    ObMenu *pipe_creator;
 };
 
 static GHashTable *menu_hash = NULL;
@@ -32,37 +54,18 @@ static void parse_menu_separator(ObParseInst *i,
                                  gpointer data);
 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
                        gpointer data);
+static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
+                               gchar **strippedlabel, guint *position);
 
-static gboolean menu_open(gchar *file, xmlDocPtr *doc, xmlNodePtr *node)
-{
-    gboolean loaded = TRUE;
-    gchar *p;
-
-    p = g_build_filename(g_get_home_dir(), ".openbox", file, NULL);
-    if (!parse_load(p, "openbox_menu", doc, node)) {
-        g_free(p);
-        p = g_build_filename(RCDIR, file, NULL);
-        if (!parse_load(p, "openbox_menu", doc, node)) {
-            g_free(p);
-            p = g_strdup(file);
-            if (!parse_load(p, "openbox_menu", doc, node)) {
-                g_warning("Failed to load menu from '%s'", file);
-                loaded = FALSE;
-            }
-        }
-    }
-    g_free(p);
-    return loaded;
-}
 
-static void client_dest(ObClient *c)
+static void client_dest(ObClient *client, gpointer data)
 {
     /* menus can be associated with a client, so close any that are since
        we are disappearing now */
-    menu_frame_hide_all_client(c);
+    menu_frame_hide_all_client(client);
 }
 
-void menu_startup()
+void menu_startup(gboolean reconfig)
 {
     xmlDocPtr doc;
     xmlNodePtr node;
@@ -72,12 +75,14 @@ void menu_startup()
     menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
                                       (GDestroyNotify)menu_destroy_hash_value);
 
-    client_list_menu_startup();
+    client_list_menu_startup(reconfig);
+    client_list_combined_menu_startup(reconfig);
     client_menu_startup();
 
     menu_parse_inst = parse_startup();
 
-    menu_parse_state.menus = NULL;
+    menu_parse_state.parent = NULL;
+    menu_parse_state.pipe_creator = NULL;
     parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
     parse_register(menu_parse_inst, "item", parse_menu_item,
                    &menu_parse_state);
@@ -85,36 +90,51 @@ void menu_startup()
                    parse_menu_separator, &menu_parse_state);
 
     for (it = config_menu_files; it; it = g_slist_next(it)) {
-        if (menu_open(it->data, &doc, &node)) {
+        if (parse_load_menu(it->data, &doc, &node)) {
             loaded = TRUE;
-            parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
+            parse_tree(menu_parse_inst, doc, node->children);
             xmlFreeDoc(doc);
-        }
+        } else
+            g_message(_("Unable to find a valid menu file '%s'"),
+                      (const gchar*)it->data);
     }
     if (!loaded) {
-        if (menu_open("menu.xml", &doc, &node)) {
-            parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
+        if (parse_load_menu("menu.xml", &doc, &node)) {
+            parse_tree(menu_parse_inst, doc, node->children);
             xmlFreeDoc(doc);
-        }
+        } else
+            g_message(_("Unable to find a valid menu file '%s'"),
+                      "menu.xml");
     }
     
-    g_assert(menu_parse_state.menus == NULL);
+    g_assert(menu_parse_state.parent == NULL);
 
-    client_add_destructor(client_dest);
+    if (!reconfig)
+        client_add_destructor(client_dest, NULL);
 }
 
-void menu_shutdown()
+void menu_shutdown(gboolean reconfig)
 {
-    client_remove_destructor(client_dest);
+    if (!reconfig)
+        client_remove_destructor(client_dest);
 
     parse_shutdown(menu_parse_inst);
     menu_parse_inst = NULL;
 
+    client_list_menu_shutdown(reconfig);
+    client_list_combined_menu_shutdown(reconfig);
+
     menu_frame_hide_all();
     g_hash_table_destroy(menu_hash);
     menu_hash = NULL;
 }
 
+static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
+{
+    ObMenu *menu = val;
+    return menu->pipe_creator == data;
+}
+
 void menu_pipe_execute(ObMenu *self)
 {
     xmlDocPtr doc;
@@ -125,9 +145,9 @@ void menu_pipe_execute(ObMenu *self)
     if (!self->execute)
         return;
 
-    if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err))
-    {
-        g_warning("Failed to execute command for pipe-menu: %s", err->message);
+    if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
+        g_message(_("Failed to execute command for pipe-menu '%s': %s"),
+                  self->execute, err->message);
         g_error_free(err);
         return;
     }
@@ -135,15 +155,18 @@ void menu_pipe_execute(ObMenu *self)
     if (parse_load_mem(output, strlen(output),
                        "openbox_pipe_menu", &doc, &node))
     {
+        g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, self);
         menu_clear_entries(self);
 
-        menu_parse_state.menus = g_slist_prepend(NULL, self);
-        parse_tree(menu_parse_inst, doc, node->xmlChildrenNode);
-        menu_parse_state.menus = g_slist_remove(menu_parse_state.menus, self);
+        menu_parse_state.pipe_creator = self;
+        menu_parse_state.parent = self;
+        parse_tree(menu_parse_inst, doc, node->children);
         xmlFreeDoc(doc);
-
-        g_assert(menu_parse_state.menus == NULL);
+    } else {
+        g_message(_("Invalid output from pipe-menu '%s'"), self->execute);
     }
+
+    g_free(output);
 }
 
 static ObMenu* menu_from_name(gchar *name)
@@ -153,25 +176,83 @@ static ObMenu* menu_from_name(gchar *name)
     g_assert(name != NULL);
 
     if (!(self = g_hash_table_lookup(menu_hash, name)))
-        g_warning("Attempted to access menu '%s' but it does not exist.",
+        g_message(_("Attempted to access menu '%s' but it does not exist"),
                   name);
     return self;
 }  
 
+#define VALID_SHORTCUT(c) (((c) >= '0' && (c) <= '9') || \
+                           ((c) >= 'A' && (c) <= 'Z') || \
+                           ((c) >= 'a' && (c) <= 'z'))
+
+static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
+                               gchar **strippedlabel, guint *position)
+{
+    gunichar shortcut = 0;
+    
+    *position = 0;
+
+    g_assert(strippedlabel != NULL);
+
+    if (label == NULL) {
+        *strippedlabel = NULL;
+    } else {
+        gchar *i;
+
+        *strippedlabel = g_strdup(label);
+
+        /* if allow_shortcut is false, then you can't use the &, instead you
+           have to just use the first valid character
+        */
+
+        i = strchr(*strippedlabel, '&');
+        if (allow_shortcut && i != NULL) {
+            /* there is an ampersand in the string */
+
+            /* you have to use a printable ascii character for shortcuts
+               don't allow space either, so you can have like "a & b"
+            */
+            if (VALID_SHORTCUT(*(i+1))) {
+                shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
+                *position = i - *strippedlabel;
+
+                /* remove the & from the string */
+                for (; *i != '\0'; ++i)
+                    *i = *(i+1);
+            }
+        } else {
+            /* there is no ampersand, so find the first valid character to use
+               instead */
+
+            for (i = *strippedlabel; *i != '\0'; ++i)
+                if (VALID_SHORTCUT(*i)) {
+                    *position = i - *strippedlabel;
+                    shortcut = g_unichar_tolower(g_utf8_get_char(i));
+                    break;
+                }
+        }
+    }
+    return shortcut;
+}
+
 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
                             gpointer data)
 {
     ObMenuParseState *state = data;
     gchar *label;
     
-    if (state->menus) {
+    if (state->parent) {
         if (parse_attr_string("label", node, &label)) {
             GSList *acts = NULL;
 
-            for (node = node->xmlChildrenNode; node; node = node->next)
-                if (!xmlStrcasecmp(node->name, (const xmlChar*) "action"))
-                    acts = g_slist_append(acts, action_parse(i, doc, node));
-            menu_add_normal(state->menus->data, -1, label, acts);
+            for (node = node->children; node; node = node->next)
+                if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
+                    ObAction *a = action_parse
+                        (i, doc, node, OB_USER_ACTION_MENU_SELECTION);
+                    if (a)
+                        acts = g_slist_append(acts, a);
+                }
+            menu_add_normal(state->parent, -1, label, acts, FALSE);
             g_free(label);
         }
     }
@@ -183,8 +264,15 @@ static void parse_menu_separator(ObParseInst *i,
 {
     ObMenuParseState *state = data;
 
-    if (state->menus)
-        menu_add_separator(state->menus->data, -1);
+    if (state->parent) {
+        gchar *label;
+
+        if (!parse_attr_string("label", node, &label))
+            label = NULL;
+
+        menu_add_separator(state->parent, -1, label);
+        g_free(label);
+    }
 }
 
 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
@@ -201,19 +289,23 @@ static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
         if (!parse_attr_string("label", node, &title))
             goto parse_menu_fail;
 
-        if ((menu = menu_new(name, title, NULL))) {
+        if ((menu = menu_new(name, title, FALSE, NULL))) {
+            menu->pipe_creator = state->pipe_creator;
             if (parse_attr_string("execute", node, &script)) {
-                menu->execute = ob_expand_tilde(script);
+                menu->execute = parse_expand_tilde(script);
             } else {
-                state->menus = g_slist_prepend(state->menus, menu);
-                parse_tree(i, doc, node->xmlChildrenNode);
-                state->menus = g_slist_delete_link(state->menus, state->menus);
+                ObMenu *old;
+
+                old = state->parent;
+                state->parent = menu;
+                parse_tree(i, doc, node->children);
+                state->parent = old;
             }
         }
     }
 
-    if (state->menus)
-        menu_add_submenu(state->menus->data, -1, name);
+    if (state->parent)
+        menu_add_submenu(state->parent, -1, name);
 
 parse_menu_fail:
     g_free(name);
@@ -221,15 +313,18 @@ parse_menu_fail:
     g_free(script);
 }
 
-ObMenu* menu_new(gchar *name, gchar *title, gpointer data)
+ObMenu* menu_new(const gchar *name, const gchar *title,
+                 gboolean allow_shortcut, gpointer data)
 {
     ObMenu *self;
 
     self = g_new0(ObMenu, 1);
     self->name = g_strdup(name);
-    self->title = g_strdup(title);
     self->data = data;
 
+    self->shortcut = parse_shortcut(title, allow_shortcut, &self->title,
+                                    &self->shortcut_position);
+
     g_hash_table_replace(menu_hash, self->name, self);
 
     return self;
@@ -237,7 +332,17 @@ ObMenu* menu_new(gchar *name, gchar *title, gpointer data)
 
 static void menu_destroy_hash_value(ObMenu *self)
 {
-    /* XXX make sure its not visible */
+    /* make sure its not visible */
+    {
+        GList *it;
+        ObMenuFrame *f;
+
+        for (it = menu_frame_visible; it; it = g_list_next(it)) {
+            f = it->data;
+            if (f->menu == self)
+                menu_frame_hide_all();
+        }
+    }
 
     if (self->destroy_func)
         self->destroy_func(self, self->data);
@@ -246,6 +351,8 @@ static void menu_destroy_hash_value(ObMenu *self)
     g_free(self->name);
     g_free(self->title);
     g_free(self->execute);
+
+    g_free(self);
 }
 
 void menu_free(ObMenu *menu)
@@ -253,18 +360,33 @@ void menu_free(ObMenu *menu)
     g_hash_table_remove(menu_hash, menu->name);
 }
 
-void menu_show(gchar *name, gint x, gint y, ObClient *client)
+void menu_show(gchar *name, gint x, gint y, gint button, ObClient *client)
 {
     ObMenu *self;
     ObMenuFrame *frame;
 
-    if (!(self = menu_from_name(name))) return;
+    if (!(self = menu_from_name(name))
+        || keyboard_interactively_grabbed()) return;
+
+    /* if the requested menu is already the top visible menu, then don't
+       bother */
+    if (menu_frame_visible) {
+        frame = menu_frame_visible->data;
+        if (frame->menu == self)
+            return;
+    }
+
+    menu_frame_hide_all();
 
     frame = menu_frame_new(self, client);
-    menu_frame_move(frame, x, y);
-    menu_frame_show(frame, NULL);
-    if (frame->entries)
-        menu_frame_select_next(frame);
+    if (!menu_frame_show_topmenu(frame, x, y, button))
+        menu_frame_free(frame);
+    else if (frame->entries) {
+        /* select the first entry if it's not a submenu */
+        ObMenuEntryFrame *e = frame->entries->data;
+        if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL)
+            menu_frame_select(frame, e, FALSE);
+    }
 }
 
 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
@@ -297,7 +419,7 @@ void menu_entry_free(ObMenuEntry *self)
         case OB_MENU_ENTRY_TYPE_NORMAL:
             g_free(self->data.normal.label);
             while (self->data.normal.actions) {
-                action_free(self->data.normal.actions->data);
+                action_unref(self->data.normal.actions->data);
                 self->data.normal.actions =
                     g_slist_delete_link(self->data.normal.actions,
                                         self->data.normal.actions);
@@ -316,10 +438,21 @@ void menu_entry_free(ObMenuEntry *self)
 
 void menu_clear_entries(ObMenu *self)
 {
-    /* XXX assert that the menu isn't visible */
+#ifdef DEBUG
+    /* assert that the menu isn't visible */
+    {
+        GList *it;
+        ObMenuFrame *f;
+
+        for (it = menu_frame_visible; it; it = g_list_next(it)) {
+            f = it->data;
+            g_assert(f->menu != self);
+        }
+    }
+#endif
 
     while (self->entries) {
-       menu_entry_free(self->entries->data);
+        menu_entry_free(self->entries->data);
         self->entries = g_list_delete_link(self->entries, self->entries);
     }
 }
@@ -330,20 +463,21 @@ void menu_entry_remove(ObMenuEntry *self)
     menu_entry_free(self);
 }
 
-ObMenuEntry* menu_add_normal(ObMenu *self, gint id, gchar *label,
-                             GSList *actions)
+ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
+                             GSList *actions, gboolean allow_shortcut)
 {
     ObMenuEntry *e;
 
     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
-    e->data.normal.label = g_strdup(label);
     e->data.normal.actions = actions;
 
+    menu_entry_set_label(e, label, allow_shortcut);
+
     self->entries = g_list_append(self->entries, e);
     return e;
 }
 
-ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, gchar *submenu)
+ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
 {
     ObMenuEntry *e;
 
@@ -354,12 +488,14 @@ ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, gchar *submenu)
     return e;
 }
 
-ObMenuEntry* menu_add_separator(ObMenu *self, gint id)
+ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
 {
     ObMenuEntry *e;
 
     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
 
+    menu_entry_set_label(e, label, FALSE);
+
     self->entries = g_list_append(self->entries, e);
     return e;
 }
@@ -379,6 +515,11 @@ void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
     self->destroy_func = func;
 }
 
+void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
+{
+    self->place_func = func;
+}
+
 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
 {
     ObMenuEntry *ret = NULL;
@@ -406,3 +547,27 @@ void menu_find_submenus(ObMenu *self)
             e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
     }
 }
+
+void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
+                          gboolean allow_shortcut)
+{
+    switch (self->type) {
+    case OB_MENU_ENTRY_TYPE_SEPARATOR:
+        g_free(self->data.separator.label);
+        self->data.separator.label = g_strdup(label);
+        break;
+    case OB_MENU_ENTRY_TYPE_NORMAL:
+        g_free(self->data.normal.label);
+        self->data.normal.shortcut =
+            parse_shortcut(label, allow_shortcut, &self->data.normal.label,
+                           &self->data.normal.shortcut_position);
+        break;
+    default:
+        g_assert_not_reached();
+    }
+}
+
+void menu_show_all_shortcuts(ObMenu *self, gboolean show)
+{
+    self->show_all_shortcuts = show;
+}
This page took 0.036176 seconds and 4 git commands to generate.