LUMIERA.clone/tests/core/steam/control/memento-tie-test.cpp
Ichthyostega 806db414dd Copyright: clarify and simplify the file headers
* Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.
2024-11-17 23:42:55 +01:00

132 lines
4 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);
CHECK (sizeof(MemHolder) <= sizeof(int) // storage for the memento
+ 2 * sizeof(function<void()>) // storage for the 2 undecorated functors
+ ALIGNMENT);
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