fix the design of Mackie XML state management

3 files changed, 62 insertions, 57 deletions

diff --git a/libs/surfaces/mackie/mackie_control_protocol.cc b/libs/surfaces/mackie/mackie_control_protocol.cc
index 9f98f1d05b..5f35dda080 100644
--- a/libs/surfaces/mackie/mackie_control_protocol.cc
+++ b/libs/surfaces/mackie/mackie_control_protocol.cc
@@ -114,9 +114,8 @@ MackieControlProtocol::MackieControlProtocol (Session& session)
 	, needs_ipmidi_restart (false)
 	, _metering_active (true)
 	, _initialized (false)
-	, _surfaces_state (0)
-	, _surfaces_version (0)
-	, _session_load (true)
+	, configuration_state (0)
+	, state_version (0)
 {
 	DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
 
@@ -144,7 +143,7 @@ MackieControlProtocol::~MackieControlProtocol()
 	DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol tear_down_gui ()\n");
 	tear_down_gui ();
 
-	delete _surfaces_state;
+	delete configuration_state;
 
 	/* stop event loop */
 	DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol BaseUI::quit ()\n");
@@ -700,23 +699,12 @@ MackieControlProtocol::set_device (const string& device_name, bool force)
 		/* already using that device, nothing to do */
 		return 0;
 	}
-
 	/* get state from the current setup, and make sure it is stored in
-	   the _surface_states node so that if we switch back to this device,
+	   the configuration_states node so that if we switch back to this device,
 	   we will have its state available.
 	*/
 
-	if (!_surfaces_state) {
-		_surfaces_state = new XMLNode (X_("Surfaces"));
-	}
-
-	{
-		Glib::Threads::Mutex::Lock lm (surfaces_lock);
-
-		for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-			update_surface_state (*s);
-		}
-	}
+	update_configuration_state ();
 
 	if (set_device_info (device_name)) {
 		return -1;
@@ -788,7 +776,8 @@ MackieControlProtocol::create_surfaces ()
 		if (!is_master) {
 			device_name = string_compose (X_("mackie control ext %1"), n+1);
 		}
-	DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Port Name for surface %1 is %2\n", n, device_name));
+
+		DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Port Name for surface %1 is %2\n", n, device_name));
 
 		boost::shared_ptr<Surface> surface;
 
@@ -807,8 +796,22 @@ MackieControlProtocol::create_surfaces ()
 			_master_surface = surface;
 		}
 
-		if (_surfaces_state) {
-			surface->set_state (*_surfaces_state, _surfaces_version);
+		if (configuration_state) {
+			XMLNode* this_device = 0;
+			XMLNodeList const& devices = configuration_state->children();
+			for (XMLNodeList::const_iterator d = devices.begin(); d != devices.end(); ++d) {
+				XMLProperty* prop = (*d)->property (X_("name"));
+				if (prop && prop->value() == device_name) {
+					this_device = *d;
+					break;
+				}
+			}
+			if (this_device) {
+				XMLNode* surfaces = this_device->child (X_("Surfaces"));
+				if (surfaces) {
+					surface->set_state (*surfaces, state_version);
+				}
+			}
 		}
 
 		{
@@ -901,16 +904,32 @@ MackieControlProtocol::close()
 	clear_surfaces();
 }
 
-/** Ensure that the _surfaces_state XML node contains an up-to-date
- *  copy of the state node for @param surface. If _surfaces_state already
- *  contains a state node for @param surface, it will deleted and replaced.
+/** Ensure that the configuration_state XML node contains an up-to-date
+ *  copy of the state node the current device. If configuration_state already
+ *  contains a state node for the device, it will deleted and replaced.
  */
 void
-MackieControlProtocol::update_surface_state (boost::shared_ptr<Surface> surface)
+MackieControlProtocol::update_configuration_state ()
 {
-	assert (_surfaces_state);
-	_surfaces_state->remove_nodes_and_delete (X_("name"), surface->name());
-	_surfaces_state->add_child_nocopy (surface->get_state());
+	if (!configuration_state) {
+		configuration_state = new XMLNode (X_("Configurations"));
+	}
+
+	XMLNode* devnode = new XMLNode (X_("Configuration"));
+	devnode->add_property (X_("name"), _device_info.name());
+
+	configuration_state->remove_nodes_and_delete (X_("name"), _device_info.name());
+	configuration_state->add_child_nocopy (*devnode);
+
+	XMLNode* snode = new XMLNode (X_("Surfaces"));
+	devnode->add_child_nocopy (*snode);
+
+	{
+		Glib::Threads::Mutex::Lock lm (surfaces_lock);
+		for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
+			snode->add_child_nocopy ((*s)->get_state());
+		}
+	}
 }
 
 XMLNode&
@@ -932,19 +951,10 @@ MackieControlProtocol::get_state()
 	node.add_property (X_("device-profile"), _device_profile.name());
 	node.add_property (X_("device-name"), _device_info.name());
 
-	if (!_surfaces_state) {
-		_surfaces_state = new XMLNode (X_("Surfaces"));
-	}
-
-	{
-		Glib::Threads::Mutex::Lock lm (surfaces_lock);
-		for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
-			update_surface_state (*s);
-		}
-	}
+	update_configuration_state ();
 
 	/* force a copy of the _surfaces_state node, because we want to retain ownership */
-	node.add_child_copy (*_surfaces_state);
+	node.add_child_copy (*configuration_state);
 
 	DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state done\n");
 
@@ -981,14 +991,14 @@ MackieControlProtocol::set_state (const XMLNode & node, int version)
 		set_profile (prop->value());
 	}
 
-	XMLNode* snode = node.child (X_("Surfaces"));
+	XMLNode* dnode = node.child (X_("Configurations"));
 
-	delete _surfaces_state;
-	_surfaces_state = 0;
+	delete configuration_state;
+	configuration_state = 0;
 
-	if (snode) {
-		_surfaces_state = new XMLNode (*snode);
-		_surfaces_version = version;
+	if (dnode) {
+		configuration_state = new XMLNode (*dnode);
+		state_version = version;
 	}
 
 	switch_banks (bank, true);
diff --git a/libs/surfaces/mackie/mackie_control_protocol.h b/libs/surfaces/mackie/mackie_control_protocol.h
index 18069dc591..530f328951 100644
--- a/libs/surfaces/mackie/mackie_control_protocol.h
+++ b/libs/surfaces/mackie/mackie_control_protocol.h
@@ -231,9 +231,6 @@ class MackieControlProtocol
 	int16_t ipmidi_base() const { return _ipmidi_base; }
 	void    set_ipmidi_base (int16_t);
 
-	bool session_load () { return _session_load; }
-	void not_session_load () { _session_load = false; }
-
 	void ping_devices ();
 
   protected:
@@ -325,9 +322,9 @@ class MackieControlProtocol
 	bool                     _metering_active;
 	bool                     _initialized;
 	ARDOUR::RouteNotificationList _last_selected_routes;
-	XMLNode*				_surfaces_state;
-	int						_surfaces_version;
-	bool					_session_load;
+	XMLNode*                 configuration_state;
+	int                      state_version;
+
 	boost::shared_ptr<ArdourSurface::Mackie::Surface>	_master_surface;
 
         struct ipMIDIHandler {
@@ -352,7 +349,7 @@ class MackieControlProtocol
 	int ipmidi_restart ();
         void initialize ();
         int set_device_info (const std::string& device_name);
-	void update_surface_state (boost::shared_ptr<Mackie::Surface>);
+	void update_configuration_state ();
 
 	/* MIDI port connection management */
 
diff --git a/libs/surfaces/mackie/surface.cc b/libs/surfaces/mackie/surface.cc
index ff5de96513..1ef37672c6 100644
--- a/libs/surfaces/mackie/surface.cc
+++ b/libs/surfaces/mackie/surface.cc
@@ -270,12 +270,10 @@ Surface::set_state (const XMLNode& node, int version)
 		return 0;
 	}
 
-	if (_mcp.session_load ()) {
-		XMLNode* portnode = mynode->child (X_("Port"));
-		if (portnode) {
-			if (_port->set_state (*portnode, version)) {
-				return -1;
-			}
+	XMLNode* portnode = mynode->child (X_("Port"));
+	if (portnode) {
+		if (_port->set_state (*portnode, version)) {
+			return -1;
 		}
 	}