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