X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Fkeyboard.cc;h=501c81ee6ddaa347926f1299c00208ba171c54a5;hb=6b1b72a247bf04c81292fc41af4f69c9b7f90379;hp=83b301d92eac0cb80a8c44c12ae57a3b4c86b932;hpb=bb457bb960c5bd7ed538f9d31477293415739f68;p=ardour.git diff --git a/gtk2_ardour/keyboard.cc b/gtk2_ardour/keyboard.cc index 83b301d92e..501c81ee6d 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 @@ -17,337 +17,346 @@ */ -#include "ardour_ui.h" - -#include -#include - -#include +#include "pbd/convert.h" +#include "pbd/error.h" +#include "pbd/file_utils.h" +#include "pbd/basename.h" -#include -#include +#include "ardour/filesystem_paths.h" +#include "ardour/revision.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; - -#ifdef GTKOSX -guint Keyboard::PrimaryModifier = GDK_MOD1_MASK; // Command -guint Keyboard::SecondaryModifier = GDK_MOD5_MASK; // Alt/Option -guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift -guint Keyboard::CopyModifier = GDK_MOD5_MASK; // Alt/Option -guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK; +#ifdef __APPLE__ +guint ArdourKeyboard::constraint_mod = Keyboard::PrimaryModifier; #else -guint Keyboard::PrimaryModifier = GDK_CONTROL_MASK; // Control -guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option -guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift -guint Keyboard::CopyModifier = GDK_CONTROL_MASK; -guint Keyboard::RangeSelectModifier = GDK_SHIFT_MASK; +guint ArdourKeyboard::constraint_mod = Keyboard::TertiaryModifier; #endif -Keyboard* Keyboard::_the_keyboard = 0; -Gtk::Window* Keyboard::current_window = 0; -bool Keyboard::_some_magic_widget_has_focus = false; +/* TrimDrag::start_grab() */ +guint ArdourKeyboard::trim_contents_mod = Keyboard::PrimaryModifier; -/* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */ +/* TrimDrag::motion() */ +guint ArdourKeyboard::trim_overlap_mod = Keyboard::TertiaryModifier; -GdkModifierType Keyboard::RelevantModifierKeyMask; +/* TrimDrag::start_grab() */ +guint ArdourKeyboard::trim_anchored_mod = Keyboard::PrimaryModifier|Keyboard::TertiaryModifier; -void -Keyboard::magic_widget_grab_focus () +/* ControlPointDrag::motion() && LineDrag::motion()*/ +guint ArdourKeyboard::fine_adjust_mod = Keyboard::PrimaryModifier|Keyboard::SecondaryModifier; // XXX better just 2ndary + +/* ControlPointDrag::start_grab() && MarkerDrag::motion() */ +guint ArdourKeyboard::push_points_mod = Keyboard::PrimaryModifier|Keyboard::Level4Modifier; + +/* NoteResizeDrag::start_grab() */ +guint ArdourKeyboard::note_size_relative_mod = Keyboard::TertiaryModifier; // XXX better: 2ndary + +ArdourKeyboard::ArdourKeyboard (ARDOUR_UI& ardour_ui) : ui (ardour_ui) { - _some_magic_widget_has_focus = true; + Keyboard::RelevantModifierKeysChanged.connect (sigc::mem_fun (*this, &ArdourKeyboard::reset_relevant_modifier_key_mask)); } void -Keyboard::magic_widget_drop_focus () +ArdourKeyboard::find_bindings_files (map& files) { - _some_magic_widget_has_focus = false; -} + vector found; + Searchpath spath = ardour_config_search_path(); -bool -Keyboard::some_magic_widget_has_focus () -{ - return _some_magic_widget_has_focus; + find_files_matching_pattern (found, spath, string_compose ("*%1", Keyboard::binding_filename_suffix)); + + if (found.empty()) { + return; + } + + for (vector::iterator x = found.begin(); x != found.end(); ++x) { + std::string path(*x); + pair 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; - } + string keybindings_path = ARDOUR_COMMAND_LINE::keybindings_path; + string default_bindings = string_compose ("%1%2", UIConfiguration::instance().get_default_bindings(), Keyboard::binding_filename_suffix); + vector strs; - RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask (); + binding_files.clear (); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier); + find_bindings_files (binding_files); - snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this); + /* set up the per-user bindings path */ - XMLNode* node = ARDOUR_UI::instance()->keyboard_settings(); - set_state (*node); -} + string lowercase_program_name = downcase (string(PROGRAM_NAME)); -Keyboard::~Keyboard () -{ - gtk_key_snooper_remove (snooper_id); -} + /* extract and append minor vesion */ + std::string rev (revision); + std::size_t pos = rev.find_first_of("-"); + if (pos != string::npos && pos > 0) { + lowercase_program_name += "-"; + lowercase_program_name += rev.substr (0, pos); + } -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); + user_keybindings_path = Glib::build_filename (user_config_directory(), lowercase_program_name + binding_filename_suffix); - return *node; -} + 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); + } -int -Keyboard::set_state (const XMLNode& node) -{ - const XMLProperty* prop; + /* check to see if they gave a style name ("ergonomic") or an actual filename (*.bindings) + */ - if ((prop = node.property ("edit-button")) != 0) { - sscanf (prop->value().c_str(), "%d", &edit_but); - } + if (!keybindings_path.empty() && keybindings_path.find (binding_filename_suffix) == string::npos) { - if ((prop = node.property ("edit-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &edit_mod); - } + // just a style name - allow user to + // specify the layout type. - if ((prop = node.property ("delete-button")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_but); - } + char* layout; - if ((prop = node.property ("delete-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_mod); - } + if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') { - if ((prop = node.property ("snap-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &snap_mod); - } + /* user-specified keyboard layout */ - return 0; -} + keybindings_path += '-'; + keybindings_path += layout; -gint -Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data) -{ - return ((Keyboard *) data)->snooper (widget, event); -} + } else { -gint -Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) -{ - uint32_t keyval; + /* default to US/ANSI - we have to pick something */ -#if 0 - cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type - << " state " << std::hex << event->state << std::dec - << endl; -#endif + keybindings_path += "-us"; + } -#if KBD_DEBUG - if (debug_keyboard) { - cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type - << endl; + keybindings_path += binding_filename_suffix; } -#endif - if (event->keyval == GDK_Shift_R) { - keyval = GDK_Shift_L; + if (keybindings_path.empty()) { - } else if (event->keyval == GDK_Control_R) { - keyval = GDK_Control_L; + /* no path or binding name given: check the user one first */ - } else { - keyval = event->keyval; - } - - if (event->type == GDK_KEY_PRESS) { + if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) { + + keybindings_path = ""; - if (find (state.begin(), state.end(), keyval) == state.end()) { - state.push_back (keyval); - sort (state.begin(), state.end()); - } + } else { - } else if (event->type == GDK_KEY_RELEASE) { + keybindings_path = user_keybindings_path; + } + } - State::iterator i; - - if ((i = find (state.begin(), state.end(), keyval)) != state.end()) { - state.erase (i); - sort (state.begin(), state.end()); - } + /* if we still don't have a path at this point, use the default */ + if (keybindings_path.empty()) { + keybindings_path = default_bindings; } - if (event->type == GDK_KEY_RELEASE && event->keyval == GDK_w && modifier_state_equals (event->state, PrimaryModifier)) { - if (current_window) { - current_window->hide (); - current_window = 0; + while (true) { + + 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; + } + + } else { + break; + } } } - return false; -} + load_keybindings (keybindings_path); -bool -Keyboard::key_is_down (uint32_t keyval) -{ - return find (state.begin(), state.end(), keyval) != state.end(); -} + /* catch changes made via some GTK mechanism */ -bool -Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win) -{ - current_window = win; - return false; + // GtkAccelMap* accelmap = gtk_accel_map_get(); + // g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, this); } -bool -Keyboard::leave_window (GdkEventCrossing *ev, Gtk::Window* win) +XMLNode& +ArdourKeyboard::get_state (void) { - switch (ev->detail) { - case GDK_NOTIFY_INFERIOR: - if (debug_keyboard) { - cerr << "INFERIOR crossing ... out\n"; - } - break; + XMLNode* node = &Keyboard::get_state (); - case GDK_NOTIFY_VIRTUAL: - if (debug_keyboard) { - cerr << "VIRTUAL crossing ... out\n"; - } - /* fallthru */ + node->set_property ("constraint-modifier", constraint_mod); + node->set_property ("trim-contents-modifier", trim_contents_mod); + node->set_property ("trim-overlap-modifier", trim_overlap_mod); + node->set_property ("trim-anchored-modifier", trim_anchored_mod); + node->set_property ("fine-adjust-modifier", fine_adjust_mod); + node->set_property ("push-points-modifier", push_points_mod); + node->set_property ("note-size-relative-modifier", note_size_relative_mod); - default: - if (debug_keyboard) { - cerr << "REAL CROSSING ... out\n"; - cerr << "clearing current target\n"; - } - state.clear (); - current_window = 0; - } + return *node; +} - return false; +int +ArdourKeyboard::set_state (const XMLNode& node, int version) +{ + node.get_property ("constraint-modifier", constraint_mod); + node.get_property ("trim-contents-modifier", trim_contents_mod); + node.get_property ("trim-overlap-modifier", trim_overlap_mod); + node.get_property ("trim-anchored-modifier", trim_anchored_mod); + node.get_property ("fine-adjust-modifier", fine_adjust_mod); + node.get_property ("push-points-modifier", push_points_mod); + node.get_property ("note-size-relative-modifier", note_size_relative_mod); + + 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_modifier (uint32_t newval, uint32_t& var) +bool +ArdourKeyboard::indicates_constraint (guint state) { - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var); - var = newval; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var); + 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" */