2 Copyright (C) 2001 Paul Davis
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.
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.
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.
21 #include "ardour/ardour.h"
23 #include "ardour_ui.h"
31 #include <gtkmm/accelmap.h>
33 #include <gdk/gdkkeysyms.h>
34 #include "pbd/error.h"
35 #include "pbd/file_utils.h"
37 #include "ardour/filesystem_paths.h"
40 #include "gui_thread.h"
47 using namespace ARDOUR;
52 bool debug_keyboard = false;
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;
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;
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 */
79 Keyboard* Keyboard::_the_keyboard = 0;
80 Gtk::Window* Keyboard::current_window = 0;
81 bool Keyboard::_some_magic_widget_has_focus = false;
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;
90 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
92 GdkModifierType Keyboard::RelevantModifierKeyMask;
95 Keyboard::magic_widget_grab_focus ()
97 _some_magic_widget_has_focus = true;
101 Keyboard::magic_widget_drop_focus ()
103 _some_magic_widget_has_focus = false;
107 Keyboard::some_magic_widget_has_focus ()
109 return _some_magic_widget_has_focus;
112 Keyboard::Keyboard ()
114 if (_the_keyboard == 0) {
115 _the_keyboard = this;
118 RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
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);
127 gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
129 snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
131 XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
135 Keyboard::~Keyboard ()
137 gtk_key_snooper_remove (snooper_id);
141 Keyboard::get_state (void)
143 XMLNode* node = new XMLNode ("Keyboard");
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);
161 Keyboard::set_state (const XMLNode& node)
163 const XMLProperty* prop;
165 if ((prop = node.property ("edit-button")) != 0) {
166 sscanf (prop->value().c_str(), "%d", &edit_but);
169 if ((prop = node.property ("edit-modifier")) != 0) {
170 sscanf (prop->value().c_str(), "%d", &edit_mod);
173 if ((prop = node.property ("delete-button")) != 0) {
174 sscanf (prop->value().c_str(), "%d", &delete_but);
177 if ((prop = node.property ("delete-modifier")) != 0) {
178 sscanf (prop->value().c_str(), "%d", &delete_mod);
181 if ((prop = node.property ("snap-modifier")) != 0) {
182 sscanf (prop->value().c_str(), "%d", &snap_mod);
189 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
191 return ((Keyboard *) data)->snooper (widget, event);
195 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
201 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
202 << " state " << std::hex << event->state << std::dec
207 if (debug_keyboard) {
208 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
213 if (event->keyval == GDK_Shift_R) {
214 keyval = GDK_Shift_L;
216 } else if (event->keyval == GDK_Control_R) {
217 keyval = GDK_Control_L;
220 keyval = event->keyval;
223 if (event->type == GDK_KEY_PRESS) {
225 if (find (state.begin(), state.end(), keyval) == state.end()) {
226 state.push_back (keyval);
227 sort (state.begin(), state.end());
231 /* key is already down. if its also used for release,
232 prevent auto-repeat events.
235 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
237 const AccelKey& ak (k->first);
239 if (keyval == ak.get_key() && (Gdk::ModifierType)(event->state | Gdk::RELEASE_MASK) == ak.get_mod()) {
246 } else if (event->type == GDK_KEY_RELEASE) {
250 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
252 sort (state.begin(), state.end());
255 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
257 const AccelKey& ak (k->first);
258 two_strings ts (k->second);
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());
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
276 if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) {
277 switch (event->keyval) {
279 if (current_window) {
280 current_window->hide ();
292 Keyboard::key_is_down (uint32_t keyval)
294 return find (state.begin(), state.end(), keyval) != state.end();
298 Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win)
300 current_window = win;
305 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win)
308 switch (ev->detail) {
309 case GDK_NOTIFY_INFERIOR:
310 if (debug_keyboard) {
311 cerr << "INFERIOR crossing ... out\n";
315 case GDK_NOTIFY_VIRTUAL:
316 if (debug_keyboard) {
317 cerr << "VIRTUAL crossing ... out\n";
322 if (debug_keyboard) {
323 cerr << "REAL CROSSING ... out\n";
324 cerr << "clearing current target\n";
337 Keyboard::set_edit_button (guint but)
343 Keyboard::set_edit_modifier (guint mod)
345 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
347 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
351 Keyboard::set_delete_button (guint but)
357 Keyboard::set_delete_modifier (guint mod)
359 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
361 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
365 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
367 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
369 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
373 Keyboard::set_snap_modifier (guint mod)
375 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
377 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
381 Keyboard::is_edit_event (GdkEventButton *ev)
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());
389 Keyboard::is_button2_event (GdkEventButton* ev)
392 return (ev->button == 2) ||
393 ((ev->button == 1) &&
394 ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers));
396 return ev->button == 2;
401 Keyboard::is_delete_event (GdkEventButton *ev)
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());
409 Keyboard::is_context_menu_event (GdkEventButton *ev)
411 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
413 ((ev->state & RelevantModifierKeyMask) == 0);
417 Keyboard::no_modifiers_active (guint state)
419 return (state & RelevantModifierKeyMask) == 0;
423 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
425 return (state & mask) == (guint) mask;
429 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
431 return (state & RelevantModifierKeyMask) == (guint) mask;
435 Keyboard::selection_type (guint state)
437 /* note that there is no modifier for "Add" */
439 if (modifier_state_equals (state, RangeSelectModifier)) {
440 return Selection::Extend;
441 } else if (modifier_state_equals (state, PrimaryModifier)) {
442 return Selection::Toggle;
444 return Selection::Set;
450 accel_map_changed (GtkAccelMap* map,
456 Keyboard::keybindings_changed ();
460 Keyboard::keybindings_changed ()
462 if (Keyboard::can_save_keybindings) {
463 Keyboard::bindings_changed_after_save_became_legal = true;
466 Keyboard::save_keybindings ();
470 Keyboard::set_can_save_keybindings (bool yn)
472 can_save_keybindings = yn;
476 Keyboard::save_keybindings ()
478 if (can_save_keybindings && bindings_changed_after_save_became_legal) {
479 Gtk::AccelMap::save (user_keybindings_path);
484 Keyboard::setup_keybindings ()
486 using namespace ARDOUR_COMMAND_LINE;
487 std::string default_bindings = "mnemonic-us.bindings";
490 binding_files.clear ();
492 ARDOUR::find_bindings_files (binding_files);
494 /* set up the per-user bindings path */
496 strs.push_back (Glib::get_home_dir());
497 strs.push_back (".ardour3");
498 strs.push_back ("ardour.bindings");
500 user_keybindings_path = Glib::build_filename (strs);
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);
509 /* check to see if they gave a style name ("SAE", "ergonomic") or
510 an actual filename (*.bindings)
513 if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) {
515 // just a style name - allow user to
516 // specify the layout type.
520 if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
522 /* user-specified keyboard layout */
524 keybindings_path += '-';
525 keybindings_path += layout;
529 /* default to US/ANSI - we have to pick something */
531 keybindings_path += "-us";
534 keybindings_path += ".bindings";
537 if (keybindings_path.empty()) {
539 /* no path or binding name given: check the user one first */
541 if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
543 keybindings_path = "";
547 keybindings_path = user_keybindings_path;
551 /* if we still don't have a path at this point, use the default */
553 if (keybindings_path.empty()) {
554 keybindings_path = default_bindings;
559 if (!Glib::path_is_absolute (keybindings_path)) {
561 /* not absolute - look in the usual places */
562 sys::path keybindings_file;
564 SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
566 if ( ! find_file_in_search_path (spath, keybindings_path, keybindings_file)) {
568 if (keybindings_path == default_bindings) {
569 error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg;
572 warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
575 keybindings_path = default_bindings;
582 keybindings_path = keybindings_file.to_string();
589 /* path is absolute already */
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;
596 warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
599 keybindings_path = default_bindings;
608 load_keybindings (keybindings_path);
612 GtkAccelMap* accelmap = gtk_accel_map_get();
613 g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, 0);
617 Keyboard::load_keybindings (string path)
620 cerr << "Loading bindings from " << path << endl;
622 Gtk::AccelMap::load (path);
624 _current_binding_name = _("Unknown");
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;
635 error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path)
640 /* now find all release-driven bindings */
642 vector<string> groups;
643 vector<string> names;
644 vector<AccelKey> bindings;
646 ActionManager::get_all_actions (groups, names, bindings);
648 vector<string>::iterator g;
649 vector<AccelKey>::iterator b;
650 vector<string>::iterator n;
652 release_keys.clear ();
654 bool show_bindings = (getenv ("ARDOUR_SHOW_BINDINGS") != 0);
656 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
660 cerr << "Action: " << (*n) << " Group: " << (*g) << " binding = ";
662 if ((*b).get_key() != GDK_VoidSymbol) {
663 cerr << (*b).get_key() << " w/mod = " << hex << (*b).get_mod() << dec << " = " << (*b).get_abbrev();
672 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
673 if ((*b).get_mod() & Gdk::RELEASE_MASK) {
674 release_keys.insert (pair<AccelKey,two_strings> (*b, two_strings (*g, *n)));