Allow escaping _ in menu labels by putting __
[mikachu/openbox.git] / openbox / menu.c
index c411101..58b6280 100644 (file)
@@ -59,8 +59,8 @@ static void parse_menu_separator(ObParseInst *i,
 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);
-
+                               gchar **strippedlabel, guint *position,
+                               gboolean *always_show);
 
 static void client_dest(ObClient *client, gpointer data)
 {
@@ -99,7 +99,7 @@ void menu_startup(gboolean reconfig)
             parse_tree(menu_parse_inst, doc, node->children);
             xmlFreeDoc(doc);
         } 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) {
@@ -107,10 +107,10 @@ void menu_startup(gboolean reconfig)
             parse_tree(menu_parse_inst, doc, node->children);
             xmlFreeDoc(doc);
         } 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)
@@ -146,7 +146,7 @@ static void clear_cache(gpointer key, gpointer val, gpointer data)
         menu_clear_entries(menu);
 }
 
-void menu_clear_pipe_caches()
+void menu_clear_pipe_caches(void)
 {
     /* delete any pipe menus' submenus */
     g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
@@ -167,7 +167,7 @@ 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;
@@ -181,7 +181,7 @@ void menu_pipe_execute(ObMenu *self)
         parse_tree(menu_parse_inst, doc, node->children);
         xmlFreeDoc(doc);
     } else {
-        g_message(_("Invalid output from pipe-menu '%s'"), self->execute);
+        g_message(_("Invalid output from pipe-menu \"%s\""), self->execute);
     }
 
     g_free(output);
@@ -194,21 +194,23 @@ 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;
-}  
+}
 
 #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)
+                               gchar **strippedlabel, guint *position,
+                               gboolean *always_show)
 {
     gunichar shortcut = 0;
-    
+
     *position = 0;
+    *always_show = FALSE;
 
     g_assert(strippedlabel != NULL);
 
@@ -219,27 +221,37 @@ static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
 
         *strippedlabel = g_strdup(label);
 
-        /* if allow_shortcut is false, then you can't use the &, instead you
+        /* if allow_shortcut is false, then you can't use the '_', instead you
            have to just use the first valid character
         */
 
-        i = strchr(*strippedlabel, '&');
+        i = strchr(*strippedlabel, '_');
         if (allow_shortcut && i != NULL) {
-            /* there is an ampersand in the string */
+            /* 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"
+               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;
+            if (VALID_SHORTCUT(*(i+1)) || *(i+1) == '_') {
+                /* Allow you to escape the first _ by putting __ */
+                if (*(i+1) != '_') {
+                    shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
+                    *position = i - *strippedlabel;
+                    *always_show = TRUE;
+                }
 
-                /* remove the & from the string */
+                /* 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 ampersand, so find the first valid character to use
+            /* there is no underscore, so find the first valid character to use
                instead */
 
             for (i = *strippedlabel; *i != '\0'; ++i)
@@ -258,7 +270,7 @@ static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 {
     ObMenuParseState *state = data;
     gchar *label;
-    
+
     if (state->parent) {
         if (parse_attr_string("label", node, &label)) {
             GSList *acts = NULL;
@@ -269,7 +281,7 @@ static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
                     if (a)
                         acts = g_slist_append(acts, a);
                 }
-            menu_add_normal(state->parent, -1, label, acts, FALSE);
+            menu_add_normal(state->parent, -1, label, acts, TRUE);
             g_free(label);
         }
     }
@@ -306,7 +318,7 @@ 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, FALSE, NULL))) {
+        if ((menu = menu_new(name, title, TRUE, NULL))) {
             menu->pipe_creator = state->pipe_creator;
             if (parse_attr_string("execute", node, &script)) {
                 menu->execute = parse_expand_tilde(script);
@@ -340,7 +352,8 @@ ObMenu* menu_new(const gchar *name, const gchar *title,
     self->data = data;
 
     self->shortcut = parse_shortcut(title, allow_shortcut_selection,
-                                    &self->title, &self->shortcut_position);
+                                    &self->title, &self->shortcut_position,
+                                    &self->shortcut_always_show);
 
     g_hash_table_replace(menu_hash, self->name, self);
 
@@ -359,13 +372,6 @@ ObMenu* menu_new(const gchar *name, const gchar *title,
     self->more_menu->data = data;
     self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
 
-    self->more_menu->show_func = self->show_func;
-    self->more_menu->hide_func = self->hide_func;
-    self->more_menu->update_func = self->update_func;
-    self->more_menu->execute_func = self->execute_func;
-    self->more_menu->destroy_func = self->destroy_func;
-    self->more_menu->place_func = self->place_func;
-
     return self;
 }
 
@@ -407,7 +413,7 @@ static gboolean menu_hide_delay_func(gpointer data)
     return FALSE; /* no repeat */
 }
 
-void menu_show(gchar *name, gint x, gint y, gint button, ObClient *client)
+void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
 {
     ObMenu *self;
     ObMenuFrame *frame;
@@ -429,10 +435,10 @@ void menu_show(gchar *name, gint x, gint y, gint button, ObClient *client)
     menu_clear_pipe_caches();
 
     frame = menu_frame_new(self, 0, client);
-    if (!menu_frame_show_topmenu(frame, x, y, button))
+    if (!menu_frame_show_topmenu(frame, x, y, mouse))
         menu_frame_free(frame);
     else {
-        if (!button) {
+        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;
@@ -449,7 +455,7 @@ void menu_show(gchar *name, gint x, gint y, gint button, ObClient *client)
         }
 
         /* reset the hide timer */
-        if (!button)
+        if (!mouse)
             menu_can_hide = TRUE;
         else {
             menu_can_hide = FALSE;
@@ -461,7 +467,7 @@ void menu_show(gchar *name, gint x, gint y, gint button, ObClient *client)
     }
 }
 
-gboolean menu_hide_delay_reached()
+gboolean menu_hide_delay_reached(void)
 {
     return menu_can_hide;
 }
@@ -500,6 +506,7 @@ void menu_entry_unref(ObMenuEntry *self)
     if (self && --self->ref == 0) {
         switch (self->type) {
         case OB_MENU_ENTRY_TYPE_NORMAL:
+            RrImageUnref(self->data.normal.icon);
             g_free(self->data.normal.label);
             while (self->data.normal.actions) {
                 actions_act_unref(self->data.normal.actions->data);
@@ -512,6 +519,7 @@ void menu_entry_unref(ObMenuEntry *self)
             g_free(self->data.submenu.name);
             break;
         case OB_MENU_ENTRY_TYPE_SEPARATOR:
+            g_free(self->data.separator.label);
             break;
         }
 
@@ -601,19 +609,16 @@ ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
 {
     self->show_func = func;
-    self->more_menu->show_func = func; /* keep it in sync */
 }
 
 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
 {
     self->hide_func = func;
-    self->more_menu->hide_func = func; /* keep it in sync */
 }
 
 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
 {
     self->update_func = func;
-    self->more_menu->update_func = func; /* keep it in sync */
 }
 
 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
@@ -625,13 +630,11 @@ void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
 {
     self->destroy_func = func;
-    self->more_menu->destroy_func = func; /* keep it in sync */
 }
 
 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
 {
     self->place_func = func;
-    self->more_menu->place_func = func; /* keep it in sync */
 }
 
 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
@@ -674,7 +677,8 @@ void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
         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_position,
+                           &self->data.normal.shortcut_always_show);
         break;
     default:
         g_assert_not_reached();