enough with umpteen "i18n.h" files. Consolidate on pbd/i18n.h
[ardour.git] / gtk2_ardour / keyboard.cc
index e6eaffefcbfd0e1fc6807410802991bd9a027418..6341071451f94d3b5e99b72169e8405652ff53e2 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2001 Paul Davis 
+    Copyright (C) 2001 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include "ardour_ui.h"
-
-#include <algorithm>
-#include <fstream>
+#include "pbd/convert.h"
+#include "pbd/error.h"
+#include "pbd/file_utils.h"
+#include "pbd/basename.h"
 
-#include <ctype.h>
-
-#include <gdk/gdkkeysyms.h>
-#include <pbd/error.h>
+#include "ardour/filesystem_paths.h"
 
+#include "ardour_ui.h"
+#include "public_editor.h"
 #include "keyboard.h"
-#include "gui_thread.h"
+#include "opts.h"
+#include "ui_config.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
+using namespace std;
+using namespace Gtk;
 using namespace PBD;
+using namespace ARDOUR;
+using Gtkmm2ext::Keyboard;
 
-#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::snap_mod = GDK_MOD3_MASK;
-
-uint32_t Keyboard::Control = GDK_CONTROL_MASK;
-uint32_t Keyboard::Shift = GDK_SHIFT_MASK;
-uint32_t Keyboard::Alt = GDK_MOD1_MASK;
-uint32_t Keyboard::Meta;
+#ifdef __APPLE__
+guint ArdourKeyboard::constraint_mod = Keyboard::PrimaryModifier;
+#else
+guint ArdourKeyboard::constraint_mod = Keyboard::SecondaryModifier;
+#endif
+guint ArdourKeyboard::trim_contents_mod = Keyboard::PrimaryModifier;
+guint ArdourKeyboard::trim_overlap_mod = Keyboard::TertiaryModifier;
+guint ArdourKeyboard::trim_anchored_mod = Keyboard::TertiaryModifier;
+guint ArdourKeyboard::fine_adjust_mod = Keyboard::SecondaryModifier;
+guint ArdourKeyboard::push_points_mod = Keyboard::PrimaryModifier;
+guint ArdourKeyboard::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;
+void
+ArdourKeyboard::find_bindings_files (map<string,string>& files)
+{
+       vector<std::string> found;
+       Searchpath spath = ardour_config_search_path();
 
-/* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
+       find_files_matching_pattern (found, spath, string_compose ("*%1", Keyboard::binding_filename_suffix));
 
-GdkModifierType Keyboard::RelevantModifierKeyMask;
+       if (found.empty()) {
+               return;
+       }
 
-void
-Keyboard::magic_widget_grab_focus () 
-{
-       _some_magic_widget_has_focus = true;
+       for (vector<std::string>::iterator x = found.begin(); x != found.end(); ++x) {
+               std::string path(*x);
+               pair<string,string> namepath;
+               namepath.second = path;
+               namepath.first = PBD::basename_nosuffix (path);
+               files.insert (namepath);
+       }
 }
 
 void
-Keyboard::magic_widget_drop_focus ()
+ArdourKeyboard::setup_keybindings ()
 {
-       _some_magic_widget_has_focus = false;
-}
+       using namespace ARDOUR_COMMAND_LINE;
+       string default_bindings = string_compose ("%1%2", UIConfiguration::instance().get_default_bindings(), Keyboard::binding_filename_suffix);
+       vector<string> strs;
 
-bool
-Keyboard::some_magic_widget_has_focus ()
-{
-       return _some_magic_widget_has_focus;
-}
+       binding_files.clear ();
 
-Keyboard::Keyboard ()
-{
-       if (_the_keyboard == 0) {
-               _the_keyboard = this;
-       }
+       find_bindings_files (binding_files);
 
-       RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
+       /* set up the per-user bindings path */
 
-       /* figure out Meta */
+       string lowercase_program_name = downcase (string(PROGRAM_NAME));
 
-       uint32_t possible_meta[] = { GDK_MOD2_MASK, GDK_MOD3_MASK, GDK_MOD4_MASK, GDK_MOD5_MASK, 0};
-       int i;
+       user_keybindings_path = Glib::build_filename (user_config_directory(), lowercase_program_name + binding_filename_suffix);
 
-       for (i = 0; possible_meta[i]; ++i) {
-               if (!(RelevantModifierKeyMask & possible_meta[i])) {
-                       break;
-               }
+       if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
+               std::pair<string,string> newpair;
+               newpair.first = _("your own");
+               newpair.second = user_keybindings_path;
+               binding_files.insert (newpair);
        }
-       Meta = possible_meta[i];
 
-       snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
+       /* check to see if they gave a style name ("ergonomic") or an actual filename (*.bindings)
+       */
 
-       XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
-       set_state (*node);
-}
+       if (!keybindings_path.empty() && keybindings_path.find (binding_filename_suffix) == string::npos) {
 
-Keyboard::~Keyboard ()
-{
-       gtk_key_snooper_remove (snooper_id);
-}
+               // just a style name - allow user to
+               // specify the layout type.
 
-XMLNode& 
-Keyboard::get_state (void)
-{
-       XMLNode* node = new XMLNode ("Keyboard");
-       char buf[32];
+               char* layout;
 
-       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);
+               if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
 
-       return *node;
-}
+                       /* user-specified keyboard layout */
 
-int 
-Keyboard::set_state (const XMLNode& node)
-{
-       const XMLProperty* prop;
+                       keybindings_path += '-';
+                       keybindings_path += layout;
 
-       if ((prop = node.property ("edit-button")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &edit_but);
-       } 
+               } else {
 
-       if ((prop = node.property ("edit-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &edit_mod);
-       } 
+                       /* default to US/ANSI - we have to pick something */
 
-       if ((prop = node.property ("delete-button")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &delete_but);
-       } 
+                       keybindings_path += "-us";
+               }
 
-       if ((prop = node.property ("delete-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &delete_mod);
-       } 
+               keybindings_path += binding_filename_suffix;
+       }
 
-       if ((prop = node.property ("snap-modifier")) != 0) {
-               sscanf (prop->value().c_str(), "%d", &snap_mod);
-       } 
+       if (keybindings_path.empty()) {
 
-       return 0;
-}
+               /* no path or binding name given: check the user one first */
 
-gint
-Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
-{
-       return ((Keyboard *) data)->snooper (widget, event);
-}
+               if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
 
-gint
-Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
-{
-       uint32_t keyval;
+                       keybindings_path = "";
 
-#if KBD_DEBUG
-       if (debug_keyboard) {
-               cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type 
-                    << endl;
-       }
-#endif
+               } else {
 
-       if (event->keyval == GDK_Shift_R) {
-               keyval = GDK_Shift_L;
+                       keybindings_path = user_keybindings_path;
+               }
+       }
 
-       } else  if (event->keyval == GDK_Control_R) {
-               keyval = GDK_Control_L;
+       /* if we still don't have a path at this point, use the default */
 
-       } else {
-               keyval = event->keyval;
+       if (keybindings_path.empty()) {
+               keybindings_path = default_bindings;
        }
-               
-       if (event->type == GDK_KEY_PRESS) {
 
-               if (find (state.begin(), state.end(), keyval) == state.end()) {
-                       state.push_back (keyval);
-                       sort (state.begin(), state.end());
-               }
+       cerr << "KP is " << keybindings_path << endl;
 
-       } else if (event->type == GDK_KEY_RELEASE) {
+       while (true) {
 
-               State::iterator i;
-               
-               if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
-                       state.erase (i);
-                       sort (state.begin(), state.end());
-               } 
+               if (!Glib::path_is_absolute (keybindings_path)) {
 
-       }
+                       /* not absolute - look in the usual places */
+                       std::string keybindings_file;
+
+                       if (!find_file (ardour_config_search_path(), keybindings_path, keybindings_file)) {
+
+                               if (keybindings_path == default_bindings) {
+                                       error << string_compose (_("Default keybindings not found - %1 will be hard to use!"), PROGRAM_NAME) << endmsg;
+                                       return;
+                               } else {
+                                       warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
+                                                                  keybindings_path)
+                                               << endmsg;
+                                       keybindings_path = default_bindings;
+                               }
+
+                       } else {
+
+                               /* use it */
+
+                               keybindings_path = keybindings_file;
+                               break;
+
+                       }
+
+               } else {
+
+                       /* path is absolute already */
+
+                       if (!Glib::file_test (keybindings_path, Glib::FILE_TEST_EXISTS)) {
+                               if (keybindings_path == default_bindings) {
+                                       error << string_compose (_("Default keybindings not found - %1 will be hard to use!"), PROGRAM_NAME) << endmsg;
+                                       return;
+                               } else {
+                                       keybindings_path = default_bindings;
+                               }
 
-       if (event->type == GDK_KEY_RELEASE && event->keyval == GDK_w && modifier_state_equals (event->state, Control)) {
-               if (current_window) {
-                       current_window->hide ();
-                       current_window = 0;
+                       } else {
+                               break;
+                       }
                }
        }
 
-       return false;
-}
+       info << string_compose (_("Loading keybindings from %1"), keybindings_path) << endmsg;
 
-bool
-Keyboard::key_is_down (uint32_t keyval)
-{
-       return find (state.begin(), state.end(), keyval) != state.end();
+       load_keybindings (keybindings_path);
+
+       /* catch changes made via some GTK mechanism */
+
+       // GtkAccelMap* accelmap = gtk_accel_map_get();
+       // g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, this);
 }
 
-bool
-Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win)
+XMLNode&
+ArdourKeyboard::get_state (void)
 {
-       current_window = win;
-       return false;
+       XMLNode* node = &Keyboard::get_state ();
+       char buf[32];
+
+       snprintf (buf, sizeof (buf), "%d", constraint_mod);
+       node->add_property ("constraint-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", 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);
+
+       return *node;
 }
 
-bool
-Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win)
+int
+ArdourKeyboard::set_state (const XMLNode& node, int version)
 {
-       switch (ev->detail) {
-       case GDK_NOTIFY_INFERIOR:
-               if (debug_keyboard) {
-                       cerr << "INFERIOR crossing ... out\n";
-               }
-               break;
+       XMLProperty const * prop;
 
-       case GDK_NOTIFY_VIRTUAL:
-               if (debug_keyboard) {
-                       cerr << "VIRTUAL crossing ... out\n";
-               }
-               /* fallthru */
+       if ((prop = node.property ("constraint-modifier")) != 0) {
+               sscanf (prop->value().c_str(), "%d", &constraint_mod);
+       }
 
-       default:
-               if (debug_keyboard) {
-                       cerr << "REAL CROSSING ... out\n";
-                       cerr << "clearing current target\n";
-               }
-               state.clear ();
-               current_window = 0;
+       if ((prop = node.property ("trim-contents-modifier")) != 0) {
+               sscanf (prop->value().c_str(), "%d", &trim_contents_mod);
        }
 
-       return false;
-}
+       if ((prop = node.property ("trim-overlap-modifier")) != 0) {
+               sscanf (prop->value().c_str(), "%d", &trim_overlap_mod);
+       }
 
-void
-Keyboard::set_edit_button (guint but)
-{
-       edit_but = but;
-}
+       if ((prop = node.property ("trim-anchored-modifier")) != 0) {
+               sscanf (prop->value().c_str(), "%d", &trim_anchored_mod);
+       }
 
-void
-Keyboard::set_edit_modifier (guint mod)
-{
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
-       edit_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
-}
+       if ((prop = node.property ("fine-adjust-modifier")) != 0) {
+               sscanf (prop->value().c_str(), "%d", &fine_adjust_mod);
+       }
 
-void
-Keyboard::set_delete_button (guint but)
-{
-       delete_but = but;
+       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);
+       }
+
+       return Keyboard::set_state (node, version);
 }
 
-void
-Keyboard::set_delete_modifier (guint mod)
+/* Snap and snap delta modifiers may contain each other, so we use the
+ * following two methods to sort that out:
+ */
+bool
+ArdourKeyboard::indicates_snap (guint state)
 {
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
-       delete_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
+       const bool contains_s = Keyboard::modifier_state_contains (state, Keyboard::snap_modifier ());
+       const bool contains_d = Keyboard::modifier_state_contains (state, Keyboard::snap_delta_modifier ());
+       const bool s_contains_d = Keyboard::modifier_state_contains (Keyboard::snap_modifier (), Keyboard::snap_delta_modifier ());
+
+       return  (contains_s && ((contains_d && s_contains_d) || !contains_d));
 }
 
-void
-Keyboard::set_meta_modifier (guint mod)
+bool
+ArdourKeyboard::indicates_snap_delta (guint state)
 {
-       /* we don't include Meta in the RelevantModifierKeyMask because its not used
-          in the same way as snap_mod, delete_mod etc. the only reason we allow it to be
-          set at all is that X Window has no convention for the keyboard modifier
-          that Meta should use. Some Linux distributions bind NumLock to Mod2, which
-          is our default Meta modifier, and this causes severe problems.
-       */
-       Meta = mod;
+       const bool contains_d = Keyboard::modifier_state_contains (state, Keyboard::snap_delta_modifier ());
+       const bool contains_s = Keyboard::modifier_state_contains (state, Keyboard::snap_modifier ());
+       const bool d_contains_s = Keyboard::modifier_state_contains (Keyboard::snap_delta_modifier (), Keyboard::snap_modifier ());
+
+       return (contains_d && ((contains_s && d_contains_s) || !contains_s));
 }
 
 void
-Keyboard::set_snap_modifier (guint mod)
+ArdourKeyboard::set_constraint_modifier (guint mod)
 {
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
-       snap_mod = mod;
-       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~constraint_mod);
+       constraint_mod = mod;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | constraint_mod);
 }
 
-bool
-Keyboard::is_edit_event (GdkEventButton *ev)
+void
+ArdourKeyboard::set_trim_contents_modifier (guint mod)
 {
-
-       return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) && 
-               (ev->button == Keyboard::edit_button()) && 
-               ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_contents_mod);
+       trim_contents_mod = mod;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_contents_mod);
 }
 
-bool
-Keyboard::is_delete_event (GdkEventButton *ev)
+void
+ArdourKeyboard::set_trim_overlap_modifier (guint mod)
 {
-       return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) && 
-               (ev->button == Keyboard::delete_button()) && 
-               ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_overlap_mod);
+       trim_overlap_mod = mod;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_overlap_mod);
 }
 
-bool
-Keyboard::is_context_menu_event (GdkEventButton *ev)
+void
+ArdourKeyboard::set_trim_anchored_modifier (guint mod)
 {
-       return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) && 
-               (ev->button == 3) && 
-               ((ev->state & RelevantModifierKeyMask) == 0);
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_anchored_mod);
+       trim_anchored_mod = mod;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_anchored_mod);
 }
 
-bool 
-Keyboard::no_modifiers_active (guint state)
+void
+ArdourKeyboard::set_fine_adjust_modifier (guint mod)
 {
-       return (state & RelevantModifierKeyMask) == 0;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~fine_adjust_mod);
+       fine_adjust_mod = mod;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | fine_adjust_mod);
 }
 
-bool
-Keyboard::modifier_state_contains (guint state, ModifierMask mask)
+void
+ArdourKeyboard::set_push_points_modifier (guint mod)
 {
-       return (state & mask) == (guint) mask;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~push_points_mod);
+       push_points_mod = mod;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | push_points_mod);
 }
 
-bool
-Keyboard::modifier_state_equals (guint state, ModifierMask mask)
+void
+ArdourKeyboard::set_note_size_relative_modifier (guint mod)
 {
-       return (state & RelevantModifierKeyMask) == (guint) mask;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~note_size_relative_mod);
+       note_size_relative_mod = mod;
+       RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | note_size_relative_mod);
 }
 
 Selection::Operation
-Keyboard::selection_type (guint state)
+ArdourKeyboard::selection_type (guint state)
 {
        /* note that there is no modifier for "Add" */
 
-       if (modifier_state_equals (state, Shift)) {
+       if (modifier_state_equals (state, RangeSelectModifier)) {
                return Selection::Extend;
-       } else if (modifier_state_equals (state, Control)) {
+       } else if (modifier_state_equals (state, PrimaryModifier)) {
                return Selection::Toggle;
        } else {
                return Selection::Set;