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     $Id$
  19 */
  20
  21 #include <vector>
  22 #include <string>
  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
  33 #include <ardour/ardour.h>
  34
  35 #include "actions.h"
  36 #include "i18n.h"
  37
  38 using namespace std;
  39 using namespace Gtk;
  40 using namespace Glib;
  41 using namespace sigc;
  42 using namespace PBD;
  43 using namespace ARDOUR;
  44
  45 vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
  46 vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
  47 vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
  48 vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
  49 vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
  50 vector<RefPtr<Gtk::Action> > ActionManager::point_selection_sensitive_actions;
  51 vector<RefPtr<Gtk::Action> > ActionManager::time_selection_sensitive_actions;
  52 vector<RefPtr<Gtk::Action> > ActionManager::line_selection_sensitive_actions;
  53 vector<RefPtr<Gtk::Action> > ActionManager::playlist_selection_sensitive_actions;
  54
  55 vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
  56 vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
  57 vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
  58 vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
  59 vector<RefPtr<Gtk::Action> > ActionManager::edit_cursor_in_region_sensitive_actions;
  60
  61 RefPtr<UIManager> ActionManager::ui_manager;
  62 string ActionManager::unbound_string = "--";
  63
  64 void
  65 ActionManager::init ()
  66 {
  67         ui_manager = UIManager::create ();
  68
  69         std::string ui_file = ARDOUR::find_config_file("ardour.menus");
  70
  71         bool loaded = false;
  72
  73         try {
  74                 ui_manager->add_ui_from_file (ui_file);
  75                 loaded = true;
  76         } catch (Glib::MarkupError& err) {
  77                 error << _("badly formatted UI definition file") << endmsg;
  78         } catch (...) {
  79                 error << _("Ardour menu definition file not found") << endmsg;
  80         }
  81
  82         if (!loaded) {
  83                 error << _("ardour will not work without a valid ardour.menus file") << endmsg;
  84                 exit(1);
  85         }
  86 }
  87
  88 RefPtr<Action>
  89 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
  90 {
  91         RefPtr<Action> act = register_action (group, name, label, sl);
  92         AccelMap::add_entry (act->get_accel_path(), key, mods);
  93
  94         return act;
  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, guint key, Gdk::ModifierType mods)
 122 {
 123         RefPtr<Action> act = register_radio_action (group, rgroup, name, label, sl);
 124         AccelMap::add_entry (act->get_accel_path(), key, mods);
 125
 126         return act;
 127 }
 128
 129 RefPtr<Action>
 130 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group& rgroup, const char * name, const char * label, slot<void> sl)
 131 {
 132         RefPtr<Action> act;
 133
 134         act = RadioAction::create (rgroup, name, label);
 135         group->add (act, sl);
 136
 137         return act;
 138 }
 139
 140 RefPtr<Action>
 141 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
 142 {
 143         RefPtr<Action> act = register_toggle_action (group,name, label, sl);
 144         AccelMap::add_entry (act->get_accel_path(), key, mods);
 145
 146         return act;
 147 }
 148
 149 RefPtr<Action>
 150 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
 151 {
 152         RefPtr<Action> act;
 153
 154         act = ToggleAction::create (name, label);
 155         group->add (act, sl);
 156
 157         return act;
 158 }
 159
 160 bool
 161 ActionManager::lookup_entry (const ustring accel_path, Gtk::AccelKey& key)
 162 {
 163         GtkAccelKey gkey;
 164         bool known = gtk_accel_map_lookup_entry (accel_path.c_str(), &gkey);
 165
 166         if (known) {
 167                 key = AccelKey (gkey.accel_key, Gdk::ModifierType (gkey.accel_mods));
 168         } else {
 169                 key = AccelKey (GDK_VoidSymbol, Gdk::ModifierType (0));
 170         }
 171
 172         return known;
 173 }
 174
 175 void
 176 ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
 177 {
 178         ListHandle<RefPtr<ActionGroup> > uim_groups = ui_manager->get_action_groups ();
 179
 180         for (ListHandle<RefPtr<ActionGroup> >::iterator g = uim_groups.begin(); g != uim_groups.end(); ++g) {
 181
 182                 ListHandle<RefPtr<Action> > group_actions = (*g)->get_actions();
 183
 184                 for (ListHandle<RefPtr<Action> >::iterator a = group_actions.begin(); a != group_actions.end(); ++a) {
 185
 186                         ustring accel_path;
 187
 188                         accel_path = (*a)->get_accel_path();
 189
 190                         names.push_back ((*a)->get_name());
 191                         paths.push_back (accel_path);
 192
 193                         AccelKey key;
 194                         bool known = lookup_entry (accel_path, key);
 195
 196                         if (known) {
 197                                 keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
 198                         } else {
 199                                 keys.push_back (unbound_string);
 200                         }
 201
 202                         bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
 203                 }
 204         }
 205 }
 206
 207 void
 208 ActionManager::add_action_group (RefPtr<ActionGroup> grp)
 209 {
 210         ui_manager->insert_action_group (grp);
 211 }
 212
 213 Widget*
 214 ActionManager::get_widget (const char * name)
 215 {
 216         return ui_manager->get_widget (name);
 217 }
 218
 219 RefPtr<Action>
 220 ActionManager::get_action (const char* group_name, const char* action_name)
 221 {
 222         /* the C++ API for functions used here appears to be broken in
 223            gtkmm2.6, so we fall back to the C level.
 224         */
 225
 226         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 227         GList* node;
 228         RefPtr<Action> act;
 229
 230         for (node = list; node; node = g_list_next (node)) {
 231
 232                 GtkActionGroup* _ag = (GtkActionGroup*) node->data;
 233
 234                 if (strcmp (group_name,  gtk_action_group_get_name (_ag)) == 0) {
 235
 236                         GtkAction* _act;
 237
 238                         if ((_act = gtk_action_group_get_action (_ag, action_name)) != 0) {
 239                                 act = Glib::wrap (_act, true);
 240                                 break;
 241                         }
 242                 }
 243         }
 244
 245         return act;
 246 }
 247
 248 void
 249 ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
 250 {
 251         for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
 252                 (*i)->set_sensitive (state);
 253         }
 254 }
 255
 256 void
 257 ActionManager::uncheck_toggleaction (const char * name)
 258 {
 259         char *last_slash = strrchr (name, '/');
 260
 261         if (last_slash == 0) {
 262                 fatal << string_compose (_("programmer error: %1 %2"), X_("illegal toggle action name"), name) << endmsg;
 263                 /*NOTREACHED*/
 264                 return;
 265         }
 266
 267         /* 10 = strlen ("<Actions>/") */
 268         size_t len = last_slash - (name + 10);
 269
 270         char* group_name = new char[len+1];
 271         memcpy (group_name, name + 10, len);
 272         group_name[len] = '\0';
 273
 274         char* action_name = last_slash + 1;
 275
 276         RefPtr<Action> act = get_action (group_name, action_name);
 277         if (act) {
 278                 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
 279                 tact->set_active (false);
 280         } else {
 281                 error << string_compose (_("Unknown action name: %1"),  name) << endmsg;
 282         }
 283
 284         delete [] group_name;
 285 }
 286
 287 void
 288 ActionManager::toggle_config_state (const char* group, const char* action, bool (Configuration::*set)(bool), bool (Configuration::*get)(void) const)
 289 {
 290         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 291         if (act) {
 292                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 293
 294                 if (tact) {
 295                         bool x = (Config->*get)();
 296
 297                         if (x != tact->get_active()) {
 298                                 (Config->*set) (!x);
 299                         }
 300                 }
 301         }
 302 }
 303
 304 void
 305 ActionManager::toggle_config_state (const char* group, const char* action, sigc::slot<void> theSlot)
 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                 if (tact->get_active()) {
 311                         theSlot ();
 312                 }
 313         }
 314 }
 315
 316 void
 317 ActionManager::map_some_state (const char* group, const char* action, bool (Configuration::*get)() const)
 318 {
 319         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 320         if (act) {
 321                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 322
 323                 if (tact) {
 324
 325                         bool x = (Config->*get)();
 326
 327                         if (tact->get_active() != x) {
 328                                 tact->set_active (x);
 329                         }
 330                 } else {
 331                         cerr << group << ':' << action << " is not a toggle\n";
 332                 }
 333         } else {
 334                 cerr << group << ':' << action << " not an action\n";
 335         }
 336 }