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