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(reconfig);
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 client_list_menu_shutdown(reconfig);
115 menu_frame_hide_all();
116 g_hash_table_destroy(menu_hash);
120 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
123 return menu->pipe_creator == data;
126 void menu_pipe_execute(ObMenu *self)
136 if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
137 g_warning("Failed to execute command for pipe-menu: %s", err->message);
142 if (parse_load_mem(output, strlen(output),
143 "openbox_pipe_menu", &doc, &node))
145 g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, self);
146 menu_clear_entries(self);
148 menu_parse_state.pipe_creator = self;
149 menu_parse_state.parent = self;
150 parse_tree(menu_parse_inst, doc, node->children);
153 g_warning("Invalid output from pipe-menu: %s", self->execute);
159 static ObMenu* menu_from_name(gchar *name)
163 g_assert(name != NULL);
165 if (!(self = g_hash_table_lookup(menu_hash, name)))
166 g_warning("Attempted to access menu '%s' but it does not exist.",
171 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
174 ObMenuParseState *state = data;
178 if (parse_attr_string("label", node, &label)) {
181 for (node = node->children; node; node = node->next)
182 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
183 ObAction *a = action_parse
184 (i, doc, node, OB_USER_ACTION_MENU_SELECTION);
186 acts = g_slist_append(acts, a);
188 menu_add_normal(state->parent, -1, label, acts);
194 static void parse_menu_separator(ObParseInst *i,
195 xmlDocPtr doc, xmlNodePtr node,
198 ObMenuParseState *state = data;
201 menu_add_separator(state->parent, -1);
204 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
207 ObMenuParseState *state = data;
208 gchar *name = NULL, *title = NULL, *script = NULL;
211 if (!parse_attr_string("id", node, &name))
212 goto parse_menu_fail;
214 if (!g_hash_table_lookup(menu_hash, name)) {
215 if (!parse_attr_string("label", node, &title))
216 goto parse_menu_fail;
218 if ((menu = menu_new(name, title, NULL))) {
219 menu->pipe_creator = state->pipe_creator;
220 if (parse_attr_string("execute", node, &script)) {
221 menu->execute = parse_expand_tilde(script);
226 state->parent = menu;
227 parse_tree(i, doc, node->children);
234 menu_add_submenu(state->parent, -1, name);
242 ObMenu* menu_new(gchar *name, gchar *title, gpointer data)
246 self = g_new0(ObMenu, 1);
247 self->name = g_strdup(name);
248 self->title = g_strdup(title);
251 g_hash_table_replace(menu_hash, self->name, self);
256 static void menu_destroy_hash_value(ObMenu *self)
258 /* make sure its not visible */
263 for (it = menu_frame_visible; it; it = g_list_next(it)) {
266 menu_frame_hide_all();
270 if (self->destroy_func)
271 self->destroy_func(self, self->data);
273 menu_clear_entries(self);
276 g_free(self->execute);
281 void menu_free(ObMenu *menu)
283 g_hash_table_remove(menu_hash, menu->name);
286 void menu_show(gchar *name, gint x, gint y, ObClient *client)
292 if (!(self = menu_from_name(name))
293 || keyboard_interactively_grabbed()) return;
295 /* if the requested menu is already the top visible menu, then don't
297 if (menu_frame_visible) {
298 frame = menu_frame_visible->data;
299 if (frame->menu == self)
303 menu_frame_hide_all();
305 frame = menu_frame_new(self, client);
306 if (client && x < 0 && y < 0) {
307 x = client->frame->area.x + client->frame->size.left;
308 y = client->frame->area.y + client->frame->size.top;
309 menu_frame_move(frame, x, y);
311 menu_frame_move(frame,
312 x - ob_rr_theme->bwidth, y - ob_rr_theme->bwidth);
313 for (i = 0; i < screen_num_monitors; ++i) {
314 Rect *a = screen_physical_area_monitor(i);
315 if (RECT_CONTAINS(*a, x, y)) {
320 if (!menu_frame_show(frame, NULL))
321 menu_frame_free(frame);
322 else if (frame->entries) {
323 ObMenuEntryFrame *e = frame->entries->data;
324 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL &&
325 e->entry->data.normal.enabled)
326 menu_frame_select(frame, e);
330 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
336 self = g_new0(ObMenuEntry, 1);
342 case OB_MENU_ENTRY_TYPE_NORMAL:
343 self->data.normal.enabled = TRUE;
345 case OB_MENU_ENTRY_TYPE_SUBMENU:
346 case OB_MENU_ENTRY_TYPE_SEPARATOR:
353 void menu_entry_free(ObMenuEntry *self)
356 switch (self->type) {
357 case OB_MENU_ENTRY_TYPE_NORMAL:
358 g_free(self->data.normal.label);
359 while (self->data.normal.actions) {
360 action_unref(self->data.normal.actions->data);
361 self->data.normal.actions =
362 g_slist_delete_link(self->data.normal.actions,
363 self->data.normal.actions);
366 case OB_MENU_ENTRY_TYPE_SUBMENU:
367 g_free(self->data.submenu.name);
369 case OB_MENU_ENTRY_TYPE_SEPARATOR:
377 void menu_clear_entries(ObMenu *self)
380 /* assert that the menu isn't visible */
385 for (it = menu_frame_visible; it; it = g_list_next(it)) {
387 g_assert(f->menu != self);
392 while (self->entries) {
393 menu_entry_free(self->entries->data);
394 self->entries = g_list_delete_link(self->entries, self->entries);
398 void menu_entry_remove(ObMenuEntry *self)
400 self->menu->entries = g_list_remove(self->menu->entries, self);
401 menu_entry_free(self);
404 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, gchar *label,
409 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
410 e->data.normal.label = g_strdup(label);
411 e->data.normal.actions = actions;
413 self->entries = g_list_append(self->entries, e);
417 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, gchar *submenu)
421 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
422 e->data.submenu.name = g_strdup(submenu);
424 self->entries = g_list_append(self->entries, e);
428 ObMenuEntry* menu_add_separator(ObMenu *self, gint id)
432 e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
434 self->entries = g_list_append(self->entries, e);
438 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
440 self->update_func = func;
443 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
445 self->execute_func = func;
448 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
450 self->destroy_func = func;
453 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
455 ObMenuEntry *ret = NULL;
458 for (it = self->entries; it; it = g_list_next(it)) {
459 ObMenuEntry *e = it->data;
469 void menu_find_submenus(ObMenu *self)
473 for (it = self->entries; it; it = g_list_next(it)) {
474 ObMenuEntry *e = it->data;
476 if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
477 e->data.submenu.submenu = menu_from_name(e->data.submenu.name);