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