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 vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
  50 vector<RefPtr<Gtk::Action> > ActionManager::edit_cursor_in_region_sensitive_actions;
  51
  52 RefPtr<UIManager> ActionManager::ui_manager;
  53 string ActionManager::unbound_string = "--";
  54
  55 void
  56 ActionManager::init ()
  57 {
  58         ui_manager = UIManager::create ();
  59
  60         try {
  61                 ui_manager->add_ui_from_file (ARDOUR::find_config_file("ardour-menus.xml"));
  62         } catch (Glib::MarkupError& err) {
  63                 error << "badly formatted UI definition file" << endmsg;
  64         } catch (...) {
  65                 error << "Ardour menu definition file not found" << endmsg;
  66         }
  67 }
  68
  69 RefPtr<Action>
  70 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
  71 {
  72         RefPtr<Action> act = register_action (group, name, label, sl);
  73         AccelMap::add_entry (act->get_accel_path(), key, mods);
  74
  75         return act;
  76 }
  77
  78 RefPtr<Action>
  79 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
  80 {
  81         RefPtr<Action> act;
  82
  83         act = Action::create (name, label);
  84         group->add (act, sl);
  85
  86         return act;
  87 }
  88
  89 RefPtr<Action>
  90 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label)
  91 {
  92         RefPtr<Action> act;
  93
  94         act = Action::create (name, label);
  95         group->add (act);
  96
  97         return act;
  98 }
  99
 100
 101 RefPtr<Action>
 102 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group rgroup, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
 103 {
 104         RefPtr<Action> act = register_radio_action (group, rgroup, name, label, sl);
 105         AccelMap::add_entry (act->get_accel_path(), key, mods);
 106
 107         return act;
 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
 122 RefPtr<Action>
 123 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl, guint key, Gdk::ModifierType mods)
 124 {
 125         RefPtr<Action> act = register_toggle_action (group,name, label, sl);
 126         AccelMap::add_entry (act->get_accel_path(), key, mods);
 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 void
 158 ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
 159 {
 160         ListHandle<RefPtr<ActionGroup> > uim_groups = ui_manager->get_action_groups ();
 161
 162         for (ListHandle<RefPtr<ActionGroup> >::iterator g = uim_groups.begin(); g != uim_groups.end(); ++g) {
 163
 164                 ListHandle<RefPtr<Action> > group_actions = (*g)->get_actions();
 165
 166                 for (ListHandle<RefPtr<Action> >::iterator a = group_actions.begin(); a != group_actions.end(); ++a) {
 167
 168                         ustring accel_path;
 169
 170                         accel_path = (*a)->get_accel_path();
 171
 172                         names.push_back ((*a)->get_name());
 173                         paths.push_back (accel_path);
 174
 175                         AccelKey key;
 176                         bool known = lookup_entry (accel_path, key);
 177
 178                         if (known) {
 179                                 keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
 180                         } else {
 181                                 keys.push_back (unbound_string);
 182                         }
 183
 184                         bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
 185                 }
 186         }
 187 }
 188
 189 void
 190 ActionManager::add_action_group (RefPtr<ActionGroup> grp)
 191 {
 192         ui_manager->insert_action_group (grp);
 193 }
 194
 195 Widget*
 196 ActionManager::get_widget (const char * name)
 197 {
 198         return ui_manager->get_widget (name);
 199 }
 200
 201 RefPtr<Action>
 202 ActionManager::get_action (const char * _name)
 203 {
 204         /* the C++ API for functions used here appears to be broken in
 205            gtkmm2.6, so we fall back to the C level.
 206         */
 207
 208         ustring name(_name);
 209         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 210         GList* node;
 211         RefPtr<Action> act;
 212
 213         if (name.substr (0,9) != "<Actions>") {
 214                 error << "badly specified action name: " << name << endmsg;
 215                 return act;
 216         }
 217
 218         ustring::size_type last_slash = name.find_last_of ('/');
 219         ustring group_name = name.substr (10, last_slash - 10);
 220         ustring action_name = name.substr (last_slash+1);
 221
 222         for (node = list; node; node = g_list_next (node)) {
 223
 224                 GtkActionGroup* _ag = (GtkActionGroup*) node->data;
 225
 226                 if (group_name == gtk_action_group_get_name (_ag)) {
 227
 228                         GtkAction* _act;
 229
 230                         if ((_act = gtk_action_group_get_action (_ag, action_name.c_str())) != 0) {
 231                                 act = Glib::wrap (_act);
 232                                 break;
 233                         }
 234                 }
 235         }
 236
 237         return act;
 238 }
 239
 240 void
 241 ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
 242 {
 243         for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
 244                 (*i)->set_sensitive (state);
 245         }
 246 }
 247
 248 void
 249 ActionManager::uncheck_toggleaction (const char * actionname)
 250 {
 251         RefPtr<Action> act = get_action (actionname);
 252         if (act) {
 253                 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
 254                 tact->set_active (false);
 255         } else {
 256                 error << "Invalid action name: " << actionname << endmsg;
 257         }
 258 }
 259