X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fgtkmm2ext%2Fkeyboard.cc;h=97531fe8f1bfdc654180d6196369177eb5226629;hb=0354dbdfe95d7c9ea1156cb23de038020ac73bf4;hp=b08a1e4f8c19eb41859e05797d313fb8f2e3e2eb;hpb=22b07e0233a29d9633ffa825a79503befaf2e16e;p=ardour.git diff --git a/libs/gtkmm2ext/keyboard.cc b/libs/gtkmm2ext/keyboard.cc index b08a1e4f8c..97531fe8f1 100644 --- a/libs/gtkmm2ext/keyboard.cc +++ b/libs/gtkmm2ext/keyboard.cc @@ -20,13 +20,10 @@ #include #include -#include -#include - #include #include -#include +#include "pbd/gstdio_compat.h" #include #include @@ -41,11 +38,13 @@ #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; @@ -59,9 +58,9 @@ guint Keyboard::delete_mod = GDK_SHIFT_MASK; guint Keyboard::insert_note_but = 1; guint Keyboard::insert_note_mod = GDK_CONTROL_MASK; -#ifdef GTKOSX +#ifdef __APPLE__ -uint Keyboard::PrimaryModifier = GDK_MOD2_MASK; // Command +guint Keyboard::PrimaryModifier = GDK_MOD2_MASK; // Command guint Keyboard::SecondaryModifier = GDK_CONTROL_MASK; // Control guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift guint Keyboard::Level4Modifier = GDK_MOD1_MASK; // Alt/Option @@ -73,8 +72,11 @@ 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::copy_modifier_name() { return _("Control"); } -const char* Keyboard::rangeselect_modifier_name() { return S_("Key|Shift"); } + +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; @@ -84,7 +86,7 @@ guint Keyboard::snap_delta_mod = Keyboard::Level4Modifier; 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::Level4Modifier = GDK_MOD4_MASK|GDK_SUPER_MASK; // Mod4/Windows guint Keyboard::CopyModifier = GDK_CONTROL_MASK; guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK; guint Keyboard::button2_modifiers = 0; /* not used */ @@ -92,9 +94,12 @@ 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 _("Meta"); } -const char* Keyboard::copy_modifier_name() { return _("Control"); } -const char* Keyboard::rangeselect_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; @@ -117,11 +122,12 @@ 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; +sigc::signal0 Keyboard::RelevantModifierKeysChanged; void Keyboard::magic_widget_grab_focus () @@ -148,16 +154,7 @@ Keyboard::Keyboard () _current_binding_name = _("Unknown"); } - RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask (); - - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier); - - gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask); + reset_relevant_modifier_key_mask(); snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this); } @@ -171,26 +168,16 @@ XMLNode& 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); - node->add_property ("edit-modifier", buf); - snprintf (buf, sizeof (buf), "%d", delete_but); - node->add_property ("delete-button", buf); - snprintf (buf, sizeof (buf), "%d", delete_mod); - 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); + + node->set_property ("copy-modifier", CopyModifier); + node->set_property ("edit-button", edit_but); + node->set_property ("edit-modifier", edit_mod); + node->set_property ("delete-button", delete_but); + node->set_property ("delete-modifier", delete_mod); + node->set_property ("snap-modifier", snap_mod); + node->set_property ("snap-delta-modifier", snap_delta_mod); + node->set_property ("insert-note-button", insert_note_but); + node->set_property ("insert-note-modifier", insert_note_mod); return *node; } @@ -198,43 +185,15 @@ Keyboard::get_state (void) int Keyboard::set_state (const XMLNode& node, int /*version*/) { - const XMLProperty* 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); - } - - if ((prop = node.property ("edit-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &edit_mod); - } - - if ((prop = node.property ("delete-button")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_but); - } - - if ((prop = node.property ("delete-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_mod); - } - - if ((prop = node.property ("snap-modifier")) != 0) { - 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); - } + node.get_property ("copy-modifier", CopyModifier); + node.get_property ("edit-button", edit_but); + node.get_property ("edit-modifier", edit_mod); + node.get_property ("delete-button", delete_but); + node.get_property ("delete-modifier", delete_mod); + node.get_property ("snap-modifier", snap_mod); + node.get_property ("snap-delta-modifier", snap_delta_mod); + node.get_property ("insert-note-button", insert_note_but); + node.get_property ("insert-note-modifier", insert_note_mod); return 0; } @@ -245,6 +204,7 @@ Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data) return ((Keyboard *) data)->snooper (widget, event); } + gint Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) { @@ -254,9 +214,9 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) DEBUG_TRACE ( DEBUG::Keyboard, string_compose ( - "Snoop widget %1 name: [%6] key %2 type %3 state %4 magic %5\n", + "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) + gtk_widget_get_name (widget), show_gdk_event_state (event->state), gdk_keyval_name (event->keyval) ) ); @@ -293,6 +253,10 @@ 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); @@ -303,63 +267,110 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) break; } } +#endif } + } - } 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()); + if (event->type == GDK_KEY_RELEASE) { + + State::iterator k = find (state.begin(), state.end(), keyval); + + if (k != state.end()) { + /* this cannot change the ordering, so need to sort */ + state.erase (k); + if (state.empty()) { + DEBUG_TRACE (DEBUG::Keyboard, "no keys down\n"); + } else { +#ifndef NDEBUG + if (DEBUG_ENABLED(DEBUG::Keyboard)) { + DEBUG_STR_DECL(a); + DEBUG_STR_APPEND(a, "keyboard, keys still down: "); + for (State::iterator i = state.begin(); i != state.end(); ++i) { + DEBUG_STR_APPEND(a, gdk_keyval_name (*i)); + DEBUG_STR_APPEND(a, ','); + } + DEBUG_STR_APPEND(a, '\n'); + DEBUG_TRACE (DEBUG::Keyboard, DEBUG_STR(a).str()); + } +#endif /* NDEBUG */ + } } - for (map::iterator k = release_keys.begin(); k != release_keys.end(); ++k) { + if (modifier_state_equals (event->state, PrimaryModifier)) { - const AccelKey& ak (k->first); - two_strings ts (k->second); + /* Special keys that we want to handle in + any dialog, no matter whether it uses + the regular set of accelerators or not + */ - 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) { - DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Activate %1 %2\n", ts.first, ts.second)); - act->activate(); - DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Use repeat, suppress other\n", ts.first, ts.second)); - ret = true; - } + switch (event->keyval) { + case GDK_w: + close_current_dialog (); + ret = true; break; } } } - /* 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: - close_current_dialog (); - ret = true; - break; - } - } - DEBUG_TRACE (DEBUG::Keyboard, string_compose ("snooper returns %1\n", ret)); return ret; } +void +Keyboard::reset_relevant_modifier_key_mask () +{ + RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask (); + + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | Level4Modifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier); + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier); + + gtk_accelerator_set_default_mod_mask (RelevantModifierKeyMask); + + RelevantModifierKeysChanged(); /* EMIT SIGNAL */ +} + 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) { @@ -394,6 +405,7 @@ Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/) current_window = 0; } } else { + DEBUG_TRACE (DEBUG::Keyboard, "LEAVE window without event\n"); current_window = 0; } @@ -415,7 +427,9 @@ Keyboard::focus_out_window (GdkEventFocus * ev, Gtk::Window* win) state.clear (); current_window = 0; } else { - current_window = 0; + if (win == current_window) { + current_window = 0; + } } DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Foucusing out window, title = %1\n", win->get_title())); @@ -432,9 +446,8 @@ Keyboard::set_edit_button (guint but) void Keyboard::set_edit_modifier (guint mod) { - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod); edit_mod = mod; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod); + reset_relevant_modifier_key_mask(); } void @@ -446,9 +459,8 @@ Keyboard::set_delete_button (guint but) void Keyboard::set_delete_modifier (guint mod) { - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod); delete_mod = mod; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod); + reset_relevant_modifier_key_mask(); } void @@ -460,34 +472,30 @@ Keyboard::set_insert_note_button (guint 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); + reset_relevant_modifier_key_mask(); } void Keyboard::set_modifier (uint32_t newval, uint32_t& var) { - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var); var = newval; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var); + reset_relevant_modifier_key_mask(); } void Keyboard::set_snap_modifier (guint mod) { - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod); snap_mod = mod; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod); + reset_relevant_modifier_key_mask(); } void Keyboard::set_snap_delta_modifier (guint mod) { - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_delta_mod); snap_delta_mod = mod; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_delta_mod); + reset_relevant_modifier_key_mask(); } bool @@ -509,7 +517,7 @@ Keyboard::is_insert_note_event (GdkEventButton *ev) 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)); @@ -572,17 +580,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"); @@ -600,41 +610,62 @@ Keyboard::load_keybindings (string path) return false; } - /* now find all release-driven bindings */ + return true; +} - vector groups; - vector names; - vector tooltips; - vector bindings; +int +Keyboard::read_keybindings (string const & path) +{ + XMLTree tree; - ActionManager::get_all_actions (groups, names, tooltips, bindings); + if (!tree.read (path.c_str())) { + return -1; + } - vector::iterator g; - vector::iterator b; - vector::iterator n; + /* toplevel node is "BindingSet; children are "Bindings" */ - release_keys.clear (); + XMLNodeList const& children = tree.root()->children(); - for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) { - stringstream s; - s << "Action: " << *n << " Group: " << *g << " Binding: "; + 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; + } - if ((*b).get_key() != GDK_VoidSymbol) { - s << b->get_key() << " w/mod " << hex << b->get_mod() << dec << " = " << b->get_abbrev () << "\n"; - } else { - s << "unbound\n"; - } + Bindings* b = new Bindings (name->value()); + b->load (**i); + } + } + + return 0; +} - DEBUG_TRACE (DEBUG::Bindings, s.str ()); +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->set_property (X_("name"), (*b)->name()); + (*b)->save (*bnode); + node->add_child_nocopy (*bnode); } - 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))); - } + XMLTree tree; + tree.set_root (node); /* tree now owns root and will delete it */ + + if (!tree.write (path)) { + error << string_compose (_("Cannot save key bindings to %1"), path) << endmsg; + ret = -1; } - return true; + return ret; } int @@ -653,7 +684,9 @@ Keyboard::reset_bindings () { PBD::Unwinder uw (can_save_keybindings, false); + Bindings::reset_bindings (); setup_keybindings (); + Bindings::associate_all (); } return 0;