add obt_parse_tree_from_root and use it, cuz it's nice
[dana/openbox.git] / openbox / menu.c
index 00a2bc2..f6d19d0 100644 (file)
+/* -*- 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 "client.h"
+#include "config.h"
+#include "actions.h"
 #include "screen.h"
+#include "menuframe.h"
+#include "keyboard.h"
 #include "geom.h"
-#include "plugin.h"
 #include "misc.h"
+#include "client_menu.h"
+#include "client_list_menu.h"
+#include "client_list_combined_menu.h"
+#include "gettext.h"
+#include "obt/parse.h"
 
-GHashTable *menu_hash = NULL;
-GList *menu_visible = NULL;
-
-#define FRAME_EVENTMASK (ButtonPressMask |ButtonMotionMask | EnterWindowMask |\
-                        LeaveWindowMask)
-#define TITLE_EVENTMASK (ButtonPressMask | ButtonMotionMask)
-#define ENTRY_EVENTMASK (EnterWindowMask | LeaveWindowMask | \
-                         ButtonPressMask | ButtonReleaseMask)
+typedef struct _ObMenuParseState ObMenuParseState;
 
-static void parse_menu(xmlDocPtr doc, xmlNodePtr node, void *data)
+struct _ObMenuParseState
 {
-    parse_menu_full(doc, node, data, TRUE);
-}
+    ObMenu *parent;
+    ObMenu *pipe_creator;
+};
 
+static GHashTable *menu_hash = NULL;
+static ObtParseInst *menu_parse_inst;
+static ObMenuParseState menu_parse_state;
+static gboolean menu_can_hide = FALSE;
 
-void parse_menu_full(xmlDocPtr doc, xmlNodePtr node, void *data,
-                       gboolean newmenu)
-{
-    Action *act;
-    xmlNodePtr nact;
+static void menu_destroy_hash_value(ObMenu *self);
+static void parse_menu_item(xmlNodePtr node, gpointer data);
+static void parse_menu_separator(xmlNodePtr node, gpointer data);
+static void parse_menu(xmlNodePtr node, gpointer data);
+static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
+                               gchar **strippedlabel, guint *position,
+                               gboolean *always_show);
 
-    gchar *id = NULL, *title = NULL, *label = NULL, *plugin;
-    ObMenu *menu = NULL, *parent;
 
-    if (newmenu == TRUE) {
-        if (!parse_attr_string("id", node, &id))
-            goto parse_menu_fail;
-        if (!parse_attr_string("label", node, &title))
-            goto parse_menu_fail;
-        ob_debug("menu label %s\n", title);
+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(client);
+}
 
-        if (parse_attr_string("plugin", node, &plugin)) {
-            PluginMenuCreateData data;
-            data.doc = doc;
-            data.node = node;
-            data.parent = menu;
+void menu_startup(gboolean reconfig)
+{
+    gboolean loaded = FALSE;
+    GSList *it;
+
+    menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
+                                      (GDestroyNotify)menu_destroy_hash_value);
 
-            if (plugin_open_reopen(plugin))
-                parent = plugin_create(plugin, &data);
-            g_free(plugin);
+    client_list_menu_startup(reconfig);
+    client_list_combined_menu_startup(reconfig);
+    client_menu_startup();
+
+    menu_parse_inst = obt_parse_instance_new();
+
+    menu_parse_state.parent = NULL;
+    menu_parse_state.pipe_creator = NULL;
+    obt_parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
+    obt_parse_register(menu_parse_inst, "item", parse_menu_item,
+                       &menu_parse_state);
+    obt_parse_register(menu_parse_inst, "separator",
+                       parse_menu_separator, &menu_parse_state);
+
+    for (it = config_menu_files; it; it = g_slist_next(it)) {
+        if (obt_parse_load_config_file(menu_parse_inst,
+                                       "openbox",
+                                       it->data,
+                                       "openbox_menu"))
+        {
+            loaded = TRUE;
+            obt_parse_tree_from_root(menu_parse_inst);
+            obt_parse_close(menu_parse_inst);
         } else
-            menu = menu_new(title, id, data ? *((ObMenu**)data) : NULL);
-            
-        if (data)
-            *((ObMenu**)data) = menu;
-    } else {
-        menu = (ObMenu *)data;
+            g_message(_("Unable to find a valid menu file '%s'"),
+                      (const gchar*)it->data);
     }
-
-    node = node->xmlChildrenNode;
-    
-    while (node) {
-        if (!xmlStrcasecmp(node->name, (const xmlChar*) "menu")) {
-            if (parse_attr_string("plugin", node, &plugin)) {
-                PluginMenuCreateData data;
-                data.doc = doc;
-                data.node = node;
-                data.parent = menu;
-                if (plugin_open_reopen(plugin))
-                    parent = plugin_create(plugin, &data);
-                g_free(plugin);
-            } else {
-                parent = menu;
-                parse_menu(doc, node, &parent);
-                menu_add_entry(menu, menu_entry_new_submenu(parent->label,
-                                                            parent));
-            }
-
-        }
-        else if (!xmlStrcasecmp(node->name, (const xmlChar*) "item")) {
-            if (parse_attr_string("label", node, &label)) {
-                if ((nact = parse_find_node("action", node->xmlChildrenNode)))
-                    act = action_parse(doc, nact);
-                else
-                    act = NULL;
-                if (act)
-                    menu_add_entry(menu, menu_entry_new(label, act));
-                else
-                    menu_add_entry(menu, menu_entry_new_separator(label));
-                g_free(label);
-            }
-        }
-        node = node->next;
+    if (!loaded) {
+        if (obt_parse_load_config_file(menu_parse_inst,
+                                       "openbox",
+                                       "menu.xml",
+                                       "openbox_menu"))
+        {
+            obt_parse_tree_from_root(menu_parse_inst);
+            obt_parse_close(menu_parse_inst);
+        } else
+            g_message(_("Unable to find a valid menu file '%s'"),
+                      "menu.xml");
     }
 
-parse_menu_fail:
-    g_free(id);
-    g_free(title);
+    g_assert(menu_parse_state.parent == NULL);
+
+    if (!reconfig)
+        client_add_destroy_notify(client_dest, NULL);
 }
 
-void menu_control_show(ObMenu *self, int x, int y, ObClient *client);
+void menu_shutdown(gboolean reconfig)
+{
+    if (!reconfig)
+        client_remove_destroy_notify(client_dest);
+
+    obt_parse_instance_unref(menu_parse_inst);
+    menu_parse_inst = NULL;
 
-void menu_destroy_hash_key(ObMenu *menu)
+    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)
 {
-    g_free(menu);
+    ObMenu *menu = val;
+    return menu->pipe_creator != NULL;
 }
 
-void menu_destroy_hash_value(ObMenu *self)
+static void clear_cache(gpointer key, gpointer val, gpointer data)
 {
-    GList *it;
+    ObMenu *menu = val;
+    if (menu->execute)
+        menu_clear_entries(menu);
+}
 
-    for (it = self->entries; it; it = it->next)
-        menu_entry_free(it->data);
-    g_list_free(self->entries);
+void menu_clear_pipe_caches(void)
+{
+    /* delete any pipe menus' submenus */
+    g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
+    /* empty the top level pipe menus */
+    g_hash_table_foreach(menu_hash, clear_cache, NULL);
+}
 
-    g_free(self->label);
-    g_free(self->name);
+void menu_pipe_execute(ObMenu *self)
+{
+    xmlNodePtr node;
+    gchar *output;
+    GError *err = NULL;
 
-    g_hash_table_remove(window_map, &self->title);
-    g_hash_table_remove(window_map, &self->frame);
-    g_hash_table_remove(window_map, &self->items);
+    if (!self->execute)
+        return;
+    if (self->entries) /* the entries are already created and cached */
+        return;
 
-    stacking_remove(self);
+    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;
+    }
 
-    RrAppearanceFree(self->a_title);
-    RrAppearanceFree(self->a_items);
-    XDestroyWindow(ob_display, self->title);
-    XDestroyWindow(ob_display, self->frame);
-    XDestroyWindow(ob_display, self->items);
+    if (obt_parse_load_mem(menu_parse_inst, output, strlen(output),
+                           "openbox_pipe_menu"))
+    {
+        menu_parse_state.pipe_creator = self;
+        menu_parse_state.parent = self;
+        obt_parse_tree(menu_parse_inst, node->children);
+        obt_parse_close(menu_parse_inst);
+    } else {
+        g_message(_("Invalid output from pipe-menu '%s'"), self->execute);
+    }
 
-    g_free(self);
+    g_free(output);
 }
 
-void menu_entry_free(ObMenuEntry *self)
+static ObMenu* menu_from_name(gchar *name)
 {
-    g_free(self->label);
-    action_free(self->action);
+    ObMenu *self = NULL;
 
-    g_hash_table_remove(window_map, &self->item);
+    g_assert(name != NULL);
 
-    RrAppearanceFree(self->a_item);
-    RrAppearanceFree(self->a_disabled);
-    RrAppearanceFree(self->a_hilite);
-    RrAppearanceFree(self->a_submenu);
-    XDestroyWindow(ob_display, self->item);
-    XDestroyWindow(ob_display, self->submenu_pic);
-    g_free(self);
+    if (!(self = g_hash_table_lookup(menu_hash, name)))
+        g_message(_("Attempted to access menu '%s' but it does not exist"),
+                  name);
+    return self;
 }
-    
-void menu_startup()
+
+#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,
+                               gboolean *always_show)
 {
-    menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal,
-                                      (GDestroyNotify)menu_destroy_hash_key,
-                                      (GDestroyNotify)menu_destroy_hash_value);
+    gunichar shortcut = 0;
+
+    *position = 0;
+    *always_show = FALSE;
 
-    parse_register("menu", parse_menu, NULL);
+    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 underscore 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;
+                *always_show = TRUE;
+
+                /* remove the '_' from the string */
+                for (; *i != '\0'; ++i)
+                    *i = *(i+1);
+            } else if (*(i+1) == '\0') {
+                /* no default shortcut if the '_' is the last character
+                   (eg. "Exit_") for menu entries that you don't want
+                   to be executed by mistake
+                */
+                    *i = '\0';
+            }
+        } else {
+            /* there is no underscore, 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;
 }
 
-void menu_shutdown()
+static void parse_menu_item(xmlNodePtr node,  gpointer data)
 {
-    g_hash_table_destroy(menu_hash);
+    ObMenuParseState *state = data;
+    gchar *label;
+
+    if (state->parent) {
+        if (obt_parse_attr_string(node, "label", &label)) {
+            GSList *acts = NULL;
+
+            for (node = node->children; node; node = node->next)
+                if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
+                    ObActionsAct *a = actions_parse(node);
+                    if (a)
+                        acts = g_slist_append(acts, a);
+                }
+            menu_add_normal(state->parent, -1, label, acts, TRUE);
+            g_free(label);
+        }
+    }
+}
+
+static void parse_menu_separator(xmlNodePtr node, gpointer data)
+{
+    ObMenuParseState *state = data;
+
+    if (state->parent) {
+        gchar *label;
+
+        if (!obt_parse_attr_string(node, "label", &label))
+            label = NULL;
+
+        menu_add_separator(state->parent, -1, label);
+        g_free(label);
+    }
 }
 
-static Window createWindow(Window parent, unsigned long mask,
-                          XSetWindowAttributes *attrib)
+static void parse_menu(xmlNodePtr node, gpointer data)
 {
-    return XCreateWindow(ob_display, parent, 0, 0, 1, 1, 0,
-                        RrDepth(ob_rr_inst), InputOutput,
-                         RrVisual(ob_rr_inst), mask, attrib);
-                       
+    ObMenuParseState *state = data;
+    gchar *name = NULL, *title = NULL, *script = NULL;
+    ObMenu *menu;
+
+    if (!obt_parse_attr_string(node, "id", &name))
+        goto parse_menu_fail;
+
+    if (!g_hash_table_lookup(menu_hash, name)) {
+        if (!obt_parse_attr_string(node, "label", &title))
+            goto parse_menu_fail;
+
+        if ((menu = menu_new(name, title, TRUE, NULL))) {
+            menu->pipe_creator = state->pipe_creator;
+            if (obt_parse_attr_string(node, "execute", &script)) {
+                menu->execute = parse_expand_tilde(script);
+            } else {
+                ObMenu *old;
+
+                old = state->parent;
+                state->parent = menu;
+                obt_parse_tree(menu_parse_inst, node->children);
+                state->parent = old;
+            }
+        }
+    }
+
+    if (state->parent)
+        menu_add_submenu(state->parent, -1, name);
+
+parse_menu_fail:
+    g_free(name);
+    g_free(title);
+    g_free(script);
 }
 
-ObMenu *menu_new_full(char *label, char *name, ObMenu *parent, 
-                      menu_controller_show show, menu_controller_update update,
-                      menu_controller_selected selected,
-                      menu_controller_hide hide,
-                      menu_controller_mouseover mouseover)
+ObMenu* menu_new(const gchar *name, const gchar *title,
+                 gboolean allow_shortcut_selection, gpointer data)
 {
-    XSetWindowAttributes attrib;
     ObMenu *self;
 
     self = g_new0(ObMenu, 1);
-    self->obwin.type = Window_Menu;
-    self->label = g_strdup(label);
     self->name = g_strdup(name);
-    self->parent = parent;
-    self->open_submenu = NULL;
-    self->over = NULL;
-
-    self->entries = NULL;
-    self->shown = FALSE;
-    self->invalid = TRUE;
-
-    /* default controllers */
-    self->show = (show != NULL ? show : menu_show_full);
-    self->hide = (hide != NULL ? hide : menu_hide);
-    self->update = (update != NULL ? update : menu_render);
-    self->mouseover = (mouseover != NULL ? mouseover :
-                       menu_control_mouseover);
-    self->selected = (selected != NULL ? selected : menu_entry_fire);
-
-    self->plugin = NULL;
-    self->plugin_data = NULL;
-
-    attrib.override_redirect = TRUE;
-    attrib.event_mask = FRAME_EVENTMASK;
-    self->frame = createWindow(RootWindow(ob_display, ob_screen),
-                               CWOverrideRedirect|CWEventMask, &attrib);
-    attrib.event_mask = TITLE_EVENTMASK;
-    self->title = createWindow(self->frame, CWEventMask, &attrib);
-    self->items = createWindow(self->frame, 0, &attrib);
-
-    self->a_title = self->a_items = NULL;
-
-    XMapWindow(ob_display, self->title);
-    XMapWindow(ob_display, self->items);
-
-    g_hash_table_insert(window_map, &self->frame, self);
-    g_hash_table_insert(window_map, &self->title, self);
-    g_hash_table_insert(window_map, &self->items, self);
-    g_hash_table_insert(menu_hash, g_strdup(name), self);
-
-    stacking_add(MENU_AS_WINDOW(self));
-    stacking_raise(MENU_AS_WINDOW(self));
+    self->data = data;
 
-    return self;
-}
+    self->shortcut = parse_shortcut(title, allow_shortcut_selection,
+                                    &self->title, &self->shortcut_position,
+                                    &self->shortcut_always_show);
 
-void menu_free(char *name)
-{
-    g_hash_table_remove(menu_hash, name);
+    g_hash_table_replace(menu_hash, self->name, self);
+
+    /* Each menu has a single more_menu.  When the menu spills past what
+       can fit on the screen, a new menu frame entry is created from this
+       more_menu, and a new menu frame for the submenu is created for this
+       menu, also pointing to the more_menu.
+
+       This can be done multiple times using the same more_menu.
+
+       more_menu->more_menu will always be NULL, since there is only 1 for
+       each menu. */
+    self->more_menu = g_new0(ObMenu, 1);
+    self->more_menu->name = _("More...");
+    self->more_menu->title = _("More...");
+    self->more_menu->data = data;
+    self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
+
+    return self;
 }
 
-ObMenuEntry *menu_entry_new_full(char *label, Action *action,
-                               ObMenuEntryRenderType render_type,
-                               gpointer submenu)
+static void menu_destroy_hash_value(ObMenu *self)
 {
-    ObMenuEntry *menu_entry = g_new0(ObMenuEntry, 1);
-
-    menu_entry->label = g_strdup(label);
-    menu_entry->render_type = render_type;
-    menu_entry->action = action;
+    /* 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();
+        }
+    }
 
-    menu_entry->hilite = FALSE;
-    menu_entry->enabled = TRUE;
+    if (self->destroy_func)
+        self->destroy_func(self, self->data);
 
-    menu_entry->submenu = submenu;
+    menu_clear_entries(self);
+    g_free(self->name);
+    g_free(self->title);
+    g_free(self->execute);
+    g_free(self->more_menu);
 
-    return menu_entry;
+    g_free(self);
 }
 
-void menu_entry_set_submenu(ObMenuEntry *entry, ObMenu *submenu)
+void menu_free(ObMenu *menu)
 {
-    g_assert(entry != NULL);
-    
-    entry->submenu = submenu;
-
-    if(entry->parent != NULL)
-        entry->parent->invalid = TRUE;
+    if (menu)
+        g_hash_table_remove(menu_hash, menu->name);
 }
 
-void menu_add_entry(ObMenu *menu, ObMenuEntry *entry)
+static gboolean menu_hide_delay_func(gpointer data)
 {
-    XSetWindowAttributes attrib;
+    menu_can_hide = TRUE;
+    return FALSE; /* no repeat */
+}
 
-    g_assert(menu != NULL);
-    g_assert(entry != NULL);
-    g_assert(entry->item == None);
+void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
+{
+    ObMenu *self;
+    ObMenuFrame *frame;
 
-    menu->entries = g_list_append(menu->entries, entry);
-    entry->parent = menu;
+    if (!(self = menu_from_name(name)) ||
+        grab_on_keyboard() || grab_on_pointer()) return;
 
-    attrib.event_mask = ENTRY_EVENTMASK;
-    entry->item = createWindow(menu->items, CWEventMask, &attrib);
-    entry->submenu_pic = createWindow(menu->items, CWEventMask, &attrib);
-    XMapWindow(ob_display, entry->item);
-    XMapWindow(ob_display, entry->submenu_pic);
+    /* 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;
+    }
 
-    entry->a_item = entry->a_disabled = entry->a_hilite = entry->a_submenu
-        = NULL;
+    menu_frame_hide_all();
+
+    /* clear the pipe menus when showing a new menu */
+    menu_clear_pipe_caches();
+
+    frame = menu_frame_new(self, 0, client);
+    if (!menu_frame_show_topmenu(frame, x, y, mouse))
+        menu_frame_free(frame);
+    else {
+        if (!mouse) {
+            /* select the first entry if it's not a submenu and we opened
+             * the menu with the keyboard, and skip all headers */
+            GList *it = frame->entries;
+            while (it) {
+                ObMenuEntryFrame *e = it->data;
+                if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
+                    menu_frame_select(frame, e, FALSE);
+                    break;
+                } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
+                    it = g_list_next(it);
+                else
+                    break;
+            }
+        }
 
-    menu->invalid = TRUE;
+        /* reset the hide timer */
+        if (!mouse)
+            menu_can_hide = TRUE;
+        else {
+            menu_can_hide = FALSE;
+            obt_main_loop_timeout_add(ob_main_loop,
+                                      config_menu_hide_delay * 1000,
+                                      menu_hide_delay_func,
+                                      NULL, g_direct_equal, NULL);
+        }
+    }
+}
 
-    g_hash_table_insert(window_map, &entry->item, menu);
-    g_hash_table_insert(window_map, &entry->submenu_pic, menu);
+gboolean menu_hide_delay_reached(void)
+{
+    return menu_can_hide;
 }
 
-void menu_show(char *name, int x, int y, ObClient *client)
+static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
 {
-    ObMenu *self;
-  
-    self = g_hash_table_lookup(menu_hash, name);
-    if (!self) {
-        g_warning("Attempted to show menu '%s' but it does not exist.",
-                  name);
-        return;
-    }
+    ObMenuEntry *self;
 
-    menu_show_full(self, x, y, client);
-}  
+    g_assert(menu);
 
-void menu_show_full(ObMenu *self, int x, int y, ObClient *client)
-{
-    g_assert(self != NULL);
-       
-    self->update(self);
-    
-    self->client = client;
+    self = g_new0(ObMenuEntry, 1);
+    self->ref = 1;
+    self->type = type;
+    self->menu = menu;
+    self->id = id;
 
-    if (!self->shown) {
-        if (!(self->parent && self->parent->shown)) {
-            grab_pointer(TRUE, None);
-            grab_keyboard(TRUE);
-        }
-        menu_visible = g_list_append(menu_visible, self);
+    switch (type) {
+    case OB_MENU_ENTRY_TYPE_NORMAL:
+        self->data.normal.enabled = TRUE;
+        break;
+    case OB_MENU_ENTRY_TYPE_SUBMENU:
+    case OB_MENU_ENTRY_TYPE_SEPARATOR:
+        break;
     }
 
-    menu_control_show(self, x, y, client);
+    return self;
 }
 
-void menu_hide(ObMenu *self) {
-    if (self->shown) {
-        XUnmapWindow(ob_display, self->frame);
-        self->shown = FALSE;
-       if (self->open_submenu)
-           self->open_submenu->hide(self->open_submenu);
-       if (self->parent && self->parent->open_submenu == self) {
-           self->parent->open_submenu = NULL;
-        }
+void menu_entry_ref(ObMenuEntry *self)
+{
+    ++self->ref;
+}
 
-        if (!(self->parent && self->parent->shown)) {
-            grab_keyboard(FALSE);
-            grab_pointer(FALSE, None);
-        }
-        menu_visible = g_list_remove(menu_visible, self);
-        if (self->over) {
-            ((ObMenuEntry *)self->over->data)->hilite = FALSE;
-            menu_entry_render(self->over->data);
-            self->over = NULL;
+void menu_entry_unref(ObMenuEntry *self)
+{
+    if (self && --self->ref == 0) {
+        switch (self->type) {
+        case OB_MENU_ENTRY_TYPE_NORMAL:
+            g_free(self->data.normal.label);
+            while (self->data.normal.actions) {
+                actions_act_unref(self->data.normal.actions->data);
+                self->data.normal.actions =
+                    g_slist_delete_link(self->data.normal.actions,
+                                        self->data.normal.actions);
+            }
+            break;
+        case OB_MENU_ENTRY_TYPE_SUBMENU:
+            g_free(self->data.submenu.name);
+            break;
+        case OB_MENU_ENTRY_TYPE_SEPARATOR:
+            g_free(self->data.separator.label);
+            break;
         }
+
+        g_free(self);
     }
 }
 
-void menu_clear(ObMenu *self) {
-    GList *it;
-  
-    for (it = self->entries; it; it = it->next) {
-       ObMenuEntry *entry = it->data;
-       menu_entry_free(entry);
+void menu_clear_entries(ObMenu *self)
+{
+#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);
+        }
     }
-    self->entries = NULL;
-    self->invalid = TRUE;
+#endif
+
+    while (self->entries) {
+        menu_entry_unref(self->entries->data);
+        self->entries = g_list_delete_link(self->entries, self->entries);
+    }
+    self->more_menu->entries = self->entries; /* keep it in sync */
 }
 
+void menu_entry_remove(ObMenuEntry *self)
+{
+    self->menu->entries = g_list_remove(self->menu->entries, self);
+    menu_entry_unref(self);
+}
 
-ObMenuEntry *menu_find_entry(ObMenu *menu, Window win)
+ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
+                             GSList *actions, gboolean allow_shortcut)
 {
-    GList *it;
+    ObMenuEntry *e;
 
-    for (it = menu->entries; it; it = it->next) {
-        ObMenuEntry *entry = it->data;
-        if (entry->item == win)
-            return entry;
-    }
-    return NULL;
+    e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
+    e->data.normal.actions = actions;
+
+    menu_entry_set_label(e, label, allow_shortcut);
+
+    self->entries = g_list_append(self->entries, e);
+    self->more_menu->entries = self->entries; /* keep it in sync */
+    return e;
 }
 
-ObMenuEntry *menu_find_entry_by_submenu(ObMenu *menu, ObMenu *submenu)
+ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
 {
-    GList *it;
-
-    for (it = menu->entries; it; it = it->next) {
-        ObMenuEntry *entry = it->data;
-        if (entry->submenu == submenu)
-            return entry;
-    }
-    return NULL;
+    ObMenuEntry *e;
+    e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
+    /* points to itself */
+    e->data.submenu.name = g_strdup(self->name);
+    e->data.submenu.submenu = self;
+    e->data.submenu.show_from = show_from;
+    return e;
 }
 
-ObMenuEntry *menu_find_entry_by_pos(ObMenu *menu, int x, int y)
+ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
 {
-    if (x < 0 || x >= menu->size.width || y < 0 || y >= menu->size.height)
-        return NULL;
+    ObMenuEntry *e;
+
+    e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
+    e->data.submenu.name = g_strdup(submenu);
 
-    y -= menu->title_h + ob_rr_theme->bwidth;
-    if (y < 0) return NULL;
-    
-    ob_debug("%d %p\n", y/menu->item_h,
-             g_list_nth_data(menu->entries, y / menu->item_h));
-    return g_list_nth_data(menu->entries, y / menu->item_h);
+    self->entries = g_list_append(self->entries, e);
+    self->more_menu->entries = self->entries; /* keep it in sync */
+    return e;
 }
 
-void menu_entry_fire(ObMenuEntry *self, unsigned int button, unsigned int x,
-                     unsigned int y)
+ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
 {
-    ObMenu *m;
+    ObMenuEntry *e;
 
-    /* ignore wheel scrolling */
-    if (button == 4 || button == 5) return;
+    e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
 
-    if (self->action) {
-        self->action->data.any.c = self->parent->client;
-        self->action->func(&self->action->data);
+    menu_entry_set_label(e, label, FALSE);
 
-        /* hide the whole thing */
-        m = self->parent;
-        while (m->parent) m = m->parent;
-        m->hide(m);
-    }
+    self->entries = g_list_append(self->entries, e);
+    self->more_menu->entries = self->entries; /* keep it in sync */
+    return e;
 }
 
-/* 
-   Default menu controller action for showing.
-*/
+void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
+{
+    self->show_func = func;
+}
 
-void menu_control_show(ObMenu *self, int x, int y, ObClient *client)
+void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
 {
-    guint i;
-    Rect *a = NULL;
+    self->hide_func = func;
+}
 
-    g_assert(!self->invalid);
-    
-    for (i = 0; i < screen_num_monitors; ++i) {
-        a = screen_physical_area_monitor(i);
-        if (RECT_CONTAINS(*a, x, y))
-            break;
-    }
-    g_assert(a != NULL);
-    self->xin_area = i;
-
-    POINT_SET(self->location,
-             MIN(x, a->x + a->width - 1 - self->size.width), 
-             MIN(y, a->y + a->height - 1 - self->size.height));
-    XMoveWindow(ob_display, self->frame, self->location.x, self->location.y);
-
-    if (!self->shown) {
-       XMapWindow(ob_display, self->frame);
-        stacking_raise(MENU_AS_WINDOW(self));
-       self->shown = TRUE;
-    } else if (self->shown && self->open_submenu) {
-       self->open_submenu->hide(self->open_submenu);
-    }
+void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
+{
+    self->update_func = func;
 }
 
-void menu_control_mouseover(ObMenuEntry *self, gboolean enter)
+void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
 {
-    int x;
-    Rect *a;
-    ObMenuEntry *e;
+    self->execute_func = func;
+    self->more_menu->execute_func = func; /* keep it in sync */
+}
 
-    g_assert(self != NULL);
-    
-    if (enter) {
-        /* TODO: we prolly don't need open_submenu */
-       if (self->parent->open_submenu && self->submenu 
-           != self->parent->open_submenu)
-        {
-            e = (ObMenuEntry *) self->parent->over->data;
-            e->hilite = FALSE;
-            menu_entry_render(e);
-           self->parent->open_submenu->hide(self->parent->open_submenu);
-        }
-       
-       if (self->submenu && self->parent->open_submenu != self->submenu) {
-           self->parent->open_submenu = self->submenu;
-
-           /* shouldn't be invalid since it must be displayed */
-           g_assert(!self->parent->invalid);
-           /* TODO: I don't understand why these bevels should be here.
-              Something must be wrong in the width calculation */
-           x = self->parent->location.x + self->parent->size.width + 
-               ob_rr_theme->bwidth - ob_rr_theme->menu_overlap;
-
-           /* need to get the width. is this bad?*/
-           self->parent->update(self->submenu);
-
-            a = screen_physical_area_monitor(self->parent->xin_area);
-
-           if (self->submenu->size.width + x >= a->x + a->width) {
-                int newparentx = a->x + a->width
-                    - self->submenu->size.width
-                    - self->parent->size.width
-                    - ob_rr_theme->bwidth
-                    - ob_rr_theme->menu_overlap;
-                
-                x = a->x + a->width - self->submenu->size.width
-                    - ob_rr_theme->menu_overlap;
-                XWarpPointer(ob_display, None, None, 0, 0, 0, 0,
-                             newparentx - self->parent->location.x, 0);
-
-                menu_show_full(self->parent, newparentx,
-                               self->parent->location.y, self->parent->client);
-            }
-           
-           menu_show_full(self->submenu, x,
-                          self->parent->location.y + self->y,
-                           self->parent->client);
-       }
-        self->hilite = TRUE;
-        self->parent->over = g_list_find(self->parent->entries, self);
-        
-    } else
-        self->hilite = FALSE;
-    
-    menu_entry_render(self);
-}
-
-void menu_control_keyboard_nav(unsigned int key)
-{
-    static ObMenu *current_menu = NULL;
-    ObMenuEntry *e = NULL;
-
-    ObKey obkey = OB_NUM_KEYS;
-
-    /* hrmm. could be fixed */
-    if (key == ob_keycode(OB_KEY_DOWN))
-        obkey = OB_KEY_DOWN;
-    else if (key == ob_keycode(OB_KEY_UP))
-        obkey = OB_KEY_UP;
-    else if (key == ob_keycode(OB_KEY_RIGHT)) /* fuck */
-        obkey = OB_KEY_RIGHT;
-    else if (key == ob_keycode(OB_KEY_LEFT)) /* users */
-        obkey = OB_KEY_LEFT;
-    else if (key == ob_keycode(OB_KEY_RETURN))
-        obkey = OB_KEY_RETURN;
-
-    
-    if (current_menu == NULL)
-        current_menu = menu_visible->data;
-    
-    switch (obkey) {
-    case OB_KEY_DOWN: {
-        if (current_menu->over) {
-            current_menu->mouseover(current_menu->over->data, FALSE);
-            current_menu->over = (current_menu->over->next != NULL ?
-                          current_menu->over->next :
-                          current_menu->entries);
-        }
-        else
-            current_menu->over = current_menu->entries;
+void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
+{
+    self->destroy_func = func;
+}
 
-        if (current_menu->over)
-            current_menu->mouseover(current_menu->over->data, TRUE);
-        
-        break;
-    }
-    case OB_KEY_UP: {
-        if (current_menu->over) {
-            current_menu->mouseover(current_menu->over->data, FALSE);
-            current_menu->over = (current_menu->over->prev != NULL ?
-                          current_menu->over->prev :
-                g_list_last(current_menu->entries));
-        } else
-            current_menu->over = g_list_last(current_menu->entries);
+void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
+{
+    self->place_func = func;
+}
 
-        if (current_menu->over)
-            current_menu->mouseover(current_menu->over->data, TRUE);
-        
-        break;
-    }
-    case OB_KEY_RIGHT: {
-        if (current_menu->over == NULL)
-            return;
-        e = (ObMenuEntry *)current_menu->over->data;
-        if (e->submenu) {
-            current_menu->mouseover(e, TRUE);
-            current_menu = e->submenu;
-            current_menu->over = current_menu->entries;
-            if (current_menu->over)
-                current_menu->mouseover(current_menu->over->data, TRUE);
+ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
+{
+    ObMenuEntry *ret = NULL;
+    GList *it;
+
+    for (it = self->entries; it; it = g_list_next(it)) {
+        ObMenuEntry *e = it->data;
+
+        if (e->id == id) {
+            ret = e;
+            break;
         }
-        break;
     }
+    return ret;
+}
 
-    case OB_KEY_RETURN: {
-        if (current_menu->over == NULL)
-            return;
-        e = (ObMenuEntry *)current_menu->over->data;
+void menu_find_submenus(ObMenu *self)
+{
+    GList *it;
 
-        current_menu->mouseover(e, FALSE);
-        current_menu->over = NULL;
-        /* zero is enter */
-        menu_entry_fire(e, 0, 0, 0);
+    for (it = self->entries; it; it = g_list_next(it)) {
+        ObMenuEntry *e = it->data;
+
+        if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
+            e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
     }
-        
-    case OB_KEY_LEFT: {
-        if (current_menu->over != NULL) {
-            current_menu->mouseover(current_menu->over->data, FALSE);
-            current_menu->over = NULL;
-        }
-        
-        current_menu->hide(current_menu);
+}
 
-        if (current_menu->parent)
-            current_menu = current_menu->parent;
-        
+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,
+                           &self->data.normal.shortcut_always_show);
         break;
-    }
     default:
-        ((ObMenu *)menu_visible->data)->hide(menu_visible->data);
-        current_menu = NULL;
+        g_assert_not_reached();
     }
-    return;
 }
 
-void menu_noop()
+void menu_show_all_shortcuts(ObMenu *self, gboolean show)
 {
-    /* This noop brought to you by OLS 2003 Email Garden. */
+    self->show_all_shortcuts = show;
 }