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