LUMIERA.clone/tests/core/steam/control/command-message-binding-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

127 lines
3.5 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.

/*
CommandMessageBinding(Test) - verify argument binding via GenNode-Message, with immutable types
Copyright (C)
2016, 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 command-message-binding-test.cpp
** unit test \ref CommandMessageBinding_test
*/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
#include "steam/control/command-def.hpp"
#include "lib/time/timevalue.hpp"
#include "lib/diff/gen-node.hpp"
namespace steam {
namespace control {
namespace test {
using lib::time::Time;
using lib::time::TimeVar;
using lib::time::TimeValue;
using lib::time::TimeSpan;
using lib::time::Duration;
using lib::test::randTime;
using lib::diff::Rec;
namespace { // functions to be invoked through the command system
TimeVar implicitTestState;
void
operate (Duration dur)
{
implicitTestState += dur;
}
Time
capture (Duration)
{
return implicitTestState;
}
void
undoIt (Duration, Time oldVal)
{
implicitTestState = oldVal;
}
}
/***********************************************************************//**
* @test verify the simple standard usage pattern, where command arguments
* for binding are passed via UI-Bus message with GenNode elements.
* This is a simplified demonstration, but covers some tricky aspects.
* - commands may define arguments of arbitrary type, and at runtime
* these are initialised from the set of standard types allowed
* within GenNode elements. Here the Duration is initialised from
* a TimeSpan object
* - we support immutable argument types, which means the command binding
* machinery works without (re)assignment, only copy construction of
* argument holders into an inline buffer.
* - likewise we support to use an immutable type as captured state
* memento, which is demonstrated by capturing a Time value
*
* @see BusTerm_test
* @see TupleRecordInit_test
*/
class CommandMessageBinding_test : public Test
{
virtual void
run (Arg)
{
Time five(TimeValue(5));
implicitTestState = five;
CommandDef ("test.command2")
.operation (operate)
.captureUndo (capture)
.undoOperation (undoIt)
;
TimeSpan testSpan (randTime(), randTime());
Rec argMsg {testSpan};
// bind the command argument from a GenNode message
Command ourCmd = Command::get("test.command2");
CHECK (not ourCmd.canExec());
ourCmd.bindArg (argMsg);
CHECK (ourCmd.canExec());
// invoke the command
ourCmd();
CHECK (implicitTestState == five + Duration(testSpan));
// undo the effect of the command
ourCmd.undo();
CHECK (implicitTestState == five);
}
};
/** Register this test class... */
LAUNCHER (CommandMessageBinding_test, "unit controller");
}}} // namespace steam::control::test