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