X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Fkeyboard.cc;h=98ffab1160bb563fa2a2f5abf868062f6d10e281;hb=3008fbdea5098fac2649fc7c69efc2cb8f0769ee;hp=17390b8b4db79020fb24d82c5e855a55eaa95d4d;hpb=7ff370e79895d7eb293e7214689b791bd98415fb;p=ardour.git diff --git a/gtk2_ardour/keyboard.cc b/gtk2_ardour/keyboard.cc index 17390b8b4d..98ffab1160 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,792 +15,176 @@ 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 -#include +#include "pbd/error.h" +#include "pbd/file_utils.h" -#include - -#include -#include -#include -#include +#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 = GDK_MOD2_MASK; - -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 = - GdkModifierType (GDK_SHIFT_MASK|GDK_CONTROL_MASK|GDK_MOD1_MASK|GDK_MOD3_MASK); - - -Keyboard::Keyboard () +static void +accel_map_changed (GtkAccelMap* /*map*/, + gchar* /*path*/, + guint /*key*/, + GdkModifierType /*mod*/, + gpointer keyboard) { - if (_the_keyboard == 0) { - _the_keyboard = this; - } - - collecting_prefix = false; - - get_modifier_masks (); - - snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this); - - XMLNode* node = ARDOUR_UI::instance()->keyboard_settings(); - set_state (*node); + ArdourKeyboard* me = (ArdourKeyboard*)keyboard; + Keyboard::keybindings_changed (); + me->ui.setup_tooltips (); } -Keyboard::~Keyboard () +void +ArdourKeyboard::setup_keybindings () { - gtk_key_snooper_remove (snooper_id); - delete [] modifier_masks; -} + using namespace ARDOUR_COMMAND_LINE; + string default_bindings = "mnemonic-us.bindings"; + vector strs; -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; -} + binding_files.clear (); -int -Keyboard::set_state (const XMLNode& node) -{ - const XMLProperty* prop; + ARDOUR::find_bindings_files (binding_files); - if ((prop = node.property ("edit-button")) != 0) { - sscanf (prop->value().c_str(), "%d", &edit_but); - } + /* set up the per-user bindings path */ - if ((prop = node.property ("edit-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &edit_mod); - } + user_keybindings_path = Glib::build_filename (user_config_directory(), "ardour.bindings"); - if ((prop = node.property ("delete-button")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_but); - } + if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) { + std::pair newpair; + newpair.first = _("your own"); + newpair.second = user_keybindings_path; + binding_files.insert (newpair); + } - if ((prop = node.property ("delete-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_mod); - } + /* check to see if they gave a style name ("SAE", "ergonomic") or + an actual filename (*.bindings) + */ - if ((prop = node.property ("snap-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &snap_mod); - } + if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) { - return 0; -} + // just a style name - allow user to + // specify the layout type. -gint -Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data) -{ - return ((Keyboard *) data)->snooper (widget, event); -} + char* layout; -gint -Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) -{ - uint32_t keyval; + if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') { -#if KBD_DEBUG - if (debug_keyboard) { - cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type - << endl; - } -#endif + /* user-specified keyboard layout */ - if (event->keyval == GDK_Shift_R) { - keyval = GDK_Shift_L; + keybindings_path += '-'; + keybindings_path += layout; - } else if (event->keyval == GDK_Control_R) { - keyval = GDK_Control_L; + } else { - } else { - keyval = event->keyval; - } - - if (event->type == GDK_KEY_PRESS) { - bool was_prefix = false; - - if (collecting_prefix) { - switch (keyval) { - case GDK_0: - current_prefix += '0'; - was_prefix = true; - break; - case GDK_1: - current_prefix += '1'; - was_prefix = true; - break; - case GDK_2: - current_prefix += '2'; - was_prefix = true; - break; - case GDK_3: - current_prefix += '3'; - was_prefix = true; - break; - case GDK_4: - current_prefix += '4'; - was_prefix = true; - break; - case GDK_5: - current_prefix += '5'; - was_prefix = true; - break; - case GDK_6: - current_prefix += '6'; - was_prefix = true; - break; - case GDK_7: - current_prefix += '7'; - was_prefix = true; - break; - case GDK_8: - current_prefix += '8'; - was_prefix = true; - break; - case GDK_9: - current_prefix += '9'; - was_prefix = true; - break; - case GDK_period: - current_prefix += '.'; - was_prefix = true; - break; - default: - was_prefix = false; - collecting_prefix = false; - break; - } - } + /* default to US/ANSI - we have to pick something */ - if (find (state.begin(), state.end(), keyval) == state.end()) { - state.push_back (keyval); - sort (state.begin(), state.end()); + keybindings_path += "-us"; } - } else if (event->type == GDK_KEY_RELEASE) { - - State::iterator i; - - if ((i = find (state.begin(), state.end(), keyval)) != state.end()) { - state.erase (i); - sort (state.begin(), state.end()); - } - + keybindings_path += ".bindings"; } - return false; -} + if (keybindings_path.empty()) { -bool -Keyboard::key_is_down (uint32_t keyval) -{ - return find (state.begin(), state.end(), keyval) != state.end(); -} + /* no path or binding name given: check the user one first */ -Keyboard::State -Keyboard::translate_key_name (const string& name) + if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) { -{ - string::size_type i; - string::size_type len; - bool at_end; - string::size_type hyphen; - string keyname; - string whatevers_left; - State result; - guint keycode; - - i = 0; - len = name.length(); - at_end = (len == 0); - - while (!at_end) { - - whatevers_left = name.substr (i); - - if ((hyphen = whatevers_left.find_first_of ('-')) == string::npos) { - - /* no hyphen, so use the whole thing */ - - keyname = whatevers_left; - at_end = true; + keybindings_path = ""; } else { - /* There is a hyphen. */ - - if (hyphen == 0 && whatevers_left.length() == 1) { - /* its the first and only character */ - - keyname = "-"; - at_end = true; - - } else { - - /* use the text before the hypen */ - - keyname = whatevers_left.substr (0, hyphen); - - if (hyphen == len - 1) { - at_end = true; - } else { - i += hyphen + 1; - at_end = (i >= len); - } - } - } - - if (keyname.length() == 1 && isupper (keyname[0])) { - result.push_back (GDK_Shift_L); - } - - if ((keycode = gdk_keyval_from_name(get_real_keyname (keyname).c_str())) == GDK_VoidSymbol) { - error << string_compose(_("KeyboardTarget: keyname \"%1\" is unknown."), keyname) << endmsg; - result.clear(); - return result; + keybindings_path = user_keybindings_path; } - - result.push_back (keycode); } - sort (result.begin(), result.end()); - - return result; -} - -string -Keyboard::get_real_keyname (const string& name) -{ + /* if we still don't have a path at this point, use the default */ - if (name == "Control" || name == "Ctrl") { - return "Control_L"; - } - if (name == "Meta" || name == "MetaL") { - return "Meta_L"; - } - if (name == "MetaR") { - return "Meta_R"; - } - if (name == "Alt" || name == "AltL") { - return "Alt_L"; - } - if (name == "AltR") { - return "Alt_R"; - } - if (name == "Shift") { - return "Shift_L"; - } - if (name == "Shift_R") { - return "Shift_L"; - } - if (name == " ") { - return "space"; - } - if (name == "!") { - return "exclam"; - } - if (name == "\"") { - return "quotedbl"; - } - if (name == "#") { - return "numbersign"; - } - if (name == "$") { - return "dollar"; - } - if (name == "%") { - return "percent"; - } - if (name == "&") { - return "ampersand"; - } - if (name == "'") { - return "apostrophe"; - } - if (name == "'") { - return "quoteright"; - } - if (name == "(") { - return "parenleft"; - } - if (name == ")") { - return "parenright"; - } - if (name == "*") { - return "asterisk"; - } - if (name == "+") { - return "plus"; - } - if (name == ",") { - return "comma"; - } - if (name == "-") { - return "minus"; - } - if (name == ".") { - return "period"; - } - if (name == "/") { - return "slash"; - } - if (name == ":") { - return "colon"; - } - if (name == ";") { - return "semicolon"; - } - if (name == "<") { - return "less"; - } - if (name == "=") { - return "equal"; - } - if (name == ">") { - return "greater"; - } - if (name == "?") { - return "question"; - } - if (name == "@") { - return "at"; - } - if (name == "[") { - return "bracketleft"; - } - if (name == "\\") { - return "backslash"; - } - if (name == "]") { - return "bracketright"; - } - if (name == "^") { - return "asciicircum"; - } - if (name == "_") { - return "underscore"; - } - if (name == "`") { - return "grave"; - } - if (name == "`") { - return "quoteleft"; - } - if (name == "{") { - return "braceleft"; - } - if (name == "|") { - return "bar"; - } - if (name == "}") { - return "braceright"; - } - if (name == "~") { - return "asciitilde"; + if (keybindings_path.empty()) { + keybindings_path = default_bindings; } - return name; -} + while (true) { -int -Keyboard::get_prefix (float& val, bool& was_floating) -{ - if (current_prefix.length()) { - if (current_prefix.find ('.') != string::npos) { - was_floating = true; - } else { - was_floating = false; - } - if (sscanf (current_prefix.c_str(), "%f", &val) == 1) { - return 0; - } - current_prefix = ""; - } - return -1; -} - -void -Keyboard::start_prefix () -{ - collecting_prefix = true; - current_prefix = ""; -} + if (!Glib::path_is_absolute (keybindings_path)) { -void -Keyboard::clear_modifier_state () -{ - modifier_mask = 0; -} + /* not absolute - look in the usual places */ + std::string keybindings_file; -void -Keyboard::check_modifier_state () -{ - char keys[32]; - int i, j; + if ( ! find_file_in_search_path (ardour_config_search_path(), keybindings_path, keybindings_file)) { - clear_modifier_state (); - XQueryKeymap (GDK_DISPLAY(), keys); + 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; + } - for (i = 0; i < 32; ++i) { - for (j = 0; j < 8; ++j) { + } else { - if (keys[i] & (1<modifiermap; - - for (i = 0; i < modifiers->max_keypermod; ++i) { /* shift */ - if (*keycode) { - modifier_masks[*keycode] = GDK_SHIFT_MASK; - // cerr << "Shift = " << XKeysymToString (XKeycodeToKeysym (GDK_DISPLAY(), *keycode, 0)) << endl; - } - keycode++; - } - - for (i = 0; i < modifiers->max_keypermod; ++i) keycode++; /* skip lock */ - - for (i = 0; i < modifiers->max_keypermod; ++i) { /* control */ - if (*keycode) { - modifier_masks[*keycode] = GDK_CONTROL_MASK; - // cerr << "Control = " << XKeysymToString (XKeycodeToKeysym (GDK_DISPLAY(), *keycode, 0)) << endl; - } - keycode++; - } - - bound = 0; - for (i = 0; i < modifiers->max_keypermod; ++i) { /* mod 1 */ - if (*keycode) { - modifier_masks[*keycode] = GDK_MOD1_MASK; - // cerr << "Mod1 = " << XKeysymToString (XKeycodeToKeysym (GDK_DISPLAY(), *keycode, 0)) << endl; - bound++; - } - keycode++; - } -#ifdef WARN_ABOUT_DUPLICATE_MODIFIERS - if (bound > 1) { - warning << string_compose (_("You have %1 keys bound to \"mod1\""), bound) << endmsg; - } -#endif - bound = 0; - for (i = 0; i < modifiers->max_keypermod; ++i) { /* mod2 */ - if (*keycode) { - modifier_masks[*keycode] = GDK_MOD2_MASK; - check_meta_numlock (*keycode, GDK_MOD2_MASK, "Mod2"); - //cerr << "Mod2 = " << std::hex << (int) *keycode << std::dec << " = " << XKeysymToString (XKeycodeToKeysym (GDK_DISPLAY(), *keycode, 0)) << endl; - bound++; - } - keycode++; - } -#ifdef WARN_ABOUT_DUPLICATE_MODIFIERS - if (bound > 1) { - warning << string_compose (_("You have %1 keys bound to \"mod2\""), bound) << endmsg; - } -#endif - bound = 0; - for (i = 0; i < modifiers->max_keypermod; ++i) { /* mod3 */ - if (*keycode) { - modifier_masks[*keycode] = GDK_MOD3_MASK; - check_meta_numlock (*keycode, GDK_MOD3_MASK, "Mod3"); - // cerr << "Mod3 = " << XKeysymToString (XKeycodeToKeysym (GDK_DISPLAY(), *keycode, 0)) << endl; - bound++; - } - keycode++; - } -#ifdef WARN_ABOUT_DUPLICATE_MODIFIERS - if (bound > 1) { - warning << string_compose (_("You have %1 keys bound to \"mod3\""), bound) << endmsg; - } -#endif - bound = 0; - for (i = 0; i < modifiers->max_keypermod; ++i) { /* mod 4 */ - if (*keycode) { - modifier_masks[*keycode] = GDK_MOD4_MASK; - check_meta_numlock (*keycode, GDK_MOD4_MASK, "Mod4"); - // cerr << "Mod4 = " << XKeysymToString (XKeycodeToKeysym (GDK_DISPLAY(), *keycode, 0)) << endl; - bound++; - } - keycode++; - } -#ifdef WARN_ABOUT_DUPLICATE_MODIFIERS - if (bound > 1) { - warning << string_compose (_("You have %1 keys bound to \"mod4\""), bound) << endmsg; - } -#endif - bound = 0; - for (i = 0; i < modifiers->max_keypermod; ++i) { /* mod 5 */ - if (*keycode) { - modifier_masks[*keycode] = GDK_MOD5_MASK; - check_meta_numlock (*keycode, GDK_MOD5_MASK, "Mod5"); - // cerr << "Mod5 = " << XKeysymToString (XKeycodeToKeysym (GDK_DISPLAY(), *keycode, 0)) << endl; - bound++; - } - keycode++; - } -#ifdef WARN_ABOUT_DUPLICATE_MODIFIERS - if (bound > 1) { - warning << string_compose (_("You have %1 keys bound to \"mod5\""), bound) << endmsg; - } -#endif - - XFreeModifiermap (modifiers); -} - -bool -Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win) -{ - switch (ev->detail) { - case GDK_NOTIFY_INFERIOR: - break; - - case GDK_NOTIFY_VIRTUAL: - /* fallthru */ - - default: - check_modifier_state (); - } + } - return FALSE; -} + } else { -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; + /* path is absolute already */ - case GDK_NOTIFY_VIRTUAL: - if (debug_keyboard) { - cerr << "VIRTUAL crossing ... out\n"; - } - /* fallthru */ + 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; + } - default: - if (debug_keyboard) { - cerr << "REAL CROSSING ... out\n"; - cerr << "clearing current target\n"; + } else { + break; + } } - state.clear (); - clear_modifier_state (); } - return FALSE; - -} - -void -Keyboard::set_edit_button (guint but) -{ - edit_but = but; -} -void -Keyboard::set_edit_modifier (guint mod) -{ - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~edit_mod); - edit_mod = mod; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | edit_mod); -} + load_keybindings (keybindings_path); -void -Keyboard::set_delete_button (guint but) -{ - delete_but = but; -} + /* catch changes */ -void -Keyboard::set_delete_modifier (guint mod) -{ - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod); - delete_mod = mod; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod); -} - -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; -} - -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) -{ - return (ev->type == GDK_BUTTON_PRESS || ev->type == GDK_BUTTON_RELEASE) && - (ev->button == Keyboard::edit_button()) && - ((ev->state & RelevantModifierKeyMask) == Keyboard::edit_modifier()); -} - -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()); -} - -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); -} - -bool -Keyboard::no_modifiers_active (guint state) -{ - return (state & RelevantModifierKeyMask) == 0; -} - -bool -Keyboard::modifier_state_contains (guint state, ModifierMask mask) -{ - return (state & mask) == (guint) mask; -} - -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) { - if (modifier_state_equals (state, Shift)) { + /* note that there is no modifier for "Add" */ + + 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; } } + +