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