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