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