X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Fkeyboard.cc;h=f3542054aafad01d36673719dc2a8439e1259988;hb=3162ffb4f418d85088d53d5e0a4a5d6ce7235e04;hp=90fea321de89320a5500bcacbfa12c6662182088;hpb=376c5381edca72ce25a04d449e7df39ecbc0d4d0;p=ardour.git diff --git a/gtk2_ardour/keyboard.cc b/gtk2_ardour/keyboard.cc index 90fea321de..f3542054aa 100644 --- a/gtk2_ardour/keyboard.cc +++ b/gtk2_ardour/keyboard.cc @@ -17,22 +17,36 @@ */ +#include +#include "ardour/ardour.h" + #include "ardour_ui.h" #include #include +#include #include +#include + #include -#include +#include "pbd/error.h" +#include "pbd/file_utils.h" + +#include "ardour/filesystem_paths.h" #include "keyboard.h" #include "gui_thread.h" +#include "opts.h" +#include "actions.h" #include "i18n.h" using namespace PBD; +using namespace ARDOUR; +using namespace Gtk; +using namespace std; #define KBD_DEBUG 1 bool debug_keyboard = false; @@ -43,19 +57,40 @@ guint Keyboard::delete_but = 3; guint Keyboard::delete_mod = GDK_SHIFT_MASK; guint Keyboard::snap_mod = GDK_MOD3_MASK; -uint32_t Keyboard::Control = GDK_CONTROL_MASK; -uint32_t Keyboard::Shift = GDK_SHIFT_MASK; -uint32_t Keyboard::Alt = GDK_MOD1_MASK; -uint32_t Keyboard::Meta; +#ifdef GTKOSX +guint Keyboard::PrimaryModifier = GDK_META_MASK; // Command +guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option +guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift +guint Keyboard::Level4Modifier = GDK_CONTROL_MASK; // Control +guint Keyboard::CopyModifier = GDK_MOD1_MASK; // Alt/Option +guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK; +guint Keyboard::button2_modifiers = Keyboard::SecondaryModifier|Keyboard::Level4Modifier; +#else +guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control +guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option +guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift +guint Keyboard::Level4Modifier = GDK_MOD4_MASK; // Mod4/Windows +guint Keyboard::CopyModifier = GDK_CONTROL_MASK; +guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK; +guint Keyboard::button2_modifiers = 0; /* not used */ +#endif + + +Keyboard* Keyboard::_the_keyboard = 0; +Gtk::Window* Keyboard::current_window = 0; +bool Keyboard::_some_magic_widget_has_focus = false; -Keyboard* Keyboard::_the_keyboard = 0; +std::string Keyboard::user_keybindings_path; +bool Keyboard::can_save_keybindings = false; +bool Keyboard::bindings_changed_after_save_became_legal = false; +map Keyboard::binding_files; +string Keyboard::_current_binding_name = _("Unknown"); +map,Keyboard::AccelKeyLess> Keyboard::release_keys; /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */ GdkModifierType Keyboard::RelevantModifierKeyMask; -bool Keyboard::_some_magic_widget_has_focus = false; - void Keyboard::magic_widget_grab_focus () { @@ -82,17 +117,14 @@ Keyboard::Keyboard () RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask (); - /* figure out Meta */ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier); - uint32_t possible_meta[] = { GDK_MOD2_MASK, GDK_MOD3_MASK, GDK_MOD4_MASK, GDK_MOD5_MASK, 0}; - int i; - - for (i = 0; possible_meta[i]; ++i) { - if (!(RelevantModifierKeyMask & possible_meta[i])) { - break; - } - } - Meta = possible_meta[i]; + gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask); snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this); @@ -163,6 +195,13 @@ gint Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) { uint32_t keyval; + bool ret = false; + +#if 0 + cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type + << " state " << std::hex << event->state << std::dec + << endl; +#endif #if KBD_DEBUG if (debug_keyboard) { @@ -186,6 +225,22 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) if (find (state.begin(), state.end(), keyval) == state.end()) { state.push_back (keyval); sort (state.begin(), state.end()); + + } else { + + /* key is already down. if its also used for release, + prevent auto-repeat events. + */ + + for (map::iterator k = release_keys.begin(); k != release_keys.end(); ++k) { + + const AccelKey& ak (k->first); + + if (keyval == ak.get_key() && (Gdk::ModifierType)(event->state | Gdk::RELEASE_MASK) == ak.get_mod()) { + ret = true; + break; + } + } } } else if (event->type == GDK_KEY_RELEASE) { @@ -197,9 +252,40 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) sort (state.begin(), state.end()); } + for (map::iterator k = release_keys.begin(); k != release_keys.end(); ++k) { + + const AccelKey& ak (k->first); + two_strings ts (k->second); + + if (keyval == ak.get_key() && (Gdk::ModifierType)(event->state | Gdk::RELEASE_MASK) == ak.get_mod()) { + Glib::RefPtr act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str()); + if (act) { + act->activate(); + ret = true; + } + break; + } + } } - return false; + /* Special keys that we want to handle in + any dialog, no matter whether it uses + the regular set of accelerators or not + */ + + if (event->type == GDK_KEY_RELEASE && modifier_state_equals (event->state, PrimaryModifier)) { + switch (event->keyval) { + case GDK_w: + if (current_window) { + current_window->hide (); + current_window = 0; + ret = true; + } + break; + } + } + + return ret; } bool @@ -209,33 +295,39 @@ Keyboard::key_is_down (uint32_t keyval) } bool -Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win) +Keyboard::enter_window (GdkEventCrossing *, Gtk::Window* win) { + current_window = win; return false; } bool -Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win) +Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/) { - switch (ev->detail) { - case GDK_NOTIFY_INFERIOR: - if (debug_keyboard) { - cerr << "INFERIOR crossing ... out\n"; - } - break; - - case GDK_NOTIFY_VIRTUAL: - if (debug_keyboard) { - cerr << "VIRTUAL crossing ... out\n"; - } - /* fallthru */ - - default: - if (debug_keyboard) { - cerr << "REAL CROSSING ... out\n"; - cerr << "clearing current target\n"; + if (ev) { + switch (ev->detail) { + case GDK_NOTIFY_INFERIOR: + if (debug_keyboard) { + cerr << "INFERIOR crossing ... out\n"; + } + break; + + case GDK_NOTIFY_VIRTUAL: + if (debug_keyboard) { + cerr << "VIRTUAL crossing ... out\n"; + } + /* fallthru */ + + default: + if (debug_keyboard) { + cerr << "REAL CROSSING ... out\n"; + cerr << "clearing current target\n"; + } + state.clear (); + current_window = 0; } - state.clear (); + } else { + current_window = 0; } return false; @@ -270,15 +362,11 @@ Keyboard::set_delete_modifier (guint mod) } void -Keyboard::set_meta_modifier (guint mod) +Keyboard::set_modifier (uint32_t newval, uint32_t& var) { - /* we don't include Meta in the RelevantModifierKeyMask because its not used - in the same way as snap_mod, delete_mod etc. the only reason we allow it to be - set at all is that X Window has no convention for the keyboard modifier - that Meta should use. Some Linux distributions bind NumLock to Mod2, which - is our default Meta modifier, and this causes severe problems. - */ - Meta = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var); + var = newval; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var); } void @@ -292,12 +380,23 @@ Keyboard::set_snap_modifier (guint mod) bool Keyboard::is_edit_event (GdkEventButton *ev) { - return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) && (ev->button == Keyboard::edit_button()) && ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier()); } +bool +Keyboard::is_button2_event (GdkEventButton* ev) +{ +#ifdef GTKOSX + return (ev->button == 2) || + ((ev->button == 1) && + ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers)); +#else + return ev->button == 2; +#endif +} + bool Keyboard::is_delete_event (GdkEventButton *ev) { @@ -337,11 +436,246 @@ Keyboard::selection_type (guint state) { /* note that there is no modifier for "Add" */ - if (modifier_state_equals (state, Shift)) { + if (modifier_state_equals (state, RangeSelectModifier)) { return Selection::Extend; - } else if (modifier_state_equals (state, Control)) { + } else if (modifier_state_equals (state, PrimaryModifier)) { return Selection::Toggle; } else { return Selection::Set; } } + + +static void +accel_map_changed (GtkAccelMap* /*map*/, + gchar* /*path*/, + guint /*key*/, + GdkModifierType /*mod*/, + gpointer /*arg*/) +{ + Keyboard::keybindings_changed (); +} + +void +Keyboard::keybindings_changed () +{ + if (Keyboard::can_save_keybindings) { + Keyboard::bindings_changed_after_save_became_legal = true; + } + + Keyboard::save_keybindings (); +} + +void +Keyboard::set_can_save_keybindings (bool yn) +{ + can_save_keybindings = yn; +} + +void +Keyboard::save_keybindings () +{ + if (can_save_keybindings && bindings_changed_after_save_became_legal) { + Gtk::AccelMap::save (user_keybindings_path); + } +} + +void +Keyboard::setup_keybindings () +{ + using namespace ARDOUR_COMMAND_LINE; + std::string default_bindings = "mnemonic-us.bindings"; + vector strs; + + binding_files.clear (); + + ARDOUR::find_bindings_files (binding_files); + + /* set up the per-user bindings path */ + + strs.push_back (Glib::get_home_dir()); + strs.push_back (".ardour3"); + strs.push_back ("ardour.bindings"); + + user_keybindings_path = Glib::build_filename (strs); + + if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) { + std::pair newpair; + newpair.first = _("your own"); + newpair.second = user_keybindings_path; + binding_files.insert (newpair); + } + + /* check to see if they gave a style name ("SAE", "ergonomic") or + an actual filename (*.bindings) + */ + + if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) { + + // just a style name - allow user to + // specify the layout type. + + char* layout; + + if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') { + + /* user-specified keyboard layout */ + + keybindings_path += '-'; + keybindings_path += layout; + + } else { + + /* default to US/ANSI - we have to pick something */ + + keybindings_path += "-us"; + } + + keybindings_path += ".bindings"; + } + + if (keybindings_path.empty()) { + + /* no path or binding name given: check the user one first */ + + if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) { + + keybindings_path = ""; + + } else { + + keybindings_path = user_keybindings_path; + } + } + + /* if we still don't have a path at this point, use the default */ + + if (keybindings_path.empty()) { + keybindings_path = default_bindings; + } + + while (true) { + + if (!Glib::path_is_absolute (keybindings_path)) { + + /* not absolute - look in the usual places */ + sys::path keybindings_file; + + SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path(); + + if ( ! find_file_in_search_path (spath, keybindings_path, keybindings_file)) { + + if (keybindings_path == default_bindings) { + error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg; + return; + } else { + warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"), + keybindings_path) + << endmsg; + keybindings_path = default_bindings; + } + + } else { + + /* use it */ + + keybindings_path = keybindings_file.to_string(); + break; + + } + + } else { + + /* path is absolute already */ + + if (!Glib::file_test (keybindings_path, Glib::FILE_TEST_EXISTS)) { + if (keybindings_path == default_bindings) { + error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg; + return; + } else { + warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"), + keybindings_path) + << endmsg; + keybindings_path = default_bindings; + } + + } else { + break; + } + } + } + + load_keybindings (keybindings_path); + + /* catch changes */ + + GtkAccelMap* accelmap = gtk_accel_map_get(); + g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, 0); +} + +bool +Keyboard::load_keybindings (string path) +{ + try { + cerr << "Loading bindings from " << path << endl; + + Gtk::AccelMap::load (path); + + _current_binding_name = _("Unknown"); + + for (map::iterator x = binding_files.begin(); x != binding_files.end(); ++x) { + if (path == x->second) { + _current_binding_name = x->first; + break; + } + } + + + } catch (...) { + error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path) + << endmsg; + return false; + } + + /* now find all release-driven bindings */ + + vector groups; + vector names; + vector bindings; + + ActionManager::get_all_actions (groups, names, bindings); + + vector::iterator g; + vector::iterator b; + vector::iterator n; + + release_keys.clear (); + + bool show_bindings = (getenv ("ARDOUR_SHOW_BINDINGS") != 0); + + for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) { + + if (show_bindings) { + + cerr << "Action: " << (*n) << " Group: " << (*g) << " binding = "; + + if ((*b).get_key() != GDK_VoidSymbol) { + cerr << (*b).get_key() << " w/mod = " << hex << (*b).get_mod() << dec << " = " << (*b).get_abbrev(); + } else { + cerr << "unbound"; + } + + cerr << endl; + } + } + + for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) { + if ((*b).get_mod() & Gdk::RELEASE_MASK) { + release_keys.insert (pair (*b, two_strings (*g, *n))); + } + } + + return true; +} + +