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"
38 #include "obt/paths.h"
40 typedef struct _ObMenuParseState ObMenuParseState;
42 struct _ObMenuParseState
48 static GHashTable *menu_hash = NULL;
49 static ObtParseInst *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(xmlNodePtr node, gpointer data);
55 static void parse_menu_separator(xmlNodePtr node, gpointer data);
56 static void parse_menu(xmlNodePtr node, gpointer data);
57 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
58 gchar **strippedlabel, guint *position,
59 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_from_root(menu_parse_inst);
98 obt_parse_close(menu_parse_inst);
100 g_message(_("Unable to find a valid menu file \"%s\""),
101 (const gchar*)it->data);
104 if (obt_parse_load_config_file(menu_parse_inst,
109 obt_parse_tree_from_root(menu_parse_inst);
110 obt_parse_close(menu_parse_inst);
112 g_message(_("Unable to find a valid menu file \"%s\""),
116 g_assert(menu_parse_state.parent == NULL);
119 client_add_destroy_notify(client_dest, NULL);
122 void menu_shutdown(gboolean reconfig)
125 client_remove_destroy_notify(client_dest);
127 obt_parse_instance_unref(menu_parse_inst);
128 menu_parse_inst = NULL;
130 client_list_menu_shutdown(reconfig);
131 client_list_combined_menu_shutdown(reconfig);
133 menu_frame_hide_all();
134 g_hash_table_destroy(menu_hash);
138 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
141 return menu->pipe_creator != NULL;
144 static void clear_cache(gpointer key, gpointer val, gpointer data)
148 menu_clear_entries(menu);
151 void menu_clear_pipe_caches(void)
153 /* delete any pipe menus' submenus */
154 g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
155 /* empty the top level pipe menus */
156 g_hash_table_foreach(menu_hash, clear_cache, NULL);
159 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 (obt_parse_load_mem(menu_parse_inst, output, strlen(output),
177 "openbox_pipe_menu"))
179 menu_parse_state.pipe_creator = self;
180 menu_parse_state.parent = self;
181 obt_parse_tree_from_root(menu_parse_inst);
182 obt_parse_close(menu_parse_inst);
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(xmlNodePtr node, gpointer data)
267 ObMenuParseState *state = data;
271 if (obt_parse_attr_string(node, "label", &label)) {
274 for (node = node->children; node; node = node->next)
275 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
276 ObActionsAct *a = actions_parse(node);
278 acts = g_slist_append(acts, a);
280 menu_add_normal(state->parent, -1, label, acts, TRUE);
286 static void parse_menu_separator(xmlNodePtr node, gpointer data)
288 ObMenuParseState *state = data;
293 if (!obt_parse_attr_string(node, "label", &label))
296 menu_add_separator(state->parent, -1, label);
301 static void parse_menu(xmlNodePtr node, gpointer data)
303 ObMenuParseState *state = data;
304 gchar *name = NULL, *title = NULL, *script = NULL;
307 if (!obt_parse_attr_string(node, "id", &name))
308 goto parse_menu_fail;
310 if (!g_hash_table_lookup(menu_hash, name)) {
311 if (!obt_parse_attr_string(node, "label", &title))
312 goto parse_menu_fail;
314 if ((menu = menu_new(name, title, TRUE, NULL))) {
315 menu->pipe_creator = state->pipe_creator;
316 if (obt_parse_attr_string(node, "execute", &script)) {
317 menu->execute = obt_paths_expand_tilde(script);
322 state->parent = menu;
323 obt_parse_tree(menu_parse_inst, node->children);
330 menu_add_submenu(state->parent, -1, name);
338 ObMenu* menu_new(const gchar *name, const gchar *title,
339 gboolean allow_shortcut_selection, gpointer data)
343 self = g_new0(ObMenu, 1);
344 self->name = g_strdup(name);
347 self->shortcut = parse_shortcut(title, allow_shortcut_selection,
348 &self->title, &self->shortcut_position,
349 &self->shortcut_always_show);
351 g_hash_table_replace(menu_hash, self->name, self);
353 /* Each menu has a single more_menu. When the menu spills past what
354 can fit on the screen, a new menu frame entry is created from this
355 more_menu, and a new menu frame for the submenu is created for this
356 menu, also pointing to the more_menu.
358 This can be done multiple times using the same more_menu.
360 more_menu->more_menu will always be NULL, since there is only 1 for
362 self->more_menu = g_new0(ObMenu, 1);
363 self->more_menu->name = _("More...");
364 self->more_menu->title = _("More...");
365 self->more_menu->data = data;
366 self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
371 static void menu_destroy_hash_value(ObMenu *self)
373 /* make sure its not visible */
378 for (it = menu_frame_visible; it; it = g_list_next(it)) {
381 menu_frame_hide_all();
385 if (self->destroy_func)
386 self->destroy_func(self, self->data);
388 menu_clear_entries(self);
391 g_free(self->execute);
392 g_free(self->more_menu);
397 void menu_free(ObMenu *menu)
400 g_hash_table_remove(menu_hash, menu->name);
403 static gboolean menu_hide_delay_func(gpointer data)
405 menu_can_hide = TRUE;
406 return FALSE; /* no repeat */
409 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
414 if (!(self = menu_from_name(name)) ||
415 grab_on_keyboard() || grab_on_pointer()) return;
417 /* if the requested menu is already the top visible menu, then don't
419 if (menu_frame_visible) {
420 frame = menu_frame_visible->data;
421 if (frame->menu == self)
425 menu_frame_hide_all();
427 /* clear the pipe menus when showing a new menu */
428 menu_clear_pipe_caches();
430 frame = menu_frame_new(self, 0, client);
431 if (!menu_frame_show_topmenu(frame, x, y, mouse))
432 menu_frame_free(frame);
435 /* select the first entry if it's not a submenu and we opened
436 * the menu with the keyboard, and skip all headers */
437 GList *it = frame->entries;
439 ObMenuEntryFrame *e = it->data;
440 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
441 menu_frame_select(frame, e, FALSE);
443 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
444 it = g_list_next(it);
450 /* reset the hide timer */
452 menu_can_hide = TRUE;
454 menu_can_hide = FALSE;
455 obt_main_loop_timeout_add(ob_main_loop,
456 config_menu_hide_delay * 1000,
457 menu_hide_delay_func,
458 NULL, g_direct_equal, NULL);
463 gboolean menu_hide_delay_reached(void)
465 return menu_can_hide;
468 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
474 self = g_new0(ObMenuEntry, 1);
481 case OB_MENU_ENTRY_TYPE_NORMAL:
482 self->data.normal.enabled = TRUE;
484 case OB_MENU_ENTRY_TYPE_SUBMENU:
485 case OB_MENU_ENTRY_TYPE_SEPARATOR:
492 void menu_entry_ref(ObMenuEntry *self)
497 void menu_entry_unref(ObMenuEntry *self)
499 if (self && --self->ref == 0) {
500 switch (self->type) {
501 case OB_MENU_ENTRY_TYPE_NORMAL:
502 RrImageUnref(self->data.normal.icon);
503 g_free(self->data.normal.label);
504 while (self->data.normal.actions) {
505 actions_act_unref(self->data.normal.actions->data);
506 self->data.normal.actions =
507 g_slist_delete_link(self->data.normal.actions,
508 self->data.normal.actions);
511 case OB_MENU_ENTRY_TYPE_SUBMENU:
512 g_free(self->data.submenu.name);
514 case OB_MENU_ENTRY_TYPE_SEPARATOR:
515 g_free(self->data.separator.label);
523 void menu_clear_entries(ObMenu *self)
526 /* assert that the menu isn't visible */
531 for (it = menu_frame_visible; it; it = g_list_next(it)) {
533 g_assert(f->menu != self);
538 while (self->entries) {
539 menu_entry_unref(self->entries->data);
540 self->entries = g_list_delete_link(self->entries, self->entries);
542 self->more_menu->entries = self->entries; /* keep it in sync */
545 void menu_entry_remove(ObMenuEntry *self)
547 self->menu->entries = g_list_remove(self->menu->entries, self);
548 menu_entry_unref(self);
551 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
552 GSList *actions, gboolean allow_shortcut)
556 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
557 e->data.normal.actions = actions;
559 menu_entry_set_label(e, label, allow_shortcut);
561 self->entries = g_list_append(self->entries, e);
562 self->more_menu->entries = self->entries; /* keep it in sync */
566 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
569 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
570 /* points to itself */
571 e->data.submenu.name = g_strdup(self->name);
572 e->data.submenu.submenu = self;
573 e->data.submenu.show_from = show_from;
577 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
581 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
582 e->data.submenu.name = g_strdup(submenu);
584 self->entries = g_list_append(self->entries, e);
585 self->more_menu->entries = self->entries; /* keep it in sync */
589 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
593 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
595 menu_entry_set_label(e, label, FALSE);
597 self->entries = g_list_append(self->entries, e);
598 self->more_menu->entries = self->entries; /* keep it in sync */
602 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
604 self->show_func = func;
607 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
609 self->hide_func = func;
612 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
614 self->update_func = func;
617 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
619 self->execute_func = func;
620 self->more_menu->execute_func = func; /* keep it in sync */
623 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
625 self->destroy_func = func;
628 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
630 self->place_func = func;
633 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
635 ObMenuEntry *ret = NULL;
638 for (it = self->entries; it; it = g_list_next(it)) {
639 ObMenuEntry *e = it->data;
649 void menu_find_submenus(ObMenu *self)
653 for (it = self->entries; it; it = g_list_next(it)) {
654 ObMenuEntry *e = it->data;
656 if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
657 e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
661 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
662 gboolean allow_shortcut)
664 switch (self->type) {
665 case OB_MENU_ENTRY_TYPE_SEPARATOR:
666 g_free(self->data.separator.label);
667 self->data.separator.label = g_strdup(label);
669 case OB_MENU_ENTRY_TYPE_NORMAL:
670 g_free(self->data.normal.label);
671 self->data.normal.shortcut =
672 parse_shortcut(label, allow_shortcut, &self->data.normal.label,
673 &self->data.normal.shortcut_position,
674 &self->data.normal.shortcut_always_show);
677 g_assert_not_reached();
681 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
683 self->show_all_shortcuts = show;