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"
37 #include "parser/parse.h"
39 typedef struct _ObMenuParseState ObMenuParseState;
41 struct _ObMenuParseState
47 static GHashTable *menu_hash = NULL;
48 static ObParseInst *menu_parse_inst;
49 static ObMenuParseState menu_parse_state;
50 static gboolean menu_can_hide = FALSE;
52 static void menu_destroy_hash_value(ObMenu *self);
53 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
55 static void parse_menu_separator(ObParseInst *i,
56 xmlDocPtr doc, xmlNodePtr node,
58 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
60 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
61 gchar **strippedlabel, guint *position,
62 gboolean *always_show);
65 static void client_dest(ObClient *client, gpointer data)
67 /* menus can be associated with a client, so close any that are since
68 we are disappearing now */
69 menu_frame_hide_all_client(client);
72 void menu_startup(gboolean reconfig)
76 gboolean loaded = FALSE;
79 menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
80 (GDestroyNotify)menu_destroy_hash_value);
82 client_list_menu_startup(reconfig);
83 client_list_combined_menu_startup(reconfig);
84 client_menu_startup();
86 menu_parse_inst = parse_startup();
88 menu_parse_state.parent = NULL;
89 menu_parse_state.pipe_creator = NULL;
90 parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
91 parse_register(menu_parse_inst, "item", parse_menu_item,
93 parse_register(menu_parse_inst, "separator",
94 parse_menu_separator, &menu_parse_state);
96 for (it = config_menu_files; it; it = g_slist_next(it)) {
97 if (parse_load_menu(it->data, &doc, &node)) {
99 parse_tree(menu_parse_inst, doc, node->children);
102 g_message(_("Unable to find a valid menu file '%s'"),
103 (const gchar*)it->data);
106 if (parse_load_menu("menu.xml", &doc, &node)) {
107 parse_tree(menu_parse_inst, doc, node->children);
110 g_message(_("Unable to find a valid menu file '%s'"),
114 g_assert(menu_parse_state.parent == NULL);
117 client_add_destroy_notify(client_dest, NULL);
120 void menu_shutdown(gboolean reconfig)
123 client_remove_destroy_notify(client_dest);
125 parse_shutdown(menu_parse_inst);
126 menu_parse_inst = NULL;
128 client_list_menu_shutdown(reconfig);
129 client_list_combined_menu_shutdown(reconfig);
131 menu_frame_hide_all();
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)
166 if (self->entries) /* the entries are already created and cached */
169 if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
170 g_message(_("Failed to execute command for pipe-menu '%s': %s"),
171 self->execute, err->message);
176 if (parse_load_mem(output, strlen(output),
177 "openbox_pipe_menu", &doc, &node))
179 menu_parse_state.pipe_creator = self;
180 menu_parse_state.parent = self;
181 parse_tree(menu_parse_inst, doc, node->children);
184 g_message(_("Invalid output from pipe-menu '%s'"), self->execute);
190 static ObMenu* menu_from_name(gchar *name)
194 g_assert(name != NULL);
196 if (!(self = g_hash_table_lookup(menu_hash, name)))
197 g_message(_("Attempted to access menu '%s' but it does not exist"),
202 #define VALID_SHORTCUT(c) (((c) >= '0' && (c) <= '9') || \
203 ((c) >= 'A' && (c) <= 'Z') || \
204 ((c) >= 'a' && (c) <= 'z'))
206 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
207 gchar **strippedlabel, guint *position,
208 gboolean *always_show)
210 gunichar shortcut = 0;
213 *always_show = FALSE;
215 g_assert(strippedlabel != NULL);
218 *strippedlabel = NULL;
222 *strippedlabel = g_strdup(label);
224 /* if allow_shortcut is false, then you can't use the '_', instead you
225 have to just use the first valid character
228 i = strchr(*strippedlabel, '_');
229 if (allow_shortcut && i != NULL) {
230 /* there is an underscore in the string */
232 /* you have to use a printable ascii character for shortcuts
233 don't allow space either, so you can have like "a _ b"
235 if (VALID_SHORTCUT(*(i+1))) {
236 shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
237 *position = i - *strippedlabel;
240 /* remove the '_' from the string */
241 for (; *i != '\0'; ++i)
243 } else if (*(i+1) == '\0') {
244 /* no default shortcut if the '_' is the last character
245 (eg. "Exit_") for menu entries that you don't want
246 to be executed by mistake
251 /* there is no underscore, so find the first valid character to use
254 for (i = *strippedlabel; *i != '\0'; ++i)
255 if (VALID_SHORTCUT(*i)) {
256 *position = i - *strippedlabel;
257 shortcut = g_unichar_tolower(g_utf8_get_char(i));
265 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
268 ObMenuParseState *state = data;
272 if (parse_attr_string("label", node, &label)) {
275 for (node = node->children; node; node = node->next)
276 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
277 ObActionsAct *a = actions_parse(i, doc, node);
279 acts = g_slist_append(acts, a);
281 menu_add_normal(state->parent, -1, label, acts, TRUE);
287 static void parse_menu_separator(ObParseInst *i,
288 xmlDocPtr doc, xmlNodePtr node,
291 ObMenuParseState *state = data;
296 if (!parse_attr_string("label", node, &label))
299 menu_add_separator(state->parent, -1, label);
304 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
307 ObMenuParseState *state = data;
308 gchar *name = NULL, *title = NULL, *script = NULL;
311 if (!parse_attr_string("id", node, &name))
312 goto parse_menu_fail;
314 if (!g_hash_table_lookup(menu_hash, name)) {
315 if (!parse_attr_string("label", node, &title))
316 goto parse_menu_fail;
318 if ((menu = menu_new(name, title, TRUE, NULL))) {
319 menu->pipe_creator = state->pipe_creator;
320 if (parse_attr_string("execute", node, &script)) {
321 menu->execute = parse_expand_tilde(script);
326 state->parent = menu;
327 parse_tree(i, doc, node->children);
334 menu_add_submenu(state->parent, -1, name);
342 ObMenu* menu_new(const gchar *name, const gchar *title,
343 gboolean allow_shortcut_selection, gpointer data)
347 self = g_new0(ObMenu, 1);
348 self->name = g_strdup(name);
351 self->shortcut = parse_shortcut(title, allow_shortcut_selection,
352 &self->title, &self->shortcut_position,
353 &self->shortcut_always_show);
355 g_hash_table_replace(menu_hash, self->name, self);
357 /* Each menu has a single more_menu. When the menu spills past what
358 can fit on the screen, a new menu frame entry is created from this
359 more_menu, and a new menu frame for the submenu is created for this
360 menu, also pointing to the more_menu.
362 This can be done multiple times using the same more_menu.
364 more_menu->more_menu will always be NULL, since there is only 1 for
366 self->more_menu = g_new0(ObMenu, 1);
367 self->more_menu->name = _("More...");
368 self->more_menu->title = _("More...");
369 self->more_menu->data = data;
370 self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
375 static void menu_destroy_hash_value(ObMenu *self)
377 /* make sure its not visible */
382 for (it = menu_frame_visible; it; it = g_list_next(it)) {
385 menu_frame_hide_all();
389 if (self->destroy_func)
390 self->destroy_func(self, self->data);
392 menu_clear_entries(self);
395 g_free(self->execute);
396 g_free(self->more_menu);
401 void menu_free(ObMenu *menu)
404 g_hash_table_remove(menu_hash, menu->name);
407 static gboolean menu_hide_delay_func(gpointer data)
409 menu_can_hide = TRUE;
410 return FALSE; /* no repeat */
413 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
418 if (!(self = menu_from_name(name)) ||
419 grab_on_keyboard() || grab_on_pointer()) return;
421 /* if the requested menu is already the top visible menu, then don't
423 if (menu_frame_visible) {
424 frame = menu_frame_visible->data;
425 if (frame->menu == self)
429 menu_frame_hide_all();
431 /* clear the pipe menus when showing a new menu */
432 menu_clear_pipe_caches();
434 frame = menu_frame_new(self, 0, client);
435 if (!menu_frame_show_topmenu(frame, x, y, mouse))
436 menu_frame_free(frame);
439 /* select the first entry if it's not a submenu and we opened
440 * the menu with the keyboard, and skip all headers */
441 GList *it = frame->entries;
443 ObMenuEntryFrame *e = it->data;
444 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
445 menu_frame_select(frame, e, FALSE);
447 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
448 it = g_list_next(it);
454 /* reset the hide timer */
456 menu_can_hide = TRUE;
458 menu_can_hide = FALSE;
459 obt_main_loop_timeout_add(ob_main_loop,
460 config_menu_hide_delay * 1000,
461 menu_hide_delay_func,
462 NULL, g_direct_equal, NULL);
467 gboolean menu_hide_delay_reached(void)
469 return menu_can_hide;
472 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
478 self = g_new0(ObMenuEntry, 1);
485 case OB_MENU_ENTRY_TYPE_NORMAL:
486 self->data.normal.enabled = TRUE;
488 case OB_MENU_ENTRY_TYPE_SUBMENU:
489 case OB_MENU_ENTRY_TYPE_SEPARATOR:
496 void menu_entry_ref(ObMenuEntry *self)
501 void menu_entry_unref(ObMenuEntry *self)
503 if (self && --self->ref == 0) {
504 switch (self->type) {
505 case OB_MENU_ENTRY_TYPE_NORMAL:
506 g_free(self->data.normal.label);
507 while (self->data.normal.actions) {
508 actions_act_unref(self->data.normal.actions->data);
509 self->data.normal.actions =
510 g_slist_delete_link(self->data.normal.actions,
511 self->data.normal.actions);
514 case OB_MENU_ENTRY_TYPE_SUBMENU:
515 g_free(self->data.submenu.name);
517 case OB_MENU_ENTRY_TYPE_SEPARATOR:
518 g_free(self->data.separator.label);
526 void menu_clear_entries(ObMenu *self)
529 /* assert that the menu isn't visible */
534 for (it = menu_frame_visible; it; it = g_list_next(it)) {
536 g_assert(f->menu != self);
541 while (self->entries) {
542 menu_entry_unref(self->entries->data);
543 self->entries = g_list_delete_link(self->entries, self->entries);
545 self->more_menu->entries = self->entries; /* keep it in sync */
548 void menu_entry_remove(ObMenuEntry *self)
550 self->menu->entries = g_list_remove(self->menu->entries, self);
551 menu_entry_unref(self);
554 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
555 GSList *actions, gboolean allow_shortcut)
559 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
560 e->data.normal.actions = actions;
562 menu_entry_set_label(e, label, allow_shortcut);
564 self->entries = g_list_append(self->entries, e);
565 self->more_menu->entries = self->entries; /* keep it in sync */
569 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
572 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
573 /* points to itself */
574 e->data.submenu.name = g_strdup(self->name);
575 e->data.submenu.submenu = self;
576 e->data.submenu.show_from = show_from;
580 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
584 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
585 e->data.submenu.name = g_strdup(submenu);
587 self->entries = g_list_append(self->entries, e);
588 self->more_menu->entries = self->entries; /* keep it in sync */
592 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
596 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
598 menu_entry_set_label(e, label, FALSE);
600 self->entries = g_list_append(self->entries, e);
601 self->more_menu->entries = self->entries; /* keep it in sync */
605 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
607 self->show_func = func;
610 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
612 self->hide_func = func;
615 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
617 self->update_func = func;
620 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
622 self->execute_func = func;
623 self->more_menu->execute_func = func; /* keep it in sync */
626 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
628 self->destroy_func = func;
631 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
633 self->place_func = func;
636 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
638 ObMenuEntry *ret = NULL;
641 for (it = self->entries; it; it = g_list_next(it)) {
642 ObMenuEntry *e = it->data;
652 void menu_find_submenus(ObMenu *self)
656 for (it = self->entries; it; it = g_list_next(it)) {
657 ObMenuEntry *e = it->data;
659 if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
660 e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
664 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
665 gboolean allow_shortcut)
667 switch (self->type) {
668 case OB_MENU_ENTRY_TYPE_SEPARATOR:
669 g_free(self->data.separator.label);
670 self->data.separator.label = g_strdup(label);
672 case OB_MENU_ENTRY_TYPE_NORMAL:
673 g_free(self->data.normal.label);
674 self->data.normal.shortcut =
675 parse_shortcut(label, allow_shortcut, &self->data.normal.label,
676 &self->data.normal.shortcut_position,
677 &self->data.normal.shortcut_always_show);
680 g_assert_not_reached();
684 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
686 self->show_all_shortcuts = show;