gtk2_ardour/actions.cc

   1 /*
   2     Copyright (C) 2005 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 <vector>
  21 #include <string>
  22
  23 #include <gtk/gtkaccelmap.h>
  24 #include <gtk/gtkuimanager.h>
  25 #include <gtk/gtkactiongroup.h>
  26
  27 #include <gtkmm/accelmap.h>
  28 #include <gtkmm/uimanager.h>
  29
  30 #include <pbd/error.h>
  31 #include <pbd/file_utils.h>
  32
  33 #include <ardour/ardour.h>
  34 #include <ardour/filesystem_paths.h>
  35
  36 #include "actions.h"
  37 #include "i18n.h"
  38
  39 using namespace std;
  40 using namespace Gtk;
  41 using namespace Glib;
  42 using namespace sigc;
  43 using namespace PBD;
  44 using namespace ARDOUR;
  45
  46 vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
  47 vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
  48 vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
  49 vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
  50 vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
  51 vector<RefPtr<Gtk::Action> > ActionManager::point_selection_sensitive_actions;
  52 vector<RefPtr<Gtk::Action> > ActionManager::time_selection_sensitive_actions;
  53 vector<RefPtr<Gtk::Action> > ActionManager::line_selection_sensitive_actions;
  54 vector<RefPtr<Gtk::Action> > ActionManager::playlist_selection_sensitive_actions;
  55
  56 vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
  57 vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
  58 vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
  59 vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
  60 vector<RefPtr<Gtk::Action> > ActionManager::edit_cursor_in_region_sensitive_actions;
  61
  62 RefPtr<UIManager> ActionManager::ui_manager;
  63 string ActionManager::unbound_string = "--";
  64
  65 void
  66 ActionManager::init ()
  67 {
  68         ui_manager = UIManager::create ();
  69
  70         sys::path ui_file;
  71
  72         SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
  73
  74         find_file_in_search_path (spath, "ardour.menus", ui_file);
  75
  76         bool loaded = false;
  77
  78         try {
  79                 ui_manager->add_ui_from_file (ui_file.to_string());
  80                 loaded = true;
  81         } catch (Glib::MarkupError& err) {
  82                 error << _("badly formatted UI definition file") << endmsg;
  83         } catch (...) {
  84                 error << _("Ardour menu definition file not found") << endmsg;
  85         }
  86
  87         if (!loaded) {
  88                 error << _("ardour will not work without a valid ardour.menus file") << endmsg;
  89                 exit(1);
  90         }
  91 }
  92
  93 RefPtr<Action>
  94 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
  95 {
  96         RefPtr<Action> act;
  97
  98         act = Action::create (name, label);
  99         group->add (act, sl);
 100
 101         return act;
 102 }
 103
 104 RefPtr<Action>
 105 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label)
 106 {
 107         RefPtr<Action> act;
 108
 109         act = Action::create (name, label);
 110         group->add (act);
 111
 112         return act;
 113 }
 114
 115
 116 RefPtr<Action>
 117 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group& rgroup, const char * name, const char * label, slot<void> sl)
 118 {
 119         RefPtr<Action> act;
 120
 121         act = RadioAction::create (rgroup, name, label);
 122         group->add (act, sl);
 123
 124         return act;
 125 }
 126
 127 RefPtr<Action>
 128 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
 129 {
 130         RefPtr<Action> act;
 131
 132         act = ToggleAction::create (name, label);
 133         group->add (act, sl);
 134
 135         return act;
 136 }
 137
 138 bool
 139 ActionManager::lookup_entry (const ustring accel_path, Gtk::AccelKey& key)
 140 {
 141         GtkAccelKey gkey;
 142         bool known = gtk_accel_map_lookup_entry (accel_path.c_str(), &gkey);
 143
 144         if (known) {
 145                 key = AccelKey (gkey.accel_key, Gdk::ModifierType (gkey.accel_mods));
 146         } else {
 147                 key = AccelKey (GDK_VoidSymbol, Gdk::ModifierType (0));
 148         }
 149
 150         return known;
 151 }
 152
 153 void
 154 ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
 155 {
 156         ListHandle<RefPtr<ActionGroup> > uim_groups = ui_manager->get_action_groups ();
 157
 158         for (ListHandle<RefPtr<ActionGroup> >::iterator g = uim_groups.begin(); g != uim_groups.end(); ++g) {
 159
 160                 ListHandle<RefPtr<Action> > group_actions = (*g)->get_actions();
 161
 162                 for (ListHandle<RefPtr<Action> >::iterator a = group_actions.begin(); a != group_actions.end(); ++a) {
 163
 164                         ustring accel_path;
 165
 166                         accel_path = (*a)->get_accel_path();
 167
 168                         names.push_back ((*a)->get_name());
 169                         paths.push_back (accel_path);
 170
 171                         AccelKey key;
 172                         bool known = lookup_entry (accel_path, key);
 173
 174                         if (known) {
 175                                 keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
 176                         } else {
 177                                 keys.push_back (unbound_string);
 178                         }
 179
 180                         bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
 181                 }
 182         }
 183 }
 184
 185 void
 186 ActionManager::add_action_group (RefPtr<ActionGroup> grp)
 187 {
 188         ui_manager->insert_action_group (grp);
 189 }
 190
 191 Widget*
 192 ActionManager::get_widget (const char * name)
 193 {
 194         return ui_manager->get_widget (name);
 195 }
 196
 197 RefPtr<Action>
 198 ActionManager::get_action (const char* group_name, const char* action_name)
 199 {
 200         /* the C++ API for functions used here appears to be broken in
 201            gtkmm2.6, so we fall back to the C level.
 202         */
 203
 204         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 205         GList* node;
 206         RefPtr<Action> act;
 207
 208         for (node = list; node; node = g_list_next (node)) {
 209
 210                 GtkActionGroup* _ag = (GtkActionGroup*) node->data;
 211
 212                 if (strcmp (group_name,  gtk_action_group_get_name (_ag)) == 0) {
 213
 214                         GtkAction* _act;
 215
 216                         if ((_act = gtk_action_group_get_action (_ag, action_name)) != 0) {
 217                                 act = Glib::wrap (_act, true);
 218                                 break;
 219                         }
 220                 }
 221         }
 222
 223         return act;
 224 }
 225
 226 void
 227 ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
 228 {
 229         for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
 230                 (*i)->set_sensitive (state);
 231         }
 232 }
 233
 234 void
 235 ActionManager::uncheck_toggleaction (const char * name)
 236 {
 237         char *last_slash = strrchr (name, '/');
 238
 239         if (last_slash == 0) {
 240                 fatal << string_compose (_("programmer error: %1 %2"), X_("illegal toggle action name"), name) << endmsg;
 241                 /*NOTREACHED*/
 242                 return;
 243         }
 244
 245         /* 10 = strlen ("<Actions>/") */
 246         size_t len = last_slash - (name + 10);
 247
 248         char* group_name = new char[len+1];
 249         memcpy (group_name, name + 10, len);
 250         group_name[len] = '\0';
 251
 252         char* action_name = last_slash + 1;
 253
 254         RefPtr<Action> act = get_action (group_name, action_name);
 255         if (act) {
 256                 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
 257                 tact->set_active (false);
 258         } else {
 259                 error << string_compose (_("Unknown action name: %1"),  name) << endmsg;
 260         }
 261
 262         delete [] group_name;
 263 }
 264
 265 /** Examine the state of a Configuration setting and a toggle action, and toggle the Configuration
 266  * setting if its state doesn't match the toggle action.
 267  * @param group Action group.
 268  * @param action Action name.
 269  * @param Method to set the state of the Configuration setting.
 270  * @param Method to get the state of the Configuration setting.
 271  */
 272 void
 273 ActionManager::toggle_config_state (const char* group, const char* action, bool (Configuration::*set)(bool), bool (Configuration::*get)(void) const)
 274 {
 275         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 276         if (act) {
 277                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 278
 279                 if (tact) {
 280                         bool x = (Config->*get)();
 281
 282                         if (x != tact->get_active()) {
 283                                 (Config->*set) (!x);
 284                         }
 285                 }
 286         }
 287 }
 288
 289 void
 290 ActionManager::toggle_config_state (const char* group, const char* action, sigc::slot<void> theSlot)
 291 {
 292         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 293         if (act) {
 294                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 295                 if (tact->get_active()) {
 296                         theSlot ();
 297                 }
 298         }
 299 }
 300
 301
 302 /** Set the state of a ToggleAction using a particular Configuration get() method
 303  * @param group Action group.
 304  * @param action Action name.
 305  * @param get Method to obtain the state that the ToggleAction should have.
 306  */
 307 void
 308 ActionManager::map_some_state (const char* group, const char* action, bool (Configuration::*get)() const)
 309 {
 310         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 311         if (act) {
 312                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 313
 314                 if (tact) {
 315
 316                         bool x = (Config->*get)();
 317
 318                         if (tact->get_active() != x) {
 319                                 tact->set_active (x);
 320                         }
 321                 } else {
 322                         cerr << group << ':' << action << " is not a toggle\n";
 323                 }
 324         } else {
 325                 cerr << group << ':' << action << " not an action\n";
 326         }
 327 }