no tabs
[mikachu/openbox.git] / openbox / menu.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    menu.c for the Openbox window manager
4    Copyright (c) 2003        Ben Jansens
5
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.
10
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.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #include "debug.h"
20 #include "menu.h"
21 #include "openbox.h"
22 #include "stacking.h"
23 #include "client.h"
24 #include "config.h"
25 #include "screen.h"
26 #include "menuframe.h"
27 #include "geom.h"
28 #include "misc.h"
29 #include "client_menu.h"
30 #include "client_list_menu.h"
31 #include "parser/parse.h"
32
33 typedef struct _ObMenuParseState ObMenuParseState;
34
35 struct _ObMenuParseState
36 {
37     ObMenu *parent;
38     ObMenu *pipe_creator;
39 };
40
41 static GHashTable *menu_hash = NULL;
42 static ObParseInst *menu_parse_inst;
43 static ObMenuParseState menu_parse_state;
44
45 static void menu_destroy_hash_value(ObMenu *self);
46 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
47                             gpointer data);
48 static void parse_menu_separator(ObParseInst *i,
49                                  xmlDocPtr doc, xmlNodePtr node,
50                                  gpointer data);
51 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
52                        gpointer data);
53
54 static void client_dest(gpointer client)
55 {
56     /* menus can be associated with a client, so close any that are since
57        we are disappearing now */
58     menu_frame_hide_all_client(client);
59 }
60
61 void menu_startup(gboolean reconfig)
62 {
63     xmlDocPtr doc;
64     xmlNodePtr node;
65     gboolean loaded = FALSE;
66     GSList *it;
67
68     menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
69                                       (GDestroyNotify)menu_destroy_hash_value);
70
71     client_list_menu_startup();
72     client_menu_startup();
73
74     menu_parse_inst = parse_startup();
75
76     menu_parse_state.parent = NULL;
77     menu_parse_state.pipe_creator = NULL;
78     parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
79     parse_register(menu_parse_inst, "item", parse_menu_item,
80                    &menu_parse_state);
81     parse_register(menu_parse_inst, "separator",
82                    parse_menu_separator, &menu_parse_state);
83
84     for (it = config_menu_files; it; it = g_slist_next(it)) {
85         if (parse_load_menu(it->data, &doc, &node)) {
86             loaded = TRUE;
87             parse_tree(menu_parse_inst, doc, node->children);
88             xmlFreeDoc(doc);
89         }
90     }
91     if (!loaded) {
92         if (parse_load_menu("menu.xml", &doc, &node)) {
93             parse_tree(menu_parse_inst, doc, node->children);
94             xmlFreeDoc(doc);
95         }
96     }
97     
98     g_assert(menu_parse_state.parent == NULL);
99
100     if (!reconfig)
101         client_add_destructor(client_dest);
102 }
103
104 void menu_shutdown(gboolean reconfig)
105 {
106     if (!reconfig)
107         client_remove_destructor(client_dest);
108
109     parse_shutdown(menu_parse_inst);
110     menu_parse_inst = NULL;
111
112     menu_frame_hide_all();
113     g_hash_table_destroy(menu_hash);
114     menu_hash = NULL;
115 }
116
117 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
118 {
119     ObMenu *menu = val;
120     return menu->pipe_creator == data;
121 }
122
123 void menu_pipe_execute(ObMenu *self)
124 {
125     xmlDocPtr doc;
126     xmlNodePtr node;
127     gchar *output;
128     GError *err = NULL;
129
130     if (!self->execute)
131         return;
132
133     if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
134         g_warning("Failed to execute command for pipe-menu: %s", err->message);
135         g_error_free(err);
136         return;
137     }
138
139     if (parse_load_mem(output, strlen(output),
140                        "openbox_pipe_menu", &doc, &node))
141     {
142         g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, self);
143         menu_clear_entries(self);
144
145         menu_parse_state.pipe_creator = self;
146         menu_parse_state.parent = self;
147         parse_tree(menu_parse_inst, doc, node->children);
148         xmlFreeDoc(doc);
149     } else {
150         g_warning("Invalid output from pipe-menu: %s", self->execute);
151     }
152
153     g_free(output);
154 }
155
156 static ObMenu* menu_from_name(gchar *name)
157 {
158     ObMenu *self = NULL;
159
160     g_assert(name != NULL);
161
162     if (!(self = g_hash_table_lookup(menu_hash, name)))
163         g_warning("Attempted to access menu '%s' but it does not exist.",
164                   name);
165     return self;
166 }  
167
168 static void parse_menu_item(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
169                             gpointer data)
170 {
171     ObMenuParseState *state = data;
172     gchar *label;
173     
174     if (state->parent) {
175         if (parse_attr_string("label", node, &label)) {
176             GSList *acts = NULL;
177
178             for (node = node->children; node; node = node->next)
179                 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action"))
180                     acts = g_slist_append(acts, action_parse
181                                           (i, doc, node,
182                                            OB_USER_ACTION_MENU_SELECTION));
183             menu_add_normal(state->parent, -1, label, acts);
184             g_free(label);
185         }
186     }
187 }
188
189 static void parse_menu_separator(ObParseInst *i,
190                                  xmlDocPtr doc, xmlNodePtr node,
191                                  gpointer data)
192 {
193     ObMenuParseState *state = data;
194
195     if (state->parent)
196         menu_add_separator(state->parent, -1);
197 }
198
199 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
200                        gpointer data)
201 {
202     ObMenuParseState *state = data;
203     gchar *name = NULL, *title = NULL, *script = NULL;
204     ObMenu *menu;
205
206     if (!parse_attr_string("id", node, &name))
207         goto parse_menu_fail;
208
209     if (!g_hash_table_lookup(menu_hash, name)) {
210         if (!parse_attr_string("label", node, &title))
211             goto parse_menu_fail;
212
213         if ((menu = menu_new(name, title, NULL))) {
214             menu->pipe_creator = state->pipe_creator;
215             if (parse_attr_string("execute", node, &script)) {
216                 menu->execute = parse_expand_tilde(script);
217             } else {
218                 ObMenu *old;
219
220                 old = state->parent;
221                 state->parent = menu;
222                 parse_tree(i, doc, node->children);
223                 state->parent = old;
224             }
225         }
226     }
227
228     if (state->parent)
229         menu_add_submenu(state->parent, -1, name);
230
231 parse_menu_fail:
232     g_free(name);
233     g_free(title);
234     g_free(script);
235 }
236
237 ObMenu* menu_new(gchar *name, gchar *title, gpointer data)
238 {
239     ObMenu *self;
240
241     self = g_new0(ObMenu, 1);
242     self->name = g_strdup(name);
243     self->title = g_strdup(title);
244     self->data = data;
245
246     g_hash_table_replace(menu_hash, self->name, self);
247
248     return self;
249 }
250
251 static void menu_destroy_hash_value(ObMenu *self)
252 {
253     /* make sure its not visible */
254     {
255         GList *it;
256         ObMenuFrame *f;
257
258         for (it = menu_frame_visible; it; it = g_list_next(it)) {
259             f = it->data;
260             if (f->menu == self)
261                 menu_frame_hide_all();
262         }
263     }
264
265     if (self->destroy_func)
266         self->destroy_func(self, self->data);
267
268     menu_clear_entries(self);
269     g_free(self->name);
270     g_free(self->title);
271     g_free(self->execute);
272
273     g_free(self);
274 }
275
276 void menu_free(ObMenu *menu)
277 {
278     g_hash_table_remove(menu_hash, menu->name);
279 }
280
281 void menu_show(gchar *name, gint x, gint y, ObClient *client)
282 {
283     ObMenu *self;
284     ObMenuFrame *frame;
285
286     if (!(self = menu_from_name(name))) return;
287
288     menu_frame_hide_all();
289
290     frame = menu_frame_new(self, client);
291     menu_frame_move(frame, x, y);
292     menu_frame_show(frame, NULL);
293     if (frame->entries)
294         menu_frame_select_next(frame);
295 }
296
297 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
298 {
299     ObMenuEntry *self;
300
301     g_assert(menu);
302
303     self = g_new0(ObMenuEntry, 1);
304     self->type = type;
305     self->menu = menu;
306     self->id = id;
307
308     switch (type) {
309     case OB_MENU_ENTRY_TYPE_NORMAL:
310         self->data.normal.enabled = TRUE;
311         break;
312     case OB_MENU_ENTRY_TYPE_SUBMENU:
313     case OB_MENU_ENTRY_TYPE_SEPARATOR:
314         break;
315     }
316
317     return self;
318 }
319
320 void menu_entry_free(ObMenuEntry *self)
321 {
322     if (self) {
323         switch (self->type) {
324         case OB_MENU_ENTRY_TYPE_NORMAL:
325             g_free(self->data.normal.label);
326             while (self->data.normal.actions) {
327                 action_free(self->data.normal.actions->data);
328                 self->data.normal.actions =
329                     g_slist_delete_link(self->data.normal.actions,
330                                         self->data.normal.actions);
331             }
332             break;
333         case OB_MENU_ENTRY_TYPE_SUBMENU:
334             g_free(self->data.submenu.name);
335             break;
336         case OB_MENU_ENTRY_TYPE_SEPARATOR:
337             break;
338         }
339
340         g_free(self);
341     }
342 }
343
344 void menu_clear_entries(ObMenu *self)
345 {
346 #ifdef DEBUG
347     /* assert that the menu isn't visible */
348     {
349         GList *it;
350         ObMenuFrame *f;
351
352         for (it = menu_frame_visible; it; it = g_list_next(it)) {
353             f = it->data;
354             g_assert(f->menu != self);
355         }
356     }
357 #endif
358
359     while (self->entries) {
360         menu_entry_free(self->entries->data);
361         self->entries = g_list_delete_link(self->entries, self->entries);
362     }
363 }
364
365 void menu_entry_remove(ObMenuEntry *self)
366 {
367     self->menu->entries = g_list_remove(self->menu->entries, self);
368     menu_entry_free(self);
369 }
370
371 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, gchar *label,
372                              GSList *actions)
373 {
374     ObMenuEntry *e;
375
376     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
377     e->data.normal.label = g_strdup(label);
378     e->data.normal.actions = actions;
379
380     self->entries = g_list_append(self->entries, e);
381     return e;
382 }
383
384 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, gchar *submenu)
385 {
386     ObMenuEntry *e;
387
388     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
389     e->data.submenu.name = g_strdup(submenu);
390
391     self->entries = g_list_append(self->entries, e);
392     return e;
393 }
394
395 ObMenuEntry* menu_add_separator(ObMenu *self, gint id)
396 {
397     ObMenuEntry *e;
398
399     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
400
401     self->entries = g_list_append(self->entries, e);
402     return e;
403 }
404
405 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
406 {
407     self->update_func = func;
408 }
409
410 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
411 {
412     self->execute_func = func;
413 }
414
415 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
416 {
417     self->destroy_func = func;
418 }
419
420 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
421 {
422     ObMenuEntry *ret = NULL;
423     GList *it;
424
425     for (it = self->entries; it; it = g_list_next(it)) {
426         ObMenuEntry *e = it->data;
427
428         if (e->id == id) {
429             ret = e;
430             break;
431         }
432     }
433     return ret;
434 }
435
436 void menu_find_submenus(ObMenu *self)
437 {
438     GList *it;
439
440     for (it = self->entries; it; it = g_list_next(it)) {
441         ObMenuEntry *e = it->data;
442
443         if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
444             e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
445     }
446 }