Allow all drag -related modifiers to be set, re-instate "jump after trim"
[ardour.git] / libs / gtkmm2ext / keyboard.cc
index 5e4a5f8b625021b72084831bf54702ca1ae41956..17e41a4b85e3005fb6a147d51124c56bf4a5fca8 100644 (file)
 #include <fstream>
 #include <iostream>
 
+#include <cerrno>
 #include <ctype.h>
 
+#include <glib/gstdio.h>
+
 #include <gtkmm/widget.h>
 #include <gtkmm/window.h>
 #include <gtkmm/accelmap.h>
 #include <gdk/gdkkeysyms.h>
 
 #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/debug.h"
 
 #include "i18n.h"
 
@@ -45,33 +52,31 @@ 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::insert_note_but = 3;
+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
 
-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 _("Option"); }
-const char* Keyboard::tertiary_modifier_name() { return _("Shift"); }
-const char* Keyboard::level4_modifier_name() { return _("Control"); }
-const char* Keyboard::copy_modifier_name() { return _("Mod1";    ); }
-const char* Keyboard::rangeselect_modifier_name() { return _("Shift"); }
+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"); }
 
 #else
 
@@ -85,13 +90,28 @@ 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 _("Shift"); }
+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 _("Shift"); }
+const char* Keyboard::rangeselect_modifier_name() { return S_("Key|Shift"); }
 
 #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;
+
+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;
@@ -167,6 +187,22 @@ 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", 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);
@@ -200,6 +236,38 @@ 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 ("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);
        }
@@ -223,30 +291,36 @@ 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 type %3 state %4 magic %5\n",
+                       widget, event->keyval, event->type, event->state, _some_magic_widget_has_focus,
+                       gtk_widget_get_name (widget)
+                       )
+               );
 
        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()) {
@@ -264,7 +338,7 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
                                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;
                                }
@@ -288,8 +362,9 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
                        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();
-                                       cerr << "use repeat, suppress other\n";
+                                       DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Use repeat, suppress other\n", ts.first, ts.second));
                                        ret = true;
                                }
                                break;
@@ -305,18 +380,26 @@ 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;
+       }
+}
+
 bool
 Keyboard::key_is_down (uint32_t keyval)
 {
@@ -327,6 +410,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;
 }
 
@@ -336,22 +420,16 @@ 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;
                }
@@ -362,6 +440,29 @@ Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* /*win*/)
        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 {
+               current_window = 0;
+       }
+
+       DEBUG_TRACE (DEBUG::Keyboard, string_compose ("Foucusing out window, title = %1\n", win->get_title()));
+
+       return false;
+}
+
 void
 Keyboard::set_edit_button (guint but)
 {
@@ -421,6 +522,70 @@ 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);
+}
+
+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)
 {
@@ -526,7 +691,7 @@ 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;
        }
@@ -535,9 +700,10 @@ Keyboard::load_keybindings (string path)
 
        vector<string> groups;
        vector<string> names;
+       vector<string> tooltips;
        vector<AccelKey> bindings;
 
-       ActionManager::get_all_actions (groups, names, bindings);
+       ActionManager::get_all_actions (groups, names, tooltips, bindings);
 
        vector<string>::iterator g;
        vector<AccelKey>::iterator b;
@@ -545,22 +711,17 @@ Keyboard::load_keybindings (string path)
 
        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) {
+               stringstream s;
+               s << "Action: " << *n << " Group: " << *g << " Binding: ";
 
-               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;
+               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";
                }
+
+               DEBUG_TRACE (DEBUG::Bindings, s.str ());
        }
 
        for (n = names.begin(), b = bindings.begin(), g = groups.begin(); n != names.end(); ++n, ++b, ++g) {
@@ -572,4 +733,24 @@ Keyboard::load_keybindings (string path)
        return true;
 }
 
+int
+Keyboard::reset_bindings ()
+{
+       if (Glib::file_test (user_keybindings_path,  Glib::FILE_TEST_EXISTS)) {
+
+               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 ();
+       }
 
+       return 0;
+}