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 */
  19
  20 #include <vector>
  21 #include <string>
  22 #include <list>
  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 #include <pbd/file_utils.h>
  33
  34 #include <ardour/ardour.h>
  35 #include <ardour/filesystem_paths.h>
  36
  37 #include "actions.h"
  38 #include "i18n.h"
  39
  40 using namespace std;
  41 using namespace Gtk;
  42 using namespace Glib;
  43 using namespace sigc;
  44 using namespace PBD;
  45 using namespace ARDOUR;
  46
  47 vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
  48 vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
  49 vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
  50 vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
  51 vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
  52 vector<RefPtr<Gtk::Action> > ActionManager::point_selection_sensitive_actions;
  53 vector<RefPtr<Gtk::Action> > ActionManager::time_selection_sensitive_actions;
  54 vector<RefPtr<Gtk::Action> > ActionManager::line_selection_sensitive_actions;
  55 vector<RefPtr<Gtk::Action> > ActionManager::playlist_selection_sensitive_actions;
  56 vector<RefPtr<Gtk::Action> > ActionManager::mouse_edit_point_requires_canvas_actions;
  57
  58 vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
  59 vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
  60 vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
  61 vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
  62 vector<RefPtr<Gtk::Action> > ActionManager::edit_point_in_region_sensitive_actions;
  63
  64 RefPtr<UIManager> ActionManager::ui_manager;
  65 string ActionManager::unbound_string = "--";
  66
  67 void
  68 ActionManager::init ()
  69 {
  70         ui_manager = UIManager::create ();
  71
  72         sys::path ui_file;
  73
  74         SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
  75
  76         find_file_in_search_path (spath, "ardour.menus", ui_file);
  77
  78         bool loaded = false;
  79
  80         try {
  81                 ui_manager->add_ui_from_file (ui_file.to_string());
  82                 loaded = true;
  83         } catch (Glib::MarkupError& err) {
  84                 error << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endmsg;
  85                 cerr << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endl;
  86         } catch (...) {
  87                 error << _("Ardour menu definition file not found") << endmsg;
  88         }
  89
  90         if (!loaded) {
  91                 error << _("ardour will not work without a valid ardour.menus file") << endmsg;
  92                 exit(1);
  93         }
  94 }
  95
  96 RefPtr<Action>
  97 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
  98 {
  99         RefPtr<Action> act;
 100
 101         act = Action::create (name, label);
 102         group->add (act, sl);
 103
 104         return act;
 105 }
 106
 107 RefPtr<Action>
 108 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label)
 109 {
 110         RefPtr<Action> act;
 111
 112         act = Action::create (name, label);
 113         group->add (act);
 114
 115         return act;
 116 }
 117
 118
 119 RefPtr<Action>
 120 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group& rgroup, const char * name, const char * label, slot<void> sl)
 121 {
 122         RefPtr<Action> act;
 123
 124         act = RadioAction::create (rgroup, name, label);
 125         group->add (act, sl);
 126
 127         return act;
 128 }
 129
 130 RefPtr<Action>
 131 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
 132 {
 133         RefPtr<Action> act;
 134
 135         act = ToggleAction::create (name, label);
 136         group->add (act, sl);
 137
 138         return act;
 139 }
 140
 141 bool
 142 ActionManager::lookup_entry (const ustring accel_path, Gtk::AccelKey& key)
 143 {
 144         GtkAccelKey gkey;
 145         bool known = gtk_accel_map_lookup_entry (accel_path.c_str(), &gkey);
 146
 147         if (known) {
 148                 key = AccelKey (gkey.accel_key, Gdk::ModifierType (gkey.accel_mods));
 149         } else {
 150                 key = AccelKey (GDK_VoidSymbol, Gdk::ModifierType (0));
 151         }
 152
 153         return known;
 154 }
 155
 156 struct SortActionsByLabel {
 157     bool operator() (Glib::RefPtr<Gtk::Action> a, Glib::RefPtr<Gtk::Action> b) {
 158             ustring astr = a->get_accel_path();
 159             ustring bstr = b->get_accel_path();
 160             return astr < bstr;
 161     }
 162 };
 163
 164 void
 165 ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
 166 {
 167         /* the C++ API for functions used here appears to be broken in
 168            gtkmm2.6, so we fall back to the C level.
 169         */
 170
 171         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 172         GList* node;
 173         GList* acts;
 174
 175         for (node = list; node; node = g_list_next (node)) {
 176
 177                 GtkActionGroup* group = (GtkActionGroup*) node->data;
 178
 179                 /* first pass: collect them all */
 180
 181                 typedef std::list<Glib::RefPtr<Gtk::Action> > action_list;
 182                 action_list the_acts;
 183
 184                 for (acts = gtk_action_group_list_actions (group); acts; acts = g_list_next (acts)) {
 185                         GtkAction* action = (GtkAction*) acts->data;
 186                         the_acts.push_back (Glib::wrap (action, true));
 187                 }
 188
 189                 /* now sort by label */
 190
 191                 SortActionsByLabel cmp;
 192                 the_acts.sort (cmp);
 193
 194                 for (action_list::iterator a = the_acts.begin(); a != the_acts.end(); ++a) {
 195
 196                         string accel_path = (*a)->get_accel_path ();
 197                         ustring label = (*a)->property_label();
 198
 199                         names.push_back (label);
 200                         paths.push_back (accel_path);
 201
 202                         AccelKey key;
 203                         bool known = lookup_entry (accel_path, key);
 204
 205                         if (known) {
 206                                 keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
 207                         } else {
 208                                 keys.push_back (unbound_string);
 209                         }
 210
 211                         bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
 212                 }
 213         }
 214 }
 215
 216 void
 217 ActionManager::add_action_group (RefPtr<ActionGroup> grp)
 218 {
 219         ui_manager->insert_action_group (grp);
 220 }
 221
 222 Widget*
 223 ActionManager::get_widget (const char * name)
 224 {
 225         return ui_manager->get_widget (name);
 226 }
 227
 228 RefPtr<Action>
 229 ActionManager::get_action (const char* group_name, const char* action_name)
 230 {
 231         /* the C++ API for functions used here appears to be broken in
 232            gtkmm2.6, so we fall back to the C level.
 233         */
 234
 235         GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
 236         GList* node;
 237         RefPtr<Action> act;
 238
 239         for (node = list; node; node = g_list_next (node)) {
 240
 241                 GtkActionGroup* _ag = (GtkActionGroup*) node->data;
 242
 243                 if (strcmp (group_name,  gtk_action_group_get_name (_ag)) == 0) {
 244
 245                         GtkAction* _act;
 246
 247                         if ((_act = gtk_action_group_get_action (_ag, action_name)) != 0) {
 248                                 act = Glib::wrap (_act, true);
 249                                 break;
 250                         }
 251                 }
 252         }
 253
 254         return act;
 255 }
 256
 257 void
 258 ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
 259 {
 260         for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
 261                 (*i)->set_sensitive (state);
 262         }
 263 }
 264
 265 void
 266 ActionManager::uncheck_toggleaction (const char * name)
 267 {
 268         char *last_slash = strrchr (name, '/');
 269
 270         if (last_slash == 0) {
 271                 fatal << string_compose (_("programmer error: %1 %2"), X_("illegal toggle action name"), name) << endmsg;
 272                 /*NOTREACHED*/
 273                 return;
 274         }
 275
 276         /* 10 = strlen ("<Actions>/") */
 277         size_t len = last_slash - (name + 10);
 278
 279         char* group_name = new char[len+1];
 280         memcpy (group_name, name + 10, len);
 281         group_name[len] = '\0';
 282
 283         char* action_name = last_slash + 1;
 284
 285         RefPtr<Action> act = get_action (group_name, action_name);
 286         if (act) {
 287                 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
 288                 tact->set_active (false);
 289         } else {
 290                 error << string_compose (_("Unknown action name: %1"),  name) << endmsg;
 291         }
 292
 293         delete [] group_name;
 294 }
 295
 296 /** Examine the state of a Configuration setting and a toggle action, and toggle the Configuration
 297  * setting if its state doesn't match the toggle action.
 298  * @param group Action group.
 299  * @param action Action name.
 300  * @param Method to set the state of the Configuration setting.
 301  * @param Method to get the state of the Configuration setting.
 302  */
 303 void
 304 ActionManager::toggle_config_state (const char* group, const char* action, bool (Configuration::*set)(bool), bool (Configuration::*get)(void) const)
 305 {
 306         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 307         if (act) {
 308                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 309
 310                 if (tact) {
 311                         bool x = (Config->*get)();
 312
 313                         if (x != tact->get_active()) {
 314                                 (Config->*set) (!x);
 315                         }
 316                 }
 317         }
 318 }
 319
 320 void
 321 ActionManager::toggle_config_state (const char* group, const char* action, sigc::slot<void> theSlot)
 322 {
 323         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 324         if (act) {
 325                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 326                 if (tact->get_active()) {
 327                         theSlot ();
 328                 }
 329         }
 330 }
 331
 332
 333 /** Set the state of a ToggleAction using a particular Configuration get() method
 334  * @param group Action group.
 335  * @param action Action name.
 336  * @param get Method to obtain the state that the ToggleAction should have.
 337  */
 338 void
 339 ActionManager::map_some_state (const char* group, const char* action, bool (Configuration::*get)() const)
 340 {
 341         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 342         if (act) {
 343                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 344
 345                 if (tact) {
 346
 347                         bool x = (Config->*get)();
 348
 349                         if (tact->get_active() != x) {
 350                                 tact->set_active (x);
 351                         }
 352                 } else {
 353                         cerr << group << ':' << action << " is not a toggle\n";
 354                 }
 355         } else {
 356                 cerr << group << ':' << action << " not an action\n";
 357         }
 358 }