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