* 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.
77 lines
2.4 KiB
C++
77 lines
2.4 KiB
C++
/*
|
||
TEST-SCOPES.hpp - builds a test PlacementIndex containing dummy Placements as nested scopes
|
||
|
||
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-scopes.hpp
|
||
** Unit test helper to generate a system of nested test scopes.
|
||
** These can be used to verify session search and discovery functionality.
|
||
** The build_testScopes() function generates a system of placements and MObjects
|
||
** with a known, fixed layout.
|
||
*/
|
||
|
||
|
||
#ifndef MOBJECT_SESSION_TEST_TEST_SCOPES_H
|
||
#define MOBJECT_SESSION_TEST_TEST_SCOPES_H
|
||
|
||
|
||
#include "steam/mobject/test-dummy-mobject.hpp"
|
||
#include "steam/mobject/session/placement-index.hpp"
|
||
#include "steam/mobject/session/scope-query.hpp"
|
||
#include "steam/mobject/placement.hpp"
|
||
|
||
#include <memory>
|
||
|
||
|
||
namespace steam {
|
||
namespace mobject {
|
||
namespace session {
|
||
namespace test {
|
||
|
||
using namespace mobject::test;
|
||
typedef TestPlacement<DummyMO> PDum;
|
||
|
||
typedef std::shared_ptr<PlacementIndex> PPIdx;
|
||
typedef ScopeQuery<MObject>::iterator _ScopeIterMO;
|
||
|
||
|
||
|
||
/** helper for tests: create a pseudo-session (actually just a PlacementIndex),
|
||
* which contains some nested placement scopes.
|
||
* @return new PlacementIndex, which has already been activated to be used
|
||
* by all Placements from now on. This activation will be cleared
|
||
* automatically, when this object goes out of scope.
|
||
*
|
||
* @see mobject::PlacementIndex
|
||
* @see session::SessManagerImpl::getCurrentIndex()
|
||
* @see mobject::session::SessionServiceMockIndex::reset_PlacementIndex
|
||
*/
|
||
PPIdx build_testScopes();
|
||
|
||
|
||
/** complement to the helper: retrieve one of the dummy placements
|
||
* which is a Placement<> and way down into the hierarchy
|
||
*/
|
||
PlacementMO& retrieve_startElm();
|
||
|
||
PlacementMO& retrieve_firstTestSubMO21();
|
||
|
||
|
||
/** shortcut to explore the contents of a scope within the current index.
|
||
* Usually, clients would use QueryFocus or ScopeLocator to perform this task,
|
||
* but for the purpose of testing we're better off to invoke the query directly
|
||
*/
|
||
_ScopeIterMO explore_testScope (PlacementMO const& scopeTop);
|
||
|
||
|
||
|
||
}}}} // namespace steam::mobject::session::test
|
||
#endif
|