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