LUMIERA.clone/tests/library/advice/advice-situations-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

140 lines
4.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.

/*
AdviceSituations(Test) - catalogue of standard Advice usage scenarios
Copyright (C)
2010, 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 advice-situations-test.cpp
** unit test \ref AdviceSituations_test
*/
#include "lib/test/run.hpp"
//#include "lib/test/test-helper.hpp"
#include "common/advice.hpp"
namespace lumiera {
namespace advice {
namespace test {
namespace {
}
/**************************************************************************************//**
* @test documentation of the fundamental usage scenarios envisioned in the Advice concept.
* This test will be augmented and completed as the Lumiera application matures.
*
* @todo yet more use cases to come.... ////////////////////////////////////////////////////////TICKET #335
*
* @see advice.hpp
* @see AdviceBasics_test
* @see AdviceConfiguration_test
*/
class AdviceSituations_test : public Test
{
virtual void
run (Arg)
{
pattern01_justPickAndBeHappy();
pattern02_pickIfPresent();
pattern03_installOnlyOnce();
TODO ("more advice usage scenarios.....?");
}
/** @test usage pattern 01: simply consume Advice -- irrespective if set explicitly. */
void
pattern01_justPickAndBeHappy()
{
Request<int> generic{"solution(life_and_universe_and_everything)"};
CHECK (0 == generic.getAdvice()); // the early bird gets the worm...
Provision<int> universal{"solution(life_and_universe_and_everything)"};
universal.setAdvice(5);
CHECK (5 == generic.getAdvice()); // ...while the bad girls go everywhere
universal.retractAdvice();
CHECK (0 == generic.getAdvice()); // nothing to see here, just move on
}
/** @test usage pattern 01: detect if specific advice was given. */
void
pattern02_pickIfPresent()
{
Request<int> request{"something(special)"};
CHECK (not request.isMatched());
Provision<int> info{"something(special)"};
info.setAdvice(55);
CHECK (request.isMatched());
CHECK (55 == request.getAdvice());
info.retractAdvice();
CHECK (not request.isMatched());
}
/** @test usage pattern 01: . */
void
pattern03_installOnlyOnce()
{
Provision<int> info{"something(special)"};
CHECK (not info.isGiven());
Request<int> question{"something(special)"};
CHECK (0 == question.getAdvice());
CHECK (not question.isMatched());
auto publish = [&](int i)
{
if (not info.isGiven())
info.setAdvice (i);
};
for (uint i=0; i<5; ++i)
if (i % 2)
publish (i);
CHECK (1 == question.getAdvice());
CHECK (question.isMatched());
info.retractAdvice();
CHECK (not info.isGiven());
CHECK (not question.isMatched());
}
#if false /////////////////////////////////////////////////////////////////////////////////////////////////////////////UNIMPLEMENTED :: TICKET #335
/** @test usage pattern ∞ : somewhat literally fantastic */
void
check_SevenMoreWondersOfTheWorld()
{
UNIMPLEMENTED ("suitable advice to save the world");
}
#endif /////////////////////////////////////////////////////////////////////////////////////////////////////////////UNIMPLEMENTED :: TICKET #335
// more to come.....
};
/** Register this test class... */
LAUNCHER (AdviceSituations_test, "function common");
}}} // namespace lumiera::advice::test