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 "obt/parse.h"
39 typedef struct _ObMenuParseState ObMenuParseState;
41 struct _ObMenuParseState
47 static GHashTable *menu_hash = NULL;
48 static ObtParseInst *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(xmlNodePtr node, gpointer data);
54 static void parse_menu_separator(xmlNodePtr node, gpointer data);
55 static void parse_menu(xmlNodePtr node, gpointer data);
56 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
57 gchar **strippedlabel, guint *position,
58 gboolean *always_show);
61 static void client_dest(ObClient *client, gpointer data)
63 /* menus can be associated with a client, so close any that are since
64 we are disappearing now */
65 menu_frame_hide_all_client(client);
68 void menu_startup(gboolean reconfig)
70 gboolean loaded = FALSE;
73 menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
74 (GDestroyNotify)menu_destroy_hash_value);
76 client_list_menu_startup(reconfig);
77 client_list_combined_menu_startup(reconfig);
78 client_menu_startup();
80 menu_parse_inst = obt_parse_instance_new();
82 menu_parse_state.parent = NULL;
83 menu_parse_state.pipe_creator = NULL;
84 obt_parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
85 obt_parse_register(menu_parse_inst, "item", parse_menu_item,
87 obt_parse_register(menu_parse_inst, "separator",
88 parse_menu_separator, &menu_parse_state);
90 for (it = config_menu_files; it; it = g_slist_next(it)) {
91 if (obt_parse_load_config_file(menu_parse_inst,
97 obt_parse_tree(menu_parse_inst,
98 obt_parse_instance_root(menu_parse_inst)->children);
99 obt_parse_close(menu_parse_inst);
101 g_message(_("Unable to find a valid menu file '%s'"),
102 (const gchar*)it->data);
105 if (obt_parse_load_config_file(menu_parse_inst,
110 obt_parse_tree(menu_parse_inst,
111 obt_parse_instance_root(menu_parse_inst)->children);
112 obt_parse_close(menu_parse_inst);
114 g_message(_("Unable to find a valid menu file '%s'"),
118 g_assert(menu_parse_state.parent == NULL);
121 client_add_destroy_notify(client_dest, NULL);
124 void menu_shutdown(gboolean reconfig)
127 client_remove_destroy_notify(client_dest);
129 obt_parse_instance_unref(menu_parse_inst);
130 menu_parse_inst = NULL;
132 client_list_menu_shutdown(reconfig);
133 client_list_combined_menu_shutdown(reconfig);
135 menu_frame_hide_all();
136 g_hash_table_destroy(menu_hash);
140 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
143 return menu->pipe_creator != NULL;
146 static void clear_cache(gpointer key, gpointer val, gpointer data)
150 menu_clear_entries(menu);
153 void menu_clear_pipe_caches(void)
155 /* delete any pipe menus' submenus */
156 g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
157 /* empty the top level pipe menus */
158 g_hash_table_foreach(menu_hash, clear_cache, NULL);
161 void menu_pipe_execute(ObMenu *self)
169 if (self->entries) /* the entries are already created and cached */
172 if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
173 g_message(_("Failed to execute command for pipe-menu '%s': %s"),
174 self->execute, err->message);
179 if (obt_parse_load_mem(menu_parse_inst, output, strlen(output),
180 "openbox_pipe_menu"))
182 menu_parse_state.pipe_creator = self;
183 menu_parse_state.parent = self;
184 obt_parse_tree(menu_parse_inst, node->children);
185 obt_parse_close(menu_parse_inst);
187 g_message(_("Invalid output from pipe-menu '%s'"), self->execute);
193 static ObMenu* menu_from_name(gchar *name)
197 g_assert(name != NULL);
199 if (!(self = g_hash_table_lookup(menu_hash, name)))
200 g_message(_("Attempted to access menu '%s' but it does not exist"),
205 #define VALID_SHORTCUT(c) (((c) >= '0' && (c) <= '9') || \
206 ((c) >= 'A' && (c) <= 'Z') || \
207 ((c) >= 'a' && (c) <= 'z'))
209 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
210 gchar **strippedlabel, guint *position,
211 gboolean *always_show)
213 gunichar shortcut = 0;
216 *always_show = FALSE;
218 g_assert(strippedlabel != NULL);
221 *strippedlabel = NULL;
225 *strippedlabel = g_strdup(label);
227 /* if allow_shortcut is false, then you can't use the '_', instead you
228 have to just use the first valid character
231 i = strchr(*strippedlabel, '_');
232 if (allow_shortcut && i != NULL) {
233 /* there is an underscore in the string */
235 /* you have to use a printable ascii character for shortcuts
236 don't allow space either, so you can have like "a _ b"
238 if (VALID_SHORTCUT(*(i+1))) {
239 shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
240 *position = i - *strippedlabel;
243 /* remove the '_' from the string */
244 for (; *i != '\0'; ++i)
246 } else if (*(i+1) == '\0') {
247 /* no default shortcut if the '_' is the last character
248 (eg. "Exit_") for menu entries that you don't want
249 to be executed by mistake
254 /* there is no underscore, so find the first valid character to use
257 for (i = *strippedlabel; *i != '\0'; ++i)
258 if (VALID_SHORTCUT(*i)) {
259 *position = i - *strippedlabel;
260 shortcut = g_unichar_tolower(g_utf8_get_char(i));
268 static void parse_menu_item(xmlNodePtr node, gpointer data)
270 ObMenuParseState *state = data;
274 if (obt_parse_attr_string(node, "label", &label)) {
277 for (node = node->children; node; node = node->next)
278 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
279 ObActionsAct *a = actions_parse(node);
281 acts = g_slist_append(acts, a);
283 menu_add_normal(state->parent, -1, label, acts, TRUE);
289 static void parse_menu_separator(xmlNodePtr node, gpointer data)
291 ObMenuParseState *state = data;
296 if (!obt_parse_attr_string(node, "label", &label))
299 menu_add_separator(state->parent, -1, label);
304 static void parse_menu(xmlNodePtr node, gpointer data)
306 ObMenuParseState *state = data;
307 gchar *name = NULL, *title = NULL, *script = NULL;
310 if (!obt_parse_attr_string(node, "id", &name))
311 goto parse_menu_fail;
313 if (!g_hash_table_lookup(menu_hash, name)) {
314 if (!obt_parse_attr_string(node, "label", &title))
315 goto parse_menu_fail;
317 if ((menu = menu_new(name, title, TRUE, NULL))) {
318 menu->pipe_creator = state->pipe_creator;
319 if (obt_parse_attr_string(node, "execute", &script)) {
320 menu->execute = parse_expand_tilde(script);
325 state->parent = menu;
326 obt_parse_tree(menu_parse_inst, node->children);
333 menu_add_submenu(state->parent, -1, name);
341 ObMenu* menu_new(const gchar *name, const gchar *title,
342 gboolean allow_shortcut_selection, gpointer data)
346 self = g_new0(ObMenu, 1);
347 self->name = g_strdup(name);
350 self->shortcut = parse_shortcut(title, allow_shortcut_selection,
351 &self->title, &self->shortcut_position,
352 &self->shortcut_always_show);
354 g_hash_table_replace(menu_hash, self->name, self);
356 /* Each menu has a single more_menu. When the menu spills past what
357 can fit on the screen, a new menu frame entry is created from this
358 more_menu, and a new menu frame for the submenu is created for this
359 menu, also pointing to the more_menu.
361 This can be done multiple times using the same more_menu.
363 more_menu->more_menu will always be NULL, since there is only 1 for
365 self->more_menu = g_new0(ObMenu, 1);
366 self->more_menu->name = _("More...");
367 self->more_menu->title = _("More...");
368 self->more_menu->data = data;
369 self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
374 static void menu_destroy_hash_value(ObMenu *self)
376 /* make sure its not visible */
381 for (it = menu_frame_visible; it; it = g_list_next(it)) {
384 menu_frame_hide_all();
388 if (self->destroy_func)
389 self->destroy_func(self, self->data);
391 menu_clear_entries(self);
394 g_free(self->execute);
395 g_free(self->more_menu);
400 void menu_free(ObMenu *menu)
403 g_hash_table_remove(menu_hash, menu->name);
406 static gboolean menu_hide_delay_func(gpointer data)
408 menu_can_hide = TRUE;
409 return FALSE; /* no repeat */
412 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
417 if (!(self = menu_from_name(name)) ||
418 grab_on_keyboard() || grab_on_pointer()) return;
420 /* if the requested menu is already the top visible menu, then don't
422 if (menu_frame_visible) {
423 frame = menu_frame_visible->data;
424 if (frame->menu == self)
428 menu_frame_hide_all();
430 /* clear the pipe menus when showing a new menu */
431 menu_clear_pipe_caches();
433 frame = menu_frame_new(self, 0, client);
434 if (!menu_frame_show_topmenu(frame, x, y, mouse))
435 menu_frame_free(frame);
438 /* select the first entry if it's not a submenu and we opened
439 * the menu with the keyboard, and skip all headers */
440 GList *it = frame->entries;
442 ObMenuEntryFrame *e = it->data;
443 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
444 menu_frame_select(frame, e, FALSE);
446 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
447 it = g_list_next(it);
453 /* reset the hide timer */
455 menu_can_hide = TRUE;
457 menu_can_hide = FALSE;
458 obt_main_loop_timeout_add(ob_main_loop,
459 config_menu_hide_delay * 1000,
460 menu_hide_delay_func,
461 NULL, g_direct_equal, NULL);
466 gboolean menu_hide_delay_reached(void)
468 return menu_can_hide;
471 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
477 self = g_new0(ObMenuEntry, 1);
484 case OB_MENU_ENTRY_TYPE_NORMAL:
485 self->data.normal.enabled = TRUE;
487 case OB_MENU_ENTRY_TYPE_SUBMENU:
488 case OB_MENU_ENTRY_TYPE_SEPARATOR:
495 void menu_entry_ref(ObMenuEntry *self)
500 void menu_entry_unref(ObMenuEntry *self)
502 if (self && --self->ref == 0) {
503 switch (self->type) {
504 case OB_MENU_ENTRY_TYPE_NORMAL:
505 g_free(self->data.normal.label);
506 while (self->data.normal.actions) {
507 actions_act_unref(self->data.normal.actions->data);
508 self->data.normal.actions =
509 g_slist_delete_link(self->data.normal.actions,
510 self->data.normal.actions);
513 case OB_MENU_ENTRY_TYPE_SUBMENU:
514 g_free(self->data.submenu.name);
516 case OB_MENU_ENTRY_TYPE_SEPARATOR:
517 g_free(self->data.separator.label);
525 void menu_clear_entries(ObMenu *self)
528 /* assert that the menu isn't visible */
533 for (it = menu_frame_visible; it; it = g_list_next(it)) {
535 g_assert(f->menu != self);
540 while (self->entries) {
541 menu_entry_unref(self->entries->data);
542 self->entries = g_list_delete_link(self->entries, self->entries);
544 self->more_menu->entries = self->entries; /* keep it in sync */
547 void menu_entry_remove(ObMenuEntry *self)
549 self->menu->entries = g_list_remove(self->menu->entries, self);
550 menu_entry_unref(self);
553 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
554 GSList *actions, gboolean allow_shortcut)
558 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
559 e->data.normal.actions = actions;
561 menu_entry_set_label(e, label, allow_shortcut);
563 self->entries = g_list_append(self->entries, e);
564 self->more_menu->entries = self->entries; /* keep it in sync */
568 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
571 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
572 /* points to itself */
573 e->data.submenu.name = g_strdup(self->name);
574 e->data.submenu.submenu = self;
575 e->data.submenu.show_from = show_from;
579 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
583 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
584 e->data.submenu.name = g_strdup(submenu);
586 self->entries = g_list_append(self->entries, e);
587 self->more_menu->entries = self->entries; /* keep it in sync */
591 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
595 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
597 menu_entry_set_label(e, label, FALSE);
599 self->entries = g_list_append(self->entries, e);
600 self->more_menu->entries = self->entries; /* keep it in sync */
604 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
606 self->show_func = func;
609 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
611 self->hide_func = func;
614 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
616 self->update_func = func;
619 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
621 self->execute_func = func;
622 self->more_menu->execute_func = func; /* keep it in sync */
625 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
627 self->destroy_func = func;
630 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
632 self->place_func = func;
635 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
637 ObMenuEntry *ret = NULL;
640 for (it = self->entries; it; it = g_list_next(it)) {
641 ObMenuEntry *e = it->data;
651 void menu_find_submenus(ObMenu *self)
655 for (it = self->entries; it; it = g_list_next(it)) {
656 ObMenuEntry *e = it->data;
658 if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
659 e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
663 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
664 gboolean allow_shortcut)
666 switch (self->type) {
667 case OB_MENU_ENTRY_TYPE_SEPARATOR:
668 g_free(self->data.separator.label);
669 self->data.separator.label = g_strdup(label);
671 case OB_MENU_ENTRY_TYPE_NORMAL:
672 g_free(self->data.normal.label);
673 self->data.normal.shortcut =
674 parse_shortcut(label, allow_shortcut, &self->data.normal.label,
675 &self->data.normal.shortcut_position,
676 &self->data.normal.shortcut_always_show);
679 g_assert_not_reached();
683 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
685 self->show_all_shortcuts = show;