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 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)) || *(i+1) == '_') {
236 /* Allow you to escape the first _ by putting __ */
238 shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
239 *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(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
271 ObMenuParseState *state = data;
275 if (parse_attr_string("label", node, &label)) {
278 for (node = node->children; node; node = node->next)
279 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
280 ObActionsAct *a = actions_parse(i, doc, node);
282 acts = g_slist_append(acts, a);
284 menu_add_normal(state->parent, -1, label, acts, TRUE);
290 static void parse_menu_separator(ObParseInst *i,
291 xmlDocPtr doc, xmlNodePtr node,
294 ObMenuParseState *state = data;
299 if (!parse_attr_string("label", node, &label))
302 menu_add_separator(state->parent, -1, label);
307 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
310 ObMenuParseState *state = data;
311 gchar *name = NULL, *title = NULL, *script = NULL;
314 if (!parse_attr_string("id", node, &name))
315 goto parse_menu_fail;
317 if (!g_hash_table_lookup(menu_hash, name)) {
318 if (!parse_attr_string("label", node, &title))
319 goto parse_menu_fail;
321 if ((menu = menu_new(name, title, TRUE, NULL))) {
322 menu->pipe_creator = state->pipe_creator;
323 if (parse_attr_string("execute", node, &script)) {
324 menu->execute = parse_expand_tilde(script);
329 state->parent = menu;
330 parse_tree(i, doc, node->children);
337 menu_add_submenu(state->parent, -1, name);
345 ObMenu* menu_new(const gchar *name, const gchar *title,
346 gboolean allow_shortcut_selection, gpointer data)
350 self = g_new0(ObMenu, 1);
351 self->name = g_strdup(name);
354 self->shortcut = parse_shortcut(title, allow_shortcut_selection,
355 &self->title, &self->shortcut_position,
356 &self->shortcut_always_show);
358 g_hash_table_replace(menu_hash, self->name, self);
360 /* Each menu has a single more_menu. When the menu spills past what
361 can fit on the screen, a new menu frame entry is created from this
362 more_menu, and a new menu frame for the submenu is created for this
363 menu, also pointing to the more_menu.
365 This can be done multiple times using the same more_menu.
367 more_menu->more_menu will always be NULL, since there is only 1 for
369 self->more_menu = g_new0(ObMenu, 1);
370 self->more_menu->name = _("More...");
371 self->more_menu->title = _("More...");
372 self->more_menu->data = data;
373 self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
378 static void menu_destroy_hash_value(ObMenu *self)
380 /* make sure its not visible */
385 for (it = menu_frame_visible; it; it = g_list_next(it)) {
388 menu_frame_hide_all();
392 if (self->destroy_func)
393 self->destroy_func(self, self->data);
395 menu_clear_entries(self);
398 g_free(self->execute);
399 g_free(self->more_menu);
404 void menu_free(ObMenu *menu)
407 g_hash_table_remove(menu_hash, menu->name);
410 static gboolean menu_hide_delay_func(gpointer data)
412 menu_can_hide = TRUE;
413 return FALSE; /* no repeat */
416 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
421 if (!(self = menu_from_name(name)) ||
422 grab_on_keyboard() || grab_on_pointer()) return;
424 /* if the requested menu is already the top visible menu, then don't
426 if (menu_frame_visible) {
427 frame = menu_frame_visible->data;
428 if (frame->menu == self)
432 menu_frame_hide_all();
434 /* clear the pipe menus when showing a new menu */
435 menu_clear_pipe_caches();
437 frame = menu_frame_new(self, 0, client);
438 if (!menu_frame_show_topmenu(frame, x, y, mouse))
439 menu_frame_free(frame);
442 /* select the first entry if it's not a submenu and we opened
443 * the menu with the keyboard, and skip all headers */
444 GList *it = frame->entries;
446 ObMenuEntryFrame *e = it->data;
447 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
448 menu_frame_select(frame, e, FALSE);
450 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
451 it = g_list_next(it);
457 /* reset the hide timer */
459 menu_can_hide = TRUE;
461 menu_can_hide = FALSE;
462 ob_main_loop_timeout_add(ob_main_loop,
463 config_menu_hide_delay * 1000,
464 menu_hide_delay_func,
465 NULL, g_direct_equal, NULL);
470 gboolean menu_hide_delay_reached(void)
472 return menu_can_hide;
475 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
481 self = g_new0(ObMenuEntry, 1);
488 case OB_MENU_ENTRY_TYPE_NORMAL:
489 self->data.normal.enabled = TRUE;
491 case OB_MENU_ENTRY_TYPE_SUBMENU:
492 case OB_MENU_ENTRY_TYPE_SEPARATOR:
499 void menu_entry_ref(ObMenuEntry *self)
504 void menu_entry_unref(ObMenuEntry *self)
506 if (self && --self->ref == 0) {
507 switch (self->type) {
508 case OB_MENU_ENTRY_TYPE_NORMAL:
509 RrImageUnref(self->data.normal.icon);
510 g_free(self->data.normal.label);
511 while (self->data.normal.actions) {
512 actions_act_unref(self->data.normal.actions->data);
513 self->data.normal.actions =
514 g_slist_delete_link(self->data.normal.actions,
515 self->data.normal.actions);
518 case OB_MENU_ENTRY_TYPE_SUBMENU:
519 g_free(self->data.submenu.name);
521 case OB_MENU_ENTRY_TYPE_SEPARATOR:
522 g_free(self->data.separator.label);
530 void menu_clear_entries(ObMenu *self)
533 /* assert that the menu isn't visible */
538 for (it = menu_frame_visible; it; it = g_list_next(it)) {
540 g_assert(f->menu != self);
545 while (self->entries) {
546 menu_entry_unref(self->entries->data);
547 self->entries = g_list_delete_link(self->entries, self->entries);
549 self->more_menu->entries = self->entries; /* keep it in sync */
552 void menu_entry_remove(ObMenuEntry *self)
554 self->menu->entries = g_list_remove(self->menu->entries, self);
555 menu_entry_unref(self);
558 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
559 GSList *actions, gboolean allow_shortcut)
563 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
564 e->data.normal.actions = actions;
566 menu_entry_set_label(e, label, allow_shortcut);
568 self->entries = g_list_append(self->entries, e);
569 self->more_menu->entries = self->entries; /* keep it in sync */
573 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
576 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
577 /* points to itself */
578 e->data.submenu.name = g_strdup(self->name);
579 e->data.submenu.submenu = self;
580 e->data.submenu.show_from = show_from;
584 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
588 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
589 e->data.submenu.name = g_strdup(submenu);
591 self->entries = g_list_append(self->entries, e);
592 self->more_menu->entries = self->entries; /* keep it in sync */
596 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
600 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
602 menu_entry_set_label(e, label, FALSE);
604 self->entries = g_list_append(self->entries, e);
605 self->more_menu->entries = self->entries; /* keep it in sync */
609 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
611 self->show_func = func;
614 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
616 self->hide_func = func;
619 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
621 self->update_func = func;
624 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
626 self->execute_func = func;
627 self->more_menu->execute_func = func; /* keep it in sync */
630 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
632 self->destroy_func = func;
635 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
637 self->place_func = func;
640 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
642 ObMenuEntry *ret = NULL;
645 for (it = self->entries; it; it = g_list_next(it)) {
646 ObMenuEntry *e = it->data;
656 void menu_find_submenus(ObMenu *self)
660 for (it = self->entries; it; it = g_list_next(it)) {
661 ObMenuEntry *e = it->data;
663 if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
664 e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
668 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
669 gboolean allow_shortcut)
671 switch (self->type) {
672 case OB_MENU_ENTRY_TYPE_SEPARATOR:
673 g_free(self->data.separator.label);
674 self->data.separator.label = g_strdup(label);
676 case OB_MENU_ENTRY_TYPE_NORMAL:
677 g_free(self->data.normal.label);
678 self->data.normal.shortcut =
679 parse_shortcut(label, allow_shortcut, &self->data.normal.label,
680 &self->data.normal.shortcut_position,
681 &self->data.normal.shortcut_always_show);
684 g_assert_not_reached();
688 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
690 self->show_all_shortcuts = show;