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