1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 menu.c for the Openbox window manager
4 Copyright (c) 2003 Ben Jansens
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 See the COPYING file for a copy of the GNU General Public License.
26 #include "menuframe.h"
30 #include "client_menu.h"
31 #include "client_list_menu.h"
32 #include "parser/parse.h"
34 typedef struct _ObMenuParseState ObMenuParseState
;
36 struct _ObMenuParseState
42 static GHashTable
*menu_hash
= NULL
;
43 static ObParseInst
*menu_parse_inst
;
44 static ObMenuParseState menu_parse_state
;
46 static void menu_destroy_hash_value(ObMenu
*self
);
47 static void parse_menu_item(ObParseInst
*i
, xmlDocPtr doc
, xmlNodePtr node
,
49 static void parse_menu_separator(ObParseInst
*i
,
50 xmlDocPtr doc
, xmlNodePtr node
,
52 static void parse_menu(ObParseInst
*i
, xmlDocPtr doc
, xmlNodePtr node
,
55 static void client_dest(ObClient
*client
, gpointer data
)
57 /* menus can be associated with a client, so close any that are since
58 we are disappearing now */
59 menu_frame_hide_all_client(client
);
62 void menu_startup(gboolean reconfig
)
66 gboolean loaded
= FALSE
;
69 menu_hash
= g_hash_table_new_full(g_str_hash
, g_str_equal
, NULL
,
70 (GDestroyNotify
)menu_destroy_hash_value
);
72 client_list_menu_startup();
73 client_menu_startup();
75 menu_parse_inst
= parse_startup();
77 menu_parse_state
.parent
= NULL
;
78 menu_parse_state
.pipe_creator
= NULL
;
79 parse_register(menu_parse_inst
, "menu", parse_menu
, &menu_parse_state
);
80 parse_register(menu_parse_inst
, "item", parse_menu_item
,
82 parse_register(menu_parse_inst
, "separator",
83 parse_menu_separator
, &menu_parse_state
);
85 for (it
= config_menu_files
; it
; it
= g_slist_next(it
)) {
86 if (parse_load_menu(it
->data
, &doc
, &node
)) {
88 parse_tree(menu_parse_inst
, doc
, node
->children
);
93 if (parse_load_menu("menu.xml", &doc
, &node
)) {
94 parse_tree(menu_parse_inst
, doc
, node
->children
);
99 g_assert(menu_parse_state
.parent
== NULL
);
102 client_add_destructor(client_dest
, NULL
);
105 void menu_shutdown(gboolean reconfig
)
108 client_remove_destructor(client_dest
);
110 parse_shutdown(menu_parse_inst
);
111 menu_parse_inst
= NULL
;
113 menu_frame_hide_all();
114 g_hash_table_destroy(menu_hash
);
118 static gboolean
menu_pipe_submenu(gpointer key
, gpointer val
, gpointer data
)
121 return menu
->pipe_creator
== data
;
124 void menu_pipe_execute(ObMenu
*self
)
134 if (!g_spawn_command_line_sync(self
->execute
, &output
, NULL
, NULL
, &err
)) {
135 g_warning("Failed to execute command for pipe-menu: %s", err
->message
);
140 if (parse_load_mem(output
, strlen(output
),
141 "openbox_pipe_menu", &doc
, &node
))
143 g_hash_table_foreach_remove(menu_hash
, menu_pipe_submenu
, self
);
144 menu_clear_entries(self
);
146 menu_parse_state
.pipe_creator
= self
;
147 menu_parse_state
.parent
= self
;
148 parse_tree(menu_parse_inst
, doc
, node
->children
);
151 g_warning("Invalid output from pipe-menu: %s", self
->execute
);
157 static ObMenu
* menu_from_name(gchar
*name
)
161 g_assert(name
!= NULL
);
163 if (!(self
= g_hash_table_lookup(menu_hash
, name
)))
164 g_warning("Attempted to access menu '%s' but it does not exist.",
169 static void parse_menu_item(ObParseInst
*i
, xmlDocPtr doc
, xmlNodePtr node
,
172 ObMenuParseState
*state
= data
;
176 if (parse_attr_string("label", node
, &label
)) {
179 for (node
= node
->children
; node
; node
= node
->next
)
180 if (!xmlStrcasecmp(node
->name
, (const xmlChar
*) "action")) {
181 ObAction
*a
= action_parse
182 (i
, doc
, node
, OB_USER_ACTION_MENU_SELECTION
);
184 acts
= g_slist_append(acts
, a
);
186 menu_add_normal(state
->parent
, -1, label
, acts
);
192 static void parse_menu_separator(ObParseInst
*i
,
193 xmlDocPtr doc
, xmlNodePtr node
,
196 ObMenuParseState
*state
= data
;
199 menu_add_separator(state
->parent
, -1);
202 static void parse_menu(ObParseInst
*i
, xmlDocPtr doc
, xmlNodePtr node
,
205 ObMenuParseState
*state
= data
;
206 gchar
*name
= NULL
, *title
= NULL
, *script
= NULL
;
209 if (!parse_attr_string("id", node
, &name
))
210 goto parse_menu_fail
;
212 if (!g_hash_table_lookup(menu_hash
, name
)) {
213 if (!parse_attr_string("label", node
, &title
))
214 goto parse_menu_fail
;
216 if ((menu
= menu_new(name
, title
, NULL
))) {
217 menu
->pipe_creator
= state
->pipe_creator
;
218 if (parse_attr_string("execute", node
, &script
)) {
219 menu
->execute
= parse_expand_tilde(script
);
224 state
->parent
= menu
;
225 parse_tree(i
, doc
, node
->children
);
232 menu_add_submenu(state
->parent
, -1, name
);
240 ObMenu
* menu_new(gchar
*name
, gchar
*title
, gpointer data
)
244 self
= g_new0(ObMenu
, 1);
245 self
->name
= g_strdup(name
);
246 self
->title
= g_strdup(title
);
249 g_hash_table_replace(menu_hash
, self
->name
, self
);
254 static void menu_destroy_hash_value(ObMenu
*self
)
256 /* make sure its not visible */
261 for (it
= menu_frame_visible
; it
; it
= g_list_next(it
)) {
264 menu_frame_hide_all();
268 if (self
->destroy_func
)
269 self
->destroy_func(self
, self
->data
);
271 menu_clear_entries(self
);
274 g_free(self
->execute
);
279 void menu_free(ObMenu
*menu
)
281 g_hash_table_remove(menu_hash
, menu
->name
);
284 void menu_show(gchar
*name
, gint x
, gint y
, ObClient
*client
)
290 if (!(self
= menu_from_name(name
))
291 || keyboard_interactively_grabbed()) return;
293 /* if the requested menu is already the top visible menu, then don't
295 if (menu_frame_visible
) {
296 frame
= menu_frame_visible
->data
;
297 if (frame
->menu
== self
)
301 menu_frame_hide_all();
303 frame
= menu_frame_new(self
, client
);
304 if (client
&& x
< 0 && y
< 0) {
305 x
= client
->frame
->area
.x
+ client
->frame
->size
.left
;
306 y
= client
->frame
->area
.y
+ client
->frame
->size
.top
;
307 menu_frame_move(frame
, x
, y
);
309 menu_frame_move(frame
,
310 x
- ob_rr_theme
->bwidth
, y
- ob_rr_theme
->bwidth
);
311 for (i
= 0; i
< screen_num_monitors
; ++i
) {
312 Rect
*a
= screen_physical_area_monitor(i
);
313 if (RECT_CONTAINS(*a
, x
, y
)) {
318 if (!menu_frame_show(frame
, NULL
))
319 menu_frame_free(frame
);
320 else if (frame
->entries
) {
321 ObMenuEntryFrame
*e
= frame
->entries
->data
;
322 if (e
->entry
->type
== OB_MENU_ENTRY_TYPE_NORMAL
&&
323 e
->entry
->data
.normal
.enabled
)
324 menu_frame_select(frame
, e
);
328 static ObMenuEntry
* menu_entry_new(ObMenu
*menu
, ObMenuEntryType type
, gint id
)
334 self
= g_new0(ObMenuEntry
, 1);
340 case OB_MENU_ENTRY_TYPE_NORMAL
:
341 self
->data
.normal
.enabled
= TRUE
;
343 case OB_MENU_ENTRY_TYPE_SUBMENU
:
344 case OB_MENU_ENTRY_TYPE_SEPARATOR
:
351 void menu_entry_free(ObMenuEntry
*self
)
354 switch (self
->type
) {
355 case OB_MENU_ENTRY_TYPE_NORMAL
:
356 g_free(self
->data
.normal
.label
);
357 while (self
->data
.normal
.actions
) {
358 action_unref(self
->data
.normal
.actions
->data
);
359 self
->data
.normal
.actions
=
360 g_slist_delete_link(self
->data
.normal
.actions
,
361 self
->data
.normal
.actions
);
364 case OB_MENU_ENTRY_TYPE_SUBMENU
:
365 g_free(self
->data
.submenu
.name
);
367 case OB_MENU_ENTRY_TYPE_SEPARATOR
:
375 void menu_clear_entries(ObMenu
*self
)
378 /* assert that the menu isn't visible */
383 for (it
= menu_frame_visible
; it
; it
= g_list_next(it
)) {
385 g_assert(f
->menu
!= self
);
390 while (self
->entries
) {
391 menu_entry_free(self
->entries
->data
);
392 self
->entries
= g_list_delete_link(self
->entries
, self
->entries
);
396 void menu_entry_remove(ObMenuEntry
*self
)
398 self
->menu
->entries
= g_list_remove(self
->menu
->entries
, self
);
399 menu_entry_free(self
);
402 ObMenuEntry
* menu_add_normal(ObMenu
*self
, gint id
, gchar
*label
,
407 e
= menu_entry_new(self
, OB_MENU_ENTRY_TYPE_NORMAL
, id
);
408 e
->data
.normal
.label
= g_strdup(label
);
409 e
->data
.normal
.actions
= actions
;
411 self
->entries
= g_list_append(self
->entries
, e
);
415 ObMenuEntry
* menu_add_submenu(ObMenu
*self
, gint id
, gchar
*submenu
)
419 e
= menu_entry_new(self
, OB_MENU_ENTRY_TYPE_SUBMENU
, id
);
420 e
->data
.submenu
.name
= g_strdup(submenu
);
422 self
->entries
= g_list_append(self
->entries
, e
);
426 ObMenuEntry
* menu_add_separator(ObMenu
*self
, gint id
)
430 e
= menu_entry_new(self
, OB_MENU_ENTRY_TYPE_SEPARATOR
, id
);
432 self
->entries
= g_list_append(self
->entries
, e
);
436 void menu_set_update_func(ObMenu
*self
, ObMenuUpdateFunc func
)
438 self
->update_func
= func
;
441 void menu_set_execute_func(ObMenu
*self
, ObMenuExecuteFunc func
)
443 self
->execute_func
= func
;
446 void menu_set_destroy_func(ObMenu
*self
, ObMenuDestroyFunc func
)
448 self
->destroy_func
= func
;
451 ObMenuEntry
* menu_find_entry_id(ObMenu
*self
, gint id
)
453 ObMenuEntry
*ret
= NULL
;
456 for (it
= self
->entries
; it
; it
= g_list_next(it
)) {
457 ObMenuEntry
*e
= it
->data
;
467 void menu_find_submenus(ObMenu
*self
)
471 for (it
= self
->entries
; it
; it
= g_list_next(it
)) {
472 ObMenuEntry
*e
= it
->data
;
474 if (e
->type
== OB_MENU_ENTRY_TYPE_SUBMENU
)
475 e
->data
.submenu
.submenu
= menu_from_name(e
->data
.submenu
.name
);