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