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