Use Stripable::Sorter in GUI consistently.

gtk2_ardour/editor.cc

@@ -5332,7 +5332,7 @@ Editor::add_stripables (StripableList& sl)
 	TrackViewList new_selection;
 	bool from_scratch = (track_views.size() == 0);
 
-	sl.sort (StripablePresentationInfoSorter());
+	sl.sort (Stripable::Sorter());
 
 	for (StripableList::iterator s = sl.begin(); s != sl.end(); ++s) {
 

gtk2_ardour/editor_drag.cc

@@ -546,9 +546,11 @@ Drag::add_midi_region (MidiTimeAxisView* view, bool commit)
 	return boost::shared_ptr<Region>();
 }
 
-struct PresentationInfoTimeAxisViewSorter {
+struct TimeAxisViewStripableSorter {
-	bool operator() (TimeAxisView* a, TimeAxisView* b) {
+	bool operator() (TimeAxisView* tav_a, TimeAxisView* tav_b) {
-		return a->stripable()->presentation_info().order() < b->stripable()->presentation_info().order();
+		boost::shared_ptr<ARDOUR::Stripable> const& a = tav_a->stripable ();
+		boost::shared_ptr<ARDOUR::Stripable> const& b = tav_b->stripable ();
+		return ARDOUR::Stripable::Sorter () (a, b);
 	}
 };
 
@@ -564,7 +566,7 @@ RegionDrag::RegionDrag (Editor* e, ArdourCanvas::Item* i, RegionView* p, list<Re
 	*/
 
 	TrackViewList track_views = _editor->track_views;
-	track_views.sort (PresentationInfoTimeAxisViewSorter ());
+	track_views.sort (TimeAxisViewStripableSorter ());
 
 	for (TrackViewList::iterator i = track_views.begin(); i != track_views.end(); ++i) {
 		_time_axis_views.push_back (*i);

gtk2_ardour/editor_routes.cc

@@ -1006,82 +1006,37 @@ EditorRoutes::sync_presentation_info_from_treeview ()
 	TreeModel::Children::iterator ri;
 	bool change = false;
 	PresentationInfo::order_t order = 0;
-	bool master_is_first = false;
-	uint32_t count = 0;
 
-	OrderingKeys sorted;
+	TreeOrderKeys sorted;
-	const size_t cmp_max = rows.size ();
 
 	PresentationInfo::ChangeSuspender cs;
 
-	// special case master if it's got PI order 0 lets keep it there
-	if (_session->master_out() && (_session->master_out()->presentation_info().order() == 0)) {
-		order++;
-		master_is_first = true;
-	}
-
 	for (ri = rows.begin(); ri != rows.end(); ++ri) {
-
 		boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
 		bool visible = (*ri)[_columns.visible];
 
-		/* Monitor and Auditioner do not get their presentation
+#ifndef NDEBUG // these should not exist in the treeview
-		 * info reset here.
-		 */
-
 		if (stripable->is_monitor() || stripable->is_auditioner()) {
+			assert (0);
 			continue;
 		}
+#endif
 
 		stripable->presentation_info().set_hidden (!visible);
 
-		/* special case master if it's got PI order 0 lets keep it there
-		 * but still allow master to move if first non-master route has
-		 * presentation order 1
-		 */
-		if ((count == 0) && master_is_first && (stripable->presentation_info().order()  == 1)) {
-			master_is_first = false; // someone has moved master
-			order = 0;
-		}
-
-		if (stripable->is_master() && master_is_first) {
-			if (count) {
-				continue;
-			} else {
-				count++;
-				continue;
-			}
-		}
-
 		if (order != stripable->presentation_info().order()) {
 			stripable->set_presentation_order (order);
 			change = true;
 		}
 
-		sorted.push_back (OrderKeys (order, stripable, cmp_max));
+		sorted.push_back (TreeOrderKey (order, stripable));
-
 		++order;
-		++count;
 	}
 
-	if (!change) {
+	change |= _session->ensure_stripable_sort_order ();
-		// VCA (and Mixbus) special cases according to SortByNewDisplayOrder
+
-		uint32_t n = 0;
+	if (change) {
-		SortByNewDisplayOrder cmp;
+		_session->set_dirty();
-		sort (sorted.begin(), sorted.end(), cmp);
-		for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
-			if (sr->old_display_order != n) {
-				change = true;
-			}
-		}
-		if (change) {
-			n = 0;
-			for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
-				if (sr->stripable->presentation_info().order() != n) {
-					sr->stripable->set_presentation_order (n);
-				}
-			}
-		}
 	}
 }
 
@@ -1114,23 +1069,21 @@ EditorRoutes::sync_treeview_from_presentation_info (PropertyChange const & what_
 			return;
 		}
 
-		OrderingKeys sorted;
+		TreeOrderKeys sorted;
-		const size_t cmp_max = rows.size ();
-
 		for (TreeModel::Children::iterator ri = rows.begin(); ri != rows.end(); ++ri, ++old_order) {
 			boost::shared_ptr<Stripable> stripable = (*ri)[_columns.stripable];
 			/* use global order */
-			sorted.push_back (OrderKeys (old_order, stripable, cmp_max));
+			sorted.push_back (TreeOrderKey (old_order, stripable));
 		}
 
-		SortByNewDisplayOrder cmp;
+		TreeOrderKeySorter cmp;
 
 		sort (sorted.begin(), sorted.end(), cmp);
 		neworder.assign (sorted.size(), 0);
 
 		uint32_t n = 0;
 
-		for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
+		for (TreeOrderKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
 
 			neworder[n] = sr->old_display_order;
 
@@ -1543,27 +1496,6 @@ EditorRoutes::selection_filter (Glib::RefPtr<TreeModel> const& model, TreeModel:
 	return true;
 }
 
-struct PresentationInfoRouteSorter
-{
-	bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
-		if (a->is_master()) {
-			/* master before everything else */
-			return true;
-		} else if (b->is_master()) {
-			/* everything else before master */
-			return false;
-		}
-		return a->presentation_info().order () < b->presentation_info().order ();
-	}
-};
-
-struct PresentationInfoVCASorter
-{
-	bool operator() (boost::shared_ptr<VCA> a, boost::shared_ptr<VCA> b) {
-		return a->presentation_info().order () < b->presentation_info().order ();
-	}
-};
-
 void
 EditorRoutes::initial_display ()
 {
@@ -1627,7 +1559,7 @@ EditorRoutes::move_selected_tracks (bool up)
 		return;
 	}
 
-	sl.sort (Stripable::PresentationOrderSorter());
+	sl.sort (Stripable::Sorter());
 
 	std::list<ViewStripable> view_stripables;
 

gtk2_ardour/export_channel_selector.cc

@@ -121,7 +121,7 @@ PortExportChannelSelector::fill_route_list ()
 		channel_view.add_route (master);
 	}
 
-	routes.sort (Stripable::PresentationOrderSorter ());
+	routes.sort (Stripable::Sorter ());
 
 	for (RouteList::iterator it = routes.begin(); it != routes.end(); ++it) {
 		if ((*it)->is_master () || (*it)->is_monitor ()) {

gtk2_ardour/group_tabs.cc

@@ -679,12 +679,12 @@ void
 GroupTabs::collect (RouteGroup* g)
 {
 	boost::shared_ptr<RouteList> group_routes = g->route_list ();
-	group_routes->sort (Stripable::PresentationOrderSorter());
+	group_routes->sort (Stripable::Sorter());
 	int const N = group_routes->size ();
 
 	RouteList::iterator i = group_routes->begin ();
 	boost::shared_ptr<RouteList> routes = _session->get_routes ();
-	routes->sort (Stripable::PresentationOrderSorter());
+	routes->sort (Stripable::Sorter());
 	RouteList::const_iterator j = routes->begin ();
 
 	int diff = 0;

gtk2_ardour/meterbridge.cc

@@ -408,22 +408,6 @@ Meterbridge::on_scroll()
 	metrics_right.set_metric_mode(mm_right, mt_right);
 }
 
-struct PresentationInfoRouteSorter
-{
-	bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
-		if (a->is_master() || a->is_monitor()) {
-			/* "a" is a special route (master, monitor, etc), and comes
-			 * last in the mixer ordering
-			 */
-			return false;
-		} else if (b->is_master() || b->is_monitor()) {
-			/* everything comes before b */
-			return true;
-		}
-		return a->presentation_info().order() < b->presentation_info().order();
-	}
-};
-
 void
 Meterbridge::set_session (Session* s)
 {
@@ -449,7 +433,7 @@ Meterbridge::set_session (Session* s)
 	boost::shared_ptr<RouteList> routes = _session->get_routes();
 
 	RouteList copy (*routes);
-	copy.sort (PresentationInfoRouteSorter());
+	copy.sort (Stripable::Sorter (true));
 	add_strips (copy);
 
 	_session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&Meterbridge::add_strips, this, _1), gui_context());

gtk2_ardour/mixer_ui.cc

@@ -498,7 +498,7 @@ Mixer_UI::add_stripables (StripableList& slist)
 	bool from_scratch = (track_model->children().size() == 0);
 	uint32_t nroutes = 0;
 
-	slist.sort (StripablePresentationInfoSorter());
+	slist.sort (Stripable::Sorter());
 
 	for (Gtk::TreeModel::Children::iterator it = track_model->children().begin(); it != track_model->children().end(); ++it) {
 		boost::shared_ptr<Stripable> s = (*it)[stripable_columns.stripable];
@@ -509,6 +509,7 @@ Mixer_UI::add_stripables (StripableList& slist)
 
 		nroutes++;
 
+		// XXX what does this special case do?
 		if (s->presentation_info().order() == (slist.front()->presentation_info().order() + slist.size())) {
 			insert_iter = it;
 			break;
@@ -722,15 +723,12 @@ Mixer_UI::sync_presentation_info_from_treeview ()
 
 	TreeModel::Children::iterator ri;
 	bool change = false;
-	uint32_t order = 0;
 
-	OrderingKeys sorted;
+	PresentationInfo::order_t master_key = _session->master_order_key ();
-	const size_t cmp_max = rows.size ();
+	PresentationInfo::order_t order = 0;
+	uint32_t count = 0;
 
-	// special case master if it's got PI order 0 lets keep it there
+	TreeOrderKeys sorted;
-	if (_session->master_out() && (_session->master_out()->presentation_info().order() == 0)) {
-		order++;
-	}
 
 	PresentationInfo::ChangeSuspender cs;
 
@@ -738,27 +736,26 @@ Mixer_UI::sync_presentation_info_from_treeview ()
 		bool visible = (*ri)[stripable_columns.visible];
 		boost::shared_ptr<Stripable> stripable = (*ri)[stripable_columns.stripable];
 
+#ifndef NDEBUG // these should not exist in the mixer's treeview
 		if (!stripable) {
+			assert (0);
 			continue;
 		}
-
-		/* Monitor and Auditioner do not get their presentation
-		 * info reset here.
-		 */
-
 		if (stripable->is_monitor() || stripable->is_auditioner()) {
+			assert (0);
 			continue;
 		}
-
+		if (stripable->is_master()) {
-		/* Master also doesn't get set here but since the editor allows
+			assert (0);
-		 * it to be reordered, we need to preserve its ordering.
+			continue;
-		 */
+		}
+#endif
 
 		stripable->presentation_info().set_hidden (!visible);
 
-		// master may not get set here, but if it is zero keep it there
+		// leave master where it is.
-		if (stripable->is_master() && (stripable->presentation_info().order() == 0)) {
+		if (order == master_key) {
-			continue;
+			++order;
 		}
 
 		if (order != stripable->presentation_info().order()) {
@@ -766,37 +763,12 @@ Mixer_UI::sync_presentation_info_from_treeview ()
 			change = true;
 		}
 
-		sorted.push_back (OrderKeys (order, stripable, cmp_max));
+		sorted.push_back (TreeOrderKey (count, stripable));
-
 		++order;
+		++count;
 	}
 
-	if (!change) {
+	change |= _session->ensure_stripable_sort_order ();
-		// VCA (and Mixbus) special cases according to SortByNewDisplayOrder
-		uint32_t n = 0;
-		SortByNewDisplayOrder cmp;
-		sort (sorted.begin(), sorted.end(), cmp);
-		for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
-			if (_session->master_out() && (_session->master_out()->presentation_info().order() == n)) {
-				++n;
-			}
-			if (sr->old_display_order != n) {
-				change = true;
-				break;
-			}
-		}
-		if (change) {
-			n = 0;
-			for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
-				if (_session->master_out() && (_session->master_out()->presentation_info().order() == n)) {
-					++n;
-				}
-				if (sr->stripable->presentation_info().order() != n) {
-					sr->stripable->set_presentation_order (n);
-				}
-			}
-		}
-	}
 
 	if (change) {
 		DEBUG_TRACE (DEBUG::OrderKeys, "... notify PI change from mixer GUI\n");
@@ -827,22 +799,20 @@ Mixer_UI::sync_treeview_from_presentation_info (PropertyChange const & what_chan
 		return;
 	}
 
-	OrderingKeys sorted;
+	TreeOrderKeys sorted;
-	const size_t cmp_max = rows.size ();
-
 	for (TreeModel::Children::iterator ri = rows.begin(); ri != rows.end(); ++ri, ++old_order) {
 		boost::shared_ptr<Stripable> stripable = (*ri)[stripable_columns.stripable];
-		sorted.push_back (OrderKeys (old_order, stripable, cmp_max));
+		sorted.push_back (TreeOrderKey (old_order, stripable));
 	}
 
-	SortByNewDisplayOrder cmp;
+	TreeOrderKeySorter cmp;
 
 	sort (sorted.begin(), sorted.end(), cmp);
 	neworder.assign (sorted.size(), 0);
 
 	uint32_t n = 0;
 
-	for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
+	for (TreeOrderKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr, ++n) {
 
 		neworder[n] = sr->old_display_order;
 
@@ -926,6 +896,15 @@ Mixer_UI::axis_view_by_control (boost::shared_ptr<AutomationControl> c) const
 	return 0;
 }
 
+struct MixerStripSorter {
+	bool operator() (const MixerStrip* ms_a, const MixerStrip* ms_b)
+	{
+		boost::shared_ptr<ARDOUR::Stripable> const& a = ms_a->stripable ();
+		boost::shared_ptr<ARDOUR::Stripable> const& b = ms_b->stripable ();
+		return ARDOUR::Stripable::Sorter(true)(a, b);
+	}
+};
+
 bool
 Mixer_UI::strip_button_release_event (GdkEventButton *ev, MixerStrip *strip)
 {
@@ -949,16 +928,10 @@ Mixer_UI::strip_button_release_event (GdkEventButton *ev, MixerStrip *strip)
 				bool accumulate = false;
 				bool found_another = false;
 
-				OrderingKeys sorted;
+				strips.sort (MixerStripSorter());
-				const size_t cmp_max = strips.size ();
-				for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
-					sorted.push_back (OrderKeys (-1, (*i)->stripable(), cmp_max));
-				}
-				SortByNewDisplayOrder cmp;
-				sort (sorted.begin(), sorted.end(), cmp);
 
-				for (OrderingKeys::iterator sr = sorted.begin(); sr != sorted.end(); ++sr) {
+				for (list<MixerStrip*>::iterator i = strips.begin(); i != strips.end(); ++i) {
-					MixerStrip* ms = strip_by_stripable (sr->stripable);
+					MixerStrip* ms = *i;
 					assert (ms);
 
 					if (ms == strip) {

gtk2_ardour/route_sorter.h

@@ -26,44 +26,29 @@
 
 #include "ardour/stripable.h"
 
-struct OrderKeys {
+/* This is used to keep numerical tree-order in sync
+ * with Stripable ordering (mixer_ui.cc editor_routes.cc)
+ */
+
+struct TreeOrderKey {
     uint32_t old_display_order;
-    uint32_t new_display_order;
-    uint32_t compare_order;
 		boost::shared_ptr<ARDOUR::Stripable> stripable;
 
-	OrderKeys (uint32_t ok, boost::shared_ptr<ARDOUR::Stripable> s, uint32_t cmp_max)
+	TreeOrderKey (uint32_t ok, boost::shared_ptr<ARDOUR::Stripable> s)
 		: old_display_order (ok)
 		, stripable (s)
+	{}
+};
+
+typedef std::vector<TreeOrderKey> TreeOrderKeys;
+
+struct TreeOrderKeySorter
+{
+	bool operator() (const TreeOrderKey& ok_a, const TreeOrderKey& ok_b)
 	{
-		new_display_order = s->presentation_info().order();
+		boost::shared_ptr<ARDOUR::Stripable> const& a = ok_a.stripable;
-		compare_order = new_display_order;
+		boost::shared_ptr<ARDOUR::Stripable> const& b = ok_b.stripable;
-
+		return ARDOUR::Stripable::Sorter () (a, b);
-		if (s->presentation_info().flags () & ARDOUR::PresentationInfo::VCA) {
-			compare_order += 2 * cmp_max;
-		}
-#ifdef MIXBUS
-		if (s->presentation_info().flags () & ARDOUR::PresentationInfo::Mixbus || s->mixbus()) {
-			compare_order += cmp_max;
-		}
-		if (s->presentation_info().flags () & ARDOUR::PresentationInfo::MasterOut) {
-			compare_order += 3 * cmp_max;
-		}
-#endif
-	}
-};
-
-typedef std::vector<OrderKeys> OrderingKeys;
-
-struct SortByNewDisplayOrder {
-    bool operator() (const OrderKeys& a, const OrderKeys& b) {
-	    return a.compare_order < b.compare_order;
-    }
-};
-
-struct StripablePresentationInfoSorter {
-	bool operator() (boost::shared_ptr<ARDOUR::Stripable> a, boost::shared_ptr<ARDOUR::Stripable> b) {
-		return a->presentation_info().order () < b->presentation_info().order ();
 	}
 };
 

gtk2_ardour/stripable_treemodel.cc

@@ -129,7 +129,7 @@ StripableTreeModel::iter_next_vfunc (const iterator& iter, iterator& iter_next)
 	if (sl.empty()) {
 		return false;
 	}
-	sl.sort (Stripable::PresentationOrderSorter());
+	sl.sort (Stripable::Sorter());
 
 	for (StripableList::const_iterator s = sl.begin(); s != sl.end(); ++s) {
 
@@ -199,7 +199,7 @@ StripableTreeModel::iter_nth_root_child_vfunc(int n, iterator& iter) const
 		return false;
 	}
 
-	sl.sort (Stripable::PresentationOrderSorter());
+	sl.sort (Stripable::Sorter());
 
 	StripableList::const_iterator s;