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/error.h"
  21 #include "pbd/file_utils.h"
  22
  23 #include "ardour/filesystem_paths.h"
  24
  25 #include "ardour_ui.h"
  26 #include "keyboard.h"
  27 #include "opts.h"
  28
  29 #include "i18n.h"
  30
  31 using namespace std;
  32 using namespace Gtk;
  33 using namespace PBD;
  34 using namespace ARDOUR;
  35 using Gtkmm2ext::Keyboard;
  36
  37 static void
  38 accel_map_changed (GtkAccelMap* /*map*/,
  39                    gchar* /*path*/,
  40                    guint /*key*/,
  41                    GdkModifierType /*mod*/,
  42                    gpointer keyboard)
  43 {
  44         ArdourKeyboard* me = (ArdourKeyboard*)keyboard;
  45         Keyboard::keybindings_changed ();
  46         me->ui.setup_tooltips ();
  47 }
  48
  49 void
  50 ArdourKeyboard::setup_keybindings ()
  51 {
  52         using namespace ARDOUR_COMMAND_LINE;
  53         string default_bindings = "mnemonic-us.bindings";
  54         vector<string> strs;
  55
  56         binding_files.clear ();
  57
  58         ARDOUR::find_bindings_files (binding_files);
  59
  60         /* set up the per-user bindings path */
  61
  62         strs.push_back (Glib::get_home_dir());
  63         strs.push_back (".ardour3");
  64         strs.push_back ("ardour.bindings");
  65
  66         user_keybindings_path = Glib::build_filename (strs);
  67
  68         if (Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
  69                 std::pair<string,string> newpair;
  70                 newpair.first = _("your own");
  71                 newpair.second = user_keybindings_path;
  72                 binding_files.insert (newpair);
  73         }
  74
  75         /* check to see if they gave a style name ("SAE", "ergonomic") or
  76            an actual filename (*.bindings)
  77         */
  78
  79         if (!keybindings_path.empty() && keybindings_path.find (".bindings") == string::npos) {
  80
  81                 // just a style name - allow user to
  82                 // specify the layout type.
  83
  84                 char* layout;
  85
  86                 if ((layout = getenv ("ARDOUR_KEYBOARD_LAYOUT")) != 0 && layout[0] != '\0') {
  87
  88                         /* user-specified keyboard layout */
  89
  90                         keybindings_path += '-';
  91                         keybindings_path += layout;
  92
  93                 } else {
  94
  95                         /* default to US/ANSI - we have to pick something */
  96
  97                         keybindings_path += "-us";
  98                 }
  99
 100                 keybindings_path += ".bindings";
 101         }
 102
 103         if (keybindings_path.empty()) {
 104
 105                 /* no path or binding name given: check the user one first */
 106
 107                 if (!Glib::file_test (user_keybindings_path, Glib::FILE_TEST_EXISTS)) {
 108
 109                         keybindings_path = "";
 110
 111                 } else {
 112
 113                         keybindings_path = user_keybindings_path;
 114                 }
 115         }
 116
 117         /* if we still don't have a path at this point, use the default */
 118
 119         if (keybindings_path.empty()) {
 120                 keybindings_path = default_bindings;
 121         }
 122
 123         while (true) {
 124
 125                 if (!Glib::path_is_absolute (keybindings_path)) {
 126
 127                         /* not absolute - look in the usual places */
 128                         sys::path keybindings_file;
 129
 130                         SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
 131
 132                         if ( ! find_file_in_search_path (spath, keybindings_path, keybindings_file)) {
 133
 134                                 if (keybindings_path == default_bindings) {
 135                                         error << string_compose (_("Default keybindings not found - %1 will be hard to use!"), PROGRAM_NAME) << endmsg;
 136                                         return;
 137                                 } else {
 138                                         warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
 139                                                                    keybindings_path)
 140                                                 << endmsg;
 141                                         keybindings_path = default_bindings;
 142                                 }
 143
 144                         } else {
 145
 146                                 /* use it */
 147
 148                                 keybindings_path = keybindings_file.to_string();
 149                                 break;
 150
 151                         }
 152
 153                 } else {
 154
 155                         /* path is absolute already */
 156
 157                         if (!Glib::file_test (keybindings_path, Glib::FILE_TEST_EXISTS)) {
 158                                 if (keybindings_path == default_bindings) {
 159                                         error << string_compose (_("Default keybindings not found - %1 will be hard to use!"), PROGRAM_NAME) << endmsg;
 160                                         return;
 161                                 } else {
 162                                         warning << string_compose (_("Key bindings file \"%1\" not found. Default bindings used instead"),
 163                                                                    keybindings_path)
 164                                                 << endmsg;
 165                                         keybindings_path = default_bindings;
 166                                 }
 167
 168                         } else {
 169                                 break;
 170                         }
 171                 }
 172         }
 173
 174         load_keybindings (keybindings_path);
 175
 176         /* catch changes */
 177
 178         GtkAccelMap* accelmap = gtk_accel_map_get();
 179         g_signal_connect (accelmap, "changed", (GCallback) accel_map_changed, this);
 180 }
 181
 182 Selection::Operation
 183 ArdourKeyboard::selection_type (guint state)
 184 {
 185         /* note that there is no modifier for "Add" */
 186
 187         if (modifier_state_equals (state, RangeSelectModifier)) {
 188                 return Selection::Extend;
 189         } else if (modifier_state_equals (state, PrimaryModifier)) {
 190                 return Selection::Toggle;
 191         } else {
 192                 return Selection::Set;
 193         }
 194 }
 195
 196