Handle invalid headstage selections gracefully

- Immediately shut down the port voltage to prevent damage to devices
- Display the selected vs. connected headstages so the user is aware of what is incorrect
- Only present a single button (Okay) to the user so they acknowledge the information
- Leave the devices in a disconnected state so the user can update the drop-down menu if needed, or give them time to connect devices manually

Author: bparks13

Source/OnixSourceCanvas.cpp

@@ -262,184 +262,61 @@ OnixDeviceMap OnixSourceCanvas::getSelectedDevices(std::vector<std::shared_ptr<S
 	return tabMap;
 }
 
-void OnixSourceCanvas::askKeepRemove(int offset)
+bool OnixSourceCanvas::verifyHeadstageSelection()
 {
-	std::string selectedHeadstage = editor->getHeadstageSelected(offset);
-
-	std::string msg = "Headstage " + selectedHeadstage + " is selected on " + OnixDevice::getPortName(offset) + ", but was not discovered there.\n\n";
-	msg += "Select one of the options below to continue:\n";
-	msg += " [Keep Current] to keep " + selectedHeadstage + " selected.\n";
-	msg += " [Remove] to remove " + selectedHeadstage + ".\n - Note: this will delete any settings that were modified.";
-
-	int result = AlertWindow::show(
-		MessageBoxOptions()
-		.withIconType(MessageBoxIconType::WarningIcon)
-		.withTitle("Headstage Not Found")
-		.withMessage(msg)
-		.withButton("Keep Current")
-		.withButton("Remove")
-	);
-
-	switch (result)
-	{
-	case 0: // Remove
-		removeTabs(PortController::getPortFromIndex(offset));
-		break;
-	case 1: // Keep Current
-		break;
-	default:
-		break;
-	}
-}
+	auto selectedDevices = getSelectedDevices(settingsInterfaces);
+	auto connectedDevices = source->getConnectedDevices(true);
 
-void OnixSourceCanvas::askKeepUpdate(int offset, std::string foundHeadstage, OnixDeviceVector devices)
-{
-	std::string selectedHeadstage = editor->getHeadstageSelected(offset);
-
-	if (selectedHeadstage == foundHeadstage) return;
-
-	std::string msg = "Headstage " + selectedHeadstage + " is selected on " + OnixDevice::getPortName(offset) + ". ";
-	msg += "However, headstage " + foundHeadstage + " was found on " + OnixDevice::getPortName(offset) + ". \n\n";
-	msg += "Select one of the options below to continue:\n";
-	msg += " [Keep Current] to keep " + selectedHeadstage + " selected.\n";
-	msg += " [Update] to change the selected headstage to " + foundHeadstage + ".\n - Note: this will delete any settings that were modified.";
-
-	int result = AlertWindow::show(
-		MessageBoxOptions()
-		.withIconType(MessageBoxIconType::WarningIcon)
-		.withTitle("Mismatched Headstages")
-		.withMessage(msg)
-		.withButton("Keep Current")
-		.withButton("Update")
-	);
-
-	switch (result)
+	if (selectedDevices != connectedDevices)
 	{
-	case 0: // Update
-	{
-		PortName port = PortController::getPortFromIndex(offset);
-		removeTabs(port);
+		auto connectedOffsets = OnixDevice::getUniqueOffsets(connectedDevices);
+		auto selectedOffsets = OnixDevice::getUniqueOffsets(selectedDevices);
 
-		CustomTabComponent* tab = addTopLevelTab(getTopLevelTabName(port, foundHeadstage), (int)port);
-		populateSourceTabs(tab, devices);
-	}
-	break;
-	case 1: // Keep Current
-		break;
-	default:
-		break;
-	}
-}
-
-void OnixSourceCanvas::refreshTabs()
-{
-	auto selectedMap = createSelectedMap(settingsInterfaces);
-	auto foundMap = source->createDeviceMap(true);
+		auto hubNames = source->getHubNames();
 
-	if (selectedMap != foundMap)
-	{
-		std::vector<int> selectedIndices, foundIndices;
+		std::string title = "Invalid Headstage Selection", msg;
 
-		for (const auto& [key, _] : selectedMap) { selectedIndices.emplace_back(key); }
-		for (const auto& [key, _] : foundMap) { foundIndices.emplace_back(key); }
+		msg = "There is a mismatch between the headstages that are selected, and the headstages that are connected.\n\n";
+		msg += "Selected headstage";
+		msg += (selectedOffsets.size() > 1) ? "s" : "";
+		msg += ":\n\n";
 
-		auto selectedOffsets = OnixDevice::getUniqueOffsetsFromIndices(selectedIndices);
-		auto foundOffsets = OnixDevice::getUniqueOffsetsFromIndices(foundIndices);
-
-		if (foundIndices.size() == 0 || foundOffsets.size() == 0) // NB: No devices found
+		if (selectedOffsets.size() == 0)
 		{
-			if (selectedMap.size() != 0)
-			{
-				for (const auto& offset : selectedOffsets)
-				{
-					askKeepRemove(offset);
-				}
-			}
+			msg += "None\n";
 		}
-		else if (selectedIndices.size() == 0) // NB: No headstages selected, add all found headstages
+		else
 		{
-			for (auto& [offset, hubName] : source->getHubNames())
+			for (const auto offset : selectedOffsets)
 			{
-				addHub(hubName, offset);
+				msg += OnixDevice::getPortName(offset) + ": " + editor->getHeadstageSelected(offset) + "\n";
 			}
 		}
-		else if (selectedOffsets.size() == foundOffsets.size()) // NB: Same number of ports selected and found
-		{
-			auto hubNames = source->getHubNames();
 
-			if (selectedOffsets.size() == 1)
-			{
-				if (hubNames.size() != 2)
-				{
-					LOGE("Wrong number of headstages found in the source node.");
-					return;
-				}
-
-				if (selectedOffsets[0] == foundOffsets[0]) // NB: Selected headstage is different from the found headstage on the same port
-				{
-					askKeepUpdate(selectedOffsets[0], hubNames[foundOffsets[0]], source->getDataSources());
-				}
-				else // NB: Selected headstage on one port is not found, and the found headstage is not selected on the other port
-				{
-					askKeepRemove(selectedOffsets[0]);
-
-					addHub(hubNames[foundOffsets[0]], foundOffsets[0]);
-				}
-			}
-			else // NB: Two headstages are selected on different ports, and at least one of those headstages does not match the found headstages
-			{
-				for (const auto& offset : foundOffsets)
-				{
-					if (hubNames[offset] != editor->getHeadstageSelected(offset))
-					{
-						askKeepUpdate(offset, hubNames[offset], source->getDataSourcesFromOffset(offset));
-					}
-				}
-			}
+		msg += "\nConnected headstage";
+		msg += (connectedOffsets.size() > 1) ? "s" : "";
+		msg += ":\n\n";
+
+		if (connectedOffsets.size() == 0)
+		{
+			msg += "None\n";
 		}
-		else // NB: Different number of ports selected versus found
+		else
 		{
-			auto hubNames = source->getHubNames();
-
-			if (selectedOffsets.size() > foundOffsets.size()) // NB: More headstages selected than found
-			{
-				for (const auto& offset : selectedOffsets)
-				{
-					if (offset == foundOffsets[0])
-					{
-						if (hubNames[offset] != editor->getHeadstageSelected(offset))
-						{
-							askKeepUpdate(offset, hubNames[offset], source->getDataSourcesFromOffset(offset));
-						}
-					}
-					else
-					{
-						askKeepRemove(offset);
-					}
-				}
-			}
-			else // NB: More headstages found than selected
+			for (const auto offset : connectedOffsets)
 			{
-				for (const auto& offset : foundOffsets)
-				{
-					if (offset == selectedOffsets[0])
-					{
-						if (hubNames[offset] != editor->getHeadstageSelected(offset))
-						{
-							askKeepUpdate(offset, hubNames[offset], source->getDataSourcesFromOffset(offset));
-						}
-					}
-					else
-					{
-						addHub(hubNames[offset], offset);
-					}
-				}
+				msg += OnixDevice::getPortName(offset) + ": " + hubNames[offset] + "\n";
 			}
 		}
+
+		msg += "\nVerify that the correct headstage(s) are selected, and that all hardware connections are correct before trying to connect again.";
+
+		Onix1::showWarningMessageBoxAsync(title, msg);
+
+		return false;
 	}
 
-	CoreServices::updateSignalChain(editor);
-	editor->refreshComboBoxSelection();
+	return true;
 }
 
 void OnixSourceCanvas::update() const

Source/OnixSourceCanvas.h

@@ -59,8 +59,8 @@ namespace OnixSourcePlugin
 		/** Removes all tabs from the canvas */
 		void removeAllTabs();
 
-		/** Called when the hardware is connected, to ensure the right tabs are present */
-		void refreshTabs();
+		/** Called when the hardware is connected, to ensure the correct headstage is found */
+		bool verifyHeadstageSelection();
 
 		/** Called when the Visualizer is first created, and optionally when
 			the parameters of the underlying processor are changed */
@@ -113,18 +113,6 @@ namespace OnixSourcePlugin
 
 		std::string getTopLevelTabName(PortName port, std::string headstage);
 
-		/**
-			Create an alert window that asks whether to keep the selected headstage on the given port,
-			or to remove it since the hardware was not found
-		*/
-		void askKeepRemove(int offset);
-
-		/**
-			Create an alert window that asks whether to keep the selected headstage on the given port,
-			or to update to the headstage that was found
-		*/
-		void askKeepUpdate(int offset, std::string foundHeadstage, OnixDeviceVector devices);
-
 		JUCE_LEAK_DETECTOR(OnixSourceCanvas);
 	};
 }

Source/OnixSourceEditor.cpp

@@ -357,12 +357,9 @@ bool OnixSourceEditor::configureAllDevices()
 	if (!OnixSource::checkHubFirmwareCompatibility(source->getContext(), deviceTable))
 		return false;
 
-	if (source->initializeDevices(deviceTable, false))
-		canvas->refreshTabs();
-	else
+	if (!source->initializeDevices(deviceTable, false) || !canvas->verifyHeadstageSelection())
 	{
-		CoreServices::sendStatusMessage("Error configuring hardware. Check logs for more details.");
-		connectButton->setToggleState(false, sendNotification);
+		setConnectedStatus(false);
 		return false;
 	}