Undo: make weight editing undoable

Implement the EditWeight undo command. Since there is common code
(storage of the old weight), this creates a common base class for
RemoveWeight and EditWeight. The model calls directly into the undo
command, which is somewhat unfortunate as it feels like a layering
violation. It's the easy thing to do for now.

Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
This commit is contained in:
Berthold Stoeger 2019-11-08 22:47:38 +01:00 committed by Dirk Hohndel
parent 029c9ccf02
commit 72c6b83866
10 changed files with 132 additions and 59 deletions

View file

@ -278,6 +278,11 @@ int removeWeight(int index, bool currentDiveOnly)
return execute_edit(new RemoveWeight(index, currentDiveOnly));
}
int editWeight(int index, weightsystem_t ws, bool currentDiveOnly)
{
return execute_edit(new EditWeight(index, ws, currentDiveOnly));
}
// Trip editing related commands
void editTripLocation(dive_trip *trip, const QString &s)
{

View file

@ -83,6 +83,7 @@ void replanDive(dive *d); // dive computer(s) and cylinder(s) will be reset!
void editProfile(dive *d); // dive computer(s) and cylinder(s) will be reset!
int addWeight(bool currentDiveOnly);
int removeWeight(int index, bool currentDiveOnly);
int editWeight(int index, weightsystem_t ws, bool currentDiveOnly);
// 5) Trip editing commands

View file

@ -6,6 +6,7 @@
#include "core/selection.h"
#include "core/subsurface-string.h"
#include "core/tag.h"
#include "qt-models/weightsysteminfomodel.h"
namespace Command {
@ -993,7 +994,7 @@ static int find_weightsystem_index(const struct dive *d, weightsystem_t ws)
return -1;
}
RemoveWeight::RemoveWeight(int index, bool currentDiveOnly) :
EditWeightBase::EditWeightBase(int index, bool currentDiveOnly) :
EditDivesBase(currentDiveOnly),
ws(empty_weightsystem)
{
@ -1024,21 +1025,25 @@ RemoveWeight::RemoveWeight(int index, bool currentDiveOnly) :
}
}
dives = std::move(divesNew);
//: remove the part in parentheses for %n = 1
setText(tr("Remove weight (%n dive(s))", "", dives.size()));
}
RemoveWeight::~RemoveWeight()
EditWeightBase::~EditWeightBase()
{
free_weightsystem(ws);
}
bool RemoveWeight::workToBeDone()
bool EditWeightBase::workToBeDone()
{
return !dives.empty();
}
RemoveWeight::RemoveWeight(int index, bool currentDiveOnly) :
EditWeightBase(index, currentDiveOnly)
{
//: remove the part in parentheses for %n = 1
setText(tr("Remove weight (%n dive(s))", "", dives.size()));
}
void RemoveWeight::undo()
{
for (size_t i = 0; i < dives.size(); ++i) {
@ -1055,4 +1060,57 @@ void RemoveWeight::redo()
}
}
EditWeight::EditWeight(int index, weightsystem_t wsIn, bool currentDiveOnly) :
EditWeightBase(index, currentDiveOnly),
new_ws(empty_weightsystem)
{
if (dives.empty())
return;
//: remove the part in parentheses for %n = 1
setText(tr("Edit weight (%n dive(s))", "", dives.size()));
// Try to untranslate the weightsystem name
new_ws = clone_weightsystem(wsIn);
QString vString(new_ws.description);
for (int i = 0; i < MAX_WS_INFO && ws_info[i].name; ++i) {
if (gettextFromC::tr(ws_info[i].name) == vString) {
free_weightsystem(new_ws);
new_ws.description = copy_string(ws_info[i].name);
break;
}
}
// If that doesn't change anything, do nothing
if (same_weightsystem(ws, new_ws)) {
dives.clear();
return;
}
WSInfoModel *wsim = WSInfoModel::instance();
QModelIndexList matches = wsim->match(wsim->index(0, 0), Qt::DisplayRole, gettextFromC::tr(new_ws.description));
if (!matches.isEmpty())
wsim->setData(wsim->index(matches.first().row(), WSInfoModel::GR), new_ws.weight.grams);
}
EditWeight::~EditWeight()
{
free_weightsystem(new_ws);
}
void EditWeight::redo()
{
for (size_t i = 0; i < dives.size(); ++i) {
set_weightsystem(dives[i], indexes[i], new_ws);
emit diveListNotifier.weightEdited(dives[i], indexes[i]);
}
std::swap(ws, new_ws);
}
// Undo and redo do the same as just the stored value is exchanged
void EditWeight::undo()
{
redo();
}
} // namespace Command

View file

@ -339,16 +339,32 @@ private:
bool workToBeDone() override;
};
class RemoveWeight : public EditDivesBase {
public:
RemoveWeight(int index, bool currentDiveOnly);
~RemoveWeight();
private:
class EditWeightBase : public EditDivesBase {
protected:
EditWeightBase(int index, bool currentDiveOnly);
~EditWeightBase();
weightsystem_t ws;
std::vector<int> indexes; // An index for each dive in the dives vector.
bool workToBeDone() override;
};
class RemoveWeight : public EditWeightBase {
public:
RemoveWeight(int index, bool currentDiveOnly);
private:
void undo() override;
void redo() override;
};
class EditWeight : public EditWeightBase {
public:
EditWeight(int index, weightsystem_t ws, bool currentDiveOnly); // Clones ws
~EditWeight();
private:
weightsystem_t new_ws;
void undo() override;
void redo() override;
bool workToBeDone() override;
};
} // namespace Command