gtk2_ardour/keyboard.cc

   1 /*
   2     Copyright (C) 2001 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "pbd/convert.h"
  21 #include "pbd/error.h"
  22 #include "pbd/file_utils.h"
  23 #include "pbd/basename.h"
  24
  25 #include "ardour/filesystem_paths.h"
  26 #include "ardour/revision.h"
  27
  28 #include "ardour_ui.h"
  29 #include "public_editor.h"
  30 #include "keyboard.h"
  31 #include "opts.h"
  32 #include "ui_config.h"
  33
  34 #include "pbd/i18n.h"
  35
  36 using namespace std;
  37 using namespace Gtk;
  38 using namespace PBD;
  39 using namespace ARDOUR;
  40 using Gtkmm2ext::Keyboard;
  41
  42 #ifdef __APPLE__
  43 guint ArdourKeyboard::constraint_mod = Keyboard::PrimaryModifier;
  44 #else
  45 guint ArdourKeyboard::constraint_mod = Keyboard::TertiaryModifier;
  46 #endif
  47
  48 /* TrimDrag::start_grab() */
  49 guint ArdourKeyboard::trim_contents_mod = Keyboard::PrimaryModifier;
  50
  51 /* TrimDrag::motion() */
  52 guint ArdourKeyboard::trim_overlap_mod = Keyboard::TertiaryModifier;
  53
  54 /* TrimDrag::start_grab() */
  55 guint ArdourKeyboard::trim_anchored_mod = Keyboard::PrimaryModifier|Keyboard::TertiaryModifier;
  56
  57 /* ControlPointDrag::motion() && LineDrag::motion()*/
  58 guint ArdourKeyboard::fine_adjust_mod = Keyboard::PrimaryModifier|Keyboard::SecondaryModifier; // XXX better just 2ndary
  59
  60 /* ControlPointDrag::start_grab() && MarkerDrag::motion() */
  61 guint ArdourKeyboard::push_points_mod = Keyboard::PrimaryModifier|Keyboard::Level4Modifier;
  62
  63 /* NoteResizeDrag::start_grab() */
  64 guint ArdourKeyboard::note_size_relative_mod = Keyboard::TertiaryModifier; // XXX better: 2ndary
  65
  66 ArdourKeyboard::ArdourKeyboard (ARDOUR_UI& ardour_ui) : ui (ardour_ui)
  67 {
  68         Keyboard::RelevantModifierKeysChanged.connect (sigc::mem_fun (*this, &ArdourKeyboard::reset_relevant_modifier_key_mask));
  69 }
  70
  71 void
  72 ArdourKeyboard::find_bindings_files (map<string,string>& files)
  73 {
  74         vector<std::string> found;
  75         Searchpath spath = ardour_config_search_path();
  76
  77         find_files_matching_pattern (found, spath, string_compose ("*%1", Keyboard::binding_filename_suffix));
  78
  79         if (found.empty()) {
  80                 return;
  81         }
  82
  83         for (vector<std::string>::iterator x = found.begin(); x != found.end(); ++x) {
  84                 std::string path(*x);
  85                 pair<string,string> namepath;
  86                 namepath.second = path;
  87                 namepath.first = PBD::basename_nosuffix (path);
  88                 files.insert (namepath);
  89         }
  90 }
  91
  92 void
  93 ArdourKeyboard::setup_keybindings ()
  94 {
  95         string keybindings_path = ARDOUR_COMMAND_LINE::keybindings_path;
  96         string default_bindings = string_compose ("%1%2", UIConfiguration::instance().get_default_bindings(), Keyboard::binding_filename_suffix);
  97         vector<string> strs;
  98
  99         binding_files.clear ();
 100
 101         find_bindings_files (binding_files);
 102
 103         /* set up the per-user bindings path */
 104
 105         string lowercase_program_name = downcase (string(PROGRAM_NAME));
 106
 107 #ifndef MIXBUS // not for v4.0 just yet
 108         /* extract and append minor vesion */
 109         std::string rev (revision);
 110         std::size_t pos = rev.find_first_of("-");
 111         if (pos != string::npos && pos > 0) {
 112                 lowercase_program_name += "-";
 113                 lowercase_program_name += rev.substr (0, pos);
 114         }
 115 #endif
 116
 117         user_keybindings_path = Glib::build_filename (user_config_directory(), lowercase_program_name + binding_filename_suffix);
 118
 119         if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
 120                 std::pair<string,string> newpair;
 121                 newpair.first = _("your own");
 122                 newpair.second = user_keybindings_path;
 123                 binding_files.insert (newpair);
 124         }
 125
 126         /* check to see if they gave a style name ("ergonomic") or an actual filename (*.bindings)
 127         */
 128
 129         if (!keybindings_path.empty() && keybindings_path.find (binding_filename_suffix) == string::npos) {
 130
 131                 // just a style name - allow user to
 132                 // specify the layout type.
 133
 134                 char* layout;
 135
 136                 if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
 137
 138                         /* user-specified keyboard layout */
 139
 140                         keybindings_path += '-';
 141                         keybindings_path += layout;
 142
 143                 } else {
 144
 145                         /* default to US/ANSI - we have to pick something */
 146
 147                         keybindings_path += "-us";
 148                 }
 149
 150                 keybindings_path += binding_filename_suffix;
 151         }
 152
 153         if (keybindings_path.empty()) {
 154
 155                 /* no path or binding name given: check the user one first */
 156
 157                 if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
 158
 159                         keybindings_path = "";
 160
 161                 } else {
 162
 163                         keybindings_path = user_keybindings_path;
 164                 }
 165         }
 166
 167         /* if we still don't have a path at this point, use the default */
 168
 169         if (keybindings_path.empty()) {
 170                 keybindings_path = default_bindings;
 171         }
 172
 173         while (true) {
 174
 175                 if (!Glib::path_is_absolute (keybindings_path)) {
 176
 177                         /* not absolute - look in the usual places */
 178                         std::string keybindings_file;
 179
 180                         if (!find_file (ardour_config_search_path(), keybindings_path, keybindings_file)) {
 181
 182                                 if (keybindings_path == default_bindings) {
 183                                         error << string_compose (_("Default keybindings not found - %1 will be hard to use!"), PROGRAM_NAME) << endmsg;
 184                                         return;
 185                                 } else {
 186                                         warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
 187                                                                    keybindings_path)
 188                                                 << endmsg;
 189                                         keybindings_path = default_bindings;
 190                                 }
 191
 192                         } else {
 193
 194                                 /* use it */
 195
 196                                 keybindings_path = keybindings_file;
 197                                 break;
 198
 199                         }
 200
 201                 } else {
 202
 203                         /* path is absolute already */
 204
 205                         if (!Glib::file_test (keybindings_path, Glib::FILE_TEST_EXISTS)) {
 206                                 if (keybindings_path == default_bindings) {
 207                                         error << string_compose (_("Default keybindings not found - %1 will be hard to use!"), PROGRAM_NAME) << endmsg;
 208                                         return;
 209                                 } else {
 210                                         keybindings_path = default_bindings;
 211                                 }
 212
 213                         } else {
 214                                 break;
 215                         }
 216                 }
 217         }
 218
 219         load_keybindings (keybindings_path);
 220
 221         /* catch changes made via some GTK mechanism */
 222
 223         // GtkAccelMap* accelmap = gtk_accel_map_get();
 224         // g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, this);
 225 }
 226
 227 XMLNode&
 228 ArdourKeyboard::get_state (void)
 229 {
 230         XMLNode* node = &Keyboard::get_state ();
 231
 232         node->set_property ("constraint-modifier", constraint_mod);
 233         node->set_property ("trim-contents-modifier", trim_contents_mod);
 234         node->set_property ("trim-overlap-modifier", trim_overlap_mod);
 235         node->set_property ("trim-anchored-modifier", trim_anchored_mod);
 236         node->set_property ("fine-adjust-modifier", fine_adjust_mod);
 237         node->set_property ("push-points-modifier", push_points_mod);
 238         node->set_property ("note-size-relative-modifier", note_size_relative_mod);
 239
 240         return *node;
 241 }
 242
 243 int
 244 ArdourKeyboard::set_state (const XMLNode& node, int version)
 245 {
 246         node.get_property ("constraint-modifier", constraint_mod);
 247         node.get_property ("trim-contents-modifier", trim_contents_mod);
 248         node.get_property ("trim-overlap-modifier", trim_overlap_mod);
 249         node.get_property ("trim-anchored-modifier", trim_anchored_mod);
 250         node.get_property ("fine-adjust-modifier", fine_adjust_mod);
 251         node.get_property ("push-points-modifier", push_points_mod);
 252         node.get_property ("note-size-relative-modifier", note_size_relative_mod);
 253
 254         return Keyboard::set_state (node, version);
 255 }
 256
 257 void
 258 ArdourKeyboard::reset_relevant_modifier_key_mask ()
 259 {
 260         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | constraint_mod);
 261         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_contents_mod);
 262         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_overlap_mod);
 263         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | trim_anchored_mod);
 264         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | fine_adjust_mod);
 265         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | push_points_mod);
 266         RelevantModifierKeyMask = GdkModifierType (RelevantModifierKeyMask | note_size_relative_mod);
 267 }
 268
 269 /* Snap and snap delta modifiers may contain each other, so we use the
 270  * following two methods to sort that out:
 271  */
 272 bool
 273 ArdourKeyboard::indicates_snap (guint state)
 274 {
 275         const bool contains_s = Keyboard::modifier_state_contains (state, Keyboard::snap_modifier ());
 276         const bool contains_d = Keyboard::modifier_state_contains (state, Keyboard::snap_delta_modifier ());
 277         const bool s_contains_d = Keyboard::modifier_state_contains (Keyboard::snap_modifier (), Keyboard::snap_delta_modifier ());
 278
 279         return  (contains_s && ((contains_d && s_contains_d) || !contains_d));
 280 }
 281
 282 bool
 283 ArdourKeyboard::indicates_snap_delta (guint state)
 284 {
 285         const bool contains_d = Keyboard::modifier_state_contains (state, Keyboard::snap_delta_modifier ());
 286         const bool contains_s = Keyboard::modifier_state_contains (state, Keyboard::snap_modifier ());
 287         const bool d_contains_s = Keyboard::modifier_state_contains (Keyboard::snap_delta_modifier (), Keyboard::snap_modifier ());
 288
 289         return (contains_d && ((contains_s && d_contains_s) || !contains_s));
 290 }
 291
 292 /* Constraint and copy modifiers are both in effect at the beginning of some drags, and may be set ambiguously */
 293 bool
 294 ArdourKeyboard::indicates_copy (guint state)
 295 {
 296         const bool contains_c = Keyboard::modifier_state_contains (state, Keyboard::CopyModifier);
 297         const bool equals_cs = Keyboard::modifier_state_equals (state, constraint_modifier ());
 298
 299         return  contains_c && !equals_cs;
 300 }
 301
 302 bool
 303 ArdourKeyboard::indicates_constraint (guint state)
 304 {
 305         const bool contains_cs = Keyboard::modifier_state_contains (state, constraint_modifier ());
 306         const bool equals_c = Keyboard::modifier_state_equals (state, Keyboard::CopyModifier);
 307
 308         return contains_cs && !equals_c;
 309 }
 310
 311 void
 312 ArdourKeyboard::set_constraint_modifier (guint mod)
 313 {
 314         constraint_mod = mod;
 315         the_keyboard().reset_relevant_modifier_key_mask();
 316 }
 317
 318 void
 319 ArdourKeyboard::set_trim_contents_modifier (guint mod)
 320 {
 321         trim_contents_mod = mod;
 322         the_keyboard().reset_relevant_modifier_key_mask();
 323 }
 324
 325 void
 326 ArdourKeyboard::set_trim_overlap_modifier (guint mod)
 327 {
 328         trim_overlap_mod = mod;
 329         the_keyboard().reset_relevant_modifier_key_mask();
 330 }
 331
 332 void
 333 ArdourKeyboard::set_trim_anchored_modifier (guint mod)
 334 {
 335         trim_anchored_mod = mod;
 336         the_keyboard().reset_relevant_modifier_key_mask();
 337 }
 338
 339 void
 340 ArdourKeyboard::set_fine_adjust_modifier (guint mod)
 341 {
 342         fine_adjust_mod = mod;
 343         the_keyboard().reset_relevant_modifier_key_mask();
 344 }
 345
 346 void
 347 ArdourKeyboard::set_push_points_modifier (guint mod)
 348 {
 349         push_points_mod = mod;
 350         the_keyboard().reset_relevant_modifier_key_mask();
 351 }
 352
 353 void
 354 ArdourKeyboard::set_note_size_relative_modifier (guint mod)
 355 {
 356         note_size_relative_mod = mod;
 357         the_keyboard().reset_relevant_modifier_key_mask();
 358 }
 359
 360 Selection::Operation
 361 ArdourKeyboard::selection_type (guint state)
 362 {
 363         /* note that there is no modifier for "Add" */
 364
 365         if (modifier_state_equals (state, RangeSelectModifier)) {
 366                 return Selection::Extend;
 367         } else if (modifier_state_equals (state, PrimaryModifier)) {
 368                 return Selection::Toggle;
 369         } else {
 370                 return Selection::Set;
 371         }
 372 }