Tweak group tabs class hierarchy and offer the same menu in both editor and mixer...
[ardour.git] / gtk2_ardour / editor_snapshots.cc
1 /*
2     Copyright (C) 2000-2009 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 <gtkmm/liststore.h>
21 #include "gtkmm2ext/choice.h"
22 #include "ardour/session.h"
23 #include "ardour/session_state_utils.h"
24 #include "ardour/session_directory.h"
25 #include "editor_snapshots.h"
26 #include "ardour_ui.h"
27 #include "i18n.h"
28 #include "editor.h"
29 #include "utils.h"
30 #include "prompter.h"
31
32 using namespace std;
33 using namespace PBD;
34 using namespace Gtk;
35 using namespace ARDOUR;
36
37 EditorSnapshots::EditorSnapshots (Editor* e)
38         : EditorComponent (e)
39 {
40         _model = ListStore::create (_columns);
41         _display.set_model (_model);
42         _display.append_column (X_("snapshot"), _columns.visible_name);
43         _display.set_name ("SnapshotDisplay");
44         _display.set_size_request (75, -1);
45         _display.set_headers_visible (false);
46         _display.set_reorderable (false);
47         _scroller.add (_display);
48         _scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
49
50         _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorSnapshots::selection_changed));
51         _display.signal_button_press_event().connect (sigc::mem_fun (*this, &EditorSnapshots::button_press), false);
52 }
53
54 void
55 EditorSnapshots::set_session (Session* s)
56 {
57         SessionHandlePtr::set_session (s);
58
59         redisplay ();
60 }
61
62 /** A new snapshot has been selected.
63  */
64 void
65 EditorSnapshots::selection_changed ()
66 {
67         if (_display.get_selection()->count_selected_rows() > 0) {
68
69                 TreeModel::iterator i = _display.get_selection()->get_selected();
70
71                 Glib::ustring snap_name = (*i)[_columns.real_name];
72
73                 if (snap_name.length() == 0) {
74                         return;
75                 }
76
77                 if (_session->snap_name() == snap_name) {
78                         return;
79                 }
80
81                 ARDOUR_UI::instance()->load_session (_session->path(), string (snap_name));
82         }
83 }
84
85 bool
86 EditorSnapshots::button_press (GdkEventButton* ev)
87 {
88         if (ev->button == 3) {
89                 /* Right-click on the snapshot list. Work out which snapshot it
90                    was over. */
91                 Gtk::TreeModel::Path path;
92                 Gtk::TreeViewColumn* col;
93                 int cx;
94                 int cy;
95                 _display.get_path_at_pos ((int) ev->x, (int) ev->y, path, col, cx, cy);
96                 Gtk::TreeModel::iterator iter = _model->get_iter (path);
97                 if (iter) {
98                         Gtk::TreeModel::Row row = *iter;
99                         popup_context_menu (ev->button, ev->time, row[_columns.real_name]);
100                 }
101                 return true;
102         }
103
104         return false;
105 }
106
107
108 /** Pop up the snapshot display context menu.
109  * @param button Button used to open the menu.
110  * @param time Menu open time.
111  * @snapshot_name Name of the snapshot that the menu click was over.
112  */
113 void
114 EditorSnapshots::popup_context_menu (int button, int32_t time, Glib::ustring snapshot_name)
115 {
116         using namespace Menu_Helpers;
117
118         MenuList& items (_menu.items());
119         items.clear ();
120
121         const bool modification_allowed = (_session->snap_name() != snapshot_name && _session->name() != snapshot_name);
122
123         add_item_with_sensitivity (items, MenuElem (_("Remove"), sigc::bind (sigc::mem_fun (*this, &EditorSnapshots::remove), snapshot_name)), modification_allowed);
124
125         add_item_with_sensitivity (items, MenuElem (_("Rename"), sigc::bind (sigc::mem_fun (*this, &EditorSnapshots::rename), snapshot_name)), modification_allowed);
126
127         _menu.popup (button, time);
128 }
129
130 void
131 EditorSnapshots::rename (Glib::ustring old_name)
132 {
133         ArdourPrompter prompter(true);
134
135         string new_name;
136
137         prompter.set_name ("Prompter");
138         prompter.add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
139         prompter.set_prompt (_("New name of snapshot"));
140         prompter.set_initial_text (old_name);
141
142         if (prompter.run() == RESPONSE_ACCEPT) {
143                 prompter.get_result (new_name);
144                 if (new_name.length()) {
145                         _session->rename_state (old_name, new_name);
146                         redisplay ();
147                 }
148         }
149 }
150
151
152 void
153 EditorSnapshots::remove (Glib::ustring name)
154 {
155         vector<string> choices;
156
157         std::string prompt = string_compose (_("Do you really want to remove snapshot \"%1\" ?\n(which cannot be undone)"), name);
158
159         choices.push_back (_("No, do nothing."));
160         choices.push_back (_("Yes, remove it."));
161
162         Gtkmm2ext::Choice prompter (_("Remove snapshot"), prompt, choices);
163
164         if (prompter.run () == 1) {
165                 _session->remove_state (name);
166                 redisplay ();
167         }
168 }
169
170 void
171 EditorSnapshots::redisplay ()
172 {
173         if (_session == 0) {
174                 return;
175         }
176
177         vector<sys::path> state_file_paths;
178
179         get_state_files_in_directory (_session->session_directory().root_path(),
180                                       state_file_paths);
181
182         if (state_file_paths.empty()) {
183                 return;
184         }
185
186         vector<string> state_file_names (get_file_names_no_extension(state_file_paths));
187
188         _model->clear ();
189
190         for (vector<string>::iterator i = state_file_names.begin(); i != state_file_names.end(); ++i)
191         {
192                 string statename = (*i);
193                 TreeModel::Row row = *(_model->append());
194
195                 /* this lingers on in case we ever want to change the visible
196                    name of the snapshot.
197                 */
198
199                 string display_name;
200                 display_name = statename;
201
202                 if (statename == _session->snap_name()) {
203                         _display.get_selection()->select(row);
204                 }
205
206                 row[_columns.visible_name] = display_name;
207                 row[_columns.real_name] = statename;
208         }
209 }
210