X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fgtkmm2ext%2Fkeyboard.cc;h=135e1fdc5650bf0f94e65e885c02aafcf088608f;hb=b9cab93fb116b60f3864bc3e33c9cb6eaf087e97;hp=e09d35e0ea0d1ead83a6d5f1d0f56acf4ae39696;hpb=7c39d2171f485fc44dec9b43621e80909ec26633;p=ardour.git diff --git a/libs/gtkmm2ext/keyboard.cc b/libs/gtkmm2ext/keyboard.cc index e09d35e0ea..135e1fdc56 100644 --- a/libs/gtkmm2ext/keyboard.cc +++ b/libs/gtkmm2ext/keyboard.cc @@ -20,49 +20,69 @@ #include #include -#include -#include - +#include #include +#include "pbd/gstdio_compat.h" + #include #include #include #include #include "pbd/error.h" +#include "pbd/convert.h" #include "pbd/file_utils.h" #include "pbd/search_path.h" #include "pbd/xml++.h" +#include "pbd/debug.h" +#include "pbd/unwind.h" -#include "gtkmm2ext/keyboard.h" #include "gtkmm2ext/actions.h" +#include "gtkmm2ext/bindings.h" +#include "gtkmm2ext/keyboard.h" +#include "gtkmm2ext/debug.h" +#include "gtkmm2ext/utils.h" -#include "i18n.h" +#include "pbd/i18n.h" using namespace PBD; using namespace Gtk; using namespace Gtkmm2ext; using namespace std; -#define KBD_DEBUG 1 -bool debug_keyboard = false; - guint Keyboard::edit_but = 3; guint Keyboard::edit_mod = GDK_CONTROL_MASK; guint Keyboard::delete_but = 3; guint Keyboard::delete_mod = GDK_SHIFT_MASK; -guint Keyboard::snap_mod = GDK_MOD3_MASK; +guint Keyboard::insert_note_but = 1; +guint Keyboard::insert_note_mod = GDK_CONTROL_MASK; + +#ifdef __APPLE__ -#ifdef GTKOSX -guint Keyboard::PrimaryModifier = GDK_META_MASK; // Command -guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option +uint Keyboard::PrimaryModifier = GDK_MOD2_MASK; // Command +guint Keyboard::SecondaryModifier = GDK_CONTROL_MASK; // Control guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift -guint Keyboard::Level4Modifier = GDK_CONTROL_MASK; // Control -guint Keyboard::CopyModifier = GDK_MOD1_MASK; // Alt/Option +guint Keyboard::Level4Modifier = GDK_MOD1_MASK; // Alt/Option +guint Keyboard::CopyModifier = GDK_CONTROL_MASK; // Control guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK; guint Keyboard::button2_modifiers = Keyboard::SecondaryModifier|Keyboard::Level4Modifier; + +const char* Keyboard::primary_modifier_name() { return _("Command"); } +const char* Keyboard::secondary_modifier_name() { return _("Control"); } +const char* Keyboard::tertiary_modifier_name() { return S_("Key|Shift"); } +const char* Keyboard::level4_modifier_name() { return _("Option"); } + +const char* Keyboard::primary_modifier_short_name() { return _("Cmd"); } +const char* Keyboard::secondary_modifier_short_name() { return _("Ctrl"); } +const char* Keyboard::tertiary_modifier_short_name() { return S_("Key|Shift"); } +const char* Keyboard::level4_modifier_short_name() { return _("Opt"); } + +guint Keyboard::snap_mod = Keyboard::Level4Modifier|Keyboard::TertiaryModifier; // XXX this is probably completely wrong +guint Keyboard::snap_delta_mod = 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 @@ -70,8 +90,28 @@ 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 */ + +const char* Keyboard::primary_modifier_name() { return _("Control"); } +const char* Keyboard::secondary_modifier_name() { return _("Alt"); } +const char* Keyboard::tertiary_modifier_name() { return S_("Key|Shift"); } +const char* Keyboard::level4_modifier_name() { return _("Windows"); } + +const char* Keyboard::primary_modifier_short_name() { return _("Ctrl"); } +const char* Keyboard::secondary_modifier_short_name() { return _("Alt"); } +const char* Keyboard::tertiary_modifier_short_name() { return S_("Key|Shift"); } +const char* Keyboard::level4_modifier_short_name() { return _("Win"); } + +guint Keyboard::snap_mod = Keyboard::SecondaryModifier; +guint Keyboard::snap_delta_mod = Keyboard::SecondaryModifier|Keyboard::Level4Modifier; + #endif +guint Keyboard::GainFineScaleModifier = Keyboard::PrimaryModifier; +guint Keyboard::GainExtraFineScaleModifier = Keyboard::SecondaryModifier; + +guint Keyboard::ScrollZoomVerticalModifier = Keyboard::SecondaryModifier; +guint Keyboard::ScrollZoomHorizontalModifier = Keyboard::PrimaryModifier; +guint Keyboard::ScrollHorizontalModifier = Keyboard::TertiaryModifier; Keyboard* Keyboard::_the_keyboard = 0; Gtk::Window* Keyboard::current_window = 0; @@ -82,10 +122,10 @@ bool Keyboard::can_save_keybindings = false; bool Keyboard::bindings_changed_after_save_became_legal = false; map Keyboard::binding_files; string Keyboard::_current_binding_name; -map,Keyboard::AccelKeyLess> Keyboard::release_keys; +string Keyboard::binding_filename_suffix = X_(".keys"); +Gtk::Window* Keyboard::pre_dialog_active_window = 0; /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */ - GdkModifierType Keyboard::RelevantModifierKeyMask; void @@ -124,6 +164,29 @@ Keyboard::Keyboard () gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask); +#ifdef __APPLE__ + /* Remove SUPER,HYPER,META. + * + * GTK on OS X adds META when Command is pressed for various indefensible reasons, since + * it also uses MOD2 to indicate Command. Our code assumes that each + * modifier (Primary, Secondary etc.) is represented by a single bit in + * the modifier mask, but GTK's (STUPID) design uses two (MOD2 + META) + * to represent the Command key. Some discussion about this is here: + * https://bugzilla.gnome.org/show_bug.cgi?id=692597 + * + * We cannot do this until AFTER we told GTK what the default modifier + * was, because otherwise it will fail to recognize MOD2-META- as + * an accelerator. + * + * Note that in the tabbed branch, we no longer use GTK accelerators + * for functional purposes, so this is as critical for that branch. + */ + + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~GDK_SUPER_MASK); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~GDK_HYPER_MASK); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~GDK_META_MASK); +#endif + snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this); } @@ -138,6 +201,8 @@ Keyboard::get_state (void) XMLNode* node = new XMLNode ("Keyboard"); char buf[32]; + snprintf (buf, sizeof (buf), "%d", CopyModifier); + node->add_property ("copy-modifier", buf); snprintf (buf, sizeof (buf), "%d", edit_but); node->add_property ("edit-button", buf); snprintf (buf, sizeof (buf), "%d", edit_mod); @@ -148,6 +213,12 @@ Keyboard::get_state (void) node->add_property ("delete-modifier", buf); snprintf (buf, sizeof (buf), "%d", snap_mod); node->add_property ("snap-modifier", buf); + snprintf (buf, sizeof (buf), "%d", snap_delta_mod); + node->add_property ("snap-delta-modifier", buf); + snprintf (buf, sizeof (buf), "%d", insert_note_but); + node->add_property ("insert-note-button", buf); + snprintf (buf, sizeof (buf), "%d", insert_note_mod); + node->add_property ("insert-note-modifier", buf); return *node; } @@ -155,7 +226,11 @@ Keyboard::get_state (void) int Keyboard::set_state (const XMLNode& node, int /*version*/) { - const XMLProperty* prop; + XMLProperty const * prop; + + if ((prop = node.property ("copy-modifier")) != 0) { + sscanf (prop->value().c_str(), "%d", &CopyModifier); + } if ((prop = node.property ("edit-button")) != 0) { sscanf (prop->value().c_str(), "%d", &edit_but); @@ -177,6 +252,18 @@ Keyboard::set_state (const XMLNode& node, int /*version*/) sscanf (prop->value().c_str(), "%d", &snap_mod); } + if ((prop = node.property ("snap-delta-modifier")) != 0) { + sscanf (prop->value().c_str(), "%d", &snap_delta_mod); + } + + if ((prop = node.property ("insert-note-button")) != 0) { + sscanf (prop->value().c_str(), "%d", &insert_note_but); + } + + if ((prop = node.property ("insert-note-modifier")) != 0) { + sscanf (prop->value().c_str(), "%d", &insert_note_mod); + } + return 0; } @@ -186,36 +273,43 @@ Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data) return ((Keyboard *) data)->snooper (widget, event); } + 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 - << " magic ? " << _some_magic_widget_has_focus - << endl; -#endif - -#if KBD_DEBUG - if (debug_keyboard) { - cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type - << endl; - } -#endif + DEBUG_TRACE ( + DEBUG::Keyboard, + string_compose ( + "Snoop widget %1 name: [%6] key %2 [%8] type %3 state %4 [%7] magic %5\n", + widget, event->keyval, event->type, event->state, _some_magic_widget_has_focus, + gtk_widget_get_name (widget), show_gdk_event_state (event->state), gdk_keyval_name (event->keyval) + ) + ); if (event->keyval == GDK_Shift_R) { keyval = GDK_Shift_L; - } else if (event->keyval == GDK_Control_R) { + } else if (event->keyval == GDK_Control_R) { keyval = GDK_Control_L; } else { keyval = event->keyval; } + if (event->state & ScrollZoomVerticalModifier) { + /* There is a special and rather hacky situation in Editor which makes + it useful to know when the modifier key for vertical zoom has been + released, so emit a signal here (see Editor::_stepping_axis_view). + Note that the state bit for the modifier key is set for the key-up + event when the modifier is released, but not the key-down when it + is pressed, so we get here on key-up, which is what we want. + */ + ZoomVerticalModifierReleased (); /* EMIT SIGNAL */ + } + if (event->type == GDK_KEY_PRESS) { if (find (state.begin(), state.end(), keyval) == state.end()) { @@ -228,41 +322,21 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) prevent auto-repeat events. */ +#if 0 + /* August 2015: we don't have any release bindings + */ + 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 & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) { - cerr << "Suppress auto repeat\n"; + DEBUG_TRACE (DEBUG::Keyboard, "Suppress auto repeat\n"); ret = true; break; } } - } - - } else if (event->type == GDK_KEY_RELEASE) { - - State::iterator i; - - if ((i = find (state.begin(), state.end(), keyval)) != state.end()) { - state.erase (i); - 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 & Keyboard::RelevantModifierKeyMask) | Gdk::RELEASE_MASK) == ak.get_mod()) { - Glib::RefPtr act = ActionManager::get_action (ts.first.c_str(), ts.second.c_str()); - if (act) { - act->activate(); - cerr << "use repeat, suppress other\n"; - ret = true; - } - break; - } +#endif } } @@ -274,18 +348,54 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) 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; - } + close_current_dialog (); + ret = true; break; } } + DEBUG_TRACE (DEBUG::Keyboard, string_compose ("snooper returns %1\n", ret)); + return ret; } +void +Keyboard::close_current_dialog () +{ + if (current_window) { + current_window->hide (); + current_window = 0; + + if (pre_dialog_active_window) { + pre_dialog_active_window->present (); + pre_dialog_active_window = 0; + } + } +} + +bool +Keyboard::catch_user_event_for_pre_dialog_focus (GdkEvent* ev, Gtk::Window* w) +{ + switch (ev->type) { + case GDK_BUTTON_PRESS: + case GDK_BUTTON_RELEASE: + case GDK_KEY_PRESS: + case GDK_KEY_RELEASE: + pre_dialog_active_window = w; + break; + + case GDK_FOCUS_CHANGE: + if (ev->focus_change.in) { + pre_dialog_active_window = w; + } + break; + + default: + break; + } + return false; +} + bool Keyboard::key_is_down (uint32_t keyval) { @@ -296,6 +406,7 @@ bool Keyboard::enter_window (GdkEventCrossing *, Gtk::Window* win) { current_window = win; + DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Entering window, title = %1\n", win->get_title())); return false; } @@ -305,29 +416,49 @@ Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/) if (ev) { switch (ev->detail) { case GDK_NOTIFY_INFERIOR: - if (debug_keyboard) { - cerr << "INFERIOR crossing ... out\n"; - } + DEBUG_TRACE (DEBUG::Keyboard, "INFERIOR crossing ... out\n"); break; case GDK_NOTIFY_VIRTUAL: - if (debug_keyboard) { - cerr << "VIRTUAL crossing ... out\n"; - } + DEBUG_TRACE (DEBUG::Keyboard, "VIRTUAL crossing ... out\n"); /* fallthru */ default: - if (debug_keyboard) { - cerr << "REAL CROSSING ... out\n"; - cerr << "clearing current target\n"; - } + DEBUG_TRACE (DEBUG::Keyboard, "REAL crossing ... out\n"); + DEBUG_TRACE (DEBUG::Keyboard, "Clearing current target\n"); state.clear (); current_window = 0; } } else { + DEBUG_TRACE (DEBUG::Keyboard, "LEAVE window without event\n"); + current_window = 0; + } + + return false; +} + +bool +Keyboard::focus_in_window (GdkEventFocus *, Gtk::Window* win) +{ + current_window = win; + DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Focusing in window, title = %1\n", win->get_title())); + return false; +} + +bool +Keyboard::focus_out_window (GdkEventFocus * ev, Gtk::Window* win) +{ + if (ev) { + state.clear (); current_window = 0; + } else { + if (win == current_window) { + current_window = 0; + } } + DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Foucusing out window, title = %1\n", win->get_title())); + return false; } @@ -359,6 +490,21 @@ Keyboard::set_delete_modifier (guint mod) RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod); } +void +Keyboard::set_insert_note_button (guint but) +{ + insert_note_but = but; +} + +void +Keyboard::set_insert_note_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~insert_note_mod); + insert_note_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | insert_note_mod); +} + + void Keyboard::set_modifier (uint32_t newval, uint32_t& var) { @@ -375,6 +521,14 @@ Keyboard::set_snap_modifier (guint mod) RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod); } +void +Keyboard::set_snap_delta_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_delta_mod); + snap_delta_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_delta_mod); +} + bool Keyboard::is_edit_event (GdkEventButton *ev) { @@ -383,10 +537,18 @@ Keyboard::is_edit_event (GdkEventButton *ev) ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier()); } +bool +Keyboard::is_insert_note_event (GdkEventButton *ev) +{ + return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) && + (ev->button == Keyboard::insert_note_button()) && + ((ev->state & RelevantModifierKeyMask) == Keyboard::insert_note_modifier()); +} + bool Keyboard::is_button2_event (GdkEventButton* ev) { -#ifdef GTKOSX +#ifdef __APPLE__ return (ev->button == 2) || ((ev->button == 1) && ((ev->state & Keyboard::button2_modifiers) == Keyboard::button2_modifiers)); @@ -449,17 +611,19 @@ void Keyboard::save_keybindings () { if (can_save_keybindings && bindings_changed_after_save_became_legal) { - Gtk::AccelMap::save (user_keybindings_path); + /* Call to specific implementation to save bindings to path */ + store_keybindings (user_keybindings_path); } } bool -Keyboard::load_keybindings (string path) +Keyboard::load_keybindings (string const & path) { try { info << "Loading bindings from " << path << endl; - Gtk::AccelMap::load (path); + /* Call to specific implementation to load bindings from path */ + read_keybindings (path); _current_binding_name = _("Unknown"); @@ -472,50 +636,88 @@ Keyboard::load_keybindings (string path) } catch (...) { - error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path) + error << string_compose (_("key bindings file not found at \"%2\" or contains errors."), path) << endmsg; return false; } - /* now find all release-driven bindings */ + return true; +} + +int +Keyboard::read_keybindings (string const & path) +{ + XMLTree tree; + + if (!tree.read (path.c_str())) { + return -1; + } + + /* toplevel node is "BindingSet; children are "Bindings" */ + + XMLNodeList const& children = tree.root()->children(); - vector groups; - vector names; - vector bindings; + for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) { + XMLNode const * child = *i; + if (child->name() == X_("Bindings")) { + XMLProperty const* name = child->property (X_("name")); + if (!name) { + warning << _("Keyboard binding found without a name") << endmsg; + continue; + } - ActionManager::get_all_actions (groups, names, bindings); + Bindings* b = new Bindings (name->value()); + b->load (**i); + } + } - vector::iterator g; - vector::iterator b; - vector::iterator n; + return 0; +} - release_keys.clear (); +int +Keyboard::store_keybindings (string const & path) +{ + XMLNode* node = new XMLNode (X_("BindingSet")); + XMLNode* bnode; + int ret = 0; + + for (list::const_iterator b = Bindings::bindings.begin(); b != Bindings::bindings.end(); ++b) { + bnode = new XMLNode (X_("Bindings")); + bnode->add_property (X_("name"), (*b)->name()); + (*b)->save (*bnode); + node->add_child_nocopy (*bnode); + } - bool show_bindings = (getenv ("ARDOUR_SHOW_BINDINGS") != 0); + XMLTree tree; + tree.set_root (node); /* tree now owns root and will delete it */ - for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) { + if (!tree.write (path)) { + error << string_compose (_("Cannot save key bindings to %1"), path) << endmsg; + ret = -1; + } - if (show_bindings) { + return ret; +} - cerr << "Action: " << (*n) << " Group: " << (*g) << " binding = "; +int +Keyboard::reset_bindings () +{ + if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) { - if ((*b).get_key() != GDK_VoidSymbol) { - cerr << (*b).get_key() << " w/mod = " << hex << (*b).get_mod() << dec << " = " << (*b).get_abbrev(); - } else { - cerr << "unbound"; - } + string new_path = user_keybindings_path; + new_path += ".old"; - cerr << endl; + if (::g_rename (user_keybindings_path.c_str(), new_path.c_str())) { + error << string_compose (_("Cannot rename your own keybinding file (%1)"), strerror (errno)) << endmsg; + return -1; } } - 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))); - } + { + PBD::Unwinder uw (can_save_keybindings, false); + setup_keybindings (); + Bindings::associate_all (); } - return true; + return 0; } - -