Save/restore location clock mode

- save mode separately for Editor-sidebar and Location Window
- cache mode (multiple calls to set_session())
- fix restore: after creating the editor, instant_save() is called,
  potentially overwriting the previous value.

5 files changed, 68 insertions, 9 deletions

diff --git a/gtk2_ardour/editor.cc b/gtk2_ardour/editor.cc
index 3ff2d710d0..e4d2a126a1 100644
--- a/gtk2_ardour/editor.cc
+++ b/gtk2_ardour/editor.cc
@@ -2552,6 +2552,7 @@ Editor::set_state (const XMLNode& node, int version)
 	for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
 		selection->set_state (**i, Stateful::current_state_version);
 		_regions->set_state (**i);
+		_locations->set_state (**i);
 	}
 
 	if ((prop = node.property ("maximised"))) {
@@ -2693,6 +2694,7 @@ Editor::get_state ()
 
 	node->add_child_nocopy (LuaInstance::instance()->get_action_state());
 	node->add_child_nocopy (LuaInstance::instance()->get_hook_state());
+	node->add_child_nocopy (_locations->get_state ());
 
 	return *node;
 }
diff --git a/gtk2_ardour/editor_locations.cc b/gtk2_ardour/editor_locations.cc
index 0c0066c3a5..328cb65cca 100644
--- a/gtk2_ardour/editor_locations.cc
+++ b/gtk2_ardour/editor_locations.cc
@@ -28,7 +28,7 @@ using namespace Gtk;
 EditorLocations::EditorLocations (Editor* e)
 	: EditorComponent (e)
 {
-	_locations = new LocationUI ();
+	_locations = new LocationUI (X_("EditorLocations"));
 	_scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_NEVER);
 	_scroller.add (*_locations);
 }
@@ -45,3 +45,15 @@ EditorLocations::widget()
 {
 	return _scroller;
 }
+
+XMLNode&
+EditorLocations::get_state () const
+{
+	return _locations->get_state();
+}
+
+int
+EditorLocations::set_state (const XMLNode& node)
+{
+	return _locations->set_state(node);
+}
diff --git a/gtk2_ardour/editor_locations.h b/gtk2_ardour/editor_locations.h
index 36926bbec8..6ed6f8db50 100644
--- a/gtk2_ardour/editor_locations.h
+++ b/gtk2_ardour/editor_locations.h
@@ -20,6 +20,8 @@
 #ifndef __gtk_ardour_editor_locations_h__
 #define __gtk_ardour_editor_locations_h__
 
+#include "pbd/xml++.h"
+
 #include <gtkmm/scrolledwindow.h>
 #include "ardour/session_handle.h"
 #include "editor_component.h"
@@ -38,6 +40,8 @@ class EditorLocations : public EditorComponent, public ARDOUR::SessionHandlePtr
 	void set_session (ARDOUR::Session *);
 
 	Gtk::Widget& widget ();
+	XMLNode & get_state () const;
+	int set_state (const XMLNode&);
 
   private:
 	Gtk::ScrolledWindow _scroller;
diff --git a/gtk2_ardour/location_ui.cc b/gtk2_ardour/location_ui.cc
index 4bdc9798c5..7aeced896e 100644
--- a/gtk2_ardour/location_ui.cc
+++ b/gtk2_ardour/location_ui.cc
@@ -750,9 +750,12 @@ LocationEditRow::set_clock_editable_status ()
 
 /*------------------------------------------------------------------------*/
 
-LocationUI::LocationUI ()
+LocationUI::LocationUI (std::string state_node_name)
 	: add_location_button (_("New Marker"))
 	, add_range_button (_("New Range"))
+	, _mode (AudioClock::Frames)
+	, _mode_set (false)
+	, _state_node_name (state_node_name)
 {
 	i_am_the_modifier = 0;
 
@@ -1111,6 +1114,8 @@ LocationUI::set_session(ARDOUR::Session* s)
 		_session->locations()->changed.connect (_session_connections, invalidator (*this), boost::bind (&LocationUI::refresh_location_list, this), gui_context());
 
 		_clock_group->set_clock_mode (clock_mode_from_session_instant_xml ());
+	} else {
+		_mode_set = false;
 	}
 
 	loop_edit_row.set_session (s);
@@ -1137,21 +1142,49 @@ LocationUI::session_going_away()
 	punch_edit_row.set_session (0);
 	punch_edit_row.set_location (0);
 
+	_mode_set = false;
+
 	SessionHandlePtr::session_going_away ();
 }
 
 XMLNode &
 LocationUI::get_state () const
 {
-	XMLNode* node = new XMLNode (X_("LocationUI"));
-	node->add_property (X_("clock-mode"), enum_2_string (_clock_group->clock_mode ()));
+	XMLNode* node = new XMLNode (_state_node_name);
+	if (_mode_set) {
+		node->add_property (X_("clock-mode"), enum_2_string (_mode));
+	} else {
+		node->add_property (X_("clock-mode"), enum_2_string (_clock_group->clock_mode ()));
+	}
 	return *node;
 }
 
+int
+LocationUI::set_state (const XMLNode& node)
+{
+	if (node.name() != _state_node_name) {
+		return -1;
+	}
+	XMLProperty const* p = node.property (X_("clock-mode"));
+	if (!p) {
+		return -1;
+	}
+	_mode = (AudioClock::Mode) string_2_enum (p->value (), AudioClock::Mode);
+	_mode_set = true;
+	if (_clock_group) {
+		_clock_group->set_clock_mode (_mode);
+	}
+	return 0;
+}
+
 AudioClock::Mode
-LocationUI::clock_mode_from_session_instant_xml () const
+LocationUI::clock_mode_from_session_instant_xml ()
 {
-	XMLNode* node = _session->instant_xml (X_("LocationUI"));
+	if (_mode_set) {
+		return _mode;
+	}
+
+	XMLNode* node = _session->instant_xml (_state_node_name);
 	if (!node) {
 		return AudioClock::Frames;
 	}
@@ -1161,7 +1194,9 @@ LocationUI::clock_mode_from_session_instant_xml () const
 		return ARDOUR_UI::instance()->secondary_clock->mode();
 	}
 
-	return (AudioClock::Mode) string_2_enum (p->value (), AudioClock::Mode);
+	_mode = (AudioClock::Mode) string_2_enum (p->value (), AudioClock::Mode);
+	_mode_set = true;
+	return _mode;
 }
 
 
diff --git a/gtk2_ardour/location_ui.h b/gtk2_ardour/location_ui.h
index 76542804c2..3be45dc329 100644
--- a/gtk2_ardour/location_ui.h
+++ b/gtk2_ardour/location_ui.h
@@ -153,7 +153,7 @@ protected:
 class LocationUI : public Gtk::HBox, public ARDOUR::SessionHandlePtr
 {
 public:
-	LocationUI ();
+	LocationUI (std::string state_node_name = "LocationUI");
 	~LocationUI ();
 
 	void set_session (ARDOUR::Session *);
@@ -165,6 +165,7 @@ public:
 	void refresh_location_list ();
 
 	XMLNode & get_state () const;
+	int set_state (const XMLNode&);
 
 private:
 	/** set to the location that has just been created with the LocationUI `add' button
@@ -209,7 +210,12 @@ private:
 	void map_locations (const ARDOUR::Locations::LocationList&);
 
 	ClockGroup* _clock_group;
-	AudioClock::Mode clock_mode_from_session_instant_xml () const;
+	AudioClock::Mode clock_mode_from_session_instant_xml ();
+
+	AudioClock::Mode _mode;
+	bool _mode_set;
+
+	std::string _state_node_name;
 };
 
 class LocationUIWindow : public ArdourWindow