/*
- 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
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
-#include "ardour_ui.h"
-
-#include <algorithm>
-#include <fstream>
-
-#include <ctype.h>
+#include "pbd/error.h"
+#include "pbd/file_utils.h"
-#include <gdk/gdkkeysyms.h>
-#include <pbd/error.h>
+#include "ardour/filesystem_paths.h"
+#include "ardour_ui.h"
#include "keyboard.h"
-#include "gui_thread.h"
+#include "opts.h"
#include "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;
-
-Keyboard* Keyboard::_the_keyboard = 0;
-
-/* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */
-
-GdkModifierType Keyboard::RelevantModifierKeyMask;
-
-
-Keyboard::Keyboard ()
+static void
+accel_map_changed (GtkAccelMap* /*map*/,
+ gchar* /*path*/,
+ guint /*key*/,
+ GdkModifierType /*mod*/,
+ gpointer keyboard)
{
- if (_the_keyboard == 0) {
- _the_keyboard = this;
- }
+ ArdourKeyboard* me = (ArdourKeyboard*)keyboard;
+ Keyboard::keybindings_changed ();
+ me->ui.setup_tooltips ();
+}
- RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask ();
+void
+ArdourKeyboard::setup_keybindings ()
+{
+ using namespace ARDOUR_COMMAND_LINE;
+ string default_bindings = "mnemonic-us.bindings";
+ vector<string> strs;
- /* figure out Meta */
+ binding_files.clear ();
- uint32_t possible_meta[] = { GDK_MOD2_MASK, GDK_MOD3_MASK, GDK_MOD4_MASK, GDK_MOD5_MASK, 0};
- int i;
+ ARDOUR::find_bindings_files (binding_files);
- for (i = 0; possible_meta[i]; ++i) {
- if (!(RelevantModifierKeyMask & possible_meta[i])) {
- break;
- }
- }
- Meta = possible_meta[i];
+ /* set up the per-user bindings path */
- snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this);
+ sys::path p (user_config_directory ());
+ p /= "ardour.bindings";
- XMLNode* node = ARDOUR_UI::instance()->keyboard_settings();
- set_state (*node);
-}
+ user_keybindings_path = p.to_string ();
-Keyboard::~Keyboard ()
-{
- gtk_key_snooper_remove (snooper_id);
-}
+ 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);
+ }
-XMLNode&
-Keyboard::get_state (void)
-{
- XMLNode* node = new XMLNode ("Keyboard");
- char buf[32];
-
- 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);
-
- return *node;
-}
+ /* check to see if they gave a style name ("SAE", "ergonomic") or
+ an actual filename (*.bindings)
+ */
-int
-Keyboard::set_state (const XMLNode& node)
-{
- const XMLProperty* prop;
+ if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) {
- if ((prop = node.property ("edit-button")) != 0) {
- sscanf (prop->value().c_str(), "%d", &edit_but);
- }
+ // just a style name - allow user to
+ // specify the layout type.
- if ((prop = node.property ("edit-modifier")) != 0) {
- sscanf (prop->value().c_str(), "%d", &edit_mod);
- }
+ char* layout;
- if ((prop = node.property ("delete-button")) != 0) {
- sscanf (prop->value().c_str(), "%d", &delete_but);
- }
+ if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
- if ((prop = node.property ("delete-modifier")) != 0) {
- sscanf (prop->value().c_str(), "%d", &delete_mod);
- }
+ /* user-specified keyboard layout */
- if ((prop = node.property ("snap-modifier")) != 0) {
- sscanf (prop->value().c_str(), "%d", &snap_mod);
- }
+ keybindings_path += '-';
+ keybindings_path += layout;
- return 0;
-}
+ } else {
-gint
-Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data)
-{
- return ((Keyboard *) data)->snooper (widget, event);
-}
+ /* default to US/ANSI - we have to pick something */
-gint
-Keyboard::snooper (GtkWidget *widget, GdkEventKey *event)
-{
- uint32_t keyval;
+ keybindings_path += "-us";
+ }
-#if KBD_DEBUG
- if (debug_keyboard) {
- cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type
- << endl;
+ keybindings_path += ".bindings";
}
-#endif
-
- if (event->keyval == GDK_Shift_R) {
- keyval = GDK_Shift_L;
- } else if (event->keyval == GDK_Control_R) {
- keyval = GDK_Control_L;
+ if (keybindings_path.empty()) {
- } else {
- keyval = event->keyval;
- }
-
- if (event->type == GDK_KEY_PRESS) {
+ /* no path or binding name given: check the user one first */
- if (find (state.begin(), state.end(), keyval) == state.end()) {
- state.push_back (keyval);
- sort (state.begin(), state.end());
- }
+ if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
- } else if (event->type == GDK_KEY_RELEASE) {
+ keybindings_path = "";
- State::iterator i;
-
- if ((i = find (state.begin(), state.end(), keyval)) != state.end()) {
- state.erase (i);
- sort (state.begin(), state.end());
- }
+ } else {
+ keybindings_path = user_keybindings_path;
+ }
}
- return false;
-}
-
-bool
-Keyboard::key_is_down (uint32_t keyval)
-{
- return find (state.begin(), state.end(), keyval) != state.end();
-}
+ /* if we still don't have a path at this point, use the default */
-bool
-Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win)
-{
- return false;
-}
+ if (keybindings_path.empty()) {
+ keybindings_path = default_bindings;
+ }
-bool
-Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win)
-{
- switch (ev->detail) {
- case GDK_NOTIFY_INFERIOR:
- if (debug_keyboard) {
- cerr << "INFERIOR crossing ... out\n";
- }
- break;
+ while (true) {
- case GDK_NOTIFY_VIRTUAL:
- if (debug_keyboard) {
- cerr << "VIRTUAL crossing ... out\n";
- }
- /* fallthru */
+ if (!Glib::path_is_absolute (keybindings_path)) {
- default:
- if (debug_keyboard) {
- cerr << "REAL CROSSING ... out\n";
- cerr << "clearing current target\n";
- }
- state.clear ();
- }
+ /* not absolute - look in the usual places */
+ sys::path keybindings_file;
- return false;
-}
+ SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
-void
-Keyboard::set_edit_button (guint but)
-{
- edit_but = but;
-}
+ if ( ! find_file_in_search_path (spath, keybindings_path, keybindings_file)) {
-void
-Keyboard::set_edit_modifier (guint mod)
-{
- RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod);
- edit_mod = mod;
- RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod);
-}
+ 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;
+ }
-void
-Keyboard::set_delete_button (guint but)
-{
- delete_but = but;
-}
+ } else {
-void
-Keyboard::set_delete_modifier (guint mod)
-{
- RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod);
- delete_mod = mod;
- RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod);
-}
+ /* use it */
-void
-Keyboard::set_meta_modifier (guint mod)
-{
- /* 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;
-}
+ keybindings_path = keybindings_file.to_string();
+ break;
-void
-Keyboard::set_snap_modifier (guint mod)
-{
- RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~snap_mod);
- snap_mod = mod;
- RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | snap_mod);
-}
+ }
-bool
-Keyboard::is_edit_event (GdkEventButton *ev)
-{
+ } else {
- return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
- (ev->button == Keyboard::edit_button()) &&
- ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier());
-}
+ /* path is absolute already */
-bool
-Keyboard::is_delete_event (GdkEventButton *ev)
-{
- return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
- (ev->button == Keyboard::delete_button()) &&
- ((ev->state & RelevantModifierKeyMask) == Keyboard::delete_modifier());
-}
+ 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 {
+ warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
+ keybindings_path)
+ << endmsg;
+ keybindings_path = default_bindings;
+ }
-bool
-Keyboard::is_context_menu_event (GdkEventButton *ev)
-{
- return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) &&
- (ev->button == 3) &&
- ((ev->state & RelevantModifierKeyMask) == 0);
-}
+ } else {
+ break;
+ }
+ }
+ }
-bool
-Keyboard::no_modifiers_active (guint state)
-{
- return (state & RelevantModifierKeyMask) == 0;
-}
+ load_keybindings (keybindings_path);
-bool
-Keyboard::modifier_state_contains (guint state, ModifierMask mask)
-{
- return (state & mask) == (guint) mask;
-}
+ /* catch changes */
-bool
-Keyboard::modifier_state_equals (guint state, ModifierMask mask)
-{
- return (state & RelevantModifierKeyMask) == (guint) mask;
+ GtkAccelMap* accelmap = gtk_accel_map_get();
+ g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, this);
}
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;
}
}
+
+