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.
26 #include <pbd/gstdio_compat.h>
28 #include <gtkmm/widget.h>
29 #include <gtkmm/window.h>
30 #include <gtkmm/accelmap.h>
31 #include <gdk/gdkkeysyms.h>
33 #include "pbd/error.h"
34 #include "pbd/convert.h"
35 #include "pbd/file_utils.h"
36 #include "pbd/search_path.h"
37 #include "pbd/xml++.h"
38 #include "pbd/debug.h"
39 #include "pbd/unwind.h"
41 #include "gtkmm2ext/keyboard.h"
42 #include "gtkmm2ext/actions.h"
43 #include "gtkmm2ext/debug.h"
49 using namespace Gtkmm2ext;
52 guint Keyboard::edit_but = 3;
53 guint Keyboard::edit_mod = GDK_CONTROL_MASK;
54 guint Keyboard::delete_but = 3;
55 guint Keyboard::delete_mod = GDK_SHIFT_MASK;
56 guint Keyboard::insert_note_but = 1;
57 guint Keyboard::insert_note_mod = GDK_CONTROL_MASK;
61 uint Keyboard::PrimaryModifier = GDK_MOD2_MASK; // Command
62 guint Keyboard::SecondaryModifier = GDK_CONTROL_MASK; // Control
63 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
64 guint Keyboard::Level4Modifier = GDK_MOD1_MASK; // Alt/Option
65 guint Keyboard::CopyModifier = GDK_CONTROL_MASK; // Control
66 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
67 guint Keyboard::button2_modifiers = Keyboard::SecondaryModifier|Keyboard::Level4Modifier;
69 const char* Keyboard::primary_modifier_name() { return _("Command"); }
70 const char* Keyboard::secondary_modifier_name() { return _("Control"); }
71 const char* Keyboard::tertiary_modifier_name() { return S_("Key|Shift"); }
72 const char* Keyboard::level4_modifier_name() { return _("Option"); }
73 const char* Keyboard::copy_modifier_name() { return _("Control"); }
74 const char* Keyboard::rangeselect_modifier_name() { return S_("Key|Shift"); }
76 guint Keyboard::snap_mod = Keyboard::Level4Modifier|Keyboard::TertiaryModifier; // XXX this is probably completely wrong
77 guint Keyboard::snap_delta_mod = Keyboard::Level4Modifier;
81 guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control
82 guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option
83 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
84 guint Keyboard::Level4Modifier = GDK_MOD4_MASK; // Mod4/Windows
85 guint Keyboard::CopyModifier = GDK_CONTROL_MASK;
86 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
87 guint Keyboard::button2_modifiers = 0; /* not used */
89 const char* Keyboard::primary_modifier_name() { return _("Control"); }
90 const char* Keyboard::secondary_modifier_name() { return _("Alt"); }
91 const char* Keyboard::tertiary_modifier_name() { return S_("Key|Shift"); }
92 const char* Keyboard::level4_modifier_name() { return _("Meta"); }
93 const char* Keyboard::copy_modifier_name() { return _("Control"); }
94 const char* Keyboard::rangeselect_modifier_name() { return S_("Key|Shift"); }
96 guint Keyboard::snap_mod = Keyboard::SecondaryModifier;
97 guint Keyboard::snap_delta_mod = Keyboard::SecondaryModifier|Keyboard::Level4Modifier;
101 guint Keyboard::GainFineScaleModifier = Keyboard::PrimaryModifier;
102 guint Keyboard::GainExtraFineScaleModifier = Keyboard::SecondaryModifier;
104 guint Keyboard::ScrollZoomVerticalModifier = Keyboard::SecondaryModifier;
105 guint Keyboard::ScrollZoomHorizontalModifier = Keyboard::PrimaryModifier;
106 guint Keyboard::ScrollHorizontalModifier = Keyboard::TertiaryModifier;
108 Keyboard* Keyboard::_the_keyboard = 0;
109 Gtk::Window* Keyboard::current_window = 0;
110 bool Keyboard::_some_magic_widget_has_focus = false;
112 std::string Keyboard::user_keybindings_path;
113 bool Keyboard::can_save_keybindings = false;
114 bool Keyboard::bindings_changed_after_save_became_legal = false;
115 map<string,string> Keyboard::binding_files;
116 string Keyboard::_current_binding_name;
117 map<AccelKey,pair<string,string>,Keyboard::AccelKeyLess> Keyboard::release_keys;
119 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
121 GdkModifierType Keyboard::RelevantModifierKeyMask;
124 Keyboard::magic_widget_grab_focus ()
126 _some_magic_widget_has_focus = true;
130 Keyboard::magic_widget_drop_focus ()
132 _some_magic_widget_has_focus = false;
136 Keyboard::some_magic_widget_has_focus ()
138 return _some_magic_widget_has_focus;
141 Keyboard::Keyboard ()
143 if (_the_keyboard == 0) {
144 _the_keyboard = this;
145 _current_binding_name = _("Unknown");
148 RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
150 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier);
151 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier);
152 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier);
153 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier);
154 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier);
155 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier);
157 gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
159 snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
162 Keyboard::~Keyboard ()
164 gtk_key_snooper_remove (snooper_id);
168 Keyboard::get_state (void)
170 XMLNode* node = new XMLNode ("Keyboard");
173 snprintf (buf, sizeof (buf), "%d", CopyModifier);
174 node->add_property ("copy-modifier", buf);
175 snprintf (buf, sizeof (buf), "%d", edit_but);
176 node->add_property ("edit-button", buf);
177 snprintf (buf, sizeof (buf), "%d", edit_mod);
178 node->add_property ("edit-modifier", buf);
179 snprintf (buf, sizeof (buf), "%d", delete_but);
180 node->add_property ("delete-button", buf);
181 snprintf (buf, sizeof (buf), "%d", delete_mod);
182 node->add_property ("delete-modifier", buf);
183 snprintf (buf, sizeof (buf), "%d", snap_mod);
184 node->add_property ("snap-modifier", buf);
185 snprintf (buf, sizeof (buf), "%d", snap_delta_mod);
186 node->add_property ("snap-delta-modifier", buf);
187 snprintf (buf, sizeof (buf), "%d", insert_note_but);
188 node->add_property ("insert-note-button", buf);
189 snprintf (buf, sizeof (buf), "%d", insert_note_mod);
190 node->add_property ("insert-note-modifier", buf);
196 Keyboard::set_state (const XMLNode& node, int /*version*/)
198 const XMLProperty* prop;
200 if ((prop = node.property ("copy-modifier")) != 0) {
201 sscanf (prop->value().c_str(), "%d", &CopyModifier);
204 if ((prop = node.property ("edit-button")) != 0) {
205 sscanf (prop->value().c_str(), "%d", &edit_but);
208 if ((prop = node.property ("edit-modifier")) != 0) {
209 sscanf (prop->value().c_str(), "%d", &edit_mod);
212 if ((prop = node.property ("delete-button")) != 0) {
213 sscanf (prop->value().c_str(), "%d", &delete_but);
216 if ((prop = node.property ("delete-modifier")) != 0) {
217 sscanf (prop->value().c_str(), "%d", &delete_mod);
220 if ((prop = node.property ("snap-modifier")) != 0) {
221 sscanf (prop->value().c_str(), "%d", &snap_mod);
224 if ((prop = node.property ("snap-delta-modifier")) != 0) {
225 sscanf (prop->value().c_str(), "%d", &snap_delta_mod);
228 if ((prop = node.property ("insert-note-button")) != 0) {
229 sscanf (prop->value().c_str(), "%d", &insert_note_but);
232 if ((prop = node.property ("insert-note-modifier")) != 0) {
233 sscanf (prop->value().c_str(), "%d", &insert_note_mod);
240 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
242 return ((Keyboard *) data)->snooper (widget, event);
246 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
254 "Snoop widget %1 name: [%6] key %2 type %3 state %4 magic %5\n",
255 widget, event->keyval, event->type, event->state, _some_magic_widget_has_focus,
256 gtk_widget_get_name (widget)
260 if (event->keyval == GDK_Shift_R) {
261 keyval = GDK_Shift_L;
263 } else if (event->keyval == GDK_Control_R) {
264 keyval = GDK_Control_L;
267 keyval = event->keyval;
270 if (event->state & ScrollZoomVerticalModifier) {
271 /* There is a special and rather hacky situation in Editor which makes
272 it useful to know when the modifier key for vertical zoom has been
273 released, so emit a signal here (see Editor::_stepping_axis_view).
274 Note that the state bit for the modifier key is set for the key-up
275 event when the modifier is released, but not the key-down when it
276 is pressed, so we get here on key-up, which is what we want.
278 ZoomVerticalModifierReleased (); /* EMIT SIGNAL */
281 if (event->type == GDK_KEY_PRESS) {
283 if (find (state.begin(), state.end(), keyval) == state.end()) {
284 state.push_back (keyval);
285 sort (state.begin(), state.end());
289 /* key is already down. if its also used for release,
290 prevent auto-repeat events.
293 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
295 const AccelKey& ak (k->first);
297 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
298 DEBUG_TRACE (DEBUG::Keyboard, "Suppress auto repeat\n");
305 } else if (event->type == GDK_KEY_RELEASE) {
309 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
311 sort (state.begin(), state.end());
314 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
316 const AccelKey& ak (k->first);
317 two_strings ts (k->second);
319 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
320 Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str());
322 DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Activate %1 %2\n", ts.first, ts.second));
324 DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Use repeat, suppress other\n", ts.first, ts.second));
332 /* Special keys that we want to handle in
333 any dialog, no matter whether it uses
334 the regular set of accelerators or not
337 if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) {
338 switch (event->keyval) {
340 close_current_dialog ();
346 DEBUG_TRACE (DEBUG::Keyboard, string_compose ("snooper returns %1\n", ret));
352 Keyboard::close_current_dialog ()
354 if (current_window) {
355 current_window->hide ();
361 Keyboard::key_is_down (uint32_t keyval)
363 return find (state.begin(), state.end(), keyval) != state.end();
367 Keyboard::enter_window (GdkEventCrossing *, Gtk::Window* win)
369 current_window = win;
370 DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Entering window, title = %1\n", win->get_title()));
375 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/)
378 switch (ev->detail) {
379 case GDK_NOTIFY_INFERIOR:
380 DEBUG_TRACE (DEBUG::Keyboard, "INFERIOR crossing ... out\n");
383 case GDK_NOTIFY_VIRTUAL:
384 DEBUG_TRACE (DEBUG::Keyboard, "VIRTUAL crossing ... out\n");
388 DEBUG_TRACE (DEBUG::Keyboard, "REAL crossing ... out\n");
389 DEBUG_TRACE (DEBUG::Keyboard, "Clearing current target\n");
401 Keyboard::focus_in_window (GdkEventFocus *, Gtk::Window* win)
403 current_window = win;
404 DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Focusing in window, title = %1\n", win->get_title()));
409 Keyboard::focus_out_window (GdkEventFocus * ev, Gtk::Window* win)
418 DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Foucusing out window, title = %1\n", win->get_title()));
424 Keyboard::set_edit_button (guint but)
430 Keyboard::set_edit_modifier (guint mod)
432 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
434 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
438 Keyboard::set_delete_button (guint but)
444 Keyboard::set_delete_modifier (guint mod)
446 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
448 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
452 Keyboard::set_insert_note_button (guint but)
454 insert_note_but = but;
458 Keyboard::set_insert_note_modifier (guint mod)
460 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~insert_note_mod);
461 insert_note_mod = mod;
462 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | insert_note_mod);
467 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
469 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
471 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
475 Keyboard::set_snap_modifier (guint mod)
477 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
479 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
483 Keyboard::set_snap_delta_modifier (guint mod)
485 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_delta_mod);
486 snap_delta_mod = mod;
487 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_delta_mod);
491 Keyboard::is_edit_event (GdkEventButton *ev)
493 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
494 (ev->button == Keyboard::edit_button()) &&
495 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
499 Keyboard::is_insert_note_event (GdkEventButton *ev)
501 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
502 (ev->button == Keyboard::insert_note_button()) &&
503 ((ev->state & RelevantModifierKeyMask) == Keyboard::insert_note_modifier());
507 Keyboard::is_button2_event (GdkEventButton* ev)
510 return (ev->button == 2) ||
511 ((ev->button == 1) &&
512 ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers));
514 return ev->button == 2;
519 Keyboard::is_delete_event (GdkEventButton *ev)
521 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
522 (ev->button == Keyboard::delete_button()) &&
523 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
527 Keyboard::is_context_menu_event (GdkEventButton *ev)
529 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
531 ((ev->state & RelevantModifierKeyMask) == 0);
535 Keyboard::no_modifiers_active (guint state)
537 return (state & RelevantModifierKeyMask) == 0;
541 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
543 return (state & mask) == (guint) mask;
547 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
549 return (state & RelevantModifierKeyMask) == (guint) mask;
553 Keyboard::keybindings_changed ()
555 if (Keyboard::can_save_keybindings) {
556 Keyboard::bindings_changed_after_save_became_legal = true;
559 Keyboard::save_keybindings ();
563 Keyboard::set_can_save_keybindings (bool yn)
565 can_save_keybindings = yn;
569 Keyboard::save_keybindings ()
571 if (can_save_keybindings && bindings_changed_after_save_became_legal) {
572 Gtk::AccelMap::save (user_keybindings_path);
577 Keyboard::load_keybindings (string path)
580 info << "Loading bindings from " << path << endl;
582 Gtk::AccelMap::load (path);
584 _current_binding_name = _("Unknown");
586 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
587 if (path == x->second) {
588 _current_binding_name = x->first;
595 error << string_compose (_("key bindings file not found at \"%2\" or contains errors."), path)
600 /* now find all release-driven bindings */
602 vector<string> groups;
603 vector<string> names;
604 vector<string> tooltips;
605 vector<AccelKey> bindings;
607 ActionManager::get_all_actions (groups, names, tooltips, bindings);
609 vector<string>::iterator g;
610 vector<AccelKey>::iterator b;
611 vector<string>::iterator n;
613 release_keys.clear ();
615 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
617 s << "Action: " << *n << " Group: " << *g << " Binding: ";
619 if ((*b).get_key() != GDK_VoidSymbol) {
620 s << b->get_key() << " w/mod " << hex << b->get_mod() << dec << " = " << b->get_abbrev () << "\n";
625 DEBUG_TRACE (DEBUG::Bindings, s.str ());
628 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
629 if ((*b).get_mod() & Gdk::RELEASE_MASK) {
630 release_keys.insert (pair<AccelKey,two_strings> (*b, two_strings (*g, *n)));
638 Keyboard::reset_bindings ()
640 if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
642 string new_path = user_keybindings_path;
645 if (::g_rename (user_keybindings_path.c_str(), new_path.c_str())) {
646 error << string_compose (_("Cannot rename your own keybinding file (%1)"), strerror (errno)) << endmsg;
652 PBD::Unwinder<bool> uw (can_save_keybindings, false);
653 setup_keybindings ();