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::CopyModifier = GDK_MOD1_MASK; // Alt/Option
61 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
63 guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control
64 guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option
65 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
66 guint Keyboard::CopyModifier = GDK_CONTROL_MASK;
67 guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK;
70 Keyboard* Keyboard::_the_keyboard = 0;
71 Gtk::Window* Keyboard::current_window = 0;
72 bool Keyboard::_some_magic_widget_has_focus = false;
74 std::string Keyboard::user_keybindings_path;
75 bool Keyboard::can_save_keybindings = false;
76 map<string,string> Keyboard::binding_files;
77 std::string Keyboard::_current_binding_name = _("Unknown");
79 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
81 GdkModifierType Keyboard::RelevantModifierKeyMask;
84 Keyboard::magic_widget_grab_focus ()
86 _some_magic_widget_has_focus = true;
90 Keyboard::magic_widget_drop_focus ()
92 _some_magic_widget_has_focus = false;
96 Keyboard::some_magic_widget_has_focus ()
98 return _some_magic_widget_has_focus;
101 Keyboard::Keyboard ()
103 if (_the_keyboard == 0) {
104 _the_keyboard = this;
107 RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
109 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier);
110 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier);
111 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier);
112 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier);
113 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier);
115 snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
117 XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
121 Keyboard::~Keyboard ()
123 gtk_key_snooper_remove (snooper_id);
127 Keyboard::get_state (void)
129 XMLNode* node = new XMLNode ("Keyboard");
132 snprintf (buf, sizeof (buf), "%d", edit_but);
133 node->add_property ("edit-button", buf);
134 snprintf (buf, sizeof (buf), "%d", edit_mod);
135 node->add_property ("edit-modifier", buf);
136 snprintf (buf, sizeof (buf), "%d", delete_but);
137 node->add_property ("delete-button", buf);
138 snprintf (buf, sizeof (buf), "%d", delete_mod);
139 node->add_property ("delete-modifier", buf);
140 snprintf (buf, sizeof (buf), "%d", snap_mod);
141 node->add_property ("snap-modifier", buf);
147 Keyboard::set_state (const XMLNode& node)
149 const XMLProperty* prop;
151 if ((prop = node.property ("edit-button")) != 0) {
152 sscanf (prop->value().c_str(), "%d", &edit_but);
155 if ((prop = node.property ("edit-modifier")) != 0) {
156 sscanf (prop->value().c_str(), "%d", &edit_mod);
159 if ((prop = node.property ("delete-button")) != 0) {
160 sscanf (prop->value().c_str(), "%d", &delete_but);
163 if ((prop = node.property ("delete-modifier")) != 0) {
164 sscanf (prop->value().c_str(), "%d", &delete_mod);
167 if ((prop = node.property ("snap-modifier")) != 0) {
168 sscanf (prop->value().c_str(), "%d", &snap_mod);
175 Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
177 return ((Keyboard *) data)->snooper (widget, event);
181 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
186 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
187 << " state " << std::hex << event->state << std::dec
192 if (debug_keyboard) {
193 cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
198 if (event->keyval == GDK_Shift_R) {
199 keyval = GDK_Shift_L;
201 } else if (event->keyval == GDK_Control_R) {
202 keyval = GDK_Control_L;
205 keyval = event->keyval;
208 if (event->type == GDK_KEY_PRESS) {
210 if (find (state.begin(), state.end(), keyval) == state.end()) {
211 state.push_back (keyval);
212 sort (state.begin(), state.end());
215 } else if (event->type == GDK_KEY_RELEASE) {
219 if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
221 sort (state.begin(), state.end());
226 if (event->type == GDK_KEY_RELEASE && event->keyval == GDK_w && modifier_state_equals (event->state, PrimaryModifier)) {
227 if (current_window) {
228 current_window->hide ();
237 Keyboard::key_is_down (uint32_t keyval)
239 return find (state.begin(), state.end(), keyval) != state.end();
243 Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win)
245 current_window = win;
250 Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win)
252 switch (ev->detail) {
253 case GDK_NOTIFY_INFERIOR:
254 if (debug_keyboard) {
255 cerr << "INFERIOR crossing ... out\n";
259 case GDK_NOTIFY_VIRTUAL:
260 if (debug_keyboard) {
261 cerr << "VIRTUAL crossing ... out\n";
266 if (debug_keyboard) {
267 cerr << "REAL CROSSING ... out\n";
268 cerr << "clearing current target\n";
278 Keyboard::set_edit_button (guint but)
284 Keyboard::set_edit_modifier (guint mod)
286 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
288 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
292 Keyboard::set_delete_button (guint but)
298 Keyboard::set_delete_modifier (guint mod)
300 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
302 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
306 Keyboard::set_modifier (uint32_t newval, uint32_t& var)
308 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var);
310 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var);
314 Keyboard::set_snap_modifier (guint mod)
316 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
318 RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
322 Keyboard::is_edit_event (GdkEventButton *ev)
325 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
326 (ev->button == Keyboard::edit_button()) &&
327 ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
331 Keyboard::is_delete_event (GdkEventButton *ev)
333 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
334 (ev->button == Keyboard::delete_button()) &&
335 ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
339 Keyboard::is_context_menu_event (GdkEventButton *ev)
341 return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
343 ((ev->state & RelevantModifierKeyMask) == 0);
347 Keyboard::no_modifiers_active (guint state)
349 return (state & RelevantModifierKeyMask) == 0;
353 Keyboard::modifier_state_contains (guint state, ModifierMask mask)
355 return (state & mask) == (guint) mask;
359 Keyboard::modifier_state_equals (guint state, ModifierMask mask)
361 return (state & RelevantModifierKeyMask) == (guint) mask;
365 Keyboard::selection_type (guint state)
367 /* note that there is no modifier for "Add" */
369 if (modifier_state_equals (state, RangeSelectModifier)) {
370 return Selection::Extend;
371 } else if (modifier_state_equals (state, PrimaryModifier)) {
372 return Selection::Toggle;
374 return Selection::Set;
380 accel_map_changed (GtkAccelMap* map,
386 Keyboard::save_keybindings ();
390 Keyboard::set_can_save_keybindings (bool yn)
392 can_save_keybindings = yn;
396 Keyboard::save_keybindings ()
398 if (can_save_keybindings) {
399 Gtk::AccelMap::save (user_keybindings_path);
404 Keyboard::setup_keybindings ()
406 using namespace ARDOUR_COMMAND_LINE;
407 std::string default_bindings = "mnemonic-us.bindings";
411 binding_files.clear ();
413 ARDOUR::find_bindings_files (binding_files);
415 /* set up the per-user bindings path */
417 strs.push_back (Glib::get_home_dir());
418 strs.push_back (".ardour2");
419 strs.push_back ("ardour.bindings");
421 user_keybindings_path = Glib::build_filename (strs);
423 if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
424 std::pair<string,string> newpair;
425 newpair.first = _("your own");
426 newpair.second = user_keybindings_path;
427 binding_files.insert (newpair);
430 /* check to see if they gave a style name ("SAE", "ergonomic") or
431 an actual filename (*.bindings)
434 if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) {
436 // just a style name - allow user to
437 // specify the layout type.
441 if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
443 /* user-specified keyboard layout */
445 keybindings_path += '-';
446 keybindings_path += layout;
450 /* default to US/ANSI - we have to pick something */
452 keybindings_path += "-us";
455 keybindings_path += ".bindings";
458 if (keybindings_path.empty()) {
460 /* no path or binding name given: check the user one first */
462 if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
464 keybindings_path = "";
468 keybindings_path = user_keybindings_path;
472 /* if we still don't have a path at this point, use the default */
474 if (keybindings_path.empty()) {
475 keybindings_path = default_bindings;
480 if (!Glib::path_is_absolute (keybindings_path)) {
482 /* not absolute - look in the usual places */
483 sys::path keybindings_file;
485 SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
487 find_file_in_search_path (spath, keybindings_path, keybindings_file);
491 if (keybindings_path == default_bindings) {
492 error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg;
495 warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
498 keybindings_path = default_bindings;
505 keybindings_path = path;
512 /* path is absolute already */
514 if (!Glib::file_test (keybindings_path, Glib::FILE_TEST_EXISTS)) {
515 if (keybindings_path == default_bindings) {
516 error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg;
519 warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
522 keybindings_path = default_bindings;
531 load_keybindings (keybindings_path);
535 GtkAccelMap* accelmap = gtk_accel_map_get();
536 g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, 0);
540 Keyboard::load_keybindings (string path)
543 cerr << "loading bindings from " << path << endl;
545 Gtk::AccelMap::load (path);
547 _current_binding_name = _("Unknown");
549 for (map<string,string>::iterator x = binding_files.begin(); x != binding_files.end(); ++x) {
550 if (path == x->second) {
551 _current_binding_name = x->first;
559 error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path)