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 = _("Unknown");
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;
115 RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
117 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier);
118 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier);
119 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier);
120 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier);
121 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier);
122 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier);
124 gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
126 snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
129 Keyboard::~Keyboard ()
131 gtk_key_snooper_remove (snooper_id);
135 Keyboard::get_state (void)
137 XMLNode* node = new XMLNode ("Keyboard");
140 snprintf (buf, sizeof (buf), "%d", edit_but);
141 node->add_property ("edit-button", buf);
142 snprintf (buf, sizeof (buf), "%d", edit_mod);
143 node->add_property ("edit-modifier", buf);
144 snprintf (buf, sizeof (buf), "%d", delete_but);
145 node->add_property ("delete-button", buf);
146 snprintf (buf, sizeof (buf), "%d", delete_mod);
147 node->add_property ("delete-modifier", buf);
148 snprintf (buf, sizeof (buf), "%d", snap_mod);
149 node->add_property ("snap-modifier", buf);
155 Keyboard::set_state (const XMLNode& node, int /*version*/)
157 const XMLProperty* prop;
159 if ((prop = node.property ("edit-button")) != 0) {
160 sscanf (prop->value().c_str(), "%d", &edit_but);
163 if ((prop = node.property ("edit-modifier")) != 0) {
164 sscanf (prop->value().c_str(), "%d", &edit_mod);
167 if ((prop = node.property ("delete-button")) != 0) {
168 sscanf (prop->value().c_str(), "%d", &delete_but);
171 if ((prop = node.property ("delete-modifier")) != 0) {
172 sscanf (prop->value().c_str(), "%d", &delete_mod);
175 if ((prop = node.property ("snap-modifier")) != 0) {
176 sscanf (prop->value().c_str(), "%d", &snap_mod);
183 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
185 return ((Keyboard *) data)->snooper (widget, event);
189 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
195 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
196 << " state " << std::hex << event->state << std::dec
201 if (debug_keyboard) {
202 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
207 if (event->keyval == GDK_Shift_R) {
208 keyval = GDK_Shift_L;
210 } else if (event->keyval == GDK_Control_R) {
211 keyval = GDK_Control_L;
214 keyval = event->keyval;
217 if (event->type == GDK_KEY_PRESS) {
219 if (find (state.begin(), state.end(), keyval) == state.end()) {
220 state.push_back (keyval);
221 sort (state.begin(), state.end());
225 /* key is already down. if its also used for release,
226 prevent auto-repeat events.
229 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
231 const AccelKey& ak (k->first);
233 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
234 cerr << "Suppress auto repeat\n";
241 } else if (event->type == GDK_KEY_RELEASE) {
245 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
247 sort (state.begin(), state.end());
250 for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
252 const AccelKey& ak (k->first);
253 two_strings ts (k->second);
255 if (keyval == ak.get_key() && (Gdk::ModifierType)((event->state & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) {
256 Glib::RefPtr<Gtk::Action> act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str());
259 cerr << "use repeat, suppress other\n";
267 /* Special keys that we want to handle in
268 any dialog, no matter whether it uses
269 the regular set of accelerators or not
272 if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) {
273 switch (event->keyval) {
275 if (current_window) {
276 current_window->hide ();
288 Keyboard::key_is_down (uint32_t keyval)
290 return find (state.begin(), state.end(), keyval) != state.end();
294 Keyboard::enter_window (GdkEventCrossing *, Gtk::Window* win)
296 current_window = win;
301 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/)
304 switch (ev->detail) {
305 case GDK_NOTIFY_INFERIOR:
306 if (debug_keyboard) {
307 cerr << "INFERIOR crossing ... out\n";
311 case GDK_NOTIFY_VIRTUAL:
312 if (debug_keyboard) {
313 cerr << "VIRTUAL crossing ... out\n";
318 if (debug_keyboard) {
319 cerr << "REAL CROSSING ... out\n";
320 cerr << "clearing current target\n";
333 Keyboard::set_edit_button (guint but)
339 Keyboard::set_edit_modifier (guint mod)
341 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
343 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
347 Keyboard::set_delete_button (guint but)
353 Keyboard::set_delete_modifier (guint mod)
355 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
357 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
361 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
363 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
365 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
369 Keyboard::set_snap_modifier (guint mod)
371 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
373 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
377 Keyboard::is_edit_event (GdkEventButton *ev)
379 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
380 (ev->button == Keyboard::edit_button()) &&
381 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
385 Keyboard::is_button2_event (GdkEventButton* ev)
388 return (ev->button == 2) ||
389 ((ev->button == 1) &&
390 ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers));
392 return ev->button == 2;
397 Keyboard::is_delete_event (GdkEventButton *ev)
399 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
400 (ev->button == Keyboard::delete_button()) &&
401 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
405 Keyboard::is_context_menu_event (GdkEventButton *ev)
407 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
409 ((ev->state & RelevantModifierKeyMask) == 0);
413 Keyboard::no_modifiers_active (guint state)
415 return (state & RelevantModifierKeyMask) == 0;
419 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
421 return (state & mask) == (guint) mask;
425 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
427 return (state & RelevantModifierKeyMask) == (guint) mask;
431 Keyboard::keybindings_changed ()
433 if (Keyboard::can_save_keybindings) {
434 Keyboard::bindings_changed_after_save_became_legal = true;
437 Keyboard::save_keybindings ();
441 Keyboard::set_can_save_keybindings (bool yn)
443 can_save_keybindings = yn;
447 Keyboard::save_keybindings ()
449 if (can_save_keybindings && bindings_changed_after_save_became_legal) {
450 Gtk::AccelMap::save (user_keybindings_path);
455 Keyboard::load_keybindings (string path)
458 info << "Loading bindings from " << path << endl;
460 Gtk::AccelMap::load (path);
462 _current_binding_name = _("Unknown");
464 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
465 if (path == x->second) {
466 _current_binding_name = x->first;
473 error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path)
478 /* now find all release-driven bindings */
480 vector<string> groups;
481 vector<string> names;
482 vector<AccelKey> bindings;
484 ActionManager::get_all_actions (groups, names, bindings);
486 vector<string>::iterator g;
487 vector<AccelKey>::iterator b;
488 vector<string>::iterator n;
490 release_keys.clear ();
492 bool show_bindings = (getenv ("ARDOUR_SHOW_BINDINGS") != 0);
494 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
498 cerr << "Action: " << (*n) << " Group: " << (*g) << " binding = ";
500 if ((*b).get_key() != GDK_VoidSymbol) {
501 cerr << (*b).get_key() << " w/mod = " << hex << (*b).get_mod() << dec << " = " << (*b).get_abbrev();
510 for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
511 if ((*b).get_mod() & Gdk::RELEASE_MASK) {
512 release_keys.insert (pair<AccelKey,two_strings> (*b, two_strings (*g, *n)));