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