X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=gtk2_ardour%2Fkeyboard.cc;h=6341071451f94d3b5e99b72169e8405652ff53e2;hb=cf52d6e4b40111eb04b244ec054055a4ec15dbe0;hp=b7706556ed2366c12a222d6e01c81516b8217bde;hpb=4d94305cc904cc2cce33d62050f351fe80f0d517;p=ardour.git diff --git a/gtk2_ardour/keyboard.cc b/gtk2_ardour/keyboard.cc index b7706556ed..6341071451 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,407 +17,76 @@ */ -#include +#include "pbd/convert.h" +#include "pbd/error.h" +#include "pbd/file_utils.h" +#include "pbd/basename.h" -#include "ardour_ui.h" - -#include -#include -#include - -#include - -#include - -#include -#include -#include - -#include +#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; - -#ifdef GTKOSX -guint Keyboard::PrimaryModifier = GDK_META_MASK; // Command -guint Keyboard::SecondaryModifier = GDK_MOD1_MASK; // Alt/Option -guint Keyboard::TertiaryModifier = GDK_SHIFT_MASK; // Shift -guint Keyboard::CopyModifier = GDK_MOD1_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::SecondaryModifier; #endif - -Keyboard* Keyboard::_the_keyboard = 0; -Gtk::Window* Keyboard::current_window = 0; -bool Keyboard::_some_magic_widget_has_focus = false; - -std::string Keyboard::user_keybindings_path; -bool Keyboard::can_save_keybindings = false; -map Keyboard::binding_files; -std::string Keyboard::_current_binding_name = _("Unknown"); - -/* set this to initially contain the modifiers we care about, then track changes in ::set_edit_modifier() etc. */ - -GdkModifierType Keyboard::RelevantModifierKeyMask; - -void -Keyboard::magic_widget_grab_focus () -{ - _some_magic_widget_has_focus = true; -} +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; void -Keyboard::magic_widget_drop_focus () -{ - _some_magic_widget_has_focus = false; -} - -bool -Keyboard::some_magic_widget_has_focus () -{ - return _some_magic_widget_has_focus; -} - -Keyboard::Keyboard () -{ - if (_the_keyboard == 0) { - _the_keyboard = this; - } - - RelevantModifierKeyMask = (GdkModifierType) gtk_accelerator_get_default_mod_mask (); - - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | PrimaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | SecondaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | TertiaryModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | CopyModifier); - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | RangeSelectModifier); - - snooper_id = gtk_key_snooper_install (_snooper, (gpointer) this); - - XMLNode* node = ARDOUR_UI::instance()->keyboard_settings(); - set_state (*node); -} - -Keyboard::~Keyboard () -{ - gtk_key_snooper_remove (snooper_id); -} - -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; -} - -int -Keyboard::set_state (const XMLNode& node) +ArdourKeyboard::find_bindings_files (map& files) { - const XMLProperty* prop; - - if ((prop = node.property ("edit-button")) != 0) { - sscanf (prop->value().c_str(), "%d", &edit_but); - } - - if ((prop = node.property ("edit-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &edit_mod); - } - - if ((prop = node.property ("delete-button")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_but); - } + vector found; + Searchpath spath = ardour_config_search_path(); - if ((prop = node.property ("delete-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &delete_mod); - } + find_files_matching_pattern (found, spath, string_compose ("*%1", Keyboard::binding_filename_suffix)); - if ((prop = node.property ("snap-modifier")) != 0) { - sscanf (prop->value().c_str(), "%d", &snap_mod); - } - - return 0; -} - -gint -Keyboard::_snooper (GtkWidget *widget, GdkEventKey *event, gpointer data) -{ - return ((Keyboard *) data)->snooper (widget, event); -} - -gint -Keyboard::snooper (GtkWidget *widget, GdkEventKey *event) -{ - uint32_t keyval; - -#if 0 - cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type - << " state " << std::hex << event->state << std::dec - << endl; -#endif - -#if KBD_DEBUG - if (debug_keyboard) { - cerr << "snoop widget " << widget << " key " << event->keyval << " type: " << event->type - << endl; + if (found.empty()) { + return; } -#endif - - if (event->keyval == GDK_Shift_R) { - keyval = GDK_Shift_L; - - } else if (event->keyval == GDK_Control_R) { - keyval = GDK_Control_L; - - } else { - keyval = event->keyval; - } - - if (event->type == GDK_KEY_PRESS) { - - if (find (state.begin(), state.end(), keyval) == state.end()) { - state.push_back (keyval); - sort (state.begin(), state.end()); - } - - } 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()); - } + 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); } - - 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; - } - } - - return false; -} - -bool -Keyboard::key_is_down (uint32_t keyval) -{ - return find (state.begin(), state.end(), keyval) != state.end(); -} - -bool -Keyboard::enter_window (GdkEventCrossing *ev, Gtk::Window* win) -{ - current_window = win; - return false; -} - -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; - - case GDK_NOTIFY_VIRTUAL: - if (debug_keyboard) { - cerr << "VIRTUAL crossing ... out\n"; - } - /* fallthru */ - - default: - if (debug_keyboard) { - cerr << "REAL CROSSING ... out\n"; - cerr << "clearing current target\n"; - } - state.clear (); - current_window = 0; - } - - 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); } void -Keyboard::set_delete_button (guint but) -{ - delete_but = but; -} - -void -Keyboard::set_delete_modifier (guint mod) -{ - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~delete_mod); - delete_mod = mod; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | delete_mod); -} - -void -Keyboard::set_modifier (uint32_t newval, uint32_t& var) -{ - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~var); - var = newval; - RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | var); -} - -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; -} - -Selection::Operation -Keyboard::selection_type (guint state) -{ - /* note that there is no modifier for "Add" */ - - if (modifier_state_equals (state, RangeSelectModifier)) { - return Selection::Extend; - } else if (modifier_state_equals (state, PrimaryModifier)) { - return Selection::Toggle; - } else { - return Selection::Set; - } -} - - -static void -accel_map_changed (GtkAccelMap* map, - gchar* path, - guint key, - GdkModifierType mod, - gpointer arg) -{ - Keyboard::save_keybindings (); -} - -void -Keyboard::set_can_save_keybindings (bool yn) -{ - can_save_keybindings = yn; -} - -void -Keyboard::save_keybindings () -{ - if (can_save_keybindings) { - Gtk::AccelMap::save (user_keybindings_path); - } -} - -void -Keyboard::setup_keybindings () +ArdourKeyboard::setup_keybindings () { using namespace ARDOUR_COMMAND_LINE; - std::string default_bindings = "mnemonic-us.bindings"; + string default_bindings = string_compose ("%1%2", UIConfiguration::instance().get_default_bindings(), Keyboard::binding_filename_suffix); vector strs; binding_files.clear (); - ARDOUR::find_bindings_files (binding_files); + find_bindings_files (binding_files); /* set up the per-user bindings path */ - - strs.push_back (Glib::get_home_dir()); - strs.push_back (".ardour3"); - strs.push_back ("ardour.bindings"); - user_keybindings_path = Glib::build_filename (strs); + 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 newpair; @@ -426,21 +95,20 @@ Keyboard::setup_keybindings () binding_files.insert (newpair); } - /* check to see if they gave a style name ("SAE", "ergonomic") or - an actual filename (*.bindings) + /* check to see if they gave a style name ("ergonomic") or an actual filename (*.bindings) */ - if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) { - + if (!keybindings_path.empty() && keybindings_path.find (binding_filename_suffix) == string::npos) { + // just a style name - allow user to - // specify the layout type. - + // specify the layout type. + char* layout; - + if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') { - + /* user-specified keyboard layout */ - + keybindings_path += '-'; keybindings_path += layout; @@ -450,23 +118,23 @@ Keyboard::setup_keybindings () keybindings_path += "-us"; } - - keybindings_path += ".bindings"; - } + + keybindings_path += binding_filename_suffix; + } if (keybindings_path.empty()) { /* no path or binding name given: check the user one first */ if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) { - + keybindings_path = ""; } else { - + keybindings_path = user_keybindings_path; } - } + } /* if we still don't have a path at this point, use the default */ @@ -474,22 +142,22 @@ Keyboard::setup_keybindings () keybindings_path = default_bindings; } + cerr << "KP is " << keybindings_path << endl; + while (true) { if (!Glib::path_is_absolute (keybindings_path)) { - + /* not absolute - look in the usual places */ - sys::path keybindings_file; + std::string keybindings_file; - SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path(); + if (!find_file (ardour_config_search_path(), keybindings_path, keybindings_file)) { - if ( ! find_file_in_search_path (spath, keybindings_path, keybindings_file)) { - if (keybindings_path == default_bindings) { - error << _("Default keybindings not found - Ardour will be hard to use!") << endmsg; + 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"), + warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"), keybindings_path) << endmsg; keybindings_path = default_bindings; @@ -499,23 +167,20 @@ Keyboard::setup_keybindings () /* use it */ - keybindings_path = keybindings_file.to_string(); + 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 << _("Default keybindings not found - Ardour will be hard to use!") << endmsg; + 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; } @@ -525,38 +190,165 @@ Keyboard::setup_keybindings () } } + info << string_compose (_("Loading keybindings from %1"), keybindings_path) << endmsg; + load_keybindings (keybindings_path); - /* catch changes */ + /* catch changes made via some GTK mechanism */ - GtkAccelMap* accelmap = gtk_accel_map_get(); - g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, 0); + // GtkAccelMap* accelmap = gtk_accel_map_get(); + // g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, this); } -bool -Keyboard::load_keybindings (string path) +XMLNode& +ArdourKeyboard::get_state (void) { - try { - cerr << "loading bindings from " << path << endl; + XMLNode* node = &Keyboard::get_state (); + char buf[32]; - Gtk::AccelMap::load (path); + 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); - _current_binding_name = _("Unknown"); + return *node; +} - for (map::iterator x = binding_files.begin(); x != binding_files.end(); ++x) { - if (path == x->second) { - _current_binding_name = x->first; - break; - } - } +int +ArdourKeyboard::set_state (const XMLNode& node, int version) +{ + XMLProperty const * prop; - return true; + if ((prop = node.property ("constraint-modifier")) != 0) { + sscanf (prop->value().c_str(), "%d", &constraint_mod); + } + + 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); + } - } catch (...) { - error << string_compose (_("Ardour key bindings file not found at \"%1\" or contains errors."), path) - << endmsg; - return false; + if ((prop = node.property ("note-size-relative-modifier")) != 0) { + sscanf (prop->value().c_str(), "%d", ¬e_size_relative_mod); } + + return Keyboard::set_state (node, version); } +/* 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) +{ + 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)); +} +bool +ArdourKeyboard::indicates_snap_delta (guint state) +{ + 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 +ArdourKeyboard::set_constraint_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~constraint_mod); + constraint_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | constraint_mod); +} + +void +ArdourKeyboard::set_trim_contents_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_contents_mod); + trim_contents_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_contents_mod); +} + +void +ArdourKeyboard::set_trim_overlap_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_overlap_mod); + trim_overlap_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_overlap_mod); +} + +void +ArdourKeyboard::set_trim_anchored_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~trim_anchored_mod); + trim_anchored_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_anchored_mod); +} + +void +ArdourKeyboard::set_fine_adjust_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~fine_adjust_mod); + fine_adjust_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | fine_adjust_mod); +} + +void +ArdourKeyboard::set_push_points_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~push_points_mod); + push_points_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | push_points_mod); +} + +void +ArdourKeyboard::set_note_size_relative_modifier (guint mod) +{ + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask & ~note_size_relative_mod); + note_size_relative_mod = mod; + RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | note_size_relative_mod); +} + +Selection::Operation +ArdourKeyboard::selection_type (guint state) +{ + /* note that there is no modifier for "Add" */ + + if (modifier_state_equals (state, RangeSelectModifier)) { + return Selection::Extend; + } else if (modifier_state_equals (state, PrimaryModifier)) { + return Selection::Toggle; + } else { + return Selection::Set; + } +}