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