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