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