LUMIERA.clone/tests/core/steam/mobject/builder/builder-tool-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

144 lines
5.1 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.

/*
BuilderTool(Test) - specialised visitor used within the builder for processing Placements
Copyright (C)
2008, 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-tool-test.cpp
** unit test \ref BuilderTool_test
*/
#include "lib/test/run.hpp"
#include "steam/mobject/builder/buildertool.hpp"
#include "steam/mobject/placement.hpp"
#include "steam/asset/category.hpp"
#include "steam/asset/media.hpp"
#include "steam/mobject/session/clip.hpp"
#include "steam/mobject/test-dummy-mobject.hpp"
#include "vault/media-access-mock.hpp"
#include "lib/depend-inject.hpp"
#include "lib/format-cout.hpp"
#include "lib/util.hpp"
using std::string;
namespace steam {
namespace mobject {
namespace builder {
namespace test {
using session::Clip;
using session::AbstractMO;
using namespace mobject::test;
using MediaAccessMock = lib::DependInject<vault::MediaAccessFacade>
::Local<vault::test::MediaAccessMock>;
/**
* BuilderTool implementation for checking the invocation of the correct
* \c treat() function and for accessing the original Placement from
* within this invocation. It is declared to be applicable to Clip
* and DummyMO objects (wrapped into any acceptable shared-ptr).
* Intentionally, we omit to declare it applicable to TestSubMO2 instances.
* In reality this would be a case of misconfiguration, because TestSubMO2
* is defined to be processable and consequently has an \apply() function,
* which, due to this omission can't find a dispatcher entry when invoked,
* so it will call the \c onUnknown(Buildable&) instead
*/
class TestTool
: public Applicable<TestTool, Types<Clip, DummyMO>::List>
{
public:
string log_;
void treat (Clip& c)
{
Placement<Clip>& pC = getPlacement<Clip>();
cout << "Clip on media : "<< pC->getMedia() <<"\n";
CHECK (pC->operator==(c));
log_ = string (pC);
}
void treat (AbstractMO&)
{
cout << "treat (AbstractMO&);\n";
log_ = string (getPlacement<MObject>());
}
void onUnknown (Buildable&)
{
cout << "catch-all-function called...\n";
log_ = string (getPlacement<MObject>());
}
};
/*********************************************************************************//**
* @test the generic visitor pattern specialised for treating MObjects in the builder.
* Besides using existing MObject types (at the moment session::Clip),
* we create a yet-unknown new MObject subclass. When passing such to any
* BuilderTool subclass, the compiler enforces the definition of a catch-all
* function, which is called, when there is no other applicable \c treat(MO&)
* function. Note further, within the specific treat-functions we get direct
* references, without interfering with Placements and memory management.
* But from within the \c treat() function, we may access the wrapper object
* (i.e. shared_ptr, or lumiera::P or Placement) used when invoking the
* BuilderTool by using the protected interface on BuilderTool.
*
* @see VisitingTool_test for checking general visitor functionality
*/
class BuilderTool_test : public Test
{
virtual void
run(Arg)
{
MediaAccessMock useMockMedia;
TestTool t1;
BuilderTool& tool = t1;
Placement<Clip> clip = asset::Media::create("test-1", asset::VIDEO)->createClip();
TestPlacement<> test1(*new TestSubMO1);
TestPlacement<> test2(*new TestSubMO2);
cout << "apply (tool, clip);\n";
apply (tool, clip);
INFO (test, "got Wrapper = %s", t1.log_.c_str());
CHECK (t1.log_ == string(clip));
cout << "apply (tool, test1);\n";
apply (tool, test1);
INFO (test, "got Wrapper = %s", t1.log_.c_str());
CHECK (t1.log_ == string(test1));
cout << "apply (tool, test2);\n";
apply (tool, test2);
INFO (test, "got Wrapper = %s", t1.log_.c_str());
CHECK (t1.log_ == string(test2));
}
};
/** Register this test class... */
LAUNCHER (BuilderTool_test, "unit builder");
}}}} // namespace steam::mobject::builder::test