X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Fkeyboard.cc;h=ff336c2f698a31d40eda2c02d503e85966bbfdb1;hb=d3bb4e8b08ac3bc80013bce1a82eeae2ea53eea1;hp=517ef973d4cef5bc4930bb5b6d72b27b18ad3f2a;hpb=14543eb1374dc51834385d2f3886f1e6068223c5;p=ardour.git

diff --git a/gtk2_ardour/keyboard.cc b/gtk2_ardour/keyboard.cc
index 517ef973d4..ff336c2f69 100644
--- a/gtk2_ardour/keyboard.cc
+++ b/gtk2_ardour/keyboard.cc
@@ -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
@@ -15,319 +15,379 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
+#include "pbd/convert.h"
+#include "pbd/error.h"
+#include "pbd/file_utils.h"
+#include "pbd/basename.h"
+
+#include "ardour/filesystem_paths.h"
+
 #include "ardour_ui.h"
+#include "public_editor.h"
+#include "keyboard.h"
+#include "opts.h"
+#include "ui_config.h"
 
-#include <algorithm>
-#include <fstream>
+#include "pbd/i18n.h"
 
-#include <ctype.h>
+using namespace std;
+using namespace Gtk;
+using namespace PBD;
+using namespace ARDOUR;
+using Gtkmm2ext::Keyboard;
 
-#include <gdk/gdkkeysyms.h>
-#include <pbd/error.h>
+#ifdef __APPLE__
+guint ArdourKeyboard::constraint_mod = Keyboard::PrimaryModifier;
+#else
+guint ArdourKeyboard::constraint_mod = Keyboard::TertiaryModifier;
+#endif
 
-#include "keyboard.h"
-#include "gui_thread.h"
+/* TrimDrag::start_grab() */
+guint ArdourKeyboard::trim_contents_mod = Keyboard::PrimaryModifier;
 
-#include "i18n.h"
+/* TrimDrag::motion() */
+guint ArdourKeyboard::trim_overlap_mod = Keyboard::TertiaryModifier;
 
-using namespace PBD;
+/* TrimDrag::start_grab() */
+guint ArdourKeyboard::trim_anchored_mod = Keyboard::PrimaryModifier|Keyboard::TertiaryModifier;
 
-#define KBD_DEBUG 1
-bool debug_keyboard = false;
+/* ControlPointDrag::motion() && LineDrag::motion()*/
+guint ArdourKeyboard::fine_adjust_mod = Keyboard::PrimaryModifier|Keyboard::SecondaryModifier;
 
-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;
+/* ControlPointDrag::start_grab() && MarkerDrag::motion() */
+guint ArdourKeyboard::push_points_mod = Keyboard::PrimaryModifier|Keyboard::Level4Modifier;
 
-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;
+/* NoteResizeDrag::start_grab() */
+guint ArdourKeyboard::note_size_relative_mod = Keyboard::TertiaryModifier;
 
-Keyboard* Keyboard::_the_keyboard = 0;
+ArdourKeyboard::ArdourKeyboard (ARDOUR_UI& ardour_ui) : ui (ardour_ui)
+{
+	Keyboard::RelevantModifierKeysChanged.connect (sigc::mem_fun (*this, &ArdourKeyboard::reset_relevant_modifier_key_mask));
+}
+
+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;
+	}
 
+	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);
+	}
+}
 
-Keyboard::Keyboard ()
+void
+ArdourKeyboard::setup_keybindings ()
 {
-	if (_the_keyboard == 0) {
-		_the_keyboard = this;
+	using namespace ARDOUR_COMMAND_LINE;
+	string default_bindings = string_compose ("%1%2", UIConfiguration::instance().get_default_bindings(), Keyboard::binding_filename_suffix);
+	vector<string> strs;
+
+	binding_files.clear ();
+
+	find_bindings_files (binding_files);
+
+	/* set up the per-user bindings path */
+
+	string lowercase_program_name = downcase (string(PROGRAM_NAME));
+
+	user_keybindings_path = Glib::build_filename (user_config_directory(), lowercase_program_name + binding_filename_suffix);
+
+	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);
 	}
 
-	RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
+	/* check to see if they gave a style name ("ergonomic") or an actual filename (*.bindings)
+	*/
+
+	if (!keybindings_path.empty() && keybindings_path.find (binding_filename_suffix) == string::npos) {
+
+		// just a style name - allow user to
+		// specify the layout type.
+
+		char* layout;
 
-	/* figure out Meta */
+		if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
 
-	uint32_t possible_meta[] = { GDK_MOD2_MASK, GDK_MOD3_MASK, GDK_MOD4_MASK, GDK_MOD5_MASK, 0};
-	int i;
+			/* user-specified keyboard layout */
 
-	for (i = 0; possible_meta[i]; ++i) {
-		if (!(RelevantModifierKeyMask & possible_meta[i])) {
-			break;
+			keybindings_path += '-';
+			keybindings_path += layout;
+
+		} else {
+
+			/* default to US/ANSI - we have to pick something */
+
+			keybindings_path += "-us";
 		}
-	}
-	Meta = possible_meta[i];
 
-	if (Meta) {
-		cerr << "Using " << possible_meta[i] << " for Meta\n";
-	} else {
-		cerr << "NO Meta\n";
+		keybindings_path += binding_filename_suffix;
 	}
 
-	snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
+	if (keybindings_path.empty()) {
 
-	XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
-	set_state (*node);
-}
+		/* no path or binding name given: check the user one first */
 
-Keyboard::~Keyboard ()
-{
-	gtk_key_snooper_remove (snooper_id);
-}
+		if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
 
-XMLNode& 
-Keyboard::get_state (void)
-{
-	XMLNode* node = new XMLNode ("Keyboard");
-	char buf[32];
+			keybindings_path = "";
 
-	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);
+		} else {
 
-	return *node;
-}
+			keybindings_path = user_keybindings_path;
+		}
+	}
 
-int 
-Keyboard::set_state (const XMLNode& node)
-{
-	const XMLProperty* prop;
+	/* if we still don't have a path at this point, use the default */
 
-	if ((prop = node.property ("edit-button")) != 0) {
-		sscanf (prop->value().c_str(), "%d", &edit_but);
-	} 
+	if (keybindings_path.empty()) {
+		keybindings_path = default_bindings;
+	}
 
-	if ((prop = node.property ("edit-modifier")) != 0) {
-		sscanf (prop->value().c_str(), "%d", &edit_mod);
-	} 
+	cerr << "KP is " << keybindings_path << endl;
 
-	if ((prop = node.property ("delete-button")) != 0) {
-		sscanf (prop->value().c_str(), "%d", &delete_but);
-	} 
+	while (true) {
 
-	if ((prop = node.property ("delete-modifier")) != 0) {
-		sscanf (prop->value().c_str(), "%d", &delete_mod);
-	} 
+		if (!Glib::path_is_absolute (keybindings_path)) {
 
-	if ((prop = node.property ("snap-modifier")) != 0) {
-		sscanf (prop->value().c_str(), "%d", &snap_mod);
-	} 
+			/* not absolute - look in the usual places */
+			std::string keybindings_file;
 
-	return 0;
-}
+			if (!find_file (ardour_config_search_path(), keybindings_path, keybindings_file)) {
 
-gint
-Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
-{
-	return ((Keyboard *) data)->snooper (widget, event);
-}
+				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;
+				}
 
-gint
-Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
-{
-	uint32_t keyval;
+			} else {
 
-#if KBD_DEBUG
-	if (debug_keyboard) {
-		cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type 
-		     << endl;
-	}
-#endif
+				/* use it */
 
-	if (event->keyval == GDK_Shift_R) {
-		keyval = GDK_Shift_L;
+				keybindings_path = keybindings_file;
+				break;
 
-	} else 	if (event->keyval == GDK_Control_R) {
-		keyval = GDK_Control_L;
+			}
 
-	} else {
-		keyval = event->keyval;
-	}
-		
-	if (event->type == GDK_KEY_PRESS) {
+		} else {
+
+			/* path is absolute already */
 
-		if (find (state.begin(), state.end(), keyval) == state.end()) {
-			state.push_back (keyval);
-			sort (state.begin(), state.end());
+			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;
+				}
+
+			} else {
+				break;
+			}
 		}
+	}
 
-	} else if (event->type == GDK_KEY_RELEASE) {
+	info << string_compose (_("Loading keybindings from %1"), keybindings_path) << endmsg;
 
-		State::iterator i;
-		
-		if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
-			state.erase (i);
-			sort (state.begin(), state.end());
-		} 
+	load_keybindings (keybindings_path);
 
-	}
+	/* catch changes made via some GTK mechanism */
 
-	return false;
+	// GtkAccelMap* accelmap = gtk_accel_map_get();
+	// g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, this);
 }
 
-bool
-Keyboard::key_is_down (uint32_t keyval)
+XMLNode&
+ArdourKeyboard::get_state (void)
 {
-	return find (state.begin(), state.end(), keyval) != state.end();
-}
+	XMLNode* node = &Keyboard::get_state ();
+	char buf[32];
 
-bool
-Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win)
-{
-	return false;
+	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 ();
+	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 ("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);
 	}
 
-	return false;
+	return Keyboard::set_state (node, version);
 }
 
 void
-Keyboard::set_edit_button (guint but)
+ArdourKeyboard::reset_relevant_modifier_key_mask ()
 {
-	edit_but = but;
+	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | constraint_mod);
+	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_contents_mod);
+	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_overlap_mod);
+	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_anchored_mod);
+	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | fine_adjust_mod);
+	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | push_points_mod);
+	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | note_size_relative_mod);
 }
 
-void
-Keyboard::set_edit_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 & ~edit_mod);
-	edit_mod = mod;
-	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_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_delete_button (guint but)
+bool
+ArdourKeyboard::indicates_snap_delta (guint state)
 {
-	delete_but = but;
+	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_delete_modifier (guint mod)
+/* Constraint and copy modifiers are both in effect at the beginning of some drags, and may be set ambiguously */
+bool
+ArdourKeyboard::indicates_copy (guint state)
 {
-	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
-	delete_mod = mod;
-	RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
+	const bool contains_c = Keyboard::modifier_state_contains (state, Keyboard::CopyModifier);
+	const bool equals_cs = Keyboard::modifier_state_equals (state, constraint_modifier ());
+
+	return  contains_c && !equals_cs;
 }
 
-void
-Keyboard::set_meta_modifier (guint mod)
+bool
+ArdourKeyboard::indicates_constraint (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_cs = Keyboard::modifier_state_contains (state, constraint_modifier ());
+	const bool equals_c = Keyboard::modifier_state_equals (state, Keyboard::CopyModifier);
+
+	return contains_cs && !equals_c;
 }
 
 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);
+	constraint_mod = mod;
+	the_keyboard().reset_relevant_modifier_key_mask();
 }
 
-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());
+	trim_contents_mod = mod;
+	the_keyboard().reset_relevant_modifier_key_mask();
 }
 
-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());
+	trim_overlap_mod = mod;
+	the_keyboard().reset_relevant_modifier_key_mask();
 }
 
-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);
+	trim_anchored_mod = mod;
+	the_keyboard().reset_relevant_modifier_key_mask();
 }
 
-bool 
-Keyboard::no_modifiers_active (guint state)
+void
+ArdourKeyboard::set_fine_adjust_modifier (guint mod)
 {
-	return (state & RelevantModifierKeyMask) == 0;
+	fine_adjust_mod = mod;
+	the_keyboard().reset_relevant_modifier_key_mask();
 }
 
-bool
-Keyboard::modifier_state_contains (guint state, ModifierMask mask)
+void
+ArdourKeyboard::set_push_points_modifier (guint mod)
 {
-	return (state & mask) == (guint) mask;
+	push_points_mod = mod;
+	the_keyboard().reset_relevant_modifier_key_mask();
 }
 
-bool
-Keyboard::modifier_state_equals (guint state, ModifierMask mask)
+void
+ArdourKeyboard::set_note_size_relative_modifier (guint mod)
 {
-	return (state & RelevantModifierKeyMask) == (guint) mask;
+	note_size_relative_mod = mod;
+	the_keyboard().reset_relevant_modifier_key_mask();
 }
 
 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;