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 <cstring>
  21 #include <vector>
  22 #include <string>
  23 #include <list>
  24
  25 #include <gtk/gtkaccelmap.h>
  26 #include <gtk/gtkuimanager.h>
  27 #include <gtk/gtkactiongroup.h>
  28
  29 #include <gtkmm/accelmap.h>
  30 #include <gtkmm/uimanager.h>
  31
  32 #include "pbd/error.h"
  33 #include "pbd/file_utils.h"
  34
  35 #include "ardour/ardour.h"
  36 #include "ardour/filesystem_paths.h"
  37 #include "ardour/rc_configuration.h"
  38
  39 #include "actions.h"
  40 #include "i18n.h"
  41
  42 using namespace std;
  43 using namespace Gtk;
  44 using namespace Glib;
  45 using namespace sigc;
  46 using namespace PBD;
  47 using namespace ARDOUR;
  48
  49 vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
  50 vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
  51 vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
  52 vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
  53 vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
  54 vector<RefPtr<Gtk::Action> > ActionManager::point_selection_sensitive_actions;
  55 vector<RefPtr<Gtk::Action> > ActionManager::time_selection_sensitive_actions;
  56 vector<RefPtr<Gtk::Action> > ActionManager::line_selection_sensitive_actions;
  57 vector<RefPtr<Gtk::Action> > ActionManager::playlist_selection_sensitive_actions;
  58 vector<RefPtr<Gtk::Action> > ActionManager::mouse_edit_point_requires_canvas_actions;
  59
  60 vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
  61 vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
  62 vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
  63 vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
  64 vector<RefPtr<Gtk::Action> > ActionManager::edit_point_in_region_sensitive_actions;
  65
  66 RefPtr<UIManager> ActionManager::ui_manager;
  67 string ActionManager::unbound_string = "--";
  68
  69 void
  70 ActionManager::init ()
  71 {
  72         ui_manager = UIManager::create ();
  73
  74         sys::path ui_file;
  75
  76         SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
  77
  78         find_file_in_search_path (spath, "ardour.menus", ui_file);
  79
  80         bool loaded = false;
  81
  82         try {
  83                 ui_manager->add_ui_from_file (ui_file.to_string());
  84                 loaded = true;
  85         } catch (Glib::MarkupError& err) {
  86                 error << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endmsg;
  87                 cerr << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endl;
  88         } catch (...) {
  89                 error << _("Ardour menu definition file not found") << endmsg;
  90         }
  91
  92         if (!loaded) {
  93                 error << _("ardour will not work without a valid ardour.menus file") << endmsg;
  94                 exit(1);
  95         }
  96 }
  97
  98 RefPtr<Action>
  99 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
 100 {
 101         RefPtr<Action> act;
 102
 103         act = Action::create (name, label);
 104         group->add (act, sl);
 105
 106         return act;
 107 }
 108
 109 RefPtr<Action>
 110 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label)
 111 {
 112         RefPtr<Action> act;
 113
 114         act = Action::create (name, label);
 115         group->add (act);
 116
 117         return act;
 118 }
 119
 120
 121 RefPtr<Action>
 122 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group& rgroup, const char * name, const char * label, slot<void> sl)
 123 {
 124         RefPtr<Action> act;
 125
 126         act = RadioAction::create (rgroup, name, label);
 127         group->add (act, sl);
 128
 129         return act;
 130 }
 131
 132 RefPtr<Action>
 133 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
 134 {
 135         RefPtr<Action> act;
 136
 137         act = ToggleAction::create (name, label);
 138         group->add (act, sl);
 139
 140         return act;
 141 }
 142
 143 bool
 144 ActionManager::lookup_entry (const ustring accel_path, Gtk::AccelKey& key)
 145 {
 146         GtkAccelKey gkey;
 147         bool known = gtk_accel_map_lookup_entry (accel_path.c_str(), &gkey);
 148
 149         if (known) {
 150                 key = AccelKey (gkey.accel_key, Gdk::ModifierType (gkey.accel_mods));
 151         } else {
 152                 key = AccelKey (GDK_VoidSymbol, Gdk::ModifierType (0));
 153         }
 154
 155         return known;
 156 }
 157
 158 struct SortActionsByLabel {
 159     bool operator() (Glib::RefPtr<Gtk::Action> a, Glib::RefPtr<Gtk::Action> b) {
 160             ustring astr = a->get_accel_path();
 161             ustring bstr = b->get_accel_path();
 162             return astr < bstr;
 163     }
 164 };
 165
 166 void
 167 ActionManager::get_all_actions (vector<string>& groups, vector<string>& names, vector<AccelKey>& bindings)
 168 {
 169         /* the C++ API for functions used here appears to be broken in
 170            gtkmm2.6, so we fall back to the C level.
 171         */
 172
 173         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 174         GList* node;
 175         GList* acts;
 176
 177         for (node = list; node; node = g_list_next (node)) {
 178
 179                 GtkActionGroup* group = (GtkActionGroup*) node->data;
 180
 181                 /* first pass: collect them all */
 182
 183                 typedef std::list<Glib::RefPtr<Gtk::Action> > action_list;
 184                 action_list the_acts;
 185
 186                 for (acts = gtk_action_group_list_actions (group); acts; acts = g_list_next (acts)) {
 187                         GtkAction* action = (GtkAction*) acts->data;
 188                         the_acts.push_back (Glib::wrap (action, true));
 189                 }
 190
 191                 /* now sort by label */
 192
 193                 SortActionsByLabel cmp;
 194                 the_acts.sort (cmp);
 195
 196                 for (action_list::iterator a = the_acts.begin(); a != the_acts.end(); ++a) {
 197
 198                         string accel_path = (*a)->get_accel_path ();
 199
 200                         groups.push_back (gtk_action_group_get_name(group));
 201                         names.push_back (accel_path.substr (accel_path.find_last_of ('/') + 1));
 202
 203                         AccelKey key;
 204                         lookup_entry (accel_path, key);
 205                         bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
 206                 }
 207         }
 208 }
 209
 210 void
 211 ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
 212 {
 213         /* the C++ API for functions used here appears to be broken in
 214            gtkmm2.6, so we fall back to the C level.
 215         */
 216
 217         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 218         GList* node;
 219         GList* acts;
 220
 221         for (node = list; node; node = g_list_next (node)) {
 222
 223                 GtkActionGroup* group = (GtkActionGroup*) node->data;
 224
 225                 /* first pass: collect them all */
 226
 227                 typedef std::list<Glib::RefPtr<Gtk::Action> > action_list;
 228                 action_list the_acts;
 229
 230                 for (acts = gtk_action_group_list_actions (group); acts; acts = g_list_next (acts)) {
 231                         GtkAction* action = (GtkAction*) acts->data;
 232                         the_acts.push_back (Glib::wrap (action, true));
 233                 }
 234
 235                 /* now sort by label */
 236
 237                 SortActionsByLabel cmp;
 238                 the_acts.sort (cmp);
 239
 240                 for (action_list::iterator a = the_acts.begin(); a != the_acts.end(); ++a) {
 241
 242                         string accel_path = (*a)->get_accel_path ();
 243                         ustring label = (*a)->property_label();
 244
 245                         names.push_back (label);
 246                         paths.push_back (accel_path);
 247
 248                         AccelKey key;
 249                         bool known = lookup_entry (accel_path, key);
 250
 251                         if (known) {
 252                                 keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
 253                         } else {
 254                                 keys.push_back (unbound_string);
 255                         }
 256
 257                         bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
 258                 }
 259         }
 260 }
 261
 262 void
 263 ActionManager::add_action_group (RefPtr<ActionGroup> grp)
 264 {
 265         ui_manager->insert_action_group (grp);
 266 }
 267
 268 Widget*
 269 ActionManager::get_widget (const char * name)
 270 {
 271         return ui_manager->get_widget (name);
 272 }
 273
 274 RefPtr<Action>
 275 ActionManager::get_action (const char* path)
 276 {
 277         GtkAction* _act;
 278         RefPtr<Action> act;
 279
 280         if ((_act = gtk_ui_manager_get_action (ui_manager->gobj(), path)) != 0) {
 281                 return Glib::wrap (_act, true);
 282         }
 283
 284         return act;
 285 }
 286
 287 RefPtr<Action>
 288 ActionManager::get_action (const char* group_name, const char* action_name)
 289 {
 290         /* the C++ API for functions used here appears to be broken in
 291            gtkmm2.6, so we fall back to the C level.
 292         */
 293
 294         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 295         GList* node;
 296         RefPtr<Action> act;
 297
 298         for (node = list; node; node = g_list_next (node)) {
 299
 300                 GtkActionGroup* _ag = (GtkActionGroup*) node->data;
 301
 302                 if (strcmp (group_name,  gtk_action_group_get_name (_ag)) == 0) {
 303
 304                         GtkAction* _act;
 305
 306                         if ((_act = gtk_action_group_get_action (_ag, action_name)) != 0) {
 307                                 act = Glib::wrap (_act, true);
 308                                 break;
 309                         }
 310                 }
 311         }
 312
 313         return act;
 314 }
 315
 316 void
 317 ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
 318 {
 319         for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
 320                 (*i)->set_sensitive (state);
 321         }
 322 }
 323
 324 void
 325 ActionManager::uncheck_toggleaction (const char * name)
 326 {
 327         const char *last_slash = strrchr (name, '/');
 328
 329         if (last_slash == 0) {
 330                 fatal << string_compose (_("programmer error: %1 %2"), X_("illegal toggle action name"), name) << endmsg;
 331                 /*NOTREACHED*/
 332                 return;
 333         }
 334
 335         /* 10 = strlen ("<Actions>/") */
 336         size_t len = last_slash - (name + 10);
 337
 338         char* group_name = new char[len+1];
 339         memcpy (group_name, name + 10, len);
 340         group_name[len] = '\0';
 341
 342         const char* action_name = last_slash + 1;
 343
 344         RefPtr<Action> act = get_action (group_name, action_name);
 345         if (act) {
 346                 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
 347                 tact->set_active (false);
 348         } else {
 349                 error << string_compose (_("Unknown action name: %1"),  name) << endmsg;
 350         }
 351
 352         delete [] group_name;
 353 }
 354
 355 /** Examine the state of a Configuration setting and a toggle action, and toggle the Configuration
 356  * setting if its state doesn't match the toggle action.
 357  * @param group Action group.
 358  * @param action Action name.
 359  * @param Method to set the state of the Configuration setting.
 360  * @param Method to get the state of the Configuration setting.
 361  */
 362 void
 363 ActionManager::toggle_config_state (const char* group, const char* action, bool (RCConfiguration::*set)(bool), bool (RCConfiguration::*get)(void) const)
 364 {
 365         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 366         if (act) {
 367                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 368
 369                 if (tact) {
 370                         bool x = (Config->*get)();
 371
 372                         if (x != tact->get_active()) {
 373                                 (Config->*set) (!x);
 374                         }
 375                 }
 376         }
 377 }
 378
 379 void
 380 ActionManager::toggle_config_state_foo (const char* group, const char* action, sigc::slot<bool, bool> set, sigc::slot<bool> get)
 381 {
 382         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 383         if (act) {
 384                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 385                 if (tact->get_active()) {
 386                         bool const x = get ();
 387                         if (x != tact->get_active ()) {
 388                                 set (x);
 389                         }
 390                 }
 391         }
 392 }
 393
 394
 395 /** Set the state of a ToggleAction using a particular Configuration get() method
 396  * @param group Action group.
 397  * @param action Action name.
 398  * @param get Method to obtain the state that the ToggleAction should have.
 399  */
 400 void
 401 ActionManager::map_some_state (const char* group, const char* action, bool (RCConfiguration::*get)() const)
 402 {
 403         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 404         if (act) {
 405                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 406
 407                 if (tact) {
 408
 409                         bool x = (Config->*get)();
 410
 411                         if (tact->get_active() != x) {
 412                                 tact->set_active (x);
 413                         }
 414                 } else {
 415                         cerr << group << ':' << action << " is not a toggle\n";
 416                 }
 417         } else {
 418                 cerr << group << ':' << action << " not an action\n";
 419         }
 420 }
 421
 422 void
 423 ActionManager::map_some_state (const char* group, const char* action, sigc::slot<bool> get)
 424 {
 425         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 426         if (act) {
 427                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 428
 429                 if (tact) {
 430
 431                         bool const x = get ();
 432
 433                         if (tact->get_active() != x) {
 434                                 tact->set_active (x);
 435                         }
 436                 }
 437         }
 438 }