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