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