Don't hog the user during the hideDelay
[mikachu/openbox.git] / openbox / menu.c
index 63b74b9..a4f62f6 100644 (file)
@@ -34,7 +34,7 @@
 #include "client_list_menu.h"
 #include "client_list_combined_menu.h"
 #include "gettext.h"
-#include "obt/parse.h"
+#include "obt/xml.h"
 #include "obt/paths.h"
 
 typedef struct _ObMenuParseState ObMenuParseState;
@@ -46,9 +46,10 @@ struct _ObMenuParseState
 };
 
 static GHashTable *menu_hash = NULL;
-static ObtParseInst *menu_parse_inst;
+static ObtXmlInst *menu_parse_inst;
 static ObMenuParseState menu_parse_state;
 static gboolean menu_can_hide = FALSE;
+static guint menu_timeout_id = 0;
 
 static void menu_destroy_hash_value(ObMenu *self);
 static void parse_menu_item(xmlNodePtr node, gpointer data);
@@ -58,14 +59,6 @@ static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
                                gchar **strippedlabel, guint *position,
                                gboolean *always_show);
 
-
-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);
-}
-
 void menu_startup(gboolean reconfig)
 {
     gboolean loaded = FALSE;
@@ -78,54 +71,48 @@ void menu_startup(gboolean reconfig)
     client_list_combined_menu_startup(reconfig);
     client_menu_startup();
 
-    menu_parse_inst = obt_parse_instance_new();
+    menu_parse_inst = obt_xml_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",
+    obt_xml_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
+    obt_xml_register(menu_parse_inst, "item", parse_menu_item,
+                     &menu_parse_state);
+    obt_xml_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"))
+        if (obt_xml_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);
+            obt_xml_tree_from_root(menu_parse_inst);
+            obt_xml_close(menu_parse_inst);
         } else
-            g_message(_("Unable to find a valid menu file '%s'"),
+            g_message(_("Unable to find a valid menu file \"%s\""),
                       (const gchar*)it->data);
     }
     if (!loaded) {
-        if (obt_parse_load_config_file(menu_parse_inst,
-                                       "openbox",
-                                       "menu.xml",
-                                       "openbox_menu"))
+        if (obt_xml_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);
+            obt_xml_tree_from_root(menu_parse_inst);
+            obt_xml_close(menu_parse_inst);
         } else
-            g_message(_("Unable to find a valid menu file '%s'"),
+            g_message(_("Unable to find a valid menu file \"%s\""),
                       "menu.xml");
     }
 
     g_assert(menu_parse_state.parent == NULL);
-
-    if (!reconfig)
-        client_add_destroy_notify(client_dest, NULL);
 }
 
 void menu_shutdown(gboolean reconfig)
 {
-    if (!reconfig)
-        client_remove_destroy_notify(client_dest);
-
-    obt_parse_instance_unref(menu_parse_inst);
+    obt_xml_instance_unref(menu_parse_inst);
     menu_parse_inst = NULL;
 
     client_list_menu_shutdown(reconfig);
@@ -168,21 +155,21 @@ void menu_pipe_execute(ObMenu *self)
         return;
 
     if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
-        g_message(_("Failed to execute command for pipe-menu '%s': %s"),
+        g_message(_("Failed to execute command for pipe-menu \"%s\": %s"),
                   self->execute, err->message);
         g_error_free(err);
         return;
     }
 
-    if (obt_parse_load_mem(menu_parse_inst, output, strlen(output),
-                           "openbox_pipe_menu"))
+    if (obt_xml_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_from_root(menu_parse_inst);
-        obt_parse_close(menu_parse_inst);
+        obt_xml_tree_from_root(menu_parse_inst);
+        obt_xml_close(menu_parse_inst);
     } else {
-        g_message(_("Invalid output from pipe-menu '%s'"), self->execute);
+        g_message(_("Invalid output from pipe-menu \"%s\""), self->execute);
     }
 
     g_free(output);
@@ -195,7 +182,7 @@ static ObMenu* menu_from_name(gchar *name)
     g_assert(name != NULL);
 
     if (!(self = g_hash_table_lookup(menu_hash, name)))
-        g_message(_("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;
 }
@@ -219,6 +206,7 @@ static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
         *strippedlabel = NULL;
     } else {
         gchar *i;
+        gboolean escape;
 
         *strippedlabel = g_strdup(label);
 
@@ -226,7 +214,23 @@ static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
            have to just use the first valid character
         */
 
-        i = strchr(*strippedlabel, '_');
+        /* allow __ to escape an underscore */
+        i = *strippedlabel;
+        do {
+            escape = FALSE;
+            i = strchr(i, '_');
+            if (i && *(i+1) == '_') {
+                gchar *j;
+
+                /* remove the escape '_' from the string */
+                for (j = i; *j != '\0'; ++j)
+                    *j = *(j+1);
+
+                ++i;
+                escape = TRUE;
+            }
+        } while (escape);
+
         if (allow_shortcut && i != NULL) {
             /* there is an underscore in the string */
 
@@ -267,18 +271,48 @@ static void parse_menu_item(xmlNodePtr node,  gpointer data)
 {
     ObMenuParseState *state = data;
     gchar *label;
+    gchar *icon;
+    ObMenuEntry *e;
 
     if (state->parent) {
-        if (obt_parse_attr_string(node, "label", &label)) {
+        /* Don't try to extract "icon" attribute if icons in user-defined
+           menus are not enabled. */
+
+        if (obt_xml_attr_string(node, "label", &label)) {
+            xmlNodePtr c;
             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);
+            c = obt_xml_find_node(node->children, "action");
+            while (c) {
+                ObActionsAct *action = actions_parse(c);
+                if (action)
+                    acts = g_slist_append(acts, action);
+                c = obt_xml_find_node(node->next, "action");
+            }
+            e = menu_add_normal(state->parent, -1, label, acts, TRUE);
+            
+            if (config_menu_show_icons &&
+                obt_xml_attr_string(node, "icon", &icon))
+            {
+                RrImage *ic;
+
+                ic = RrImageCacheFindName(ob_rr_icons, icon);
+                if (ic)
+                    RrImageRef(ic);
+                else {
+                    ic = RrImageNew(ob_rr_icons);
+                    if (!RrImageAddPictureName(ic, icon)) {
+                        RrImageUnref(ic); /* no need to keep it around */
+                        ic = NULL;
+                    }
                 }
-            menu_add_normal(state->parent, -1, label, acts, TRUE);
+                e->data.normal.icon = ic;
+
+                if (e->data.normal.icon)
+                    e->data.normal.icon_alpha = 0xff;
+
+                g_free(icon);
+            }
             g_free(label);
         }
     }
@@ -291,7 +325,7 @@ static void parse_menu_separator(xmlNodePtr node, gpointer data)
     if (state->parent) {
         gchar *label;
 
-        if (!obt_parse_attr_string(node, "label", &label))
+        if (!obt_xml_attr_string(node, "label", &label))
             label = NULL;
 
         menu_add_separator(state->parent, -1, label);
@@ -305,23 +339,23 @@ static void parse_menu(xmlNodePtr node, gpointer data)
     gchar *name = NULL, *title = NULL, *script = NULL;
     ObMenu *menu;
 
-    if (!obt_parse_attr_string(node, "id", &name))
+    if (!obt_xml_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))
+        if (!obt_xml_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)) {
+            if (obt_xml_attr_string(node, "execute", &script)) {
                 menu->execute = obt_paths_expand_tilde(script);
             } else {
                 ObMenu *old;
 
                 old = state->parent;
                 state->parent = menu;
-                obt_parse_tree(menu_parse_inst, node->children);
+                obt_xml_tree(menu_parse_inst, node->children);
                 state->parent = old;
             }
         }
@@ -341,7 +375,7 @@ ObMenu* menu_new(const gchar *name, const gchar *title,
 {
     ObMenu *self;
 
-    self = g_new0(ObMenu, 1);
+    self = g_slice_new0(ObMenu);
     self->name = g_strdup(name);
     self->data = data;
 
@@ -360,7 +394,7 @@ ObMenu* menu_new(const gchar *name, const gchar *title,
 
        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 = g_slice_new0(ObMenu);
     self->more_menu->name = _("More...");
     self->more_menu->title = _("More...");
     self->more_menu->data = data;
@@ -390,9 +424,9 @@ static void menu_destroy_hash_value(ObMenu *self)
     g_free(self->name);
     g_free(self->title);
     g_free(self->execute);
-    g_free(self->more_menu);
+    g_slice_free(ObMenu, self->more_menu);
 
-    g_free(self);
+    g_slice_free(ObMenu, self);
 }
 
 void menu_free(ObMenu *menu)
@@ -404,6 +438,7 @@ void menu_free(ObMenu *menu)
 static gboolean menu_hide_delay_func(gpointer data)
 {
     menu_can_hide = TRUE;
+    menu_timeout_id = 0;
     return FALSE; /* no repeat */
 }
 
@@ -453,10 +488,11 @@ void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
             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);
+            if (menu_timeout_id) g_source_remove(menu_timeout_id);
+            menu_timeout_id = g_timeout_add_full(G_PRIORITY_DEFAULT,
+                                                 config_menu_hide_delay,
+                                                 menu_hide_delay_func,
+                                                 NULL, NULL);
         }
     }
 }
@@ -472,7 +508,7 @@ static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
 
     g_assert(menu);
 
-    self = g_new0(ObMenuEntry, 1);
+    self = g_slice_new0(ObMenuEntry);
     self->ref = 1;
     self->type = type;
     self->menu = menu;
@@ -517,7 +553,7 @@ void menu_entry_unref(ObMenuEntry *self)
             break;
         }
 
-        g_free(self);
+        g_slice_free(ObMenuEntry, self);
     }
 }
 
@@ -621,6 +657,11 @@ void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
     self->more_menu->execute_func = func; /* keep it in sync */
 }
 
+void menu_set_cleanup_func(ObMenu *self, ObMenuCleanupFunc func)
+{
+    self->cleanup_func = func;
+}
+
 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
 {
     self->destroy_func = func;