LUMIERA.clone/tests/components/proc/control/command-clone-builder-test.cpp

242 lines
8.5 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.

/*
CommandCloneBuilder(Test) - verify building an implementation clone
Copyright (C) Lumiera.org
2009, Hermann Vosseler <Ichthyostega@web.de>
This program 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.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
* *****************************************************/
#include "lib/test/run.hpp"
#include "lib/test/test-helper.hpp"
//#include "proc/control/command-def.hpp"
#include "proc/control/command-registry.hpp"
#include "proc/control/command-impl-clone-builder.hpp"
#include "lib/symbol.hpp"
#include "lib/util.hpp"
#include "proc/control/test-dummy-commands.hpp"
#include <tr1/functional>
namespace control {
namespace test {
using std::tr1::function;
using util::isSameObject;
using lib::Symbol;
namespace { // test data and helpers...
Symbol TEST_CMD = "test.command1.1";
Symbol TEST_CMD2 = "test.command1.2";
}
/********************************************************************************
* @test check creation of a command implementation clone from top level,
* without disclosing specific type information about the involved closure.
* This includes verifying sane allocation management.
* @note this test covers a very specific low-level perspective, but on an
* integration level, including TypedAllocationManager, CommandRegistry,
* CommandImpl, CmdClosure, ArgumentHolder, UndoMutation, MementoTie.
* Closes: Ticket #298
*
* @see Command
* @see CommandRegistry
* @see command.cpp
* @see command-use1-test.cpp
*/
class CommandCloneBuilder_test : public Test
{
uint cnt_defs;
uint cnt_inst;
virtual void
run (Arg)
{
CommandRegistry& registry = CommandRegistry::instance();
ASSERT (&registry);
cnt_defs = registry.index_size();
cnt_inst = registry.instance_count();
// prepare a command definition (prototype)
CommandDef (TEST_CMD)
.operation (command1::operate)
.captureUndo (command1::capture)
.undoOperation (command1::undoIt)
.bind(123);
// this command definition is
// represented internally by a prototype instance
ASSERT (++cnt_inst == registry.instance_count());
ASSERT (++cnt_defs == registry.index_size());
checkRegistration (registry);
checkAllocation(registry);
ASSERT (cnt_inst == registry.instance_count());
ASSERT (cnt_defs == registry.index_size());
Command::remove (TEST_CMD);
ASSERT (--cnt_inst == registry.instance_count());
}
/** @test verify the index operation.
* Add, search, remove, store copy.
*/
void
checkRegistration (CommandRegistry& registry)
{
ASSERT (cnt_inst == registry.instance_count());
Command cmd1 = registry.queryIndex (TEST_CMD);
ASSERT (cmd1);
ASSERT (TEST_CMD == registry.findDefinition(cmd1));
Command nonexistant = registry.queryIndex("miraculous");
ASSERT (!nonexistant);
// now create a clone, registered under a different ID
Command cmd2 = cmd1.storeDef(TEST_CMD2);
ASSERT (cmd2 == cmd1);
cmd2.bind(54321);
ASSERT (cmd2 != cmd1);
// this created exactly one additional instance allocation:
ASSERT (1+cnt_inst == registry.instance_count());
ASSERT (1+cnt_defs == registry.index_size());
// ...and another index entry
Command cmdX = registry.queryIndex(TEST_CMD2);
ASSERT (cmdX == cmd2);
ASSERT (cmdX != cmd1);
ASSERT (registry.remove(TEST_CMD2));
ASSERT (!registry.queryIndex(TEST_CMD2));
ASSERT (cnt_defs == registry.index_size()); // removed from index
ASSERT (1+cnt_inst == registry.instance_count()); //...but still alive
// create a new registration..
registry.track(TEST_CMD2, cmd2);
ASSERT (registry.queryIndex(TEST_CMD2));
ASSERT (1+cnt_defs == registry.index_size()); // again holding two distinct entries
ASSERT (cmdX == cmd2);
ASSERT (cmdX != cmd1);
ASSERT (TEST_CMD == registry.findDefinition(cmd1));
ASSERT (TEST_CMD2 == registry.findDefinition(cmd2));
ASSERT (TEST_CMD2 == registry.findDefinition(cmdX));
ASSERT ( registry.remove(TEST_CMD2));
ASSERT (!registry.remove("miraculous"));
ASSERT (!registry.queryIndex(TEST_CMD2));
ASSERT ( registry.queryIndex(TEST_CMD));
ASSERT (cnt_defs == registry.index_size()); // the index entry is gone,
ASSERT (1+cnt_inst == registry.instance_count()); // but the allocation still lives
cmdX.close();
ASSERT (1+cnt_inst == registry.instance_count());
cmd2.close();
ASSERT (0+cnt_inst == registry.instance_count()); // ...as long as it's still referred
}
/** @test verify the allocation/de-allocation handling as
* embedded into the CommandRegistry operation.
* Simulates on low level what normally happens
* during command lifecycle.
*/
void
checkAllocation (CommandRegistry& registry)
{
// simulate what normally happens within a CommandDef
typedef void Sig_oper(int);
typedef long Sig_capt(int);
typedef void Sig_undo(int,long);
function<Sig_oper> o_Fun (command1::operate);
function<Sig_capt> c_Fun (command1::capture);
function<Sig_undo> u_Fun (command1::undoIt);
ASSERT (o_Fun && c_Fun && u_Fun);
ASSERT (cnt_inst == registry.instance_count());
// when the CommandDef is complete, it issues the
// allocation call to the registry behind the scenes....
typedef shared_ptr<CommandImpl> PImpl;
PImpl pImpl = registry.newCommandImpl(o_Fun,c_Fun,u_Fun);
ASSERT (1+cnt_inst == registry.instance_count());
ASSERT (pImpl);
ASSERT (pImpl->isValid());
ASSERT (!pImpl->canExec());
ASSERT (1 == pImpl.use_count()); // no magic involved, we hold the only instance
PImpl clone = registry.createCloneImpl(*pImpl);
ASSERT (clone->isValid());
ASSERT (!clone->canExec());
ASSERT (1 == clone.use_count());
ASSERT (1 == pImpl.use_count());
ASSERT (2+cnt_inst == registry.instance_count());
ASSERT (!isSameObject (*pImpl, *clone));
ASSERT (*pImpl == *clone);
ASSERT (!pImpl->canExec());
typedef Types<int> ArgType;
TypedArguments<Tuple<ArgType> > arg (Tuple<ArgType>(98765));
pImpl->setArguments(arg);
ASSERT (pImpl->canExec());
ASSERT (!clone->canExec()); // this proves the clone has indeed a separate identity
ASSERT (*pImpl != *clone);
// discard the first clone and overwrite with a new one
clone = registry.createCloneImpl(*pImpl);
ASSERT (2+cnt_inst == registry.instance_count());
ASSERT (*pImpl == *clone);
ASSERT (clone->canExec());
clone.reset();
pImpl.reset();
// corresponding allocation slots cleared automatically
ASSERT (cnt_inst == registry.instance_count());
}
};
/** Register this test class... */
LAUNCHER (CommandCloneBuilder_test, "function controller");
}} // namespace control::test