Merge branch 'master' into windows
[ardour.git] / libs / gtkmm2ext / keyboard.cc
index da51d4e412d1a71438c358ba82ecc2d40ef24029..5087f61a237480f3359f0213fddb92f8ec13096e 100644 (file)
 #include "pbd/file_utils.h"
 #include "pbd/search_path.h"
 #include "pbd/xml++.h"
+#include "pbd/debug.h"
 
 #include "gtkmm2ext/keyboard.h"
 #include "gtkmm2ext/actions.h"
+#include "gtkmm2ext/debug.h"
 
 #include "i18n.h"
 
@@ -45,24 +47,33 @@ 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 = 1;
+guint Keyboard::insert_note_mod = GDK_CONTROL_MASK;
 guint Keyboard::snap_mod = GDK_MOD3_MASK;
 
 #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::copy_modifier_name() { return _("Control"); }
+const char* Keyboard::rangeselect_modifier_name() { return S_("Key|Shift"); }
+
 #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 +81,23 @@ 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 _("Meta"); }
+const char* Keyboard::copy_modifier_name() { return _("Control"); }
+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;
+
 
 Keyboard*    Keyboard::_the_keyboard = 0;
 Gtk::Window* Keyboard::current_window = 0;
@@ -81,7 +107,7 @@ std::string Keyboard::user_keybindings_path;
 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 = _("Unknown");
+string Keyboard::_current_binding_name;
 map<AccelKey,pair<string,string>,Keyboard::AccelKeyLess> Keyboard::release_keys;
 
 /* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
@@ -110,6 +136,7 @@ Keyboard::Keyboard ()
 {
        if (_the_keyboard == 0) {
                _the_keyboard = this;
+                _current_binding_name = _("Unknown");
        }
 
        RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
@@ -147,6 +174,10 @@ 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", 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;
 }
@@ -176,6 +207,14 @@ Keyboard::set_state (const XMLNode& node, int /*version*/)
                sscanf (prop->value().c_str(), "%d", &snap_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;
 }
 
@@ -191,29 +230,35 @@ 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
-            << 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 key %2 type %3 state %4 magic %5\n",
+                       widget, event->keyval, event->type, event->state, _some_magic_widget_has_focus
+                       )
+               );
 
        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()) {
@@ -231,7 +276,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;
                                }
@@ -255,8 +300,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;
@@ -272,11 +318,8 @@ 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;
                }
        }
@@ -284,6 +327,15 @@ Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
        return ret;
 }
 
+void
+Keyboard::close_current_dialog ()
+{
+       if (current_window) {
+               current_window->hide ();
+               current_window = 0;
+       }
+}
+
 bool
 Keyboard::key_is_down (uint32_t keyval)
 {
@@ -303,22 +355,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;
                }
@@ -357,6 +403,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)
 {
@@ -381,6 +442,14 @@ 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)
 {
@@ -470,7 +539,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;
        }
@@ -479,9 +548,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;
@@ -489,22 +559,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) {
@@ -516,4 +581,3 @@ Keyboard::load_keybindings (string path)
        return true;
 }
 
-