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.
20 #include <ardour/ardour.h>
22 #include "ardour_ui.h"
30 #include <gtkmm/accelmap.h>
32 #include <gdk/gdkkeysyms.h>
33 #include <pbd/error.h>
34 #include <pbd/file_utils.h>
36 #include <ardour/filesystem_paths.h>
39 #include "gui_thread.h"
45 using namespace ARDOUR;
48 bool debug_keyboard = false;
50 guint Keyboard::edit_but = 3;
51 guint Keyboard::edit_mod = GDK_CONTROL_MASK;
52 guint Keyboard::delete_but = 3;
53 guint Keyboard::delete_mod = GDK_SHIFT_MASK;
54 guint Keyboard::snap_mod = GDK_MOD3_MASK;
57 guint Keyboard::PrimaryModifier = GDK_META_MASK; // Command
58 guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option
59 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
60 guint Keyboard::Level4Modifier = GDK_CONTROL_MASK; // Control
61 guint Keyboard::CopyModifier = GDK_MOD1_MASK; // Alt/Option
62 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
64 guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control
65 guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option
66 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
67 guint Keyboard::Level4Modifier = GDK_MOD4_MASK; // Mod4/Windows
68 guint Keyboard::CopyModifier = GDK_CONTROL_MASK;
69 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
72 Keyboard* Keyboard::_the_keyboard = 0;
73 Gtk::Window* Keyboard::current_window = 0;
74 bool Keyboard::_some_magic_widget_has_focus = false;
76 std::string Keyboard::user_keybindings_path;
77 bool Keyboard::can_save_keybindings = false;
78 map<string,string> Keyboard::binding_files;
79 std::string Keyboard::_current_binding_name = _("Unknown");
81 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
83 GdkModifierType Keyboard::RelevantModifierKeyMask;
86 Keyboard::magic_widget_grab_focus ()
88 _some_magic_widget_has_focus = true;
92 Keyboard::magic_widget_drop_focus ()
94 _some_magic_widget_has_focus = false;
98 Keyboard::some_magic_widget_has_focus ()
100 return _some_magic_widget_has_focus;
103 Keyboard::Keyboard ()
105 if (_the_keyboard == 0) {
106 _the_keyboard = this;
109 RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
111 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier);
112 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier);
113 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier);
114 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier);
115 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier);
116 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier);
118 gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask);
120 snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
122 XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
126 Keyboard::~Keyboard ()
128 gtk_key_snooper_remove (snooper_id);
132 Keyboard::get_state (void)
134 XMLNode* node = new XMLNode ("Keyboard");
137 snprintf (buf, sizeof (buf), "%d", edit_but);
138 node->add_property ("edit-button", buf);
139 snprintf (buf, sizeof (buf), "%d", edit_mod);
140 node->add_property ("edit-modifier", buf);
141 snprintf (buf, sizeof (buf), "%d", delete_but);
142 node->add_property ("delete-button", buf);
143 snprintf (buf, sizeof (buf), "%d", delete_mod);
144 node->add_property ("delete-modifier", buf);
145 snprintf (buf, sizeof (buf), "%d", snap_mod);
146 node->add_property ("snap-modifier", buf);
152 Keyboard::set_state (const XMLNode& node)
154 const XMLProperty* prop;
156 if ((prop = node.property ("edit-button")) != 0) {
157 sscanf (prop->value().c_str(), "%d", &edit_but);
160 if ((prop = node.property ("edit-modifier")) != 0) {
161 sscanf (prop->value().c_str(), "%d", &edit_mod);
164 if ((prop = node.property ("delete-button")) != 0) {
165 sscanf (prop->value().c_str(), "%d", &delete_but);
168 if ((prop = node.property ("delete-modifier")) != 0) {
169 sscanf (prop->value().c_str(), "%d", &delete_mod);
172 if ((prop = node.property ("snap-modifier")) != 0) {
173 sscanf (prop->value().c_str(), "%d", &snap_mod);
180 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
182 return ((Keyboard *) data)->snooper (widget, event);
186 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
191 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
192 << " state " << std::hex << event->state << std::dec
197 if (debug_keyboard) {
198 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
203 if (event->keyval == GDK_Shift_R) {
204 keyval = GDK_Shift_L;
206 } else if (event->keyval == GDK_Control_R) {
207 keyval = GDK_Control_L;
210 keyval = event->keyval;
213 if (event->type == GDK_KEY_PRESS) {
215 if (find (state.begin(), state.end(), keyval) == state.end()) {
216 state.push_back (keyval);
217 sort (state.begin(), state.end());
220 } else if (event->type == GDK_KEY_RELEASE) {
224 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
226 sort (state.begin(), state.end());
231 if (event->type == GDK_KEY_RELEASE && event->keyval == GDK_w && modifier_state_equals (event->state, PrimaryModifier)) {
232 if (current_window) {
233 current_window->hide ();
242 Keyboard::key_is_down (uint32_t keyval)
244 return find (state.begin(), state.end(), keyval) != state.end();
248 Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win)
250 current_window = win;
255 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win)
257 switch (ev->detail) {
258 case GDK_NOTIFY_INFERIOR:
259 if (debug_keyboard) {
260 cerr << "INFERIOR crossing ... out\n";
264 case GDK_NOTIFY_VIRTUAL:
265 if (debug_keyboard) {
266 cerr << "VIRTUAL crossing ... out\n";
271 if (debug_keyboard) {
272 cerr << "REAL CROSSING ... out\n";
273 cerr << "clearing current target\n";
283 Keyboard::set_edit_button (guint but)
289 Keyboard::set_edit_modifier (guint mod)
291 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
293 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
297 Keyboard::set_delete_button (guint but)
303 Keyboard::set_delete_modifier (guint mod)
305 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
307 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
311 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
313 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
315 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
319 Keyboard::set_snap_modifier (guint mod)
321 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
323 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
327 Keyboard::is_edit_event (GdkEventButton *ev)
330 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
331 (ev->button == Keyboard::edit_button()) &&
332 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
336 Keyboard::is_delete_event (GdkEventButton *ev)
338 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
339 (ev->button == Keyboard::delete_button()) &&
340 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
344 Keyboard::is_context_menu_event (GdkEventButton *ev)
346 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
348 ((ev->state & RelevantModifierKeyMask) == 0);
352 Keyboard::no_modifiers_active (guint state)
354 return (state & RelevantModifierKeyMask) == 0;
358 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
360 return (state & mask) == (guint) mask;
364 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
366 return (state & RelevantModifierKeyMask) == (guint) mask;
370 Keyboard::selection_type (guint state)
372 /* note that there is no modifier for "Add" */
374 if (modifier_state_equals (state, RangeSelectModifier)) {
375 return Selection::Extend;
376 } else if (modifier_state_equals (state, PrimaryModifier)) {
377 return Selection::Toggle;
379 return Selection::Set;
385 accel_map_changed (GtkAccelMap* map,
391 Keyboard::save_keybindings ();
395 Keyboard::set_can_save_keybindings (bool yn)
397 can_save_keybindings = yn;
401 Keyboard::save_keybindings ()
403 if (can_save_keybindings) {
404 Gtk::AccelMap::save (user_keybindings_path);
409 Keyboard::setup_keybindings ()
411 using namespace ARDOUR_COMMAND_LINE;
412 std::string default_bindings = "mnemonic-us.bindings";
415 binding_files.clear ();
417 ARDOUR::find_bindings_files (binding_files);
419 /* set up the per-user bindings path */
421 strs.push_back (Glib::get_home_dir());
422 strs.push_back (".ardour3");
423 strs.push_back ("ardour.bindings");
425 user_keybindings_path = Glib::build_filename (strs);
427 if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
428 std::pair<string,string> newpair;
429 newpair.first = _("your own");
430 newpair.second = user_keybindings_path;
431 binding_files.insert (newpair);
434 /* check to see if they gave a style name ("SAE", "ergonomic") or
435 an actual filename (*.bindings)
438 if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) {
440 // just a style name - allow user to
441 // specify the layout type.
445 if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
447 /* user-specified keyboard layout */
449 keybindings_path += '-';
450 keybindings_path += layout;
454 /* default to US/ANSI - we have to pick something */
456 keybindings_path += "-us";
459 keybindings_path += ".bindings";
462 if (keybindings_path.empty()) {
464 /* no path or binding name given: check the user one first */
466 if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
468 keybindings_path = "";
472 keybindings_path = user_keybindings_path;
476 /* if we still don't have a path at this point, use the default */
478 if (keybindings_path.empty()) {
479 keybindings_path = default_bindings;
484 if (!Glib::path_is_absolute (keybindings_path)) {
486 /* not absolute - look in the usual places */
487 sys::path keybindings_file;
489 SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
491 if ( ! find_file_in_search_path (spath, keybindings_path, keybindings_file)) {
493 if (keybindings_path == default_bindings) {
494 error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg;
497 warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
500 keybindings_path = default_bindings;
507 keybindings_path = keybindings_file.to_string();
514 /* path is absolute already */
516 if (!Glib::file_test (keybindings_path, Glib::FILE_TEST_EXISTS)) {
517 if (keybindings_path == default_bindings) {
518 error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg;
521 warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
524 keybindings_path = default_bindings;
533 load_keybindings (keybindings_path);
537 GtkAccelMap* accelmap = gtk_accel_map_get();
538 g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, 0);
542 Keyboard::load_keybindings (string path)
545 cerr << "loading bindings from " << path << endl;
547 Gtk::AccelMap::load (path);
549 _current_binding_name = _("Unknown");
551 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
552 if (path == x->second) {
553 _current_binding_name = x->first;
561 error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path)