fix definition of PrimaryModifier for Keyboard for OS X
[ardour.git] / libs / gtkmm2ext / keyboard.cc
index 17e41a4b85e3005fb6a147d51124c56bf4a5fca8..135e1fdc5650bf0f94e65e885c02aafcf088608f 100644 (file)
 #include <vector>
 
 #include <algorithm>
-#include <fstream>
-#include <iostream>
-
 #include <cerrno>
 #include <ctype.h>
 
-#include <glib/gstdio.h>
+#include "pbd/gstdio_compat.h"
 
 #include <gtkmm/widget.h>
 #include <gtkmm/window.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;
@@ -58,10 +57,8 @@ guint Keyboard::delete_but = 3;
 guint Keyboard::delete_mod = GDK_SHIFT_MASK;
 guint Keyboard::insert_note_but = 1;
 guint Keyboard::insert_note_mod = GDK_CONTROL_MASK;
-guint Keyboard::snap_mod = GDK_MOD3_MASK;
-guint Keyboard::snap_delta_mod = 0;
 
-#ifdef GTKOSX
+#ifdef __APPLE__
 
 uint Keyboard::PrimaryModifier = GDK_MOD2_MASK;   // Command
 guint Keyboard::SecondaryModifier = GDK_CONTROL_MASK; // Control
@@ -75,8 +72,14 @@ 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;
 
 #else
 
@@ -91,9 +94,15 @@ 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;
 
 #endif
 
@@ -104,14 +113,6 @@ guint Keyboard::ScrollZoomVerticalModifier = Keyboard::SecondaryModifier;
 guint Keyboard::ScrollZoomHorizontalModifier = Keyboard::PrimaryModifier;
 guint Keyboard::ScrollHorizontalModifier = Keyboard::TertiaryModifier;
 
-guint Keyboard::trim_contents_mod = Keyboard::PrimaryModifier;
-guint Keyboard::trim_overlap_mod = Keyboard::TertiaryModifier;
-guint Keyboard::trim_anchored_mod = Keyboard::TertiaryModifier;
-guint Keyboard::trim_jump_mod = Keyboard::TertiaryModifier;
-guint Keyboard::fine_adjust_mod = Keyboard::SecondaryModifier;
-guint Keyboard::push_points_mod = Keyboard::PrimaryModifier;
-guint Keyboard::note_size_relative_mod = Keyboard::PrimaryModifier;
-
 Keyboard*    Keyboard::_the_keyboard = 0;
 Gtk::Window* Keyboard::current_window = 0;
 bool         Keyboard::_some_magic_widget_has_focus = false;
@@ -121,10 +122,10 @@ bool Keyboard::can_save_keybindings = false;
 bool Keyboard::bindings_changed_after_save_became_legal = false;
 map<string,string> Keyboard::binding_files;
 string Keyboard::_current_binding_name;
-map<AccelKey,pair<string,string>,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
@@ -163,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-<key> 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);
 }
 
@@ -177,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);
@@ -189,20 +215,6 @@ Keyboard::get_state (void)
        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", trim_contents_mod);
-       node->add_property ("trim-contents-modifier", buf);
-       snprintf (buf, sizeof (buf), "%d", trim_overlap_mod);
-       node->add_property ("trim-overlap-modifier", buf);
-       snprintf (buf, sizeof (buf), "%d", trim_anchored_mod);
-       node->add_property ("trim-anchored-modifier", buf);
-       snprintf (buf, sizeof (buf), "%d", trim_jump_mod);
-       node->add_property ("trim-jump-modifier", buf);
-       snprintf (buf, sizeof (buf), "%d", fine_adjust_mod);
-       node->add_property ("fine-adjust-modifier", buf);
-       snprintf (buf, sizeof (buf), "%d", push_points_mod);
-       node->add_property ("push-points-modifier", buf);
-       snprintf (buf, sizeof (buf), "%d", note_size_relative_mod);
-       node->add_property ("note-size-relative-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);
@@ -214,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);
@@ -240,34 +256,6 @@ Keyboard::set_state (const XMLNode& node, int /*version*/)
                sscanf (prop->value().c_str(), "%d", &snap_delta_mod);
        }
 
-       if ((prop = node.property ("trim-contents-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &trim_contents_mod);
-       }
-
-       if ((prop = node.property ("trim-overlap-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &trim_overlap_mod);
-       }
-
-       if ((prop = node.property ("trim-anchored-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &trim_anchored_mod);
-       }
-
-       if ((prop = node.property ("trim-jump-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &trim_jump_mod);
-       }
-
-       if ((prop = node.property ("fine-adjust-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &fine_adjust_mod);
-       }
-
-       if ((prop = node.property ("push-points-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &push_points_mod);
-       }
-
-       if ((prop = node.property ("note-size-relative-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &note_size_relative_mod);
-       }
-
        if ((prop = node.property ("insert-note-button")) != 0) {
                sscanf (prop->value().c_str(), "%d", &insert_note_but);
        }
@@ -285,6 +273,7 @@ Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
        return ((Keyboard *) data)->snooper (widget, event);
 }
 
+
 gint
 Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
 {
@@ -294,9 +283,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)
                        )
                );
 
@@ -333,6 +322,10 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
                           prevent auto-repeat events.
                        */
 
+#if 0
+                       /* August 2015: we don't have any release bindings
+                        */
+
                        for (map<AccelKey,two_strings,AccelKeyLess>::iterator k = release_keys.begin(); k != release_keys.end(); ++k) {
 
                                const AccelKey& ak (k->first);
@@ -343,32 +336,7 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
                                        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<AccelKey,two_strings,AccelKeyLess>::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<Gtk::Action> 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;
-                               }
-                               break;
-                       }
+#endif
                }
        }
 
@@ -397,9 +365,37 @@ 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)
 {
@@ -434,6 +430,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;
        }
 
@@ -455,7 +452,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()));
@@ -530,62 +529,6 @@ Keyboard::set_snap_delta_modifier (guint mod)
        RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_delta_mod);
 }
 
-void
-Keyboard::set_trim_contents_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_contents_mod);
-       trim_contents_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_contents_mod);
-}
-
-void
-Keyboard::set_trim_overlap_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_overlap_mod);
-       trim_overlap_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_overlap_mod);
-}
-
-void
-Keyboard::set_trim_anchored_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_anchored_mod);
-       trim_anchored_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_anchored_mod);
-}
-
-void
-Keyboard::set_trim_jump_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_jump_mod);
-       trim_jump_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_jump_mod);
-}
-
-void
-Keyboard::set_fine_adjust_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~fine_adjust_mod);
-       fine_adjust_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | fine_adjust_mod);
-}
-
-void
-Keyboard::set_push_points_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~push_points_mod);
-       push_points_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | push_points_mod);
-}
-
-void
-Keyboard::set_note_size_relative_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~note_size_relative_mod);
-       note_size_relative_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | note_size_relative_mod);
-}
-
 bool
 Keyboard::is_edit_event (GdkEventButton *ev)
 {
@@ -605,7 +548,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));
@@ -668,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");
 
@@ -696,41 +641,62 @@ Keyboard::load_keybindings (string path)
                return false;
        }
 
-       /* now find all release-driven bindings */
+       return true;
+}
 
-       vector<string> groups;
-       vector<string> names;
-       vector<string> tooltips;
-       vector<AccelKey> 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<string>::iterator g;
-       vector<AccelKey>::iterator b;
-       vector<string>::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);
+               }
+        }
 
-               DEBUG_TRACE (DEBUG::Bindings, s.str ());
+       return 0;
+}
+
+int
+Keyboard::store_keybindings (string const & path)
+{
+       XMLNode* node = new XMLNode (X_("BindingSet"));
+       XMLNode* bnode;
+       int ret = 0;
+
+       for (list<Bindings*>::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);
        }
 
-       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<AccelKey,two_strings> (*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
@@ -740,16 +706,17 @@ Keyboard::reset_bindings ()
 
                string new_path = user_keybindings_path;
                new_path += ".old";
-               
+
                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;
-               } 
+               }
        }
 
        {
                PBD::Unwinder<bool> uw (can_save_keybindings, false);
                setup_keybindings ();
+               Bindings::associate_all ();
        }
 
        return 0;