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
  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
  36 using namespace std;
  37 using namespace Gtk;
  38 using namespace Glib;
  39 using namespace sigc;
  40
  41 vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
  42 vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
  43 vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
  44 vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
  45 vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
  46 vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
  47 vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
  48 vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
  49 RefPtr<UIManager> ActionManager::ui_manager;
  50 string ActionManager::unbound_string = "--";
  51
  52 void
  53 ActionManager::init ()
  54 {
  55         ui_manager = UIManager::create ();
  56
  57         try {
  58                 ui_manager->add_ui_from_file (ARDOUR::find_config_file("ardour-menus.xml"));
  59         } catch (Glib::MarkupError& err) {
  60                 error << "badly formatted UI definition file" << endmsg;
  61         } catch (...) {
  62                 error << "Ardour menu definition file not found" << endmsg;
  63         }
  64 }
  65
  66 RefPtr<Action>
  67 ActionManager::register_action (RefPtr<ActionGroup> group, string name, string label, slot<void> sl, guint key, Gdk::ModifierType mods)
  68 {
  69         RefPtr<Action> act = register_action (group, name, label, sl);
  70         AccelMap::add_entry (act->get_accel_path(), key, mods);
  71
  72         return act;
  73 }
  74
  75 RefPtr<Action>
  76 ActionManager::register_action (RefPtr<ActionGroup> group, string name, string label, slot<void> sl)
  77 {
  78         RefPtr<Action> act = register_action (group, name, label);
  79         group->add (act, sl);
  80
  81         return act;
  82 }
  83
  84 RefPtr<Action>
  85 ActionManager::register_action (RefPtr<ActionGroup> group, string name, string label)
  86 {
  87         RefPtr<Action> act;
  88
  89         act = Action::create (name, label);
  90         group->add (act);
  91
  92         return act;
  93 }
  94
  95
  96 RefPtr<Action>
  97 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group rgroup, string name, string label, slot<void> sl, guint key, Gdk::ModifierType mods)
  98 {
  99         RefPtr<Action> act = register_radio_action (group, rgroup, name, label, sl);
 100         AccelMap::add_entry (act->get_accel_path(), key, mods);
 101
 102         return act;
 103 }
 104
 105 RefPtr<Action>
 106 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group rgroup, string name, string label, slot<void> sl)
 107 {
 108         RefPtr<Action> act;
 109
 110         act = RadioAction::create (rgroup, name, label);
 111         group->add (act, sl);
 112
 113         return act;
 114 }
 115
 116
 117 RefPtr<Action>
 118 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, string name, string label, slot<void> sl, guint key, Gdk::ModifierType mods)
 119 {
 120         RefPtr<Action> act = register_toggle_action (group,name, label, sl);
 121         AccelMap::add_entry (act->get_accel_path(), key, mods);
 122
 123         return act;
 124 }
 125
 126 RefPtr<Action>
 127 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, string name, string label, slot<void> sl)
 128 {
 129         RefPtr<Action> act;
 130
 131         act = ToggleAction::create (name, label);
 132         group->add (act, sl);
 133
 134         return act;
 135 }
 136
 137 bool
 138 ActionManager::lookup_entry (const ustring accel_path, Gtk::AccelKey& key)
 139 {
 140         GtkAccelKey gkey;
 141         bool known = gtk_accel_map_lookup_entry (accel_path.c_str(), &gkey);
 142
 143         if (known) {
 144                 key = AccelKey (gkey.accel_key, Gdk::ModifierType (gkey.accel_mods));
 145         } else {
 146                 key = AccelKey (GDK_VoidSymbol, Gdk::ModifierType (0));
 147         }
 148
 149         return known;
 150 }
 151
 152 void
 153 ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
 154 {
 155         ListHandle<RefPtr<ActionGroup> > uim_groups = ui_manager->get_action_groups ();
 156
 157         for (ListHandle<RefPtr<ActionGroup> >::iterator g = uim_groups.begin(); g != uim_groups.end(); ++g) {
 158
 159                 ListHandle<RefPtr<Action> > group_actions = (*g)->get_actions();
 160
 161                 for (ListHandle<RefPtr<Action> >::iterator a = group_actions.begin(); a != group_actions.end(); ++a) {
 162
 163                         ustring accel_path;
 164
 165                         accel_path = (*a)->get_accel_path();
 166
 167                         names.push_back ((*a)->get_name());
 168                         paths.push_back (accel_path);
 169
 170                         AccelKey key;
 171                         bool known = lookup_entry (accel_path, key);
 172
 173                         if (known) {
 174                                 keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
 175                         } else {
 176                                 keys.push_back (unbound_string);
 177                         }
 178
 179                         bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
 180                 }
 181         }
 182 }
 183
 184 void
 185 ActionManager::add_action_group (RefPtr<ActionGroup> grp)
 186 {
 187         ui_manager->insert_action_group (grp);
 188 }
 189
 190 Widget*
 191 ActionManager::get_widget (ustring name)
 192 {
 193         return ui_manager->get_widget (name);
 194 }
 195
 196 RefPtr<Action>
 197 ActionManager::get_action (ustring name)
 198 {
 199         /* the C++ API for functions used here appears to be broken in
 200            gtkmm2.6, so we fall back to the C level.
 201         */
 202
 203         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 204         GList* node;
 205         RefPtr<Action> act;
 206
 207         if (name.substr (0,9) != "<Actions>") {
 208                 error << "badly specified action name: " << name << endmsg;
 209                 return act;
 210         }
 211
 212         ustring::size_type last_slash = name.find_last_of ('/');
 213         ustring group_name = name.substr (10, last_slash - 10);
 214         ustring action_name = name.substr (last_slash+1);
 215
 216         for (node = list; node; node = g_list_next (node)) {
 217
 218                 GtkActionGroup* _ag = (GtkActionGroup*) node->data;
 219
 220                 if (group_name == gtk_action_group_get_name (_ag)) {
 221
 222                         GtkAction* _act;
 223
 224                         if ((_act = gtk_action_group_get_action (_ag, action_name.c_str())) != 0) {
 225                                 act = Glib::wrap (_act);
 226                                 break;
 227                         }
 228                 }
 229         }
 230
 231         return act;
 232 }
 233
 234 void
 235 ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
 236 {
 237         for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
 238                 (*i)->set_sensitive (state);
 239         }
 240 }
 241
 242 void
 243 ActionManager::uncheck_toggleaction (const std::string& actionname)
 244 {
 245         RefPtr<Action> act = get_action (actionname);
 246         if (act) {
 247                 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
 248                 tact->set_active (false);
 249         } else {
 250                 error << "Invalid action name: " << actionname << endmsg;
 251         }
 252 }
 253