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 <cstring>
  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 #include "ardour/rc_configuration.h"
  37
  38 #include "gtkmm2ext/actions.h"
  39
  40 #include "utils.h"
  41 #include "actions.h"
  42 #include "i18n.h"
  43
  44 using namespace std;
  45 using namespace Gtk;
  46 using namespace Glib;
  47 using namespace PBD;
  48 using namespace ARDOUR;
  49
  50 vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
  51 vector<RefPtr<Gtk::Action> > ActionManager::write_sensitive_actions;
  52 vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
  53 vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
  54 vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
  55 vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
  56 vector<RefPtr<Gtk::Action> > ActionManager::point_selection_sensitive_actions;
  57 vector<RefPtr<Gtk::Action> > ActionManager::time_selection_sensitive_actions;
  58 vector<RefPtr<Gtk::Action> > ActionManager::line_selection_sensitive_actions;
  59 vector<RefPtr<Gtk::Action> > ActionManager::playlist_selection_sensitive_actions;
  60 vector<RefPtr<Gtk::Action> > ActionManager::mouse_edit_point_requires_canvas_actions;
  61
  62 vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
  63 vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
  64 vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
  65 vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
  66 vector<RefPtr<Gtk::Action> > ActionManager::edit_point_in_region_sensitive_actions;
  67
  68
  69 void
  70 ActionManager::init ()
  71 {
  72         ui_manager = UIManager::create ();
  73
  74         sys::path ui_file;
  75
  76         SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
  77
  78         find_file_in_search_path (spath, "ardour.menus", ui_file);
  79
  80         bool loaded = false;
  81
  82         try {
  83                 ui_manager->add_ui_from_file (ui_file.to_string());
  84                 info << string_compose (_("Loading menus from %1"), ui_file.to_string()) << endmsg;
  85                 loaded = true;
  86         } catch (Glib::MarkupError& err) {
  87                 error << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endmsg;
  88                 cerr << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endl;
  89         } catch (...) {
  90                 error << string_compose (_("%1 menu definition file not found"), PROGRAM_NAME) << endmsg;
  91         }
  92
  93         if (!loaded) {
  94                 cerr << string_compose (_("%1 will not work without a valid ardour.menus file"), PROGRAM_NAME) << endl;
  95                 error << string_compose (_("%1 will not work without a valid ardour.menus file"), PROGRAM_NAME) << endmsg;
  96                 exit(1);
  97         }
  98 }
  99
 100 /** Examine the state of a Configuration setting and a toggle action, and toggle the Configuration
 101  * setting if its state doesn't match the toggle action.
 102  * @param group Action group.
 103  * @param action Action name.
 104  * @param Method to set the state of the Configuration setting.
 105  * @param Method to get the state of the Configuration setting.
 106  */
 107 void
 108 ActionManager::toggle_config_state (const char* group, const char* action, bool (RCConfiguration::*set)(bool), bool (RCConfiguration::*get)(void) const)
 109 {
 110         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 111
 112         if (act) {
 113                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 114
 115                 if (tact) {
 116                         bool x = (Config->*get)();
 117
 118                         if (x != tact->get_active()) {
 119                                 (Config->*set) (!x);
 120                         }
 121                 }
 122         }
 123 }
 124
 125 void
 126 ActionManager::toggle_config_state_foo (const char* group, const char* action, sigc::slot<bool, bool> set, sigc::slot<bool> get)
 127 {
 128         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 129
 130         if (act) {
 131                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 132
 133                 if (tact) {
 134                         bool const x = get ();
 135
 136                         if (x != tact->get_active ()) {
 137                                 set (!x);
 138                         }
 139                 }
 140         }
 141 }
 142
 143
 144 /** Set the state of a ToggleAction using a particular Configuration get() method
 145  * @param group Action group.
 146  * @param action Action name.
 147  * @param get Method to obtain the state that the ToggleAction should have.
 148  */
 149 void
 150 ActionManager::map_some_state (const char* group, const char* action, bool (RCConfiguration::*get)() const)
 151 {
 152         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 153         if (act) {
 154                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 155
 156                 if (tact) {
 157
 158                         bool x = (Config->*get)();
 159
 160                         if (tact->get_active() != x) {
 161                                 tact->set_active (x);
 162                         }
 163                 } else {
 164                         cerr << group << ':' << action << " is not a toggle\n";
 165                 }
 166         } else {
 167                 cerr << group << ':' << action << " not an action\n";
 168         }
 169 }
 170
 171 void
 172 ActionManager::map_some_state (const char* group, const char* action, sigc::slot<bool> get)
 173 {
 174         Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
 175         if (act) {
 176                 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
 177
 178                 if (tact) {
 179
 180                         bool const x = get ();
 181
 182                         if (tact->get_active() != x) {
 183                                 tact->set_active (x);
 184                         }
 185                 }
 186         }
 187 }
 188
 189 string
 190 ActionManager::get_key_representation (const string& accel_path, AccelKey& key)
 191 {
 192         bool known = lookup_entry (accel_path, key);
 193
 194         if (known) {
 195                 uint32_t k = possibly_translate_legal_accelerator_to_real_key (key.get_key());
 196                 key = AccelKey (k, Gdk::ModifierType (key.get_mod()));
 197                 return ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod()));
 198         }
 199
 200         return unbound_string;
 201 }