add menu_sort_entries() which sorts all entries in an ObMenu
[dana/openbox.git] / openbox / menu.c
index 432aa2b..7d8f0ba 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,60 +71,55 @@ 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\""),
                       (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\""),
                       "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);
+    menu_frame_hide_all();
+
     client_list_combined_menu_shutdown(reconfig);
+    client_list_menu_shutdown(reconfig);
 
-    menu_frame_hide_all();
     g_hash_table_destroy(menu_hash);
     menu_hash = NULL;
 }
@@ -174,13 +162,13 @@ void menu_pipe_execute(ObMenu *self)
         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);
     }
@@ -219,6 +207,7 @@ static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
         *strippedlabel = NULL;
     } else {
         gchar *i;
+        gboolean escape;
 
         *strippedlabel = g_strdup(label);
 
@@ -226,7 +215,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 +272,36 @@ 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);
-                }
-            menu_add_normal(state->parent, -1, label, acts, TRUE);
+            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(c->next, "action");
+            }
+            e = menu_add_normal(state->parent, -1, label, acts, TRUE);
+            
+            if (config_menu_show_icons &&
+                obt_xml_attr_string(node, "icon", &icon))
+            {
+                e->data.normal.icon = RrImageNewFromName(ob_rr_icons, icon);
+
+                if (e->data.normal.icon)
+                    e->data.normal.icon_alpha = 0xff;
+
+                g_free(icon);
+            }
             g_free(label);
         }
     }
@@ -291,7 +314,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);
@@ -304,31 +327,45 @@ static void parse_menu(xmlNodePtr node, gpointer data)
     ObMenuParseState *state = data;
     gchar *name = NULL, *title = NULL, *script = NULL;
     ObMenu *menu;
+    ObMenuEntry *e;
+    gchar *icon;
 
-    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;
             }
         }
     }
 
-    if (state->parent)
-        menu_add_submenu(state->parent, -1, name);
+    if (state->parent) {
+        e = menu_add_submenu(state->parent, -1, name);
+
+        if (config_menu_show_icons &&
+            obt_xml_attr_string(node, "icon", &icon))
+        {
+            e->data.submenu.icon = RrImageNewFromName(ob_rr_icons, icon);
+
+            if (e->data.submenu.icon)
+                e->data.submenu.icon_alpha = 0xff;
+
+            g_free(icon);
+        }
+    }
 
 parse_menu_fail:
     g_free(name);
@@ -341,13 +378,14 @@ 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;
 
     self->shortcut = parse_shortcut(title, allow_shortcut_selection,
                                     &self->title, &self->shortcut_position,
                                     &self->shortcut_always_show);
+    self->collate_key = g_utf8_collate_key(self->title, -1);
 
     g_hash_table_replace(menu_hash, self->name, self);
 
@@ -360,9 +398,10 @@ 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->collate_key = "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff";
     self->more_menu->data = data;
     self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
 
@@ -389,10 +428,11 @@ static void menu_destroy_hash_value(ObMenu *self)
     menu_clear_entries(self);
     g_free(self->name);
     g_free(self->title);
+    g_free(self->collate_key);
     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 +444,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 +494,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 +514,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;
@@ -502,6 +544,7 @@ void menu_entry_unref(ObMenuEntry *self)
         case OB_MENU_ENTRY_TYPE_NORMAL:
             RrImageUnref(self->data.normal.icon);
             g_free(self->data.normal.label);
+            g_free(self->data.normal.collate_key);
             while (self->data.normal.actions) {
                 actions_act_unref(self->data.normal.actions->data);
                 self->data.normal.actions =
@@ -510,6 +553,7 @@ void menu_entry_unref(ObMenuEntry *self)
             }
             break;
         case OB_MENU_ENTRY_TYPE_SUBMENU:
+            RrImageUnref(self->data.submenu.icon);
             g_free(self->data.submenu.name);
             break;
         case OB_MENU_ENTRY_TYPE_SEPARATOR:
@@ -517,7 +561,7 @@ void menu_entry_unref(ObMenuEntry *self)
             break;
         }
 
-        g_free(self);
+        g_slice_free(ObMenuEntry, self);
     }
 }
 
@@ -621,6 +665,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;
@@ -669,10 +718,13 @@ void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
         break;
     case OB_MENU_ENTRY_TYPE_NORMAL:
         g_free(self->data.normal.label);
+        g_free(self->data.normal.collate_key);
         self->data.normal.shortcut =
             parse_shortcut(label, allow_shortcut, &self->data.normal.label,
                            &self->data.normal.shortcut_position,
                            &self->data.normal.shortcut_always_show);
+        self->data.normal.collate_key =
+            g_utf8_collate_key(self->data.normal.label, -1);
         break;
     default:
         g_assert_not_reached();
@@ -683,3 +735,69 @@ void menu_show_all_shortcuts(ObMenu *self, gboolean show)
 {
     self->show_all_shortcuts = show;
 }
+
+static int sort_func(const void *a, const void *b) {
+    const ObMenuEntry *e[2] = {*(ObMenuEntry**)a, *(ObMenuEntry**)b};
+    const gchar *k[2];
+    gint i;
+
+    for (i = 0; i < 2; ++i) {
+        if (e[i]->type == OB_MENU_ENTRY_TYPE_NORMAL)
+            k[i] = e[i]->data.normal.collate_key;
+        else {
+            g_assert(e[i]->type == OB_MENU_ENTRY_TYPE_SUBMENU);
+            if (e[i]->data.submenu.submenu)
+                k[i] = e[i]->data.submenu.submenu->collate_key;
+            else
+                return -1; /* arbitrary really.. the submenu doesn't exist. */
+        }
+    }
+    return strcmp(k[0], k[1]);
+}
+
+/*!
+  @param start The first entry in the range to sort.
+  @param end The last entry in the range to sort.
+*/
+static void sort_range(ObMenu *self, GList *start, GList *end, guint len)
+{
+    ObMenuEntry **ar;
+    GList *it;
+    guint i;
+    if (!len) return;
+
+    ar = g_slice_alloc(sizeof(ObMenuEntry*) * len);
+    for (i = 0, it = start; it != g_list_next(end); ++i, it = g_list_next(it))
+        ar[i] = it->data;
+    qsort(ar, len, sizeof(ObMenuEntry*), sort_func);
+    for (i = 0, it = start; it != g_list_next(end); ++i, it = g_list_next(it))
+        it->data = ar[i];
+    g_slice_free1(sizeof(ObMenuEntry*) * len, ar);
+}
+
+void menu_sort_entries(ObMenu *self)
+{
+    GList *it, *start, *end, *last;
+    guint len;
+
+    /* need the submenus to know their labels for sorting */
+    menu_find_submenus(self);
+
+    start = self->entries;
+    len = 0;
+    for (it = self->entries; it; it = g_list_next(it)) {
+        ObMenuEntry *e = it->data;
+        if (e->type == OB_MENU_ENTRY_TYPE_SEPARATOR) {
+            end = g_list_previous(it);
+            sort_range(self, start, end, len);
+
+            it = g_list_next(it); /* skip over the separator */
+            start = it;
+            len = 0;
+        }
+        else
+            len += 1;
+        last = it;
+    }
+    sort_range(self, start, last, len);
+}