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