new PBD::DEBUG API changes for Waves backend
[ardour.git] / libs / gtkmm2ext / keyboard.cc
index e8f59af8c965da7830119f811c6f25040419e8dd..9091eb55f9e433cd0afca201aa5c58d71347c178 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"
@@ -53,14 +58,13 @@ 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;
 
 #ifdef GTKOSX
 
 uint Keyboard::PrimaryModifier = GDK_MOD2_MASK;   // Command
-guint Keyboard::SecondaryModifier = GDK_CONTROL_MASK; // Alt/Option
+guint Keyboard::SecondaryModifier = GDK_CONTROL_MASK; // Control
 guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift
-guint Keyboard::Level4Modifier = GDK_MOD1_MASK; // Control
+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;
@@ -72,6 +76,9 @@ 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"); }
 
+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
@@ -89,8 +96,18 @@ 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"); }
 
+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;
 bool         Keyboard::_some_magic_widget_has_focus = false;
@@ -156,6 +173,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);
@@ -166,6 +185,8 @@ 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);
@@ -179,6 +200,10 @@ 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);
        }
@@ -199,6 +224,10 @@ 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);
        }
@@ -225,8 +254,9 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
        DEBUG_TRACE (
                DEBUG::Keyboard,
                string_compose (
-                       "Snoop widget %1 key %2 type %3 state %4 magic %5\n",
-                       widget, event->keyval, event->type, event->state, _some_magic_widget_has_focus
+                       "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)
                        )
                );
 
@@ -240,6 +270,17 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
                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()) {
@@ -305,6 +346,8 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
                }
        }
 
+       DEBUG_TRACE (DEBUG::Keyboard, string_compose ("snooper returns %1\n", ret));
+
        return ret;
 }
 
@@ -327,6 +370,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;
 }
 
@@ -356,6 +400,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)
 {
@@ -415,6 +482,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)
 {
@@ -520,7 +595,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;
        }
@@ -562,3 +637,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;
+}