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