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