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