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