undo: add device related undo commands

Add commands for deleting devices and editing device nicknames
to include the device-handling in the undo system.

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>

5 files changed, 129 insertions, 1 deletions

diff --git a/commands/CMakeLists.txt b/commands/CMakeLists.txt
index bcd76bba9..f03842048 100644
--- a/commands/CMakeLists.txt
+++ b/commands/CMakeLists.txt
@@ -6,6 +6,8 @@ set(SUBSURFACE_GENERIC_COMMANDS_SRCS
 	command_base.h
 	command.cpp
 	command.h
+	command_device.cpp
+	command_device.h
 	command_divelist.cpp
 	command_divelist.h
 	command_divesite.cpp
diff --git a/commands/command.cpp b/commands/command.cpp
index 6ce7f18bd..4125d994b 100644
--- a/commands/command.cpp
+++ b/commands/command.cpp
@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: GPL-2.0
 
 #include "command.h"
+#include "command_device.h"
 #include "command_divelist.h"
 #include "command_divesite.h"
 #include "command_edit.h"
@@ -380,6 +381,16 @@ void addPictures(const std::vector<PictureListForAddition> &pictures)
 	execute(new AddPictures(pictures));
 }
 
+void removeDevice(int idx)
+{
+	execute(new RemoveDevice(idx));
+}
+
+void editDeviceNickname(int idx, const QString &nickname)
+{
+	execute(new EditDeviceNickname(idx, nickname));
+}
+
 void createFilterPreset(const QString &name, const FilterData &data)
 {
 	execute(new CreateFilterPreset(name, data));
diff --git a/commands/command.h b/commands/command.h
index 26340357e..a18fc5dd6 100644
--- a/commands/command.h
+++ b/commands/command.h
@@ -138,7 +138,12 @@ void setPictureOffset(dive *d, const QString &filename, offset_t offset);
 void removePictures(const std::vector<PictureListForDeletion> &pictures);
 void addPictures(const std::vector<PictureListForAddition> &pictures);
 
-// 8) Filter commands
+// 8) Device commands
+
+void removeDevice(int idx);
+void editDeviceNickname(int idx, const QString &nickname);
+
+// 9) Filter commands
 
 void createFilterPreset(const QString &name, const FilterData &data);
 void removeFilterPreset(int index);
diff --git a/commands/command_device.cpp b/commands/command_device.cpp
new file mode 100644
index 000000000..afd368b55
--- /dev/null
+++ b/commands/command_device.cpp
@@ -0,0 +1,66 @@
+// SPDX-License-Identifier: GPL-2.0
+
+#include "command_device.h"
+#include "core/subsurface-qt/divelistnotifier.h"
+
+namespace Command {
+
+RemoveDevice::RemoveDevice(int indexIn) : index(indexIn)
+{
+	const device *dev = get_device(&device_table, index);
+	if (!dev)
+		return;
+
+	setText(Command::Base::tr("Delete device %1 (0x%2)").arg(QString::fromStdString(dev->model),
+								 QString::number(dev->deviceId)));
+}
+
+bool RemoveDevice::workToBeDone()
+{
+	return get_device(&device_table, index) != nullptr;
+}
+
+void RemoveDevice::redo()
+{
+	dev = *get_device(&device_table, index);
+	remove_from_device_table(&device_table, index);
+	emit diveListNotifier.deviceDeleted(index);
+}
+
+void RemoveDevice::undo()
+{
+	index = add_to_device_table(&device_table, &dev);
+	emit diveListNotifier.deviceAdded(index);
+}
+
+EditDeviceNickname::EditDeviceNickname(int indexIn, const QString &nicknameIn) :
+	index(indexIn), nickname(nicknameIn.toStdString())
+{
+	const device *dev = get_device(&device_table, index);
+	if (!dev)
+		return;
+
+	setText(Command::Base::tr("Set nickname of device %1 (0x%2) to %3").arg(QString::fromStdString(dev->model),
+										QString::number(dev->deviceId,1 ,16), nicknameIn));
+}
+
+bool EditDeviceNickname::workToBeDone()
+{
+	return get_device(&device_table, index) != nullptr;
+}
+
+void EditDeviceNickname::redo()
+{
+	device *dev = get_device_mutable(&device_table, index);
+	if (!dev)
+		return;
+	std::swap(dev->nickName, nickname);
+	emit diveListNotifier.deviceEdited(index);
+}
+
+void EditDeviceNickname::undo()
+{
+	redo(); // undo() and redo() do the same thing
+}
+
+} // namespace Command
diff --git a/commands/command_device.h b/commands/command_device.h
new file mode 100644
index 000000000..c1cf1a240
--- /dev/null
+++ b/commands/command_device.h
@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: GPL-2.0
+// Note: this header file is used by the undo-machinery and should not be included elsewhere.
+
+#ifndef COMMAND_DEVICE_H
+#define COMMAND_DEVICE_H
+
+#include "command_base.h"
+#include "core/device.h"
+
+struct device;
+
+// We put everything in a namespace, so that we can shorten names without polluting the global namespace
+namespace Command {
+
+class RemoveDevice final : public Base {
+public:
+	RemoveDevice(int index);
+private:
+	// for undo
+	device dev;
+
+	// for redo
+	int index;
+
+	void undo() override;
+	void redo() override;
+	bool workToBeDone() override;
+};
+
+class EditDeviceNickname final : public Base {
+public:
+	EditDeviceNickname(int index, const QString &nickname);
+private:
+	// for redo and undo
+	int index;
+	std::string nickname;
+
+	void undo() override;
+	void redo() override;
+	bool workToBeDone() override;
+};
+
+} // namespace Command
+#endif