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::snap_mod = GDK_MOD3_MASK;
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;
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 */
76 Keyboard* Keyboard::_the_keyboard = 0;
77 Gtk::Window* Keyboard::current_window = 0;
78 bool Keyboard::_some_magic_widget_has_focus = false;
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;
87 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
89 GdkModifierType Keyboard::RelevantModifierKeyMask;
92 Keyboard::magic_widget_grab_focus ()
94 _some_magic_widget_has_focus = true;
98 Keyboard::magic_widget_drop_focus ()
100 _some_magic_widget_has_focus = false;
104 Keyboard::some_magic_widget_has_focus ()
106 return _some_magic_widget_has_focus;
109 Keyboard::Keyboard ()
111 if (_the_keyboard == 0) {
112 _the_keyboard = this;
113 _current_binding_name = _("Unknown");
116 RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
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);
125 gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
127 snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
130 Keyboard::~Keyboard ()
132 gtk_key_snooper_remove (snooper_id);
136 Keyboard::get_state (void)
138 XMLNode* node = new XMLNode ("Keyboard");
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);
156 Keyboard::set_state (const XMLNode& node, int /*version*/)
158 const XMLProperty* prop;
160 if ((prop = node.property ("edit-button")) != 0) {
161 sscanf (prop->value().c_str(), "%d", &edit_but);
164 if ((prop = node.property ("edit-modifier")) != 0) {
165 sscanf (prop->value().c_str(), "%d", &edit_mod);
168 if ((prop = node.property ("delete-button")) != 0) {
169 sscanf (prop->value().c_str(), "%d", &delete_but);
172 if ((prop = node.property ("delete-modifier")) != 0) {
173 sscanf (prop->value().c_str(), "%d", &delete_mod);
176 if ((prop = node.property ("snap-modifier")) != 0) {
177 sscanf (prop->value().c_str(), "%d", &snap_mod);
184 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
186 return ((Keyboard *) data)->snooper (widget, event);
190 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
196 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
197 << " state " << std::hex << event->state << std::dec
198 << " magic ? " << _some_magic_widget_has_focus
203 if (debug_keyboard) {
204 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
209 if (event->keyval == GDK_Shift_R) {
210 keyval = GDK_Shift_L;
212 } else if (event->keyval == GDK_Control_R) {
213 keyval = GDK_Control_L;
216 keyval = event->keyval;
219 if (event->type == GDK_KEY_PRESS) {
221 if (find (state.begin(), state.end(), keyval) == state.end()) {
222 state.push_back (keyval);
223 sort (state.begin(), state.end());
227 /* key is already down. if its also used for release,
228 prevent auto-repeat events.
231 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
233 const AccelKey& ak (k->first);
235 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
236 cerr << "Suppress auto repeat\n";
243 } else if (event->type == GDK_KEY_RELEASE) {
247 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
249 sort (state.begin(), state.end());
252 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
254 const AccelKey& ak (k->first);
255 two_strings ts (k->second);
257 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
258 Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str());
261 cerr << "use repeat, suppress other\n";
269 /* Special keys that we want to handle in
270 any dialog, no matter whether it uses
271 the regular set of accelerators or not
274 if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) {
275 switch (event->keyval) {
277 if (current_window) {
278 current_window->hide ();
290 Keyboard::key_is_down (uint32_t keyval)
292 return find (state.begin(), state.end(), keyval) != state.end();
296 Keyboard::enter_window (GdkEventCrossing *, Gtk::Window* win)
298 current_window = win;
303 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/)
306 switch (ev->detail) {
307 case GDK_NOTIFY_INFERIOR:
308 if (debug_keyboard) {
309 cerr << "INFERIOR crossing ... out\n";
313 case GDK_NOTIFY_VIRTUAL:
314 if (debug_keyboard) {
315 cerr << "VIRTUAL crossing ... out\n";
320 if (debug_keyboard) {
321 cerr << "REAL CROSSING ... out\n";
322 cerr << "clearing current target\n";
335 Keyboard::set_edit_button (guint but)
341 Keyboard::set_edit_modifier (guint mod)
343 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
345 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
349 Keyboard::set_delete_button (guint but)
355 Keyboard::set_delete_modifier (guint mod)
357 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
359 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
363 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
365 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
367 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
371 Keyboard::set_snap_modifier (guint mod)
373 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
375 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
379 Keyboard::is_edit_event (GdkEventButton *ev)
381 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
382 (ev->button == Keyboard::edit_button()) &&
383 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
387 Keyboard::is_button2_event (GdkEventButton* ev)
390 return (ev->button == 2) ||
391 ((ev->button == 1) &&
392 ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers));
394 return ev->button == 2;
399 Keyboard::is_delete_event (GdkEventButton *ev)
401 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
402 (ev->button == Keyboard::delete_button()) &&
403 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
407 Keyboard::is_context_menu_event (GdkEventButton *ev)
409 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
411 ((ev->state & RelevantModifierKeyMask) == 0);
415 Keyboard::no_modifiers_active (guint state)
417 return (state & RelevantModifierKeyMask) == 0;
421 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
423 return (state & mask) == (guint) mask;
427 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
429 return (state & RelevantModifierKeyMask) == (guint) mask;
433 Keyboard::keybindings_changed ()
435 if (Keyboard::can_save_keybindings) {
436 Keyboard::bindings_changed_after_save_became_legal = true;
439 Keyboard::save_keybindings ();
443 Keyboard::set_can_save_keybindings (bool yn)
445 can_save_keybindings = yn;
449 Keyboard::save_keybindings ()
451 if (can_save_keybindings && bindings_changed_after_save_became_legal) {
452 Gtk::AccelMap::save (user_keybindings_path);
457 Keyboard::load_keybindings (string path)
460 info << "Loading bindings from " << path << endl;
462 Gtk::AccelMap::load (path);
464 _current_binding_name = _("Unknown");
466 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
467 if (path == x->second) {
468 _current_binding_name = x->first;
475 error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path)
480 /* now find all release-driven bindings */
482 vector<string> groups;
483 vector<string> names;
484 vector<AccelKey> bindings;
486 ActionManager::get_all_actions (groups, names, bindings);
488 vector<string>::iterator g;
489 vector<AccelKey>::iterator b;
490 vector<string>::iterator n;
492 release_keys.clear ();
494 bool show_bindings = (getenv ("ARDOUR_SHOW_BINDINGS") != 0);
496 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
500 cerr << "Action: " << (*n) << " Group: " << (*g) << " binding = ";
502 if ((*b).get_key() != GDK_VoidSymbol) {
503 cerr << (*b).get_key() << " w/mod = " << hex << (*b).get_mod() << dec << " = " << (*b).get_abbrev();
512 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
513 if ((*b).get_mod() & Gdk::RELEASE_MASK) {
514 release_keys.insert (pair<AccelKey,two_strings> (*b, two_strings (*g, *n)));