(1) use select next/previous row functions for tab/shift-tab navigation in region...
[ardour.git] / gtk2_ardour / editor_regions.cc
1 /*
2     Copyright (C) 2000-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 <cstdlib>
21 #include <cmath>
22 #include <algorithm>
23 #include <string>
24 #include <sstream>
25
26 #include "pbd/basename.h"
27 #include "pbd/enumwriter.h"
28
29 #include "ardour/audioregion.h"
30 #include "ardour/audiofilesource.h"
31 #include "ardour/region_factory.h"
32 #include "ardour/session.h"
33 #include "ardour/session_playlists.h"
34 #include "ardour/silentfilesource.h"
35 #include "ardour/profile.h"
36
37 #include "gtkmm2ext/treeutils.h"
38
39 #include "editor.h"
40 #include "editing.h"
41 #include "keyboard.h"
42 #include "ardour_ui.h"
43 #include "gui_thread.h"
44 #include "actions.h"
45 #include "region_view.h"
46 #include "utils.h"
47 #include "editor_regions.h"
48 #include "editor_drag.h"
49
50 #include "i18n.h"
51
52 using namespace std;
53 using namespace ARDOUR;
54 using namespace PBD;
55 using namespace Gtk;
56 using namespace Glib;
57 using namespace Editing;
58 using Gtkmm2ext::Keyboard;
59
60 EditorRegions::EditorRegions (Editor* e)
61         : EditorComponent (e)
62         , _menu (0)
63         , _show_automatic_regions (true)
64         , _sort_type ((Editing::RegionListSortType) 0)
65         , _no_redisplay (false) 
66         , ignore_region_list_selection_change (false)
67         , ignore_selected_region_change (false)
68         , expanded (false)
69 {
70         _display.set_size_request (100, -1);
71         _display.set_name ("RegionListDisplay");
72         _display.set_rules_hint (true);
73         /* Try to prevent single mouse presses from initiating edits.
74            This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
75         */
76         _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
77
78         _model = TreeStore::create (_columns);
79         _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
80         _model->set_sort_column (0, SORT_ASCENDING);
81
82         _display.set_model (_model);
83
84         _display.append_column (_("Regions"), _columns.name);
85         _display.append_column (_("Position"), _columns.position);
86         _display.append_column (_("End"), _columns.end);
87         _display.append_column (_("Length"), _columns.length);
88         _display.append_column (_("Start"), _columns.start);
89         _display.append_column (_("Sync"), _columns.sync);
90         _display.append_column (_("Fade In"), _columns.fadein);
91         _display.append_column (_("Fade Out"), _columns.fadeout);
92         _display.append_column (_("L"), _columns.locked);
93         _display.append_column (_("G"), _columns.glued);
94         _display.append_column (_("M"), _columns.muted);
95         _display.append_column (_("O"), _columns.opaque);
96         // _display.append_column (_("Used"), _columns.used);
97         // _display.append_column (_("Path"), _columns.path);
98         _display.set_headers_visible (true);
99         //_display.set_grid_lines (TREE_VIEW_GRID_LINES_BOTH);
100
101         /* show path as the row tooltip */
102         _display.set_tooltip_column (15); /* path */
103
104         CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
105         region_name_cell->property_editable() = true;
106         region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
107
108         _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
109
110         TreeViewColumn* tv_col = _display.get_column(0);
111         CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
112         tv_col->add_attribute(renderer->property_text(), _columns.name);
113         tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
114
115         CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
116         locked_cell->property_activatable() = true;
117         locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
118         TreeViewColumn* locked_col = _display.get_column (8);
119         locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
120
121         CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
122         glued_cell->property_activatable() = true;
123         glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
124         TreeViewColumn* glued_col = _display.get_column (9);
125         glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
126
127         CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
128         muted_cell->property_activatable() = true;
129         muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
130         TreeViewColumn* muted_col = _display.get_column (10);
131         muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
132
133         CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (11));
134         opaque_cell->property_activatable() = true;
135         opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
136         TreeViewColumn* opaque_col = _display.get_column (11);
137         opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
138         
139         _display.get_selection()->set_mode (SELECTION_MULTIPLE);
140         _display.add_object_drag (_columns.region.index(), "regions");
141
142         /* setup DnD handling */
143
144         list<TargetEntry> region_list_target_table;
145
146         region_list_target_table.push_back (TargetEntry ("text/plain"));
147         region_list_target_table.push_back (TargetEntry ("text/uri-list"));
148         region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
149
150         _display.add_drop_targets (region_list_target_table);
151         _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
152
153         _scroller.add (_display);
154         _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
155
156         _display.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
157         _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
158         _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
159         // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
160
161         //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
162         ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
163         ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
164         ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::add_region, this, _1), gui_context());
165 }
166
167 void
168 EditorRegions::set_session (ARDOUR::Session* s)
169 {
170         SessionHandlePtr::set_session (s);
171         redisplay ();
172 }
173
174 void
175 EditorRegions::add_regions (vector<boost::shared_ptr<Region> >& regions)
176 {
177         for (vector<boost::shared_ptr<Region> >::iterator x = regions.begin(); x != regions.end(); ++x) {
178                 add_region (*x);
179         }
180 }
181
182 void
183 EditorRegions::add_region (boost::shared_ptr<Region> region)
184 {
185         if (!region || !_session) {
186                 return;
187         }
188
189         string str;
190         TreeModel::Row row;
191         Gdk::Color c;
192         bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source());
193
194         if (!_show_automatic_regions && region->automatic()) {
195                 return;
196         }
197
198         if (region->hidden()) {
199                 TreeModel::iterator iter = _model->get_iter ("0");
200                 TreeModel::Row parent;
201                 TreeModel::Row child;
202
203                 if (!iter) {
204                         parent = *(_model->append());
205                         parent[_columns.name] = _("Hidden");
206                         boost::shared_ptr<Region> proxy = parent[_columns.region];
207                         proxy.reset ();
208                 } else {
209                         string s = (*iter)[_columns.name];
210                         if (s != _("Hidden")) {
211                                 parent = *(_model->insert(iter));
212                                 parent[_columns.name] = _("Hidden");
213                                 boost::shared_ptr<Region> proxy = parent[_columns.region];
214                                 proxy.reset ();
215                         } else {
216                                 parent = *iter;
217                         }
218                 }
219                 row = *(_model->append (parent.children()));
220
221         } else if (region->whole_file()) {
222
223                 TreeModel::iterator i;
224                 TreeModel::Children rows = _model->children();
225
226                 for (i = rows.begin(); i != rows.end(); ++i) {
227                         boost::shared_ptr<Region> rr = (*i)[_columns.region];
228
229                         if (rr && region->region_list_equivalent (rr)) {
230                                 return;
231                         }
232                 }
233
234                 row = *(_model->append());
235
236                 if (missing_source) {
237                         c.set_rgb(65535,0,0);     // FIXME: error color from style
238
239                 } else if (region->automatic()){
240                         c.set_rgb(0,65535,0);     // FIXME: error color from style
241
242                 } else {
243                         set_color(c, rgba_from_style ("RegionListWholeFile", 0xff, 0, 0, 0, "fg", Gtk::STATE_NORMAL, false ));
244
245                 }
246
247                 row[_columns.color_] = c;
248
249                 if (region->source()->name()[0] == '/') { // external file
250
251                         if (region->whole_file()) {
252
253                                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
254                                 str = ".../";
255
256                                 if (afs) {
257                                         str = region_name_from_path (afs->path(), region->n_channels() > 1);
258                                 } else {
259                                         str += region->source()->name();
260                                 }
261
262                         } else {
263                                 str = region->name();
264                         }
265
266                 } else {
267                         str = region->name();
268                 }
269
270                 if (region->n_channels() > 1) {
271                         std::stringstream foo;
272                         foo << region->n_channels ();
273                         str += " [";
274                         str += foo.str();
275                         str += "]";
276                 }
277
278                 row[_columns.name] = str;
279                 row[_columns.region] = region;
280                 row[_columns.property_toggles_visible] = false;
281
282                 if (missing_source) {
283                         row[_columns.path] = _("(MISSING) ") + region->source()->name();
284
285                 } else {
286                         boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
287                         if (fs) {
288                                 row[_columns.path] = fs->path();
289                         } else {
290                                 row[_columns.path] = region->source()->name();
291                         }
292                 }
293
294                 if (region->automatic()) {
295                         return;
296                 }
297
298         } else {
299
300                 /* find parent node, add as new child */
301
302                 TreeModel::iterator i;
303                 TreeModel::Children rows = _model->children();
304                 bool found_parent = false;
305
306                 for (i = rows.begin(); i != rows.end(); ++i) {
307                         boost::shared_ptr<Region> r = (*i)[_columns.region];
308
309                         if (r && r->whole_file()) {
310
311                                 if (region->source_equivalent (r)) {
312                                         found_parent = true;
313                                 }
314                         }
315                         
316                         TreeModel::iterator ii;
317                         TreeModel::Children subrows = (*i).children();
318
319                         for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
320                                 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
321
322                                 if (region->region_list_equivalent (rr)) {
323                                         return;
324                                 }
325                         }
326
327                         if (found_parent) {
328                                 row = *(_model->append ((*i).children()));
329                                 break;
330                         }
331                 }
332
333                 if (!found_parent) {
334                         row = *(_model->append());
335                 }
336
337                 row[_columns.property_toggles_visible] = true;
338         }
339
340         row[_columns.region] = region;
341
342         populate_row(region, (*row));
343 }
344
345 void
346 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
347 {
348         PropertyChange our_interests;
349
350         our_interests.add (ARDOUR::Properties::name);
351         our_interests.add (ARDOUR::Properties::position);
352         our_interests.add (ARDOUR::Properties::length);
353         our_interests.add (ARDOUR::Properties::start);
354         our_interests.add (ARDOUR::Properties::locked);
355         our_interests.add (ARDOUR::Properties::position_lock_style);
356         our_interests.add (ARDOUR::Properties::muted);
357         our_interests.add (ARDOUR::Properties::opaque);
358         our_interests.add (ARDOUR::Properties::fade_in);
359         our_interests.add (ARDOUR::Properties::fade_out);
360         
361         if (last_row != 0) {
362
363                 TreeModel::iterator j = _model->get_iter (last_row.get_path());
364                 boost::shared_ptr<Region> c = (*j)[_columns.region];
365
366                 if (c == r) {
367                         populate_row (r, (*j));
368                         
369                         if (what_changed.contains (ARDOUR::Properties::hidden)) {
370                                 redisplay ();
371                         }
372                         
373                         return;
374                 }
375         }
376
377
378         if (what_changed.contains (our_interests)) {
379
380                 /* find the region in our model and update its row */
381                 TreeModel::Children rows = _model->children ();
382                 TreeModel::iterator i = rows.begin ();
383                 
384                 while (i != rows.end ()) {
385                         
386                         TreeModel::Children children = (*i)->children ();
387                         TreeModel::iterator j = children.begin ();
388                         
389                         while (j != children.end()) {
390                           
391                                 boost::shared_ptr<Region> c = (*j)[_columns.region];
392                         
393                                 if (c == r) {
394                                         last_row = TreeRowReference(_model, TreePath(j));
395                                         break;
396                                 }
397                                 ++j;
398                         }
399
400                         if (j != children.end()) {
401
402                                 boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(r);
403                                 uint32_t used = _editor->get_regionview_count_from_region_list (r);
404
405                                 if (what_changed.contains (ARDOUR::Properties::name)) {
406                                         populate_row_name (r, *j);
407                                 }
408                                 if (what_changed.contains (ARDOUR::Properties::position)) {
409                                         populate_row_position (r, *j, used);
410                                         populate_row_end (r, *j, used);
411                                 }
412                                 if (what_changed.contains (ARDOUR::Properties::length)) {
413                                         populate_row_end (r, *j, used);
414                                         populate_row_length (r, *j);
415                                 }
416                                 if (what_changed.contains (ARDOUR::Properties::start)) {
417                                         populate_row_start (r, *j, used);
418                                         populate_row_length (r, *j);
419                                 }
420                                 if (what_changed.contains (ARDOUR::Properties::locked)) {
421                                         populate_row_locked (r, *j, used);
422                                 }
423                                 if (what_changed.contains (ARDOUR::Properties::position_lock_style)) {
424                                         populate_row_glued (r, *j, used);
425                                 }
426                                 if (what_changed.contains (ARDOUR::Properties::muted)) {
427                                         populate_row_muted (r, *j, used);
428                                 }
429                                 if (what_changed.contains (ARDOUR::Properties::opaque)) {
430                                         populate_row_opaque (r, *j, used);
431                                 }
432                                 if (what_changed.contains (ARDOUR::Properties::fade_in)) {
433                                         populate_row_fade_in (r, *j, used, audioregion);
434                                 }
435                                 if (what_changed.contains (ARDOUR::Properties::fade_out)) {
436                                         populate_row_fade_out (r, *j, used, audioregion);
437                                 }
438
439                                 break;
440                         }
441
442                         ++i;
443                 }
444         }
445
446         if (what_changed.contains (ARDOUR::Properties::hidden)) {
447                 redisplay ();
448         }
449 }
450
451 void
452 EditorRegions::selection_changed ()
453 {
454         if (ignore_region_list_selection_change) {
455                 return;
456         }
457
458         _editor->_region_selection_change_updates_region_list = false;
459
460         if (_display.get_selection()->count_selected_rows() > 0) {
461
462                 TreeIter iter;
463                 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
464
465                 _editor->get_selection().clear_regions ();
466
467                 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
468
469                         if (iter = _model->get_iter (*i)) { 
470                                 boost::shared_ptr<Region> region = (*iter)[_columns.region];
471
472                                 // they could have clicked on a row that is just a placeholder, like "Hidden"
473                                 // although that is not allowed by our selection filter. check it anyway
474                                 // since we need a region ptr.
475
476                                 if (region) {
477                                         
478                                         if (region->automatic()) {
479
480                                                 _display.get_selection()->unselect(*i);
481
482                                         } else {
483                                                 _change_connection.block (true);
484                                                 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
485
486                                                 _change_connection.block (false);
487                                         }
488                                 }
489                         }
490                 }
491         } else {
492                 _editor->get_selection().clear_regions ();
493         }
494
495         _editor->_region_selection_change_updates_region_list = true;
496 }
497
498 void
499 EditorRegions::set_selected (RegionSelection& regions)
500 {
501         TreeModel::Children rows = _model->children();
502
503         for (RegionSelection::iterator iter = regions.begin(); iter != regions.end(); ++iter) {
504
505                 TreeModel::iterator i;
506                 
507                 boost::shared_ptr<Region> r ((*iter)->region());
508
509                 for (i = rows.begin(); i != rows.end(); ++i) {
510
511                         boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
512
513                         if (r == compared_region) {
514                                 _display.get_selection()->select(*i);
515                                 break;
516                         }
517
518                         if (!(*i).children().empty()) {
519                                 if (set_selected_in_subrow(r, (*i), 2)) {
520                                         break;
521                                 }
522                         }
523                 }
524         }
525 }
526
527 bool
528 EditorRegions::set_selected_in_subrow (boost::shared_ptr<Region> region, TreeModel::Row const &parent_row, int level)
529 {
530         TreeModel::iterator i;
531         TreeModel::Children subrows = (*parent_row).children();
532
533         for (i = subrows.begin(); i != subrows.end(); ++i) {
534
535                 boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
536
537                 if (region == compared_region) {
538                         _display.get_selection()->select(*i);
539                         return true;
540                 }
541
542                 if (!(*i).children().empty()) {
543                         if (set_selected_in_subrow (region, (*i), level + 1)) {
544                                 return true;
545                         }
546                 }
547         }
548         
549         return false;
550 }
551
552 void
553 EditorRegions::insert_into_tmp_regionlist(boost::shared_ptr<Region> region)
554 {
555         /* keep all whole files at the beginning */
556
557         if (region->whole_file()) {
558                 tmp_region_list.push_front (region);
559         } else {
560                 tmp_region_list.push_back (region);
561         }
562 }
563
564 void
565 EditorRegions::redisplay ()
566 {
567         if (_no_redisplay || !_session) {
568                 return;
569         }
570
571         bool tree_expanded = false;
572
573         /* If the list was expanded prior to rebuilding, expand it again afterwards */
574         if (toggle_full_action()->get_active()) {
575                 tree_expanded = true;
576         }
577
578         _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
579         _model->clear ();
580
581         /* now add everything we have, via a temporary list used to help with sorting */
582
583         tmp_region_list.clear();
584
585         const RegionFactory::RegionMap& regions (RegionFactory::regions());
586         for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
587                 insert_into_tmp_regionlist (i->second);
588         }
589
590         for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
591                 add_region (*r);
592         }
593         tmp_region_list.clear();
594
595         _display.set_model (_model);
596
597         if (tree_expanded) {
598                 _display.expand_all();
599         }
600 }
601
602 void
603 EditorRegions::update_row (boost::shared_ptr<Region> region)
604 {
605         if (!region || !_session) {
606                 return;
607         }
608
609         TreeModel::iterator i;
610         TreeModel::Children rows = _model->children();
611         
612         return;
613
614         for (i = rows.begin(); i != rows.end(); ++i) {
615
616 //              cerr << "Level 1: Compare " << region->name() << " with parent " << (*i)[_columns.name] << "\n";
617
618                 boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
619
620                 if (region == compared_region) {
621 //                      cerr << "Matched\n";
622                         populate_row(region, (*i));
623                         return;
624                 }
625
626                 if (!(*i).children().empty()) {
627                         if (update_subrows(region, (*i), 2)) {
628                                 return;
629                         }
630                 }
631         }
632
633 //      cerr << "Returning - No match\n";
634 }
635
636 bool
637 EditorRegions::update_subrows (boost::shared_ptr<Region> region, TreeModel::Row const &parent_row, int level)
638 {
639         TreeModel::iterator i;
640         TreeModel::Children subrows = (*parent_row).children();
641
642         for (i = subrows.begin(); i != subrows.end(); ++i) {
643
644 //              cerr << "Level " << level << ": Compare " << region->name() << " with child " << (*i)[_columns.name] << "\n";
645
646                 boost::shared_ptr<Region> compared_region = (*i)[_columns.region];
647
648                 if (region == compared_region) {
649                         populate_row(region, (*i));
650 //                      cerr << "Matched\n";
651                         return true;
652                 }
653
654                 if (!(*i).children().empty()) {
655                         if (update_subrows (region, (*i), level + 1)) {
656                                 return true;
657                         }
658                 }
659         }
660
661         return false;
662 }
663
664 void
665 EditorRegions::update_all_rows ()
666 {
667         if (!_session) {
668                 return;
669         }
670         
671         TreeModel::iterator i;
672         TreeModel::Children rows = _model->children();
673
674         for (i = rows.begin(); i != rows.end(); ++i) {
675
676                 boost::shared_ptr<Region> region = (*i)[_columns.region];
677
678                 if (!region->automatic()) {
679                         populate_row(region, (*i));
680                 }
681
682                 if (!(*i).children().empty()) {
683                         update_all_subrows ((*i), 2);
684                 }
685         }
686 }
687
688 void
689 EditorRegions::update_all_subrows (TreeModel::Row const &parent_row, int level)
690 {
691         TreeModel::iterator i;
692         TreeModel::Children subrows = (*parent_row).children();
693
694         for (i = subrows.begin(); i != subrows.end(); ++i) {
695
696                 boost::shared_ptr<Region> region = (*i)[_columns.region];
697
698                 if (!region->automatic()) {
699                         populate_row(region, (*i));
700                 }
701
702                 if (!(*i).children().empty()) {
703                         update_all_subrows ((*i), level + 1);
704                 }
705         }
706 }
707
708 void
709 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize)
710 {
711         BBT_Time bbt;
712         Timecode::Time timecode;
713
714         switch (ARDOUR_UI::instance()->secondary_clock.mode ()) {
715         case AudioClock::BBT:
716                 _session->tempo_map().bbt_time (pos, bbt);
717                 snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
718                 break;
719
720         case AudioClock::MinSec:
721                 framepos_t left;
722                 int hrs;
723                 int mins;
724                 float secs;
725
726                 left = pos;
727                 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
728                 left -= (nframes_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
729                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
730                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
731                 secs = left / (float) _session->frame_rate();
732                 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
733                 break;
734
735         case AudioClock::Frames:
736                 snprintf (buf, bufsize, "%" PRId64, pos);
737                 break;
738
739         case AudioClock::Timecode:
740         case AudioClock::Off: /* If the secondary clock is off, default to Timecode */
741         default:
742                 _session->timecode_time (pos, timecode);
743                 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
744                 break;
745         }
746 }
747
748 void
749 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
750 {
751         boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
752         uint32_t used = _session->playlists->region_use_count (region);
753
754         populate_row_position (region, row, used);
755         populate_row_end (region, row, used);
756         populate_row_start (region, row, used);
757         populate_row_sync (region, row, used);
758         populate_row_fade_in (region, row, used, audioregion);
759         populate_row_fade_out (region, row, used, audioregion);
760         populate_row_locked (region, row, used);
761         populate_row_glued (region, row, used);
762         populate_row_muted (region, row, used);
763         populate_row_opaque (region, row, used);
764         populate_row_length (region, row);
765         populate_row_source (region, row);
766         populate_row_name (region, row);
767         populate_row_used (region, row, used);
768 }
769
770 #if 0
771         if (audioRegion && fades_in_seconds) {
772
773                 nframes_t left;
774                 int mins;
775                 int millisecs;
776
777                 left = audioRegion->fade_in()->back()->when;
778                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
779                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
780                 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
781
782                 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
783                         sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
784                 } else {
785                         sprintf (fadein_str, "%01dmS", millisecs);
786                 }
787
788                 left = audioRegion->fade_out()->back()->when;
789                 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
790                 left -= (nframes_t) floor (mins * _session->frame_rate() * 60.0f);
791                 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
792
793                 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
794                         sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
795                 } else {
796                         sprintf (fadeout_str, "%01dmS", millisecs);
797                 }
798         }
799 #endif
800
801 void
802 EditorRegions::populate_row_used (boost::shared_ptr<Region> region, TreeModel::Row const& row, uint32_t used)
803 {
804         char buf[8];
805         snprintf (buf, sizeof (buf), "%4d" , used);
806         row[_columns.used] = buf;
807 }
808
809 void
810 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
811 {
812         char buf[16];
813         format_position (region->length(), buf, sizeof (buf));
814         row[_columns.length] = buf;
815 }
816
817 void
818 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
819 {
820         if (region->whole_file()) {
821                 row[_columns.end] = "";
822         } else if (used > 1) {
823                 row[_columns.end] = _("Mult.");
824         } else {
825                 char buf[16];
826                 format_position (region->last_frame(), buf, sizeof (buf));
827                 row[_columns.end] = buf;
828         }
829 }
830
831 void
832 EditorRegions::populate_row_start (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
833 {
834         if (region->whole_file()) {
835                 row[_columns.start] = "";
836         } else if (used > 1) {
837                 row[_columns.start] = _("Mult.");
838         } else {
839                 char buf[16];
840                 format_position (region->start(), buf, sizeof (buf));
841                 row[_columns.start] = buf;
842         }
843 }
844
845 void
846 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
847 {
848         if (region->whole_file()) {
849                 row[_columns.position] = "";
850         } else if (used > 1) {
851                 row[_columns.position] = _("Mult.");
852         } else {
853                 char buf[16];
854                 format_position (region->position(), buf, sizeof (buf));
855                 row[_columns.position] = buf;
856         }
857 }
858
859 void
860 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
861 {
862         if (region->whole_file()) {
863                 row[_columns.sync] = "";
864         } else if (used > 1) {
865                 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
866         } else {
867                 if (region->sync_position() == region->position()) {
868                         row[_columns.sync] = _("Start");
869                 } else if (region->sync_position() == (region->last_frame())) {
870                         row[_columns.sync] = _("End");
871                 } else {
872                         char buf[16];
873                         format_position (region->sync_position(), buf, sizeof (buf));
874                         row[_columns.sync] = buf;
875                 }
876         }
877 }
878
879 void
880 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
881 {
882         if (!audioregion || region->whole_file()) {
883                         row[_columns.fadein] = "";
884         } else {
885                 if (used > 1) {
886                         row[_columns.fadein] = _("Multiple");
887                 } else {
888
889                         char buf[16];
890                         format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf));
891                         row[_columns.fadein] = buf;
892                         
893                         if (audioregion->fade_in_active()) {
894                                 row[_columns.fadein] = string_compose("%1%2%3", " ", buf, " ");
895                         } else {
896                                 row[_columns.fadein] = string_compose("%1%2%3", "(", buf, ")");
897                         }
898                 }
899         }
900 }
901
902 void
903 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
904 {
905         if (!audioregion || region->whole_file()) {
906                 row[_columns.fadeout] = "";
907         } else {
908                 if (used > 1) {
909                         row[_columns.fadeout] = _("Multiple");
910                 } else {
911                         char buf[16];
912                         format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf));
913                         
914                         if (audioregion->fade_out_active()) {
915                                 row[_columns.fadeout] = string_compose("%1%2%3", " ", buf, " ");
916                         } else {
917                                 row[_columns.fadeout] = string_compose("%1%2%3", "(", buf, ")");
918                         }
919                 } 
920         }
921 }
922         
923 void
924 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
925 {
926         if (region->whole_file()) {
927                 row[_columns.locked] = false;
928         } else if (used > 1) {
929                 row[_columns.locked] = false;
930         } else {
931                 row[_columns.locked] = region->locked();
932         }
933 }
934
935 void
936 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
937 {
938         if (region->whole_file() || used > 1) {
939                 row[_columns.glued] = false;
940         } else {
941                 if (region->position_lock_style() == MusicTime) {
942                         row[_columns.glued] = true;
943                 } else {
944                         row[_columns.glued] = false;
945                 }
946         }
947 }
948
949 void
950 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
951 {
952         if (region->whole_file() || used > 1) {
953                 row[_columns.muted] = false;
954         } else {
955                 row[_columns.muted] = region->muted();
956         }
957 }
958
959 void
960 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
961 {
962         if (region->whole_file() || used > 1) {
963                 row[_columns.opaque] = false;
964         } else {
965                 row[_columns.opaque] = region->opaque();
966         }
967 }
968
969 void
970 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
971 {
972         if (region->n_channels() > 1) {
973                 row[_columns.name] = string_compose("%1  [%2]", region->name(), region->n_channels());
974         } else {
975                 row[_columns.name] = region->name();
976         }
977 }        
978
979 void
980 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
981 {
982         if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
983                 row[_columns.path] = _("MISSING ") + region->source()->name();
984         } else {
985                 row[_columns.path] = region->source()->name();
986         }
987 }
988
989 void
990 EditorRegions::toggle_show_auto_regions ()
991 {
992         _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
993         redisplay ();
994 }
995
996 void
997 EditorRegions::toggle_full ()
998 {
999         set_full (toggle_full_action()->get_active ());
1000 }
1001
1002 void
1003 EditorRegions::set_full (bool f)
1004 {
1005         if (f) {
1006                 _display.expand_all ();
1007                 expanded = true;
1008         } else {
1009                 _display.collapse_all ();
1010                 expanded = false;
1011         }
1012 }
1013
1014 void
1015 EditorRegions::show_context_menu (int button, int time)
1016 {
1017         if (_menu == 0) {
1018                 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
1019         }
1020
1021         if (_display.get_selection()->count_selected_rows() > 0) {
1022                 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
1023         } else {
1024                 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
1025         }
1026
1027         /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
1028
1029         bool have_shown = false;
1030         bool have_hidden = false;
1031         
1032         TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1033         for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1034                 TreeIter t = _model->get_iter (*i);
1035                 boost::shared_ptr<Region> r = (*t)[_columns.region];
1036                 if (r) {
1037                         if (r->hidden ()) {
1038                                 have_hidden = true;
1039                         } else {
1040                                 have_shown = true;
1041                         }
1042                 }
1043         }
1044
1045         hide_action()->set_sensitive (have_shown);
1046         show_action()->set_sensitive (have_hidden);
1047
1048         _menu->popup (button, time);
1049 }
1050
1051 bool
1052 EditorRegions::key_press (GdkEventKey* ev)
1053 {
1054         TreeViewColumn *col;
1055
1056         switch (ev->keyval) {
1057         case GDK_Tab:
1058         case GDK_ISO_Left_Tab:
1059                 col = _display.get_column (0); // select&focus on name column
1060
1061                 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1062                         treeview_select_previous (_display, _model, col);
1063                 } else {
1064                         treeview_select_next (_display, _model, col);
1065                 }
1066
1067                 return true;
1068                 break;
1069
1070         default:
1071                 break;
1072         }
1073
1074         return false;
1075 }
1076
1077 bool
1078 EditorRegions::button_press (GdkEventButton *ev)
1079 {
1080         boost::shared_ptr<Region> region;
1081         TreeIter iter;
1082         TreeModel::Path path;
1083         TreeViewColumn* column;
1084         int cellx;
1085         int celly;
1086
1087         if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1088                 if ((iter = _model->get_iter (path))) {
1089                         region = (*iter)[_columns.region];
1090                 }
1091         }
1092
1093         if (Keyboard::is_context_menu_event (ev)) {
1094                 show_context_menu (ev->button, ev->time);
1095                 return false;
1096         }
1097
1098         if (region != 0 && Keyboard::is_button2_event (ev)) {
1099                 // start/stop audition
1100                 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1101                         _editor->consider_auditioning (region);
1102                 }
1103                 return true;
1104         }
1105
1106         return false;
1107 }
1108
1109 int
1110 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1111 {
1112         int cmp = 0;
1113
1114         boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1115         boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1116
1117         /* handle rows without regions, like "Hidden" */
1118
1119         if (r1 == 0) {
1120                 return -1;
1121         }
1122
1123         if (r2 == 0) {
1124                 return 1;
1125         }
1126
1127         boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1128         boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1129
1130         if (region1 == 0 || region2 == 0) {
1131                 std::string s1;
1132                 std::string s2;
1133                 switch (_sort_type) {
1134                 case ByName:
1135                         s1 = (*a)[_columns.name];
1136                         s2 = (*b)[_columns.name];
1137                         return (s1.compare (s2));
1138                 default:
1139                         return 0;
1140                 }
1141         }
1142
1143         switch (_sort_type) {
1144         case ByName:
1145                 cmp = strcasecmp (region1->name().c_str(), region2->name().c_str());
1146                 break;
1147
1148         case ByLength:
1149                 cmp = region1->length() - region2->length();
1150                 break;
1151
1152         case ByPosition:
1153                 cmp = region1->position() - region2->position();
1154                 break;
1155
1156         case ByTimestamp:
1157                 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1158                 break;
1159
1160         case ByStartInFile:
1161                 cmp = region1->start() - region2->start();
1162                 break;
1163
1164         case ByEndInFile:
1165                 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1166                 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1167                 break;
1168
1169         case BySourceFileName:
1170                 cmp = strcasecmp (region1->source()->name().c_str(), region2->source()->name().c_str());
1171                 break;
1172
1173         case BySourceFileLength:
1174                 cmp = region1->source_length(0) - region2->source_length(0);
1175                 break;
1176
1177         case BySourceFileCreationDate:
1178                 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1179                 break;
1180
1181         case BySourceFileFS:
1182                 if (region1->source()->name() == region2->source()->name()) {
1183                         cmp = strcasecmp (region1->name().c_str(),  region2->name().c_str());
1184                 } else {
1185                         cmp = strcasecmp (region1->source()->name().c_str(),  region2->source()->name().c_str());
1186                 }
1187                 break;
1188         }
1189
1190         // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1191
1192         if (cmp < 0) {
1193                 return -1;
1194         } else if (cmp > 0) {
1195                 return 1;
1196         } else {
1197                 return 0;
1198         }
1199 }
1200
1201 void
1202 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1203 {
1204         if (type != _sort_type || force) {
1205                 _sort_type = type;
1206                 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1207         }
1208 }
1209
1210 void
1211 EditorRegions::reset_sort_direction (bool up)
1212 {
1213         _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1214 }
1215
1216 void
1217 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1218 {
1219         Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1220         TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1221         TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1222
1223         if (selection->count_selected_rows() == 0 || _session == 0) {
1224                 return;
1225         }
1226
1227         for (; i != rows.end(); ++i) {
1228                 TreeIter iter;
1229
1230                 if ((iter = _model->get_iter (*i))) {
1231
1232                         /* some rows don't have a region associated with them, but can still be
1233                            selected (XXX maybe prevent them from being selected)
1234                         */
1235
1236                         boost::shared_ptr<Region> r = (*iter)[_columns.region];
1237
1238                         if (r) {
1239                                 sl (r);
1240                         }
1241                 }
1242         }
1243 }
1244
1245
1246 void
1247 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1248                                    int x, int y,
1249                                    const SelectionData& data,
1250                                    guint info, guint time)
1251 {
1252         vector<string> paths;
1253
1254         if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1255                 /* something is being dragged over the region list */
1256                 _editor->_drags->abort ();
1257                 _display.on_drag_data_received (context, x, y, data, info, time);
1258                 return;
1259         }
1260
1261         if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1262                 framepos_t pos = 0;
1263                 if (Profile->get_sae() || Config->get_only_copy_imported_files()) {
1264                         _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1265                 } else {
1266                         _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1267                 }
1268                 context->drag_finish (true, false, time);
1269         }
1270 }
1271
1272 bool
1273 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1274 {
1275         /* not possible to select rows that do not represent regions, like "Hidden" */
1276
1277         if (already_selected) {
1278                 /* deselecting anything is OK with us */
1279                 return true;
1280         }
1281
1282         TreeModel::iterator iter = model->get_iter (path);
1283
1284         if (iter) {
1285                 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1286                 if (!r) {
1287                         return false;
1288                 }
1289         }
1290
1291         return true;
1292 }
1293
1294 void
1295 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1296 {
1297         boost::shared_ptr<Region> region;
1298         TreeIter iter;
1299
1300         if ((iter = _model->get_iter (path))) {
1301                 region = (*iter)[_columns.region];
1302                 (*iter)[_columns.name] = new_text;
1303         }
1304
1305         /* now mapover everything */
1306
1307         if (region) {
1308                 vector<RegionView*> equivalents;
1309                 _editor->get_regions_corresponding_to (region, equivalents);
1310
1311                 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1312                         if (new_text != (*i)->region()->name()) {
1313                                 (*i)->region()->set_name (new_text);
1314                         }
1315                 }
1316         }
1317
1318 }
1319
1320 /** @return Region that has been dragged out of the list, or 0 */
1321 boost::shared_ptr<Region>
1322 EditorRegions::get_dragged_region ()
1323 {
1324         list<boost::shared_ptr<Region> > regions;
1325         TreeView* source;
1326         _display.get_object_drag_data (regions, &source);
1327
1328         if (regions.empty()) {
1329                 return boost::shared_ptr<Region> ();
1330         }
1331         
1332         assert (regions.size() == 1);
1333         return regions.front ();
1334 }
1335
1336 void
1337 EditorRegions::clear ()
1338 {
1339         _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1340         _model->clear ();
1341         _display.set_model (_model);
1342 }
1343
1344 boost::shared_ptr<Region>
1345 EditorRegions::get_single_selection ()
1346 {
1347         Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1348
1349         if (selected->count_selected_rows() != 1) {
1350                 return boost::shared_ptr<Region> ();
1351         }
1352
1353         TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1354
1355         /* only one row selected, so rows.begin() is it */
1356
1357         TreeIter iter = _model->get_iter (*rows.begin());
1358
1359         if (!iter) {
1360                 return boost::shared_ptr<Region> ();
1361         }
1362
1363         return (*iter)[_columns.region];
1364 }
1365
1366 void
1367 EditorRegions::locked_changed (std::string const & path)
1368 {
1369         TreeIter i = _model->get_iter (path);
1370         if (i) {
1371                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1372                 if (region) {
1373                         region->set_locked (!(*i)[_columns.locked]);
1374                 }
1375         }
1376 }
1377
1378 void
1379 EditorRegions::glued_changed (std::string const & path)
1380 {
1381         TreeIter i = _model->get_iter (path);
1382         if (i) {
1383                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1384                 if (region) {
1385                         /* `glued' means MusicTime, and we're toggling here */
1386                         region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1387                 }
1388         }
1389
1390 }
1391
1392 void
1393 EditorRegions::muted_changed (std::string const & path)
1394 {
1395         TreeIter i = _model->get_iter (path);
1396         if (i) {
1397                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1398                 if (region) {
1399                         region->set_muted (!(*i)[_columns.muted]);
1400                 }
1401         }
1402
1403 }
1404
1405 void
1406 EditorRegions::opaque_changed (std::string const & path)
1407 {
1408         TreeIter i = _model->get_iter (path);
1409         if (i) {
1410                 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1411                 if (region) {
1412                         region->set_opaque (!(*i)[_columns.opaque]);
1413                 }
1414         }
1415
1416 }
1417
1418 XMLNode &
1419 EditorRegions::get_state () const
1420 {
1421         XMLNode* node = new XMLNode (X_("RegionList"));
1422
1423         node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1424
1425         RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1426         bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1427         node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1428         node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1429         node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1430
1431         return *node;
1432 }
1433                 
1434 void
1435 EditorRegions::set_state (const XMLNode & node)
1436 {
1437         bool changed = false;
1438
1439         if (node.name() != X_("RegionList")) {
1440                 return;
1441         }
1442
1443         XMLProperty const * p = node.property (X_("sort-type"));
1444         if (p) {
1445                 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1446                 if (_sort_type != t) {
1447                         changed = true;
1448                 }
1449                 reset_sort_type (t, true);
1450                 RefPtr<RadioAction> ract = sort_type_action (t);
1451                 ract->set_active ();
1452         }
1453
1454         p = node.property (X_("sort-ascending"));
1455         if (p) {
1456                 bool const yn = string_is_affirmative (p->value ());
1457                 SortType old_sort_type;
1458                 int old_sort_column;
1459
1460                 _model->get_sort_column_id (old_sort_column, old_sort_type);
1461                 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1462                         changed = true;
1463                 }
1464                 reset_sort_direction (yn);
1465                 RefPtr<Action> act;
1466                 if (yn) {
1467                         act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1468                 } else {
1469                         act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1470                 }
1471
1472                 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1473         }
1474
1475         p = node.property (X_("show-all"));
1476         if (p) {
1477                 bool const yn = string_is_affirmative (p->value ());
1478                 if (expanded != yn) {
1479                         changed = true;
1480                 }
1481                 set_full (yn);
1482                 toggle_full_action()->set_active (yn);
1483         }
1484
1485         p = node.property (X_("show-automatic-regions"));
1486         if (p) {
1487                 bool const yn = string_is_affirmative (p->value ());
1488                 if (yn != _show_automatic_regions) {
1489                         _show_automatic_regions = yn;
1490                         toggle_show_auto_regions_action()->set_active (yn);
1491                         /* no need to set changed because the above toggle 
1492                            will have triggered a redisplay 
1493                         */
1494                 }
1495         }
1496         
1497         if (changed) {
1498                 redisplay ();
1499         }
1500 }
1501
1502 RefPtr<RadioAction>
1503 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1504 {
1505         const char* action = 0;
1506
1507         switch (t) {
1508         case Editing::ByName:
1509                 action = X_("SortByRegionName");
1510                 break;
1511         case Editing::ByLength:
1512                 action = X_("SortByRegionLength");
1513                 break;
1514         case Editing::ByPosition:
1515                 action = X_("SortByRegionPosition");
1516                 break;
1517         case Editing::ByTimestamp:
1518                 action = X_("SortByRegionTimestamp");
1519                 break;
1520         case Editing::ByStartInFile:
1521                 action = X_("SortByRegionStartinFile");
1522                 break;
1523         case Editing::ByEndInFile:
1524                 action = X_("SortByRegionEndinFile");
1525                 break;
1526         case Editing::BySourceFileName:
1527                 action = X_("SortBySourceFileName");
1528                 break;
1529         case Editing::BySourceFileLength:
1530                 action = X_("SortBySourceFileLength");
1531                 break;
1532         case Editing::BySourceFileCreationDate:
1533                 action = X_("SortBySourceFileCreationDate");
1534                 break;
1535         case Editing::BySourceFileFS:
1536                 action = X_("SortBySourceFilesystem");
1537                 break;
1538         default:
1539                 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1540                 /*NOTREACHED*/
1541         }
1542
1543         RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1544         assert (act);
1545
1546         return RefPtr<RadioAction>::cast_dynamic (act);
1547 }
1548
1549 RefPtr<Action>
1550 EditorRegions::hide_action () const
1551 {
1552         return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1553         
1554 }
1555
1556 RefPtr<Action>
1557 EditorRegions::show_action () const
1558 {
1559         return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1560 }
1561
1562 RefPtr<ToggleAction>
1563 EditorRegions::toggle_full_action () const
1564 {
1565         Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1566         assert (act);
1567         return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1568 }
1569
1570 RefPtr<ToggleAction>
1571 EditorRegions::toggle_show_auto_regions_action () const
1572 {
1573         Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1574         assert (act);
1575         return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1576 }