1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 menu.c for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 See the COPYING file for a copy of the GNU General Public License.
29 #include "menuframe.h"
33 #include "client_menu.h"
34 #include "client_list_menu.h"
35 #include "client_list_combined_menu.h"
38 #include "obt/paths.h"
40 typedef struct _ObMenuParseState ObMenuParseState;
42 struct _ObMenuParseState
48 static GHashTable *menu_hash = NULL;
49 static ObtXmlInst *menu_parse_inst;
50 static ObMenuParseState menu_parse_state;
51 static gboolean menu_can_hide = FALSE;
52 static guint menu_timeout_id = 0;
54 static void menu_destroy_hash_value(ObMenu *self);
55 static void parse_menu_item(xmlNodePtr node, gpointer data);
56 static void parse_menu_separator(xmlNodePtr node, gpointer data);
57 static void parse_menu(xmlNodePtr node, gpointer data);
58 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
59 gchar **strippedlabel, guint *position,
60 gboolean *always_show);
62 void menu_startup(gboolean reconfig)
64 gboolean loaded = FALSE;
67 menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
68 (GDestroyNotify)menu_destroy_hash_value);
70 client_list_menu_startup(reconfig);
71 client_list_combined_menu_startup(reconfig);
72 client_menu_startup();
74 menu_parse_inst = obt_xml_instance_new();
76 menu_parse_state.parent = NULL;
77 menu_parse_state.pipe_creator = NULL;
78 obt_xml_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
79 obt_xml_register(menu_parse_inst, "item", parse_menu_item,
81 obt_xml_register(menu_parse_inst, "separator",
82 parse_menu_separator, &menu_parse_state);
84 for (it = config_menu_files; it; it = g_slist_next(it)) {
85 if (obt_xml_load_config_file(menu_parse_inst,
91 obt_xml_tree_from_root(menu_parse_inst);
92 obt_xml_close(menu_parse_inst);
94 else if (obt_xml_load_file(menu_parse_inst,
99 obt_xml_tree_from_root(menu_parse_inst);
100 obt_xml_close(menu_parse_inst);
103 g_message(_("Unable to find a valid menu file \"%s\""),
104 (const gchar*)it->data);
107 if (obt_xml_load_config_file(menu_parse_inst,
112 obt_xml_tree_from_root(menu_parse_inst);
113 obt_xml_close(menu_parse_inst);
115 g_message(_("Unable to find a valid menu file \"%s\""),
119 g_assert(menu_parse_state.parent == NULL);
122 void menu_shutdown(gboolean reconfig)
124 obt_xml_instance_unref(menu_parse_inst);
125 menu_parse_inst = NULL;
127 menu_frame_hide_all();
129 client_list_combined_menu_shutdown(reconfig);
130 client_list_menu_shutdown(reconfig);
132 g_hash_table_destroy(menu_hash);
136 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
139 return menu->pipe_creator != NULL;
142 static void clear_cache(gpointer key, gpointer val, gpointer data)
146 menu_clear_entries(menu);
149 void menu_clear_pipe_caches(void)
151 /* delete any pipe menus' submenus */
152 g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
153 /* empty the top level pipe menus */
154 g_hash_table_foreach(menu_hash, clear_cache, NULL);
157 void menu_pipe_execute(ObMenu *self)
164 if (self->entries) /* the entries are already created and cached */
167 if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
168 g_message(_("Failed to execute command for pipe-menu \"%s\": %s"),
169 self->execute, err->message);
174 if (obt_xml_load_mem(menu_parse_inst, output, strlen(output),
175 "openbox_pipe_menu"))
177 menu_parse_state.pipe_creator = self;
178 menu_parse_state.parent = self;
179 obt_xml_tree_from_root(menu_parse_inst);
180 obt_xml_close(menu_parse_inst);
182 g_message(_("Invalid output from pipe-menu \"%s\""), self->execute);
188 static ObMenu* menu_from_name(gchar *name)
192 g_assert(name != NULL);
194 if (!(self = g_hash_table_lookup(menu_hash, name)))
195 g_message(_("Attempted to access menu \"%s\" but it does not exist"),
200 #define VALID_SHORTCUT(c) (((c) >= '0' && (c) <= '9') || \
201 ((c) >= 'A' && (c) <= 'Z') || \
202 ((c) >= 'a' && (c) <= 'z'))
204 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
205 gchar **strippedlabel, guint *position,
206 gboolean *always_show)
208 gunichar shortcut = 0;
211 *always_show = FALSE;
213 g_assert(strippedlabel != NULL);
216 *strippedlabel = NULL;
221 *strippedlabel = g_strdup(label);
223 /* if allow_shortcut is false, then you can't use the '_', instead you
224 have to just use the first valid character
227 /* allow __ to escape an underscore */
232 if (i && *(i+1) == '_') {
235 /* remove the escape '_' from the string */
236 for (j = i; *j != '\0'; ++j)
244 if (allow_shortcut && i != NULL) {
245 /* there is an underscore in the string */
247 /* you have to use a printable ascii character for shortcuts
248 don't allow space either, so you can have like "a _ b"
250 if (VALID_SHORTCUT(*(i+1))) {
251 shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
252 *position = i - *strippedlabel;
255 /* remove the '_' from the string */
256 for (; *i != '\0'; ++i)
258 } else if (*(i+1) == '\0') {
259 /* no default shortcut if the '_' is the last character
260 (eg. "Exit_") for menu entries that you don't want
261 to be executed by mistake
266 /* there is no underscore, so find the first valid character to use
269 for (i = *strippedlabel; *i != '\0'; ++i)
270 if (VALID_SHORTCUT(*i)) {
271 *position = i - *strippedlabel;
272 shortcut = g_unichar_tolower(g_utf8_get_char(i));
280 static void parse_menu_item(xmlNodePtr node, gpointer data)
282 ObMenuParseState *state = data;
288 /* Don't try to extract "icon" attribute if icons in user-defined
289 menus are not enabled. */
291 if (obt_xml_attr_string_unstripped(node, "label", &label)) {
295 c = obt_xml_find_node(node->children, "action");
297 ObActionsAct *action = actions_parse(c);
299 acts = g_slist_append(acts, action);
300 c = obt_xml_find_node(c->next, "action");
302 e = menu_add_normal(state->parent, -1, label, acts, TRUE);
304 if (config_menu_show_icons &&
305 obt_xml_attr_string(node, "icon", &icon))
307 e->data.normal.icon = RrImageNewFromName(ob_rr_icons, icon);
309 if (e->data.normal.icon)
310 e->data.normal.icon_alpha = 0xff;
319 static void parse_menu_separator(xmlNodePtr node, gpointer data)
321 ObMenuParseState *state = data;
326 if (!obt_xml_attr_string_unstripped(node, "label", &label))
329 menu_add_separator(state->parent, -1, label);
334 static void parse_menu(xmlNodePtr node, gpointer data)
336 ObMenuParseState *state = data;
337 gchar *name = NULL, *title = NULL, *script = NULL;
342 if (!obt_xml_attr_string(node, "id", &name))
343 goto parse_menu_fail;
345 if (!g_hash_table_lookup(menu_hash, name)) {
346 if (!obt_xml_attr_string_unstripped(node, "label", &title))
347 goto parse_menu_fail;
349 if ((menu = menu_new(name, title, TRUE, NULL))) {
350 menu->pipe_creator = state->pipe_creator;
351 if (obt_xml_attr_string(node, "execute", &script)) {
352 menu->execute = obt_paths_expand_tilde(script);
357 state->parent = menu;
358 obt_xml_tree(menu_parse_inst, node->children);
365 e = menu_add_submenu(state->parent, -1, name);
367 if (config_menu_show_icons &&
368 obt_xml_attr_string(node, "icon", &icon))
370 e->data.submenu.icon = RrImageNewFromName(ob_rr_icons, icon);
372 if (e->data.submenu.icon)
373 e->data.submenu.icon_alpha = 0xff;
385 ObMenu* menu_new(const gchar *name, const gchar *title,
386 gboolean allow_shortcut_selection, gpointer data)
390 self = g_slice_new0(ObMenu);
391 self->name = g_strdup(name);
394 self->shortcut = parse_shortcut(title, allow_shortcut_selection,
395 &self->title, &self->shortcut_position,
396 &self->shortcut_always_show);
397 self->collate_key = g_utf8_collate_key(self->title, -1);
399 g_hash_table_replace(menu_hash, self->name, self);
401 /* Each menu has a single more_menu. When the menu spills past what
402 can fit on the screen, a new menu frame entry is created from this
403 more_menu, and a new menu frame for the submenu is created for this
404 menu, also pointing to the more_menu.
406 This can be done multiple times using the same more_menu.
408 more_menu->more_menu will always be NULL, since there is only 1 for
410 self->more_menu = g_slice_new0(ObMenu);
411 self->more_menu->name = _("More...");
412 self->more_menu->title = _("More...");
413 self->more_menu->collate_key = "\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff";
414 self->more_menu->data = data;
415 self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
420 static void menu_destroy_hash_value(ObMenu *self)
422 /* make sure its not visible */
427 for (it = menu_frame_visible; it; it = g_list_next(it)) {
430 menu_frame_hide_all();
434 if (self->destroy_func)
435 self->destroy_func(self, self->data);
437 menu_clear_entries(self);
440 g_free(self->collate_key);
441 g_free(self->execute);
442 g_slice_free(ObMenu, self->more_menu);
444 g_slice_free(ObMenu, self);
447 void menu_free(ObMenu *menu)
450 g_hash_table_remove(menu_hash, menu->name);
453 static gboolean menu_hide_delay_func(gpointer data)
455 menu_can_hide = TRUE;
458 return FALSE; /* no repeat */
461 void menu_show(gchar *name, const GravityPoint *pos, gint monitor,
462 gboolean mouse, gboolean user_positioned, ObClient *client)
467 if (!(self = menu_from_name(name)) ||
468 grab_on_keyboard() || grab_on_pointer()) return;
470 /* if the requested menu is already the top visible menu, then don't
472 if (menu_frame_visible) {
473 frame = menu_frame_visible->data;
474 if (frame->menu == self)
478 menu_frame_hide_all();
480 /* clear the pipe menus when showing a new menu */
481 menu_clear_pipe_caches();
483 frame = menu_frame_new(self, 0, client);
484 if (!menu_frame_show_topmenu(frame, pos, monitor, mouse, user_positioned))
485 menu_frame_free(frame);
488 /* select the first entry if it's not a submenu and we opened
489 * the menu with the keyboard, and skip all headers */
490 GList *it = frame->entries;
492 ObMenuEntryFrame *e = it->data;
493 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
494 menu_frame_select(frame, e, FALSE);
496 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
497 it = g_list_next(it);
503 /* reset the hide timer */
505 menu_can_hide = TRUE;
507 menu_can_hide = FALSE;
508 if (menu_timeout_id) g_source_remove(menu_timeout_id);
509 menu_timeout_id = g_timeout_add_full(G_PRIORITY_DEFAULT,
510 config_menu_hide_delay,
511 menu_hide_delay_func,
517 gboolean menu_hide_delay_reached(void)
519 return menu_can_hide;
522 void menu_hide_delay_reset(void)
524 if (menu_timeout_id) g_source_remove(menu_timeout_id);
525 menu_hide_delay_func(NULL);
528 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
534 self = g_slice_new0(ObMenuEntry);
541 case OB_MENU_ENTRY_TYPE_NORMAL:
542 self->data.normal.enabled = TRUE;
544 case OB_MENU_ENTRY_TYPE_SUBMENU:
545 case OB_MENU_ENTRY_TYPE_SEPARATOR:
552 void menu_entry_ref(ObMenuEntry *self)
557 void menu_entry_unref(ObMenuEntry *self)
559 if (self && --self->ref == 0) {
560 switch (self->type) {
561 case OB_MENU_ENTRY_TYPE_NORMAL:
562 RrImageUnref(self->data.normal.icon);
563 g_free(self->data.normal.label);
564 g_free(self->data.normal.collate_key);
565 while (self->data.normal.actions) {
566 actions_act_unref(self->data.normal.actions->data);
567 self->data.normal.actions =
568 g_slist_delete_link(self->data.normal.actions,
569 self->data.normal.actions);
572 case OB_MENU_ENTRY_TYPE_SUBMENU:
573 RrImageUnref(self->data.submenu.icon);
574 g_free(self->data.submenu.name);
576 case OB_MENU_ENTRY_TYPE_SEPARATOR:
577 g_free(self->data.separator.label);
581 g_slice_free(ObMenuEntry, self);
585 void menu_clear_entries(ObMenu *self)
588 /* assert that the menu isn't visible */
593 for (it = menu_frame_visible; it; it = g_list_next(it)) {
595 g_assert(f->menu != self);
600 while (self->entries) {
601 menu_entry_unref(self->entries->data);
602 self->entries = g_list_delete_link(self->entries, self->entries);
604 self->more_menu->entries = self->entries; /* keep it in sync */
607 void menu_entry_remove(ObMenuEntry *self)
609 self->menu->entries = g_list_remove(self->menu->entries, self);
610 menu_entry_unref(self);
613 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
614 GSList *actions, gboolean allow_shortcut)
618 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
619 e->data.normal.actions = actions;
621 menu_entry_set_label(e, label, allow_shortcut);
623 self->entries = g_list_append(self->entries, e);
624 self->more_menu->entries = self->entries; /* keep it in sync */
628 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
631 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
632 /* points to itself */
633 e->data.submenu.name = g_strdup(self->name);
634 e->data.submenu.submenu = self;
635 e->data.submenu.show_from = show_from;
639 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
643 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
644 e->data.submenu.name = g_strdup(submenu);
646 self->entries = g_list_append(self->entries, e);
647 self->more_menu->entries = self->entries; /* keep it in sync */
651 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
655 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
657 menu_entry_set_label(e, label, FALSE);
659 self->entries = g_list_append(self->entries, e);
660 self->more_menu->entries = self->entries; /* keep it in sync */
664 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
666 self->show_func = func;
669 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
671 self->hide_func = func;
674 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
676 self->update_func = func;
679 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
681 self->execute_func = func;
682 self->more_menu->execute_func = func; /* keep it in sync */
685 void menu_set_cleanup_func(ObMenu *self, ObMenuCleanupFunc func)
687 self->cleanup_func = func;
690 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
692 self->destroy_func = func;
695 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
697 self->place_func = func;
700 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
702 ObMenuEntry *ret = NULL;
705 for (it = self->entries; it; it = g_list_next(it)) {
706 ObMenuEntry *e = it->data;
716 void menu_find_submenus(ObMenu *self)
720 for (it = self->entries; it; it = g_list_next(it)) {
721 ObMenuEntry *e = it->data;
723 if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
724 e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
728 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
729 gboolean allow_shortcut)
731 switch (self->type) {
732 case OB_MENU_ENTRY_TYPE_SEPARATOR:
733 g_free(self->data.separator.label);
734 self->data.separator.label = g_strdup(label);
736 case OB_MENU_ENTRY_TYPE_NORMAL:
737 g_free(self->data.normal.label);
738 g_free(self->data.normal.collate_key);
739 self->data.normal.shortcut =
740 parse_shortcut(label, allow_shortcut, &self->data.normal.label,
741 &self->data.normal.shortcut_position,
742 &self->data.normal.shortcut_always_show);
743 self->data.normal.collate_key =
744 g_utf8_collate_key(self->data.normal.label, -1);
747 g_assert_not_reached();
751 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
753 self->show_all_shortcuts = show;
756 static int sort_func(const void *a, const void *b) {
757 const ObMenuEntry *e[2] = {*(ObMenuEntry**)a, *(ObMenuEntry**)b};
761 for (i = 0; i < 2; ++i) {
762 if (e[i]->type == OB_MENU_ENTRY_TYPE_NORMAL)
763 k[i] = e[i]->data.normal.collate_key;
765 g_assert(e[i]->type == OB_MENU_ENTRY_TYPE_SUBMENU);
766 if (e[i]->data.submenu.submenu)
767 k[i] = e[i]->data.submenu.submenu->collate_key;
769 return -1; /* arbitrary really.. the submenu doesn't exist. */
772 return strcmp(k[0], k[1]);
776 @param start The first entry in the range to sort.
777 @param end The last entry in the range to sort.
779 static void sort_range(ObMenu *self, GList *start, GList *end, guint len)
786 ar = g_slice_alloc(sizeof(ObMenuEntry*) * len);
787 for (i = 0, it = start; it != g_list_next(end); ++i, it = g_list_next(it))
789 qsort(ar, len, sizeof(ObMenuEntry*), sort_func);
790 for (i = 0, it = start; it != g_list_next(end); ++i, it = g_list_next(it))
792 g_slice_free1(sizeof(ObMenuEntry*) * len, ar);
795 void menu_sort_entries(ObMenu *self)
797 GList *it, *start, *end, *last;
800 /* need the submenus to know their labels for sorting */
801 menu_find_submenus(self);
803 start = self->entries;
805 for (it = self->entries; it; it = g_list_next(it)) {
806 ObMenuEntry *e = it->data;
807 if (e->type == OB_MENU_ENTRY_TYPE_SEPARATOR) {
808 end = g_list_previous(it);
809 sort_range(self, start, end, len);
811 it = g_list_next(it); /* skip over the separator */
819 sort_range(self, start, last, len);