LUMIERA.clone/tests/core/steam/control/test-dummy-commands.hpp
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

160 lines
3.2 KiB
C++
Raw Permalink 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.

/*
TEST-DUMMY-COMMANDS.hpp - dummy functions used to build test commands
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 test-dummy-commands.hpp
** Some dummy command functions used for building unit test cases.
** Any of these functions comes in triples of operation function, undo state
** capturing function and UNDO function. They are placed into a nested test
** namespace, together with some global variables, usable as backdoor to
** verify the effect of calling these functions.
**
** @see command-use1-test.cpp
** @see CommandBasic_test simple complete command definition example
**
*/
#ifndef COMMAND_TEST_DUMMY_COMMANDS_H
#define COMMAND_TEST_DUMMY_COMMANDS_H
#include "lib/error.hpp"
#include "lib/test/test-helper.hpp"
#include "steam/control/command-setup.hpp"
#include <functional>
#include <sstream>
#include <string>
namespace steam {
namespace control {
namespace test {
using std::ostringstream;
using std::function;
using std::string;
namespace command1 { ///< test command just adding a given value
extern int64_t check_;
inline void
operate (int someVal)
{
check_ += someVal;
}
inline int64_t
capture (int)
{
return check_;
}
inline void
undoIt (int, int64_t oldVal)
{
check_ = oldVal;
}
}
namespace command2 { ///< test command writing capturing log and possibly throwing
using lumiera::error::External;
extern ostringstream check_;
typedef function<string()> FunS;
inline void
operate (FunS func, bool *fail)
{
if (fail and *fail) throw External("simulated exception");
check_ << func();
}
inline string
capture (FunS, bool*)
{
return check_.str();
}
inline void
undoIt (FunS, bool *fail, string previousProtocol)
{
if (fail and *fail) throw External("simulated exception in UNDO");
check_.str("");
check_ << previousProtocol << "|UNDO|";
}
}
namespace command3 { ///< test command with zero arguments
extern ulong check_;
inline void
operate ()
{
++check_;
}
inline ulong
capture ()
{
return check_;
}
inline void
undoIt (ulong oldVal)
{
check_ = oldVal;
}
}
/* ==== global static prototype definitions for these commands ==== */
/** test dummy command to add the argument to a global variable */
extern CommandSetup test_Dummy_command1;
/** test dummy command to invoke the given functor and
* append the result onto a global log string buffer */
extern CommandSetup test_Dummy_command2;
/** test dummy command to increment a global variable; no arguments */
extern CommandSetup test_Dummy_command3;
}}} // namespace steam::control::test
#endif