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