gtk2_ardour/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 #include <ardour/ardour.h>
  22
  23 #include "ardour_ui.h"
  24
  25 #include <algorithm>
  26 #include <fstream>
  27 #include <iostream>
  28
  29 #include <ctype.h>
  30
  31 #include <gtkmm/accelmap.h>
  32
  33 #include <gdk/gdkkeysyms.h>
  34 #include <pbd/error.h>
  35 #include <pbd/file_utils.h>
  36
  37 #include <ardour/filesystem_paths.h>
  38
  39 #include "keyboard.h"
  40 #include "gui_thread.h"
  41 #include "opts.h"
  42 #include "actions.h"
  43
  44 #include "i18n.h"
  45
  46 using namespace PBD;
  47 using namespace ARDOUR;
  48 using namespace Gtk;
  49 using namespace std;
  50
  51 #define KBD_DEBUG 1
  52 bool debug_keyboard = false;
  53
  54 guint Keyboard::edit_but = 3;
  55 guint Keyboard::edit_mod = GDK_CONTROL_MASK;
  56 guint Keyboard::delete_but = 3;
  57 guint Keyboard::delete_mod = GDK_SHIFT_MASK;
  58 guint Keyboard::snap_mod = GDK_MOD3_MASK;
  59
  60 #ifdef GTKOSX
  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 #else
  69 guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control
  70 guint Keyboard::SecondaryModifier = GDK_MOD1_MASK;  // Alt/Option
  71 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK;  // Shift
  72 guint Keyboard::Level4Modifier = GDK_MOD4_MASK;     // Mod4/Windows
  73 guint Keyboard::CopyModifier = GDK_CONTROL_MASK;
  74 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
  75 guint Keyboard::button2_modifiers = 0; /* not used */
  76 #endif
  77
  78
  79 Keyboard*    Keyboard::_the_keyboard = 0;
  80 Gtk::Window* Keyboard::current_window = 0;
  81 bool         Keyboard::_some_magic_widget_has_focus = false;
  82
  83 std::string Keyboard::user_keybindings_path;
  84 bool Keyboard::can_save_keybindings = false;
  85 bool Keyboard::bindings_changed_after_save_became_legal = false;
  86 map<string,string> Keyboard::binding_files;
  87 string Keyboard::_current_binding_name = _("Unknown");
  88 map<AccelKey,pair<string,string>,Keyboard::AccelKeyLess> Keyboard::release_keys;
  89
  90 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
  91
  92 GdkModifierType Keyboard::RelevantModifierKeyMask;
  93
  94 void
  95 Keyboard::magic_widget_grab_focus ()
  96 {
  97         _some_magic_widget_has_focus = true;
  98 }
  99
 100 void
 101 Keyboard::magic_widget_drop_focus ()
 102 {
 103         _some_magic_widget_has_focus = false;
 104 }
 105
 106 bool
 107 Keyboard::some_magic_widget_has_focus ()
 108 {
 109         return _some_magic_widget_has_focus;
 110 }
 111
 112 Keyboard::Keyboard ()
 113 {
 114         if (_the_keyboard == 0) {
 115                 _the_keyboard = this;
 116         }
 117
 118         RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
 119
 120         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier);
 121         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier);
 122         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier);
 123         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier);
 124         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier);
 125         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier);
 126
 127         gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
 128
 129         snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
 130
 131         XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
 132         set_state (*node);
 133 }
 134
 135 Keyboard::~Keyboard ()
 136 {
 137         gtk_key_snooper_remove (snooper_id);
 138 }
 139
 140 XMLNode&
 141 Keyboard::get_state (void)
 142 {
 143         XMLNode* node = new XMLNode ("Keyboard");
 144         char buf[32];
 145
 146         snprintf (buf, sizeof (buf), "%d", edit_but);
 147         node->add_property ("edit-button", buf);
 148         snprintf (buf, sizeof (buf), "%d", edit_mod);
 149         node->add_property ("edit-modifier", buf);
 150         snprintf (buf, sizeof (buf), "%d", delete_but);
 151         node->add_property ("delete-button", buf);
 152         snprintf (buf, sizeof (buf), "%d", delete_mod);
 153         node->add_property ("delete-modifier", buf);
 154         snprintf (buf, sizeof (buf), "%d", snap_mod);
 155         node->add_property ("snap-modifier", buf);
 156
 157         return *node;
 158 }
 159
 160 int
 161 Keyboard::set_state (const XMLNode& node)
 162 {
 163         const XMLProperty* prop;
 164
 165         if ((prop = node.property ("edit-button")) != 0) {
 166                 sscanf (prop->value().c_str(), "%d", &edit_but);
 167         }
 168
 169         if ((prop = node.property ("edit-modifier")) != 0) {
 170                 sscanf (prop->value().c_str(), "%d", &edit_mod);
 171         }
 172
 173         if ((prop = node.property ("delete-button")) != 0) {
 174                 sscanf (prop->value().c_str(), "%d", &delete_but);
 175         }
 176
 177         if ((prop = node.property ("delete-modifier")) != 0) {
 178                 sscanf (prop->value().c_str(), "%d", &delete_mod);
 179         }
 180
 181         if ((prop = node.property ("snap-modifier")) != 0) {
 182                 sscanf (prop->value().c_str(), "%d", &snap_mod);
 183         }
 184
 185         return 0;
 186 }
 187
 188 gint
 189 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
 190 {
 191         return ((Keyboard *) data)->snooper (widget, event);
 192 }
 193
 194 gint
 195 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
 196 {
 197         uint32_t keyval;
 198         bool ret = false;
 199
 200 #if 0
 201         cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
 202              << " state " << std::hex << event->state << std::dec
 203              << endl;
 204 #endif
 205
 206 #if KBD_DEBUG
 207         if (debug_keyboard) {
 208                 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
 209                      << endl;
 210         }
 211 #endif
 212
 213         if (event->keyval == GDK_Shift_R) {
 214                 keyval = GDK_Shift_L;
 215
 216         } else  if (event->keyval == GDK_Control_R) {
 217                 keyval = GDK_Control_L;
 218
 219         } else {
 220                 keyval = event->keyval;
 221         }
 222
 223         if (event->type == GDK_KEY_PRESS) {
 224
 225                 if (find (state.begin(), state.end(), keyval) == state.end()) {
 226                         state.push_back (keyval);
 227                         sort (state.begin(), state.end());
 228
 229                 } else {
 230
 231                         /* key is already down. if its also used for release,
 232                            prevent auto-repeat events.
 233                         */
 234
 235                         for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
 236
 237                                 const AccelKey& ak (k->first);
 238
 239                                 if (keyval == ak.get_key() && (Gdk::ModifierType)(event->state | Gdk::RELEASE_MASK) == ak.get_mod()) {
 240                                         ret = true;
 241                                         break;
 242                                 }
 243                         }
 244                 }
 245
 246         } else if (event->type == GDK_KEY_RELEASE) {
 247
 248                 State::iterator i;
 249
 250                 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
 251                         state.erase (i);
 252                         sort (state.begin(), state.end());
 253                 }
 254
 255                 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
 256
 257                         const AccelKey& ak (k->first);
 258                         two_strings ts (k->second);
 259
 260                         if (keyval == ak.get_key() && (Gdk::ModifierType)(event->state | Gdk::RELEASE_MASK) == ak.get_mod()) {
 261                                 Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str());
 262                                 if (act) {
 263                                         act->activate();
 264                                         ret = true;
 265                                 }
 266                                 break;
 267                         }
 268                 }
 269         }
 270
 271         /* Special keys that we want to handle in
 272            any dialog, no matter whether it uses
 273            the regular set of accelerators or not
 274         */
 275
 276         if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) {
 277                 switch (event->keyval) {
 278                 case GDK_w:
 279                         if (current_window) {
 280                                 current_window->hide ();
 281                                 current_window = 0;
 282                                 ret = true;
 283                         }
 284                         break;
 285                 }
 286         }
 287
 288         return ret;
 289 }
 290
 291 bool
 292 Keyboard::key_is_down (uint32_t keyval)
 293 {
 294         return find (state.begin(), state.end(), keyval) != state.end();
 295 }
 296
 297 bool
 298 Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win)
 299 {
 300         current_window = win;
 301         return false;
 302 }
 303
 304 bool
 305 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win)
 306 {
 307         if (ev) {
 308                 switch (ev->detail) {
 309                 case GDK_NOTIFY_INFERIOR:
 310                         if (debug_keyboard) {
 311                                 cerr << "INFERIOR crossing ... out\n";
 312                         }
 313                         break;
 314
 315                 case GDK_NOTIFY_VIRTUAL:
 316                         if (debug_keyboard) {
 317                                 cerr << "VIRTUAL crossing ... out\n";
 318                         }
 319                         /* fallthru */
 320
 321                 default:
 322                         if (debug_keyboard) {
 323                                 cerr << "REAL CROSSING ... out\n";
 324                                 cerr << "clearing current target\n";
 325                         }
 326                         state.clear ();
 327                         current_window = 0;
 328                 }
 329         } else {
 330                 current_window = 0;
 331         }
 332
 333         return false;
 334 }
 335
 336 void
 337 Keyboard::set_edit_button (guint but)
 338 {
 339         edit_but = but;
 340 }
 341
 342 void
 343 Keyboard::set_edit_modifier (guint mod)
 344 {
 345         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
 346         edit_mod = mod;
 347         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
 348 }
 349
 350 void
 351 Keyboard::set_delete_button (guint but)
 352 {
 353         delete_but = but;
 354 }
 355
 356 void
 357 Keyboard::set_delete_modifier (guint mod)
 358 {
 359         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
 360         delete_mod = mod;
 361         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
 362 }
 363
 364 void
 365 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
 366 {
 367         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
 368         var = newval;
 369         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
 370 }
 371
 372 void
 373 Keyboard::set_snap_modifier (guint mod)
 374 {
 375         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
 376         snap_mod = mod;
 377         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
 378 }
 379
 380 bool
 381 Keyboard::is_edit_event (GdkEventButton *ev)
 382 {
 383         return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
 384                 (ev->button == Keyboard::edit_button()) &&
 385                 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
 386 }
 387
 388 bool
 389 Keyboard::is_button2_event (GdkEventButton* ev)
 390 {
 391 #ifdef GTKOSX
 392         return (ev->button == 2) ||
 393                 ((ev->button == 1) &&
 394                  ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers));
 395 #else
 396         return ev->button == 2;
 397 #endif
 398 }
 399
 400 bool
 401 Keyboard::is_delete_event (GdkEventButton *ev)
 402 {
 403         return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
 404                 (ev->button == Keyboard::delete_button()) &&
 405                 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
 406 }
 407
 408 bool
 409 Keyboard::is_context_menu_event (GdkEventButton *ev)
 410 {
 411         return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
 412                 (ev->button == 3) &&
 413                 ((ev->state & RelevantModifierKeyMask) == 0);
 414 }
 415
 416 bool
 417 Keyboard::no_modifiers_active (guint state)
 418 {
 419         return (state & RelevantModifierKeyMask) == 0;
 420 }
 421
 422 bool
 423 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
 424 {
 425         return (state & mask) == (guint) mask;
 426 }
 427
 428 bool
 429 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
 430 {
 431         return (state & RelevantModifierKeyMask) == (guint) mask;
 432 }
 433
 434 Selection::Operation
 435 Keyboard::selection_type (guint state)
 436 {
 437         /* note that there is no modifier for "Add" */
 438
 439         if (modifier_state_equals (state, RangeSelectModifier)) {
 440                 return Selection::Extend;
 441         } else if (modifier_state_equals (state, PrimaryModifier)) {
 442                 return Selection::Toggle;
 443         } else {
 444                 return Selection::Set;
 445         }
 446 }
 447
 448
 449 static void
 450 accel_map_changed (GtkAccelMap* map,
 451                    gchar* path,
 452                    guint  key,
 453                    GdkModifierType mod,
 454                    gpointer arg)
 455 {
 456         Keyboard::keybindings_changed ();
 457 }
 458
 459 void
 460 Keyboard::keybindings_changed ()
 461 {
 462         if (Keyboard::can_save_keybindings) {
 463                 Keyboard::bindings_changed_after_save_became_legal = true;
 464         }
 465
 466         Keyboard::save_keybindings ();
 467 }
 468
 469 void
 470 Keyboard::set_can_save_keybindings (bool yn)
 471 {
 472         can_save_keybindings = yn;
 473 }
 474
 475 void
 476 Keyboard::save_keybindings ()
 477 {
 478         if (can_save_keybindings && bindings_changed_after_save_became_legal) {
 479                 Gtk::AccelMap::save (user_keybindings_path);
 480         }
 481 }
 482
 483 void
 484 Keyboard::setup_keybindings ()
 485 {
 486         using namespace ARDOUR_COMMAND_LINE;
 487         std::string default_bindings = "mnemonic-us.bindings";
 488         vector<string> strs;
 489
 490         binding_files.clear ();
 491
 492         ARDOUR::find_bindings_files (binding_files);
 493
 494         /* set up the per-user bindings path */
 495
 496         strs.push_back (Glib::get_home_dir());
 497         strs.push_back (".ardour3");
 498         strs.push_back ("ardour.bindings");
 499
 500         user_keybindings_path = Glib::build_filename (strs);
 501
 502         if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
 503                 std::pair<string,string> newpair;
 504                 newpair.first = _("your own");
 505                 newpair.second = user_keybindings_path;
 506                 binding_files.insert (newpair);
 507         }
 508
 509         /* check to see if they gave a style name ("SAE", "ergonomic") or
 510            an actual filename (*.bindings)
 511         */
 512
 513         if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) {
 514
 515                 // just a style name - allow user to
 516                 // specify the layout type.
 517
 518                 char* layout;
 519
 520                 if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
 521
 522                         /* user-specified keyboard layout */
 523
 524                         keybindings_path += '-';
 525                         keybindings_path += layout;
 526
 527                 } else {
 528
 529                         /* default to US/ANSI - we have to pick something */
 530
 531                         keybindings_path += "-us";
 532                 }
 533
 534                 keybindings_path += ".bindings";
 535         }
 536
 537         if (keybindings_path.empty()) {
 538
 539                 /* no path or binding name given: check the user one first */
 540
 541                 if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
 542
 543                         keybindings_path = "";
 544
 545                 } else {
 546
 547                         keybindings_path = user_keybindings_path;
 548                 }
 549         }
 550
 551         /* if we still don't have a path at this point, use the default */
 552
 553         if (keybindings_path.empty()) {
 554                 keybindings_path = default_bindings;
 555         }
 556
 557         while (true) {
 558
 559                 if (!Glib::path_is_absolute (keybindings_path)) {
 560
 561                         /* not absolute - look in the usual places */
 562                         sys::path keybindings_file;
 563
 564                         SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
 565
 566                         if ( ! find_file_in_search_path (spath, keybindings_path, keybindings_file)) {
 567
 568                                 if (keybindings_path == default_bindings) {
 569                                         error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg;
 570                                         return;
 571                                 } else {
 572                                         warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
 573                                                                    keybindings_path)
 574                                                 << endmsg;
 575                                         keybindings_path = default_bindings;
 576                                 }
 577
 578                         } else {
 579
 580                                 /* use it */
 581
 582                                 keybindings_path = keybindings_file.to_string();
 583                                 break;
 584
 585                         }
 586
 587                 } else {
 588
 589                         /* path is absolute already */
 590
 591                         if (!Glib::file_test (keybindings_path, Glib::FILE_TEST_EXISTS)) {
 592                                 if (keybindings_path == default_bindings) {
 593                                         error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg;
 594                                         return;
 595                                 } else {
 596                                         warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
 597                                                                    keybindings_path)
 598                                                 << endmsg;
 599                                         keybindings_path = default_bindings;
 600                                 }
 601
 602                         } else {
 603                                 break;
 604                         }
 605                 }
 606         }
 607
 608         load_keybindings (keybindings_path);
 609
 610         /* catch changes */
 611
 612         GtkAccelMap* accelmap = gtk_accel_map_get();
 613         g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, 0);
 614 }
 615
 616 bool
 617 Keyboard::load_keybindings (string path)
 618 {
 619         try {
 620                 cerr << "loading bindings from " << path << endl;
 621
 622                 Gtk::AccelMap::load (path);
 623
 624                 _current_binding_name = _("Unknown");
 625
 626                 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
 627                         if (path == x->second) {
 628                                 _current_binding_name = x->first;
 629                                 break;
 630                         }
 631                 }
 632
 633
 634         } catch (...) {
 635                 error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path)
 636                       << endmsg;
 637                 return false;
 638         }
 639
 640         /* now find all release-driven bindings */
 641
 642         vector<string> groups;
 643         vector<string> names;
 644         vector<AccelKey> bindings;
 645
 646         ActionManager::get_all_actions (groups, names, bindings);
 647
 648         vector<string>::iterator g;
 649         vector<AccelKey>::iterator b;
 650         vector<string>::iterator n;
 651
 652         release_keys.clear ();
 653
 654         for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
 655                 if ((*b).get_mod() & Gdk::RELEASE_MASK) {
 656                         release_keys.insert (pair<AccelKey,two_strings> (*b, two_strings (*g, *n)));
 657                 }
 658         }
 659
 660         return true;
 661 }
 662
 663