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 "mainloop.h"
  24 #include "stacking.h"
  25 #include "grab.h"
  26 #include "client.h"
  27 #include "config.h"
  28 #include "actions.h"
  29 #include "screen.h"
  30 #include "menuframe.h"
  31 #include "keyboard.h"
  32 #include "geom.h"
  33 #include "misc.h"
  34 #include "client_menu.h"
  35 #include "client_list_menu.h"
  36 #include "client_list_combined_menu.h"
  37 #include "gettext.h"
  38 #include "parser/parse.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 ObParseInst *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(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
  55                             gpointer data);
  56 static void parse_menu_separator(ObParseInst *i,
  57                                  xmlDocPtr doc, xmlNodePtr node,
  58                                  gpointer data);
  59 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
  60                        gpointer data);
  61 static gunichar parse_shortcut(const gchar *label, gboolean allow_shortcut,
  62                                gchar **strippedlabel, guint *position,
  63                                gboolean *always_show);
  64
  65
  66 static void client_dest(ObClient *client, gpointer data)
  67 {
  68     /* menus can be associated with a client, so close any that are since
  69        we are disappearing now */
  70     menu_frame_hide_all_client(client);
  71 }
  72
  73 void menu_startup(gboolean reconfig)
  74 {
  75     xmlDocPtr doc;
  76     xmlNodePtr node;
  77     gboolean loaded = FALSE;
  78     GSList *it;
  79
  80     menu_hash = g_hash_table_new_full(g_str_hash, g_str_equal, NULL,
  81                                       (GDestroyNotify)menu_destroy_hash_value);
  82
  83     client_list_menu_startup(reconfig);
  84     client_list_combined_menu_startup(reconfig);
  85     client_menu_startup();
  86
  87     menu_parse_inst = parse_startup();
  88
  89     menu_parse_state.parent = NULL;
  90     menu_parse_state.pipe_creator = NULL;
  91     parse_register(menu_parse_inst, "menu", parse_menu, &menu_parse_state);
  92     parse_register(menu_parse_inst, "item", parse_menu_item,
  93                    &menu_parse_state);
  94     parse_register(menu_parse_inst, "separator",
  95                    parse_menu_separator, &menu_parse_state);
  96
  97     for (it = config_menu_files; it; it = g_slist_next(it)) {
  98         if (parse_load_menu(it->data, &doc, &node)) {
  99             loaded = TRUE;
 100             parse_tree(menu_parse_inst, doc, node->children);
 101             xmlFreeDoc(doc);
 102         } else
 103             g_message(_("Unable to find a valid menu file '%s'"),
 104                       (const gchar*)it->data);
 105     }
 106     if (!loaded) {
 107         if (parse_load_menu("menu.xml", &doc, &node)) {
 108             parse_tree(menu_parse_inst, doc, node->children);
 109             xmlFreeDoc(doc);
 110         } else
 111             g_message(_("Unable to find a valid menu file '%s'"),
 112                       "menu.xml");
 113     }
 114
 115     g_assert(menu_parse_state.parent == NULL);
 116
 117     if (!reconfig)
 118         client_add_destroy_notify(client_dest, NULL);
 119 }
 120
 121 void menu_shutdown(gboolean reconfig)
 122 {
 123     if (!reconfig)
 124         client_remove_destroy_notify(client_dest);
 125
 126     parse_shutdown(menu_parse_inst);
 127     menu_parse_inst = NULL;
 128
 129     client_list_menu_shutdown(reconfig);
 130     client_list_combined_menu_shutdown(reconfig);
 131
 132     menu_frame_hide_all();
 133     g_hash_table_destroy(menu_hash);
 134     menu_hash = NULL;
 135 }
 136
 137 static gboolean menu_pipe_submenu(gpointer key, gpointer val, gpointer data)
 138 {
 139     ObMenu *menu = val;
 140     return menu->pipe_creator != NULL;
 141 }
 142
 143 static void clear_cache(gpointer key, gpointer val, gpointer data)
 144 {
 145     ObMenu *menu = val;
 146     if (menu->execute)
 147         menu_clear_entries(menu);
 148 }
 149
 150 void menu_clear_pipe_caches()
 151 {
 152     /* delete any pipe menus' submenus */
 153     g_hash_table_foreach_remove(menu_hash, menu_pipe_submenu, NULL);
 154     /* empty the top level pipe menus */
 155     g_hash_table_foreach(menu_hash, clear_cache, NULL);
 156 }
 157
 158 void menu_pipe_execute(ObMenu *self)
 159 {
 160     xmlDocPtr doc;
 161     xmlNodePtr node;
 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 (parse_load_mem(output, strlen(output),
 178                        "openbox_pipe_menu", &doc, &node))
 179     {
 180         menu_parse_state.pipe_creator = self;
 181         menu_parse_state.parent = self;
 182         parse_tree(menu_parse_inst, doc, node->children);
 183         xmlFreeDoc(doc);
 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(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 267                             gpointer data)
 268 {
 269     ObMenuParseState *state = data;
 270     gchar *label;
 271
 272     if (state->parent) {
 273         if (parse_attr_string("label", node, &label)) {
 274             GSList *acts = NULL;
 275
 276             for (node = node->children; node; node = node->next)
 277                 if (!xmlStrcasecmp(node->name, (const xmlChar*) "action")) {
 278                     ObActionsAct *a = actions_parse(i, doc, node);
 279                     if (a)
 280                         acts = g_slist_append(acts, a);
 281                 }
 282             menu_add_normal(state->parent, -1, label, acts, TRUE);
 283             g_free(label);
 284         }
 285     }
 286 }
 287
 288 static void parse_menu_separator(ObParseInst *i,
 289                                  xmlDocPtr doc, xmlNodePtr node,
 290                                  gpointer data)
 291 {
 292     ObMenuParseState *state = data;
 293
 294     if (state->parent) {
 295         gchar *label;
 296
 297         if (!parse_attr_string("label", node, &label))
 298             label = NULL;
 299
 300         menu_add_separator(state->parent, -1, label);
 301         g_free(label);
 302     }
 303 }
 304
 305 static void parse_menu(ObParseInst *i, xmlDocPtr doc, xmlNodePtr node,
 306                        gpointer data)
 307 {
 308     ObMenuParseState *state = data;
 309     gchar *name = NULL, *title = NULL, *script = NULL;
 310     ObMenu *menu;
 311
 312     if (!parse_attr_string("id", node, &name))
 313         goto parse_menu_fail;
 314
 315     if (!g_hash_table_lookup(menu_hash, name)) {
 316         if (!parse_attr_string("label", node, &title))
 317             goto parse_menu_fail;
 318
 319         if ((menu = menu_new(name, title, TRUE, NULL))) {
 320             menu->pipe_creator = state->pipe_creator;
 321             if (parse_attr_string("execute", node, &script)) {
 322                 menu->execute = parse_expand_tilde(script);
 323             } else {
 324                 ObMenu *old;
 325
 326                 old = state->parent;
 327                 state->parent = menu;
 328                 parse_tree(i, doc, node->children);
 329                 state->parent = old;
 330             }
 331         }
 332     }
 333
 334     if (state->parent)
 335         menu_add_submenu(state->parent, -1, name);
 336
 337 parse_menu_fail:
 338     g_free(name);
 339     g_free(title);
 340     g_free(script);
 341 }
 342
 343 ObMenu* menu_new(const gchar *name, const gchar *title,
 344                  gboolean allow_shortcut_selection, gpointer data)
 345 {
 346     ObMenu *self;
 347
 348     self = g_new0(ObMenu, 1);
 349     self->name = g_strdup(name);
 350     self->data = data;
 351
 352     self->shortcut = parse_shortcut(title, allow_shortcut_selection,
 353                                     &self->title, &self->shortcut_position,
 354                                     &self->shortcut_always_show);
 355
 356     g_hash_table_replace(menu_hash, self->name, self);
 357
 358     /* Each menu has a single more_menu.  When the menu spills past what
 359        can fit on the screen, a new menu frame entry is created from this
 360        more_menu, and a new menu frame for the submenu is created for this
 361        menu, also pointing to the more_menu.
 362
 363        This can be done multiple times using the same more_menu.
 364
 365        more_menu->more_menu will always be NULL, since there is only 1 for
 366        each menu. */
 367     self->more_menu = g_new0(ObMenu, 1);
 368     self->more_menu->name = _("More...");
 369     self->more_menu->title = _("More...");
 370     self->more_menu->data = data;
 371     self->more_menu->shortcut = g_unichar_tolower(g_utf8_get_char("M"));
 372
 373     self->more_menu->show_func = self->show_func;
 374     self->more_menu->hide_func = self->hide_func;
 375     self->more_menu->update_func = self->update_func;
 376     self->more_menu->execute_func = self->execute_func;
 377     self->more_menu->destroy_func = self->destroy_func;
 378     self->more_menu->place_func = self->place_func;
 379
 380     return self;
 381 }
 382
 383 static void menu_destroy_hash_value(ObMenu *self)
 384 {
 385     /* make sure its not visible */
 386     {
 387         GList *it;
 388         ObMenuFrame *f;
 389
 390         for (it = menu_frame_visible; it; it = g_list_next(it)) {
 391             f = it->data;
 392             if (f->menu == self)
 393                 menu_frame_hide_all();
 394         }
 395     }
 396
 397     if (self->destroy_func)
 398         self->destroy_func(self, self->data);
 399
 400     menu_clear_entries(self);
 401     g_free(self->name);
 402     g_free(self->title);
 403     g_free(self->execute);
 404     g_free(self->more_menu);
 405
 406     g_free(self);
 407 }
 408
 409 void menu_free(ObMenu *menu)
 410 {
 411     if (menu)
 412         g_hash_table_remove(menu_hash, menu->name);
 413 }
 414
 415 static gboolean menu_hide_delay_func(gpointer data)
 416 {
 417     menu_can_hide = TRUE;
 418     return FALSE; /* no repeat */
 419 }
 420
 421 void menu_show(gchar *name, gint x, gint y, gboolean mouse, ObClient *client)
 422 {
 423     ObMenu *self;
 424     ObMenuFrame *frame;
 425
 426     if (!(self = menu_from_name(name)) ||
 427         grab_on_keyboard() || grab_on_pointer()) return;
 428
 429     /* if the requested menu is already the top visible menu, then don't
 430        bother */
 431     if (menu_frame_visible) {
 432         frame = menu_frame_visible->data;
 433         if (frame->menu == self)
 434             return;
 435     }
 436
 437     menu_frame_hide_all();
 438
 439     /* clear the pipe menus when showing a new menu */
 440     menu_clear_pipe_caches();
 441
 442     frame = menu_frame_new(self, 0, client);
 443     if (!menu_frame_show_topmenu(frame, x, y, mouse))
 444         menu_frame_free(frame);
 445     else {
 446         if (!mouse) {
 447             /* select the first entry if it's not a submenu and we opened
 448              * the menu with the keyboard, and skip all headers */
 449             GList *it = frame->entries;
 450             while (it) {
 451                 ObMenuEntryFrame *e = it->data;
 452                 if (e->entry->type == OB_MENU_ENTRY_TYPE_NORMAL) {
 453                     menu_frame_select(frame, e, FALSE);
 454                     break;
 455                 } else if (e->entry->type == OB_MENU_ENTRY_TYPE_SEPARATOR)
 456                     it = g_list_next(it);
 457                 else
 458                     break;
 459             }
 460         }
 461
 462         /* reset the hide timer */
 463         if (!mouse)
 464             menu_can_hide = TRUE;
 465         else {
 466             menu_can_hide = FALSE;
 467             ob_main_loop_timeout_add(ob_main_loop,
 468                                      config_menu_hide_delay * 1000,
 469                                      menu_hide_delay_func,
 470                                      NULL, g_direct_equal, NULL);
 471         }
 472     }
 473 }
 474
 475 gboolean menu_hide_delay_reached()
 476 {
 477     return menu_can_hide;
 478 }
 479
 480 static ObMenuEntry* menu_entry_new(ObMenu *menu, ObMenuEntryType type, gint id)
 481 {
 482     ObMenuEntry *self;
 483
 484     g_assert(menu);
 485
 486     self = g_new0(ObMenuEntry, 1);
 487     self->ref = 1;
 488     self->type = type;
 489     self->menu = menu;
 490     self->id = id;
 491
 492     switch (type) {
 493     case OB_MENU_ENTRY_TYPE_NORMAL:
 494         self->data.normal.enabled = TRUE;
 495         break;
 496     case OB_MENU_ENTRY_TYPE_SUBMENU:
 497     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 498         break;
 499     }
 500
 501     return self;
 502 }
 503
 504 void menu_entry_ref(ObMenuEntry *self)
 505 {
 506     ++self->ref;
 507 }
 508
 509 void menu_entry_unref(ObMenuEntry *self)
 510 {
 511     if (self && --self->ref == 0) {
 512         switch (self->type) {
 513         case OB_MENU_ENTRY_TYPE_NORMAL:
 514             g_free(self->data.normal.label);
 515             while (self->data.normal.actions) {
 516                 actions_act_unref(self->data.normal.actions->data);
 517                 self->data.normal.actions =
 518                     g_slist_delete_link(self->data.normal.actions,
 519                                         self->data.normal.actions);
 520             }
 521             break;
 522         case OB_MENU_ENTRY_TYPE_SUBMENU:
 523             g_free(self->data.submenu.name);
 524             break;
 525         case OB_MENU_ENTRY_TYPE_SEPARATOR:
 526             break;
 527         }
 528
 529         g_free(self);
 530     }
 531 }
 532
 533 void menu_clear_entries(ObMenu *self)
 534 {
 535 #ifdef DEBUG
 536     /* assert that the menu isn't visible */
 537     {
 538         GList *it;
 539         ObMenuFrame *f;
 540
 541         for (it = menu_frame_visible; it; it = g_list_next(it)) {
 542             f = it->data;
 543             g_assert(f->menu != self);
 544         }
 545     }
 546 #endif
 547
 548     while (self->entries) {
 549         menu_entry_unref(self->entries->data);
 550         self->entries = g_list_delete_link(self->entries, self->entries);
 551     }
 552     self->more_menu->entries = self->entries; /* keep it in sync */
 553 }
 554
 555 void menu_entry_remove(ObMenuEntry *self)
 556 {
 557     self->menu->entries = g_list_remove(self->menu->entries, self);
 558     menu_entry_unref(self);
 559 }
 560
 561 ObMenuEntry* menu_add_normal(ObMenu *self, gint id, const gchar *label,
 562                              GSList *actions, gboolean allow_shortcut)
 563 {
 564     ObMenuEntry *e;
 565
 566     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_NORMAL, id);
 567     e->data.normal.actions = actions;
 568
 569     menu_entry_set_label(e, label, allow_shortcut);
 570
 571     self->entries = g_list_append(self->entries, e);
 572     self->more_menu->entries = self->entries; /* keep it in sync */
 573     return e;
 574 }
 575
 576 ObMenuEntry* menu_get_more(ObMenu *self, guint show_from)
 577 {
 578     ObMenuEntry *e;
 579     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, -1);
 580     /* points to itself */
 581     e->data.submenu.name = g_strdup(self->name);
 582     e->data.submenu.submenu = self;
 583     e->data.submenu.show_from = show_from;
 584     return e;
 585 }
 586
 587 ObMenuEntry* menu_add_submenu(ObMenu *self, gint id, const gchar *submenu)
 588 {
 589     ObMenuEntry *e;
 590
 591     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SUBMENU, id);
 592     e->data.submenu.name = g_strdup(submenu);
 593
 594     self->entries = g_list_append(self->entries, e);
 595     self->more_menu->entries = self->entries; /* keep it in sync */
 596     return e;
 597 }
 598
 599 ObMenuEntry* menu_add_separator(ObMenu *self, gint id, const gchar *label)
 600 {
 601     ObMenuEntry *e;
 602
 603     e = menu_entry_new(self, OB_MENU_ENTRY_TYPE_SEPARATOR, id);
 604
 605     menu_entry_set_label(e, label, FALSE);
 606
 607     self->entries = g_list_append(self->entries, e);
 608     self->more_menu->entries = self->entries; /* keep it in sync */
 609     return e;
 610 }
 611
 612 void menu_set_show_func(ObMenu *self, ObMenuShowFunc func)
 613 {
 614     self->show_func = func;
 615     self->more_menu->show_func = func; /* keep it in sync */
 616 }
 617
 618 void menu_set_hide_func(ObMenu *self, ObMenuHideFunc func)
 619 {
 620     self->hide_func = func;
 621     self->more_menu->hide_func = func; /* keep it in sync */
 622 }
 623
 624 void menu_set_update_func(ObMenu *self, ObMenuUpdateFunc func)
 625 {
 626     self->update_func = func;
 627     self->more_menu->update_func = func; /* keep it in sync */
 628 }
 629
 630 void menu_set_execute_func(ObMenu *self, ObMenuExecuteFunc func)
 631 {
 632     self->execute_func = func;
 633     self->more_menu->execute_func = func; /* keep it in sync */
 634 }
 635
 636 void menu_set_destroy_func(ObMenu *self, ObMenuDestroyFunc func)
 637 {
 638     self->destroy_func = func;
 639     self->more_menu->destroy_func = func; /* keep it in sync */
 640 }
 641
 642 void menu_set_place_func(ObMenu *self, ObMenuPlaceFunc func)
 643 {
 644     self->place_func = func;
 645     self->more_menu->place_func = func; /* keep it in sync */
 646 }
 647
 648 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id)
 649 {
 650     ObMenuEntry *ret = NULL;
 651     GList *it;
 652
 653     for (it = self->entries; it; it = g_list_next(it)) {
 654         ObMenuEntry *e = it->data;
 655
 656         if (e->id == id) {
 657             ret = e;
 658             break;
 659         }
 660     }
 661     return ret;
 662 }
 663
 664 void menu_find_submenus(ObMenu *self)
 665 {
 666     GList *it;
 667
 668     for (it = self->entries; it; it = g_list_next(it)) {
 669         ObMenuEntry *e = it->data;
 670
 671         if (e->type == OB_MENU_ENTRY_TYPE_SUBMENU)
 672             e->data.submenu.submenu = menu_from_name(e->data.submenu.name);
 673     }
 674 }
 675
 676 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
 677                           gboolean allow_shortcut)
 678 {
 679     switch (self->type) {
 680     case OB_MENU_ENTRY_TYPE_SEPARATOR:
 681         g_free(self->data.separator.label);
 682         self->data.separator.label = g_strdup(label);
 683         break;
 684     case OB_MENU_ENTRY_TYPE_NORMAL:
 685         g_free(self->data.normal.label);
 686         self->data.normal.shortcut =
 687             parse_shortcut(label, allow_shortcut, &self->data.normal.label,
 688                            &self->data.normal.shortcut_position,
 689                            &self->data.normal.shortcut_always_show);
 690         break;
 691     default:
 692         g_assert_not_reached();
 693     }
 694 }
 695
 696 void menu_show_all_shortcuts(ObMenu *self, gboolean show)
 697 {
 698     self->show_all_shortcuts = show;
 699 }