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.
30 #include "menuframe.h"
34 #include "client_menu.h"
35 #include "client_list_menu.h"
36 #include "client_list_combined_menu.h"
38 #include "parser/parse.h"
40 typedef struct _ObMenuParseState ObMenuParseState;
42 struct _ObMenuParseState
48 static GHashTable *menu_hash = NULL;
49 static ObParseInst *menu_parse_inst;
50 static ObMenuParseState menu_parse_state;
51 static gboolean menu_can_hide = FALSE;
53 static void menu_destroy_hash_value(ObMenu *self);
54 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
56 static void parse_menu_separator(ObParseInst *i,
57 xmlDocPtr doc, xmlNodePtr node,
59 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
61 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
62 gchar **strippedlabel, guint *position,
63 gboolean *always_show);
65 void menu_startup(gboolean reconfig)
69 gboolean loaded = FALSE;
72 menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
73 (GDestroyNotify)menu_destroy_hash_value);
75 client_list_menu_startup(reconfig);
76 client_list_combined_menu_startup(reconfig);
77 client_menu_startup();
79 menu_parse_inst = parse_startup();
81 menu_parse_state.parent = NULL;
82 menu_parse_state.pipe_creator = NULL;
83 parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
84 parse_register(menu_parse_inst, "item", parse_menu_item,
86 parse_register(menu_parse_inst, "separator",
87 parse_menu_separator, &menu_parse_state);
89 for (it = config_menu_files; it; it = g_slist_next(it)) {
90 if (parse_load_menu(it->data, &doc, &node)) {
92 parse_tree(menu_parse_inst, doc, node->children);
95 g_message(_("Unable to find a valid menu file \"%s\""),
96 (const gchar*)it->data);
99 if (parse_load_menu("menu.xml", &doc, &node)) {
100 parse_tree(menu_parse_inst, doc, node->children);
103 g_message(_("Unable to find a valid menu file \"%s\""),
107 g_assert(menu_parse_state.parent == NULL);
110 void menu_shutdown(gboolean reconfig)
112 parse_shutdown(menu_parse_inst);
113 menu_parse_inst = NULL;
115 client_list_menu_shutdown(reconfig);
116 client_list_combined_menu_shutdown(reconfig);
118 menu_frame_hide_all();
119 g_hash_table_destroy(menu_hash);
123 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
126 return menu->pipe_creator != NULL;
129 static void clear_cache(gpointer key, gpointer val, gpointer data)
133 menu_clear_entries(menu);
136 void menu_clear_pipe_caches(void)
138 /* delete any pipe menus' submenus */
139 g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
140 /* empty the top level pipe menus */
141 g_hash_table_foreach(menu_hash, clear_cache, NULL);
144 void menu_pipe_execute(ObMenu *self)
153 if (self->entries) /* the entries are already created and cached */
156 if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
157 g_message(_("Failed to execute command for pipe-menu \"%s\": %s"),
158 self->execute, err->message);
163 if (parse_load_mem(output, strlen(output),
164 "openbox_pipe_menu", &doc, &node))
166 menu_parse_state.pipe_creator = self;
167 menu_parse_state.parent = self;
168 parse_tree(menu_parse_inst, doc, node->children);
171 g_message(_("Invalid output from pipe-menu \"%s\""), self->execute);
177 static ObMenu* menu_from_name(gchar *name)
181 g_assert(name != NULL);
183 if (!(self = g_hash_table_lookup(menu_hash, name)))
184 g_message(_("Attempted to access menu \"%s\" but it does not exist"),
189 #define VALID_SHORTCUT(c) (((c) >= '0' && (c) <= '9') || \
190 ((c) >= 'A' && (c) <= 'Z') || \
191 ((c) >= 'a' && (c) <= 'z'))
193 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
194 gchar **strippedlabel, guint *position,
195 gboolean *always_show)
197 gunichar shortcut = 0;
200 *always_show = FALSE;
202 g_assert(strippedlabel != NULL);
205 *strippedlabel = NULL;
210 *strippedlabel = g_strdup(label);
212 /* if allow_shortcut is false, then you can't use the '_', instead you
213 have to just use the first valid character
216 /* allow __ to escape an underscore */
221 if (i && *(i+1) == '_') {
224 /* remove the escape '_' from the string */
225 for (j = i; *j != '\0'; ++j)
233 if (allow_shortcut && i != NULL) {
234 /* there is an underscore in the string */
236 /* you have to use a printable ascii character for shortcuts
237 don't allow space either, so you can have like "a _ b"
239 if (VALID_SHORTCUT(*(i+1))) {
240 shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
241 *position = i - *strippedlabel;
244 /* remove the '_' from the string */
245 for (; *i != '\0'; ++i)
247 } else if (*(i+1) == '\0') {
248 /* no default shortcut if the '_' is the last character
249 (eg. "Exit_") for menu entries that you don't want
250 to be executed by mistake
255 /* there is no underscore, so find the first valid character to use
258 for (i = *strippedlabel; *i != '\0'; ++i)
259 if (VALID_SHORTCUT(*i)) {
260 *position = i - *strippedlabel;
261 shortcut = g_unichar_tolower(g_utf8_get_char(i));
269 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
272 ObMenuParseState *state = data;
276 if (parse_attr_string("label", node, &label)) {
279 for (node = node->children; node; node = node->next)
280 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
281 ObActionsAct *a = actions_parse(i, doc, node);
283 acts = g_slist_append(acts, a);
285 menu_add_normal(state->parent, -1, label, acts, TRUE);
291 static void parse_menu_separator(ObParseInst *i,
292 xmlDocPtr doc, xmlNodePtr node,
295 ObMenuParseState *state = data;
300 if (!parse_attr_string("label", node, &label))
303 menu_add_separator(state->parent, -1, label);
308 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
311 ObMenuParseState *state = data;
312 gchar *name = NULL, *title = NULL, *script = NULL;
315 if (!parse_attr_string("id", node, &name))
316 goto parse_menu_fail;
318 if (!g_hash_table_lookup(menu_hash, name)) {
319 if (!parse_attr_string("label", node, &title))
320 goto parse_menu_fail;
322 if ((menu = menu_new(name, title, TRUE, NULL))) {
323 menu->pipe_creator = state->pipe_creator;
324 if (parse_attr_string("execute", node, &script)) {
325 menu->execute = parse_expand_tilde(script);
330 state->parent = menu;
331 parse_tree(i, doc, node->children);
338 menu_add_submenu(state->parent, -1, name);
346 ObMenu* menu_new(const gchar *name, const gchar *title,
347 gboolean allow_shortcut_selection, gpointer data)
351 self = g_new0(ObMenu, 1);
352 self->name = g_strdup(name);
355 self->shortcut = parse_shortcut(title, allow_shortcut_selection,
356 &self->title, &self->shortcut_position,
357 &self->shortcut_always_show);
359 g_hash_table_replace(menu_hash, self->name, self);
361 /* Each menu has a single more_menu. When the menu spills past what
362 can fit on the screen, a new menu frame entry is created from this
363 more_menu, and a new menu frame for the submenu is created for this
364 menu, also pointing to the more_menu.
366 This can be done multiple times using the same more_menu.
368 more_menu->more_menu will always be NULL, since there is only 1 for
370 self->more_menu = g_new0(ObMenu, 1);
371 self->more_menu->name = _("More...");
372 self->more_menu->title = _("More...");
373 self->more_menu->data = data;
374 self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
379 static void menu_destroy_hash_value(ObMenu *self)
381 /* make sure its not visible */
386 for (it = menu_frame_visible; it; it = g_list_next(it)) {
389 menu_frame_hide_all();
393 if (self->destroy_func)
394 self->destroy_func(self, self->data);
396 menu_clear_entries(self);
399 g_free(self->execute);
400 g_free(self->more_menu);
405 void menu_free(ObMenu *menu)
408 g_hash_table_remove(menu_hash, menu->name);
411 static gboolean menu_hide_delay_func(gpointer data)
413 menu_can_hide = TRUE;
414 return FALSE; /* no repeat */
417 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
422 if (!(self = menu_from_name(name)) ||
423 grab_on_keyboard() || grab_on_pointer()) return;
425 /* if the requested menu is already the top visible menu, then don't
427 if (menu_frame_visible) {
428 frame = menu_frame_visible->data;
429 if (frame->menu == self)
433 menu_frame_hide_all();
435 /* clear the pipe menus when showing a new menu */
436 menu_clear_pipe_caches();
438 frame = menu_frame_new(self, 0, client);
439 if (!menu_frame_show_topmenu(frame, x, y, mouse))
440 menu_frame_free(frame);
443 /* select the first entry if it's not a submenu and we opened
444 * the menu with the keyboard, and skip all headers */
445 GList *it = frame->entries;
447 ObMenuEntryFrame *e = it->data;
448 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
449 menu_frame_select(frame, e, FALSE);
451 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
452 it = g_list_next(it);
458 /* reset the hide timer */
460 menu_can_hide = TRUE;
462 menu_can_hide = FALSE;
463 ob_main_loop_timeout_add(ob_main_loop,
464 config_menu_hide_delay * 1000,
465 menu_hide_delay_func,
466 NULL, g_direct_equal, NULL);
471 gboolean menu_hide_delay_reached(void)
473 return menu_can_hide;
476 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
482 self = g_new0(ObMenuEntry, 1);
489 case OB_MENU_ENTRY_TYPE_NORMAL:
490 self->data.normal.enabled = TRUE;
492 case OB_MENU_ENTRY_TYPE_SUBMENU:
493 case OB_MENU_ENTRY_TYPE_SEPARATOR:
500 void menu_entry_ref(ObMenuEntry *self)
505 void menu_entry_unref(ObMenuEntry *self)
507 if (self && --self->ref == 0) {
508 switch (self->type) {
509 case OB_MENU_ENTRY_TYPE_NORMAL:
510 RrImageUnref(self->data.normal.icon);
511 g_free(self->data.normal.label);
512 while (self->data.normal.actions) {
513 actions_act_unref(self->data.normal.actions->data);
514 self->data.normal.actions =
515 g_slist_delete_link(self->data.normal.actions,
516 self->data.normal.actions);
519 case OB_MENU_ENTRY_TYPE_SUBMENU:
520 g_free(self->data.submenu.name);
522 case OB_MENU_ENTRY_TYPE_SEPARATOR:
523 g_free(self->data.separator.label);
531 void menu_clear_entries(ObMenu *self)
534 /* assert that the menu isn't visible */
539 for (it = menu_frame_visible; it; it = g_list_next(it)) {
541 g_assert(f->menu != self);
546 while (self->entries) {
547 menu_entry_unref(self->entries->data);
548 self->entries = g_list_delete_link(self->entries, self->entries);
550 self->more_menu->entries = self->entries; /* keep it in sync */
553 void menu_entry_remove(ObMenuEntry *self)
555 self->menu->entries = g_list_remove(self->menu->entries, self);
556 menu_entry_unref(self);
559 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
560 GSList *actions, gboolean allow_shortcut)
564 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
565 e->data.normal.actions = actions;
567 menu_entry_set_label(e, label, allow_shortcut);
569 self->entries = g_list_append(self->entries, e);
570 self->more_menu->entries = self->entries; /* keep it in sync */
574 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
577 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
578 /* points to itself */
579 e->data.submenu.name = g_strdup(self->name);
580 e->data.submenu.submenu = self;
581 e->data.submenu.show_from = show_from;
585 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
589 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
590 e->data.submenu.name = g_strdup(submenu);
592 self->entries = g_list_append(self->entries, e);
593 self->more_menu->entries = self->entries; /* keep it in sync */
597 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
601 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
603 menu_entry_set_label(e, label, FALSE);
605 self->entries = g_list_append(self->entries, e);
606 self->more_menu->entries = self->entries; /* keep it in sync */
610 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
612 self->show_func = func;
615 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
617 self->hide_func = func;
620 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
622 self->update_func = func;
625 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
627 self->execute_func = func;
628 self->more_menu->execute_func = func; /* keep it in sync */
631 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
633 self->destroy_func = func;
636 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
638 self->place_func = func;
641 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
643 ObMenuEntry *ret = NULL;
646 for (it = self->entries; it; it = g_list_next(it)) {
647 ObMenuEntry *e = it->data;
657 void menu_find_submenus(ObMenu *self)
661 for (it = self->entries; it; it = g_list_next(it)) {
662 ObMenuEntry *e = it->data;
664 if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
665 e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
669 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
670 gboolean allow_shortcut)
672 switch (self->type) {
673 case OB_MENU_ENTRY_TYPE_SEPARATOR:
674 g_free(self->data.separator.label);
675 self->data.separator.label = g_strdup(label);
677 case OB_MENU_ENTRY_TYPE_NORMAL:
678 g_free(self->data.normal.label);
679 self->data.normal.shortcut =
680 parse_shortcut(label, allow_shortcut, &self->data.normal.label,
681 &self->data.normal.shortcut_position,
682 &self->data.normal.shortcut_always_show);
685 g_assert_not_reached();
689 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
691 self->show_all_shortcuts = show;