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
  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 ObtParseInst *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_parse_instance_new();
  81
  82     menu_parse_state.parent = NULL;
  83     menu_parse_state.pipe_creator = NULL;
  84     obt_parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
  85     obt_parse_register(menu_parse_inst, "item", parse_menu_item,
  86                        &menu_parse_state);
  87     obt_parse_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_parse_load_config_file(menu_parse_inst,
  92                                        "openbox",
  93                                        it->data,
  94                                        "openbox_menu"))
  95         {
  96             loaded = TRUE;
  97             obt_parse_tree_from_root(menu_parse_inst);
  98             obt_parse_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_parse_load_config_file(menu_parse_inst,
 105                                        "openbox",
 106                                        "menu.xml",
 107                                        "openbox_menu"))
 108         {
 109             obt_parse_tree_from_root(menu_parse_inst);
 110             obt_parse_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_parse_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_parse_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_parse_tree_from_root(menu_parse_inst);
 182         obt_parse_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
 273     if (state->parent) {
 274         if (obt_parse_attr_string(node, "label", &label)) {
 275             GSList *acts = NULL;
 276
 277             for (node = node->children; node; node = node->next)
 278                 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
 279                     ObActionsAct *a = actions_parse(node);
 280                     if (a)
 281                         acts = g_slist_append(acts, a);
 282                 }
 283             menu_add_normal(state->parent, -1, label, acts, TRUE);
 284             g_free(label);
 285         }
 286     }
 287 }
 288
 289 static void parse_menu_separator(xmlNodePtr node, gpointer data)
 290 {
 291     ObMenuParseState *state = data;
 292
 293     if (state->parent) {
 294         gchar *label;
 295
 296         if (!obt_parse_attr_string(node, "label", &label))
 297             label = NULL;
 298
 299         menu_add_separator(state->parent, -1, label);
 300         g_free(label);
 301     }
 302 }
 303
 304 static void parse_menu(xmlNodePtr node, gpointer data)
 305 {
 306     ObMenuParseState *state = data;
 307     gchar *name = NULL, *title = NULL, *script = NULL;
 308     ObMenu *menu;
 309
 310     if (!obt_parse_attr_string(node, "id", &name))
 311         goto parse_menu_fail;
 312
 313     if (!g_hash_table_lookup(menu_hash, name)) {
 314         if (!obt_parse_attr_string(node, "label", &title))
 315             goto parse_menu_fail;
 316
 317         if ((menu = menu_new(name, title, TRUE, NULL))) {
 318             menu->pipe_creator = state->pipe_creator;
 319             if (obt_parse_attr_string(node, "execute", &script)) {
 320                 menu->execute = obt_paths_expand_tilde(script);
 321             } else {
 322                 ObMenu *old;
 323
 324                 old = state->parent;
 325                 state->parent = menu;
 326                 obt_parse_tree(menu_parse_inst, node->children);
 327                 state->parent = old;
 328             }
 329         }
 330     }
 331
 332     if (state->parent)
 333         menu_add_submenu(state->parent, -1, name);
 334
 335 parse_menu_fail:
 336     g_free(name);
 337     g_free(title);
 338     g_free(script);
 339 }
 340
 341 ObMenu* menu_new(const gchar *name, const gchar *title,
 342                  gboolean allow_shortcut_selection, gpointer data)
 343 {
 344     ObMenu *self;
 345
 346     self = g_new0(ObMenu, 1);
 347     self->name = g_strdup(name);
 348     self->data = data;
 349
 350     self->shortcut = parse_shortcut(title, allow_shortcut_selection,
 351                                     &self->title, &self->shortcut_position,
 352                                     &self->shortcut_always_show);
 353
 354     g_hash_table_replace(menu_hash, self->name, self);
 355
 356     /* Each menu has a single more_menu.  When the menu spills past what
 357        can fit on the screen, a new menu frame entry is created from this
 358        more_menu, and a new menu frame for the submenu is created for this
 359        menu, also pointing to the more_menu.
 360
 361        This can be done multiple times using the same more_menu.
 362
 363        more_menu->more_menu will always be NULL, since there is only 1 for
 364        each menu. */
 365     self->more_menu = g_new0(ObMenu, 1);
 366     self->more_menu->name = _("More...");
 367     self->more_menu->title = _("More...");
 368     self->more_menu->data = data;
 369     self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
 370
 371     return self;
 372 }
 373
 374 static void menu_destroy_hash_value(ObMenu *self)
 375 {
 376     /* make sure its not 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             if (f->menu == self)
 384                 menu_frame_hide_all();
 385         }
 386     }
 387
 388     if (self->destroy_func)
 389         self->destroy_func(self, self->data);
 390
 391     menu_clear_entries(self);
 392     g_free(self->name);
 393     g_free(self->title);
 394     g_free(self->execute);
 395     g_free(self->more_menu);
 396
 397     g_free(self);
 398 }
 399
 400 void menu_free(ObMenu *menu)
 401 {
 402     if (menu)
 403         g_hash_table_remove(menu_hash, menu->name);
 404 }
 405
 406 static gboolean menu_hide_delay_func(gpointer data)
 407 {
 408     menu_can_hide = TRUE;
 409     return FALSE; /* no repeat */
 410 }
 411
 412 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
 413 {
 414     ObMenu *self;
 415     ObMenuFrame *frame;
 416
 417     if (!(self = menu_from_name(name)) ||
 418         grab_on_keyboard() || grab_on_pointer()) return;
 419
 420     /* if the requested menu is already the top visible menu, then don't
 421        bother */
 422     if (menu_frame_visible) {
 423         frame = menu_frame_visible->data;
 424         if (frame->menu == self)
 425             return;
 426     }
 427
 428     menu_frame_hide_all();
 429
 430     /* clear the pipe menus when showing a new menu */
 431     menu_clear_pipe_caches();
 432
 433     frame = menu_frame_new(self, 0, client);
 434     if (!menu_frame_show_topmenu(frame, x, y, mouse))
 435         menu_frame_free(frame);
 436     else {
 437         if (!mouse) {
 438             /* select the first entry if it's not a submenu and we opened
 439              * the menu with the keyboard, and skip all headers */
 440             GList *it = frame->entries;
 441             while (it) {
 442                 ObMenuEntryFrame *e = it->data;
 443                 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
 444                     menu_frame_select(frame, e, FALSE);
 445                     break;
 446                 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
 447                     it = g_list_next(it);
 448                 else
 449                     break;
 450             }
 451         }
 452
 453         /* reset the hide timer */
 454         if (!mouse)
 455             menu_can_hide = TRUE;
 456         else {
 457             menu_can_hide = FALSE;
 458             obt_main_loop_timeout_add(ob_main_loop,
 459                                       config_menu_hide_delay * 1000,
 460                                       menu_hide_delay_func,
 461                                       NULL, g_direct_equal, NULL);
 462         }
 463     }
 464 }
 465
 466 gboolean menu_hide_delay_reached(void)
 467 {
 468     return menu_can_hide;
 469 }
 470
 471 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
 472 {
 473     ObMenuEntry *self;
 474
 475     g_assert(menu);
 476
 477     self = g_new0(ObMenuEntry, 1);
 478     self->ref = 1;
 479     self->type = type;
 480     self->menu = menu;
 481     self->id = id;
 482
 483     switch (type) {
 484     case OB_MENU_ENTRY_TYPE_NORMAL:
 485         self->data.normal.enabled = TRUE;
 486         break;
 487     case OB_MENU_ENTRY_TYPE_SUBMENU:
 488     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 489         break;
 490     }
 491
 492     return self;
 493 }
 494
 495 void menu_entry_ref(ObMenuEntry *self)
 496 {
 497     ++self->ref;
 498 }
 499
 500 void menu_entry_unref(ObMenuEntry *self)
 501 {
 502     if (self && --self->ref == 0) {
 503         switch (self->type) {
 504         case OB_MENU_ENTRY_TYPE_NORMAL:
 505             RrImageUnref(self->data.normal.icon);
 506             g_free(self->data.normal.label);
 507             while (self->data.normal.actions) {
 508                 actions_act_unref(self->data.normal.actions->data);
 509                 self->data.normal.actions =
 510                     g_slist_delete_link(self->data.normal.actions,
 511                                         self->data.normal.actions);
 512             }
 513             break;
 514         case OB_MENU_ENTRY_TYPE_SUBMENU:
 515             g_free(self->data.submenu.name);
 516             break;
 517         case OB_MENU_ENTRY_TYPE_SEPARATOR:
 518             g_free(self->data.separator.label);
 519             break;
 520         }
 521
 522         g_free(self);
 523     }
 524 }
 525
 526 void menu_clear_entries(ObMenu *self)
 527 {
 528 #ifdef DEBUG
 529     /* assert that the menu isn't visible */
 530     {
 531         GList *it;
 532         ObMenuFrame *f;
 533
 534         for (it = menu_frame_visible; it; it = g_list_next(it)) {
 535             f = it->data;
 536             g_assert(f->menu != self);
 537         }
 538     }
 539 #endif
 540
 541     while (self->entries) {
 542         menu_entry_unref(self->entries->data);
 543         self->entries = g_list_delete_link(self->entries, self->entries);
 544     }
 545     self->more_menu->entries = self->entries; /* keep it in sync */
 546 }
 547
 548 void menu_entry_remove(ObMenuEntry *self)
 549 {
 550     self->menu->entries = g_list_remove(self->menu->entries, self);
 551     menu_entry_unref(self);
 552 }
 553
 554 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
 555                              GSList *actions, gboolean allow_shortcut)
 556 {
 557     ObMenuEntry *e;
 558
 559     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
 560     e->data.normal.actions = actions;
 561
 562     menu_entry_set_label(e, label, allow_shortcut);
 563
 564     self->entries = g_list_append(self->entries, e);
 565     self->more_menu->entries = self->entries; /* keep it in sync */
 566     return e;
 567 }
 568
 569 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
 570 {
 571     ObMenuEntry *e;
 572     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
 573     /* points to itself */
 574     e->data.submenu.name = g_strdup(self->name);
 575     e->data.submenu.submenu = self;
 576     e->data.submenu.show_from = show_from;
 577     return e;
 578 }
 579
 580 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
 581 {
 582     ObMenuEntry *e;
 583
 584     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
 585     e->data.submenu.name = g_strdup(submenu);
 586
 587     self->entries = g_list_append(self->entries, e);
 588     self->more_menu->entries = self->entries; /* keep it in sync */
 589     return e;
 590 }
 591
 592 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
 593 {
 594     ObMenuEntry *e;
 595
 596     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
 597
 598     menu_entry_set_label(e, label, FALSE);
 599
 600     self->entries = g_list_append(self->entries, e);
 601     self->more_menu->entries = self->entries; /* keep it in sync */
 602     return e;
 603 }
 604
 605 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
 606 {
 607     self->show_func = func;
 608 }
 609
 610 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
 611 {
 612     self->hide_func = func;
 613 }
 614
 615 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
 616 {
 617     self->update_func = func;
 618 }
 619
 620 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
 621 {
 622     self->execute_func = func;
 623     self->more_menu->execute_func = func; /* keep it in sync */
 624 }
 625
 626 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
 627 {
 628     self->destroy_func = func;
 629 }
 630
 631 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
 632 {
 633     self->place_func = func;
 634 }
 635
 636 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
 637 {
 638     ObMenuEntry *ret = NULL;
 639     GList *it;
 640
 641     for (it = self->entries; it; it = g_list_next(it)) {
 642         ObMenuEntry *e = it->data;
 643
 644         if (e->id == id) {
 645             ret = e;
 646             break;
 647         }
 648     }
 649     return ret;
 650 }
 651
 652 void menu_find_submenus(ObMenu *self)
 653 {
 654     GList *it;
 655
 656     for (it = self->entries; it; it = g_list_next(it)) {
 657         ObMenuEntry *e = it->data;
 658
 659         if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
 660             e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
 661     }
 662 }
 663
 664 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
 665                           gboolean allow_shortcut)
 666 {
 667     switch (self->type) {
 668     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 669         g_free(self->data.separator.label);
 670         self->data.separator.label = g_strdup(label);
 671         break;
 672     case OB_MENU_ENTRY_TYPE_NORMAL:
 673         g_free(self->data.normal.label);
 674         self->data.normal.shortcut =
 675             parse_shortcut(label, allow_shortcut, &self->data.normal.label,
 676                            &self->data.normal.shortcut_position,
 677                            &self->data.normal.shortcut_always_show);
 678         break;
 679     default:
 680         g_assert_not_reached();
 681     }
 682 }
 683
 684 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
 685 {
 686     self->show_all_shortcuts = show;
 687 }