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 "grab.h"
  25 #include "client.h"
  26 #include "config.h"
  27 #include "actions.h"
  28 #include "screen.h"
  29 #include "menuframe.h"
  30 #include "keyboard.h"
  31 #include "geom.h"
  32 #include "misc.h"
  33 #include "client_menu.h"
  34 #include "client_list_menu.h"
  35 #include "client_list_combined_menu.h"
  36 #include "gettext.h"
  37 #include "obt/parse.h"
  38 #include "obt/paths.h"
  39 #include "imageload.h"
  40
  41 typedef struct _ObMenuParseState ObMenuParseState;
  42
  43 struct _ObMenuParseState
  44 {
  45     ObMenu *parent;
  46     ObMenu *pipe_creator;
  47 };
  48
  49 static GHashTable *menu_hash = NULL;
  50 static ObtParseInst *menu_parse_inst;
  51 static ObMenuParseState menu_parse_state;
  52 static gboolean menu_can_hide = FALSE;
  53
  54 static void menu_destroy_hash_value(ObMenu *self);
  55 static void parse_menu_item(xmlNodePtr node, gpointer data);
  56 static void parse_menu_separator(xmlNodePtr node, gpointer data);
  57 static void parse_menu(xmlNodePtr node, gpointer data);
  58 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
  59                                gchar **strippedlabel, guint *position,
  60                                gboolean *always_show);
  61
  62 static void client_dest(ObClient *client, gpointer data)
  63 {
  64     /* menus can be associated with a client, so close any that are since
  65        we are disappearing now */
  66     menu_frame_hide_all_client(client);
  67 }
  68
  69 void menu_startup(gboolean reconfig)
  70 {
  71     gboolean loaded = FALSE;
  72     GSList *it;
  73
  74     menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
  75                                       (GDestroyNotify)menu_destroy_hash_value);
  76
  77     client_list_menu_startup(reconfig);
  78     client_list_combined_menu_startup(reconfig);
  79     client_menu_startup();
  80
  81     menu_parse_inst = obt_parse_instance_new();
  82
  83     menu_parse_state.parent = NULL;
  84     menu_parse_state.pipe_creator = NULL;
  85     obt_parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
  86     obt_parse_register(menu_parse_inst, "item", parse_menu_item,
  87                        &menu_parse_state);
  88     obt_parse_register(menu_parse_inst, "separator",
  89                        parse_menu_separator, &menu_parse_state);
  90
  91     for (it = config_menu_files; it; it = g_slist_next(it)) {
  92         if (obt_parse_load_config_file(menu_parse_inst,
  93                                        "openbox",
  94                                        it->data,
  95                                        "openbox_menu"))
  96         {
  97             loaded = TRUE;
  98             obt_parse_tree_from_root(menu_parse_inst);
  99             obt_parse_close(menu_parse_inst);
 100         } else
 101             g_message(_("Unable to find a valid menu file \"%s\""),
 102                       (const gchar*)it->data);
 103     }
 104     if (!loaded) {
 105         if (obt_parse_load_config_file(menu_parse_inst,
 106                                        "openbox",
 107                                        "menu.xml",
 108                                        "openbox_menu"))
 109         {
 110             obt_parse_tree_from_root(menu_parse_inst);
 111             obt_parse_close(menu_parse_inst);
 112         } else
 113             g_message(_("Unable to find a valid menu file \"%s\""),
 114                       "menu.xml");
 115     }
 116
 117     g_assert(menu_parse_state.parent == NULL);
 118
 119     if (!reconfig)
 120         client_add_destroy_notify(client_dest, NULL);
 121 }
 122
 123 void menu_shutdown(gboolean reconfig)
 124 {
 125     if (!reconfig)
 126         client_remove_destroy_notify(client_dest);
 127
 128     obt_parse_instance_unref(menu_parse_inst);
 129     menu_parse_inst = NULL;
 130
 131     client_list_menu_shutdown(reconfig);
 132     client_list_combined_menu_shutdown(reconfig);
 133
 134     menu_frame_hide_all();
 135     g_hash_table_destroy(menu_hash);
 136     menu_hash = NULL;
 137 }
 138
 139 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
 140 {
 141     ObMenu *menu = val;
 142     return menu->pipe_creator != NULL;
 143 }
 144
 145 static void clear_cache(gpointer key, gpointer val, gpointer data)
 146 {
 147     ObMenu *menu = val;
 148     if (menu->execute)
 149         menu_clear_entries(menu);
 150 }
 151
 152 void menu_clear_pipe_caches(void)
 153 {
 154     /* delete any pipe menus' submenus */
 155     g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
 156     /* empty the top level pipe menus */
 157     g_hash_table_foreach(menu_hash, clear_cache, NULL);
 158 }
 159
 160 void menu_pipe_execute(ObMenu *self)
 161 {
 162     gchar *output;
 163     GError *err = NULL;
 164
 165     if (!self->execute)
 166         return;
 167     if (self->entries) /* the entries are already created and cached */
 168         return;
 169
 170     if (!g_spawn_command_line_sync(self->execute, &output, NULL, NULL, &err)) {
 171         g_message(_("Failed to execute command for pipe-menu \"%s\": %s"),
 172                   self->execute, err->message);
 173         g_error_free(err);
 174         return;
 175     }
 176
 177     if (obt_parse_load_mem(menu_parse_inst, output, strlen(output),
 178                            "openbox_pipe_menu"))
 179     {
 180         menu_parse_state.pipe_creator = self;
 181         menu_parse_state.parent = self;
 182         obt_parse_tree_from_root(menu_parse_inst);
 183         obt_parse_close(menu_parse_inst);
 184     } else {
 185         g_message(_("Invalid output from pipe-menu \"%s\""), self->execute);
 186     }
 187
 188     g_free(output);
 189 }
 190
 191 static ObMenu* menu_from_name(gchar *name)
 192 {
 193     ObMenu *self = NULL;
 194
 195     g_assert(name != NULL);
 196
 197     if (!(self = g_hash_table_lookup(menu_hash, name)))
 198         g_message(_("Attempted to access menu \"%s\" but it does not exist"),
 199                   name);
 200     return self;
 201 }
 202
 203 #define VALID_SHORTCUT(c) (((c) >= '0' && (c) <= '9') || \
 204                            ((c) >= 'A' && (c) <= 'Z') || \
 205                            ((c) >= 'a' && (c) <= 'z'))
 206
 207 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
 208                                gchar **strippedlabel, guint *position,
 209                                gboolean *always_show)
 210 {
 211     gunichar shortcut = 0;
 212
 213     *position = 0;
 214     *always_show = FALSE;
 215
 216     g_assert(strippedlabel != NULL);
 217
 218     if (label == NULL) {
 219         *strippedlabel = NULL;
 220     } else {
 221         gchar *i;
 222
 223         *strippedlabel = g_strdup(label);
 224
 225         /* if allow_shortcut is false, then you can't use the '_', instead you
 226            have to just use the first valid character
 227         */
 228
 229         i = strchr(*strippedlabel, '_');
 230         if (allow_shortcut && i != NULL) {
 231             /* there is an underscore in the string */
 232
 233             /* you have to use a printable ascii character for shortcuts
 234                don't allow space either, so you can have like "a _ b"
 235             */
 236             if (VALID_SHORTCUT(*(i+1))) {
 237                 shortcut = g_unichar_tolower(g_utf8_get_char(i+1));
 238                 *position = i - *strippedlabel;
 239                 *always_show = TRUE;
 240
 241                 /* remove the '_' from the string */
 242                 for (; *i != '\0'; ++i)
 243                     *i = *(i+1);
 244             } else if (*(i+1) == '\0') {
 245                 /* no default shortcut if the '_' is the last character
 246                    (eg. "Exit_") for menu entries that you don't want
 247                    to be executed by mistake
 248                 */
 249                     *i = '\0';
 250             }
 251         } else {
 252             /* there is no underscore, so find the first valid character to use
 253                instead */
 254
 255             for (i = *strippedlabel; *i != '\0'; ++i)
 256                 if (VALID_SHORTCUT(*i)) {
 257                     *position = i - *strippedlabel;
 258                     shortcut = g_unichar_tolower(g_utf8_get_char(i));
 259                     break;
 260                 }
 261         }
 262     }
 263     return shortcut;
 264 }
 265
 266 static void parse_menu_item(xmlNodePtr node,  gpointer data)
 267 {
 268     ObMenuParseState *state = data;
 269     xmlNodePtr n;
 270     gchar *label;
 271 #ifdef USE_IMLIB2
 272     gchar *icon;
 273 #endif
 274     ObMenuEntry *e;
 275
 276     if (state->parent) {
 277         if (obt_parse_attr_string(node, "label", &label)) {
 278             GSList *acts = NULL;
 279
 280             for (n = node->children; n; n = n->next)
 281                 if (!xmlStrcasecmp(n->name, (const xmlChar*) "action")) {
 282                     ObActionsAct *a = actions_parse(n);
 283                     if (a)
 284                         acts = g_slist_append(acts, a);
 285                 }
 286             e = menu_add_normal(state->parent, -1, label, acts, TRUE);
 287
 288 #ifdef USE_IMLIB2
 289             /* Don't try to extract "icon" attribute if icons in user-defined
 290                menus are not enabled. */
 291             if (!(config_menu_user_show_icons &&
 292                 obt_parse_attr_string(node, "icon", &icon)))
 293                    icon = NULL;
 294
 295             if (icon) { /* Icon will be used. */
 296                 e->data.normal.icon = RrImageFetchFromFile(ob_rr_icons, icon);
 297                 if (e->data.normal.icon) {
 298                     e->data.normal.icon_alpha = 0xff;
 299                 }
 300                 g_free(icon);
 301             }
 302 #endif
 303             g_free(label);
 304         }
 305     }
 306 }
 307
 308 static void parse_menu_separator(xmlNodePtr node, gpointer data)
 309 {
 310     ObMenuParseState *state = data;
 311
 312     if (state->parent) {
 313         gchar *label;
 314
 315         if (!obt_parse_attr_string(node, "label", &label))
 316             label = NULL;
 317
 318         menu_add_separator(state->parent, -1, label);
 319         g_free(label);
 320     }
 321 }
 322
 323 static void parse_menu(xmlNodePtr node, gpointer data)
 324 {
 325     ObMenuParseState *state = data;
 326     gchar *name = NULL, *title = NULL, *script = NULL;
 327     ObMenu *menu;
 328     ObMenuEntry *e;
 329     gchar *icon;
 330
 331     if (!obt_parse_attr_string(node, "id", &name))
 332         goto parse_menu_fail;
 333
 334     if (!g_hash_table_lookup(menu_hash, name)) {
 335         if (!obt_parse_attr_string(node, "label", &title))
 336             goto parse_menu_fail;
 337
 338         if ((menu = menu_new(name, title, TRUE, NULL))) {
 339             menu->pipe_creator = state->pipe_creator;
 340             if (obt_parse_attr_string(node, "execute", &script)) {
 341                 menu->execute = obt_paths_expand_tilde(script);
 342             } else {
 343                 ObMenu *old;
 344
 345                 old = state->parent;
 346                 state->parent = menu;
 347                 obt_parse_tree(menu_parse_inst, node->children);
 348                 state->parent = old;
 349             }
 350         }
 351     }
 352
 353     if (state->parent) {
 354         e = menu_add_submenu(state->parent, -1, name);
 355
 356         if (!(config_menu_user_show_icons &&
 357             obt_parse_attr_string(node, "icon", &icon)))
 358                icon = NULL;
 359
 360         if (icon) {
 361             e->data.submenu.icon = RrImageFetchFromFile(ob_rr_icons, icon);
 362             if (e->data.submenu.icon)
 363                 e->data.submenu.icon_alpha = 0xff;
 364             g_free(icon);
 365         }
 366     }
 367
 368 parse_menu_fail:
 369     g_free(name);
 370     g_free(title);
 371     g_free(script);
 372 }
 373
 374 ObMenu* menu_new(const gchar *name, const gchar *title,
 375                  gboolean allow_shortcut_selection, gpointer data)
 376 {
 377     ObMenu *self;
 378
 379     self = g_new0(ObMenu, 1);
 380     self->name = g_strdup(name);
 381     self->data = data;
 382
 383     self->shortcut = parse_shortcut(title, allow_shortcut_selection,
 384                                     &self->title, &self->shortcut_position,
 385                                     &self->shortcut_always_show);
 386
 387     g_hash_table_replace(menu_hash, self->name, self);
 388
 389     /* Each menu has a single more_menu.  When the menu spills past what
 390        can fit on the screen, a new menu frame entry is created from this
 391        more_menu, and a new menu frame for the submenu is created for this
 392        menu, also pointing to the more_menu.
 393
 394        This can be done multiple times using the same more_menu.
 395
 396        more_menu->more_menu will always be NULL, since there is only 1 for
 397        each menu. */
 398     self->more_menu = g_new0(ObMenu, 1);
 399     self->more_menu->name = _("More...");
 400     self->more_menu->title = _("More...");
 401     self->more_menu->data = data;
 402     self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
 403
 404     return self;
 405 }
 406
 407 static void menu_destroy_hash_value(ObMenu *self)
 408 {
 409     /* make sure its not visible */
 410     {
 411         GList *it;
 412         ObMenuFrame *f;
 413
 414         for (it = menu_frame_visible; it; it = g_list_next(it)) {
 415             f = it->data;
 416             if (f->menu == self)
 417                 menu_frame_hide_all();
 418         }
 419     }
 420
 421     if (self->destroy_func)
 422         self->destroy_func(self, self->data);
 423
 424     menu_clear_entries(self);
 425     g_free(self->name);
 426     g_free(self->title);
 427     g_free(self->execute);
 428     g_free(self->more_menu);
 429
 430     g_free(self);
 431 }
 432
 433 void menu_free(ObMenu *menu)
 434 {
 435     if (menu)
 436         g_hash_table_remove(menu_hash, menu->name);
 437 }
 438
 439 static gboolean menu_hide_delay_func(gpointer data)
 440 {
 441     menu_can_hide = TRUE;
 442     return FALSE; /* no repeat */
 443 }
 444
 445 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
 446 {
 447     ObMenu *self;
 448     ObMenuFrame *frame;
 449
 450     if (!(self = menu_from_name(name)) ||
 451         grab_on_keyboard() || grab_on_pointer()) return;
 452
 453     /* if the requested menu is already the top visible menu, then don't
 454        bother */
 455     if (menu_frame_visible) {
 456         frame = menu_frame_visible->data;
 457         if (frame->menu == self)
 458             return;
 459     }
 460
 461     menu_frame_hide_all();
 462
 463     /* clear the pipe menus when showing a new menu */
 464     menu_clear_pipe_caches();
 465
 466     frame = menu_frame_new(self, 0, client);
 467     if (!menu_frame_show_topmenu(frame, x, y, mouse))
 468         menu_frame_free(frame);
 469     else {
 470         if (!mouse) {
 471             /* select the first entry if it's not a submenu and we opened
 472              * the menu with the keyboard, and skip all headers */
 473             GList *it = frame->entries;
 474             while (it) {
 475                 ObMenuEntryFrame *e = it->data;
 476                 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
 477                     menu_frame_select(frame, e, FALSE);
 478                     break;
 479                 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
 480                     it = g_list_next(it);
 481                 else
 482                     break;
 483             }
 484         }
 485
 486         /* reset the hide timer */
 487         if (!mouse)
 488             menu_can_hide = TRUE;
 489         else {
 490             menu_can_hide = FALSE;
 491             obt_main_loop_timeout_add(ob_main_loop,
 492                                       config_menu_hide_delay * 1000,
 493                                       menu_hide_delay_func,
 494                                       NULL, g_direct_equal, NULL);
 495         }
 496     }
 497 }
 498
 499 gboolean menu_hide_delay_reached(void)
 500 {
 501     return menu_can_hide;
 502 }
 503
 504 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
 505 {
 506     ObMenuEntry *self;
 507
 508     g_assert(menu);
 509
 510     self = g_new0(ObMenuEntry, 1);
 511     self->ref = 1;
 512     self->type = type;
 513     self->menu = menu;
 514     self->id = id;
 515
 516     switch (type) {
 517     case OB_MENU_ENTRY_TYPE_NORMAL:
 518         self->data.normal.enabled = TRUE;
 519         break;
 520     case OB_MENU_ENTRY_TYPE_SUBMENU:
 521     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 522         break;
 523     }
 524
 525     return self;
 526 }
 527
 528 void menu_entry_ref(ObMenuEntry *self)
 529 {
 530     ++self->ref;
 531 }
 532
 533 void menu_entry_unref(ObMenuEntry *self)
 534 {
 535     if (self && --self->ref == 0) {
 536         switch (self->type) {
 537         case OB_MENU_ENTRY_TYPE_NORMAL:
 538             RrImageUnref(self->data.normal.icon);
 539             g_free(self->data.normal.label);
 540             while (self->data.normal.actions) {
 541                 actions_act_unref(self->data.normal.actions->data);
 542                 self->data.normal.actions =
 543                     g_slist_delete_link(self->data.normal.actions,
 544                                         self->data.normal.actions);
 545             }
 546             break;
 547         case OB_MENU_ENTRY_TYPE_SUBMENU:
 548             g_free(self->data.submenu.name);
 549             break;
 550         case OB_MENU_ENTRY_TYPE_SEPARATOR:
 551             g_free(self->data.separator.label);
 552             break;
 553         }
 554
 555         g_free(self);
 556     }
 557 }
 558
 559 void menu_clear_entries(ObMenu *self)
 560 {
 561 #ifdef DEBUG
 562     /* assert that the menu isn't visible */
 563     {
 564         GList *it;
 565         ObMenuFrame *f;
 566
 567         for (it = menu_frame_visible; it; it = g_list_next(it)) {
 568             f = it->data;
 569             g_assert(f->menu != self);
 570         }
 571     }
 572 #endif
 573
 574     while (self->entries) {
 575         menu_entry_unref(self->entries->data);
 576         self->entries = g_list_delete_link(self->entries, self->entries);
 577     }
 578     self->more_menu->entries = self->entries; /* keep it in sync */
 579 }
 580
 581 void menu_entry_remove(ObMenuEntry *self)
 582 {
 583     self->menu->entries = g_list_remove(self->menu->entries, self);
 584     menu_entry_unref(self);
 585 }
 586
 587 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
 588                              GSList *actions, gboolean allow_shortcut)
 589 {
 590     ObMenuEntry *e;
 591
 592     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
 593     e->data.normal.actions = actions;
 594
 595     menu_entry_set_label(e, label, allow_shortcut);
 596
 597     self->entries = g_list_append(self->entries, e);
 598     self->more_menu->entries = self->entries; /* keep it in sync */
 599     return e;
 600 }
 601
 602 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
 603 {
 604     ObMenuEntry *e;
 605     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
 606     /* points to itself */
 607     e->data.submenu.name = g_strdup(self->name);
 608     e->data.submenu.submenu = self;
 609     e->data.submenu.show_from = show_from;
 610     return e;
 611 }
 612
 613 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
 614 {
 615     ObMenuEntry *e;
 616
 617     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
 618     e->data.submenu.name = g_strdup(submenu);
 619
 620     self->entries = g_list_append(self->entries, e);
 621     self->more_menu->entries = self->entries; /* keep it in sync */
 622     return e;
 623 }
 624
 625 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
 626 {
 627     ObMenuEntry *e;
 628
 629     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
 630
 631     menu_entry_set_label(e, label, FALSE);
 632
 633     self->entries = g_list_append(self->entries, e);
 634     self->more_menu->entries = self->entries; /* keep it in sync */
 635     return e;
 636 }
 637
 638 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
 639 {
 640     self->show_func = func;
 641 }
 642
 643 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
 644 {
 645     self->hide_func = func;
 646 }
 647
 648 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
 649 {
 650     self->update_func = func;
 651 }
 652
 653 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
 654 {
 655     self->execute_func = func;
 656     self->more_menu->execute_func = func; /* keep it in sync */
 657 }
 658
 659 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
 660 {
 661     self->destroy_func = func;
 662 }
 663
 664 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
 665 {
 666     self->place_func = func;
 667 }
 668
 669 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
 670 {
 671     ObMenuEntry *ret = NULL;
 672     GList *it;
 673
 674     for (it = self->entries; it; it = g_list_next(it)) {
 675         ObMenuEntry *e = it->data;
 676
 677         if (e->id == id) {
 678             ret = e;
 679             break;
 680         }
 681     }
 682     return ret;
 683 }
 684
 685 void menu_find_submenus(ObMenu *self)
 686 {
 687     GList *it;
 688
 689     for (it = self->entries; it; it = g_list_next(it)) {
 690         ObMenuEntry *e = it->data;
 691
 692         if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
 693             e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
 694     }
 695 }
 696
 697 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
 698                           gboolean allow_shortcut)
 699 {
 700     switch (self->type) {
 701     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 702         g_free(self->data.separator.label);
 703         self->data.separator.label = g_strdup(label);
 704         break;
 705     case OB_MENU_ENTRY_TYPE_NORMAL:
 706         g_free(self->data.normal.label);
 707         self->data.normal.shortcut =
 708             parse_shortcut(label, allow_shortcut, &self->data.normal.label,
 709                            &self->data.normal.shortcut_position,
 710                            &self->data.normal.shortcut_always_show);
 711         break;
 712     default:
 713         g_assert_not_reached();
 714     }
 715 }
 716
 717 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
 718 {
 719     self->show_all_shortcuts = show;
 720 }