LUMIERA.clone/tests/library/builder-qualifier-support-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

133 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.

/*
BuilderQualifierSupport(Test) - demonstrate accepting arbitrary qualifier terms on a builder function
Copyright (C)
2022, 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 builder-qualifier-support-test.cpp
** unit test \ref lib::test::BuilderQualifierSupport_test
*/
#include "lib/test/run.hpp"
#include "lib/builder-qualifier-support.hpp"
#include "lib/test/test-helper.hpp"
#include <string>
namespace lib {
namespace test{
using std::string;
namespace { // example strategy to use the builder-qualifier-support...
/** Example "strategy" class, which can be configured
* with additional qualifiers at construction */
class ExampleStrategy
: BuilderQualifierSupport<ExampleStrategy>
{
friend Qualifier one();
friend Qualifier two(string);
public:
ExampleStrategy() = default;
template<class... QS>
ExampleStrategy(Qualifier qual, QS... qs)
: ExampleStrategy{}
{
qualify(*this, qual, qs...);
}
operator string () const
{
return "Strategy{"+prop_+"}";
}
private:
/** a private property
* to be manipulated by the qualifiers */
string prop_{""};
};
/** definition of a qualifier `one()` */
ExampleStrategy::Qualifier
one()
{
return ExampleStrategy::Qualifier{[](ExampleStrategy& strategy)
{
strategy.prop_ = "!one!";
}};
}
/** definition of another qualifier `two(arg)`, accepting an additional argument */
ExampleStrategy::Qualifier
two(string additionalArg)
{
return ExampleStrategy::Qualifier{[=](ExampleStrategy& strategy)
{
strategy.prop_ += ".two("+additionalArg+")";
}};
}
}//(End)Test example
/***********************************************************************************//**
* @test Demonstrate a technique to supply additional descriptive ctor arguments in a type safe way.
* - target and receiver may be some configurable Strategy etc.
* - the idea is to provide friend functors, which might tweak or reset internal settings;
* - these functors are packaged into free standing friend functions with intuitive naming...
* - which, on call-site, look like algebraic expressions/data-types.
* @remark because the actual helper function is a free function, it may be integrated
* in various ways, but typically the support template will be mixed-in, as demonstrated
* here; this mechanism can be integrated into a constructor call, thus optionally allowing
* for arbitrary extra qualifiers, even with extra arguments.
*
* @see builder-qualifier-support.hpp
*/
class BuilderQualifierSupport_test : public Test
{
void
run (Arg)
{
ExampleStrategy f0;
CHECK (f0 == "Strategy{∅}"_expect);
ExampleStrategy f1(one());
CHECK (f1 == "Strategy{!one!}"_expect);
ExampleStrategy f2(two("Ψ"));
CHECK (f2 == "Strategy{∅.two(Ψ)}"_expect);
ExampleStrategy f3(one(), two(""));
CHECK (f3 == "Strategy{!one!.two(↯)}"_expect);
ExampleStrategy f4(two(""), one());
CHECK (f4 == "Strategy{!one!}"_expect); // Note: evaluated from left to right, one() overwrites prop_
}
};
/** Register this test class... */
LAUNCHER (BuilderQualifierSupport_test, "unit common");
}} // namespace lib::test