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.
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/file_utils.h"
35 #include "pbd/search_path.h"
36 #include "pbd/xml++.h"
38 #include "gtkmm2ext/keyboard.h"
39 #include "gtkmm2ext/actions.h"
45 using namespace Gtkmm2ext;
49 bool debug_keyboard = false;
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::insert_note_but = 3;
56 guint Keyboard::insert_note_mod = GDK_CONTROL_MASK;
57 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 const char* Keyboard::primary_modifier_name() { return _("Command"); }
70 const char* Keyboard::secondary_modifier_name() { return _("Option"); }
71 const char* Keyboard::tertiary_modifier_name() { return _("Shift"); }
72 const char* Keyboard::level4_modifier_name() { return _("Control"); }
73 const char* Keyboard::copy_modifier_name() { return _("Mod1"; ); }
74 const char* Keyboard::rangeselect_modifier_name() { return _("Shift"); }
78 guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control
79 guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option
80 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
81 guint Keyboard::Level4Modifier = GDK_MOD4_MASK; // Mod4/Windows
82 guint Keyboard::CopyModifier = GDK_CONTROL_MASK;
83 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
84 guint Keyboard::button2_modifiers = 0; /* not used */
86 const char* Keyboard::primary_modifier_name() { return _("Control"); }
87 const char* Keyboard::secondary_modifier_name() { return _("Alt"); }
88 const char* Keyboard::tertiary_modifier_name() { return _("Shift"); }
89 const char* Keyboard::level4_modifier_name() { return _("Meta"); }
90 const char* Keyboard::copy_modifier_name() { return _("Control"); }
91 const char* Keyboard::rangeselect_modifier_name() { return _("Shift"); }
95 Keyboard* Keyboard::_the_keyboard = 0;
96 Gtk::Window* Keyboard::current_window = 0;
97 bool Keyboard::_some_magic_widget_has_focus = false;
99 std::string Keyboard::user_keybindings_path;
100 bool Keyboard::can_save_keybindings = false;
101 bool Keyboard::bindings_changed_after_save_became_legal = false;
102 map<string,string> Keyboard::binding_files;
103 string Keyboard::_current_binding_name;
104 map<AccelKey,pair<string,string>,Keyboard::AccelKeyLess> Keyboard::release_keys;
106 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
108 GdkModifierType Keyboard::RelevantModifierKeyMask;
111 Keyboard::magic_widget_grab_focus ()
113 _some_magic_widget_has_focus = true;
117 Keyboard::magic_widget_drop_focus ()
119 _some_magic_widget_has_focus = false;
123 Keyboard::some_magic_widget_has_focus ()
125 return _some_magic_widget_has_focus;
128 Keyboard::Keyboard ()
130 if (_the_keyboard == 0) {
131 _the_keyboard = this;
132 _current_binding_name = _("Unknown");
135 RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
137 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier);
138 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier);
139 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier);
140 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier);
141 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier);
142 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier);
144 gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
146 snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
149 Keyboard::~Keyboard ()
151 gtk_key_snooper_remove (snooper_id);
155 Keyboard::get_state (void)
157 XMLNode* node = new XMLNode ("Keyboard");
160 snprintf (buf, sizeof (buf), "%d", edit_but);
161 node->add_property ("edit-button", buf);
162 snprintf (buf, sizeof (buf), "%d", edit_mod);
163 node->add_property ("edit-modifier", buf);
164 snprintf (buf, sizeof (buf), "%d", delete_but);
165 node->add_property ("delete-button", buf);
166 snprintf (buf, sizeof (buf), "%d", delete_mod);
167 node->add_property ("delete-modifier", buf);
168 snprintf (buf, sizeof (buf), "%d", snap_mod);
169 node->add_property ("snap-modifier", buf);
170 snprintf (buf, sizeof (buf), "%d", insert_note_but);
171 node->add_property ("insert-note-button", buf);
172 snprintf (buf, sizeof (buf), "%d", insert_note_mod);
173 node->add_property ("insert-note-modifier", buf);
179 Keyboard::set_state (const XMLNode& node, int /*version*/)
181 const XMLProperty* prop;
183 if ((prop = node.property ("edit-button")) != 0) {
184 sscanf (prop->value().c_str(), "%d", &edit_but);
187 if ((prop = node.property ("edit-modifier")) != 0) {
188 sscanf (prop->value().c_str(), "%d", &edit_mod);
191 if ((prop = node.property ("delete-button")) != 0) {
192 sscanf (prop->value().c_str(), "%d", &delete_but);
195 if ((prop = node.property ("delete-modifier")) != 0) {
196 sscanf (prop->value().c_str(), "%d", &delete_mod);
199 if ((prop = node.property ("snap-modifier")) != 0) {
200 sscanf (prop->value().c_str(), "%d", &snap_mod);
203 if ((prop = node.property ("insert-note-button")) != 0) {
204 sscanf (prop->value().c_str(), "%d", &insert_note_but);
207 if ((prop = node.property ("insert-note-modifier")) != 0) {
208 sscanf (prop->value().c_str(), "%d", &insert_note_mod);
215 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
217 return ((Keyboard *) data)->snooper (widget, event);
221 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
227 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
228 << " state " << std::hex << event->state << std::dec
229 << " magic ? " << _some_magic_widget_has_focus
234 if (debug_keyboard) {
235 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
240 if (event->keyval == GDK_Shift_R) {
241 keyval = GDK_Shift_L;
243 } else if (event->keyval == GDK_Control_R) {
244 keyval = GDK_Control_L;
247 keyval = event->keyval;
250 if (event->type == GDK_KEY_PRESS) {
252 if (find (state.begin(), state.end(), keyval) == state.end()) {
253 state.push_back (keyval);
254 sort (state.begin(), state.end());
258 /* key is already down. if its also used for release,
259 prevent auto-repeat events.
262 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
264 const AccelKey& ak (k->first);
266 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
267 cerr << "Suppress auto repeat\n";
274 } else if (event->type == GDK_KEY_RELEASE) {
278 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
280 sort (state.begin(), state.end());
283 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
285 const AccelKey& ak (k->first);
286 two_strings ts (k->second);
288 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
289 Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str());
292 cerr << "use repeat, suppress other\n";
300 /* Special keys that we want to handle in
301 any dialog, no matter whether it uses
302 the regular set of accelerators or not
305 if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) {
306 switch (event->keyval) {
308 if (current_window) {
309 current_window->hide ();
321 Keyboard::key_is_down (uint32_t keyval)
323 return find (state.begin(), state.end(), keyval) != state.end();
327 Keyboard::enter_window (GdkEventCrossing *, Gtk::Window* win)
329 current_window = win;
334 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/)
337 switch (ev->detail) {
338 case GDK_NOTIFY_INFERIOR:
339 if (debug_keyboard) {
340 cerr << "INFERIOR crossing ... out\n";
344 case GDK_NOTIFY_VIRTUAL:
345 if (debug_keyboard) {
346 cerr << "VIRTUAL crossing ... out\n";
351 if (debug_keyboard) {
352 cerr << "REAL CROSSING ... out\n";
353 cerr << "clearing current target\n";
366 Keyboard::set_edit_button (guint but)
372 Keyboard::set_edit_modifier (guint mod)
374 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
376 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
380 Keyboard::set_delete_button (guint but)
386 Keyboard::set_delete_modifier (guint mod)
388 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
390 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
394 Keyboard::set_insert_note_button (guint but)
396 insert_note_but = but;
400 Keyboard::set_insert_note_modifier (guint mod)
402 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~insert_note_mod);
403 insert_note_mod = mod;
404 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | insert_note_mod);
409 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
411 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
413 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
417 Keyboard::set_snap_modifier (guint mod)
419 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
421 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
425 Keyboard::is_edit_event (GdkEventButton *ev)
427 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
428 (ev->button == Keyboard::edit_button()) &&
429 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
433 Keyboard::is_insert_note_event (GdkEventButton *ev)
435 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
436 (ev->button == Keyboard::insert_note_button()) &&
437 ((ev->state & RelevantModifierKeyMask) == Keyboard::insert_note_modifier());
441 Keyboard::is_button2_event (GdkEventButton* ev)
444 return (ev->button == 2) ||
445 ((ev->button == 1) &&
446 ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers));
448 return ev->button == 2;
453 Keyboard::is_delete_event (GdkEventButton *ev)
455 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
456 (ev->button == Keyboard::delete_button()) &&
457 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
461 Keyboard::is_context_menu_event (GdkEventButton *ev)
463 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
465 ((ev->state & RelevantModifierKeyMask) == 0);
469 Keyboard::no_modifiers_active (guint state)
471 return (state & RelevantModifierKeyMask) == 0;
475 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
477 return (state & mask) == (guint) mask;
481 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
483 return (state & RelevantModifierKeyMask) == (guint) mask;
487 Keyboard::keybindings_changed ()
489 if (Keyboard::can_save_keybindings) {
490 Keyboard::bindings_changed_after_save_became_legal = true;
493 Keyboard::save_keybindings ();
497 Keyboard::set_can_save_keybindings (bool yn)
499 can_save_keybindings = yn;
503 Keyboard::save_keybindings ()
505 if (can_save_keybindings && bindings_changed_after_save_became_legal) {
506 Gtk::AccelMap::save (user_keybindings_path);
511 Keyboard::load_keybindings (string path)
514 info << "Loading bindings from " << path << endl;
516 Gtk::AccelMap::load (path);
518 _current_binding_name = _("Unknown");
520 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
521 if (path == x->second) {
522 _current_binding_name = x->first;
529 error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path)
534 /* now find all release-driven bindings */
536 vector<string> groups;
537 vector<string> names;
538 vector<string> tooltips;
539 vector<AccelKey> bindings;
541 ActionManager::get_all_actions (groups, names, tooltips, bindings);
543 vector<string>::iterator g;
544 vector<AccelKey>::iterator b;
545 vector<string>::iterator n;
547 release_keys.clear ();
549 bool show_bindings = (getenv ("ARDOUR_SHOW_BINDINGS") != 0);
551 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
555 cerr << "Action: " << (*n) << " Group: " << (*g) << " binding = ";
557 if ((*b).get_key() != GDK_VoidSymbol) {
558 cerr << (*b).get_key() << " w/mod = " << hex << (*b).get_mod() << dec << " = " << (*b).get_abbrev();
567 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
568 if ((*b).get_mod() & Gdk::RELEASE_MASK) {
569 release_keys.insert (pair<AccelKey,two_strings> (*b, two_strings (*g, *n)));