lumiera_/tests/core/steam/control/memento-tie-test.cpp
Ichthyostega bc6a219543 clean-up: trash ReplacableItem (closes: #1059)
Now looking into largely obsolete library facilities...
Starting from `ScopedHolder`, I found a surprising problem with ''perfect forwarding....''

...which however turned out to be the result of ''sloppy programming'' on my side.
At that time, in 2017, seemingly I was under pressure to define a Session-Command,
which captures a Time-entity as »State Memento«. Which turned out to be impossible,
since the Time entities were conceived as being immutable -- a questionable design
decision (see #1261), which already generated quite some additional complexities.


In the course of this »exercise«, I could again clarify that the implementation
of perfect forwarding works as expected on modern compilers — confusion may arrise
sometimes due to ''copy elision'' (which the compiler is required to perform
since C++17, even when the elided constructor has observable side effects).
And it can be derailed when (as was the case here) a »grab everything« constructor
accidentally ends up generating a copy- or move-constructor for the container class
itself. This is an instance of the problem documented with #963 ...

.... and the best solution is to abide by the rule-of-five (and a half)
and to put that `ReplacableItem` to where it belongs...
2025-05-30 19:12:01 +02:00

128 lines
3.7 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
MementoTie(Test) - check the mechanism for capturing and providing undo-state
Copyright (C)
2009, Hermann Vosseler <Ichthyostega@web.de>
  **Lumiera** is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the
  Free Software Foundation; either version 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.
* *****************************************************************/
/** @file memento-tie-test.cpp
** unit test \ref MementoTie_test
*/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "steam/control/memento-tie.hpp"
#include <functional>
using std::function;
using std::bind;
namespace steam {
namespace control {
namespace test {
namespace {
int testVal=0; ///< used to verify the effect of testFunc
void
undo (short param, int memento) ///< simulates "Undo" of the command operation
{
testVal += param-memento;
}
int
capture (short param) ///< simulates capturing the undo state
{
return testVal+param;
}
/** maximum additional storage maybe wasted due
* to alignment of the memento value within MementoTie
*/
const size_t ALIGNMENT = sizeof(size_t);
}
using LERR_(MISSING_MEMENTO);
/*************************************************************************************//**
* @test Verify the state capturing mechanism (memento), which is used to implement
* the Undo() functionality for Steam-Layer commands. Bind an undo function and a state
* capturing function and wire up both to store and retrieve a memento value.
* Verify that after closing the functions, actually state is captured by each invocation.
*
* @see control::Command
* @see control::CmdClosure
* @see control::UndoMutation
* @see command-mutation-test.hpp
*/
class MementoTie_test : public Test
{
virtual void
run (Arg)
{
seedRand();
checkStateCapturingMechanism();
}
/// assumed signature of the Command "Operation"
typedef void OpSIG(short);
typedef MementoTie<OpSIG,int> MemHolder;
void
checkStateCapturingMechanism ()
{
function<void(short,int)> undo_func = undo;
function< int(short)> cap_func = capture;
MemHolder mementoHolder (undo_func,cap_func);
function<OpSIG> bound_undo_func = mementoHolder.tieUndoFunc();
function<OpSIG> bound_cap_func = mementoHolder.tieCaptureFunc();
VERIFY_ERROR (MISSING_MEMENTO, bound_undo_func(123) );
VERIFY_ERROR (MISSING_MEMENTO, mementoHolder.getState() );
short rr (rani (100));
testVal = 0;
bound_cap_func(rr); // invoke state capturing
CHECK (rr == mementoHolder.getState());
testVal = 10; // meanwhile "somehow" mutate the state
bound_undo_func(0); // invoking the undo() feeds back the memento
CHECK (testVal == 10-rr);
// this cycle can be repeated with different state values
rr = rani (100);
testVal = rr;
bound_cap_func(5); // capture new state
CHECK (5+rr == mementoHolder.getState());
testVal = -20;
bound_undo_func(3*rr);
CHECK (testVal == -20 + 3*rr - (5+rr));
}
};
/** Register this test class... */
LAUNCHER (MementoTie_test, "unit controller");
}}} // namespace steam::control::test