libs/gtkmm2ext/keyboard.cc

   1 /*
   2     Copyright (C) 2001 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <vector>
  21
  22 #include <algorithm>
  23 #include <fstream>
  24 #include <iostream>
  25
  26 #include <cerrno>
  27 #include <ctype.h>
  28
  29 #include <glib/gstdio.h>
  30
  31 #include <gtkmm/widget.h>
  32 #include <gtkmm/window.h>
  33 #include <gtkmm/accelmap.h>
  34 #include <gdk/gdkkeysyms.h>
  35
  36 #include "pbd/error.h"
  37 #include "pbd/convert.h"
  38 #include "pbd/file_utils.h"
  39 #include "pbd/search_path.h"
  40 #include "pbd/xml++.h"
  41 #include "pbd/debug.h"
  42 #include "pbd/unwind.h"
  43
  44 #include "gtkmm2ext/keyboard.h"
  45 #include "gtkmm2ext/actions.h"
  46 #include "gtkmm2ext/debug.h"
  47
  48 #include "i18n.h"
  49
  50 using namespace PBD;
  51 using namespace Gtk;
  52 using namespace Gtkmm2ext;
  53 using namespace std;
  54
  55 guint Keyboard::edit_but = 3;
  56 guint Keyboard::edit_mod = GDK_CONTROL_MASK;
  57 guint Keyboard::delete_but = 3;
  58 guint Keyboard::delete_mod = GDK_SHIFT_MASK;
  59 guint Keyboard::insert_note_but = 1;
  60 guint Keyboard::insert_note_mod = GDK_CONTROL_MASK;
  61 guint Keyboard::snap_mod = GDK_MOD3_MASK;
  62
  63 #ifdef GTKOSX
  64
  65 uint Keyboard::PrimaryModifier = GDK_MOD2_MASK;   // Command
  66 guint Keyboard::SecondaryModifier = GDK_CONTROL_MASK; // Control
  67 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
  68 guint Keyboard::Level4Modifier = GDK_MOD1_MASK; // Alt/Option
  69 guint Keyboard::CopyModifier = GDK_CONTROL_MASK;      // Control
  70 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
  71 guint Keyboard::button2_modifiers = Keyboard::SecondaryModifier|Keyboard::Level4Modifier;
  72
  73 const char* Keyboard::primary_modifier_name() { return _("Command"); }
  74 const char* Keyboard::secondary_modifier_name() { return _("Control"); }
  75 const char* Keyboard::tertiary_modifier_name() { return S_("Key|Shift"); }
  76 const char* Keyboard::level4_modifier_name() { return _("Option"); }
  77 const char* Keyboard::copy_modifier_name() { return _("Control"); }
  78 const char* Keyboard::rangeselect_modifier_name() { return S_("Key|Shift"); }
  79
  80 #else
  81
  82 guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control
  83 guint Keyboard::SecondaryModifier = GDK_MOD1_MASK;  // Alt/Option
  84 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK;  // Shift
  85 guint Keyboard::Level4Modifier = GDK_MOD4_MASK;     // Mod4/Windows
  86 guint Keyboard::CopyModifier = GDK_CONTROL_MASK;
  87 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
  88 guint Keyboard::button2_modifiers = 0; /* not used */
  89
  90 const char* Keyboard::primary_modifier_name() { return _("Control"); }
  91 const char* Keyboard::secondary_modifier_name() { return _("Alt"); }
  92 const char* Keyboard::tertiary_modifier_name() { return S_("Key|Shift"); }
  93 const char* Keyboard::level4_modifier_name() { return _("Meta"); }
  94 const char* Keyboard::copy_modifier_name() { return _("Control"); }
  95 const char* Keyboard::rangeselect_modifier_name() { return S_("Key|Shift"); }
  96
  97 #endif
  98
  99 guint Keyboard::GainFineScaleModifier = Keyboard::PrimaryModifier;
 100 guint Keyboard::GainExtraFineScaleModifier = Keyboard::SecondaryModifier;
 101
 102 guint Keyboard::ScrollZoomVerticalModifier = Keyboard::SecondaryModifier;
 103 guint Keyboard::ScrollZoomHorizontalModifier = Keyboard::PrimaryModifier;
 104 guint Keyboard::ScrollHorizontalModifier = Keyboard::TertiaryModifier;
 105
 106
 107 Keyboard*    Keyboard::_the_keyboard = 0;
 108 Gtk::Window* Keyboard::current_window = 0;
 109 bool         Keyboard::_some_magic_widget_has_focus = false;
 110
 111 std::string Keyboard::user_keybindings_path;
 112 bool Keyboard::can_save_keybindings = false;
 113 bool Keyboard::bindings_changed_after_save_became_legal = false;
 114 map<string,string> Keyboard::binding_files;
 115 string Keyboard::_current_binding_name;
 116 map<AccelKey,pair<string,string>,Keyboard::AccelKeyLess> Keyboard::release_keys;
 117
 118 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
 119
 120 GdkModifierType Keyboard::RelevantModifierKeyMask;
 121
 122 void
 123 Keyboard::magic_widget_grab_focus ()
 124 {
 125         _some_magic_widget_has_focus = true;
 126 }
 127
 128 void
 129 Keyboard::magic_widget_drop_focus ()
 130 {
 131         _some_magic_widget_has_focus = false;
 132 }
 133
 134 bool
 135 Keyboard::some_magic_widget_has_focus ()
 136 {
 137         return _some_magic_widget_has_focus;
 138 }
 139
 140 Keyboard::Keyboard ()
 141 {
 142         if (_the_keyboard == 0) {
 143                 _the_keyboard = this;
 144                 _current_binding_name = _("Unknown");
 145         }
 146
 147         RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
 148
 149         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier);
 150         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier);
 151         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier);
 152         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier);
 153         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier);
 154         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier);
 155
 156         gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
 157
 158         snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
 159 }
 160
 161 Keyboard::~Keyboard ()
 162 {
 163         gtk_key_snooper_remove (snooper_id);
 164 }
 165
 166 XMLNode&
 167 Keyboard::get_state (void)
 168 {
 169         XMLNode* node = new XMLNode ("Keyboard");
 170         char buf[32];
 171
 172         snprintf (buf, sizeof (buf), "%d", edit_but);
 173         node->add_property ("edit-button", buf);
 174         snprintf (buf, sizeof (buf), "%d", edit_mod);
 175         node->add_property ("edit-modifier", buf);
 176         snprintf (buf, sizeof (buf), "%d", delete_but);
 177         node->add_property ("delete-button", buf);
 178         snprintf (buf, sizeof (buf), "%d", delete_mod);
 179         node->add_property ("delete-modifier", buf);
 180         snprintf (buf, sizeof (buf), "%d", snap_mod);
 181         node->add_property ("snap-modifier", buf);
 182         snprintf (buf, sizeof (buf), "%d", insert_note_but);
 183         node->add_property ("insert-note-button", buf);
 184         snprintf (buf, sizeof (buf), "%d", insert_note_mod);
 185         node->add_property ("insert-note-modifier", buf);
 186
 187         return *node;
 188 }
 189
 190 int
 191 Keyboard::set_state (const XMLNode& node, int /*version*/)
 192 {
 193         const XMLProperty* prop;
 194
 195         if ((prop = node.property ("edit-button")) != 0) {
 196                 sscanf (prop->value().c_str(), "%d", &edit_but);
 197         }
 198
 199         if ((prop = node.property ("edit-modifier")) != 0) {
 200                 sscanf (prop->value().c_str(), "%d", &edit_mod);
 201         }
 202
 203         if ((prop = node.property ("delete-button")) != 0) {
 204                 sscanf (prop->value().c_str(), "%d", &delete_but);
 205         }
 206
 207         if ((prop = node.property ("delete-modifier")) != 0) {
 208                 sscanf (prop->value().c_str(), "%d", &delete_mod);
 209         }
 210
 211         if ((prop = node.property ("snap-modifier")) != 0) {
 212                 sscanf (prop->value().c_str(), "%d", &snap_mod);
 213         }
 214
 215         if ((prop = node.property ("insert-note-button")) != 0) {
 216                 sscanf (prop->value().c_str(), "%d", &insert_note_but);
 217         }
 218
 219         if ((prop = node.property ("insert-note-modifier")) != 0) {
 220                 sscanf (prop->value().c_str(), "%d", &insert_note_mod);
 221         }
 222
 223         return 0;
 224 }
 225
 226 gint
 227 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
 228 {
 229         return ((Keyboard *) data)->snooper (widget, event);
 230 }
 231
 232 gint
 233 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
 234 {
 235         uint32_t keyval;
 236         bool ret = false;
 237
 238         DEBUG_TRACE (
 239                 DEBUG::Keyboard,
 240                 string_compose (
 241                         "Snoop widget %1 name: [%6] key %2 type %3 state %4 magic %5\n",
 242                         widget, event->keyval, event->type, event->state, _some_magic_widget_has_focus,
 243                         gtk_widget_get_name (widget)
 244                         )
 245                 );
 246
 247         if (event->keyval == GDK_Shift_R) {
 248                 keyval = GDK_Shift_L;
 249
 250         } else if (event->keyval == GDK_Control_R) {
 251                 keyval = GDK_Control_L;
 252
 253         } else {
 254                 keyval = event->keyval;
 255         }
 256
 257         if (event->state & ScrollZoomVerticalModifier) {
 258                 /* There is a special and rather hacky situation in Editor which makes
 259                    it useful to know when the modifier key for vertical zoom has been
 260                    released, so emit a signal here (see Editor::_stepping_axis_view).
 261                    Note that the state bit for the modifier key is set for the key-up
 262                    event when the modifier is released, but not the key-down when it
 263                    is pressed, so we get here on key-up, which is what we want.
 264                 */
 265                 ZoomVerticalModifierReleased (); /* EMIT SIGNAL */
 266         }
 267
 268         if (event->type == GDK_KEY_PRESS) {
 269
 270                 if (find (state.begin(), state.end(), keyval) == state.end()) {
 271                         state.push_back (keyval);
 272                         sort (state.begin(), state.end());
 273
 274                 } else {
 275
 276                         /* key is already down. if its also used for release,
 277                            prevent auto-repeat events.
 278                         */
 279
 280                         for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
 281
 282                                 const AccelKey& ak (k->first);
 283
 284                                 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
 285                                         DEBUG_TRACE (DEBUG::Keyboard, "Suppress auto repeat\n");
 286                                         ret = true;
 287                                         break;
 288                                 }
 289                         }
 290                 }
 291
 292         } else if (event->type == GDK_KEY_RELEASE) {
 293
 294                 State::iterator i;
 295
 296                 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
 297                         state.erase (i);
 298                         sort (state.begin(), state.end());
 299                 }
 300
 301                 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
 302
 303                         const AccelKey& ak (k->first);
 304                         two_strings ts (k->second);
 305
 306                         if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
 307                                 Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str());
 308                                 if (act) {
 309                                         DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Activate %1 %2\n", ts.first, ts.second));
 310                                         act->activate();
 311                                         DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Use repeat, suppress other\n", ts.first, ts.second));
 312                                         ret = true;
 313                                 }
 314                                 break;
 315                         }
 316                 }
 317         }
 318
 319         /* Special keys that we want to handle in
 320            any dialog, no matter whether it uses
 321            the regular set of accelerators or not
 322         */
 323
 324         if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) {
 325                 switch (event->keyval) {
 326                 case GDK_w:
 327                         close_current_dialog ();
 328                         ret = true;
 329                         break;
 330                 }
 331         }
 332
 333         DEBUG_TRACE (DEBUG::Keyboard, string_compose ("snooper returns %1\n", ret));
 334
 335         return ret;
 336 }
 337
 338 void
 339 Keyboard::close_current_dialog ()
 340 {
 341         if (current_window) {
 342                 current_window->hide ();
 343                 current_window = 0;
 344         }
 345 }
 346
 347 bool
 348 Keyboard::key_is_down (uint32_t keyval)
 349 {
 350         return find (state.begin(), state.end(), keyval) != state.end();
 351 }
 352
 353 bool
 354 Keyboard::enter_window (GdkEventCrossing *, Gtk::Window* win)
 355 {
 356         current_window = win;
 357         DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Entering window, title = %1\n", win->get_title()));
 358         return false;
 359 }
 360
 361 bool
 362 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/)
 363 {
 364         if (ev) {
 365                 switch (ev->detail) {
 366                 case GDK_NOTIFY_INFERIOR:
 367                         DEBUG_TRACE (DEBUG::Keyboard, "INFERIOR crossing ... out\n");
 368                         break;
 369
 370                 case GDK_NOTIFY_VIRTUAL:
 371                         DEBUG_TRACE (DEBUG::Keyboard, "VIRTUAL crossing ... out\n");
 372                         /* fallthru */
 373
 374                 default:
 375                         DEBUG_TRACE (DEBUG::Keyboard, "REAL crossing ... out\n");
 376                         DEBUG_TRACE (DEBUG::Keyboard, "Clearing current target\n");
 377                         state.clear ();
 378                         current_window = 0;
 379                 }
 380         } else {
 381                 current_window = 0;
 382         }
 383
 384         return false;
 385 }
 386
 387 void
 388 Keyboard::set_edit_button (guint but)
 389 {
 390         edit_but = but;
 391 }
 392
 393 void
 394 Keyboard::set_edit_modifier (guint mod)
 395 {
 396         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
 397         edit_mod = mod;
 398         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
 399 }
 400
 401 void
 402 Keyboard::set_delete_button (guint but)
 403 {
 404         delete_but = but;
 405 }
 406
 407 void
 408 Keyboard::set_delete_modifier (guint mod)
 409 {
 410         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
 411         delete_mod = mod;
 412         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
 413 }
 414
 415 void
 416 Keyboard::set_insert_note_button (guint but)
 417 {
 418         insert_note_but = but;
 419 }
 420
 421 void
 422 Keyboard::set_insert_note_modifier (guint mod)
 423 {
 424         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~insert_note_mod);
 425         insert_note_mod = mod;
 426         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | insert_note_mod);
 427 }
 428
 429
 430 void
 431 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
 432 {
 433         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
 434         var = newval;
 435         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
 436 }
 437
 438 void
 439 Keyboard::set_snap_modifier (guint mod)
 440 {
 441         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
 442         snap_mod = mod;
 443         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
 444 }
 445
 446 bool
 447 Keyboard::is_edit_event (GdkEventButton *ev)
 448 {
 449         return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
 450                 (ev->button == Keyboard::edit_button()) &&
 451                 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
 452 }
 453
 454 bool
 455 Keyboard::is_insert_note_event (GdkEventButton *ev)
 456 {
 457         return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
 458                 (ev->button == Keyboard::insert_note_button()) &&
 459                 ((ev->state & RelevantModifierKeyMask) == Keyboard::insert_note_modifier());
 460 }
 461
 462 bool
 463 Keyboard::is_button2_event (GdkEventButton* ev)
 464 {
 465 #ifdef GTKOSX
 466         return (ev->button == 2) ||
 467                 ((ev->button == 1) &&
 468                  ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers));
 469 #else
 470         return ev->button == 2;
 471 #endif
 472 }
 473
 474 bool
 475 Keyboard::is_delete_event (GdkEventButton *ev)
 476 {
 477         return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
 478                 (ev->button == Keyboard::delete_button()) &&
 479                 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
 480 }
 481
 482 bool
 483 Keyboard::is_context_menu_event (GdkEventButton *ev)
 484 {
 485         return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
 486                 (ev->button == 3) &&
 487                 ((ev->state & RelevantModifierKeyMask) == 0);
 488 }
 489
 490 bool
 491 Keyboard::no_modifiers_active (guint state)
 492 {
 493         return (state & RelevantModifierKeyMask) == 0;
 494 }
 495
 496 bool
 497 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
 498 {
 499         return (state & mask) == (guint) mask;
 500 }
 501
 502 bool
 503 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
 504 {
 505         return (state & RelevantModifierKeyMask) == (guint) mask;
 506 }
 507
 508 void
 509 Keyboard::keybindings_changed ()
 510 {
 511         if (Keyboard::can_save_keybindings) {
 512                 Keyboard::bindings_changed_after_save_became_legal = true;
 513         }
 514
 515         Keyboard::save_keybindings ();
 516 }
 517
 518 void
 519 Keyboard::set_can_save_keybindings (bool yn)
 520 {
 521         can_save_keybindings = yn;
 522 }
 523
 524 void
 525 Keyboard::save_keybindings ()
 526 {
 527         if (can_save_keybindings && bindings_changed_after_save_became_legal) {
 528                 Gtk::AccelMap::save (user_keybindings_path);
 529         }
 530 }
 531
 532 bool
 533 Keyboard::load_keybindings (string path)
 534 {
 535         try {
 536                 info << "Loading bindings from " << path << endl;
 537
 538                 Gtk::AccelMap::load (path);
 539
 540                 _current_binding_name = _("Unknown");
 541
 542                 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
 543                         if (path == x->second) {
 544                                 _current_binding_name = x->first;
 545                                 break;
 546                         }
 547                 }
 548
 549
 550         } catch (...) {
 551                 error << string_compose (_("key bindings file not found at \"%2\" or contains errors."), path)
 552                       << endmsg;
 553                 return false;
 554         }
 555
 556         /* now find all release-driven bindings */
 557
 558         vector<string> groups;
 559         vector<string> names;
 560         vector<string> tooltips;
 561         vector<AccelKey> bindings;
 562
 563         ActionManager::get_all_actions (groups, names, tooltips, bindings);
 564
 565         vector<string>::iterator g;
 566         vector<AccelKey>::iterator b;
 567         vector<string>::iterator n;
 568
 569         release_keys.clear ();
 570
 571         for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
 572                 stringstream s;
 573                 s << "Action: " << *n << " Group: " << *g << " Binding: ";
 574
 575                 if ((*b).get_key() != GDK_VoidSymbol) {
 576                         s << b->get_key() << " w/mod " << hex << b->get_mod() << dec << " = " << b->get_abbrev () << "\n";
 577                 } else {
 578                         s << "unbound\n";
 579                 }
 580
 581                 DEBUG_TRACE (DEBUG::Bindings, s.str ());
 582         }
 583
 584         for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
 585                 if ((*b).get_mod() & Gdk::RELEASE_MASK) {
 586                         release_keys.insert (pair<AccelKey,two_strings> (*b, two_strings (*g, *n)));
 587                 }
 588         }
 589
 590         return true;
 591 }
 592
 593 int
 594 Keyboard::reset_bindings ()
 595 {
 596         if (Glib::file_test (user_keybindings_path,  Glib::FILE_TEST_EXISTS)) {
 597
 598                 string new_path = user_keybindings_path;
 599                 new_path += ".old";
 600
 601                 if (::g_rename (user_keybindings_path.c_str(), new_path.c_str())) {
 602                         error << string_compose (_("Cannot rename your own keybinding file (%1)"), strerror (errno)) << endmsg;
 603                         return -1;
 604                 }
 605         }
 606
 607         {
 608                 PBD::Unwinder<bool> uw (can_save_keybindings, false);
 609                 setup_keybindings ();
 610         }
 611
 612         return 0;
 613 }