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
);
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()
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
)
209 gunichar shortcut
= 0;
213 g_assert(strippedlabel
!= NULL
);
216 *strippedlabel
= NULL
;
220 *strippedlabel
= g_strdup(label
);
222 /* if allow_shortcut is false, then you can't use the &, instead you
223 have to just use the first valid character
226 i
= strchr(*strippedlabel
, '&');
227 if (allow_shortcut
&& i
!= NULL
) {
228 /* there is an ampersand in the string */
230 /* you have to use a printable ascii character for shortcuts
231 don't allow space either, so you can have like "a & b"
233 if (VALID_SHORTCUT(*(i
+1))) {
234 shortcut
= g_unichar_tolower(g_utf8_get_char(i
+1));
235 *position
= i
- *strippedlabel
;
237 /* remove the & from the string */
238 for (; *i
!= '\0'; ++i
)
242 /* there is no ampersand, so find the first valid character to use
245 for (i
= *strippedlabel
; *i
!= '\0'; ++i
)
246 if (VALID_SHORTCUT(*i
)) {
247 *position
= i
- *strippedlabel
;
248 shortcut
= g_unichar_tolower(g_utf8_get_char(i
));
256 static void parse_menu_item(ObParseInst
*i
, xmlDocPtr doc
, xmlNodePtr node
,
259 ObMenuParseState
*state
= data
;
263 if (parse_attr_string("label", node
, &label
)) {
266 for (node
= node
->children
; node
; node
= node
->next
)
267 if (!xmlStrcasecmp(node
->name
, (const xmlChar
*) "action")) {
268 ObActionsAct
*a
= actions_parse(i
, doc
, node
);
270 acts
= g_slist_append(acts
, a
);
272 menu_add_normal(state
->parent
, -1, label
, acts
, FALSE
);
278 static void parse_menu_separator(ObParseInst
*i
,
279 xmlDocPtr doc
, xmlNodePtr node
,
282 ObMenuParseState
*state
= data
;
287 if (!parse_attr_string("label", node
, &label
))
290 menu_add_separator(state
->parent
, -1, label
);
295 static void parse_menu(ObParseInst
*i
, xmlDocPtr doc
, xmlNodePtr node
,
298 ObMenuParseState
*state
= data
;
299 gchar
*name
= NULL
, *title
= NULL
, *script
= NULL
;
302 if (!parse_attr_string("id", node
, &name
))
303 goto parse_menu_fail
;
305 if (!g_hash_table_lookup(menu_hash
, name
)) {
306 if (!parse_attr_string("label", node
, &title
))
307 goto parse_menu_fail
;
309 if ((menu
= menu_new(name
, title
, FALSE
, NULL
))) {
310 menu
->pipe_creator
= state
->pipe_creator
;
311 if (parse_attr_string("execute", node
, &script
)) {
312 menu
->execute
= parse_expand_tilde(script
);
317 state
->parent
= menu
;
318 parse_tree(i
, doc
, node
->children
);
325 menu_add_submenu(state
->parent
, -1, name
);
333 ObMenu
* menu_new(const gchar
*name
, const gchar
*title
,
334 gboolean allow_shortcut_selection
, gpointer data
)
338 self
= g_new0(ObMenu
, 1);
339 self
->name
= g_strdup(name
);
342 self
->shortcut
= parse_shortcut(title
, allow_shortcut_selection
,
343 &self
->title
, &self
->shortcut_position
);
345 g_hash_table_replace(menu_hash
, self
->name
, self
);
347 /* Each menu has a single more_menu. When the menu spills past what
348 can fit on the screen, a new menu frame entry is created from this
349 more_menu, and a new menu frame for the submenu is created for this
350 menu, also pointing to the more_menu.
352 This can be done multiple times using the same more_menu.
354 more_menu->more_menu will always be NULL, since there is only 1 for
356 self
->more_menu
= g_new0(ObMenu
, 1);
357 self
->more_menu
->name
= _("More...");
358 self
->more_menu
->title
= _("More...");
359 self
->more_menu
->data
= data
;
360 self
->more_menu
->shortcut
= g_unichar_tolower(g_utf8_get_char("M"));
362 self
->more_menu
->show_func
= self
->show_func
;
363 self
->more_menu
->hide_func
= self
->hide_func
;
364 self
->more_menu
->update_func
= self
->update_func
;
365 self
->more_menu
->execute_func
= self
->execute_func
;
366 self
->more_menu
->destroy_func
= self
->destroy_func
;
367 self
->more_menu
->place_func
= self
->place_func
;
372 static void menu_destroy_hash_value(ObMenu
*self
)
374 /* make sure its not visible */
379 for (it
= menu_frame_visible
; it
; it
= g_list_next(it
)) {
382 menu_frame_hide_all();
386 if (self
->destroy_func
)
387 self
->destroy_func(self
, self
->data
);
389 menu_clear_entries(self
);
392 g_free(self
->execute
);
393 g_free(self
->more_menu
);
398 void menu_free(ObMenu
*menu
)
401 g_hash_table_remove(menu_hash
, menu
->name
);
404 static gboolean
menu_hide_delay_func(gpointer data
)
406 menu_can_hide
= TRUE
;
407 return FALSE
; /* no repeat */
410 void menu_show(gchar
*name
, gint x
, gint y
, gboolean mouse
, ObClient
*client
)
415 if (!(self
= menu_from_name(name
)) ||
416 grab_on_keyboard() || grab_on_pointer()) return;
418 /* if the requested menu is already the top visible menu, then don't
420 if (menu_frame_visible
) {
421 frame
= menu_frame_visible
->data
;
422 if (frame
->menu
== self
)
426 menu_frame_hide_all();
428 /* clear the pipe menus when showing a new menu */
429 menu_clear_pipe_caches();
431 frame
= menu_frame_new(self
, 0, client
);
432 if (!menu_frame_show_topmenu(frame
, x
, y
, mouse
))
433 menu_frame_free(frame
);
436 /* select the first entry if it's not a submenu and we opened
437 * the menu with the keyboard, and skip all headers */
438 GList
*it
= frame
->entries
;
440 ObMenuEntryFrame
*e
= it
->data
;
441 if (e
->entry
->type
== OB_MENU_ENTRY_TYPE_NORMAL
) {
442 menu_frame_select(frame
, e
, FALSE
);
444 } else if (e
->entry
->type
== OB_MENU_ENTRY_TYPE_SEPARATOR
)
445 it
= g_list_next(it
);
451 /* reset the hide timer */
453 menu_can_hide
= TRUE
;
455 menu_can_hide
= FALSE
;
456 ob_main_loop_timeout_add(ob_main_loop
,
457 config_menu_hide_delay
* 1000,
458 menu_hide_delay_func
,
459 NULL
, g_direct_equal
, NULL
);
464 gboolean
menu_hide_delay_reached()
466 return menu_can_hide
;
469 static ObMenuEntry
* menu_entry_new(ObMenu
*menu
, ObMenuEntryType type
, gint id
)
475 self
= g_new0(ObMenuEntry
, 1);
482 case OB_MENU_ENTRY_TYPE_NORMAL
:
483 self
->data
.normal
.enabled
= TRUE
;
485 case OB_MENU_ENTRY_TYPE_SUBMENU
:
486 case OB_MENU_ENTRY_TYPE_SEPARATOR
:
493 void menu_entry_ref(ObMenuEntry
*self
)
498 void menu_entry_unref(ObMenuEntry
*self
)
500 if (self
&& --self
->ref
== 0) {
501 switch (self
->type
) {
502 case OB_MENU_ENTRY_TYPE_NORMAL
:
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
:
522 void menu_clear_entries(ObMenu
*self
)
525 /* assert that the menu isn't visible */
530 for (it
= menu_frame_visible
; it
; it
= g_list_next(it
)) {
532 g_assert(f
->menu
!= self
);
537 while (self
->entries
) {
538 menu_entry_unref(self
->entries
->data
);
539 self
->entries
= g_list_delete_link(self
->entries
, self
->entries
);
541 self
->more_menu
->entries
= self
->entries
; /* keep it in sync */
544 void menu_entry_remove(ObMenuEntry
*self
)
546 self
->menu
->entries
= g_list_remove(self
->menu
->entries
, self
);
547 menu_entry_unref(self
);
550 ObMenuEntry
* menu_add_normal(ObMenu
*self
, gint id
, const gchar
*label
,
551 GSList
*actions
, gboolean allow_shortcut
)
555 e
= menu_entry_new(self
, OB_MENU_ENTRY_TYPE_NORMAL
, id
);
556 e
->data
.normal
.actions
= actions
;
558 menu_entry_set_label(e
, label
, allow_shortcut
);
560 self
->entries
= g_list_append(self
->entries
, e
);
561 self
->more_menu
->entries
= self
->entries
; /* keep it in sync */
565 ObMenuEntry
* menu_get_more(ObMenu
*self
, guint show_from
)
568 e
= menu_entry_new(self
, OB_MENU_ENTRY_TYPE_SUBMENU
, -1);
569 /* points to itself */
570 e
->data
.submenu
.name
= g_strdup(self
->name
);
571 e
->data
.submenu
.submenu
= self
;
572 e
->data
.submenu
.show_from
= show_from
;
576 ObMenuEntry
* menu_add_submenu(ObMenu
*self
, gint id
, const gchar
*submenu
)
580 e
= menu_entry_new(self
, OB_MENU_ENTRY_TYPE_SUBMENU
, id
);
581 e
->data
.submenu
.name
= g_strdup(submenu
);
583 self
->entries
= g_list_append(self
->entries
, e
);
584 self
->more_menu
->entries
= self
->entries
; /* keep it in sync */
588 ObMenuEntry
* menu_add_separator(ObMenu
*self
, gint id
, const gchar
*label
)
592 e
= menu_entry_new(self
, OB_MENU_ENTRY_TYPE_SEPARATOR
, id
);
594 menu_entry_set_label(e
, label
, FALSE
);
596 self
->entries
= g_list_append(self
->entries
, e
);
597 self
->more_menu
->entries
= self
->entries
; /* keep it in sync */
601 void menu_set_show_func(ObMenu
*self
, ObMenuShowFunc func
)
603 self
->show_func
= func
;
604 self
->more_menu
->show_func
= func
; /* keep it in sync */
607 void menu_set_hide_func(ObMenu
*self
, ObMenuHideFunc func
)
609 self
->hide_func
= func
;
610 self
->more_menu
->hide_func
= func
; /* keep it in sync */
613 void menu_set_update_func(ObMenu
*self
, ObMenuUpdateFunc func
)
615 self
->update_func
= func
;
616 self
->more_menu
->update_func
= func
; /* keep it in sync */
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
;
628 self
->more_menu
->destroy_func
= func
; /* keep it in sync */
631 void menu_set_place_func(ObMenu
*self
, ObMenuPlaceFunc func
)
633 self
->place_func
= func
;
634 self
->more_menu
->place_func
= func
; /* keep it in sync */
637 ObMenuEntry
* menu_find_entry_id(ObMenu
*self
, gint id
)
639 ObMenuEntry
*ret
= NULL
;
642 for (it
= self
->entries
; it
; it
= g_list_next(it
)) {
643 ObMenuEntry
*e
= it
->data
;
653 void menu_find_submenus(ObMenu
*self
)
657 for (it
= self
->entries
; it
; it
= g_list_next(it
)) {
658 ObMenuEntry
*e
= it
->data
;
660 if (e
->type
== OB_MENU_ENTRY_TYPE_SUBMENU
)
661 e
->data
.submenu
.submenu
= menu_from_name(e
->data
.submenu
.name
);
665 void menu_entry_set_label(ObMenuEntry
*self
, const gchar
*label
,
666 gboolean allow_shortcut
)
668 switch (self
->type
) {
669 case OB_MENU_ENTRY_TYPE_SEPARATOR
:
670 g_free(self
->data
.separator
.label
);
671 self
->data
.separator
.label
= g_strdup(label
);
673 case OB_MENU_ENTRY_TYPE_NORMAL
:
674 g_free(self
->data
.normal
.label
);
675 self
->data
.normal
.shortcut
=
676 parse_shortcut(label
, allow_shortcut
, &self
->data
.normal
.label
,
677 &self
->data
.normal
.shortcut_position
);
680 g_assert_not_reached();
684 void menu_show_all_shortcuts(ObMenu
*self
, gboolean show
)
686 self
->show_all_shortcuts
= show
;