2 Copyright (C) 2005 Paul Davis
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.
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.
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.
25 #include <gtk/gtkaccelmap.h>
26 #include <gtk/gtkuimanager.h>
27 #include <gtk/gtkactiongroup.h>
29 #include <gtkmm/accelmap.h>
30 #include <gtkmm/uimanager.h>
32 #include <pbd/error.h>
33 #include <pbd/file_utils.h>
35 #include <ardour/ardour.h>
36 #include <ardour/filesystem_paths.h>
46 using namespace ARDOUR;
48 vector<RefPtr<Gtk::Action> > ActionManager::session_sensitive_actions;
49 vector<RefPtr<Gtk::Action> > ActionManager::region_list_selection_sensitive_actions;
50 vector<RefPtr<Gtk::Action> > ActionManager::plugin_selection_sensitive_actions;
51 vector<RefPtr<Gtk::Action> > ActionManager::region_selection_sensitive_actions;
52 vector<RefPtr<Gtk::Action> > ActionManager::track_selection_sensitive_actions;
53 vector<RefPtr<Gtk::Action> > ActionManager::point_selection_sensitive_actions;
54 vector<RefPtr<Gtk::Action> > ActionManager::time_selection_sensitive_actions;
55 vector<RefPtr<Gtk::Action> > ActionManager::line_selection_sensitive_actions;
56 vector<RefPtr<Gtk::Action> > ActionManager::playlist_selection_sensitive_actions;
57 vector<RefPtr<Gtk::Action> > ActionManager::mouse_edit_point_requires_canvas_actions;
59 vector<RefPtr<Gtk::Action> > ActionManager::range_sensitive_actions;
60 vector<RefPtr<Gtk::Action> > ActionManager::jack_sensitive_actions;
61 vector<RefPtr<Gtk::Action> > ActionManager::jack_opposite_sensitive_actions;
62 vector<RefPtr<Gtk::Action> > ActionManager::transport_sensitive_actions;
63 vector<RefPtr<Gtk::Action> > ActionManager::edit_point_in_region_sensitive_actions;
65 RefPtr<UIManager> ActionManager::ui_manager;
66 string ActionManager::unbound_string = "--";
69 ActionManager::init ()
71 ui_manager = UIManager::create ();
75 SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
77 find_file_in_search_path (spath, "ardour.menus", ui_file);
82 ui_manager->add_ui_from_file (ui_file.to_string());
84 } catch (Glib::MarkupError& err) {
85 error << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endmsg;
86 cerr << string_compose (_("badly formatted UI definition file: %1"), err.what()) << endl;
88 error << _("Ardour menu definition file not found") << endmsg;
92 error << _("ardour will not work without a valid ardour.menus file") << endmsg;
98 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
102 act = Action::create (name, label);
103 group->add (act, sl);
109 ActionManager::register_action (RefPtr<ActionGroup> group, const char * name, const char * label)
113 act = Action::create (name, label);
121 ActionManager::register_radio_action (RefPtr<ActionGroup> group, RadioAction::Group& rgroup, const char * name, const char * label, slot<void> sl)
125 act = RadioAction::create (rgroup, name, label);
126 group->add (act, sl);
132 ActionManager::register_toggle_action (RefPtr<ActionGroup> group, const char * name, const char * label, slot<void> sl)
136 act = ToggleAction::create (name, label);
137 group->add (act, sl);
143 ActionManager::lookup_entry (const ustring accel_path, Gtk::AccelKey& key)
146 bool known = gtk_accel_map_lookup_entry (accel_path.c_str(), &gkey);
149 key = AccelKey (gkey.accel_key, Gdk::ModifierType (gkey.accel_mods));
151 key = AccelKey (GDK_VoidSymbol, Gdk::ModifierType (0));
157 struct SortActionsByLabel {
158 bool operator() (Glib::RefPtr<Gtk::Action> a, Glib::RefPtr<Gtk::Action> b) {
159 ustring astr = a->get_accel_path();
160 ustring bstr = b->get_accel_path();
166 ActionManager::get_all_actions (vector<string>& groups, vector<string>& names, vector<AccelKey>& bindings)
168 /* the C++ API for functions used here appears to be broken in
169 gtkmm2.6, so we fall back to the C level.
172 GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
176 for (node = list; node; node = g_list_next (node)) {
178 GtkActionGroup* group = (GtkActionGroup*) node->data;
180 /* first pass: collect them all */
182 typedef std::list<Glib::RefPtr<Gtk::Action> > action_list;
183 action_list the_acts;
185 for (acts = gtk_action_group_list_actions (group); acts; acts = g_list_next (acts)) {
186 GtkAction* action = (GtkAction*) acts->data;
187 the_acts.push_back (Glib::wrap (action, true));
190 /* now sort by label */
192 SortActionsByLabel cmp;
195 for (action_list::iterator a = the_acts.begin(); a != the_acts.end(); ++a) {
197 string accel_path = (*a)->get_accel_path ();
199 groups.push_back (gtk_action_group_get_name(group));
200 names.push_back (accel_path.substr (accel_path.find_last_of ('/') + 1));
203 lookup_entry (accel_path, key);
204 bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
210 ActionManager::get_all_actions (vector<string>& names, vector<string>& paths, vector<string>& keys, vector<AccelKey>& bindings)
212 /* the C++ API for functions used here appears to be broken in
213 gtkmm2.6, so we fall back to the C level.
216 GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
220 for (node = list; node; node = g_list_next (node)) {
222 GtkActionGroup* group = (GtkActionGroup*) node->data;
224 /* first pass: collect them all */
226 typedef std::list<Glib::RefPtr<Gtk::Action> > action_list;
227 action_list the_acts;
229 for (acts = gtk_action_group_list_actions (group); acts; acts = g_list_next (acts)) {
230 GtkAction* action = (GtkAction*) acts->data;
231 the_acts.push_back (Glib::wrap (action, true));
234 /* now sort by label */
236 SortActionsByLabel cmp;
239 for (action_list::iterator a = the_acts.begin(); a != the_acts.end(); ++a) {
241 string accel_path = (*a)->get_accel_path ();
242 ustring label = (*a)->property_label();
244 names.push_back (label);
245 paths.push_back (accel_path);
248 bool known = lookup_entry (accel_path, key);
251 keys.push_back (ui_manager->get_accel_group()->name (key.get_key(), Gdk::ModifierType (key.get_mod())));
253 keys.push_back (unbound_string);
256 bindings.push_back (AccelKey (key.get_key(), Gdk::ModifierType (key.get_mod())));
262 ActionManager::add_action_group (RefPtr<ActionGroup> grp)
264 ui_manager->insert_action_group (grp);
268 ActionManager::get_widget (const char * name)
270 return ui_manager->get_widget (name);
274 ActionManager::get_action (const char* path)
279 if ((_act = gtk_ui_manager_get_action (ui_manager->gobj(), path)) != 0) {
280 return Glib::wrap (_act, true);
287 ActionManager::get_action (const char* group_name, const char* action_name)
289 /* the C++ API for functions used here appears to be broken in
290 gtkmm2.6, so we fall back to the C level.
293 GList* list = gtk_ui_manager_get_action_groups (ui_manager->gobj());
297 for (node = list; node; node = g_list_next (node)) {
299 GtkActionGroup* _ag = (GtkActionGroup*) node->data;
301 if (strcmp (group_name, gtk_action_group_get_name (_ag)) == 0) {
305 if ((_act = gtk_action_group_get_action (_ag, action_name)) != 0) {
306 act = Glib::wrap (_act, true);
316 ActionManager::set_sensitive (vector<RefPtr<Action> >& actions, bool state)
318 for (vector<RefPtr<Action> >::iterator i = actions.begin(); i != actions.end(); ++i) {
319 (*i)->set_sensitive (state);
324 ActionManager::uncheck_toggleaction (const char * name)
326 char *last_slash = strrchr (name, '/');
328 if (last_slash == 0) {
329 fatal << string_compose (_("programmer error: %1 %2"), X_("illegal toggle action name"), name) << endmsg;
334 /* 10 = strlen ("<Actions>/") */
335 size_t len = last_slash - (name + 10);
337 char* group_name = new char[len+1];
338 memcpy (group_name, name + 10, len);
339 group_name[len] = '\0';
341 char* action_name = last_slash + 1;
343 RefPtr<Action> act = get_action (group_name, action_name);
345 RefPtr<ToggleAction> tact = RefPtr<ToggleAction>::cast_dynamic(act);
346 tact->set_active (false);
348 error << string_compose (_("Unknown action name: %1"), name) << endmsg;
351 delete [] group_name;
354 /** Examine the state of a Configuration setting and a toggle action, and toggle the Configuration
355 * setting if its state doesn't match the toggle action.
356 * @param group Action group.
357 * @param action Action name.
358 * @param Method to set the state of the Configuration setting.
359 * @param Method to get the state of the Configuration setting.
362 ActionManager::toggle_config_state (const char* group, const char* action, bool (Configuration::*set)(bool), bool (Configuration::*get)(void) const)
364 Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
366 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
369 bool x = (Config->*get)();
371 if (x != tact->get_active()) {
379 ActionManager::toggle_config_state (const char* group, const char* action, sigc::slot<void> theSlot)
381 Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
383 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
384 if (tact->get_active()) {
391 /** Set the state of a ToggleAction using a particular Configuration get() method
392 * @param group Action group.
393 * @param action Action name.
394 * @param get Method to obtain the state that the ToggleAction should have.
397 ActionManager::map_some_state (const char* group, const char* action, bool (Configuration::*get)() const)
399 Glib::RefPtr<Action> act = ActionManager::get_action (group, action);
401 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
405 bool x = (Config->*get)();
407 if (tact->get_active() != x) {
408 tact->set_active (x);
411 cerr << group << ':' << action << " is not a toggle\n";
414 cerr << group << ':' << action << " not an action\n";